查询指定空间下的文档库 - ListDocbaseInOrganization
功能介绍
根据条件查询指定空间下的文档库详情,用于文档库管理或者创建文档。
URI
GET /v1/app/organizations/{organization_id}/wikis
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| organization_id | 是 | String | 参数解释: 空间ID。 约束限制: 不涉及。 取值范围: [1-64]个字符。 默认取值: 不涉及。 |
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| offset | 否 | Integer | 参数解释: 偏移量,表示从此偏移量开始查询。 约束限制: 不涉及。 取值范围: 大于等于0的整数。 默认取值: 0。 |
| limit | 否 | Integer | 参数解释: 每页显示的条目数量。 约束限制: 不涉及。 取值范围: 正整数。 默认取值: 50。 |
| sort_key | 否 | String | 参数解释: 排序字段。 约束限制: 不涉及。 取值范围: name:标题。 update_time:修改时间。 create_time:创建时间。 默认取值: create_time。 |
| sort_dir | 否 | String | 参数解释: 排序方式。 约束限制: 不涉及。 取值范围: asc:升序,desc:降序。 默认取值: desc。 |
| only_default_wiki | 否 | Boolean | 参数解释: 支持返回团队中默认文档库。 约束限制: 不涉及。 取值范围: false或者空返回指定空间的所有文档库;取值true则返回默认文档库。 默认取值: 空。 |
请求参数
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| Authorization | 是 | String | 参数解释: 认证凭证。 约束限制: 格式:Bearer {access_token}。 取值范围: [1-1024]个字符。 默认取值: 不涉及。 |
| X-Cloud-Doc-AppId | 是 | String | 参数解释: APP ID。 约束限制: 不涉及。 取值范围: [1-128]个字符。 默认取值: 不涉及。 |
响应参数
状态码:200
| 参数 | 参数类型 | 描述 |
|---|---|---|
| wiki_list | Array of ListDocbaseInOrganizationVo objects | 参数解释: 文档库列表。 取值范围: 不涉及。 |
| total | Integer | 参数解释: 总数。 取值范围: 不涉及。 |
| 参数 | 参数类型 | 描述 |
|---|---|---|
| id | String | 参数解释: 文档库ID。 取值范围: [1-64]个字符。 |
| name | String | 参数解释: 文档库名称。 取值范围: [1-255]个字符。 |
| avatar | String | 参数解释: 文档库图标。 取值范围: [1-255]个字符。 |
| create_time | String | 参数解释: 创建时间。 取值范围: 不涉及。 |
| update_time | String | 参数解释: 更新时间。 取值范围: 不涉及。 |
| authority | AuthorityV1Vo object | 参数解释: 用户权限。 取值范围: 不涉及。 |
状态码:400
| 参数 | 参数类型 | 描述 |
|---|---|---|
| error_code | String | 错误码。 |
| error_msg | String | 错误描述。 |
请求示例
查询空间id为cXXXXXXX2-bfb0-0XXXXX1af7的前50个文档库。
GET https://{Endpoint}/v1/app/organizations/cXXXXXXX2-bfb0-0XXXXX1af7/wikis?offset=0&limit=50 响应示例
状态码:200
{
"wiki_list" : [ {
"id" : "wiki_5e6f7a8b",
"name" : "技术文档库",
"avatar" : "https://example.com/avatar.png",
"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 | 错误响应。 |
错误码
请参见错误码。