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

Depuração

O OpenAPI Explorer calcula automaticamente o valor da assinatura. Para sua conveniência, recomendamos que você chame esta operação no OpenAPI Explorer. O OpenAPI Explorer gera dinamicamente o código de exemplo da operação para diferentes SDKs.

Parâmetros de solicitação

Parâmetro	Tipo	Obrigatório	Exemplo	Descrição
Action	String	Sim	DescribeDBClusters	A operação a ser executada. Defina o valor como DescribeDBClusters.
RegionId	String	Sim	cn-hangzhou	O ID da região do cluster. Chame a operação DescribeRegions para consultar a lista de regiões mais recente.
DBClusterIds	String	Não	cc-bp108z124a8o7****	O ID do cluster. Nota Se este parâmetro não for especificado, todos os clusters serão consultados por padrão.
DBClusterDescription	String	Não	cc-bp108z124a8o7****	A descrição do cluster.
DBClusterStatus	String	Não	Running	O estado do cluster. Valores válidos: Preparing: O cluster está sendo preparado. Creating: O cluster está sendo criado. Running: O cluster está em execução. Deleting: O cluster está sendo excluído. SCALING_OUT: O cluster está passando por scale-out.
PageSize	Integer	Não	30	O número de entradas a serem retornadas em cada página. Valor padrão: 30. Valores válidos: 30 50 100
PageNumber	Integer	Não	1	O número da página a ser retornada.
Tag.N.Key	String	Não	department	O nome da tag.
Tag.N.Value	String	Não	it	O valor da tag.

Parâmetros de resposta

