Queries the performance monitoring data of a specified database.

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 DescribeDrdsInstanceDbMonitor

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

DbName String Yes drds_test

The name of the database.
DrdsInstanceId String Yes drds*************

The ID of the Distributed Relational Database Service (DRDS) instance.
EndTime Long Yes 1603166400000

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

Key String Yes qps

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 Database monitoring.
StartTime Long Yes 1603162800000

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

RegionId String No cn-hangzhou

The ID of the region.

Response parameters

Parameter Type Example Description
Data Array of PartialPerformanceData

The list of monitoring data.
Key String qps

The name of the monitoring metric.
Unit String qps

The unit of the monitoring metric.
Values Array of PerformanceValue

The details about the value of monitoring data.
Date Long 1603162805000

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

Value String 0

The data value.
RequestId String 2F7F8080-9132-4279-85D0-B7E5C4******

The ID of the request.
Success Boolean true

Indicates whether the request is successful.

Examples

Sample requests

http(s)://drds.cn-hangzhou.aliyuncs.com/? Action=DescribeDrdsInstanceDbMonitor
&DbName=drds_test
&DrdsInstanceId=drds*************
&EndTime=1603166400000
&Key=qps
&StartTime=1603162800000
&<Common request parameters>

Sample success responses

XML format 

<DescribeDrdsInstanceDbMonitorResponse>
  <RequestId>01685B03-4099-414F-B9E1-DB994947CA8E</RequestId>
  <Data>
        <Values>
              <Value>0</Value>
              <Date>1602234005000</Date>
        </Values>
        <Unit>qps</Unit>
        <Key>qps</Key>
  </Data>
  <Success>true</Success>
</DescribeDrdsInstanceDbMonitorResponse>

JSON format 

{
    "RequestId": "01685B03-4099-414F-B9E1-DB9949******",
    "Data": [
        {
            "Values": [
                {
                    "Value": "0",
                    "Date": 1602234005000
                }
            ],
            "Unit": "qps",
            "Key": "qps"
        }
    ],
    "Success": true
}

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.