任务运维中心OpenAPI

此手册用于记录大数据开发与管理平台中，任务运维产品所有对外开放的OpenAPI，阅读此手册，你将了解任务运维产品开放的OpenAPI能力与调用方法。

一、公共参数

1.1 响应格式

1.2 异常响应码

1.2.1 公共响应码

1.2.2 业务响应码

1.3 枚举列表

1.3.1 ExecJobStatusEnum

1.3.2 ExecFlowStatusEnum

1.3.3 JobTypeEnum

描述：节点类型

1.3.4 ScheduleTypeEnum

1.3.5 SchedulePeriodEnum

1.3.6 ExecTypeEnum

1.3.7 AlertRuleTypeEnum

1.3.8 ExecConcurrentOptionEnum

1.3.9 ExecFailureActionEnum

1.3.10 RerunNofityConditionEnum

1.3.11 CalendarEffectModeEnum

描述：交易日日历生效方式

1.3.12 CalendarStatusEnum

描述：交易日日历状态

1.3.13 BackfillNofityConditionEnum

1.3.14 BackfillStatusEnum

1.3.15 YarnApplicationTypeEnum

描述：yarn任务类型，开发平台提交的yarn类型默认为以下3种：

1.3.16 ExecSourceEnum

描述：yarn任务来源

1.4 响应实体列表

1.4.1 PageResult

分页查询结果

1.4.2 ExecOverview

实例统计概览

1.4.3 AlertRule

1.4.4 AlertRuleObject

1.4.5 UserInfo

1.4.6 ExecFlow

1.4.7 ExecFlowDetail

1.4.8 ExecFlowSetting

1.4.9 ExecFlowJob

1.4.10 ExecFlowJobLog

1.4.11 ExecFlowRerunResult

1.4.12 AlertChannelConf

1.4.13 ScheduleCalendar

描述：交易日日历信息

1.4.14 SchedulePeriodInfo

描述：调度周期信息

1.4.15 RetrySetting

1.4.16 RecycleSetting

1.4.17 BackfillDetail

1.4.18 BackfillFlow

1.4.19 BackfillSetting

1.4.20 FlowExecHistory

1.4.21 Tag

1.4.22 TagValue

1.4.23 YarnExecJob

1.4.24 FinishHourlyTrend

实例统计概览

1.5 请求实体列表

1.5.1 AlertRuleCreateReq

1.5.2 AlertRuleObjectReq

1.5.3 RerunSettingReq

1.5.4 RerunNotifyReq

1.5.5 BackFillNotifyReq

1.5.6 BackfillSettingReq

1.5.7 BackfillFlowReq

1.5.8 RecycleSettingReq

1.5.9 RetrySettingReq

1.5.10 FlowIdReq

二、OpenAPI列表

2.1 OpenAPI总览

2.2 大盘统计

2.2.1 实例大盘统计

GET /dashboard/v1/flow/execOverview/get

产品版本：v1.3.0

描述：按项目、时间范围统计调度实例状态

URL参数/请求体

请求示例：

curl -X GET 'http://easytaskops-dev.service.163.org/api/openapi/dashboard/v1/flow/execOverview/get?product=intern&clusterId=dev4&date=1648569600000'

响应体

响应示例：

{

    "code":0,

    "msg":null,

    "result":{

        "scheduleTaskNum":287,

        "totalTaskNum":287,

        "planExecTaskNum":226,

        "planExecInstanceNum":3656

    },

    "reqId":"20968bf538ba4454a5c71c49bed56563",

    "cost":518

}

2.2.2 任务完成统计接口

GET /dashboard/v1/flow/finishTrend/get

产品版本：v1.9.2

描述：按项目、时间范围统计调度实例完成率（每30分钟，最多返回2天）

URL参数/请求体

请求示例：

curl -X GET 'http://easytaskops-dev.service.163.org/api/openapi/dashboard/v1/flow/finishTrend/get?product=intern&clusterId=dev4&date=1648569600000'

响应体

响应示例：

{

    "code":0,

    "msg":null,

    "result":\[{

            "time":1694881800000

            "totalNum":97

            "finishNum":3

    },{

            "time":1694883600000

            "totalNum":97

            "finishNum":9

    }\]

    "reqId":"20968bf538ba4454a5c71c49bed56563",

    "cost":518

}

