DescribeDBClusters - AnalyticDB: Central de Documentação do Alibaba Cloud

Consulta os clusters da edição Data Lakehouse na região de destino.

Descrição da operação

Para obter uma lista atualizada de endpoints de serviço, consulte Endpoints de serviço.

Experimente agora

Experimente esta API no OpenAPI Explorer, sem necessidade de assinatura manual. Chamadas bem-sucedidas geram automaticamente código SDK correspondente aos seus parâmetros. Faça o download com segurança de credenciais integrada para uso local.

Testar

Autorização RAM

A tabela abaixo descreve a autorização necessária para chamar esta API. Você pode defini-la em uma política do Resource Access Management (RAM). As colunas da tabela estão detalhadas abaixo:

Ação: As ações que podem ser usadas no elemento Action das instruções de política de permissão do RAM para conceder permissões para executar a operação.
API: A API que você pode chamar para executar a ação.
Nível de acesso: O nível de acesso predefinido concedido para cada API. Valores válidos: create, list, get, update e delete.
Tipo de recurso: O tipo de recurso que suporta autorização para executar a ação. Indica se a ação suporta permissão em nível de recurso. O recurso especificado deve ser compatível com a ação. Caso contrário, a política será ineficaz.
- Para APIs com permissões em nível de recurso, os tipos de recursos obrigatórios são marcados com um asterisco (*). Especifique o Nome de Recurso Alibaba Cloud (ARN) correspondente no elemento Resource da política.
- Para APIs sem permissões em nível de recurso, é exibido como Todos os Recursos. Use um asterisco (*) no elemento Resource da política.
Chave de condição: As chaves de condição definidas pelo serviço. A chave permite controle granular, aplicando-se somente a ações ou a ações associadas a recursos específicos. Além das chaves de condição específicas do serviço, o Alibaba Cloud fornece um conjunto de chaves de condição comuns aplicáveis a todos os serviços compatíveis com RAM.
Ação dependente: As ações dependentes necessárias para executar a ação. Para concluir a ação, o usuário RAM ou a função RAM deve ter permissões para executar todas as ações dependentes.

Ação

Nível de acesso

Tipo de recurso

Chave de condição

Ação dependente

adb:DescribeDBClusters

list

*DBClusterLakeVersion

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

Nenhuma

Parâmetros da solicitação

Parâmetro	Tipo	Obrigatório	Descrição	Exemplo
RegionId	string	Sim	O ID da região. Nota Você pode chamar a operação DescribeRegions para consultar os IDs das regiões disponíveis.	cn-hangzhou
DBClusterIds	string	Não	O ID do cluster. Se você omitir este parâmetro, a operação retornará informações sobre todos os clusters na região especificada.	amv-bp1r053byu48p****
DBClusterDescription	string	Não	A descrição do cluster. Não pode começar com `http://` ou `https://`. A descrição deve ter de 2 a 256 caracteres.	test
DBClusterStatus	string	Não	O status do cluster. Valores válidos: Preparing: O cluster está em preparação. Creating: O cluster está sendo criado. Running: O cluster está em execução. Deleting: O cluster está sendo excluído. Restoring: O cluster está sendo restaurado a partir de um backup. ClassChanging: As especificações do cluster estão sendo alteradas. NetAddressCreating: Uma conexão de rede está sendo criada para o cluster. NetAddressDeleting: A conexão de rede do cluster está sendo excluída. NetAddressModifying: A conexão de rede do cluster está sendo modificada.	Running
PageSize	integer	Não	O número de entradas a serem retornadas em cada página. Valores válidos: 30 (padrão) 50 100	30
PageNumber	integer	Não	O número da página. O valor deve ser um número inteiro positivo. Valor padrão: 1.	1
ResourceGroupId	string	Não	O ID do grupo de recursos. Se você omitir este parâmetro, a operação retornará informações sobre clusters em todos os grupos de recursos.	rg-4690g37929****
Tag	array<object>	Não	As tags para filtrar os clusters.
	object	Não	Informações sobre uma tag do cluster.
