调用DescribeDBInstancePerformance API查询MongoDB实例性能数据-云数据库 MongoDB 版-阿里云

查询MongoDB实例性能数据。

调试

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

调试

授权信息

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

操作：是指具体的权限点。
访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。
资源类型：是指操作中支持授权的资源类型。具体说明如下：
- 对于必选的资源类型，用前面加 * 表示。
- 对于不支持资源级授权的操作，用全部资源表示。
条件关键字：是指云产品自身定义的条件关键字。
关联操作：是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限，操作才能成功。

操作

访问级别

资源类型

条件关键字

关联操作

dds:DescribeDBInstancePerformance

get

*dbinstance

acs:dds:{#regionId}:{#accountId}:dbinstance/{#dbinstanceId}

dds:ResourceTag

无

请求参数

名称	类型	必填	描述	示例值
DBInstanceId	string	是	实例 ID。说明当本参数传入的是分片集群实例 ID 时，还需要传入 NodeId 参数。	dds-bp2635****
NodeId	string	否	分片集群实例中 Mongos 节点 ID 或 Shard 节点 ID，可用于查询单个节点的性能情况。说明当 DBInstanceId 参数传入的是分片集群实例 ID 时，本参数才可用。	d-bp2287****
Key	string	是	性能指标，取值详情请参见监控项说明。说明如需传入多个指标请用英文逗号（,）分隔。	CpuUsage
StartTime	string	是	查询开始时间，格式为yyyy-MM-ddTHH:mmZ（UTC 时间）。	2022-06-13T10:58Z
EndTime	string	是	查询结束时间，必须晚于查询开始时间，格式为yyyy-MM-ddTHH:mmZ（UTC 时间）。	2022-06-13T11:58Z
RoleId	string	否	单节点实例或副本集实例的节点角色 ID。您可以通过调用 DescribeReplicaSetRole 接口查询。说明当 DBInstanceId 参数传入的是单节点实例 ID 或副本集实例 ID 时，本参数才可用。	6025****
Interval	string	否	性能数据粒度(5,30,60,600,1800,3600,86400)	60
ReplicaSetRole	string	否	单节点实例或副本集实例的节点角色，取值说明： Primary：主节点。 Secondary：从节点。说明当 DBInstanceId 参数传入的是单节点实例 ID 或副本集实例 ID 时，本参数才可用。当 DBInstanceId 参数传入的是单节点实例时，本参数的取值仅支持 Primary。	Primary

返回参数

名称	类型	描述	示例值
	object
PerformanceKeys	object
PerformanceKey	array<object>	性能指标信息列表。
	array<object>
Key	string	性能指标。	CpuUsage
Unit	string	性能指标的单位。	%
ValueFormat	string	性能指标值的格式。如果该性能指标包含多个字段，通常以&分隔。例如查询磁盘空间使用量，返回的 ValueFormat 即为ins_size&data_size&log_size。	cpu_usage
PerformanceValues	object
PerformanceValue	array<object>	性能指标值列表。
	object
Value	string	性能指标值。	0.23
Date	string	性能指标值产生的日期。	2022-06-13T10:58:00Z
EndTime	string	查询结束时间，格式为yyyy-MM-ddTHH:mmZ（UTC 时间）。	2022-06-13T11:58Z
RequestId	string	请求 ID。	4A300BC7-6D8F-527F-A2DB-A7768D26E9AC
StartTime	string	查询开始时间，格式为yyyy-MM-ddTHH:mmZ（UTC 时间）。	2022-06-13T10:58Z

示例

正常返回示例

JSON格式

{
  "PerformanceKeys": {
    "PerformanceKey": [
      {
        "Key": "CpuUsage",
        "Unit": "%",
        "ValueFormat": "cpu_usage",
        "PerformanceValues": {
          "PerformanceValue": [
            {
              "Value": "0.23",
              "Date": "2022-06-13T10:58:00Z"
            }
          ]
        }
      }
    ]
  },
  "EndTime": "2022-06-13T11:58Z",
  "RequestId": "4A300BC7-6D8F-527F-A2DB-A7768D26E9AC",
  "StartTime": "2022-06-13T10:58Z"
}

错误码

HTTP status code	错误码	错误信息	描述
400	InvalidPerformanceKey.Malformed	The specified parameter Key is not valid.
400	InvalidStartTime.Malformed	The specified parameter StartTime is not valid.
400	InvalidEndTime.Malformed	The specified parameter EndTime is not valid.
400	InvalidStartTimeAndEndTime.Malformed	The end time must be greater than the start time	结束时间不能小于开始时间

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

变更历史

更多信息，参考变更详情。