すべてのプロダクト
Search
ドキュメントセンター

Platform For AI:ListJobs

最終更新日:Jul 15, 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

*すべてのリソース。

*

なし なし

リクエスト構文

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

任意

タスクタイプ。デフォルト値: 空。すべてのタイプを示します。有効な値:

  • TFJob

  • PyTorchJob

  • XGBoostJob

  • OneFlowJob

  • ElasticBatchJob

TFJob

Status

string

任意

タスクのステータス。有効な値:

  • Creating

  • Queuing

  • Bidding (現在 Lingjun Spot タスクのみ対象)

  • EnvPreparing

  • SanityChecking

  • Running

  • Restarting

  • Stopping

  • SucceededReserving

  • FailedReserving

  • Succeeded

  • Failed

  • Stopped

Running

StartTime

string

任意

クエリの有効値の開始時刻。タスクは作成時刻でフィルターされます。デフォルト値: 現在時刻から 7 日前。StartTime と EndTime の両方が指定されていない場合、デフォルトで過去 7 日間に作成されたタスクが返されます。

2025-04-16T07:25:34Z

EndTime

string

任意

クエリの有効値の終了時刻。タスクは作成時刻でフィルターされます。デフォルト値: 現在時刻。

2025-04-16T07:26:41Z

PageNumber

integer

任意

ページングクエリで返すページ番号。最小値: 1。デフォルト値: 1。

1

PageSize

integer

任意

1 ページあたりに返すタスクの数。

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 (true はタスクが実際にオフピークリソースを使用したことを示します)

  • AcceptQuotaOverSold-false (false はタスクが実際に保証リソースを使用したことを示します)

ForbiddenQuotaOverSold

PaymentType

string

任意

リソースタイプ。有効な値:

  • PrePaid: リソースクォータ

  • Spot: プリエンプティブルリソース

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

PostPaid

JobIds

string

任意

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

dlc123abc

DisplayNameSearchMode

string

任意

DisplayName の検索モード。デフォルト値: ワイルドカード一致。

列挙値:

  • prefix :

    prefix。

  • fulltext :

    fulltext。

  • term :

    term。

  • wildcard :

    wildcard。

wildcard

ReasonSearch

string

任意

ノードの失敗した理由フィールドに対して全文インデックスを実行してノードを取得します。中国語と英語の形態素解析に対応しています。

OOM

UserCommandSearch

string

任意

user_command フィールドに対して全文インデックスを実行してノードを取得します。中国語と英語の形態素解析に対応しています。

python train.py

ImageSearch

string

任意

images フィールドに対して全文インデックスを実行してノードを取得します。中国語と英語の形態素解析に対応しています。

pytorch

TimeRangeField

string

任意

StartTime/EndTime フィルターに使用される時間フィールド。デフォルト値: 作成時刻。

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

Description

string

任意

レスポンスフィールド

フィールド

説明

object

タスクリスト。

Jobs

array

タスクのリスト。

JobItem

単一のタスク。

TotalCount

integer

フィルター条件に一致するタスクの総数。

1

RequestId

string

診断およびトラブルシューティングに使用されるリクエスト ID。

473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E

成功レスポンス

JSONJSON

