{ "opencollection": "1.0.0", "info": { "name": "Monitoring API", "version": "20180401" }, "items": [ { "info": { "name": "monitoring", "type": "folder" }, "items": [ { "info": { "name": "List Alarm Suppressions", "type": "http" }, "http": { "method": "GET", "url": "/20180401/alarmSuppressions", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "alarmId", "value": "", "type": "query", "description": "The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the alarm that is the target of the alarm suppression." }, { "name": "displayName", "value": "", "type": "query", "description": "A filter to return only resources that match the given display name exactly.\nUse this filter to list an alarm suppression by name.\nAlternatively, when you know the alarm suppression OCID, use the GetAlarmSuppression operation.\n" }, { "name": "lifecycleState", "value": "", "type": "query", "description": "A filter to return only resources that match the given lifecycle state exactly. When not specified, only resources in the ACTIVE lifecycle state are listed.\n" }, { "name": "level", "value": "", "type": "query", "description": "The level of this alarm suppression.\n`ALARM` indicates a suppression of the entire alarm, regardless of dimension.\n`DIMENSION` indicates a suppression configured for specified dimensions.\n" }, { "name": "compartmentId", "value": "", "type": "query", "description": "The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compartment for searching. \nUse the tenancy OCID to search in the root compartment.\n\nIf targetType is not specified, searches all suppressions defined under the compartment. \nIf targetType is `COMPARTMENT`, searches suppressions in the specified compartment only.\n\nExample: `ocid1.compartment.oc1..exampleuniqueID`\n" }, { "name": "compartmentIdInSubtree", "value": "", "type": "query", "description": "When true, returns resources from all compartments and subcompartments. The parameter can\nonly be set to true when compartmentId is the tenancy OCID (the tenancy is the root compartment).\nA true value requires the user to have tenancy-level permissions. If this requirement is not met,\nthen the call is rejected. When false, returns resources from only the compartment specified in\ncompartmentId. Default is false.\n" }, { "name": "targetType", "value": "", "type": "query", "description": "The target type to use when listing alarm suppressions. \n`ALARM` lists all suppression records for the specified alarm.\n`COMPARTMENT` lists all suppression records for the specified compartment or tenancy.\n" }, { "name": "isAllSuppressions", "value": "", "type": "query", "description": "Setting this parameter to true requires the query to specify the alarm (`alarmId`).\n\nWhen true, lists all alarm suppressions that affect the specified alarm,\nincluding suppressions that target the corresponding compartment or tenancy.\nWhen false, lists only the alarm suppressions that target the specified alarm.\n\nDefault is false.\n" }, { "name": "sortBy", "value": "", "type": "query", "description": "The field to use when sorting returned alarm suppressions. Only one sorting level is provided.\n\nExample: `timeCreated`\n" }, { "name": "sortOrder", "value": "", "type": "query", "description": "The sort order to use when sorting returned alarm suppressions. Ascending (ASC) or descending (DESC).\n\nExample: `ASC`\n" }, { "name": "page", "value": "", "type": "query", "description": "For list pagination. The value of the `opc-next-page` response header from the previous \"List\" call.\nFor important details about how pagination works, see\n[List Pagination](/iaas/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 return in a paginated \"List\" call.\nFor important details about how pagination works, see\n[List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine).\n\nDefault: 1000\n\nExample: 500\n" } ] }, "docs": "Lists alarm suppressions for the specified alarm. For more information, see\n[Listing Alarm Suppressions](/iaas/Content/Monitoring/Tasks/list-alarm-suppression.htm).\n\nFor important limits information, see\n[Limits on Monitoring](/iaas/Content/Monitoring/Concepts/monitoringoverview.htm#limits).\n\nThis call is subject to a Monitoring limit that applies to the total number of requests across all alarm operations.\nMonitoring might throttle this call to reject an otherwise valid request when the total r" }, { "info": { "name": "Creates a new alarm suppression", "type": "http" }, "http": { "method": "POST", "url": "/20180401/alarmSuppressions", "headers": [ { "name": "opc-request-id", "value": "" }, { "name": "opc-retry-token", "value": "" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Creates a new alarm suppression at the specified level (alarm-wide or dimension-specific).\nFor more information, see\n[Suppressing a Single Alarm](/iaas/Content/Monitoring/Tasks/create-alarm-suppression.htm) and\n[Suppressing Multiple Alarms](/iaas/Content/Monitoring/Tasks/create-alarm-suppression-multiple.htm).\n\nFor important limits information, see\n[Limits on Monitoring](/iaas/Content/Monitoring/Concepts/monitoringoverview.htm#limits).\n\nThis call is subject to a Monitoring limit that applies to " }, { "info": { "name": "GetAlarmSuppression", "type": "http" }, "http": { "method": "GET", "url": "/20180401/alarmSuppressions/:alarmSuppressionId", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "alarmSuppressionId", "value": "", "type": "path", "description": "The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the alarm suppression." } ] }, "docs": "Gets the specified alarm suppression. For more information, see\n[Getting an Alarm-wide Suppression](/iaas/Content/Monitoring/Tasks/get-alarm-suppression.htm).\n\nFor important limits information, see\n[Limits on Monitoring](/iaas/Content/Monitoring/Concepts/monitoringoverview.htm#limits).\n\nThis call is subject to a Monitoring limit that applies to the total number of requests across all alarm operations.\nMonitoring might throttle this call to reject an otherwise valid request when the total rate of" }, { "info": { "name": "DeleteAlarmSuppression", "type": "http" }, "http": { "method": "DELETE", "url": "/20180401/alarmSuppressions/:alarmSuppressionId", "headers": [ { "name": "opc-request-id", "value": "" }, { "name": "if-match", "value": "" } ], "params": [ { "name": "alarmSuppressionId", "value": "", "type": "path", "description": "The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the alarm suppression." } ] }, "docs": "Deletes the specified alarm suppression. For more information, see\n[Removing a Suppression from a Single Alarm](/iaas/Content/Monitoring/Tasks/delete-alarm-suppression.htm) and\n[Removing a Suppression from Multiple Alarms](/iaas/Content/Monitoring/Tasks/delete-alarm-suppression-multiple.htm).\n\nFor important limits information, see\n[Limits on Monitoring](/iaas/Content/Monitoring/Concepts/monitoringoverview.htm#limits).\n\nThis call is subject to a Monitoring limit that applies to the total number o" }, { "info": { "name": "ListAlarms", "type": "http" }, "http": { "method": "GET", "url": "/20180401/alarms", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "compartmentId", "value": "", "type": "query", "description": "The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compartment containing the\nresources monitored by the metric that you are searching for. Use tenancyId to search in\nthe root compartment.\n\nExample: `ocid1.compartment.oc1..exampleuniqueID`\n" }, { "name": "page", "value": "", "type": "query", "description": "For list pagination. The value of the `opc-next-page` response header from the previous \"List\" call.\nFor important details about how pagination works, see\n[List Pagination](/iaas/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 return in a paginated \"List\" call.\nFor important details about how pagination works, see\n[List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine).\n\nDefault: 1000\n\nExample: 500\n" }, { "name": "displayName", "value": "", "type": "query", "description": "A filter to return only resources that match the given display name exactly.\nUse this filter to list an alarm by name. Alternatively, when you know the alarm OCID, use the GetAlarm operation.\n" }, { "name": "lifecycleState", "value": "", "type": "query", "description": "A filter to return only alarms that match the given lifecycle state exactly. When not specified, only alarms in the ACTIVE lifecycle state are listed.\n" }, { "name": "sortBy", "value": "", "type": "query", "description": "The field to use when sorting returned alarm definitions. Only one sorting level is provided.\n\nExample: `severity`\n" }, { "name": "sortOrder", "value": "", "type": "query", "description": "The sort order to use when sorting returned alarm definitions. Ascending (ASC) or descending (DESC).\n\nExample: `ASC`\n" }, { "name": "compartmentIdInSubtree", "value": "", "type": "query", "description": "When true, returns resources from all compartments and subcompartments. The parameter can\nonly be set to true when compartmentId is the tenancy OCID (the tenancy is the root compartment).\nA true value requires the user to have tenancy-level permissions. If this requirement is not met,\nthen the call is rejected. When false, returns resources from only the compartment specified in\ncompartmentId. Default is false.\n" } ] }, "docs": "Lists the alarms for the specified compartment.\nFor more information, see\n[Listing Alarms](/iaas/Content/Monitoring/Tasks/list-alarm.htm).\nFor important limits information, see\n[Limits on Monitoring](/iaas/Content/Monitoring/Concepts/monitoringoverview.htm#limits).\n\nThis call is subject to a Monitoring limit that applies to the total number of requests across all alarm operations.\nMonitoring might throttle this call to reject an otherwise valid request when the total rate of alarm operations exc" }, { "info": { "name": "Creates a new alarm in the specified compartment.\n", "type": "http" }, "http": { "method": "POST", "url": "/20180401/alarms", "headers": [ { "name": "opc-request-id", "value": "" }, { "name": "opc-retry-token", "value": "" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Creates a new alarm in the specified compartment.\nFor more information, see\n[Creating an Alarm](/iaas/Content/Monitoring/Tasks/create-alarm.htm).\nFor important limits information, see\n[Limits on Monitoring](/iaas/Content/Monitoring/Concepts/monitoringoverview.htm#limits).\n\nThis call is subject to a Monitoring limit that applies to the total number of requests across all alarm operations.\nMonitoring might throttle this call to reject an otherwise valid request when the total rate of alarm operati" }, { "info": { "name": "ListAlarmsStatus", "type": "http" }, "http": { "method": "GET", "url": "/20180401/alarms/status", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "compartmentId", "value": "", "type": "query", "description": "The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compartment containing the\nresources monitored by the metric that you are searching for. Use tenancyId to search in\nthe root compartment.\n\nExample: `ocid1.compartment.oc1..exampleuniqueID`\n" }, { "name": "compartmentIdInSubtree", "value": "", "type": "query", "description": "When true, returns resources from all compartments and subcompartments. The parameter can\nonly be set to true when compartmentId is the tenancy OCID (the tenancy is the root compartment).\nA true value requires the user to have tenancy-level permissions. If this requirement is not met,\nthen the call is rejected. When false, returns resources from only the compartment specified in\ncompartmentId. Default is false.\n" }, { "name": "page", "value": "", "type": "query", "description": "For list pagination. The value of the `opc-next-page` response header from the previous \"List\" call.\nFor important details about how pagination works, see\n[List Pagination](/iaas/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 return in a paginated \"List\" call.\nFor important details about how pagination works, see\n[List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine).\n\nDefault: 1000\n\nExample: 500\n" }, { "name": "displayName", "value": "", "type": "query", "description": "A filter to return only resources that match the given display name exactly.\nUse this filter to list an alarm by name. Alternatively, when you know the alarm OCID, use the GetAlarm operation.\n" }, { "name": "sortBy", "value": "", "type": "query", "description": "The field to use when sorting returned alarm definitions. Only one sorting level is provided.\n\nExample: `severity`\n" }, { "name": "sortOrder", "value": "", "type": "query", "description": "The sort order to use when sorting returned alarm definitions. Ascending (ASC) or descending (DESC).\n\nExample: `ASC`\n" }, { "name": "resourceId", "value": "", "type": "query", "description": "A filter to return only the resource with the specified [OCID](/iaas/Content/General/Concepts/identifiers.htm).\nThe resource must be monitored by the metric that you are searching for.\n\nExample: `ocid1.instance.oc1.phx.exampleuniqueID`\n" }, { "name": "serviceName", "value": "", "type": "query", "description": "A filter to return only resources that match the given service name exactly.\nUse this filter to list all alarms containing metric streams that match the *exact* service-name dimension.\n\nExample: `logging-analytics`\n" }, { "name": "entityId", "value": "", "type": "query", "description": "A filter to return only resources that match the given entity [OCID](/iaas/Content/General/Concepts/identifiers.htm) exactly.\nThe resource (entity) must be monitored by the metric that you are searching for.\n\nExample: `ocid1.instance.oc1.phx.exampleuniqueID`\n" }, { "name": "status", "value": "", "type": "query", "description": "A filter to return only metric streams that match the specified status.\nFor example, the value \"FIRING\" returns only firing metric streams.\n\nExample: `FIRING`\n" } ] }, "docs": "List the status of each alarm in the specified compartment.\nStatus is collective, across all metric streams in the alarm.\nTo list alarm status for each metric stream, use [RetrieveDimensionStates](#/en/monitoring/latest/AlarmDimensionStatesCollection/RetrieveDimensionStates).\nOptionally filter by resource or status value.\n\nFor more information, see\n[Listing Alarm Statuses](/iaas/Content/Monitoring/Tasks/list-alarm-status.htm).\nFor important limits information, see\n[Limits on Monitoring](/iaas/Co" }, { "info": { "name": "GetAlarm", "type": "http" }, "http": { "method": "GET", "url": "/20180401/alarms/:alarmId", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "alarmId", "value": "", "type": "path", "description": "The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of an alarm.\n" } ] }, "docs": "Gets the specified alarm.\nFor more information, see\n[Getting an Alarm](/iaas/Content/Monitoring/Tasks/get-alarm.htm).\nFor important limits information, see\n[Limits on Monitoring](/iaas/Content/Monitoring/Concepts/monitoringoverview.htm#limits).\n\nThis call is subject to a Monitoring limit that applies to the total number of requests across all alarm operations.\nMonitoring might throttle this call to reject an otherwise valid request when the total rate of alarm operations exceeds 10 requests,\nor " }, { "info": { "name": "Updates an alarm.\n", "type": "http" }, "http": { "method": "PUT", "url": "/20180401/alarms/:alarmId", "headers": [ { "name": "if-match", "value": "" }, { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "alarmId", "value": "", "type": "path", "description": "The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of an alarm.\n" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Updates the specified alarm.\nFor more information, see\n[Updating an Alarm](/iaas/Content/Monitoring/Tasks/update-alarm.htm).\nFor important limits information, see\n[Limits on Monitoring](/iaas/Content/Monitoring/Concepts/monitoringoverview.htm#limits).\n\nThis call is subject to a Monitoring limit that applies to the total number of requests across all alarm operations.\nMonitoring might throttle this call to reject an otherwise valid request when the total rate of alarm operations exceeds 10 reques" }, { "info": { "name": "Deletes an alarm.\n", "type": "http" }, "http": { "method": "DELETE", "url": "/20180401/alarms/:alarmId", "headers": [ { "name": "if-match", "value": "" }, { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "alarmId", "value": "", "type": "path", "description": "The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of an alarm.\n" } ] }, "docs": "Deletes the specified alarm.\nFor more information, see\n[Deleting an Alarm](/iaas/Content/Monitoring/Tasks/delete-alarm.htm).\nFor important limits information, see\n[Limits on Monitoring](/iaas/Content/Monitoring/Concepts/monitoringoverview.htm#limits).\n\nThis call is subject to a Monitoring limit that applies to the total number of requests across all alarm operations.\nMonitoring might throttle this call to reject an otherwise valid request when the total rate of alarm operations exceeds 10 reques" }, { "info": { "name": "ChangeAlarmCompartment", "type": "http" }, "http": { "method": "POST", "url": "/20180401/alarms/:alarmId/actions/changeCompartment", "headers": [ { "name": "if-match", "value": "" }, { "name": "opc-request-id", "value": "" }, { "name": "opc-retry-token", "value": "" } ], "params": [ { "name": "alarmId", "value": "", "type": "path", "description": "The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of an alarm.\n" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Moves an alarm into a different compartment within the same tenancy.\nFor more information, see\n[Moving an Alarm](/iaas/Content/Monitoring/Tasks/change-compartment-alarm.htm).\n" }, { "info": { "name": "Removes any existing suppression for the specified alarm.\n", "type": "http" }, "http": { "method": "POST", "url": "/20180401/alarms/:alarmId/actions/removeSuppression", "headers": [ { "name": "if-match", "value": "" }, { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "alarmId", "value": "", "type": "path", "description": "The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of an alarm.\n" } ] }, "docs": "Removes any existing suppression for the specified alarm.\nFor more information, see\n[Removing a Suppression from a Single Alarm](/iaas/Content/Monitoring/Tasks/delete-alarm-suppression.htm) and\n[Removing a Suppression from Multiple Alarms](/iaas/Content/Monitoring/Tasks/delete-alarm-suppression-multiple.htm).\nFor important limits information, see\n[Limits on Monitoring](/iaas/Content/Monitoring/Concepts/monitoringoverview.htm#limits).\n\nThis call is subject to a Monitoring limit that applies to th" }, { "info": { "name": "RetrieveDimensionStates", "type": "http" }, "http": { "method": "POST", "url": "/20180401/alarms/:alarmId/actions/retrieveDimensionStates", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "alarmId", "value": "", "type": "path", "description": "The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of an alarm.\n" }, { "name": "page", "value": "", "type": "query", "description": "For list pagination. The value of the `opc-next-page` response header from the previous \"List\" call.\nFor important details about how pagination works, see\n[List Pagination](/iaas/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 return in a paginated \"List\" call.\nFor important details about how pagination works, see\n[List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine).\n\nDefault: 1000\n\nExample: 500\n" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Lists the current alarm status of each metric stream, where status is derived from the metric stream's last associated transition.\nOptionally filter by status value and one or more dimension key-value pairs.\n\nFor more information, see\n[Listing Metric Stream Status in an Alarm](/iaas/Content/Monitoring/Tasks/list-alarm-status-metric-stream.htm).\n\nFor important limits information, see\n[Limits on Monitoring](/iaas/Content/Monitoring/Concepts/monitoringoverview.htm#limits).\n\nThis call is subject to " }, { "info": { "name": "SummarizeAlarmSuppressionHistory", "type": "http" }, "http": { "method": "POST", "url": "/20180401/alarms/:alarmId/actions/summarizeAlarmSuppressionHistory", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "alarmId", "value": "", "type": "path", "description": "The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of an alarm.\n" }, { "name": "page", "value": "", "type": "query", "description": "For list pagination. The value of the `opc-next-page` response header from the previous \"List\" call.\nFor important details about how pagination works, see\n[List Pagination](/iaas/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 return in a paginated \"List\" call.\nFor important details about how pagination works, see\n[List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine).\n\nDefault: 1000\n\nExample: 500\n" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Returns history of suppressions for the specified alarm, including both dimension-specific and and alarm-wide suppressions. For more information, see\n[Getting Suppression History for an Alarm](/iaas/Content/Monitoring/Tasks/summarize-alarm-suppression-history.htm).\n\nFor important limits information, see\n[Limits on Monitoring](/iaas/Content/Monitoring/Concepts/monitoringoverview.htm#limits).\n\nThis call is subject to a Monitoring limit that applies to the total number of requests across all alarm " }, { "info": { "name": "GetAlarmHistory", "type": "http" }, "http": { "method": "GET", "url": "/20180401/alarms/:alarmId/history", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "alarmId", "value": "", "type": "path", "description": "The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of an alarm.\n" }, { "name": "alarmHistorytype", "value": "", "type": "query", "description": "The type of history entries to retrieve.\nState history (STATE_HISTORY), state transition history (STATE_TRANSITION_HISTORY), rule history (RULE_HISTORY) or rule transition history (RULE_TRANSITION_HISTORY).\nIf not specified, entries of all types are retrieved.\n\nExample: `STATE_HISTORY`\n" }, { "name": "page", "value": "", "type": "query", "description": "For list pagination. The value of the `opc-next-page` response header from the previous \"List\" call.\nFor important details about how pagination works, see\n[List Pagination](/iaas/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 return in a paginated \"List\" call.\nFor important details about how pagination works, see\n[List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine).\n\nDefault: 1000\n\nExample: 500\n" }, { "name": "timestampGreaterThanOrEqualTo", "value": "", "type": "query", "description": "A filter to return only alarm history entries with timestamps occurring on or after the specified date and time. Format defined by RFC3339.\n\nExample: `2023-01-01T01:00:00.789Z`\n" }, { "name": "timestampLessThan", "value": "", "type": "query", "description": "A filter to return only alarm history entries with timestamps occurring before the specified date and time. Format defined by RFC3339.\n\nExample: `2023-01-02T01:00:00.789Z`\n" } ] }, "docs": "Get the history of the specified alarm.\nFor more information, see\n[Getting History of an Alarm](/iaas/Content/Monitoring/Tasks/get-alarm-history.htm).\nFor important limits information, see\n[Limits on Monitoring](/iaas/Content/Monitoring/Concepts/monitoringoverview.htm#limits).\n\nThis call is subject to a Monitoring limit that applies to the total number of requests across all alarm operations.\nMonitoring might throttle this call to reject an otherwise valid request when the total rate of alarm op" }, { "info": { "name": "Publishes raw metric data points to the Monitoring service.\n", "type": "http" }, "http": { "method": "POST", "url": "/20180401/metrics", "headers": [ { "name": "opc-request-id", "value": "" }, { "name": "content-encoding", "value": "" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Publishes raw metric data points to the Monitoring service.\nFor a data point to be posted, its timestamp must be near current time (less than two hours in the past and less than 10 minutes in the future).\n\nFor more information about publishing metrics, see \n[Publishing Custom Metrics](/iaas/Content/Monitoring/Tasks/publishingcustommetrics.htm)\nand\n[Custom Metrics Walkthrough](/iaas/Content/Monitoring/Tasks/custom-metrics-walkthrough.htm).\nFor information about developing a metric-posting client," }, { "info": { "name": "List metrics based on matching criteria.", "type": "http" }, "http": { "method": "POST", "url": "/20180401/metrics/actions/listMetrics", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "compartmentId", "value": "", "type": "query", "description": "The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compartment containing the\nresources monitored by the metric that you are searching for. Use tenancyId to search in\nthe root compartment.\n\nExample: `ocid1.compartment.oc1..exampleuniqueID`\n" }, { "name": "page", "value": "", "type": "query", "description": "For list pagination. The value of the `opc-next-page` response header from the previous \"List\" call.\nFor important details about how pagination works, see\n[List Pagination](/iaas/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 return in a paginated \"List\" call.\nFor important details about how pagination works, see\n[List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine).\n\nDefault: 1000\n\nExample: 500\n" }, { "name": "compartmentIdInSubtree", "value": "", "type": "query", "description": "When true, returns resources from all compartments and subcompartments. The parameter can\nonly be set to true when compartmentId is the tenancy OCID (the tenancy is the root compartment).\nA true value requires the user to have tenancy-level permissions. If this requirement is not met,\nthen the call is rejected. When false, returns resources from only the compartment specified in\ncompartmentId. Default is false.\n" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Returns metric definitions that match the criteria specified in the request. Compartment OCID required.\nFor more information, see\n[Listing Metric Definitions](/iaas/Content/Monitoring/Tasks/list-metric.htm).\nFor information about metrics, see\n[Metrics Overview](/iaas/Content/Monitoring/Concepts/monitoringoverview.htm#MetricsOverview).\nFor important limits information, see\n[Limits on Monitoring](/iaas/Content/Monitoring/Concepts/monitoringoverview.htm#limits).\n\nTransactions Per Second (TPS) per-t" }, { "info": { "name": "Summarizes and returns metrics data filtered using the provided query expression and compartmentId.", "type": "http" }, "http": { "method": "POST", "url": "/20180401/metrics/actions/summarizeMetricsData", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "compartmentId", "value": "", "type": "query", "description": "The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compartment containing the\nresources monitored by the metric that you are searching for. Use tenancyId to search in\nthe root compartment.\n\nExample: `ocid1.compartment.oc1..exampleuniqueID`\n" }, { "name": "compartmentIdInSubtree", "value": "", "type": "query", "description": "When true, returns resources from all compartments and subcompartments. The parameter can\nonly be set to true when compartmentId is the tenancy OCID (the tenancy is the root compartment).\nA true value requires the user to have tenancy-level permissions. If this requirement is not met,\nthen the call is rejected. When false, returns resources from only the compartment specified in\ncompartmentId. Default is false.\n" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Returns aggregated data that match the criteria specified in the request. Compartment OCID required.\nFor more information, see\n[Querying Metric Data](/iaas/Content/Monitoring/Tasks/query-metric-landing.htm)\nand\n[Creating a Query](/iaas/Content/Monitoring/Tasks/query-metric.htm).\nFor important limits information, see\n[Limits on Monitoring](/iaas/Content/Monitoring/Concepts/monitoringoverview.htm#limits).\n\nTransactions Per Second (TPS) per-tenancy limit for this operation: 10.\n" } ] } ], "bundled": true }