{ "swagger":"2.0", "info":{ "description":"The Oracle Monitoring Cloud Service API enables you to monitor cloud services and set alert thresholds for specific metrics. For example, you can use this REST API to build your own dashboard to monitor the state of specific metrics, such as CPU and memory usage, for instances of your Oracle Cloud services. ", "version":"2019.01.11", "title":"REST API for Oracle Monitoring Cloud Service", "x-summary":"The Oracle Monitoring Cloud Service API enables you to monitor cloud services and set alert thresholds for specific metrics." }, "basePath":"/monitoring", "tags":[ { "name":"Alerts", "description":"" }, { "name":"Metrics", "description":"" }, { "name":"Reports", "description":"" } ], "schemes":[ "https" ], "paths":{ "/monitoring/{idDomainName}/.customer/api/v1/metricReports":{ "get":{ "tags":[ "Reports" ], "summary":"Generate a Metrics Report", "description":"Generates a metrics report based on specific query criteria.", "operationId":"createMetricReport", "produces":[ "application/json" ], "parameters":[ { "name":"Authorization", "in":"header", "required":true, "type":"string", "description":"Basic Authentication credentials. The user must be located in the identity domain name specified by the header X-ID-TENANT-NAME." }, { "name":"X-ID-TENANT-NAME", "in":"header", "required":true, "type":"string", "description":"Set to the identity domain ID where the user specified in the Authorization header resides." }, { "name":"idDomainName", "in":"path", "description":"Identity domain ID for the Oracle Monitoring Cloud Service account.", "required":true, "type":"string" }, { "name":"sinceDuration", "in":"query", "description":"Specify how far from the current time should the start of the time range be set. Note: You must use the iCalendar Duration format. For example, PT10M.", "required":false, "type":"string" }, { "name":"since", "in":"query", "description":"Start of the time range. This value is inclusive and must not be specified if sinceDuration is specified.", "required":false, "type":"string" }, { "name":"until", "in":"query", "description":"End of the time range. This value is exclusive and is set to the current time if not specified.", "required":false, "type":"string" }, { "name":"precision", "in":"query", "description":"Desired precision expressed in time duration of the returned elements. If not specified, the service will use the most precise precision available for the supplied interval. Note that the user cannot request a precision with a lower time interval that is presently available on the service. Note: You must use the iCalendar Duration format. For example, PT10M.", "required":false, "type":"string" }, { "name":"seriesIds", "in":"query", "description":"Filter on the metric series.", "required":false, "type":"string" }, { "name":"subjectIds", "in":"query", "description":"Filter on the metric subject.", "required":false, "type":"string" }, { "name":"metricTypeIds", "in":"query", "description":"Filter on the metric type.", "required":false, "type":"string" }, { "name":"extraFields", "in":"query", "description":"Specify the extra field to include in the report. Accepted value are: items.data.startInMillisecond and items.data.endInMillisecond", "required":false, "type":"string" }, { "name":"filterOutDeleted", "in":"query", "description":"Filter on isDeleted attribute of the metric series.", "required":false, "type":"boolean" } ], "responses":{ "200":{ "description":"successful operation", "schema":{ "$ref":"#/definitions/MetricReports" } } }, "x-internal-id":"monitoring-{idDomainName}-.customer-api-v1-metricReports-get", "x-filename-id":"monitoring-iddomainname-customer-api-v1-metricreports-get" } }, "/monitoring/{idDomainName}/.customer/api/v1/metricSeries":{ "get":{ "tags":[ "Metrics" ], "summary":"Retrieve Details of All Available Metric Instances", "description":"", "operationId":"searchMetricSeries", "produces":[ "application/json" ], "parameters":[ { "name":"Authorization", "in":"header", "required":true, "type":"string", "description":"Basic Authentication credentials. The user must be located in the identity domain name specified by the header X-ID-TENANT-NAME." }, { "name":"X-ID-TENANT-NAME", "in":"header", "required":true, "type":"string", "description":"Set to the identity domain ID where the user specified in the Authorization header resides." }, { "name":"idDomainName", "in":"path", "description":"Identity domain ID for the Oracle Monitoring Cloud Service account.", "required":true, "type":"string" }, { "name":"since", "in":"query", "description":"Filter on the creation date time.", "required":false, "type":"string" }, { "name":"until", "in":"query", "description":"Filter on the creation date time.", "required":false, "type":"string" }, { "name":"limit", "in":"query", "description":"Maximum number of items that the request should return.", "required":false, "type":"integer", "format":"int32" }, { "name":"offset", "in":"query", "description":"Offset of the first element to return (for pagination purpose).", "required":false, "type":"integer", "format":"int32" }, { "name":"expands", "in":"query", "description":"Expand attributes in the comma separated list.", "required":false, "type":"string" }, { "name":"ids", "in":"query", "description":"Filter on metric series ids.", "required":false, "type":"string" }, { "name":"subjectTypeIds", "in":"query", "description":"Filter on metric subject type ids.", "required":false, "type":"string" }, { "name":"subjectIds", "in":"query", "description":"Filter on metric subject ids.", "required":false, "type":"string" }, { "name":"metricTypeIds", "in":"query", "description":"Filter on metric type ids.", "required":false, "type":"string" }, { "name":"filterOutDeleted", "in":"query", "description":"Filter on isDeleted attribute of the metric series.", "required":false, "type":"boolean" } ], "responses":{ "200":{ "description":"successful operation", "schema":{ "$ref":"#/definitions/MetricSeriesResultSet" } } }, "x-internal-id":"monitoring-{idDomainName}-.customer-api-v1-metricSeries-get", "x-filename-id":"monitoring-iddomainname-customer-api-v1-metricseries-get" } }, "/monitoring/{idDomainName}/.customer/api/v1/metricSeries/{metricSeriesId}":{ "get":{ "tags":[ "Metrics" ], "summary":"Retrieve Details of a Specific Metric Instance", "description":"", "operationId":"searchSingularMetricSeries", "produces":[ "application/json" ], "parameters":[ { "name":"Authorization", "in":"header", "required":true, "type":"string", "description":"Basic Authentication credentials. The user must be located in the identity domain name specified by the header X-ID-TENANT-NAME." }, { "name":"X-ID-TENANT-NAME", "in":"header", "required":true, "type":"string", "description":"Set to the identity domain ID where the user specified in the Authorization header resides." }, { "name":"idDomainName", "in":"path", "description":"Identity domain ID for the Oracle Monitoring Cloud Service account.", "required":true, "type":"string" }, { "name":"metricSeriesId", "in":"path", "description":"Id of the metric series.", "required":true, "type":"string" }, { "name":"expands", "in":"query", "description":"Expand attributes in the comma separated list.", "required":false, "type":"string" } ], "responses":{ "200":{ "description":"successful operation", "schema":{ "$ref":"#/definitions/MetricSeries" } } }, "x-internal-id":"monitoring-{idDomainName}-.customer-api-v1-metricSeries-{metricSeriesId}-get", "x-filename-id":"monitoring-iddomainname-customer-api-v1-metricseries-metricseriesid-get" } }, "/monitoring/{idDomainName}/.customer/api/v1/metricSubjects":{ "get":{ "tags":[ "Metrics" ], "summary":"Retrieve Details of All Available Metric Subjects", "description":"", "operationId":"searchMetricSubjects", "produces":[ "application/json" ], "parameters":[ { "name":"Authorization", "in":"header", "required":true, "type":"string", "description":"Basic Authentication credentials. The user must be located in the identity domain name specified by the header X-ID-TENANT-NAME." }, { "name":"X-ID-TENANT-NAME", "in":"header", "required":true, "type":"string", "description":"Set to the identity domain ID where the user specified in the Authorization header resides." }, { "name":"idDomainName", "in":"path", "description":"Identity domain ID for the Oracle Monitoring Cloud Service account.", "required":true, "type":"string" }, { "name":"since", "in":"query", "description":"Filter on the creation date time.", "required":false, "type":"string" }, { "name":"until", "in":"query", "description":"Filter on the creation date time.", "required":false, "type":"string" }, { "name":"limit", "in":"query", "description":"Maximum number of items that the request should return.", "required":false, "type":"integer", "format":"int32" }, { "name":"offset", "in":"query", "description":"Offset of the first element to return (for pagination purpose).", "required":false, "type":"integer", "format":"int32" }, { "name":"ids", "in":"query", "description":"Filter on metric subject ids.", "required":false, "type":"string" }, { "name":"subjectTypeIds", "in":"query", "description":"Filter on metric subject type ids.", "required":false, "type":"string" }, { "name":"filterOutDeleted", "in":"query", "description":"Filter on isDeleted attribute of the metric subject.", "required":false, "type":"boolean" } ], "responses":{ "200":{ "description":"successful operation", "schema":{ "$ref":"#/definitions/MetricSubjects" } } }, "x-internal-id":"monitoring-{idDomainName}-.customer-api-v1-metricSubjects-get", "x-filename-id":"monitoring-iddomainname-customer-api-v1-metricsubjects-get" } }, "/monitoring/{idDomainName}/.customer/api/v1/metricSubjects/{metricSubjectId}":{ "get":{ "tags":[ "Metrics" ], "summary":"Retrieve Details of a Specific Metric Subject", "description":"", "operationId":"searchMetricSubject", "produces":[ "application/json" ], "parameters":[ { "name":"Authorization", "in":"header", "required":true, "type":"string", "description":"Basic Authentication credentials. The user must be located in the identity domain name specified by the header X-ID-TENANT-NAME." }, { "name":"X-ID-TENANT-NAME", "in":"header", "required":true, "type":"string", "description":"Set to the identity domain ID where the user specified in the Authorization header resides." }, { "name":"idDomainName", "in":"path", "description":"Identity domain ID for the Oracle Monitoring Cloud Service account.", "required":true, "type":"string" }, { "name":"metricSubjectId", "in":"path", "description":"Id of the metric subject.", "required":true, "type":"string" } ], "responses":{ "200":{ "description":"successful operation", "schema":{ "$ref":"#/definitions/MetricSubject" } } }, "x-internal-id":"monitoring-{idDomainName}-.customer-api-v1-metricSubjects-{metricSubjectId}-get", "x-filename-id":"monitoring-iddomainname-customer-api-v1-metricsubjects-metricsubjectid-get" } }, "/monitoring/{idDomainName}/.customer/api/v1/metricThresholds":{ "get":{ "tags":[ "Alerts" ], "summary":"Retrieve Details of All Available Metric Thresholds", "description":"", "operationId":"searchMetricThresholds", "produces":[ "application/json" ], "parameters":[ { "name":"Authorization", "in":"header", "required":true, "type":"string", "description":"Basic Authentication credentials. The user must be located in the identity domain name specified by the header X-ID-TENANT-NAME." }, { "name":"X-ID-TENANT-NAME", "in":"header", "required":true, "type":"string", "description":"Set to the identity domain ID where the user specified in the Authorization header resides." }, { "name":"idDomainName", "in":"path", "description":"Identity domain ID for the Oracle Monitoring Cloud Service account.", "required":true, "type":"string" }, { "name":"since", "in":"query", "description":"Filter on the creation date time.", "required":false, "type":"string" }, { "name":"until", "in":"query", "description":"Filter on the creation date time.", "required":false, "type":"string" }, { "name":"limit", "in":"query", "description":"Maximum number of items that the request should return.", "required":false, "type":"integer", "format":"int32" }, { "name":"offset", "in":"query", "description":"Offset of the first element to return (for pagination purpose).", "required":false, "type":"integer", "format":"int32" }, { "name":"seriesIds", "in":"query", "description":"Filter on the metric series. A coma separated list of IDs of the desired metric series.", "required":false, "type":"string" }, { "name":"actionChannelType", "in":"query", "description":"Filter on the action channel type.", "required":false, "type":"string" } ], "responses":{ "200":{ "description":"successful operation", "schema":{ "$ref":"#/definitions/MetricThresholds" } } }, "x-internal-id":"monitoring-{idDomainName}-.customer-api-v1-metricThresholds-get", "x-filename-id":"monitoring-iddomainname-customer-api-v1-metricthresholds-get" }, "post":{ "tags":[ "Alerts" ], "summary":"Create a Metric Threshold", "description":"

For some Oracle Cloud services, service administrators can configure rules to generate alerts when metrics exceed or are under specified thresholds for a specific time period.

\r\n

You can specify thresholds to monitor and receive alerts about specific metrics for specific instances. The resulting alert can be either an email to the service administrator or a notification message to the process that's polling for changes in the state of the alert threshold.

\r\n

The specified alert action (email or notification message) is triggered in the following situations: