作业相关接口

新建作业

描述

本接口用于创建一个BSC作业。

请求

• 请求结构

  Plain Text 复制

  1POST /api/v{version}/seniorbsc/job/create HTTP/1.1
  2	
  3{
  4	CreateJobRequest
  5}

• 请求头域

  除公共头域外，无其它特殊头域。

• 请求参数

参数名称	类型	是否必需	参数位置	描述
version	String	是	URL	API版本号
CreateJobRequest	CreateJobRequest	是	RequestBody	创建作业参数

返回

• 返回头域

  除公共头域，无其它特殊头域。

• 返回参数

参数名称	类型	描述
data	CreateJobResponse	执行结果

示例

• 请求示例

  Plain Text 复制

  1POST /api/v3/seniorbsc/job/create HTTP/1.1		
  2authorization: bce-auth-v1/2f48672d408541d99c083131d9ba2926/2019-03-27T07:41:49Z/3600/host;x-bce-console-rpc-id;x-bce-date/66be528d53fb9f0716049004ebc7c93a9801e022252760be49c8b4b0428bc600
  3x-bce-console-rpc-id: 5377d020-48d4-4567-be82-dfd08af91ab0
  4x-bce-date: 2019-03-27T07:41:49Z
  5x-Region: bj	
  6{
  7	description: "",
  8    engineVersion: "2.4.6-bsc",
  9    frequency: "",
  10    name: "testApi2",
  11    priority: "",
  12    schedule: "",
  13    type: "SPARK_STREAM/SQL"
  14}

• 返回示例

  Plain Text 复制

  1HTTP/1.1 200 OK
  2Transfer-Encoding: chunked
  3Cache-Control: no-cache
  4Server: BWS
  5Date: Thu, 16 Feb 2017 02:17:26 GMT
  6Content-Type: application/json;charset=UTF-8
  7	
  8{
  9	result: {
  10        jobId: "7dd19f23d01347d594ef0e78edd80a2e"
  11    },
  12    jobId: "7dd19f23d01347d594ef0e78edd80a2e",
  13    status: 200,
  14    success: true
  15}

编辑已有作业

描述

本接口用于编辑作业。

请求

• 请求结构

  Plain Text 复制

  1POST /api/v{version}/seniorbsc/job/update/{jobId} HTTP/1.1
  2	
  3{
  4	UpdateJobRequest
  5}

• 请求头域

  除公共头域外，无其它特殊头域。

• 请求参数

参数名称	类型	是否必需	参数位置	描述
version	String	是	URL	API版本号
jobId	String	是	URL	作业Id
UpdateJobRequest	UpdateJobRequest	是	RequestBody	编辑作业参数

返回

• 返回头域

  除公共头域，无其它特殊头域。

• 返回参数

无特殊返回参数

示例

• 请求示例

  Plain Text 复制

  1POST /api/v3/seniorbsc/job/update/${jobId} HTTP/1.1
  2authorization: bce-auth-v1/2f48672d408541d99c083131d9ba2926/2019-03-27T07:41:49Z/3600/host;x-bce-		console-rpc-id;x-bce-date/66be528d53fb9f0716049004ebc7c93a9801e022252760be49c8b4b0428bc600
  3x-bce-console-rpc-id: 5377d020-48d4-4567-be82-dfd08af91ab0
  4x-bce-date: 2019-03-27T07:41:49Z
  5	
  6{
  7    code: "",
  8    description: "",
  9    name: "testApi2",
  10    properties: {
  11        jobParameter: {
  12            common: {job.output.mode: "append",job.trigger.intervalMs: "0"},
  13            job.output.mode: "append",
  14            job.trigger.intervalMs: "0"
  15        },
  16        custom: "job.stream.aggWithState=true;\njob.shuffle.partitions=200;"}
  17    jsonJobParameter: ""}
  18}

• 返回示例

  Plain Text 复制

  1HTTP/1.1 200 OK
  2Transfer-Encoding: chunked
  3Cache-Control: no-cache
  4Server: BWS
  5Date: Thu, 16 Feb 2017 02:17:26 GMT
  6Content-Type: application/json;charset=UTF-8
  7	
  8{
  9	status: 200,
  10    success: true
  11}

获取开发作业列表

描述

本接口用于获取开发作业列表。

请求

• 请求结构

  Plain Text 复制

  1POST /api/v{version}/seniorbsc/job/list HTTP/1.1
  2	
  3{
  4	ListJobsRequest
  5}

• 请求头域

  除公共头域外，无其它特殊头域。

• 请求参数

