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> Virtual Private Network> Referencia de la API> API de Professional Edition VPN> Gateway del cliente> Consulta de la lista de gateway del cliente

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

Ver PDF

Consulta de la lista de gateway del cliente

Función

Esta API se utiliza para consultar la lista de gateway de clientes.

URI

GET /v5/{project_id}/customer-gateways

**Tabla 1** Descripción del parámetro
Parámetro	Tipo	Obligatorio	Descripción
project_id	String	Sí	Especifica un ID de proyecto. Puede obtener el ID del proyecto haciendo referencia a Obtención del ID del proyecto.

**Tabla 2** Parámetro en una solicitud de consulta
Parámetro	Tipo	Obligatorio	Descripción
limit	Integer	No	Especifica el número de registros devueltos en cada página durante la consulta de paginación. El valor varía de 0 a 200. El valor predeterminado es 200.
marker	String	No	Especifica el indicador de inicio para consultar la página actual. Si este parámetro se deja en blanco, se consulta la primera página. El marker para consultar la página siguiente es el next_marker del objeto page_info devuelto en la página actual. Este parámetro debe usarse junto con limit.

Solicitud

Parámetros de solicitud
No hay

Ejemplo de la solicitud

GET https://{Endpoint}/v5/{project_id}/customer-gateways?limit={limit}&marker={marker}

Respuesta

Parámetros de respuesta

Código de estado devuelto 200: consulta exitosa

**Tabla 3** Parámetros en el cuerpo de respuesta
Parámetro	Tipo	Descripción
customer_gateways	Array of ResponseCustomerGateway	Especifica el objeto de gateway del cliente.
total_count	Long	Especifica el número total de gateway de cliente de un tenant.
page_info	PageInfo	Especifica la información de paginación.
request_id	String	Especifica un ID de solicitud.

**Tabla 4** ResponseCustomerGateway
Parámetro	Tipo	Descripción
id	String	Especifica un ID de gateway de cliente. El valor es un UUID que contiene 36 caracteres.
name	String	Especifica un nombre de gateway de cliente. Si no se especifica ningún nombre de gateway de cliente, el sistema genera automáticamente uno. El valor es una cadena de 1 a 64 caracteres, que puede contener dígitos, letras, guiones bajos (_), y guiones (-).
route_mode	String	Especifica el modo de enrutamiento del gateway del cliente. El valor puede ser static o bgp.
bgp_asn	Long	Especifica el número de AS de BGP del gateway del cliente. Este parámetro solo está disponible cuando route_mode está establecido en bgp.
ip	String	Especifica la dirección IP del gateway del cliente. El valor es una dirección IPv4, por ejemplo, 10.*.*.21.
created_at	String	Especifica la hora a la que se crea el gateway del cliente.
updated_at	String	Especifica la hora de la última actualización.

**Tabla 5** PageInfo
Parámetro	Tipo	Descripción
next_marker	String	Especifica el marcador de la página siguiente. El valor es la hora en que se creó el último recurso de la última respuesta a la consulta.
current_count	Integer	Especifica el número de recursos de la lista. Si el valor de current_count es menor que el valor de limit en la solicitud de consulta, la página actual será la última página.

Ejemplo de la respuesta

{
    "customer_gateways": [{
        "id": "e67d6e27-****-****-****-be9a0f0168e9",
        "name": "cgw-a45b",
        "route_mode": "bgp",
        "bgp_asn": 65588,
        "ip": "100.***.***.81",
        "created_at": "2022-11-28T07:36:24.923Z",
        "updated_at": "2022-11-28T07:36:24.923Z"
    }, {
        "id": "312067bb-****-****-****-09dc941bbffc",
        "name": "cgw-21a3",
        "route_mode": "static",
        "ip": "100.***.***.55",
        "created_at": "2022-11-28T06:25:01.937Z",
        "updated_at": "2022-11-28T06:25:01.937Z"
    }],
    "total_count": 2,
    "page_info": {
        "next_marker": "2022-11-28T06:25:01.937Z",
        "current_count": 2
    },
    "request_id": "82a108d9-0929-42e9-adb7-e146c04c587c"
}