Queries the details of the monitoring data of a specified instance.

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer. OpenAPI Explorer dynamically generates the sample code of the operation for different SDKs.

Request parameters

Parameter Type Required Example Description
Action String Yes DescribeDrdsInstanceMonitor

The operation that you want to perform. Set the value to DescribeDrdsInstanceMonitor.

DrdsInstanceId String Yes drds*********

The ID of the instance.

EndTime Long Yes 1603209690000

The end time of the query. Specify the value in the UNIX timestamp format. The timestamp must be in UTC. Unit: ms.

Note If the time range that you specify is less than 1 hour, the monitoring data that is collected in a 1-hour period before the end time is returned.
Key String Yes cpu

The performance monitoring metrics. You can specify one or more metrics. Separate multiple metric names with commas (,).

Note For more information about performance monitoring metrics, see Monitor instances.
RegionId String Yes cn-hangzhou

The ID of the region where the instance is deployed.

StartTime Long Yes 1603123290000

The start time of the query. Specify the value in the UNIX timestamp format. The timestamp must be in UTC. Unit: ms.

PeriodMultiple Integer No 1

The multiple of the default time interval that you want to use to collect monitoring data. By default, the system collects monitoring data of resources at an interval of 1 minute. If you set the value of this parameter to 2, the system collects monitoring data of the instance at an interval of 2 minutes.

Response parameters

Parameter Type Example Description
Data Array of PartialPerformanceData

The result set of the query.

Key String cpu

The name of the metric.

NodeNum Integer 1

The number of nodes.

Unit String %

The unit of the metric value.

Values Array of PerformanceValue

The details of the monitoring data of the metric.

Date Long 1603163400000

The point in time when the value of the metric was collected. The value is in the UNIX timestamp format. The timestamp is displayed in UTC. Unit: ms.

Value String 1.40

The value of the metric.

RequestId String 2F7F8080-9132-4279-85D0-B7E5C4

The ID of the request.

Examples

Sample requests

http(s)://[Endpoint]/?Action=DescribeDrdsInstanceMonitor
&DrdsInstanceId=drds*********
&EndTime=1603209690000
&Key=cpu
&RegionId=cn-hangzhou
&StartTime=1603123290000
&<Common request parameters>

Sample success response

XML format 

<RequestId>2F7F8080-9132-4279-85D0-B7E5C4</RequestId>
<Data>
    <NodeNum>1</NodeNum>
    <Unit>%</Unit>
    <Key>cpu</Key>
    <Values>
        <Value>1.40</Value>
        <Date>1603163400000</Date>
    </Values>
</Data>

JSON format 

{"RequestId":"2F7F8080-9132-4279-85D0-B7E5C4","Data":[{"NodeNum":"1","Unit":"%","Key":"cpu","Values":[{"Value":"1.40","Date":"1603163400000"}]}]}

Error codes

HttpCode Error code Error message Description
400 ActionUnauthorized The specified action is not available for you The error message returned because you are not granted permissions to perform this operation. Grant the required permissions to the Resource Access Management (RAM) user that you want to use to perform this operation.
500 InternalError The request processing has failed due to some unknown error. The error message returned because an internal error occurred and the request failed.

For a list of error codes, visit the Error Center.