参数名称	类型	是否必需	参数位置	描述
version	String	是	URL	API版本号
ListJobsRequest	ListJobsRequest	是	RequestBody	获取作业列表参数

返回

• 返回头域

  除公共头域，无其它特殊头域。

• 返回参数

参数名称	类型	描述
pageNo	Int	当前页码
pageSize	Int	每页展示数量
totalCount	Long	总记录数
result	List<Job>	响应带回的具体数据

示例

• 请求示例

  Plain Text 复制

  1POST /api/v3/seniorbsc/job/list HTTP/1.1		
  2authorization: bce-auth-v1/2f48672d408541d99c083131d9ba2926/2019-03-27T07:41:49Z/3600/host;x-bce-console-rpc-id;x-bce-date/66be528d53fb9f0716049004ebc7c93a9801e022252760be49c8b4b0428bc600
  3x-bce-console-rpc-id: 5377d020-48d4-4567-be82-dfd08af91ab0
  4x-bce-date: 2019-03-27T07:41:49Z
  5x-Region: bj
  6{
  7	"pageNo": "页数",
  8	"pageSize": "每页数量",
  9	"jobName": "作业名",
  10	"orderBy": "排序字段",
  11	"order": "排序规则"
  12}

• 返回示例

  Plain Text 复制

  1HTTP/1.1 200 OK
  2Transfer-Encoding: chunked
  3Cache-Control: no-cache
  4Server: BWS
  5Date: Thu, 16 Feb 2017 02:17:26 GMT
  6Content-Type: application/json;charset=UTF-8
  7	
  8{
  9	"status":200,
  10	"success": true,
  11	"pageNo":当前页码,
  12	"pageSize":每页记录数,
  13	"totalCount":总记录数,
  14	"result":[
  15		{
  16		   ...
  17		},
  18		...
  19	]
  20}

获取开发作业详情

描述

本接口用于获取开发作业详情。

请求

• 请求结构

  Plain Text 复制

  1GET /api/v{version}/seniorbsc/job/detail/{jobId} HTTP/1.1
  2	

• 请求头域

  除公共头域外，无其它特殊头域。

• 请求参数

参数名称	类型	是否必需	参数位置	描述
version	String	是	URL	API版本号
jobId	Long	是	URL	作业ID

返回

• 返回头域

  除公共头域，无其它特殊头域。

• 返回参数

参数名称	类型	描述
result	Job	执行结果

示例

• 请求示例

  Plain Text 复制

  1GET /api/v3/seniorbsc/job/detail/3552 HTTP/1.1		
  2authorization: bce-auth-v1/2f48672d408541d99c083131d9ba2926/2019-03-27T07:41:49Z/3600/host;x-bce-console-rpc-id;x-bce-date/66be528d53fb9f0716049004ebc7c93a9801e022252760be49c8b4b0428bc600
  3x-bce-console-rpc-id: 5377d020-48d4-4567-be82-dfd08af91ab0
  4x-bce-date: 2019-03-27T07:41:49Z
  5x-Region: bj

• 返回示例

  Plain Text 复制

  1HTTP/1.1 200 OK
  2Transfer-Encoding: chunked
  3Cache-Control: no-cache
  4Server: BWS
  5Date: Thu, 16 Feb 2017 02:17:26 GMT
  6Content-Type: application/json;charset=UTF-8
  7	
  8{
  9	"status": 200,
  10	"success": true,
  11	"result": {
  12		instanceId: "c37b8141bd08472cbec43f0705d1bad1"，
  13        isDeleted: 0，
  14        jobId: "c2be8838d4cf469aae8cb7ab4039998a"，
  15        jobType: "STREAM"，
  16        ...
  17	}
  18}

对代码进行语法校验

描述

本接口用于检查开发作业代码。

请求

• 请求结构

  Plain Text 复制

  1POST /api/v{version}/seniorbsc/job/sql/validate HTTP/1.1
  2	
  3{
  4	ValidateSqlRequest
  5}

• 请求头域

  除公共头域外，无其它特殊头域。

• 请求参数

参数名称	类型	是否必需	参数位置	描述
version	String	是	URL	API版本号
ValidateSqlRequest	ValidateSqlRequest	是	RequestBody	检查开发作业代码参数

返回

• 返回头域

  除公共头域，无其它特殊头域。

• 返回参数

参数名称	类型	描述
result	ValidateSqlResponse	执行结果

示例

