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

Obtém os detalhes de uma Global Database Network (GDN).

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

get

*dbcluster

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

Nenhuma

Parâmetros da solicitação

Parâmetro	Tipo	Obrigatório	Descrição	Exemplo
GDNId	string	Sim	O ID da Global Database Network (GDN).	gdn-bp1fttxsrmv*****
ResourceGroupId	string	Não	O ID do grupo de recursos.	rg-************

Elementos de resposta

Elemento	Tipo	Descrição	Exemplo
	object
GDNStatus	string	O status da Global Database Network (GDN). Valores válidos: creating: A GDN está sendo criada. active: A GDN está em execução. deleting: A GDN está sendo excluída. locked: A GDN está bloqueada. Neste estado, você não pode realizar nenhuma operação em nenhum cluster da GDN. removing_member: Um cluster está sendo removido da GDN.	active
Connections	array<object>	Os detalhes da conexão.
	object
ConnectionString	string	A string de conexão.	abc.polardb.rds.aliyuncs.com
NetType	string	O tipo de rede.	Private
Port	string	O número da porta da string de conexão.	3306
DBVersion	string	A versão do mecanismo de banco de dados. Somente a versão 8.0 é compatível.	8.0
RequestId	string	O ID da solicitação.	67F2E75F-AE67-4FB2-821F-A81237EACD15
GDNId	string	O ID da GDN.	gdn-bp1fttxsrmv*****
CreateTime	string	A hora em que a GDN foi criada.	2020-02-24T11:57:54Z
DBType	string	O tipo de mecanismo de banco de dados. Somente o MySQL é compatível.	MySQL
GDNDescription	string	A descrição da GDN. Deve atender aos seguintes requisitos: Não pode começar com `http://` ou `https://`. Deve começar com uma letra ou um caractere chinês. Pode conter apenas letras, caracteres chineses, dígitos, sublinhados (_) e hifens (-). Deve ter de 2 a 126 caracteres de comprimento.	GDN-fortest
GlobalDomainName	string	O nome de domínio global.	[gdnid].gdn.rds.aliyuncs.com
DBClusters	array<object>	Os clusters na GDN.
	array<object>
ReplicaLag	string	O atraso de replicação para replicação entre regiões entre os clusters primário e em standby. Unidade: segundos.	1
ExpireTime	string	O horário de expiração do cluster. Nota Este parâmetro é retornado apenas para clusters por assinatura. Uma string vazia é retornada para clusters pós-pagos.	2020-11-14T16:00:00Z
Expired	string	Indica se o cluster expirou. Valores válidos: true: O cluster expirou. false: O cluster não expirou. Nota Este parâmetro é retornado apenas para clusters por assinatura.	false
DBNodeClass	string	O tipo de nó.	polar.mysql.x4.large
PayType	string	O método de cobrança do cluster. Valores válidos: Postpaid: pós-pago. Prepaid: por assinatura.	Prepaid
DBType	string	O mecanismo de banco de dados. Somente o MySQL é compatível.	MySQL
RegionId	string	O ID da região do cluster.	cn-hangzhou
DBVersion	string	A versão do mecanismo de banco de dados. Somente a versão 8.0 é compatível.	8.0
DBClusterId	string	O ID do cluster.	pc-wz9fb5nn44u1d****
DBClusterStatus	string	O status do cluster. Para mais informações, consulte Status do cluster.	Running
StorageUsed	string	A quantidade de espaço de armazenamento utilizado. Unidade: bytes.	3012558848
DBClusterDescription	string	A descrição do cluster.	test
Category	string	A edição do cluster. Valores válidos: `Normal`: Edição Cluster `Basic`: Edição de nó único `Archive`: Edição X-Engine `NormalMultimaster`: Edição Multi-master Cluster `SENormal`: Edição Standard Nota A Edição de nó único não é compatível com clusters PolarDB for PostgreSQL que executam PostgreSQL 11. A Edição Standard é compatível com clusters PolarDB for MySQL que executam MySQL 8.0 ou 5.7 e com clusters PolarDB for PostgreSQL que executam PostgreSQL 14. A Edição X-Engine e a Edição Multi-master Cluster são compatíveis apenas com clusters PolarDB for MySQL que executam MySQL 8.0.	Normal
Role	string	A função do cluster na GDN. Valores válidos: primary: o cluster primário standby: um cluster em standby Nota Uma GDN consiste em um cluster primário e até quatro clusters em standby.	primary
ServerlessType	string	O tipo de cluster Serverless. O valor é fixo como `AgileServerless`. Nota Este parâmetro é retornado apenas para clusters Serverless.	AgileServerless
DBNodes	array<object>	Os detalhes dos nós no cluster.
	object
