Tenant Cloud Security Cloud Workload Protection Platform Asset Management APIs DescribeAssetWebLocationList

DescribeAssetWebLocationList

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

1. Interface Description

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

API for getting the list of web sites

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: DescribeAssetWebLocationList
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 PathCount.
Example: PathCount
Filters No No Array of Filter Filter conditions.
  • IP - String - Required: No - Host IP address.
  • MachineName - String - Required: No - Host name.
  • InstanceID - String - Required: No - Instance ID.
  • Name - String - Required: No - Domain name.
  • User - String - Required: No - Corresponding user.
  • Port - UInt64 - Required: No - Site port.
  • Proto - UInt64 - Required: No - Site protocol. 1: HTTP; 2: HTTPS.
  • ServiceType - UInt64 - Required: No - Service type.
    1: Tomcat
    2: Apache
    3: Nginx
    4: WebLogic
    5: Websphere
    6: JBoss
    7: WildFly
    8: Jetty
    9: IHS
    10: Tengine
  • 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: 10
    Offset No No Uint64 Offset. Default value: 0.
    Example: 12
    Order No No String Sorting order. asc: ascending order. desc: descending order.
    Example: asc
    Quuid No No String QUUID of the server.
    Example: acdd5474-6360-4fd4-bfc7-843162cb8116

    3. Output Parameters

    Parameter name Type Description
    Locations Array of AssetWebLocationBaseInfo List of websites.
    Example:View
    Total Uint64 Total number of records.
    Example: 12
    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.
    InvalidParameter Invalid parameter.
    InvalidParameterValue The parameter value is invalid.