模板相关接口

获取模板列表

接口描述

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

请求结构

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

• 请求头域

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

• 请求参数

返回

• 返回头域

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

• 返回参数

示例

• 请求示例

  POST /api/v3/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
  x-Region: bj
  {
  	"page": "总页数",
  	"pageSize": "每页数量"
  	"orderBy": "排序字段",
  	"order": "排序规则",
      "category": "PRIVATE",
      "name": "模板名称"
  }

• 返回示例

  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,
  				"accountId": "用户账号",
  				"name": 模板名称,
  				"region": "地域",
  				"createBy": "创建人",
  				"createAt": 创建时间,
  				"updateBy": "更新人",
  				"updateAt": 更新时间,
  				"deleteAt": 删除时间,
  				"description": "模板描述"
  			},
  			...
  		]
  }

获取模板详情

描述

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

请求

• 请求结构

  GET /api/v{version}/seniorbsc/template/detail/{templateId} HTTP/1.1

• 请求头域

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

• 请求参数

返回

• 返回头域

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

• 返回参数

示例

• 请求示例

  GET /api/v3/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
  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": {
  		"id": 模板ID,
  		"name": "模板名称",
  		"description": "模板描述",
  		"code": "代码",
  		"createBy": "创建人",
  		"createAt": 创建时间,
  		"updateBy": "更新人",
  		"updateAt": 更新时间
  	}
  }

创建模板

描述

本接口用于创建模板。

请求

• 请求结构

  POST /api/v{version}/seniorbsc/template/create HTTP/1.1
  
  {
  	CreateTemplateParameters
  }

• 请求头域

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

• 请求参数

返回

• 返回头域

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

• 返回参数

示例

• 请求示例

  POST /api/v3/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
  x-Region: bj
  
  {
  	"name": "模板名称",
  	"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": 200,
  	"success": true,
  	"result": {
  		"templateId": 模板ID,
  	}
  }

修改模板

描述

本接口用于修改模板。

请求

• 请求结构

  POST /api/v{version}/seniorbsc/template/update/${templateId} HTTP/1.1
  
  {
  	UpdateTemplateRequest
  }

• 请求头域

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

• 请求参数

返回

• 返回头域

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

• 返回参数

示例

• 请求示例

  POST /api/v3/seniorbsc/template/update/123 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
  
  {
  	"name": "模板名称",
  	"region": "bj",
  	"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": 200,
  	"success": true
      "result": {
          "templateId" : "xxx"
      }
  }

删除模板

描述

本接口用于删除模板。

请求

• 请求结构

  POST /api/v{version}/seniorbsc/template/delete/{templateId} HTTP/1.1

• 请求头域

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

• 请求参数

返回

• 返回头域

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

示例

• 请求示例

  POST /api/v3/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
  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
  }

模型定义

ListUserTemplateRequest

CreateTemplateRequest

UpdateTemplateRequest

CreateTemplateRequest

Template