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

Consulta os detalhes de um cluster do AnalyticDB for MySQL especificado.

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

get

DBCluster.

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

Nenhuma

Parâmetros da solicitação

Parâmetro	Tipo	Obrigatório	Descrição	Exemplo
DBClusterId	string	Sim	O ID do cluster do AnalyticDB for MySQL Data Warehouse Edition.\n> Você pode chamar a operação DescribeDBClusters para consultar os IDs de todos os clusters do AnalyticDB for MySQL Data Warehouse Edition em uma região especificada.	am-bp111m2cfrdl1****
RegionId	string	Não	O ID da região do cluster.	cn-hangzhou

Elementos de resposta

Elemento	Tipo	Descrição	Exemplo
	object	Os detalhes da lista.
RequestId	string	O ID da solicitação.	2895BB82-B2C1-408E-AA73-DB8D59******
Items	object
DBCluster	array<object>	A lista de informações do cluster.
	array<object>	Os detalhes do cluster.
CreationTime	string	A hora de criação do cluster. A hora é exibida no formato yyyy-MM-ddTHH:mm:ssZ (UTC).	2021-04-01T09:50:18Z
EnableSpark	boolean	Indica se um cluster Spark é criado. Valores válidos: true: Um cluster Spark é criado. false: Nenhum cluster Spark é criado.	false
DtsJobId	string	O ID da tarefa de sincronização do Data Transmission Service (DTS). Este parâmetro é retornado apenas para instâncias analíticas do MySQL.	dtsb1hp3790****
DBNodeCount	integer	O número de grupos de nós.	1
Expired	string	Indica se o cluster expirou. Valores válidos: true: O cluster expirou. false: O cluster não expirou.	false
MaintainTime	string	A janela de manutenção do cluster. A hora é exibida no formato HH:mmZ-HH:mmZ. Por exemplo, 04:00Z-05:00Z indica que a janela de manutenção é das 04:00 às 05:00. Nota Para mais informações sobre a janela de manutenção, consulte Definir a janela de manutenção.	04:00Z-05:00Z
PayType	string	O método de cobrança do cluster. Valores válidos: Postpaid: Pós-pago. Prepaid: Assinatura.	Postpaid
DiskType	string	O tipo de disco do cluster. Valores válidos: local_ssd: Disco local. cloud: Disco em nuvem básico. cloud_ssd: SSD padrão. cloud_efficiency: Ultra disco. cloud_essd0: ESSD PL0. cloud_essd: ESSD PL1. cloud_essd2: ESSD PL2. cloud_essd3: ESSD PL3. Nota Para mais informações sobre ESSDs, consulte Especificações de ESSD.	cloud_essd
Tags	object
Tag	array<object>	A lista de tags.
	object	Os detalhes do cluster.
