Help Center/Cloud Firewall/API Reference (Ally Region)/API/Service Group Management/Creating a Service Group
Updated on 2026-01-07 GMT+08:00
Online Debugging
CLI Examples
View PDF
Share

Creating a Service Group

Function

This API is used to create a service group.

URI

POST /v1/{project_id}/service-set

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

object_id

Yes

String

Protected object ID, which is used to distinguish between Internet border protection and VPC border protection after a cloud firewall is created. You can obtain the ID by calling the API for querying firewall instances. In the return value, find the ID in data.records.protect_objects.object_id (The period [.] is used to separate different levels of objects). If the value of type is 0, the protected object ID belongs to the Internet border. If the value of type is 1, the protected object ID belongs to the VPC border. You can obtain the value of type from data.records.protect_objects.type (The period [.] is used to separate different levels of objects).

name

Yes

String

Service group name.

description

No

String

Service group description.

Response Parameters

Status code: 200

Table 5 Response body parameters

Parameter

Type

Description

data

ServiceSetId object

Data returned for creating a service group.

Table 6 ServiceSetId

Parameter

Type

Description

id

String

Service group ID.

name

String

Service group name.

Status code: 400

Table 7 Response body parameters

Parameter

Type

Description

error_code

String

Error code.

error_msg

String

Error description.

Example Requests

Add a service group whose project ID is 9d80d070b6d44942af73c9c3d38e0429, protected object is cfebd347-b655-4b84-b938-3c54317599b2, and name is ceshi.

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

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

Example Responses

Status code: 200

Return value for creating a service group.

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

Status code: 400

Bad Request

{
  "error_code" : "CFW.00200024",
  "error_msg" : "Exceeded the upper limit."
}

Status Codes

Status Code

Description

200

Return value for creating a service group.

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

500

Internal Server Error

Error Codes

See Error Codes.