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

Consulta as informações de atributos de um cluster.

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

get

*DBCluster.

acs:polardb:{#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. Nota Você pode chamar a operação DescribeDBClusters para consultar os detalhes de todos os clusters em sua conta, incluindo o ID do cluster.	pc-*****************
DescribeType	string	Não	Especifica se devem ser obtidas informações de nós relacionadas à IA.	AI

Elementos de resposta

Elemento	Tipo	Descrição	Exemplo
	object
DeletionLock	integer	O status de bloqueio da exclusão do cluster. Valores válidos: 0: Desbloqueado. O cluster pode ser excluído. 1: Bloqueado. O cluster não pode ser excluído.	0
Category	string	A edição do produto. Valores válidos: Normal: Edição Cluster Basic: Edição Nó Único Archive: Edição PolarDB X-Engine NormalMultimaster: Edição Cluster Multi-master SENormal: Edição Standard do PolarDB for MySQL Nota O PolarDB for PostgreSQL 11 não suporta a Edição Nó Único. O PolarDB for MySQL 8.0, o PolarDB for MySQL 5.7 e o PolarDB for PostgreSQL 14 suportam a Edição Standard do PolarDB for MySQL. O PolarDB for MySQL 8.0 suporta a Edição PolarDB X-Engine e a Edição Cluster Multi-master.	Normal
ResourceGroupId	string	O ID do grupo de recursos.	rg-***************
DataLevel1BackupChainSize	integer	O tamanho total dos backups de nível 1 (snapshots). Unidade: bytes.	74448896
DBClusterId	string	O ID do cluster.	pc-*****************
DBType	string	O tipo de mecanismo de banco de dados.	MySQL
DBClusterNetworkType	string	O tipo de rede do cluster.	VPC
IsLatestVersion	boolean	Indica se o cluster está executando a versão mais recente do kernel. Valores válidos:	false
HasCompleteStandbyRes	boolean	Indica se os recursos para o novo banco de dados primário são reabastecidos após um failover entre zonas. Valores válidos: true: Os recursos são reabastecidos. false: Os recursos não são reabastecidos.	false
HotStandbyCluster	string	Indica se o cluster de armazenamento standby ativo (e nós de computação Standby) está ativado. Valores válidos: StandbyClusterON: O cluster de armazenamento standby ativo e os nós de computação Standby estão ativados. StandbyClusterOFF: O cluster de armazenamento standby ativo e os nós de computação Standby estão desativados.	StandbyClusterON
DataSyncMode	string	O modo de replicação de dados. Valores válidos: AsyncSync: assíncrono SemiSync: semissíncrono	AsyncSync
StandbyHAMode	string	O modo de recuperação de desastres entre zonas. Valores válidos: ON: O modo de recuperação de desastres entre zonas está ativado. OFF: O modo de recuperação de desastres entre zonas está desativado. 0: Modo de simulação do cliente.	OFF
CompressStorageMode	string	Indica se a compactação de armazenamento está ativada. Valores válidos:	ON
StorageMax	integer	A capacidade máxima de armazenamento para as especificações atuais do cluster. Unidade: bytes.	10995116277760
DBVersion	string	A versão do mecanismo de banco de dados.	8.0
DBNodes	array<object>	As informações do nó.
	object
CreationTime	string	A hora em que o nó foi criado.	2020-03-23T21:35:43Z
FailoverPriority	integer	A prioridade de failover. Cada nó possui uma prioridade de failover que determina a probabilidade de o nó ser eleito como o nó primário durante um failover. Um valor maior indica uma prioridade mais alta. Valores válidos: 1 a 15.	1
MaxIOPS	integer	O número máximo de solicitações de I/O por segundo (IOPS).	32000
DBNodeClass	string	As especificações do nó.	polar.mysql.x4.large
CpuCores	string	O número de núcleos de CPU do nó.	2
MemorySize	string	O tamanho da memória do nó. Unidade: MB.	8192
DBNodeRole	string	A função do nó. Valores válidos:	Reader
ZoneId	string	O ID da zona.	cn-hangzhou-i
MaxConnections	integer	O número máximo de conexões simultâneas ao cluster.	8000
DBNodeStatus	string	O status do nó. Valores válidos:	Running
DBNodeId	string	O ID do nó.	pi-****************
ImciSwitch	string	Indica se o In-Memory Column Index está ativado. Valores válidos:	ON
HotReplicaMode	string	Indica se o standby quente está ativado. Valores válidos:	ON
AddedCpuCores	string	O número de núcleos de CPU adicionados pelo escalonamento automático de recursos locais.	6
MasterId	string	O ID do nó primário da Edição Multi-master Cluster.	pi-bp18z52akld3*****
SccMode	string	Indica se o recurso de consistência global (modo de alto desempenho) está ativado para o nó. Valores válidos:	ON
ServerWeight	string	O peso de roteamento.	1
ServerlessType	string	O tipo serverless do nó. Valores válidos: AgileServerless: serverless ágil. O nó é um nó serverless. SteadyServerless: serverless estável. O nó é um nó com especificações definidas que possui o recurso serverless ativado. Nota Este parâmetro é suportado apenas para clusters serverless ou clusters com especificações definidas que possuem o recurso serverless ativado. Para mais informações, consulte Serverless.	SteadyServerless
SubCluster	string	Indica se o nó está na zona primária ou na zona secundária. Este parâmetro é usado principalmente para implantações simétricas de recursos. Valores válidos: Primary: zona primária. Standby: zona secundária.	Primary
RemoteMemorySize	string	O tamanho da memória remota. Unidade: MB.	3072
Orca	string	O recurso Orca. Valores válidos:	off
MultiMasterLocalStandby	string	O nó standby local multi-master.	pi-****************
MultiMasterPrimaryNode	string	O nó primário multi-master.	pi-****************
DBNodeDescription	string	A descrição do nó.	test
SubGroupDescription	string	A descrição do subgrupo do cluster.	test Description
MirrorInsName	string	O nome da réplica quente que corresponde ao nó na arquitetura de armazenamento e computação standby quente.	pi-bp18z52mirror*****
DBNodeCXLRemoteMemory	string	A configuração de memória remota CXL.	3072
RemoteMemoryMin	integer
RemoteMemoryMax	integer
RemoteMemoryRecommended	integer
DedicatedHostModel	boolean
ZoneIds	string	O ID da zona.	cn-hangzhou-i,cn-hangzhou-g
MaintainTime	string	A janela de manutenção do cluster. O horário está no formato `HH:mmZ-HH:mmZ` (UTC). Por exemplo, `16:00Z-17:00Z` indica que a manutenção de rotina pode ser realizada das 00:00 às 01:00 (UTC+08:00).	18:00Z-19:00Z
Engine	string	O mecanismo do cluster.	POLARDB
Tags	array<object>	As informações da tag.
	object
Key	string	A chave da tag.	test
Value	string	O valor da tag.	MySQL
RequestId	string	O ID da solicitação.	074467EF-86B9-4C23-ACBF-E9B81A******
VPCId	string	O ID da VPC.	vpc-*******************
SearchClusterStatus	string	O status de execução do nó de pesquisa.	Running
VSwitchId	string	O ID do vSwitch.	vsw-*********************
DBClusterDescription	string	A descrição do cluster.	test
Expired	string	Indica se o cluster expirou.	false
PayType	string	O método de cobrança. Valores válidos:	Prepaid
StoragePayType	string	O método de cobrança para armazenamento. Valores válidos: Postpaid: pay-as-you-go. Prepaid: assinatura.	Prepaid
LockMode	string	O modo de bloqueio. Valores válidos:	Unlock
SearchStorageUsed	integer	O uso de armazenamento do nó de pesquisa.	3012558848
SearchCompressStorageUsed	integer	O tamanho dos dados de armazenamento compactado do nó de pesquisa.	15529410560
StorageSpace	integer	O espaço de armazenamento cobrado por espaço (assinatura). Unidade: bytes.	50
DBVersionStatus	string	O status da versão secundária atual. Valores válidos: Stable: A versão atual é estável. Old: A versão atual está desatualizada. Atualize para a versão mais recente. HighRisk: A versão atual possui defeitos críticos. Atualize para a versão mais recente imediatamente. Beta: A versão atual é uma versão Beta. Nota Para obter mais informações sobre como atualizar a versão secundária, consulte Atualização de versão. Este parâmetro é retornado apenas quando o tipo de mecanismo de banco de dados (DBType) é MySQL.	Stable
CreationTime	string	A hora em que o cluster foi criado.	2020-08-14T05:58:42Z
SQLSize	integer	O tamanho de armazenamento das instruções SQL. Unidade: bytes. Um valor de -1 indica que não há dados disponíveis.	0
InodeTotal	integer	O número máximo de inodes no sistema de arquivos.	6,291,456
InodeUsed	integer	O uso atual de inodes.	4,194,304
BlktagTotal	integer	O número máximo de blktags no sistema de arquivos.	7,864,320
BlktagUsed	integer	O uso atual de blktags.	5,242,880
RegionId	string	O ID da região.	cn-hangzhou
ExpireTime	string	A hora de expiração do cluster. Nota Apenas clusters cujo método de cobrança é Prepaid (assinatura) retornam um valor específico para este parâmetro. Clusters Postpaid (pago conforme o uso) retornam um valor vazio.	2020-11-14T16:00:00Z
SubCategory	string	O tipo de especificação do nó de computação. Valores válidos: Exclusive: Dedicado General: Uso geral Nota Este parâmetro é retornado apenas para clusters da Edição Cluster do PolarDB for MySQL.	Exclusive
IsProxyLatestVersion	boolean	Indica se o proxy de banco de dados é a versão mais recente. Valores válidos:	false
StorageType	string	O tipo de armazenamento. O valor é fixo como HighPerformance.	HighPerformance
ServerlessType	string	O tipo serverless do cluster. Valores válidos: AgileServerless: serverless ágil. Este valor indica um cluster serverless. SteadyServerless: serverless estável. Este valor indica um cluster com especificações definidas que possui o recurso serverless ativado. Nota Este parâmetro é suportado apenas para clusters serverless ou clusters com especificações definidas que possuem o recurso serverless ativado.	SteadyServerless
StrictConsistency	string	Indica se a forte consistência de dados multizona está ativada para o cluster. Valores válidos:	ON
ProxyCpuCores	string	O número de núcleos de CPU do proxy de banco de dados.	4
ProxyStandardCpuCores	string	O número de núcleos de CPU na configuração padrão do proxy de banco de dados.	2
ProxyType	string	O tipo do proxy de banco de dados. Valores válidos:	Exclusive
ProxyStatus	string	O status do proxy de banco de dados. Valores válidos:	Running
ProxyServerlessType	string	O tipo serverless do proxy de banco de dados. Valores válidos: AgileServerless: serverless ágil, que indica um cluster serverless. SteadyServerless: serverless estável, que indica um cluster com especificações definidas (um cluster por assinatura ou pay-as-you-go).	SteadyServerless
Architecture	string	A arquitetura da CPU. Valores válidos:	X86
AiType	string	O tipo de nó de IA. Valores válidos:	DLNode
ProvisionedIops	string		2500
AiCreatingTime	string	A hora de início do recurso gratuito de IA.	2024-03-13T01:20:28Z
SupportInstantSwitchWithImci	string	Indica se o recurso de failover com réplica quente compatível com IMCI é suportado.	ON
Orca	string	O recurso Orca. Valores válidos:	ON
SourceDBCluster	string	O ID do cluster de origem. Nota Este parâmetro é suportado apenas para clusters restaurados a partir de um conjunto de backup ou ponto no tempo após 1º de junho de 2024.	pc-pz51ziv48317b2880
RestoreType	string	O método de restauração do cluster. Valores válidos: RestoreByTime: Restaura a partir de um ponto no tempo com base em um backup de nível 1. RestoreByBackupSet: Restaura a partir de um conjunto de backups com base em um backup de nível 1. RestoreByTimeOss: Restaura a partir de um ponto no tempo com base em um backup de nível 2. RestoreByBackupSetOss: Restaura a partir de um conjunto de backups com base em um backup de nível 2. CloneFromSourceCluster: Clona a partir do cluster de origem. Nota Este parâmetro é suportado apenas para clusters que são restaurados a partir de um conjunto de backups ou de um ponto no tempo após 1º de junho de 2024.	RestoreByTime
RestoreDataPoint	string	Se RestoreType for RestoreByTime ou RestoreByTimeOss, este valor indica o ponto no tempo para o qual o cluster é restaurado. Se RestoreType for RestoreByBackupSet ou RestoreByBackupSetOss, este valor indica o ID do conjunto de backup a partir do qual o cluster é restaurado. Nota Este parâmetro é suportado apenas para clusters que são restaurados a partir de um conjunto de backup ou para um ponto no tempo posterior a 1º de junho de 2024.	2179639137
SourceRegionId	string	O ID da região do cluster de origem.	cn-beijing
ImciAutoIndex	string	O recurso de aceleração automática de consultas baseada em IMCI. Valores válidos:	OFF
AutoUpgradeMinorVersion	string	A política de atualização de versão secundária.	Manual
BurstingEnabled	string	Indica se o burst de desempenho de E/S está ativado para o disco em nuvem ESSD AutoPL. Valores válidos:	false
RowCompression	string	A configuração de compactação de linhas.	OFF
ImperceptibleSwitch	string	O recurso de failover com réplica quente. Valores válidos:	true
StorageUsed	integer	O uso de armazenamento. Unidade: bytes.	3012558848
CompressStorageUsed	integer	O tamanho dos dados de armazenamento após a compactação.	15529410560
DBClusterStatus	string	O status do cluster. Para mais informações, consulte Tabela de status do cluster.	Running
Branch	object
ParentInsName	string
BranchTime	string
BranchLsn	string
ChildBranch	array<object>
	object
InsName	string
DBClusterDescription	string
BranchTime	string
BranchLsn	string
HasChild	boolean
ColumnTable	string	Indica se a tabela de armazenamento colunar está ativada.	OFF
ConnectionResourceQuota	integer	A cota de recursos de conexão (exclusivo do AgenticDB).
ConnectionResourceUsed	integer	O número de recursos de conexão utilizados (exclusivo do AgenticDB).
StorageUpperBound	integer
StorageAutoScale	string

Exemplos

Resposta de sucesso

JSON formato

{
  "DeletionLock": 0,
  "Category": "Normal",
  "ResourceGroupId": "rg-***************",
  "DataLevel1BackupChainSize": 74448896,
  "DBClusterId": "pc-*****************",
  "DBType": "MySQL",
  "DBClusterNetworkType": "VPC",
  "IsLatestVersion": false,
  "HasCompleteStandbyRes": false,
  "HotStandbyCluster": "StandbyClusterON",
  "DataSyncMode": "AsyncSync",
  "StandbyHAMode": "OFF",
  "CompressStorageMode": "ON",
  "StorageMax": 10995116277760,
  "DBVersion": "8.0",
  "DBNodes": [
    {
      "CreationTime": "2020-03-23T21:35:43Z",
      "FailoverPriority": 1,
      "MaxIOPS": 32000,
      "DBNodeClass": "polar.mysql.x4.large",
      "CpuCores": "2",
      "MemorySize": "8192",
      "DBNodeRole": "Reader",
      "ZoneId": "cn-hangzhou-i",
      "MaxConnections": 8000,
      "DBNodeStatus": "Running",
      "DBNodeId": "pi-****************",
      "ImciSwitch": "ON",
      "HotReplicaMode": "ON",
      "AddedCpuCores": "6",
      "MasterId": "pi-bp18z52akld3*****",
      "SccMode": "ON",
      "ServerWeight": "1",
      "ServerlessType": "SteadyServerless",
      "SubCluster": "Primary",
      "RemoteMemorySize": "3072",
      "Orca": "off",
      "MultiMasterLocalStandby": "pi-****************",
      "MultiMasterPrimaryNode": "pi-****************",
      "DBNodeDescription": "test",
      "SubGroupDescription": "test Description",
      "MirrorInsName": "pi-bp18z52mirror*****",
      "DBNodeCXLRemoteMemory": "3072",
      "RemoteMemoryMin": 0,
      "RemoteMemoryMax": 0,
      "RemoteMemoryRecommended": 0,
      "DedicatedHostModel": false
    }
  ],
  "ZoneIds": "cn-hangzhou-i,cn-hangzhou-g",
  "MaintainTime": "18:00Z-19:00Z",
  "Engine": "POLARDB",
  "Tags": [
    {
      "Key": "test",
      "Value": "MySQL"
    }
  ],
  "RequestId": "074467EF-86B9-4C23-ACBF-E9B81A******",
  "VPCId": "vpc-*******************",
  "SearchClusterStatus": "Running",
  "VSwitchId": "vsw-*********************",
  "DBClusterDescription": "test",
  "Expired": "false",
  "PayType": "Prepaid",
  "StoragePayType": "Prepaid",
  "LockMode": "Unlock",
  "SearchStorageUsed": 3012558848,
  "SearchCompressStorageUsed": 15529410560,
  "StorageSpace": 50,
  "DBVersionStatus": "Stable",
  "CreationTime": "2020-08-14T05:58:42Z",
  "SQLSize": 0,
  "InodeTotal": 0,
  "InodeUsed": 0,
  "BlktagTotal": 0,
  "BlktagUsed": 0,
  "RegionId": "cn-hangzhou",
  "ExpireTime": "2020-11-14T16:00:00Z",
  "SubCategory": "Exclusive",
  "IsProxyLatestVersion": false,
  "StorageType": "HighPerformance",
  "ServerlessType": "SteadyServerless",
  "StrictConsistency": "ON",
  "ProxyCpuCores": "4",
  "ProxyStandardCpuCores": "2",
  "ProxyType": "Exclusive",
  "ProxyStatus": "Running",
  "ProxyServerlessType": "SteadyServerless",
  "Architecture": "X86",
  "AiType": "DLNode",
  "ProvisionedIops": "2500",
  "AiCreatingTime": "2024-03-13T01:20:28Z",
  "SupportInstantSwitchWithImci": "ON",
  "Orca": "ON",
  "SourceDBCluster": "pc-pz51ziv48317b2880",
  "RestoreType": "RestoreByTime",
  "RestoreDataPoint": "2179639137",
  "SourceRegionId": "cn-beijing",
  "ImciAutoIndex": "OFF",
  "AutoUpgradeMinorVersion": "Manual",
  "BurstingEnabled": "false",
  "RowCompression": "OFF\n",
  "ImperceptibleSwitch": "true",
  "StorageUsed": 3012558848,
  "CompressStorageUsed": 15529410560,
  "DBClusterStatus": "Running",
  "Branch": {
    "ParentInsName": "",
    "BranchTime": "",
    "BranchLsn": "",
    "ChildBranch": [
      {
        "InsName": "",
        "DBClusterDescription": "",
        "BranchTime": "",
        "BranchLsn": "",
        "HasChild": false
      }
    ]
  },
  "ColumnTable": "OFF",
  "ConnectionResourceQuota": 0,
  "ConnectionResourceUsed": 0,
  "StorageUpperBound": 0,
  "StorageAutoScale": ""
}

Códigos de erro

Código de status HTTP	Código de erro	Mensagem de erro	Descrição
400	InvalidDBClusterId.Malformed	The specified parameter DBClusterId is not valid.
403	Forbidden.RAM	User not authorized to operate on the specified resource, or this API does not support RAM.
404	InvalidDBCluster.NotFound	The DBClusterId provided does not exist in our records.	A operação falhou. O ID da instância de cluster especificado não existe.

Consulte Códigos de Erro para uma lista completa.

Notas de versão

Consulte Notas de Versão para uma lista completa.