DescribeDBClustersZonal - PolarDB: Central de Documentação do Alibaba Cloud

Lista os clusters PolarDB no MyBase.

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

polardb:DescribeDBClustersZonal

list

*All Resource

*

Nenhuma

Sintaxe da solicitação

GET  HTTP/1.1

Parâmetros da solicitação

Parâmetro	Tipo	Obrigatório	Descrição	Exemplo
RegionId	string	Sim	O ID da região.	cn-hangzhou
DBClusterIds	string	Não	O ID do cluster. Para especificar vários IDs de cluster, separe-os com vírgulas (,).	pc-****************
DBClusterDescription	string	Não	A descrição do cluster. Há suporte para pesquisa aproximada.	pc-****************
ConnectionString	string	Não	O endpoint do banco de dados.	********.rwlb.polardb-pg-public.rds.aliyuncs.com
DBClusterStatus	string	Não	O status do cluster.	Running
DBType	string	Não	O tipo de banco de dados. Valores válidos: MySQL PostgreSQL Oracle	MySQL
DescribeType	string	Não	O modo de consulta. Defina o valor como Simple. Neste modo, apenas os metadados básicos dos clusters são retornados.	Simple
DBVersion	string	Não	A versão do banco de dados.	5.6
RecentCreationInterval	integer	Não	Filtra clusters criados nos últimos N dias. Valores válidos: 0 a 15.	7
RecentExpirationInterval	integer	Não	Filtra clusters que expiram em N dias. Valores válidos: 0 a 15.	6
Expired	string	Não	Especifica se o cluster expirou. Valores válidos: true false	true
PageSize	integer	Não	O número de entradas a serem retornadas em cada página. Valores válidos: 30, 50 e 100. Valor padrão: 30.	30
PageNumber	integer	Não	O número da página. O valor deve ser um número inteiro maior que 0 e não exceder o valor máximo do tipo de dados Integer. Valor padrão: 1.	10
ResourceGroupId	string	Não	O ID do grupo de recursos.	rg-**********
Tag	array<object>	Não	A lista de tags.
	object	Não
Value	string	Não	O valor da tag.	5.6
Key	string	Não	A chave da tag n. Você pode filtrar clusters especificando até 20 tags. O n deve ser um número inteiro exclusivo e consecutivo que começa em 1. Tag.n.Key corresponde a Tag.n.Value.	MySQL
PayType	string	Não	O método de cobrança. Valores válidos: Postpaid: pago conforme o uso Prepaid: assinatura	Postpaid
DBNodeIds	string	Não	O ID do nó. Você pode especificar vários IDs de nó. Separe-os com vírgulas (,).	pi-***************
CloudProvider	string	Não	O provedor de serviços em nuvem.	AlibabaCloud
MaxResults	integer	Não	O número máximo de entradas a serem retornadas para a solicitação atual. Valor padrão: 10.	10
NextToken	string	Não	Um token usado para recuperar a próxima página de resultados. Defina este parâmetro com o valor NextToken retornado da chamada de API anterior. Você não precisa especificar este parâmetro na primeira chamada.	212db86sca4384811e0b5e8707e******

Elementos de resposta

Elemento	Tipo	Descrição	Exemplo
	object
TotalRecordCount	integer	O número total de registros.	16
PageRecordCount	integer	O número de clusters na página atual.	5
RequestId	string	O ID da solicitação.	9B7BFB11-C077-4FE3-B051-F69CEB******
PageNumber	integer	O número da página.	12
Items	array<object>	A lista de clusters.
	array<object>
Category	string	A edição do cluster. Há suporte para as seguintes edições: Normal: Cluster Edition Basic: nó único Archive: X-Engine NormalMultimaster: Cluster Multi-master (Banco de dados/Tabela)	Normal
DBClusterId	string	O ID do cluster.	pc-****************
DBType	string	O tipo de banco de dados.	MySQL
CentralControlRegionId	string	O ID da região de controle central.	cn-beijing
DBVersion	string	A versão do banco de dados.	5.6
CloudProvider	string	O provedor de serviços em nuvem.	ENS
Tags	array<object>	A lista de tags.
	object
