DescribeDBClusters - - Centro de documentación de Alibaba Cloud

Consulta los clústeres de la edición Data Warehouse.

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:DescribeDBClusters

get

DBCluster.

acs:adb:{#regionId}:{#accountId}:dbcluster/*

Ninguna

Parámetros de la solicitud

Parámetro	Tipo	Obligatorio	Descripción	Ejemplo
RegionId	string	Sí	El ID de la región. Nota Puede llamar a la operación DescribeRegions para consultar los ID de región de las regiones disponibles.	cn-hangzhou
DBClusterIds	string	No	Los ID de los clústeres. Nota Puede ingresar cualquier ID de clúster en la región especificada.	am-bp1r053byu48p****
DBClusterDescription	string	No	La descripción del clúster. No puede comenzar con `http://` ni con `https://`. Debe tener una longitud de 2 a 256 caracteres.	test
DBClusterStatus	string	No	El estado del clúster. Valores válidos: Preparing: en preparación Creating: en creación Restoring: en restauración desde una copia de seguridad Running: en ejecución Deleting: en eliminación ClassChanging: en cambio de especificaciones NetAddressCreating: en creación de dirección de red NetAddressDeleting: en eliminación de dirección de red	Running
PageSize	integer	No	El número de entradas por página. Valores válidos: 30 (valor predeterminado) 50 100	30
PageNumber	integer	No	El número de página. El valor debe ser un número entero positivo que no exceda el valor máximo del tipo de datos Integer. Valor predeterminado: 1.	1
ResourceGroupId	string	No	El ID del grupo de recursos.	rg-4690g37929XXXX
Tag	array<object>	No	La lista de etiquetas.
	object	No	Los detalles de la etiqueta.
Key	string	No	La clave de la etiqueta. Puede filtrar la lista de clústeres por etiqueta. Puede especificar hasta 20 pares clave-valor de etiqueta. El número N en cada par clave-valor de etiqueta debe ser único y debe ser un número entero consecutivo a partir de 1. El valor de Tag.N.Key corresponde al valor de Tag.N.Value. Nota La clave de la etiqueta puede tener hasta 64 caracteres de longitud y no puede comenzar con `aliyun`, `acs:`, `http://` ni `https://`.	tag1
Value	string	No	El valor de la etiqueta. Puede filtrar la lista de clústeres por etiqueta. Puede especificar hasta 20 pares clave-valor de etiqueta. El número N en cada par clave-valor de etiqueta debe ser único y debe ser un número entero consecutivo a partir de 1. El valor de Tag.N.Key corresponde al valor de Tag.N.Value. Nota El valor de la etiqueta puede tener hasta 64 caracteres de longitud y no puede comenzar con `aliyun`, `acs:`, `http://` ni `https://`.	test1
DBVersion	string	No	La versión del clúster. Establezca el valor en 3.0.	3.0
DBClusterVersion	string	No	La edición del clúster. Valores válidos: 3.0: edición Data Warehouse. 5.0 (valor predeterminado): edición Data Lakehouse, edición Enterprise y edición Basic. All: todas las ediciones, incluida la edición Data Warehouse, la edición Data Lakehouse, la edición Enterprise y la edición Basic. Valores válidos: All : Todas las ediciones, incluida la edición Data Warehouse, la edición Data Lakehouse, la edición Enterprise y la edición Basic. 3.0 : Edición Data Warehouse. 5.0 : Edición Data Lakehouse, edición Enterprise y edición Basic.	3.0

Elementos de la respuesta

Elemento	Tipo	Descripción	Ejemplo
	object	Los detalles de la lista.
TotalCount	integer	El número total de registros.	1
PageSize	integer	El número de registros por página.	30
RequestId	string	El ID de la solicitud.	D65A809F-34CE-4550-9BC1-0ED21ETG380
PageNumber	integer	El número de página.	1
Items	object
DBCluster	array<object>	La lista de información de los clústeres.
	array<object>	Los detalles de la etiqueta.
DtsJobId	string	El ID de la tarea de sincronización de Data Transmission Service (DTS). Este parámetro se devuelve solo para instancias analíticas de MySQL.	dtsb1578j90XXXX
DBNodeCount	integer	El número de grupos de nodos.	1
Expired	string	Indica si el clúster ha vencido. Valores válidos: true: El clúster ha vencido. false: El clúster no ha vencido.	false
CreateTime	string	La hora en que se creó el clúster. La hora se muestra en UTC con el formato yyyy-MM-ddTHH:mm:ssZ. Ejemplo: 2021-04-01T09:50:18Z.	2021-04-01T09:50:18Z
PayType	string	El método de facturación del clúster. Valores válidos: Postpaid: pago por uso. Prepaid: suscripción.	Postpaid
DiskType	string	El tipo de disco del clúster. Valores válidos: local_ssd: disco local. cloud: disco básico. cloud_ssd: SSD estándar. cloud_efficiency: disco ultra. cloud_essd0: ESSD PL0. cloud_essd: ESSD PL1. cloud_essd2: ESSD PL2. cloud_essd3: ESSD PL3. Nota Para obtener más información sobre los ESSD, consulte Especificaciones de ESSD.	cloud_essd
Tags	object
Tag	array<object>	La lista de etiquetas.
	object	Los detalles de la etiqueta.
Key	string	La clave de la etiqueta. Nota Puede llamar a la operación TagResources para crear etiquetas para el clúster.	tag1
Value	string	El valor de la etiqueta.	test1
Mode	string	El modo del clúster. Valores válidos: flexible: Modo elástico. reserver: Modo reservado. Nota Para obtener más información sobre los modos de clúster, consulte Ediciones.	flexible
Port	string	El número de puerto del clúster. Valor predeterminado: 3306.	3306
LockMode	string	El modo de bloqueo del clúster. Valores válidos: Unlock: El clúster no está bloqueado. ManualLock: El clúster está bloqueado manualmente. LockByExpiration: El clúster se bloquea automáticamente por vencimiento. LockByRestoration: El clúster se bloquea automáticamente antes de una reversión. LockByDiskQuota: El clúster se bloquea automáticamente porque el espacio de almacenamiento está lleno. Esto ocurre cuando el espacio de almacenamiento utilizado por los datos alcanza el 90 % del límite superior.	Unlock
StorageResource	string	La especificación de recursos de almacenamiento utilizada en el modo elástico para lecturas y escrituras de datos. Aumentar este recurso mejora las capacidades de lectura y escritura del clúster.	8Core32GB
ExecutorCount	string	El número de nodos de computación utilizados por el clúster en modo elástico.	1
DBClusterId	string	El ID del clúster.	am-bp163885f8q21****
ConnectionString	string	El endpoint público del clúster.	am-bp163885f8q21****.ads.aliyuncs.com
RdsInstanceId	string	El ID de la instancia de ApsaraDB RDS de origen para la sincronización. Este parámetro se devuelve solo para instancias analíticas de MySQL.	rm-bp11q28kvl688****
DBClusterType	string	El tipo de clúster. Valores válidos: Common: clúster común. RDS_ANALYSIS: instancia analítica de MySQL.	Common
CommodityCode	string	El código de producto. El valor es fijo: ads.	ads
ExpireTime	string	La hora de vencimiento del clúster. La hora se muestra en UTC con el formato yyyy-MM-ddTHH:mm:ssZ. Ejemplo: 2999-09-08T16:00:00Z. Nota Si el clúster utiliza el método de facturación por suscripción, se devuelve la hora de vencimiento real. Si el clúster utiliza el método de facturación de pago por uso, se devuelve el valor fijo 2999-09-08T16:00:00Z.	2999-09-08T16:00:00Z
DBNodeStorage	integer	El espacio de almacenamiento del clúster. Unidad: GB.	300
DBNodeClass	string	Las especificaciones del nodo.	E8
LockReason	string	El motivo por el que el clúster está bloqueado. Nota Este parámetro se devuelve solo cuando el clúster está bloqueado. El valor es fijo: instance_expire.	instance_expired
VPCId	string	El ID de la nube privada virtual (VPC).	vpc-bp13h7uzhulpuxvnpXXXX
RegionId	string	El ID de la región del clúster.	cn-hangzhou
ComputeResource	string	La especificación de recursos de computación utilizada en el modo elástico para el procesamiento de datos. Aumentar los recursos de computación acelera la velocidad de las consultas. Puede escalar los recursos de computación de forma elástica según los requisitos de rendimiento reales del clúster.	8Core32GB
ElasticIOResource	integer	El recurso de E/S elástico (EIU). Para obtener más información, consulte Descripción general de EIU. Nota Este parámetro se devuelve solo para clústeres en modo elástico.	0
VSwitchId	string	El ID del vSwitch.	vsw-bp1syh8vvw8yech7nXXXX
DBVersion	string	La versión del motor de base de datos. Solo se admite la versión 3.0.	3.0
VPCCloudInstanceId	string	El ID de la instancia conectada a la VPC.	am-bp163885f8q21****-controller
DBClusterStatus	string	El estado del clúster. Para obtener más información, consulte Estado del clúster.	Running
ResourceGroupId	string	El ID del grupo de recursos.	rg-acfmyiu4ekp****
DBClusterNetworkType	string	El tipo de red del clúster. Solo se admite VPC.	vpc
DBClusterDescription	string	La descripción del clúster.	adb_test
ZoneId	string	El ID de la zona del clúster.	cn-hangzhou-h
Category	string	La edición. Valores válidos: BASIC: Edición básica en modo reservado. CLUSTER: Edición de clúster en modo reservado. MIXED_STORAGE: Edición de clúster en modo elástico. Nota Para obtener más información sobre las ediciones, consulte Ediciones.	MIXED_STORAGE
Engine	string	El motor de base de datos del clúster. El valor es fijo: AnalyticDB.	AnalyticDB
InnerIp	string	La dirección IP pública.	10.1.xx.xx
InnerPort	string	El número de puerto.	3306
TaskInfo	object	La información del progreso de la tarea.
Name	string	El nombre de la tarea.	analyticDBFlexibleScaleOut
Status	string	El estado de la tarea. Valores válidos: NOT_RUN: La tarea está en espera de ejecución. RUNNING: La tarea se está ejecutando. SUCCEED: La tarea se ha completado. Valores válidos: SUCCEED : Completada. RUNNING : En ejecución. NOT_RUN : En espera de ejecución.	RUNNING
Progress	string	El progreso de la tarea. Unidad: %.	10
StepList	object
StepList	array<object>	Los pasos de la tarea.
	object	Los pasos de la tarea.
StepName	string	El nombre del paso.	ApplyResource
StepDesc	string	La descripción del paso.	Apply resource
StepStatus	string	El estado del paso. Valores válidos: NOT_RUN: El paso está en espera de ejecución. RUNNING: El paso se está ejecutando. SUCCEED: El paso se ha completado. Valores válidos: SUCCEED : Completada. RUNNING : En ejecución. NOT_RUN : En espera de ejecución.	SUCCEED
StepProgress	string	El progreso del paso. Unidad: %.	50
StartTime	string	La hora de inicio del paso. La hora se muestra en el formato YYYY-MM-DDThh:mm:ssZ.	2024-03-10T09:28:34Z
EndTime	string	La hora de finalización del paso. La hora se muestra en el formato YYYY-MM-DDThh:mm:ssZ.	2024-03-10T10:28:34Z
ProductVersion	string	La edición del producto. Valores válidos: BasicVersion: Edición básica. EnterpriseVersion: Edición empresarial.	EnterpriseVersion

Ejemplos

Respuesta exitosa

JSON Formato

{
  "TotalCount": 1,
  "PageSize": 30,
  "RequestId": "D65A809F-34CE-4550-9BC1-0ED21ETG380",
  "PageNumber": 1,
  "Items": {
    "DBCluster": [
      {
        "DtsJobId": "dtsb1578j90XXXX",
        "DBNodeCount": 1,
        "Expired": "false",
        "CreateTime": "2021-04-01T09:50:18Z",
        "PayType": "Postpaid",
        "DiskType": "cloud_essd",
        "Tags": {
          "Tag": [
            {
              "Key": "tag1",
              "Value": "test1"
            }
          ]
        },
        "Mode": "flexible",
        "Port": "3306",
        "LockMode": "Unlock",
        "StorageResource": "8Core32GB",
        "ExecutorCount": "1",
        "DBClusterId": "am-bp163885f8q21****",
        "ConnectionString": "am-bp163885f8q21****.ads.aliyuncs.com",
        "RdsInstanceId": "rm-bp11q28kvl688****",
        "DBClusterType": "Common",
        "CommodityCode": "ads",
        "ExpireTime": "2999-09-08T16:00:00Z",
        "DBNodeStorage": 300,
        "DBNodeClass": "E8",
        "LockReason": "instance_expired",
        "VPCId": "vpc-bp13h7uzhulpuxvnpXXXX",
        "RegionId": "cn-hangzhou",
        "ComputeResource": "8Core32GB",
        "ElasticIOResource": 0,
        "VSwitchId": "vsw-bp1syh8vvw8yech7nXXXX",
        "DBVersion": "3.0",
        "VPCCloudInstanceId": "am-bp163885f8q21****-controller",
        "DBClusterStatus": "Running",
        "ResourceGroupId": "rg-acfmyiu4ekp****",
        "DBClusterNetworkType": "vpc",
        "DBClusterDescription": "adb_test",
        "ZoneId": "cn-hangzhou-h",
        "Category": "MIXED_STORAGE",
        "Engine": "AnalyticDB",
        "InnerIp": "10.1.xx.xx",
        "InnerPort": "3306",
        "TaskInfo": {
          "Name": "analyticDBFlexibleScaleOut",
          "Status": "RUNNING",
          "Progress": "10",
          "StepList": {
            "StepList": [
              {
                "StepName": "ApplyResource",
                "StepDesc": "Aplicar recurso",
                "StepStatus": "SUCCEED",
                "StepProgress": "50",
                "StartTime": "2024-03-10T09:28:34Z",
                "EndTime": "2024-03-10T10:28:34Z"
              }
            ]
          }
        },
        "ProductVersion": "EnterpriseVersion"
      }
    ]
  }
}

Códigos de error

Código de estado HTTP	Código de error	Mensaje de error	Descripción
500	InternalError	An error occurred while processing your request.	Ocurrió un error interno del sistema. Inténtelo de nuevo más tarde.
503	ServiceUnavailable	An error occurred while processing your request.	El sistema no está disponible temporalmente. Inténtelo de nuevo más tarde.

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.