{ "opencollection": "1.0.0", "info": { "name": "Stack Monitoring API", "version": "20210330" }, "items": [ { "info": { "name": "stackMonitoring", "type": "folder" }, "items": [ { "info": { "name": "List summary of baseline-able metrics", "type": "http" }, "http": { "method": "GET", "url": "http://127.0.0.1/20210330/baselineableMetrics", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "resourceGroup", "value": "", "type": "query", "description": "Resource Group" }, { "name": "name", "value": "", "type": "query", "description": "Metric Name" }, { "name": "metricNamespace", "value": "", "type": "query", "description": "A filter to return monitored resource types that has the matching namespace.\n" }, { "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\nprevious \"List\" call. For important details about how pagination works, see\n[List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine).\n" }, { "name": "compartmentId", "value": "", "type": "query", "description": "The ID of the compartment in which data is listed." }, { "name": "baselineableMetricId", "value": "", "type": "query", "description": "Identifier for the metric" }, { "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 is ascending.\n" } ] }, "docs": "List of summary of baseline-able metrics for a given resource group if specified." }, { "info": { "name": "Creates Baseline-able metric", "type": "http" }, "http": { "method": "POST", "url": "http://127.0.0.1/20210330/baselineableMetrics", "headers": [ { "name": "opc-request-id", "value": "" }, { "name": "opc-retry-token", "value": "" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Creates the specified Baseline-able metric" }, { "info": { "name": "Get Baseline-able metric", "type": "http" }, "http": { "method": "GET", "url": "http://127.0.0.1/20210330/baselineableMetrics/:baselineableMetricId", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "baselineableMetricId", "value": "", "type": "path", "description": "Identifier for the metric" } ] }, "docs": "Get the Baseline-able metric for the given id" }, { "info": { "name": "Updates Baseline-able metric", "type": "http" }, "http": { "method": "PUT", "url": "http://127.0.0.1/20210330/baselineableMetrics/:baselineableMetricId", "headers": [ { "name": "if-match", "value": "" }, { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "baselineableMetricId", "value": "", "type": "path", "description": "Identifier for the metric" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Updates the Baseline-able metric for the given id" }, { "info": { "name": "Deletes Baseline-able metric", "type": "http" }, "http": { "method": "DELETE", "url": "http://127.0.0.1/20210330/baselineableMetrics/:baselineableMetricId", "headers": [ { "name": "opc-request-id", "value": "" }, { "name": "if-match", "value": "" } ], "params": [ { "name": "baselineableMetricId", "value": "", "type": "path", "description": "Identifier for the metric" } ] }, "docs": "Deletes the Baseline-able metric for the given id" }, { "info": { "name": "Evaluate metric for anomalies", "type": "http" }, "http": { "method": "POST", "url": "http://127.0.0.1/20210330/baselineableMetrics/:baselineableMetricId/actions/evaluate", "headers": [ { "name": "opc-request-id", "value": "" }, { "name": "if-match", "value": "" }, { "name": "opc-retry-token", "value": "" } ], "params": [ { "name": "baselineableMetricId", "value": "", "type": "path", "description": "Identifier for the metric" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Evaluates metric for anomalies for the given data points" }, { "info": { "name": "Gets a list of configurations.", "type": "http" }, "http": { "method": "GET", "url": "http://127.0.0.1/20210330/configs", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "compartmentId", "value": "", "type": "query", "description": "The ID of the compartment in which data is listed." }, { "name": "displayName", "value": "", "type": "query", "description": "A filter to return only resources that match the entire display name given." }, { "name": "type", "value": "", "type": "query", "description": "A filter to return only configuration items for a given config type." }, { "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\nprevious \"List\" call. For important details about how pagination works, see\n[List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine).\n" }, { "name": "lifecycleState", "value": "", "type": "query", "description": "The current state of the Config." }, { "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. \nDefault order for 'timeCreated' is descending. \nDefault order for 'displayName' and 'configType' is ascending. \n" } ] }, "docs": "Get a list of configurations in a compartment.\n" }, { "info": { "name": "Create a configuration.", "type": "http" }, "http": { "method": "POST", "url": "http://127.0.0.1/20210330/configs", "headers": [ { "name": "opc-retry-token", "value": "" }, { "name": "opc-request-id", "value": "" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Creates a configuration item, for example to define \nwhether resources of a specific type should be discovered automatically. \n\nFor example, when a new Management Agent gets registered in a certain compartment, \nthis Management Agent can potentially get promoted to a HOST resource. \nThe configuration item will determine if HOST resources in the selected compartment will be\ndiscovered automatically.\n" }, { "info": { "name": "Get configuration.", "type": "http" }, "http": { "method": "GET", "url": "http://127.0.0.1/20210330/configs/:configId", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "configId", "value": "", "type": "path", "description": "Unique Config identifier." } ] }, "docs": "Gets the details of a configuration." }, { "info": { "name": "Update a configuration.", "type": "http" }, "http": { "method": "PUT", "url": "http://127.0.0.1/20210330/configs/:configId", "headers": [ { "name": "if-match", "value": "" }, { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "configId", "value": "", "type": "path", "description": "Unique Config identifier." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Updates the configuration identified by the id given." }, { "info": { "name": "Delete a configuration.", "type": "http" }, "http": { "method": "DELETE", "url": "http://127.0.0.1/20210330/configs/:configId", "headers": [ { "name": "if-match", "value": "" }, { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "configId", "value": "", "type": "path", "description": "Unique Config identifier." } ] }, "docs": "Deletes a configuration identified by the id." }, { "info": { "name": "Move a configuration to another compartment.", "type": "http" }, "http": { "method": "POST", "url": "http://127.0.0.1/20210330/configs/:configId/actions/changeCompartment", "headers": [ { "name": "if-match", "value": "" }, { "name": "opc-request-id", "value": "" }, { "name": "opc-retry-token", "value": "" } ], "params": [ { "name": "configId", "value": "", "type": "path", "description": "Unique Config identifier." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Moves the configuration item to another compartment. \nBasically, this will disable any configuration for this configuration type in thie compartment,\nand will enable it in the new one. \n\nFor example, if for a HOST resource type, the configuration with AUTO_PROMOTE in the configuration type \nand TRUE as value is moved, automatic discovery will not take place in this compartment any more, but in the new one. \n\nSo this operation will have the same effect as deleting the configuration item in the o" }, { "info": { "name": "API to get the details of all Discovery Jobs.", "type": "http" }, "http": { "method": "GET", "url": "http://127.0.0.1/20210330/discoveryJobs", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "compartmentId", "value": "", "type": "query", "description": "The ID of the compartment in which data is listed." }, { "name": "name", "value": "", "type": "query", "description": "A filter to return only discovery jobs that match the entire resource name given." }, { "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\nprevious \"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`).\n" }, { "name": "sortBy", "value": "", "type": "query", "description": "The field to sort by. Only one sort order may be provided. Default order for timeUpdated is descending. Default order for resourceName is ascending.\n" } ] }, "docs": "API to get the details of all Discovery Jobs.\n" }, { "info": { "name": "API to create discovery Job and submit discovery Details to agent.", "type": "http" }, "http": { "method": "POST", "url": "http://127.0.0.1/20210330/discoveryJobs", "headers": [ { "name": "opc-request-id", "value": "" }, { "name": "opc-retry-token", "value": "" } ], "body": { "type": "json", "data": "{}" } }, "docs": "API to create discovery Job and submit discovery Details to agent.\n" }, { "info": { "name": "API to get the details of Discovery Job by identifier.", "type": "http" }, "http": { "method": "GET", "url": "http://127.0.0.1/20210330/discoveryJobs/:discoveryJobId", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "discoveryJobId", "value": "", "type": "path", "description": "The Discovery Job ID" } ] }, "docs": "API to get the details of discovery Job by identifier.\n" }, { "info": { "name": "Delete a Discovery Job", "type": "http" }, "http": { "method": "DELETE", "url": "http://127.0.0.1/20210330/discoveryJobs/:discoveryJobId", "headers": [ { "name": "if-match", "value": "" }, { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "discoveryJobId", "value": "", "type": "path", "description": "The Discovery Job ID" } ] }, "docs": "Deletes a DiscoveryJob by identifier" }, { "info": { "name": "API to get all the logs of a Discovery Job.", "type": "http" }, "http": { "method": "GET", "url": "http://127.0.0.1/20210330/discoveryJobs/:discoveryJobId/logs", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "discoveryJobId", "value": "", "type": "path", "description": "The Discovery Job ID" }, { "name": "logType", "value": "", "type": "query", "description": "The log type like INFO, WARNING, ERROR, SUCCESS" }, { "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\nprevious \"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`).\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 logType is ascending.\n" } ] }, "docs": "API to get all the logs of a Discovery Job.\n" }, { "info": { "name": "Gets a list of all metric extensions in a compartment", "type": "http" }, "http": { "method": "GET", "url": "http://127.0.0.1/20210330/metricExtensions", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "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\nprevious \"List\" call. For important details about how pagination works, see\n[List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine).\n" }, { "name": "sortBy", "value": "", "type": "query", "description": "The field to sort by. Only one sort order may be provided.\nDefault order for timeCreated is descending. Default order for resources is ascending.\n" }, { "name": "sortOrder", "value": "", "type": "query", "description": "The sort order to use, either ascending (`ASC`) or descending (`DESC`).\n" }, { "name": "compartmentId", "value": "", "type": "query", "description": "The ID of the compartment in which data is listed." }, { "name": "resourceType", "value": "", "type": "query", "description": "A filter to return resources based on resource type." }, { "name": "name", "value": "", "type": "query", "description": "A filter to return resources based on name." }, { "name": "status", "value": "", "type": "query", "description": "A filter to return resources based on status e.g. Draft or Published" }, { "name": "lifecycleState", "value": "", "type": "query", "description": "A filter to return metric extensions based on Lifecycle State" }, { "name": "enabledOnResourceId", "value": "", "type": "query", "description": "A filter to return metric extensions based on input resource Id on which metric extension is enabled" } ] }, "docs": "Returns a list of metric extensions" }, { "info": { "name": "Create a new metric extension resource", "type": "http" }, "http": { "method": "POST", "url": "http://127.0.0.1/20210330/metricExtensions", "headers": [ { "name": "opc-retry-token", "value": "" }, { "name": "opc-request-id", "value": "" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Creates a new metric extension resource for a given compartment\n" }, { "info": { "name": "Get Metric Extension", "type": "http" }, "http": { "method": "GET", "url": "http://127.0.0.1/20210330/metricExtensions/:metricExtensionId", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "metricExtensionId", "value": "", "type": "path", "description": "The [OCID](/Content/General/Concepts/identifiers.htm) of the metric extension resource." } ] }, "docs": "Gets a Metric Extension by identifier" }, { "info": { "name": "Update the Metric Extension identified by the id", "type": "http" }, "http": { "method": "PUT", "url": "http://127.0.0.1/20210330/metricExtensions/:metricExtensionId", "headers": [ { "name": "if-match", "value": "" }, { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "metricExtensionId", "value": "", "type": "path", "description": "The [OCID](/Content/General/Concepts/identifiers.htm) of the metric extension resource." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Updates the Metric Extension" }, { "info": { "name": "Delete the metric extension resource", "type": "http" }, "http": { "method": "DELETE", "url": "http://127.0.0.1/20210330/metricExtensions/:metricExtensionId", "headers": [ { "name": "if-match", "value": "" }, { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "metricExtensionId", "value": "", "type": "path", "description": "The [OCID](/Content/General/Concepts/identifiers.htm) of the metric extension resource." } ] }, "docs": "Deletes a metric extension by identifier" }, { "info": { "name": "Moves a Metric Extension into a different compartment.", "type": "http" }, "http": { "method": "POST", "url": "http://127.0.0.1/20210330/metricExtensions/:metricExtensionId/actions/changeCompartment", "headers": [ { "name": "if-match", "value": "" }, { "name": "opc-request-id", "value": "" }, { "name": "opc-retry-token", "value": "" } ], "params": [ { "name": "metricExtensionId", "value": "", "type": "path", "description": "The [OCID](/Content/General/Concepts/identifiers.htm) of the metric extension resource." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Moves a Metric Extension resource from one compartment identifier to another. \nWhen provided, If-Match is checked against ETag values of the resource.\n" }, { "info": { "name": "Disable metric extension.", "type": "http" }, "http": { "method": "POST", "url": "http://127.0.0.1/20210330/metricExtensions/:metricExtensionId/actions/disable", "headers": [ { "name": "if-match", "value": "" }, { "name": "opc-request-id", "value": "" }, { "name": "opc-retry-token", "value": "" } ], "params": [ { "name": "metricExtensionId", "value": "", "type": "path", "description": "The [OCID](/Content/General/Concepts/identifiers.htm) of the metric extension resource." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Submits a request to disable matching metric extension Id for the given Resource IDs\n" }, { "info": { "name": "Enable Metric Extension", "type": "http" }, "http": { "method": "POST", "url": "http://127.0.0.1/20210330/metricExtensions/:metricExtensionId/actions/enable", "headers": [ { "name": "if-match", "value": "" }, { "name": "opc-request-id", "value": "" }, { "name": "opc-retry-token", "value": "" } ], "params": [ { "name": "metricExtensionId", "value": "", "type": "path", "description": "The [OCID](/Content/General/Concepts/identifiers.htm) of the metric extension resource." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Submits a request to enable matching metric extension Id for the given Resource IDs\n" }, { "info": { "name": "Export metric extension definition in a template format.", "type": "http" }, "http": { "method": "POST", "url": "http://127.0.0.1/20210330/metricExtensions/:metricExtensionId/actions/export", "headers": [ { "name": "if-match", "value": "" }, { "name": "opc-request-id", "value": "" }, { "name": "opc-retry-token", "value": "" } ], "params": [ { "name": "metricExtensionId", "value": "", "type": "path", "description": "The [OCID](/Content/General/Concepts/identifiers.htm) of the metric extension resource." } ] }, "docs": "Export generates a template used to create new metric extension resources similar to matching metric extension id.\nResponse is a file that contains metric extension definition with placeholders for fields to be changed. \n" }, { "info": { "name": "Publish the Metric Extension identified by the id", "type": "http" }, "http": { "method": "POST", "url": "http://127.0.0.1/20210330/metricExtensions/:metricExtensionId/actions/publish", "headers": [ { "name": "opc-request-id", "value": "" }, { "name": "opc-retry-token", "value": "" }, { "name": "if-match", "value": "" } ], "params": [ { "name": "metricExtensionId", "value": "", "type": "path", "description": "The [OCID](/Content/General/Concepts/identifiers.htm) of the metric extension resource." } ] }, "docs": "Publish the Metric Extension identified by the id" }, { "info": { "name": "Perform test of Metric Extension on a specific resource Id", "type": "http" }, "http": { "method": "POST", "url": "http://127.0.0.1/20210330/metricExtensions/:metricExtensionId/actions/test", "headers": [ { "name": "if-match", "value": "" }, { "name": "opc-request-id", "value": "" }, { "name": "opc-retry-token", "value": "" } ], "params": [ { "name": "metricExtensionId", "value": "", "type": "path", "description": "The [OCID](/Content/General/Concepts/identifiers.htm) of the metric extension resource." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Performs test of Metric Extension on a specific resource Id" }, { "info": { "name": "List stack monitoring monitoredResourceTasks.", "type": "http" }, "http": { "method": "GET", "url": "http://127.0.0.1/20210330/monitoredResourceTasks", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "compartmentId", "value": "", "type": "query", "description": "The [OCID](/Content/General/Concepts/identifiers.htm) of the compartment for which \nstack monitoring resource tasks should be listed.\n" }, { "name": "status", "value": "", "type": "query", "description": "A filter to return only resources that matches with lifecycleState given." }, { "name": "sortBy", "value": "", "type": "query", "description": "The field to sort by. Only one sort order may be provided. \nDefault order for 'timeUpdated' is descending. \n" }, { "name": "sortOrder", "value": "", "type": "query", "description": "The sort order to use, either ascending (`ASC`) or descending (`DESC`).\n" }, { "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\nprevious \"List\" call. For important details about how pagination works, see\n[List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine).\n" } ] }, "docs": "Returns a list of stack monitoring resource tasks in the compartment.\n" }, { "info": { "name": "Create a new stack monitoring resource task.", "type": "http" }, "http": { "method": "POST", "url": "http://127.0.0.1/20210330/monitoredResourceTasks", "headers": [ { "name": "opc-request-id", "value": "" }, { "name": "opc-retry-token", "value": "" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Create a new stack monitoring resource task." }, { "info": { "name": "Get stack monitoring resource task details.", "type": "http" }, "http": { "method": "GET", "url": "http://127.0.0.1/20210330/monitoredResourceTasks/:monitoredResourceTaskId", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "monitoredResourceTaskId", "value": "", "type": "path", "description": "The [OCID](/Content/General/Concepts/identifiers.htm) of stack monitoring resource task." } ] }, "docs": "Gets stack monitoring resource task details by identifier [OCID](/Content/General/Concepts/identifiers.htm)." }, { "info": { "name": "Update stack monitoring resource task.\n", "type": "http" }, "http": { "method": "PUT", "url": "http://127.0.0.1/20210330/monitoredResourceTasks/:monitoredResourceTaskId", "headers": [ { "name": "if-match", "value": "" }, { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "monitoredResourceTaskId", "value": "", "type": "path", "description": "The [OCID](/Content/General/Concepts/identifiers.htm) of stack monitoring resource task." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Update stack monitoring resource task by the given identifier [OCID](/Content/General/Concepts/identifiers.htm).\n" }, { "info": { "name": "Moves a stack monitoring resource task into a different compartment.", "type": "http" }, "http": { "method": "POST", "url": "http://127.0.0.1/20210330/monitoredResourceTasks/:monitoredResourceTaskId/actions/changeCompartment", "headers": [ { "name": "if-match", "value": "" }, { "name": "opc-request-id", "value": "" }, { "name": "opc-retry-token", "value": "" } ], "params": [ { "name": "monitoredResourceTaskId", "value": "", "type": "path", "description": "The [OCID](/Content/General/Concepts/identifiers.htm) of stack monitoring resource task." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Moves a stack monitoring resource task from one compartment to another.\n" }, { "info": { "name": "List monitored resource types.", "type": "http" }, "http": { "method": "GET", "url": "http://127.0.0.1/20210330/monitoredResourceTypes", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "compartmentId", "value": "", "type": "query", "description": "The [OCID](/Content/General/Concepts/identifiers.htm) of the tenancy for which \nmonitored resource types should be listed.\n" }, { "name": "name", "value": "", "type": "query", "description": "A filter to return monitored resource types that match exactly with the resource type name given.\n" }, { "name": "status", "value": "", "type": "query", "description": "A filter to return only resources that matches with lifecycleState given." }, { "name": "isExcludeSystemTypes", "value": "", "type": "query", "description": "A filter to exclude system resource types. If set to true, system resource types will be excluded.\n" }, { "name": "metricNamespace", "value": "", "type": "query", "description": "A filter to return monitored resource types that has the matching namespace.\n" }, { "name": "sortBy", "value": "", "type": "query", "description": "The field to sort by. Only one sort order may be provided. \nDefault order for 'timeUpdated' is descending. Default order for 'name' is ascending.\n" }, { "name": "sortOrder", "value": "", "type": "query", "description": "The sort order to use, either ascending (`ASC`) or descending (`DESC`).\n" }, { "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\nprevious \"List\" call. For important details about how pagination works, see\n[List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine).\n" }, { "name": "fields", "value": "", "type": "query", "description": "Partial response refers to an optimization technique offered\nby the RESTful web APIs, to return only the information\n(fields) required by the client. In this mechanism, the client\nsends the required field names as the query parameters for\nan API to the server, and the server trims down the default\nresponse content by removing the fields that are not required\nby the client. The parameter controls which fields to\nreturn and should be a query string parameter called \"fields\" of\nan array type, provide the values as enums, and use collectionFormat.\n\nMonitoredResourceType Id, name and compartment will be added by default.\n" }, { "name": "excludeFields", "value": "", "type": "query", "description": "Partial response refers to an optimization technique offered\nby the RESTful web APIs, to return all the information except\nthe fields requested to be excluded (excludeFields) by the client.\nIn this mechanism, the client\nsends the exclude field names as the query parameters for\nan API to the server, and the server trims down the default\nresponse content by removing the fields that are not required\nby the client. The parameter controls which fields to\nexlude and to return and should be a query string parameter\ncalled \"excludeFields\" of an array type, provide the values\nas enums, and use collectionFormat.\n" } ] }, "docs": "Returns list of resource types accessible to the customer. \nThere are two types of resource types - System resource types and User resource types. \nSystem resource types are available out of the box in the stack monitoring resource service \nand are accessible to all the tenant users. User resource types are created in the context \nof a tenancy and are visible only for the tenancy. By default, both System resource types \nand User resource types are returned.\n" }, { "info": { "name": "Create a new monitored resource type.", "type": "http" }, "http": { "method": "POST", "url": "http://127.0.0.1/20210330/monitoredResourceTypes", "headers": [ { "name": "opc-request-id", "value": "" }, { "name": "opc-retry-token", "value": "" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Creates a new monitored resource type." }, { "info": { "name": "Get monitored resource type.", "type": "http" }, "http": { "method": "GET", "url": "http://127.0.0.1/20210330/monitoredResourceTypes/:monitoredResourceTypeId", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "monitoredResourceTypeId", "value": "", "type": "path", "description": "The [OCID](/Content/General/Concepts/identifiers.htm) of monitored resource type." } ] }, "docs": "Gets a monitored resource type by identifier [OCID](/Content/General/Concepts/identifiers.htm)." }, { "info": { "name": "Updates the Monitored Resource Type", "type": "http" }, "http": { "method": "PUT", "url": "http://127.0.0.1/20210330/monitoredResourceTypes/:monitoredResourceTypeId", "headers": [ { "name": "if-match", "value": "" }, { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "monitoredResourceTypeId", "value": "", "type": "path", "description": "The [OCID](/Content/General/Concepts/identifiers.htm) of monitored resource type." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Update the Monitored Resource Type identified by the identifier [OCID](/Content/General/Concepts/identifiers.htm).\n" }, { "info": { "name": "Delete the monitored resource type.", "type": "http" }, "http": { "method": "DELETE", "url": "http://127.0.0.1/20210330/monitoredResourceTypes/:monitoredResourceTypeId", "headers": [ { "name": "if-match", "value": "" }, { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "monitoredResourceTypeId", "value": "", "type": "path", "description": "The [OCID](/Content/General/Concepts/identifiers.htm) of monitored resource type." } ] }, "docs": "Deletes a monitored resource type by identifier [OCID](/Content/General/Concepts/identifiers.htm)." }, { "info": { "name": "Gets a list of all monitored resources in a compartment", "type": "http" }, "http": { "method": "GET", "url": "http://127.0.0.1/20210330/monitoredResources", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "compartmentId", "value": "", "type": "query", "description": "The ID of the compartment in which data is listed." }, { "name": "name", "value": "", "type": "query", "description": "A filter to return resources that match exact resource name." }, { "name": "workRequestId", "value": "", "type": "query", "description": "A filter to return resources which were impacted as part of this work request identifier." }, { "name": "status", "value": "", "type": "query", "description": "A filter to return only resources with matching lifecycleState." }, { "name": "sortBy", "value": "", "type": "query", "description": "The field to sort by. Only one sort order may be provided.\nDefault order for timeCreated is descending. Default order for resources is ascending.\n" }, { "name": "sortOrder", "value": "", "type": "query", "description": "The sort order to use, either ascending (`ASC`) or descending (`DESC`).\n" }, { "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\nprevious \"List\" call. For important details about how pagination works, see\n[List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine).\n" } ] }, "docs": "Returns a list of monitored resources." }, { "info": { "name": "Create a new monitored resource.\n", "type": "http" }, "http": { "method": "POST", "url": "http://127.0.0.1/20210330/monitoredResources", "headers": [ { "name": "opc-retry-token", "value": "" }, { "name": "opc-request-id", "value": "" }, { "name": "external-resource-id", "value": "" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Creates a new monitored resource for the given resource type with the details and submits \na work request for promoting the resource to agent. Once the resource is successfully \nadded to agent, resource state will be marked active.\n" }, { "info": { "name": "Create an association between two monitored resources.", "type": "http" }, "http": { "method": "POST", "url": "http://127.0.0.1/20210330/monitoredResources/actions/associateMonitoredResources", "headers": [ { "name": "opc-request-id", "value": "" }, { "name": "opc-retry-token", "value": "" }, { "name": "if-match", "value": "" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Create an association between two monitored resources. Associations can be created \nbetween resources from different compartments as long they are in same tenancy.\nUser should have required access in both the compartments.\n" }, { "info": { "name": "Removes associations between two monitored resources.", "type": "http" }, "http": { "method": "POST", "url": "http://127.0.0.1/20210330/monitoredResources/actions/disassociateMonitoredResources", "headers": [ { "name": "opc-request-id", "value": "" }, { "name": "opc-retry-token", "value": "" }, { "name": "if-match", "value": "" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Removes associations between two monitored resources." }, { "info": { "name": "Returns a list of monitored resources.\n", "type": "http" }, "http": { "method": "POST", "url": "http://127.0.0.1/20210330/monitoredResources/actions/search", "headers": [ { "name": "opc-request-id", "value": "" }, { "name": "opc-retry-token", "value": "" }, { "name": "if-match", "value": "" } ], "params": [ { "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\nprevious \"List\" call. For important details about how pagination works, see\n[List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine).\n" }, { "name": "fields", "value": "", "type": "query", "description": "Partial response refers to an optimization technique offered\nby the RESTful web APIs, to return only the information\n(fields) required by the client. In this mechanism, the client\nsends the required field names as the query parameters for\nan API to the server, and the server trims down the default\nresponse content by removing the fields that are not required\nby the client. The parameter controls which fields to\nreturn and should be a query string parameter called \"fields\" of\nan array type, provide the values as enums, and use collectionFormat.\n" }, { "name": "excludeFields", "value": "", "type": "query", "description": "Partial response refers to an optimization technique offered\nby the RESTful web APIs, to return all the information except\nthe fields requested to be excluded (excludeFields) by the client.\nIn this mechanism, the client\nsends the exclude field names as the query parameters for\nan API to the server, and the server trims down the default\nresponse content by removing the fields that are not required\nby the client. The parameter controls which fields to\nexlude and to return and should be a query string parameter\ncalled \"excludeFields\" of an array type, provide the values\nas enums, and use collectionFormat.\n" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Gets a list of all monitored resources in a compartment for the given search criteria.\n" }, { "info": { "name": "List associated monitored resources.\n", "type": "http" }, "http": { "method": "POST", "url": "http://127.0.0.1/20210330/monitoredResources/actions/searchAssociatedResources", "headers": [ { "name": "opc-request-id", "value": "" }, { "name": "opc-retry-token", "value": "" }, { "name": "if-match", "value": "" } ], "params": [ { "name": "fields", "value": "", "type": "query", "description": "Partial response refers to an optimization technique offered\nby the RESTful web APIs, to return only the information\n(fields) required by the client. In this mechanism, the client\nsends the required field names as the query parameters for\nan API to the server, and the server trims down the default\nresponse content by removing the fields that are not required\nby the client. The parameter controls which fields to\nreturn and should be a query string parameter called \"fields\" of\nan array type, provide the values as enums, and use collectionFormat.\n" }, { "name": "excludeFields", "value": "", "type": "query", "description": "Partial response refers to an optimization technique offered\nby the RESTful web APIs, to return all the information except\nthe fields requested to be excluded (excludeFields) by the client.\nIn this mechanism, the client\nsends the exclude field names as the query parameters for\nan API to the server, and the server trims down the default\nresponse content by removing the fields that are not required\nby the client. The parameter controls which fields to\nexlude and to return and should be a query string parameter\ncalled \"excludeFields\" of an array type, provide the values\nas enums, and use collectionFormat.\n" }, { "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\nprevious \"List\" call. For important details about how pagination works, see\n[List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine).\n" } ], "body": { "type": "json", "data": "{}" } }, "docs": "List all associated resources recursively up-to a specified level,\nfor the monitored resources of type specified.\n" }, { "info": { "name": "Returns a list of monitored resource associations.\n", "type": "http" }, "http": { "method": "POST", "url": "http://127.0.0.1/20210330/monitoredResources/actions/searchAssociations", "headers": [ { "name": "opc-request-id", "value": "" }, { "name": "opc-retry-token", "value": "" }, { "name": "if-match", "value": "" } ], "params": [ { "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\nprevious \"List\" call. For important details about how pagination works, see\n[List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine).\n" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Search associations in the given compartment based on the search criteria.\n" }, { "info": { "name": "Summarize the monitored resource counts.", "type": "http" }, "http": { "method": "POST", "url": "http://127.0.0.1/20210330/monitoredResources/actions/summarizeCount", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "compartmentId", "value": "", "type": "query", "description": "The ID of the compartment in which data is listed." }, { "name": "groupBy", "value": "", "type": "query", "description": "The field to group by. Default group by is 'resourceType'.\n" }, { "name": "license", "value": "", "type": "query", "description": "Filter to return resource counts that match with the given licence edition.\n" }, { "name": "resourceType", "value": "", "type": "query", "description": "A filter to return resource counts that match exact resource type." }, { "name": "sortBy", "value": "", "type": "query", "description": "If this query parameter is specified, the result is sorted by this query parameter value.\n" }, { "name": "sortOrder", "value": "", "type": "query", "description": "The sort order to use, either ascending (`ASC`) or descending (`DESC`).\n" }, { "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\nprevious \"List\" call. For important details about how pagination works, see\n[List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine).\n" } ] }, "docs": "Gets resource count based on the aggregation criteria specified using \"groupBy\" parameter.\n" }, { "info": { "name": "Get monitored resource.\n", "type": "http" }, "http": { "method": "GET", "url": "http://127.0.0.1/20210330/monitoredResources/:monitoredResourceId", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "monitoredResourceId", "value": "", "type": "path", "description": "The [OCID](/Content/General/Concepts/identifiers.htm) of monitored resource." } ] }, "docs": "Get monitored resource for the given identifier [OCID](/Content/General/Concepts/identifiers.htm).\n" }, { "info": { "name": "Update monitored resource.\n", "type": "http" }, "http": { "method": "PUT", "url": "http://127.0.0.1/20210330/monitoredResources/:monitoredResourceId", "headers": [ { "name": "if-match", "value": "" }, { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "monitoredResourceId", "value": "", "type": "path", "description": "The [OCID](/Content/General/Concepts/identifiers.htm) of monitored resource." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Update monitored resource by the given identifier [OCID](/Content/General/Concepts/identifiers.htm).\nNote that \"properties\" object, if specified, will entirely replace the existing object, \nas part this operation.\n" }, { "info": { "name": "Delete monitored resource.\n", "type": "http" }, "http": { "method": "DELETE", "url": "http://127.0.0.1/20210330/monitoredResources/:monitoredResourceId", "headers": [ { "name": "if-match", "value": "" }, { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "monitoredResourceId", "value": "", "type": "path", "description": "The [OCID](/Content/General/Concepts/identifiers.htm) of monitored resource." }, { "name": "isDeleteMembers", "value": "", "type": "query", "description": "If this query parameter is specified and set to true, all the member \nresources will be deleted before deleting the specified resource.\n" } ] }, "docs": "Delete monitored resource by the given identifier [OCID](/Content/General/Concepts/identifiers.htm).\nBy default, only the specified resource is deleted. If the parameter 'isDeleteMembers' is set to true, \nthen the member resources will be deleted too. If the operation fails partially, the deleted entries \nwill not be rolled back.\n" }, { "info": { "name": "Moves a resource into a different compartment.", "type": "http" }, "http": { "method": "POST", "url": "http://127.0.0.1/20210330/monitoredResources/:monitoredResourceId/actions/changeCompartment", "headers": [ { "name": "if-match", "value": "" }, { "name": "opc-request-id", "value": "" }, { "name": "opc-retry-token", "value": "" } ], "params": [ { "name": "monitoredResourceId", "value": "", "type": "path", "description": "The [OCID](/Content/General/Concepts/identifiers.htm) of monitored resource." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Moves a monitored resource from one compartment to another. \nWhen provided, If-Match is checked against ETag values of the resource.\n" }, { "info": { "name": "Disable external database resource monitoring.", "type": "http" }, "http": { "method": "POST", "url": "http://127.0.0.1/20210330/monitoredResources/:monitoredResourceId/actions/disableExternalDatabase", "headers": [ { "name": "opc-retry-token", "value": "" }, { "name": "opc-request-id", "value": "" }, { "name": "if-match", "value": "" } ], "params": [ { "name": "monitoredResourceId", "value": "", "type": "path", "description": "The [OCID](/Content/General/Concepts/identifiers.htm) of monitored resource." } ] }, "docs": "Disable external database resource monitoring. All the references in DBaaS, \nDBM and resource service will be deleted as part of this operation.\n" }, { "info": { "name": "List member resources for the monitored resource.\n", "type": "http" }, "http": { "method": "POST", "url": "http://127.0.0.1/20210330/monitoredResources/:monitoredResourceId/actions/listMembers", "headers": [ { "name": "opc-retry-token", "value": "" }, { "name": "opc-request-id", "value": "" }, { "name": "if-match", "value": "" } ], "params": [ { "name": "monitoredResourceId", "value": "", "type": "path", "description": "The [OCID](/Content/General/Concepts/identifiers.htm) of monitored resource." }, { "name": "sortBy", "value": "", "type": "query", "description": "If this query parameter is specified, the result is sorted by this query parameter value.\n" }, { "name": "sortOrder", "value": "", "type": "query", "description": "The sort order to use, either ascending (`ASC`) or descending (`DESC`).\n" }, { "name": "page", "value": "", "type": "query", "description": "For list pagination. The value of the `opc-next-page` response header from the\nprevious \"List\" call. For 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\npaginated \"List\" call. For important details about how pagination works, see\n[List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine).\n" } ], "body": { "type": "json", "data": "{}" } }, "docs": "List the member resources for the given monitored resource identifier [OCID](/Content/General/Concepts/identifiers.htm).\n" }, { "info": { "name": "Manages the license of given resource and all member resources.", "type": "http" }, "http": { "method": "POST", "url": "http://127.0.0.1/20210330/monitoredResources/:monitoredResourceId/actions/manageLicense", "headers": [ { "name": "opc-retry-token", "value": "" }, { "name": "opc-request-id", "value": "" }, { "name": "if-match", "value": "" } ], "params": [ { "name": "monitoredResourceId", "value": "", "type": "path", "description": "The [OCID](/Content/General/Concepts/identifiers.htm) of monitored resource." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Each resource is assigned a license based on which features are enabled for it. \nUser is charged differently based on license. \nSpecify the license type to be updated for the parent resource in the topology. \nThe license type value is propagated to the member resources as well. \nMember resource is a resource which has \"contains\" association with the resource.\n" }, { "info": { "name": "Update and propagate tags to related resources.", "type": "http" }, "http": { "method": "POST", "url": "http://127.0.0.1/20210330/monitoredResources/:monitoredResourceId/actions/updateAndPropagateTags", "headers": [ { "name": "opc-retry-token", "value": "" }, { "name": "opc-request-id", "value": "" }, { "name": "if-match", "value": "" } ], "params": [ { "name": "monitoredResourceId", "value": "", "type": "path", "description": "The [OCID](/Content/General/Concepts/identifiers.htm) of monitored resource." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Provided tags will be added or updated in the existing list of tags for the affected resources.\nResources to be updated are identified based on association types specified. \nIf association types not specified, then tags will be updated only for the resource identified by \nthe given monitored resource identifier [OCID](/Content/General/Concepts/identifiers.htm).\n" }, { "info": { "name": "API to get the details of all Process Sets.", "type": "http" }, "http": { "method": "GET", "url": "http://127.0.0.1/20210330/processSets", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "compartmentId", "value": "", "type": "query", "description": "The ID of the compartment in which data is listed." }, { "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\nprevious \"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`).\n" }, { "name": "sortBy", "value": "", "type": "query", "description": "The field to sort by. Only one sort order may be provided. Default order for timeUpdated is descending. Default order for name is ascending.\n" }, { "name": "displayName", "value": "", "type": "query", "description": "A filter to return only resources that match the entire display name given." } ] }, "docs": "API to get the details of all Process Sets." }, { "info": { "name": "API to create Process Set.", "type": "http" }, "http": { "method": "POST", "url": "http://127.0.0.1/20210330/processSets", "headers": [ { "name": "opc-request-id", "value": "" }, { "name": "opc-retry-token", "value": "" } ], "body": { "type": "json", "data": "{}" } }, "docs": "API to create Process Set." }, { "info": { "name": "API to get the details of a Process Set by identifier.", "type": "http" }, "http": { "method": "GET", "url": "http://127.0.0.1/20210330/processSets/:processSetId", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "processSetId", "value": "", "type": "path", "description": "The Process Set ID" } ] }, "docs": "API to get the details of a Process Set by identifier." }, { "info": { "name": "API to update a Process Set identified by a given ocid.", "type": "http" }, "http": { "method": "PUT", "url": "http://127.0.0.1/20210330/processSets/:processSetId", "headers": [ { "name": "opc-request-id", "value": "" }, { "name": "if-match", "value": "" } ], "params": [ { "name": "processSetId", "value": "", "type": "path", "description": "The Process Set ID" } ], "body": { "type": "json", "data": "{}" } }, "docs": "API to update a Process Set identified by a given ocid." }, { "info": { "name": "Delete a Process Set", "type": "http" }, "http": { "method": "DELETE", "url": "http://127.0.0.1/20210330/processSets/:processSetId", "headers": [ { "name": "if-match", "value": "" }, { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "processSetId", "value": "", "type": "path", "description": "The Process Set ID" } ] }, "docs": "Deletes a Process Set" }, { "info": { "name": "Moves a resource into a different compartment.", "type": "http" }, "http": { "method": "POST", "url": "http://127.0.0.1/20210330/processSets/:processSetId/actions/changeCompartment", "headers": [ { "name": "if-match", "value": "" }, { "name": "opc-request-id", "value": "" }, { "name": "opc-retry-token", "value": "" } ], "params": [ { "name": "processSetId", "value": "", "type": "path", "description": "The Process Set ID" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Moves a ProcessSet resource from one compartment identifier to another. When provided, If-Match is checked against ETag values of the resource.\n" }, { "info": { "name": "List Work Requests", "type": "http" }, "http": { "method": "GET", "url": "http://127.0.0.1/20210330/workRequests", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "compartmentId", "value": "", "type": "query", "description": "The ID of the compartment in which data is listed." }, { "name": "workRequestId", "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": "page", "value": "", "type": "query", "description": "For list pagination. The value of the `opc-next-page` response header from the\nprevious \"List\" call. For 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\npaginated \"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`).\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. If no value is specified timeAccepted is default.\n" } ] }, "docs": "Lists the work requests in a compartment.\n" }, { "info": { "name": "GET Work Request Status", "type": "http" }, "http": { "method": "GET", "url": "http://127.0.0.1/20210330/workRequests/:workRequestId", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "workRequestId", "value": "", "type": "path", "description": "The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the work 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/20210330/workRequests/:workRequestId/errors", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "workRequestId", "value": "", "type": "path", "description": "The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the work request." }, { "name": "page", "value": "", "type": "query", "description": "For list pagination. The value of the `opc-next-page` response header from the\nprevious \"List\" call. For 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\npaginated \"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`).\n" }, { "name": "sortBy", "value": "", "type": "query", "description": "The field to sort by. Only one sort order may be provided. Default order for timestamp is descending. If no value is specified timestamp is default.\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/20210330/workRequests/:workRequestId/logs", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "workRequestId", "value": "", "type": "path", "description": "The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the work request." }, { "name": "page", "value": "", "type": "query", "description": "For list pagination. The value of the `opc-next-page` response header from the\nprevious \"List\" call. For 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\npaginated \"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`).\n" }, { "name": "sortBy", "value": "", "type": "query", "description": "The field to sort by. Only one sort order may be provided. Default order for timestamp is descending. If no value is specified timestamp is default.\n" } ] }, "docs": "Return a (paginated) list of logs for a given work request.\n" } ] } ], "bundled": true }