Query volume reference¶

Returns the current results of the volume reference query.

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

Preparation before calling¶

First query the object in the database to obtain the target volume ID. Prepare the personal access token, target workspace ID, and volume ID that have access to the target workspace.

The example below uses:

$AI_STUDIO_API_KEY: The actual personal access token, passed through the X-API-Key Header.
$WORKSPACE_ID: Target workspace ID, passed through X-Workspace-ID Header.
$VOLUME_ID: The referenced volume ID is to be queried.

Request example¶

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"'
  }'

Request body¶

Parameter	Type	Required	Description
`id`	integer	Yes	Volume ID.

Successful response¶

Returns 200 on success. The current implementation returns an empty array, and this result cannot be used to confirm that the volume is not referenced; the actual result of the delete operation is subject to the delete interface response.

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

The response fields are as follows.

Field	Type	Description
`code`	string	`OK` on success.
`msg`	string	`OK` on success.
`data.list`	array	It is currently fixed to an empty array and cannot be used to determine whether a reference exists.

Error response¶

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

Common HTTP errors¶

HTTP status code	error code	Common causes	Recommended actions
`400`	`ErrParamInvalid`	`id` is missing or in an invalid format.	Pass in a valid volume ID.
`403`	`ErrForbidden`	The current identity does not have read permission for the volume.	Use credentials with read access, or contact your administrator for authorization.
`500`	`ErrServer`	The service cannot read the reference information.	Record the request time and error message and try again; if it continues to fail, contact support.

Last updated on Sep 3, 2026