Consulta de canales de VPC
Función
Esta API se utiliza para consultar los canales de VPC en un gateway.
URI
GET /v2/{project_id}/apigw/instances/{instance_id}/vpc-channels
Parámetro |
Obligatorio |
Tipo |
Descripción |
---|---|---|---|
project_id |
Sí |
String |
ID del proyecto. Para obtener detalles sobre cómo obtener un ID de proyecto, consulte "Apéndice" > "Obtención de un ID de proyecto" en este documento. |
instance_id |
Sí |
String |
Gateway ID, que se puede obtener de la información de gateway en la consola APIG. |
Parámetro |
Obligatorio |
Tipo |
Descripción |
---|---|---|---|
offset |
No |
Long |
Desfase desde el que se inicia la consulta. Si el valor es menor que 0, se convierte automáticamente a 0. Predeterminado: 0 |
limit |
No |
Integer |
Número de elementos mostrados en cada página. Un valor menor o igual a 0 se convertirá automáticamente a 20, y un valor mayor que 500 se convertirá automáticamente a 500. Mínimo: 1 Máximo: 500 Predeterminado: 20 |
id |
No |
String |
ID de canal de VPC. |
name |
No |
String |
Nombre del canal de VPC. |
dict_code |
No |
String |
Código de diccionario del canal VPC. El valor puede contener letras, dígitos, guiones (-), guiones bajos (_), y puntos (.). Este parámetro no se admite actualmente. Mínimo: 3 Máximo: 64 |
precise_search |
No |
String |
Nombre del parámetro para la coincidencia exacta. Separar varios nombres de parámetros con comas (,). Actualmente, se admiten nombre y member_group_name. |
member_host |
No |
String |
Dirección de servicio de backend. De forma predeterminada, se utiliza la coincidencia exacta. No se admite la coincidencia difusa. |
member_port |
No |
Integer |
Puerto de servidor de backend. Mínimo: 0 Máximo: 65535 |
member_group_name |
No |
String |
Nombre del grupo del servidor de backend. |
member_group_id |
No |
String |
ID de grupo de servidor de backend. |
Parámetros de solicitud
Parámetro |
Obligatorio |
Tipo |
Descripción |
---|---|---|---|
X-Auth-Token |
Sí |
String |
Token de usuario. Se puede obtener llamando a la API de IAM utilizada para obtener un token de usuario. El valor de X-Subject-Token en el encabezado de respuesta es un token. |
Parámetros de respuesta
Código de estado: 200
Parámetro |
Tipo |
Descripción |
---|---|---|
size |
Integer |
Longitud de la lista de recursos devuelta. |
total |
Long |
Número de recursos que coinciden con las condiciones de consulta. |
vpc_channels |
Array of VpcChannelInfo objects |
Lista de canales de VPC. |
Parámetro |
Tipo |
Descripción |
---|---|---|
name |
String |
Nombre del canal de VPC. Puede contener de 3 a 64 caracteres, empezando por una letra. Solo se permiten letras, dígitos, guiones (-) y guiones bajos (_). |
port |
Integer |
Puerto de host del canal VPC. Rango: 1–65535. |
balance_strategy |
Integer |
Algoritmo de distribución.
Predeterminado: 1 Valores de enumeración:
|
member_type |
String |
Tipo de miembro del canal VPC.
Predeterminado: ecs Valores de enumeración:
|
type |
Integer |
Tipo de canal de VPC. El tipo predeterminado es servidor.
Predeterminado: 2 Valores de enumeración:
|
dict_code |
String |
Código de diccionario del canal VPC. El valor puede contener letras, dígitos, guiones (-), guiones bajos (_), y puntos (.). Este parámetro no se admite actualmente. Mínimo: 3 Máximo: 64 |
create_time |
String |
Hora en la que se crea el canal VPC. |
id |
String |
ID de canal de VPC. |
status |
Integer |
Estado del canal de VPC.
Valores de enumeración:
|
member_groups |
Array of MemberGroupInfo objects |
Grupos de servidores backend. |
microservice_info |
MicroServiceInfo object |
Información de microservicio. |
Parámetro |
Tipo |
Descripción |
---|---|---|
member_group_name |
String |
Nombre del grupo de servidores backend del canal VPC. |
member_group_remark |
String |
Descripción del grupo de servidores backend. |
member_group_weight |
Integer |
Peso del grupo de servidores backend. Si el grupo de servidores contiene servidores y se ha establecido un peso para él, el peso se utiliza automáticamente para asignar pesos a los servidores de este grupo. Mínimo: 0 Máximo: 100 |
dict_code |
String |
Código de diccionario del grupo de servidores backend. El valor puede contener letras, dígitos, guiones (-), guiones bajos (_), y puntos (.). Actualmente, este parámetro no es compatible. Mínimo: 3 Máximo: 64 |
microservice_version |
String |
Versión del grupo de servidores backend. Este parámetro solo se admite cuando el tipo de canal de VPC es microservicio. Máximo: 64 |
microservice_port |
Integer |
Puerto del grupo de servidores de backend. Este parámetro solo se admite cuando el tipo de canal de VPC es microservicio. Si el número de puerto es 0, todas las direcciones en el grupo de servidores backend utilizan el puerto de equilibrio de carga original para heredar la lógica. Mínimo: 0 Máximo: 65535 |
microservice_labels |
Array of MicroserviceLabel objects |
Etiquetas del grupo de servidores de backend. Este parámetro solo se admite cuando el tipo de canal de VPC es microservicio. |
member_group_id |
String |
ID del grupo de servidores backend del canal VPC. |
create_time |
String |
Hora en la que se crea el grupo de servidores de backend. |
update_time |
String |
Hora en la que se actualiza el grupo de servidores de backend. |
Parámetro |
Tipo |
Descripción |
---|---|---|
label_name |
String |
Nombre de la etiqueta. Comience y termine con una letra o dígito. Utilice solo letras, dígitos, guiones (-), guiones bajos (_), y puntos (.). (Máx. 63 caracteres.) Mínimo: 1 Máximo 63 |
label_value |
String |
Valor de la etiqueta. Comience y termine con una letra o dígito. Utilice solo letras, dígitos, guiones (-), guiones bajos (_), y puntos (.). (Máx. 63 caracteres.) Mínimo: 1 Máximo 63 |
Parámetro |
Tipo |
Descripción |
---|---|---|
id |
String |
ID de microservicio. |
service_type |
String |
Tipo de microservicio.
Valores de enumeración:
|
cse_info |
MicroServiceInfoCSE object |
Detalles del microservicio CSE. |
cce_info |
MicroServiceInfoCCE object |
Detalles del microservicio CCE. |
update_time |
String |
Tiempo de actualización del microservicio. |
create_time |
String |
Tiempo de creación de microservicios. |
Parámetro |
Tipo |
Descripción |
---|---|---|
engine_id |
String |
ID del motor de microservicio. Máximo: 64 |
service_id |
String |
ID de microservicio. Máximo: 64 |
engine_name |
String |
Nombre del motor de microservicios. |
service_name |
String |
Nombre del microservicio. |
register_address |
String |
Dirección del centro de registro. |
cse_app_id |
String |
App a la que pertenece el microservicio. |
version |
String |
Versión de microservicio, que se ha descartado y se refleja en la versión del grupo de servidores de backend. Máximo: 64 |
Parámetro |
Tipo |
Descripción |
---|---|---|
cluster_id |
String |
ID del clúster de CCE. Máximo: 64 |
namespace |
String |
Espacio de nombres. Máximo: 64 |
workload_type |
String |
Tipo de carga de trabajo.
Valores de enumeración:
|
app_name |
String |
Nombre de la aplicación. Máximo: 64 |
cluster_name |
String |
Nombre del clúster de CCE. |
Código de estado: 400
Parámetro |
Tipo |
Descripción |
---|---|---|
error_code |
String |
Código de error. |
error_msg |
String |
Mensaje de error. |
Código de estado: 401
Parámetro |
Tipo |
Descripción |
---|---|---|
error_code |
String |
Código de error. |
error_msg |
String |
Mensaje de error. |
Código de estado: 403
Parámetro |
Tipo |
Descripción |
---|---|---|
error_code |
String |
Código de error. |
error_msg |
String |
Mensaje de error. |
Código de estado: 404
Parámetro |
Tipo |
Descripción |
---|---|---|
error_code |
String |
Código de error. |
error_msg |
String |
Mensaje de error. |
Código de estado: 500
Parámetro |
Tipo |
Descripción |
---|---|---|
error_code |
String |
Código de error. |
error_msg |
String |
Mensaje de error. |
Solicitudes de ejemplo
Ninguna
Ejemplo de respuestas
Código de estado: 200
OK
{ "total" : 2, "size" : 2, "vpc_channels" : [ { "name" : "channel 1", "port" : 8080, "balance_strategy" : 1, "member_type" : "ip", "dict_code" : "", "create_time" : "2020-07-23T07:24:33Z", "id" : "105c6902457144a4820dff8b1ad63331", "status" : 1, "member_groups" : [ ], "type" : 2, "microservice_info" : { "id" : "", "project_id" : "", "instance_id" : "", "service_type" : "", "cse_info" : { "cse_app_id" : "", "engine_id" : "", "engine_name" : "", "register_address" : "", "service_id" : "", "service_name" : "" }, "cce_info" : { "cluster_id" : "", "cluster_name" : "", "namespace" : "", "workload_type" : "", "app_name" : "" }, "create_time" : "", "update_time" : "" } }, { "name" : "channel 2", "port" : 8088, "balance_strategy" : 2, "member_type" : "ip", "dict_code" : "", "create_time" : "2020-07-23T07:11:57Z", "id" : "56a7d7358e1b42459c9d730d65b14e59", "status" : 1, "member_groups" : [ ], "type" : 3, "microservice_info" : { "id" : "9483afa235be45158a70c19ab817ac65", "project_id" : "73d69ae0cfcf460190522d06b60f05ad", "instance_id" : "f0fa1789-3b76-433b-a787-9892951c620e", "service_type" : "CCE", "cse_info" : { "cse_app_id" : "", "engine_id" : "", "engine_name" : "", "register_address" : "", "service_id" : "", "service_name" : "" }, "cce_info" : { "cluster_id" : "ab1485b4f91b45abbcd560be591f7309", "cluster_name" : "cce-test", "namespace" : "default", "workload_type" : "deployment", "app_name" : "testapp" }, "create_time" : "2020-07-23T07:11:57.244829604Z", "update_time" : "2020-07-23T07:11:57.244829604Z" } } ] }
Código de estado: 400
Bad Request
{ "error_code" : "APIG.2011", "error_msg" : "The request parameters must be specified,parameterName:name. Please refer to the support documentation" }
Código de estado: 401
Unauthorized
{ "error_code" : "APIG.1002", "error_msg" : "Incorrect token or token resolution failed" }
Código de estado: 403
Forbidden
{ "error_code" : "APIG.1005", "error_msg" : "No permissions to request this method" }
Código de estado: 404
Not Found
{ "error_code" : "APIG.3030", "error_msg" : "The instance does not exist;id:eddc4d25480b4cd6b512f270a1b8b341" }
Código de estado: 500
Internal Server Error
{ "error_code" : "APIG.9999", "error_msg" : "System error" }
Códigos de estado
Código de estado |
Descripción |
---|---|
200 |
OK |
400 |
Bad Request |
401 |
Unauthorized |
403 |
Forbidden |
404 |
Not Found |
500 |
Internal Server Error |
Códigos de error
Consulte Códigos de error.