Key	string	Não	A chave da tag.	tag1
Value	string	Não	O valor da tag.	test1
ProductVersion	string	Não	A versão do produto. Valores válidos: EnterpriseVersion: Edição Enterprise. BasicVersion: Edição Basic. Nota Se você omitir este parâmetro, a operação retornará clusters de todas as versões do produto.	BasicVersion
DBClusterVersion	string	Não	A versão do cluster. Valores válidos: 3.0: Edição Data Warehouse. 5.0 (padrão): Inclui as edições Lakehouse, Enterprise e Basic. All: Todas as edições, incluindo as edições Data Warehouse, Lakehouse, Enterprise e Basic.	5.0

Elementos de resposta

Elemento	Tipo	Descrição	Exemplo
	object
TotalCount	integer	O número total de entradas retornadas.	1
PageSize	integer	O número de entradas por página.	30
RequestId	string	O ID da solicitação.	A5EDBA27-AF3E-5966-9503-FD1557E19167
PageNumber	integer	O número da página.	1
Items	object
DBCluster	array<object>	Os detalhes dos clusters.
	array<object>	Os detalhes do cluster.
Expired	string	Indicates whether the subscription cluster has expired. Valid values: true: The cluster has expired. false: The cluster has not expired. Nota If a subscription cluster expires, it is locked and may be released after a period of time. We recommend that you renew the cluster. For more information, see Renewal. This parameter is not returned for pay-as-you-go clusters.	false
CreateTime	string	The creation time of the cluster. The time is in UTC and formatted as yyyy-MM-ddTHH:mm:ssZ.	2022-04-01T09:50:18Z
PayType	string	The billing method of the cluster. Valid values: Postpaid: pay-as-you-go. Prepaid: subscription.	Prepaid
Mode	string	The mode of the cluster. A value of flexible indicates that the cluster is in elastic mode.	flexible
Port	string	The port number of the cluster.	3306
LockMode	string	The lock state of the cluster. Valid values: Unlock: The cluster is not locked. ManualLock: The cluster is manually locked. LockByExpiration: The cluster is automatically locked upon expiration.	Unlock
StorageResource	string	The amount of reserved storage resources. An AnalyticDB Compute Unit (ACU) is equivalent to 1 vCPU and 4 GB of memory. Storage resources are used for data read and write operations. Increasing storage resources can improve the read and write performance of the cluster.	24ACU
DBClusterId	string	The ID of the Data Lakehouse Edition cluster.	amv-bp163885f8q21****
ConnectionString	string	The public endpoint of the cluster.	amv-bp163885f8q21****.ads.aliyuncs.com
DBClusterType	string	The type of the cluster. A value of Common indicates a regular cluster.	Common
CommodityCode	string	The commodity code of the cluster. Valid values: ads: a pay-as-you-go cluster. ads_pre: a subscription cluster.	ads_pre
ExpireTime	string	The expiration time of the cluster. The time is in UTC and formatted as yyyy-MM-ddTHH:mm:ssZ. Nota If the cluster has a subscription billing method, the actual expiration time is returned. If the cluster has a pay-as-you-go billing method, no value is returned.	2022-07-01T09:50:18Z
LockReason	string	The reason that the cluster is locked. Nota This parameter is returned only when the cluster is locked. The value is fixed as instance_expired.	instance_expired
VPCId	string	The virtual private cloud (VPC) ID.	vpc-bp13h7uzhulpuxvnp****
RegionId	string	The ID of the region where the cluster resides.	cn-hangzhou
ComputeResource	string	The amount of reserved computing resources. An AnalyticDB Compute Unit (ACU) is equivalent to 1 vCPU and 4 GB of memory. Computing resources are used for data computation. You can increase computing resources to accelerate queries and elastically scale them based on the cluster performance.	16ACU
VSwitchId	string	The vSwitch ID.	vsw-bp1syh8vvw8yech7n****
DBVersion	string	The database engine version. The only supported version is 5.0.	5.0
DBClusterStatus	string	The status of the cluster. Valid values: Preparing: The cluster is being prepared. Creating: The cluster is being created. Running: The cluster is running. Deleting: The cluster is being deleted. Restoring: The cluster is being restored from a backup. ClassChanging: The cluster specifications are being changed. NetAddressCreating: A network connection is being created. NetAddressDeleting: A network connection is being deleted. NetAddressModifying: A network connection is being modified.	Running
ResourceGroupId	string	The ID of the resource group.	rg-acfmyiu4ekp****
DBClusterNetworkType	string	The network type of the cluster. The only supported network type is VPC.	VPC
DBClusterDescription	string	The description of the cluster.	adb_test
ZoneId	string	The ID of the zone where the cluster resides.	cn-hangzhou-h
Engine	string	The database engine of the cluster. The value is fixed as AnalyticDB.	AnalyticDB
ReservedACU	string	The amount of remaining reserved computing resources. An ACU is equivalent to 1 vCPU and 4 GB of memory.	32ACU
Tags	object
Tag	array<object>	The list of tags.
	object	The tags.
