Skip to content

查询当前可用于新建的分区或目录 ​

查询新建时可用的分区和目录:先传 kind=projects,再用返回的 project_id 查 kind=categories。只读,不创建目录;has_more=true 时继续翻页。

请求 ​

text
POST https://open.cli.im/api/v2/rpc/qrcodes/listCreateTargets
项目要求
最低权限只读,见权限档位
需要的 scopetemplates.read
组织 Key不能调用,返回 403 credential_type_not_allowed,见历史组织 Key

相关调用流程:按模板批量建码。

请求参数 ​

请求体为 JSON。

字段类型必填说明
kindstring否查询类型:projects(默认)列出可以建码的分区;categories 列出某个分区下的目录。可选值:projects、categories。默认 "projects"
project_idinteger否kind 为 categories 时要查询的分区 ID,取自 kind=projects 的结果;0 为默认分区。默认 0
pageinteger否页码,从 1 开始。默认 1。最小 1
page_sizeinteger否每页条数。默认 20。范围 1–100

请求示例 ​

示例里的 ID、幂等键等换成实际值。

bash
curl -sS -X POST 'https://open.cli.im/api/v2/rpc/qrcodes/listCreateTargets' \
  -H "Authorization: Bearer ${CAOLIAO_API_KEY}" \
  -H 'Content-Type: application/json' \
  -d '{
  "kind": "categories",
  "project_id": 0,
  "page": 1,
  "page_size": 20
}'

响应 ​

成功时 HTTP 状态码为 200,顶层 code 为 0,结果在 data 里。失败时的返回见错误码与调用额度和业务错误码。

字段类型一定返回说明
data.kindstring是本次查询的类型。可选值:projects、categories
data.itemsobject[]是可用的分区或目录
data.items[].namestring是名称
data.items[].project_idinteger是分区 ID
data.items[].category_idinteger否目录 ID;kind 为 categories 时返回
data.items[].parent_idinteger否上级目录 ID;kind 为 categories 时返回
data.pageinteger是当前页码,从 1 开始
data.page_sizeinteger是每页条数
data.has_moreboolean是是否还有下一页。为 true 时即使当前页为空也应继续翻页

响应示例 ​

json
{
  "code": 0,
  "message": "ok",
  "data": {
    "kind": "categories",
    "items": [
      {
        "category_id": 120045,
        "name": "设备档案",
        "parent_id": 0,
        "project_id": 0
      }
    ],
    "page": 1,
    "page_size": 20,
    "has_more": false
  }
}

常见错误 ​

PERMISSION_DENIED。含义和处理方式见业务错误码。


本页由 openapi.json 生成。全部接口见接口清单。