分页获取任务列表,也可以通过条件进行筛选查询。
接口说明
需要购买 DataWorks 基础版及以上版本才能使用。
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。
授权信息
下表是API对应的授权信息,可以在RAM权限策略语句的Action
元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:
- 操作:是指具体的权限点。
- 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
- 资源类型:是指操作中支持授权的资源类型。具体说明如下:
- 对于必选的资源类型,用前面加 * 表示。
- 对于不支持资源级授权的操作,用
全部资源
表示。
- 条件关键字:是指云产品自身定义的条件关键字。
- 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作 | 访问级别 | 资源类型 | 条件关键字 | 关联操作 |
---|---|---|---|---|
dataworks:* | get | *Task acs:dataworks:{#regionId}:{#accountId}:task/* |
| 无 |
请求参数
名称 | 类型 | 必填 | 描述 | 示例值 |
---|---|---|---|---|
ProjectEnv | string | 否 | 项目环境。 枚举值:
| Prod |
ProjectId | long | 是 | 项目 ID。 | 100 |
Name | string | 否 | 名称,支持模糊查询。 | SQL node |
Ids | array | 否 | 任务的 ID 列表,可根据任务 Id 批量查询任务。 | |
long | 否 | 任务 ID。 | 1234 | |
Owner | string | 否 | 任务的责任人的账号 ID。 | 1000 |
TaskType | string | 否 | 任务类型。例如:
| ODPS_SQL |
RuntimeResource | string | 否 | 资源组信息,这里请填入调度资源组标识符。 | S_res_group_524258031846018_1684XXXXXXXXX |
WorkflowId | long | 否 | 所属工作流的 ID。 | 1234 |
TriggerType | string | 否 | 触发方式类型。 枚举值:
| Scheduler |
TriggerRecurrence | string | 否 | 触发时的运行模式,TriggerType=Scheduler 时生效。 枚举值:
| Normal |
SortBy | string | 否 | 排序字段。支持修改时间、创建时间等字段,格式为"排序字段+排序方式(Desc/Asc)"(Asc 可以缺省)。排序字段的枚举值如下:
| Id Desc |
PageSize | integer | 否 | 每页的条目数,默认为 10,最大为 1000。 | 10 |
PageNumber | integer | 否 | 页码,从 1 开始,默认为 1。 | 1 |
返回参数
示例
正常返回示例
JSON
格式
{
"RequestId": "22C97E95-F023-56B5-8852-B1A77A17XXXX\n",
"PagingInfo": {
"TotalCount": 100,
"PageSize": 10,
"PageNumber": 1,
"Tasks": [
{
"Name": "SQL node\n",
"Description": "test\n",
"WorkflowId": 1234,
"InstanceMode": "T+1",
"Type": "ODPS_SQL",
"BaselineId": 1234,
"Priority": 1,
"Timeout": 3600,
"RerunMode": "AllAllowed\n",
"RerunTimes": 3,
"RerunInterval": 60,
"Trigger": {
"Type": "Scheduler\n",
"Recurrence": "Normal\n",
"Cron": "00 00 00 * * ?",
"StartTime": "1970-01-01 00:00:00\n",
"EndTime": "9999-01-01 00:00:00\n"
},
"RuntimeResource": {
"ResourceGroupId": "S_res_group_524258031846018_1684XXXXXXXXX",
"Image": "i-xxxxxx\n",
"Cu": 0.25
},
"DataSource": {
"Name": "mysql_test\n"
},
"Id": 1234,
"ProjectId": 100,
"ProjectEnv": "Prod",
"Owner": 1000,
"CreateTime": 1710239005403,
"ModifyTime": 1710239005403,
"CreateUser": 1000,
"ModifyUser": 1000,
"ScriptParameters": "para1=$bizdate para2=$[yyyymmdd] "
}
]
}
}
错误码
访问错误中心查看更多错误码。
变更历史
变更时间 | 变更内容概要 | 操作 |
---|---|---|
2025-01-21 | OpenAPI 返回结构发生变更 | 查看变更详情 |
2025-01-15 | OpenAPI 入参发生变更 | 查看变更详情 |
2025-01-06 | OpenAPI 返回结构发生变更 | 查看变更详情 |
2024-11-20 | OpenAPI 返回结构发生变更 | 查看变更详情 |