tencent cloud

PrevNext

Feedback

search by keyword

Recent Pages

Documentation
Documentation

DescribeAssetUserList

Last updated: 2024-08-27 11:44:23

1. API Description

Domain name for API request: cwp.tencentcloudapi.com.

This API is used to obtain the list of accounts.

A maximum of 20 requests can be initiated per second for this API.

We recommend you to use API Explorer
Try it
API Explorer provides a range of capabilities, including online call, signature authentication, SDK code generation, and API quick search. It enables you to view the request, response, and auto-generated examples.

2. Input Parameters

The following request parameter list only provides API request parameters and some common parameters. For the complete common parameter list, see Common Request Parameters.

Parameter Name Required Type Description
Action Yes String Common Params. The value used for this API: DescribeAssetUserList.
Version Yes String Common Params. The value used for this API: 2018-02-28.
Region No String Common Params. This parameter is not required.
Quuid No String Query the information on the host with the specified QUUID
Filters.N No Array of Filter Filter criteria
  • 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 (strict match)
  • Uid - uint64 - required: no - UID
  • Guid - uint64 - required: no - GUID
  • LoginTimeStart - String - required: no - start time, such as 2021-01-11
  • LoginTimeEnd - String - required: no - end time, such as 2021-01-11
  • LoginType - uint64 - required: no - 0 - not allowed to log in; 1 - only key-based log-in allowed; 2 - only password-based log-in allowed; 3 - both key-based and password-based log-in allowed (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 - administrator user (Windows Only)
  • IsDomain - uint64 - required: no - whether a domain account: 0 - no; 1 - yes (Windows only)
  • IsRoot - uint64 - required: no - whether there is root permission: 0 - no; 1 - yes (Linux only)
  • IsSudo - uint64 - required: no - whether there is sudo permission: 0 - no; 1 - yes (Linux only)
  • IsSshLogin - uint64 - required: no - whether to use SSH log-in: 0 - no; 1 - yes (Linux only)
  • ShellLoginStatus - uint64 - required: no - whether to use Shell log-in: 0 - no; 1 - yes (Linux only)
  • PasswordStatus - uint64 - required: no - password status: 1 - normal; 2 - expiring soon; 3 - expired; 4 - locked (Linux only)
  • Os -String required: no - operating system (the value of DescribeMachineOsList API)
    		•
    Limit No Integer Number of items to be returned. It is 10 by default, and the maximum value is 100.
    Offset No Integer Offset, which is 0 by default.
    Order No String Sorting method: asc for ascending order or desc for descending order
    By No String Optional sorting method: [FirstTime|LoginTime|PasswordChangeTime|PasswordDuaTime|PasswordLockDays]

    3. Output Parameters

    Parameter Name Type Description
    Total Integer Total number of records
    Users Array of AssetUserBaseInfo Account list
    Note: This field may return null, indicating that no valid values can be obtained.
    RequestId String The unique request ID, generated by the server, will be returned for every request (if the request fails to reach the server for other reasons, the request will not obtain a RequestId). RequestId is required for locating a problem.

    4. Example

    Example1 Obtaining an Account List

    Input Example

    POST / HTTP/1.1
Host: cwp.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeAssetUserList
<Common request parameters>

{}

    Output Example

    {
    "Response": {
        "Total": 1,
        "Users": [
            {
                "MachineIp": "abc",
                "MachineWanIp": "abc",
                "MachineName": "abc",
                "OsInfo": "abc",
                "Uuid": "abc",
                "Quuid": "abc",
                "Uid": "abc",
                "Gid": "abc",
                "Status": 1,
                "IsRoot": 1,
                "LoginType": 1,
                "LastLoginTime": "abc",
                "Name": "abc",
                "ProjectId": 1,
                "UserType": 1,
                "IsDomain": 1,
                "IsSudo": 1,
                "IsSshLogin": 1,
                "HomePath": "abc",
                "Shell": "abc",
                "ShellLoginStatus": 1,
                "PasswordChangeTime": "abc",
                "PasswordDueTime": "abc",
                "PasswordLockDays": 0,
                "PasswordStatus": 0,
                "UpdateTime": "abc",
                "FirstTime": "abc",
                "IsNew": 0,
                "MachineExtraInfo": {
                    "WanIP": "abc",
                    "PrivateIP": "abc",
                    "NetworkType": 0,
                    "NetworkName": "abc",
                    "InstanceID": "abc",
                    "HostName": "abc"
                }
            }
        ],
        "RequestId": "abc"
    }
}

    5. Developer Resources

    SDK

    TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to call APIs.

    Command Line Interface

    6. Error Code

    The following only lists the error codes related to the API business logic. For other error codes, see Common Error Codes.

    Error Code Description
    InternalError Internal error
    InvalidParameter Incorrect parameter.
    InvalidParameter.DateRange Incorrect time range format.
    InvalidParameter.ParsingError Incorrect parameter parsing.
    InvalidParameterValue Invalid parameter value.
    Copyright © 2013-2024 Tencent Cloud. All Rights Reserved.
    Privacy PolicyLegalCookie Policy