作业相关接口

更新时间：2019-08-01

创建SQL作业

描述

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

请求

请求结构

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

请求头域

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

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

返回头域

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

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

示例

请求示例

POST /api/v2/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
	
{
	"region": "地域",
	"name": "作业名",
	"type": "bigsql",
	"decription": "描述信息"
}

返回示例

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": 0,
	"msg": "操作成功！",
	"data": {
	"jobId": 作业ID
     }
}

创建spark作业

描述

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

请求

请求结构

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

请求头域

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

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

返回头域

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

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

示例

请求示例

POST /api/v2/seniorbsc/job/spark/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
	
{
	"region": "地域",
	"name": "作业名",
	"type": "spark23",
	"fileName": "文件名",
	"file": "文件内容",
	"bosBucket": "bos bucket",
	"bosObject": "bos object",
	"description": "作业描述",
	"mainClass": "启动类"
}

返回示例

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": 0,
	"msg": "操作成功！",
	"data": {
		"jobId":作业ID
	}
}

编辑spark作业

描述

本接口用于编辑一个spark作业。

请求

请求结构

POST /api/v{version}/seniorbsc/job/spark/update HTTP/1.1
	
{
	UpdateSparkJobParameters
}

请求头域

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

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

返回头域

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

无特殊返回参数

示例

请求示例

POST /api/v2/seniorbsc/job/spark/update 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
	
{
	"jobId": "作业ID",
	"name": "作业名",
	"type": "spark23",
	"fileName": "文件名",
	"file": "文件内容",
	"bosBucket": "bos bucket",
	"bosObject": "bos object",
	"decription": "作业描述",
	"mainClass": "启动类"
}

返回示例

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": 0,
	"msg": "操作成功！"
}

获取开发作业列表

描述

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

请求

请求结构

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

请求头域

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

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

返回头域

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

参数名称	类型	描述
page	Int	当前页码
size	Int	每页展示数量
total	Long	总记录数
pageTotal	Long	总页数
items	List<BscJob>	响应带回的具体数据

示例

请求示例

POST /api/v2/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
	
{
	"region": "地域",
	"page": "页数",
	"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":0,
	"msg":"操作成功!",
	"page":当前页码,
	"size":每页记录数,
	"total":总记录数,
	"pageTotal":总页数,
	"items":[
		{
			"id":作业ID,
			"accountId":"用户帐号",
			"name":"作业名称",
			"type":"bigsql",
			"region":"地域",
			"createBy":"创建人",
			"createAt":创建时间,
			"updateBy":"更新人",
			"updateAt":更新时间,
			"deleteAt":删除时间,
			"executionId":执行ID,
			"canCommit":是否能提交,
			"description":"作业描述"
		},
		...
	]
}

获取开发作业详情

描述

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

请求

请求结构

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

请求头域

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

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

返回头域

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

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

示例

请求示例

GET /api/v2/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

返回示例

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": 0,
	"msg": "操作成功！",
	"data": {
		"name":"作业名称",
		"description":"作业描述",
		"createBy":"创建人",
		"createAt":创建时间,
		"updateBy":"更新人",
		"updateAt":更新时间,
		"code":"代码",
		"batchInterval":{
			"unit":时间单位,
			"interval":时间间隔
		}
	}
}

更新开发作业

描述

本接口用于更新开发作业。

请求

请求结构

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

请求头域

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

参数名称	类型	是否必需	参数位置	描述
version	String	是	URL	API版本号
UpdateJobParameters	UpdateJobParameters	是	RequestBody	更新开发作业参数

返回头域

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

无特殊返回参数

示例

请求示例

POST /api/v2/seniorbsc/job/update 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
host: localhost
x-bce-date: 2019-03-27T07:41:49Z
	
{
	"jobId": 作业ID,
	"code": "代码",
	"name": "作业名称，只能包含大小写英文字母，数字，下划线`_`，横行`-`",
	"description": "作业描述",
	"batchInterval":{
			"unit":时间单位,
			"interval":时间间隔
	}
}

返回示例

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": 0,
	"msg": "操作成功！"
}

检查开发作业代码

描述

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

请求

请求结构

