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

Cria um gateway de cliente.

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

create

*CustomerGateway.

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

Nenhuma

Parâmetros da solicitação

Parâmetro	Tipo	Obrigatório	Descrição	Exemplo
RegionId	string	Sim	O ID da região do gateway de cliente. Você pode chamar a operação DescribeRegions para consultar o ID da região.	cn-shanghai
ClientToken	string	Não	O token de cliente usado para garantir a idempotência da solicitação. Você pode usar o cliente para gerar o token, mas deve garantir que o token seja exclusivo entre diferentes solicitações. O token pode conter apenas caracteres ASCII e não pode exceder 64 caracteres de comprimento. Nota Se você não especificar este parâmetro, o sistema usará automaticamente o RequestId da solicitação de API como o ClientToken. O RequestId pode ser diferente para cada solicitação de API.	02fb3da4-130e-11e9-8e44****
IpAddress	string	Sim	O endereço IP estático do dispositivo de gateway no data center local. Se você deseja criar uma conexão IPsec-VPN que usa o tipo de rede pública, insira um endereço IP público. Se você deseja criar uma conexão IPsec-VPN que usa o tipo de rede privada, insira um endereço IP privado. Os seguintes endereços IP não são suportados. Se você usar esses endereços IP, a conexão IPsec-VPN não poderá ser estabelecida: 100.64.0.0 a 100.127.255.255 127.0.0.0 a 127.255.255.255 169.254.0.0 a 169.254.255.255 224.0.0.0 a 239.255.255.255 255.0.0.0 a 255.255.255.255	101.12.XX.XX
Name	string	Não	O nome do gateway de cliente. O nome deve ter de 1 a 100 caracteres de comprimento e não pode começar com `http://` ou `https://`.	nametest
Description	string	Não	A descrição do gateway de cliente. A descrição deve ter de 1 a 100 caracteres de comprimento e não pode começar com `http://` ou `https://`.	desctest
Asn	string	Não	Se você planeja ativar o protocolo de roteamento dinâmico BGP para a conexão IPsec-VPN, é necessário alocar o Número do Sistema Autônomo (ASN) do dispositivo de gateway no data center local. Valores válidos: 1 a 4294967295. O valor 45104 não é suportado. Asn é um número de 4 bytes. Você pode inserir o número no formato de dois segmentos: os primeiros 16 bits.os últimos 16 bits. Cada segmento é inserido no formato decimal. Por exemplo, se você inserir 123.456, o ASN será 123 × 65536 + 456 = 8061384. Nota Use um ASN privado para estabelecer uma conexão BGP com o Alibaba Cloud. Para obter mais informações sobre o intervalo de ASNs privados, consulte a documentação relevante. 45104 é uma identidade exclusiva alocada à Alibaba Cloud Computing Co., Ltd. pela Internet Assigned Numbers Authority (IANA). É usada como identidade para o Alibaba Cloud no roteamento global da Internet e na transmissão de dados.	65530
AuthKey	string	Não	A chave de autenticação do protocolo de roteamento BGP para o dispositivo de gateway no data center local. A chave deve ter de 1 a 64 caracteres de comprimento e pode conter apenas caracteres ASCII. Espaços, caracteres chineses e pontos de interrogação de meia largura (?) não são suportados.	AuthKey****
Tags	array<object>	Não	A lista de tags a serem adicionadas ao gateway de cliente. Você pode adicionar até 20 tags a um gateway de cliente por vez.
	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 de comprimento 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 de comprimento 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 gateway de cliente pertence. Você pode chamar a operação ListResourceGroups para consultar o ID do grupo de recursos. Se você não especificar um grupo de recursos, o gateway de cliente pertencerá ao grupo de recursos padrão após ser criado.	rg-aek2qo2h4jy****

Elementos de resposta

Elemento	Tipo	Descrição	Exemplo
	object	Os parâmetros de resposta.
RequestId	string	O ID da solicitação.	D32B3C26-6C6C-4988-93E9-D2A6444CE6AE
IpAddress	string	O endereço IP estático do dispositivo de gateway no data center local.	101.12.XX.XX
Description	string	A descrição do gateway de cliente.	desctest
CustomerGatewayId	string	O ID da instância do gateway de cliente.	cgw-bp1jrawp82av6bws9****
CreateTime	integer	O timestamp de quando o gateway de cliente foi criado. Unidade: milissegundos. O timestamp está no formato UNIX e representa o número de milissegundos decorridos desde 1º de janeiro de 1970, 00:00:00 UTC.	1493363486000
Name	string	O nome do gateway de cliente.	nametest

Exemplos

Resposta de sucesso

JSON formato

{
  "RequestId": "D32B3C26-6C6C-4988-93E9-D2A6444CE6AE",
  "IpAddress": "101.12.XX.XX",
  "Description": "desctest",
  "CustomerGatewayId": "cgw-bp1jrawp82av6bws9****",
  "CreateTime": 1493363486000,
  "Name": "nametest"
}

Códigos de erro

Código de status HTTP	Código de erro	Mensagem de erro	Descrição
400	InvalidAuthkey.Malformed	The specified BGP authentication key (%s) is malformed.	A chave de autenticação BGP é inválida.
400	InvalidIpAddress.AlreadyExist	Specified IpAddress is already exist.	O endereço IP já existe. O mesmo endereço IP não pode ser usado mais de uma vez pela mesma conta na mesma região.
400	InvalidIpAddress.WrongFormat	Specified IpAddress is invalid.
400	InvalidName	The name is not valid
400	InvalidDescription	The description is not valid
400	Resource.QuotaFull	The quota of resource is full
400	IllegalParam.Asn	The specified Asn is invalid.	O ASN especificado não está em conformidade com a especificação.
400	OperationDenied.MissingAsn	The autonomous system number of the customer gateway is mandatory when BGP authentication key is specified.	Quando uma chave de autenticação BGP é especificada para o gateway do cliente, o número do sistema autônomo também deve ser especificado.
400	InvalidParameter.TagValue	The specified parameter TagValue is invalid.	O parâmetro TagValue especificado é inválido.
400	SizeLimitExceeded.TagNum	The maximum number of tags is exceeded.	O número de tags excede o limite.
400	Forbidden.TagKey.Duplicated	The specified tag key already exists.	O recurso de tag está duplicado.
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.
400	OperationFailed.NoRamPermission	Vpn Service has no permission to operate your IDaaS instances.	O serviço VPN não tem permissão para operar em sua instância IDaaS.
400	CreateVpnUserGatewayQuotaFull.QuotaFull	The number of created VPN customer gateways exceeds the quota.	O número de gateways de cliente VPN excede o limite de cota.
403	Forbidden.SubUser	User not authorized to operate on the specified resource as your account is created by another user.	Você não tem permissão para operar neste recurso. Solicite a permissão necessária e tente novamente.
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.
409	OperationConflict	The operation against this instance is too frequent, please try again later.	Ocorreu um conflito de solicitação. Tente novamente mais tarde.

Consulte Códigos de Erro para uma lista completa.

Notas de versão

Consulte Notas de Versão para uma lista completa.