DescribeProtectDirList

Last Updated At: 2026-08-02 00:04:57

1. Interface Description

Interface request domain name: cwp.api3.convergecloud.com.

This API is used to query the protected directory list in the web page anti-tampering module.

Default interface request rate limit: 20 times per second.

Interface update time: 2022-05-20 15:13:13.

The interface is both signature verification and authentication.

2. Input Parameters

The following list of request parameters only lists interface request parameters and some public parameters, For a complete list of public parameters see public request parameters.

Parameter name Required Allow NULL Type Description
Action Yes No String Public parameter, The value of this interface: DescribeProtectDirList
Version Yes No String Public parameter, The value of this interface: 2018-02-28
Region No No String Public parameter,Regional information This interface does not need to pass this parameter.
By No No String Sorting field. Valid values: ProtectServerNum, NoProtectServerNum, LatestProtectTime, and RelatedServerNum.
Example: ProtectServerNum
Filters No No Array of AssetFilters DirName: website name.
DirPath: protected website directory.
Example:View
Limit Yes No Uint64 Maximum number of entries to return on each page. Maximum value: 100.
Example: 10
Offset Yes No Uint64 Offset.
Example: 1
Order No No String Sorting order. asc: ascending order. desc: descending order.
Example: asc

3. Output Parameters

Parameter name Type Description
List Array of ProtectDirInfo Information about protected directories.
Example:View
TotalCount Uint64 Total number.
Example: 1
RequestId String Unique request id, Each request will return. The RequestId of the request needs to be provided when locating the problem.

4. Error Code

The following lists only the error codes related to the interface business logic, For other error codes, see public ErrorCode.

Error Code Description
InternalError Internal error.
InvalidParameter.MissingParameter Missing parameter.
InvalidParameter.InvalidFormat Incorrect parameter format.
MissingParameter Missing parameter.
InvalidParameter.IllegalRequest Invalid request.
InvalidParameter Invalid parameter.
InvalidParameterValue The parameter value is invalid.