Jump to

• Request
• Response
• Examples

Retrieve Details of a Specific Metric Threshold

get

/monitoring/monitoring/{idDomainName}/.customer/api/v1/metricThresholds/{thresholdId}

Request

Path Parameters

• idDomainName: string
  Identity domain ID for the Oracle Monitoring Cloud Service account.
• thresholdId: string
  ID of the Threshold object.

Header Parameters

• Authorization: string
  Basic Authentication credentials. The user must be located in the identity domain name specified by the header X-ID-TENANT-NAME.
• X-ID-TENANT-NAME: string
  Set to the identity domain ID where the user specified in the Authorization header resides.

Back to Top

Response

Supported Media Types

• application/json

200 Response

successful operation

Body ()

Root Schema : MetricThreshold

Type: object

Show Source

• alertAction(optional): object MetricThresholdAlertAction
• canonicalLink(optional): string(uri)
  Read Only: true

  Relative path to the resource.
• condition(optional): object MetricThresholdCondition
• id(optional): string(uuid)
  Read Only: true

  Unique ID of the metric threshold.
• name(optional): string
  Specify a name for the metric threshold.
• target(optional): object MetricTarget

{
    "type":"object",
    "properties":{
        "canonicalLink":{
            "type":"string",
            "format":"uri",
            "readOnly":true,
            "description":"\tRelative path to the resource."
        },
        "id":{
            "type":"string",
            "format":"uuid",
            "readOnly":true,
            "description":"Unique ID of the metric threshold."
        },
        "name":{
            "type":"string",
            "description":"Specify a name for the metric threshold."
        },
        "target":{
            "$ref":"#/definitions/MetricTarget"
        },
        "condition":{
            "$ref":"#/definitions/MetricThresholdCondition"
        },
        "alertAction":{
            "$ref":"#/definitions/MetricThresholdAlertAction"
        }
    }
}

Nested Schema : MetricThresholdAlertAction

Type: object

Show Source

• channelType(optional): string
  Specify the type of alert notification to be sent. By default, the channelType attribute is set to NOTIFICATION_MESSAGE. In this case, an email notification is sent to the service administrator of the requested resource when an event occurs.
  
  The channelType attribute can also be set to PUSH_TO_CLIENT. In this case, notification messages are delivered to the process polling for state changes.
• type(optional): string
  Specify the alert action type.

{
    "type":"object",
    "properties":{
        "type":{
            "type":"string",
            "description":"Specify the alert action type."
        },
        "channelType":{
            "type":"string",
            "description":"Specify the type of alert notification to be sent. By default, the <code>channelType</code> attribute is set to <code>NOTIFICATION_MESSAGE</code>. In this case, an email notification is sent to the service administrator of the requested resource when an event occurs.<br><br>The <code>channelType</code> attribute can also be set to <code>PUSH_TO_CLIENT</code>. In this case, notification messages are delivered to the process polling for state changes."
        }
    }
}

Nested Schema : MetricThresholdCondition

Type: object

Show Source

• operation(optional): string
  Specify the operation (>, <, <=, >=, =).
• periodCountToSatisfy(optional): integer(int32)
  Enter the number of consecutive times the metric must meet the criteria specified by you to trigger an alert.
• periodCountToUnsatisfy(optional): integer(int32)
  Enter the number of consecutive times that the metric must be within the threshold limit to trigger an alert.
• periodDuration(optional): string
  Specify the time period for which you want to monitor the metric.
  
  Note: You must use the iCalendar Duration format. For example, PT10M.
  
  By default periodDuration is set to PT5M. The minimum accepted value for periodDuration is PT5M.
• stats(optional): string
  Specify the statistic to monitor (avg, count, min, max, sum).
• value(optional): number(double)
  Specify the threshold value.

