DescribeCustomerGateways - VPN Gateway: Central de Documentação do Alibaba Cloud

Consulta informações sobre customer gateways.

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

A tabela abaixo descreve a autorização necessária para chamar esta API. Você pode defini-la em uma política do Resource Access Management (RAM). As colunas da tabela estão detalhadas abaixo:

Ação: As ações que podem ser usadas no elemento Action das instruções de política de permissão do RAM para conceder permissões para executar a operação.
API: A API que você pode chamar para executar a ação.
Nível de acesso: O nível de acesso predefinido concedido para cada API. Valores válidos: create, list, get, update e delete.
Tipo de recurso: O tipo de recurso que suporta autorização para executar a ação. Indica se a ação suporta permissão em nível de recurso. O recurso especificado deve ser compatível com a ação. Caso contrário, a política será ineficaz.
- Para APIs com permissões em nível de recurso, os tipos de recursos obrigatórios são marcados com um asterisco (*). Especifique o Nome de Recurso Alibaba Cloud (ARN) correspondente no elemento Resource da política.
- Para APIs sem permissões em nível de recurso, é exibido como Todos os Recursos. Use um asterisco (*) no elemento Resource da política.
Chave de condição: As chaves de condição definidas pelo serviço. A chave permite controle granular, aplicando-se somente a ações ou a ações associadas a recursos específicos. Além das chaves de condição específicas do serviço, o Alibaba Cloud fornece um conjunto de chaves de condição comuns aplicáveis a todos os serviços compatíveis com RAM.
Ação dependente: As ações dependentes necessárias para executar a ação. Para concluir a ação, o usuário RAM ou a função RAM deve ter permissões para executar todas as ações dependentes.

Ação

Nível de acesso

Tipo de recurso

Chave de condição

Ação dependente

vpc:DescribeCustomerGateways

list

CustomerGateway

acs:vpc:{#regionId}:{#accountId}:customergateway/*

CustomerGateway

acs:vpc:{#regionId}:{#accountId}:customergateway/{#CustomerGatewayId}

Nenhuma

Parâmetros da solicitação

Parâmetro	Tipo	Obrigatório	Descrição	Exemplo
RegionId	string	Sim	O ID da região do customer gateway. Você pode chamar DescribeRegions para consultar os IDs de região.	cn-shanghai
CustomerGatewayId	string	Não	O ID da instância do customer gateway. Nota Se você não especificar o ID da instância de um customer gateway, o sistema consultará informações sobre todos os customer gateways na região atual por padrão.	cgw-bp1pvpl9r9adju6l5****
PageNumber	integer	Não	O número da página da lista. Valor padrão: 1.	1
PageSize	integer	Não	O número de entradas por página em uma consulta paginada. Valor máximo: 50. Valor padrão: 10.	10
Tag	array<object>	Não	A lista de tags vinculadas ao customer gateway.
	object	Não	As informações da tag.
Key	string	Não	A chave da tag. Se você especificar este parâmetro, o valor não poderá ser uma string vazia. A chave da tag pode ter até 64 caracteres e não pode começar com `aliyun` ou `acs:`. Não pode conter `http://` ou `https://`. Você pode especificar até 20 chaves de tag por vez.	TagKey
Value	string	Não	O valor da tag. O valor da tag pode ter até 128 caracteres e pode ser uma string vazia. Não pode começar com `aliyun` ou `acs:` e não pode conter `http://` ou `https://`. Cada chave de tag corresponde a um valor de tag. Você pode especificar até 20 valores de tag por vez.	TagValue
ResourceGroupId	string	Não	O ID do grupo de recursos ao qual o customer gateway pertence. Você pode chamar ListResourceGroups para consultar os IDs de grupos de recursos.	rg-acfmzs372yg****

Elementos de resposta

Elemento	Tipo	Descrição	Exemplo
	object	Os parâmetros de resposta.
PageSize	integer	O número de entradas por página em uma consulta paginada.	10
RequestId	string	O ID da solicitação.	E82612A9-CB90-4D7E-B394-1DB7F6509B29
PageNumber	integer	O número da página da lista.	1
TotalCount	integer	O número total de entradas na lista.	1
CustomerGateways	object
CustomerGateway	array<object>	A lista de customer gateways.
	array<object>	As informações sobre o customer gateway.
IpAddress	string	The IP address of the gateway device in the on-premises data center.	139.32.XX.XX
Asn	integer	The autonomous system number of the gateway device in the on-premises data center.	65530
Description	string	The description of the customer gateway.	desctest
CustomerGatewayId	string	The instance ID of the customer gateway.	cgw-bp1pvpl9r9adju6l5****
CreateTime	integer	The timestamp when the customer gateway was created. Unit: milliseconds. The timestamp is in the UNIX format and represents the total number of milliseconds that have elapsed since January 1, 1970, 00:00:00 UTC.	1492747187000
Name	string	The name of the customer gateway.	nametest
AuthKey	string	The authentication key of the BGP routing protocol for the gateway device in the on-premises data center.	AuthKey****
Tags	object
Tag	array<object>	The list of tags bound to the customer gateway.
	object	The tag information.
Key	string	The tag key.	TagKey
Value	string	The tag value.	TagValue
ResourceGroupId	string	The ID of the resource group to which the customer gateway belongs. You can call ListResourceGroups to query resource group information.	rg-acfmzs372yg****

Exemplos

Resposta de sucesso

JSON formato

{
  "PageSize": 10,
  "RequestId": "E82612A9-CB90-4D7E-B394-1DB7F6509B29",
  "PageNumber": 1,
  "TotalCount": 1,
  "CustomerGateways": {
    "CustomerGateway": [
      {
        "IpAddress": "139.32.XX.XX",
        "Asn": 65530,
        "Description": "desctest",
        "CustomerGatewayId": "cgw-bp1pvpl9r9adju6l5****",
        "CreateTime": 1492747187000,
        "Name": "nametest",
        "AuthKey": "AuthKey****",
        "Tags": {
          "Tag": [
            {
              "Key": "TagKey",
              "Value": "TagValue"
            }
          ]
        },
        "ResourceGroupId": "rg-acfmzs372yg****"
      }
    ]
  }
}

Códigos de erro

Código de status HTTP	Código de erro	Mensagem de erro	Descrição
400	Forbidden.TagKey.Duplicated	The specified tag key already exists.	The tag resources are duplicate.
400	SizeLimitExceeded.TagNum	The maximum number of tags is exceeded.	The number of tags has reached the upper limit.
400	InvalidParameter.TagValue	The specified parameter TagValue is invalid.	The error message returned because the specified tag value is invalid.
400	InvalidParameter.TagKey	The specified parameter TagKey is invalid.	The error message returned because the specified tag key is invalid.
400	Duplicated.TagKey	The specified parameter TagKey is duplicated.	The error message returned because the specified tag key already exists.
403	Forbbiden.SubUser	User not authorized to operate on the specified resource as your account is created by another user.
403	Forbidden	User not authorized to operate on the specified resource.	You do not have the permissions to manage the specified resource. Apply for the permissions and try again.

Consulte Códigos de Erro para uma lista completa.

Notas de versão

Consulte Notas de Versão para uma lista completa.