• 请求示例

  Plain Text 复制

  1POST /api/v3/seniorbsc/job/check HTTP/1.1		
  2authorization: bce-auth-v1/2f48672d408541d99c083131d9ba2926/2019-03-27T07:41:49Z/3600/host;x-bce-console-rpc-id;x-bce-date/66be528d53fb9f0716049004ebc7c93a9801e022252760be49c8b4b0428bc600
  3x-bce-console-rpc-id: 5377d020-48d4-4567-be82-dfd08af91ab0
  4x-bce-date: 2019-03-27T07:41:49Z
  5	
  6{
  7	"code": "代码",
  8    "engineType": "FLINK"
  9}

• 返回示例

  Plain Text 复制

  1HTTP/1.1 200 OK
  2Transfer-Encoding: chunked
  3Cache-Control: no-cache
  4Server: BWS
  5Date: Thu, 16 Feb 2017 02:17:26 GMT
  6Content-Type: application/json;charset=UTF-8
  7
  8{
  9	"success": true,
  10	"status": 200,
  11	"result": {
  12		"hasError": 是否有错,
  13		"errLine": 错误所在行,
  14		"errCol": 错误所在列,
  15		"errMsg": "错误信息"
  16	}
  17}

调试开发作业代码

描述

本接口用于调试开发作业代码。

请求

• 请求结构

  Plain Text 复制

  1POST /api/v{version}/seniorbsc/job/debug/{jobId} HTTP/1.1
  2	
  3{
  4	DebugJobRequest
  5}

• 请求头域

  除公共头域外，无其它特殊头域。

• 请求参数

参数名称	类型	是否必需	参数位置	描述
version	String	是	URL	API版本号
jobId	String	是	URL	作业ID
DebugJobRequest	DebugJobRequest	是	RequestBody	调试开发作业代码参数

返回

• 返回头域

  除公共头域，无其它特殊头域。

• 返回参数

参数名称	类型	描述
result	DebugJobResponse	执行结果

示例

• 请求示例

  Plain Text 复制

  1POST /api/v3/seniorbsc/job/debug/3522 HTTP/1.1
  2authorization: bce-auth-v1/2f48672d408541d99c083131d9ba2926/2019-03-27T07:41:49Z/3600/host;x-bce-console-rpc-id;x-bce-date/66be528d53fb9f0716049004ebc7c93a9801e022252760be49c8b4b0428bc600
  3x-bce-console-rpc-id: 5377d020-48d4-4567-be82-dfd08af91ab0
  4x-bce-date: 2019-03-27T07:41:49Z
  5x-Region: bj
  6{
  7	"code": "代码",
  8	"debugData": [
  9		{
  10			"sourceName":"表名",
  11			"debugValue":"测试数据"
  12		},
  13		...
  14	]		
  15}

• 返回示例

  Plain Text 复制

  1HTTP/1.1 200 OK
  2Transfer-Encoding: chunked
  3Cache-Control: no-cache
  4Server: BWS
  5Date: Thu, 16 Feb 2017 02:17:26 GMT
  6Content-Type: application/json;charset=UTF-8
  7	
  8{
  9	"status": 200,
  10	"success": true,
  11	"result: {
  12		"appId": "spark任务的id"
  13	}
  14}

获取调试作业结果

描述

本接口用于获取调试作业结果。

请求

• 请求结构

  Plain Text 复制

  1POST /api/v{version}/seniorbsc/job/debug/result/{jobId} HTTP/1.1
  2	
  3{
  4	GetDebugResultRequest
  5}

• 请求头域

  除公共头域外，无其它特殊头域。

• 请求参数

参数名称	类型	是否必需	参数位置	描述
version	String	是	URL	API版本号
jobId	String	是	URL	作业ID
GetDebugResultRequest	GetDebugResultRequest	是	RequestBody	获取调试作业结果参数

返回

• 返回头域

  除公共头域，无其它特殊头域。

• 返回参数

参数名称	类型	描述
result	GetDebugResultResponse	执行结果

示例

• 请求示例

  Plain Text 复制

  1POST /api/v3/seniorbsc/job/debug/result/3552 HTTP/1.1		
  2authorization: bce-auth-v1/2f48672d408541d99c083131d9ba2926/2019-03-27T07:41:49Z/3600/host;x-bce-console-rpc-id;x-bce-date/66be528d53fb9f0716049004ebc7c93a9801e022252760be49c8b4b0428bc600
  3x-bce-console-rpc-id: 5377d020-48d4-4567-be82-dfd08af91ab0
  4x-bce-date: 2019-03-27T07:41:49Z
  5x-Region: bj
  6{
  7	"appId": "调试作业ID",
  8	"region": "地域"		
  9}

