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

1. 接口描述

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

获取租户下的空间列表

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

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

2. 输入参数

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

参数名称 必选 类型 描述
Action String 公共参数,本接口取值:DescribeWorkspaceList。
Version String 公共参数,本接口取值:2023-04-27。
Region String 公共参数,详见产品支持的 地域列表
ApplicationToken String 应用token
示例值:XaaJvayJyusfUwuoJ2OlT5Z2YAVb6bVo
WorkspaceId Integer 工作空间id,非必填,填了则表示根据id进行批量查询
示例值:1101

3. 输出参数

参数名称 类型 描述
Result WorkspaceInfoList 项目空间列表
示例值:{ "List": [ { "ChineseName": "lv测试空间", "Description": "lv测试空间", "EnglishName": "", "IsCommWorkspace": false, "Status": 0, "TenantId": 100055, "ValidityEndTime": "1744387200", "ValidityStartTime": "1682524800", "WorkspaceId": 1092 }, { "ChineseName": "RayDataWeb", "Description": "RayDataWeb测试使用测完后删除", "EnglishName": "", "IsCommWorkspace": false, "Status": 0, "TenantId": 100055, "ValidityEndTime": "2000390400", "ValidityStartTime": "1684684800", "WorkspaceId": 1166 }, { "ChineseName": "华东项目空间", "Description": "演练项目空间", "EnglishName": "", "IsCommWorkspace": false, "Status": 0, "TenantId": 100055, "ValidityEndTime": "1693411200", "ValidityStartTime": "1682870400", "WorkspaceId": 1175 }, { "ChineseName": "ces", "Description": "123", "EnglishName": "", "IsCommWorkspace": false, "Status": 1, "TenantId": 100055, "ValidityEndTime": "1688400000", "ValidityStartTime": "1688313600", "WorkspaceId": 1524 }, { "ChineseName": "公共空间", "Description": "租户默认工作空间", "EnglishName": "comm_workspace", "IsCommWorkspace": true, "Status": 0, "TenantId": 100055, "ValidityEndTime": "4834882335", "ValidityStartTime": "1681282335", "WorkspaceId": 1015 }, { "ChineseName": "华南园区项目", "Description": "华南园区项目", "EnglishName": "", "IsCommWorkspace": false, "Status": 0, "TenantId": 100055, "ValidityEndTime": "2153664000", "ValidityStartTime": "1680278400", "WorkspaceId": 1016 }, { "ChineseName": "华北园区项目", "Description": "华北园区项目", "EnglishName": "", "IsCommWorkspace": false, "Status": 0, "TenantId": 100055, "ValidityEndTime": "2153664000", "ValidityStartTime": "1680278400", "WorkspaceId": 1018 }, { "ChineseName": "test", "Description": "ceshi", "EnglishName": "", "IsCommWorkspace": false, "Status": 0, "TenantId": 100055, "ValidityEndTime": "1747584000", "ValidityStartTime": "1685289600", "WorkspaceId": 1263 }, { "ChineseName": "report2test", "Description": "report2test", "EnglishName": "", "IsCommWorkspace": false, "Status": 0, "TenantId": 100055, "ValidityEndTime": "2192976000", "ValidityStartTime": "1687795200", "WorkspaceId": 1439 } ] }
RequestId String 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 查询项目空间列表

查询项目空间列表

输入示例

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

{
    "ApplicationToken": "XggJvayJyusfUwuoJ2OlT4Z2YAVq6bVo"
}

输出示例

{
    "Response": {
        "RequestId": "d04a9bab-dd91-4999-8584-bbc4d5203d50",
        "Result": {
            "List": [
                {
                    "ChineseName": "lv测试空间",
                    "Description": "lv测试空间",
                    "EnglishName": "",
                    "IsCommWorkspace": false,
                    "Status": 0,
                    "TenantId": 100055,
                    "ValidityEndTime": "1744387200",
                    "ValidityStartTime": "1682524800",
                    "WorkspaceId": 1092
                },
                {
                    "ChineseName": "RayDataWeb",
                    "Description": "RayDataWeb测试使用测完后删除",
                    "EnglishName": "",
                    "IsCommWorkspace": false,
                    "Status": 0,
                    "TenantId": 100055,
                    "ValidityEndTime": "2000390400",
                    "ValidityStartTime": "1684684800",
                    "WorkspaceId": 1166
                },
                {
                    "ChineseName": "华东项目空间",
                    "Description": "演练项目空间",
                    "EnglishName": "",
                    "IsCommWorkspace": false,
                    "Status": 0,
                    "TenantId": 100055,
                    "ValidityEndTime": "1693411200",
                    "ValidityStartTime": "1682870400",
                    "WorkspaceId": 1175
                },
                {
                    "ChineseName": "ces",
                    "Description": "123",
                    "EnglishName": "",
                    "IsCommWorkspace": false,
                    "Status": 1,
                    "TenantId": 100055,
                    "ValidityEndTime": "1688400000",
                    "ValidityStartTime": "1688313600",
                    "WorkspaceId": 1524
                },
                {
                    "ChineseName": "公共空间",
                    "Description": "租户默认工作空间",
                    "EnglishName": "comm_workspace",
                    "IsCommWorkspace": true,
                    "Status": 0,
                    "TenantId": 100055,
                    "ValidityEndTime": "4834882335",
                    "ValidityStartTime": "1681282335",
                    "WorkspaceId": 1015
                },
                {
                    "ChineseName": "华南园区项目",
                    "Description": "华南园区项目",
                    "EnglishName": "",
                    "IsCommWorkspace": false,
                    "Status": 0,
                    "TenantId": 100055,
                    "ValidityEndTime": "2153664000",
                    "ValidityStartTime": "1680278400",
                    "WorkspaceId": 1016
                },
                {
                    "ChineseName": "华北园区项目",
                    "Description": "华北园区项目",
                    "EnglishName": "",
                    "IsCommWorkspace": false,
                    "Status": 0,
                    "TenantId": 100055,
                    "ValidityEndTime": "2153664000",
                    "ValidityStartTime": "1680278400",
                    "WorkspaceId": 1018
                },
                {
                    "ChineseName": "test",
                    "Description": "ceshi",
                    "EnglishName": "",
                    "IsCommWorkspace": false,
                    "Status": 0,
                    "TenantId": 100055,
                    "ValidityEndTime": "1747584000",
                    "ValidityStartTime": "1685289600",
                    "WorkspaceId": 1263
                },
                {
                    "ChineseName": "report2test",
                    "Description": "report2test",
                    "EnglishName": "",
                    "IsCommWorkspace": false,
                    "Status": 0,
                    "TenantId": 100055,
                    "ValidityEndTime": "2192976000",
                    "ValidityStartTime": "1687795200",
                    "WorkspaceId": 1439
                }
            ]
        }
    }
}

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 参数错误。
InvalidParameterValue 参数取值错误。
InvalidParameterValue.InvalidWorkspaceId 错误的工作空间Id