Adición o actualización de instancias de backend
Función
Esta API se utiliza para agregar instancias de backend a un canal de VPC.
Si ya existe una instancia de backend con la dirección especificada, se actualiza la información de la instancia. Si el cuerpo de la solicitud contiene varias definiciones de instancia de backend con la misma dirección, se utiliza la primera definición.
No se pueden agregar ni actualizar instancias de backend para un canal de balanceo de carga de referencia.
Método de invocación
Para obtener más información, véase invocación de API.
URI
POST /v2/{project_id}/apigw/instances/{instance_id}/vpc-channels/{vpc_channel_id}/members
|
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á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ámetro |
Obligatorio |
Tipo |
Descripción |
|---|---|---|---|
|
members |
Sí |
Array of MemberInfo objects |
Instancias de backend. |
|
Parámetro |
Obligatorio |
Tipo |
Descripción |
|---|---|---|---|
|
host |
No |
String |
Dirección del servidor backend. Este parámetro es necesario cuando el tipo de miembro es dirección IP. Máximo: 255 |
|
weight |
No |
Integer |
Ponderación. Cuanto mayor sea la ponderación, más solicitudes recibirá un servicio de backend. Mínimo: 0 Máximo: 10000 |
|
is_backup |
No |
Boolean |
Indica si el servicio backend es un nodo en espera. Después de habilitar esta opción, el servicio de backend correspondiente actúa como nodo en espera y funciona solo cuando todos los nodos que no son en espera presentan fallas. Esta función solo se admite cuando el gateway se ha actualizado a la versión correspondiente. Si su gateway no admite esta función, póngase en contacto con el soporte técnico. Predeterminado: false |
|
member_group_name |
No |
String |
Nombre del grupo de servidores backend. El grupo de servidores facilita la modificación de la dirección del servicio de backend. |
|
status |
No |
Integer |
Estado del servidor backend.
|
|
port |
No |
Integer |
Puerto de servidor de backend. Mínimo: 0 Máximo: 65535 |
|
ecs_id |
No |
String |
ID del servidor de backend. Este parámetro es necesario si el tipo de instancia de backend es ecs. El valor puede contener de 1 a 64 caracteres, incluidos letras, dígitos, guiones (-) y guiones bajos (_). Máximo: 255 |
|
ecs_name |
No |
String |
Nombre del servidor de backend. Este parámetro es necesario si el tipo de instancia de backend es ecs. El valor puede contener de 1 a 64 caracteres, incluidos letras, dígitos, guiones (-), guiones bajos (_) y puntos (.). Máximo: 64 |
Parámetros de respuesta
Código de estado: 201
|
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. |
|
members |
Array of VpcMemberInfo objects |
Lista de servidores en la nube. |
|
Parámetro |
Tipo |
Descripción |
|---|---|---|
|
host |
String |
Dirección del servidor backend. Este parámetro es necesario cuando el tipo de miembro es dirección IP. Máximo: 255 |
|
weight |
Integer |
Ponderación. Cuanto mayor sea la ponderación, más solicitudes recibirá un servicio de backend. Mínimo: 0 Máximo: 10000 |
|
is_backup |
Boolean |
Indica si el servicio backend es un nodo en espera. Después de habilitar esta opción, el servicio de backend correspondiente actúa como nodo en espera y funciona solo cuando todos los nodos que no son en espera presentan fallas. Esta función solo se admite cuando el gateway se ha actualizado a la versión correspondiente. Si su gateway no admite esta función, póngase en contacto con el soporte técnico. Predeterminado: false |
|
member_group_name |
String |
Nombre del grupo de servidores backend. El grupo de servidores facilita la modificación de la dirección del servicio de backend. |
|
status |
Integer |
Estado del servidor backend.
|
|
port |
Integer |
Puerto de servidor de backend. Mínimo: 0 Máximo: 65535 |
|
ecs_id |
String |
ID del servidor de backend. Este parámetro es necesario si el tipo de instancia de backend es ecs. El valor puede contener de 1 a 64 caracteres, incluidos letras, dígitos, guiones (-) y guiones bajos (_). Máximo: 255 |
|
ecs_name |
String |
Nombre del servidor de backend. Este parámetro es necesario si el tipo de instancia de backend es ecs. El valor puede contener de 1 a 64 caracteres, incluidos letras, dígitos, guiones (-), guiones bajos (_) y puntos (.). Máximo: 64 |
|
id |
String |
ID de instancia de backend. |
|
vpc_channel_id |
String |
ID de canal de VPC. |
|
create_time |
String |
Hora en la que se agrega el servidor backend al canal de VPC. |
|
member_group_id |
String |
ID de grupo de servidor de backend. |
|
health_status |
String |
Estado de mantenimiento de la instancia de backend del canal de balanceo de carga. El valor puede ser desconocido, saludable o no saludable, lo que indica que no se realiza ninguna comprobación de estado, saludable o no saludable, respectivamente. |
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
-
Adición de una dirección IP de servidor en la nube a un canal de VPC
{ "members" : [ { "host" : "192.168.2.25", "weight" : 1, "member_group_name" : "test" } ] } -
Adición de un nombre de servidor en la nube a un canal de VPC
{ "members" : [ { "ecs_id" : "1082720c-3c15-409c-9ae3-4983ddfb6a9d", "ecs_name" : "APIGtest02", "weight" : 2 } ] }
Ejemplo de respuestas
Código de estado: 201
Creado
-
Ejemplo 1
{ "total" : 1, "size" : 1, "members" : [ { "host" : "192.168.2.25", "weight" : 1, "is_backup" : false, "member_group_name" : "test", "status" : 1, "port" : 22, "ecs_id" : "3082720c-3c15-409c-9ae3-4983ddfb6a9d", "ecs_name" : "APIGtest", "id" : "683b6807cad54122a6777ad047a6178e", "vpc_channel_id" : "105c6902457144a4820dff8b1ad63331", "create_time" : "2020-07-23T09:13:24Z", "member_group_id" : "cf868f0224084710a1e188b7d3057c52" } ] } -
Ejemplo 2
{ "total" : 2, "size" : 2, "members" : [ { "host" : "192.168.0.17", "weight" : 2, "is_backup" : false, "member_group_name" : "test02", "status" : 1, "port" : 22, "ecs_id" : "1082720c-3c15-409c-9ae3-4983ddfb6a9d", "ecs_name" : "APIGtest02", "id" : "5c868f0224084710a1e188b7d3057c52", "vpc_channel_id" : "105c6902457144a4820dff8b1ad63331", "create_time" : "2020-07-23T09:03:53Z", "member_group_id" : "df868f0224084710a1e188b7d3057c52", "health_status" : "unhealthy" }, { "host" : "192.168.0.39", "weight" : 1, "is_backup" : false, "member_group_name" : "test01", "status" : 1, "port" : 22, "ecs_id" : "ebe1104f-1254-4ac6-8ed7-366bec84f36e", "ecs_name" : "APIGtest01", "id" : "33ac0e39d005492eb1f4683e66d1a0d1", "vpc_channel_id" : "105c6902457144a4820dff8b1ad63331", "create_time" : "2020-07-23T07:24:34Z", "member_group_id" : "ef868f0224084710a1e188b7d3057c42", "health_status" : "unhealthy" } ] }
Código de estado: 400
Error en la solicitud
{
"error_code" : "APIG.2004",
"error_msg" : "The parameter value is outside the allowable range,parameterName:weight. Please refer to the support documentation"
}
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.3023",
"error_msg" : "The VPC channel 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 |
|---|---|
|
201 |
Creado |
|
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.