Jump to

• Request
• Response
• Examples

Retrieve Details of All Available Metric Types

get

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

Request

Path Parameters

• idDomainName: string
  Identity domain ID for the Oracle Monitoring Cloud Service account.

Query Parameters

• expands(optional): string
  Expand attributes in the comma separated list.
• ids(optional): string
  Filter on the metric types id.
• 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.
• since(optional): string
  Filter on the creation date time.
• subjectTypeIds(optional): string
  Filter on the subject type id.
• until(optional): string
  Filter on the creation date time.

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 : MetricTypes

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/MetricType"
            }
        }
    }
}

Nested Schema : items

Type: array

Show Source

• Array of: object MetricType

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

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 : 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 all available metric types 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

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": "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"
    },
    {
      "id": "compute.MEMORY.CURRENT",
      "name": "currentUsage",
      "displayName": "Memory Usage",
      "shortDisplayName": "Memory Usage",
      "unit": {
        "id": "KILOBYTES",
        "canonicalLink": "/monitoring/mydomain/.customer/api/v1/metricUnits/KILOBYTES"
      },
      "subjectType": {
        "id": "compute.vm"
      },
      "canonicalLink": "/monitoring/mydomain/.customer/api/v1/metricTypes/compute.MEMORY.CURRENT"
    },
    {
      "id": "compute.MEMORY.CURRENT_PERCENT",
      "name": "currentUsagePercent",
      "displayName": "Memory Usage Percentage",
      "shortDisplayName": "Memory Percent",
      "unit": {
        "id": "PERCENT",
        "canonicalLink": "/monitoring/mydomain/.customer/api/v1/metricUnits/PERCENT"
      },
      "subjectType": {
        "id": "compute.vm"
      },
      "canonicalLink": "/monitoring/mydomain/.customer/api/v1/metricTypes/compute.MEMORY.CURRENT_PERCENT"
    },
    {
      "id": "compute.NETWORK.RX_BYTES_PER_SEC",
      "name": "netRxBps",
      "displayName": "Network bytes received per second",
      "shortDisplayName": "Network Rcvd",
      "unit": {
        "id": "BYTES_PER_SEC",
        "canonicalLink": "/monitoring/mydomain/.customer/api/v1/metricUnits/BYTES_PER_SEC"
      },
      "subjectType": {
        "id": "compute.vm"
      },
      "canonicalLink": "/monitoring/mydomain/.customer/api/v1/metricTypes/compute.NETWORK.RX_BYTES_PER_SEC"
    },
    {
      "id": "compute.NETWORK.TX_BYTES_PER_SEC",
      "name": "netRxBps",
      "displayName": "Network bytes sent per second",
      "shortDisplayName": "Network Sent",
      "unit": {
        "id": "BYTES_PER_SEC",
        "canonicalLink": "/monitoring/mydomain/.customer/api/v1/metricUnits/BYTES_PER_SEC"
      },
      "subjectType": {
        "id": "compute.vm"
      },
      "canonicalLink": "/monitoring/mydomain/.customer/api/v1/metricTypes/compute.NETWORK.TX_BYTES_PER_SEC"
    },
    {
      "id": "compute.IOSTAT.READ",
      "name": "opStatsRead",
      "displayName": "Virtual block device read",
      "shortDisplayName": "IOStat Read",
      "unit": {
        "id": "SECTORS",
        "canonicalLink": "/monitoring/mydomain/.customer/api/v1/metricUnits/SECTORS"
      },
      "subjectType": {
        "id": "compute.vm"
      },
      "canonicalLink": "/monitoring/mydomain/.customer/api/v1/metricTypes/compute.IOSTAT.READ"
    },
    {
      "id": "compute.IOSTAT.WRITE",
      "name": "opStatsWrite",
      "displayName": "Virtual block device write",
      "shortDisplayName": "IOStat Write",
      "unit": {
        "id": "SECTORS",
        "canonicalLink": "/monitoring/mydomain/.customer/api/v1/metricUnits/SECTORS"
      },
      "subjectType": {
        "id": "compute.vm"
      },
      "canonicalLink": "/monitoring/mydomain/.customer/api/v1/metricTypes/compute.IOSTAT.WRITE"
    }
  ],
  "offset": 0,
  "limit": 1000,
  "hasMore": false,
  "canonicalLink": "/monitoring/mydomain/.customer/api/v1/metricTypes"
}

Back to Top