Atualização de uma interface virtual
Função
Essa API é usada para atualizar uma interface virtual.
URI
PUT /v3/{project_id}/dcaas/virtual-interfaces/{virtual_interface_id}
Parâmetro |
Obrigatório |
Tipo |
Descrição |
---|---|---|---|
project_id |
Sim |
String |
Especifica o ID do projeto. |
virtual_interface_id |
Sim |
String |
Especifica o ID da interface virtual. Mínimo: 36 Máximo: 36 |
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_interface |
Sim |
UpdateVirtualInterface object |
Objetos de interface virtual a serem atualizados |
Parâmetro |
Obrigatório |
Tipo |
Descrição |
---|---|---|---|
name |
Não |
String |
Especifica o nome da interface virtual. Mínimo: 0 Máximo: 64 |
description |
Não |
String |
Fornece informações complementares sobre a interface virtual. Mínimo: 0 Máximo: 128 |
bandwidth |
Não |
Integer |
Especifica a configuração de largura de banda da interface virtual. Mínimo: 2 Máximo: 2147483647 |
remote_ep_group |
Não |
Array of strings |
Especifica a lista de sub-redes remotas, que registra os blocos CIDR usados no data center local. |
service_ep_group |
Não |
Array of strings |
Especifica o grupo de pontos de extremidade local que está ligado à rede pública através de uma ligação. |
enable_bfd |
Não |
Boolean |
Especifica se deve ativar a Detecção de Encaminhamento Bidirecional (BFD). O valor pode ser true ou false. |
enable_nqa |
Não |
Boolean |
Especifica se o NQA deve ser ativado. O valor pode ser true ou false. |
status |
Não |
String |
Confirma as interfaces virtuais criadas por outros usuários. O valor pode ser ACCEPTED ou REJECTED. Valores de enumeração:
|
Parâmetros de resposta
Código de status: 200
Parâmetro |
Tipo |
Descrição |
---|---|---|
request_id |
String |
Especifica o ID da solicitação. |
virtual_interface |
VirtualInterface object |
Especifica parâmetros para criar uma interface virtual. |
Parâmetro |
Tipo |
Descrição |
---|---|---|
id |
String |
Especifica o ID da interface virtual. Máximo: 36 |
name |
String |
Especifica o nome da interface virtual. Máximo: 64 |
admin_state_up |
Boolean |
Especifica o status administrativo, que pode ser true ou false. |
bandwidth |
Integer |
Especifica a largura de banda da interface virtual. Mínimo: 2 Máximo: 2147483647 |
create_time |
String |
Especifica quando a interface virtual foi criada. Máximo: 255 |
update_time |
String |
Especifica quando a interface virtual foi atualizada. |
description |
String |
Fornece informações complementares sobre a interface virtual. Máximo: 128 |
direct_connect_id |
String |
Especifica o ID de conexão. Máximo: 36 |
service_type |
String |
Especifica o tipo de gateway, que pode ser VGW, GDGW ou LGW. Valores de enumeração:
|
status |
String |
Especifica o status operacional, que pode ser ACTIVE, DOWN, BUILD, ERROR, PENDING_CREATE, PENDING_UPDATE, PENDING_DELETE, DELETED, AUTHORIZATION ou REJECTED. |
tenant_id |
String |
Especifica o ID do projeto. Mínimo: 32 Máximo: 32 |
type |
String |
Especifica o tipo da interface virtual. O valor é private. Padrão: private Máximo: 255 Valores de enumeração:
|
vgw_id |
String |
Especifica o ID do gateway virtual. Mínimo: 36 Máximo: 36 |
vlan |
Integer |
Especifica a VLAN para conexão com o gateway do usuário. O valor varia de 0 a 3999. Mínimo: 0 Máximo: 3999 |
route_limit |
Integer |
Especifica as configurações de rota de sub-rede remota da interface virtual. Mínimo: 1 Máximo: 200 Padrão: 50 |
enable_nqa |
Boolean |
Especifica se o NQA deve ser ativado. O valor pode ser true ou false. |
enable_bfd |
Boolean |
Especifica se o BFD deve ser ativado. O valor pode ser true ou false. |
lag_id |
String |
Especifica a ID do LAG associado à interface virtual. Mínimo: 36 Máximo: 36 |
device_id |
String |
Especifica o ID do dispositivo ao qual a interface virtual pertence. |
enterprise_project_id |
String |
Especifica o ID do projeto corporativo ao qual a interface virtual pertence. Mínimo: 36 Máximo: 36 |
tags |
Array of Tag objects |
Especifica as tags. |
vif_peers |
Array of VifPeer objects |
Especifica as informações de par da interface virtual. |
extend_attribute |
VifExtendAttribute object |
Especifica informações de detecção de confiabilidade, como BFD ou NQA, sobre a interface virtual. |
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 |
Parâmetro |
Tipo |
Descrição |
---|---|---|
id |
String |
Especifica o ID do recurso. Mínimo: 36 Máximo: 36 |
tenant_id |
String |
Especifica o ID do projeto ao qual o par de interface virtual pertence. Mínimo: 36 Máximo: 36 |
name |
String |
Especifica o nome de par de interface virtual. Mínimo: 0 Máximo: 64 |
description |
String |
Fornece informações suplementares sobre um par de interface virtual. Mínimo: 0 Máximo: 128 |
address_family |
String |
Especifica o tipo de família de endereços da interface virtual, que pode ser IPv4 ou IPv6. |
local_gateway_ip |
String |
Especifica o endereço do par de interface virtual usado na nuvem. |
remote_gateway_ip |
String |
Especifica o endereço do par de interface virtual usado no data center local. |
route_mode |
String |
Especifica o modo de roteamento, que pode ser static ou bgp. Máximo: 255 Valores de enumeração:
|
bgp_asn |
Integer |
Especifica o ASN do par BGP. Mínimo: 1 Máximo: 4294967295 |
bgp_md5 |
String |
Especifica a senha de MD5 do par BGP. |
remote_ep_group |
Array of strings |
Especifica a lista de sub-redes remotas, que registra os blocos CIDR usados no data center local. |
service_ep_group |
Array of strings |
Especifica a lista de endereços de rede pública que podem ser acedidos pelo data center no local. Este campo é obrigatório nas APIs de conexões de rede públicas. |
device_id |
String |
Especifica o ID do dispositivo ao qual o correspondente da interface virtual pertence. |
bgp_route_limit |
Integer |
Especifica a configuração da rota BGP. |
bgp_status |
String |
Especifica o status do protocolo BGP do correspondente da interface virtual. Se o par da interface virtual usar roteamento estático, o status será null. Máximo: 10 |
status |
String |
Especifica o status do par da interface virtual. |
vif_id |
String |
Especifica o ID da interface virtual correspondente ao par da interface virtual. Mínimo: 36 Máximo: 36 |
Parâmetro |
Tipo |
Descrição |
---|---|---|
ha_type |
String |
Especifica o tipo de detecção de disponibilidade da interface virtual. Valores de enumeração:
|
ha_mode |
String |
Especifica o modo de detecção de disponibilidade. Valores de enumeração:
|
detect_multiplier |
Integer |
Especifica o número de tentativas de detecção. Padrão: 5 |
min_rx_interval |
Integer |
Especifica o intervalo para receber pacotes de detecção. Padrão: 1000 |
min_tx_interval |
Integer |
Especifica o intervalo para o envio de pacotes de detecção. Padrão: 1000 |
remote_disclaim |
Integer |
Especifica o identificador remoto da sessão BFD estática. |
local_disclaim |
Integer |
Especifica o identificador local da sessão BFD estática. |
Exemplos de solicitações
Atualização de uma interface virtual
PUT https://{dc_endpoint}/v3/0605768a3300d5762f82c01180692873/dcaas/virtual-interfaces/0d0fdf63-f2c4-491c-8866-d504796189be { "virtual_interface" : { "name" : "vif-0819", "description" : "mytest", "bandwidth" : 2 } }
Exemplo de respostas
Código de status: 200
OK
{ "virtual_interface" : { "id" : "0d0fdf63-f2c4-491c-8866-d504796189be", "name" : "vif-0819", "description" : "mytest", "tenant_id" : "0605768a3300d5762f82c01180692873", "direct_connect_id" : "4673e339-8412-4ee1-b73e-2ba9cdfa54c1", "vgw_id" : "8a47064a-f34c-4f94-b7fe-cac456c9b37b", "type" : "private", "service_type" : "VGW", "vlan" : 332, "bandwidth" : 2, "status" : "ACTIVE", "create_time" : "2022-08-19T11:28:06.000Z", "admin_state_up" : true, "rate_limit" : false, "enable_bfd" : false, "route_limit" : 50, "enable_nqa" : false, "vif_peers" : [ { "id" : "c768eb52-12a8-4859-9b43-81194643040c", "tenant_id" : "0605768a3300d5762f82c01180692873", "name" : "vif-0819", "description" : "", "address_family" : "ipv4", "local_gateway_ip" : "1.1.1.1/30", "remote_gateway_ip" : "1.1.1.2/30", "route_mode" : "static", "bgp_asn" : null, "bgp_md5" : null, "device_id" : "18.9.215.131", "bgp_route_limit" : 100, "bgp_status" : null, "status" : "ACTIVE", "vif_id" : "0d0fdf63-f2c4-491c-8866-d504796189be", "remote_ep_group" : [ "1.1.2.0/30" ], "service_ep_group" : null } ], "enterprise_project_id" : "0" }, "request_id" : "5633df7af874576d819a481c76673236" }
Códigos de status
Código de status |
Descrição |
---|---|
200 |
OK |
Códigos de erro
Consulte Códigos de erro.