DescribeComponentStatistics

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

1. Interface Description

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

This API is used to get the component statistics list.

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: DescribeComponentStatistics
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.
Filters No No Array of Filter Filter condition.
ComponentName - String - Required: No - Component name.
Example:View
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
ComponentStatistics Array of ComponentStatistics Component statistics.
Example:View
TotalCount Uint64 Total number of records in the component statistics list.
Example: 100
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.ParsingError Parameter parsing error.
InvalidParameter.InvalidFormat Incorrect parameter format.
MissingParameter Missing parameter.
InvalidParameter.IllegalRequest Invalid request.
InvalidParameter Invalid parameter.
InvalidParameterValue The parameter value is invalid.