DescribeElasticPlan - - Centro de documentación de Alibaba Cloud

Consulta los planes de escalado de un clúster de AnalyticDB for MySQL. Esta operación solo se puede utilizar para clústeres de AnalyticDB for MySQL en modo elástico de la edición Cluster.

Descripción de la operación

Solo puede invocar esta operación para clústeres de AnalyticDB for MySQL Data Warehouse Edition (V3.0) en modo elástico de la edición Cluster que tengan 32 núcleos o más.

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

adb:DescribeElasticPlan

get

DBCluster

acs:adb:{#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 de AnalyticDB for MySQL Data Warehouse Edition (V3.0). Nota Puede invocar la operación DescribeDBClusters para consultar los ID de todos los clústeres de AnalyticDB for MySQL Data Warehouse Edition (V3.0) dentro de una región.	am-bp278jg9****
ElasticPlanName	string	No	El nombre del plan de escalado. El nombre debe tener entre 2 y 30 caracteres de longitud. El nombre puede contener letras, dígitos y guiones bajos (_). Nota Si no especifica este parámetro, se devuelve la información de todos los planes de escalado del clúster especificado.	realtime
ResourcePoolName	string	No	El nombre del grupo de recursos. Nota Puede invocar la operación DescribeDBResourceGroup para consultar el nombre del grupo de recursos.	USER_DEFAULT
ElasticPlanEnable	boolean	No	Especifica si el plan de escalado surte efecto. Valores válidos: true (predeterminado) false	true

Elementos de la respuesta

Elemento	Tipo	Descripción	Ejemplo
	object
RequestId	string	El ID de la solicitud.	1AD222E9-E606-4A42-BF6D-8A4442913CEF
ElasticPlanList	array<object>	Los planes de escalado consultados.
	object
EndTime	string	La hora de restauración del plan de escalado. El intervalo entre la hora de escalado ascendente y la hora de restauración no puede superar las 24 horas. La hora tiene el formato HH:mm:ss.	10:00:00
WeeklyRepeat	string	Los días de la semana en que se ejecutó el plan de escalado. Valores válidos: 0 a 6, que indican de domingo a sábado. Los valores múltiples se separan con comas (,).	3,4,5,6
MonthlyRepeat	string	Los días del mes en que se ejecutó el plan de escalado. Un valor indica un día del mes. Los valores múltiples se separan con comas (,).	1,15,25
StartTime	string	La hora de escalado ascendente del plan de escalado. La hora tiene el formato HH:mm:ss.	08:00:00
ResourcePoolName	string	El nombre del grupo de recursos.	USER_DEFAULT
StartDay	string	La fecha de inicio del plan de escalado. Este parámetro se devuelve solo si se establece la fecha de inicio del plan de escalado. La fecha tiene el formato yyyy-MM-dd.	2022-12-02
ElasticNodeNum	integer	El número de nodos que participan en el plan de escalado. Si ElasticPlanType se establece en worker, se devuelve un valor de 0 o null. Si ElasticPlanType se establece en executorcombineworker o executor, se devuelve un valor mayor que 0.	0
Enable	boolean	Indica si el plan de escalado surte efecto. Valores válidos: true (predeterminado) false	true
EndDay	string	La fecha de finalización del plan de escalado. Este parámetro se devuelve solo si se establece la fecha de finalización del plan de escalado. La fecha tiene el formato yyyy-MM-dd.	2022-12-09
PlanName	string	El nombre del plan de escalado.	realtime
ElasticPlanType	string	El tipo de plan de escalado. Valores válidos: worker: escala solo recursos de E/S elásticos. executor: escala solo recursos de computación. executorcombineworker (predeterminado): escala tanto recursos de E/S elásticos como recursos de computación de forma proporcional.	worker
ElasticPlanWorkerSpec	string	Las especificaciones de recursos que el plan de escalado puede aumentar. Valores válidos: 8 Core 64 GB (predeterminado) 16 Core 64 GB 32 Core 64 GB 64 Core 128 GB 12 Core 96 GB 24 Core 96 GB 52 Core 86 GB	16 Core 64 GB

Ejemplos

Respuesta exitosa

JSON Formato

{
  "RequestId": "1AD222E9-E606-4A42-BF6D-8A4442913CEF",
  "ElasticPlanList": [
    {
      "EndTime": "10:00:00",
      "WeeklyRepeat": "3,4,5,6",
      "MonthlyRepeat": "1,15,25",
      "StartTime": "08:00:00",
      "ResourcePoolName": "USER_DEFAULT",
      "StartDay": "2022-12-02",
      "ElasticNodeNum": 0,
      "Enable": true,
      "EndDay": "2022-12-09",
      "PlanName": "realtime",
      "ElasticPlanType": "worker",
      "ElasticPlanWorkerSpec": "16 Core 64 GB"
    }
  ]
}

Códigos de error

Código de estado HTTP	Código de error	Mensaje de error	Descripción
404	InvalidDBCluster.NotFound	The DBClusterId provided does not exist in our records.	The specified DBClusterId parameter does not exist. Make sure that the DBClusterId value is valid.

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.