Consulta de grupos de servidores backend de un canal de VPC
Función
Esta API se utiliza para consultar grupos de servidores backend de un canal de VPC.
Método de invocación
Para obtener más información, véase invocación de API.
URI
GET /v2/{project_id}/apigw/instances/{instance_id}/vpc-channels/{vpc_channel_id}/member-groups
|
Parámetro |
Obligatorio |
Tipo |
Descripción |
|---|---|---|---|
|
project_id |
Sí |
String |
ID del proyecto. Para obtener más información sobre cómo obtenerlo, véase Obtención de un ID de proyecto. |
|
instance_id |
Sí |
String |
ID de gateway, que se puede obtener de la información de gateway en la consola de APIG. |
|
vpc_channel_id |
Sí |
String |
ID de canal de VPC. |
|
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 |
|
dict_code |
No |
String |
Código del diccionario. 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 |
|
member_group_name |
No |
String |
Nombre del grupo del servidor backend del canal VPC. |
|
precise_search |
No |
String |
Nombre del parámetro para la coincidencia exacta. Separar varios nombres de parámetros con comas (,). Actualmente, se admite member_group_name. |
Parámetros de solicitud
|
Parámetro |
Obligatorio |
Tipo |
Descripción |
|---|---|---|---|
|
X-Auth-Token |
Sí |
String |
Token de usuario. Se puede obtener invocando 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. |
|
member_groups |
Array of MemberGroupInfo objects |
Grupos de servidores backend del canal VPC. |
|
Parámetro |
Tipo |
Descripción |
|---|---|---|
|
member_group_name |
String |
Nombre del grupo de servidores backend del canal de VPC. Puede contener de 3 a 64 caracteres, comenzando con una letra. Solo se permiten letras, dígitos, guiones bajos (_), guiones medios (-) y puntos (.). |
|
member_group_remark |
String |
Descripción del grupo de servidores backend. Máximo: 255 |
|
member_group_weight |
Integer |
Ponderación del grupo de servidores backend. Si el grupo de servidores contiene servidores y se ha establecido una ponderación para él, la ponderación se utiliza automáticamente para asignar ponderaciones 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. |
|
reference_vpc_channel_id |
String |
ID del canal de balanceo de carga de referencia. Este parámetro solo se admite cuando el tipo de canal de VPC es de referencia (vpc_channel_type=reference). Mínimo: 0 Máximo: 64 |
|
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. Se comienza y se termina con una letra o un dígito. Se utiliza 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. Se comienza y se termina con una letra o un dígito. Se utiliza solo letras, dígitos, guiones (-), guiones bajos (_) y puntos (.). (Máx. 63 caracteres.) Mínimo: 1 Máximo: 63 |
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. |
Ejemplo de las solicitudes
Ninguno
Ejemplo de respuestas
Código de estado: 200
Aceptar
{
"total" : 1,
"size" : 1,
"member_groups" : [ {
"member_group_name" : "vpc_member_group",
"member_group_remark" : "remark",
"member_group_weight" : 1,
"dict_code" : "",
"member_group_id" : "105c6902457144a4820dff8b1ad63331",
"create_time" : "2020-07-23T07:24:33Z",
"update_time" : "2020-07-23T07:24:33Z",
"microservice_version" : "",
"microservice_port" : 0,
"microservice_labels" : [ ]
} ]
}
Código de estado: 400
Error en la solicitud
{
"error_code" : "APIG.2001",
"error_msg" : "The request parameters must be specified, parameter name:members"
}
Código de estado: 401
Sin autorización
{
"error_code" : "APIG.1002",
"error_msg" : "Incorrect token or token resolution failed"
}
Código de estado: 403
Prohibido
{
"error_code" : "APIG.1005",
"error_msg" : "No permissions to request this method"
}
Código de estado: 404
No se ha encontrado
{
"error_code" : "APIG.3030",
"error_msg" : "The instance does not exist,id:56a7d7358e1b42459c9d730d65b14e59"
}
Código de estado: 500
Error del servidor interno
{
"error_code" : "APIG.9999",
"error_msg" : "System error"
}
Códigos de estado
|
Código de estado |
Descripción |
|---|---|
|
200 |
Aceptar |
|
400 |
Error en la solicitud |
|
401 |
Sin autorización |
|
403 |
Prohibido |
|
404 |
No se ha encontrado |
|
500 |
Error del servidor interno |
Códigos de error
Consulte Códigos de error.
