Creating a Service Group
Function
This API is used to create a service group.
Debugging
You can debug this API through automatic authentication in or use the SDK sample code generated by API Explorer.
URI
POST /v1/{project_id}/service-set
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. |
Request Parameters
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 |
|---|---|---|---|
object_id |
Yes |
String |
Protected object ID, which is used to distinguish Internet border protection from VPC border protection after a CFW instance is created. You can obtain the ID by calling the API used for querying a firewall instance. Note that the value 0 indicates the ID of a protected object on the Internet border, and the value 1 indicates the ID of a protected object on the VPC border. For details, see the API Explorer and Help Center FAQ. |
name |
Yes |
String |
Service group name Minimum: 1 Maximum: 255 |
description |
No |
String |
Service group description Minimum: 1 Maximum: 255 |
Response Parameters
Status code: 200
Parameter |
Type |
Description |
|---|---|---|
data |
IdObject object |
Data returned when a service group is created |
Status code: 400
Parameter |
Type |
Description |
|---|---|---|
error_code |
String |
Error code Minimum: 8 Maximum: 36 |
error_msg |
String |
Description Minimum: 2 Maximum: 512 |
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 of creating a service group
{
"data" : {
"id" : "221cfdca-3abf-4c30-ab0d-516a03c70866"
}
}
Status code: 400
Bad Request
{
"error_code" : "CFW.00200024",
"error_msg" : "Exceeded maximum quantity limit"
}
Status Codes
Status Code |
Description |
|---|---|
200 |
Return value of creating a service group |
400 |
Bad Request |
401 |
Unauthorized |
403 |
Forbidden |
404 |
Not Found |
500 |
Internal Server Error |
Error Codes
See Error Codes.
Feedback
Was this page helpful?
Provide feedbackThank you very much for your feedback. We will continue working to improve the documentation.
