Domain name for API request: emr.intl.tencentcloudapi.com.
This API is used for clusters with the OpenLDAP component installed.
This API is used to export users in batches. For a Kerberos cluster, if the keytab file download link is required, set NeedKeytabInfo to true. Note: If SupportDownLoadKeyTab is set to true but DownLoadKeyTabUrl is an empty string, the keytab file is not ready (being generated).
A maximum of 20 requests can be initiated per second for this API.
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 | Yes | String | Common Params. For more information, please see the list of regions supported by the product. |
| InstanceId | Yes | String | Cluster ID. |
| PageNo | Yes | Integer | Page number. |
| PageSize | Yes | Integer | Number of entries per page. All records are queried by default. If the PageNo and PageSize settings are inappropriate, all records are queried. |
| UserManagerFilter | No | UserManagerFilter | User list filter. |
| NeedKeytabInfo | No | Boolean | Whether keytab file information is needed, only effective for clusters with Kerberos enabled. The default value is false. |
| Parameter Name | Type | Description |
|---|---|---|
| TotalCnt | Integer | Total number. |
| UserManagerUserList | Array of UserManagerUserBriefInfo | User information list. |
| 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. |
POST / HTTP/1.1
Host: emr.intl.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeUsersForUserManager
<Common request parameters>
{
"InstanceId": "emr-jnyiihlc",
"UserManagerFilter": {
"UserName": "sam"
},
"PageSize": 0,
"PageNo": 0,
"NeedKeytabInfo": true
}{
"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"
}
]
}
}TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to call APIs.
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 cannot be found. |
| ResourceNotFound.InstanceNotFound | The instance cannot be found. |
| UnauthorizedOperation.CheckCamAuth | No permission to verify account operations. |
Was this page helpful?
You can also Contact sales or Submit a Ticket for help.
Help us improve! Rate your documentation experience in 5 mins.
Feedback