Key	string	A chave da tag. Nota Você pode chamar a operação TagResources para criar tags para o cluster.	tag1
Value	string	O valor da tag.	test1
Mode	string	O modo do cluster. Valores válidos: flexible: Modo elástico. reserver: Modo reservado. Nota Para mais informações sobre os modos de cluster, consulte Edições.	flexible
Port	integer	O número da porta do cluster.	3306
LockMode	string	O modo de bloqueio do cluster. Valores válidos: Unlock: Normal (desbloqueado). ManualLock: Bloqueado manualmente. LockByExpiration: Bloqueado automaticamente devido à expiração. LockByRestoration: Bloqueado automaticamente antes de uma reversão. LockByDiskQuota: Bloqueado automaticamente porque o espaço de armazenamento está cheio (o espaço de armazenamento usado pelos dados atingiu 90% do limite superior).	Unlock
EngineVersion	string	A versão do mecanismo DPI do cluster.	3.1.1.9
EnableAirflow	boolean	Indica se um cluster Airflow é criado. Valores válidos: true: Um cluster Airflow é criado. false: Nenhum cluster Airflow é criado.	true
ExecutorCount	string	O número de nós de computação usados pelo cluster no modo elástico.	1
StorageResource	string	As especificações de recursos de armazenamento usadas no modo elástico para leituras e gravações de dados. Aumentar esse recurso melhora as capacidades de leitura e gravação do cluster.	8Core32GB
DBClusterId	string	O ID do cluster da edição Data Warehouse do AnalyticDB for MySQL.	am-bp111m2cfrdl1****
ConnectionString	string	O endpoint de VPC do cluster.	am-bp111m2cfrdl1****.ads.aliyuncs.com
RdsInstanceId	string	O ID da instância de origem do ApsaraDB RDS para sincronização. Este parâmetro é retornado apenas para instâncias analíticas do MySQL.	rm-bp837jsdp2****
DBClusterType	string	O tipo de cluster. Valores válidos: Common: Cluster comum. RDS_ANALYSIS: Instância analítica do MySQL.	Common
CommodityCode	string	O método de cobrança da commodity. Valores válidos: ads: Commodity pós-paga. ads_pre: Commodity de assinatura.	ads
ExpireTime	string	A hora de expiração do cluster. A hora é exibida no formato yyyy-MM-ddTHH:mm:ssZ (UTC), como 2999-09-08T16:00:00Z. Nota Se o cluster usar o método de cobrança de assinatura, a hora de expiração real é retornada. Se o cluster usar o método de cobrança pós-pago, o valor fixo 2999-09-08T16:00:00Z é retornado.	2999-09-08T16:00:00Z
DBNodeStorage	integer	O espaço de armazenamento do cluster. Unidade: GB.	300
DBNodeClass	string	As especificações do nó.	E8
LockReason	string	O motivo pelo qual o cluster está bloqueado. Nota Este parâmetro é retornado apenas quando o cluster está bloqueado. O valor é fixo como instance_expire.	instance_expired
VPCId	string	O ID da virtual private cloud (VPC).	vpc-bp13h7uzhulpuxvnp****
ComputeResource	string	As especificações de recursos de computação usadas no modo elástico para computação de dados. Aumentar os recursos de computação acelera as velocidades de consulta. Você pode dimensionar os recursos de computação elasticamente com base nos requisitos reais de desempenho do cluster.	8Core32GB
RegionId	string	O ID da região do cluster.	cn-hangzhou
ElasticIOResource	integer	O número de recursos de E/S elásticos.	2
VSwitchId	string	O ID do vSwitch.	vsw-bp1syh8vvw8yech7n****
DBVersion	string	A versão do banco de dados. Apenas a versão 3.0 é suportada.	3.0
VPCCloudInstanceId	string	O ID da instância conectada à VPC.	am-bp111m2cfrdl1****-controller
DBClusterStatus	string	O status do cluster. Para mais informações, consulte Tabela de status do cluster.	Running
ResourceGroupId	string	O ID do grupo de recursos.	rg-acfmyiu4ekp****
DBClusterNetworkType	string	O tipo de rede do cluster. Apenas VPC é suportado.	vpc
DBClusterDescription	string	A descrição do cluster.	adb_test
UserENIStatus	boolean	Indica se a rede do controlador de interface de rede elástica (NIC) está ativada. Valores válidos: true: A rede ENI está ativada. false: A rede ENI está desativada.	true
ZoneId	string	O ID da zona do cluster.	cn-hangzhou-h
Category	string	A edição. Valores válidos: BASIC: Basic Edition no modo reservado. CLUSTER: Cluster Edition no modo reservado. MIXED_STORAGE: Cluster Edition no modo elástico (nova versão). Nota Para mais informações sobre as edições, consulte Edições.	MIXED_STORAGE
Engine	string	O mecanismo do cluster. O valor é fixo como AnalyticDB.	AnalyticDB
KmsId	string	O ID da chave usada para criptografar dados de disco em nuvem. Nota Este parâmetro é retornado apenas quando a criptografia de disco em nuvem está ativada para o cluster AnalyticDB for MySQL.	e1935511-cf88-1123-a0f8-1be8d251****
InnerIp	string	O endereço IP público.	10.1.XX.XX
InnerPort	string	O número da porta pública.	3306
DiskPerformanceLevel	string	O nível de desempenho do disco em nuvem.	PL1
ElasticIOResourceSize	string	As especificações de nó único de recursos elásticos. Valores válidos: 8Core64GB: Quando as especificações de nó único são 8 núcleos e 64 GB, as especificações de um grupo de recursos de E/S elásticos são 24 núcleos e 192 GB. 12Core96GB: Quando as especificações de nó único são 12 núcleos e 96 GB, as especificações de um grupo de recursos de E/S elásticos são 36 núcleos e 288 GB.	8Core64GB
DiskEncryption	boolean	Indica se a criptografia de disco em nuvem está ativada. Valores válidos: true: A criptografia de disco em nuvem está ativada. false: A criptografia de disco em nuvem está desativada.	false
TaskInfo	object	As informações da tarefa.
Name	string	O nome da tarefa.	analyticDBFlexibleScaleOut
Status	string	O status da tarefa. Valores válidos: NOT_RUN: Pendente. RUNNING: Em execução. SUCCEED: Concluído. Valores válidos: SUCCEED : Concluído. RUNNING : Em execução. NOT_RUN : Pendente.	RUNNING
Progress	string	O progresso da tarefa. Unidade: %.	10
StepList	object
StepList	array<object>	As etapas da tarefa.
	object	As etapas da tarefa.
