Jump to

• Request
• Response
• Examples

Retrieve Details of a Specific Metric Type

get

/monitoring/monitoring/{idDomainName}/.customer/api/v1/metricTypes/{metricTypeId}

Request

Path Parameters

• idDomainName: string
  Identity domain ID for the Oracle Monitoring Cloud Service account.
• metricTypeId: string
  Id of the metric type.

Query Parameters

• expands(optional): string
  Expand attributes in the comma separated list.

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 : 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 : 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."
        }
    }
}

Back to Top

Examples

The following example shows how to retrieve details of a specific metric type 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/metricTypes/compute.CPU.PERCENT

Example of Response Header

The following shows an example of the response header.

HTTP/1.1 200 OK
Date: Tue, 08 Mar 2016 12:20:49 GMT
Content-Type: application/json

Example of Response Body

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

{
  "id": "compute.CPU.PERCENT",
  "name": "cpuPercent",
  "displayName": "CPU Percentage",
  "shortDisplayName": "CPU",
  "unit": {
    "id": "PERCENT",
    "canonicalLink": "/monitoring/mydomain/.customer/api/v1/metricUnits/PERCENT"
  },
  "subjectType": {
    "id": "compute.vm"
  },
  "canonicalLink": "/monitoring/mydomain/.customer/api/v1/metricTypes/compute.CPU.PERCENT"
}
}

Back to Top