2.3 任务

2.3.1 任务告警规则列表

GET /flow/v1/alert/list

产品版本：v1.4.1

描述：获取任务下所有告警规则

URL参数/请求体

请求示例：

curl -i -X GET \

'http://easy-opena[pi.bdms.service.163.org/openapi/easytaskops/flow/v1/alert/list?clusterId=dev4&produt=intern&flow=tttt\_copy1&project=e57d9d08843843289f262501d149d15e&user=wei.chen@corp.netease.com'](http://easy-openapi.bdms.service.163.org/openapi/easytaskops/flow/v1/alert/list?clusterId=dev4&produt=intern&flow=tttt_copy1&project=e57d9d08843843289f262501d149d15e&user=wei.chen@corp.netease.com)

响应体

响应示例：

{

    "code": 0,

    "result": \[

        {

            "id": 1333,

            "ruleType": "FLOW\_FAIL",

            "ruleObject": {

                "flowAliasName": "tttt\_copy1",

                "flow": "tttt\_copy1"

            },

            "channelIds": \[

                1

            \],

            "flowOwner": true,

            "recycleSetting": {

                "maxTimes": 2,

                "interval": 60000,

                "reportEnable": false

            }

        }

    \],

    "reqId": "59fec9e1fad744849723389a4d62bad2",

    "cost": 73

}

2.3.2 保存任务告警规则

POST /flow/v1/alert/upsert

产品版本：v1.4.1

描述：创建、覆盖任务告警规则。如果不存在则新增，存在则覆盖

URL参数/请求体

请求示例：

curl -i -X POST \\

   -H "Content-Type:application/json" \\

   -d \\

'{

  "clusterId":"dev4",

  "flow":"tttt\_copy1\_1",

  "product":"intern",

  "project":"f554c4c1973d40a5bf53d22ed557babd",

  "rules":\[

    {

      "alertObject":{

        "flow":"tttt\_copy1",

        "type":"FLOW"

      },

      "channelIds":\[

        1\],

      "flowOwner":true,

      "recycleSetting":{

        "interval":60000,

        "maxTimes":2

      },

      "ruleType":"FLOW\_FAIL"

    }\],

  "user":"wei.chen@corp.netease.com"

}

' \\

 'http://easy-openapi.bdms.service.163.org/openapi/easytaskops/flow/v1/alert/upsert'

响应体

响应示例：

{

"code":0,

"result":true,

"reqId":"2c57154fb4484f84a1b067e30e60dc26",

"cost":453

}

2.3.3 删除任务下告警规则

POST /flow/v1/alert/delete

产品版本：v1.4.1

描述：删除任务下所有告警规则

URL参数/请求体

请求示例：

curl -i -X POST \\

   -H "Content-Type:application/json" \\

   -d \\

'{

  "clusterId":"dev4",

  "flow":"tttt\_copy1",

  "product":"intern",

  "project":"e57d9d08843843289f262501d149d15e",

  "user":"wei.chen@corp.netease.com"

}

' \\

 'http://easy-openapi.bdms.service.163.org/openapi/easytaskops/flow/v1/alert/delete'

响应体

响应示例：

{

"code":0,

"result":true,

"reqId":"2c57154fb4484f84a1b067e30e60dc26",

"cost":453

}

2.3.4 批量设置标签

GET /flow/v1/tag/batch-set

产品版本：v1.8.6

描述：批量设置标签

URL参数/请求体

请求示例：

curl -i -X POST \\

   -H "Content-Type:application/json" \\

   -d \\

'{

  "clusterId":"dev4",

  "product":"intern",

  "tagValueId":1,

  "flows":\[{"flow":"ai3-test","project":"c7c377776af8467ca79a36d1dcafbcf8"}\],

  "user":"wei.chen@corp.netease.com"

}

' \\

 'http://easy-openapi.bdms.service.163.org/openapi/easytaskops/flow/v1/tag/batch-set'

响应体

响应示例：

{

    "code": 0,

    "result": true,

    "reqId": "fd02022b17114a2f8c9ef1ee774c01e4",

    "cost": 513

}

2.4 实例

2.4.1 实例列表

POST /sched/v1/exec/list

产品版本：v1.4.1

描述：搜索实例列表

URL参数/请求体

请求示例：

