Domain name for API request: dlc.tencentcloudapi.com.
This API is used to get detailed user information.
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: DescribeUserInfo. |
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 | User ID |
Type | No | String | Type of queried information. Group: working group; DataAuth: data permission; EngineAuth: engine permission |
Filters.N | No | Array of Filter | Filter criteria that are queried When the type is Group, the fuzzy search is supported as the key is workgroup-name. When the type is DataAuth, the keys supported are: policy-type: types of permissions; policy-source: data sources; data-name: fuzzy search of the database and table. When the type is EngineAuth, the keys supported are: policy-type: types of permissions; policy-source: data sources; engine-name: fuzzy search of the database and table. |
SortBy | No | String | Sort fields. When the type is Group, the create-time and group-name are supported. When the type is DataAuth, create-time is supported. When the type is EngineAuth, create-time is supported. |
Sorting | No | String | Sorting methods: desc means in order; asc means in reverse order; it is asc by default. |
Limit | No | Integer | Quantity of returns. It is 20 by default, and the maximum value is 100. |
Offset | No | Integer | Offset, which is 0 by default. |
Parameter Name | Type | Description |
---|---|---|
UserInfo | UserDetailInfo | Detailed user information Note: This field may return null, indicating that no valid values can be obtained. |
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: DescribeUserInfo
<Common request parameters>
{}
{
"Response": {
"UserInfo": {
"UserId": "123108743",
"UserAlias": "testname",
"UserType": "ADMIN",
"UserDescription": "test",
"Type": "Group"
},
"RequestId": "1231sad-sadsd121-fvmkl23-f124"
}
}
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 | The parameter is incorrect. |
InvalidParameter.InvalidAccessPolicy | The access policy is invalid. |
InvalidParameter.InvalidFilterKey | The filter condition is not supported. |
InvalidParameter.InvalidInfoType | The requested message type is invalid. |
InvalidParameter.InvalidSortByType | The sorting type is not supported. |
InvalidParameter.InvalidUserName | The username is invalid. |
InvalidParameter.InvalidUserType | The user type is invalid. |
UnauthorizedOperation.UserNotExist | The sub-user does not exist. |
この記事はお役に立ちましたか?