openapi: 3.2.0
info:
description: Stack Monitoring API.
title: Stack Monitoring API
version: '20210330'
x-provenance:
method: harvested
first_party: true
publisher: Oracle
source: https://docs.oracle.com/en-us/iaas/api/specs/b91bae309bd8ae0adbc1f7bbd5eb88868f0b7f44d15c8ede08fb3b5bd7681955.yaml
harvested: '2026-08-04'
note: Published by Oracle as the contract for the Stack Monitoring API OCI service and stored verbatim; API Evangelist added only this provenance block.
x-evidence:
- url: https://docs.oracle.com/en-us/iaas/api/specs/index.json
what: Oracle's own index of every OCI service specification
- url: https://docs.oracle.com/en-us/iaas/api/specs/b91bae309bd8ae0adbc1f7bbd5eb88868f0b7f44d15c8ede08fb3b5bd7681955.yaml
what: the harvested document for Stack Monitoring API
servers:
- url: http://127.0.0.1/20210330
- url: https://127.0.0.1/20210330
tags:
- name: stackMonitoring
paths:
/baselineableMetrics:
get:
description: List of summary of baseline-able metrics for a given resource group if specified.
operationId: ListBaselineableMetrics
parameters:
- $ref: '#/components/parameters/RequestIdHeader'
- $ref: '#/components/parameters/ResourceGroupOptionalQueryParam'
- $ref: '#/components/parameters/MetricNameOptionalQueryParam'
- $ref: '#/components/parameters/MetricNamespaceQueryParam'
- $ref: '#/components/parameters/PaginationLimitQueryParam'
- $ref: '#/components/parameters/PaginationTokenQueryParam'
- $ref: '#/components/parameters/CompartmentIdOptionalQueryParam'
- $ref: '#/components/parameters/BaselineableMetricIdentifierOptionalQueryParam'
- $ref: '#/components/parameters/SortOrderQueryParam'
- $ref: '#/components/parameters/BaselineMetricSortByQueryParam'
responses:
200:
description: Baseline-able Metric details
headers:
opc-next-page:
description: 'For pagination of a list of items. When paging through a list, if this header appears in the response,
then a partial list might have been returned. Include this value as the `page` parameter for the
subsequent GET request to get the next batch of items.
'
schema:
type: string
opc-request-id:
description: 'Unique Oracle-assigned identifier for the request. If you need to contact
Oracle about a particular request, please provide the request ID.
'
schema:
type: string
retry-after:
description: A decimal number representing the number of seconds the client should wait before polling this endpoint again.
schema:
type: integer
content:
application/json:
schema:
$ref: '#/components/schemas/BaselineableMetricSummaryCollection'
400:
$ref: '#/components/responses/400'
401:
$ref: '#/components/responses/401'
404:
$ref: '#/components/responses/404'
429:
$ref: '#/components/responses/429'
500:
$ref: '#/components/responses/500'
default:
$ref: '#/components/responses/default'
summary: List summary of baseline-able metrics
tags:
- stackMonitoring
x-example: "GET /20210330/baselineableMetrics/\nHost: console.us-phoenix-1.oraclecloud.com \n<authorization and other headers>\n"
x-obmcs-client-retries-enabled: true
x-related-resource: '#/definitions/BaselineableMetric'
post:
description: Creates the specified Baseline-able metric
operationId: CreateBaselineableMetric
parameters:
- $ref: '#/components/parameters/RequestIdHeader'
- $ref: '#/components/parameters/RetryTokenHeader'
responses:
200:
description: Baseline-able Metric
headers:
etag:
description: 'For optimistic concurrency control. See `if-match`.
'
schema:
type: string
opc-request-id:
description: 'Unique Oracle-assigned identifier for the request. If you need to contact
Oracle about a particular request, please provide the request ID.
'
schema:
type: string
retry-after:
description: A decimal number representing the number of seconds the client should wait before polling this endpoint again.
schema:
type: integer
content:
application/json:
schema:
$ref: '#/components/schemas/BaselineableMetric'
400:
$ref: '#/components/responses/400'
401:
$ref: '#/components/responses/401'
404:
$ref: '#/components/responses/404'
409:
$ref: '#/components/responses/409'
412:
$ref: '#/components/responses/412'
429:
$ref: '#/components/responses/429'
500:
$ref: '#/components/responses/500'
default:
$ref: '#/components/responses/default'
summary: Creates Baseline-able metric
tags:
- stackMonitoring
x-example: "POST /20210330/baselineableMetrics/\nHost: console.us-phoenix-1.oraclecloud.com \n<authorization and other headers>\n{\n \"compartmentId\": \"ocid.compartment.oc1.<unique_id>\",\n \"name\": \"CPU\",\n \"column\" :\"CPUUtilization\",\n \"namespace\": \"oracle_appmgmt\",\n \"resourceGroup\": \"oracle_database\"\n}\n"
x-obmcs-client-retries-enabled: true
x-related-resource: '#/definitions/BaselineableMetric'
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/CreateBaselineableMetricDetails'
description: Baseline metric
required: true
/baselineableMetrics/{baselineableMetricId}:
delete:
description: Deletes the Baseline-able metric for the given id
operationId: DeleteBaselineableMetric
parameters:
- $ref: '#/components/parameters/RequestIdHeader'
- $ref: '#/components/parameters/BaselineableMetricIdentifierPathParam'
- $ref: '#/components/parameters/IfMatchHeader'
responses:
204:
description: Baseline-able Metric
headers:
opc-request-id:
description: 'Unique Oracle-assigned identifier for the request. If you need to contact
Oracle about a particular request, please provide the request ID.
'
schema:
type: string
retry-after:
description: A decimal number representing the number of seconds the client should wait before polling this endpoint again.
schema:
type: integer
400:
$ref: '#/components/responses/400'
401:
$ref: '#/components/responses/401'
404:
$ref: '#/components/responses/404'
412:
$ref: '#/components/responses/412'
429:
$ref: '#/components/responses/429'
500:
$ref: '#/components/responses/500'
default:
$ref: '#/components/responses/default'
summary: Deletes Baseline-able metric
tags:
- stackMonitoring
x-example: 'DELETE /20210330/baselineableMetrics/<baslineableMetric_OCID>
Host: console.us-phoenix-1.oraclecloud.com
<authorization and other headers>
'
x-obmcs-client-retries-enabled: true
x-related-resource: '#/definitions/BaselineableMetric'
get:
description: Get the Baseline-able metric for the given id
operationId: GetBaselineableMetric
parameters:
- $ref: '#/components/parameters/RequestIdHeader'
- $ref: '#/components/parameters/BaselineableMetricIdentifierPathParam'
responses:
200:
description: Baseline-able Metric
headers:
etag:
description: 'For optimistic concurrency control. See `if-match`.
'
schema:
type: string
opc-request-id:
description: 'Unique Oracle-assigned identifier for the request. If you need to contact
Oracle about a particular request, please provide the request ID.
'
schema:
type: string
retry-after:
description: A decimal number representing the number of seconds the client should wait before polling this endpoint again.
schema:
type: integer
content:
application/json:
schema:
$ref: '#/components/schemas/BaselineableMetric'
400:
$ref: '#/components/responses/400'
401:
$ref: '#/components/responses/401'
404:
$ref: '#/components/responses/404'
429:
$ref: '#/components/responses/429'
500:
$ref: '#/components/responses/500'
default:
$ref: '#/components/responses/default'
summary: Get Baseline-able metric
tags:
- stackMonitoring
x-example: 'GET /20210330/baselineableMetrics/<baslineableMetric_OCID>
Host: console.us-phoenix-1.oraclecloud.com
<authorization and other headers>
'
x-obmcs-client-retries-enabled: true
x-related-resource: '#/definitions/BaselineableMetric'
put:
description: Updates the Baseline-able metric for the given id
operationId: UpdateBaselineableMetric
parameters:
- $ref: '#/components/parameters/IfMatchHeader'
- $ref: '#/components/parameters/RequestIdHeader'
- $ref: '#/components/parameters/BaselineableMetricIdentifierPathParam'
responses:
200:
description: Baseline-able Metric
headers:
etag:
description: 'For optimistic concurrency control. See `if-match`.
'
schema:
type: string
opc-request-id:
description: 'Unique Oracle-assigned identifier for the request. If you need to contact
Oracle about a particular request, please provide the request ID.
'
schema:
type: string
retry-after:
description: A decimal number representing the number of seconds the client should wait before polling this endpoint again.
schema:
type: integer
content:
application/json:
schema:
$ref: '#/components/schemas/BaselineableMetric'
400:
$ref: '#/components/responses/400'
401:
$ref: '#/components/responses/401'
404:
$ref: '#/components/responses/404'
412:
$ref: '#/components/responses/412'
429:
$ref: '#/components/responses/429'
500:
$ref: '#/components/responses/500'
default:
$ref: '#/components/responses/default'
summary: Updates Baseline-able metric
tags:
- stackMonitoring
x-example: "PUT /20210330/baselineableMetrics/<baslineableMetric_OCID>\nHost: console.us-phoenix-1.oraclecloud.com\n<authorization and other headers>\n{\n \"compartmentId\": \"ocid.compartment.oc1.<unique_id>\",\n \"name\": \"CPU\",\n \"column\" :\"CPUUtilization\",\n \"namespace\": \"oracle_appmgmt\",\n \"resourceGroup\": \"oracle_database\",\n}\n"
x-obmcs-client-retries-enabled: true
x-related-resource: '#/definitions/BaselineableMetric'
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/UpdateBaselineableMetricDetails'
description: Baseline metric
required: true
/baselineableMetrics/{baselineableMetricId}/actions/evaluate:
post:
description: Evaluates metric for anomalies for the given data points
operationId: EvaluateBaselineableMetric
parameters:
- $ref: '#/components/parameters/RequestIdHeader'
- $ref: '#/components/parameters/BaselineableMetricIdentifierPathParam'
- $ref: '#/components/parameters/IfMatchHeader'
- $ref: '#/components/parameters/RetryTokenHeader'
responses:
200:
description: Evaluation results for the metric data
headers:
etag:
description: 'For optimistic concurrency control. See `if-match`.
'
schema:
type: string
opc-request-id:
description: 'Unique Oracle-assigned identifier for the request. If you need to contact
Oracle about a particular request, please provide the request ID.
'
schema:
type: string
content:
application/json:
schema:
$ref: '#/components/schemas/EvaluateBaselineableMetricResult'
400:
$ref: '#/components/responses/400'
401:
$ref: '#/components/responses/401'
403:
$ref: '#/components/responses/403'
404:
$ref: '#/components/responses/404'
409:
$ref: '#/components/responses/404'
412:
$ref: '#/components/responses/412'
429:
$ref: '#/components/responses/429'
500:
$ref: '#/components/responses/500'
default:
$ref: '#/components/responses/default'
summary: Evaluate metric for anomalies
tags:
- stackMonitoring
x-example: "DELETE /20210330/baselineableMetrics/<baslineableMetric_OCID>/actions/evalaute\nHost: console.us-phoenix-1.oraclecloud.com\n<authorization and other headers>\n{\n resourceId: \"ocid.resource.oc1.<unique_id>\",\n items: [\n {\n dimensions: [\n \"tablespaceName\": \"FINANCE\",\n \"hostName\", \"abc.xyc\"\n ],\n trainingDataPoints: [\n {\n \"timestamp\": \"2023-05-15 05:13:00Z\",\n \"value\": 2.5\n },\n {\n \"timestamp\": \"2023-05-15 05:14:00Z\",\n \"value\": 2.5\n }\n ]\n },\n {\n dimensions: [\n \"tablespaceName\": \"HR\",\n \"hostName\", \"abc.xyc\"\n ],\n trainingDataPoints: [\n {\n \"timestamp\": \"2023-05-15 05:13:00Z\",\n \"value\": 3.5\n },\n {\n \"timestamp\": \"2023-05-15 05:14:00Z\",\n \"value\": 3.5\n }\n ]\n }\n ]\n}\n"
x-obmcs-client-retries-enabled: true
x-related-resource: '#/definitions/BaselineableMetric'
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/EvaluateBaselineableMetricDetails'
description: Metric details
required: true
/configs:
get:
description: 'Get a list of configurations in a compartment.
'
operationId: ListConfigs
parameters:
- $ref: '#/components/parameters/CompartmentIdQueryParam'
- $ref: '#/components/parameters/ConfigDisplayNameQueryParam'
- $ref: '#/components/parameters/ConfigTypeQueryParam'
- $ref: '#/components/parameters/PaginationLimitQueryParam'
- $ref: '#/components/parameters/PaginationTokenQueryParam'
- $ref: '#/components/parameters/ConfigLifecycleStateQueryParam'
- $ref: '#/components/parameters/SortOrderQueryParam'
- $ref: '#/components/parameters/ConfigSortByQueryParam'
- $ref: '#/components/parameters/RequestIdHeader'
responses:
200:
description: A page of ConfigSummary objects.
headers:
opc-next-page:
description: 'For pagination of a list of items. When paging through a list, if this header appears in the response,
then a partial list might have been returned. Include this value as the `page` parameter for the
subsequent GET request to get the next batch of items.
'
schema:
type: string
opc-request-id:
description: 'Unique Oracle-assigned identifier for the request. If you need to contact
Oracle about a particular request, please provide the request ID.
'
schema:
type: string
content:
application/json:
schema:
$ref: '#/components/schemas/ConfigCollection'
400:
$ref: '#/components/responses/400'
401:
$ref: '#/components/responses/401'
404:
$ref: '#/components/responses/404'
429:
$ref: '#/components/responses/429'
500:
$ref: '#/components/responses/500'
default:
$ref: '#/components/responses/default'
summary: Gets a list of configurations.
tags:
- stackMonitoring
x-example: 'GET /20210330/configs?compartmentId=<compartment_OCID>&limit=10&sortBy=timeCreated
Host: console.us-phoenix-1.oraclecloud.com
<authorization and other headers>
'
x-obmcs-client-retries-enabled: true
post:
description: "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"
operationId: CreateConfig
parameters:
- $ref: '#/components/parameters/RetryTokenHeader'
- $ref: '#/components/parameters/RequestIdHeader'
responses:
200:
description: The configuration was successfully created.
headers:
etag:
description: 'For optimistic concurrency control. See `if-match`.
'
schema:
type: string
opc-request-id:
description: 'Unique Oracle-assigned identifier for the request. If you need to contact
Oracle about a particular request, please provide the request ID.
'
schema:
type: string
content:
application/json:
schema:
$ref: '#/components/schemas/Config'
400:
$ref: '#/components/responses/400'
401:
$ref: '#/components/responses/401'
404:
$ref: '#/components/responses/404'
409:
$ref: '#/components/responses/409'
429:
$ref: '#/components/responses/429'
500:
$ref: '#/components/responses/500'
default:
$ref: '#/components/responses/default'
summary: Create a configuration.
tags:
- stackMonitoring
x-example: "POST /20210330/configs\nHost: console.us-phoenix-1.oraclecloud.com\n<authorization and other headers>\n{\n \"compartmentId\": \"<compartment_OCID>\",\n \"configType\": \"AUTO_PROMOTE\",\n \"resourceType\": \"HOST\",\n \"isEnabled\": true\n}\n"
x-obmcs-client-retries-enabled: true
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/CreateConfigDetails'
description: Details for the new configuration.
required: true
/configs/{configId}:
delete:
description: Deletes a configuration identified by the id.
operationId: DeleteConfig
parameters:
- $ref: '#/components/parameters/ConfigIdentifierPathParam'
- $ref: '#/components/parameters/IfMatchHeader'
- $ref: '#/components/parameters/RequestIdHeader'
responses:
204:
description: The configuration was successfully deleted.
headers:
opc-request-id:
description: 'Unique Oracle-assigned identifier for the request. If you need to contact
Oracle about a particular request, please provide the request ID.
'
schema:
type: string
400:
$ref: '#/components/responses/400'
401:
$ref: '#/components/responses/401'
404:
$ref: '#/components/responses/404'
412:
$ref: '#/components/responses/412'
429:
$ref: '#/components/responses/429'
500:
$ref: '#/components/responses/500'
default:
$ref: '#/components/responses/default'
summary: Delete a configuration.
tags:
- stackMonitoring
x-example: 'DELETE /20210330/configs/<config_OCID>
Host: console.us-phoenix-1.oraclecloud.com
<authorization and other headers>
'
x-obmcs-client-retries-enabled: true
x-related-resource: '#/definitions/Config'
get:
description: Gets the details of a configuration.
operationId: GetConfig
parameters:
- $ref: '#/components/parameters/ConfigIdentifierPathParam'
- $ref: '#/components/parameters/RequestIdHeader'
responses:
200:
description: Retrieves the Configuration with the given id.
headers:
etag:
description: 'For optimistic concurrency control. See `if-match`.
'
schema:
type: string
opc-request-id:
description: 'Unique Oracle-assigned identifier for the request. If you need to contact
Oracle about a particular request, please provide the request ID.
'
schema:
type: string
content:
application/json:
schema:
$ref: '#/components/schemas/Config'
400:
$ref: '#/components/responses/400'
401:
$ref: '#/components/responses/401'
404:
$ref: '#/components/responses/404'
429:
$ref: '#/components/responses/429'
500:
$ref: '#/components/responses/500'
default:
$ref: '#/components/responses/default'
summary: Get configuration.
tags:
- stackMonitoring
x-example: 'GET /20210330/configs/<config_OCID>
Host: console.us-phoenix-1.oraclecloud.com
<authorization and other headers>
'
x-obmcs-client-retries-enabled: true
put:
description: Updates the configuration identified by the id given.
operationId: UpdateConfig
parameters:
- $ref: '#/components/parameters/ConfigIdentifierPathParam'
- $ref: '#/components/parameters/IfMatchHeader'
- $ref: '#/components/parameters/RequestIdHeader'
responses:
200:
description: The configuration was successfully updated.
headers:
etag:
description: 'For optimistic concurrency control. See `if-match`.
'
schema:
type: string
opc-request-id:
description: 'Unique Oracle-assigned identifier for the request. If you need to contact
Oracle about a particular request, please provide the request ID.
'
schema:
type: string
content:
application/json:
schema:
$ref: '#/components/schemas/Config'
400:
$ref: '#/components/responses/400'
401:
$ref: '#/components/responses/401'
404:
$ref: '#/components/responses/404'
412:
$ref: '#/components/responses/412'
429:
$ref: '#/components/responses/429'
500:
$ref: '#/components/responses/500'
default:
$ref: '#/components/responses/default'
summary: Update a configuration.
tags:
- stackMonitoring
x-example: "PUT /20210330/configs/<config_OCID>\nHost: console.us-phoenix-1.oraclecloud.com\n<authorization and other headers>\n{\n \"compartmentId\": \"<compartment_OCID>\",\n \"configType\": \"AUTO_PROMOTE\",\n \"isEnabled\": true\n}\n"
x-obmcs-client-retries-enabled: true
x-related-resource: '#/definitions/Config'
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/UpdateConfigDetails'
description: The details of the configuration to be updated.
required: true
/configs/{configId}/actions/changeCompartment:
post:
description: "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 old compartment and\nrecreating it in another compartment. \n\nWhen provided, If-Match is checked against ETag values of the resource.\n"
operationId: ChangeConfigCompartment
parameters:
- $ref: '#/components/parameters/IfMatchHeader'
- $ref: '#/components/parameters/RequestIdHeader'
- $ref: '#/components/parameters/RetryTokenHeader'
- $ref: '#/components/parameters/ConfigIdentifierPathParam'
responses:
204:
description: The configuration has been moved to the provided compartment.
headers:
opc-request-id:
description: 'Unique Oracle-assigned identifier for the request. If you need to contact
Oracle about a particular request, please provide the request ID.
'
schema:
type: string
400:
$ref: '#/components/responses/400'
401:
$ref: '#/components/responses/401'
404:
$ref: '#/components/responses/404'
409:
$ref: '#/components/responses/409'
412:
$ref: '#/components/responses/412'
429:
$ref: '#/components/responses/429'
500:
$ref: '#/components/responses/500'
summary: Move a configuration to another compartment.
tags:
- stackMonitoring
x-example: "POST /20210330/configs/<configId>/actions/changeCompartment\nHost: demohost.example.com \n<authorization and other headers>\n{\n \"compartmentId\": \"<target_compartment_OCID>\",\n}\n"
x-obmcs-client-retries-enabled: true
x-related-resource: '#/definitions/Config'
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/ChangeConfigCompartmentDetails'
description: Details for the compartment move.
required: true
/discoveryJobs:
get:
description: 'API to get the details of all Discovery Jobs.
'
operationId: ListDiscoveryJobs
parameters:
- $ref: '#/components/parameters/CompartmentIdQueryParam'
- $ref: '#/components/parameters/ResourceNameQueryParam'
- $ref: '#/components/parameters/PaginationLimitQueryParam'
- $ref: '#/components/parameters/PaginationTokenQueryParam'
- $ref: '#/components/parameters/SortOrderQueryParam'
- $ref: '#/components/parameters/DiscoveryJobSortByQueryParam'
- $ref: '#/components/parameters/RequestIdHeader'
responses:
200:
description: A collection of the Discovery Job details.
headers:
opc-next-page:
description: 'For pagination of a list of items. When paging through a list, if this header appears in the response,
then a partial list might have been returned. Include this value as the `page` parameter for the
subsequent GET request to get the next batch of items.
'
schema:
type: string
opc-request-id:
description: 'Unique Oracle-assigned identifier for the request. If you need to contact
Oracle about a particular request, please provide the request ID.
'
schema:
type: string
content:
application/json:
schema:
$ref: '#/components/schemas/DiscoveryJobCollection'
400:
$ref: '#/components/responses/400'
401:
$ref: '#/components/responses/401'
404:
$ref: '#/components/responses/404'
429:
$ref: '#/components/responses/429'
500:
$ref: '#/components/responses/500'
default:
$ref: '#/components/responses/default'
summary: API to get the details of all Discovery Jobs.
tags:
- stackMonitoring
x-example: 'GET /20210330/discoveryJobs?compartmentId=<compartment_OCID>&limit=10&sortBy=timeCreated Host: console.us-phoenix-1.oraclecloud.com <authorization and other headers>
'
x-obmcs-client-retries-enabled: true
x-related-resource: '#/definitions/DiscoveryJobCollection'
post:
description: 'API to create discovery Job and submit discovery Details to agent.
'
operationId: CreateDiscoveryJob
parameters:
- $ref: '#/components/parameters/RequestIdHeader'
- $ref: '#/components/parameters/RetryTokenHeader'
responses:
200:
description: The discovery Job is sucessfully created.
headers:
etag:
description: 'For optimistic concurrency control. See `if-match`.
'
schema:
type: string
opc-request-id:
description: 'Unique Oracle-assigned identifier for the request. If you need to contact
Oracle about a particular request, please provide the request ID.
'
schema:
type: string
content:
application/json:
schema:
$ref: '#/components/schemas/DiscoveryJob'
400:
$ref: '#/components/responses/400'
401:
$ref: '#/components/responses/401'
404:
$ref: '#/components/responses/404'
409:
$ref: '#/components/responses/409'
429:
$ref: '#/components/responses/429'
500:
$ref: '#/components/responses/500'
default:
$ref: '#/components/responses/default'
summary: API to create discovery Job and submit discovery Details to agent.
tags:
- stackMonitoring
x-example: "POST /20210330/discoveryJobs\nHost: console.us-phoenix-1.oraclecloud.com\nconnection: keep-alive\naccept-encoding: gzip, deflate\naccept: */*\nuser-agent: Mozilla/5.0 (Macintosh; Intel Mac OS X 10_14_6) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/92.0.4515.159 Safari/537.36\ndate: Mon, 23 Aug 2021 21:57:48 GMT\nauthorization: <authorization and other headers>\n{\n \"discoveryType\": \"ADD\", \"discoveryClient\": \"appmgmt\",\n \"compartmentId\": \"ocid1.compartment.oc1..<unique_id>\",\n \"discoveryDetails\": {\n \"resourceName\": \"ebs\",\n \"resourceType\": \"EBS_INSTANCE\",\n \"agentId\": \"ocid1.managementagent..<unique_id>\",\n \"properties\": {\"map\": {\"ebs_version\": \"12.2\", \"ebs_admin_server_host\": \"somehostname.oracle.com\", \"ebs_admin_server_port\": \"7001\",???}},\n \"credentials\": {\"items\": [{\"credentialName\": \"Test==\", \"credentialType\": \"Test==\",\"properties\": {\"map\": {\"DBUserName\": \"Test==\",\"DBPassword\": \"Test==\",\"DBRole\":\"Tk9STUFM\"}}}]}\n }\n}\n"
x-obmcs-client-retries-enabled: false
x-related-resource: '#/definitions/DiscoveryJob'
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/CreateDiscoveryJobDetails'
description: Summary of source and credential discovery details.
required: true
/discoveryJobs/{discoveryJobId}:
delete:
description: Deletes a DiscoveryJob by identifier
operationId: DeleteDiscoveryJob
parameters:
- $ref: '#/components/parameters/JobRequestIdPathParam'
- $ref: '#/components/parameters/IfMatchHeader'
- $ref: '#/components/parameters/RequestIdHeader'
responses:
204:
description: The Discovery Job is successfully deleted.
headers:
opc-request-id:
description: 'Unique Oracle-assigned identifier for the request. If you need to contact
Oracle about a particular request, please provide the request ID.
'
schema:
type: string
400:
$ref: '#/components/responses/400'
401:
$ref: '#/components/responses/401'
404:
$ref: '#/components/responses/404'
412:
$ref: '#/components/responses/412'
429:
$ref: '#/components/responses/429'
500:
$ref: '#/components/responses/500'
default:
$ref: '#/components/responses/default'
summary: Delete a Discovery Job
tags:
- stackMonitoring
x-example: 'DELETE /20210330/discoveryJobs/<discoveryJob_OCID> Host: console.us-phoenix-1.oraclecloud.com <authorization and other headers>
'
x-obmcs-client-retries-enabled: true
x-related-resource: '#/definitions/DiscoveryJob'
get:
description: 'API to get the details of discovery Job by identifier.
'
operationId: GetDiscoveryJob
parameters:
- $ref: '#/components/parameters/RequestIdHeader'
- $ref: '#/components/parameters/JobRequestIdPathParam'
responses:
200:
description: Retrieves the dicovery job details with the given job id.
headers:
etag:
description: 'For optimistic concurrency control. See `if-match`.
'
schema:
type: string
opc-request-id:
description: 'Unique Oracle-assigned identifier for the request. If you need to contact
Oracle about a particular request, please provide the request ID.
'
schema:
type: string
content:
application/json:
schema:
$ref: '#/components/schemas/DiscoveryJob'
400:
$ref: '#/components/responses/400'
401:
$ref: '#/components/responses/401'
404:
$ref: '#/components/responses/404'
429:
$ref: '#/components/responses/429'
500:
$ref: '#/components/responses/500'
default:
$ref: '#/components/responses/default'
summary: API to get the details of Discovery Job by identifier.
tags:
- stackMonitoring
x-example: 'GET /20210330/discoveryJobs/<discoveryJob_OCID> Host: console.us-phoenix-1.oraclecloud.com <authorization and other headers>
'
x-obmcs-client-retries-enabled: true
x-related-resource: '#/definitions/DiscoveryJob'
/discoveryJobs/{discoveryJobId}/logs:
get:
description: 'API to get all the logs of a Discovery Job.
'
operationId: ListDiscoveryJobLogs
parameters:
- $ref: '#/components/parameters/JobRequestIdPathParam'
- $ref: '#/components/parameters/LogTypeQueryParam'
- $ref: '#/components/parameters/PaginationLimitQueryParam'
- $ref: '#/components/parameters/PaginationTokenQueryParam'
- $ref: '#/components/parameters/SortOrderQueryParam'
- $ref: '#/components/parameters/DiscoveryJobLogSortByQueryParam'
- $ref: '#/components/parameters/RequestIdHeader'
responses:
200:
description: A collection of Discovery Job logs for a particular Discovery Job Id.
headers:
opc-next-page:
description: 'For pagination of a list of items. When paging through a list, if this header appears in the response,
then a partial list might have been returned. Include this value as the `page` parameter for the
subsequent GET request to get the next batch of items.
'
schema:
type: string
opc-request-id:
description: 'Unique Oracle-assigned identifier for the request. If you need to contact
Oracle about a particular request, please provide the request ID.
'
schema:
type: string
content:
application/json:
schema:
$ref: '#/components/schemas/DiscoveryJobLogCollection'
400:
$ref: '#/components/responses/400'
401:
$ref: '#/components/responses/401'
404:
$ref: '#/components/responses/404'
429:
$ref: '#/components/responses/429'
500:
$ref: '#/components/responses/500'
default:
$ref: '#/components/responses/default'
summary: API to get all the logs of a Discovery Job.
tags:
- stackMonitoring
x-example: 'GET /20210330/discoveryJobs/<discoveryJob_OCID>/logs Host: console.us-phoenix-1.oraclecloud.com <authorization and other headers>
'
x-obmcs-client-retries-enabled: true
x-related-resource: '#/definitions/DiscoveryJobLogCollection'
/metricExtensions:
get:
description: Returns a list of metric extensions
operationId: ListMetricExtensions
parameters:
- $ref: '#/components/parameters/PaginationLimitQueryParam'
- $ref: '#/components/parameters/PaginationTokenQueryParam'
- $ref: '#/components/parameters/MetricExtensionSortByQueryParam'
- $ref: '#/components/parameters/SortOrderQueryParam'
- $ref: '#/components/parameters/CompartmentIdQueryParam'
- $ref: '#/components/parameters/MetricExtensionResourceTypeQueryParam'
- $ref: '#/components/parameters/MetricExtensionNameParam'
- $ref: '#/components/parameters/StatusQueryParam'
- $ref: '#/components/parameters/LifecycleStateQueryParam'
- $ref: '#/components/parameters/EnabledOnResourceIdQueryParam'
- $ref: '#/components/parameters/RequestIdHeader'
responses:
200:
description: A page of Metric Extension resources
headers:
opc-next-page:
description: 'For pagination of a list of items. When paging through a list, if this header appears in the response,
then a partial list might have been returned. Include this value as the `page` parameter for the
subsequent GET request to get the next batch of items.
'
schema:
type: string
opc-request-id:
description: 'Unique Oracle-assigned identifier for the request. If you need to contact
Oracle about a particular request, please provide the request ID.
'
schema:
type: string
content:
application/json:
schema:
$ref: '#/components/schemas/MetricExtensionCollection'
400:
$ref: '#/components/responses/400'
401:
$ref: '#/components/responses/401'
404:
$ref: '#/components/responses/404'
429:
$ref: '#/components/responses/429'
500:
$ref: '#/components/responses/500'
default:
$ref: '#/components/responses/default'
summary: Gets a list of all metric extensions in a compartment
tags:
- stackMonitoring
x-example: "GET /20210330/metricExtensions?compartmentId=<compartment_OCID>&resourceType=<resource_type_name>\nHost: console.us-phoenix-1.oraclecloud.com \n<authorization and other headers>\n"
x-obmcs-client-retries-enabled: true
x-related-resource: '#/definitions/MetricExtension'
post:
description: 'Creates a new metric extension resource for a given compartment
'
operationId: CreateMetricExtension
parameters:
- $ref: '#/components/parameters/RetryTokenHeader'
- $ref: '#/components/parameters/RequestIdHeader'
responses:
200:
description: The Metric Extension resource is created successfully
headers:
content-location:
description: Content location of the resource.
schema:
type: string
etag:
description: 'For optimistic concurrency control. See `if-match`.
'
schema:
type: string
opc-request-id:
description: 'Unique Oracle-assigned identifier for the request. If you need to contact
Oracle about a particular request, please provide the request ID.
'
schema:
type: string
content:
application/json:
schema:
$ref: '#/components/schemas/MetricExtension'
400:
$ref: '#/components/responses/400'
401:
$ref: '#/components/responses/401'
404:
$ref: '#/components/responses/404'
409:
$ref: '#/components/responses/409'
429:
$ref: '#/components/responses/429'
500:
$ref: '#/components/responses/500'
default:
$ref: '#/components/responses/default'
summary: Create a new metric extension resource
tags:
- stackMonitoring
x-example: "Example 1: Create Metric Extension details having SQL Collection Method. \n\nPOST /20210330/metricExtensions\nHost: console.us-phoenix-1.oraclecloud.com\nauthorization: <authorization and other headers>\n{\n \"name\": \"ME_CountOfRunningInstances\",\n \"displayName\": \"Count of Running Instances\",\n \"resourceType\": \"ebs_instance\",\n \"compartmentId\": \"ocid1.compartment.oc1..<unique_id>\",\n \"description\": \"Collects count of instances in 'UP' status in staging compartments from monitoring table\",\n \"collectionRecurrences\": \"FREQ=MINUTELY;INTERVAL=10\",\n \"metricList\": [\n {\n \"name\": \"NumberOfUpInstances\",\n \"displayName\": \"NumberOfUpInstances\",\n \"isDimension\": false,\n \"computeExpression\": null,\n \"dataType\": \"NUMBER\",\n \"isHidden\": false,\n \"metricCategory\": \"AVAILABILITY\",\n \"unit\": null\n }\n ],\n \"queryProperties\": {\n \"collectionMethod\": \"SQL\",\n \"sqlType\": \"STATEMENT\",\n \"sqlDetails\": {\n \"content\": \"<SQL statement as base64 encoded string>\"\n },\n \"inParamDetails\": [\n {\n \"inParamPosition\": 1,\n \"inParamValue\": \"staging\"\n }\n ],\n \"outParamDetails\": null\n }\n}\n\nNote#1: SQL statement or script content needs to be passed as base64 encoded string in \"content\" sub-property of sqlDetails property.\nFor example, \nif SQL statement is\n \"SELECT count(instance_id) FROM monitoring_table WHERE status = 'UP' AND compartment_type = :1\"\nthen below base 64 encoded string of the same SQL statement has to be passed in \"content\" sub-property\n \"U0VMRUNUIGNvdW50KGluc3RhbmNlX2lkKSBGUk9NIG1vbml0b3JpbmdfdGFibGUgV0hFUkUgc3RhdHVzID0gJ1VQJyBBTkQgY29tcGFydG1lbnRfdHlwZSA9IDox\"\n\n\nNote#2: Optional properties/sub-properties can be skipped or sent as null\n\nExample 2: Create Metric Extension details having OS_COMMAND Collection Method. \n\n{\n \"name\": \"ME_OsFileSystemUtilization\",\n \"displayName\": \"OS File System Utilization\",\n \"resourceType\": \"host_linux\",\n \"compartmentId\": \"ocid1.compartment.oc1..<unique_id>\",\n \"description\": \"Computes File System Utilization Percentage of various mount points\",\n \"collectionRecurrences\": \"FREQ=DAILY;INTERVAL=1\",\n \"metricList\": [\n {\n \"name\": \"MountPoint\",\n \"displayName\": null,\n \"isDimension\": true,\n \"computeExpression\": null,\n \"dataType\": \"STRING\",\n \"isHidden\": false,\n \"metricCategory\": null,\n \"unit\": null\n },\n {\n \"name\": \"FileSystemSize\",\n \"displayName\": null,\n \"isDimension\": false,\n \"computeExpression\": null,\n \"dataType\": \"NUMBER\",\n \"isHidden\": true,\n \"metricCategory\": null,\n \"unit\": null\n },\n {\n \"name\": \"FileSystemUsed\",\n \"displayName\": null,\n \"isDimension\": false,\n \"computeExpression\": null,\n \"dataType\": \"NUMBER\",\n \"isHidden\": true,\n \"metricCategory\": null,\n \"unit\": null\n },\n {\n \"name\": \"FileSystemUsage\",\n \"displayName\": null,\n \"isDimension\": false,\n \"computeExpression\": \"(FileSystemUsed / FileSystemSize) *100\",\n \"dataType\": \"NUMBER\",\n \"isHidden\": false,\n \"metricCategory\": \"UTILIZATION\",\n \"unit\": \"percent\"\n }\n ],\n \"queryProperties\": {\n \"collectionMethod\": \"OS_COMMAND\",\n \"command\": \"/bin/bash\",\n \"delimiter\": \"|\",\n \"scriptDetails\": {\n \"name\": \"fileSystem.sh\",\n \"content\": \"<Script file content as base64 encoded string>\"\n },\n \"arguments\": null,\n \"startsWith\": \"oci_result=\"\n }\n}\n\nExample 3: Create Metric Extension details having JMX Collection Method. \n\n{\n \"name\": \"ME_TotalPhysicalMemoryInGB\",\n \"displayName\": \"Total Physical Memory In GigaBytes\",\n \"resourceType\": \"weblogic_j2eeserver\",\n \"compartmentId\": \"ocid1.compartment.oc1..<unique_id>\",\n \"description\": \"Collects TotalPhysicalMemoryInGB for server named PIA in GBs\",\n \"collectionRecurrences\": \"FREQ=HOURLY;INTERVAL=1\",\n \"metricList\": [\n {\n \"name\": \"TotalPhysicalMemorySize\",\n \"isDimension\": false,\n \"isHidden\": true,\n \"dataType\": \"NUMBER\"\n },\n {\n \"name\": \"TotalPhysicalMemorySizeGB\",\n \"displayName\": \"TotalPhysicalMemorySizeInGB\",\n \"isDimension\": false,\n \"isHidden\": false,\n \"dataType\": \"NUMBER\",\n \"computeExpression\": \"TotalPhysicalMemorySize > 0 ? (TotalPhysicalMemorySize/(1024*1024*1024)) : 0\",\n \"metricCategory\": \"UTILIZATION\"\n }\n ],\n \"queryProperties\": {\n \"collectionMethod\": \"JMX\",\n \"managedBeanQuery\": \"java.lang:type=OperatingSystem,Location=PIA\",\n \"jmxAttributes\": \"TotalPhysicalMemorySize\",\n \"identityMetric\": null,\n \"autoRowPrefix\": null,\n \"isMetricServiceEnabled\": false\n }\n}\n"
x-obmcs-client-retries-enabled: false
x-related-resource: '#/definitions/MetricExtension'
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/CreateMetricExtensionDetails'
description: Details required for creating new Metric Extension
required: true
/metricExtensions/{metricExtensionId}:
delete:
description: Deletes a metric extension by identifier
operationId: DeleteMetricExtension
parameters:
- $ref: '#/components/parameters/MetricExtensionIdentifierPathParam'
- $ref: '#/components/parameters/IfMatchHeader'
- $ref: '#/components/parameters/RequestIdHeader'
responses:
204:
description: The Metric Extension resource is deleted successfully
headers:
opc-request-id:
description: 'Unique Oracle-assigned identifier for the request. If you need to contact
Oracle about a particular request, please provide the request ID.
'
schema:
type: string
400:
$ref: '#/components/responses/400'
401:
$ref: '#/components/responses/401'
404:
$ref: '#/components/responses/404'
409:
$ref: '#/components/responses/409'
412:
$ref: '#/components/responses/412'
429:
$ref: '#/components/responses/429'
500:
$ref: '#/components/responses/500'
default:
$ref: '#/components/responses/default'
summary: Delete the metric extension resource
tags:
- stackMonitoring
x-example: 'DELETE /20210330/metricExtensions/<metricExtension_OCID>
Host: console.us-phoenix-1.oraclecloud.com
<authorization and other headers>
'
x-obmcs-client-retries-enabled: false
x-related-resource: '#/definitions/MetricExtension'
get:
description: Gets a Metric Extension by identifier
operationId: GetMetricExtension
parameters:
- $ref: '#/components/parameters/MetricExtensionIdentifierPathParam'
- $ref: '#/components/parameters/RequestIdHeader'
responses:
200:
description: Retrieves the Metric Extension resource with the given id
headers:
etag:
description: 'For optimistic concurrency control. See `if-match`.
'
schema:
type: string
opc-request-id:
description: 'Unique Oracle-assigned identifier for the request. If you need to contact
Oracle about a particular request, please provide the request ID.
'
schema:
type: string
content:
application/json:
schema:
$ref: '#/components/schemas/MetricExtension'
400:
$ref: '#/components/responses/400'
401:
$ref: '#/components/responses/401'
404:
$ref: '#/components/responses/404'
429:
$ref: '#/components/responses/429'
500:
$ref: '#/components/responses/500'
default:
$ref: '#/components/responses/default'
summary: Get Metric Extension
tags:
- stackMonitoring
x-example: 'GET /20210330/metricExtensions/<metricExtension_OCID>
Host: console.us-phoenix-1.oraclecloud.com
<authorization and other headers>
'
x-obmcs-client-retries-enabled: true
x-related-resource: '#/definitions/MetricExtension'
put:
description: Updates the Metric Extension
operationId: UpdateMetricExtension
parameters:
- $ref: '#/components/parameters/MetricExtensionIdentifierPathParam'
- $ref: '#/components/parameters/IfMatchHeader'
- $ref: '#/components/parameters/RequestIdHeader'
responses:
200:
description: The Metric Extension resource is successfully updated
headers:
content-location:
description: Content location of the resource.
schema:
type: string
etag:
description: 'For optimistic concurrency control. See `if-match`.
'
schema:
type: string
opc-request-id:
description: 'Unique Oracle-assigned identifier for the request. If you need to contact
Oracle about a particular request, please provide the request ID.
'
schema:
type: string
content:
application/json:
schema:
$ref: '#/components/schemas/MetricExtension'
400:
$ref: '#/components/responses/400'
401:
$ref: '#/components/responses/401'
404:
$ref: '#/components/responses/404'
409:
$ref: '#/components/responses/409'
412:
$ref: '#/components/responses/412'
429:
$ref: '#/components/responses/429'
500:
$ref: '#/components/responses/500'
default:
$ref: '#/components/responses/default'
summary: Update the Metric Extension identified by the id
tags:
- stackMonitoring
x-example: "PUT /20210330/metricExtensions/<metricExtensions_OCID>\nHost: console.us-phoenix-1.oraclecloud.com\n<authorization and other headers>\n{\n \"displayName\": \"Count of Running Instances in production\",\n \"description\": \"Collects count of instances in 'UP' status in production compartments from monitoring table\",\n \"collectionRecurrences\": \"FREQ=HOURLY;INTERVAL=1\",\n \"metricList\": [\n {\n \"name\": \"CountOfUpInstances\",\n \"displayName\": \"Count Of Running Instances\",\n \"isDimension\": false,\n \"isHidden\": false,\n \"dataType\": \"NUMBER\",\n \"metricCategory\": \"AVAILABILITY\"\n }\n ],\n \"queryProperties\": {\n \"collectionMethod\": \"SQL\",\n \"sqlDetails\": {\n \"content\": \"<new SQL statement as base64 encoded string>\"\n }, \n \"inParamDetails\": [\n {\n \"inParamPosition\": 1,\n \"inParamValue\": \"production\"\n }\n ]\n }\n}\n\nAbove, the example in create end point (POST /20210330/metricExtensions) is updated \nwith modified values for display name, description, collectionRecurrences, metricList and \ninParamValue, content sub-properties of queryProperties.\n\nNote#1: Update Metric Extension supports completely overwriting the existing properties \n with latest/updated values, whenever passed to the PUT /metricExtensions/{metricExtensionId} end point. \n \n So, even if the modification is required in one of many sub-properties of complex\n input properties like metricList always send the entire updated complex properties set. \n Example: If one metric is being added to metricList as part of the update request, then \n metricList property should carry all existing metrics that need to be retained \n as well as the new metric.\n \nNote#2: Update of queryProperties of Metric Extension supports incremental updates to its sub-properties.\n And only modified sub-property of queryProperties is required to be sent in queryProperties section. \n\nNote#3: If there is no change in any property or its sub-property then no need to send that property.\n\nNote#4: For removing an optional property or sub-property, pass that as empty string or \"\" in the update request.\n"
x-obmcs-client-retries-enabled: false
x-related-resource: '#/definitions/MetricExtension'
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/UpdateMetricExtensionDetails'
description: The information to be updated.
required: true
/metricExtensions/{metricExtensionId}/actions/changeCompartment:
post:
description: "Moves a Metric Extension resource from one compartment identifier to another. \nWhen provided, If-Match is checked against ETag values of the resource.\n"
operationId: ChangeMetricExtensionCompartment
parameters:
- $ref: '#/components/parameters/MetricExtensionIdentifierPathParam'
- $ref: '#/components/parameters/IfMatchHeader'
- $ref: '#/components/parameters/RequestIdHeader'
- $ref: '#/components/parameters/RetryTokenHeader'
responses:
204:
description: The Metric Extension is moved successfully to given compartment
headers:
opc-request-id:
description: 'Unique Oracle-assigned identifier for the request. If you need to contact
Oracle about a particular request, please provide the request ID.
'
schema:
type: string
401:
$ref: '#/components/responses/401'
404:
$ref: '#/components/responses/404'
409:
$ref: '#/components/responses/409'
412:
$ref: '#/components/responses/412'
429:
$ref: '#/components/responses/429'
500:
$ref: '#/components/responses/500'
default:
$ref: '#/components/responses/default'
summary: Moves a Metric Extension into a different compartment.
tags:
- stackMonitoring
x-example: "POST /20210330/metricExtensions/<metricExtension_OCID>/actions/changeCompartment\nHost: console.us-phoenix-1.oraclecloud.com \n<authorization and other headers>\n{\n \"compartmentId\": \"<compartment_OCID>\"\n}\n"
x-obmcs-client-retries-enabled: false
x-related-resource: '#/definitions/MetricExtension'
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/ChangeMetricExtensionCompartmentDetails'
description: The information required to change compartment of given Metric Extension resource
required: true
/metricExtensions/{metricExtensionId}/actions/disable:
post:
description: 'Submits a request to disable matching metric extension Id for the given Resource IDs
'
operationId: DisableMetricExtension
parameters:
- $ref: '#/components/parameters/MetricExtensionIdentifierPathParam'
- $ref: '#/components/parameters/IfMatchHeader'
- $ref: '#/components/parameters/RequestIdHeader'
- $ref: '#/components/parameters/RetryTokenHeader'
responses:
202:
description: Accepted the request. The Metric Extension will be disabled for given Resource Id
headers:
opc-request-id:
description: 'Unique Oracle-assigned identifier for the request. If you need to contact
Oracle about a particular request, please provide the request ID.
'
schema:
type: string
opc-work-request-id:
description: 'Unique Oracle-assigned identifier for the asynchronous request. You can use this to query status of the asynchronous operation.
'
schema:
type: string
401:
$ref: '#/components/responses/401'
404:
$ref: '#/components/responses/404'
409:
$ref: '#/components/responses/409'
412:
$ref: '#/components/responses/412'
429:
$ref: '#/components/responses/429'
500:
$ref: '#/components/responses/500'
default:
$ref: '#/components/responses/default'
summary: Disable metric extension.
tags:
- stackMonitoring
x-example: "POST /20210330/metricExtensions/<metricExtension_OCID>/actions/disable\nHost: console.us-phoenix-1.oraclecloud.com\n<authorization and other headers>\n{\n \"resourceIds\": [\n \"<resource_OCID_1>\",\n \"<resource_OCID_2>\"\n ]\n}\n\nNote#1: The status of work request can be tracked via below GetWorkRequest end point\n GET /20210330/workRequests/{workRequestId}\n\nNote#2: In case of bulk request, SUCCEEDED status means the work request completed with Metric Extension getting disabled on one or more resources.\n Status of Disable request for individual resources can be checked from actionType value in the resources list of GetWorkRequest response.\n"
x-obmcs-client-retries-enabled: false
x-obmcs-terraform:
actionType: DISABLE
identifier: METRIC_EXTENSION_ON_GIVEN_RESOURCES
x-related-resource: '#/definitions/MetricExtension'
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/DisableMetricExtensionDetails'
description: The list of Resource IDs for which given metric extension needs to be disabled
required: true
/metricExtensions/{metricExtensionId}/actions/enable:
post:
description: 'Submits a request to enable matching metric extension Id for the given Resource IDs
'
operationId: EnableMetricExtension
parameters:
- $ref: '#/components/parameters/MetricExtensionIdentifierPathParam'
- $ref: '#/components/parameters/IfMatchHeader'
- $ref: '#/components/parameters/RequestIdHeader'
- $ref: '#/components/parameters/RetryTokenHeader'
responses:
202:
description: Accepted the request. The Metric Extension will be enabled for given Resource IDs.
headers:
opc-request-id:
description: 'Unique Oracle-assigned identifier for the request. If you need to contact
Oracle about a particular request, please provide the request ID.
'
schema:
type: string
opc-work-request-id:
description: 'Unique Oracle-assigned identifier for the asynchronous request. You can use this to query status of the asynchronous operation.
'
schema:
type: string
401:
$ref: '#/components/responses/401'
403:
$ref: '#/components/responses/403'
404:
$ref: '#/components/responses/404'
409:
$ref: '#/components/responses/409'
412:
$ref: '#/components/responses/412'
429:
$ref: '#/components/responses/429'
500:
$ref: '#/components/responses/500'
default:
$ref: '#/components/responses/default'
summary: Enable Metric Extension
tags:
- stackMonitoring
x-example: "POST /20210330/metricExtensions/<metricExtension_OCID>/actions/enable\nHost: console.us-phoenix-1.oraclecloud.com\n<authorization and other headers>\n{\n \"resourceIds\": [\n \"<resource_OCID_1>\",\n \"<resource_OCID_2>\"\n ]\n}\n\nNote#1: The status of work request can be tracked via below GetWorkRequest end point\n GET /20210330/workRequests/{workRequestId}\n \nNote#2: In case of bulk request, SUCCEEDED status means the work request completed with Metric Extension getting enabled on one or more resources.\n Status of Enable request for individual resources can be checked from actionType value in the resources list of GetWorkRequest response.\n"
x-obmcs-client-retries-enabled: false
x-obmcs-terraform:
actionType: ENABLE
identifier: METRIC_EXTENSION_ON_GIVEN_RESOURCES
x-related-resource: '#/definitions/MetricExtension'
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/EnableMetricExtensionDetails'
description: The list of Resource IDs for which given metric extension needs to be enabled
required: true
/metricExtensions/{metricExtensionId}/actions/export:
post:
description: "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"
operationId: ExportMetricExtension
parameters:
- $ref: '#/components/parameters/MetricExtensionIdentifierPathParam'
- $ref: '#/components/parameters/IfMatchHeader'
- $ref: '#/components/parameters/RequestIdHeader'
- $ref: '#/components/parameters/RetryTokenHeader'
responses:
200:
description: "The Metric Extension definition, with placeholders for fields which need to be edited/provided, \nis returned for the matching metric extension Id. This template can be saved as file and can be \nused later to create new metric extensions which have same/similar definition.\n"
headers:
etag:
description: 'For optimistic concurrency control. See `if-match`.
'
schema:
type: string
opc-request-id:
description: 'Unique Oracle-assigned identifier for the request. If you need to contact
Oracle about a particular request, please provide the request ID.
'
schema:
type: string
content:
application/json:
schema:
format: binary
type: string
401:
$ref: '#/components/responses/401'
404:
$ref: '#/components/responses/404'
409:
$ref: '#/components/responses/409'
412:
$ref: '#/components/responses/412'
429:
$ref: '#/components/responses/429'
500:
$ref: '#/components/responses/500'
default:
$ref: '#/components/responses/default'
summary: Export metric extension definition in a template format.
tags:
- stackMonitoring
x-example: 'POST /20210330/metricExtensions/<metricExtension_OCID>/actions/export
Host: console.us-phoenix-1.oraclecloud.com
<authorization and other headers>
'
x-obmcs-client-retries-enabled: true
x-related-resource: '#/definitions/MetricExtension'
/metricExtensions/{metricExtensionId}/actions/publish:
post:
description: Publish the Metric Extension identified by the id
operationId: PublishMetricExtension
parameters:
- $ref: '#/components/parameters/MetricExtensionIdentifierPathParam'
- $ref: '#/components/parameters/RequestIdHeader'
- $ref: '#/components/parameters/RetryTokenHeader'
- $ref: '#/components/parameters/IfMatchHeader'
responses:
200:
description: The Metric Extension resource is marked published
headers:
content-location:
description: Content location of the resource.
schema:
type: string
etag:
description: 'For optimistic concurrency control. See `if-match`.
'
schema:
type: string
opc-request-id:
description: 'Unique Oracle-assigned identifier for the request. If you need to contact
Oracle about a particular request, please provide the request ID.
'
schema:
type: string
content:
application/json:
schema:
$ref: '#/components/schemas/MetricExtension'
400:
$ref: '#/components/responses/400'
401:
$ref: '#/components/responses/401'
404:
$ref: '#/components/responses/404'
409:
$ref: '#/components/responses/409'
412:
$ref: '#/components/responses/412'
429:
$ref: '#/components/responses/429'
500:
$ref: '#/components/responses/500'
default:
$ref: '#/components/responses/default'
summary: Publish the Metric Extension identified by the id
tags:
- stackMonitoring
x-example: "POST /20210330/metricExtensions/<metricExtension_OCID>/actions/publish\nHost: console.us-phoenix-1.oraclecloud.com \n<authorization and other headers>\n"
x-obmcs-client-retries-enabled: false
x-obmcs-terraform:
actionType: SPECIAL_UPDATE
x-related-resource: '#/definitions/MetricExtension'
/metricExtensions/{metricExtensionId}/actions/test:
post:
description: Performs test of Metric Extension on a specific resource Id
operationId: TestMetricExtension
parameters:
- $ref: '#/components/parameters/MetricExtensionIdentifierPathParam'
- $ref: '#/components/parameters/IfMatchHeader'
- $ref: '#/components/parameters/RequestIdHeader'
- $ref: '#/components/parameters/RetryTokenHeader'
responses:
202:
description: Accepted the request. Submitted Test of given metric extension on specified resource Id
headers:
etag:
description: 'For optimistic concurrency control. See `if-match`.
'
schema:
type: string
opc-request-id:
description: 'Unique Oracle-assigned identifier for the request. If you need to contact
Oracle about a particular request, please provide the request ID.
'
schema:
type: string
opc-work-request-id:
description: 'Unique Oracle-assigned identifier for the asynchronous request. You can use this to query status of the asynchronous operation.
'
schema:
type: string
content:
application/json:
schema:
$ref: '#/components/schemas/TestMetricExtensionData'
400:
$ref: '#/components/responses/400'
401:
$ref: '#/components/responses/401'
403:
$ref: '#/components/responses/403'
404:
$ref: '#/components/responses/404'
405:
$ref: '#/components/responses/405'
409:
$ref: '#/components/responses/409'
412:
$ref: '#/components/responses/412'
429:
$ref: '#/components/responses/429'
500:
$ref: '#/components/responses/500'
default:
$ref: '#/components/responses/default'
summary: Perform test of Metric Extension on a specific resource Id
tags:
- stackMonitoring
x-example: "POST /20210330/metricExtensions/<metricExtension_OCID>/actions/test\nHost: console.us-phoenix-1.oraclecloud.com \n<authorization and other headers>\n{\n \"resourceId\": \"<resource_OCID>\"\n}\n"
x-obmcs-client-retries-enabled: false
x-related-resource: '#/definitions/MetricExtension'
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/TestMetricExtensionDetails'
description: It contains OCID of resource.
required: true
/monitoredResourceTasks:
get:
description: 'Returns a list of stack monitoring resource tasks in the compartment.
'
operationId: ListMonitoredResourceTasks
parameters:
- $ref: '#/components/parameters/MonitoredResourceTaskCompartmentIdQueryParam'
- $ref: '#/components/parameters/MonitoredResourceTaskStatusQueryParam'
- $ref: '#/components/parameters/MonitoredResourceTaskSortByQueryParam'
- $ref: '#/components/parameters/SortOrderQueryParam'
- $ref: '#/components/parameters/PaginationLimitQueryParam'
- $ref: '#/components/parameters/PaginationTokenQueryParam'
- $ref: '#/components/parameters/RequestIdHeader'
responses:
200:
description: List stack monitoring monitoredResourceTasks completed successfully.
headers:
opc-next-page:
description: 'For pagination of a list of items. When paging through a list, if this header appears in the response,
then a partial list might have been returned. Include this value as the `page` parameter for the
subsequent GET request to get the next batch of items.
'
schema:
type: string
opc-request-id:
description: 'Unique Oracle-assigned identifier for the request. If you need to contact
Oracle about a particular request, please provide the request ID.
'
schema:
type: string
opc-total-items:
description: 'For pagination of a list of items. The total number of items in the result.
'
schema:
type: integer
content:
application/json:
schema:
$ref: '#/components/schemas/MonitoredResourceTasksCollection'
400:
$ref: '#/components/responses/400'
401:
$ref: '#/components/responses/401'
404:
$ref: '#/components/responses/404'
409:
$ref: '#/components/responses/409'
429:
$ref: '#/components/responses/429'
500:
$ref: '#/components/responses/500'
default:
$ref: '#/components/responses/default'
summary: List stack monitoring monitoredResourceTasks.
tags:
- stackMonitoring
x-example: "GET /20210330/monitoredResourceTasks?compartmentId=compartmentId1&limit=10&sortBy=timeUpdated \nHost: console.us-phoenix-1.oraclecloud.com \n<authorization and other headers>\n"
x-obmcs-client-retries-enabled: true
x-related-resource: '#/definitions/MonitoredResourceTask'
post:
description: Create a new stack monitoring resource task.
operationId: CreateMonitoredResourceTask
parameters:
- $ref: '#/components/parameters/RequestIdHeader'
- $ref: '#/components/parameters/RetryTokenHeader'
responses:
201:
description: Work request for the stack monitoring resource task created successfully.
headers:
etag:
description: 'For optimistic concurrency control. See `if-match`.
'
schema:
type: string
opc-request-id:
description: 'Unique Oracle-assigned identifier for the request. If you need to contact
Oracle about a particular request, please provide the request ID.
'
schema:
type: string
opc-work-request-id:
description: 'Unique Oracle-assigned identifier for the asynchronous request. You can use this to query status of the asynchronous operation.
'
schema:
type: string
content:
application/json:
schema:
$ref: '#/components/schemas/MonitoredResourceTask'
400:
$ref: '#/components/responses/400'
401:
$ref: '#/components/responses/401'
404:
$ref: '#/components/responses/404'
409:
$ref: '#/components/responses/409'
412:
$ref: '#/components/responses/412'
429:
$ref: '#/components/responses/429'
500:
$ref: '#/components/responses/500'
default:
$ref: '#/components/responses/default'
summary: Create a new stack monitoring resource task.
tags:
- stackMonitoring
x-example: "POST /20210330/monitoredResourceTasks\nHost: demohost.example.com\n<authorization and other headers>\n{\n \"compartmentId\": \"ocid1.compartment.oc1.<unique_id>\",\n \"displayName\": \"Import resources for oci_autonomous_database\",\n \"description\": \"Import resources from Telemetry for OCI Autonomous Database Resources\",\n \"taskDetails\" : {\n \"type\" : \"IMPORT_OCI_TELEMETRY_RESOURCES\",\n \"source\" : \"OCI_TELEMETRY_NATIVE\",\n \"namespace\": \"oci_autonomous_database\",\n \"resourceNameMapping\" : \"displayName\",\n \"externalIdMapping\" : \"id\"\n },\n \"freeformTags\": {},\n \"definedTags\": {\n \"discoveryTags\": {\n \"stack\": \"middleware\"\n }\n }\n}\n"
x-obmcs-client-retries-enabled: true
x-related-resource: '#/definitions/MonitoredResourceTask'
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/CreateMonitoredResourceTaskDetails'
description: Details to create the new stack monitoring resource task.
required: true
/monitoredResourceTasks/{monitoredResourceTaskId}:
get:
description: Gets stack monitoring resource task details by identifier [OCID](/Content/General/Concepts/identifiers.htm).
operationId: GetMonitoredResourceTask
parameters:
- $ref: '#/components/parameters/MonitoredResourceTaskIdentifierPathParam'
- $ref: '#/components/parameters/RequestIdHeader'
responses:
200:
description: Get stack monitoring resource task completed successfully.
headers:
etag:
description: 'For optimistic concurrency control. See `if-match`.
'
schema:
type: string
opc-request-id:
description: 'Unique Oracle-assigned identifier for the request. If you need to contact
Oracle about a particular request, please provide the request ID.
'
schema:
type: string
content:
application/json:
schema:
$ref: '#/components/schemas/MonitoredResourceTask'
400:
$ref: '#/components/responses/400'
401:
$ref: '#/components/responses/401'
404:
$ref: '#/components/responses/404'
429:
$ref: '#/components/responses/429'
500:
$ref: '#/components/responses/500'
default:
$ref: '#/components/responses/default'
summary: Get stack monitoring resource task details.
tags:
- stackMonitoring
x-example: "GET /20210330/monitoredResourceTasks/<monitoredResourceTaskId>\nHost: demohost.example.com \n<authorization and other headers>\n"
x-obmcs-client-retries-enabled: true
put:
description: 'Update stack monitoring resource task by the given identifier [OCID](/Content/General/Concepts/identifiers.htm).
'
operationId: UpdateMonitoredResourceTask
parameters:
- $ref: '#/components/parameters/MonitoredResourceTaskIdentifierPathParam'
- $ref: '#/components/parameters/IfMatchHeader'
- $ref: '#/components/parameters/RequestIdHeader'
responses:
200:
description: Task updated successfully.
headers:
etag:
description: 'For optimistic concurrency control. See `if-match`.
'
schema:
type: string
opc-request-id:
description: 'Unique Oracle-assigned identifier for the request. If you need to contact
Oracle about a particular request, please provide the request ID.
'
schema:
type: string
content:
application/json:
schema:
$ref: '#/components/schemas/MonitoredResourceTask'
400:
$ref: '#/components/responses/400'
401:
$ref: '#/components/responses/401'
404:
$ref: '#/components/responses/404'
412:
$ref: '#/components/responses/412'
429:
$ref: '#/components/responses/429'
500:
$ref: '#/components/responses/500'
default:
$ref: '#/components/responses/default'
summary: 'Update stack monitoring resource task.
'
tags:
- stackMonitoring
x-example: "PUT /20210330/monitoredResourceTasks/<monitoredResourceTask_OCID>\nHost: demohost.example.com \n<authorization and other headers>\n{\n \"displayName\": \"<new display name>\"\n}\n"
x-obmcs-client-retries-enabled: false
x-related-resource: '#/definitions/MonitoredResourceTask'
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/UpdateMonitoredResourceTaskDetails'
description: The information to be updated.
required: true
/monitoredResourceTasks/{monitoredResourceTaskId}/actions/changeCompartment:
post:
description: 'Moves a stack monitoring resource task from one compartment to another.
'
operationId: ChangeMonitoredResourceTaskCompartment
parameters:
- $ref: '#/components/parameters/MonitoredResourceTaskIdentifierPathParam'
- $ref: '#/components/parameters/IfMatchHeader'
- $ref: '#/components/parameters/RequestIdHeader'
- $ref: '#/components/parameters/RetryTokenHeader'
responses:
204:
description: The stack monitoring resource task move succeeded.
headers:
opc-request-id:
description: 'Unique Oracle-assigned identifier for the request. If you need to contact
Oracle about a particular request, please provide the request ID.
'
schema:
type: string
401:
$ref: '#/components/responses/401'
404:
$ref: '#/components/responses/404'
409:
$ref: '#/components/responses/409'
412:
$ref: '#/components/responses/412'
429:
$ref: '#/components/responses/429'
500:
$ref: '#/components/responses/500'
summary: Moves a stack monitoring resource task into a different compartment.
tags:
- stackMonitoring
x-example: "POST /20210330/monitoredResourceTasks/<monitoredResourceTaskId>/actions/changeCompartment\nHost: demohost.example.com \n<authorization and other headers>\n"
x-obmcs-client-retries-enabled: true
x-related-resource: '#/definitions/MonitoredResourceTask'
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/ChangeMonitoredResourceTaskCompartmentDetails'
description: The information to be updated.
required: true
/monitoredResourceTypes:
get:
description: "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"
operationId: ListMonitoredResourceTypes
parameters:
- $ref: '#/components/parameters/MonitoredResourceTypeCompartmentIdQueryParam'
- $ref: '#/components/parameters/MonitoredResourceTypeNameQueryParam'
- $ref: '#/components/parameters/MonitoredResourceTypeStatusQueryParam'
- $ref: '#/components/parameters/ExcludeSystemResourceTypesQueryParam'
- $ref: '#/components/parameters/MetricNamespaceQueryParam'
- $ref: '#/components/parameters/MonitoredResourceTypeSortByQueryParam'
- $ref: '#/components/parameters/SortOrderQueryParam'
- $ref: '#/components/parameters/PaginationLimitQueryParam'
- $ref: '#/components/parameters/PaginationTokenQueryParam'
- $ref: '#/components/parameters/RequestIdHeader'
- $ref: '#/components/parameters/ResourceTypeRequestFields'
- $ref: '#/components/parameters/ResourceTypeExcludeRequestFields'
responses:
200:
description: List monitored resource types completed successfully.
headers:
opc-next-page:
description: 'For pagination of a list of items. When paging through a list, if this header appears in the response,
then a partial list might have been returned. Include this value as the `page` parameter for the
subsequent GET request to get the next batch of items.
'
schema:
type: string
opc-request-id:
description: 'Unique Oracle-assigned identifier for the request. If you need to contact
Oracle about a particular request, please provide the request ID.
'
schema:
type: string
opc-total-items:
description: 'For pagination of a list of items. The total number of items in the result.
'
schema:
type: integer
content:
application/json:
schema:
$ref: '#/components/schemas/MonitoredResourceTypesCollection'
400:
$ref: '#/components/responses/400'
401:
$ref: '#/components/responses/401'
404:
$ref: '#/components/responses/404'
409:
$ref: '#/components/responses/409'
429:
$ref: '#/components/responses/429'
500:
$ref: '#/components/responses/500'
default:
$ref: '#/components/responses/default'
summary: List monitored resource types.
tags:
- stackMonitoring
x-example: "GET /20210330/monitoredResourceTypes?compartmentId=<tenant_OCID>&limit=10&sortBy=TIME_CREATED \nHost: console.us-phoenix-1.oraclecloud.com \n<authorization and other headers>\n"
x-obmcs-client-retries-enabled: true
x-related-resource: '#/definitions/MonitoredResourceType'
post:
description: Creates a new monitored resource type.
operationId: CreateMonitoredResourceType
parameters:
- $ref: '#/components/parameters/RequestIdHeader'
- $ref: '#/components/parameters/RetryTokenHeader'
responses:
200:
description: Resource type created successfully.
headers:
etag:
description: 'For optimistic concurrency control. See `if-match`.
'
schema:
type: string
opc-request-id:
description: 'Unique Oracle-assigned identifier for the request. If you need to contact
Oracle about a particular request, please provide the request ID.
'
schema:
type: string
content:
application/json:
schema:
$ref: '#/components/schemas/MonitoredResourceType'
400:
$ref: '#/components/responses/400'
401:
$ref: '#/components/responses/401'
404:
$ref: '#/components/responses/404'
409:
$ref: '#/components/responses/409'
412:
$ref: '#/components/responses/412'
429:
$ref: '#/components/responses/429'
500:
$ref: '#/components/responses/500'
default:
$ref: '#/components/responses/default'
summary: Create a new monitored resource type.
tags:
- stackMonitoring
x-example: "POST /20210330/monitoredResourceTypes\nHost: demohost.example.com\n<authorization and other headers>\n{\n \"compartmentId\": \"ocid1.tenancy.oc1.<unique_id>\",\n \"name\": \"postgresql\",\n \"displayName\": \"Postgres SQL Server\",\n \"description\": \"Created by telegraf\",\n \"metadata\": {\n \"format\" : \"SYSTEM_FORMAT\",\n \"requiredProperties\": [\"osName\",\"osVersion\"],\n \"agentProperties\": [\"hostType\",\"osType\",\"osName\",\"osVersion\"],\n \"validPropertiesForCreate\": [\"osName\",\"osVersion\"],\n \"validPropertiesForUpdate\": [\"osName\",\"osVersion\",\"hostType\", \"osType\"],\n \"requiredMetrics\": [\"CpuUtilization\",\"CpuTime\",\"APEXApps\"],\n \"uniquePropertySets\":[\n {\n \"properties\":[\"host_uuid\"]\n }\n ],\n \"validPropertyValues\":{\n \"osType\":[\"Linux\"]\n }\n },\n \"freeformTags\": {},\n \"definedTags\": {\n \"discoveryTags\": {\n \"stack\": \"middleware\"\n }\n }\n}\n"
x-obmcs-client-retries-enabled: true
x-related-resource: '#/definitions/MonitoredResourceType'
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/CreateMonitoredResourceTypeDetails'
description: Details for the new monitored resource type.
required: true
/monitoredResourceTypes/{monitoredResourceTypeId}:
delete:
description: Deletes a monitored resource type by identifier [OCID](/Content/General/Concepts/identifiers.htm).
operationId: DeleteMonitoredResourceType
parameters:
- $ref: '#/components/parameters/MonitoredResourceTypeIdentifierPathParam'
- $ref: '#/components/parameters/IfMatchHeader'
- $ref: '#/components/parameters/RequestIdHeader'
responses:
204:
description: The monitored resource type deleted.
headers:
opc-request-id:
description: 'Unique Oracle-assigned identifier for the request. If you need to contact
Oracle about a particular request, please provide the request ID.
'
schema:
type: string
400:
$ref: '#/components/responses/400'
401:
$ref: '#/components/responses/401'
404:
$ref: '#/components/responses/404'
409:
$ref: '#/components/responses/409'
412:
$ref: '#/components/responses/412'
429:
$ref: '#/components/responses/429'
500:
$ref: '#/components/responses/500'
default:
$ref: '#/components/responses/default'
summary: Delete the monitored resource type.
tags:
- stackMonitoring
x-example: "DELETE /20210330/monitoredResourceTypes/<monitored_resource_type_OCID>\nHost: demohost.example.com \n<authorization and other headers>\n"
x-obmcs-client-retries-enabled: false
x-related-resource: '#/definitions/MonitoredResourceType'
get:
description: Gets a monitored resource type by identifier [OCID](/Content/General/Concepts/identifiers.htm).
operationId: GetMonitoredResourceType
parameters:
- $ref: '#/components/parameters/MonitoredResourceTypeIdentifierPathParam'
- $ref: '#/components/parameters/RequestIdHeader'
responses:
200:
description: Get monitored resource type completed successfully.
headers:
etag:
description: 'For optimistic concurrency control. See `if-match`.
'
schema:
type: string
opc-request-id:
description: 'Unique Oracle-assigned identifier for the request. If you need to contact
Oracle about a particular request, please provide the request ID.
'
schema:
type: string
content:
application/json:
schema:
$ref: '#/components/schemas/MonitoredResourceType'
400:
$ref: '#/components/responses/400'
401:
$ref: '#/components/responses/401'
404:
$ref: '#/components/responses/404'
429:
$ref: '#/components/responses/429'
500:
$ref: '#/components/responses/500'
default:
$ref: '#/components/responses/default'
summary: Get monitored resource type.
tags:
- stackMonitoring
x-example: "GET /20210330/monitoredResourceTypes/<monitored_resource_type_OCID>\nHost: demohost.example.com \n<authorization and other headers>\n"
x-obmcs-client-retries-enabled: true
put:
description: 'Update the Monitored Resource Type identified by the identifier [OCID](/Content/General/Concepts/identifiers.htm).
'
operationId: UpdateMonitoredResourceType
parameters:
- $ref: '#/components/parameters/MonitoredResourceTypeIdentifierPathParam'
- $ref: '#/components/parameters/IfMatchHeader'
- $ref: '#/components/parameters/RequestIdHeader'
responses:
200:
description: Resource type updated successfully.
headers:
etag:
description: 'For optimistic concurrency control. See `if-match`.
'
schema:
type: string
opc-request-id:
description: 'Unique Oracle-assigned identifier for the request. If you need to contact
Oracle about a particular request, please provide the request ID.
'
schema:
type: string
content:
application/json:
schema:
$ref: '#/components/schemas/MonitoredResourceType'
400:
$ref: '#/components/responses/400'
401:
$ref: '#/components/responses/401'
404:
$ref: '#/components/responses/404'
409:
$ref: '#/components/responses/409'
412:
$ref: '#/components/responses/412'
429:
$ref: '#/components/responses/429'
500:
$ref: '#/components/responses/500'
default:
$ref: '#/components/responses/default'
summary: Updates the Monitored Resource Type
tags:
- stackMonitoring
x-example: "PUT /20210330/monitoredResourceTypes/<monitored_resource_type_OCID>\nHost: demohost.example.com \n<authorization and other headers>\n{\n \"displayName\": \"new display name\",\n \"description\": \"Updated description\"\n}\n"
x-obmcs-client-retries-enabled: false
x-related-resource: '#/definitions/MonitoredResourceType'
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/UpdateMonitoredResourceTypeDetails'
description: The information to be updated for the given resource type id.
required: true
/monitoredResources:
get:
description: Returns a list of monitored resources.
operationId: ListMonitoredResources
parameters:
- $ref: '#/components/parameters/CompartmentIdQueryParam'
- $ref: '#/components/parameters/MonitoredResourceNameQueryParam'
- $ref: '#/components/parameters/MonitoredResourceWorkRequestIdQueryParam'
- $ref: '#/components/parameters/MonitoredResourceStatusQueryParam'
- $ref: '#/components/parameters/MonitoredResourceSortByQueryParam'
- $ref: '#/components/parameters/SortOrderQueryParam'
- $ref: '#/components/parameters/PaginationLimitQueryParam'
- $ref: '#/components/parameters/PaginationTokenQueryParam'
- $ref: '#/components/parameters/RequestIdHeader'
responses:
200:
description: A page of MonitoredResourceSummary objects.
headers:
opc-next-page:
description: 'For pagination of a list of items. When paging through a list, if this header appears in the response,
then a partial list might have been returned. Include this value as the `page` parameter for the
subsequent GET request to get the next batch of items.
'
schema:
type: string
opc-request-id:
description: 'Unique Oracle-assigned identifier for the request. If you need to contact
Oracle about a particular request, please provide the request ID.
'
schema:
type: string
opc-total-items:
description: 'For pagination of a list of items. The total number of items in the result.
'
schema:
type: integer
content:
application/json:
schema:
$ref: '#/components/schemas/MonitoredResourceCollection'
400:
$ref: '#/components/responses/400'
401:
$ref: '#/components/responses/401'
404:
$ref: '#/components/responses/404'
429:
$ref: '#/components/responses/429'
500:
$ref: '#/components/responses/500'
default:
$ref: '#/components/responses/default'
summary: Gets a list of all monitored resources in a compartment
tags:
- stackMonitoring
x-example: "GET /20210330/monitoredResources?compartmentId=<compartment_OCID>&limit=10&sortBy=TIME_CREATED \nHost: console.us-phoenix-1.oraclecloud.com \n<authorization and other headers>\n"
x-obmcs-client-retries-enabled: true
x-related-resource: '#/definitions/MonitoredResource'
post:
description: "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"
operationId: CreateMonitoredResource
parameters:
- $ref: '#/components/parameters/RetryTokenHeader'
- $ref: '#/components/parameters/RequestIdHeader'
- $ref: '#/components/parameters/ExternalResourceIdHeader'
responses:
201:
description: 'Accepted the request. The Monitored Resource will be created.
'
headers:
content-location:
description: Content location of the resource.
schema:
type: string
etag:
description: 'For optimistic concurrency control. See `if-match`.
'
schema:
type: string
location:
description: Location of the resource.
schema:
type: string
opc-monitored-resource-id:
description: 'Unique identifier for the monitored resource. This is sent to user in response headers for create monitored resource.
'
schema:
type: string
opc-request-id:
description: 'Unique Oracle-assigned identifier for the request. If you need to contact
Oracle about a particular request, please provide the request ID.
'
schema:
type: string
opc-work-request-id:
description: 'Unique Oracle-assigned identifier for the asynchronous request. You can use this to query status of the asynchronous operation.
'
schema:
type: string
content:
application/json:
schema:
$ref: '#/components/schemas/MonitoredResource'
400:
$ref: '#/components/responses/400'
401:
$ref: '#/components/responses/401'
404:
$ref: '#/components/responses/404'
409:
$ref: '#/components/responses/409'
429:
$ref: '#/components/responses/429'
500:
$ref: '#/components/responses/500'
default:
$ref: '#/components/responses/default'
summary: 'Create a new monitored resource.
'
tags:
- stackMonitoring
x-example: "POST /20210330/monitoredResources\nHost: demohost.example.com\n<authorization and other headers>\n{\n\"name\": \"Demo_AdminServer\",\n\"type\": \"weblogic_j2eeserver\",\n\"compartmentId\": \"ocid1.compartment.oc1..<unique_id>\",\n\"hostName\": \"demohost.example.com\",\n\"managementAgentId\": \"ocid1.managementagent.oc1.iad.<unique_id>\",\n\"resourceTimeZone\": \"UTC\",\n\"properties\": [\n \n {\n \"name\": \"is_admin_server\",\n \"value\": \"1\"\n }\n \n],\n\"aliases\": {\n \"source\": \"weblogic_j2eeserver.Demo_AdminServer\",\n \"name\": \"JMXCreds\",\n \"credential\": {\n \"source\": \"weblogic_domain.demo_domain\",\n \"name\": \"JMXCreds\",\n \"service\": \"appmgmt\"\n }\n}\n}\n"
x-obmcs-client-retries-enabled: false
x-related-resource: '#/definitions/MonitoredResource'
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/CreateMonitoredResourceDetails'
description: 'Details for the new monitored resource.
'
required: true
/monitoredResources/actions/associateMonitoredResources:
post:
description: "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"
operationId: AssociateMonitoredResources
parameters:
- $ref: '#/components/parameters/RequestIdHeader'
- $ref: '#/components/parameters/RetryTokenHeader'
- $ref: '#/components/parameters/IfMatchHeader'
responses:
200:
description: Resources associated successfully
headers:
etag:
description: 'For optimistic concurrency control. See `if-match`.
'
schema:
type: string
opc-request-id:
description: 'Unique Oracle-assigned identifier for the request. If you need to contact
Oracle about a particular request, please provide the request ID.
'
schema:
type: string
content:
application/json:
schema:
$ref: '#/components/schemas/MonitoredResourceAssociation'
400:
$ref: '#/components/responses/400'
401:
$ref: '#/components/responses/401'
404:
$ref: '#/components/responses/404'
412:
$ref: '#/components/responses/412'
429:
$ref: '#/components/responses/429'
500:
$ref: '#/components/responses/500'
default:
$ref: '#/components/responses/default'
summary: Create an association between two monitored resources.
tags:
- stackMonitoring
x-example: "POST /20210330/monitoredResources/actions/associateMonitoredResources\nHost: demohost.example.com \n<authorization and other headers>\n{\n \"compartmentId\": \"ocid1.compartment.oc1..<unique_id>\",\n \"associationType\": \"contains\",\n \"sourceResourceId\" : \"ocid1.stackmonitoringresource.oc1.eu-frankfurt-1.<unique_id>\",\n \"destinationResourceId\": \"ocid1.stackmonitoringresource.oc1.eu-frankfurt-1.<unique_id>\"\n}\n"
x-obmcs-client-retries-enabled: false
x-related-resource: '#/definitions/MonitoredResource'
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/AssociateMonitoredResourcesDetails'
description: 'Details to create association between two resources.
'
required: true
/monitoredResources/actions/disassociateMonitoredResources:
post:
description: Removes associations between two monitored resources.
operationId: DisassociateMonitoredResources
parameters:
- $ref: '#/components/parameters/RequestIdHeader'
- $ref: '#/components/parameters/RetryTokenHeader'
- $ref: '#/components/parameters/IfMatchHeader'
responses:
200:
description: 'Resources disassociated successfully.
'
headers:
opc-request-id:
description: 'Unique Oracle-assigned identifier for the request. If you need to contact
Oracle about a particular request, please provide the request ID.
'
schema:
type: string
400:
$ref: '#/components/responses/400'
401:
$ref: '#/components/responses/401'
404:
$ref: '#/components/responses/404'
412:
$ref: '#/components/responses/412'
429:
$ref: '#/components/responses/429'
500:
$ref: '#/components/responses/500'
default:
$ref: '#/components/responses/default'
summary: Removes associations between two monitored resources.
tags:
- stackMonitoring
x-example: "POST /20210330/monitoredResources/actions/disassociateMonitoredResources\nHost: demohost.example.com \n<authorization and other headers>\n{\n \"compartmentId\": \"ocid1.compartment.oc1..<unique_id>\",\n \"sourceResourceId\": \"ocid1.stackmonitoringresource.oc1.iad.<unique_id>\",\n \"destinationResourceId\": \"ocid1.stackmonitoringresource.oc1.iad.<unique_id>\"\n}\n"
x-obmcs-client-retries-enabled: false
x-related-resource: '#/definitions/MonitoredResource'
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/DisassociateMonitoredResourcesDetails'
description: Disassociate resources.
required: true
/monitoredResources/actions/search:
post:
description: 'Gets a list of all monitored resources in a compartment for the given search criteria.
'
operationId: SearchMonitoredResources
parameters:
- $ref: '#/components/parameters/PaginationLimitQueryParam'
- $ref: '#/components/parameters/PaginationTokenQueryParam'
- $ref: '#/components/parameters/RequestFields'
- $ref: '#/components/parameters/ExcludeRequestFields'
- $ref: '#/components/parameters/RequestIdHeader'
- $ref: '#/components/parameters/RetryTokenHeader'
- $ref: '#/components/parameters/IfMatchHeader'
responses:
200:
description: A page of MonitoredResourceSummary objects.
headers:
opc-next-page:
description: 'For pagination of a list of items. When paging through a list, if this header appears in the response,
then a partial list might have been returned. Include this value as the `page` parameter for the
subsequent GET request to get the next batch of items.
'
schema:
type: string
opc-request-id:
description: 'Unique Oracle-assigned identifier for the request. If you need to contact
Oracle about a particular request, please provide the request ID.
'
schema:
type: string
opc-total-items:
description: 'For pagination of a list of items. The total number of items in the result.
'
schema:
type: integer
content:
application/json:
schema:
$ref: '#/components/schemas/MonitoredResourceCollection'
400:
$ref: '#/components/responses/400'
401:
$ref: '#/components/responses/401'
404:
$ref: '#/components/responses/404'
412:
$ref: '#/components/responses/412'
429:
$ref: '#/components/responses/429'
500:
$ref: '#/components/responses/500'
default:
$ref: '#/components/responses/default'
summary: 'Returns a list of monitored resources.
'
tags:
- stackMonitoring
x-example: "POST /20210330/monitoredResources/actions/search\nHost: demohost.example.com \n<authorization and other headers>\n{\n \"compartmentId\": \"ocid1.compartment.oc1..<unique_id>\"\n}\n"
x-obmcs-client-retries-enabled: true
x-related-resource: '#/definitions/MonitoredResource'
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/SearchMonitoredResourcesDetails'
description: 'Search Criteria for listing monitored resources.
'
required: true
/monitoredResources/actions/searchAssociatedResources:
post:
description: 'List all associated resources recursively up-to a specified level,
for the monitored resources of type specified.
'
operationId: SearchAssociatedResources
parameters:
- $ref: '#/components/parameters/RequestFields'
- $ref: '#/components/parameters/ExcludeRequestFields'
- $ref: '#/components/parameters/RequestIdHeader'
- $ref: '#/components/parameters/RetryTokenHeader'
- $ref: '#/components/parameters/IfMatchHeader'
- $ref: '#/components/parameters/PaginationLimitQueryParam'
- $ref: '#/components/parameters/PaginationTokenQueryParam'
responses:
200:
description: A page of AssociatedResourcesSummary objects.
headers:
opc-next-page:
description: 'For pagination of a list of items. When paging through a list, if this header appears in the response,
then a partial list might have been returned. Include this value as the `page` parameter for the
subsequent GET request to get the next batch of items.
'
schema:
type: string
opc-request-id:
description: 'Unique Oracle-assigned identifier for the request. If you need to contact
Oracle about a particular request, please provide the request ID.
'
schema:
type: string
opc-total-items:
description: 'For pagination of a list of items. The total number of items in the result.
'
schema:
type: integer
content:
application/json:
schema:
$ref: '#/components/schemas/AssociatedResourcesCollection'
400:
$ref: '#/components/responses/400'
401:
$ref: '#/components/responses/401'
404:
$ref: '#/components/responses/404'
412:
$ref: '#/components/responses/412'
429:
$ref: '#/components/responses/429'
500:
$ref: '#/components/responses/500'
default:
$ref: '#/components/responses/default'
summary: 'List associated monitored resources.
'
tags:
- stackMonitoring
x-example: "POST /20210330/monitoredResources/actions/searchAssociatedResources\nHost: demohost.example.com\n<authorization and other headers>\n{\n \"compartmentId\": \"compartmentId1\",\n \"resourceType\": \"ebs_instance\",\n \"resourceId\": \"unique_stackmonitoringresource_id\",\n \"associationTypes\": [\"contains\",\"uses\"],\n \"limitLevel\":2\n}\n"
x-obmcs-client-retries-enabled: true
x-related-resource: '#/definitions/MonitoredResource'
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/SearchAssociatedResourcesDetails'
description: Search Criteria for the listing the monitored resources for given type and compartmentId.
required: true
/monitoredResources/actions/searchAssociations:
post:
description: 'Search associations in the given compartment based on the search criteria.
'
operationId: SearchMonitoredResourceAssociations
parameters:
- $ref: '#/components/parameters/PaginationLimitQueryParam'
- $ref: '#/components/parameters/PaginationTokenQueryParam'
- $ref: '#/components/parameters/RequestIdHeader'
- $ref: '#/components/parameters/RetryTokenHeader'
- $ref: '#/components/parameters/IfMatchHeader'
responses:
200:
description: A page of MonitoredResourceAssociationSummary objects.
headers:
opc-next-page:
description: 'For pagination of a list of items. When paging through a list, if this header appears in the response,
then a partial list might have been returned. Include this value as the `page` parameter for the
subsequent GET request to get the next batch of items.
'
schema:
type: string
opc-request-id:
description: 'Unique Oracle-assigned identifier for the request. If you need to contact
Oracle about a particular request, please provide the request ID.
'
schema:
type: string
opc-total-items:
description: 'For pagination of a list of items. The total number of items in the result.
'
schema:
type: integer
content:
application/json:
schema:
$ref: '#/components/schemas/MonitoredResourceAssociationsCollection'
400:
$ref: '#/components/responses/400'
401:
$ref: '#/components/responses/401'
404:
$ref: '#/components/responses/404'
412:
$ref: '#/components/responses/412'
429:
$ref: '#/components/responses/429'
500:
$ref: '#/components/responses/500'
default:
$ref: '#/components/responses/default'
summary: 'Returns a list of monitored resource associations.
'
tags:
- stackMonitoring
x-example: "POST /20210330/monitoredResources/actions/searchAssociations\nHost: demohost.example.com \n<authorization and other headers>\n{\n \"compartmentId\": \"ocid1.compartment.oc1..<unique_id>\",\n \"sourceResourceId\": \"ocid1.stackmonitoringresource.oc1.iad.<unique_id>\"\n}\n"
x-obmcs-client-retries-enabled: true
x-related-resource: '#/definitions/MonitoredResource'
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/SearchMonitoredResourceAssociationsDetails'
description: 'Search criteria for listing monitored resource associations.
'
required: true
/monitoredResources/actions/summarizeCount:
post:
description: 'Gets resource count based on the aggregation criteria specified using "groupBy" parameter.
'
operationId: RequestMonitoredResourcesSummarizedCount
parameters:
- $ref: '#/components/parameters/CompartmentIdQueryParam'
- $ref: '#/components/parameters/GroupByQueryParam'
- $ref: '#/components/parameters/LicenseQueryParam'
- $ref: '#/components/parameters/ResourceTypeQueryParam'
- $ref: '#/components/parameters/SummarizeDataSortByQueryParam'
- $ref: '#/components/parameters/SortOrderQueryParam'
- $ref: '#/components/parameters/PaginationLimitQueryParam'
- $ref: '#/components/parameters/PaginationTokenQueryParam'
- $ref: '#/components/parameters/RequestIdHeader'
responses:
200:
description: Returns counts based on groupBy query parameter.
headers:
opc-next-page:
description: 'For pagination of a list of items. When paging through a list, if this header appears in the response,
then a partial list might have been returned. Include this value as the `page` parameter for the
subsequent GET request to get the next batch of items.
'
schema:
type: string
opc-request-id:
description: 'Unique Oracle-assigned identifier for the request. If you need to contact
Oracle about a particular request, please provide the request ID.
'
schema:
type: string
opc-total-items:
description: 'For pagination of a list of items. The total number of items in the result.
'
schema:
type: integer
content:
application/json:
schema:
$ref: '#/components/schemas/MonitoredResourcesCountAggregationCollection'
400:
$ref: '#/components/responses/400'
401:
$ref: '#/components/responses/401'
404:
$ref: '#/components/responses/404'
409:
$ref: '#/components/responses/409'
429:
$ref: '#/components/responses/429'
500:
$ref: '#/components/responses/500'
default:
$ref: '#/components/responses/default'
summary: Summarize the monitored resource counts.
tags:
- stackMonitoring
x-obmcs-client-retries-enabled: true
x-related-resource: '#/definitions/MonitoredResource'
/monitoredResources/{monitoredResourceId}:
delete:
description: "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"
operationId: DeleteMonitoredResource
parameters:
- $ref: '#/components/parameters/MonitoredResourceIdentifierPathParam'
- $ref: '#/components/parameters/IfMatchHeader'
- $ref: '#/components/parameters/RequestIdHeader'
- $ref: '#/components/parameters/MonitoredResourceDeleteMembersQueryParam'
responses:
202:
description: Accepted the request. The Monitored Resource will be deleted.
headers:
opc-request-id:
description: 'Unique Oracle-assigned identifier for the request. If you need to contact
Oracle about a particular request, please provide the request ID.
'
schema:
type: string
opc-work-request-id:
description: 'Unique Oracle-assigned identifier for the asynchronous request. You can use this to query status of the asynchronous operation.
'
schema:
type: string
400:
$ref: '#/components/responses/400'
401:
$ref: '#/components/responses/401'
404:
$ref: '#/components/responses/404'
409:
$ref: '#/components/responses/409'
412:
$ref: '#/components/responses/412'
429:
$ref: '#/components/responses/429'
500:
$ref: '#/components/responses/500'
default:
$ref: '#/components/responses/default'
summary: 'Delete monitored resource.
'
tags:
- stackMonitoring
x-example: "DELETE /20210330/monitoredResources/<monitoredResource_OCID>\nHost: demohost.example.com \n<authorization and other headers>\n"
x-obmcs-client-retries-enabled: false
x-related-resource: '#/definitions/MonitoredResource'
get:
description: 'Get monitored resource for the given identifier [OCID](/Content/General/Concepts/identifiers.htm).
'
operationId: GetMonitoredResource
parameters:
- $ref: '#/components/parameters/MonitoredResourceIdentifierPathParam'
- $ref: '#/components/parameters/RequestIdHeader'
responses:
200:
description: 'Successfully returned monitored resource.
'
headers:
etag:
description: 'For optimistic concurrency control. See `if-match`.
'
schema:
type: string
opc-request-id:
description: 'Unique Oracle-assigned identifier for the request. If you need to contact
Oracle about a particular request, please provide the request ID.
'
schema:
type: string
content:
application/json:
schema:
$ref: '#/components/schemas/MonitoredResource'
400:
$ref: '#/components/responses/400'
401:
$ref: '#/components/responses/401'
404:
$ref: '#/components/responses/404'
429:
$ref: '#/components/responses/429'
500:
$ref: '#/components/responses/500'
default:
$ref: '#/components/responses/default'
summary: 'Get monitored resource.
'
tags:
- stackMonitoring
x-example: "GET /20210330/monitoredResources/<monitoredResource_OCID>\nHost: demohost.example.com \n<authorization and other headers>\n"
x-obmcs-client-retries-enabled: true
put:
description: "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"
operationId: UpdateMonitoredResource
parameters:
- $ref: '#/components/parameters/MonitoredResourceIdentifierPathParam'
- $ref: '#/components/parameters/IfMatchHeader'
- $ref: '#/components/parameters/RequestIdHeader'
responses:
202:
description: Accepted the request. The Monitored Resource will be updated.
headers:
opc-request-id:
description: 'Unique Oracle-assigned identifier for the request. If you need to contact
Oracle about a particular request, please provide the request ID.
'
schema:
type: string
opc-work-request-id:
description: 'Unique Oracle-assigned identifier for the asynchronous request. You can use this to query status of the asynchronous operation.
'
schema:
type: string
400:
$ref: '#/components/responses/400'
401:
$ref: '#/components/responses/401'
404:
$ref: '#/components/responses/404'
405:
$ref: '#/components/responses/405'
412:
$ref: '#/components/responses/412'
429:
$ref: '#/components/responses/429'
500:
$ref: '#/components/responses/500'
default:
$ref: '#/components/responses/default'
summary: 'Update monitored resource.
'
tags:
- stackMonitoring
x-example: "PUT /20210330/monitoredResources/<monitoredResource_OCID>\nHost: demohost.example.com \n<authorization and other headers>\n{\n \"displayName\": \"<new display name>\"\n}\n"
x-obmcs-client-retries-enabled: false
x-related-resource: '#/definitions/MonitoredResource'
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/UpdateMonitoredResourceDetails'
description: The information to be updated.
required: true
/monitoredResources/{monitoredResourceId}/actions/changeCompartment:
post:
description: "Moves a monitored resource from one compartment to another. \nWhen provided, If-Match is checked against ETag values of the resource.\n"
operationId: ChangeMonitoredResourceCompartment
parameters:
- $ref: '#/components/parameters/MonitoredResourceIdentifierPathParam'
- $ref: '#/components/parameters/IfMatchHeader'
- $ref: '#/components/parameters/RequestIdHeader'
- $ref: '#/components/parameters/RetryTokenHeader'
responses:
202:
description: Accepted the request. The MonitoredResource will be moved into a different compartment.
headers:
opc-request-id:
description: 'Unique Oracle-assigned identifier for the request. If you need to contact
Oracle about a particular request, please provide the request ID.
'
schema:
type: string
opc-work-request-id:
description: 'Unique Oracle-assigned identifier for the asynchronous request. You can use this to query status of the asynchronous operation.
'
schema:
type: string
401:
$ref: '#/components/responses/401'
404:
$ref: '#/components/responses/404'
409:
$ref: '#/components/responses/409'
412:
$ref: '#/components/responses/412'
500:
$ref: '#/components/responses/500'
summary: Moves a resource into a different compartment.
tags:
- stackMonitoring
x-example: "POST /20210330/monitoredResources/<monitoredResourceId>/actions/changeCompartment\nHost: demohost.example.com \n<authorization and other headers>\n"
x-obmcs-client-retries-enabled: false
x-related-resource: '#/definitions/MonitoredResource'
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/ChangeMonitoredResourceCompartmentDetails'
description: The information to be updated.
required: true
/monitoredResources/{monitoredResourceId}/actions/disableExternalDatabase:
post:
description: "Disable external database resource monitoring. All the references in DBaaS, \nDBM and resource service will be deleted as part of this operation.\n"
operationId: DisableExternalDatabase
parameters:
- $ref: '#/components/parameters/MonitoredResourceIdentifierPathParam'
- $ref: '#/components/parameters/RetryTokenHeader'
- $ref: '#/components/parameters/RequestIdHeader'
- $ref: '#/components/parameters/IfMatchHeader'
responses:
202:
description: Accepted the request. The Resource will be deleted.
headers:
opc-request-id:
description: 'Unique Oracle-assigned identifier for the request. If you need to contact
Oracle about a particular request, please provide the request ID.
'
schema:
type: string
opc-work-request-id:
description: 'Unique Oracle-assigned identifier for the asynchronous request. You can use this to query status of the asynchronous operation.
'
schema:
type: string
400:
$ref: '#/components/responses/400'
401:
$ref: '#/components/responses/401'
404:
$ref: '#/components/responses/404'
409:
$ref: '#/components/responses/409'
429:
$ref: '#/components/responses/429'
500:
$ref: '#/components/responses/500'
412:
$ref: '#/components/responses/412'
default:
$ref: '#/components/responses/default'
summary: Disable external database resource monitoring.
tags:
- stackMonitoring
x-example: 'POST /20210330/monitoredResources/<monitoredResource_OCID>/actions/disableExternalDatabase
Host: demohost.example.com
<authorization and other headers>
'
x-obmcs-client-retries-enabled: false
x-related-resource: '#/definitions/MonitoredResource'
/monitoredResources/{monitoredResourceId}/actions/listMembers:
post:
description: 'List the member resources for the given monitored resource identifier [OCID](/Content/General/Concepts/identifiers.htm).
'
operationId: SearchMonitoredResourceMembers
parameters:
- $ref: '#/components/parameters/MonitoredResourceIdentifierPathParam'
- $ref: '#/components/parameters/MonitoredResourceMembersSortByQueryParam'
- $ref: '#/components/parameters/SortOrderQueryParam'
- $ref: '#/components/parameters/PaginationTokenQueryParam'
- $ref: '#/components/parameters/PaginationLimitQueryParam'
- $ref: '#/components/parameters/RetryTokenHeader'
- $ref: '#/components/parameters/RequestIdHeader'
- $ref: '#/components/parameters/IfMatchHeader'
responses:
200:
description: Member resources retrieved successfully.
headers:
opc-next-page:
description: 'For pagination of a list of items. When paging through a list, if this header appears in the response,
then a partial list might have been returned. Include this value as the `page` parameter for the
subsequent GET request to get the next batch of items.
'
schema:
type: string
opc-request-id:
description: 'Unique Oracle-assigned identifier for the request. If you need to contact
Oracle about a particular request, please provide the request ID.
'
schema:
type: string
opc-total-items:
description: 'For pagination of a list of items. The total number of items in the result.
'
schema:
type: integer
content:
application/json:
schema:
$ref: '#/components/schemas/MonitoredResourceMembersCollection'
400:
$ref: '#/components/responses/400'
401:
$ref: '#/components/responses/401'
404:
$ref: '#/components/responses/404'
412:
$ref: '#/components/responses/412'
429:
$ref: '#/components/responses/429'
500:
$ref: '#/components/responses/500'
default:
$ref: '#/components/responses/default'
summary: 'List member resources for the monitored resource.
'
tags:
- stackMonitoring
x-example: "POST /20210330/monitoredResources/<monitoredResourceId>/actions/listMembers\nHost: demohost.example.com \n<authorization and other headers>\n{\n \"limitLevel\":\"3\"\n}\n"
x-obmcs-client-retries-enabled: true
x-related-resource: '#/definitions/MonitoredResource'
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/SearchMonitoredResourceMembersDetails'
description: 'Search criteria for listing member monitored resources.
'
required: true
/monitoredResources/{monitoredResourceId}/actions/manageLicense:
post:
description: "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"
operationId: ManageLicense
parameters:
- $ref: '#/components/parameters/MonitoredResourceIdentifierPathParam'
- $ref: '#/components/parameters/RetryTokenHeader'
- $ref: '#/components/parameters/RequestIdHeader'
- $ref: '#/components/parameters/IfMatchHeader'
responses:
200:
description: Updated the license edition successfully.
headers:
opc-request-id:
description: 'Unique Oracle-assigned identifier for the request. If you need to contact
Oracle about a particular request, please provide the request ID.
'
schema:
type: string
400:
$ref: '#/components/responses/400'
401:
$ref: '#/components/responses/401'
404:
$ref: '#/components/responses/404'
405:
$ref: '#/components/responses/405'
409:
$ref: '#/components/responses/409'
412:
$ref: '#/components/responses/412'
429:
$ref: '#/components/responses/429'
500:
$ref: '#/components/responses/500'
default:
$ref: '#/components/responses/default'
summary: Manages the license of given resource and all member resources.
tags:
- stackMonitoring
x-example: "POST /20210330/monitoredResources/<monitoredResource_OCID>/actions/manageLicense\nHost: demohost.example.com\n<authorization and other headers>\n{\n \"license\" : \"STANDARD_EDITION\"\n}\n"
x-obmcs-client-retries-enabled: true
x-obmcs-terraform:
actionType: UPDATE_FIELD
x-related-resource: '#/definitions/MonitoredResource'
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/ManageLicenseDetails'
description: New license information.
required: true
/monitoredResources/{monitoredResourceId}/actions/updateAndPropagateTags:
post:
description: "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"
operationId: UpdateAndPropagateTags
parameters:
- $ref: '#/components/parameters/MonitoredResourceIdentifierPathParam'
- $ref: '#/components/parameters/RetryTokenHeader'
- $ref: '#/components/parameters/RequestIdHeader'
- $ref: '#/components/parameters/IfMatchHeader'
responses:
202:
description: Accepted the request. The Resource will be updated.
headers:
opc-request-id:
description: 'Unique Oracle-assigned identifier for the request. If you need to contact
Oracle about a particular request, please provide the request ID.
'
schema:
type: string
opc-work-request-id:
description: 'Unique Oracle-assigned identifier for the asynchronous request. You can use this to query status of the asynchronous operation.
'
schema:
type: string
400:
$ref: '#/components/responses/400'
401:
$ref: '#/components/responses/401'
404:
$ref: '#/components/responses/404'
409:
$ref: '#/components/responses/409'
412:
$ref: '#/components/responses/412'
429:
$ref: '#/components/responses/429'
500:
$ref: '#/components/responses/500'
default:
$ref: '#/components/responses/default'
summary: Update and propagate tags to related resources.
tags:
- stackMonitoring
x-example: "POST /20210330/monitoredResources/<monitoredResource_OCID>/actions/updateAndPropagateTags\nHost: demohost.example.com\n<authorization and other headers>\n{\n \"freeformTags\" : {\n \"bar-key\" : \"value\"\n },\n \"definedTags\": {\n \"discoveryTags\": {\n \"stack\": \"middleware\"\n }\n },\n \"associationTypes\": [\"contains\",\"uses\"]\n}\n"
x-obmcs-client-retries-enabled: true
x-related-resource: '#/definitions/MonitoredResource'
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/UpdateAndPropagateTagsDetails'
description: The tags to be updated.
required: true
/processSets:
get:
description: API to get the details of all Process Sets.
operationId: ListProcessSets
parameters:
- $ref: '#/components/parameters/CompartmentIdQueryParam'
- $ref: '#/components/parameters/PaginationLimitQueryParam'
- $ref: '#/components/parameters/PaginationTokenQueryParam'
- $ref: '#/components/parameters/SortOrderQueryParam'
- $ref: '#/components/parameters/RequestIdHeader'
- $ref: '#/components/parameters/ProcessSetSortByQueryParam'
- $ref: '#/components/parameters/ProcessSetDisplayNameQueryParam'
responses:
200:
description: A collection of Process Sets.
headers:
opc-next-page:
description: 'For pagination of a list of items. When paging through a list, if this header appears in the response,
then a partial list might have been returned. Include this value as the `page` parameter for the
subsequent GET request to get the next batch of items.
'
schema:
type: string
opc-request-id:
description: 'Unique Oracle-assigned identifier for the request. If you need to contact
Oracle about a particular request, please provide the request ID.
'
schema:
type: string
content:
application/json:
schema:
$ref: '#/components/schemas/ProcessSetCollection'
400:
$ref: '#/components/responses/400'
401:
$ref: '#/components/responses/401'
404:
$ref: '#/components/responses/404'
429:
$ref: '#/components/responses/429'
500:
$ref: '#/components/responses/500'
default:
$ref: '#/components/responses/default'
summary: API to get the details of all Process Sets.
tags:
- stackMonitoring
x-example: 'GET /20210330/processSets?compartmentId=<compartment_OCID>&limit=10&sortBy=timeCreated Host: console.us-phoenix-1.oraclecloud.com <authorization and other headers>
'
x-obmcs-client-retries-enabled: true
x-related-resource: '#/definitions/ProcessSetCollection'
post:
description: API to create Process Set.
operationId: CreateProcessSet
parameters:
- $ref: '#/components/parameters/RequestIdHeader'
- $ref: '#/components/parameters/RetryTokenHeader'
responses:
200:
description: Process Set successfully created.
headers:
etag:
description: 'For optimistic concurrency control. See `if-match`.
'
schema:
type: string
opc-request-id:
description: 'Unique Oracle-assigned identifier for the request. If you need to contact
Oracle about a particular request, please provide the request ID.
'
schema:
type: string
content:
application/json:
schema:
$ref: '#/components/schemas/ProcessSet'
400:
$ref: '#/components/responses/400'
401:
$ref: '#/components/responses/401'
404:
$ref: '#/components/responses/404'
409:
$ref: '#/components/responses/409'
429:
$ref: '#/components/responses/429'
500:
$ref: '#/components/responses/500'
default:
$ref: '#/components/responses/default'
summary: API to create Process Set.
tags:
- stackMonitoring
x-example: "POST /20210330/processSets\nHost: console.us-phoenix-1.oraclecloud.com\nconnection: keep-alive\naccept-encoding: gzip, deflate\naccept: */*\nuser-agent: Mozilla/5.0 (Macintosh; Intel Mac OS X 10_14_6) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/92.0.4515.159 Safari/537.36\ndate: Mon, 23 Aug 2021 21:57:48 GMT\nauthorization: <authorization and other headers>\n{\n \"compartmentId\": \"ocid1.compartment.oc1.<unique_id>\",\n \"displayName\": \"nginx workers\",\n \"specification\": {\n \"items\": [\n {\n \"processCommand\": \"nginx\",\n \"processUser\": \"opc\",\n \"processLineRegexPattern\": \"nginx: worker.\",\n \"label\": \"nginx-workers\"\n }\n ]\n }\n}\n"
x-obmcs-client-retries-enabled: true
x-related-resource: '#/definitions/ProcessSet'
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/CreateProcessSetDetails'
description: Summary of process set details.
required: true
/processSets/{processSetId}:
delete:
description: Deletes a Process Set
operationId: DeleteProcessSet
parameters:
- $ref: '#/components/parameters/ProcessSetIdPathParam'
- $ref: '#/components/parameters/IfMatchHeader'
- $ref: '#/components/parameters/RequestIdHeader'
responses:
204:
description: The Process Set has successfully been deleted.
headers:
opc-request-id:
description: 'Unique Oracle-assigned identifier for the request. If you need to contact
Oracle about a particular request, please provide the request ID.
'
schema:
type: string
400:
$ref: '#/components/responses/400'
401:
$ref: '#/components/responses/401'
404:
$ref: '#/components/responses/404'
412:
$ref: '#/components/responses/412'
429:
$ref: '#/components/responses/429'
500:
$ref: '#/components/responses/500'
default:
$ref: '#/components/responses/default'
summary: Delete a Process Set
tags:
- stackMonitoring
x-example: 'DELETE /20210330/processSets/<processSet_OCID> Host: console.us-phoenix-1.oraclecloud.com <authorization and other headers>
'
x-obmcs-client-retries-enabled: true
x-related-resource: '#/definitions/ProcessSet'
get:
description: API to get the details of a Process Set by identifier.
operationId: GetProcessSet
parameters:
- $ref: '#/components/parameters/RequestIdHeader'
- $ref: '#/components/parameters/ProcessSetIdPathParam'
responses:
200:
description: Retrieves the Process Set details with the given ProcessSetId.
headers:
etag:
description: 'For optimistic concurrency control. See `if-match`.
'
schema:
type: string
opc-request-id:
description: 'Unique Oracle-assigned identifier for the request. If you need to contact
Oracle about a particular request, please provide the request ID.
'
schema:
type: string
content:
application/json:
schema:
$ref: '#/components/schemas/ProcessSet'
400:
$ref: '#/components/responses/400'
401:
$ref: '#/components/responses/401'
404:
$ref: '#/components/responses/404'
429:
$ref: '#/components/responses/429'
500:
$ref: '#/components/responses/500'
default:
$ref: '#/components/responses/default'
summary: API to get the details of a Process Set by identifier.
tags:
- stackMonitoring
x-example: 'GET /20210330/processSets/<processSet_OCID> Host: console.us-phoenix-1.oraclecloud.com <authorization and other headers>
'
x-obmcs-client-retries-enabled: true
x-related-resource: '#/definitions/ProcessSet'
put:
description: API to update a Process Set identified by a given ocid.
operationId: UpdateProcessSet
parameters:
- $ref: '#/components/parameters/RequestIdHeader'
- $ref: '#/components/parameters/IfMatchHeader'
- $ref: '#/components/parameters/ProcessSetIdPathParam'
responses:
200:
description: Updates the Process Set details with the given ProcessSetId.
headers:
etag:
description: 'For optimistic concurrency control. See `if-match`.
'
schema:
type: string
opc-request-id:
description: 'Unique Oracle-assigned identifier for the request. If you need to contact
Oracle about a particular request, please provide the request ID.
'
schema:
type: string
content:
application/json:
schema:
$ref: '#/components/schemas/ProcessSet'
400:
$ref: '#/components/responses/400'
401:
$ref: '#/components/responses/401'
404:
$ref: '#/components/responses/404'
405:
$ref: '#/components/responses/405'
412:
$ref: '#/components/responses/412'
429:
$ref: '#/components/responses/429'
500:
$ref: '#/components/responses/500'
default:
$ref: '#/components/responses/default'
summary: API to update a Process Set identified by a given ocid.
tags:
- stackMonitoring
x-example: "/20210330/processSets/<processSet_OCID>\nHost: console.us-phoenix-1.oraclecloud.com\nconnection: keep-alive\naccept-encoding: gzip, deflate\naccept: */*\nuser-agent: Mozilla/5.0 (Macintosh; Intel Mac OS X 10_14_6) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/92.0.4515.159 Safari/537.36\ndate: Mon, 23 Aug 2021 21:57:48 GMT\nauthorization: <authorization and other headers>\n{\n \"displayName\": \"nginx worker processes\",\n \"specification\": {\n \"items\": [\n {\n \"processCommand\": \"nginx\",\n \"processUser\": \"opc\",\n \"processLineRegexPattern\": \"nginx: worker.\",\n \"label\": \"nginx-workers\"\n }\n ]\n }\n}\n"
x-obmcs-client-retries-enabled: true
x-related-resource: '#/definitions/ProcessSet'
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/UpdateProcessSetDetails'
description: The updated Process Set details.
required: true
/processSets/{processSetId}/actions/changeCompartment:
post:
description: 'Moves a ProcessSet resource from one compartment identifier to another. When provided, If-Match is checked against ETag values of the resource.
'
operationId: ChangeProcessSetCompartment
parameters:
- $ref: '#/components/parameters/ProcessSetIdPathParam'
- $ref: '#/components/parameters/IfMatchHeader'
- $ref: '#/components/parameters/RequestIdHeader'
- $ref: '#/components/parameters/RetryTokenHeader'
responses:
204:
description: The ProcessSet has been moved into the provided compartment.
headers:
opc-request-id:
description: 'Unique Oracle-assigned identifier for the request. If you need to contact
Oracle about a particular request, please provide the request ID.
'
schema:
type: string
401:
$ref: '#/components/responses/401'
404:
$ref: '#/components/responses/404'
409:
$ref: '#/components/responses/409'
412:
$ref: '#/components/responses/412'
429:
$ref: '#/components/responses/429'
500:
$ref: '#/components/responses/500'
summary: Moves a resource into a different compartment.
tags:
- stackMonitoring
x-example: 'POST /20210330/processSets/<processSetId>/actions/changeCompartment
Host: demohost.example.com
<authorization and other headers>
'
x-obmcs-client-retries-enabled: true
x-related-resource: '#/definitions/ProcessSet'
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/ChangeProcessSetCompartmentDetails'
description: The information to be updated.
required: true
/workRequests:
get:
description: 'Lists the work requests in a compartment.
'
operationId: ListWorkRequests
parameters:
- $ref: '#/components/parameters/CompartmentIdQueryParam'
- $ref: '#/components/parameters/WorkRequestIdQueryParam'
- $ref: '#/components/parameters/WorkRequestStatusQueryParam'
- $ref: '#/components/parameters/ResourceIdentifierQueryParam'
- $ref: '#/components/parameters/RequestIdHeader'
- $ref: '#/components/parameters/PaginationTokenQueryParam'
- $ref: '#/components/parameters/PaginationLimitQueryParam'
- $ref: '#/components/parameters/SortOrderQueryParam'
- $ref: '#/components/parameters/SortByListQueryParam'
responses:
200:
description: The list is being retrieved.
headers:
opc-next-page:
description: 'For pagination of a list of items. When paging through a list, if this header appears in the response,
then a partial list might have been returned. Include this value as the `page` parameter for the
subsequent GET request to get the next batch of items.
'
schema:
type: string
opc-request-id:
description: 'Unique Oracle-assigned identifier for the request. If you need to contact
Oracle about a particular request, please provide the request ID.
'
schema:
type: string
content:
application/json:
schema:
$ref: '#/components/schemas/WorkRequestSummaryCollection'
400:
$ref: '#/components/responses/400'
401:
$ref: '#/components/responses/401'
404:
$ref: '#/components/responses/404'
429:
$ref: '#/components/responses/429'
500:
$ref: '#/components/responses/500'
default:
$ref: '#/components/responses/default'
summary: List Work Requests
tags:
- stackMonitoring
x-example: 'GET /20210330/workRequests?compartmentId=<compartment_OCID>
Host: stack-monitoring.us-ashburn-1.oci.oraclecloud.com
<authorization and other headers>
'
x-obmcs-client-retries-enabled: true
x-related-resource: '#/definitions/WorkRequestSummaryCollection'
/workRequests/{workRequestId}:
get:
description: Gets the status of the work request with the given ID.
operationId: GetWorkRequest
parameters:
- $ref: '#/components/parameters/WorkRequestIdPathParam'
- $ref: '#/components/parameters/RequestIdHeader'
responses:
200:
description: The detail of the work request.
headers:
opc-request-id:
description: 'Unique Oracle-assigned identifier for the request. If you need to contact
Oracle about a particular request, please provide the request ID.
'
schema:
type: string
retry-after:
description: A decimal number representing the number of seconds the client should wait before polling this endpoint again.
schema:
type: integer
content:
application/json:
schema:
$ref: '#/components/schemas/WorkRequest'
400:
$ref: '#/components/responses/400'
401:
$ref: '#/components/responses/401'
404:
$ref: '#/components/responses/404'
429:
$ref: '#/components/responses/429'
500:
$ref: '#/components/responses/500'
default:
$ref: '#/components/responses/default'
summary: GET Work Request Status
tags:
- stackMonitoring
x-example: 'GET /20210330/workRequests/<stack_monitoring_work_request_OCID>
Host: stack-monitoring.us-ashburn-1.oci.oraclecloud.com
<authorization and other headers>
'
x-obmcs-client-retries-enabled: true
x-related-resource: '#/definitions/WorkRequest'
/workRequests/{workRequestId}/errors:
get:
description: 'Return a (paginated) list of errors for a given work request.
'
operationId: ListWorkRequestErrors
parameters:
- $ref: '#/components/parameters/WorkRequestIdPathParam'
- $ref: '#/components/parameters/RequestIdHeader'
- $ref: '#/components/parameters/PaginationTokenQueryParam'
- $ref: '#/components/parameters/PaginationLimitQueryParam'
- $ref: '#/components/parameters/SortOrderQueryParam'
- $ref: '#/components/parameters/SortByLogQueryParam'
responses:
200:
description: List of work request errors.
headers:
opc-next-page:
description: 'For pagination of a list of items. When paging through a list, if this header appears in the response,
then a partial list might have been returned. Include this value as the `page` parameter for the
subsequent GET request to get the next batch of items.
'
schema:
type: string
opc-request-id:
description: 'Unique Oracle-assigned identifier for the request. If you need to contact
Oracle about a particular request, please provide the request ID.
'
schema:
type: string
content:
application/json:
schema:
$ref: '#/components/schemas/WorkRequestErrorCollection'
400:
$ref: '#/components/responses/400'
401:
$ref: '#/components/responses/401'
404:
$ref: '#/components/responses/404'
429:
$ref: '#/components/responses/429'
500:
$ref: '#/components/responses/500'
default:
$ref: '#/components/responses/default'
summary: Lists work request errors
tags:
- stackMonitoring
x-example: 'GET /20210330/workRequests/<stack_monitoring_work_request_OCID>/errors
Host: stack-monitoring.us-ashburn-1.oci.oraclecloud.com
<authorization and other headers>
'
x-obmcs-client-retries-enabled: true
x-related-resource: '#/definitions/WorkRequestErrorCollection'
/workRequests/{workRequestId}/logs:
get:
description: 'Return a (paginated) list of logs for a given work request.
'
operationId: ListWorkRequestLogs
parameters:
- $ref: '#/components/parameters/WorkRequestIdPathParam'
- $ref: '#/components/parameters/RequestIdHeader'
- $ref: '#/components/parameters/PaginationTokenQueryParam'
- $ref: '#/components/parameters/PaginationLimitQueryParam'
- $ref: '#/components/parameters/SortOrderQueryParam'
- $ref: '#/components/parameters/SortByLogQueryParam'
responses:
200:
description: List of work request logs.
headers:
opc-next-page:
description: 'For pagination of a list of items. When paging through a list, if this header appears in the response,
then a partial list might have been returned. Include this value as the `page` parameter for the
subsequent GET request to get the next batch of items.
'
schema:
type: string
opc-request-id:
description: 'Unique Oracle-assigned identifier for the request. If you need to contact
Oracle about a particular request, please provide the request ID.
'
schema:
type: string
content:
application/json:
schema:
$ref: '#/components/schemas/WorkRequestLogEntryCollection'
400:
$ref: '#/components/responses/400'
401:
$ref: '#/components/responses/401'
404:
$ref: '#/components/responses/404'
429:
$ref: '#/components/responses/429'
500:
$ref: '#/components/responses/500'
default:
$ref: '#/components/responses/default'
summary: Lists work request logs
tags:
- stackMonitoring
x-example: 'GET /20210330/workRequests/<stack_monitoring_work_request_OCID>/logs
Host: stack-monitoring.us-ashburn-1.oci.oraclecloud.com
<authorization and other headers>
'
x-obmcs-client-retries-enabled: true
x-related-resource: '#/definitions/WorkRequestLogEntryCollection'
components:
schemas:
SearchMonitoredResourceAssociationsDetails:
description: The information required to search monitored resource associations.
properties:
associationType:
description: 'Association type filter to search associated resources.
'
maxLength: 255
minLength: 1
type: string
compartmentId:
description: 'Compartment Identifier [OCID](/Content/General/Concepts/identifiers.htm).
'
maxLength: 255
minLength: 1
type: string
destinationResourceId:
description: 'Destination Monitored Resource Identifier [OCID](/Content/General/Concepts/identifiers.htm).
'
maxLength: 255
minLength: 1
type: string
destinationResourceName:
description: 'Source Monitored Resource Name.
'
maxLength: 255
minLength: 1
type: string
destinationResourceType:
description: 'Source Monitored Resource Type.
'
maxLength: 255
minLength: 1
type: string
sortBy:
default: TIME_CREATED
description: 'The field to sort by. Only one sort order may be provided.
Default order for timeCreated is descending. Default order for assocType is descending.
'
enum:
- TIME_CREATED
- ASSOC_TYPE
type: string
sortOrder:
description: The sort order to use, either 'ASC' or 'DESC'.
enum:
- ASC
- DESC
type: string
x-default-description: 'The default value depends upon `sortBy`, and
in general is ''DESC'' when sorting by time and ''ASC'' otherwise.
'
x-obmcs-top-level-enum: '#/definitions/SortOrder'
sourceResourceId:
description: 'Source Monitored Resource Identifier [OCID](/Content/General/Concepts/identifiers.htm).
'
maxLength: 255
minLength: 1
type: string
sourceResourceName:
description: 'Source Monitored Resource Name.
'
maxLength: 255
minLength: 1
type: string
sourceResourceType:
description: 'Source Monitored Resource Type.
'
maxLength: 255
minLength: 1
type: string
required:
- compartmentId
type: object
DiscoveryJobCollection:
description: Result of the discovery Job search
properties:
items:
description: List of Discovery jobs
items:
$ref: '#/components/schemas/DiscoveryJobSummary'
type: array
required:
- items
type: object
ResourceLifecycleState:
description: 'Possible lifecycle states for monitored resource.
'
enum:
- CREATING
- UPDATING
- ACTIVE
- DELETING
- DELETED
- FAILED
type: string
AssociationDetails:
description: The information about monitored resource association.
properties:
associationType:
description: 'Association Type.
'
maxLength: 255
minLength: 1
type: string
sourceResourceId:
description: 'Source Monitored Resource Identifier [OCID](/Content/General/Concepts/identifiers.htm).
'
maxLength: 255
minLength: 1
type: string
required:
- sourceResourceId
- associationType
type: object
Error:
description: Error Information.
properties:
code:
description: A short error code that defines the error, meant for programmatic parsing.
type: string
message:
description: A human-readable error string.
type: string
required:
- code
- message
EvaluateBaselineableMetricResult:
description: Result for Baseline Metric Data evaluation
properties:
items:
description: List of Metric data
items:
$ref: '#/components/schemas/AnomalyMetricData'
type: array
resourceId:
description: OCID of the resource
maxLength: 255
minLength: 1
type: string
required:
- resourceId
- items
type: object
x-example: "{\n resourceId: \"ocid.resource.oc1.<unique_id>\",\n items: [\n {\n dimensions: [\n \"tablespaceName\": \"FINANCE\",\n \"hostName\", \"abc.xyc\"\n ],\n dataPoints: [\n {\n \"timestamp\": \"2023-05-15 05:13:00Z\",\n \"value\": 2.5,\n \"high\", 10,\n \"low\", 5\n \"anomaly\", -1\n },\n {\n \"timestamp\": \"2023-05-15 05:14:00Z\",\n \"value\": 2.5,\n \"high\", 10,\n \"low\", 5\n \"anomaly\", 0 \n }\n ]\n },\n {\n dimensions: [\n \"tablespaceName\": \"HR\",\n \"hostName\", \"abc.xyc\"\n ],\n dataPoints: [\n {\n \"timestamp\": \"2023-05-15 05:13:00Z\",\n \"value\": 2.5,\n \"high\", 10,\n \"low\", 5\n \"anomaly\", -1\n },\n {\n \"timestamp\": \"2023-05-15 05:14:00Z\",\n \"value\": 2.5,\n \"high\", 10,\n \"low\", 5\n \"anomaly\", 0 \n }\n ]\n }\n ]\n}\n"
SearchAssociatedResourcesDetails:
description: The criteria for searching associated monitored resources.
properties:
associationTypes:
default: []
description: 'Association types filter to be searched for finding associated resources.
'
example:
- contains
- uses
items:
type: string
maxItems: 5
type: array
compartmentId:
description: 'Compartment Identifier [OCID](/Content/General/Concepts/identifiers.htm).
'
example: ocid1.compartment.oc1.unique_id
maxLength: 255
minLength: 1
type: string
limitLevel:
default: 1
description: 'The field which determines the depth of hierarchy while searching for associated resources.
Possible values - 0 for all levels. And positive number to indicate different levels.
Default value is 1, which indicates 1st level associations.
'
minimum: 0
type: integer
resourceId:
description: 'Monitored resource identifier for which the associated resources should be fetched.
Either resourceId or resourceType should be provided.
'
example: ocid1.stackmonitoringresource.unique_resource_id
maxLength: 255
minLength: 1
type: string
resourceType:
description: 'A filter to return associated resources that match resources of type.
Either resourceId or resourceType should be provided.
'
example: ebs_instance
maxLength: 255
minLength: 1
type: string
required:
- compartmentId
type: object
x-example: "{\n \"compartmentId\": \"ocid1.compartment.oc1.<unique_id>\",\n \"type\": \"ebs_instance\",\n \"resourceId\" : \"uniue_resource_id\",\n \"associationTypes\": [\"contains\",\"uses\"],\n \"limitLevel\" : 2\n}\n"
DiscoveryJob:
description: The DiscoveryJob details.
properties:
compartmentId:
description: The OCID of the Compartment
maxLength: 255
minLength: 1
type: string
definedTags:
additionalProperties:
additionalProperties:
description: 'The value of the tag. Only string, integer and boolean types are supported.
'
type: object
description: 'Key-value pair representing predefined tags'' keys and values scoped to a namespace.
Example: `{"bar-key": "value"}`
'
type: object
description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace.
Example: `{"foo-namespace": {"bar-key": "value"}}`
'
type: object
discoveryClient:
description: Client who submits discovery job.
maxLength: 255
minLength: 0
type: string
discoveryDetails:
$ref: '#/components/schemas/DiscoveryDetails'
discoveryType:
default: ADD
description: 'Add option submits new discovery Job. Add with retry option to re-submit failed discovery job. Refresh option refreshes the existing discovered resources.
'
enum:
- ADD
- ADD_WITH_RETRY
- REFRESH
- PREREQ
- PREREQ_WITH_RETRY
type: string
freeformTags:
additionalProperties:
type: string
description: 'Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only.
Example: `{"bar-key": "value"}`
'
type: object
id:
description: The OCID of Discovery job
maxLength: 255
minLength: 1
type: string
lifecycleState:
description: The current state of the DiscoveryJob Resource.
enum:
- CREATING
- UPDATING
- ACTIVE
- DELETING
- DELETED
- FAILED
type: string
x-obmcs-top-level-enum: '#/definitions/LifecycleState'
status:
description: Specifies the status of the discovery job
enum:
- SUCCESS
- FAILURE
- INPROGRESS
- INACTIVE
- CREATED
- DELETED
- NEEDS_ATTENTION
type: string
statusMessage:
description: The short summary of the status of the discovery job
maxLength: 2000
minLength: 0
type: string
systemTags:
additionalProperties:
additionalProperties:
description: 'The value of the tag. Only string, integer and boolean types are supported.
'
type: object
description: 'Key-value pair representing system tags'' keys and values scoped to a namespace.
Example: `{"bar-key": "value"}`
'
type: object
description: 'Usage of system tag keys. These predefined keys are scoped to namespaces.
Example: `{"orcl-cloud": {"free-tier-retained": "true"}}`
'
type: object
tenantId:
description: The OCID of Tenant
maxLength: 255
minLength: 1
type: string
timeUpdated:
description: The time the discovery Job was updated.
format: date-time
type: string
userId:
description: The OCID of user in which the job is submitted
maxLength: 255
minLength: 1
type: string
required:
- id
type: object
MonitoredResourceTask:
description: The request details for importing resources from Telemetry.
properties:
compartmentId:
description: 'The [OCID](/Content/General/Concepts/identifiers.htm) of the compartment identifier.
'
maxLength: 255
minLength: 1
type: string
definedTags:
additionalProperties:
additionalProperties:
description: 'The value of the tag. Only string, integer and boolean types are supported.
'
type: object
description: 'Key-value pair representing predefined tags'' keys and values scoped to a namespace.
Example: `{"bar-key": "value"}`
'
type: object
description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace.
Example: `{"foo-namespace": {"bar-key": "value"}}`
'
type: object
freeformTags:
additionalProperties:
type: string
description: 'Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only.
Example: `{"bar-key": "value"}`
'
type: object
id:
description: Task identifier [OCID](/Content/General/Concepts/identifiers.htm).
maxLength: 255
minLength: 1
type: string
lifecycleState:
description: The current state of the stack monitoring resource task.
enum:
- ACCEPTED
- IN_PROGRESS
- WAITING
- FAILED
- SUCCEEDED
- CANCELING
- CANCELED
- NEEDS_ATTENTION
type: string
x-obmcs-top-level-enum: '#/definitions/MonitoredResourceTaskLifecycleState'
name:
description: Name of the task.
maxLength: 255
minLength: 1
type: string
systemTags:
additionalProperties:
additionalProperties:
description: 'The value of the tag. Only string, integer and boolean types are supported.
'
type: object
description: 'Key-value pair representing system tags'' keys and values scoped to a namespace.
Example: `{"bar-key": "value"}`
'
type: object
description: 'Usage of system tag keys. These predefined keys are scoped to namespaces.
Example: `{"orcl-cloud": {"free-tier-retained": "true"}}`
'
type: object
taskDetails:
$ref: '#/components/schemas/MonitoredResourceTaskDetails'
tenantId:
description: 'The [OCID](/Content/General/Concepts/identifiers.htm) of the tenancy.
'
maxLength: 255
minLength: 1
type: string
timeCreated:
description: "The date and time when the stack monitoring resource task was created, expressed in \n[RFC 3339](https://tools.ietf.org/html/rfc3339) timestamp format.\n"
format: date-time
type: string
timeUpdated:
description: 'The date and time when the stack monitoring resource task was last updated, expressed in
[RFC 3339](https://tools.ietf.org/html/rfc3339) timestamp format.
'
format: date-time
type: string
workRequestIds:
description: 'Identifiers [OCID](/Content/General/Concepts/identifiers.htm) for work requests submitted for this task.
'
example:
- ocid1.stackmonitoringworkrequest.oc1.iad.<unique_id_for_create>
items:
type: string
maxItems: 10
minItems: 0
type: array
required:
- id
- name
- compartmentId
- taskDetails
type: object
CredentialDetails:
description: DiscoveryJob Credential Details.
properties:
credentialName:
description: Name of Credential
maxLength: 255
minLength: 1
type: string
credentialType:
description: Name of Credential Type
maxLength: 128
minLength: 1
type: string
properties:
$ref: '#/components/schemas/PropertyDetails'
required:
- credentialName
- credentialType
- properties
type: object
CreateConfigDetails:
description: Create a configuration.
discriminator:
propertyName: configType
properties:
compartmentId:
description: Compartment in which the configuration is created.
maxLength: 255
minLength: 1
type: string
configType:
description: The type of configuration.
type: string
x-obmcs-enumref: '#/definitions/Config/configType'
definedTags:
additionalProperties:
additionalProperties:
description: 'The value of the tag. Only string, integer and boolean types are supported.
'
type: object
description: 'Key-value pair representing predefined tags'' keys and values scoped to a namespace.
Example: `{"bar-key": "value"}`
'
type: object
description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace.
Example: `{"foo-namespace": {"bar-key": "value"}}`
'
type: object
displayName:
description: The display name of the configuration.
maxLength: 255
minLength: 1
type: string
freeformTags:
additionalProperties:
type: string
description: 'Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only.
Example: `{"bar-key": "value"}`
'
type: object
required:
- compartmentId
- configType
type: object
MetricExtensionSummary:
description: Summary information about metric extension resources
properties:
collectionMethod:
description: Type of possible collection methods.
enum:
- OS_COMMAND
- SQL
- JMX
type: string
x-obmcs-top-level-enum: '#/definitions/MetricExtensionCollectionMethods'
compartmentId:
description: Compartment Identifier [OCID](/Content/General/Concepts/identifiers.htm)
maxLength: 255
minLength: 1
type: string
description:
description: Description of the metric extension.
maxLength: 400
minLength: 1
type: string
displayName:
description: Metric Extension resource display name.
maxLength: 255
minLength: 1
type: string
enabledOnResourcesCount:
default: 1
description: Count of resources on which this metric extension is enabled.
minimum: 1
type: integer
id:
description: The [OCID](/Content/General/Concepts/identifiers.htm) of metric extension.
maxLength: 255
minLength: 1
type: string
lifecycleState:
description: The current lifecycle state of the metric extension
enum:
- ACTIVE
- DELETED
type: string
x-obmcs-top-level-enum: '#/definitions/MetricExtensionLifeCycleStates'
name:
description: Metric Extension Resource name.
maxLength: 110
minLength: 1
type: string
resourceType:
description: Resource type to which Metric Extension applies
maxLength: 255
minLength: 1
type: string
resourceUri:
description: The URI path that the user can do a GET on to access the metric extension metadata
type: string
status:
description: The current state of the metric extension.
enum:
- DRAFT
- PUBLISHED
type: string
x-obmcs-top-level-enum: '#/definitions/MetricExtensionLifeCycleDetails'
timeCreated:
description: Metric Extension creation time. An RFC3339 formatted datetime string
format: date-time
type: string
timeUpdated:
description: Metric Extension updation time. An RFC3339 formatted datetime string
format: date-time
type: string
required:
- id
- name
- resourceType
- compartmentId
- status
type: object
x-example: "Sample Metric Extension Summary: \n{\n \"id\": \"ocid1.stackmonitoringmetricextension.oc1.iad.<unique_id>\",\n \"name\": \"ME_SqlDemo\",\n \"displayName\": \"SQL Demo\",\n \"description\": \"Metric Extension which demonstrates SQL collection method\",\n \"resourceType\": \"oci_oracle_cdb\",\n \"compartmentId\": \"ocid1.compartment.oc1..<unique_id>\",\n \"status\": \"DRAFT\",\n \"lifecycleState\": \"ACTIVE\",\n \"timeCreated\": \"2023-01-11T15:01:10.154Z\",\n \"timeUpdated\": \"2023-01-21T15:02:25.254Z\",\n \"collectionMethod\": \"SQL\",\n \"enabledOnResourcesCount\": \"23\",\n \"resourceUri\": \"/20210330/metricExtensions/ocid1.stackmonitoringmetricextension.oc1..<unique_id>\"\n}\n"
ConfigCollection:
description: Contains a list of configurations.
properties:
items:
description: List of configurations.
items:
$ref: '#/components/schemas/ConfigSummary'
type: array
required:
- items
type: object
ChangeProcessSetCompartmentDetails:
description: Payload describing to which compartment the resource should be moved.
properties:
compartmentId:
description: 'The [OCID](/Content/General/Concepts/identifiers.htm) of the compartment
into which the resource should be moved.
'
maxLength: 255
minLength: 1
type: string
required:
- compartmentId
type: object
x-example: "1. Example of a ChangeProcessSetCompartmentDetails object.\n {\n \"compartmentId\": \"ocid1.compartment.oc1.<unique_id>\"\n }\n"
WorkRequestSummaryCollection:
description: Results of a workRequest search. Contains both WorkRequest items and other information, such as metadata.
properties:
items:
description: List of workRequestSummary objects.
items:
$ref: '#/components/schemas/WorkRequestSummary'
type: array
required:
- items
type: object
x-example: "{\n items: [\n {\n \"operationType\": \"CREATE_RESOURCES\",\n \"status\": \"SUCCEEDED\",\n \"id\": \"ocid1.stackmonitoringworkrequest.oc1.iad.<unique_id>\",\n \"compartmentId\": \"ocid1.comapertment.oc1..<unique_id>\",\n \"resources\": [\n {\n \"entityType\": \"stackmonitoringresource\",\n \"actionType\": \"CREATED\"\n \"identifier\": \"ocid1.stackmonitoringresource.oc1.iad.<unique_id>\",\n \"entityUri\": \"/monitoredResources/ocid1.stackmonitoringresource.oc1.iad.<unique_id>\"\n }\n ],\n \"percentComplete\": 100,\n \"timeAccepted\": \"2021-11-29T19:11:37.920+0100\",\n \"timeStarted\": \"2021-11-29T19:11:55.920+0100\",\n \"timeFinished\": \"2021-11-29T19:13:37.920+0100\"\n }\n ]\n}\n"
MonitoredResourceTaskSummary:
description: The summary details for the task.
properties:
definedTags:
additionalProperties:
additionalProperties:
description: 'The value of the tag. Only string, integer and boolean types are supported.
'
type: object
description: 'Key-value pair representing predefined tags'' keys and values scoped to a namespace.
Example: `{"bar-key": "value"}`
'
type: object
description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace.
Example: `{"foo-namespace": {"bar-key": "value"}}`
'
type: object
freeformTags:
additionalProperties:
type: string
description: 'Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only.
Example: `{"bar-key": "value"}`
'
type: object
id:
description: 'Task identifier [OCID](/Content/General/Concepts/identifiers.htm).
'
maxLength: 255
minLength: 1
type: string
lifecycleState:
description: The current state of the stack monitoring resource task.
enum:
- ACCEPTED
- IN_PROGRESS
- WAITING
- FAILED
- SUCCEEDED
- CANCELING
- CANCELED
- NEEDS_ATTENTION
type: string
x-obmcs-top-level-enum: '#/definitions/MonitoredResourceTaskLifecycleState'
name:
description: Name of the task.
maxLength: 255
minLength: 1
type: string
systemTags:
additionalProperties:
additionalProperties:
description: 'The value of the tag. Only string, integer and boolean types are supported.
'
type: object
description: 'Key-value pair representing system tags'' keys and values scoped to a namespace.
Example: `{"bar-key": "value"}`
'
type: object
description: 'Usage of system tag keys. These predefined keys are scoped to namespaces.
Example: `{"orcl-cloud": {"free-tier-retained": "true"}}`
'
type: object
taskDetails:
$ref: '#/components/schemas/MonitoredResourceTaskDetails'
timeCreated:
description: "The date and time when the stack monitoring resource task was created, expressed in \n[RFC 3339](https://tools.ietf.org/html/rfc3339) timestamp format.\n"
format: date-time
type: string
timeUpdated:
description: 'The date and time when the stack monitoring resource task was last updated, expressed in
[RFC 3339](https://tools.ietf.org/html/rfc3339) timestamp format.
'
format: date-time
type: string
workRequestIds:
description: 'Identifiers [OCID](/Content/General/Concepts/identifiers.htm) for work requests submitted for this task.
'
example:
- ocid1.stackmonitoringworkrequest.oc1.iad.<unique_id_for_create>
items:
type: string
type: array
required:
- id
- name
- taskDetails
type: object
Metric:
description: Details of a metric which is part of this metric extension
properties:
computeExpression:
description: Compute Expression to calculate the value of this metric
maxLength: 255
minLength: 1
type: string
dataType:
description: Data type of value of this metric
enum:
- STRING
- NUMBER
type: string
displayName:
description: Display name of the metric.
maxLength: 255
minLength: 1
type: string
isDimension:
default: false
description: Current metric need to be included as dimension or not
type: boolean
isHidden:
default: false
description: Flag to marks whether a metric has to be uploaded or not. When isHidden = false -> Metric is uploaded, isHidden = true -> Metric is NOT uploaded
type: boolean
metricCategory:
description: Metric category
enum:
- LOAD
- UTILIZATION
- CAPACITY
- AVAILABILITY
type: string
name:
description: Name of the metric.
maxLength: 110
minLength: 1
type: string
unit:
description: Unit of metric value
maxLength: 255
minLength: 1
type: string
required:
- name
- dataType
type: object
ProcessSetSpecificationDetails:
description: Details of a single regular expression specification in a Process Set.
properties:
label:
description: Optional label used to identify a single filter.
maxLength: 255
minLength: 1
type: string
processCommand:
description: String literal used for exact matching on process name.
maxLength: 255
type: string
processLineRegexPattern:
description: Regex pattern matching on process arguments.
maxLength: 255
minLength: 1
type: string
processUser:
description: String literal used for exact matching on process user.
maxLength: 255
type: string
type: object
x-example: "1. Example of a ProcessSetSpecificationDetails object.\n {\n \"processCommand\": \"nginx\",\n \"processUser\": \"opc\",\n \"processLineRegexPattern\": \"nginx: worker.\",\n \"label\": \"nginx-workers\"\n }\n"
CreateDiscoveryJobDetails:
description: The request of DiscoveryJob details.
properties:
compartmentId:
description: The OCID of Compartment
maxLength: 255
minLength: 1
type: string
definedTags:
additionalProperties:
additionalProperties:
description: 'The value of the tag. Only string, integer and boolean types are supported.
'
type: object
description: 'Key-value pair representing predefined tags'' keys and values scoped to a namespace.
Example: `{"bar-key": "value"}`
'
type: object
description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace.
Example: `{"foo-namespace": {"bar-key": "value"}}`
'
type: object
discoveryClient:
description: Client who submits discovery job.
maxLength: 255
minLength: 0
type: string
discoveryDetails:
$ref: '#/components/schemas/DiscoveryDetails'
discoveryType:
default: ADD
description: 'Add option submits new discovery Job. Add with retry option to re-submit failed discovery job. Refresh option refreshes the existing discovered resources.
'
enum:
- ADD
- ADD_WITH_RETRY
- REFRESH
- PREREQ
- PREREQ_WITH_RETRY
type: string
freeformTags:
additionalProperties:
type: string
description: 'Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only.
Example: `{"bar-key": "value"}`
'
type: object
shouldPropagateTagsToDiscoveredResources:
default: true
description: "If this parameter set to true, the specified tags will be applied \nto all resources discovered in the current request. \nDefault is true.\n"
type: boolean
required:
- discoveryDetails
- compartmentId
type: object
x-example: "1.Sample example for ADD discovery type with EBS resource type\n {\n \"discoveryType\": \"ADD\",\n \"discoveryClient\": \"APPMGMT\",\n \"compartmentId\": \"ocid1.compartment.oc1.<unique_id>\",\n \"discoveryDetails\": {\n \"agentId\": \"ocid1.managementagent.oc1.iad.<unique_id>\",\n \"resourceType\": \"EBS_INSTANCE\",\n \"resourceName\": \"ebstest\",\n \"license\": \"ENTERPRISE_EDITION\",\n \"properties\": {\n \"propertiesMap\": {\n \"ebs_version\": \"12.2\",\n \"ebs_admin_server_host\":\"somehostname.oracle.com\",\n \"ebs_admin_server_port\":\"7001\",\n \"ebs_admin_server_protocol\":\"t3\",\n \"ebs_db_host\":\"somehostname.oracle.com\",\n \"ebs_db_port\": \"1521\",\n \"ebs_db_service_name\":\"PROD\",\n \"ebs_discover_db\":\"true\"\n }\n },\n \"credentials\": {\n \"items\": [\n {\n \"credentialName\" : \"Test==\",\n \"credentialType\" : \"Test==\",\n \"properties\": {\n \"propertiesMap\": {\n \"DBUserName\": \"testuser==\",\n \"DBPassword\": \"testPassword=\",\n \"DBRole\":\"Tk9STUFM\"\n }\n }\n },\n {\n \"credentialName\": \"Test==\",\n \"credentialType\": \"Test==\",\n \"properties\": {\n \"propertiesMap\": {\n \"Username\": \"testuser==\",\n \"Password\": \"testPassword=\"\n }\n }\n }\n ]\n }\n }\n }\n2.Sample example for ADD discovery type with Weblogic resource type\n {\n \"discoveryType\": \"ADD\",\n \"discoveryClient\": \"APPMGMT\",\n \"compartmentId\": \"ocid1.compartment.oc1.<unique_id>\",\n \"discoveryDetails\": {\n \"agentId\": \"ocid1.managementagent.oc1.iad.<unique_id>\",\n \"resourceType\": \"WEBLOGIC_DOMAIN\",\n \"resourceName\": \"weblogicTest\",\n \"license\": \"ENTERPRISE_EDITION\",\n \"properties\": {\n \"propertiesMap\": {\n \"admin_server_host\":\"somehostname.oracle.com\",\n \"admin_server_port\":\"7001\",\n \"admin_server_protocol\":\"t3\"\n }\n },\n \"credentials\": {\n \"items\": [\n {\n \"credentialName\": \"Test==\",\n \"credentialType\": \"Test==\",\n \"properties\": {\n \"propertiesMap\": {\n \"Username\": \"testuser==\",\n \"Password\": \"testPassword=\"\n }\n }\n }\n ]\n }\n }\n }\n3.Sample example for ADD discovery type with Oracle Database resource type\n {\n \"discoveryType\": \"ADD\",\n \"discoveryClient\": \"APPMGMT\",\n \"compartmentId\": \"ocid1.compartment.oc1.<unique_id>\",\n \"discoveryDetails\": {\n \"agentId\": \"ocid1.managementagent.oc1.iad.<unique_id>\",\n \"resourceType\": \"ORACLE_DATABASE\",\n \"resourceName\": \"DBTEST_NOCDB1\",\n \"license\": \"ENTERPRISE_EDITION\",\n \"properties\": {\n \"propertiesMap\": {\n \"database_port\": \"1521\",\n \"database_host_name\":\"somehostname.oracle.com\",\n \"database_service_name\":\"ebsdb\"\n }\n },\n \"credentials\": {\n \"items\": [\n {\n \"credentialName\" : \"Test==\",\n \"credentialType\" : \"Test==\",\n \"properties\": {\n \"propertiesMap\": {\n \"DBUserName\": \"testuser==\",\n \"DBPassword\": \"testPassword=\",\n \"DBRole\":\"Tk9STUFM\"\n }\n }\n }\n ]\n }\n }\n }\n4.Sample example for ADD_WITH_RETRY discovery type with Weblogic resource type\n {\n \"discoveryType\": \"ADD_WITH_RETRY\",\n \"discoveryClient\": \"appmgmt\",\n \"compartmentId\": \"ocid1.compartment.oc1.<unique_id>\",\n \"discoveryDetails\": {\n \"agentId\": \"ocid1.managementagent.oc1.iad.<unique_id>\",\n \"resourceType\": \"WEBLOGIC_DOMAIN\",\n \"resourceName\": \"weblogic_retry\",\n \"license\": \"ENTERPRISE_EDITION\",\n \"properties\": {\n \"propertiesMap\": {\n \"retry_job_id\" :\"ocid1.stackmonitoringdiscoveryjob.oc1.iad.<unique_id>\",\n \"admin_server_port\": \"7001\",\n \"admin_server_protocol\":\"t3\",\n \"admin_server_host\":\"somehostname.oracle.com\"\n }\n },\n \"credentials\": {\n \"items\": [\n {\n \"credentialName\": \"Test==\",\n \"credentialType\": \"Test==\",\n \"properties\": {\n \"propertiesMap\": {\n \"Username\": \"testuser==\",\n \"Password\": \"testPassword=\"\n }\n }\n }\n ]\n }\n }\n }\n5.Sample example for REFRESH discovery type with Weblogic resource type\n {\n \"discoveryType\": \"REFRESH\",\n \"discoveryClient\": \"appmgmt\",\n \"compartmentId\": \"ocid1.compartment.oc1.<unique_id>\",\n \"discoveryDetails\": {\n \"agentId\": \"ocid1.managementagent.oc1.iad.<unique_id>\",\n \"resourceType\": \"WEBLOGIC_DOMAIN\",\n \"resourceName\": \"weblogic_refresh\",\n \"license\": \"ENTERPRISE_EDITION\",\n \"properties\": {\n \"propertiesMap\": {\n \"resource_id\": \"ocid1.stackmonitoringresource.oc1.iad.<unique_id>\"\n }\n }\n }\n }\n"
EvaluateBaselineableMetricDetails:
description: Details for Baseline Metric Data to evaluate
properties:
items:
description: List of Metric data
items:
$ref: '#/components/schemas/MetricData'
type: array
resourceId:
description: OCID of the resource
maxLength: 255
minLength: 1
type: string
required:
- resourceId
- items
type: object
x-example: "{\n resourceId: \"ocid.resource.oc1.<unique_id>\",\n items: [\n {\n dimensions: [\n \"tablespaceName\": \"FINANCE\",\n \"hostName\", \"abc.xyc\"\n ],\n trainingDataPoints: [\n {\n \"timestamp\": \"2023-05-15 05:13:00Z\",\n \"value\": 2.5\n },\n {\n \"timestamp\": \"2023-05-15 05:14:00Z\",\n \"value\": 2.5\n }\n ]\n },\n {\n dimensions: [\n \"tablespaceName\": \"HR\",\n \"hostName\", \"abc.xyc\"\n ],\n trainingDataPoints: [\n {\n \"timestamp\": \"2023-05-15 05:13:00Z\",\n \"value\": 3.5\n },\n {\n \"timestamp\": \"2023-05-15 05:14:00Z\",\n \"value\": 3.5\n }\n ]\n }\n ]\n}\n"
WorkRequestSummary:
description: A summary of the status of a work request.
properties:
compartmentId:
description: 'The ocid of the compartment that contains the work request. Work requests should be scoped to
the same compartment as the resource the work request affects. If the work request affects multiple resources,
and those resources are not in the same compartment, it is up to the service team to pick the primary
resource whose compartment should be used
'
type: string
id:
description: The id of the work request.
type: string
operationType:
description: Type of the work request
enum:
- CREATE_RESOURCES
- UPDATE_RESOURCES
- DELETE_RESOURCES
- MOVE_RESOURCES
- ENABLE_EXTERNAL_DATABASE
- DISABLE_EXTERNAL_DATABASE
- ADD_SOURCES_TO_AGENT
- ENABLE_METRIC_EXTENSION
- DISABLE_METRIC_EXTENSION
- TEST_METRIC_EXTENSION
- BULK_ADD_RESOURCES
- BULK_DELETE_RESOURCES
- UPDATE_AND_PROPAGATE_TAGS
- IMPORT_RESOURCES
type: string
x-obmcs-top-level-enum: '#/definitions/OperationType'
percentComplete:
description: Percentage of the request completed.
format: float
type: number
resources:
description: The resources affected by this work request.
items:
$ref: '#/components/schemas/WorkRequestResource'
type: array
status:
description: Status of current work request.
enum:
- ACCEPTED
- IN_PROGRESS
- WAITING
- FAILED
- SUCCEEDED
- CANCELING
- CANCELED
type: string
x-obmcs-top-level-enum: '#/definitions/OperationStatus'
timeAccepted:
description: 'The date and time the request was created, as described in
[RFC 3339](https://tools.ietf.org/rfc/rfc3339), section 14.29.
'
format: date-time
type: string
timeFinished:
description: 'The date and time the object was finished, as described in [RFC 3339](https://tools.ietf.org/rfc/rfc3339).
'
format: date-time
type: string
timeStarted:
description: 'The date and time the request was started, as described in [RFC 3339](https://tools.ietf.org/rfc/rfc3339),
section 14.29.
'
format: date-time
type: string
required:
- operationType
- status
- id
- compartmentId
- resources
- percentComplete
- timeAccepted
x-example: "{\n \"operationType\": \"CREATE_RESOURCES\",\n \"status\": \"SUCCEEDED\",\n \"id\": \"ocid1.stackmonitoringworkrequest.oc1.iad.<unique_id>\",\n \"compartmentId\": \"ocid1.comapertment.oc1..<unique_id>\",\n \"resources\": [\n {\n \"entityType\": \"stackmonitoringresource\",\n \"actionType\": \"CREATED\"\n \"identifier\": \"ocid1.stackmonitoringresource.oc1.iad.<unique_id>\",\n \"entityUri\": \"/monitoredResources/ocid1.stackmonitoringresource.oc1.iad.<unique_id>\"\n }\n ],\n \"percentComplete\": 100,\n \"timeAccepted\": \"2021-11-29T19:11:37.920+0100\",\n \"timeStarted\": \"2021-11-29T19:11:55.920+0100\",\n \"timeFinished\": \"2021-11-29T19:13:37.920+0100\"\n}\n"
AnomalyDataPoint:
allOf:
- $ref: '#/components/schemas/DataPoint'
- properties:
anomaly:
description: if the value is anomaly or not 0 indicates not an anomaly -1 indicates value is below the threshold +1 indicates value is above the threshold
format: double
maximum: 1
minimum: -1
type: number
high:
description: upper threshold for the metric value
format: double
type: number
low:
description: lower threshold for the metric value
format: double
type: number
required:
- anomaly
type: object
description: anomaly evaluation result fo the data point
x-example: "{\n \"timestamp\": \"2023-05-16 05:13:00Z\",\n \"value\": 3.5,\n \"high\", 10,\n \"low\", 5\n \"anomaly\", -1\n}\n"
UpdateMonitoredResourceTypeDetails:
description: The information to be updated for the monitored resource type.
properties:
definedTags:
additionalProperties:
additionalProperties:
description: 'The value of the tag. Only string, integer and boolean types are supported.
'
type: object
description: 'Key-value pair representing predefined tags'' keys and values scoped to a namespace.
Example: `{"bar-key": "value"}`
'
type: object
description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace.
Example: `{"foo-namespace": {"bar-key": "value"}}`
'
type: object
description:
description: A friendly description.
maxLength: 255
minLength: 1
type: string
displayName:
description: Monitored resource type display name.
maxLength: 255
minLength: 1
type: string
freeformTags:
additionalProperties:
type: string
description: 'Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only.
Example: `{"bar-key": "value"}`
'
type: object
metadata:
$ref: '#/components/schemas/ResourceTypeMetadataDetails'
metricNamespace:
description: Metric namespace for resource type.
maxLength: 255
minLength: 1
type: string
resourceCategory:
description: 'Resource Category to indicate the kind of resource type.
'
enum:
- APPLICATION
- DATABASE
- MIDDLEWARE
- UNKNOWN
type: string
x-obmcs-top-level-enum: '#/definitions/ResourceCategory'
sourceType:
description: 'Source type to indicate if the resource is stack monitoring discovered, OCI native resource, etc.
'
enum:
- SM_MGMT_AGENT_MONITORED
- SM_REPO_ONLY
- OCI_NATIVE
- PROMETHEUS
- TELEGRAF
- COLLECTD
type: string
x-obmcs-top-level-enum: '#/definitions/SourceType'
type: object
x-example: "{\n \"displayName\": \"CustomHost123\",\n \"description\": \"System defined monitoring resource type for host resource type\",\n \"metricNamespace\": \"oracle_appmgmt\",\n \"sourceType\": \"OCI_NATIVE\",\n \"resourceCategory\": \"APPLICATION\",\n \"metadata\": {\n \"format\" : \"SYSTEM_FORMAT\",\n \"requiredProperties\": [\"osName\",\"osVersion\"],\n \"agentProperties\": [\"hostType\",\"osType\",\"osName\",\"osVersion\"],\n \"validPropertiesForCreate\": [\"osName\",\"osVersion\"],\n \"validPropertiesForUpdate\": [\"osName\",\"osVersion\",\"hostType\", \"osType\"],\n \"uniquePropertySets\":[\n {\n \"properties\":[\"host_uuid\"]\n }\n ],\n \"validPropertyValues\":{\n \"osType\":[\"Linux\"]\n }\n },\n \"freeformTags\": {},\n \"definedTags\": {\n \"discoveryTags\": {\n \"stack\": \"middleware\"\n }\n }\n}\n"
CreateMonitoredResourceTypeDetails:
description: "The information about new monitored resource type. The resource type name should be unique across tenancy.\nA set of resource types are created by the service by default. These resource types are available \nfor all tenancies. Service provided resource types can not be duplicated or overwritten in any tenancy.\n"
properties:
compartmentId:
description: 'The [OCID](/Content/General/Concepts/identifiers.htm) of the tenancy containing the resource type.
'
maxLength: 255
minLength: 1
type: string
definedTags:
additionalProperties:
additionalProperties:
description: 'The value of the tag. Only string, integer and boolean types are supported.
'
type: object
description: 'Key-value pair representing predefined tags'' keys and values scoped to a namespace.
Example: `{"bar-key": "value"}`
'
type: object
description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace.
Example: `{"foo-namespace": {"bar-key": "value"}}`
'
type: object
description:
description: A friendly description.
maxLength: 255
minLength: 1
type: string
displayName:
description: Monitored resource type display name.
maxLength: 255
minLength: 1
type: string
freeformTags:
additionalProperties:
type: string
description: 'Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only.
Example: `{"bar-key": "value"}`
'
type: object
metadata:
$ref: '#/components/schemas/ResourceTypeMetadataDetails'
metricNamespace:
description: Metric namespace for resource type.
maxLength: 255
minLength: 1
type: string
name:
description: "A unique monitored resource type name. The name must be unique across tenancy. \nName can not be changed.\n"
maxLength: 255
minLength: 1
type: string
resourceCategory:
description: 'Resource Category to indicate the kind of resource type.
'
enum:
- APPLICATION
- DATABASE
- MIDDLEWARE
- UNKNOWN
type: string
x-obmcs-top-level-enum: '#/definitions/ResourceCategory'
sourceType:
description: 'Source type to indicate if the resource is stack monitoring discovered, OCI native resource, etc.
'
enum:
- SM_MGMT_AGENT_MONITORED
- SM_REPO_ONLY
- OCI_NATIVE
- PROMETHEUS
- TELEGRAF
- COLLECTD
type: string
x-obmcs-top-level-enum: '#/definitions/SourceType'
required:
- name
- compartmentId
type: object
x-example: "{\n \"compartmentId\": \"ocid1.tenancy.oc1.<unique_id>\",\n \"name\": \"postgresql\",\n \"displayName\": \"Postgres SQL Server\",\n \"description\": \"Created by telegraf\",\n \"metricNamespace\": \"postgresql\",\n \"sourceType\": \"OCI_NATIVE\",\n \"resourceCategory\": \"APPLICATION\",\n \"metadata\": {\n \"format\" : \"SYSTEM_FORMAT\",\n \"requiredProperties\": [\"osName\",\"osVersion\"],\n \"agentProperties\": [\"hostType\",\"osType\",\"osName\",\"osVersion\"],\n \"validPropertiesForCreate\": [\"osName\",\"osVersion\"],\n \"validPropertiesForUpdate\": [\"osName\",\"osVersion\",\"hostType\", \"osType\"],\n \"uniquePropertySets\":[\n {\n \"properties\":[\"host_uuid\"]\n }\n ],\n \"validPropertyValues\":{\n \"osType\":[\"Linux\"]\n }\n },\n \"freeformTags\": {},\n \"definedTags\": {\n \"discoveryTags\": {\n \"stack\": \"middleware\"\n }\n }\n}\n"
MonitoredResourceMembersCollection:
description: Results of a member search.
properties:
items:
description: 'List of member resources.
'
items:
$ref: '#/components/schemas/MonitoredResourceMemberSummary'
type: array
required:
- items
type: object
MonitoredResourceTaskDetails:
description: The request details for the performing the task.
discriminator:
propertyName: type
properties:
type:
description: Task type.
enum:
- IMPORT_OCI_TELEMETRY_RESOURCES
type: string
required:
- type
type: object
ProcessSetCollection:
description: Result of the Process Set fetch.
properties:
items:
description: List of Process Sets.
items:
$ref: '#/components/schemas/ProcessSetSummary'
type: array
required:
- items
type: object
x-example: "1. Example of a ProcessSetCollection object.\n {\n \"items\": [\n {\n \"id\": \"ocid1.stackmonitoringprocesset.oc1.<unique_id>\",\n \"compartmentId\": \"ocid1.compartment.oc1.<unique_id>\",\n \"lifecycleState\": \"ACTIVE\",\n \"displayName\": \"nginx workers\",\n \"specification\": {\n \"items\": [\n {\n \"processCommand\": \"nginx\",\n \"processUser\": \"opc\",\n \"processLineRegexPattern\": \"nginx: worker.\",\n \"label\": \"nginx-workers\"\n }\n ]\n },\n \"revision\": \"5\"\n },\n {\n \"id\": \"ocid1.stackmonitoringprocesset.oc1.<unique_id>\",\n \"compartmentId\": \"ocid1.compartment.oc1.<unique_id>\",\n \"lifecycleState\": \"ACTIVE\",\n \"displayName\": \"SomeOtherApp\",\n \"specification\": {\n \"items\": [\n {\n \"processCommandRegexPattern\": \"^processName$\",\n \"processUser\": \"opc\",\n \"processLineRegexPattern\": \"nginx: worker.\",\n \"label\": \"nginx-workers\"\n }\n ]\n },\n \"revision\": \"5\"\n }\n ]\n }\n"
MetricExtensionQueryProperties:
description: Collection method and query properties details of metric extension
discriminator:
propertyName: collectionMethod
properties:
collectionMethod:
description: Type of possible collection methods.
enum:
- OS_COMMAND
- SQL
- JMX
type: string
x-obmcs-top-level-enum: '#/definitions/MetricExtensionCollectionMethods'
required:
- collectionMethod
type: object
EnabledResourceDetails:
description: Details of a resource on which Metric Extension is enabled
properties:
resourceId:
description: The OCID of the resource on which Metric Extension is enabled
maxLength: 255
minLength: 1
type: string
required:
- resourceId
type: object
MonitoredResourceSummary:
description: The information about monitored resource.
properties:
compartmentId:
description: Compartment Identifier [OCID](/Content/General/Concepts/identifiers.htm).
maxLength: 255
minLength: 1
type: string
definedTags:
additionalProperties:
additionalProperties:
description: 'The value of the tag. Only string, integer and boolean types are supported.
'
type: object
description: 'Key-value pair representing predefined tags'' keys and values scoped to a namespace.
Example: `{"bar-key": "value"}`
'
type: object
description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace.
Example: `{"foo-namespace": {"bar-key": "value"}}`
'
type: object
displayName:
description: Monitored resource display name.
maxLength: 255
minLength: 1
type: string
externalId:
description: 'External resource is any OCI resource identifier [OCID](/Content/General/Concepts/identifiers.htm)
which is not a Stack Monitoring service resource.
'
maxLength: 255
minLength: 1
type: string
freeformTags:
additionalProperties:
type: string
description: 'Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only.
Example: `{"bar-key": "value"}`
'
type: object
hostName:
description: 'Monitored Resource Host Name.
'
maxLength: 255
minLength: 1
type: string
id:
description: 'Monitored resource identifier [OCID](/Content/General/Concepts/identifiers.htm).
'
maxLength: 255
minLength: 1
type: string
license:
description: License edition of the monitored resource.
enum:
- STANDARD_EDITION
- ENTERPRISE_EDITION
type: string
x-obmcs-top-level-enum: '#/definitions/LicenseType'
lifecycleState:
description: The current state of the monitored resource.
enum:
- CREATING
- UPDATING
- ACTIVE
- DELETING
- DELETED
- FAILED
type: string
x-obmcs-top-level-enum: '#/definitions/ResourceLifecycleState'
managementAgentId:
description: Management Agent Identifier [OCID](/Content/General/Concepts/identifiers.htm).
maxLength: 255
minLength: 1
type: string
name:
description: 'Monitored Resource Name.
'
maxLength: 255
minLength: 1
type: string
properties:
description: 'List of monitored resource properties.
'
items:
$ref: '#/components/schemas/MonitoredResourceProperty'
type: array
resourceCategory:
description: 'Resource Category to indicate the kind of resource type.
'
enum:
- APPLICATION
- DATABASE
- MIDDLEWARE
- UNKNOWN
type: string
x-obmcs-top-level-enum: '#/definitions/ResourceCategory'
sourceType:
description: 'Source type to indicate if the resource is stack monitoring discovered, OCI native resource, etc.
'
enum:
- SM_MGMT_AGENT_MONITORED
- SM_REPO_ONLY
- OCI_NATIVE
- PROMETHEUS
- TELEGRAF
- COLLECTD
type: string
x-obmcs-top-level-enum: '#/definitions/SourceType'
systemTags:
additionalProperties:
additionalProperties:
description: 'The value of the tag. Only string, integer and boolean types are supported.
'
type: object
description: 'Key-value pair representing system tags'' keys and values scoped to a namespace.
Example: `{"bar-key": "value"}`
'
type: object
description: 'Usage of system tag keys. These predefined keys are scoped to namespaces.
Example: `{"orcl-cloud": {"free-tier-retained": "true"}}`
'
type: object
timeCreated:
description: 'Monitored resource creation time. An RFC3339 formatted datetime string.
'
format: date-time
type: string
timeUpdated:
description: 'Monitored resource update time. An RFC3339 formatted datetime string.
'
format: date-time
type: string
type:
description: 'Monitored Resource Type.
'
maxLength: 255
minLength: 1
type: string
required:
- id
- name
- type
type: object
ChangeMetricExtensionCompartmentDetails:
description: The information to be updated.
properties:
compartmentId:
description: 'The [OCID](/Content/General/Concepts/identifiers.htm) of the compartment
into which the resource should be moved.
'
maxLength: 255
minLength: 1
type: string
required:
- compartmentId
type: object
ManageLicenseDetails:
description: 'License information for a given resource.
'
properties:
license:
description: License edition of the monitored resource.
enum:
- STANDARD_EDITION
- ENTERPRISE_EDITION
type: string
x-obmcs-top-level-enum: '#/definitions/LicenseType'
required:
- license
type: object
x-example: "{\n \"license\" : \"ENTERPRISE_EDITION\"\n}\n"
DiscoveryJobLogSummary:
description: Log of a specific job
properties:
id:
description: The OCID of Discovery job
maxLength: 255
minLength: 1
type: string
logMessage:
description: Log message
maxLength: 2000
minLength: 1
type: string
logType:
description: Type of log (INFO, WARNING, ERROR or SUCCESS)
enum:
- INFO
- WARNING
- ERROR
- SUCCESS
type: string
systemTags:
additionalProperties:
additionalProperties:
description: 'The value of the tag. Only string, integer and boolean types are supported.
'
type: object
description: 'Key-value pair representing system tags'' keys and values scoped to a namespace.
Example: `{"bar-key": "value"}`
'
type: object
description: 'Usage of system tag keys. These predefined keys are scoped to namespaces.
Example: `{"orcl-cloud": {"free-tier-retained": "true"}}`
'
type: object
timeCreated:
description: Time the Job log was created
format: date-time
type: string
required:
- id
- logType
- logMessage
- timeCreated
type: object
x-example: "{\n \"id\": \"ocid1.instance.oc1.iad.<unique_id>\",\n \"logType\": \"INFO\",\n \"logMessage\": \"HereIsTheLogMessage\",\n \"timeCreated\": \"2021-10-27T17:05:50.347+0200\",\n}\n"
UpdateBaselineableMetricDetails:
allOf:
- $ref: '#/components/schemas/BaselineableMetricSummary'
- type: object
description: Summary for the baseline-able metric
x-example: "{\n \"id\": \"ocid.smad.oc1.<unique_id>\",\n \"tenancyId\": \"ocid.tenancy.oc1.<unique_id>\",\n \"compartmentId\": \"ocid.compartment.oc1.<unique_id>\",\n \"name\": \"Memory\",\n \"column\":\"MemoryUtilization\",\n \"namespace\": \"oracle_appmgmt\",\n \"resourceGroup\": \"oracle_database\",\n \"isOutOfBox\": TRUE,\n \"lifecycleState\": \"ACTIVE\"\n}\n"
ConfigSummary:
description: Summary of the configuration.
discriminator:
propertyName: configType
properties:
compartmentId:
description: Compartment Identifier.
type: string
configType:
description: The type of configuration.
type: string
x-obmcs-enumref: '#/definitions/Config/configType'
definedTags:
additionalProperties:
additionalProperties:
description: 'The value of the tag. Only string, integer and boolean types are supported.
'
type: object
description: 'Key-value pair representing predefined tags'' keys and values scoped to a namespace.
Example: `{"bar-key": "value"}`
'
type: object
description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace.
Example: `{"foo-namespace": {"bar-key": "value"}}`
'
type: object
displayName:
description: Config Identifier, can be renamed.
type: string
freeformTags:
additionalProperties:
type: string
description: 'Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only.
Example: `{"bar-key": "value"}`
'
type: object
id:
description: Unique identifier that is immutable on creation.
type: string
lifecycleState:
description: The current state of the configuration.
type: string
x-obmcs-enumref: '#/definitions/Config/lifecycleState'
systemTags:
additionalProperties:
additionalProperties:
description: 'The value of the tag. Only string, integer and boolean types are supported.
'
type: object
description: 'Key-value pair representing system tags'' keys and values scoped to a namespace.
Example: `{"bar-key": "value"}`
'
type: object
description: 'Usage of system tag keys. These predefined keys are scoped to namespaces.
Example: `{"orcl-cloud": {"free-tier-retained": "true"}}`
'
type: object
timeCreated:
description: The time the the configuration was created. An RFC3339 formatted datetime string.
format: date-time
type: string
timeUpdated:
description: The time the configuration was updated.
format: date-time
type: string
required:
- id
- compartmentId
- lifecycleState
- configType
type: object
DiscoveryJobLogCollection:
description: List of logs of a job
properties:
items:
description: List of logs
items:
$ref: '#/components/schemas/DiscoveryJobLogSummary'
type: array
required:
- items
type: object
x-example: "{\n items: [\n {\n \"id\": \"ocid1.instance.oc1.iad.<unique_id>\",\n \"logType\": \"INFO\",\n \"logMessage\": \"HereIsTheLogMessage\",\n \"timeCreated\": \"2021-10-27T17:05:50.347+0200\",\n }\n ]\n}\n"
MetricExtension:
description: Detailed information of the Metric Extension resource
properties:
collectionMethod:
description: Collection Method Metric Extension applies
maxLength: 255
minLength: 1
type: string
collectionRecurrences:
description: Schedule of metric extension should use RFC 5545 format -> recur-rule-part = "FREQ";"INTERVAL" where FREQ rule part identifies the type of recurrence rule. Valid values are "MINUTELY","HOURLY","DAILY" to specify repeating events based on an interval of a minute, an hour and a day or more. Example- FREQ=DAILY;INTERVAL=1
format: x-obmcs-duration
type: string
compartmentId:
description: Compartment Identifier [OCID](/Content/General/Concepts/identifiers.htm)
maxLength: 255
minLength: 1
type: string
createdBy:
description: Created by user
maxLength: 255
minLength: 1
type: string
description:
description: Description of the metric extension.
maxLength: 400
minLength: 0
type: string
displayName:
description: Metric Extension resource display name
maxLength: 255
minLength: 1
type: string
enabledOnResources:
description: List of resource objects on which this metric extension is enabled.
items:
$ref: '#/components/schemas/EnabledResourceDetails'
maxItems: 2000
type: array
enabledOnResourcesCount:
default: 0
description: Count of resources on which this metric extension is enabled.
minimum: 0
type: integer
id:
description: The [OCID](/Content/General/Concepts/identifiers.htm) of Metric Extension resource
maxLength: 255
minLength: 1
type: string
lastUpdatedBy:
description: Last updated by user
maxLength: 255
minLength: 1
type: string
lifecycleState:
description: The current lifecycle state of the metric extension
enum:
- ACTIVE
- DELETED
type: string
x-obmcs-top-level-enum: '#/definitions/MetricExtensionLifeCycleStates'
metricList:
description: List of metrics which are part of this metric extension
items:
$ref: '#/components/schemas/Metric'
maxItems: 20
minItems: 1
type: array
name:
description: Metric Extension resource name
maxLength: 110
minLength: 1
type: string
queryProperties:
$ref: '#/components/schemas/MetricExtensionQueryProperties'
resourceType:
description: Resource type to which Metric Extension applies
maxLength: 255
minLength: 1
type: string
resourceUri:
description: The URI path that the user can do a GET on to access the metric extension metadata
type: string
status:
description: The current status of the metric extension i.e. whether it is Draft or Published
enum:
- DRAFT
- PUBLISHED
type: string
x-obmcs-top-level-enum: '#/definitions/MetricExtensionLifeCycleDetails'
tenantId:
description: Tenant Identifier [OCID](/Content/General/Concepts/identifiers.htm)
maxLength: 255
minLength: 1
type: string
timeCreated:
description: Metric Extension creation time. An RFC3339 formatted datetime string.
format: date-time
type: string
timeUpdated:
description: Metric Extension update time. An RFC3339 formatted datetime string.
format: date-time
type: string
required:
- id
- name
- displayName
- resourceType
- compartmentId
- tenantId
- status
- collectionMethod
- collectionRecurrences
- metricList
- queryProperties
type: object
x-example: "Sample 1: Metric Extension resource having SQL Collection Method \n{\n \"id\": \"ocid1.stackmonitoringresource.oc1.iad.<unique_id>\",\n \"name\": \"ME_SqlDemo\",\n \"displayName\": \"SQL Demo\",\n \"description\": \"Metric extensions to demonstrate SQL collection method\",\n \"resourceType\": \"oci_oracle_cdb\",\n \"compartmentId\": \"ocid1.compartment.oc1..<unique_id>\",\n \"tenantId\": \"ocid1.tenancy.oc1..<unique_id>\",\n \"collectionMethod\": \"SQL\", \n \"status\": \"DRAFT\",\n \"lifecycleState\": \"ACTIVE\",\n \"createdBy\": \"ocid1.user.oc1..<unique_id>\",\n \"lastUpdatedBy\": \"ocid1.user.oc1..<unique_id>\",\n \"timeCreated\": \"2023-01-11T15:01:10.154Z\",\n \"timeUpdated\": \"2023-01-21T15:02:25.254Z\",\n \"collectionRecurrences\": \"FREQ=DAILY;INTERVAL=1\", \n \"metricList\": [\n {\n \"name\": \"NumberOfUpInstances\",\n \"displayName\": \"NumberOfUpInstances\",\n \"isDimension\": false,\n \"computeExpression\": null,\n \"dataType\": \"NUMBER\",\n \"isHidden\": false,\n \"metricCategory\": \"AVAILABILITY\",\n \"unit\": null\n }\n ], \n \"queryProperties\": {\n \"collectionMethod\": \"SQL\",\n \"sqlType\": \"STATEMENT\",\n \"sqlDetails\": {\n \"scriptFileName\": null,\n \"content\": \"<SQL statement as base64 encoded string>\"\n },\n \"inParamDetails\": [\n {\n \"inParamPosition\": \"1\",\n \"inParamValue\": \"production\"\n }\n ],\n \"outParamDetails\": null\n },\n \"enabledOnResources\": [\n \"ocid1.stackmonitoringresource.oc1.iad.<unique_id>\",\n \"ocid1.stackmonitoringresource.oc1.iad.<unique_id>\"\n ],\n \"enabledOnResourcesCount\": \"2\",\n \"resourceUri\": \"/metricExtensions/ocid1.stackmonitoringmetricextension.oc1..<unique_id>\"\n}\n\nSample 2: Metric Extension resource having OS Command Collection Method\n{\n \"id\": \"ocid1.stackmonitoringresource.oc1.iad.<unique_id>\",\n \"name\": \"ME_OsCommandDemo\",\n \"displayName\": \"OS Command Demo\",\n \"description\": \"Metric extension demonstrating OS Command collection method\",\n \"resourceType\": \"host_linux\",\n \"compartmentId\": \"ocid1.compartment.oc1..<unique_id>\",\n \"tenantId\": \"ocid1.tenancy.oc1..<unique_id>\",\n \"collectionMethod\": \"OS_COMMAND\", \n \"status\": \"PUBLISHED\",\n \"lifecycleState\": \"ACTIVE\",\n \"createdBy\": \"ocid1.user.oc1..<unique_id>\",\n \"lastUpdatedBy\": \"ocid1.user.oc1..<unique_id>\",\n \"timeCreated\": \"2023-01-11T15:01:10.154Z\",\n \"timeUpdated\": \"2023-01-21T15:02:25.254Z\",\n \"collectionRecurrences\": \"FREQ=HOURLY;INTERVAL=1\", \n \"metricList\": [\n {\n \"name\": \"MountPoint\",\n \"displayName\": null,\n \"isDimension\": true,\n \"computeExpression\": null,\n \"dataType\": \"STRING\",\n \"isHidden\": false,\n \"metricCategory\": null,\n \"unit\": null\n },\n {\n \"name\": \"FileSystemSize\",\n \"displayName\": null,\n \"isDimension\": false,\n \"computeExpression\": null,\n \"dataType\": \"NUMBER\",\n \"isHidden\": true,\n \"metricCategory\": null,\n \"unit\": null\n },\n {\n \"name\": \"FileSystemUsed\",\n \"displayName\": null,\n \"isDimension\": false,\n \"computeExpression\": null,\n \"dataType\": \"NUMBER\",\n \"isHidden\": true,\n \"metricCategory\": null,\n \"unit\": null\n },\n {\n \"name\": \"FileSystemUsage\",\n \"displayName\": null,\n \"isDimension\": false,\n \"computeExpression\": \"(FileSystemUsed / FileSystemSize) *100\",\n \"dataType\": \"NUMBER\",\n \"isHidden\": false,\n \"metricCategory\": \"UTILIZATION\",\n \"unit\": \"percent\"\n }\n ],\n \"queryProperties\": {\n \"collectionMethod\": \"OS_COMMAND\",\n \"command\": \"/bin/bash\",\n \"delimiter\": \"|\",\n \"scriptDetails\": {\n \"name\": \"fileSystem.sh\",\n \"content\": \"<Script file content as base64 encoded string>\"\n },\n \"arguments\": null,\n \"startsWith\": \"oci_result=\"\n }\n },\n \"enabledOnResources\": [\n \"ocid1.stackmonitoringresource.oc1.iad.<unique_id>\",\n \"ocid1.stackmonitoringresource.oc1.iad.<unique_id>\",\n \"ocid1.stackmonitoringresource.oc1.iad.<unique_id>\"\n ],\n \"enabledOnResourcesCount\": \"3\",\n \"resourceUri\": \"/metricExtensions/ocid1.stackmonitoringmetricextension.oc1..<unique_id>\"\n}\n\nSample 3: Metric Extension resource having JMX Collection Method\n{\n \"id\": \"ocid1.stackmonitoringresource.oc1.iad.<unique_id>\",\n \"name\": \"ME_JMXDemo\",\n \"displayName\": \"JMX Demo\",\n \"description\": \"Metric extension to demonstrate JMX collection method\",\n \"resourceType\": \"weblogic_j2eeserver\",\n \"compartmentId\": \"ocid1.compartment.oc1..<unique_id>\",\n \"tenantId\": \"ocid1.tenancy.oc1..<unique_id>\",\n \"collectionMethod\": \"JMX\", \n \"status\": \"PUBLISHED\",\n \"lifecycleState\": \"ACTIVE\",\n \"createdBy\": \"ocid1.user.oc1..<unique_id>\",\n \"lastUpdatedBy\": \"ocid1.user.oc1..<unique_id>\",\n \"timeCreated\": \"2023-01-11T15:01:10.154Z\",\n \"timeUpdated\": \"2023-01-21T15:02:25.254Z\",\n \"collectionRecurrences\": \"FREQ=MINUTELY;INTERVAL=1\", \n \"metricList\": [\n {\n \"name\": \"TotalPhysicalMemorySize\",\n \"isDimension\": false,\n \"isHidden\": true,\n \"dataType\": \"NUMBER\"\n },\n {\n \"name\": \"TotalPhysicalMemorySizeGB\",\n \"displayName\": \"TotalPhysicalMemorySizeInGB\",\n \"isDimension\": false,\n \"isHidden\": false,\n \"dataType\": \"NUMBER\",\n \"computeExpression\": \"TotalPhysicalMemorySize > 0 ? (TotalPhysicalMemorySize/(1024*1024*1024)) : 0\",\n \"metricCategory\": \"UTILIZATION\"\n }\n ],\n \"queryProperties\": {\n \"collectionMethod\": \"JMX\",\n \"managedBeanQuery\": \"java.lang:type=OperatingSystem,Location=PIA\",\n \"jmxAttributes\": \"TotalPhysicalMemorySize\",\n \"identityMetric\": null,\n \"autoRowPrefix\": null,\n \"isMetricServiceEnabled\": false\n },\n \"enabledOnResources\": [\n \"ocid1.stackmonitoringresource.oc1.iad.<unique_id>\",\n \"ocid1.stackmonitoringresource.oc1.iad.<unique_id>\",\n \"ocid1.stackmonitoringresource.oc1.iad.<unique_id>\",\n \"ocid1.stackmonitoringresource.oc1.iad.<unique_id>\"\n ],\n \"enabledOnResourcesCount\": \"4\",\n \"resourceUri\": \"/metricExtensions/ocid1.stackmonitoringmetricextension.oc1..<unique_id>\"\n}\n"
AssociatedResourcesSummary:
description: The information about monitored resource.
properties:
associatedResources:
description: 'List of associated monitored resources.
'
items:
$ref: '#/components/schemas/AssociatedMonitoredResource'
type: array
compartmentId:
description: 'Compartment Identifier [OCID](/Content/General/Concepts/identifiers.htm).
'
maxLength: 255
minLength: 1
type: string
displayName:
description: Monitored resource display name.
maxLength: 255
minLength: 1
type: string
externalId:
description: "External resource is any OCI resource identifier [OCID](/Content/General/Concepts/identifiers.htm)\nwhich is not a Stack Monitoring service resource.\nCurrently supports only following resource types - Container database, non-container database, \npluggable database and OCI compute instance.\n"
maxLength: 255
minLength: 1
type: string
hostName:
description: 'Monitored Resource Host Name.
'
maxLength: 255
minLength: 1
type: string
id:
description: 'Monitored resource identifier [OCID](/Content/General/Concepts/identifiers.htm).
'
maxLength: 255
minLength: 1
type: string
license:
description: License edition of the monitored resource.
enum:
- STANDARD_EDITION
- ENTERPRISE_EDITION
type: string
x-obmcs-top-level-enum: '#/definitions/LicenseType'
lifecycleState:
description: The current state of the monitored resource.
enum:
- CREATING
- UPDATING
- ACTIVE
- DELETING
- DELETED
- FAILED
type: string
x-obmcs-top-level-enum: '#/definitions/ResourceLifecycleState'
managementAgentId:
description: Management Agent Identifier [OCID](/Content/General/Concepts/identifiers.htm).
maxLength: 255
minLength: 1
type: string
name:
description: 'Monitored Resource Name.
'
maxLength: 255
minLength: 1
type: string
resourceCategory:
description: 'Resource Category to indicate the kind of resource type.
'
enum:
- APPLICATION
- DATABASE
- MIDDLEWARE
- UNKNOWN
type: string
x-obmcs-top-level-enum: '#/definitions/ResourceCategory'
sourceType:
description: 'Source type to indicate if the resource is stack monitoring discovered, OCI native resource, etc.
'
enum:
- SM_MGMT_AGENT_MONITORED
- SM_REPO_ONLY
- OCI_NATIVE
- PROMETHEUS
- TELEGRAF
- COLLECTD
type: string
x-obmcs-top-level-enum: '#/definitions/SourceType'
type:
description: 'Monitored Resource Type.
'
maxLength: 255
minLength: 1
type: string
required:
- id
type: object
x-example: "\nSample 1: Without fields and excludeFields query parameters\n/monitoredResources/actions/searchAssociatedResources\n{\n \"id\": \"ebs1-id\",\n \"name\": \"ebs1\",\n \"displayName\": \"ebs1\",\n \"type\": \"ebs_instance\",\n \"hostName\": \"my.host.com\",\n \"externalId\": null,\n \"managementAgentId\": \"agent.id\",\n \"lifecycleState\": \"ACTIVE\",\n \"sourceType\": \"SM_MGMT_AGENT_MANAGED\",\n \"resourceCategory\": \"APPLICATION\",\n \"license\": \"ENTERPRISE_EDITION\",\n \"associatedResources\": [\n {\n \"id\": \"wls-domain-1-id\",\n \"name\": \"wls-domain-1\",\n \"displayName\": \"wls-domain-1\",\n \"type\": \"weblogic_domain\",\n \"hostName\": \"my.host.com\",\n \"externalId\": null,\n \"managementAgentId\": \"agent.id\",\n \"lifecycleState\": \"ACTIVE\",\n \"sourceType\": \"SM_MGMT_AGENT_MANAGED\",\n \"resourceCategory\": \"APPLICATION\",\n \"license\": \"ENTERPRISE_EDITION\",\n \"association\":\n {\n \"sourceResourceId\": \"ebs1-id\",\n \"associationType\": \"contains\"\n }\n\n },\n {\n \"id\": \"wls-cluster-1-id\",\n \"name\": \"wls-cluster-1\",\n \"displayName\": \"wls-cluster-1\",\n \"type\": \"weblogic_cluster\",\n \"hostName\": \"my.host.com\",\n \"externalId\": null,\n \"managementAgentId\": \"agent.id\",\n \"lifecycleState\": \"ACTIVE\",\n \"sourceType\": \"SM_MGMT_AGENT_MANAGED\",\n \"resourceCategory\": \"APPLICATION\",\n \"license\": \"ENTERPRISE_EDITION\",\n \"association\":\n {\n \"sourceResourceId\": \"wls-domain-1-id\",\n \"associationType\": \"contains\"\n }\n },\n {\n \"id\": \"wls-server-1-id\",\n \"name\": \"wls-server-1\",\n \"displayName\": \"wls-server-1\",\n \"type\": \"weblogic_j2eeserver\",\n \"hostName\": \"my.host.com\",\n \"externalId\": null,\n \"managementAgentId\": \"agent.id\",\n \"lifecycleState\": \"ACTIVE\",\n \"sourceType\": \"SM_MGMT_AGENT_MANAGED\",\n \"resourceCategory\": \"APPLICATION\",\n \"license\": \"ENTERPRISE_EDITION\",\n \"association\":\n {\n \"sourceResourceId\": \"wls-cluster-1-id\",\n \"associationType\": \"contains\"\n }\n }\n ]\n }\n\nSample 2: With fields query parameters.\n /monitoredResources/actions/searchAssociatedResources?fields=id&fields=name&fields=type\n{\n \"id\": \"ebs1-id\",\n \"name\": \"ebs1\",\n \"type\": \"ebs_instance\",\n \"associatedResources\":\n [\n {\n \"id\": \"wls-domain-1-id\",\n \"name\": \"wls-domain-1\",\n \"type\": \"weblogic_domain\",\n \"association\":\n {\n \"sourceResourceId\": \"ebs1-id\",\n \"associationType\": \"contains\"\n }\n },\n {\n \"id\": \"wls-cluster-1-id\",\n \"name\": \"wls-cluster-1\",\n \"type\": \"weblogic_cluster\",\n \"association\":\n {\n \"sourceResourceId\": \"wls-domain-1-id\",\n \"associationType\": \"contains\"\n }\n },\n {\n \"id\": \"wls-server-1-id\",\n \"name\": \"wls-server-1\",\n \"type\": \"weblogic_j2eeserver\",\n \"association\":\n {\n \"sourceResourceId\": \"wls-cluster-1-id\",\n \"associationType\": \"contains\"\n }\n }\n ]\n}\n\nSample 3: With fields query parameters.\n/monitoredResources/actions/searchAssociatedResources?excludeFields=externalId&excludeFields=hostName&excludeFields=managementAgentId\n\n{\n \"id\": \"ebs1-id\",\n \"name\": \"ebs1\",\n \"displayName\": \"ebs1\",\n \"type\": \"ebs_instance\",\n \"lifecycleState\": \"ACTIVE\",\n \"sourceType\": \"SM_MGMT_AGENT_MANAGED\",\n \"resourceCategory\": \"APPLICATION\",\n \"license\": \"ENTERPRISE_EDITION\",\n \"associatedResources\": [\n {\n \"id\": \"wls-domain-1-id\",\n \"name\": \"wls-domain-1\",\n \"displayName\": \"wls-domain-1\",\n \"type\": \"weblogic_domain\",\n \"lifecycleState\": \"ACTIVE\",\n \"association\":\n {\n \"sourceResourceId\": \"ebs1-id\",\n \"associationType\": \"contains\"\n }\n },\n {\n \"id\": \"wls-cluster-1-id\",\n \"name\": \"wls-cluster-1\",\n \"displayName\": \"wls-cluster-1\",\n \"type\": \"weblogic_cluster\",\n \"lifecycleState\": \"ACTIVE\",\n \"association\":\n {\n \"sourceResourceId\": \"wls-domain-1-id\",\n \"associationType\": \"contains\"\n }\n },\n {\n \"id\": \"wls-server-1-id\",\n \"name\": \"wls-server-1\",\n \"displayName\": \"wls-server-1\",\n \"type\": \"weblogic_j2eeserver\",\n \"lifecycleState\": \"ACTIVE\",\n \"association\":\n {\n \"sourceResourceId\": \"wls-cluster-1-id\",\n \"associationType\": \"contains\"\n }\n }\n ]\n }\n"
ConnectionDetails:
description: 'Connection details for the database.
'
properties:
connectorId:
description: 'Database connector Identifier [OCID](/Content/General/Concepts/identifiers.htm).
'
maxLength: 255
minLength: 1
type: string
dbId:
description: 'dbId of the database.
'
maxLength: 128
minLength: 1
type: string
dbUniqueName:
description: UniqueName used for database connection requests.
maxLength: 128
minLength: 1
type: string
port:
description: Listener Port number used for connection requests.
maximum: 65535
minimum: 1
type: integer
protocol:
description: Protocol used in DB connection string when connecting to external database service.
enum:
- TCP
- TCPS
type: string
serviceName:
description: Service name used for connection requests.
maxLength: 128
minLength: 1
type: string
sslSecretId:
description: 'SSL Secret Identifier for TCPS connector in OCI Vault[OCID](/Content/General/Concepts/identifiers.htm).
'
maxLength: 255
minLength: 1
type: string
required:
- protocol
- port
- serviceName
MonitoredResourceCredential:
description: 'Monitored Resource Credential Details.
'
discriminator:
propertyName: credentialType
properties:
credentialType:
description: "Type of credentials specified in the credentials element.\nThree possible values - EXISTING, PLAINTEXT and ENCRYPTED.\n* EXISTING - Credential is already stored in agent and only credential name need\n to be passed for existing credential.\n* PLAINTEXT - The credential properties will have credentials in plain text format.\n* ENCRYPTED - The credential properties will have credentials stored in vault in\n encrypted format using KMS client which uses master key for encryption.\n The same master key will be used to decrypt the credentials before passing\n on to the management agent.\n"
enum:
- EXISTING
- PLAINTEXT
- ENCRYPTED
type: string
description:
description: The user-specified textual description of the credential.
maxLength: 255
minLength: 1
type: string
name:
description: The name of the credential, within the context of the source.
maxLength: 96
minLength: 1
type: string
source:
description: 'The source type and source name combination, delimited with (.) separator.
{source type}.{source name} and source type max char limit is 63.
'
maxLength: 255
minLength: 1
type: string
type:
description: The type of the credential ( ex. JMXCreds,DBCreds).
maxLength: 255
minLength: 1
type: string
type: object
MonitoredResourceMemberSummary:
description: 'Monitored resource member details.
'
properties:
compartmentId:
description: Compartment Identifier [OCID](/Content/General/Concepts/identifiers.htm).
maxLength: 255
minLength: 1
type: string
definedTags:
additionalProperties:
additionalProperties:
description: 'The value of the tag. Only string, integer and boolean types are supported.
'
type: object
description: 'Key-value pair representing predefined tags'' keys and values scoped to a namespace.
Example: `{"bar-key": "value"}`
'
type: object
description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace.
Example: `{"foo-namespace": {"bar-key": "value"}}`
'
type: object
externalId:
description: "External resource is any OCI resource identifier [OCID](/Content/General/Concepts/identifiers.htm)\nwhich is not a Stack Monitoring service resource.\nCurrently supports only following resource types - Container database, non-container database, \npluggable database and OCI compute instance.\n"
maxLength: 255
minLength: 1
type: string
freeformTags:
additionalProperties:
type: string
description: 'Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only.
Example: `{"bar-key": "value"}`
'
type: object
hostName:
description: 'Monitored Resource Host Name.
'
maxLength: 255
minLength: 1
type: string
license:
description: License edition of the monitored resource.
enum:
- STANDARD_EDITION
- ENTERPRISE_EDITION
type: string
x-obmcs-top-level-enum: '#/definitions/LicenseType'
lifecycleState:
description: The current state of the Resource.
enum:
- CREATING
- UPDATING
- ACTIVE
- DELETING
- DELETED
- FAILED
type: string
x-obmcs-top-level-enum: '#/definitions/ResourceLifecycleState'
parentId:
description: 'Parent monitored resource identifier [OCID](/Content/General/Concepts/identifiers.htm).
'
maxLength: 255
minLength: 1
type: string
resourceCategory:
description: 'Resource Category to indicate the kind of resource type.
'
enum:
- APPLICATION
- DATABASE
- MIDDLEWARE
- UNKNOWN
type: string
x-obmcs-top-level-enum: '#/definitions/ResourceCategory'
resourceDisplayName:
description: Monitored resource display name.
maxLength: 255
minLength: 1
type: string
resourceId:
description: 'Monitored resource identifier [OCID](/Content/General/Concepts/identifiers.htm).
'
maxLength: 255
minLength: 1
type: string
resourceName:
description: 'Monitored Resource Name.
'
maxLength: 255
minLength: 1
type: string
resourceType:
description: 'Monitored Resource Type.
'
maxLength: 255
minLength: 1
type: string
sourceType:
description: 'Source type to indicate if the resource is stack monitoring discovered, OCI native resource, etc.
'
enum:
- SM_MGMT_AGENT_MONITORED
- SM_REPO_ONLY
- OCI_NATIVE
- PROMETHEUS
- TELEGRAF
- COLLECTD
type: string
x-obmcs-top-level-enum: '#/definitions/SourceType'
systemTags:
additionalProperties:
additionalProperties:
description: 'The value of the tag. Only string, integer and boolean types are supported.
'
type: object
description: 'Key-value pair representing system tags'' keys and values scoped to a namespace.
Example: `{"bar-key": "value"}`
'
type: object
description: 'Usage of system tag keys. These predefined keys are scoped to namespaces.
Example: `{"orcl-cloud": {"free-tier-retained": "true"}}`
'
type: object
type: object
DisableMetricExtensionDetails:
description: The Resource IDs for which metric extension will be disabled
properties:
resourceIds:
description: List of Resource IDs [OCIDs]. Currently supports upto 20 resources per request
items:
maxLength: 255
minLength: 1
type: string
maxItems: 20
minItems: 1
type: array
required:
- resourceIds
type: object
SearchMonitoredResourceMembersDetails:
description: The search criteria for listing monitored resource member targets.
properties:
destinationResourceId:
description: 'Destination Monitored Resource Identifier [OCID](/Content/General/Concepts/identifiers.htm).
'
maxLength: 255
minLength: 1
type: string
limitLevel:
default: 1
description: 'The field which determines the depth of hierarchy while searching for members.
'
minimum: 1
type: integer
type: object
MonitoredResource:
description: "The response object for create monitored resource and get monitored resource operations. \nThis contains information about the monitored resource. Credentials and credential aliases attributes \nwill be returned as null due to security reasons.\n"
properties:
aliases:
$ref: '#/components/schemas/MonitoredResourceAliasCredential'
compartmentId:
description: 'Compartment Identifier [OCID](/Content/General/Concepts/identifiers.htm).
'
maxLength: 255
minLength: 1
type: string
credentials:
$ref: '#/components/schemas/MonitoredResourceCredential'
databaseConnectionDetails:
$ref: '#/components/schemas/ConnectionDetails'
definedTags:
additionalProperties:
additionalProperties:
description: 'The value of the tag. Only string, integer and boolean types are supported.
'
type: object
description: 'Key-value pair representing predefined tags'' keys and values scoped to a namespace.
Example: `{"bar-key": "value"}`
'
type: object
description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace.
Example: `{"foo-namespace": {"bar-key": "value"}}`
'
type: object
displayName:
description: Monitored resource display name.
maxLength: 255
minLength: 1
type: string
externalId:
description: "The external resource identifier [OCID](/Content/General/Concepts/identifiers.htm).\nExternal resource is any OCI resource which is not a Stack Monitoring service resource.\nCurrently supports only following resource types - Container database, non-container database, \npluggable database and OCI compute instance.\n"
maxLength: 255
minLength: 1
type: string
freeformTags:
additionalProperties:
type: string
description: 'Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only.
Example: `{"bar-key": "value"}`
'
type: object
hostName:
description: Monitored resource host name.
maxLength: 255
minLength: 1
type: string
id:
description: 'Monitored resource identifier [OCID](/Content/General/Concepts/identifiers.htm).
'
maxLength: 255
minLength: 1
type: string
license:
description: License edition of the monitored resource.
enum:
- STANDARD_EDITION
- ENTERPRISE_EDITION
type: string
x-obmcs-top-level-enum: '#/definitions/LicenseType'
lifecycleState:
description: Lifecycle state of the monitored resource.
enum:
- CREATING
- UPDATING
- ACTIVE
- DELETING
- DELETED
- FAILED
type: string
x-obmcs-top-level-enum: '#/definitions/ResourceLifecycleState'
managementAgentId:
description: Management Agent Identifier [OCID](/Content/General/Concepts/identifiers.htm).
maxLength: 255
minLength: 1
type: string
name:
description: Monitored resource name.
maxLength: 255
minLength: 1
type: string
properties:
description: 'List of monitored resource properties.
'
items:
$ref: '#/components/schemas/MonitoredResourceProperty'
type: array
resourceCategory:
description: 'Resource Category to indicate the kind of resource type.
'
enum:
- APPLICATION
- DATABASE
- MIDDLEWARE
- UNKNOWN
type: string
x-obmcs-top-level-enum: '#/definitions/ResourceCategory'
resourceTimeZone:
default: Etc/UTC
description: Time zone in the form of tz database canonical zone ID.
example: America/Los_Angeles
format: x-obmcs-time-zone
type: string
sourceType:
description: 'Source type to indicate if the resource is stack monitoring discovered, OCI native resource, etc.
'
enum:
- SM_MGMT_AGENT_MONITORED
- SM_REPO_ONLY
- OCI_NATIVE
- PROMETHEUS
- TELEGRAF
- COLLECTD
type: string
x-obmcs-top-level-enum: '#/definitions/SourceType'
systemTags:
additionalProperties:
additionalProperties:
description: 'The value of the tag. Only string, integer and boolean types are supported.
'
type: object
description: 'Key-value pair representing system tags'' keys and values scoped to a namespace.
Example: `{"bar-key": "value"}`
'
type: object
description: 'Usage of system tag keys. These predefined keys are scoped to namespaces.
Example: `{"orcl-cloud": {"free-tier-retained": "true"}}`
'
type: object
tenantId:
description: 'Tenancy Identifier [OCID](/Content/General/Concepts/identifiers.htm).
'
maxLength: 255
minLength: 1
type: string
timeCreated:
description: "The date and time when the monitored resource was created, expressed in \n[RFC 3339](https://tools.ietf.org/html/rfc3339) timestamp format.\n"
format: date-time
type: string
timeUpdated:
description: 'The date and time when the monitored resource was last updated, expressed in
[RFC 3339](https://tools.ietf.org/html/rfc3339) timestamp format.
'
format: date-time
type: string
type:
description: 'Monitored Resource Type.
'
maxLength: 255
minLength: 1
type: string
required:
- id
- name
- type
- tenantId
- compartmentId
type: object
x-example: "Sample 1: Non-database resource where \"databaseConnectionDetails\" is null. \n{\n \"id\": \"ocid1.stackmonitoringresource.oc1.iad.<unique_id>\",\n \"name\": \"weblogic_domain1\",\n \"displayName\": \"domain1\",\n \"type\": \"weblogic_domain\",\n \"compartmentId\": \"ocid1.compartment.oc1.<unique_id>\",\n \"tenantId\": \"ocid1.tenancy.oc1.<unique_id>\",\n \"hostName\": \"demohost.example.com\",\n \"managementAgentId\": \"ocid1.managementagent.oc1.iad.<unique_id>\",\n \"resourceTimeZone\": \"Etc/UTC\", \n \"sourceType\": \"SM_MGMT_AGENT_MANAGED\",\n \"resourceCategory\": \"APPLICATION\",\n \"timeCreated\": \"2022-01-27T15:01:10.254Z\",\n \"timeUpdated\": \"2022-01-27T15:04:34.456Z\",\n \"lifecycleState\": \"ACTIVE\",\n \"license\": \"ENTERPRISE_EDITION\",\n \"properties\": [\n {\n \"name\": \"admin_server_port\",\n \"value\": \"7003\"\n },\n {\n \"name\": \"admin_service\",\n \"value\": \"weblogic.management.mbeanservers.domainruntime\"\n },\n {\n \"name\": \"admin_server_protocol\",\n \"value\": \"t3\"\n },\n {\n \"name\": \"admin_server_host\",\n \"value\": \"demohost.example.com\"\n }\n ],\n \"databaseConnectionDetails\": null,\n \"credentials\": null,\n \"aliases\": null,\n \"freeformTags\": {},\n \"definedTags\": {\n \"discoveryTags\": {\n \"stack\": \"middleware\"\n }\n },\n \"systemTags\": {}\n \n}\n\nSample 2: Database resource\n\n{\n\"id\": \"ocid1.stackmonitoringresource.oc1.iad.<unique_id>\",\n\"name\": \"DEMO_CDB\",\n\"displayName\": \"DEMO_CDB\",\n\"type\": \"oci_oracle_cdb\",\n\"compartmentId\": \"ocid1.compartment.oc1..<unique_id>\",\n\"tenantId\": \"ocid1.tenancy.oc1..<unique_id>\",\n\"hostName\": \"demohost.example.com\",\n\"managementAgentId\": \"ocid1.managementagent.oc1.iad.<unique_id>\",\n\"resourceTimeZone\": \"UTC\",\n\"timeCreated\": \"2022-03-03T17:05:27.344Z\",\n\"timeUpdated\": \"2022-03-03T17:12:00.481Z\",\n\"lifecycleState\": \"ACTIVE\",\n\"sourceType\": \"SM_MGMT_AGENT_MANAGED\",\n\"resourceCategory\": \"DATABASE\",\n\"license\": \"ENTERPRISE_EDITION\",\n\"properties\": [\n {\n \"name\": \"db_type\",\n \"value\": \"CDB\"\n },\n \n {\n \"name\": \"is_cluster\",\n \"value\": \"false\"\n },\n {\n \"name\": \"oracle_home\",\n \"value\": \"/dbhome_1\"\n },\n {\n \"name\": \"service_name\",\n \"value\": \"cdb2\"\n },\n {\n \"name\": \"allowed_logon_version\",\n \"value\": \"10\"\n }\n],\n\"databaseConnectionDetails\": {\n \"protocol\": \"TCP\",\n \"port\": 1521,\n \"connectorId\": \"ocid1.externaldatabaseconnector.oc1.iad.<unique_id>\",\n \"serviceName\": \"cdb2\",\n \"dbUniqueName\": \"cdb2\",\n \"dbId\": \"845398373\"\n},\n\"credentials\": null,\n\"aliases\": null,\n\"freeformTags\": null,\n\"definedTags\": null,\n\"systemTags\": null\n}\n"
PropertyDetails:
description: Property Details
properties:
propertiesMap:
additionalProperties:
type: string
description: Key/Value pair of Property
type: object
type: object
BaselineableMetricSummary:
description: Summary for the baseline-able metric
properties:
column:
description: metric column name
maxLength: 255
minLength: 1
type: string
compartmentId:
description: OCID of the compartment
maxLength: 255
minLength: 1
type: string
definedTags:
additionalProperties:
additionalProperties:
description: 'The value of the tag. Only string, integer and boolean types are supported.
'
type: object
description: 'Key-value pair representing predefined tags'' keys and values scoped to a namespace.
Example: `{"bar-key": "value"}`
'
type: object
description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace.
Example: `{"foo-namespace": {"bar-key": "value"}}`
'
type: object
freeformTags:
additionalProperties:
type: string
description: 'Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only.
Example: `{"bar-key": "value"}`
'
type: object
id:
description: OCID of the metric
maxLength: 255
minLength: 1
type: string
isOutOfBox:
description: Is the metric created out of box, default false
type: boolean
lifecycleState:
description: The current lifecycle state of the metric extension
enum:
- ACTIVE
- DELETED
type: string
x-obmcs-top-level-enum: '#/definitions/BaselineableMetricLifeCycleStates'
name:
description: name of the metric
maxLength: 255
minLength: 1
type: string
namespace:
description: namespace of the metric
maxLength: 255
minLength: 1
type: string
resourceGroup:
description: Resource group of the metric
maxLength: 255
minLength: 1
type: string
systemTags:
additionalProperties:
additionalProperties:
description: 'The value of the tag. Only string, integer and boolean types are supported.
'
type: object
description: 'Key-value pair representing system tags'' keys and values scoped to a namespace.
Example: `{"bar-key": "value"}`
'
type: object
description: 'Usage of system tag keys. These predefined keys are scoped to namespaces.
Example: `{"orcl-cloud": {"free-tier-retained": "true"}}`
'
type: object
tenancyId:
description: OCID of the tenancy
maxLength: 255
minLength: 1
type: string
required:
- id
- name
- column
- namespace
- resourceGroup
- isOutOfBox
type: object
x-example: "{\n \"id\": \"ocid.smad.oc1.<unique_id>\",\n \"tenancyId\": \"ocid.tenancy.oc1.<unique_id>\",\n \"compartmentId\": \"ocid.compartment.oc1.<unique_id>\",\n \"name\": \"Memory\",\n \"column\":\"MemoryUtilization\",\n \"namespace\": \"oracle_appmgmt\",\n \"resourceGroup\": \"oracle_database\",\n \"isOutOfBox\": TRUE,\n \"lifecycleState\": \"ACTIVE\"\n}\n"
UpdateMonitoredResourceDetails:
description: The information about updating a monitored resource.
properties:
additionalAliases:
description: "List of MonitoredResourceAliasCredentials. This property complements the existing \n\"aliases\" property by allowing user to specify more than one credential alias. \nIf both \"aliases\" and \"additionalAliases\" are specified, union of the \nvalues is used as list of aliases applicable for this resource.\nIf any duplicate found in the combined list of \"alias\" and \"additionalAliases\", \nan error will be thrown.\n"
items:
$ref: '#/components/schemas/MonitoredResourceAliasCredential'
maxItems: 4
type: array
additionalCredentials:
description: "List of MonitoredResourceCredentials. This property complements the existing \n\"credentials\" property by allowing user to specify more than one credential. \nIf both \"credential\" and \"additionalCredentials\" are specified, union of the \nvalues is used as list of credentials applicable for this resource.\nIf any duplicate found in the combined list of \"credentials\" and \"additionalCredentials\", \nan error will be thrown.\n"
items:
$ref: '#/components/schemas/MonitoredResourceCredential'
maxItems: 4
type: array
aliases:
$ref: '#/components/schemas/MonitoredResourceAliasCredential'
credentials:
$ref: '#/components/schemas/MonitoredResourceCredential'
databaseConnectionDetails:
$ref: '#/components/schemas/ConnectionDetails'
definedTags:
additionalProperties:
additionalProperties:
description: 'The value of the tag. Only string, integer and boolean types are supported.
'
type: object
description: 'Key-value pair representing predefined tags'' keys and values scoped to a namespace.
Example: `{"bar-key": "value"}`
'
type: object
description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace.
Example: `{"foo-namespace": {"bar-key": "value"}}`
'
type: object
displayName:
description: Monitored resource display name.
maxLength: 255
minLength: 1
type: string
freeformTags:
additionalProperties:
type: string
description: 'Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only.
Example: `{"bar-key": "value"}`
'
type: object
hostName:
description: 'Host name of the monitored resource.
'
maxLength: 255
minLength: 1
type: string
properties:
description: 'List of monitored resource properties.
'
items:
$ref: '#/components/schemas/MonitoredResourceProperty'
type: array
resourceTimeZone:
default: Etc/UTC
description: 'Time zone in the form of tz database canonical zone ID. Specifies the preference with
a value that uses the IANA Time Zone Database format (x-obmcs-time-zone).
For example - America/Los_Angeles
'
example: America/Los_Angeles
format: x-obmcs-time-zone
type: string
type: object
x-example: "Sample 2: Database Resource\n{\n \"displayName\": \"cdb1\",\n \"hostName\": \"demohost.example.com\", \n \"resourceTimeZone\": \"Etc/UTC\",\n \"databaseConnectionDetails\": {\n \"port\": \"1521\",\n \"protocol\": \"TCP\",\n \"serviceName\": \"XE\"\n },\n \"credentials\": {\n\n \"credentialType\": \"PLAINTEXT\",\n \"keyId\":\"\"\n \"properties\": [\n {\n \"name\": \"databaseUserName\",\n \"value\": \"<username>\"\n },\n {\n \"name\": \"databasePassword\",\n \"value\": \"<password>\"\n },\n {\n \"name\": \"databaseRole\",\n \"value\": \"<dbrole>\"\n }\n ]\n },\n \"properties\": [\n {\n \"name\": \"DB_HOME\",\n \"value\": \"/u01/db12\"\n }\n \n ],\n \"freeformTags\" : {\n \"Environment\" : \"Prod\",\n \"Department\":\"Ops\"\n },\n \"definedTags\": {\n \"discoveryTags\": {\n \"stack\": \"db\"\n }\n }\n \n}\n"
MonitoredResourceAssociationSummary:
description: Summary of the monitored resource association.
properties:
associationType:
description: 'Association type between source and destination resources.
'
maxLength: 255
minLength: 1
type: string
definedTags:
additionalProperties:
additionalProperties:
description: 'The value of the tag. Only string, integer and boolean types are supported.
'
type: object
description: 'Key-value pair representing predefined tags'' keys and values scoped to a namespace.
Example: `{"bar-key": "value"}`
'
type: object
description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace.
Example: `{"foo-namespace": {"bar-key": "value"}}`
'
type: object
destinationResourceDetails:
$ref: '#/components/schemas/AssociationResourceDetails'
destinationResourceId:
description: 'Destination Monitored Resource Identifier [OCID](/Content/General/Concepts/identifiers.htm).
'
maxLength: 255
minLength: 1
type: string
freeformTags:
additionalProperties:
type: string
description: 'Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only.
Example: `{"bar-key": "value"}`
'
type: object
sourceResourceDetails:
$ref: '#/components/schemas/AssociationResourceDetails'
sourceResourceId:
description: 'Source Monitored Resource Identifier [OCID](/Content/General/Concepts/identifiers.htm).
'
maxLength: 255
minLength: 1
type: string
systemTags:
additionalProperties:
additionalProperties:
description: 'The value of the tag. Only string, integer and boolean types are supported.
'
type: object
description: 'Key-value pair representing system tags'' keys and values scoped to a namespace.
Example: `{"bar-key": "value"}`
'
type: object
description: 'Usage of system tag keys. These predefined keys are scoped to namespaces.
Example: `{"orcl-cloud": {"free-tier-retained": "true"}}`
'
type: object
timeCreated:
description: 'The association creation time. An RFC3339 formatted datetime string.
'
format: date-time
type: string
required:
- associationType
- sourceResourceId
- destinationResourceId
type: object
DisassociateMonitoredResourcesDetails:
description: The information required to create new monitored resource association.
properties:
associationType:
description: 'Association type between source and destination resources.
'
maxLength: 255
minLength: 1
type: string
compartmentId:
description: 'Compartment Identifier [OCID](/Content/General/Concepts/identifiers.htm).
'
maxLength: 255
minLength: 1
type: string
destinationResourceId:
description: 'Destination Monitored Resource Identifier [OCID](/Content/General/Concepts/identifiers.htm).
'
maxLength: 255
minLength: 1
type: string
sourceResourceId:
description: 'Source Monitored Resource Identifier [OCID](/Content/General/Concepts/identifiers.htm).
'
maxLength: 255
minLength: 1
type: string
required:
- compartmentId
type: object
DiscoveryDetails:
description: The request of DiscoveryJob Resource details.
properties:
agentId:
description: The OCID of Management Agent
maxLength: 255
minLength: 1
type: string
credentials:
$ref: '#/components/schemas/CredentialCollection'
license:
description: License edition of the monitored resource.
enum:
- STANDARD_EDITION
- ENTERPRISE_EDITION
type: string
x-obmcs-top-level-enum: '#/definitions/LicenseType'
properties:
$ref: '#/components/schemas/PropertyDetails'
resourceName:
description: The Name of resource type
maxLength: 128
minLength: 1
type: string
resourceType:
description: Resource Type.
enum:
- WEBLOGIC_DOMAIN
- EBS_INSTANCE
- SQL_SERVER
- APACHE_TOMCAT
- ORACLE_DATABASE
- OCI_ORACLE_DB
- OCI_ORACLE_CDB
- OCI_ORACLE_PDB
- HOST
- ORACLE_PSFT
- ORACLE_MFT
- APACHE_HTTP_SERVER
- ORACLE_GOLDENGATE
- CUSTOM_RESOURCE
- ORACLE_HTTP_SERVER
type: string
tags:
$ref: '#/components/schemas/PropertyDetails'
required:
- agentId
- resourceType
- resourceName
- properties
type: object
CreateBaselineableMetricDetails:
description: Summary for the baseline-able metric
properties:
column:
description: metric column name
maxLength: 255
minLength: 1
type: string
compartmentId:
description: OCID of the compartment
maxLength: 255
minLength: 1
type: string
name:
description: name of the metric
maxLength: 255
minLength: 1
type: string
namespace:
description: namespace of the metric
maxLength: 255
minLength: 1
type: string
resourceGroup:
description: Resource group of the metric
maxLength: 255
minLength: 1
type: string
required:
- compartmentId
- name
- column
- namespace
- resourceGroup
type: object
x-example: "{\n compartmentId\": \"ocid.compartment.oc1.<unique_id>\",\n name: \"CPU\",\n column:\"CPUUtilization\",\n namespace: \"oracle_appmgmt\",\n resourceGroup: \"oracle_database\",\n}\n"
MonitoredResourceTypesCollection:
description: A Collection of monitored resource type summaries.
properties:
items:
description: List of monitored resource type summaries.
items:
$ref: '#/components/schemas/MonitoredResourceTypeSummary'
type: array
required:
- items
type: object
x-example: "{\n \"items\": [\n {\n \"id\": \"ocid1.stackmonitoringresourcetype.oc1.iad.<unique_id>\",\n \"compartmentId\": \"ocid1.tenancy.oc1.<unique_id>\",\n \"name\": \"host\",\n \"displayName\": \"Host\",\n \"lifecycleState\": \"ACTIVE\",\n \"metricNamespace\": \"oracle_appmgmt\",\n \"metadata\": {\n \"format\" : \"SYSTEM_FORMAT\",\n \"requiredProperties\": [\"osName\",\"osVersion\"],\n \"agentProperties\": [\"hostType\",\"osType\",\"osName\",\"osVersion\"],\n \"validPropertiesForCreate\": [\"osName\",\"osVersion\"],\n \"validPropertiesForUpdate\": [\"osName\",\"osVersion\",\"hostType\",\"osType\"],\n \"uniquePropertySets\": [\n {\n \"properties\": [\"host_uuid\"]\n }\n ],\n \"validPropertyValues\": {\n \"osType\": [\"Linux\"]\n }\n },\n \"timeCreated\": \"2022-01-27T15:01:10.254Z\",\n \"timeUpdated\": \"2022-01-27T15:04:34.456Z\",\n \"freeformTags\": {},\n \"definedTags\": {\n \"discoveryTags\": {\n \"stack\": \"middleware\"\n }\n },\n \"systemTags\": {}\n }\n ]\n}\n"
CreateMetricExtensionDetails:
description: The information about new metric extension resource. The combination of metric extension name and resource type should be unique in a compartment.
properties:
collectionRecurrences:
description: Schedule of metric extension should use RFC 5545 format i.e. recur-rule-part = "FREQ";INTERVAL where FREQ rule part identifies the type of recurrence rule. Valid values are "MINUTELY","HOURLY","DAILY" to specify repeating events based on an interval of a minute, an hour and a day or more. Example- FREQ=DAILY;INTERVAL=1
format: x-obmcs-duration
type: string
compartmentId:
description: Compartment Identifier [OCID](/Content/General/Concepts/identifiers.htm)
maxLength: 255
minLength: 1
type: string
description:
description: Description of the metric extension.
maxLength: 400
minLength: 0
type: string
displayName:
description: Metric Extension display name.
maxLength: 255
minLength: 1
type: string
metricList:
description: List of metrics which are part of this metric extension
items:
$ref: '#/components/schemas/Metric'
maxItems: 20
type: array
name:
description: Metric Extension Resource name.
maxLength: 110
minLength: 1
type: string
queryProperties:
$ref: '#/components/schemas/MetricExtensionQueryProperties'
resourceType:
description: Resource type to which Metric Extension applies
maxLength: 255
minLength: 1
type: string
required:
- name
- displayName
- resourceType
- compartmentId
- collectionRecurrences
- metricList
- queryProperties
type: object
x-example: "Sample 1: Metric Extension with SQL collection method\n{\n \"name\": \"ME_CountOfRunningInstances\",\n \"displayName\": \"Count of Running Instances\",\n \"resourceType\": \"ebs_instance\",\n \"compartmentId\": \"ocid1.compartment.oc1..<unique_id>\",\n \"description\": \"Collects count of instances in 'UP' status in staging compartments from monitoring table\",\n \"collectionRecurrences\": \"FREQ=MINUTELY;INTERVAL=10\",\n \"metricList\": [\n {\n \"name\": \"NumberOfUpInstances\",\n \"displayName\": \"NumberOfUpInstances\",\n \"isDimension\": \"false\",\n \"isHidden\": \"false\",\n \"dataType\": \"NUMBER\",\n \"metricCategory\": \"AVAILABILITY\"\n }\n ],\n \"queryProperties\": {\n \"collectionMethod\": \"SQL\",\n \"sqlType\": \"STATEMENT\",\n \"sqlDetails\": {\n \"content\": \"<SQL statement as base64 encoded string>\"\n },\n \"inParamDetails\": [\n {\n \"inParamPosition\": 1,\n \"inParamValue\": \"staging\"\n }\n ]\n }\n}\n\nNote#1: SQL statement or script content needs to be passed as base64 encoded string. \n For example, \n if SQL statement is\n \"SELECT count(instance_id) FROM monitoring_table WHERE status = 'UP' AND compartment_type = :1\"\n then below base 64 encoded string of the same SQL statement has to be passed in \"content\" sub-property\n \"U0VMRUNUIGNvdW50KGluc3RhbmNlX2lkKSBGUk9NIG1vbml0b3JpbmdfdGFibGUgV0hFUkUgc3RhdHVzID0gJ1VQJyBBTkQgY29tcGFydG1lbnRfdHlwZSA9IDox\"\n\nNote#2: Optional properties/sub-properties can be skipped or sent as null\n\nSample 2: Metric Extension with OS Command collection method\n{\n \"name\": \"ME_OsFileSystemUtilization\",\n \"displayName\": \"OS File System Utilization\",\n \"resourceType\": \"host_linux\",\n \"compartmentId\": \"ocid1.compartment.oc1..<unique_id>\",\n \"description\": \"Computes File System Utilization Percentage of various mount points\",\n \"collectionRecurrences\": \"FREQ=DAILY;INTERVAL=1\",\n \"metricList\": [\n {\n \"name\": \"MountPoint\",\n \"displayName\": null,\n \"isDimension\": true,\n \"computeExpression\": null,\n \"dataType\": \"STRING\",\n \"isHidden\": false,\n \"metricCategory\": null,\n \"unit\": null\n },\n {\n \"name\": \"FileSystemSize\",\n \"displayName\": null,\n \"isDimension\": false,\n \"computeExpression\": null,\n \"dataType\": \"NUMBER\",\n \"isHidden\": true,\n \"metricCategory\": null,\n \"unit\": null\n },\n {\n \"name\": \"FileSystemUsed\",\n \"displayName\": null,\n \"isDimension\": false,\n \"computeExpression\": null,\n \"dataType\": \"NUMBER\",\n \"isHidden\": true,\n \"metricCategory\": null,\n \"unit\": null\n },\n {\n \"name\": \"FileSystemUsage\",\n \"displayName\": null,\n \"isDimension\": false,\n \"computeExpression\": \"(FileSystemUsed / FileSystemSize) *100\",\n \"dataType\": \"NUMBER\",\n \"isHidden\": false,\n \"metricCategory\": \"UTILIZATION\",\n \"unit\": \"percent\"\n }\n ],\n \"queryProperties\": {\n \"collectionMethod\": \"OS_COMMAND\",\n \"command\": \"/bin/bash\",\n \"delimiter\": \"|\",\n \"scriptDetails\": {\n \"name\": \"fileSystem.sh\",\n \"content\": \"<Script file content as base64 encoded string>\"\n },\n \"arguments\": null,\n \"startsWith\": \"oci_result=\"\n }\n}\n\nSample 3: Metric Extension with JMX collection method\n{\n \"name\": \"ME_TotalPhysicalMemoryInGB\",\n \"displayName\": \"Total Physical Memory In GigaBytes\",\n \"resourceType\": \"weblogic_j2eeserver\",\n \"compartmentId\": \"ocid1.compartment.oc1..<unique_id>\",\n \"description\": \"Collects TotalPhysicalMemoryInGB for server named PIA in GBs\",\n \"collectionRecurrences\": \"FREQ=HOURLY;INTERVAL=1\",\n \"metricList\": [\n {\n \"name\": \"TotalPhysicalMemorySize\",\n \"isDimension\": false,\n \"isHidden\": true,\n \"dataType\": \"NUMBER\"\n },\n {\n \"name\": \"TotalPhysicalMemorySizeGB\",\n \"displayName\": \"TotalPhysicalMemorySizeInGB\",\n \"isDimension\": false,\n \"isHidden\": false,\n \"dataType\": \"NUMBER\",\n \"computeExpression\": \"TotalPhysicalMemorySize > 0 ? (TotalPhysicalMemorySize/(1024*1024*1024)) : 0\",\n \"metricCategory\": \"UTILIZATION\"\n }\n ],\n \"queryProperties\": {\n \"collectionMethod\": \"JMX\",\n \"managedBeanQuery\": \"java.lang:type=OperatingSystem,Location=PIA\",\n \"jmxAttributes\": \"TotalPhysicalMemorySize\"\n }\n}\n"
EnableMetricExtensionDetails:
description: The Resource IDs for which metric extension will be enabled
properties:
resourceIds:
description: List of Resource IDs [OCIDs]. Currently supports upto 20 resources per request
items:
maxLength: 255
minLength: 1
type: string
maxItems: 20
minItems: 1
type: array
required:
- resourceIds
type: object
UpdateMetricExtensionDetails:
description: The information about updating a metric extension resource
properties:
collectionRecurrences:
description: Schedule of metric extension should use RFC 5545 format -> recur-rule-part = "FREQ";"INTERVAL" where FREQ rule part identifies the type of recurrence rule. Valid values are "MINUTELY","HOURLY","DAILY" to specify repeating events based on an interval of a minute, an hour and a day or more. Example- FREQ=DAILY;INTERVAL=1
format: x-obmcs-duration
type: string
description:
description: Description of the metric extension.
maxLength: 400
minLength: 0
type: string
displayName:
description: Metric Extension resource display name.
maxLength: 255
minLength: 1
type: string
metricList:
description: List of metrics which are part of this metric extension
items:
$ref: '#/components/schemas/Metric'
maxItems: 20
type: array
queryProperties:
$ref: '#/components/schemas/MetricExtensionUpdateQueryProperties'
type: object
x-example: "1. Sample update metric extension having SQL collection method\n The CreateMetricExtensionDetails example having SQL collection method is updated below\n using modified displayName, description, content and inParamValue sub-property of inParamDetails. \n\n{\n \"displayName\": \"Count of Running Instances in production\",\n \"description\": \"Collects count of instances in 'UP' status in production compartments from monitoring table\",\n \"queryProperties\": {\n \"collectionMethod\": \"SQL\",\n \"sqlDetails\": {\n \"content\": \"<new SQL statement as base64 encoded string>\"\n },\n \"inParamDetails\": [\n {\n \"inParamPosition\": 1,\n \"inParamValue\": \"production\"\n }\n ]\n }\n}\n\nNote#1: UpdateMetricExtension supports incremental changes to Metric Extension definition. \n Only the properties that need to be changed are required to be passed.\n For example in above case, properties like collectionRecurrences, metricList, sqlType are NOT passed,\n as there has been no change required in them. \n\n2. Sample update metric extension having OS Command collection method\n\nThe CreateMetricExtensionDetails example having OS Command collection method is updated below\nusing modified displayName, description, arguments (which is a sub-property inside queryProperties)\n\nNote#2: If one or more sub-property of queryProperties need a change, then only those sub-properties need to be \n sent inside queryProperties for update with latest values. In example below, as only \"arguments\" property \n was required to be changed, hence \"queryProperties\" property is required to be passed along with collectionMethod\n\nNote#3: Since no change is required in collectionRecurrences and metricList properties. \n Hence, they are not passed in UpdateMetricExtension request.\n\n{\n \"displayName\": \"Updated OS File System Utilization\",\n \"description\": \"Computes File System Utilization Percentage of various mount points on OS\",\n \"queryProperties\": {\n \"collectionMethod\": \"OS_COMMAND\",\n \"arguments\": \"arg1\"\n }\n}\n\nNote#4: When user needs to update metricList, then complete and updated metricList has to be sent.\n\nNote#5: For removing an optional property or sub-property, pass that as empty string or \"\" in the update request.\n"
WorkRequestLogEntry:
description: A log message from the execution of a work request.
properties:
message:
description: Human-readable log message.
type: string
timestamp:
description: The time the log message was written. An RFC3339 formatted datetime string
format: date-time
type: string
required:
- message
- timestamp
x-example: "{\n \"message\": \"Successfully created monitored resource with id [ocid1.stackmonitoringresource.oc1.iad.<unique_id>]\",\n \"timestamp\": \"2022-01-07T17:11:34.878Z\"\n}\n"
WorkRequest:
description: A description of workrequest status
properties:
compartmentId:
description: 'The ocid of the compartment that contains the work request. Work requests should be scoped to
the same compartment as the resource the work request affects. If the work request affects multiple resources,
and those resources are not in the same compartment, it is up to the service team to pick the primary
resource whose compartment should be used.
'
type: string
id:
description: The id of the work request.
type: string
operationType:
description: Type of the work request
enum:
- CREATE_RESOURCES
- UPDATE_RESOURCES
- DELETE_RESOURCES
- MOVE_RESOURCES
- ENABLE_EXTERNAL_DATABASE
- DISABLE_EXTERNAL_DATABASE
- ADD_SOURCES_TO_AGENT
- ENABLE_METRIC_EXTENSION
- DISABLE_METRIC_EXTENSION
- TEST_METRIC_EXTENSION
- BULK_ADD_RESOURCES
- BULK_DELETE_RESOURCES
- UPDATE_AND_PROPAGATE_TAGS
- IMPORT_RESOURCES
type: string
x-obmcs-top-level-enum: '#/definitions/OperationType'
percentComplete:
description: Percentage of the request completed.
format: float
type: number
resources:
description: The resources affected by this work request.
items:
$ref: '#/components/schemas/WorkRequestResource'
type: array
status:
description: Status of current work request.
enum:
- ACCEPTED
- IN_PROGRESS
- WAITING
- FAILED
- SUCCEEDED
- CANCELING
- CANCELED
type: string
x-obmcs-top-level-enum: '#/definitions/OperationStatus'
timeAccepted:
description: 'The date and time the request was created, as described in
[RFC 3339](https://tools.ietf.org/rfc/rfc3339), section 14.29.
'
format: date-time
type: string
timeFinished:
description: 'The date and time the object was finished, as described in [RFC 3339](https://tools.ietf.org/rfc/rfc3339).
'
format: date-time
type: string
timeStarted:
description: 'The date and time the request was started, as described in [RFC 3339](https://tools.ietf.org/rfc/rfc3339),
section 14.29.
'
format: date-time
type: string
required:
- operationType
- status
- id
- compartmentId
- resources
- percentComplete
- timeAccepted
x-example: "{\n \"operationType\": \"CREATE_RESOURCES\",\n \"status\": \"SUCCEEDED\",\n \"id\": \"ocid1.stackmonitoringworkrequest.oc1.iad.<unique_id>\",\n \"compartmentId\": \"ocid1.comapertment.oc1..<unique_id>\",\n \"resources\": [\n {\n \"entityType\": \"stackmonitoringresource\",\n \"actionType\": \"CREATED\"\n \"identifier\": \"ocid1.stackmonitoringresource.oc1.iad.<unique_id>\",\n \"entityUri\": \"/monitoredResources/ocid1.stackmonitoringresource.oc1.iad.<unique_id>\"\n }\n ],\n \"percentComplete\": 100,\n \"timeAccepted\": \"2021-11-29T19:11:37.920+0100\",\n \"timeStarted\": \"2021-11-29T19:11:55.920+0100\",\n \"timeFinished\": \"2021-11-29T19:13:37.920+0100\"\n}\n"
CreateProcessSetDetails:
description: Process Set create payload model.
properties:
compartmentId:
description: 'The [OCID](/Content/General/Concepts/identifiers.htm) of the compartment.
'
maxLength: 255
minLength: 1
type: string
definedTags:
additionalProperties:
additionalProperties:
description: 'The value of the tag. Only string, integer and boolean types are supported.
'
type: object
description: 'Key-value pair representing predefined tags'' keys and values scoped to a namespace.
Example: `{"bar-key": "value"}`
'
type: object
description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace.
Example: `{"foo-namespace": {"bar-key": "value"}}`
'
type: object
displayName:
description: Name of the Process Set.
maxLength: 255
minLength: 1
type: string
freeformTags:
additionalProperties:
type: string
description: 'Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only.
Example: `{"bar-key": "value"}`
'
type: object
specification:
$ref: '#/components/schemas/ProcessSetSpecification'
required:
- compartmentId
- displayName
- specification
type: object
x-example: "1. Example of a CreateProcessSetDetails object, which corresponds to the payload required to create a Process Set.\n {\n \"compartmentId\": \"ocid1.compartment.oc1.<unique_id>\",\n \"displayName\": \"nginx workers\",\n \"specification\": {\n \"items\": [\n {\n \"processCommand\": \"nginx\",\n \"processUser\": \"opc\",\n \"processLineRegexPattern\": \"nginx: worker.\",\n \"label\": \"nginx-workers\"\n },\n {\n \"processCommand\": \"nginx\",\n \"processUser\": \".\",\n \"processLineRegexPattern\": \"nginx: worker.\",\n \"label\": \"nginx-workers-any-user\"\n }\n ]\n }\n }\n"
MonitoredResourceCollection:
description: Results of a resources search. Contains MonitoredResourceSummary items and other data.
properties:
items:
description: List of monitored resources.
items:
$ref: '#/components/schemas/MonitoredResourceSummary'
type: array
required:
- items
type: object
AnomalyMetricData:
description: Anomaly Metric Details
properties:
dataPoints:
description: list of anomaly data points for the metric
items:
$ref: '#/components/schemas/AnomalyDataPoint'
minItems: 1
type: array
dimensions:
additionalProperties:
maxLength: 255
minLength: 1
type: string
description: list of dimensions for the metric
type: object
required:
- dataPoints
type: object
x-example: "{\n dimensions: [\n \"tablespaceName\": \"FINANCE\",\n \"hostName\", \"abc.xyc\"\n ],\n dataPoints: [\n {\n \"timestamp\": \"2023-05-15 05:13:00Z\",\n \"value\": 2.5,\n \"high\", 10,\n \"low\", 5\n \"anomaly\", -1\n },\n {\n \"timestamp\": \"2023-05-15 05:14:00Z\",\n \"value\": 2.5,\n \"high\", 10,\n \"low\", 5\n \"anomaly\", 0 \n }\n ]\n}\n"
AssociatedResourcesCollection:
description: Results of a resources search. Contains AssociatedResourcesSummary items.
properties:
items:
description: List of associated monitored resources.
items:
$ref: '#/components/schemas/AssociatedResourcesSummary'
type: array
required:
- items
type: object
MonitoredResourceTasksCollection:
description: A Collection of stack monitoring resource task summaries.
properties:
items:
description: List of stack monitoring resource task summaries.
items:
$ref: '#/components/schemas/MonitoredResourceTaskSummary'
type: array
required:
- items
type: object
x-example: "{\n \"items\": [\n {\n \"compartmentId\": \"ocid1.compartment.oc1.<unique_id>\",\n \"taskDetails\" : {\n \"type\" : \"IMPORT_OCI_TELEMETRY_RESOURCES\",\n \"source\" : \"OCI_TELEMETRY_NATIVE\",\n \"namespace\": \"oci_autonomous_database\"\n },\n \"workRequestIds\": [\"ocid1.stackmonitoredworkrequest.oc1.<unique_id>\"],\n \"timeCreated\": \"2022-01-27T15:01:10.254Z\",\n \"timeUpdated\": \"2022-01-27T15:04:34.456Z\",\n \"lifecycleState\": \"ACTIVE\",\n \"freeformTags\": {},\n \"definedTags\": {\n \"discoveryTags\": {\n \"stack\": \"middleware\"\n }\n }\n }\n ]\n}\n"
CreateMonitoredResourceTaskDetails:
description: The request details for the stack monitoring resource task.
properties:
compartmentId:
description: 'The [OCID](/Content/General/Concepts/identifiers.htm) of the compartment identifier.
'
maxLength: 255
minLength: 1
type: string
definedTags:
additionalProperties:
additionalProperties:
description: 'The value of the tag. Only string, integer and boolean types are supported.
'
type: object
description: 'Key-value pair representing predefined tags'' keys and values scoped to a namespace.
Example: `{"bar-key": "value"}`
'
type: object
description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace.
Example: `{"foo-namespace": {"bar-key": "value"}}`
'
type: object
freeformTags:
additionalProperties:
type: string
description: 'Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only.
Example: `{"bar-key": "value"}`
'
type: object
name:
description: 'Name of the task. If not provided by default the following names will be taken
OCI tasks - namespace plus timestamp.
'
maxLength: 255
minLength: 1
type: string
taskDetails:
$ref: '#/components/schemas/MonitoredResourceTaskDetails'
required:
- compartmentId
- taskDetails
type: object
x-example: "{\n \"compartmentId\": \"ocid1.compartment.oc1.<unique_id>\",\n \"name\":\"DiscOCiResources\",\n \"taskDetails\" : {\n \"type\" : \"IMPORT_OCI_TELEMETRY_RESOURCES\",\n \"source\" : \"OCI_TELEMETRY_NATIVE\",\n \"namespace\": \"oci_autonomous_database\"\n },\n \"freeformTags\": {},\n \"definedTags\": {\n \"discoveryTags\": {\n \"stack\": \"middleware\"\n }\n }\n}\n"
ResourceTypeMetadataDetails:
description: The metadata details for resource type.
discriminator:
propertyName: format
properties:
format:
description: 'ResourceType metadata format to be used. Currently supports only one format.
Possible values - SYSTEM_FORMAT.
* SYSTEM_FORMAT - The resource type metadata is defined in machine friendly format.
'
enum:
- SYSTEM_FORMAT
type: string
required:
- format
type: object
ChangeMonitoredResourceCompartmentDetails:
description: The information to be updated.
properties:
compartmentId:
description: 'The [OCID](/Content/General/Concepts/identifiers.htm) of the compartment
into which the resource should be moved.
'
maxLength: 255
minLength: 1
type: string
required:
- compartmentId
type: object
TestMetricExtensionDetails:
description: The resource Id on which test will be run
properties:
resourceIds:
description: List of Resource IDs [OCID]. Currently supports only one resource id per request.
items:
maxLength: 255
minLength: 1
type: string
maxItems: 1
minItems: 1
type: array
required:
- resourceIds
type: object
CredentialCollection:
description: List of DiscoveryJOb Credential Details.
properties:
items:
description: List of DiscoveryJob credentials.
items:
$ref: '#/components/schemas/CredentialDetails'
type: array
required:
- items
type: object
UpdateMonitoredResourceTaskDetails:
description: The request details for the stack monitoring resource task.
properties:
definedTags:
additionalProperties:
additionalProperties:
description: 'The value of the tag. Only string, integer and boolean types are supported.
'
type: object
description: 'Key-value pair representing predefined tags'' keys and values scoped to a namespace.
Example: `{"bar-key": "value"}`
'
type: object
description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace.
Example: `{"foo-namespace": {"bar-key": "value"}}`
'
type: object
freeformTags:
additionalProperties:
type: string
description: 'Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only.
Example: `{"bar-key": "value"}`
'
type: object
type: object
x-example: "{\n \"freeformTags\": {},\n \"definedTags\": {\n \"discoveryTags\": {\n \"stack\": \"middleware\"\n }\n }\n}\n"
WorkRequestResource:
description: A resource created or operated on by a work request.
properties:
actionType:
description: 'The way in which this resource is affected by the work tracked in the work request.
A resource being created, updated, or deleted will remain in the IN_PROGRESS state until
work is complete for that resource at which point it will transition to CREATED, UPDATED,
or DELETED, respectively.
'
enum:
- CREATED
- UPDATED
- DELETED
- IN_PROGRESS
- RELATED
- FAILED
type: string
x-obmcs-top-level-enum: '#/definitions/ActionType'
entityType:
description: The resource type the work request affects.
type: string
entityUri:
description: The URI path that the user can do a GET on to access the resource metadata
type: string
identifier:
description: The identifier of the resource the work request affects.
type: string
required:
- actionType
- entityType
- identifier
x-example: "{\n \"entityType\": \"stackmonitoringresource\",\n \"actionType\": \"CREATED\"\n \"identifier\": \"ocid1.stackmonitoringresource.oc1.iad.<unique_id>\",\n \"entityUri\": \"/monitoredResources/ocid1.stackmonitoringresource.oc1.iad.<unique_id>\"\n}\n"
BaselineableMetric:
allOf:
- $ref: '#/components/schemas/BaselineableMetricSummary'
- properties:
createdBy:
description: Created user id
maxLength: 255
minLength: 1
type: string
lastUpdatedBy:
description: last Updated user id
maxLength: 255
minLength: 1
type: string
timeCreated:
description: creation date
format: date-time
type: string
timeLastUpdated:
description: last updated time
format: date-time
type: string
type: object
description: Summary for the baseline-able metric
x-example: "{\n \"id\": \"ocid.smad.oc1.<unique_id>\",\n \"tenancyId\": \"ocid.tenancy.oc1.<unique_id>\",\n \"compartmentId\": \"ocid.compartment.oc1.<unique_id>\",\n \"name\": \"Memory\",\n \"column\":\"MemoryUtilization\",\n \"namespace\": \"oracle_appmgmt\",\n \"resourceGroup\": \"oracle_database\",\n \"isOutOfBox\": TRUE,\n \"lifecycleState\": \"ACTIVE\"\n \"createdBy\": \"abc@xyz.com\",\n \"lastUpdatedBy\": \"def@xyz.com\",\n \"timeCreated\": \"2023-05-16 05:13:00Z\",\n \"timeLastUpdated\": \"2023-05-16 06:13:00Z\",\n}\n"
MonitoredResourcesCountAggregation:
description: The count of resources for specified dimension.
properties:
count:
description: the value of this metric
type: integer
dimensions:
additionalProperties:
maxLength: 255
minLength: 1
type: string
description: "Qualifiers provided in a metric definition. \nAvailable dimensions vary based on groupBy parameter.\nEach dimension takes the form of a key-value pair.\n\nExample: `\"resourceType\": \"oci_autonomous_database\"`\n"
type: object
required:
- dimensions
- count
type: object
MonitoredResourceAliasSourceCredential:
description: 'Monitored Resource Alias Reference Source Credential.
'
properties:
name:
description: 'The name of the pre-existing source credential which alias cred should point to.
This should refer to the pre-existing source attribute which is bound to credential name.
'
maxLength: 96
minLength: 1
type: string
service:
description: "The name of the service owning the credential. \nExample: stack-monitoring or dbmgmt\n"
maxLength: 255
minLength: 1
type: string
source:
description: 'The source type and source name combination,delimited with (.) separator.
This refers to the pre-existing source which alias cred should point to.
Ex. {source type}.{source name} and source type max char limit is 63.
'
maxLength: 255
minLength: 1
type: string
required:
- source
- name
- service
type: object
DataPoint:
description: metric data point
properties:
timestamp:
description: timestamp of when the metric was collected
format: date-time
type: string
value:
description: value for the metric data point
format: double
type: number
required:
- timestamp
- value
type: object
x-example: "{\n \"timestamp\": \"2023-05-16 05:13:00Z\",\n \"value\": 2.5\n}\n"
Config:
description: "A configuration item that, for example defines whether resources of a specific type \nshould be discovered automatically. \n\nIn this case, the 'configType' is set to 'AUTO_PROMOTE' and additional fields like\n'resourceType' and 'isEnabled' determine if such resources are to be discovered\nautomatically (also referred to as 'Automatic Promotion').\n"
discriminator:
propertyName: configType
properties:
compartmentId:
description: The OCID of the compartment containing the configuration.
type: string
configType:
description: The type of configuration.
enum:
- AUTO_PROMOTE
- LICENSE_AUTO_ASSIGN
- LICENSE_ENTERPRISE_EXTENSIBILITY
type: string
definedTags:
additionalProperties:
additionalProperties:
description: 'The value of the tag. Only string, integer and boolean types are supported.
'
type: object
description: 'Key-value pair representing predefined tags'' keys and values scoped to a namespace.
Example: `{"bar-key": "value"}`
'
type: object
description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace.
Example: `{"foo-namespace": {"bar-key": "value"}}`
'
type: object
displayName:
description: A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information.
type: string
freeformTags:
additionalProperties:
type: string
description: 'Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only.
Example: `{"bar-key": "value"}`
'
type: object
id:
description: The Unique Oracle ID (OCID) that is immutable on creation.
type: string
lifecycleState:
description: The current state of the configuration.
enum:
- CREATING
- UPDATING
- ACTIVE
- DELETING
- DELETED
- FAILED
type: string
systemTags:
additionalProperties:
additionalProperties:
description: 'The value of the tag. Only string, integer and boolean types are supported.
'
type: object
description: 'Key-value pair representing system tags'' keys and values scoped to a namespace.
Example: `{"bar-key": "value"}`
'
type: object
description: 'Usage of system tag keys. These predefined keys are scoped to namespaces.
Example: `{"orcl-cloud": {"free-tier-retained": "true"}}`
'
type: object
timeCreated:
description: The time the configuration was created. An RFC3339 formatted datetime string.
format: date-time
type: string
timeUpdated:
description: The time the Config was updated.
format: date-time
type: string
required:
- id
- compartmentId
- lifecycleState
- configType
type: object
WorkRequestError:
description: An error encountered while executing a work request.
properties:
code:
description: 'A machine-usable code for the error that occured. Error codes are listed on
(https://docs.cloud.oracle.com/Content/API/References/apierrors.htm)
'
type: string
message:
description: A human readable description of the issue encountered.
type: string
timestamp:
description: The time the error occured. An RFC3339 formatted datetime string.
format: date-time
type: string
required:
- code
- message
- timestamp
x-example: "{\n \"code\": \"500\",\n \"message\": \"CreateResources work request failed with error: SubmitWorkDetailsToAgent failed with error [(404, NotAuthorizedOrNotFound, false) Unknown resource ocid1.managementagent.oc1.iad.<unique_id> (opc-request-id: <unique_id>)]\",\n \"timestamp\": \"2022-01-07T15:59:10.279Z\"\n}\n"
UpdateProcessSetDetails:
description: Process Set update payload model.
properties:
definedTags:
additionalProperties:
additionalProperties:
description: 'The value of the tag. Only string, integer and boolean types are supported.
'
type: object
description: 'Key-value pair representing predefined tags'' keys and values scoped to a namespace.
Example: `{"bar-key": "value"}`
'
type: object
description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace.
Example: `{"foo-namespace": {"bar-key": "value"}}`
'
type: object
displayName:
description: Name of the Process Set.
maxLength: 255
minLength: 1
type: string
freeformTags:
additionalProperties:
type: string
description: 'Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only.
Example: `{"bar-key": "value"}`
'
type: object
specification:
$ref: '#/components/schemas/ProcessSetSpecification'
type: object
x-example: "1. Example of a UpdateProcessSetDetails object, which corresponds to the payload required to update a Process Set.\n {\n \"displayName\": \"nginx workers\",\n \"specification\": {\n \"items\": [\n {\n \"processCommand\": \"nginx\",\n \"processUser\": \"opc\",\n \"processLineRegexPattern\": \"nginx: worker.\",\n \"label\": \"nginx-workers\"\n }\n ]\n }\n }\n"
MonitoredResourceTypeSummary:
description: The summary of monitored resource type.
properties:
compartmentId:
description: 'The [OCID](/Content/General/Concepts/identifiers.htm) of the tenancy containing the resource type.
'
maxLength: 255
minLength: 1
type: string
definedTags:
additionalProperties:
additionalProperties:
description: 'The value of the tag. Only string, integer and boolean types are supported.
'
type: object
description: 'Key-value pair representing predefined tags'' keys and values scoped to a namespace.
Example: `{"bar-key": "value"}`
'
type: object
description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace.
Example: `{"foo-namespace": {"bar-key": "value"}}`
'
type: object
description:
description: A friendly description.
maxLength: 255
minLength: 1
type: string
displayName:
description: Monitored resource type display name.
maxLength: 255
minLength: 1
type: string
freeformTags:
additionalProperties:
type: string
description: 'Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only.
Example: `{"bar-key": "value"}`
'
type: object
id:
description: 'Monitored resource type identifier [OCID](/Content/General/Concepts/identifiers.htm).
'
maxLength: 255
minLength: 1
type: string
lifecycleState:
description: Lifecycle state of the monitored resource type.
enum:
- CREATING
- UPDATING
- ACTIVE
- INACTIVE
- DELETING
- DELETED
- FAILED
type: string
x-obmcs-top-level-enum: '#/definitions/ResourceTypeLifecycleState'
metadata:
$ref: '#/components/schemas/ResourceTypeMetadataDetails'
metricNamespace:
description: Metric namespace for resource type.
maxLength: 255
minLength: 1
type: string
name:
description: "A unique monitored resource type name. The name must be unique across tenancy. \nName can not be changed.\n"
maxLength: 255
minLength: 1
type: string
resourceCategory:
description: 'Resource Category to indicate the kind of resource type.
'
enum:
- APPLICATION
- DATABASE
- MIDDLEWARE
- UNKNOWN
type: string
x-obmcs-top-level-enum: '#/definitions/ResourceCategory'
sourceType:
description: 'Source type to indicate if the resource is stack monitoring discovered, OCI native resource, etc.
'
enum:
- SM_MGMT_AGENT_MONITORED
- SM_REPO_ONLY
- OCI_NATIVE
- PROMETHEUS
- TELEGRAF
- COLLECTD
type: string
x-obmcs-top-level-enum: '#/definitions/SourceType'
systemTags:
additionalProperties:
additionalProperties:
description: 'The value of the tag. Only string, integer and boolean types are supported.
'
type: object
description: 'Key-value pair representing system tags'' keys and values scoped to a namespace.
Example: `{"bar-key": "value"}`
'
type: object
description: 'Usage of system tag keys. These predefined keys are scoped to namespaces.
Example: `{"orcl-cloud": {"free-tier-retained": "true"}}`
'
type: object
timeCreated:
description: "The date and time when the monitored resource type was created, expressed in \n[RFC 3339](https://tools.ietf.org/html/rfc3339) timestamp format.\n"
format: date-time
type: string
timeUpdated:
description: "The date and time when the monitored resource was updated, expressed in \n[RFC 3339](https://tools.ietf.org/html/rfc3339) timestamp format.\n"
format: date-time
type: string
required:
- id
- name
- compartmentId
type: object
x-example: "{\n \"id\": \"ocid1.stackmonitoringresourcetype.oc1.iad.<unique_id>\",\n \"compartmentId\": \"ocid1.tenancy.oc1.<unique_id>\",\n \"name\": \"host\",\n \"displayName\": \"Host\",\n \"description\": \"System defined monitoring resource type for host resource type\",\n \"lifecycleState\": \"ACTIVE\",\n \"metricNamespace\": \"oracle_appmgmt\",\n \"sourceType\": \"OCI_NATIVE\",\n \"resourceCategory\": \"APPLICATION\",\n \"metadata\": {\n \"format\" : \"SYSTEM_FORMAT\",\n \"requiredProperties\": [\"osName\",\"osVersion\"],\n \"agentProperties\": [\"hostType\",\"osType\",\"osName\",\"osVersion\"],\n \"validPropertiesForCreate\": [\"osName\",\"osVersion\"],\n \"validPropertiesForUpdate\": [\"osName\",\"osVersion\",\"hostType\", \"osType\"],\n \"uniquePropertySets\":[\n {\n \"properties\":[\"host_uuid\"]\n }\n ],\n \"validPropertyValues\":{\n \"osType\":[\"Linux\"]\n }\n },\n \"timeCreated\": \"2022-01-27T15:01:10.254Z\",\n \"timeUpdated\": \"2022-01-27T15:04:34.456Z\",\n \"freeformTags\": {},\n \"definedTags\": {\n \"discoveryTags\": {\n \"stack\": \"middleware\"\n }\n },\n \"systemTags\": {}\n}\n"
MonitoredResourceType:
description: 'The response object for create monitored resource type and get monitored resource type operations.
'
properties:
compartmentId:
description: 'The [OCID](/Content/General/Concepts/identifiers.htm) of the tenancy containing the resource type.
'
maxLength: 255
minLength: 1
type: string
definedTags:
additionalProperties:
additionalProperties:
description: 'The value of the tag. Only string, integer and boolean types are supported.
'
type: object
description: 'Key-value pair representing predefined tags'' keys and values scoped to a namespace.
Example: `{"bar-key": "value"}`
'
type: object
description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace.
Example: `{"foo-namespace": {"bar-key": "value"}}`
'
type: object
description:
description: A friendly description.
maxLength: 255
minLength: 1
type: string
displayName:
description: Monitored resource type display name.
maxLength: 255
minLength: 1
type: string
freeformTags:
additionalProperties:
type: string
description: 'Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only.
Example: `{"bar-key": "value"}`
'
type: object
id:
description: 'Monitored resource type identifier [OCID](/Content/General/Concepts/identifiers.htm).
'
maxLength: 255
minLength: 1
type: string
lifecycleState:
description: Lifecycle state of the monitored resource type.
enum:
- CREATING
- UPDATING
- ACTIVE
- INACTIVE
- DELETING
- DELETED
- FAILED
type: string
x-obmcs-top-level-enum: '#/definitions/ResourceTypeLifecycleState'
metadata:
$ref: '#/components/schemas/ResourceTypeMetadataDetails'
metricNamespace:
description: Metric namespace for resource type.
maxLength: 255
minLength: 1
type: string
name:
description: "A unique monitored resource type name. The name must be unique across tenancy. \nName can not be changed.\n"
maxLength: 255
minLength: 1
type: string
resourceCategory:
description: 'Resource Category to indicate the kind of resource type.
'
enum:
- APPLICATION
- DATABASE
- MIDDLEWARE
- UNKNOWN
type: string
x-obmcs-top-level-enum: '#/definitions/ResourceCategory'
sourceType:
description: 'Source type to indicate if the resource is stack monitoring discovered, OCI native resource, etc.
'
enum:
- SM_MGMT_AGENT_MONITORED
- SM_REPO_ONLY
- OCI_NATIVE
- PROMETHEUS
- TELEGRAF
- COLLECTD
type: string
x-obmcs-top-level-enum: '#/definitions/SourceType'
systemTags:
additionalProperties:
additionalProperties:
description: 'The value of the tag. Only string, integer and boolean types are supported.
'
type: object
description: 'Key-value pair representing system tags'' keys and values scoped to a namespace.
Example: `{"bar-key": "value"}`
'
type: object
description: 'Usage of system tag keys. These predefined keys are scoped to namespaces.
Example: `{"orcl-cloud": {"free-tier-retained": "true"}}`
'
type: object
timeCreated:
description: "The date and time when the monitored resource type was created, expressed in \n[RFC 3339](https://tools.ietf.org/html/rfc3339) timestamp format.\n"
format: date-time
type: string
timeUpdated:
description: "The date and time when the monitored resource was updated, expressed in \n[RFC 3339](https://tools.ietf.org/html/rfc3339) timestamp format.\n"
format: date-time
type: string
required:
- id
- name
- compartmentId
type: object
x-example: "{\n \"id\": \"ocid1.stackmonitoringresourcetype.oc1.iad.<unique_id>\",\n \"compartmentId\": \"ocid1.tenancy.oc1.<unique_id>\",\n \"name\": \"host\",\n \"displayName\": \"Host\",\n \"lifecycleState\" : \"ACTIVE\",\n \"description\": \"System defined resource type\",\n \"metricNamespace\": \"oracle_appmgmt\",\n \"sourceType\": \"OCI_NATIVE\",\n \"resourceCategory\": \"APPLICATION\",\n \"metadata\": {\n \"format\" : \"SYSTEM_FORMAT\",\n \"requiredProperties\": [\"osName\",\"osVersion\"],\n \"agentProperties\": [\"hostType\",\"osType\",\"osName\",\"osVersion\"],\n \"validPropertiesForCreate\": [\"osName\",\"osVersion\"],\n \"validPropertiesForUpdate\": [\"osName\",\"osVersion\",\"hostType\", \"osType\"],\n \"uniquePropertySets\":[\n {\n \"properties\":[\"host_uuid\"]\n }\n ],\n \"validPropertyValues\":{\n \"osType\":[\"Linux\"]\n }\n },\n \"timeCreated\": \"2022-01-27T15:01:10.254Z\",\n \"timeUpdated\": \"2022-01-27T15:04:34.456Z\",\n \"freeformTags\": {},\n \"definedTags\": {\n \"discoveryTags\": {\n \"stack\": \"middleware\"\n }\n },\n \"systemTags\": {}\n}\n"
UpdateConfigDetails:
description: Change the configuration.
discriminator:
propertyName: configType
properties:
configType:
description: The type of configuration.
type: string
x-obmcs-enumref: '#/definitions/Config/configType'
definedTags:
additionalProperties:
additionalProperties:
description: 'The value of the tag. Only string, integer and boolean types are supported.
'
type: object
description: 'Key-value pair representing predefined tags'' keys and values scoped to a namespace.
Example: `{"bar-key": "value"}`
'
type: object
description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace.
Example: `{"foo-namespace": {"bar-key": "value"}}`
'
type: object
displayName:
description: The display name of the configuration.
type: string
freeformTags:
additionalProperties:
type: string
description: 'Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only.
Example: `{"bar-key": "value"}`
'
type: object
type: object
ProcessSet:
description: The Process Set details.
properties:
compartmentId:
description: 'The [OCID](/Content/General/Concepts/identifiers.htm) of the compartment.
'
maxLength: 255
minLength: 1
type: string
definedTags:
additionalProperties:
additionalProperties:
description: 'The value of the tag. Only string, integer and boolean types are supported.
'
type: object
description: 'Key-value pair representing predefined tags'' keys and values scoped to a namespace.
Example: `{"bar-key": "value"}`
'
type: object
description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace.
Example: `{"foo-namespace": {"bar-key": "value"}}`
'
type: object
displayName:
description: Name of the Process Set.
maxLength: 255
minLength: 1
type: string
freeformTags:
additionalProperties:
type: string
description: 'Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only.
Example: `{"bar-key": "value"}`
'
type: object
id:
description: 'The [OCID](/Content/General/Concepts/identifiers.htm) of the Process Set.
'
maxLength: 255
minLength: 1
type: string
lifecycleState:
description: The current state of the Resource.
enum:
- CREATING
- UPDATING
- ACTIVE
- DELETING
- DELETED
- FAILED
type: string
x-obmcs-top-level-enum: '#/definitions/LifecycleState'
revision:
description: The current revision of the Process Set.
minLength: 1
type: string
specification:
$ref: '#/components/schemas/ProcessSetSpecification'
systemTags:
additionalProperties:
additionalProperties:
description: 'The value of the tag. Only string, integer and boolean types are supported.
'
type: object
description: 'Key-value pair representing system tags'' keys and values scoped to a namespace.
Example: `{"bar-key": "value"}`
'
type: object
description: 'Usage of system tag keys. These predefined keys are scoped to namespaces.
Example: `{"orcl-cloud": {"free-tier-retained": "true"}}`
'
type: object
timeCreated:
description: The time the process set was created. An RFC3339 formatted datetime string.
format: date-time
type: string
timeUpdated:
description: The time the process set was last updated. An RFC3339 formatted datetime string.
format: date-time
type: string
required:
- id
- compartmentId
- lifecycleState
- displayName
- specification
- timeCreated
- revision
type: object
x-example: "1. Example of a ProcessSet object.\n {\n \"id\": \"ocid1.stackmonitoringprocesset.oc1.<unique_id>\",\n \"compartmentId\": \"ocid1.compartment.oc1.<unique_id>\",\n \"lifecycleState\": \"ACTIVE\",\n \"displayName\": \"nginx workers\",\n \"specification\": {\n \"items\": [\n {\n \"processCommand\": \"nginx\",\n \"processUser\": \"opc\",\n \"processLineRegexPattern\": \"nginx: worker.\",\n \"label\": \"nginx-workers\"\n }\n ]\n },\n \"revision\": \"5\"\n }\n"
ChangeConfigCompartmentDetails:
description: Details for which compartment to move the resource to.
properties:
compartmentId:
description: 'The [OCID](/Content/General/Concepts/identifiers.htm) of the compartment
into which the resource should be moved.
'
maxLength: 255
minLength: 1
type: string
required:
- compartmentId
type: object
AssociateMonitoredResourcesDetails:
description: The information required to create new monitored resource association.
properties:
associationType:
description: 'Association type to be created between source and destination resources.
'
maxLength: 255
minLength: 1
type: string
compartmentId:
description: 'Compartment Identifier [OCID](/Content/General/Concepts/identifiers.htm).
'
maxLength: 255
minLength: 1
type: string
destinationResourceId:
description: 'Destination Monitored Resource Identifier [OCID](/Content/General/Concepts/identifiers.htm).
'
maxLength: 255
minLength: 1
type: string
sourceResourceId:
description: 'Source Monitored Resource Identifier [OCID](/Content/General/Concepts/identifiers.htm).
'
maxLength: 255
minLength: 1
type: string
required:
- associationType
- sourceResourceId
- destinationResourceId
- compartmentId
type: object
x-example: "{\n \"associationType\": \"contains\",\n \"sourceResourceId\": \"ocid1.stackmonitoringresource.oc1.iad.<unique_id>\",\n \"destinationResourceId\": \"ocid1.stackmonitoringresource.oc1.iad.<unique_id>\",\n \"compartmentId\" \"ocid1.compartment.oc1.<src_cmpt_id>\"\n}\n"
MonitoredResourceProperty:
description: 'Property of monitored resource.
'
properties:
name:
description: 'Property Name.
'
maxLength: 64
minLength: 1
type: string
value:
description: 'Property Value.
'
maxLength: 4000
minLength: 0
type: string
type: object
TestMetricExtensionData:
description: The Test result details
properties:
testRunId:
description: Test Run Id
maxLength: 255
minLength: 1
type: string
testRunMetricSuffix:
description: Test Run Metric Suffix
maxLength: 255
minLength: 1
type: string
testRunNamespaceName:
description: Test Run Namespace name
maxLength: 255
minLength: 1
type: string
testRunResourceGroupName:
description: Test Run Resource Group name
maxLength: 255
minLength: 0
type: string
required:
- testRunId
- testRunMetricSuffix
- testRunNamespaceName
type: object
MetricExtensionCollection:
description: Results of a metric extension search. Contains list of MetricExtension items.
properties:
items:
description: List of metric extensions.
items:
$ref: '#/components/schemas/MetricExtensionSummary'
type: array
required:
- items
type: object
MonitoredResourceAliasCredential:
description: Monitored Resource Alias Credential Details
properties:
credential:
$ref: '#/components/schemas/MonitoredResourceAliasSourceCredential'
name:
description: The name of the alias, within the context of the source.
maxLength: 96
minLength: 1
type: string
source:
description: 'The source type and source name combination,delimited with (.) separator.
Example: {source type}.{source name} and source type max char limit is 63.
'
maxLength: 255
minLength: 1
type: string
required:
- source
- name
- credential
type: object
AssociationResourceDetails:
description: 'Association Resource Details.
'
properties:
compartmentId:
description: 'Compartment Identifier [OCID](/Content/General/Concepts/identifiers.htm).
'
maxLength: 255
minLength: 1
type: string
name:
description: 'Monitored Resource Name.
'
maxLength: 255
minLength: 1
type: string
type:
description: 'Monitored Resource Type.
'
maxLength: 255
minLength: 1
type: string
type: object
AssociatedMonitoredResource:
description: The information about monitored resource.
properties:
association:
description: 'Association details of the resource.
'
items:
$ref: '#/components/schemas/AssociationDetails'
type: object
compartmentId:
description: 'Compartment Identifier [OCID](/Content/General/Concepts/identifiers.htm).
'
maxLength: 255
minLength: 1
type: string
displayName:
description: Monitored resource display name.
maxLength: 255
minLength: 1
type: string
externalId:
description: "External resource is any OCI resource identifier [OCID](/Content/General/Concepts/identifiers.htm)\nwhich is not a Stack Monitoring service resource.\nCurrently supports only following resource types - Container database, non-container database, \npluggable database and OCI compute instance.\n"
maxLength: 255
minLength: 1
type: string
hostName:
description: 'Monitored Resource Host Name.
'
maxLength: 255
minLength: 1
type: string
id:
description: 'Monitored resource identifier [OCID](/Content/General/Concepts/identifiers.htm).
'
maxLength: 255
minLength: 1
type: string
license:
description: License edition of the monitored resource.
enum:
- STANDARD_EDITION
- ENTERPRISE_EDITION
type: string
x-obmcs-top-level-enum: '#/definitions/LicenseType'
lifecycleState:
description: The current state of the monitored resource.
enum:
- CREATING
- UPDATING
- ACTIVE
- DELETING
- DELETED
- FAILED
type: string
x-obmcs-top-level-enum: '#/definitions/ResourceLifecycleState'
managementAgentId:
description: Management Agent Identifier [OCID](/Content/General/Concepts/identifiers.htm).
maxLength: 255
minLength: 1
type: string
name:
description: 'Monitored Resource Name.
'
maxLength: 255
minLength: 1
type: string
resourceCategory:
description: 'Resource Category to indicate the kind of resource type.
'
enum:
- APPLICATION
- DATABASE
- MIDDLEWARE
- UNKNOWN
type: string
x-obmcs-top-level-enum: '#/definitions/ResourceCategory'
sourceType:
description: 'Source type to indicate if the resource is stack monitoring discovered, OCI native resource, etc.
'
enum:
- SM_MGMT_AGENT_MONITORED
- SM_REPO_ONLY
- OCI_NATIVE
- PROMETHEUS
- TELEGRAF
- COLLECTD
type: string
x-obmcs-top-level-enum: '#/definitions/SourceType'
type:
description: 'Monitored Resource Type.
'
maxLength: 255
minLength: 1
type: string
required:
- id
type: object
MetricData:
description: Metric Details
properties:
dimensions:
additionalProperties:
maxLength: 255
minLength: 1
type: string
description: list of dimensions for the metric
type: object
evaluationDataPoints:
description: list of data points for the metric for evaluation of anomalies
items:
$ref: '#/components/schemas/DataPoint'
minItems: 1
type: array
trainingDataPoints:
description: list of data points for the metric for training of baseline
items:
$ref: '#/components/schemas/DataPoint'
minItems: 1
type: array
required:
- trainingDataPoints
- evaluationDataPoints
type: object
x-example: "{\n dimensions: [\n \"tablespaceName\": \"FINANCE\",\n \"hostName\", \"abc.xyc\"\n ],\n trainingDataPoints: [\n {\n \"timestamp\": \"2023-05-15 05:13:00Z\",\n \"value\": 2.5\n },\n {\n \"timestamp\": \"2023-05-15 05:14:00Z\",\n \"value\": 2.5\n }\n ],\n evaluationDataPoints: [\n {\n \"timestamp\": \"2023-05-16 05:13:00Z\",\n \"value\": 2.5\n },\n {\n \"timestamp\": \"2023-05-16 05:14:00Z\",\n \"value\": 2.5\n }\n ]\n}\n"
MonitoredResourceAssociation:
description: Association details between two monitored resources.
properties:
associationType:
description: 'Association Type.
'
maxLength: 255
minLength: 1
type: string
category:
default: SYSTEM
description: "Association category. Possible values are:\n- System created (SYSTEM), \n- User created using API (USER_API)\n- User created using tags (USER_TAG_ASSOC).\n"
enum:
- SYSTEM
- USER_API
- USER_TAG_ASSOC
maxLength: 255
minLength: 1
type: string
compartmentId:
description: 'Compartment Identifier [OCID](/Content/General/Concepts/identifiers.htm).
'
maxLength: 255
minLength: 1
type: string
definedTags:
additionalProperties:
additionalProperties:
description: 'The value of the tag. Only string, integer and boolean types are supported.
'
type: object
description: 'Key-value pair representing predefined tags'' keys and values scoped to a namespace.
Example: `{"bar-key": "value"}`
'
type: object
description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace.
Example: `{"foo-namespace": {"bar-key": "value"}}`
'
type: object
destinationResourceDetails:
$ref: '#/components/schemas/AssociationResourceDetails'
destinationResourceId:
description: 'Destination Monitored Resource Identifier [OCID](/Content/General/Concepts/identifiers.htm).
'
maxLength: 255
minLength: 1
type: string
freeformTags:
additionalProperties:
type: string
description: 'Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only.
Example: `{"bar-key": "value"}`
'
type: object
sourceResourceDetails:
$ref: '#/components/schemas/AssociationResourceDetails'
sourceResourceId:
description: 'Source Monitored Resource Identifier [OCID](/Content/General/Concepts/identifiers.htm).
'
maxLength: 255
minLength: 1
type: string
systemTags:
additionalProperties:
additionalProperties:
description: 'The value of the tag. Only string, integer and boolean types are supported.
'
type: object
description: 'Key-value pair representing system tags'' keys and values scoped to a namespace.
Example: `{"bar-key": "value"}`
'
type: object
description: 'Usage of system tag keys. These predefined keys are scoped to namespaces.
Example: `{"orcl-cloud": {"free-tier-retained": "true"}}`
'
type: object
tenantId:
description: 'Tenancy Identifier [OCID](/Content/General/Concepts/identifiers.htm).
'
maxLength: 255
minLength: 1
type: string
timeCreated:
description: 'The time when the association was created. An RFC3339 formatted datetime string.
'
format: date-time
type: string
required:
- associationType
- sourceResourceId
- destinationResourceId
- tenantId
- compartmentId
type: object
x-example: "{\n \"associationType\": \"contains\",\n \"tenantId\": \"ocid1.tenancy.oc1.<unique_id>\",\n \"sourceResourceId\": \"ocid1.stackmonitoringresource.oc1.iad.<unique_id>\",\n \"destinationResourceId\": \"ocid1.stackmonitoringresource.oc1.iad.<unique_id>\",\n \"sourceResourceDetails\": {\n \"name\": \"domain1\",\n \"type\": \"weblogic_domain\"\n ,\"compartmentId\": \"ocid1.compartment.oc1.<src_compt_id>\"\n },\n \"destinationResourceDetails\": {\n \"name\": \"cluster1\",\n \"type\": \"weblogic_cluster\"\n ,\"compartmentId\": \"ocid1.compartment.oc1.<dest_compt_id>\"\n },\n \"timeCreated\": \"2022-02-03T16:18:12.394Z\",\n \"category\": \"SYSTEM\",\n \"freeformTags\": null,\n \"definedTags\": null,\n \"systemTags\": null\n}\n"
ProcessSetSummary:
description: Summary of a Process Set, used to construct a list of Process Sets when fetching all Process Sets in a compartment.
properties:
compartmentId:
description: 'The [OCID](/Content/General/Concepts/identifiers.htm) of the compartment.
'
maxLength: 255
minLength: 1
type: string
definedTags:
additionalProperties:
additionalProperties:
description: 'The value of the tag. Only string, integer and boolean types are supported.
'
type: object
description: 'Key-value pair representing predefined tags'' keys and values scoped to a namespace.
Example: `{"bar-key": "value"}`
'
type: object
description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace.
Example: `{"foo-namespace": {"bar-key": "value"}}`
'
type: object
displayName:
description: Name of the Process Set.
maxLength: 255
minLength: 1
type: string
freeformTags:
additionalProperties:
type: string
description: 'Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only.
Example: `{"bar-key": "value"}`
'
type: object
id:
description: 'The [OCID](/Content/General/Concepts/identifiers.htm) of the Process Set.
'
maxLength: 255
minLength: 1
type: string
lifecycleState:
description: The current state of the Resource.
enum:
- CREATING
- UPDATING
- ACTIVE
- DELETING
- DELETED
- FAILED
type: string
x-obmcs-top-level-enum: '#/definitions/LifecycleState'
revision:
description: The current revision of the Process Set.
minLength: 1
type: string
specification:
$ref: '#/components/schemas/ProcessSetSpecification'
systemTags:
additionalProperties:
additionalProperties:
description: 'The value of the tag. Only string, integer and boolean types are supported.
'
type: object
description: 'Key-value pair representing system tags'' keys and values scoped to a namespace.
Example: `{"bar-key": "value"}`
'
type: object
description: 'Usage of system tag keys. These predefined keys are scoped to namespaces.
Example: `{"orcl-cloud": {"free-tier-retained": "true"}}`
'
type: object
timeCreated:
description: The time the process set was created. An RFC3339 formatted datetime string.
format: date-time
type: string
timeUpdated:
description: The time the process set was last updated. An RFC3339 formatted datetime string.
format: date-time
type: string
required:
- id
- compartmentId
- lifecycleState
- displayName
- specification
- revision
- timeCreated
type: object
x-example: "1. Example of a ProcessSetSummary object.\n {\n \"id\": \"ocid1.stackmonitoringprocesset.oc1.<unique_id>\",\n \"compartmentId\": \"ocid1.compartment.oc1.<unique_id>\",\n \"lifecycleState\": \"ACTIVE\",\n \"displayName\": \"nginx workers\",\n \"specification\": {\n \"items\": [\n {\n \"processCommand\": \"nginx\",\n \"processUser\": \"opc\",\n \"processLineRegexPattern\": \"nginx: worker.\",\n \"label\": \"nginx-workers\"\n }\n ]\n },\n \"revision\": \"5\"\n }\n"
ChangeMonitoredResourceTaskCompartmentDetails:
description: The information required for change of compartment for stack monitoring resource task.
properties:
compartmentId:
description: 'The [OCID](/Content/General/Concepts/identifiers.htm) of the compartment
into which the resource should be moved.
'
maxLength: 255
minLength: 1
type: string
required:
- compartmentId
type: object
SearchMonitoredResourcesDetails:
description: The property search criteria for listing monitored resources.
properties:
compartmentId:
description: 'Compartment Identifier [OCID](/Content/General/Concepts/identifiers.htm).
'
maxLength: 255
minLength: 1
type: string
compartmentIds:
default: []
description: 'Multiple compartment identifiers [OCID](/Content/General/Concepts/identifiers.htm).
'
items:
type: string
maxItems: 5
type: array
externalId:
description: "External resource is any OCI resource identifier [OCID](/Content/General/Concepts/identifiers.htm)\nwhich is not a Stack Monitoring service resource.\nCurrently supports only following resource types - Container database, non-container database, \npluggable database and OCI compute instance.\n"
maxLength: 255
minLength: 1
type: string
hostName:
description: 'A filter to return resources with host name match.
'
maxLength: 255
minLength: 1
type: string
hostNameContains:
description: 'A filter to return resources with host name pattern.
'
maxLength: 255
minLength: 1
type: string
license:
description: License edition of the monitored resource.
enum:
- STANDARD_EDITION
- ENTERPRISE_EDITION
type: string
x-obmcs-top-level-enum: '#/definitions/LicenseType'
lifecycleState:
description: A filter to return resources with matching lifecycle state.
enum:
- CREATING
- UPDATING
- ACTIVE
- DELETING
- DELETED
- FAILED
type: string
x-obmcs-top-level-enum: '#/definitions/ResourceLifecycleState'
lifecycleStates:
default: []
description: 'Multiple lifecycle states filter.
'
items:
$ref: '#/components/schemas/ResourceLifecycleState'
maxItems: 5
type: array
managementAgentId:
description: A filter to return resources with matching management agent id.
maxLength: 255
minLength: 1
type: string
name:
description: 'A filter to return resources that match exact resource name.
'
maxLength: 255
minLength: 1
type: string
nameContains:
description: A filter to return resources that match resource name pattern given. The match is not case sensitive.
maxLength: 255
minLength: 1
type: string
propertyEquals:
additionalProperties:
type: string
description: Criteria based on resource property.
type: object
resourceCategory:
description: Resource category filter.
enum:
- APPLICATION
- DATABASE
- MIDDLEWARE
- UNKNOWN
type: string
x-obmcs-top-level-enum: '#/definitions/ResourceCategory'
resourceTimeZone:
default: Etc/UTC
description: 'Time zone in the form of tz database canonical zone ID. Specifies the preference with
a value that uses the IANA Time Zone Database format (x-obmcs-time-zone).
For example - America/Los_Angeles
'
example: America/Los_Angeles
format: x-obmcs-time-zone
type: string
sortBy:
default: TIME_CREATED
description: 'The field to sort by. Only one sort order may be provided.
Default order for timeCreated is descending. Default order for resources is ascending.
'
enum:
- TIME_CREATED
- RESOURCE_NAME
type: string
sortOrder:
description: The sort order to use, either 'ASC' or 'DESC'.
enum:
- ASC
- DESC
type: string
x-default-description: 'The default value depends upon `sortBy`, and
in general is ''DESC'' when sorting by time and ''ASC'' otherwise.
'
x-obmcs-top-level-enum: '#/definitions/SortOrder'
sourceType:
description: Source type filter.
enum:
- SM_MGMT_AGENT_MONITORED
- SM_REPO_ONLY
- OCI_NATIVE
- PROMETHEUS
- TELEGRAF
- COLLECTD
type: string
x-obmcs-top-level-enum: '#/definitions/SourceType'
timeCreatedGreaterThanOrEqualTo:
description: 'Search for resources that were created within a specific date range,
using this parameter to specify the earliest creation date for the
returned list (inclusive). Specifying this parameter without the
corresponding `timeCreatedLessThan` parameter will retrieve resources created from the
given `timeCreatedGreaterThanOrEqualTo` to the current time, in "YYYY-MM-ddThh:mmZ" format with a
Z offset, as defined by [RFC 3339](https://tools.ietf.org/html/rfc3339).
**Example:** 2016-12-19T16:39:57.600Z
'
format: date-time
type: string
x-default-description: 'null'
timeCreatedLessThan:
description: 'Search for resources that were created within a specific date range,
using this parameter to specify the latest creation date for the returned
list (exclusive). Specifying this parameter without the corresponding
`timeCreatedGreaterThanOrEqualTo` parameter will retrieve all resources created before the
specified end date, in "YYYY-MM-ddThh:mmZ" format with a Z offset, as
defined by [RFC 3339](https://tools.ietf.org/html/rfc3339).
**Example:** 2016-12-19T16:39:57.600Z
'
format: date-time
type: string
x-default-description: 'null'
timeUpdatedGreaterThanOrEqualTo:
description: 'Search for resources that were updated within a specific date range,
using this parameter to specify the earliest update date for the
returned list (inclusive). Specifying this parameter without the
corresponding `timeUpdatedLessThan` parameter will retrieve resources updated from the
given `timeUpdatedGreaterThanOrEqualTo` to the current time, in "YYYY-MM-ddThh:mmZ" format with a
Z offset, as defined by [RFC 3339](https://tools.ietf.org/html/rfc3339).
**Example:** 2016-12-19T16:39:57.600Z
'
format: date-time
type: string
x-default-description: 'null'
timeUpdatedLessThan:
description: 'Search for resources that were updated within a specific date range,
using this parameter to specify the latest creation date for the returned
list (exclusive). Specifying this parameter without the corresponding
`timeUpdatedGreaterThanOrEqualTo` parameter will retrieve all resources updated before the
specified end date, in "YYYY-MM-ddThh:mmZ" format with a Z offset, as
defined by [RFC 3339](https://tools.ietf.org/html/rfc3339).
**Example:** 2016-12-19T16:39:57.600Z
'
format: date-time
type: string
x-default-description: 'null'
type:
description: 'A filter to return resources that match resource type.
'
maxLength: 255
minLength: 1
type: string
required:
- compartmentId
type: object
x-example: "{\n \"compartmentId\": \"ocid1.compartment.oc1.<unique_id>\",\n \"lifecycleState\": \"ACTIVE\",\n \"license\": \"ENTERPRISE_EDITION\",\n \"timeCreatedGreaterThanOrEqualTo\": \"2022-02-22T00:00:00.000Z\",\n \"propertyEquals\": {\n \"protocol\": \"t3\"\n },\n \"sortBy\":\"TIME_CREATED\",\n \"sortOrder\":\"ASC\"\n}\n"
UpdateAndPropagateTagsDetails:
description: "The information about monitored resource tags. Request will fail if at least one of \nfreeformTags or definedTags are not specified.\nProvided 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 are not specified, then tags will be updated only for the current resource.\n"
properties:
associationTypes:
default: []
description: "Association types that will be traversed recursively starting from the current resource, \nto identify resources for which the tags will be updated. \nIf no association type is specified, only current resource will be updated. \nDefault is empty list, which means no related resources will be updated.\n"
example:
- contains
- uses
items:
type: string
maxItems: 5
type: array
definedTags:
additionalProperties:
additionalProperties:
description: 'The value of the tag. Only string, integer and boolean types are supported.
'
type: object
description: 'Key-value pair representing predefined tags'' keys and values scoped to a namespace.
Example: `{"bar-key": "value"}`
'
type: object
description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace.
Example: `{"foo-namespace": {"bar-key": "value"}}`
'
type: object
freeformTags:
additionalProperties:
type: string
description: 'Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only.
Example: `{"bar-key": "value"}`
'
type: object
type: object
x-example: "{\n \"freeformTags\" : {\n \"bar-key\" : \"value\"\n },\n \"definedTags\": {\n \"discoveryTags\": {\n \"stack\": \"middleware\"\n }\n },\n \"associationTypes\": [\"contains\",\"uses\"]\n}\n"
WorkRequestErrorCollection:
description: Results of a workRequestError search. Contains both WorkRequestError items and other information, such as metadata.
properties:
items:
description: List of workRequestError objects.
items:
$ref: '#/components/schemas/WorkRequestError'
type: array
required:
- items
type: object
x-example: "{\n items: [\n {\n \"code\": \"500\",\n \"message\": \"CreateResources work request failed with error: SubmitWorkDetailsToAgent failed with error [(404, NotAuthorizedOrNotFound, false) Unknown resource ocid1.managementagent.oc1.eu-frankfurt-2.<unique_id> (opc-request-id: <unique_id>)]\",\n \"timestamp\": \"2022-01-07T15:59:10.279Z\"\n },\n {\n \"code\": \"500\",\n \"message\": \"SubmitWorkDetailsToAgent failed with error [(404, NotAuthorizedOrNotFound, false) Unknown resource ocid1.managementagent.oc1.eu-frankfurt-2.<unique_id> (opc-request-id: <unique_id>)]\",\n \"timestamp\": \"2022-01-07T15:58:53.965Z\"\n }\n ]\n}\n"
DiscoveryJobSummary:
description: The Summary of DiscoveryJob details.
properties:
compartmentId:
description: The OCID of the Compartment
maxLength: 255
minLength: 1
type: string
definedTags:
additionalProperties:
additionalProperties:
description: 'The value of the tag. Only string, integer and boolean types are supported.
'
type: object
description: 'Key-value pair representing predefined tags'' keys and values scoped to a namespace.
Example: `{"bar-key": "value"}`
'
type: object
description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace.
Example: `{"foo-namespace": {"bar-key": "value"}}`
'
type: object
discoveryType:
default: ADD
description: 'Add option submits new discovery Job. Add with retry option to re-submit failed discovery job. Refresh option refreshes the existing discovered resources.
'
enum:
- ADD
- ADD_WITH_RETRY
- REFRESH
- PREREQ
- PREREQ_WITH_RETRY
type: string
freeformTags:
additionalProperties:
type: string
description: 'Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only.
Example: `{"bar-key": "value"}`
'
type: object
id:
description: The OCID of Discovery job
maxLength: 255
minLength: 1
type: string
license:
description: License edition of the monitored resource.
enum:
- STANDARD_EDITION
- ENTERPRISE_EDITION
type: string
x-obmcs-top-level-enum: '#/definitions/LicenseType'
lifecycleState:
description: The current state of the DiscoveryJob Resource.
enum:
- CREATING
- UPDATING
- ACTIVE
- DELETING
- DELETED
- FAILED
type: string
x-obmcs-top-level-enum: '#/definitions/LifecycleState'
resourceName:
description: The name of resource type
maxLength: 128
minLength: 1
type: string
resourceType:
description: Resource Type
enum:
- WEBLOGIC_DOMAIN
- EBS_INSTANCE
- SQL_SERVER
- APACHE_TOMCAT
- ORACLE_DATABASE
- OCI_ORACLE_DB
- OCI_ORACLE_CDB
- OCI_ORACLE_PDB
- HOST
- ORACLE_PSFT
- ORACLE_MFT
- APACHE_HTTP_SERVER
- ORACLE_GOLDENGATE
- CUSTOM_RESOURCE
- ORACLE_HTTP_SERVER
type: string
status:
description: Specifies the status of the discovery job
enum:
- SUCCESS
- FAILURE
- INPROGRESS
- INACTIVE
- CREATED
- DELETED
- NEEDS_ATTENTION
type: string
statusMessage:
description: The short summary of the status of the discovery job
maxLength: 2000
minLength: 0
type: string
systemTags:
additionalProperties:
additionalProperties:
description: 'The value of the tag. Only string, integer and boolean types are supported.
'
type: object
description: 'Key-value pair representing system tags'' keys and values scoped to a namespace.
Example: `{"bar-key": "value"}`
'
type: object
description: 'Usage of system tag keys. These predefined keys are scoped to namespaces.
Example: `{"orcl-cloud": {"free-tier-retained": "true"}}`
'
type: object
tenantId:
description: The OCID of Tenant
maxLength: 255
minLength: 1
type: string
timeUpdated:
description: The time the discovery Job was updated.
format: date-time
type: string
userId:
description: The OCID of user in which the job is submitted
maxLength: 255
minLength: 1
type: string
required:
- id
type: object
BaselineableMetricSummaryCollection:
description: List summary of Baseline-able metrics
properties:
items:
description: list of baseline-able metric summary
items:
$ref: '#/components/schemas/BaselineableMetricSummary'
type: array
required:
- items
type: object
x-example: "{\n items: [\n {\n \"id\": \"ocid.smad.oc1.<unique_id>\",\n \"tenancyId\": \"ocid.tenancy.oc1.<unique_id>\",\n \"compartmentId\": \"ocid.compartment.oc1.<unique_id>\",\n \"name\": \"CPU\",\n \"column\":\"CPUUtilization\",\n \"namespace\": \"oracle_appmgmt\",\n \"resourceGroup\": \"oracle_database\",\n \"isOutOfBox\": TRUE,\n \"lifecycleState\": \"ACTIVE\"\n },\n {\n \"id\": \"ocid.smad.oc1.<unique_id>\",\n \"tenancyId\": \"ocid.tenancy.oc1.<unique_id>\",\n \"compartmentId\": \"ocid.compartment.oc1.<unique_id>\",\n \"name\": \"Memory\",\n \"column\":\"MemoryUtilization\",\n \"namespace\": \"oracle_appmgmt\",\n \"resourceGroup\": \"oracle_database\",\n \"isOutOfBox\": TRUE,\n \"lifecycleState\": \"ACTIVE\"\n }\n ]\n}\n"
MetricExtensionUpdateQueryProperties:
description: Collection method and query properties details of metric extension during update
discriminator:
propertyName: collectionMethod
properties:
collectionMethod:
description: Type of possible collection methods.
enum:
- OS_COMMAND
- SQL
- JMX
type: string
x-obmcs-top-level-enum: '#/definitions/MetricExtensionCollectionMethods'
required:
- collectionMethod
type: object
MonitoredResourcesCountAggregationCollection:
description: The resource count grouped by given criteria.
properties:
items:
description: The counts related to the resource and resource types.
items:
$ref: '#/components/schemas/MonitoredResourcesCountAggregation'
type: array
required:
- items
type: object
x-example: "Response 1: When groupBy=resourceType \n{\n \"items\": [\n {\n \"dimensions\": { \"resourceType\": \"oci_autonomous_database\" },\n \"count\": 1\n },\n {\n \"dimensions\": { \"resourceType\": \"postgres_database\" },\n \"count\": 1\n },\n {\n \"dimensions\": { \"resourceType\": \"weblogic_cluster\" },\n \"count\": 30\n },\n {\n \"dimensions\": { \"resourceType\": \"weblogic_j2eeserver\" },\n \"count\": 4\n }\n ]\n}\n\nResponse 2: When groupBy=license \n{\n \"items\": [\n {\n \"dimensions\": { \"license\": \"ENTERPRISE_EDITION\"},\n \"count\": 256\n },\n {\n \"dimensions\": { \"license\": \"STANDARD_EDITION\"},\n \"count\": 784\n }\n ]\n}\nResponse 3: When groupBy=namespace\n{\n \"items\": [\n {\n \"dimensions\": { \"namespace\": \"oci_autonomous_database\" },\n \"count\": 1\n },\n {\n \"dimensions\": { \"namespace\": \"oracle_appmgmt\" },\n \"count\": 34\n },\n {\n \"dimensions\": { \"namespace\": \"postgres_database\" },\n \"count\": 1\n }\n ]\n}\n"
ProcessSetSpecification:
description: Collection of regular expression specifications used to identify the processes to be monitored.
properties:
items:
description: List of Process Set specification details.
items:
$ref: '#/components/schemas/ProcessSetSpecificationDetails'
maxItems: 10
minItems: 1
type: array
required:
- items
type: object
x-example: "1. Example of a ProcessSetSpecification object.\n {\n \"items\": [\n {\n \"processCommand\": \"nginx\",\n \"processUser\": \"opc\",\n \"processLineRegexPattern\": \"nginx: main.\",\n \"label\": \"nginx-main\"\n },\n {\n \"processCommand\": \"nginx\",\n \"processUser\": \"opc\",\n \"processLineRegexPattern\": \"nginx: worker.\",\n \"label\": \"nginx-workers\"\n }\n ]\n }\n"
MonitoredResourceAssociationsCollection:
description: List of MonitoredResourceAssociationSummary elements.
properties:
items:
description: List of Monitored Resource Associations.
items:
$ref: '#/components/schemas/MonitoredResourceAssociationSummary'
type: array
required:
- items
type: object
WorkRequestLogEntryCollection:
description: Results of a workRequestLog search. Contains both workRequestLog items and other information, such as metadata.
properties:
items:
description: List of workRequestLogEntries.
items:
$ref: '#/components/schemas/WorkRequestLogEntry'
type: array
required:
- items
type: object
x-example: "{\n items: [\n {\n \"message\": \"Successfully created monitored resource with id [ocid1.stackmonitoringresource.oc1.iad.<unique_id>]\",\n \"timestamp\": \"2022-01-07T17:11:34.878Z\"\n },\n {\n \"message\": \"Successfully added resource to management agent.\",\n \"timestamp\": \"2022-01-07T17:11:24.904Z\"\n },\n {\n \"message\": \"Submitted upsertResources request to management agent.\",\n \"timestamp\": \"2022-01-07T17:10:34.510Z\"\n },\n {\n \"message\": \"Resource existence validated successfully.\",\n \"timestamp\": \"2022-01-07T17:10:06.561Z\"\n },\n {\n \"message\": \"Started Work Request.\",\n \"timestamp\": \"2022-01-07T17:09:51.304Z\"\n }\n ]\n}\n"
CreateMonitoredResourceDetails:
description: "The information about new monitored resource to be created. \nThe combination of monitored resource name and type should be unique across tenancy.\n"
properties:
additionalAliases:
description: "List of MonitoredResourceAliasCredentials. This property complements the existing \n\"aliases\" property by allowing user to specify more than one credential alias. \nIf both \"aliases\" and \"additionalAliases\" are specified, union of the \nvalues is used as list of aliases applicable for this resource.\nIf any duplicate found in the combined list of \"alias\" and \"additionalAliases\", \nan error will be thrown.\n"
items:
$ref: '#/components/schemas/MonitoredResourceAliasCredential'
maxItems: 4
type: array
additionalCredentials:
description: "List of MonitoredResourceCredentials. This property complements the existing \n\"credentials\" property by allowing user to specify more than one credential. \nIf both \"credential\" and \"additionalCredentials\" are specified, union of the \nvalues is used as list of credentials applicable for this resource.\nIf any duplicate found in the combined list of \"credentials\" and \"additionalCredentials\", \nan error will be thrown.\n"
items:
$ref: '#/components/schemas/MonitoredResourceCredential'
maxItems: 4
type: array
aliases:
$ref: '#/components/schemas/MonitoredResourceAliasCredential'
compartmentId:
description: 'Compartment Identifier [OCID](/Content/General/Concepts/identifiers.htm).
'
maxLength: 255
minLength: 1
type: string
credentials:
$ref: '#/components/schemas/MonitoredResourceCredential'
databaseConnectionDetails:
$ref: '#/components/schemas/ConnectionDetails'
definedTags:
additionalProperties:
additionalProperties:
description: 'The value of the tag. Only string, integer and boolean types are supported.
'
type: object
description: 'Key-value pair representing predefined tags'' keys and values scoped to a namespace.
Example: `{"bar-key": "value"}`
'
type: object
description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace.
Example: `{"foo-namespace": {"bar-key": "value"}}`
'
type: object
displayName:
description: Monitored resource display name.
maxLength: 255
minLength: 1
type: string
externalId:
description: 'External resource is any OCI resource identifier [OCID](/Content/General/Concepts/identifiers.htm)
which is not a Stack Monitoring service resource.
Currently supports only OCI compute instance.
'
maxLength: 255
minLength: 1
type: string
freeformTags:
additionalProperties:
type: string
description: 'Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only.
Example: `{"bar-key": "value"}`
'
type: object
hostName:
description: 'Host name of the monitored resource.
'
maxLength: 255
minLength: 1
type: string
license:
description: "License edition of the monitored resource. If not provided \nthe default license type for the compartment will be used.\n"
enum:
- STANDARD_EDITION
- ENTERPRISE_EDITION
type: string
x-obmcs-top-level-enum: '#/definitions/LicenseType'
managementAgentId:
description: Management Agent Identifier [OCID](/Content/General/Concepts/identifiers.htm).
maxLength: 255
minLength: 1
type: string
name:
description: 'Monitored Resource Name.
'
maxLength: 255
minLength: 1
type: string
properties:
description: 'List of monitored resource properties.
'
items:
$ref: '#/components/schemas/MonitoredResourceProperty'
type: array
resourceTimeZone:
default: Etc/UTC
description: 'Time zone in the form of tz database canonical zone ID. Specifies the preference with
a value that uses the IANA Time Zone Database format (x-obmcs-time-zone).
For example - America/Los_Angeles
'
example: America/Los_Angeles
format: x-obmcs-time-zone
type: string
type:
description: 'Monitored Resource Type.
'
maxLength: 255
minLength: 1
type: string
required:
- name
- type
- compartmentId
type: object
x-example: "Sample 1: Non-database Resource with credentials\n{\n\"name\": \"demo_domain\",\n\"displayName\": \"Demo\",\n\"type\": \"weblogic_domain\",\n\"compartmentId\": \"ocid1.compartment.oc1..<unique_id>\",\n\"hostName\": \"apps.example.com\",\n\"managementAgentId\": \"ocid1.managementagent.oc1.iad.<unique_id>\",\n\"resourceTimeZone\": \"UTC\",\n\"license\": \"ENTERPRISE_EDITION\",\n\"properties\":\n [\n {\n \"name\": \"admin_service\",\n \"value\": \"weblogic.management.mbeanservers.domainruntime\",\n },\n { \"name\": \"administration_protocol\", \"value\": \"t3s\" },\n {\n \"name\": \"admin_server_host\",\n \"value\": \"demo.host.com\",\n },\n \n { \"name\": \"admin_server_port\", \"value\": \"7001\" },\n \n { \"name\": \"admin_server_protocol\", \"value\": \"t3\" },\n \n {\n \"name\": \"admin_service_url\",\n \"value\": \"service:jmx:t3://demo.host.com:7001/jndi/weblogic.management.mbeanservers.domainruntime\",\n }\n ],\n\n\"credentials\":\n {\n \"credentialType\": \"PLAINTEXT\",\n \"source\": \"weblogic_domain.demo_domain\",\n \"name\": \"JMXCreds\",\n \"type\": \"JMXCreds\",\n \"description\": \"Credential for Weblogic stack metric collection.\",\n \"properties\":\n [\n { \"name\": \"Username\", \"value\": \"<username>\" },\n { \"name\": \"Password\", \"value\": \"<password>\" }\n ]\n },\n \"additionalCredentials\": [\n {\n \"source\": \"weblogic_cluster.cluster-1\",\n \"name\": \"cluster1cred\",\n \"type\": \"HostCreds\",\n \"description\": \"Host Credential\",\n \"credentialType\": \"PLAINTEXT\",\n \"properties\":\n [\n { \"name\": \"Username\", \"value\": \"<username>\" },\n { \"name\": \"Password\", \"value\": \"<password>\" }\n ]\n }\n ]\n}\nSample 2: Non-database resource with aliases\n\n{\n\"name\": \"Demo_AdminServer\",\n\"type\": \"weblogic_j2eeserver\",\n\"compartmentId\": \"ocid1.compartment.oc1..<unique_id>\",\n\"hostName\": \"apps.demo.com\",\n\"managementAgentId\": \"ocid1.managementagent.oc1.iad.<unique_id>\",\n\"resourceTimeZone\": \"UTC\",\n\"license\": \"ENTERPRISE_EDITION\",\n\"properties\": [\n \n {\n \"name\": \"is_admin_server\",\n \"value\": \"1\"\n }\n \n],\n\"aliases\": {\n \"source\": \"weblogic_j2eeserver.Demo_AdminServer\",\n \"name\": \"JMXCreds\",\n \"credential\": {\n \"source\": \"weblogic_domain.demo_domain\",\n \"name\": \"JMXCreds\",\n \"service\": \"appmgmt\"\n }\n}\n}\n\nSample 3: Database Resource\n{\n \n \"name\": \"cdb1\",\n \"displayName\": \"cdb1\",\n \"type\": \"oracle_database\",\n \"compartmentId\": \"ocid1.compartment.oc1.<unique_id>\",\n \"hostName\": \"myhost.oracle.com\",\n \"managementAgentId\": \"ocid1.managementagent.oc1.iad.<unique_id>\",\n \"resourceTimeZone\": \"Etc/UTC\", \n \"license\": \"ENTERPRISE_EDITION\",\n \"databaseConnectionDetails\": {\n \"port\": \"1521\",\n \"protocol\": \"TCP\",\n \"serviceName\": \"XE\"\n },\n \"credentials\": {\n\n \"credentialType\": \"PLAINTEXT\",\n \"keyId\":\"\"\n \"properties\": [\n {\n \"name\": \"databaseUserName\",\n \"value\": \"demouser\"\n },\n {\n \"name\": \"databasePassword\",\n \"value\": \"demopassword\"\n },\n {\n \"name\": \"databaseRole\",\n \"value\": \"sysdba\"\n }\n ]\n },\n \"properties\": [\n {\n \"name\": \"DB_HOME\",\n \"value\": \"/u01/db12\"\n }\n \n ],\n \"freeformTags\" : {\n \"Environment\" : \"Prod\",\n \"Department\":\"Ops\"\n },\n \"definedTags\": {\n \"discoveryTags\": {\n \"stack\": \"db\"\n }\n }\n \n}\n"
parameters:
ConfigLifecycleStateQueryParam:
description: The current state of the Config.
in: query
name: lifecycleState
x-default-description: 'null'
x-obmcs-enumref: '#/definitions/Config/lifecycleState'
schema:
type: string
MetricNameOptionalQueryParam:
description: Metric Name
in: query
name: name
required: false
x-default-description: If no value is specified * indicating all will be used
schema:
type: string
maxLength: 255
minLength: 1
MonitoredResourceTypeNameQueryParam:
description: 'A filter to return monitored resource types that match exactly with the resource type name given.
'
in: query
name: name
required: false
x-default-description: 'null'
schema:
type: string
maxLength: 255
minLength: 1
LogTypeQueryParam:
description: The log type like INFO, WARNING, ERROR, SUCCESS
in: query
name: logType
x-default-description: 'null'
schema:
type: string
enum:
- INFO
- WARNING
- ERROR
- SUCCESS
IfMatchHeader:
description: 'For optimistic concurrency control. In the PUT or DELETE call
for a resource, set the `if-match` parameter to the value of the
etag from a previous GET or POST response for that resource.
The resource will be updated or deleted only if the etag you
provide matches the resource''s current etag value.
'
in: header
name: if-match
required: false
schema:
type: string
ConfigDisplayNameQueryParam:
description: A filter to return only resources that match the entire display name given.
in: query
name: displayName
x-default-description: 'null'
schema:
type: string
maxLength: 255
minLength: 1
ConfigIdentifierPathParam:
description: Unique Config identifier.
in: path
name: configId
required: true
schema:
type: string
MonitoredResourceTaskStatusQueryParam:
description: A filter to return only resources that matches with lifecycleState given.
in: query
name: status
required: false
x-default-description: 'null'
x-obmcs-top-level-enum: '#/definitions/MonitoredResourceTaskLifecycleState'
schema:
type: string
enum:
- ACCEPTED
- IN_PROGRESS
- WAITING
- FAILED
- SUCCEEDED
- CANCELING
- CANCELED
- NEEDS_ATTENTION
MetricExtensionIdentifierPathParam:
description: The [OCID](/Content/General/Concepts/identifiers.htm) of the metric extension resource.
in: path
name: metricExtensionId
required: true
schema:
type: string
maxLength: 255
minLength: 1
SortOrderQueryParam:
description: 'The sort order to use, either ascending (`ASC`) or descending (`DESC`).
'
in: query
name: sortOrder
required: false
x-obmcs-top-level-enum: '#/definitions/SortOrder'
schema:
type: string
enum:
- ASC
- DESC
default: ASC
MonitoredResourceTaskCompartmentIdQueryParam:
description: "The [OCID](/Content/General/Concepts/identifiers.htm) of the compartment for which \nstack monitoring resource tasks should be listed.\n"
in: query
name: compartmentId
required: true
schema:
type: string
maxLength: 255
minLength: 1
ConfigSortByQueryParam:
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"
in: query
name: sortBy
schema:
type: string
enum:
- timeCreated
- configType
- displayName
default: timeCreated
LicenseQueryParam:
description: 'Filter to return resource counts that match with the given licence edition.
'
in: query
name: license
required: false
x-default-description: 'null'
x-obmcs-top-level-enum: '#/definitions/LicenseType'
schema:
type: string
enum:
- STANDARD_EDITION
- ENTERPRISE_EDITION
DiscoveryJobSortByQueryParam:
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.
'
in: query
name: sortBy
schema:
type: string
enum:
- timeUpdated
- resourceName
default: timeUpdated
MonitoredResourceSortByQueryParam:
description: 'The field to sort by. Only one sort order may be provided.
Default order for timeCreated is descending. Default order for resources is ascending.
'
in: query
name: sortBy
x-obmcs-top-level-enum: '#/definitions/MonitoredResourceSortBy'
schema:
type: string
enum:
- NAME
- TIME_CREATED
default: TIME_CREATED
ProcessSetIdPathParam:
description: The Process Set ID
in: path
name: processSetId
required: true
schema:
type: string
maxLength: 255
minLength: 1
RequestIdHeader:
description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a
particular request, please provide the request ID.
'
in: header
name: opc-request-id
schema:
type: string
CompartmentIdOptionalQueryParam:
description: The ID of the compartment in which data is listed.
in: query
name: compartmentId
required: false
schema:
type: string
maxLength: 255
minLength: 1
LifecycleStateQueryParam:
description: A filter to return metric extensions based on Lifecycle State
in: query
name: lifecycleState
x-obmcs-top-level-enum: '#/definitions/MetricExtensionLifeCycleStates'
schema:
type: string
enum:
- ACTIVE
- DELETED
ResourceIdentifierQueryParam:
description: The ID of the resource affected by the work request.
in: query
name: resourceId
x-default-description: 'null'
schema:
type: string
ResourceTypeExcludeRequestFields:
description: 'Partial response refers to an optimization technique offered
by the RESTful web APIs, to return all the information except
the fields requested to be excluded (excludeFields) by the client.
In this mechanism, the client
sends the exclude field names as the query parameters for
an API to the server, and the server trims down the default
response content by removing the fields that are not required
by the client. The parameter controls which fields to
exlude and to return and should be a query string parameter
called "excludeFields" of an array type, provide the values
as enums, and use collectionFormat.
'
in: query
name: excludeFields
x-default-description: 'null'
style: form
explode: true
schema:
type: array
items:
type: string
enum:
- displayName
- description
- lifecycleState
- metricNamespace
- metadata
- timeCreated
- timeUpdated
- freeformTags
- definedTags
- systemTags
WorkRequestStatusQueryParam:
description: A filter to return only resources their lifecycleState matches the given OperationStatus.
in: query
name: status
required: false
x-default-description: 'null'
x-obmcs-top-level-enum: '#/definitions/OperationStatus'
schema:
type: string
enum:
- ACCEPTED
- IN_PROGRESS
- WAITING
- FAILED
- SUCCEEDED
- CANCELING
- CANCELED
MonitoredResourceStatusQueryParam:
description: A filter to return only resources with matching lifecycleState.
in: query
name: status
required: false
x-default-description: 'null'
x-obmcs-top-level-enum: '#/definitions/ResourceLifecycleState'
schema:
type: string
enum:
- CREATING
- UPDATING
- ACTIVE
- DELETING
- DELETED
- FAILED
MonitoredResourceWorkRequestIdQueryParam:
description: A filter to return resources which were impacted as part of this work request identifier.
in: query
name: workRequestId
x-default-description: 'null'
schema:
type: string
maxLength: 255
minLength: 1
ProcessSetSortByQueryParam:
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.
'
in: query
name: sortBy
schema:
type: string
enum:
- timeUpdated
- name
default: timeUpdated
BaselineMetricSortByQueryParam:
description: 'The field to sort by. Only one sort order may be provided. Default order is ascending.
'
in: query
name: sortBy
schema:
type: string
enum:
- name
- namespace
- resourceGroup
default: name
DiscoveryJobLogSortByQueryParam:
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.
'
in: query
name: sortBy
schema:
type: string
enum:
- timeCreated
- logType
default: timeCreated
WorkRequestIdPathParam:
description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the work request.
in: path
name: workRequestId
required: true
schema:
type: string
maxLength: 255
minLength: 1
SortByLogQueryParam:
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.
'
in: query
name: sortBy
schema:
type: string
enum:
- timestamp
default: timestamp
BaselineableMetricIdentifierPathParam:
description: Identifier for the metric
in: path
name: baselineableMetricId
required: true
schema:
type: string
maxLength: 255
minLength: 1
MetricExtensionSortByQueryParam:
description: 'The field to sort by. Only one sort order may be provided.
Default order for timeCreated is descending. Default order for resources is ascending.
'
in: query
name: sortBy
x-obmcs-top-level-enum: '#/definitions/MetricExtensionSortBy'
schema:
type: string
enum:
- NAME
- TIME_CREATED
default: TIME_CREATED
MonitoredResourceTypeSortByQueryParam:
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"
in: query
name: sortBy
schema:
type: string
enum:
- timeUpdated
- name
default: timeUpdated
MonitoredResourceTypeCompartmentIdQueryParam:
description: "The [OCID](/Content/General/Concepts/identifiers.htm) of the tenancy for which \nmonitored resource types should be listed.\n"
in: query
name: compartmentId
required: true
schema:
type: string
maxLength: 255
minLength: 1
MonitoredResourceMembersSortByQueryParam:
description: 'If this query parameter is specified, the result is sorted by this query parameter value.
'
in: query
name: sortBy
x-default-description: 'If this query parameter is specified, the result is sorted by this query parameter value.
'
schema:
type: string
enum:
- resourceName
- resourceType
- sourceResourceType
default: resourceName
PaginationTokenQueryParam:
description: 'For list pagination. The value of the `opc-next-page` response header from the
previous "List" call. For important details about how pagination works, see
[List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine).
'
in: query
name: page
required: false
x-default-description: 'null'
schema:
type: string
minLength: 1
MonitoredResourceTypeIdentifierPathParam:
description: The [OCID](/Content/General/Concepts/identifiers.htm) of monitored resource type.
in: path
name: monitoredResourceTypeId
required: true
schema:
type: string
maxLength: 255
minLength: 1
MonitoredResourceTaskIdentifierPathParam:
description: The [OCID](/Content/General/Concepts/identifiers.htm) of stack monitoring resource task.
in: path
name: monitoredResourceTaskId
required: true
schema:
type: string
maxLength: 255
minLength: 1
BaselineableMetricIdentifierOptionalQueryParam:
description: Identifier for the metric
in: query
name: baselineableMetricId
required: false
schema:
type: string
maxLength: 255
minLength: 1
MonitoredResourceIdentifierPathParam:
description: The [OCID](/Content/General/Concepts/identifiers.htm) of monitored resource.
in: path
name: monitoredResourceId
required: true
schema:
type: string
maxLength: 255
minLength: 1
RequestFields:
description: 'Partial response refers to an optimization technique offered
by the RESTful web APIs, to return only the information
(fields) required by the client. In this mechanism, the client
sends the required field names as the query parameters for
an API to the server, and the server trims down the default
response content by removing the fields that are not required
by the client. The parameter controls which fields to
return and should be a query string parameter called "fields" of
an array type, provide the values as enums, and use collectionFormat.
'
in: query
name: fields
x-default-description: 'null'
style: form
explode: true
schema:
type: array
items:
type: string
enum:
- id
- name
- type
- displayName
- hostName
- externalId
- managementAgentId
- lifecycleState
- license
- timeCreated
- timeUpdated
MonitoredResourceDeleteMembersQueryParam:
description: "If this query parameter is specified and set to true, all the member \nresources will be deleted before deleting the specified resource.\n"
in: query
name: isDeleteMembers
schema:
type: boolean
default: false
WorkRequestIdQueryParam:
description: The ID of the asynchronous work request.
in: query
name: workRequestId
x-default-description: 'null'
schema:
type: string
ProcessSetDisplayNameQueryParam:
description: A filter to return only resources that match the entire display name given.
in: query
name: displayName
x-default-description: 'null'
schema:
type: string
maxLength: 255
minLength: 1
MonitoredResourceTypeStatusQueryParam:
description: A filter to return only resources that matches with lifecycleState given.
in: query
name: status
required: false
x-default-description: 'null'
x-obmcs-top-level-enum: '#/definitions/ResourceTypeLifecycleState'
schema:
type: string
enum:
- CREATING
- UPDATING
- ACTIVE
- DELETING
- DELETED
- FAILED
ResourceNameQueryParam:
description: A filter to return only discovery jobs that match the entire resource name given.
in: query
name: name
x-default-description: 'null'
schema:
type: string
maxLength: 255
minLength: 1
ConfigTypeQueryParam:
description: A filter to return only configuration items for a given config type.
in: query
name: type
x-default-description: 'null'
x-obmcs-enumref: '#/definitions/Config/configType'
schema:
type: string
maxLength: 255
minLength: 1
GroupByQueryParam:
description: 'The field to group by. Default group by is ''resourceType''.
'
in: query
name: groupBy
x-default-description: 'The field to group by. Default group by is ''resourceType''.
'
schema:
type: string
enum:
- resourceType
- license
- parentResourceId
default: resourceType
SummarizeDataSortByQueryParam:
description: 'If this query parameter is specified, the result is sorted by this query parameter value.
'
in: query
name: sortBy
x-default-description: 'If this query parameter is specified, the result is sorted by this query parameter value.
'
schema:
type: string
enum:
- count
default: count
RetryTokenHeader:
description: 'A token that uniquely identifies a request so it can be retried in case of a timeout or
server error without risk of executing that same action again. Retry tokens expire after 24
hours, but can be invalidated before then due to conflicting operations. For example, if a resource
has been deleted and purged from the system, then a retry of the original creation request
might be rejected.
'
in: header
name: opc-retry-token
required: false
schema:
type: string
maxLength: 64
minLength: 1
MonitoredResourceTaskSortByQueryParam:
description: "The field to sort by. Only one sort order may be provided. \nDefault order for 'timeUpdated' is descending. \n"
in: query
name: sortBy
schema:
type: string
enum:
- timeUpdated
default: timeUpdated
MetricNamespaceQueryParam:
description: 'A filter to return monitored resource types that has the matching namespace.
'
in: query
name: metricNamespace
required: false
x-default-description: 'null'
schema:
type: string
maxLength: 255
minLength: 1
JobRequestIdPathParam:
description: The Discovery Job ID
in: path
name: discoveryJobId
required: true
schema:
type: string
maxLength: 255
minLength: 1
StatusQueryParam:
description: A filter to return resources based on status e.g. Draft or Published
in: query
name: status
x-default-description: 'null'
x-obmcs-top-level-enum: '#/definitions/MetricExtensionLifeCycleDetails'
schema:
type: string
enum:
- DRAFT
- PUBLISHED
ResourceTypeQueryParam:
description: A filter to return resource counts that match exact resource type.
in: query
name: resourceType
required: false
x-default-description: 'null'
schema:
type: string
maxLength: 255
minLength: 1
MetricExtensionNameParam:
description: A filter to return resources based on name.
in: query
name: name
schema:
type: string
maxLength: 255
minLength: 1
EnabledOnResourceIdQueryParam:
description: A filter to return metric extensions based on input resource Id on which metric extension is enabled
in: query
name: enabledOnResourceId
x-default-description: 'null'
schema:
type: string
maxLength: 255
minLength: 1
CompartmentIdQueryParam:
description: The ID of the compartment in which data is listed.
in: query
name: compartmentId
required: true
schema:
type: string
maxLength: 255
minLength: 1
PaginationLimitQueryParam:
description: 'For list pagination. The maximum number of results per page, or items to return in a
paginated "List" call. For important details about how pagination works, see
[List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine).
'
in: query
name: limit
required: false
schema:
type: integer
default: 10
maximum: 1000
minimum: 1
ExternalResourceIdHeader:
description: 'Generally used by DBaaS to send the Database OCID stored on the DBaaS.
The same will be passed to resource service to enable Stack Monitoring Service on DBM.
This will be stored in Stack Monitoring Resource Service data store as identifier for monitored resource.
If this header is not set as part of the request, then an id will be generated and stored for the resource.
'
in: header
name: external-resource-id
required: false
x-default-description: 'null'
schema:
type: string
maxLength: 255
minLength: 1
MonitoredResourceNameQueryParam:
description: A filter to return resources that match exact resource name.
in: query
name: name
x-default-description: 'null'
schema:
type: string
maxLength: 255
minLength: 1
MetricExtensionResourceTypeQueryParam:
description: A filter to return resources based on resource type.
in: query
name: resourceType
x-default-description: 'null'
schema:
type: string
maxLength: 255
minLength: 1
ResourceGroupOptionalQueryParam:
description: Resource Group
in: query
name: resourceGroup
required: false
x-default-description: If no value is specified * indicating all will be used
schema:
type: string
maxLength: 255
minLength: 1
ExcludeSystemResourceTypesQueryParam:
description: 'A filter to exclude system resource types. If set to true, system resource types will be excluded.
'
in: query
name: isExcludeSystemTypes
schema:
type: boolean
default: false
ResourceTypeRequestFields:
description: 'Partial response refers to an optimization technique offered
by the RESTful web APIs, to return only the information
(fields) required by the client. In this mechanism, the client
sends the required field names as the query parameters for
an API to the server, and the server trims down the default
response content by removing the fields that are not required
by the client. The parameter controls which fields to
return and should be a query string parameter called "fields" of
an array type, provide the values as enums, and use collectionFormat.
MonitoredResourceType Id, name and compartment will be added by default.
'
in: query
name: fields
x-default-description: 'null'
style: form
explode: true
schema:
type: array
items:
type: string
enum:
- id
- compartmentId
- name
- displayName
- description
- lifecycleState
- metricNamespace
- metadata
- timeCreated
- timeUpdated
- freeformTags
- definedTags
- systemTags
ExcludeRequestFields:
description: 'Partial response refers to an optimization technique offered
by the RESTful web APIs, to return all the information except
the fields requested to be excluded (excludeFields) by the client.
In this mechanism, the client
sends the exclude field names as the query parameters for
an API to the server, and the server trims down the default
response content by removing the fields that are not required
by the client. The parameter controls which fields to
exlude and to return and should be a query string parameter
called "excludeFields" of an array type, provide the values
as enums, and use collectionFormat.
'
in: query
name: excludeFields
x-default-description: 'null'
style: form
explode: true
schema:
type: array
items:
type: string
enum:
- displayName
- hostName
- externalId
- managementAgentId
- lifecycleState
- license
- timeCreated
- timeUpdated
SortByListQueryParam:
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.
'
in: query
name: sortBy
schema:
type: string
enum:
- timeAccepted
default: timeAccepted
responses:
default:
description: Unknown Error
headers:
opc-request-id:
description: 'Unique Oracle-assigned identifier for the request. If you need to contact
Oracle about a particular request, please provide the request ID.
'
schema:
type: string
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
x-anchors:
agentProperties:
description: "List of properties needed by the agent for monitoring the resource. \nValid only if resource type is OCI management agent based. When specified, \nthese properties are passed to the management agent during resource create or update.\n"
items:
type: string
maxItems: 100
minItems: 0
type: array
compartmentId:
description: 'The [OCID](/Content/General/Concepts/identifiers.htm) of the tenancy containing the resource type.
'
maxLength: 255
minLength: 1
type: string
description:
description: A friendly description.
maxLength: 255
minLength: 1
type: string
lifecycleState:
description: Lifecycle state of the monitored resource type.
enum:
- CREATING
- UPDATING
- ACTIVE
- INACTIVE
- DELETING
- DELETED
- FAILED
type: string
x-obmcs-top-level-enum: '#/definitions/ResourceTypeLifecycleState'
metricNamespace:
description: Metric namespace for resource type.
maxLength: 255
minLength: 1
type: string
requiredProperties:
description: List of required properties for resource type.
items:
type: string
maxItems: 100
minItems: 0
type: array
resourceTypeDisplayName:
description: Monitored resource type display name.
maxLength: 255
minLength: 1
type: string
resourceTypeId:
description: 'Monitored resource type identifier [OCID](/Content/General/Concepts/identifiers.htm).
'
maxLength: 255
minLength: 1
type: string
resourceTypeName:
description: "A unique monitored resource type name. The name must be unique across tenancy. \nName can not be changed.\n"
maxLength: 255
minLength: 1
type: string
timeCreated:
description: "The date and time when the monitored resource type was created, expressed in \n[RFC 3339](https://tools.ietf.org/html/rfc3339) timestamp format.\n"
format: date-time
type: string
timeUpdated:
description: "The date and time when the monitored resource was updated, expressed in \n[RFC 3339](https://tools.ietf.org/html/rfc3339) timestamp format.\n"
format: date-time
type: string
uniquePropertySets:
description: "List of property sets used to uniquely identify the resources. \nThis check is made during create or update of stack monitoring resource. \nThe resource has to pass unique check for each set in the list. \nFor example, database can have user, password and SID as one unique set. \nAnother unique set would be user, password and service name.\n"
items:
$ref: '#/components/schemas/UniquePropertySet'
maxItems: 10
minItems: 0
type: array
validPropertiesForCreate:
description: "List of valid properties for resource type while creating the monitored resource. \nIf resources of this type specifies any other properties during create operation, \nthe operation will fail.\n"
items:
type: string
maxItems: 100
minItems: 0
type: array
validPropertiesForUpdate:
description: "List of valid properties for resource type while updating the monitored resource. \nIf resources of this type specifies any other properties during update operation, \nthe operation will fail.\n"
items:
type: string
maxItems: 100
minItems: 0
type: array
validPropertyValues:
additionalProperties:
items:
type: string
maxItems: 100
minItems: 0
type: array
description: "List of valid values for the properties. This is useful when resource type wants to\nrestrict only certain values for some properties. For instance for 'osType' property, \nsupported values can be restricted to be either Linux or Windows.\nExample: `{ \"osType\": [\"Linux\",\"Windows\",\"Solaris\"]}`\n"
type: object
x-headers:
content-location:
description: Content location of the resource.
type: string
etag:
description: 'For optimistic concurrency control. See `if-match`.
'
type: string
location:
description: Location of the resource.
type: string
opc-monitored-resource-id:
description: 'Unique identifier for the monitored resource. This is sent to user in response headers for create monitored resource.
'
type: string
opc-next-page:
description: 'For pagination of a list of items. When paging through a list, if this header appears in the response,
then a partial list might have been returned. Include this value as the `page` parameter for the
subsequent GET request to get the next batch of items.
'
type: string
opc-request-id:
description: 'Unique Oracle-assigned identifier for the request. If you need to contact
Oracle about a particular request, please provide the request ID.
'
type: string
opc-total-items:
description: 'For pagination of a list of items. The total number of items in the result.
'
type: integer
opc-work-request-id:
description: 'Unique Oracle-assigned identifier for the asynchronous request. You can use this to query status of the asynchronous operation.
'
type: string
retry-after:
description: A decimal number representing the number of seconds the client should wait before polling this endpoint again.
type: integer
x-properties:
definedTags:
additionalProperties:
additionalProperties:
description: 'The value of the tag. Only string, integer and boolean types are supported.
'
type: object
description: 'Key-value pair representing predefined tags'' keys and values scoped to a namespace.
Example: `{"bar-key": "value"}`
'
type: object
description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace.
Example: `{"foo-namespace": {"bar-key": "value"}}`
'
type: object
freeformTags:
additionalProperties:
type: string
description: 'Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only.
Example: `{"bar-key": "value"}`
'
type: object
systemTags:
additionalProperties:
additionalProperties:
description: 'The value of the tag. Only string, integer and boolean types are supported.
'
type: object
description: 'Key-value pair representing system tags'' keys and values scoped to a namespace.
Example: `{"bar-key": "value"}`
'
type: object
description: 'Usage of system tag keys. These predefined keys are scoped to namespaces.
Example: `{"orcl-cloud": {"free-tier-retained": "true"}}`
'
type: object
x-oracle-package: com.oracle.pic.appmgmt