DescribeVpnConnection - : Central de Documentação do Alibaba Cloud

Depuração

O OpenAPI Explorer calcula automaticamente o valor da assinatura. Recomendamos chamar esta operação no OpenAPI Explorer para maior conveniência. A ferramenta gera dinamicamente códigos de exemplo da operação para diferentes SDKs.

Parâmetros de solicitação

Parâmetro	Tipo	Obrigatório	Exemplo	Descrição
Action	String	Sim	DescribeVpnConnection	Operação a ser executada. Defina o valor como DescribeVpnConnection.
RegionId	String	Sim	cn-hangzhou	ID da região onde a conexão IPsec-VPN foi criada. Chame a operação DescribeRegions para consultar a lista de regiões mais recente.
VpnConnectionId	String	Sim	vco-bp1bbi27hojx80nck****	ID da conexão IPsec-VPN.

Parâmetros de resposta

Parâmetro	Tipo	Exemplo	Descrição
Status	String	ike_sa_not_established	Status da conexão IPsec-VPN. Valores válidos: ike_sa_not_established: falha nas negociações da Fase 1. ike_sa_established: negociações da Fase 1 bem-sucedidas. ipsec_sa_not_established: falha nas negociações da Fase 2. ipsec_sa_established: negociações da Fase 2 bem-sucedidas.
RemoteCaCertificate	String	-----BEGIN CERTIFICATE----- MIIB7zCCAZW****	Certificado CA do par.
EnableNatTraversal	Boolean	true	Indica se o NAT traversal está ativado para a conexão IPsec-VPN. true false Com o NAT traversal ativado, o iniciador não verifica as portas UDP durante as negociações IKE e descobre automaticamente dispositivos de gateway NAT ao longo do túnel VPN.
CreateTime	Long	1492753817000	Timestamp que indica quando a conexão IPsec-VPN foi estabelecida. Unidade: milissegundos. Este valor é um timestamp UNIX que representa o número de milissegundos decorridos desde a época (epoch time) de 1º de janeiro de 1970, 00:00:00 UTC.
EffectImmediately	Boolean	true	Indica se as negociações IPsec começam imediatamente. true: as negociações são reiniciadas após a alteração da configuração. false: as negociações são reiniciadas ao detectar tráfego.
VpnGatewayId	String	vpn-bp1q8bgx4xnkm2ogj****	ID do gateway VPN.
LocalSubnet	String	10.0.0.0/8	Bloco CIDR no lado da Alibaba Cloud. Blocos CIDR são separados por vírgulas (,).
RequestId	String	F2310D45-BCF6-4E2E-9082-B4503844BA4C	ID da solicitação.
VpnConnectionId	String	vco-bp1bbi27hojx80nck****	ID da conexão IPsec-VPN.
RemoteSubnet	String	192.168.0.0/16	Bloco CIDR no lado do data center. Blocos CIDR são separados por vírgulas (,).
CustomerGatewayId	String	cgw-bp1mvj4g9kogwwcxk****	ID do customer gateway associado à conexão IPsec-VPN.
Name	String	ipsec1	Nome da conexão IPsec-VPN.
EnableDpd	Boolean	true	Indica se o dead peer detection (DPD) está ativado para a conexão IPsec-VPN. Valores válidos: false true Ao ativar o DPD, o iniciador da conexão IPsec-VPN envia pacotes DPD para verificar a existência e a disponibilidade do par. Se nenhuma resposta for recebida dentro do período especificado, a conexão falhará. Em seguida, o ISAKMP SA, o IPsec SA e o túnel IPsec serão excluídos.
IkeConfig	Object		Configurações das negociações da Fase 1.
RemoteId	String	139.34.XX.XX	Identificador no lado do data center.
IkeLifetime	Long	86400	Tempo de vida na fase IKE. Unidade: segundos.
IkeEncAlg	String	aes	Algoritmo de criptografia na fase IKE.
LocalId	String	116.28.XX.XX	Identificador no lado da Alibaba Cloud.
IkeMode	String	main	Modo de negociação IKE. Valores válidos: main: oferece maior segurança durante as negociações. aggressive: modo mais rápido e com maior taxa de sucesso.
IkeVersion	String	ikev1	Versão do IKE. ikev1 ikev2 Em comparação com o IKEv1, o IKEv2 simplifica o processo de negociação de SA e é mais adequado para cenários com vários blocos CIDR.
IkePfs	String	group2	Grupo DH na fase IKE.
Psk	String	pgw6dy****	Chave pré-compartilhada.
IkeAuthAlg	String	sha1	Algoritmo de autenticação na fase IKE.
IpsecConfig	Object		Configurações das negociações da Fase 2.
IpsecAuthAlg	String	sha1	Algoritmo de autenticação na fase IPsec.
IpsecLifetime	Long	86400	Tempo de vida na fase IPsec. Unidade: segundos.
IpsecEncAlg	String	aes	Algoritmo de criptografia na fase IPsec.
IpsecPfs	String	group2	Grupo DH na fase IPsec.
VcoHealthCheck	Object		Informações de verificação de integridade da conexão IPsec-VPN.
Status	String	failed	Status da verificação de integridade. Valores válidos: failed success
Dip	String	10.0.0.1	Endereço IP de destino.
Interval	Integer	3	Intervalo entre novas tentativas de verificação de integridade. Unidade: segundos.
Retry	Integer	3	Número máximo de novas tentativas de verificação de integridade.
Sip	String	192.168.1.1	Endereço IP de source.
Enable	String	true	Indica se o recurso de verificação de integridade está ativado para a conexão IPsec-VPN. Valores válidos: false true
Policy	String	revoke_route	Indica se as rotas anunciadas são retiradas quando a verificação de integridade falha. revoke_route reserve_route
VpnBgpConfig	Object		Configuração BGP da conexão IPsec-VPN.
Status	String	success	Status de negociação do protocolo de roteamento BGP. success failed
PeerBgpIp	String	169.254.11.1	Endereço IP BGP do par.
TunnelCidr	String	169.254.11.0/30	Bloco CIDR BGP da conexão IPsec-VPN. O bloco CIDR está dentro de 169.254.0.0/16. A máscara do bloco CIDR tem 30 bits de comprimento.
EnableBgp	String	true	Status do protocolo de roteamento BGP. Valores válidos: true false
LocalBgpIp	String	169.254.11.2	Endereço IP BGP no lado da Alibaba Cloud.
PeerAsn	Long	65530	Número do sistema autônomo (ASN) do par.
LocalAsn	Long	65531	ASN no lado da Alibaba Cloud.
AuthKey	String	AuthKey****	Chave de autenticação do protocolo de roteamento BGP.
AttachType	String	CEN	Tipo de recurso associado à conexão IPsec-VPN. Valores válidos: CEN: a conexão IPsec-VPN está associada a um transit router de uma instância Cloud Enterprise Network (CEN). NO_ASSOCIATED: a conexão IPsec-VPN não está associada a nenhum recurso. VPNGW: a conexão IPsec-VPN está associada a um gateway VPN.
NetworkType	String	public	Tipo de rede da conexão IPsec-VPN. Valores válidos: public private
AttachInstanceId	String	cen-lxxpbpalc776qz****	ID da instância CEN à qual o transit router pertence.
Spec	String	1000M	Especificação de largura de banda da conexão IPsec-VPN. Unidade: Mbit/s.
State	String	attached	Status de associação da conexão IPsec-VPN. Valores válidos: active: a conexão IPsec-VPN está associada a um gateway VPN. init: a conexão IPsec-VPN não está associada a um recurso e está sendo inicializada. attaching: a conexão IPsec-VPN está sendo associada a um transit router. attached: a conexão IPsec-VPN está associada a um transit router. detaching: a conexão IPsec-VPN está sendo desassociada de um transit router. financialLocked: a conexão IPsec-VPN está bloqueada devido a pagamentos em atraso. provisioning: a conexão IPsec-VPN está sendo preparada. updating: a conexão IPsec-VPN está sendo atualizada. upgrading: a conexão IPsec-VPN está sendo atualizada para uma versão superior. deleted: a conexão IPsec-VPN foi excluída.
ZoneNo	String	ap-southeast-2b	ID da zona onde a conexão IPsec-VPN está implantada. Chame DescribeZones para consultar os IDs das zonas.
InternetIp	String	47.XX.XX.162	Endereço IP do gateway da conexão IPsec-VPN.
TransitRouterId	String	tr-p0we2edef9qr44a85****	ID do transit router ao qual a conexão IPsec-VPN está associada.
TransitRouterName	String	nametest	Nome do transit router.
CrossAccountAuthorized	Boolean	false	Indica se a conexão IPsec-VPN está associada a um transit router que pertence a outra conta da Alibaba Cloud. Valores válidos: true false
Tags	Array of Tag		Lista de tags adicionadas à conexão IPsec-VPN.
Tag
Key	String	TagKey	Chave da tag N.
Value	String	TagValue	Valor da tag N.
TunnelOptionsSpecification	Array of TunnelOptions		Configuração do túnel da conexão IPsec-VPN. Os parâmetros em TunnelOptionsSpecification são retornados apenas se você consultar conexões IPsec-VPN no modo de túnel duplo.
TunnelOptions
TunnelId	String	tun-opsqc4d97wni27****	ID do túnel.
CustomerGatewayId	String	cgw-p0wy363lucf1uyae8****	ID do customer gateway associado ao túnel.
EnableDpd	String	true	Indica se o DPD está ativado para o túnel. Valores válidos: false true
EnableNatTraversal	String	true	Indica se o NAT traversal está ativado para o túnel. false true
InternetIp	String	47.21.XX.XX	Endereço IP do túnel.
RemoteCaCertificate	String	-----BEGIN CERTIFICATE----- MIIB7zCCAZW**** -----END CERTIFICATE-----	Certificado CA do par do túnel. Este parâmetro é retornado apenas se o gateway VPN for do tipo ShangMi (SM).
Role	String	master	Função do túnel. Valores válidos: master slave
State	String	active	Status do túnel. Valores válidos: active updating deleting
Status	String	ipsec_sa_established	Status da conexão IPsec-VPN. Valores válidos: ike_sa_not_established: falha nas negociações da Fase 1. ike_sa_established: negociações da Fase 1 bem-sucedidas. ipsec_sa_not_established: falha nas negociações da Fase 2. ipsec_sa_established: negociações da Fase 2 bem-sucedidas.
TunnelBgpConfig	Object		Configurações BGP.
BgpStatus	String	success	Status de negociação do BGP. Valores válidos: success false
LocalAsn	String	65530	ASN no lado da Alibaba Cloud.
LocalBgpIp	String	169.254.10.1	Endereço IP BGP no lado da Alibaba Cloud.
PeerAsn	String	65531	ASN do par.
PeerBgpIp	String	169.254.10.2	Endereço IP BGP do par.
TunnelCidr	String	169.254.10.0/30	Bloco CIDR BGP do túnel.
TunnelIkeConfig	Object		Configurações das negociações da Fase 1.
IkeAuthAlg	String	sha1	Algoritmo de autenticação na fase IKE.
IkeEncAlg	String	aes	Algoritmo de criptografia na fase IKE.
IkeLifetime	String	86400	Tempo de vida na fase IKE. Unidade: segundos.
IkeMode	String	main	Modo de negociação IKE. Valores válidos: main: oferece maior segurança durante as negociações. aggressive: modo mais rápido e com maior taxa de sucesso.
IkePfs	String	group2	Grupo DH na fase IKE.
IkeVersion	String	ikev1	Versão do IKE.
LocalId	String	47.21.XX.XX	Identificador no lado da Alibaba Cloud.
Psk	String	123456****	Chave pré-compartilhada.
RemoteId	String	47.42.XX.XX	Identificador do par.
TunnelIpsecConfig	Object		Configurações das negociações da Fase 2.
IpsecAuthAlg	String	sha1	Algoritmo de autenticação na fase IPsec.
IpsecEncAlg	String	aes	Algoritmo de criptografia na fase IPsec.
IpsecLifetime	String	86400	Tempo de vida na fase IPsec. Unidade: segundos.
IpsecPfs	String	group2	Grupo DH na fase IPsec.
ZoneNo	String	ap-southeast-5a	Zona onde o túnel está implantado. Chame DescribeZones para consultar os IDs das zonas.
EnableTunnelsBgp	Boolean	true	Status BGP do túnel. Valores válidos: true false

