ListCollaborationGroups - 查询协作空间列表

更新时间:
复制 MD 格式

分页查询当前用户可见的协作空间列表。

接口说明

分页查询当前调用用户在当前租户中有效加入的协作空间,支持按空间名称搜索。仅返回 ACTIVE 空间;需要关联平台用户的调用身份,不支持无用户身份的部署凭证。

调试

您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

调试

授权信息

下表是API对应的授权信息,可以在RAM权限策略语句的Action元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:

  • 操作:是指具体的权限点。

  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。

  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:

    • 对于必选的资源类型,用前面加 * 表示。

    • 对于不支持资源级授权的操作,用全部资源表示。

  • 条件关键字:是指云产品自身定义的条件关键字。

  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。

操作

访问级别

资源类型

条件关键字

关联操作

winnexo:ListCollaborationGroups

none

*全部资源

*

无 无

请求语法

POST /openapi/listCollaborationGroups HTTP/1.1

请求参数

名称

类型

必填

描述

示例值

tenantId

string

否

租户 ID;缺省使用调用方默认租户

10001

keyword

string

否

搜索关键词;可选,最大 256 字符

工作流

page

integer

否

页码,从 1 开始

1

pageSize

integer

否

每页数量,1 到 100,默认 20

20

返回参数

名称

类型

描述

示例值

object

code

string

公共业务状态码

ERR.Robject.Auth.TenantAccessDenied

message

string

公共错误描述

无权访问租户 2147483647,用户不属于该租户

requestId

string

请求追踪 ID

c9cf6cb3-3f5c-4994-a8a1-c93379a6f5cf

items

array<object>

当前页列表

[{"collaborationGroupId":"cg_9401","name":"产品协作空间","status":"ACTIVE","currentUserRole":"OWNER"}]

object

collaborationGroupId

string

协作空间 ID

cg_9401

name

string

空间名称

工作流待办测试

status

string

空间状态,当前只返回 ACTIVE

ACTIVE

currentUserRole

string

当前用户在空间中的角色

ADMIN

total

integer

筛选后的总记录数

39

page

integer

当前页码

1

pageSize

integer

当前页大小

20

示例

正常返回示例

JSON格式

{
  "code": "ERR.Robject.Auth.TenantAccessDenied",
  "message": "无权访问租户 2147483647,用户不属于该租户",
  "requestId": "c9cf6cb3-3f5c-4994-a8a1-c93379a6f5cf",
  "items": [
    {
      "collaborationGroupId": "cg_9401",
      "name": "工作流待办测试",
      "status": "ACTIVE",
      "currentUserRole": "ADMIN"
    }
  ],
  "total": 39,
  "page": 1,
  "pageSize": 20
}

错误码

访问错误中心错误中心查看更多错误码。

变更历史

更多信息,参考变更详情变更详情。