すべてのプロダクト
Search

このプロダクト

    Platform For AI:ListJobs

    ドキュメントセンター

    Platform For AI:ListJobs

    最終更新日:Apr 09, 2026

    ページ分割、ソート、フィルターが可能なジョブのリストを取得します。

    今すぐお試しください

    この API を OpenAPI Explorer でお試しください。手作業による署名は必要ありません。呼び出しに成功すると、入力したパラメーターに基づき、資格情報が組み込まれた SDK コードが自動的に生成されます。このコードをダウンロードしてローカルで使用できます。

    テスト

    RAM 認証

    下表に、この API を呼び出すために必要な認証情報を示します。認証情報は、RAM (Resource Access Management) ポリシーを使用して定義できます。以下で各列名について説明します。

    • アクション：特定のリソースに対して実行可能な操作。ポリシー構文ではAction要素として指定します。

    • API：アクションを具体的に実行するための API。

    • アクセスレベル：各 API に対して事前定義されているアクセスの種類。有効な値：create、list、get、update、delete。

    • リソースタイプ：アクションが作用するリソースの種類。リソースレベルでの権限をサポートするかどうかを示すことができます。ポリシーの有効性を確保するため、アクションの対象として適切なリソースを指定してください。

      • リソースレベルの権限を持つ API の場合、必要なリソースタイプはアスタリスク (*) でマークされます。ポリシーのResource要素で対応する ARN を指定してください。

      • リソースレベルの権限を持たない API の場合、「すべてのリソース」と表示され、ポリシーのResource要素でアスタリスク (*) でマークされます。

    • 条件キー：サービスによって定義された条件のキー。このキーにより、きめ細やかなアクセス制御が可能になります。この制御は、アクション単体に適用することも、特定のリソースに対するアクションに適用することもできます。Alibaba Cloud は、サービス固有の条件キーに加えて、すべての RAM 統合サービスに適用可能な一連の共通条件キーを提供しています。

    • 依存アクション：ある特定のアクションを実行するために、前提として実行が必要となる他のアクション。依存アクションの権限も RAM ユーザーまたは RAM ロールに付与する必要があります。

    アクション

    アクセスレベル

    リソースタイプ

    条件キー

    依存アクション

    paidlc:ListJobs

    get

    *All Resource

    *

    		 なし なし

    リクエスト構文

    GET /api/v1/jobs HTTP/1.1

    リクエストパラメーター

    パラメーター

    型

    必須 / 任意

    説明

    例
    DisplayName

    string

    任意

    ジョブの名前。このパラメーターでは、大文字と小文字を区別しない部分一致がサポートされます。たとえば、値に test を指定すると、test-job1、job-test、job-test2、job-Test には一致しますが、job-t1 には一致しません。このパラメーターを空のままにした場合、ジョブは名前でフィルターされません。

    tf-mnist-test
    JobType

    string

    任意

    ジョブのタイプ。このパラメーターを指定しない場合、API はすべてのタイプのジョブを返します。有効な値：

    • TFJob

    • PyTorchJob

    • XGBoostJob

    • OneFlowJob

    • ElasticBatchJob

    TFJob
    Status

    string

    任意

    ジョブのステータス。有効な値：

    • Creating

    • Queuing

    • Bidding (このステータスは Lingjun スポットジョブにのみ適用されます)

    • EnvPreparing

    • SanityChecking

    • Running

    • Restarting

    • Stopping

    • SucceededReserving

    • FailedReserving

    • Succeeded

    • Failed

    • Stopped

    Running
    StartTime

    string

    任意

    クエリの時間範囲の開始時刻。デフォルトでは、ジョブは作成時刻 (GmtCreateTime) でフィルターされます。デフォルト値は、現在の時刻の 7 日前です。StartTime と EndTime の両方を指定しない場合、API は過去 7 日間に作成されたジョブを返します。

    2025-04-16T07:25:34Z
    EndTime

    string

    任意

    クエリの時間範囲の終了時刻。デフォルト値は現在の時刻です。

    2025-04-16T07:26:41Z
    PageNumber

    integer

    任意

    ページングクエリのページ番号。1 から始まり、デフォルトは 1 です。

    1
    PageSize

    integer

    任意

    各ページで返すジョブの数。

    50
    SortBy

    string

    任意

    ジョブのソートに使用するフィールド。有効な値：

    • DisplayName

    • JobType

    • Status

    • GmtCreateTime

    • GmtFinishTime

    GmtCreateTime
    Order

    string

    任意

    結果のソート順。有効な値：

    • desc：降順 (デフォルト)。

    • asc：昇順。

    列挙値:

    • asc :

      asc

    • desc :

      desc

    desc
    ShowOwn

    boolean

    任意

    現在のユーザーによって送信されたジョブのみを返すかどうかを指定します。

    true
    WorkspaceId

    string

    任意

    ワークスペースの ID。

    1****
    ResourceId

    string

    任意

    リソースグループの ID。専用リソースグループの ID を照会する方法の詳細については、「リソースクォータの管理」をご参照ください。

    r*****
    BusinessUserId

    string

    任意

    ジョブに関連付けられているユーザー ID。

    16****
    Caller

    string

    任意

    呼び出し元の識別子。

    local
    Tags

    object

    任意

    ジョブのフィルターに使用するタグ。

    string

    任意

    単一のタグ。

    recommandation
    PipelineId

    string

    任意

    指定されたパイプライン ID によって作成されたジョブのみを含むようにジョブリストをフィルターします。

    flow-*******
    FromAllWorkspaces

    boolean

    任意

    すべてのワークスペースからジョブを取得するかどうかを指定します。このパラメーターは、現在のユーザーによって送信されたジョブをクエリするために ShowOwn=true と一緒に使用する必要があります。

    false
    JobId

    string

    任意

    ジョブ ID。このパラメーターでは大文字と小文字は区別されません。部分一致およびワイルドカード文字はサポートされていません。このパラメーターを空のままにした場合、ジョブはジョブ ID でフィルターされません。

    dlc********
    UserIdForFilter

    string

    任意

    ジョブ送信者のユーザー ID でジョブリストをフィルターします。

    20**************
    Username

    string

    任意

    ジョブ送信者のユーザー名でジョブリストをフィルターします。部分一致はサポートされていますが、ワイルドカード文字はサポートされていません。このパラメーターを空のままにした場合、ジョブはユーザー名でフィルターされません。

    test***
    ResourceQuotaName

    string

    任意

    リソースクォータの名前でジョブリストをフィルターします。部分一致はサポートされていますが、ワイルドカード文字はサポートされていません。このパラメーターを空のままにした場合、ジョブはリソースクォータ名でフィルターされません。

    quota***
    Accessibility

    string

    任意

    ジョブの可視性。有効な値：

    • PUBLIC：ジョブはワークスペース内の全員に表示されます。

    • PRIVATE (デフォルト)：ジョブはその所有者とワークスペースの管理者のみに表示されます。

    列挙値:

    • PUBLIC :

      PUBLIC

    • PRIVATE :

      PRIVATE

    PRIVATE
    OversoldInfo

    string

    任意

    アイドルリソースの使用状況に基づいてジョブをフィルターします。有効な値：

    • ForbiddenQuotaOverSold

    • ForceQuotaOverSold

    • AcceptQuotaOverSold-true：ジョブはアイドルリソースを使用しました。

    • AcceptQuotaOverSold-false：ジョブは保証リソースを使用しました。

    ForbiddenQuotaOverSold
    PaymentType

    string

    任意

    リソースの支払いタイプ。有効な値：

    • PrePaid：リソースクォータ

    • Spot：スポットリソース

    • PostPaid：パブリックリソース

    PostPaid
    JobIds

    string

    任意

    ジョブ ID のコンマ区切りリスト。JobIds と JobId の両方が指定されている場合、JobId が優先されます。

    dlc123abc
    DisplayNameSearchMode

    string

    任意

    DisplayName パラメーターの検索モード。デフォルト値は wildcard です。

    列挙値:

    • prefix :

      prefix

    • fulltext :

      fulltext

    • term :

      term

    • wildcard :

      wildcard

    wildcard
    ReasonSearch

    string

    任意

    ジョブの失敗理由を示す reason フィールドで全文検索を実行します。検索は中国語と英語の両方の形態素解析をサポートしています。

    OOM
    UserCommandSearch

    string

    任意

    user_command フィールドで全文検索を実行します。検索は中国語と英語の両方の形態素解析をサポートしています。

    python train.py
    ImageSearch

    string

    任意

    images フィールドで全文検索を実行します。検索は中国語と英語の両方の形態素解析をサポートしています。

    pytorch
    TimeRangeField

    string

    任意

    StartTime と EndTime を使用したフィルターに使用する時間ベースのフィールドを指定します。このパラメーターが指定されていない場合、デフォルトで GmtCreateTime (ジョブの作成時間) が使用されます。

    GmtFinishTime
    NumericRangeField

    string

    任意

    数値範囲フィルターに使用するフィールド。このパラメーターは NumericRangeMin および NumericRangeMax と一緒に使用する必要があります。

    RequestGPU
    NumericRangeMin

    integer

    任意

    数値範囲フィルターの最小値 (この値を含む)。このパラメーターは NumericRangeField と一緒に使用する必要があります。

    4

    NumericRangeMax

    integer

    任意

    数値範囲フィルターの最大値 (この値を含む)。このパラメーターは NumericRangeField と一緒に使用する必要があります。

    8
    EnableAssignNode

    string

    任意

    指定されたノードで実行するように設定されているかどうかに基づいてジョブをフィルターします。

    列挙値:

    • true :

      true

    • false :

      false

    true
    TemplateId

    string

    任意

    作成元のテンプレートの ID でジョブをフィルターします。

    tmlabc123

    レスポンスフィールド

    フィールド

    型

    説明

    例

    object

    応答データ。

    Jobs

    array

    ジョブオブジェクトの配列。

    JobItem

    ジョブオブジェクト。

    TotalCount

    integer

    フィルター条件に一致するジョブの総数。

    1
    RequestId

    string

    リクエスト ID。トラブルシューティングに使用されます。

    473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E

    エラーコード

    完全なリストについては、「エラーコード」をご参照ください。

    変更履歴

    完全なリストについては、「変更履歴」をご参照ください。