文档首页/ 华为云DocZip智能文档服务/ API参考/ API/ 空间管理/ 查询空间列表 - ListOrganization
更新时间:2026-10-22 GMT+08:00
分享

查询空间列表 - ListOrganization

功能介绍

根据条件查询用户名下的所有或部分空间列表。

URI

GET /v1/app/organizations

表1 Query参数

参数

是否必选

参数类型

描述

offset

否

Integer

参数解释:

偏移量,表示从此偏移量开始查询。

约束限制:

不涉及。

取值范围:

大于等于0。

默认取值:

0。

limit

否

Integer

参数解释:

每页显示的条目数量。

约束限制:

不涉及。

取值范围:

正整数。

默认取值:

50。

sort_key

否

String

参数解释:

排序字段。

约束限制:

不涉及。

取值范围:

name:标题。

update_time:修改时间。

create_time:创建时间。

默认取值:

create_time。

sort_dir

否

String

参数解释:

排序方式。

约束限制:

不涉及。

取值范围:

asc:升序,desc:降序。

默认取值:

desc。

only_personal

否

Boolean

参数解释:

是否仅查询个人空间。

约束限制:

不涉及。

取值范围:

false或者空走原逻辑,取值true则返回个人团队,默认空,兼容原逻辑。

默认取值:

空。

请求参数

表2 请求Header参数

参数

是否必选

参数类型

描述

Authorization

是

String

参数解释:

认证凭证。

约束限制:

格式:Bearer {access_token}。

取值范围:

[1-1024]个字符。

默认取值:

不涉及。

X-Cloud-Doc-AppId

是

String

参数解释:

APP ID。

约束限制:

不涉及。

取值范围:

[1-128]个字符。

默认取值:

不涉及。

响应参数

状态码:200

表3 响应Body参数

参数

参数类型

描述

org_list

Array of ListOrganizationVo objects

参数解释:

空间列表。

取值范围:

不涉及。

total

Integer

参数解释:

列表项总数。

取值范围:

不涉及。

表4 ListOrganizationVo

参数

参数类型

描述

id

String

参数解释:

空间ID。

取值范围:

[1-64]个字符。

name

String

参数解释:

空间名称。

取值范围:

[1-255]个字符。

logo

String

参数解释:

空间Logo背景色。

取值范围:

不涉及。

is_personal

Boolean

参数解释:

是否为个人空间。

取值范围:

boolean。

create_time

String

参数解释:

创建时间。

取值范围:

不涉及。

update_time

String

参数解释:

更新时间。

取值范围:

不涉及。

authority

AuthorityV1Vo object

参数解释:

权限。

取值范围:

不涉及。

表5 AuthorityV1Vo

参数

参数类型

描述

auth

String

参数解释:

用户权限。

取值范围:

不涉及。

状态码:400

表6 响应Header参数

参数

参数类型

描述

X-Trace-Id

String

业务跟踪ID。

表7 响应Body参数

参数

参数类型

描述

error_code

String

错误码。

error_msg

String

错误描述。

状态码:500

表8 响应Header参数

参数

参数类型

描述

X-Trace-Id

String

业务跟踪ID。

表9 响应Body参数

参数

参数类型

描述

error_code

String

错误码。

error_msg

String

错误描述。

请求示例

查询个人文档库。

GET https://{Endpoint}/v1/app/organizations?only_personal=true

响应示例

状态码:200

{
  "org_list" : [ {
    "id" : "org_1a2b3c4d",
    "name" : "产品研发组",
    "logo" : "#4A90D9",
    "is_personal" : false,
    "create_time" : "2026-09-18 10:00:00",
    "update_time" : "2026-09-18 14:30:00"
  } ],
  "total" : 1
}

状态码:400

{
  "error_code" : "KPGE.00001000",
  "error_msg" : "Parameter error."
}

状态码

状态码

描述

200

请求成功。

400

错误响应。

500

错误响应。

错误码

请参见错误码。

相关文档