资源相关接口

更新时间：2021-10-12

通过本地创建资源

接口描述

本接口用于通过本地上传创建BSC资源，BSC资源包括：Jar作业需要的相关Jar包、kafka证书等。

请求结构

POST /api/v{version}/seniorbsc/resource/create/local HTTP/1.1
Host: bsc.bj.baidubce.com
Authorization: authorization string
{
  description: "",
  file: : "...",
  fileName: "demo-1.0-SNAPSHOT.jar",
  name: "testApi",
  type: "JOB_FILE/JAR"
}

请求头域

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

请求参数

参数名称	类型	是否必需	参数位置	描述
version	String	是	URL参数	API版本号
file	String	是	RequestBody参数	file内容经过base64编码之后的String
fileName	String	是	RequestBody参数	本地文件的 orginalname
type	String	是	RequestBody参数	资源类型，调用 [列出用户可用资源类型] 接口来返回资源类型，目前支持的资源类型包括：JOB_FILE_JAR、JOB_FILE_PY、JOB_CODE_PY、UDX_FILE_JAR、UDX_CODE_GO、KAR_FILE_ZIP、DIC_FILE_TXT 一共7种类型
name	String	是	RequestBody参数	资源名称
description	String	否	RequestBody参数	描述信息

响应头域

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

响应参数

参数名称	类型	描述
resourceId	String	资源 id

请求示例

POST http://bsc.bj.baidubce.com/api/v3/seniorbsc/resource/create/local
Host: bsc.bj.baidubce.com
Authorization: bce-auth-v1/f81d3b34e48048fbb2634dc7882d7e21/2015-08-11T04:17:29Z/3600/host/74c506f68c65e26c633bfa104c863fffac5190fdec1ec24b7c03eb5d67d2e1de
X-Region: fwh
{
  description: "",
  file: "...",
  fileName: "demo-1.0-SNAPSHOT.jar",
  name: "testApi",
  type: "JOB_FILE/JAR"
}

响应示例

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: {
        resourceId: "a4291c93084d49c996987d5a705a74c7"
    },
    status: 200,
    success: true
}

通过Bos创建资源

接口描述

本接口用于通过Bos上已有资源创建BSC资源。

请求结构

POST /api/v{version}/seniorbsc/resource/create/bos HTTP/1.1
Host: bsc.bj.baidubce.com
Authorization: authorization string
{
  bosBucket: "bsc-fwh-resource",
  bosObject: "test",
  description: "",
  name: "testBos",
  type: "JOB_FILE/JAR"
}

请求头域

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

请求参数

参数名称	类型	是否必需	参数位置	描述
version	String	是	URL参数	API版本号
bosBucket	String	是	RequestBody参数	bos bucket name
bosObject	String	是	RequestBody参数	bos object name
type	String	是	RequestBody参数	资源类型，调用 [列出用户可用资源类型] 接口来返回资源类型，目前支持的资源类型包括：JOB_FILE_JAR、JOB_FILE_PY、JOB_CODE_PY、UDX_FILE_JAR、UDX_CODE_GO、KAR_FILE_ZIP、DIC_FILE_TXT 一共7种类型
name	String	是	RequestBody参数	资源名称
description	String	否	RequestBody参数	描述信息

响应头域

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

响应参数

参数名称	类型	描述
resourceId	String	资源 id

请求示例

POST http://bsc.bj.baidubce.com/api/v3/seniorbsc/resource/create/bos
Host: bsc.bj.baidubce.com
Authorization: bce-auth-v1/f81d3b34e48048fbb2634dc7882d7e21/2015-08-11T04:17:29Z/3600/host/74c506f68c65e26c633bfa104c863fffac5190fdec1ec24b7c03eb5d67d2e1de
X-Region: fwh
{
  bosBucket: "bsc-fwh-resource",
  bosObject: "test",
  description: "",
  name: "testBos",
  type: "JOB_FILE/JAR"
}

响应示例

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: {
        resourceId: "a4291c93084d49c996987d5a705a74c7"
    },
    status: 200,
    success: true
}

编辑资源

接口描述

本接口用于对已有资源名称与描述进行修改。

请求结构

POST /api/v{version}/seniorbsc/resource/update/{resId} HTTP/1.1
Host: bsc.bj.baidubce.com
Authorization: authorization string
{
  description: ""
  name: "testBos"
}

请求头域

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

请求参数

参数名称	类型	是否必需	参数位置	描述
version	String	是	URL参数	API版本号
resId	String	是	URL参数	resId
name	String	是	RequestBody参数	资源名称
description	String	否	RequestBody参数	描述信息

响应头域

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

响应参数

参数名称	类型	描述
resourceId	String	资源 id

请求示例

