Function

This API is used to obtain the service group list.

URI

GET /v1/{project_id}/service-sets

**Table 1** Path Parameters
Parameter	Mandatory	Type	Description
project_id	Yes	String	Project ID

**Table 2** Query Parameters
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.
key_word	No	String	Keyword
limit	Yes	Integer	Number of queries on each page, in the range 1-1024 Minimum: 1 Maximum: 1024
offset	Yes	Integer	Offset, which specifies the start position of the record to be returned. The value must be a number no less than 0. The default value is 0. Minimum: 0
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.
query_service_set_type	No	Integer	Query service set type, 0 means custom define service set, 1 means predefine service set.

Request Parameters

**Table 3** Request header 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.

Response Parameters

Status code: 200

**Table 4** Response body parameters
Parameter	Type	Description
data	ServiceSetRecords object	QueryServiceSetResponse

**Table 5** ServiceSetRecords
Parameter	Type	Description
offset	Integer	Offset, which specifies the start position of the record to be returned. The value must be a number no less than 0. The default value is 0.
limit	Integer	Number of records displayed on each page, in the range 1-1024
total	Integer	Total number of records queried
records	Array of ServiceSet objects	Service group list

**Table 6** ServiceSet
Parameter	Type	Description
set_id	String	Service group ID
name	String	Name
description	String	Description
service_set_type	Integer	Service set type, 0 indicates a custom service set, 1 indicates a predefined service set, 2 indicates commonly used remote login and PING, 3 indicates commonly used databases
ref_count	Integer	Reference count
status	String	Status
project_id	String	Project ID
protocols	Array of integers	Protocols

Status code: 400

**Table 7** Response body parameters
Parameter	Type	Description
error_code	String	Error code Minimum: 8 Maximum: 36
error_msg	String	Description Minimum: 2 Maximum: 512

Example Requests

Query the service group list on the first page of protected object a37bb4eb-c49e-4e88-bf77-944a75b0ce8a in project 2349ba469daf4b7daf268bb0261d18b0.

https://{Endpoint}/v1/2349ba469daf4b7daf268bb0261d18b0/service-sets?object_id=a37bb4eb-c49e-4e88-bf77-944a75b0ce8a&limit=10&offset=0

Example Responses

Status code: 200

Response to the request for querying service group information

{
  "data" : {
    "limit" : 50,
    "offset" : 0,
    "records" : [ {
      "name" : "test",
      "project_id" : "2349ba469daf4b7daf268bb0261d18b0",
      "protocols" : [ 6 ],
      "ref_count" : 2,
      "service_set_type" : 0,
      "set_id" : "6f475bad-5d33-45d1-98f8-c79f2f308d5a"
    } ],
    "total" : 1
  }
}

Status code: 400

Bad Request

{
  "error_code" : "CFW.0020016",
  "error_msg" : "instance status error"
}

Status Codes

Status Code	Description
200	Response to the request for querying service group information
400	Bad Request
401	Unauthorized
403	Forbidden
404	Not Found
500	Internal Server Error

Error Codes

See Error Codes.

Obtaining the Service Set List