Consulta de un gateway de cliente especificado
Función
Esta API se utiliza para consultar un gateway de cliente con un ID de gateway especificado.
URI
GET /v5/{project_id}/customer-gateways/{customer_gateway_id}
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. |
customer_gateway_id |
String |
Sí |
Especifica un ID de gateway de cliente. |
- Ejemplo de la solicitud
GET https://{Endpoint}/v5/{project_id}/customer-gateways/{customer_gateway_id}
Respuesta
- Parámetros de respuesta
Código de estado devuelto 200: consulta exitosa
Tabla 2 Parámetros en el cuerpo de respuesta Parámetro
Tipo
Descripción
customer_gateway
Especifica el objeto de gateway del cliente.
request_id
String
Especifica un ID de solicitud.
Tabla 3 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.
- Ejemplo de la respuesta
{ "customer_gateway": { "id": "03c0aa3d-****-****-****-9d82473765d4", "name": "cgw-ba08", "route_mode": "bgp", "bgp_asn": 65000, "ip": "10.***.***.21", "created_at": "2021-12-21T16:49:28.108+08:00", "updated_at": "2021-12-21T16:49:28.108+08:00" }, "request_id": "8111d315-5024-45c9-8ee3-5ef676edb0d1" }
Códigos de estado
Para obtener más información, véase Códigos de estado.