智能创作
有奖捉虫：办公协同&微信生态&物联网文档专题 HOT
文档中心 > 智能创作 > 服务端 API > 团队管理相关接口 > 获取团队信息

获取团队信息

最近更新时间：2024-04-03 11:14:24

我的收藏

本页目录：

1. 接口描述

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

获取指定团队的信息，拉取团队信息列表。

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

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

2. 输入参数

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

参数名称 必选 类型 描述
Action 是 String 公共参数，本接口取值：DescribeTeams。
Version 是 String 公共参数，本接口取值：2019-10-29。
Region 否 String 公共参数，本接口不需要传递此参数。
Platform 是 String 平台 Id，指定访问的平台。关于平台概念，请参见文档 平台。
示例值：test
TeamIds.N 否 Array of String 团队 ID 列表，限30个。若不填，则默认获取平台下所有团队。
示例值：["1kdk882ddd88338ddd3k3\n","1kdk882ddd88338ddd3k4\n"]
Offset 否 Integer 分页偏移量，默认值：0。
示例值：0
Limit 否 Integer 返回记录条数，默认值：20，最大值：30。
示例值：10

3. 输出参数

参数名称 类型 描述
TotalCount Integer 符合条件的记录总数。
示例值：2
TeamSet Array of TeamInfo 团队列表。
RequestId String 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 分布获取团队信息

输入示例

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

{
    "Platform": "test",
    "Limit": "10",
    "Offset": "0"
}

输出示例

{
    "Response": {
        "TotalCount": 1,
        "TeamSet": [
            {
                "TeamId": "1kdk882ddd88338ddd3k3",
                "Name": "工作室1",
                "MemberCount": 30,
                "CreateTime": "2020-03-09T02:35:21Z",
                "UpdateTime": "2020-07-06T04:55:21Z"
            }
        ],
        "RequestId": "98534d9f-aeec-4817-bbe2-d3499f95a2af"
    }
}

示例2 获取指定团队信息

输入示例

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

{
    "TeamIds": [
        "1kdk882ddd88338ddd3k4",
        "1kdk882ddd88338ddd3k3"
    ],
    "Platform": "test"
}

输出示例

{
    "Response": {
        "TotalCount": 2,
        "TeamSet": [
            {
                "TeamId": "1kdk882ddd88338ddd3k3",
                "Name": "工作室1",
                "MemberCount": 30,
                "CreateTime": "2020-03-09T02:35:21Z",
                "UpdateTime": "2020-07-06T04:55:21Z"
            },
            {
                "TeamId": "1kdk882ddd88338ddd3k4",
                "Name": "工作室2",
                "MemberCount": 10,
                "CreateTime": "2020-04-03T09:25:21Z",
                "UpdateTime": "2020-06-06T03:16:21Z"
            }
        ],
        "RequestId": "99004d9f-aeec-4817-bbe2-d3499f95a2bf"
    }
}

5. 开发者资源

腾讯云 API 平台

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

API Inspector

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

SDK

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

命令行工具

6. 错误码

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

错误码 描述
InternalError 内部错误。
InvalidParameter.Platform 平台参数非法。
InvalidParameterValue 参数取值错误。
InvalidParameterValue.Platform 平台参数取值错误。
InvalidParameterValue.TeamNotExist 团队不存在。
OperationDenied.PermissionDeny 权限不足，请检查对应操作者的权限。
ResourceNotFound.Platform 平台不存在。
UnauthorizedOperation 未授权操作。
中国站