文档首页/云防火墙 CFW/API参考（安卡拉区域）/API/服务组管理/新建服务成员
更新时间：2024-12-05 GMT+08:00
在线调试
CLI示例
查看PDF
分享

新建服务成员

功能介绍

批量添加服务组成员

调用方法

请参见如何调用API。

URI

POST /v1/{project_id}/service-items

表1 路径参数

参数

是否必选

参数类型

描述

project_id

是

String

租户项目id

表2 Query参数

参数

是否必选

参数类型

描述

enterprise_project_id

否

String

企业项目id，用户支持企业项目后，由企业项目生成的id。

fw_instance_id

否

String

防火墙实例id，创建云防火墙后用于标志防火墙由系统自动生成的标志id，可通过调用查询防火墙实例接口，默认情况下，fw_instance_Id为空时，返回账号下第一个墙的信息；fw_instance_Id非空时，返回与fw_instance_Id对应墙的信息。

请求参数

表3 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

是

String

用户Token。 通过调用IAM服务获取用户Token接口获取（响应消息头中X-Subject-Token的值）

表4 请求Body参数

参数

是否必选

参数类型

描述

set_id

是

String

服务组id

service_items

是

Array of service_items objects

添加服务组成员

表5 service_items

参数

是否必选

参数类型

描述

protocol

是

Integer

协议类型:TCP为6，UDP为17，ICMP为1，ICMPV6为58，ANY为-1，手动类型不为空，自动类型为空

source_port

是

String

源端口

dest_port

是

String

目的端口

description

否

String

服务成员描述

响应参数

状态码： 200

表6 响应Body参数

参数

参数类型

描述

data

ServiceItemIds object

新建服务组成员返回数据

表7 ServiceItemIds

参数

参数类型

描述

items

Array of items objects

服务组成员id列表

表8 items

参数

参数类型

描述

id

String

id值

状态码： 400

表9 响应Body参数

参数

参数类型

描述

data

data object

响应体

trace_id

String

trace id

表10 data

参数

参数类型

描述

id

String

标识ID

请求示例

给项目id为9d80d070b6d44942af73c9c3d38e0429的项目添加名称为ceshi的服务组成员，描述为添加服务组成员

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

{
  "set_id" : "7cdebed3-af07-494e-a3c2-b88bb8d58b57",
  "service_items" : [ {
    "description" : "添加服务组成员",
    "dest_port" : "1",
    "source_port" : "1",
    "protocol" : 6
  } ]
}

响应示例

状态码： 200

添加服务组成员返回值

{
  "data" : {
    "items" : [ {
      "id" : "cc41c4af-86e8-4ed2-80ad-87d399aeaed0"
    } ]
  }
}

状态码： 400

Bad Request

{
  "error_code" : "CFW.00200001",
  "error_msg" : "空参数错误"
}

状态码

状态码

描述

200

添加服务组成员返回值

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

500

Internal Server Error

错误码

请参见错误码。

父主题：服务组管理