• 返回示例

  Plain Text 复制

  1HTTP/1.1 200 OK
  2Transfer-Encoding: chunked
  3Cache-Control: no-cache
  4Server: BWS
  5Date: Thu, 16 Feb 2017 02:17:26 GMT
  6Content-Type: application/json;charset=UTF-8
  7	
  8{
  9	"status": 200,
  10	"success": true,
  11	"result": {
  12		"debugStatus": "调试的状态",
  13		"debugData": "调试的数据",
  14		"debugMsg": "调试的输出信息"
  15	}
  16}

删除作业

描述

本接口用于删除作业。

请求

• 请求结构

  Plain Text 复制

  1POST /api/v{version}/seniorbsc/job/delete/{jobId} HTTP/1.1

• 请求头域

  除公共头域外，无其它特殊头域。

• 请求参数

参数名称	类型	是否必需	参数位置	描述
version	String	是	URL	API版本号
jobId	String	是	URL	作业ID

返回

• 返回头域

  除公共头域，无其它特殊头域。

• 返回参数

无特殊返回参数

示例

• 请求示例

  Plain Text 复制

  1POST /api/v3/seniorbsc/job/delete/3552 HTTP/1.1		
  2authorization: bce-auth-v1/2f48672d408541d99c083131d9ba2926/2019-03-27T07:41:49Z/3600/host;x-bce-console-rpc-id;x-bce-date/66be528d53fb9f0716049004ebc7c93a9801e022252760be49c8b4b0428bc600
  3x-bce-console-rpc-id: 5377d020-48d4-4567-be82-dfd08af91ab0
  4x-bce-date: 2019-03-27T07:41:49Z
  5x-Region: bj

• 返回示例

  Plain Text 复制

  1HTTP/1.1 200 OK
  2Transfer-Encoding: chunked
  3Cache-Control: no-cache
  4Server: BWS
  5Date: Thu, 16 Feb 2017 02:17:26 GMT
  6Content-Type: application/json;charset=UTF-8
  7	
  8{
  9	"status": 200,
  10	"success": true
  11}

发布作业代码

描述

本接口用于发布作业代码。

请求

• 请求结构

  Plain Text 复制

  1POST /api/v{version}/seniorbsc/job/commit/{jobId} HTTP/1.1
  2	
  3{
  4	CommitJobRequest
  5}

• 请求头域

  除公共头域外，无其它特殊头域。

• 请求参数

参数名称	类型	是否必需	参数位置	描述
version	String	是	URL	API版本号
CommitJobRequest	CommitJobRequest	是	RequestBody	发布作业代码参数

返回

• 返回头域

  除公共头域，无其它特殊头域。

• 返回参数

参数名称	类型	描述
data	CommitJobResponse	执行结果

示例

• 请求示例

  Plain Text 复制

  1POST /api/v3/seniorbsc/job/commit/{JobId} HTTP/1.1		

  authorization: bce-auth-v1/2f48672d408541d99c083131d9ba2926/2019-03-27T07:41:49Z/3600/host;x-bce-console-rpc-id;x-bce-date/66be528d53fb9f0716049004ebc7c93a9801e022252760be49c8b4b0428bc600 x-bce-console-rpc-id: 5377d020-48d4-4567-be82-dfd08af91ab0 x-bce-date: 2019-03-27T07:41:49Z x-Region: bj { "withKill": true }

• 返回示例

  Plain Text 复制

  1HTTP/1.1 200 OK
  2Transfer-Encoding: chunked
  3Cache-Control: no-cache
  4Server: BWS
  5Date: Thu, 16 Feb 2017 02:17:26 GMT
  6Content-Type: application/json;charset=UTF-8
  7	
  8{
  9	"status": 200,
  10	"success": true,
  11	"result": {
  12        "instanceId": 实例Id,
  13		"version":版本号
  14	}
  15}
  16	

获取某一历史版本

描述

本接口用于获取某个作业历史某版本代码。

请求

• 请求结构

  Plain Text 复制

  1GET /api/v{version}/seniorbsc/job/history/detail/{jobId}/{jobHisId} HTTP/1.1

• 请求头域

  除公共头域外，无其它特殊头域。

• 请求参数

参数名称	类型	是否必需	参数位置	描述
version	String	是	URL	API版本号
jobId	String	是	URL	作业ID
jobHisId	Integer	是	URL	已发布代码版本号

返回

• 返回头域

  除公共头域，无其它特殊头域。

• 返回参数

参数名称	类型	描述
data	JobHistory	执行结果

示例