Parâmetro	Tipo	Exemplo	Descrição
TotalCount	Integer	1	O número total de entradas retornadas.
PageSize	Integer	30	O número de entradas retornadas em cada página. Valor padrão: 30. Valores válidos: 30 50 100
RequestId	String	F5178C10-1407-4987-9133-DE4DC9119F75	O ID da solicitação.
PageNumber	Integer	1	O número da página retornada.
DBClusters	Array of DBCluster		Os detalhes sobre os clusters retornados.
DBCluster
VpcId	String	vpc-bp175iuvg8nxqraf2****	O ID da Virtual Private Cloud (VPC) à qual o cluster está conectado.
DBNodeCount	Long	2	O número de nós. Para clusters da Edição de Réplica Única, o valor varia de 1 a 48. Para clusters da Edição de Réplica Dupla, o valor varia de 1 a 24.
CreateTime	String	2021-10-28T07:24:45Z	O horário de criação do cluster. O horário segue o formato yyyy-MM-ddTHH:mm:ssZ.
PayType	String	Postpaid	O método de faturamento do cluster. Valores válidos: Postpaid: O cluster utiliza o método de pagamento conforme o uso. Prepaid: O cluster utiliza o método de faturamento por assinatura.
Tags	Array of Tag		Os detalhes sobre as tags retornadas.
Tag
Key	String	department	O nome da tag.
Value	String	it	O valor da tag.
StorageType	String	CloudESSD	O tipo de armazenamento do cluster. Valores válidos: CloudESSD: O cluster utiliza um ESSD (SSD aprimorado) de nível de desempenho (PL) 1. CloudESSD_PL2: O cluster utiliza um ESSD de PL2. CloudESSD_PL3: O cluster utiliza um ESSD de PL3. CloudEfficiency: O cluster utiliza um disco ultra.
Port	Integer	8123	O número da porta HTTP.
LockMode	String	Unlock	O estado de bloqueio do cluster. Valores válidos: Unlock: O cluster não está bloqueado. ManualLock: O cluster foi bloqueado manualmente. LockByExpiration: O cluster foi bloqueado automaticamente devido à expiração. LockByRestoration: O cluster foi bloqueado automaticamente pois está prestes a ser revertido. LockByDiskQuota: O cluster foi bloqueado automaticamente porque o espaço em disco se esgotou.
Bid	String	26842	O ID do site. Valores válidos: 26842: o site da China (aliyun.com) 26888: o site Internacional (alibabacloud.com)
IsExpired	String	false	Indica se o cluster expirou. Valores válidos: true: O cluster expirou. false: O cluster não expirou.
VpcCloudInstanceId	String	vpc-bp175iuvg8nxqraf2****	O ID da VPC.
ScaleOutStatus	Object		O status da tarefa de migração de dados.
Progress	String	0	O progresso da tarefa de migração de dados em porcentagem. Nota Este parâmetro é retornado apenas quando o cluster está no estado SCALING_OUT.
Ratio	String	0MB/60469MB	O progresso da tarefa de migração de dados. Este valor é exibido no seguinte formato: Volume de dados migrados/Volume total de dados. Nota Este parâmetro é retornado apenas quando o cluster está no estado SCALING_OUT.
DBClusterId	String	cc-bp108z124a8o7****	O ID do cluster.
ConnectionString	String	cc-bp1fs5o051c61****.clickhouse.ads.aliyuncs.com	O endpoint usado para conectar-se ao cluster via VPC.
CommodityCode	String	clickhouse_go_public_cn	O código da mercadoria do cluster.
ExpireTime	String	2011-05-30T12:11:4Z	O horário de expiração do cluster. O horário segue o formato yyyy-MM-ddTHH:mm:ssZ. Nota Clusters com pagamento conforme o uso nunca expiram. Se o cluster utilizar esse método de faturamento, uma string vazia será retornada para este parâmetro.
DBNodeStorage	Long	100	A capacidade de armazenamento de um único nó. Valores válidos: 100 a 32000. Unidade: GB. Nota Este valor é um múltiplo de 100.
DBNodeClass	String	C8	A especificação do cluster. Para clusters da Edição de Réplica Única, os seguintes valores são válidos: S4: 4 núcleos, 16 GB. S8: 8 núcleos, 32 GB. S16: 16 núcleos, 64 GB. S32: 32 núcleos, 128 GB. S64: 64 núcleos, 256 GB. S104: 104 núcleos, 384 GB. Para clusters da Edição de Réplica Dupla, os seguintes valores são válidos: C4: 4 núcleos, 16 GB. C8: 8 núcleos, 32 GB. C16: 16 núcleos, 64 GB. C32: 32 núcleos, 128 GB. C64: 64 núcleos, 256 GB. C104: 104 núcleos, 384 GB.
AliUid	String	140692647406****	O ID da conta Alibaba Cloud.
LockReason	String	DISK_FULL	O motivo pelo qual o cluster está bloqueado. Nota Se o valor do parâmetro LockMode for Unlock, uma string vazia será retornada para este parâmetro.
RegionId	String	cn-hangzhou	O ID da região do cluster.
VSwitchId	String	vsw-bp1gzt31twhlo0sa5****	O ID do vSwitch.
DBClusterStatus	String	Running	O estado do cluster. Valores válidos: Preparing: O cluster está sendo preparado. Creating: O cluster está sendo criado. Running: O cluster está em execução. Deleting: O cluster está sendo excluído. SCALING_OUT: O cluster está passando por scale-out.
DBClusterDescription	String	test	A descrição do cluster.
DBClusterNetworkType	String	VPC	O tipo de rede do cluster. Apenas VPC é suportada.
ZoneId	String	cn-hangzhou-h	O ID da zona.
Category	String	Basic	A edição do cluster. Valores válidos: Basic: a Edição de Réplica Única HighAvailability: a Edição de Réplica Dupla
ControlVersion	String	v1	O número da versão do console do ApsaraDB for ClickHouse usado para gerenciar o cluster. Valores válidos: v1 v2

Exemplos

Exemplos de solicitações

http(s)://clickhouse.aliyuncs.com/?Action=DescribeDBClusters
&RegionId=cn-hangzhou
&<Common request parameters>

Exemplos de respostas de sucesso

Formato XML

HTTP/1.1 200 OK
Content-Type:application/xml

