tencent cloud

Feedback

ExportAssetUserList

Last updated: 2024-08-27 11:43:29

1. API Description

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

This API is used to export the account list.

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: ExportAssetUserList.
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 information of a specified QUUID host
Filters.N No Array of Filter Filter criteria
  • Name - String - whether required: no - account name
  • Uid - uint64 - whether required: no - Uid
  • Guid - uint64 - whether required: no - Guid
  • LoginTimeStart - String - whether required: no - start time, such as 2021-01-11
  • LoginTimeEnd - String - whether required: no - end time, such as 2021-01-11
  • LoginType - uint64 - whether 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 - whether required: no - Windows or Linux
  • Status - uint64 - whether required: no - account status: 0 - disabled; 1 - enabled
  • Type - uint64 - whether required: no - account type: 0 - guest user; 1 - standard user; 2 - administrator user (Windows Only)
  • IsDomain - uint64 - whether required: no - whether a domain account: 0 - no; 1 - yes (Windows only)
  • IsRoot - uint64 - whether required: no - whether there is root permission: 0 - no; 1 - yes (Linux only)
  • IsSudo - uint64 - whether required: no - whether there is sudo permission: 0 - no; 1 - yes (Linux only)
  • IsSshLogin - uint64 - whether required: no - whether to use ssh log-in: 0 - no; 1 - yes (Linux only)
  • ShellLoginStatus - uint64 - whether required: no - whether to use shell log-in: 0 - no; 1 - yes (Linux only)
  • PasswordStatus - uint64 - whether required: no - password status: 1 - normal; 2 - expiring soon; 3 - expired; 4 - locked (Linux only)
  • Order No String Sorting method: asc for ascending order or desc for descending order
    By No String Optional sorting method: [FirstTime|LoginTime|ChangePasswordTime|PasswordDuaTime]
    PasswordLockDays

    3. Output Parameters

    Parameter Name Type Description
    TaskId String ID of asynchronous download task. It is used together with ExportTasks API.
    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 Exporting the Account List

    Input Example

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

    Output Example

    {
        "Response": {
            "RequestId": "xx",
            "TaskId": "xx"
        }
    }
    

    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
    InternalError.MainDBFail Failed to manipulate the data.
    InvalidParameter Incorrect parameter.
    InvalidParameter.DateRange Incorrect time range format.