1. 接口描述
接口请求域名： lcic.tencentcloudapi.com 。
获取群组列表
默认接口请求频率限制：20次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数，完整公共参数列表见 公共请求参数。
| 参数名称 | 必选 | 类型 | 描述 |
|---|---|---|---|
| Action | 是 | String | 公共参数，本接口取值：DescribeGroupList。 |
| Version | 是 | String | 公共参数，本接口取值：2022-08-17。 |
| Region | 否 | String | 公共参数，此参数为可选参数。 |
| SdkAppId | 是 | Integer | 低代码平台应用ID 示例值：1234657 |
| Page | 否 | Integer | 分页查询当前页数，默认从1开始递增。 示例值：1 |
| Limit | 否 | Integer | 每页数据量，默认20，最大1000。 示例值：10 |
| TeacherId | 否 | String | 主讲人ID筛选群组，与MemberId有且只有一个,都传时以此字段获取 示例值：abc |
| MemberId | 否 | String | 成员ID刷选群组，与TeacherId有且只有一个 示例值：abc |
3. 输出参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
| Total | Integer | 记录总数。当前匹配群组总数。 示例值：1 |
| GroupInfos | Array of GroupInfo | 群组信息列表。 注意：此字段可能返回 null，表示取不到有效值。 |
| RequestId | String | 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 示例1
TeacherId和MemberId都不填的返回结果
输入示例
POST / HTTP/1.1
Host: lcic.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeGroupList
<公共请求参数>
{
"SdkAppId": 3618809
}输出示例
{
"Response": {
"GroupInfos": [
{
"GroupId": "cfmsqfu2r378uak93i70",
"GroupName": "修改测试群组名称",
"GroupType": 0,
"SubGroupIds": null,
"TeacherId": "2LoDvr6M9TvI4x4dMFBpGRzxZXr"
},
{
"GroupId": "cfmst8u2r378uak93i90",
"GroupName": "批量创建群组1",
"GroupType": 0,
"SubGroupIds": null,
"TeacherId": ""
},
{
"GroupId": "cfmst8u2r378uak93i9g",
"GroupName": "批量创建群组2",
"GroupType": 0,
"SubGroupIds": null,
"TeacherId": ""
},
{
"GroupId": "cfmthke2r378uak93ii0",
"GroupName": "测试修改群组",
"GroupType": 0,
"SubGroupIds": null,
"TeacherId": "2LoDvr6M9TvI4x4dMFBpGRzxZXr"
},
{
"GroupId": "cjdipop7qk6r714q0fh0",
"GroupName": "lukatest",
"GroupType": 0,
"SubGroupIds": null,
"TeacherId": ""
}
],
"RequestId": "5b261337-70dc-49a9-92cb-820641958626",
"Total": 5
}
}示例2 示例2
查询TeacherId的结果
输入示例
POST / HTTP/1.1
Host: lcic.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeGroupList
<公共请求参数>
{
"SdkAppId": 3618809,
"TeacherId": "2LoDvr6M9TvI4x4dMFBpGRzxZXr"
}输出示例
{
"Response": {
"GroupInfos": [
{
"GroupId": "cfmsqfu2r378uak93i70",
"GroupName": "修改测试群组名称",
"GroupType": 0,
"SubGroupIds": null,
"TeacherId": "2LoDvr6M9TvI4x4dMFBpGRzxZXr"
},
{
"GroupId": "cfmthke2r378uak93ii0",
"GroupName": "测试修改群组",
"GroupType": 0,
"SubGroupIds": null,
"TeacherId": "2LoDvr6M9TvI4x4dMFBpGRzxZXr"
}
],
"RequestId": "a69c412e-1da6-4d27-bd37-c74a2703f94a",
"Total": 2
}
}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. 错误码
以下仅列出了接口业务逻辑相关的错误码，其他错误码详见 公共错误码。
| 错误码 | 描述 |
|---|---|
| AuthFailure | CAM签名/鉴权错误。 |
| FailedOperation | 操作失败。 |
| InternalError | 内部错误。 |
| InvalidParameter | 参数错误。 |
| InvalidParameter.GroupMemberOverLimit | 操作的群组成员超过限制 |
| InvalidParameter.GroupTypeInvalid | 群组类型错误 |
| InvalidParameter.SdkAppId | SdkAppId参数错误。 |
| InvalidParameterValue | 参数取值错误。 |
| MissingParameter | 缺少参数错误。 |
| RequestLimitExceeded | 请求的次数超过了频率限制。 |
| ResourceNotFound.GroupNotExist | 群组不存在 |
| UnauthorizedOperation | 未授权操作。 |
| UnknownParameter | 未知参数错误。 |
| UnsupportedOperation | 操作不支持。 |