Querying an Anti-DDoS Domain Name

Function

This API is used to query a tenant's Anti-DDoS domain name.

URI

GET /v1/edgeddos/domains

**Table 1** Query Parameters
Parameter	Mandatory	Type	Description
domain_name	No	String	Domain name.
enterprise_project_id	No	String	Obtain the enterprise project ID by calling the ListEnterpriseProject API of Enterprise Project Management Service (EPS).
offset	No	Integer	Offset, which is the position where the query starts. The value must be greater than or equal to 0. Minimum: 0 Default: 0
limit	No	Integer	Number of records displayed on each page Minimum: 1 Maximum: 1000 Default: 10

Request Parameters

**Table 2** Request header parameters
Parameter	Mandatory	Type	Description
X-Auth-Token	Yes	String	auth token

Response Parameters

Status code: 200

**Table 3** Response body parameters
Parameter	Type	Description
domain_list	Array of EdgeDDoSDomainVo objects	Domain name.
total	Long	Total number of domain names Minimum: 0 Default: 0

**Table 4** EdgeDDoSDomainVo
Parameter	Type	Description
id	String	Domain name ID
domain_name	String	Domain name.
tenant_id	String	Tenant ID.
area_type	String	Region that the domain name belongs to. Enumeration values: mainland_china outside_mainland_china europe global
dispatch_status	Integer	CDN domain name scheduling status (0: not protected; 1: configuring; 2: protected; 3: deleting)
protected_switch	Integer	Protection switch (0: off; 1: on)
open_date	Long	Start time
close_date	Long	Closing time
enterprise_project_id	String	Obtain the enterprise project ID by calling the ListEnterpriseProject API of Enterprise Project Management Service (EPS).

Status code: 400

**Table 5** Response body parameters
Parameter	Type	Description
error_code	String	Error code.
error_msg	String	Error message.

Status code: 401

**Table 6** Response body parameters
Parameter	Type	Description
error_code	String	Error code.
error_msg	String	Error message.

Status code: 500

**Table 7** Response body parameters
Parameter	Type	Description
error_code	String	Error code.
error_msg	String	Error message.

Example Requests

View the list of anti-DDoS domain names.

GET https://{Endpoint}/v1/edgeddos/domains?limit=10

Example Responses

Status code: 200

Request succeeded.

{
  "total" : 1,
  "domain_list" : [ {
    "id" : "095b60b21ac248579426f97379b3fbec",
    "domain_name" : "domain_name",
    "tenant_id" : "e5865897eb404d2e88e104f3fe3abff1",
    "area_type" : "outside_mainland_china",
    "dispatch_status" : 2,
    "protected_switch" : 1,
    "open_date" : 1691478911117,
    "enterprise_project_id" : 0
  } ]
}

Status Codes

Status Code	Description
200	Request succeeded.
400	Invalid request parameter.
401	The account corresponding to the token does not have sufficient permission.
500	Internal server error.