查詢指定 OceanBase 租戶指標信息。
調試
您可以在OpenAPI Explorer中直接運行該接口，免去您計算簽名的困擾。運行成功后，OpenAPI Explorer可以自動生成SDK代碼示例。
授權信息
下表是API對應的授權信息，可以在RAM權限策略語句的Action元素中使用，用來給RAM用戶或RAM角色授予調用此API的權限。具體說明如下：
- 操作：是指具體的權限點。
- 訪問級別：是指每個操作的訪問級別，取值為寫入（Write）、讀取（Read）或列出（List）。
- 資源類型：是指操作中支持授權的資源類型。具體說明如下：
- 對于必選的資源類型，用背景高亮的方式表示。
- 對于不支持資源級授權的操作，用
全部資源表示。
- 條件關鍵字：是指云產品自身定義的條件關鍵字。
- 關聯操作：是指成功執行操作所需要的其他權限。操作者必須同時具備關聯操作的權限，操作才能成功。
| 操作 | 訪問級別 | 資源類型 | 條件關鍵字 | 關聯操作 |
|---|---|---|---|---|
| oceanbase:DescribeTenantMetrics | get | *全部資源 * |
| 無 |
請求參數
| 名稱 | 類型 | 必填 | 描述 | 示例值 |
|---|---|---|---|---|
| InstanceId | string | 是 | OceanBase 集群 ID。 | ob317v4uif**** |
| PageSize | integer | 否 | 分頁查詢時設置的每頁行數。
| 10 |
| PageNumber | integer | 否 | 分頁查詢的頁碼。
| 1 |
TenantNamedeprecated | string | 否 | 租戶名稱。 長度為 2~20 個字符，支持英文字母、數字和下劃線，區分大小寫，必須以字母或下劃線開頭。 不可設置為 sys。 說明
該參數后期會廢棄，建議使用 TenantIdList。 | pay_online |
| StartTime | string | 是 | 監控數據的起始時間。 | 2021-06-13T15:40:43Z |
| EndTime | string | 是 | 監控數據的結束時間。 | 2021-06-13T15:45:43Z |
| Metrics | string | 是 | 監控指標項。 | tps |
TenantIddeprecated | string | 否 | 租戶 ID。 說明
該參數后期會廢棄，建議使用 TenantIdList。 | tfafd34fs**** |
| TenantIdList | string | 否 | 租戶 ID 列表。 | [tdak3nac****,tdakc42df****] |
返回參數
示例
正常返回示例
JSON格式
{
"TotalCount": 9,
"RequestId": "EE205C00-30E4-****-****-87E3A8A2AA0C",
"TenantMetrics": "\"Metrics\":[ {\"request_queue_rt\":0.0,\"TimeStamp\":\"2022-02-23T01:58:00Z\"}]"
}錯誤碼
訪問錯誤中心查看更多錯誤碼。
變更歷史
| 變更時間 | 變更內容概要 | 操作 |
|---|---|---|
| 2024-08-16 | API 內部配置變更，不影響調用 | 查看變更詳情 |
| 2024-08-15 | API 內部配置變更，不影響調用 | 查看變更詳情 |
| 2022-01-17 | API 內部配置變更，不影響調用 | 查看變更詳情 |
| 2022-01-17 | OpenAPI 入參發生變更、OpenAPI 返回結構發生變更 | 查看變更詳情 |