Stack Monitoring Functions
Package: DBMS_CLOUD_OCI_SMON_STACK_MONITORING
ASSOCIATE_MONITORED_RESOURCES Function
Create an association between two monitored resources. Associations can be created between resources from different compartments as long they are in same tenancy. User should have required access in both the compartments.
Syntax
FUNCTION associate_monitored_resources (
associate_monitored_resources_details dbms_cloud_oci_stack_monitoring_associate_monitored_resources_details_t,
opc_request_id varchar2 DEFAULT NULL,
opc_retry_token varchar2 DEFAULT NULL,
if_match varchar2 DEFAULT NULL,
region varchar2 DEFAULT NULL,
endpoint varchar2 DEFAULT NULL,
credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_smon_stack_monitoring_associate_monitored_resources_response_t;Parameters
| Parameter | Description |
|---|---|
|
|
(required) Details to create association between two resources. |
|
|
(optional) Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. |
|
|
(optional) 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. |
|
|
(optional) 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. |
|
|
(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix). |
|
|
(optional) The endpoint of the service to call using this function. e.g https://stack-monitoring.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence. |
|
|
(optional) The name of the credential for authenticating with the corresponding cloud native API. |
CHANGE_CONFIG_COMPARTMENT Function
Moves the configuration item to another compartment. Basically, this will disable any configuration for this configuration type in thie compartment, and will enable it in the new one. For example, if for a HOST resource type, the configuration with AUTO_PROMOTE in the configuration type and TRUE as value is moved, automatic discovery will not take place in this compartment any more, but in the new one. So this operation will have the same effect as deleting the configuration item in the old compartment and recreating it in another compartment. When provided, If-Match is checked against ETag values of the resource.
Syntax
FUNCTION change_config_compartment (
config_id varchar2,
change_config_compartment_details dbms_cloud_oci_stack_monitoring_change_config_compartment_details_t,
if_match varchar2 DEFAULT NULL,
opc_request_id varchar2 DEFAULT NULL,
opc_retry_token varchar2 DEFAULT NULL,
region varchar2 DEFAULT NULL,
endpoint varchar2 DEFAULT NULL,
credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_smon_stack_monitoring_change_config_compartment_response_t;Parameters
| Parameter | Description |
|---|---|
|
|
(required) Unique Config identifier. |
|
|
(required) Details for the compartment move. |
|
|
(optional) 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. |
|
|
(optional) Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. |
|
|
(optional) 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. |
|
|
(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix). |
|
|
(optional) The endpoint of the service to call using this function. e.g https://stack-monitoring.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence. |
|
|
(optional) The name of the credential for authenticating with the corresponding cloud native API. |
CHANGE_METRIC_EXTENSION_COMPARTMENT Function
Moves a Metric Extension resource from one compartment identifier to another. When provided, If-Match is checked against ETag values of the resource.
Syntax
FUNCTION change_metric_extension_compartment (
metric_extension_id varchar2,
change_metric_extension_compartment_details dbms_cloud_oci_stack_monitoring_change_metric_extension_compartment_details_t,
if_match varchar2 DEFAULT NULL,
opc_request_id varchar2 DEFAULT NULL,
opc_retry_token varchar2 DEFAULT NULL,
region varchar2 DEFAULT NULL,
endpoint varchar2 DEFAULT NULL,
credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_smon_stack_monitoring_change_metric_extension_compartment_response_t;Parameters
| Parameter | Description |
|---|---|
|
|
(required) The OCID of the metric extension resource. |
|
|
(required) The information required to change compartment of given Metric Extension resource |
|
|
(optional) 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. |
|
|
(optional) Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. |
|
|
(optional) 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. |
|
|
(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix). |
|
|
(optional) The endpoint of the service to call using this function. e.g https://stack-monitoring.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence. |
|
|
(optional) The name of the credential for authenticating with the corresponding cloud native API. |
CHANGE_MONITORED_RESOURCE_COMPARTMENT Function
Moves a monitored resource from one compartment to another. When provided, If-Match is checked against ETag values of the resource.
Syntax
FUNCTION change_monitored_resource_compartment (
monitored_resource_id varchar2,
change_monitored_resource_compartment_details dbms_cloud_oci_stack_monitoring_change_monitored_resource_compartment_details_t,
if_match varchar2 DEFAULT NULL,
opc_request_id varchar2 DEFAULT NULL,
opc_retry_token varchar2 DEFAULT NULL,
region varchar2 DEFAULT NULL,
endpoint varchar2 DEFAULT NULL,
credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_smon_stack_monitoring_change_monitored_resource_compartment_response_t;Parameters
| Parameter | Description |
|---|---|
|
|
(required) The OCID of monitored resource. |
|
|
(required) The information to be updated. |
|
|
(optional) 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. |
|
|
(optional) Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. |
|
|
(optional) 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. |
|
|
(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix). |
|
|
(optional) The endpoint of the service to call using this function. e.g https://stack-monitoring.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence. |
|
|
(optional) The name of the credential for authenticating with the corresponding cloud native API. |
CHANGE_MONITORED_RESOURCE_TASK_COMPARTMENT Function
Moves a stack monitoring resource task from one compartment to another.
Syntax
FUNCTION change_monitored_resource_task_compartment (
monitored_resource_task_id varchar2,
change_monitored_resource_task_compartment_details dbms_cloud_oci_stack_monitoring_change_monitored_resource_task_compartment_details_t,
if_match varchar2 DEFAULT NULL,
opc_request_id varchar2 DEFAULT NULL,
opc_retry_token varchar2 DEFAULT NULL,
region varchar2 DEFAULT NULL,
endpoint varchar2 DEFAULT NULL,
credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_smon_stack_monitoring_change_monitored_resource_task_compartment_response_t;Parameters
| Parameter | Description |
|---|---|
|
|
(required) The OCID of stack monitoring resource task. |
|
|
(required) The information to be updated. |
|
|
(optional) 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. |
|
|
(optional) Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. |
|
|
(optional) 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. |
|
|
(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix). |
|
|
(optional) The endpoint of the service to call using this function. e.g https://stack-monitoring.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence. |
|
|
(optional) The name of the credential for authenticating with the corresponding cloud native API. |
CREATE_BASELINEABLE_METRIC Function
Creates the specified Baseline-able metric
Syntax
FUNCTION create_baselineable_metric (
create_baselineable_metric_details dbms_cloud_oci_stack_monitoring_create_baselineable_metric_details_t,
opc_request_id varchar2 DEFAULT NULL,
opc_retry_token varchar2 DEFAULT NULL,
region varchar2 DEFAULT NULL,
endpoint varchar2 DEFAULT NULL,
credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_smon_stack_monitoring_create_baselineable_metric_response_t;Parameters
| Parameter | Description |
|---|---|
|
|
(required) Baseline metric |
|
|
(optional) Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. |
|
|
(optional) 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. |
|
|
(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix). |
|
|
(optional) The endpoint of the service to call using this function. e.g https://stack-monitoring.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence. |
|
|
(optional) The name of the credential for authenticating with the corresponding cloud native API. |
CREATE_CONFIG Function
Creates a configuration item, for example to define whether resources of a specific type should be discovered automatically. For example, when a new Management Agent gets registered in a certain compartment, this Management Agent can potentially get promoted to a HOST resource. The configuration item will determine if HOST resources in the selected compartment will be discovered automatically.
Syntax
FUNCTION create_config (
create_config_details dbms_cloud_oci_stack_monitoring_create_config_details_t,
opc_retry_token varchar2 DEFAULT NULL,
opc_request_id varchar2 DEFAULT NULL,
region varchar2 DEFAULT NULL,
endpoint varchar2 DEFAULT NULL,
credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_smon_stack_monitoring_create_config_response_t;Parameters
| Parameter | Description |
|---|---|
|
|
(required) Details for the new configuration. |
|
|
(optional) 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. |
|
|
(optional) Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. |
|
|
(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix). |
|
|
(optional) The endpoint of the service to call using this function. e.g https://stack-monitoring.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence. |
|
|
(optional) The name of the credential for authenticating with the corresponding cloud native API. |
CREATE_DISCOVERY_JOB Function
API to create discovery Job and submit discovery Details to agent.
Syntax
FUNCTION create_discovery_job (
create_discovery_job_details dbms_cloud_oci_stack_monitoring_create_discovery_job_details_t,
opc_request_id varchar2 DEFAULT NULL,
opc_retry_token varchar2 DEFAULT NULL,
region varchar2 DEFAULT NULL,
endpoint varchar2 DEFAULT NULL,
credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_smon_stack_monitoring_create_discovery_job_response_t;Parameters
| Parameter | Description |
|---|---|
|
|
(required) Summary of source and credential discovery details. |
|
|
(optional) Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. |
|
|
(optional) 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. |
|
|
(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix). |
|
|
(optional) The endpoint of the service to call using this function. e.g https://stack-monitoring.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence. |
|
|
(optional) The name of the credential for authenticating with the corresponding cloud native API. |
CREATE_METRIC_EXTENSION Function
Creates a new metric extension resource for a given compartment
Syntax
FUNCTION create_metric_extension (
create_metric_extension_details dbms_cloud_oci_stack_monitoring_create_metric_extension_details_t,
opc_retry_token varchar2 DEFAULT NULL,
opc_request_id varchar2 DEFAULT NULL,
region varchar2 DEFAULT NULL,
endpoint varchar2 DEFAULT NULL,
credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_smon_stack_monitoring_create_metric_extension_response_t;Parameters
| Parameter | Description |
|---|---|
|
|
(required) Details required for creating new Metric Extension |
|
|
(optional) 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. |
|
|
(optional) Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. |
|
|
(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix). |
|
|
(optional) The endpoint of the service to call using this function. e.g https://stack-monitoring.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence. |
|
|
(optional) The name of the credential for authenticating with the corresponding cloud native API. |
CREATE_MONITORED_RESOURCE Function
Creates a new monitored resource for the given resource type with the details and submits a work request for promoting the resource to agent. Once the resource is successfully added to agent, resource state will be marked active.
Syntax
FUNCTION create_monitored_resource (
create_monitored_resource_details dbms_cloud_oci_stack_monitoring_create_monitored_resource_details_t,
opc_retry_token varchar2 DEFAULT NULL,
opc_request_id varchar2 DEFAULT NULL,
external_resource_id varchar2 DEFAULT NULL,
region varchar2 DEFAULT NULL,
endpoint varchar2 DEFAULT NULL,
credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_smon_stack_monitoring_create_monitored_resource_response_t;Parameters
| Parameter | Description |
|---|---|
|
|
(required) Details for the new monitored resource. |
|
|
(optional) 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. |
|
|
(optional) Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. |
|
|
(optional) 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. |
|
|
(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix). |
|
|
(optional) The endpoint of the service to call using this function. e.g https://stack-monitoring.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence. |
|
|
(optional) The name of the credential for authenticating with the corresponding cloud native API. |
CREATE_MONITORED_RESOURCE_TASK Function
Create a new stack monitoring resource task.
Syntax
FUNCTION create_monitored_resource_task (
create_monitored_resource_task_details dbms_cloud_oci_stack_monitoring_create_monitored_resource_task_details_t,
opc_request_id varchar2 DEFAULT NULL,
opc_retry_token varchar2 DEFAULT NULL,
region varchar2 DEFAULT NULL,
endpoint varchar2 DEFAULT NULL,
credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_smon_stack_monitoring_create_monitored_resource_task_response_t;Parameters
| Parameter | Description |
|---|---|
|
|
(required) Details to create the new stack monitoring resource task. |
|
|
(optional) Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. |
|
|
(optional) 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. |
|
|
(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix). |
|
|
(optional) The endpoint of the service to call using this function. e.g https://stack-monitoring.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence. |
|
|
(optional) The name of the credential for authenticating with the corresponding cloud native API. |
CREATE_MONITORED_RESOURCE_TYPE Function
Creates a new monitored resource type.
Syntax
FUNCTION create_monitored_resource_type (
create_monitored_resource_type_details dbms_cloud_oci_stack_monitoring_create_monitored_resource_type_details_t,
opc_request_id varchar2 DEFAULT NULL,
opc_retry_token varchar2 DEFAULT NULL,
region varchar2 DEFAULT NULL,
endpoint varchar2 DEFAULT NULL,
credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_smon_stack_monitoring_create_monitored_resource_type_response_t;Parameters
| Parameter | Description |
|---|---|
|
|
(required) Details for the new monitored resource type. |
|
|
(optional) Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. |
|
|
(optional) 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. |
|
|
(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix). |
|
|
(optional) The endpoint of the service to call using this function. e.g https://stack-monitoring.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence. |
|
|
(optional) The name of the credential for authenticating with the corresponding cloud native API. |
DELETE_BASELINEABLE_METRIC Function
Deletes the Baseline-able metric for the given id
Syntax
FUNCTION delete_baselineable_metric (
baselineable_metric_id varchar2,
opc_request_id varchar2 DEFAULT NULL,
if_match varchar2 DEFAULT NULL,
region varchar2 DEFAULT NULL,
endpoint varchar2 DEFAULT NULL,
credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_smon_stack_monitoring_delete_baselineable_metric_response_t;Parameters
| Parameter | Description |
|---|---|
|
|
(required) Identifier for the metric |
|
|
(optional) Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. |
|
|
(optional) 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. |
|
|
(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix). |
|
|
(optional) The endpoint of the service to call using this function. e.g https://stack-monitoring.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence. |
|
|
(optional) The name of the credential for authenticating with the corresponding cloud native API. |
DELETE_CONFIG Function
Deletes a configuration identified by the id.
Syntax
FUNCTION delete_config (
config_id varchar2,
if_match varchar2 DEFAULT NULL,
opc_request_id varchar2 DEFAULT NULL,
region varchar2 DEFAULT NULL,
endpoint varchar2 DEFAULT NULL,
credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_smon_stack_monitoring_delete_config_response_t;Parameters
| Parameter | Description |
|---|---|
|
|
(required) Unique Config identifier. |
|
|
(optional) 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. |
|
|
(optional) Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. |
|
|
(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix). |
|
|
(optional) The endpoint of the service to call using this function. e.g https://stack-monitoring.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence. |
|
|
(optional) The name of the credential for authenticating with the corresponding cloud native API. |
DELETE_DISCOVERY_JOB Function
Deletes a DiscoveryJob by identifier
Syntax
FUNCTION delete_discovery_job (
discovery_job_id varchar2,
if_match varchar2 DEFAULT NULL,
opc_request_id varchar2 DEFAULT NULL,
region varchar2 DEFAULT NULL,
endpoint varchar2 DEFAULT NULL,
credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_smon_stack_monitoring_delete_discovery_job_response_t;Parameters
| Parameter | Description |
|---|---|
|
|
(required) The Discovery Job ID |
|
|
(optional) 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. |
|
|
(optional) Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. |
|
|
(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix). |
|
|
(optional) The endpoint of the service to call using this function. e.g https://stack-monitoring.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence. |
|
|
(optional) The name of the credential for authenticating with the corresponding cloud native API. |
DELETE_METRIC_EXTENSION Function
Deletes a metric extension by identifier
Syntax
FUNCTION delete_metric_extension (
metric_extension_id varchar2,
if_match varchar2 DEFAULT NULL,
opc_request_id varchar2 DEFAULT NULL,
region varchar2 DEFAULT NULL,
endpoint varchar2 DEFAULT NULL,
credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_smon_stack_monitoring_delete_metric_extension_response_t;Parameters
| Parameter | Description |
|---|---|
|
|
(required) The OCID of the metric extension resource. |
|
|
(optional) 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. |
|
|
(optional) Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. |
|
|
(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix). |
|
|
(optional) The endpoint of the service to call using this function. e.g https://stack-monitoring.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence. |
|
|
(optional) The name of the credential for authenticating with the corresponding cloud native API. |
DELETE_MONITORED_RESOURCE Function
Delete monitored resource by the given identifier OCID. By default, only the specified resource is deleted. If the parameter 'isDeleteMembers' is set to true, then the member resources will be deleted too. If the operation fails partially, the deleted entries will not be rolled back.
Syntax
FUNCTION delete_monitored_resource (
monitored_resource_id varchar2,
if_match varchar2 DEFAULT NULL,
opc_request_id varchar2 DEFAULT NULL,
is_delete_members number DEFAULT NULL,
region varchar2 DEFAULT NULL,
endpoint varchar2 DEFAULT NULL,
credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_smon_stack_monitoring_delete_monitored_resource_response_t;Parameters
| Parameter | Description |
|---|---|
|
|
(required) The OCID of monitored resource. |
|
|
(optional) 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. |
|
|
(optional) Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. |
|
|
(optional) If this query parameter is specified and set to true, all the member resources will be deleted before deleting the specified resource. |
|
|
(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix). |
|
|
(optional) The endpoint of the service to call using this function. e.g https://stack-monitoring.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence. |
|
|
(optional) The name of the credential for authenticating with the corresponding cloud native API. |
DELETE_MONITORED_RESOURCE_TYPE Function
Deletes a monitored resource type by identifier OCID.
Syntax
FUNCTION delete_monitored_resource_type (
monitored_resource_type_id varchar2,
if_match varchar2 DEFAULT NULL,
opc_request_id varchar2 DEFAULT NULL,
region varchar2 DEFAULT NULL,
endpoint varchar2 DEFAULT NULL,
credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_smon_stack_monitoring_delete_monitored_resource_type_response_t;Parameters
| Parameter | Description |
|---|---|
|
|
(required) The OCID of monitored resource type. |
|
|
(optional) 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. |
|
|
(optional) Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. |
|
|
(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix). |
|
|
(optional) The endpoint of the service to call using this function. e.g https://stack-monitoring.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence. |
|
|
(optional) The name of the credential for authenticating with the corresponding cloud native API. |
DISABLE_EXTERNAL_DATABASE Function
Disable external database resource monitoring. All the references in DBaaS, DBM and resource service will be deleted as part of this operation.
Syntax
FUNCTION disable_external_database (
monitored_resource_id varchar2,
opc_retry_token varchar2 DEFAULT NULL,
opc_request_id varchar2 DEFAULT NULL,
if_match varchar2 DEFAULT NULL,
region varchar2 DEFAULT NULL,
endpoint varchar2 DEFAULT NULL,
credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_smon_stack_monitoring_disable_external_database_response_t;Parameters
| Parameter | Description |
|---|---|
|
|
(required) The OCID of monitored resource. |
|
|
(optional) 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. |
|
|
(optional) Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. |
|
|
(optional) 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. |
|
|
(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix). |
|
|
(optional) The endpoint of the service to call using this function. e.g https://stack-monitoring.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence. |
|
|
(optional) The name of the credential for authenticating with the corresponding cloud native API. |
DISABLE_METRIC_EXTENSION Function
Submits a request to disable matching metric extension Id for the given Resource IDs
Syntax
FUNCTION disable_metric_extension (
metric_extension_id varchar2,
disable_metric_extension_details dbms_cloud_oci_stack_monitoring_disable_metric_extension_details_t,
if_match varchar2 DEFAULT NULL,
opc_request_id varchar2 DEFAULT NULL,
opc_retry_token varchar2 DEFAULT NULL,
region varchar2 DEFAULT NULL,
endpoint varchar2 DEFAULT NULL,
credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_smon_stack_monitoring_disable_metric_extension_response_t;Parameters
| Parameter | Description |
|---|---|
|
|
(required) The OCID of the metric extension resource. |
|
|
(required) The list of Resource IDs for which given metric extension needs to be disabled |
|
|
(optional) 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. |
|
|
(optional) Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. |
|
|
(optional) 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. |
|
|
(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix). |
|
|
(optional) The endpoint of the service to call using this function. e.g https://stack-monitoring.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence. |
|
|
(optional) The name of the credential for authenticating with the corresponding cloud native API. |
DISASSOCIATE_MONITORED_RESOURCES Function
Removes associations between two monitored resources.
Syntax
FUNCTION disassociate_monitored_resources (
disassociate_monitored_resources_details dbms_cloud_oci_stack_monitoring_disassociate_monitored_resources_details_t,
opc_request_id varchar2 DEFAULT NULL,
opc_retry_token varchar2 DEFAULT NULL,
if_match varchar2 DEFAULT NULL,
region varchar2 DEFAULT NULL,
endpoint varchar2 DEFAULT NULL,
credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_smon_stack_monitoring_disassociate_monitored_resources_response_t;Parameters
| Parameter | Description |
|---|---|
|
|
(required) Disassociate resources. |
|
|
(optional) Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. |
|
|
(optional) 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. |
|
|
(optional) 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. |
|
|
(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix). |
|
|
(optional) The endpoint of the service to call using this function. e.g https://stack-monitoring.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence. |
|
|
(optional) The name of the credential for authenticating with the corresponding cloud native API. |
ENABLE_METRIC_EXTENSION Function
Submits a request to enable matching metric extension Id for the given Resource IDs
Syntax
FUNCTION enable_metric_extension (
metric_extension_id varchar2,
enable_metric_extension_details dbms_cloud_oci_stack_monitoring_enable_metric_extension_details_t,
if_match varchar2 DEFAULT NULL,
opc_request_id varchar2 DEFAULT NULL,
opc_retry_token varchar2 DEFAULT NULL,
region varchar2 DEFAULT NULL,
endpoint varchar2 DEFAULT NULL,
credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_smon_stack_monitoring_enable_metric_extension_response_t;Parameters
| Parameter | Description |
|---|---|
|
|
(required) The OCID of the metric extension resource. |
|
|
(required) The list of Resource IDs for which given metric extension needs to be enabled |
|
|
(optional) 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. |
|
|
(optional) Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. |
|
|
(optional) 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. |
|
|
(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix). |
|
|
(optional) The endpoint of the service to call using this function. e.g https://stack-monitoring.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence. |
|
|
(optional) The name of the credential for authenticating with the corresponding cloud native API. |
EVALUATE_BASELINEABLE_METRIC Function
Evaluates metric for anomalies for the given data points
Syntax
FUNCTION evaluate_baselineable_metric (
evaluate_baselineable_metric_details dbms_cloud_oci_stack_monitoring_evaluate_baselineable_metric_details_t,
baselineable_metric_id varchar2,
opc_request_id varchar2 DEFAULT NULL,
if_match varchar2 DEFAULT NULL,
opc_retry_token varchar2 DEFAULT NULL,
region varchar2 DEFAULT NULL,
endpoint varchar2 DEFAULT NULL,
credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_smon_stack_monitoring_evaluate_baselineable_metric_response_t;Parameters
| Parameter | Description |
|---|---|
|
|
(required) Metric details |
|
|
(required) Identifier for the metric |
|
|
(optional) Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. |
|
|
(optional) 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. |
|
|
(optional) 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. |
|
|
(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix). |
|
|
(optional) The endpoint of the service to call using this function. e.g https://stack-monitoring.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence. |
|
|
(optional) The name of the credential for authenticating with the corresponding cloud native API. |
EXPORT_METRIC_EXTENSION Function
Export generates a template used to create new metric extension resources similar to matching metric extension id. Response is a file that contains metric extension definition with placeholders for fields to be changed.
Syntax
FUNCTION export_metric_extension (
metric_extension_id varchar2,
if_match varchar2 DEFAULT NULL,
opc_request_id varchar2 DEFAULT NULL,
opc_retry_token varchar2 DEFAULT NULL,
region varchar2 DEFAULT NULL,
endpoint varchar2 DEFAULT NULL,
credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_smon_stack_monitoring_export_metric_extension_response_t;Parameters
| Parameter | Description |
|---|---|
|
|
(required) The OCID of the metric extension resource. |
|
|
(optional) 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. |
|
|
(optional) Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. |
|
|
(optional) 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. |
|
|
(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix). |
|
|
(optional) The endpoint of the service to call using this function. e.g https://stack-monitoring.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence. |
|
|
(optional) The name of the credential for authenticating with the corresponding cloud native API. |
GET_BASELINEABLE_METRIC Function
Get the Baseline-able metric for the given id
Syntax
FUNCTION get_baselineable_metric (
baselineable_metric_id varchar2,
opc_request_id varchar2 DEFAULT NULL,
region varchar2 DEFAULT NULL,
endpoint varchar2 DEFAULT NULL,
credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_smon_stack_monitoring_get_baselineable_metric_response_t;Parameters
| Parameter | Description |
|---|---|
|
|
(required) Identifier for the metric |
|
|
(optional) Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. |
|
|
(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix). |
|
|
(optional) The endpoint of the service to call using this function. e.g https://stack-monitoring.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence. |
|
|
(optional) The name of the credential for authenticating with the corresponding cloud native API. |
GET_CONFIG Function
Gets the details of a configuration.
Syntax
FUNCTION get_config (
config_id varchar2,
opc_request_id varchar2 DEFAULT NULL,
region varchar2 DEFAULT NULL,
endpoint varchar2 DEFAULT NULL,
credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_smon_stack_monitoring_get_config_response_t;Parameters
| Parameter | Description |
|---|---|
|
|
(required) Unique Config identifier. |
|
|
(optional) Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. |
|
|
(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix). |
|
|
(optional) The endpoint of the service to call using this function. e.g https://stack-monitoring.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence. |
|
|
(optional) The name of the credential for authenticating with the corresponding cloud native API. |
GET_DISCOVERY_JOB Function
API to get the details of discovery Job by identifier.
Syntax
FUNCTION get_discovery_job (
discovery_job_id varchar2,
opc_request_id varchar2 DEFAULT NULL,
region varchar2 DEFAULT NULL,
endpoint varchar2 DEFAULT NULL,
credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_smon_stack_monitoring_get_discovery_job_response_t;Parameters
| Parameter | Description |
|---|---|
|
|
(required) The Discovery Job ID |
|
|
(optional) Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. |
|
|
(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix). |
|
|
(optional) The endpoint of the service to call using this function. e.g https://stack-monitoring.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence. |
|
|
(optional) The name of the credential for authenticating with the corresponding cloud native API. |
GET_METRIC_EXTENSION Function
Gets a Metric Extension by identifier
Syntax
FUNCTION get_metric_extension (
metric_extension_id varchar2,
opc_request_id varchar2 DEFAULT NULL,
region varchar2 DEFAULT NULL,
endpoint varchar2 DEFAULT NULL,
credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_smon_stack_monitoring_get_metric_extension_response_t;Parameters
| Parameter | Description |
|---|---|
|
|
(required) The OCID of the metric extension resource. |
|
|
(optional) Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. |
|
|
(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix). |
|
|
(optional) The endpoint of the service to call using this function. e.g https://stack-monitoring.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence. |
|
|
(optional) The name of the credential for authenticating with the corresponding cloud native API. |
GET_MONITORED_RESOURCE Function
Get monitored resource for the given identifier OCID.
Syntax
FUNCTION get_monitored_resource (
monitored_resource_id varchar2,
opc_request_id varchar2 DEFAULT NULL,
region varchar2 DEFAULT NULL,
endpoint varchar2 DEFAULT NULL,
credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_smon_stack_monitoring_get_monitored_resource_response_t;Parameters
| Parameter | Description |
|---|---|
|
|
(required) The OCID of monitored resource. |
|
|
(optional) Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. |
|
|
(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix). |
|
|
(optional) The endpoint of the service to call using this function. e.g https://stack-monitoring.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence. |
|
|
(optional) The name of the credential for authenticating with the corresponding cloud native API. |
GET_MONITORED_RESOURCE_TASK Function
Gets stack monitoring resource task details by identifier OCID.
Syntax
FUNCTION get_monitored_resource_task (
monitored_resource_task_id varchar2,
opc_request_id varchar2 DEFAULT NULL,
region varchar2 DEFAULT NULL,
endpoint varchar2 DEFAULT NULL,
credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_smon_stack_monitoring_get_monitored_resource_task_response_t;Parameters
| Parameter | Description |
|---|---|
|
|
(required) The OCID of stack monitoring resource task. |
|
|
(optional) Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. |
|
|
(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix). |
|
|
(optional) The endpoint of the service to call using this function. e.g https://stack-monitoring.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence. |
|
|
(optional) The name of the credential for authenticating with the corresponding cloud native API. |
GET_MONITORED_RESOURCE_TYPE Function
Gets a monitored resource type by identifier OCID.
Syntax
FUNCTION get_monitored_resource_type (
monitored_resource_type_id varchar2,
opc_request_id varchar2 DEFAULT NULL,
region varchar2 DEFAULT NULL,
endpoint varchar2 DEFAULT NULL,
credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_smon_stack_monitoring_get_monitored_resource_type_response_t;Parameters
| Parameter | Description |
|---|---|
|
|
(required) The OCID of monitored resource type. |
|
|
(optional) Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. |
|
|
(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix). |
|
|
(optional) The endpoint of the service to call using this function. e.g https://stack-monitoring.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence. |
|
|
(optional) The name of the credential for authenticating with the corresponding cloud native API. |
GET_WORK_REQUEST Function
Gets the status of the work request with the given ID.
Syntax
FUNCTION get_work_request (
work_request_id varchar2,
opc_request_id varchar2 DEFAULT NULL,
region varchar2 DEFAULT NULL,
endpoint varchar2 DEFAULT NULL,
credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_smon_stack_monitoring_get_work_request_response_t;Parameters
| Parameter | Description |
|---|---|
|
|
(required) The OCID of the work request. |
|
|
(optional) Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. |
|
|
(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix). |
|
|
(optional) The endpoint of the service to call using this function. e.g https://stack-monitoring.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence. |
|
|
(optional) The name of the credential for authenticating with the corresponding cloud native API. |
LIST_BASELINEABLE_METRICS Function
List of summary of baseline-able metrics for a given resource group if specified.
Syntax
FUNCTION list_baselineable_metrics (
opc_request_id varchar2 DEFAULT NULL,
resource_group varchar2 DEFAULT NULL,
name varchar2 DEFAULT NULL,
metric_namespace varchar2 DEFAULT NULL,
limit number DEFAULT NULL,
page varchar2 DEFAULT NULL,
compartment_id varchar2 DEFAULT NULL,
baselineable_metric_id varchar2 DEFAULT NULL,
sort_order varchar2 DEFAULT NULL,
sort_by varchar2 DEFAULT NULL,
region varchar2 DEFAULT NULL,
endpoint varchar2 DEFAULT NULL,
credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_smon_stack_monitoring_list_baselineable_metrics_response_t;Parameters
| Parameter | Description |
|---|---|
|
|
(optional) Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. |
|
|
(optional) Resource Group |
|
|
(optional) Metric Name |
|
|
(optional) A filter to return monitored resource types that has the matching namespace. |
|
|
(optional) 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. |
|
|
(optional) 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. |
|
|
(optional) The ID of the compartment in which data is listed. |
|
|
(optional) Identifier for the metric |
|
|
(optional) The sort order to use, either ascending (`ASC`) or descending (`DESC`). Allowed values are: 'ASC', 'DESC' |
|
|
(optional) The field to sort by. Only one sort order may be provided. Default order is ascending. Allowed values are: 'name', 'namespace', 'resourceGroup' |
|
|
(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix). |
|
|
(optional) The endpoint of the service to call using this function. e.g https://stack-monitoring.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence. |
|
|
(optional) The name of the credential for authenticating with the corresponding cloud native API. |
LIST_CONFIGS Function
Get a list of configurations in a compartment.
Syntax
FUNCTION list_configs (
compartment_id varchar2,
display_name varchar2 DEFAULT NULL,
l_type varchar2 DEFAULT NULL,
limit number DEFAULT NULL,
page varchar2 DEFAULT NULL,
lifecycle_state varchar2 DEFAULT NULL,
sort_order varchar2 DEFAULT NULL,
sort_by varchar2 DEFAULT NULL,
opc_request_id varchar2 DEFAULT NULL,
region varchar2 DEFAULT NULL,
endpoint varchar2 DEFAULT NULL,
credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_smon_stack_monitoring_list_configs_response_t;Parameters
| Parameter | Description |
|---|---|
|
|
(required) The ID of the compartment in which data is listed. |
|
|
(optional) A filter to return only resources that match the entire display name given. |
|
|
(optional) A filter to return only configuration items for a given config type. |
|
|
(optional) 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. |
|
|
(optional) 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. |
|
|
(optional) The current state of the Config. |
|
|
(optional) The sort order to use, either ascending (`ASC`) or descending (`DESC`). Allowed values are: 'ASC', 'DESC' |
|
|
(optional) The field to sort by. Only one sort order may be provided. Default order for 'timeCreated' is descending. Default order for 'displayName' and 'configType' is ascending. Allowed values are: 'timeCreated', 'configType', 'displayName' |
|
|
(optional) Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. |
|
|
(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix). |
|
|
(optional) The endpoint of the service to call using this function. e.g https://stack-monitoring.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence. |
|
|
(optional) The name of the credential for authenticating with the corresponding cloud native API. |
LIST_DISCOVERY_JOB_LOGS Function
API to get all the logs of a Discovery Job.
Syntax
FUNCTION list_discovery_job_logs (
discovery_job_id varchar2,
log_type varchar2 DEFAULT NULL,
limit number DEFAULT NULL,
page varchar2 DEFAULT NULL,
sort_order varchar2 DEFAULT NULL,
sort_by varchar2 DEFAULT NULL,
opc_request_id varchar2 DEFAULT NULL,
region varchar2 DEFAULT NULL,
endpoint varchar2 DEFAULT NULL,
credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_smon_stack_monitoring_list_discovery_job_logs_response_t;Parameters
| Parameter | Description |
|---|---|
|
|
(required) The Discovery Job ID |
|
|
(optional) The log type like INFO, WARNING, ERROR, SUCCESS Allowed values are: 'INFO', 'WARNING', 'ERROR', 'SUCCESS' |
|
|
(optional) 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. |
|
|
(optional) 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. |
|
|
(optional) The sort order to use, either ascending (`ASC`) or descending (`DESC`). Allowed values are: 'ASC', 'DESC' |
|
|
(optional) The field to sort by. Only one sort order may be provided. Default order for timeCreated is descending. Default order for logType is ascending. Allowed values are: 'timeCreated', 'logType' |
|
|
(optional) Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. |
|
|
(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix). |
|
|
(optional) The endpoint of the service to call using this function. e.g https://stack-monitoring.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence. |
|
|
(optional) The name of the credential for authenticating with the corresponding cloud native API. |
LIST_DISCOVERY_JOBS Function
API to get the details of all Discovery Jobs.
Syntax
FUNCTION list_discovery_jobs (
compartment_id varchar2,
name varchar2 DEFAULT NULL,
limit number DEFAULT NULL,
page varchar2 DEFAULT NULL,
sort_order varchar2 DEFAULT NULL,
sort_by varchar2 DEFAULT NULL,
opc_request_id varchar2 DEFAULT NULL,
region varchar2 DEFAULT NULL,
endpoint varchar2 DEFAULT NULL,
credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_smon_stack_monitoring_list_discovery_jobs_response_t;Parameters
| Parameter | Description |
|---|---|
|
|
(required) The ID of the compartment in which data is listed. |
|
|
(optional) A filter to return only discovery jobs that match the entire resource name given. |
|
|
(optional) 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. |
|
|
(optional) 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. |
|
|
(optional) The sort order to use, either ascending (`ASC`) or descending (`DESC`). Allowed values are: 'ASC', 'DESC' |
|
|
(optional) The field to sort by. Only one sort order may be provided. Default order for timeUpdated is descending. Default order for resourceName is ascending. Allowed values are: 'timeUpdated', 'resourceName' |
|
|
(optional) Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. |
|
|
(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix). |
|
|
(optional) The endpoint of the service to call using this function. e.g https://stack-monitoring.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence. |
|
|
(optional) The name of the credential for authenticating with the corresponding cloud native API. |
LIST_METRIC_EXTENSIONS Function
Returns a list of metric extensions
Syntax
FUNCTION list_metric_extensions (
compartment_id varchar2,
limit number DEFAULT NULL,
page varchar2 DEFAULT NULL,
sort_by varchar2 DEFAULT NULL,
sort_order varchar2 DEFAULT NULL,
resource_type varchar2 DEFAULT NULL,
name varchar2 DEFAULT NULL,
status varchar2 DEFAULT NULL,
lifecycle_state varchar2 DEFAULT NULL,
enabled_on_resource_id varchar2 DEFAULT NULL,
opc_request_id varchar2 DEFAULT NULL,
region varchar2 DEFAULT NULL,
endpoint varchar2 DEFAULT NULL,
credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_smon_stack_monitoring_list_metric_extensions_response_t;Parameters
| Parameter | Description |
|---|---|
|
|
(required) The ID of the compartment in which data is listed. |
|
|
(optional) 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. |
|
|
(optional) 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. |
|
|
(optional) The field to sort by. Only one sort order may be provided. Default order for timeCreated is descending. Default order for resources is ascending. Allowed values are: 'NAME', 'TIME_CREATED' |
|
|
(optional) The sort order to use, either ascending (`ASC`) or descending (`DESC`). Allowed values are: 'ASC', 'DESC' |
|
|
(optional) A filter to return resources based on resource type. |
|
|
(optional) A filter to return resources based on name. |
|
|
(optional) A filter to return resources based on status e.g. Draft or Published Allowed values are: 'DRAFT', 'PUBLISHED' |
|
|
(optional) A filter to return metric extensions based on Lifecycle State Allowed values are: 'ACTIVE', 'DELETED' |
|
|
(optional) A filter to return metric extensions based on input resource Id on which metric extension is enabled |
|
|
(optional) Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. |
|
|
(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix). |
|
|
(optional) The endpoint of the service to call using this function. e.g https://stack-monitoring.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence. |
|
|
(optional) The name of the credential for authenticating with the corresponding cloud native API. |
LIST_MONITORED_RESOURCE_TASKS Function
Returns a list of stack monitoring resource tasks in the compartment.
Syntax
FUNCTION list_monitored_resource_tasks (
compartment_id varchar2,
status varchar2 DEFAULT NULL,
sort_by varchar2 DEFAULT NULL,
sort_order varchar2 DEFAULT NULL,
limit number DEFAULT NULL,
page varchar2 DEFAULT NULL,
opc_request_id varchar2 DEFAULT NULL,
region varchar2 DEFAULT NULL,
endpoint varchar2 DEFAULT NULL,
credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_smon_stack_monitoring_list_monitored_resource_tasks_response_t;Parameters
| Parameter | Description |
|---|---|
|
|
(required) The OCID of the compartment for which stack monitoring resource tasks should be listed. |
|
|
(optional) A filter to return only resources that matches with lifecycleState given. Allowed values are: 'ACCEPTED', 'IN_PROGRESS', 'WAITING', 'FAILED', 'SUCCEEDED', 'CANCELING', 'CANCELED', 'NEEDS_ATTENTION' |
|
|
(optional) The field to sort by. Only one sort order may be provided. Default order for 'timeUpdated' is descending. Allowed values are: 'timeUpdated' |
|
|
(optional) The sort order to use, either ascending (`ASC`) or descending (`DESC`). Allowed values are: 'ASC', 'DESC' |
|
|
(optional) 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. |
|
|
(optional) 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. |
|
|
(optional) Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. |
|
|
(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix). |
|
|
(optional) The endpoint of the service to call using this function. e.g https://stack-monitoring.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence. |
|
|
(optional) The name of the credential for authenticating with the corresponding cloud native API. |
LIST_MONITORED_RESOURCE_TYPES Function
Returns list of resource types accessible to the customer. There are two types of resource types - System resource types and User resource types. System resource types are available out of the box in the stack monitoring resource service and are accessible to all the tenant users. User resource types are created in the context of a tenancy and are visible only for the tenancy. By default, both System resource types and User resource types are returned.
Syntax
FUNCTION list_monitored_resource_types (
compartment_id varchar2,
name varchar2 DEFAULT NULL,
status varchar2 DEFAULT NULL,
is_exclude_system_types number DEFAULT NULL,
metric_namespace varchar2 DEFAULT NULL,
sort_by varchar2 DEFAULT NULL,
sort_order varchar2 DEFAULT NULL,
limit number DEFAULT NULL,
page varchar2 DEFAULT NULL,
opc_request_id varchar2 DEFAULT NULL,
fields dbms_cloud_oci_stack_monitoring_varchar2_tbl DEFAULT NULL,
exclude_fields dbms_cloud_oci_stack_monitoring_varchar2_tbl DEFAULT NULL,
region varchar2 DEFAULT NULL,
endpoint varchar2 DEFAULT NULL,
credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_smon_stack_monitoring_list_monitored_resource_types_response_t;Parameters
| Parameter | Description |
|---|---|
|
|
(required) The OCID of the tenancy for which monitored resource types should be listed. |
|
|
(optional) A filter to return monitored resource types that match exactly with the resource type name given. |
|
|
(optional) A filter to return only resources that matches with lifecycleState given. Allowed values are: 'CREATING', 'UPDATING', 'ACTIVE', 'DELETING', 'DELETED', 'FAILED' |
|
|
(optional) A filter to exclude system resource types. If set to true, system resource types will be excluded. |
|
|
(optional) A filter to return monitored resource types that has the matching namespace. |
|
|
(optional) The field to sort by. Only one sort order may be provided. Default order for 'timeUpdated' is descending. Default order for 'name' is ascending. Allowed values are: 'timeUpdated', 'name' |
|
|
(optional) The sort order to use, either ascending (`ASC`) or descending (`DESC`). Allowed values are: 'ASC', 'DESC' |
|
|
(optional) 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. |
|
|
(optional) 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. |
|
|
(optional) Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. |
|
|
(optional) 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. |
|
|
(optional) 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. |
|
|
(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix). |
|
|
(optional) The endpoint of the service to call using this function. e.g https://stack-monitoring.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence. |
|
|
(optional) The name of the credential for authenticating with the corresponding cloud native API. |
LIST_MONITORED_RESOURCES Function
Returns a list of monitored resources.
Syntax
FUNCTION list_monitored_resources (
compartment_id varchar2,
name varchar2 DEFAULT NULL,
work_request_id varchar2 DEFAULT NULL,
sort_by varchar2 DEFAULT NULL,
sort_order varchar2 DEFAULT NULL,
limit number DEFAULT NULL,
page varchar2 DEFAULT NULL,
opc_request_id varchar2 DEFAULT NULL,
region varchar2 DEFAULT NULL,
endpoint varchar2 DEFAULT NULL,
credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_smon_stack_monitoring_list_monitored_resources_response_t;Parameters
| Parameter | Description |
|---|---|
|
|
(required) The ID of the compartment in which data is listed. |
|
|
(optional) A filter to return resources that match exact resource name. |
|
|
(optional) A filter to return resources which were impacted as part of this work request identifier. |
|
|
(optional) The field to sort by. Only one sort order may be provided. Default order for timeCreated is descending. Default order for resources is ascending. Allowed values are: 'NAME', 'TIME_CREATED' |
|
|
(optional) The sort order to use, either ascending (`ASC`) or descending (`DESC`). Allowed values are: 'ASC', 'DESC' |
|
|
(optional) 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. |
|
|
(optional) 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. |
|
|
(optional) Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. |
|
|
(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix). |
|
|
(optional) The endpoint of the service to call using this function. e.g https://stack-monitoring.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence. |
|
|
(optional) The name of the credential for authenticating with the corresponding cloud native API. |
LIST_WORK_REQUEST_ERRORS Function
Return a (paginated) list of errors for a given work request.
Syntax
FUNCTION list_work_request_errors (
work_request_id varchar2,
opc_request_id varchar2 DEFAULT NULL,
page varchar2 DEFAULT NULL,
limit number DEFAULT NULL,
sort_order varchar2 DEFAULT NULL,
sort_by varchar2 DEFAULT NULL,
region varchar2 DEFAULT NULL,
endpoint varchar2 DEFAULT NULL,
credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_smon_stack_monitoring_list_work_request_errors_response_t;Parameters
| Parameter | Description |
|---|---|
|
|
(required) The OCID of the work request. |
|
|
(optional) Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. |
|
|
(optional) 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. |
|
|
(optional) 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. |
|
|
(optional) The sort order to use, either ascending (`ASC`) or descending (`DESC`). Allowed values are: 'ASC', 'DESC' |
|
|
(optional) 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. Allowed values are: 'timestamp' |
|
|
(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix). |
|
|
(optional) The endpoint of the service to call using this function. e.g https://stack-monitoring.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence. |
|
|
(optional) The name of the credential for authenticating with the corresponding cloud native API. |
LIST_WORK_REQUEST_LOGS Function
Return a (paginated) list of logs for a given work request.
Syntax
FUNCTION list_work_request_logs (
work_request_id varchar2,
opc_request_id varchar2 DEFAULT NULL,
page varchar2 DEFAULT NULL,
limit number DEFAULT NULL,
sort_order varchar2 DEFAULT NULL,
sort_by varchar2 DEFAULT NULL,
region varchar2 DEFAULT NULL,
endpoint varchar2 DEFAULT NULL,
credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_smon_stack_monitoring_list_work_request_logs_response_t;Parameters
| Parameter | Description |
|---|---|
|
|
(required) The OCID of the work request. |
|
|
(optional) Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. |
|
|
(optional) 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. |
|
|
(optional) 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. |
|
|
(optional) The sort order to use, either ascending (`ASC`) or descending (`DESC`). Allowed values are: 'ASC', 'DESC' |
|
|
(optional) 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. Allowed values are: 'timestamp' |
|
|
(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix). |
|
|
(optional) The endpoint of the service to call using this function. e.g https://stack-monitoring.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence. |
|
|
(optional) The name of the credential for authenticating with the corresponding cloud native API. |
LIST_WORK_REQUESTS Function
Lists the work requests in a compartment.
Syntax
FUNCTION list_work_requests (
compartment_id varchar2,
work_request_id varchar2 DEFAULT NULL,
status varchar2 DEFAULT NULL,
resource_id varchar2 DEFAULT NULL,
opc_request_id varchar2 DEFAULT NULL,
page varchar2 DEFAULT NULL,
limit number DEFAULT NULL,
sort_order varchar2 DEFAULT NULL,
sort_by varchar2 DEFAULT NULL,
region varchar2 DEFAULT NULL,
endpoint varchar2 DEFAULT NULL,
credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_smon_stack_monitoring_list_work_requests_response_t;Parameters
| Parameter | Description |
|---|---|
|
|
(required) The ID of the compartment in which data is listed. |
|
|
(optional) The ID of the asynchronous work request. |
|
|
(optional) A filter to return only resources their lifecycleState matches the given OperationStatus. Allowed values are: 'ACCEPTED', 'IN_PROGRESS', 'WAITING', 'FAILED', 'SUCCEEDED', 'CANCELING', 'CANCELED' |
|
|
(optional) The ID of the resource affected by the work request. |
|
|
(optional) Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. |
|
|
(optional) 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. |
|
|
(optional) 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. |
|
|
(optional) The sort order to use, either ascending (`ASC`) or descending (`DESC`). Allowed values are: 'ASC', 'DESC' |
|
|
(optional) 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. Allowed values are: 'timeAccepted' |
|
|
(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix). |
|
|
(optional) The endpoint of the service to call using this function. e.g https://stack-monitoring.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence. |
|
|
(optional) The name of the credential for authenticating with the corresponding cloud native API. |
MANAGE_LICENSE Function
Each resource is assigned a license based on which features are enabled for it. User is charged differently based on license. Specify the license type to be updated for the parent resource in the topology. The license type value is propagated to the member resources as well. Member resource is a resource which has \"contains\" association with the resource.
Syntax
FUNCTION manage_license (
monitored_resource_id varchar2,
manage_license_details dbms_cloud_oci_stack_monitoring_manage_license_details_t,
opc_retry_token varchar2 DEFAULT NULL,
opc_request_id varchar2 DEFAULT NULL,
if_match varchar2 DEFAULT NULL,
region varchar2 DEFAULT NULL,
endpoint varchar2 DEFAULT NULL,
credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_smon_stack_monitoring_manage_license_response_t;Parameters
| Parameter | Description |
|---|---|
|
|
(required) The OCID of monitored resource. |
|
|
(required) New license information. |
|
|
(optional) 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. |
|
|
(optional) Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. |
|
|
(optional) 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. |
|
|
(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix). |
|
|
(optional) The endpoint of the service to call using this function. e.g https://stack-monitoring.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence. |
|
|
(optional) The name of the credential for authenticating with the corresponding cloud native API. |
PUBLISH_METRIC_EXTENSION Function
Publish the Metric Extension identified by the id
Syntax
FUNCTION publish_metric_extension (
metric_extension_id varchar2,
opc_request_id varchar2 DEFAULT NULL,
opc_retry_token varchar2 DEFAULT NULL,
if_match varchar2 DEFAULT NULL,
region varchar2 DEFAULT NULL,
endpoint varchar2 DEFAULT NULL,
credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_smon_stack_monitoring_publish_metric_extension_response_t;Parameters
| Parameter | Description |
|---|---|
|
|
(required) The OCID of the metric extension resource. |
|
|
(optional) Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. |
|
|
(optional) 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. |
|
|
(optional) 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. |
|
|
(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix). |
|
|
(optional) The endpoint of the service to call using this function. e.g https://stack-monitoring.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence. |
|
|
(optional) The name of the credential for authenticating with the corresponding cloud native API. |
REQUEST_MONITORED_RESOURCES_SUMMARIZED_COUNT Function
Gets resource count based on the aggregation criteria specified using \"groupBy\" parameter.
Syntax
FUNCTION request_monitored_resources_summarized_count (
compartment_id varchar2,
group_by varchar2 DEFAULT NULL,
license varchar2 DEFAULT NULL,
resource_type varchar2 DEFAULT NULL,
sort_by varchar2 DEFAULT NULL,
sort_order varchar2 DEFAULT NULL,
limit number DEFAULT NULL,
page varchar2 DEFAULT NULL,
opc_request_id varchar2 DEFAULT NULL,
region varchar2 DEFAULT NULL,
endpoint varchar2 DEFAULT NULL,
credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_smon_stack_monitoring_request_monitored_resources_summarized_count_response_t;Parameters
| Parameter | Description |
|---|---|
|
|
(required) The ID of the compartment in which data is listed. |
|
|
(optional) The field to group by. Default group by is 'resourceType'. Allowed values are: 'resourceType', 'license', 'parentResourceId' |
|
|
(optional) Filter to return resource counts that match with the given licence edition. Allowed values are: 'STANDARD_EDITION', 'ENTERPRISE_EDITION' |
|
|
(optional) A filter to return resource counts that match exact resource type. |
|
|
(optional) If this query parameter is specified, the result is sorted by this query parameter value. Allowed values are: 'count' |
|
|
(optional) The sort order to use, either ascending (`ASC`) or descending (`DESC`). Allowed values are: 'ASC', 'DESC' |
|
|
(optional) 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. |
|
|
(optional) 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. |
|
|
(optional) Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. |
|
|
(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix). |
|
|
(optional) The endpoint of the service to call using this function. e.g https://stack-monitoring.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence. |
|
|
(optional) The name of the credential for authenticating with the corresponding cloud native API. |
SEARCH_ASSOCIATED_RESOURCES Function
List all associated resources recursively up-to a specified level, for the monitored resources of type specified.
Syntax
FUNCTION search_associated_resources (
search_associated_resources_details dbms_cloud_oci_stack_monitoring_search_associated_resources_details_t,
fields dbms_cloud_oci_stack_monitoring_varchar2_tbl DEFAULT NULL,
exclude_fields dbms_cloud_oci_stack_monitoring_varchar2_tbl DEFAULT NULL,
opc_request_id varchar2 DEFAULT NULL,
opc_retry_token varchar2 DEFAULT NULL,
if_match varchar2 DEFAULT NULL,
limit number DEFAULT NULL,
page varchar2 DEFAULT NULL,
region varchar2 DEFAULT NULL,
endpoint varchar2 DEFAULT NULL,
credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_smon_stack_monitoring_search_associated_resources_response_t;Parameters
| Parameter | Description |
|---|---|
|
|
(required) Search Criteria for the listing the monitored resources for given type and compartmentId. |
|
|
(optional) 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. |
|
|
(optional) 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. |
|
|
(optional) Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. |
|
|
(optional) 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. |
|
|
(optional) 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. |
|
|
(optional) 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. |
|
|
(optional) 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. |
|
|
(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix). |
|
|
(optional) The endpoint of the service to call using this function. e.g https://stack-monitoring.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence. |
|
|
(optional) The name of the credential for authenticating with the corresponding cloud native API. |
SEARCH_MONITORED_RESOURCE_ASSOCIATIONS Function
Search associations in the given compartment based on the search criteria.
Syntax
FUNCTION search_monitored_resource_associations (
search_monitored_resource_associations_details dbms_cloud_oci_stack_monitoring_search_monitored_resource_associations_details_t,
limit number DEFAULT NULL,
page varchar2 DEFAULT NULL,
opc_request_id varchar2 DEFAULT NULL,
opc_retry_token varchar2 DEFAULT NULL,
if_match varchar2 DEFAULT NULL,
region varchar2 DEFAULT NULL,
endpoint varchar2 DEFAULT NULL,
credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_smon_stack_monitoring_search_monitored_resource_associations_response_t;Parameters
| Parameter | Description |
|---|---|
|
|
(required) Search criteria for listing monitored resource associations. |
|
|
(optional) 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. |
|
|
(optional) 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. |
|
|
(optional) Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. |
|
|
(optional) 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. |
|
|
(optional) 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. |
|
|
(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix). |
|
|
(optional) The endpoint of the service to call using this function. e.g https://stack-monitoring.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence. |
|
|
(optional) The name of the credential for authenticating with the corresponding cloud native API. |
SEARCH_MONITORED_RESOURCE_MEMBERS Function
List the member resources for the given monitored resource identifier OCID.
Syntax
FUNCTION search_monitored_resource_members (
monitored_resource_id varchar2,
search_monitored_resource_members_details dbms_cloud_oci_stack_monitoring_search_monitored_resource_members_details_t,
sort_by varchar2 DEFAULT NULL,
sort_order varchar2 DEFAULT NULL,
page varchar2 DEFAULT NULL,
limit number DEFAULT NULL,
opc_retry_token varchar2 DEFAULT NULL,
opc_request_id varchar2 DEFAULT NULL,
if_match varchar2 DEFAULT NULL,
region varchar2 DEFAULT NULL,
endpoint varchar2 DEFAULT NULL,
credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_smon_stack_monitoring_search_monitored_resource_members_response_t;Parameters
| Parameter | Description |
|---|---|
|
|
(required) The OCID of monitored resource. |
|
|
(required) Search criteria for listing member monitored resources. |
|
|
(optional) If this query parameter is specified, the result is sorted by this query parameter value. Allowed values are: 'resourceName', 'resourceType', 'sourceResourceType' |
|
|
(optional) The sort order to use, either ascending (`ASC`) or descending (`DESC`). Allowed values are: 'ASC', 'DESC' |
|
|
(optional) 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. |
|
|
(optional) 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. |
|
|
(optional) 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. |
|
|
(optional) Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. |
|
|
(optional) 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. |
|
|
(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix). |
|
|
(optional) The endpoint of the service to call using this function. e.g https://stack-monitoring.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence. |
|
|
(optional) The name of the credential for authenticating with the corresponding cloud native API. |
SEARCH_MONITORED_RESOURCES Function
Gets a list of all monitored resources in a compartment for the given search criteria.
Syntax
FUNCTION search_monitored_resources (
search_monitored_resources_details dbms_cloud_oci_stack_monitoring_search_monitored_resources_details_t,
limit number DEFAULT NULL,
page varchar2 DEFAULT NULL,
fields dbms_cloud_oci_stack_monitoring_varchar2_tbl DEFAULT NULL,
exclude_fields dbms_cloud_oci_stack_monitoring_varchar2_tbl DEFAULT NULL,
opc_request_id varchar2 DEFAULT NULL,
opc_retry_token varchar2 DEFAULT NULL,
if_match varchar2 DEFAULT NULL,
region varchar2 DEFAULT NULL,
endpoint varchar2 DEFAULT NULL,
credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_smon_stack_monitoring_search_monitored_resources_response_t;Parameters
| Parameter | Description |
|---|---|
|
|
(required) Search Criteria for listing monitored resources. |
|
|
(optional) 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. |
|
|
(optional) 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. |
|
|
(optional) 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. |
|
|
(optional) 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. |
|
|
(optional) Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. |
|
|
(optional) 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. |
|
|
(optional) 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. |
|
|
(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix). |
|
|
(optional) The endpoint of the service to call using this function. e.g https://stack-monitoring.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence. |
|
|
(optional) The name of the credential for authenticating with the corresponding cloud native API. |
TEST_METRIC_EXTENSION Function
Performs test of Metric Extension on a specific resource Id
Syntax
FUNCTION test_metric_extension (
metric_extension_id varchar2,
test_metric_extension_details dbms_cloud_oci_stack_monitoring_test_metric_extension_details_t,
if_match varchar2 DEFAULT NULL,
opc_request_id varchar2 DEFAULT NULL,
opc_retry_token varchar2 DEFAULT NULL,
region varchar2 DEFAULT NULL,
endpoint varchar2 DEFAULT NULL,
credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_smon_stack_monitoring_test_metric_extension_response_t;Parameters
| Parameter | Description |
|---|---|
|
|
(required) The OCID of the metric extension resource. |
|
|
(required) It contains OCID of resource. |
|
|
(optional) 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. |
|
|
(optional) Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. |
|
|
(optional) 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. |
|
|
(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix). |
|
|
(optional) The endpoint of the service to call using this function. e.g https://stack-monitoring.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence. |
|
|
(optional) The name of the credential for authenticating with the corresponding cloud native API. |
UPDATE_AND_PROPAGATE_TAGS Function
Provided tags will be added or updated in the existing list of tags for the affected resources. Resources to be updated are identified based on association types specified. If association types not specified, then tags will be updated only for the resource identified by the given monitored resource identifier OCID.
Syntax
FUNCTION update_and_propagate_tags (
monitored_resource_id varchar2,
update_and_propagate_tags_details dbms_cloud_oci_stack_monitoring_update_and_propagate_tags_details_t,
opc_retry_token varchar2 DEFAULT NULL,
opc_request_id varchar2 DEFAULT NULL,
if_match varchar2 DEFAULT NULL,
region varchar2 DEFAULT NULL,
endpoint varchar2 DEFAULT NULL,
credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_smon_stack_monitoring_update_and_propagate_tags_response_t;Parameters
| Parameter | Description |
|---|---|
|
|
(required) The OCID of monitored resource. |
|
|
(required) The tags to be updated. |
|
|
(optional) 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. |
|
|
(optional) Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. |
|
|
(optional) 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. |
|
|
(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix). |
|
|
(optional) The endpoint of the service to call using this function. e.g https://stack-monitoring.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence. |
|
|
(optional) The name of the credential for authenticating with the corresponding cloud native API. |
UPDATE_BASELINEABLE_METRIC Function
Updates the Baseline-able metric for the given id
Syntax
FUNCTION update_baselineable_metric (
update_baselineable_metric_details dbms_cloud_oci_stack_monitoring_update_baselineable_metric_details_t,
baselineable_metric_id varchar2,
if_match varchar2 DEFAULT NULL,
opc_request_id varchar2 DEFAULT NULL,
region varchar2 DEFAULT NULL,
endpoint varchar2 DEFAULT NULL,
credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_smon_stack_monitoring_update_baselineable_metric_response_t;Parameters
| Parameter | Description |
|---|---|
|
|
(required) Baseline metric |
|
|
(required) Identifier for the metric |
|
|
(optional) 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. |
|
|
(optional) Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. |
|
|
(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix). |
|
|
(optional) The endpoint of the service to call using this function. e.g https://stack-monitoring.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence. |
|
|
(optional) The name of the credential for authenticating with the corresponding cloud native API. |
UPDATE_CONFIG Function
Updates the configuration identified by the id given.
Syntax
FUNCTION update_config (
config_id varchar2,
update_config_details dbms_cloud_oci_stack_monitoring_update_config_details_t,
if_match varchar2 DEFAULT NULL,
opc_request_id varchar2 DEFAULT NULL,
region varchar2 DEFAULT NULL,
endpoint varchar2 DEFAULT NULL,
credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_smon_stack_monitoring_update_config_response_t;Parameters
| Parameter | Description |
|---|---|
|
|
(required) Unique Config identifier. |
|
|
(required) The details of the configuration to be updated. |
|
|
(optional) 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. |
|
|
(optional) Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. |
|
|
(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix). |
|
|
(optional) The endpoint of the service to call using this function. e.g https://stack-monitoring.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence. |
|
|
(optional) The name of the credential for authenticating with the corresponding cloud native API. |
UPDATE_METRIC_EXTENSION Function
Updates the Metric Extension
Syntax
FUNCTION update_metric_extension (
metric_extension_id varchar2,
update_metric_extension_details dbms_cloud_oci_stack_monitoring_update_metric_extension_details_t,
if_match varchar2 DEFAULT NULL,
opc_request_id varchar2 DEFAULT NULL,
region varchar2 DEFAULT NULL,
endpoint varchar2 DEFAULT NULL,
credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_smon_stack_monitoring_update_metric_extension_response_t;Parameters
| Parameter | Description |
|---|---|
|
|
(required) The OCID of the metric extension resource. |
|
|
(required) The information to be updated. |
|
|
(optional) 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. |
|
|
(optional) Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. |
|
|
(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix). |
|
|
(optional) The endpoint of the service to call using this function. e.g https://stack-monitoring.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence. |
|
|
(optional) The name of the credential for authenticating with the corresponding cloud native API. |
UPDATE_MONITORED_RESOURCE Function
Update monitored resource by the given identifier OCID. Note that \"properties\" object, if specified, will entirely replace the existing object, as part this operation.
Syntax
FUNCTION update_monitored_resource (
monitored_resource_id varchar2,
update_monitored_resource_details dbms_cloud_oci_stack_monitoring_update_monitored_resource_details_t,
if_match varchar2 DEFAULT NULL,
opc_request_id varchar2 DEFAULT NULL,
region varchar2 DEFAULT NULL,
endpoint varchar2 DEFAULT NULL,
credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_smon_stack_monitoring_update_monitored_resource_response_t;Parameters
| Parameter | Description |
|---|---|
|
|
(required) The OCID of monitored resource. |
|
|
(required) The information to be updated. |
|
|
(optional) 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. |
|
|
(optional) Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. |
|
|
(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix). |
|
|
(optional) The endpoint of the service to call using this function. e.g https://stack-monitoring.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence. |
|
|
(optional) The name of the credential for authenticating with the corresponding cloud native API. |
UPDATE_MONITORED_RESOURCE_TASK Function
Update stack monitoring resource task by the given identifier OCID.
Syntax
FUNCTION update_monitored_resource_task (
monitored_resource_task_id varchar2,
update_monitored_resource_task_details dbms_cloud_oci_stack_monitoring_update_monitored_resource_task_details_t,
if_match varchar2 DEFAULT NULL,
opc_request_id varchar2 DEFAULT NULL,
region varchar2 DEFAULT NULL,
endpoint varchar2 DEFAULT NULL,
credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_smon_stack_monitoring_update_monitored_resource_task_response_t;Parameters
| Parameter | Description |
|---|---|
|
|
(required) The OCID of stack monitoring resource task. |
|
|
(required) The information to be updated. |
|
|
(optional) 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. |
|
|
(optional) Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. |
|
|
(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix). |
|
|
(optional) The endpoint of the service to call using this function. e.g https://stack-monitoring.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence. |
|
|
(optional) The name of the credential for authenticating with the corresponding cloud native API. |
UPDATE_MONITORED_RESOURCE_TYPE Function
Update the Monitored Resource Type identified by the identifier OCID.
Syntax
FUNCTION update_monitored_resource_type (
monitored_resource_type_id varchar2,
update_monitored_resource_type_details dbms_cloud_oci_stack_monitoring_update_monitored_resource_type_details_t,
if_match varchar2 DEFAULT NULL,
opc_request_id varchar2 DEFAULT NULL,
region varchar2 DEFAULT NULL,
endpoint varchar2 DEFAULT NULL,
credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_smon_stack_monitoring_update_monitored_resource_type_response_t;Parameters
| Parameter | Description |
|---|---|
|
|
(required) The OCID of monitored resource type. |
|
|
(required) The information to be updated for the given resource type id. |
|
|
(optional) 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. |
|
|
(optional) Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. |
|
|
(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix). |
|
|
(optional) The endpoint of the service to call using this function. e.g https://stack-monitoring.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence. |
|
|
(optional) The name of the credential for authenticating with the corresponding cloud native API. |