DescribeTenantMetrics - ApsaraDB for OceanBase (Deprecated) - Centro de documentación de Alibaba Cloud

Las métricas de monitoreo. Para obtener más información sobre las métricas admitidas, consulte [Ver estadísticas del inquilino](~~212125~~).

Pruébelo ahora

Pruebe esta API en OpenAPI Explorer sin necesidad de firma manual. Las llamadas exitosas generan automáticamente código SDK acorde a sus parámetros. Descárguelo con seguridad de credenciales integrada para uso local.

Test

Autorización de RAM

La siguiente tabla describe la autorización necesaria para invocar esta API. Puede definirla en una directiva de Resource Access Management (RAM). A continuación, se detallan las columnas de la tabla:

Action: Estas acciones se utilizan en el elemento Action de las declaraciones de directivas de permisos de RAM para otorgar permisos que permitan realizar la operación.
API: La API que debe invocarse para llevar a cabo la acción.
Nivel de acceso: Nivel de acceso predefinido que se concede para cada API. Valores válidos: create, list, get, update y delete.
Tipo de recurso: Tipo de recurso que admite autorización para ejecutar la acción. Indica si la acción es compatible con permisos a nivel de recurso. El recurso especificado debe ser compatible con la acción; de lo contrario, la directiva no surtirá efecto.
- En las API con permisos a nivel de recurso, los tipos de recursos obligatorios se marcan con un asterisco (*). Especifique el Alibaba Cloud Resource Name (ARN) correspondiente en el elemento Resource de la directiva.
- Para las API sin permisos a nivel de recurso, se muestra All Resources. Utilice un asterisco (*) en el elemento Resource de la directiva.
Clave de condición: Claves de condición definidas por el servicio. Permiten un control granular y se aplican ya sea solo a acciones o a acciones asociadas con recursos específicos. Además de las claves de condición específicas del servicio, Alibaba Cloud proporciona un conjunto de common condition keys aplicables a todos los servicios compatibles con RAM.
Acción dependiente: Acciones dependientes necesarias para ejecutar la acción principal. Para completar la operación, el usuario de RAM o el rol de RAM debe contar con permisos para realizar todas las acciones dependientes.

Action

Nivel de acceso

Tipo de recurso

Clave de condición

Acción dependiente

oceanbase:DescribeTenantMetrics

get

*All Resource

*

Ninguna

Parámetros de la solicitud

Parámetro	Tipo	Obligatorio	Descripción	Ejemplo
InstanceId	string	Sí	2021-06-13T15:40:43Z	ob317v4uif****
PageSize	integer	No	tfafd34fs****	10
PageNumber	integer	No	El ID del clúster de OceanBase.	1
TenantName `deprecated`	string	No	2021-06-13T15:45:43Z	pay_online
StartTime	string	Sí	Ejemplo 1	2021-06-13T15:40:43Z
EndTime	string	Sí	Hora de fin de los datos de monitoreo. Esta hora solo admite UTC, con el formato: AAAA-MM-DDThh:mm:ssZ.	2021-06-13T15:45:43Z
Metrics	string	Sí	{"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
TenantId `deprecated`	string	No	ID del inquilino. Nota Este parámetro quedará obsoleto en el futuro. Se recomienda utilizar TenantIdList en su lugar.	tfafd34fs****
TenantIdList	string	No	Lista de ID de inquilinos.	[tdak3nac**,tdakc42df**]

Elementos de la respuesta

Elemento	Tipo	Descripción	Ejemplo
	object	Resultado devuelto de la solicitud.
TotalCount	integer	Cantidad total.	9
RequestId	string	ID de la solicitud.	EE205C00-30E4-**-**-87E3A8A2AA0C
TenantMetrics	string	Información de métricas del inquilino.	"Metrics":[ {"request_queue_rt":0.0,"TimeStamp":"2022-02-23T01:58:00Z"}]

Ejemplos

Respuesta exitosa

JSON Formato

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

Códigos de error

Consulte Códigos de error para ver la lista completa.

Notas de la versión

Consulte Notas de la versión para ver la lista completa.