DescribeDBInstancePerformance - ApsaraDB for MongoDB - Centro de documentación de Alibaba Cloud

Consulta los datos de rendimiento de una instancia de MongoDB.

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

dds:DescribeDBInstancePerformance

get

*dbinstance

acs:dds:{#regionId}:{#accountId}:dbinstance/{#dbinstanceId}

dds:ResourceTag

Ninguna

Parámetros de la solicitud

Parámetro	Tipo	Obligatorio	Descripción	Ejemplo
DBInstanceId	string	Sí	El ID de la instancia. Nota NodeId es obligatorio cuando se especifica el ID de una instancia de clúster fragmentado.	dds-bp2635****
NodeId	string	No	El ID de un nodo mongos o shard en la instancia de clúster fragmentado. Este parámetro permite consultar el rendimiento de un solo nodo. Nota Disponible únicamente cuando DBInstanceId se establece en el ID de una instancia de clúster fragmentado.	d-bp2287****
Key	string	Sí	Las métricas de rendimiento. Para obtener más información, consulte Métricas. Nota Para especificar varias métricas, sepárelas con comas (,).	CpuUsage
StartTime	string	Sí	El inicio del intervalo de tiempo a consultar. Especifique la hora en formato yyyy-MM-ddTHH:mmZ. La hora debe estar en UTC.	2022-06-13T10:58Z
EndTime	string	Sí	El final del intervalo de tiempo a consultar. La hora de finalización debe ser posterior a la hora de inicio. Especifique la hora en formato yyyy-MM-ddTHH:mmZ. La hora debe estar en UTC.	2022-06-13T11:58Z
RoleId	string	No	El ID de rol de un nodo en una instancia independiente o de conjunto de réplicas. Para consultar el ID de rol, llame a la operación DescribeReplicaSetRole. Nota Disponible únicamente cuando DBInstanceId se establece en el ID de una instancia independiente o de conjunto de réplicas.	6025****
Interval	string	No	La granularidad de datos de las métricas de rendimiento en segundos. Valores válidos: 5, 30, 60, 600, 1800, 3600 y 86400.	60
ReplicaSetRole	string	No	El rol de un nodo en una instancia independiente o de conjunto de réplicas. Valores válidos: Primary: El nodo primario. Secondary: Un nodo secundario. Nota Disponible únicamente cuando DBInstanceId se establece en el ID de una instancia independiente o de conjunto de réplicas. Si DBInstanceId se establece en el ID de una instancia independiente, este parámetro solo admite el valor Primary.	Primary
SearchId	string	No	El ID del nodo Search. Nota Disponible únicamente después de habilitar la función Search para la instancia.	dds-2zec12675c9e****-search

Elementos de la respuesta

Elemento	Tipo	Descripción	Ejemplo
	object
PerformanceKeys	object
PerformanceKey	array<object>	La lista de métricas de rendimiento.
	array<object>
Key	string	La métrica de rendimiento.	CpuUsage
Unit	string	La unidad de la métrica de rendimiento.	%
ValueFormat	string	El formato de los valores de la métrica de rendimiento. Si una métrica de rendimiento contiene varios campos, estos se separan con caracteres et (&). Por ejemplo, si consulta el uso de espacio en disco, el valor de ValueFormat devuelto es ins_size&data_size&log_size.	cpu_usage
PerformanceValues	object
PerformanceValue	array<object>	La lista de valores de la métrica de rendimiento.
	object
Value	string	El valor de la métrica de rendimiento.	0.23
Date	string	La hora en que se generó el valor de la métrica de rendimiento.	2022-06-13T10:58:00Z
EndTime	string	El final del intervalo de tiempo a consultar. La hora tiene el formato yyyy-MM-ddTHH:mmZ. La hora se muestra en UTC.	2022-06-13T11:58Z
RequestId	string	El ID de la solicitud.	4A300BC7-6D8F-527F-A2DB-A7768D26E9AC
StartTime	string	El inicio del intervalo de tiempo a consultar. La hora tiene el formato yyyy-MM-ddTHH:mmZ. La hora se muestra en UTC.	2022-06-13T10:58Z

Ejemplos

Respuesta exitosa

JSON Formato

{
  "PerformanceKeys": {
    "PerformanceKey": [
      {
        "Key": "CpuUsage",
        "Unit": "%",
        "ValueFormat": "cpu_usage",
        "PerformanceValues": {
          "PerformanceValue": [
            {
              "Value": "0.23",
              "Date": "2022-06-13T10:58:00Z"
            }
          ]
        }
      }
    ]
  },
  "EndTime": "2022-06-13T11:58Z",
  "RequestId": "4A300BC7-6D8F-527F-A2DB-A7768D26E9AC",
  "StartTime": "2022-06-13T10:58Z"
}

Códigos de error

Código de estado HTTP	Código de error	Mensaje de error	Descripción
400	InvalidPerformanceKey.Malformed	The specified parameter Key is not valid.
400	InvalidStartTime.Malformed	The specified parameter StartTime is not valid.
400	InvalidEndTime.Malformed	The specified parameter EndTime is not valid.
400	InvalidStartTimeAndEndTime.Malformed	The end time must be greater than the start time	The end time cannot be earlier than the start time.

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.