文档首页/云防火墙 CFW/API参考 (联盟区域) /API/服务组管理/获取服务组列表
更新时间：2025-12-29 GMT+08:00
在线调试
CLI示例
查看PDF
分享

获取服务组列表

功能介绍

获取服务组列表

URI

GET /v1/{project_id}/service-sets

表1 路径参数

参数

是否必选

参数类型

描述

project_id

是

String

项目ID, 可以从调API处获取，也可以从控制台获取。项目ID获取方式

表2 Query参数

参数

是否必选

参数类型

描述

object_id

是

String

防护对象id，是创建云防火墙后用于区分互联网边界防护和VPC边界防护的标志id，可通过调用查询防火墙实例接口获得，通过返回值中的data.records.protect_objects.object_id（.表示各对象之间层级的区分）获得，注意type为0的为互联网边界防护对象id，type为1的为VPC边界防护对象id，type可通过data.records.protect_objects.type（.表示各对象之间层级的区分）获得

key_word

否

String

关键字，可使用功能服务组名称和服务组描述的一部分

limit

是

Integer

每页查询个数，范围为1-1024

offset

是

Integer

偏移量：指定返回记录的开始位置，必须为数字，取值范围为大于或等于0，默认0

enterprise_project_id

否

String

企业项目ID，用户根据组织规划企业项目，对应的ID为企业项目ID，可通过如何获取企业项目ID获取，用户未开启企业项目时为0

fw_instance_id

否

String

防火墙id，可通过防火墙ID获取方式获取

query_service_set_type

否

Integer

查询服务组类型，0表示自定义服务组，1表示预定义服务组

请求参数

表3 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

是

String

用户Token。可通过如何获取用户Token获取。

Content-Type

是

String

内容类型，只有application/json的值是适用的

响应参数

状态码：200

表4 响应Body参数

参数

参数类型

描述

data

ServiceSetRecords object

查询服务组列表记录

表5 ServiceSetRecords

参数

参数类型

描述

offset

Integer

偏移量：指定返回记录的开始位置，必须为数字，取值范围为大于或等于0，默认0

limit

Integer

每页显示个数，范围为1-1024

total

Integer

查询服务组总数

records

Array of ServiceSet objects

服务组列表

表6 ServiceSet

参数

参数类型

描述

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

协议列表，协议类型：TCP为6，UDP为17，ICMP为1，ICMPV6为58，ANY为-1,type为0手动类型时不能为空。

状态码：400

表7 响应Body参数

参数

参数类型

描述

error_code

String

错误码

error_msg

String

错误描述

请求示例

查询项目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

错误码

请参见错误码。

父主题：服务组管理