Tenant Cloud Security Cloud Workload Protection Platform Asset Management APIs DescribeAssetAppList

DescribeAssetAppList

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

1. Interface Description

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

API for querying the application list

Default interface request rate limit: 20 times per second.

Interface update time: 2022-09-28 15:55:30.

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: DescribeAssetAppList
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 Field for sorting. Valid values: FirstTime and ProcessCount.
Example: FirstTime
Filters No No Array of AssetFilters Filter conditions.
  • AppName - String - Required: No - Application name for search.
  • IP - String - Required: No - Host IP address.
  • MachineName - String - Required: No - Host name.
  • InstanceID - String - Required: No - Instance ID.
  • Type - Int - Required: No - Type. Only Linux applications are supported.
    0: all
    1: Ops
    2: database
    3: security
    4: suspicious application
    5: system architecture
    6: system application
    7: web service
    99: others
  • OsType - String - Required: No - Windows or Linux.
  • OsName - String - Required: No - Operating system name (Value returned by the DescribeMachineOsList API).

    • Example:View
    Limit No No Uint64 Number of items to be returned. The default value is 10, and the maximum value is 100.
    Example: 1
    Offset No No Uint64 Offset. Default value: 0.
    Example: 1
    Order No No String Sorting order. asc: ascending order. desc: descending order.
    Example: asc
    Quuid No No String QUUID of the server.
    Example: 24c9be55-c743-4a75-a5c7-2a2936843684

    3. Output Parameters

    Parameter name Type Description
    Apps Array of AssetAppBaseInfo Application list API
    Example:View
    Total Uint64 Total number.
    Example: 1021
    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.MissingParameter Missing parameter.
    InvalidParameter.InvalidFormat Incorrect parameter format.
    MissingParameter Missing parameter.
    ResourceNotFound The resource does not exist.
    InvalidParameter Invalid parameter.
    InvalidParameterValue The parameter value is invalid.