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> Gateway virtual> Consulta de los gateway virtuales

Actualización más reciente 2023-02-13 GMT+08:00

Ver PDF

Consulta de los gateway virtuales

Función

Esta API se utiliza para consultar los gateway virtuales.

URI

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

**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
id	No	Array	Especifica el ID de recurso por el que se filtran las instancias.
vpc_id	No	Array	Especifica el ID de VPC por el que se filtran 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_gateways	Array of VirtualGateway objects	Especifica los parámetros para crear un gateway virtual.
page_info	PageInfo object	Especifica la información de consulta de paginación.

**Tabla 5** VirtualGateway
Parámetro	Tipo	Descripción
id	String	Especifica el ID del gateway virtual.
vpc_id	String	Especifica el ID de la VPC conectada por el gateway virtual.
tenant_id	String	Especifica el ID del proyecto al que pertenece la instancia. Mínimo: 32 Máximo: 32
name	String	Especifica el nombre del gateway virtual. Mínimo: 0 Máximo: 64
description	String	Proporciona la información complementaria sobre el gateway virtual. Mínimo: 0 Máximo: 128
type	String	Especifica el tipo del gateway virtual. El valor solo puede ser default. Predeterminado: default Valores de enumeración: default
local_ep_group	Array of strings	Especifica las subredes IPv4 conectadas por el gateway virtual, que suele ser los bloques CIDR de una VPC.
local_ep_group_ipv6	Array of strings	Especifica las subredes IPv6 conectadas por el gateway virtual, que suele ser los bloques CIDR de una VPC. Este es un campo reservado.
admin_state_up	Boolean	Especifica el estado administrativo, que puede ser true o false. Predeterminado: true
status	String	Especifica el estado del gateway virtual, que puede ser ACTIVE, DOWN, BUILD, ERROR, PENDING_CREATE, PENDING_UPDATE o PENDING_DELETE.
bgp_asn	Integer	Especifica el ASN de BGP local del gateway virtual. Mínimo: 1 Máximo: 4294967295
enterprise_project_id	String	Especifica el ID del proyecto de empresa al que pertenece el gateway virtual. Mínimo: 36 Máximo: 36
tags	Array of Tag objects	Especifica las etiquetas.

**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** 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 del gateway virtual

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

Ejemplo de las respuestas

Código de estado: 200

{
  "virtual_gateways" : [ {
    "id" : "20082c1b-3c99-48d8-8e8c-116af5d7e9f0",
    "name" : "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.1.0/24" ],
    "enterprise_project_id" : "0"
  } ],
  "request_id" : "765f7aaf8f2edd0e719de564ef72e2de"
}