DescribeDBProxyPerformance - PolarDB - Centro de documentación de Alibaba Cloud

Consulta los datos de rendimiento de PolarProxy.

Descripción de la operación

Nota

Esta operación solo es aplicable a clústeres de PolarDB for MySQL.

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

polardb:DescribeDBProxyPerformance

get

*DBCluster

acs:polardb:{#regionId}:{#accountId}:dbcluster/{#dbclusterId}

Ninguna

Parámetros de la solicitud

Parámetro	Tipo	Obligatorio	Descripción	Ejemplo
DBClusterId	string	Sí	El ID del clúster.	pc-****************
DBEndpointId	string	No	El ID del endpoint.	pe-****************
Interval	string	No	El intervalo en el que se recopilan los datos de rendimiento. Valores válidos: 5, 30, 60, 600, 1800, 3600, 86400, en segundos.	60
Type	string	No	Métrica especial. Establezca el valor en tair, que indica la arquitectura PolarTair.	tair
Key	string	Sí	Las métricas de rendimiento que desea consultar. Separe múltiples indicadores con comas (,). Para obtener más información, consulte Parámetros de rendimiento.	PolarProxy_CpuUsage
StartTime	string	Sí	El inicio del rango de tiempo a consultar. Especifique la hora en formato `yyyy-MM-ddTHH:mmZ`. La hora debe estar en UTC.	2020-09-23T01:01Z
EndTime	string	Sí	El fin del rango de tiempo a consultar. Especifique la hora en formato `yyyy-MM-ddTHH:mmZ`. La hora debe estar en UTC.	2020-09-24T02:08Z
DBNodeId	string	No	El ID del nodo en el clúster. Este parámetro se puede utilizar para consultar las métricas de rendimiento de PolarProxy en diferentes nodos. Se admiten las siguientes métricas: PolarProxy_DBConns, PolarProxy_DBQps y PolarProxy_DBActionOps.	pi-****************

Elementos de la respuesta

Elemento	Tipo	Descripción	Ejemplo
	object
PerformanceKeys	object
PerformanceItem	array<object>	Detalles sobre las métricas de rendimiento.
	array<object>
MetricName	string	El nombre de la métrica de rendimiento.	service_connections_ps
Measurement	string	La métrica de rendimiento.	PolarProxy_CpuUsage
Points	object
PerformanceItemValue	array<object>	La lista de las métricas de rendimiento.
	object
Value	string	El valor de la métrica.	10
Timestamp	integer	La hora en la que se recopiló el valor de la métrica. Este valor es una marca de tiempo en milisegundos.	1600822800000
DBNodeId	string	El ID del nodo.	pi-*************
DBVersion	string	La versión del motor de base de datos.	8.0
EndTime	string	La hora de finalización de la consulta. La hora tiene el formato `yyyy-MM-ddTHH:mm:ssZ`. La hora se muestra en UTC.	2020-09-23T01:01:00Z
RequestId	string	El ID de la solicitud.	35D3E3DA-4650-407A-BFF5-59BFF1******
StartTime	string	La hora de inicio de la consulta. La hora tiene el formato `yyyy-MM-ddTHH:mm:ssZ`. La hora se muestra en UTC.	2020-09-23T01:00:00Z
DBClusterId	string	El ID del clúster.	pc-*****************
DBType	string	El tipo de motor de base de datos.	MySQL

Ejemplos

Respuesta exitosa

JSON Formato

{
  "PerformanceKeys": {
    "PerformanceItem": [
      {
        "MetricName": "service_connections_ps",
        "Measurement": "PolarProxy_CpuUsage",
        "Points": {
          "PerformanceItemValue": [
            {
              "Value": "10",
              "Timestamp": 1600822800000
            }
          ]
        },
        "DBNodeId": "pi-*************"
      }
    ]
  },
  "DBVersion": "8.0",
  "EndTime": "2020-09-23T01:01:00Z",
  "RequestId": "35D3E3DA-4650-407A-BFF5-59BFF1******",
  "StartTime": "2020-09-23T01:00:00Z",
  "DBClusterId": "pc-*****************",
  "DBType": "MySQL"
}

Códigos de error

Código de estado HTTP	Código de error	Mensaje de error
400	InvalidParameterCombination	The end time must be greater than the start time.
400	InvalidStartTime.Malformed	The specified parameter StartTime is not valid.
400	InvalidEndTime.Malformed	The specified parameter EndTime is not valid.
400	InvalidKey.Malformed	The specified parameter Key is not valid.
404	InvalidDBClusterId.NotFound	The DBClusterId provided does not exist in our records.
404	InvalidDBEndpointId.NotFound	The DBEndpointId provided does not exist in our records.

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.