POST http://bsc.bj.baidubce.com/api/v3/seniorbsc/resource/update/{resId}
Host: bsc.bj.baidubce.com
Authorization: bce-auth-v1/f81d3b34e48048fbb2634dc7882d7e21/2015-08-11T04:17:29Z/3600/host/74c506f68c65e26c633bfa104c863fffac5190fdec1ec24b7c03eb5d67d2e1de
X-Region: fwh
{
  description: "",
  name: "testBos"
}

响应示例

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: {
        resourceId: "a4291c93084d49c996987d5a705a74c7"
    },
    status: 200,
    success: true
}

通过本地更新资源

接口描述

本接口用于通过本地对已有资源新增版本，原有资源不会删除，会以历史版本的形式存在。

请求结构

POST /api/v{version}/seniorbsc/resource/upgrade/local/{resId} HTTP/1.1
Host: bsc.bj.baidubce.com
Authorization: authorization string
{
  description: "",
  file: "...",
  fileName: "demo-1.0-SNAPSHOT.jar",
  name: "testApi"
}

请求头域

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

请求参数

参数名称	类型	是否必需	参数位置	描述
version	String	是	URL参数	API版本号
resId	String	是	URL参数	resId
description	String	否	RequestBody参数	描述信息
file	String	是	RequestBody参数	file内容经过base64编码之后的String
fileName	String	是	RequestBody参数	本地文件的 orginalname

响应头域

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

响应参数

参数名称	类型	描述
version	Integer	资源版本号

请求示例

POST http://bsc.bj.baidubce.com/api/v3/seniorbsc/resource/upgrate/local/{resId}
Host: bsc.bj.baidubce.com
Authorization: bce-auth-v1/f81d3b34e48048fbb2634dc7882d7e21/2015-08-11T04:17:29Z/3600/host/74c506f68c65e26c633bfa104c863fffac5190fdec1ec24b7c03eb5d67d2e1de
X-Region: fwh
{
  description: "",
  file: "...",
  fileName: "demo-1.0-SNAPSHOT.jar",
  name: "testApi"
}

响应示例

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: {
        version: 1
    },
    status: 200,
    success: true
}

通过Bos更新资源

接口描述

本接口用于通过Bos对已有资源新增版本，原有资源不会删除，会以历史版本的形式存在。

请求结构

POST /api/v{version}/seniorbsc/resource/upgrade/bos/{resId} HTTP/1.1
Host: bsc.bj.baidubce.com
Authorization: authorization string
{
  bosBucket: "bsc-fwh-resource",
  bosObject: "test",
  description: "",
  name: "testBos"
}

请求头域

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

请求参数

参数名称	类型	是否必需	参数位置	描述
version	String	是	URL参数	API版本号
resId	String	是	URL参数	resId
description	String	否	RequestBody参数	描述信息
bosBucket	String	是	RequestBody参数	bos bucket name
bosObject	String	是	RequestBody参数	bos object name

响应头域

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

响应参数

参数名称	类型	描述
version	Integer	资源版本号

请求示例

POST http://bsc.bj.baidubce.com/api/v3/seniorbsc/resource/upgrate/bos/{resId}
Host: bsc.bj.baidubce.com
Authorization: bce-auth-v1/f81d3b34e48048fbb2634dc7882d7e21/2015-08-11T04:17:29Z/3600/host/74c506f68c65e26c633bfa104c863fffac5190fdec1ec24b7c03eb5d67d2e1de
X-Region: fwh
{
  bosBucket: "bsc-fwh-resource",
  bosObject: "test",
  description: ""
}

响应示例

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: {
        version: 1
    },
    status: 200,
    success: true
}

获取资源列表

接口描述

本接口用于获取资源列表存在。

请求结构

POST /api/v{version}/seniorbsc/resource/list HTTP/1.1
Host: bsc.bj.baidubce.com
Authorization: authorization string
{
  result: [...],
  order: "",
  orderBy: "create_time",
  pageNo: 1,
  pageSize: 10,
  totalCount: 16
}

请求头域

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

请求参数

参数名称	类型	是否必需	参数位置	描述
page	Integer	是	RequestBody参数	页码
pageSize	Integer	是	RequestBody参数	每页数目
name	String	否	RequestBody参数	资源 name，可模糊匹配
orderBy	String	否	RequestBody参数	列表排序的依据，目前可以选择：创建时间 create_time、更新时间 modify_time
order	String	否	RequestBody参数	升序或降序，目前可以选择：desc、asc
keyWords	List<Map<String, String>>	否	RequestBody参数	筛选条件，目前可以是资源类型或资源状态
jobId	String	否	RequestBody参数	作业 id

响应头域

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

响应参数