• 请求示例

  Plain Text 复制

  1POST /api/v3/seniorbsc/job/history/detail/{jobId}/{jobHisId} HTTP/1.1
  2authorization: bce-auth-v1/2f48672d408541d99c083131d9ba2926/2019-03-27T07:41:49Z/3600/host;x-bce-console-rpc-id;x-bce-date/66be528d53fb9f0716049004ebc7c93a9801e022252760be49c8b4b0428bc600
  3x-bce-console-rpc-id: 5377d020-48d4-4567-be82-dfd08af91ab0
  4x-bce-date: 2019-03-27T07:41:49Z
  5x-Region: bj

• 返回示例

  Plain Text 复制

  1HTTP/1.1 200 OK
  2Transfer-Encoding: chunked
  3Cache-Control: no-cache
  4Server: BWS
  5Date: Thu, 16 Feb 2017 02:17:26 GMT
  6Content-Type: application/json;charset=UTF-8
  7	
  8{
  9	"status": 200,
  10	"success": true,
  11	"resule": {
  12		"code": "代码",
  13		...
  14	}
  15}

删除某一历史版本

描述

本接口用于删除某个作业某版本已发布代码。

请求

• 请求结构

  Plain Text 复制

  1POST  /api/v{version}/seniorbsc/job/history/delete/{jobId}/{jobHisId} HTTP/1.1

• 请求头域

  除公共头域外，无其它特殊头域。

• 请求参数

参数名称	类型	是否必需	参数位置	描述
version	String	是	URL	API版本号
jobId	String	是	URL	作业ID
jobHisId	Integer	是	URL	作业历史版本号

返回

• 返回头域

  除公共头域，无其它特殊头域。

• 返回参数

无特殊返回参数

示例

• 请求示例

  Plain Text 复制

  1POST /api/v3/seniorbsc/job/history/delete/{3552}/{2} HTTP/1.1
  2authorization: bce-auth-v1/2f48672d408541d99c083131d9ba2926/2019-03-27T07:41:49Z/3600/host;x-bce-console-rpc-id;x-bce-date/66be528d53fb9f0716049004ebc7c93a9801e022252760be49c8b4b0428bc600
  3x-bce-console-rpc-id: 5377d020-48d4-4567-be82-dfd08af91ab0
  4x-bce-date: 2019-03-27T07:41:49Z
  5x-Region: bj

• 返回示例

  Plain Text 复制

  1HTTP/1.1 200 OK
  2Transfer-Encoding: chunked
  3Cache-Control: no-cache
  4Server: BWS
  5Date: Thu, 16 Feb 2017 02:17:26 GMT
  6Content-Type: application/json;charset=UTF-8
  7	
  8{
  9	"status": 200,
  10	"success": true
  11}

获取作业历史版本列表

描述

本接口用于获取某个作业历史版本列表。

请求

• 请求结构

  Plain Text 复制

  1GET /api/v{version}/seniorbsc/job/history/list/{jobId} HTTP/1.1

• 请求头域

  除公共头域外，无其它特殊头域。

• 请求参数

参数名称	类型	是否必需	参数位置	描述
version	String	是	URL	API版本号
jobId	String	是	URL	作业ID

返回

• 返回头域

  除公共头域，无其它特殊头域。

• 返回参数

参数名称	类型	描述
result	List<JobHistory>	响应带回的具体数据
pageNo	Int	当前页码
pageSize	Int	每页展示数量
totalCount	Long	总记录数

示例

• 请求示例

  Plain Text 复制

  1GET /api/v3/seniorbsc/job/history/list/{jobId} HTTP/1.1
  2authorization: bce-auth-v1/2f48672d408541d99c083131d9ba2926/2019-03-27T07:41:49Z/3600/host;x-bce-console-rpc-id;x-bce-date/66be528d53fb9f0716049004ebc7c93a9801e022252760be49c8b4b0428bc600
  3x-bce-console-rpc-id: 5377d020-48d4-4567-be82-dfd08af91ab0
  4x-bce-date: 2019-03-27T07:41:49Z
  5x-Region: bj

• 返回示例

  Plain Text 复制

  1HTTP/1.1 200 OK
  2Transfer-Encoding: chunked
  3Cache-Control: no-cache
  4Server: BWS
  5Date: Thu, 16 Feb 2017 02:17:26 GMT
  6Content-Type: application/json;charset=UTF-8
  7	
  8{
  9	"status": 200,
  10	"success": true,
  11	"pageNo": 当前页码,
  12	"pageSize": 每页记录数,
  13	"totalCount": 总记录数,
  14	"result": {
  15		[
  16			{
  17				"id": 作业执行ID,
  18				"jobId": 作业ID,
  19				"version": 版本号,
  20				"code": "代码"
  21                ...
  22			},
  23			...
  24		]
  25	}
  26}