DescribeSearchTemplates

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

1. Interface Description

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

API for querying a list of quick searches

Default interface request rate limit: 20 times per second.

Interface update time: 2023-02-09 16:57:20.

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: DescribeSearchTemplates
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.
Limit No No Uint64 Number of items returned. The default value is 10, and the maximum value is 100.
Example: 10
Offset No No Uint64 Offset. Default value: 0.
Example: 0

3. Output Parameters

Parameter name Type Description
List Array of SearchTemplate Template list
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.
MissingParameter Missing parameter.
InvalidParameter Invalid parameter.
InvalidParameterValue The parameter value is invalid.