全部產品
Search

搜尋本產品

    ：DescribeDBInstancePerformance - 查詢執行個體效能資料

    文件中心

    ：DescribeDBInstancePerformance - 查詢執行個體效能資料

    更新時間：Dec 16, 2025

    查詢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
    SearchId

    string

    否

    Search-節點 ID。

    說明

    • 當執行個體開通 Search 功能後，本參數才可用。

    dds-2zec12675c9e****-search

    返回參數

    名稱

    類型

    描述

    樣本值

    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 結束時間不能小於開始時間

    訪問錯誤中心查看更多錯誤碼。

    變更歷史

    更多資訊，參考變更詳情。