Exemplos

Solicitações de exemplo

http(s)://[Endpoint]/?Action=DescribeVpnConnection
&RegionId=cn-hangzhou
&VpnConnectionId=vco-bp1bbi27hojx80nck****
&Common request parameters

Respostas de sucesso de exemplo

Formato XML

HTTP/1.1 200 OK
Content-Type:application/xml

<DescribeVpnConnectionResponse>
    <Status>ike_sa_not_established</Status>
    <RemoteCaCertificate>-----BEGIN CERTIFICATE----- MIIB7zCCAZW****</RemoteCaCertificate>
    <EnableNatTraversal>true</EnableNatTraversal>
    <CreateTime>1492753817000</CreateTime>
    <EffectImmediately>true</EffectImmediately>
    <VpnGatewayId>vpn-bp1q8bgx4xnkm2ogj****</VpnGatewayId>
    <State>active</State>
    <LocalSubnet>10.0.0.0/8</LocalSubnet>
    <RequestId>F2310D45-BCF6-4E2E-9082-B4503844BA4C</RequestId>
    <VpnConnectionId>vco-bp1bbi27hojx80nck****</VpnConnectionId>
    <RemoteSubnet>192.168.0.0/16</RemoteSubnet>
    <CustomerGatewayId>cgw-bp1mvj4g9kogwwcxk****</CustomerGatewayId>
    <Name>ipsec1</Name>
    <EnableDpd>true</EnableDpd>
    <IkeConfig>
        <RemoteId>139.34.XX.XX</RemoteId>
        <IkeLifetime>86400</IkeLifetime>
        <IkeEncAlg>aes</IkeEncAlg>
        <LocalId>116.28.XX.XX</LocalId>
        <IkeMode>main</IkeMode>
        <IkeVersion>ikev1</IkeVersion>
        <IkePfs>group2</IkePfs>
        <Psk>pgw6dy****</Psk>
        <IkeAuthAlg>sha1</IkeAuthAlg>
    </IkeConfig>
    <IpsecConfig>
        <IpsecAuthAlg>sha1</IpsecAuthAlg>
        <IpsecLifetime>86400</IpsecLifetime>
        <IpsecEncAlg>aes</IpsecEncAlg>
        <IpsecPfs>group2</IpsecPfs>
    </IpsecConfig>
    <VcoHealthCheck>
        <Status>failed</Status>
        <Dip>10.0.0.1</Dip>
        <Interval>3</Interval>
        <Retry>3</Retry>
        <Sip>192.168.1.1</Sip>
        <Enable>true</Enable>
    </VcoHealthCheck>
    <VpnBgpConfig>
        <Status>success</Status>
        <PeerBgpIp>169.254.11.1</PeerBgpIp>
        <TunnelCidr>169.254.11.0/30</TunnelCidr>
        <EnableBgp>true</EnableBgp>
        <LocalBgpIp>169.254.11.2</LocalBgpIp>
        <PeerAsn>65530</PeerAsn>
        <LocalAsn>65531</LocalAsn>
        <AuthKey>AuthKey****</AuthKey>
    </VpnBgpConfig>
