DescribeGlobalDatabaseNetwork - PolarDB - Centro de documentación de Alibaba Cloud

Consulta los detalles de una red de base de datos global (GDN).

Pruébelo ahora

Pruebe esta API en OpenAPI Explorer sin necesidad de firma manual. Las llamadas exitosas generan automáticamente código SDK acorde a sus parámetros. Descárguelo con seguridad de credenciales integrada para uso local.

Test

Autorización de RAM

La siguiente tabla describe la autorización necesaria para invocar esta API. Puede definirla en una directiva de Resource Access Management (RAM). A continuación, se detallan las columnas de la tabla:

Action: Estas acciones se utilizan en el elemento Action de las declaraciones de directivas de permisos de RAM para otorgar permisos que permitan realizar la operación.
API: La API que debe invocarse para llevar a cabo la acción.
Nivel de acceso: Nivel de acceso predefinido que se concede para cada API. Valores válidos: create, list, get, update y delete.
Tipo de recurso: Tipo de recurso que admite autorización para ejecutar la acción. Indica si la acción es compatible con permisos a nivel de recurso. El recurso especificado debe ser compatible con la acción; de lo contrario, la directiva no surtirá efecto.
- En las API con permisos a nivel de recurso, los tipos de recursos obligatorios se marcan con un asterisco (*). Especifique el Alibaba Cloud Resource Name (ARN) correspondiente en el elemento Resource de la directiva.
- Para las API sin permisos a nivel de recurso, se muestra All Resources. Utilice un asterisco (*) en el elemento Resource de la directiva.
Clave de condición: Claves de condición definidas por el servicio. Permiten un control granular y se aplican ya sea solo a acciones o a acciones asociadas con recursos específicos. Además de las claves de condición específicas del servicio, Alibaba Cloud proporciona un conjunto de common condition keys aplicables a todos los servicios compatibles con RAM.
Acción dependiente: Acciones dependientes necesarias para ejecutar la acción principal. Para completar la operación, el usuario de RAM o el rol de RAM debe contar con permisos para realizar todas las acciones dependientes.

Action

Nivel de acceso

Tipo de recurso

Clave de condición

Acción dependiente

polardb:DescribeGlobalDatabaseNetwork

get

*dbcluster.

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

Ninguna

Parámetros de la solicitud

Parámetro	Tipo	Obligatorio	Descripción	Ejemplo
GDNId	string	Sí	El ID de la GDN.	gdn-bp1fttxsrmv*****
ResourceGroupId	string	No	El ID del grupo de recursos.	rg-************

Elementos de la respuesta

Elemento	Tipo	Descripción	Ejemplo
	object
GDNStatus	string	El estado de la GDN. Valores válidos: creating: En creación. active: En ejecución. deleting: En eliminación. locked: Bloqueado. No se puede realizar ninguna operación en ningún clúster de la GDN. removing_member: Se está quitando un clúster de la GDN.	active
Connections	array<object>	La información de conexión.
	object
ConnectionString	string	La cadena de conexión.	abc.polardb.rds.aliyuncs.com
NetType	string	El tipo de red.	Private
Port	string	El número de puerto de la cadena de conexión.	3306
DBVersion	string	La versión del motor de base de datos. Actualmente solo se admite la versión 8.0.	8.0
RequestId	string	El ID de la solicitud.	67F2E75F-AE67-4FB2-821F-A81237EACD15
GDNId	string	El ID de la GDN.	gdn-bp1fttxsrmv*****
CreateTime	string	La hora en que se creó la GDN. La hora está en formato ISO 8601 en UTC (formato: YYYY-MM-DDTHH:mm:ssZ).	2020-02-24T11:57:54Z
DBType	string	El tipo de motor de base de datos. Actualmente solo se admite MySQL.	MySQL
GDNDescription	string	La descripción de la GDN. La descripción debe cumplir los siguientes requisitos: No puede comenzar con http:// ni https://. Debe comenzar con una letra mayúscula, una letra minúscula o un carácter chino. Puede contener letras mayúsculas, letras minúsculas, caracteres chinos, dígitos, guiones bajos (_) o guiones (-). Debe tener una longitud de 2 a 126 caracteres.	GDN-paraprueba
GlobalDomainName	string	El nombre de dominio global.	[gdnid].gdn.rds.aliyuncs.com
DBClusters	array<object>	Los clústeres de la GDN.
	array<object>