<DescribeDBClustersResponse>
    <TotalCount>1</TotalCount>
    <PageSize>30</PageSize>
    <RequestId>F5178C10-1407-4987-9133-DE4DC9119F75</RequestId>
    <PageNumber>1</PageNumber>
    <DBClusters>
        <VpcId>vpc-bp175iuvg8nxqraf2****</VpcId>
        <DBNodeCount>2</DBNodeCount>
        <CreateTime>2021-10-28T07:24:45Z</CreateTime>
        <PayType>Postpaid</PayType>
        <Tags>
            <Key>department</Key>
            <Value>it</Value>
        </Tags>
        <StorageType>CloudESSD</StorageType>
        <Port>8123</Port>
        <LockMode>Unlock</LockMode>
        <Bid>26842</Bid>
        <IsExpired>false</IsExpired>
        <VpcCloudInstanceId>vpc-bp175iuvg8nxqraf2****</VpcCloudInstanceId>
        <ScaleOutStatus>
            <Progress>0</Progress>
            <Ratio>0MB/60469MB</Ratio>
        </ScaleOutStatus>
        <DBClusterId>cc-bp108z124a8o7****</DBClusterId>
        <ConnectionString>cc-bp1fs5o051c61****.clickhouse.ads.aliyuncs.com</ConnectionString>
        <CommodityCode>clickhouse_go_public_cn</CommodityCode>
        <ExpireTime>2011-05-30T12:11:4Z</ExpireTime>
        <DBNodeStorage>100</DBNodeStorage>
        <DBNodeClass>C8</DBNodeClass>
        <AliUid>140692647406****</AliUid>
        <LockReason>DISK_FULL</LockReason>
        <RegionId>cn-hangzhou</RegionId>
        <VSwitchId>vsw-bp1gzt31twhlo0sa5****</VSwitchId>
        <DBClusterStatus>Running</DBClusterStatus>
        <DBClusterDescription>test</DBClusterDescription>
        <DBClusterNetworkType>VPC</DBClusterNetworkType>
        <ZoneId>cn-hangzhou-h</ZoneId>
        <Category>Basic</Category>
        <ControlVersion>v1</ControlVersion>
    </DBClusters>
</DescribeDBClustersResponse>

Formato JSON

HTTP/1.1 200 OK
Content-Type:application/json

{
  "TotalCount" : 1,
  "PageSize" : 30,
  "RequestId" : "F5178C10-1407-4987-9133-DE4DC9119F75",
  "PageNumber" : 1,
  "DBClusters" : [ {
    "VpcId" : "vpc-bp175iuvg8nxqraf2****",
    "DBNodeCount" : 2,
    "CreateTime" : "2021-10-28T07:24:45Z",
    "PayType" : "Postpaid",
    "Tags" : [ {
      "Key" : "department",
      "Value" : "it"
    } ],
    "StorageType" : "CloudESSD",
    "Port" : 8123,
    "LockMode" : "Unlock",
    "Bid" : "26842",
    "IsExpired" : "false",
    "VpcCloudInstanceId" : "vpc-bp175iuvg8nxqraf2****",
    "ScaleOutStatus" : {
      "Progress" : "0",
      "Ratio" : "0MB/60469MB"
    },
    "DBClusterId" : "cc-bp108z124a8o7****",
    "ConnectionString" : "cc-bp1fs5o051c61****.clickhouse.ads.aliyuncs.com",
    "CommodityCode" : "clickhouse_go_public_cn",
    "ExpireTime" : "2011-05-30T12:11:4Z",
    "DBNodeStorage" : 100,
    "DBNodeClass" : "C8",
    "AliUid" : "140692647406****",
    "LockReason" : "DISK_FULL",
    "RegionId" : "cn-hangzhou",
    "VSwitchId" : "vsw-bp1gzt31twhlo0sa5****",
    "DBClusterStatus" : "Running",
    "DBClusterDescription" : "test",
    "DBClusterNetworkType" : "VPC",
    "ZoneId" : "cn-hangzhou-h",
    "Category" : "Basic",
    "ControlVersion" : "v1"
  } ]
}

Códigos de erro

HttpCode	Código de erro	Mensagem de erro	Descrição
500	InternalError	An error occurred while processing your request.	A mensagem de erro retornada porque ocorreu um erro interno. Tente novamente mais tarde.
503	ServiceUnavailable	An error occurred while processing your request.	A mensagem de erro retornada porque o serviço está indisponível. Tente novamente mais tarde.

Para obter uma lista de códigos de erro, consulte Códigos de erro do serviço.