ListQuotaWorkloads - 获取资源配额上的任务列表_人工智能平台 PAI(PAI)-阿里云帮助中心

您可以通过此API获取Quota上的任务信息列表。

调试

您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。

授权信息

当前API暂无授权信息透出。

请求语法

GET /api/v1/quotas/{QuotaId}/workloads HTTP/1.1

请求参数

名称	类型	必填	描述	示例值
QuotaId	string	是	Quota ID。	quota1y9qarq****
WorkspaceIds	string	否	查询指定的 Workspace 下的 workload 的排队信息。	1866**
WorkloadType	string	否	查询指定子产品的实例的排队信息。	dlc
WorkloadIds	string	否	查询指定 workload ID 的排队信息。	dlc123445**
BeforeWorkloadId	string	否	查询队列中指定 workload ID 之前的实例的排队信息。	dsw654433**
PageNumber	integer	否	查询的页码。	1
PageSize	integer	否	分页查询每页的大小。	10
SortBy	string	否	返回结果的排序字段。	GmtCreatedTime
Order	string	否	排队顺序。	desc
Status	string	否	在队列中状态。	Enqueued
ShowOwn	boolean	否	是否只看本资源配额对应 Workload。	true
SubQuotaIds	string	否	子资源配额 ID 列表。	quota123446,quota644322
UserIds	string	否	用户 ID 列表。	290438938,238290930
NodeName	string	否	只搜索该节点上的任务。	lrn482781276**
WorkloadCreatedTimeRange	TimeRangeFilter	否	Workload 创建时间范围搜索。
WorkloadStatuses	string	否	按 Workload 状态过滤。	Pending
GmtPositionModifiedTimeRange	TimeRangeFilter	否	Workload 队列位置变化时间范围搜索。
GmtEnqueuedTimeRange	TimeRangeFilter	否	Workload 进入队列时间范围搜索。
GmtDequeuedTimeRange	TimeRangeFilter	否	Workload 出队时间范围搜索。

返回参数

名称	类型	描述	示例值
	object	返回结果。
RequestId	string	请求 ID。	42F23B58-3684-5443-848A-8DA81FF99712
TotalCount	long	符合过滤条件的实例数量。	23
Workloads	array	Workload 信息列表。
Workloads	QueueInfo	一个 Workload 信息详情。

示例

正常返回示例

JSON格式

{
  "RequestId": "42F23B58-3684-5443-848A-8DA81FF99712",
  "TotalCount": 23,
  "Workloads": [
    {
      "WorkloadId": "dlcxxxx",
      "WorkloadType": "dlc",
      "Position": 10,
      "Priority": 2,
      "WorkspaceId": "“432524”",
      "QuotaId": "“quotamtl37ge7gkvdz”",
      "GmtEnqueuedTime": "“2023-06-22T00:00:00Z”",
      "GmtPositionModifiedTime": "\"2023-06-22T00:00:00Z\"",
      "QueueStrategy": "PaiStrategyIntelligent",
      "Name": "test-label-79f5498dd-9qrzs",
      "Code": "roleMaximumResource",
      "CodeType": "ConfigRule",
      "Reason": "Current GPU Limit is 5, limited by Role PAI.AlgoDeveloper",
      "Status": "Enqueued",
      "Resource": {
        "CPU": "100",
        "Memory": "100Gi",
        "GPU": "16",
        "GPUType": "GPU"
      },
      "UserId": "",
      "GmtDequeuedTime": "\"2023-06-22T00:00:00Z\"",
      "WorkloadStatus": "PreAllocation",
      "UserName": "",
      "WorkloadName": "",
      "GmtCreatedTime": ""
    }
  ]
}

错误码

访问错误中心查看更多错误码。

变更历史

变更时间	变更内容概要	操作
2025-02-19	OpenAPI 入参发生变更	查看变更详情