DescribeTenantMetrics - ApsaraDB for OceanBase - Alibaba Cloud Documentation Center

You can call this operation to query the metrics of a specified OceanBase Database tenant.

Debugging

You can run this interface directly in OpenAPI Explorer, saving you the trouble of calculating signatures. After running successfully, OpenAPI Explorer can automatically generate SDK code samples.

Debug

Authorization information

There is currently no authorization information disclosed in the API.

Request parameters

Parameter	Type	Required	Description	Example
InstanceId	string	Yes	2021-06-13T15:40:43Z	ob317v4uif****
PageSize	integer	No	tfafd34fs****	10
PageNumber	integer	No	The ID of the OceanBase cluster.	1
TenantName`deprecated`	string	No	2021-06-13T15:45:43Z	pay_online
StartTime	string	Yes	Example 1	2021-06-13T15:40:43Z
EndTime	string	Yes		2021-06-13T15:45:43Z
Metrics	string	Yes	{"name":"DescribeTenantMetrics","product":"OceanBasePro","version":"2019-09-01","path":"/","deprecated":0,"method":"POST\|GET","protocol":"HTTP\|HTTPS","hidden":0,"timeout":10000,"parameter_type":"Single","params":"[{"name":"Action","position":"Query","required":true,"checkBlank":false,"visibility":"Public","deprecated":false,"type":"String","description":"","example":"DescribeTenantMetrics"},{"name":"InstanceId","position":"Body","required":true,"checkBlank":false,"visibility":"Public","deprecated":false,"type":"String","title":"","description":"","example":"ob317v4uif**"},{"name":"PageSize","position":"Body","required":false,"checkBlank":false,"visibility":"Public","deprecated":false,"type":"Integer","title":"","description":"","example":"10"},{"name":"PageNumber","position":"Body","required":false,"checkBlank":false,"visibility":"Public","deprecated":false,"type":"Integer","title":"","description":"","example":"1"},{"name":"TenantName","position":"Body","required":false,"checkBlank":false,"visibility":"Public","deprecated":true,"type":"String","title":"","description":"","example":"pay_online"},{"name":"StartTime","position":"Body","required":true,"checkBlank":false,"visibility":"Public","deprecated":false,"type":"String","title":"","description":"","example":"2021-06-13T15:40:43Z"},{"name":"EndTime","position":"Body","required":true,"checkBlank":false,"visibility":"Public","deprecated":false,"type":"String","title":"","description":"","example":"2021-06-13T15:45:43Z"},{"name":"Metrics","position":"Body","required":true,"checkBlank":false,"visibility":"Public","deprecated":false,"type":"String","title":"","description":"","example":"tps"},{"name":"TenantId","position":"Body","required":false,"checkBlank":false,"visibility":"Public","deprecated":true,"type":"String","title":"","description":"","example":"tfafd34fs"},{"name":"TenantIdList","position":"Body","required":false,"checkBlank":false,"visibility":"Public","deprecated":false,"type":"String","title":"","description":"","example":"[tdak3nac,tdakc42df**]"}]","response_headers":"[]","response":"{"type":"Object","children":[{"name":"TotalCount","required":false,"checkBlank":false,"visibility":"Public","deprecated":false,"type":"Integer","title":"","description":"","example":"9"},{"name":"RequestId","required":false,"checkBlank":false,"visibility":"Public","deprecated":false,"type":"String","title":"","description":"","example":"EE205C00-30E4-XXXX-XXXX-87E3A8A2AA0C"},{"name":"TenantMetrics","required":false,"checkBlank":false,"visibility":"Public","deprecated":false,"type":"String","title":"","description":"","example":"\"Metrics\":[ {\"request_queue_rt\":0.0,\"TimeStamp\":\"2022-02-23T01:58:00Z\"}]"}],"title":"","description":""}","errors":"{}"}	tps

Response parameters

Parameter	Type	Description	Example

The current API has no return parameters

Examples

Sample success responses

JSONformat

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

Error codes

For a list of error codes, visit the Service error codes.

Change history

Change time	Summary of changes	Operation
2024-08-16	The internal configuration of the API is changed, but the call is not affected	View Change Details
2024-08-15	The internal configuration of the API is changed, but the call is not affected	View Change Details
2022-01-17	The internal configuration of the API is changed, but the call is not affected	View Change Details
2022-01-17	The request parameters of the API has changed. The response structure of the API has changed	View Change Details