Criação de um gateway de cliente
Função
Essa API é usada para criar um gateway de cliente ao qual um gateway de VPN se conecta.
URI
Parâmetro |
Tipo |
Obrigatório |
Descrição |
---|---|---|---|
project_id |
String |
Sim |
Especifica um ID do projeto. Você pode obter o ID do projeto, referindo-se a Obtenção do ID do projeto. |
Solicitação
- Parâmetros de solicitação
Tabela 2 Parâmetros de solicitação Parâmetro
Tipo
Obrigatório
Descrição
customer_gateway
Sim
Especifica o objeto de gateway de cliente.
Tabela 3 CreateCgwRequestBodyContent Parâmetro
Tipo
Obrigatório
Descrição
name
String
Não
- Especifica o nome de um gateway do cliente. Se este parâmetro não for especificado, um nome no formato cgw-**** é gerado automaticamente, por exemplo, cgw-21a3.
- O valor é uma cadeia de 1 a 64 caracteres, que pode conter dígitos, letras, sublinhados (_) e hifens (-).
route_mode
String
Não
- Especifica o modo de roteamento do gateway do cliente.
- O valor pode ser static ou bgp.
- O valor padrão é bgp.
bgp_asn
Long
Não
- Especifica o número do sistema autônomo do BGP do gateway de cliente.
- O valor varia de 1 a 4294967295.
- O valor padrão é 65000.
- Defina este parâmetro apenas quando route_mode for definido como bgp.
ip
String
Sim
- Especifica o endereço IP do gateway de cliente.
- O valor é um endereço IPv4, por exemplo, 10.***.***.21.
- Exemplo de solicitação
POST https://{Endpoint}/v5/{project_id}/vpn/customer-gateways { "customer_gateway": { "name": "cgw-2abf", "route_mode": "bgp", "bgp_asn": 65000, "ip": "10.***.***.21" } }
Resposta
- Parâmetros de resposta
Código de status 201 retornado: criação bem-sucedida
Tabela 4 Parâmetros no corpo da resposta Parâmetro
Tipo
Descrição
customer_gateway
Especifica o objeto de gateway de cliente.
request_id
String
Especifica um ID da solicitação.
Tabela 5 ResponseCustomerGateway Parâmetro
Tipo
Descrição
id
String
- Especifica um ID de gateway de cliente.
- O valor é um UUID contendo 36 caracteres.
name
String
- Especifica um nome de gateway de cliente. Se nenhum nome de gateway de cliente for especificado, o sistema gera um automaticamente.
- O valor é uma cadeia de 1 a 64 caracteres, que pode conter dígitos, letras, sublinhados (_) e hifens (-).
route_mode
String
- Especifica o modo de roteamento do gateway do cliente.
- O valor pode ser static ou bgp.
bgp_asn
Long
Especifica o número do sistema autônomo do BGP do gateway de cliente. Este parâmetro só está disponível quando route_mode está definido como bgp.
ip
String
- Especifica o endereço IP do gateway de cliente.
- O valor é um endereço IPv4, por exemplo, 10.***.***.21.
created_at
String
Especifica a hora em que o gateway de cliente é criado.
updated_at
String
Especifica a hora da última atualização.
- Exemplo de resposta
{ "customer_gateway": { "id": "03c0aa3d-****-****-****-9d82473765d4", "name": "cgw-2abf", "route_mode": "bgp", "bgp_asn": 65000, "ip": "10.***.***.21", "created_at": "2021-12-21T16:49:28.108+08:00", "updated_at": "2021-12-21T16:49:28.108+08:00" }, "request_id": "7e0383bf-a7fb-461b-a926-baa8a795bf1a" }
Códigos de status
Para mais detalhes, consulte Códigos de status.