Value	string	The tag value.	5.6
Key	string	The tag key.	MySQL
StorageType	string	A classe de armazenamento do cluster Standard Edition. Valores válidos: essdpl0 essdpl1 essdpl2 essdpl3 essdautopl	essdautopl
ZoneId	string	O ID da zona.	cn-hangzhou-i
DBClusterStatus	string	O status do cluster.	Running
CreateTime	string	A hora de criação.	2020-08-14T05:58:42Z
DBClusterDescription	string	A descrição do cluster.	GDN-1
Expired	string	Indica se o cluster expirou. Valores válidos: true false	false
PayType	string	O método de cobrança. Valores válidos: Postpaid: pago conforme o uso. Prepaid: assinatura.	Prepaid
LockMode	string	O estado de bloqueio do cluster. Valores válidos: Unlock: Normal. ManualLock: O cluster está bloqueado manualmente. LockByExpiration: O cluster é bloqueado automaticamente após a expiração.	Unlock
VswitchId	string	O ID do vSwitch.	vsw-***************
StrictConsistency	string	Indica se a consistência forte está ativada para dados em várias zonas. Valores válidos: ON: A consistência forte está ativada. Isso se aplica a clusters da Standard Edition implantados em três zonas. OFF: A consistência forte não está ativada.	ON
DBNodeClass	string	As especificações do nó.	polar.mysql.g1.tiny.c
StorageUsed	integer	O espaço de armazenamento utilizado do cluster. Unidade: bytes.	3009413120
ENSRegionId	string	O ID da região ENS.	sg-singapore-9
DBNodeNumber	integer	O número de nós.	2
VpcId	string	O ID da nuvem privada virtual (VPC).	vpc-****************
StorageSpace	integer	A capacidade de armazenamento da instância.	10
ServerlessType	string	O tipo Serverless. AgileServerless indica que o cluster é um cluster Serverless. Um valor vazio indica que o cluster é um cluster comum.	AgileServerless
AiType	string	O tipo de nó de IA. Valores válidos: SearchNode: nó de pesquisa DLNode: nó de IA	SearchNode
CpuCores	string	O número de núcleos de CPU.	1
SubCategory	string	O tipo de especificação do nó de computação. Valores válidos: Exclusive: Dedicado General: Uso geral	Exclusive
ExpireTime	string	O horário de expiração do cluster. Nota Este parâmetro é retornado apenas para clusters Prepaid (assinatura). Para clusters Postpaid (pago conforme o uso), este parâmetro está vazio.	2022-09-14T16:00:00Z
MaxResults	integer	O número máximo de entradas retornadas para a solicitação atual. Valor padrão: 10.	10
NextToken	string	O token para recuperar a próxima página de resultados. Se houver mais resultados disponíveis, este parâmetro será retornado. Para recuperar a próxima página, inclua este token na sua próxima solicitação. Se todos os resultados tiverem sido retornados, este parâmetro não será retornado.	212db86sca4384811e0b5e8707e******

Exemplos

Resposta de sucesso

JSON formato

{
  "TotalRecordCount": 16,
  "PageRecordCount": 5,
  "RequestId": "9B7BFB11-C077-4FE3-B051-F69CEB******",
  "PageNumber": 12,
  "Items": [
    {
      "Category": "Normal",
      "DBClusterId": "pc-****************",
      "DBType": "MySQL",
      "CentralControlRegionId": "cn-beijing",
      "DBVersion": "5.6",
      "CloudProvider": "ENS",
      "Tags": [
        {
          "Value": "5.6",
          "Key": "MySQL"
        }
      ],
      "StorageType": "essdautopl",
      "ZoneId": "cn-hangzhou-i",
      "DBClusterStatus": "Running",
      "CreateTime": "2020-08-14T05:58:42Z",
      "DBClusterDescription": "GDN-1",
      "Expired": "false",
      "PayType": "Prepaid",
      "LockMode": "Unlock",
      "VswitchId": "vsw-***************",
      "StrictConsistency": "ON",
      "DBNodeClass": "polar.mysql.g1.tiny.c",
      "StorageUsed": 3009413120,
      "ENSRegionId": "sg-singapore-9",
      "DBNodeNumber": 2,
      "VpcId": "vpc-****************",
      "StorageSpace": 10,
      "ServerlessType": "AgileServerless",
      "AiType": "SearchNode",
      "CpuCores": "1",
      "SubCategory": "Exclusive",
      "ExpireTime": "2022-09-14T16:00:00Z"
    }
  ],
  "MaxResults": 10,
  "NextToken": "212db86sca4384811e0b5e8707e******"
}

Códigos de erro

Consulte Códigos de Erro para uma lista completa.

Notas de versão

Consulte Notas de Versão para uma lista completa.