{ "opencollection": "1.0.0", "info": { "name": "Database Management Db Management API", "version": "20201101" }, "items": [ { "info": { "name": "dbManagement", "type": "folder" }, "items": [ { "info": { "name": "Disables Database Management feature for a database.", "type": "http" }, "http": { "method": "POST", "url": "http://dbmgmt.{region}.oci.oraclecloud.com/20201101/autonomousDatabases/:autonomousDatabaseId/actions/disableDatabaseManagement", "headers": [ { "name": "opc-request-id", "value": "" }, { "name": "opc-retry-token", "value": "" }, { "name": "if-match", "value": "" } ], "params": [ { "name": "autonomousDatabaseId", "value": "", "type": "path", "description": "The [OCID](/Content/General/Concepts/identifiers.htm) of the Autonomous Database." } ] }, "docs": "Disables a Database Management feature for the specified Autonomous Database.\n" }, { "info": { "name": "Enables Database Management feature for the Autonomous Database.", "type": "http" }, "http": { "method": "POST", "url": "http://dbmgmt.{region}.oci.oraclecloud.com/20201101/autonomousDatabases/:autonomousDatabaseId/actions/enableDatabaseManagement", "headers": [ { "name": "opc-request-id", "value": "" }, { "name": "opc-retry-token", "value": "" }, { "name": "if-match", "value": "" } ], "params": [ { "name": "autonomousDatabaseId", "value": "", "type": "path", "description": "The [OCID](/Content/General/Concepts/identifiers.htm) of the Autonomous Database." } ] }, "docs": "Enables a Database Management feature for the specified Autonomous Database.\n" }, { "info": { "name": "Modifies Database Management feature for the Autonomous Database.", "type": "http" }, "http": { "method": "POST", "url": "http://dbmgmt.{region}.oci.oraclecloud.com/20201101/autonomousDatabases/:autonomousDatabaseId/actions/modifyDatabaseManagement", "headers": [ { "name": "opc-request-id", "value": "" }, { "name": "opc-retry-token", "value": "" }, { "name": "if-match", "value": "" } ], "params": [ { "name": "autonomousDatabaseId", "value": "", "type": "path", "description": "The [OCID](/Content/General/Concepts/identifiers.htm) of the Autonomous Database." } ] }, "docs": "Modifies the Database Management feature for the specified Autonomous Database.\n" }, { "info": { "name": "Lists the cloud ASM instances.", "type": "http" }, "http": { "method": "GET", "url": "http://dbmgmt.{region}.oci.oraclecloud.com/20201101/cloudAsmInstances", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "compartmentId", "value": "", "type": "query", "description": "The [OCID](/Content/General/Concepts/identifiers.htm) of the compartment." }, { "name": "cloudAsmId", "value": "", "type": "query", "description": "The [OCID](/Content/General/Concepts/identifiers.htm) of the cloud ASM." }, { "name": "displayName", "value": "", "type": "query", "description": "A filter to only return the resources that match the entire display name." }, { "name": "page", "value": "", "type": "query", "description": "The page token representing the page from where the next set of paginated results\nare retrieved. This is usually retrieved from a previous list call.\n" }, { "name": "limit", "value": "", "type": "query", "description": "The maximum number of records returned in the paginated response." }, { "name": "sortBy", "value": "", "type": "query", "description": "The field to sort information by. Only one sortOrder can be used. The default sort order\nfor `TIMECREATED` is descending and the default sort order for `DISPLAYNAME` is ascending.\nThe `DISPLAYNAME` sort order is case-sensitive.\n" }, { "name": "sortOrder", "value": "", "type": "query", "description": "The option to sort information in ascending (‘ASC’) or descending (‘DESC’) order. Ascending order is the default order." } ] }, "docs": "Lists the ASM instances in the specified cloud ASM." }, { "info": { "name": "Gets the cloud ASM instance details.", "type": "http" }, "http": { "method": "GET", "url": "http://dbmgmt.{region}.oci.oraclecloud.com/20201101/cloudAsmInstances/:cloudAsmInstanceId", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "cloudAsmInstanceId", "value": "", "type": "path", "description": "The [OCID](/Content/General/Concepts/identifiers.htm) of the cloud ASM instance." } ] }, "docs": "Gets the details for the cloud ASM instance specified by `cloudAsmInstanceId`.\n" }, { "info": { "name": "Updates a cloud ASM instance.", "type": "http" }, "http": { "method": "PUT", "url": "http://dbmgmt.{region}.oci.oraclecloud.com/20201101/cloudAsmInstances/:cloudAsmInstanceId", "headers": [ { "name": "opc-request-id", "value": "" }, { "name": "if-match", "value": "" } ], "params": [ { "name": "cloudAsmInstanceId", "value": "", "type": "path", "description": "The [OCID](/Content/General/Concepts/identifiers.htm) of the cloud ASM instance." } ] }, "docs": "Updates the cloud ASM instance specified by `cloudAsmInstanceId`.\n" }, { "info": { "name": "Lists the cloud ASMs.", "type": "http" }, "http": { "method": "GET", "url": "http://dbmgmt.{region}.oci.oraclecloud.com/20201101/cloudAsms", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "compartmentId", "value": "", "type": "query", "description": "The [OCID](/Content/General/Concepts/identifiers.htm) of the compartment." }, { "name": "cloudDbSystemId", "value": "", "type": "query", "description": "The [OCID](/Content/General/Concepts/identifiers.htm) of the cloud DB system." }, { "name": "displayName", "value": "", "type": "query", "description": "A filter to only return the resources that match the entire display name." }, { "name": "page", "value": "", "type": "query", "description": "The page token representing the page from where the next set of paginated results\nare retrieved. This is usually retrieved from a previous list call.\n" }, { "name": "limit", "value": "", "type": "query", "description": "The maximum number of records returned in the paginated response." }, { "name": "sortBy", "value": "", "type": "query", "description": "The field to sort information by. Only one sortOrder can be used. The default sort order\nfor `TIMECREATED` is descending and the default sort order for `DISPLAYNAME` is ascending.\nThe `DISPLAYNAME` sort order is case-sensitive.\n" }, { "name": "sortOrder", "value": "", "type": "query", "description": "The option to sort information in ascending (‘ASC’) or descending (‘DESC’) order. Ascending order is the default order." } ] }, "docs": "Lists the ASMs in the specified cloud DB system." }, { "info": { "name": "Gets the cloud ASM details.", "type": "http" }, "http": { "method": "GET", "url": "http://dbmgmt.{region}.oci.oraclecloud.com/20201101/cloudAsms/:cloudAsmId", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "cloudAsmId", "value": "", "type": "path", "description": "The [OCID](/Content/General/Concepts/identifiers.htm) of the cloud ASM." } ] }, "docs": "Gets the details for the cloud ASM specified by `cloudAsmId`.\n" }, { "info": { "name": "Updates a cloud ASM.", "type": "http" }, "http": { "method": "PUT", "url": "http://dbmgmt.{region}.oci.oraclecloud.com/20201101/cloudAsms/:cloudAsmId", "headers": [ { "name": "opc-request-id", "value": "" }, { "name": "if-match", "value": "" } ], "params": [ { "name": "cloudAsmId", "value": "", "type": "path", "description": "The [OCID](/Content/General/Concepts/identifiers.htm) of the cloud ASM." } ] }, "docs": "Updates the cloud ASM specified by `cloudAsmId`.\n" }, { "info": { "name": "Gets the cloud ASM configuration.", "type": "http" }, "http": { "method": "GET", "url": "http://dbmgmt.{region}.oci.oraclecloud.com/20201101/cloudAsms/:cloudAsmId/configuration", "headers": [ { "name": "opc-request-id", "value": "" }, { "name": "opc-named-credential-id", "value": "" } ], "params": [ { "name": "cloudAsmId", "value": "", "type": "path", "description": "The [OCID](/Content/General/Concepts/identifiers.htm) of the cloud ASM." } ] }, "docs": "Gets configuration details including disk groups for the cloud ASM specified by `cloudAsmId`.\n" }, { "info": { "name": "Lists the cloud ASM disk groups.", "type": "http" }, "http": { "method": "GET", "url": "http://dbmgmt.{region}.oci.oraclecloud.com/20201101/cloudAsms/:cloudAsmId/diskGroups", "headers": [ { "name": "opc-request-id", "value": "" }, { "name": "opc-named-credential-id", "value": "" } ], "params": [ { "name": "cloudAsmId", "value": "", "type": "path", "description": "The [OCID](/Content/General/Concepts/identifiers.htm) of the cloud ASM." }, { "name": "page", "value": "", "type": "query", "description": "The page token representing the page from where the next set of paginated results\nare retrieved. This is usually retrieved from a previous list call.\n" }, { "name": "limit", "value": "", "type": "query", "description": "The maximum number of records returned in the paginated response." }, { "name": "sortBy", "value": "", "type": "query", "description": "The field to sort information by. Only one sortOrder can be used. The\ndefault sort order for `NAME` is ascending and it is case-sensitive.\n" }, { "name": "sortOrder", "value": "", "type": "query", "description": "The option to sort information in ascending (‘ASC’) or descending (‘DESC’) order. Ascending order is the default order." } ] }, "docs": "Lists ASM disk groups for the cloud ASM specified by `cloudAsmId`.\n" }, { "info": { "name": "Gets the cloud ASM metrics.", "type": "http" }, "http": { "method": "GET", "url": "http://dbmgmt.{region}.oci.oraclecloud.com/20201101/cloudAsms/:cloudAsmId/metrics", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "cloudAsmId", "value": "", "type": "path", "description": "The [OCID](/Content/General/Concepts/identifiers.htm) of the cloud ASM." }, { "name": "page", "value": "", "type": "query", "description": "The page token representing the page from where the next set of paginated results\nare retrieved. This is usually retrieved from a previous list call.\n" }, { "name": "limit", "value": "", "type": "query", "description": "The maximum number of records returned in the paginated response." }, { "name": "startTime", "value": "", "type": "query", "description": "The beginning of the time range set to retrieve metric data for the DB system\nand its members. Expressed in UTC in ISO-8601 format, which is `yyyy-MM-dd'T'hh:mm:ss.sss'Z'`.\n" }, { "name": "endTime", "value": "", "type": "query", "description": "The end of the time range set to retrieve metric data for the DB system\nand its members. Expressed in UTC in ISO-8601 format, which is `yyyy-MM-dd'T'hh:mm:ss.sss'Z'`.\n" }, { "name": "filterByMetricNames", "value": "", "type": "query", "description": "The filter used to retrieve a specific set of metrics by passing the desired metric names with a comma separator. Note that, by default, the service returns all supported metrics." } ] }, "docs": "Gets metrics for the cloud ASM specified by `cloudAsmId`.\n" }, { "info": { "name": "Lists the cloud ASM users.", "type": "http" }, "http": { "method": "GET", "url": "http://dbmgmt.{region}.oci.oraclecloud.com/20201101/cloudAsms/:cloudAsmId/users", "headers": [ { "name": "opc-request-id", "value": "" }, { "name": "opc-named-credential-id", "value": "" } ], "params": [ { "name": "cloudAsmId", "value": "", "type": "path", "description": "The [OCID](/Content/General/Concepts/identifiers.htm) of the cloud ASM." }, { "name": "page", "value": "", "type": "query", "description": "The page token representing the page from where the next set of paginated results\nare retrieved. This is usually retrieved from a previous list call.\n" }, { "name": "limit", "value": "", "type": "query", "description": "The maximum number of records returned in the paginated response." }, { "name": "sortBy", "value": "", "type": "query", "description": "The field to sort information by. Only one sortOrder can be used. The\ndefault sort order for `NAME` is ascending and it is case-sensitive.\n" }, { "name": "sortOrder", "value": "", "type": "query", "description": "The option to sort information in ascending (‘ASC’) or descending (‘DESC’) order. Ascending order is the default order." } ] }, "docs": "Lists ASM users for the cloud ASM specified by `cloudAsmId`.\n" }, { "info": { "name": "Lists the cloud cluster instances.", "type": "http" }, "http": { "method": "GET", "url": "http://dbmgmt.{region}.oci.oraclecloud.com/20201101/cloudClusterInstances", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "compartmentId", "value": "", "type": "query", "description": "The [OCID](/Content/General/Concepts/identifiers.htm) of the compartment." }, { "name": "cloudClusterId", "value": "", "type": "query", "description": "The [OCID](/Content/General/Concepts/identifiers.htm) of the cloud cluster." }, { "name": "displayName", "value": "", "type": "query", "description": "A filter to only return the resources that match the entire display name." }, { "name": "page", "value": "", "type": "query", "description": "The page token representing the page from where the next set of paginated results\nare retrieved. This is usually retrieved from a previous list call.\n" }, { "name": "limit", "value": "", "type": "query", "description": "The maximum number of records returned in the paginated response." }, { "name": "sortBy", "value": "", "type": "query", "description": "The field to sort information by. Only one sortOrder can be used. The default sort order\nfor `TIMECREATED` is descending and the default sort order for `DISPLAYNAME` is ascending.\nThe `DISPLAYNAME` sort order is case-sensitive.\n" }, { "name": "sortOrder", "value": "", "type": "query", "description": "The option to sort information in ascending (‘ASC’) or descending (‘DESC’) order. Ascending order is the default order." } ] }, "docs": "Lists the cluster instances in the specified cloud cluster." }, { "info": { "name": "Gets the cloud cluster instance details.", "type": "http" }, "http": { "method": "GET", "url": "http://dbmgmt.{region}.oci.oraclecloud.com/20201101/cloudClusterInstances/:cloudClusterInstanceId", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "cloudClusterInstanceId", "value": "", "type": "path", "description": "The [OCID](/Content/General/Concepts/identifiers.htm) of the cloud cluster instance." } ] }, "docs": "Gets the details for the cloud cluster instance specified by `cloudClusterInstanceId`.\n" }, { "info": { "name": "Updates a cloud cluster instance.", "type": "http" }, "http": { "method": "PUT", "url": "http://dbmgmt.{region}.oci.oraclecloud.com/20201101/cloudClusterInstances/:cloudClusterInstanceId", "headers": [ { "name": "opc-request-id", "value": "" }, { "name": "if-match", "value": "" } ], "params": [ { "name": "cloudClusterInstanceId", "value": "", "type": "path", "description": "The [OCID](/Content/General/Concepts/identifiers.htm) of the cloud cluster instance." } ] }, "docs": "Updates the cloud cluster instance specified by `cloudClusterInstanceId`.\n" }, { "info": { "name": "Lists the cloud clusters.", "type": "http" }, "http": { "method": "GET", "url": "http://dbmgmt.{region}.oci.oraclecloud.com/20201101/cloudClusters", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "compartmentId", "value": "", "type": "query", "description": "The [OCID](/Content/General/Concepts/identifiers.htm) of the compartment." }, { "name": "cloudDbSystemId", "value": "", "type": "query", "description": "The [OCID](/Content/General/Concepts/identifiers.htm) of the cloud DB system." }, { "name": "displayName", "value": "", "type": "query", "description": "A filter to only return the resources that match the entire display name." }, { "name": "page", "value": "", "type": "query", "description": "The page token representing the page from where the next set of paginated results\nare retrieved. This is usually retrieved from a previous list call.\n" }, { "name": "limit", "value": "", "type": "query", "description": "The maximum number of records returned in the paginated response." }, { "name": "sortBy", "value": "", "type": "query", "description": "The field to sort information by. Only one sortOrder can be used. The default sort order\nfor `TIMECREATED` is descending and the default sort order for `DISPLAYNAME` is ascending.\nThe `DISPLAYNAME` sort order is case-sensitive.\n" }, { "name": "sortOrder", "value": "", "type": "query", "description": "The option to sort information in ascending (‘ASC’) or descending (‘DESC’) order. Ascending order is the default order." } ] }, "docs": "Lists the clusters in the specified cloud DB system." }, { "info": { "name": "Gets the cloud cluster details.", "type": "http" }, "http": { "method": "GET", "url": "http://dbmgmt.{region}.oci.oraclecloud.com/20201101/cloudClusters/:cloudClusterId", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "cloudClusterId", "value": "", "type": "path", "description": "The [OCID](/Content/General/Concepts/identifiers.htm) of the cloud cluster." } ] }, "docs": "Gets the details for the cloud cluster specified by `cloudClusterId`.\n" }, { "info": { "name": "Updates a cloud cluster.", "type": "http" }, "http": { "method": "PUT", "url": "http://dbmgmt.{region}.oci.oraclecloud.com/20201101/cloudClusters/:cloudClusterId", "headers": [ { "name": "opc-request-id", "value": "" }, { "name": "if-match", "value": "" } ], "params": [ { "name": "cloudClusterId", "value": "", "type": "path", "description": "The [OCID](/Content/General/Concepts/identifiers.htm) of the cloud cluster." } ] }, "docs": "Updates the cloud cluster specified by `cloudClusterId`.\n" }, { "info": { "name": "Gets the cloud cluster metrics.", "type": "http" }, "http": { "method": "GET", "url": "http://dbmgmt.{region}.oci.oraclecloud.com/20201101/cloudClusters/:cloudClusterId/metrics", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "cloudClusterId", "value": "", "type": "path", "description": "The [OCID](/Content/General/Concepts/identifiers.htm) of the cloud cluster." }, { "name": "page", "value": "", "type": "query", "description": "The page token representing the page from where the next set of paginated results\nare retrieved. This is usually retrieved from a previous list call.\n" }, { "name": "limit", "value": "", "type": "query", "description": "The maximum number of records returned in the paginated response." }, { "name": "startTime", "value": "", "type": "query", "description": "The beginning of the time range set to retrieve metric data for the DB system\nand its members. Expressed in UTC in ISO-8601 format, which is `yyyy-MM-dd'T'hh:mm:ss.sss'Z'`.\n" }, { "name": "endTime", "value": "", "type": "query", "description": "The end of the time range set to retrieve metric data for the DB system\nand its members. Expressed in UTC in ISO-8601 format, which is `yyyy-MM-dd'T'hh:mm:ss.sss'Z'`.\n" }, { "name": "filterByMetricNames", "value": "", "type": "query", "description": "The filter used to retrieve a specific set of metrics by passing the desired metric names with a comma separator. Note that, by default, the service returns all supported metrics." } ] }, "docs": "Gets metrics for the cloud cluster specified by `cloudClusterId`.\n" }, { "info": { "name": "Lists the cloud databases in a cloud database system.", "type": "http" }, "http": { "method": "GET", "url": "http://dbmgmt.{region}.oci.oraclecloud.com/20201101/cloudDatabases", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "compartmentId", "value": "", "type": "query", "description": "The [OCID](/Content/General/Concepts/identifiers.htm) of the compartment." }, { "name": "cloudDbSystemId", "value": "", "type": "query", "description": "The [OCID](/Content/General/Concepts/identifiers.htm) of the cloud DB system." }, { "name": "displayName", "value": "", "type": "query", "description": "A filter to only return the resources that match the entire display name." }, { "name": "page", "value": "", "type": "query", "description": "The page token representing the page from where the next set of paginated results\nare retrieved. This is usually retrieved from a previous list call.\n" }, { "name": "limit", "value": "", "type": "query", "description": "The maximum number of records returned in the paginated response." }, { "name": "sortBy", "value": "", "type": "query", "description": "The field to sort information by. Only one sortOrder can be used. The default sort order\nfor `TIMECREATED` is descending and the default sort order for `DISPLAYNAME` is ascending.\nThe `DISPLAYNAME` sort order is case-sensitive.\n" }, { "name": "sortOrder", "value": "", "type": "query", "description": "The option to sort information in ascending (‘ASC’) or descending (‘DESC’) order. Ascending order is the default order." } ] }, "docs": "Lists the cloud databases in the specified compartment or in the specified DB system." }, { "info": { "name": "Lists the cloud DB homes.", "type": "http" }, "http": { "method": "GET", "url": "http://dbmgmt.{region}.oci.oraclecloud.com/20201101/cloudDbHomes", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "compartmentId", "value": "", "type": "query", "description": "The [OCID](/Content/General/Concepts/identifiers.htm) of the compartment." }, { "name": "cloudDbSystemId", "value": "", "type": "query", "description": "The [OCID](/Content/General/Concepts/identifiers.htm) of the cloud DB system." }, { "name": "displayName", "value": "", "type": "query", "description": "A filter to only return the resources that match the entire display name." }, { "name": "page", "value": "", "type": "query", "description": "The page token representing the page from where the next set of paginated results\nare retrieved. This is usually retrieved from a previous list call.\n" }, { "name": "limit", "value": "", "type": "query", "description": "The maximum number of records returned in the paginated response." }, { "name": "sortBy", "value": "", "type": "query", "description": "The field to sort information by. Only one sortOrder can be used. The default sort order\nfor `TIMECREATED` is descending and the default sort order for `DISPLAYNAME` is ascending.\nThe `DISPLAYNAME` sort order is case-sensitive.\n" }, { "name": "sortOrder", "value": "", "type": "query", "description": "The option to sort information in ascending (‘ASC’) or descending (‘DESC’) order. Ascending order is the default order." } ] }, "docs": "Lists the DB homes in the specified cloud DB system." }, { "info": { "name": "Gets the cloud DB home details.", "type": "http" }, "http": { "method": "GET", "url": "http://dbmgmt.{region}.oci.oraclecloud.com/20201101/cloudDbHomes/:cloudDbHomeId", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "cloudDbHomeId", "value": "", "type": "path", "description": "The [OCID](/Content/General/Concepts/identifiers.htm) of the cloud database home." } ] }, "docs": "Gets the details for the cloud DB home specified by `cloudDbHomeId`.\n" }, { "info": { "name": "Updates a cloud DB home.", "type": "http" }, "http": { "method": "PUT", "url": "http://dbmgmt.{region}.oci.oraclecloud.com/20201101/cloudDbHomes/:cloudDbHomeId", "headers": [ { "name": "opc-request-id", "value": "" }, { "name": "if-match", "value": "" } ], "params": [ { "name": "cloudDbHomeId", "value": "", "type": "path", "description": "The [OCID](/Content/General/Concepts/identifiers.htm) of the cloud database home." } ] }, "docs": "Updates the cloud DB home specified by `cloudDbHomeId`.\n" }, { "info": { "name": "Lists the cloud DB nodes.", "type": "http" }, "http": { "method": "GET", "url": "http://dbmgmt.{region}.oci.oraclecloud.com/20201101/cloudDbNodes", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "compartmentId", "value": "", "type": "query", "description": "The [OCID](/Content/General/Concepts/identifiers.htm) of the compartment." }, { "name": "cloudDbSystemId", "value": "", "type": "query", "description": "The [OCID](/Content/General/Concepts/identifiers.htm) of the cloud DB system." }, { "name": "displayName", "value": "", "type": "query", "description": "A filter to only return the resources that match the entire display name." }, { "name": "page", "value": "", "type": "query", "description": "The page token representing the page from where the next set of paginated results\nare retrieved. This is usually retrieved from a previous list call.\n" }, { "name": "limit", "value": "", "type": "query", "description": "The maximum number of records returned in the paginated response." }, { "name": "sortBy", "value": "", "type": "query", "description": "The field to sort information by. Only one sortOrder can be used. The default sort order\nfor `TIMECREATED` is descending and the default sort order for `DISPLAYNAME` is ascending.\nThe `DISPLAYNAME` sort order is case-sensitive.\n" }, { "name": "sortOrder", "value": "", "type": "query", "description": "The option to sort information in ascending (‘ASC’) or descending (‘DESC’) order. Ascending order is the default order." } ] }, "docs": "Lists the cloud DB nodes in the specified cloud DB system." }, { "info": { "name": "Gets the cloud DB node details.", "type": "http" }, "http": { "method": "GET", "url": "http://dbmgmt.{region}.oci.oraclecloud.com/20201101/cloudDbNodes/:cloudDbNodeId", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "cloudDbNodeId", "value": "", "type": "path", "description": "The [OCID](/Content/General/Concepts/identifiers.htm) of the cloud database node." } ] }, "docs": "Gets the details for the cloud DB node specified by `cloudDbNodeId`.\n" }, { "info": { "name": "Updates a cloud DB node.", "type": "http" }, "http": { "method": "PUT", "url": "http://dbmgmt.{region}.oci.oraclecloud.com/20201101/cloudDbNodes/:cloudDbNodeId", "headers": [ { "name": "opc-request-id", "value": "" }, { "name": "if-match", "value": "" } ], "params": [ { "name": "cloudDbNodeId", "value": "", "type": "path", "description": "The [OCID](/Content/General/Concepts/identifiers.htm) of the cloud database node." } ] }, "docs": "Updates the cloud DB node specified by `cloudDbNodeId`.\n" }, { "info": { "name": "Gets the cloud DB nodemetrics.", "type": "http" }, "http": { "method": "GET", "url": "http://dbmgmt.{region}.oci.oraclecloud.com/20201101/cloudDbNodes/:cloudDbNodeId/metrics", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "cloudDbNodeId", "value": "", "type": "path", "description": "The [OCID](/Content/General/Concepts/identifiers.htm) of the cloud database node." }, { "name": "page", "value": "", "type": "query", "description": "The page token representing the page from where the next set of paginated results\nare retrieved. This is usually retrieved from a previous list call.\n" }, { "name": "limit", "value": "", "type": "query", "description": "The maximum number of records returned in the paginated response." }, { "name": "startTime", "value": "", "type": "query", "description": "The beginning of the time range set to retrieve metric data for the DB system\nand its members. Expressed in UTC in ISO-8601 format, which is `yyyy-MM-dd'T'hh:mm:ss.sss'Z'`.\n" }, { "name": "endTime", "value": "", "type": "query", "description": "The end of the time range set to retrieve metric data for the DB system\nand its members. Expressed in UTC in ISO-8601 format, which is `yyyy-MM-dd'T'hh:mm:ss.sss'Z'`.\n" }, { "name": "filterByMetricNames", "value": "", "type": "query", "description": "The filter used to retrieve a specific set of metrics by passing the desired metric names with a comma separator. Note that, by default, the service returns all supported metrics." } ] }, "docs": "Gets metrics for the cloud DB node specified by `cloudDbNodeId`.\n" }, { "info": { "name": "Lists the cloud connectors.", "type": "http" }, "http": { "method": "GET", "url": "http://dbmgmt.{region}.oci.oraclecloud.com/20201101/cloudDbSystemConnectors", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "compartmentId", "value": "", "type": "query", "description": "The [OCID](/Content/General/Concepts/identifiers.htm) of the compartment." }, { "name": "cloudDbSystemId", "value": "", "type": "query", "description": "The [OCID](/Content/General/Concepts/identifiers.htm) of the cloud DB system." }, { "name": "displayName", "value": "", "type": "query", "description": "A filter to only return the resources that match the entire display name." }, { "name": "page", "value": "", "type": "query", "description": "The page token representing the page from where the next set of paginated results\nare retrieved. This is usually retrieved from a previous list call.\n" }, { "name": "limit", "value": "", "type": "query", "description": "The maximum number of records returned in the paginated response." }, { "name": "sortBy", "value": "", "type": "query", "description": "The field to sort information by. Only one sortOrder can be used. The default sort order\nfor `TIMECREATED` is descending and the default sort order for `DISPLAYNAME` is ascending.\nThe `DISPLAYNAME` sort order is case-sensitive.\n" }, { "name": "sortOrder", "value": "", "type": "query", "description": "The option to sort information in ascending (‘ASC’) or descending (‘DESC’) order. Ascending order is the default order." } ] }, "docs": "Lists the cloud connectors in the specified cloud DB system." }, { "info": { "name": "Creates a cloud connector.", "type": "http" }, "http": { "method": "POST", "url": "http://dbmgmt.{region}.oci.oraclecloud.com/20201101/cloudDbSystemConnectors", "headers": [ { "name": "opc-request-id", "value": "" }, { "name": "opc-retry-token", "value": "" } ] }, "docs": "Creates a new cloud connector." }, { "info": { "name": "Gets the cloud connector details.", "type": "http" }, "http": { "method": "GET", "url": "http://dbmgmt.{region}.oci.oraclecloud.com/20201101/cloudDbSystemConnectors/:cloudDbSystemConnectorId", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "cloudDbSystemConnectorId", "value": "", "type": "path", "description": "The [OCID](/Content/General/Concepts/identifiers.htm) of the cloud connector." } ] }, "docs": "Gets the details for the cloud connector specified by `cloudDbSystemConnectorId`.\n" }, { "info": { "name": "Updates a cloud connector.", "type": "http" }, "http": { "method": "PUT", "url": "http://dbmgmt.{region}.oci.oraclecloud.com/20201101/cloudDbSystemConnectors/:cloudDbSystemConnectorId", "headers": [ { "name": "if-match", "value": "" }, { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "cloudDbSystemConnectorId", "value": "", "type": "path", "description": "The [OCID](/Content/General/Concepts/identifiers.htm) of the cloud connector." } ] }, "docs": "Updates the cloud connector specified by `cloudDbSystemConnectorId`." }, { "info": { "name": "Deletes the cloud connector.", "type": "http" }, "http": { "method": "DELETE", "url": "http://dbmgmt.{region}.oci.oraclecloud.com/20201101/cloudDbSystemConnectors/:cloudDbSystemConnectorId", "headers": [ { "name": "opc-request-id", "value": "" }, { "name": "if-match", "value": "" } ], "params": [ { "name": "cloudDbSystemConnectorId", "value": "", "type": "path", "description": "The [OCID](/Content/General/Concepts/identifiers.htm) of the cloud connector." } ] }, "docs": "Deletes the cloud connector specified by `cloudDbSystemConnectorId`.\n" }, { "info": { "name": "Checks the connectivity status of a cloud connector.", "type": "http" }, "http": { "method": "POST", "url": "http://dbmgmt.{region}.oci.oraclecloud.com/20201101/cloudDbSystemConnectors/:cloudDbSystemConnectorId/actions/checkConnectionStatus", "headers": [ { "name": "if-match", "value": "" }, { "name": "opc-request-id", "value": "" }, { "name": "opc-retry-token", "value": "" } ], "params": [ { "name": "cloudDbSystemConnectorId", "value": "", "type": "path", "description": "The [OCID](/Content/General/Concepts/identifiers.htm) of the cloud connector." } ] }, "docs": "Checks the status of the cloud DB system component connection specified in this connector.\nThis operation will refresh the connectionStatus and timeConnectionStatusLastUpdated fields.\n" }, { "info": { "name": "Lists the cloud DB system discovery resources.", "type": "http" }, "http": { "method": "GET", "url": "http://dbmgmt.{region}.oci.oraclecloud.com/20201101/cloudDbSystemDiscoveries", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "compartmentId", "value": "", "type": "query", "description": "The [OCID](/Content/General/Concepts/identifiers.htm) of the compartment." }, { "name": "displayName", "value": "", "type": "query", "description": "A filter to only return the resources that match the entire display name." }, { "name": "page", "value": "", "type": "query", "description": "The page token representing the page from where the next set of paginated results\nare retrieved. This is usually retrieved from a previous list call.\n" }, { "name": "limit", "value": "", "type": "query", "description": "The maximum number of records returned in the paginated response." }, { "name": "sortBy", "value": "", "type": "query", "description": "The field to sort information by. Only one sortOrder can be used. The default sort order\nfor `TIMECREATED` is descending and the default sort order for `DISPLAYNAME` is ascending.\nThe `DISPLAYNAME` sort order is case-sensitive.\n" }, { "name": "sortOrder", "value": "", "type": "query", "description": "The option to sort information in ascending (‘ASC’) or descending (‘DESC’) order. Ascending order is the default order." } ] }, "docs": "Lists the cloud DB system discovery resources in the specified compartment." }, { "info": { "name": "Creates a cloud DB system discovery resource.", "type": "http" }, "http": { "method": "POST", "url": "http://dbmgmt.{region}.oci.oraclecloud.com/20201101/cloudDbSystemDiscoveries", "headers": [ { "name": "opc-request-id", "value": "" }, { "name": "opc-retry-token", "value": "" } ] }, "docs": "Creates a cloud DB system discovery resource and initiates the discovery process.\n" }, { "info": { "name": "Gets the cloud DB system discovery details.", "type": "http" }, "http": { "method": "GET", "url": "http://dbmgmt.{region}.oci.oraclecloud.com/20201101/cloudDbSystemDiscoveries/:cloudDbSystemDiscoveryId", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "cloudDbSystemDiscoveryId", "value": "", "type": "path", "description": "The [OCID](/Content/General/Concepts/identifiers.htm) of the cloud DB system discovery." } ] }, "docs": "Gets the details for the cloud DB system discovery resource specified by `cloudDbSystemDiscoveryId`.\n" }, { "info": { "name": "Updates a cloud DB system discovery.", "type": "http" }, "http": { "method": "PUT", "url": "http://dbmgmt.{region}.oci.oraclecloud.com/20201101/cloudDbSystemDiscoveries/:cloudDbSystemDiscoveryId", "headers": [ { "name": "opc-request-id", "value": "" }, { "name": "if-match", "value": "" } ], "params": [ { "name": "cloudDbSystemDiscoveryId", "value": "", "type": "path", "description": "The [OCID](/Content/General/Concepts/identifiers.htm) of the cloud DB system discovery." } ] }, "docs": "Updates the cloud DB system discovery specified by `cloudDbSystemDiscoveryId`.\n" }, { "info": { "name": "Updates a cloud DB system discovery.", "type": "http" }, "http": { "method": "PATCH", "url": "http://dbmgmt.{region}.oci.oraclecloud.com/20201101/cloudDbSystemDiscoveries/:cloudDbSystemDiscoveryId", "headers": [ { "name": "opc-request-id", "value": "" }, { "name": "if-match", "value": "" } ], "params": [ { "name": "cloudDbSystemDiscoveryId", "value": "", "type": "path", "description": "The [OCID](/Content/General/Concepts/identifiers.htm) of the cloud DB system discovery." } ] }, "docs": "Patches the cloud DB system discovery specified by `cloudDbSystemDiscoveryId`.\n" }, { "info": { "name": "Deletes the cloud DB system discovery resource.", "type": "http" }, "http": { "method": "DELETE", "url": "http://dbmgmt.{region}.oci.oraclecloud.com/20201101/cloudDbSystemDiscoveries/:cloudDbSystemDiscoveryId", "headers": [ { "name": "opc-request-id", "value": "" }, { "name": "if-match", "value": "" } ], "params": [ { "name": "cloudDbSystemDiscoveryId", "value": "", "type": "path", "description": "The [OCID](/Content/General/Concepts/identifiers.htm) of the cloud DB system discovery." } ] }, "docs": "Deletes the cloud DB system discovery resource specified by `cloudDbSystemDiscoveryId`.\n" }, { "info": { "name": "Lists the cloud DB systems.", "type": "http" }, "http": { "method": "GET", "url": "http://dbmgmt.{region}.oci.oraclecloud.com/20201101/cloudDbSystems", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "compartmentId", "value": "", "type": "query", "description": "The [OCID](/Content/General/Concepts/identifiers.htm) of the compartment." }, { "name": "dbaasParentInfrastructureId", "value": "", "type": "query", "description": "The [OCID](/Content/General/Concepts/identifiers.htm) of the dbaas parent infrastructure of the cloud DB system." }, { "name": "deploymentType", "value": "", "type": "query", "description": "A filter to return cloud DB systems of the specified deployment type." }, { "name": "displayName", "value": "", "type": "query", "description": "A filter to only return the resources that match the entire display name." }, { "name": "lifecycleState", "value": "", "type": "query", "description": "The lifecycle state of a resource." }, { "name": "page", "value": "", "type": "query", "description": "The page token representing the page from where the next set of paginated results\nare retrieved. This is usually retrieved from a previous list call.\n" }, { "name": "limit", "value": "", "type": "query", "description": "The maximum number of records returned in the paginated response." }, { "name": "sortBy", "value": "", "type": "query", "description": "The field to sort information by. Only one sortOrder can be used. The default sort order\nfor `TIMECREATED` is descending and the default sort order for `DISPLAYNAME` is ascending.\nThe `DISPLAYNAME` sort order is case-sensitive.\n" }, { "name": "sortOrder", "value": "", "type": "query", "description": "The option to sort information in ascending (‘ASC’) or descending (‘DESC’) order. Ascending order is the default order." } ] }, "docs": "Lists the cloud DB systems in the specified compartment." }, { "info": { "name": "Creates a cloud DB system.", "type": "http" }, "http": { "method": "POST", "url": "http://dbmgmt.{region}.oci.oraclecloud.com/20201101/cloudDbSystems", "headers": [ { "name": "opc-request-id", "value": "" }, { "name": "opc-retry-token", "value": "" } ] }, "docs": "Creates a cloud DB system and its related resources.\n" }, { "info": { "name": "Gets the cloud DB system details.", "type": "http" }, "http": { "method": "GET", "url": "http://dbmgmt.{region}.oci.oraclecloud.com/20201101/cloudDbSystems/:cloudDbSystemId", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "cloudDbSystemId", "value": "", "type": "path", "description": "The [OCID](/Content/General/Concepts/identifiers.htm) of the cloud DB system." } ] }, "docs": "Gets the details for the cloud DB system specified by `cloudDbSystemId`.\n" }, { "info": { "name": "Updates a cloud DB system.", "type": "http" }, "http": { "method": "PUT", "url": "http://dbmgmt.{region}.oci.oraclecloud.com/20201101/cloudDbSystems/:cloudDbSystemId", "headers": [ { "name": "opc-request-id", "value": "" }, { "name": "if-match", "value": "" } ], "params": [ { "name": "cloudDbSystemId", "value": "", "type": "path", "description": "The [OCID](/Content/General/Concepts/identifiers.htm) of the cloud DB system." } ] }, "docs": "Updates the cloud DB system specified by `cloudDbSystemId`.\n" }, { "info": { "name": "Deletes the cloud DB system.", "type": "http" }, "http": { "method": "DELETE", "url": "http://dbmgmt.{region}.oci.oraclecloud.com/20201101/cloudDbSystems/:cloudDbSystemId", "headers": [ { "name": "opc-request-id", "value": "" }, { "name": "if-match", "value": "" } ], "params": [ { "name": "cloudDbSystemId", "value": "", "type": "path", "description": "The [OCID](/Content/General/Concepts/identifiers.htm) of the cloud DB system." } ] }, "docs": "Deletes the cloud DB system specified by `cloudDbSystemId`.\n" }, { "info": { "name": "Disables Database Management service for the cloud DB system.", "type": "http" }, "http": { "method": "POST", "url": "http://dbmgmt.{region}.oci.oraclecloud.com/20201101/cloudDbSystems/:cloudDbSystemId/actions/disableDatabaseManagement", "headers": [ { "name": "opc-request-id", "value": "" }, { "name": "opc-retry-token", "value": "" }, { "name": "if-match", "value": "" } ], "params": [ { "name": "cloudDbSystemId", "value": "", "type": "path", "description": "The [OCID](/Content/General/Concepts/identifiers.htm) of the cloud DB system." } ] }, "docs": "Disables Database Management service for all the components of the specified\ncloud DB system (except databases).\n" }, { "info": { "name": "Disables Stack monitoring service for the cloud DB system.", "type": "http" }, "http": { "method": "POST", "url": "http://dbmgmt.{region}.oci.oraclecloud.com/20201101/cloudDbSystems/:cloudDbSystemId/actions/disableStackMonitoring", "headers": [ { "name": "opc-request-id", "value": "" }, { "name": "opc-retry-token", "value": "" }, { "name": "if-match", "value": "" } ], "params": [ { "name": "cloudDbSystemId", "value": "", "type": "path", "description": "The [OCID](/Content/General/Concepts/identifiers.htm) of the cloud DB system." } ] }, "docs": "Disables Stack Monitoring for all the components of the specified\ncloud DB system (except databases).\n" }, { "info": { "name": "Enables Database Management service for the cloud DB system.", "type": "http" }, "http": { "method": "POST", "url": "http://dbmgmt.{region}.oci.oraclecloud.com/20201101/cloudDbSystems/:cloudDbSystemId/actions/enableDatabaseManagement", "headers": [ { "name": "opc-request-id", "value": "" }, { "name": "opc-retry-token", "value": "" }, { "name": "if-match", "value": "" } ], "params": [ { "name": "cloudDbSystemId", "value": "", "type": "path", "description": "The [OCID](/Content/General/Concepts/identifiers.htm) of the cloud DB system." } ] }, "docs": "Enables Database Management service for all the components of the specified\ncloud DB system (except databases).\n" }, { "info": { "name": "Enables Stack Monitoring service for the cloud DB system.", "type": "http" }, "http": { "method": "POST", "url": "http://dbmgmt.{region}.oci.oraclecloud.com/20201101/cloudDbSystems/:cloudDbSystemId/actions/enableStackMonitoring", "headers": [ { "name": "opc-request-id", "value": "" }, { "name": "opc-retry-token", "value": "" }, { "name": "if-match", "value": "" } ], "params": [ { "name": "cloudDbSystemId", "value": "", "type": "path", "description": "The [OCID](/Content/General/Concepts/identifiers.htm) of the cloud DB system." } ] }, "docs": "Enables Stack Monitoring for all the components of the specified\ncloud DB system (except databases).\n" }, { "info": { "name": "Gets availability metrics for the cloud DB system components.", "type": "http" }, "http": { "method": "GET", "url": "http://dbmgmt.{region}.oci.oraclecloud.com/20201101/cloudDbSystems/:cloudDbSystemId/availabilityMetrics", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "cloudDbSystemId", "value": "", "type": "path", "description": "The [OCID](/Content/General/Concepts/identifiers.htm) of the cloud DB system." }, { "name": "page", "value": "", "type": "query", "description": "The page token representing the page from where the next set of paginated results\nare retrieved. This is usually retrieved from a previous list call.\n" }, { "name": "limit", "value": "", "type": "query", "description": "The maximum number of records returned in the paginated response." }, { "name": "filterByComponentTypes", "value": "", "type": "query", "description": "The filter used to retrieve metrics for a specific set of component types by passing the desired component types separated by a comma. Note that, by default, the service returns metrics for all DB system component types." }, { "name": "startTime", "value": "", "type": "query", "description": "The beginning of the time range set to retrieve metric data for the DB system\nand its members. Expressed in UTC in ISO-8601 format, which is `yyyy-MM-dd'T'hh:mm:ss.sss'Z'`.\n" }, { "name": "endTime", "value": "", "type": "query", "description": "The end of the time range set to retrieve metric data for the DB system\nand its members. Expressed in UTC in ISO-8601 format, which is `yyyy-MM-dd'T'hh:mm:ss.sss'Z'`.\n" } ] }, "docs": "Gets availability metrics for the components present in the cloud DB system specified by `cloudDbSystemId`.\n" }, { "info": { "name": "Lists the Exadata infrastructures.", "type": "http" }, "http": { "method": "GET", "url": "http://dbmgmt.{region}.oci.oraclecloud.com/20201101/cloudExadataInfrastructures", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "compartmentId", "value": "", "type": "query", "description": "The [OCID](/Content/General/Concepts/identifiers.htm) of the compartment." }, { "name": "displayName", "value": "", "type": "query", "description": "The optional single value query filter parameter on the entity display name." }, { "name": "page", "value": "", "type": "query", "description": "The page token representing the page from where the next set of paginated results\nare retrieved. This is usually retrieved from a previous list call.\n" }, { "name": "limit", "value": "", "type": "query", "description": "The maximum number of records returned in the paginated response." }, { "name": "sortBy", "value": "", "type": "query", "description": "The field to sort information by. Only one sortOrder can be used. The default sort order\nfor ‘TIMECREATED’ is descending and the default sort order for ‘NAME’ is ascending.\nThe ‘NAME’ sort order is case-sensitive.\n" }, { "name": "sortOrder", "value": "", "type": "query", "description": "The option to sort information in ascending (‘ASC’) or descending (‘DESC’) order. Ascending order is the default order." } ] }, "docs": "Lists the Exadata infrastructure resources in the specified compartment.\n" }, { "info": { "name": "Creates an OCI resource for the Exadata infrastructure.", "type": "http" }, "http": { "method": "POST", "url": "http://dbmgmt.{region}.oci.oraclecloud.com/20201101/cloudExadataInfrastructures", "headers": [ { "name": "opc-request-id", "value": "" }, { "name": "opc-retry-token", "value": "" } ] }, "docs": "Creates an OCI resource for the Exadata infrastructure and enables the Monitoring service for the Exadata infrastructure.\nThe following resource/subresources are created:\n Infrastructure\n Storage server connectors\n Storage servers\n Storage grids\n" }, { "info": { "name": "Start the discovery process for Exadata system infrastructure from the specified agent.", "type": "http" }, "http": { "method": "POST", "url": "http://dbmgmt.{region}.oci.oraclecloud.com/20201101/cloudExadataInfrastructures/actions/discoverExadataInfrastructure", "headers": [ { "name": "opc-request-id", "value": "" }, { "name": "opc-retry-token", "value": "" } ] }, "docs": "Completes the Exadata system prechecking on the following:\n\n- Verifies if the ASM connector is defined for each VM Cluster or return 400 status code with CONNECTOR_NOT_DEFINED error code.\n- Verifies if the agents associated with ASM are valid and could be used for the Exadata storage servers or return 400 status code with\nINVALID_AGENT error code.\n\nStarts the discovery process for the Exadata system infrastructure. The following resources/components are discovered\n\n- Exadata storage servers from" }, { "info": { "name": "Gets the Exadata infrastructure details.", "type": "http" }, "http": { "method": "GET", "url": "http://dbmgmt.{region}.oci.oraclecloud.com/20201101/cloudExadataInfrastructures/:cloudExadataInfrastructureId", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "cloudExadataInfrastructureId", "value": "", "type": "path", "description": "The [OCID](/Content/General/Concepts/identifiers.htm) of the Exadata infrastructure." } ] }, "docs": "Gets the details for the Exadata infrastructure specified by exadataInfrastructureId. It includes the VMCluster and storage grid within the\nExadata infrastructure.\n" }, { "info": { "name": "Update the Exadata infrastructure.", "type": "http" }, "http": { "method": "PUT", "url": "http://dbmgmt.{region}.oci.oraclecloud.com/20201101/cloudExadataInfrastructures/:cloudExadataInfrastructureId", "headers": [ { "name": "opc-request-id", "value": "" }, { "name": "if-match", "value": "" }, { "name": "opc-retry-token", "value": "" } ], "params": [ { "name": "cloudExadataInfrastructureId", "value": "", "type": "path", "description": "The [OCID](/Content/General/Concepts/identifiers.htm) of the Exadata infrastructure." } ] }, "docs": "Updates the details for the Exadata infrastructure specified by exadataInfrastructureId.\n" }, { "info": { "name": "Deletes the Exadata infrastructure.", "type": "http" }, "http": { "method": "DELETE", "url": "http://dbmgmt.{region}.oci.oraclecloud.com/20201101/cloudExadataInfrastructures/:cloudExadataInfrastructureId", "headers": [ { "name": "opc-request-id", "value": "" }, { "name": "if-match", "value": "" } ], "params": [ { "name": "cloudExadataInfrastructureId", "value": "", "type": "path", "description": "The [OCID](/Content/General/Concepts/identifiers.htm) of the Exadata infrastructure." } ] }, "docs": "Deletes the Exadata infrastructure specified by exadataInfrastructureId.\n" }, { "info": { "name": "Moves the Exadata infrastructure and its resources to a different compartment.", "type": "http" }, "http": { "method": "POST", "url": "http://dbmgmt.{region}.oci.oraclecloud.com/20201101/cloudExadataInfrastructures/:cloudExadataInfrastructureId/actions/changeCompartment", "headers": [ { "name": "opc-request-id", "value": "" }, { "name": "opc-retry-token", "value": "" }, { "name": "if-match", "value": "" } ], "params": [ { "name": "cloudExadataInfrastructureId", "value": "", "type": "path", "description": "The [OCID](/Content/General/Concepts/identifiers.htm) of the Exadata infrastructure." } ] }, "docs": "Moves the Exadata infrastructure and its related resources (Exadata storage server, Exadata storage server connectors and Exadata storage server grid) to the specified compartment.\n" }, { "info": { "name": "Disables Database Management for the Exadata infrastructure.", "type": "http" }, "http": { "method": "POST", "url": "http://dbmgmt.{region}.oci.oraclecloud.com/20201101/cloudExadataInfrastructures/:cloudExadataInfrastructureId/actions/disableDatabaseManagement", "headers": [ { "name": "opc-request-id", "value": "" }, { "name": "opc-retry-token", "value": "" }, { "name": "if-match", "value": "" } ], "params": [ { "name": "cloudExadataInfrastructureId", "value": "", "type": "path", "description": "The [OCID](/Content/General/Concepts/identifiers.htm) of the Exadata infrastructure." } ] }, "docs": "Disables Database Management for the Exadata infrastructure specified by exadataInfrastructureId.\nIt covers the following components:\n\n- Exadata infrastructure\n- Exadata storage grid\n- Exadata storage server\n\nNote that Database Management will not be disabled for the VM Clusters within the Exadata infrastructure and should be disabled explicitly, if required.\n" }, { "info": { "name": "Enables Database Management for the Exadata infrastructure.", "type": "http" }, "http": { "method": "POST", "url": "http://dbmgmt.{region}.oci.oraclecloud.com/20201101/cloudExadataInfrastructures/:cloudExadataInfrastructureId/actions/enableDatabaseManagement", "headers": [ { "name": "opc-request-id", "value": "" }, { "name": "opc-retry-token", "value": "" }, { "name": "if-match", "value": "" } ], "params": [ { "name": "cloudExadataInfrastructureId", "value": "", "type": "path", "description": "The [OCID](/Content/General/Concepts/identifiers.htm) of the Exadata infrastructure." } ] }, "docs": "Enables Database Management for the Exadata infrastructure specified by exadataInfrastructureId. It covers the following \ncomponents:\n\n- Exadata infrastructure\n- Exadata storage grid\n- Exadata storage server\n" }, { "info": { "name": "Lists the connectors.", "type": "http" }, "http": { "method": "GET", "url": "http://dbmgmt.{region}.oci.oraclecloud.com/20201101/cloudExadataStorageConnectors", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "compartmentId", "value": "", "type": "query", "description": "The [OCID](/Content/General/Concepts/identifiers.htm) of the compartment." }, { "name": "cloudExadataInfrastructureId", "value": "", "type": "query", "description": "The [OCID](/Content/General/Concepts/identifiers.htm) of the Exadata infrastructure." }, { "name": "displayName", "value": "", "type": "query", "description": "The optional single value query filter parameter on the entity display name." }, { "name": "page", "value": "", "type": "query", "description": "The page token representing the page from where the next set of paginated results\nare retrieved. This is usually retrieved from a previous list call.\n" }, { "name": "limit", "value": "", "type": "query", "description": "The maximum number of records returned in the paginated response." }, { "name": "sortBy", "value": "", "type": "query", "description": "The field to sort information by. Only one sortOrder can be used. The default sort order\nfor ‘TIMECREATED’ is descending and the default sort order for ‘NAME’ is ascending.\nThe ‘NAME’ sort order is case-sensitive.\n" }, { "name": "sortOrder", "value": "", "type": "query", "description": "The option to sort information in ascending (‘ASC’) or descending (‘DESC’) order. Ascending order is the default order." } ] }, "docs": "Lists the Exadata storage server connectors for the specified Exadata infrastructure.\n" }, { "info": { "name": "Creates an Exadata storage server connector.", "type": "http" }, "http": { "method": "POST", "url": "http://dbmgmt.{region}.oci.oraclecloud.com/20201101/cloudExadataStorageConnectors", "headers": [ { "name": "opc-request-id", "value": "" }, { "name": "opc-retry-token", "value": "" } ] }, "docs": "Creates the Exadata storage server connector after validating the connection information.\n" }, { "info": { "name": "Gets the Exadata storage server connector details.", "type": "http" }, "http": { "method": "GET", "url": "http://dbmgmt.{region}.oci.oraclecloud.com/20201101/cloudExadataStorageConnectors/:cloudExadataStorageConnectorId", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "cloudExadataStorageConnectorId", "value": "", "type": "path", "description": "The [OCID](/Content/General/Concepts/identifiers.htm) of the connector to the Exadata storage server." } ] }, "docs": "Gets the details for the Exadata storage server connector specified by exadataStorageConnectorId.\n" }, { "info": { "name": "Updates an Exadata storage server connector.", "type": "http" }, "http": { "method": "PUT", "url": "http://dbmgmt.{region}.oci.oraclecloud.com/20201101/cloudExadataStorageConnectors/:cloudExadataStorageConnectorId", "headers": [ { "name": "if-match", "value": "" }, { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "cloudExadataStorageConnectorId", "value": "", "type": "path", "description": "The [OCID](/Content/General/Concepts/identifiers.htm) of the connector to the Exadata storage server." } ] }, "docs": "Updates the Exadata storage server connector specified by exadataStorageConnectorId.\n" }, { "info": { "name": "Deletes the exadata connector.", "type": "http" }, "http": { "method": "DELETE", "url": "http://dbmgmt.{region}.oci.oraclecloud.com/20201101/cloudExadataStorageConnectors/:cloudExadataStorageConnectorId", "headers": [ { "name": "opc-request-id", "value": "" }, { "name": "if-match", "value": "" } ], "params": [ { "name": "cloudExadataStorageConnectorId", "value": "", "type": "path", "description": "The [OCID](/Content/General/Concepts/identifiers.htm) of the connector to the Exadata storage server." } ] }, "docs": "Deletes the Exadata storage server connector specified by exadataStorageConnectorId.\n" }, { "info": { "name": "Checks the connectivity status of the Exadata storage server connection.", "type": "http" }, "http": { "method": "POST", "url": "http://dbmgmt.{region}.oci.oraclecloud.com/20201101/cloudExadataStorageConnectors/:cloudExadataStorageConnectorId/actions/checkStatus", "headers": [ { "name": "if-match", "value": "" }, { "name": "opc-request-id", "value": "" }, { "name": "opc-retry-token", "value": "" } ], "params": [ { "name": "cloudExadataStorageConnectorId", "value": "", "type": "path", "description": "The [OCID](/Content/General/Concepts/identifiers.htm) of the connector to the Exadata storage server." } ] }, "docs": "Checks the status of the Exadata storage server connection specified by exadataStorageConnectorId.\n" }, { "info": { "name": "Gets the Exadata storage server grid details.", "type": "http" }, "http": { "method": "GET", "url": "http://dbmgmt.{region}.oci.oraclecloud.com/20201101/cloudExadataStorageGrids/:cloudExadataStorageGridId", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "cloudExadataStorageGridId", "value": "", "type": "path", "description": "The [OCID](/Content/General/Concepts/identifiers.htm) of the Exadata storage grid." } ] }, "docs": "Gets the details for the Exadata storage server grid specified by exadataStorageGridId.\n" }, { "info": { "name": "Updates the Exadata storage server grid details.", "type": "http" }, "http": { "method": "PUT", "url": "http://dbmgmt.{region}.oci.oraclecloud.com/20201101/cloudExadataStorageGrids/:cloudExadataStorageGridId", "headers": [ { "name": "opc-request-id", "value": "" }, { "name": "if-match", "value": "" } ], "params": [ { "name": "cloudExadataStorageGridId", "value": "", "type": "path", "description": "The [OCID](/Content/General/Concepts/identifiers.htm) of the Exadata storage grid." } ] }, "docs": "Updates the Exadata storage server grid specified by exadataStorageGridId.\n" }, { "info": { "name": "Lists the exadata storage servers.", "type": "http" }, "http": { "method": "GET", "url": "http://dbmgmt.{region}.oci.oraclecloud.com/20201101/cloudExadataStorageServers", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "compartmentId", "value": "", "type": "query", "description": "The [OCID](/Content/General/Concepts/identifiers.htm) of the compartment." }, { "name": "cloudExadataInfrastructureId", "value": "", "type": "query", "description": "The [OCID](/Content/General/Concepts/identifiers.htm) of the Exadata infrastructure." }, { "name": "displayName", "value": "", "type": "query", "description": "The optional single value query filter parameter on the entity display name." }, { "name": "page", "value": "", "type": "query", "description": "The page token representing the page from where the next set of paginated results\nare retrieved. This is usually retrieved from a previous list call.\n" }, { "name": "limit", "value": "", "type": "query", "description": "The maximum number of records returned in the paginated response." }, { "name": "sortBy", "value": "", "type": "query", "description": "The field to sort information by. Only one sortOrder can be used. The default sort order\nfor ‘TIMECREATED’ is descending and the default sort order for ‘NAME’ is ascending.\nThe ‘NAME’ sort order is case-sensitive.\n" }, { "name": "sortOrder", "value": "", "type": "query", "description": "The option to sort information in ascending (‘ASC’) or descending (‘DESC’) order. Ascending order is the default order." } ] }, "docs": "Lists the Exadata storage servers for the specified Exadata infrastructure.\n" }, { "info": { "name": "Gets the Exadata storage server summary.", "type": "http" }, "http": { "method": "GET", "url": "http://dbmgmt.{region}.oci.oraclecloud.com/20201101/cloudExadataStorageServers/:cloudExadataStorageServerId", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "cloudExadataStorageServerId", "value": "", "type": "path", "description": "The [OCID](/Content/General/Concepts/identifiers.htm) of the Exadata storage server." } ] }, "docs": "Gets the summary for the Exadata storage server specified by exadataStorageServerId.\n" }, { "info": { "name": "Updates the Exadata storage server.", "type": "http" }, "http": { "method": "PUT", "url": "http://dbmgmt.{region}.oci.oraclecloud.com/20201101/cloudExadataStorageServers/:cloudExadataStorageServerId", "headers": [ { "name": "opc-request-id", "value": "" }, { "name": "if-match", "value": "" } ], "params": [ { "name": "cloudExadataStorageServerId", "value": "", "type": "path", "description": "The [OCID](/Content/General/Concepts/identifiers.htm) of the Exadata storage server." } ] }, "docs": "Updates the Exadata storage server specified by exadataStorageServerId.\n" }, { "info": { "name": "Gets the IORM plan from the specified Exadata storage server.", "type": "http" }, "http": { "method": "GET", "url": "http://dbmgmt.{region}.oci.oraclecloud.com/20201101/cloudExadataStorageServers/:cloudExadataStorageServerId/iormPlan", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "cloudExadataStorageServerId", "value": "", "type": "path", "description": "The [OCID](/Content/General/Concepts/identifiers.htm) of the Exadata storage server." } ] }, "docs": "Get the IORM plan from the specific Exadata storage server.\n" }, { "info": { "name": "Get open alerts from the specific Exadata storage server.", "type": "http" }, "http": { "method": "GET", "url": "http://dbmgmt.{region}.oci.oraclecloud.com/20201101/cloudExadataStorageServers/:cloudExadataStorageServerId/openAlertHistory", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "cloudExadataStorageServerId", "value": "", "type": "path", "description": "The [OCID](/Content/General/Concepts/identifiers.htm) of the Exadata storage server." } ] }, "docs": "Gets the open alerts from the specified Exadata storage server.\n" }, { "info": { "name": "Lists the cloud listeners.", "type": "http" }, "http": { "method": "GET", "url": "http://dbmgmt.{region}.oci.oraclecloud.com/20201101/cloudListeners", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "compartmentId", "value": "", "type": "query", "description": "The [OCID](/Content/General/Concepts/identifiers.htm) of the compartment." }, { "name": "cloudDbSystemId", "value": "", "type": "query", "description": "The [OCID](/Content/General/Concepts/identifiers.htm) of the cloud DB system." }, { "name": "displayName", "value": "", "type": "query", "description": "A filter to only return the resources that match the entire display name." }, { "name": "page", "value": "", "type": "query", "description": "The page token representing the page from where the next set of paginated results\nare retrieved. This is usually retrieved from a previous list call.\n" }, { "name": "limit", "value": "", "type": "query", "description": "The maximum number of records returned in the paginated response." }, { "name": "sortBy", "value": "", "type": "query", "description": "The field to sort information by. Only one sortOrder can be used. The default sort order\nfor `TIMECREATED` is descending and the default sort order for `DISPLAYNAME` is ascending.\nThe `DISPLAYNAME` sort order is case-sensitive.\n" }, { "name": "sortOrder", "value": "", "type": "query", "description": "The option to sort information in ascending (‘ASC’) or descending (‘DESC’) order. Ascending order is the default order." } ] }, "docs": "Lists the listeners in the specified cloud DB system." }, { "info": { "name": "Gets the cloud listener details.", "type": "http" }, "http": { "method": "GET", "url": "http://dbmgmt.{region}.oci.oraclecloud.com/20201101/cloudListeners/:cloudListenerId", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "cloudListenerId", "value": "", "type": "path", "description": "The [OCID](/Content/General/Concepts/identifiers.htm) of the cloud listener." } ] }, "docs": "Gets the details for the cloud listener specified by `cloudListenerId`.\n" }, { "info": { "name": "Updates a cloud listener.", "type": "http" }, "http": { "method": "PUT", "url": "http://dbmgmt.{region}.oci.oraclecloud.com/20201101/cloudListeners/:cloudListenerId", "headers": [ { "name": "opc-request-id", "value": "" }, { "name": "if-match", "value": "" } ], "params": [ { "name": "cloudListenerId", "value": "", "type": "path", "description": "The [OCID](/Content/General/Concepts/identifiers.htm) of the cloud listener." } ] }, "docs": "Updates the cloud listener specified by `cloudListenerId`.\n" }, { "info": { "name": "Gets the cloud listener metrics.", "type": "http" }, "http": { "method": "GET", "url": "http://dbmgmt.{region}.oci.oraclecloud.com/20201101/cloudListeners/:cloudListenerId/metrics", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "cloudListenerId", "value": "", "type": "path", "description": "The [OCID](/Content/General/Concepts/identifiers.htm) of the cloud listener." }, { "name": "page", "value": "", "type": "query", "description": "The page token representing the page from where the next set of paginated results\nare retrieved. This is usually retrieved from a previous list call.\n" }, { "name": "limit", "value": "", "type": "query", "description": "The maximum number of records returned in the paginated response." }, { "name": "startTime", "value": "", "type": "query", "description": "The beginning of the time range set to retrieve metric data for the DB system\nand its members. Expressed in UTC in ISO-8601 format, which is `yyyy-MM-dd'T'hh:mm:ss.sss'Z'`.\n" }, { "name": "endTime", "value": "", "type": "query", "description": "The end of the time range set to retrieve metric data for the DB system\nand its members. Expressed in UTC in ISO-8601 format, which is `yyyy-MM-dd'T'hh:mm:ss.sss'Z'`.\n" }, { "name": "filterByMetricNames", "value": "", "type": "query", "description": "The filter used to retrieve a specific set of metrics by passing the desired metric names with a comma separator. Note that, by default, the service returns all supported metrics." } ] }, "docs": "Gets metrics for the cloud listener specified by `cloudListenerId`.\n" }, { "info": { "name": "Lists the database services registered with the cloud listener.", "type": "http" }, "http": { "method": "GET", "url": "http://dbmgmt.{region}.oci.oraclecloud.com/20201101/cloudListeners/:cloudListenerId/services", "headers": [ { "name": "opc-request-id", "value": "" }, { "name": "opc-named-credential-id", "value": "" } ], "params": [ { "name": "cloudListenerId", "value": "", "type": "path", "description": "The [OCID](/Content/General/Concepts/identifiers.htm) of the cloud listener." }, { "name": "managedDatabaseId", "value": "", "type": "query", "description": "The [OCID](/Content/General/Concepts/identifiers.htm) of the Managed Database." }, { "name": "page", "value": "", "type": "query", "description": "The page token representing the page from where the next set of paginated results\nare retrieved. This is usually retrieved from a previous list call.\n" }, { "name": "limit", "value": "", "type": "query", "description": "The maximum number of records returned in the paginated response." }, { "name": "sortBy", "value": "", "type": "query", "description": "The field to sort information by. Only one sortOrder can be used. The\ndefault sort order for `NAME` is ascending and it is case-sensitive.\n" }, { "name": "sortOrder", "value": "", "type": "query", "description": "The option to sort information in ascending (‘ASC’) or descending (‘DESC’) order. Ascending order is the default order." } ] }, "docs": "Lists the database services registered with the specified cloud listener\nfor the specified Managed Database.\n" }, { "info": { "name": "Gets the health metrics for a fleet of databases.", "type": "http" }, "http": { "method": "GET", "url": "http://dbmgmt.{region}.oci.oraclecloud.com/20201101/databaseFleetBackupMetrics", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "databaseHostedIn", "value": "", "type": "query", "description": "Indicates whether the database is a cloud database or an external database." }, { "name": "managedDatabaseGroupId", "value": "", "type": "query", "description": "The [OCID](/Content/General/Concepts/identifiers.htm) of the Managed Database Group." }, { "name": "compartmentId", "value": "", "type": "query", "description": "The [OCID](/Content/General/Concepts/identifiers.htm) of the compartment." }, { "name": "startTime", "value": "", "type": "query", "description": "The start time of the time range to retrieve the health metrics of a Managed Database\nin UTC in ISO-8601 format, which is \"yyyy-MM-dd'T'hh:mm:ss.sss'Z'\".\n" }, { "name": "endTime", "value": "", "type": "query", "description": "The end time of the time range to retrieve the health metrics of a Managed Database\nin UTC in ISO-8601 format, which is \"yyyy-MM-dd'T'hh:mm:ss.sss'Z'\".\n" }, { "name": "filterByMetricNames", "value": "", "type": "query", "description": "The filter used to retrieve a specific set of metrics by passing the desired metric names with a comma separator. Note that, by default, the service returns all supported metrics." }, { "name": "page", "value": "", "type": "query", "description": "The page token representing the page from where the next set of paginated results\nare retrieved. This is usually retrieved from a previous list call.\n" }, { "name": "limit", "value": "", "type": "query", "description": "The maximum number of records returned in the paginated response." }, { "name": "sortBy", "value": "", "type": "query", "description": "The field to sort information by. Only one sortOrder can be used. The\ndefault sort order for `DATABASENAME` is ascending and it is case-sensitive.\n" }, { "name": "sortOrder", "value": "", "type": "query", "description": "The option to sort information in ascending (‘ASC’) or descending (‘DESC’) order. Ascending order is the default order." }, { "name": "definedTagEquals", "value": "", "type": "query", "description": "A list of tag filters to apply. Only resources with a defined tag matching the value will be returned.\nEach item in the list has the format \"{namespace}.{tagName}.{value}\". All inputs are case-insensitive.\nMultiple values for the same key (i.e. same namespace and tag name) are interpreted as \"OR\".\nValues for different keys (i.e. different namespaces, different tag names, or both) are interpreted as \"AND\".\n" }, { "name": "freeformTagEquals", "value": "", "type": "query", "description": "A list of tag filters to apply. Only resources with a freeform tag matching the value will be returned.\nThe key for each tag is \"{tagName}.{value}\". All inputs are case-insensitive.\nMultiple values for the same tag name are interpreted as \"OR\". Values for different tag names are interpreted as \"AND\".\n" }, { "name": "definedTagExists", "value": "", "type": "query", "description": "A list of tag existence filters to apply. Only resources for which the specified defined tags exist will be returned.\nEach item in the list has the format \"{namespace}.{tagName}.true\" (for checking existence of a defined tag)\nor \"{namespace}.true\". All inputs are case-insensitive.\nCurrently, only existence (\"true\" at the end) is supported. Absence (\"false\" at the end) is not supported.\nMultiple values for the same key (i.e. same namespace and tag name) are interpreted as \"OR\".\nValues for different keys (i.e. different namespaces, different tag names, or both) are interpreted as \"AND\".\n" }, { "name": "freeformTagExists", "value": "", "type": "query", "description": "A list of tag existence filters to apply. Only resources for which the specified freeform tags exist the value will be returned.\nThe key for each tag is \"{tagName}.true\". All inputs are case-insensitive.\nCurrently, only existence (\"true\" at the end) is supported. Absence (\"false\" at the end) is not supported.\nMultiple values for different tag names are interpreted as \"AND\".\n" } ] }, "docs": "Gets the fleet of container databases (CDBs) and their backup details and metrics, in a compartment or Database Group. \nThe databaseHostedIn query parameter must be provided to list either cloud or external databases. \nEither the CompartmentId or the ManagedDatabaseGroupId query parameters must be provided to retrieve the HA and backup metrics.\n" }, { "info": { "name": "Gets the dataguard enabled databases in fleet with dataguard metrics.", "type": "http" }, "http": { "method": "GET", "url": "http://dbmgmt.{region}.oci.oraclecloud.com/20201101/databaseFleetDataguardMetrics", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "managedDatabaseGroupId", "value": "", "type": "query", "description": "The [OCID](/Content/General/Concepts/identifiers.htm) of the Managed Database Group." }, { "name": "compartmentId", "value": "", "type": "query", "description": "The [OCID](/Content/General/Concepts/identifiers.htm) of the compartment." }, { "name": "filterByMetricNames", "value": "", "type": "query", "description": "The filter used to retrieve a specific set of metrics by passing the desired metric names with a comma separator. Note that, by default, the service returns all supported metrics." }, { "name": "page", "value": "", "type": "query", "description": "The page token representing the page from where the next set of paginated results\nare retrieved. This is usually retrieved from a previous list call.\n" }, { "name": "limit", "value": "", "type": "query", "description": "The maximum number of records returned in the paginated response." }, { "name": "sortBy", "value": "", "type": "query", "description": "The field to sort information by. Only one sortOrder can be used. The\ndefault sort order for `DATABASENAME` is ascending and it is case-sensitive.\n" }, { "name": "sortOrder", "value": "", "type": "query", "description": "The option to sort information in ascending (‘ASC’) or descending (‘DESC’) order. Ascending order is the default order." }, { "name": "definedTagEquals", "value": "", "type": "query", "description": "A list of tag filters to apply. Only resources with a defined tag matching the value will be returned.\nEach item in the list has the format \"{namespace}.{tagName}.{value}\". All inputs are case-insensitive.\nMultiple values for the same key (i.e. same namespace and tag name) are interpreted as \"OR\".\nValues for different keys (i.e. different namespaces, different tag names, or both) are interpreted as \"AND\".\n" }, { "name": "freeformTagEquals", "value": "", "type": "query", "description": "A list of tag filters to apply. Only resources with a freeform tag matching the value will be returned.\nThe key for each tag is \"{tagName}.{value}\". All inputs are case-insensitive.\nMultiple values for the same tag name are interpreted as \"OR\". Values for different tag names are interpreted as \"AND\".\n" }, { "name": "definedTagExists", "value": "", "type": "query", "description": "A list of tag existence filters to apply. Only resources for which the specified defined tags exist will be returned.\nEach item in the list has the format \"{namespace}.{tagName}.true\" (for checking existence of a defined tag)\nor \"{namespace}.true\". All inputs are case-insensitive.\nCurrently, only existence (\"true\" at the end) is supported. Absence (\"false\" at the end) is not supported.\nMultiple values for the same key (i.e. same namespace and tag name) are interpreted as \"OR\".\nValues for different keys (i.e. different namespaces, different tag names, or both) are interpreted as \"AND\".\n" }, { "name": "freeformTagExists", "value": "", "type": "query", "description": "A list of tag existence filters to apply. Only resources for which the specified freeform tags exist the value will be returned.\nThe key for each tag is \"{tagName}.true\". All inputs are case-insensitive.\nCurrently, only existence (\"true\" at the end) is supported. Absence (\"false\" at the end) is not supported.\nMultiple values for different tag names are interpreted as \"AND\".\n" } ] }, "docs": "Gets the fleet of Oracle Data Guard-enabled container databases (CDBs) along with Data Guard metrics and standby databases, in a compartment or Database Group.\nEither the CompartmentId or the ManagedDatabaseGroupId query parameters must be provided to retrieve the list of databases and Data Guard metrics.\n" }, { "info": { "name": "Gets the list fleet databases with HA and backup metrics.", "type": "http" }, "http": { "method": "GET", "url": "http://dbmgmt.{region}.oci.oraclecloud.com/20201101/databaseFleetHaOverviewMetrics", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "managedDatabaseGroupId", "value": "", "type": "query", "description": "The [OCID](/Content/General/Concepts/identifiers.htm) of the Managed Database Group." }, { "name": "compartmentId", "value": "", "type": "query", "description": "The [OCID](/Content/General/Concepts/identifiers.htm) of the compartment." }, { "name": "filterByMetricNames", "value": "", "type": "query", "description": "The filter used to retrieve a specific set of metrics by passing the desired metric names with a comma separator. Note that, by default, the service returns all supported metrics." }, { "name": "page", "value": "", "type": "query", "description": "The page token representing the page from where the next set of paginated results\nare retrieved. This is usually retrieved from a previous list call.\n" }, { "name": "limit", "value": "", "type": "query", "description": "The maximum number of records returned in the paginated response." }, { "name": "sortBy", "value": "", "type": "query", "description": "The field to sort information by. Only one sortOrder can be used. The\ndefault sort order for `DATABASENAME` is ascending and it is case-sensitive.\n" }, { "name": "sortOrder", "value": "", "type": "query", "description": "The option to sort information in ascending (‘ASC’) or descending (‘DESC’) order. Ascending order is the default order." }, { "name": "definedTagEquals", "value": "", "type": "query", "description": "A list of tag filters to apply. Only resources with a defined tag matching the value will be returned.\nEach item in the list has the format \"{namespace}.{tagName}.{value}\". All inputs are case-insensitive.\nMultiple values for the same key (i.e. same namespace and tag name) are interpreted as \"OR\".\nValues for different keys (i.e. different namespaces, different tag names, or both) are interpreted as \"AND\".\n" }, { "name": "freeformTagEquals", "value": "", "type": "query", "description": "A list of tag filters to apply. Only resources with a freeform tag matching the value will be returned.\nThe key for each tag is \"{tagName}.{value}\". All inputs are case-insensitive.\nMultiple values for the same tag name are interpreted as \"OR\". Values for different tag names are interpreted as \"AND\".\n" }, { "name": "definedTagExists", "value": "", "type": "query", "description": "A list of tag existence filters to apply. Only resources for which the specified defined tags exist will be returned.\nEach item in the list has the format \"{namespace}.{tagName}.true\" (for checking existence of a defined tag)\nor \"{namespace}.true\". All inputs are case-insensitive.\nCurrently, only existence (\"true\" at the end) is supported. Absence (\"false\" at the end) is not supported.\nMultiple values for the same key (i.e. same namespace and tag name) are interpreted as \"OR\".\nValues for different keys (i.e. different namespaces, different tag names, or both) are interpreted as \"AND\".\n" }, { "name": "freeformTagExists", "value": "", "type": "query", "description": "A list of tag existence filters to apply. Only resources for which the specified freeform tags exist the value will be returned.\nThe key for each tag is \"{tagName}.true\". All inputs are case-insensitive.\nCurrently, only existence (\"true\" at the end) is supported. Absence (\"false\" at the end) is not supported.\nMultiple values for different tag names are interpreted as \"AND\".\n" } ] }, "docs": "Gets the fleet of container databases (CDBs) and their HA and backup metrics in a compartment or in a Database Group.\nEither the CompartmentId or the ManagedDatabaseGroupId query parameters must be provided to retrieve the HA and backup metrics.\n" }, { "info": { "name": "Gets a summary of the activity and resource usage metrics for a Managed Database.", "type": "http" }, "http": { "method": "GET", "url": "http://dbmgmt.{region}.oci.oraclecloud.com/20201101/databaseHomeMetrics", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "managedDatabaseId", "value": "", "type": "query", "description": "The [OCID](/Content/General/Concepts/identifiers.htm) of the Managed Database." }, { "name": "startTime", "value": "", "type": "query", "description": "The start time of the time range to retrieve the health metrics of a Managed Database\nin UTC in ISO-8601 format, which is \"yyyy-MM-dd'T'hh:mm:ss.sss'Z'\".\n" }, { "name": "endTime", "value": "", "type": "query", "description": "The end time of the time range to retrieve the health metrics of a Managed Database\nin UTC in ISO-8601 format, which is \"yyyy-MM-dd'T'hh:mm:ss.sss'Z'\".\n" } ] }, "docs": "Gets a summary of the activity and resource usage metrics like DB Time, CPU, User I/O, Wait, Storage, and Memory for a Managed Database." }, { "info": { "name": "Disables Database Management feature for a database.", "type": "http" }, "http": { "method": "POST", "url": "http://dbmgmt.{region}.oci.oraclecloud.com/20201101/databases/:databaseId/actions/disableDatabaseManagement", "headers": [ { "name": "opc-request-id", "value": "" }, { "name": "opc-retry-token", "value": "" }, { "name": "if-match", "value": "" } ], "params": [ { "name": "databaseId", "value": "", "type": "path", "description": "The [OCID](/Content/General/Concepts/identifiers.htm) of the Database." } ] }, "docs": "Disables a Database Management feature for the specified Oracle cloud database.\n" }, { "info": { "name": "Enables Database Management feature for the Oracle cloud Database.", "type": "http" }, "http": { "method": "POST", "url": "http://dbmgmt.{region}.oci.oraclecloud.com/20201101/databases/:databaseId/actions/enableDatabaseManagement", "headers": [ { "name": "opc-request-id", "value": "" }, { "name": "opc-retry-token", "value": "" }, { "name": "if-match", "value": "" } ], "params": [ { "name": "databaseId", "value": "", "type": "path", "description": "The [OCID](/Content/General/Concepts/identifiers.htm) of the Database." } ] }, "docs": "Enables a Database Management feature for the specified cloud database.\n" }, { "info": { "name": "Modifies Database Management feature for the cloud Database.", "type": "http" }, "http": { "method": "POST", "url": "http://dbmgmt.{region}.oci.oraclecloud.com/20201101/databases/:databaseId/actions/modifyDatabaseManagement", "headers": [ { "name": "opc-request-id", "value": "" }, { "name": "opc-retry-token", "value": "" }, { "name": "if-match", "value": "" } ], "params": [ { "name": "databaseId", "value": "", "type": "path", "description": "The [OCID](/Content/General/Concepts/identifiers.htm) of the Database." } ] }, "docs": "Modifies a Database Management feature for the specified Oracle cloud database.\n" }, { "info": { "name": "Gets a list of Database Management private endpoints.", "type": "http" }, "http": { "method": "GET", "url": "http://dbmgmt.{region}.oci.oraclecloud.com/20201101/dbManagementPrivateEndpoints", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "compartmentId", "value": "", "type": "query", "description": "The [OCID](/Content/General/Concepts/identifiers.htm) of the compartment." }, { "name": "name", "value": "", "type": "query", "description": "A filter to return only resources that match the entire name." }, { "name": "vcnId", "value": "", "type": "query", "description": "The [OCID](/Content/General/Concepts/identifiers.htm) of the VCN." }, { "name": "isCluster", "value": "", "type": "query", "description": "The option to filter Database Management private endpoints that can used for Oracle Databases in a cluster. This should be used along with the vcnId query parameter.\n" }, { "name": "isDnsResolutionEnabled", "value": "", "type": "query", "description": "The option to filter Database Management private endpoints which are endbled with DNS proxy server. This should be used along with the vcnId query parameter.\nOnly one of this parameter and IsClusterDbManagementPrivateEndpointQueryParam should be set to true at one time.\n" }, { "name": "lifecycleState", "value": "", "type": "query", "description": "The lifecycle state of a resource." }, { "name": "limit", "value": "", "type": "query", "description": "The maximum number of records returned in the paginated response." }, { "name": "page", "value": "", "type": "query", "description": "The page token representing the page from where the next set of paginated results\nare retrieved. This is usually retrieved from a previous list call.\n" }, { "name": "sortOrder", "value": "", "type": "query", "description": "The option to sort information in ascending (‘ASC’) or descending (‘DESC’) order. Ascending order is the default order." }, { "name": "sortBy", "value": "", "type": "query", "description": "The field to sort information by. Only one sortOrder can be used. The default sort order\nfor ‘TIMECREATED’ is descending and the default sort order for ‘NAME’ is ascending.\nThe ‘NAME’ sort order is case-sensitive.\n" } ] }, "docs": "Gets a list of Database Management private endpoints.\n" }, { "info": { "name": "Creates a new Database Management private endpoint.", "type": "http" }, "http": { "method": "POST", "url": "http://dbmgmt.{region}.oci.oraclecloud.com/20201101/dbManagementPrivateEndpoints", "headers": [ { "name": "opc-retry-token", "value": "" }, { "name": "opc-request-id", "value": "" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Creates a new Database Management private endpoint.\n" }, { "info": { "name": "Gets the details of a specific Database Management private endpoint.", "type": "http" }, "http": { "method": "GET", "url": "http://dbmgmt.{region}.oci.oraclecloud.com/20201101/dbManagementPrivateEndpoints/:dbManagementPrivateEndpointId", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "dbManagementPrivateEndpointId", "value": "", "type": "path", "description": "The [OCID](/Content/General/Concepts/identifiers.htm) of the Database Management private endpoint." } ] }, "docs": "Gets the details of a specific Database Management private endpoint." }, { "info": { "name": "Updates one or more attributes of a specific Database Management private endpoint.", "type": "http" }, "http": { "method": "PUT", "url": "http://dbmgmt.{region}.oci.oraclecloud.com/20201101/dbManagementPrivateEndpoints/:dbManagementPrivateEndpointId", "headers": [ { "name": "opc-request-id", "value": "" }, { "name": "if-match", "value": "" } ], "params": [ { "name": "dbManagementPrivateEndpointId", "value": "", "type": "path", "description": "The [OCID](/Content/General/Concepts/identifiers.htm) of the Database Management private endpoint." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Updates one or more attributes of a specific Database Management private endpoint." }, { "info": { "name": "Deletes a specific Database Management private endpoint.", "type": "http" }, "http": { "method": "DELETE", "url": "http://dbmgmt.{region}.oci.oraclecloud.com/20201101/dbManagementPrivateEndpoints/:dbManagementPrivateEndpointId", "headers": [ { "name": "opc-request-id", "value": "" }, { "name": "if-match", "value": "" } ], "params": [ { "name": "dbManagementPrivateEndpointId", "value": "", "type": "path", "description": "The [OCID](/Content/General/Concepts/identifiers.htm) of the Database Management private endpoint." } ] }, "docs": "Deletes a specific Database Management private endpoint." }, { "info": { "name": "ChangeDbManagementPrivateEndpointCompartment", "type": "http" }, "http": { "method": "POST", "url": "http://dbmgmt.{region}.oci.oraclecloud.com/20201101/dbManagementPrivateEndpoints/:dbManagementPrivateEndpointId/actions/changeCompartment", "headers": [ { "name": "opc-request-id", "value": "" }, { "name": "opc-retry-token", "value": "" }, { "name": "if-match", "value": "" } ], "params": [ { "name": "dbManagementPrivateEndpointId", "value": "", "type": "path", "description": "The [OCID](/Content/General/Concepts/identifiers.htm) of the Database Management private endpoint." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Moves the Database Management private endpoint and its dependent resources to the specified compartment." }, { "info": { "name": "Gets the list of databases using a specific Database Management private endpoint.", "type": "http" }, "http": { "method": "GET", "url": "http://dbmgmt.{region}.oci.oraclecloud.com/20201101/dbManagementPrivateEndpoints/:dbManagementPrivateEndpointId/associatedDatabases", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "dbManagementPrivateEndpointId", "value": "", "type": "path", "description": "The [OCID](/Content/General/Concepts/identifiers.htm) of the Database Management private endpoint." }, { "name": "compartmentId", "value": "", "type": "query", "description": "The [OCID](/Content/General/Concepts/identifiers.htm) of the compartment." }, { "name": "limit", "value": "", "type": "query", "description": "The maximum number of records returned in the paginated response." }, { "name": "page", "value": "", "type": "query", "description": "The page token representing the page from where the next set of paginated results\nare retrieved. This is usually retrieved from a previous list call.\n" }, { "name": "sortOrder", "value": "", "type": "query", "description": "The option to sort information in ascending (‘ASC’) or descending (‘DESC’) order. Ascending order is the default order." }, { "name": "sortBy", "value": "", "type": "query", "description": "The option to sort databases using a specific Database Management private endpoint.\n" } ] }, "docs": "Gets the list of databases using a specific Database Management private endpoint." }, { "info": { "name": "Gets the health metrics for a fleet of Exadata infrastructure.", "type": "http" }, "http": { "method": "GET", "url": "http://dbmgmt.{region}.oci.oraclecloud.com/20201101/exadataInfrastructureFleetMetrics", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "compartmentId", "value": "", "type": "query", "description": "The [OCID](/Content/General/Concepts/identifiers.htm) of the compartment." }, { "name": "compareBaselineTime", "value": "", "type": "query", "description": "The baseline time for metrics comparison." }, { "name": "compareTargetTime", "value": "", "type": "query", "description": "The target time for metrics comparison." }, { "name": "compareType", "value": "", "type": "query", "description": "The time window used for metrics comparison." }, { "name": "filterByExadataInfrastructureDeploymentType", "value": "", "type": "query", "description": "The filter used to filter the Exadata infrastructures in the fleet by a specific deployment type." }, { "name": "filterByExadataInfrastructureLifecycleState", "value": "", "type": "query", "description": "The filter used to filter the Exadata infrastructure in the fleet by its lifecycle state.\nIf the parameter is not provided, Exdata infrastructures in any state are returned.\n" }, { "name": "sortBy", "value": "", "type": "query", "description": "The field to sort information by. Only one sortOrder can be used. The default sort order\nfor ‘TIMECREATED’ is descending and the default sort order for ‘NAME’ is ascending.\nThe ‘NAME’ sort order is case-sensitive.\n" }, { "name": "sortOrder", "value": "", "type": "query", "description": "The option to sort information in ascending (‘ASC’) or descending (‘DESC’) order. Ascending order is the default order." } ] }, "docs": "Gets the health metrics for a fleet of Exadata infrastructure in a compartment. \nThe CompartmentId query parameters must be provided to retrieve the health metrics.\n" }, { "info": { "name": "Lists the external ASM instances.", "type": "http" }, "http": { "method": "GET", "url": "http://dbmgmt.{region}.oci.oraclecloud.com/20201101/externalAsmInstances", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "compartmentId", "value": "", "type": "query", "description": "The [OCID](/Content/General/Concepts/identifiers.htm) of the compartment." }, { "name": "externalAsmId", "value": "", "type": "query", "description": "The [OCID](/Content/General/Concepts/identifiers.htm) of the external ASM." }, { "name": "displayName", "value": "", "type": "query", "description": "A filter to only return the resources that match the entire display name." }, { "name": "page", "value": "", "type": "query", "description": "The page token representing the page from where the next set of paginated results\nare retrieved. This is usually retrieved from a previous list call.\n" }, { "name": "limit", "value": "", "type": "query", "description": "The maximum number of records returned in the paginated response." }, { "name": "sortBy", "value": "", "type": "query", "description": "The field to sort information by. Only one sortOrder can be used. The default sort order\nfor `TIMECREATED` is descending and the default sort order for `DISPLAYNAME` is ascending.\nThe `DISPLAYNAME` sort order is case-sensitive.\n" }, { "name": "sortOrder", "value": "", "type": "query", "description": "The option to sort information in ascending (‘ASC’) or descending (‘DESC’) order. Ascending order is the default order." } ] }, "docs": "Lists the ASM instances in the specified external ASM." }, { "info": { "name": "Gets the external ASM instance details.", "type": "http" }, "http": { "method": "GET", "url": "http://dbmgmt.{region}.oci.oraclecloud.com/20201101/externalAsmInstances/:externalAsmInstanceId", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "externalAsmInstanceId", "value": "", "type": "path", "description": "The [OCID](/Content/General/Concepts/identifiers.htm) of the external ASM instance." } ] }, "docs": "Gets the details for the external ASM instance specified by `externalAsmInstanceId`.\n" }, { "info": { "name": "Updates an external ASM instance.", "type": "http" }, "http": { "method": "PUT", "url": "http://dbmgmt.{region}.oci.oraclecloud.com/20201101/externalAsmInstances/:externalAsmInstanceId", "headers": [ { "name": "opc-request-id", "value": "" }, { "name": "if-match", "value": "" } ], "params": [ { "name": "externalAsmInstanceId", "value": "", "type": "path", "description": "The [OCID](/Content/General/Concepts/identifiers.htm) of the external ASM instance." } ] }, "docs": "Updates the external ASM instance specified by `externalAsmInstanceId`.\n" }, { "info": { "name": "Lists the external ASMs.", "type": "http" }, "http": { "method": "GET", "url": "http://dbmgmt.{region}.oci.oraclecloud.com/20201101/externalAsms", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "compartmentId", "value": "", "type": "query", "description": "The [OCID](/Content/General/Concepts/identifiers.htm) of the compartment." }, { "name": "externalDbSystemId", "value": "", "type": "query", "description": "The [OCID](/Content/General/Concepts/identifiers.htm) of the external DB system." }, { "name": "displayName", "value": "", "type": "query", "description": "A filter to only return the resources that match the entire display name." }, { "name": "page", "value": "", "type": "query", "description": "The page token representing the page from where the next set of paginated results\nare retrieved. This is usually retrieved from a previous list call.\n" }, { "name": "limit", "value": "", "type": "query", "description": "The maximum number of records returned in the paginated response." }, { "name": "sortBy", "value": "", "type": "query", "description": "The field to sort information by. Only one sortOrder can be used. The default sort order\nfor `TIMECREATED` is descending and the default sort order for `DISPLAYNAME` is ascending.\nThe `DISPLAYNAME` sort order is case-sensitive.\n" }, { "name": "sortOrder", "value": "", "type": "query", "description": "The option to sort information in ascending (‘ASC’) or descending (‘DESC’) order. Ascending order is the default order." } ] }, "docs": "Lists the ASMs in the specified external DB system." }, { "info": { "name": "Gets the external ASM details.", "type": "http" }, "http": { "method": "GET", "url": "http://dbmgmt.{region}.oci.oraclecloud.com/20201101/externalAsms/:externalAsmId", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "externalAsmId", "value": "", "type": "path", "description": "The [OCID](/Content/General/Concepts/identifiers.htm) of the external ASM." } ] }, "docs": "Gets the details for the external ASM specified by `externalAsmId`.\n" }, { "info": { "name": "Updates an external ASM.", "type": "http" }, "http": { "method": "PUT", "url": "http://dbmgmt.{region}.oci.oraclecloud.com/20201101/externalAsms/:externalAsmId", "headers": [ { "name": "opc-request-id", "value": "" }, { "name": "if-match", "value": "" } ], "params": [ { "name": "externalAsmId", "value": "", "type": "path", "description": "The [OCID](/Content/General/Concepts/identifiers.htm) of the external ASM." } ] }, "docs": "Updates the external ASM specified by `externalAsmId`.\n" }, { "info": { "name": "Gets the external ASM configuration.", "type": "http" }, "http": { "method": "GET", "url": "http://dbmgmt.{region}.oci.oraclecloud.com/20201101/externalAsms/:externalAsmId/configuration", "headers": [ { "name": "opc-request-id", "value": "" }, { "name": "opc-named-credential-id", "value": "" } ], "params": [ { "name": "externalAsmId", "value": "", "type": "path", "description": "The [OCID](/Content/General/Concepts/identifiers.htm) of the external ASM." } ] }, "docs": "Gets configuration details including disk groups for the external ASM specified by `externalAsmId`.\n" }, { "info": { "name": "Lists the external ASM disk groups.", "type": "http" }, "http": { "method": "GET", "url": "http://dbmgmt.{region}.oci.oraclecloud.com/20201101/externalAsms/:externalAsmId/diskGroups", "headers": [ { "name": "opc-request-id", "value": "" }, { "name": "opc-named-credential-id", "value": "" } ], "params": [ { "name": "externalAsmId", "value": "", "type": "path", "description": "The [OCID](/Content/General/Concepts/identifiers.htm) of the external ASM." }, { "name": "page", "value": "", "type": "query", "description": "The page token representing the page from where the next set of paginated results\nare retrieved. This is usually retrieved from a previous list call.\n" }, { "name": "limit", "value": "", "type": "query", "description": "The maximum number of records returned in the paginated response." }, { "name": "sortBy", "value": "", "type": "query", "description": "The field to sort information by. Only one sortOrder can be used. The\ndefault sort order for `NAME` is ascending and it is case-sensitive.\n" }, { "name": "sortOrder", "value": "", "type": "query", "description": "The option to sort information in ascending (‘ASC’) or descending (‘DESC’) order. Ascending order is the default order." } ] }, "docs": "Lists ASM disk groups for the external ASM specified by `externalAsmId`.\n" }, { "info": { "name": "Gets the external ASM metrics.", "type": "http" }, "http": { "method": "GET", "url": "http://dbmgmt.{region}.oci.oraclecloud.com/20201101/externalAsms/:externalAsmId/metrics", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "externalAsmId", "value": "", "type": "path", "description": "The [OCID](/Content/General/Concepts/identifiers.htm) of the external ASM." }, { "name": "page", "value": "", "type": "query", "description": "The page token representing the page from where the next set of paginated results\nare retrieved. This is usually retrieved from a previous list call.\n" }, { "name": "limit", "value": "", "type": "query", "description": "The maximum number of records returned in the paginated response." }, { "name": "startTime", "value": "", "type": "query", "description": "The beginning of the time range set to retrieve metric data for the DB system\nand its members. Expressed in UTC in ISO-8601 format, which is `yyyy-MM-dd'T'hh:mm:ss.sss'Z'`.\n" }, { "name": "endTime", "value": "", "type": "query", "description": "The end of the time range set to retrieve metric data for the DB system\nand its members. Expressed in UTC in ISO-8601 format, which is `yyyy-MM-dd'T'hh:mm:ss.sss'Z'`.\n" }, { "name": "filterByMetricNames", "value": "", "type": "query", "description": "The filter used to retrieve a specific set of metrics by passing the desired metric names with a comma separator. Note that, by default, the service returns all supported metrics." } ] }, "docs": "Gets metrics for the external ASM specified by `externalAsmId`.\n" }, { "info": { "name": "Lists the external ASM users.", "type": "http" }, "http": { "method": "GET", "url": "http://dbmgmt.{region}.oci.oraclecloud.com/20201101/externalAsms/:externalAsmId/users", "headers": [ { "name": "opc-request-id", "value": "" }, { "name": "opc-named-credential-id", "value": "" } ], "params": [ { "name": "externalAsmId", "value": "", "type": "path", "description": "The [OCID](/Content/General/Concepts/identifiers.htm) of the external ASM." }, { "name": "page", "value": "", "type": "query", "description": "The page token representing the page from where the next set of paginated results\nare retrieved. This is usually retrieved from a previous list call.\n" }, { "name": "limit", "value": "", "type": "query", "description": "The maximum number of records returned in the paginated response." }, { "name": "sortBy", "value": "", "type": "query", "description": "The field to sort information by. Only one sortOrder can be used. The\ndefault sort order for `NAME` is ascending and it is case-sensitive.\n" }, { "name": "sortOrder", "value": "", "type": "query", "description": "The option to sort information in ascending (‘ASC’) or descending (‘DESC’) order. Ascending order is the default order." } ] }, "docs": "Lists ASM users for the external ASM specified by `externalAsmId`.\n" }, { "info": { "name": "Lists the external cluster instances.", "type": "http" }, "http": { "method": "GET", "url": "http://dbmgmt.{region}.oci.oraclecloud.com/20201101/externalClusterInstances", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "compartmentId", "value": "", "type": "query", "description": "The [OCID](/Content/General/Concepts/identifiers.htm) of the compartment." }, { "name": "externalClusterId", "value": "", "type": "query", "description": "The [OCID](/Content/General/Concepts/identifiers.htm) of the external cluster." }, { "name": "displayName", "value": "", "type": "query", "description": "A filter to only return the resources that match the entire display name." }, { "name": "page", "value": "", "type": "query", "description": "The page token representing the page from where the next set of paginated results\nare retrieved. This is usually retrieved from a previous list call.\n" }, { "name": "limit", "value": "", "type": "query", "description": "The maximum number of records returned in the paginated response." }, { "name": "sortBy", "value": "", "type": "query", "description": "The field to sort information by. Only one sortOrder can be used. The default sort order\nfor `TIMECREATED` is descending and the default sort order for `DISPLAYNAME` is ascending.\nThe `DISPLAYNAME` sort order is case-sensitive.\n" }, { "name": "sortOrder", "value": "", "type": "query", "description": "The option to sort information in ascending (‘ASC’) or descending (‘DESC’) order. Ascending order is the default order." } ] }, "docs": "Lists the cluster instances in the specified external cluster." }, { "info": { "name": "Gets the external cluster instance details.", "type": "http" }, "http": { "method": "GET", "url": "http://dbmgmt.{region}.oci.oraclecloud.com/20201101/externalClusterInstances/:externalClusterInstanceId", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "externalClusterInstanceId", "value": "", "type": "path", "description": "The [OCID](/Content/General/Concepts/identifiers.htm) of the external cluster instance." } ] }, "docs": "Gets the details for the external cluster instance specified by `externalClusterInstanceId`.\n" }, { "info": { "name": "Updates an external cluster instance.", "type": "http" }, "http": { "method": "PUT", "url": "http://dbmgmt.{region}.oci.oraclecloud.com/20201101/externalClusterInstances/:externalClusterInstanceId", "headers": [ { "name": "opc-request-id", "value": "" }, { "name": "if-match", "value": "" } ], "params": [ { "name": "externalClusterInstanceId", "value": "", "type": "path", "description": "The [OCID](/Content/General/Concepts/identifiers.htm) of the external cluster instance." } ] }, "docs": "Updates the external cluster instance specified by `externalClusterInstanceId`.\n" }, { "info": { "name": "Lists the external clusters.", "type": "http" }, "http": { "method": "GET", "url": "http://dbmgmt.{region}.oci.oraclecloud.com/20201101/externalClusters", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "compartmentId", "value": "", "type": "query", "description": "The [OCID](/Content/General/Concepts/identifiers.htm) of the compartment." }, { "name": "externalDbSystemId", "value": "", "type": "query", "description": "The [OCID](/Content/General/Concepts/identifiers.htm) of the external DB system." }, { "name": "displayName", "value": "", "type": "query", "description": "A filter to only return the resources that match the entire display name." }, { "name": "page", "value": "", "type": "query", "description": "The page token representing the page from where the next set of paginated results\nare retrieved. This is usually retrieved from a previous list call.\n" }, { "name": "limit", "value": "", "type": "query", "description": "The maximum number of records returned in the paginated response." }, { "name": "sortBy", "value": "", "type": "query", "description": "The field to sort information by. Only one sortOrder can be used. The default sort order\nfor `TIMECREATED` is descending and the default sort order for `DISPLAYNAME` is ascending.\nThe `DISPLAYNAME` sort order is case-sensitive.\n" }, { "name": "sortOrder", "value": "", "type": "query", "description": "The option to sort information in ascending (‘ASC’) or descending (‘DESC’) order. Ascending order is the default order." } ] }, "docs": "Lists the clusters in the specified external DB system." }, { "info": { "name": "Gets the external cluster details.", "type": "http" }, "http": { "method": "GET", "url": "http://dbmgmt.{region}.oci.oraclecloud.com/20201101/externalClusters/:externalClusterId", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "externalClusterId", "value": "", "type": "path", "description": "The [OCID](/Content/General/Concepts/identifiers.htm) of the external cluster." } ] }, "docs": "Gets the details for the external cluster specified by `externalClusterId`.\n" }, { "info": { "name": "Updates an external cluster.", "type": "http" }, "http": { "method": "PUT", "url": "http://dbmgmt.{region}.oci.oraclecloud.com/20201101/externalClusters/:externalClusterId", "headers": [ { "name": "opc-request-id", "value": "" }, { "name": "if-match", "value": "" } ], "params": [ { "name": "externalClusterId", "value": "", "type": "path", "description": "The [OCID](/Content/General/Concepts/identifiers.htm) of the external cluster." } ] }, "docs": "Updates the external cluster specified by `externalClusterId`.\n" }, { "info": { "name": "Gets the external cluster metrics.", "type": "http" }, "http": { "method": "GET", "url": "http://dbmgmt.{region}.oci.oraclecloud.com/20201101/externalClusters/:externalClusterId/metrics", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "externalClusterId", "value": "", "type": "path", "description": "The [OCID](/Content/General/Concepts/identifiers.htm) of the external cluster." }, { "name": "page", "value": "", "type": "query", "description": "The page token representing the page from where the next set of paginated results\nare retrieved. This is usually retrieved from a previous list call.\n" }, { "name": "limit", "value": "", "type": "query", "description": "The maximum number of records returned in the paginated response." }, { "name": "startTime", "value": "", "type": "query", "description": "The beginning of the time range set to retrieve metric data for the DB system\nand its members. Expressed in UTC in ISO-8601 format, which is `yyyy-MM-dd'T'hh:mm:ss.sss'Z'`.\n" }, { "name": "endTime", "value": "", "type": "query", "description": "The end of the time range set to retrieve metric data for the DB system\nand its members. Expressed in UTC in ISO-8601 format, which is `yyyy-MM-dd'T'hh:mm:ss.sss'Z'`.\n" }, { "name": "filterByMetricNames", "value": "", "type": "query", "description": "The filter used to retrieve a specific set of metrics by passing the desired metric names with a comma separator. Note that, by default, the service returns all supported metrics." } ] }, "docs": "Gets metrics for the external cluster specified by `externalClusterId`.\n" }, { "info": { "name": "Lists the external databases.", "type": "http" }, "http": { "method": "GET", "url": "http://dbmgmt.{region}.oci.oraclecloud.com/20201101/externalDatabases", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "compartmentId", "value": "", "type": "query", "description": "The [OCID](/Content/General/Concepts/identifiers.htm) of the compartment." }, { "name": "externalDbSystemId", "value": "", "type": "query", "description": "The [OCID](/Content/General/Concepts/identifiers.htm) of the external DB system." }, { "name": "externalDatabaseId", "value": "", "type": "query", "description": "The [OCID](/Content/General/Concepts/identifiers.htm) of the external database." }, { "name": "displayName", "value": "", "type": "query", "description": "A filter to only return the resources that match the entire display name." }, { "name": "page", "value": "", "type": "query", "description": "The page token representing the page from where the next set of paginated results\nare retrieved. This is usually retrieved from a previous list call.\n" }, { "name": "limit", "value": "", "type": "query", "description": "The maximum number of records returned in the paginated response." }, { "name": "sortBy", "value": "", "type": "query", "description": "The field to sort information by. Only one sortOrder can be used. The default sort order\nfor `TIMECREATED` is descending and the default sort order for `DISPLAYNAME` is ascending.\nThe `DISPLAYNAME` sort order is case-sensitive.\n" }, { "name": "sortOrder", "value": "", "type": "query", "description": "The option to sort information in ascending (‘ASC’) or descending (‘DESC’) order. Ascending order is the default order." } ] }, "docs": "Lists the external databases in the specified compartment or in the specified DB system." }, { "info": { "name": "Lists the external DB homes.", "type": "http" }, "http": { "method": "GET", "url": "http://dbmgmt.{region}.oci.oraclecloud.com/20201101/externalDbHomes", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "compartmentId", "value": "", "type": "query", "description": "The [OCID](/Content/General/Concepts/identifiers.htm) of the compartment." }, { "name": "externalDbSystemId", "value": "", "type": "query", "description": "The [OCID](/Content/General/Concepts/identifiers.htm) of the external DB system." }, { "name": "displayName", "value": "", "type": "query", "description": "A filter to only return the resources that match the entire display name." }, { "name": "page", "value": "", "type": "query", "description": "The page token representing the page from where the next set of paginated results\nare retrieved. This is usually retrieved from a previous list call.\n" }, { "name": "limit", "value": "", "type": "query", "description": "The maximum number of records returned in the paginated response." }, { "name": "sortBy", "value": "", "type": "query", "description": "The field to sort information by. Only one sortOrder can be used. The default sort order\nfor `TIMECREATED` is descending and the default sort order for `DISPLAYNAME` is ascending.\nThe `DISPLAYNAME` sort order is case-sensitive.\n" }, { "name": "sortOrder", "value": "", "type": "query", "description": "The option to sort information in ascending (‘ASC’) or descending (‘DESC’) order. Ascending order is the default order." } ] }, "docs": "Lists the DB homes in the specified external DB system." }, { "info": { "name": "Gets the external DB home details.", "type": "http" }, "http": { "method": "GET", "url": "http://dbmgmt.{region}.oci.oraclecloud.com/20201101/externalDbHomes/:externalDbHomeId", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "externalDbHomeId", "value": "", "type": "path", "description": "The [OCID](/Content/General/Concepts/identifiers.htm) of the external database home." } ] }, "docs": "Gets the details for the external DB home specified by `externalDbHomeId`.\n" }, { "info": { "name": "Updates an external DB home.", "type": "http" }, "http": { "method": "PUT", "url": "http://dbmgmt.{region}.oci.oraclecloud.com/20201101/externalDbHomes/:externalDbHomeId", "headers": [ { "name": "opc-request-id", "value": "" }, { "name": "if-match", "value": "" } ], "params": [ { "name": "externalDbHomeId", "value": "", "type": "path", "description": "The [OCID](/Content/General/Concepts/identifiers.htm) of the external database home." } ] }, "docs": "Updates the external DB home specified by `externalDbHomeId`.\n" }, { "info": { "name": "Lists the external DB nodes.", "type": "http" }, "http": { "method": "GET", "url": "http://dbmgmt.{region}.oci.oraclecloud.com/20201101/externalDbNodes", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "compartmentId", "value": "", "type": "query", "description": "The [OCID](/Content/General/Concepts/identifiers.htm) of the compartment." }, { "name": "externalDbSystemId", "value": "", "type": "query", "description": "The [OCID](/Content/General/Concepts/identifiers.htm) of the external DB system." }, { "name": "displayName", "value": "", "type": "query", "description": "A filter to only return the resources that match the entire display name." }, { "name": "page", "value": "", "type": "query", "description": "The page token representing the page from where the next set of paginated results\nare retrieved. This is usually retrieved from a previous list call.\n" }, { "name": "limit", "value": "", "type": "query", "description": "The maximum number of records returned in the paginated response." }, { "name": "sortBy", "value": "", "type": "query", "description": "The field to sort information by. Only one sortOrder can be used. The default sort order\nfor `TIMECREATED` is descending and the default sort order for `DISPLAYNAME` is ascending.\nThe `DISPLAYNAME` sort order is case-sensitive.\n" }, { "name": "sortOrder", "value": "", "type": "query", "description": "The option to sort information in ascending (‘ASC’) or descending (‘DESC’) order. Ascending order is the default order." } ] }, "docs": "Lists the external DB nodes in the specified external DB system." }, { "info": { "name": "Gets the external DB node details.", "type": "http" }, "http": { "method": "GET", "url": "http://dbmgmt.{region}.oci.oraclecloud.com/20201101/externalDbNodes/:externalDbNodeId", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "externalDbNodeId", "value": "", "type": "path", "description": "The [OCID](/Content/General/Concepts/identifiers.htm) of the external database node." } ] }, "docs": "Gets the details for the external DB node specified by `externalDbNodeId`.\n" }, { "info": { "name": "Updates an external DB node.", "type": "http" }, "http": { "method": "PUT", "url": "http://dbmgmt.{region}.oci.oraclecloud.com/20201101/externalDbNodes/:externalDbNodeId", "headers": [ { "name": "opc-request-id", "value": "" }, { "name": "if-match", "value": "" } ], "params": [ { "name": "externalDbNodeId", "value": "", "type": "path", "description": "The [OCID](/Content/General/Concepts/identifiers.htm) of the external database node." } ] }, "docs": "Updates the external DB node specified by `externalDbNodeId`.\n" }, { "info": { "name": "Gets the external DB nodemetrics.", "type": "http" }, "http": { "method": "GET", "url": "http://dbmgmt.{region}.oci.oraclecloud.com/20201101/externalDbNodes/:externalDbNodeId/metrics", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "externalDbNodeId", "value": "", "type": "path", "description": "The [OCID](/Content/General/Concepts/identifiers.htm) of the external database node." }, { "name": "page", "value": "", "type": "query", "description": "The page token representing the page from where the next set of paginated results\nare retrieved. This is usually retrieved from a previous list call.\n" }, { "name": "limit", "value": "", "type": "query", "description": "The maximum number of records returned in the paginated response." }, { "name": "startTime", "value": "", "type": "query", "description": "The beginning of the time range set to retrieve metric data for the DB system\nand its members. Expressed in UTC in ISO-8601 format, which is `yyyy-MM-dd'T'hh:mm:ss.sss'Z'`.\n" }, { "name": "endTime", "value": "", "type": "query", "description": "The end of the time range set to retrieve metric data for the DB system\nand its members. Expressed in UTC in ISO-8601 format, which is `yyyy-MM-dd'T'hh:mm:ss.sss'Z'`.\n" }, { "name": "filterByMetricNames", "value": "", "type": "query", "description": "The filter used to retrieve a specific set of metrics by passing the desired metric names with a comma separator. Note that, by default, the service returns all supported metrics." } ] }, "docs": "Gets metrics for the external DB node specified by `externalDbNodeId`.\n" }, { "info": { "name": "Lists the external connectors.", "type": "http" }, "http": { "method": "GET", "url": "http://dbmgmt.{region}.oci.oraclecloud.com/20201101/externalDbSystemConnectors", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "compartmentId", "value": "", "type": "query", "description": "The [OCID](/Content/General/Concepts/identifiers.htm) of the compartment." }, { "name": "externalDbSystemId", "value": "", "type": "query", "description": "The [OCID](/Content/General/Concepts/identifiers.htm) of the external DB system." }, { "name": "displayName", "value": "", "type": "query", "description": "A filter to only return the resources that match the entire display name." }, { "name": "page", "value": "", "type": "query", "description": "The page token representing the page from where the next set of paginated results\nare retrieved. This is usually retrieved from a previous list call.\n" }, { "name": "limit", "value": "", "type": "query", "description": "The maximum number of records returned in the paginated response." }, { "name": "sortBy", "value": "", "type": "query", "description": "The field to sort information by. Only one sortOrder can be used. The default sort order\nfor `TIMECREATED` is descending and the default sort order for `DISPLAYNAME` is ascending.\nThe `DISPLAYNAME` sort order is case-sensitive.\n" }, { "name": "sortOrder", "value": "", "type": "query", "description": "The option to sort information in ascending (‘ASC’) or descending (‘DESC’) order. Ascending order is the default order." } ] }, "docs": "Lists the external connectors in the specified external DB system." }, { "info": { "name": "Creates an external connector.", "type": "http" }, "http": { "method": "POST", "url": "http://dbmgmt.{region}.oci.oraclecloud.com/20201101/externalDbSystemConnectors", "headers": [ { "name": "opc-request-id", "value": "" }, { "name": "opc-retry-token", "value": "" } ] }, "docs": "Creates a new external connector." }, { "info": { "name": "Gets the external connector details.", "type": "http" }, "http": { "method": "GET", "url": "http://dbmgmt.{region}.oci.oraclecloud.com/20201101/externalDbSystemConnectors/:externalDbSystemConnectorId", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "externalDbSystemConnectorId", "value": "", "type": "path", "description": "The [OCID](/Content/General/Concepts/identifiers.htm) of the external connector." } ] }, "docs": "Gets the details for the external connector specified by `externalDbSystemConnectorId`.\n" }, { "info": { "name": "Updates an external connector.", "type": "http" }, "http": { "method": "PUT", "url": "http://dbmgmt.{region}.oci.oraclecloud.com/20201101/externalDbSystemConnectors/:externalDbSystemConnectorId", "headers": [ { "name": "if-match", "value": "" }, { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "externalDbSystemConnectorId", "value": "", "type": "path", "description": "The [OCID](/Content/General/Concepts/identifiers.htm) of the external connector." } ] }, "docs": "Updates the external connector specified by `externalDbSystemConnectorId`." }, { "info": { "name": "Deletes the external connector.", "type": "http" }, "http": { "method": "DELETE", "url": "http://dbmgmt.{region}.oci.oraclecloud.com/20201101/externalDbSystemConnectors/:externalDbSystemConnectorId", "headers": [ { "name": "opc-request-id", "value": "" }, { "name": "if-match", "value": "" } ], "params": [ { "name": "externalDbSystemConnectorId", "value": "", "type": "path", "description": "The [OCID](/Content/General/Concepts/identifiers.htm) of the external connector." } ] }, "docs": "Deletes the external connector specified by `externalDbSystemConnectorId`.\n" }, { "info": { "name": "Checks the connectivity status of an external connector.", "type": "http" }, "http": { "method": "POST", "url": "http://dbmgmt.{region}.oci.oraclecloud.com/20201101/externalDbSystemConnectors/:externalDbSystemConnectorId/actions/checkConnectionStatus", "headers": [ { "name": "if-match", "value": "" }, { "name": "opc-request-id", "value": "" }, { "name": "opc-retry-token", "value": "" } ], "params": [ { "name": "externalDbSystemConnectorId", "value": "", "type": "path", "description": "The [OCID](/Content/General/Concepts/identifiers.htm) of the external connector." } ] }, "docs": "Checks the status of the external DB system component connection specified in this connector.\nThis operation will refresh the connectionStatus and timeConnectionStatusLastUpdated fields.\n" }, { "info": { "name": "Lists the external DB system discovery resources.", "type": "http" }, "http": { "method": "GET", "url": "http://dbmgmt.{region}.oci.oraclecloud.com/20201101/externalDbSystemDiscoveries", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "compartmentId", "value": "", "type": "query", "description": "The [OCID](/Content/General/Concepts/identifiers.htm) of the compartment." }, { "name": "displayName", "value": "", "type": "query", "description": "A filter to only return the resources that match the entire display name." }, { "name": "page", "value": "", "type": "query", "description": "The page token representing the page from where the next set of paginated results\nare retrieved. This is usually retrieved from a previous list call.\n" }, { "name": "limit", "value": "", "type": "query", "description": "The maximum number of records returned in the paginated response." }, { "name": "sortBy", "value": "", "type": "query", "description": "The field to sort information by. Only one sortOrder can be used. The default sort order\nfor `TIMECREATED` is descending and the default sort order for `DISPLAYNAME` is ascending.\nThe `DISPLAYNAME` sort order is case-sensitive.\n" }, { "name": "sortOrder", "value": "", "type": "query", "description": "The option to sort information in ascending (‘ASC’) or descending (‘DESC’) order. Ascending order is the default order." } ] }, "docs": "Lists the external DB system discovery resources in the specified compartment." }, { "info": { "name": "Creates an external DB system discovery resource.", "type": "http" }, "http": { "method": "POST", "url": "http://dbmgmt.{region}.oci.oraclecloud.com/20201101/externalDbSystemDiscoveries", "headers": [ { "name": "opc-request-id", "value": "" }, { "name": "opc-retry-token", "value": "" } ] }, "docs": "Creates an external DB system discovery resource and initiates the discovery process.\n" }, { "info": { "name": "Gets the external DB system discovery details.", "type": "http" }, "http": { "method": "GET", "url": "http://dbmgmt.{region}.oci.oraclecloud.com/20201101/externalDbSystemDiscoveries/:externalDbSystemDiscoveryId", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "externalDbSystemDiscoveryId", "value": "", "type": "path", "description": "The [OCID](/Content/General/Concepts/identifiers.htm) of the external DB system discovery." } ] }, "docs": "Gets the details for the external DB system discovery resource specified by `externalDbSystemDiscoveryId`.\n" }, { "info": { "name": "Updates an external DB system discovery.", "type": "http" }, "http": { "method": "PUT", "url": "http://dbmgmt.{region}.oci.oraclecloud.com/20201101/externalDbSystemDiscoveries/:externalDbSystemDiscoveryId", "headers": [ { "name": "opc-request-id", "value": "" }, { "name": "if-match", "value": "" } ], "params": [ { "name": "externalDbSystemDiscoveryId", "value": "", "type": "path", "description": "The [OCID](/Content/General/Concepts/identifiers.htm) of the external DB system discovery." } ] }, "docs": "Updates the external DB system discovery specified by `externalDbSystemDiscoveryId`.\n" }, { "info": { "name": "Updates an external DB system discovery.", "type": "http" }, "http": { "method": "PATCH", "url": "http://dbmgmt.{region}.oci.oraclecloud.com/20201101/externalDbSystemDiscoveries/:externalDbSystemDiscoveryId", "headers": [ { "name": "opc-request-id", "value": "" }, { "name": "if-match", "value": "" } ], "params": [ { "name": "externalDbSystemDiscoveryId", "value": "", "type": "path", "description": "The [OCID](/Content/General/Concepts/identifiers.htm) of the external DB system discovery." } ] }, "docs": "Patches the external DB system discovery specified by `externalDbSystemDiscoveryId`.\n" }, { "info": { "name": "Deletes the external DB system discovery resource.", "type": "http" }, "http": { "method": "DELETE", "url": "http://dbmgmt.{region}.oci.oraclecloud.com/20201101/externalDbSystemDiscoveries/:externalDbSystemDiscoveryId", "headers": [ { "name": "opc-request-id", "value": "" }, { "name": "if-match", "value": "" } ], "params": [ { "name": "externalDbSystemDiscoveryId", "value": "", "type": "path", "description": "The [OCID](/Content/General/Concepts/identifiers.htm) of the external DB system discovery." } ] }, "docs": "Deletes the external DB system discovery resource specified by `externalDbSystemDiscoveryId`.\n" }, { "info": { "name": "Lists the external DB systems.", "type": "http" }, "http": { "method": "GET", "url": "http://dbmgmt.{region}.oci.oraclecloud.com/20201101/externalDbSystems", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "compartmentId", "value": "", "type": "query", "description": "The [OCID](/Content/General/Concepts/identifiers.htm) of the compartment." }, { "name": "displayName", "value": "", "type": "query", "description": "A filter to only return the resources that match the entire display name." }, { "name": "page", "value": "", "type": "query", "description": "The page token representing the page from where the next set of paginated results\nare retrieved. This is usually retrieved from a previous list call.\n" }, { "name": "limit", "value": "", "type": "query", "description": "The maximum number of records returned in the paginated response." }, { "name": "sortBy", "value": "", "type": "query", "description": "The field to sort information by. Only one sortOrder can be used. The default sort order\nfor `TIMECREATED` is descending and the default sort order for `DISPLAYNAME` is ascending.\nThe `DISPLAYNAME` sort order is case-sensitive.\n" }, { "name": "sortOrder", "value": "", "type": "query", "description": "The option to sort information in ascending (‘ASC’) or descending (‘DESC’) order. Ascending order is the default order." } ] }, "docs": "Lists the external DB systems in the specified compartment." }, { "info": { "name": "Creates an external DB system.", "type": "http" }, "http": { "method": "POST", "url": "http://dbmgmt.{region}.oci.oraclecloud.com/20201101/externalDbSystems", "headers": [ { "name": "opc-request-id", "value": "" }, { "name": "opc-retry-token", "value": "" } ] }, "docs": "Creates an external DB system and its related resources.\n" }, { "info": { "name": "Gets the external DB system details.", "type": "http" }, "http": { "method": "GET", "url": "http://dbmgmt.{region}.oci.oraclecloud.com/20201101/externalDbSystems/:externalDbSystemId", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "externalDbSystemId", "value": "", "type": "path", "description": "The [OCID](/Content/General/Concepts/identifiers.htm) of the external DB system." } ] }, "docs": "Gets the details for the external DB system specified by `externalDbSystemId`.\n" }, { "info": { "name": "Updates an external DB system.", "type": "http" }, "http": { "method": "PUT", "url": "http://dbmgmt.{region}.oci.oraclecloud.com/20201101/externalDbSystems/:externalDbSystemId", "headers": [ { "name": "opc-request-id", "value": "" }, { "name": "if-match", "value": "" } ], "params": [ { "name": "externalDbSystemId", "value": "", "type": "path", "description": "The [OCID](/Content/General/Concepts/identifiers.htm) of the external DB system." } ] }, "docs": "Updates the external DB system specified by `externalDbSystemId`.\n" }, { "info": { "name": "Deletes the external DB system.", "type": "http" }, "http": { "method": "DELETE", "url": "http://dbmgmt.{region}.oci.oraclecloud.com/20201101/externalDbSystems/:externalDbSystemId", "headers": [ { "name": "opc-request-id", "value": "" }, { "name": "if-match", "value": "" } ], "params": [ { "name": "externalDbSystemId", "value": "", "type": "path", "description": "The [OCID](/Content/General/Concepts/identifiers.htm) of the external DB system." } ] }, "docs": "Deletes the external DB system specified by `externalDbSystemId`.\n" }, { "info": { "name": "Moves an external DB system to a different compartment.", "type": "http" }, "http": { "method": "POST", "url": "http://dbmgmt.{region}.oci.oraclecloud.com/20201101/externalDbSystems/:externalDbSystemId/actions/changeCompartment", "headers": [ { "name": "opc-request-id", "value": "" }, { "name": "opc-retry-token", "value": "" }, { "name": "if-match", "value": "" } ], "params": [ { "name": "externalDbSystemId", "value": "", "type": "path", "description": "The [OCID](/Content/General/Concepts/identifiers.htm) of the external DB system." } ] }, "docs": "Moves the external DB system and its related resources (excluding databases) to the specified compartment.\n" }, { "info": { "name": "Disables Database Management service for the external DB system.", "type": "http" }, "http": { "method": "POST", "url": "http://dbmgmt.{region}.oci.oraclecloud.com/20201101/externalDbSystems/:externalDbSystemId/actions/disableDatabaseManagement", "headers": [ { "name": "opc-request-id", "value": "" }, { "name": "opc-retry-token", "value": "" }, { "name": "if-match", "value": "" } ], "params": [ { "name": "externalDbSystemId", "value": "", "type": "path", "description": "The [OCID](/Content/General/Concepts/identifiers.htm) of the external DB system." } ] }, "docs": "Disables Database Management service for all the components of the specified\nexternal DB system (except databases).\n" }, { "info": { "name": "Disables Stack monitoring service for the external DB system.", "type": "http" }, "http": { "method": "POST", "url": "http://dbmgmt.{region}.oci.oraclecloud.com/20201101/externalDbSystems/:externalDbSystemId/actions/disableStackMonitoring", "headers": [ { "name": "opc-request-id", "value": "" }, { "name": "opc-retry-token", "value": "" }, { "name": "if-match", "value": "" } ], "params": [ { "name": "externalDbSystemId", "value": "", "type": "path", "description": "The [OCID](/Content/General/Concepts/identifiers.htm) of the external DB system." } ] }, "docs": "Disables Stack Monitoring for all the components of the specified\nexternal DB system (except databases).\n" }, { "info": { "name": "Enables Database Management service for the external DB system.", "type": "http" }, "http": { "method": "POST", "url": "http://dbmgmt.{region}.oci.oraclecloud.com/20201101/externalDbSystems/:externalDbSystemId/actions/enableDatabaseManagement", "headers": [ { "name": "opc-request-id", "value": "" }, { "name": "opc-retry-token", "value": "" }, { "name": "if-match", "value": "" } ], "params": [ { "name": "externalDbSystemId", "value": "", "type": "path", "description": "The [OCID](/Content/General/Concepts/identifiers.htm) of the external DB system." } ] }, "docs": "Enables Database Management service for all the components of the specified\nexternal DB system (except databases).\n" }, { "info": { "name": "Enables Stack Monitoring service for the external DB system.", "type": "http" }, "http": { "method": "POST", "url": "http://dbmgmt.{region}.oci.oraclecloud.com/20201101/externalDbSystems/:externalDbSystemId/actions/enableStackMonitoring", "headers": [ { "name": "opc-request-id", "value": "" }, { "name": "opc-retry-token", "value": "" }, { "name": "if-match", "value": "" } ], "params": [ { "name": "externalDbSystemId", "value": "", "type": "path", "description": "The [OCID](/Content/General/Concepts/identifiers.htm) of the external DB system." } ] }, "docs": "Enables Stack Monitoring for all the components of the specified\nexternal DB system (except databases).\n" }, { "info": { "name": "Gets availability metrics for the external DB system components.", "type": "http" }, "http": { "method": "GET", "url": "http://dbmgmt.{region}.oci.oraclecloud.com/20201101/externalDbSystems/:externalDbSystemId/availabilityMetrics", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "externalDbSystemId", "value": "", "type": "path", "description": "The [OCID](/Content/General/Concepts/identifiers.htm) of the external DB system." }, { "name": "page", "value": "", "type": "query", "description": "The page token representing the page from where the next set of paginated results\nare retrieved. This is usually retrieved from a previous list call.\n" }, { "name": "limit", "value": "", "type": "query", "description": "The maximum number of records returned in the paginated response." }, { "name": "filterByComponentTypes", "value": "", "type": "query", "description": "The filter used to retrieve metrics for a specific set of component types by passing the desired component types separated by a comma. Note that, by default, the service returns metrics for all DB system component types." }, { "name": "startTime", "value": "", "type": "query", "description": "The beginning of the time range set to retrieve metric data for the DB system\nand its members. Expressed in UTC in ISO-8601 format, which is `yyyy-MM-dd'T'hh:mm:ss.sss'Z'`.\n" }, { "name": "endTime", "value": "", "type": "query", "description": "The end of the time range set to retrieve metric data for the DB system\nand its members. Expressed in UTC in ISO-8601 format, which is `yyyy-MM-dd'T'hh:mm:ss.sss'Z'`.\n" } ] }, "docs": "Gets availability metrics for the components present in the external DB system specified by `externalDbSystemId`.\n" }, { "info": { "name": "Lists the external Exadata infrastructures.", "type": "http" }, "http": { "method": "GET", "url": "http://dbmgmt.{region}.oci.oraclecloud.com/20201101/externalExadataInfrastructures", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "compartmentId", "value": "", "type": "query", "description": "The [OCID](/Content/General/Concepts/identifiers.htm) of the compartment." }, { "name": "displayName", "value": "", "type": "query", "description": "The optional single value query filter parameter on the entity display name." }, { "name": "page", "value": "", "type": "query", "description": "The page token representing the page from where the next set of paginated results\nare retrieved. This is usually retrieved from a previous list call.\n" }, { "name": "limit", "value": "", "type": "query", "description": "The maximum number of records returned in the paginated response." }, { "name": "sortBy", "value": "", "type": "query", "description": "The field to sort information by. Only one sortOrder can be used. The default sort order\nfor ‘TIMECREATED’ is descending and the default sort order for ‘NAME’ is ascending.\nThe ‘NAME’ sort order is case-sensitive.\n" }, { "name": "sortOrder", "value": "", "type": "query", "description": "The option to sort information in ascending (‘ASC’) or descending (‘DESC’) order. Ascending order is the default order." } ] }, "docs": "Lists the Exadata infrastructure resources in the specified compartment.\n" }, { "info": { "name": "Creates an OCI resource for the Exadata infrastructure.", "type": "http" }, "http": { "method": "POST", "url": "http://dbmgmt.{region}.oci.oraclecloud.com/20201101/externalExadataInfrastructures", "headers": [ { "name": "opc-request-id", "value": "" }, { "name": "opc-retry-token", "value": "" } ] }, "docs": "Creates an OCI resource for the Exadata infrastructure and enables the Monitoring service for the Exadata infrastructure.\nThe following resource/subresources are created:\n Infrastructure\n Storage server connectors\n Storage servers\n Storage grids\n" }, { "info": { "name": "Start the discovery process for Exadata system infrastructure from the specified agent.", "type": "http" }, "http": { "method": "POST", "url": "http://dbmgmt.{region}.oci.oraclecloud.com/20201101/externalExadataInfrastructures/actions/discoverExadataInfrastructure", "headers": [ { "name": "opc-request-id", "value": "" }, { "name": "opc-retry-token", "value": "" }, { "name": "if-match", "value": "" } ] }, "docs": "Completes the Exadata system prechecking on the following:\n\n- Verifies if the DB systems are valid RAC DB systems or return 400 status code with NON_RAC_DATABASE_SYSTEM error code.\n- Verifies if the ASM connector defined for each DB system or return 400 status code with CONNECTOR_NOT_DEFINED error code.\n- Verifies if the agents associated with ASM are valid and could be used for the Exadata storage servers or return 400 status code with \nINVALID_AGENT error code.\n- Verifies if it is an Exadata s" }, { "info": { "name": "Gets the Exadata infrastructure details.", "type": "http" }, "http": { "method": "GET", "url": "http://dbmgmt.{region}.oci.oraclecloud.com/20201101/externalExadataInfrastructures/:externalExadataInfrastructureId", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "externalExadataInfrastructureId", "value": "", "type": "path", "description": "The [OCID](/Content/General/Concepts/identifiers.htm) of the Exadata infrastructure." } ] }, "docs": "Gets the details for the Exadata infrastructure specified by externalExadataInfrastructureId. It includes the DB systems and storage grid within the\nExadata infrastructure.\n" }, { "info": { "name": "Update the Exadata infrastructure.", "type": "http" }, "http": { "method": "PUT", "url": "http://dbmgmt.{region}.oci.oraclecloud.com/20201101/externalExadataInfrastructures/:externalExadataInfrastructureId", "headers": [ { "name": "opc-request-id", "value": "" }, { "name": "if-match", "value": "" }, { "name": "opc-retry-token", "value": "" } ], "params": [ { "name": "externalExadataInfrastructureId", "value": "", "type": "path", "description": "The [OCID](/Content/General/Concepts/identifiers.htm) of the Exadata infrastructure." } ] }, "docs": "Updates the details for the Exadata infrastructure specified by externalExadataInfrastructureId.\n" }, { "info": { "name": "Deletes the Exadata infrastructure.", "type": "http" }, "http": { "method": "DELETE", "url": "http://dbmgmt.{region}.oci.oraclecloud.com/20201101/externalExadataInfrastructures/:externalExadataInfrastructureId", "headers": [ { "name": "opc-request-id", "value": "" }, { "name": "if-match", "value": "" } ], "params": [ { "name": "externalExadataInfrastructureId", "value": "", "type": "path", "description": "The [OCID](/Content/General/Concepts/identifiers.htm) of the Exadata infrastructure." } ] }, "docs": "Deletes the Exadata infrastructure specified by externalExadataInfrastructureId.\n" }, { "info": { "name": "Moves the Exadata infrastructure and its resources to a different compartment.", "type": "http" }, "http": { "method": "POST", "url": "http://dbmgmt.{region}.oci.oraclecloud.com/20201101/externalExadataInfrastructures/:externalExadataInfrastructureId/actions/changeCompartment", "headers": [ { "name": "opc-request-id", "value": "" }, { "name": "opc-retry-token", "value": "" }, { "name": "if-match", "value": "" } ], "params": [ { "name": "externalExadataInfrastructureId", "value": "", "type": "path", "description": "The [OCID](/Content/General/Concepts/identifiers.htm) of the Exadata infrastructure." } ] }, "docs": "Moves the Exadata infrastructure and its related resources (Exadata storage server, Exadata storage server connectors and Exadata storage server grid) to the specified compartment.\n" }, { "info": { "name": "Disables Database Management for the Exadata infrastructure.", "type": "http" }, "http": { "method": "POST", "url": "http://dbmgmt.{region}.oci.oraclecloud.com/20201101/externalExadataInfrastructures/:externalExadataInfrastructureId/actions/disableDatabaseManagement", "headers": [ { "name": "opc-request-id", "value": "" }, { "name": "opc-retry-token", "value": "" }, { "name": "if-match", "value": "" } ], "params": [ { "name": "externalExadataInfrastructureId", "value": "", "type": "path", "description": "The [OCID](/Content/General/Concepts/identifiers.htm) of the Exadata infrastructure." } ] }, "docs": "Disables Database Management for the Exadata infrastructure specified by externalExadataInfrastructureId.\nIt covers the following components:\n\n- Exadata infrastructure\n- Exadata storage grid\n- Exadata storage server\n\nNote that Database Management will not be disabled for the DB systems within the Exadata infrastructure and should be disabled explicitly, if required.\n" }, { "info": { "name": "Enables Database Management for the Exadata infrastructure.", "type": "http" }, "http": { "method": "POST", "url": "http://dbmgmt.{region}.oci.oraclecloud.com/20201101/externalExadataInfrastructures/:externalExadataInfrastructureId/actions/enableDatabaseManagement", "headers": [ { "name": "opc-request-id", "value": "" }, { "name": "opc-retry-token", "value": "" }, { "name": "if-match", "value": "" } ], "params": [ { "name": "externalExadataInfrastructureId", "value": "", "type": "path", "description": "The [OCID](/Content/General/Concepts/identifiers.htm) of the Exadata infrastructure." } ] }, "docs": "Enables Database Management for the Exadata infrastructure specified by externalExadataInfrastructureId. It covers the following \ncomponents:\n\n- Exadata infrastructure\n- Exadata storage grid\n- Exadata storage server\n" }, { "info": { "name": "Lists the external connectors.", "type": "http" }, "http": { "method": "GET", "url": "http://dbmgmt.{region}.oci.oraclecloud.com/20201101/externalExadataStorageConnectors", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "compartmentId", "value": "", "type": "query", "description": "The [OCID](/Content/General/Concepts/identifiers.htm) of the compartment." }, { "name": "externalExadataInfrastructureId", "value": "", "type": "query", "description": "The [OCID](/Content/General/Concepts/identifiers.htm) of the Exadata infrastructure." }, { "name": "displayName", "value": "", "type": "query", "description": "The optional single value query filter parameter on the entity display name." }, { "name": "page", "value": "", "type": "query", "description": "The page token representing the page from where the next set of paginated results\nare retrieved. This is usually retrieved from a previous list call.\n" }, { "name": "limit", "value": "", "type": "query", "description": "The maximum number of records returned in the paginated response." }, { "name": "sortBy", "value": "", "type": "query", "description": "The field to sort information by. Only one sortOrder can be used. The default sort order\nfor ‘TIMECREATED’ is descending and the default sort order for ‘NAME’ is ascending.\nThe ‘NAME’ sort order is case-sensitive.\n" }, { "name": "sortOrder", "value": "", "type": "query", "description": "The option to sort information in ascending (‘ASC’) or descending (‘DESC’) order. Ascending order is the default order." } ] }, "docs": "Lists the Exadata storage server connectors for the specified Exadata infrastructure.\n" }, { "info": { "name": "Creates an Exadata storage server connector.", "type": "http" }, "http": { "method": "POST", "url": "http://dbmgmt.{region}.oci.oraclecloud.com/20201101/externalExadataStorageConnectors", "headers": [ { "name": "opc-request-id", "value": "" }, { "name": "opc-retry-token", "value": "" } ] }, "docs": "Creates the Exadata storage server connector after validating the connection information.\n" }, { "info": { "name": "Gets the Exadata storage server connector details.", "type": "http" }, "http": { "method": "GET", "url": "http://dbmgmt.{region}.oci.oraclecloud.com/20201101/externalExadataStorageConnectors/:externalExadataStorageConnectorId", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "externalExadataStorageConnectorId", "value": "", "type": "path", "description": "The [OCID](/Content/General/Concepts/identifiers.htm) of the connector to the Exadata storage server." } ] }, "docs": "Gets the details for the Exadata storage server connector specified by exadataStorageConnectorId.\n" }, { "info": { "name": "Updates an Exadata storage server connector.", "type": "http" }, "http": { "method": "PUT", "url": "http://dbmgmt.{region}.oci.oraclecloud.com/20201101/externalExadataStorageConnectors/:externalExadataStorageConnectorId", "headers": [ { "name": "if-match", "value": "" }, { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "externalExadataStorageConnectorId", "value": "", "type": "path", "description": "The [OCID](/Content/General/Concepts/identifiers.htm) of the connector to the Exadata storage server." } ] }, "docs": "Updates the Exadata storage server connector specified by exadataStorageConnectorId.\n" }, { "info": { "name": "Deletes the external connector.", "type": "http" }, "http": { "method": "DELETE", "url": "http://dbmgmt.{region}.oci.oraclecloud.com/20201101/externalExadataStorageConnectors/:externalExadataStorageConnectorId", "headers": [ { "name": "opc-request-id", "value": "" }, { "name": "if-match", "value": "" } ], "params": [ { "name": "externalExadataStorageConnectorId", "value": "", "type": "path", "description": "The [OCID](/Content/General/Concepts/identifiers.htm) of the connector to the Exadata storage server." } ] }, "docs": "Deletes the Exadata storage server connector specified by exadataStorageConnectorId.\n" }, { "info": { "name": "Checks the connectivity status of the Exadata storage server connection.", "type": "http" }, "http": { "method": "POST", "url": "http://dbmgmt.{region}.oci.oraclecloud.com/20201101/externalExadataStorageConnectors/:externalExadataStorageConnectorId/actions/checkStatus", "headers": [ { "name": "if-match", "value": "" }, { "name": "opc-request-id", "value": "" }, { "name": "opc-retry-token", "value": "" } ], "params": [ { "name": "externalExadataStorageConnectorId", "value": "", "type": "path", "description": "The [OCID](/Content/General/Concepts/identifiers.htm) of the connector to the Exadata storage server." } ] }, "docs": "Checks the status of the Exadata storage server connection specified by exadataStorageConnectorId.\n" }, { "info": { "name": "Gets the Exadata storage server grid details.", "type": "http" }, "http": { "method": "GET", "url": "http://dbmgmt.{region}.oci.oraclecloud.com/20201101/externalExadataStorageGrids/:externalExadataStorageGridId", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "externalExadataStorageGridId", "value": "", "type": "path", "description": "The [OCID](/Content/General/Concepts/identifiers.htm) of the Exadata storage grid." } ] }, "docs": "Gets the details for the Exadata storage server grid specified by exadataStorageGridId.\n" }, { "info": { "name": "Updates the Exadata storage server grid details.", "type": "http" }, "http": { "method": "PUT", "url": "http://dbmgmt.{region}.oci.oraclecloud.com/20201101/externalExadataStorageGrids/:externalExadataStorageGridId", "headers": [ { "name": "opc-request-id", "value": "" }, { "name": "if-match", "value": "" } ], "params": [ { "name": "externalExadataStorageGridId", "value": "", "type": "path", "description": "The [OCID](/Content/General/Concepts/identifiers.htm) of the Exadata storage grid." } ] }, "docs": "Updates the Exadata storage server grid specified by exadataStorageGridId.\n" }, { "info": { "name": "Lists the external storage servers.", "type": "http" }, "http": { "method": "GET", "url": "http://dbmgmt.{region}.oci.oraclecloud.com/20201101/externalExadataStorageServers", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "compartmentId", "value": "", "type": "query", "description": "The [OCID](/Content/General/Concepts/identifiers.htm) of the compartment." }, { "name": "externalExadataInfrastructureId", "value": "", "type": "query", "description": "The [OCID](/Content/General/Concepts/identifiers.htm) of the Exadata infrastructure." }, { "name": "displayName", "value": "", "type": "query", "description": "The optional single value query filter parameter on the entity display name." }, { "name": "page", "value": "", "type": "query", "description": "The page token representing the page from where the next set of paginated results\nare retrieved. This is usually retrieved from a previous list call.\n" }, { "name": "limit", "value": "", "type": "query", "description": "The maximum number of records returned in the paginated response." }, { "name": "sortBy", "value": "", "type": "query", "description": "The field to sort information by. Only one sortOrder can be used. The default sort order\nfor ‘TIMECREATED’ is descending and the default sort order for ‘NAME’ is ascending.\nThe ‘NAME’ sort order is case-sensitive.\n" }, { "name": "sortOrder", "value": "", "type": "query", "description": "The option to sort information in ascending (‘ASC’) or descending (‘DESC’) order. Ascending order is the default order." } ] }, "docs": "Lists the Exadata storage servers for the specified Exadata infrastructure.\n" }, { "info": { "name": "Gets the Exadata storage server summary.", "type": "http" }, "http": { "method": "GET", "url": "http://dbmgmt.{region}.oci.oraclecloud.com/20201101/externalExadataStorageServers/:externalExadataStorageServerId", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "externalExadataStorageServerId", "value": "", "type": "path", "description": "The [OCID](/Content/General/Concepts/identifiers.htm) of the Exadata storage server." } ] }, "docs": "Gets the summary for the Exadata storage server specified by exadataStorageServerId.\n" }, { "info": { "name": "Updates the Exadata storage server.", "type": "http" }, "http": { "method": "PUT", "url": "http://dbmgmt.{region}.oci.oraclecloud.com/20201101/externalExadataStorageServers/:externalExadataStorageServerId", "headers": [ { "name": "opc-request-id", "value": "" }, { "name": "if-match", "value": "" } ], "params": [ { "name": "externalExadataStorageServerId", "value": "", "type": "path", "description": "The [OCID](/Content/General/Concepts/identifiers.htm) of the Exadata storage server." } ] }, "docs": "Updates the Exadata storage server specified by exadataStorageServerId.\n" }, { "info": { "name": "Gets the IORM plan from the specified Exadata storage server.", "type": "http" }, "http": { "method": "GET", "url": "http://dbmgmt.{region}.oci.oraclecloud.com/20201101/externalExadataStorageServers/:externalExadataStorageServerId/iormPlan", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "externalExadataStorageServerId", "value": "", "type": "path", "description": "The [OCID](/Content/General/Concepts/identifiers.htm) of the Exadata storage server." } ] }, "docs": "Get the IORM plan from the specific Exadata storage server.\n" }, { "info": { "name": "Get open alerts from the specific Exadata storage server.", "type": "http" }, "http": { "method": "GET", "url": "http://dbmgmt.{region}.oci.oraclecloud.com/20201101/externalExadataStorageServers/:externalExadataStorageServerId/openAlertHistory", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "externalExadataStorageServerId", "value": "", "type": "path", "description": "The [OCID](/Content/General/Concepts/identifiers.htm) of the Exadata storage server." } ] }, "docs": "Gets the open alerts from the specified Exadata storage server.\n" }, { "info": { "name": "Get the SQL IDs with top cpu activity from Exadata storage server.", "type": "http" }, "http": { "method": "GET", "url": "http://dbmgmt.{region}.oci.oraclecloud.com/20201101/externalExadataStorageServers/:externalExadataStorageServerId/topSqlCpuActivity", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "externalExadataStorageServerId", "value": "", "type": "path", "description": "The [OCID](/Content/General/Concepts/identifiers.htm) of the Exadata storage server." } ] }, "docs": "Gets the SQL IDs with the top CPU activity from the Exadata storage server.\n" }, { "info": { "name": "Lists the external listeners.", "type": "http" }, "http": { "method": "GET", "url": "http://dbmgmt.{region}.oci.oraclecloud.com/20201101/externalListeners", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "compartmentId", "value": "", "type": "query", "description": "The [OCID](/Content/General/Concepts/identifiers.htm) of the compartment." }, { "name": "externalDbSystemId", "value": "", "type": "query", "description": "The [OCID](/Content/General/Concepts/identifiers.htm) of the external DB system." }, { "name": "displayName", "value": "", "type": "query", "description": "A filter to only return the resources that match the entire display name." }, { "name": "page", "value": "", "type": "query", "description": "The page token representing the page from where the next set of paginated results\nare retrieved. This is usually retrieved from a previous list call.\n" }, { "name": "limit", "value": "", "type": "query", "description": "The maximum number of records returned in the paginated response." }, { "name": "sortBy", "value": "", "type": "query", "description": "The field to sort information by. Only one sortOrder can be used. The default sort order\nfor `TIMECREATED` is descending and the default sort order for `DISPLAYNAME` is ascending.\nThe `DISPLAYNAME` sort order is case-sensitive.\n" }, { "name": "sortOrder", "value": "", "type": "query", "description": "The option to sort information in ascending (‘ASC’) or descending (‘DESC’) order. Ascending order is the default order." } ] }, "docs": "Lists the listeners in the specified external DB system." }, { "info": { "name": "Gets the external listener details.", "type": "http" }, "http": { "method": "GET", "url": "http://dbmgmt.{region}.oci.oraclecloud.com/20201101/externalListeners/:externalListenerId", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "externalListenerId", "value": "", "type": "path", "description": "The [OCID](/Content/General/Concepts/identifiers.htm) of the external listener." } ] }, "docs": "Gets the details for the external listener specified by `externalListenerId`.\n" }, { "info": { "name": "Updates an external listener.", "type": "http" }, "http": { "method": "PUT", "url": "http://dbmgmt.{region}.oci.oraclecloud.com/20201101/externalListeners/:externalListenerId", "headers": [ { "name": "opc-request-id", "value": "" }, { "name": "if-match", "value": "" } ], "params": [ { "name": "externalListenerId", "value": "", "type": "path", "description": "The [OCID](/Content/General/Concepts/identifiers.htm) of the external listener." } ] }, "docs": "Updates the external listener specified by `externalListenerId`.\n" }, { "info": { "name": "Gets the external listener metrics.", "type": "http" }, "http": { "method": "GET", "url": "http://dbmgmt.{region}.oci.oraclecloud.com/20201101/externalListeners/:externalListenerId/metrics", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "externalListenerId", "value": "", "type": "path", "description": "The [OCID](/Content/General/Concepts/identifiers.htm) of the external listener." }, { "name": "page", "value": "", "type": "query", "description": "The page token representing the page from where the next set of paginated results\nare retrieved. This is usually retrieved from a previous list call.\n" }, { "name": "limit", "value": "", "type": "query", "description": "The maximum number of records returned in the paginated response." }, { "name": "startTime", "value": "", "type": "query", "description": "The beginning of the time range set to retrieve metric data for the DB system\nand its members. Expressed in UTC in ISO-8601 format, which is `yyyy-MM-dd'T'hh:mm:ss.sss'Z'`.\n" }, { "name": "endTime", "value": "", "type": "query", "description": "The end of the time range set to retrieve metric data for the DB system\nand its members. Expressed in UTC in ISO-8601 format, which is `yyyy-MM-dd'T'hh:mm:ss.sss'Z'`.\n" }, { "name": "filterByMetricNames", "value": "", "type": "query", "description": "The filter used to retrieve a specific set of metrics by passing the desired metric names with a comma separator. Note that, by default, the service returns all supported metrics." } ] }, "docs": "Gets metrics for the external listener specified by `externalListenerId`.\n" }, { "info": { "name": "Lists the database services registered with the external listener.", "type": "http" }, "http": { "method": "GET", "url": "http://dbmgmt.{region}.oci.oraclecloud.com/20201101/externalListeners/:externalListenerId/services", "headers": [ { "name": "opc-request-id", "value": "" }, { "name": "opc-named-credential-id", "value": "" } ], "params": [ { "name": "externalListenerId", "value": "", "type": "path", "description": "The [OCID](/Content/General/Concepts/identifiers.htm) of the external listener." }, { "name": "managedDatabaseId", "value": "", "type": "query", "description": "The [OCID](/Content/General/Concepts/identifiers.htm) of the Managed Database." }, { "name": "page", "value": "", "type": "query", "description": "The page token representing the page from where the next set of paginated results\nare retrieved. This is usually retrieved from a previous list call.\n" }, { "name": "limit", "value": "", "type": "query", "description": "The maximum number of records returned in the paginated response." }, { "name": "sortBy", "value": "", "type": "query", "description": "The field to sort information by. Only one sortOrder can be used. The\ndefault sort order for `NAME` is ascending and it is case-sensitive.\n" }, { "name": "sortOrder", "value": "", "type": "query", "description": "The option to sort information in ascending (‘ASC’) or descending (‘DESC’) order. Ascending order is the default order." } ] }, "docs": "Lists the database services registered with the specified external listener\nfor the specified Managed Database.\n" }, { "info": { "name": "Lists External MySql Connectors.\n", "type": "http" }, "http": { "method": "GET", "url": "http://dbmgmt.{region}.oci.oraclecloud.com/20201101/externalMySqlDatabaseConnectors", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "externalDatabaseId", "value": "", "type": "query", "description": "The [OCID](/Content/General/Concepts/identifiers.htm) of the external database." }, { "name": "name", "value": "", "type": "query", "description": "The parameter to filter by MySQL Database System type." }, { "name": "compartmentId", "value": "", "type": "query", "description": "The [OCID](/Content/General/Concepts/identifiers.htm) of the compartment." }, { "name": "page", "value": "", "type": "query", "description": "The page token representing the page from where the next set of paginated results\nare retrieved. This is usually retrieved from a previous list call.\n" }, { "name": "limit", "value": "", "type": "query", "description": "The maximum number of records returned in the paginated response." }, { "name": "sortBy", "value": "", "type": "query", "description": "The field to sort information by. Only one sortOrder can be used. The default sort order\nfor ‘TIMECREATED’ is descending and the default sort order for ‘NAME’ is ascending.\nThe ‘NAME’ sort order is case-sensitive.\n" }, { "name": "sortOrder", "value": "", "type": "query", "description": "The option to sort information in ascending (‘ASC’) or descending (‘DESC’) order. Ascending order is the default order." } ] }, "docs": "Gets the list of External MySQL Database connectors.\nMySQL support within OCI Database Management service has been deprecated as of January 29, 2026.\n" }, { "info": { "name": "Creates an external MySQL Database Connector resource.", "type": "http" }, "http": { "method": "POST", "url": "http://dbmgmt.{region}.oci.oraclecloud.com/20201101/externalMySqlDatabaseConnectors", "headers": [ { "name": "opc-request-id", "value": "" }, { "name": "opc-retry-token", "value": "" } ], "params": [ { "name": "isTestConnectionParam", "value": "", "type": "query", "description": "Parameter indicating whether database connection needs to be tested." } ] }, "docs": "Creates an external MySQL connector resource.\nMySQL support within OCI Database Management service has been deprecated as of January 29, 2026.\n" }, { "info": { "name": "Get External MySQL Connector", "type": "http" }, "http": { "method": "GET", "url": "http://dbmgmt.{region}.oci.oraclecloud.com/20201101/externalMySqlDatabaseConnectors/:externalMySqlDatabaseConnectorId", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "externalMySqlDatabaseConnectorId", "value": "", "type": "path", "description": "The OCID of the External MySQL Database Connector." } ] }, "docs": "Retrieves the MySQL database connector.\nMySQL support within OCI Database Management service has been deprecated as of January 29, 2026.\n" }, { "info": { "name": "Updates External Mysql Database Connector.", "type": "http" }, "http": { "method": "PUT", "url": "http://dbmgmt.{region}.oci.oraclecloud.com/20201101/externalMySqlDatabaseConnectors/:externalMySqlDatabaseConnectorId", "headers": [ { "name": "if-match", "value": "" }, { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "externalMySqlDatabaseConnectorId", "value": "", "type": "path", "description": "The OCID of the External MySQL Database Connector." } ] }, "docs": "Updates the External Mysql Database Connector.\nMySQL support within OCI Database Management service has been deprecated as of January 29, 2026.\n" }, { "info": { "name": "Delete the External MySQL Database Connector resource.", "type": "http" }, "http": { "method": "DELETE", "url": "http://dbmgmt.{region}.oci.oraclecloud.com/20201101/externalMySqlDatabaseConnectors/:externalMySqlDatabaseConnectorId", "headers": [ { "name": "if-match", "value": "" }, { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "externalMySqlDatabaseConnectorId", "value": "", "type": "path", "description": "The OCID of the External MySQL Database Connector." } ] }, "docs": "Deletes the Oracle Cloud Infrastructure resource representing an external MySQL database connector.\nMySQL support within OCI Database Management service has been deprecated as of January 29, 2026.\n" }, { "info": { "name": "Check the status of the external database connection specified in this connector.", "type": "http" }, "http": { "method": "POST", "url": "http://dbmgmt.{region}.oci.oraclecloud.com/20201101/externalMySqlDatabaseConnectors/:externalMySqlDatabaseConnectorId/actions/checkConnectionStatus", "headers": [ { "name": "opc-retry-token", "value": "" }, { "name": "if-match", "value": "" }, { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "externalMySqlDatabaseConnectorId", "value": "", "type": "path", "description": "The OCID of the External MySQL Database Connector." } ] }, "docs": "Check the status of the external database connection specified in this connector.\nThis operation will refresh the connectionStatus and timeConnectionStatusLastUpdated fields.\nMySQL support within OCI Database Management service has been deprecated as of January 29, 2026.\n" }, { "info": { "name": "Lists External MySql databases in a given compartment.\n", "type": "http" }, "http": { "method": "GET", "url": "http://dbmgmt.{region}.oci.oraclecloud.com/20201101/externalMySqlDatabases", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "compartmentId", "value": "", "type": "query", "description": "The [OCID](/Content/General/Concepts/identifiers.htm) of the compartment." }, { "name": "name", "value": "", "type": "query", "description": "The parameter to filter by MySQL Database System type." }, { "name": "page", "value": "", "type": "query", "description": "The page token representing the page from where the next set of paginated results\nare retrieved. This is usually retrieved from a previous list call.\n" }, { "name": "limit", "value": "", "type": "query", "description": "The maximum number of records returned in the paginated response." }, { "name": "sortBy", "value": "", "type": "query", "description": "The field to sort information by. Only one sortOrder can be used. The default sort order\nfor ‘TIMECREATED’ is descending and the default sort order for ‘NAME’ is ascending.\nThe ‘NAME’ sort order is case-sensitive.\n" }, { "name": "sortOrder", "value": "", "type": "query", "description": "The option to sort information in ascending (‘ASC’) or descending (‘DESC’) order. Ascending order is the default order." } ] }, "docs": "Gets the list of External MySQL Databases.\nMySQL support within OCI Database Management service has been deprecated as of January 29, 2026.\n" }, { "info": { "name": "Creates an external MySQL database resource.", "type": "http" }, "http": { "method": "POST", "url": "http://dbmgmt.{region}.oci.oraclecloud.com/20201101/externalMySqlDatabases", "headers": [ { "name": "opc-request-id", "value": "" }, { "name": "opc-retry-token", "value": "" } ] }, "docs": "Creates an external MySQL database.\nMySQL support within OCI Database Management service has been deprecated as of January 29, 2026.\n" }, { "info": { "name": "Get External MySQL database information.", "type": "http" }, "http": { "method": "GET", "url": "http://dbmgmt.{region}.oci.oraclecloud.com/20201101/externalMySqlDatabases/:externalMySqlDatabaseId", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "externalMySqlDatabaseId", "value": "", "type": "path", "description": "The OCID of the External MySQL Database." } ] }, "docs": "Retrieves the external MySQL database information.\nMySQL support within OCI Database Management service has been deprecated as of January 29, 2026.\n" }, { "info": { "name": "Updates External Mysql Database.", "type": "http" }, "http": { "method": "PUT", "url": "http://dbmgmt.{region}.oci.oraclecloud.com/20201101/externalMySqlDatabases/:externalMySqlDatabaseId", "headers": [ { "name": "if-match", "value": "" }, { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "externalMySqlDatabaseId", "value": "", "type": "path", "description": "The OCID of the External MySQL Database." } ] }, "docs": "Updates the External Mysql Database.\nMySQL support within OCI Database Management service has been deprecated as of January 29, 2026.\n" }, { "info": { "name": "Delete the External MySQL Database resource.", "type": "http" }, "http": { "method": "DELETE", "url": "http://dbmgmt.{region}.oci.oraclecloud.com/20201101/externalMySqlDatabases/:externalMySqlDatabaseId", "headers": [ { "name": "if-match", "value": "" }, { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "externalMySqlDatabaseId", "value": "", "type": "path", "description": "The OCID of the External MySQL Database." } ] }, "docs": "Deletes the Oracle Cloud Infrastructure resource representing an external MySQL database.\nMySQL support within OCI Database Management service has been deprecated as of January 29, 2026.\n" }, { "info": { "name": "Disables Database Management for an external MySQL Database.", "type": "http" }, "http": { "method": "POST", "url": "http://dbmgmt.{region}.oci.oraclecloud.com/20201101/externalMySqlDatabases/:externalMySqlDatabaseId/actions/disableDatabaseManagement", "headers": [ { "name": "opc-retry-token", "value": "" }, { "name": "if-match", "value": "" }, { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "externalMySqlDatabaseId", "value": "", "type": "path", "description": "The OCID of the External MySQL Database." } ] }, "docs": "Disables Database Management for an external MySQL Database.\nMySQL support within OCI Database Management service has been deprecated as of January 29, 2026.\n" }, { "info": { "name": "Enables Database Management for an external MySQL Database resource.", "type": "http" }, "http": { "method": "POST", "url": "http://dbmgmt.{region}.oci.oraclecloud.com/20201101/externalMySqlDatabases/:externalMySqlDatabaseId/actions/enableDatabaseManagement", "headers": [ { "name": "opc-retry-token", "value": "" }, { "name": "if-match", "value": "" }, { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "externalMySqlDatabaseId", "value": "", "type": "path", "description": "The OCID of the External MySQL Database." } ] }, "docs": "Enables Database Management for an external MySQL Database.\nMySQL support within OCI Database Management service has been deprecated as of January 29, 2026.\n" }, { "info": { "name": "Disables Database Management feature for an external container Database.", "type": "http" }, "http": { "method": "POST", "url": "http://dbmgmt.{region}.oci.oraclecloud.com/20201101/externalcontainerdatabases/:externalContainerDatabaseId/actions/disableDatabaseManagement", "headers": [ { "name": "opc-request-id", "value": "" }, { "name": "opc-retry-token", "value": "" }, { "name": "if-match", "value": "" } ], "params": [ { "name": "externalContainerDatabaseId", "value": "", "type": "path", "description": "The [OCID](/Content/General/Concepts/identifiers.htm) of the external container database." } ] }, "docs": "Disables a Database Management feature for the specified external container database.\n" }, { "info": { "name": "Enables Database Management feature for the external Database.", "type": "http" }, "http": { "method": "POST", "url": "http://dbmgmt.{region}.oci.oraclecloud.com/20201101/externalcontainerdatabases/:externalContainerDatabaseId/actions/enableDatabaseManagement", "headers": [ { "name": "opc-request-id", "value": "" }, { "name": "opc-retry-token", "value": "" }, { "name": "if-match", "value": "" } ], "params": [ { "name": "externalContainerDatabaseId", "value": "", "type": "path", "description": "The [OCID](/Content/General/Concepts/identifiers.htm) of the external container database." } ] }, "docs": "Enables a Database Management feature for the specified external container database.\n" }, { "info": { "name": "Modifies Database Management feature for the external Database.", "type": "http" }, "http": { "method": "POST", "url": "http://dbmgmt.{region}.oci.oraclecloud.com/20201101/externalcontainerdatabases/:externalContainerDatabaseId/actions/modifyDatabaseManagement", "headers": [ { "name": "opc-request-id", "value": "" }, { "name": "opc-retry-token", "value": "" }, { "name": "if-match", "value": "" } ], "params": [ { "name": "externalContainerDatabaseId", "value": "", "type": "path", "description": "The [OCID](/Content/General/Concepts/identifiers.htm) of the external container database." } ] }, "docs": "Modifies a Database Management feature for the specified external container database.\n" }, { "info": { "name": "Disables Database Management feature for an external non-container Database.", "type": "http" }, "http": { "method": "POST", "url": "http://dbmgmt.{region}.oci.oraclecloud.com/20201101/externalnoncontainerdatabases/:externalNonContainerDatabaseId/actions/disableDatabaseManagement", "headers": [ { "name": "opc-request-id", "value": "" }, { "name": "opc-retry-token", "value": "" }, { "name": "if-match", "value": "" } ], "params": [ { "name": "externalNonContainerDatabaseId", "value": "", "type": "path", "description": "The [OCID](/Content/General/Concepts/identifiers.htm) of the external non-container database." } ] }, "docs": "Disables a Database Management feature for the specified external non-container database.\n" }, { "info": { "name": "Enables a Database Management feature for the external non-container database.", "type": "http" }, "http": { "method": "POST", "url": "http://dbmgmt.{region}.oci.oraclecloud.com/20201101/externalnoncontainerdatabases/:externalNonContainerDatabaseId/actions/enableDatabaseManagement", "headers": [ { "name": "opc-request-id", "value": "" }, { "name": "opc-retry-token", "value": "" }, { "name": "if-match", "value": "" } ], "params": [ { "name": "externalNonContainerDatabaseId", "value": "", "type": "path", "description": "The [OCID](/Content/General/Concepts/identifiers.htm) of the external non-container database." } ] }, "docs": "Enables Database Management feature for the specified external non-container database.\n" }, { "info": { "name": "Disables Database Management feature for an external pluggable Database.", "type": "http" }, "http": { "method": "POST", "url": "http://dbmgmt.{region}.oci.oraclecloud.com/20201101/externalpluggabledatabases/:externalPluggableDatabaseId/actions/disableDatabaseManagement", "headers": [ { "name": "opc-request-id", "value": "" }, { "name": "opc-retry-token", "value": "" }, { "name": "if-match", "value": "" } ], "params": [ { "name": "externalPluggableDatabaseId", "value": "", "type": "path", "description": "The [OCID](/Content/General/Concepts/identifiers.htm) of the external pluggable database." } ] }, "docs": "Disables a Database Management feature for the specified external pluggable database.\n" }, { "info": { "name": "Enables Database Management feature for the external pluggable Database.", "type": "http" }, "http": { "method": "POST", "url": "http://dbmgmt.{region}.oci.oraclecloud.com/20201101/externalpluggabledatabases/:externalPluggableDatabaseId/actions/enableDatabaseManagement", "headers": [ { "name": "opc-request-id", "value": "" }, { "name": "opc-retry-token", "value": "" }, { "name": "if-match", "value": "" } ], "params": [ { "name": "externalPluggableDatabaseId", "value": "", "type": "path", "description": "The [OCID](/Content/General/Concepts/identifiers.htm) of the external pluggable database." } ] }, "docs": "Enables a Database Management feature for the specified external pluggable database.\n" }, { "info": { "name": "Gets the health metrics for a fleet of databases.", "type": "http" }, "http": { "method": "GET", "url": "http://dbmgmt.{region}.oci.oraclecloud.com/20201101/fleetMetrics", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "managedDatabaseGroupId", "value": "", "type": "query", "description": "The [OCID](/Content/General/Concepts/identifiers.htm) of the Managed Database Group." }, { "name": "compartmentId", "value": "", "type": "query", "description": "The [OCID](/Content/General/Concepts/identifiers.htm) of the compartment." }, { "name": "compareBaselineTime", "value": "", "type": "query", "description": "The baseline time for metrics comparison." }, { "name": "compareTargetTime", "value": "", "type": "query", "description": "The target time for metrics comparison." }, { "name": "compareType", "value": "", "type": "query", "description": "The time window used for metrics comparison." }, { "name": "filterByMetricNames", "value": "", "type": "query", "description": "The filter used to retrieve a specific set of metrics by passing the desired metric names with a comma separator. Note that, by default, the service returns all supported metrics." }, { "name": "filterByDatabaseType", "value": "", "type": "query", "description": "The filter used to filter the databases in the fleet by a specific Oracle Database type." }, { "name": "filterByDatabaseSubType", "value": "", "type": "query", "description": "The filter used to filter the databases in the fleet by a specific Oracle Database subtype." }, { "name": "page", "value": "", "type": "query", "description": "The page token representing the page from where the next set of paginated results\nare retrieved. This is usually retrieved from a previous list call.\n" }, { "name": "limit", "value": "", "type": "query", "description": "The maximum number of records returned in the paginated response." }, { "name": "sortBy", "value": "", "type": "query", "description": "The field to sort information by. Only one sortOrder can be used. The default sort order\nfor ‘TIMECREATED’ is descending and the default sort order for ‘NAME’ is ascending.\nThe ‘NAME’ sort order is case-sensitive.\n" }, { "name": "sortOrder", "value": "", "type": "query", "description": "The option to sort information in ascending (‘ASC’) or descending (‘DESC’) order. Ascending order is the default order." }, { "name": "filterByDatabaseDeploymentType", "value": "", "type": "query", "description": "The filter used to filter the databases in the fleet by a specific Oracle Database deployment type." }, { "name": "filterByDatabaseVersion", "value": "", "type": "query", "description": "The filter used to filter the databases in the fleet by a specific Oracle Database version." }, { "name": "definedTagEquals", "value": "", "type": "query", "description": "A list of tag filters to apply. Only resources with a defined tag matching the value will be returned.\nEach item in the list has the format \"{namespace}.{tagName}.{value}\". All inputs are case-insensitive.\nMultiple values for the same key (i.e. same namespace and tag name) are interpreted as \"OR\".\nValues for different keys (i.e. different namespaces, different tag names, or both) are interpreted as \"AND\".\n" }, { "name": "freeformTagEquals", "value": "", "type": "query", "description": "A list of tag filters to apply. Only resources with a freeform tag matching the value will be returned.\nThe key for each tag is \"{tagName}.{value}\". All inputs are case-insensitive.\nMultiple values for the same tag name are interpreted as \"OR\". Values for different tag names are interpreted as \"AND\".\n" }, { "name": "definedTagExists", "value": "", "type": "query", "description": "A list of tag existence filters to apply. Only resources for which the specified defined tags exist will be returned.\nEach item in the list has the format \"{namespace}.{tagName}.true\" (for checking existence of a defined tag)\nor \"{namespace}.true\". All inputs are case-insensitive.\nCurrently, only existence (\"true\" at the end) is supported. Absence (\"false\" at the end) is not supported.\nMultiple values for the same key (i.e. same namespace and tag name) are interpreted as \"OR\".\nValues for different keys (i.e. different namespaces, different tag names, or both) are interpreted as \"AND\".\n" }, { "name": "freeformTagExists", "value": "", "type": "query", "description": "A list of tag existence filters to apply. Only resources for which the specified freeform tags exist the value will be returned.\nThe key for each tag is \"{tagName}.true\". All inputs are case-insensitive.\nCurrently, only existence (\"true\" at the end) is supported. Absence (\"false\" at the end) is not supported.\nMultiple values for different tag names are interpreted as \"AND\".\n" } ] }, "docs": "Gets the health metrics for a fleet of databases in a compartment or in a Managed Database Group.\nEither the CompartmentId or the ManagedDatabaseGroupId query parameters must be provided to retrieve the health metrics.\n" }, { "info": { "name": "Lists job executions.", "type": "http" }, "http": { "method": "GET", "url": "http://dbmgmt.{region}.oci.oraclecloud.com/20201101/jobExecutions", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "compartmentId", "value": "", "type": "query", "description": "The [OCID](/Content/General/Concepts/identifiers.htm) of the compartment." }, { "name": "id", "value": "", "type": "query", "description": "The identifier of the resource." }, { "name": "jobId", "value": "", "type": "query", "description": "The identifier of the job." }, { "name": "managedDatabaseId", "value": "", "type": "query", "description": "The [OCID](/Content/General/Concepts/identifiers.htm) of the Managed Database." }, { "name": "managedDatabaseGroupId", "value": "", "type": "query", "description": "The [OCID](/Content/General/Concepts/identifiers.htm) of the Managed Database Group." }, { "name": "status", "value": "", "type": "query", "description": "The status of the job execution." }, { "name": "name", "value": "", "type": "query", "description": "A filter to return only resources that match the entire name." }, { "name": "limit", "value": "", "type": "query", "description": "The maximum number of records returned in the paginated response." }, { "name": "page", "value": "", "type": "query", "description": "The page token representing the page from where the next set of paginated results\nare retrieved. This is usually retrieved from a previous list call.\n" }, { "name": "sortBy", "value": "", "type": "query", "description": "The field to sort information by. Only one sortOrder can be used. The default sort order\nfor ‘TIMECREATED’ is descending and the default sort order for ‘NAME’ is ascending.\nThe ‘NAME’ sort order is case-sensitive.\n" }, { "name": "sortOrder", "value": "", "type": "query", "description": "The option to sort information in ascending (‘ASC’) or descending (‘DESC’) order. Ascending order is the default order." }, { "name": "jobRunId", "value": "", "type": "query", "description": "The identifier of the job run." } ] }, "docs": "Gets the job execution for a specific ID or the list of job executions for a job, job run, Managed Database or Managed Database Group\nin a specific compartment. Only one of the parameters, ID, jobId, jobRunId, managedDatabaseId or managedDatabaseGroupId should be provided.\nIf none of these parameters is provided, all the job executions in the compartment are listed. Job executions can also be filtered\nbased on the name and status parameters.\n" }, { "info": { "name": "Gets job execution details.", "type": "http" }, "http": { "method": "GET", "url": "http://dbmgmt.{region}.oci.oraclecloud.com/20201101/jobExecutions/:jobExecutionId", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "jobExecutionId", "value": "", "type": "path", "description": "The identifier of the job execution." } ] }, "docs": "Gets the details of the job execution specified by jobExecutionId.\n" }, { "info": { "name": "Gets a summary of the status of job executions.", "type": "http" }, "http": { "method": "GET", "url": "http://dbmgmt.{region}.oci.oraclecloud.com/20201101/jobExecutionsStatus", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "compartmentId", "value": "", "type": "query", "description": "The [OCID](/Content/General/Concepts/identifiers.htm) of the compartment." }, { "name": "id", "value": "", "type": "query", "description": "The identifier of the resource." }, { "name": "managedDatabaseGroupId", "value": "", "type": "query", "description": "The [OCID](/Content/General/Concepts/identifiers.htm) of the Managed Database Group." }, { "name": "managedDatabaseId", "value": "", "type": "query", "description": "The [OCID](/Content/General/Concepts/identifiers.htm) of the Managed Database." }, { "name": "startTime", "value": "", "type": "query", "description": "The start time of the time range to retrieve the status summary of job executions\nin UTC in ISO-8601 format, which is \"yyyy-MM-dd'T'hh:mm:ss.sss'Z'\".\n" }, { "name": "endTime", "value": "", "type": "query", "description": "The end time of the time range to retrieve the status summary of job executions\nin UTC in ISO-8601 format, which is \"yyyy-MM-dd'T'hh:mm:ss.sss'Z'\".\n" }, { "name": "name", "value": "", "type": "query", "description": "A filter to return only resources that match the entire name." }, { "name": "sortBy", "value": "", "type": "query", "description": "The field to sort information by. Only one sortOrder can be used. The default sort order\nfor ‘TIMECREATED’ is descending and the default sort order for ‘NAME’ is ascending.\nThe ‘NAME’ sort order is case-sensitive.\n" }, { "name": "sortOrder", "value": "", "type": "query", "description": "The option to sort information in ascending (‘ASC’) or descending (‘DESC’) order. Ascending order is the default order." } ] }, "docs": "Gets the number of job executions grouped by status for a job, Managed Database, or Database Group in a specific compartment. Only one of the parameters, jobId, managedDatabaseId, or managedDatabaseGroupId should be provided." }, { "info": { "name": "Lists job runs.", "type": "http" }, "http": { "method": "GET", "url": "http://dbmgmt.{region}.oci.oraclecloud.com/20201101/jobRuns", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "compartmentId", "value": "", "type": "query", "description": "The [OCID](/Content/General/Concepts/identifiers.htm) of the compartment." }, { "name": "id", "value": "", "type": "query", "description": "The identifier of the resource." }, { "name": "jobId", "value": "", "type": "query", "description": "The identifier of the job." }, { "name": "managedDatabaseId", "value": "", "type": "query", "description": "The [OCID](/Content/General/Concepts/identifiers.htm) of the Managed Database." }, { "name": "managedDatabaseGroupId", "value": "", "type": "query", "description": "The [OCID](/Content/General/Concepts/identifiers.htm) of the Managed Database Group." }, { "name": "runStatus", "value": "", "type": "query", "description": "The status of the job run." }, { "name": "name", "value": "", "type": "query", "description": "A filter to return only resources that match the entire name." }, { "name": "limit", "value": "", "type": "query", "description": "The maximum number of records returned in the paginated response." }, { "name": "page", "value": "", "type": "query", "description": "The page token representing the page from where the next set of paginated results\nare retrieved. This is usually retrieved from a previous list call.\n" }, { "name": "sortBy", "value": "", "type": "query", "description": "The field to sort information by. Only one sortOrder can be used. The default sort order\nfor ‘TIMECREATED’ is descending and the default sort order for ‘NAME’ is ascending.\nThe ‘NAME’ sort order is case-sensitive.\n" }, { "name": "sortOrder", "value": "", "type": "query", "description": "The option to sort information in ascending (‘ASC’) or descending (‘DESC’) order. Ascending order is the default order." } ] }, "docs": "Gets the job run for a specific ID or the list of job runs for a job, Managed Database or Managed Database Group\nin a specific compartment. Only one of the parameters, ID, jobId, managedDatabaseId, or managedDatabaseGroupId\nshould be provided. If none of these parameters is provided, all the job runs in the compartment are listed.\nJob runs can also be filtered based on name and runStatus parameters.\n" }, { "info": { "name": "Gets job run details.", "type": "http" }, "http": { "method": "GET", "url": "http://dbmgmt.{region}.oci.oraclecloud.com/20201101/jobRuns/:jobRunId", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "jobRunId", "value": "", "type": "path", "description": "The identifier of the job run." } ] }, "docs": "Gets the details of the job run specified by jobRunId.\n" }, { "info": { "name": "Lists jobs.", "type": "http" }, "http": { "method": "GET", "url": "http://dbmgmt.{region}.oci.oraclecloud.com/20201101/jobs", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "compartmentId", "value": "", "type": "query", "description": "The [OCID](/Content/General/Concepts/identifiers.htm) of the compartment." }, { "name": "id", "value": "", "type": "query", "description": "The identifier of the resource." }, { "name": "managedDatabaseGroupId", "value": "", "type": "query", "description": "The [OCID](/Content/General/Concepts/identifiers.htm) of the Managed Database Group." }, { "name": "managedDatabaseId", "value": "", "type": "query", "description": "The [OCID](/Content/General/Concepts/identifiers.htm) of the Managed Database." }, { "name": "name", "value": "", "type": "query", "description": "A filter to return only resources that match the entire name." }, { "name": "lifecycleState", "value": "", "type": "query", "description": "The lifecycle state of the job." }, { "name": "limit", "value": "", "type": "query", "description": "The maximum number of records returned in the paginated response." }, { "name": "page", "value": "", "type": "query", "description": "The page token representing the page from where the next set of paginated results\nare retrieved. This is usually retrieved from a previous list call.\n" }, { "name": "sortBy", "value": "", "type": "query", "description": "The field to sort information by. Only one sortOrder can be used. The default sort order\nfor ‘TIMECREATED’ is descending and the default sort order for ‘NAME’ is ascending.\nThe ‘NAME’ sort order is case-sensitive.\n" }, { "name": "sortOrder", "value": "", "type": "query", "description": "The option to sort information in ascending (‘ASC’) or descending (‘DESC’) order. Ascending order is the default order." } ] }, "docs": "Gets the job for a specific ID or the list of jobs for a Managed Database or Managed Database Group\nin a specific compartment. Only one of the parameters, ID, managedDatabaseId or managedDatabaseGroupId,\nshould be provided. If none of these parameters is provided, all the jobs in the compartment are listed.\nJobs can also be filtered based on the name and lifecycleState parameters.\n" }, { "info": { "name": "Creates a job.", "type": "http" }, "http": { "method": "POST", "url": "http://dbmgmt.{region}.oci.oraclecloud.com/20201101/jobs", "headers": [ { "name": "opc-request-id", "value": "" }, { "name": "opc-retry-token", "value": "" } ] }, "docs": "Creates a job to be executed on a Managed Database or Managed Database Group. Only one\nof the parameters, managedDatabaseId or managedDatabaseGroupId should be provided as\ninput in CreateJobDetails resource in request body.\n" }, { "info": { "name": "Gets job details.", "type": "http" }, "http": { "method": "GET", "url": "http://dbmgmt.{region}.oci.oraclecloud.com/20201101/jobs/:jobId", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "jobId", "value": "", "type": "path", "description": "The identifier of the job." } ] }, "docs": "Gets the details of the job specified by jobId.\n" }, { "info": { "name": "Updates job details.", "type": "http" }, "http": { "method": "PUT", "url": "http://dbmgmt.{region}.oci.oraclecloud.com/20201101/jobs/:jobId", "headers": [ { "name": "opc-request-id", "value": "" }, { "name": "if-match", "value": "" } ], "params": [ { "name": "jobId", "value": "", "type": "path", "description": "The identifier of the job." } ] }, "docs": "Updates the details of the recurring scheduled job specified by jobId. Note that non-recurring (one time) jobs cannot be updated.\n" }, { "info": { "name": "Deletes a job.", "type": "http" }, "http": { "method": "DELETE", "url": "http://dbmgmt.{region}.oci.oraclecloud.com/20201101/jobs/:jobId", "headers": [ { "name": "if-match", "value": "" }, { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "jobId", "value": "", "type": "path", "description": "The identifier of the job." } ] }, "docs": "Deletes the job specified by jobId." }, { "info": { "name": "Moves a job to a different compartment.", "type": "http" }, "http": { "method": "POST", "url": "http://dbmgmt.{region}.oci.oraclecloud.com/20201101/jobs/:jobId/actions/changeCompartment", "headers": [ { "name": "opc-request-id", "value": "" }, { "name": "opc-retry-token", "value": "" }, { "name": "if-match", "value": "" } ], "params": [ { "name": "jobId", "value": "", "type": "path", "description": "The identifier of the job." } ] }, "docs": "Moves a job.\n" }, { "info": { "name": "Lists Managed Database Groups.\n", "type": "http" }, "http": { "method": "GET", "url": "http://dbmgmt.{region}.oci.oraclecloud.com/20201101/managedDatabaseGroups", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "compartmentId", "value": "", "type": "query", "description": "The [OCID](/Content/General/Concepts/identifiers.htm) of the compartment." }, { "name": "id", "value": "", "type": "query", "description": "The identifier of the resource." }, { "name": "name", "value": "", "type": "query", "description": "A filter to return only resources that match the entire name." }, { "name": "lifecycleState", "value": "", "type": "query", "description": "The lifecycle state of a resource." }, { "name": "page", "value": "", "type": "query", "description": "The page token representing the page from where the next set of paginated results\nare retrieved. This is usually retrieved from a previous list call.\n" }, { "name": "limit", "value": "", "type": "query", "description": "The maximum number of records returned in the paginated response." }, { "name": "sortBy", "value": "", "type": "query", "description": "The field to sort information by. Only one sortOrder can be used. The default sort order\nfor ‘TIMECREATED’ is descending and the default sort order for ‘NAME’ is ascending.\nThe ‘NAME’ sort order is case-sensitive.\n" }, { "name": "sortOrder", "value": "", "type": "query", "description": "The option to sort information in ascending (‘ASC’) or descending (‘DESC’) order. Ascending order is the default order." } ] }, "docs": "Gets the Managed Database Group for a specific ID or the list of Managed Database Groups in\na specific compartment. Managed Database Groups can also be filtered based on the name parameter.\nOnly one of the parameters, ID or name should be provided. If none of these parameters is provided,\nall the Managed Database Groups in the compartment are listed.\n" }, { "info": { "name": "Creates a Managed Database Group.", "type": "http" }, "http": { "method": "POST", "url": "http://dbmgmt.{region}.oci.oraclecloud.com/20201101/managedDatabaseGroups", "headers": [ { "name": "opc-request-id", "value": "" }, { "name": "opc-retry-token", "value": "" } ] }, "docs": "Creates a Managed Database Group. The group does not contain any\nManaged Databases when it is created, and they must be added later.\n" }, { "info": { "name": "Gets Managed Database Group details.", "type": "http" }, "http": { "method": "GET", "url": "http://dbmgmt.{region}.oci.oraclecloud.com/20201101/managedDatabaseGroups/:managedDatabaseGroupId", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "managedDatabaseGroupId", "value": "", "type": "path", "description": "The [OCID](/Content/General/Concepts/identifiers.htm) of the Managed Database Group." } ] }, "docs": "Gets the details of the Managed Database Group specified by managedDatabaseGroupId.\n" }, { "info": { "name": "Updates a Managed Database Group.", "type": "http" }, "http": { "method": "PUT", "url": "http://dbmgmt.{region}.oci.oraclecloud.com/20201101/managedDatabaseGroups/:managedDatabaseGroupId", "headers": [ { "name": "if-match", "value": "" }, { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "managedDatabaseGroupId", "value": "", "type": "path", "description": "The [OCID](/Content/General/Concepts/identifiers.htm) of the Managed Database Group." } ] }, "docs": "Updates the Managed Database Group specified by managedDatabaseGroupId.\n" }, { "info": { "name": "Deletes a Managed Database Group.", "type": "http" }, "http": { "method": "DELETE", "url": "http://dbmgmt.{region}.oci.oraclecloud.com/20201101/managedDatabaseGroups/:managedDatabaseGroupId", "headers": [ { "name": "if-match", "value": "" }, { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "managedDatabaseGroupId", "value": "", "type": "path", "description": "The [OCID](/Content/General/Concepts/identifiers.htm) of the Managed Database Group." } ] }, "docs": "Deletes the Managed Database Group specified by managedDatabaseGroupId.\nIf the group contains Managed Databases, then it cannot be deleted.\n" }, { "info": { "name": "Adds a Managed Database to a Managed Database Group.", "type": "http" }, "http": { "method": "POST", "url": "http://dbmgmt.{region}.oci.oraclecloud.com/20201101/managedDatabaseGroups/:managedDatabaseGroupId/actions/addManagedDatabase", "headers": [ { "name": "opc-request-id", "value": "" }, { "name": "opc-retry-token", "value": "" } ], "params": [ { "name": "managedDatabaseGroupId", "value": "", "type": "path", "description": "The [OCID](/Content/General/Concepts/identifiers.htm) of the Managed Database Group." } ] }, "docs": "Adds a Managed Database to a specific Managed Database Group.\nAfter the database is added, it will be included in the\nmanagement activities performed on the Managed Database Group.\n" }, { "info": { "name": "Moves a Managed Database Group.", "type": "http" }, "http": { "method": "POST", "url": "http://dbmgmt.{region}.oci.oraclecloud.com/20201101/managedDatabaseGroups/:managedDatabaseGroupId/actions/changeCompartment", "headers": [ { "name": "opc-request-id", "value": "" }, { "name": "opc-retry-token", "value": "" }, { "name": "if-match", "value": "" } ], "params": [ { "name": "managedDatabaseGroupId", "value": "", "type": "path", "description": "The [OCID](/Content/General/Concepts/identifiers.htm) of the Managed Database Group." } ] }, "docs": "Moves a Managed Database Group to a different compartment.\nThe destination compartment must not have a Managed Database Group\nwith the same name.\n" }, { "info": { "name": "Removes a Managed Database from a Managed Database Group.", "type": "http" }, "http": { "method": "POST", "url": "http://dbmgmt.{region}.oci.oraclecloud.com/20201101/managedDatabaseGroups/:managedDatabaseGroupId/actions/removeManagedDatabase", "headers": [ { "name": "opc-request-id", "value": "" }, { "name": "opc-retry-token", "value": "" } ], "params": [ { "name": "managedDatabaseGroupId", "value": "", "type": "path", "description": "The [OCID](/Content/General/Concepts/identifiers.htm) of the Managed Database Group." } ] }, "docs": "Removes a Managed Database from a Managed Database Group. Any management\nactivities that are currently running on this database will continue to\nrun to completion. However, any activities scheduled to run in the future\nwill not be performed on this database.\n" }, { "info": { "name": "Lists Managed Databases.\n", "type": "http" }, "http": { "method": "GET", "url": "http://dbmgmt.{region}.oci.oraclecloud.com/20201101/managedDatabases", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "compartmentId", "value": "", "type": "query", "description": "The [OCID](/Content/General/Concepts/identifiers.htm) of the compartment." }, { "name": "id", "value": "", "type": "query", "description": "The identifier of the resource." }, { "name": "name", "value": "", "type": "query", "description": "A filter to return only resources that match the entire name." }, { "name": "managementOption", "value": "", "type": "query", "description": "A filter to return Managed Databases with the specified management option." }, { "name": "deploymentType", "value": "", "type": "query", "description": "A filter to return Managed Databases of the specified deployment type." }, { "name": "externalExadataInfrastructureId", "value": "", "type": "query", "description": "The [OCID](/Content/General/Concepts/identifiers.htm) of the Exadata infrastructure." }, { "name": "page", "value": "", "type": "query", "description": "The page token representing the page from where the next set of paginated results\nare retrieved. This is usually retrieved from a previous list call.\n" }, { "name": "limit", "value": "", "type": "query", "description": "The maximum number of records returned in the paginated response." }, { "name": "sortBy", "value": "", "type": "query", "description": "The field to sort information by. Only one sortOrder can be used. The default sort order\nfor ‘TIMECREATED’ is descending and the default sort order for ‘NAME’ is ascending.\nThe ‘NAME’ sort order is case-sensitive.\n" }, { "name": "sortOrder", "value": "", "type": "query", "description": "The option to sort information in ascending (‘ASC’) or descending (‘DESC’) order. Ascending order is the default order." } ] }, "docs": "Gets the Managed Database for a specific ID or the list of Managed Databases in a specific compartment.\nManaged Databases can be filtered based on the name parameter. Only one of the parameters, ID or name\nshould be provided. If neither of these parameters is provided, all the Managed Databases in the compartment\nare listed. Managed Databases can also be filtered based on the deployment type and management option.\nIf the deployment type is not specified or if it is `ONPREMISE`, then the manageme" }, { "info": { "name": "Gets Managed Database details.", "type": "http" }, "http": { "method": "GET", "url": "http://dbmgmt.{region}.oci.oraclecloud.com/20201101/managedDatabases/:managedDatabaseId", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "managedDatabaseId", "value": "", "type": "path", "description": "The [OCID](/Content/General/Concepts/identifiers.htm) of the Managed Database." } ] }, "docs": "Gets the details of the Managed Database specified by managedDatabaseId.\n" }, { "info": { "name": "Updates Managed Database details.", "type": "http" }, "http": { "method": "PUT", "url": "http://dbmgmt.{region}.oci.oraclecloud.com/20201101/managedDatabases/:managedDatabaseId", "headers": [ { "name": "opc-request-id", "value": "" }, { "name": "if-match", "value": "" } ], "params": [ { "name": "managedDatabaseId", "value": "", "type": "path", "description": "The [OCID](/Content/General/Concepts/identifiers.htm) of the Managed Database." } ] }, "docs": "Updates the Managed Database specified by managedDatabaseId.\n" }, { "info": { "name": "Changes database parameter values.", "type": "http" }, "http": { "method": "POST", "url": "http://dbmgmt.{region}.oci.oraclecloud.com/20201101/managedDatabases/:managedDatabaseId/actions/changeDatabaseParameters", "headers": [ { "name": "opc-request-id", "value": "" }, { "name": "opc-retry-token", "value": "" } ], "params": [ { "name": "managedDatabaseId", "value": "", "type": "path", "description": "The [OCID](/Content/General/Concepts/identifiers.htm) of the Managed Database." } ] }, "docs": "Changes database parameter values. There are two kinds of database\nparameters:\n\n- Dynamic parameters: They can be changed for the current Oracle\nDatabase instance. The changes take effect immediately.\n- Static parameters: They cannot be changed for the current instance.\nYou must change these parameters and then restart the database before\nchanges take effect.\n\n**Note:** If the instance is started using a text initialization\nparameter file, the parameter changes are applicable only for the\ncurren" }, { "info": { "name": "Creates an AWR snapshot for the target database.", "type": "http" }, "http": { "method": "POST", "url": "http://dbmgmt.{region}.oci.oraclecloud.com/20201101/managedDatabases/:managedDatabaseId/actions/generateAwrSnapshot", "headers": [ { "name": "opc-retry-token", "value": "" }, { "name": "opc-request-id", "value": "" }, { "name": "opc-named-credential-id", "value": "" } ], "params": [ { "name": "managedDatabaseId", "value": "", "type": "path", "description": "The [OCID](/Content/General/Concepts/identifiers.htm) of the Managed Database." } ] }, "docs": "Creates an AWR snapshot for the target database.\n" }, { "info": { "name": "Resets database parameter values.", "type": "http" }, "http": { "method": "POST", "url": "http://dbmgmt.{region}.oci.oraclecloud.com/20201101/managedDatabases/:managedDatabaseId/actions/resetDatabaseParameters", "headers": [ { "name": "opc-request-id", "value": "" }, { "name": "opc-retry-token", "value": "" } ], "params": [ { "name": "managedDatabaseId", "value": "", "type": "path", "description": "The [OCID](/Content/General/Concepts/identifiers.htm) of the Managed Database." } ] }, "docs": "Resets database parameter values to their default or startup values.\n" }, { "info": { "name": "Creates and executes a historic ADDM task using the specified AWR snapshot IDs.", "type": "http" }, "http": { "method": "POST", "url": "http://dbmgmt.{region}.oci.oraclecloud.com/20201101/managedDatabases/:managedDatabaseId/actions/runHistoricAddm", "headers": [ { "name": "opc-retry-token", "value": "" }, { "name": "opc-request-id", "value": "" }, { "name": "opc-named-credential-id", "value": "" } ], "params": [ { "name": "managedDatabaseId", "value": "", "type": "path", "description": "The [OCID](/Content/General/Concepts/identifiers.htm) of the Managed Database." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Creates and executes a historic ADDM task using the specified AWR snapshot IDs. If an existing ADDM task\nuses the provided awr snapshot IDs, the existing task will be returned.\n" }, { "info": { "name": "Lists the ADDM tasks who's end snapshot time falls within the provided time range.", "type": "http" }, "http": { "method": "GET", "url": "http://dbmgmt.{region}.oci.oraclecloud.com/20201101/managedDatabases/:managedDatabaseId/addmTasks", "headers": [ { "name": "opc-request-id", "value": "" }, { "name": "opc-named-credential-id", "value": "" } ], "params": [ { "name": "managedDatabaseId", "value": "", "type": "path", "description": "The [OCID](/Content/General/Concepts/identifiers.htm) of the Managed Database." }, { "name": "timeStart", "value": "", "type": "query", "description": "The beginning of the time range to search for ADDM tasks as defined by date-time RFC3339 format." }, { "name": "timeEnd", "value": "", "type": "query", "description": "The end of the time range to search for ADDM tasks as defined by date-time RFC3339 format." }, { "name": "page", "value": "", "type": "query", "description": "The page token representing the page from where the next set of paginated results\nare retrieved. This is usually retrieved from a previous list call.\n" }, { "name": "limit", "value": "", "type": "query", "description": "The maximum number of records returned in the paginated response." }, { "name": "sortBy", "value": "", "type": "query", "description": "The option to sort the list of ADDM tasks." }, { "name": "sortOrder", "value": "", "type": "query", "description": "The option to sort information in ascending (‘ASC’) or descending (‘DESC’) order. Descending order is the default order." } ] }, "docs": "Lists the metadata for each ADDM task who's end snapshot time falls within the provided start and end time. Details include\nthe name of the ADDM task, description, user, status and creation date time.\n" }, { "info": { "name": "Gets a list of ASM properties for a Managed Database.", "type": "http" }, "http": { "method": "GET", "url": "http://dbmgmt.{region}.oci.oraclecloud.com/20201101/managedDatabases/:managedDatabaseId/asmProperties", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "managedDatabaseId", "value": "", "type": "path", "description": "The [OCID](/Content/General/Concepts/identifiers.htm) of the Managed Database." }, { "name": "name", "value": "", "type": "query", "description": "A filter to return only resources that match the entire name." }, { "name": "sortBy", "value": "", "type": "query", "description": "The field to sort information by. Only one sortOrder can be used. The default sort order\nfor ‘TIMECREATED’ is descending and the default sort order for ‘NAME’ is ascending.\nThe ‘NAME’ sort order is case-sensitive.\n" }, { "name": "sortOrder", "value": "", "type": "query", "description": "The option to sort information in ascending (‘ASC’) or descending (‘DESC’) order. Ascending order is the default order." }, { "name": "page", "value": "", "type": "query", "description": "The page token representing the page from where the next set of paginated results\nare retrieved. This is usually retrieved from a previous list call.\n" }, { "name": "limit", "value": "", "type": "query", "description": "The maximum number of records returned in the paginated response." } ] }, "docs": "Gets the list of ASM properties for the specified managedDatabaseId." }, { "info": { "name": "Gets availability metrics of given managed database.\n", "type": "http" }, "http": { "method": "GET", "url": "http://dbmgmt.{region}.oci.oraclecloud.com/20201101/managedDatabases/:managedDatabaseId/availabilityMetrics", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "managedDatabaseId", "value": "", "type": "path", "description": "The [OCID](/Content/General/Concepts/identifiers.htm) of the Managed Database." }, { "name": "page", "value": "", "type": "query", "description": "The page token representing the page from where the next set of paginated results\nare retrieved. This is usually retrieved from a previous list call.\n" }, { "name": "limit", "value": "", "type": "query", "description": "The maximum number of records returned in the paginated response." }, { "name": "startTime", "value": "", "type": "query", "description": "The start time of the time range to retrieve the health metrics of a Managed Database\nin UTC in ISO-8601 format, which is \"yyyy-MM-dd'T'hh:mm:ss.sss'Z'\".\n" }, { "name": "endTime", "value": "", "type": "query", "description": "The end time of the time range to retrieve the health metrics of a Managed Database\nin UTC in ISO-8601 format, which is \"yyyy-MM-dd'T'hh:mm:ss.sss'Z'\".\n" } ] }, "docs": "Gets the availability metrics related to managed database for the Oracle\ndatabase specified by managedDatabaseId.\n" }, { "info": { "name": "Summarizes AWR snapshot ranges.", "type": "http" }, "http": { "method": "GET", "url": "http://dbmgmt.{region}.oci.oraclecloud.com/20201101/managedDatabases/:managedDatabaseId/awrDbSnapshotRanges", "headers": [ { "name": "opc-request-id", "value": "" }, { "name": "opc-retry-token", "value": "" }, { "name": "opc-named-credential-id", "value": "" } ], "params": [ { "name": "managedDatabaseId", "value": "", "type": "path", "description": "The [OCID](/Content/General/Concepts/identifiers.htm) of the Managed Database." }, { "name": "name", "value": "", "type": "query", "description": "The optional single value query parameter to filter the entity name." }, { "name": "timeGreaterThanOrEqualTo", "value": "", "type": "query", "description": "The optional greater than or equal to query parameter to filter the timestamp." }, { "name": "timeLessThanOrEqualTo", "value": "", "type": "query", "description": "The optional less than or equal to query parameter to filter the timestamp." }, { "name": "page", "value": "", "type": "query", "description": "The page token representing the page from where the next set of paginated results\nare retrieved. This is usually retrieved from a previous list call.\n" }, { "name": "limit", "value": "", "type": "query", "description": "The maximum number of records returned in the paginated response." }, { "name": "sortBy", "value": "", "type": "query", "description": "The option to sort the AWR summary data." }, { "name": "sortOrder", "value": "", "type": "query", "description": "The option to sort information in ascending (‘ASC’) or descending (‘DESC’) order. Descending order is the default order." } ] }, "docs": "Summarizes the AWR snapshot ranges that contain continuous snapshots, for the specified Managed Database.\n" }, { "info": { "name": "Gets a list of AWR database information.", "type": "http" }, "http": { "method": "GET", "url": "http://dbmgmt.{region}.oci.oraclecloud.com/20201101/managedDatabases/:managedDatabaseId/awrDbs", "headers": [ { "name": "opc-request-id", "value": "" }, { "name": "opc-retry-token", "value": "" }, { "name": "opc-named-credential-id", "value": "" } ], "params": [ { "name": "managedDatabaseId", "value": "", "type": "path", "description": "The [OCID](/Content/General/Concepts/identifiers.htm) of the Managed Database." }, { "name": "name", "value": "", "type": "query", "description": "The optional single value query parameter to filter the entity name." }, { "name": "timeGreaterThanOrEqualTo", "value": "", "type": "query", "description": "The optional greater than or equal to query parameter to filter the timestamp." }, { "name": "timeLessThanOrEqualTo", "value": "", "type": "query", "description": "The optional less than or equal to query parameter to filter the timestamp." }, { "name": "page", "value": "", "type": "query", "description": "The page token representing the page from where the next set of paginated results\nare retrieved. This is usually retrieved from a previous list call.\n" }, { "name": "limit", "value": "", "type": "query", "description": "The maximum number of records returned in the paginated response." }, { "name": "sortBy", "value": "", "type": "query", "description": "The option to sort the AWR summary data." }, { "name": "sortOrder", "value": "", "type": "query", "description": "The option to sort information in ascending (‘ASC’) or descending (‘DESC’) order. Descending order is the default order." } ] }, "docs": "Gets the list of databases and their snapshot summary details available in the AWR of the specified Managed Database.\n" }, { "info": { "name": "Summarizes AWR CPU usage data.", "type": "http" }, "http": { "method": "GET", "url": "http://dbmgmt.{region}.oci.oraclecloud.com/20201101/managedDatabases/:managedDatabaseId/awrDbs/:awrDbId/awrDbCpuUsages", "headers": [ { "name": "opc-request-id", "value": "" }, { "name": "opc-retry-token", "value": "" }, { "name": "opc-named-credential-id", "value": "" } ], "params": [ { "name": "managedDatabaseId", "value": "", "type": "path", "description": "The [OCID](/Content/General/Concepts/identifiers.htm) of the Managed Database." }, { "name": "awrDbId", "value": "", "type": "path", "description": "The parameter to filter the database by internal ID.\nNote that the internal ID of the database can be retrieved from the following endpoint:\n/managedDatabases/{managedDatabaseId}/awrDbs\n" }, { "name": "instNum", "value": "", "type": "query", "description": "The optional single value query parameter to filter the database instance number." }, { "name": "beginSnIdGreaterThanOrEqualTo", "value": "", "type": "query", "description": "The optional greater than or equal to filter on the snapshot ID." }, { "name": "endSnIdLessThanOrEqualTo", "value": "", "type": "query", "description": "The optional less than or equal to query parameter to filter the snapshot ID." }, { "name": "timeGreaterThanOrEqualTo", "value": "", "type": "query", "description": "The optional greater than or equal to query parameter to filter the timestamp." }, { "name": "timeLessThanOrEqualTo", "value": "", "type": "query", "description": "The optional less than or equal to query parameter to filter the timestamp." }, { "name": "sessionType", "value": "", "type": "query", "description": "The optional query parameter to filter ASH activities by FOREGROUND or BACKGROUND." }, { "name": "containerId", "value": "", "type": "query", "description": "The optional query parameter to filter the database container by an exact ID value.\nNote that the database container ID can be retrieved from the following endpoint:\n/managedDatabases/{managedDatabaseId}/awrDbSnapshotRanges\n" }, { "name": "page", "value": "", "type": "query", "description": "The page token representing the page from where the next set of paginated results\nare retrieved. This is usually retrieved from a previous list call.\n" }, { "name": "limit", "value": "", "type": "query", "description": "The maximum number of records returned in large paginated response." }, { "name": "sortBy", "value": "", "type": "query", "description": "The option to sort the AWR CPU usage summary data." }, { "name": "sortOrder", "value": "", "type": "query", "description": "The option to sort information in ascending (‘ASC’) or descending (‘DESC’) order. Descending order is the default order." } ] }, "docs": "Summarizes the AWR CPU resource limits and metrics for the specified database in AWR.\n" }, { "info": { "name": "Summarizes metric samples for the specified database.", "type": "http" }, "http": { "method": "GET", "url": "http://dbmgmt.{region}.oci.oraclecloud.com/20201101/managedDatabases/:managedDatabaseId/awrDbs/:awrDbId/awrDbMetrics", "headers": [ { "name": "opc-request-id", "value": "" }, { "name": "opc-retry-token", "value": "" }, { "name": "opc-named-credential-id", "value": "" } ], "params": [ { "name": "managedDatabaseId", "value": "", "type": "path", "description": "The [OCID](/Content/General/Concepts/identifiers.htm) of the Managed Database." }, { "name": "awrDbId", "value": "", "type": "path", "description": "The parameter to filter the database by internal ID.\nNote that the internal ID of the database can be retrieved from the following endpoint:\n/managedDatabases/{managedDatabaseId}/awrDbs\n" }, { "name": "instNum", "value": "", "type": "query", "description": "The optional single value query parameter to filter the database instance number." }, { "name": "beginSnIdGreaterThanOrEqualTo", "value": "", "type": "query", "description": "The optional greater than or equal to filter on the snapshot ID." }, { "name": "endSnIdLessThanOrEqualTo", "value": "", "type": "query", "description": "The optional less than or equal to query parameter to filter the snapshot ID." }, { "name": "timeGreaterThanOrEqualTo", "value": "", "type": "query", "description": "The optional greater than or equal to query parameter to filter the timestamp." }, { "name": "timeLessThanOrEqualTo", "value": "", "type": "query", "description": "The optional less than or equal to query parameter to filter the timestamp." }, { "name": "name", "value": "", "type": "query", "description": "The required multiple value query parameter to filter the entity name." }, { "name": "containerId", "value": "", "type": "query", "description": "The optional query parameter to filter the database container by an exact ID value.\nNote that the database container ID can be retrieved from the following endpoint:\n/managedDatabases/{managedDatabaseId}/awrDbSnapshotRanges\n" }, { "name": "page", "value": "", "type": "query", "description": "The page token representing the page from where the next set of paginated results\nare retrieved. This is usually retrieved from a previous list call.\n" }, { "name": "limit", "value": "", "type": "query", "description": "The maximum number of records returned in large paginated response." }, { "name": "sortBy", "value": "", "type": "query", "description": "The option to sort the AWR time series summary data." }, { "name": "sortOrder", "value": "", "type": "query", "description": "The option to sort information in ascending (‘ASC’) or descending (‘DESC’) order. Descending order is the default order." } ] }, "docs": "Summarizes the metric samples for the specified database in the AWR. The metric samples are summarized based on the Time dimension for each metric.\n" }, { "info": { "name": "Summarize the AWR database parameter change history.", "type": "http" }, "http": { "method": "GET", "url": "http://dbmgmt.{region}.oci.oraclecloud.com/20201101/managedDatabases/:managedDatabaseId/awrDbs/:awrDbId/awrDbParameterChanges", "headers": [ { "name": "opc-request-id", "value": "" }, { "name": "opc-retry-token", "value": "" }, { "name": "opc-named-credential-id", "value": "" } ], "params": [ { "name": "managedDatabaseId", "value": "", "type": "path", "description": "The [OCID](/Content/General/Concepts/identifiers.htm) of the Managed Database." }, { "name": "awrDbId", "value": "", "type": "path", "description": "The parameter to filter the database by internal ID.\nNote that the internal ID of the database can be retrieved from the following endpoint:\n/managedDatabases/{managedDatabaseId}/awrDbs\n" }, { "name": "instNum", "value": "", "type": "query", "description": "The optional single value query parameter to filter the database instance number." }, { "name": "beginSnIdGreaterThanOrEqualTo", "value": "", "type": "query", "description": "The optional greater than or equal to filter on the snapshot ID." }, { "name": "endSnIdLessThanOrEqualTo", "value": "", "type": "query", "description": "The optional less than or equal to query parameter to filter the snapshot ID." }, { "name": "timeGreaterThanOrEqualTo", "value": "", "type": "query", "description": "The optional greater than or equal to query parameter to filter the timestamp." }, { "name": "timeLessThanOrEqualTo", "value": "", "type": "query", "description": "The optional less than or equal to query parameter to filter the timestamp." }, { "name": "containerId", "value": "", "type": "query", "description": "The optional query parameter to filter the database container by an exact ID value.\nNote that the database container ID can be retrieved from the following endpoint:\n/managedDatabases/{managedDatabaseId}/awrDbSnapshotRanges\n" }, { "name": "name", "value": "", "type": "query", "description": "The required single value query parameter to filter the entity name." }, { "name": "page", "value": "", "type": "query", "description": "The page token representing the page from where the next set of paginated results\nare retrieved. This is usually retrieved from a previous list call.\n" }, { "name": "limit", "value": "", "type": "query", "description": "The maximum number of records returned in large paginated response." }, { "name": "sortBy", "value": "", "type": "query", "description": "The option to sort the AWR database parameter change history data." }, { "name": "sortOrder", "value": "", "type": "query", "description": "The option to sort information in ascending (‘ASC’) or descending (‘DESC’) order. Descending order is the default order." } ] }, "docs": "Summarizes the database parameter change history for one database parameter of the specified database in AWR. One change history record contains\nthe previous value, the changed value, and the corresponding time range. If the database parameter value was changed multiple times within the time range, then multiple change history records are created for the same parameter.\nNote that this API only returns information on change history details for one database parameter.\nTo get a list of all the data" }, { "info": { "name": "Summarize AWR datbase parameter history information.", "type": "http" }, "http": { "method": "GET", "url": "http://dbmgmt.{region}.oci.oraclecloud.com/20201101/managedDatabases/:managedDatabaseId/awrDbs/:awrDbId/awrDbParameters", "headers": [ { "name": "opc-request-id", "value": "" }, { "name": "opc-retry-token", "value": "" }, { "name": "opc-named-credential-id", "value": "" } ], "params": [ { "name": "managedDatabaseId", "value": "", "type": "path", "description": "The [OCID](/Content/General/Concepts/identifiers.htm) of the Managed Database." }, { "name": "awrDbId", "value": "", "type": "path", "description": "The parameter to filter the database by internal ID.\nNote that the internal ID of the database can be retrieved from the following endpoint:\n/managedDatabases/{managedDatabaseId}/awrDbs\n" }, { "name": "instNum", "value": "", "type": "query", "description": "The optional single value query parameter to filter the database instance number." }, { "name": "beginSnIdGreaterThanOrEqualTo", "value": "", "type": "query", "description": "The optional greater than or equal to filter on the snapshot ID." }, { "name": "endSnIdLessThanOrEqualTo", "value": "", "type": "query", "description": "The optional less than or equal to query parameter to filter the snapshot ID." }, { "name": "timeGreaterThanOrEqualTo", "value": "", "type": "query", "description": "The optional greater than or equal to query parameter to filter the timestamp." }, { "name": "timeLessThanOrEqualTo", "value": "", "type": "query", "description": "The optional less than or equal to query parameter to filter the timestamp." }, { "name": "containerId", "value": "", "type": "query", "description": "The optional query parameter to filter the database container by an exact ID value.\nNote that the database container ID can be retrieved from the following endpoint:\n/managedDatabases/{managedDatabaseId}/awrDbSnapshotRanges\n" }, { "name": "name", "value": "", "type": "query", "description": "The optional multiple value query parameter to filter the entity name." }, { "name": "nameContains", "value": "", "type": "query", "description": "The optional contains query parameter to filter the entity name by any part of the name." }, { "name": "valueChanged", "value": "", "type": "query", "description": "The optional query parameter to filter database parameters whose values were changed." }, { "name": "valueDefault", "value": "", "type": "query", "description": "The optional query parameter to filter the database parameters that had the default value in the last snapshot." }, { "name": "valueModified", "value": "", "type": "query", "description": "The optional query parameter to filter the database parameters that had a modified value in the last snapshot." }, { "name": "page", "value": "", "type": "query", "description": "The page token representing the page from where the next set of paginated results\nare retrieved. This is usually retrieved from a previous list call.\n" }, { "name": "limit", "value": "", "type": "query", "description": "The maximum number of records returned in large paginated response." }, { "name": "sortBy", "value": "", "type": "query", "description": "The option to sort the AWR database parameter change history data." }, { "name": "sortOrder", "value": "", "type": "query", "description": "The option to sort information in ascending (‘ASC’) or descending (‘DESC’) order. Descending order is the default order." } ] }, "docs": "Summarizes the database parameter history for the specified database in AWR. This includes the list of database\nparameters, with information on whether the parameter values were modified within the query time range. Note that\neach database parameter is only listed once. Depending on the optional query parameters, the returned summary gets all the database parameters, which include:\n\n- Each parameter whose value was changed during the time range: (valueChanged =\"Y\")\n- Each parameter whose value " }, { "info": { "name": "Gets the AWR database report.", "type": "http" }, "http": { "method": "GET", "url": "http://dbmgmt.{region}.oci.oraclecloud.com/20201101/managedDatabases/:managedDatabaseId/awrDbs/:awrDbId/awrDbReport", "headers": [ { "name": "opc-request-id", "value": "" }, { "name": "opc-retry-token", "value": "" }, { "name": "opc-named-credential-id", "value": "" } ], "params": [ { "name": "managedDatabaseId", "value": "", "type": "path", "description": "The [OCID](/Content/General/Concepts/identifiers.htm) of the Managed Database." }, { "name": "awrDbId", "value": "", "type": "path", "description": "The parameter to filter the database by internal ID.\nNote that the internal ID of the database can be retrieved from the following endpoint:\n/managedDatabases/{managedDatabaseId}/awrDbs\n" }, { "name": "instNums", "value": "", "type": "query", "description": "The optional multiple value query parameter to filter the database instance numbers." }, { "name": "beginSnIdGreaterThanOrEqualTo", "value": "", "type": "query", "description": "The optional greater than or equal to filter on the snapshot ID." }, { "name": "endSnIdLessThanOrEqualTo", "value": "", "type": "query", "description": "The optional less than or equal to query parameter to filter the snapshot ID." }, { "name": "timeGreaterThanOrEqualTo", "value": "", "type": "query", "description": "The optional greater than or equal to query parameter to filter the timestamp." }, { "name": "timeLessThanOrEqualTo", "value": "", "type": "query", "description": "The optional less than or equal to query parameter to filter the timestamp." }, { "name": "reportType", "value": "", "type": "query", "description": "The query parameter to filter the AWR report types." }, { "name": "containerId", "value": "", "type": "query", "description": "The optional query parameter to filter the database container by an exact ID value.\nNote that the database container ID can be retrieved from the following endpoint:\n/managedDatabases/{managedDatabaseId}/awrDbSnapshotRanges\n" }, { "name": "reportFormat", "value": "", "type": "query", "description": "The format of the AWR report." } ] }, "docs": "Gets the AWR report for the specified database.\n" }, { "info": { "name": "List the AWR snapshots for one database.", "type": "http" }, "http": { "method": "GET", "url": "http://dbmgmt.{region}.oci.oraclecloud.com/20201101/managedDatabases/:managedDatabaseId/awrDbs/:awrDbId/awrDbSnapshots", "headers": [ { "name": "opc-request-id", "value": "" }, { "name": "opc-retry-token", "value": "" }, { "name": "opc-named-credential-id", "value": "" } ], "params": [ { "name": "managedDatabaseId", "value": "", "type": "path", "description": "The [OCID](/Content/General/Concepts/identifiers.htm) of the Managed Database." }, { "name": "awrDbId", "value": "", "type": "path", "description": "The parameter to filter the database by internal ID.\nNote that the internal ID of the database can be retrieved from the following endpoint:\n/managedDatabases/{managedDatabaseId}/awrDbs\n" }, { "name": "instNum", "value": "", "type": "query", "description": "The optional single value query parameter to filter the database instance number." }, { "name": "beginSnIdGreaterThanOrEqualTo", "value": "", "type": "query", "description": "The optional greater than or equal to filter on the snapshot ID." }, { "name": "endSnIdLessThanOrEqualTo", "value": "", "type": "query", "description": "The optional less than or equal to query parameter to filter the snapshot ID." }, { "name": "timeGreaterThanOrEqualTo", "value": "", "type": "query", "description": "The optional greater than or equal to query parameter to filter the timestamp." }, { "name": "timeLessThanOrEqualTo", "value": "", "type": "query", "description": "The optional less than or equal to query parameter to filter the timestamp." }, { "name": "containerId", "value": "", "type": "query", "description": "The optional query parameter to filter the database container by an exact ID value.\nNote that the database container ID can be retrieved from the following endpoint:\n/managedDatabases/{managedDatabaseId}/awrDbSnapshotRanges\n" }, { "name": "page", "value": "", "type": "query", "description": "The page token representing the page from where the next set of paginated results\nare retrieved. This is usually retrieved from a previous list call.\n" }, { "name": "limit", "value": "", "type": "query", "description": "The maximum number of records returned in the paginated response." }, { "name": "sortBy", "value": "", "type": "query", "description": "The option to sort the AWR snapshot summary data." }, { "name": "sortOrder", "value": "", "type": "query", "description": "The option to sort information in ascending (‘ASC’) or descending (‘DESC’) order. Descending order is the default order." } ] }, "docs": "Lists AWR snapshots for the specified database in the AWR.\n" }, { "info": { "name": "Gets the SQL health check report for the SQL statement specified by the SQL ID.", "type": "http" }, "http": { "method": "GET", "url": "http://dbmgmt.{region}.oci.oraclecloud.com/20201101/managedDatabases/:managedDatabaseId/awrDbs/:awrDbId/awrDbSqlReport", "headers": [ { "name": "opc-request-id", "value": "" }, { "name": "opc-retry-token", "value": "" }, { "name": "opc-named-credential-id", "value": "" } ], "params": [ { "name": "managedDatabaseId", "value": "", "type": "path", "description": "The [OCID](/Content/General/Concepts/identifiers.htm) of the Managed Database." }, { "name": "awrDbId", "value": "", "type": "path", "description": "The parameter to filter the database by internal ID.\nNote that the internal ID of the database can be retrieved from the following endpoint:\n/managedDatabases/{managedDatabaseId}/awrDbs\n" }, { "name": "instNum", "value": "", "type": "query", "description": "The optional single value query parameter to filter the database instance number." }, { "name": "beginSnIdGreaterThanOrEqualTo", "value": "", "type": "query", "description": "The optional greater than or equal to filter on the snapshot ID." }, { "name": "endSnIdLessThanOrEqualTo", "value": "", "type": "query", "description": "The optional less than or equal to query parameter to filter the snapshot ID." }, { "name": "timeGreaterThanOrEqualTo", "value": "", "type": "query", "description": "The optional greater than or equal to query parameter to filter the timestamp." }, { "name": "timeLessThanOrEqualTo", "value": "", "type": "query", "description": "The optional less than or equal to query parameter to filter the timestamp." }, { "name": "sqlId", "value": "", "type": "query", "description": "The parameter to filter SQL by ID. Note that the SQL ID is generated internally by Oracle for each SQL statement and can be retrieved from AWR Report API (/managedDatabases/{managedDatabaseId}/awrDbs/{awrDbId}/awrDbReport) or Performance Hub API (/internal/managedDatabases/{managedDatabaseId}/actions/retrievePerformanceData)\n" }, { "name": "reportFormat", "value": "", "type": "query", "description": "The format of the AWR report." }, { "name": "containerId", "value": "", "type": "query", "description": "The optional query parameter to filter the database container by an exact ID value.\nNote that the database container ID can be retrieved from the following endpoint:\n/managedDatabases/{managedDatabaseId}/awrDbSnapshotRanges\n" } ] }, "docs": "Gets the SQL health check report for one SQL of the specified database.\n" }, { "info": { "name": "Summarizes AWR Sysstat sample data for one database.", "type": "http" }, "http": { "method": "GET", "url": "http://dbmgmt.{region}.oci.oraclecloud.com/20201101/managedDatabases/:managedDatabaseId/awrDbs/:awrDbId/awrDbSysstats", "headers": [ { "name": "opc-request-id", "value": "" }, { "name": "opc-retry-token", "value": "" }, { "name": "opc-named-credential-id", "value": "" } ], "params": [ { "name": "managedDatabaseId", "value": "", "type": "path", "description": "The [OCID](/Content/General/Concepts/identifiers.htm) of the Managed Database." }, { "name": "awrDbId", "value": "", "type": "path", "description": "The parameter to filter the database by internal ID.\nNote that the internal ID of the database can be retrieved from the following endpoint:\n/managedDatabases/{managedDatabaseId}/awrDbs\n" }, { "name": "instNum", "value": "", "type": "query", "description": "The optional single value query parameter to filter the database instance number." }, { "name": "beginSnIdGreaterThanOrEqualTo", "value": "", "type": "query", "description": "The optional greater than or equal to filter on the snapshot ID." }, { "name": "endSnIdLessThanOrEqualTo", "value": "", "type": "query", "description": "The optional less than or equal to query parameter to filter the snapshot ID." }, { "name": "timeGreaterThanOrEqualTo", "value": "", "type": "query", "description": "The optional greater than or equal to query parameter to filter the timestamp." }, { "name": "timeLessThanOrEqualTo", "value": "", "type": "query", "description": "The optional less than or equal to query parameter to filter the timestamp." }, { "name": "name", "value": "", "type": "query", "description": "The required multiple value query parameter to filter the entity name." }, { "name": "containerId", "value": "", "type": "query", "description": "The optional query parameter to filter the database container by an exact ID value.\nNote that the database container ID can be retrieved from the following endpoint:\n/managedDatabases/{managedDatabaseId}/awrDbSnapshotRanges\n" }, { "name": "page", "value": "", "type": "query", "description": "The page token representing the page from where the next set of paginated results\nare retrieved. This is usually retrieved from a previous list call.\n" }, { "name": "limit", "value": "", "type": "query", "description": "The maximum number of records returned in large paginated response." }, { "name": "sortBy", "value": "", "type": "query", "description": "The option to sort the data within a time period." }, { "name": "sortOrder", "value": "", "type": "query", "description": "The option to sort information in ascending (‘ASC’) or descending (‘DESC’) order. Descending order is the default order." } ] }, "docs": "Summarizes the AWR SYSSTAT sample data for the specified database in AWR. The statistical data is summarized based on the Time dimension for each statistic.\n" }, { "info": { "name": "Summarizes AWR top N wait events.", "type": "http" }, "http": { "method": "GET", "url": "http://dbmgmt.{region}.oci.oraclecloud.com/20201101/managedDatabases/:managedDatabaseId/awrDbs/:awrDbId/awrDbTopWaitEvents", "headers": [ { "name": "opc-request-id", "value": "" }, { "name": "opc-retry-token", "value": "" }, { "name": "opc-named-credential-id", "value": "" } ], "params": [ { "name": "managedDatabaseId", "value": "", "type": "path", "description": "The [OCID](/Content/General/Concepts/identifiers.htm) of the Managed Database." }, { "name": "awrDbId", "value": "", "type": "path", "description": "The parameter to filter the database by internal ID.\nNote that the internal ID of the database can be retrieved from the following endpoint:\n/managedDatabases/{managedDatabaseId}/awrDbs\n" }, { "name": "instNum", "value": "", "type": "query", "description": "The optional single value query parameter to filter the database instance number." }, { "name": "beginSnIdGreaterThanOrEqualTo", "value": "", "type": "query", "description": "The optional greater than or equal to filter on the snapshot ID." }, { "name": "endSnIdLessThanOrEqualTo", "value": "", "type": "query", "description": "The optional less than or equal to query parameter to filter the snapshot ID." }, { "name": "timeGreaterThanOrEqualTo", "value": "", "type": "query", "description": "The optional greater than or equal to query parameter to filter the timestamp." }, { "name": "timeLessThanOrEqualTo", "value": "", "type": "query", "description": "The optional less than or equal to query parameter to filter the timestamp." }, { "name": "sessionType", "value": "", "type": "query", "description": "The optional query parameter to filter ASH activities by FOREGROUND or BACKGROUND." }, { "name": "containerId", "value": "", "type": "query", "description": "The optional query parameter to filter the database container by an exact ID value.\nNote that the database container ID can be retrieved from the following endpoint:\n/managedDatabases/{managedDatabaseId}/awrDbSnapshotRanges\n" }, { "name": "topN", "value": "", "type": "query", "description": "The optional query parameter to filter the number of top categories to be returned." }, { "name": "sortBy", "value": "", "type": "query", "description": "The option to sort the AWR top event summary data." }, { "name": "sortOrder", "value": "", "type": "query", "description": "The option to sort information in ascending (‘ASC’) or descending (‘DESC’) order. Descending order is the default order." } ] }, "docs": "Summarizes the AWR top wait events.\n" }, { "info": { "name": "Summarize AWR event data into value buckets and frequencies for one database.", "type": "http" }, "http": { "method": "GET", "url": "http://dbmgmt.{region}.oci.oraclecloud.com/20201101/managedDatabases/:managedDatabaseId/awrDbs/:awrDbId/awrDbWaitEventBuckets", "headers": [ { "name": "opc-request-id", "value": "" }, { "name": "opc-retry-token", "value": "" }, { "name": "opc-named-credential-id", "value": "" } ], "params": [ { "name": "managedDatabaseId", "value": "", "type": "path", "description": "The [OCID](/Content/General/Concepts/identifiers.htm) of the Managed Database." }, { "name": "awrDbId", "value": "", "type": "path", "description": "The parameter to filter the database by internal ID.\nNote that the internal ID of the database can be retrieved from the following endpoint:\n/managedDatabases/{managedDatabaseId}/awrDbs\n" }, { "name": "instNum", "value": "", "type": "query", "description": "The optional single value query parameter to filter the database instance number." }, { "name": "beginSnIdGreaterThanOrEqualTo", "value": "", "type": "query", "description": "The optional greater than or equal to filter on the snapshot ID." }, { "name": "endSnIdLessThanOrEqualTo", "value": "", "type": "query", "description": "The optional less than or equal to query parameter to filter the snapshot ID." }, { "name": "timeGreaterThanOrEqualTo", "value": "", "type": "query", "description": "The optional greater than or equal to query parameter to filter the timestamp." }, { "name": "timeLessThanOrEqualTo", "value": "", "type": "query", "description": "The optional less than or equal to query parameter to filter the timestamp." }, { "name": "name", "value": "", "type": "query", "description": "The required single value query parameter to filter the entity name." }, { "name": "numBucket", "value": "", "type": "query", "description": "The number of buckets within the histogram." }, { "name": "minValue", "value": "", "type": "query", "description": "The minimum value of the histogram." }, { "name": "maxValue", "value": "", "type": "query", "description": "The maximum value of the histogram." }, { "name": "containerId", "value": "", "type": "query", "description": "The optional query parameter to filter the database container by an exact ID value.\nNote that the database container ID can be retrieved from the following endpoint:\n/managedDatabases/{managedDatabaseId}/awrDbSnapshotRanges\n" }, { "name": "page", "value": "", "type": "query", "description": "The page token representing the page from where the next set of paginated results\nare retrieved. This is usually retrieved from a previous list call.\n" }, { "name": "limit", "value": "", "type": "query", "description": "The maximum number of records returned in large paginated response." }, { "name": "sortBy", "value": "", "type": "query", "description": "The option to sort distribution data." }, { "name": "sortOrder", "value": "", "type": "query", "description": "The option to sort information in ascending (‘ASC’) or descending (‘DESC’) order. Ascending order is the default order." } ] }, "docs": "Summarizes AWR wait event data into value buckets and frequency, for the specified database in the AWR.\n" }, { "info": { "name": "Summarizes AWR wait event sample data.", "type": "http" }, "http": { "method": "GET", "url": "http://dbmgmt.{region}.oci.oraclecloud.com/20201101/managedDatabases/:managedDatabaseId/awrDbs/:awrDbId/awrDbWaitEvents", "headers": [ { "name": "opc-request-id", "value": "" }, { "name": "opc-retry-token", "value": "" }, { "name": "opc-named-credential-id", "value": "" } ], "params": [ { "name": "managedDatabaseId", "value": "", "type": "path", "description": "The [OCID](/Content/General/Concepts/identifiers.htm) of the Managed Database." }, { "name": "awrDbId", "value": "", "type": "path", "description": "The parameter to filter the database by internal ID.\nNote that the internal ID of the database can be retrieved from the following endpoint:\n/managedDatabases/{managedDatabaseId}/awrDbs\n" }, { "name": "instNum", "value": "", "type": "query", "description": "The optional single value query parameter to filter the database instance number." }, { "name": "beginSnIdGreaterThanOrEqualTo", "value": "", "type": "query", "description": "The optional greater than or equal to filter on the snapshot ID." }, { "name": "endSnIdLessThanOrEqualTo", "value": "", "type": "query", "description": "The optional less than or equal to query parameter to filter the snapshot ID." }, { "name": "timeGreaterThanOrEqualTo", "value": "", "type": "query", "description": "The optional greater than or equal to query parameter to filter the timestamp." }, { "name": "timeLessThanOrEqualTo", "value": "", "type": "query", "description": "The optional less than or equal to query parameter to filter the timestamp." }, { "name": "name", "value": "", "type": "query", "description": "The optional multiple value query parameter to filter the entity name." }, { "name": "sessionType", "value": "", "type": "query", "description": "The optional query parameter to filter ASH activities by FOREGROUND or BACKGROUND." }, { "name": "containerId", "value": "", "type": "query", "description": "The optional query parameter to filter the database container by an exact ID value.\nNote that the database container ID can be retrieved from the following endpoint:\n/managedDatabases/{managedDatabaseId}/awrDbSnapshotRanges\n" }, { "name": "page", "value": "", "type": "query", "description": "The page token representing the page from where the next set of paginated results\nare retrieved. This is usually retrieved from a previous list call.\n" }, { "name": "limit", "value": "", "type": "query", "description": "The maximum number of records returned in large paginated response." }, { "name": "sortBy", "value": "", "type": "query", "description": "The option to sort the data within a time period." }, { "name": "sortOrder", "value": "", "type": "query", "description": "The option to sort information in ascending (‘ASC’) or descending (‘DESC’) order. Descending order is the default order." } ] }, "docs": "Summarizes the AWR wait event sample data for the specified database in the AWR. The event data is summarized based on the Time dimension for each event.\n" }, { "info": { "name": "Gets a detailed summary of various cluster cache metrics.\n", "type": "http" }, "http": { "method": "GET", "url": "http://dbmgmt.{region}.oci.oraclecloud.com/20201101/managedDatabases/:managedDatabaseId/clusterCacheMetrics", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "managedDatabaseId", "value": "", "type": "path", "description": "The [OCID](/Content/General/Concepts/identifiers.htm) of the Managed Database." }, { "name": "startTime", "value": "", "type": "query", "description": "The start time of the time range to retrieve the health metrics of a Managed Database\nin UTC in ISO-8601 format, which is \"yyyy-MM-dd'T'hh:mm:ss.sss'Z'\".\n" }, { "name": "endTime", "value": "", "type": "query", "description": "The end time of the time range to retrieve the health metrics of a Managed Database\nin UTC in ISO-8601 format, which is \"yyyy-MM-dd'T'hh:mm:ss.sss'Z'\".\n" } ] }, "docs": "Gets the metrics related to cluster cache for the Oracle\nReal Application Clusters (Oracle RAC) database specified\nby managedDatabaseId.\n" }, { "info": { "name": "Lists the SQL statements from shared SQL area, also called the cursor cache.", "type": "http" }, "http": { "method": "GET", "url": "http://dbmgmt.{region}.oci.oraclecloud.com/20201101/managedDatabases/:managedDatabaseId/cursorCacheStatements", "headers": [ { "name": "opc-request-id", "value": "" }, { "name": "opc-named-credential-id", "value": "" } ], "params": [ { "name": "managedDatabaseId", "value": "", "type": "path", "description": "The [OCID](/Content/General/Concepts/identifiers.htm) of the Managed Database." }, { "name": "sqlText", "value": "", "type": "query", "description": "A filter to return all the SQL plan baselines that match the SQL text. By default, the search\nis case insensitive. To run an exact or case-sensitive search, double-quote the search string.\nYou may also use the '%' symbol as a wildcard.\n" }, { "name": "page", "value": "", "type": "query", "description": "The page token representing the page from where the next set of paginated results\nare retrieved. This is usually retrieved from a previous list call.\n" }, { "name": "limit", "value": "", "type": "query", "description": "The maximum number of records returned in the paginated response." }, { "name": "sortBy", "value": "", "type": "query", "description": "The option to sort the SQL statement summary data." }, { "name": "sortOrder", "value": "", "type": "query", "description": "The option to sort information in ascending (‘ASC’) or descending (‘DESC’) order. Ascending order is the default order." } ] }, "docs": "Lists the SQL statements from shared SQL area, also called the cursor cache.\n" }, { "info": { "name": "Lists database parameters.\n", "type": "http" }, "http": { "method": "GET", "url": "http://dbmgmt.{region}.oci.oraclecloud.com/20201101/managedDatabases/:managedDatabaseId/databaseParameters", "headers": [ { "name": "opc-request-id", "value": "" }, { "name": "opc-named-credential-id", "value": "" } ], "params": [ { "name": "managedDatabaseId", "value": "", "type": "path", "description": "The [OCID](/Content/General/Concepts/identifiers.htm) of the Managed Database." }, { "name": "source", "value": "", "type": "query", "description": "The source used to list database parameters. `CURRENT` is used to get the\ndatabase parameters that are currently in effect for the database\ninstance. `SPFILE` is used to list parameters from the server parameter\nfile. Default is `CURRENT`.\n" }, { "name": "name", "value": "", "type": "query", "description": "A filter to return all parameters that have the text given in their names.\n" }, { "name": "isAllowedValuesIncluded", "value": "", "type": "query", "description": "When true, results include a list of valid values for parameters (if applicable).\n" }, { "name": "sortBy", "value": "", "type": "query", "description": "The field to sort information by. Only one sortOrder can be used. The\ndefault sort order for `NAME` is ascending and it is case-sensitive.\n" }, { "name": "sortOrder", "value": "", "type": "query", "description": "The option to sort information in ascending (‘ASC’) or descending (‘DESC’) order. Ascending order is the default order." } ] }, "docs": "Gets the list of database parameters for the specified Managed Database. The parameters are listed in alphabetical order, along with their current values.\n" }, { "info": { "name": "Gets a summary of the Data Guard performance metrics like ApplyLag, TransportLag and RedoApplyRate metrics for the Managed Databases.", "type": "http" }, "http": { "method": "GET", "url": "http://dbmgmt.{region}.oci.oraclecloud.com/20201101/managedDatabases/:managedDatabaseId/dataguardPerformanceMetrics", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "managedDatabaseId", "value": "", "type": "path", "description": "The [OCID](/Content/General/Concepts/identifiers.htm) of the Managed Database." }, { "name": "startTime", "value": "", "type": "query", "description": "The start time of the time range to retrieve the health metrics of a Managed Database\nin UTC in ISO-8601 format, which is \"yyyy-MM-dd'T'hh:mm:ss.sss'Z'\".\n" }, { "name": "endTime", "value": "", "type": "query", "description": "The end time of the time range to retrieve the health metrics of a Managed Database\nin UTC in ISO-8601 format, which is \"yyyy-MM-dd'T'hh:mm:ss.sss'Z'\".\n" }, { "name": "peerDatabaseCompartmentId", "value": "", "type": "query", "description": "The [OCID](/Content/General/Concepts/identifiers.htm) of the compartment for which peer database metrics are required.\nThis is not a mandatory parameter and in its absence, all the peer database metrics are returned.\n" }, { "name": "filterByMetricNames", "value": "", "type": "query", "description": "The filter used to retrieve a specific set of metrics by passing the desired metric names with a comma separator. Note that, by default, the service returns all supported metrics." } ] }, "docs": "Gets a historical summary of the Database Guard performance metrics for Managed Databases.\nIf the peerDatabaseCompartmentId is specified, then the metrics are only retrieved from the specified compartment. \nIf the peerDatabaseCompartmentId is not specified, then the metrics are retrieved from the compartment of the Managed Database specified by the ManagedDatabaseId.\n" }, { "info": { "name": "Gets HA and backup details with metrics and backup history for a single database.\n", "type": "http" }, "http": { "method": "GET", "url": "http://dbmgmt.{region}.oci.oraclecloud.com/20201101/managedDatabases/:managedDatabaseId/haBackupDetails", "headers": [ { "name": "opc-request-id", "value": "" }, { "name": "opc-named-credential-id", "value": "" } ], "params": [ { "name": "managedDatabaseId", "value": "", "type": "path", "description": "The [OCID](/Content/General/Concepts/identifiers.htm) of the Managed Database." } ] }, "docs": "Gets HA and backup details with metrics and backup history for a single database.\n" }, { "info": { "name": "Lists the optimizer advisor task executions scan details and their findings count.", "type": "http" }, "http": { "method": "GET", "url": "http://dbmgmt.{region}.oci.oraclecloud.com/20201101/managedDatabases/:managedDatabaseId/optimizerStatisticsAdvisorExecutions", "headers": [ { "name": "opc-request-id", "value": "" }, { "name": "opc-named-credential-id", "value": "" } ], "params": [ { "name": "managedDatabaseId", "value": "", "type": "path", "description": "The [OCID](/Content/General/Concepts/identifiers.htm) of the Managed Database." }, { "name": "startTimeGreaterThanOrEqualTo", "value": "", "type": "query", "description": "The start time of the time range to retrieve the optimizer statistics of a Managed Database\nin UTC in ISO-8601 format, which is \"yyyy-MM-dd'T'hh:mm:ss.sss'Z'\".\n" }, { "name": "endTimeLessThanOrEqualTo", "value": "", "type": "query", "description": "The end time of the time range to retrieve the optimizer statistics of a Managed Database\nin UTC in ISO-8601 format, which is \"yyyy-MM-dd'T'hh:mm:ss.sss'Z'\".\n" } ] }, "docs": "Lists the details of the Optimizer Statistics Advisor task executions, such as their duration, and the number of findings, if any.\nOptionally, you can specify a date-time range (of seven days) to obtain the list of executions that fall within the specified time range.\nIf the date-time range is not specified, then the executions in the last seven days are listed.\n" }, { "info": { "name": "Gets the optimizer statistics advisor task execution detailed report.", "type": "http" }, "http": { "method": "GET", "url": "http://dbmgmt.{region}.oci.oraclecloud.com/20201101/managedDatabases/:managedDatabaseId/optimizerStatisticsAdvisorExecutions/:executionName", "headers": [ { "name": "opc-request-id", "value": "" }, { "name": "opc-named-credential-id", "value": "" } ], "params": [ { "name": "managedDatabaseId", "value": "", "type": "path", "description": "The [OCID](/Content/General/Concepts/identifiers.htm) of the Managed Database." }, { "name": "executionName", "value": "", "type": "path", "description": "The name of the Optimizer Statistics Advisor execution." }, { "name": "taskName", "value": "", "type": "query", "description": "The name of the optimizer statistics collection execution task." } ] }, "docs": "Gets a comprehensive report of the Optimizer Statistics Advisor execution, which includes details of the\nManaged Database, findings, recommendations, rationale, and examples.\n" }, { "info": { "name": "Implements the Optimizer Statistics Advisor task recommendations asynchronously.", "type": "http" }, "http": { "method": "POST", "url": "http://dbmgmt.{region}.oci.oraclecloud.com/20201101/managedDatabases/:managedDatabaseId/optimizerStatisticsAdvisorExecutions/:executionName/actions/implementRecommendations", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "managedDatabaseId", "value": "", "type": "path", "description": "The [OCID](/Content/General/Concepts/identifiers.htm) of the Managed Database." }, { "name": "executionName", "value": "", "type": "path", "description": "The name of the Optimizer Statistics Advisor execution." } ] }, "docs": "Asynchronously implements the findings and recommendations of the Optimizer Statistics Advisor execution." }, { "info": { "name": "Gets the optimizer statistics advisor execution script for the provided task and execution name.", "type": "http" }, "http": { "method": "GET", "url": "http://dbmgmt.{region}.oci.oraclecloud.com/20201101/managedDatabases/:managedDatabaseId/optimizerStatisticsAdvisorExecutions/:executionName/script", "headers": [ { "name": "opc-request-id", "value": "" }, { "name": "opc-named-credential-id", "value": "" } ], "params": [ { "name": "managedDatabaseId", "value": "", "type": "path", "description": "The [OCID](/Content/General/Concepts/identifiers.htm) of the Managed Database." }, { "name": "executionName", "value": "", "type": "path", "description": "The name of the Optimizer Statistics Advisor execution." }, { "name": "taskName", "value": "", "type": "query", "description": "The name of the optimizer statistics collection execution task." } ] }, "docs": "Gets the Oracle system-generated script for the specified Optimizer Statistics Advisor execution." }, { "info": { "name": "Lists the number of optimizer statistics collection operations per hour, grouped by task or object status for the specified Managed Database.", "type": "http" }, "http": { "method": "GET", "url": "http://dbmgmt.{region}.oci.oraclecloud.com/20201101/managedDatabases/:managedDatabaseId/optimizerStatisticsCollectionAggregations", "headers": [ { "name": "opc-request-id", "value": "" }, { "name": "opc-named-credential-id", "value": "" } ], "params": [ { "name": "managedDatabaseId", "value": "", "type": "path", "description": "The [OCID](/Content/General/Concepts/identifiers.htm) of the Managed Database." }, { "name": "startTimeGreaterThanOrEqualTo", "value": "", "type": "query", "description": "The start time of the time range to retrieve the optimizer statistics of a Managed Database\nin UTC in ISO-8601 format, which is \"yyyy-MM-dd'T'hh:mm:ss.sss'Z'\".\n" }, { "name": "endTimeLessThanOrEqualTo", "value": "", "type": "query", "description": "The end time of the time range to retrieve the optimizer statistics of a Managed Database\nin UTC in ISO-8601 format, which is \"yyyy-MM-dd'T'hh:mm:ss.sss'Z'\".\n" }, { "name": "taskType", "value": "", "type": "query", "description": "The filter types of the optimizer statistics tasks." }, { "name": "groupType", "value": "", "type": "query", "description": "The optimizer statistics tasks grouped by type." }, { "name": "limit", "value": "", "type": "query", "description": "The maximum number of records returned in the paginated response." }, { "name": "page", "value": "", "type": "query", "description": "The page token representing the page from where the next set of paginated results\nare retrieved. This is usually retrieved from a previous list call.\n" } ] }, "docs": "Gets a list of the optimizer statistics collection operations per hour, grouped by task or object status for the specified Managed Database.\nYou must specify a value for GroupByQueryParam to determine whether the data should be grouped by task status or task object status.\nOptionally, you can specify a date-time range (of seven days) to obtain collection aggregations within the specified time range.\nIf the date-time range is not specified, then the operations in the last seven days are listed.\nY" }, { "info": { "name": "This API returns a detailed summary of optimizer statistics collection operations.", "type": "http" }, "http": { "method": "GET", "url": "http://dbmgmt.{region}.oci.oraclecloud.com/20201101/managedDatabases/:managedDatabaseId/optimizerStatisticsCollectionOperations", "headers": [ { "name": "opc-request-id", "value": "" }, { "name": "opc-named-credential-id", "value": "" } ], "params": [ { "name": "managedDatabaseId", "value": "", "type": "path", "description": "The [OCID](/Content/General/Concepts/identifiers.htm) of the Managed Database." }, { "name": "startTimeGreaterThanOrEqualTo", "value": "", "type": "query", "description": "The start time of the time range to retrieve the optimizer statistics of a Managed Database\nin UTC in ISO-8601 format, which is \"yyyy-MM-dd'T'hh:mm:ss.sss'Z'\".\n" }, { "name": "endTimeLessThanOrEqualTo", "value": "", "type": "query", "description": "The end time of the time range to retrieve the optimizer statistics of a Managed Database\nin UTC in ISO-8601 format, which is \"yyyy-MM-dd'T'hh:mm:ss.sss'Z'\".\n" }, { "name": "taskType", "value": "", "type": "query", "description": "The filter types of the optimizer statistics tasks." }, { "name": "limit", "value": "", "type": "query", "description": "The maximum number of records returned in the paginated response." }, { "name": "page", "value": "", "type": "query", "description": "The page token representing the page from where the next set of paginated results\nare retrieved. This is usually retrieved from a previous list call.\n" }, { "name": "filterBy", "value": "", "type": "query", "description": "The parameter used to filter the optimizer statistics operations.\nAny property of the OptimizerStatisticsCollectionOperationSummary can be used to define the filter condition.\nThe allowed conditional operators are AND or OR, and the allowed binary operators are are >, < and =. Any other operator is regarded invalid.\nExample: jobName= AND status=\n" }, { "name": "sortBy", "value": "", "type": "query", "description": "Sorts the list of optimizer statistics operations based on a specific attribute." }, { "name": "sortOrder", "value": "", "type": "query", "description": "The option to sort information in ascending (‘ASC’) or descending (‘DESC’) order. Ascending order is the default order." } ] }, "docs": "Lists the Optimizer Statistics Collection (Auto and Manual) task operation summary for the specified Managed Database.\nThe summary includes the details of each operation and the number of tasks grouped by status: Completed, In Progress, Failed, and so on.\nOptionally, you can specify a date-time range (of seven days) to obtain the list of operations that fall within the specified time range.\nIf the date-time range is not specified, then the operations in the last seven days are listed.\nThis API a" }, { "info": { "name": "The API gets the optimizer statistics collection operation detailed report for the provided managed database.", "type": "http" }, "http": { "method": "GET", "url": "http://dbmgmt.{region}.oci.oraclecloud.com/20201101/managedDatabases/:managedDatabaseId/optimizerStatisticsCollectionOperations/:optimizerStatisticsCollectionOperationId", "headers": [ { "name": "opc-request-id", "value": "" }, { "name": "opc-named-credential-id", "value": "" } ], "params": [ { "name": "managedDatabaseId", "value": "", "type": "path", "description": "The [OCID](/Content/General/Concepts/identifiers.htm) of the Managed Database." }, { "name": "optimizerStatisticsCollectionOperationId", "value": "", "type": "path", "description": "The ID of the Optimizer Statistics Collection operation." } ] }, "docs": "Gets a detailed report of the Optimizer Statistics Collection operation for the specified Managed Database." }, { "info": { "name": "Gets a summary of the resource usage metrics like DB Time, CPU, User I/O, Wait, Storage, and Memory metrics for Pdb's under the container database.", "type": "http" }, "http": { "method": "GET", "url": "http://dbmgmt.{region}.oci.oraclecloud.com/20201101/managedDatabases/:managedDatabaseId/pdbMetrics", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "managedDatabaseId", "value": "", "type": "path", "description": "The [OCID](/Content/General/Concepts/identifiers.htm) of the Managed Database." }, { "name": "startTime", "value": "", "type": "query", "description": "The start time of the time range to retrieve the health metrics of a Managed Database\nin UTC in ISO-8601 format, which is \"yyyy-MM-dd'T'hh:mm:ss.sss'Z'\".\n" }, { "name": "endTime", "value": "", "type": "query", "description": "The end time of the time range to retrieve the health metrics of a Managed Database\nin UTC in ISO-8601 format, which is \"yyyy-MM-dd'T'hh:mm:ss.sss'Z'\".\n" }, { "name": "compartmentId", "value": "", "type": "query", "description": "The [OCID](/Content/General/Concepts/identifiers.htm) of the compartment." }, { "name": "compareType", "value": "", "type": "query", "description": "The time window used for metrics comparison." }, { "name": "filterByMetricNames", "value": "", "type": "query", "description": "The filter used to retrieve a specific set of metrics by passing the desired metric names with a comma separator. Note that, by default, the service returns all supported metrics." } ] }, "docs": "Gets a summary of the resource usage metrics such as CPU, User I/O, and Storage for each\nPDB within a specific CDB. If comparmentId is specified, then the metrics for\neach PDB (within the CDB) in the specified compartment are retrieved.\nIf compartmentId is not specified, then the metrics for all the PDBs within the CDB are retrieved.\n" }, { "info": { "name": "Gets a comparative summary of the baseline and target values of the Data Guard performance metrics for Managed Databases.", "type": "http" }, "http": { "method": "GET", "url": "http://dbmgmt.{region}.oci.oraclecloud.com/20201101/managedDatabases/:managedDatabaseId/peerDatabaseMetrics", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "managedDatabaseId", "value": "", "type": "path", "description": "The [OCID](/Content/General/Concepts/identifiers.htm) of the Managed Database." }, { "name": "startTime", "value": "", "type": "query", "description": "The start time of the time range to retrieve the health metrics of a Managed Database\nin UTC in ISO-8601 format, which is \"yyyy-MM-dd'T'hh:mm:ss.sss'Z'\".\n" }, { "name": "endTime", "value": "", "type": "query", "description": "The end time of the time range to retrieve the health metrics of a Managed Database\nin UTC in ISO-8601 format, which is \"yyyy-MM-dd'T'hh:mm:ss.sss'Z'\".\n" }, { "name": "peerDatabaseCompartmentId", "value": "", "type": "query", "description": "The [OCID](/Content/General/Concepts/identifiers.htm) of the compartment for which peer database metrics are required.\nThis is not a mandatory parameter and in its absence, all the peer database metrics are returned.\n" }, { "name": "compareType", "value": "", "type": "query", "description": "The time window used for metrics comparison." }, { "name": "filterByMetricNames", "value": "", "type": "query", "description": "The filter used to retrieve a specific set of metrics by passing the desired metric names with a comma separator. Note that, by default, the service returns all supported metrics." } ] }, "docs": "Gets a comparative summary of the baseline and target values of the Data Guard performance metrics for Managed Databases.\nIf the peerDatabaseCompartmentId is specified, then the metrics are only retrieved from the specified compartment. \nIf the peerDatabaseCompartmentId is not specified, then the metrics are retrieved from the compartment of the Managed Database specified by the ManagedDatabaseId.\n" }, { "info": { "name": "Gets the list of preferred credentials for the given Managed Database.", "type": "http" }, "http": { "method": "GET", "url": "http://dbmgmt.{region}.oci.oraclecloud.com/20201101/managedDatabases/:managedDatabaseId/preferredCredentials", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "managedDatabaseId", "value": "", "type": "path", "description": "The [OCID](/Content/General/Concepts/identifiers.htm) of the Managed Database." } ] }, "docs": "Gets the list of preferred credentials for a given Managed Database.\n" }, { "info": { "name": "Gets the preferred credential based on credentialName path attribute.", "type": "http" }, "http": { "method": "GET", "url": "http://dbmgmt.{region}.oci.oraclecloud.com/20201101/managedDatabases/:managedDatabaseId/preferredCredentials/:credentialName", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "managedDatabaseId", "value": "", "type": "path", "description": "The [OCID](/Content/General/Concepts/identifiers.htm) of the Managed Database." }, { "name": "credentialName", "value": "", "type": "path", "description": "The name of the preferred credential. There are 3 built-in preferred credentials with display names and names as below: \n Basic Monitoring(MONITORING)\n Advanced diagnostics(PC_READ)\n Administrator(PC_WRITE)\n" } ] }, "docs": "Gets the preferred credential details for a Managed Database based on credentialName.\n" }, { "info": { "name": "Update the details of preferred credential.", "type": "http" }, "http": { "method": "PUT", "url": "http://dbmgmt.{region}.oci.oraclecloud.com/20201101/managedDatabases/:managedDatabaseId/preferredCredentials/:credentialName", "headers": [ { "name": "opc-request-id", "value": "" }, { "name": "if-match", "value": "" } ], "params": [ { "name": "managedDatabaseId", "value": "", "type": "path", "description": "The [OCID](/Content/General/Concepts/identifiers.htm) of the Managed Database." }, { "name": "credentialName", "value": "", "type": "path", "description": "The name of the preferred credential. There are 3 built-in preferred credentials with display names and names as below: \n Basic Monitoring(MONITORING)\n Advanced diagnostics(PC_READ)\n Administrator(PC_WRITE)\n" } ] }, "docs": "Updates the preferred credential based on the credentialName.\n" }, { "info": { "name": "Delete the preferred credential.", "type": "http" }, "http": { "method": "DELETE", "url": "http://dbmgmt.{region}.oci.oraclecloud.com/20201101/managedDatabases/:managedDatabaseId/preferredCredentials/:credentialName", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "managedDatabaseId", "value": "", "type": "path", "description": "The [OCID](/Content/General/Concepts/identifiers.htm) of the Managed Database." }, { "name": "credentialName", "value": "", "type": "path", "description": "The name of the preferred credential. There are 3 built-in preferred credentials with display names and names as below: \n Basic Monitoring(MONITORING)\n Advanced diagnostics(PC_READ)\n Administrator(PC_WRITE)\n" } ] }, "docs": "Deletes the preferred credential based on the credentialName.\n" }, { "info": { "name": "Status of the test preferred credential.", "type": "http" }, "http": { "method": "POST", "url": "http://dbmgmt.{region}.oci.oraclecloud.com/20201101/managedDatabases/:managedDatabaseId/preferredCredentials/:credentialName/actions/test", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "managedDatabaseId", "value": "", "type": "path", "description": "The [OCID](/Content/General/Concepts/identifiers.htm) of the Managed Database." }, { "name": "credentialName", "value": "", "type": "path", "description": "The name of the preferred credential. There are 3 built-in preferred credentials with display names and names as below: \n Basic Monitoring(MONITORING)\n Advanced diagnostics(PC_READ)\n Administrator(PC_WRITE)\n" } ] }, "docs": "Tests the preferred credential.\n" }, { "info": { "name": "Gets SQL plan baseline configuration details.", "type": "http" }, "http": { "method": "GET", "url": "http://dbmgmt.{region}.oci.oraclecloud.com/20201101/managedDatabases/:managedDatabaseId/sqlPlanBaselineConfiguration", "headers": [ { "name": "opc-request-id", "value": "" }, { "name": "opc-named-credential-id", "value": "" } ], "params": [ { "name": "managedDatabaseId", "value": "", "type": "path", "description": "The [OCID](/Content/General/Concepts/identifiers.htm) of the Managed Database." } ] }, "docs": "Gets the configuration details of SQL plan baselines for the specified\nManaged Database. The details include the settings for the capture and use of\nSQL plan baselines, SPM Evolve Advisor task, and SQL Management Base.\n" }, { "info": { "name": "Get counts of SQL plan baselines aggregated by the age of their last execution in weeks.", "type": "http" }, "http": { "method": "GET", "url": "http://dbmgmt.{region}.oci.oraclecloud.com/20201101/managedDatabases/:managedDatabaseId/sqlPlanBaselineExecutionStats", "headers": [ { "name": "opc-request-id", "value": "" }, { "name": "opc-named-credential-id", "value": "" } ], "params": [ { "name": "managedDatabaseId", "value": "", "type": "path", "description": "The [OCID](/Content/General/Concepts/identifiers.htm) of the Managed Database." }, { "name": "page", "value": "", "type": "query", "description": "The page token representing the page from where the next set of paginated results\nare retrieved. This is usually retrieved from a previous list call.\n" } ] }, "docs": "Gets the number of SQL plan baselines aggregated by the age of their last execution in weeks.\n" }, { "info": { "name": "Lists the database jobs used for loading SQL plan baselines.", "type": "http" }, "http": { "method": "GET", "url": "http://dbmgmt.{region}.oci.oraclecloud.com/20201101/managedDatabases/:managedDatabaseId/sqlPlanBaselineJobs", "headers": [ { "name": "opc-request-id", "value": "" }, { "name": "opc-named-credential-id", "value": "" } ], "params": [ { "name": "managedDatabaseId", "value": "", "type": "path", "description": "The [OCID](/Content/General/Concepts/identifiers.htm) of the Managed Database." }, { "name": "name", "value": "", "type": "query", "description": "A filter to return the SQL plan baseline jobs that match the name." }, { "name": "page", "value": "", "type": "query", "description": "The page token representing the page from where the next set of paginated results\nare retrieved. This is usually retrieved from a previous list call.\n" }, { "name": "limit", "value": "", "type": "query", "description": "The maximum number of records returned in the paginated response." }, { "name": "sortBy", "value": "", "type": "query", "description": "The field to sort information by. Only one sortOrder can be used. The default sort order\nfor ‘TIMECREATED’ is descending and the default sort order for ‘NAME’ is ascending.\nThe ‘NAME’ sort order is case-sensitive.\n" }, { "name": "sortOrder", "value": "", "type": "query", "description": "The option to sort information in ascending (‘ASC’) or descending (‘DESC’) order. Ascending order is the default order." } ] }, "docs": "Lists the database jobs used for loading SQL plan baselines in the specified Managed Database.\n" }, { "info": { "name": "Get counts of SQL plan baselines aggregated by their attributes.", "type": "http" }, "http": { "method": "GET", "url": "http://dbmgmt.{region}.oci.oraclecloud.com/20201101/managedDatabases/:managedDatabaseId/sqlPlanBaselineStats", "headers": [ { "name": "opc-request-id", "value": "" }, { "name": "opc-named-credential-id", "value": "" } ], "params": [ { "name": "managedDatabaseId", "value": "", "type": "path", "description": "The [OCID](/Content/General/Concepts/identifiers.htm) of the Managed Database." }, { "name": "page", "value": "", "type": "query", "description": "The page token representing the page from where the next set of paginated results\nare retrieved. This is usually retrieved from a previous list call.\n" } ] }, "docs": "Gets the number of SQL plan baselines aggregated by their attributes.\n" }, { "info": { "name": "Lists the SQL plan baselines.", "type": "http" }, "http": { "method": "GET", "url": "http://dbmgmt.{region}.oci.oraclecloud.com/20201101/managedDatabases/:managedDatabaseId/sqlPlanBaselines", "headers": [ { "name": "opc-request-id", "value": "" }, { "name": "opc-named-credential-id", "value": "" } ], "params": [ { "name": "managedDatabaseId", "value": "", "type": "path", "description": "The [OCID](/Content/General/Concepts/identifiers.htm) of the Managed Database." }, { "name": "planName", "value": "", "type": "query", "description": "A filter to return only SQL plan baselines that match the plan name." }, { "name": "sqlHandle", "value": "", "type": "query", "description": "A filter to return all the SQL plan baselines for the specified SQL handle." }, { "name": "sqlText", "value": "", "type": "query", "description": "A filter to return all the SQL plan baselines that match the SQL text. By default, the search\nis case insensitive. To run an exact or case-sensitive search, double-quote the search string.\nYou may also use the '%' symbol as a wildcard.\n" }, { "name": "isEnabled", "value": "", "type": "query", "description": "A filter to return only SQL plan baselines that are either enabled or not enabled.\nBy default, all SQL plan baselines are returned.\n" }, { "name": "isAccepted", "value": "", "type": "query", "description": "A filter to return only SQL plan baselines that are either accepted or not accepted.\nBy default, all SQL plan baselines are returned.\n" }, { "name": "isReproduced", "value": "", "type": "query", "description": "A filter to return only SQL plan baselines that were either reproduced or\nnot reproduced by the optimizer. By default, all SQL plan baselines are returned.\n" }, { "name": "isFixed", "value": "", "type": "query", "description": "A filter to return only SQL plan baselines that are either fixed or not fixed.\nBy default, all SQL plan baselines are returned.\n" }, { "name": "isAdaptive", "value": "", "type": "query", "description": "A filter to return only SQL plan baselines that are either adaptive or not adaptive.\nBy default, all SQL plan baselines are returned.\n" }, { "name": "origin", "value": "", "type": "query", "description": "A filter to return all the SQL plan baselines that match the origin." }, { "name": "page", "value": "", "type": "query", "description": "The page token representing the page from where the next set of paginated results\nare retrieved. This is usually retrieved from a previous list call.\n" }, { "name": "limit", "value": "", "type": "query", "description": "The maximum number of records returned in the paginated response." }, { "name": "sortBy", "value": "", "type": "query", "description": "The option to sort the SQL plan baseline summary data." }, { "name": "sortOrder", "value": "", "type": "query", "description": "The option to sort information in ascending (‘ASC’) or descending (‘DESC’) order. Descending order is the default order." }, { "name": "isAutoPurged", "value": "", "type": "query", "description": "A filter to return only SQL plan baselines that are either auto-purged or not auto-purged.\nBy default, all SQL plan baselines are returned.\n" }, { "name": "timeLastExecutedGreaterThan", "value": "", "type": "query", "description": "A filter to return only SQL plan baselines whose last execution time is\nafter the specified value. By default, all SQL plan baselines are returned.\n" }, { "name": "timeLastExecutedLessThan", "value": "", "type": "query", "description": "A filter to return only SQL plan baselines whose last execution time is\nbefore the specified value. By default, all SQL plan baselines are returned.\n" }, { "name": "isNeverExecuted", "value": "", "type": "query", "description": "A filter to return only SQL plan baselines that are not executed till now.\nBy default, all SQL plan baselines are returned.\n" } ] }, "docs": "Lists the SQL plan baselines for the specified Managed Database.\n" }, { "info": { "name": "Changes the retention period of unused plans.", "type": "http" }, "http": { "method": "POST", "url": "http://dbmgmt.{region}.oci.oraclecloud.com/20201101/managedDatabases/:managedDatabaseId/sqlPlanBaselines/actions/changePlanRetention", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "managedDatabaseId", "value": "", "type": "path", "description": "The [OCID](/Content/General/Concepts/identifiers.htm) of the Managed Database." } ] }, "docs": "Changes the retention period of unused plans. The period can range\nbetween 5 and 523 weeks.\n\nThe database purges plans that have not been used for longer than\nthe plan retention period.\n" }, { "info": { "name": "Changes the disk space limit for the SQL Management Base.", "type": "http" }, "http": { "method": "POST", "url": "http://dbmgmt.{region}.oci.oraclecloud.com/20201101/managedDatabases/:managedDatabaseId/sqlPlanBaselines/actions/changeSpaceBudget", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "managedDatabaseId", "value": "", "type": "path", "description": "The [OCID](/Content/General/Concepts/identifiers.htm) of the Managed Database." } ] }, "docs": "Changes the disk space limit for the SQL Management Base. The allowable\nrange for this limit is between 1% and 50%.\n" }, { "info": { "name": "Changes one or more attributes of a single plan or all plans associated with a SQL statement.", "type": "http" }, "http": { "method": "POST", "url": "http://dbmgmt.{region}.oci.oraclecloud.com/20201101/managedDatabases/:managedDatabaseId/sqlPlanBaselines/actions/changeSqlPlanBaselinesAttributes", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "managedDatabaseId", "value": "", "type": "path", "description": "The [OCID](/Content/General/Concepts/identifiers.htm) of the Managed Database." } ] }, "docs": "Changes one or more attributes of a single plan or all plans associated with a SQL statement.\n" }, { "info": { "name": "Configures automatic capture filters.", "type": "http" }, "http": { "method": "POST", "url": "http://dbmgmt.{region}.oci.oraclecloud.com/20201101/managedDatabases/:managedDatabaseId/sqlPlanBaselines/actions/configureAutomaticCaptureFilters", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "managedDatabaseId", "value": "", "type": "path", "description": "The [OCID](/Content/General/Concepts/identifiers.htm) of the Managed Database." } ] }, "docs": "Configures automatic capture filters to capture only those statements\nthat match the filter criteria.\n" }, { "info": { "name": "Configures the Automatic SPM Evolve Advisor task.", "type": "http" }, "http": { "method": "POST", "url": "http://dbmgmt.{region}.oci.oraclecloud.com/20201101/managedDatabases/:managedDatabaseId/sqlPlanBaselines/actions/configureAutomaticSpmEvolveAdvisorTask", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "managedDatabaseId", "value": "", "type": "path", "description": "The [OCID](/Content/General/Concepts/identifiers.htm) of the Managed Database." } ] }, "docs": "Configures the Automatic SPM Evolve Advisor task `SYS_AUTO_SPM_EVOLVE_TASK`\nby specifying task parameters. As the task is owned by `SYS`, only `SYS` can\nset task parameters.\n" }, { "info": { "name": "Disables automatic initial plan capture.", "type": "http" }, "http": { "method": "POST", "url": "http://dbmgmt.{region}.oci.oraclecloud.com/20201101/managedDatabases/:managedDatabaseId/sqlPlanBaselines/actions/disableAutomaticInitialPlanCapture", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "managedDatabaseId", "value": "", "type": "path", "description": "The [OCID](/Content/General/Concepts/identifiers.htm) of the Managed Database." } ] }, "docs": "Disables automatic initial plan capture.\n" }, { "info": { "name": "Disables the Automatic SPM Evolve Advisor task.", "type": "http" }, "http": { "method": "POST", "url": "http://dbmgmt.{region}.oci.oraclecloud.com/20201101/managedDatabases/:managedDatabaseId/sqlPlanBaselines/actions/disableAutomaticSpmEvolveAdvisorTask", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "managedDatabaseId", "value": "", "type": "path", "description": "The [OCID](/Content/General/Concepts/identifiers.htm) of the Managed Database." } ] }, "docs": "Disables the Automatic SPM Evolve Advisor task.\n\nOne client controls both Automatic SQL Tuning Advisor and Automatic SPM Evolve Advisor.\nThus, the same task enables or disables both.\n" }, { "info": { "name": "Disables the high-frequency Automatic SPM Evolve Advisor task.", "type": "http" }, "http": { "method": "POST", "url": "http://dbmgmt.{region}.oci.oraclecloud.com/20201101/managedDatabases/:managedDatabaseId/sqlPlanBaselines/actions/disableHighFrequencyAutomaticSpmEvolveAdvisorTask", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "managedDatabaseId", "value": "", "type": "path", "description": "The [OCID](/Content/General/Concepts/identifiers.htm) of the Managed Database." } ] }, "docs": "Disables the high-frequency Automatic SPM Evolve Advisor task.\n\nIt is available only on Oracle Exadata Database Machine, Oracle Database Exadata\nCloud Service (ExaCS) and Oracle Database Exadata Cloud@Customer (ExaCC).\n" }, { "info": { "name": "Disables the use of SQL plan baselines stored in SQL Management Base.", "type": "http" }, "http": { "method": "POST", "url": "http://dbmgmt.{region}.oci.oraclecloud.com/20201101/managedDatabases/:managedDatabaseId/sqlPlanBaselines/actions/disableSqlPlanBaselinesUsage", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "managedDatabaseId", "value": "", "type": "path", "description": "The [OCID](/Content/General/Concepts/identifiers.htm) of the Managed Database." } ] }, "docs": "Disables the use of SQL plan baselines stored in SQL Management Base.\n\nWhen disabled, the optimizer does not use any SQL plan baselines.\n" }, { "info": { "name": "Drops a single plan or all plans associated with a SQL statement.", "type": "http" }, "http": { "method": "POST", "url": "http://dbmgmt.{region}.oci.oraclecloud.com/20201101/managedDatabases/:managedDatabaseId/sqlPlanBaselines/actions/dropSqlPlanBaselines", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "managedDatabaseId", "value": "", "type": "path", "description": "The [OCID](/Content/General/Concepts/identifiers.htm) of the Managed Database." } ] }, "docs": "Drops a single plan or all plans associated with a SQL statement.\n" }, { "info": { "name": "Enables automatic initial plan capture.", "type": "http" }, "http": { "method": "POST", "url": "http://dbmgmt.{region}.oci.oraclecloud.com/20201101/managedDatabases/:managedDatabaseId/sqlPlanBaselines/actions/enableAutomaticInitialPlanCapture", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "managedDatabaseId", "value": "", "type": "path", "description": "The [OCID](/Content/General/Concepts/identifiers.htm) of the Managed Database." } ] }, "docs": "Enables automatic initial plan capture. When enabled, the database checks whether\nexecuted SQL statements are eligible for automatic capture. It creates initial\nplan baselines for eligible statements.\n\nBy default, the database creates a SQL plan baseline for every eligible repeatable\nstatement, including all recursive SQL and monitoring SQL. Thus, automatic capture\nmay result in the creation of an extremely large number of plan baselines. To limit\nthe statements that are eligible for plan baseli" }, { "info": { "name": "Enables the Automatic SPM Evolve Advisor task.", "type": "http" }, "http": { "method": "POST", "url": "http://dbmgmt.{region}.oci.oraclecloud.com/20201101/managedDatabases/:managedDatabaseId/sqlPlanBaselines/actions/enableAutomaticSpmEvolveAdvisorTask", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "managedDatabaseId", "value": "", "type": "path", "description": "The [OCID](/Content/General/Concepts/identifiers.htm) of the Managed Database." } ] }, "docs": "Enables the Automatic SPM Evolve Advisor task. By default, the automatic task\n`SYS_AUTO_SPM_EVOLVE_TASK` runs every day in the scheduled maintenance window.\n\nThe SPM Evolve Advisor performs the following tasks:\n\n- Checks AWR for top SQL\n- Looks for alternative plans in all available sources\n- Adds unaccepted plans to the plan history\n- Tests the execution of as many plans as possible during the maintenance window\n- Adds the alternative plan to the baseline if it performs better than the current " }, { "info": { "name": "Enables the high-frequency Automatic SPM Evolve Advisor task.", "type": "http" }, "http": { "method": "POST", "url": "http://dbmgmt.{region}.oci.oraclecloud.com/20201101/managedDatabases/:managedDatabaseId/sqlPlanBaselines/actions/enableHighFrequencyAutomaticSpmEvolveAdvisorTask", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "managedDatabaseId", "value": "", "type": "path", "description": "The [OCID](/Content/General/Concepts/identifiers.htm) of the Managed Database." } ] }, "docs": "Enables the high-frequency Automatic SPM Evolve Advisor task. The high-frequency\ntask runs every hour and runs for no longer than 30 minutes. These settings\nare not configurable.\n\nThe high-frequency task complements the standard Automatic SPM Evolve Advisor task.\nThey are independent and are scheduled through two different frameworks.\n\nIt is available only on Oracle Exadata Database Machine, Oracle Database Exadata\nCloud Service (ExaCS) and Oracle Database Exadata Cloud@Customer (ExaCC).\n" }, { "info": { "name": "Enables the use of SQL plan baselines stored in SQL Management Base.", "type": "http" }, "http": { "method": "POST", "url": "http://dbmgmt.{region}.oci.oraclecloud.com/20201101/managedDatabases/:managedDatabaseId/sqlPlanBaselines/actions/enableSqlPlanBaselinesUsage", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "managedDatabaseId", "value": "", "type": "path", "description": "The [OCID](/Content/General/Concepts/identifiers.htm) of the Managed Database." } ] }, "docs": "Enables the use of SQL plan baselines stored in SQL Management Base.\n\nWhen enabled, the optimizer uses SQL plan baselines to select plans\nto avoid potential performance regressions.\n" }, { "info": { "name": "Loads plans from Automatic Workload Repository (AWR) snapshots.", "type": "http" }, "http": { "method": "POST", "url": "http://dbmgmt.{region}.oci.oraclecloud.com/20201101/managedDatabases/:managedDatabaseId/sqlPlanBaselines/actions/loadSqlPlanBaselinesFromAwr", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "managedDatabaseId", "value": "", "type": "path", "description": "The [OCID](/Content/General/Concepts/identifiers.htm) of the Managed Database." } ] }, "docs": "Loads plans from Automatic Workload Repository (AWR) snapshots. You must\nspecify the beginning and ending of the snapshot range. Optionally, you\ncan apply a filter to load only plans that meet specified criteria. By\ndefault, the optimizer uses the loaded plans the next time that the database\nexecutes the SQL statements.\n" }, { "info": { "name": "Loads plans for statements directly from the shared SQL area, also called the cursor cache.", "type": "http" }, "http": { "method": "POST", "url": "http://dbmgmt.{region}.oci.oraclecloud.com/20201101/managedDatabases/:managedDatabaseId/sqlPlanBaselines/actions/loadSqlPlanBaselinesFromCursorCache", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "managedDatabaseId", "value": "", "type": "path", "description": "The [OCID](/Content/General/Concepts/identifiers.htm) of the Managed Database." } ] }, "docs": "Loads plans for statements directly from the shared SQL area, also called\nthe cursor cache. By applying a filter on the module name, the schema, or\nthe SQL ID you identify the SQL statement or set of SQL statements to load.\n" }, { "info": { "name": "Gets SQL plan baseline details.", "type": "http" }, "http": { "method": "GET", "url": "http://dbmgmt.{region}.oci.oraclecloud.com/20201101/managedDatabases/:managedDatabaseId/sqlPlanBaselines/:planName", "headers": [ { "name": "opc-request-id", "value": "" }, { "name": "opc-named-credential-id", "value": "" } ], "params": [ { "name": "managedDatabaseId", "value": "", "type": "path", "description": "The [OCID](/Content/General/Concepts/identifiers.htm) of the Managed Database." }, { "name": "planName", "value": "", "type": "path", "description": "The plan name of the SQL plan baseline." } ] }, "docs": "Gets the SQL plan baseline details for the specified planName.\n" }, { "info": { "name": "Gets the number of table statistics categorized by statistics status.", "type": "http" }, "http": { "method": "GET", "url": "http://dbmgmt.{region}.oci.oraclecloud.com/20201101/managedDatabases/:managedDatabaseId/tableStatistics", "headers": [ { "name": "opc-request-id", "value": "" }, { "name": "opc-named-credential-id", "value": "" } ], "params": [ { "name": "managedDatabaseId", "value": "", "type": "path", "description": "The [OCID](/Content/General/Concepts/identifiers.htm) of the Managed Database." } ] }, "docs": "Lists the database table statistics grouped by different statuses such as Not Stale Stats, Stale Stats, and No Stats.\nThis also includes the percentage of each status.\n" }, { "info": { "name": "Gets a list of tablespaces for a Managed Database.", "type": "http" }, "http": { "method": "GET", "url": "http://dbmgmt.{region}.oci.oraclecloud.com/20201101/managedDatabases/:managedDatabaseId/tablespaces", "headers": [ { "name": "opc-request-id", "value": "" }, { "name": "opc-named-credential-id", "value": "" } ], "params": [ { "name": "managedDatabaseId", "value": "", "type": "path", "description": "The [OCID](/Content/General/Concepts/identifiers.htm) of the Managed Database." }, { "name": "name", "value": "", "type": "query", "description": "A filter to return only resources that match the entire name." }, { "name": "sortBy", "value": "", "type": "query", "description": "The field to sort information by. Only one sortOrder can be used. The default sort order\nfor ‘TIMECREATED’ is descending and the default sort order for ‘NAME’ is ascending.\nThe ‘NAME’ sort order is case-sensitive.\n" }, { "name": "sortOrder", "value": "", "type": "query", "description": "The option to sort information in ascending (‘ASC’) or descending (‘DESC’) order. Ascending order is the default order." }, { "name": "page", "value": "", "type": "query", "description": "The page token representing the page from where the next set of paginated results\nare retrieved. This is usually retrieved from a previous list call.\n" }, { "name": "limit", "value": "", "type": "query", "description": "The maximum number of records returned in the paginated response." } ] }, "docs": "Gets the list of tablespaces for the specified managedDatabaseId." }, { "info": { "name": "Creates a tablespace.", "type": "http" }, "http": { "method": "POST", "url": "http://dbmgmt.{region}.oci.oraclecloud.com/20201101/managedDatabases/:managedDatabaseId/tablespaces", "headers": [ { "name": "opc-request-id", "value": "" }, { "name": "opc-retry-token", "value": "" } ], "params": [ { "name": "managedDatabaseId", "value": "", "type": "path", "description": "The [OCID](/Content/General/Concepts/identifiers.htm) of the Managed Database." } ] }, "docs": "Creates a tablespace within the Managed Database specified by managedDatabaseId.\n" }, { "info": { "name": "Gets the details of the tablespace.", "type": "http" }, "http": { "method": "GET", "url": "http://dbmgmt.{region}.oci.oraclecloud.com/20201101/managedDatabases/:managedDatabaseId/tablespaces/:tablespaceName", "headers": [ { "name": "opc-request-id", "value": "" }, { "name": "opc-named-credential-id", "value": "" } ], "params": [ { "name": "managedDatabaseId", "value": "", "type": "path", "description": "The [OCID](/Content/General/Concepts/identifiers.htm) of the Managed Database." }, { "name": "tablespaceName", "value": "", "type": "path", "description": "The name of the tablespace." } ] }, "docs": "Gets the details of the tablespace specified by tablespaceName within the Managed Database specified by managedDatabaseId.\n" }, { "info": { "name": "Updates tablespace attributes.", "type": "http" }, "http": { "method": "PUT", "url": "http://dbmgmt.{region}.oci.oraclecloud.com/20201101/managedDatabases/:managedDatabaseId/tablespaces/:tablespaceName", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "managedDatabaseId", "value": "", "type": "path", "description": "The [OCID](/Content/General/Concepts/identifiers.htm) of the Managed Database." }, { "name": "tablespaceName", "value": "", "type": "path", "description": "The name of the tablespace." } ] }, "docs": "Updates the attributes of the tablespace specified by tablespaceName within the Managed Database specified by managedDatabaseId.\n" }, { "info": { "name": "Adds data files or temp files to the tablespace.", "type": "http" }, "http": { "method": "POST", "url": "http://dbmgmt.{region}.oci.oraclecloud.com/20201101/managedDatabases/:managedDatabaseId/tablespaces/:tablespaceName/actions/addDataFiles", "headers": [ { "name": "opc-request-id", "value": "" }, { "name": "opc-retry-token", "value": "" } ], "params": [ { "name": "managedDatabaseId", "value": "", "type": "path", "description": "The [OCID](/Content/General/Concepts/identifiers.htm) of the Managed Database." }, { "name": "tablespaceName", "value": "", "type": "path", "description": "The name of the tablespace." } ] }, "docs": "Adds data files or temp files to the tablespace.\n" }, { "info": { "name": "Drops the tablespace.", "type": "http" }, "http": { "method": "POST", "url": "http://dbmgmt.{region}.oci.oraclecloud.com/20201101/managedDatabases/:managedDatabaseId/tablespaces/:tablespaceName/actions/dropTablespace", "headers": [ { "name": "opc-request-id", "value": "" }, { "name": "opc-retry-token", "value": "" } ], "params": [ { "name": "managedDatabaseId", "value": "", "type": "path", "description": "The [OCID](/Content/General/Concepts/identifiers.htm) of the Managed Database." }, { "name": "tablespaceName", "value": "", "type": "path", "description": "The name of the tablespace." } ] }, "docs": "Drops the tablespace specified by tablespaceName within the Managed Database specified by managedDatabaseId.\n" }, { "info": { "name": "Removes a data file or temp file from the tablespace.", "type": "http" }, "http": { "method": "POST", "url": "http://dbmgmt.{region}.oci.oraclecloud.com/20201101/managedDatabases/:managedDatabaseId/tablespaces/:tablespaceName/actions/removeDataFile", "headers": [ { "name": "opc-request-id", "value": "" }, { "name": "opc-retry-token", "value": "" } ], "params": [ { "name": "managedDatabaseId", "value": "", "type": "path", "description": "The [OCID](/Content/General/Concepts/identifiers.htm) of the Managed Database." }, { "name": "tablespaceName", "value": "", "type": "path", "description": "The name of the tablespace." } ] }, "docs": "Removes a data file or temp file from the tablespace.\n" }, { "info": { "name": "Resizes a data file or temp file within the tablespace.", "type": "http" }, "http": { "method": "POST", "url": "http://dbmgmt.{region}.oci.oraclecloud.com/20201101/managedDatabases/:managedDatabaseId/tablespaces/:tablespaceName/actions/resizeDataFile", "headers": [ { "name": "opc-request-id", "value": "" }, { "name": "opc-retry-token", "value": "" } ], "params": [ { "name": "managedDatabaseId", "value": "", "type": "path", "description": "The [OCID](/Content/General/Concepts/identifiers.htm) of the Managed Database." }, { "name": "tablespaceName", "value": "", "type": "path", "description": "The name of the tablespace." } ] }, "docs": "Resizes a data file or temp file within the tablespace.\n" }, { "info": { "name": "Gets a list of users for a Managed Database.", "type": "http" }, "http": { "method": "GET", "url": "http://dbmgmt.{region}.oci.oraclecloud.com/20201101/managedDatabases/:managedDatabaseId/users", "headers": [ { "name": "opc-request-id", "value": "" }, { "name": "opc-named-credential-id", "value": "" } ], "params": [ { "name": "managedDatabaseId", "value": "", "type": "path", "description": "The [OCID](/Content/General/Concepts/identifiers.htm) of the Managed Database." }, { "name": "name", "value": "", "type": "query", "description": "A filter to return only resources that match the entire name." }, { "name": "sortBy", "value": "", "type": "query", "description": "The field to sort information by. Only one sortOrder can be used. The default sort order\nfor ‘TIMECREATED’ is descending and the default sort order for ‘NAME’ is ascending.\nThe ‘NAME’ sort order is case-sensitive.\n" }, { "name": "sortOrder", "value": "", "type": "query", "description": "The option to sort information in ascending (‘ASC’) or descending (‘DESC’) order. Ascending order is the default order." }, { "name": "limit", "value": "", "type": "query", "description": "The maximum number of records returned in the paginated response." }, { "name": "page", "value": "", "type": "query", "description": "The page token representing the page from where the next set of paginated results\nare retrieved. This is usually retrieved from a previous list call.\n" } ] }, "docs": "Gets the list of users for the specified managedDatabaseId." }, { "info": { "name": "Gets the details of a specific user.", "type": "http" }, "http": { "method": "GET", "url": "http://dbmgmt.{region}.oci.oraclecloud.com/20201101/managedDatabases/:managedDatabaseId/users/:userName", "headers": [ { "name": "opc-request-id", "value": "" }, { "name": "opc-named-credential-id", "value": "" } ], "params": [ { "name": "managedDatabaseId", "value": "", "type": "path", "description": "The [OCID](/Content/General/Concepts/identifiers.htm) of the Managed Database." }, { "name": "userName", "value": "", "type": "path", "description": "The name of the user whose details are to be viewed." } ] }, "docs": "Gets the details of the user specified by managedDatabaseId and userName.\n" }, { "info": { "name": "Gets a list of Consumer Group Privileges granted to a user.", "type": "http" }, "http": { "method": "GET", "url": "http://dbmgmt.{region}.oci.oraclecloud.com/20201101/managedDatabases/:managedDatabaseId/users/:userName/consumerGroupPrivileges", "headers": [ { "name": "opc-request-id", "value": "" }, { "name": "opc-named-credential-id", "value": "" } ], "params": [ { "name": "managedDatabaseId", "value": "", "type": "path", "description": "The [OCID](/Content/General/Concepts/identifiers.htm) of the Managed Database." }, { "name": "userName", "value": "", "type": "path", "description": "The name of the user whose details are to be viewed." }, { "name": "name", "value": "", "type": "query", "description": "A filter to return only resources that match the entire name." }, { "name": "sortBy", "value": "", "type": "query", "description": "The field to sort information by. Only one sortOrder can be used. The default sort order\nfor ‘NAME’ is ascending. The ‘NAME’ sort order is case-sensitive.\n" }, { "name": "sortOrder", "value": "", "type": "query", "description": "The option to sort information in ascending (‘ASC’) or descending (‘DESC’) order. Ascending order is the default order." }, { "name": "limit", "value": "", "type": "query", "description": "The maximum number of records returned in the paginated response." }, { "name": "page", "value": "", "type": "query", "description": "The page token representing the page from where the next set of paginated results\nare retrieved. This is usually retrieved from a previous list call.\n" } ] }, "docs": "Gets the list of consumer group privileges granted to a specific user." }, { "info": { "name": "Gets a list of Containers.", "type": "http" }, "http": { "method": "GET", "url": "http://dbmgmt.{region}.oci.oraclecloud.com/20201101/managedDatabases/:managedDatabaseId/users/:userName/dataAccessContainers", "headers": [ { "name": "opc-request-id", "value": "" }, { "name": "opc-named-credential-id", "value": "" } ], "params": [ { "name": "managedDatabaseId", "value": "", "type": "path", "description": "The [OCID](/Content/General/Concepts/identifiers.htm) of the Managed Database." }, { "name": "userName", "value": "", "type": "path", "description": "The name of the user whose details are to be viewed." }, { "name": "name", "value": "", "type": "query", "description": "A filter to return only resources that match the entire name." }, { "name": "sortBy", "value": "", "type": "query", "description": "The field to sort information by. Only one sortOrder can be used. The default sort order\nfor ‘NAME’ is ascending. The ‘NAME’ sort order is case-sensitive.\n" }, { "name": "sortOrder", "value": "", "type": "query", "description": "The option to sort information in ascending (‘ASC’) or descending (‘DESC’) order. Ascending order is the default order." }, { "name": "limit", "value": "", "type": "query", "description": "The maximum number of records returned in the paginated response." }, { "name": "page", "value": "", "type": "query", "description": "The page token representing the page from where the next set of paginated results\nare retrieved. This is usually retrieved from a previous list call.\n" } ] }, "docs": "Gets the list of containers for a specific user. This is only applicable if ALL_CONTAINERS !='Y'." }, { "info": { "name": "Gets a list of Object Privileges granted a user.", "type": "http" }, "http": { "method": "GET", "url": "http://dbmgmt.{region}.oci.oraclecloud.com/20201101/managedDatabases/:managedDatabaseId/users/:userName/objectPrivileges", "headers": [ { "name": "opc-request-id", "value": "" }, { "name": "opc-named-credential-id", "value": "" } ], "params": [ { "name": "managedDatabaseId", "value": "", "type": "path", "description": "The [OCID](/Content/General/Concepts/identifiers.htm) of the Managed Database." }, { "name": "userName", "value": "", "type": "path", "description": "The name of the user whose details are to be viewed." }, { "name": "name", "value": "", "type": "query", "description": "A filter to return only resources that match the entire name." }, { "name": "sortBy", "value": "", "type": "query", "description": "The field to sort information by. Only one sortOrder can be used. The default sort order\nfor ‘NAME’ is ascending. The ‘NAME’ sort order is case-sensitive.\n" }, { "name": "sortOrder", "value": "", "type": "query", "description": "The option to sort information in ascending (‘ASC’) or descending (‘DESC’) order. Ascending order is the default order." }, { "name": "limit", "value": "", "type": "query", "description": "The maximum number of records returned in the paginated response." }, { "name": "page", "value": "", "type": "query", "description": "The page token representing the page from where the next set of paginated results\nare retrieved. This is usually retrieved from a previous list call.\n" } ] }, "docs": "Gets the list of object privileges granted to a specific user." }, { "info": { "name": "Gets a list of proxied users.", "type": "http" }, "http": { "method": "GET", "url": "http://dbmgmt.{region}.oci.oraclecloud.com/20201101/managedDatabases/:managedDatabaseId/users/:userName/proxiedForUsers", "headers": [ { "name": "opc-request-id", "value": "" }, { "name": "opc-named-credential-id", "value": "" } ], "params": [ { "name": "managedDatabaseId", "value": "", "type": "path", "description": "The [OCID](/Content/General/Concepts/identifiers.htm) of the Managed Database." }, { "name": "userName", "value": "", "type": "path", "description": "The name of the user whose details are to be viewed." }, { "name": "name", "value": "", "type": "query", "description": "A filter to return only resources that match the entire name." }, { "name": "sortBy", "value": "", "type": "query", "description": "The field to sort information by. Only one sortOrder can be used. The default sort order\nfor ‘NAME’ is ascending. The ‘NAME’ sort order is case-sensitive.\n" }, { "name": "sortOrder", "value": "", "type": "query", "description": "The option to sort information in ascending (‘ASC’) or descending (‘DESC’) order. Ascending order is the default order." }, { "name": "limit", "value": "", "type": "query", "description": "The maximum number of records returned in the paginated response." }, { "name": "page", "value": "", "type": "query", "description": "The page token representing the page from where the next set of paginated results\nare retrieved. This is usually retrieved from a previous list call.\n" } ] }, "docs": "Gets the list of users on whose behalf the current user acts as proxy." }, { "info": { "name": "Gets a list of proxy Users.", "type": "http" }, "http": { "method": "GET", "url": "http://dbmgmt.{region}.oci.oraclecloud.com/20201101/managedDatabases/:managedDatabaseId/users/:userName/proxyUsers", "headers": [ { "name": "opc-request-id", "value": "" }, { "name": "opc-named-credential-id", "value": "" } ], "params": [ { "name": "managedDatabaseId", "value": "", "type": "path", "description": "The [OCID](/Content/General/Concepts/identifiers.htm) of the Managed Database." }, { "name": "userName", "value": "", "type": "path", "description": "The name of the user whose details are to be viewed." }, { "name": "name", "value": "", "type": "query", "description": "A filter to return only resources that match the entire name." }, { "name": "sortBy", "value": "", "type": "query", "description": "The field to sort information by. Only one sortOrder can be used. The default sort order\nfor ‘NAME’ is ascending. The ‘NAME’ sort order is case-sensitive.\n" }, { "name": "sortOrder", "value": "", "type": "query", "description": "The option to sort information in ascending (‘ASC’) or descending (‘DESC’) order. Ascending order is the default order." }, { "name": "limit", "value": "", "type": "query", "description": "The maximum number of records returned in the paginated response." }, { "name": "page", "value": "", "type": "query", "description": "The page token representing the page from where the next set of paginated results\nare retrieved. This is usually retrieved from a previous list call.\n" } ] }, "docs": "Gets the list of proxy users for the current user." }, { "info": { "name": "Gets a list of roles granted to a user.", "type": "http" }, "http": { "method": "GET", "url": "http://dbmgmt.{region}.oci.oraclecloud.com/20201101/managedDatabases/:managedDatabaseId/users/:userName/roles", "headers": [ { "name": "opc-request-id", "value": "" }, { "name": "opc-named-credential-id", "value": "" } ], "params": [ { "name": "managedDatabaseId", "value": "", "type": "path", "description": "The [OCID](/Content/General/Concepts/identifiers.htm) of the Managed Database." }, { "name": "userName", "value": "", "type": "path", "description": "The name of the user whose details are to be viewed." }, { "name": "name", "value": "", "type": "query", "description": "A filter to return only resources that match the entire name." }, { "name": "sortBy", "value": "", "type": "query", "description": "The field to sort information by. Only one sortOrder can be used. The default sort order\nfor ‘NAME’ is ascending. The ‘NAME’ sort order is case-sensitive.\n" }, { "name": "sortOrder", "value": "", "type": "query", "description": "The option to sort information in ascending (‘ASC’) or descending (‘DESC’) order. Ascending order is the default order." }, { "name": "limit", "value": "", "type": "query", "description": "The maximum number of records returned in the paginated response." }, { "name": "page", "value": "", "type": "query", "description": "The page token representing the page from where the next set of paginated results\nare retrieved. This is usually retrieved from a previous list call.\n" } ] }, "docs": "Gets the list of roles granted to a specific user." }, { "info": { "name": "Gets a list of System Privileges granted to a user.", "type": "http" }, "http": { "method": "GET", "url": "http://dbmgmt.{region}.oci.oraclecloud.com/20201101/managedDatabases/:managedDatabaseId/users/:userName/systemPrivileges", "headers": [ { "name": "opc-request-id", "value": "" }, { "name": "opc-named-credential-id", "value": "" } ], "params": [ { "name": "managedDatabaseId", "value": "", "type": "path", "description": "The [OCID](/Content/General/Concepts/identifiers.htm) of the Managed Database." }, { "name": "userName", "value": "", "type": "path", "description": "The name of the user whose details are to be viewed." }, { "name": "name", "value": "", "type": "query", "description": "A filter to return only resources that match the entire name." }, { "name": "sortBy", "value": "", "type": "query", "description": "The field to sort information by. Only one sortOrder can be used. The default sort order\nfor ‘NAME’ is ascending. The ‘NAME’ sort order is case-sensitive.\n" }, { "name": "sortOrder", "value": "", "type": "query", "description": "The option to sort information in ascending (‘ASC’) or descending (‘DESC’) order. Ascending order is the default order." }, { "name": "limit", "value": "", "type": "query", "description": "The maximum number of records returned in the paginated response." }, { "name": "page", "value": "", "type": "query", "description": "The page token representing the page from where the next set of paginated results\nare retrieved. This is usually retrieved from a previous list call.\n" } ] }, "docs": "Gets the list of system privileges granted to a specific user." }, { "info": { "name": "Lists Named Credential.\n", "type": "http" }, "http": { "method": "GET", "url": "http://dbmgmt.{region}.oci.oraclecloud.com/20201101/namedCredentials", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "compartmentId", "value": "", "type": "query", "description": "The [OCID](/Content/General/Concepts/identifiers.htm) of the compartment." }, { "name": "associatedResource", "value": "", "type": "query", "description": "The resource associated to the named credential." }, { "name": "type", "value": "", "type": "query", "description": "The type of database that is associated to the named credential." }, { "name": "scope", "value": "", "type": "query", "description": "The scope of named credential." }, { "name": "name", "value": "", "type": "query", "description": "The name of the named credential." }, { "name": "page", "value": "", "type": "query", "description": "The page token representing the page from where the next set of paginated results\nare retrieved. This is usually retrieved from a previous list call.\n" }, { "name": "limit", "value": "", "type": "query", "description": "The maximum number of records returned in the paginated response." }, { "name": "sortBy", "value": "", "type": "query", "description": "The field to sort information by. Only one sortOrder can be used. The default sort order\nfor ‘TIMECREATED’ is descending and the default sort order for ‘NAME’ is ascending.\nThe ‘NAME’ sort order is case-sensitive.\n" }, { "name": "sortOrder", "value": "", "type": "query", "description": "The option to sort information in ascending (‘ASC’) or descending (‘DESC’) order. Ascending order is the default order." } ] }, "docs": "Gets a single named credential specified by the name or all the named credentials in a specific compartment.\n" }, { "info": { "name": "Creates a Named Credential.", "type": "http" }, "http": { "method": "POST", "url": "http://dbmgmt.{region}.oci.oraclecloud.com/20201101/namedCredentials", "headers": [ { "name": "opc-request-id", "value": "" }, { "name": "opc-retry-token", "value": "" } ] }, "docs": "Creates a named credential.\n" }, { "info": { "name": "Gets Named Credential details.", "type": "http" }, "http": { "method": "GET", "url": "http://dbmgmt.{region}.oci.oraclecloud.com/20201101/namedCredentials/:namedCredentialId", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "namedCredentialId", "value": "", "type": "path", "description": "The [OCID](/Content/General/Concepts/identifiers.htm) of the named credential." } ] }, "docs": "Gets the details for the named credential specified by namedCredentialId.\n" }, { "info": { "name": "Updates a Named Credential.", "type": "http" }, "http": { "method": "PUT", "url": "http://dbmgmt.{region}.oci.oraclecloud.com/20201101/namedCredentials/:namedCredentialId", "headers": [ { "name": "if-match", "value": "" }, { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "namedCredentialId", "value": "", "type": "path", "description": "The [OCID](/Content/General/Concepts/identifiers.htm) of the named credential." } ] }, "docs": "Updates the named credential specified by namedCredentialId.\n" }, { "info": { "name": "Deletes a Named Credential.", "type": "http" }, "http": { "method": "DELETE", "url": "http://dbmgmt.{region}.oci.oraclecloud.com/20201101/namedCredentials/:namedCredentialId", "headers": [ { "name": "if-match", "value": "" }, { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "namedCredentialId", "value": "", "type": "path", "description": "The [OCID](/Content/General/Concepts/identifiers.htm) of the named credential." } ] }, "docs": "Deletes the named credential specified by namedCredentialId.\n" }, { "info": { "name": "Moves a Named Credential.", "type": "http" }, "http": { "method": "POST", "url": "http://dbmgmt.{region}.oci.oraclecloud.com/20201101/namedCredentials/:namedCredentialId/actions/changeCompartment", "headers": [ { "name": "opc-request-id", "value": "" }, { "name": "opc-retry-token", "value": "" }, { "name": "if-match", "value": "" } ], "params": [ { "name": "namedCredentialId", "value": "", "type": "path", "description": "The [OCID](/Content/General/Concepts/identifiers.htm) of the named credential." } ] }, "docs": "Moves a named credential to a different compartment.\nThe destination compartment must not have a named credential\nwith the same name.\n" }, { "info": { "name": "Status of the test named credential.", "type": "http" }, "http": { "method": "POST", "url": "http://dbmgmt.{region}.oci.oraclecloud.com/20201101/namedCredentials/:namedCredentialId/actions/test", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "namedCredentialId", "value": "", "type": "path", "description": "The [OCID](/Content/General/Concepts/identifiers.htm) of the named credential." } ] }, "docs": "Tests the named credential.\n" }, { "info": { "name": "Disables Database Management feature for a database.", "type": "http" }, "http": { "method": "POST", "url": "http://dbmgmt.{region}.oci.oraclecloud.com/20201101/pluggabledatabases/:pluggableDatabaseId/actions/disableDatabaseManagement", "headers": [ { "name": "opc-request-id", "value": "" }, { "name": "opc-retry-token", "value": "" }, { "name": "if-match", "value": "" } ], "params": [ { "name": "pluggableDatabaseId", "value": "", "type": "path", "description": "The [OCID](/Content/General/Concepts/identifiers.htm) of the Oracle cloud pluggable database." } ] }, "docs": "Disables a Database Management feature for the specified Oracle cloud pluggable database.\n" }, { "info": { "name": "Enables Database Management feature for the cloud pluggable Database.", "type": "http" }, "http": { "method": "POST", "url": "http://dbmgmt.{region}.oci.oraclecloud.com/20201101/pluggabledatabases/:pluggableDatabaseId/actions/enableDatabaseManagement", "headers": [ { "name": "opc-request-id", "value": "" }, { "name": "opc-retry-token", "value": "" }, { "name": "if-match", "value": "" } ], "params": [ { "name": "pluggableDatabaseId", "value": "", "type": "path", "description": "The [OCID](/Content/General/Concepts/identifiers.htm) of the Oracle cloud pluggable database." } ] }, "docs": "Enables a Database Management feature for the specified Oracle cloud pluggable database.\n" }, { "info": { "name": "Modifies Database Management feature for the cloud pluggable Database.", "type": "http" }, "http": { "method": "POST", "url": "http://dbmgmt.{region}.oci.oraclecloud.com/20201101/pluggabledatabases/:pluggableDatabaseId/actions/modifyDatabaseManagement", "headers": [ { "name": "opc-request-id", "value": "" }, { "name": "opc-retry-token", "value": "" }, { "name": "if-match", "value": "" } ], "params": [ { "name": "pluggableDatabaseId", "value": "", "type": "path", "description": "The [OCID](/Content/General/Concepts/identifiers.htm) of the Oracle cloud pluggable database." } ] }, "docs": "Modifies the Database Management feature for the specified Oracle cloud pluggable database.\n" }, { "info": { "name": "List Work Requests", "type": "http" }, "http": { "method": "GET", "url": "http://dbmgmt.{region}.oci.oraclecloud.com/20201101/workRequests", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "compartmentId", "value": "", "type": "query", "description": "The [OCID](/Content/General/Concepts/identifiers.htm) of the compartment." }, { "name": "resourceId", "value": "", "type": "query", "description": "The [OCID](/Content/General/Concepts/identifiers.htm) of the resource affected by the work request." }, { "name": "workRequestId", "value": "", "type": "query", "description": "The [OCID](/Content/General/Concepts/identifiers.htm) of the asynchronous work request." }, { "name": "status", "value": "", "type": "query", "description": "A filter that returns the resources whose status matches the given WorkRequestStatus." }, { "name": "sortOrder", "value": "", "type": "query", "description": "The option to sort information in ascending (‘ASC’) or descending (‘DESC’) order. Ascending order is the default order." }, { "name": "sortBy", "value": "", "type": "query", "description": "The field to sort by. Only one sort order may be provided and the default order for timeAccepted is descending.\n" }, { "name": "page", "value": "", "type": "query", "description": "The page token representing the page from where the next set of paginated results\nare retrieved. This is usually retrieved from a previous list call.\n" }, { "name": "limit", "value": "", "type": "query", "description": "The maximum number of records returned in the paginated response." } ] }, "docs": "Lists the work requests in a specific compartment.\n" }, { "info": { "name": "Get Work Request Status", "type": "http" }, "http": { "method": "GET", "url": "http://dbmgmt.{region}.oci.oraclecloud.com/20201101/workRequests/:workRequestId", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "workRequestId", "value": "", "type": "path", "description": "The [OCID](/Content/General/Concepts/identifiers.htm) of the asynchronous work request." } ] }, "docs": "Gets the status of the work request with the given Work Request ID." }, { "info": { "name": "Lists work request errors", "type": "http" }, "http": { "method": "GET", "url": "http://dbmgmt.{region}.oci.oraclecloud.com/20201101/workRequests/:workRequestId/errors", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "workRequestId", "value": "", "type": "path", "description": "The [OCID](/Content/General/Concepts/identifiers.htm) of the asynchronous work request." }, { "name": "page", "value": "", "type": "query", "description": "The page token representing the page from where the next set of paginated results\nare retrieved. This is usually retrieved from a previous list call.\n" }, { "name": "limit", "value": "", "type": "query", "description": "The maximum number of records returned in the paginated response." }, { "name": "sortBy", "value": "", "type": "query", "description": "The field to sort by. Only one sort order may be provided and the default order for timeAccepted is descending.\n" }, { "name": "sortOrder", "value": "", "type": "query", "description": "The option to sort information in ascending (‘ASC’) or descending (‘DESC’) order. Ascending order is the default order." } ] }, "docs": "Returns a paginated list of errors for a given work request.\n" }, { "info": { "name": "Lists work request logs", "type": "http" }, "http": { "method": "GET", "url": "http://dbmgmt.{region}.oci.oraclecloud.com/20201101/workRequests/:workRequestId/logs", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "workRequestId", "value": "", "type": "path", "description": "The [OCID](/Content/General/Concepts/identifiers.htm) of the asynchronous work request." }, { "name": "page", "value": "", "type": "query", "description": "The page token representing the page from where the next set of paginated results\nare retrieved. This is usually retrieved from a previous list call.\n" }, { "name": "limit", "value": "", "type": "query", "description": "The maximum number of records returned in the paginated response." }, { "name": "sortBy", "value": "", "type": "query", "description": "The field to sort by. Only one sort order may be provided and the default order for timeAccepted is descending.\n" }, { "name": "sortOrder", "value": "", "type": "query", "description": "The option to sort information in ascending (‘ASC’) or descending (‘DESC’) order. Ascending order is the default order." } ] }, "docs": "Returns a paginated list of logs for a given work request.\n" } ] } ], "bundled": true }