调用DescribeDBInstanceMetrics查询RDS PostgreSQL实例已开启的增强指标。
前提条件
实例为RDS PostgreSQL。
本功能对应的控制台文档,请参见查看增强监控。
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。
请求参数
名称 | 类型 | 是否必选 | 示例值 | 描述 |
---|---|---|---|---|
Action | String | 是 | DescribeDBInstanceMetrics |
系统规定参数。取值:DescribeDBInstanceMetrics。 |
DBInstanceName | String | 是 | pgm-bp1s1j103lo6**** |
实例ID。可调用DescribeDBInstances获取。 |
ResourceGroupId | String | 否 | rg-acfmy***** |
资源组ID。 |
返回数据
名称 | 类型 | 示例值 | 描述 |
---|---|---|---|
TotalRecordCount | Integer | 1 |
实例已开启的增强指标总数。 |
RequestId | String | 318C3754-F6D0-54BB-A55C-23EAA04708B7 |
请求ID。 |
Items | Array of Metrics |
实例已开启的增强指标列表。 |
|
GroupKey | String | os.cpu_usage |
增强指标所在分组的Key。 |
SortRule | Integer | 1 |
增强指标编号。 |
Description | String | sys cpu使用率,sys cpu使用量 / cpu总量 |
增强指标描述信息。 |
Unit | String | % |
增强指标单位。 |
MetricsKey | String | os.cpu_usage.sys.avg |
增强指标的Key。 |
GroupKeyType | String | CPU使用率 |
增强指标所在分组的名称。 |
Method | String | avg |
增强指标统计方法。返回值:
|
Dimension | String | os |
增强指标类别。返回值:
|
MetricsKeyAlias | String | os.cpu_usage.sys |
增强指标别名。 |
DBInstanceName | String | rm-bp1***** |
实例ID。 |
示例
请求示例
http(s)://rds.aliyuncs.com/?Action=DescribeDBInstanceMetrics
&DBInstanceName=pgm-bp1s1j103lo6****
&<公共请求参数>
正常返回示例
XML
格式
HTTP/1.1 200 OK
Content-Type:application/xml
<DescribeDBInstanceMetrics>
<TotalRecordCount>1</TotalRecordCount>
<RequestId>318C3754-F6D0-54BB-A55C-23EAA04708B7</RequestId>
<Items>
<Description>sys cpu使用率,sys cpu使用量 / cpu总量</Description>
<GroupKeyType>CPU使用率</GroupKeyType>
<MetricsKey>os.cpu_usage.sys.avg</MetricsKey>
<GroupKey>os.cpu_usage</GroupKey>
<Dimension>os</Dimension>
<Method>avg</Method>
<Unit>%</Unit>
<SortRule>1</SortRule>
<MetricsKeyAlias>os.cpu_usage.sys</MetricsKeyAlias>
</Items>
</DescribeDBInstanceMetrics>
JSON
格式
HTTP/1.1 200 OK
Content-Type:application/json
{
"TotalRecordCount" : 1,
"RequestId" : "318C3754-F6D0-54BB-A55C-23EAA04708B7",
"Items" : {
"Description" : "sys cpu使用率,sys cpu使用量 / cpu总量",
"GroupKeyType" : "CPU使用率",
"MetricsKey" : "os.cpu_usage.sys.avg",
"GroupKey" : "os.cpu_usage",
"Dimension" : "os",
"Method" : "avg",
"Unit" : "%",
"SortRule" : 1,
"MetricsKeyAlias" : "os.cpu_usage.sys"
}
}
错误码
HttpCode | 错误码 | 错误信息 | 描述 |
---|---|---|---|
400 | InvalidInstanceMetricsConfigs.NotFound | The specified instance has no metrics configs | 指定的实例没有性能指标配置项 |
400 | InvalidDBInstanceEngineType.Format | the DB instance engine type does not support this operation. | DB实例引擎类型不支持此操作。 |
404 | InvalidDBInstanceName.NotFound | The database instance does not exist. | 数据库实例名称不存在。请确认数据名称是否正确。 |
访问错误中心查看更多错误码。