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.
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 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. |
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 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ámetro |
Obligatorio |
Tipo |
Descripción |
---|---|---|---|
members |
Sí |
Array of MemberInfo objects |
Lista de servidores 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: 64 |
weight |
No |
Integer |
Peso. Cuanto mayor sea el peso, más solicitudes recibirá un servicio de back-end. 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 función, el servicio backend sirve como nodo en espera. Funciona solo cuando todos los nodos no en espera están defectuosos. 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 del servidor de backend. El grupo de servidores facilita la modificación de la dirección del servicio de back-end. |
status |
No |
Integer |
Estado del servidor backend.
Valores de enumeración:
|
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, incluyendo 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, incluyendo 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: 64 |
weight |
Integer |
Peso. Cuanto mayor sea el peso, más solicitudes recibirá un servicio de back-end. Mínimo: 0 Máximo: 10000 |
is_backup |
Boolean |
Indica si el servicio backend es un nodo en espera. Después de habilitar esta función, el servicio backend sirve como nodo en espera. Funciona solo cuando todos los nodos no en espera están defectuosos. 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 del servidor de backend. El grupo de servidores facilita la modificación de la dirección del servicio de back-end. |
status |
Integer |
Estado del servidor backend.
Valores de enumeración:
|
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, incluyendo 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, incluyendo letras, dígitos, guiones (-), guiones bajos (_), y puntos (.). Máximo: 64 |
id |
String |
ID del servidor 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. |
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
-
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
Created
-
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" }, { "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" } ] }
Código de estado: 400
Bad Request
{ "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
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.3023", "error_msg" : "The VPC channel does not exist,id:56a7d7358e1b42459c9d730d65b14e59" }
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 |
---|---|
201 |
Created |
400 |
Bad Request |
401 |
Unauthorized |
403 |
Forbidden |
404 |
Not Found |
500 |
Internal Server Error |
Códigos de error
Consulte Códigos de error.