Querying Details About a Protected Domain Name_Protected Domain Name Management_API_API Reference

Function

This API is used to query a protected domain name.

URI

GET /v1/edgesec/configuration/domains/{domain_id}

**Table 1** Path Parameters
Parameter	Mandatory	Type	Description
domain_id	Yes	String	Protected domain name ID.

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
id	String	Domain name ID.
domain_name	String	Domain name.
enterprise_project_id	String	Enterprise project ID.
description	String	Domain name description.
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 4** 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 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: 500

**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.

Example Requests

Querying Details About a Protected Domain Name

GET https://esa.cn-north-4.myhuaweicloud.com/v1/edgesec/configuration/domains/a5bd0ca4b2ac48cfb8c59deebf6b64e8

Example Responses

Status code: 200

{
  "id" : "a5bd0ca4b2ac48cfb8c59deebf6b64e8",
  "domain_name" : "xxx.test.com",
  "enterprise_project_id" : "0",
  "description" : "test",
  "policy_id" : "41671f652ef2430a9cb09c3c94bfdfg",
  "protect_status" : "on",
  "create_time" : 1715389902000,
  "update_time" : 1715389902000
}

Status Codes

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

Error Codes

See Error Codes.