Tenant Cloud Security Cloud Workload Protection Platform Asset Management APIs DescribeComponents

DescribeComponents

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 obtain the list of components.

Default interface request rate limit: 20 times per second.

Interface update time: 0001-01-01 00:00:00.

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: DescribeComponents
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.
ComponentId No No Uint64 Component ID. You must specify either Uuid or ComponentId. If you configure the ComponentId parameter, the information about the specified component will be queried.
Example: 1
Filters No No Array of Filter Filter condition.
  • ComponentVersion - String - Required: No - Version number of the component.
  • MachineIp - String - Required: No - Private IP of the server.

    • 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
    Uuid No No String Unique UUID of the CWP client. You must specify either Uuid or ComponentId. If you configure the Uuid parameter, the information about the components on the specified server will be queried.
    Example: 5a540076-d38a-4078-aa98-qwert371d322

    3. Output Parameters

    Parameter name Type Description
    Components Array of Component Component list data.
    Example:View
    TotalCount Uint64 Total number of records in the component list.
    Example: 0
    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.
    ResourceNotFound The resource does not exist.
    InvalidParameter Invalid parameter.
    OperationDenied Operation denied.
    InvalidParameterValue The parameter value is invalid.