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

Consulta los detalles de todas las redes globales de bases de datos (GDN) en su cuenta.

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

get

*DBCluster

acs:polardb:{#regionId}:{#accountId}:{#resource-type}/*

Ninguna

Parámetros de la solicitud

Parámetro	Tipo	Obligatorio	Descripción	Ejemplo
FilterRegion	string	No	Devuelve solo las GDN que admiten la creación de un clúster secundario en la región especificada.	cn-beijing
DBClusterId	string	No	El ID del clúster. Nota Puede llamar a la operación DescribeDBClusters para obtener los ID de todos los clústeres en una región.	pc-**************
PageSize	integer	No	El número de entradas que se devolverán en cada página. Valor predeterminado: 30. Valores válidos: 30 50 100	30
PageNumber	integer	No	El número de página. El valor debe ser mayor que 0. Valor predeterminado: 1.	1
GDNDescription	string	No	La descripción de la GDN. La descripción debe cumplir con los siguientes requisitos: No puede comenzar con `http://` o `https://`. Debe comenzar con una letra o un carácter chino. Puede contener letras, caracteres chinos, dígitos, guiones bajos (_) y guiones (-). Debe tener una longitud de 2 a 126 caracteres.	test
GDNId	string	No	El ID de la GDN.	gdn-****************
ResourceGroupId	string	No	El ID del grupo de recursos.	rg-************

Elementos de la respuesta

Elemento	Tipo	Descripción	Ejemplo
	object
TotalRecordCount	integer	El número total de registros.	1
PageRecordCount	integer	El número de registros en la página actual.	30
RequestId	string	El ID de la solicitud.	69A85BAF-1089-4CDF-A82F-0A140F******
PageNumber	integer	El número de página.	1
Items	array<object>	Una lista de GDN.
	array<object>
DBVersion	string	La versión del motor de base de datos. Solo se admite la versión 8.0.	8.0
GDNId	string	El ID de la GDN.	gdn-****************
CreateTime	string	La hora en que se creó la GDN, en formato UTC. El formato es `YYYY-MM-DDTHH:mm:ssZ`.	2020-03-23T05:46:54Z
GDNStatus	string	El estado de la GDN. Valores válidos: creating: La GDN se está creando. active: La GDN está en ejecución. deleting: La GDN se está eliminando. locked: La GDN está bloqueada. Este estado impide cualquier operación en los clústeres de la GDN. removing_member: Se está eliminando un clúster en espera de la GDN.	active
DBClusters	array<object>	Una lista de clústeres en la GDN.
	object
DBClusterId	string	El ID del clúster.	pc-****************
Role	string	El rol del clúster. Valores válidos: primary: El clúster principal. standby: El clúster en espera. Nota Una GDN consta de un clúster principal y hasta cuatro clústeres en espera. Para obtener más información, consulte Red global de bases de datos.	primary
RegionId	string	El ID de la región.	cn-hangzhou
DBType	string	El tipo de motor de base de datos. Solo se admite MySQL.	MySQL
GDNDescription	string	La descripción de la GDN. Requisitos: No puede comenzar con http:// o https://. Debe comenzar con una letra o un carácter chino. Puede contener letras, caracteres chinos, dígitos, guiones bajos (_) o guiones (-). Debe tener una longitud de 2 a 126 caracteres.	test
Labels	object	Las etiquetas aplicadas a la GDN.
GDNVersion	string	La versión de la GDN.	2.0

Ejemplos

Respuesta exitosa

JSON Formato

{
  "TotalRecordCount": 1,
  "PageRecordCount": 30,
  "RequestId": "69A85BAF-1089-4CDF-A82F-0A140F******",
  "PageNumber": 1,
  "Items": [
    {
      "DBVersion": "8.0",
      "GDNId": "gdn-****************",
      "CreateTime": "2020-03-23T05:46:54Z",
      "GDNStatus": "active",
      "DBClusters": [
        {
          "DBClusterId": "pc-****************",
          "Role": "primary",
          "RegionId": "cn-hangzhou"
        }
      ],
      "DBType": "MySQL",
      "GDNDescription": "test",
      "Labels": {
        "GDNVersion": "2.0"
      }
    }
  ]
}

Códigos de error

Código de estado HTTP	Código de error	Mensaje de error
400	InvalidPageSize.Malformed	The specified parameter PageSize is not valid.
400	InvalidPageNumber.Malformed	The specified parameter PageNumber is not valid.
404	InvalidDBCluster.NotFound	The DBClusterId provided does not exist in our records.

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.