首页 云数据库 RDS API参考 API目录 数据库 DescribeDBInstancesByPerformance - 按性能获取数据库实例

DescribeDBInstancesByPerformance - 按性能获取数据库实例

调用DescribeDBInstancesByPerformance接口查询实例性能。

接口说明

本接口已下线,请勿使用。

调试

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

调试

授权信息

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

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

请求参数

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

用于保证请求的幂等性,防止重复提交请求。由客户端生成该参数值,要保证在不同请求间唯一,最大值不超过64个ASCII字符,且该参数值中不能包含非ASCII字符。

ETnLKlblzczshOTUbOCzxxxxxx
proxyIdstring

代理模式ID。

API
DBInstanceIdstring

实例ID。

rm-uf6wjk5xxxxxx
PageSizeinteger

每页记录数,取值:5~100

默认值:30

30
PageNumberinteger

页码,取值:大于0且不超过Integer的最大值。

默认值:1

1
SortMethodstring

分类方法。

ASC
SortKeystring

排序依据。

CPU_Usage
Tagsstring

查询绑定有该标签的实例,包括TagKey和TagValue。格式:{"key1":"value1"}

{"key1":"value1"}
Tag.1.keystring

查询绑定有该标签Tag.1.key的实例。

key1
Tag.2.keystring

查询绑定有该标签Tag.2.key的实例。

key2
Tag.3.keystring

查询绑定有该标签Tag.3.key的实例。

key3
Tag.4.keystring

查询绑定有该标签Tag.4.key的实例。

key4
Tag.5.keystring

查询绑定有该标签Tag.5.key的实例。

key5
Tag.1.valuestring

查询绑定有该标签Tag.1.value的实例。

value1
Tag.2.valuestring

查询绑定有该标签Tag.2.value的实例。

value2
Tag.3.valuestring

查询绑定有该标签Tag.3.value的实例。

value3
Tag.4.valuestring

查询绑定有该标签Tag.4.value的实例。

value4
Tag.5.valuestring

查询绑定有该标签Tag.5.value的实例。

value5
RegionIdstring

地域ID,您可以通过DescribeRegions接口查询。

cn-hangzhou
ResourceGroupIdstring

资源组ID。

rg-acfmy*****

返回参数

名称类型描述示例值
object

返回参数详情如下。

RequestIdstring

请求ID。

23907437-79B9-411A-9EE6-75A8F0F1C619
PageNumberinteger

页码。

1
PageRecordCountinteger

当前页实例个数。

28
TotalRecordCountinteger

查询出的总实例数量。

28
Itemsobject []

返回信息列表。

CPUUsagestring

实例的当前CPU使用率。单位:%。

0.70
SessionUsagestring

会话连接数。

0.10
DBInstanceIdstring

实例ID。

rm-uf6wjk5xxxxxx
DBInstanceDescriptionstring

实例的名称。

DatabaseTest
IOPSUsagestring

实例的当前IOPS使用量。单位:%。

0.15
DiskUsagestring

实例的当前磁盘使用率。单位:%。

14.56

示例

正常返回示例

JSON格式

{
  "RequestId": "23907437-79B9-411A-9EE6-75A8F0F1C619",
  "PageNumber": 1,
  "PageRecordCount": 28,
  "TotalRecordCount": 28,
  "Items": {
    "DBInstancePerformance": [
      {
        "CPUUsage": "0.70",
        "SessionUsage": "0.10",
        "DBInstanceId": "rm-uf6wjk5xxxxxx",
        "DBInstanceDescription": "DatabaseTest",
        "IOPSUsage": "0.15",
        "DiskUsage": "14.56"
      }
    ]
  }
}

错误码

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

阿里云首页 关系型数据库 相关技术圈