curl -i -X POST  \\

   -H "Content-Type:application/json" \\

   -d \\

'{

  "product":"intern",

  "submitEndTime":1652796252196,

  "pageOffset":0,

  "pageSize":25,

  "clusterId":"dev4",

  "pageNum":1,

  "user":"wei.chen@corp.netease.com",

  "scheduleEndTime":1652796252196,

  "scheduleStartTime":1652716800000

}

' \\

 'http://easy-openapi.bdms.service.163.org/openapi/easytaskops/sched/v1/exec/list'

响应体

响应示例：

 {

    "code": 0,

    "result": {

        "pageNum": 1,

        "pageSize": 2,

        "totalPage": 1826,

        "totalCount": 3653,

        "list": \[

            {

                "execId": 2883487,

                "flow": "dqc\_demo08",

                "project": "edbfad9efcb6446bb0381c9b9c88c05b",

                "execStatus": "FAILED",

                "scheduleTime": 1652533020000,

                "submitTime": 1652796301595,

                "startTime": 1652796303588,

                "endTime": 1652796614470,

                "flowAliasName": "dqc\_demo08",

                "yarnQueue": "intern\_new",

                "yarnId": "",

                "highPriority": false,

                "execType": "SCHEDULE",

                "periodInfo": {

                    "type": "PERIOD",

                    "periodUnit": "MINUTE",

                    "periodValue": 5

                },

                "owner": {

                    "fullName": "金雨鑫",

                    "user": "jinyuxin@corp.netease.com"

                }

            },

            {

                "execId": 2883496,

                "flow": "dqc\_demo08",

                "project": "edbfad9efcb6446bb0381c9b9c88c05b",

                "execStatus": "FAILED",

                "scheduleTime": 1652533320000,

                "submitTime": 1652796361596,

                "startTime": 1652796364960,

                "endTime": 1652796691876,

                "flowAliasName": "dqc\_demo08",

                "yarnQueue": "intern\_new",

                "yarnId": "",

                "highPriority": false,

                "execType": "SCHEDULE",

                "periodInfo": {

                    "type": "PERIOD",

                    "periodUnit": "MINUTE",

                    "periodValue": 5

                },

                "owner": {

                    "fullName": "金雨鑫",

                    "user": "jinyuxin@corp.netease.com"

                }

            }

        \]

    },

    "reqId": "4c441a4f37ac449686a9d312a8692a7d",

    "cost": 109

}

2.4.2 实例详情

GET /sched/v1/exec/detail

产品版本：v1.4.1

描述：获取实例详情

URL参数/请求体

请求示例：

curl -i -X GET \

'http://easy-opena[pi.bdms.service.163.org/openapi/easytaskops/sched/v1/exec/detail/get?clusterId=dev4&product=intern&execId=2877323&user=wei.chen%40corp.netease.com'](http://easy-openapi.bdms.service.163.org/openapi/easytaskops/sched/v1/exec/detail/get?clusterId=dev4&product=intern&execId=2877323&user=wei.chen%40corp.netease.com)

响应体

响应示例：

 {

    "code": 0,

    "result": {

        "execId": 2877323,

        "flow": "mysql-check",

        "project": "ddb3d6ed7fc04cc89b530c5303003885",

        "execStatus": "FAILED",

        "scheduleTime": 1652717400000,

        "submitTime": 1652717449990,

        "startTime": 1652717452373,

        "endTime": 1652717489721,

        "flowAliasName": "mysql-check",

        "execType": "SCHEDULE",

        "periodInfo": {

            "type": "PERIOD",

            "periodUnit": "MINUTE",

            "periodValue": 10

        },

        "executionSetting": {

            "failureAction": "FINISH\_CURRENTLY\_RUNNING",

            "retrySetting": {

                "maxTimes": 3,

                "interval": 1000

            },

            "highPriority": false,

            "yarnId": "default",

            "yarnQueue": "intern\_new"

        },

        "execJobs": \[

            {

                "job": "default\_B74BC5",

                "jobAliasName": "default\_B74BC5",

                "attempt": 0,

                "startTime": 1652717452389,

                "endTime": 1652717458294,

                "status": "SUCCEEDED",

                "type": "vertical\_sql"

            },

            {

                "job": "mysql",

                "jobAliasName": "mysql",

                "attempt": 3,

                "startTime": 1652717478678,

                "endTime": 1652717489690,

                "status": "FAILED",

                "type": "mysql"

            },

            {

                "job": "mysql-check",

                "jobAliasName": "mysql-check",

                "attempt": 0,

                "startTime": 1652717489702,

                "endTime": 1652717489702,

                "status": "CANCELLED",

                "type": "noop"

            }

        \],

        "owner": {

            "fullName": "祝联新",

            "user": "zhulianxin@corp.netease.com"

        }

    },

    "reqId": "17079c34c7224fe4825fb72688504b78",

    "cost": 678

}

2.4.3 实例重跑

GET /sched/v1/exec/rerun

产品版本：v1.4.1

描述：实例重跑

URL参数/请求体

请求示例：

curl -i -X POST \\

   -H "Content-Type:application/json" \\

   -d \\

'{

  "product":"intern",

  "clusterId":"dev4",

  "user":"wei.chen@corp.netease.com",

  "execId":2879865,

    "executionSetting":

  {

    "failureAction":"CANCEL\_ALL",

    "highPriority":true,

    "yarnId":"default",

    "yarnFullQueue":"root.queue\_cur.sla",

    "parameters":{

      "d":"2022-01-01"

    },

    "retrySetting":{

      "maxTimes":2,

      "interval":60000

    },

    "jobIds":\["sql1"\]

  },

  "notifyConfig":{

    "conditions":\[

      "SUCCEEDED",

      "FAILED"\],

    "channelIds":\[

      1,

      2\],

    "flowOwner":true,

    "currentUser":true,

    "customUsers":\[

      "wei.chen@corp.netease.com"\]

  }

}

