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

Lista os clusters da edição Data Lakehouse.

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

get

DBCluster

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

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 visualizar os IDs de região disponíveis.	cn-hangzhou
DBClusterIds	string	Não	O ID do cluster. Nota Você pode especificar qualquer ID de cluster na região especificada.	am-bp1r053byu48p****
DBClusterDescription	string	Não	A descrição do cluster. Não pode começar com `http://` ou `https://`. Deve ter de 2 a 256 caracteres.	test
DBClusterStatus	string	Não	O status do cluster. Valores válidos: Preparing: Preparando. Creating: Criando. Restoring: Restaurando de um backup. Running: Em execução. Deleting: Excluindo. ClassChanging: Fazendo upgrade ou downgrade de especificações. NetAddressCreating: Criando um endpoint de rede. NetAddressDeleting: Excluindo um endpoint de rede.	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. Os valores válidos são números inteiros maiores que 0 e menores ou iguais ao valor máximo do tipo de dados inteiro. Valor padrão: 1.	1
ResourceGroupId	string	Não	O ID do grupo de recursos.	rg-4690g37929XXXX
Tag	array<object>	Não	A lista de tags.
	object	Não	Detalhes sobre os itens na lista.
Key	string	Não	A chave da tag. Você pode filtrar clusters por chaves de tag. Você pode especificar até 20 pares chave-valor. Os números n em Tag.N.Key e Tag.N.Value devem ser números inteiros únicos e consecutivos começando de 1. Nota Uma chave de tag pode ter até 64 caracteres. Não pode começar com `aliyun`, `acs:`, `http://` ou `https://`.	tag1
Value	string	Não	O valor da tag. Você pode filtrar clusters por valores de tag. Você pode especificar até 20 pares chave-valor. Os números n em Tag.N.Key e Tag.N.Value devem ser números inteiros únicos e consecutivos começando de 1. Nota Um valor de tag pode ter até 64 caracteres. Não pode começar com `aliyun`, `acs:`, `http://` ou `https://`.	test1
DBVersion	string	Não	A versão do banco de dados. Valor válido: 3.0.	3.0
DBClusterVersion	string	Não	A versão do cluster. 3.0: Data Warehouse Edition. 5.0 (padrão): Inclui a Data Lakehouse Edition, Enterprise Edition e Basic Edition. All: Todas as versões, incluindo a Data Warehouse Edition, Data Lakehouse Edition, Enterprise Edition e Basic Edition.	3.0

Elementos de resposta

Elemento	Tipo	Descrição	Exemplo
	object	Detalhes sobre a lista retornada.
TotalCount	integer	O número total de entradas.	1
PageSize	integer	O número de entradas retornadas em cada página.	30
RequestId	string	O ID da solicitação.	D65A809F-34CE-4550-9BC1-0ED21ETG380
PageNumber	integer	O número da página.	1
Items	object
DBCluster	array<object>	A lista de clusters.
	array<object>	Detalhes sobre a lista de clusters.
DtsJobId	string	The DTS sync task ID. This parameter is returned only for MySQL analytic instances.	dtsb1578j90XXXX
DBNodeCount	integer	The number of node groups.	1
Expired	string	Indicates whether the cluster has expired. Valid values: true: Expired. false: Not expired.	false
CreateTime	string	The time when the cluster was created, in UTC. Format: yyyy-MM-ddTHH:mm:ssZ. Example: 2021-04-01T09:50:18Z.	2021-04-01T09:50:18Z
PayType	string	The billing method. Valid values: Postpaid: Pay-as-you-go. Prepaid: Subscription.	Postpaid
DiskType	string	The disk type. Valid values: local_ssd: Local SSD. cloud: Basic disk. cloud_ssd: Standard SSD. cloud_efficiency: Ultra disk. cloud_essd0: ESSD PL0. cloud_essd: ESSD PL1. cloud_essd2: ESSD PL2. cloud_essd3: ESSD PL3. Nota For more information about ESSDs, see ESSD specifications.	cloud_essd
Tags	object
Tag	array<object>	The list of tags.
	object	Details about the tag list.