{
  "Jobs": [
    {
      "JobId": "dlc-20210126170216-********",
      "CredentialConfig": {
        "EnableCredentialInject": false,
        "AliyunEnvRoleKey": "",
        "CredentialConfigItems": [
          {
            "Key": "",
            "Type": "",
            "Roles": [
              {
                "RoleArn": "",
                "RoleType": "",
                "AssumeRoleFor": "",
                "Policy": "",
                "AssumeUserInfo": {
                  "SecurityToken": "",
                  "AccessKeyId": "",
                  "Type": "",
                  "Id": ""
                }
              }
            ]
          }
        ]
      },
      "JobType": "TFJob",
      "DisplayName": "tf-mnist-test",
      "UserVpc": {
        "VpcId": "vpc-2zed***",
        "SwitchId": "vsw-2ze6***",
        "SecurityGroupId": "sg-2zeef***",
        "ExtendedCidrs": [
          "10.2.0.0/16"
        ],
        "DefaultRoute": "eth0"
      },
      "UserId": "123456789",
      "Username": "pai-dlc-role",
      "Status": "Stopped",
      "WorkspaceId": "268",
      "WorkspaceName": "dlc-workspace",
      "ResourceId": "dlc-quota",
      "ResourceLevel": "L0",
      "ReasonCode": "JobStoppedByUser",
      "ReasonMessage": "Job is stopped by user.",
      "JobSpecs": [
        {
          "Type": "Worker",
          "Image": "registry-vpc.cn-hangzhou.aliyuncs.com/cloud-dsw/tensorflow:1.12PAI-gpu-py36-cu101-ubuntu18.04",
          "ImageConfig": {
            "DockerRegistry": "docker****registry.com",
            "Username": " username",
            "Password": "password",
            "Auth": ""
          },
          "PodCount": 1,
          "ExtraPodSpec": {
            "SideCarContainers": [
              {
                "Name": "data-init",
                "Image": "registry.cn-hangzhou.aliyuncs.com/pai-dlc/curl:v1.0.0",
                "Command": [
                  "curl www.aliyun.com"
                ],
                "Args": [
                  "-v"
                ],
                "WorkingDir": "/root",
                "Env": [
                  {
                    "Name": "ENABLE_DEBUG",
                    "Value": "true"
                  }
                ],
                "Resources": {
                  "Limits": {
                    "key": "{'cpu': '1', 'memory': '1000Mi'}"
                  },
                  "Requests": {
                    "key": "{'cpu': '1', 'memory': '1000Mi'}"
                  }
                }
              }
            ],
            "InitContainers": [
              {
                "Name": "data-init",
                "Image": "registry.cn-hangzhou.aliyuncs.com/pai-dlc/curl:v1.0.0",
                "Command": [
                  "curl www.aliyun.com"
                ],
                "Args": [
                  "-v"
                ],
                "WorkingDir": "/root",
                "Env": [
                  {
                    "Name": "ENABLE_DEBUG",
                    "Value": "true"
                  }
                ],
                "Resources": {
                  "Limits": {
                    "key": "{'cpu': '1', 'memory': '1000Mi'}"
                  },
                  "Requests": {
                    "key": "{'cpu': '1', 'memory': '1000Mi'}"
                  }
                }
              }
            ],
            "PodLabels": {
              "key": "example-lable"
            },
            "PodAnnotations": {
              "key": "example-annotation"
            },
            "SharedVolumeMountPaths": [
              "/root/share/"
            ],
            "Lifecycle": {
              "PreStop": {
                "Exec": {
                  "Command": [
                    ""
                  ]
                }
              },
              "PostStart": {
                "Exec": {
                  "Command": [
                    ""
                  ]
                }
              }
            },
            "MainContainerSecurityContext": {
              "RunAsUser": 1000,
              "RunAsGroup": 1000,
              "SeccompProfile": {
                "Type": "Unconfined",
                "LocalhostProfile": "my-profiles/profile-allow.json"
              },
              "Privileged": false,
              "Capabilities": {
                "Add": [
                  ""
                ],
                "Drop": [
                  ""
                ]
              }
            }
          },
          "ResourceConfig": {
            "CPU": "10",
            "GPU": "3",
            "Memory": "10Gi",
            "SharedMemory": "5Gi",
            "GPUType": "Tesla-V100-16G"
          },
          "UseSpotInstance": false,
          "SpotSpec": {
            "SpotStrategy": "SpotWithPriceLimit",
            "SpotDiscountLimit": 0.8,
            "SpotPriceLimit": 0.4744
          },
          "AssignNodeSpec": {
            "EnableAssignNode": true,
            "NodeNames": "lingjxxxxxxxx",
            "AntiAffinityNodeNames": "lingjxxxxxxxx",
            "HyperNodes": [
              {
                "HyperNodeName": "",
                "NodeNames": ""
              }
            ],
            "AntiAffinityHyperNodes": [
              {
                "HyperNodeName": "",
                "NodeNames": ""
              }
            ]
          },
          "LocalMountSpecs": [
            {
              "MountMode": "",
              "LocalPath": "",
              "MountPath": ""
            }
          ],
          "AutoScalingSpec": {
            "ScalingStrategy": "",
            "MinReplicas": 0,
            "MaxReplicas": 0,
            "PodsToDelete": [
              ""
            ],
            "AutoscalingMetricSpec": {
              "MetricName": "",
              "TargetValue": 0,
              "StabilizationWindowSeconds": 0,
              "Tolerance": ""
            }
          },
          "ServiceSpec": {
            "DefaultPort": 8080,
            "ServiceMode": "PerRole",
            "ExtraPorts": [
              8081
            ]
          },
          "IsCheif": false,
          "IsChief": false,
          "RestartPolicy": "ExitCode",
          "SystemDisk": {
            "Size": 0,
            "Category": "",
            "PerformanceLevel": ""
          },
          "EcsSpec": "ecs.c6.large",
          "QuotaId": "",
          "ConsiderInSuccessPolicy": false,
          "StartupDependencies": [
            {
              "Type": "",
              "OnPhase": "",
              "MinReplicas": ""
            }
          ],
          "ElasticSpotSpecs": [
            {
              "InstanceType": "",
              "SpotPriceLimit": 0,
              "SpotDiscountLimit": 0,
              "SpotStrategy": ""
            }
          ],
          "OversoldType": ""
        }
      ],
      "UserCommand": "python /root/code/mnist.py",
      "DataSources": [
        {
          "DataSourceId": "data-20210114104214-********",
          "MountPath": "/mnt/data"
        }
      ],
      "CodeSource": {
        "CodeSourceId": "code-20210111103721-********",
        "Branch": "master",
        "Commit": "44da109b59f8596152987eaa8f3b2487bb******",
        "MountPath": "/mnt/data"
      },
      "ThirdpartyLibs": [
        "numpy==1.16.1"
      ],
      "NodeNames": [
        "i-a"
      ],
      "ThirdpartyLibDir": "/root/code/",
      "Envs": {
        "key": "ENABLE_DEBUG_MODE"
      },
      "SystemEnvs": {
        "key": "ENABLE_DEBUG_MODE"
      },
      "GmtCreateTime": "2025-04-16T07:25:34Z",
      "GmtSubmittedTime": "2025-04-16T07:26:14Z",
      "GmtRunningTime": "2025-04-16T07:26:41Z",
      "GmtSuccessedTime": "2025-04-16T07:28:20Z",
      "GmtStoppedTime": "null",
      "GmtFailedTime": "null",
      "GmtFinishTime": "2025-04-16T07:28:20Z",
      "GmtModifiedTime": "2025-04-16T07:28:22Z",
      "Duration": 243,
      "JobMaxRunningTimeMinutes": 0,
      "Settings": {
        "BusinessUserId": "16****",
        "Caller": "SilkFlow",
        "Tags": {
          "key": "key:value"
        },
        "PipelineId": "pid-12****",
        "EnableTideResource": true,
        "EnableErrorMonitoringInAIMaster": false,
        "ErrorMonitoringArgs": "--enable-log-hang-detection true",
        "EnableRDMA": true,
        "EnableOssAppend": true,
        "OversoldType": "AcceptQuotaOverSold",
        "AdvancedSettings": {
          "test": "test",
          "test2": 1
        },
        "Driver": "535.54.03",
        "EnableSanityCheck": true,
        "SanityCheckArgs": "--sanity-check-timing=AfterJobFaultTolerant --sanity-check-timeout-ops=MarkJobFail",
        "JobReservedMinutes": 30,
        "JobReservedPolicy": "Always",
        "EnableCPUAffinity": true,
        "DisableEcsStockCheck": false,
        "AllocateAllRDMADevices": false,
        "EnableDSWDev": false,
        "DataJuicerConfig": {
          "ExecutionMode": "standalone",
          "CommandType": "config",
          "EnableResourceEstimation": false,
          "ResourceLimit": {
            "CPU": "2",
            "Memory": "10Gi",
            "GPU": "20"
          }
        },
        "ModelConfig": {
          "ModelName": "",
          "ModelTemplate": {
            "ModelName": "",
            "Provider": "",
            "Collections": ""
          }
        },
        "AllowUnschedulableNodes": false,
        "Shell": "/bin/bash",
        "TerminationGracePeriodSeconds": 0
      },
      "EnabledDebugger": false,
      "IsDeleted": false,
      "EnablePreemptibleJob": false,
      "ResourceName": "my_resource_group",
      "WorkingDir": "/mnt/data",
      "UserScript": "ls ",
      "RestartTimes": "1",
      "RequestCPU": 1,
      "RequestMemory": "1Gi",
      "ResourceQuotaName": "test",
      "RequestGPU": "1",
      "NodeCount": "1",
      "Priority": 1,
      "SubStatus": "Restarting",
      "UseOversoldResource": false,
      "ResourceType": "ECS",
      "Accessibility": "PUBLIC",
      "ClusterId": "****1316721349****",
      "TenantId": "****93955616****",
      "StatusHistory": [
        {
          "Status": "",
          "StartTime": "",
          "EndTime": "",
          "ReasonCode": "",
          "ReasonMessage": ""
        }
      ],
      "ElasticSpec": {
        "EnableElasticTraining": true,
        "MinParallelism": 1,
        "MaxParallelism": 8,
        "AIMasterType": "",
        "AIMasterDockerImage": "",
        "EnablePsJobElasticWorker": false,
        "EnableAIMaster": false,
        "EnablePsResourceEstimate": true,
        "EnablePsJobElasticPS": true,
        "PSMinParallelism": 4,
        "PSMaxParallelism": 10,
        "ElasticStrategy": "",
        "EnableEDP": true,
        "EDPMaxParallelism": 16,
        "EDPMinParallelism": 8
      },
      "Pods": [
        {
          "Type": "Worker",
          "PodId": "dlc-20210126170216-mtl37ge7gkvdz-worker-0",
          "PodUid": "fe846462-af2c-4521-bd6f-96787a57591d",
          "Status": "Stopped",
          "Ip": "10.0.1.2",
          "GmtCreateTime": "2021-01-12T14:36:01Z",
          "GmtStartTime": "2021-01-12T14:36:05Z",
          "GmtFinishTime": "2021-01-12T15:36:05Z",
          "HistoryPods": [
            {
              "Type": "Worker",
              "PodId": "dlc-20210126170216-mtl37ge7gkvdz-worker-0",
              "PodUid": "fe846462-af2c-4521-bd6f-96787a57591d",
              "Status": "Stopped",
              "Ip": "10.0.1.2",
              "GmtCreateTime": "2021-01-12T14:36:01Z",
              "GmtStartTime": "2021-01-12T14:36:05Z",
              "GmtFinishTime": "2021-01-12T15:36:05Z",
              "HistoryPods": [
                {
                  "Type": "Worker",
                  "PodId": "dlc-20210126170216-mtl37ge7gkvdz-worker-0",
                  "PodUid": "fe846462-af2c-4521-bd6f-96787a57591d",
                  "Status": "Stopped",
                  "Ip": "10.0.1.2",
                  "GmtCreateTime": "2021-01-12T14:36:01Z",
                  "GmtStartTime": "2021-01-12T14:36:05Z",
                  "GmtFinishTime": "2021-01-12T15:36:05Z",
                  "HistoryPods": [],
                  "SubStatus": "",
                  "NodeName": "",
                  "PodIp": "",
                  "PodIps": [
                    {
                      "InterfaceName": "",
                      "Ip": ""
                    }
                  ]
                }
              ],
              "SubStatus": "",
              "NodeName": "",
              "PodIp": "",
              "PodIps": [
                {
                  "InterfaceName": "",
                  "Ip": ""
                }
              ]
            }
          ],
          "SubStatus": "",
          "NodeName": "",
          "PodIp": "",
          "PodIps": [
            {
              "InterfaceName": "",
              "Ip": ""
            }
          ]
        }
      ],
      "TemplateId": "",
      "TemplateName": "",
      "JobReplicaStatuses": [
        {
          "Type": "",
          "Active": 0,
          "EstimatedPodCount": 0,
          "EstimatedAutoScalingSpec": {
            "ScalingStrategy": "",
            "MinReplicas": 0,
            "MaxReplicas": 0,
            "PodsToDelete": [
              ""
            ],
            "AutoscalingMetricSpec": {
              "MetricName": "",
              "TargetValue": 0,
              "StabilizationWindowSeconds": 0,
              "Tolerance": ""
            }
          },
          "EstimatedResourceConfig": {
            "CPU": "10",
            "GPU": "3",
            "Memory": "10Gi",
            "SharedMemory": "5Gi",
            "GPUType": "Tesla-V100-16G"
          },
          "Queuing": 0,
          "Dequeued": 0,
          "CurrentSpotInstanceType": ""
        }
      ],
      "SchedulingStrategy": "",
      "RetryCount": 0
    }
  ],
  "TotalCount": 1,
  "RequestId": "473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E"
}

エラーコード

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

変更履歴

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