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

Sparkジョブを一覧表示 (V2)

この操作では、Zilliz Cloudクラスターに関連付けられた Spark バッチジョブを一覧表示します。

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

https://api.cloud.zilliz.com

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

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

値の例： Bearer {{TOKEN}}
Acceptstringheader

application/json を使用します。

値の例： application/json
typestringquery必要

一覧表示するジョブタイプです。このパラメータを SPARK に設定します。

値の例： SPARK
clusterIdstringquery必要

Sparkジョブを一覧表示する対象の Zilliz Cloudクラスターです。

値の例： in01-xxxxxxxxxxxxxxx
regionIdstringquery

Zilliz Cloudクラスターのクラウドリージョンです。指定する場合は、clusterId のリージョンと一致している必要があります。

値の例： aws-us-west-2
currentPageintegerquery

ページ番号です。デフォルト値は 1 です。

値の例： 1
pageSizeintegerquery

1ページあたりの Sparkジョブ数です。デフォルト値は 20、最大値は 100 です。

値の例： 20
bash
export TOKEN="YOUR_API_KEY"

curl --request GET \
--url "${BASE_URL}/v2/jobs?type=SPARK&clusterId=in01-xxxxxxxxxxxxxxx" \
--header "Authorization: Bearer ${TOKEN}" \
--header "Accept: application/json" \
--header "Request-Timeout: 5" \
--header "Content-Type: application/json"
レスポンス200 OK - application/json

Sparkジョブのリストを返します。

codeinteger

レスポンスコードです。

dataobject

Sparkジョブと総件数を含むレスポンスペイロードです。

totalinteger

Sparkジョブの総数です。

値の例： 1
itemsarray

Sparkジョブの概要です。

[]itemsobject

Spark バッチジョブの概要情報です。

jobIdstring必要

コントロールプレーンのジョブ ID です。

projectIdstring必要

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

typestring必要

ジョブタイプです。Sparkジョブの場合、値は SPARK です。

descriptionstring

ジョブの説明。

statusstring必要

Spark バッチジョブのステータスです。

regionIdstring必要

Sparkジョブが実行されるクラウドリージョンです。

clusterIdstring

Sparkジョブに関連付けられた Zilliz Cloudクラスターです。

createdAtstring

Sparkジョブが作成された時刻です。

startedAtstring

Sparkジョブの実行が開始された時刻です。ジョブの開始前は、このフィールドが存在しない場合があります。

finishedAtstring

Sparkジョブが終了ステータスに達した時刻です。アクティブなジョブでは、このフィールドが存在しない場合があります。

durationSecondsinteger<int64>

経過実行時間（秒）です。アクティブなジョブの場合、この値は現在時刻までで計算されます。

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

codeinteger

レスポンスコードです。

messagestring

エラーメッセージです。

Successjson
{
    "code": 0,
    "data": {
        "total": 1,
        "items": [
            {
                "jobId": "job-xxxxxxxxxxxxxxxxxx",
                "type": "SPARK",
                "description": "daily-vector-etl",
                "status": "RUNNING",
                "regionId": "aws-us-west-2",
                "clusterId": "in01-xxxxxxxxxxxxxxx",
                "createdAt": "2026-05-20T10:00:00Z",
                "startedAt": "2026-05-20T10:01:00Z",
                "finishedAt": null,
                "durationSeconds": 300,
                "projectId": "proj-xxxxxxxxxxxxxxxxxxxx"
            }
        ]
    }
}
Ctrl I