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

Consulta los detalles de una instancia de gateway.

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

get

*All Resource

*

Ninguna

Sintaxis de la solicitud

POST  HTTP/1.1

Parámetros de la solicitud

Parámetro	Tipo	Obligatorio	Descripción	Ejemplo
GwClusterId	string	Sí	El ID de la instancia de gateway.	pg-xxxxxxx
RegionId	string	No	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.	3E5CD764-FCCA-5C9C-838E-20E0DE84B2AF
VpcId	string	El ID de la VPC donde se despliega la instancia de gateway.	vpc-*************
VSwitchId	string	El ID del VSwitch donde se despliega la instancia de gateway.	vsw-*********************
PayType	string	El método de facturación de la instancia de gateway. Valores válidos: Postpaid: pago por uso. Prepaid: suscripción.	Postpaid
GwClusterId	string	El ID de la instancia de gateway.	pg-xxxxxxx
GwDescription	string	La descripción de la instancia de gateway.	xxx
Status	string	El estado de la instancia de gateway. Valores válidos: CREATE: la instancia de gateway se está creando. ACTIVATION: la instancia de gateway está en ejecución.	ACTIVATION
RegionId	string	El ID de la región.	cn-beijing
DbType	string	El tipo de base de datos.	MySQL
CreateTime	string	La hora en que se creó la instancia de gateway.	2020-02-24T11:57:54Z
ModifyTime	string	La hora en que se modificó por última vez la instancia de gateway.	2025-10-07T02:19:55Z
ClassCode	string	El código de especificación de la instancia de gateway.	polar.app.g2.medium
ExpireTime	string	La hora en que expira la suscripción de la instancia de gateway. Este parámetro está vacío para las instancias de pago por uso.	2027-04-22T16:00:00Z
Endpoints	array<object>	Una lista de endpoints de la instancia de gateway.
	object	Contiene los detalles de un endpoint.
Address	string	La dirección del endpoint.	pg-xxxxx.polardbaigateway.pre.rds.aliyuncs.com
EndpointId	string	El ID del endpoint.	xxx
GwClusterId	string	El ID de la instancia de gateway.	pg-xxxxxxx
Port	string	El número de puerto.	8080
TunnelId	string	El ID del túnel.	1874631
VpcId	string	El ID de la VPC a la que pertenece el endpoint.	vpc-*************
NetType	string	El tipo de red del endpoint. Valores válidos: Private: endpoint de VPC. Public: endpoint público.	Public
Expired	boolean	Indica si la suscripción de la instancia de gateway ha expirado. Valores válidos: true false	False
SecurityIPArrays	array<object>	Una lista de listas blancas de IP para la instancia de gateway.
	object	Contiene los detalles de una lista blanca de IP.
SecurityIPArrayTag	string	La etiqueta de la lista blanca de IP.	mytag
SecurityIPList	string	Una lista separada por comas de direcciones IP en la lista blanca de IP.	127.0.0.1
SecurityIPArrayName	string	El nombre de la lista blanca de IP. El valor predeterminado es `default`.	default
LatestVersion	string
CurrentVersion	string
RunningVersion	string

Ejemplos

Respuesta exitosa

JSON Formato

{
  "RequestId": "3E5CD764-FCCA-5C9C-838E-20E0DE84B2AF",
  "VpcId": "vpc-*************",
  "VSwitchId": "vsw-*********************",
  "PayType": "Postpaid",
  "GwClusterId": "pg-xxxxxxx",
  "GwDescription": "xxx",
  "Status": "ACTIVATION",
  "RegionId": "cn-beijing",
  "DbType": "MySQL",
  "CreateTime": "2020-02-24T11:57:54Z",
  "ModifyTime": "2025-10-07T02:19:55Z",
  "ClassCode": "polar.app.g2.medium",
  "ExpireTime": "2027-04-22T16:00:00Z",
  "Endpoints": [
    {
      "Address": "pg-xxxxx.polardbaigateway.pre.rds.aliyuncs.com",
      "EndpointId": "xxx",
      "GwClusterId": "pg-xxxxxxx",
      "Port": "8080",
      "TunnelId": "1874631",
      "VpcId": "vpc-*************",
      "NetType": "Public"
    }
  ],
  "Expired": true,
  "SecurityIPArrays": [
    {
      "SecurityIPArrayTag": "mytag",
      "SecurityIPList": "127.0.0.1",
      "SecurityIPArrayName": "default"
    }
  ],
  "LatestVersion": "",
  "CurrentVersion": "",
  "RunningVersion": ""
}

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.