作业相关接口

更新时间：2021-10-14

新建作业

描述

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

请求

请求结构

POST /api/v{version}/seniorbsc/job/create HTTP/1.1
	
{
	CreateJobRequest
}

请求头域

除公共头域外，无其它特殊头域。
请求参数

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

返回头域

除公共头域，无其它特殊头域。
返回参数

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

示例

请求示例

POST /api/v3/seniorbsc/job/create 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	
{
	description: "",
    engineVersion: "2.4.6-bsc",
    frequency: "",
    name: "testApi2",
    priority: "",
    schedule: "",
    type: "SPARK_STREAM/SQL"
}

返回示例

HTTP/1.1 200 OK
Transfer-Encoding: chunked
Cache-Control: no-cache
Server: BWS
Date: Thu, 16 Feb 2017 02:17:26 GMT
Content-Type: application/json;charset=UTF-8
	
{
	result: {
        jobId: "7dd19f23d01347d594ef0e78edd80a2e"
    },
    jobId: "7dd19f23d01347d594ef0e78edd80a2e",
    status: 200,
    success: true
}

编辑已有作业

描述

本接口用于编辑作业。

请求

请求结构

POST /api/v{version}/seniorbsc/job/update/{jobId} HTTP/1.1
	
{
	UpdateJobRequest
}

请求头域

除公共头域外，无其它特殊头域。
请求参数

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

返回头域

除公共头域，无其它特殊头域。
返回参数

无特殊返回参数

示例

请求示例

POST /api/v3/seniorbsc/job/update/${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
	
{
    code: "",
    description: "",
    name: "testApi2",
    properties: {
        jobParameter: {
            common: {job.output.mode: "append",job.trigger.intervalMs: "0"},
            job.output.mode: "append",
            job.trigger.intervalMs: "0"
        },
        custom: "job.stream.aggWithState=true;\njob.shuffle.partitions=200;"}
    jsonJobParameter: ""}
}

返回示例

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

获取开发作业列表

描述

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

请求

请求结构

POST /api/v{version}/seniorbsc/job/list HTTP/1.1
	
{
	ListJobsRequest
}

请求头域

除公共头域外，无其它特殊头域。
请求参数

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

返回头域

除公共头域，无其它特殊头域。
返回参数

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

示例

请求示例

POST /api/v3/seniorbsc/job/list 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
{
	"pageNo": "页数",
	"pageSize": "每页数量",
	"jobName": "作业名",
	"orderBy": "排序字段",
	"order": "排序规则"
}

返回示例

HTTP/1.1 200 OK
Transfer-Encoding: chunked
Cache-Control: no-cache
Server: BWS
Date: Thu, 16 Feb 2017 02:17:26 GMT
Content-Type: application/json;charset=UTF-8
	
{
	"status":200,
	"success": true,
	"pageNo":当前页码,
	"pageSize":每页记录数,
	"totalCount":总记录数,
	"result":[
		{
		   ...
		},
		...
	]
}

获取开发作业详情

描述

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

请求

请求结构

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

请求头域

除公共头域外，无其它特殊头域。
请求参数

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

返回头域

除公共头域，无其它特殊头域。
返回参数

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

示例

请求示例

GET /api/v3/seniorbsc/job/detail/3552 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

返回示例

HTTP/1.1 200 OK
Transfer-Encoding: chunked
Cache-Control: no-cache
Server: BWS
Date: Thu, 16 Feb 2017 02:17:26 GMT
Content-Type: application/json;charset=UTF-8
	
{
	"status": 200,
	"success": true,
	"result": {
		instanceId: "c37b8141bd08472cbec43f0705d1bad1"，
        isDeleted: 0，
        jobId: "c2be8838d4cf469aae8cb7ab4039998a"，
        jobType: "STREAM"，
        ...
	}
}

对代码进行语法校验

描述

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

请求

请求结构

POST /api/v{version}/seniorbsc/job/sql/validate HTTP/1.1
	
{
	ValidateSqlRequest
}

请求头域

除公共头域外，无其它特殊头域。
请求参数

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

返回头域

除公共头域，无其它特殊头域。
返回参数

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

示例

请求示例

POST /api/v3/seniorbsc/job/check 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
	
{
	"code": "代码",
    "engineType": "FLINK"
}

返回示例

HTTP/1.1 200 OK
Transfer-Encoding: chunked
Cache-Control: no-cache
Server: BWS
Date: Thu, 16 Feb 2017 02:17:26 GMT
Content-Type: application/json;charset=UTF-8

{
	"success": true,
	"status": 200,
	"result": {
		"hasError": 是否有错,
		"errLine": 错误所在行,
		"errCol": 错误所在列,
		"errMsg": "错误信息"
	}
}

