Description
You can call this API to retrieve the performance data for an instance.
Note You can retrieve a maximum of 400 records for each request. The number of records for each request must satisfy the following formula: (EndTime – StartTime)/Interval < 400. Otherwise, an error message is returned.
Request parameters
Name | Type | Required | Description |
---|---|---|---|
<Common request parameters> | - | - | For more information, see Common parameters. |
Action | String | Yes | Required parameter, and the value is DescribeInstancePerformance. |
InstanceId | String | Yes | The ID of the instance. |
Interval | String | Yes | The sampling interval. |
KeyList | String | Yes | The monitoring metrics for database performance. Separate multiple metrics by commas (,). For more information about the metrics, see the PerformanceValue table. |
StartTime | String | Yes | The start time of the data sampling. |
End time. | String | Yes | The end time of the data sampling. |
MonitorGroup | String | No | The monitoring group. |
Response parameters
Name | Type | Description |
---|---|---|
<Common response parameters> | String | For more information, see Common response parameters. |
MonitorDatas | List<MonitorData> | The details about the monitoring data. |
Name | Type | Description |
---|---|---|
DBInstanceId | String | The ID of the instance. |
Key | String | The name of the metric. |
Unit | String | The unit of the metric. |
PerformanceValues | List<PerformanceValue> | The performance data. |
Name | Type | Description |
---|---|---|
Value | String | The value of the metric. |
Date | String | The timestamp for the monitoring data, accurate to milliseconds. |
Sample requests
https://petadata.aliyuncs.com/?Action=DescribeInstancePerformance
&InstanceId=pd-xxxxxxxxxxxxxx
&StartTime=2018-08-03T05:00:08Z
&EndTime=2018-08-03T06:00:08Z
&Interval=2
&KeyList=sfn
&MonitorGroup=gcs
&<[Common request parameters]>
Sample responses
XML format
<DescribeInstancePerformanceResponse>
<MonitorDatas>
<MonitorData>
<Key>sfn</Key>
<PerformanceValues></PerformanceValues>
<Unit>integer</Unit>
</MonitorData>
</MonitorDatas>
<RequestId>830BB980-A7C9-4F02-B977-5CA73374AC05</RequestId>
</DescribeInstancePerformanceResponse>
JSON format
{
"MonitorDatas":{
"MonitorData":[
{
"Key":"sfn",
"PerformanceValues":{
"PerformanceValue":[
]
},
"Unit":"integer"
}
]
},
"RequestId":"830BB980-A7C9-4F02-B977-5CA73374AC05"
}