参数名称	类型	描述
pageNo	Integer	页码
pageSize	Integer	每页大小
totalCount	Integer	总记录数
result	List	具体内容

请求示例

POST http://bsc.bj.baidubce.com/api/v3/seniorbsc/resource/list
Host: bsc.bj.baidubce.com
Authorization: bce-auth-v1/f81d3b34e48048fbb2634dc7882d7e21/2015-08-11T04:17:29Z/3600/host/74c506f68c65e26c633bfa104c863fffac5190fdec1ec24b7c03eb5d67d2e1de
X-Region: fwh
{
    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
}

获取资源历史列表

接口描述

本接口用于获取某一资源的历史列表。

请求结构

POST /api/v{version}/seniorbsc/resource/history/list/{resId} HTTP/1.1
Host: bsc.bj.baidubce.com
Authorization: authorization string

请求头域

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

请求参数

响应头域

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

响应参数

参数名称	类型	描述
pageNo	Integer	页码
pageSize	Integer	每页大小
totalCount	Integer	总记录数
result	List	具体内容

请求示例

POST http://bsc.bj.baidubce.com/api/v3/seniorbsc/resource/history/list
Host: bsc.bj.baidubce.com
Authorization: bce-auth-v1/f81d3b34e48048fbb2634dc7882d7e21/2015-08-11T04:17:29Z/3600/host/74c506f68c65e26c633bfa104c863fffac5190fdec1ec24b7c03eb5d67d2e1de
X-Region: fwh

响应示例

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
}

获取资源详情

接口描述

本接口用于通过resId获取资源详情。

请求结构

GET /api/v{version}/seniorbsc/resource/detail/{resId} HTTP/1.1
Host: bsc.bj.baidubce.com
Authorization: authorization string

请求头域

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

请求参数

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

响应头域

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

响应参数

参数名称	类型	描述
result	[BscResource]	资源信息

请求示例

GET http://bsc.bj.baidubce.com/api/v3/seniorbsc/resource/detail/{resId}
Host: bsc.bj.baidubce.com
Authorization: bce-auth-v1/f81d3b34e48048fbb2634dc7882d7e21/2015-08-11T04:17:29Z/3600/host/74c506f68c65e26c633bfa104c863fffac5190fdec1ec24b7c03eb5d67d2e1de
X-Region: fwh

响应示例

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: {
        ...
    },
    status: 200,
    success: true
}

获取作业与资源引用关系

接口描述

本接口用于通过resId获取资源和作业引用关

请求结构

GET /api/v{version}/seniorbsc/resource/detail/relation/{resId} HTTP/1.1
Host: bsc.bj.baidubce.com
Authorization: authorization string

请求头域

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

请求参数

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

响应头域

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

响应参数

参数名称	类型	描述
result	[BscRelation]	关联信息

请求示例

GET http://bsc.bj.baidubce.com/api/v3/seniorbsc/resource/detail/relation/{resId}
Host: bsc.bj.baidubce.com
Authorization: bce-auth-v1/f81d3b34e48048fbb2634dc7882d7e21/2015-08-11T04:17:29Z/3600/host/74c506f68c65e26c633bfa104c863fffac5190fdec1ec24b7c03eb5d67d2e1de
X-Region: fwh

响应示例

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: {
        ...
    },
    status: 200,
    success: true
}

回滚资源

接口描述

本接口用于回滚资源

请求结构

POST /api/v{version}/seniorbsc/resource/history/rollback/{resId}/{hisId} HTTP/1.1
Host: bsc.bj.baidubce.com
Authorization: authorization string

请求头域

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

请求参数

参数名称	类型	是否必需	参数位置	描述
version	String	是	URL参数	API版本号
resId	String	是	URL参数	resId
hisId	String	是	URL参数	历史版本号

响应头域

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

响应参数

请求示例

POST http://bsc.bj.baidubce.com/api/v3/seniorbsc/resource/history/rollback/{resId}/{hisId}
Host: bsc.bj.baidubce.com
Authorization: bce-auth-v1/f81d3b34e48048fbb2634dc7882d7e21/2015-08-11T04:17:29Z/3600/host/74c506f68c65e26c633bfa104c863fffac5190fdec1ec24b7c03eb5d67d2e1de
X-Region: fwh

响应示例

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: {},
    status: 200,
    success: true
}

删除资源

接口描述

本接口用于删除资源

请求结构

POST /api/v{version}/seniorbsc/resource/delete/{resIds} HTTP/1.1
Host: bsc.bj.baidubce.com
Authorization: authorization string

请求头域

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

请求参数

参数名称	类型	是否必需	参数位置	描述
version	String	是	URL参数	API版本号
resIds	String	是	URL参数	多个资源 id 以逗号分隔符分隔的字符串，例如： res1,res2,res3

