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

Retorna os detalhes de um cluster específico.

Descrição da operação

Para encontrar os endpoints deste serviço, consulte Endpoints.

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

*DBClusterLakeVersion

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 da Data Lakehouse Edition. Nota Você pode chamar a operação DescribeDBClusters para obter o ID do cluster.	amv-wz9509beptiz****

Elementos de resposta

Elemento	Tipo	Descrição	Exemplo
	object
RequestId	string	O ID da solicitação.	A5C433C2-001F-58E3-99F5-3274C14DF8BD
Items	object
DBCluster	array<object>	As informações sobre os clusters da Data Lakehouse Edition.
	array<object>	Os detalhes do cluster.
CreationTime	string	The time when the cluster was created. The time is in the `yyyy-MM-ddThh:mm:ssZ` format and is displayed in UTC.	2022-07-01T09:50:18Z
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 cluster expires, the cluster is locked or even 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
MaintainTime	string	The maintenance window of the cluster. The time is in the `HH:mmZ-HH:mmZ` format and is displayed in UTC. Nota For more information about maintenance windows, see Set a maintenance window.	04:00Z-05:00Z
PayType	string	The billing method of the cluster. Valid values: Postpaid: pay-as-you-go. Prepaid: subscription.	Prepaid
Tags	object
Tag	array<object>	The list of tags.
	object
Key	string	The tag key. Nota To add tags to the cluster, call the TagResources operation.	tag1
Value	string	The tag value.	test1
Mode	string	The mode of the cluster. The default value is flexible, which indicates an elastic mode cluster.	flexible
Port	integer	The port number of the cluster.	3306
LockMode	string	The lock mode of the cluster. Valid values: Unlock: The cluster is not locked. ManualLock: The cluster is manually locked. LockByExpiration: The cluster is automatically locked due to expiration.	ManualLock
EngineVersion	string	The engine version of the cluster.	3.1.16
StorageResource	string	The amount of reserved storage resources. These resources are used for data reads and writes. Increasing them can improve the cluster's read and write performance.	24ACU
DBClusterId	string	The ID of the Data Lakehouse Edition cluster.	amv-wz9509beptiz****
ConnectionString	string	The VPC endpoint of the cluster.	amv-wz9509beptiz****.ads.aliyuncs.com
DBClusterType	string	The type of the cluster. The default value is Common, which indicates a regular cluster.	Common
CommodityCode	string	The commodity code of the cluster, which is the same as the code of the cluster on the Billing Management page. Valid values: ads: A pay-as-you-go cluster. ads_pre: A subscription cluster.	ads_pre
ExpireTime	string	The expiration time of the cluster. If the cluster is a subscription cluster, the expiration time is returned. If the cluster is a pay-as-you-go cluster, an empty string is returned.	2022-10-01T09:50:18Z
LockReason	string	The reason why the cluster is locked. Nota This parameter is returned only when the cluster is locked. The value is always instance_expire.	instance_expire
VPCId	string	The Virtual Private Cloud (VPC) ID.	vpc-bp13h7uzhulpu****
ComputeResource	string	The amount of reserved computing resources. One AnalyticDB Compute Unit (ACU) is equivalent to approximately 1 core and 4 GB of memory. Computing resources are used for data computation. Increasing these resources can accelerate queries. You can scale the resources on demand based on the actual performance of the cluster.	16ACU
RegionId	string	The region ID of the cluster.	cn-hangzhou
VSwitchId	string	The vSwitch ID.	vsw-uf629gydd54ld****
DBVersion	string	The version of the AnalyticDB for MySQL cluster. Currently, only version 5.0 is supported.	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 resource group ID.	rg-acfmyiu4ekp****
DBClusterNetworkType	string	The network type of the cluster. Only VPC (Virtual Private Cloud) is supported.	VPC
DBClusterDescription	string	The description of the cluster.	adb_test
UserENIStatus	boolean	Indicates whether an elastic network interface (ENI) is enabled. Valid values: true: An ENI is enabled. false: An ENI is not enabled.	false
ZoneId	string	The zone ID of the cluster.	cn-hangzhou-h
Engine	string	The database engine of the cluster. The value is always AnalyticDB.	AnalyticDB
ReservedACU	string	The amount of available reserved computing resources in the cluster.	24ACU
ComputeResourceTotal	string	The total amount of computing resources in the cluster.	48ACU
StorageResourceTotal	string	The total amount of storage resources in the cluster.	24ACU
SupportedFeatures	object	This parameter is reserved for future use.
	string	This parameter is reserved for future use.	预留参数，不涉及。
ProductForm	string	This parameter is reserved for future use.	Reserved parameter. Not applicable.
ReservedNodeSize	string	This parameter is reserved for future use.	Reserved parameter. Not applicable.
ReservedNodeCount	integer	This parameter is reserved for future use.	Reserved parameter. Not applicable.
ClickhouseEngineEnabled	boolean	Indicates whether the ClickHouse wide table engine is enabled. true: The ClickHouse wide table engine is enabled. false: The ClickHouse wide table engine is not enabled. Valores válidos: true : true false : false	true
AINodeNumber	integer	The number of AI nodes.	3
ProductVersion	string	The product version of the cluster. Valid values: BasicVersion: Basic Edition. EnterpriseVersion: Enterprise Edition.	BasicVersion
KmsId	string	The key ID used for disk encryption. Nota This parameter is returned only when disk encryption is enabled for the AnalyticDB for MySQL cluster.	e1935511-cf88-1123-a0f8-1be8d251****
TaskInfo	object	The task information.
Name	string	The name of the task.	ScaleUpDBCluster
Status	string	The status of the task. Valid values: NOT_RUN: The task is waiting to run. RUNNING: The task is running. SUCCEED: The task is complete.	RUNNING
Progress	string	The progress of the task, in percentage.	10
StepList	object
StepList	array<object>	The steps of the task.
	object	The details of a step.
