Consulta de la lista de canales de VPC
Función
Esta API se utiliza para consultar la lista de canales de VPC que se han creado.
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[?page_size, page_no, id, name, vpc_type] |
o
- 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 id, name, vpc_type, page_size y page_no.
Parámetro |
Obligatorio |
Tipo |
Descripción |
---|---|---|---|
id |
No |
String |
ID de canal de VPC |
name |
No |
String |
Nombre del canal de VPC |
vpc_type |
No |
Integer |
Tipo de canal VPC, que puede ser: |
page_size |
No |
Integer |
Número de canales de VPC mostrados en cada página. El valor predeterminado es 20. |
page_no |
No |
Integer |
Número de página. El valor predeterminado es 1. |
precise_search |
No |
String |
Nombre del parámetro name para la coincidencia exacta |
Solicitud
N/A
Respuesta
Parámetro |
Tipo |
Descripción |
---|---|---|
total |
Integer |
Número total de canales de VPC que coinciden con las condiciones de consulta |
size |
Integer |
Longitud de la lista de canales de VPC devuelta |
vpcs |
Dictionary |
Lista de canales de VPC |
Parámetro |
Tipo |
Descripción |
---|---|---|
id |
String |
ID de canal de VPC |
name |
String |
Nombre del canal de VPC |
type |
Integer |
Tipo de canal VPC, que puede ser:
|
member_type |
String |
Tipo de miembro del canal VPC, que puede ser:
|
status |
Integer |
Estado del canal de VPC, que puede ser:
|
port |
Integer |
Puerto de host del canal de VPC |
balance_strategy |
Integer |
Algoritmo de distribución, que puede ser:
|
create_time |
Timestamp |
Hora en que se crea el canal de VPC |
Ejemplo de respuesta:
{ "total": 2, "size": 2, "vpcs": [ { "name": "Channel_1", "type": 1, "member_type": "instance", "port": 8080, "balance_strategy": 1, "id": "39c62689302a48fe9f4bd7cf5c052064", "create_time": "2018-04-24T12:07:58Z", "status": 1 }, { "name": "Channel_2", "type": 2, "member_type": "instance", "port": 8088, "balance_strategy": 1, "id": "e6831cbcbe2b45bbbc6318c2892f060b", "create_time": "2018-04-24T11:57:03Z", "status": 1 } ] }
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 |