StepName	string	O nome da etapa.	ApplyResource
StepDesc	string	A descrição da etapa.	Apply resource
StepStatus	string	O status da etapa. Valores válidos: NOT_RUN: Pendente. RUNNING: Em execução. SUCCEED: Concluído. Valores válidos: SUCCEED : Concluído. RUNNING : Em execução. NOT_RUN : Pendente.	SUCCEED
StepProgress	string	O progresso da etapa. Unidade: %.	50
StartTime	string	A hora de início da etapa. A hora é exibida no formato YYYY-MM-DDThh:mm:ssZ.	2024-03-10T09:28:34Z
EndTime	string	A hora de término da etapa. A hora é exibida no formato YYYY-MM-DDThh:mm:ssZ.	2024-03-10T10:28:34Z
ProductVersion	string	A edição do produto. Valores válidos: BasicVersion: Basic Edition. EnterpriseVersion: Enterprise Edition.	BasicVersion
SecondaryZoneId	string	O ID da zona secundária. Nota O valor deste parâmetro não pode ser igual ao valor do parâmetro ZoneId.	cn-hangzhou-i
SecondaryVSwitchId	string	O ID do vSwitch secundário. Nota O valor deste parâmetro não pode ser igual ao valor do parâmetro VSwitchId.	vsw-0jlxwqt4531fsb3jdzx6h
ReservedNodeSize	string	As especificações do nó reservado. Unidade: ACU.	8ACU
ReservedNodeCount	integer	O número de nós de recursos reservados.	3
ProductForm	string	A forma do produto. Valores válidos: LegacyForm: Forma legada. IntegrationForm: Forma de integração. Valores válidos: LegacyForm : Forma legada. IntegrationForm : Forma de integração.	IntegrationForm

Exemplos

Resposta de sucesso

JSON formato

{
  "RequestId": "2895BB82-B2C1-408E-AA73-DB8D59******",
  "Items": {
    "DBCluster": [
      {
        "CreationTime": "2021-04-01T09:50:18Z",
        "EnableSpark": false,
        "DtsJobId": "dtsb1hp3790****",
        "DBNodeCount": 1,
        "Expired": "false",
        "MaintainTime": "04:00Z-05:00Z",
        "PayType": "Postpaid",
        "DiskType": "cloud_essd",
        "Tags": {
          "Tag": [
            {
              "Key": "tag1",
              "Value": "test1"
            }
          ]
        },
        "Mode": "flexible",
        "Port": 3306,
        "LockMode": "Unlock",
        "EngineVersion": "3.1.1.9",
        "EnableAirflow": true,
        "ExecutorCount": "1",
        "StorageResource": "8Core32GB",
        "DBClusterId": "am-bp111m2cfrdl1****",
        "ConnectionString": "am-bp111m2cfrdl1****.ads.aliyuncs.com",
        "RdsInstanceId": "rm-bp837jsdp2****",
        "DBClusterType": "Common",
        "CommodityCode": "ads",
        "ExpireTime": "2999-09-08T16:00:00Z",
        "DBNodeStorage": 300,
        "DBNodeClass": "E8",
        "LockReason": "instance_expired",
        "VPCId": "vpc-bp13h7uzhulpuxvnp****",
        "ComputeResource": "8Core32GB",
        "RegionId": "cn-hangzhou",
        "ElasticIOResource": 2,
        "VSwitchId": "vsw-bp1syh8vvw8yech7n****",
        "DBVersion": "3.0",
        "VPCCloudInstanceId": "am-bp111m2cfrdl1****-controller",
        "DBClusterStatus": "Running",
        "ResourceGroupId": "rg-acfmyiu4ekp****",
        "DBClusterNetworkType": "vpc",
        "DBClusterDescription": "adb_test",
        "UserENIStatus": true,
        "ZoneId": "cn-hangzhou-h",
        "Category": "MIXED_STORAGE",
        "Engine": "AnalyticDB",
        "KmsId": "e1935511-cf88-1123-a0f8-1be8d251****",
        "InnerIp": "10.1.XX.XX",
        "InnerPort": "3306",
        "DiskPerformanceLevel": "PL1",
        "ElasticIOResourceSize": "8Core64GB",
        "DiskEncryption": false,
        "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": "BasicVersion",
        "SecondaryZoneId": "cn-hangzhou-i",
        "SecondaryVSwitchId": "vsw-0jlxwqt4531fsb3jdzx6h",
        "ReservedNodeSize": "8ACU",
        "ReservedNodeCount": 3,
        "ProductForm": "IntegrationForm"
      }
    ]
  }
}

Códigos de erro

Código de status HTTP	Código de erro	Mensagem de erro	Descrição
404	InvalidDBCluster.NotFound	The DBClusterId provided does not exist in our records.	O DBClusterId especificado não existe. Verifique se o valor de DBClusterId está correto.

Consulte Códigos de Erro para uma lista completa.

Notas de versão

Consulte Notas de Versão para uma lista completa.