查询卷引用

返回卷引用查询的当前结果。

POST https://moi.matrixorigin.cn/newmoi/catalog/volume/ref_list

调用前准备

查询数据库中的对象取得目标卷 ID。准备有目标工作区访问权限的个人访问令牌、目标工作区 ID 和卷 ID。

下方示例使用:

  • $AI_STUDIO_API_KEY:实际个人访问令牌,通过 X-API-Key Header 传递。

  • $WORKSPACE_ID:目标工作区 ID,通过 X-Workspace-ID Header 传递。

  • $VOLUME_ID:要查询引用的卷 ID。

请求体

参数

类型

是否必填

说明

id

integer

卷 ID。

请求示例

curl -X POST "https://moi.matrixorigin.cn/newmoi/catalog/volume/ref_list" \
  -H "X-API-Key: $AI_STUDIO_API_KEY" \
  -H "X-Workspace-ID: $WORKSPACE_ID" \
  -H 'Content-Type: application/json' \
  -d '{
    "id": '"$VOLUME_ID"'
  }'

成功响应

成功时返回 200。当前实现返回空数组,不能用该结果确认卷没有引用;删除操作的实际结果以删除接口响应为准。

{
  "code": "OK",
  "msg": "OK",
  "data": {
    "list": []
  }
}

响应字段如下。

字段

类型

说明

code

string

成功时为 OK

msg

string

成功时为 OK

data.list

array

当前固定为空数组,不能用于判断是否存在引用。

错误响应

{
  "code": "ErrParamInvalid",
  "msg": "id 无效",
  "data": null
}

常见 HTTP 错误

HTTP 状态码

错误代码

常见原因

建议操作

400

ErrParamInvalid

id 缺失或格式无效。

传入有效的卷 ID。

403

ErrForbidden

当前身份没有该卷的读取权限。

使用有读取权限的凭据,或联系管理员授权。

500

ErrServer

服务无法读取引用信息。

记录请求时间和错误信息后重试;持续失败时联系支持人员。

最后更新于