POST /api/v{version}/seniorbsc/job/check HTTP/1.1
	
{
	CheckCodeParameters
}

请求头域

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

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

返回头域

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

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

示例

请求示例

POST /api/v2/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": "代码"		
}

返回示例

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": 0,
	"msg": "操作成功！",
	"data": {
		"hasError": 是否有错,
		"errLine": 错误所在行,
		"errCol": 错误所在列,
		"errMsg": "错误信息"
	}
}

调试开发作业代码

描述

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

请求

请求结构

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

请求头域

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

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

返回头域

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

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

示例

请求示例

POST /api/v2/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
	
{
	"region": "地域",
	"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": 0,
	"msg": "操作成功！",
	"data": {
		"appId": "spark任务的id"
	}
}

获取调试作业状态

描述

本接口用于获取调试作业状态。

请求

请求结构

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

请求头域

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

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

返回头域

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

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

示例

请求示例

POST /api/v2/seniorbsc/job/getDebugStatus/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
	
{
	"appId": "调试作业ID",
	"fileName": "文件名",
	"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": 0,
	"msg": "操作成功！",
	"data": {
		"debugStatus": "调试的状态",
		"debugData": "调试的数据",
		"debugMsg": "调试的输出信息"
	}
}

删除作业

描述

本接口用于删除作业。

请求

请求结构

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

请求头域

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

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

返回头域

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

无特殊返回参数

示例

请求示例

POST /api/v2/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

返回示例

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": 0,
	"msg": "操作成功！"
}

语法检查

描述

本接口用于检查用户提交sql作业语法。

请求

请求结构

POST /api/v{version}/seniorbsc/job/grammarCheck HTTP/1.1
	
{
	CheckCodeParameters
}

请求头域

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

参数名称	类型	是否必需	参数位置	描述
version	String	是	URL	API版本号
CheckCodeParameters	CheckCodeParameters	是	RequestBody	语法检查按钮参数

返回头域

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

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

示例

请求示例

POST /api/v2/seniorbsc/job/grammarCheck 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": "代码"
}

返回示例

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": 0,
	"msg": "操作成功！",
	"data": {
		"hasError": 是否有错,
		"errLine": 错误所在行,
		"errCol": 错误所在列,
		"errMsg": "错误信息"
	}
}

发布作业代码

描述

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

请求

请求结构

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

请求头域

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

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

返回头域

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

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

示例

