{ "opencollection": "1.0.0", "info": { "name": "Database Management Sql Tuning API", "version": "20201101" }, "items": [ { "info": { "name": "sqlTuning", "type": "folder" }, "items": [ { "info": { "name": "Clone and run a SQL tuning task in the database", "type": "http" }, "http": { "method": "POST", "url": "http://dbmgmt.{region}.oci.oraclecloud.com/20201101/managedDatabases/:managedDatabaseId/actions/cloneSqlTuningTask", "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." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Clones and runs a SQL tuning task in the database.\n" }, { "info": { "name": "Drop a SQL tuning task from the database", "type": "http" }, "http": { "method": "POST", "url": "http://dbmgmt.{region}.oci.oraclecloud.com/20201101/managedDatabases/:managedDatabaseId/actions/dropSqlTuningTask", "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." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Drops a SQL tuning task and its related results from the database.\n" }, { "info": { "name": "Start a SQL tuning task in the database", "type": "http" }, "http": { "method": "POST", "url": "http://dbmgmt.{region}.oci.oraclecloud.com/20201101/managedDatabases/:managedDatabaseId/actions/startSqlTuningTask", "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." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Starts a SQL tuning task for a given set of SQL statements from the active session history top SQL statements.\n" }, { "info": { "name": "Lists the SQL Tuning Advisor tasks.", "type": "http" }, "http": { "method": "GET", "url": "http://dbmgmt.{region}.oci.oraclecloud.com/20201101/managedDatabases/:managedDatabaseId/sqlTuningAdvisorTasks", "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": "The optional query parameter to filter the SQL Tuning Advisor task list by name." }, { "name": "status", "value": "", "type": "query", "description": "The optional query parameter to filter the SQL Tuning Advisor task list by status." }, { "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 SQL Tuning Advisor task 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 the SQL Tuning Advisor tasks for the specified Managed Database.\n" }, { "info": { "name": "Retrieve a comparison of the existing SQL execution plan and new plan.", "type": "http" }, "http": { "method": "GET", "url": "http://dbmgmt.{region}.oci.oraclecloud.com/20201101/managedDatabases/:managedDatabaseId/sqlTuningAdvisorTasks/:sqlTuningAdvisorTaskId/executionPlanStatsComparision", "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": "sqlTuningAdvisorTaskId", "value": "", "type": "path", "description": "The SQL tuning task identifier. This is not the [OCID](/Content/General/Concepts/identifiers.htm)." }, { "name": "sqlObjectId", "value": "", "type": "query", "description": "The SQL object ID for the SQL tuning task. This is not the [OCID](/Content/General/Concepts/identifiers.htm)." }, { "name": "executionId", "value": "", "type": "query", "description": "The execution ID for an execution of a SQL tuning task. This is not the [OCID](/Content/General/Concepts/identifiers.htm).\n" } ] }, "docs": "Retrieves a comparison of the existing SQL execution plan and a new plan.\nA SQL tuning task may suggest a new execution plan for a SQL,\nand this API retrieves the comparison report of the statistics of the two plans.\n" }, { "info": { "name": "Gets an array of details for the findings that match the given filters.", "type": "http" }, "http": { "method": "GET", "url": "http://dbmgmt.{region}.oci.oraclecloud.com/20201101/managedDatabases/:managedDatabaseId/sqlTuningAdvisorTasks/:sqlTuningAdvisorTaskId/findings", "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": "sqlTuningAdvisorTaskId", "value": "", "type": "path", "description": "The SQL tuning task identifier. This is not the [OCID](/Content/General/Concepts/identifiers.htm)." }, { "name": "beginExecId", "value": "", "type": "query", "description": "The optional greater than or equal to filter on the execution ID related to a specific SQL Tuning Advisor task." }, { "name": "endExecId", "value": "", "type": "query", "description": "The optional less than or equal to query parameter to filter on the execution ID related to a specific SQL Tuning Advisor task." }, { "name": "searchPeriod", "value": "", "type": "query", "description": "The search period during which the API will search for begin and end exec id, if not supplied.\nUnused if beginExecId and endExecId optional query params are both supplied.\n" }, { "name": "findingFilter", "value": "", "type": "query", "description": "The filter used to display specific findings in the report." }, { "name": "statsHashFilter", "value": "", "type": "query", "description": "The hash value of the object for the statistic finding search." }, { "name": "indexHashFilter", "value": "", "type": "query", "description": "The hash value of the index table name." }, { "name": "sortBy", "value": "", "type": "query", "description": "The possible sortBy values of an object's recommendations." }, { "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": "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 an array of the details of the findings that match specific filters.\n" }, { "info": { "name": "Gets the findings and possible actions for a given object in a SQL tuning task.", "type": "http" }, "http": { "method": "GET", "url": "http://dbmgmt.{region}.oci.oraclecloud.com/20201101/managedDatabases/:managedDatabaseId/sqlTuningAdvisorTasks/:sqlTuningAdvisorTaskId/recommendations", "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": "sqlTuningAdvisorTaskId", "value": "", "type": "path", "description": "The SQL tuning task identifier. This is not the [OCID](/Content/General/Concepts/identifiers.htm)." }, { "name": "sqlObjectId", "value": "", "type": "query", "description": "The SQL object ID for the SQL tuning task. This is not the [OCID](/Content/General/Concepts/identifiers.htm)." }, { "name": "executionId", "value": "", "type": "query", "description": "The execution ID for an execution of a SQL tuning task. This is not the [OCID](/Content/General/Concepts/identifiers.htm).\n" }, { "name": "sortBy", "value": "", "type": "query", "description": "The possible sortBy values of an object's recommendations." }, { "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": "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 findings and possible actions for a given object in a SQL tuning task.\nThe task ID and object ID are used to retrieve the findings and recommendations.\n" }, { "info": { "name": "Retrieve a SQL execution plan for a SQL being tuned.", "type": "http" }, "http": { "method": "GET", "url": "http://dbmgmt.{region}.oci.oraclecloud.com/20201101/managedDatabases/:managedDatabaseId/sqlTuningAdvisorTasks/:sqlTuningAdvisorTaskId/sqlExecutionPlan", "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": "sqlTuningAdvisorTaskId", "value": "", "type": "path", "description": "The SQL tuning task identifier. This is not the [OCID](/Content/General/Concepts/identifiers.htm)." }, { "name": "sqlObjectId", "value": "", "type": "query", "description": "The SQL object ID for the SQL tuning task. This is not the [OCID](/Content/General/Concepts/identifiers.htm)." }, { "name": "attribute", "value": "", "type": "query", "description": "The attribute of the SQL execution plan." } ] }, "docs": "Retrieves a SQL execution plan for the SQL being tuned.\n" }, { "info": { "name": "Gets the SQL Tuning Advisor summary report.", "type": "http" }, "http": { "method": "GET", "url": "http://dbmgmt.{region}.oci.oraclecloud.com/20201101/managedDatabases/:managedDatabaseId/sqlTuningAdvisorTasks/:sqlTuningAdvisorTaskId/summaryReport", "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": "sqlTuningAdvisorTaskId", "value": "", "type": "path", "description": "The SQL tuning task identifier. This is not the [OCID](/Content/General/Concepts/identifiers.htm)." }, { "name": "searchPeriod", "value": "", "type": "query", "description": "How far back the API will search for begin and end exec id. Unused if neither exec ids nor time filter query params are supplied. This is applicable only for Auto SQL Tuning tasks." }, { "name": "timeGreaterThanOrEqualTo", "value": "", "type": "query", "description": "The optional greater than or equal to query parameter to filter the timestamp. This is applicable only for Auto SQL Tuning tasks." }, { "name": "timeLessThanOrEqualTo", "value": "", "type": "query", "description": "The optional less than or equal to query parameter to filter the timestamp. This is applicable only for Auto SQL Tuning tasks." }, { "name": "beginExecIdGreaterThanOrEqualTo", "value": "", "type": "query", "description": "The optional greater than or equal to filter on the execution ID related to a specific SQL Tuning Advisor task. This is applicable only for Auto SQL Tuning tasks." }, { "name": "endExecIdLessThanOrEqualTo", "value": "", "type": "query", "description": "The optional less than or equal to query parameter to filter on the execution ID related to a specific SQL Tuning Advisor task. This is applicable only for Auto SQL Tuning tasks." } ] }, "docs": "Gets the summary report for the specified SQL Tuning Advisor task.\n" }, { "info": { "name": "Lists the SQL Tuning Sets.", "type": "http" }, "http": { "method": "GET", "url": "http://dbmgmt.{region}.oci.oraclecloud.com/20201101/managedDatabases/:managedDatabaseId/sqlTuningSets", "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": "owner", "value": "", "type": "query", "description": "The owner of the SQL tuning set." }, { "name": "nameContains", "value": "", "type": "query", "description": "Allow searching the name of the SQL tuning set by partial matching. The search is case insensitive." }, { "name": "sortBy", "value": "", "type": "query", "description": "The option to sort the SQL tuning set 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." }, { "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 SQL tuning sets for the specified Managed Database.\n" }, { "info": { "name": "Creates an empty Sql tuning set.", "type": "http" }, "http": { "method": "POST", "url": "http://dbmgmt.{region}.oci.oraclecloud.com/20201101/managedDatabases/:managedDatabaseId/sqlTuningSets", "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 an empty Sql tuning set within the Managed Database specified by managedDatabaseId.\n" }, { "info": { "name": "Fetch the details of Sql statements in the Sql tuning set.", "type": "http" }, "http": { "method": "POST", "url": "http://dbmgmt.{region}.oci.oraclecloud.com/20201101/managedDatabases/:managedDatabaseId/sqlTuningSets/:sqlTuningSetId", "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": "sqlTuningSetId", "value": "", "type": "path", "description": "The unique identifier of the Sql tuning set. This is not OCID." } ] }, "docs": "Fetch the details of Sql statements in the Sql tuning set specified by name, owner and optional filter parameters.\n" }, { "info": { "name": "Drops the Sql tuning set.", "type": "http" }, "http": { "method": "POST", "url": "http://dbmgmt.{region}.oci.oraclecloud.com/20201101/managedDatabases/:managedDatabaseId/sqlTuningSets/:sqlTuningSetId/actions/dropSqlTuningSet", "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": "sqlTuningSetId", "value": "", "type": "path", "description": "The unique identifier of the Sql tuning set. This is not OCID." } ] }, "docs": "Drops the Sql tuning set specified by sqlTuningSet within the Managed Database specified by managedDatabaseId.\n" }, { "info": { "name": "Deletes the Sqls in the specified Sql tuning set.", "type": "http" }, "http": { "method": "POST", "url": "http://dbmgmt.{region}.oci.oraclecloud.com/20201101/managedDatabases/:managedDatabaseId/sqlTuningSets/:sqlTuningSetId/actions/dropSqlsInSqlTuningSet", "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": "sqlTuningSetId", "value": "", "type": "path", "description": "The unique identifier of the Sql tuning set. This is not OCID." } ] }, "docs": "Deletes the Sqls in the specified Sql tuning set that matches the filter criteria provided in the basicFilter.\nIf basicFilter criteria is not provided, then entire Sqls in the Sql tuning set is deleted.\n" }, { "info": { "name": "Load Sql statements into a Sql tuning set.", "type": "http" }, "http": { "method": "POST", "url": "http://dbmgmt.{region}.oci.oraclecloud.com/20201101/managedDatabases/:managedDatabaseId/sqlTuningSets/:sqlTuningSetId/actions/loadSqlTuningSet", "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": "sqlTuningSetId", "value": "", "type": "path", "description": "The unique identifier of the Sql tuning set. This is not OCID." } ] }, "docs": "Load Sql statements into the Sql tuning set specified by name and optional filter parameters within the Managed Database specified by managedDatabaseId.\n" }, { "info": { "name": "Saves the specified list of Sqls statements into another Sql tuning set.", "type": "http" }, "http": { "method": "POST", "url": "http://dbmgmt.{region}.oci.oraclecloud.com/20201101/managedDatabases/:managedDatabaseId/sqlTuningSets/:sqlTuningSetId/actions/saveAs", "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": "sqlTuningSetId", "value": "", "type": "path", "description": "The unique identifier of the Sql tuning set. This is not OCID." } ] }, "docs": "Saves the specified list of Sqls statements into another new Sql tuning set or loads into an existing Sql tuning set'.\n" }, { "info": { "name": "Validates the user entered basic filter criteria.", "type": "http" }, "http": { "method": "POST", "url": "http://dbmgmt.{region}.oci.oraclecloud.com/20201101/managedDatabases/:managedDatabaseId/sqlTuningSets/:sqlTuningSetId/actions/validateBasicFilter", "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": "sqlTuningSetId", "value": "", "type": "path", "description": "The unique identifier of the Sql tuning set. This is not OCID." } ] }, "docs": "Executes a SQL query to check whether user entered basic filter criteria is valid or not.\n" } ] } ], "bundled": true }