Domain name for API request: dlc.tencentcloudapi.com.
This API is used to obtain the user list.
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: DescribeUsers. |
Version | Yes | String | Common Params. The value used for this API: 2021-01-25. |
Region | Yes | String | Common Params. For more information, please see the list of regions supported by the product. |
UserId | No | String | Specify the UIN of the sub-user to be queried. Users need to create it through the CreateUser API. |
Offset | No | Integer | Offset, which is 0 by default. |
Limit | No | Integer | Quantity of returns. It is 20 by default, and the maximum value is 100. |
SortBy | No | String | Sorting fields, which support the following type: create-time |
Sorting | No | String | Sorting methods: desc means in order; asc means in reverse order; it is asc by default. |
Filters.N | No | Array of Filter | Filter criteria. The following filter types are supported. User-type means the filtering is based on the types of users, and user-keyword means the filtering is based on the names of users. |
Parameter Name | Type | Description |
---|---|---|
TotalCount | Integer | Total queried number of users queried |
UserSet | Array of UserInfo | Collection of the queried information of the authorized user |
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: dlc.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeUsers
<Common request parameters>
{
"Limit": 10,
"Sorting": "create-time",
"UserId": "1248065439",
"SortBy": "desc",
"Offset": 0
}
{
"Response": {
"TotalCount": 1,
"UserSet": [
{
"Creator": "1248065439",
"PolicySet": [
{
"Table": "TableName",
"Catalog": "COSDataCatalog",
"Operation": "ALL",
"Database": "DatabaseName"
}
],
"UserId": "1248065439",
"UserType": "ADMIN",
"UserAlias": "xxxname",
"IsOwner": true,
"UserDescription": "Test User",
"WorkGroupSet": [
{
"WorkGroupId": 0,
"WorkGroupName": "Group1",
"CreateTime": "2021-07-28 16:19:32",
"WorkGroupDescription": "test group",
"Creator": "1248065439"
}
],
"CreateTime": "2021-07-28 16:19:32"
}
],
"RequestId": "1287310-badou889lodj-1231jk12"
}
}
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 |
---|---|
FailedOperation.GetPolicyFailed | Obtaining the authentication policy failed. |
FailedOperation.GetUserInfoFailed | Obtaining user information failed. Please try again or submit a ticket to contact us. |
FailedOperation.GetWorkGroupInfoFailed | Obtaining working group information failed. |
InternalError | An internal error occurred. |
InternalError.InternalSystemException | The business system is abnormal. Please try again or submit a ticket to contact us. |
InvalidParameter.InvalidAccessPolicy | The access policy is invalid. |
InvalidParameter.InvalidOffset | The Offset value is invalid. |
InvalidParameter.InvalidSortByType | The sorting type is not supported. |
문제 해결에 도움이 되었나요?