Retrieve Details of a Specific Metric Instance
get
/monitoring/monitoring/{idDomainName}/.customer/api/v1/metricSeries/{metricSeriesId}
Request
Path Parameters
-
idDomainName: string
Identity domain ID for the Oracle Monitoring Cloud Service account.
-
metricSeriesId: string
Id of the metric series.
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.
Response
Supported Media Types
- application/json
200 Response
successful operation
Root Schema : MetricSeries
Type:
Show Source
object
-
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
Nested Schema : MetricType
Type:
Show Source
object
-
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
Nested Schema : MetricSubject
Type:
Show Source
object
-
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
Nested Schema : MetricSubjectType
Type:
Show Source
object
-
id(optional):
string
Unique ID of the metric unit. For example, compute.vm.
Nested Schema : MetricUnit
Type:
Show Source
object
-
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.
Nested Schema : MetricProperty
Type:
Show Source
object
-
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.
Examples
The following example shows how to retrieve details of a specific metric instance 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/821ce631-691e-494e-ba69-526739e086e2
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 Transfer-Encoding: chunked Content-Type: application/json
Example of Response Body
The following example shows the contents of the response body in JSON format:
{ "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" }