Estos contenidos se han traducido de forma automática para su comodidad, pero Huawei Cloud no garantiza la exactitud de estos. Para consultar los contenidos originales, acceda a la versión en inglés.
Centro de ayuda> Direct Connect> Referencia de la API> API> Interfaz virtual> Consulta de la lista de interfaz virtual
Actualización más reciente 2023-02-13 GMT+08:00
Ver PDF

Consulta de la lista de interfaz virtual

Función

Esta API se utiliza para consultar todas las interfaces virtuales de un tenant.

URI

GET /v3/{project_id}/dcaas/virtual-interfaces

Tabla 1 Parámetros de ruta

Parámetro

Obligatorio

Tipo

Descripción

project_id

Sí

String

Especifica el ID del proyecto.
Tabla 2 Parámetros de consulta

Parámetro

Obligatorio

Tipo

Descripción

limit

No

Integer

Especifica el número de registros devueltos en cada página. Rango de valores: 1 a 2000

Mínimo: 1

Máximo: 2000

Predeterminado: 2000

marker

No

String

Especifica el ID del último registro de recursos de la página anterior. Si este parámetro se deja en blanco, se consulta la primera página. Este parámetro debe usarse junto con limit.

Mínimo: 0

Máximo: 36

fields

No

Array

Especifica la lista de campos que se mostrarán.

sort_dir

No

Array

Especifica el orden de clasificación de los resultados devueltos, que puede ser asc (orden ascendente) o desc (orden descendente). El valor predeterminado es asc.

sort_key

No

String

Especifica el campo de la ordenación.

Predeterminado: created_at

Mínimo: 0

Máximo: 36

enterprise_project_id

No

Array

Especifica el ID del proyecto de empresa por el que se filtran las redes centrales.

id

No

Array

Especifica el ID de recurso por el que se filtran las instancias.

status

No

Array

Especifica el estado por el que se filtran las instancias.

direct_connect_id

No

Array

Especifica el ID de conexión por el que se filtran y consultan las conexiones.

vgw_id

No

Array

Especifica el ID de gateway virtual por el que se filtran y consultan los gateway virtuales.

Parámetros de solicitud

Tabla 3 Parámetros de cabecera 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

Tabla 4 Parámetros del cuerpo de respuesta

Parámetro

Tipo

Descripción

request_id

String

Especifica el ID de la solicitud.

virtual_interfaces

Array of VirtualInterface objects

Especifica los parámetros para crear una interfaz virtual.

page_info

PageInfo object

Especifica la información de consulta de paginación.
Tabla 5 VirtualInterface

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:

  • vpc
  • VGW
  • GDWW
  • LGW

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:

  • private
  • public

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.
Tabla 6 Etiqueta

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
Tabla 7 VifPeer

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
  • static

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
Tabla 8 VifExtendAttribute

Parámetro

Tipo

Descripción

ha_type

String

Especifica el tipo de detección de disponibilidad de la interfaz virtual.

Valores de enumeración:

  • nqa
  • bfd

ha_mode

String

Especifica el modo de detección de disponibilidad.

Valores de enumeración:

  • auto_single
  • auto_multi
  • static_single
  • static_multi
  • enhance_nqa

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.
Tabla 9 PageInfo

Parámetro

Tipo

Descripción

previous_marker

String

Especifica el marcador de la página anterior. El valor es el UUID del recurso.

Mínimo: 0

Máximo: 36

current_count

Integer

Especifica el número de recursos de la lista actual.

Mínimo: 0

Máximo: 2000

next_marker

String

Especifica el marcador de la página siguiente. El valor es el UUID del recurso. Si el valor está vacío, el recurso se encuentra en la última página.

Mínimo: 0

Máximo: 36

Ejemplo de las solicitudes

Consulta de la lista de interfaz virtual

GET https://{dc_endpoint}/v3/0605768a3300d5762f82c01180692873/dcaas/virtual-interfaces

Ejemplo de las respuestas

Código de estado: 200

OK

{
  "virtual_interfaces" : [ {
    "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,
    "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.

Tema principal: Interfaz virtual