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

Consulta os detalhes da instância de gateway.

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

Nenhuma autorização necessária para esta operação. Se você encontrar problemas com esta operação, entre em contato com o suporte técnico.

Sintaxe da solicitação

POST  HTTP/1.1

Parâmetros da solicitação

Parâmetro	Tipo	Obrigatório	Descrição	Exemplo
GwClusterId	string	Sim	O ID da instância de gateway.	pg-xxxxxxx
RegionId	string	Não	O ID da região.	cn-beijing

Elementos de resposta

Elemento	Tipo	Descrição	Exemplo
	object	Esquema da resposta.
RequestId	string	O ID da solicitação.	3E5CD764-FCCA-5C9C-838E-20E0DE84B2AF
VpcId	string	O ID da VPC na qual a instância de gateway está implantada.	vpc-*************
VSwitchId	string	O ID do VSwitch no qual a instância de gateway está implantada.	vsw-*********************
PayType	string	O método de cobrança da instância de gateway. Valores válidos: Postpaid: pós-pago. Prepaid: assinatura.	Postpaid
GwClusterId	string	O ID da instância de gateway.	pg-xxxxxxx
GwDescription	string	A descrição da instância de gateway.	xxx
Status	string	O status da instância de gateway. Valores válidos: CREATE: A instância de gateway está sendo criada. ACTIVATION: A instância de gateway está em execução.	ACTIVATION
RegionId	string	O ID da região.	cn-beijing
DbType	string	O tipo de banco de dados.	MySQL
CreateTime	string	O horário em que a instância de gateway foi criada.	2020-02-24T11:57:54Z
ModifyTime	string	O horário em que a instância de gateway foi modificada pela última vez.	2025-10-07T02:19:55Z
ClassCode	string	O código de especificação da instância de gateway.	polar.app.g2.medium
ExpireTime	string	O horário em que a assinatura da instância de gateway expira. Este parâmetro está vazio para instâncias pós-pagas.	2027-04-22T16:00:00Z
Endpoints	array<object>	Uma lista de endpoints da instância de gateway.
	object	Contém os detalhes de um endpoint.
Address	string	O endereço do endpoint.	pg-xxxxx.polardbaigateway.pre.rds.aliyuncs.com
EndpointId	string	O ID do endpoint.	xxx
GwClusterId	string	O ID da instância de gateway.	pg-xxxxxxx
Port	string	O número da porta.	8080
TunnelId	string	O ID do túnel.	1874631
VpcId	string	O ID da VPC à qual o endpoint pertence.	vpc-*************
NetType	string	O tipo de rede do endpoint. Valores válidos: Private: endpoint de VPC. Public: endpoint público.	Public
Expired	boolean	Indica se a assinatura da instância de gateway expirou. Valores válidos: true false	False
SecurityIPArrays	array<object>	Uma lista de listas de permissões de IP da instância de gateway.
	object	Contém os detalhes de uma lista de permissões de IP.
SecurityIPArrayTag	string	A tag da lista de permissões de IP.	mytag
SecurityIPList	string	Uma lista de endereços IP separados por vírgula na lista de permissões de IP.	127.0.0.1
SecurityIPArrayName	string	O nome da lista de permissões de IP. O valor padrão é default.	default
LatestVersion	string
CurrentVersion	string
RunningVersion	string

Exemplos

Resposta de sucesso

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 erro

Consulte Códigos de Erro para uma lista completa.

Notas de versão

Consulte Notas de Versão para uma lista completa.