Last updated: 2021-08-06 16:41:07

1. API Description

Domain name for API request:

This API is used to query sub-users.

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 parameter. The value used for this API: GetUser.
Version Yes String Common parameter. The value used for this API: 2019-01-16.
Region No String Common parameter. This parameter is not required for this API.
Name Yes String Sub-user username

3. Output Parameters

Parameter Name Type Description
Uin Integer Sub-user UIN
Name String Sub-user username
Uid Integer Sub-user UID
Remark String Sub-user remarks
ConsoleLogin Integer If sub-user can log in to the Console
PhoneNum String Mobile number
CountryCode String Country/Area code
Email String Email
RequestId String The unique request ID, which is returned for each request. RequestId is required for locating a problem.

4. Example

Example1 Querying sub-user

Input Example
&<Common request parameters>

Output Example

  "Response": {
    "Uin": 100000546533,
    "Name": "test124",
    "Uid": 1001774,
    "Remark": "test",
    "ConsoleLogin": 1,
    "PhoneNum": "10086",
    "CountryCode": "86",
    "Email": "",
    "RequestId": "33674182-e53d-416b-b6ce-bd7e7536b5d6"

5. Developer Resources


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.
ResourceNotFound.UserNotExist User does not exist.