{ "opencollection": "1.0.0", "info": { "name": "Service Database API", "version": "20160918" }, "items": [ { "info": { "name": "database", "type": "folder" }, "items": [ { "info": { "name": "Gets a list of application virtual IP (VIP) addresses on a cloud VM cluster.", "type": "http" }, "http": { "method": "GET", "url": "http://localhost:19222/20160918/applicationVip", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "compartmentId", "value": "", "type": "query", "description": "The compartment [OCID](/Content/General/Concepts/identifiers.htm)." }, { "name": "limit", "value": "", "type": "query", "description": "The maximum number of items to return per page." }, { "name": "page", "value": "", "type": "query", "description": "The pagination token to continue listing from." }, { "name": "cloudVmClusterId", "value": "", "type": "query", "description": "The [OCID](/Content/General/Concepts/identifiers.htm) of the cloud VM cluster associated with the application virtual IP (VIP) address." }, { "name": "sortOrder", "value": "", "type": "query", "description": "The sort order to use, either ascending (`ASC`) or descending (`DESC`)." }, { "name": "sortBy", "value": "", "type": "query", "description": "The field to sort by. You can provide one sort order (`sortOrder`).\nDefault order for TIMECREATED is descending.\nDefault order for DISPLAYNAME is ascending.\nThe DISPLAYNAME sort order is case sensitive.\n" }, { "name": "lifecycleState", "value": "", "type": "query", "description": "A filter to return only resources that match the given lifecycle state exactly." } ] }, "docs": "Gets a list of application virtual IP (VIP) addresses on a cloud VM cluster.\n" }, { "info": { "name": "Creates a new application virtual IP (VIP) address.", "type": "http" }, "http": { "method": "POST", "url": "http://localhost:19222/20160918/applicationVip", "headers": [ { "name": "opc-retry-token", "value": "" }, { "name": "opc-request-id", "value": "" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Creates a new application virtual IP (VIP) address in the specified cloud VM cluster based on the request parameters you provide.\n" }, { "info": { "name": "GetApplicationVip", "type": "http" }, "http": { "method": "GET", "url": "http://localhost:19222/20160918/applicationVip/:applicationVipId", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "applicationVipId", "value": "", "type": "path", "description": "The [OCID](/Content/General/Concepts/identifiers.htm) of the application virtual IP (VIP) address." } ] }, "docs": "Gets information about a specified application virtual IP (VIP) address." }, { "info": { "name": "DeleteApplicationVip", "type": "http" }, "http": { "method": "DELETE", "url": "http://localhost:19222/20160918/applicationVip/:applicationVipId", "headers": [ { "name": "if-match", "value": "" }, { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "applicationVipId", "value": "", "type": "path", "description": "The [OCID](/Content/General/Concepts/identifiers.htm) of the application virtual IP (VIP) address." } ] }, "docs": "Deletes and deregisters the specified application virtual IP (VIP) address.\n" }, { "info": { "name": "ListAutonomousContainerDatabaseBackups", "type": "http" }, "http": { "method": "GET", "url": "http://localhost:19222/20160918/autonomousContainerDatabaseBackups", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "compartmentId", "value": "", "type": "query", "description": "The compartment [OCID](/Content/General/Concepts/identifiers.htm)." }, { "name": "autonomousContainerDatabaseId", "value": "", "type": "query", "description": "The Autonomous Container Database [OCID](/Content/General/Concepts/identifiers.htm)." }, { "name": "isRemote", "value": "", "type": "query", "description": "call for all remote backups" }, { "name": "infrastructureType", "value": "", "type": "query", "description": "A filter to return only resources that match the given Infrastructure Type." }, { "name": "lifecycleState", "value": "", "type": "query", "description": "A filter to return only resources that match the given lifecycle state exactly." }, { "name": "sortBy", "value": "", "type": "query", "description": "The field to sort by. You can provide one sort order (`sortOrder`). Default order for TIMECREATED is descending. Default order for DISPLAYNAME is ascending. The DISPLAYNAME sort order is case sensitive.\n\n**Note:** If you do not include the availability domain filter, the resources are grouped by availability domain, then sorted.\n" }, { "name": "limit", "value": "", "type": "query", "description": "The maximum number of items to return per page." }, { "name": "page", "value": "", "type": "query", "description": "The pagination token to continue listing from." }, { "name": "sortOrder", "value": "", "type": "query", "description": "The sort order to use, either ascending (`ASC`) or descending (`DESC`)." }, { "name": "displayName", "value": "", "type": "query", "description": "A filter to return only resources that match the entire display name given. The match is not case sensitive." } ] }, "docs": "Gets a list of Autonomous Container Database backups by using either the 'autonomousDatabaseId' or 'compartmentId' as your query parameter.\n" }, { "info": { "name": "Gets a list of supported Autonomous Container Database versions.", "type": "http" }, "http": { "method": "GET", "url": "http://localhost:19222/20160918/autonomousContainerDatabaseVersions", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "compartmentId", "value": "", "type": "query", "description": "The compartment [OCID](/Content/General/Concepts/identifiers.htm)." }, { "name": "limit", "value": "", "type": "query", "description": "The maximum number of items to return per page." }, { "name": "page", "value": "", "type": "query", "description": "The pagination token to continue listing from." }, { "name": "sortOrder", "value": "", "type": "query", "description": "The sort order to use, either ascending (`ASC`) or descending (`DESC`)." }, { "name": "serviceComponent", "value": "", "type": "query", "description": "The service component to use, either ADBD or EXACC." } ] }, "docs": "Gets a list of supported Autonomous Container Database versions." }, { "info": { "name": "ListAutonomousContainerDatabases", "type": "http" }, "http": { "method": "GET", "url": "http://localhost:19222/20160918/autonomousContainerDatabases", "params": [ { "name": "compartmentId", "value": "", "type": "query", "description": "The compartment [OCID](/Content/General/Concepts/identifiers.htm)." }, { "name": "autonomousExadataInfrastructureId", "value": "", "type": "query", "description": "The Autonomous Exadata Infrastructure [OCID](/Content/General/Concepts/identifiers.htm)." }, { "name": "autonomousVmClusterId", "value": "", "type": "query", "description": "The Autonomous VM Cluster [OCID](/Content/General/Concepts/identifiers.htm)." }, { "name": "infrastructureType", "value": "", "type": "query", "description": "A filter to return only resources that match the given Infrastructure Type." }, { "name": "limit", "value": "", "type": "query", "description": "The maximum number of items to return per page." }, { "name": "page", "value": "", "type": "query", "description": "The pagination token to continue listing from." }, { "name": "sortBy", "value": "", "type": "query", "description": "The field to sort by. You can provide one sort order (`sortOrder`). Default order for TIMECREATED is descending. Default order for DISPLAYNAME is ascending. The DISPLAYNAME sort order is case sensitive.\n\n**Note:** If you do not include the availability domain filter, the resources are grouped by availability domain, then sorted.\n" }, { "name": "sortOrder", "value": "", "type": "query", "description": "The sort order to use, either ascending (`ASC`) or descending (`DESC`)." }, { "name": "lifecycleState", "value": "", "type": "query", "description": "A filter to return only resources that match the given lifecycle state exactly." }, { "name": "availabilityDomain", "value": "", "type": "query", "description": "A filter to return only resources that match the given availability domain exactly." }, { "name": "displayName", "value": "", "type": "query", "description": "A filter to return only resources that match the entire display name given. The match is not case sensitive." }, { "name": "serviceLevelAgreementType", "value": "", "type": "query", "description": "A filter to return only resources that match the given service-level agreement type exactly." }, { "name": "cloudAutonomousVmClusterId", "value": "", "type": "query", "description": "The cloud Autonomous VM Cluster [OCID](/Content/General/Concepts/identifiers.htm)." } ] }, "docs": "Gets a list of the Autonomous Container Databases in the specified compartment.\n" }, { "info": { "name": "CreateAutonomousContainerDatabase", "type": "http" }, "http": { "method": "POST", "url": "http://localhost:19222/20160918/autonomousContainerDatabases", "headers": [ { "name": "opc-retry-token", "value": "" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Creates an Autonomous Container Database in the specified Autonomous Exadata Infrastructure.\n" }, { "info": { "name": "GetAutonomousContainerDatabase", "type": "http" }, "http": { "method": "GET", "url": "http://localhost:19222/20160918/autonomousContainerDatabases/:autonomousContainerDatabaseId", "params": [ { "name": "autonomousContainerDatabaseId", "value": "", "type": "path", "description": "The Autonomous Container Database [OCID](/Content/General/Concepts/identifiers.htm)." } ] }, "docs": "Gets information about the specified Autonomous Container Database." }, { "info": { "name": "UpdateAutonomousContainerDatabase", "type": "http" }, "http": { "method": "PUT", "url": "http://localhost:19222/20160918/autonomousContainerDatabases/:autonomousContainerDatabaseId", "headers": [ { "name": "if-match", "value": "" } ], "params": [ { "name": "autonomousContainerDatabaseId", "value": "", "type": "path", "description": "The Autonomous Container Database [OCID](/Content/General/Concepts/identifiers.htm)." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Updates the properties of an Autonomous Container Database, such as display name, maintenance preference, backup retention, and tags." }, { "info": { "name": "TerminiateAutonomousContainerDatabase", "type": "http" }, "http": { "method": "DELETE", "url": "http://localhost:19222/20160918/autonomousContainerDatabases/:autonomousContainerDatabaseId", "headers": [ { "name": "if-match", "value": "" } ], "params": [ { "name": "autonomousContainerDatabaseId", "value": "", "type": "path", "description": "The Autonomous Container Database [OCID](/Content/General/Concepts/identifiers.htm)." } ] }, "docs": "Terminates an Autonomous Container Database, which permanently deletes the container database and any databases within the container database. The database data is local to the Autonomous Exadata Infrastructure and will be lost when the container database is terminated. Oracle recommends that you back up any data in the Autonomous Container Database prior to terminating it." }, { "info": { "name": "AddStandbyAutonomousContainerDatabase", "type": "http" }, "http": { "method": "POST", "url": "http://localhost:19222/20160918/autonomousContainerDatabases/:autonomousContainerDatabaseId/actions/addStandby", "headers": [ { "name": "opc-request-id", "value": "" }, { "name": "opc-retry-token", "value": "" }, { "name": "if-match", "value": "" } ], "params": [ { "name": "autonomousContainerDatabaseId", "value": "", "type": "path", "description": "The Autonomous Container Database [OCID](/Content/General/Concepts/identifiers.htm)." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Add a standby Autonomous Container Database. For more information about Autonomous Data Guard,see\n[Protect Critical Databases from Failures and Disasters Using Autonomous Data Guard](https://docs.oracle.com/en/cloud/paas/autonomous-database/dedicated/adbau/GUID-C57B9A6E-7471-4CDC-8F10-B8386538E31C).\n" }, { "info": { "name": "ChangeAutonomousContainerDatabaseCompartment", "type": "http" }, "http": { "method": "POST", "url": "http://localhost:19222/20160918/autonomousContainerDatabases/:autonomousContainerDatabaseId/actions/changeCompartment", "headers": [ { "name": "opc-retry-token", "value": "" }, { "name": "opc-request-id", "value": "" }, { "name": "if-match", "value": "" } ], "params": [ { "name": "autonomousContainerDatabaseId", "value": "", "type": "path", "description": "The Autonomous Container Database [OCID](/Content/General/Concepts/identifiers.htm)." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Move the Autonomous Container Database and its dependent resources to the specified compartment.\nFor more information about moving Autonomous Container Databases, see\n[Moving Database Resources to a Different Compartment](https://docs.oracle.com/en/cloud/paas/autonomous-database/dedicated/raqyy/#articletitle.html).\n" }, { "info": { "name": "ChangeAutonomousContainerDatabaseDatagardRole", "type": "http" }, "http": { "method": "POST", "url": "http://localhost:19222/20160918/autonomousContainerDatabases/:autonomousContainerDatabaseId/actions/changeDataguardRole", "headers": [ { "name": "opc-request-id", "value": "" }, { "name": "opc-retry-token", "value": "" }, { "name": "if-match", "value": "" } ], "params": [ { "name": "autonomousContainerDatabaseId", "value": "", "type": "path", "description": "The Autonomous Container Database [OCID](/Content/General/Concepts/identifiers.htm)." } ], "body": { "type": "json", "data": "{}" } }, "docs": "**Deprecated.** Use the [ConvertStandbyAutonomousContainerDatabase](#/en/database/latest/AutonomousContainerDatabase/ConvertStandbyAutonomousContainerDatabase) operation to switch the Autonomous Container Database (ACD) role between Standby and Snapshot Standby.\nFor more information about changing ACD Role, see\n[Convert Physical Standby to Snapshot Standby](https://docs.oracle.com/en/cloud/paas/autonomous-database/dedicated/adbcl/index.html#ADBCL-GUID-D3B503F1-0032-4B0D-9F00-ACAE8151AB80) and [C" }, { "info": { "name": "EditAutonomousContainerDatabaseDataguard", "type": "http" }, "http": { "method": "POST", "url": "http://localhost:19222/20160918/autonomousContainerDatabases/:autonomousContainerDatabaseId/actions/editDataguard", "headers": [ { "name": "opc-request-id", "value": "" }, { "name": "opc-retry-token", "value": "" }, { "name": "if-match", "value": "" } ], "params": [ { "name": "autonomousContainerDatabaseId", "value": "", "type": "path", "description": "The Autonomous Container Database [OCID](/Content/General/Concepts/identifiers.htm)." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Modify Autonomous Container Database Data Guard settings such as protection mode, automatic failover, and fast start failover lag limit. For more information, see\n[Update Autonomous Container Database Dataguard](https://docs.oracle.com/en/cloud/paas/autonomous-database/dedicated/adbcl/index.html#ADBCL-GUID-3A936EC7-7A49-4FD2-9F39-8DB6B22011CE).\n" }, { "info": { "name": "Failover Autonomous Container Database of an Primary Autonomous Data Guard into a standby role.", "type": "http" }, "http": { "method": "POST", "url": "http://localhost:19222/20160918/autonomousContainerDatabases/:autonomousContainerDatabaseId/actions/failover", "headers": [ { "name": "if-match", "value": "" }, { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "autonomousContainerDatabaseId", "value": "", "type": "path", "description": "The Autonomous Container Database [OCID](/Content/General/Concepts/identifiers.htm)." } ] }, "docs": "Performs failover to a standby Autonomous Container Database (ACD) identified by the autonomousContainerDatabaseId parameter. This standby ACD will become the new primary ACD when the failover completes successfully. For more information, see\n[Fail Over to the Standby in an Autonomous Data Guard Configuration](https://docs.oracle.com/en/cloud/paas/autonomous-database/dedicated/adbcl/index.html#ADBCL-GUID-C8FFA343-223C-4F41-9656-AEC356AD90A0). \n" }, { "info": { "name": "Reinstates the primary Autonomous Container Database of an Autonomous Data Guard Association into a standby role.", "type": "http" }, "http": { "method": "POST", "url": "http://localhost:19222/20160918/autonomousContainerDatabases/:autonomousContainerDatabaseId/actions/reinstate", "headers": [ { "name": "if-match", "value": "" }, { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "autonomousContainerDatabaseId", "value": "", "type": "path", "description": "The Autonomous Container Database [OCID](/Content/General/Concepts/identifiers.htm)." } ] }, "docs": "Reinstates a disabled standby Autonomous Container Database (ACD), identified by the autonomousContainerDatabaseId parameter to an active standby ACD. For more information, see\n[Reinstate the Disabled Standby in an Autonomous Data Guard Configuration](https://docs.oracle.com/en/cloud/paas/autonomous-database/dedicated/adbcl/index.html#ADBCL-GUID-B5C6A90D-72E3-4F32-988D-8AECC0A2D947).\n" }, { "info": { "name": "Rolling restarts the specified Autonomous Container Database.", "type": "http" }, "http": { "method": "POST", "url": "http://localhost:19222/20160918/autonomousContainerDatabases/:autonomousContainerDatabaseId/actions/restart", "headers": [ { "name": "if-match", "value": "" }, { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "autonomousContainerDatabaseId", "value": "", "type": "path", "description": "The Autonomous Container Database [OCID](/Content/General/Concepts/identifiers.htm)." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Rolling restarts the specified Autonomous Container Database.\n" }, { "info": { "name": "Rotate Key", "type": "http" }, "http": { "method": "POST", "url": "http://localhost:19222/20160918/autonomousContainerDatabases/:autonomousContainerDatabaseId/actions/rotateKey", "headers": [ { "name": "if-match", "value": "" }, { "name": "opc-retry-token", "value": "" }, { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "autonomousContainerDatabaseId", "value": "", "type": "path", "description": "The Autonomous Container Database [OCID](/Content/General/Concepts/identifiers.htm)." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Creates a new version of an existing [Vault service](/iaas/Content/KeyManagement/Concepts/keyoverview.htm) key." }, { "info": { "name": "ConvertStandbyAutonomousContainerDatabase", "type": "http" }, "http": { "method": "POST", "url": "http://localhost:19222/20160918/autonomousContainerDatabases/:autonomousContainerDatabaseId/actions/snapshotStandby", "headers": [ { "name": "opc-request-id", "value": "" }, { "name": "opc-retry-token", "value": "" }, { "name": "if-match", "value": "" } ], "params": [ { "name": "autonomousContainerDatabaseId", "value": "", "type": "path", "description": "The Autonomous Container Database [OCID](/Content/General/Concepts/identifiers.htm)." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Convert the standby Autonomous Container Database (ACD) between physical standby and snapshot standby ACD. For more information about converting standby ACDs, see\n[Convert Physical Standby to Snapshot Standby](https://docs.oracle.com/en/cloud/paas/autonomous-database/dedicated/adbcl/index.html#ADBCL-GUID-D3B503F1-0032-4B0D-9F00-ACAE8151AB80) and [Convert Snapshot Standby to Physical Standby](https://docs.oracle.com/en/cloud/paas/autonomous-database/dedicated/adbcl/index.html#ADBCL-GUID-E8D7E0EE-" }, { "info": { "name": "Switchover Autonomous Container Database between Primary and Standby Autonomous Container Database.", "type": "http" }, "http": { "method": "POST", "url": "http://localhost:19222/20160918/autonomousContainerDatabases/:autonomousContainerDatabaseId/actions/switchover", "headers": [ { "name": "if-match", "value": "" }, { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "autonomousContainerDatabaseId", "value": "", "type": "path", "description": "The Autonomous Container Database [OCID](/Content/General/Concepts/identifiers.htm)." } ] }, "docs": "Switchover an Autonomous Container Database (ACD), identified by the autonomousContainerDatabaseId parameter, to an active standby ACD. This standby ACD will become the new primary ACD when the switchover completes successfully. For more information, see\n[Switch Roles in an Autonomous Data Guard Configuration](https://docs.oracle.com/en/cloud/paas/autonomous-database/dedicated/adbcl/index.html#ADBCL-GUID-A2AB31F6-D52D-493C-9BA7-D87A0F17078F). \n" }, { "info": { "name": "ListAutonomousContainerDatabaseDataguardAssociations", "type": "http" }, "http": { "method": "GET", "url": "http://localhost:19222/20160918/autonomousContainerDatabases/:autonomousContainerDatabaseId/autonomousContainerDatabaseDataguardAssociations", "params": [ { "name": "limit", "value": "", "type": "query", "description": "The maximum number of items to return per page." }, { "name": "page", "value": "", "type": "query", "description": "The pagination token to continue listing from." }, { "name": "autonomousContainerDatabaseId", "value": "", "type": "path", "description": "The Autonomous Container Database [OCID](/Content/General/Concepts/identifiers.htm)." } ] }, "docs": "**Deprecated.** Use the [ListAutonomousContainerDatabases](#/en/database/latest/AutonomousContainerDatabase/ListAutonomousContainerDatabases) operation to get a list of the Autonomous Container Databases (ACDs)with Autonomous Data Guard-enabled associated with the specified ACD.\n" }, { "info": { "name": "Create a Autonomous Data Guard association.", "type": "http" }, "http": { "method": "POST", "url": "http://localhost:19222/20160918/autonomousContainerDatabases/:autonomousContainerDatabaseId/autonomousContainerDatabaseDataguardAssociations", "headers": [ { "name": "opc-retry-token", "value": "" } ], "params": [ { "name": "autonomousContainerDatabaseId", "value": "", "type": "path", "description": "The Autonomous Container Database [OCID](/Content/General/Concepts/identifiers.htm)." } ], "body": { "type": "json", "data": "{}" } }, "docs": "**Deprecated.** Use the [AddStandbyAutonomousContainerDatabase](#/en/database/latest/AutonomousContainerDatabase/AddStandbyAutonomousContainerDatabase) operation to create a new Autonomous Data Guard association. An Autonomous Data Guard association represents the replication relationship between the\nspecified Autonomous Container database and a peer Autonomous Container database. For more information, see [Using Oracle Data Guard](https://docs.oracle.com/en/cloud/paas/autonomous-database/dedica" }, { "info": { "name": "GetAutonomousContainerDatabaseDataguardAssociation", "type": "http" }, "http": { "method": "GET", "url": "http://localhost:19222/20160918/autonomousContainerDatabases/:autonomousContainerDatabaseId/autonomousContainerDatabaseDataguardAssociations/:autonomousContainerDatabaseDataguardAssociationId", "params": [ { "name": "autonomousContainerDatabaseId", "value": "", "type": "path", "description": "The Autonomous Container Database [OCID](/Content/General/Concepts/identifiers.htm)." }, { "name": "autonomousContainerDatabaseDataguardAssociationId", "value": "", "type": "path", "description": "The Autonomous Container Database-Autonomous Data Guard association [OCID](/Content/General/Concepts/identifiers.htm)." } ] }, "docs": "**Deprecated.** Use the [GetAutonomousContainerDatabase](#/en/database/latest/AutonomousContainerDatabase/GetAutonomousContainerDatabase) operation to get the details of an Autonomous Container Database (ACD) enabled with Autonomous Data Guard associated with the specified ACD.\n" }, { "info": { "name": "UpdateAutonomousContainerDatabaseDataguardAssociation", "type": "http" }, "http": { "method": "PUT", "url": "http://localhost:19222/20160918/autonomousContainerDatabases/:autonomousContainerDatabaseId/autonomousContainerDatabaseDataguardAssociations/:autonomousContainerDatabaseDataguardAssociationId", "headers": [ { "name": "if-match", "value": "" }, { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "autonomousContainerDatabaseId", "value": "", "type": "path", "description": "The Autonomous Container Database [OCID](/Content/General/Concepts/identifiers.htm)." }, { "name": "autonomousContainerDatabaseDataguardAssociationId", "value": "", "type": "path", "description": "The Autonomous Container Database-Autonomous Data Guard association [OCID](/Content/General/Concepts/identifiers.htm)." } ], "body": { "type": "json", "data": "{}" } }, "docs": "**Deprecated.** Use the [EditAutonomousContainerDatabaseDataguard](#/en/database/latest/AutonomousContainerDatabase/EditAutonomousContainerDatabaseDataguard) operation to update an Autonomous Data Guard association.\n" }, { "info": { "name": "Fails over to a standby Autonomous Container Database to the primary Autonomous Container Database role.", "type": "http" }, "http": { "method": "POST", "url": "http://localhost:19222/20160918/autonomousContainerDatabases/:autonomousContainerDatabaseId/autonomousContainerDatabaseDataguardAssociations/:autonomousContainerDatabaseDataguardAssociationId/actions/failover", "headers": [ { "name": "if-match", "value": "" } ], "params": [ { "name": "autonomousContainerDatabaseId", "value": "", "type": "path", "description": "The Autonomous Container Database [OCID](/Content/General/Concepts/identifiers.htm)." }, { "name": "autonomousContainerDatabaseDataguardAssociationId", "value": "", "type": "path", "description": "The Autonomous Container Database-Autonomous Data Guard association [OCID](/Content/General/Concepts/identifiers.htm)." } ] }, "docs": "**Deprecated.** Use the [FailoverAutonomousContainerDatabaseDataguard](#/en/database/latest/AutonomousContainerDatabase/FailoverAutonomousContainerDatabaseDataguard) operation to fail over the standby Autonomous Container Database (ACD) to the primary ACD after the existing primary ACD fails or becomes unreachable.\n\nA failover can result in data loss, depending on the protection mode in effect at the time the primary Autonomous Container Database fails.\n" }, { "info": { "name": "Migrate the primary Autonomous Container Database of an Autonomous Data Guard Association into a standby role.", "type": "http" }, "http": { "method": "POST", "url": "http://localhost:19222/20160918/autonomousContainerDatabases/:autonomousContainerDatabaseId/autonomousContainerDatabaseDataguardAssociations/:autonomousContainerDatabaseDataguardAssociationId/actions/migrate", "headers": [ { "name": "if-match", "value": "" }, { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "autonomousContainerDatabaseId", "value": "", "type": "path", "description": "The Autonomous Container Database [OCID](/Content/General/Concepts/identifiers.htm)." }, { "name": "autonomousContainerDatabaseDataguardAssociationId", "value": "", "type": "path", "description": "The Autonomous Container Database-Autonomous Data Guard association [OCID](/Content/General/Concepts/identifiers.htm)." } ] }, "docs": "Migrate Autonomous Container Database, identified by the autonomousContainerDatabaseId parameter.\n" }, { "info": { "name": "Reinstates the primary Autonomous Container Database of an Autonomous Data Guard Association into a standby role.", "type": "http" }, "http": { "method": "POST", "url": "http://localhost:19222/20160918/autonomousContainerDatabases/:autonomousContainerDatabaseId/autonomousContainerDatabaseDataguardAssociations/:autonomousContainerDatabaseDataguardAssociationId/actions/reinstate", "headers": [ { "name": "if-match", "value": "" } ], "params": [ { "name": "autonomousContainerDatabaseId", "value": "", "type": "path", "description": "The Autonomous Container Database [OCID](/Content/General/Concepts/identifiers.htm)." }, { "name": "autonomousContainerDatabaseDataguardAssociationId", "value": "", "type": "path", "description": "The Autonomous Container Database-Autonomous Data Guard association [OCID](/Content/General/Concepts/identifiers.htm)." } ] }, "docs": "**Deprecated.** Use the [ReinstateAutonomousContainerDatabaseDataguard](#/en/database/latest/AutonomousContainerDatabase/ReinstateAutonomousContainerDatabaseDataguard) operation to reinstate a disabled standby Autonomous Container Database (ACD), identified by the autonomousContainerDatabaseId parameter, to an active standby ACD.\n" }, { "info": { "name": "Switches the primary Autonomous Container Database of an Autonomous Data Guard association to standby role.", "type": "http" }, "http": { "method": "POST", "url": "http://localhost:19222/20160918/autonomousContainerDatabases/:autonomousContainerDatabaseId/autonomousContainerDatabaseDataguardAssociations/:autonomousContainerDatabaseDataguardAssociationId/actions/switchover", "headers": [ { "name": "if-match", "value": "" } ], "params": [ { "name": "autonomousContainerDatabaseId", "value": "", "type": "path", "description": "The Autonomous Container Database [OCID](/Content/General/Concepts/identifiers.htm)." }, { "name": "autonomousContainerDatabaseDataguardAssociationId", "value": "", "type": "path", "description": "The Autonomous Container Database-Autonomous Data Guard association [OCID](/Content/General/Concepts/identifiers.htm)." } ] }, "docs": "**Deprecated.** Use the [SwitchoverAutonomousContainerDatabaseDataguard](#/en/database/latest/AutonomousContainerDatabase/SwitchoverAutonomousContainerDatabaseDataguard) operation to switches over the primary Autonomous Container Database (ACD) of an Autonomous Data Guard peer association to standby role. The standby ACD associated with autonomousContainerDatabaseDataguardAssociationId assumes the primary ACD role.\n\nA switchover incurs no data loss.\n" }, { "info": { "name": "ListContainerDatabasePatches", "type": "http" }, "http": { "method": "GET", "url": "http://localhost:19222/20160918/autonomousContainerDatabases/:autonomousContainerDatabaseId/patches", "params": [ { "name": "autonomousContainerDatabaseId", "value": "", "type": "path", "description": "The Autonomous Container Database [OCID](/Content/General/Concepts/identifiers.htm)." }, { "name": "limit", "value": "", "type": "query", "description": "The maximum number of items to return per page." }, { "name": "page", "value": "", "type": "query", "description": "The pagination token to continue listing from." }, { "name": "compartmentId", "value": "", "type": "query", "description": "The compartment [OCID](/Content/General/Concepts/identifiers.htm)." }, { "name": "autonomousPatchType", "value": "", "type": "query", "description": "Autonomous patch type, either \"QUARTERLY\" or \"TIMEZONE\".\n" } ] }, "docs": "Lists the patches applicable to the requested container database.\n" }, { "info": { "name": "GetAutonomousContainerDatabaseResourceUsage", "type": "http" }, "http": { "method": "GET", "url": "http://localhost:19222/20160918/autonomousContainerDatabases/:autonomousContainerDatabaseId/resourceUsage", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "autonomousContainerDatabaseId", "value": "", "type": "path", "description": "The Autonomous Container Database [OCID](/Content/General/Concepts/identifiers.htm)." } ] }, "docs": "Get resource usage details for the specified Autonomous Container Database.\n" }, { "info": { "name": "Gets a list of Autonomous AI Database backups.", "type": "http" }, "http": { "method": "GET", "url": "http://localhost:19222/20160918/autonomousDatabaseBackups", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "autonomousDatabaseId", "value": "", "type": "query", "description": "The database [OCID](/Content/General/Concepts/identifiers.htm)." }, { "name": "compartmentId", "value": "", "type": "query", "description": "The compartment [OCID](/Content/General/Concepts/identifiers.htm)." }, { "name": "limit", "value": "", "type": "query", "description": "The maximum number of items to return per page." }, { "name": "page", "value": "", "type": "query", "description": "The pagination token to continue listing from." }, { "name": "sortBy", "value": "", "type": "query", "description": "The field to sort by. You can provide one sort order (`sortOrder`). Default order for TIMECREATED is descending. Default order for DISPLAYNAME is ascending. The DISPLAYNAME sort order is case sensitive.\n\n**Note:** If you do not include the availability domain filter, the resources are grouped by availability domain, then sorted.\n" }, { "name": "sortOrder", "value": "", "type": "query", "description": "The sort order to use, either ascending (`ASC`) or descending (`DESC`)." }, { "name": "lifecycleState", "value": "", "type": "query", "description": "A filter to return only resources that match the given lifecycle state exactly." }, { "name": "displayName", "value": "", "type": "query", "description": "A filter to return only resources that match the entire display name given. The match is not case sensitive." }, { "name": "type", "value": "", "type": "query", "description": "A filter to return only backups that matches with the given type of Backup." }, { "name": "backupDestinationId", "value": "", "type": "query", "description": "A filter to return only resources that have the given backup destination id." }, { "name": "keyStoreId", "value": "", "type": "query", "description": "A filter to return only resources that have the given key store id." }, { "name": "infrastructureType", "value": "", "type": "query", "description": "A filter to return only resources that match the given Infrastructure Type." } ] }, "docs": "Gets a list of Autonomous AI Database backups based on either the `autonomousDatabaseId` or `compartmentId` specified as a query parameter.\n" }, { "info": { "name": "Creates a new Autonomous AI Database backup for the specified database.", "type": "http" }, "http": { "method": "POST", "url": "http://localhost:19222/20160918/autonomousDatabaseBackups", "headers": [ { "name": "opc-retry-token", "value": "" }, { "name": "opc-request-id", "value": "" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Creates a new Autonomous AI Database backup for the specified database based on the provided request parameters.\n" }, { "info": { "name": "Gets information about the specified Autonomous AI Database backup.", "type": "http" }, "http": { "method": "GET", "url": "http://localhost:19222/20160918/autonomousDatabaseBackups/:autonomousDatabaseBackupId", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "autonomousDatabaseBackupId", "value": "", "type": "path", "description": "The [OCID](/Content/General/Concepts/identifiers.htm) of the Autonomous AI Database backup." } ] }, "docs": "Gets information about the specified Autonomous AI Database backup." }, { "info": { "name": "Updates an existing Autonomous AI Database backup of the specified database.", "type": "http" }, "http": { "method": "PUT", "url": "http://localhost:19222/20160918/autonomousDatabaseBackups/:autonomousDatabaseBackupId", "headers": [ { "name": "if-match", "value": "" }, { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "autonomousDatabaseBackupId", "value": "", "type": "path", "description": "The [OCID](/Content/General/Concepts/identifiers.htm) of the Autonomous AI Database backup." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Updates the Autonomous AI Database backup of the specified database based on the request parameters.\n" }, { "info": { "name": "DeleteAutonomousDatabaseBackup", "type": "http" }, "http": { "method": "DELETE", "url": "http://localhost:19222/20160918/autonomousDatabaseBackups/:autonomousDatabaseBackupId", "headers": [ { "name": "if-match", "value": "" }, { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "autonomousDatabaseBackupId", "value": "", "type": "path", "description": "The [OCID](/Content/General/Concepts/identifiers.htm) of the Autonomous AI Database backup." } ] }, "docs": "Deletes a long-term backup. You cannot delete other backups using this API." }, { "info": { "name": "ListAutonomousDatabaseCharacterSets", "type": "http" }, "http": { "method": "GET", "url": "http://localhost:19222/20160918/autonomousDatabaseCharacterSets", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "isShared", "value": "", "type": "query", "description": "Specifies whether this request is for an Autonomous AI Database Serverless instance. By default, this request will be for Autonomous AI Database on Dedicated Exadata Infrastructure.\n" }, { "name": "isDedicated", "value": "", "type": "query", "description": "Specifies if the request is for an Autonomous AI Database Dedicated instance. The default request is for an Autonomous AI Database Dedicated instance.\n" }, { "name": "characterSetType", "value": "", "type": "query", "description": "Specifies whether this request pertains to database character sets or national character sets.\n" } ] }, "docs": "Gets a list of supported character sets." }, { "info": { "name": "ListAutonomousDatabaseSoftwareImages", "type": "http" }, "http": { "method": "GET", "url": "http://localhost:19222/20160918/autonomousDatabaseSoftwareImages", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "compartmentId", "value": "", "type": "query", "description": "The compartment [OCID](/Content/General/Concepts/identifiers.htm)." }, { "name": "limit", "value": "", "type": "query", "description": "The maximum number of items to return per page." }, { "name": "page", "value": "", "type": "query", "description": "The pagination token to continue listing from." }, { "name": "sortOrder", "value": "", "type": "query", "description": "The sort order to use, either ascending (`ASC`) or descending (`DESC`)." }, { "name": "sortBy", "value": "", "type": "query", "description": "parameter according to which Autonomous AI Database Software Images will be sorted.\n" }, { "name": "lifecycleState", "value": "", "type": "query", "description": "A filter to return only resources that match the given lifecycle state exactly." }, { "name": "displayName", "value": "", "type": "query", "description": "A filter to return only resources that match the entire display name given. The match is not case sensitive." }, { "name": "imageShapeFamily", "value": "", "type": "query", "description": "A filter to return only resources that match the given image shape family exactly." } ] }, "docs": "Gets a list of the Autonomous AI Database Software Images in the specified compartment.\n" }, { "info": { "name": "CreateAutonomousDatabaseSoftwareImage", "type": "http" }, "http": { "method": "POST", "url": "http://localhost:19222/20160918/autonomousDatabaseSoftwareImages", "headers": [ { "name": "opc-retry-token", "value": "" }, { "name": "opc-request-id", "value": "" } ], "body": { "type": "json", "data": "{}" } }, "docs": "create Autonomous AI Database Software Image in the specified compartment.\n" }, { "info": { "name": "GetAutonomousDatabaseSoftwareImage", "type": "http" }, "http": { "method": "GET", "url": "http://localhost:19222/20160918/autonomousDatabaseSoftwareImages/:autonomousDatabaseSoftwareImageId", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "autonomousDatabaseSoftwareImageId", "value": "", "type": "path", "description": "The Autonomous AI Database Software Image [OCID](/Content/General/Concepts/identifiers.htm)." } ] }, "docs": "Gets information about the specified Autonomous AI Database Software Image." }, { "info": { "name": "UpdateAutonomousDatabaseSoftwareImage", "type": "http" }, "http": { "method": "PUT", "url": "http://localhost:19222/20160918/autonomousDatabaseSoftwareImages/:autonomousDatabaseSoftwareImageId", "headers": [ { "name": "if-match", "value": "" }, { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "autonomousDatabaseSoftwareImageId", "value": "", "type": "path", "description": "The Autonomous AI Database Software Image [OCID](/Content/General/Concepts/identifiers.htm)." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Updates the properties of an Autonomous AI Database Software Image, like add tags" }, { "info": { "name": "DeleteAutonomousDatabaseSoftwareImage", "type": "http" }, "http": { "method": "DELETE", "url": "http://localhost:19222/20160918/autonomousDatabaseSoftwareImages/:autonomousDatabaseSoftwareImageId", "headers": [ { "name": "if-match", "value": "" }, { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "autonomousDatabaseSoftwareImageId", "value": "", "type": "path", "description": "The Autonomous AI Database Software Image [OCID](/Content/General/Concepts/identifiers.htm)." } ] }, "docs": "Delete an Autonomous AI Database Software Image" }, { "info": { "name": "ChangeAutonomousDatabaseSoftwareImageCompartment", "type": "http" }, "http": { "method": "POST", "url": "http://localhost:19222/20160918/autonomousDatabaseSoftwareImages/:autonomousDatabaseSoftwareImageId/actions/changeCompartment", "headers": [ { "name": "opc-retry-token", "value": "" }, { "name": "opc-request-id", "value": "" }, { "name": "if-match", "value": "" } ], "params": [ { "name": "autonomousDatabaseSoftwareImageId", "value": "", "type": "path", "description": "The Autonomous AI Database Software Image [OCID](/Content/General/Concepts/identifiers.htm)." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Move the Autonomous AI Database Software Image and its dependent resources to the specified compartment.\n" }, { "info": { "name": "Gets a list of Autonomous AI Database.", "type": "http" }, "http": { "method": "GET", "url": "http://localhost:19222/20160918/autonomousDatabases", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "compartmentId", "value": "", "type": "query", "description": "The compartment [OCID](/Content/General/Concepts/identifiers.htm)." }, { "name": "autonomousContainerDatabaseId", "value": "", "type": "query", "description": "The Autonomous Container Database [OCID](/Content/General/Concepts/identifiers.htm)." }, { "name": "limit", "value": "", "type": "query", "description": "The maximum number of items to return per page." }, { "name": "page", "value": "", "type": "query", "description": "The pagination token to continue listing from." }, { "name": "sortBy", "value": "", "type": "query", "description": "The field to sort by. You can provide one sort order (`sortOrder`). Default order for TIMECREATED is descending. Default order for DISPLAYNAME is ascending. The DISPLAYNAME sort order is case sensitive.\n\n**Note:** If you do not include the availability domain filter, the resources are grouped by availability domain, then sorted.\n" }, { "name": "sortOrder", "value": "", "type": "query", "description": "The sort order to use, either ascending (`ASC`) or descending (`DESC`)." }, { "name": "infrastructureType", "value": "", "type": "query", "description": "A filter to return only resources that match the given Infrastructure Type." }, { "name": "lifecycleState", "value": "", "type": "query", "description": "A filter to return only resources that match the given lifecycle state exactly." }, { "name": "lifecycleStateNotEqualTo", "value": "", "type": "query", "description": "A filter to return only resources that not match the given lifecycle state." }, { "name": "dbWorkload", "value": "", "type": "query", "description": "A filter to return only Autonomous AI Database resources that match the specified workload type." }, { "name": "dbVersion", "value": "", "type": "query", "description": "A filter to return only Autonomous AI Database resources that match the specified dbVersion." }, { "name": "isFreeTier", "value": "", "type": "query", "description": "Filter on the value of the resource's 'isFreeTier' property. A value of `true` returns only Always Free resources.\nA value of `false` excludes Always Free resources from the returned results. Omitting this parameter returns both Always Free and paid resources.\n" }, { "name": "displayName", "value": "", "type": "query", "description": "A filter to return only resources that match the entire display name given. The match is not case sensitive." }, { "name": "isRefreshableClone", "value": "", "type": "query", "description": "Filter on the value of the resource's 'isRefreshableClone' property. A value of `true` returns only refreshable clones.\nA value of `false` excludes refreshable clones from the returned results. Omitting this parameter returns both refreshable clones and databases that are not refreshable clones.\n" }, { "name": "isDataGuardEnabled", "value": "", "type": "query", "description": "A filter to return only resources that have Data Guard enabled." }, { "name": "isResourcePoolLeader", "value": "", "type": "query", "description": "Filter if the resource is the resource pool leader. A value of `true` returns only resource pool leader.\n" }, { "name": "resourcePoolLeaderId", "value": "", "type": "query", "description": "The database [OCID](/Content/General/Concepts/identifiers.htm) of the resourcepool Leader Autonomous AI Database." } ] }, "docs": "Gets a list of Autonomous AI Databases based on the query parameters specified.\n" }, { "info": { "name": "Creates a new Autonomous AI Database.", "type": "http" }, "http": { "method": "POST", "url": "http://localhost:19222/20160918/autonomousDatabases", "headers": [ { "name": "opc-retry-token", "value": "" }, { "name": "opc-request-id", "value": "" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Creates a new Autonomous AI Database.\n" }, { "info": { "name": "Lists resource pool shapes for Autonomous AI Database Serverless databases.", "type": "http" }, "http": { "method": "POST", "url": "http://localhost:19222/20160918/autonomousDatabases/actions/listResourcePoolShapes", "headers": [ { "name": "if-match", "value": "" }, { "name": "opc-retry-token", "value": "" }, { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "limit", "value": "", "type": "query", "description": "The maximum number of items to return per page." }, { "name": "page", "value": "", "type": "query", "description": "The pagination token to continue listing from." } ] }, "docs": "Lists available resource pools shapes." }, { "info": { "name": "Get the regional wallet details for Autonomous AI Databases.", "type": "http" }, "http": { "method": "GET", "url": "http://localhost:19222/20160918/autonomousDatabases/wallet", "headers": [ { "name": "opc-request-id", "value": "" } ] }, "docs": "Gets the Autonomous AI Database regional wallet details.\n" }, { "info": { "name": "Update the regional wallet for Autonomous AI Database.", "type": "http" }, "http": { "method": "PUT", "url": "http://localhost:19222/20160918/autonomousDatabases/wallet", "headers": [ { "name": "opc-request-id", "value": "" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Updates the Autonomous AI Database regional wallet.\n" }, { "info": { "name": "Gets the details of the specified Autonomous AI Database.", "type": "http" }, "http": { "method": "GET", "url": "http://localhost:19222/20160918/autonomousDatabases/:autonomousDatabaseId", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "autonomousDatabaseId", "value": "", "type": "path", "description": "The database [OCID](/Content/General/Concepts/identifiers.htm)." } ] }, "docs": "Gets the details of the specified Autonomous AI Database.\n" }, { "info": { "name": "Updates the specified Autonomous AI Database with new OCPU core count and size.", "type": "http" }, "http": { "method": "PUT", "url": "http://localhost:19222/20160918/autonomousDatabases/:autonomousDatabaseId", "headers": [ { "name": "if-match", "value": "" }, { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "autonomousDatabaseId", "value": "", "type": "path", "description": "The database [OCID](/Content/General/Concepts/identifiers.htm)." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Updates one or more attributes of the specified Autonomous AI Database. See the UpdateAutonomousDatabaseDetails resource for a full list of attributes that can be updated.\n" }, { "info": { "name": "Deletes the specified Autonomous AI Database.", "type": "http" }, "http": { "method": "DELETE", "url": "http://localhost:19222/20160918/autonomousDatabases/:autonomousDatabaseId", "headers": [ { "name": "if-match", "value": "" }, { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "autonomousDatabaseId", "value": "", "type": "path", "description": "The database [OCID](/Content/General/Concepts/identifiers.htm)." }, { "name": "mustDeleteAssociatedLongTermBackups", "value": "", "type": "query", "description": "If set to true, terminating the Autonomous AI Database also deletes its associated long-term backups if the retention lock is not enabled." } ] }, "docs": "Deletes the specified Autonomous AI Database.\n" }, { "info": { "name": "ChangeAutonomousDatabaseCompartment", "type": "http" }, "http": { "method": "POST", "url": "http://localhost:19222/20160918/autonomousDatabases/:autonomousDatabaseId/actions/changeCompartment", "headers": [ { "name": "opc-retry-token", "value": "" }, { "name": "opc-request-id", "value": "" }, { "name": "if-match", "value": "" } ], "params": [ { "name": "autonomousDatabaseId", "value": "", "type": "path", "description": "The database [OCID](/Content/General/Concepts/identifiers.htm)." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Move the Autonomous AI Database and its dependent resources to the specified compartment.\nFor more information about moving Autonomous AI Databases, see\n[Moving Database Resources to a Different Compartment](/Content/Database/Concepts/databaseoverview.htm#moveRes).\n" }, { "info": { "name": "Updates the cross-region disaster recovery (DR) details of the standby Autonomous AI Database Serverless database.", "type": "http" }, "http": { "method": "PUT", "url": "http://localhost:19222/20160918/autonomousDatabases/:autonomousDatabaseId/actions/changeDisasterRecoveryConfiguration", "headers": [ { "name": "if-match", "value": "" }, { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "autonomousDatabaseId", "value": "", "type": "path", "description": "The database [OCID](/Content/General/Concepts/identifiers.htm)." } ], "body": { "type": "json", "data": "{}" } }, "docs": "This operation updates the cross-region disaster recovery (DR) details of the standby Autonomous AI Database Serverless database, and must be run on the standby side." }, { "info": { "name": "Associate an Autonomous AI Database with a different subscription.", "type": "http" }, "http": { "method": "POST", "url": "http://localhost:19222/20160918/autonomousDatabases/:autonomousDatabaseId/actions/changeSubscription", "headers": [ { "name": "opc-retry-token", "value": "" }, { "name": "opc-request-id", "value": "" }, { "name": "if-match", "value": "" } ], "params": [ { "name": "autonomousDatabaseId", "value": "", "type": "path", "description": "The database [OCID](/Content/General/Concepts/identifiers.htm)." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Associate an Autonomous AI Database with a different subscription.\n" }, { "info": { "name": "Configure Autonomous AI Database Vault Key.", "type": "http" }, "http": { "method": "POST", "url": "http://localhost:19222/20160918/autonomousDatabases/:autonomousDatabaseId/actions/configureAutonomousDatabaseVaultKey", "headers": [ { "name": "if-match", "value": "" }, { "name": "opc-request-id", "value": "" }, { "name": "opc-retry-token", "value": "" } ], "params": [ { "name": "autonomousDatabaseId", "value": "", "type": "path", "description": "The database [OCID](/Content/General/Concepts/identifiers.htm)." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Configures the Autonomous AI Database Vault service [key](/Content/KeyManagement/Concepts/keyoverview.htm#concepts).\n" }, { "info": { "name": "Updates configuration of SaaS administrative user.", "type": "http" }, "http": { "method": "POST", "url": "http://localhost:19222/20160918/autonomousDatabases/:autonomousDatabaseId/actions/configureSaasAdminUser", "headers": [ { "name": "if-match", "value": "" }, { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "autonomousDatabaseId", "value": "", "type": "path", "description": "The database [OCID](/Content/General/Concepts/identifiers.htm)." } ], "body": { "type": "json", "data": "{}" } }, "docs": "This operation updates SaaS administrative user configuration of the Autonomous AI Database." }, { "info": { "name": "Asynchronously deregisters Data Safe for this Autonomous AI Database.", "type": "http" }, "http": { "method": "POST", "url": "http://localhost:19222/20160918/autonomousDatabases/:autonomousDatabaseId/actions/deregisterDataSafe", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "autonomousDatabaseId", "value": "", "type": "path", "description": "The database [OCID](/Content/General/Concepts/identifiers.htm)." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Asynchronously deregisters this Autonomous AI Database with Data Safe.\n" }, { "info": { "name": "Disables DatabaseManagement for the Autonomous AI Database resource.", "type": "http" }, "http": { "method": "POST", "url": "http://localhost:19222/20160918/autonomousDatabases/:autonomousDatabaseId/actions/disableDatabaseManagement", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "autonomousDatabaseId", "value": "", "type": "path", "description": "The database [OCID](/Content/General/Concepts/identifiers.htm)." } ] }, "docs": "Disables Database Management for the Autonomous AI Database resource.\n" }, { "info": { "name": "Disables Operations Insights for the Autonomous AI Database resource.", "type": "http" }, "http": { "method": "POST", "url": "http://localhost:19222/20160918/autonomousDatabases/:autonomousDatabaseId/actions/disableOperationsInsights", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "autonomousDatabaseId", "value": "", "type": "path", "description": "The database [OCID](/Content/General/Concepts/identifiers.htm)." } ] }, "docs": "Disables Operations Insights for the Autonomous AI Database resource.\n" }, { "info": { "name": "Enables Database Management for Autonomous AI Database.", "type": "http" }, "http": { "method": "POST", "url": "http://localhost:19222/20160918/autonomousDatabases/:autonomousDatabaseId/actions/enableDatabaseManagement", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "autonomousDatabaseId", "value": "", "type": "path", "description": "The database [OCID](/Content/General/Concepts/identifiers.htm)." } ] }, "docs": "Enables Database Management for Autonomous AI Database.\n" }, { "info": { "name": "Enables the specified Autonomous AI Database with Operations Insights.", "type": "http" }, "http": { "method": "POST", "url": "http://localhost:19222/20160918/autonomousDatabases/:autonomousDatabaseId/actions/enableOperationsInsights", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "autonomousDatabaseId", "value": "", "type": "path", "description": "The database [OCID](/Content/General/Concepts/identifiers.htm)." } ] }, "docs": "Enables the specified Autonomous AI Database with Operations Insights.\n" }, { "info": { "name": "Fails over AutonomousDatabase to a Standby.", "type": "http" }, "http": { "method": "POST", "url": "http://localhost:19222/20160918/autonomousDatabases/:autonomousDatabaseId/actions/failover", "headers": [ { "name": "if-match", "value": "" }, { "name": "opc-retry-token", "value": "" }, { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "autonomousDatabaseId", "value": "", "type": "path", "description": "The database [OCID](/Content/General/Concepts/identifiers.htm)." }, { "name": "peerDbId", "value": "", "type": "query", "description": "The database OCID(/Content/General/Concepts/identifiers.htm) of the Disaster Recovery peer (source Primary) database, which is located in a different (remote) region from the current peer database." } ] }, "docs": "Initiates a failover of the specified Autonomous AI Database to the associated peer database. Applicable only to databases with Disaster Recovery enabled.\nThis API should be called in the remote region where the peer database resides.\nBelow parameter is optional:\n - `peerDbId`\n Use this parameter to specify the database OCID of the Disaster Recovery peer, which is located in a different (remote) region from the current peer database.\n If this parameter is not provided, the failover will h" }, { "info": { "name": "Creates and downloads a wallet for the specified Autonomous AI Database.", "type": "http" }, "http": { "method": "POST", "url": "http://localhost:19222/20160918/autonomousDatabases/:autonomousDatabaseId/actions/generateWallet", "headers": [ { "name": "opc-request-id", "value": "" }, { "name": "opc-retry-token", "value": "" } ], "params": [ { "name": "autonomousDatabaseId", "value": "", "type": "path", "description": "The database [OCID](/Content/General/Concepts/identifiers.htm)." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Creates and downloads a wallet for the specified Autonomous AI Database.\n" }, { "info": { "name": "Gets status of SaaS administrative user.", "type": "http" }, "http": { "method": "POST", "url": "http://localhost:19222/20160918/autonomousDatabases/:autonomousDatabaseId/actions/getSaasAdminUserStatus", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "autonomousDatabaseId", "value": "", "type": "path", "description": "The database [OCID](/Content/General/Concepts/identifiers.htm)." } ] }, "docs": "This operation gets SaaS administrative user status of the Autonomous AI Database." }, { "info": { "name": "Imports transportable tablespace for the specified Autonomous AI Database.", "type": "http" }, "http": { "method": "POST", "url": "http://localhost:19222/20160918/autonomousDatabases/:autonomousDatabaseId/actions/importTransportableTablespace", "headers": [ { "name": "if-match", "value": "" }, { "name": "opc-retry-token", "value": "" }, { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "autonomousDatabaseId", "value": "", "type": "path", "description": "The database [OCID](/Content/General/Concepts/identifiers.htm)." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Imports transportable tablespace for the specified Autonomous AI Database.\n" }, { "info": { "name": "Refresh an Autonomous AI Database refreshable clone.", "type": "http" }, "http": { "method": "POST", "url": "http://localhost:19222/20160918/autonomousDatabases/:autonomousDatabaseId/actions/refresh", "headers": [ { "name": "if-match", "value": "" }, { "name": "opc-retry-token", "value": "" }, { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "autonomousDatabaseId", "value": "", "type": "path", "description": "The database [OCID](/Content/General/Concepts/identifiers.htm)." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Initiates a data refresh for an Autonomous AI Database refreshable clone. Data is refreshed from the source database to the point of a specified timestamp.\n" }, { "info": { "name": "Asynchronously registers this Autonomous AI Database with Data Safe.", "type": "http" }, "http": { "method": "POST", "url": "http://localhost:19222/20160918/autonomousDatabases/:autonomousDatabaseId/actions/registerDataSafe", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "autonomousDatabaseId", "value": "", "type": "path", "description": "The database [OCID](/Content/General/Concepts/identifiers.htm)." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Asynchronously registers this Autonomous AI Database with Data Safe.\n" }, { "info": { "name": "Restarts the specified Autonomous AI Database.", "type": "http" }, "http": { "method": "POST", "url": "http://localhost:19222/20160918/autonomousDatabases/:autonomousDatabaseId/actions/restart", "headers": [ { "name": "if-match", "value": "" } ], "params": [ { "name": "autonomousDatabaseId", "value": "", "type": "path", "description": "The database [OCID](/Content/General/Concepts/identifiers.htm)." }, { "name": "isOnlineRestart", "value": "", "type": "query", "description": "If provided, an online restart will be triggered." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Restarts the specified Autonomous AI Database.\n" }, { "info": { "name": "Restores an Autonomous AI Database based on the provided request parameters.", "type": "http" }, "http": { "method": "POST", "url": "http://localhost:19222/20160918/autonomousDatabases/:autonomousDatabaseId/actions/restore", "headers": [ { "name": "if-match", "value": "" } ], "params": [ { "name": "autonomousDatabaseId", "value": "", "type": "path", "description": "The database [OCID](/Content/General/Concepts/identifiers.htm)." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Restores an Autonomous AI Database based on the provided request parameters.\n" }, { "info": { "name": "Rotate Key", "type": "http" }, "http": { "method": "POST", "url": "http://localhost:19222/20160918/autonomousDatabases/:autonomousDatabaseId/actions/rotateKey", "headers": [ { "name": "if-match", "value": "" }, { "name": "opc-retry-token", "value": "" }, { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "autonomousDatabaseId", "value": "", "type": "path", "description": "The database [OCID](/Content/General/Concepts/identifiers.htm)." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Rotate existing AutonomousDatabase [Vault service](/iaas/Content/KeyManagement/Concepts/keyoverview.htm) key." }, { "info": { "name": "Shrinks the current allocated storage down to the current actual used storage.", "type": "http" }, "http": { "method": "POST", "url": "http://localhost:19222/20160918/autonomousDatabases/:autonomousDatabaseId/actions/shrink", "headers": [ { "name": "if-match", "value": "" } ], "params": [ { "name": "autonomousDatabaseId", "value": "", "type": "path", "description": "The database [OCID](/Content/General/Concepts/identifiers.htm)." } ] }, "docs": "This operation shrinks the current allocated storage down to the current actual used data storage (actualUsedDataStorageSizeInTBs). The if the base storage value for the database (dataStorageSizeInTBs) is larger than the actualUsedDataStorageSizeInTBs value, you are billed for the base storage value.\n" }, { "info": { "name": "Starts the specified Autonomous AI Database.", "type": "http" }, "http": { "method": "POST", "url": "http://localhost:19222/20160918/autonomousDatabases/:autonomousDatabaseId/actions/start", "headers": [ { "name": "if-match", "value": "" } ], "params": [ { "name": "autonomousDatabaseId", "value": "", "type": "path", "description": "The database [OCID](/Content/General/Concepts/identifiers.htm)." } ] }, "docs": "Starts the specified Autonomous AI Database.\n" }, { "info": { "name": "Stops the specified Autonomous AI Database.", "type": "http" }, "http": { "method": "POST", "url": "http://localhost:19222/20160918/autonomousDatabases/:autonomousDatabaseId/actions/stop", "headers": [ { "name": "if-match", "value": "" }, { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "autonomousDatabaseId", "value": "", "type": "path", "description": "The database [OCID](/Content/General/Concepts/identifiers.htm)." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Stops the specified Autonomous AI Database.\n" }, { "info": { "name": "Switches over AutonomousDatabase to a Standby.", "type": "http" }, "http": { "method": "POST", "url": "http://localhost:19222/20160918/autonomousDatabases/:autonomousDatabaseId/actions/switchover", "headers": [ { "name": "if-match", "value": "" }, { "name": "opc-retry-token", "value": "" }, { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "autonomousDatabaseId", "value": "", "type": "path", "description": "The database [OCID](/Content/General/Concepts/identifiers.htm)." }, { "name": "peerDbId", "value": "", "type": "query", "description": "The database OCID(/Content/General/Concepts/identifiers.htm) of the Disaster Recovery peer (source Primary) database, which is located in a different (remote) region from the current peer database." } ] }, "docs": "Initiates a switchover of the specified Autonomous AI Database to the associated peer database. Applicable only to databases with Disaster Recovery enabled.\nThis API should be called in the remote region where the peer database resides.\nBelow parameter is optional:\n - `peerDbId`\n Use this parameter to specify the database OCID of the Disaster Recovery peer, which is located in a different (remote) region from the current peer database.\n If this parameter is not provided, the switchover wi" }, { "info": { "name": "ListAutonomousDatabaseDataguardAssociations", "type": "http" }, "http": { "method": "GET", "url": "http://localhost:19222/20160918/autonomousDatabases/:autonomousDatabaseId/autonomousDatabaseDataguardAssociations", "params": [ { "name": "limit", "value": "", "type": "query", "description": "The maximum number of items to return per page." }, { "name": "page", "value": "", "type": "query", "description": "The pagination token to continue listing from." }, { "name": "autonomousDatabaseId", "value": "", "type": "path", "description": "The database [OCID](/Content/General/Concepts/identifiers.htm)." } ] }, "docs": "*Deprecated.* Use the [GetAutonomousContainerDatabase](#/en/database/latest/AutonomousContainerDatabase/GetAutonomousContainerDatabase) operation to get a list of the Autonomous Data Guard-enabled databases associated with the specified Autonomous AI Database.\n" }, { "info": { "name": "ListAutonomousDatabaseDataguardAssociation", "type": "http" }, "http": { "method": "GET", "url": "http://localhost:19222/20160918/autonomousDatabases/:autonomousDatabaseId/autonomousDatabaseDataguardAssociations/:autonomousDatabaseDataguardAssociationId", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "autonomousDatabaseId", "value": "", "type": "path", "description": "The database [OCID](/Content/General/Concepts/identifiers.htm)." }, { "name": "autonomousDatabaseDataguardAssociationId", "value": "", "type": "path", "description": "The Autonomous Container Database-Autonomous Data Guard association [OCID](/Content/General/Concepts/identifiers.htm)." } ] }, "docs": "*Deprecated.* Use the [GetAutonomousContainerDatabase](#/en/database/latest/AutonomousContainerDatabase/GetAutonomousContainerDatabase) operation to gets an Autonomous Data Guard-enabled database associated with the specified Autonomous AI Database.\n" }, { "info": { "name": "Gets a list of Autonomous AI Database clones.", "type": "http" }, "http": { "method": "GET", "url": "http://localhost:19222/20160918/autonomousDatabases/:autonomousDatabaseId/clones", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "compartmentId", "value": "", "type": "query", "description": "The compartment [OCID](/Content/General/Concepts/identifiers.htm)." }, { "name": "limit", "value": "", "type": "query", "description": "The maximum number of items to return per page." }, { "name": "page", "value": "", "type": "query", "description": "The pagination token to continue listing from." }, { "name": "autonomousDatabaseId", "value": "", "type": "path", "description": "The database [OCID](/Content/General/Concepts/identifiers.htm)." }, { "name": "sortOrder", "value": "", "type": "query", "description": "The sort order to use, either ascending (`ASC`) or descending (`DESC`)." }, { "name": "displayName", "value": "", "type": "query", "description": "A filter to return only resources that match the entire display name given. The match is not case sensitive." }, { "name": "lifecycleState", "value": "", "type": "query", "description": "A filter to return only resources that match the given lifecycle state exactly." }, { "name": "sortBy", "value": "", "type": "query", "description": "The field to sort by. You can provide one sort order (`sortOrder`). Default order for TIMECREATED is descending. Default order for DISPLAYNAME is ascending. The DISPLAYNAME sort order is case sensitive.\n\n**Note:** If you do not include the availability domain filter, the resources are grouped by availability domain, then sorted.\n" }, { "name": "cloneType", "value": "", "type": "query", "description": "A filter to return only resources that match the given clone type exactly." } ] }, "docs": "Lists the Autonomous AI Database clones for the specified Autonomous AI Database.\n" }, { "info": { "name": "Gets estimate cost savings of the Autonomous AI Database.", "type": "http" }, "http": { "method": "GET", "url": "http://localhost:19222/20160918/autonomousDatabases/:autonomousDatabaseId/estimateCostSavings", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "limit", "value": "", "type": "query", "description": "The maximum number of items to return per page." }, { "name": "page", "value": "", "type": "query", "description": "The pagination token to continue listing from." }, { "name": "isCpuAutoscale", "value": "", "type": "query", "description": "If provided as true, cost estimate with cpu autoscaling." }, { "name": "autonomousDatabaseId", "value": "", "type": "path", "description": "The database [OCID](/Content/General/Concepts/identifiers.htm)." } ] }, "docs": "Gets the estimate cost savings of the Autonomous AI Database." }, { "info": { "name": "Gets a list of Autonomous AI Database peers.", "type": "http" }, "http": { "method": "GET", "url": "http://localhost:19222/20160918/autonomousDatabases/:autonomousDatabaseId/peers", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "limit", "value": "", "type": "query", "description": "The maximum number of items to return per page." }, { "name": "page", "value": "", "type": "query", "description": "The pagination token to continue listing from." }, { "name": "autonomousDatabaseId", "value": "", "type": "path", "description": "The database [OCID](/Content/General/Concepts/identifiers.htm)." } ] }, "docs": "Lists the Autonomous AI Database peers for the specified Autonomous AI Database.\n" }, { "info": { "name": "Gets the list of Autonomous AI Database refreshable clone OCIDs and the region they exist.", "type": "http" }, "http": { "method": "GET", "url": "http://localhost:19222/20160918/autonomousDatabases/:autonomousDatabaseId/refreshableClones", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "limit", "value": "", "type": "query", "description": "The maximum number of items to return per page." }, { "name": "page", "value": "", "type": "query", "description": "The pagination token to continue listing from." }, { "name": "autonomousDatabaseId", "value": "", "type": "path", "description": "The database [OCID](/Content/General/Concepts/identifiers.htm)." } ] }, "docs": "Lists the OCIDs of the Autonomous AI Database local and connected remote refreshable clones with the region where they exist for the specified source database.\n" }, { "info": { "name": "Lists the OCIDs of the Autonomous AI Database resource pool members for the specified Autonomous AI Database leader.", "type": "http" }, "http": { "method": "GET", "url": "http://localhost:19222/20160918/autonomousDatabases/:autonomousDatabaseId/resourcePoolMembers", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "limit", "value": "", "type": "query", "description": "The maximum number of items to return per page." }, { "name": "page", "value": "", "type": "query", "description": "The pagination token to continue listing from." }, { "name": "autonomousDatabaseId", "value": "", "type": "path", "description": "The database [OCID](/Content/General/Concepts/identifiers.htm)." } ] }, "docs": "Lists the OCIDs of the Autonomous AI Database resource pool members for the specified Autonomous AI Database leader.\n" }, { "info": { "name": "Get the wallet for the specified Autonomous AI Database.", "type": "http" }, "http": { "method": "GET", "url": "http://localhost:19222/20160918/autonomousDatabases/:autonomousDatabaseId/wallet", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "autonomousDatabaseId", "value": "", "type": "path", "description": "The database [OCID](/Content/General/Concepts/identifiers.htm)." } ] }, "docs": "Gets the wallet details for the specified Autonomous AI Database.\n" }, { "info": { "name": "Updates the wallet for the specified Autonomous AI Database.", "type": "http" }, "http": { "method": "PUT", "url": "http://localhost:19222/20160918/autonomousDatabases/:autonomousDatabaseId/wallet", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "autonomousDatabaseId", "value": "", "type": "path", "description": "The database [OCID](/Content/General/Concepts/identifiers.htm)." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Updates the wallet for the specified Autonomous AI Database.\n" }, { "info": { "name": "Gets a list of supported Autonomous AI Database versions.", "type": "http" }, "http": { "method": "GET", "url": "http://localhost:19222/20160918/autonomousDbPreviewVersions", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "compartmentId", "value": "", "type": "query", "description": "The compartment [OCID](/Content/General/Concepts/identifiers.htm)." }, { "name": "limit", "value": "", "type": "query", "description": "The maximum number of items to return per page." }, { "name": "page", "value": "", "type": "query", "description": "The pagination token to continue listing from." }, { "name": "sortBy", "value": "", "type": "query", "description": "The field to sort by. You can provide one sort order (`sortOrder`). Default order for DBWORKLOAD is ascending.\n\n**Note:** If you do not include the availability domain filter, the resources are grouped by availability domain, then sorted.\n" }, { "name": "sortOrder", "value": "", "type": "query", "description": "The sort order to use, either ascending (`ASC`) or descending (`DESC`)." } ] }, "docs": "Gets a list of supported Autonomous AI Database versions. Note that preview version software is only available for\nAutonomous AI Database Serverless (https://docs.oracle.com/en/cloud/paas/autonomous-database/index.html) databases.\n" }, { "info": { "name": "Gets a list of supported Autonomous AI Database versions.", "type": "http" }, "http": { "method": "GET", "url": "http://localhost:19222/20160918/autonomousDbVersions", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "compartmentId", "value": "", "type": "query", "description": "The compartment [OCID](/Content/General/Concepts/identifiers.htm)." }, { "name": "limit", "value": "", "type": "query", "description": "The maximum number of items to return per page." }, { "name": "page", "value": "", "type": "query", "description": "The pagination token to continue listing from." }, { "name": "dbWorkload", "value": "", "type": "query", "description": "A filter to return only Autonomous AI Database resources that match the specified workload type." }, { "name": "sortOrder", "value": "", "type": "query", "description": "The sort order to use, either ascending (`ASC`) or descending (`DESC`)." } ] }, "docs": "Gets a list of supported Autonomous AI Database versions." }, { "info": { "name": "ListAutonomousExadataInfrastructureShapes", "type": "http" }, "http": { "method": "GET", "url": "http://localhost:19222/20160918/autonomousExadataInfrastructureShapes", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "availabilityDomain", "value": "", "type": "query", "description": "The name of the Availability Domain." }, { "name": "compartmentId", "value": "", "type": "query", "description": "The compartment [OCID](/Content/General/Concepts/identifiers.htm)." }, { "name": "limit", "value": "", "type": "query", "description": "The maximum number of items to return per page." }, { "name": "page", "value": "", "type": "query", "description": "The pagination token to continue listing from." } ] }, "docs": "**Deprecated.**\n" }, { "info": { "name": "ListAutonomousExadataInfrastructures", "type": "http" }, "http": { "method": "GET", "url": "http://localhost:19222/20160918/autonomousExadataInfrastructures", "params": [ { "name": "compartmentId", "value": "", "type": "query", "description": "The compartment [OCID](/Content/General/Concepts/identifiers.htm)." }, { "name": "limit", "value": "", "type": "query", "description": "The maximum number of items to return per page." }, { "name": "page", "value": "", "type": "query", "description": "The pagination token to continue listing from." }, { "name": "sortBy", "value": "", "type": "query", "description": "The field to sort by. You can provide one sort order (`sortOrder`). Default order for TIMECREATED is descending. Default order for DISPLAYNAME is ascending. The DISPLAYNAME sort order is case sensitive.\n\n **Note:** If you do not include the availability domain filter, the resources are grouped by availability domain, then sorted.\n" }, { "name": "sortOrder", "value": "", "type": "query", "description": "The sort order to use, either ascending (`ASC`) or descending (`DESC`)." }, { "name": "lifecycleState", "value": "", "type": "query", "description": "A filter to return only resources that match the given lifecycle state exactly." }, { "name": "availabilityDomain", "value": "", "type": "query", "description": "A filter to return only resources that match the given availability domain exactly." }, { "name": "displayName", "value": "", "type": "query", "description": "A filter to return only resources that match the entire display name given. The match is not case sensitive." } ] }, "docs": "**Deprecated.** Use the [ListCloudExadataInfrastructures](#/en/database/latest/CloudExadataInfrastructure/ListCloudExadataInfrastructures) operation to list Exadata Infrastructures in the Oracle cloud and the [ListCloudAutonomousVmClusters](#/en/database/latest/CloudAutonomousVmCluster/ListCloudAutonomousVmClusters) operation to list Autonomous Exadata VM clusters.\n" }, { "info": { "name": "LaunchAutonomousExadataInfrastructure", "type": "http" }, "http": { "method": "POST", "url": "http://localhost:19222/20160918/autonomousExadataInfrastructures", "headers": [ { "name": "opc-retry-token", "value": "" } ], "body": { "type": "json", "data": "{}" } }, "docs": "**Deprecated** To create a new Autonomous AI Database system on dedicated Exadata Infrastructure, use the [CreateCloudExadataInfrastructure](#/en/database/latest/CloudExadataInfrastructure/CreateCloudExadataInfrastructure) and [CreateCloudAutonomousVmCluster](#/en/database/latest/CloudAutonomousVmCluster/CreateCloudAutonomousVmCluster) operations instead. Note that to create an Autonomous VM cluster, you must have an existing Exadata Infrastructure resource to contain the VM cluster.\n" }, { "info": { "name": "GetAutonomousExadataInfrastructure", "type": "http" }, "http": { "method": "GET", "url": "http://localhost:19222/20160918/autonomousExadataInfrastructures/:autonomousExadataInfrastructureId", "params": [ { "name": "autonomousExadataInfrastructureId", "value": "", "type": "path", "description": "The Autonomous Exadata Infrastructure [OCID](/Content/General/Concepts/identifiers.htm)." } ] }, "docs": "**Deprecated.** Use the [GetCloudExadataInfrastructure](#/en/database/latest/CloudExadataInfrastructure/GetCloudExadataInfrastructure) operation to get details of an Exadata Infrastructure resource and the [GetCloudAutonomousVmCluster](#/en/database/latest/CloudAutonomousVmCluster/GetCloudAutonomousVmCluster) operation to get details of an Autonomous Exadata VM cluster.\n" }, { "info": { "name": "UpdateAutonomousExadataInfrastructure", "type": "http" }, "http": { "method": "PUT", "url": "http://localhost:19222/20160918/autonomousExadataInfrastructures/:autonomousExadataInfrastructureId", "headers": [ { "name": "if-match", "value": "" } ], "params": [ { "name": "autonomousExadataInfrastructureId", "value": "", "type": "path", "description": "The Autonomous Exadata Infrastructure [OCID](/Content/General/Concepts/identifiers.htm)." } ], "body": { "type": "json", "data": "{}" } }, "docs": "**Deprecated.** Use the [UpdateCloudExadataInfrastructure](#/en/database/latest/CloudExadataInfrastructure/UpdateCloudExadataInfrastructure) operation to update an Exadata Infrastructure resource and [UpdateCloudAutonomousVmCluster](#/en/database/latest/CloudAutonomousVmCluster/UpdateCloudAutonomousVmCluster) operation to update an Autonomous Exadata VM cluster.\n" }, { "info": { "name": "TerminateAutonomousExadataInfrastructure", "type": "http" }, "http": { "method": "DELETE", "url": "http://localhost:19222/20160918/autonomousExadataInfrastructures/:autonomousExadataInfrastructureId", "headers": [ { "name": "if-match", "value": "" } ], "params": [ { "name": "autonomousExadataInfrastructureId", "value": "", "type": "path", "description": "The Autonomous Exadata Infrastructure [OCID](/Content/General/Concepts/identifiers.htm)." } ] }, "docs": "**Deprecated.** To terminate an Exadata Infrastructure resource in the Oracle cloud, use the [DeleteCloudExadataInfrastructure](#/en/database/latest/CloudExadataInfrastructure/DeleteCloudExadataInfrastructure) operation. To delete an Autonomous Exadata VM cluster in the Oracle cloud, use the [DeleteCloudAutonomousVmCluster](#/en/database/latest/CloudAutonomousVmCluster/DeleteCloudAutonomousVmCluster) operation.\n" }, { "info": { "name": "ChangeAutonomousExadataInfrastructureCompartment", "type": "http" }, "http": { "method": "POST", "url": "http://localhost:19222/20160918/autonomousExadataInfrastructures/:autonomousExadataInfrastructureId/actions/changeCompartment", "headers": [ { "name": "opc-retry-token", "value": "" }, { "name": "opc-request-id", "value": "" }, { "name": "if-match", "value": "" } ], "params": [ { "name": "autonomousExadataInfrastructureId", "value": "", "type": "path", "description": "The Autonomous Exadata Infrastructure [OCID](/Content/General/Concepts/identifiers.htm)." } ], "body": { "type": "json", "data": "{}" } }, "docs": "**Deprecated.** Use the [ChangeCloudExadataInfrastructureCompartment](#/en/database/latest/CloudExadataInfrastructure/ChangeCloudExadataInfrastructureCompartment) operation to move an Exadata infrastructure resource to a different compartment and [ChangeCloudAutonomousVmClusterCompartment](#/en/database/latest/CloudAutonomousVmCluster/ChangeCloudAutonomousVmClusterCompartment) operation to move an Autonomous Exadata VM cluster to a different compartment.\nFor more information, see\n[Moving Databa" }, { "info": { "name": "Rotate ORDS certs for Autonomous Exadata Infrastructure.", "type": "http" }, "http": { "method": "POST", "url": "http://localhost:19222/20160918/autonomousExadataInfrastructures/:autonomousExadataInfrastructureId/actions/rotateOrdsCerts", "headers": [ { "name": "opc-request-id", "value": "" }, { "name": "opc-retry-token", "value": "" }, { "name": "if-match", "value": "" } ], "params": [ { "name": "autonomousExadataInfrastructureId", "value": "", "type": "path", "description": "The Autonomous Exadata Infrastructure [OCID](/Content/General/Concepts/identifiers.htm)." } ] }, "docs": "**Deprecated.** Use the [RotateCloudAutonomousVmClusterOrdsCerts](#/en/database/latest/CloudAutonomousVmCluster/RotateCloudAutonomousVmClusterOrdsCerts) to rotate Oracle REST Data Services (ORDS) certs for an Autonomous Exadata VM cluster instead.\n" }, { "info": { "name": "Rotate SSL certs for Autonomous Exadata Infrastructure.", "type": "http" }, "http": { "method": "POST", "url": "http://localhost:19222/20160918/autonomousExadataInfrastructures/:autonomousExadataInfrastructureId/actions/rotateSslCerts", "headers": [ { "name": "opc-request-id", "value": "" }, { "name": "opc-retry-token", "value": "" }, { "name": "if-match", "value": "" } ], "params": [ { "name": "autonomousExadataInfrastructureId", "value": "", "type": "path", "description": "The Autonomous Exadata Infrastructure [OCID](/Content/General/Concepts/identifiers.htm)." } ] }, "docs": "**Deprecated.** Use the [RotateCloudAutonomousVmClusterSslCerts](#/en/database/latest/CloudAutonomousVmCluster/RotateCloudAutonomousVmClusterSslCerts) to rotate SSL certs for an Autonomous Exadata VM cluster instead.\n" }, { "info": { "name": "GetExadataInfrastructureOcpus", "type": "http" }, "http": { "method": "GET", "url": "http://localhost:19222/20160918/autonomousExadataInfrastructures/:autonomousExadataInfrastructureId/ocpus", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "autonomousExadataInfrastructureId", "value": "", "type": "path", "description": "The Autonomous Exadata Infrastructure [OCID](/Content/General/Concepts/identifiers.htm)." } ] }, "docs": "Gets details of the available and consumed OCPUs for the specified Autonomous Exadata Infrastructure resource.\n" }, { "info": { "name": "GetAutonomousPatch", "type": "http" }, "http": { "method": "GET", "url": "http://localhost:19222/20160918/autonomousPatches/:autonomousPatchId", "params": [ { "name": "autonomousPatchId", "value": "", "type": "path", "description": "The autonomous patch [OCID](/Content/General/Concepts/identifiers.htm)." } ] }, "docs": "Gets information about a specific autonomous patch." }, { "info": { "name": "Gets the list of the Autonomous Virtual Machines.", "type": "http" }, "http": { "method": "GET", "url": "http://localhost:19222/20160918/autonomousVirtualMachines", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "compartmentId", "value": "", "type": "query", "description": "The compartment [OCID](/Content/General/Concepts/identifiers.htm)." }, { "name": "autonomousVmClusterId", "value": "", "type": "query", "description": "The Autonomous Virtual machine [OCID](/Content/General/Concepts/identifiers.htm)." }, { "name": "limit", "value": "", "type": "query", "description": "The maximum number of items to return per page." }, { "name": "page", "value": "", "type": "query", "description": "The pagination token to continue listing from." }, { "name": "lifecycleState", "value": "", "type": "query", "description": "A filter to return only resources that match the given lifecycle state exactly." } ] }, "docs": "Lists the Autonomous Virtual Machines in the specified Autonomous VM Cluster and Compartment.\n" }, { "info": { "name": "Gets the details of the specified Autonomous Virtual Machine.", "type": "http" }, "http": { "method": "GET", "url": "http://localhost:19222/20160918/autonomousVirtualMachines/:autonomousVirtualMachineId", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "autonomousVirtualMachineId", "value": "", "type": "path", "description": "The Autonomous Virtual machine [OCID](/Content/General/Concepts/identifiers.htm)." } ] }, "docs": "Gets the details of specific Autonomous Virtual Machine.\n" }, { "info": { "name": "ListAutonomousVmClusters", "type": "http" }, "http": { "method": "GET", "url": "http://localhost:19222/20160918/autonomousVmClusters", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "compartmentId", "value": "", "type": "query", "description": "The compartment [OCID](/Content/General/Concepts/identifiers.htm)." }, { "name": "exadataInfrastructureId", "value": "", "type": "query", "description": "If provided, filters the results for the given Exadata Infrastructure." }, { "name": "limit", "value": "", "type": "query", "description": "The maximum number of items to return per page." }, { "name": "page", "value": "", "type": "query", "description": "The pagination token to continue listing from." }, { "name": "sortBy", "value": "", "type": "query", "description": "The field to sort by. You can provide one sort order (`sortOrder`). Default order for TIMECREATED is descending. Default order for DISPLAYNAME is ascending. The DISPLAYNAME sort order is case sensitive.\n" }, { "name": "sortOrder", "value": "", "type": "query", "description": "The sort order to use, either ascending (`ASC`) or descending (`DESC`)." }, { "name": "lifecycleState", "value": "", "type": "query", "description": "A filter to return only resources that match the given lifecycle state exactly." }, { "name": "displayName", "value": "", "type": "query", "description": "A filter to return only resources that match the entire display name given. The match is not case sensitive." } ] }, "docs": "Gets a list of Exadata Cloud@Customer Autonomous VM clusters in the specified compartment. To list Autonomous VM Clusters in the Oracle Cloud, see [ListCloudAutonomousVmClusters](#/en/database/latest/CloudAutonomousVmCluster/ListCloudAutonomousVmClusters).\n" }, { "info": { "name": "CreateAutonomousVmCluster", "type": "http" }, "http": { "method": "POST", "url": "http://localhost:19222/20160918/autonomousVmClusters", "headers": [ { "name": "opc-retry-token", "value": "" }, { "name": "opc-request-id", "value": "" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Creates an Autonomous VM cluster for Exadata Cloud@Customer. To create an Autonomous VM Cluster in the Oracle cloud, see [CreateCloudAutonomousVmCluster](#/en/database/latest/CloudAutonomousVmCluster/CreateCloudAutonomousVmCluster).\n" }, { "info": { "name": "GetAutonomousVmCluster", "type": "http" }, "http": { "method": "GET", "url": "http://localhost:19222/20160918/autonomousVmClusters/:autonomousVmClusterId", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "autonomousVmClusterId", "value": "", "type": "path", "description": "The autonomous VM cluster [OCID](/Content/General/Concepts/identifiers.htm)." } ] }, "docs": "Gets information about the specified Autonomous VM cluster for an Exadata Cloud@Customer system. To get information about an Autonomous VM Cluster in the Oracle cloud, see [GetCloudAutonomousVmCluster](#/en/database/latest/CloudAutonomousVmCluster/GetCloudAutonomousVmCluster).\n" }, { "info": { "name": "Updates the specified Autonomous VM cluster.", "type": "http" }, "http": { "method": "PUT", "url": "http://localhost:19222/20160918/autonomousVmClusters/:autonomousVmClusterId", "headers": [ { "name": "if-match", "value": "" }, { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "autonomousVmClusterId", "value": "", "type": "path", "description": "The autonomous VM cluster [OCID](/Content/General/Concepts/identifiers.htm)." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Updates the specified Autonomous VM cluster for the Exadata Cloud@Customer system.To update an Autonomous VM Cluster in the Oracle cloud, see [UpdateCloudAutonomousVmCluster](#/en/database/latest/CloudAutonomousVmCluster/UpdateCloudAutonomousVmCluster).\n" }, { "info": { "name": "Deletes the specified Autonomous VM cluster.", "type": "http" }, "http": { "method": "DELETE", "url": "http://localhost:19222/20160918/autonomousVmClusters/:autonomousVmClusterId", "headers": [ { "name": "if-match", "value": "" }, { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "autonomousVmClusterId", "value": "", "type": "path", "description": "The autonomous VM cluster [OCID](/Content/General/Concepts/identifiers.htm)." } ] }, "docs": "Deletes the specified Autonomous VM cluster in an Exadata Cloud@Customer system. To delete an Autonomous VM Cluster in the Oracle cloud, see [DeleteCloudAutonomousVmCluster](#/en/database/latest/CloudAutonomousVmCluster/DeleteCloudAutonomousVmCluster).\n" }, { "info": { "name": "ListAutonomousVmClusterAcdResourceUsage", "type": "http" }, "http": { "method": "GET", "url": "http://localhost:19222/20160918/autonomousVmClusters/:autonomousVmClusterId/acdResourceUsage", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "compartmentId", "value": "", "type": "query", "description": "The compartment [OCID](/Content/General/Concepts/identifiers.htm)." }, { "name": "autonomousVmClusterId", "value": "", "type": "path", "description": "The autonomous VM cluster [OCID](/Content/General/Concepts/identifiers.htm)." }, { "name": "limit", "value": "", "type": "query", "description": "The maximum number of items to return per page." }, { "name": "page", "value": "", "type": "query", "description": "The pagination token to continue listing from." } ] }, "docs": "Gets the list of resource usage details for all the Autonomous Container Database in the specified Autonomous Exadata VM cluster.\n" }, { "info": { "name": "ChangeAutonomousVmClusterCompartment", "type": "http" }, "http": { "method": "POST", "url": "http://localhost:19222/20160918/autonomousVmClusters/:autonomousVmClusterId/actions/changeCompartment", "headers": [ { "name": "opc-retry-token", "value": "" }, { "name": "opc-request-id", "value": "" }, { "name": "if-match", "value": "" } ], "params": [ { "name": "autonomousVmClusterId", "value": "", "type": "path", "description": "The autonomous VM cluster [OCID](/Content/General/Concepts/identifiers.htm)." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Moves an Autonomous VM cluster and its dependent resources to another compartment. Applies to Exadata Cloud@Customer only. For systems in the Oracle cloud, see [ChangeAutonomousVmClusterCompartment](#/en/database/latest/AutonomousVmCluster/ChangeAutonomousVmClusterCompartment).\n" }, { "info": { "name": "RestartAutonomousVmClusterOrds", "type": "http" }, "http": { "method": "POST", "url": "http://localhost:19222/20160918/autonomousVmClusters/:autonomousVmClusterId/actions/restartOrds", "headers": [ { "name": "opc-retry-token", "value": "" }, { "name": "opc-request-id", "value": "" }, { "name": "if-match", "value": "" } ], "params": [ { "name": "autonomousVmClusterId", "value": "", "type": "path", "description": "The autonomous VM cluster [OCID](/Content/General/Concepts/identifiers.htm)." } ] }, "docs": "Restarts Oracle REST Data Services (ORDS) for Autonomous Exadata VM cluster.\n" }, { "info": { "name": "RotateAutonomousVmClusterOrdsCerts", "type": "http" }, "http": { "method": "POST", "url": "http://localhost:19222/20160918/autonomousVmClusters/:autonomousVmClusterId/actions/rotateOrdsCerts", "headers": [ { "name": "opc-request-id", "value": "" }, { "name": "opc-retry-token", "value": "" }, { "name": "if-match", "value": "" } ], "params": [ { "name": "autonomousVmClusterId", "value": "", "type": "path", "description": "The autonomous VM cluster [OCID](/Content/General/Concepts/identifiers.htm)." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Rotates the Oracle REST Data Services (ORDS) certificates for Autonomous Exadata VM cluster.\n" }, { "info": { "name": "RotateAutonomousVmClusterSslCerts", "type": "http" }, "http": { "method": "POST", "url": "http://localhost:19222/20160918/autonomousVmClusters/:autonomousVmClusterId/actions/rotateSslCerts", "headers": [ { "name": "opc-request-id", "value": "" }, { "name": "opc-retry-token", "value": "" }, { "name": "if-match", "value": "" } ], "params": [ { "name": "autonomousVmClusterId", "value": "", "type": "path", "description": "The autonomous VM cluster [OCID](/Content/General/Concepts/identifiers.htm)." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Rotates the SSL certificates for Autonomous Exadata VM cluster.\n" }, { "info": { "name": "GetAutonomousVmClusterResourceUsage", "type": "http" }, "http": { "method": "GET", "url": "http://localhost:19222/20160918/autonomousVmClusters/:autonomousVmClusterId/resourceUsage", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "autonomousVmClusterId", "value": "", "type": "path", "description": "The autonomous VM cluster [OCID](/Content/General/Concepts/identifiers.htm)." } ] }, "docs": "Get the resource usage details for the specified Autonomous Exadata VM cluster.\n" }, { "info": { "name": "ListBackupDestination", "type": "http" }, "http": { "method": "GET", "url": "http://localhost:19222/20160918/backupDestinations", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "compartmentId", "value": "", "type": "query", "description": "The compartment [OCID](/Content/General/Concepts/identifiers.htm)." }, { "name": "limit", "value": "", "type": "query", "description": "The maximum number of items to return per page." }, { "name": "page", "value": "", "type": "query", "description": "The pagination token to continue listing from." }, { "name": "type", "value": "", "type": "query", "description": "A filter to return only resources that match the given type of the Backup Destination." } ] }, "docs": "Gets a list of backup destinations in the specified compartment.\n" }, { "info": { "name": "CreateBackupDestination", "type": "http" }, "http": { "method": "POST", "url": "http://localhost:19222/20160918/backupDestinations", "headers": [ { "name": "opc-retry-token", "value": "" }, { "name": "opc-request-id", "value": "" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Creates a backup destination in an Exadata Cloud@Customer system.\n" }, { "info": { "name": "GetBackupDestination", "type": "http" }, "http": { "method": "GET", "url": "http://localhost:19222/20160918/backupDestinations/:backupDestinationId", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "backupDestinationId", "value": "", "type": "path", "description": "The [OCID](/Content/General/Concepts/identifiers.htm) of the backup destination." } ] }, "docs": "Gets information about the specified backup destination in an Exadata Cloud@Customer system.\n" }, { "info": { "name": "Updates the specified backup destination.", "type": "http" }, "http": { "method": "PUT", "url": "http://localhost:19222/20160918/backupDestinations/:backupDestinationId", "headers": [ { "name": "if-match", "value": "" }, { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "backupDestinationId", "value": "", "type": "path", "description": "The [OCID](/Content/General/Concepts/identifiers.htm) of the backup destination." } ], "body": { "type": "json", "data": "{}" } }, "docs": "If no database is associated with the backup destination:\n- For a RECOVERY_APPLIANCE backup destination, updates the connection string and/or the list of VPC users.\n- For an NFS backup destination, updates the NFS location.\n" }, { "info": { "name": "DeleteBackupDestination", "type": "http" }, "http": { "method": "DELETE", "url": "http://localhost:19222/20160918/backupDestinations/:backupDestinationId", "headers": [ { "name": "if-match", "value": "" }, { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "backupDestinationId", "value": "", "type": "path", "description": "The [OCID](/Content/General/Concepts/identifiers.htm) of the backup destination." } ] }, "docs": "Deletes a backup destination in an Exadata Cloud@Customer system.\n" }, { "info": { "name": "ChangeBackupDestinationCompartment", "type": "http" }, "http": { "method": "POST", "url": "http://localhost:19222/20160918/backupDestinations/:backupDestinationId/actions/changeCompartment", "headers": [ { "name": "opc-retry-token", "value": "" }, { "name": "opc-request-id", "value": "" }, { "name": "if-match", "value": "" } ], "params": [ { "name": "backupDestinationId", "value": "", "type": "path", "description": "The [OCID](/Content/General/Concepts/identifiers.htm) of the backup destination." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Move the backup destination and its dependent resources to the specified compartment.\nFor more information, see\n[Moving Database Resources to a Different Compartment](/Content/Database/Concepts/databaseoverview.htm#moveRes).\n" }, { "info": { "name": "ListBackups", "type": "http" }, "http": { "method": "GET", "url": "http://localhost:19222/20160918/backups", "params": [ { "name": "databaseId", "value": "", "type": "query", "description": "The [OCID](/Content/General/Concepts/identifiers.htm) of the database." }, { "name": "compartmentId", "value": "", "type": "query", "description": "The compartment [OCID](/Content/General/Concepts/identifiers.htm)." }, { "name": "limit", "value": "", "type": "query", "description": "The maximum number of items to return per page." }, { "name": "page", "value": "", "type": "query", "description": "The pagination token to continue listing from." }, { "name": "shapeFamily", "value": "", "type": "query", "description": "If provided, filters the results to the set of database versions which are supported for the given shape family." }, { "name": "version", "value": "", "type": "query", "description": "A filter to return only resources that match the given database version." }, { "name": "type", "value": "", "type": "query", "description": "A filter to return only backups that matches with the given type of Backup." }, { "name": "lifecycleState", "value": "", "type": "query", "description": "A filter to return only resources that match the given lifecycle state exactly." }, { "name": "timeExpiryScheduledGreaterThanOrEqualTo", "value": "", "type": "query", "description": "The start of date-time range of expiration for the long term backups to be fetched." }, { "name": "timeExpiryScheduledLessThan", "value": "", "type": "query", "description": "The end of date-time range of expiration for the long term backups to be fetched." }, { "name": "backupDestinationType", "value": "", "type": "query", "description": "A filter to return only resources that match the given backup destination type." } ] }, "docs": "Gets a list of backups based on the `databaseId` or `compartmentId` specified. Either one of these query parameters must be provided.\n" }, { "info": { "name": "CreateBackup", "type": "http" }, "http": { "method": "POST", "url": "http://localhost:19222/20160918/backups", "headers": [ { "name": "opc-retry-token", "value": "" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Creates a new backup in the specified database based on the request parameters you provide. If you previously used RMAN or dbcli to configure backups and then you switch to using the Console or the API for backups, a new backup configuration is created and associated with your database. This means that you can no longer rely on your previously configured unmanaged backups to work.\n" }, { "info": { "name": "GetBackup", "type": "http" }, "http": { "method": "GET", "url": "http://localhost:19222/20160918/backups/:backupId", "params": [ { "name": "backupId", "value": "", "type": "path", "description": "The backup [OCID](/Content/General/Concepts/identifiers.htm)." } ] }, "docs": "Gets information about the specified backup." }, { "info": { "name": "UpdateBackup", "type": "http" }, "http": { "method": "PUT", "url": "http://localhost:19222/20160918/backups/:backupId", "headers": [ { "name": "if-match", "value": "" }, { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "backupId", "value": "", "type": "path", "description": "The backup [OCID](/Content/General/Concepts/identifiers.htm)." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Updates database backup details." }, { "info": { "name": "DeleteBackup", "type": "http" }, "http": { "method": "DELETE", "url": "http://localhost:19222/20160918/backups/:backupId", "headers": [ { "name": "if-match", "value": "" } ], "params": [ { "name": "backupId", "value": "", "type": "path", "description": "The backup [OCID](/Content/General/Concepts/identifiers.htm)." } ] }, "docs": "Deletes a full backup. You cannot delete automatic backups using this API." }, { "info": { "name": "ListCloudAutonomousVmClusters", "type": "http" }, "http": { "method": "GET", "url": "http://localhost:19222/20160918/cloudAutonomousVmClusters", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "compartmentId", "value": "", "type": "query", "description": "The compartment [OCID](/Content/General/Concepts/identifiers.htm)." }, { "name": "cloudExadataInfrastructureId", "value": "", "type": "query", "description": "If provided, filters the results for the specified cloud Exadata infrastructure." }, { "name": "limit", "value": "", "type": "query", "description": "The maximum number of items to return per page." }, { "name": "page", "value": "", "type": "query", "description": "The pagination token to continue listing from." }, { "name": "sortBy", "value": "", "type": "query", "description": "The field to sort by. You can provide one sort order (`sortOrder`). Default order for TIMECREATED is descending. Default order for DISPLAYNAME is ascending. The DISPLAYNAME sort order is case sensitive.\n" }, { "name": "sortOrder", "value": "", "type": "query", "description": "The sort order to use, either ascending (`ASC`) or descending (`DESC`)." }, { "name": "lifecycleState", "value": "", "type": "query", "description": "A filter to return only resources that match the given lifecycle state exactly." }, { "name": "availabilityDomain", "value": "", "type": "query", "description": "A filter to return only resources that match the given availability domain exactly." }, { "name": "displayName", "value": "", "type": "query", "description": "A filter to return only resources that match the entire display name given. The match is not case sensitive." } ] }, "docs": "Lists Autonomous Exadata VM clusters in the Oracle cloud. For Exadata Cloud@Customer systems, see [ListAutonomousVmClusters](#/en/database/latest/AutonomousVmCluster/ListAutonomousVmClusters).\n" }, { "info": { "name": "CreateCloudAutonomousVmCluster", "type": "http" }, "http": { "method": "POST", "url": "http://localhost:19222/20160918/cloudAutonomousVmClusters", "headers": [ { "name": "opc-retry-token", "value": "" }, { "name": "opc-request-id", "value": "" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Creates an Autonomous Exadata VM cluster in the Oracle cloud. For Exadata Cloud@Customer systems, see [CreateAutonomousVmCluster](#/en/database/latest/AutonomousVmCluster/CreateAutonomousVmCluster).\n" }, { "info": { "name": "GetCloudAutonomousVmCluster", "type": "http" }, "http": { "method": "GET", "url": "http://localhost:19222/20160918/cloudAutonomousVmClusters/:cloudAutonomousVmClusterId", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "cloudAutonomousVmClusterId", "value": "", "type": "path", "description": "The Cloud VM cluster [OCID](/Content/General/Concepts/identifiers.htm)." } ] }, "docs": "Gets information about the specified Autonomous Exadata VM cluster in the Oracle cloud. For Exadata Cloud@Custustomer systems, see [GetAutonomousVmCluster ](#/en/database/latest/AutonomousVmCluster/GetAutonomousVmCluster).\n" }, { "info": { "name": "Updates the specified cloud Autonomous VM cluster.", "type": "http" }, "http": { "method": "PUT", "url": "http://localhost:19222/20160918/cloudAutonomousVmClusters/:cloudAutonomousVmClusterId", "headers": [ { "name": "if-match", "value": "" }, { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "cloudAutonomousVmClusterId", "value": "", "type": "path", "description": "The Cloud VM cluster [OCID](/Content/General/Concepts/identifiers.htm)." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Updates the specified Autonomous Exadata VM cluster in the Oracle cloud. For Exadata Cloud@Customer systems, see [UpdateAutonomousVmCluster](#/en/database/latest/AutonomousVmCluster/UpdateAutonomousVmCluster).\n" }, { "info": { "name": "Deletes the specified cloud VM cluster.", "type": "http" }, "http": { "method": "DELETE", "url": "http://localhost:19222/20160918/cloudAutonomousVmClusters/:cloudAutonomousVmClusterId", "headers": [ { "name": "if-match", "value": "" }, { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "cloudAutonomousVmClusterId", "value": "", "type": "path", "description": "The Cloud VM cluster [OCID](/Content/General/Concepts/identifiers.htm)." } ] }, "docs": "Deletes the specified Autonomous Exadata VM cluster in the Oracle cloud. For Exadata Cloud@Customer systems, see [DeleteAutonomousVmCluster](#/en/database/latest/AutonomousVmCluster/DeleteAutonomousVmCluster).\n" }, { "info": { "name": "ListCloudAutonomousVmClusterAcdResourceUsage", "type": "http" }, "http": { "method": "GET", "url": "http://localhost:19222/20160918/cloudAutonomousVmClusters/:cloudAutonomousVmClusterId/acdResourceUsage", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "compartmentId", "value": "", "type": "query", "description": "The compartment [OCID](/Content/General/Concepts/identifiers.htm)." }, { "name": "cloudAutonomousVmClusterId", "value": "", "type": "path", "description": "The Cloud VM cluster [OCID](/Content/General/Concepts/identifiers.htm)." }, { "name": "limit", "value": "", "type": "query", "description": "The maximum number of items to return per page." }, { "name": "page", "value": "", "type": "query", "description": "The pagination token to continue listing from." } ] }, "docs": "Gets the list of resource usage details for all the Cloud Autonomous Container Database\nin the specified Cloud Autonomous Exadata VM cluster.\n" }, { "info": { "name": "ChangeCloudAutonomousVmClusterCompartment", "type": "http" }, "http": { "method": "POST", "url": "http://localhost:19222/20160918/cloudAutonomousVmClusters/:cloudAutonomousVmClusterId/actions/changeCompartment", "headers": [ { "name": "opc-retry-token", "value": "" }, { "name": "opc-request-id", "value": "" }, { "name": "if-match", "value": "" } ], "params": [ { "name": "cloudAutonomousVmClusterId", "value": "", "type": "path", "description": "The Cloud VM cluster [OCID](/Content/General/Concepts/identifiers.htm)." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Moves an Autonomous Exadata VM cluster in the Oracle cloud and its dependent resources to another compartment. For Exadata Cloud@Customer systems, see [ChangeAutonomousVmClusterCompartment](#/en/database/latest/AutonomousVmCluster/ChangeAutonomousVmClusterCompartment).\n" }, { "info": { "name": "RestartCloudAutonomousVmClusterOrds", "type": "http" }, "http": { "method": "POST", "url": "http://localhost:19222/20160918/cloudAutonomousVmClusters/:cloudAutonomousVmClusterId/actions/restartOrds", "headers": [ { "name": "opc-retry-token", "value": "" }, { "name": "opc-request-id", "value": "" }, { "name": "if-match", "value": "" } ], "params": [ { "name": "cloudAutonomousVmClusterId", "value": "", "type": "path", "description": "The Cloud VM cluster [OCID](/Content/General/Concepts/identifiers.htm)." } ] }, "docs": "Restarts Oracle REST Data Services (ORDS) for a cloud Autonomous Exadata VM cluster.\n" }, { "info": { "name": "RotateCloudAutonomousVmClusterOrdsCerts", "type": "http" }, "http": { "method": "POST", "url": "http://localhost:19222/20160918/cloudAutonomousVmClusters/:cloudAutonomousVmClusterId/actions/rotateOrdsCerts", "headers": [ { "name": "opc-retry-token", "value": "" }, { "name": "opc-request-id", "value": "" }, { "name": "if-match", "value": "" } ], "params": [ { "name": "cloudAutonomousVmClusterId", "value": "", "type": "path", "description": "The Cloud VM cluster [OCID](/Content/General/Concepts/identifiers.htm)." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Rotates the Oracle REST Data Services (ORDS) certificates for a cloud Autonomous Exadata VM cluster.\n" }, { "info": { "name": "RotateCloudAutonomousVmClusterSslCerts", "type": "http" }, "http": { "method": "POST", "url": "http://localhost:19222/20160918/cloudAutonomousVmClusters/:cloudAutonomousVmClusterId/actions/rotateSslCerts", "headers": [ { "name": "opc-retry-token", "value": "" }, { "name": "opc-request-id", "value": "" }, { "name": "if-match", "value": "" } ], "params": [ { "name": "cloudAutonomousVmClusterId", "value": "", "type": "path", "description": "The Cloud VM cluster [OCID](/Content/General/Concepts/identifiers.htm)." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Rotates the SSL certficates for a cloud Autonomous Exadata VM cluster.\n" }, { "info": { "name": "GetCloudAutonomousVmClusterResourceUsage", "type": "http" }, "http": { "method": "GET", "url": "http://localhost:19222/20160918/cloudAutonomousVmClusters/:cloudAutonomousVmClusterId/resourceUsage", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "cloudAutonomousVmClusterId", "value": "", "type": "path", "description": "The Cloud VM cluster [OCID](/Content/General/Concepts/identifiers.htm)." } ] }, "docs": "Get the resource usage details for the specified Cloud Autonomous Exadata VM cluster.\n" }, { "info": { "name": "ListCloudExadataInfrastructures", "type": "http" }, "http": { "method": "GET", "url": "http://localhost:19222/20160918/cloudExadataInfrastructures", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "compartmentId", "value": "", "type": "query", "description": "The compartment [OCID](/Content/General/Concepts/identifiers.htm)." }, { "name": "limit", "value": "", "type": "query", "description": "The maximum number of items to return per page." }, { "name": "page", "value": "", "type": "query", "description": "The pagination token to continue listing from." }, { "name": "sortBy", "value": "", "type": "query", "description": "The field to sort by. You can provide one sort order (`sortOrder`). Default order for TIMECREATED is descending. Default order for DISPLAYNAME is ascending. The DISPLAYNAME sort order is case sensitive.\n" }, { "name": "sortOrder", "value": "", "type": "query", "description": "The sort order to use, either ascending (`ASC`) or descending (`DESC`)." }, { "name": "lifecycleState", "value": "", "type": "query", "description": "A filter to return only resources that match the given lifecycle state exactly." }, { "name": "displayName", "value": "", "type": "query", "description": "A filter to return only resources that match the entire display name given. The match is not case sensitive." }, { "name": "clusterPlacementGroupId", "value": "", "type": "query", "description": "A filter to return only resources that match the given cluster placement group ID exactly." } ] }, "docs": "Gets a list of the cloud Exadata infrastructure resources in the specified compartment. Applies to Exadata Cloud Service instances and Autonomous AI Database on dedicated Exadata infrastructure only.\n" }, { "info": { "name": "CreateCloudExadataInfrastructure", "type": "http" }, "http": { "method": "POST", "url": "http://localhost:19222/20160918/cloudExadataInfrastructures", "headers": [ { "name": "opc-retry-token", "value": "" }, { "name": "opc-request-id", "value": "" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Creates a cloud Exadata infrastructure resource. This resource is used to create either an [Exadata Cloud Service](/Content/Database/Concepts/exaoverview.htm) instance or an Autonomous AI Database on dedicated Exadata infrastructure.\n" }, { "info": { "name": "GetCloudExadataInfrastructure", "type": "http" }, "http": { "method": "GET", "url": "http://localhost:19222/20160918/cloudExadataInfrastructures/:cloudExadataInfrastructureId", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "cloudExadataInfrastructureId", "value": "", "type": "path", "description": "The cloud Exadata infrastructure [OCID](/Content/General/Concepts/identifiers.htm)." } ] }, "docs": "Gets information about the specified cloud Exadata infrastructure resource. Applies to Exadata Cloud Service instances and Autonomous AI Database on dedicated Exadata infrastructure only.\n" }, { "info": { "name": "Updates the specified cloud Exadata Infrastructure resource.", "type": "http" }, "http": { "method": "PUT", "url": "http://localhost:19222/20160918/cloudExadataInfrastructures/:cloudExadataInfrastructureId", "headers": [ { "name": "if-match", "value": "" }, { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "cloudExadataInfrastructureId", "value": "", "type": "path", "description": "The cloud Exadata infrastructure [OCID](/Content/General/Concepts/identifiers.htm)." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Updates the Cloud Exadata infrastructure resource. Applies to Exadata Cloud Service instances and Autonomous AI Database on dedicated Exadata infrastructure only.\n" }, { "info": { "name": "Deletes the specified cloud Exadata infrastructure.", "type": "http" }, "http": { "method": "DELETE", "url": "http://localhost:19222/20160918/cloudExadataInfrastructures/:cloudExadataInfrastructureId", "headers": [ { "name": "if-match", "value": "" }, { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "cloudExadataInfrastructureId", "value": "", "type": "path", "description": "The cloud Exadata infrastructure [OCID](/Content/General/Concepts/identifiers.htm)." }, { "name": "isDeleteVmClusters", "value": "", "type": "query", "description": "If `true`, forces the deletion the specified cloud Exadata infrastructure resource as well as all associated VM clusters. If `false`, the cloud Exadata infrastructure resource can be deleted only if it has no associated VM clusters. Default value is `false`.\n" } ] }, "docs": "Deletes the cloud Exadata infrastructure resource. Applies to Exadata Cloud Service instances and Autonomous AI Database on dedicated Exadata infrastructure only.\n" }, { "info": { "name": "Makes the storage capacity from additional storage servers available for Cloud VM Cluster consumption. Applies to Exadata Cloud instances only.", "type": "http" }, "http": { "method": "POST", "url": "http://localhost:19222/20160918/cloudExadataInfrastructures/:cloudExadataInfrastructureId/actions/addStorageCapacity", "headers": [ { "name": "if-match", "value": "" }, { "name": "opc-request-id", "value": "" }, { "name": "opc-retry-token", "value": "" } ], "params": [ { "name": "cloudExadataInfrastructureId", "value": "", "type": "path", "description": "The cloud Exadata infrastructure [OCID](/Content/General/Concepts/identifiers.htm)." } ] }, "docs": "Makes the storage capacity from additional storage servers available for Cloud VM Cluster consumption. Applies to Exadata Cloud Service instances and Autonomous AI Database on dedicated Exadata infrastructure only.\n" }, { "info": { "name": "ChangeCloudExadataInfrastructureCompartment", "type": "http" }, "http": { "method": "POST", "url": "http://localhost:19222/20160918/cloudExadataInfrastructures/:cloudExadataInfrastructureId/actions/changeCompartment", "headers": [ { "name": "opc-retry-token", "value": "" }, { "name": "opc-request-id", "value": "" }, { "name": "if-match", "value": "" } ], "params": [ { "name": "cloudExadataInfrastructureId", "value": "", "type": "path", "description": "The cloud Exadata infrastructure [OCID](/Content/General/Concepts/identifiers.htm)." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Moves a cloud Exadata infrastructure resource and its dependent resources to another compartment. Applies to Exadata Cloud Service instances and Autonomous AI Database on dedicated Exadata infrastructure only.For more information about moving resources to a different compartment, see [Moving Database Resources to a Different Compartment](/Content/Database/Concepts/databaseoverview.htm#moveRes).\n" }, { "info": { "name": "ChangeCloudExadataInfrastructureSubscription", "type": "http" }, "http": { "method": "POST", "url": "http://localhost:19222/20160918/cloudExadataInfrastructures/:cloudExadataInfrastructureId/actions/changeSubscription", "headers": [ { "name": "opc-retry-token", "value": "" }, { "name": "opc-request-id", "value": "" }, { "name": "if-match", "value": "" } ], "params": [ { "name": "cloudExadataInfrastructureId", "value": "", "type": "path", "description": "The cloud Exadata infrastructure [OCID](/Content/General/Concepts/identifiers.htm)." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Associate a cloud Exadata infrastructure with a different subscription.\n" }, { "info": { "name": "Configure exascale on Cloud ExadataInfrastructure.", "type": "http" }, "http": { "method": "POST", "url": "http://localhost:19222/20160918/cloudExadataInfrastructures/:cloudExadataInfrastructureId/actions/configureExascale", "headers": [ { "name": "if-match", "value": "" }, { "name": "opc-request-id", "value": "" }, { "name": "opc-retry-token", "value": "" } ], "params": [ { "name": "cloudExadataInfrastructureId", "value": "", "type": "path", "description": "The cloud Exadata infrastructure [OCID](/Content/General/Concepts/identifiers.htm)." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Configures Exascale on Cloud exadata infrastructure resource. Applies to Exadata Cloud Service instances only.\n" }, { "info": { "name": "GetCloudExadataInfrastructureUnallocatedResources", "type": "http" }, "http": { "method": "GET", "url": "http://localhost:19222/20160918/cloudExadataInfrastructures/:cloudExadataInfrastructureId/unAllocatedResources", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "cloudExadataInfrastructureId", "value": "", "type": "path", "description": "The cloud Exadata infrastructure [OCID](/Content/General/Concepts/identifiers.htm)." }, { "name": "dbServers", "value": "", "type": "query", "description": "The list of [OCIDs](/Content/General/Concepts/identifiers.htm) of the Db servers." } ] }, "docs": "Gets unallocated resources information for the specified Cloud Exadata infrastructure.\n" }, { "info": { "name": "ListCloudVmClusters", "type": "http" }, "http": { "method": "GET", "url": "http://localhost:19222/20160918/cloudVmClusters", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "compartmentId", "value": "", "type": "query", "description": "The compartment [OCID](/Content/General/Concepts/identifiers.htm)." }, { "name": "cloudExadataInfrastructureId", "value": "", "type": "query", "description": "If provided, filters the results for the specified cloud Exadata infrastructure." }, { "name": "limit", "value": "", "type": "query", "description": "The maximum number of items to return per page." }, { "name": "page", "value": "", "type": "query", "description": "The pagination token to continue listing from." }, { "name": "sortBy", "value": "", "type": "query", "description": "The field to sort by. You can provide one sort order (`sortOrder`). Default order for TIMECREATED is descending. Default order for DISPLAYNAME is ascending. The DISPLAYNAME sort order is case sensitive.\n" }, { "name": "sortOrder", "value": "", "type": "query", "description": "The sort order to use, either ascending (`ASC`) or descending (`DESC`)." }, { "name": "lifecycleState", "value": "", "type": "query", "description": "A filter to return only cloud VM clusters that match the given lifecycle state exactly." }, { "name": "displayName", "value": "", "type": "query", "description": "A filter to return only resources that match the entire display name given. The match is not case sensitive." } ] }, "docs": "Gets a list of the cloud VM clusters in the specified compartment. Applies to Exadata Cloud Service instances and Autonomous Database on dedicated Exadata infrastructure only.\n" }, { "info": { "name": "CreateCloudVmCluster", "type": "http" }, "http": { "method": "POST", "url": "http://localhost:19222/20160918/cloudVmClusters", "headers": [ { "name": "opc-retry-token", "value": "" }, { "name": "opc-request-id", "value": "" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Creates a cloud VM cluster.\n" }, { "info": { "name": "GetCloudVmCluster", "type": "http" }, "http": { "method": "GET", "url": "http://localhost:19222/20160918/cloudVmClusters/:cloudVmClusterId", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "cloudVmClusterId", "value": "", "type": "path", "description": "The cloud VM cluster [OCID](/Content/General/Concepts/identifiers.htm)." } ] }, "docs": "Gets information about the specified cloud VM cluster. Applies to Exadata Cloud Service instances and Autonomous Database on dedicated Exadata infrastructure only.\n" }, { "info": { "name": "Updates the specified cloud VM cluster.", "type": "http" }, "http": { "method": "PUT", "url": "http://localhost:19222/20160918/cloudVmClusters/:cloudVmClusterId", "headers": [ { "name": "if-match", "value": "" }, { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "cloudVmClusterId", "value": "", "type": "path", "description": "The cloud VM cluster [OCID](/Content/General/Concepts/identifiers.htm)." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Updates the specified cloud VM cluster. Applies to Exadata Cloud Service instances and Autonomous Database on dedicated Exadata infrastructure only.\n" }, { "info": { "name": "Deletes the specified cloud VM cluster.", "type": "http" }, "http": { "method": "DELETE", "url": "http://localhost:19222/20160918/cloudVmClusters/:cloudVmClusterId", "headers": [ { "name": "if-match", "value": "" }, { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "cloudVmClusterId", "value": "", "type": "path", "description": "The cloud VM cluster [OCID](/Content/General/Concepts/identifiers.htm)." } ] }, "docs": "Deletes the specified cloud VM cluster. Applies to Exadata Cloud Service instances and Autonomous Database on dedicated Exadata infrastructure only.\n" }, { "info": { "name": "GetCloudVmClusterIormConfig", "type": "http" }, "http": { "method": "GET", "url": "http://localhost:19222/20160918/cloudVmClusters/:cloudVmClusterId/CloudVmClusterIormConfig", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "cloudVmClusterId", "value": "", "type": "path", "description": "The cloud VM cluster [OCID](/Content/General/Concepts/identifiers.htm)." } ] }, "docs": "Gets the IORM configuration for the specified cloud VM cluster in an Exadata Cloud Service instance.\nIf you have not specified an IORM configuration, the default configuration is returned.\n" }, { "info": { "name": "UpdateCloudVmClusterIormConfig", "type": "http" }, "http": { "method": "PUT", "url": "http://localhost:19222/20160918/cloudVmClusters/:cloudVmClusterId/CloudVmClusterIormConfig", "headers": [ { "name": "opc-request-id", "value": "" }, { "name": "if-match", "value": "" } ], "params": [ { "name": "cloudVmClusterId", "value": "", "type": "path", "description": "The cloud VM cluster [OCID](/Content/General/Concepts/identifiers.htm)." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Updates the IORM settings for the specified cloud VM cluster in an Exadata Cloud Service instance.\n" }, { "info": { "name": "AddVirtualMachineToCloudVmCluster", "type": "http" }, "http": { "method": "POST", "url": "http://localhost:19222/20160918/cloudVmClusters/:cloudVmClusterId/actions/addVirtualMachine", "headers": [ { "name": "opc-retry-token", "value": "" }, { "name": "opc-request-id", "value": "" }, { "name": "if-match", "value": "" } ], "params": [ { "name": "cloudVmClusterId", "value": "", "type": "path", "description": "The cloud VM cluster [OCID](/Content/General/Concepts/identifiers.htm)." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Add Virtual Machines to the Cloud VM cluster. Applies to Exadata Cloud instances only.\n" }, { "info": { "name": "ChangeCloudVmClusterCompartment", "type": "http" }, "http": { "method": "POST", "url": "http://localhost:19222/20160918/cloudVmClusters/:cloudVmClusterId/actions/changeCompartment", "headers": [ { "name": "opc-retry-token", "value": "" }, { "name": "opc-request-id", "value": "" }, { "name": "if-match", "value": "" } ], "params": [ { "name": "cloudVmClusterId", "value": "", "type": "path", "description": "The cloud VM cluster [OCID](/Content/General/Concepts/identifiers.htm)." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Moves a cloud VM cluster and its dependent resources to another compartment. Applies to Exadata Cloud Service instances and Autonomous Database on dedicated Exadata infrastructure only.\n" }, { "info": { "name": "ChangeCloudVmClusterSubscription", "type": "http" }, "http": { "method": "POST", "url": "http://localhost:19222/20160918/cloudVmClusters/:cloudVmClusterId/actions/changeSubscription", "headers": [ { "name": "opc-retry-token", "value": "" }, { "name": "opc-request-id", "value": "" }, { "name": "if-match", "value": "" } ], "params": [ { "name": "cloudVmClusterId", "value": "", "type": "path", "description": "The cloud VM cluster [OCID](/Content/General/Concepts/identifiers.htm)." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Associate a cloud VM cluster with a different subscription.\n" }, { "info": { "name": "RegisterCloudVmClusterPkcs", "type": "http" }, "http": { "method": "POST", "url": "http://localhost:19222/20160918/cloudVmClusters/:cloudVmClusterId/actions/registerPkcs", "headers": [ { "name": "opc-retry-token", "value": "" }, { "name": "opc-request-id", "value": "" }, { "name": "if-match", "value": "" } ], "params": [ { "name": "cloudVmClusterId", "value": "", "type": "path", "description": "The cloud VM cluster [OCID](/Content/General/Concepts/identifiers.htm)." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Install the PKCS11 driver for given keystore type\n" }, { "info": { "name": "RemoveVirtualMachineFromCloudVmCluster", "type": "http" }, "http": { "method": "POST", "url": "http://localhost:19222/20160918/cloudVmClusters/:cloudVmClusterId/actions/removeVirtualMachine", "headers": [ { "name": "opc-retry-token", "value": "" }, { "name": "opc-request-id", "value": "" }, { "name": "if-match", "value": "" } ], "params": [ { "name": "cloudVmClusterId", "value": "", "type": "path", "description": "The cloud VM cluster [OCID](/Content/General/Concepts/identifiers.htm)." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Remove Virtual Machines from the Cloud VM cluster. Applies to Exadata Cloud instances only.\n" }, { "info": { "name": "UnregisterCloudVmClusterPkcs", "type": "http" }, "http": { "method": "POST", "url": "http://localhost:19222/20160918/cloudVmClusters/:cloudVmClusterId/actions/unregisterPkcs", "headers": [ { "name": "opc-retry-token", "value": "" }, { "name": "opc-request-id", "value": "" }, { "name": "if-match", "value": "" } ], "params": [ { "name": "cloudVmClusterId", "value": "", "type": "path", "description": "The cloud VM cluster [OCID](/Content/General/Concepts/identifiers.htm)." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Uninstall the PKCS11 driver for given keystore type\n" }, { "info": { "name": "ListCloudVmClusterUpdateHistoryEntries", "type": "http" }, "http": { "method": "GET", "url": "http://localhost:19222/20160918/cloudVmClusters/:cloudVmClusterId/updateHistoryEntries", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "cloudVmClusterId", "value": "", "type": "path", "description": "The cloud VM cluster [OCID](/Content/General/Concepts/identifiers.htm)." }, { "name": "updateType", "value": "", "type": "query", "description": "A filter to return only resources that match the given update type exactly." }, { "name": "limit", "value": "", "type": "query", "description": "The maximum number of items to return per page." }, { "name": "page", "value": "", "type": "query", "description": "The pagination token to continue listing from." } ] }, "docs": "Gets the history of the maintenance update actions performed on the specified cloud VM cluster. Applies to Exadata Cloud Service instances only.\n" }, { "info": { "name": "GetCloudVmClusterUpdateHistoryEntry", "type": "http" }, "http": { "method": "GET", "url": "http://localhost:19222/20160918/cloudVmClusters/:cloudVmClusterId/updateHistoryEntries/:updateHistoryEntryId", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "cloudVmClusterId", "value": "", "type": "path", "description": "The cloud VM cluster [OCID](/Content/General/Concepts/identifiers.htm)." }, { "name": "updateHistoryEntryId", "value": "", "type": "path", "description": "The [OCID](/Content/General/Concepts/identifiers.htm) of the maintenance update history entry." } ] }, "docs": "Gets the maintenance update history details for the specified update history entry. Applies to Exadata Cloud Service instances only.\n" }, { "info": { "name": "ListCloudVmClusterUpdates", "type": "http" }, "http": { "method": "GET", "url": "http://localhost:19222/20160918/cloudVmClusters/:cloudVmClusterId/updates", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "cloudVmClusterId", "value": "", "type": "path", "description": "The cloud VM cluster [OCID](/Content/General/Concepts/identifiers.htm)." }, { "name": "updateType", "value": "", "type": "query", "description": "A filter to return only resources that match the given update type exactly." }, { "name": "limit", "value": "", "type": "query", "description": "The maximum number of items to return per page." }, { "name": "page", "value": "", "type": "query", "description": "The pagination token to continue listing from." } ] }, "docs": "Lists the maintenance updates that can be applied to the specified cloud VM cluster. Applies to Exadata Cloud Service instances only.\n" }, { "info": { "name": "GetCloudVmClusterUpdate", "type": "http" }, "http": { "method": "GET", "url": "http://localhost:19222/20160918/cloudVmClusters/:cloudVmClusterId/updates/:updateId", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "cloudVmClusterId", "value": "", "type": "path", "description": "The cloud VM cluster [OCID](/Content/General/Concepts/identifiers.htm)." }, { "name": "updateId", "value": "", "type": "path", "description": "The [OCID](/Content/General/Concepts/identifiers.htm) of the maintenance update." } ] }, "docs": "Gets information about a specified maintenance update package for a cloud VM cluster. Applies to Exadata Cloud Service instances only.\n" }, { "info": { "name": "ListDatabaseSoftwareImages", "type": "http" }, "http": { "method": "GET", "url": "http://localhost:19222/20160918/databaseSoftwareImages", "params": [ { "name": "compartmentId", "value": "", "type": "query", "description": "The compartment [OCID](/Content/General/Concepts/identifiers.htm)." }, { "name": "limit", "value": "", "type": "query", "description": "The maximum number of items to return per page." }, { "name": "page", "value": "", "type": "query", "description": "The pagination token to continue listing from." }, { "name": "sortBy", "value": "", "type": "query", "description": "The field to sort by. You can provide one sort order (`sortOrder`). Default order for TIMECREATED is descending. Default order for DISPLAYNAME is ascending. The DISPLAYNAME sort order is case sensitive.\nDefault order for PATCHSET is descending.\n" }, { "name": "sortOrder", "value": "", "type": "query", "description": "The sort order to use, either ascending (`ASC`) or descending (`DESC`)." }, { "name": "lifecycleState", "value": "", "type": "query", "description": "A filter to return only resources that match the given lifecycle state exactly." }, { "name": "displayName", "value": "", "type": "query", "description": "A filter to return only resources that match the entire display name given. The match is not case sensitive." }, { "name": "imageType", "value": "", "type": "query", "description": "A filter to return only resources that match the given image type exactly." }, { "name": "imageShapeFamily", "value": "", "type": "query", "description": "A filter to return only resources that match the given image shape family exactly." }, { "name": "patchSetGreaterThanOrEqualTo", "value": "", "type": "query", "description": "A filter to return only resources with `patchSet` greater than or equal to given value." }, { "name": "isUpgradeSupported", "value": "", "type": "query", "description": "If provided, filters the results to the set of database versions which are supported for Upgrade." } ] }, "docs": "Gets a list of the database software images in the specified compartment.\n" }, { "info": { "name": "CreateDatabaseSoftwareImage", "type": "http" }, "http": { "method": "POST", "url": "http://localhost:19222/20160918/databaseSoftwareImages", "headers": [ { "name": "opc-retry-token", "value": "" } ], "body": { "type": "json", "data": "{}" } }, "docs": "create database software image in the specified compartment.\n" }, { "info": { "name": "GetDatabaseSoftwareImage", "type": "http" }, "http": { "method": "GET", "url": "http://localhost:19222/20160918/databaseSoftwareImages/:databaseSoftwareImageId", "params": [ { "name": "databaseSoftwareImageId", "value": "", "type": "path", "description": "The DB system [OCID](/Content/General/Concepts/identifiers.htm)." } ] }, "docs": "Gets information about the specified database software image." }, { "info": { "name": "UpdateDatabaseSoftwareImage", "type": "http" }, "http": { "method": "PUT", "url": "http://localhost:19222/20160918/databaseSoftwareImages/:databaseSoftwareImageId", "headers": [ { "name": "if-match", "value": "" } ], "params": [ { "name": "databaseSoftwareImageId", "value": "", "type": "path", "description": "The DB system [OCID](/Content/General/Concepts/identifiers.htm)." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Updates the properties of a Database Software Image, like Display Nmae" }, { "info": { "name": "DeleteDatabaseSoftwareImage", "type": "http" }, "http": { "method": "DELETE", "url": "http://localhost:19222/20160918/databaseSoftwareImages/:databaseSoftwareImageId", "headers": [ { "name": "if-match", "value": "" } ], "params": [ { "name": "databaseSoftwareImageId", "value": "", "type": "path", "description": "The DB system [OCID](/Content/General/Concepts/identifiers.htm)." } ] }, "docs": "Delete a database software image" }, { "info": { "name": "ChangeDatabaseSoftwareImageCompartment", "type": "http" }, "http": { "method": "POST", "url": "http://localhost:19222/20160918/databaseSoftwareImages/:databaseSoftwareImageId/actions/changeCompartment", "headers": [ { "name": "opc-retry-token", "value": "" }, { "name": "opc-request-id", "value": "" }, { "name": "if-match", "value": "" } ], "params": [ { "name": "databaseSoftwareImageId", "value": "", "type": "path", "description": "The DB system [OCID](/Content/General/Concepts/identifiers.htm)." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Move the Database Software Image and its dependent resources to the specified compartment.\nFor more information about moving Databse Software Images, see\n[Moving Database Resources to a Different Compartment](/Content/Database/Concepts/databaseoverview.htm#moveRes).\n" }, { "info": { "name": "ListDatabases", "type": "http" }, "http": { "method": "GET", "url": "http://localhost:19222/20160918/databases", "params": [ { "name": "compartmentId", "value": "", "type": "query", "description": "The compartment [OCID](/Content/General/Concepts/identifiers.htm)." }, { "name": "dbHomeId", "value": "", "type": "query", "description": "A Database Home [OCID](/Content/General/Concepts/identifiers.htm)." }, { "name": "systemId", "value": "", "type": "query", "description": "The [OCID](/Content/General/Concepts/identifiers.htm) of the Exadata DB system that you want to filter the database results by. Applies only to Exadata DB systems." }, { "name": "limit", "value": "", "type": "query", "description": "The maximum number of items to return per page." }, { "name": "page", "value": "", "type": "query", "description": "The pagination token to continue listing from." }, { "name": "sortBy", "value": "", "type": "query", "description": "The field to sort by. You can provide one sort order (`sortOrder`). Default order for TIMECREATED is descending. Default order for DBNAME is ascending. The DBNAME sort order is case sensitive." }, { "name": "sortOrder", "value": "", "type": "query", "description": "The sort order to use, either ascending (`ASC`) or descending (`DESC`)." }, { "name": "lifecycleState", "value": "", "type": "query", "description": "A filter to return only resources that match the given lifecycle state exactly." }, { "name": "dbName", "value": "", "type": "query", "description": "A filter to return only resources that match the entire database name given. The match is not case sensitive." } ] }, "docs": "Gets a list of the databases in the specified Database Home.\n" }, { "info": { "name": "CreateDatabase", "type": "http" }, "http": { "method": "POST", "url": "http://localhost:19222/20160918/databases", "headers": [ { "name": "opc-retry-token", "value": "" }, { "name": "opc-request-id", "value": "" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Creates a new database in the specified Database Home. If the database version is provided, it must match the version of the Database Home. Applies to Exadata and Exadata Cloud@Customer systems.\n" }, { "info": { "name": "GetDatabase", "type": "http" }, "http": { "method": "GET", "url": "http://localhost:19222/20160918/databases/:databaseId", "params": [ { "name": "databaseId", "value": "", "type": "path", "description": "The database [OCID](/Content/General/Concepts/identifiers.htm)." } ] }, "docs": "Gets information about the specified database." }, { "info": { "name": "UpdateDatabase", "type": "http" }, "http": { "method": "PUT", "url": "http://localhost:19222/20160918/databases/:databaseId", "headers": [ { "name": "if-match", "value": "" } ], "params": [ { "name": "databaseId", "value": "", "type": "path", "description": "The database [OCID](/Content/General/Concepts/identifiers.htm)." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Update the specified database based on the request parameters provided.\n" }, { "info": { "name": "DeleteDatabase", "type": "http" }, "http": { "method": "DELETE", "url": "http://localhost:19222/20160918/databases/:databaseId", "headers": [ { "name": "if-match", "value": "" }, { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "databaseId", "value": "", "type": "path", "description": "The database [OCID](/Content/General/Concepts/identifiers.htm)." }, { "name": "performFinalBackup", "value": "", "type": "query", "description": "Whether to perform a final backup of the database or not. Default is false.\n\nIf you previously used RMAN or dbcli to configure backups and then you switch to using the Console or the API for backups, a new backup configuration is created and associated with your database. This means that you can no longer rely on your previously configured unmanaged backups to work.\n\nThis parameter is used in multiple APIs. Refer to the API description for details on how the operation uses it.\n" } ] }, "docs": "Deletes the specified database. Applies only to Exadata systems.\n\nThe data in this database is local to the Exadata system and will be lost when the database is deleted. Oracle recommends that you back up any data in the Exadata system prior to deleting it. You can use the `performFinalBackup` parameter to have the Exadata system database backed up before it is deleted.\n" }, { "info": { "name": "Change encryption key location", "type": "http" }, "http": { "method": "POST", "url": "http://localhost:19222/20160918/databases/:databaseId/actions/changeEncryptionKeyLocation", "headers": [ { "name": "if-match", "value": "" }, { "name": "opc-retry-token", "value": "" }, { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "databaseId", "value": "", "type": "path", "description": "The database [OCID](/Content/General/Concepts/identifiers.htm)." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Update the encryption key management location for the database" }, { "info": { "name": "ConvertToPdb", "type": "http" }, "http": { "method": "POST", "url": "http://localhost:19222/20160918/databases/:databaseId/actions/convertToPdb", "headers": [ { "name": "if-match", "value": "" }, { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "databaseId", "value": "", "type": "path", "description": "The database [OCID](/Content/General/Concepts/identifiers.htm)." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Converts a non-container database to a pluggable database.\n" }, { "info": { "name": "Disables the Database Management service for the database.", "type": "http" }, "http": { "method": "POST", "url": "http://localhost:19222/20160918/databases/:databaseId/actions/disableDatabaseManagement", "headers": [ { "name": "opc-retry-token", "value": "" }, { "name": "opc-request-id", "value": "" }, { "name": "if-match", "value": "" } ], "params": [ { "name": "databaseId", "value": "", "type": "path", "description": "The database [OCID](/Content/General/Concepts/identifiers.htm)." } ] }, "docs": "Disables the Database Management service for the database.\n" }, { "info": { "name": "Enables the Database Management service for an Oracle Database located in Oracle Cloud Infrastructure.", "type": "http" }, "http": { "method": "POST", "url": "http://localhost:19222/20160918/databases/:databaseId/actions/enableDatabaseManagement", "headers": [ { "name": "opc-retry-token", "value": "" }, { "name": "opc-request-id", "value": "" }, { "name": "if-match", "value": "" } ], "params": [ { "name": "databaseId", "value": "", "type": "path", "description": "The database [OCID](/Content/General/Concepts/identifiers.htm)." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Enables the Database Management service for an Oracle Database located in Oracle Cloud Infrastructure. This service allows the database to access tools including Metrics and Performance hub. Database Management is enabled at the container database (CDB) level." }, { "info": { "name": "Migrate Key", "type": "http" }, "http": { "method": "POST", "url": "http://localhost:19222/20160918/databases/:databaseId/actions/migrateKey", "headers": [ { "name": "if-match", "value": "" }, { "name": "opc-retry-token", "value": "" }, { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "databaseId", "value": "", "type": "path", "description": "The database [OCID](/Content/General/Concepts/identifiers.htm)." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Changes encryption key management from customer-managed, using the [Vault service](/iaas/Content/KeyManagement/Concepts/keyoverview.htm), to Oracle-managed." }, { "info": { "name": "Updates one or more attributes of the Database Management service for the database.", "type": "http" }, "http": { "method": "POST", "url": "http://localhost:19222/20160918/databases/:databaseId/actions/modifyDatabaseManagement", "headers": [ { "name": "opc-retry-token", "value": "" }, { "name": "opc-request-id", "value": "" }, { "name": "if-match", "value": "" } ], "params": [ { "name": "databaseId", "value": "", "type": "path", "description": "The database [OCID](/Content/General/Concepts/identifiers.htm)." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Updates one or more attributes of the Database Management service for the database." }, { "info": { "name": "RescheduleManagedDbSoftwareUpdate", "type": "http" }, "http": { "method": "POST", "url": "http://localhost:19222/20160918/databases/:databaseId/actions/rescheduleManagedDbSoftwareUpdate", "headers": [ { "name": "if-match", "value": "" }, { "name": "opc-request-id", "value": "" }, { "name": "opc-retry-token", "value": "" } ], "params": [ { "name": "databaseId", "value": "", "type": "path", "description": "The database [OCID](/Content/General/Concepts/identifiers.htm)." } ] }, "docs": "Reschedule the Managed Database Software Update\n" }, { "info": { "name": "RestoreDatabase", "type": "http" }, "http": { "method": "POST", "url": "http://localhost:19222/20160918/databases/:databaseId/actions/restore", "headers": [ { "name": "if-match", "value": "" } ], "params": [ { "name": "databaseId", "value": "", "type": "path", "description": "The database [OCID](/Content/General/Concepts/identifiers.htm)." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Restore a Database based on the request parameters you provide.\n" }, { "info": { "name": "Rotate Key", "type": "http" }, "http": { "method": "POST", "url": "http://localhost:19222/20160918/databases/:databaseId/actions/rotateKey", "headers": [ { "name": "if-match", "value": "" }, { "name": "opc-retry-token", "value": "" }, { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "databaseId", "value": "", "type": "path", "description": "The database [OCID](/Content/General/Concepts/identifiers.htm)." } ] }, "docs": "Creates a new version of an existing [Vault service](/iaas/Content/KeyManagement/Concepts/keyoverview.htm) key." }, { "info": { "name": "UpgradeDatabase", "type": "http" }, "http": { "method": "POST", "url": "http://localhost:19222/20160918/databases/:databaseId/actions/upgrade", "headers": [ { "name": "if-match", "value": "" }, { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "databaseId", "value": "", "type": "path", "description": "The database [OCID](/Content/General/Concepts/identifiers.htm)." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Upgrades the specified Oracle Database instance.\n" }, { "info": { "name": "Convert a standby database to a standalone database.", "type": "http" }, "http": { "method": "POST", "url": "http://localhost:19222/20160918/databases/:databaseId/dataGuard/actions/convertToStandalone", "headers": [ { "name": "opc-retry-token", "value": "" }, { "name": "opc-request-id", "value": "" }, { "name": "if-match", "value": "" } ], "params": [ { "name": "databaseId", "value": "", "type": "path", "description": "The database [OCID](/Content/General/Concepts/identifiers.htm)." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Disassociate the standby database identified by the `databaseId` parameter from existing Data Guard group. \n\nConvert the standby to a standalone database. \n\nThis operation should be performed on respective standby database.\n" }, { "info": { "name": "Performs a failover to transition a standby database into the primary database role.", "type": "http" }, "http": { "method": "POST", "url": "http://localhost:19222/20160918/databases/:databaseId/dataGuard/actions/failover", "headers": [ { "name": "opc-retry-token", "value": "" }, { "name": "opc-request-id", "value": "" }, { "name": "if-match", "value": "" } ], "params": [ { "name": "databaseId", "value": "", "type": "path", "description": "The database [OCID](/Content/General/Concepts/identifiers.htm)." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Performs a failover to transition the standby database identified by the `databaseId` path parameter into the\nprimary role after the existing primary database fails or becomes unreachable.\n\nA failover might result in data loss depending on the protection mode in effect at the time of the primary\ndatabase failure.\n\nThis operation should be performed on respective standby database.\n" }, { "info": { "name": "Reinstates a database to a Data Guard association standby role.", "type": "http" }, "http": { "method": "POST", "url": "http://localhost:19222/20160918/databases/:databaseId/dataGuard/actions/reinstate", "headers": [ { "name": "opc-retry-token", "value": "" }, { "name": "opc-request-id", "value": "" }, { "name": "if-match", "value": "" } ], "params": [ { "name": "databaseId", "value": "", "type": "path", "description": "The database [OCID](/Content/General/Concepts/identifiers.htm)." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Reinstates the database identified by the `databaseId` parameter into the standby role in a Data Guard association. \n\nThis operation should be performed on disabled standby database.\n" }, { "info": { "name": "Performs a switchover to transition the primary database of a Data Guard association into a standby role.", "type": "http" }, "http": { "method": "POST", "url": "http://localhost:19222/20160918/databases/:databaseId/dataGuard/actions/switchover", "headers": [ { "name": "opc-retry-token", "value": "" }, { "name": "opc-request-id", "value": "" }, { "name": "if-match", "value": "" } ], "params": [ { "name": "databaseId", "value": "", "type": "path", "description": "The database [OCID](/Content/General/Concepts/identifiers.htm)." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Performs a switchover to transition primary database of this Data Guard association into a standby role. The\nstandby database associated with the `dataGuardAssociationId` assumes the primary database role.\n\nA switchover guarantees no data loss.\n\nThis operation should be performed on respective standby database.\n" }, { "info": { "name": "Updates an existing Data Guard member.", "type": "http" }, "http": { "method": "POST", "url": "http://localhost:19222/20160918/databases/:databaseId/dataGuard/actions/updateDataGuard", "headers": [ { "name": "opc-retry-token", "value": "" }, { "name": "opc-request-id", "value": "" }, { "name": "if-match", "value": "" } ], "params": [ { "name": "databaseId", "value": "", "type": "path", "description": "The database [OCID](/Content/General/Concepts/identifiers.htm)." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Update an existing Data Guard member. A Data Guard member represents the replication relationship between the\nspecified database and a standby database. For more information, see [Using Oracle Data Guard](/Content/Database/Tasks/usingdataguard.htm).\n" }, { "info": { "name": "Lists all Data Guard associations for the specified database.", "type": "http" }, "http": { "method": "GET", "url": "http://localhost:19222/20160918/databases/:databaseId/dataGuardAssociations", "params": [ { "name": "databaseId", "value": "", "type": "path", "description": "The database [OCID](/Content/General/Concepts/identifiers.htm)." }, { "name": "limit", "value": "", "type": "query", "description": "The maximum number of items to return per page." }, { "name": "page", "value": "", "type": "query", "description": "The pagination token to continue listing from." } ] }, "docs": "Lists all Data Guard associations for the specified database.\n" }, { "info": { "name": "Creates a Data Guard association.", "type": "http" }, "http": { "method": "POST", "url": "http://localhost:19222/20160918/databases/:databaseId/dataGuardAssociations", "headers": [ { "name": "opc-retry-token", "value": "" } ], "params": [ { "name": "databaseId", "value": "", "type": "path", "description": "The database [OCID](/Content/General/Concepts/identifiers.htm)." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Creates a new Data Guard association. A Data Guard association represents the replication relationship between the\nspecified database and a peer database. For more information, see [Using Oracle Data Guard](/Content/Database/Tasks/usingdataguard.htm).\n\nAll Oracle Cloud Infrastructure resources, including Data Guard associations, get an Oracle-assigned, unique ID\ncalled an Oracle Cloud Identifier (OCID). When you create a resource, you can find its OCID in the response.\nYou can also retrieve a r" }, { "info": { "name": "Gets configuration information for the specified database and Data Guard association.", "type": "http" }, "http": { "method": "GET", "url": "http://localhost:19222/20160918/databases/:databaseId/dataGuardAssociations/:dataGuardAssociationId", "params": [ { "name": "databaseId", "value": "", "type": "path", "description": "The database [OCID](/Content/General/Concepts/identifiers.htm)." }, { "name": "dataGuardAssociationId", "value": "", "type": "path", "description": "The Data Guard association's [OCID](/Content/General/Concepts/identifiers.htm)." } ] }, "docs": "Gets the specified Data Guard association's configuration information.\n" }, { "info": { "name": "Update Data Guard association of a database.", "type": "http" }, "http": { "method": "PUT", "url": "http://localhost:19222/20160918/databases/:databaseId/dataGuardAssociations/:dataGuardAssociationId", "headers": [ { "name": "if-match", "value": "" }, { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "databaseId", "value": "", "type": "path", "description": "The database [OCID](/Content/General/Concepts/identifiers.htm)." }, { "name": "dataGuardAssociationId", "value": "", "type": "path", "description": "The Data Guard association's [OCID](/Content/General/Concepts/identifiers.htm)." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Updates the Data Guard association the specified database. This API can be used to change the `protectionMode` and `transportType` of the Data Guard association.\n" }, { "info": { "name": "Performs a failover to transition a standby database into the primary database role.", "type": "http" }, "http": { "method": "POST", "url": "http://localhost:19222/20160918/databases/:databaseId/dataGuardAssociations/:dataGuardAssociationId/actions/failover", "headers": [ { "name": "if-match", "value": "" } ], "params": [ { "name": "databaseId", "value": "", "type": "path", "description": "The database [OCID](/Content/General/Concepts/identifiers.htm)." }, { "name": "dataGuardAssociationId", "value": "", "type": "path", "description": "The Data Guard association's [OCID](/Content/General/Concepts/identifiers.htm)." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Performs a failover to transition the standby database identified by the `databaseId` parameter into the\nspecified Data Guard association's primary role after the existing primary database fails or becomes unreachable.\n\nA failover might result in data loss depending on the protection mode in effect at the time of the primary\ndatabase failure.\n" }, { "info": { "name": "Enables existing Data Guard to support multiple standby databases.", "type": "http" }, "http": { "method": "POST", "url": "http://localhost:19222/20160918/databases/:databaseId/dataGuardAssociations/:dataGuardAssociationId/actions/migrate", "headers": [ { "name": "opc-retry-token", "value": "" }, { "name": "opc-request-id", "value": "" }, { "name": "if-match", "value": "" } ], "params": [ { "name": "databaseId", "value": "", "type": "path", "description": "The database [OCID](/Content/General/Concepts/identifiers.htm)." }, { "name": "dataGuardAssociationId", "value": "", "type": "path", "description": "The Data Guard association's [OCID](/Content/General/Concepts/identifiers.htm)." } ] }, "docs": "Migrates the existing Data Guard association to new Data Guard model to support multiple standby databases functionality. \n\nThis operation should always be performed on primary.\n" }, { "info": { "name": "Reinstates a database to a Data Guard association standby role.", "type": "http" }, "http": { "method": "POST", "url": "http://localhost:19222/20160918/databases/:databaseId/dataGuardAssociations/:dataGuardAssociationId/actions/reinstate", "headers": [ { "name": "if-match", "value": "" } ], "params": [ { "name": "databaseId", "value": "", "type": "path", "description": "The database [OCID](/Content/General/Concepts/identifiers.htm)." }, { "name": "dataGuardAssociationId", "value": "", "type": "path", "description": "The Data Guard association's [OCID](/Content/General/Concepts/identifiers.htm)." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Reinstates the database identified by the `databaseId` parameter into the standby role in a Data Guard association.\n" }, { "info": { "name": "Performs a switchover to transition the primary database of a Data Guard association into a standby role.", "type": "http" }, "http": { "method": "POST", "url": "http://localhost:19222/20160918/databases/:databaseId/dataGuardAssociations/:dataGuardAssociationId/actions/switchover", "headers": [ { "name": "if-match", "value": "" } ], "params": [ { "name": "databaseId", "value": "", "type": "path", "description": "The database [OCID](/Content/General/Concepts/identifiers.htm)." }, { "name": "dataGuardAssociationId", "value": "", "type": "path", "description": "The Data Guard association's [OCID](/Content/General/Concepts/identifiers.htm)." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Performs a switchover to transition the primary database of a Data Guard association into a standby role. The\nstandby database associated with the `dataGuardAssociationId` assumes the primary database role.\n\nA switchover guarantees no data loss.\n" }, { "info": { "name": "ListPdbConversionHistoryEntries", "type": "http" }, "http": { "method": "GET", "url": "http://localhost:19222/20160918/databases/:databaseId/pdbConversionHistoryEntries", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "databaseId", "value": "", "type": "path", "description": "The database [OCID](/Content/General/Concepts/identifiers.htm)." }, { "name": "pdbConversionAction", "value": "", "type": "query", "description": "A filter to return only the pluggable database conversion history entries that match the specified conversion action. For example, you can use this filter to return only entries for the precheck operation." }, { "name": "lifecycleState", "value": "", "type": "query", "description": "A filter to return only the pluggable database conversion history entries that match the specified lifecycle state. For example, you can use this filter to return only entries in the \"failed\" lifecycle state." }, { "name": "sortBy", "value": "", "type": "query", "description": "The field to sort by. You can provide one sort order (`sortOrder`). The default order for `TIMECREATED` is ascending.\n" }, { "name": "sortOrder", "value": "", "type": "query", "description": "The sort order to use, either ascending (`ASC`) or descending (`DESC`)." }, { "name": "limit", "value": "", "type": "query", "description": "The maximum number of items to return per page." }, { "name": "page", "value": "", "type": "query", "description": "The pagination token to continue listing from." } ] }, "docs": "Gets the pluggable database conversion history for a specified database in a bare metal or virtual machine DB system.\n" }, { "info": { "name": "GetPdbConversionHistoryEntry", "type": "http" }, "http": { "method": "GET", "url": "http://localhost:19222/20160918/databases/:databaseId/pdbConversionHistoryEntries/:pdbConversionHistoryEntryId", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "databaseId", "value": "", "type": "path", "description": "The database [OCID](/Content/General/Concepts/identifiers.htm)." }, { "name": "pdbConversionHistoryEntryId", "value": "", "type": "path", "description": "The database conversion history [OCID](/Content/General/Concepts/identifiers.htm)." } ] }, "docs": "Gets the details of operations performed to convert the specified database from non-container (non-CDB) to pluggable (PDB).\n" }, { "info": { "name": "ListDatabaseUpgradeHistoryEntries", "type": "http" }, "http": { "method": "GET", "url": "http://localhost:19222/20160918/databases/:databaseId/upgradeHistoryEntries", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "databaseId", "value": "", "type": "path", "description": "The database [OCID](/Content/General/Concepts/identifiers.htm)." }, { "name": "upgradeAction", "value": "", "type": "query", "description": "A filter to return only upgradeHistoryEntries that match the specified Upgrade Action." }, { "name": "lifecycleState", "value": "", "type": "query", "description": "A filter to return only upgradeHistoryEntries that match the given lifecycle state exactly." }, { "name": "sortBy", "value": "", "type": "query", "description": "The field to sort by. You can provide one sort order (`sortOrder`). Default order for TIMECREATED is ascending.\n" }, { "name": "sortOrder", "value": "", "type": "query", "description": "The sort order to use, either ascending (`ASC`) or descending (`DESC`)." }, { "name": "limit", "value": "", "type": "query", "description": "The maximum number of items to return per page." }, { "name": "page", "value": "", "type": "query", "description": "The pagination token to continue listing from." } ] }, "docs": "Gets the upgrade history for a specified database in a bare metal or virtual machine DB system.\n" }, { "info": { "name": "GetDatabaseUpgradeHistoryEntry", "type": "http" }, "http": { "method": "GET", "url": "http://localhost:19222/20160918/databases/:databaseId/upgradeHistoryEntries/:upgradeHistoryEntryId", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "databaseId", "value": "", "type": "path", "description": "The database [OCID](/Content/General/Concepts/identifiers.htm)." }, { "name": "upgradeHistoryEntryId", "value": "", "type": "path", "description": "The database/db system upgrade History [OCID](/Content/General/Concepts/identifiers.htm)." } ] }, "docs": "gets the upgrade history for a specified database.\n" }, { "info": { "name": "Gets a list of Database Connection Bundles in the specified compartment", "type": "http" }, "http": { "method": "GET", "url": "http://localhost:19222/20160918/dbConnectionBundles", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "compartmentId", "value": "", "type": "query", "description": "The compartment [OCID](/Content/General/Concepts/identifiers.htm)." }, { "name": "limit", "value": "", "type": "query", "description": "The maximum number of items to return per page." }, { "name": "page", "value": "", "type": "query", "description": "The pagination token to continue listing from." }, { "name": "sortOrder", "value": "", "type": "query", "description": "The sort order to use, either ascending (`ASC`) or descending (`DESC`)." }, { "name": "sortBy", "value": "", "type": "query", "description": "The field to sort by. You can specify only one sort order. The default\norder for `TIMECREATED` is descending. The default order for `TIMEREFRESHED` \nis descending.\n" }, { "name": "lifecycleState", "value": "", "type": "query", "description": "A filter that returns only resources that match the given lifecycle state. The state value is case-insensitive." }, { "name": "displayName", "value": "", "type": "query", "description": "A filter to return only resources that match the entire display name given. The match is not case sensitive." }, { "name": "dbConnectionBundleType", "value": "", "type": "query", "description": "A filter that returns only resources that match the specified database connection bundle type." }, { "name": "associatedResourceId", "value": "", "type": "query", "description": "The OCID of the VM cluster associated with the connection bundle. If the parameter is set to null, all bundles are returned." } ] }, "docs": "Lists all database connection bundles that match the query parameters.\n" }, { "info": { "name": "Gets a database connection bundle.", "type": "http" }, "http": { "method": "GET", "url": "http://localhost:19222/20160918/dbConnectionBundles/:dbConnectionBundleId", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "dbConnectionBundleId", "value": "", "type": "path", "description": "The OCID of the database connection bundle." } ] }, "docs": "Gets information about the specified database connection bundle." }, { "info": { "name": "Downloads a database connection bundle.", "type": "http" }, "http": { "method": "POST", "url": "http://localhost:19222/20160918/dbConnectionBundles/:dbConnectionBundleId/actions/download", "headers": [ { "name": "opc-request-id", "value": "" }, { "name": "if-match", "value": "" }, { "name": "opc-retry-token", "value": "" } ], "params": [ { "name": "dbConnectionBundleId", "value": "", "type": "path", "description": "The OCID of the database connection bundle." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Downloads the specified database connection bundle content.\nThe bundle is returned as a binary file containing the connection details.\n" }, { "info": { "name": "ListDbHomes", "type": "http" }, "http": { "method": "GET", "url": "http://localhost:19222/20160918/dbHomes", "params": [ { "name": "compartmentId", "value": "", "type": "query", "description": "The compartment [OCID](/Content/General/Concepts/identifiers.htm)." }, { "name": "dbSystemId", "value": "", "type": "query", "description": "The DB system [OCID](/Content/General/Concepts/identifiers.htm). If provided, filters the results to the set of database versions which are supported for the DB system." }, { "name": "vmClusterId", "value": "", "type": "query", "description": "The [OCID](/Content/General/Concepts/identifiers.htm) of the VM cluster." }, { "name": "backupId", "value": "", "type": "query", "description": "The [OCID](/Content/General/Concepts/identifiers.htm) of the backup. Specify a backupId to list only the DB systems or DB homes that support creating a database using this backup in this compartment." }, { "name": "dbVersion", "value": "", "type": "query", "description": "A filter to return only DB Homes that match the specified dbVersion." }, { "name": "limit", "value": "", "type": "query", "description": "The maximum number of items to return per page." }, { "name": "page", "value": "", "type": "query", "description": "The pagination token to continue listing from." }, { "name": "sortBy", "value": "", "type": "query", "description": "The field to sort by. You can provide one sort order (`sortOrder`). Default order for TIMECREATED is descending. Default order for DISPLAYNAME is ascending. The DISPLAYNAME sort order is case sensitive." }, { "name": "sortOrder", "value": "", "type": "query", "description": "The sort order to use, either ascending (`ASC`) or descending (`DESC`)." }, { "name": "lifecycleState", "value": "", "type": "query", "description": "A filter to return only resources that match the given lifecycle state exactly." }, { "name": "displayName", "value": "", "type": "query", "description": "A filter to return only resources that match the entire display name given. The match is not case sensitive." } ] }, "docs": "Lists the Database Homes in the specified DB system and compartment. A Database Home is a directory where Oracle Database software is installed.\n" }, { "info": { "name": "CreateDbHome", "type": "http" }, "http": { "method": "POST", "url": "http://localhost:19222/20160918/dbHomes", "headers": [ { "name": "opc-retry-token", "value": "" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Creates a new Database Home in the specified database system based on the request parameters you provide. Applies to bare metal DB systems, Exadata systems, and Exadata Cloud@Customer systems.\n" }, { "info": { "name": "GetDbHome", "type": "http" }, "http": { "method": "GET", "url": "http://localhost:19222/20160918/dbHomes/:dbHomeId", "params": [ { "name": "dbHomeId", "value": "", "type": "path", "description": "The Database Home [OCID](/Content/General/Concepts/identifiers.htm)." } ] }, "docs": "Gets information about the specified Database Home." }, { "info": { "name": "UpdateDbHome", "type": "http" }, "http": { "method": "PUT", "url": "http://localhost:19222/20160918/dbHomes/:dbHomeId", "headers": [ { "name": "if-match", "value": "" } ], "params": [ { "name": "dbHomeId", "value": "", "type": "path", "description": "The Database Home [OCID](/Content/General/Concepts/identifiers.htm)." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Patches the specified Database Home." }, { "info": { "name": "DeleteDbHome", "type": "http" }, "http": { "method": "DELETE", "url": "http://localhost:19222/20160918/dbHomes/:dbHomeId", "headers": [ { "name": "if-match", "value": "" } ], "params": [ { "name": "dbHomeId", "value": "", "type": "path", "description": "The Database Home [OCID](/Content/General/Concepts/identifiers.htm)." }, { "name": "performFinalBackup", "value": "", "type": "query", "description": "Whether to perform a final backup of the database or not. Default is false.\n\nIf you previously used RMAN or dbcli to configure backups and then you switch to using the Console or the API for backups, a new backup configuration is created and associated with your database. This means that you can no longer rely on your previously configured unmanaged backups to work.\n\nThis parameter is used in multiple APIs. Refer to the API description for details on how the operation uses it.\n" } ] }, "docs": "Deletes a Database Home. Applies to bare metal DB systems, Exadata Cloud Service, and Exadata Cloud@Customer systems.\n\nOracle recommends that you use the `performFinalBackup` parameter to back up any data on a bare metal DB system before you delete a Database Home. On an Exadata Cloud@Customer system or an Exadata Cloud Service system, you can delete a Database Home only when there are no databases in it and therefore you cannot use the `performFinalBackup` parameter to back up data.\n" }, { "info": { "name": "ListDbHomePatchHistoryEntries", "type": "http" }, "http": { "method": "GET", "url": "http://localhost:19222/20160918/dbHomes/:dbHomeId/patchHistoryEntries", "params": [ { "name": "dbHomeId", "value": "", "type": "path", "description": "The Database Home [OCID](/Content/General/Concepts/identifiers.htm)." }, { "name": "limit", "value": "", "type": "query", "description": "The maximum number of items to return per page." }, { "name": "page", "value": "", "type": "query", "description": "The pagination token to continue listing from." } ] }, "docs": "Lists the history of patch operations on the specified Database Home.\n" }, { "info": { "name": "GetDbHomePatchHistoryEntry", "type": "http" }, "http": { "method": "GET", "url": "http://localhost:19222/20160918/dbHomes/:dbHomeId/patchHistoryEntries/:patchHistoryEntryId", "params": [ { "name": "dbHomeId", "value": "", "type": "path", "description": "The Database Home [OCID](/Content/General/Concepts/identifiers.htm)." }, { "name": "patchHistoryEntryId", "value": "", "type": "path", "description": "The [OCID](/Content/General/Concepts/identifiers.htm) of the patch history entry." } ] }, "docs": "Gets the patch history details for the specified patchHistoryEntryId\n" }, { "info": { "name": "ListDbHomePatches", "type": "http" }, "http": { "method": "GET", "url": "http://localhost:19222/20160918/dbHomes/:dbHomeId/patches", "params": [ { "name": "dbHomeId", "value": "", "type": "path", "description": "The Database Home [OCID](/Content/General/Concepts/identifiers.htm)." }, { "name": "limit", "value": "", "type": "query", "description": "The maximum number of items to return per page." }, { "name": "page", "value": "", "type": "query", "description": "The pagination token to continue listing from." } ] }, "docs": "Lists patches applicable to the requested Database Home.\n" }, { "info": { "name": "GetDbHomePatch", "type": "http" }, "http": { "method": "GET", "url": "http://localhost:19222/20160918/dbHomes/:dbHomeId/patches/:patchId", "params": [ { "name": "dbHomeId", "value": "", "type": "path", "description": "The Database Home [OCID](/Content/General/Concepts/identifiers.htm)." }, { "name": "patchId", "value": "", "type": "path", "description": "The [OCID](/Content/General/Concepts/identifiers.htm) of the patch." } ] }, "docs": "Gets information about a specified patch package.\n" }, { "info": { "name": "ListDbNodes", "type": "http" }, "http": { "method": "GET", "url": "http://localhost:19222/20160918/dbNodes", "params": [ { "name": "compartmentId", "value": "", "type": "query", "description": "The compartment [OCID](/Content/General/Concepts/identifiers.htm)." }, { "name": "dbSystemId", "value": "", "type": "query", "description": "The DB system [OCID](/Content/General/Concepts/identifiers.htm). If provided, filters the results to the set of database versions which are supported for the DB system." }, { "name": "vmClusterId", "value": "", "type": "query", "description": "The [OCID](/Content/General/Concepts/identifiers.htm) of the VM cluster." }, { "name": "limit", "value": "", "type": "query", "description": "The maximum number of items to return per page." }, { "name": "page", "value": "", "type": "query", "description": "The pagination token to continue listing from." }, { "name": "sortBy", "value": "", "type": "query", "description": "Sort by TIMECREATED. Default order for TIMECREATED is descending." }, { "name": "sortOrder", "value": "", "type": "query", "description": "The sort order to use, either ascending (`ASC`) or descending (`DESC`)." }, { "name": "lifecycleState", "value": "", "type": "query", "description": "A filter to return only resources that match the given lifecycle state exactly." }, { "name": "dbServerId", "value": "", "type": "query", "description": "The [OCID](/Content/General/Concepts/identifiers.htm) of the Exacc Db server." } ] }, "docs": "Lists the database nodes in the specified DB system and compartment. In addition to the other required parameters, either '--db-system-id' or '--vm-cluster-id' also must be provided, depending on the service being accessed.\n" }, { "info": { "name": "GetDbNode", "type": "http" }, "http": { "method": "GET", "url": "http://localhost:19222/20160918/dbNodes/:dbNodeId", "params": [ { "name": "dbNodeId", "value": "", "type": "path", "description": "The database node [OCID](/Content/General/Concepts/identifiers.htm)." } ] }, "docs": "Gets information about the specified database node." }, { "info": { "name": "DbNodeAction", "type": "http" }, "http": { "method": "POST", "url": "http://localhost:19222/20160918/dbNodes/:dbNodeId", "headers": [ { "name": "opc-retry-token", "value": "" }, { "name": "if-match", "value": "" } ], "params": [ { "name": "dbNodeId", "value": "", "type": "path", "description": "The database node [OCID](/Content/General/Concepts/identifiers.htm)." }, { "name": "action", "value": "", "type": "query", "description": "The action to perform on the DB Node." } ] }, "docs": "Performs one of the following power actions on the specified DB node:\n- start - power on\n- stop - power off gracefully\n- forcestop - power off forcefully\n- forcereset - ACPI shutdown and power on forcefully\n- softreset - ACPI shutdown and power on\n- reset - power off and power on\n\n**Note:** Stopping a node affects billing differently, depending on the type of DB system:\n*Bare metal and Exadata systems* - The _stop_ state has no effect on the resources you consume.\nBilling continues for DB nodes " }, { "info": { "name": "ListConsoleConnections", "type": "http" }, "http": { "method": "GET", "url": "http://localhost:19222/20160918/dbNodes/:dbNodeId/consoleConnections", "params": [ { "name": "dbNodeId", "value": "", "type": "path", "description": "The database node [OCID](/Content/General/Concepts/identifiers.htm)." } ] }, "docs": "Lists the console connections for the specified database node.\n" }, { "info": { "name": "CreateConsoleConnection", "type": "http" }, "http": { "method": "POST", "url": "http://localhost:19222/20160918/dbNodes/:dbNodeId/consoleConnections", "headers": [ { "name": "opc-retry-token", "value": "" } ], "params": [ { "name": "dbNodeId", "value": "", "type": "path", "description": "The database node [OCID](/Content/General/Concepts/identifiers.htm)." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Creates a new console connection to the specified database node.\nAfter the console connection has been created and is available,\nyou connect to the console using SSH.\n" }, { "info": { "name": "GetConsoleConnection", "type": "http" }, "http": { "method": "GET", "url": "http://localhost:19222/20160918/dbNodes/:dbNodeId/consoleConnections/:consoleConnectionId", "params": [ { "name": "dbNodeId", "value": "", "type": "path", "description": "The database node [OCID](/Content/General/Concepts/identifiers.htm)." }, { "name": "consoleConnectionId", "value": "", "type": "path", "description": "The OCID of the console connection." } ] }, "docs": "Gets the specified database node console connection's information." }, { "info": { "name": "DeleteConsoleConnection", "type": "http" }, "http": { "method": "DELETE", "url": "http://localhost:19222/20160918/dbNodes/:dbNodeId/consoleConnections/:consoleConnectionId", "headers": [ { "name": "if-match", "value": "" } ], "params": [ { "name": "dbNodeId", "value": "", "type": "path", "description": "The database node [OCID](/Content/General/Concepts/identifiers.htm)." }, { "name": "consoleConnectionId", "value": "", "type": "path", "description": "The OCID of the console connection." } ] }, "docs": "Deletes the specified database node console connection." }, { "info": { "name": "ListConsoleHistories", "type": "http" }, "http": { "method": "GET", "url": "http://localhost:19222/20160918/dbNodes/:dbNodeId/consoleHistories", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "dbNodeId", "value": "", "type": "path", "description": "The database node [OCID](/Content/General/Concepts/identifiers.htm)." }, { "name": "limit", "value": "", "type": "query", "description": "The maximum number of items to return per page." }, { "name": "page", "value": "", "type": "query", "description": "The pagination token to continue listing from." }, { "name": "sortBy", "value": "", "type": "query", "description": "The field to sort by. You can provide one sort order (`sortOrder`). Default order for TIMECREATED is descending. Default order for DISPLAYNAME is ascending. The DISPLAYNAME sort order is case sensitive.\n" }, { "name": "sortOrder", "value": "", "type": "query", "description": "The sort order to use, either ascending (`ASC`) or descending (`DESC`)." }, { "name": "lifecycleState", "value": "", "type": "query", "description": "A filter to return only resources that match the given lifecycle state exactly." }, { "name": "displayName", "value": "", "type": "query", "description": "A filter to return only resources that match the entire display name given. The match is not case sensitive." } ] }, "docs": "Lists the console histories for the specified database node.\n" }, { "info": { "name": "CreateConsoleHistory", "type": "http" }, "http": { "method": "POST", "url": "http://localhost:19222/20160918/dbNodes/:dbNodeId/consoleHistories", "headers": [ { "name": "opc-retry-token", "value": "" }, { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "dbNodeId", "value": "", "type": "path", "description": "The database node [OCID](/Content/General/Concepts/identifiers.htm)." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Captures the most recent serial console data (up to a megabyte) for the specified database node.\n" }, { "info": { "name": "GetConsoleHistory", "type": "http" }, "http": { "method": "GET", "url": "http://localhost:19222/20160918/dbNodes/:dbNodeId/consoleHistories/:consoleHistoryId", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "dbNodeId", "value": "", "type": "path", "description": "The database node [OCID](/Content/General/Concepts/identifiers.htm)." }, { "name": "consoleHistoryId", "value": "", "type": "path", "description": "The OCID of the console history." } ] }, "docs": "Gets information about the specified database node console history.\n" }, { "info": { "name": "UpdateConsoleHistory", "type": "http" }, "http": { "method": "PUT", "url": "http://localhost:19222/20160918/dbNodes/:dbNodeId/consoleHistories/:consoleHistoryId", "headers": [ { "name": "if-match", "value": "" }, { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "dbNodeId", "value": "", "type": "path", "description": "The database node [OCID](/Content/General/Concepts/identifiers.htm)." }, { "name": "consoleHistoryId", "value": "", "type": "path", "description": "The OCID of the console history." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Updates the specified database node console history.\n" }, { "info": { "name": "DeleteConsoleHistory", "type": "http" }, "http": { "method": "DELETE", "url": "http://localhost:19222/20160918/dbNodes/:dbNodeId/consoleHistories/:consoleHistoryId", "headers": [ { "name": "if-match", "value": "" }, { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "dbNodeId", "value": "", "type": "path", "description": "The database node [OCID](/Content/General/Concepts/identifiers.htm)." }, { "name": "consoleHistoryId", "value": "", "type": "path", "description": "The OCID of the console history." } ] }, "docs": "Deletes the specified database node console history.\n" }, { "info": { "name": "GetConsoleHistoryContent", "type": "http" }, "http": { "method": "GET", "url": "http://localhost:19222/20160918/dbNodes/:dbNodeId/consoleHistories/:consoleHistoryId/content", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "dbNodeId", "value": "", "type": "path", "description": "The database node [OCID](/Content/General/Concepts/identifiers.htm)." }, { "name": "consoleHistoryId", "value": "", "type": "path", "description": "The OCID of the console history." } ] }, "docs": "Retrieves the specified database node console history contents upto a megabyte.\n" }, { "info": { "name": "ListDbServers", "type": "http" }, "http": { "method": "GET", "url": "http://localhost:19222/20160918/dbServers", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "compartmentId", "value": "", "type": "query", "description": "The compartment [OCID](/Content/General/Concepts/identifiers.htm)." }, { "name": "exadataInfrastructureId", "value": "", "type": "query", "description": "The [OCID](/Content/General/Concepts/identifiers.htm) of the ExadataInfrastructure." }, { "name": "limit", "value": "", "type": "query", "description": "The maximum number of items to return per page." }, { "name": "page", "value": "", "type": "query", "description": "The pagination token to continue listing from." }, { "name": "sortOrder", "value": "", "type": "query", "description": "The sort order to use, either ascending (`ASC`) or descending (`DESC`)." }, { "name": "sortBy", "value": "", "type": "query", "description": "Sort by TIMECREATED. Default order for TIMECREATED is descending." }, { "name": "lifecycleState", "value": "", "type": "query", "description": "A filter to return only resources that match the given lifecycle state exactly." }, { "name": "displayName", "value": "", "type": "query", "description": "A filter to return only resources that match the entire display name given. The match is not case sensitive." } ] }, "docs": "Lists the Exadata DB servers in the ExadataInfrastructureId and specified compartment.\n" }, { "info": { "name": "GetDbServer", "type": "http" }, "http": { "method": "GET", "url": "http://localhost:19222/20160918/dbServers/:dbServerId", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "exadataInfrastructureId", "value": "", "type": "query", "description": "The [OCID](/Content/General/Concepts/identifiers.htm) of the ExadataInfrastructure." }, { "name": "dbServerId", "value": "", "type": "path", "description": "The DB server [OCID](/Content/General/Concepts/identifiers.htm)." } ] }, "docs": "Gets information about the Exadata Db server.\n" }, { "info": { "name": "List of DbSystemComputePerformance params", "type": "http" }, "http": { "method": "GET", "url": "http://localhost:19222/20160918/dbSystemComputePerformance", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "dbSystemShape", "value": "", "type": "query", "description": "If provided, filters the results to the set of database versions which are supported for the given shape." }, { "name": "compartmentId", "value": "", "type": "query", "description": "The compartment [OCID](/Content/General/Concepts/identifiers.htm)." } ] }, "docs": "Gets a list of expected compute performance parameters for a virtual machine DB system based on system configuration. Adding compartmentId does not affect results.\n" }, { "info": { "name": "ListDbSystemShapes", "type": "http" }, "http": { "method": "GET", "url": "http://localhost:19222/20160918/dbSystemShapes", "params": [ { "name": "availabilityDomain", "value": "", "type": "query", "description": "The name of the Availability Domain." }, { "name": "compartmentId", "value": "", "type": "query", "description": "The compartment [OCID](/Content/General/Concepts/identifiers.htm)." }, { "name": "limit", "value": "", "type": "query", "description": "The maximum number of items to return per page." }, { "name": "page", "value": "", "type": "query", "description": "The pagination token to continue listing from." }, { "name": "shapeAttribute", "value": "", "type": "query", "description": "If provided and applicable, return DB System shape parameters based on the shapeAttribute provided" } ] }, "docs": "Gets a list of the shapes that can be used to launch a new DB system. The shape determines resources to allocate to the DB system - CPU cores and memory for VM shapes; CPU cores, memory and storage for non-VM (or bare metal) shapes." }, { "info": { "name": "ListFlexComponents", "type": "http" }, "http": { "method": "GET", "url": "http://localhost:19222/20160918/dbSystemShapes/flexComponents", "params": [ { "name": "compartmentId", "value": "", "type": "query", "description": "The compartment [OCID](/Content/General/Concepts/identifiers.htm)." }, { "name": "name", "value": "", "type": "query", "description": "A filter to return only resources that match the entire name given. The match is not case sensitive." }, { "name": "shape", "value": "", "type": "query", "description": "A filter to return only resources that belong to the entire shape name given. The match is not case sensitive." }, { "name": "sortOrder", "value": "", "type": "query", "description": "The sort order to use, either ascending (`ASC`) or descending (`DESC`)." }, { "name": "sortBy", "value": "", "type": "query", "description": "The field to sort by. You can provide one sort order (`sortOrder`). Default order for NAME is ascending. The NAME sort order is case sensitive.\n" }, { "name": "limit", "value": "", "type": "query", "description": "The maximum number of items to return per page." }, { "name": "page", "value": "", "type": "query", "description": "The pagination token to continue listing from." } ] }, "docs": "Gets a list of the flex components that can be used to launch a new DB system. The flex component determines resources to allocate to the DB system - Database Servers and Storage Servers." }, { "info": { "name": "List of DbSystemStoragePerformance params", "type": "http" }, "http": { "method": "GET", "url": "http://localhost:19222/20160918/dbSystemStoragePerformance", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "storageManagement", "value": "", "type": "query", "description": "The DB system storage management option. Used to list database versions available for that storage manager. Valid values are `ASM` and `LVM`.\n* ASM specifies Oracle Automatic Storage Management\n* LVM specifies logical volume manager, sometimes called logical disk manager.\n" }, { "name": "shapeType", "value": "", "type": "query", "description": "Optional. Filters the performance results by shape type." }, { "name": "databaseEdition", "value": "", "type": "query", "description": "The database edition of quota (STANDARD_EDITION/ENTERPRISE_EDITION/ENTERPRISE_EDITION_HIGH_PERFORMANCE/ENTERPRISE_EDITION_EXTREME_PERFORMANCE/ENTERPRISE_EDITION_DEVELOPER)" } ] }, "docs": "Gets a list of possible expected storage performance parameters of a VMDB System based on Configuration.\n" }, { "info": { "name": "ListDbSystems", "type": "http" }, "http": { "method": "GET", "url": "http://localhost:19222/20160918/dbSystems", "params": [ { "name": "compartmentId", "value": "", "type": "query", "description": "The compartment [OCID](/Content/General/Concepts/identifiers.htm)." }, { "name": "limit", "value": "", "type": "query", "description": "The maximum number of items to return per page." }, { "name": "page", "value": "", "type": "query", "description": "The pagination token to continue listing from." }, { "name": "backupId", "value": "", "type": "query", "description": "The [OCID](/Content/General/Concepts/identifiers.htm) of the backup. Specify a backupId to list only the DB systems or DB homes that support creating a database using this backup in this compartment." }, { "name": "sortBy", "value": "", "type": "query", "description": "The field to sort by. You can provide one sort order (`sortOrder`). Default order for TIMECREATED is descending. Default order for DISPLAYNAME is ascending. The DISPLAYNAME sort order is case sensitive.\n\n**Note:** If you do not include the availability domain filter, the resources are grouped by availability domain, then sorted.\n" }, { "name": "sortOrder", "value": "", "type": "query", "description": "The sort order to use, either ascending (`ASC`) or descending (`DESC`)." }, { "name": "lifecycleState", "value": "", "type": "query", "description": "A filter to return only resources that match the given lifecycle state exactly." }, { "name": "availabilityDomain", "value": "", "type": "query", "description": "A filter to return only resources that match the given availability domain exactly." }, { "name": "displayName", "value": "", "type": "query", "description": "A filter to return only resources that match the entire display name given. The match is not case sensitive." } ] }, "docs": "Lists the DB systems in the specified compartment. You can specify a `backupId` to list only the DB systems that support creating a database using this backup in this compartment.\n\n**Note:** Deprecated for Exadata Cloud Service systems. Use the [new resource model APIs](/iaas/Content/Database/Concepts/exaflexsystem.htm#exaflexsystem_topic-resource_model) instead.\n\nFor Exadata Cloud Service instances, support for this API will end on May 15th, 2021. See [Switching an Exadata DB System to the New " }, { "info": { "name": "LaunchDbSystem", "type": "http" }, "http": { "method": "POST", "url": "http://localhost:19222/20160918/dbSystems", "headers": [ { "name": "opc-retry-token", "value": "" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Creates a new DB system in the specified compartment and availability domain. The Oracle\nDatabase edition that you specify applies to all the databases on that DB system. The selected edition cannot be changed.\n\nAn initial database is created on the DB system based on the request parameters you provide and some default\noptions. For detailed information about default options, see [Bare metal and virtual machine DB system default options.](/Content/Database/Tasks/creatingDBsystem.htm#Default)\n\n**N" }, { "info": { "name": "GetDbSystem", "type": "http" }, "http": { "method": "GET", "url": "http://localhost:19222/20160918/dbSystems/:dbSystemId", "params": [ { "name": "dbSystemId", "value": "", "type": "path", "description": "The DB system [OCID](/Content/General/Concepts/identifiers.htm)." } ] }, "docs": "Gets information about the specified DB system.\n\n**Note:** Deprecated for Exadata Cloud Service systems. Use the [new resource model APIs](/iaas/Content/Database/Concepts/exaflexsystem.htm#exaflexsystem_topic-resource_model) instead.\n\nFor Exadata Cloud Service instances, support for this API will end on May 15th, 2021. See [Switching an Exadata DB System to the New Resource Model and APIs](/iaas/Content/Database/Concepts/exaflexsystem_topic-resource_model_conversion.htm) for details on convertin" }, { "info": { "name": "UpdateDbSystem", "type": "http" }, "http": { "method": "PUT", "url": "http://localhost:19222/20160918/dbSystems/:dbSystemId", "headers": [ { "name": "if-match", "value": "" } ], "params": [ { "name": "dbSystemId", "value": "", "type": "path", "description": "The DB system [OCID](/Content/General/Concepts/identifiers.htm)." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Updates the properties of the specified DB system.\n\n**Note:** Deprecated for Exadata Cloud Service systems. Use the [new resource model APIs](/iaas/Content/Database/Concepts/exaflexsystem.htm#exaflexsystem_topic-resource_model) instead.\n\nFor Exadata Cloud Service instances, support for this API will end on May 15th, 2021. See [Switching an Exadata DB System to the New Resource Model and APIs](/iaas/Content/Database/Concepts/exaflexsystem_topic-resource_model_conversion.htm) for details on conver" }, { "info": { "name": "TerminateDbSystem", "type": "http" }, "http": { "method": "DELETE", "url": "http://localhost:19222/20160918/dbSystems/:dbSystemId", "headers": [ { "name": "if-match", "value": "" } ], "params": [ { "name": "dbSystemId", "value": "", "type": "path", "description": "The DB system [OCID](/Content/General/Concepts/identifiers.htm)." } ] }, "docs": "Terminates a DB system and permanently deletes it and any databases running on it, and any storage volumes attached to it. The database data is local to the DB system and will be lost when the system is terminated. Oracle recommends that you back up any data in the DB system prior to terminating it.\n\n**Note:** Deprecated for Exadata Cloud Service systems. Use the [new resource model APIs](/iaas/Content/Database/Concepts/exaflexsystem.htm#exaflexsystem_topic-resource_model) instead.\n\nFor Exadata " }, { "info": { "name": "GetExadataIormConfig", "type": "http" }, "http": { "method": "GET", "url": "http://localhost:19222/20160918/dbSystems/:dbSystemId/ExadataIormConfig", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "dbSystemId", "value": "", "type": "path", "description": "The DB system [OCID](/Content/General/Concepts/identifiers.htm)." } ] }, "docs": "Gets the IORM configuration settings for the specified cloud Exadata DB system.\nAll Exadata service instances have default IORM settings.\n\n**Note:** Deprecated for Exadata Cloud Service systems. Use the [new resource model APIs](/iaas/Content/Database/Concepts/exaflexsystem.htm#exaflexsystem_topic-resource_model) instead.\n\nFor Exadata Cloud Service instances, support for this API will end on May 15th, 2021. See [Switching an Exadata DB System to the New Resource Model and APIs](/iaas/Content/Dat" }, { "info": { "name": "UpdateExadataIormConfig", "type": "http" }, "http": { "method": "PUT", "url": "http://localhost:19222/20160918/dbSystems/:dbSystemId/ExadataIormConfig", "headers": [ { "name": "opc-request-id", "value": "" }, { "name": "if-match", "value": "" } ], "params": [ { "name": "dbSystemId", "value": "", "type": "path", "description": "The DB system [OCID](/Content/General/Concepts/identifiers.htm)." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Updates IORM settings for the specified Exadata DB system.\n\n**Note:** Deprecated for Exadata Cloud Service systems. Use the [new resource model APIs](/iaas/Content/Database/Concepts/exaflexsystem.htm#exaflexsystem_topic-resource_model) instead.\n\nFor Exadata Cloud Service instances, support for this API will end on May 15th, 2021. See [Switching an Exadata DB System to the New Resource Model and APIs](/iaas/Content/Database/Concepts/exaflexsystem_topic-resource_model_conversion.htm) for details o" }, { "info": { "name": "ChangeDbSystemCompartment", "type": "http" }, "http": { "method": "POST", "url": "http://localhost:19222/20160918/dbSystems/:dbSystemId/actions/changeCompartment", "headers": [ { "name": "opc-retry-token", "value": "" }, { "name": "opc-request-id", "value": "" }, { "name": "if-match", "value": "" } ], "params": [ { "name": "dbSystemId", "value": "", "type": "path", "description": "The DB system [OCID](/Content/General/Concepts/identifiers.htm)." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Moves the DB system and its dependent resources to the specified compartment.\nFor more information about moving DB systems, see\n[Moving Database Resources to a Different Compartment](/Content/Database/Concepts/databaseoverview.htm#moveRes).\n" }, { "info": { "name": "MigrateExadataDbSystemResourceModel", "type": "http" }, "http": { "method": "POST", "url": "http://localhost:19222/20160918/dbSystems/:dbSystemId/actions/migration", "headers": [ { "name": "opc-request-id", "value": "" }, { "name": "if-match", "value": "" }, { "name": "opc-retry-token", "value": "" } ], "params": [ { "name": "dbSystemId", "value": "", "type": "path", "description": "The DB system [OCID](/Content/General/Concepts/identifiers.htm)." } ] }, "docs": "Migrates the Exadata DB system to the new [Exadata resource model](/iaas/Content/Database/Concepts/exaflexsystem.htm#exaflexsystem_topic-resource_model).\nAll related resources will be migrated.\n" }, { "info": { "name": "ExecuteDbSystemOsPatch", "type": "http" }, "http": { "method": "POST", "url": "http://localhost:19222/20160918/dbSystems/:dbSystemId/actions/osPatch", "headers": [ { "name": "opc-retry-token", "value": "" }, { "name": "opc-request-id", "value": "" }, { "name": "if-match", "value": "" } ], "params": [ { "name": "dbSystemId", "value": "", "type": "path", "description": "The DB system [OCID](/Content/General/Concepts/identifiers.htm)." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Execute an operating system (OS) patch action on a DB system. Returns 202 and a work request. Some updates may require a reboot.\n" }, { "info": { "name": "UpgradeDbSystem", "type": "http" }, "http": { "method": "POST", "url": "http://localhost:19222/20160918/dbSystems/:dbSystemId/actions/upgrade", "headers": [ { "name": "if-match", "value": "" }, { "name": "opc-request-id", "value": "" }, { "name": "opc-retry-token", "value": "" } ], "params": [ { "name": "dbSystemId", "value": "", "type": "path", "description": "The DB system [OCID](/Content/General/Concepts/identifiers.htm)." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Upgrades the operating system and grid infrastructure of the DB system.\n" }, { "info": { "name": "ListDbSystemUpgrades", "type": "http" }, "http": { "method": "GET", "url": "http://localhost:19222/20160918/dbSystems/:dbSystemId/dbSystemUpgrades", "params": [ { "name": "dbSystemId", "value": "", "type": "path", "description": "The DB system [OCID](/Content/General/Concepts/identifiers.htm)." }, { "name": "limit", "value": "", "type": "query", "description": "The maximum number of items to return per page." }, { "name": "page", "value": "", "type": "query", "description": "The pagination token to continue listing from." } ] }, "docs": "Lists the applicable upgrade components for a DB systems.\n" }, { "info": { "name": "ListDbSystemOsPatchHistoryEntries", "type": "http" }, "http": { "method": "GET", "url": "http://localhost:19222/20160918/dbSystems/:dbSystemId/osPatchHistoryEntries", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "dbSystemId", "value": "", "type": "path", "description": "The DB system [OCID](/Content/General/Concepts/identifiers.htm)." }, { "name": "limit", "value": "", "type": "query", "description": "The maximum number of items to return per page." }, { "name": "page", "value": "", "type": "query", "description": "The pagination token to continue listing from." }, { "name": "sortOrder", "value": "", "type": "query", "description": "The sort order to use, either ascending (`ASC`) or descending (`DESC`)." }, { "name": "sortBy", "value": "", "type": "query", "description": "The field to sort by. You can provide one sort order (`sortOrder`). Default order for TIMESTARTED is descending.\n" }, { "name": "lifecycleState", "value": "", "type": "query", "description": "A filter to return only OS patch history entries that match the given lifecycle state exactly." }, { "name": "action", "value": "", "type": "query", "description": "A filter to return only OS patch history entries that match the specified OS patch action." } ] }, "docs": "Gets the history of the OS patch actions performed on the specified DB system.\n" }, { "info": { "name": "GetDbSystemOsPatchHistoryEntry", "type": "http" }, "http": { "method": "GET", "url": "http://localhost:19222/20160918/dbSystems/:dbSystemId/osPatchHistoryEntries/:osPatchHistoryEntryId", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "dbSystemId", "value": "", "type": "path", "description": "The DB system [OCID](/Content/General/Concepts/identifiers.htm)." }, { "name": "osPatchHistoryEntryId", "value": "", "type": "path", "description": "The [OCID](/Content/General/Concepts/identifiers.htm) of the patch history entry." } ] }, "docs": "Gets the details of the specified OS patch action for the specified DB system.\n" }, { "info": { "name": "ListDbSystemPatchHistoryEntries", "type": "http" }, "http": { "method": "GET", "url": "http://localhost:19222/20160918/dbSystems/:dbSystemId/patchHistoryEntries", "params": [ { "name": "dbSystemId", "value": "", "type": "path", "description": "The DB system [OCID](/Content/General/Concepts/identifiers.htm)." }, { "name": "limit", "value": "", "type": "query", "description": "The maximum number of items to return per page." }, { "name": "page", "value": "", "type": "query", "description": "The pagination token to continue listing from." } ] }, "docs": "Gets the history of the patch actions performed on the specified DB system.\n" }, { "info": { "name": "GetDbSystemPatchHistoryEntry", "type": "http" }, "http": { "method": "GET", "url": "http://localhost:19222/20160918/dbSystems/:dbSystemId/patchHistoryEntries/:patchHistoryEntryId", "params": [ { "name": "dbSystemId", "value": "", "type": "path", "description": "The DB system [OCID](/Content/General/Concepts/identifiers.htm)." }, { "name": "patchHistoryEntryId", "value": "", "type": "path", "description": "The [OCID](/Content/General/Concepts/identifiers.htm) of the patch history entry." } ] }, "docs": "Gets the details of the specified patch operation on the specified DB system.\n" }, { "info": { "name": "ListDbSystemPatches", "type": "http" }, "http": { "method": "GET", "url": "http://localhost:19222/20160918/dbSystems/:dbSystemId/patches", "params": [ { "name": "dbSystemId", "value": "", "type": "path", "description": "The DB system [OCID](/Content/General/Concepts/identifiers.htm)." }, { "name": "limit", "value": "", "type": "query", "description": "The maximum number of items to return per page." }, { "name": "page", "value": "", "type": "query", "description": "The pagination token to continue listing from." } ] }, "docs": "Lists the patches applicable to the specified DB system.\n" }, { "info": { "name": "GetDbSystemPatch", "type": "http" }, "http": { "method": "GET", "url": "http://localhost:19222/20160918/dbSystems/:dbSystemId/patches/:patchId", "params": [ { "name": "dbSystemId", "value": "", "type": "path", "description": "The DB system [OCID](/Content/General/Concepts/identifiers.htm)." }, { "name": "patchId", "value": "", "type": "path", "description": "The [OCID](/Content/General/Concepts/identifiers.htm) of the patch." } ] }, "docs": "Gets information the specified patch.\n" }, { "info": { "name": "ListDbSystemUpgradeHistoryEntries", "type": "http" }, "http": { "method": "GET", "url": "http://localhost:19222/20160918/dbSystems/:dbSystemId/upgradeHistoryEntries", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "dbSystemId", "value": "", "type": "path", "description": "The DB system [OCID](/Content/General/Concepts/identifiers.htm)." }, { "name": "limit", "value": "", "type": "query", "description": "The maximum number of items to return per page." }, { "name": "page", "value": "", "type": "query", "description": "The pagination token to continue listing from." }, { "name": "sortOrder", "value": "", "type": "query", "description": "The sort order to use, either ascending (`ASC`) or descending (`DESC`)." }, { "name": "sortBy", "value": "", "type": "query", "description": "The field to sort by. You can provide one sort order (`sortOrder`). Default order for TIMECREATED is ascending.\n" }, { "name": "upgradeAction", "value": "", "type": "query", "description": "A filter to return only upgradeHistoryEntries that match the specified Upgrade Action." }, { "name": "lifecycleState", "value": "", "type": "query", "description": "A filter to return only upgrade history entries that match the given lifecycle state exactly." } ] }, "docs": "Gets the history of the upgrade actions performed on the specified DB system.\n" }, { "info": { "name": "GetDbSystemUpgradeHistoryEntry", "type": "http" }, "http": { "method": "GET", "url": "http://localhost:19222/20160918/dbSystems/:dbSystemId/upgradeHistoryEntries/:upgradeHistoryEntryId", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "dbSystemId", "value": "", "type": "path", "description": "The DB system [OCID](/Content/General/Concepts/identifiers.htm)." }, { "name": "upgradeHistoryEntryId", "value": "", "type": "path", "description": "The database/db system upgrade History [OCID](/Content/General/Concepts/identifiers.htm)." } ] }, "docs": "Gets the details of the specified operating system upgrade operation for the specified DB system.\n" }, { "info": { "name": "ListDbVersions", "type": "http" }, "http": { "method": "GET", "url": "http://localhost:19222/20160918/dbVersions", "params": [ { "name": "compartmentId", "value": "", "type": "query", "description": "The compartment [OCID](/Content/General/Concepts/identifiers.htm)." }, { "name": "limit", "value": "", "type": "query", "description": "The maximum number of items to return per page." }, { "name": "page", "value": "", "type": "query", "description": "The pagination token to continue listing from." }, { "name": "dbSystemShape", "value": "", "type": "query", "description": "If provided, filters the results to the set of database versions which are supported for the given shape." }, { "name": "dbSystemId", "value": "", "type": "query", "description": "The DB system [OCID](/Content/General/Concepts/identifiers.htm). If provided, filters the results to the set of database versions which are supported for the DB system." }, { "name": "storageManagement", "value": "", "type": "query", "description": "The DB system storage management option. Used to list database versions available for that storage manager. Valid values are `ASM` and `LVM`.\n* ASM specifies Oracle Automatic Storage Management\n* LVM specifies logical volume manager, sometimes called logical disk manager.\n" }, { "name": "shapeAttribute", "value": "", "type": "query", "description": "If provided and applicable, return DB System shape parameters based on the shapeAttribute provided" }, { "name": "isUpgradeSupported", "value": "", "type": "query", "description": "If provided, filters the results to the set of database versions which are supported for Upgrade." }, { "name": "isDatabaseSoftwareImageSupported", "value": "", "type": "query", "description": "If true, filters the results to the set of Oracle Database versions that are supported for OCI database software images." } ] }, "docs": "Gets a list of supported Oracle Database versions." }, { "info": { "name": "ListDbnodeSnapshots", "type": "http" }, "http": { "method": "GET", "url": "http://localhost:19222/20160918/dbnodeSnapshots", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "compartmentId", "value": "", "type": "query", "description": "The compartment [OCID](/Content/General/Concepts/identifiers.htm)." }, { "name": "limit", "value": "", "type": "query", "description": "The maximum number of items to return per page." }, { "name": "page", "value": "", "type": "query", "description": "The pagination token to continue listing from." }, { "name": "sortBy", "value": "", "type": "query", "description": "The field to sort by. You can provide one sort order (`sortOrder`). Default order for TIMECREATED is descending. Default order for NAME is ascending. The NAME sort order is case sensitive.\n" }, { "name": "name", "value": "", "type": "query", "description": "A filter to return only resources that match the entire name given. The match is not case sensitive." }, { "name": "sortOrder", "value": "", "type": "query", "description": "The sort order to use, either ascending (`ASC`) or descending (`DESC`)." }, { "name": "lifecycleState", "value": "", "type": "query", "description": "A filter to return only Exadata Database Snapshots that match the given lifecycle state exactly." }, { "name": "clusterId", "value": "", "type": "query", "description": "A filter to return only Exadata Database Node Snapshots that match the given VM cluster." }, { "name": "sourceDbnodeId", "value": "", "type": "query", "description": "A filter to return only Exadata Database Snapshots that match the given database node." } ] }, "docs": "Gets a list of the Exadata Database Node Snapshots in the specified compartment.\n" }, { "info": { "name": "GetDbnodeSnapshot", "type": "http" }, "http": { "method": "GET", "url": "http://localhost:19222/20160918/dbnodeSnapshots/:dbnodeSnapshotId", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "dbnodeSnapshotId", "value": "", "type": "path", "description": "The Exadata Database Node Snapshot [OCID](/Content/General/Concepts/identifiers.htm)." } ] }, "docs": "Gets information about the specified Exadata Database Node Snapshot in the specified compartment.\n" }, { "info": { "name": "Deletes the specified Exadata Database Node Snapshot.", "type": "http" }, "http": { "method": "DELETE", "url": "http://localhost:19222/20160918/dbnodeSnapshots/:dbnodeSnapshotId", "headers": [ { "name": "if-match", "value": "" }, { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "dbnodeSnapshotId", "value": "", "type": "path", "description": "The Exadata Database Node Snapshot [OCID](/Content/General/Concepts/identifiers.htm)." } ] }, "docs": "Deletes the specified Exadata Database Node Snapshot.\n" }, { "info": { "name": "MountDbnodeSnapshot", "type": "http" }, "http": { "method": "POST", "url": "http://localhost:19222/20160918/dbnodeSnapshots/:dbnodeSnapshotId/actions/mount", "headers": [ { "name": "opc-retry-token", "value": "" }, { "name": "opc-request-id", "value": "" }, { "name": "if-match", "value": "" } ], "params": [ { "name": "dbnodeSnapshotId", "value": "", "type": "path", "description": "The Exadata Database Node Snapshot [OCID](/Content/General/Concepts/identifiers.htm)." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Mounts the snapshot for the provided dbNode.\n" }, { "info": { "name": "UnmountDbnodeSnapshot", "type": "http" }, "http": { "method": "POST", "url": "http://localhost:19222/20160918/dbnodeSnapshots/:dbnodeSnapshotId/actions/unmount", "headers": [ { "name": "opc-retry-token", "value": "" }, { "name": "opc-request-id", "value": "" }, { "name": "if-match", "value": "" } ], "params": [ { "name": "dbnodeSnapshotId", "value": "", "type": "path", "description": "The Exadata Database Node Snapshot [OCID](/Content/General/Concepts/identifiers.htm)." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Unmounts the snapshot for the provided dbNode.\n" }, { "info": { "name": "ListExadataInfrastructures", "type": "http" }, "http": { "method": "GET", "url": "http://localhost:19222/20160918/exadataInfrastructures", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "compartmentId", "value": "", "type": "query", "description": "The compartment [OCID](/Content/General/Concepts/identifiers.htm)." }, { "name": "limit", "value": "", "type": "query", "description": "The maximum number of items to return per page." }, { "name": "page", "value": "", "type": "query", "description": "The pagination token to continue listing from." }, { "name": "sortBy", "value": "", "type": "query", "description": "The field to sort by. You can provide one sort order (`sortOrder`). Default order for TIMECREATED is descending. Default order for DISPLAYNAME is ascending. The DISPLAYNAME sort order is case sensitive.\n" }, { "name": "sortOrder", "value": "", "type": "query", "description": "The sort order to use, either ascending (`ASC`) or descending (`DESC`)." }, { "name": "lifecycleState", "value": "", "type": "query", "description": "A filter to return only resources that match the given lifecycle state exactly." }, { "name": "displayName", "value": "", "type": "query", "description": "A filter to return only resources that match the entire display name given. The match is not case sensitive." }, { "name": "excludedFields", "value": "", "type": "query", "description": "If provided, the specified fields will be excluded in the response." } ] }, "docs": "Lists the Exadata infrastructure resources in the specified compartment. Applies to Exadata Cloud@Customer instances only.\nTo list the Exadata Cloud Service infrastructure resources in a compartment, use the [ListCloudExadataInfrastructures](#/en/database/latest/CloudExadataInfrastructure/ListCloudExadataInfrastructures) operation.\n" }, { "info": { "name": "CreateExadataInfrastructure", "type": "http" }, "http": { "method": "POST", "url": "http://localhost:19222/20160918/exadataInfrastructures", "headers": [ { "name": "opc-retry-token", "value": "" }, { "name": "opc-request-id", "value": "" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Creates an Exadata infrastructure resource. Applies to Exadata Cloud@Customer instances only.\nTo create an Exadata Cloud Service infrastructure resource, use the [CreateCloudExadataInfrastructure](#/en/database/latest/CloudExadataInfrastructure/CreateCloudExadataInfrastructure) operation.\n" }, { "info": { "name": "GetExadataInfrastructure", "type": "http" }, "http": { "method": "GET", "url": "http://localhost:19222/20160918/exadataInfrastructures/:exadataInfrastructureId", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "exadataInfrastructureId", "value": "", "type": "path", "description": "The Exadata infrastructure [OCID](/Content/General/Concepts/identifiers.htm)." }, { "name": "excludedFields", "value": "", "type": "query", "description": "If provided, the specified fields will be excluded in the response." } ] }, "docs": "Gets information about the specified Exadata infrastructure. Applies to Exadata Cloud@Customer instances only.\nTo get information on an Exadata Cloud Service infrastructure resource, use the [GetCloudExadataInfrastructure](#/en/database/latest/CloudExadataInfrastructure/GetCloudExadataInfrastructure) operation.\n" }, { "info": { "name": "Updates the specified Exadata Cloud@Customer Infrastructure", "type": "http" }, "http": { "method": "PUT", "url": "http://localhost:19222/20160918/exadataInfrastructures/:exadataInfrastructureId", "headers": [ { "name": "if-match", "value": "" }, { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "exadataInfrastructureId", "value": "", "type": "path", "description": "The Exadata infrastructure [OCID](/Content/General/Concepts/identifiers.htm)." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Updates the Exadata infrastructure resource. Applies to Exadata Cloud@Customer instances only.\nTo update an Exadata Cloud Service infrastructure resource, use the [UpdateCloudExadataInfrastructure](#/en/database/latest/CloudExadataInfrastructure/UpdateCloudExadataInfrastructure) operation.\n" }, { "info": { "name": "Deletes the specified Exadata infrastructure.", "type": "http" }, "http": { "method": "DELETE", "url": "http://localhost:19222/20160918/exadataInfrastructures/:exadataInfrastructureId", "headers": [ { "name": "if-match", "value": "" }, { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "exadataInfrastructureId", "value": "", "type": "path", "description": "The Exadata infrastructure [OCID](/Content/General/Concepts/identifiers.htm)." } ] }, "docs": "Deletes the Exadata Cloud@Customer infrastructure.\n" }, { "info": { "name": "Activate ExadataInfrastructure", "type": "http" }, "http": { "method": "POST", "url": "http://localhost:19222/20160918/exadataInfrastructures/:exadataInfrastructureId/actions/activate", "headers": [ { "name": "opc-request-id", "value": "" }, { "name": "opc-retry-token", "value": "" } ], "params": [ { "name": "exadataInfrastructureId", "value": "", "type": "path", "description": "The Exadata infrastructure [OCID](/Content/General/Concepts/identifiers.htm)." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Activates the specified Exadata infrastructure resource. Applies to Exadata Cloud@Customer instances only.\n" }, { "info": { "name": "Makes the storage capacity from additional storage servers available for VM Cluster consumption. Applies to Exadata Cloud@Customer instances only.", "type": "http" }, "http": { "method": "POST", "url": "http://localhost:19222/20160918/exadataInfrastructures/:exadataInfrastructureId/actions/addStorageCapacity", "headers": [ { "name": "if-match", "value": "" }, { "name": "opc-request-id", "value": "" }, { "name": "opc-retry-token", "value": "" } ], "params": [ { "name": "exadataInfrastructureId", "value": "", "type": "path", "description": "The Exadata infrastructure [OCID](/Content/General/Concepts/identifiers.htm)." } ] }, "docs": "Makes the storage capacity from additional storage servers available for VM Cluster consumption. Applies to Exadata Cloud@Customer instances only.\n" }, { "info": { "name": "ChangeExadataInfrastructureCompartment", "type": "http" }, "http": { "method": "POST", "url": "http://localhost:19222/20160918/exadataInfrastructures/:exadataInfrastructureId/actions/changeCompartment", "headers": [ { "name": "opc-retry-token", "value": "" }, { "name": "opc-request-id", "value": "" }, { "name": "if-match", "value": "" } ], "params": [ { "name": "exadataInfrastructureId", "value": "", "type": "path", "description": "The Exadata infrastructure [OCID](/Content/General/Concepts/identifiers.htm)." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Moves an Exadata infrastructure resource and its dependent resources to another compartment. Applies to Exadata Cloud@Customer instances only.\nTo move an Exadata Cloud Service infrastructure resource to another compartment, use the [ChangeCloudExadataInfrastructureCompartment](#/en/database/latest/CloudExadataInfrastructure/ChangeCloudExadataInfrastructureCompartment) operation.\n" }, { "info": { "name": "Downloads the configuration file for the specified Exadata infrastructure.", "type": "http" }, "http": { "method": "POST", "url": "http://localhost:19222/20160918/exadataInfrastructures/:exadataInfrastructureId/actions/downloadConfigFile", "headers": [ { "name": "opc-request-id", "value": "" }, { "name": "opc-retry-token", "value": "" } ], "params": [ { "name": "exadataInfrastructureId", "value": "", "type": "path", "description": "The Exadata infrastructure [OCID](/Content/General/Concepts/identifiers.htm)." } ] }, "docs": "Downloads the configuration file for the specified Exadata Cloud@Customer infrastructure.\n" }, { "info": { "name": "GetExadataInfrastructureUnAllocatedResources", "type": "http" }, "http": { "method": "GET", "url": "http://localhost:19222/20160918/exadataInfrastructures/:exadataInfrastructureId/unAllocatedResources", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "exadataInfrastructureId", "value": "", "type": "path", "description": "The Exadata infrastructure [OCID](/Content/General/Concepts/identifiers.htm)." }, { "name": "dbServers", "value": "", "type": "query", "description": "The list of [OCIDs](/Content/General/Concepts/identifiers.htm) of the Db servers." } ] }, "docs": "Gets un allocated resources information for the specified Exadata infrastructure. Applies to Exadata Cloud@Customer instances only.\n" }, { "info": { "name": "ListVmClusterNetworks", "type": "http" }, "http": { "method": "GET", "url": "http://localhost:19222/20160918/exadataInfrastructures/:exadataInfrastructureId/vmClusterNetworks", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "exadataInfrastructureId", "value": "", "type": "path", "description": "The Exadata infrastructure [OCID](/Content/General/Concepts/identifiers.htm)." }, { "name": "compartmentId", "value": "", "type": "query", "description": "The compartment [OCID](/Content/General/Concepts/identifiers.htm)." }, { "name": "limit", "value": "", "type": "query", "description": "The maximum number of items to return per page." }, { "name": "page", "value": "", "type": "query", "description": "The pagination token to continue listing from." }, { "name": "sortBy", "value": "", "type": "query", "description": "The field to sort by. You can provide one sort order (`sortOrder`). Default order for TIMECREATED is descending. Default order for DISPLAYNAME is ascending. The DISPLAYNAME sort order is case sensitive.\n" }, { "name": "sortOrder", "value": "", "type": "query", "description": "The sort order to use, either ascending (`ASC`) or descending (`DESC`)." }, { "name": "lifecycleState", "value": "", "type": "query", "description": "A filter to return only resources that match the given lifecycle state exactly." }, { "name": "displayName", "value": "", "type": "query", "description": "A filter to return only resources that match the entire display name given. The match is not case sensitive." } ] }, "docs": "Gets a list of the VM cluster networks in the specified compartment. Applies to Exadata Cloud@Customer instances only.\n" }, { "info": { "name": "CreateVmClusterNetwork", "type": "http" }, "http": { "method": "POST", "url": "http://localhost:19222/20160918/exadataInfrastructures/:exadataInfrastructureId/vmClusterNetworks", "headers": [ { "name": "opc-retry-token", "value": "" }, { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "exadataInfrastructureId", "value": "", "type": "path", "description": "The Exadata infrastructure [OCID](/Content/General/Concepts/identifiers.htm)." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Creates the VM cluster network. Applies to Exadata Cloud@Customer instances only.\nTo create a cloud VM cluster in an Exadata Cloud Service instance, use the [CreateCloudVmCluster ](#/en/database/latest/CloudVmCluster/CreateCloudVmCluster) operation.\n" }, { "info": { "name": "Generates a recommended VM cluster network configuration.", "type": "http" }, "http": { "method": "POST", "url": "http://localhost:19222/20160918/exadataInfrastructures/:exadataInfrastructureId/vmClusterNetworks/actions/generateRecommendedNetwork", "headers": [ { "name": "opc-request-id", "value": "" }, { "name": "opc-retry-token", "value": "" } ], "params": [ { "name": "exadataInfrastructureId", "value": "", "type": "path", "description": "The Exadata infrastructure [OCID](/Content/General/Concepts/identifiers.htm)." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Generates a recommended Cloud@Customer VM cluster network configuration.\n" }, { "info": { "name": "GetVmClusterNetwork", "type": "http" }, "http": { "method": "GET", "url": "http://localhost:19222/20160918/exadataInfrastructures/:exadataInfrastructureId/vmClusterNetworks/:vmClusterNetworkId", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "exadataInfrastructureId", "value": "", "type": "path", "description": "The Exadata infrastructure [OCID](/Content/General/Concepts/identifiers.htm)." }, { "name": "vmClusterNetworkId", "value": "", "type": "path", "description": "The VM cluster network [OCID](/Content/General/Concepts/identifiers.htm)." } ] }, "docs": "Gets information about the specified VM cluster network. Applies to Exadata Cloud@Customer instances only.\nTo get information about a cloud VM cluster in an Exadata Cloud Service instance, use the [GetCloudVmCluster ](#/en/database/latest/CloudVmCluster/GetCloudVmCluster) operation.\n" }, { "info": { "name": "Updates the specified VM cluster network.", "type": "http" }, "http": { "method": "PUT", "url": "http://localhost:19222/20160918/exadataInfrastructures/:exadataInfrastructureId/vmClusterNetworks/:vmClusterNetworkId", "headers": [ { "name": "if-match", "value": "" }, { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "exadataInfrastructureId", "value": "", "type": "path", "description": "The Exadata infrastructure [OCID](/Content/General/Concepts/identifiers.htm)." }, { "name": "vmClusterNetworkId", "value": "", "type": "path", "description": "The VM cluster network [OCID](/Content/General/Concepts/identifiers.htm)." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Updates the specified VM cluster network. Applies to Exadata Cloud@Customer instances only.\nTo update a cloud VM cluster in an Exadata Cloud Service instance, use the [UpdateCloudVmCluster ](#/en/database/latest/CloudVmCluster/UpdateCloudVmCluster) operation.\n" }, { "info": { "name": "Deletes the specified VM cluster network.", "type": "http" }, "http": { "method": "DELETE", "url": "http://localhost:19222/20160918/exadataInfrastructures/:exadataInfrastructureId/vmClusterNetworks/:vmClusterNetworkId", "headers": [ { "name": "if-match", "value": "" }, { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "exadataInfrastructureId", "value": "", "type": "path", "description": "The Exadata infrastructure [OCID](/Content/General/Concepts/identifiers.htm)." }, { "name": "vmClusterNetworkId", "value": "", "type": "path", "description": "The VM cluster network [OCID](/Content/General/Concepts/identifiers.htm)." } ] }, "docs": "Deletes the specified VM cluster network. Applies to Exadata Cloud@Customer instances only.\nTo delete a cloud VM cluster in an Exadata Cloud Service instance, use the [DeleteCloudVmCluster ](#/en/database/latest/CloudVmCluster/DeleteCloudVmCluster) operation.\n" }, { "info": { "name": "Downloads the configuration file for the specified VM Cluster Network.", "type": "http" }, "http": { "method": "POST", "url": "http://localhost:19222/20160918/exadataInfrastructures/:exadataInfrastructureId/vmClusterNetworks/:vmClusterNetworkId/actions/downloadConfigFile", "headers": [ { "name": "opc-request-id", "value": "" }, { "name": "opc-retry-token", "value": "" } ], "params": [ { "name": "exadataInfrastructureId", "value": "", "type": "path", "description": "The Exadata infrastructure [OCID](/Content/General/Concepts/identifiers.htm)." }, { "name": "vmClusterNetworkId", "value": "", "type": "path", "description": "The VM cluster network [OCID](/Content/General/Concepts/identifiers.htm)." } ] }, "docs": "Downloads the configuration file for the specified VM cluster network. Applies to Exadata Cloud@Customer instances only.\n" }, { "info": { "name": "Adds or removes Db server network nodes in the VM cluster network.", "type": "http" }, "http": { "method": "POST", "url": "http://localhost:19222/20160918/exadataInfrastructures/:exadataInfrastructureId/vmClusterNetworks/:vmClusterNetworkId/actions/resize", "headers": [ { "name": "opc-request-id", "value": "" }, { "name": "opc-retry-token", "value": "" }, { "name": "if-match", "value": "" } ], "params": [ { "name": "exadataInfrastructureId", "value": "", "type": "path", "description": "The Exadata infrastructure [OCID](/Content/General/Concepts/identifiers.htm)." }, { "name": "vmClusterNetworkId", "value": "", "type": "path", "description": "The VM cluster network [OCID](/Content/General/Concepts/identifiers.htm)." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Adds or removes Db server network nodes to extend or shrink the existing VM cluster network. Applies to Exadata\nCloud@Customer instances only.\n" }, { "info": { "name": "Validates the specified VM cluster network.", "type": "http" }, "http": { "method": "POST", "url": "http://localhost:19222/20160918/exadataInfrastructures/:exadataInfrastructureId/vmClusterNetworks/:vmClusterNetworkId/actions/validate", "headers": [ { "name": "opc-request-id", "value": "" }, { "name": "opc-retry-token", "value": "" } ], "params": [ { "name": "exadataInfrastructureId", "value": "", "type": "path", "description": "The Exadata infrastructure [OCID](/Content/General/Concepts/identifiers.htm)." }, { "name": "vmClusterNetworkId", "value": "", "type": "path", "description": "The VM cluster network [OCID](/Content/General/Concepts/identifiers.htm)." } ] }, "docs": "Validates the specified VM cluster network. Applies to Exadata Cloud@Customer instances only.\n" }, { "info": { "name": "ListExadbVmClusters", "type": "http" }, "http": { "method": "GET", "url": "http://localhost:19222/20160918/exadbVmClusters", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "compartmentId", "value": "", "type": "query", "description": "The compartment [OCID](/Content/General/Concepts/identifiers.htm)." }, { "name": "limit", "value": "", "type": "query", "description": "The maximum number of items to return per page." }, { "name": "page", "value": "", "type": "query", "description": "The pagination token to continue listing from." }, { "name": "sortBy", "value": "", "type": "query", "description": "The field to sort by. You can provide one sort order (`sortOrder`). Default order for TIMECREATED is descending. Default order for DISPLAYNAME is ascending. The DISPLAYNAME sort order is case sensitive.\n" }, { "name": "sortOrder", "value": "", "type": "query", "description": "The sort order to use, either ascending (`ASC`) or descending (`DESC`)." }, { "name": "lifecycleState", "value": "", "type": "query", "description": "A filter to return only Exadata VM clusters on Exascale Infrastructure that match the given lifecycle state exactly.\n" }, { "name": "exascaleDbStorageVaultId", "value": "", "type": "query", "description": "A filter to return only Exadata VM clusters on Exascale Infrastructure that match the given Exascale Database Storage Vault ID.\n" }, { "name": "clusterPlacementGroupId", "value": "", "type": "query", "description": "A filter to return only resources that match the given cluster placement group ID exactly." }, { "name": "displayName", "value": "", "type": "query", "description": "A filter to return only resources that match the entire display name given. The match is not case sensitive." } ] }, "docs": "Gets a list of the Exadata VM clusters on Exascale Infrastructure in the specified compartment. Applies to Exadata Database Service on Exascale Infrastructure only.\n" }, { "info": { "name": "CreateExadbVmCluster", "type": "http" }, "http": { "method": "POST", "url": "http://localhost:19222/20160918/exadbVmClusters", "headers": [ { "name": "opc-retry-token", "value": "" }, { "name": "opc-request-id", "value": "" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Creates an Exadata VM cluster on Exascale Infrastructure\n" }, { "info": { "name": "GetExadbVmCluster", "type": "http" }, "http": { "method": "GET", "url": "http://localhost:19222/20160918/exadbVmClusters/:exadbVmClusterId", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "exadbVmClusterId", "value": "", "type": "path", "description": "The Exadata VM cluster [OCID](/Content/General/Concepts/identifiers.htm) on Exascale Infrastructure." } ] }, "docs": "Gets information about the specified Exadata VM cluster on Exascale Infrastructure. Applies to Exadata Database Service on Exascale Infrastructure only.\n" }, { "info": { "name": "Updates the specified Exadata VM cluster on Exascale Infrastructure.", "type": "http" }, "http": { "method": "PUT", "url": "http://localhost:19222/20160918/exadbVmClusters/:exadbVmClusterId", "headers": [ { "name": "if-match", "value": "" }, { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "exadbVmClusterId", "value": "", "type": "path", "description": "The Exadata VM cluster [OCID](/Content/General/Concepts/identifiers.htm) on Exascale Infrastructure." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Updates the specified Exadata VM cluster on Exascale Infrastructure. Applies to Exadata Database Service on Exascale Infrastructure only.\n" }, { "info": { "name": "Deletes the specified Exadata VM cluster on Exascale Infrastructure.", "type": "http" }, "http": { "method": "DELETE", "url": "http://localhost:19222/20160918/exadbVmClusters/:exadbVmClusterId", "headers": [ { "name": "if-match", "value": "" }, { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "exadbVmClusterId", "value": "", "type": "path", "description": "The Exadata VM cluster [OCID](/Content/General/Concepts/identifiers.htm) on Exascale Infrastructure." } ] }, "docs": "Deletes the specified Exadata VM cluster on Exascale Infrastructure. Applies to Exadata Database Service on Exascale Infrastructure only.\n" }, { "info": { "name": "AddDbnodeSnapshotsForExadbVmCluster", "type": "http" }, "http": { "method": "POST", "url": "http://localhost:19222/20160918/exadbVmClusters/:exadbVmClusterId/actions/addDbNodeSnapshots", "headers": [ { "name": "opc-retry-token", "value": "" }, { "name": "opc-request-id", "value": "" }, { "name": "if-match", "value": "" } ], "params": [ { "name": "exadbVmClusterId", "value": "", "type": "path", "description": "The Exadata VM cluster [OCID](/Content/General/Concepts/identifiers.htm) on Exascale Infrastructure." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Add a database node snapshots to the Exadb VM cluster..\n" }, { "info": { "name": "ChangeExadbVmClusterCompartment", "type": "http" }, "http": { "method": "POST", "url": "http://localhost:19222/20160918/exadbVmClusters/:exadbVmClusterId/actions/changeCompartment", "headers": [ { "name": "opc-retry-token", "value": "" }, { "name": "opc-request-id", "value": "" }, { "name": "if-match", "value": "" } ], "params": [ { "name": "exadbVmClusterId", "value": "", "type": "path", "description": "The Exadata VM cluster [OCID](/Content/General/Concepts/identifiers.htm) on Exascale Infrastructure." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Moves a Exadata VM cluster on Exascale Infrastructure and its dependent resources to another compartment. Applies to Exadata Database Service on Exascale Infrastructure only.\n" }, { "info": { "name": "ChangeExadbVmClusterSubscription", "type": "http" }, "http": { "method": "POST", "url": "http://localhost:19222/20160918/exadbVmClusters/:exadbVmClusterId/actions/changeSubscription", "headers": [ { "name": "opc-retry-token", "value": "" }, { "name": "opc-request-id", "value": "" }, { "name": "if-match", "value": "" } ], "params": [ { "name": "exadbVmClusterId", "value": "", "type": "path", "description": "The Exadata VM cluster [OCID](/Content/General/Concepts/identifiers.htm) on Exascale Infrastructure." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Associate a Exadata VM cluster on Exascale Infrastructure with a different subscription.\n" }, { "info": { "name": "RemoveVirtualMachineFromExadbVmCluster", "type": "http" }, "http": { "method": "POST", "url": "http://localhost:19222/20160918/exadbVmClusters/:exadbVmClusterId/actions/removeVirtualMachine", "headers": [ { "name": "opc-retry-token", "value": "" }, { "name": "opc-request-id", "value": "" }, { "name": "if-match", "value": "" } ], "params": [ { "name": "exadbVmClusterId", "value": "", "type": "path", "description": "The Exadata VM cluster [OCID](/Content/General/Concepts/identifiers.htm) on Exascale Infrastructure." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Remove Virtual Machines from the Exadata VM cluster on Exascale Infrastructure. Applies to Exadata Cloud instances only.\n" }, { "info": { "name": "ListExadbVmClusterUpdateHistoryEntries", "type": "http" }, "http": { "method": "GET", "url": "http://localhost:19222/20160918/exadbVmClusters/:exadbVmClusterId/updateHistoryEntries", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "exadbVmClusterId", "value": "", "type": "path", "description": "The Exadata VM cluster [OCID](/Content/General/Concepts/identifiers.htm) on Exascale Infrastructure." }, { "name": "updateType", "value": "", "type": "query", "description": "A filter to return only resources that match the given update type exactly." }, { "name": "limit", "value": "", "type": "query", "description": "The maximum number of items to return per page." }, { "name": "page", "value": "", "type": "query", "description": "The pagination token to continue listing from." } ] }, "docs": "Gets the history of the maintenance update actions performed on the specified Exadata VM cluster on Exascale Infrastructure.\n" }, { "info": { "name": "GetExadbVmClusterUpdateHistoryEntry", "type": "http" }, "http": { "method": "GET", "url": "http://localhost:19222/20160918/exadbVmClusters/:exadbVmClusterId/updateHistoryEntries/:updateHistoryEntryId", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "exadbVmClusterId", "value": "", "type": "path", "description": "The Exadata VM cluster [OCID](/Content/General/Concepts/identifiers.htm) on Exascale Infrastructure." }, { "name": "updateHistoryEntryId", "value": "", "type": "path", "description": "The [OCID](/Content/General/Concepts/identifiers.htm) of the maintenance update history entry." } ] }, "docs": "Gets the maintenance update history details for the specified update history entry.\n" }, { "info": { "name": "ListExadbVmClusterUpdates", "type": "http" }, "http": { "method": "GET", "url": "http://localhost:19222/20160918/exadbVmClusters/:exadbVmClusterId/updates", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "exadbVmClusterId", "value": "", "type": "path", "description": "The Exadata VM cluster [OCID](/Content/General/Concepts/identifiers.htm) on Exascale Infrastructure." }, { "name": "updateType", "value": "", "type": "query", "description": "A filter to return only resources that match the given update type exactly." }, { "name": "version", "value": "", "type": "query", "description": "A filter to return only resources that match the given update version exactly." }, { "name": "limit", "value": "", "type": "query", "description": "The maximum number of items to return per page." }, { "name": "page", "value": "", "type": "query", "description": "The pagination token to continue listing from." } ] }, "docs": "Lists the maintenance updates that can be applied to the specified Exadata VM cluster on Exascale Infrastructure.\n" }, { "info": { "name": "GetExadbVmClusterUpdate", "type": "http" }, "http": { "method": "GET", "url": "http://localhost:19222/20160918/exadbVmClusters/:exadbVmClusterId/updates/:updateId", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "exadbVmClusterId", "value": "", "type": "path", "description": "The Exadata VM cluster [OCID](/Content/General/Concepts/identifiers.htm) on Exascale Infrastructure." }, { "name": "updateId", "value": "", "type": "path", "description": "The [OCID](/Content/General/Concepts/identifiers.htm) of the maintenance update." } ] }, "docs": "Gets information about a specified maintenance update package for a Exadata VM cluster on Exascale Infrastructure.\n" }, { "info": { "name": "ListExascaleDbStorageVaults", "type": "http" }, "http": { "method": "GET", "url": "http://localhost:19222/20160918/exascaleDbStorageVaults", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "compartmentId", "value": "", "type": "query", "description": "The compartment [OCID](/Content/General/Concepts/identifiers.htm)." }, { "name": "limit", "value": "", "type": "query", "description": "The maximum number of items to return per page." }, { "name": "page", "value": "", "type": "query", "description": "The pagination token to continue listing from." }, { "name": "sortBy", "value": "", "type": "query", "description": "The field to sort by. You can provide one sort order (`sortOrder`). Default order for TIMECREATED is descending. Default order for DISPLAYNAME is ascending. The DISPLAYNAME sort order is case sensitive.\n" }, { "name": "sortOrder", "value": "", "type": "query", "description": "The sort order to use, either ascending (`ASC`) or descending (`DESC`)." }, { "name": "lifecycleState", "value": "", "type": "query", "description": "A filter to return only Exadata Database Storage Vaults that match the given lifecycle state exactly." }, { "name": "clusterPlacementGroupId", "value": "", "type": "query", "description": "A filter to return only resources that match the given cluster placement group ID exactly." }, { "name": "attachedShapeAttributesNotEqualTo", "value": "", "type": "query", "description": "A filter to return only Exadata Database Storage Vaults which do not match the given attachedShapeAttributes" }, { "name": "attachedShapeAttributes", "value": "", "type": "query", "description": "A filter to return only Exadata Database Storage Vaults which match the given attachedShapeAttributes or has null attachedShapeAttributes" }, { "name": "vmClusterCountLessThanOrEqualTo", "value": "", "type": "query", "description": "A filter to return only Exadata Database Storage Vaults with associated Exadata VM Clusters less than or equal to the given count" }, { "name": "vmClusterCountGreaterThanOrEqualTo", "value": "", "type": "query", "description": "A filter to return only Exadata Database Storage Vaults with associated Exadata VM Clusters greater than or equal to the given count" }, { "name": "displayName", "value": "", "type": "query", "description": "A filter to return only resources that match the entire display name given. The match is not case sensitive." }, { "name": "exadataInfrastructureId", "value": "", "type": "query", "description": "A filter to return only list of Vaults that are linked to the exadata infrastructure Id." } ] }, "docs": "Gets a list of the Exadata Database Storage Vaults in the specified compartment.\n" }, { "info": { "name": "CreateExascaleDbStorageVault", "type": "http" }, "http": { "method": "POST", "url": "http://localhost:19222/20160918/exascaleDbStorageVaults", "headers": [ { "name": "opc-retry-token", "value": "" }, { "name": "opc-request-id", "value": "" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Creates an Exadata Database Storage Vault\n" }, { "info": { "name": "GetExascaleDbStorageVault", "type": "http" }, "http": { "method": "GET", "url": "http://localhost:19222/20160918/exascaleDbStorageVaults/:exascaleDbStorageVaultId", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "exascaleDbStorageVaultId", "value": "", "type": "path", "description": "The Exadata Database Storage Vault [OCID](/Content/General/Concepts/identifiers.htm)." } ] }, "docs": "Gets information about the specified Exadata Database Storage Vaults in the specified compartment.\n" }, { "info": { "name": "Updates the specified Exadata Database Storage Vault.", "type": "http" }, "http": { "method": "PUT", "url": "http://localhost:19222/20160918/exascaleDbStorageVaults/:exascaleDbStorageVaultId", "headers": [ { "name": "if-match", "value": "" }, { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "exascaleDbStorageVaultId", "value": "", "type": "path", "description": "The Exadata Database Storage Vault [OCID](/Content/General/Concepts/identifiers.htm)." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Updates the specified Exadata Database Storage Vault.\n" }, { "info": { "name": "Deletes the specified Exadata Database Storage Vault.", "type": "http" }, "http": { "method": "DELETE", "url": "http://localhost:19222/20160918/exascaleDbStorageVaults/:exascaleDbStorageVaultId", "headers": [ { "name": "if-match", "value": "" }, { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "exascaleDbStorageVaultId", "value": "", "type": "path", "description": "The Exadata Database Storage Vault [OCID](/Content/General/Concepts/identifiers.htm)." } ] }, "docs": "Deletes the specified Exadata Database Storage Vault.\n" }, { "info": { "name": "ChangeExascaleDbStorageVaultCompartment", "type": "http" }, "http": { "method": "POST", "url": "http://localhost:19222/20160918/exascaleDbStorageVaults/:exascaleDbStorageVaultId/actions/changeCompartment", "headers": [ { "name": "opc-retry-token", "value": "" }, { "name": "opc-request-id", "value": "" }, { "name": "if-match", "value": "" } ], "params": [ { "name": "exascaleDbStorageVaultId", "value": "", "type": "path", "description": "The Exadata Database Storage Vault [OCID](/Content/General/Concepts/identifiers.htm)." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Moves a Exadata Database Storage Vault to another compartment.\n" }, { "info": { "name": "ChangeExascaleDbStorageVaultSubscription", "type": "http" }, "http": { "method": "POST", "url": "http://localhost:19222/20160918/exascaleDbStorageVaults/:exascaleDbStorageVaultId/actions/changeSubscription", "headers": [ { "name": "opc-retry-token", "value": "" }, { "name": "opc-request-id", "value": "" }, { "name": "if-match", "value": "" } ], "params": [ { "name": "exascaleDbStorageVaultId", "value": "", "type": "path", "description": "The Exadata Database Storage Vault [OCID](/Content/General/Concepts/identifiers.htm)." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Associate a Exadata Database Storage Vault with a different subscription.\n" }, { "info": { "name": "ListExecutionActions", "type": "http" }, "http": { "method": "GET", "url": "http://localhost:19222/20160918/executionActions", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "compartmentId", "value": "", "type": "query", "description": "The compartment [OCID](/Content/General/Concepts/identifiers.htm)." }, { "name": "limit", "value": "", "type": "query", "description": "The maximum number of items to return per page." }, { "name": "page", "value": "", "type": "query", "description": "The pagination token to continue listing from." }, { "name": "sortBy", "value": "", "type": "query", "description": "The field to sort by. You can provide one sort order (`sortOrder`). Default order for TIMECREATED is descending. Default order for DISPLAYNAME is ascending. The DISPLAYNAME sort order is case sensitive.\n" }, { "name": "sortOrder", "value": "", "type": "query", "description": "The sort order to use, either ascending (`ASC`) or descending (`DESC`)." }, { "name": "lifecycleState", "value": "", "type": "query", "description": "A filter to return only resources that match the given lifecycle state exactly." }, { "name": "executionWindowId", "value": "", "type": "query", "description": "A filter to return only resources that match the given execution wondow id." }, { "name": "displayName", "value": "", "type": "query", "description": "A filter to return only resources that match the entire display name given. The match is not case sensitive." } ] }, "docs": "Lists the execution action resources in the specified compartment.\n" }, { "info": { "name": "CreateExecutionAction", "type": "http" }, "http": { "method": "POST", "url": "http://localhost:19222/20160918/executionActions", "headers": [ { "name": "opc-retry-token", "value": "" }, { "name": "opc-request-id", "value": "" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Creates an execution action resource.\n" }, { "info": { "name": "Get ExecutionAction", "type": "http" }, "http": { "method": "GET", "url": "http://localhost:19222/20160918/executionActions/:executionActionId", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "executionActionId", "value": "", "type": "path", "description": "The execution action [OCID](/Content/General/Concepts/identifiers.htm)." } ] }, "docs": "Gets information about the specified execution action.\n" }, { "info": { "name": "Updates the specified execution action", "type": "http" }, "http": { "method": "PUT", "url": "http://localhost:19222/20160918/executionActions/:executionActionId", "headers": [ { "name": "if-match", "value": "" }, { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "executionActionId", "value": "", "type": "path", "description": "The execution action [OCID](/Content/General/Concepts/identifiers.htm)." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Updates the execution action resource.\n" }, { "info": { "name": "Delete an execution action.", "type": "http" }, "http": { "method": "DELETE", "url": "http://localhost:19222/20160918/executionActions/:executionActionId", "headers": [ { "name": "if-match", "value": "" }, { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "executionActionId", "value": "", "type": "path", "description": "The execution action [OCID](/Content/General/Concepts/identifiers.htm)." } ] }, "docs": "Deletes the execution action.\n" }, { "info": { "name": "Moves an execution action member to this execution action resource from another.", "type": "http" }, "http": { "method": "POST", "url": "http://localhost:19222/20160918/executionActions/:executionActionId/actions/moveActionMember", "headers": [ { "name": "if-match", "value": "" }, { "name": "opc-request-id", "value": "" }, { "name": "opc-retry-token", "value": "" } ], "params": [ { "name": "executionActionId", "value": "", "type": "path", "description": "The execution action [OCID](/Content/General/Concepts/identifiers.htm)." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Moves an execution action member to this execution action resource from another.\n" }, { "info": { "name": "ListExecutionWindows", "type": "http" }, "http": { "method": "GET", "url": "http://localhost:19222/20160918/executionWindows", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "compartmentId", "value": "", "type": "query", "description": "The compartment [OCID](/Content/General/Concepts/identifiers.htm)." }, { "name": "limit", "value": "", "type": "query", "description": "The maximum number of items to return per page." }, { "name": "page", "value": "", "type": "query", "description": "The pagination token to continue listing from." }, { "name": "sortBy", "value": "", "type": "query", "description": "The field to sort by. You can provide one sort order (`sortOrder`). Default order for TIMECREATED is descending. Default order for DISPLAYNAME is ascending. The DISPLAYNAME sort order is case sensitive.\n" }, { "name": "executionResourceId", "value": "", "type": "query", "description": "A filter to return only resources that match the given resource id exactly." }, { "name": "sortOrder", "value": "", "type": "query", "description": "The sort order to use, either ascending (`ASC`) or descending (`DESC`)." }, { "name": "lifecycleState", "value": "", "type": "query", "description": "A filter to return only resources that match the given lifecycle state exactly." }, { "name": "displayName", "value": "", "type": "query", "description": "A filter to return only resources that match the entire display name given. The match is not case sensitive." } ] }, "docs": "Lists the execution window resources in the specified compartment.\n" }, { "info": { "name": "CreateExecutionWindow", "type": "http" }, "http": { "method": "POST", "url": "http://localhost:19222/20160918/executionWindows", "headers": [ { "name": "opc-retry-token", "value": "" }, { "name": "opc-request-id", "value": "" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Creates an execution window resource.\n" }, { "info": { "name": "GetExecutionWindow", "type": "http" }, "http": { "method": "GET", "url": "http://localhost:19222/20160918/executionWindows/:executionWindowId", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "executionWindowId", "value": "", "type": "path", "description": "The execution window [OCID](/Content/General/Concepts/identifiers.htm)." } ] }, "docs": "Gets information about the specified execution window.\n" }, { "info": { "name": "Updates the specified execution window", "type": "http" }, "http": { "method": "PUT", "url": "http://localhost:19222/20160918/executionWindows/:executionWindowId", "headers": [ { "name": "if-match", "value": "" }, { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "executionWindowId", "value": "", "type": "path", "description": "The execution window [OCID](/Content/General/Concepts/identifiers.htm)." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Updates the execution window resource.\n" }, { "info": { "name": "Delete an execution window.", "type": "http" }, "http": { "method": "DELETE", "url": "http://localhost:19222/20160918/executionWindows/:executionWindowId", "headers": [ { "name": "if-match", "value": "" }, { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "executionWindowId", "value": "", "type": "path", "description": "The execution window [OCID](/Content/General/Concepts/identifiers.htm)." } ] }, "docs": "Deletes the execution window.\n" }, { "info": { "name": "Reorders the execution actions under this execution window resource.", "type": "http" }, "http": { "method": "POST", "url": "http://localhost:19222/20160918/executionWindows/:executionWindowId/actions/reorder", "headers": [ { "name": "if-match", "value": "" }, { "name": "opc-request-id", "value": "" }, { "name": "opc-retry-token", "value": "" } ], "params": [ { "name": "executionWindowId", "value": "", "type": "path", "description": "The execution window [OCID](/Content/General/Concepts/identifiers.htm)." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Reorders the execution actions under this execution window resource.\n" }, { "info": { "name": "CreateExternalBackupJob", "type": "http" }, "http": { "method": "POST", "url": "http://localhost:19222/20160918/externalBackupJobs", "headers": [ { "name": "opc-retry-token", "value": "" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Creates a new backup resource and returns the information the caller needs to back up an on-premises Oracle Database to Oracle Cloud Infrastructure.\n\n**Note:** This API is used by an Oracle Cloud Infrastructure Python script that is packaged with the Oracle Cloud Infrastructure CLI. Oracle recommends that you use the script instead using the API directly. See [Migrating an On-Premises Database to Oracle Cloud Infrastructure by Creating a Backup in the Cloud](/Content/Database/Tasks/mig-onprembac" }, { "info": { "name": "GetExternalBackupJob", "type": "http" }, "http": { "method": "GET", "url": "http://localhost:19222/20160918/externalBackupJobs/:backupId", "params": [ { "name": "backupId", "value": "", "type": "path", "description": "The backup [OCID](/Content/General/Concepts/identifiers.htm)." } ] }, "docs": "Gets information about the specified external backup job.\n\n**Note:** This API is used by an Oracle Cloud Infrastructure Python script that is packaged with the Oracle Cloud Infrastructure CLI. Oracle recommends that you use the script instead using the API directly. See [Migrating an On-Premises Database to Oracle Cloud Infrastructure by Creating a Backup in the Cloud](/Content/Database/Tasks/mig-onprembackup.htm) for more information.\n" }, { "info": { "name": "CompleteExternalBackupJob", "type": "http" }, "http": { "method": "POST", "url": "http://localhost:19222/20160918/externalBackupJobs/:backupId/actions/complete", "headers": [ { "name": "if-match", "value": "" }, { "name": "opc-retry-token", "value": "" } ], "params": [ { "name": "backupId", "value": "", "type": "path", "description": "The backup [OCID](/Content/General/Concepts/identifiers.htm)." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Changes the status of the standalone backup resource to `ACTIVE` after the backup is created from the on-premises database and placed in Oracle Cloud Infrastructure Object Storage.\n\n**Note:** This API is used by an Oracle Cloud Infrastructure Python script that is packaged with the Oracle Cloud Infrastructure CLI. Oracle recommends that you use the script instead using the API directly. See [Migrating an On-Premises Database to Oracle Cloud Infrastructure by Creating a Backup in the Cloud](/Cont" }, { "info": { "name": "ListExternalContainerDatabases", "type": "http" }, "http": { "method": "GET", "url": "http://localhost:19222/20160918/externalcontainerdatabases", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "compartmentId", "value": "", "type": "query", "description": "The compartment [OCID](/Content/General/Concepts/identifiers.htm)." }, { "name": "limit", "value": "", "type": "query", "description": "The maximum number of items to return per page." }, { "name": "page", "value": "", "type": "query", "description": "The pagination token to continue listing from." }, { "name": "sortBy", "value": "", "type": "query", "description": "The field to sort by. You can provide one sort order (`sortOrder`).\nDefault order for TIMECREATED is descending.\nDefault order for DISPLAYNAME is ascending.\nThe DISPLAYNAME sort order is case sensitive.\n" }, { "name": "sortOrder", "value": "", "type": "query", "description": "The sort order to use, either ascending (`ASC`) or descending (`DESC`)." }, { "name": "lifecycleState", "value": "", "type": "query", "description": "A filter to return only resources that match the specified lifecycle state." }, { "name": "displayName", "value": "", "type": "query", "description": "A filter to return only resources that match the entire display name given. The match is not case sensitive." } ] }, "docs": "Gets a list of the external container databases in the specified compartment.\n" }, { "info": { "name": "CreateExternalContainerDatabase", "type": "http" }, "http": { "method": "POST", "url": "http://localhost:19222/20160918/externalcontainerdatabases", "headers": [ { "name": "opc-retry-token", "value": "" }, { "name": "opc-request-id", "value": "" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Creates a new external container database resource." }, { "info": { "name": "GetExternalContainerDatabase", "type": "http" }, "http": { "method": "GET", "url": "http://localhost:19222/20160918/externalcontainerdatabases/:externalContainerDatabaseId", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "externalContainerDatabaseId", "value": "", "type": "path", "description": "The ExternalContainerDatabase [OCID](/Content/General/Concepts/identifiers.htm)." } ] }, "docs": "Gets information about the specified external container database." }, { "info": { "name": "UpdateExternalContainerDatabase", "type": "http" }, "http": { "method": "PUT", "url": "http://localhost:19222/20160918/externalcontainerdatabases/:externalContainerDatabaseId", "headers": [ { "name": "if-match", "value": "" }, { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "externalContainerDatabaseId", "value": "", "type": "path", "description": "The ExternalContainerDatabase [OCID](/Content/General/Concepts/identifiers.htm)." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Updates the properties of\nan [ExternalContainerDatabase](#/en/database/latest/datatypes/CreateExternalContainerDatabaseDetails) resource,\nsuch as the display name.\n" }, { "info": { "name": "Delete the ExternalContainerDatabase", "type": "http" }, "http": { "method": "DELETE", "url": "http://localhost:19222/20160918/externalcontainerdatabases/:externalContainerDatabaseId", "headers": [ { "name": "opc-request-id", "value": "" }, { "name": "if-match", "value": "" } ], "params": [ { "name": "externalContainerDatabaseId", "value": "", "type": "path", "description": "The ExternalContainerDatabase [OCID](/Content/General/Concepts/identifiers.htm)." } ] }, "docs": "Deletes the [external container database](#/en/database/latest/datatypes/CreateExternalContainerDatabaseDetails)\nresource. Any external pluggable databases registered under this container database must be deleted in\nyour Oracle Cloud Infrastructure tenancy prior to this operation.\n" }, { "info": { "name": "ChangeExternalContainerDatabaseCompartment", "type": "http" }, "http": { "method": "POST", "url": "http://localhost:19222/20160918/externalcontainerdatabases/:externalContainerDatabaseId/actions/changeCompartment", "headers": [ { "name": "opc-retry-token", "value": "" }, { "name": "opc-request-id", "value": "" }, { "name": "if-match", "value": "" } ], "params": [ { "name": "externalContainerDatabaseId", "value": "", "type": "path", "description": "The ExternalContainerDatabase [OCID](/Content/General/Concepts/identifiers.htm)." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Move the [external container database](#/en/database/latest/datatypes/CreateExternalContainerDatabaseDetails)\nand its dependent resources to the specified compartment.\nFor more information about moving external container databases, see\n[Moving Database Resources to a Different Compartment](/Content/Database/Concepts/databaseoverview.htm#moveRes).\n" }, { "info": { "name": "Disable Database Management Service for the external container database.", "type": "http" }, "http": { "method": "POST", "url": "http://localhost:19222/20160918/externalcontainerdatabases/:externalContainerDatabaseId/actions/disableDatabaseManagement", "headers": [ { "name": "opc-retry-token", "value": "" }, { "name": "opc-request-id", "value": "" }, { "name": "if-match", "value": "" } ], "params": [ { "name": "externalContainerDatabaseId", "value": "", "type": "path", "description": "The ExternalContainerDatabase [OCID](/Content/General/Concepts/identifiers.htm)." } ] }, "docs": "Disable Database Management service for the external container database.\n" }, { "info": { "name": "Disable Stack Monitoring Service for the external container database.", "type": "http" }, "http": { "method": "POST", "url": "http://localhost:19222/20160918/externalcontainerdatabases/:externalContainerDatabaseId/actions/disableStackMonitoring", "headers": [ { "name": "opc-retry-token", "value": "" }, { "name": "opc-request-id", "value": "" }, { "name": "if-match", "value": "" } ], "params": [ { "name": "externalContainerDatabaseId", "value": "", "type": "path", "description": "The ExternalContainerDatabase [OCID](/Content/General/Concepts/identifiers.htm)." } ] }, "docs": "Disable Stack Monitoring for the external container database.\n" }, { "info": { "name": "Enable Database Management Service for the external container database.", "type": "http" }, "http": { "method": "POST", "url": "http://localhost:19222/20160918/externalcontainerdatabases/:externalContainerDatabaseId/actions/enableDatabaseManagement", "headers": [ { "name": "opc-retry-token", "value": "" }, { "name": "opc-request-id", "value": "" }, { "name": "if-match", "value": "" } ], "params": [ { "name": "externalContainerDatabaseId", "value": "", "type": "path", "description": "The ExternalContainerDatabase [OCID](/Content/General/Concepts/identifiers.htm)." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Enables Database Management Service for the external container database.\nFor more information about the Database Management Service, see\n[Database Management Service](/Content/ExternalDatabase/Concepts/databasemanagementservice.htm).\n" }, { "info": { "name": "Enable Stack Monitoring Service for the external container database.", "type": "http" }, "http": { "method": "POST", "url": "http://localhost:19222/20160918/externalcontainerdatabases/:externalContainerDatabaseId/actions/enableStackMonitoring", "headers": [ { "name": "opc-retry-token", "value": "" }, { "name": "opc-request-id", "value": "" }, { "name": "if-match", "value": "" } ], "params": [ { "name": "externalContainerDatabaseId", "value": "", "type": "path", "description": "The ExternalContainerDatabase [OCID](/Content/General/Concepts/identifiers.htm)." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Enable Stack Monitoring for the external container database.\n" }, { "info": { "name": "Scan for un-registered pluggable databases in this external container database.", "type": "http" }, "http": { "method": "POST", "url": "http://localhost:19222/20160918/externalcontainerdatabases/:externalContainerDatabaseId/actions/scanPluggableDatabases", "headers": [ { "name": "opc-request-id", "value": "" }, { "name": "opc-retry-token", "value": "" } ], "params": [ { "name": "externalContainerDatabaseId", "value": "", "type": "path", "description": "The ExternalContainerDatabase [OCID](/Content/General/Concepts/identifiers.htm)." }, { "name": "externalDatabaseConnectorId", "value": "", "type": "query", "description": "The [OCID](/Content/General/Concepts/identifiers.htm) of the\nexternal database connector resource (`ExternalDatabaseConnectorId`).\n" } ] }, "docs": "Scans for pluggable databases in the specified external container database.\nThis operation will return un-registered pluggable databases in the [GetWorkRequest](#/en/workrequests/20160918/WorkRequest/GetWorkRequest) operation.\n" }, { "info": { "name": "ListExternalDatabaseConnectors", "type": "http" }, "http": { "method": "GET", "url": "http://localhost:19222/20160918/externaldatabaseconnectors", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "compartmentId", "value": "", "type": "query", "description": "The compartment [OCID](/Content/General/Concepts/identifiers.htm)." }, { "name": "externalDatabaseId", "value": "", "type": "query", "description": "The [OCID](/Content/General/Concepts/identifiers.htm) of the external database whose connectors will be listed.\n" }, { "name": "limit", "value": "", "type": "query", "description": "The maximum number of items to return per page." }, { "name": "page", "value": "", "type": "query", "description": "The pagination token to continue listing from." }, { "name": "sortBy", "value": "", "type": "query", "description": "The field to sort by. You can provide one sort order (`sortOrder`).\nDefault order for TIMECREATED is descending.\nDefault order for DISPLAYNAME is ascending.\nThe DISPLAYNAME sort order is case sensitive.\n" }, { "name": "sortOrder", "value": "", "type": "query", "description": "The sort order to use, either ascending (`ASC`) or descending (`DESC`)." }, { "name": "lifecycleState", "value": "", "type": "query", "description": "A filter to return only resources that match the specified lifecycle state." }, { "name": "displayName", "value": "", "type": "query", "description": "A filter to return only resources that match the entire display name given. The match is not case sensitive." } ] }, "docs": "Gets a list of the external database connectors in the specified compartment.\n" }, { "info": { "name": "Creates an ExternalDatabaseConnector", "type": "http" }, "http": { "method": "POST", "url": "http://localhost:19222/20160918/externaldatabaseconnectors", "headers": [ { "name": "opc-retry-token", "value": "" }, { "name": "opc-request-id", "value": "" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Creates a new external database connector." }, { "info": { "name": "GetExternalDatabaseConnector", "type": "http" }, "http": { "method": "GET", "url": "http://localhost:19222/20160918/externaldatabaseconnectors/:externalDatabaseConnectorId", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "externalDatabaseConnectorId", "value": "", "type": "path", "description": "The [OCID](/Content/General/Concepts/identifiers.htm) of the\nexternal database connector resource (`ExternalDatabaseConnectorId`).\n" } ] }, "docs": "Gets information about the specified external database connector." }, { "info": { "name": "UpdateExternalDatabaseConnector", "type": "http" }, "http": { "method": "PUT", "url": "http://localhost:19222/20160918/externaldatabaseconnectors/:externalDatabaseConnectorId", "headers": [ { "name": "if-match", "value": "" }, { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "externalDatabaseConnectorId", "value": "", "type": "path", "description": "The [OCID](/Content/General/Concepts/identifiers.htm) of the\nexternal database connector resource (`ExternalDatabaseConnectorId`).\n" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Updates the properties of an external database connector, such as the display name." }, { "info": { "name": "DeleteExternalDatabaseConnector", "type": "http" }, "http": { "method": "DELETE", "url": "http://localhost:19222/20160918/externaldatabaseconnectors/:externalDatabaseConnectorId", "headers": [ { "name": "if-match", "value": "" }, { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "externalDatabaseConnectorId", "value": "", "type": "path", "description": "The [OCID](/Content/General/Concepts/identifiers.htm) of the\nexternal database connector resource (`ExternalDatabaseConnectorId`).\n" } ] }, "docs": "Deletes an external database connector.\nAny services enabled using the external database connector must be\ndeleted prior to this operation.\n" }, { "info": { "name": "Check the status of the external database connection specified in this connector.", "type": "http" }, "http": { "method": "POST", "url": "http://localhost:19222/20160918/externaldatabaseconnectors/:externalDatabaseConnectorId/actions/checkConnectionStatus", "headers": [ { "name": "opc-retry-token", "value": "" }, { "name": "opc-request-id", "value": "" }, { "name": "if-match", "value": "" } ], "params": [ { "name": "externalDatabaseConnectorId", "value": "", "type": "path", "description": "The [OCID](/Content/General/Concepts/identifiers.htm) of the\nexternal database connector resource (`ExternalDatabaseConnectorId`).\n" } ] }, "docs": "Check the status of the external database connection specified in this connector.\nThis operation will refresh the connectionStatus and timeConnectionStatusLastUpdated fields.\n" }, { "info": { "name": "List the ExternalNonContainerDatabases in the compartment.", "type": "http" }, "http": { "method": "GET", "url": "http://localhost:19222/20160918/externalnoncontainerdatabases", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "compartmentId", "value": "", "type": "query", "description": "The compartment [OCID](/Content/General/Concepts/identifiers.htm)." }, { "name": "limit", "value": "", "type": "query", "description": "The maximum number of items to return per page." }, { "name": "page", "value": "", "type": "query", "description": "The pagination token to continue listing from." }, { "name": "sortBy", "value": "", "type": "query", "description": "The field to sort by. You can provide one sort order (`sortOrder`).\nDefault order for TIMECREATED is descending.\nDefault order for DISPLAYNAME is ascending.\nThe DISPLAYNAME sort order is case sensitive.\n" }, { "name": "sortOrder", "value": "", "type": "query", "description": "The sort order to use, either ascending (`ASC`) or descending (`DESC`)." }, { "name": "lifecycleState", "value": "", "type": "query", "description": "A filter to return only resources that match the specified lifecycle state." }, { "name": "displayName", "value": "", "type": "query", "description": "A filter to return only resources that match the entire display name given. The match is not case sensitive." } ] }, "docs": "Gets a list of the ExternalNonContainerDatabases in the specified compartment.\n" }, { "info": { "name": "CreateExternalNonContainerDatabase", "type": "http" }, "http": { "method": "POST", "url": "http://localhost:19222/20160918/externalnoncontainerdatabases", "headers": [ { "name": "opc-retry-token", "value": "" }, { "name": "opc-request-id", "value": "" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Creates a new ExternalNonContainerDatabase resource\n" }, { "info": { "name": "GetExternalNonContainerDatabase", "type": "http" }, "http": { "method": "GET", "url": "http://localhost:19222/20160918/externalnoncontainerdatabases/:externalNonContainerDatabaseId", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "externalNonContainerDatabaseId", "value": "", "type": "path", "description": "The external non-container database [OCID](/Content/General/Concepts/identifiers.htm)." } ] }, "docs": "Gets information about a specific external non-container database." }, { "info": { "name": "UpdateExternalNonContainerDatabase", "type": "http" }, "http": { "method": "PUT", "url": "http://localhost:19222/20160918/externalnoncontainerdatabases/:externalNonContainerDatabaseId", "headers": [ { "name": "if-match", "value": "" }, { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "externalNonContainerDatabaseId", "value": "", "type": "path", "description": "The external non-container database [OCID](/Content/General/Concepts/identifiers.htm)." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Updates the properties of an external non-container database, such as the display name." }, { "info": { "name": "Delete the ExternalNonContainerDatabase", "type": "http" }, "http": { "method": "DELETE", "url": "http://localhost:19222/20160918/externalnoncontainerdatabases/:externalNonContainerDatabaseId", "headers": [ { "name": "if-match", "value": "" }, { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "externalNonContainerDatabaseId", "value": "", "type": "path", "description": "The external non-container database [OCID](/Content/General/Concepts/identifiers.htm)." } ] }, "docs": "Deletes the Oracle Cloud Infrastructure resource representing an external non-container database.\n" }, { "info": { "name": "ChangeExternalNonContainerDatabaseCompartment", "type": "http" }, "http": { "method": "POST", "url": "http://localhost:19222/20160918/externalnoncontainerdatabases/:externalNonContainerDatabaseId/actions/changeCompartment", "headers": [ { "name": "opc-retry-token", "value": "" }, { "name": "opc-request-id", "value": "" }, { "name": "if-match", "value": "" } ], "params": [ { "name": "externalNonContainerDatabaseId", "value": "", "type": "path", "description": "The external non-container database [OCID](/Content/General/Concepts/identifiers.htm)." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Move the external non-container database and its dependent resources to the specified compartment.\nFor more information about moving external non-container databases, see\n[Moving Database Resources to a Different Compartment](/Content/Database/Concepts/databaseoverview.htm#moveRes).\n" }, { "info": { "name": "Disable Database Management Service for the external container database.", "type": "http" }, "http": { "method": "POST", "url": "http://localhost:19222/20160918/externalnoncontainerdatabases/:externalNonContainerDatabaseId/actions/disableDatabaseManagement", "headers": [ { "name": "opc-retry-token", "value": "" }, { "name": "opc-request-id", "value": "" }, { "name": "if-match", "value": "" } ], "params": [ { "name": "externalNonContainerDatabaseId", "value": "", "type": "path", "description": "The external non-container database [OCID](/Content/General/Concepts/identifiers.htm)." } ] }, "docs": "Disable Database Management Service for the external non-container database.\nFor more information about the Database Management Service, see\n[Database Management Service](/Content/ExternalDatabase/Concepts/databasemanagementservice.htm).\n" }, { "info": { "name": "Disable Operations Insights Service for the external non-container database.", "type": "http" }, "http": { "method": "POST", "url": "http://localhost:19222/20160918/externalnoncontainerdatabases/:externalNonContainerDatabaseId/actions/disableOperationsInsights", "headers": [ { "name": "opc-retry-token", "value": "" }, { "name": "opc-request-id", "value": "" }, { "name": "if-match", "value": "" } ], "params": [ { "name": "externalNonContainerDatabaseId", "value": "", "type": "path", "description": "The external non-container database [OCID](/Content/General/Concepts/identifiers.htm)." } ] }, "docs": "Disable Operations Insights for the external non-container database.\n" }, { "info": { "name": "Disable Stack Monitoring Service for the external non-container database.", "type": "http" }, "http": { "method": "POST", "url": "http://localhost:19222/20160918/externalnoncontainerdatabases/:externalNonContainerDatabaseId/actions/disableStackMonitoring", "headers": [ { "name": "opc-retry-token", "value": "" }, { "name": "opc-request-id", "value": "" }, { "name": "if-match", "value": "" } ], "params": [ { "name": "externalNonContainerDatabaseId", "value": "", "type": "path", "description": "The external non-container database [OCID](/Content/General/Concepts/identifiers.htm)." } ] }, "docs": "Disable Stack Monitoring for the external non-container database.\n" }, { "info": { "name": "Enable Database Management Service for the external container database.", "type": "http" }, "http": { "method": "POST", "url": "http://localhost:19222/20160918/externalnoncontainerdatabases/:externalNonContainerDatabaseId/actions/enableDatabaseManagement", "headers": [ { "name": "opc-retry-token", "value": "" }, { "name": "opc-request-id", "value": "" }, { "name": "if-match", "value": "" } ], "params": [ { "name": "externalNonContainerDatabaseId", "value": "", "type": "path", "description": "The external non-container database [OCID](/Content/General/Concepts/identifiers.htm)." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Enable Database Management Service for the external non-container database.\nFor more information about the Database Management Service, see\n[Database Management Service](/Content/ExternalDatabase/Concepts/databasemanagementservice.htm).\n" }, { "info": { "name": "Enable Operations Insights Service for the external non-container database.", "type": "http" }, "http": { "method": "POST", "url": "http://localhost:19222/20160918/externalnoncontainerdatabases/:externalNonContainerDatabaseId/actions/enableOperationsInsights", "headers": [ { "name": "opc-retry-token", "value": "" }, { "name": "opc-request-id", "value": "" }, { "name": "if-match", "value": "" } ], "params": [ { "name": "externalNonContainerDatabaseId", "value": "", "type": "path", "description": "The external non-container database [OCID](/Content/General/Concepts/identifiers.htm)." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Enable Operations Insights for the external non-container database.\n" }, { "info": { "name": "Enable Stack Monitoring Service for the external non-container database.", "type": "http" }, "http": { "method": "POST", "url": "http://localhost:19222/20160918/externalnoncontainerdatabases/:externalNonContainerDatabaseId/actions/enableStackMonitoring", "headers": [ { "name": "opc-retry-token", "value": "" }, { "name": "opc-request-id", "value": "" }, { "name": "if-match", "value": "" } ], "params": [ { "name": "externalNonContainerDatabaseId", "value": "", "type": "path", "description": "The external non-container database [OCID](/Content/General/Concepts/identifiers.htm)." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Enable Stack Monitoring for the external non-container database.\n" }, { "info": { "name": "List ExternalPluggableDatabases in the specified compartment.", "type": "http" }, "http": { "method": "GET", "url": "http://localhost:19222/20160918/externalpluggabledatabases", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "compartmentId", "value": "", "type": "query", "description": "The compartment [OCID](/Content/General/Concepts/identifiers.htm)." }, { "name": "externalContainerDatabaseId", "value": "", "type": "query", "description": "The ExternalContainerDatabase [OCID](/Content/General/Concepts/identifiers.htm)." }, { "name": "limit", "value": "", "type": "query", "description": "The maximum number of items to return per page." }, { "name": "page", "value": "", "type": "query", "description": "The pagination token to continue listing from." }, { "name": "sortBy", "value": "", "type": "query", "description": "The field to sort by. You can provide one sort order (`sortOrder`).\nDefault order for TIMECREATED is descending.\nDefault order for DISPLAYNAME is ascending.\nThe DISPLAYNAME sort order is case sensitive.\n" }, { "name": "sortOrder", "value": "", "type": "query", "description": "The sort order to use, either ascending (`ASC`) or descending (`DESC`)." }, { "name": "lifecycleState", "value": "", "type": "query", "description": "A filter to return only resources that match the specified lifecycle state." }, { "name": "displayName", "value": "", "type": "query", "description": "A filter to return only resources that match the entire display name given. The match is not case sensitive." } ] }, "docs": "Gets a list of the [ExternalPluggableDatabase](#/en/database/latest/datatypes/CreateExternalPluggableDatabaseDetails)\nresources in the specified compartment.\n" }, { "info": { "name": "Creates an ExternalPluggableDatabase", "type": "http" }, "http": { "method": "POST", "url": "http://localhost:19222/20160918/externalpluggabledatabases", "headers": [ { "name": "opc-retry-token", "value": "" }, { "name": "opc-request-id", "value": "" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Registers a new [ExternalPluggableDatabase](#/en/database/latest/datatypes/CreateExternalPluggableDatabaseDetails)\nresource.\n" }, { "info": { "name": "GetExternalPluggableDatabase", "type": "http" }, "http": { "method": "GET", "url": "http://localhost:19222/20160918/externalpluggabledatabases/:externalPluggableDatabaseId", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "externalPluggableDatabaseId", "value": "", "type": "path", "description": "The ExternalPluggableDatabaseId [OCID](/Content/General/Concepts/identifiers.htm)." } ] }, "docs": "Gets information about a specific\n[external pluggable database](#/en/database/latest/datatypes/CreateExternalPluggableDatabaseDetails) resource.\n" }, { "info": { "name": "UpdateExternalPluggableDatabase", "type": "http" }, "http": { "method": "PUT", "url": "http://localhost:19222/20160918/externalpluggabledatabases/:externalPluggableDatabaseId", "headers": [ { "name": "if-match", "value": "" }, { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "externalPluggableDatabaseId", "value": "", "type": "path", "description": "The ExternalPluggableDatabaseId [OCID](/Content/General/Concepts/identifiers.htm)." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Updates the properties of an\n[external pluggable database](#/en/database/latest/datatypes/CreateExternalPluggableDatabaseDetails) resource,\nsuch as the display name.\n" }, { "info": { "name": "Deletes an ExternalPluggableDatabase", "type": "http" }, "http": { "method": "DELETE", "url": "http://localhost:19222/20160918/externalpluggabledatabases/:externalPluggableDatabaseId", "headers": [ { "name": "opc-request-id", "value": "" }, { "name": "if-match", "value": "" } ], "params": [ { "name": "externalPluggableDatabaseId", "value": "", "type": "path", "description": "The ExternalPluggableDatabaseId [OCID](/Content/General/Concepts/identifiers.htm)." } ] }, "docs": "Deletes the [external pluggable database](#/en/database/latest/datatypes/CreateExternalPluggableDatabaseDetails).\nresource.\n" }, { "info": { "name": "ChangeExternalPluggableDatabaseCompartment", "type": "http" }, "http": { "method": "POST", "url": "http://localhost:19222/20160918/externalpluggabledatabases/:externalPluggableDatabaseId/actions/changeCompartment", "headers": [ { "name": "opc-retry-token", "value": "" }, { "name": "opc-request-id", "value": "" }, { "name": "if-match", "value": "" } ], "params": [ { "name": "externalPluggableDatabaseId", "value": "", "type": "path", "description": "The ExternalPluggableDatabaseId [OCID](/Content/General/Concepts/identifiers.htm)." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Move the [external pluggable database](#/en/database/latest/datatypes/CreateExternalPluggableDatabaseDetails) and\nits dependent resources to the specified compartment.\nFor more information about moving external pluggable databases, see\n[Moving Database Resources to a Different Compartment](/Content/Database/Concepts/databaseoverview.htm#moveRes).\n" }, { "info": { "name": "Disable Database Management Service for the external pluggable database.", "type": "http" }, "http": { "method": "POST", "url": "http://localhost:19222/20160918/externalpluggabledatabases/:externalPluggableDatabaseId/actions/disableDatabaseManagement", "headers": [ { "name": "opc-retry-token", "value": "" }, { "name": "opc-request-id", "value": "" }, { "name": "if-match", "value": "" } ], "params": [ { "name": "externalPluggableDatabaseId", "value": "", "type": "path", "description": "The ExternalPluggableDatabaseId [OCID](/Content/General/Concepts/identifiers.htm)." } ] }, "docs": "Disable Database Management Service for the external pluggable database.\nFor more information about the Database Management Service, see\n[Database Management Service](/Content/ExternalDatabase/Concepts/databasemanagementservice.htm).\n" }, { "info": { "name": "Disable Operations Insights Service for the external pluggable database.", "type": "http" }, "http": { "method": "POST", "url": "http://localhost:19222/20160918/externalpluggabledatabases/:externalPluggableDatabaseId/actions/disableOperationsInsights", "headers": [ { "name": "opc-retry-token", "value": "" }, { "name": "opc-request-id", "value": "" }, { "name": "if-match", "value": "" } ], "params": [ { "name": "externalPluggableDatabaseId", "value": "", "type": "path", "description": "The ExternalPluggableDatabaseId [OCID](/Content/General/Concepts/identifiers.htm)." } ] }, "docs": "Disable Operations Insights for the external pluggable database.\n" }, { "info": { "name": "Disable Stack Monitoring Service for the external pluggable database.", "type": "http" }, "http": { "method": "POST", "url": "http://localhost:19222/20160918/externalpluggabledatabases/:externalPluggableDatabaseId/actions/disableStackMonitoring", "headers": [ { "name": "opc-retry-token", "value": "" }, { "name": "opc-request-id", "value": "" }, { "name": "if-match", "value": "" } ], "params": [ { "name": "externalPluggableDatabaseId", "value": "", "type": "path", "description": "The ExternalPluggableDatabaseId [OCID](/Content/General/Concepts/identifiers.htm)." } ] }, "docs": "Disable Stack Monitoring for the external pluggable database.\n" }, { "info": { "name": "Enable Database Management Service for the external pluggable database.", "type": "http" }, "http": { "method": "POST", "url": "http://localhost:19222/20160918/externalpluggabledatabases/:externalPluggableDatabaseId/actions/enableDatabaseManagement", "headers": [ { "name": "opc-retry-token", "value": "" }, { "name": "opc-request-id", "value": "" }, { "name": "if-match", "value": "" } ], "params": [ { "name": "externalPluggableDatabaseId", "value": "", "type": "path", "description": "The ExternalPluggableDatabaseId [OCID](/Content/General/Concepts/identifiers.htm)." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Enable Database Management Service for the external pluggable database.\nFor more information about the Database Management Service, see\n[Database Management Service](/Content/ExternalDatabase/Concepts/databasemanagementservice.htm).\n" }, { "info": { "name": "Enable Operations Insights Service for the external pluggable database.", "type": "http" }, "http": { "method": "POST", "url": "http://localhost:19222/20160918/externalpluggabledatabases/:externalPluggableDatabaseId/actions/enableOperationsInsights", "headers": [ { "name": "opc-retry-token", "value": "" }, { "name": "opc-request-id", "value": "" }, { "name": "if-match", "value": "" } ], "params": [ { "name": "externalPluggableDatabaseId", "value": "", "type": "path", "description": "The ExternalPluggableDatabaseId [OCID](/Content/General/Concepts/identifiers.htm)." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Enable Operations Insights for the external pluggable database.\n" }, { "info": { "name": "Enable Stack Monitoring Service for the external pluggable database.", "type": "http" }, "http": { "method": "POST", "url": "http://localhost:19222/20160918/externalpluggabledatabases/:externalPluggableDatabaseId/actions/enableStackMonitoring", "headers": [ { "name": "opc-retry-token", "value": "" }, { "name": "opc-request-id", "value": "" }, { "name": "if-match", "value": "" } ], "params": [ { "name": "externalPluggableDatabaseId", "value": "", "type": "path", "description": "The ExternalPluggableDatabaseId [OCID](/Content/General/Concepts/identifiers.htm)." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Enable Stack Monitoring for the external pluggable database.\n" }, { "info": { "name": "ListGiVersions", "type": "http" }, "http": { "method": "GET", "url": "http://localhost:19222/20160918/giVersions", "params": [ { "name": "compartmentId", "value": "", "type": "query", "description": "The compartment [OCID](/Content/General/Concepts/identifiers.htm)." }, { "name": "limit", "value": "", "type": "query", "description": "The maximum number of items to return per page." }, { "name": "page", "value": "", "type": "query", "description": "The pagination token to continue listing from." }, { "name": "sortOrder", "value": "", "type": "query", "description": "The sort order to use, either ascending (`ASC`) or descending (`DESC`)." }, { "name": "shape", "value": "", "type": "query", "description": "If provided, filters the results for the given shape." }, { "name": "availabilityDomain", "value": "", "type": "query", "description": "The target availability domain. Only passed if the limit is AD-specific." }, { "name": "resourceId", "value": "", "type": "query", "description": "If provided, filters the results for the specified resource Id." }, { "name": "shapeAttribute", "value": "", "type": "query", "description": "If provided and applicable, return DB System shape parameters based on the shapeAttribute provided" } ] }, "docs": "Gets a list of supported GI versions." }, { "info": { "name": "ListGiMinorVersions", "type": "http" }, "http": { "method": "GET", "url": "http://localhost:19222/20160918/giVersions/:version/minorVersions", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "version", "value": "", "type": "path", "description": "The Oracle Grid Infrastructure major version." }, { "name": "availabilityDomain", "value": "", "type": "query", "description": "The target availability domain. Only passed if the limit is AD-specific." }, { "name": "compartmentId", "value": "", "type": "query", "description": "The compartment [OCID](/Content/General/Concepts/identifiers.htm)." }, { "name": "shapeFamily", "value": "", "type": "query", "description": "If provided, filters the results to the set of database versions which are supported for the given shape family." }, { "name": "isGiVersionForProvisioning", "value": "", "type": "query", "description": "If true, returns the Grid Infrastructure versions that can be used for provisioning a cluster" }, { "name": "shape", "value": "", "type": "query", "description": "If provided, filters the results for the given shape." }, { "name": "sortBy", "value": "", "type": "query", "description": "Sort by VERSION. Default order for VERSION is descending." }, { "name": "sortOrder", "value": "", "type": "query", "description": "The sort order to use, either ascending (`ASC`) or descending (`DESC`)." }, { "name": "limit", "value": "", "type": "query", "description": "The maximum number of items to return per page." }, { "name": "page", "value": "", "type": "query", "description": "The pagination token to continue listing from." } ] }, "docs": "Gets a list of supported Oracle Grid Infrastructure minor versions for the given major version and shape family." }, { "info": { "name": "ListKeyStores", "type": "http" }, "http": { "method": "GET", "url": "http://localhost:19222/20160918/keyStores", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "compartmentId", "value": "", "type": "query", "description": "The compartment [OCID](/Content/General/Concepts/identifiers.htm)." }, { "name": "limit", "value": "", "type": "query", "description": "The maximum number of items to return per page." }, { "name": "page", "value": "", "type": "query", "description": "The pagination token to continue listing from." } ] }, "docs": "Gets a list of key stores in the specified compartment.\n" }, { "info": { "name": "CreateKeyStore", "type": "http" }, "http": { "method": "POST", "url": "http://localhost:19222/20160918/keyStores", "headers": [ { "name": "opc-retry-token", "value": "" }, { "name": "opc-request-id", "value": "" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Creates a Key Store.\n" }, { "info": { "name": "GetKeyStore", "type": "http" }, "http": { "method": "GET", "url": "http://localhost:19222/20160918/keyStores/:keyStoreId", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "keyStoreId", "value": "", "type": "path", "description": "The [OCID](/Content/General/Concepts/identifiers.htm) of the key store." } ] }, "docs": "Gets information about the specified key store.\n" }, { "info": { "name": "Updates the specified key store.", "type": "http" }, "http": { "method": "PUT", "url": "http://localhost:19222/20160918/keyStores/:keyStoreId", "headers": [ { "name": "if-match", "value": "" }, { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "keyStoreId", "value": "", "type": "path", "description": "The [OCID](/Content/General/Concepts/identifiers.htm) of the key store." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Edit the key store.\n" }, { "info": { "name": "DeleteKeyStore", "type": "http" }, "http": { "method": "DELETE", "url": "http://localhost:19222/20160918/keyStores/:keyStoreId", "headers": [ { "name": "if-match", "value": "" }, { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "keyStoreId", "value": "", "type": "path", "description": "The [OCID](/Content/General/Concepts/identifiers.htm) of the key store." } ] }, "docs": "Deletes a key store.\n" }, { "info": { "name": "ChangeKeyStoreCompartment", "type": "http" }, "http": { "method": "POST", "url": "http://localhost:19222/20160918/keyStores/:keyStoreId/actions/changeCompartment", "headers": [ { "name": "opc-retry-token", "value": "" }, { "name": "opc-request-id", "value": "" }, { "name": "if-match", "value": "" } ], "params": [ { "name": "keyStoreId", "value": "", "type": "path", "description": "The [OCID](/Content/General/Concepts/identifiers.htm) of the key store." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Move the key store resource to the specified compartment.\nFor more information about moving key stores, see\n[Moving Database Resources to a Different Compartment](/Content/Database/Concepts/databaseoverview.htm#moveRes).\n" }, { "info": { "name": "List maintenance run histories.", "type": "http" }, "http": { "method": "GET", "url": "http://localhost:19222/20160918/maintenanceRunHistory", "params": [ { "name": "compartmentId", "value": "", "type": "query", "description": "The compartment [OCID](/Content/General/Concepts/identifiers.htm)." }, { "name": "targetResourceId", "value": "", "type": "query", "description": "The target resource ID." }, { "name": "targetResourceType", "value": "", "type": "query", "description": "The type of the target resource." }, { "name": "maintenanceType", "value": "", "type": "query", "description": "The maintenance type." }, { "name": "limit", "value": "", "type": "query", "description": "The maximum number of items to return per page." }, { "name": "page", "value": "", "type": "query", "description": "The pagination token to continue listing from." }, { "name": "sortBy", "value": "", "type": "query", "description": "The field to sort by. You can provide one sort order (`sortOrder`). Default order for TIME_SCHEDULED and TIME_ENDED is descending. Default order for DISPLAYNAME is ascending. The DISPLAYNAME sort order is case sensitive.\n\n**Note:** If you do not include the availability domain filter, the resources are grouped by availability domain, then sorted.\n" }, { "name": "sortOrder", "value": "", "type": "query", "description": "The sort order to use, either ascending (`ASC`) or descending (`DESC`)." }, { "name": "lifecycleState", "value": "", "type": "query", "description": "The state of the maintenance run history." }, { "name": "availabilityDomain", "value": "", "type": "query", "description": "A filter to return only resources that match the given availability domain exactly." }, { "name": "maintenanceSubtype", "value": "", "type": "query", "description": "The sub-type of the maintenance run." } ] }, "docs": "Gets a list of the maintenance run histories in the specified compartment.\n" }, { "info": { "name": "Gets maintenance run history.", "type": "http" }, "http": { "method": "GET", "url": "http://localhost:19222/20160918/maintenanceRunHistory/:maintenanceRunHistoryId", "params": [ { "name": "maintenanceRunHistoryId", "value": "", "type": "path", "description": "The maintenance run history OCID." } ] }, "docs": "Gets information about the specified maintenance run history." }, { "info": { "name": "ListMaintenanceRuns", "type": "http" }, "http": { "method": "GET", "url": "http://localhost:19222/20160918/maintenanceRuns", "params": [ { "name": "compartmentId", "value": "", "type": "query", "description": "The compartment [OCID](/Content/General/Concepts/identifiers.htm)." }, { "name": "targetResourceId", "value": "", "type": "query", "description": "The target resource ID." }, { "name": "targetResourceType", "value": "", "type": "query", "description": "The type of the target resource." }, { "name": "maintenanceType", "value": "", "type": "query", "description": "The maintenance type." }, { "name": "limit", "value": "", "type": "query", "description": "The maximum number of items to return per page." }, { "name": "page", "value": "", "type": "query", "description": "The pagination token to continue listing from." }, { "name": "isLocalAdg", "value": "", "type": "query", "description": "A filter to return the maintenance history results for the local standby Autonomous AI Database Serverless only." }, { "name": "sortBy", "value": "", "type": "query", "description": "The field to sort by. You can provide one sort order (`sortOrder`). Default order for TIME_SCHEDULED and TIME_ENDED is descending. Default order for DISPLAYNAME is ascending. The DISPLAYNAME sort order is case sensitive.\n\n**Note:** If you do not include the availability domain filter, the resources are grouped by availability domain, then sorted.\n" }, { "name": "sortOrder", "value": "", "type": "query", "description": "The sort order to use, either ascending (`ASC`) or descending (`DESC`)." }, { "name": "lifecycleState", "value": "", "type": "query", "description": "A filter to return only resources that match the given lifecycle state exactly." }, { "name": "availabilityDomain", "value": "", "type": "query", "description": "A filter to return only resources that match the given availability domain exactly." }, { "name": "maintenanceSubtype", "value": "", "type": "query", "description": "The sub-type of the maintenance run." } ] }, "docs": "Gets a list of the maintenance runs in the specified compartment.\n" }, { "info": { "name": "CreateMaintenanceRun", "type": "http" }, "http": { "method": "POST", "url": "http://localhost:19222/20160918/maintenanceRuns", "headers": [ { "name": "opc-request-id", "value": "" }, { "name": "opc-retry-token", "value": "" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Creates a maintenance run with one of the following:\n1. The latest available release update patch (RUP) for the Autonomous Container Database.\n2. The latest available RUP and DST time-zone (TZ) file updates for the Autonomous Container Database.\n3. The DST TZ file updates for the Autonomous Container Database.\n" }, { "info": { "name": "GetMaintenanceRun", "type": "http" }, "http": { "method": "GET", "url": "http://localhost:19222/20160918/maintenanceRuns/:maintenanceRunId", "params": [ { "name": "maintenanceRunId", "value": "", "type": "path", "description": "The maintenance run OCID." } ] }, "docs": "Gets information about the specified maintenance run." }, { "info": { "name": "UpdateMaintenanceRun", "type": "http" }, "http": { "method": "PUT", "url": "http://localhost:19222/20160918/maintenanceRuns/:maintenanceRunId", "headers": [ { "name": "if-match", "value": "" } ], "params": [ { "name": "maintenanceRunId", "value": "", "type": "path", "description": "The maintenance run OCID." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Updates the properties of a maintenance run, such as the state of a maintenance run." }, { "info": { "name": "Lists one-off patches in the specified compartment.", "type": "http" }, "http": { "method": "GET", "url": "http://localhost:19222/20160918/oneoffPatches", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "compartmentId", "value": "", "type": "query", "description": "The compartment [OCID](/Content/General/Concepts/identifiers.htm)." }, { "name": "limit", "value": "", "type": "query", "description": "The maximum number of items to return per page." }, { "name": "page", "value": "", "type": "query", "description": "The pagination token to continue listing from." }, { "name": "sortBy", "value": "", "type": "query", "description": "The field to sort by. You can provide one sort order (`sortOrder`). Default order for TIMECREATED is descending. Default order for DISPLAYNAME is ascending. The DISPLAYNAME sort order is case sensitive.\n" }, { "name": "sortOrder", "value": "", "type": "query", "description": "The sort order to use, either ascending (`ASC`) or descending (`DESC`)." }, { "name": "lifecycleState", "value": "", "type": "query", "description": "A filter to return only resources that match the given lifecycle state exactly" }, { "name": "displayName", "value": "", "type": "query", "description": "A filter to return only resources that match the entire display name given. The match is not case sensitive." } ] }, "docs": "Lists one-off patches in the specified compartment.\n" }, { "info": { "name": "Create one-off patch", "type": "http" }, "http": { "method": "POST", "url": "http://localhost:19222/20160918/oneoffPatches", "headers": [ { "name": "opc-retry-token", "value": "" }, { "name": "opc-request-id", "value": "" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Creates one-off patch for specified database version to download.\n" }, { "info": { "name": "Get one-off patch", "type": "http" }, "http": { "method": "GET", "url": "http://localhost:19222/20160918/oneoffPatches/:oneoffPatchId", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "oneoffPatchId", "value": "", "type": "path", "description": "The one-off patch [OCID](/Content/General/Concepts/identifiers.htm)." } ] }, "docs": "Gets information about the specified one-off patch.\n" }, { "info": { "name": "Updates the properties of the specified one-off patch.", "type": "http" }, "http": { "method": "PUT", "url": "http://localhost:19222/20160918/oneoffPatches/:oneoffPatchId", "headers": [ { "name": "if-match", "value": "" }, { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "oneoffPatchId", "value": "", "type": "path", "description": "The one-off patch [OCID](/Content/General/Concepts/identifiers.htm)." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Updates the properties of the specified one-off patch.\n" }, { "info": { "name": "Delete one-off patch", "type": "http" }, "http": { "method": "DELETE", "url": "http://localhost:19222/20160918/oneoffPatches/:oneoffPatchId", "headers": [ { "name": "opc-request-id", "value": "" }, { "name": "if-match", "value": "" } ], "params": [ { "name": "oneoffPatchId", "value": "", "type": "path", "description": "The one-off patch [OCID](/Content/General/Concepts/identifiers.htm)." } ] }, "docs": "Deletes a one-off patch.\n" }, { "info": { "name": "Change one-off patch compartment", "type": "http" }, "http": { "method": "POST", "url": "http://localhost:19222/20160918/oneoffPatches/:oneoffPatchId/actions/changeCompartment", "headers": [ { "name": "opc-retry-token", "value": "" }, { "name": "opc-request-id", "value": "" }, { "name": "if-match", "value": "" } ], "params": [ { "name": "oneoffPatchId", "value": "", "type": "path", "description": "The one-off patch [OCID](/Content/General/Concepts/identifiers.htm)." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Move the one-off patch to the specified compartment.\n" }, { "info": { "name": "Download one-off patch.", "type": "http" }, "http": { "method": "POST", "url": "http://localhost:19222/20160918/oneoffPatches/:oneoffPatchId/actions/downloadOneoffPatch", "headers": [ { "name": "opc-retry-token", "value": "" }, { "name": "opc-request-id", "value": "" }, { "name": "if-match", "value": "" } ], "params": [ { "name": "oneoffPatchId", "value": "", "type": "path", "description": "The one-off patch [OCID](/Content/General/Concepts/identifiers.htm)." } ] }, "docs": "Download one-off patch.\n" }, { "info": { "name": "ListPluggableDatabaseSnapshots", "type": "http" }, "http": { "method": "GET", "url": "http://localhost:19222/20160918/pluggableDatabaseSnapshots", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "compartmentId", "value": "", "type": "query", "description": "The compartment [OCID](/Content/General/Concepts/identifiers.htm)." }, { "name": "limit", "value": "", "type": "query", "description": "The maximum number of items to return per page." }, { "name": "page", "value": "", "type": "query", "description": "The pagination token to continue listing from." }, { "name": "sortBy", "value": "", "type": "query", "description": "The field to sort by. You can provide one sort order (`sortOrder`). Default order for TIMECREATED is descending. Default order for NAME is ascending. The NAME sort order is case sensitive.\n" }, { "name": "name", "value": "", "type": "query", "description": "A filter to return only resources that match the entire name given. The match is not case sensitive." }, { "name": "sortOrder", "value": "", "type": "query", "description": "The sort order to use, either ascending (`ASC`) or descending (`DESC`)." }, { "name": "lifecycleState", "value": "", "type": "query", "description": "A filter to return only Exadata Pluggable Database Snapshots that match the given lifecycle state exactly." }, { "name": "clusterId", "value": "", "type": "query", "description": "A filter to return only Exadata Database Node Snapshots that match the given VM cluster." }, { "name": "pluggableDatabaseId", "value": "", "type": "query", "description": "A filter to return only Exadata Pluggable Database Snapshots that match the given database [OCID](/Content/General/Concepts/identifiers.htm)." } ] }, "docs": "Gets a list of the Exadata Pluggable Database Snapshots in the specified compartment.\n" }, { "info": { "name": "CreatePluggableDatabaseSnapshot", "type": "http" }, "http": { "method": "POST", "url": "http://localhost:19222/20160918/pluggableDatabaseSnapshots", "headers": [ { "name": "opc-retry-token", "value": "" }, { "name": "opc-request-id", "value": "" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Creates a Pluggable Database Snapshot\n" }, { "info": { "name": "GetPluggableDatabaseSnapshot", "type": "http" }, "http": { "method": "GET", "url": "http://localhost:19222/20160918/pluggableDatabaseSnapshots/:pluggableDatabaseSnapshotId", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "pluggableDatabaseSnapshotId", "value": "", "type": "path", "description": "The Exadata Pluggable Database Snapshot [OCID](/Content/General/Concepts/identifiers.htm)." } ] }, "docs": "Gets information about the specified Exadata Pluggable Database Snapshot in the specified compartment.\n" }, { "info": { "name": "Deletes the specified Exadata Pluggable Database Snapshot.", "type": "http" }, "http": { "method": "DELETE", "url": "http://localhost:19222/20160918/pluggableDatabaseSnapshots/:pluggableDatabaseSnapshotId", "headers": [ { "name": "if-match", "value": "" }, { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "pluggableDatabaseSnapshotId", "value": "", "type": "path", "description": "The Exadata Pluggable Database Snapshot [OCID](/Content/General/Concepts/identifiers.htm)." } ] }, "docs": "Deletes the specified Exadata Pluggable Database Snapshot.\n" }, { "info": { "name": "ListPluggableDatabases", "type": "http" }, "http": { "method": "GET", "url": "http://localhost:19222/20160918/pluggableDatabases", "params": [ { "name": "compartmentId", "value": "", "type": "query", "description": "The compartment [OCID](/Content/General/Concepts/identifiers.htm)." }, { "name": "databaseId", "value": "", "type": "query", "description": "The [OCID](/Content/General/Concepts/identifiers.htm) of the database." }, { "name": "limit", "value": "", "type": "query", "description": "The maximum number of items to return per page." }, { "name": "page", "value": "", "type": "query", "description": "The pagination token to continue listing from." }, { "name": "sortBy", "value": "", "type": "query", "description": "The field to sort by. You can provide one sort order (`sortOrder`). Default order for TIMECREATED is descending. Default order for PDBNAME is ascending. The PDBNAME sort order is case sensitive." }, { "name": "sortOrder", "value": "", "type": "query", "description": "The sort order to use, either ascending (`ASC`) or descending (`DESC`)." }, { "name": "lifecycleState", "value": "", "type": "query", "description": "A filter to return only resources that match the given lifecycle state exactly." }, { "name": "pdbName", "value": "", "type": "query", "description": "A filter to return only pluggable databases that match the entire name given. The match is not case sensitive." } ] }, "docs": "Gets a list of the pluggable databases in a database or compartment. You must provide either a `databaseId` or `compartmentId` value.\n" }, { "info": { "name": "CreatePluggableDatabase", "type": "http" }, "http": { "method": "POST", "url": "http://localhost:19222/20160918/pluggableDatabases", "headers": [ { "name": "opc-retry-token", "value": "" }, { "name": "opc-request-id", "value": "" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Creates and starts a pluggable database in the specified container database.\nPluggable Database can be created using different operations (e.g. LocalClone, RemoteClone, Relocate ) with this API.\nUse the [StartPluggableDatabase](#/en/database/latest/PluggableDatabase/StartPluggableDatabase) and [StopPluggableDatabase](#/en/database/latest/PluggableDatabase/StopPluggableDatabase) APIs to start and stop the pluggable database.\n" }, { "info": { "name": "GetPluggableDatabase", "type": "http" }, "http": { "method": "GET", "url": "http://localhost:19222/20160918/pluggableDatabases/:pluggableDatabaseId", "params": [ { "name": "pluggableDatabaseId", "value": "", "type": "path", "description": "The database [OCID](/Content/General/Concepts/identifiers.htm)." } ] }, "docs": "Gets information about the specified pluggable database." }, { "info": { "name": "UpdatePluggableDatabase", "type": "http" }, "http": { "method": "PUT", "url": "http://localhost:19222/20160918/pluggableDatabases/:pluggableDatabaseId", "headers": [ { "name": "if-match", "value": "" } ], "params": [ { "name": "pluggableDatabaseId", "value": "", "type": "path", "description": "The database [OCID](/Content/General/Concepts/identifiers.htm)." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Updates the specified pluggable database." }, { "info": { "name": "DeletePluggableDatabase", "type": "http" }, "http": { "method": "DELETE", "url": "http://localhost:19222/20160918/pluggableDatabases/:pluggableDatabaseId", "headers": [ { "name": "if-match", "value": "" }, { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "pluggableDatabaseId", "value": "", "type": "path", "description": "The database [OCID](/Content/General/Concepts/identifiers.htm)." } ] }, "docs": "Deletes the specified pluggable database." }, { "info": { "name": "Converts a Refreshable clone to Regular pluggable database.", "type": "http" }, "http": { "method": "POST", "url": "http://localhost:19222/20160918/pluggableDatabases/:pluggableDatabaseId/actions/convertToRegular", "headers": [ { "name": "if-match", "value": "" }, { "name": "opc-request-id", "value": "" }, { "name": "opc-retry-token", "value": "" } ], "params": [ { "name": "pluggableDatabaseId", "value": "", "type": "path", "description": "The database [OCID](/Content/General/Concepts/identifiers.htm)." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Converts a Refreshable clone to Regular pluggable database (PDB).\nPluggable Database will be in `READ_WRITE` openmode after conversion.\n" }, { "info": { "name": "LocalClonePluggableDatabase", "type": "http" }, "http": { "method": "POST", "url": "http://localhost:19222/20160918/pluggableDatabases/:pluggableDatabaseId/actions/localClone", "headers": [ { "name": "if-match", "value": "" }, { "name": "opc-request-id", "value": "" }, { "name": "opc-retry-token", "value": "" } ], "params": [ { "name": "pluggableDatabaseId", "value": "", "type": "path", "description": "The database [OCID](/Content/General/Concepts/identifiers.htm)." } ], "body": { "type": "json", "data": "{}" } }, "docs": "**Deprecated.** Use [CreatePluggableDatabase](#/en/database/latest/PluggableDatabase/CreatePluggableDatabase) for Pluggable Database LocalClone Operation.\nClones and starts a pluggable database (PDB) in the same database (CDB) as the source PDB. The source PDB must be in the `READ_WRITE` openMode to perform the clone operation.\n" }, { "info": { "name": "Refreshes a pluggable database Refreshable clone.", "type": "http" }, "http": { "method": "POST", "url": "http://localhost:19222/20160918/pluggableDatabases/:pluggableDatabaseId/actions/refresh", "headers": [ { "name": "if-match", "value": "" }, { "name": "opc-request-id", "value": "" }, { "name": "opc-retry-token", "value": "" } ], "params": [ { "name": "pluggableDatabaseId", "value": "", "type": "path", "description": "The database [OCID](/Content/General/Concepts/identifiers.htm)." } ] }, "docs": "Refreshes a pluggable database (PDB) Refreshable clone.\n" }, { "info": { "name": "RemoteClonePluggableDatabase", "type": "http" }, "http": { "method": "POST", "url": "http://localhost:19222/20160918/pluggableDatabases/:pluggableDatabaseId/actions/remoteClone", "headers": [ { "name": "if-match", "value": "" }, { "name": "opc-request-id", "value": "" }, { "name": "opc-retry-token", "value": "" } ], "params": [ { "name": "pluggableDatabaseId", "value": "", "type": "path", "description": "The database [OCID](/Content/General/Concepts/identifiers.htm)." } ], "body": { "type": "json", "data": "{}" } }, "docs": "**Deprecated.** Use [CreatePluggableDatabase](#/en/database/latest/PluggableDatabase/CreatePluggableDatabase) for Pluggable Database RemoteClone Operation.\nClones a pluggable database (PDB) to a different database from the source PDB. The cloned PDB will be started upon completion of the clone operation. The source PDB must be in the `READ_WRITE` openMode when performing the clone.\nFor Exadata Cloud@Customer instances, the source pluggable database (PDB) must be on the same Exadata Infrastructur" }, { "info": { "name": "StartPluggableDatabase", "type": "http" }, "http": { "method": "POST", "url": "http://localhost:19222/20160918/pluggableDatabases/:pluggableDatabaseId/actions/start", "headers": [ { "name": "if-match", "value": "" }, { "name": "opc-request-id", "value": "" }, { "name": "opc-retry-token", "value": "" } ], "params": [ { "name": "pluggableDatabaseId", "value": "", "type": "path", "description": "The database [OCID](/Content/General/Concepts/identifiers.htm)." } ] }, "docs": "Starts a stopped pluggable database. The `openMode` value of the pluggable database will be `READ_WRITE` upon completion." }, { "info": { "name": "StopPluggableDatabase", "type": "http" }, "http": { "method": "POST", "url": "http://localhost:19222/20160918/pluggableDatabases/:pluggableDatabaseId/actions/stop", "headers": [ { "name": "if-match", "value": "" }, { "name": "opc-request-id", "value": "" }, { "name": "opc-retry-token", "value": "" } ], "params": [ { "name": "pluggableDatabaseId", "value": "", "type": "path", "description": "The database [OCID](/Content/General/Concepts/identifiers.htm)." } ] }, "docs": "Stops a pluggable database. The `openMode` value of the pluggable database will be `MOUNTED` upon completion." }, { "info": { "name": "GetResourcePrincipalToken", "type": "http" }, "http": { "method": "GET", "url": "http://localhost:19222/20160918/resourcePrincipalToken/:instanceId", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "instanceId", "value": "", "type": "path", "description": "The Compute Instance [OCID](/Content/General/Concepts/identifiers.htm)." } ] }, "docs": "Gets a resource principal intermediate token that contains mapping information between the instance prinicpal and resource.\n" }, { "info": { "name": "ListParamsForActionType", "type": "http" }, "http": { "method": "GET", "url": "http://localhost:19222/20160918/scheduledActionParams", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "type", "value": "", "type": "query", "description": "The type of the scheduled action" }, { "name": "planIntent", "value": "", "type": "query", "description": "The plan intent the action will be used for. Relevant to action type that can be used in multiple plans" }, { "name": "limit", "value": "", "type": "query", "description": "The maximum number of items to return per page." }, { "name": "page", "value": "", "type": "query", "description": "The pagination token to continue listing from." } ] }, "docs": "List all the action params and their possible values for a given action type\n" }, { "info": { "name": "ListScheduledActions", "type": "http" }, "http": { "method": "GET", "url": "http://localhost:19222/20160918/scheduledActions", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "limit", "value": "", "type": "query", "description": "The maximum number of items to return per page." }, { "name": "compartmentId", "value": "", "type": "query", "description": "The compartment [OCID](/Content/General/Concepts/identifiers.htm)." }, { "name": "page", "value": "", "type": "query", "description": "The pagination token to continue listing from." }, { "name": "sortOrder", "value": "", "type": "query", "description": "The sort order to use, either ascending (`ASC`) or descending (`DESC`)." }, { "name": "serviceType", "value": "", "type": "query", "description": "A filter to return only resources that match the given service type exactly." }, { "name": "schedulingPlanId", "value": "", "type": "query", "description": "A filter to return only resources that match the given scheduling policy id exactly." }, { "name": "displayName", "value": "", "type": "query", "description": "A filter to return only resources that match the entire display name given. The match is not case sensitive." }, { "name": "sortBy", "value": "", "type": "query", "description": "The field to sort by. You can provide one sort order (`sortOrder`). Default order for TIMECREATED is descending.\n" }, { "name": "id", "value": "", "type": "query", "description": "A filter to return only resources that match the given Scheduled Action id exactly." }, { "name": "lifecycleState", "value": "", "type": "query", "description": "A filter to return only resources that match the given lifecycle state exactly." } ] }, "docs": "Lists the Scheduled Action resources in the specified compartment.\n" }, { "info": { "name": "CreateScheduledAction", "type": "http" }, "http": { "method": "POST", "url": "http://localhost:19222/20160918/scheduledActions", "headers": [ { "name": "opc-retry-token", "value": "" }, { "name": "opc-request-id", "value": "" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Creates a Scheduled Action resource.\n" }, { "info": { "name": "Get ScheduledAction", "type": "http" }, "http": { "method": "GET", "url": "http://localhost:19222/20160918/scheduledActions/:scheduledActionId", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "scheduledActionId", "value": "", "type": "path", "description": "The Scheduled Action [OCID](/Content/General/Concepts/identifiers.htm)." } ] }, "docs": "Gets information about the specified Scheduled Action.\n" }, { "info": { "name": "Updates the specified Scheduled Action", "type": "http" }, "http": { "method": "PUT", "url": "http://localhost:19222/20160918/scheduledActions/:scheduledActionId", "headers": [ { "name": "if-match", "value": "" }, { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "scheduledActionId", "value": "", "type": "path", "description": "The Scheduled Action [OCID](/Content/General/Concepts/identifiers.htm)." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Updates the Scheduled Action resource.\n" }, { "info": { "name": "Delete a scheduled action.", "type": "http" }, "http": { "method": "DELETE", "url": "http://localhost:19222/20160918/scheduledActions/:scheduledActionId", "headers": [ { "name": "if-match", "value": "" }, { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "scheduledActionId", "value": "", "type": "path", "description": "The Scheduled Action [OCID](/Content/General/Concepts/identifiers.htm)." } ] }, "docs": "Deletes the scheduled action.\n" }, { "info": { "name": "ListSchedulingPlans", "type": "http" }, "http": { "method": "GET", "url": "http://localhost:19222/20160918/schedulingPlans", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "compartmentId", "value": "", "type": "query", "description": "The compartment [OCID](/Content/General/Concepts/identifiers.htm)." }, { "name": "limit", "value": "", "type": "query", "description": "The maximum number of items to return per page." }, { "name": "page", "value": "", "type": "query", "description": "The pagination token to continue listing from." }, { "name": "sortBy", "value": "", "type": "query", "description": "The field to sort by. You can provide one sort order (`sortOrder`). Default order for TIMECREATED is descending.\n" }, { "name": "sortOrder", "value": "", "type": "query", "description": "The sort order to use, either ascending (`ASC`) or descending (`DESC`)." }, { "name": "lifecycleState", "value": "", "type": "query", "description": "A filter to return only resources that match the given lifecycle state exactly." }, { "name": "displayName", "value": "", "type": "query", "description": "A filter to return only resources that match the entire display name given. The match is not case sensitive." }, { "name": "resourceId", "value": "", "type": "query", "description": "A filter to return only resources that match the given resource id exactly." }, { "name": "id", "value": "", "type": "query", "description": "A filter to return only resources that match the given Schedule Plan id exactly." }, { "name": "planIntent", "value": "", "type": "query", "description": "A filter to return only resources that match the given plan intent exactly." } ] }, "docs": "Lists the Scheduling Plan resources in the specified compartment.\n" }, { "info": { "name": "CreateSchedulingPlan", "type": "http" }, "http": { "method": "POST", "url": "http://localhost:19222/20160918/schedulingPlans", "headers": [ { "name": "opc-retry-token", "value": "" }, { "name": "opc-request-id", "value": "" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Creates a Scheduling Plan resource.\n" }, { "info": { "name": "Get SchedulingPlan", "type": "http" }, "http": { "method": "GET", "url": "http://localhost:19222/20160918/schedulingPlans/:schedulingPlanId", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "schedulingPlanId", "value": "", "type": "path", "description": "The Schedule Plan [OCID](/Content/General/Concepts/identifiers.htm)." } ] }, "docs": "Gets information about the specified Scheduling Plan.\n" }, { "info": { "name": "Delete a scheduling plan.", "type": "http" }, "http": { "method": "DELETE", "url": "http://localhost:19222/20160918/schedulingPlans/:schedulingPlanId", "headers": [ { "name": "if-match", "value": "" }, { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "schedulingPlanId", "value": "", "type": "path", "description": "The Schedule Plan [OCID](/Content/General/Concepts/identifiers.htm)." } ] }, "docs": "Deletes the scheduling plan.\n" }, { "info": { "name": "ChangeSchedulingPlanCompartment", "type": "http" }, "http": { "method": "POST", "url": "http://localhost:19222/20160918/schedulingPlans/:schedulingPlanId/actions/changeCompartment", "headers": [ { "name": "if-match", "value": "" }, { "name": "opc-request-id", "value": "" }, { "name": "opc-retry-token", "value": "" } ], "params": [ { "name": "schedulingPlanId", "value": "", "type": "path", "description": "The Schedule Plan [OCID](/Content/General/Concepts/identifiers.htm)." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Moves an scheduling plan resource to another compartment.\n" }, { "info": { "name": "Re-order the scheduled actions under this scheduling plan resource", "type": "http" }, "http": { "method": "POST", "url": "http://localhost:19222/20160918/schedulingPlans/:schedulingPlanId/actions/reorder", "headers": [ { "name": "opc-retry-token", "value": "" }, { "name": "opc-request-id", "value": "" }, { "name": "if-match", "value": "" } ], "params": [ { "name": "schedulingPlanId", "value": "", "type": "path", "description": "The Schedule Plan [OCID](/Content/General/Concepts/identifiers.htm)." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Re-order the scheduled actions under this scheduling plan resource.\n" }, { "info": { "name": "ListSchedulingPolicies", "type": "http" }, "http": { "method": "GET", "url": "http://localhost:19222/20160918/schedulingPolicies", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "compartmentId", "value": "", "type": "query", "description": "The compartment [OCID](/Content/General/Concepts/identifiers.htm)." }, { "name": "limit", "value": "", "type": "query", "description": "The maximum number of items to return per page." }, { "name": "page", "value": "", "type": "query", "description": "The pagination token to continue listing from." }, { "name": "sortBy", "value": "", "type": "query", "description": "The field to sort by. You can provide one sort order (`sortOrder`). Default order for TIMECREATED is descending. Default order for DISPLAYNAME is ascending. The DISPLAYNAME sort order is case sensitive.\n" }, { "name": "sortOrder", "value": "", "type": "query", "description": "The sort order to use, either ascending (`ASC`) or descending (`DESC`)." }, { "name": "lifecycleState", "value": "", "type": "query", "description": "A filter to return only resources that match the given lifecycle state exactly." }, { "name": "displayName", "value": "", "type": "query", "description": "A filter to return only resources that match the entire display name given. The match is not case sensitive." }, { "name": "cadence", "value": "", "type": "query", "description": "A filter to return only resources that match the given cadence period exactly." } ] }, "docs": "Lists the Scheduling Policy resources in the specified compartment.\n" }, { "info": { "name": "CreateSchedulingPolicy", "type": "http" }, "http": { "method": "POST", "url": "http://localhost:19222/20160918/schedulingPolicies", "headers": [ { "name": "opc-retry-token", "value": "" }, { "name": "opc-request-id", "value": "" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Creates a Scheduling Policy resource.\n" }, { "info": { "name": "Get SchedulingPolicy", "type": "http" }, "http": { "method": "GET", "url": "http://localhost:19222/20160918/schedulingPolicies/:schedulingPolicyId", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "schedulingPolicyId", "value": "", "type": "path", "description": "The Scheduling Policy [OCID](/Content/General/Concepts/identifiers.htm)." } ] }, "docs": "Gets information about the specified Scheduling Policy.\n" }, { "info": { "name": "Updates the specified Scheduling Policy", "type": "http" }, "http": { "method": "PUT", "url": "http://localhost:19222/20160918/schedulingPolicies/:schedulingPolicyId", "headers": [ { "name": "if-match", "value": "" }, { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "schedulingPolicyId", "value": "", "type": "path", "description": "The Scheduling Policy [OCID](/Content/General/Concepts/identifiers.htm)." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Updates the Scheduling Policy resource.\n" }, { "info": { "name": "Delete a scheduling policy.", "type": "http" }, "http": { "method": "DELETE", "url": "http://localhost:19222/20160918/schedulingPolicies/:schedulingPolicyId", "headers": [ { "name": "if-match", "value": "" }, { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "schedulingPolicyId", "value": "", "type": "path", "description": "The Scheduling Policy [OCID](/Content/General/Concepts/identifiers.htm)." } ] }, "docs": "Deletes the scheduling policy.\n" }, { "info": { "name": "ChangeSchedulingPolicyCompartment", "type": "http" }, "http": { "method": "POST", "url": "http://localhost:19222/20160918/schedulingPolicies/:schedulingPolicyId/actions/changeCompartment", "headers": [ { "name": "if-match", "value": "" }, { "name": "opc-request-id", "value": "" }, { "name": "opc-retry-token", "value": "" } ], "params": [ { "name": "schedulingPolicyId", "value": "", "type": "path", "description": "The Scheduling Policy [OCID](/Content/General/Concepts/identifiers.htm)." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Moves an scheduling policy resource to another compartment.\n" }, { "info": { "name": "ListRecommendedScheduledActions", "type": "http" }, "http": { "method": "GET", "url": "http://localhost:19222/20160918/schedulingPolicies/:schedulingPolicyId/recommendedScheduledActions", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "schedulingPolicyId", "value": "", "type": "path", "description": "The Scheduling Policy [OCID](/Content/General/Concepts/identifiers.htm)." }, { "name": "schedulingPolicyTargetResourceId", "value": "", "type": "query", "description": "The target resource [OCID](/Content/General/Concepts/identifiers.htm) the scheduled actions will be for." }, { "name": "planIntent", "value": "", "type": "query", "description": "The scheduling plan intent the scheduled actions will be for." }, { "name": "limit", "value": "", "type": "query", "description": "The maximum number of items to return per page." }, { "name": "page", "value": "", "type": "query", "description": "The pagination token to continue listing from." } ] }, "docs": "Returns a recommended Scheduled Actions configuration for a given resource, plan intent and scheduling policy.\n" }, { "info": { "name": "ListSchedulingWindows", "type": "http" }, "http": { "method": "GET", "url": "http://localhost:19222/20160918/schedulingPolicies/:schedulingPolicyId/schedulingWindows", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "schedulingPolicyId", "value": "", "type": "path", "description": "The Scheduling Policy [OCID](/Content/General/Concepts/identifiers.htm)." }, { "name": "compartmentId", "value": "", "type": "query", "description": "The compartment [OCID](/Content/General/Concepts/identifiers.htm)." }, { "name": "limit", "value": "", "type": "query", "description": "The maximum number of items to return per page." }, { "name": "page", "value": "", "type": "query", "description": "The pagination token to continue listing from." }, { "name": "sortBy", "value": "", "type": "query", "description": "The field to sort by. You can provide one sort order (`sortOrder`). Default order for TIMECREATED is descending. Default order for DISPLAYNAME is ascending. The DISPLAYNAME sort order is case sensitive.\n" }, { "name": "sortOrder", "value": "", "type": "query", "description": "The sort order to use, either ascending (`ASC`) or descending (`DESC`)." }, { "name": "lifecycleState", "value": "", "type": "query", "description": "A filter to return only resources that match the given lifecycle state exactly." }, { "name": "displayName", "value": "", "type": "query", "description": "A filter to return only resources that match the entire display name given. The match is not case sensitive." } ] }, "docs": "Lists the Scheduling Window resources in the specified compartment.\n" }, { "info": { "name": "CreateSchedulingWindow", "type": "http" }, "http": { "method": "POST", "url": "http://localhost:19222/20160918/schedulingPolicies/:schedulingPolicyId/schedulingWindows", "headers": [ { "name": "opc-retry-token", "value": "" }, { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "schedulingPolicyId", "value": "", "type": "path", "description": "The Scheduling Policy [OCID](/Content/General/Concepts/identifiers.htm)." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Creates a Scheduling Window resource.\n" }, { "info": { "name": "Get SchedulingWindow", "type": "http" }, "http": { "method": "GET", "url": "http://localhost:19222/20160918/schedulingPolicies/:schedulingPolicyId/schedulingWindows/:schedulingWindowId", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "schedulingPolicyId", "value": "", "type": "path", "description": "The Scheduling Policy [OCID](/Content/General/Concepts/identifiers.htm)." }, { "name": "schedulingWindowId", "value": "", "type": "path", "description": "The Scheduling Window [OCID](/Content/General/Concepts/identifiers.htm)." } ] }, "docs": "Gets information about the specified Scheduling Window.\n" }, { "info": { "name": "Updates the specified Scheduling Window", "type": "http" }, "http": { "method": "PUT", "url": "http://localhost:19222/20160918/schedulingPolicies/:schedulingPolicyId/schedulingWindows/:schedulingWindowId", "headers": [ { "name": "if-match", "value": "" }, { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "schedulingPolicyId", "value": "", "type": "path", "description": "The Scheduling Policy [OCID](/Content/General/Concepts/identifiers.htm)." }, { "name": "schedulingWindowId", "value": "", "type": "path", "description": "The Scheduling Window [OCID](/Content/General/Concepts/identifiers.htm)." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Updates the Scheduling Window resource.\n" }, { "info": { "name": "Delete a scheduling window.", "type": "http" }, "http": { "method": "DELETE", "url": "http://localhost:19222/20160918/schedulingPolicies/:schedulingPolicyId/schedulingWindows/:schedulingWindowId", "headers": [ { "name": "if-match", "value": "" }, { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "schedulingPolicyId", "value": "", "type": "path", "description": "The Scheduling Policy [OCID](/Content/General/Concepts/identifiers.htm)." }, { "name": "schedulingWindowId", "value": "", "type": "path", "description": "The Scheduling Window [OCID](/Content/General/Concepts/identifiers.htm)." } ] }, "docs": "Deletes the scheduling window.\n" }, { "info": { "name": "ListSystemVersions", "type": "http" }, "http": { "method": "GET", "url": "http://localhost:19222/20160918/systemVersions", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "compartmentId", "value": "", "type": "query", "description": "The compartment [OCID](/Content/General/Concepts/identifiers.htm)." }, { "name": "limit", "value": "", "type": "query", "description": "The maximum number of items to return per page." }, { "name": "page", "value": "", "type": "query", "description": "The pagination token to continue listing from." }, { "name": "sortOrder", "value": "", "type": "query", "description": "The sort order to use, either ascending (`ASC`) or descending (`DESC`)." }, { "name": "shape", "value": "", "type": "query", "description": "If provided, filters the results for the given shape." }, { "name": "isLatest", "value": "", "type": "query", "description": "If provided, return highest versions from each major version family." }, { "name": "resourceId", "value": "", "type": "query", "description": "If provided, filters the results for the specified resource Id." }, { "name": "giVersion", "value": "", "type": "query", "description": "Specifies gi version query parameter." } ] }, "docs": "Gets a list of supported Exadata system versions for a given shape and GI version." }, { "info": { "name": "ListSystemVersionMinorVersions", "type": "http" }, "http": { "method": "GET", "url": "http://localhost:19222/20160918/systemVersions/:majorVersion/minorVersions", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "majorVersion", "value": "", "type": "path", "description": "The System major version." }, { "name": "compartmentId", "value": "", "type": "query", "description": "The compartment [OCID](/Content/General/Concepts/identifiers.htm)." }, { "name": "limit", "value": "", "type": "query", "description": "The maximum number of items to return per page." }, { "name": "page", "value": "", "type": "query", "description": "The pagination token to continue listing from." }, { "name": "sortOrder", "value": "", "type": "query", "description": "The sort order to use, either ascending (`ASC`) or descending (`DESC`)." }, { "name": "giVersion", "value": "", "type": "query", "description": "Specifies gi version query parameter." }, { "name": "shape", "value": "", "type": "query", "description": "If provided, filters the results for the given shape." }, { "name": "resourceId", "value": "", "type": "query", "description": "If provided, filters the results for the specified resource Id." }, { "name": "isLatest", "value": "", "type": "query", "description": "If provided, return highest versions from each major version family." } ] }, "docs": "Retrieves a list of supported minor versions for the specified Exadata System Software major version. You must provide either a `shape` or `resourceId` value." }, { "info": { "name": "ListVmClusters", "type": "http" }, "http": { "method": "GET", "url": "http://localhost:19222/20160918/vmClusters", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "compartmentId", "value": "", "type": "query", "description": "The compartment [OCID](/Content/General/Concepts/identifiers.htm)." }, { "name": "exadataInfrastructureId", "value": "", "type": "query", "description": "If provided, filters the results for the given Exadata Infrastructure." }, { "name": "limit", "value": "", "type": "query", "description": "The maximum number of items to return per page." }, { "name": "page", "value": "", "type": "query", "description": "The pagination token to continue listing from." }, { "name": "sortBy", "value": "", "type": "query", "description": "The field to sort by. You can provide one sort order (`sortOrder`). Default order for TIMECREATED is descending. Default order for DISPLAYNAME is ascending. The DISPLAYNAME sort order is case sensitive.\n" }, { "name": "sortOrder", "value": "", "type": "query", "description": "The sort order to use, either ascending (`ASC`) or descending (`DESC`)." }, { "name": "lifecycleState", "value": "", "type": "query", "description": "A filter to return only resources that match the given lifecycle state exactly." }, { "name": "displayName", "value": "", "type": "query", "description": "A filter to return only resources that match the entire display name given. The match is not case sensitive." } ] }, "docs": "Lists the VM clusters in the specified compartment. Applies to Exadata Cloud@Customer instances only.\nTo list the cloud VM clusters in an Exadata Cloud Service instance, use the [ListCloudVmClusters ](#/en/database/latest/CloudVmCluster/ListCloudVmClusters) operation.\n" }, { "info": { "name": "CreateVmCluster", "type": "http" }, "http": { "method": "POST", "url": "http://localhost:19222/20160918/vmClusters", "headers": [ { "name": "opc-retry-token", "value": "" }, { "name": "opc-request-id", "value": "" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Creates an Exadata Cloud@Customer VM cluster.\n" }, { "info": { "name": "GetVmCluster", "type": "http" }, "http": { "method": "GET", "url": "http://localhost:19222/20160918/vmClusters/:vmClusterId", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "vmClusterId", "value": "", "type": "path", "description": "The VM cluster [OCID](/Content/General/Concepts/identifiers.htm)." } ] }, "docs": "Gets information about the VM cluster. Applies to Exadata Cloud@Customer instances only.\n" }, { "info": { "name": "Updates the specified VM cluster.", "type": "http" }, "http": { "method": "PUT", "url": "http://localhost:19222/20160918/vmClusters/:vmClusterId", "headers": [ { "name": "if-match", "value": "" }, { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "vmClusterId", "value": "", "type": "path", "description": "The VM cluster [OCID](/Content/General/Concepts/identifiers.htm)." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Updates the specified VM cluster. Applies to Exadata Cloud@Customer instances only.\n" }, { "info": { "name": "Deletes the specified VM cluster.", "type": "http" }, "http": { "method": "DELETE", "url": "http://localhost:19222/20160918/vmClusters/:vmClusterId", "headers": [ { "name": "if-match", "value": "" }, { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "vmClusterId", "value": "", "type": "path", "description": "The VM cluster [OCID](/Content/General/Concepts/identifiers.htm)." } ] }, "docs": "Deletes the specified VM cluster. Applies to Exadata Cloud@Customer instances only.\n" }, { "info": { "name": "AddVirtualMachineToVmCluster", "type": "http" }, "http": { "method": "POST", "url": "http://localhost:19222/20160918/vmClusters/:vmClusterId/actions/addVirtualMachine", "headers": [ { "name": "opc-retry-token", "value": "" }, { "name": "opc-request-id", "value": "" }, { "name": "if-match", "value": "" } ], "params": [ { "name": "vmClusterId", "value": "", "type": "path", "description": "The VM cluster [OCID](/Content/General/Concepts/identifiers.htm)." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Add Virtual Machines to the VM cluster. Applies to Exadata Cloud@Customer instances only.\n" }, { "info": { "name": "ChangeVmClusterCompartment", "type": "http" }, "http": { "method": "POST", "url": "http://localhost:19222/20160918/vmClusters/:vmClusterId/actions/changeCompartment", "headers": [ { "name": "opc-retry-token", "value": "" }, { "name": "opc-request-id", "value": "" }, { "name": "if-match", "value": "" } ], "params": [ { "name": "vmClusterId", "value": "", "type": "path", "description": "The VM cluster [OCID](/Content/General/Concepts/identifiers.htm)." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Moves a VM cluster and its dependent resources to another compartment. Applies to Exadata Cloud@Customer instances only.\nTo move a cloud VM cluster in an Exadata Cloud Service instance to another compartment, use the [ChangeCloudVmClusterCompartment ](#/en/database/latest/CloudVmCluster/ChangeCloudVmClusterCompartment) operation.\n" }, { "info": { "name": "RemoveVirtualMachineFromVmCluster", "type": "http" }, "http": { "method": "POST", "url": "http://localhost:19222/20160918/vmClusters/:vmClusterId/actions/removeVirtualMachine", "headers": [ { "name": "opc-retry-token", "value": "" }, { "name": "opc-request-id", "value": "" }, { "name": "if-match", "value": "" } ], "params": [ { "name": "vmClusterId", "value": "", "type": "path", "description": "The VM cluster [OCID](/Content/General/Concepts/identifiers.htm)." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Remove Virtual Machines from the VM cluster. Applies to Exadata Cloud@Customer instances only.\n" }, { "info": { "name": "ListVmClusterPatchHistoryEntries", "type": "http" }, "http": { "method": "GET", "url": "http://localhost:19222/20160918/vmClusters/:vmClusterId/patchHistoryEntries", "params": [ { "name": "vmClusterId", "value": "", "type": "path", "description": "The VM cluster [OCID](/Content/General/Concepts/identifiers.htm)." }, { "name": "limit", "value": "", "type": "query", "description": "The maximum number of items to return per page." }, { "name": "page", "value": "", "type": "query", "description": "The pagination token to continue listing from." } ] }, "docs": "Gets the history of the patch actions performed on the specified VM cluster in an Exadata Cloud@Customer system.\n" }, { "info": { "name": "GetVmClusterPatchHistoryEntry", "type": "http" }, "http": { "method": "GET", "url": "http://localhost:19222/20160918/vmClusters/:vmClusterId/patchHistoryEntries/:patchHistoryEntryId", "params": [ { "name": "vmClusterId", "value": "", "type": "path", "description": "The VM cluster [OCID](/Content/General/Concepts/identifiers.htm)." }, { "name": "patchHistoryEntryId", "value": "", "type": "path", "description": "The [OCID](/Content/General/Concepts/identifiers.htm) of the patch history entry." } ] }, "docs": "Gets the patch history details for the specified patch history entry.\n" }, { "info": { "name": "ListVmClusterPatches", "type": "http" }, "http": { "method": "GET", "url": "http://localhost:19222/20160918/vmClusters/:vmClusterId/patches", "params": [ { "name": "vmClusterId", "value": "", "type": "path", "description": "The VM cluster [OCID](/Content/General/Concepts/identifiers.htm)." }, { "name": "limit", "value": "", "type": "query", "description": "The maximum number of items to return per page." }, { "name": "page", "value": "", "type": "query", "description": "The pagination token to continue listing from." } ] }, "docs": "Lists the patches applicable to the specified VM cluster in an Exadata Cloud@Customer system.\n" }, { "info": { "name": "GetVmClusterPatch", "type": "http" }, "http": { "method": "GET", "url": "http://localhost:19222/20160918/vmClusters/:vmClusterId/patches/:patchId", "params": [ { "name": "vmClusterId", "value": "", "type": "path", "description": "The VM cluster [OCID](/Content/General/Concepts/identifiers.htm)." }, { "name": "patchId", "value": "", "type": "path", "description": "The [OCID](/Content/General/Concepts/identifiers.htm) of the patch." } ] }, "docs": "Gets information about a specified patch package.\n" }, { "info": { "name": "ListVmClusterUpdateHistoryEntries", "type": "http" }, "http": { "method": "GET", "url": "http://localhost:19222/20160918/vmClusters/:vmClusterId/updateHistoryEntries", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "vmClusterId", "value": "", "type": "path", "description": "The VM cluster [OCID](/Content/General/Concepts/identifiers.htm)." }, { "name": "updateType", "value": "", "type": "query", "description": "A filter to return only resources that match the given update type exactly." }, { "name": "lifecycleState", "value": "", "type": "query", "description": "A filter to return only resources that match the given lifecycle state exactly." }, { "name": "limit", "value": "", "type": "query", "description": "The maximum number of items to return per page." }, { "name": "page", "value": "", "type": "query", "description": "The pagination token to continue listing from." } ] }, "docs": "Gets the history of the maintenance update actions performed on the specified VM cluster. Applies to Exadata Cloud@Customer instances only.\n" }, { "info": { "name": "GetVmClusterUpdateHistoryEntry", "type": "http" }, "http": { "method": "GET", "url": "http://localhost:19222/20160918/vmClusters/:vmClusterId/updateHistoryEntries/:updateHistoryEntryId", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "vmClusterId", "value": "", "type": "path", "description": "The VM cluster [OCID](/Content/General/Concepts/identifiers.htm)." }, { "name": "updateHistoryEntryId", "value": "", "type": "path", "description": "The [OCID](/Content/General/Concepts/identifiers.htm) of the maintenance update history entry." } ] }, "docs": "Gets the maintenance update history details for the specified update history entry. Applies to Exadata Cloud@Customer instances only.\n" }, { "info": { "name": "ListVmClusterUpdates", "type": "http" }, "http": { "method": "GET", "url": "http://localhost:19222/20160918/vmClusters/:vmClusterId/updates", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "vmClusterId", "value": "", "type": "path", "description": "The VM cluster [OCID](/Content/General/Concepts/identifiers.htm)." }, { "name": "updateType", "value": "", "type": "query", "description": "A filter to return only resources that match the given update type exactly." }, { "name": "lifecycleState", "value": "", "type": "query", "description": "A filter to return only resources that match the given lifecycle state exactly." }, { "name": "limit", "value": "", "type": "query", "description": "The maximum number of items to return per page." }, { "name": "page", "value": "", "type": "query", "description": "The pagination token to continue listing from." } ] }, "docs": "Lists the maintenance updates that can be applied to the specified VM cluster. Applies to Exadata Cloud@Customer instances only.\n" }, { "info": { "name": "GetVmClusterUpdate", "type": "http" }, "http": { "method": "GET", "url": "http://localhost:19222/20160918/vmClusters/:vmClusterId/updates/:updateId", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "vmClusterId", "value": "", "type": "path", "description": "The VM cluster [OCID](/Content/General/Concepts/identifiers.htm)." }, { "name": "updateId", "value": "", "type": "path", "description": "The [OCID](/Content/General/Concepts/identifiers.htm) of the maintenance update." } ] }, "docs": "Gets information about a specified maintenance update package for a VM cluster. Applies to Exadata Cloud@Customer instances only.\n" } ] } ], "bundled": true }