Querying a Web Tamper Protection Rule
Function
This API is used to query a web tamper protection rule.
URI
GET /v1/{project_id}/waf/policy/{policy_id}/antitamper/{rule_id}
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
project_id |
Yes |
String |
Project ID. To obtain it, go to Cloud management console and hover the cursor over your username. On the displayed window, choose My Credentials.Then, in the Projects area, view Project ID of the corresponding project. |
policy_id |
Yes |
String |
Policy ID. It can be obtained by calling the ListPolicy API. |
rule_id |
Yes |
String |
ID of the anti-tamper rule. It can be obtained by calling the ListAntitamperRule API. |
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
enterprise_project_id |
No |
String |
You can obtain the ID by calling the ListEnterpriseProject API of 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). |
Content-Type |
Yes |
String |
Content type. Default: application/json;charset=utf8 |
Response Parameters
Status code: 200
Parameter |
Type |
Description |
---|---|---|
id |
String |
Rule ID. |
policyid |
String |
Policy ID. |
hostname |
String |
Domain name protected by the web tamper protection rule |
url |
String |
URL protected by the web tamper protection rule |
description |
String |
Timestamp the rule is created. |
status |
Integer |
Rule status. The value can be 0 or 1.
|
timestamp |
Long |
Timestamp the rule is created. |
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
The following example shows how to query a web tamper protection rule. The project ID is specified by project_id, the policy ID is specified by policy_id, and the rule ID is specified by rule_id.
GET https://{Endpoint}/v1/{project_id}/waf/policy/{policy_id}/antitamper/{rule_id}?enterprise_project_id=0
Example Responses
Status code: 200
Request sent.
{ "id" : "b77c3182957b46ed8f808a1998245cc4", "policyid" : "bdba8e224cbd4d11915f244c991d1720", "timestamp" : 1647499571037, "description" : "", "status" : 0, "hostname" : "www.demo.com", "url" : "/sdf" }
Status Codes
Status Code |
Description |
---|---|
200 |
Request sent. |
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.