1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864 865 866 867 868 869 870 871 872 873 874 875 876 877 878 879 880 881 882 883 884 885 886 887 888 889 890 891 892 893 894 895 896 897 898 899 900 901 902 903 904 905 906 907 908 909 910 911 912 913 914 915 916 917 918 919 920 921 922 923 924 925 926 927 928 929 930 931 932 933 934 935 936 937 938 939 940 941 942 943 944 945 946 947 948 949 950 951 952 953 954
|
<html><body>
<style>
body, h1, h2, h3, div, span, p, pre, a {
margin: 0;
padding: 0;
border: 0;
font-weight: inherit;
font-style: inherit;
font-size: 100%;
font-family: inherit;
vertical-align: baseline;
}
body {
font-size: 13px;
padding: 1em;
}
h1 {
font-size: 26px;
margin-bottom: 1em;
}
h2 {
font-size: 24px;
margin-bottom: 1em;
}
h3 {
font-size: 20px;
margin-bottom: 1em;
margin-top: 1em;
}
pre, code {
line-height: 1.5;
font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace;
}
pre {
margin-top: 0.5em;
}
h1, h2, h3, p {
font-family: Arial, sans serif;
}
h1, h2, h3 {
border-bottom: solid #CCC 1px;
}
.toc_element {
margin-top: 0.5em;
}
.firstline {
margin-left: 2 em;
}
.method {
margin-top: 1em;
border: solid 1px #CCC;
padding: 1em;
background: #EEE;
}
.details {
font-weight: bold;
font-size: 14px;
}
</style>
<h1><a href="oracledatabase_v1.html">Oracle Database@Google Cloud API</a> . <a href="oracledatabase_v1.projects.html">projects</a> . <a href="oracledatabase_v1.projects.locations.html">locations</a> . <a href="oracledatabase_v1.projects.locations.autonomousDatabases.html">autonomousDatabases</a></h1>
<h2>Instance Methods</h2>
<p class="toc_element">
<code><a href="#close">close()</a></code></p>
<p class="firstline">Close httplib2 connections.</p>
<p class="toc_element">
<code><a href="#create">create(parent, autonomousDatabaseId=None, body=None, requestId=None, x__xgafv=None)</a></code></p>
<p class="firstline">Creates a new Autonomous Database in a given project and location.</p>
<p class="toc_element">
<code><a href="#delete">delete(name, requestId=None, x__xgafv=None)</a></code></p>
<p class="firstline">Deletes a single Autonomous Database.</p>
<p class="toc_element">
<code><a href="#generateWallet">generateWallet(name, body=None, x__xgafv=None)</a></code></p>
<p class="firstline">Generates a wallet for an Autonomous Database.</p>
<p class="toc_element">
<code><a href="#get">get(name, x__xgafv=None)</a></code></p>
<p class="firstline">Gets the details of a single Autonomous Database.</p>
<p class="toc_element">
<code><a href="#list">list(parent, filter=None, orderBy=None, pageSize=None, pageToken=None, x__xgafv=None)</a></code></p>
<p class="firstline">Lists the Autonomous Databases in a given project and location.</p>
<p class="toc_element">
<code><a href="#list_next">list_next()</a></code></p>
<p class="firstline">Retrieves the next page of results.</p>
<p class="toc_element">
<code><a href="#restart">restart(name, body=None, x__xgafv=None)</a></code></p>
<p class="firstline">Restarts an Autonomous Database.</p>
<p class="toc_element">
<code><a href="#restore">restore(name, body=None, x__xgafv=None)</a></code></p>
<p class="firstline">Restores a single Autonomous Database.</p>
<p class="toc_element">
<code><a href="#start">start(name, body=None, x__xgafv=None)</a></code></p>
<p class="firstline">Starts an Autonomous Database.</p>
<p class="toc_element">
<code><a href="#stop">stop(name, body=None, x__xgafv=None)</a></code></p>
<p class="firstline">Stops an Autonomous Database.</p>
<p class="toc_element">
<code><a href="#switchover">switchover(name, body=None, x__xgafv=None)</a></code></p>
<p class="firstline">Initiates a switchover of specified autonomous database to the associated peer database.</p>
<h3>Method Details</h3>
<div class="method">
<code class="details" id="close">close()</code>
<pre>Close httplib2 connections.</pre>
</div>
<div class="method">
<code class="details" id="create">create(parent, autonomousDatabaseId=None, body=None, requestId=None, x__xgafv=None)</code>
<pre>Creates a new Autonomous Database in a given project and location.
Args:
parent: string, Required. The name of the parent in the following format: projects/{project}/locations/{location}. (required)
body: object, The request body.
The object takes the form of:
{ # Details of the Autonomous Database resource. https://docs.oracle.com/en-us/iaas/api/#/en/database/20160918/AutonomousDatabase/
"adminPassword": "A String", # Optional. The password for the default ADMIN user.
"cidr": "A String", # Optional. The subnet CIDR range for the Autonomous Database.
"createTime": "A String", # Output only. The date and time that the Autonomous Database was created.
"database": "A String", # Optional. The name of the Autonomous Database. The database name must be unique in the project. The name must begin with a letter and can contain a maximum of 30 alphanumeric characters.
"disasterRecoverySupportedLocations": [ # Output only. List of supported GCP region to clone the Autonomous Database for disaster recovery. Format: `project/{project}/locations/{location}`.
"A String",
],
"displayName": "A String", # Optional. The display name for the Autonomous Database. The name does not have to be unique within your project.
"entitlementId": "A String", # Output only. The ID of the subscription entitlement associated with the Autonomous Database.
"labels": { # Optional. The labels or tags associated with the Autonomous Database.
"a_key": "A String",
},
"name": "A String", # Identifier. The name of the Autonomous Database resource in the following format: projects/{project}/locations/{region}/autonomousDatabases/{autonomous_database}
"network": "A String", # Optional. The name of the VPC network used by the Autonomous Database in the following format: projects/{project}/global/networks/{network}
"odbNetwork": "A String", # Optional. The name of the OdbNetwork associated with the Autonomous Database. Format: projects/{project}/locations/{location}/odbNetworks/{odb_network} It is optional but if specified, this should match the parent ODBNetwork of the OdbSubnet.
"odbSubnet": "A String", # Optional. The name of the OdbSubnet associated with the Autonomous Database. Format: projects/{project}/locations/{location}/odbNetworks/{odb_network}/odbSubnets/{odb_subnet}
"peerAutonomousDatabases": [ # Output only. The peer Autonomous Database names of the given Autonomous Database.
"A String",
],
"properties": { # The properties of an Autonomous Database. # Optional. The properties of the Autonomous Database.
"actualUsedDataStorageSizeTb": 3.14, # Output only. The amount of storage currently being used for user and system data, in terabytes.
"allocatedStorageSizeTb": 3.14, # Output only. The amount of storage currently allocated for the database tables and billed for, rounded up in terabytes.
"allowlistedIps": [ # Optional. The list of allowlisted IP addresses for the Autonomous Database.
"A String",
],
"apexDetails": { # Oracle APEX Application Development. https://docs.oracle.com/en-us/iaas/api/#/en/database/20160918/datatypes/AutonomousDatabaseApex # Output only. The details for the Oracle APEX Application Development.
"apexVersion": "A String", # Output only. The Oracle APEX Application Development version.
"ordsVersion": "A String", # Output only. The Oracle REST Data Services (ORDS) version.
},
"arePrimaryAllowlistedIpsUsed": True or False, # Output only. This field indicates the status of Data Guard and Access control for the Autonomous Database. The field's value is null if Data Guard is disabled or Access Control is disabled. The field's value is TRUE if both Data Guard and Access Control are enabled, and the Autonomous Database is using primary IP access control list (ACL) for standby. The field's value is FALSE if both Data Guard and Access Control are enabled, and the Autonomous Database is using a different IP access control list (ACL) for standby compared to primary.
"autonomousContainerDatabaseId": "A String", # Output only. The Autonomous Container Database OCID.
"availableUpgradeVersions": [ # Output only. The list of available Oracle Database upgrade versions for an Autonomous Database.
"A String",
],
"backupRetentionPeriodDays": 42, # Optional. The retention period for the Autonomous Database. This field is specified in days, can range from 1 day to 60 days, and has a default value of 60 days.
"characterSet": "A String", # Optional. The character set for the Autonomous Database. The default is AL32UTF8.
"computeCount": 3.14, # Optional. The number of compute servers for the Autonomous Database.
"connectionStrings": { # The connection string used to connect to the Autonomous Database. https://docs.oracle.com/en-us/iaas/api/#/en/database/20160918/datatypes/AutonomousDatabaseConnectionStrings # Output only. The connection strings used to connect to an Autonomous Database.
"allConnectionStrings": { # A list of all connection strings that can be used to connect to the Autonomous Database. # Output only. Returns all connection strings that can be used to connect to the Autonomous Database.
"high": "A String", # Output only. The database service provides the highest level of resources to each SQL statement.
"low": "A String", # Output only. The database service provides the least level of resources to each SQL statement.
"medium": "A String", # Output only. The database service provides a lower level of resources to each SQL statement.
},
"dedicated": "A String", # Output only. The database service provides the least level of resources to each SQL statement, but supports the most number of concurrent SQL statements.
"high": "A String", # Output only. The database service provides the highest level of resources to each SQL statement.
"low": "A String", # Output only. The database service provides the least level of resources to each SQL statement.
"medium": "A String", # Output only. The database service provides a lower level of resources to each SQL statement.
"profiles": [ # Output only. A list of connection string profiles to allow clients to group, filter, and select values based on the structured metadata.
{ # The connection string profile to allow clients to group. https://docs.oracle.com/en-us/iaas/api/#/en/database/20160918/datatypes/DatabaseConnectionStringProfile
"consumerGroup": "A String", # Output only. The current consumer group being used by the connection.
"displayName": "A String", # Output only. The display name for the database connection.
"hostFormat": "A String", # Output only. The host name format being currently used in connection string.
"isRegional": True or False, # Output only. This field indicates if the connection string is regional and is only applicable for cross-region Data Guard.
"protocol": "A String", # Output only. The protocol being used by the connection.
"sessionMode": "A String", # Output only. The current session mode of the connection.
"syntaxFormat": "A String", # Output only. The syntax of the connection string.
"tlsAuthentication": "A String", # Output only. This field indicates the TLS authentication type of the connection.
"value": "A String", # Output only. The value of the connection string.
},
],
},
"connectionUrls": { # The URLs for accessing Oracle Application Express (APEX) and SQL Developer Web with a browser from a Compute instance. https://docs.oracle.com/en-us/iaas/api/#/en/database/20160918/datatypes/AutonomousDatabaseConnectionUrls # Output only. The Oracle Connection URLs for an Autonomous Database.
"apexUri": "A String", # Output only. Oracle Application Express (APEX) URL.
"databaseTransformsUri": "A String", # Output only. The URL of the Database Transforms for the Autonomous Database.
"graphStudioUri": "A String", # Output only. The URL of the Graph Studio for the Autonomous Database.
"machineLearningNotebookUri": "A String", # Output only. The URL of the Oracle Machine Learning (OML) Notebook for the Autonomous Database.
"machineLearningUserManagementUri": "A String", # Output only. The URL of Machine Learning user management the Autonomous Database.
"mongoDbUri": "A String", # Output only. The URL of the MongoDB API for the Autonomous Database.
"ordsUri": "A String", # Output only. The Oracle REST Data Services (ORDS) URL of the Web Access for the Autonomous Database.
"sqlDevWebUri": "A String", # Output only. The URL of the Oracle SQL Developer Web for the Autonomous Database.
},
"cpuCoreCount": 42, # Optional. The number of CPU cores to be made available to the database.
"customerContacts": [ # Optional. The list of customer contacts.
{ # The CustomerContact reference as defined by Oracle. https://docs.oracle.com/en-us/iaas/api/#/en/database/20160918/datatypes/CustomerContact
"email": "A String", # Required. The email address used by Oracle to send notifications regarding databases and infrastructure.
},
],
"dataGuardRoleChangedTime": "A String", # Output only. The date and time the Autonomous Data Guard role was changed for the standby Autonomous Database.
"dataSafeState": "A String", # Output only. The current state of the Data Safe registration for the Autonomous Database.
"dataStorageSizeGb": 42, # Optional. The size of the data stored in the database, in gigabytes.
"dataStorageSizeTb": 42, # Optional. The size of the data stored in the database, in terabytes.
"databaseManagementState": "A String", # Output only. The current state of database management for the Autonomous Database.
"dbEdition": "A String", # Optional. The edition of the Autonomous Databases.
"dbVersion": "A String", # Optional. The Oracle Database version for the Autonomous Database.
"dbWorkload": "A String", # Required. The workload type of the Autonomous Database.
"disasterRecoveryRoleChangedTime": "A String", # Output only. The date and time the Disaster Recovery role was changed for the standby Autonomous Database.
"failedDataRecoveryDuration": "A String", # Output only. This field indicates the number of seconds of data loss during a Data Guard failover.
"isAutoScalingEnabled": True or False, # Optional. This field indicates if auto scaling is enabled for the Autonomous Database CPU core count.
"isLocalDataGuardEnabled": True or False, # Output only. This field indicates whether the Autonomous Database has local (in-region) Data Guard enabled.
"isStorageAutoScalingEnabled": True or False, # Optional. This field indicates if auto scaling is enabled for the Autonomous Database storage.
"licenseType": "A String", # Required. The license type used for the Autonomous Database.
"lifecycleDetails": "A String", # Output only. The details of the current lifestyle state of the Autonomous Database.
"localAdgAutoFailoverMaxDataLossLimit": 42, # Output only. This field indicates the maximum data loss limit for an Autonomous Database, in seconds.
"localDisasterRecoveryType": "A String", # Output only. This field indicates the local disaster recovery (DR) type of an Autonomous Database.
"localStandbyDb": { # Autonomous Data Guard standby database details. https://docs.oracle.com/en-us/iaas/api/#/en/database/20160918/datatypes/AutonomousDatabaseStandbySummary # Output only. The details of the Autonomous Data Guard standby database.
"dataGuardRoleChangedTime": "A String", # Output only. The date and time the Autonomous Data Guard role was switched for the standby Autonomous Database.
"disasterRecoveryRoleChangedTime": "A String", # Output only. The date and time the Disaster Recovery role was switched for the standby Autonomous Database.
"lagTimeDuration": "A String", # Output only. The amount of time, in seconds, that the data of the standby database lags in comparison to the data of the primary database.
"lifecycleDetails": "A String", # Output only. The additional details about the current lifecycle state of the Autonomous Database.
"state": "A String", # Output only. The current lifecycle state of the Autonomous Database.
},
"maintenanceBeginTime": "A String", # Output only. The date and time when maintenance will begin.
"maintenanceEndTime": "A String", # Output only. The date and time when maintenance will end.
"maintenanceScheduleType": "A String", # Optional. The maintenance schedule of the Autonomous Database.
"memoryPerOracleComputeUnitGbs": 42, # Output only. The amount of memory enabled per ECPU, in gigabytes.
"memoryTableGbs": 42, # Output only. The memory assigned to in-memory tables in an Autonomous Database.
"mtlsConnectionRequired": True or False, # Optional. This field specifies if the Autonomous Database requires mTLS connections.
"nCharacterSet": "A String", # Optional. The national character set for the Autonomous Database. The default is AL16UTF16.
"nextLongTermBackupTime": "A String", # Output only. The long term backup schedule of the Autonomous Database.
"ociUrl": "A String", # Output only. The Oracle Cloud Infrastructure link for the Autonomous Database.
"ocid": "A String", # Output only. OCID of the Autonomous Database. https://docs.oracle.com/en-us/iaas/Content/General/Concepts/identifiers.htm#Oracle
"openMode": "A String", # Output only. This field indicates the current mode of the Autonomous Database.
"operationsInsightsState": "A String", # Output only. This field indicates the state of Operations Insights for the Autonomous Database.
"peerDbIds": [ # Output only. The list of OCIDs of standby databases located in Autonomous Data Guard remote regions that are associated with the source database.
"A String",
],
"permissionLevel": "A String", # Output only. The permission level of the Autonomous Database.
"privateEndpoint": "A String", # Output only. The private endpoint for the Autonomous Database.
"privateEndpointIp": "A String", # Optional. The private endpoint IP address for the Autonomous Database.
"privateEndpointLabel": "A String", # Optional. The private endpoint label for the Autonomous Database.
"refreshableMode": "A String", # Output only. The refresh mode of the cloned Autonomous Database.
"refreshableState": "A String", # Output only. The refresh State of the clone.
"role": "A String", # Output only. The Data Guard role of the Autonomous Database.
"scheduledOperationDetails": [ # Output only. The list and details of the scheduled operations of the Autonomous Database.
{ # Details of scheduled operation. https://docs.oracle.com/en-us/iaas/api/#/en/database/20160918/datatypes/ScheduledOperationDetails
"dayOfWeek": "A String", # Output only. Day of week.
"startTime": { # Represents a time of day. The date and time zone are either not significant or are specified elsewhere. An API may choose to allow leap seconds. Related types are google.type.Date and `google.protobuf.Timestamp`. # Output only. Auto start time.
"hours": 42, # Hours of a day in 24 hour format. Must be greater than or equal to 0 and typically must be less than or equal to 23. An API may choose to allow the value "24:00:00" for scenarios like business closing time.
"minutes": 42, # Minutes of an hour. Must be greater than or equal to 0 and less than or equal to 59.
"nanos": 42, # Fractions of seconds, in nanoseconds. Must be greater than or equal to 0 and less than or equal to 999,999,999.
"seconds": 42, # Seconds of a minute. Must be greater than or equal to 0 and typically must be less than or equal to 59. An API may allow the value 60 if it allows leap-seconds.
},
"stopTime": { # Represents a time of day. The date and time zone are either not significant or are specified elsewhere. An API may choose to allow leap seconds. Related types are google.type.Date and `google.protobuf.Timestamp`. # Output only. Auto stop time.
"hours": 42, # Hours of a day in 24 hour format. Must be greater than or equal to 0 and typically must be less than or equal to 23. An API may choose to allow the value "24:00:00" for scenarios like business closing time.
"minutes": 42, # Minutes of an hour. Must be greater than or equal to 0 and less than or equal to 59.
"nanos": 42, # Fractions of seconds, in nanoseconds. Must be greater than or equal to 0 and less than or equal to 999,999,999.
"seconds": 42, # Seconds of a minute. Must be greater than or equal to 0 and typically must be less than or equal to 59. An API may allow the value 60 if it allows leap-seconds.
},
},
],
"secretId": "A String", # Optional. The ID of the Oracle Cloud Infrastructure vault secret.
"sqlWebDeveloperUrl": "A String", # Output only. The SQL Web Developer URL for the Autonomous Database.
"state": "A String", # Output only. The current lifecycle state of the Autonomous Database.
"supportedCloneRegions": [ # Output only. The list of available regions that can be used to create a clone for the Autonomous Database.
"A String",
],
"totalAutoBackupStorageSizeGbs": 3.14, # Output only. The storage space used by automatic backups of Autonomous Database, in gigabytes.
"usedDataStorageSizeTbs": 42, # Output only. The storage space used by Autonomous Database, in gigabytes.
"vaultId": "A String", # Optional. The ID of the Oracle Cloud Infrastructure vault.
},
"sourceConfig": { # The source configuration for the standby Autonomous Database. # Optional. The source Autonomous Database configuration for the standby Autonomous Database. The source Autonomous Database is configured while creating the Peer Autonomous Database and can't be updated after creation.
"automaticBackupsReplicationEnabled": True or False, # Optional. This field specifies if the replication of automatic backups is enabled when creating a Data Guard.
"autonomousDatabase": "A String", # Optional. The name of the primary Autonomous Database that is used to create a Peer Autonomous Database from a source.
},
}
autonomousDatabaseId: string, Required. The ID of the Autonomous Database to create. This value is restricted to (^[a-z]([a-z0-9-]{0,61}[a-z0-9])?$) and must be a maximum of 63 characters in length. The value must start with a letter and end with a letter or a number.
requestId: string, Optional. An optional ID to identify the request. This value is used to identify duplicate requests. If you make a request with the same request ID and the original request is still in progress or completed, the server ignores the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # This resource represents a long-running operation that is the result of a network API call.
"done": True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.
"error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation.
"code": 42, # The status code, which should be an enum value of google.rpc.Code.
"details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
{
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
],
"message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
},
"metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
"name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.
"response": { # The normal, successful response of the operation. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
}</pre>
</div>
<div class="method">
<code class="details" id="delete">delete(name, requestId=None, x__xgafv=None)</code>
<pre>Deletes a single Autonomous Database.
Args:
name: string, Required. The name of the resource in the following format: projects/{project}/locations/{location}/autonomousDatabases/{autonomous_database}. (required)
requestId: string, Optional. An optional ID to identify the request. This value is used to identify duplicate requests. If you make a request with the same request ID and the original request is still in progress or completed, the server ignores the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # This resource represents a long-running operation that is the result of a network API call.
"done": True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.
"error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation.
"code": 42, # The status code, which should be an enum value of google.rpc.Code.
"details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
{
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
],
"message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
},
"metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
"name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.
"response": { # The normal, successful response of the operation. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
}</pre>
</div>
<div class="method">
<code class="details" id="generateWallet">generateWallet(name, body=None, x__xgafv=None)</code>
<pre>Generates a wallet for an Autonomous Database.
Args:
name: string, Required. The name of the Autonomous Database in the following format: projects/{project}/locations/{location}/autonomousDatabases/{autonomous_database}. (required)
body: object, The request body.
The object takes the form of:
{ # The request for `AutonomousDatabase.GenerateWallet`.
"isRegional": True or False, # Optional. True when requesting regional connection strings in PDB connect info, applicable to cross-region Data Guard only.
"password": "A String", # Required. The password used to encrypt the keys inside the wallet. The password must be a minimum of 8 characters.
"type": "A String", # Optional. The type of wallet generation for the Autonomous Database. The default value is SINGLE.
}
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # The response for `AutonomousDatabase.GenerateWallet`.
"archiveContent": "A String", # Output only. The base64 encoded wallet files.
}</pre>
</div>
<div class="method">
<code class="details" id="get">get(name, x__xgafv=None)</code>
<pre>Gets the details of a single Autonomous Database.
Args:
name: string, Required. The name of the Autonomous Database in the following format: projects/{project}/locations/{location}/autonomousDatabases/{autonomous_database}. (required)
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # Details of the Autonomous Database resource. https://docs.oracle.com/en-us/iaas/api/#/en/database/20160918/AutonomousDatabase/
"adminPassword": "A String", # Optional. The password for the default ADMIN user.
"cidr": "A String", # Optional. The subnet CIDR range for the Autonomous Database.
"createTime": "A String", # Output only. The date and time that the Autonomous Database was created.
"database": "A String", # Optional. The name of the Autonomous Database. The database name must be unique in the project. The name must begin with a letter and can contain a maximum of 30 alphanumeric characters.
"disasterRecoverySupportedLocations": [ # Output only. List of supported GCP region to clone the Autonomous Database for disaster recovery. Format: `project/{project}/locations/{location}`.
"A String",
],
"displayName": "A String", # Optional. The display name for the Autonomous Database. The name does not have to be unique within your project.
"entitlementId": "A String", # Output only. The ID of the subscription entitlement associated with the Autonomous Database.
"labels": { # Optional. The labels or tags associated with the Autonomous Database.
"a_key": "A String",
},
"name": "A String", # Identifier. The name of the Autonomous Database resource in the following format: projects/{project}/locations/{region}/autonomousDatabases/{autonomous_database}
"network": "A String", # Optional. The name of the VPC network used by the Autonomous Database in the following format: projects/{project}/global/networks/{network}
"odbNetwork": "A String", # Optional. The name of the OdbNetwork associated with the Autonomous Database. Format: projects/{project}/locations/{location}/odbNetworks/{odb_network} It is optional but if specified, this should match the parent ODBNetwork of the OdbSubnet.
"odbSubnet": "A String", # Optional. The name of the OdbSubnet associated with the Autonomous Database. Format: projects/{project}/locations/{location}/odbNetworks/{odb_network}/odbSubnets/{odb_subnet}
"peerAutonomousDatabases": [ # Output only. The peer Autonomous Database names of the given Autonomous Database.
"A String",
],
"properties": { # The properties of an Autonomous Database. # Optional. The properties of the Autonomous Database.
"actualUsedDataStorageSizeTb": 3.14, # Output only. The amount of storage currently being used for user and system data, in terabytes.
"allocatedStorageSizeTb": 3.14, # Output only. The amount of storage currently allocated for the database tables and billed for, rounded up in terabytes.
"allowlistedIps": [ # Optional. The list of allowlisted IP addresses for the Autonomous Database.
"A String",
],
"apexDetails": { # Oracle APEX Application Development. https://docs.oracle.com/en-us/iaas/api/#/en/database/20160918/datatypes/AutonomousDatabaseApex # Output only. The details for the Oracle APEX Application Development.
"apexVersion": "A String", # Output only. The Oracle APEX Application Development version.
"ordsVersion": "A String", # Output only. The Oracle REST Data Services (ORDS) version.
},
"arePrimaryAllowlistedIpsUsed": True or False, # Output only. This field indicates the status of Data Guard and Access control for the Autonomous Database. The field's value is null if Data Guard is disabled or Access Control is disabled. The field's value is TRUE if both Data Guard and Access Control are enabled, and the Autonomous Database is using primary IP access control list (ACL) for standby. The field's value is FALSE if both Data Guard and Access Control are enabled, and the Autonomous Database is using a different IP access control list (ACL) for standby compared to primary.
"autonomousContainerDatabaseId": "A String", # Output only. The Autonomous Container Database OCID.
"availableUpgradeVersions": [ # Output only. The list of available Oracle Database upgrade versions for an Autonomous Database.
"A String",
],
"backupRetentionPeriodDays": 42, # Optional. The retention period for the Autonomous Database. This field is specified in days, can range from 1 day to 60 days, and has a default value of 60 days.
"characterSet": "A String", # Optional. The character set for the Autonomous Database. The default is AL32UTF8.
"computeCount": 3.14, # Optional. The number of compute servers for the Autonomous Database.
"connectionStrings": { # The connection string used to connect to the Autonomous Database. https://docs.oracle.com/en-us/iaas/api/#/en/database/20160918/datatypes/AutonomousDatabaseConnectionStrings # Output only. The connection strings used to connect to an Autonomous Database.
"allConnectionStrings": { # A list of all connection strings that can be used to connect to the Autonomous Database. # Output only. Returns all connection strings that can be used to connect to the Autonomous Database.
"high": "A String", # Output only. The database service provides the highest level of resources to each SQL statement.
"low": "A String", # Output only. The database service provides the least level of resources to each SQL statement.
"medium": "A String", # Output only. The database service provides a lower level of resources to each SQL statement.
},
"dedicated": "A String", # Output only. The database service provides the least level of resources to each SQL statement, but supports the most number of concurrent SQL statements.
"high": "A String", # Output only. The database service provides the highest level of resources to each SQL statement.
"low": "A String", # Output only. The database service provides the least level of resources to each SQL statement.
"medium": "A String", # Output only. The database service provides a lower level of resources to each SQL statement.
"profiles": [ # Output only. A list of connection string profiles to allow clients to group, filter, and select values based on the structured metadata.
{ # The connection string profile to allow clients to group. https://docs.oracle.com/en-us/iaas/api/#/en/database/20160918/datatypes/DatabaseConnectionStringProfile
"consumerGroup": "A String", # Output only. The current consumer group being used by the connection.
"displayName": "A String", # Output only. The display name for the database connection.
"hostFormat": "A String", # Output only. The host name format being currently used in connection string.
"isRegional": True or False, # Output only. This field indicates if the connection string is regional and is only applicable for cross-region Data Guard.
"protocol": "A String", # Output only. The protocol being used by the connection.
"sessionMode": "A String", # Output only. The current session mode of the connection.
"syntaxFormat": "A String", # Output only. The syntax of the connection string.
"tlsAuthentication": "A String", # Output only. This field indicates the TLS authentication type of the connection.
"value": "A String", # Output only. The value of the connection string.
},
],
},
"connectionUrls": { # The URLs for accessing Oracle Application Express (APEX) and SQL Developer Web with a browser from a Compute instance. https://docs.oracle.com/en-us/iaas/api/#/en/database/20160918/datatypes/AutonomousDatabaseConnectionUrls # Output only. The Oracle Connection URLs for an Autonomous Database.
"apexUri": "A String", # Output only. Oracle Application Express (APEX) URL.
"databaseTransformsUri": "A String", # Output only. The URL of the Database Transforms for the Autonomous Database.
"graphStudioUri": "A String", # Output only. The URL of the Graph Studio for the Autonomous Database.
"machineLearningNotebookUri": "A String", # Output only. The URL of the Oracle Machine Learning (OML) Notebook for the Autonomous Database.
"machineLearningUserManagementUri": "A String", # Output only. The URL of Machine Learning user management the Autonomous Database.
"mongoDbUri": "A String", # Output only. The URL of the MongoDB API for the Autonomous Database.
"ordsUri": "A String", # Output only. The Oracle REST Data Services (ORDS) URL of the Web Access for the Autonomous Database.
"sqlDevWebUri": "A String", # Output only. The URL of the Oracle SQL Developer Web for the Autonomous Database.
},
"cpuCoreCount": 42, # Optional. The number of CPU cores to be made available to the database.
"customerContacts": [ # Optional. The list of customer contacts.
{ # The CustomerContact reference as defined by Oracle. https://docs.oracle.com/en-us/iaas/api/#/en/database/20160918/datatypes/CustomerContact
"email": "A String", # Required. The email address used by Oracle to send notifications regarding databases and infrastructure.
},
],
"dataGuardRoleChangedTime": "A String", # Output only. The date and time the Autonomous Data Guard role was changed for the standby Autonomous Database.
"dataSafeState": "A String", # Output only. The current state of the Data Safe registration for the Autonomous Database.
"dataStorageSizeGb": 42, # Optional. The size of the data stored in the database, in gigabytes.
"dataStorageSizeTb": 42, # Optional. The size of the data stored in the database, in terabytes.
"databaseManagementState": "A String", # Output only. The current state of database management for the Autonomous Database.
"dbEdition": "A String", # Optional. The edition of the Autonomous Databases.
"dbVersion": "A String", # Optional. The Oracle Database version for the Autonomous Database.
"dbWorkload": "A String", # Required. The workload type of the Autonomous Database.
"disasterRecoveryRoleChangedTime": "A String", # Output only. The date and time the Disaster Recovery role was changed for the standby Autonomous Database.
"failedDataRecoveryDuration": "A String", # Output only. This field indicates the number of seconds of data loss during a Data Guard failover.
"isAutoScalingEnabled": True or False, # Optional. This field indicates if auto scaling is enabled for the Autonomous Database CPU core count.
"isLocalDataGuardEnabled": True or False, # Output only. This field indicates whether the Autonomous Database has local (in-region) Data Guard enabled.
"isStorageAutoScalingEnabled": True or False, # Optional. This field indicates if auto scaling is enabled for the Autonomous Database storage.
"licenseType": "A String", # Required. The license type used for the Autonomous Database.
"lifecycleDetails": "A String", # Output only. The details of the current lifestyle state of the Autonomous Database.
"localAdgAutoFailoverMaxDataLossLimit": 42, # Output only. This field indicates the maximum data loss limit for an Autonomous Database, in seconds.
"localDisasterRecoveryType": "A String", # Output only. This field indicates the local disaster recovery (DR) type of an Autonomous Database.
"localStandbyDb": { # Autonomous Data Guard standby database details. https://docs.oracle.com/en-us/iaas/api/#/en/database/20160918/datatypes/AutonomousDatabaseStandbySummary # Output only. The details of the Autonomous Data Guard standby database.
"dataGuardRoleChangedTime": "A String", # Output only. The date and time the Autonomous Data Guard role was switched for the standby Autonomous Database.
"disasterRecoveryRoleChangedTime": "A String", # Output only. The date and time the Disaster Recovery role was switched for the standby Autonomous Database.
"lagTimeDuration": "A String", # Output only. The amount of time, in seconds, that the data of the standby database lags in comparison to the data of the primary database.
"lifecycleDetails": "A String", # Output only. The additional details about the current lifecycle state of the Autonomous Database.
"state": "A String", # Output only. The current lifecycle state of the Autonomous Database.
},
"maintenanceBeginTime": "A String", # Output only. The date and time when maintenance will begin.
"maintenanceEndTime": "A String", # Output only. The date and time when maintenance will end.
"maintenanceScheduleType": "A String", # Optional. The maintenance schedule of the Autonomous Database.
"memoryPerOracleComputeUnitGbs": 42, # Output only. The amount of memory enabled per ECPU, in gigabytes.
"memoryTableGbs": 42, # Output only. The memory assigned to in-memory tables in an Autonomous Database.
"mtlsConnectionRequired": True or False, # Optional. This field specifies if the Autonomous Database requires mTLS connections.
"nCharacterSet": "A String", # Optional. The national character set for the Autonomous Database. The default is AL16UTF16.
"nextLongTermBackupTime": "A String", # Output only. The long term backup schedule of the Autonomous Database.
"ociUrl": "A String", # Output only. The Oracle Cloud Infrastructure link for the Autonomous Database.
"ocid": "A String", # Output only. OCID of the Autonomous Database. https://docs.oracle.com/en-us/iaas/Content/General/Concepts/identifiers.htm#Oracle
"openMode": "A String", # Output only. This field indicates the current mode of the Autonomous Database.
"operationsInsightsState": "A String", # Output only. This field indicates the state of Operations Insights for the Autonomous Database.
"peerDbIds": [ # Output only. The list of OCIDs of standby databases located in Autonomous Data Guard remote regions that are associated with the source database.
"A String",
],
"permissionLevel": "A String", # Output only. The permission level of the Autonomous Database.
"privateEndpoint": "A String", # Output only. The private endpoint for the Autonomous Database.
"privateEndpointIp": "A String", # Optional. The private endpoint IP address for the Autonomous Database.
"privateEndpointLabel": "A String", # Optional. The private endpoint label for the Autonomous Database.
"refreshableMode": "A String", # Output only. The refresh mode of the cloned Autonomous Database.
"refreshableState": "A String", # Output only. The refresh State of the clone.
"role": "A String", # Output only. The Data Guard role of the Autonomous Database.
"scheduledOperationDetails": [ # Output only. The list and details of the scheduled operations of the Autonomous Database.
{ # Details of scheduled operation. https://docs.oracle.com/en-us/iaas/api/#/en/database/20160918/datatypes/ScheduledOperationDetails
"dayOfWeek": "A String", # Output only. Day of week.
"startTime": { # Represents a time of day. The date and time zone are either not significant or are specified elsewhere. An API may choose to allow leap seconds. Related types are google.type.Date and `google.protobuf.Timestamp`. # Output only. Auto start time.
"hours": 42, # Hours of a day in 24 hour format. Must be greater than or equal to 0 and typically must be less than or equal to 23. An API may choose to allow the value "24:00:00" for scenarios like business closing time.
"minutes": 42, # Minutes of an hour. Must be greater than or equal to 0 and less than or equal to 59.
"nanos": 42, # Fractions of seconds, in nanoseconds. Must be greater than or equal to 0 and less than or equal to 999,999,999.
"seconds": 42, # Seconds of a minute. Must be greater than or equal to 0 and typically must be less than or equal to 59. An API may allow the value 60 if it allows leap-seconds.
},
"stopTime": { # Represents a time of day. The date and time zone are either not significant or are specified elsewhere. An API may choose to allow leap seconds. Related types are google.type.Date and `google.protobuf.Timestamp`. # Output only. Auto stop time.
"hours": 42, # Hours of a day in 24 hour format. Must be greater than or equal to 0 and typically must be less than or equal to 23. An API may choose to allow the value "24:00:00" for scenarios like business closing time.
"minutes": 42, # Minutes of an hour. Must be greater than or equal to 0 and less than or equal to 59.
"nanos": 42, # Fractions of seconds, in nanoseconds. Must be greater than or equal to 0 and less than or equal to 999,999,999.
"seconds": 42, # Seconds of a minute. Must be greater than or equal to 0 and typically must be less than or equal to 59. An API may allow the value 60 if it allows leap-seconds.
},
},
],
"secretId": "A String", # Optional. The ID of the Oracle Cloud Infrastructure vault secret.
"sqlWebDeveloperUrl": "A String", # Output only. The SQL Web Developer URL for the Autonomous Database.
"state": "A String", # Output only. The current lifecycle state of the Autonomous Database.
"supportedCloneRegions": [ # Output only. The list of available regions that can be used to create a clone for the Autonomous Database.
"A String",
],
"totalAutoBackupStorageSizeGbs": 3.14, # Output only. The storage space used by automatic backups of Autonomous Database, in gigabytes.
"usedDataStorageSizeTbs": 42, # Output only. The storage space used by Autonomous Database, in gigabytes.
"vaultId": "A String", # Optional. The ID of the Oracle Cloud Infrastructure vault.
},
"sourceConfig": { # The source configuration for the standby Autonomous Database. # Optional. The source Autonomous Database configuration for the standby Autonomous Database. The source Autonomous Database is configured while creating the Peer Autonomous Database and can't be updated after creation.
"automaticBackupsReplicationEnabled": True or False, # Optional. This field specifies if the replication of automatic backups is enabled when creating a Data Guard.
"autonomousDatabase": "A String", # Optional. The name of the primary Autonomous Database that is used to create a Peer Autonomous Database from a source.
},
}</pre>
</div>
<div class="method">
<code class="details" id="list">list(parent, filter=None, orderBy=None, pageSize=None, pageToken=None, x__xgafv=None)</code>
<pre>Lists the Autonomous Databases in a given project and location.
Args:
parent: string, Required. The parent value for the Autonomous Database in the following format: projects/{project}/locations/{location}. (required)
filter: string, Optional. An expression for filtering the results of the request.
orderBy: string, Optional. An expression for ordering the results of the request.
pageSize: integer, Optional. The maximum number of items to return. If unspecified, at most 50 Autonomous Database will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000.
pageToken: string, Optional. A token identifying a page of results the server should return.
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # The response for `AutonomousDatabase.List`.
"autonomousDatabases": [ # The list of Autonomous Databases.
{ # Details of the Autonomous Database resource. https://docs.oracle.com/en-us/iaas/api/#/en/database/20160918/AutonomousDatabase/
"adminPassword": "A String", # Optional. The password for the default ADMIN user.
"cidr": "A String", # Optional. The subnet CIDR range for the Autonomous Database.
"createTime": "A String", # Output only. The date and time that the Autonomous Database was created.
"database": "A String", # Optional. The name of the Autonomous Database. The database name must be unique in the project. The name must begin with a letter and can contain a maximum of 30 alphanumeric characters.
"disasterRecoverySupportedLocations": [ # Output only. List of supported GCP region to clone the Autonomous Database for disaster recovery. Format: `project/{project}/locations/{location}`.
"A String",
],
"displayName": "A String", # Optional. The display name for the Autonomous Database. The name does not have to be unique within your project.
"entitlementId": "A String", # Output only. The ID of the subscription entitlement associated with the Autonomous Database.
"labels": { # Optional. The labels or tags associated with the Autonomous Database.
"a_key": "A String",
},
"name": "A String", # Identifier. The name of the Autonomous Database resource in the following format: projects/{project}/locations/{region}/autonomousDatabases/{autonomous_database}
"network": "A String", # Optional. The name of the VPC network used by the Autonomous Database in the following format: projects/{project}/global/networks/{network}
"odbNetwork": "A String", # Optional. The name of the OdbNetwork associated with the Autonomous Database. Format: projects/{project}/locations/{location}/odbNetworks/{odb_network} It is optional but if specified, this should match the parent ODBNetwork of the OdbSubnet.
"odbSubnet": "A String", # Optional. The name of the OdbSubnet associated with the Autonomous Database. Format: projects/{project}/locations/{location}/odbNetworks/{odb_network}/odbSubnets/{odb_subnet}
"peerAutonomousDatabases": [ # Output only. The peer Autonomous Database names of the given Autonomous Database.
"A String",
],
"properties": { # The properties of an Autonomous Database. # Optional. The properties of the Autonomous Database.
"actualUsedDataStorageSizeTb": 3.14, # Output only. The amount of storage currently being used for user and system data, in terabytes.
"allocatedStorageSizeTb": 3.14, # Output only. The amount of storage currently allocated for the database tables and billed for, rounded up in terabytes.
"allowlistedIps": [ # Optional. The list of allowlisted IP addresses for the Autonomous Database.
"A String",
],
"apexDetails": { # Oracle APEX Application Development. https://docs.oracle.com/en-us/iaas/api/#/en/database/20160918/datatypes/AutonomousDatabaseApex # Output only. The details for the Oracle APEX Application Development.
"apexVersion": "A String", # Output only. The Oracle APEX Application Development version.
"ordsVersion": "A String", # Output only. The Oracle REST Data Services (ORDS) version.
},
"arePrimaryAllowlistedIpsUsed": True or False, # Output only. This field indicates the status of Data Guard and Access control for the Autonomous Database. The field's value is null if Data Guard is disabled or Access Control is disabled. The field's value is TRUE if both Data Guard and Access Control are enabled, and the Autonomous Database is using primary IP access control list (ACL) for standby. The field's value is FALSE if both Data Guard and Access Control are enabled, and the Autonomous Database is using a different IP access control list (ACL) for standby compared to primary.
"autonomousContainerDatabaseId": "A String", # Output only. The Autonomous Container Database OCID.
"availableUpgradeVersions": [ # Output only. The list of available Oracle Database upgrade versions for an Autonomous Database.
"A String",
],
"backupRetentionPeriodDays": 42, # Optional. The retention period for the Autonomous Database. This field is specified in days, can range from 1 day to 60 days, and has a default value of 60 days.
"characterSet": "A String", # Optional. The character set for the Autonomous Database. The default is AL32UTF8.
"computeCount": 3.14, # Optional. The number of compute servers for the Autonomous Database.
"connectionStrings": { # The connection string used to connect to the Autonomous Database. https://docs.oracle.com/en-us/iaas/api/#/en/database/20160918/datatypes/AutonomousDatabaseConnectionStrings # Output only. The connection strings used to connect to an Autonomous Database.
"allConnectionStrings": { # A list of all connection strings that can be used to connect to the Autonomous Database. # Output only. Returns all connection strings that can be used to connect to the Autonomous Database.
"high": "A String", # Output only. The database service provides the highest level of resources to each SQL statement.
"low": "A String", # Output only. The database service provides the least level of resources to each SQL statement.
"medium": "A String", # Output only. The database service provides a lower level of resources to each SQL statement.
},
"dedicated": "A String", # Output only. The database service provides the least level of resources to each SQL statement, but supports the most number of concurrent SQL statements.
"high": "A String", # Output only. The database service provides the highest level of resources to each SQL statement.
"low": "A String", # Output only. The database service provides the least level of resources to each SQL statement.
"medium": "A String", # Output only. The database service provides a lower level of resources to each SQL statement.
"profiles": [ # Output only. A list of connection string profiles to allow clients to group, filter, and select values based on the structured metadata.
{ # The connection string profile to allow clients to group. https://docs.oracle.com/en-us/iaas/api/#/en/database/20160918/datatypes/DatabaseConnectionStringProfile
"consumerGroup": "A String", # Output only. The current consumer group being used by the connection.
"displayName": "A String", # Output only. The display name for the database connection.
"hostFormat": "A String", # Output only. The host name format being currently used in connection string.
"isRegional": True or False, # Output only. This field indicates if the connection string is regional and is only applicable for cross-region Data Guard.
"protocol": "A String", # Output only. The protocol being used by the connection.
"sessionMode": "A String", # Output only. The current session mode of the connection.
"syntaxFormat": "A String", # Output only. The syntax of the connection string.
"tlsAuthentication": "A String", # Output only. This field indicates the TLS authentication type of the connection.
"value": "A String", # Output only. The value of the connection string.
},
],
},
"connectionUrls": { # The URLs for accessing Oracle Application Express (APEX) and SQL Developer Web with a browser from a Compute instance. https://docs.oracle.com/en-us/iaas/api/#/en/database/20160918/datatypes/AutonomousDatabaseConnectionUrls # Output only. The Oracle Connection URLs for an Autonomous Database.
"apexUri": "A String", # Output only. Oracle Application Express (APEX) URL.
"databaseTransformsUri": "A String", # Output only. The URL of the Database Transforms for the Autonomous Database.
"graphStudioUri": "A String", # Output only. The URL of the Graph Studio for the Autonomous Database.
"machineLearningNotebookUri": "A String", # Output only. The URL of the Oracle Machine Learning (OML) Notebook for the Autonomous Database.
"machineLearningUserManagementUri": "A String", # Output only. The URL of Machine Learning user management the Autonomous Database.
"mongoDbUri": "A String", # Output only. The URL of the MongoDB API for the Autonomous Database.
"ordsUri": "A String", # Output only. The Oracle REST Data Services (ORDS) URL of the Web Access for the Autonomous Database.
"sqlDevWebUri": "A String", # Output only. The URL of the Oracle SQL Developer Web for the Autonomous Database.
},
"cpuCoreCount": 42, # Optional. The number of CPU cores to be made available to the database.
"customerContacts": [ # Optional. The list of customer contacts.
{ # The CustomerContact reference as defined by Oracle. https://docs.oracle.com/en-us/iaas/api/#/en/database/20160918/datatypes/CustomerContact
"email": "A String", # Required. The email address used by Oracle to send notifications regarding databases and infrastructure.
},
],
"dataGuardRoleChangedTime": "A String", # Output only. The date and time the Autonomous Data Guard role was changed for the standby Autonomous Database.
"dataSafeState": "A String", # Output only. The current state of the Data Safe registration for the Autonomous Database.
"dataStorageSizeGb": 42, # Optional. The size of the data stored in the database, in gigabytes.
"dataStorageSizeTb": 42, # Optional. The size of the data stored in the database, in terabytes.
"databaseManagementState": "A String", # Output only. The current state of database management for the Autonomous Database.
"dbEdition": "A String", # Optional. The edition of the Autonomous Databases.
"dbVersion": "A String", # Optional. The Oracle Database version for the Autonomous Database.
"dbWorkload": "A String", # Required. The workload type of the Autonomous Database.
"disasterRecoveryRoleChangedTime": "A String", # Output only. The date and time the Disaster Recovery role was changed for the standby Autonomous Database.
"failedDataRecoveryDuration": "A String", # Output only. This field indicates the number of seconds of data loss during a Data Guard failover.
"isAutoScalingEnabled": True or False, # Optional. This field indicates if auto scaling is enabled for the Autonomous Database CPU core count.
"isLocalDataGuardEnabled": True or False, # Output only. This field indicates whether the Autonomous Database has local (in-region) Data Guard enabled.
"isStorageAutoScalingEnabled": True or False, # Optional. This field indicates if auto scaling is enabled for the Autonomous Database storage.
"licenseType": "A String", # Required. The license type used for the Autonomous Database.
"lifecycleDetails": "A String", # Output only. The details of the current lifestyle state of the Autonomous Database.
"localAdgAutoFailoverMaxDataLossLimit": 42, # Output only. This field indicates the maximum data loss limit for an Autonomous Database, in seconds.
"localDisasterRecoveryType": "A String", # Output only. This field indicates the local disaster recovery (DR) type of an Autonomous Database.
"localStandbyDb": { # Autonomous Data Guard standby database details. https://docs.oracle.com/en-us/iaas/api/#/en/database/20160918/datatypes/AutonomousDatabaseStandbySummary # Output only. The details of the Autonomous Data Guard standby database.
"dataGuardRoleChangedTime": "A String", # Output only. The date and time the Autonomous Data Guard role was switched for the standby Autonomous Database.
"disasterRecoveryRoleChangedTime": "A String", # Output only. The date and time the Disaster Recovery role was switched for the standby Autonomous Database.
"lagTimeDuration": "A String", # Output only. The amount of time, in seconds, that the data of the standby database lags in comparison to the data of the primary database.
"lifecycleDetails": "A String", # Output only. The additional details about the current lifecycle state of the Autonomous Database.
"state": "A String", # Output only. The current lifecycle state of the Autonomous Database.
},
"maintenanceBeginTime": "A String", # Output only. The date and time when maintenance will begin.
"maintenanceEndTime": "A String", # Output only. The date and time when maintenance will end.
"maintenanceScheduleType": "A String", # Optional. The maintenance schedule of the Autonomous Database.
"memoryPerOracleComputeUnitGbs": 42, # Output only. The amount of memory enabled per ECPU, in gigabytes.
"memoryTableGbs": 42, # Output only. The memory assigned to in-memory tables in an Autonomous Database.
"mtlsConnectionRequired": True or False, # Optional. This field specifies if the Autonomous Database requires mTLS connections.
"nCharacterSet": "A String", # Optional. The national character set for the Autonomous Database. The default is AL16UTF16.
"nextLongTermBackupTime": "A String", # Output only. The long term backup schedule of the Autonomous Database.
"ociUrl": "A String", # Output only. The Oracle Cloud Infrastructure link for the Autonomous Database.
"ocid": "A String", # Output only. OCID of the Autonomous Database. https://docs.oracle.com/en-us/iaas/Content/General/Concepts/identifiers.htm#Oracle
"openMode": "A String", # Output only. This field indicates the current mode of the Autonomous Database.
"operationsInsightsState": "A String", # Output only. This field indicates the state of Operations Insights for the Autonomous Database.
"peerDbIds": [ # Output only. The list of OCIDs of standby databases located in Autonomous Data Guard remote regions that are associated with the source database.
"A String",
],
"permissionLevel": "A String", # Output only. The permission level of the Autonomous Database.
"privateEndpoint": "A String", # Output only. The private endpoint for the Autonomous Database.
"privateEndpointIp": "A String", # Optional. The private endpoint IP address for the Autonomous Database.
"privateEndpointLabel": "A String", # Optional. The private endpoint label for the Autonomous Database.
"refreshableMode": "A String", # Output only. The refresh mode of the cloned Autonomous Database.
"refreshableState": "A String", # Output only. The refresh State of the clone.
"role": "A String", # Output only. The Data Guard role of the Autonomous Database.
"scheduledOperationDetails": [ # Output only. The list and details of the scheduled operations of the Autonomous Database.
{ # Details of scheduled operation. https://docs.oracle.com/en-us/iaas/api/#/en/database/20160918/datatypes/ScheduledOperationDetails
"dayOfWeek": "A String", # Output only. Day of week.
"startTime": { # Represents a time of day. The date and time zone are either not significant or are specified elsewhere. An API may choose to allow leap seconds. Related types are google.type.Date and `google.protobuf.Timestamp`. # Output only. Auto start time.
"hours": 42, # Hours of a day in 24 hour format. Must be greater than or equal to 0 and typically must be less than or equal to 23. An API may choose to allow the value "24:00:00" for scenarios like business closing time.
"minutes": 42, # Minutes of an hour. Must be greater than or equal to 0 and less than or equal to 59.
"nanos": 42, # Fractions of seconds, in nanoseconds. Must be greater than or equal to 0 and less than or equal to 999,999,999.
"seconds": 42, # Seconds of a minute. Must be greater than or equal to 0 and typically must be less than or equal to 59. An API may allow the value 60 if it allows leap-seconds.
},
"stopTime": { # Represents a time of day. The date and time zone are either not significant or are specified elsewhere. An API may choose to allow leap seconds. Related types are google.type.Date and `google.protobuf.Timestamp`. # Output only. Auto stop time.
"hours": 42, # Hours of a day in 24 hour format. Must be greater than or equal to 0 and typically must be less than or equal to 23. An API may choose to allow the value "24:00:00" for scenarios like business closing time.
"minutes": 42, # Minutes of an hour. Must be greater than or equal to 0 and less than or equal to 59.
"nanos": 42, # Fractions of seconds, in nanoseconds. Must be greater than or equal to 0 and less than or equal to 999,999,999.
"seconds": 42, # Seconds of a minute. Must be greater than or equal to 0 and typically must be less than or equal to 59. An API may allow the value 60 if it allows leap-seconds.
},
},
],
"secretId": "A String", # Optional. The ID of the Oracle Cloud Infrastructure vault secret.
"sqlWebDeveloperUrl": "A String", # Output only. The SQL Web Developer URL for the Autonomous Database.
"state": "A String", # Output only. The current lifecycle state of the Autonomous Database.
"supportedCloneRegions": [ # Output only. The list of available regions that can be used to create a clone for the Autonomous Database.
"A String",
],
"totalAutoBackupStorageSizeGbs": 3.14, # Output only. The storage space used by automatic backups of Autonomous Database, in gigabytes.
"usedDataStorageSizeTbs": 42, # Output only. The storage space used by Autonomous Database, in gigabytes.
"vaultId": "A String", # Optional. The ID of the Oracle Cloud Infrastructure vault.
},
"sourceConfig": { # The source configuration for the standby Autonomous Database. # Optional. The source Autonomous Database configuration for the standby Autonomous Database. The source Autonomous Database is configured while creating the Peer Autonomous Database and can't be updated after creation.
"automaticBackupsReplicationEnabled": True or False, # Optional. This field specifies if the replication of automatic backups is enabled when creating a Data Guard.
"autonomousDatabase": "A String", # Optional. The name of the primary Autonomous Database that is used to create a Peer Autonomous Database from a source.
},
},
],
"nextPageToken": "A String", # A token identifying a page of results the server should return.
}</pre>
</div>
<div class="method">
<code class="details" id="list_next">list_next()</code>
<pre>Retrieves the next page of results.
Args:
previous_request: The request for the previous page. (required)
previous_response: The response from the request for the previous page. (required)
Returns:
A request object that you can call 'execute()' on to request the next
page. Returns None if there are no more items in the collection.
</pre>
</div>
<div class="method">
<code class="details" id="restart">restart(name, body=None, x__xgafv=None)</code>
<pre>Restarts an Autonomous Database.
Args:
name: string, Required. The name of the Autonomous Database in the following format: projects/{project}/locations/{location}/autonomousDatabases/{autonomous_database}. (required)
body: object, The request body.
The object takes the form of:
{ # The request for `AutonomousDatabase.Restart`.
}
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # This resource represents a long-running operation that is the result of a network API call.
"done": True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.
"error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation.
"code": 42, # The status code, which should be an enum value of google.rpc.Code.
"details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
{
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
],
"message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
},
"metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
"name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.
"response": { # The normal, successful response of the operation. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
}</pre>
</div>
<div class="method">
<code class="details" id="restore">restore(name, body=None, x__xgafv=None)</code>
<pre>Restores a single Autonomous Database.
Args:
name: string, Required. The name of the Autonomous Database in the following format: projects/{project}/locations/{location}/autonomousDatabases/{autonomous_database}. (required)
body: object, The request body.
The object takes the form of:
{ # The request for `AutonomousDatabase.Restore`.
"restoreTime": "A String", # Required. The time and date to restore the database to.
}
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # This resource represents a long-running operation that is the result of a network API call.
"done": True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.
"error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation.
"code": 42, # The status code, which should be an enum value of google.rpc.Code.
"details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
{
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
],
"message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
},
"metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
"name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.
"response": { # The normal, successful response of the operation. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
}</pre>
</div>
<div class="method">
<code class="details" id="start">start(name, body=None, x__xgafv=None)</code>
<pre>Starts an Autonomous Database.
Args:
name: string, Required. The name of the Autonomous Database in the following format: projects/{project}/locations/{location}/autonomousDatabases/{autonomous_database}. (required)
body: object, The request body.
The object takes the form of:
{ # The request for `AutonomousDatabase.Start`.
}
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # This resource represents a long-running operation that is the result of a network API call.
"done": True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.
"error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation.
"code": 42, # The status code, which should be an enum value of google.rpc.Code.
"details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
{
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
],
"message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
},
"metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
"name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.
"response": { # The normal, successful response of the operation. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
}</pre>
</div>
<div class="method">
<code class="details" id="stop">stop(name, body=None, x__xgafv=None)</code>
<pre>Stops an Autonomous Database.
Args:
name: string, Required. The name of the Autonomous Database in the following format: projects/{project}/locations/{location}/autonomousDatabases/{autonomous_database}. (required)
body: object, The request body.
The object takes the form of:
{ # The request for `AutonomousDatabase.Stop`.
}
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # This resource represents a long-running operation that is the result of a network API call.
"done": True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.
"error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation.
"code": 42, # The status code, which should be an enum value of google.rpc.Code.
"details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
{
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
],
"message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
},
"metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
"name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.
"response": { # The normal, successful response of the operation. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
}</pre>
</div>
<div class="method">
<code class="details" id="switchover">switchover(name, body=None, x__xgafv=None)</code>
<pre>Initiates a switchover of specified autonomous database to the associated peer database.
Args:
name: string, Required. The name of the Autonomous Database in the following format: projects/{project}/locations/{location}/autonomousDatabases/{autonomous_database}. (required)
body: object, The request body.
The object takes the form of:
{ # The request for `OracleDatabase.SwitchoverAutonomousDatabase`.
"peerAutonomousDatabase": "A String", # Required. The peer database name to switch over to.
}
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # This resource represents a long-running operation that is the result of a network API call.
"done": True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.
"error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation.
"code": 42, # The status code, which should be an enum value of google.rpc.Code.
"details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
{
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
],
"message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
},
"metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
"name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.
"response": { # The normal, successful response of the operation. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
}</pre>
</div>
</body></html>
|