</DescribeVpnConnectionResponse>

Formato JSON

HTTP/1.1 200 OK
Content-Type:application/json

{
  "Status" : "ike_sa_not_established",
  "RemoteCaCertificate" : "-----BEGIN CERTIFICATE----- MIIB7zCCAZW****",
  "EnableNatTraversal" : true,
  "CreateTime" : 1492753817000,
  "EffectImmediately" : true,
  "VpnGatewayId" : "vpn-bp1q8bgx4xnkm2ogj****",
  "State" : "active",
  "LocalSubnet" : "10.0.0.0/8",
  "RequestId" : "F2310D45-BCF6-4E2E-9082-B4503844BA4C",
  "VpnConnectionId" : "vco-bp1bbi27hojx80nck****",
  "RemoteSubnet" : "192.168.0.0/16",
  "CustomerGatewayId" : "cgw-bp1mvj4g9kogwwcxk****",
  "Name" : "ipsec1",
  "EnableDpd" : true,
  "IkeConfig" : {
    "RemoteId" : "139.34.XX.XX",
    "IkeLifetime" : 86400,
    "IkeEncAlg" : "aes",
    "LocalId" : "116.28.XX.XX",
    "IkeMode" : "main",
    "IkeVersion" : "ikev1",
    "IkePfs" : "group2",
    "Psk" : "pgw6dy****",
    "IkeAuthAlg" : "sha1"
  },
  "IpsecConfig" : {
    "IpsecAuthAlg" : "sha1",
    "IpsecLifetime" : 86400,
    "IpsecEncAlg" : "aes",
    "IpsecPfs" : "group2"
  },
  "VcoHealthCheck" : {
    "Status" : "failed",
    "Dip" : "10.0.0.1",
    "Interval" : 3,
    "Retry" : 3,
    "Sip" : "192.168.1.1",
    "Enable" : "true"
  },
  "VpnBgpConfig" : {
    "Status" : "success",
    "PeerBgpIp" : "169.254.11.1",
    "TunnelCidr" : "169.254.11.0/30",
    "EnableBgp" : "true",
    "LocalBgpIp" : "169.254.11.2",
    "PeerAsn" : 65530,
    "LocalAsn" : 65531,
    "AuthKey" : "AuthKey****"
  }
}

Códigos de erro

HttpCode	Código de erro	Mensagem de erro	Descrição
403	Forbbiden.SubUser	User not authorized to operate on the specified resource as your account is created by another user.	Você não tem autorização para executar esta operação no recurso especificado. Solicite as permissões necessárias e tente novamente.
403	Forbidden	User not authorized to operate on the specified resource.	Você não tem autorização para executar esta operação no recurso especificado. Solicite as permissões necessárias e tente novamente.
404	InvalidVpnConnectionInstanceId.NotFound	The specified vpn connection instance id does not exist.	A conexão IPsec especificada não existe. Verifique se o ID da conexão IPsec é válido.

Para obter uma lista de códigos de erro, consulte Códigos de erro do serviço.