{ "opencollection": "1.0.0", "info": { "name": "Ops Insights Operations Insights API", "version": "20200630" }, "items": [ { "info": { "name": "operationsInsights", "type": "folder" }, "items": [ { "info": { "name": "Gets a list of Awr Hub objects.", "type": "http" }, "http": { "method": "GET", "url": "http://127.0.0.1/20200630/awrHubObjects/awrHubSources/:awrHubSourceId/o", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "awrHubSourceId", "value": "", "type": "path", "description": "Unique Awr Hub Source identifier" }, { "name": "prefix", "value": "", "type": "query", "description": "The string to use for matching against the start of object names in a Awr Hub list objects query." }, { "name": "start", "value": "", "type": "query", "description": "Object names returned by Awr Hub list objects query must be greater or equal to this parameter." }, { "name": "end", "value": "", "type": "query", "description": "Object names returned by Awr Hub list objects query must be strictly less than this parameter." }, { "name": "delimiter", "value": "", "type": "query", "description": "When this parameter is set, only objects whose names do not contain the delimiter character\n(after an optionally specified prefix) are returned in the Awr Hub list objects key of the response body.\nScanned objects whose names contain the delimiter have the part of their name up to the first\noccurrence of the delimiter (including the optional prefix) returned as a set of prefixes.\nNote that only '/' is a supported delimiter character at this time.\n" }, { "name": "startAfter", "value": "", "type": "query", "description": "Awr Hub Object name after which remaining objects are listed" }, { "name": "page", "value": "", "type": "query", "description": "For list pagination. The value of the `opc-next-page` response header from\nthe previous \"List\" call. For important details about how pagination works,\nsee [List Pagination](/Content/API/Concepts/usingapi.htm#nine).\n" }, { "name": "limit", "value": "", "type": "query", "description": "For list pagination. The maximum number of results per page, or items to\nreturn in a paginated \"List\" call.\nFor important details about how pagination works, see\n[List Pagination](/Content/API/Concepts/usingapi.htm#nine).\nExample: `50`\n" }, { "name": "fields", "value": "", "type": "query", "description": "By default all the fields are returned. Use this parameter to fetch specific fields 'size', 'etag', 'md5',\n'timeCreated', 'timeModified', 'storageTier' and 'archivalState' fields. List the names of those fields \nin a comma-separated, case-insensitive list as the value of this parameter. \nFor example: 'name,etag,timeCreated,md5,timeModified,storageTier,archivalState'.\n" } ] }, "docs": "Gets a list of Awr Hub objects. Awr Hub id needs to specified.\n" }, { "info": { "name": "Gets the Awr Hub object metadata and body.", "type": "http" }, "http": { "method": "GET", "url": "http://127.0.0.1/20200630/awrHubObjects/awrHubSources/:awrHubSourceId/o/:objectName", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "awrHubSourceId", "value": "", "type": "path", "description": "Unique Awr Hub Source identifier" }, { "name": "objectName", "value": "", "type": "path", "description": "Unique Awr Hub Object identifier" } ] }, "docs": "Gets the Awr Hub object metadata and body." }, { "info": { "name": "Upload an Awr hub Object", "type": "http" }, "http": { "method": "PUT", "url": "http://127.0.0.1/20200630/awrHubObjects/awrHubSources/:awrHubSourceId/o/:objectName", "headers": [ { "name": "if-match", "value": "" }, { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "awrHubSourceId", "value": "", "type": "path", "description": "Unique Awr Hub Source identifier" }, { "name": "objectName", "value": "", "type": "path", "description": "Unique Awr Hub Object identifier" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Creates a new object or overwrites an existing object with the same name to the Awr Hub.\n" }, { "info": { "name": "Deletes an Awr Hub object.", "type": "http" }, "http": { "method": "DELETE", "url": "http://127.0.0.1/20200630/awrHubObjects/awrHubSources/:awrHubSourceId/o/:objectName", "headers": [ { "name": "if-match", "value": "" }, { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "awrHubSourceId", "value": "", "type": "path", "description": "Unique Awr Hub Source identifier" }, { "name": "objectName", "value": "", "type": "path", "description": "Unique Awr Hub Object identifier" } ] }, "docs": "Deletes an Awr Hub object." }, { "info": { "name": "HEAD Object", "type": "http" }, "http": { "method": "HEAD", "url": "http://127.0.0.1/20200630/awrHubObjects/awrHubSources/:awrHubSourceId/o/:objectName", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "awrHubSourceId", "value": "", "type": "path", "description": "Unique Awr Hub Source identifier" }, { "name": "objectName", "value": "", "type": "path", "description": "Unique Awr Hub Object identifier" } ] }, "docs": "Gets the Awr Hub object's user-defined metadata and entity tag (ETag).\n" }, { "info": { "name": "Gets a list of Awr Hub source objects.", "type": "http" }, "http": { "method": "GET", "url": "http://127.0.0.1/20200630/awrHubSources", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "awrHubId", "value": "", "type": "query", "description": "Unique Awr Hub identifier" }, { "name": "compartmentId", "value": "", "type": "query", "description": "The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compartment." }, { "name": "awrHubSourceId", "value": "", "type": "query", "description": "Awr Hub source identifier" }, { "name": "sourceType", "value": "", "type": "query", "description": "Filter by one or more database type.\nPossible values are ADW-S, ATP-S, ADW-D, ATP-D, EXTERNAL-PDB, EXTERNAL-NONCDB.\n" }, { "name": "name", "value": "", "type": "query", "description": "Awr Hub source database name" }, { "name": "status", "value": "", "type": "query", "description": "Resource Status" }, { "name": "lifecycleState", "value": "", "type": "query", "description": "Lifecycle states" }, { "name": "limit", "value": "", "type": "query", "description": "For list pagination. The maximum number of results per page, or items to\nreturn in a paginated \"List\" call.\nFor important details about how pagination works, see\n[List Pagination](/Content/API/Concepts/usingapi.htm#nine).\nExample: `50`\n" }, { "name": "page", "value": "", "type": "query", "description": "For list pagination. The value of the `opc-next-page` response header from\nthe previous \"List\" call. For important details about how pagination works,\nsee [List Pagination](/Content/API/Concepts/usingapi.htm#nine).\n" }, { "name": "sortOrder", "value": "", "type": "query", "description": "The sort order to use, either ascending (`ASC`) or descending (`DESC`).\n" }, { "name": "sortBy", "value": "", "type": "query", "description": "The field to sort by. Only one sort order may be provided. Default order for timeCreated is descending. Default order for displayName is ascending. If no value is specified timeCreated is default.\n" } ] }, "docs": "Gets a list of Awr Hub source objects." }, { "info": { "name": "Register Awr Hub source", "type": "http" }, "http": { "method": "POST", "url": "http://127.0.0.1/20200630/awrHubSources", "headers": [ { "name": "opc-retry-token", "value": "" }, { "name": "opc-request-id", "value": "" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Register Awr Hub source\n" }, { "info": { "name": "Gets the Awr Hub source object.", "type": "http" }, "http": { "method": "GET", "url": "http://127.0.0.1/20200630/awrHubSources/:awrHubSourceId", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "awrHubSourceId", "value": "", "type": "path", "description": "Unique Awr Hub Source identifier" } ] }, "docs": "Gets the Awr Hub source object." }, { "info": { "name": "Update Awr Hub Source object.", "type": "http" }, "http": { "method": "PUT", "url": "http://127.0.0.1/20200630/awrHubSources/:awrHubSourceId", "headers": [ { "name": "if-match", "value": "" }, { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "awrHubSourceId", "value": "", "type": "path", "description": "Unique Awr Hub Source identifier" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Update Awr Hub Source object." }, { "info": { "name": "Deletes an Awr Hub source object.", "type": "http" }, "http": { "method": "DELETE", "url": "http://127.0.0.1/20200630/awrHubSources/:awrHubSourceId", "headers": [ { "name": "if-match", "value": "" }, { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "awrHubSourceId", "value": "", "type": "path", "description": "Unique Awr Hub Source identifier" } ] }, "docs": "Deletes an Awr Hub source object." }, { "info": { "name": "Moves a resource into a different compartment.", "type": "http" }, "http": { "method": "POST", "url": "http://127.0.0.1/20200630/awrHubSources/:awrHubSourceId/actions/changeCompartment", "headers": [ { "name": "if-match", "value": "" }, { "name": "opc-request-id", "value": "" }, { "name": "opc-retry-token", "value": "" } ], "params": [ { "name": "awrHubSourceId", "value": "", "type": "path", "description": "Unique Awr Hub Source identifier" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Moves an AwrHubSource resource from one compartment to another. When provided, If-Match is checked against ETag values of the resource." }, { "info": { "name": "Disables a Awr Hub source database in Operations Insights.", "type": "http" }, "http": { "method": "POST", "url": "http://127.0.0.1/20200630/awrHubSources/:awrHubSourceId/actions/disable", "headers": [ { "name": "if-match", "value": "" }, { "name": "opc-request-id", "value": "" }, { "name": "opc-retry-token", "value": "" } ], "params": [ { "name": "awrHubSourceId", "value": "", "type": "path", "description": "Unique Awr Hub Source identifier" } ] }, "docs": "Disables a Awr Hub source database in Operations Insights. This will stop the Awr data flow for the given Awr Hub source." }, { "info": { "name": "Enables a Awr Hub source database in Operations Insights.", "type": "http" }, "http": { "method": "POST", "url": "http://127.0.0.1/20200630/awrHubSources/:awrHubSourceId/actions/enable", "headers": [ { "name": "if-match", "value": "" }, { "name": "opc-request-id", "value": "" }, { "name": "opc-retry-token", "value": "" } ], "params": [ { "name": "awrHubSourceId", "value": "", "type": "path", "description": "Unique Awr Hub Source identifier" } ] }, "docs": "Enables a Awr Hub source database in Operations Insights. This will resume the Awr data flow for the given Awr Hub source if it was stopped earlier." }, { "info": { "name": "Gets a list of AWR hubs.", "type": "http" }, "http": { "method": "GET", "url": "http://127.0.0.1/20200630/awrHubs", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "compartmentId", "value": "", "type": "query", "description": "The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compartment." }, { "name": "displayName", "value": "", "type": "query", "description": "A filter to return only resources that match the entire display name." }, { "name": "id", "value": "", "type": "query", "description": "Unique Awr Hub identifier" }, { "name": "operationsInsightsWarehouseId", "value": "", "type": "query", "description": "Unique Operations Insights Warehouse identifier" }, { "name": "lifecycleState", "value": "", "type": "query", "description": "Lifecycle states" }, { "name": "limit", "value": "", "type": "query", "description": "For list pagination. The maximum number of results per page, or items to\nreturn in a paginated \"List\" call.\nFor important details about how pagination works, see\n[List Pagination](/Content/API/Concepts/usingapi.htm#nine).\nExample: `50`\n" }, { "name": "page", "value": "", "type": "query", "description": "For list pagination. The value of the `opc-next-page` response header from\nthe previous \"List\" call. For important details about how pagination works,\nsee [List Pagination](/Content/API/Concepts/usingapi.htm#nine).\n" }, { "name": "sortOrder", "value": "", "type": "query", "description": "The sort order to use, either ascending (`ASC`) or descending (`DESC`).\n" }, { "name": "sortBy", "value": "", "type": "query", "description": "The field to sort by. Only one sort order may be provided. Default order for timeCreated is descending. Default order for displayName is ascending. If no value is specified timeCreated is default.\n" } ] }, "docs": "Gets a list of AWR hubs. Either compartmentId or id must be specified. All these resources are expected to be in root compartment.\n" }, { "info": { "name": "Create an Awr hub resource", "type": "http" }, "http": { "method": "POST", "url": "http://127.0.0.1/20200630/awrHubs", "headers": [ { "name": "opc-retry-token", "value": "" }, { "name": "opc-request-id", "value": "" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Create a AWR hub resource for the tenant in Operations Insights.\nThis resource will be created in root compartment.\n" }, { "info": { "name": "Gets details of an AWR hub.", "type": "http" }, "http": { "method": "GET", "url": "http://127.0.0.1/20200630/awrHubs/:awrHubId", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "awrHubId", "value": "", "type": "path", "description": "Unique Awr Hub identifier" } ] }, "docs": "Gets details of an AWR hub." }, { "info": { "name": "Updates the configuration of a hub .", "type": "http" }, "http": { "method": "PUT", "url": "http://127.0.0.1/20200630/awrHubs/:awrHubId", "headers": [ { "name": "if-match", "value": "" }, { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "awrHubId", "value": "", "type": "path", "description": "Unique Awr Hub identifier" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Updates the configuration of a hub ." }, { "info": { "name": "Deletes an AWR hub.", "type": "http" }, "http": { "method": "DELETE", "url": "http://127.0.0.1/20200630/awrHubs/:awrHubId", "headers": [ { "name": "if-match", "value": "" }, { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "awrHubId", "value": "", "type": "path", "description": "Unique Awr Hub identifier" } ] }, "docs": "Deletes an AWR hub." }, { "info": { "name": "Summarizes AWR CPU usage data.", "type": "http" }, "http": { "method": "GET", "url": "http://127.0.0.1/20200630/awrHubs/:awrHubId/awrDatabaseCpuUsages", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "awrHubId", "value": "", "type": "path", "description": "Unique Awr Hub identifier" }, { "name": "awrSourceDatabaseIdentifier", "value": "", "type": "query", "description": "The internal ID of the database. The internal ID of the database is not the [OCID](/Content/General/Concepts/identifiers.htm).\nIt can be retrieved from the following endpoint:\n/awrHubs/{awrHubId}/awrDatabases\n" }, { "name": "instanceNumber", "value": "", "type": "query", "description": "The optional single value query parameter to filter by database instance number." }, { "name": "beginSnapshotIdentifierGreaterThanOrEqualTo", "value": "", "type": "query", "description": "The optional greater than or equal to filter on the snapshot ID.\n" }, { "name": "endSnapshotIdentifierLessThanOrEqualTo", "value": "", "type": "query", "description": "The optional less than or equal to query parameter to filter the snapshot Identifier.\n" }, { "name": "timeGreaterThanOrEqualTo", "value": "", "type": "query", "description": "The optional greater than or equal to query parameter to filter the timestamp. The timestamp format to be followed is: YYYY-MM-DDTHH:MM:SSZ, example 2020-12-03T19:00:53Z\n" }, { "name": "timeLessThanOrEqualTo", "value": "", "type": "query", "description": "The optional less than or equal to query parameter to filter the timestamp. The timestamp format to be followed is: YYYY-MM-DDTHH:MM:SSZ, example 2020-12-03T19:00:53Z\n" }, { "name": "sessionType", "value": "", "type": "query", "description": "The optional query parameter to filter ASH activities by FOREGROUND or BACKGROUND." }, { "name": "page", "value": "", "type": "query", "description": "For list pagination. The value of the `opc-next-page` response header from\nthe previous \"List\" call. For important details about how pagination works,\nsee [List Pagination](/Content/API/Concepts/usingapi.htm#nine).\n" }, { "name": "limit", "value": "", "type": "query", "description": "For list pagination. The maximum number of results per page, or items to\nreturn in a paginated \"List\" call.\nFor important details about how pagination works, see\n[List Pagination](/Content/API/Concepts/usingapi.htm#nine).\nExample: `50`\n" }, { "name": "sortBy", "value": "", "type": "query", "description": "The option to sort the AWR CPU usage summary data." }, { "name": "sortOrder", "value": "", "type": "query", "description": "The sort order to use, either ascending (`ASC`) or descending (`DESC`).\n" } ] }, "docs": "Summarizes the AWR CPU resource limits and metrics for the specified database in AWR.\nBased on the time range provided as part of query param, the metrics points will be returned in the response as below.\n- if time range is <=7 days then the metrics points will be for every MINUTES\n- if time range is <=2 hours then the metrics points will be for every 10 SECONDS\n- if time range is >7 days then the metrics points will be for every HOUR.\n" }, { "info": { "name": "Summarizes metric samples for the specified database.", "type": "http" }, "http": { "method": "GET", "url": "http://127.0.0.1/20200630/awrHubs/:awrHubId/awrDatabaseMetrics", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "awrHubId", "value": "", "type": "path", "description": "Unique Awr Hub identifier" }, { "name": "awrSourceDatabaseIdentifier", "value": "", "type": "query", "description": "The internal ID of the database. The internal ID of the database is not the [OCID](/Content/General/Concepts/identifiers.htm).\nIt can be retrieved from the following endpoint:\n/awrHubs/{awrHubId}/awrDatabases\n" }, { "name": "instanceNumber", "value": "", "type": "query", "description": "The optional single value query parameter to filter by database instance number." }, { "name": "beginSnapshotIdentifierGreaterThanOrEqualTo", "value": "", "type": "query", "description": "The optional greater than or equal to filter on the snapshot ID.\n" }, { "name": "endSnapshotIdentifierLessThanOrEqualTo", "value": "", "type": "query", "description": "The optional less than or equal to query parameter to filter the snapshot Identifier.\n" }, { "name": "timeGreaterThanOrEqualTo", "value": "", "type": "query", "description": "The optional greater than or equal to query parameter to filter the timestamp. The timestamp format to be followed is: YYYY-MM-DDTHH:MM:SSZ, example 2020-12-03T19:00:53Z\n" }, { "name": "timeLessThanOrEqualTo", "value": "", "type": "query", "description": "The optional less than or equal to query parameter to filter the timestamp. The timestamp format to be followed is: YYYY-MM-DDTHH:MM:SSZ, example 2020-12-03T19:00:53Z\n" }, { "name": "name", "value": "", "type": "query", "description": "The required multiple value query parameter to filter the entity name." }, { "name": "page", "value": "", "type": "query", "description": "For list pagination. The value of the `opc-next-page` response header from\nthe previous \"List\" call. For important details about how pagination works,\nsee [List Pagination](/Content/API/Concepts/usingapi.htm#nine).\n" }, { "name": "limit", "value": "", "type": "query", "description": "For list pagination. The maximum number of results per page, or items to\nreturn in a paginated \"List\" call.\nFor important details about how pagination works, see\n[List Pagination](/Content/API/Concepts/usingapi.htm#nine).\nExample: `50`\n" }, { "name": "sortBy", "value": "", "type": "query", "description": "The option to sort the AWR time series summary data." }, { "name": "sortOrder", "value": "", "type": "query", "description": "The sort order to use, either ascending (`ASC`) or descending (`DESC`).\n" } ] }, "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://127.0.0.1/20200630/awrHubs/:awrHubId/awrDatabaseParameterChanges", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "awrHubId", "value": "", "type": "path", "description": "Unique Awr Hub identifier" }, { "name": "awrSourceDatabaseIdentifier", "value": "", "type": "query", "description": "The internal ID of the database. The internal ID of the database is not the [OCID](/Content/General/Concepts/identifiers.htm).\nIt can be retrieved from the following endpoint:\n/awrHubs/{awrHubId}/awrDatabases\n" }, { "name": "instanceNumber", "value": "", "type": "query", "description": "The optional single value query parameter to filter by database instance number." }, { "name": "beginSnapshotIdentifierGreaterThanOrEqualTo", "value": "", "type": "query", "description": "The optional greater than or equal to filter on the snapshot ID.\n" }, { "name": "endSnapshotIdentifierLessThanOrEqualTo", "value": "", "type": "query", "description": "The optional less than or equal to query parameter to filter the snapshot Identifier.\n" }, { "name": "timeGreaterThanOrEqualTo", "value": "", "type": "query", "description": "The optional greater than or equal to query parameter to filter the timestamp. The timestamp format to be followed is: YYYY-MM-DDTHH:MM:SSZ, example 2020-12-03T19:00:53Z\n" }, { "name": "timeLessThanOrEqualTo", "value": "", "type": "query", "description": "The optional less than or equal to query parameter to filter the timestamp. The timestamp format to be followed is: YYYY-MM-DDTHH:MM:SSZ, example 2020-12-03T19:00:53Z\n" }, { "name": "name", "value": "", "type": "query", "description": "The required single value query parameter to filter the entity name." }, { "name": "page", "value": "", "type": "query", "description": "For list pagination. The value of the `opc-next-page` response header from\nthe previous \"List\" call. For important details about how pagination works,\nsee [List Pagination](/Content/API/Concepts/usingapi.htm#nine).\n" }, { "name": "limit", "value": "", "type": "query", "description": "For list pagination. The maximum number of results per page, or items to\nreturn in a paginated \"List\" call.\nFor important details about how pagination works, see\n[List Pagination](/Content/API/Concepts/usingapi.htm#nine).\nExample: `50`\n" }, { "name": "sortBy", "value": "", "type": "query", "description": "The option to sort the AWR database parameter change history data." }, { "name": "sortOrder", "value": "", "type": "query", "description": "The sort order to use, either ascending (`ASC`) or descending (`DESC`).\n" } ] }, "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://127.0.0.1/20200630/awrHubs/:awrHubId/awrDatabaseParameters", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "awrHubId", "value": "", "type": "path", "description": "Unique Awr Hub identifier" }, { "name": "awrSourceDatabaseIdentifier", "value": "", "type": "query", "description": "The internal ID of the database. The internal ID of the database is not the [OCID](/Content/General/Concepts/identifiers.htm).\nIt can be retrieved from the following endpoint:\n/awrHubs/{awrHubId}/awrDatabases\n" }, { "name": "instanceNumber", "value": "", "type": "query", "description": "The optional single value query parameter to filter by database instance number." }, { "name": "beginSnapshotIdentifierGreaterThanOrEqualTo", "value": "", "type": "query", "description": "The optional greater than or equal to filter on the snapshot ID.\n" }, { "name": "endSnapshotIdentifierLessThanOrEqualTo", "value": "", "type": "query", "description": "The optional less than or equal to query parameter to filter the snapshot Identifier.\n" }, { "name": "timeGreaterThanOrEqualTo", "value": "", "type": "query", "description": "The optional greater than or equal to query parameter to filter the timestamp. The timestamp format to be followed is: YYYY-MM-DDTHH:MM:SSZ, example 2020-12-03T19:00:53Z\n" }, { "name": "timeLessThanOrEqualTo", "value": "", "type": "query", "description": "The optional less than or equal to query parameter to filter the timestamp. The timestamp format to be followed is: YYYY-MM-DDTHH:MM:SSZ, example 2020-12-03T19:00:53Z\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": "For list pagination. The value of the `opc-next-page` response header from\nthe previous \"List\" call. For important details about how pagination works,\nsee [List Pagination](/Content/API/Concepts/usingapi.htm#nine).\n" }, { "name": "limit", "value": "", "type": "query", "description": "For list pagination. The maximum number of results per page, or items to\nreturn in a paginated \"List\" call.\nFor important details about how pagination works, see\n[List Pagination](/Content/API/Concepts/usingapi.htm#nine).\nExample: `50`\n" }, { "name": "sortBy", "value": "", "type": "query", "description": "The option to sort the AWR database parameter change history data." }, { "name": "sortOrder", "value": "", "type": "query", "description": "The sort order to use, either ascending (`ASC`) or descending (`DESC`).\n" } ] }, "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\nQueryparam (valueChanged =\"Y\") - Each parameter whose value was changed during the time range, \"isChanged : true\" " }, { "info": { "name": "Gets the AWR database report.", "type": "http" }, "http": { "method": "GET", "url": "http://127.0.0.1/20200630/awrHubs/:awrHubId/awrDatabaseReport", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "awrHubId", "value": "", "type": "path", "description": "Unique Awr Hub identifier" }, { "name": "awrSourceDatabaseIdentifier", "value": "", "type": "query", "description": "The internal ID of the database. The internal ID of the database is not the [OCID](/Content/General/Concepts/identifiers.htm).\nIt can be retrieved from the following endpoint:\n/awrHubs/{awrHubId}/awrDatabases\n" }, { "name": "instanceNumber", "value": "", "type": "query", "description": "The optional single value query parameter to filter by database instance number." }, { "name": "beginSnapshotIdentifierGreaterThanOrEqualTo", "value": "", "type": "query", "description": "The optional greater than or equal to filter on the snapshot ID.\n" }, { "name": "endSnapshotIdentifierLessThanOrEqualTo", "value": "", "type": "query", "description": "The optional less than or equal to query parameter to filter the snapshot Identifier.\n" }, { "name": "timeGreaterThanOrEqualTo", "value": "", "type": "query", "description": "The optional greater than or equal to query parameter to filter the timestamp. The timestamp format to be followed is: YYYY-MM-DDTHH:MM:SSZ, example 2020-12-03T19:00:53Z\n" }, { "name": "timeLessThanOrEqualTo", "value": "", "type": "query", "description": "The optional less than or equal to query parameter to filter the timestamp. The timestamp format to be followed is: YYYY-MM-DDTHH:MM:SSZ, example 2020-12-03T19:00:53Z\n" }, { "name": "reportType", "value": "", "type": "query", "description": "The query parameter to filter the AWR report types." }, { "name": "reportFormat", "value": "", "type": "query", "description": "The format of the AWR report." } ] }, "docs": "Gets the AWR report for the specified database.\n" }, { "info": { "name": "Summarizes AWR snapshot ranges.", "type": "http" }, "http": { "method": "GET", "url": "http://127.0.0.1/20200630/awrHubs/:awrHubId/awrDatabaseSnapshotRanges", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "awrHubId", "value": "", "type": "path", "description": "Unique Awr Hub identifier" }, { "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. The timestamp format to be followed is: YYYY-MM-DDTHH:MM:SSZ, example 2020-12-03T19:00:53Z\n" }, { "name": "timeLessThanOrEqualTo", "value": "", "type": "query", "description": "The optional less than or equal to query parameter to filter the timestamp. The timestamp format to be followed is: YYYY-MM-DDTHH:MM:SSZ, example 2020-12-03T19:00:53Z\n" }, { "name": "page", "value": "", "type": "query", "description": "For list pagination. The value of the `opc-next-page` response header from\nthe previous \"List\" call. For important details about how pagination works,\nsee [List Pagination](/Content/API/Concepts/usingapi.htm#nine).\n" }, { "name": "limit", "value": "", "type": "query", "description": "For list pagination. The maximum number of results per page, or items to\nreturn in a paginated \"List\" call.\nFor important details about how pagination works, see\n[List Pagination](/Content/API/Concepts/usingapi.htm#nine).\nExample: `50`\n" }, { "name": "sortBy", "value": "", "type": "query", "description": "The option to sort the AWR summary data." }, { "name": "sortOrder", "value": "", "type": "query", "description": "The sort order to use, either ascending (`ASC`) or descending (`DESC`).\n" } ] }, "docs": "Summarizes the AWR snapshot ranges that contain continuous snapshots, for the specified AWRHub.\n" }, { "info": { "name": "List the AWR snapshots for specified database.", "type": "http" }, "http": { "method": "GET", "url": "http://127.0.0.1/20200630/awrHubs/:awrHubId/awrDatabaseSnapshots", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "awrHubId", "value": "", "type": "path", "description": "Unique Awr Hub identifier" }, { "name": "awrSourceDatabaseIdentifier", "value": "", "type": "query", "description": "The internal ID of the database. The internal ID of the database is not the [OCID](/Content/General/Concepts/identifiers.htm).\nIt can be retrieved from the following endpoint:\n/awrHubs/{awrHubId}/awrDatabases\n" }, { "name": "instanceNumber", "value": "", "type": "query", "description": "The optional single value query parameter to filter by database instance number." }, { "name": "beginSnapshotIdentifierGreaterThanOrEqualTo", "value": "", "type": "query", "description": "The optional greater than or equal to filter on the snapshot ID.\n" }, { "name": "endSnapshotIdentifierLessThanOrEqualTo", "value": "", "type": "query", "description": "The optional less than or equal to query parameter to filter the snapshot Identifier.\n" }, { "name": "timeGreaterThanOrEqualTo", "value": "", "type": "query", "description": "The optional greater than or equal to query parameter to filter the timestamp. The timestamp format to be followed is: YYYY-MM-DDTHH:MM:SSZ, example 2020-12-03T19:00:53Z\n" }, { "name": "timeLessThanOrEqualTo", "value": "", "type": "query", "description": "The optional less than or equal to query parameter to filter the timestamp. The timestamp format to be followed is: YYYY-MM-DDTHH:MM:SSZ, example 2020-12-03T19:00:53Z\n" }, { "name": "page", "value": "", "type": "query", "description": "For list pagination. The value of the `opc-next-page` response header from\nthe previous \"List\" call. For important details about how pagination works,\nsee [List Pagination](/Content/API/Concepts/usingapi.htm#nine).\n" }, { "name": "limit", "value": "", "type": "query", "description": "For list pagination. The maximum number of results per page, or items to\nreturn in a paginated \"List\" call.\nFor important details about how pagination works, see\n[List Pagination](/Content/API/Concepts/usingapi.htm#nine).\nExample: `50`\n" }, { "name": "sortBy", "value": "", "type": "query", "description": "The option to sort the AWR snapshot summary data." }, { "name": "sortOrder", "value": "", "type": "query", "description": "The sort order to use, either ascending (`ASC`) or descending (`DESC`).\n" } ] }, "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. 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 (/awrHubs/{awrHubId}/awrDatabaseReport).", "type": "http" }, "http": { "method": "GET", "url": "http://127.0.0.1/20200630/awrHubs/:awrHubId/awrDatabaseSqlReport", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "awrHubId", "value": "", "type": "path", "description": "Unique Awr Hub identifier" }, { "name": "awrSourceDatabaseIdentifier", "value": "", "type": "query", "description": "The internal ID of the database. The internal ID of the database is not the [OCID](/Content/General/Concepts/identifiers.htm).\nIt can be retrieved from the following endpoint:\n/awrHubs/{awrHubId}/awrDatabases\n" }, { "name": "instanceNumber", "value": "", "type": "query", "description": "The optional single value query parameter to filter by database instance number." }, { "name": "beginSnapshotIdentifierGreaterThanOrEqualTo", "value": "", "type": "query", "description": "The optional greater than or equal to filter on the snapshot ID.\n" }, { "name": "endSnapshotIdentifierLessThanOrEqualTo", "value": "", "type": "query", "description": "The optional less than or equal to query parameter to filter the snapshot Identifier.\n" }, { "name": "timeGreaterThanOrEqualTo", "value": "", "type": "query", "description": "The optional greater than or equal to query parameter to filter the timestamp. The timestamp format to be followed is: YYYY-MM-DDTHH:MM:SSZ, example 2020-12-03T19:00:53Z\n" }, { "name": "timeLessThanOrEqualTo", "value": "", "type": "query", "description": "The optional less than or equal to query parameter to filter the timestamp. The timestamp format to be followed is: YYYY-MM-DDTHH:MM:SSZ, example 2020-12-03T19:00:53Z\n" }, { "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 (/awrHubs/{awrHubId}/awrDbReport).\n" }, { "name": "reportFormat", "value": "", "type": "query", "description": "The format of the AWR report." } ] }, "docs": "Gets the SQL health check report for one SQL of the specified database.\n" }, { "info": { "name": "Summarizes AWR Sysstat sample data for specified database.", "type": "http" }, "http": { "method": "GET", "url": "http://127.0.0.1/20200630/awrHubs/:awrHubId/awrDatabaseSysstats", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "awrHubId", "value": "", "type": "path", "description": "Unique Awr Hub identifier" }, { "name": "awrSourceDatabaseIdentifier", "value": "", "type": "query", "description": "The internal ID of the database. The internal ID of the database is not the [OCID](/Content/General/Concepts/identifiers.htm).\nIt can be retrieved from the following endpoint:\n/awrHubs/{awrHubId}/awrDatabases\n" }, { "name": "instanceNumber", "value": "", "type": "query", "description": "The optional single value query parameter to filter by database instance number." }, { "name": "beginSnapshotIdentifierGreaterThanOrEqualTo", "value": "", "type": "query", "description": "The optional greater than or equal to filter on the snapshot ID.\n" }, { "name": "endSnapshotIdentifierLessThanOrEqualTo", "value": "", "type": "query", "description": "The optional less than or equal to query parameter to filter the snapshot Identifier.\n" }, { "name": "timeGreaterThanOrEqualTo", "value": "", "type": "query", "description": "The optional greater than or equal to query parameter to filter the timestamp. The timestamp format to be followed is: YYYY-MM-DDTHH:MM:SSZ, example 2020-12-03T19:00:53Z\n" }, { "name": "timeLessThanOrEqualTo", "value": "", "type": "query", "description": "The optional less than or equal to query parameter to filter the timestamp. The timestamp format to be followed is: YYYY-MM-DDTHH:MM:SSZ, example 2020-12-03T19:00:53Z\n" }, { "name": "name", "value": "", "type": "query", "description": "The required multiple value query parameter to filter the entity name." }, { "name": "page", "value": "", "type": "query", "description": "For list pagination. The value of the `opc-next-page` response header from\nthe previous \"List\" call. For important details about how pagination works,\nsee [List Pagination](/Content/API/Concepts/usingapi.htm#nine).\n" }, { "name": "limit", "value": "", "type": "query", "description": "For list pagination. The maximum number of results per page, or items to\nreturn in a paginated \"List\" call.\nFor important details about how pagination works, see\n[List Pagination](/Content/API/Concepts/usingapi.htm#nine).\nExample: `50`\n" }, { "name": "sortBy", "value": "", "type": "query", "description": "The option to sort the data within a time period." }, { "name": "sortOrder", "value": "", "type": "query", "description": "The sort order to use, either ascending (`ASC`) or descending (`DESC`).\n" } ] }, "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://127.0.0.1/20200630/awrHubs/:awrHubId/awrDatabaseTopWaitEvents", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "awrHubId", "value": "", "type": "path", "description": "Unique Awr Hub identifier" }, { "name": "awrSourceDatabaseIdentifier", "value": "", "type": "query", "description": "The internal ID of the database. The internal ID of the database is not the [OCID](/Content/General/Concepts/identifiers.htm).\nIt can be retrieved from the following endpoint:\n/awrHubs/{awrHubId}/awrDatabases\n" }, { "name": "instanceNumber", "value": "", "type": "query", "description": "The optional single value query parameter to filter by database instance number." }, { "name": "beginSnapshotIdentifierGreaterThanOrEqualTo", "value": "", "type": "query", "description": "The optional greater than or equal to filter on the snapshot ID.\n" }, { "name": "endSnapshotIdentifierLessThanOrEqualTo", "value": "", "type": "query", "description": "The optional less than or equal to query parameter to filter the snapshot Identifier.\n" }, { "name": "timeGreaterThanOrEqualTo", "value": "", "type": "query", "description": "The optional greater than or equal to query parameter to filter the timestamp. The timestamp format to be followed is: YYYY-MM-DDTHH:MM:SSZ, example 2020-12-03T19:00:53Z\n" }, { "name": "timeLessThanOrEqualTo", "value": "", "type": "query", "description": "The optional less than or equal to query parameter to filter the timestamp. The timestamp format to be followed is: YYYY-MM-DDTHH:MM:SSZ, example 2020-12-03T19:00:53Z\n" }, { "name": "sessionType", "value": "", "type": "query", "description": "The optional query parameter to filter ASH activities by FOREGROUND or BACKGROUND." }, { "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 sort order to use, either ascending (`ASC`) or descending (`DESC`).\n" } ] }, "docs": "Summarizes the AWR top wait events.\n" }, { "info": { "name": "Summarize AWR event data into value buckets and frequencies for specified database.", "type": "http" }, "http": { "method": "GET", "url": "http://127.0.0.1/20200630/awrHubs/:awrHubId/awrDatabaseWaitEventBuckets", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "awrHubId", "value": "", "type": "path", "description": "Unique Awr Hub identifier" }, { "name": "awrSourceDatabaseIdentifier", "value": "", "type": "query", "description": "The internal ID of the database. The internal ID of the database is not the [OCID](/Content/General/Concepts/identifiers.htm).\nIt can be retrieved from the following endpoint:\n/awrHubs/{awrHubId}/awrDatabases\n" }, { "name": "instanceNumber", "value": "", "type": "query", "description": "The optional single value query parameter to filter by database instance number." }, { "name": "beginSnapshotIdentifierGreaterThanOrEqualTo", "value": "", "type": "query", "description": "The optional greater than or equal to filter on the snapshot ID.\n" }, { "name": "endSnapshotIdentifierLessThanOrEqualTo", "value": "", "type": "query", "description": "The optional less than or equal to query parameter to filter the snapshot Identifier.\n" }, { "name": "timeGreaterThanOrEqualTo", "value": "", "type": "query", "description": "The optional greater than or equal to query parameter to filter the timestamp. The timestamp format to be followed is: YYYY-MM-DDTHH:MM:SSZ, example 2020-12-03T19:00:53Z\n" }, { "name": "timeLessThanOrEqualTo", "value": "", "type": "query", "description": "The optional less than or equal to query parameter to filter the timestamp. The timestamp format to be followed is: YYYY-MM-DDTHH:MM:SSZ, example 2020-12-03T19:00:53Z\n" }, { "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": "page", "value": "", "type": "query", "description": "For list pagination. The value of the `opc-next-page` response header from\nthe previous \"List\" call. For important details about how pagination works,\nsee [List Pagination](/Content/API/Concepts/usingapi.htm#nine).\n" }, { "name": "limit", "value": "", "type": "query", "description": "For list pagination. The maximum number of results per page, or items to\nreturn in a paginated \"List\" call.\nFor important details about how pagination works, see\n[List Pagination](/Content/API/Concepts/usingapi.htm#nine).\nExample: `50`\n" }, { "name": "sortBy", "value": "", "type": "query", "description": "The option to sort distribution data." }, { "name": "sortOrder", "value": "", "type": "query", "description": "The sort order to use, either ascending (`ASC`) or descending (`DESC`).\n" } ] }, "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://127.0.0.1/20200630/awrHubs/:awrHubId/awrDatabaseWaitEvents", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "awrHubId", "value": "", "type": "path", "description": "Unique Awr Hub identifier" }, { "name": "awrSourceDatabaseIdentifier", "value": "", "type": "query", "description": "The internal ID of the database. The internal ID of the database is not the [OCID](/Content/General/Concepts/identifiers.htm).\nIt can be retrieved from the following endpoint:\n/awrHubs/{awrHubId}/awrDatabases\n" }, { "name": "instanceNumber", "value": "", "type": "query", "description": "The optional single value query parameter to filter by database instance number." }, { "name": "beginSnapshotIdentifierGreaterThanOrEqualTo", "value": "", "type": "query", "description": "The optional greater than or equal to filter on the snapshot ID.\n" }, { "name": "endSnapshotIdentifierLessThanOrEqualTo", "value": "", "type": "query", "description": "The optional less than or equal to query parameter to filter the snapshot Identifier.\n" }, { "name": "timeGreaterThanOrEqualTo", "value": "", "type": "query", "description": "The optional greater than or equal to query parameter to filter the timestamp. The timestamp format to be followed is: YYYY-MM-DDTHH:MM:SSZ, example 2020-12-03T19:00:53Z\n" }, { "name": "timeLessThanOrEqualTo", "value": "", "type": "query", "description": "The optional less than or equal to query parameter to filter the timestamp. The timestamp format to be followed is: YYYY-MM-DDTHH:MM:SSZ, example 2020-12-03T19:00:53Z\n" }, { "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": "page", "value": "", "type": "query", "description": "For list pagination. The value of the `opc-next-page` response header from\nthe previous \"List\" call. For important details about how pagination works,\nsee [List Pagination](/Content/API/Concepts/usingapi.htm#nine).\n" }, { "name": "limit", "value": "", "type": "query", "description": "For list pagination. The maximum number of results per page, or items to\nreturn in a paginated \"List\" call.\nFor important details about how pagination works, see\n[List Pagination](/Content/API/Concepts/usingapi.htm#nine).\nExample: `50`\n" }, { "name": "sortBy", "value": "", "type": "query", "description": "The option to sort the data within a time period." }, { "name": "sortOrder", "value": "", "type": "query", "description": "The sort order to use, either ascending (`ASC`) or descending (`DESC`).\n" } ] }, "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 list of AWR database information.", "type": "http" }, "http": { "method": "GET", "url": "http://127.0.0.1/20200630/awrHubs/:awrHubId/awrDatabases", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "awrHubId", "value": "", "type": "path", "description": "Unique Awr Hub identifier" }, { "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. The timestamp format to be followed is: YYYY-MM-DDTHH:MM:SSZ, example 2020-12-03T19:00:53Z\n" }, { "name": "timeLessThanOrEqualTo", "value": "", "type": "query", "description": "The optional less than or equal to query parameter to filter the timestamp. The timestamp format to be followed is: YYYY-MM-DDTHH:MM:SSZ, example 2020-12-03T19:00:53Z\n" }, { "name": "page", "value": "", "type": "query", "description": "For list pagination. The value of the `opc-next-page` response header from\nthe previous \"List\" call. For important details about how pagination works,\nsee [List Pagination](/Content/API/Concepts/usingapi.htm#nine).\n" }, { "name": "limit", "value": "", "type": "query", "description": "For list pagination. The maximum number of results per page, or items to\nreturn in a paginated \"List\" call.\nFor important details about how pagination works, see\n[List Pagination](/Content/API/Concepts/usingapi.htm#nine).\nExample: `50`\n" }, { "name": "sortBy", "value": "", "type": "query", "description": "The option to sort the AWR summary data." }, { "name": "sortOrder", "value": "", "type": "query", "description": "The sort order to use, either ascending (`ASC`) or descending (`DESC`).\n" } ] }, "docs": "Gets the list of databases and their snapshot summary details available in the AWRHub.\n" }, { "info": { "name": "Gets the AWR report for the specified source database in the AWR hub.", "type": "http" }, "http": { "method": "GET", "url": "http://127.0.0.1/20200630/awrHubs/:awrHubId/awrReport", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "awrHubId", "value": "", "type": "path", "description": "Unique Awr Hub identifier" }, { "name": "awrSourceDatabaseIdentifier", "value": "", "type": "query", "description": "AWR source database identifier." }, { "name": "reportFormat", "value": "", "type": "query", "description": "The format of the AWR report. Default report format is HTML." }, { "name": "instanceNumber", "value": "", "type": "query", "description": "The optional single value query parameter to filter by database instance number." }, { "name": "beginSnapshotIdentifierGreaterThanOrEqualTo", "value": "", "type": "query", "description": "The optional greater than or equal to filter on the snapshot ID.\n" }, { "name": "endSnapshotIdentifierLessThanOrEqualTo", "value": "", "type": "query", "description": "The optional less than or equal to query parameter to filter the snapshot Identifier.\n" }, { "name": "timeGreaterThanOrEqualTo", "value": "", "type": "query", "description": "The optional greater than or equal to query parameter to filter the timestamp. The timestamp format to be followed is: YYYY-MM-DDTHH:MM:SSZ, example 2020-12-03T19:00:53Z\n" }, { "name": "timeLessThanOrEqualTo", "value": "", "type": "query", "description": "The optional less than or equal to query parameter to filter the timestamp. The timestamp format to be followed is: YYYY-MM-DDTHH:MM:SSZ, example 2020-12-03T19:00:53Z\n" } ] }, "docs": "Gets the AWR report for the specified source database in the AWR hub. The difference between the timeGreaterThanOrEqualTo and timeLessThanOrEqualTo should not be greater than 7 days.\nEither beginSnapshotIdentifierGreaterThanOrEqualTo & endSnapshotIdentifierLessThanOrEqualTo params Or timeGreaterThanOrEqualTo & timeLessThanOrEqualTo params are required.\n" }, { "info": { "name": "Lists AWR snapshots for the specified source database in the AWR hub.", "type": "http" }, "http": { "method": "GET", "url": "http://127.0.0.1/20200630/awrHubs/:awrHubId/awrSnapshots", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "awrHubId", "value": "", "type": "path", "description": "Unique Awr Hub identifier" }, { "name": "awrSourceDatabaseIdentifier", "value": "", "type": "query", "description": "AWR source database identifier." }, { "name": "timeGreaterThanOrEqualTo", "value": "", "type": "query", "description": "The optional greater than or equal to query parameter to filter the timestamp. The timestamp format to be followed is: YYYY-MM-DDTHH:MM:SSZ, example 2020-12-03T19:00:53Z\n" }, { "name": "timeLessThanOrEqualTo", "value": "", "type": "query", "description": "The optional less than or equal to query parameter to filter the timestamp. The timestamp format to be followed is: YYYY-MM-DDTHH:MM:SSZ, example 2020-12-03T19:00:53Z\n" }, { "name": "limit", "value": "", "type": "query", "description": "For list pagination. The maximum number of results per page, or items to\nreturn in a paginated \"List\" call.\nFor important details about how pagination works, see\n[List Pagination](/Content/API/Concepts/usingapi.htm#nine).\nExample: `50`\n" }, { "name": "page", "value": "", "type": "query", "description": "For list pagination. The value of the `opc-next-page` response header from\nthe previous \"List\" call. For important details about how pagination works,\nsee [List Pagination](/Content/API/Concepts/usingapi.htm#nine).\n" }, { "name": "sortOrder", "value": "", "type": "query", "description": "The sort order to use, either ascending (`ASC`) or descending (`DESC`).\n" }, { "name": "sortBy", "value": "", "type": "query", "description": "The option to sort the AWR snapshot summary data. Default sort is by timeBegin." } ] }, "docs": "Lists AWR snapshots for the specified source database in the AWR hub. The difference between the timeGreaterThanOrEqualTo and timeLessThanOrEqualTo should not exceed an elapsed range of 1 day.\nThe timeGreaterThanOrEqualTo & timeLessThanOrEqualTo params are optional. If these params are not provided, by default last 1 day snapshots will be returned.\n" }, { "info": { "name": "Gets a list of summary of AWR Sources.", "type": "http" }, "http": { "method": "GET", "url": "http://127.0.0.1/20200630/awrHubs/:awrHubId/awrSourcesSummary", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "awrHubId", "value": "", "type": "path", "description": "Unique Awr Hub identifier" }, { "name": "compartmentId", "value": "", "type": "query", "description": "The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compartment." }, { "name": "name", "value": "", "type": "query", "description": "Name for an Awr source database\n" }, { "name": "limit", "value": "", "type": "query", "description": "For list pagination. The maximum number of results per page, or items to\nreturn in a paginated \"List\" call.\nFor important details about how pagination works, see\n[List Pagination](/Content/API/Concepts/usingapi.htm#nine).\nExample: `50`\n" }, { "name": "page", "value": "", "type": "query", "description": "For list pagination. The value of the `opc-next-page` response header from\nthe previous \"List\" call. For important details about how pagination works,\nsee [List Pagination](/Content/API/Concepts/usingapi.htm#nine).\n" }, { "name": "sortBy", "value": "", "type": "query", "description": "The order in which Awr sources summary records are listed\n" }, { "name": "sortOrder", "value": "", "type": "query", "description": "The sort order to use, either ascending (`ASC`) or descending (`DESC`).\n" } ] }, "docs": "Gets a list of summary of AWR Sources.\n" }, { "info": { "name": "Gets a list of Ops Insights chargeback plan reports for a resource.", "type": "http" }, "http": { "method": "GET", "url": "http://127.0.0.1/20200630/chargebackPlanReport", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "id", "value": "", "type": "query", "description": "Unique Ops insight identifier" }, { "name": "resourceType", "value": "", "type": "query", "description": "Filter by resource type.\nSupported values are EXADATA_INSIGHT , HOST_INSIGHT, DATABASE_INSIGHT.\n" }, { "name": "limit", "value": "", "type": "query", "description": "For list pagination. The maximum number of results per page, or items to\nreturn in a paginated \"List\" call.\nFor important details about how pagination works, see\n[List Pagination](/Content/API/Concepts/usingapi.htm#nine).\nExample: `50`\n" }, { "name": "page", "value": "", "type": "query", "description": "For list pagination. The value of the `opc-next-page` response header from\nthe previous \"List\" call. For important details about how pagination works,\nsee [List Pagination](/Content/API/Concepts/usingapi.htm#nine).\n" }, { "name": "sortOrder", "value": "", "type": "query", "description": "The sort order to use, either ascending (`ASC`) or descending (`DESC`).\n" }, { "name": "sortBy", "value": "", "type": "query", "description": "The field to sort chargeback plan reports.\n" } ] }, "docs": "Gets a list of Ops Insights chargeback plan reports for a resource." }, { "info": { "name": "Creates a chargeback plan report for a resource in Ops Insights.", "type": "http" }, "http": { "method": "POST", "url": "http://127.0.0.1/20200630/chargebackPlanReport", "headers": [ { "name": "if-match", "value": "" }, { "name": "opc-request-id", "value": "" }, { "name": "opc-retry-token", "value": "" } ], "params": [ { "name": "id", "value": "", "type": "query", "description": "Unique Ops insight identifier" }, { "name": "resourceType", "value": "", "type": "query", "description": "Filter by resource type.\nSupported values are EXADATA_INSIGHT , HOST_INSIGHT, DATABASE_INSIGHT.\n" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Creates a chargeback plan report for a resource in Ops Insights" }, { "info": { "name": "Gets the details of the specified chargeback plan report for a resource", "type": "http" }, "http": { "method": "GET", "url": "http://127.0.0.1/20200630/chargebackPlanReport/:chargebackPlanReportId", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "chargebackPlanReportId", "value": "", "type": "path", "description": "The [OCID](/Content/General/Concepts/identifiers.htm) of the Ops Insights chargeback plan report" }, { "name": "id", "value": "", "type": "query", "description": "Unique Ops insight identifier" }, { "name": "resourceType", "value": "", "type": "query", "description": "Filter by resource type.\nSupported values are EXADATA_INSIGHT , HOST_INSIGHT, DATABASE_INSIGHT.\n" } ] }, "docs": "Gets the details of the specified chargeback plan plan report" }, { "info": { "name": "Updates one or more attributes of the specified chargeback plan report.", "type": "http" }, "http": { "method": "PUT", "url": "http://127.0.0.1/20200630/chargebackPlanReport/:chargebackPlanReportId", "headers": [ { "name": "if-match", "value": "" }, { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "chargebackPlanReportId", "value": "", "type": "path", "description": "The [OCID](/Content/General/Concepts/identifiers.htm) of the Ops Insights chargeback plan report" }, { "name": "id", "value": "", "type": "query", "description": "Unique Ops insight identifier" }, { "name": "resourceType", "value": "", "type": "query", "description": "Filter by resource type.\nSupported values are EXADATA_INSIGHT , HOST_INSIGHT, DATABASE_INSIGHT.\n" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Updates one or more attributes of the specified chargeback plan report." }, { "info": { "name": "Deletes a chargeback plan report", "type": "http" }, "http": { "method": "DELETE", "url": "http://127.0.0.1/20200630/chargebackPlanReport/:chargebackPlanReportId", "headers": [ { "name": "if-match", "value": "" }, { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "chargebackPlanReportId", "value": "", "type": "path", "description": "The [OCID](/Content/General/Concepts/identifiers.htm) of the Ops Insights chargeback plan report" }, { "name": "id", "value": "", "type": "query", "description": "Unique Ops insight identifier" }, { "name": "resourceType", "value": "", "type": "query", "description": "Filter by resource type.\nSupported values are EXADATA_INSIGHT , HOST_INSIGHT, DATABASE_INSIGHT.\n" } ] }, "docs": "Deletes a chargeback plan report if it's not assigned to any resource." }, { "info": { "name": "Generates the chargeback report in csv format for a given resource", "type": "http" }, "http": { "method": "GET", "url": "http://127.0.0.1/20200630/chargebackPlanReport/:chargebackPlanReportId/content", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "chargebackPlanReportId", "value": "", "type": "path", "description": "The [OCID](/Content/General/Concepts/identifiers.htm) of the Ops Insights chargeback plan report" }, { "name": "timeIntervalStart", "value": "", "type": "query", "description": "Analysis start time in UTC in ISO 8601 format(inclusive).\nExample 2019-10-30T00:00:00Z (yyyy-MM-ddThh:mm:ssZ).\nThe minimum allowed value is 2 years prior to the current day.\ntimeIntervalStart and timeIntervalEnd parameters are used together.\nIf analysisTimeInterval is specified, this parameter is ignored.\n" }, { "name": "timeIntervalEnd", "value": "", "type": "query", "description": "Analysis end time in UTC in ISO 8601 format(exclusive).\nExample 2019-10-30T00:00:00Z (yyyy-MM-ddThh:mm:ssZ).\ntimeIntervalStart and timeIntervalEnd are used together.\nIf timeIntervalEnd is not specified, current time is used as timeIntervalEnd.\n" }, { "name": "id", "value": "", "type": "query", "description": "Unique Ops insight identifier" }, { "name": "resourceType", "value": "", "type": "query", "description": "Filter by resource type.\nSupported values are EXADATA_INSIGHT , HOST_INSIGHT, DATABASE_INSIGHT.\n" }, { "name": "relativeTimeInterval", "value": "", "type": "query", "description": "Specify relative time period with respect to current time.\nIf relativeTimeInterval is specified, then timeIntervalStart and timeIntervalEnd will be ignored.\nExamples P1M (previous month), P1Q (previous quarter) and P1Y (previous year).\n" } ] }, "docs": "Generates the chargeback report in csv format for a specified time interval" }, { "info": { "name": "Gets a list of Ops Insights chargeback plans.", "type": "http" }, "http": { "method": "GET", "url": "http://127.0.0.1/20200630/chargebackPlans", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "compartmentId", "value": "", "type": "query", "description": "The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compartment." }, { "name": "chargebackplanId", "value": "", "type": "query", "description": "The [OCID](/Content/General/Concepts/identifiers.htm) of the Ops Insights chargeback plan." }, { "name": "limit", "value": "", "type": "query", "description": "For list pagination. The maximum number of results per page, or items to\nreturn in a paginated \"List\" call.\nFor important details about how pagination works, see\n[List Pagination](/Content/API/Concepts/usingapi.htm#nine).\nExample: `50`\n" }, { "name": "page", "value": "", "type": "query", "description": "For list pagination. The value of the `opc-next-page` response header from\nthe previous \"List\" call. For important details about how pagination works,\nsee [List Pagination](/Content/API/Concepts/usingapi.htm#nine).\n" }, { "name": "sortOrder", "value": "", "type": "query", "description": "The sort order to use, either ascending (`ASC`) or descending (`DESC`).\n" }, { "name": "sortBy", "value": "", "type": "query", "description": "The field to sort chargeback plans.\n" }, { "name": "compartmentIdInSubtree", "value": "", "type": "query", "description": "A flag to search all resources within a given compartment and all sub-compartments.\n" } ] }, "docs": "Gets a list of Ops Insights chargeback plans." }, { "info": { "name": "Create an Ops Insights chargeback plan resource", "type": "http" }, "http": { "method": "POST", "url": "http://127.0.0.1/20200630/chargebackPlans", "headers": [ { "name": "opc-retry-token", "value": "" }, { "name": "opc-request-id", "value": "" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Create a chargeback plan resource for the resource in Ops Insights.\n" }, { "info": { "name": "Gets the details of the specified chargeback plan", "type": "http" }, "http": { "method": "GET", "url": "http://127.0.0.1/20200630/chargebackPlans/:chargebackplanId", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "chargebackplanId", "value": "", "type": "path", "description": "The [OCID](/Content/General/Concepts/identifiers.htm) of the Ops Insights chargeback plan." } ] }, "docs": "Gets the details of the specified chargeback plan." }, { "info": { "name": "Updates one or more attributes of the specified chargeback plan.", "type": "http" }, "http": { "method": "PUT", "url": "http://127.0.0.1/20200630/chargebackPlans/:chargebackplanId", "headers": [ { "name": "if-match", "value": "" }, { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "chargebackplanId", "value": "", "type": "path", "description": "The [OCID](/Content/General/Concepts/identifiers.htm) of the Ops Insights chargeback plan." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Updates one or more attributes of the specified chargeback plan." }, { "info": { "name": "Deletes a chargeback plan.", "type": "http" }, "http": { "method": "DELETE", "url": "http://127.0.0.1/20200630/chargebackPlans/:chargebackplanId", "headers": [ { "name": "if-match", "value": "" }, { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "chargebackplanId", "value": "", "type": "path", "description": "The [OCID](/Content/General/Concepts/identifiers.htm) of the Ops Insights chargeback plan." } ] }, "docs": "Deletes a chargeback plan if it's not assigned to any resource." }, { "info": { "name": "Moves a resource into a different compartment.", "type": "http" }, "http": { "method": "POST", "url": "http://127.0.0.1/20200630/chargebackPlans/:chargebackplanId/actions/changeCompartment", "headers": [ { "name": "if-match", "value": "" }, { "name": "opc-request-id", "value": "" }, { "name": "opc-retry-token", "value": "" } ], "params": [ { "name": "chargebackplanId", "value": "", "type": "path", "description": "The [OCID](/Content/General/Concepts/identifiers.htm) of the Ops Insights chargeback plan." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Moves a Chargeback Plan insight resource from one compartment identifier to another. When provided, If-Match is checked against ETag values of the resource." }, { "info": { "name": "Gets a list of database insights.", "type": "http" }, "http": { "method": "GET", "url": "http://127.0.0.1/20200630/databaseInsights", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "compartmentId", "value": "", "type": "query", "description": "The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compartment." }, { "name": "enterpriseManagerBridgeId", "value": "", "type": "query", "description": "Unique Enterprise Manager bridge identifier" }, { "name": "id", "value": "", "type": "query", "description": "Optional list of database insight resource [OCIDs](/iaas/Content/General/Concepts/identifiers.htm).\n" }, { "name": "status", "value": "", "type": "query", "description": "Resource Status" }, { "name": "lifecycleState", "value": "", "type": "query", "description": "Lifecycle states" }, { "name": "databaseType", "value": "", "type": "query", "description": "Filter by one or more database type.\nPossible values are ADW-S, ATP-S, ADW-D, ATP-D, EXTERNAL-PDB, EXTERNAL-NONCDB.\n" }, { "name": "databaseId", "value": "", "type": "query", "description": "Optional list of database [OCIDs](/iaas/Content/General/Concepts/identifiers.htm) of the associated DBaaS entity.\n" }, { "name": "fields", "value": "", "type": "query", "description": "Specifies the fields to return in a database summary response. By default all fields are returned if omitted.\n" }, { "name": "limit", "value": "", "type": "query", "description": "For list pagination. The maximum number of results per page, or items to\nreturn in a paginated \"List\" call.\nFor important details about how pagination works, see\n[List Pagination](/Content/API/Concepts/usingapi.htm#nine).\nExample: `50`\n" }, { "name": "page", "value": "", "type": "query", "description": "For list pagination. The value of the `opc-next-page` response header from\nthe previous \"List\" call. For important details about how pagination works,\nsee [List Pagination](/Content/API/Concepts/usingapi.htm#nine).\n" }, { "name": "sortOrder", "value": "", "type": "query", "description": "The sort order to use, either ascending (`ASC`) or descending (`DESC`).\n" }, { "name": "sortBy", "value": "", "type": "query", "description": "Database insight list sort options. If `fields` parameter is selected, the `sortBy` parameter must be one of the fields specified.\n" }, { "name": "exadataInsightId", "value": "", "type": "query", "description": "[OCID](/iaas/Content/General/Concepts/identifiers.htm) of exadata insight resource.\n" }, { "name": "compartmentIdInSubtree", "value": "", "type": "query", "description": "A flag to search all resources within a given compartment and all sub-compartments.\n" }, { "name": "opsiPrivateEndpointId", "value": "", "type": "query", "description": "Unique Operations Insights PrivateEndpoint identifier" } ] }, "docs": "Gets a list of database insights based on the query parameters specified. Either compartmentId or id query parameter must be specified.\nWhen both compartmentId and compartmentIdInSubtree are specified, a list of database insights in that compartment and in all sub-compartments will be returned.\n" }, { "info": { "name": "Create a Database Insight resource for a database in Operations Insights.", "type": "http" }, "http": { "method": "POST", "url": "http://127.0.0.1/20200630/databaseInsights", "headers": [ { "name": "opc-retry-token", "value": "" }, { "name": "opc-request-id", "value": "" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Create a Database Insight resource for a database in Operations Insights. The database will be enabled in Operations Insights. Database metric collection and analysis will be started.\n" }, { "info": { "name": "Accepts the addm reports payload and persists it in Operation Insights ingest pipeline.", "type": "http" }, "http": { "method": "POST", "url": "http://127.0.0.1/20200630/databaseInsights/actions/ingestAddmReports", "headers": [ { "name": "opc-request-id", "value": "" }, { "name": "if-match", "value": "" }, { "name": "opc-retry-token", "value": "" } ], "params": [ { "name": "databaseId", "value": "", "type": "query", "description": "Optional [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the associated DBaaS entity.\n" }, { "name": "id", "value": "", "type": "query", "description": "[OCID](/iaas/Content/General/Concepts/identifiers.htm) of the database insight resource.\n" } ], "body": { "type": "json", "data": "{}" } }, "docs": "This endpoint takes in a JSON payload, persists it in Operation Insights ingest pipeline.\nEither databaseId or id must be specified.\n" }, { "info": { "name": "Accepts the database configuration metrics payload and persists it in the Ops Insights Service.", "type": "http" }, "http": { "method": "POST", "url": "http://127.0.0.1/20200630/databaseInsights/actions/ingestDatabaseConfiguration", "headers": [ { "name": "opc-request-id", "value": "" }, { "name": "if-match", "value": "" }, { "name": "opc-retry-token", "value": "" } ], "params": [ { "name": "databaseId", "value": "", "type": "query", "description": "Optional [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the associated DBaaS entity.\n" }, { "name": "id", "value": "", "type": "query", "description": "[OCID](/iaas/Content/General/Concepts/identifiers.htm) of the database insight resource.\n" } ], "body": { "type": "json", "data": "{}" } }, "docs": "This is a generic ingest endpoint for all database configuration metrics." }, { "info": { "name": "Accepts the MySql SQL Stats metrics payload and persists it in Ops Insights ingest pipeline.", "type": "http" }, "http": { "method": "POST", "url": "http://127.0.0.1/20200630/databaseInsights/actions/ingestMySqlSqlStatsMetric", "headers": [ { "name": "opc-request-id", "value": "" }, { "name": "if-match", "value": "" }, { "name": "opc-retry-token", "value": "" } ], "params": [ { "name": "databaseId", "value": "", "type": "query", "description": "Optional [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the associated DBaaS entity.\n" }, { "name": "id", "value": "", "type": "query", "description": "[OCID](/iaas/Content/General/Concepts/identifiers.htm) of the database insight resource.\n" } ], "body": { "type": "json", "data": "{}" } }, "docs": "The MySql SQL Stats endpoint takes in a JSON payload, persists it in Ops Insights ingest pipeline.\nEither databaseId or id must be specified.\n" }, { "info": { "name": "Accepts the sql text metrics payload and persists it in Operation Insights ingest pipeline.", "type": "http" }, "http": { "method": "POST", "url": "http://127.0.0.1/20200630/databaseInsights/actions/ingestMySqlSqlText", "headers": [ { "name": "opc-request-id", "value": "" }, { "name": "if-match", "value": "" }, { "name": "opc-retry-token", "value": "" } ], "params": [ { "name": "compartmentId", "value": "", "type": "query", "description": "The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compartment." }, { "name": "databaseId", "value": "", "type": "query", "description": "Optional [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the associated DBaaS entity.\n" }, { "name": "id", "value": "", "type": "query", "description": "[OCID](/iaas/Content/General/Concepts/identifiers.htm) of the database insight resource.\n" } ], "body": { "type": "json", "data": "{}" } }, "docs": "The SqlText endpoint takes in a JSON payload, persists it in Operation Insights ingest pipeline.\nEither databaseId or id must be specified.\nDisclaimer: SQL text being uploaded explicitly via APIs is already masked. All sensitive literals contained in the sqlFullText column are masked prior to ingestion.\n" }, { "info": { "name": "Accepts the bucket metrics payload and persists it in Ops Insights ingest pipeline.", "type": "http" }, "http": { "method": "POST", "url": "http://127.0.0.1/20200630/databaseInsights/actions/ingestSqlBucket", "headers": [ { "name": "opc-request-id", "value": "" }, { "name": "if-match", "value": "" }, { "name": "opc-retry-token", "value": "" } ], "params": [ { "name": "compartmentId", "value": "", "type": "query", "description": "The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compartment." }, { "name": "databaseId", "value": "", "type": "query", "description": "Optional [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the associated DBaaS entity.\n" }, { "name": "id", "value": "", "type": "query", "description": "[OCID](/iaas/Content/General/Concepts/identifiers.htm) of the database insight resource.\n" } ], "body": { "type": "json", "data": "{}" } }, "docs": "The sqlbucket endpoint takes in a JSON payload, persists it in Ops Insights ingest pipeline.\nEither databaseId or id must be specified.\n" }, { "info": { "name": "Accepts the sql plan lines payload and persists it in Operation Insights ingest pipeline.", "type": "http" }, "http": { "method": "POST", "url": "http://127.0.0.1/20200630/databaseInsights/actions/ingestSqlPlanLines", "headers": [ { "name": "opc-request-id", "value": "" }, { "name": "if-match", "value": "" }, { "name": "opc-retry-token", "value": "" } ], "params": [ { "name": "compartmentId", "value": "", "type": "query", "description": "The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compartment." }, { "name": "databaseId", "value": "", "type": "query", "description": "Optional [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the associated DBaaS entity.\n" }, { "name": "id", "value": "", "type": "query", "description": "[OCID](/iaas/Content/General/Concepts/identifiers.htm) of the database insight resource.\n" } ], "body": { "type": "json", "data": "{}" } }, "docs": "The SqlPlanLines endpoint takes in a JSON payload, persists it in Operation Insights ingest pipeline.\nEither databaseId or id must be specified.\n" }, { "info": { "name": "Accepts the SQL Stats metrics payload and persists it in Ops Insights ingest pipeline.", "type": "http" }, "http": { "method": "POST", "url": "http://127.0.0.1/20200630/databaseInsights/actions/ingestSqlStatsMetric", "headers": [ { "name": "opc-request-id", "value": "" }, { "name": "if-match", "value": "" }, { "name": "opc-retry-token", "value": "" } ], "params": [ { "name": "databaseId", "value": "", "type": "query", "description": "Optional [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the associated DBaaS entity.\n" }, { "name": "id", "value": "", "type": "query", "description": "[OCID](/iaas/Content/General/Concepts/identifiers.htm) of the database insight resource.\n" } ], "body": { "type": "json", "data": "{}" } }, "docs": "The SQL Stats endpoint takes in a JSON payload, persists it in Ops Insights ingest pipeline.\nEither databaseId or id must be specified.\n" }, { "info": { "name": "Accepts the sql text metrics payload and persists it in Operation Insights ingest pipeline.", "type": "http" }, "http": { "method": "POST", "url": "http://127.0.0.1/20200630/databaseInsights/actions/ingestSqlText", "headers": [ { "name": "opc-request-id", "value": "" }, { "name": "if-match", "value": "" }, { "name": "opc-retry-token", "value": "" } ], "params": [ { "name": "compartmentId", "value": "", "type": "query", "description": "The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compartment." }, { "name": "databaseId", "value": "", "type": "query", "description": "Optional [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the associated DBaaS entity.\n" }, { "name": "id", "value": "", "type": "query", "description": "[OCID](/iaas/Content/General/Concepts/identifiers.htm) of the database insight resource.\n" } ], "body": { "type": "json", "data": "{}" } }, "docs": "The SqlText endpoint takes in a JSON payload, persists it in Operation Insights ingest pipeline.\nEither databaseId or id must be specified.\nDisclaimer: SQL text being uploaded explicitly via APIs is not masked. Any sensitive literals contained in the sqlFullText column should be masked prior to ingestion.\n" }, { "info": { "name": "Test the connection details of a Cloud MACS-managed database.", "type": "http" }, "http": { "method": "POST", "url": "http://127.0.0.1/20200630/databaseInsights/actions/testMacsManagedCloudDatabaseInsightConnectionDetails", "headers": [ { "name": "opc-request-id", "value": "" }, { "name": "opc-retry-token", "value": "" } ], "params": [ { "name": "databaseId", "value": "", "type": "query", "description": "Optional [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the associated DBaaS entity.\n" }, { "name": "id", "value": "", "type": "query", "description": "[OCID](/iaas/Content/General/Concepts/identifiers.htm) of the database insight resource.\n" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Test the connection details of a Cloud MACS-managed database." }, { "info": { "name": "Gets list of ADDM finding categories", "type": "http" }, "http": { "method": "GET", "url": "http://127.0.0.1/20200630/databaseInsights/addmDbFindingCategories", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "compartmentId", "value": "", "type": "query", "description": "The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compartment." }, { "name": "databaseId", "value": "", "type": "query", "description": "Optional list of database [OCIDs](/iaas/Content/General/Concepts/identifiers.htm) of the associated DBaaS entity.\n" }, { "name": "id", "value": "", "type": "query", "description": "Optional list of database insight resource [OCIDs](/iaas/Content/General/Concepts/identifiers.htm).\n" }, { "name": "limit", "value": "", "type": "query", "description": "For list pagination. The maximum number of results per page, or items to\nreturn in a paginated \"List\" call.\nFor important details about how pagination works, see\n[List Pagination](/Content/API/Concepts/usingapi.htm#nine).\nExample: `50`\n" }, { "name": "page", "value": "", "type": "query", "description": "For list pagination. The value of the `opc-next-page` response header from\nthe previous \"List\" call. For important details about how pagination works,\nsee [List Pagination](/Content/API/Concepts/usingapi.htm#nine).\n" }, { "name": "sortOrder", "value": "", "type": "query", "description": "The sort order to use, either ascending (`ASC`) or descending (`DESC`).\n" }, { "name": "sortBy", "value": "", "type": "query", "description": "Field name for sorting the finding categories" }, { "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" }, { "name": "compartmentIdInSubtree", "value": "", "type": "query", "description": "A flag to search all resources within a given compartment and all sub-compartments.\n" } ] }, "docs": "Gets list of ADDM finding categories.\n" }, { "info": { "name": "Summarizes ADDM findings for the specified databases", "type": "http" }, "http": { "method": "GET", "url": "http://127.0.0.1/20200630/databaseInsights/addmDbFindings", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "compartmentId", "value": "", "type": "query", "description": "The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compartment." }, { "name": "databaseId", "value": "", "type": "query", "description": "Optional list of database [OCIDs](/iaas/Content/General/Concepts/identifiers.htm) of the associated DBaaS entity.\n" }, { "name": "id", "value": "", "type": "query", "description": "Optional list of database insight resource [OCIDs](/iaas/Content/General/Concepts/identifiers.htm).\n" }, { "name": "instanceNumber", "value": "", "type": "query", "description": "The optional single value query parameter to filter by database instance number." }, { "name": "timeIntervalStart", "value": "", "type": "query", "description": "Analysis start time in UTC in ISO 8601 format(inclusive).\nExample 2019-10-30T00:00:00Z (yyyy-MM-ddThh:mm:ssZ).\nThe minimum allowed value is 2 years prior to the current day.\ntimeIntervalStart and timeIntervalEnd parameters are used together.\nIf analysisTimeInterval is specified, this parameter is ignored.\n" }, { "name": "timeIntervalEnd", "value": "", "type": "query", "description": "Analysis end time in UTC in ISO 8601 format(exclusive).\nExample 2019-10-30T00:00:00Z (yyyy-MM-ddThh:mm:ssZ).\ntimeIntervalStart and timeIntervalEnd are used together.\nIf timeIntervalEnd is not specified, current time is used as timeIntervalEnd.\n" }, { "name": "categoryName", "value": "", "type": "query", "description": "Optional value filter to match the finding category exactly.\n" }, { "name": "limit", "value": "", "type": "query", "description": "For list pagination. The maximum number of results per page, or items to\nreturn in a paginated \"List\" call.\nFor important details about how pagination works, see\n[List Pagination](/Content/API/Concepts/usingapi.htm#nine).\nExample: `50`\n" }, { "name": "page", "value": "", "type": "query", "description": "For list pagination. The value of the `opc-next-page` response header from\nthe previous \"List\" call. For important details about how pagination works,\nsee [List Pagination](/Content/API/Concepts/usingapi.htm#nine).\n" }, { "name": "sortOrder", "value": "", "type": "query", "description": "The sort order to use, either ascending (`ASC`) or descending (`DESC`).\n" }, { "name": "sortBy", "value": "", "type": "query", "description": "Field name for sorting the ADDM finding summary data" }, { "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" }, { "name": "compartmentIdInSubtree", "value": "", "type": "query", "description": "A flag to search all resources within a given compartment and all sub-compartments.\n" } ] }, "docs": "Summarizes ADDM findings for the specified databases.\n" }, { "info": { "name": "Get the ADDM findings time series for the specified databases.", "type": "http" }, "http": { "method": "GET", "url": "http://127.0.0.1/20200630/databaseInsights/addmDbFindingsTimeSeries", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "compartmentId", "value": "", "type": "query", "description": "The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compartment." }, { "name": "databaseId", "value": "", "type": "query", "description": "Optional list of database [OCIDs](/iaas/Content/General/Concepts/identifiers.htm) of the associated DBaaS entity.\n" }, { "name": "id", "value": "", "type": "query", "description": "Optional list of database insight resource [OCIDs](/iaas/Content/General/Concepts/identifiers.htm).\n" }, { "name": "instanceNumber", "value": "", "type": "query", "description": "The optional single value query parameter to filter by database instance number." }, { "name": "timeIntervalStart", "value": "", "type": "query", "description": "Analysis start time in UTC in ISO 8601 format(inclusive).\nExample 2019-10-30T00:00:00Z (yyyy-MM-ddThh:mm:ssZ).\nThe minimum allowed value is 2 years prior to the current day.\ntimeIntervalStart and timeIntervalEnd parameters are used together.\nIf analysisTimeInterval is specified, this parameter is ignored.\n" }, { "name": "timeIntervalEnd", "value": "", "type": "query", "description": "Analysis end time in UTC in ISO 8601 format(exclusive).\nExample 2019-10-30T00:00:00Z (yyyy-MM-ddThh:mm:ssZ).\ntimeIntervalStart and timeIntervalEnd are used together.\nIf timeIntervalEnd is not specified, current time is used as timeIntervalEnd.\n" }, { "name": "categoryName", "value": "", "type": "query", "description": "Optional value filter to match the finding category exactly.\n" }, { "name": "limit", "value": "", "type": "query", "description": "For list pagination. The maximum number of results per page, or items to\nreturn in a paginated \"List\" call.\nFor important details about how pagination works, see\n[List Pagination](/Content/API/Concepts/usingapi.htm#nine).\nExample: `50`\n" }, { "name": "page", "value": "", "type": "query", "description": "For list pagination. The value of the `opc-next-page` response header from\nthe previous \"List\" call. For important details about how pagination works,\nsee [List Pagination](/Content/API/Concepts/usingapi.htm#nine).\n" }, { "name": "sortOrder", "value": "", "type": "query", "description": "The sort order to use, either ascending (`ASC`) or descending (`DESC`).\n" }, { "name": "sortBy", "value": "", "type": "query", "description": "Field name for sorting the ADDM finding time series summary data\n" }, { "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" }, { "name": "compartmentIdInSubtree", "value": "", "type": "query", "description": "A flag to search all resources within a given compartment and all sub-compartments.\n" } ] }, "docs": "Get the ADDM findings time series for the specified databases for a given time period.\n" }, { "info": { "name": "Gets list of ADDM database parameter categories", "type": "http" }, "http": { "method": "GET", "url": "http://127.0.0.1/20200630/databaseInsights/addmDbParameterCategories", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "compartmentId", "value": "", "type": "query", "description": "The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compartment." }, { "name": "databaseId", "value": "", "type": "query", "description": "Optional list of database [OCIDs](/iaas/Content/General/Concepts/identifiers.htm) of the associated DBaaS entity.\n" }, { "name": "id", "value": "", "type": "query", "description": "Optional list of database insight resource [OCIDs](/iaas/Content/General/Concepts/identifiers.htm).\n" }, { "name": "limit", "value": "", "type": "query", "description": "For list pagination. The maximum number of results per page, or items to\nreturn in a paginated \"List\" call.\nFor important details about how pagination works, see\n[List Pagination](/Content/API/Concepts/usingapi.htm#nine).\nExample: `50`\n" }, { "name": "page", "value": "", "type": "query", "description": "For list pagination. The value of the `opc-next-page` response header from\nthe previous \"List\" call. For important details about how pagination works,\nsee [List Pagination](/Content/API/Concepts/usingapi.htm#nine).\n" }, { "name": "sortOrder", "value": "", "type": "query", "description": "The sort order to use, either ascending (`ASC`) or descending (`DESC`).\n" }, { "name": "sortBy", "value": "", "type": "query", "description": "Field name for sorting the database parameter categories" }, { "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" }, { "name": "compartmentIdInSubtree", "value": "", "type": "query", "description": "A flag to search all resources within a given compartment and all sub-compartments.\n" } ] }, "docs": "Gets list of ADDM database parameter categories for the specified databases.\n" }, { "info": { "name": "Summarizes the AWR database parameter change history", "type": "http" }, "http": { "method": "GET", "url": "http://127.0.0.1/20200630/databaseInsights/addmDbParameterChanges", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "compartmentId", "value": "", "type": "query", "description": "The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compartment." }, { "name": "databaseId", "value": "", "type": "query", "description": "Optional list of database [OCIDs](/iaas/Content/General/Concepts/identifiers.htm) of the associated DBaaS entity.\n" }, { "name": "id", "value": "", "type": "query", "description": "Optional list of database insight resource [OCIDs](/iaas/Content/General/Concepts/identifiers.htm).\n" }, { "name": "instanceNumber", "value": "", "type": "query", "description": "The optional single value query parameter to filter by database instance number." }, { "name": "timeIntervalStart", "value": "", "type": "query", "description": "Analysis start time in UTC in ISO 8601 format(inclusive).\nExample 2019-10-30T00:00:00Z (yyyy-MM-ddThh:mm:ssZ).\nThe minimum allowed value is 2 years prior to the current day.\ntimeIntervalStart and timeIntervalEnd parameters are used together.\nIf analysisTimeInterval is specified, this parameter is ignored.\n" }, { "name": "timeIntervalEnd", "value": "", "type": "query", "description": "Analysis end time in UTC in ISO 8601 format(exclusive).\nExample 2019-10-30T00:00:00Z (yyyy-MM-ddThh:mm:ssZ).\ntimeIntervalStart and timeIntervalEnd are used together.\nIf timeIntervalEnd is not specified, current time is used as timeIntervalEnd.\n" }, { "name": "name", "value": "", "type": "query", "description": "Required filter to return only changes for the specified parameter. The\nmatch is case sensitive.\n" }, { "name": "valueContains", "value": "", "type": "query", "description": "Optional filter to return only resources whose value contains the substring given. The\nmatch is not case sensitive.\n" }, { "name": "limit", "value": "", "type": "query", "description": "For list pagination. The maximum number of results per page, or items to\nreturn in a paginated \"List\" call.\nFor important details about how pagination works, see\n[List Pagination](/Content/API/Concepts/usingapi.htm#nine).\nExample: `50`\n" }, { "name": "page", "value": "", "type": "query", "description": "For list pagination. The value of the `opc-next-page` response header from\nthe previous \"List\" call. For important details about how pagination works,\nsee [List Pagination](/Content/API/Concepts/usingapi.htm#nine).\n" }, { "name": "sortOrder", "value": "", "type": "query", "description": "The sort order to use, either ascending (`ASC`) or descending (`DESC`).\n" }, { "name": "sortBy", "value": "", "type": "query", "description": "Field name for sorting the database parameter change data" }, { "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" }, { "name": "compartmentIdInSubtree", "value": "", "type": "query", "description": "A flag to search all resources within a given compartment and all sub-compartments.\n" } ] }, "docs": "Summarizes the AWR database parameter change history for the specified parameter. There will\nbe one element for each time that parameter changed during the specified time period.\nThis API is limited to only one parameter per request.\n" }, { "info": { "name": "Summarizes database parameter history information", "type": "http" }, "http": { "method": "GET", "url": "http://127.0.0.1/20200630/databaseInsights/addmDbParameters", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "compartmentId", "value": "", "type": "query", "description": "The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compartment." }, { "name": "databaseId", "value": "", "type": "query", "description": "Optional list of database [OCIDs](/iaas/Content/General/Concepts/identifiers.htm) of the associated DBaaS entity.\n" }, { "name": "id", "value": "", "type": "query", "description": "Optional list of database insight resource [OCIDs](/iaas/Content/General/Concepts/identifiers.htm).\n" }, { "name": "instanceNumber", "value": "", "type": "query", "description": "The optional single value query parameter to filter by database instance number." }, { "name": "timeIntervalStart", "value": "", "type": "query", "description": "Analysis start time in UTC in ISO 8601 format(inclusive).\nExample 2019-10-30T00:00:00Z (yyyy-MM-ddThh:mm:ssZ).\nThe minimum allowed value is 2 years prior to the current day.\ntimeIntervalStart and timeIntervalEnd parameters are used together.\nIf analysisTimeInterval is specified, this parameter is ignored.\n" }, { "name": "timeIntervalEnd", "value": "", "type": "query", "description": "Analysis end time in UTC in ISO 8601 format(exclusive).\nExample 2019-10-30T00:00:00Z (yyyy-MM-ddThh:mm:ssZ).\ntimeIntervalStart and timeIntervalEnd are used together.\nIf timeIntervalEnd is not specified, current time is used as timeIntervalEnd.\n" }, { "name": "categoryName", "value": "", "type": "query", "description": "Optional value filter to match the parameter category exactly. Note the list of possible\ncategory names can be retrieved from the following endpoint:\n/databases/{databaseId}/addmDbParameterCategories.\n" }, { "name": "nameOrValueContains", "value": "", "type": "query", "description": "Optional filter to return only resources whose name or value contains the substring given. The\nmatch is not case sensitive.\n" }, { "name": "isChanged", "value": "", "type": "query", "description": "Optional filter to return only parameters whose value changed in the specified time period.\nValid values include: TRUE, FALSE\n" }, { "name": "isDefault", "value": "", "type": "query", "description": "Optional filter to return only parameters whose end value was set to the default value (TRUE)\nor was specified in the parameter file (FALSE). Valid values include: TRUE, FALSE\n" }, { "name": "hasRecommendations", "value": "", "type": "query", "description": "Optional filter to return only parameters which have recommendations in the specified time period.\nValid values include: TRUE, FALSE\n" }, { "name": "limit", "value": "", "type": "query", "description": "For list pagination. The maximum number of results per page, or items to\nreturn in a paginated \"List\" call.\nFor important details about how pagination works, see\n[List Pagination](/Content/API/Concepts/usingapi.htm#nine).\nExample: `50`\n" }, { "name": "page", "value": "", "type": "query", "description": "For list pagination. The value of the `opc-next-page` response header from\nthe previous \"List\" call. For important details about how pagination works,\nsee [List Pagination](/Content/API/Concepts/usingapi.htm#nine).\n" }, { "name": "sortOrder", "value": "", "type": "query", "description": "The sort order to use, either ascending (`ASC`) or descending (`DESC`).\n" }, { "name": "sortBy", "value": "", "type": "query", "description": "Field name for sorting the database parameter data" }, { "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" }, { "name": "compartmentIdInSubtree", "value": "", "type": "query", "description": "A flag to search all resources within a given compartment and all sub-compartments.\n" } ] }, "docs": "Summarizes database parameter history information for the specified databases. Return a list of parameters\nwith information on whether the parameter values were changed or not within the specified\ntime period. The response does not include the individual parameter changes within the time\nperiod.\n" }, { "info": { "name": "Gets list of ADDM recommendation categories", "type": "http" }, "http": { "method": "GET", "url": "http://127.0.0.1/20200630/databaseInsights/addmDbRecommendationCategories", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "compartmentId", "value": "", "type": "query", "description": "The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compartment." }, { "name": "databaseId", "value": "", "type": "query", "description": "Optional list of database [OCIDs](/iaas/Content/General/Concepts/identifiers.htm) of the associated DBaaS entity.\n" }, { "name": "id", "value": "", "type": "query", "description": "Optional list of database insight resource [OCIDs](/iaas/Content/General/Concepts/identifiers.htm).\n" }, { "name": "limit", "value": "", "type": "query", "description": "For list pagination. The maximum number of results per page, or items to\nreturn in a paginated \"List\" call.\nFor important details about how pagination works, see\n[List Pagination](/Content/API/Concepts/usingapi.htm#nine).\nExample: `50`\n" }, { "name": "page", "value": "", "type": "query", "description": "For list pagination. The value of the `opc-next-page` response header from\nthe previous \"List\" call. For important details about how pagination works,\nsee [List Pagination](/Content/API/Concepts/usingapi.htm#nine).\n" }, { "name": "sortOrder", "value": "", "type": "query", "description": "The sort order to use, either ascending (`ASC`) or descending (`DESC`).\n" }, { "name": "sortBy", "value": "", "type": "query", "description": "Field name for sorting the recommendation categories" }, { "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" }, { "name": "compartmentIdInSubtree", "value": "", "type": "query", "description": "A flag to search all resources within a given compartment and all sub-compartments.\n" } ] }, "docs": "Gets list of ADDM recommendation categories for the specified databases.\n" }, { "info": { "name": "Summarizes ADDM recommendations for the specified databases", "type": "http" }, "http": { "method": "GET", "url": "http://127.0.0.1/20200630/databaseInsights/addmDbRecommendations", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "compartmentId", "value": "", "type": "query", "description": "The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compartment." }, { "name": "databaseId", "value": "", "type": "query", "description": "Optional list of database [OCIDs](/iaas/Content/General/Concepts/identifiers.htm) of the associated DBaaS entity.\n" }, { "name": "id", "value": "", "type": "query", "description": "Optional list of database insight resource [OCIDs](/iaas/Content/General/Concepts/identifiers.htm).\n" }, { "name": "instanceNumber", "value": "", "type": "query", "description": "The optional single value query parameter to filter by database instance number." }, { "name": "timeIntervalStart", "value": "", "type": "query", "description": "Analysis start time in UTC in ISO 8601 format(inclusive).\nExample 2019-10-30T00:00:00Z (yyyy-MM-ddThh:mm:ssZ).\nThe minimum allowed value is 2 years prior to the current day.\ntimeIntervalStart and timeIntervalEnd parameters are used together.\nIf analysisTimeInterval is specified, this parameter is ignored.\n" }, { "name": "timeIntervalEnd", "value": "", "type": "query", "description": "Analysis end time in UTC in ISO 8601 format(exclusive).\nExample 2019-10-30T00:00:00Z (yyyy-MM-ddThh:mm:ssZ).\ntimeIntervalStart and timeIntervalEnd are used together.\nIf timeIntervalEnd is not specified, current time is used as timeIntervalEnd.\n" }, { "name": "categoryName", "value": "", "type": "query", "description": "Optional value filter to match the finding category exactly.\n" }, { "name": "findingIdentifier", "value": "", "type": "query", "description": "Unique finding ID" }, { "name": "sqlIdentifier", "value": "", "type": "query", "description": "Optional filter to return only resources whose sql id matches the value given. Only considered when\ncategoryName is SQL_TUNING.\n" }, { "name": "ownerOrNameContains", "value": "", "type": "query", "description": "Optional filter to return only resources whose owner or name contains the substring given. The\nmatch is not case sensitive. Only considered when categoryName is SCHEMA_OBJECT.\n" }, { "name": "nameContains", "value": "", "type": "query", "description": "Optional filter to return only resources whose name contains the substring given. The\nmatch is not case sensitive. Only considered when categoryName is DATABASE_CONFIGURATION.\n" }, { "name": "name", "value": "", "type": "query", "description": "Optional filter to return only resources whose name exactly matches the substring given. The\nmatch is case sensitive. Only considered when categoryName is DATABASE_CONFIGURATION.\n" }, { "name": "limit", "value": "", "type": "query", "description": "For list pagination. The maximum number of results per page, or items to\nreturn in a paginated \"List\" call.\nFor important details about how pagination works, see\n[List Pagination](/Content/API/Concepts/usingapi.htm#nine).\nExample: `50`\n" }, { "name": "page", "value": "", "type": "query", "description": "For list pagination. The value of the `opc-next-page` response header from\nthe previous \"List\" call. For important details about how pagination works,\nsee [List Pagination](/Content/API/Concepts/usingapi.htm#nine).\n" }, { "name": "sortOrder", "value": "", "type": "query", "description": "The sort order to use, either ascending (`ASC`) or descending (`DESC`).\n" }, { "name": "sortBy", "value": "", "type": "query", "description": "Field name for sorting the recommendation data" }, { "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" }, { "name": "compartmentIdInSubtree", "value": "", "type": "query", "description": "A flag to search all resources within a given compartment and all sub-compartments.\n" } ] }, "docs": "Summarizes ADDM recommendations for the specified databases.\n" }, { "info": { "name": "Gets time series data for ADDM recommendations for the specified databases", "type": "http" }, "http": { "method": "GET", "url": "http://127.0.0.1/20200630/databaseInsights/addmDbRecommendationsTimeSeries", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "compartmentId", "value": "", "type": "query", "description": "The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compartment." }, { "name": "databaseId", "value": "", "type": "query", "description": "Optional list of database [OCIDs](/iaas/Content/General/Concepts/identifiers.htm) of the associated DBaaS entity.\n" }, { "name": "id", "value": "", "type": "query", "description": "Optional list of database insight resource [OCIDs](/iaas/Content/General/Concepts/identifiers.htm).\n" }, { "name": "instanceNumber", "value": "", "type": "query", "description": "The optional single value query parameter to filter by database instance number." }, { "name": "timeIntervalStart", "value": "", "type": "query", "description": "Analysis start time in UTC in ISO 8601 format(inclusive).\nExample 2019-10-30T00:00:00Z (yyyy-MM-ddThh:mm:ssZ).\nThe minimum allowed value is 2 years prior to the current day.\ntimeIntervalStart and timeIntervalEnd parameters are used together.\nIf analysisTimeInterval is specified, this parameter is ignored.\n" }, { "name": "timeIntervalEnd", "value": "", "type": "query", "description": "Analysis end time in UTC in ISO 8601 format(exclusive).\nExample 2019-10-30T00:00:00Z (yyyy-MM-ddThh:mm:ssZ).\ntimeIntervalStart and timeIntervalEnd are used together.\nIf timeIntervalEnd is not specified, current time is used as timeIntervalEnd.\n" }, { "name": "categoryName", "value": "", "type": "query", "description": "Optional value filter to match the finding category exactly.\n" }, { "name": "sqlIdentifier", "value": "", "type": "query", "description": "Optional filter to return only resources whose sql id matches the value given. Only considered when\ncategoryName is SQL_TUNING.\n" }, { "name": "ownerOrNameContains", "value": "", "type": "query", "description": "Optional filter to return only resources whose owner or name contains the substring given. The\nmatch is not case sensitive. Only considered when categoryName is SCHEMA_OBJECT.\n" }, { "name": "nameContains", "value": "", "type": "query", "description": "Optional filter to return only resources whose name contains the substring given. The\nmatch is not case sensitive. Only considered when categoryName is DATABASE_CONFIGURATION.\n" }, { "name": "name", "value": "", "type": "query", "description": "Optional filter to return only resources whose name exactly matches the substring given. The\nmatch is case sensitive. Only considered when categoryName is DATABASE_CONFIGURATION.\n" }, { "name": "limit", "value": "", "type": "query", "description": "For list pagination. The maximum number of results per page, or items to\nreturn in a paginated \"List\" call.\nFor important details about how pagination works, see\n[List Pagination](/Content/API/Concepts/usingapi.htm#nine).\nExample: `50`\n" }, { "name": "page", "value": "", "type": "query", "description": "For list pagination. The value of the `opc-next-page` response header from\nthe previous \"List\" call. For important details about how pagination works,\nsee [List Pagination](/Content/API/Concepts/usingapi.htm#nine).\n" }, { "name": "sortOrder", "value": "", "type": "query", "description": "The sort order to use, either ascending (`ASC`) or descending (`DESC`).\n" }, { "name": "sortBy", "value": "", "type": "query", "description": "Field name for sorting the ADDM recommendation time series summary data" }, { "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" }, { "name": "compartmentIdInSubtree", "value": "", "type": "query", "description": "A flag to search all resources within a given compartment and all sub-compartments.\n" } ] }, "docs": "Gets time series data for ADDM recommendations for the specified databases.\n" }, { "info": { "name": "Summarizes Schema objects for the specified databases for the specified objectIdentifiers", "type": "http" }, "http": { "method": "GET", "url": "http://127.0.0.1/20200630/databaseInsights/addmDbSchemaObjects", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "compartmentId", "value": "", "type": "query", "description": "The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compartment." }, { "name": "databaseId", "value": "", "type": "query", "description": "Optional list of database [OCIDs](/iaas/Content/General/Concepts/identifiers.htm) of the associated DBaaS entity.\n" }, { "name": "id", "value": "", "type": "query", "description": "Optional list of database insight resource [OCIDs](/iaas/Content/General/Concepts/identifiers.htm).\n" }, { "name": "objectIdentifier", "value": "", "type": "query", "description": "One or more unique Object id (from RDBMS)\n" }, { "name": "timeIntervalStart", "value": "", "type": "query", "description": "Analysis start time in UTC in ISO 8601 format(inclusive).\nExample 2019-10-30T00:00:00Z (yyyy-MM-ddThh:mm:ssZ).\nThe minimum allowed value is 2 years prior to the current day.\ntimeIntervalStart and timeIntervalEnd parameters are used together.\nIf analysisTimeInterval is specified, this parameter is ignored.\n" }, { "name": "timeIntervalEnd", "value": "", "type": "query", "description": "Analysis end time in UTC in ISO 8601 format(exclusive).\nExample 2019-10-30T00:00:00Z (yyyy-MM-ddThh:mm:ssZ).\ntimeIntervalStart and timeIntervalEnd are used together.\nIf timeIntervalEnd is not specified, current time is used as timeIntervalEnd.\n" }, { "name": "limit", "value": "", "type": "query", "description": "For list pagination. The maximum number of results per page, or items to\nreturn in a paginated \"List\" call.\nFor important details about how pagination works, see\n[List Pagination](/Content/API/Concepts/usingapi.htm#nine).\nExample: `50`\n" }, { "name": "page", "value": "", "type": "query", "description": "For list pagination. The value of the `opc-next-page` response header from\nthe previous \"List\" call. For important details about how pagination works,\nsee [List Pagination](/Content/API/Concepts/usingapi.htm#nine).\n" }, { "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" }, { "name": "compartmentIdInSubtree", "value": "", "type": "query", "description": "A flag to search all resources within a given compartment and all sub-compartments.\n" } ] }, "docs": "Summarizes Schema objects for the specified databases for the specified objectIdentifiers\n" }, { "info": { "name": "Summarizes SQL Statements for the specified databases for the specified sqlIdentifiers", "type": "http" }, "http": { "method": "GET", "url": "http://127.0.0.1/20200630/databaseInsights/addmDbSqlStatements", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "compartmentId", "value": "", "type": "query", "description": "The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compartment." }, { "name": "databaseId", "value": "", "type": "query", "description": "Optional list of database [OCIDs](/iaas/Content/General/Concepts/identifiers.htm) of the associated DBaaS entity.\n" }, { "name": "id", "value": "", "type": "query", "description": "Optional list of database insight resource [OCIDs](/iaas/Content/General/Concepts/identifiers.htm).\n" }, { "name": "sqlIdentifier", "value": "", "type": "query", "description": "One or more unique SQL_IDs for a SQL Statement.\nExample: `6rgjh9bjmy2s7`\n" }, { "name": "timeIntervalStart", "value": "", "type": "query", "description": "Analysis start time in UTC in ISO 8601 format(inclusive).\nExample 2019-10-30T00:00:00Z (yyyy-MM-ddThh:mm:ssZ).\nThe minimum allowed value is 2 years prior to the current day.\ntimeIntervalStart and timeIntervalEnd parameters are used together.\nIf analysisTimeInterval is specified, this parameter is ignored.\n" }, { "name": "timeIntervalEnd", "value": "", "type": "query", "description": "Analysis end time in UTC in ISO 8601 format(exclusive).\nExample 2019-10-30T00:00:00Z (yyyy-MM-ddThh:mm:ssZ).\ntimeIntervalStart and timeIntervalEnd are used together.\nIf timeIntervalEnd is not specified, current time is used as timeIntervalEnd.\n" }, { "name": "limit", "value": "", "type": "query", "description": "For list pagination. The maximum number of results per page, or items to\nreturn in a paginated \"List\" call.\nFor important details about how pagination works, see\n[List Pagination](/Content/API/Concepts/usingapi.htm#nine).\nExample: `50`\n" }, { "name": "page", "value": "", "type": "query", "description": "For list pagination. The value of the `opc-next-page` response header from\nthe previous \"List\" call. For important details about how pagination works,\nsee [List Pagination](/Content/API/Concepts/usingapi.htm#nine).\n" }, { "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" }, { "name": "compartmentIdInSubtree", "value": "", "type": "query", "description": "A flag to search all resources within a given compartment and all sub-compartments.\n" } ] }, "docs": "Summarizes SQL Statements for the specified databases for the specified sqlIdentifiers\n" }, { "info": { "name": "Gets a list of ADDM database information", "type": "http" }, "http": { "method": "GET", "url": "http://127.0.0.1/20200630/databaseInsights/addmDbs", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "compartmentId", "value": "", "type": "query", "description": "The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compartment." }, { "name": "databaseId", "value": "", "type": "query", "description": "Optional list of database [OCIDs](/iaas/Content/General/Concepts/identifiers.htm) of the associated DBaaS entity.\n" }, { "name": "id", "value": "", "type": "query", "description": "Optional list of database insight resource [OCIDs](/iaas/Content/General/Concepts/identifiers.htm).\n" }, { "name": "timeIntervalStart", "value": "", "type": "query", "description": "Analysis start time in UTC in ISO 8601 format(inclusive).\nExample 2019-10-30T00:00:00Z (yyyy-MM-ddThh:mm:ssZ).\nThe minimum allowed value is 2 years prior to the current day.\ntimeIntervalStart and timeIntervalEnd parameters are used together.\nIf analysisTimeInterval is specified, this parameter is ignored.\n" }, { "name": "timeIntervalEnd", "value": "", "type": "query", "description": "Analysis end time in UTC in ISO 8601 format(exclusive).\nExample 2019-10-30T00:00:00Z (yyyy-MM-ddThh:mm:ssZ).\ntimeIntervalStart and timeIntervalEnd are used together.\nIf timeIntervalEnd is not specified, current time is used as timeIntervalEnd.\n" }, { "name": "limit", "value": "", "type": "query", "description": "For list pagination. The maximum number of results per page, or items to\nreturn in a paginated \"List\" call.\nFor important details about how pagination works, see\n[List Pagination](/Content/API/Concepts/usingapi.htm#nine).\nExample: `50`\n" }, { "name": "page", "value": "", "type": "query", "description": "For list pagination. The value of the `opc-next-page` response header from\nthe previous \"List\" call. For important details about how pagination works,\nsee [List Pagination](/Content/API/Concepts/usingapi.htm#nine).\n" }, { "name": "sortOrder", "value": "", "type": "query", "description": "The sort order to use, either ascending (`ASC`) or descending (`DESC`).\n" }, { "name": "sortBy", "value": "", "type": "query", "description": "Field name for sorting ADDM database data" }, { "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" }, { "name": "compartmentIdInSubtree", "value": "", "type": "query", "description": "A flag to search all resources within a given compartment and all sub-compartments.\n" } ] }, "docs": "Gets a list of ADDM database information\n" }, { "info": { "name": "Gets a list of database insights configuration.", "type": "http" }, "http": { "method": "GET", "url": "http://127.0.0.1/20200630/databaseInsights/databaseConfigurations", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "compartmentId", "value": "", "type": "query", "description": "The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compartment." }, { "name": "enterpriseManagerBridgeId", "value": "", "type": "query", "description": "Unique Enterprise Manager bridge identifier" }, { "name": "id", "value": "", "type": "query", "description": "Optional list of database insight resource [OCIDs](/iaas/Content/General/Concepts/identifiers.htm).\n" }, { "name": "databaseId", "value": "", "type": "query", "description": "Optional list of database [OCIDs](/iaas/Content/General/Concepts/identifiers.htm) of the associated DBaaS entity.\n" }, { "name": "exadataInsightId", "value": "", "type": "query", "description": "Optional list of exadata insight resource [OCIDs](/iaas/Content/General/Concepts/identifiers.htm).\n" }, { "name": "cdbName", "value": "", "type": "query", "description": "Filter by one or more cdb name.\n" }, { "name": "databaseType", "value": "", "type": "query", "description": "Filter by one or more database type.\nPossible values are ADW-S, ATP-S, ADW-D, ATP-D, EXTERNAL-PDB, EXTERNAL-NONCDB.\n" }, { "name": "limit", "value": "", "type": "query", "description": "For list pagination. The maximum number of results per page, or items to\nreturn in a paginated \"List\" call.\nFor important details about how pagination works, see\n[List Pagination](/Content/API/Concepts/usingapi.htm#nine).\nExample: `50`\n" }, { "name": "page", "value": "", "type": "query", "description": "For list pagination. The value of the `opc-next-page` response header from\nthe previous \"List\" call. For important details about how pagination works,\nsee [List Pagination](/Content/API/Concepts/usingapi.htm#nine).\n" }, { "name": "sortOrder", "value": "", "type": "query", "description": "The sort order to use, either ascending (`ASC`) or descending (`DESC`).\n" }, { "name": "sortBy", "value": "", "type": "query", "description": "Database configuration list sort options. If `fields` parameter is selected, the `sortBy` parameter must be one of the fields specified.\n" }, { "name": "hostName", "value": "", "type": "query", "description": "Filter by one or more hostname.\n" }, { "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" }, { "name": "compartmentIdInSubtree", "value": "", "type": "query", "description": "A flag to search all resources within a given compartment and all sub-compartments.\n" }, { "name": "vmclusterName", "value": "", "type": "query", "description": "Optional list of Exadata Insight VM cluster name.\n" } ] }, "docs": "Gets a list of database insight configurations based on the query parameters specified. Either compartmentId or databaseInsightId query parameter must be specified.\nWhen both compartmentId and compartmentIdInSubtree are specified, a list of database insight configurations in that compartment and in all sub-compartments will be returned.\n" }, { "info": { "name": "Get base and maximum capacity for a resource type.", "type": "http" }, "http": { "method": "GET", "url": "http://127.0.0.1/20200630/databaseInsights/resourceCapacityTrend", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "compartmentId", "value": "", "type": "query", "description": "The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compartment." }, { "name": "resourceMetric", "value": "", "type": "query", "description": "Filter by resource metric.\nSupported values are CPU , STORAGE, MEMORY and IO.\n" }, { "name": "analysisTimeInterval", "value": "", "type": "query", "description": "Specify time period in ISO 8601 format with respect to current time.\nDefault is last 30 days represented by P30D.\nIf timeInterval is specified, then timeIntervalStart and timeIntervalEnd will be ignored.\nExamples P90D (last 90 days), P4W (last 4 weeks), P2M (last 2 months), P1Y (last 12 months), . Maximum value allowed is 25 months prior to current time (P25M).\n" }, { "name": "timeIntervalStart", "value": "", "type": "query", "description": "Analysis start time in UTC in ISO 8601 format(inclusive).\nExample 2019-10-30T00:00:00Z (yyyy-MM-ddThh:mm:ssZ).\nThe minimum allowed value is 2 years prior to the current day.\ntimeIntervalStart and timeIntervalEnd parameters are used together.\nIf analysisTimeInterval is specified, this parameter is ignored.\n" }, { "name": "timeIntervalEnd", "value": "", "type": "query", "description": "Analysis end time in UTC in ISO 8601 format(exclusive).\nExample 2019-10-30T00:00:00Z (yyyy-MM-ddThh:mm:ssZ).\ntimeIntervalStart and timeIntervalEnd are used together.\nIf timeIntervalEnd is not specified, current time is used as timeIntervalEnd.\n" }, { "name": "databaseType", "value": "", "type": "query", "description": "Filter by one or more database type.\nPossible values are ADW-S, ATP-S, ADW-D, ATP-D, EXTERNAL-PDB, EXTERNAL-NONCDB.\n" }, { "name": "databaseId", "value": "", "type": "query", "description": "Optional list of database [OCIDs](/iaas/Content/General/Concepts/identifiers.htm) of the associated DBaaS entity.\n" }, { "name": "id", "value": "", "type": "query", "description": "Optional list of database insight resource [OCIDs](/iaas/Content/General/Concepts/identifiers.htm).\n" }, { "name": "exadataInsightId", "value": "", "type": "query", "description": "Optional list of exadata insight resource [OCIDs](/iaas/Content/General/Concepts/identifiers.htm).\n" }, { "name": "cdbName", "value": "", "type": "query", "description": "Filter by one or more cdb name.\n" }, { "name": "utilizationLevel", "value": "", "type": "query", "description": "Filter by utilization level by the following buckets:\n - HIGH_UTILIZATION: DBs with utilization greater or equal than 75.\n - LOW_UTILIZATION: DBs with utilization lower than 25.\n - MEDIUM_HIGH_UTILIZATION: DBs with utilization greater or equal than 50 but lower than 75.\n - MEDIUM_LOW_UTILIZATION: DBs with utilization greater or equal than 25 but lower than 50.\n" }, { "name": "page", "value": "", "type": "query", "description": "For list pagination. The value of the `opc-next-page` response header from\nthe previous \"List\" call. For important details about how pagination works,\nsee [List Pagination](/Content/API/Concepts/usingapi.htm#nine).\n" }, { "name": "sortOrder", "value": "", "type": "query", "description": "The sort order to use, either ascending (`ASC`) or descending (`DESC`).\n" }, { "name": "sortBy", "value": "", "type": "query", "description": "Sorts using end timestamp , capacity or baseCapacity\n" }, { "name": "tablespaceName", "value": "", "type": "query", "description": "Tablespace name for a database\n" }, { "name": "hostName", "value": "", "type": "query", "description": "Filter by one or more hostname.\n" }, { "name": "isDatabaseInstanceLevelMetrics", "value": "", "type": "query", "description": "Flag to indicate if database instance level metrics should be returned. The flag is ignored when a host name filter is not applied.\nWhen a hostname filter is applied this flag will determine whether to return metrics for the instances located on the specified host or for the\nwhole database which contains an instance on this host.\n" }, { "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" }, { "name": "compartmentIdInSubtree", "value": "", "type": "query", "description": "A flag to search all resources within a given compartment and all sub-compartments.\n" }, { "name": "vmclusterName", "value": "", "type": "query", "description": "Optional list of Exadata Insight VM cluster name.\n" }, { "name": "highUtilizationThreshold", "value": "", "type": "query", "description": "Percent value in which a resource metric is considered highly utilized." }, { "name": "lowUtilizationThreshold", "value": "", "type": "query", "description": "Percent value in which a resource metric is considered low utilized." } ] }, "docs": "Returns response with time series data (endTimestamp, capacity, baseCapacity) for the time period specified.\nThe maximum time range for analysis is 2 years, hence this is intentionally not paginated.\nIf compartmentIdInSubtree is specified, aggregates resources in a compartment and in all sub-compartments.\n" }, { "info": { "name": "Get Forecast predictions for host resources.", "type": "http" }, "http": { "method": "GET", "url": "http://127.0.0.1/20200630/databaseInsights/resourceForecastTrend", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "compartmentId", "value": "", "type": "query", "description": "The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compartment." }, { "name": "resourceMetric", "value": "", "type": "query", "description": "Filter by resource metric.\nSupported values are CPU , STORAGE, MEMORY and IO.\n" }, { "name": "analysisTimeInterval", "value": "", "type": "query", "description": "Specify time period in ISO 8601 format with respect to current time.\nDefault is last 30 days represented by P30D.\nIf timeInterval is specified, then timeIntervalStart and timeIntervalEnd will be ignored.\nExamples P90D (last 90 days), P4W (last 4 weeks), P2M (last 2 months), P1Y (last 12 months), . Maximum value allowed is 25 months prior to current time (P25M).\n" }, { "name": "timeIntervalStart", "value": "", "type": "query", "description": "Analysis start time in UTC in ISO 8601 format(inclusive).\nExample 2019-10-30T00:00:00Z (yyyy-MM-ddThh:mm:ssZ).\nThe minimum allowed value is 2 years prior to the current day.\ntimeIntervalStart and timeIntervalEnd parameters are used together.\nIf analysisTimeInterval is specified, this parameter is ignored.\n" }, { "name": "timeIntervalEnd", "value": "", "type": "query", "description": "Analysis end time in UTC in ISO 8601 format(exclusive).\nExample 2019-10-30T00:00:00Z (yyyy-MM-ddThh:mm:ssZ).\ntimeIntervalStart and timeIntervalEnd are used together.\nIf timeIntervalEnd is not specified, current time is used as timeIntervalEnd.\n" }, { "name": "databaseType", "value": "", "type": "query", "description": "Filter by one or more database type.\nPossible values are ADW-S, ATP-S, ADW-D, ATP-D, EXTERNAL-PDB, EXTERNAL-NONCDB.\n" }, { "name": "databaseId", "value": "", "type": "query", "description": "Optional list of database [OCIDs](/iaas/Content/General/Concepts/identifiers.htm) of the associated DBaaS entity.\n" }, { "name": "id", "value": "", "type": "query", "description": "Optional list of database insight resource [OCIDs](/iaas/Content/General/Concepts/identifiers.htm).\n" }, { "name": "exadataInsightId", "value": "", "type": "query", "description": "Optional list of exadata insight resource [OCIDs](/iaas/Content/General/Concepts/identifiers.htm).\n" }, { "name": "cdbName", "value": "", "type": "query", "description": "Filter by one or more cdb name.\n" }, { "name": "statistic", "value": "", "type": "query", "description": "Choose the type of statistic metric data to be used for forecasting." }, { "name": "forecastDays", "value": "", "type": "query", "description": "Number of days used for utilization forecast analysis.\n" }, { "name": "forecastModel", "value": "", "type": "query", "description": "Choose algorithm model for the forecasting.\nPossible values:\n - LINEAR: Uses linear regression algorithm for forecasting.\n - ML_AUTO: Automatically detects best algorithm to use for forecasting.\n - ML_NO_AUTO: Automatically detects seasonality of the data for forecasting using linear or seasonal algorithm.\n" }, { "name": "utilizationLevel", "value": "", "type": "query", "description": "Filter by utilization level by the following buckets:\n - HIGH_UTILIZATION: DBs with utilization greater or equal than 75.\n - LOW_UTILIZATION: DBs with utilization lower than 25.\n - MEDIUM_HIGH_UTILIZATION: DBs with utilization greater or equal than 50 but lower than 75.\n - MEDIUM_LOW_UTILIZATION: DBs with utilization greater or equal than 25 but lower than 50.\n" }, { "name": "confidence", "value": "", "type": "query", "description": "This parameter is used to change data's confidence level, this data is ingested by the\nforecast algorithm.\nConfidence is the probability of an interval to contain the expected population parameter.\nManipulation of this value will lead to different results.\nIf not set, default confidence value is 95%.\n" }, { "name": "page", "value": "", "type": "query", "description": "For list pagination. The value of the `opc-next-page` response header from\nthe previous \"List\" call. For important details about how pagination works,\nsee [List Pagination](/Content/API/Concepts/usingapi.htm#nine).\n" }, { "name": "hostName", "value": "", "type": "query", "description": "Filter by one or more hostname.\n" }, { "name": "tablespaceName", "value": "", "type": "query", "description": "Tablespace name for a database\n" }, { "name": "isDatabaseInstanceLevelMetrics", "value": "", "type": "query", "description": "Flag to indicate if database instance level metrics should be returned. The flag is ignored when a host name filter is not applied.\nWhen a hostname filter is applied this flag will determine whether to return metrics for the instances located on the specified host or for the\nwhole database which contains an instance on this host.\n" }, { "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" }, { "name": "compartmentIdInSubtree", "value": "", "type": "query", "description": "A flag to search all resources within a given compartment and all sub-compartments.\n" }, { "name": "vmclusterName", "value": "", "type": "query", "description": "Optional list of Exadata Insight VM cluster name.\n" }, { "name": "highUtilizationThreshold", "value": "", "type": "query", "description": "Percent value in which a resource metric is considered highly utilized." }, { "name": "lowUtilizationThreshold", "value": "", "type": "query", "description": "Percent value in which a resource metric is considered low utilized." } ] }, "docs": "Get Forecast predictions for CPU and Storage resources since a time in the past.\nIf compartmentIdInSubtree is specified, aggregates resources in a compartment and in all sub-compartments.\n" }, { "info": { "name": "Lists the Resource statistics for each database", "type": "http" }, "http": { "method": "GET", "url": "http://127.0.0.1/20200630/databaseInsights/resourceStatistics", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "compartmentId", "value": "", "type": "query", "description": "The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compartment." }, { "name": "resourceMetric", "value": "", "type": "query", "description": "Filter by resource metric.\nSupported values are CPU , STORAGE, MEMORY and IO.\n" }, { "name": "analysisTimeInterval", "value": "", "type": "query", "description": "Specify time period in ISO 8601 format with respect to current time.\nDefault is last 30 days represented by P30D.\nIf timeInterval is specified, then timeIntervalStart and timeIntervalEnd will be ignored.\nExamples P90D (last 90 days), P4W (last 4 weeks), P2M (last 2 months), P1Y (last 12 months), . Maximum value allowed is 25 months prior to current time (P25M).\n" }, { "name": "timeIntervalStart", "value": "", "type": "query", "description": "Analysis start time in UTC in ISO 8601 format(inclusive).\nExample 2019-10-30T00:00:00Z (yyyy-MM-ddThh:mm:ssZ).\nThe minimum allowed value is 2 years prior to the current day.\ntimeIntervalStart and timeIntervalEnd parameters are used together.\nIf analysisTimeInterval is specified, this parameter is ignored.\n" }, { "name": "timeIntervalEnd", "value": "", "type": "query", "description": "Analysis end time in UTC in ISO 8601 format(exclusive).\nExample 2019-10-30T00:00:00Z (yyyy-MM-ddThh:mm:ssZ).\ntimeIntervalStart and timeIntervalEnd are used together.\nIf timeIntervalEnd is not specified, current time is used as timeIntervalEnd.\n" }, { "name": "databaseType", "value": "", "type": "query", "description": "Filter by one or more database type.\nPossible values are ADW-S, ATP-S, ADW-D, ATP-D, EXTERNAL-PDB, EXTERNAL-NONCDB.\n" }, { "name": "databaseId", "value": "", "type": "query", "description": "Optional list of database [OCIDs](/iaas/Content/General/Concepts/identifiers.htm) of the associated DBaaS entity.\n" }, { "name": "id", "value": "", "type": "query", "description": "Optional list of database insight resource [OCIDs](/iaas/Content/General/Concepts/identifiers.htm).\n" }, { "name": "exadataInsightId", "value": "", "type": "query", "description": "Optional list of exadata insight resource [OCIDs](/iaas/Content/General/Concepts/identifiers.htm).\n" }, { "name": "cdbName", "value": "", "type": "query", "description": "Filter by one or more cdb name.\n" }, { "name": "percentile", "value": "", "type": "query", "description": "Percentile values of daily usage to be used for computing the aggregate resource usage.\n" }, { "name": "insightBy", "value": "", "type": "query", "description": "Return data of a specific insight\nPossible values are High Utilization, Low Utilization, Any ,High Utilization Forecast,\nLow Utilization Forecast\n" }, { "name": "forecastDays", "value": "", "type": "query", "description": "Number of days used for utilization forecast analysis.\n" }, { "name": "limit", "value": "", "type": "query", "description": "For list pagination. The maximum number of results per page, or items to\nreturn in a paginated \"List\" call.\nFor important details about how pagination works, see\n[List Pagination](/Content/API/Concepts/usingapi.htm#nine).\nExample: `50`\n" }, { "name": "page", "value": "", "type": "query", "description": "For list pagination. The value of the `opc-next-page` response header from\nthe previous \"List\" call. For important details about how pagination works,\nsee [List Pagination](/Content/API/Concepts/usingapi.htm#nine).\n" }, { "name": "sortOrder", "value": "", "type": "query", "description": "The sort order to use, either ascending (`ASC`) or descending (`DESC`).\n" }, { "name": "sortBy", "value": "", "type": "query", "description": "The order in which resource statistics records are listed\n" }, { "name": "hostName", "value": "", "type": "query", "description": "Filter by one or more hostname.\n" }, { "name": "isDatabaseInstanceLevelMetrics", "value": "", "type": "query", "description": "Flag to indicate if database instance level metrics should be returned. The flag is ignored when a host name filter is not applied.\nWhen a hostname filter is applied this flag will determine whether to return metrics for the instances located on the specified host or for the\nwhole database which contains an instance on this host.\n" }, { "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" }, { "name": "compartmentIdInSubtree", "value": "", "type": "query", "description": "A flag to search all resources within a given compartment and all sub-compartments.\n" }, { "name": "vmclusterName", "value": "", "type": "query", "description": "Optional list of Exadata Insight VM cluster name.\n" }, { "name": "highUtilizationThreshold", "value": "", "type": "query", "description": "Percent value in which a resource metric is considered highly utilized." }, { "name": "lowUtilizationThreshold", "value": "", "type": "query", "description": "Percent value in which a resource metric is considered low utilized." } ] }, "docs": "Lists the Resource statistics (usage,capacity, usage change percent, utilization percent, base capacity, isAutoScalingEnabled)\nfor each database filtered by utilization level in a compartment and in all sub-compartments if specified.\n" }, { "info": { "name": "Get aggregated usage, capacity and usage change percentage summed across databases for the current time period.", "type": "http" }, "http": { "method": "GET", "url": "http://127.0.0.1/20200630/databaseInsights/resourceUsageSummary", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "compartmentId", "value": "", "type": "query", "description": "The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compartment." }, { "name": "resourceMetric", "value": "", "type": "query", "description": "Filter by resource metric.\nSupported values are CPU , STORAGE, MEMORY and IO.\n" }, { "name": "analysisTimeInterval", "value": "", "type": "query", "description": "Specify time period in ISO 8601 format with respect to current time.\nDefault is last 30 days represented by P30D.\nIf timeInterval is specified, then timeIntervalStart and timeIntervalEnd will be ignored.\nExamples P90D (last 90 days), P4W (last 4 weeks), P2M (last 2 months), P1Y (last 12 months), . Maximum value allowed is 25 months prior to current time (P25M).\n" }, { "name": "timeIntervalStart", "value": "", "type": "query", "description": "Analysis start time in UTC in ISO 8601 format(inclusive).\nExample 2019-10-30T00:00:00Z (yyyy-MM-ddThh:mm:ssZ).\nThe minimum allowed value is 2 years prior to the current day.\ntimeIntervalStart and timeIntervalEnd parameters are used together.\nIf analysisTimeInterval is specified, this parameter is ignored.\n" }, { "name": "timeIntervalEnd", "value": "", "type": "query", "description": "Analysis end time in UTC in ISO 8601 format(exclusive).\nExample 2019-10-30T00:00:00Z (yyyy-MM-ddThh:mm:ssZ).\ntimeIntervalStart and timeIntervalEnd are used together.\nIf timeIntervalEnd is not specified, current time is used as timeIntervalEnd.\n" }, { "name": "databaseType", "value": "", "type": "query", "description": "Filter by one or more database type.\nPossible values are ADW-S, ATP-S, ADW-D, ATP-D, EXTERNAL-PDB, EXTERNAL-NONCDB.\n" }, { "name": "databaseId", "value": "", "type": "query", "description": "Optional list of database [OCIDs](/iaas/Content/General/Concepts/identifiers.htm) of the associated DBaaS entity.\n" }, { "name": "id", "value": "", "type": "query", "description": "Optional list of database insight resource [OCIDs](/iaas/Content/General/Concepts/identifiers.htm).\n" }, { "name": "exadataInsightId", "value": "", "type": "query", "description": "Optional list of exadata insight resource [OCIDs](/iaas/Content/General/Concepts/identifiers.htm).\n" }, { "name": "hostName", "value": "", "type": "query", "description": "Filter by one or more hostname.\n" }, { "name": "isDatabaseInstanceLevelMetrics", "value": "", "type": "query", "description": "Flag to indicate if database instance level metrics should be returned. The flag is ignored when a host name filter is not applied.\nWhen a hostname filter is applied this flag will determine whether to return metrics for the instances located on the specified host or for the\nwhole database which contains an instance on this host.\n" }, { "name": "page", "value": "", "type": "query", "description": "For list pagination. The value of the `opc-next-page` response header from\nthe previous \"List\" call. For important details about how pagination works,\nsee [List Pagination](/Content/API/Concepts/usingapi.htm#nine).\n" }, { "name": "percentile", "value": "", "type": "query", "description": "Percentile values of daily usage to be used for computing the aggregate resource usage.\n" }, { "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" }, { "name": "compartmentIdInSubtree", "value": "", "type": "query", "description": "A flag to search all resources within a given compartment and all sub-compartments.\n" }, { "name": "vmclusterName", "value": "", "type": "query", "description": "Optional list of Exadata Insight VM cluster name.\n" }, { "name": "cdbName", "value": "", "type": "query", "description": "Filter by one or more cdb name.\n" } ] }, "docs": "A cumulative distribution function is used to rank the usage data points per database within the specified time period.\nFor each database, the minimum data point with a ranking > the percentile value is included in the summation.\nLinear regression functions are used to calculate the usage change percentage.\nIf compartmentIdInSubtree is specified, aggregates resources in a compartment and in all sub-compartments.\n" }, { "info": { "name": "Gets aggregate usage and capacity for a resource type.", "type": "http" }, "http": { "method": "GET", "url": "http://127.0.0.1/20200630/databaseInsights/resourceUsageTrend", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "compartmentId", "value": "", "type": "query", "description": "The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compartment." }, { "name": "resourceMetric", "value": "", "type": "query", "description": "Filter by resource metric.\nSupported values are CPU , STORAGE, MEMORY and IO.\n" }, { "name": "analysisTimeInterval", "value": "", "type": "query", "description": "Specify time period in ISO 8601 format with respect to current time.\nDefault is last 30 days represented by P30D.\nIf timeInterval is specified, then timeIntervalStart and timeIntervalEnd will be ignored.\nExamples P90D (last 90 days), P4W (last 4 weeks), P2M (last 2 months), P1Y (last 12 months), . Maximum value allowed is 25 months prior to current time (P25M).\n" }, { "name": "timeIntervalStart", "value": "", "type": "query", "description": "Analysis start time in UTC in ISO 8601 format(inclusive).\nExample 2019-10-30T00:00:00Z (yyyy-MM-ddThh:mm:ssZ).\nThe minimum allowed value is 2 years prior to the current day.\ntimeIntervalStart and timeIntervalEnd parameters are used together.\nIf analysisTimeInterval is specified, this parameter is ignored.\n" }, { "name": "timeIntervalEnd", "value": "", "type": "query", "description": "Analysis end time in UTC in ISO 8601 format(exclusive).\nExample 2019-10-30T00:00:00Z (yyyy-MM-ddThh:mm:ssZ).\ntimeIntervalStart and timeIntervalEnd are used together.\nIf timeIntervalEnd is not specified, current time is used as timeIntervalEnd.\n" }, { "name": "databaseType", "value": "", "type": "query", "description": "Filter by one or more database type.\nPossible values are ADW-S, ATP-S, ADW-D, ATP-D, EXTERNAL-PDB, EXTERNAL-NONCDB.\n" }, { "name": "databaseId", "value": "", "type": "query", "description": "Optional list of database [OCIDs](/iaas/Content/General/Concepts/identifiers.htm) of the associated DBaaS entity.\n" }, { "name": "id", "value": "", "type": "query", "description": "Optional list of database insight resource [OCIDs](/iaas/Content/General/Concepts/identifiers.htm).\n" }, { "name": "exadataInsightId", "value": "", "type": "query", "description": "Optional list of exadata insight resource [OCIDs](/iaas/Content/General/Concepts/identifiers.htm).\n" }, { "name": "page", "value": "", "type": "query", "description": "For list pagination. The value of the `opc-next-page` response header from\nthe previous \"List\" call. For important details about how pagination works,\nsee [List Pagination](/Content/API/Concepts/usingapi.htm#nine).\n" }, { "name": "sortOrder", "value": "", "type": "query", "description": "The sort order to use, either ascending (`ASC`) or descending (`DESC`).\n" }, { "name": "sortBy", "value": "", "type": "query", "description": "Sorts using end timestamp, usage or capacity\n" }, { "name": "hostName", "value": "", "type": "query", "description": "Filter by one or more hostname.\n" }, { "name": "isDatabaseInstanceLevelMetrics", "value": "", "type": "query", "description": "Flag to indicate if database instance level metrics should be returned. The flag is ignored when a host name filter is not applied.\nWhen a hostname filter is applied this flag will determine whether to return metrics for the instances located on the specified host or for the\nwhole database which contains an instance on this host.\n" }, { "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" }, { "name": "compartmentIdInSubtree", "value": "", "type": "query", "description": "A flag to search all resources within a given compartment and all sub-compartments.\n" }, { "name": "vmclusterName", "value": "", "type": "query", "description": "Optional list of Exadata Insight VM cluster name.\n" }, { "name": "cdbName", "value": "", "type": "query", "description": "Filter by one or more cdb name.\n" } ] }, "docs": "Returns response with time series data (endTimestamp, usage, capacity) for the time period specified.\nThe maximum time range for analysis is 2 years, hence this is intentionally not paginated.\nIf compartmentIdInSubtree is specified, aggregates resources in a compartment and in all sub-compartments.\n" }, { "info": { "name": "Gets current and projected utilization insights.", "type": "http" }, "http": { "method": "GET", "url": "http://127.0.0.1/20200630/databaseInsights/resourceUtilizationInsight", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "compartmentId", "value": "", "type": "query", "description": "The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compartment." }, { "name": "resourceMetric", "value": "", "type": "query", "description": "Filter by resource metric.\nSupported values are CPU , STORAGE, MEMORY and IO.\n" }, { "name": "analysisTimeInterval", "value": "", "type": "query", "description": "Specify time period in ISO 8601 format with respect to current time.\nDefault is last 30 days represented by P30D.\nIf timeInterval is specified, then timeIntervalStart and timeIntervalEnd will be ignored.\nExamples P90D (last 90 days), P4W (last 4 weeks), P2M (last 2 months), P1Y (last 12 months), . Maximum value allowed is 25 months prior to current time (P25M).\n" }, { "name": "timeIntervalStart", "value": "", "type": "query", "description": "Analysis start time in UTC in ISO 8601 format(inclusive).\nExample 2019-10-30T00:00:00Z (yyyy-MM-ddThh:mm:ssZ).\nThe minimum allowed value is 2 years prior to the current day.\ntimeIntervalStart and timeIntervalEnd parameters are used together.\nIf analysisTimeInterval is specified, this parameter is ignored.\n" }, { "name": "timeIntervalEnd", "value": "", "type": "query", "description": "Analysis end time in UTC in ISO 8601 format(exclusive).\nExample 2019-10-30T00:00:00Z (yyyy-MM-ddThh:mm:ssZ).\ntimeIntervalStart and timeIntervalEnd are used together.\nIf timeIntervalEnd is not specified, current time is used as timeIntervalEnd.\n" }, { "name": "databaseType", "value": "", "type": "query", "description": "Filter by one or more database type.\nPossible values are ADW-S, ATP-S, ADW-D, ATP-D, EXTERNAL-PDB, EXTERNAL-NONCDB.\n" }, { "name": "databaseId", "value": "", "type": "query", "description": "Optional list of database [OCIDs](/iaas/Content/General/Concepts/identifiers.htm) of the associated DBaaS entity.\n" }, { "name": "id", "value": "", "type": "query", "description": "Optional list of database insight resource [OCIDs](/iaas/Content/General/Concepts/identifiers.htm).\n" }, { "name": "exadataInsightId", "value": "", "type": "query", "description": "Optional list of exadata insight resource [OCIDs](/iaas/Content/General/Concepts/identifiers.htm).\n" }, { "name": "forecastDays", "value": "", "type": "query", "description": "Number of days used for utilization forecast analysis.\n" }, { "name": "hostName", "value": "", "type": "query", "description": "Filter by one or more hostname.\n" }, { "name": "isDatabaseInstanceLevelMetrics", "value": "", "type": "query", "description": "Flag to indicate if database instance level metrics should be returned. The flag is ignored when a host name filter is not applied.\nWhen a hostname filter is applied this flag will determine whether to return metrics for the instances located on the specified host or for the\nwhole database which contains an instance on this host.\n" }, { "name": "page", "value": "", "type": "query", "description": "For list pagination. The value of the `opc-next-page` response header from\nthe previous \"List\" call. For important details about how pagination works,\nsee [List Pagination](/Content/API/Concepts/usingapi.htm#nine).\n" }, { "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" }, { "name": "compartmentIdInSubtree", "value": "", "type": "query", "description": "A flag to search all resources within a given compartment and all sub-compartments.\n" }, { "name": "vmclusterName", "value": "", "type": "query", "description": "Optional list of Exadata Insight VM cluster name.\n" }, { "name": "cdbName", "value": "", "type": "query", "description": "Filter by one or more cdb name.\n" }, { "name": "highUtilizationThreshold", "value": "", "type": "query", "description": "Percent value in which a resource metric is considered highly utilized." }, { "name": "lowUtilizationThreshold", "value": "", "type": "query", "description": "Percent value in which a resource metric is considered low utilized." } ] }, "docs": "Gets resources with current utilization (high and low) and projected utilization (high and low) for a resource type over specified time period.\nIf compartmentIdInSubtree is specified, aggregates resources in a compartment and in all sub-compartments.\n" }, { "info": { "name": "Get performance Insights for SQLs across databases.", "type": "http" }, "http": { "method": "GET", "url": "http://127.0.0.1/20200630/databaseInsights/sqlInsights", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "compartmentId", "value": "", "type": "query", "description": "The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compartment." }, { "name": "databaseType", "value": "", "type": "query", "description": "Filter by one or more database type.\nPossible values are ADW-S, ATP-S, ADW-D, ATP-D, EXTERNAL-PDB, EXTERNAL-NONCDB.\n" }, { "name": "databaseId", "value": "", "type": "query", "description": "Optional list of database [OCIDs](/iaas/Content/General/Concepts/identifiers.htm) of the associated DBaaS entity.\n" }, { "name": "id", "value": "", "type": "query", "description": "Optional list of database insight resource [OCIDs](/iaas/Content/General/Concepts/identifiers.htm).\n" }, { "name": "exadataInsightId", "value": "", "type": "query", "description": "Optional list of exadata insight resource [OCIDs](/iaas/Content/General/Concepts/identifiers.htm).\n" }, { "name": "cdbName", "value": "", "type": "query", "description": "Filter by one or more cdb name.\n" }, { "name": "hostName", "value": "", "type": "query", "description": "Filter by one or more hostname.\n" }, { "name": "databaseTimePctGreaterThan", "value": "", "type": "query", "description": "Filter sqls by percentage of db time.\n" }, { "name": "analysisTimeInterval", "value": "", "type": "query", "description": "Specify time period in ISO 8601 format with respect to current time.\nDefault is last 30 days represented by P30D.\nIf timeInterval is specified, then timeIntervalStart and timeIntervalEnd will be ignored.\nExamples P90D (last 90 days), P4W (last 4 weeks), P2M (last 2 months), P1Y (last 12 months), . Maximum value allowed is 25 months prior to current time (P25M).\n" }, { "name": "timeIntervalStart", "value": "", "type": "query", "description": "Analysis start time in UTC in ISO 8601 format(inclusive).\nExample 2019-10-30T00:00:00Z (yyyy-MM-ddThh:mm:ssZ).\nThe minimum allowed value is 2 years prior to the current day.\ntimeIntervalStart and timeIntervalEnd parameters are used together.\nIf analysisTimeInterval is specified, this parameter is ignored.\n" }, { "name": "timeIntervalEnd", "value": "", "type": "query", "description": "Analysis end time in UTC in ISO 8601 format(exclusive).\nExample 2019-10-30T00:00:00Z (yyyy-MM-ddThh:mm:ssZ).\ntimeIntervalStart and timeIntervalEnd are used together.\nIf timeIntervalEnd is not specified, current time is used as timeIntervalEnd.\n" }, { "name": "page", "value": "", "type": "query", "description": "For list pagination. The value of the `opc-next-page` response header from\nthe previous \"List\" call. For important details about how pagination works,\nsee [List Pagination](/Content/API/Concepts/usingapi.htm#nine).\n" }, { "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" }, { "name": "compartmentIdInSubtree", "value": "", "type": "query", "description": "A flag to search all resources within a given compartment and all sub-compartments.\n" }, { "name": "vmclusterName", "value": "", "type": "query", "description": "Optional list of Exadata Insight VM cluster name.\n" } ] }, "docs": "This API was deprecated May 2024 and is no longer functional as of May 31st, 2025. \nQuery SQL Warehouse to get the performance insights for SQLs taking greater than X% database time for a given time period across the given databases or database \ntypes in a compartment and in all sub-compartments if specified.\n" }, { "info": { "name": "Get performance insights on execution plans for a SQL.", "type": "http" }, "http": { "method": "GET", "url": "http://127.0.0.1/20200630/databaseInsights/sqlPlanInsights", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "compartmentId", "value": "", "type": "query", "description": "The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compartment." }, { "name": "databaseId", "value": "", "type": "query", "description": "Optional [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the associated DBaaS entity.\n" }, { "name": "id", "value": "", "type": "query", "description": "[OCID](/iaas/Content/General/Concepts/identifiers.htm) of the database insight resource.\n" }, { "name": "sqlIdentifier", "value": "", "type": "query", "description": "Unique SQL_ID for a SQL Statement.\nExample: `6rgjh9bjmy2s7`\n" }, { "name": "analysisTimeInterval", "value": "", "type": "query", "description": "Specify time period in ISO 8601 format with respect to current time.\nDefault is last 30 days represented by P30D.\nIf timeInterval is specified, then timeIntervalStart and timeIntervalEnd will be ignored.\nExamples P90D (last 90 days), P4W (last 4 weeks), P2M (last 2 months), P1Y (last 12 months), . Maximum value allowed is 25 months prior to current time (P25M).\n" }, { "name": "timeIntervalStart", "value": "", "type": "query", "description": "Analysis start time in UTC in ISO 8601 format(inclusive).\nExample 2019-10-30T00:00:00Z (yyyy-MM-ddThh:mm:ssZ).\nThe minimum allowed value is 2 years prior to the current day.\ntimeIntervalStart and timeIntervalEnd parameters are used together.\nIf analysisTimeInterval is specified, this parameter is ignored.\n" }, { "name": "timeIntervalEnd", "value": "", "type": "query", "description": "Analysis end time in UTC in ISO 8601 format(exclusive).\nExample 2019-10-30T00:00:00Z (yyyy-MM-ddThh:mm:ssZ).\ntimeIntervalStart and timeIntervalEnd are used together.\nIf timeIntervalEnd is not specified, current time is used as timeIntervalEnd.\n" }, { "name": "page", "value": "", "type": "query", "description": "For list pagination. The value of the `opc-next-page` response header from\nthe previous \"List\" call. For important details about how pagination works,\nsee [List Pagination](/Content/API/Concepts/usingapi.htm#nine).\n" } ] }, "docs": "This API was deprecated May 2024 and is no longer functional as of May 31st, 2025. \nQuery SQL Warehouse to get the performance insights on the execution plans for a given SQL for a given time period.\nEither databaseId or id must be specified.\n" }, { "info": { "name": "List the plan xml for a SQL execution plan", "type": "http" }, "http": { "method": "GET", "url": "http://127.0.0.1/20200630/databaseInsights/sqlPlans", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "compartmentId", "value": "", "type": "query", "description": "The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compartment." }, { "name": "databaseId", "value": "", "type": "query", "description": "Optional [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the associated DBaaS entity.\n" }, { "name": "id", "value": "", "type": "query", "description": "[OCID](/iaas/Content/General/Concepts/identifiers.htm) of the database insight resource.\n" }, { "name": "sqlIdentifier", "value": "", "type": "query", "description": "Unique SQL_ID for a SQL Statement.\nExample: `6rgjh9bjmy2s7`\n" }, { "name": "planHash", "value": "", "type": "query", "description": "Unique plan hash for a SQL Plan of a particular SQL Statement.\nExample: `9820154385`\n" }, { "name": "page", "value": "", "type": "query", "description": "For list pagination. The value of the `opc-next-page` response header from\nthe previous \"List\" call. For important details about how pagination works,\nsee [List Pagination](/Content/API/Concepts/usingapi.htm#nine).\n" } ] }, "docs": "Query SQL Warehouse to list the plan xml for a given SQL execution plan. This returns a SqlPlanCollection object, but is currently limited to a single plan.\nEither databaseId or id must be specified.\n" }, { "info": { "name": "Summarize response time distribution of query executions for a SQL", "type": "http" }, "http": { "method": "GET", "url": "http://127.0.0.1/20200630/databaseInsights/sqlResponseTimeDistributions", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "compartmentId", "value": "", "type": "query", "description": "The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compartment." }, { "name": "databaseId", "value": "", "type": "query", "description": "Optional [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the associated DBaaS entity.\n" }, { "name": "id", "value": "", "type": "query", "description": "[OCID](/iaas/Content/General/Concepts/identifiers.htm) of the database insight resource.\n" }, { "name": "sqlIdentifier", "value": "", "type": "query", "description": "Unique SQL_ID for a SQL Statement.\nExample: `6rgjh9bjmy2s7`\n" }, { "name": "analysisTimeInterval", "value": "", "type": "query", "description": "Specify time period in ISO 8601 format with respect to current time.\nDefault is last 30 days represented by P30D.\nIf timeInterval is specified, then timeIntervalStart and timeIntervalEnd will be ignored.\nExamples P90D (last 90 days), P4W (last 4 weeks), P2M (last 2 months), P1Y (last 12 months), . Maximum value allowed is 25 months prior to current time (P25M).\n" }, { "name": "timeIntervalStart", "value": "", "type": "query", "description": "Analysis start time in UTC in ISO 8601 format(inclusive).\nExample 2019-10-30T00:00:00Z (yyyy-MM-ddThh:mm:ssZ).\nThe minimum allowed value is 2 years prior to the current day.\ntimeIntervalStart and timeIntervalEnd parameters are used together.\nIf analysisTimeInterval is specified, this parameter is ignored.\n" }, { "name": "timeIntervalEnd", "value": "", "type": "query", "description": "Analysis end time in UTC in ISO 8601 format(exclusive).\nExample 2019-10-30T00:00:00Z (yyyy-MM-ddThh:mm:ssZ).\ntimeIntervalStart and timeIntervalEnd are used together.\nIf timeIntervalEnd is not specified, current time is used as timeIntervalEnd.\n" }, { "name": "page", "value": "", "type": "query", "description": "For list pagination. The value of the `opc-next-page` response header from\nthe previous \"List\" call. For important details about how pagination works,\nsee [List Pagination](/Content/API/Concepts/usingapi.htm#nine).\n" } ] }, "docs": "This API was deprecated May 2024 and is no longer functional as of May 31st, 2025. \nQuery SQL Warehouse to summarize the response time distribution of query executions for a given SQL for a given time period. Either databaseId or id must be specified.\n" }, { "info": { "name": "Search SQL by SQL Identifier across databases.", "type": "http" }, "http": { "method": "GET", "url": "http://127.0.0.1/20200630/databaseInsights/sqlSearches", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "compartmentId", "value": "", "type": "query", "description": "The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compartment." }, { "name": "sqlIdentifier", "value": "", "type": "query", "description": "Unique SQL_ID for a SQL Statement.\nExample: `6rgjh9bjmy2s7`\n" }, { "name": "analysisTimeInterval", "value": "", "type": "query", "description": "Specify time period in ISO 8601 format with respect to current time.\nDefault is last 30 days represented by P30D.\nIf timeInterval is specified, then timeIntervalStart and timeIntervalEnd will be ignored.\nExamples P90D (last 90 days), P4W (last 4 weeks), P2M (last 2 months), P1Y (last 12 months), . Maximum value allowed is 25 months prior to current time (P25M).\n" }, { "name": "timeIntervalStart", "value": "", "type": "query", "description": "Analysis start time in UTC in ISO 8601 format(inclusive).\nExample 2019-10-30T00:00:00Z (yyyy-MM-ddThh:mm:ssZ).\nThe minimum allowed value is 2 years prior to the current day.\ntimeIntervalStart and timeIntervalEnd parameters are used together.\nIf analysisTimeInterval is specified, this parameter is ignored.\n" }, { "name": "timeIntervalEnd", "value": "", "type": "query", "description": "Analysis end time in UTC in ISO 8601 format(exclusive).\nExample 2019-10-30T00:00:00Z (yyyy-MM-ddThh:mm:ssZ).\ntimeIntervalStart and timeIntervalEnd are used together.\nIf timeIntervalEnd is not specified, current time is used as timeIntervalEnd.\n" }, { "name": "page", "value": "", "type": "query", "description": "For list pagination. The value of the `opc-next-page` response header from\nthe previous \"List\" call. For important details about how pagination works,\nsee [List Pagination](/Content/API/Concepts/usingapi.htm#nine).\n" }, { "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" }, { "name": "compartmentIdInSubtree", "value": "", "type": "query", "description": "A flag to search all resources within a given compartment and all sub-compartments.\n" } ] }, "docs": "This API was deprecated May 2024 and is no longer functional as of May 31st, 2025. \nSearch SQL by SQL Identifier across databases in a compartment and in all sub-compartments if specified.\nAnd get the SQL Text and the details of the databases executing the SQL for a given time period.\n" }, { "info": { "name": "Get performance statistics for SQLs across databases.", "type": "http" }, "http": { "method": "GET", "url": "http://127.0.0.1/20200630/databaseInsights/sqlStatistics", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "compartmentId", "value": "", "type": "query", "description": "The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compartment." }, { "name": "databaseType", "value": "", "type": "query", "description": "Filter by one or more database type.\nPossible values are ADW-S, ATP-S, ADW-D, ATP-D, EXTERNAL-PDB, EXTERNAL-NONCDB.\n" }, { "name": "databaseId", "value": "", "type": "query", "description": "Optional list of database [OCIDs](/iaas/Content/General/Concepts/identifiers.htm) of the associated DBaaS entity.\n" }, { "name": "id", "value": "", "type": "query", "description": "Optional list of database insight resource [OCIDs](/iaas/Content/General/Concepts/identifiers.htm).\n" }, { "name": "exadataInsightId", "value": "", "type": "query", "description": "Optional list of exadata insight resource [OCIDs](/iaas/Content/General/Concepts/identifiers.htm).\n" }, { "name": "cdbName", "value": "", "type": "query", "description": "Filter by one or more cdb name.\n" }, { "name": "hostName", "value": "", "type": "query", "description": "Filter by one or more hostname.\n" }, { "name": "databaseTimePctGreaterThan", "value": "", "type": "query", "description": "Filter sqls by percentage of db time.\n" }, { "name": "sqlIdentifier", "value": "", "type": "query", "description": "One or more unique SQL_IDs for a SQL Statement.\nExample: `6rgjh9bjmy2s7`\n" }, { "name": "analysisTimeInterval", "value": "", "type": "query", "description": "Specify time period in ISO 8601 format with respect to current time.\nDefault is last 30 days represented by P30D.\nIf timeInterval is specified, then timeIntervalStart and timeIntervalEnd will be ignored.\nExamples P90D (last 90 days), P4W (last 4 weeks), P2M (last 2 months), P1Y (last 12 months), . Maximum value allowed is 25 months prior to current time (P25M).\n" }, { "name": "timeIntervalStart", "value": "", "type": "query", "description": "Analysis start time in UTC in ISO 8601 format(inclusive).\nExample 2019-10-30T00:00:00Z (yyyy-MM-ddThh:mm:ssZ).\nThe minimum allowed value is 2 years prior to the current day.\ntimeIntervalStart and timeIntervalEnd parameters are used together.\nIf analysisTimeInterval is specified, this parameter is ignored.\n" }, { "name": "timeIntervalEnd", "value": "", "type": "query", "description": "Analysis end time in UTC in ISO 8601 format(exclusive).\nExample 2019-10-30T00:00:00Z (yyyy-MM-ddThh:mm:ssZ).\ntimeIntervalStart and timeIntervalEnd are used together.\nIf timeIntervalEnd is not specified, current time is used as timeIntervalEnd.\n" }, { "name": "limit", "value": "", "type": "query", "description": "For list pagination. The maximum number of results per page, or items to\nreturn in a paginated \"List\" call.\nFor important details about how pagination works, see\n[List Pagination](/Content/API/Concepts/usingapi.htm#nine).\nExample: `50`\n" }, { "name": "page", "value": "", "type": "query", "description": "For list pagination. The value of the `opc-next-page` response header from\nthe previous \"List\" call. For important details about how pagination works,\nsee [List Pagination](/Content/API/Concepts/usingapi.htm#nine).\n" }, { "name": "sortOrder", "value": "", "type": "query", "description": "The sort order to use, either ascending (`ASC`) or descending (`DESC`).\n" }, { "name": "sortBy", "value": "", "type": "query", "description": "The field to use when sorting SQL statistics.\nExample: databaseTimeInSec\n" }, { "name": "category", "value": "", "type": "query", "description": "Filter sqls by one or more performance categories.\n" }, { "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" }, { "name": "compartmentIdInSubtree", "value": "", "type": "query", "description": "A flag to search all resources within a given compartment and all sub-compartments.\n" }, { "name": "vmclusterName", "value": "", "type": "query", "description": "Optional list of Exadata Insight VM cluster name.\n" } ] }, "docs": "This API was deprecated May 2024 and is no longer functional as of May 31st, 2025. \nQuery SQL Warehouse to get the performance statistics for SQLs taking greater than X% database time for a given\ntime period across the given databases or database types in a compartment and in all sub-compartments if specified.\n" }, { "info": { "name": "Get performance statistics time series for a SQL across one or more databases", "type": "http" }, "http": { "method": "GET", "url": "http://127.0.0.1/20200630/databaseInsights/sqlStatisticsTimeSeries", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "compartmentId", "value": "", "type": "query", "description": "The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compartment." }, { "name": "databaseId", "value": "", "type": "query", "description": "Optional list of database [OCIDs](/iaas/Content/General/Concepts/identifiers.htm) of the associated DBaaS entity.\n" }, { "name": "id", "value": "", "type": "query", "description": "Optional list of database [OCIDs](/iaas/Content/General/Concepts/identifiers.htm) of the database insight resource.\n" }, { "name": "exadataInsightId", "value": "", "type": "query", "description": "Optional list of exadata insight resource [OCIDs](/iaas/Content/General/Concepts/identifiers.htm).\n" }, { "name": "cdbName", "value": "", "type": "query", "description": "Filter by one or more cdb name.\n" }, { "name": "hostName", "value": "", "type": "query", "description": "Filter by one or more hostname.\n" }, { "name": "sqlIdentifier", "value": "", "type": "query", "description": "Unique SQL_ID for a SQL Statement.\nExample: `6rgjh9bjmy2s7`\n" }, { "name": "analysisTimeInterval", "value": "", "type": "query", "description": "Specify time period in ISO 8601 format with respect to current time.\nDefault is last 30 days represented by P30D.\nIf timeInterval is specified, then timeIntervalStart and timeIntervalEnd will be ignored.\nExamples P90D (last 90 days), P4W (last 4 weeks), P2M (last 2 months), P1Y (last 12 months), . Maximum value allowed is 25 months prior to current time (P25M).\n" }, { "name": "timeIntervalStart", "value": "", "type": "query", "description": "Analysis start time in UTC in ISO 8601 format(inclusive).\nExample 2019-10-30T00:00:00Z (yyyy-MM-ddThh:mm:ssZ).\nThe minimum allowed value is 2 years prior to the current day.\ntimeIntervalStart and timeIntervalEnd parameters are used together.\nIf analysisTimeInterval is specified, this parameter is ignored.\n" }, { "name": "timeIntervalEnd", "value": "", "type": "query", "description": "Analysis end time in UTC in ISO 8601 format(exclusive).\nExample 2019-10-30T00:00:00Z (yyyy-MM-ddThh:mm:ssZ).\ntimeIntervalStart and timeIntervalEnd are used together.\nIf timeIntervalEnd is not specified, current time is used as timeIntervalEnd.\n" }, { "name": "page", "value": "", "type": "query", "description": "For list pagination. The value of the `opc-next-page` response header from\nthe previous \"List\" call. For important details about how pagination works,\nsee [List Pagination](/Content/API/Concepts/usingapi.htm#nine).\n" }, { "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" }, { "name": "compartmentIdInSubtree", "value": "", "type": "query", "description": "A flag to search all resources within a given compartment and all sub-compartments.\n" }, { "name": "vmclusterName", "value": "", "type": "query", "description": "Optional list of Exadata Insight VM cluster name.\n" } ] }, "docs": "This API was deprecated May 2024 and is no longer functional as of May 31st, 2025. \nQuery SQL Warehouse to get the performance statistics time series for a given SQL across given databases for a\ngiven time period in a compartment and in all sub-compartments if specified.\n" }, { "info": { "name": "Get performance statistics time series for a SQL by execution plans", "type": "http" }, "http": { "method": "GET", "url": "http://127.0.0.1/20200630/databaseInsights/sqlStatisticsTimeSeriesByPlan", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "compartmentId", "value": "", "type": "query", "description": "The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compartment." }, { "name": "databaseId", "value": "", "type": "query", "description": "Optional [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the associated DBaaS entity.\n" }, { "name": "id", "value": "", "type": "query", "description": "[OCID](/iaas/Content/General/Concepts/identifiers.htm) of the database insight resource.\n" }, { "name": "sqlIdentifier", "value": "", "type": "query", "description": "Unique SQL_ID for a SQL Statement.\nExample: `6rgjh9bjmy2s7`\n" }, { "name": "analysisTimeInterval", "value": "", "type": "query", "description": "Specify time period in ISO 8601 format with respect to current time.\nDefault is last 30 days represented by P30D.\nIf timeInterval is specified, then timeIntervalStart and timeIntervalEnd will be ignored.\nExamples P90D (last 90 days), P4W (last 4 weeks), P2M (last 2 months), P1Y (last 12 months), . Maximum value allowed is 25 months prior to current time (P25M).\n" }, { "name": "timeIntervalStart", "value": "", "type": "query", "description": "Analysis start time in UTC in ISO 8601 format(inclusive).\nExample 2019-10-30T00:00:00Z (yyyy-MM-ddThh:mm:ssZ).\nThe minimum allowed value is 2 years prior to the current day.\ntimeIntervalStart and timeIntervalEnd parameters are used together.\nIf analysisTimeInterval is specified, this parameter is ignored.\n" }, { "name": "timeIntervalEnd", "value": "", "type": "query", "description": "Analysis end time in UTC in ISO 8601 format(exclusive).\nExample 2019-10-30T00:00:00Z (yyyy-MM-ddThh:mm:ssZ).\ntimeIntervalStart and timeIntervalEnd are used together.\nIf timeIntervalEnd is not specified, current time is used as timeIntervalEnd.\n" }, { "name": "page", "value": "", "type": "query", "description": "For list pagination. The value of the `opc-next-page` response header from\nthe previous \"List\" call. For important details about how pagination works,\nsee [List Pagination](/Content/API/Concepts/usingapi.htm#nine).\n" } ] }, "docs": "This API was deprecated May 2024 and is no longer functional as of May 31st, 2025. \nQuery SQL Warehouse to get the performance statistics time series for a given SQL by execution plans for a given time period.\nEither databaseId or id must be specified.\n" }, { "info": { "name": "Get SQL Text for a SQL", "type": "http" }, "http": { "method": "GET", "url": "http://127.0.0.1/20200630/databaseInsights/sqlTexts", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "compartmentId", "value": "", "type": "query", "description": "The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compartment." }, { "name": "databaseId", "value": "", "type": "query", "description": "Optional list of database [OCIDs](/iaas/Content/General/Concepts/identifiers.htm) of the assosicated DBaaS entity.\n" }, { "name": "id", "value": "", "type": "query", "description": "Optional list of database [OCIDs](/iaas/Content/General/Concepts/identifiers.htm) of the database insight resource.\n" }, { "name": "sqlIdentifier", "value": "", "type": "query", "description": "One or more unique SQL_IDs for a SQL Statement.\nExample: `6rgjh9bjmy2s7`\n" }, { "name": "page", "value": "", "type": "query", "description": "For list pagination. The value of the `opc-next-page` response header from\nthe previous \"List\" call. For important details about how pagination works,\nsee [List Pagination](/Content/API/Concepts/usingapi.htm#nine).\n" }, { "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" }, { "name": "compartmentIdInSubtree", "value": "", "type": "query", "description": "A flag to search all resources within a given compartment and all sub-compartments.\n" } ] }, "docs": "Query SQL Warehouse to get the full SQL Text for a SQL in a compartment and in all sub-compartments if specified.\n" }, { "info": { "name": "Gets tablespace usage metrics for a database.", "type": "http" }, "http": { "method": "GET", "url": "http://127.0.0.1/20200630/databaseInsights/tablespaceUsageTrend", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "compartmentId", "value": "", "type": "query", "description": "The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compartment." }, { "name": "analysisTimeInterval", "value": "", "type": "query", "description": "Specify time period in ISO 8601 format with respect to current time.\nDefault is last 30 days represented by P30D.\nIf timeInterval is specified, then timeIntervalStart and timeIntervalEnd will be ignored.\nExamples P90D (last 90 days), P4W (last 4 weeks), P2M (last 2 months), P1Y (last 12 months), . Maximum value allowed is 25 months prior to current time (P25M).\n" }, { "name": "timeIntervalStart", "value": "", "type": "query", "description": "Analysis start time in UTC in ISO 8601 format(inclusive).\nExample 2019-10-30T00:00:00Z (yyyy-MM-ddThh:mm:ssZ).\nThe minimum allowed value is 2 years prior to the current day.\ntimeIntervalStart and timeIntervalEnd parameters are used together.\nIf analysisTimeInterval is specified, this parameter is ignored.\n" }, { "name": "timeIntervalEnd", "value": "", "type": "query", "description": "Analysis end time in UTC in ISO 8601 format(exclusive).\nExample 2019-10-30T00:00:00Z (yyyy-MM-ddThh:mm:ssZ).\ntimeIntervalStart and timeIntervalEnd are used together.\nIf timeIntervalEnd is not specified, current time is used as timeIntervalEnd.\n" }, { "name": "databaseId", "value": "", "type": "query", "description": "Optional [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the associated DBaaS entity.\n" }, { "name": "id", "value": "", "type": "query", "description": "[OCID](/iaas/Content/General/Concepts/identifiers.htm) of the database insight resource.\n" }, { "name": "page", "value": "", "type": "query", "description": "For list pagination. The value of the `opc-next-page` response header from\nthe previous \"List\" call. For important details about how pagination works,\nsee [List Pagination](/Content/API/Concepts/usingapi.htm#nine).\n" }, { "name": "limit", "value": "", "type": "query", "description": "For list pagination. The maximum number of results per page, or items to\nreturn in a paginated \"List\" call.\nFor important details about how pagination works, see\n[List Pagination](/Content/API/Concepts/usingapi.htm#nine).\nExample: `50`\n" } ] }, "docs": "Returns response with usage time series data (endTimestamp, usage, capacity) with breakdown by tablespaceName for the time period specified.\nThe maximum time range for analysis is 2 years, hence this is intentionally not paginated.\nEither databaseId or id must be specified.\n" }, { "info": { "name": "Gets details of a database insight.", "type": "http" }, "http": { "method": "GET", "url": "http://127.0.0.1/20200630/databaseInsights/:databaseInsightId", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "databaseInsightId", "value": "", "type": "path", "description": "Unique database insight identifier" } ] }, "docs": "Gets details of a database insight." }, { "info": { "name": "Updates configuration of a database insight.", "type": "http" }, "http": { "method": "PUT", "url": "http://127.0.0.1/20200630/databaseInsights/:databaseInsightId", "headers": [ { "name": "if-match", "value": "" }, { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "databaseInsightId", "value": "", "type": "path", "description": "Unique database insight identifier" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Updates configuration of a database insight." }, { "info": { "name": "Deletes a database insight.", "type": "http" }, "http": { "method": "DELETE", "url": "http://127.0.0.1/20200630/databaseInsights/:databaseInsightId", "headers": [ { "name": "if-match", "value": "" }, { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "databaseInsightId", "value": "", "type": "path", "description": "Unique database insight identifier" } ] }, "docs": "Deletes a database insight. The database insight will be deleted and cannot be enabled again." }, { "info": { "name": "Update advanced features for Autonomous Database in Operations Insights.", "type": "http" }, "http": { "method": "POST", "url": "http://127.0.0.1/20200630/databaseInsights/:databaseInsightId/actions/changeAutonomousDatabaseInsightAdvancedFeatures", "headers": [ { "name": "if-match", "value": "" }, { "name": "opc-request-id", "value": "" }, { "name": "opc-retry-token", "value": "" } ], "params": [ { "name": "databaseInsightId", "value": "", "type": "path", "description": "Unique database insight identifier" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Update connection detail for advanced features of Autonomous Database in Operations Insights." }, { "info": { "name": "Moves a resource into a different compartment.", "type": "http" }, "http": { "method": "POST", "url": "http://127.0.0.1/20200630/databaseInsights/:databaseInsightId/actions/changeCompartment", "headers": [ { "name": "if-match", "value": "" }, { "name": "opc-request-id", "value": "" }, { "name": "opc-retry-token", "value": "" } ], "params": [ { "name": "databaseInsightId", "value": "", "type": "path", "description": "Unique database insight identifier" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Moves a DatabaseInsight resource from one compartment identifier to another. When provided, If-Match is checked against ETag values of the resource." }, { "info": { "name": "Change the connection details of a External Mysql database insight.", "type": "http" }, "http": { "method": "POST", "url": "http://127.0.0.1/20200630/databaseInsights/:databaseInsightId/actions/changeExternalMysqlDatabaseInsightConnectionDetails", "headers": [ { "name": "if-match", "value": "" }, { "name": "opc-request-id", "value": "" }, { "name": "opc-retry-token", "value": "" } ], "params": [ { "name": "databaseInsightId", "value": "", "type": "path", "description": "Unique database insight identifier" } ], "body": { "type": "json", "data": "{}" } }, "docs": "MySQL support within the OCI Ops Insights service has been deprecated as of January 29, 2026.\nChange the connection details of an External MySQL database insight. When provided, If-Match is checked against ETag values of the resource.\n" }, { "info": { "name": "Change the connection details of a Cloud MACS-managed database insight.", "type": "http" }, "http": { "method": "POST", "url": "http://127.0.0.1/20200630/databaseInsights/:databaseInsightId/actions/changeMacsManagedCloudDatabaseInsightConnectionDetails", "headers": [ { "name": "if-match", "value": "" }, { "name": "opc-request-id", "value": "" }, { "name": "opc-retry-token", "value": "" } ], "params": [ { "name": "databaseInsightId", "value": "", "type": "path", "description": "Unique database insight identifier" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Change the connection details of a Cloud MACS-managed database insight. When provided, If-Match is checked against ETag values of the resource." }, { "info": { "name": "Change the connection details or private endpoint of co managed database insight.", "type": "http" }, "http": { "method": "POST", "url": "http://127.0.0.1/20200630/databaseInsights/:databaseInsightId/actions/changePeComanagedDatabaseInsightDetails", "headers": [ { "name": "if-match", "value": "" }, { "name": "opc-request-id", "value": "" }, { "name": "opc-retry-token", "value": "" } ], "params": [ { "name": "databaseInsightId", "value": "", "type": "path", "description": "Unique database insight identifier" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Change the connection details of a co-managed database insight. When provided, If-Match is checked against ETag values of the resource." }, { "info": { "name": "Disables a database in Operations Insights.", "type": "http" }, "http": { "method": "POST", "url": "http://127.0.0.1/20200630/databaseInsights/:databaseInsightId/actions/disable", "headers": [ { "name": "if-match", "value": "" }, { "name": "opc-request-id", "value": "" }, { "name": "opc-retry-token", "value": "" } ], "params": [ { "name": "databaseInsightId", "value": "", "type": "path", "description": "Unique database insight identifier" } ] }, "docs": "Disables a database in Operations Insights. Database metric collection and analysis will be stopped." }, { "info": { "name": "Disable advanced features for an Autonomous Database in Operations Insights.", "type": "http" }, "http": { "method": "POST", "url": "http://127.0.0.1/20200630/databaseInsights/:databaseInsightId/actions/disableAutonomousDatabaseInsightAdvancedFeatures", "headers": [ { "name": "if-match", "value": "" }, { "name": "opc-request-id", "value": "" }, { "name": "opc-retry-token", "value": "" } ], "params": [ { "name": "databaseInsightId", "value": "", "type": "path", "description": "Unique database insight identifier" } ] }, "docs": "Disable advanced features for an Autonomous Database in Operations Insights. The connection detail and advanced features will be removed." }, { "info": { "name": "Enables a database in Operations Insights.", "type": "http" }, "http": { "method": "POST", "url": "http://127.0.0.1/20200630/databaseInsights/:databaseInsightId/actions/enable", "headers": [ { "name": "if-match", "value": "" }, { "name": "opc-request-id", "value": "" }, { "name": "opc-retry-token", "value": "" } ], "params": [ { "name": "databaseInsightId", "value": "", "type": "path", "description": "Unique database insight identifier" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Enables a database in Operations Insights. Database metric collection and analysis will be started." }, { "info": { "name": "Enables advanced features for an Autonomous Database in Operations Insights.", "type": "http" }, "http": { "method": "POST", "url": "http://127.0.0.1/20200630/databaseInsights/:databaseInsightId/actions/enableAutonomousDatabaseInsightAdvancedFeatures", "headers": [ { "name": "if-match", "value": "" }, { "name": "opc-request-id", "value": "" }, { "name": "opc-retry-token", "value": "" } ], "params": [ { "name": "databaseInsightId", "value": "", "type": "path", "description": "Unique database insight identifier" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Enables advanced features for an Autonomous Database in Operations Insights. A direct connection will be available for further collection." }, { "info": { "name": "Gets a list of Ops Insights Enterprise Manager bridges.", "type": "http" }, "http": { "method": "GET", "url": "http://127.0.0.1/20200630/enterpriseManagerBridges", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "compartmentId", "value": "", "type": "query", "description": "The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compartment." }, { "name": "displayName", "value": "", "type": "query", "description": "A filter to return only resources that match the entire display name." }, { "name": "id", "value": "", "type": "query", "description": "Unique Enterprise Manager bridge identifier" }, { "name": "lifecycleState", "value": "", "type": "query", "description": "Lifecycle states" }, { "name": "limit", "value": "", "type": "query", "description": "For list pagination. The maximum number of results per page, or items to\nreturn in a paginated \"List\" call.\nFor important details about how pagination works, see\n[List Pagination](/Content/API/Concepts/usingapi.htm#nine).\nExample: `50`\n" }, { "name": "page", "value": "", "type": "query", "description": "For list pagination. The value of the `opc-next-page` response header from\nthe previous \"List\" call. For important details about how pagination works,\nsee [List Pagination](/Content/API/Concepts/usingapi.htm#nine).\n" }, { "name": "sortOrder", "value": "", "type": "query", "description": "The sort order to use, either ascending (`ASC`) or descending (`DESC`).\n" }, { "name": "sortBy", "value": "", "type": "query", "description": "The field to sort by. Only one sort order may be provided. Default order for timeCreated is descending. Default order for displayName is ascending. If no value is specified timeCreated is default.\n" }, { "name": "compartmentIdInSubtree", "value": "", "type": "query", "description": "A flag to search all resources within a given compartment and all sub-compartments.\n" } ] }, "docs": "Gets a list of Ops Insights Enterprise Manager bridges. Either compartmentId or id must be specified.\nWhen both compartmentId and compartmentIdInSubtree are specified, a list of bridges in that compartment and in all sub-compartments will be returned.\n" }, { "info": { "name": "Create a Enterprise Manager bridge in Operations Insights.", "type": "http" }, "http": { "method": "POST", "url": "http://127.0.0.1/20200630/enterpriseManagerBridges", "headers": [ { "name": "opc-retry-token", "value": "" }, { "name": "opc-request-id", "value": "" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Create a Enterprise Manager bridge in Operations Insights.\n" }, { "info": { "name": "Gets details of an Operations Insights Enterprise Manager bridge.", "type": "http" }, "http": { "method": "GET", "url": "http://127.0.0.1/20200630/enterpriseManagerBridges/:enterpriseManagerBridgeId", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "enterpriseManagerBridgeId", "value": "", "type": "path", "description": "Unique Enterprise Manager bridge identifier" } ] }, "docs": "Gets details of an Operations Insights Enterprise Manager bridge." }, { "info": { "name": "Updates configuration of an Operations Insights Enterprise Manager bridge.", "type": "http" }, "http": { "method": "PUT", "url": "http://127.0.0.1/20200630/enterpriseManagerBridges/:enterpriseManagerBridgeId", "headers": [ { "name": "if-match", "value": "" }, { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "enterpriseManagerBridgeId", "value": "", "type": "path", "description": "Unique Enterprise Manager bridge identifier" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Updates configuration of an Operations Insights Enterprise Manager bridge." }, { "info": { "name": "Deletes an Operations Insights Enterprise Manager bridge.", "type": "http" }, "http": { "method": "DELETE", "url": "http://127.0.0.1/20200630/enterpriseManagerBridges/:enterpriseManagerBridgeId", "headers": [ { "name": "if-match", "value": "" }, { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "enterpriseManagerBridgeId", "value": "", "type": "path", "description": "Unique Enterprise Manager bridge identifier" } ] }, "docs": "Deletes an Operations Insights Enterprise Manager bridge. If any database insight is still referencing this bridge, the operation will fail." }, { "info": { "name": "Moves a resource into a different compartment.", "type": "http" }, "http": { "method": "POST", "url": "http://127.0.0.1/20200630/enterpriseManagerBridges/:enterpriseManagerBridgeId/actions/changeCompartment", "headers": [ { "name": "if-match", "value": "" }, { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "enterpriseManagerBridgeId", "value": "", "type": "path", "description": "Unique Enterprise Manager bridge identifier" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Moves a EnterpriseManagerBridge resource from one compartment to another. When provided, If-Match is checked against ETag values of the resource." }, { "info": { "name": "Gets a list of importable entities for an Operations Insights Enterprise Manager bridge that have not been imported before.", "type": "http" }, "http": { "method": "GET", "url": "http://127.0.0.1/20200630/enterpriseManagerBridges/:enterpriseManagerBridgeId/importableEnterpriseManagerEntities", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "enterpriseManagerBridgeId", "value": "", "type": "path", "description": "Unique Enterprise Manager bridge identifier" }, { "name": "limit", "value": "", "type": "query", "description": "For list pagination. The maximum number of results per page, or items to\nreturn in a paginated \"List\" call.\nFor important details about how pagination works, see\n[List Pagination](/Content/API/Concepts/usingapi.htm#nine).\nExample: `50`\n" }, { "name": "page", "value": "", "type": "query", "description": "For list pagination. The value of the `opc-next-page` response header from\nthe previous \"List\" call. For important details about how pagination works,\nsee [List Pagination](/Content/API/Concepts/usingapi.htm#nine).\n" }, { "name": "enterpriseManagerEntityType", "value": "", "type": "query", "description": "Filter by one or more Enterprise Manager entity types. Currently, the supported types are \"oracle_pdb\", \"oracle_database\", \"host\", \"oracle_dbmachine\", \"oracle_exa_cloud_service\", and \"oracle_oci_exadata_cloud_service\". If this parameter is not specified, targets of all supported entity types are returned by default.\n" }, { "name": "enterpriseManagerIdentifier", "value": "", "type": "query", "description": "Used in combination with enterpriseManagerParentEntityIdentifier to return the members of a particular Enterprise Manager parent entity. Both enterpriseManagerIdentifier and enterpriseManagerParentEntityIdentifier must be specified to identify a particular Enterprise Manager parent entity.\n" }, { "name": "enterpriseManagerParentEntityIdentifier", "value": "", "type": "query", "description": "Used in combination with enterpriseManagerIdentifier to return the members of a particular Enterprise Manager parent entity. Both enterpriseManagerIdentifier and enterpriseManagerParentEntityIdentifier must be specified to identify a particular Enterprise Manager parent entity.\n" } ] }, "docs": "Gets a list of importable entities for an Operations Insights Enterprise Manager bridge that have not been imported before.\n" }, { "info": { "name": "Gets a list of Exadata insights.", "type": "http" }, "http": { "method": "GET", "url": "http://127.0.0.1/20200630/exadataInsights", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "compartmentId", "value": "", "type": "query", "description": "The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compartment." }, { "name": "enterpriseManagerBridgeId", "value": "", "type": "query", "description": "Unique Enterprise Manager bridge identifier" }, { "name": "id", "value": "", "type": "query", "description": "Optional list of Exadata insight resource [OCIDs](/iaas/Content/General/Concepts/identifiers.htm).\n" }, { "name": "status", "value": "", "type": "query", "description": "Resource Status" }, { "name": "lifecycleState", "value": "", "type": "query", "description": "Lifecycle states" }, { "name": "exadataType", "value": "", "type": "query", "description": "Filter by one or more Exadata types.\nPossible value are DBMACHINE, EXACS, and EXACC.\n" }, { "name": "limit", "value": "", "type": "query", "description": "For list pagination. The maximum number of results per page, or items to\nreturn in a paginated \"List\" call.\nFor important details about how pagination works, see\n[List Pagination](/Content/API/Concepts/usingapi.htm#nine).\nExample: `50`\n" }, { "name": "page", "value": "", "type": "query", "description": "For list pagination. The value of the `opc-next-page` response header from\nthe previous \"List\" call. For important details about how pagination works,\nsee [List Pagination](/Content/API/Concepts/usingapi.htm#nine).\n" }, { "name": "sortOrder", "value": "", "type": "query", "description": "The sort order to use, either ascending (`ASC`) or descending (`DESC`).\n" }, { "name": "sortBy", "value": "", "type": "query", "description": "Exadata insight list sort options. If `fields` parameter is selected, the `sortBy` parameter must be one of the fields specified. Default order for timeCreated is descending. Default order for exadataName is ascending. If no value is specified timeCreated is default.\n" }, { "name": "compartmentIdInSubtree", "value": "", "type": "query", "description": "A flag to search all resources within a given compartment and all sub-compartments.\n" } ] }, "docs": "Gets a list of Exadata insights based on the query parameters specified. Either compartmentId or id query parameter must be specified.\nWhen both compartmentId and compartmentIdInSubtree are specified, a list of Exadata insights in that compartment and in all sub-compartments will be returned.\n" }, { "info": { "name": "Create an Exadata insight resource for an Exadata system in Operations Insights.", "type": "http" }, "http": { "method": "POST", "url": "http://127.0.0.1/20200630/exadataInsights", "headers": [ { "name": "opc-retry-token", "value": "" }, { "name": "opc-request-id", "value": "" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Create an Exadata insight resource for an Exadata system in Operations Insights. The Exadata system will be enabled in Operations Insights. Exadata-related metric collection and analysis will be started.\n" }, { "info": { "name": "Gets a list of exadata insights configuration.", "type": "http" }, "http": { "method": "GET", "url": "http://127.0.0.1/20200630/exadataInsights/exadataConfigurations", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "compartmentId", "value": "", "type": "query", "description": "The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compartment." }, { "name": "exadataInsightId", "value": "", "type": "query", "description": "Optional list of exadata insight resource [OCIDs](/iaas/Content/General/Concepts/identifiers.htm).\n" }, { "name": "exadataType", "value": "", "type": "query", "description": "Filter by one or more Exadata types.\nPossible value are DBMACHINE, EXACS, and EXACC.\n" }, { "name": "limit", "value": "", "type": "query", "description": "For list pagination. The maximum number of results per page, or items to\nreturn in a paginated \"List\" call.\nFor important details about how pagination works, see\n[List Pagination](/Content/API/Concepts/usingapi.htm#nine).\nExample: `50`\n" }, { "name": "page", "value": "", "type": "query", "description": "For list pagination. The value of the `opc-next-page` response header from\nthe previous \"List\" call. For important details about how pagination works,\nsee [List Pagination](/Content/API/Concepts/usingapi.htm#nine).\n" }, { "name": "sortOrder", "value": "", "type": "query", "description": "The sort order to use, either ascending (`ASC`) or descending (`DESC`).\n" }, { "name": "sortBy", "value": "", "type": "query", "description": "Exadata configuration list sort options. If `fields` parameter is selected, the `sortBy` parameter must be one of the fields specified.\n" }, { "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" }, { "name": "compartmentIdInSubtree", "value": "", "type": "query", "description": "A flag to search all resources within a given compartment and all sub-compartments.\n" } ] }, "docs": "Gets a list of exadata insight configurations. Either compartmentId or exadataInsightsId query parameter must be specified." }, { "info": { "name": "Gets software and hardware inventory for an exadata insight resource.", "type": "http" }, "http": { "method": "GET", "url": "http://127.0.0.1/20200630/exadataInsights/exadataMembers", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "exadataInsightId", "value": "", "type": "query", "description": "[OCID](/iaas/Content/General/Concepts/identifiers.htm) of exadata insight resource.\n" }, { "name": "exadataType", "value": "", "type": "query", "description": "Filter by one or more Exadata types.\nPossible value are DBMACHINE, EXACS, and EXACC.\n" }, { "name": "sortOrder", "value": "", "type": "query", "description": "The sort order to use, either ascending (`ASC`) or descending (`DESC`).\n" }, { "name": "sortBy", "value": "", "type": "query", "description": "The order in which exadata member records are listed" }, { "name": "limit", "value": "", "type": "query", "description": "For list pagination. The maximum number of results per page, or items to\nreturn in a paginated \"List\" call.\nFor important details about how pagination works, see\n[List Pagination](/Content/API/Concepts/usingapi.htm#nine).\nExample: `50`\n" }, { "name": "page", "value": "", "type": "query", "description": "For list pagination. The value of the `opc-next-page` response header from\nthe previous \"List\" call. For important details about how pagination works,\nsee [List Pagination](/Content/API/Concepts/usingapi.htm#nine).\n" } ] }, "docs": "Lists the software and hardware inventory of the Exadata System." }, { "info": { "name": "Gets capacity for an exadata system. Either compartmentId or exadataInsightsId query parameter must be specified.", "type": "http" }, "http": { "method": "GET", "url": "http://127.0.0.1/20200630/exadataInsights/resourceCapacityTrend", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "compartmentId", "value": "", "type": "query", "description": "The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compartment." }, { "name": "resourceType", "value": "", "type": "query", "description": "Filter by resource.\nSupported values are HOST , STORAGE_SERVER and DATABASE\n" }, { "name": "resourceMetric", "value": "", "type": "query", "description": "Filter by resource metric.\nSupported values are CPU , STORAGE, MEMORY, IO, IOPS, THROUGHPUT\n" }, { "name": "analysisTimeInterval", "value": "", "type": "query", "description": "Specify time period in ISO 8601 format with respect to current time.\nDefault is last 30 days represented by P30D.\nIf timeInterval is specified, then timeIntervalStart and timeIntervalEnd will be ignored.\nExamples P90D (last 90 days), P4W (last 4 weeks), P2M (last 2 months), P1Y (last 12 months), . Maximum value allowed is 25 months prior to current time (P25M).\n" }, { "name": "timeIntervalStart", "value": "", "type": "query", "description": "Analysis start time in UTC in ISO 8601 format(inclusive).\nExample 2019-10-30T00:00:00Z (yyyy-MM-ddThh:mm:ssZ).\nThe minimum allowed value is 2 years prior to the current day.\ntimeIntervalStart and timeIntervalEnd parameters are used together.\nIf analysisTimeInterval is specified, this parameter is ignored.\n" }, { "name": "timeIntervalEnd", "value": "", "type": "query", "description": "Analysis end time in UTC in ISO 8601 format(exclusive).\nExample 2019-10-30T00:00:00Z (yyyy-MM-ddThh:mm:ssZ).\ntimeIntervalStart and timeIntervalEnd are used together.\nIf timeIntervalEnd is not specified, current time is used as timeIntervalEnd.\n" }, { "name": "exadataInsightId", "value": "", "type": "query", "description": "[OCID](/iaas/Content/General/Concepts/identifiers.htm) of exadata insight resource.\n" }, { "name": "databaseInsightId", "value": "", "type": "query", "description": "Optional list of database insight resource [OCIDs](/iaas/Content/General/Concepts/identifiers.htm).\n" }, { "name": "hostInsightId", "value": "", "type": "query", "description": "Optional list of host insight resource [OCIDs](/iaas/Content/General/Concepts/identifiers.htm).\n" }, { "name": "storageServerName", "value": "", "type": "query", "description": "Optional storage server name on an exadata system.\n" }, { "name": "exadataType", "value": "", "type": "query", "description": "Filter by one or more Exadata types.\nPossible value are DBMACHINE, EXACS, and EXACC.\n" }, { "name": "cdbName", "value": "", "type": "query", "description": "Filter by one or more cdb name.\n" }, { "name": "hostName", "value": "", "type": "query", "description": "Filter by hostname.\n" }, { "name": "page", "value": "", "type": "query", "description": "For list pagination. The value of the `opc-next-page` response header from\nthe previous \"List\" call. For important details about how pagination works,\nsee [List Pagination](/Content/API/Concepts/usingapi.htm#nine).\n" }, { "name": "limit", "value": "", "type": "query", "description": "For list pagination. The maximum number of results per page, or items to\nreturn in a paginated \"List\" call.\nFor important details about how pagination works, see\n[List Pagination](/Content/API/Concepts/usingapi.htm#nine).\nExample: `50`\n" }, { "name": "sortOrder", "value": "", "type": "query", "description": "The sort order to use, either ascending (`ASC`) or descending (`DESC`).\n" }, { "name": "sortBy", "value": "", "type": "query", "description": "The order in which resource capacity trend records are listed" } ] }, "docs": "Returns response with time series data (endTimestamp, capacity) for the time period specified for an exadata system for a resource metric.\nAdditionally resources can be filtered using databaseInsightId, hostInsightId or storageServerName query parameters.\nTop five resources are returned if total exceeds the limit specified.\nValid values for ResourceType DATABASE are CPU,MEMORY,IO and STORAGE. Database name is returned in name field. DatabaseInsightId, cdbName and hostName query parameter applies" }, { "info": { "name": "Gets capacity for an exadata system. Either compartmentId or exadataInsightsId query parameter must be specified.", "type": "http" }, "http": { "method": "GET", "url": "http://127.0.0.1/20200630/exadataInsights/resourceCapacityTrendAggregated", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "compartmentId", "value": "", "type": "query", "description": "The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compartment." }, { "name": "resourceType", "value": "", "type": "query", "description": "Filter by resource.\nSupported values are HOST , STORAGE_SERVER and DATABASE\n" }, { "name": "resourceMetric", "value": "", "type": "query", "description": "Filter by resource metric.\nSupported values are CPU , STORAGE, MEMORY, IO, IOPS, THROUGHPUT\n" }, { "name": "analysisTimeInterval", "value": "", "type": "query", "description": "Specify time period in ISO 8601 format with respect to current time.\nDefault is last 30 days represented by P30D.\nIf timeInterval is specified, then timeIntervalStart and timeIntervalEnd will be ignored.\nExamples P90D (last 90 days), P4W (last 4 weeks), P2M (last 2 months), P1Y (last 12 months), . Maximum value allowed is 25 months prior to current time (P25M).\n" }, { "name": "timeIntervalStart", "value": "", "type": "query", "description": "Analysis start time in UTC in ISO 8601 format(inclusive).\nExample 2019-10-30T00:00:00Z (yyyy-MM-ddThh:mm:ssZ).\nThe minimum allowed value is 2 years prior to the current day.\ntimeIntervalStart and timeIntervalEnd parameters are used together.\nIf analysisTimeInterval is specified, this parameter is ignored.\n" }, { "name": "timeIntervalEnd", "value": "", "type": "query", "description": "Analysis end time in UTC in ISO 8601 format(exclusive).\nExample 2019-10-30T00:00:00Z (yyyy-MM-ddThh:mm:ssZ).\ntimeIntervalStart and timeIntervalEnd are used together.\nIf timeIntervalEnd is not specified, current time is used as timeIntervalEnd.\n" }, { "name": "exadataInsightId", "value": "", "type": "query", "description": "Optional list of exadata insight resource [OCIDs](/iaas/Content/General/Concepts/identifiers.htm).\n" }, { "name": "exadataType", "value": "", "type": "query", "description": "Filter by one or more Exadata types.\nPossible value are DBMACHINE, EXACS, and EXACC.\n" }, { "name": "cdbName", "value": "", "type": "query", "description": "Filter by one or more cdb name.\n" }, { "name": "hostName", "value": "", "type": "query", "description": "Filter by hostname.\n" }, { "name": "page", "value": "", "type": "query", "description": "For list pagination. The value of the `opc-next-page` response header from\nthe previous \"List\" call. For important details about how pagination works,\nsee [List Pagination](/Content/API/Concepts/usingapi.htm#nine).\n" }, { "name": "sortOrder", "value": "", "type": "query", "description": "The sort order to use, either ascending (`ASC`) or descending (`DESC`).\n" }, { "name": "sortBy", "value": "", "type": "query", "description": "Sorts using end timestamp or capacity.\n" }, { "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" }, { "name": "compartmentIdInSubtree", "value": "", "type": "query", "description": "A flag to search all resources within a given compartment and all sub-compartments.\n" } ] }, "docs": "Returns response with time series data (endTimestamp, capacity) for the time period specified for an exadata system or fleet aggregation for a resource metric.\nThe maximum time range for analysis is 2 years, hence this is intentionally not paginated.\nValid values for ResourceType DATABASE are CPU,MEMORY,IO and STORAGE.\nValid values for ResourceType HOST are CPU and MEMORY.\nValid values for ResourceType STORAGE_SERVER are STORAGE, IOPS and THROUGHPUT.\n" }, { "info": { "name": "Get historical usage and forecast predictions for an exadata system with breakdown by databases, hosts,storage servers or diskgroup.", "type": "http" }, "http": { "method": "GET", "url": "http://127.0.0.1/20200630/exadataInsights/resourceForecastTrend", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "resourceType", "value": "", "type": "query", "description": "Filter by resource.\nSupported values are HOST , STORAGE_SERVER and DATABASE\n" }, { "name": "resourceMetric", "value": "", "type": "query", "description": "Filter by resource metric.\nSupported values are CPU , STORAGE, MEMORY, IO, IOPS, THROUGHPUT\n" }, { "name": "analysisTimeInterval", "value": "", "type": "query", "description": "Specify time period in ISO 8601 format with respect to current time.\nDefault is last 30 days represented by P30D.\nIf timeInterval is specified, then timeIntervalStart and timeIntervalEnd will be ignored.\nExamples P90D (last 90 days), P4W (last 4 weeks), P2M (last 2 months), P1Y (last 12 months), . Maximum value allowed is 25 months prior to current time (P25M).\n" }, { "name": "timeIntervalStart", "value": "", "type": "query", "description": "Analysis start time in UTC in ISO 8601 format(inclusive).\nExample 2019-10-30T00:00:00Z (yyyy-MM-ddThh:mm:ssZ).\nThe minimum allowed value is 2 years prior to the current day.\ntimeIntervalStart and timeIntervalEnd parameters are used together.\nIf analysisTimeInterval is specified, this parameter is ignored.\n" }, { "name": "timeIntervalEnd", "value": "", "type": "query", "description": "Analysis end time in UTC in ISO 8601 format(exclusive).\nExample 2019-10-30T00:00:00Z (yyyy-MM-ddThh:mm:ssZ).\ntimeIntervalStart and timeIntervalEnd are used together.\nIf timeIntervalEnd is not specified, current time is used as timeIntervalEnd.\n" }, { "name": "exadataInsightId", "value": "", "type": "query", "description": "[OCID](/iaas/Content/General/Concepts/identifiers.htm) of exadata insight resource.\n" }, { "name": "databaseInsightId", "value": "", "type": "query", "description": "Optional list of database insight resource [OCIDs](/iaas/Content/General/Concepts/identifiers.htm).\n" }, { "name": "hostInsightId", "value": "", "type": "query", "description": "Optional list of host insight resource [OCIDs](/iaas/Content/General/Concepts/identifiers.htm).\n" }, { "name": "storageServerName", "value": "", "type": "query", "description": "Optional storage server name on an exadata system.\n" }, { "name": "exadataType", "value": "", "type": "query", "description": "Filter by one or more Exadata types.\nPossible value are DBMACHINE, EXACS, and EXACC.\n" }, { "name": "statistic", "value": "", "type": "query", "description": "Choose the type of statistic metric data to be used for forecasting." }, { "name": "forecastStartDay", "value": "", "type": "query", "description": "Number of days used for utilization forecast analysis.\n" }, { "name": "forecastDays", "value": "", "type": "query", "description": "Number of days used for utilization forecast analysis.\n" }, { "name": "forecastModel", "value": "", "type": "query", "description": "Choose algorithm model for the forecasting.\nPossible values:\n - LINEAR: Uses linear regression algorithm for forecasting.\n - ML_AUTO: Automatically detects best algorithm to use for forecasting.\n - ML_NO_AUTO: Automatically detects seasonality of the data for forecasting using linear or seasonal algorithm.\n" }, { "name": "cdbName", "value": "", "type": "query", "description": "Filter by one or more cdb name.\n" }, { "name": "hostName", "value": "", "type": "query", "description": "Filter by hostname.\n" }, { "name": "limit", "value": "", "type": "query", "description": "For list pagination. The maximum number of results per page, or items to\nreturn in a paginated \"List\" call.\nFor important details about how pagination works, see\n[List Pagination](/Content/API/Concepts/usingapi.htm#nine).\nExample: `50`\n" }, { "name": "confidence", "value": "", "type": "query", "description": "This parameter is used to change data's confidence level, this data is ingested by the\nforecast algorithm.\nConfidence is the probability of an interval to contain the expected population parameter.\nManipulation of this value will lead to different results.\nIf not set, default confidence value is 95%.\n" }, { "name": "sortOrder", "value": "", "type": "query", "description": "The sort order to use, either ascending (`ASC`) or descending (`DESC`).\n" }, { "name": "sortBy", "value": "", "type": "query", "description": "The order in which resource Forecast trend records are listed" }, { "name": "page", "value": "", "type": "query", "description": "For list pagination. The value of the `opc-next-page` response header from\nthe previous \"List\" call. For important details about how pagination works,\nsee [List Pagination](/Content/API/Concepts/usingapi.htm#nine).\n" } ] }, "docs": "Get historical usage and forecast predictions for an exadata system with breakdown by databases, hosts or storage servers.\nAdditionally resources can be filtered using databaseInsightId, hostInsightId or storageServerName query parameters.\nTop five resources are returned if total exceeds the limit specified.\nValid values for ResourceType DATABASE are CPU,MEMORY,IO and STORAGE. Database name is returned in name field. DatabaseInsightId , cdbName and hostName query parameter applies to ResourceTyp" }, { "info": { "name": "Get aggregated historical usage and forecast predictions for exadata systems.", "type": "http" }, "http": { "method": "GET", "url": "http://127.0.0.1/20200630/exadataInsights/resourceForecastTrendAggregated", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "compartmentId", "value": "", "type": "query", "description": "The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compartment." }, { "name": "resourceType", "value": "", "type": "query", "description": "Filter by resource.\nSupported values are HOST , STORAGE_SERVER and DATABASE\n" }, { "name": "resourceMetric", "value": "", "type": "query", "description": "Filter by resource metric.\nSupported values are CPU , STORAGE, MEMORY, IO, IOPS, THROUGHPUT\n" }, { "name": "analysisTimeInterval", "value": "", "type": "query", "description": "Specify time period in ISO 8601 format with respect to current time.\nDefault is last 30 days represented by P30D.\nIf timeInterval is specified, then timeIntervalStart and timeIntervalEnd will be ignored.\nExamples P90D (last 90 days), P4W (last 4 weeks), P2M (last 2 months), P1Y (last 12 months), . Maximum value allowed is 25 months prior to current time (P25M).\n" }, { "name": "timeIntervalStart", "value": "", "type": "query", "description": "Analysis start time in UTC in ISO 8601 format(inclusive).\nExample 2019-10-30T00:00:00Z (yyyy-MM-ddThh:mm:ssZ).\nThe minimum allowed value is 2 years prior to the current day.\ntimeIntervalStart and timeIntervalEnd parameters are used together.\nIf analysisTimeInterval is specified, this parameter is ignored.\n" }, { "name": "timeIntervalEnd", "value": "", "type": "query", "description": "Analysis end time in UTC in ISO 8601 format(exclusive).\nExample 2019-10-30T00:00:00Z (yyyy-MM-ddThh:mm:ssZ).\ntimeIntervalStart and timeIntervalEnd are used together.\nIf timeIntervalEnd is not specified, current time is used as timeIntervalEnd.\n" }, { "name": "exadataInsightId", "value": "", "type": "query", "description": "Optional list of exadata insight resource [OCIDs](/iaas/Content/General/Concepts/identifiers.htm).\n" }, { "name": "exadataType", "value": "", "type": "query", "description": "Filter by one or more Exadata types.\nPossible value are DBMACHINE, EXACS, and EXACC.\n" }, { "name": "statistic", "value": "", "type": "query", "description": "Choose the type of statistic metric data to be used for forecasting." }, { "name": "forecastStartDay", "value": "", "type": "query", "description": "Number of days used for utilization forecast analysis.\n" }, { "name": "forecastDays", "value": "", "type": "query", "description": "Number of days used for utilization forecast analysis.\n" }, { "name": "forecastModel", "value": "", "type": "query", "description": "Choose algorithm model for the forecasting.\nPossible values:\n - LINEAR: Uses linear regression algorithm for forecasting.\n - ML_AUTO: Automatically detects best algorithm to use for forecasting.\n - ML_NO_AUTO: Automatically detects seasonality of the data for forecasting using linear or seasonal algorithm.\n" }, { "name": "cdbName", "value": "", "type": "query", "description": "Filter by one or more cdb name.\n" }, { "name": "hostName", "value": "", "type": "query", "description": "Filter by hostname.\n" }, { "name": "confidence", "value": "", "type": "query", "description": "This parameter is used to change data's confidence level, this data is ingested by the\nforecast algorithm.\nConfidence is the probability of an interval to contain the expected population parameter.\nManipulation of this value will lead to different results.\nIf not set, default confidence value is 95%.\n" }, { "name": "page", "value": "", "type": "query", "description": "For list pagination. The value of the `opc-next-page` response header from\nthe previous \"List\" call. For important details about how pagination works,\nsee [List Pagination](/Content/API/Concepts/usingapi.htm#nine).\n" }, { "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" }, { "name": "compartmentIdInSubtree", "value": "", "type": "query", "description": "A flag to search all resources within a given compartment and all sub-compartments.\n" } ] }, "docs": "Get aggregated historical usage and forecast predictions for resources. Either compartmentId or exadataInsightsId query parameter must be specified.\nValid values for ResourceType DATABASE are CPU,MEMORY,IO and STORAGE.\nValid values for ResourceType HOST are CPU and MEMORY.\nValid values for ResourceType STORAGE_SERVER are STORAGE, IOPS and THROUGHPUT.\n" }, { "info": { "name": "Lists the Resource statistics for each resource/member of the Exadata System (database, hosts, storage server or diskgroup).", "type": "http" }, "http": { "method": "GET", "url": "http://127.0.0.1/20200630/exadataInsights/resourceStatistics", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "exadataInsightId", "value": "", "type": "query", "description": "[OCID](/iaas/Content/General/Concepts/identifiers.htm) of exadata insight resource.\n" }, { "name": "resourceType", "value": "", "type": "query", "description": "Filter by resource.\nSupported values are HOST , STORAGE_SERVER and DATABASE\n" }, { "name": "resourceMetric", "value": "", "type": "query", "description": "Filter by resource metric.\nSupported values are CPU , STORAGE, MEMORY, IO, IOPS, THROUGHPUT\n" }, { "name": "analysisTimeInterval", "value": "", "type": "query", "description": "Specify time period in ISO 8601 format with respect to current time.\nDefault is last 30 days represented by P30D.\nIf timeInterval is specified, then timeIntervalStart and timeIntervalEnd will be ignored.\nExamples P90D (last 90 days), P4W (last 4 weeks), P2M (last 2 months), P1Y (last 12 months), . Maximum value allowed is 25 months prior to current time (P25M).\n" }, { "name": "timeIntervalStart", "value": "", "type": "query", "description": "Analysis start time in UTC in ISO 8601 format(inclusive).\nExample 2019-10-30T00:00:00Z (yyyy-MM-ddThh:mm:ssZ).\nThe minimum allowed value is 2 years prior to the current day.\ntimeIntervalStart and timeIntervalEnd parameters are used together.\nIf analysisTimeInterval is specified, this parameter is ignored.\n" }, { "name": "timeIntervalEnd", "value": "", "type": "query", "description": "Analysis end time in UTC in ISO 8601 format(exclusive).\nExample 2019-10-30T00:00:00Z (yyyy-MM-ddThh:mm:ssZ).\ntimeIntervalStart and timeIntervalEnd are used together.\nIf timeIntervalEnd is not specified, current time is used as timeIntervalEnd.\n" }, { "name": "exadataType", "value": "", "type": "query", "description": "Filter by one or more Exadata types.\nPossible value are DBMACHINE, EXACS, and EXACC.\n" }, { "name": "cdbName", "value": "", "type": "query", "description": "Filter by one or more cdb name.\n" }, { "name": "hostName", "value": "", "type": "query", "description": "Filter by hostname.\n" }, { "name": "percentile", "value": "", "type": "query", "description": "Percentile values of daily usage to be used for computing the aggregate resource usage.\n" }, { "name": "sortOrder", "value": "", "type": "query", "description": "The sort order to use, either ascending (`ASC`) or descending (`DESC`).\n" }, { "name": "sortBy", "value": "", "type": "query", "description": "The order in which resource statistics records are listed\n" }, { "name": "limit", "value": "", "type": "query", "description": "For list pagination. The maximum number of results per page, or items to\nreturn in a paginated \"List\" call.\nFor important details about how pagination works, see\n[List Pagination](/Content/API/Concepts/usingapi.htm#nine).\nExample: `50`\n" }, { "name": "page", "value": "", "type": "query", "description": "For list pagination. The value of the `opc-next-page` response header from\nthe previous \"List\" call. For important details about how pagination works,\nsee [List Pagination](/Content/API/Concepts/usingapi.htm#nine).\n" } ] }, "docs": "Lists the Resource statistics (usage, capacity, usage change percent, utilization percent) for each resource based on resourceMetric filtered by utilization level.\nValid values for ResourceType DATABASE are CPU,MEMORY,IO and STORAGE.\nValid values for ResourceType HOST are CPU and MEMORY.\nValid values for ResourceType STORAGE_SERVER are STORAGE, IOPS, THROUGHPUT.\nValid value for ResourceType DISKGROUP is STORAGE.\n" }, { "info": { "name": "Get usage, capacity and usage change percentage for exadata systems for the current time period.", "type": "http" }, "http": { "method": "GET", "url": "http://127.0.0.1/20200630/exadataInsights/resourceUsageSummary", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "compartmentId", "value": "", "type": "query", "description": "The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compartment." }, { "name": "resourceType", "value": "", "type": "query", "description": "Filter by resource.\nSupported values are HOST , STORAGE_SERVER and DATABASE\n" }, { "name": "resourceMetric", "value": "", "type": "query", "description": "Filter by resource metric.\nSupported values are CPU , STORAGE, MEMORY, IO, IOPS, THROUGHPUT\n" }, { "name": "analysisTimeInterval", "value": "", "type": "query", "description": "Specify time period in ISO 8601 format with respect to current time.\nDefault is last 30 days represented by P30D.\nIf timeInterval is specified, then timeIntervalStart and timeIntervalEnd will be ignored.\nExamples P90D (last 90 days), P4W (last 4 weeks), P2M (last 2 months), P1Y (last 12 months), . Maximum value allowed is 25 months prior to current time (P25M).\n" }, { "name": "timeIntervalStart", "value": "", "type": "query", "description": "Analysis start time in UTC in ISO 8601 format(inclusive).\nExample 2019-10-30T00:00:00Z (yyyy-MM-ddThh:mm:ssZ).\nThe minimum allowed value is 2 years prior to the current day.\ntimeIntervalStart and timeIntervalEnd parameters are used together.\nIf analysisTimeInterval is specified, this parameter is ignored.\n" }, { "name": "timeIntervalEnd", "value": "", "type": "query", "description": "Analysis end time in UTC in ISO 8601 format(exclusive).\nExample 2019-10-30T00:00:00Z (yyyy-MM-ddThh:mm:ssZ).\ntimeIntervalStart and timeIntervalEnd are used together.\nIf timeIntervalEnd is not specified, current time is used as timeIntervalEnd.\n" }, { "name": "exadataInsightId", "value": "", "type": "query", "description": "Optional list of exadata insight resource [OCIDs](/iaas/Content/General/Concepts/identifiers.htm).\n" }, { "name": "exadataType", "value": "", "type": "query", "description": "Filter by one or more Exadata types.\nPossible value are DBMACHINE, EXACS, and EXACC.\n" }, { "name": "cdbName", "value": "", "type": "query", "description": "Filter by one or more cdb name.\n" }, { "name": "hostName", "value": "", "type": "query", "description": "Filter by hostname.\n" }, { "name": "sortOrder", "value": "", "type": "query", "description": "The sort order to use, either ascending (`ASC`) or descending (`DESC`).\n" }, { "name": "sortBy", "value": "", "type": "query", "description": "The order in which resource usage summary records are listed\n" }, { "name": "page", "value": "", "type": "query", "description": "For list pagination. The value of the `opc-next-page` response header from\nthe previous \"List\" call. For important details about how pagination works,\nsee [List Pagination](/Content/API/Concepts/usingapi.htm#nine).\n" }, { "name": "limit", "value": "", "type": "query", "description": "For list pagination. The maximum number of results per page, or items to\nreturn in a paginated \"List\" call.\nFor important details about how pagination works, see\n[List Pagination](/Content/API/Concepts/usingapi.htm#nine).\nExample: `50`\n" }, { "name": "percentile", "value": "", "type": "query", "description": "Percentile values of daily usage to be used for computing the aggregate resource usage.\n" }, { "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" }, { "name": "compartmentIdInSubtree", "value": "", "type": "query", "description": "A flag to search all resources within a given compartment and all sub-compartments.\n" } ] }, "docs": "A cumulative distribution function is used to rank the usage data points per resource within the specified time period.\nFor each resource, the minimum data point with a ranking > the percentile value is included in the summation.\nLinear regression functions are used to calculate the usage change percentage.\nValid values for ResourceType DATABASE are CPU,MEMORY,IO and STORAGE.\nValid values for ResourceType HOST are CPU and MEMORY.\nValid values for ResourceType STORAGE_SERVER are STORAGE, IOPS and" }, { "info": { "name": "Get aggregated usage, capacity and usage change percentage summed across exadata systems for the current time period.", "type": "http" }, "http": { "method": "GET", "url": "http://127.0.0.1/20200630/exadataInsights/resourceUsageSummaryAggregated", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "compartmentId", "value": "", "type": "query", "description": "The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compartment." }, { "name": "resourceType", "value": "", "type": "query", "description": "Filter by resource.\nSupported values are HOST , STORAGE_SERVER and DATABASE\n" }, { "name": "resourceMetric", "value": "", "type": "query", "description": "Filter by resource metric.\nSupported values are CPU , STORAGE, MEMORY, IO, IOPS, THROUGHPUT\n" }, { "name": "analysisTimeInterval", "value": "", "type": "query", "description": "Specify time period in ISO 8601 format with respect to current time.\nDefault is last 30 days represented by P30D.\nIf timeInterval is specified, then timeIntervalStart and timeIntervalEnd will be ignored.\nExamples P90D (last 90 days), P4W (last 4 weeks), P2M (last 2 months), P1Y (last 12 months), . Maximum value allowed is 25 months prior to current time (P25M).\n" }, { "name": "timeIntervalStart", "value": "", "type": "query", "description": "Analysis start time in UTC in ISO 8601 format(inclusive).\nExample 2019-10-30T00:00:00Z (yyyy-MM-ddThh:mm:ssZ).\nThe minimum allowed value is 2 years prior to the current day.\ntimeIntervalStart and timeIntervalEnd parameters are used together.\nIf analysisTimeInterval is specified, this parameter is ignored.\n" }, { "name": "timeIntervalEnd", "value": "", "type": "query", "description": "Analysis end time in UTC in ISO 8601 format(exclusive).\nExample 2019-10-30T00:00:00Z (yyyy-MM-ddThh:mm:ssZ).\ntimeIntervalStart and timeIntervalEnd are used together.\nIf timeIntervalEnd is not specified, current time is used as timeIntervalEnd.\n" }, { "name": "exadataInsightId", "value": "", "type": "query", "description": "Optional list of exadata insight resource [OCIDs](/iaas/Content/General/Concepts/identifiers.htm).\n" }, { "name": "exadataType", "value": "", "type": "query", "description": "Filter by one or more Exadata types.\nPossible value are DBMACHINE, EXACS, and EXACC.\n" }, { "name": "cdbName", "value": "", "type": "query", "description": "Filter by one or more cdb name.\n" }, { "name": "hostName", "value": "", "type": "query", "description": "Filter by hostname.\n" }, { "name": "page", "value": "", "type": "query", "description": "For list pagination. The value of the `opc-next-page` response header from\nthe previous \"List\" call. For important details about how pagination works,\nsee [List Pagination](/Content/API/Concepts/usingapi.htm#nine).\n" }, { "name": "percentile", "value": "", "type": "query", "description": "Percentile values of daily usage to be used for computing the aggregate resource usage.\n" }, { "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" }, { "name": "compartmentIdInSubtree", "value": "", "type": "query", "description": "A flag to search all resources within a given compartment and all sub-compartments.\n" } ] }, "docs": "A cumulative distribution function is used to rank the usage data points per database within the specified time period.\nFor each database, the minimum data point with a ranking > the percentile value is included in the summation.\nLinear regression functions are used to calculate the usage change percentage.\nValid values for ResourceType DATABASE are CPU,MEMORY,IO and STORAGE.\nValid values for ResourceType HOST are CPU and MEMORY.\nValid values for ResourceType STORAGE_SERVER are STORAGE, IOPS and" }, { "info": { "name": "Gets current utilization and projected insights for an exadata system.", "type": "http" }, "http": { "method": "GET", "url": "http://127.0.0.1/20200630/exadataInsights/resourceUtilizationInsight", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "compartmentId", "value": "", "type": "query", "description": "The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compartment." }, { "name": "resourceType", "value": "", "type": "query", "description": "Filter by resource.\nSupported values are HOST , STORAGE_SERVER and DATABASE\n" }, { "name": "resourceMetric", "value": "", "type": "query", "description": "Filter by resource metric.\nSupported values are CPU , STORAGE, MEMORY, IO, IOPS, THROUGHPUT\n" }, { "name": "analysisTimeInterval", "value": "", "type": "query", "description": "Specify time period in ISO 8601 format with respect to current time.\nDefault is last 30 days represented by P30D.\nIf timeInterval is specified, then timeIntervalStart and timeIntervalEnd will be ignored.\nExamples P90D (last 90 days), P4W (last 4 weeks), P2M (last 2 months), P1Y (last 12 months), . Maximum value allowed is 25 months prior to current time (P25M).\n" }, { "name": "timeIntervalStart", "value": "", "type": "query", "description": "Analysis start time in UTC in ISO 8601 format(inclusive).\nExample 2019-10-30T00:00:00Z (yyyy-MM-ddThh:mm:ssZ).\nThe minimum allowed value is 2 years prior to the current day.\ntimeIntervalStart and timeIntervalEnd parameters are used together.\nIf analysisTimeInterval is specified, this parameter is ignored.\n" }, { "name": "timeIntervalEnd", "value": "", "type": "query", "description": "Analysis end time in UTC in ISO 8601 format(exclusive).\nExample 2019-10-30T00:00:00Z (yyyy-MM-ddThh:mm:ssZ).\ntimeIntervalStart and timeIntervalEnd are used together.\nIf timeIntervalEnd is not specified, current time is used as timeIntervalEnd.\n" }, { "name": "exadataInsightId", "value": "", "type": "query", "description": "Optional list of exadata insight resource [OCIDs](/iaas/Content/General/Concepts/identifiers.htm).\n" }, { "name": "exadataType", "value": "", "type": "query", "description": "Filter by one or more Exadata types.\nPossible value are DBMACHINE, EXACS, and EXACC.\n" }, { "name": "forecastStartDay", "value": "", "type": "query", "description": "Number of days used for utilization forecast analysis.\n" }, { "name": "forecastDays", "value": "", "type": "query", "description": "Number of days used for utilization forecast analysis.\n" }, { "name": "cdbName", "value": "", "type": "query", "description": "Filter by one or more cdb name.\n" }, { "name": "hostName", "value": "", "type": "query", "description": "Filter by hostname.\n" }, { "name": "limit", "value": "", "type": "query", "description": "For list pagination. The maximum number of results per page, or items to\nreturn in a paginated \"List\" call.\nFor important details about how pagination works, see\n[List Pagination](/Content/API/Concepts/usingapi.htm#nine).\nExample: `50`\n" }, { "name": "page", "value": "", "type": "query", "description": "For list pagination. The value of the `opc-next-page` response header from\nthe previous \"List\" call. For important details about how pagination works,\nsee [List Pagination](/Content/API/Concepts/usingapi.htm#nine).\n" }, { "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" }, { "name": "compartmentIdInSubtree", "value": "", "type": "query", "description": "A flag to search all resources within a given compartment and all sub-compartments.\n" }, { "name": "highUtilizationThreshold", "value": "", "type": "query", "description": "Percent value in which a resource metric is considered highly utilized." }, { "name": "lowUtilizationThreshold", "value": "", "type": "query", "description": "Percent value in which a resource metric is considered low utilized." } ] }, "docs": "Gets current utilization, projected utilization and days to reach projectedUtilization for an exadata system over specified time period. Valid values for ResourceType DATABASE are CPU,MEMORY,IO and STORAGE. Valid values for ResourceType HOST are CPU and MEMORY. Valid values for ResourceType STORAGE_SERVER are STORAGE, IOPS and THROUGHPUT." }, { "info": { "name": "Gets details of an Exadata insight.", "type": "http" }, "http": { "method": "GET", "url": "http://127.0.0.1/20200630/exadataInsights/:exadataInsightId", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "exadataInsightId", "value": "", "type": "path", "description": "Unique Exadata insight identifier" } ] }, "docs": "Gets details of an Exadata insight." }, { "info": { "name": "Updates configuration of an Exadata insight.", "type": "http" }, "http": { "method": "PUT", "url": "http://127.0.0.1/20200630/exadataInsights/:exadataInsightId", "headers": [ { "name": "if-match", "value": "" }, { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "exadataInsightId", "value": "", "type": "path", "description": "Unique Exadata insight identifier" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Updates configuration of an Exadata insight." }, { "info": { "name": "Deletes an Exadata insight.", "type": "http" }, "http": { "method": "DELETE", "url": "http://127.0.0.1/20200630/exadataInsights/:exadataInsightId", "headers": [ { "name": "if-match", "value": "" }, { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "exadataInsightId", "value": "", "type": "path", "description": "Unique Exadata insight identifier" } ] }, "docs": "Deletes an Exadata insight. The Exadata insight will be deleted and cannot be enabled again." }, { "info": { "name": "Add new members (e.g. databases and hosts) to an Exadata system in Operations Insights.", "type": "http" }, "http": { "method": "POST", "url": "http://127.0.0.1/20200630/exadataInsights/:exadataInsightId/actions/addMembers", "headers": [ { "name": "if-match", "value": "" }, { "name": "opc-request-id", "value": "" }, { "name": "opc-retry-token", "value": "" } ], "params": [ { "name": "exadataInsightId", "value": "", "type": "path", "description": "Unique Exadata insight identifier" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Add new members (e.g. databases and hosts) to an Exadata system in Operations Insights. Exadata-related metric collection and analysis will be started." }, { "info": { "name": "Moves a resource into a different compartment.", "type": "http" }, "http": { "method": "POST", "url": "http://127.0.0.1/20200630/exadataInsights/:exadataInsightId/actions/changeCompartment", "headers": [ { "name": "if-match", "value": "" }, { "name": "opc-request-id", "value": "" }, { "name": "opc-retry-token", "value": "" } ], "params": [ { "name": "exadataInsightId", "value": "", "type": "path", "description": "Unique Exadata insight identifier" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Moves an Exadata insight resource from one compartment identifier to another. When provided, If-Match is checked against ETag values of the resource." }, { "info": { "name": "Disables an Exadata system in Operations Insights.", "type": "http" }, "http": { "method": "POST", "url": "http://127.0.0.1/20200630/exadataInsights/:exadataInsightId/actions/disable", "headers": [ { "name": "if-match", "value": "" }, { "name": "opc-request-id", "value": "" }, { "name": "opc-retry-token", "value": "" } ], "params": [ { "name": "exadataInsightId", "value": "", "type": "path", "description": "Unique Exadata insight identifier" } ] }, "docs": "Disables an Exadata system in Operations Insights. Exadata-related metric collection and analysis will be stopped." }, { "info": { "name": "Disables a chargeback plan on an Exadata system in Operations Insights.", "type": "http" }, "http": { "method": "POST", "url": "http://127.0.0.1/20200630/exadataInsights/:exadataInsightId/actions/disablePlan", "headers": [ { "name": "if-match", "value": "" }, { "name": "opc-request-id", "value": "" }, { "name": "opc-retry-token", "value": "" } ], "params": [ { "name": "exadataInsightId", "value": "", "type": "path", "description": "Unique Exadata insight identifier" } ] }, "docs": "Disables a chargeback plan on an Exadata system in Operations Insights. Metering-related metric collection and analysis will be stopped." }, { "info": { "name": "Enables an Exadata system in Operations Insights.", "type": "http" }, "http": { "method": "POST", "url": "http://127.0.0.1/20200630/exadataInsights/:exadataInsightId/actions/enable", "headers": [ { "name": "if-match", "value": "" }, { "name": "opc-request-id", "value": "" }, { "name": "opc-retry-token", "value": "" } ], "params": [ { "name": "exadataInsightId", "value": "", "type": "path", "description": "Unique Exadata insight identifier" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Enables an Exadata system in Operations Insights. Exadata-related metric collection and analysis will be started." }, { "info": { "name": "Enables a chargeback plan on an Exadata system in Operations Insights.", "type": "http" }, "http": { "method": "POST", "url": "http://127.0.0.1/20200630/exadataInsights/:exadataInsightId/actions/enablePlan", "headers": [ { "name": "if-match", "value": "" }, { "name": "opc-request-id", "value": "" }, { "name": "opc-retry-token", "value": "" } ], "params": [ { "name": "exadataInsightId", "value": "", "type": "path", "description": "Unique Exadata insight identifier" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Enables a chargeback plan on an Exadata system in Operations Insights. Metering-related metric collection and analysis will be started." }, { "info": { "name": "Gets a list of host insights.", "type": "http" }, "http": { "method": "GET", "url": "http://127.0.0.1/20200630/hostInsights", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "compartmentId", "value": "", "type": "query", "description": "The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compartment." }, { "name": "id", "value": "", "type": "query", "description": "Optional list of host insight resource [OCIDs](/iaas/Content/General/Concepts/identifiers.htm).\n" }, { "name": "status", "value": "", "type": "query", "description": "Resource Status" }, { "name": "lifecycleState", "value": "", "type": "query", "description": "Lifecycle states" }, { "name": "hostType", "value": "", "type": "query", "description": "Filter by one or more host types.\nPossible values are CLOUD-HOST, EXTERNAL-HOST, COMANAGED-VM-HOST, COMANAGED-BM-HOST, COMANAGED-EXACS-HOST, COMANAGED-EXACC-HOST\n" }, { "name": "platformType", "value": "", "type": "query", "description": "Filter by one or more platform types.\nSupported platformType(s) for MACS-managed external host insight: [LINUX, SOLARIS, WINDOWS].\nSupported platformType(s) for MACS-managed cloud host insight: [LINUX].\nSupported platformType(s) for EM-managed external host insight: [LINUX, SOLARIS, SUNOS, ZLINUX, WINDOWS, AIX, HP-UX].\n" }, { "name": "limit", "value": "", "type": "query", "description": "For list pagination. The maximum number of results per page, or items to\nreturn in a paginated \"List\" call.\nFor important details about how pagination works, see\n[List Pagination](/Content/API/Concepts/usingapi.htm#nine).\nExample: `50`\n" }, { "name": "page", "value": "", "type": "query", "description": "For list pagination. The value of the `opc-next-page` response header from\nthe previous \"List\" call. For important details about how pagination works,\nsee [List Pagination](/Content/API/Concepts/usingapi.htm#nine).\n" }, { "name": "sortOrder", "value": "", "type": "query", "description": "The sort order to use, either ascending (`ASC`) or descending (`DESC`).\n" }, { "name": "sortBy", "value": "", "type": "query", "description": "Host insight list sort options. If `fields` parameter is selected, the `sortBy` parameter must be one of the fields specified.\n" }, { "name": "enterpriseManagerBridgeId", "value": "", "type": "query", "description": "Unique Enterprise Manager bridge identifier" }, { "name": "exadataInsightId", "value": "", "type": "query", "description": "[OCID](/iaas/Content/General/Concepts/identifiers.htm) of exadata insight resource.\n" }, { "name": "kubeClusterInsightId", "value": "", "type": "query", "description": "[OCID](/iaas/Content/General/Concepts/identifiers.htm) of K8s cluster insight resource.\n" }, { "name": "compartmentIdInSubtree", "value": "", "type": "query", "description": "A flag to search all resources within a given compartment and all sub-compartments.\n" } ] }, "docs": "Gets a list of host insights based on the query parameters specified. Either compartmentId or id query parameter must be specified.\nWhen both compartmentId and compartmentIdInSubtree are specified, a list of host insights in that compartment and in all sub-compartments will be returned.\n" }, { "info": { "name": "Create a Host Insight resource for a host in Ops Insights.", "type": "http" }, "http": { "method": "POST", "url": "http://127.0.0.1/20200630/hostInsights", "headers": [ { "name": "opc-retry-token", "value": "" }, { "name": "opc-request-id", "value": "" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Create a Host Insight resource for a host in Ops Insights. The host will be enabled in Ops Insights. Host metric collection and analysis will be started.\n" }, { "info": { "name": "Accepts the host configuration metrics payload and persists it in the Ops Insights ingest pipeline.", "type": "http" }, "http": { "method": "POST", "url": "http://127.0.0.1/20200630/hostInsights/actions/ingestHostConfiguration", "headers": [ { "name": "opc-request-id", "value": "" }, { "name": "if-match", "value": "" }, { "name": "opc-retry-token", "value": "" } ], "params": [ { "name": "id", "value": "", "type": "query", "description": "Required [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the host insight resource.\n" } ], "body": { "type": "json", "data": "{}" } }, "docs": "This is a generic ingest endpoint for all the host configuration metrics" }, { "info": { "name": "Accepts the host performance metrics payload and persists it in the Ops Insights ingest pipeline.", "type": "http" }, "http": { "method": "POST", "url": "http://127.0.0.1/20200630/hostInsights/actions/ingestHostMetrics", "headers": [ { "name": "opc-request-id", "value": "" }, { "name": "if-match", "value": "" }, { "name": "opc-retry-token", "value": "" } ], "params": [ { "name": "id", "value": "", "type": "query", "description": "Required [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the host insight resource.\n" } ], "body": { "type": "json", "data": "{}" } }, "docs": "This is a generic ingest endpoint for all the host performance metrics" }, { "info": { "name": "Gets disk(s) statistics for a host.", "type": "http" }, "http": { "method": "GET", "url": "http://127.0.0.1/20200630/hostInsights/diskStatistics", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "compartmentId", "value": "", "type": "query", "description": "The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compartment." }, { "name": "id", "value": "", "type": "query", "description": "Required [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the host insight resource.\n" }, { "name": "analysisTimeInterval", "value": "", "type": "query", "description": "Specify time period in ISO 8601 format with respect to current time.\nDefault is last 30 days represented by P30D.\nIf timeInterval is specified, then timeIntervalStart and timeIntervalEnd will be ignored.\nExamples P90D (last 90 days), P4W (last 4 weeks), P2M (last 2 months), P1Y (last 12 months), . Maximum value allowed is 25 months prior to current time (P25M).\n" }, { "name": "timeIntervalStart", "value": "", "type": "query", "description": "Analysis start time in UTC in ISO 8601 format(inclusive).\nExample 2019-10-30T00:00:00Z (yyyy-MM-ddThh:mm:ssZ).\nThe minimum allowed value is 2 years prior to the current day.\ntimeIntervalStart and timeIntervalEnd parameters are used together.\nIf analysisTimeInterval is specified, this parameter is ignored.\n" }, { "name": "timeIntervalEnd", "value": "", "type": "query", "description": "Analysis end time in UTC in ISO 8601 format(exclusive).\nExample 2019-10-30T00:00:00Z (yyyy-MM-ddThh:mm:ssZ).\ntimeIntervalStart and timeIntervalEnd are used together.\nIf timeIntervalEnd is not specified, current time is used as timeIntervalEnd.\n" }, { "name": "hostId", "value": "", "type": "query", "description": "Optional [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the host (Compute Id)\n" }, { "name": "statistic", "value": "", "type": "query", "description": "Choose the type of statistic metric data to be used for forecasting." } ] }, "docs": "Returns response with disk(s) statistics for a host.\n" }, { "info": { "name": "Gets a list of host insights configuration.", "type": "http" }, "http": { "method": "GET", "url": "http://127.0.0.1/20200630/hostInsights/hostConfigurations", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "compartmentId", "value": "", "type": "query", "description": "The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compartment." }, { "name": "enterpriseManagerBridgeId", "value": "", "type": "query", "description": "Unique Enterprise Manager bridge identifier" }, { "name": "id", "value": "", "type": "query", "description": "Optional list of host insight resource [OCIDs](/iaas/Content/General/Concepts/identifiers.htm).\n" }, { "name": "exadataInsightId", "value": "", "type": "query", "description": "Optional list of exadata insight resource [OCIDs](/iaas/Content/General/Concepts/identifiers.htm).\n" }, { "name": "platformType", "value": "", "type": "query", "description": "Filter by one or more platform types.\nSupported platformType(s) for MACS-managed external host insight: [LINUX, SOLARIS, WINDOWS].\nSupported platformType(s) for MACS-managed cloud host insight: [LINUX].\nSupported platformType(s) for EM-managed external host insight: [LINUX, SOLARIS, SUNOS, ZLINUX, WINDOWS, AIX, HP-UX].\n" }, { "name": "limit", "value": "", "type": "query", "description": "For list pagination. The maximum number of results per page, or items to\nreturn in a paginated \"List\" call.\nFor important details about how pagination works, see\n[List Pagination](/Content/API/Concepts/usingapi.htm#nine).\nExample: `50`\n" }, { "name": "page", "value": "", "type": "query", "description": "For list pagination. The value of the `opc-next-page` response header from\nthe previous \"List\" call. For important details about how pagination works,\nsee [List Pagination](/Content/API/Concepts/usingapi.htm#nine).\n" }, { "name": "sortOrder", "value": "", "type": "query", "description": "The sort order to use, either ascending (`ASC`) or descending (`DESC`).\n" }, { "name": "sortBy", "value": "", "type": "query", "description": "Host configuration list sort options.\n" }, { "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" }, { "name": "compartmentIdInSubtree", "value": "", "type": "query", "description": "A flag to search all resources within a given compartment and all sub-compartments.\n" }, { "name": "hostType", "value": "", "type": "query", "description": "Filter by one or more host types.\nPossible values are CLOUD-HOST, EXTERNAL-HOST, COMANAGED-VM-HOST, COMANAGED-BM-HOST, COMANAGED-EXACS-HOST, COMANAGED-EXACC-HOST\n" }, { "name": "hostId", "value": "", "type": "query", "description": "Optional [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the host (Compute Id)\n" }, { "name": "vmclusterName", "value": "", "type": "query", "description": "Optional list of Exadata Insight VM cluster name.\n" } ] }, "docs": "Gets a list of host insight configurations based on the query parameters specified. Either compartmentId or hostInsightId query parameter must be specified.\nWhen both compartmentId and compartmentIdInSubtree are specified, a list of host insight configurations in that compartment and in all sub-compartments will be returned.\n" }, { "info": { "name": "Gets recommendations for a host.", "type": "http" }, "http": { "method": "GET", "url": "http://127.0.0.1/20200630/hostInsights/hostRecommendation", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "compartmentId", "value": "", "type": "query", "description": "The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compartment." }, { "name": "id", "value": "", "type": "query", "description": "Required [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the host insight resource.\n" }, { "name": "resourceMetric", "value": "", "type": "query", "description": "Filter by host resource metric.\n" }, { "name": "analysisTimeInterval", "value": "", "type": "query", "description": "Specify time period in ISO 8601 format with respect to current time.\nDefault is last 30 days represented by P30D.\nIf timeInterval is specified, then timeIntervalStart and timeIntervalEnd will be ignored.\nExamples P90D (last 90 days), P4W (last 4 weeks), P2M (last 2 months), P1Y (last 12 months), . Maximum value allowed is 25 months prior to current time (P25M).\n" }, { "name": "timeIntervalStart", "value": "", "type": "query", "description": "Analysis start time in UTC in ISO 8601 format(inclusive).\nExample 2019-10-30T00:00:00Z (yyyy-MM-ddThh:mm:ssZ).\nThe minimum allowed value is 2 years prior to the current day.\ntimeIntervalStart and timeIntervalEnd parameters are used together.\nIf analysisTimeInterval is specified, this parameter is ignored.\n" }, { "name": "timeIntervalEnd", "value": "", "type": "query", "description": "Analysis end time in UTC in ISO 8601 format(exclusive).\nExample 2019-10-30T00:00:00Z (yyyy-MM-ddThh:mm:ssZ).\ntimeIntervalStart and timeIntervalEnd are used together.\nIf timeIntervalEnd is not specified, current time is used as timeIntervalEnd.\n" }, { "name": "hostId", "value": "", "type": "query", "description": "Optional [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the host (Compute Id)\n" }, { "name": "limit", "value": "", "type": "query", "description": "For list pagination. The maximum number of results per page, or items to\nreturn in a paginated \"List\" call.\nFor important details about how pagination works, see\n[List Pagination](/Content/API/Concepts/usingapi.htm#nine).\nExample: `50`\n" }, { "name": "statistic", "value": "", "type": "query", "description": "Choose the type of statistic metric data to be used for forecasting." } ] }, "docs": "Returns response with some recommendations if apply for a host.\n" }, { "info": { "name": "Gets a list of hosted entities details based on the query parameters specified.", "type": "http" }, "http": { "method": "GET", "url": "http://127.0.0.1/20200630/hostInsights/hostedEntities", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "compartmentId", "value": "", "type": "query", "description": "The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compartment." }, { "name": "analysisTimeInterval", "value": "", "type": "query", "description": "Specify time period in ISO 8601 format with respect to current time.\nDefault is last 30 days represented by P30D.\nIf timeInterval is specified, then timeIntervalStart and timeIntervalEnd will be ignored.\nExamples P90D (last 90 days), P4W (last 4 weeks), P2M (last 2 months), P1Y (last 12 months), . Maximum value allowed is 25 months prior to current time (P25M).\n" }, { "name": "timeIntervalStart", "value": "", "type": "query", "description": "Analysis start time in UTC in ISO 8601 format(inclusive).\nExample 2019-10-30T00:00:00Z (yyyy-MM-ddThh:mm:ssZ).\nThe minimum allowed value is 2 years prior to the current day.\ntimeIntervalStart and timeIntervalEnd parameters are used together.\nIf analysisTimeInterval is specified, this parameter is ignored.\n" }, { "name": "timeIntervalEnd", "value": "", "type": "query", "description": "Analysis end time in UTC in ISO 8601 format(exclusive).\nExample 2019-10-30T00:00:00Z (yyyy-MM-ddThh:mm:ssZ).\ntimeIntervalStart and timeIntervalEnd are used together.\nIf timeIntervalEnd is not specified, current time is used as timeIntervalEnd.\n" }, { "name": "platformType", "value": "", "type": "query", "description": "Filter by one or more platform types.\nSupported platformType(s) for MACS-managed external host insight: [LINUX, SOLARIS, WINDOWS].\nSupported platformType(s) for MACS-managed cloud host insight: [LINUX].\nSupported platformType(s) for EM-managed external host insight: [LINUX, SOLARIS, SUNOS, ZLINUX, WINDOWS, AIX, HP-UX].\n" }, { "name": "id", "value": "", "type": "query", "description": "Required [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the host insight resource.\n" }, { "name": "exadataInsightId", "value": "", "type": "query", "description": "[OCID](/iaas/Content/General/Concepts/identifiers.htm) of exadata insight resource.\n" }, { "name": "limit", "value": "", "type": "query", "description": "For list pagination. The maximum number of results per page, or items to\nreturn in a paginated \"List\" call.\nFor important details about how pagination works, see\n[List Pagination](/Content/API/Concepts/usingapi.htm#nine).\nExample: `50`\n" }, { "name": "page", "value": "", "type": "query", "description": "For list pagination. The value of the `opc-next-page` response header from\nthe previous \"List\" call. For important details about how pagination works,\nsee [List Pagination](/Content/API/Concepts/usingapi.htm#nine).\n" }, { "name": "sortOrder", "value": "", "type": "query", "description": "The sort order to use, either ascending (`ASC`) or descending (`DESC`).\n" }, { "name": "sortBy", "value": "", "type": "query", "description": "Hosted entity list sort options.\n" }, { "name": "hostType", "value": "", "type": "query", "description": "Filter by one or more host types.\nPossible values are CLOUD-HOST, EXTERNAL-HOST, COMANAGED-VM-HOST, COMANAGED-BM-HOST, COMANAGED-EXACS-HOST, COMANAGED-EXACC-HOST\n" }, { "name": "hostId", "value": "", "type": "query", "description": "Optional [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the host (Compute Id)\n" } ] }, "docs": "Get a list of hosted entities details.\n" }, { "info": { "name": "Gets IO usage metrics for a host.", "type": "http" }, "http": { "method": "GET", "url": "http://127.0.0.1/20200630/hostInsights/ioUsageTrend", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "compartmentId", "value": "", "type": "query", "description": "The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compartment." }, { "name": "id", "value": "", "type": "query", "description": "Required [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the host insight resource.\n" }, { "name": "analysisTimeInterval", "value": "", "type": "query", "description": "Specify time period in ISO 8601 format with respect to current time.\nDefault is last 30 days represented by P30D.\nIf timeInterval is specified, then timeIntervalStart and timeIntervalEnd will be ignored.\nExamples P90D (last 90 days), P4W (last 4 weeks), P2M (last 2 months), P1Y (last 12 months), . Maximum value allowed is 25 months prior to current time (P25M).\n" }, { "name": "timeIntervalStart", "value": "", "type": "query", "description": "Analysis start time in UTC in ISO 8601 format(inclusive).\nExample 2019-10-30T00:00:00Z (yyyy-MM-ddThh:mm:ssZ).\nThe minimum allowed value is 2 years prior to the current day.\ntimeIntervalStart and timeIntervalEnd parameters are used together.\nIf analysisTimeInterval is specified, this parameter is ignored.\n" }, { "name": "timeIntervalEnd", "value": "", "type": "query", "description": "Analysis end time in UTC in ISO 8601 format(exclusive).\nExample 2019-10-30T00:00:00Z (yyyy-MM-ddThh:mm:ssZ).\ntimeIntervalStart and timeIntervalEnd are used together.\nIf timeIntervalEnd is not specified, current time is used as timeIntervalEnd.\n" }, { "name": "hostId", "value": "", "type": "query", "description": "Optional [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the host (Compute Id)\n" }, { "name": "page", "value": "", "type": "query", "description": "For list pagination. The value of the `opc-next-page` response header from\nthe previous \"List\" call. For important details about how pagination works,\nsee [List Pagination](/Content/API/Concepts/usingapi.htm#nine).\n" }, { "name": "limit", "value": "", "type": "query", "description": "For list pagination. The maximum number of results per page, or items to\nreturn in a paginated \"List\" call.\nFor important details about how pagination works, see\n[List Pagination](/Content/API/Concepts/usingapi.htm#nine).\nExample: `50`\n" }, { "name": "statistic", "value": "", "type": "query", "description": "Choose the type of statistic metric data to be used for forecasting." } ] }, "docs": "Returns response with usage time series data with breakdown by IO interface for the time period specified.\n" }, { "info": { "name": "Gets capacity for a resource type.", "type": "http" }, "http": { "method": "GET", "url": "http://127.0.0.1/20200630/hostInsights/resourceCapacityTrend", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "compartmentId", "value": "", "type": "query", "description": "The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compartment." }, { "name": "resourceMetric", "value": "", "type": "query", "description": "Filter by host resource metric.\n" }, { "name": "analysisTimeInterval", "value": "", "type": "query", "description": "Specify time period in ISO 8601 format with respect to current time.\nDefault is last 30 days represented by P30D.\nIf timeInterval is specified, then timeIntervalStart and timeIntervalEnd will be ignored.\nExamples P90D (last 90 days), P4W (last 4 weeks), P2M (last 2 months), P1Y (last 12 months), . Maximum value allowed is 25 months prior to current time (P25M).\n" }, { "name": "timeIntervalStart", "value": "", "type": "query", "description": "Analysis start time in UTC in ISO 8601 format(inclusive).\nExample 2019-10-30T00:00:00Z (yyyy-MM-ddThh:mm:ssZ).\nThe minimum allowed value is 2 years prior to the current day.\ntimeIntervalStart and timeIntervalEnd parameters are used together.\nIf analysisTimeInterval is specified, this parameter is ignored.\n" }, { "name": "timeIntervalEnd", "value": "", "type": "query", "description": "Analysis end time in UTC in ISO 8601 format(exclusive).\nExample 2019-10-30T00:00:00Z (yyyy-MM-ddThh:mm:ssZ).\ntimeIntervalStart and timeIntervalEnd are used together.\nIf timeIntervalEnd is not specified, current time is used as timeIntervalEnd.\n" }, { "name": "platformType", "value": "", "type": "query", "description": "Filter by one or more platform types.\nSupported platformType(s) for MACS-managed external host insight: [LINUX, SOLARIS, WINDOWS].\nSupported platformType(s) for MACS-managed cloud host insight: [LINUX].\nSupported platformType(s) for EM-managed external host insight: [LINUX, SOLARIS, SUNOS, ZLINUX, WINDOWS, AIX, HP-UX].\n" }, { "name": "id", "value": "", "type": "query", "description": "Optional list of host insight resource [OCIDs](/iaas/Content/General/Concepts/identifiers.htm).\n" }, { "name": "exadataInsightId", "value": "", "type": "query", "description": "Optional list of exadata insight resource [OCIDs](/iaas/Content/General/Concepts/identifiers.htm).\n" }, { "name": "utilizationLevel", "value": "", "type": "query", "description": "Filter by utilization level by the following buckets:\n - HIGH_UTILIZATION: DBs with utilization greater or equal than 75.\n - LOW_UTILIZATION: DBs with utilization lower than 25.\n - MEDIUM_HIGH_UTILIZATION: DBs with utilization greater or equal than 50 but lower than 75.\n - MEDIUM_LOW_UTILIZATION: DBs with utilization greater or equal than 25 but lower than 50.\n" }, { "name": "page", "value": "", "type": "query", "description": "For list pagination. The value of the `opc-next-page` response header from\nthe previous \"List\" call. For important details about how pagination works,\nsee [List Pagination](/Content/API/Concepts/usingapi.htm#nine).\n" }, { "name": "sortOrder", "value": "", "type": "query", "description": "The sort order to use, either ascending (`ASC`) or descending (`DESC`).\n" }, { "name": "sortBy", "value": "", "type": "query", "description": "Sorts using end timestamp or capacity\n" }, { "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" }, { "name": "compartmentIdInSubtree", "value": "", "type": "query", "description": "A flag to search all resources within a given compartment and all sub-compartments.\n" }, { "name": "hostType", "value": "", "type": "query", "description": "Filter by one or more host types.\nPossible values are CLOUD-HOST, EXTERNAL-HOST, COMANAGED-VM-HOST, COMANAGED-BM-HOST, COMANAGED-EXACS-HOST, COMANAGED-EXACC-HOST\n" }, { "name": "hostId", "value": "", "type": "query", "description": "Optional [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the host (Compute Id)\n" }, { "name": "vmclusterName", "value": "", "type": "query", "description": "Optional list of Exadata Insight VM cluster name.\n" }, { "name": "highUtilizationThreshold", "value": "", "type": "query", "description": "Percent value in which a resource metric is considered highly utilized." }, { "name": "lowUtilizationThreshold", "value": "", "type": "query", "description": "Percent value in which a resource metric is considered low utilized." } ] }, "docs": "Returns response with time series data (endTimestamp, capacity) for the time period specified.\nThe maximum time range for analysis is 2 years, hence this is intentionally not paginated.\nIf compartmentIdInSubtree is specified, aggregates resources in a compartment and in all sub-compartments.\n" }, { "info": { "name": "Get Forecast predictions for host resources.", "type": "http" }, "http": { "method": "GET", "url": "http://127.0.0.1/20200630/hostInsights/resourceForecastTrend", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "compartmentId", "value": "", "type": "query", "description": "The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compartment." }, { "name": "resourceMetric", "value": "", "type": "query", "description": "Filter by host resource metric.\n" }, { "name": "analysisTimeInterval", "value": "", "type": "query", "description": "Specify time period in ISO 8601 format with respect to current time.\nDefault is last 30 days represented by P30D.\nIf timeInterval is specified, then timeIntervalStart and timeIntervalEnd will be ignored.\nExamples P90D (last 90 days), P4W (last 4 weeks), P2M (last 2 months), P1Y (last 12 months), . Maximum value allowed is 25 months prior to current time (P25M).\n" }, { "name": "timeIntervalStart", "value": "", "type": "query", "description": "Analysis start time in UTC in ISO 8601 format(inclusive).\nExample 2019-10-30T00:00:00Z (yyyy-MM-ddThh:mm:ssZ).\nThe minimum allowed value is 2 years prior to the current day.\ntimeIntervalStart and timeIntervalEnd parameters are used together.\nIf analysisTimeInterval is specified, this parameter is ignored.\n" }, { "name": "timeIntervalEnd", "value": "", "type": "query", "description": "Analysis end time in UTC in ISO 8601 format(exclusive).\nExample 2019-10-30T00:00:00Z (yyyy-MM-ddThh:mm:ssZ).\ntimeIntervalStart and timeIntervalEnd are used together.\nIf timeIntervalEnd is not specified, current time is used as timeIntervalEnd.\n" }, { "name": "platformType", "value": "", "type": "query", "description": "Filter by one or more platform types.\nSupported platformType(s) for MACS-managed external host insight: [LINUX, SOLARIS, WINDOWS].\nSupported platformType(s) for MACS-managed cloud host insight: [LINUX].\nSupported platformType(s) for EM-managed external host insight: [LINUX, SOLARIS, SUNOS, ZLINUX, WINDOWS, AIX, HP-UX].\n" }, { "name": "id", "value": "", "type": "query", "description": "Optional list of host insight resource [OCIDs](/iaas/Content/General/Concepts/identifiers.htm).\n" }, { "name": "exadataInsightId", "value": "", "type": "query", "description": "Optional list of exadata insight resource [OCIDs](/iaas/Content/General/Concepts/identifiers.htm).\n" }, { "name": "statistic", "value": "", "type": "query", "description": "Choose the type of statistic metric data to be used for forecasting." }, { "name": "forecastDays", "value": "", "type": "query", "description": "Number of days used for utilization forecast analysis.\n" }, { "name": "forecastModel", "value": "", "type": "query", "description": "Choose algorithm model for the forecasting.\nPossible values:\n - LINEAR: Uses linear regression algorithm for forecasting.\n - ML_AUTO: Automatically detects best algorithm to use for forecasting.\n - ML_NO_AUTO: Automatically detects seasonality of the data for forecasting using linear or seasonal algorithm.\n" }, { "name": "utilizationLevel", "value": "", "type": "query", "description": "Filter by utilization level by the following buckets:\n - HIGH_UTILIZATION: DBs with utilization greater or equal than 75.\n - LOW_UTILIZATION: DBs with utilization lower than 25.\n - MEDIUM_HIGH_UTILIZATION: DBs with utilization greater or equal than 50 but lower than 75.\n - MEDIUM_LOW_UTILIZATION: DBs with utilization greater or equal than 25 but lower than 50.\n" }, { "name": "confidence", "value": "", "type": "query", "description": "This parameter is used to change data's confidence level, this data is ingested by the\nforecast algorithm.\nConfidence is the probability of an interval to contain the expected population parameter.\nManipulation of this value will lead to different results.\nIf not set, default confidence value is 95%.\n" }, { "name": "page", "value": "", "type": "query", "description": "For list pagination. The value of the `opc-next-page` response header from\nthe previous \"List\" call. For important details about how pagination works,\nsee [List Pagination](/Content/API/Concepts/usingapi.htm#nine).\n" }, { "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" }, { "name": "compartmentIdInSubtree", "value": "", "type": "query", "description": "A flag to search all resources within a given compartment and all sub-compartments.\n" }, { "name": "hostType", "value": "", "type": "query", "description": "Filter by one or more host types.\nPossible values are CLOUD-HOST, EXTERNAL-HOST, COMANAGED-VM-HOST, COMANAGED-BM-HOST, COMANAGED-EXACS-HOST, COMANAGED-EXACC-HOST\n" }, { "name": "hostId", "value": "", "type": "query", "description": "Optional [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the host (Compute Id)\n" }, { "name": "vmclusterName", "value": "", "type": "query", "description": "Optional list of Exadata Insight VM cluster name.\n" }, { "name": "highUtilizationThreshold", "value": "", "type": "query", "description": "Percent value in which a resource metric is considered highly utilized." }, { "name": "lowUtilizationThreshold", "value": "", "type": "query", "description": "Percent value in which a resource metric is considered low utilized." }, { "name": "processHash", "value": "", "type": "query", "description": "Unique identifier for a process.\n" } ] }, "docs": "Get Forecast predictions for CPU or memory resources since a time in the past.\nIf compartmentIdInSubtree is specified, aggregates resources in a compartment and in all sub-compartments.\n" }, { "info": { "name": "Lists the resource statistics for each host.", "type": "http" }, "http": { "method": "GET", "url": "http://127.0.0.1/20200630/hostInsights/resourceStatistics", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "compartmentId", "value": "", "type": "query", "description": "The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compartment." }, { "name": "resourceMetric", "value": "", "type": "query", "description": "Filter by host resource metric.\n" }, { "name": "analysisTimeInterval", "value": "", "type": "query", "description": "Specify time period in ISO 8601 format with respect to current time.\nDefault is last 30 days represented by P30D.\nIf timeInterval is specified, then timeIntervalStart and timeIntervalEnd will be ignored.\nExamples P90D (last 90 days), P4W (last 4 weeks), P2M (last 2 months), P1Y (last 12 months), . Maximum value allowed is 25 months prior to current time (P25M).\n" }, { "name": "timeIntervalStart", "value": "", "type": "query", "description": "Analysis start time in UTC in ISO 8601 format(inclusive).\nExample 2019-10-30T00:00:00Z (yyyy-MM-ddThh:mm:ssZ).\nThe minimum allowed value is 2 years prior to the current day.\ntimeIntervalStart and timeIntervalEnd parameters are used together.\nIf analysisTimeInterval is specified, this parameter is ignored.\n" }, { "name": "timeIntervalEnd", "value": "", "type": "query", "description": "Analysis end time in UTC in ISO 8601 format(exclusive).\nExample 2019-10-30T00:00:00Z (yyyy-MM-ddThh:mm:ssZ).\ntimeIntervalStart and timeIntervalEnd are used together.\nIf timeIntervalEnd is not specified, current time is used as timeIntervalEnd.\n" }, { "name": "platformType", "value": "", "type": "query", "description": "Filter by one or more platform types.\nSupported platformType(s) for MACS-managed external host insight: [LINUX, SOLARIS, WINDOWS].\nSupported platformType(s) for MACS-managed cloud host insight: [LINUX].\nSupported platformType(s) for EM-managed external host insight: [LINUX, SOLARIS, SUNOS, ZLINUX, WINDOWS, AIX, HP-UX].\n" }, { "name": "id", "value": "", "type": "query", "description": "Optional list of host insight resource [OCIDs](/iaas/Content/General/Concepts/identifiers.htm).\n" }, { "name": "exadataInsightId", "value": "", "type": "query", "description": "Optional list of exadata insight resource [OCIDs](/iaas/Content/General/Concepts/identifiers.htm).\n" }, { "name": "percentile", "value": "", "type": "query", "description": "Percentile values of daily usage to be used for computing the aggregate resource usage.\n" }, { "name": "insightBy", "value": "", "type": "query", "description": "Return data of a specific insight\nPossible values are High Utilization, Low Utilization, Any ,High Utilization Forecast,\nLow Utilization Forecast\n" }, { "name": "forecastDays", "value": "", "type": "query", "description": "Number of days used for utilization forecast analysis.\n" }, { "name": "limit", "value": "", "type": "query", "description": "For list pagination. The maximum number of results per page, or items to\nreturn in a paginated \"List\" call.\nFor important details about how pagination works, see\n[List Pagination](/Content/API/Concepts/usingapi.htm#nine).\nExample: `50`\n" }, { "name": "page", "value": "", "type": "query", "description": "For list pagination. The value of the `opc-next-page` response header from\nthe previous \"List\" call. For important details about how pagination works,\nsee [List Pagination](/Content/API/Concepts/usingapi.htm#nine).\n" }, { "name": "sortOrder", "value": "", "type": "query", "description": "The sort order to use, either ascending (`ASC`) or descending (`DESC`).\n" }, { "name": "sortBy", "value": "", "type": "query", "description": "The order in which resource statistics records are listed.\n" }, { "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" }, { "name": "compartmentIdInSubtree", "value": "", "type": "query", "description": "A flag to search all resources within a given compartment and all sub-compartments.\n" }, { "name": "hostType", "value": "", "type": "query", "description": "Filter by one or more host types.\nPossible values are CLOUD-HOST, EXTERNAL-HOST, COMANAGED-VM-HOST, COMANAGED-BM-HOST, COMANAGED-EXACS-HOST, COMANAGED-EXACC-HOST\n" }, { "name": "hostId", "value": "", "type": "query", "description": "Optional [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the host (Compute Id)\n" }, { "name": "vmclusterName", "value": "", "type": "query", "description": "Optional list of Exadata Insight VM cluster name.\n" }, { "name": "highUtilizationThreshold", "value": "", "type": "query", "description": "Percent value in which a resource metric is considered highly utilized." }, { "name": "lowUtilizationThreshold", "value": "", "type": "query", "description": "Percent value in which a resource metric is considered low utilized." } ] }, "docs": "Lists the resource statistics (usage, capacity, usage change percent, utilization percent, load) for each host filtered\nby utilization level in a compartment and in all sub-compartments if specified.\n" }, { "info": { "name": "Get aggregated CPU, or memory usage, capacity and usage change percentage summed across hosts for the current time period.\n", "type": "http" }, "http": { "method": "GET", "url": "http://127.0.0.1/20200630/hostInsights/resourceUsageSummary", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "compartmentId", "value": "", "type": "query", "description": "The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compartment." }, { "name": "resourceMetric", "value": "", "type": "query", "description": "Filter by host resource metric.\n" }, { "name": "analysisTimeInterval", "value": "", "type": "query", "description": "Specify time period in ISO 8601 format with respect to current time.\nDefault is last 30 days represented by P30D.\nIf timeInterval is specified, then timeIntervalStart and timeIntervalEnd will be ignored.\nExamples P90D (last 90 days), P4W (last 4 weeks), P2M (last 2 months), P1Y (last 12 months), . Maximum value allowed is 25 months prior to current time (P25M).\n" }, { "name": "timeIntervalStart", "value": "", "type": "query", "description": "Analysis start time in UTC in ISO 8601 format(inclusive).\nExample 2019-10-30T00:00:00Z (yyyy-MM-ddThh:mm:ssZ).\nThe minimum allowed value is 2 years prior to the current day.\ntimeIntervalStart and timeIntervalEnd parameters are used together.\nIf analysisTimeInterval is specified, this parameter is ignored.\n" }, { "name": "timeIntervalEnd", "value": "", "type": "query", "description": "Analysis end time in UTC in ISO 8601 format(exclusive).\nExample 2019-10-30T00:00:00Z (yyyy-MM-ddThh:mm:ssZ).\ntimeIntervalStart and timeIntervalEnd are used together.\nIf timeIntervalEnd is not specified, current time is used as timeIntervalEnd.\n" }, { "name": "platformType", "value": "", "type": "query", "description": "Filter by one or more platform types.\nSupported platformType(s) for MACS-managed external host insight: [LINUX, SOLARIS, WINDOWS].\nSupported platformType(s) for MACS-managed cloud host insight: [LINUX].\nSupported platformType(s) for EM-managed external host insight: [LINUX, SOLARIS, SUNOS, ZLINUX, WINDOWS, AIX, HP-UX].\n" }, { "name": "id", "value": "", "type": "query", "description": "Optional list of host insight resource [OCIDs](/iaas/Content/General/Concepts/identifiers.htm).\n" }, { "name": "exadataInsightId", "value": "", "type": "query", "description": "Optional list of exadata insight resource [OCIDs](/iaas/Content/General/Concepts/identifiers.htm).\n" }, { "name": "page", "value": "", "type": "query", "description": "For list pagination. The value of the `opc-next-page` response header from\nthe previous \"List\" call. For important details about how pagination works,\nsee [List Pagination](/Content/API/Concepts/usingapi.htm#nine).\n" }, { "name": "percentile", "value": "", "type": "query", "description": "Percentile values of daily usage to be used for computing the aggregate resource usage.\n" }, { "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" }, { "name": "compartmentIdInSubtree", "value": "", "type": "query", "description": "A flag to search all resources within a given compartment and all sub-compartments.\n" }, { "name": "hostType", "value": "", "type": "query", "description": "Filter by one or more host types.\nPossible values are CLOUD-HOST, EXTERNAL-HOST, COMANAGED-VM-HOST, COMANAGED-BM-HOST, COMANAGED-EXACS-HOST, COMANAGED-EXACC-HOST\n" }, { "name": "hostId", "value": "", "type": "query", "description": "Optional [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the host (Compute Id)\n" }, { "name": "vmclusterName", "value": "", "type": "query", "description": "Optional list of Exadata Insight VM cluster name.\n" } ] }, "docs": "A cumulative distribution function is used to rank the usage data points per host within the specified time period.\nFor each host, the minimum data point with a ranking > the percentile value is included in the summation.\nLinear regression functions are used to calculate the usage change percentage.\nIf compartmentIdInSubtree is specified, aggregates resources in a compartment and in all sub-compartments.\n" }, { "info": { "name": "Gets aggregate usage and capacity for a resource type.", "type": "http" }, "http": { "method": "GET", "url": "http://127.0.0.1/20200630/hostInsights/resourceUsageTrend", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "compartmentId", "value": "", "type": "query", "description": "The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compartment." }, { "name": "resourceMetric", "value": "", "type": "query", "description": "Filter by host resource metric.\n" }, { "name": "analysisTimeInterval", "value": "", "type": "query", "description": "Specify time period in ISO 8601 format with respect to current time.\nDefault is last 30 days represented by P30D.\nIf timeInterval is specified, then timeIntervalStart and timeIntervalEnd will be ignored.\nExamples P90D (last 90 days), P4W (last 4 weeks), P2M (last 2 months), P1Y (last 12 months), . Maximum value allowed is 25 months prior to current time (P25M).\n" }, { "name": "timeIntervalStart", "value": "", "type": "query", "description": "Analysis start time in UTC in ISO 8601 format(inclusive).\nExample 2019-10-30T00:00:00Z (yyyy-MM-ddThh:mm:ssZ).\nThe minimum allowed value is 2 years prior to the current day.\ntimeIntervalStart and timeIntervalEnd parameters are used together.\nIf analysisTimeInterval is specified, this parameter is ignored.\n" }, { "name": "timeIntervalEnd", "value": "", "type": "query", "description": "Analysis end time in UTC in ISO 8601 format(exclusive).\nExample 2019-10-30T00:00:00Z (yyyy-MM-ddThh:mm:ssZ).\ntimeIntervalStart and timeIntervalEnd are used together.\nIf timeIntervalEnd is not specified, current time is used as timeIntervalEnd.\n" }, { "name": "platformType", "value": "", "type": "query", "description": "Filter by one or more platform types.\nSupported platformType(s) for MACS-managed external host insight: [LINUX, SOLARIS, WINDOWS].\nSupported platformType(s) for MACS-managed cloud host insight: [LINUX].\nSupported platformType(s) for EM-managed external host insight: [LINUX, SOLARIS, SUNOS, ZLINUX, WINDOWS, AIX, HP-UX].\n" }, { "name": "id", "value": "", "type": "query", "description": "Optional list of host insight resource [OCIDs](/iaas/Content/General/Concepts/identifiers.htm).\n" }, { "name": "exadataInsightId", "value": "", "type": "query", "description": "Optional list of exadata insight resource [OCIDs](/iaas/Content/General/Concepts/identifiers.htm).\n" }, { "name": "page", "value": "", "type": "query", "description": "For list pagination. The value of the `opc-next-page` response header from\nthe previous \"List\" call. For important details about how pagination works,\nsee [List Pagination](/Content/API/Concepts/usingapi.htm#nine).\n" }, { "name": "sortOrder", "value": "", "type": "query", "description": "The sort order to use, either ascending (`ASC`) or descending (`DESC`).\n" }, { "name": "sortBy", "value": "", "type": "query", "description": "Sorts using end timestamp, usage or capacity\n" }, { "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" }, { "name": "compartmentIdInSubtree", "value": "", "type": "query", "description": "A flag to search all resources within a given compartment and all sub-compartments.\n" }, { "name": "hostType", "value": "", "type": "query", "description": "Filter by one or more host types.\nPossible values are CLOUD-HOST, EXTERNAL-HOST, COMANAGED-VM-HOST, COMANAGED-BM-HOST, COMANAGED-EXACS-HOST, COMANAGED-EXACC-HOST\n" }, { "name": "hostId", "value": "", "type": "query", "description": "Optional [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the host (Compute Id)\n" }, { "name": "vmclusterName", "value": "", "type": "query", "description": "Optional list of Exadata Insight VM cluster name.\n" } ] }, "docs": "Returns response with time series data (endTimestamp, usage, capacity) for the time period specified.\nThe maximum time range for analysis is 2 years, hence this is intentionally not paginated.\nIf compartmentIdInSubtree is specified, aggregates resources in a compartment and in all sub-compartments.\n" }, { "info": { "name": "Gets current and projected utilization insights.", "type": "http" }, "http": { "method": "GET", "url": "http://127.0.0.1/20200630/hostInsights/resourceUtilizationInsight", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "compartmentId", "value": "", "type": "query", "description": "The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compartment." }, { "name": "resourceMetric", "value": "", "type": "query", "description": "Filter by host resource metric.\n" }, { "name": "analysisTimeInterval", "value": "", "type": "query", "description": "Specify time period in ISO 8601 format with respect to current time.\nDefault is last 30 days represented by P30D.\nIf timeInterval is specified, then timeIntervalStart and timeIntervalEnd will be ignored.\nExamples P90D (last 90 days), P4W (last 4 weeks), P2M (last 2 months), P1Y (last 12 months), . Maximum value allowed is 25 months prior to current time (P25M).\n" }, { "name": "timeIntervalStart", "value": "", "type": "query", "description": "Analysis start time in UTC in ISO 8601 format(inclusive).\nExample 2019-10-30T00:00:00Z (yyyy-MM-ddThh:mm:ssZ).\nThe minimum allowed value is 2 years prior to the current day.\ntimeIntervalStart and timeIntervalEnd parameters are used together.\nIf analysisTimeInterval is specified, this parameter is ignored.\n" }, { "name": "timeIntervalEnd", "value": "", "type": "query", "description": "Analysis end time in UTC in ISO 8601 format(exclusive).\nExample 2019-10-30T00:00:00Z (yyyy-MM-ddThh:mm:ssZ).\ntimeIntervalStart and timeIntervalEnd are used together.\nIf timeIntervalEnd is not specified, current time is used as timeIntervalEnd.\n" }, { "name": "platformType", "value": "", "type": "query", "description": "Filter by one or more platform types.\nSupported platformType(s) for MACS-managed external host insight: [LINUX, SOLARIS, WINDOWS].\nSupported platformType(s) for MACS-managed cloud host insight: [LINUX].\nSupported platformType(s) for EM-managed external host insight: [LINUX, SOLARIS, SUNOS, ZLINUX, WINDOWS, AIX, HP-UX].\n" }, { "name": "id", "value": "", "type": "query", "description": "Optional list of host insight resource [OCIDs](/iaas/Content/General/Concepts/identifiers.htm).\n" }, { "name": "exadataInsightId", "value": "", "type": "query", "description": "Optional list of exadata insight resource [OCIDs](/iaas/Content/General/Concepts/identifiers.htm).\n" }, { "name": "forecastDays", "value": "", "type": "query", "description": "Number of days used for utilization forecast analysis.\n" }, { "name": "page", "value": "", "type": "query", "description": "For list pagination. The value of the `opc-next-page` response header from\nthe previous \"List\" call. For important details about how pagination works,\nsee [List Pagination](/Content/API/Concepts/usingapi.htm#nine).\n" }, { "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" }, { "name": "compartmentIdInSubtree", "value": "", "type": "query", "description": "A flag to search all resources within a given compartment and all sub-compartments.\n" }, { "name": "hostType", "value": "", "type": "query", "description": "Filter by one or more host types.\nPossible values are CLOUD-HOST, EXTERNAL-HOST, COMANAGED-VM-HOST, COMANAGED-BM-HOST, COMANAGED-EXACS-HOST, COMANAGED-EXACC-HOST\n" }, { "name": "hostId", "value": "", "type": "query", "description": "Optional [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the host (Compute Id)\n" }, { "name": "vmclusterName", "value": "", "type": "query", "description": "Optional list of Exadata Insight VM cluster name.\n" }, { "name": "highUtilizationThreshold", "value": "", "type": "query", "description": "Percent value in which a resource metric is considered highly utilized." }, { "name": "lowUtilizationThreshold", "value": "", "type": "query", "description": "Percent value in which a resource metric is considered low utilized." } ] }, "docs": "Gets resources with current utilization (high and low) and projected utilization (high and low) for a resource type over specified time period.\nIf compartmentIdInSubtree is specified, aggregates resources in a compartment and in all sub-compartments.\n" }, { "info": { "name": "Gets top processes usage metrics for a host on a specific date.", "type": "http" }, "http": { "method": "GET", "url": "http://127.0.0.1/20200630/hostInsights/topProcessesUsage", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "compartmentId", "value": "", "type": "query", "description": "The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compartment." }, { "name": "id", "value": "", "type": "query", "description": "Required [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the host insight resource.\n" }, { "name": "resourceMetric", "value": "", "type": "query", "description": "Host top processes resource metric sort options.\nSupported values are CPU, MEMORY, VIIRTUAL_MEMORY.\n" }, { "name": "timeIntervalStart", "value": "", "type": "query", "description": "Analysis start time in UTC in ISO 8601 format(inclusive).\nExample 2019-10-30T00:00:00Z (yyyy-MM-ddThh:mm:ssZ).\nThe minimum allowed value is 2 years prior to the current day.\ntimeIntervalStart and timeIntervalEnd parameters are used together.\nIf analysisTimeInterval is specified, this parameter is ignored.\n" }, { "name": "timeIntervalEnd", "value": "", "type": "query", "description": "Analysis end time in UTC in ISO 8601 format(exclusive).\nExample 2019-10-30T00:00:00Z (yyyy-MM-ddThh:mm:ssZ).\ntimeIntervalStart and timeIntervalEnd are used together.\nIf timeIntervalEnd is not specified, current time is used as timeIntervalEnd.\n" }, { "name": "page", "value": "", "type": "query", "description": "For list pagination. The value of the `opc-next-page` response header from\nthe previous \"List\" call. For important details about how pagination works,\nsee [List Pagination](/Content/API/Concepts/usingapi.htm#nine).\n" }, { "name": "limit", "value": "", "type": "query", "description": "For list pagination. The maximum number of results per page, or items to\nreturn in a paginated \"List\" call.\nFor important details about how pagination works, see\n[List Pagination](/Content/API/Concepts/usingapi.htm#nine).\nExample: `50`\n" }, { "name": "analysisTimeInterval", "value": "", "type": "query", "description": "Specify time period in ISO 8601 format with respect to current time.\nDefault is last 30 days represented by P30D.\nIf timeInterval is specified, then timeIntervalStart and timeIntervalEnd will be ignored.\nExamples P90D (last 90 days), P4W (last 4 weeks), P2M (last 2 months), P1Y (last 12 months), . Maximum value allowed is 25 months prior to current time (P25M).\n" }, { "name": "hostType", "value": "", "type": "query", "description": "Filter by one or more host types.\nPossible values are CLOUD-HOST, EXTERNAL-HOST, COMANAGED-VM-HOST, COMANAGED-BM-HOST, COMANAGED-EXACS-HOST, COMANAGED-EXACC-HOST\n" }, { "name": "hostId", "value": "", "type": "query", "description": "Optional [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the host (Compute Id)\n" }, { "name": "timestamp", "value": "", "type": "query", "description": "Timestamp at which to gather the top processes. \nThis will be top processes over the hour or over the day pending the time range passed into the query.\n" } ] }, "docs": "Returns response with aggregated data (timestamp, usageData) for top processes on a specific date.\nData is aggregated for the time specified and processes are sorted descendent by the process metric specified (CPU, MEMORY, VIRTUAL_MEMORY).\nhostInsightId, processMetric must be specified.\n" }, { "info": { "name": "Gets top processes usage metrics for a host.", "type": "http" }, "http": { "method": "GET", "url": "http://127.0.0.1/20200630/hostInsights/topProcessesUsageTrend", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "compartmentId", "value": "", "type": "query", "description": "The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compartment." }, { "name": "id", "value": "", "type": "query", "description": "Required [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the host insight resource.\n" }, { "name": "resourceMetric", "value": "", "type": "query", "description": "Host top processes resource metric sort options.\nSupported values are CPU, MEMORY, VIIRTUAL_MEMORY.\n" }, { "name": "analysisTimeInterval", "value": "", "type": "query", "description": "Specify time period in ISO 8601 format with respect to current time.\nDefault is last 30 days represented by P30D.\nIf timeInterval is specified, then timeIntervalStart and timeIntervalEnd will be ignored.\nExamples P90D (last 90 days), P4W (last 4 weeks), P2M (last 2 months), P1Y (last 12 months), . Maximum value allowed is 25 months prior to current time (P25M).\n" }, { "name": "timeIntervalStart", "value": "", "type": "query", "description": "Analysis start time in UTC in ISO 8601 format(inclusive).\nExample 2019-10-30T00:00:00Z (yyyy-MM-ddThh:mm:ssZ).\nThe minimum allowed value is 2 years prior to the current day.\ntimeIntervalStart and timeIntervalEnd parameters are used together.\nIf analysisTimeInterval is specified, this parameter is ignored.\n" }, { "name": "timeIntervalEnd", "value": "", "type": "query", "description": "Analysis end time in UTC in ISO 8601 format(exclusive).\nExample 2019-10-30T00:00:00Z (yyyy-MM-ddThh:mm:ssZ).\ntimeIntervalStart and timeIntervalEnd are used together.\nIf timeIntervalEnd is not specified, current time is used as timeIntervalEnd.\n" }, { "name": "page", "value": "", "type": "query", "description": "For list pagination. The value of the `opc-next-page` response header from\nthe previous \"List\" call. For important details about how pagination works,\nsee [List Pagination](/Content/API/Concepts/usingapi.htm#nine).\n" }, { "name": "limit", "value": "", "type": "query", "description": "For list pagination. The maximum number of results per page, or items to\nreturn in a paginated \"List\" call.\nFor important details about how pagination works, see\n[List Pagination](/Content/API/Concepts/usingapi.htm#nine).\nExample: `50`\n" }, { "name": "hostType", "value": "", "type": "query", "description": "Filter by one or more host types.\nPossible values are CLOUD-HOST, EXTERNAL-HOST, COMANAGED-VM-HOST, COMANAGED-BM-HOST, COMANAGED-EXACS-HOST, COMANAGED-EXACC-HOST\n" }, { "name": "hostId", "value": "", "type": "query", "description": "Optional [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the host (Compute Id)\n" }, { "name": "processHash", "value": "", "type": "query", "description": "Unique identifier for a process.\n" } ] }, "docs": "Returns response with aggregated time series data (timeIntervalstart, timeIntervalEnd, commandArgs, usageData) for top processes.\nData is aggregated for the time period specified and proceses are sorted descendent by the proces metric specified (CPU, MEMORY, VIRTUAL_MEMORY).\nHostInsight Id and Process metric must be specified\n" }, { "info": { "name": "Gets details of a host insight.", "type": "http" }, "http": { "method": "GET", "url": "http://127.0.0.1/20200630/hostInsights/:hostInsightId", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "hostInsightId", "value": "", "type": "path", "description": "Unique host insight identifier" } ] }, "docs": "Gets details of a host insight." }, { "info": { "name": "Updates configuration of a host insight.", "type": "http" }, "http": { "method": "PUT", "url": "http://127.0.0.1/20200630/hostInsights/:hostInsightId", "headers": [ { "name": "if-match", "value": "" }, { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "hostInsightId", "value": "", "type": "path", "description": "Unique host insight identifier" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Updates configuration of a host insight." }, { "info": { "name": "Deletes a host insight.", "type": "http" }, "http": { "method": "DELETE", "url": "http://127.0.0.1/20200630/hostInsights/:hostInsightId", "headers": [ { "name": "if-match", "value": "" }, { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "hostInsightId", "value": "", "type": "path", "description": "Unique host insight identifier" } ] }, "docs": "Deletes a host insight. The host insight will be deleted and cannot be enabled again." }, { "info": { "name": "Moves a resource into a different compartment.", "type": "http" }, "http": { "method": "POST", "url": "http://127.0.0.1/20200630/hostInsights/:hostInsightId/actions/changeCompartment", "headers": [ { "name": "if-match", "value": "" }, { "name": "opc-request-id", "value": "" }, { "name": "opc-retry-token", "value": "" } ], "params": [ { "name": "hostInsightId", "value": "", "type": "path", "description": "Unique host insight identifier" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Moves a HostInsight resource from one compartment identifier to another. When provided, If-Match is checked against ETag values of the resource." }, { "info": { "name": "Disables a host in Ops Insights.", "type": "http" }, "http": { "method": "POST", "url": "http://127.0.0.1/20200630/hostInsights/:hostInsightId/actions/disable", "headers": [ { "name": "if-match", "value": "" }, { "name": "opc-request-id", "value": "" }, { "name": "opc-retry-token", "value": "" } ], "params": [ { "name": "hostInsightId", "value": "", "type": "path", "description": "Unique host insight identifier" } ] }, "docs": "Disables a host in Ops Insights. Host metric collection and analysis will be stopped." }, { "info": { "name": "Enables a host in Ops Insights.", "type": "http" }, "http": { "method": "POST", "url": "http://127.0.0.1/20200630/hostInsights/:hostInsightId/actions/enable", "headers": [ { "name": "if-match", "value": "" }, { "name": "opc-request-id", "value": "" }, { "name": "opc-retry-token", "value": "" } ], "params": [ { "name": "hostInsightId", "value": "", "type": "path", "description": "Unique host insight identifier" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Enables a host in Ops Insights. Host metric collection and analysis will be started." }, { "info": { "name": "Gets a list of agent entities available to add a new hostInsight", "type": "http" }, "http": { "method": "GET", "url": "http://127.0.0.1/20200630/importableAgentEntities", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "compartmentId", "value": "", "type": "query", "description": "The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compartment." }, { "name": "limit", "value": "", "type": "query", "description": "For list pagination. The maximum number of results per page, or items to\nreturn in a paginated \"List\" call.\nFor important details about how pagination works, see\n[List Pagination](/Content/API/Concepts/usingapi.htm#nine).\nExample: `50`\n" }, { "name": "page", "value": "", "type": "query", "description": "For list pagination. The value of the `opc-next-page` response header from\nthe previous \"List\" call. For important details about how pagination works,\nsee [List Pagination](/Content/API/Concepts/usingapi.htm#nine).\n" }, { "name": "sortOrder", "value": "", "type": "query", "description": "The sort order to use, either ascending (`ASC`) or descending (`DESC`).\n" }, { "name": "sortBy", "value": "", "type": "query", "description": "Hosted entity list sort options.\n" } ] }, "docs": "Gets a list of agent entities available to add a new hostInsight. An agent entity is \"available\"\nand will be shown if all the following conditions are true:\n 1. The agent OCID is not already being used for an existing hostInsight.\n 2. The agent availabilityStatus = 'ACTIVE'\n 3. The agent lifecycleState = 'ACTIVE'\n" }, { "info": { "name": "Gets a list of compute instances running OCA available to add a new hostInsight", "type": "http" }, "http": { "method": "GET", "url": "http://127.0.0.1/20200630/importableComputeEntities", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "compartmentId", "value": "", "type": "query", "description": "The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compartment." }, { "name": "limit", "value": "", "type": "query", "description": "For list pagination. The maximum number of results per page, or items to\nreturn in a paginated \"List\" call.\nFor important details about how pagination works, see\n[List Pagination](/Content/API/Concepts/usingapi.htm#nine).\nExample: `50`\n" }, { "name": "page", "value": "", "type": "query", "description": "For list pagination. The value of the `opc-next-page` response header from\nthe previous \"List\" call. For important details about how pagination works,\nsee [List Pagination](/Content/API/Concepts/usingapi.htm#nine).\n" }, { "name": "sortOrder", "value": "", "type": "query", "description": "The sort order to use, either ascending (`ASC`) or descending (`DESC`).\n" }, { "name": "sortBy", "value": "", "type": "query", "description": "Compute entity list sort options.\n" } ] }, "docs": "Gets a list of available compute intances running cloud agent to add a new hostInsight. An Compute entity is \"available\"\nand will be shown if all the following conditions are true:\n 1. Compute is running OCA\n 2. OCI Management Agent is not enabled or If OCI Management Agent is enabled\n 2.1 The agent OCID is not already being used for an existing hostInsight.\n 2.2 The agent availabilityStatus = 'ACTIVE'\n 2.3 The agent lifecycleState = 'ACTIVE'\n" }, { "info": { "name": "Gets a list of Kubernetes cluster insights.", "type": "http" }, "http": { "method": "GET", "url": "http://127.0.0.1/20200630/kubeClusterInsights", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "compartmentId", "value": "", "type": "query", "description": "The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compartment." }, { "name": "id", "value": "", "type": "query", "description": "Optional list of Kubernetes cluster insight resource [OCIDs](/iaas/Content/General/Concepts/identifiers.htm).\n" }, { "name": "status", "value": "", "type": "query", "description": "Resource Status" }, { "name": "lifecycleState", "value": "", "type": "query", "description": "Lifecycle states" }, { "name": "limit", "value": "", "type": "query", "description": "For list pagination. The maximum number of results per page, or items to\nreturn in a paginated \"List\" call.\nFor important details about how pagination works, see\n[List Pagination](/Content/API/Concepts/usingapi.htm#nine).\nExample: `50`\n" }, { "name": "page", "value": "", "type": "query", "description": "For list pagination. The value of the `opc-next-page` response header from\nthe previous \"List\" call. For important details about how pagination works,\nsee [List Pagination](/Content/API/Concepts/usingapi.htm#nine).\n" }, { "name": "sortOrder", "value": "", "type": "query", "description": "The sort order to use, either ascending (`ASC`) or descending (`DESC`).\n" }, { "name": "sortBy", "value": "", "type": "query", "description": "Kubernetes cluster insight list sort options. If `fields` parameter is selected, the `sortBy` parameter must be one of the fields specified. Default order for timeCreated is descending. Default order for exadataName is ascending. If no value is specified timeCreated is default.\n" }, { "name": "compartmentIdInSubtree", "value": "", "type": "query", "description": "A flag to search all resources within a given compartment and all sub-compartments.\n" } ] }, "docs": "Gets a list of Kubernetes cluster insights based on the query parameters specified. Either compartmentId or id query parameter must be specified.\nWhen both compartmentId and compartmentIdInSubtree are specified, a list of Kubernetes cluster insights in that compartment and in all sub-compartments will be returned.\n" }, { "info": { "name": "Create an Kubernetes cluster insight resource for a Kubernetes Cluster in Ops Insights.", "type": "http" }, "http": { "method": "POST", "url": "http://127.0.0.1/20200630/kubeClusterInsights", "headers": [ { "name": "opc-retry-token", "value": "" }, { "name": "opc-request-id", "value": "" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Create a Kubernetes cluster insight resource for a Kubernetes Cluster in Ops Insights. The Kubernetes cluster will be enabled in Ops Insights. Kubernetes cluster-related metric collection and analysis will be started.\n" }, { "info": { "name": "Gets details of a Kubernetes cluster insight.", "type": "http" }, "http": { "method": "GET", "url": "http://127.0.0.1/20200630/kubeClusterInsights/:kubeClusterInsightId", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "kubeClusterInsightId", "value": "", "type": "path", "description": "Unique Kubernetes cluster insight identifier" } ] }, "docs": "Gets details of a Kubernetes cluster insight." }, { "info": { "name": "Updates configuration of a Kubernetes cluster insight.", "type": "http" }, "http": { "method": "PUT", "url": "http://127.0.0.1/20200630/kubeClusterInsights/:kubeClusterInsightId", "headers": [ { "name": "if-match", "value": "" }, { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "kubeClusterInsightId", "value": "", "type": "path", "description": "Unique Kubernetes cluster insight identifier" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Updates configuration of a Kubernetes cluster insight." }, { "info": { "name": "Deletes a Kubernetes cluster insight.", "type": "http" }, "http": { "method": "DELETE", "url": "http://127.0.0.1/20200630/kubeClusterInsights/:kubeClusterInsightId", "headers": [ { "name": "if-match", "value": "" }, { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "kubeClusterInsightId", "value": "", "type": "path", "description": "Unique Kubernetes cluster insight identifier" } ] }, "docs": "Deletes a Kubernetes cluster insight. The Kubernetes cluster insight will be deleted and cannot be enabled again." }, { "info": { "name": "Moves a resource into a different compartment.", "type": "http" }, "http": { "method": "POST", "url": "http://127.0.0.1/20200630/kubeClusterInsights/:kubeClusterInsightId/actions/changeCompartment", "headers": [ { "name": "if-match", "value": "" }, { "name": "opc-request-id", "value": "" }, { "name": "opc-retry-token", "value": "" } ], "params": [ { "name": "kubeClusterInsightId", "value": "", "type": "path", "description": "Unique Kubernetes cluster insight identifier" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Moves a Kubernetes cluster insight resource from one compartment identifier to another. When provided, If-Match is checked against ETag values of the resource." }, { "info": { "name": "Disables a Kubernetes cluster in Ops Insights.", "type": "http" }, "http": { "method": "POST", "url": "http://127.0.0.1/20200630/kubeClusterInsights/:kubeClusterInsightId/actions/disable", "headers": [ { "name": "if-match", "value": "" }, { "name": "opc-request-id", "value": "" }, { "name": "opc-retry-token", "value": "" } ], "params": [ { "name": "kubeClusterInsightId", "value": "", "type": "path", "description": "Unique Kubernetes cluster insight identifier" } ] }, "docs": "Disables a Kubernetes cluster in Ops Insights. Kubernetes cluster-related metric collection and analysis will be stopped." }, { "info": { "name": "Enables a Kubernetes cluster in Ops Insights.", "type": "http" }, "http": { "method": "POST", "url": "http://127.0.0.1/20200630/kubeClusterInsights/:kubeClusterInsightId/actions/enable", "headers": [ { "name": "if-match", "value": "" }, { "name": "opc-request-id", "value": "" }, { "name": "opc-retry-token", "value": "" } ], "params": [ { "name": "kubeClusterInsightId", "value": "", "type": "path", "description": "Unique Kubernetes cluster insight identifier" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Enables a Kubernetes cluster in Ops Insights. Kubernetes cluster-related metric collection and analysis will be started." }, { "info": { "name": "Gets a list of news reports.", "type": "http" }, "http": { "method": "GET", "url": "http://127.0.0.1/20200630/newsReports", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "compartmentId", "value": "", "type": "query", "description": "The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compartment." }, { "name": "newsReportId", "value": "", "type": "query", "description": "Unique Ops Insights news report identifier" }, { "name": "status", "value": "", "type": "query", "description": "Resource Status" }, { "name": "lifecycleState", "value": "", "type": "query", "description": "Lifecycle states" }, { "name": "limit", "value": "", "type": "query", "description": "For list pagination. The maximum number of results per page, or items to\nreturn in a paginated \"List\" call.\nFor important details about how pagination works, see\n[List Pagination](/Content/API/Concepts/usingapi.htm#nine).\nExample: `50`\n" }, { "name": "page", "value": "", "type": "query", "description": "For list pagination. The value of the `opc-next-page` response header from\nthe previous \"List\" call. For important details about how pagination works,\nsee [List Pagination](/Content/API/Concepts/usingapi.htm#nine).\n" }, { "name": "sortOrder", "value": "", "type": "query", "description": "The sort order to use, either ascending (`ASC`) or descending (`DESC`).\n" }, { "name": "sortBy", "value": "", "type": "query", "description": "News report list sort options. If `fields` parameter is selected, the `sortBy` parameter must be one of the fields specified.\n" }, { "name": "compartmentIdInSubtree", "value": "", "type": "query", "description": "A flag to search all resources within a given compartment and all sub-compartments.\n" } ] }, "docs": "Gets a list of news reports based on the query parameters specified. Either compartmentId or id query parameter must be specified.\n" }, { "info": { "name": "Create a news report in Ops Insights.", "type": "http" }, "http": { "method": "POST", "url": "http://127.0.0.1/20200630/newsReports", "headers": [ { "name": "opc-retry-token", "value": "" }, { "name": "opc-request-id", "value": "" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Create a news report in Ops Insights. The report will be enabled in Ops Insights. Insights will be emailed as per selected frequency.\n" }, { "info": { "name": "Gets details of a news report.", "type": "http" }, "http": { "method": "GET", "url": "http://127.0.0.1/20200630/newsReports/:newsReportId", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "newsReportId", "value": "", "type": "path", "description": "Unique news report identifier." } ] }, "docs": "Gets details of a news report." }, { "info": { "name": "Updates the configuration of a news report.", "type": "http" }, "http": { "method": "PUT", "url": "http://127.0.0.1/20200630/newsReports/:newsReportId", "headers": [ { "name": "if-match", "value": "" }, { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "newsReportId", "value": "", "type": "path", "description": "Unique news report identifier." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Updates the configuration of a news report." }, { "info": { "name": "Deletes a news report.", "type": "http" }, "http": { "method": "DELETE", "url": "http://127.0.0.1/20200630/newsReports/:newsReportId", "headers": [ { "name": "if-match", "value": "" }, { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "newsReportId", "value": "", "type": "path", "description": "Unique news report identifier." } ] }, "docs": "Deletes a news report. The news report will be deleted and cannot be enabled again." }, { "info": { "name": "Moves a resource into a different compartment.", "type": "http" }, "http": { "method": "POST", "url": "http://127.0.0.1/20200630/newsReports/:newsReportId/actions/changeCompartment", "headers": [ { "name": "if-match", "value": "" }, { "name": "opc-request-id", "value": "" }, { "name": "opc-retry-token", "value": "" } ], "params": [ { "name": "newsReportId", "value": "", "type": "path", "description": "Unique news report identifier." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Moves a news report resource from one compartment identifier to another. When provided, If-Match is checked against ETag values of the resource." }, { "info": { "name": "Gets a list of Operation Insights private endpoints.", "type": "http" }, "http": { "method": "GET", "url": "http://127.0.0.1/20200630/operationsInsightsPrivateEndpoints", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "compartmentId", "value": "", "type": "query", "description": "The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compartment." }, { "name": "displayName", "value": "", "type": "query", "description": "A filter to return only resources that match the entire display name." }, { "name": "opsiPrivateEndpointId", "value": "", "type": "query", "description": "Unique Operations Insights PrivateEndpoint identifier" }, { "name": "isUsedForRacDbs", "value": "", "type": "query", "description": "The option to filter OPSI private endpoints that can used for RAC. Should be used along with vcnId query parameter." }, { "name": "vcnId", "value": "", "type": "query", "description": "The [OCID](/Content/General/Concepts/identifiers.htm) of the VCN." }, { "name": "lifecycleState", "value": "", "type": "query", "description": "Lifecycle states" }, { "name": "limit", "value": "", "type": "query", "description": "For list pagination. The maximum number of results per page, or items to\nreturn in a paginated \"List\" call.\nFor important details about how pagination works, see\n[List Pagination](/Content/API/Concepts/usingapi.htm#nine).\nExample: `50`\n" }, { "name": "page", "value": "", "type": "query", "description": "For list pagination. The value of the `opc-next-page` response header from\nthe previous \"List\" call. For important details about how pagination works,\nsee [List Pagination](/Content/API/Concepts/usingapi.htm#nine).\n" }, { "name": "sortOrder", "value": "", "type": "query", "description": "The sort order to use, either ascending (`ASC`) or descending (`DESC`).\n" }, { "name": "sortBy", "value": "", "type": "query", "description": "The field to sort private endpoints.\n" }, { "name": "compartmentIdInSubtree", "value": "", "type": "query", "description": "A flag to search all resources within a given compartment and all sub-compartments.\n" } ] }, "docs": "Gets a list of Operation Insights private endpoints." }, { "info": { "name": "Create an Operation Insights private endpoint resource", "type": "http" }, "http": { "method": "POST", "url": "http://127.0.0.1/20200630/operationsInsightsPrivateEndpoints", "headers": [ { "name": "opc-retry-token", "value": "" }, { "name": "opc-request-id", "value": "" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Create a private endpoint resource for the tenant in Ops Insights.\nThis resource will be created in customer compartment.\n" }, { "info": { "name": "Gets the details of the specified private endpoint.", "type": "http" }, "http": { "method": "GET", "url": "http://127.0.0.1/20200630/operationsInsightsPrivateEndpoints/:operationsInsightsPrivateEndpointId", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "operationsInsightsPrivateEndpointId", "value": "", "type": "path", "description": "The [OCID](/Content/General/Concepts/identifiers.htm) of the Operation Insights private endpoint." } ] }, "docs": "Gets the details of the specified private endpoint." }, { "info": { "name": "Updates one or more attributes of the specified private endpoint.", "type": "http" }, "http": { "method": "PUT", "url": "http://127.0.0.1/20200630/operationsInsightsPrivateEndpoints/:operationsInsightsPrivateEndpointId", "headers": [ { "name": "if-match", "value": "" }, { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "operationsInsightsPrivateEndpointId", "value": "", "type": "path", "description": "The [OCID](/Content/General/Concepts/identifiers.htm) of the Operation Insights private endpoint." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Updates one or more attributes of the specified private endpoint." }, { "info": { "name": "Deletes a private endpoint.", "type": "http" }, "http": { "method": "DELETE", "url": "http://127.0.0.1/20200630/operationsInsightsPrivateEndpoints/:operationsInsightsPrivateEndpointId", "headers": [ { "name": "if-match", "value": "" }, { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "operationsInsightsPrivateEndpointId", "value": "", "type": "path", "description": "The [OCID](/Content/General/Concepts/identifiers.htm) of the Operation Insights private endpoint." } ] }, "docs": "Deletes a private endpoint." }, { "info": { "name": "Moves a private endpoint into a different compartment.", "type": "http" }, "http": { "method": "POST", "url": "http://127.0.0.1/20200630/operationsInsightsPrivateEndpoints/:operationsInsightsPrivateEndpointId/actions/changeCompartment", "headers": [ { "name": "if-match", "value": "" }, { "name": "opc-request-id", "value": "" }, { "name": "opc-retry-token", "value": "" } ], "params": [ { "name": "operationsInsightsPrivateEndpointId", "value": "", "type": "path", "description": "The [OCID](/Content/General/Concepts/identifiers.htm) of the Operation Insights private endpoint." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Moves a private endpoint from one compartment to another. When provided, If-Match is checked against ETag values of the resource." }, { "info": { "name": "Gets a list of Operations Insights Warehouse Users.", "type": "http" }, "http": { "method": "GET", "url": "http://127.0.0.1/20200630/operationsInsightsWarehouseUsers", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "compartmentId", "value": "", "type": "query", "description": "The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compartment." }, { "name": "displayName", "value": "", "type": "query", "description": "A filter to return only resources that match the entire display name." }, { "name": "id", "value": "", "type": "query", "description": "Unique Operations Insights Warehouse User identifier" }, { "name": "operationsInsightsWarehouseId", "value": "", "type": "query", "description": "Unique Operations Insights Warehouse identifier" }, { "name": "lifecycleState", "value": "", "type": "query", "description": "Lifecycle states" }, { "name": "limit", "value": "", "type": "query", "description": "For list pagination. The maximum number of results per page, or items to\nreturn in a paginated \"List\" call.\nFor important details about how pagination works, see\n[List Pagination](/Content/API/Concepts/usingapi.htm#nine).\nExample: `50`\n" }, { "name": "page", "value": "", "type": "query", "description": "For list pagination. The value of the `opc-next-page` response header from\nthe previous \"List\" call. For important details about how pagination works,\nsee [List Pagination](/Content/API/Concepts/usingapi.htm#nine).\n" }, { "name": "sortOrder", "value": "", "type": "query", "description": "The sort order to use, either ascending (`ASC`) or descending (`DESC`).\n" }, { "name": "sortBy", "value": "", "type": "query", "description": "The field to sort by. Only one sort order may be provided. Default order for timeCreated is descending. Default order for displayName is ascending. If no value is specified timeCreated is default.\n" } ] }, "docs": "Gets a list of Operations Insights Warehouse users. Either compartmentId or id must be specified. All these resources are expected to be in root compartment.\n" }, { "info": { "name": "This is the endpoint for creating an Operations Insights Warehouse user", "type": "http" }, "http": { "method": "POST", "url": "http://127.0.0.1/20200630/operationsInsightsWarehouseUsers", "headers": [ { "name": "opc-retry-token", "value": "" }, { "name": "opc-request-id", "value": "" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Create a Operations Insights Warehouse user resource for the tenant in Operations Insights.\nThis resource will be created in root compartment.\n" }, { "info": { "name": "Gets details of an Operations Insights Warehouse User.", "type": "http" }, "http": { "method": "GET", "url": "http://127.0.0.1/20200630/operationsInsightsWarehouseUsers/:operationsInsightsWarehouseUserId", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "operationsInsightsWarehouseUserId", "value": "", "type": "path", "description": "Unique Operations Insights Warehouse User identifier" } ] }, "docs": "Gets details of an Operations Insights Warehouse User." }, { "info": { "name": "Updates the configuration of an Operations Insights Warehouse User.", "type": "http" }, "http": { "method": "PUT", "url": "http://127.0.0.1/20200630/operationsInsightsWarehouseUsers/:operationsInsightsWarehouseUserId", "headers": [ { "name": "if-match", "value": "" }, { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "operationsInsightsWarehouseUserId", "value": "", "type": "path", "description": "Unique Operations Insights Warehouse User identifier" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Updates the configuration of an Operations Insights Warehouse User." }, { "info": { "name": "Deletes an Operations Insights Warehouse User.", "type": "http" }, "http": { "method": "DELETE", "url": "http://127.0.0.1/20200630/operationsInsightsWarehouseUsers/:operationsInsightsWarehouseUserId", "headers": [ { "name": "if-match", "value": "" }, { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "operationsInsightsWarehouseUserId", "value": "", "type": "path", "description": "Unique Operations Insights Warehouse User identifier" } ] }, "docs": "Deletes an Operations Insights Warehouse User." }, { "info": { "name": "Gets a list of Ops Insights warehouses.", "type": "http" }, "http": { "method": "GET", "url": "http://127.0.0.1/20200630/operationsInsightsWarehouses", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "compartmentId", "value": "", "type": "query", "description": "The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compartment." }, { "name": "displayName", "value": "", "type": "query", "description": "A filter to return only resources that match the entire display name." }, { "name": "id", "value": "", "type": "query", "description": "Unique Ops Insights Warehouse identifier" }, { "name": "lifecycleState", "value": "", "type": "query", "description": "Lifecycle states" }, { "name": "limit", "value": "", "type": "query", "description": "For list pagination. The maximum number of results per page, or items to\nreturn in a paginated \"List\" call.\nFor important details about how pagination works, see\n[List Pagination](/Content/API/Concepts/usingapi.htm#nine).\nExample: `50`\n" }, { "name": "page", "value": "", "type": "query", "description": "For list pagination. The value of the `opc-next-page` response header from\nthe previous \"List\" call. For important details about how pagination works,\nsee [List Pagination](/Content/API/Concepts/usingapi.htm#nine).\n" }, { "name": "sortOrder", "value": "", "type": "query", "description": "The sort order to use, either ascending (`ASC`) or descending (`DESC`).\n" }, { "name": "sortBy", "value": "", "type": "query", "description": "The field to sort by. Only one sort order may be provided. Default order for timeCreated is descending. Default order for displayName is ascending. If no value is specified timeCreated is default.\n" } ] }, "docs": "Gets a list of Ops Insights warehouses. Either compartmentId or id must be specified.\nThere is only expected to be 1 warehouse per tenant. The warehouse is expected to be in the root compartment.\n" }, { "info": { "name": "Create an Ops Insights Warehouse", "type": "http" }, "http": { "method": "POST", "url": "http://127.0.0.1/20200630/operationsInsightsWarehouses", "headers": [ { "name": "opc-retry-token", "value": "" }, { "name": "opc-request-id", "value": "" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Create a Ops Insights Warehouse resource for the tenant in Ops Insights. New ADW will be provisioned for this tenant.\nThere is only expected to be 1 warehouse per tenant. The warehouse is expected to be in the root compartment. If the 'opsi-warehouse-type'\nheader is passed to the API, a warehouse resource without ADW or Schema provisioning is created.\n" }, { "info": { "name": "Gets details of an Ops Insights Warehouse.", "type": "http" }, "http": { "method": "GET", "url": "http://127.0.0.1/20200630/operationsInsightsWarehouses/:operationsInsightsWarehouseId", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "operationsInsightsWarehouseId", "value": "", "type": "path", "description": "Unique Ops Insights Warehouse identifier" } ] }, "docs": "Gets details of an Ops Insights Warehouse.\nThere is only expected to be 1 warehouse per tenant. The warehouse is expected to be in the root compartment.\n" }, { "info": { "name": "Updates the configuration of an Ops Insights Warehouse.", "type": "http" }, "http": { "method": "PUT", "url": "http://127.0.0.1/20200630/operationsInsightsWarehouses/:operationsInsightsWarehouseId", "headers": [ { "name": "if-match", "value": "" }, { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "operationsInsightsWarehouseId", "value": "", "type": "path", "description": "Unique Ops Insights Warehouse identifier" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Updates the configuration of an Ops Insights Warehouse.\nThere is only expected to be 1 warehouse per tenant. The warehouse is expected to be in the root compartment.\n" }, { "info": { "name": "Deletes an Operations Insights Warehouse.", "type": "http" }, "http": { "method": "DELETE", "url": "http://127.0.0.1/20200630/operationsInsightsWarehouses/:operationsInsightsWarehouseId", "headers": [ { "name": "if-match", "value": "" }, { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "operationsInsightsWarehouseId", "value": "", "type": "path", "description": "Unique Ops Insights Warehouse identifier" } ] }, "docs": "Deletes an Operations Insights Warehouse. There is only expected to be 1 warehouse per tenant.\nThe warehouse is expected to be in the root compartment.\nUser must delete AWR Hub resource for this warehouse before calling this operation.\nUser must delete the warehouse users before calling this operation.\n" }, { "info": { "name": "Moves a resource into a different compartment.", "type": "http" }, "http": { "method": "POST", "url": "http://127.0.0.1/20200630/operationsInsightsWarehouses/:operationsInsightsWarehouseId/actions/changeCompartment", "headers": [ { "name": "if-match", "value": "" }, { "name": "opc-request-id", "value": "" }, { "name": "opc-retry-token", "value": "" } ], "params": [ { "name": "operationsInsightsWarehouseId", "value": "", "type": "path", "description": "Unique Ops Insights Warehouse identifier" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Moves a Operations Insights Warehouse resource from one compartment to another. When provided, If-Match is checked against ETag values of the resource." }, { "info": { "name": "Download the ADW wallet for Operations Insights Warehouse using which the Hub data is exposed.", "type": "http" }, "http": { "method": "POST", "url": "http://127.0.0.1/20200630/operationsInsightsWarehouses/:operationsInsightsWarehouseId/actions/downloadWarehouseWallet", "headers": [ { "name": "opc-request-id", "value": "" }, { "name": "opc-retry-token", "value": "" } ], "params": [ { "name": "operationsInsightsWarehouseId", "value": "", "type": "path", "description": "Unique Ops Insights Warehouse identifier" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Download the ADW wallet for Operations Insights Warehouse using which the Hub data is exposed." }, { "info": { "name": "Rotate the ADW wallet for Operations Insights Warehouse using which the Hub data is exposed.", "type": "http" }, "http": { "method": "POST", "url": "http://127.0.0.1/20200630/operationsInsightsWarehouses/:operationsInsightsWarehouseId/actions/rotateWarehouseWallet", "headers": [ { "name": "opc-request-id", "value": "" }, { "name": "if-match", "value": "" } ], "params": [ { "name": "operationsInsightsWarehouseId", "value": "", "type": "path", "description": "Unique Ops Insights Warehouse identifier" } ] }, "docs": "Rotate the ADW wallet for Operations Insights Warehouse using which the Hub data is exposed." }, { "info": { "name": "Gets the details of resources used by an Operations Insights Warehouse.", "type": "http" }, "http": { "method": "GET", "url": "http://127.0.0.1/20200630/operationsInsightsWarehouses/:operationsInsightsWarehouseId/resourceUsageSummary", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "operationsInsightsWarehouseId", "value": "", "type": "path", "description": "Unique Ops Insights Warehouse identifier" } ] }, "docs": "Gets the details of resources used by an Operations Insights Warehouse.\nThere is only expected to be 1 warehouse per tenant. The warehouse is expected to be in the root compartment.\n" }, { "info": { "name": "Gets a list of OPSI configuration resources.", "type": "http" }, "http": { "method": "GET", "url": "http://127.0.0.1/20200630/opsiConfigurations", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "compartmentId", "value": "", "type": "query", "description": "The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compartment." }, { "name": "displayName", "value": "", "type": "query", "description": "Filter to return based on resources that match the entire display name." }, { "name": "lifecycleState", "value": "", "type": "query", "description": "Filter to return based on Lifecycle state of OPSI configuration." }, { "name": "opsiConfigType", "value": "", "type": "query", "description": "Filter to return based on configuration type of OPSI configuration." }, { "name": "limit", "value": "", "type": "query", "description": "For list pagination. The maximum number of results per page, or items to\nreturn in a paginated \"List\" call.\nFor important details about how pagination works, see\n[List Pagination](/Content/API/Concepts/usingapi.htm#nine).\nExample: `50`\n" }, { "name": "page", "value": "", "type": "query", "description": "For list pagination. The value of the `opc-next-page` response header from\nthe previous \"List\" call. For important details about how pagination works,\nsee [List Pagination](/Content/API/Concepts/usingapi.htm#nine).\n" }, { "name": "sortOrder", "value": "", "type": "query", "description": "The sort order to use, either ascending (`ASC`) or descending (`DESC`).\n" }, { "name": "sortBy", "value": "", "type": "query", "description": "OPSI configurations list sort options.\n" } ] }, "docs": "Gets a list of OPSI configuration resources based on the query parameters specified.\n" }, { "info": { "name": "Create an OPSI configuration resource.", "type": "http" }, "http": { "method": "POST", "url": "http://127.0.0.1/20200630/opsiConfigurations", "headers": [ { "name": "opc-retry-token", "value": "" }, { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "opsiConfigField", "value": "", "type": "query", "description": "Optional fields to return as part of OpsiConfiguration object. Unless requested, these fields will not be returned by default.\n" }, { "name": "configItemCustomStatus", "value": "", "type": "query", "description": "Specifies whether only customized configuration items or only non-customized configuration items or both have to be returned.\nBy default only customized configuration items are returned.\n" }, { "name": "configItemsApplicableContext", "value": "", "type": "query", "description": "Returns the configuration items filtered by applicable contexts sent in this param. By default configuration items of all applicable contexts are returned.\n" }, { "name": "configItemField", "value": "", "type": "query", "description": "Specifies the fields to return in a config item summary." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Create an OPSI configuration resource.\n" }, { "info": { "name": "Gets the applicable configuration items.", "type": "http" }, "http": { "method": "GET", "url": "http://127.0.0.1/20200630/opsiConfigurations/configurationItems", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "compartmentId", "value": "", "type": "query", "description": "The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compartment." }, { "name": "opsiConfigType", "value": "", "type": "query", "description": "Filter to return configuration items based on configuration type of OPSI configuration." }, { "name": "limit", "value": "", "type": "query", "description": "For list pagination. The maximum number of results per page, or items to\nreturn in a paginated \"List\" call.\nFor important details about how pagination works, see\n[List Pagination](/Content/API/Concepts/usingapi.htm#nine).\nExample: `50`\n" }, { "name": "page", "value": "", "type": "query", "description": "For list pagination. The value of the `opc-next-page` response header from\nthe previous \"List\" call. For important details about how pagination works,\nsee [List Pagination](/Content/API/Concepts/usingapi.htm#nine).\n" }, { "name": "configItemsApplicableContext", "value": "", "type": "query", "description": "Returns the configuration items filtered by applicable contexts sent in this param. By default configuration items of all applicable contexts are returned.\n" }, { "name": "configItemField", "value": "", "type": "query", "description": "Specifies the fields to return in a config item summary.\n" }, { "name": "name", "value": "", "type": "query", "description": "A filter to return only configuration items that match the entire name." } ] }, "docs": "Gets the applicable configuration items based on the query parameters specified. Configuration items for an opsiConfigType with respect to a compartmentId can be fetched.\nValues specified in configItemField param will determine what fields for each configuration items have to be returned.\n" }, { "info": { "name": "Gets details of an OPSI configuration resource.", "type": "http" }, "http": { "method": "GET", "url": "http://127.0.0.1/20200630/opsiConfigurations/:opsiConfigurationId", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "opsiConfigurationId", "value": "", "type": "path", "description": "[OCID](/iaas/Content/General/Concepts/identifiers.htm) of OPSI configuration resource.\n" }, { "name": "opsiConfigField", "value": "", "type": "query", "description": "Optional fields to return as part of OpsiConfiguration object. Unless requested, these fields will not be returned by default.\n" }, { "name": "configItemCustomStatus", "value": "", "type": "query", "description": "Specifies whether only customized configuration items or only non-customized configuration items or both have to be returned.\nBy default only customized configuration items are returned.\n" }, { "name": "configItemsApplicableContext", "value": "", "type": "query", "description": "Returns the configuration items filtered by applicable contexts sent in this param. By default configuration items of all applicable contexts are returned.\n" }, { "name": "configItemField", "value": "", "type": "query", "description": "Specifies the fields to return in a config item summary." } ] }, "docs": "Gets details of an OPSI configuration resource.\nValues specified in configItemField and configItemCustomStatus query params will be considered, only if configItems field is requested as part of opsiConfigField query param.\nValues specified in configItemCustomStatus will determine whether only customized configuration items or only non-customized configuration items or both have to be returned.\n" }, { "info": { "name": "Updates an OPSI configuration resource with the given ID.", "type": "http" }, "http": { "method": "PUT", "url": "http://127.0.0.1/20200630/opsiConfigurations/:opsiConfigurationId", "headers": [ { "name": "if-match", "value": "" }, { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "opsiConfigurationId", "value": "", "type": "path", "description": "[OCID](/iaas/Content/General/Concepts/identifiers.htm) of OPSI configuration resource.\n" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Updates an OPSI configuration resource with the given ID." }, { "info": { "name": "Deletes an OPSI configuration resource.", "type": "http" }, "http": { "method": "DELETE", "url": "http://127.0.0.1/20200630/opsiConfigurations/:opsiConfigurationId", "headers": [ { "name": "if-match", "value": "" }, { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "opsiConfigurationId", "value": "", "type": "path", "description": "[OCID](/iaas/Content/General/Concepts/identifiers.htm) of OPSI configuration resource.\n" } ] }, "docs": "Deletes an OPSI configuration resource." }, { "info": { "name": "Moves a resource into a different compartment.", "type": "http" }, "http": { "method": "POST", "url": "http://127.0.0.1/20200630/opsiConfigurations/:opsiConfigurationId/actions/changeCompartment", "headers": [ { "name": "if-match", "value": "" }, { "name": "opc-request-id", "value": "" }, { "name": "opc-retry-token", "value": "" } ], "params": [ { "name": "opsiConfigurationId", "value": "", "type": "path", "description": "[OCID](/iaas/Content/General/Concepts/identifiers.htm) of OPSI configuration resource.\n" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Moves an OpsiConfiguration resource from one compartment to another." }, { "info": { "name": "Gets a list of OPSI data objects.", "type": "http" }, "http": { "method": "GET", "url": "http://127.0.0.1/20200630/opsiDataObjects", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "compartmentId", "value": "", "type": "query", "description": "The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compartment." }, { "name": "dataObjectType", "value": "", "type": "query", "description": "OPSI data object types." }, { "name": "displayName", "value": "", "type": "query", "description": "A filter to return only resources that match the entire display name." }, { "name": "limit", "value": "", "type": "query", "description": "For list pagination. The maximum number of results per page, or items to\nreturn in a paginated \"List\" call.\nFor important details about how pagination works, see\n[List Pagination](/Content/API/Concepts/usingapi.htm#nine).\nExample: `50`\n" }, { "name": "page", "value": "", "type": "query", "description": "For list pagination. The value of the `opc-next-page` response header from\nthe previous \"List\" call. For important details about how pagination works,\nsee [List Pagination](/Content/API/Concepts/usingapi.htm#nine).\n" }, { "name": "sortOrder", "value": "", "type": "query", "description": "The sort order to use, either ascending (`ASC`) or descending (`DESC`).\n" }, { "name": "sortBy", "value": "", "type": "query", "description": "OPSI data object list sort options.\n" }, { "name": "groupName", "value": "", "type": "query", "description": "A filter to return only data objects that belongs to the group of the given group name. By default, no filtering will be applied on group name." }, { "name": "name", "value": "", "type": "query", "description": "A filter to return only data objects that match the entire data object name. By default, no filtering will be applied on data object name." } ] }, "docs": "Gets a list of OPSI data objects based on the query parameters specified. CompartmentId id query parameter must be specified.\n" }, { "info": { "name": "Queries data from an OPSI data object.", "type": "http" }, "http": { "method": "POST", "url": "http://127.0.0.1/20200630/opsiDataObjects/actions/queryData", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "compartmentId", "value": "", "type": "query", "description": "The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compartment." }, { "name": "limit", "value": "", "type": "query", "description": "For list pagination. The maximum number of results per page, or items to\nreturn in a paginated \"List\" call.\nFor important details about how pagination works, see\n[List Pagination](/Content/API/Concepts/usingapi.htm#nine).\nExample: `50`\n" }, { "name": "page", "value": "", "type": "query", "description": "For list pagination. The value of the `opc-next-page` response header from\nthe previous \"List\" call. For important details about how pagination works,\nsee [List Pagination](/Content/API/Concepts/usingapi.htm#nine).\n" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Queries an OPSI data object with the inputs provided and sends the result set back. Either analysisTimeInterval\nor timeIntervalStart and timeIntervalEnd parameters need to be passed as well.\n" }, { "info": { "name": "Gets details of an OPSI data object.", "type": "http" }, "http": { "method": "GET", "url": "http://127.0.0.1/20200630/opsiDataObjects/:opsiDataObjectIdentifier", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "compartmentId", "value": "", "type": "query", "description": "The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compartment." }, { "name": "opsiDataObjectIdentifier", "value": "", "type": "path", "description": "Unique OPSI data object identifier." } ] }, "docs": "Gets details of an OPSI data object." }, { "info": { "name": "List work requests", "type": "http" }, "http": { "method": "GET", "url": "http://127.0.0.1/20200630/workRequests", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "page", "value": "", "type": "query", "description": "For list pagination. The value of the `opc-next-page` response header from\nthe previous \"List\" call. For important details about how pagination works,\nsee [List Pagination](/Content/API/Concepts/usingapi.htm#nine).\n" }, { "name": "limit", "value": "", "type": "query", "description": "For list pagination. The maximum number of results per page, or items to\nreturn in a paginated \"List\" call.\nFor important details about how pagination works, see\n[List Pagination](/Content/API/Concepts/usingapi.htm#nine).\nExample: `50`\n" }, { "name": "compartmentId", "value": "", "type": "query", "description": "The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compartment." }, { "name": "id", "value": "", "type": "query", "description": "The ID of the asynchronous work request." }, { "name": "status", "value": "", "type": "query", "description": "A filter to return only resources their lifecycleState matches the given OperationStatus." }, { "name": "resourceId", "value": "", "type": "query", "description": "The ID of the resource affected by the work request." }, { "name": "relatedResourceId", "value": "", "type": "query", "description": "The ID of the related resource for the resource affected by the work request, e.g. the related Exadata Insight OCID of the Database Insight work request" }, { "name": "sortOrder", "value": "", "type": "query", "description": "The sort order to use, either ascending (`ASC`) or descending (`DESC`).\n" }, { "name": "sortBy", "value": "", "type": "query", "description": "The field to sort by. Only one sort order may be provided. Default order for timeAccepted is descending.\n" } ] }, "docs": "Lists the work requests in a compartment. Either compartmentId or id must be specified. Only one of id, resourceId or relatedResourceId can be specified optionally.\n" }, { "info": { "name": "Gets work request status", "type": "http" }, "http": { "method": "GET", "url": "http://127.0.0.1/20200630/workRequests/:workRequestId", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "workRequestId", "value": "", "type": "path", "description": "The ID of the asynchronous request." } ] }, "docs": "Gets the status of the work request with the given ID." }, { "info": { "name": "Lists work request errors", "type": "http" }, "http": { "method": "GET", "url": "http://127.0.0.1/20200630/workRequests/:workRequestId/errors", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "workRequestId", "value": "", "type": "path", "description": "The ID of the asynchronous request." }, { "name": "page", "value": "", "type": "query", "description": "For list pagination. The value of the `opc-next-page` response header from\nthe previous \"List\" call. For important details about how pagination works,\nsee [List Pagination](/Content/API/Concepts/usingapi.htm#nine).\n" }, { "name": "limit", "value": "", "type": "query", "description": "For list pagination. The maximum number of results per page, or items to\nreturn in a paginated \"List\" call.\nFor important details about how pagination works, see\n[List Pagination](/Content/API/Concepts/usingapi.htm#nine).\nExample: `50`\n" }, { "name": "sortBy", "value": "", "type": "query", "description": "The field to sort by. Only one sort order may be provided. Default order for timeAccepted is descending.\n" }, { "name": "sortOrder", "value": "", "type": "query", "description": "The sort order to use, either ascending (`ASC`) or descending (`DESC`).\n" } ] }, "docs": "Return a (paginated) list of errors for a given work request.\n" }, { "info": { "name": "Lists work request logs", "type": "http" }, "http": { "method": "GET", "url": "http://127.0.0.1/20200630/workRequests/:workRequestId/logs", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "workRequestId", "value": "", "type": "path", "description": "The ID of the asynchronous request." }, { "name": "page", "value": "", "type": "query", "description": "For list pagination. The value of the `opc-next-page` response header from\nthe previous \"List\" call. For important details about how pagination works,\nsee [List Pagination](/Content/API/Concepts/usingapi.htm#nine).\n" }, { "name": "limit", "value": "", "type": "query", "description": "For list pagination. The maximum number of results per page, or items to\nreturn in a paginated \"List\" call.\nFor important details about how pagination works, see\n[List Pagination](/Content/API/Concepts/usingapi.htm#nine).\nExample: `50`\n" }, { "name": "sortBy", "value": "", "type": "query", "description": "The field to sort by. Only one sort order may be provided. Default order for timeAccepted is descending.\n" }, { "name": "sortOrder", "value": "", "type": "query", "description": "The sort order to use, either ascending (`ASC`) or descending (`DESC`).\n" } ] }, "docs": "Return a (paginated) list of logs for a given work request.\n" }, { "info": { "name": "Queries data from Warehouse data objects (e.g: views, tables).\n", "type": "http" }, "http": { "method": "POST", "url": "http://127.0.0.1/20200630/:warehouseType/:warehouseId/actions/queryData", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "warehouseType", "value": "", "type": "path", "description": "Type of the Warehouse." }, { "name": "warehouseId", "value": "", "type": "path", "description": "The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of a Warehouse.\n" }, { "name": "limit", "value": "", "type": "query", "description": "For list pagination. The maximum number of results per page, or items to\nreturn in a paginated \"List\" call.\nFor important details about how pagination works, see\n[List Pagination](/Content/API/Concepts/usingapi.htm#nine).\nExample: `50`\n" }, { "name": "page", "value": "", "type": "query", "description": "For list pagination. The value of the `opc-next-page` response header from\nthe previous \"List\" call. For important details about how pagination works,\nsee [List Pagination](/Content/API/Concepts/usingapi.htm#nine).\n" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Queries Warehouse data objects (e.g: views, tables) with the inputs provided and sends the result set back.\nAny data to which an OperationsInsightsWarehouseUser with a permission to the corresponding Warehouse can be queried.\n" }, { "info": { "name": "Gets a list of Warehouse data objects (e.g: views, tables).\n", "type": "http" }, "http": { "method": "GET", "url": "http://127.0.0.1/20200630/:warehouseType/:warehouseId/dataObjects", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "warehouseType", "value": "", "type": "path", "description": "Type of the Warehouse." }, { "name": "warehouseId", "value": "", "type": "path", "description": "The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of a Warehouse.\n" }, { "name": "dataObjectType", "value": "", "type": "query", "description": "A filter to return only data objects that match the data object type. By default, no filtering will be applied on data object type." }, { "name": "name", "value": "", "type": "query", "description": "A filter to return only data objects that match the entire data object name. By default, no filtering will be applied on data object name." }, { "name": "owner", "value": "", "type": "query", "description": "A filter to return only data objects that match the entire data object owner name. By default, no filtering will be applied on data object owner name." }, { "name": "limit", "value": "", "type": "query", "description": "For list pagination. The maximum number of results per page, or items to\nreturn in a paginated \"List\" call.\nFor important details about how pagination works, see\n[List Pagination](/Content/API/Concepts/usingapi.htm#nine).\nExample: `50`\n" }, { "name": "page", "value": "", "type": "query", "description": "For list pagination. The value of the `opc-next-page` response header from\nthe previous \"List\" call. For important details about how pagination works,\nsee [List Pagination](/Content/API/Concepts/usingapi.htm#nine).\n" }, { "name": "sortOrder", "value": "", "type": "query", "description": "The sort order to use, either ascending (`ASC`) or descending (`DESC`).\n" }, { "name": "sortBy", "value": "", "type": "query", "description": "Sort options for Warehouse data objects list." }, { "name": "summaryField", "value": "", "type": "query", "description": "Specifies the optional fields to return in a WarehouseDataObjectSummary. Unless requested, these fields are not returned by default.\n" } ] }, "docs": "Gets a list of Warehouse data objects (e.g: views, tables), based on the query parameters specified.\n" } ] } ], "bundled": true }