更新时间:2025-11-21 GMT+08:00

新建服务组

功能介绍

创建服务组

调用方法

请参见如何调用API

URI

POST /v1/{project_id}/service-set

表1 路径参数

参数

是否必选

参数类型

描述

project_id

String

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

表2 Query参数

参数

是否必选

参数类型

描述

enterprise_project_id

String

企业项目ID,用户根据组织规划企业项目,对应的ID为企业项目ID,用户未开启企业项目时为0

fw_instance_id

String

防火墙ID,可通过防火墙ID获取方式获取

请求参数

表3 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

String

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

表4 请求Body参数

参数

是否必选

参数类型

描述

object_id

String

防护对象id,是创建云防火墙后用于区分互联网边界防护和VPC边界防护的标志id,可通过调用查询防火墙实例接口获得,通过返回值中的data.records.protect_objects.object_id(.表示各对象之间层级的区分)获得,type为0时,object_id为互联网边界防护对象ID,type为1时,object_id为VPC边界防护对象ID,type可通过data.records.protect_objects.type(.表示各对象之间层级的区分)获得,此处只能使用type为0的防护对象id

name

String

服务组名称

description

String

服务组描述信息

响应参数

状态码:200

表5 响应Body参数

参数

参数类型

描述

data

ServiceSetId object

创建服务组返回数据

表6 ServiceSetId

参数

参数类型

描述

id

String

服务组Id

name

String

服务组名称

状态码:400

表7 响应Body参数

参数

参数类型

描述

error_code

String

错误码

error_msg

String

错误描述

请求示例

添加项目id为9d80d070b6d44942af73c9c3d38e0429,防护对象为cfebd347-b655-4b84-b938-3c54317599b2,名称为ceshi的服务组。

https://{Endpoint}/v1/9d80d070b6d44942af73c9c3d38e0429/service-set

{
  "object_id" : "cfebd347-b655-4b84-b938-3c54317599b2",
  "name" : "ceshi",
  "description" : ""
}

响应示例

状态码:200

创建服务组返回值

{
  "data" : {
    "id" : "221cfdca-3abf-4c30-ab0d-516a03c70866"
  }
}

状态码:400

Bad Request,错误的请求

{
  "error_code" : "CFW.00200024",
  "error_msg" : "超出最大数量限制"
}

状态码

状态码

描述

200

创建服务组返回值

400

Bad Request,错误的请求

401

Unauthorized,错误的请求

403

Forbidden,禁止访问

404

Not Found,网页未找到

500

Internal Server Error

错误码

请参见错误码