tencent cloud

All product documents
APIs
DocumentationAPIs
DescribeUsersForUserManager
Last updated: 2024-01-09 10:47:26
DescribeUsersForUserManager
Last updated: 2024-01-09 10:47:26

1. API Description

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

This API is available for clusters with OpenLDAP components configured.
This API is used to export users in batches. For a Kerberos cluster, set NeedKeytabInfo to true to obtain the download link of the Keytab file. If SupportDownLoadKeyTab is true, but DownLoadKeyTabUrl is null, the Keytab file is not ready yet (being generated) in the backend.

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: DescribeUsersForUserManager.
Version Yes String Common Params. The value used for this API: 2019-01-03.
Region No String Common Params. This parameter is not required for this API.
InstanceId Yes String Cluster instance ID
PageNo Yes Integer Page number
PageSize Yes Integer Page size
UserManagerFilter No UserManagerFilter User list query filter
NeedKeytabInfo No Boolean Whether the Keytab file information is required. This field is only valid for clusters with Kerberos enabled and defaults to false.

3. Output Parameters

Parameter Name Type Description
TotalCnt Integer Total number
UserManagerUserList Array of UserManagerUserBriefInfo User information list
Note: This field may return null, indicating that no valid value can be obtained.
RequestId String The unique request ID, which is returned for each request. RequestId is required for locating a problem.

4. Example

Example1 test

Input Example

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

{
    "InstanceId": "xx",
    "UserManagerFilter": {
        "UserName": "xx"
    },
    "PageSize": 0,
    "PageNo": 0,
    "NeedKeytabInfo": true
}

Output Example

{
    "Response": {
        "RequestId": "782d3570-9f82-4bff-974a-17cf684fdfe9",
        "TotalCnt": 4,
        "UserManagerUserList": [
            {
                "CreateTime": "2022-05-12 17:40:23",
                "DownLoadKeyTabUrl": "",
                "SupportDownLoadKeyTab": true,
                "UserGroup": "test4",
                "UserName": "test4",
                "UserType": "NormalUser"
            },
            {
                "CreateTime": "2022-05-12 17:40:23",
                "DownLoadKeyTabUrl": "",
                "SupportDownLoadKeyTab": true,
                "UserGroup": "test3",
                "UserName": "test3",
                "UserType": "NormalUser"
            },
            {
                "CreateTime": "2022-05-12 17:40:23",
                "DownLoadKeyTabUrl": "https://cosulr/cluster/test2.keytab",
                "SupportDownLoadKeyTab": true,
                "UserGroup": "test2",
                "UserName": "test2",
                "UserType": "NormalUser"
            },
            {
                "CreateTime": "2022-05-12 17:40:23",
                "DownLoadKeyTabUrl": "https://cosulr/cluster/test1.keytab",
                "SupportDownLoadKeyTab": true,
                "UserGroup": "test1",
                "UserName": "test1",
                "UserType": "NormalUser"
            }
        ]
    }
}

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.InvalidInstanceName Invalid cluster name.
ResourceNotFound.ClusterNotFound The instance was not found.
ResourceNotFound.InstanceNotFound The instance was not found.
UnauthorizedOperation.CheckCamAuth Unauthorized operation.
Was this page helpful?
You can also Contact Sales or Submit a Ticket for help.
Yes
No

Feedback

Contact Us

Contact our sales team or business advisors to help your business.

Contact Us
Technical Support

Open a ticket if you're looking for further assistance. Our Ticket is 7x24 avaliable.

Submit a Ticket
7x24 Phone Support
Hong Kong, China
+852 800 906 020 (Toll Free)
United States
+1 844 606 0804 (Toll Free)
United Kingdom
+44 808 196 4551 (Toll Free)
Canada
+1 888 605 7930 (Toll Free)
Australia
+61 1300 986 386 (Toll Free)
EdgeOne hotline
+852 300 80699
More local hotlines coming soon