Key	string	The tag key. Nota You can call the TagResources operation to add tags to the cluster.	tag1
Value	string	The tag value.	test1
Category	string	The edition of the cluster. This parameter is returned only for clusters in Data Warehouse Edition. Valid values: BASIC: Basic Edition in reserved mode. CLUSTER: Cluster Edition in reserved mode. MIXED_STORAGE: Elastic Mode Cluster Edition (New). Nota For more information about cluster editions, see Product editions.	MIXED_STORAGE
InnerPort	string	The internal port of the cluster.	3306
VPCCloudInstanceId	string	The internal endpoint.	am-bp163885f8q21****-controller
InnerIp	string	The internal IP address of the cluster.	10.1.xx.xx
DtsJobId	string	The ID of the Data Transmission Service (DTS) synchronization task. This parameter is returned only for MySQL analysis instances.	dtsb1578j90XXXX
ElasticIOResource	integer	The number of Elastic IO Units (EIUs). For more information, see EIU details. Nota This parameter is returned only for clusters in elastic mode.	2
RdsInstanceId	string	The ID of the source ApsaraDB RDS instance. This parameter is returned only for MySQL analysis instances.	rm-bp11q28kvl688****
ExecutorCount	string	The number of compute nodes in an elastic mode cluster.	1
DBNodeClass	string	The node specification. This parameter is returned only for clusters in Data Warehouse Edition.	E8
DiskType	string	The disk type of the cluster. Valid values: local_ssd: local SSD. cloud: standard cloud disk. cloud_ssd: SSD cloud disk. cloud_efficiency: ultra disk. cloud_essd: PL1 ESSD. cloud_essd2: PL2 ESSD. cloud_essd3: PL3 ESSD. Nota For more information about ESSDs, see ESSD specifications.	cloud_essd
DBNodeStorage	integer	The storage capacity of the cluster. Unit: GB.	300
DBNodeCount	integer	The number of node groups.	2
TaskInfo	object	Information about the task.
Name	string	The name of the task.	analyticDBFlexibleScaleOut
Status	string	The status of the task. Valid values: NOT_RUN: The task is pending. RUNNING: The task is running. SUCCEED: The task is complete.	RUNNING
Progress	string	The task progress, specified as a percentage.	10%
StepList	object
StepList	array<object>	The steps of the task.
	object	The steps of the task.
StepName	string	The name of the step.	ApplyResource
StepDesc	string	The description of the step.	Apply resource
StepStatus	string	The status of the step. Valid values: NOT_RUN: The step is pending. RUNNING: The step is running. SUCCEED: The step is complete.	SUCCEED
StepProgress	string	The progress of the step, specified as a percentage.	50%
StartTime	string	The time when the step started. The time is formatted as YYYY-MM-DDThh:mm:ssZ.	2024-03-10T09:28:34Z
EndTime	string	The time when the step ended. The time is formatted as YYYY-MM-DDThh:mm:ssZ.	2024-03-10T10:28:34Z
ProductForm	string	The product form. Valid values: LegacyForm: The legacy form. IntegrationForm: The integrated form.	IntegrationForm
ProductVersion	string	The product version. Valid values: BasicVersion: Basic Edition. EnterpriseVersion: Enterprise Edition.	EnterpriseVersion
ReservedNodeSize	string	The resource specification of a single reserved node.	8ACU
ReservedNodeCount	integer	The number of reserved resource nodes.	1
AINodeSpec	string	The AI node specification.	ADB.MLGrand.5
AINodeNumber	integer	The number of AI nodes.	1

Exemplos

Resposta de sucesso

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 erro

Código de status HTTP	Código de erro	Mensagem de erro	Descrição
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 Erro para uma lista completa.

Notas de versão

Consulte Notas de Versão para uma lista completa.