全部产品
Search
文档中心

云数据库 MongoDB:DescribeDBInstancePerformance - 查询实例性能数据

更新时间:May 23, 2024

查询MongoDB实例性能数据。

调试

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

授权信息

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

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

请求参数

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

实例 ID。

说明 当本参数传入的是分片集群实例 ID 时,还需要传入 NodeId 参数。
dds-bp2635****
NodeIdstring

分片集群实例中 Mongos 节点 ID 或 Shard 节点 ID,可用于查询单个节点的性能情况。

说明 DBInstanceId 参数传入的是分片集群实例 ID 时,本参数才可用。
d-bp2287****
Keystring

性能指标,取值详情请参见性能参数表

说明 如需传入多个指标请用英文逗号(,)分隔。
CpuUsage
StartTimestring

查询开始时间,格式为yyyy-MM-ddTHH:mmZ(UTC 时间)。

2022-06-13T10:58Z
EndTimestring

查询结束时间,必须晚于查询开始时间,格式为yyyy-MM-ddTHH:mmZ(UTC 时间)。

2022-06-13T11:58Z
RoleIdstring

单节点实例或副本集实例的节点角色 ID。您可以通过调用 DescribeReplicaSetRole 接口查询。

说明 DBInstanceId 参数传入的是单节点实例 ID 或副本集实例 ID 时,本参数才可用。
6025****
ReplicaSetRolestring

单节点实例或副本集实例的节点角色,取值说明:

  • Primary:主节点。
  • Secondary:从节点。
说明
  • DBInstanceId 参数传入的是单节点实例 ID 或副本集实例 ID 时,本参数才可用。
  • DBInstanceId 参数传入的是单节点实例时,本参数的取值仅支持 Primary
  • Primary

    返回参数

    名称类型描述示例值
    object
    PerformanceKeysobject []

    性能指标信息列表。

    Keystring

    性能指标。

    CpuUsage
    Unitstring

    性能指标的单位。

    %
    ValueFormatstring

    性能指标值的格式。如果该性能指标包含多个字段,通常以&分隔。

    例如查询磁盘空间使用量,返回的 ValueFormat 即为ins_size&data_size&log_size

    cpu_usage
    PerformanceValuesobject []

    性能指标值列表。

    Valuestring

    性能指标值。

    0.23
    Datestring

    性能指标值产生的日期。

    2022-06-13T10:58:00Z
    EndTimestring

    查询结束时间,格式为yyyy-MM-ddTHH:mmZ(UTC 时间)。

    2022-06-13T11:58Z
    RequestIdstring

    请求 ID。

    4A300BC7-6D8F-527F-A2DB-A7768D26E9AC
    StartTimestring

    查询开始时间,格式为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错误码错误信息描述
    400InvalidPerformanceKey.MalformedThe specified parameter Key is not valid.-
    400InvalidStartTime.MalformedThe specified parameter StartTime is not valid.-
    400InvalidEndTime.MalformedThe specified parameter EndTime is not valid.-
    400InvalidStartTimeAndEndTime.MalformedThe end time must be greater than the start time结束时间不能小于开始时间

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

    变更历史

    变更时间变更内容概要操作
    2024-05-23OpenAPI 错误码发生变更、OpenAPI 入参发生变更看变更集
    变更项变更内容
    错误码OpenAPI 错误码发生变更
      删除错误码:400
    入参OpenAPI 入参发生变更
      新增入参:Interval