DescribeClientException

Last Updated At: 2026-08-03 00:04:49

1. Interface Description

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

Obtain Client Exception Events

Default interface request rate limit: 20 times per second.

Interface update time: 2022-11-16 10:43:36.

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: DescribeClientException
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.
EndTime No No String End time in the format of 2006-01-02 15:04:05
Example: 2006-01-02 15:04:05
ExceptionType Yes No Int64 Client Exception Type 1: Client Offline, 2: Client Uninstallation
Example: 1
Limit Yes No Uint64 Limit per Page, not 0, up to 100
Example: 10
Offset Yes No Uint64 Paging Offset
Example: 0
StartTime No No String Start time in the format of 2006-01-02 15:04:05
Example: 2006-01-02 15:04:05

3. Output Parameters

Parameter name Type Description
Records Array of RecordInfo Event details.
Example:View
TotalCount Uint64 Total Number of Events
Example: 944
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

There is no error code related to business logic for this interface, For other error codes, see public ErrorCode.