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

Consulta uma lista de clusters do PolarDB ou os detalhes de clusters com autorização do RAM.

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

list

*DBCluster

acs:polardb:{#regionId}:{#accountId}:dbcluster/{#DbClusterId}

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 consultar as regiões disponíveis.	cn-hangzhou
DBClusterIds	string	Não	Os IDs dos clusters. Separe vários IDs de clusters com vírgulas (,).	pc-****************
DBClusterDescription	string	Não	A descrição do cluster. Há suporte para correspondência 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. Para valores válidos, consulte a Tabela de 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 para a lista. O valor Simple indica o modo simplificado, no qual apenas os metadados básicos dos clusters são retornados. Nota Se este parâmetro não for especificado, o modo detalhado será usado por padrão e as informações detalhadas dos clusters serão retornadas.	Simple
DBVersion	string	Não	A versão do banco de dados.	5.6
RecentCreationInterval	integer	Não	Filtra os clusters criados nos últimos N dias. Valores válidos: 0 a 15.	7
RecentExpirationInterval	integer	Não	Filtra os clusters que expiram em N dias. Valores válidos: 0 a 15.	6
Expired	boolean	Não	Especifica se o cluster expirou. Valores válidos: true false	true
PageSize	integer	Não	O número de entradas por 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 positivo que não exceda 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
Key	string	Não	A chave da tag. Você pode filtrar a lista de clusters com base em tags. Você pode especificar até 20 pares de chave-valor de tag. O número n em cada par de chave-valor de tag deve ser exclusivo e deve ser um número inteiro consecutivo começando em 1. O valor de Tag.n.Key é Tag.n.Value. Nota A chave da tag pode ter até 64 caracteres e não pode começar com `aliyun`, `acs:`, `http://` ou `https://`.	MySQL
Value	string	Não	O valor da tag que corresponde à chave da tag. Nota O valor da tag pode ter até 64 caracteres e não pode começar com `aliyun`, `acs:`, `http://` ou `https://`.	5.6
PayType	string	Não	O método de cobrança. Valores válidos: Postpaid: pós-pago. Prepaid: assinatura.	Postpaid
DBNodeIds	string	Não	Os IDs dos nós. Você pode especificar vários IDs de nós e separá-los com vírgulas (,).	pi-***************

Elementos de resposta

Elemento	Tipo	Descrição	Exemplo
	object
TotalRecordCount	integer	O número total de entradas.	16
PageRecordCount	integer	O número de clusters retornados 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	object
DBCluster	array<object>	A lista de clusters.
	array<object>
VpcId	string	O ID da VPC.	vpc-****************
VswitchId	string	O ID do vSwitch.	vsw-***************
ExpireTime	string	O horário de expiração do cluster. Nota Um valor específico é retornado apenas para clusters cujo método de cobrança é Prepaid (assinatura). Para clusters Postpaid (pós-pago), um valor vazio é retornado. O horário de expiração está no formato padrão ISO 8601 yyyy-MM-ddTHH:mm:ssZ em UTC.	2020-11-14T16:00:00Z
Expired	string	Indica se o cluster expirou. Valores válidos: true false Nota Este parâmetro é retornado apenas para clusters cujo método de cobrança é Prepaid (assinatura).	false
DBNodeNumber	integer	O número de nós.	2
CreateTime	string	O horário de criação do cluster. O horário está no formato padrão ISO 8601 yyyy-MM-ddTHH:mm:ssZ em UTC.	2020-08-14T05:58:42Z
PayType	string	O método de cobrança. Valores válidos: Postpaid: pós-pago. Prepaid: assinatura.	Prepaid
StoragePayType	string	O método de cobrança de armazenamento. Valores válidos: Postpaid: método de cobrança pós-pago com base na capacidade de armazenamento. Prepaid: assinatura com base no espaço de armazenamento.	Prepaid
ServerlessType	string	O tipo Serverless. O valor AgileServerless indica que o cluster é um cluster Serverless. Um valor vazio indica que o cluster é um dos clusters comuns.	AgileServerless
StrictConsistency	string	Indica se a forte consistência de dados entre zonas está ativada para o cluster. Valores válidos: ON: A forte consistência de dados entre zonas está ativada. Isso se aplica à Standard Edition em uma implantação de três zonas. OFF: A forte consistência de dados entre zonas está desativada.	ON
DBNodeClass	string	As especificações do nó.	polar.mysql.x4.large
Tags	object
Tag	array<object>	A lista de tags.
	object
Key	string	A chave da tag.	MySQL
Value	string	O valor da tag.	5.6
DBType	string	O tipo de banco de dados.	MySQL
LockMode	string	O status de bloqueio do cluster. Valores válidos: Unlock: Normal. ManualLock: O cluster está bloqueado manualmente. LockByExpiration: O cluster é bloqueado automaticamente devido à expiração.	Unlock
DBNodes	object
DBNode	array<object>	A lista de nós.
	object
DBNodeClass	string	As especificações do nó.	polar.mysql.x4.large
ZoneId	string	O ID da zona.	cn-hangzhou-i
DBNodeRole	string	A função do nó. Valores válidos: Writer: nó primário. Reader: nó somente leitura. ColumnReader: nó somente leitura de column store. AI: nó de IA.	Reader
DBNodeId	string	O ID do nó.	pi-****************
RegionId	string	O ID da região.	cn-hangzhou
Serverless	string	Indica se o recurso Serverless está ativado para o nó atual. O valor ON indica que o recurso Serverless está ativado. Um valor vazio indica que o recurso Serverless está desativado.	ON
ImciSwitch	string	Indica se o recurso In-Memory Column Index (IMCI) está ativado. Valores válidos: ON: ativado. OFF: desativado. Valores válidos: OFF : Desativa o recurso In-Memory Column Index (IMCI). ON : Ativa o recurso In-Memory Column Index (IMCI).	OFF
HotReplicaMode	string	Indica se o recurso de hot standby está ativado. Valores válidos: ON: ativado. OFF: desativado.	OFF
RegionId	string	O ID da região.	cn-hangzhou
DeletionLock	integer	O status de proteção contra exclusão do cluster. Valores válidos: 0: desbloqueado. 1: bloqueado. Nota Você não pode excluir um cluster que esteja no estado bloqueado.	0
DBVersion	string	A versão do banco de dados.	5.6
DBClusterId	string	O ID do cluster.	pc-****************
DBClusterStatus	string	O status do cluster.	Running
ResourceGroupId	string	O ID do grupo de recursos.	rg-************
SearchStorageUsed	integer	O uso de armazenamento do nó Search.	89227945573
StorageSpace	integer	A capacidade de armazenamento para o método de cobrança de assinatura com base no espaço. Unidade: bytes.	50
DBClusterNetworkType	string	O tipo de rede do cluster.	VPC
DBClusterDescription	string	A descrição do cluster.	GDN-1
ZoneId	string	O ID da zona.	cn-hangzhou-i
Engine	string	O mecanismo do cluster.	POLARDB
Category	string	A edição do cluster. Valores válidos: Normal: Cluster Edition. Basic: Single Node Edition. Archive: X-Engine. NormalMultimaster: Multi-master Cluster (Database/Table).	Normal
AiType	string	O status do nó de IA. Valores válidos: SearchNode: nó de pesquisa. DLNode: nó de IA. Valores válidos: SearchNode\|DLNode : Ambos. DLNode : DLNode. SearchNode : SearchNode.	SearchNode
CpuCores	string	O número de núcleos de CPU.	1
MemorySize	string	O tamanho da memória do nó. Unidade: MB.	2048
StorageType	string	O tipo de armazenamento. Valores válidos para a Enterprise Edition: HighPerformance: PSL5. Standard: PSL4. Valores válidos para a Standard Edition: essdpl0 essdpl1 essdpl2 essdpl3 essdautopl	essdautopl
HotStandbyCluster	string	O cluster de armazenamento hot standby. Valores válidos: ON: ativado. OFF: desativado.	OFF
SubCategory	string	O tipo de especificação do nó de computação. Valores válidos: Exclusive: Dedicado. General: Uso geral.	Exclusive
StorageUsed	integer	A capacidade de armazenamento utilizada do cluster. Unidade: bytes.	3009413120
RemoteMemorySize	string	O tamanho da memória remota. Unidade: MB.	3612
ConnectionResourceQuota	integer	A cota para recursos de conexão (exclusivo para AgenticDB).	0
ConnectionResourceUsed	integer	Os recursos de conexão usados pelo AgenticDB.	0

Exemplos

Resposta de sucesso

JSON formato

{
  "TotalRecordCount": 16,
  "PageRecordCount": 5,
  "RequestId": "9B7BFB11-C077-4FE3-B051-F69CEB******",
  "PageNumber": 12,
  "Items": {
    "DBCluster": [
      {
        "VpcId": "vpc-****************",
        "VswitchId": "vsw-***************",
        "ExpireTime": "2020-11-14T16:00:00Z",
        "Expired": "false",
        "DBNodeNumber": 2,
        "CreateTime": "2020-08-14T05:58:42Z",
        "PayType": "Prepaid",
        "StoragePayType": "Prepaid",
        "ServerlessType": "AgileServerless",
        "StrictConsistency": "ON",
        "DBNodeClass": "polar.mysql.x4.large",
        "Tags": {
          "Tag": [
            {
              "Key": "MySQL",
              "Value": "5.6"
            }
          ]
        },
        "DBType": "MySQL",
        "LockMode": "Unlock",
        "DBNodes": {
          "DBNode": [
            {
              "DBNodeClass": "polar.mysql.x4.large",
              "ZoneId": "cn-hangzhou-i",
              "DBNodeRole": "Reader",
              "DBNodeId": "pi-****************",
              "RegionId": "cn-hangzhou",
              "Serverless": "ON",
              "ImciSwitch": "OFF",
              "HotReplicaMode": "OFF"
            }
          ]
        },
        "RegionId": "cn-hangzhou",
        "DeletionLock": 0,
        "DBVersion": "5.6",
        "DBClusterId": "pc-****************",
        "DBClusterStatus": "Running",
        "ResourceGroupId": "rg-************",
        "SearchStorageUsed": 89227945573,
        "StorageSpace": 50,
        "DBClusterNetworkType": "VPC",
        "DBClusterDescription": "GDN-1",
        "ZoneId": "cn-hangzhou-i",
        "Engine": "POLARDB",
        "Category": "Normal",
        "AiType": "SearchNode",
        "CpuCores": "1",
        "MemorySize": "2048",
        "StorageType": "essdautopl",
        "HotStandbyCluster": "OFF",
        "SubCategory": "Exclusive",
        "StorageUsed": 3009413120,
        "RemoteMemorySize": "3612",
        "ConnectionResourceQuota": 0,
        "ConnectionResourceUsed": 0
      }
    ]
  }
}

Códigos de erro

Código de status HTTP	Código de erro	Mensagem de erro	Descrição
400	InvalidRegionId.Malformed	The specified parameter RegionId is not valid.	O parâmetro RegionId especificado é inválido.
400	NumberExceed.Tags	The Tags parameter's number is exceed.	A operação falhou porque o número de parâmetros de tag excede o valor válido. Valor válido: 20.
400	InvalidPageSize.Malformed	The specified parameter PageSize is not valid.	O parâmetro PageSize especificado é inválido.
400	InvalidPageNumber.Malformed	The specified parameter PageNumber is not valid.	O parâmetro PageNumber especificado é inválido.
400	InvalidRecentCreationInterval.Malformed	The specified parameter RecentCreationInterval is not valid.	O parâmetro RecentCreationInterval especificado é inválido.
400	InvalidRecentExpirationInterval.Malformed	The specified parameter RecentExpirationInterval is not valid.	O parâmetro RecentExpirationInterval especificado é inválido.
500	InternalError	The request processing has failed due to some unknown error, exception or failure.	O processamento da solicitação falhou devido a um erro, exceção ou falha desconhecida.
404	DBTypeOrDBVersion.Malformed	The specified DBType does not match DBVersion.	O DBType especificado não corresponde ao DBVersion.
503	ServiceUnavailable	The request has failed due to a temporary failure of the server.	A solicitação falhou devido a uma falha temporária do servidor.

Consulte Códigos de Erro para uma lista completa.

Notas de versão

Consulte Notas de Versão para uma lista completa.