REST API for Oracle Monitoring Cloud Service

Retrieve Details of All Available Metric Units

get

/monitoring/monitoring/{idDomainName}/.customer/api/v1/metricUnits

Request

Path Parameters

idDomainName: string

Identity domain ID for the Oracle Monitoring Cloud Service account.

Query Parameters

limit(optional): integer(int32)

Maximum number of items that the request should return.
offset(optional): integer(int32)

Offset of the first element to return (for pagination purpose).
orderBy(optional): string

Supported value is displayName.

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.

Response

Supported Media Types

application/json

200 Response

successful operation

Root Schema : MetricUnits

Type: object

Show Source

canonicalLink(optional): string(uri)

Relative path to the resource.
hasMore(optional): boolean

Default Value: false

Is true if there are more items to return.
items(optional): array items
limit(optional): integer(int32)

Maximum number of items that the request should return.
nextLink(optional): string(uri)

Relative path to the next page.
offset(optional): integer(int32)

Offset of the first element to return (for pagination purpose).

{
    "type":"object",
    "properties":{
        "canonicalLink":{
            "type":"string",
            "format":"uri",
            "description":"\tRelative path to the resource."
        },
        "nextLink":{
            "type":"string",
            "format":"uri",
            "description":"Relative path to the next page."
        },
        "offset":{
            "type":"integer",
            "format":"int32",
            "description":"Offset of the first element to return (for pagination purpose)."
        },
        "limit":{
            "type":"integer",
            "format":"int32",
            "description":"Maximum number of items that the request should return."
        },
        "hasMore":{
            "type":"boolean",
            "description":"Is true if there are more items to return.",
            "default":false
        },
        "items":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/MetricUnit"
            }
        }
    }
}

Nested Schema : items

Type: array

Show Source

Array of: object MetricUnit

{
    "type":"array",
    "items":{
        "$ref":"#/definitions/MetricUnit"
    }
}

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

Examples

The following example shows how to retrieve details of all available metric units 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/metricUnits

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:

{
  "items": [
    {
      "id": "BYTES",
      "displayName": "bytes",
      "shortDisplayName": "B",
      "canonicalLink": "/monitoring/mydomain/.customer/api/v1/metricUnits/BYTES"
    },
    {
      "id": "BYTES_PER_SEC",
      "displayName": "bytes per Second",
      "shortDisplayName": "B/s",
      "canonicalLink": "/monitoring/mydomain/.customer/api/v1/metricUnits/BYTES_PER_SEC"
    },
    {
      "id": "COUNT",
      "canonicalLink": "/monitoring/mydomain/.customer/api/v1/metricUnits/COUNT"
    },
    {
      "id": "COUNT_PER_SEC",
      "displayName": "per second",
      "shortDisplayName": "/s",
      "canonicalLink": "/monitoring/mydomain/.customer/api/v1/metricUnits/COUNT_PER_SEC"
    },
    {
      "id": "KILOBYTES",
      "displayName": "kilobytes",
      "shortDisplayName": "kb",
      "canonicalLink": "/monitoring/mydomain/.customer/api/v1/metricUnits/KILOBYTES"
    },
    {
      "id": "KILOBYTES_PER_SEC",
      "displayName": "kilobytes per Second",
      "shortDisplayName": "kb/s",
      "canonicalLink": "/monitoring/mydomain/.customer/api/v1/metricUnits/KILOBYTES_PER_SEC"
    },
    {
      "id": "PERCENT",
      "displayName": "percent",
      "shortDisplayName": "%",
      "canonicalLink": "/monitoring/mydomain/.customer/api/v1/metricUnits/PERCENT"
    },
    {
      "id": "SECTORS",
      "displayName": "Virtual block device sectors",
      "shortDisplayName": "sectors",
      "canonicalLink": "/monitoring/mydomain/.customer/api/v1/metricUnits/SECTORS"
    }
  ],
  "offset": 0,
  "limit": 1000,
  "hasMore": false,
  "canonicalLink": "/monitoring/mydomain/.customer/api/v1/metricUnits"
}