' \\

 'http://easy-openapi.bdms.service.163.org/openapi/easytaskops/sched/v1/exec/rerun'

响应体

响应示例：

{

    "code": 0,

    "msg": null,

    "result": {

        "execId": 2883515

    },

    "reqId": "932050a9dc5d4e14bb3e7e7b291ec4d3",

    "cost": 632

}

2.4.4 实例终止

POST /sched/v1/exec/kill

产品版本：v1.4.1

描述：终止实例

URL参数/请求体

请求实例：

curl -i -X POST \\

   -H "Content-Type:application/json" \\

   -d \\

'{

  "product":"intern",

  "clusterId":"dev4",

  "user":"wei.chen@corp.netease.com",

  "execId":2883515

}

' \\

 'http://easy-openapi.bdms.service.163.org/openapi/easytaskops/sched/v1/exec/kill'

响应体

响应示例：

{

"code":0,

"result":true,

"reqId":"2c57154fb4484f84a1b067e30e60dc26",

"cost":453

}

2.5 日志

2.5.1 实例节点日志

GET /log/v1/job/get

产品版本：v1.4.1

描述：获取节点日志，可以根据返回的offset+length作为下次请求的起始offset（正序读）。如果倒序读取，第一次请求offset为-1，第二次请求中的offset为第一次请求返回的offset-需要读取的长度。

URL参数/请求体

请求示例：

# 从尾部开始往上查(tail)

curl -i -X GET \

