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

Consulta as informações de configuração de conexões IPsec-VPN associadas a instâncias de transit router.

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

list

*VpnConnections.

acs:vpc:{#regionId}:{#accountId}:vpnconnection/{#VpnConnectionId}

Nenhuma

Parâmetros da solicitação

Parâmetro	Tipo	Obrigatório	Descrição	Exemplo
RegionId	string	Sim	O ID da região da conexão IPsec-VPN. Você pode chamar a operação DescribeRegions para consultar o ID da região.	cn-hangzhou
PageNumber	integer	Não	O número da página. Valor padrão: 1.	1
PageSize	integer	Não	O número de entradas por página ao usar paginação. Valor padrão: 10. Valores válidos: 1 a 50.	10
VpnConnectionId	string	Não	O ID da conexão IPsec-VPN. Nota Se você não especificar o ID da conexão IPsec-VPN, o sistema consulta todas as conexões IPsec-VPN associadas a instâncias de transit router na região atual.	vco-p0w2jpkhi2eeop6q6****
AttachType	string	Não	O tipo de recurso ao qual a conexão IPsec-VPN está anexada. Valor padrão: CEN. O valor só pode ser CEN, o que indica que o sistema consulta conexões IPsec-VPN associadas a instâncias de transit router.	CEN

Elementos de resposta

Elemento	Tipo	Descrição	Exemplo
	object	Os parâmetros de resposta.
RequestId	string	O ID da solicitação.	9F0725BB-186A-3564-91C3-AAE48042F853
PageSize	integer	O número de entradas por página ao usar paginação.	10
PageNumber	integer	O número da página.	1
TotalCount	integer	O número total de entradas retornadas.	1
VpnAttachments	array<object>	A lista de conexões IPsec-VPN associadas a instâncias de transit router.
	array<object>	As informações sobre uma conexão IPsec-VPN associada a uma instância de transit router.
InstanceId	string	O ID da conexão IPsec-VPN.	vco-p0w2jpkhi2eeop6q6****
Name	string	O nome da conexão IPsec-VPN.	nametest1
Description	string	A descrição da conexão IPsec-VPN.	desctest
AttachType	string	O tipo de recurso ao qual a conexão IPsec-VPN está anexada. O valor é CEN, o que indica que a conexão IPsec-VPN está associada a uma instância de transit router.	CEN
TransitRouterId	string	O ID da instância do vRouter de roteamento de encaminhamento ao qual a conexão IPsec-VPN está anexada.	tr-p0wkh4yryb1dnanqw****
TransitRouterName	string	O nome da instância de transit router.	nametest2
CrossAccountAuthorized	boolean	Indica se a conexão IPsec-VPN está associada a uma instância de transit router que pertence a uma conta diferente da Alibaba Cloud. true: A conexão IPsec-VPN está associada a uma instância de transit router entre contas. false: A conexão IPsec-VPN não está associada a uma instância de transit router entre contas.	false
Tag	string	As tags de sistema da conexão IPsec-VPN. Você pode usar as tags de sistema para verificar se a conexão IPsec-VPN suporta BGP. Você pode ignorar as outras propriedades. BGPSupport: indica se a conexão IPsec-VPN suporta BGP. true: Suportado. false: Não suportado.	{\"description\":\"forwarding1.7.22\",\"VisuallySsl\":\"true\",\"PbrPriority\":\"true\",\"BGPSupport\":\"true\",\"IDaaSNewVersion\":\"true\"}
Tags	array<object>	A lista de tags associadas à conexão IPsec-VPN.
	object	As informações da tag.
Key	string	A chave da tag.	TagKey
Value	string	O valor da tag.	TagValue
TunnelBandwidth	string	A especificação de largura de banda de um único túnel VPN. Valores válidos: Standard (padrão): Padrão. A largura de banda padrão é 1 Gbit/s. Large: Grande. A largura de banda padrão é 3 Gbit/s.	Standard

Exemplos

Resposta de sucesso

JSON formato

{
  "RequestId": "9F0725BB-186A-3564-91C3-AAE48042F853",
  "PageSize": 10,
  "PageNumber": 1,
  "TotalCount": 1,
  "VpnAttachments": [
    {
      "InstanceId": "vco-p0w2jpkhi2eeop6q6****",
      "Name": "nametest1",
      "Description": "desctest",
      "AttachType": "CEN",
      "TransitRouterId": "tr-p0wkh4yryb1dnanqw****",
      "TransitRouterName": "nametest2",
      "CrossAccountAuthorized": false,
      "Tag": "{\\\"description\\\":\\\"forwarding1.7.22\\\",\\\"VisuallySsl\\\":\\\"true\\\",\\\"PbrPriority\\\":\\\"true\\\",\\\"BGPSupport\\\":\\\"true\\\",\\\"IDaaSNewVersion\\\":\\\"true\\\"}",
      "Tags": [
        {
          "Key": "TagKey",
          "Value": "TagValue"
        }
      ],
      "TunnelBandwidth": "Standard"
    }
  ]
}

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.	O recurso de tag está duplicado.
400	SizeLimitExceeded.TagNum	The maximum number of tags is exceeded.	O número de tags excede o limite.
400	InvalidParameter.TagValue	The specified parameter TagValue is invalid.	O parâmetro TagValue especificado é inválido.
400	InvalidParameter.TagKey	The specified parameter TagKey is invalid.	O parâmetro TagKey especificado é inválido.
400	Duplicated.TagKey	The specified parameter TagKey is duplicated.	O parâmetro TagKey especificado está duplicado.

Consulte Códigos de Erro para uma lista completa.

Notas de versão

Consulte Notas de Versão para uma lista completa.