DescribeDBClusters - - Centro de documentación de Alibaba Cloud

Consulta los clústeres de la edición Data Lakehouse en la región de destino.

Descripción de la operación

Para obtener una lista actualizada de endpoints de servicio, consulte Endpoints de servicio.

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

list

*DBClusterLakeVersion

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

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 las regiones disponibles.	cn-hangzhou
DBClusterIds	string	No	El ID del clúster. Si omite este parámetro, la operación devuelve información sobre todos los clústeres en la región especificada.	amv-bp1r053byu48p****
DBClusterDescription	string	No	La descripción del clúster. No puede comenzar con `http://` o `https://`. La descripción debe tener entre 2 y 256 caracteres de longitud.	test
DBClusterStatus	string	No	El estado del clúster. Valores válidos: Preparing: El clúster se está preparando. Creating: El clúster se está creando. Running: El clúster está en ejecución. Deleting: El clúster se está eliminando. Restoring: El clúster se está restaurando desde una copia de seguridad. ClassChanging: Las especificaciones del clúster están cambiando. NetAddressCreating: Se está creando una conexión de red para el clúster. NetAddressDeleting: Se está eliminando la conexión de red del clúster. NetAddressModifying: Se está modificando la conexión de red del clúster.	Running
PageSize	integer	No	El número de entradas que se devolverán en cada 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 entero positivo. Valor predeterminado: 1.	1
ResourceGroupId	string	No	El ID del grupo de recursos. Si omite este parámetro, la operación devuelve información sobre los clústeres de todos los grupos de recursos.	rg-4690g37929****
Tag	array<object>	No	Las etiquetas por las cuales filtrar los clústeres.
	object	No	Información sobre una etiqueta de clúster.
Key	string	No	La clave de la etiqueta.	tag1
Value	string	No	El valor de la etiqueta.	test1
ProductVersion	string	No	La versión del producto. Valores válidos: EnterpriseVersion: Edición Enterprise. BasicVersion: Edición Basic. Nota Si omite este parámetro, la operación devuelve clústeres de todas las versiones del producto.	BasicVersion
DBClusterVersion	string	No	La versión del clúster. Valores válidos: 3.0: Edición Data Warehouse. 5.0 (valor predeterminado): Incluye las ediciones Lakehouse, Enterprise y Basic. All: Todas las ediciones, incluidas las ediciones Data Warehouse, Lakehouse, Enterprise y Basic.	5.0

Elementos de la respuesta

Elemento	Tipo	Descripción	Ejemplo
	object
TotalCount	integer	El número total de entradas devueltas.	1
PageSize	integer	El número de entradas por página.	30
RequestId	string	El ID de la solicitud.	A5EDBA27-AF3E-5966-9503-FD1557E19167
PageNumber	integer	El número de página.	1
Items	object
DBCluster	array<object>	Los detalles de los clústeres.
	array<object>	Los detalles del clúster.
