This API is used to add group members in batches.
POST /v1/{project_id}/service-items
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
project_id |
Yes |
String |
Project ID |
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
enterprise_project_id |
No |
String |
Enterprise project id, the id generated by the enterprise project after the user supports the enterprise project. |
fw_instance_id |
No |
String |
Firewall instance ID, which is automatically generated after a CFW instance is created. You can obtain the ID by calling the API used for querying a firewall instance. For details, see the API Explorer and Help Center FAQ.By default, if fw_instance_Id is not specified, information about the first firewall under the account is returned. If fw_instance_Id is specified, information about the firewall with this fw_instance_Id is returned.If object_Id is specified, information about the firewall with this object_Id is returned by default. If both fw_instance_Id and object_Id are specified, the specified object_Id must belong to the specified firewall. |
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
X-Auth-Token |
Yes |
String |
User token. It can be obtained by calling the IAM API used to obtain a user token. The value of X-Subject-Token in the response header is a token. |
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
set_id |
Yes |
String |
Service group ID |
service_items |
Yes |
Array of service_items objects |
Add a member to a service group. |
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
protocol |
Yes |
Integer |
Protocol type. The value 6 indicates TCP, 17 indicates UDP, 1 indicates ICMP, 58 indicates ICMPv6, and -1 indicates any protocol. Regarding the addition type, a null value indicates it is automatically added. |
source_port |
Yes |
String |
Source port |
dest_port |
Yes |
String |
Destination port |
name |
No |
String |
Service member name |
description |
No |
String |
Service member description |
Status code: 200
Parameter |
Type |
Description |
---|---|---|
data |
ServiceItemIds object |
Data returned when a service group member is created |
Parameter |
Type |
Description |
---|---|---|
items |
Array of IdObject objects |
Service group member ID list |
Status code: 400
Parameter |
Type |
Description |
---|---|---|
error_code |
String |
Error code Minimum: 8 Maximum: 36 |
error_msg |
String |
Description Minimum: 2 Maximum: 512 |
Add a service group member named ceshi to the project whose ID is 9d80d070b6d44942af73c9c3d38e0429.
https://{Endpoint}/v1/9d80d070b6d44942af73c9c3d38e0429/service-items { "set_id" : "7cdebed3-af07-494e-a3c2-b88bb8d58b57", "service_items" : [ { "description" : "Add a member to a service group", "name" : "ceshi", "dest_port" : "1", "source_port" : "1", "protocol" : 6 } ] }
Status code: 200
Return value for adding a service group member
{ "data" : { "items" : [ { "id" : "cc41c4af-86e8-4ed2-80ad-87d399aeaed0" } ] } }
Status code: 400
Bad Request
{ "error_code" : "CFW.00200001", "error_msg" : "empty param" }
Status Code |
Description |
---|---|
200 |
Return value for adding a service group member |
400 |
Bad Request |
401 |
Unauthorized |
403 |
Forbidden |
404 |
Not Found |
500 |
Internal Server Error |
See Error Codes.