调用DescribeInstanceDbPerformance接口查看数据库监控信息详情。

调试

您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

请求参数

名称 类型 是否必选 示例值 描述
Action String DescribeInstanceDbPerformance

系统规定参数。取值为DescribeInstanceDbPerformance

DbInstanceName String pxc-****************

实例ID。

DbName String db2

数据库名称。

RegionId String cn-hangzhou

实例所在地域。

Keys String lqps,active,running_count

需要查询的监控项,取值范围如下:

  • lqps:QPS
  • active:连接数
  • running_count:活跃线程数
说明 允许同时查看多个监控项信息,多个监控项间需用英文逗号(,)分隔。
StartTime String 2020-08-19 11:02:50

监控开始时间(目标数据库所在时区的时间),格式为yyyy-mm-dd hh:mm:ss

EndTime String 2020-08-19 11:03:50

监控终止时间(目标数据库所在时区的时间),格式为yyyy-mm-dd hh:mm:ss

说明 监控终止时间需晚于监控开始时间。

返回数据

名称 类型 示例值 描述
Data Struct

监控数据。

PerformanceItems Array of PerformanceItem

监控项列表详情。

Measurement String lqps,active,running_count

监控项,取值范围如下:

  • lqps:QPS
  • active:连接数
  • running_count:活跃线程数
说明 更多关于数据库监控项信息,请参见数据库监控
MetricName String lqps

单个监控指标详情(如lqps)。

Points Array of Point

监控指标数据详情。

说明 若在查询时间范围内未采集到相关监控数据,则该参数列表为空。
Timestamp Long 1597179542

在查询时间范围内采集到监控数据的时间点,戳格式为Unix时间戳,单位为秒。

Value String 1

目标监控项的数值。

Message String ****

请求返回消息。

说明 请求成功时该参数为空,请求失败时会返回请求异常信息(如错误码等)。
RequestId String 5C07B700-A7CC-4F81-8861-86F840******

请求ID。

Success Boolean true

请求是否成功。

{

"code": "200",

"data": {

"RequestId": "5C07B700-A7CC-4F81-8861-86F84053A418",

"Data": {

"PerformanceItems": { "Measurement": "lqps,active,running_count", "MetricName": "lqps", "Points": [

}, {

"Measurement": "lqps,active,running_count",

"MetricName": "active",

"Points":

}, {

"Measurement": "lqps,active,running_count",

"MetricName": "running_count",

"Points":

}]

},

"Success": true

},

"httpStatusCode": "200",

"requestId": "5C07B700-A7CC-4F81-8861-86F84053A418",

"successResponse": true

}

示例

请求示例

http(s)://polardbx.cn-hangzhou.aliyuncs.com/?Action=DescribeInstanceDbPerformance
&DbInstanceName=pxc-****************
&DbName=db2
&RegionId=cn-hangzhou
&<公共请求参数>

正常返回示例

XML格式

<code>200</code>
<data>
    <RequestId>5C07B700-A7CC-4F81-8861-86F84053A418</RequestId>
    <Data>
        <PerformanceItems>
            <Measurement>lqps,active,running_count</Measurement>
            <MetricName>lqps</MetricName>
        </PerformanceItems>
        <PerformanceItems>
            <Measurement>lqps,active,running_count</Measurement>
            <MetricName>active</MetricName>
        </PerformanceItems>
        <PerformanceItems>
            <Measurement>lqps,active,running_count</Measurement>
            <MetricName>running_count</MetricName>
        </PerformanceItems>
    </Data>
    <Success>true</Success>
</data>
<httpStatusCode>200</httpStatusCode>
<requestId>5C07B700-A7CC-4F81-8861-86F84053A418</requestId>
<successResponse>true</successResponse>

JSON格式

{
	"code": "200",
	"data": {
		"RequestId": "5C07B700-A7CC-4F81-8861-86F840******",
		"Data": {
			"PerformanceItems": [{
				"Measurement": "lqps,active,running_count",
				"MetricName": "lqps",
				"Points": []
			}, {
				"Measurement": "lqps,active,running_count",
				"MetricName": "active",
				"Points": []
			}, {
				"Measurement": "lqps,active,running_count",
				"MetricName": "running_count",
				"Points": []
			}]
		},
		"Success": true
	},
	"httpStatusCode": "200",
	"requestId": "5C07B700-A7CC-4F81-8861-86F840******",
	"successResponse": true
}

错误码

访问错误中心查看更多错误码。