有奖:语音产品征文挑战赛火热进行中> HOT

1. 接口描述

接口请求域名: weilingwith.tencentcloudapi.com 。

查询项目空间人员列表

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

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

2. 输入参数

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

参数名称 必选 类型 描述
Action String 公共参数,本接口取值:DescribeWorkspaceUserList。
Version String 公共参数,本接口取值:2023-04-27。
Region String 公共参数,详见产品支持的 地域列表
Offset Integer 翻页页码
示例值:1
Limit Integer 翻页大小
示例值:10
WorkspaceId String 工作空间ID
示例值:1016
ApplicationToken String token
示例值:xxx
TenantId String 租户ID
示例值:10001
UpdateAt Integer 更新时间戳,单位秒
示例值:1689755305

3. 输出参数

参数名称 类型 描述
Result SsoTeamUserResult 返回数据
RequestId String 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 查询项目空间人员列表

查询项目空间人员列表

输入示例

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

{
    "Offset": 1,
    "Limit": 10,
    "WorkspaceId": "1016",
    "ApplicationToken": "o9ftuUNOFkOVf2o5etJ0nHou396ufAes"
}

输出示例

{
    "Response": {
        "RequestId": "68f43238-01a6-46c6-9204-f23cc3983756",
        "Result": {
            "Total": 3,
            "Users": [
                {
                    "CreateAt": 1692081934,
                    "DepartmentId": "6",
                    "DepartmentName": "产品部",
                    "Email": "test1@tencent.com",
                    "LinkFilter": 1,
                    "Phone": "159****6666",
                    "RealName": "test1",
                    "Status": 1,
                    "TenantId": "100055",
                    "UserId": "0d0a98561b3c4f72963eba5c5fcf56e1",
                    "UserType": "99"
                },
                {
                    "CreateAt": 1691139338,
                    "DepartmentId": "1",
                    "DepartmentName": "研发部",
                    "Email": "test2 @tencent.com",
                    "LinkFilter": 1,
                    "Phone": "139****9999",
                    "RealName": "test2",
                    "Status": 1,
                    "TenantId": "100055",
                    "UserId": "baea0677027445f49ebcf0ed29480cc2",
                    "UserType": "3"
                },
                {
                    "CreateAt": 1686233544,
                    "DepartmentId": "21",
                    "DepartmentName": "交付组",
                    "Email": "test3 @tencent.com",
                    "LinkFilter": 1,
                    "Phone": "132****0000",
                    "RealName": "test3",
                    "Status": 1,
                    "TenantId": "100055",
                    "UserId": "159ac75273614918be42b3b0a208d1ab",
                    "UserType": "3"
                }
            ]
        }
    }
}

5. 开发者资源

腾讯云 API 平台

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

API Inspector

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

SDK

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

命令行工具

6. 错误码

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

错误码 描述
InternalError.AppApiNoSpacePermission 该应用未关联该项目空间数据,无法获取该项目空间数据
InternalError.UnknownError 未知错误
InvalidParameter 参数错误。