模型定义
声明：所有的请求参数，如非特殊说明，都是必填字段，用户发送请求时都需定义。
CreateJobRequest
| 参数名称 |
类型 |
描述 |
| region |
String |
作业所在地域,如保定区域为bd |
| name |
String |
作业名称，只能包含大小写英文字母，数字，下划线_，横行- |
| type |
String |
作业类型 （SPARK or FLINK） |
| engineVersion |
String |
引擎版本 |
| description |
String |
作业描述 |
CreateJobResponse
| 参数名称 |
类型 |
描述 |
| jobId |
String |
作业ID |
UpdateJobRequest
| 参数名称 |
类型 |
描述 |
| region |
String |
作业所在地域,如保定区域为bd |
| name |
String |
作业名称，只能包含大小写英文字母，数字，下划线_，横行- |
| code |
String |
Base64编码之后的code |
| properties |
JobProperties |
properties相关配置 |
JobProperties
| 参数名称 |
类型 |
描述 |
| jobParameter |
JobParameter |
作业参数 |
| jsonJobParameter |
String |
作业json参数 |
JobParameter
| 参数名称 |
类型 |
描述 |
| common |
Map[String, String] |
e.g."job.output.mode":"append","job.trigger.intervalMs" : "6000" |
| custom |
String |
用户自定义参数 |
UpdateJobResponse
| 参数名称 |
类型 |
描述 |
| jobId |
String |
作业ID |
ListJobsRequest
| 参数名称 |
类型 |
描述 |
| region |
String |
作业所在地域,如保定区域为bd |
| page |
Integer |
请求分页的总页数 |
| pageSize |
Integer |
每页大小 |
| name |
String |
作业名 |
| orderBy |
String |
排序字段 |
| order |
String |
asc或desc,顺序或倒序 |
| keyWords |
List[Map[String, String]] |
根据关键字过滤 |
Job
| 参数名称 |
类型 |
描述 |
| jobId |
String |
作业ID |
| name |
String |
作业名称，只能包含大小写英文字母，数字，下划线_，横行- |
| type |
String |
作业类型 |
| apiType |
String |
SQL or JAR |
| jobType |
String |
STREAM or BATCH |
| engineType |
String |
FLINK or SPARK |
| engineVersion |
String |
引擎版本 |
| code |
String |
base64编码之后的code |
| properties |
String |
作业属性 |
| region |
String |
作业所在地域,如保定区域为bd |
| createBy |
String |
创建人 |
| createAt |
Date |
创建时间 |
| updateBy |
String |
更新人 |
| updateAt |
Date |
更新时间 |
| deleteAt |
Date |
删除时间 |
| canCommit |
Boolean |
是否能提交 |
| accountId |
String |
账户名称 |
| description |
String |
作业描述 |
ValidateSqlRequest
| 参数名称 |
类型 |
描述 |
| engineType |
String |
代码 |
| code |
String |
代码 |
ValidateSqlResponse
| 参数名称 |
类型 |
描述 |
| hasError |
Boolean |
是否有错 |
| errLine |
Int |
错误所在行 |
| errCol |
Int |
错误所在列 |
| errMsg |
String |
错误信息 |
DebugJobParameters
| 参数名称 |
类型 |
描述 |
| region |
String |
作业所在地域,如保定区域为bd |
| debugData |
ArrayList[HashMap[String, String]] |
debug信息 |
DebugJobResponse
| 参数名称 |
类型 |
描述 |
| appId |
String |
调试作业ID |
GetDebugResultRequest
| 参数名称 |
类型 |
描述 |
| appId |
String |
调试作业ID |
| region |
String |
作业所在地域,如保定区域为bd |
GetDebugResultResponse
| 参数名称 |
类型 |
描述 |
| debugStatus |
String |
debug状态 |
| debugData |
String |
debug数据 |
| debugMsg |
String |
debug信息 |
CommitJobParameters
| 参数名称 |
类型 |
描述 |
| region |
String |
作业所在区域 |
| withKill |
Boolean |
是否重启作业 |
CommitJobResponse
| 参数名称 |
类型 |
描述 |
| version |
Integer |
版本号 |
| instanceId |
String |
作业运行Id |
JobHistory
| 参数名称 |
类型 |
描述 |
| jobHistoryId |
String |
历史作业ID |
| jobId |
String |
作业ID |
| version |
String |
版本 |
| accountId |
String |
账户名称 |
| code |
String |
base64编码之后的code |
| properties |
String |
作业属性 |
| resources |
Map[String, String] |
资源引用 |
| region |
String |
作业所在地域,如保定区域为bd |
| createUser |
String |
创建人 |
| createTime |
String |
创建时间 |
| modifyUser |
String |
更新人 |
| modifyTime |
String |
更新时间 |
| isDeleted |
Integer |
是否删除 |
| accountId |
String |
账户名称 |
| description |
String |
作业描述 |
Template
| 参数名称 |
类型 |
描述 |
| templateId |
String |
模板ID |
| region |
String |
作业区域 |
| accountId |
String |
账户名称 |
| name |
String |
模板名称 |
| type |
String |
模板类型(FLINK or SPARK) |
| category |
String |
模板类别（PUBLIC or PRIVATE） |
| code |
String |
base64编码之后的code |
| createUser |
String |
创建人 |
| createTime |
String |
创建时间 |
| modifyUser |
String |
更新人 |
| modifyTime |
String |
更新时间 |
| isDeleted |
Integer |
是否删除 |
| description |
String |
模板描述 |
![]()
