模板相关接口
所有文档

          百度流式计算 BSC

          模板相关接口

          获取模板列表

          描述

          本接口用于获取模板列表。

          请求

          • 请求结构

            POST /api/v{version}/seniorbsc/template/list HTTP/1.1
            
            {
            	ListTemplateParameters
            }
          • 请求头域

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

          • 请求参数
          参数名称 类型 是否必需 参数位置 描述
          version String URL API版本号
          ListTemplateParameters ListTemplateParameters RequestBody 获取模板列表参数

          返回

          • 返回头域

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

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

          示例

          • 请求示例

            POST /api/v2/seniorbsc/template/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": "每页数量"
            	"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": 作业名称,
            				"region": "地域",
            				"createBy": "创建人",
            				"createAt": 创建时间,
            				"updateBy": "更新人",
            				"updateAt": 更新时间,
            				"deleteAt": 删除时间,
            				"description": "作业描述"
            			},
            			...
            		]
            }

          获取模板详情

          描述

          本接口用于获取模板详情。

          请求

          • 请求结构

            GET /api/v{version}/seniorbsc/template/detail/{templateId} HTTP/1.1
          • 请求头域

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

          • 请求参数
          参数名称 类型 是否必需 参数位置 描述
          version String URL API版本号
          templateId Long URL 模版ID

          返回

          • 返回头域

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

          • 返回参数
          参数名称 类型 描述
          data GetTemplateDetailResponse 执行结果

          示例

          • 请求示例

            GET /api/v2/seniorbsc/template/detail/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": "操作成功!",
            	"data": {
            		"id": 作业ID,
            		"name": "作业名",
            		"description": "作业描述",
            		"code": "代码",
            		"createBy": "创建人",
            		"createAt": 创建时间,
            		"updateBy": "更新人",
            		"updateAt": 更新时间
            	}
            }

          创建模板

          描述

          本接口用于创建模板。

          请求

          • 请求结构

            POST /api/v{version}/seniorbsc/template/create HTTP/1.1
            
            {
            	CreateTemplateParameters
            }
          • 请求头域

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

          • 请求参数
          参数名称 类型 是否必需 参数位置 描述
          version String URL API版本号
          CreateTemplateParameters CreateTemplateParameters RequestBody 创建模板参数

          返回

          • 返回头域

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

          • 返回参数
          参数名称 类型 描述
          data CreateTemplateResponse 执行结果

          示例

          • 请求示例

            POST /api/v2/seniorbsc/template/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
            
            {
            	"name": "作业名称",
            	"region": "地域",
            	"code": "代码",
            	"description": "作业描述"
            }
          • 返回示例

            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": {
            		"id": 作业ID,
            		"accountId": "用户帐号",
            		"name": "作业名称",
            		"region": "地域",
            		"createBy": "创建人",
            		"createAt": 创建时间,
            		"updateBy": "更新人",
            		"updateAt": 更新时间,
            		"deleteAt": 删除时间,
            		"description": "作业描述"
            	}
            }

          修改模板

          描述

          本接口用于修改模板。

          请求

          • 请求结构

            POST /api/v{version}/seniorbsc/template/update HTTP/1.1
            
            {
            	UpdateTemplateParameters
            }
          • 请求头域

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

          • 请求参数
          参数名称 类型 是否必需 参数位置 描述
          version String URL API版本号
          UpdateTemplateParameters UpdateTemplateParameters RequestBody 修改模板参数

          返回

          • 返回头域

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

          示例

          • 请求示例

            POST /api/v2/seniorbsc/template/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
            
            {
            	"name": "作业名称",
            	"id": "作业ID",
            	"description": "作业描述",
            	"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": "操作成功!"
            }

          删除模板

          描述

          本接口用于删除模板。

          请求

          • 请求结构

            POST /api/v{version}/seniorbsc/template/delete/{templateId} HTTP/1.1
          • 请求头域

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

          • 请求参数
          参数名称 类型 是否必需 参数位置 描述
          version String URL API版本号
          templateId Long URL 模板id

          返回

          • 返回头域

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

          示例

          • 请求示例

            POST /api/v2/seniorbsc/template/delete/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": "操作成功!"
            }

          基于模板新增作业

          描述

          本接口用于基于模板新增作业。

          请求

          • 请求结构

            POST /api/v{version}/seniorbsc/template/addjob HTTP/1.1
            
            {
            	AddTemplateJobParameters
            }
          • 请求头域

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

          • 请求参数
          参数名称 类型 是否必需 参数位置 描述
          version String URL API版本号
          AddTemplateJobParameters AddTemplateJobParameters URL 新增作业参数

          返回

          • 返回头域

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

          • 返回参数
          参数名称 类型 描述
          data AddTemplateJobResponse 执行结果

          示例

          • 请求示例

            POST /api/v2/seniorbsc/template/addjob 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,
            	"jobName": "作业名",
            	"region": "地域",
            	"jobType": "bigsql",
            	"jobDescription": "作业描述"
            }
          • 返回示例

            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
            	}
            }
          上一篇
          作业相关接口
          下一篇
          模型定义