DBNodeClass	string	The node type.	polar.mysql.x4.large
ZoneId	string	The zone ID.	cn-hangzhou-i
CreationTime	string	The time when the node was created.	2020-03-23T21:35:43Z
DBNodeRole	string	The role of the node. Valid values: Writer: the primary node Reader: a read-only node	Reader
DBNodeStatus	string	The status of the node. Valid values: Creating: The node is being created. Running: The node is running. Deleting: The node is being deleted. Rebooting: The node is being restarted. ClassChanging: The node type is being changed. NetAddressCreating: A network connection is being created. NetAddressDeleting: A network connection is being deleted. NetAddressModifying: A network connection is being modified. MinorVersionUpgrading: The minor version is being upgraded. Maintaining: The cluster is being maintained. Switching: A failover is in progress.	Running
FailoverPriority	integer	The failover priority. In the event of a failover, the system promotes a read-only node to the primary node. A larger value indicates a higher priority. Each read-only node is assigned a failover priority. Valid values: 1 to 15.	1
MaxConnections	integer	The maximum number of concurrent connections.	8000
MaxIOPS	integer	The maximum I/O operations per second (IOPS).	32000
DBNodeId	string	The node ID.	pi-****************
DBClusterId	string	O ID do cluster.	pc-bp1s826a1up******
ResourceGroupId	string	O ID do grupo de recursos.	rg-************
Labels	object	Os rótulos da GDN.
GDNVersion	string	A versão da GDN.	2.0

Exemplos

Resposta de sucesso

JSON formato

{
  "GDNStatus": "active",
  "Connections": [
    {
      "ConnectionString": "abc.polardb.rds.aliyuncs.com",
      "NetType": "Private",
      "Port": "3306"
    }
  ],
  "DBVersion": "8.0",
  "RequestId": "67F2E75F-AE67-4FB2-821F-A81237EACD15",
  "GDNId": "gdn-bp1fttxsrmv*****",
  "CreateTime": "2020-02-24T11:57:54Z",
  "DBType": "MySQL",
  "GDNDescription": "GDN-fortest",
  "GlobalDomainName": "[gdnid].gdn.rds.aliyuncs.com",
  "DBClusters": [
    {
      "ReplicaLag": "1",
      "ExpireTime": "2020-11-14T16:00:00Z",
      "Expired": "false",
      "DBNodeClass": "polar.mysql.x4.large",
      "PayType": "Prepaid",
      "DBType": "MySQL",
      "RegionId": "cn-hangzhou",
      "DBVersion": "8.0",
      "DBClusterId": "pc-wz9fb5nn44u1d****",
      "DBClusterStatus": "Running",
      "StorageUsed": "3012558848",
      "DBClusterDescription": "test",
      "Category": "Normal",
      "Role": "primary",
      "ServerlessType": "AgileServerless",
      "DBNodes": [
        {
          "DBNodeClass": "polar.mysql.x4.large",
          "ZoneId": "cn-hangzhou-i",
          "CreationTime": "2020-03-23T21:35:43Z",
          "DBNodeRole": "Reader",
          "DBNodeStatus": "Running",
          "FailoverPriority": 1,
          "MaxConnections": 8000,
          "MaxIOPS": 32000,
          "DBNodeId": "pi-****************"
        }
      ]
    }
  ],
  "DBClusterId": "pc-bp1s826a1up******",
  "ResourceGroupId": "rg-************",
  "Labels": {
    "GDNVersion": "2.0"
  }
}

Códigos de erro

Código de status HTTP	Código de erro	Mensagem de erro	Descrição
400	GDN.NotFound	Failed to found GdnInstance by name:%s
404	InvalidDBCluster.NotFound	The DBClusterId provided does not exist in our records.	The specified DBClusterId parameter does not exist in the current record.

Consulte Códigos de Erro para uma lista completa.

Notas de versão

Consulte Notas de Versão para uma lista completa.