Querying a Protected Domain Name
Function
This API is used to query a protected domain name.
URI
GET /v1/edgewaf/domains/{domainid}
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
domainid |
Yes |
String |
Protected domain name ID. |
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
enterprise_project_id |
No |
String |
Obtain the enterprise project ID by calling the ListEnterpriseProject API of Enterprise Project Management Service (EPS). |
Request Parameters
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
X-Auth-Token |
Yes |
String |
User token. It can be obtained by calling the IAM API (value of X-Subject-Token in the response header). |
Response Parameters
Status code: 200
Parameter |
Type |
Description |
---|---|---|
id |
String |
Domain name ID. |
domain_name |
String |
Domain name. |
enterprise_project_id |
String |
Obtain the enterprise project ID by calling the ListEnterpriseProject API of Enterprise Project Management Service (EPS). |
tenant_id |
String |
Tenant ID. |
open_time |
Long |
Last time when protection was last enabled. |
close_time |
Long |
Last time when protection was last disabled. |
dispatch_status |
Integer |
CDN domain name scheduling status (0: not protected; 1: configuring; 2: protected; 3: deleting) |
service_area |
String |
Region that the domain name belongs to. |
web_tag |
String |
Domain name. |
description |
String |
Domain name description. |
policy_id |
String |
Policy ID. |
protocol |
String |
Protocol. Enumeration values:
|
certificate_id |
String |
Certificate ID. |
certificate_name |
String |
Certificate name. |
tls |
String |
Minimum TLS version (TLS v1.0, TLS v1.1, or TLS v1.2). The default value is TLS v1.0. The TLS parameter is configured only if the client protocol is HTTPS. Enumeration values:
|
cipher |
String |
The cipher parameter is available only if the client protocol is HTTPS. Its values are as follows, each representing a cryptographic algorithm:
Enumeration values:
|
protect_status |
Integer |
Protection status:
Enumeration values:
|
access_status |
Integer |
Access status:
Enumeration values:
|
create_time |
Long |
Time when a domain name was created. The value is a 13-digit timestamp. |
block_page |
WafBlockPage object |
Alarm page configuration. |
traffic_mark |
WafTrafficMark object |
Traffic identifier. |
flag |
Flag object |
Special domain name tag. |
extend |
Map<String,String> |
Extensible attribute of the domain name. |
is_added |
Boolean |
Whether a domain name is an anti-DDoS domain name. Default: false |
Parameter |
Type |
Description |
---|---|---|
template |
String |
Blocking template name |
custom_page |
WafCustomPage object |
User-defined blocking page |
redirect_url |
String |
Redirection URL |
Parameter |
Type |
Description |
---|---|---|
status_code |
String |
Status code |
content_type |
String |
Content type of alarm page |
content |
String |
Page content Minimum: 1 Maximum: 4096 |
Parameter |
Type |
Description |
---|---|---|
sip |
Array of strings |
IP address in the known attack source rule |
cookie |
String |
cookie Minimum: 1 Maximum: 4096 |
params |
String |
Parameter Minimum: 1 Maximum: 4096 |
Parameter |
Type |
Description |
---|---|---|
pci_3ds |
String |
Whether to enable PCI 3DS compliance certification.
Enumeration values:
|
pci_dss |
String |
Whether to enable PCI DSS compliance certification.
Enumeration values:
|
cname |
String |
old: The old CNAME record is used. new: new CNAME record is used. Enumeration values:
|
is_dual_az |
String |
Whether IPv6 is enabled for the domain name.
Enumeration values:
|
ipv6 |
String |
Whether IPv6 is enabled for the domain name.
Enumeration values:
|
Status code: 400
Parameter |
Type |
Description |
---|---|---|
error_code |
String |
Error code. |
error_msg |
String |
Error message. |
Status code: 401
Parameter |
Type |
Description |
---|---|---|
error_code |
String |
Error code. |
error_msg |
String |
Error message. |
Status code: 500
Parameter |
Type |
Description |
---|---|---|
error_code |
String |
Error code. |
error_msg |
String |
Error message. |
Example Requests
Query details about domain names protected by WAF.
GET https://{Endpoint}/v1/edgewaf/domains/1771a426afcc4e16b8636cb72c2d53e4
Example Responses
Status code: 200
Request succeeded.
{ "id" : "095b60b21ac248579426f97379b3fbec", "domain_name" : "domain_name", "enterprise_project_id" : 0, "tenant_id" : "090f4899f400d33c0f17c00d4c8435e0", "open_time" : 1691478912415, "dispatch_status" : 3, "service_area" : "outside_mainland_china", "web_tag" : "domain_name", "description" : "example", "policy_id" : "1771a426afcc4e16b8636cb72c2d53e4", "protocol" : "https", "certificate_id" : "3e9df5da33744bae90bf73291c6e5c6c", "certificate_name" : "example", "tls" : "TLS v1.0", "cipher" : "cipher_1", "protect_status" : 1, "access_status" : 0, "is_added" : false }
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.
Feedback
Was this page helpful?
Provide feedbackThank you very much for your feedback. We will continue working to improve the documentation.See the reply and handling status in My Cloud VOC.
For any further questions, feel free to contact us through the chatbot.
Chatbot