Adding Service Group Members¶

Function¶

This API is used to add service group members in batches.

URI¶

POST /v1/{project_id}/service-items

**Table 1** Path Parameters¶
Parameter	Mandatory	Type	Description
project_id	Yes	String	Project ID, which can be obtained by calling an API or from the console. For details, see Obtaining a Project ID.

**Table 2** Query Parameters¶
Parameter	Mandatory	Type	Description
enterprise_project_id	No	String	Enterprise project ID, which is the ID of a project planned based on organizations. You can obtain the enterprise project ID by referring to Obtaining an Enterprise Project ID. If the enterprise project function is not enabled, the value is 0.
fw_instance_id	No	String	Firewall ID, which can be obtained by referring to Obtaining a Firewall ID.

Request Parameters¶

**Table 3** Request header parameters¶
Parameter	Mandatory	Type	Description
X-Auth-Token	Yes	String	User token. You can obtain the token by referring to Obtaining a User Token.
Content-Type	Yes	String	Content type. It can only be set to application/json.

**Table 4** Request body parameters¶
Parameter	Mandatory	Type	Description
set_id	Yes	String	Service group ID, which can be obtained by calling the API for querying the service group list. Find the value in data.records.set_id (The period [.] is used to separate different levels of objects).
service_items	Yes	Array of service_items objects	Service group member list.

**Table 5** service_items¶
Parameter	Mandatory	Type	Description
protocol	Yes	Integer	Protocol type: 6 (TCP), 17 (UDP), 1 (ICMP), 58 (ICMPv6), or -1 (any). It cannot be left blank when type is set to 0 (manual), and can be left blank when type is set to 1 (automatic).
source_port	Yes	String	Source port.
dest_port	Yes	String	Destination port.
description	No	String	Service member description.

Response Parameters¶

Status code: 200

**Table 6** Response body parameters¶
Parameter	Type	Description
data	ServiceItemIds object	Data returned for creating a service group member.

**Table 7** ServiceItemIds¶
Parameter	Type	Description
items	Array of items objects	List of service group member IDs.

**Table 8** items¶
Parameter	Type	Description
id	String	Service group member ID.

Status code: 400

**Table 9** Response body parameters¶
Parameter	Type	Description
error_code	String	Error code.
error_msg	String	Error description.

Example Requests¶

Add a service group member named ceshi to project 9d80d070b6d44942af73c9c3d38e0429. The description is Add a service group member.

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

{
  "set_id" : "7cdebed3-af07-494e-a3c2-b88bb8d58b57",
  "service_items" : [ {
    "description" : "Add members to a service group.",
    "dest_port" : "1",
    "source_port" : "1",
    "protocol" : 6
  } ]
}

Example Responses¶

Status code: 200

Return value for adding service group members.

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

Status code: 400

Bad Request

{
  "error_code" : "CFW.00200001",
  "error_msg" : "Empty parameter."
}

Status Codes¶

Status Code	Description
200	Return value for adding service group members.
400	Bad Request
401	Unauthorized
403	Forbidden
404	Not Found
500	Internal Server Error

Error Codes¶

See Error Codes.

last updated: 2025-01-21 13:19 UTC - commit: abe94c6df6d30c3b44340c2119ffd81f9990504a