Queries the details about 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 Distributed Relational Database Service (DRDS) instance.

EndTime Long Yes 1603209690000

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

Key String Yes cpu

The performance monitoring metrics. You can specify one or more metrics for a query at a time. Separate multiple metric parameters with commas (,).

Note For more information about the details of performance monitoring metrics, see Instance monitoring.
RegionId String Yes cn-hangzhou

The ID of the region.

StartTime Long Yes 1603123290000

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

PeriodMultiple Integer No 1

The multiple of the monitoring data cycle. For example, the data collection cycle of each resource metric is 1 minute by default. If you set the multiple of the cycle to 2, the data collection cycle of the current resource metric is 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 monitoring metric.

NodeNum Integer 1

The number of nodes.

Unit String %

The unit of the monitoring metric.

Values Array of PerformanceValue

The details of the monitoring metric data.

Date Long 1603163400000

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

Value String 1.40

The value of the monitoring metric.

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

The ID of the request.

Examples

Sample requests

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

Sample success responses

XML format

<DescribeDrdsInstanceMonitorResponse>
  <RequestId>59A01983-1E96-42AA-8D8C-BAC400******</RequestId>
  <Data>
        <NodeNum>1</NodeNum>
        <Values>
              <Value>1.40</Value>
              <Date>1603163400000</Date>
        </Values>
        <Unit>%</Unit>
        <Key>cpu</Key>
  </Data>
</DescribeDrdsInstanceMonitorResponse>

JSON format

{
	"RequestId": "59A01983-1E96-42AA-8D8C-BAC400******",
	"Data": [
		{
			"NodeNum": 1,
			"Values": [
				{
					"Value": "1.40",
					"Date": 1603163400000
				}
			],
			"Unit": "%",
			"Key": "cpu"
		}
	]
}

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 authorized to perform this action. Perform Resource Access Management (RAM) authorization first.

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