调试开发作业代码

描述

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

请求

请求结构

POST /api/v{version}/seniorbsc/job/debug/{jobId} HTTP/1.1
	
{
	DebugJobRequest
}

请求头域

除公共头域外，无其它特殊头域。
请求参数

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

返回头域

除公共头域，无其它特殊头域。
返回参数

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

示例

请求示例

POST /api/v3/seniorbsc/job/debug/3522 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
{
	"code": "代码",
	"debugData": [
		{
			"sourceName":"表名",
			"debugValue":"测试数据"
		},
		...
	]		
}

返回示例

HTTP/1.1 200 OK
Transfer-Encoding: chunked
Cache-Control: no-cache
Server: BWS
Date: Thu, 16 Feb 2017 02:17:26 GMT
Content-Type: application/json;charset=UTF-8
	
{
	"status": 200,
	"success": true,
	"result: {
		"appId": "spark任务的id"
	}
}

获取调试作业结果

描述

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

请求

请求结构

POST /api/v{version}/seniorbsc/job/debug/result/{jobId} HTTP/1.1
	
{
	GetDebugResultRequest
}

请求头域

除公共头域外，无其它特殊头域。
请求参数

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

返回头域

除公共头域，无其它特殊头域。
返回参数

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

示例

请求示例

POST /api/v3/seniorbsc/job/debug/result/3552 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
{
	"appId": "调试作业ID",
	"region": "地域"		
}

返回示例

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

删除作业

描述

本接口用于删除作业。

请求

请求结构

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

请求头域

除公共头域外，无其它特殊头域。
请求参数

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

返回头域

除公共头域，无其它特殊头域。
返回参数

无特殊返回参数

示例

请求示例

POST /api/v3/seniorbsc/job/delete/3552 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

返回示例

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

发布作业代码

描述

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

请求

请求结构

POST /api/v{version}/seniorbsc/job/commit/{jobId} HTTP/1.1
	
{
	CommitJobRequest
}

请求头域

除公共头域外，无其它特殊头域。
请求参数

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

返回头域

除公共头域，无其它特殊头域。
返回参数

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

示例

请求示例
```
POST /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 }

返回示例

HTTP/1.1 200 OK
Transfer-Encoding: chunked
Cache-Control: no-cache
Server: BWS
Date: Thu, 16 Feb 2017 02:17:26 GMT
Content-Type: application/json;charset=UTF-8
	
{
	"status": 200,
	"success": true,
	"result": {
        "instanceId": 实例Id,
		"version":版本号
	}
}

获取某一历史版本

描述

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

请求

请求结构

GET /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	执行结果

示例

请求示例

POST /api/v3/seniorbsc/job/history/detail/{jobId}/{jobHisId} 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

返回示例

HTTP/1.1 200 OK
Transfer-Encoding: chunked
Cache-Control: no-cache
Server: BWS
Date: Thu, 16 Feb 2017 02:17:26 GMT
Content-Type: application/json;charset=UTF-8
	
{
	"status": 200,
	"success": true,
	"resule": {
		"code": "代码",
		...
	}
}

删除某一历史版本

描述

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

请求

请求结构

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

请求头域

除公共头域外，无其它特殊头域。
请求参数

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

返回头域

除公共头域，无其它特殊头域。
返回参数

无特殊返回参数

示例

请求示例

POST /api/v3/seniorbsc/job/history/delete/{3552}/{2} 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

返回示例

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

获取作业历史版本列表

描述

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

请求

请求结构

GET /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	总记录数

示例

请求示例

GET /api/v3/seniorbsc/job/history/list/{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

返回示例

HTTP/1.1 200 OK
Transfer-Encoding: chunked
Cache-Control: no-cache
Server: BWS
Date: Thu, 16 Feb 2017 02:17:26 GMT
Content-Type: application/json;charset=UTF-8
	
{
	"status": 200,
	"success": true,
	"pageNo": 当前页码,
	"pageSize": 每页记录数,
	"totalCount": 总记录数,
	"result": {
		[
			{
				"id": 作业执行ID,
				"jobId": 作业ID,
				"version": 版本号,
				"code": "代码"
                ...
			},
			...
		]
	}
}

请求返回格式

模板相关接口

百度智能云

百度流式计算 BSC

百度流式计算 BSC

作业相关接口

新建作业

编辑已有作业

获取开发作业列表

获取开发作业详情

对代码进行语法校验

调试开发作业代码

获取调试作业结果

删除作业

发布作业代码

获取某一历史版本

删除某一历史版本

获取作业历史版本列表