'http://easy-openapi.bdms.service.1[63.org/openapi/easytaskops/log/v1/job/get?clusterId=dev4&product=intern&execId=2883515&user=wei.chen%40corp.netease.com&job=sql1&attempt=0&length=100&offset=-1'](http://easy-openapi.bdms.service.163.org/openapi/easytaskops/log/v1/job/get?clusterId=dev4&product=intern&execId=2883515&user=wei.chen%40corp.netease.com&job=sql1&attempt=0&length=100&offset=-1)

# 从头部开始往下查(head)

curl -i -X GET \

'http://easy-openapi.bdms.service.1[63.org/openapi/easytaskops/log/v1/job/get?clusterId=dev4&product=intern&execId=2883515&user=wei.chen%40corp.netease.com&job=sql1&attempt=0&length=100&offset=27526'](http://easy-openapi.bdms.service.163.org/openapi/easytaskops/log/v1/job/get?clusterId=dev4&product=intern&execId=2883515&user=wei.chen%40corp.netease.com&job=sql1&attempt=0&length=100&offset=-1)

响应体

响应示例：

 {

    "code":0,

    "result":{

        "offset":27526,

        "data":"inTrackingURI: http://hadoop335.photo.163.org:8088/cluster/app/application\_1646013605590\_179749\\n}\\n20",

        "length":100

    },

    "reqId":"bd112e9cc3c547d1963e5401bf761066",

    "cost":738

}

2.6 补数据

2.6.1 指定任务补数据

POST /backfill/v1/no-cascade/create

产品版本：v1.4.1

描述：补指定任务（不会自动补下游任务）

URL参数/请求体

请求示例：

curl -i -X POST \\

   -H "Content-Type:application/json" \\

   -d \\

'{

  "clusterId":"dev4",

  "name":"补数据任务\_20220517\_19331",

  "concurrentSize":5,

  "crossSelfDepend":false,

  "flows":\[

    {

      "flow":"tttt\_copy1\_1",

      "project":"f554c4c1973d40a5bf53d22ed557babd"

    }\],

  "executionSetting":

  {

    "failureAction":"CANCEL\_ALL",

    "highPriority":true,

    "yarnId":"default",

    "yarnFullQueue":"root.intern\_new.default",

    "parameters":{

      "d":"2022-01-01"

    },

    "retrySetting":{

      "maxTimes":2,

      "interval":60000

    }

  },

  "notifyConfig":{

    "conditions":\[

      "SUCCEEDED",

      "FAILED",

      "CANCELED"\],

    "channelIds":\[

      1,

      2\],

    "flowOwner":true,

    "currentUser":true,

    "customUsers":\[

      "wei.chen@corp.netease.com"\]

  },

  "leftTime":1652630400000,

  "product":"intern",

  "rightTime":1652787165744,

  "timeReverse":false,

  "user":"wei.chen@corp.netease.com"

}

' \\

 'http://easy-openapi.bdms.service.163.org/openapi/easytaskops/backfill/v1/no-cascade/create'

响应体

响应示例：

{

    "code": 0,

    "result": 100000485,

    "reqId": "fd02022b17114a2f8c9ef1ee774c01e4",

    "cost": 513

}

2.6.2 查询补数据详情

GET /backfill/v1/detail/get

产品版本：v1.4.1

描述：获取补数据详情

URL参数/请求体

请求示例：

curl -i -X GET \

'http://easy-opena[pi.bdms.service.163.org/openapi/easytaskops/backfill/v1/detail/get?clusterId=dev4&product=intern&id=100000485&user=wei.chen%40corp.netease.com'](http://easy-openapi.bdms.service.163.org/openapi/easytaskops/backfill/v1/detail/get?clusterId=dev4&product=intern&id=100000485&user=wei.chen%40corp.netease.com)

响应体

响应示例：

{

    "code": 0,

    "result": {

        "id": 100000485,

        "name": "补数据任务\_\_20220517\_221330",

        "leftTime": 1652630400000,

        "rightTime": 1652787165744,

        "startTime": 1652796812626,

        "status": "RUNNING\_EXCEPTION",

        "creator": {

            "fullName": "朱晨璐",

            "user": "zhuchenlu@corp.netease.com"

        },

        "concurrentSize": 5,

        "timeReverse": false,

        "crossSelfDepend": false,

        "executionSetting": {

            "failureAction": "CANCEL\_ALL",

            "retrySetting": {

                "maxTimes": 2,

                "interval": 60000

            },

            "parameters": {

                "d": "2022-01-01"

            },

            "highPriority": true,

            "yarnId": "default",

            "yarnQueue": "intern\_new"

        },

        "flows": \[

            {

                "flowAliasName": "tttt\_copy1",

                "flow": "tttt\_copy1",

                "project": "e57d9d08843843289f262501d149d15e",

                "periodInfo": {

                    "type": "PERIOD",

                    "periodUnit": "DAY",

                    "periodValue": 1

                }

            }

        \]

    },

    "reqId": "fd02022b17114a2f8c9ef1ee774c01e4",

    "cost": 513

}

2.6.3 补数据任务终止

POST /backfill/v1/kill

产品版本：v1.8.2

描述：补数据任务终止

URL参数/请求体

请求示例：

curl -i -X POST \\

   -H "Content-Type:application/json" \\

   -d \\

'{

  "clusterId":"dev4",

  "id":100000485,

  "product":"intern",

  "user":"wei.chen@corp.netease.com"

}