响应头域

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

响应参数

请求示例

POST http://bsc.bj.baidubce.com/api/v3/seniorbsc/resource/delete{resIds}
Host: bsc.bj.baidubce.com
Authorization: bce-auth-v1/f81d3b34e48048fbb2634dc7882d7e21/2015-08-11T04:17:29Z/3600/host/74c506f68c65e26c633bfa104c863fffac5190fdec1ec24b7c03eb5d67d2e1de
X-Region: fwh

响应示例

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: {},
    status: 200,
    success: true
}

删除资源某个历史版本

接口描述

本接口用于删除资源某个历史版本

请求结构

POST /api/v{version}/seniorbsc/resource/history/delete/{resId}/{resHisId}	 HTTP/1.1
Host: bsc.bj.baidubce.com
Authorization: authorization string

请求头域

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

请求参数

参数名称	类型	是否必需	参数位置	描述
version	String	是	URL参数	API版本号
resId	String	是	URL参数	resId
resHisIdId	String	是	URL参数	resHisId

响应头域

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

响应参数

请求示例

POST http://bsc.bj.baidubce.com/api/v3/seniorbsc/resource/history/delete/{resId}/{resHisId}
Host: bsc.bj.baidubce.com
Authorization: bce-auth-v1/f81d3b34e48048fbb2634dc7882d7e21/2015-08-11T04:17:29Z/3600/host/74c506f68c65e26c633bfa104c863fffac5190fdec1ec24b7c03eb5d67d2e1de
X-Region: fwh

响应示例

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: {},
    status: 200,
    success: true
}

引用资源

接口描述

本接口用于在作业中引用资源

请求结构

POST /api/v{version}/seniorbsc/resource/reference/{resId}	 HTTP/1.1
Host: bsc.bj.baidubce.com
Authorization: authorization string

请求头域

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

请求参数

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

响应头域

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

响应参数

参数名称	类型	描述
success	Boolean	是否成功

请求示例

POST http://bsc.bj.baidubce.com/api/v3/seniorbsc/resource/reference/{resId}
Host: bsc.bj.baidubce.com
Authorization: bce-auth-v1/f81d3b34e48048fbb2634dc7882d7e21/2015-08-11T04:17:29Z/3600/host/74c506f68c65e26c633bfa104c863fffac5190fdec1ec24b7c03eb5d67d2e1de
X-Region: fwh
{
    jobId: xxx
}

响应示例

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: {
        success: true
    },
    status: 200,
    success: true
}

解引用资源

接口描述

本接口用于在作业中解引用资源

请求结构

POST /api/v{version}/seniorbsc/resource/dereference/{resId}	 HTTP/1.1
Host: bsc.bj.baidubce.com
Authorization: authorization string

请求头域

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

请求参数

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

响应头域

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

响应参数

参数名称	类型	描述
success	Boolean	是否成功

请求示例

POST http://bsc.bj.baidubce.com/api/v3/seniorbsc/resource/dereference/{resId}
Host: bsc.bj.baidubce.com
Authorization: bce-auth-v1/f81d3b34e48048fbb2634dc7882d7e21/2015-08-11T04:17:29Z/3600/host/74c506f68c65e26c633bfa104c863fffac5190fdec1ec24b7c03eb5d67d2e1de
X-Region: fwh
{
    jobId: xxx
}

响应示例

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: {
        success: true
    },
    status: 200,
    success: true
}

重名校验

接口描述

本接口用于在资源的重名校验

请求结构

POST /api/v{version}/seniorbsc/resource/name/check	 HTTP/1.1
Host: bsc.bj.baidubce.com
Authorization: authorization string

请求头域

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

请求参数

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

响应头域

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

响应参数

参数名称	类型	描述
isDupResourceName	Boolean	是否重名

请求示例

POST http://bsc.bj.baidubce.com/api/v3/seniorbsc/resource/name/check
Host: bsc.bj.baidubce.com
Authorization: bce-auth-v1/f81d3b34e48048fbb2634dc7882d7e21/2015-08-11T04:17:29Z/3600/host/74c506f68c65e26c633bfa104c863fffac5190fdec1ec24b7c03eb5d67d2e1de
X-Region: fwh
{
    name: xxx
}

响应示例

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: {
        isDupResourceName: true
    },
    status: 200,
    success: true
}

模板相关接口

模型定义

百度智能云

百度流式计算 BSC

百度流式计算 BSC

资源相关接口

通过本地创建资源

通过Bos创建资源

编辑资源

通过本地更新资源

通过Bos更新资源

获取资源列表

获取资源历史列表

获取资源详情

获取作业与资源引用关系

回滚资源

删除资源

删除资源某个历史版本

引用资源

解引用资源

重名校验