{
    "type":"object",
    "properties":{
        "periodDuration":{
            "type":"string",
            "description":"Specify the time period for which you want to monitor the metric.<br><br><strong>Note:</strong> You must use the iCalendar <a href=\"https://tools.ietf.org/html/rfc5545#section-3.3.6\">Duration</a> format. For example, <code>PT10M</code>.<br><br>By default <code>periodDuration</code> is set to <code>PT5M</code>. The minimum accepted value for <code>periodDuration</code> is <code>PT5M</code>."
        },
        "periodCountToSatisfy":{
            "type":"integer",
            "format":"int32",
            "description":"Enter the number of consecutive times the metric must meet the criteria specified by you to trigger an alert."
        },
        "periodCountToUnsatisfy":{
            "type":"integer",
            "format":"int32",
            "description":"Enter the number of consecutive times that the metric must be within the threshold limit to trigger an alert."
        },
        "operation":{
            "type":"string",
            "description":"Specify the operation (&gt;, &lt;, &lt;=, &gt;=, =)."
        },
        "value":{
            "type":"number",
            "format":"double",
            "description":"Specify the threshold value."
        },
        "stats":{
            "type":"string",
            "description":"Specify the statistic to monitor (avg, count, min, max, sum)."
        }
    }
}

Nested Schema : MetricTarget

Type: object

Show Source

• series(optional): object MetricSeries

{
    "type":"object",
    "properties":{
        "series":{
            "$ref":"#/definitions/MetricSeries"
        }
    }
}

Nested Schema : MetricSeries

Type: object

Show Source

• canonicalLink(optional): string(uri)
  Relative path to the resource.
• id(optional): string(uuid)
  A unique ID representing a metric type for a specific metric subject. For example, 821ce631-691e-494e-ba69-526739e086e2.
• isDeleted(optional): boolean
  Default Value: false

  Indicates whether the referenced object has been deleted.
• metricType(optional): object MetricType
• subject(optional): object MetricSubject

{
    "type":"object",
    "properties":{
        "canonicalLink":{
            "type":"string",
            "format":"uri",
            "description":"Relative path to the resource."
        },
        "id":{
            "type":"string",
            "format":"uuid",
            "description":"A unique ID representing a metric type for a specific metric subject. For example, 821ce631-691e-494e-ba69-526739e086e2."
        },
        "isDeleted":{
            "type":"boolean",
            "description":"Indicates whether the referenced object has been deleted.",
            "default":false
        },
        "metricType":{
            "$ref":"#/definitions/MetricType"
        },
        "subject":{
            "$ref":"#/definitions/MetricSubject"
        }
    }
}

Nested Schema : MetricType

Type: object

Show Source

• canonicalLink(optional): string(uri)
  Relative path to the resource.
• description(optional): string
  Description of the metric type.
• displayName(optional): string
  Display name of the metric type.
• id(optional): string
  Unique ID of the metric type. For example, compute.CPU.PERCENT.
• name(optional): string
  Short name of the metric type. For example, cpuPercent.
• shortDisplayName(optional): string
  Short display name for the metric type.
• subjectType(optional): object MetricSubjectType
• unit(optional): object MetricUnit

{
    "type":"object",
    "properties":{
        "canonicalLink":{
            "type":"string",
            "format":"uri",
            "description":"Relative path to the resource."
        },
        "id":{
            "type":"string",
            "description":"Unique ID of the metric type. For example, compute.CPU.PERCENT."
        },
        "name":{
            "type":"string",
            "description":"Short name of the metric type. For example, cpuPercent."
        },
        "displayName":{
            "type":"string",
            "description":"Display name of the metric type."
        },
        "shortDisplayName":{
            "type":"string",
            "description":"Short display name for the metric type."
        },
        "description":{
            "type":"string",
            "description":"Description of the metric type."
        },
        "unit":{
            "$ref":"#/definitions/MetricUnit"
        },
        "subjectType":{
            "$ref":"#/definitions/MetricSubjectType"
        }
    }
}

Nested Schema : MetricSubject

Type: object

Show Source

• canonicalLink(optional): string(uri)
  Relative path to the resource.
• displayName(optional): string
  Display name of the metric subject.
• id(optional): string(uuid)
  Unique ID of the metric subject. For example, bbdce636-691e-494e-ba69-526739e086e0.
• isDeleted(optional): boolean
  Default Value: false

  Indicates whether the referenced object has been deleted.
• properties(optional): array properties
  Properties of the subject.
• subjectType(optional): object MetricSubjectType

{
    "type":"object",
    "properties":{
        "canonicalLink":{
            "type":"string",
            "format":"uri",
            "description":"Relative path to the resource."
        },
        "isDeleted":{
            "type":"boolean",
            "description":"Indicates whether the referenced object has been deleted.",
            "default":false
        },
        "displayName":{
            "type":"string",
            "description":"Display name of the metric subject."
        },
        "id":{
            "type":"string",
            "format":"uuid",
            "description":"Unique ID of the metric subject. For example, bbdce636-691e-494e-ba69-526739e086e0."
        },
        "subjectType":{
            "$ref":"#/definitions/MetricSubjectType"
        },
        "properties":{
            "type":"array",
            "description":"Properties of the subject.",
            "items":{
                "$ref":"#/definitions/MetricProperty"
            }
        }
    }
}

