查询服务成员列表
功能介绍
查询服务组成员列表
调用方法
请参见如何调用API。
URI
GET /v1/{project_id}/service-items
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
project_id |
是 |
String |
租户项目id |
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
set_id |
是 |
String |
服务组id |
key_word |
否 |
String |
查询字段 |
limit |
是 |
Integer |
每页显示个数，范围为1-1024 |
offset |
是 |
Integer |
偏移量：指定返回记录的开始位置，必须为数字，取值范围为大于或等于0，默认0 |
enterprise_project_id |
否 |
String |
企业项目id，用户支持企业项目后，由企业项目生成的id。 |
fw_instance_id |
否 |
String |
防火墙实例id，创建云防火墙后用于标志防火墙由系统自动生成的标志id，可通过调用查询防火墙实例接口，默认情况下，fw_instance_Id为空时，返回账号下第一个墙的信息；fw_instance_Id非空时，返回与fw_instance_Id对应墙的信息。 |
query_service_set_type |
否 |
Integer |
查询服务组类型，0表示自定义服务组，1表示预定义服务组。仅当set_id为预定义服务组id时生效 |
请求参数
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
X-Auth-Token |
是 |
String |
用户Token。 通过调用IAM服务获取用户Token接口获取（响应消息头中X-Subject-Token的值） |
响应参数
状态码： 200
参数 |
参数类型 |
描述 |
|---|---|---|
data |
data object |
服务组成员列表 |
参数 |
参数类型 |
描述 |
|---|---|---|
offset |
Integer |
偏移量：指定返回记录的开始位置，必须为数字，取值范围为大于或等于0，默认0 |
limit |
Integer |
每页显示个数，范围为1-1024 |
total |
Integer |
记录的总数 |
set_id |
String |
服务组id |
records |
Array of records objects |
记录 |
参数 |
参数类型 |
描述 |
|---|---|---|
item_id |
String |
服务成员id |
protocol |
Integer |
协议类型:TCP为6,UDP为17,ICMP为1,ICMPV6为58,ANY为-1,手动类型不为空，自动类型为空 |
source_port |
String |
源端口 |
dest_port |
String |
目的端口 |
description |
String |
服务成员描述 |
状态码： 400
参数 |
参数类型 |
描述 |
|---|---|---|
error_code |
String |
错误码 最小长度：8 最大长度：36 |
error_msg |
String |
错误描述 最小长度：2 最大长度：512 |
请求示例
查询项目id为9d80d070b6d44942af73c9c3d38e0429，服务组id为7cdebed3-af07-494e-a3c2-b88bb8d58b57的服务组成员列表
https://{Endpoint}/v1/9d80d070b6d44942af73c9c3d38e0429/service-items?set_id=7cdebed3-af07-494e-a3c2-b88bb8d58b57&limit=10&offset=0
响应示例
状态码： 200
服务组成员列表返回值
{
"data" : {
"limit" : 10,
"offset" : 0,
"records" : [ {
"dest_port" : "0",
"item_id" : "805b711d-c558-41e3-aab1-a4b8c3f1f90b",
"description" : "",
"protocol" : 1,
"source_port" : "0"
} ],
"set_id" : "7cdebed3-af07-494e-a3c2-b88bb8d58b57",
"total" : 1
}
}
状态码： 400
Bad Request
{
"error_code" : "CFW.00200005",
"error_msg" : "操作内容不存在"
}
状态码
状态码 |
描述 |
|---|---|
200 |
服务组成员列表返回值 |
400 |
Bad Request |
401 |
Unauthorized |
403 |
Forbidden |
404 |
Not Found |
500 |
Internal Server Error |
错误码
请参见错误码。
