Get Import Progress

Retrieves the progress of a specified import task.

---

GET

https://controller.${CLOUD_REGION}.zillizcloud.com/v1/vector/collections/import/get

---

Example

📘Notes

This API requires an API key as the authentication token.

export CLOUD_REGION="gcp-us-west1"
export JOB_ID="job-xxxxxxxxxxxxxxxxxxxxxx"
export CLUSTER_ID="inxx-xxxxxxxxxxxxxxx"
export API_KEY=""

curl --location --request GET "https://controller.api.${CLOUD_REGION}.zillizcloud.com/v1/vector/collections/import/get?jobId=${JOB_ID}&clusterId=${CLUSTER_ID}" \
--header "Authorization: Bearer ${API_KEY}"

Possible return is similar to the following.

{
    "code": 200,
    "data": {
        "collectionName": "medium_articles",
        "fileName": "1af78216-xxxx-xxxx-xxxx-2b0a73c566ed/1.parquet",
        "fileSize": 19599887,
        "readyPercentage": 0,
        "completeTime": null,
        "errorMessage": null,
        "jobId": "job-xxxxxxxxxxxxxxxxxxxxxx",
        "details": [
            {
                "fileName": "1af78216-xxxx-xxxx-xxxx-2b0a73c566ed/1.parquet",
                "fileSize": 19599887,
                "readyPercentage": 0,
                "completeTime": null,
                "errorMessage": null
            }
        ]
    }
}

Request

Parameters

• Query parameters

  Parameter	Description
  jobId	string(required) The ID of the import task in concern
  clusterId	string(required) The ID of a cluster to which this operation applies.

• No path parameters required

• Header parameters

  Parameter	Description
  Authorization	string

Request Body

No request body required

Response

Returns the progress of the specified job ID in percentage.

Response Body

{
    "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"
            }
        ]
    }
}

Property	Description
code	integer Indicates whether the request succeeds. 0: The request succeeds. Others: Some error occurs.
data	object
data.fileName	string The path of the data file object in the object storage.
data.fileSize	integer (int64) The size of the data file object.
data.readyPercentage	number (float) The indicator of the import progress
data.completeTime	string The time at which the import task completes. null indicates that the file import is going on.
data.errorMessage	string The message that explains the reason for an import failure. null indicates that no error occurs.
data.collectionName	string The target collection name of the import task.
data.jobId	string The ID of an import task.
data[].details	array The import task details
data[].details[]	object
data[].details[].fileName	string The path to a file being imported.
data[].details[].fileSize	integer (int64) The size of a file being imported.
data[].details[].readyPercentage	number (float) The import progress of a specific file.
data[].details[].completeTime	string The time at which the import progress ends for a specific file. null indicates that the file import is going on.
data[].details[].errorMessage	string The message that explains the reason for an import failure. null indicates that no error occurs.

Error Response

{
    "code": integer,
    "message": string
}

Property	Description
code	integer Indicates whether the request succeeds. 0: The request succeeds. Others: Some error occurs.
message	string Indicates the possible reason for the reported error.