Key	string	The tag key. Nota You can call the TagResources operation to add tags to a cluster.	tag1
Value	string	The tag value.	test1
Mode	string	The cluster mode. Valid values: flexible: Flexible mode. reserver: Reserved mode. Nota For more information, see Product editions.	flexible
Port	string	The port number. Default value: 3306.	3306
LockMode	string	The cluster lock mode. Valid values: Unlock: Unlocked. ManualLock: Manually locked. LockByExpiration: Locked due to expiration. LockByRestoration: Locked before rollback. LockByDiskQuota: Locked because storage usage reached 90% of the quota.	Unlock
StorageResource	string	The storage resource specification used in flexible mode for read and write operations. Increasing this resource improves cluster read and write performance.	8Core32GB
ExecutorCount	string	The number of compute nodes used by the cluster in flexible mode.	1
DBClusterId	string	The cluster ID.	am-bp163885f8q21****
ConnectionString	string	The public endpoint of the cluster.	am-bp163885f8q21****.ads.aliyuncs.com
RdsInstanceId	string	The source ApsaraDB RDS instance ID. This parameter is returned only for MySQL analytic instances.	rm-bp11q28kvl688****
DBClusterType	string	The cluster type. Valid values: Common: Standard cluster. RDS_ANALYSIS: MySQL analytic instance.	Common
CommodityCode	string	The commodity code. Fixed value: ads.	ads
ExpireTime	string	The time when the cluster expires, in UTC. Format: yyyy-MM-ddTHH:mm:ssZ. Example: 2999-09-08T16:00:00Z. Nota If the cluster uses the subscription billing method, this parameter returns the actual expiration time. If the cluster uses the pay-as-you-go billing method, this parameter returns the fixed value 2999-09-08T16:00:00Z.	2999-09-08T16:00:00Z
DBNodeStorage	integer	The storage capacity of the cluster, in GB.	300
DBNodeClass	string	The node specifications.	E8
LockReason	string	The reason why the cluster is locked. Nota This parameter is returned only if the cluster is locked. Fixed value: instance_expire.	instance_expired
VPCId	string	The virtual private cloud (VPC) ID.	vpc-bp13h7uzhulpuxvnpXXXX
RegionId	string	The region ID where the cluster resides.	cn-hangzhou
ComputeResource	string	The compute resource specification used in flexible mode for data processing. Increasing compute resources speeds up queries. You can scale these resources up or down as needed.	8Core32GB
ElasticIOResource	integer	The Elastic IO Unit (EIU). For more information, see EIU overview. Nota This parameter is returned only for clusters in flexible mode.	0
VSwitchId	string	The vSwitch ID.	vsw-bp1syh8vvw8yech7nXXXX
DBVersion	string	The database version. Only version 3.0 is supported.	3.0
VPCCloudInstanceId	string	The VPC instance ID.	am-bp163885f8q21****-controller
DBClusterStatus	string	The cluster status. For more information, see State table.	Running
ResourceGroupId	string	The resource group ID.	rg-acfmyiu4ekp****
DBClusterNetworkType	string	The network type of the cluster. Only VPC is supported.	vpc
DBClusterDescription	string	The cluster description.	adb_test
ZoneId	string	The zone ID where the cluster resides.	cn-hangzhou-h
Category	string	The product edition. Valid values: BASIC: Basic Edition in reserved mode. CLUSTER: Cluster Edition in reserved mode. MIXED_STORAGE: Cluster Edition in flexible mode (new). Nota For more information, see Product editions.	MIXED_STORAGE
Engine	string	The cluster engine. Fixed value: AnalyticDB.	AnalyticDB
InnerIp	string	The public IP address.	10.1.xx.xx
InnerPort	string	The port number.	3306
TaskInfo	object	Task progress information.
Name	string	The task name.	analyticDBFlexibleScaleOut
Status	string	The task status. Valid values: NOT_RUN: Waiting to run. RUNNING: Running. SUCCEED: Completed.	RUNNING
Progress	string	The task progress, in %.	10
StepList	object
StepList	array<object>	The task steps.
	object	The task step.
StepName	string	The step name.	ApplyResource
StepDesc	string	The step description.	Apply resource
StepStatus	string	The step status. Valid values: NOT_RUN: Waiting to run. RUNNING: Running. SUCCEED: Completed.	SUCCEED
StepProgress	string	The step progress, in %.	50
StartTime	string	The time when the step started. Format: YYYY-MM-DDThh:mm:ssZ.	2024-03-10T09:28:34Z
EndTime	string	The time when the step ended. Format: YYYY-MM-DDThh:mm:ssZ.	2024-03-10T10:28:34Z
ProductVersion	string	The product version. Valid values: BasicVersion: Basic Edition. EnterpriseVersion: Enterprise Edition.	EnterpriseVersion

Exemplos

Resposta de sucesso

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": "Apply resource",
                "StepStatus": "SUCCEED",
                "StepProgress": "50",
                "StartTime": "2024-03-10T09:28:34Z",
                "EndTime": "2024-03-10T10:28:34Z"
              }
            ]
          }
        },
        "ProductVersion": "EnterpriseVersion"
      }
    ]
  }
}

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.