查看任务详情

List the information about the specified control-plane job in detail

GET

/v2/jobs/{JOB_ID}

Base URL

该 API 的 Base URL 格式如下：

https://api.cloud.zilliz.com.cn

export BASE_URL="https://api.cloud.zilliz.com.cn"

参数

Authorizationstringheaderrequired

认证令牌，应为具备适当权限的 API 密钥。

示例值：Bearer {{TOKEN}}

JOB_IDstringpathrequired

The ID of the job that has been submitted.

示例值：job-xxxxxxxxxxxxxxxxxx

export TOKEN="YOUR_API_KEY"
export JOB_ID="job-xxxxxxxxxxxxxxxxxx"

curl --request GET \
--url "${BASE_URL}/v2/jobs/${JOB_ID}" \
--header "Authorization: Bearer ${TOKEN}" \
--header "Content-Type: application/json"

响应200 - application/json

SUCCESS

jobIdstring

The ID of the job that has been submitted.

typestring

The type of the job

枚举值：

IMPORTMIGRATIONBACKUPRESTORECLONE_COLLECTION

statusstring

The status of the job

枚举值：

PENDINGIN_PROGRESSSUCCESSFULFAILEDCANCELING

progressstring

The progress of the job

startTimestring

The time at which the job starts.

endTimestring

The time at which the job end.

reasonstring

The message of why the job failed.

FAILURE

Returns an error message.

codeinteger

响应码。

messagestring

错误描述。

SUCCESS

{
    "code": 0,
    "data": {
        "jobId": "job-03e1eefbd82dmo2oeb8pe2",
        "type": "MIGRATION",
        "status": "SUCCESSFUL",
        "progress": "100",
        "startTime": "2024-07-30T16:49:50Z",
        "endTime": "2024-07-30T17:30:50Z",
        "reason": ""
    }
}