Expired	string	Indica si el clúster de suscripción ha caducado. Valores válidos: true: El clúster ha caducado. false: El clúster no ha caducado. Nota Si un clúster de suscripción caduca, se bloquea y puede liberarse después de un periodo de tiempo. Se recomienda renovar el clúster. Para obtener más información, consulte Renovación. Este parámetro no se devuelve para clústeres de pago por uso.	false
CreateTime	string	La hora de creación del clúster. La hora está en formato UTC y tiene el formato yyyy-MM-ddTHH:mm:ssZ.	2022-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.	Prepaid
Mode	string	El modo del clúster. Un valor de flexible indica que el clúster está en modo elástico.	flexible
Port	string	El número de puerto del clúster.	3306
LockMode	string	El estado 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 al caducar.	Unlock
StorageResource	string	La cantidad de recursos de almacenamiento reservados. Una Unidad de Cómputo de AnalyticDB (ACU) equivale a 1 vCPU y 4 GB de memoria. Los recursos de almacenamiento se utilizan para operaciones de lectura y escritura de datos. Aumentar los recursos de almacenamiento puede mejorar el rendimiento de lectura y escritura del clúster.	24ACU
DBClusterId	string	El ID del clúster Data Lakehouse Edition.	amv-bp163885f8q21****
ConnectionString	string	El endpoint público del clúster.	amv-bp163885f8q21****.ads.aliyuncs.com
DBClusterType	string	El tipo de clúster. Un valor de Common indica un clúster estándar.	Common
CommodityCode	string	El código de producto del clúster. Valores válidos: ads: un clúster de pago por uso. ads_pre: un clúster de suscripción.	ads_pre
ExpireTime	string	La hora de caducidad del clúster. La hora está en formato UTC y tiene el formato yyyy-MM-ddTHH:mm:ssZ. Nota Si el clúster tiene un método de facturación de suscripción, se devuelve la hora de caducidad real. Si el clúster tiene un método de facturación de pago por uso, no se devuelve ningún valor.	2022-07-01T09:50:18Z
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_expired.	instance_expired
VPCId	string	El ID de la nube privada virtual (VPC).	vpc-bp13h7uzhulpuxvnp****
RegionId	string	El ID de la región donde reside el clúster.	cn-hangzhou
ComputeResource	string	La cantidad de recursos de cómputo reservados. Una Unidad de Cómputo de AnalyticDB (ACU) equivale a 1 vCPU y 4 GB de memoria. Los recursos de cómputo se utilizan para el procesamiento de datos. Puede aumentar los recursos de cómputo para acelerar las consultas y escalarlos elásticamente según el rendimiento del clúster.	16ACU
VSwitchId	string	El ID del vSwitch.	vsw-bp1syh8vvw8yech7n****
DBVersion	string	La versión del motor de base de datos. La única versión compatible es la 5.0.	5.0
DBClusterStatus	string	El estado del clúster. Valores válidos: Preparing: El clúster se está preparando. Creating: El clúster se está creando. Running: El clúster está en ejecución. Deleting: El clúster se está eliminando. Restoring: El clúster se está restaurando desde una copia de seguridad. ClassChanging: Se están modificando las especificaciones del clúster. NetAddressCreating: Se está creando una conexión de red. NetAddressDeleting: Se está eliminando una conexión de red. NetAddressModifying: Se está modificando una conexión de red.	Running
ResourceGroupId	string	El ID del grupo de recursos.	rg-acfmyiu4ekp****
DBClusterNetworkType	string	El tipo de red del clúster. El único tipo de red compatible es VPC.	VPC
DBClusterDescription	string	La descripción del clúster.	adb_test
ZoneId	string	El ID de la zona donde reside el clúster.	cn-hangzhou-h
Engine	string	El motor de base de datos del clúster. El valor es fijo: AnalyticDB.	AnalyticDB
ReservedACU	string	La cantidad de recursos de cómputo reservados restantes. Una ACU equivale a 1 vCPU y 4 GB de memoria.	32ACU
Tags	object
Tag	array<object>	La lista de etiquetas.
	object	Las etiquetas.
Key	string	La clave de la etiqueta. Nota Puede llamar a la operación TagResources para agregar etiquetas al clúster.	tag1
Value	string	El valor de la etiqueta.	test1
Category	string	La edición del clúster. Este parámetro se devuelve solo para clústeres en Data Warehouse Edition. Valores válidos: BASIC: Basic Edition en modo reservado. CLUSTER: Cluster Edition en modo reservado. MIXED_STORAGE: Elastic Mode Cluster Edition (Nueva). Nota Para obtener más información sobre las ediciones de clúster, consulte Ediciones del producto.	MIXED_STORAGE
InnerPort	string	El puerto interno del clúster.	3306
VPCCloudInstanceId	string	El endpoint interno.	am-bp163885f8q21****-controller
InnerIp	string	La dirección IP interna del clúster.	10.1.xx.xx
DtsJobId	string	El ID de la tarea de sincronización de Data Transmission Service (DTS). Este parámetro se devuelve solo para instancias de análisis de MySQL.	dtsb1578j90XXXX
ElasticIOResource	integer	El número de Unidades de E/S Elástica (EIU). Para obtener más información, consulte Detalles de EIU. Nota Este parámetro se devuelve solo para clústeres en modo elástico.	2
RdsInstanceId	string	El ID de la instancia de ApsaraDB RDS de origen. Este parámetro se devuelve solo para instancias de análisis de MySQL.	rm-bp11q28kvl688****
ExecutorCount	string	El número de nodos de cómputo en un clúster de modo elástico.	1
DBNodeClass	string	La especificación del nodo. Este parámetro se devuelve solo para clústeres en Data Warehouse Edition.	E8
DiskType	string	El tipo de disco del clúster. Valores válidos: local_ssd: SSD local. cloud: disco en la nube estándar. cloud_ssd: disco en la nube SSD. cloud_efficiency: disco ultra. cloud_essd: ESSD PL1. cloud_essd2: ESSD PL2. cloud_essd3: ESSD PL3. Nota Para obtener más información sobre los discos ESSD, consulte Especificaciones de ESSD.	cloud_essd
DBNodeStorage	integer	La capacidad de almacenamiento del clúster. Unidad: GB.	300
DBNodeCount	integer	El número de grupos de nodos.	2
TaskInfo	object	Información sobre 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á pendiente. RUNNING: La tarea está en ejecución. SUCCEED: La tarea se completó.	RUNNING
Progress	string	El progreso de la tarea, especificado como porcentaje.	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.	Aplicar recurso
StepStatus	string	El estado del paso. Valores válidos: NOT_RUN: El paso está pendiente. RUNNING: El paso está en ejecución. SUCCEED: El paso se completó.	SUCCEED
StepProgress	string	El progreso del paso, especificado como porcentaje.	50%
StartTime	string	La hora en que inició el paso. La hora tiene el formato YYYY-MM-DDThh:mm:ssZ.	2024-03-10T09:28:34Z
EndTime	string	La hora en que finalizó el paso. La hora tiene el formato YYYY-MM-DDThh:mm:ssZ.	2024-03-10T10:28:34Z
ProductForm	string	La forma del producto. Valores válidos: LegacyForm: La forma heredada. IntegrationForm: La forma integrada.	IntegrationForm
ProductVersion	string	La versión del producto. Valores válidos: BasicVersion: Basic Edition. EnterpriseVersion: Enterprise Edition.	EnterpriseVersion
ReservedNodeSize	string	La especificación de recursos de un solo nodo reservado.	8ACU
ReservedNodeCount	integer	El número de nodos de recursos reservados.	1
AINodeSpec	string	La especificación del nodo de IA.	ADB.MLGrand.5
AINodeNumber	integer	El número de nodos de IA.	1

