メインコンテンツまでスキップ

ジョブの詳細取得 (V2)

指定した control-plane ジョブの情報を詳細に一覧表示します

GET/v2/jobs/{JOB_ID}
接続エンドポイント

https://api.cloud.zilliz.com

shell
export BASE_URL="https://api.cloud.zilliz.com"
パラメータ
Authorizationstringheader必要

認証トークンは、適切な権限を持つ API key である必要があります。

値の例： Bearer {{TOKEN}}
JOB_IDstringpath必要

送信済みのジョブの ID。

値の例： job-xxxxxxxxxxxxxxxxxx
bash
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 "Request-Timeout: 5" \
--header "Content-Type: application/json"
レスポンス200 OK - application/json

成功

ジョブのレスポンスペイロードが取り得る形式の 1 つです。

jobIdstring

送信済みのジョブの ID。

typestring

ジョブのタイプ

statusstring

ジョブのステータス

progressstring

ジョブの進行状況

startTimestring

ジョブの開始時刻。

endTimestring

ジョブの終了時刻。

reasonstring

ジョブが失敗した理由を示すメッセージ。

dataobject

レスポンスペイロード。種類はエンドポイントによって異なります。

jobIdstring

ジョブの ID。

typestring

ジョブの種類。

statusstring

ジョブのステータス。

progressstring

ジョブの進捗状況。

startTimestring

ジョブが開始された時刻。

endTimestring

ジョブが終了した時刻。

reasonstring

ジョブが成功しなかった場合の失敗理由。

エラーメッセージを返します。

codeinteger<int32>

レスポンスコード。

messagestring

エラーメッセージ。

Successjson
{
    "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": ""
    }
}
Ctrl I