Querying the Protected Domain Name List_Protected Domain Name Management_API_API Reference

Function

Queries the protection domain name list.

URI

GET /v1/edgesec/configuration/domains

**Table 1** Query Parameters
Parameter	Mandatory	Type	Description
offset	No	Integer	Query offset.
limit	No	Integer	Number of records on each page of the query list.
domain_name	No	String	Domain name.
policy_name	No	String	Policy name.
enterprise_project_id	No	String	Obtain the enterprise project ID by calling the ListEnterpriseProject API of Enterprise Project Management Service (EPS). The default value is 0.

Request Parameters

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

Response Parameters

Status code: 200

**Table 3** Response body parameters
Parameter	Type	Description
total	Long	Total number of protected domain names.
domain_used_quota	Long	Used domain name quota.
domain_list	Array of DomainInfo objects	Details about a protected domain name.

**Table 4** DomainInfo
Parameter	Type	Description
id	String	Domain name ID.
domain_name	String	Domain name.
enterprise_project_id	String	Enterprise project ID.
dispatch_status	Integer	Scheduling status: Scheduling exception: dispatch_abnormal Unscheduled: un_dispatch Scheduling: dispatching Scheduled: dispatched Deleting: dispatch_deleting
policy_id	String	Policy ID.
protect_status	String	Protection status: Protected: on Not protected: off
create_time	Long	Time when the domain name is created.
update_time	Long	Time when the domain name is updated.

Status code: 400

**Table 5** Response body parameters
Parameter	Type	Description
error_code	String	Standard error code: service name.8-digit code
error_msg	String	Detailed error information.
encoded_authorization_message	String	If the service is integrated with IAM5.0, an IAM response must be returned when access is denied.

Status code: 401

**Table 6** Response body parameters
Parameter	Type	Description
error_code	String	Standard error code: service name.8-digit code
error_msg	String	Detailed error information.
encoded_authorization_message	String	If the service is integrated with IAM5.0, an IAM response must be returned when access is denied.

Status code: 500

**Table 7** Response body parameters
Parameter	Type	Description
error_code	String	Standard error code: service name.8-digit code
error_msg	String	Detailed error information.
encoded_authorization_message	String	If the service is integrated with IAM5.0, an IAM response must be returned when access is denied.

Example Requests

Querying the Protected Domain Name List

GET https://esa.cn-north-4.myhuaweicloud.com/v1/edgesec/configuration/domains?enterprise_project_id=0&domain_name=xxx.test.com&policy_name=policy1&offset=0&limit=10

Example Responses

Status code: 200

{
  "total" : 1,
  "domain_used_quota" : 10,
  "domain_list" : [ {
    "id" : "a5bd0ca4b2ac48cfb8c59deebf6b64e8",
    "domain_name" : "xxx.test.com",
    "enterprise_project_id" : "0",
    "dispatch_status" : "dispatched",
    "description" : "test",
    "policy_id" : "41671f652ef2430a9cb09c3c94bfdfg",
    "protect_status" : "on",
    "create_time" : 1715389902000,
    "update_time" : 1715389902000
  } ]
}

Status Codes

Status Code	Description
200	Request succeeded.
400	Request failed.
401	The token does not have required permissions.
500	Internal server error.

Error Codes

See Error Codes.