Tenant Cloud Security Cloud Workload Protection Platform Other APIs DescribeAssetEnvList

DescribeAssetEnvList

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

1. Interface Description

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

API for querying environment variables in the asset management module

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: DescribeAssetEnvList
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 value: FirstTime.
Example: FirstTime
Filters No No Array of AssetFilters Filter conditions.
  • MachineName - String - Required: No - Host alias for filtering.
  • IP - String - Required: No - Host IP address for filtering.
  • InstanceID - String - Required: No - Host instance ID for filtering.
  • User - String - Required: No - User.
  • Name - String - Required: No - Environment variable name.
  • Type - Int - Required: No - Type. 0: user variable; 1: system variable.

    • Example:View
    Limit No No Uint64 Number of items to be returned. The default value is 10, and the maximum value is 100.
    Example: 10
    Offset No No Uint64 Offset. Default value: 0.
    Example: 1
    Order No No String Sorting order. asc: ascending order. desc: descending order.
    Example: desc
    Quuid No No String QUUID of the server.
    Example: 1c26308c-5493-4eaf-a817-112ec25f499e
    Type No No Uint64 Deprecated parameter, which is replaced with Filters.
    Example: 1
    Uuid No No String Server UUID.
    Example: 1c26308c-5493-4eaf-a817-112ec25f499e

    3. Output Parameters

    Parameter name Type Description
    Envs Array of AssetEnvBaseInfo List
    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.