Skip to main content

Get Import Progress

Retrieves the progress of a specified import task.


GET
https://controller.api.{cloud-region}.zillizcloud.com/v1/vector/collections/import/get

Example

Notes
  • This API requires an API Key as the authentication token.
curl --request GET \
--url "https://controller.api.${CLOUD_REGION}.zillizcloud.com/v1/vector/collections/import/get?jobId=${JOBID}&clusterId=${CLUSTERID}" \
--header "Authorization: Bearer ${API_KEY}" \
--header "accept: application/json" \
--header "content-type: application/json"

Request

Parameters

  • Query parameters

    ParameterDescription
    jobIdstring(required)
    The ID of the import task in concern
    clusterIdstring(required)
    The ID of a cluster to which this operation applies.
  • No path parameters required

Request Body

No request body required

Response

Returns the progress of the specified job ID in percentage.

Response Bodies

  • Response body if we process your request successfully
{
"code": "integer",
"data": {
"fileName": "string",
"fileSize": "integer",
"readyPercentage": "number",
"completeTime": "string",
"errorMessage": "string",
"collectionName": "string",
"jobId": "string",
"details": [
{
"fileName": "string",
"fileSize": "integer",
"readyPercentage": "number",
"completeTime": "string",
"errorMessage": "string"
}
]
}
}
  • Response body if we failed to process your request
{
"code": integer,
"message": string
}

Properties

The properties in the returned response are listed in the following table.

PropertyDescription
codeinteger
dataobject
data.fileNamestring
The path of the data file object in the object storage.
data.fileSizeinteger (int64)
The size of the data file object.
data.readyPercentagenumber (float)
The indicator of the import progress
data.completeTimestring
The time at which the import task completes. null indicates that the file import is going on.
data.errorMessagestring
The message that explains the reason for an import failure. null indicates that no error occurs.
data.collectionNamestring
The target collection name of the import task.
data.jobIdstring
The ID of an import task.
data[].detailsarray
The import task details
data[].details[]object
data[].details[].fileNamestring
The path to a file being imported.
data[].details[].fileSizeinteger (int64)
The size of a file being imported.
data[].details[].readyPercentagenumber (float)
The import progress of a specific file.
data[].details[].completeTimestring
The time at which the import progress ends for a specific file. null indicates that the file import is going on.
data[].details[].errorMessagestring
The message that explains the reason for an import failure. null indicates that no error occurs.
messagestring
Indicates the possible reason for the reported error.

Possible Errors

CodeError Message
40021The cluster ID does not exist.
40022No access to this cluster. Please request access from your admin.
80020Cluster not exist or you don't have permission.
80020Cluster not exist or you don't have permission.
90102The cluster does not exist in current region.
90102The cluster does not exist in current region.
90103The clusterId parameter is empty in the request path.
90104The clusterId parameter is empty in the request parameter.
90117Invalid domain name used
90144No jobId record found under this cluster