首页 云数据库 RDS 开发参考 API参考 API目录 监控 DescribeDBInstanceMetrics - 查询RDS PostgreSQL实例展示的监控指标项

DescribeDBInstanceMetrics - 查询RDS PostgreSQL实例展示的监控指标项

更新时间: 2023-09-26 16:22:31

该接口用于查询RDS PostgreSQL实例已开启展示的增强指标。

接口说明

前提条件

实例为RDS PostgreSQL。

本功能对应的控制台文档,请参见查看增强监控

调试

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

调试

授权信息

下表是API对应的授权信息,可以在RAM权限策略语句的Action元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:

  • 操作:是指具体的权限点。
  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:
    • 对于必选的资源类型,用背景高亮的方式表示。
    • 对于不支持资源级授权的操作,用全部资源表示。
  • 条件关键字:是指云产品自身定义的条件关键字。
  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作访问级别资源类型条件关键字关联操作
rds:DescribeDBInstanceMetricsRead
  • DBInstance
    acs:rds:{#regionId}:{#accountId}:dbinstance/{#dbinstanceId}
  • rds:ResourceTag

请求参数

名称类型必填描述示例值
DBInstanceNamestring

实例ID。可调用DescribeDBInstances获取。

pgm-bp1s1j103lo6****
ResourceGroupIdstring

资源组ID。

rg-acfmy*****

返回参数

名称类型描述示例值
object
TotalRecordCountinteger

实例已开启的增强指标总数。

1
RequestIdstring

请求ID。

318C3754-F6D0-54BB-A55C-23EAA04708B7
Itemsobject []

实例已开启的增强指标列表。

GroupKeystring

增强指标所在分组的Key。

os.cpu_usage
SortRuleinteger

增强指标编号。

1
Descriptionstring

增强指标描述信息。

sys cpu使用率,sys cpu使用量 / cpu总量
Unitstring

增强指标单位。

%
MetricsKeystring

增强指标的Key。

os.cpu_usage.sys.avg
GroupKeyTypestring

增强指标所在分组的名称。

CPU使用率
Methodstring

增强指标统计方法。返回值:

  • avg:统计平均值。
  • min:统计最小值。
  • max:统计最大值。
avg
Dimensionstring

增强指标类别。返回值:

  • os:操作系统指标。
  • db:数据库指标。
os
MetricsKeyAliasstring

增强指标别名。

os.cpu_usage.sys
DBInstanceNamestring

实例ID。

rm-bp1*****

示例

正常返回示例

JSON格式

{
  "TotalRecordCount": 1,
  "RequestId": "318C3754-F6D0-54BB-A55C-23EAA04708B7",
  "Items": [
    {
      "GroupKey": "os.cpu_usage",
      "SortRule": 1,
      "Description": "sys cpu使用率,sys cpu使用量 / cpu总量",
      "Unit": "%",
      "MetricsKey": "os.cpu_usage.sys.avg",
      "GroupKeyType": "CPU使用率",
      "Method": "avg",
      "Dimension": "os",
      "MetricsKeyAlias": "os.cpu_usage.sys"
    }
  ],
  "DBInstanceName": "rm-bp1*****"
}

错误码

HTTP status code错误码错误信息描述
400InvalidInstanceMetricsConfigs.NotFoundThe specified instance has no metrics configs指定的实例没有性能指标配置项
400InvalidDBInstanceEngineType.Formatthe DB instance engine type does not support this operation.DB实例引擎类型不支持此操作。
404InvalidDBInstanceName.NotFoundThe database instance does not exist.数据库实例名称不存在。请确认数据名称是否正确。

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

变更历史

变更时间变更内容概要操作
2022-08-04OpenAPI 错误码发生变更,OpenAPI 入参发生变更,OpenAPI 返回结构发生变更看变更集
变更项变更内容
错误码OpenAPI 错误码发生变更
    删除错误码:400
    删除错误码:404
入参OpenAPI 入参发生变更
    新增入参:ResourceGroupId
出参OpenAPI 返回结构发生变更
阿里云首页 云数据库 RDS 相关技术圈