作业实例相关接口
更新时间：2021-10-14
启动作业实例
接口描述
本接口用于启动作业实例列表中的某一实例。
请求结构
POST /api/v{version}/seniorbsc/instance/start/${insId} HTTP/1.1
Host: bsc.bj.baidubce.com
Authorization: authorization string
x-Region: bj
{
"isRestart": true,
"vpcId" : "vpc-whdh4gxbrnnd",
"vpcUuid" : null,
"subnetId" : "sbn-jbgf9fu5tjs7",
"subnetUuid" : null,
"logicalZone" : "zoneA",
"securityGroupId" : "g-d2b5d0j1jaxf",
"cidr" : "172.18.0.0/20",
"cpu" : 1,
"ram" : 4,
"cuType" : "CPU",
"minCu" : 1,
"maxCu" : 1
}请求头域
除公共头域外，无其它特殊头域。
请求参数
| 参数名称 | 类型 | 是否必需 | 参数位置 | 描述 |
|---|---|---|---|---|
| version | String | 是 | URL参数 | API版本号 |
| insId | String | 是 | URL参数 | 作业实例id |
| request | StartInstanceRequest | 是 | RequestBody参数 | request中需要包含的字段 |
响应头域
除公共头域外，无其它特殊头域。
响应参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
| instanceId | String | 启动的作业实例Id |
请求示例
POST http://bsc.bj.baidubce.com/api/v3/seniorbsc/instance/start/3A8d84403d-a94b-40ce-9d6a-f6225dd26676
Host: bsc.bj.baidubce.com
Authorization: bce-auth-v1/f81d3b34e48048fbb2634dc7882d7e21/2015-08-11T04:17:29Z/3600/host/74c506f68c65e26c633bfa104c863fffac5190fdec1ec24b7c03eb5d67d2e1de
x-Region: bj
{
"isRestart": true,
"vpcId" : "vpc-whdh4gxbrnnd",
"vpcUuid" : null,
"subnetId" : "sbn-jbgf9fu5tjs7",
"subnetUuid" : null,
"logicalZone" : "zoneA",
"securityGroupId" : "g-d2b5d0j1jaxf",
"cidr" : "172.18.0.0/20",
"cpu" : 1,
"ram" : 4,
"cuType" : "CPU",
"minCu" : 1,
"maxCu" : 1
}响应示例
HTTP/1.1 200 OK
Content-Type: application/json;charset=UTF-8
Date: Wed, 08 Jul 2015 03:28:11 GMT
x-bce-request-id: d8752367-38e8-45e4-b4c7-e53be3137ce5
Server: BWS
{
status: 200,
success: true,
result: {
instanceId: xxx
}
}停止作业实例
接口描述
本接口用于停止作业实例列表中的某一实例。
请求结构
POST /api/v{version}/seniorbsc/instance/stop/${instanceId} HTTP/1.1
Host: bsc.bj.baidubce.com
Authorization: authorization string
x-Region: bj请求头域
除公共头域外，无其它特殊头域。
请求参数
| 参数名称 | 类型 | 是否必需 | 参数位置 | 描述 |
|---|---|---|---|---|
| version | String | 是 | URL参数 | API版本号 |
| instanceId | String | 是 | URL参数 | 作业实例id |
响应头域
除公共头域外，无其它特殊头域。
响应参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
| instanceId | String | 启动的作业实例Id |
请求示例
POST http://bsc.bj.baidubce.com/api/v3/seniorbsc/instance/stop/3A8d84403d-a94b-40ce-9d6a-f6225dd26676
Host: bsc.bj.baidubce.com
Authorization: bce-auth-v1/f81d3b34e48048fbb2634dc7882d7e21/2015-08-11T04:17:29Z/3600/host/74c506f68c65e26c633bfa104c863fffac5190fdec1ec24b7c03eb5d67d2e1de
x-Region: bj响应示例
HTTP/1.1 200 OK
Content-Type: application/json;charset=UTF-8
Date: Wed, 08 Jul 2015 03:28:11 GMT
x-bce-request-id: d8752367-38e8-45e4-b4c7-e53be3137ce5
Server: BWS
{
status: 200,
success: true,
result: {
instanceId: xxx
}
}获取作业实例列表
接口描述
本接口用于获取作业实例列表。
请求结构
POST /api/v{version}/seniorbsc/instance/list HTTP/1.1
Host: bsc.bj.baidubce.com
Authorization: authorization string
x-Region: bj
{
keyWords: []
name: ""
order: ""
orderBy: ""
page: 1
pageSize: 10
}请求头域
除公共头域外，无其它特殊头域。
请求参数
| 参数名称 | 类型 | 是否必需 | 参数位置 | 描述 |
|---|---|---|---|---|
| version | String | 是 | URL参数 | API版本号 |
| request | ListInstancesRequest | 是 | RequestBody参数 | 请求参数 |
响应头域
除公共头域外，无其它特殊头域。
响应参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
| pageNo | Integer | 页码 |
| pageSize | Integer | 每页大小 |
| totalCount | Integer | 总记录数 |
| result | List |
具体内容 |
请求示例
POST http://bsc.bj.baidubce.com/api/v3/seniorbsc/instance/list
Host: bsc.bj.baidubce.com
Authorization: bce-auth-v1/f81d3b34e48048fbb2634dc7882d7e21/2015-08-11T04:17:29Z/3600/host/74c506f68c65e26c633bfa104c863fffac5190fdec1ec24b7c03eb5d67d2e1de
x-Region: bj
{
keyWords: []
name: ""
order: ""
orderBy: ""
page: 1
pageSize: 10
}响应示例
HTTP/1.1 200 OK
Content-Type: application/json;charset=UTF-8
Date: Wed, 08 Jul 2015 03:28:11 GMT
x-bce-request-id: d8752367-38e8-45e4-b4c7-e53be3137ce5
Server: BWS
{
result: [...]
order: ""
orderBy: "create_time"
pageNo: 1
pageSize: 10
totalCount: 16
status: 200
success: true
}获取作业实例详情
接口描述
本接口用于获取作业实例列表中的某一实例详情。
请求结构
GET /api/v{version}/seniorbsc/instance/detail/${instanceId} HTTP/1.1
Host: bsc.bj.baidubce.com
Authorization: authorization string
x-Region: bj请求头域
除公共头域外，无其它特殊头域。
请求参数
| 参数名称 | 类型 | 是否必需 | 参数位置 | 描述 |
|---|---|---|---|---|
| version | String | 是 | URL参数 | API版本号 |
| instanceId | String | 是 | URL参数 | 作业实例id |
响应头域
除公共头域外，无其它特殊头域。
响应参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
| response | Instance | 作业实例详情 |
请求示例
GET http://bsc.bj.baidubce.com/api/v3/seniorbsc/instance/detail/3A8d84403d-a94b-40ce-9d6a-f6225dd26676
Host: bsc.bj.baidubce.com
Authorization: bce-auth-v1/f81d3b34e48048fbb2634dc7882d7e21/2015-08-11T04:17:29Z/3600/host/74c506f68c65e26c633bfa104c863fffac5190fdec1ec24b7c03eb5d67d2e1de
x-Region: bj响应示例
HTTP/1.1 200 OK
Content-Type: application/json;charset=UTF-8
Date: Wed, 08 Jul 2015 03:28:11 GMT
x-bce-request-id: d8752367-38e8-45e4-b4c7-e53be3137ce5
Server: BWS
{
status: 200,
success: true,
result: {
....
}
}对象定义
Instance
| 参数名称 | 类型 | 描述 |
|---|---|---|
| instanceId | String | 作业的实例id |
| jobId | String | 实例所对应的作业 id |
| jobShortId | String | 作业短 id，作业 SID |
| appId | String | 作业长 id |
| name | String | 作业名称 |
| type | String | 作业类型 |
| jobType | String | STREAM/BATCH |
| engineType | String | SPARK/FLINK |
| engineVersion | String | 引擎版本 |
| code | String | 作业正文 |
| resources | List[InstanceResource] | 作业的资源引用情况 |
| properties | JobProperties | 作业的属性 |
| autoscale | AutoScale | 作业使用的 CU 数目 |
| description | String | 作业描述 |
| startTime | long | 启动时间 |
| endTime | long | 结束时间 |
| status | String | 状态 |
InstanceResource
| 参数名称 | 类型 | 描述 |
|---|---|---|
| name | String | 资源名称 |
| path | String | 资源路径 |
| type | String | 资源类型 |
| content | Map<String, String> | udf类型资源，解析出的内容 |
JobProperties
| 参数名称 | 类型 | 描述 |
|---|---|---|
| jobParameter | JobParameter | 作业参数 |
| jsonJobParameter | String | 函数参数 |
JobParameter
| 参数名称 | 类型 | 描述 |
|---|---|---|
| common | Map<String, String> | 默认参数 |
| custom | String | 用户自定义参数 |
AutoScale
| 参数名称 | 类型 | 描述 |
|---|---|---|
| cu | Cu | cpu定义 |
| minCu | int | 最少cu数 |
| maxCu | int | 最大cu数 |
| curCu | int | 现有cu数 |
Cu
| 参数名称 | 类型 | 描述 |
|---|---|---|
| cpu | int | cpu数 |
| ram | int | ram数 |
| cuType | String | cu类型 |