最近更新版本 ： Sloth_v3.9.11

一 公共参数 1.1 响应格式

1.2 响应码(1000~9999)

1.3 公共枚举定义 1.3.1 EngineTypeEnum

1.3.2 StartMode

1.3.3 JobStatusEnum 任务运行状态

1.4 查询实体列表 1.4.1 JobTaskConfig 任务参数配置 字段说明：

1.4.2 JobResourceConfig

1.4.3 CheckpointMode

1.4.4 StateBackend 存储介质

1.4.5 RestartStrategy 重启策略

如果没有启用 checkpointing，则使用无重启 (no restart) 策略。 如果启用了 checkpointing，但没有配置重启策略，则使用固定间隔 (fixed-delay) 策略 fixed-delay 需要传入重启失败次数和重试时间间隔 failure-rate 需要传入 重启失败次数、重启时间范围、重试时间间隔 1.4.6 StartJobInfo 任务启动参数配置

• 字段说明：

1.4.7 StopJobInfo 任务停止参数配置

1.4.8 RestartJobInfo 任务重启参数配置

1.4.9 AlarmInfo 告警信息配置

1.4.10 AlarmRule 告警规则

1.4.11 ParamSetInfo

1.5 响应实体列表 1.5.1 JobBasicInfo

1.5.2 ResourceFileSimpleInfo

1.5.3 UdfSimpleInfo 注意: 手动选择函数依赖的方式, udfList参数中不会显示udf信息,请尽快下线, 推荐采用对接udf stuido的新方式使用.

1.5.4 StartJobResult

1.5.5 StopJobResult

1.5.6 RestartJobResult

1.5.7 JobStatus

二、OpenAPI列表 2.1 OpenAPI总览

2.1.1 新建SQL 任务 POST /job/v2/sql/create

• 版本：3.9.10
• 描述：创建SQL类型的任务
• URL参数/请求体

请求示例：

{
    "product":"sloth",
    "clusterId":"dev4",
    "user":"xxxx@corp.netease.com",
    "jobName":"jarName",
    "engineType":"FLINK1_12_0",
    "folderPath":"/tmp/dir",
    "rawSql":"this is sql",
    "description":"sql job description",
    "dependencyIds":[
        1,
        2,
        4
    ],
    "paramSetList":[
        {
            "id":1,
            "priority":1
        },
        {
            "id":2,
            "priority":2
        }
    ],
    "jobTaskConfig":{
        "checkpointSwitch":true,
        "checkpointMode":"EXACTLY_ONCE"
    },
    "jobResourceConfig":{
        "resourceInstanceName":"sloth_yarn_cluster_name",
        "queueName":"sloth_queue_name"
    }
}

返回示例：

{
    "code": 0,
    "msg": "success",
    "result": {
        "jobId":"104722"
    },
    "requestId": null,
    "reqId": null,
    "cost": 2072,
    "success": true
}

2.1.2 修改SQL任务 POST /job/v2/sql/modify

• 版本：3.9.10
• 描述：修改SQL类型的任务
• URL参数/请求体

请求示例：

{
    "jobId": "104722",
    "product": "sloth",
    "clusterId": "dev4",
    "user": "xxxx@corp.netease.com",
    "jobName": "jarName",
    "engineType": "FLINK1_12_0",
    "folderPath": "/tmp/dir",
    "rawSql": "this is sql",
    "description": "sql job description",
    "dependencyIds": [
        1,
        2,
        4
    ],
    "paramSetInfo" : [
        {
            "id" : 1,
            "priority" : 1            
        },
        {
            "id" : 2,
            "priority" : 2            
        }
    ],
    "jobTaskConfig" : {
        "checkpointSwitch" : true,
        "checkpointMode" : "EXACTLY_ONCE"
    },
    "jobResourceConfig" : {
        "resourceInstanceName" : "sloth_yarn_cluster_name",
        "queueName" : "sloth_queue_name"
    }
}

返回示例：

{
    "code": 0,
    "msg": "success",
    "result": null,
    "requestId": null,
    "reqId": null,
    "cost": 2072,
    "success": true
}

2.1.3 获取任务信息 POST /job/v2/detail

• 版本：3.9.10
• 描述：获取最新版本任务信息
• URL参数/请求体：

• 请求示例：

{
    "user": "xxxxxx@corp.netease.com",
    "product": "sloth",
    "clusterId": "dev4",
    "jobId": 1000056
}

• 响应体描述：

• 响应体示例：

