doc-exports/docs/cfw/api-ref/ListDomainSets.html

list domain sets

Function

list domain sets

URI

GET /v1/{project_id}/domain-sets

Table 1 Path Parameters

Parameter	Mandatory	Type	Description
project_id	Yes	String	project ID

Table 2 Query Parameters

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	Yes	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.
limit	Yes	Integer	Number of records displayed on each page, in the range 1-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.
object_id	Yes	String	Internet border Protected object ID, 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.
key_word	No	String	key
domain_set_type	No	Integer	Domain name group type. 0 means Application type and 1 means Network type.
config_status	No	Integer	config status

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	ListDomainsetsResponseData object	list domain set response

Table 5 ListDomainsetsResponseData

Parameter	Type	Description
limit	Integer	Number of records displayed on each page, in the range 1-1024
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.
total	Integer	total
records	Array of DomainSetVo objects	domain set list

Table 6 DomainSetVo

Parameter	Type	Description
set_id	String	set id
name	String	domain set name
description	String	description
ref_count	Integer	reference count
domain_set_type	Integer	Domain name group type. 0 means Application type and 1 means Network type.
config_status	Integer	config status
message	String	message
rules	Array of UseRuleVO objects	used rule list

Table 7 UseRuleVO

Parameter	Type	Description
id	String	rule id
name	String	rule name

Example Requests

Query the domain set list of firewall 546af3f8-88e9-47f2-a205-2346d7090925 in project 9d80d070b6d44942af73c9c3d38e0429. The protected object ID is ae42418e-f077-41a0-9d3b-5b2f5ad9102b.

https://{Endpoint}/v1/9d80d070b6d44942af73c9c3d38e0429/domain-sets?fw_instance_id=546af3f8-88e9-47f2-a205-2346d7090925&enterprise_project_id=default&limit=50&offset=0&object_id=ae42418e-f077-41a0-9d3b-5b2f5ad9102b

Example Responses

Status code: 200

List Domain Set Response

{
  "data" : {
    "limit" : 50,
    "offset" : 0,
    "records" : [ {
      "config_status" : 3,
      "description" : "",
      "domain_set_type" : 0,
      "name" : "ccdd",
      "ref_count" : 0,
      "set_id" : "e43db369-a863-45ed-8850-58d6b571b1ab"
    } ],
    "total" : 1
  }
}

Status Codes

Status Code	Description
200	List Domain Set Response

Error Codes

See Error Codes.

Parent topic: Domain Parse and Domain Set Management