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

Consulta os servidores IPsec que foram criados.

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

list

*Todos os recursos.

*

Nenhuma

Parâmetros da solicitação

Parâmetro	Tipo	Obrigatório	Descrição	Exemplo
RegionId	string	Sim	O ID da região do servidor IPsec. Você pode chamar a operação DescribeRegions para consultar o ID da região.	cn-hangzhou
IpsecServerName	string	Não	O nome do servidor IPsec. O nome deve ter de 1 a 100 caracteres.	test
VpnGatewayId	string	Não	O ID do gateway VPN.	vpn-bp1q8bgx4xnkm2ogj****
NextToken	string	Não	O token de paginação. Valores válidos: Você não precisa especificar este parâmetro na primeira solicitação ou se não houver consulta subsequente. Se existir uma consulta subsequente, defina o valor como o valor NextToken retornado pela chamada de API anterior.	caeba0bbb2be03f84eb48b699f0a****
MaxResults	integer	Não	O número de entradas por página. Valores válidos: 1 a 20. Valor padrão: 10.	10
IpsecServerId	array	Não	O ID do servidor IPsec.	iss-bp1bo3xuvcxo7ixll****
	string	Não	O ID do servidor IPsec. Valores válidos de N: 1 a 20.	iss-bp1bo3xuvcxo7ixll****
ResourceGroupId	string	Não	O ID do grupo de recursos ao qual o servidor IPsec pertence. O servidor IPsec pertence ao mesmo grupo de recursos da instância de gateway VPN associada. Você pode chamar a operação DescribeVpnGateway para consultar o ID do grupo de recursos da instância de gateway VPN.	rg-acfmzs372yg****

Elementos de resposta

Elemento	Tipo	Descrição	Exemplo
	object
NextToken	string	O token de paginação. Valores válidos: Se NextToken estiver vazio, não há consulta subsequente. Se NextToken for retornado, o valor indica o token para a próxima consulta.	caeba0bbb2be03f84eb48b699f0a****
RequestId	string	O ID da solicitação.	54B48E3D-DF70-471B-AA93-08E683A1B457
TotalCount	integer	O número total de entradas retornadas.	10
MaxResults	integer	O número de entradas por página.	1
IpsecServers	array<object>	A lista de servidores IPsec.
	array<object>
