Jump to

• Request
• Response
• Examples

Retrieve Details of All Available Metric Instances

get

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

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.
• filterOutDeleted(optional): boolean
  Filter on isDeleted attribute of the metric series.
• ids(optional): string
  Filter on metric series ids.
• limit(optional): integer(int32)
  Maximum number of items that the request should return.
• metricTypeIds(optional): string
  Filter on metric type ids.
• offset(optional): integer(int32)
  Offset of the first element to return (for pagination purpose).
• since(optional): string
  Filter on the creation date time.
• subjectIds(optional): string
  Filter on metric subject ids.
• subjectTypeIds(optional): string
  Filter on metric subject type ids.
• 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 : MetricSeriesResultSet

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

Nested Schema : items

Type: array

Show Source

• Array of: object MetricSeries

{
    "type":"array",
    "items":{
        "$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 all available metric instances 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/metricSeries

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
Transfer-Encoding: chunked

Example of Response Body

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

{
  "items": [
    {
      "id": "821ce631-691e-494e-ba69-526739e086e2",
      "metricType": {
        "id": "compute.NETWORK.RX_BYTES_PER_SEC",
        "canonicalLink": "/monitoring/mydomain/.customer/api/v1/metricTypes/compute.NETWORK.RX_BYTES_PER_SEC"
      },
      "subject": {
        "id": "bb1ce631-691e-494e-ba69-526739e086e2",
        "canonicalLink": "/monitoring/mydomain/.customer/api/v1/metricSubjects/bb1ce631-691e-494e-ba69-526739e086e2"
      },
      "canonicalLink": "/monitoring/mydomain/.customer/api/v1/metricSeries/821ce631-691e-494e-ba69-526739e086e2"
    },
    ],
  "offset": 0,
  "limit": 1000,
  "hasMore": false,
  "canonicalLink": "/monitoring/mydomain/.customer/api/v1/metricSeries"
}

Back to Top