Query volume details¶

Query root volume details by ID.

HTTP
POST $CLOUDSIGMA_API_BASE/catalog/volume/info

Before you call this API¶

Configure the regional API endpoint and authentication, and select the target workspace.

First query the object in the database to obtain the target volume ID.

Set the operation-specific values used in the request:

$VOLUME_ID: Volume ID to query.

Request¶

Input examples

Shell
curl -X POST "$CLOUDSIGMA_API_BASE/catalog/volume/info" \
  -H "X-API-Key: $CLOUDSIGMA_API_KEY" \
  -H "X-Workspace-ID: $WORKSPACE_ID" \
  -H 'Content-Type: application/json' \
  -d '{
    "id": "'"$VOLUME_ID"'"
  }'

Parameter reference

Request body

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

Successful response¶

Returns 200 and volume information on success. The caller must have read permissions on the volume.

Response example

JSON
{
  "code": "OK",
  "msg": "OK",
  "data": {
    "volume": {
      "id": 789,
      "name": "sales_files",
      "display_name": "销售文件",
      "description": "销售文件",
      "display_description": "销售文件"
    }
  }
}

Field reference

The response fields are as follows.

Field	Type	Description
`code`	string	`OK` on success.
`msg`	string	`OK` on success.
`data.volume.id`	integer	Volume ID.
`data.volume.name`	string	Volume name.
`data.volume.display_name`	string	Volume display name; may be omitted if not provided.
`data.volume.description`	string	Volume description; may be omitted if not provided.
`data.volume.display_description`	string	Volume display description; may be omitted if not provided.

Error response¶

Response example

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

Field reference

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 volume information.	Record the request time and error message and try again; if it continues to fail, contact support.

Follow-up operations¶

When modifications are needed Update volume. When returning the list Query file products.

Last updated on Sep 15, 2026