Tenant Cloud Security Cloud Workload Protection Platform Asset Management APIs DescribeAssetUserList

DescribeAssetUserList

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

1. Interface Description

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

API for getting the account 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: DescribeAssetUserList
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 Optional sorting method: [FirstTime
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 - Account name (fuzzy match).
  • NameStrict - String - Required: No - Account name (exact match).
  • Uid - UInt64 - Required: No - Uid.
  • Gid - UInt64 - Required: No - GID.
  • LoginTimeStart - String - Required: No - Start time. For example, 2021-01-11.
  • LoginTimeEnd - String - Required: No - End time. For example, 2021-01-11.
  • LoginType - UInt64 - Required: No - 0: login not supported; 1: key-based login only; 2: password-based login only; 3: key-based and password-based login (Linux only).
  • OsType - String - Required: No - Windows or Linux.
  • Status - UInt64 - Required: No - Account status. 0: disabled; 1: enabled.
  • UserType - UInt64 - Required: No - Account type. 0: guest user; 1: standard user; 2: admin user (Windows only).
  • IsDomain - UInt64 - Required: No - Whether the account is a domain account. 0: no; 1: yes (Windows only).
  • IsRoot - UInt64 - Required: No - Whether the permission is root permission. 0: no; 1: yes (Linux only).
  • IsSudo - UInt64 - Required: No - Whether the permission is Sudo permission. 0: no; 1: yes (Linux only).
  • IsSshLogin -UInt64 - Required: No - Whether SSH login is used. 0: no; 1: yes (Linux only).
  • ShellLoginStatus - UInt64 - Required: No - Whether shell login is used. 0: no; 1: yes (Linux only).
  • PasswordStatus - UInt64 - Required: No - Password status. 1: normal; 2: about to expire; 3: expired; 4: locked (Linux only).
  • 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: 1

    3. Output Parameters

    Parameter name Type Description
    Total Uint64 Total number of records.
    Example: 1
    Users Array of AssetUserBaseInfo Account list.
    Example:View
    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.DateRange The time range format is incorrect.
    InvalidParameter Invalid parameter.
    InvalidParameterValue The parameter value is invalid.