查詢MongoDB實(shí)例性能數(shù)據(jù)。
調(diào)試
您可以在OpenAPI Explorer中直接運(yùn)行該接口，免去您計(jì)算簽名的困擾。運(yùn)行成功后，OpenAPI Explorer可以自動生成SDK代碼示例。
授權(quán)信息
下表是API對應(yīng)的授權(quán)信息，可以在RAM權(quán)限策略語句的Action元素中使用，用來給RAM用戶或RAM角色授予調(diào)用此API的權(quán)限。具體說明如下：
- 操作：是指具體的權(quán)限點(diǎn)。
- 訪問級別：是指每個(gè)操作的訪問級別，取值為寫入（Write）、讀取（Read）或列出（List）。
- 資源類型：是指操作中支持授權(quán)的資源類型。具體說明如下：
- 對于必選的資源類型，用背景高亮的方式表示。
- 對于不支持資源級授權(quán)的操作，用
全部資源表示。
- 條件關(guān)鍵字：是指云產(chǎn)品自身定義的條件關(guān)鍵字。
- 關(guān)聯(lián)操作：是指成功執(zhí)行操作所需要的其他權(quán)限。操作者必須同時(shí)具備關(guān)聯(lián)操作的權(quán)限，操作才能成功。
| 操作 | 訪問級別 | 資源類型 | 條件關(guān)鍵字 | 關(guān)聯(lián)操作 |
|---|---|---|---|---|
| dds:DescribeDBInstancePerformance | get |
|
| 無 |
請求參數(shù)
| 名稱 | 類型 | 必填 | 描述 | 示例值 |
|---|---|---|---|---|
| DBInstanceId | string | 是 | 實(shí)例 ID。 說明
當(dāng)本參數(shù)傳入的是分片集群實(shí)例 ID 時(shí)，還需要傳入 NodeId 參數(shù)。
| dds-bp2635**** |
| NodeId | string | 否 | 分片集群實(shí)例中 Mongos 節(jié)點(diǎn) ID 或 Shard 節(jié)點(diǎn) ID，可用于查詢單個(gè)節(jié)點(diǎn)的性能情況。 說明
當(dāng) DBInstanceId 參數(shù)傳入的是分片集群實(shí)例 ID 時(shí)，本參數(shù)才可用。
| d-bp2287**** |
| Key | string | 是 | 性能指標(biāo)，取值詳情請參見監(jiān)控項(xiàng)說明。 說明
如需傳入多個(gè)指標(biāo)請用英文逗號（,）分隔。
| CpuUsage |
| StartTime | string | 是 | 查詢開始時(shí)間，格式為yyyy-MM-ddTHH:mmZ（UTC 時(shí)間）。 | 2022-06-13T10:58Z |
| EndTime | string | 是 | 查詢結(jié)束時(shí)間，必須晚于查詢開始時(shí)間，格式為yyyy-MM-ddTHH:mmZ（UTC 時(shí)間）。 | 2022-06-13T11:58Z |
| RoleId | string | 否 | 單節(jié)點(diǎn)實(shí)例或副本集實(shí)例的節(jié)點(diǎn)角色 ID。您可以通過調(diào)用 DescribeReplicaSetRole 接口查詢。 說明
當(dāng) DBInstanceId 參數(shù)傳入的是單節(jié)點(diǎn)實(shí)例 ID 或副本集實(shí)例 ID 時(shí)，本參數(shù)才可用。
| 6025**** |
| Interval | string | 否 | 性能數(shù)據(jù)粒度(5,30,60,600,1800,3600,86400) | 60 |
| ReplicaSetRole | string | 否 | 單節(jié)點(diǎn)實(shí)例或副本集實(shí)例的節(jié)點(diǎn)角色，取值說明：
說明
| Primary |
返回參數(shù)
示例
正常返回示例
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"
}錯(cuò)誤碼
| HTTP status code | 錯(cuò)誤碼 | 錯(cuò)誤信息 | 描述 |
|---|---|---|---|
| 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 | 結(jié)束時(shí)間不能小于開始時(shí)間 |
訪問錯(cuò)誤中心查看更多錯(cuò)誤碼。
變更歷史
| 變更時(shí)間 | 變更內(nèi)容概要 | 操作 |
|---|---|---|
| 2024-05-23 | OpenAPI 錯(cuò)誤碼發(fā)生變更、OpenAPI 入?yún)l(fā)生變更 | 查看變更詳情 |