ListSemanticJobs - 查询语义任务列表

更新时间:
复制 MD 格式

分页查询当前租户的语义任务定义。列表项中的 Name、ProjectId 和 Source 可分别复用于运行/删除、运行详情查询和核对输入范围。

接口说明

使用场景

分页查询当前租户已保存的语义任务定义,用于展示任务列表、选择任务运行或获取任务所属工作空间。

调用流程

  1. 通过 PageNumberPageSize 分页读取 Data.SemanticJobs

  2. 使用列表项的 Name 调用 RunSemanticJobDeleteSemanticJobListSemanticJobRuns

  3. 使用列表项的 ProjectId 配合 ExecutorJobId 调用详情、日志和停止接口。

注意事项

本接口返回的是任务定义,不是实时运行状态;运行情况请查询 ListSemanticJobRuns

调试

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

调试

授权信息

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

请求参数

名称

类型

必填

描述

示例值

PageNumber

integer

页码,从 1 开始;省略或小于等于 0 时按第 1 页处理。

1

PageSize

integer

每页返回的任务定义数;省略或小于等于 0 时默认 50,最大 200。

50

请根据各请求字段的说明构造调用参数。

返回参数

名称

类型

描述

示例值

object

分页查询任务定义的标准响应。Data.SemanticJobs 中每项都是可用于后续运行或查询的任务定义。

RequestId

string

请求 ID。用于定位日志和排查问题。

676271D6-53B4-57BE-89FA-72F7AE1418DF

Success

boolean

请求是否成功

Data

object

任务定义分页结果。使用列表项 Name 运行、删除、查询运行记录或下载结果;使用 ProjectId 查询运行详情、日志或停止运行。

TotalCount

integer

当前租户内符合条件的任务定义总数。

1

PageNumber

integer

本次返回的页码,从 1 开始。

1

PageSize

integer

本次返回的每页任务定义数。

50

SemanticJobs

array<object>

任务定义列表。

array<object>

一个已保存的语义任务定义,其字段含义与 CreateSemanticJob 的 Data 一致。

Id

integer

任务定义的内部唯一 ID。

1

Name

string

任务名称;用于 RunSemanticJob、DeleteSemanticJob、ListSemanticJobRuns 和 DownloadSemanticResults。

semantic-job-demo

UserId

string

语义任务创建者的用户标识。

user-demo

Creator

string

语义任务创建者的用户标识。

user-demo

ProjectId

integer

任务所属工作空间 ID;用于 GetSemanticJobDetail、GetSemanticJobLog 和 KillSemanticJob。

100

Type

string

任务保存的 Source.type 数据源类型。

maxcompute

Source

object

任务保存的输入数据源配置;运行时据此选择分析范围。

ReferenceFileIds

array

任务关联的上传文件 ID 列表。

string

可选的已上传参考文件 ID 列表。

semantic-job-value

ReferenceFileUris

array

任务关联的外部参考文件 URI 列表。

string

可选的可访问参考文件 URI 列表。

semantic-job-value

GmtCreate

integer

创建时间,单位为毫秒的 Unix 时间戳。

1700000000000

GmtModified

integer

最近修改时间,单位为毫秒的 Unix 时间戳。

1700000000000

ResourceGroupId

string

运行本任务时使用的资源组标识。

rg-demo

响应字段含义和后续调用关系请参阅各字段说明。

示例

正常返回示例

JSON格式

{
  "RequestId": "676271D6-53B4-57BE-89FA-72F7AE1418DF",
  "Success": true,
  "Data": {
    "TotalCount": 1,
    "PageNumber": 1,
    "PageSize": 50,
    "SemanticJobs": [
      {
        "Id": 1,
        "Name": "semantic-job-demo",
        "UserId": "user-demo",
        "Creator": "user-demo",
        "ProjectId": 100,
        "Type": "maxcompute",
        "Source": {
          "test": "test",
          "test2": 1
        },
        "ReferenceFileIds": [
          "semantic-job-value"
        ],
        "ReferenceFileUris": [
          "semantic-job-value"
        ],
        "GmtCreate": 1700000000000,
        "GmtModified": 1700000000000,
        "ResourceGroupId": "rg-demo"
      }
    ]
  }
}

错误码

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

变更历史

更多信息,参考变更详情