StepName	string	The name of the step.	PrepareResources
StepDesc	string	The description of the step.	Prepare resources
StepStatus	string	The status of the step. Valid values: NOT_RUN: The step is waiting to run. RUNNING: The step is running. SUCCEED: The step is complete.	RUNNING
StepProgress	string	The progress of the step, in percentage.	50
StartTime	string	The start time of the step. The time is in the `yyyy-MM-ddThh:mm:ssZ` format and is displayed in UTC.	2024-03-10T09:28:34Z
EndTime	string	The end time of the step. The time is in the `yyyy-MM-ddThh:mm:ssZ` format and is displayed in UTC.	2024-03-10T10:28:34Z
UserENIVpcId	string	The VPC information of the ENI.	vpc-rj9hnedlfm645uj******
UserENIVSwitchOptions	string	The vSwitch IDs for the ENI. Multiple IDs are separated by commas (,).	vsw-rj9ixufmywqq98z****,vsw-rj95ij6wcz656v7****
UserENIZoneOptions	string	The zone IDs for the ENI. Multiple IDs are separated by commas (,).	cn-hangzhou-k,cn-hangzhou-h
SecondaryZoneId	string	The ID of the secondary zone.	cn-hangzhou-k
SecondaryVSwitchId	string	The ID of the secondary vSwitch.	vsw-8vbl7kfaxxxxx
DiskEncryption	boolean	Indicates whether disk encryption is enabled. Valid values: true: Disk encryption is enabled. false: Disk encryption is not enabled.	false
ClickhouseEngineCacheSize	integer	The cache size of the ClickHouse wide table engine, in GB. A value of -1 indicates that the wide table engine is disabled.	100
AINodeSpec	string	The specifications of the AI nodes.	ADB.MLGrand.5

Exemplos

Resposta de sucesso

JSON formato

{
  "RequestId": "A5C433C2-001F-58E3-99F5-3274C14DF8BD",
  "Items": {
    "DBCluster": [
      {
        "CreationTime": "2022-07-01T09:50:18Z",
        "Expired": "false",
        "MaintainTime": "04:00Z-05:00Z",
        "PayType": "Prepaid",
        "Tags": {
          "Tag": [
            {
              "Key": "tag1",
              "Value": "test1"
            }
          ]
        },
        "Mode": "flexible",
        "Port": 3306,
        "LockMode": "ManualLock",
        "EngineVersion": "3.1.16",
        "StorageResource": "24ACU",
        "DBClusterId": "amv-wz9509beptiz****",
        "ConnectionString": "amv-wz9509beptiz****.ads.aliyuncs.com",
        "DBClusterType": "Common",
        "CommodityCode": "ads_pre",
        "ExpireTime": "2022-10-01T09:50:18Z",
        "LockReason": "instance_expire",
        "VPCId": "vpc-bp13h7uzhulpu****",
        "ComputeResource": "16ACU",
        "RegionId": "cn-hangzhou",
        "VSwitchId": "vsw-uf629gydd54ld****",
        "DBVersion": "5.0",
        "DBClusterStatus": "Running",
        "ResourceGroupId": "rg-acfmyiu4ekp****",
        "DBClusterNetworkType": "VPC",
        "DBClusterDescription": "adb_test",
        "UserENIStatus": false,
        "ZoneId": "cn-hangzhou-h",
        "Engine": "AnalyticDB",
        "ReservedACU": "24ACU",
        "ComputeResourceTotal": "48ACU",
        "StorageResourceTotal": "24ACU",
        "SupportedFeatures": {
          "key": "预留参数，不涉及。"
        },
        "ProductForm": "Reserved parameter. Not applicable.",
        "ReservedNodeSize": "Reserved parameter. Not applicable.",
        "ReservedNodeCount": 0,
        "ClickhouseEngineEnabled": true,
        "AINodeNumber": 3,
        "ProductVersion": "BasicVersion",
        "KmsId": "e1935511-cf88-1123-a0f8-1be8d251****",
        "TaskInfo": {
          "Name": "ScaleUpDBCluster",
          "Status": "RUNNING",
          "Progress": "10",
          "StepList": {
            "StepList": [
              {
                "StepName": "PrepareResources",
                "StepDesc": "Prepare resources",
                "StepStatus": "RUNNING",
                "StepProgress": "50",
                "StartTime": "2024-03-10T09:28:34Z",
                "EndTime": "2024-03-10T10:28:34Z"
              }
            ]
          }
        },
        "UserENIVpcId": "vpc-rj9hnedlfm645uj******",
        "UserENIVSwitchOptions": "vsw-rj9ixufmywqq98z******,vsw-rj95ij6wcz656v7******",
        "UserENIZoneOptions": "cn-hangzhou-k,cn-hangzhou-h",
        "SecondaryZoneId": "cn-hangzhou-k",
        "SecondaryVSwitchId": "vsw-8vbl7kfaxxxxx",
        "DiskEncryption": false,
        "ClickhouseEngineCacheSize": 100,
        "AINodeSpec": "ADB.MLGrand.5"
      }
    ]
  }
}

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.	The specified DBClusterId parameter does not exist. Make sure that the DBClusterId value is valid.

Consulte Códigos de Erro para uma lista completa.

Notas de versão

Consulte Notas de Versão para uma lista completa.