查询VPC通道后端云服务组列表
功能介绍
查询VPC通道后端云服务组列表
URI
GET /v2/{project_id}/apic/instances/{instance_id}/vpc-channels/{vpc_channel_id}/member-groups
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
project_id |
是 |
String |
项目ID，获取方式请参见API参考的“附录 > 获取项目ID”章节。 |
|
instance_id |
是 |
String |
实例ID |
|
vpc_channel_id |
是 |
String |
VPC通道的编号 |
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
offset |
否 |
Long |
偏移量，表示从此偏移量开始查询，偏移量小于0时，自动转换为0 缺省值：0 |
|
limit |
否 |
Integer |
每页显示的条目数量 最小值：1 最大值：500 缺省值：20 |
|
dict_code |
否 |
String |
字典编码。 支持英文，数字，特殊字符（-_.） 暂不支持 最小长度：3 最大长度：64 |
|
member_group_name |
否 |
String |
VPC通道后端云服务组的名称 |
|
precise_search |
否 |
String |
指定需要精确匹配查找的参数名称，多个参数需要支持精确匹配时参数之间使用“,”隔开。 当前支持member_group_name。 |
请求参数
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
X-Auth-Token |
是 |
String |
用户Token。通过调用IAM服务获取用户Token接口获取（响应消息头中X-Subject-Token的值）。 |
响应参数
状态码： 200
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
size |
Integer |
本次返回的列表长度 |
|
total |
Long |
满足条件的记录数 |
|
member_groups |
Array of MemberGroupInfo objects |
VPC通道后端服务器组列表 |
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
member_group_name |
String |
VPC通道后端服务器组名称 |
|
member_group_remark |
String |
VPC通道后端服务器组描述 |
|
member_group_weight |
Integer |
VPC通道后端服务器组权重值。 当前服务器组存在服务器且此权重值存在时，自动使用此权重值分配权重。 最小值：0 最大值：100 |
|
dict_code |
String |
VPC通道后端服务器组的字典编码 支持英文，数字，特殊字符（-_.） 暂不支持 最小长度：3 最大长度：64 |
|
microservice_version |
String |
VPC通道后端服务器组的版本，仅VPC通道类型为微服务时支持。 最大长度：64 |
|
microservice_port |
Integer |
VPC通道后端服务器组的端口号，仅VPC通道类型为微服务时支持。端口号为0时后端服务器组下的所有地址沿用原来负载端口继承逻辑。 最小值：0 最大值：65535 |
|
microservice_labels |
Array of MicroserviceLabel objects |
VPC通道后端服务器组的标签，仅VPC通道类型为微服务时支持。 |
|
member_group_id |
String |
VPC通道后端服务器组编号 |
|
create_time |
String |
VPC通道后端服务器组创建时间 |
|
update_time |
String |
VPC通道后端服务器组更新时间 |
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
label_name |
String |
标签名称。 以字母或者数字开头和结尾，由字母、数字、连接符('-')、下划线('_')、点号('.')组成且63个字符之内。 最小长度：1 最大长度：63 |
|
label_value |
String |
标签值。 以字母或者数字开头和结尾，由字母、数字、连接符('-')、下划线('_')、点号('.')组成且63个字符之内。 最小长度：1 最大长度：63 |
状态码： 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" : 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"
} ]
}
状态码： 400
Bad Request
{
"error_code" : "APIG.2011",
"error_msg" : "The request parameters must be specified,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.3030",
"error_msg" : "The instance does not exist;id:f0fa1789-3b76-433b-a787-9892951c620e"
}
状态码： 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 |
错误码
请参见错误码。
