API 中心
有奖捉虫：办公协同&微信生态&物联网文档专题 HOT
文档中心 > API 中心 > 流计算 Oceanus > 权限相关接口 > 授权工作空间列表

授权工作空间列表

最近更新时间：2024-03-12 01:42:35

我的收藏

本页目录：

1. 接口描述

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

授权工作空间列表

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

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

2. 输入参数

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

参数名称 必选 类型 描述
Action 是 String 公共参数，本接口取值：DescribeWorkSpaces。
Version 是 String 公共参数，本接口取值：2019-04-22。
Region 是 String 公共参数，详见产品支持的 地域列表。
Offset 否 Integer 偏移量，默认 0
示例值：0
OrderType 否 Integer 1 按照创建时间降序排序(默认) 2.按照创建时间升序排序，3. 按照状态降序排序 4. 按照状态升序排序 默认为0
示例值：1
Limit 否 Integer 请求的集群数量，默认 20
示例值：20
Filters.N 否 Array of Filter 过滤规则
示例值：[]

3. 输出参数

参数名称 类型 描述
WorkSpaceSetItem Array of WorkSpaceSetItem 空间详情列表
注意：此字段可能返回 null，表示取不到有效值。
TotalCount Integer 空间总数
RequestId String 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 授权空间列表

获取用户的空间列表

输入示例

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

{
    "Offset": 0,
    "Limit": 5,
    "Filters": [
        {
            "Name": "ItemSpaceName",
            "Values": [
                "def"
            ]
        }
    ],
    "OrderType": 1
}

输出示例

{
    "Response": {
        "TotalCount": 25,
        "WorkSpaceSetItem": [
            {
                "SerialId": "spc-1874",
                "WorkSpaceId": "spc-1874",
                "AppId": 1257058945,
                "OwnerUin": "100006386216",
                "CreatorUin": "100006386216",
                "WorkSpaceName": "default0",
                "Region": "ap-guangzhou",
                "CreateTime": "2021-12-10 02:39:54",
                "UpdateTime": "2021-12-10 02:39:54",
                "Status": 2,
                "Description": "子账号在默认空间具有开发者权限，可以在成员管理模块进行限制",
                "ClusterGroupSetItem": [
                    {
                        "ClusterId": "cluster-jphs0vtz",
                        "Name": "k1",
                        "Region": "ap-guangzhou",
                        "Zone": "ap-guangzhou-3",
                        "AppId": 1257058945,
                        "OwnerUin": "100006386216",
                        "CreatorUin": "100006386216",
                        "CuNum": 24,
                        "CuMem": 4,
                        "Status": -1,
                        "StatusDesc": "unknown",
                        "CreateTime": "2020-11-05 09:40:45",
                        "UpdateTime": "2020-11-25 02:47:02",
                        "Remark": "k1",
                        "NetEnvironmentType": 1,
                        "FreeCuNum": 24,
                        "FreeCu": 23.5,
                        "RunningCu": 0,
                        "PayMode": 0
                    }
                ],
                "RoleAuth": [
                    {
                        "Id": 1363,
                        "AppId": 1257058945,
                        "WorkSpaceId": 1874,
                        "WorkSpaceSerialId": "workspace-xxx",
                        "OwnerUin": "100006386216",
                        "CreatorUin": "100006386216",
                        "AuthSubAccountUin": "100006386216",
                        "Permission": 0,
                        "CreateTime": "2021-12-10 02:40:46",
                        "UpdateTime": "2021-12-10 02:40:46",
                        "Status": 2,
                        "RoleName": "name"
                    }
                ],
                "RoleAuthCount": 2,
                "JobsCount": 5
            }
        ],
        "RequestId": "415320BF-0F15-40AB-BB57-8D3B358E0423"
    }
}

5. 开发者资源

腾讯云 API 平台

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

API Inspector

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

SDK

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

命令行工具

6. 错误码

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

错误码 描述
AuthFailure CAM签名/鉴权错误。
AuthFailure.UnauthorizedOperation 未授权操作。
FailedOperation 操作失败。
InternalError 内部错误。
InvalidParameter 参数错误。
中国站