DescribeTenantMetrics - 查詢租戶指標資訊 - ApsaraDB for OceanBase (Deprecated)

查詢指定 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	否	分頁查詢時設定的每頁行數。最大值：100。預設值：10。	10
PageNumber	integer	否	分頁查詢的頁碼。起始值：1。預設值：1。	1
TenantName `deprecated`	string	否	租戶名稱。長度為 2~20 個字元，支援英文字母、數字和底線，區分大小寫，必須以字母或底線開頭。不可設定為 sys。說明該參數後期會廢棄，建議使用 TenantIdList。	pay_online
StartTime	string	是	監控資料的起始時間。該時間只支援 UTC 時間，格式為：YYYY-MM-DDThh:mm:ssZ。	2021-06-13T15:40:43Z
EndTime	string	是	監控資料的結束時間。該時間只支援 UTC 時間，格式為：YYYY-MM-DDThh:mm:ssZ。	2021-06-13T15:45:43Z
Metrics	string	是	監控指標項。當前可支援的指標及說明請參考租戶監控資料詳情。	tps
TenantId `deprecated`	string	否	租戶 ID。說明該參數後期會廢棄，建議使用 TenantIdList。	tfafd34fs****
TenantIdList	string	否	租戶 ID 列表。	[tdak3nac**,tdakc42df**]

返回參數

名稱	類型	描述	樣本值
	object	請求的返回結果
TotalCount	integer	總數量。	9
RequestId	string	請求 ID。	EE205C00-30E4-**-**-87E3A8A2AA0C
TenantMetrics	string	租戶指標資訊。	"Metrics":[ {"request_queue_rt":0.0,"TimeStamp":"2022-02-23T01:58:00Z"}]

樣本

正常返回樣本

JSON格式

{
  "TotalCount": 9,
  "RequestId": "EE205C00-30E4-****-****-87E3A8A2AA0C",
  "TenantMetrics": "\"Metrics\":[ {\"request_queue_rt\":0.0,\"TimeStamp\":\"2022-02-23T01:58:00Z\"}]"
}

錯誤碼

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

變更歷史

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