' \\

 'http://easy-openapi.bdms.service.163.org/openapi/easytaskops/backfill/v1/kill'

响应体

响应示例：

{

"code":0,

"result":true,

"reqId":"2c57154fb4484f84a1b067e30e60dc26",

"cost":453

}

2.7 标签

2.7.1 获取项目标签列表

GET /tag/v1/list

产品版本：v1.8.6

描述：获取所有标签

URL参数/请求体

请求示例：

curl -i -X GET \\

 'http://easy-openapi.bdms.service.163.org/openapi/easytaskops/tag/v1/list?clusterId=dev4&product=intern&user=wei.chen%40corp.netease.com'

响应体

响应示例：

{

    "code": 0,

    "result": {

        "pageNum": 1,

        "pageSize": 25,

        "totalPage": 1,

        "totalCount": 2,

        "list": \[

            {

                "id": 1,

                "name": "标签1",

                "description": "这是一个描述",

                "values": \[

                    {

                        "id": 1,

                        "value": "值1"

                    }

                \]

            },

            {

                "id": 2,

                "name": "标签2",

                "description": "这是一个描述",

                "values": \[

                    {

                        "id": 2,

                        "value": "值123422"

                    },

                    {

                        "id": 4,

                        "value": "值12322"

                    }

                \]

            }

        \]

    },

    "reqId": "9daddce816b34fc0a0ff7315b29477f0",

    "cost": 767

}

2.8 Yarn任务

2.8.1 获取运行中yarn任务列表

GET /yarn/v1/running/list

产品版本：v1.8.8

描述：获取所有运行中的yarn任务列表。目前只支持提交到azkaban上运行的任务

URL参数/请求体

请求示例：

curl -i -X GET \\

 'http://easy-openapi.bdms.service.163.org/openapi/easytaskops/yarn/v1/running/list?clusterId=dev4&user=wei.chen%40corp.netease.com'

响应体

响应示例：

{

    "code": 0,

    "result": \[

        {

            "applicationId": "application\_1694163532253\_194174",

            "product": "intern",

            "execId": 17253017,

            "flow": "dqcbada1dd8c5be55c2cf5c8645cd7f301e",

            "project": "",

            "jobId": "dqcbada1dd8c5be55c2cf5c8645cd7f301e",

            "jobAliasName": "dqcbada1dd8c5be55c2cf5c8645cd7f301e",

            "startTime": 1698134520668,

            "flowAliasName": "dqcbada1dd8c5be55c2cf5c8645cd7f301e",

            "yarnFullQueue": "root.intern\_new.default",

            "execType": "DEV\_EXECUTE",

            "submitter": {

                "fullName": "闫贤",

                "user": "yanxian01@corp.netease.com"

            },

            "applicationType": "SPARK",

            "execSource": "DQC"

        },

        {

            "applicationId": "application\_1694163532253\_160274",

            "product": "intern",

            "execId": 17174412,

            "flow": "20230804\_up\_02",

            "project": "7e4d434e7d9c4bfdb5c29be4dd5db4c8",

            "jobId": "up\_02",

            "jobAliasName": "up\_02",

            "startTime": 1697529995092,

            "flowAliasName": "20230804\_up\_02",

            "yarnFullQueue": "root.intern\_1.default",

            "execType": "SCHEDULE",

            "submitter": {

                "fullName": "孙伟鹏",

                "user": "sunweipeng01@corp.netease.com"

            },

            "applicationType": "SPARK",

            "execSource": "OFFLINE\_SCHEDULE"

        }

    \],

    "reqId": "4775908bcb2a407ebd5c55d783fb6ed3",

    "cost": 454

}

2.8.2 终止实例

POST /yarn/v1/kill

产品版本：v1.8.8

描述：终止实例，包括开发环境运行的实例

URL参数/请求体

请求实例：

curl -i -X POST \\

   -H "Content-Type:application/json" \\

   -d \\

'{

  "product":"intern",

  "clusterId":"dev4",

  "user":"wei.chen@corp.netease.com",

  "execId":2883515

}

' \\

 'http://easy-openapi.bdms.service.163.org/openapi/easytaskops/yarn

 /v1/kill'

响应体

响应示例：

{

"code":0,

"result":true,

"reqId":"2c57154fb4484f84a1b067e30e60dc26",

"cost":453

}