ReplicaLag	string	El retraso de replicación interregional entre los clústeres principal y secundario. Unidad: segundos.	1
ExpireTime	string	La hora de expiración del clúster. Nota Este parámetro se devuelve solo para los clústeres cuyo método de facturación es Prepaid (suscripción). Se devuelve un valor vacío para los clústeres Postpaid (pago por uso). La hora está en formato ISO 8601 en UTC (formato: YYYY-MM-DDTHH:mm:ssZ).	2020-11-14T16:00:00Z
Expired	string	Indica si el clúster ha expirado. Valores válidos: true false Nota Este parámetro se devuelve solo para los clústeres cuyo método de facturación es Prepaid (suscripción).	false
DBNodeClass	string	Las especificaciones del nodo de base de datos.	polar.mysql.x4.large
PayType	string	El método de facturación. Valores válidos: Postpaid: pago por uso. Prepaid: suscripción.	Prepaid
DBType	string	El tipo de motor de base de datos. Actualmente solo se admite MySQL.	MySQL
RegionId	string	El ID de la región.	cn-hangzhou
DBVersion	string	La versión del motor de base de datos. Actualmente solo se admite la versión 8.0.	8.0
DBClusterId	string	El ID del clúster en la GDN.	pc-wz9fb5nn44u1d****
DBClusterStatus	string	El estado del clúster en la GDN. Para obtener más información, consulte Tabla de estados del clúster.	Running
StorageUsed	string	El uso de almacenamiento. Unidad: bytes.	3012558848
DBClusterDescription	string	La descripción del clúster.	prueba
Category	string	La edición del producto. Valores válidos: Normal: Edición de clúster Basic: Edición de nodo único Archive: Edición PolarDB X-Engine NormalMultimaster: Edición de clúster multimaster SENormal: Edición estándar de PolarDB for MySQL Nota PolarDB for PostgreSQL 11 no admite la edición de nodo único. PolarDB for MySQL 8.0, PolarDB for MySQL 5.7 y PolarDB for PostgreSQL 14 admiten la edición estándar de PolarDB for MySQL. PolarDB for MySQL 8.0 admite la edición PolarDB X-Engine y la edición de clúster multimaster.	Normal
Role	string	El rol del clúster. Valores válidos: primary: clúster principal standby: clúster secundario Nota Una GDN contiene un clúster principal y hasta cuatro clústeres secundarios.	primary
ServerlessType	string	El tipo serverless. El valor es fijo: AgileServerless. Nota Este parámetro solo se admite para los clústeres serverless.	AgileServerless
DBNodes	array<object>	Los detalles de los nodos de base de datos.
	object
DBNodeClass	string	Las especificaciones del nodo de base de datos.	polar.mysql.x4.large
ZoneId	string	El ID de la zona.	cn-hangzhou-i
CreationTime	string	La hora en que se creó el nodo de base de datos. La hora está en formato ISO 8601 en UTC (formato: YYYY-MM-DDTHH:mm:ssZ).	2020-03-23T21:35:43Z
DBNodeRole	string	El rol del nodo de base de datos. Valores válidos: Writer: nodo principal Reader: nodo de solo lectura	Reader
DBNodeStatus	string	El estado del nodo. Valores válidos: Creating: En creación. Running: En ejecución. Deleting: En eliminación. Rebooting: En reinicio. ClassChanging: Se están cambiando las especificaciones del nodo. NetAddressCreating: Se está creando la conectividad de red. NetAddressDeleting: Se está eliminando la conectividad de red. NetAddressModifying: Se está modificando la conectividad de red. MinorVersionUpgrading: Hay una actualización de versión menor del motor en curso. Maintaining: El clúster está en mantenimiento. Switching: Hay una conmutación por error en curso.	Running
FailoverPriority	integer	La prioridad de conmutación por error. Cada nodo tiene una prioridad de conmutación por error que determina la probabilidad de que el nodo se elija como nodo principal durante una conmutación por error. Un valor más alto indica una prioridad más alta. Valores válidos: 1 a 15.	1
MaxConnections	integer	El número máximo de conexiones simultáneas al clúster.	8000
MaxIOPS	integer	El número máximo de solicitudes de E/S por segundo (IOPS).	32000
DBNodeId	string	El ID del nodo de base de datos.	pi-****************
DBClusterId	string	El ID del clúster.	pc-bp1s826a1up******
ResourceGroupId	string	El ID del grupo de recursos.	rg-************
Labels	object	Las etiquetas de propiedad.
GDNVersion	string	La versión de la GDN.	2.0

Ejemplos

Respuesta exitosa

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 error

Código de estado HTTP	Código de error	Mensaje de error	Descripción
400	GDN.NotFound	Failed to found GdnInstance by name:%s
404	InvalidDBCluster.NotFound	The DBClusterId provided does not exist in our records.	La operación falló. El ID de instancia del cluster especificado no existe.

Consulte Códigos de error para ver la lista completa.

Notas de la versión

Consulte Notas de la versión para ver la lista completa.