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

List Spark Jobs (V2)

This operation lists Spark batch jobs associated with a Zilliz Cloud cluster.

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

https://api.cloud.zilliz.com

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

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

値の例： 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必要

ジョブタイプ。

descriptionstring

ジョブの説明。

statusstring必要

ジョブのステータス。

regionIdstring必要

クラウドリージョン ID。

clusterIdstring

クラスター ID。

createdAtstring

作成時刻 (ISO 8601)。

startedAtstring

開始時刻 (ISO 8601)。

finishedAtstring

終了時刻 (ISO 8601)。

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