API 中心
视频服务与安全产品捉虫活动邀您参加！> HOT
文档中心>API 中心>数据湖计算 DLC>权限管理相关接口>获取用户详细信息

获取用户详细信息

最近更新时间：2024-09-06 01:29:00

我的收藏

本页目录：

1. 接口描述

接口请求域名： dlc.tencentcloudapi.com 。

获取用户详细信息

默认接口请求频率限制：20次/秒。

推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。

2. 输入参数

以下请求参数列表仅列出了接口请求参数和部分公共参数，完整公共参数列表见 公共请求参数。

参数名称 必选 类型 描述
Action 是 String 公共参数，本接口取值：DescribeUserInfo。
Version 是 String 公共参数，本接口取值：2021-01-25。
Region 是 String 公共参数，详见产品支持的 地域列表。
UserId 否 String 用户Id
示例值：123098736
Type 否 String 必传字段，查询的信息类型，Group：工作组 DataAuth：数据权限 EngineAuth:引擎权限 RowFilter：行级别权限
示例值：Group
Filters.N 否 Array of Filter 查询的过滤条件。

当Type为Group时，支持Key为workgroup-name的模糊搜索；

当Type为DataAuth时，支持key：

policy-type：权限类型。

policy-source：数据来源。

data-name：库表的模糊搜索。

当Type为EngineAuth时，支持key：

policy-type：权限类型。

policy-source：数据来源。

engine-name：库表的模糊搜索。
SortBy 否 String 排序字段。

当Type为Group时，支持create-time、group-name

当Type为DataAuth时，支持create-time

当Type为EngineAuth时，支持create-time
示例值：create-time
Sorting 否 String 排序方式，desc表示正序，asc表示反序， 默认为asc
示例值：desc
Limit 否 Integer 返回数量，默认20，最大值100
示例值：10
Offset 否 Integer 偏移量，默认为0
示例值：0

3. 输出参数

参数名称 类型 描述
UserInfo UserDetailInfo 用户详细信息
注意：此字段可能返回 null，表示取不到有效值。
RequestId String 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 test

输入示例

POST / HTTP/1.1
Host: dlc.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeUserInfo
<公共请求参数>

{
    "UserId": "abc",
    "Type": "abc",
    "Filters": [
        {
            "Name": "abc",
            "Values": [
                "abc"
            ]
        }
    ],
    "SortBy": "abc",
    "Sorting": "abc",
    "Limit": 0,
    "Offset": 0
}

输出示例

{
    "Response": {
        "UserInfo": {
            "UserId": "abc",
            "Type": "abc",
            "UserType": "abc",
            "UserDescription": "abc",
            "DataPolicyInfo": {
                "PolicySet": [
                    {
                        "Database": "abc",
                        "Catalog": "abc",
                        "Table": "abc",
                        "Operation": "abc",
                        "PolicyType": "abc",
                        "Function": "abc",
                        "View": "abc",
                        "Column": "abc",
                        "DataEngine": "abc",
                        "ReAuth": true,
                        "Source": "abc",
                        "Mode": "abc",
                        "Operator": "abc",
                        "CreateTime": "abc",
                        "SourceId": 0,
                        "SourceName": "abc",
                        "Id": 0
                    }
                ],
                "TotalCount": 0
            },
            "EnginePolicyInfo": {
                "PolicySet": [
                    {
                        "Database": "abc",
                        "Catalog": "abc",
                        "Table": "abc",
                        "Operation": "abc",
                        "PolicyType": "abc",
                        "Function": "abc",
                        "View": "abc",
                        "Column": "abc",
                        "DataEngine": "abc",
                        "ReAuth": true,
                        "Source": "abc",
                        "Mode": "abc",
                        "Operator": "abc",
                        "CreateTime": "abc",
                        "SourceId": 0,
                        "SourceName": "abc",
                        "Id": 0
                    }
                ],
                "TotalCount": 0
            },
            "WorkGroupInfo": {
                "WorkGroupSet": [
                    {
                        "WorkGroupId": 0,
                        "WorkGroupName": "abc",
                        "WorkGroupDescription": "abc",
                        "Creator": "abc",
                        "CreateTime": "abc"
                    }
                ],
                "TotalCount": 0
            },
            "UserAlias": "abc",
            "RowFilterInfo": {
                "PolicySet": [
                    {
                        "Database": "abc",
                        "Catalog": "abc",
                        "Table": "abc",
                        "Operation": "abc",
                        "PolicyType": "abc",
                        "Function": "abc",
                        "View": "abc",
                        "Column": "abc",
                        "DataEngine": "abc",
                        "ReAuth": true,
                        "Source": "abc",
                        "Mode": "abc",
                        "Operator": "abc",
                        "CreateTime": "abc",
                        "SourceId": 0,
                        "SourceName": "abc",
                        "Id": 0
                    }
                ],
                "TotalCount": 0
            }
        },
        "RequestId": "abc"
    }
}

5. 开发者资源

腾讯云 API 平台

腾讯云 API 平台 是综合 API 文档、错误码、API Explorer 及 SDK 等资源的统一查询平台，方便您从同一入口查询及使用腾讯云提供的所有 API 服务。

API Inspector

用户可通过 API Inspector 查看控制台每一步操作关联的 API 调用情况，并自动生成各语言版本的 API 代码，也可前往 API Explorer 进行在线调试。

SDK

云 API 3.0 提供了配套的开发工具集（SDK），支持多种编程语言，能更方便的调用 API。

命令行工具

6. 错误码

以下仅列出了接口业务逻辑相关的错误码，其他错误码详见 公共错误码。

错误码 描述
FailedOperation.GetPolicyFailed 获取鉴权策略失败。
FailedOperation.GetUserInfoFailed 获取用户信息失败，请重试或提工单联系我们
FailedOperation.GetWorkGroupInfoFailed 获取工作组信息失败。
InternalError 内部错误。
InternalError.InternalSystemException 业务系统异常，请重试或提工单联系我们。
InvalidParameter 参数错误。
InvalidParameter.InvalidAccessPolicy 无效的访问策略。
InvalidParameter.InvalidFilterKey 不支持此过滤条件
InvalidParameter.InvalidInfoType 请求的消息类型无效。
InvalidParameter.InvalidSortByType 不支持的排序类型。
InvalidParameter.InvalidUserName 无效的用户名。
InvalidParameter.InvalidUserType 无效的用户类型。
UnauthorizedOperation.UserNotExist 子用户不存在。
中国站
文档反馈
文档活动
message-icon联系我们
目录