{
    "code": 0,
    "msg": "success",
    "result": {
        "jobBasicInfo": {
            "jobId": 1000056,
            "jobName": "测试任务2-rename",
            "jobType": "SQL",
            "rawSql": "[{\"cellType\":\"flink.sql\",\"enable\":true,\"key\":\"743a695f-9099-11ec-ad7c-fa163ea49987\",\"source\":[\"--SQL\",\"--********************************************************************--\",\"--Author: 杨晓航\",\"--CreateTime: 2021-12-09 15:57:41\",\"--Comment: 请输入业务注释信息\",\"--********************************************************************--\",\"CREATE TABLE user_log (\",\"user_id VARCHAR,\",\"item_id VARCHAR,\",\"category_id VARCHAR,\",\"behavior VARCHAR,\",\"ts VARCHAR\",\") WITH (\",\"'connector' = 'datagen'\",\"-- , 'number-of-rows' = '10'\",\");\",\"\",\"create table print_table WITH ('connector' = 'print')\",\"LIKE user_log (EXCLUDING ALL);\",\"\",\"insert into print_table\",\"select * from user_log;\"],\"title\":\"SQL\"}]",
            "udfList": [
                {
                    "uid" : "xxxxxxxxxx"
                    "name": "udf_function",
                    "Name": "com.xxx.xx",
                    "resourceUid": "xxxxxxxxx",
                    "md5":"xxxxxx"
                }
            ],
            "paramSetList": [
                {
                "id" : 1,
                "name" : "sloth_param_set_1"
                "priority" : 1,                           
                },
                {
                "id" : 2,
                "name" : "sloth_param_set_2"
                "priority" : 2,                           
                }
            ]
            "fileList": [],
            "creator": "xxxxxx@corp.netease.com",
            "createTime": "2021-12-09T07:57:41.000+0000",
            "publisher": "xxxxxx@corp.netease.com",
            "env": 381,
            "category": 351,
            "tags": [],
            "description": "xxxxxx",
            "lastStartJobExecHistoryId": 2745,
            "startExecId": 2036,
            "lastResourceInstanceId": 1,
            "jobStatus": "FAILED",
            "applicationId": "",
            "flinkUrl": "http://sloth-test2.dg.163.org:8088/proxy/application_1645065290019_0491/#/overview",
            "monitorUrl": "http://sloth.bdms.netease.com/grafana/d/rZuGINgWk/sloth?orgId=1&var-jobAppKey=1000056&var-jobSource=sloth&from=1648028948000&to=1648696837704"
        }
    },
    "requestId": dcaf583d,
    "success": true
}

POST /job/v2/delete

• 版本：3.9.10
• 描述：删除调用方传入的任务列表
• URL参数/请求体：

• 请求示例：

{
    "user": "xxxxx@corp.netease.com",
    "product": "sloth",
    "clusterId": "dev4",
    "jobIds": "1000074,1000071"
}

• 响应体：

返回操作记录的id

{
    "code":0,
    "msg":"success",
    "result":1354,
    "requestId":"dcaf583d",
    "success":true
}

2.1.5 启动任务 POST /job/v2/start

• 版本：3.9.10
• 描述：启动调用方传入的任务
• URL参数/请求体：

• 请求示例：

{
    "user": "xxxxxx@corp.netease.com",
    "product": "sloth",
    "clusterId": "dev4",
    "jobInfos": [
        {
            "jobId": 1000074,
            "startMode": "NONE",
            "statePath": "hdfs://dev4/user/sloth/sloth-fs-savepoints/spt/ckp-111"
        }
    ]
}

• 响应体描述：

• 响应体示例：

{
    "code":0,
    "msg":"success",
    "result":{
        "results":[
            {
                "jobId":1000074,
                "jobName":"testOpenApi",
                "isSuccess":true,
                "errorMessage":""
            }
        ]
    },
    "requestId":"914abf5efc64444d92f92418e3c9840c",
    "success":true
}

2.1.6 停止任务 POST /job/v2/stop

• 版本：3.9.10
• 描述：停止调用方传入的任务
• URL参数/请求体：

• 请求示例：

{
    "user":"wanglei20@corp.netease.com",
    "product":"sloth",
    "clusterId":"dev4",
    "jobInfos":[
        {
            "jobId":1000096,
            "triggerSavepoint":false
        }
    ]
}

• 响应体描述：

• 响应体实例：

{
    "code":0,
    "msg":"success",
    "result":{
        "results":[
            {
                "jobId":1000096,
                "jobName":"sqlOpenApiTest3",
                "isSuccess":true,
                "errorMessage":""
            }
        ]
    },
    "requestId":"9483bdc3f6d84be7a74f26cb78bd4b6a",
    "success":true
}

2.1.7 重启任务 POST /job/v2/restart

• 版本：3.9.10
• 描述：重新启动调用方传入的任务
• URL参数/请求体：

• 请求示例：

{
    "user":"xxxxxx@corp.netease.com",
    "product":"sloth",
    "clusterId":"dev4",
    "jobInfos":[
        {
            "jobId":1000096,
            "startMode":"NONE",
            "statePath":"",
            "triggerSavepoint":false
        }
    ]
}

• 响应体描述：

• 响应体实例：

{
    "code":0,
    "msg":"success",
    "result":{
        "results":[
            {
                "jobId":1000096,
                "isSuccess":true,
                "errorMessage":""
            }
        ]
    },
    "requestId":"19cd594800684549aa420e100f241fc5",
    "success":true
}

2.1.8 获取任务当前状态 POST /job/v2/status

• 版本：3.9.10
• 描述：批量获取调用方传入任务的当前状态信息
• URL参数/请求体：

• 请求示例：

{
    "user":"xxxxx@corp.netease.com",
    "product":"sloth",
    "clusterId":"dev4",
    "jobIds":"100056"
}

• 响应体描述：

• 响应体实例：

{
    "code":0,
    "msg":"success",
    "result":{
        "jobStatusList":[
            {
                "jobId":"1000056",
                "jobStatus":"FAILED"
            }
        ]
    },
    "requestId":"dcaf583d",
    "success":true
}