获取服务组列表
功能介绍
获取服务组列表
调用方法
请参见如何调用API。
URI
GET /v1/{project_id}/service-sets
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
project_id |
是 |
String |
租户项目id |
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
object_id |
是 |
String |
互联网边界防护对象id，可通过调用查询防火墙实例接口，type为0的为互联网边界防护对象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表示预定义服务组 |
请求参数
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
X-Auth-Token |
是 |
String |
用户Token。 通过调用IAM服务获取用户Token接口获取（响应消息头中X-Subject-Token的值） |
响应参数
状态码： 200
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
data |
ServiceSetRecords object |
查询服务组列表返回值 |
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
offset |
Integer |
偏移量：指定返回记录的开始位置，必须为数字，取值范围为大于或等于0，默认0 |
|
limit |
Integer |
每页显示个数，范围为1-1024 |
|
total |
Integer |
查询总数 |
|
records |
Array of ServiceSet objects |
服务组列表 |
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
set_id |
String |
服务组id |
|
name |
String |
名称 |
|
description |
String |
描述 |
|
service_set_type |
Integer |
服务组类型，0表示自定义服务组，1表示常用WEB服务，2表示常用远程登录和PING，3表示常用数据库 |
|
ref_count |
Integer |
引用次数 |
|
project_id |
String |
项目id |
|
protocols |
Array of integers |
协议类型列表 |
状态码： 400
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
data |
data object |
响应体 |
|
trace_id |
String |
trace id |
请求示例
查询项目id为2349ba469daf4b7daf268bb0261d18b0的项目的防护对象id为a37bb4eb-c49e-4e88-bf77-944a75b0ce8a的第一页服务组列表信息
https://{Endpoint}/v1/2349ba469daf4b7daf268bb0261d18b0/service-sets?object_id=a37bb4eb-c49e-4e88-bf77-944a75b0ce8a&limit=10&offset=0
响应示例
状态码： 200
查询服务组信息响应
{
"data" : {
"limit" : 50,
"offset" : 0,
"records" : [ {
"name" : "test",
"project_id" : "2349ba469daf4b7daf268bb0261d18b0",
"protocols" : [ 6 ],
"ref_count" : 2,
"service_set_type" : 0,
"set_id" : "6f475bad-5d33-45d1-98f8-c79f2f308d5a"
} ],
"total" : 1
}
}
状态码： 400
Bad Request
{
"error_code" : "CFW.0020016",
"error_msg" : "实例状态错误"
}
状态码
|
状态码 |
描述 |
|---|---|
|
200 |
查询服务组信息响应 |
|
400 |
Bad Request |
|
401 |
Unauthorized |
|
403 |
Forbidden |
|
404 |
Not Found |
|
500 |
Internal Server Error |
错误码
请参见错误码。
