Get Anti-Tampering Page List - DescribeAssurancePages
Overview
Get Anti-Tampering Page List
Definition
Public Parameters
Parameter Name | Type | Description Information | Required |
---|---|---|---|
Action | string | Corresponding API command name, the current API is DescribeAssurancePages . | Yes |
PublicKey | string | The user's public key can be obtained from Console (opens in a new tab) | Yes |
Signature | string | User signature generated based on public key and API command, see Signature Algorithm | Yes |
Request Parameters
Parameter Name | Type | Description Information | Required |
---|---|---|---|
ProjectId | string | Project ID. If not filled in, the default project is used, sub-accounts must be filled in. Please refer to the GetProjectList interface. | No |
Domain | string | Domain to be obtained | Yes |
Response Field
Field Name | Type | Description Information | Required |
---|---|---|---|
RetCode | int | Return status code. If it is 0, it means successful return. If it is not 0, it means failure. | Yes |
Action | string | Operation command name. | Yes |
Message | string | Returns an error message, providing detailed description when RetCode is non-zero. | No |
Res | AssurancePages | Anti-tampering information, refer to AssurancePages | No |
Data Model
AssurancePages
Field Name | Type | Description Information | Required |
---|---|---|---|
State | string | UGuard Global Status | Yes |
TotalCount | int | Total number of tamper-proof configurations | Yes |
Limit | int | Anti-Tampering Rule Quota | Yes |
Items | array[AssuracePagesDetail] | Tamper-proof rule list, refer to AssuracePagesDetail | Yes |
AssuracePagesDetail
Field Name | Type | Description Information | Required |
---|---|---|---|
Id | int | Anti-Tampering Rule ID | Yes |
Url | string | Anti-tampering page URL | Yes |
State | string | Protection Status | Yes |
Remark | string | Note Information | No |
Example
Request Example
https://api.surfercloud.com/?Action=DescribeAssurancePages
&ProjectId=org-xxx
&Domain=www.test.com
Response Example
{
"Action": "DescribeAssurancePagesResponse",
"Res": {
"Items": [
{
"Id": 368,
"Remark": "q",
"State": "on",
"Url": "http://www.test.com/inedx.html"
}
],
"Limit": 19,
"State": "off",
"TotalCount": 1
},
"RetCode": 0
}