tencent cloud

PrevNext

Feedback

search by keyword

Recent Pages

Documentation
Documentation

DescribeUserList

Last updated: 2024-08-23 18:05:51

1. API Description

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

This API is used to query the user 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: DescribeUserList.
Version Yes String Common Params. The value used for this API: 2024-08-01.
Region Yes String Common Params. For more information, please see the list of regions supported by the product.
Offset Yes Integer Page offset
Limit Yes Integer Number of results per page
PlatformId Yes String Platform ID
Keyword No String Keywords for search (username or account)
AccountType No Integer User account 1 - Super Admin 2 - Platform Admin 3 - Ordinary member
TeamId No String Team ID

3. Output Parameters

Parameter Name Type Description
Data DescribeUserListResp Response data
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 DescribeUserList

Input Example

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

{
    "Keyword": "",
    "Limit": 10,
    "Offset": 0,
    "AccountType": 0,
    "TeamId": "0",
    "PlatformId": "T04257DS9431720WTAG"
}

Output Example

{
    "Response": {
        "Data": {
            "TotalCount": 10,
            "DataList": [
                {
                    "UserId": "U20240819174742HGXHXT",
                    "UserAccount": "OpenApiUser0819174740",
                    "UserName": "OpenApiUser0819174740",
                    "TeamName": "",
                    "Status": 1,
                    "AccountType": 3,
                    "CreateTime": "1724060862"
                },
                {
                    "UserId": "U20240819170247WSBYNR",
                    "UserAccount": "OpenApiUser0819170245",
                    "UserName": "12313",
                    "TeamName": "",
                    "Status": 1,
                    "AccountType": 3,
                    "CreateTime": "1724058167"
                },
                {
                    "UserId": "U20240819140751NLQQBP",
                    "UserAccount": "eric1",
                    "UserName": "eric1",
                    "TeamName": "eric_mini_team,eric_app_team",
                    "Status": 1,
                    "AccountType": 3,
                    "CreateTime": "1724047671"
                },
                {
                    "UserId": "U20240819115645WTLQND",
                    "UserAccount": "vinya",
                    "UserName": "vinya",
                    "TeamName": "vinya_mini,vinya_app",
                    "Status": 1,
                    "AccountType": 3,
                    "CreateTime": "1724039805"
                },
                {
                    "UserId": "U20240819113830AMQYEH",
                    "UserAccount": "eric_test",
                    "UserName": "eric_test",
                    "TeamName": "",
                    "Status": 1,
                    "AccountType": 2,
                    "CreateTime": "1724038710"
                },
                {
                    "UserId": "U20240819113604EESVUF",
                    "UserAccount": "vinya_plat",
                    "UserName": "vinya_plat",
                    "TeamName": "",
                    "Status": 1,
                    "AccountType": 2,
                    "CreateTime": "1724038564"
                },
                {
                    "UserId": "U20240814102554KKJOOF",
                    "UserAccount": "ela_platform",
                    "UserName": "ela_platform",
                    "TeamName": "",
                    "Status": 1,
                    "AccountType": 2,
                    "CreateTime": "1723602354"
                },
                {
                    "UserId": "U20240801192820CVRUBH",
                    "UserAccount": "jadentest009",
                    "UserName": "jadentest009",
                    "TeamName": "test",
                    "Status": 1,
                    "AccountType": 4,
                    "CreateTime": "1722511700"
                },
                {
                    "UserId": "U20240801145857JOWJCJ",
                    "UserAccount": "jaden",
                    "UserName": "jaden",
                    "TeamName": "",
                    "Status": 1,
                    "AccountType": 2,
                    "CreateTime": "1722495537"
                },
                {
                    "UserId": "U20240729223443LLXRFS",
                    "UserAccount": "vinya_test006",
                    "UserName": "vinya_test006",
                    "TeamName": "autotest_app_team",
                    "Status": 1,
                    "AccountType": 3,
                    "CreateTime": "1722263683"
                }
            ]
        },
        "RequestId": "ef3d028d-d74f-4764-a980-f71b867dcd89"
    }
}

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
FailedOperation Operation failed.
FailedOperation.PackageAlreadyExpired The TCMPP plan under the current account has expired.
InternalError Internal error
InvalidParameterValue Invalid parameter value.
InvalidParameterValue.InvalidAccountType Invalid account type
InvalidParameterValue.InvalidPlatformId Invalid platform ID
InvalidParameterValue.InvalidTeamId Invalid team ID
Copyright © 2013-2024 Tencent Cloud. All Rights Reserved.
Privacy PolicyLegalCookie Policy