Batch parsing file products¶

Batch query the existence of parsing products and their associated identifiers by file ID.

HTTP
POST $CLOUDSIGMA_API_BASE/catalog/file-artifacts:batchResolve

Before you call this API¶

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

First query the file list to obtain the file ID.

Set the operation-specific values used in the request:

$FILE_ID: File ID to parse.

Request¶

Input examples

Shell
curl -X POST "$CLOUDSIGMA_API_BASE/catalog/file-artifacts:batchResolve" \
  -H "X-API-Key: $CLOUDSIGMA_API_KEY" \
  -H "X-Workspace-ID: $WORKSPACE_ID" \
  -H "Content-Type: application/json" \
  -d '{
    "file_ids": ["'"$FILE_ID"'"]
  }'

Parameter reference

Request body

Parameter	Type	Required	Description
`file_ids`	string[]	Yes	List of file IDs to query.

[] after a type means an array. For example, string[] is an array of strings.

Successful response¶

When successful, 200 is returned. Each result item describes the corresponding file and product status.

Response example

JSON
{
  "code": "OK",
  "msg": "OK",
  "data": {
    "items": [
      {
        "file_id": "file-01",
        "file_exists": true,
        "has_artifact": true,
        "source_file_id": "file-01",
        "parsed_file_id": "file-02",
        "root_asset_id": "asset-root",
        "parsed_asset_id": "asset-parsed",
        "volume_id": 10
      }
    ]
  }
}

Field reference

The response fields are as follows.

Field	Type	Description
`data.items`	array	File product analysis results.
`data.items[].file_id`	string	Requested file ID.
`data.items[].file_exists`	boolean	Whether the file exists.
`data.items[].has_artifact`	boolean	Whether the file has related products.
`data.items[].source_file_id`	string	Source file ID.
`data.items[].parsed_file_id`	string	Parsed product file ID.
`data.items[].root_asset_id`	string	Root data asset ID.
`data.items[].parsed_asset_id`	string	Parsed data asset ID.
`data.items[].volume_id`	integer	ID of the root volume to which the file belongs.

Error response¶

Response example

JSON
{
  "code": "ErrNotFound",
  "msg": "对象不存在",
  "data": null
}

Field reference

Common HTTP errors¶

HTTP status code	error code	Common causes	Recommended actions
`400`	`ErrParamInvalid`	File ID list is empty or invalid.	Provide a non-empty list of file IDs.
`403`	`ErrForbidden`	The current identity does not have read permissions on the root volume to which the file belongs.	Use credentials with read permissions.
`404`	`ErrNotFound`	The requested file does not exist.	Check file ID.
`500`	`ErrServer`	The server failed to parse the file product.	Try again later.

Last updated on Sep 15, 2026