Atualização de um gateway virtual
Função
Esta API é usada para atualizar um gateway virtual.
URI
PUT /v3/{project_id}/dcaas/virtual-gateways/{virtual_gateway_id}
|
Parâmetro |
Obrigatório |
Tipo |
Descrição |
|---|---|---|---|
|
project_id |
Sim |
String |
Especifica o ID do projeto. |
|
virtual_gateway_id |
Sim |
String |
Especifica o ID do gateway virtual. |
Parâmetros de solicitação
|
Parâmetro |
Obrigatório |
Tipo |
Descrição |
|---|---|---|---|
|
X-Auth-Token |
Sim |
String |
Especifica o token do usuário. Para obter o token, consulte a seção "Obtenção do token do usuário" na Referência de API do Identity and Access Management. O token é o valor de X-Subject-Token no cabeçalho de resposta. Mínimo: 0 Máximo: 10240 |
|
Parâmetro |
Obrigatório |
Tipo |
Descrição |
|---|---|---|---|
|
virtual_gateway |
Não |
UpdateVirtualGateway object |
Especifica o gateway virtual a ser atualizado. |
|
Parâmetro |
Obrigatório |
Tipo |
Descrição |
|---|---|---|---|
|
name |
Não |
String |
Especifica o nome do gateway virtual. Mínimo: 0 Máximo: 64 |
|
description |
Não |
String |
Fornece informações suplementares sobre o gateway virtual. Mínimo: 0 Máximo: 128 |
|
local_ep_group |
Não |
Array of strings |
Especifica as sub-redes IPv4 conectadas pelo gateway virtual, que geralmente são os blocos CIDR de uma VPC. |
|
local_ep_group_ipv6 |
Não |
Array of strings |
Especifica as sub-redes IPv6 conectadas pelo gateway virtual, que geralmente são os blocos CIDR de uma VPC. |
Parâmetros de resposta
Código de status: 200
|
Parâmetro |
Tipo |
Descrição |
|---|---|---|
|
virtual_gateway |
VirtualGateway object |
Especifica parâmetros para a criação de um gateway virtual. |
|
request_id |
String |
Especifica o ID da solicitação. |
|
Parâmetro |
Tipo |
Descrição |
|---|---|---|
|
id |
String |
Especifica o ID do gateway virtual. |
|
vpc_id |
String |
Especifica o ID da VPC conectada pelo gateway virtual. |
|
tenant_id |
String |
Especifica o ID do projeto ao qual a instância pertence. Mínimo: 32 Máximo: 32 |
|
name |
String |
Especifica o nome do gateway virtual. Mínimo: 0 Máximo: 64 |
|
description |
String |
Fornece informações suplementares sobre o gateway virtual. Mínimo: 0 Máximo: 128 |
|
type |
String |
Especifica o tipo de gateway virtual. O valor só pode ser default. Padrão: default Valores de enumeração:
|
|
local_ep_group |
Array of strings |
Especifica as sub-redes IPv4 conectadas pelo gateway virtual, que geralmente são os blocos CIDR de uma VPC. |
|
local_ep_group_ipv6 |
Array of strings |
Especifica as sub-redes IPv6 conectadas pelo gateway virtual, que geralmente são os blocos CIDR de uma VPC. Este é um campo reservado. |
|
admin_state_up |
Boolean |
Especifica o status administrativo, que pode ser true ou false. Padrão: true |
|
status |
String |
Especifica o status do gateway virtual, que pode ser ACTIVE, DOWN, BUILD, ERROR, PENDING_CREATE, PENDING_UPDATE ou PENDING_DELETE. |
|
bgp_asn |
Integer |
Especifica o ASN BGP local do gateway virtual. Mínimo: 1 Máximo: 4294967295 |
|
enterprise_project_id |
String |
Especifica o ID do projeto empresarial ao qual o gateway virtual pertence. Mínimo: 36 Máximo: 36 |
|
tags |
Array of Tag objects |
Especifica as tags. |
|
Parâmetro |
Tipo |
Descrição |
|---|---|---|
|
key |
String |
Especifica a chave de tag. A chave pode conter no máximo 36 caracteres Unicode, incluindo letras, dígitos, hifens (-) e sublinhados (_). Mínimo: 0 Máximo: 36 |
|
value |
String |
Especifica o valor de tag. O valor pode conter no máximo 43 caracteres Unicode, incluindo letras, dígitos, hifens (-) sublinhados (_) e pontos (.). Mínimo: 0 Máximo: 43 |
Exemplos de solicitações
Atualização de um gateway virtual
PUT https://{dc_endpoint}/v3/0605768a3300d5762f82c01180692873/dcaas/virtual-gateways/20082c1b-3c99-48d8-8e8c-116af5d7e9f0
{
"virtual_gateway" : {
"name" : "update-vgw-c7b22",
"description" : "",
"local_ep_group" : [ "192.168.3.0/24" ]
}
}
Exemplo de respostas
Código de status: 200
OK
{
"virtual_gateway" : {
"id" : "20082c1b-3c99-48d8-8e8c-116af5d7e9f0",
"name" : "update-vgw-c7b22",
"description" : "",
"tenant_id" : "0605768a3300d5762f82c01180692873",
"vpc_id" : "6592c28e-95d7-4b0a-9f61-004fdf03420c",
"type" : "default",
"status" : "ACTIVE",
"admin_state_up" : true,
"bgp_asn" : 64512,
"local_ep_group" : [ "192.168.3.0/24" ],
"enterprise_project_id" : "0"
},
"request_id" : "765f7aaf8f2edd0e719de564ef72e2de"
}
Códigos de status
|
Código de status |
Descrição |
|---|---|
|
200 |
OK |
Códigos de erro
Consulte Códigos de erro.