{ "opencollection": "1.0.0", "info": { "name": "OCI Control Center Demand Signal Occ Metric Alarm API", "version": "20240430" }, "items": [ { "info": { "name": "OccMetricAlarm", "type": "folder" }, "items": [ { "info": { "name": "Gets a list of OccMetricAlarms across all compartments.", "type": "http" }, "http": { "method": "GET", "url": "https://127.0.0.1/20240430/internal/occMetricAlarms", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "displayName", "value": "", "type": "query", "description": "A filter to return only resources that match the given display name exactly." }, { "name": "limit", "value": "", "type": "query", "description": "For list pagination. The maximum number of results per page, or items to return in a\npaginated \"List\" call. For important details about how pagination works, see\n[List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine).\n" }, { "name": "page", "value": "", "type": "query", "description": "For list pagination. The value of the opc-next-page response header from the previous\n\"List\" call. For important details about how pagination works, see\n[List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine).\n" }, { "name": "sortOrder", "value": "", "type": "query", "description": "The sort order to use, either ascending (`ASC`) or descending (`DESC`)." }, { "name": "sortBy", "value": "", "type": "query", "description": "The field to sort by. You can provide only one sort order. Default order for `timeCreated`\nis descending. Default order for `displayName` is ascending.\n" } ] }, "docs": "Internal API to list all OccMetricAlarms in Kiev irrespective of compartment.\n" }, { "info": { "name": "Gets a list of OccMetricAlarms.", "type": "http" }, "http": { "method": "GET", "url": "https://127.0.0.1/20240430/occMetricAlarms", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "compartmentId", "value": "", "type": "query", "description": "The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compartment in which to list resources." }, { "name": "displayName", "value": "", "type": "query", "description": "A filter to return only resources that match the given display name exactly." }, { "name": "isActive", "value": "", "type": "query", "description": "Filter to list only active or inactive alarms." }, { "name": "limit", "value": "", "type": "query", "description": "For list pagination. The maximum number of results per page, or items to return in a\npaginated \"List\" call. For important details about how pagination works, see\n[List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine).\n" }, { "name": "page", "value": "", "type": "query", "description": "For list pagination. The value of the opc-next-page response header from the previous\n\"List\" call. For important details about how pagination works, see\n[List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine).\n" }, { "name": "sortOrder", "value": "", "type": "query", "description": "The sort order to use, either ascending (`ASC`) or descending (`DESC`)." }, { "name": "sortBy", "value": "", "type": "query", "description": "The field to sort by. You can provide only one sort order. Default order for `timeCreated`\nis descending. Default order for `displayName` is ascending.\n" } ] }, "docs": "Gets a list of OccMetricAlarms.\n" }, { "info": { "name": "Creates an OccMetricAlarm.", "type": "http" }, "http": { "method": "POST", "url": "https://127.0.0.1/20240430/occMetricAlarms", "headers": [ { "name": "opc-retry-token", "value": "" }, { "name": "opc-request-id", "value": "" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Creates a new OccMetricAlarm resource in the specified compartment with the provided configuration details.\n" }, { "info": { "name": "Gets an OccMetricAlarm.", "type": "http" }, "http": { "method": "GET", "url": "https://127.0.0.1/20240430/occMetricAlarms/:occMetricAlarmId", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "occMetricAlarmId", "value": "", "type": "path", "description": "The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the OccMetricAlarm." } ] }, "docs": "Retrieves the specified OccMetricAlarm resource based on its identifier.\n" }, { "info": { "name": "Updates an OccMetricAlarm.", "type": "http" }, "http": { "method": "PUT", "url": "https://127.0.0.1/20240430/occMetricAlarms/:occMetricAlarmId", "headers": [ { "name": "if-match", "value": "" }, { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "occMetricAlarmId", "value": "", "type": "path", "description": "The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the OccMetricAlarm." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Updates an existing OccMetricAlarm resource with new or modified configuration details.\n" }, { "info": { "name": "Deletes an OccMetricAlarm.", "type": "http" }, "http": { "method": "DELETE", "url": "https://127.0.0.1/20240430/occMetricAlarms/:occMetricAlarmId", "headers": [ { "name": "if-match", "value": "" }, { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "occMetricAlarmId", "value": "", "type": "path", "description": "The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the OccMetricAlarm." } ] }, "docs": "Deletes the specified OccMetricAlarm resource.\n" } ] } ], "bundled": true }