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

Consulta una lista de instancias de puerta de enlace.

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

get

*Todos los recursos.

*

Ninguna

Sintaxis de la solicitud

POST  HTTP/1.1

Parámetros de la solicitud

Parámetro	Tipo	Obligatorio	Descripción	Ejemplo
PageSize	string	No	El número de entradas por página. Valores válidos: 30 50 100 Valor predeterminado: 30.	30
PageNumber	string	No	El número de la página actual.	1
GwClusterId	string	No	El ID de la instancia de puerta de enlace.	pg-xxxxxxxxxx
GwDescription	string	No	La descripción de la puerta de enlace.	prueba
RegionId	string	Sí	El ID de la región.	cn-beijing

Elementos de la respuesta

Elemento	Tipo	Descripción	Ejemplo
	object	Esquema de la respuesta.
RequestId	string	El ID de la solicitud.	CED079B7-A408-41A1-BFF1-EC608E******
PageNumber	string	El número de la página. Valor predeterminado: 1.	1
PageRecordCount	string	El número de entradas en la página actual.	30
PageSize	string	El número de entradas por página. Valores válidos: 30 50 100 Valor predeterminado: 30.	30
TotalRecordCount	string	El número total de entradas.	1
Items	array<object>	La lista de instancias de puerta de enlace.
	object	El objeto de la instancia de puerta de enlace.
VpcId	string	El ID de la VPC.	vpc-****************
VSwitchId	string	El ID del vSwitch.	vsw-wz9u0v2yuskt1gth3uuju
PayType	string	El método de facturación. Valores válidos: Postpaid: pago por uso. Prepaid: suscripción.	Postpaid
GwClusterId	string	El ID de la instancia de puerta de enlace.	pg-xxxxxxx
GwDescription	string	La descripción de la puerta de enlace.	pg-xxxxxx
Status	string	El estado de la aplicación. Valores válidos: CREATE: en creación. ACTIVATION: en ejecución.	ACTIVATION
RegionId	string	El ID de la región.	cn-beijing
DbType	string	El tipo de base de datos.	polardb_mysql
CreateTime	string	La hora de creación. La hora está en formato ISO 8601 en UTC (formato: YYYY-MM-DDTHH:mm:ssZ).	2020-08-14T05:58:42Z
ModifyTime	string	La hora de la última modificación. La hora está en formato ISO 8601 en UTC (formato: YYYY-MM-DDTHH:mm:ssZ).	2024-10-29T09:31:37Z
ExpireTime	string	La hora de expiración del clúster. Si el método de facturación del clúster es suscripción, se devuelve la hora de expiración real. Si el método de facturación del clúster es de pago por uso, se devuelve un valor vacío. La hora está en formato ISO 8601 en UTC (formato: YYYY-MM-DDTHH:mm:ssZ).	2028-09-01T16:00:00Z
Expired	boolean	Indica si el clúster ha expirado. Valores válidos: true false	false

Ejemplos

Respuesta exitosa

JSON Formato

{
  "RequestId": "CED079B7-A408-41A1-BFF1-EC608E******",
  "PageNumber": "1",
  "PageRecordCount": "30",
  "PageSize": "30",
  "TotalRecordCount": "1",
  "Items": [
    {
      "VpcId": "vpc-****************",
      "VSwitchId": "vsw-wz9u0v2yuskt1gth3uuju",
      "PayType": "Postpaid",
      "GwClusterId": "pg-xxxxxxx",
      "GwDescription": "pg-xxxxxx",
      "Status": "ACTIVATION",
      "RegionId": "cn-beijing",
      "DbType": "polardb_mysql",
      "CreateTime": "2020-08-14T05:58:42Z",
      "ModifyTime": "2024-10-29T09:31:37Z",
      "ExpireTime": "2028-09-01T16:00:00Z",
      "Expired": false
    }
  ]
}

Códigos de error

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.