1. 接口描述
接口请求域名： dlc.tencentcloudapi.com 。
获取工作组列表
默认接口请求频率限制：20次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数，完整公共参数列表见 公共请求参数。
| 参数名称 | 必选 | 类型 | 描述 |
|---|---|---|---|
| Action | 是 | String | 公共参数，本接口取值：DescribeWorkGroups。 |
| Version | 是 | String | 公共参数，本接口取值：2021-01-25。 |
| Region | 是 | String | 公共参数，详见产品支持的 地域列表。 |
| WorkGroupId | 否 | Integer | 查询的工作组Id，不填或填0表示不过滤。 示例值：1 |
| Filters.N | 否 | Array of Filter | 过滤条件，当前仅支持按照工作组名称进行模糊搜索。Key为workgroup-name |
| Offset | 否 | Integer | 偏移量，默认为0 示例值：0 |
| Limit | 否 | Integer | 返回数量，默认20，最大值100 示例值：20 |
| SortBy | 否 | String | 排序字段，支持如下字段类型，create-time 示例值：create-time |
| Sorting | 否 | String | 排序方式，desc表示正序，asc表示反序， 默认为asc 示例值：desc |
3. 输出参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
| TotalCount | Integer | 工作组总数 示例值：1 |
| WorkGroupSet | Array of WorkGroupInfo | 工作组信息集合 |
| RequestId | String | 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 获取工作组列表
输入示例
POST / HTTP/1.1
Host: dlc.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeWorkGroups
<公共请求参数>
{
"Sorting": "desc",
"WorkGroupId": 1,
"Limit": 0,
"SortBy": "create-time",
"Filters": [
{
"Values": [
"workgroup-name"
],
"Name": "Group1"
}
],
"Offset": 0
}输出示例
{
"Response": {
"WorkGroupSet": [
{
"PolicySet": [
{
"Table": "TableName",
"Catalog": "COSDataCatalog",
"Operation": "ALL",
"Database": "DatabaseName"
}
],
"WorkGroupId": 1,
"Creator": "1248065439",
"UserNum": 1,
"WorkGroupDescription": "test group",
"WorkGroupName": "Group1",
"UserSet": [
{
"UserDescription": "test user",
"UserAlias": "testname",
"UserId": "1248065439",
"CreateTime": "2021-07-28 16:19:32",
"Creator": "1248065439"
}
],
"CreateTime": "2021-07-28 16:19:32"
}
],
"TotalCount": 1,
"RequestId": "1287310-badou889lodj-1231jk12"
}
}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: GitHub Gitee
- Tencent Cloud SDK 3.0 for Java: GitHub Gitee
- Tencent Cloud SDK 3.0 for PHP: GitHub Gitee
- Tencent Cloud SDK 3.0 for Go: GitHub Gitee
- Tencent Cloud SDK 3.0 for Node.js: GitHub Gitee
- Tencent Cloud SDK 3.0 for .NET: GitHub Gitee
- Tencent Cloud SDK 3.0 for C++: GitHub Gitee
- Tencent Cloud SDK 3.0 for Ruby: GitHub Gitee
命令行工具
6. 错误码
以下仅列出了接口业务逻辑相关的错误码，其他错误码详见 公共错误码。
| 错误码 | 描述 |
|---|---|
| FailedOperation.GetPolicyFailed | 获取鉴权策略失败。 |
| FailedOperation.GetUserInfoFailed | 获取用户信息失败，请重试或提工单联系我们 |
| FailedOperation.GetWorkGroupInfoFailed | 获取工作组信息失败。 |
| InternalError | 内部错误。 |
| InternalError.InternalSystemException | 业务系统异常，请重试或提工单联系我们。 |
| InvalidParameter.InvalidAccessPolicy | 无效的访问策略。 |
| InvalidParameter.InvalidFilterKey | 不支持此过滤条件 |
| InvalidParameter.InvalidOffset | 无效的Offset值。 |
| InvalidParameter.InvalidSortByType | 不支持的排序类型。 |
| InvalidParameter.InvalidSorting | Invalid Sorting |