Consulta de detalles acerca de una interfaz virtual
Función
Esta API se utiliza para consultar detalles sobre una interfaz virtual.
URI
GET /v3/{project_id}/dcaas/virtual-interfaces/{virtual_interface_id}
Parámetro |
Obligatorio |
Tipo |
Descripción |
---|---|---|---|
project_id |
Sí |
String |
Especifica el ID del proyecto. |
virtual_interface_id |
Sí |
String |
Especifica el ID de la interfaz virtual. Mínimo: 36 Máximo: 36 |
Parámetro |
Obligatorio |
Tipo |
Descripción |
---|---|---|---|
fields |
No |
Array |
Especifica la lista de campos que se mostrarán. |
Parámetros de solicitud
Parámetro |
Obligatorio |
Tipo |
Descripción |
---|---|---|---|
X-Auth-Token |
Sí |
String |
Especifica el token de usuario. Para obtener el token, consulte la sección "Obtención del token de usuario" en la Referencia de las API de Identity and Access Management. El token es el valor de X-Subject-Token en la cabecera de respuesta. Mínimo: 0 Máximo: 10240 |
Parámetros de respuesta
Código de estado: 200
Parámetro |
Tipo |
Descripción |
---|---|---|
request_id |
String |
Especifica el ID de la solicitud. |
virtual_interface |
VirtualInterface object |
Especifica los parámetros para crear una interfaz virtual. |
Parámetro |
Tipo |
Descripción |
---|---|---|
id |
String |
Especifica el ID de la interfaz virtual. Máximo: 36 |
name |
String |
Especifica el nombre de la interfaz virtual. Máximo: 64 |
admin_state_up |
Boolean |
Especifica el estado administrativo, que puede ser true o false. |
bandwidth |
Integer |
Especifica el ancho de banda de la interfaz virtual. Mínimo: 2 Máximo: 2147483647 |
create_time |
String |
Especifica cuándo se creó la interfaz virtual. Máximo: 255 |
update_time |
String |
Especifica cuándo se actualizó la interfaz virtual. |
description |
String |
Proporciona la información complementaria sobre la interfaz virtual. Máximo: 128 |
direct_connect_id |
String |
Especifica el ID de conexión. Máximo: 36 |
service_type |
String |
Especifica el tipo de gateway, que puede ser VGW, GDGW o LGW. Valores de enumeración:
|
status |
String |
Especifica el estado de funcionamiento, que puede ser ACTIVE, DOWN, BUILD, ERROR, PENDING_CREATE, PENDING_UPDATE, PENDING_DELETE, DELETED, AUTHORIZATION o REJECTED. |
tenant_id |
String |
Especifica el ID del proyecto. Mínimo: 32 Máximo: 32 |
type |
String |
Especifica el tipo de la interfaz virtual. El valor es private. Predeterminado: private Máximo: 255 Valores de enumeración:
|
vgw_id |
String |
Especifica el ID del gateway virtual. Mínimo: 36 Máximo: 36 |
vlan |
Integer |
Especifica la VLAN para la conexión al gateway de usuario. El valor oscila entre 0 y 3999. Mínimo: 0 Máximo: 3999 |
route_limit |
Integer |
Especifica las configuraciones de ruta de subred remota de la interfaz virtual. Mínimo: 1 Máximo: 200 Predeterminado: 50 |
enable_nqa |
Boolean |
Especifica si se va a habilitar NQA. El valor puede ser true o false. |
enable_bfd |
Boolean |
Especifica si se activa BFD. El valor puede ser true o false. |
lag_id |
String |
Especifica el ID del LAG asociado a la interfaz virtual. Mínimo: 36 Máximo: 36 |
device_id |
String |
Especifica el ID del dispositivo al que pertenece la interfaz virtual. |
enterprise_project_id |
String |
Especifica el ID del proyecto de empresa al que pertenece la interfaz virtual. Mínimo: 36 Máximo: 36 |
tags |
Array of Tag objects |
Especifica las etiquetas. |
vif_peers |
Array of VifPeer objects |
Especifica la información del mismo nivel de la interfaz virtual. |
extend_attribute |
VifExtendAttribute object |
Especifica la información de detección de fiabilidad, como BFD o NQA, sobre la interfaz virtual. |
Parámetro |
Tipo |
Descripción |
---|---|---|
key |
String |
Especifica la clave de etiqueta. La clave puede contener un máximo de 36 caracteres de Unicode, incluidos letras, dígitos, guiones (-) y guiones bajos (_). Mínimo: 0 Máximo: 36 |
value |
String |
Especifica el valor de etiqueta. El valor puede contener un máximo de 43 caracteres de Unicode, incluidos letras, dígitos, guiones (-), guiones bajos (_), y puntos (.). Mínimo: 0 Máximo: 43 |
Parámetro |
Tipo |
Descripción |
---|---|---|
id |
String |
Especifica el ID del recurso. Mínimo: 36 Máximo: 36 |
tenant_id |
String |
Especifica el ID del proyecto al que pertenece el par de interfaz virtual. Mínimo: 36 Máximo: 36 |
name |
String |
Especifica el nombre del par de interfaz virtual. Mínimo: 0 Máximo: 64 |
description |
String |
Proporciona la información adicional acerca de un par de interfaz virtual. Mínimo: 0 Máximo: 128 |
address_family |
String |
Especifica el tipo de familia de direcciones de la interfaz virtual, que puede ser IPv4 o IPv6. |
local_gateway_ip |
String |
Especifica la dirección del par de interfaz virtual utilizado en la nube. |
remote_gateway_ip |
String |
Especifica la dirección del par de interfaz virtual utilizado en el centro de datos local. |
route_mode |
String |
Especifica el modo de enrutamiento, que puede ser static o bgp. Máximo: 255 Valores de enumeración:
|
bgp_asn |
Integer |
Especifica el ASN del par de BGP. Mínimo: 1 Máximo: 4294967295 |
bgp_md5 |
String |
Especifica la contraseña de MD5 del par BGP. |
remote_ep_group |
Array of strings |
Especifica la lista de subred remota, que registra los bloques CIDR utilizados en el centro de datos local. |
service_ep_group |
Array of strings |
Especifica la lista de direcciones de red pública a las que puede acceder el centro de datos local. Este campo es obligatorio en las API de conexiones de red pública. |
device_id |
String |
Especifica el ID del dispositivo al que pertenece el par de interfaz virtual. |
bgp_route_limit |
Integer |
Especifica la configuración de ruta BGP. |
bgp_status |
String |
Especifica el estado del protocolo BGP del par de interfaz virtual. Si el par de la interfaz virtual utiliza enrutamiento estático, el estado es null. Máximo: 10 |
status |
String |
Especifica el estado del par de la interfaz virtual. |
vif_id |
String |
Especifica el ID de la interfaz virtual correspondiente al par de la interfaz virtual. Mínimo: 36 Máximo: 36 |
Parámetro |
Tipo |
Descripción |
---|---|---|
ha_type |
String |
Especifica el tipo de detección de disponibilidad de la interfaz virtual. Valores de enumeración:
|
ha_mode |
String |
Especifica el modo de detección de disponibilidad. Valores de enumeración:
|
detect_multiplier |
Integer |
Especifica el número de reintentos de detección. Predeterminado: 5 |
min_rx_interval |
Integer |
Especifica el intervalo para recibir paquetes de detección. Predeterminado: 1000 |
min_tx_interval |
Integer |
Especifica el intervalo para enviar paquetes de detección. Predeterminado: 1000 |
remote_disclaim |
Integer |
Especifica el identificador remoto de la sesión BFD estática. |
local_disclaim |
Integer |
Especifica el identificador local de la sesión BFD estática. |
Ejemplo de las solicitudes
Consulta de una interfaz virtual
POST https://{dc_endpoint}/v3/0605768a3300d5762f82c01180692873/dcaas/virtual-interfaces/0d0fdf63-f2c4-491c-8866-d504796189be
Ejemplo de las respuestas
Código de estado: 200
OK
{ "virtual_interface" : { "id" : "0d0fdf63-f2c4-491c-8866-d504796189be", "name" : "vif-0819", "description" : "", "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, "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 estado
Código de estado |
Descripción |
---|---|
200 |
Aceptar |
Códigos de error
Consulte Códigos de error.