tencent cloud

APIs

DocumentaçãoAPIsCloud Access ManagementUser APIsListAccounts

ListAccounts

Baixar
Modo Foco
Tamanho da Fonte
Última atualização: 2026-11-04 16:36:41

1. API Description

Domain name for API request: cam.intl.tencentcloudapi.com.

Query all account lists.

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: ListAccounts.
Version Yes String Common Params. The value used for this API: 2019-01-16.
Region No String Common Params. This parameter is not required.
MaxItems No Integer

Number of returned results. If the returned results are truncated after reaching the MaxItems limit, the response parameter IsTruncated will be equal to true.

Value range: [1, 100]
Marker No String

When the return result of the request is truncated, you can use Marker to get the content after the current truncation position.
UserType No String

Type of user

Enumeration values:

  • Owner: root account
  • SubUser: ordinary sub-user
  • CICUser: CIC sub-user
  • WechatCorpUser: WeCom sub-user
  • AgentIdentity: AgentIdentity sub-user
  • Collaborator: collaborator
  • MessageReceiver: message recipient

3. Output Parameters

Parameter Name Type Description
Users Array of ListAllUser

Sub-account list.
Marker String

This field is returned only when IsTruncated is true. If it returns true, you need to continue to call this API and use Marker to get the truncated content.
IsTruncated Boolean

Whether the returned result of the request is truncated.
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 Retrieving the sub-account list of all types

Get the sub-account list of all types

Input Example

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

{}

Output Example

{
    "Response": {
        "IsTruncated": false,
        "Marker": "",
        "Users": [
            {
                "ConsoleLogin": 1,
                "CountryCode": "86",
                "CreateTime": "2022-11-23 17:07:28",
                "Email": "gavi*******@tencent.com",
                "Name": "gavi*******@tencent.com",
                "PhoneNum": "132****0828",
                "Remark": "",
                "Uid": 906949110,
                "Uin": 0,
                "UserType": "Owner"
            }
        ],
        "RequestId": "e89738b3-7eb3-46fe-be37-7d3210625d78"
    }
}

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
InvalidParameter Parameter error.
InvalidParameter.PaginationTokenInvalid Invalid pageToken.
Anterior: GetUserPróximo: AttachGroupPolicy

Ajuda e Suporte

Esta página foi útil?

comentários

Search
    Enter keywords to search documentation