添加后端实例(云服务器)
功能介绍
为指定的VPC通道添加云服务器。
URI
HTTP/HTTPS请求方法以及URI如下表所示。
请求方法 |
URI |
---|---|
POST |
/v1/{project_id}/apigw/instances/{instance_id}/vpc-channels/{id}/members |
URI中的参数说明如下表所示。
名称 |
是否必选 |
类型 |
说明 |
---|---|---|---|
project_id |
是 |
String |
项目ID。可从控制台“我的凭证”中获取region下项目ID,管理员权限可查询。 |
instance_id |
是 |
String |
实例ID,可从API网关控制台的专享版实例信息中获取。 |
id |
是 |
String |
VPC通道的编号。 |
请求消息
参数 |
是否必选 |
类型 |
说明 |
---|---|---|---|
vpc_instances |
是 |
字典数据类型 |
后端实例列表。 |
参数 |
是否必选 |
类型 |
说明 |
---|---|---|---|
instance_name |
是 |
String |
云服务器的名称。 支持汉字,英文,数字,“-”,“_”,“.”,1~ 64字符。
说明:
中文字符必须为UTF-8或者unicode编码。 |
instance_id |
是 |
String |
云服务器的ID。 支持英文,数字,“-”,“_”,1 ~ 64字符。 |
weight |
是 |
Integer |
权重值。 权重值越大,转发到该云服务器的请求数量越多。 取值范围1 ~ 100。 |
请求消息样例:
{ "vpc_instances": [ { "instance_id": "instance02", "instance_name": "instance_name02", "weight": 10 } ] }
响应消息
名称 |
类型 |
说明 |
---|---|---|
total |
Integer |
该VPC通道下的云服务器总数。 |
size |
Integer |
本次返回的云服务器总数。 |
vpc_instances |
字典数据类型 |
云服务器列表。 |
名称 |
类型 |
说明 |
---|---|---|
id |
String |
后端实例对象的编号。 |
vpc_id |
String |
VPC通道的编号。 |
status |
Integer |
后端实例对象的状态。 |
instance_name |
String |
云服务器的名称。 |
instance_id |
String |
云服务器的ID。 |
host |
String |
云服务器的主机地址 |
weight |
Integer |
权重值。 权重值越大,转发到该云服务器的请求数量越多。 取值范围1 ~ 100。 |
create_time |
Timestamp |
云服务器增加到VPC通道的时间。 |
响应消息样例:
{ "total": 2, "size": 2, "vpc_instances": [ { "instance_id": "instance02", "instance_name": "instance_name02", "host": "127.0.0.2", "weight": 10, "id": "680e42fab429447ca23b9623107523d9", "vpc_id": "c3e6a7d85d9e47be89dfcc3cd37405d7", "status": 1, "create_time": "2018-07-27T12:42:32Z" }, { "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" } ] }
状态码
状态码 |
说明 |
---|---|
201 |
Created |
400 |
Bad Request |
401 |
Unauthorized |
403 |
Forbidden |
404 |
Not Found |
500 |
Server Internal Error |