Ejemplos

Respuesta exitosa

JSON Formato

{
  "TotalCount": 1,
  "PageSize": 30,
  "RequestId": "A5EDBA27-AF3E-5966-9503-FD1557E19167",
  "PageNumber": 1,
  "Items": {
    "DBCluster": [
      {
        "Expired": "false",
        "CreateTime": "2022-04-01T09:50:18Z",
        "PayType": "Prepaid",
        "Mode": "flexible",
        "Port": "3306",
        "LockMode": "Unlock",
        "StorageResource": "24ACU",
        "DBClusterId": "amv-bp163885f8q21****",
        "ConnectionString": "amv-bp163885f8q21****.ads.aliyuncs.com",
        "DBClusterType": "Common",
        "CommodityCode": "ads_pre",
        "ExpireTime": "2022-07-01T09:50:18Z",
        "LockReason": "instance_expired",
        "VPCId": "vpc-bp13h7uzhulpuxvnp****",
        "RegionId": "cn-hangzhou",
        "ComputeResource": "16ACU",
        "VSwitchId": "vsw-bp1syh8vvw8yech7n****",
        "DBVersion": "5.0",
        "DBClusterStatus": "Running",
        "ResourceGroupId": "rg-acfmyiu4ekp****",
        "DBClusterNetworkType": "VPC",
        "DBClusterDescription": "adb_test",
        "ZoneId": "cn-hangzhou-h",
        "Engine": "AnalyticDB",
        "ReservedACU": "32ACU",
        "Tags": {
          "Tag": [
            {
              "Key": "tag1",
              "Value": "test1"
            }
          ]
        },
        "Category": "MIXED_STORAGE",
        "InnerPort": "3306",
        "VPCCloudInstanceId": "am-bp163885f8q21****-controller",
        "InnerIp": "10.1.xx.xx",
        "DtsJobId": "dtsb1578j90XXXX",
        "ElasticIOResource": 2,
        "RdsInstanceId": "rm-bp11q28kvl688****",
        "ExecutorCount": "1",
        "DBNodeClass": "E8",
        "DiskType": "cloud_essd",
        "DBNodeStorage": 300,
        "DBNodeCount": 2,
        "TaskInfo": {
          "Name": "analyticDBFlexibleScaleOut",
          "Status": "RUNNING",
          "Progress": "10%",
          "StepList": {
            "StepList": [
              {
                "StepName": "ApplyResource",
                "StepDesc": "Apply resource",
                "StepStatus": "SUCCEED",
                "StepProgress": "50%",
                "StartTime": "2024-03-10T09:28:34Z",
                "EndTime": "2024-03-10T10:28:34Z"
              }
            ]
          }
        },
        "ProductForm": "IntegrationForm",
        "ProductVersion": "EnterpriseVersion",
        "ReservedNodeSize": "8ACU",
        "ReservedNodeCount": 1,
        "AINodeSpec": "ADB.MLGrand.5",
        "AINodeNumber": 1
      }
    ]
  }
}

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.	An internal error occurred. Please try again later.
503	ServiceUnavailable	An error occurred while processing your request.	The system is unavailable. Please try again later.

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.