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

バッチジョブのキャンセル (V2)

この操作は、指定されたプロジェクト内のバッチジョブのキャンセルリクエストを送信します。

POST/v2/projects/{projectId}/jobs/{jobId}/cancel
接続エンドポイント

https://api.cloud.zilliz.com

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

認証トークンには、適切な権限を持つ API key を使用してください。

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

プロジェクト ID。

値の例： proj-xxxxxxxxxxxxxxxxxxx
jobIdstringpath必要

バッチジョブ ID。

値の例： job-xxxxxxxxxxxxxxxxxx
bash
export TOKEN="YOUR_API_KEY"
export projectId="proj-xxxxxxxxxxxxxxxxxxx"
export jobId="job-xxxxxxxxxxxxxxxxxx"

curl --request POST \
--url "${BASE_URL}/v2/projects/${projectId}/jobs/${jobId}/cancel" \
--header "Authorization: Bearer ${TOKEN}" \
--header "Request-Timeout: 5" \
--header "Content-Type: application/json"
レスポンス202 Accepted - application/json

キャンセルリクエストが受理されました。

レスポンスボディが取り得る代替オブジェクト形状の 1 つ。レスポンスごとに 1 つの形状のみが適用されます。

codeinteger

レスポンスコード。

dataobject

キャンセルリクエスト後のバッチジョブを含むレスポンスペイロード。

jobIdstring必要

ジョブ ID。

projectIdstring必要

ジョブが属するプロジェクトの ID。

typestring必要

ジョブの種類。

descriptionstring

ジョブの説明。

statusstring必要

ジョブのステータス。

regionIdstring必要

クラウドリージョン ID。

clusterIdstring

クラスター ID。

artifactobject

ジョブによって生成された出力アーティファクト。

volumeNamestring必要

アーティファクトが保存されるボリューム名。

pathstring必要

ボリューム内のアーティファクトのパス。

detailsobject

バックフィルジョブの詳細。

dbNamestring

データベース名。

collectionNamestring

コレクション名。

inputobject

ジョブの入力データまたは出力データへの参照。

typestring

データ参照の種類。

volumeNamestring

ボリューム名。

pathstring

ボリューム内のデータパス。

formatstring

データ形式。

fieldsarray

ターゲットフィールド。

[]fieldsstring

バックフィルジョブについて報告されるフィールド名の 1 つで、集計バケットを形成するために使用される非空のスカラーフィールドから取得されます。

columnMappingobject

ソースからターゲットへのカラムマッピング。

modestring

バックフィルモード。

resourceSizestring

リソースサイズ。

failureReasonobject

ジョブが失敗した理由。

codestring

エラーコード。

messagestring

エラーメッセージ。

retryableboolean

ジョブを再試行できるかどうか。

precheckReportobject

バックフィルジョブの事前チェックレポート。

passedboolean

事前チェックに合格したかどうか。

dbNamestring

データベース名。

collectionNamestring

コレクション名。

inputstring

入力の説明。

fieldsarray

ターゲットフィールド。

[]fieldsstring

プリチェックレポートに含まれるフィールド名の 1 つで、集計バケットを形成するために使用される非空のスカラーフィールドから取得されます。

columnMappingobject

ソースからターゲットへのカラムマッピング。

requiredSourceColumnsarray

必須のソースカラム。

[]requiredSourceColumnsstring

プリチェックに必要なソース列の 1 つ。

errorsarray

事前チェックエラー。

[]errorsobject

個々の事前チェックエラー。

codestring

エラーコード。

sourceColumnstring

ソースカラム。

targetFieldstring

ターゲットフィールド。

expectedTypestring

期待される型。

actualTypestring

実際の型。

messagestring

エラーメッセージ。

checkedRowsinteger<int64>

チェックされた行数。

createdAtstring

作成時刻 (ISO 8601)。

submittedAtstring

送信時刻 (ISO 8601)。

startedAtstring

開始時刻 (ISO 8601)。

finishedAtstring

終了時刻 (ISO 8601)。

durationSecondsinteger<int64>

秒単位の所要時間。

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

codeinteger

レスポンスコード。

messagestring

エラーメッセージ。

Successjson
{
    "code": 0,
    "data": {
        "jobId": "job-xxxxxxxxxxxxxxxxxx",
        "sparkInstanceId": "sp-xxxxxxxxxxxxxxxxxx",
        "type": "SPARK",
        "jobName": "daily-vector-etl",
        "status": "CANCELED",
        "regionId": "aws-us-west-2",
        "clusterId": "in01-xxxxxxxxxxxxxxx",
        "mainClass": "com.zilliz.example.Main",
        "createdAt": "2026-05-20T10:00:00Z",
        "startedAt": "2026-05-20T10:01:00Z",
        "finishedAt": "2026-05-20T10:06:00Z",
        "durationSeconds": 300,
        "sparkApplicationName": "spark-batch-sp-xxxxxxxxxxxxxxxxxx",
        "sparkNamespace": "spark-sp-xxxxxxxxxxxxxxxxxx",
        "sparkHistoryUrl": "https://spark-history.example.com",
        "sparkApplicationId": "spark-batch-sp-xxxxxxxxxxxxxxxxxx-0",
        "sparkHistoryAppUrl": "https://spark-history.example.com/history/spark-batch-sp-xxxxxxxxxxxxxxxxxx-0/jobs/",
        "artifact": {
            "volumeId": "stg-xxxxxxxxxxxxxxxxxxx",
            "path": "/jars/example-job.jar",
            "artifactUri": "volume://my-volume/jars/example-job.jar"
        },
        "applicationType": "Java",
        "arguments": [
            "--collection",
            "medium_articles"
        ],
        "resource": {
            "driverCores": 2,
            "driverMemory": "8g",
            "executorCores": 2,
            "executorMemory": "8g",
            "minExecutors": 1,
            "maxExecutors": 10
        },
        "sparkConf": {
            "spark.sql.shuffle.partitions": "200"
        },
        "error": null,
        "submittedAt": "2026-05-20T10:00:30Z"
    }
}
Ctrl I