查看后端实例列表
功能介绍
查看指定VPC通道的后端实例列表。
调用方法
请参见如何调用API。
URI
GET /v2/{project_id}/apigw/instances/{instance_id}/vpc-channels/{vpc_channel_id}/members
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
project_id |
是 |
String |
项目ID，获取方式请参见获取项目ID。 |
|
instance_id |
是 |
String |
实例ID，在API网关控制台的“实例信息”中获取。 |
|
vpc_channel_id |
是 |
String |
VPC通道的编号 |
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
offset |
否 |
Long |
偏移量，表示从此偏移量开始查询，偏移量小于0时，自动转换为0 缺省值：0 |
|
limit |
否 |
Integer |
每页显示的条目数量，条目数量小于等于0时，自动转换为20，条目数量大于500时，自动转换为500 最小值：1 最大值：500 缺省值：20 |
|
name |
否 |
String |
云服务器的名称 |
|
member_group_name |
否 |
String |
后端服务器组名称。 |
|
member_group_id |
否 |
String |
后端服务器组编号 |
|
precise_search |
否 |
String |
指定需要精确匹配查找的参数名称，多个参数需要支持精确匹配时参数之间使用“,”隔开。 目前支持name，member_group_name。 |
请求参数
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
X-Auth-Token |
是 |
String |
用户Token。通过调用IAM服务获取用户Token接口获取（响应消息头中X-Subject-Token的值）。 |
响应参数
状态码： 200
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
size |
Integer |
本次返回的列表长度 |
|
total |
Long |
满足条件的记录数 |
|
members |
Array of VpcMemberInfo objects |
本次查询到的云服务器列表 |
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
host |
String |
后端服务器地址 后端实例类型为ip时必填 最大长度：255 |
|
weight |
Integer |
权重值。 允许您对后端服务进行评级，权重值越大，转发到该云服务的请求数量越多。 最小值：0 最大值：10000 |
|
is_backup |
Boolean |
是否备用节点。 开启后对应后端服务为备用节点，仅当非备用节点全部故障时工作。 实例需要升级到对应版本才支持此功能，如果不支持请联系技术支持。 缺省值：false |
|
member_group_name |
String |
后端服务器组名称。为后端服务地址选择服务器组，便于统一修改对应服务器组的后端地址。 |
|
status |
Integer |
后端服务器状态
|
|
port |
Integer |
后端服务器端口 最小值：0 最大值：65535 |
|
ecs_id |
String |
后端云服务器的编号。 后端实例类型为ecs时必填，支持英文，数字，“-”,“_”，1 ~ 64字符。 最大长度：255 |
|
ecs_name |
String |
后端云服务器的名称。 后端实例类型为ecs时必填，支持汉字，英文，数字，“-”,“_”,“.”，1 ~ 64字符。 最大长度：64 |
|
id |
String |
后端实例对象的编号 |
|
vpc_channel_id |
String |
VPC通道的编号 |
|
create_time |
String |
后端实例增加到VPC通道的时间 |
|
member_group_id |
String |
后端服务器组编号 |
|
health_status |
String |
负载通道后端实例健康状态，unknown、healthy、unhealthy分别标识未做健康检查、健康、不健康。 |
状态码： 400
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
error_code |
String |
错误码 |
|
error_msg |
String |
错误描述 |
状态码： 401
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
error_code |
String |
错误码 |
|
error_msg |
String |
错误描述 |
状态码： 403
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
error_code |
String |
错误码 |
|
error_msg |
String |
错误描述 |
状态码： 404
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
error_code |
String |
错误码 |
|
error_msg |
String |
错误描述 |
状态码： 500
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
error_code |
String |
错误码 |
|
error_msg |
String |
错误描述 |
请求示例
无
响应示例
状态码： 200
OK
{
"total" : 2,
"size" : 2,
"members" : [ {
"host" : "192.168.0.5",
"weight" : 1,
"is_backup" : false,
"member_group_name" : "",
"status" : 1,
"port" : 22,
"ecs_id" : "192.168.0.5",
"ecs_name" : "192.168.0.5",
"id" : "be63c6260a1043888187f84af39c9f0e",
"vpc_channel_id" : "56a7d7358e1b42459c9d730d65b14e59",
"create_time" : "2020-07-23T07:11:57Z",
"member_group_id" : "",
"health_status" : "unhealthy"
}, {
"host" : "192.168.1.124",
"weight" : 2,
"is_backup" : false,
"member_group_name" : "",
"status" : 1,
"port" : 22,
"ecs_id" : "192.168.1.124",
"ecs_name" : "192.168.1.124",
"id" : "a57b13f1b89b417ca8acd76909e6df67",
"vpc_channel_id" : "56a7d7358e1b42459c9d730d65b14e59",
"create_time" : "2020-07-23T07:11:57Z",
"member_group_id" : "",
"health_status" : "unhealthy"
} ]
}
状态码： 400
Bad Request
{
"error_code" : "APIG.2012",
"error_msg" : "Invalid parameter value,parameterName:name. Please refer to the support documentation"
}
状态码： 401
Unauthorized
{
"error_code" : "APIG.1002",
"error_msg" : "Incorrect token or token resolution failed"
}
状态码： 403
Forbidden
{
"error_code" : "APIG.1005",
"error_msg" : "No permissions to request this method"
}
状态码： 404
Not Found
{
"error_code" : "APIG.3023",
"error_msg" : "The VPC channel does not exist,id:56a7d7358e1b42459c9d730d65b14e59"
}
状态码： 500
Internal Server Error
{
"error_code" : "APIG.9999",
"error_msg" : "System error"
}
状态码
|
状态码 |
描述 |
|---|---|
|
200 |
OK |
|
400 |
Bad Request |
|
401 |
Unauthorized |
|
403 |
Forbidden |
|
404 |
Not Found |
|
500 |
Internal Server Error |
错误码
请参见错误码。
