Consulta de detalles del canal de VPC
Función
Esta API se utiliza para consultar los detalles 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} |
En la siguiente tabla se muestra el parámetro en el URI.
Parámetro |
Obligatorio |
Tipo |
Descripción |
---|---|---|---|
id |
Sí |
String |
ID de canal de VPC |
Solicitud
N/A
Respuesta
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 |
vpc_health_config |
Dictionary |
Detalles de la comprobación de estado |
vpc_instances |
Dictionary |
Lista de instancias de backend |
Parámetro |
Tipo |
Descripción |
---|---|---|
id |
String |
ID de control de buen funcionamiento |
vpc_id |
String |
ID de canal de VPC |
protocol |
String |
Protocolo para realizar comprobaciones de estado en servidores en la nube en el canal VPC. El valor puede ser:
|
path |
String |
Ruta de destino para las comprobaciones de estado
NOTA:
El valor de este parámetro debe cumplir con las especificaciones de URI. |
port |
Integer |
Puerto de destino para las comprobaciones de estado. De forma predeterminada, se utiliza el puerto de host del canal VPC. Alcance: 1 a 65535 |
threshold_normal |
Integer |
Umbral de control de buen funcionamiento Se refiere al número (x) de comprobaciones consecutivas correctas necesarias para que un servidor en la nube se marque como saludable. Alcance: 2 a 10 |
threshold_abnormal |
Integer |
Umbral de control de mal funcionamiento Se refiere al número (x) de comprobaciones consecutivas fallidas necesarias para que un servidor en la nube se marque como no saludable. Alcance: 2 a 10 |
time_out |
Integer |
Tiempo de espera para determinar si una comprobación de estado falla. Unidad: s. El valor debe ser menor que el valor de time_interval. Alcance: 2 a 30 |
time_interval |
Integer |
Intervalo entre comprobaciones consecutivas. Unidad: s. El valor debe ser mayor que el valor de time_out. Alcance: 5 a 300 |
http_code |
String |
Códigos de respuesta de HTTP para determinar una respuesta de HTTP correcta El valor puede ser cualquier entero dentro de 100 a 599 en uno de los siguientes formatos:
|
create_time |
Timestamp |
Hora en que se crea el canal de VPC |
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 de instancia de backend |
instance_id |
String |
ID de instancia de backend |
host |
String |
Dirección IP de la instancia de backend |
weight |
Integer |
Ponderación del servidor en la nube Cuanto mayor sea el peso, más solicitudes se reenvían a la instancia de backend. Alcance: 1 a 100 |
create_time |
Timestamp |
Hora en la que se agrega la instancia de backend al canal de VPC |
Ejemplo de respuesta:
{ "name": "vpc_001", "type": 2, "member_type": "instance", "port": 15565, "balance_strategy": 1, "id": "c3e6a7d85d9e47be89dfcc3cd37405d7", "create_time": "2018-07-27T12:30:48Z", "status": 1, "vpc_health_config": { "protocol": "http", "path": "/hc", "port": 15563, "threshold_normal": 5, "threshold_abnormal": 5, "time_out": 30, "time_interval": 200, "http_code": "205", "id": "f26c1b158f2e40f2b531cf5c1b5e05e5", "vpc_id": "c3e6a7d85d9e47be89dfcc3cd37405d7", "create_time": "2018-07-27T12:30:48Z" }, "vpc_instances": [ { "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 |