Nested Schema : MetricSubjectType

Type: object

Show Source

• id(optional): string
  Unique ID of the metric unit. For example, compute.vm.

{
    "type":"object",
    "properties":{
        "id":{
            "type":"string",
            "description":"Unique ID of the metric unit. For example, compute.vm."
        }
    }
}

Nested Schema : MetricUnit

Type: object

Show Source

• canonicalLink(optional): string(uri)
  Relative path to the resource.
• displayName(optional): string
  Display name of the metric unit.
• id(optional): string
  Unique ID of the metric unit. For example, BYTES.
• shortDisplayName(optional): string
  Short display name for the metric unit.

{
    "type":"object",
    "properties":{
        "canonicalLink":{
            "type":"string",
            "format":"uri",
            "description":"Relative path to the resource."
        },
        "id":{
            "type":"string",
            "description":"Unique ID of the metric unit. For example, BYTES."
        },
        "displayName":{
            "type":"string",
            "description":"Display name of the metric unit."
        },
        "shortDisplayName":{
            "type":"string",
            "description":"Short display name for the metric unit."
        }
    }
}

Nested Schema : properties

Type: array

Properties of the subject.

Show Source

• Array of: object MetricProperty

{
    "type":"array",
    "description":"Properties of the subject.",
    "items":{
        "$ref":"#/definitions/MetricProperty"
    }
}

Nested Schema : MetricProperty

Type: object

Show Source

• name(optional): string
  The name of the metric property. For example, vmUuid.
• value(optional): string
  The value of the metric property. For example, 11da4f96-e95e-4998-810c-198d5df034c4 for the vmUuid property.

{
    "type":"object",
    "properties":{
        "name":{
            "type":"string",
            "description":"The name of the metric property. For example, vmUuid."
        },
        "value":{
            "type":"string",
            "description":"The value of the metric property. For example, 11da4f96-e95e-4998-810c-198d5df034c4 for the vmUuid property."
        }
    }
}

Back to Top

Examples

The following example shows how to retrieve details of a specific metric threshold by submitting a GET request on the REST resource using cURL. See Use cURL.

curl -X GET -H "Authorization: Basic d2VibG9naWM6V2VsY29tZTE=" -H "X-ID-TENANT-NAME:mydomain" https://monitoring.us.oraclecloud.com/monitoring/mydomain/.customer/api/v1/metricThresholds/b9068caa-83d6-467b-8bb8-354e40767573

Example of Response Header

The following shows an example of the response header.

HTTP/1.1 200 OK
Date: Fri, 29 Apr 2016 08:40:06 GMT
Content-Type: application/json

Example of Response Body

The following example shows the contents of the response body in JSON format:

  {
      "id": "b9068caa-83d6-467b-8bb8-354e40767573",
      "target": {
        "series": {
          "id": "2b0af13a-e497-6bec-e053-caa0f90a8a24",
          "metricType": {
            "id": "compute.CPU.PERCENT",
            "canonicalLink": "/monitoring/mydomain/.customer/api/v1/metricTypes/compute.CPU.PERCENT"
          },
          "subject": {
            "id": "2b0af13a-e496-6bec-e053-caa0f90a8a24",
            "canonicalLink": "/monitoring/mydomain/.customer/api/v1/metricSubjects/2b0af13a-e496-6bec-e053-caa0f90a8a24"
          },
          "canonicalLink": "/monitoring/mydomain/.customer/api/v1/metricSeries/2b0af13a-e497-6bec-e053-caa0f90a8a24"
        }
      },
      "name": "VM1 High Cpu",
      "condition": {
        "stats": "avg",
        "operation": ">=",
        "value": 70,
        "periodDuration": "PT10M",
        "periodCountToSatisfy": 3,
        "periodCountToUnsatisfy": 2
      },
      "alertAction": {
        "type": "notification",
        "channelType": "notificationMessage"
      },
      "canonicalLink": "/monitoring/mydomain/.customer/api/v1/metricThresholds/b9068caa-83d6-467b-8bb8-354e40767573"
    },

Back to Top