文档

ListServerlessJobs - 查询Serverless作业列表

按照过滤条件查询Serverless作业列表。

调试

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

授权信息

下表是API对应的授权信息,可以在RAM权限策略语句的Action元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:

  • 操作:是指具体的权限点。
  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:
    • 对于必选的资源类型,用背景高亮的方式表示。
    • 对于不支持资源级授权的操作,用全部资源表示。
  • 条件关键字:是指云产品自身定义的条件关键字。
  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作访问级别资源类型条件关键字关联操作
ehpc:ListServerlessJobsRead
  • 全部资源
    *

请求参数

名称类型必填描述示例值
RegionIdstring

地域 ID。 您可以调用 ListRegions 查询可以使用 E-HPC 的地域列表。

cn-hangzhou
ClusterIdstring

集群 ID。

您可以通过调用 ListClusters 获取集群 ID。

ehpc-hz-FYUr32****
PageNumberlong

页码。起始值:1,默认值:1。

1
PageSizelong

每页显示条数。最大值:100,默认值:20。

20
JobIdsarray

Serverless 作业 ID 或子任务 ID(数组作业)列表。

string

Serverless 作业 ID 或子任务 ID(数组作业)。

5
JobNamesarray

Serverless 作业名列表。

string

Serverless 作业名。

testjob
Statestring

Serverless 作业状态。取值范围:

  • All:所有状态。
  • Pending: 排队中。
  • Running:运行中。
  • Succeeded:已完成。
  • Canceled:已取消。
  • Failed:运行失败。

默认值:All。

Running
StartOrderstring

按照 Serverless 作业启动时间进行排序。取值范围:

  • Asc:升序。
  • Desc:降序。
Asc
SubmitOrderstring

按照 Serverless 作业提交时间进行排序。取值范围:

  • Asc:升序。
  • Desc:降序。
Asc
SubmitTimeStartstring

最早的作业提交时间戳。

说明 用于按照 Serverless 作业的提交时间范围查询作业列表。
1647427667
SubmitTimeEndstring

最晚的作业提交时间戳。

说明 用于按照 Serverless 作业的提交时间范围查询作业列表。
1659521430

返回参数

名称类型描述示例值
object

Schema of Response

TotalCountinteger

本次请求条件下的数据总条数。

1
RequestIdstring

请求 ID。

04F0F334-1335-436C-A1D7-6C044FE7****
PageSizelong

分页查询时设置的本页条数。

20
PageNumberlong

当前页码。

1
Jobsobject []

Serverless 作业信息列表。

JobIdstring

Serverless 作业 ID 或子任务 ID(数组作业)。

5
JobNamestring

Serverless 作业名。

testjob
Statestring

Serverless 作业状态。可能的值:

  • Pending: 排队中。
  • Initing:初始化中。
  • Running:运行中。
  • Succeeded:已完成。
  • Canceled:已取消。
  • Failed:运行失败。
Running
Prioritystring

Serverless 作业的调度优先级。取值范围:0~999,取值越大,优先级越高。

9
Queuestring

执行 Serverless 作业的队列名。

comp
Userstring

执行 Serverless 作业的用户名。

testuser
SubmitTimestring

Serverless 作业提交时间戳。

1647423718
StartTimestring

Serverless 作业开始时间戳。

1647427667
EndTimestring

Serverless 作业结束时间戳。

1682128871
IsArrayJobboolean

是否是数组作业。可能的值:

  • True:是数组作业。
  • False:不是数组作业。
True

示例

正常返回示例

JSON格式

{
  "TotalCount": 1,
  "RequestId": "04F0F334-1335-436C-A1D7-6C044FE7****",
  "PageSize": 20,
  "PageNumber": 1,
  "Jobs": [
    {
      "JobId": "5",
      "JobName": "testjob",
      "State": "Running",
      "Priority": "9",
      "Queue": "comp",
      "User": "testuser",
      "SubmitTime": "1647423718",
      "StartTime": "1647427667",
      "EndTime": "1682128871",
      "IsArrayJob": true
    }
  ]
}

错误码

HTTP status code错误码错误信息描述
400InvalidParamsThe specified parameter %s is invalid.无效的参数:%s
400NotEnabledYou have not enabled this service您的账户还未开通此服务
404ClusterNotFoundThe specified cluster does not exist.指定的集群不存在,请您检查该参数是否正确。
404ManagerNotFoundThe manager nodes do not exist or their status is abnormal.管理节点不存在或状态异常。
406DbErrorA database service error occurred.数据库请求失败
406EcsErrorAn error occurred while calling the ECS API operation.ECS API调用出错
406RedisErrorA Redis service error occurred.Redis请求失败
406AliyunErrorAn Alibaba Cloud product error occurred.阿里云产品错误
406AgentErrorThe agent service request failed: %s代理请求失败
407NotAuthorizedYou are not authorized by RAM for this request.此请求未获得RAM授权
500UnknownErrorAn unknown error occurred.未知错误
503ServiceUnavailableThe request has failed due to a temporary failure of the server请求失败,服务暂时不可用

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

变更历史

变更时间变更内容概要操作
2023-07-21OpenAPI 错误码发生变更看变更集
变更项变更内容
错误码OpenAPI 错误码发生变更
    错误码 406 变更
    删除错误码:400
    删除错误码:404
    删除错误码:407
    删除错误码:500
    删除错误码:503
2023-07-17OpenAPI 错误码发生变更、OpenAPI 入参发生变更、OpenAPI 返回结构发生变更看变更集
变更项变更内容
错误码OpenAPI 错误码发生变更
    删除错误码:400
    删除错误码:404
    删除错误码:406
    删除错误码:407
    删除错误码:500
    删除错误码:503
入参OpenAPI 入参发生变更
    删除入参:Users
    删除入参:Queues
出参OpenAPI 返回结构发生变更
  • 本页导读 (1)
文档反馈