获取共享空间

最近更新时间:2024-03-15 16:01:56

我的收藏

1. 接口描述

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

获取共享空间。当个人或团队A对个人或团队B授权某资源以后,个人或团队B的共享空间就会增加个人或团队A。

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

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

2. 输入参数

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

参数名称 必选 类型 描述
Action String 公共参数,本接口取值:DescribeSharedSpace。
Version String 公共参数,本接口取值:2019-10-29。
Region String 公共参数,本接口不需要传递此参数。
Platform String 平台 Id,指定访问的平台。关于平台概念,请参见文档 平台
示例值:test
Authorizee Entity 被授权目标,个人或团队。
Operator String 操作者。如不填,默认为 cmeid_system,表示平台管理员操作,可以查询任意个人或者团队的共享空间。如果指定操作者,则操作者必须本人或者团队成员。
示例值:teamAmemberXXX

3. 输出参数

参数名称 类型 描述
TotalCount Integer 查询到的共享空间总数。
示例值:1
AuthorizerSet Array of Authorizer 各个共享空间对应的授权者信息。
RequestId String 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 获取共享空间

输入示例

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

{
    "Operator": "user_id_d1c5eb0ee4994419b465",
    "Platform": "test",
    "Authorizee": {
        "Type": "TEAM",
        "Id": "cmetid_acc5ddee49933d2b4338ud8d9"
    }
}

输出示例

{
    "Response": {
        "TotalCount": 1,
        "AuthorizerSet": [
            {
                "Type": "PERSON",
                "Id": "user_id_d1c5eb0ee4994419b465"
            }
        ],
        "RequestId": "d1c5eb0e-e499-4419-b465-60c097fbb6c9"
    }
}

5. 开发者资源

腾讯云 API 平台

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

API Inspector

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

SDK

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

命令行工具

6. 错误码

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

错误码 描述
InternalError 内部错误。
OperationDenied.PermissionDeny 权限不足,请检查对应操作者的权限。
ResourceNotFound.Platform 平台不存在。
UnauthorizedOperation 未授权操作。