Consulta de la lista de instancias de backend (lista de servidores en la nube)
Función
Esta API se utiliza para consultar los servidores en la nube de un canal de VPC especificado.
URI
La siguiente tabla muestra el método de solicitud HTTP/HTTPS y el URI de la API.
Método de solicitud |
URI |
---|---|
GET |
/v1.0/apigw/vpc-channels/{id}/members[?page_size, page_no, name] |
- Se puede agregar una combinación de diferentes condiciones de consulta al final del URI utilizando signos de interrogación (?) y ampersands (&).
- Las condiciones de consulta incluyen: name, page_size y page_no.
En la siguiente tabla se enumeran los parámetros del URI.
Parámetro |
Obligatorio |
Tipo |
Descripción |
---|---|---|---|
id |
Sí |
String |
ID de canal de VPC |
name |
No |
String |
Nombre del servidor en la nube |
page_size |
No |
Integer |
Número de servidores en la nube que se muestran en cada página. El valor predeterminado es 20. |
page_no |
No |
Integer |
Número de página. El valor predeterminado es 1. |
Solicitud
N/A
Respuesta
Parámetro |
Tipo |
Descripción |
---|---|---|
total |
Integer |
Número total de servidores en la nube que coinciden con las condiciones de consulta |
size |
Integer |
Longitud de la lista de servidores en la nube devuelta |
vpc_instances |
Dictionary |
Lista de servidores en la nube |
Parámetro |
Tipo |
Descripción |
---|---|---|
id |
String |
ID de objeto de instancia de backend |
vpc_id |
String |
ID de canal de VPC |
status |
Integer |
Estado del objeto de instancia de backend |
instance_name |
String |
Nombre del servidor en la nube |
instance_id |
String |
ID del servidor en la nube |
host |
String |
Dirección IP del servidor en la nube |
weight |
Integer |
Ponderación del servidor en la nube Cuanto mayor sea el peso, más solicitudes se reenvían al servidor en la nube. Alcance: 1 a 100 |
create_time |
Timestamp |
Hora en la que se agrega el servidor en la nube al canal de VPC |
Ejemplo de respuesta:
{ "total": 2, "size": 2, "vpc_instances": [ { "instance_id": "instance02", "instance_name": "instance_name02", "host": "127.0.0.2", "weight": 10, "id": "680e42fab429447ca23b9623107523d9", "vpc_id": "c3e6a7d85d9e47be89dfcc3cd37405d7", "status": 1, "create_time": "2018-07-27T12:42:32Z" }, { "instance_id": "instance01", "instance_name": "instance_name01", "host": "127.0.0.1", "weight": 10, "id": "c3bc73605a8b400793363c87574fbad7", "vpc_id": "c3e6a7d85d9e47be89dfcc3cd37405d7", "status": 1, "create_time": "2018-07-27T12:30:48Z" } ] }
Códigos de estado
Código de estado |
Descripción |
---|---|
200 |
OK |
400 |
Bad Request |
401 |
Unauthorized |
403 |
Forbidden |
404 |
Not Found |
500 |
Server Internal Error |