1. 接口描述
接口请求域名： dlc.tencentcloudapi.com 。
获取工作组详细信息
默认接口请求频率限制：20次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数，完整公共参数列表见 公共请求参数。
| 参数名称 | 必选 | 类型 | 描述 |
|---|---|---|---|
| Action | 是 | String | 公共参数，本接口取值：DescribeWorkGroupInfo。 |
| Version | 是 | String | 公共参数，本接口取值：2021-01-25。 |
| Region | 是 | String | 公共参数，详见产品支持的 地域列表。 |
| WorkGroupId | 否 | Integer | 工作组Id 示例值：21 |
| Type | 否 | String | 查询信息类型：User：用户信息 DataAuth：数据权限 EngineAuth：引擎权限 示例值：User |
| Filters.N | 否 | Array of Filter | 查询的过滤条件。 当Type为User时，支持Key为user-name的模糊搜索； 当Type为DataAuth时，支持key： policy-type：权限类型。 policy-source：数据来源。 data-name：库表的模糊搜索。 当Type为EngineAuth时，支持key： policy-type：权限类型。 policy-source：数据来源。 engine-name：库表的模糊搜索。 |
| SortBy | 否 | String | 排序字段。 当Type为User时，支持create-time、user-name 当Type为DataAuth时，支持create-time 当Type为EngineAuth时，支持create-time 示例值：create-time |
| Sorting | 否 | String | 排序方式，desc表示正序，asc表示反序， 默认为asc 示例值：desc |
| Limit | 否 | Integer | 返回数量，默认20，最大值100 示例值：20 |
| Offset | 否 | Integer | 偏移量，默认为0 示例值：0 |
| PolicyId | 否 | String | 要授权的策略列表 示例值：v1|WORKGROUP|221683|DATABASE|COMMON|DataLakeCatalog|andrew_dlc_02||||||ASSAYER |
3. 输出参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
| WorkGroupInfo | WorkGroupDetailInfo | 工作组详细信息 注意：此字段可能返回 null，表示取不到有效值。 |
| RequestId | String | 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 获取工作组详细信息
输入示例
POST / HTTP/1.1
Host: dlc.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeWorkGroupInfo
<公共请求参数>
{
"WorkGroupId": 63304,
"Type": "User",
"Filters": [
{
"Name": "policy-source",
"Values": [
"WORKGROUP"
]
}
],
"SortBy": "create-time",
"Sorting": "desc",
"Limit": 20,
"Offset": 0
}输出示例
{
"Response": {
"WorkGroupInfo": {
"WorkGroupId": 12,
"UserInfo": {
"TotalCount": 1,
"UserSet": [
{
"UserDescription": "default description",
"UserAlias": "testname",
"UserId": "12319087121",
"CreateTime": "2011-11-23 11:32:42",
"Creator": "12319087121"
}
]
},
"WorkGroupName": "testGroup",
"RowFilterInfo": null,
"DataPolicyInfo": null,
"EnginePolicyInfo": null,
"WorkGroupDescription": "default workgroup",
"Type": "User"
},
"RequestId": "gsdf-213kjs9sf-f11fafsaf-12e1k"
}
}示例2 获取工作组详细信息（TF场景）
输入示例
POST / HTTP/1.1
Host: dlc.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeWorkGroupInfo
<公共请求参数>
{
"WorkGroupId": 221683,
"Type": "DataAuth",
"PolicyId": "v1|WORKGROUP|221683|DATABASE|COMMON|DataLakeCatalog|andrew_dlc_02||||||ASSAYER"
}输出示例
{
"Response": {
"RequestId": "506388b2-aa19-4c1f-97a1-f7e6add6a1c1",
"WorkGroupInfo": {
"WorkGroupId": 221683,
"WorkGroupName": "test_0710",
"WorkGroupDescription": "",
"Type": "DataAuth",
"UserInfo": {
"UserSet": [],
"TotalCount": 0
},
"DataPolicyInfo": {
"PolicySet": [
{
"Id": 797339,
"PolicyType": "DATABASE",
"Mode": "COMMON",
"Catalog": "DataLakeCatalog",
"Database": "andrew_dlc_02",
"Table": "",
"View": "",
"Function": "",
"Column": "",
"DataEngine": "",
"Operation": "ASSAYER",
"ReAuth": false,
"Source": "WORKGROUP",
"SourceId": 221683,
"SourceName": "",
"Operator": "700002171047",
"CreateTime": "",
"PolicyId": "v1|WORKGROUP|221683|DATABASE|COMMON|DataLakeCatalog|andrew_dlc_02||||||ASSAYER"
}
],
"TotalCount": 1
},
"EnginePolicyInfo": {
"PolicySet": [
{
"Id": 0,
"PolicyType": "",
"Mode": "",
"Catalog": "",
"Database": "",
"Table": "",
"View": "",
"Function": "",
"Column": "",
"DataEngine": "",
"Operation": "",
"ReAuth": false,
"Source": "",
"SourceId": 0,
"SourceName": "",
"Operator": "",
"CreateTime": ""
}
],
"TotalCount": 0
},
"RowFilterInfo": {
"PolicySet": [
{
"Id": 0,
"PolicyType": "",
"Mode": "",
"Catalog": "",
"Database": "",
"Table": "",
"View": "",
"Function": "",
"Column": "",
"DataEngine": "",
"Operation": "",
"ReAuth": false,
"Source": "",
"SourceId": 0,
"SourceName": "",
"Operator": "",
"CreateTime": ""
}
],
"TotalCount": 0
}
}
}
}5. 开发者资源
腾讯云 API 平台
腾讯云 API 平台 是综合 API 文档、错误码、API Explorer 及 SDK 等资源的统一查询平台，方便您从同一入口查询及使用腾讯云提供的所有 API 服务。
API Inspector
用户可通过 API Inspector 查看控制台每一步操作关联的 API 调用情况，并自动生成各语言版本的 API 代码，也可前往 API Explorer 进行在线调试。
SDK
云 API 3.0 提供了配套的开发工具集（SDK），支持多种编程语言，能更方便的调用 API。
- Tencent Cloud SDK 3.0 for Python: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for Java: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for PHP: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for Go: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for Node.js: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for .NET: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for C++: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for Ruby: CNB, GitHub, Gitee
命令行工具
6. 错误码
以下仅列出了接口业务逻辑相关的错误码，其他错误码详见 公共错误码。
| 错误码 | 描述 |
|---|---|
| FailedOperation.GetPolicyFailed | 获取鉴权策略失败。 |
| FailedOperation.GetUserInfoFailed | 获取用户信息失败，请重试或提工单联系我们 |
| FailedOperation.GetWorkGroupInfoFailed | 获取工作组信息失败。 |
| InternalError | 内部错误。 |
| InvalidParameter | 参数错误。 |
| InvalidParameter.InvalidFilterKey | 不支持此过滤条件 |
| InvalidParameter.InvalidGroupId | 无效的工作组Id。 |
| InvalidParameter.InvalidInfoType | 请求的消息类型无效。 |
| InvalidParameter.InvalidSortByType | 不支持的排序类型。 |