CreationTime	string	A hora em que o servidor IPsec foi criado. T é o delimitador. Z indica UTC.	2018-12-03T10:11:55Z
OnlineClientCount	integer	O número de clientes conectados ao servidor IPsec.	1
InternetIp	string	O endereço IP público do gateway VPN.	47.22.XX.XX
IpsecServerName	string	O nome do servidor IPsec.	test
IDaaSInstanceId	string	O ID da instância do IDaaS.	idaas-cn-hangzhou-****
EffectImmediately	boolean	Indica se o túnel IPsec atual é excluído e as negociações são reiniciadas. true: As negociações são reiniciadas após a conclusão da configuração. false: As negociações são reiniciadas quando o tráfego é detectado.	false
VpnGatewayId	string	O ID do gateway VPN.	vpn-bp1q8bgx4xnkm2ogj****
LocalSubnet	string	O bloco CIDR local, que é o bloco CIDR do lado da VPC que precisa se comunicar com o bloco CIDR do cliente.	192.168.0.0/16,172.17.0.0/16
Psk	string	A chave pré-compartilhada.	pgw6dy7d****
RegionId	string	O ID da região do servidor IPsec.	cn-hangzhou
PskEnabled	boolean	Indica se a autenticação por chave pré-compartilhada está ativada. O valor é true, o que indica que a autenticação por chave pré-compartilhada está ativada.	true
IpsecServerId	string	O ID do servidor IPsec.	iss-bp1bo3xuvcxo7ixll****
MultiFactorAuthEnabled	boolean	Indica se a autenticação de dois fatores está ativada. true: A autenticação de dois fatores está ativada. false: A autenticação de dois fatores está desativada.	true
MaxConnections	integer	O número máximo de conexões SSL-VPN suportadas pelo gateway VPN. Nota SSL-VPN e o servidor IPsec compartilham as conexões SSL-VPN. Por exemplo, se o número máximo de conexões SSL-VPN for 5 e três clientes SSL estiverem conectados ao SSL-VPN, apenas mais dois clientes poderão se conectar ao servidor IPsec.	5
ClientIpPool	string	O bloco CIDR do cliente, que é o bloco CIDR a partir do qual os endereços IP são atribuídos aos controladores de interface de rede virtual dos clientes.	10.0.0.0/24
IkeConfig	object	As configurações das negociações da Fase 1.
RemoteId	string	O identificador do par. Os formatos FQDN e endereço IP são suportados. O valor padrão é vazio.	139.67.XX.XX
IkeLifetime	integer	O tempo de vida do IKE. Unidade: segundos.	86400
IkeEncAlg	string	O algoritmo de criptografia IKE.	aes
LocalId	string	O identificador do servidor IPsec. Os formatos FQDN e endereço IP são suportados. O valor padrão é o endereço IP público do gateway VPN selecionado.	116.64.XX.XX
IkeMode	string	O modo de negociação IKE. Valores válidos: main: modo principal. As negociações são altamente seguras.	main
IkeVersion	string	A versão do IKE.	ikev2
IkePfs	string	O algoritmo de troca de chaves Diffie-Hellman.	group2
IkeAuthAlg	string	O algoritmo de autenticação IKE.	sha1
IpsecConfig	object	As configurações das negociações da Fase 2.
IpsecAuthAlg	string	O algoritmo de autenticação IPsec.	sha1
IpsecLifetime	integer	O tempo de vida do IPsec. Unidade: segundos.	86400
IpsecEncAlg	string	O algoritmo de criptografia IPsec.	aes
IpsecPfs	string	O algoritmo de troca de chaves Diffie-Hellman.	group2
ResourceGroupId	string	O ID do grupo de recursos ao qual o servidor IPsec pertence. Você pode chamar a operação ListResourceGroups para consultar informações sobre grupos de recursos.	rg-acfmzs372yg****

Exemplos

Resposta de sucesso

JSON formato

{
  "NextToken": "caeba0bbb2be03f84eb48b699f0a****",
  "RequestId": "54B48E3D-DF70-471B-AA93-08E683A1B457",
  "TotalCount": 10,
  "MaxResults": 1,
  "IpsecServers": [
    {
      "CreationTime": "2018-12-03T10:11:55Z",
      "OnlineClientCount": 1,
      "InternetIp": "47.22.XX.XX",
      "IpsecServerName": "test",
      "IDaaSInstanceId": "idaas-cn-hangzhou-****",
      "EffectImmediately": false,
      "VpnGatewayId": "vpn-bp1q8bgx4xnkm2ogj****",
      "LocalSubnet": "192.168.0.0/16,172.17.0.0/16",
      "Psk": "pgw6dy7d****",
      "RegionId": "cn-hangzhou",
      "PskEnabled": true,
      "IpsecServerId": "iss-bp1bo3xuvcxo7ixll****",
      "MultiFactorAuthEnabled": true,
      "MaxConnections": 5,
      "ClientIpPool": "10.0.0.0/24",
      "IkeConfig": {
        "RemoteId": "139.67.XX.XX",
        "IkeLifetime": 86400,
        "IkeEncAlg": "aes",
        "LocalId": "116.64.XX.XX",
        "IkeMode": "main",
        "IkeVersion": "ikev2",
        "IkePfs": "group2",
        "IkeAuthAlg": "sha1"
      },
      "IpsecConfig": {
        "IpsecAuthAlg": "sha1",
        "IpsecLifetime": 86400,
        "IpsecEncAlg": "aes",
        "IpsecPfs": "group2"
      },
      "ResourceGroupId": "rg-acfmzs372yg****"
    }
  ]
}

Códigos de erro

Código de status HTTP	Código de erro	Mensagem de erro	Descrição
400	IllegalParam.NextToken	The specified NextToken is invalid.	O parâmetro NextToken é inválido.
403	Forbidden	User not authorized to operate on the specified resource.	O EIP não pertence ao chamador atual. Verifique se você tem permissão para chamar este EIP.

Consulte Códigos de Erro para uma lista completa.

Notas de versão

Consulte Notas de Versão para uma lista completa.