请求示例
```
POST /api/v2/seniorbsc/job/commit 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 { "jobId": 作业ID, "cu": 计算资源 }

返回示例

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": 0,
	"msg": "操作成功！",
	"data": {
		"version":版本号
	}
}

获取作业的证书列表

描述

本接口用于获取作业的证书列表。

请求

请求结构

GET /api/v{version}/seniorbsc/cert/list/{jobId} HTTP/1.1

请求头域

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

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

返回头域

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

参数名称	类型	描述
items	List<BscCerts>	响应带回的具体数据
page	Int	当前页码
size	Int	每页展示数量
total	Long	总记录数
pageTotal	Long	总页数

示例

请求示例

GET /api/v2/seniorbsc/cert/list/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

返回示例

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": 0,
	"msg": "操作成功！",
	"page": 当前页码,
	"size": 每页记录数,
	"total": 总记录数,
	"pageTotal": 总页数,
	"items": [
		{
			"id": 证书ID,
			"jobId": 作业ID,
			"name": "作业名",
			"uploadAt": "证书上传时间"
		},
		...
	]
}

上传作业证书

描述

本接口用于上传作业证书。

请求

请求结构

POST /api/v{version}/seniorbsc/cert/upload/{jobId} HTTP/1.1
请求头域

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

参数名称	类型	是否必需	参数位置	描述
version	String	是	URL	API版本号
jobId	Long	是	URL	作业ID
file	MultipartFile	是	RequestParam	证书文件

返回头域

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

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

示例

请求示例

POST /api/v2/seniorbsc/cert/upload/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
      {
          file: "作业证书内容"
      }

返回示例

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": 0,
	"msg": "操作成功！",
	"data": {
		"value": "证书名"
	}
}

删除证书

描述

本接口用于删除证书。

请求

请求结构

POST /api/v{version}/seniorbsc/cert/delete/{jobId}&{certId} HTTP/1.1

请求头域

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

参数名称	类型	是否必需	参数位置	描述
version	String	是	URL	API版本号
certId	Long	是	URL	证书ID

返回头域

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

无特殊返回参数

示例

请求示例

POST /api/v2/seniorbsc/cert/delete/3552&241 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

返回示例

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": 0,
	"msg": "操作成功！"
}

获取已发布代码

描述

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

请求

请求结构

GET /api/v{version1}/seniorbsc/code/detail/{jobId}&{version} HTTP/1.1

请求头域

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

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

返回头域

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

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

示例

请求示例

POST /api/v2/seniorbsc/code/detail/3552&241 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

返回示例

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": 0,
	"msg": "操作成功！",
	"data": {
		"code": "代码",
		"cu": 计算资源,
		"batchInterval":{
			"unit":时间单位,
			"interval":时间间隔
		}
	}
}

删除已发布代码

描述

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

请求

请求结构

POST /api/v{version1}/seniorbsc/code/delete/{jobId}&{version} HTTP/1.1

请求头域

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

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

返回头域

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

无特殊返回参数

示例

请求示例

POST /api/v2/seniorbsc/code/detele/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

返回示例

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": 0,
	"msg": "操作成功！"
}

获取已发布代码列表

描述

本接口用于获取某个作业已发布代码列表。

请求

请求结构

GET /api/v{version}/seniorbsc/code/list/{jobId} HTTP/1.1

请求头域

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

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

返回头域

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

参数名称	类型	描述
items	List<BscCommitCode>	响应带回的具体数据
page	Int	当前页码
size	Int	每页展示数量
total	Long	总记录数
pageTotal	Long	总页数

示例

请求示例

GET /api/v2/seniorbsc/code/list/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

返回示例

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": 0,
	"msg": "操作成功！",
	"page": 当前页码,
	"size": 每页记录数,
	"total": 总记录数,
	"pageTotal": 总页数,
	"items": {
		[
			{
				"id": 作业执行ID,
				"jobId": 作业ID,
				"version": 版本号,
				"cu": 计算资源,
				"commitBy": "发布人",
				"commitAt": 发布时间,
				"optionsJson": "配置",
				"code": "代码"
			},
			...
		]
	}
}

获取作业executor列表

描述

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

请求

请求结构

GET /api/v{version}/seniorbsc/log/executors/{opId} HTTP/1.1

请求头域

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

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

返回头域

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

参数名称	类型	描述
data	List<ExecutorListResponse>	执行结果

示例

请求示例

GET /api/v2/seniorbsc/log/executors/3321 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

返回示例

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": 0,
    "msg": "操作成功！",
    "data": {
        [
            {
                "executorId": "executorID",
                "active": 是否正在输出,
                "stdout": "标准输出日志地址",
                "stderr": "标准错误日志地址"
            },
            ...
        ]
    }
}

获取executor日志

描述

本接口用于获取executor日志。

请求

请求结构

		POST /api/v{version}/seniorbsc/log/content HTTP/1.1
	
		{
			ExecutorLogParameters
		}

请求头域

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

参数名称	类型	是否必需	参数位置	描述
version	String	是	URL	API版本号
ExecutorLogParameters	ExecutorLogParameters	是	RequestBody	获取executor日志参数

返回头域

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

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

示例

请求示例

POST /api/v2/seniorbsc/log/content 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

{
    "opId": 作业ID,
    "executorId": "executorID",
    "logType": "标准输出/标准错误",
    "region": "地域",
    "start": 日志偏移量
}

返回示例

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": 0,
    "msg": "操作成功！",
    "data": "日志内容"
}

启动作业

描述

本接口用于启动作业。

请求

请求结构

POST /api/v{version}/seniorbsc/start HTTP/1.1

{
    StartParameters
}

请求头域

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

参数名称	类型	是否必需	参数位置	描述
version	String	是	URL	API版本号
StartParameters	StartParameters	是	RequestBody	运维id

返回头域

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

无特殊返回参数

示例

请求示例

POST /api/v2/seniorbsc/start 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

{
    "id", 作业ID,
    "isRestart": 是否重启
}

返回示例

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": 0,
    "msg": "操作成功！"
}

停止作业

描述

本接口用于停止作业。

请求

请求结构

POST /api/v{version}/seniorbsc/stop/{opId} HTTP/1.1

请求头域

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

参数名称	类型	是否必需	参数位置	描述
version	String	是	URL	API版本号
opId	Long	是	URL	运维id

返回头域

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

无特殊返回参数

示例

请求示例

POST /api/v2/seniorbsc/stop/3452 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

返回示例

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": 0,
    "msg": "操作成功！"
}

获取作业运维详情

描述

本接口用于获取作业运维详情。

请求

请求结构

GET /api/v{version}/seniorbsc/detail/{opId} HTTP/1.1

请求头域

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

参数名称	类型	是否必需	参数位置	描述
version	String	是	URL	API版本号
opId	Long	是	URL	运维id

返回头域

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

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

示例

请求示例

GET /api/v2/seniorbsc/detail/3352 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

返回示例

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": 0,
    "msg": "操作成功！",
    "data": {
        "jobId": 作业ID,
        "name": "作业名",
        "type": "bigsql",
        "jobStatus": "作业状态",
        "cu": 计算资源,
        "commitAt": 提交时间,
        "createBy": "创建人",
        "code": "代码",
        "jarPath": "jar包路径",
        "description": "作业描述"
    }
}

获取用户作业运维列表

描述

本接口用于获取用户作业运维列表。

请求

请求结构

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

{
    ListOpParameters
}

请求头域

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

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

返回头域

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

参数名称	类型	描述
items	List<BscJobExecution>	响应带回的具体数据
page	Int	当前页码
size	Int	每页展示数量
total	Long	总记录数
pageTotal	Long	总页数

示例

请求示例

POST /api/v2/seniorbsc/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

{
    "region": "地域",
    "page": 当前页码,
    "pageSize": 每页记录数,
    "jobName": "作业名",
    "status": "作业状态",
    "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": 0,
    "msg": "操作成功！",
    "data": {
        "page": 当前页码,
        "size": 每页记录数,
        "total": 总记录数,
        "pageTotal": 总页数,
        "items": 
            [
                {
                    "name": "作业名",
                    "id": 作业执行ID,
                    "jobId": 作业ID,
                    "cu": 计算资源,
                    "startAt": 开始时间,
                    "endAt": 结束时间,
                    "status": 作业状态,
                    "appId": spark任务的id,
                    "runningTime": 运行时长
                },
                ...
            ]

    }
}

获取失败作业出错信息

描述

本接口用于获取失败作业出错信息。

请求

请求结构

GET /api/v{version}/seniorbsc/errormsg/{jobId} HTTP/1.1

请求头域

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

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

返回头域

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

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

示例

请求示例

GET /api/v2/seniorbsc/errormsg/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

返回示例

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": 0,
    "msg": "操作成功！",
    "data": "执行结果"
}

判断作业是否可以重启

描述

本接口用于判断作业是否可以重启。

请求

请求结构

GET /api/v{version}/seniorbsc/canrestart/{opId} HTTP/1.1

请求头域

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

参数名称	类型	是否必需	参数位置	描述
version	String	是	URL	API版本号
opId	Long	是	URL	运维ID

返回头域

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

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

示例

请求示例

GET /api/v2/seniorbsc/canrestart/3352 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

返回示例

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": 0,
    "msg": "操作成功！",
    "data": {
        "canRestart": 是否可以重启
    }
}

请求返回格式

模板相关接口

百度流式计算 BSC

作业相关接口

创建SQL作业

创建spark作业

编辑spark作业

获取开发作业列表

获取开发作业详情

更新开发作业

检查开发作业代码

调试开发作业代码

获取调试作业状态

删除作业

语法检查

发布作业代码

获取作业的证书列表

上传作业证书

删除证书

获取已发布代码

删除已发布代码

获取已发布代码列表

获取作业executor列表

获取executor日志

启动作业

停止作业

获取作业运维详情

获取用户作业运维列表

获取失败作业出错信息

判断作业是否可以重启