维修任务相关接口

更新时间：2024-08-05

维修平台为全局服务，API的服务域名为：bbc.bj.baidubce.com

查询维修任务列表

查询所有未关闭的维修任务

请求结构

GET /v{version}/task?marker={marker}&maxKeys={maxKeys}&startTime={startTime}&endTime={endTime} HTTP/1.1
Host: bbc.bj.baidubce.com
Authorization: authorization string

请求头域

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

请求参数

参数名称	类型	是否必需	参数位置	描述
version	String	是	URL参数	API版本号
marker	String	否	Query参数	批量获取列表的查询的起始位置，是一个由系统生成的字符串
maxKeys	int	否	Query参数	每页包含的最大数量，最大数量通常不超过1000。缺省值为1000
instanceId	String	否	Query参数	故障实例的ID
internalIp	String	否	Query参数	故障实例的内网IP
status	String	否	Request Body参数	任务状态
timeRangeType	String	否	Request Body参数	时间节点类型，当前支持类型：errStart、newTask、authorizeTask、unAuthorizeTask
timeRangeStart	String	否	Request Body参数	timeRangeType类型开始时间，例如： 2021-06-29 19:00:00。若为空则只按照timeRangeEnd限制
timeRangeEnd	String	否	Request Body参数	timeRangeType类型结束时间，例如： 2021-06-29 19:00:00。若为空则只按照timeRangeStart限制

返回头域

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

返回参数

参数名称	类型	描述
marker	String	标记查询的起始位置
isTruncated	boolean	true表示后面还有数据，false表示已经是最后一页
nextMarker	String	获取下一页所需要传递的marker值。当isTruncated为false时，该域不出现
maxKeys	int	每页包含的最大数量
RepairTask	List<TaskModel>	维修任务信息，由 TaskModel 组成的集合

错误码

无特殊返回错误码

请求示例

GET /v2/task?marker=task-IyWRtII7&maxKeys=1&startTime=2021-06-29 19:00:00&endTime=2021-07-07 10:26:35 HTTP/1.1
Host: bbc.bj.baidubce.com
ContentType: application/json
Authorization: bce-auth-v1/f81d3b34e48048fbb2634dc7882d7e21/2015-08-11T04:17:29Z/3600/host/74c506f68c65e26c633bfa104c863fffac5190fdec1ec24b7c03eb5d67d2e1de

返回示例

HTTP/1.1 200 OK
x-bce-request-id: 1214cca7-4ad5-451d-9215-71cb844c0a50
Date: Wed, 03 Dec 2014 06:42:19 GMT
Content-Type: application/json;charset=UTF-8
Server: BWS

{
    "nextMarker": "task-xktdeMSf",
    "marker": "task-IyWRtII7",
    "maxKeys": 1,
    "isTruncated": true,
    "RepairTask": [
        {
            "taskId": "task-IyWRtII7",
            "instanceId": "i-j93wzbn1",
            "internalIp": "192.168.1.1",
            "status": "processing",
            "errResult": "test error"
        }
    ]
}

维修任务详情

查询维修任务详情

请求结构

GET /v{version}/task/{taskId} HTTP/1.1
Host: bbc.bj.baidubce.com
Authorization: authorization string

请求头域

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

请求参数

参数名称	类型	是否必需	参数位置	描述
version	String	是	URL参数	API版本号
taskId	String	是	URL参数	维修任务ID

返回头域

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

返回参数

参数名称	类型	描述
RepairTaskDetail	RepairTaskDetail	维修任务详细信息

错误码

无特殊返回错误码

请求示例

GET /v2/task/task-tv9xpdWi HTTP/1.1
Host: bbc.bj.baidubce.com
ContentType: application/json
Authorization: bce-auth-v1/f81d3b34e48048fbb2634dc7882d7e21/2015-08-11T04:17:29Z/3600/host/74c506f68c65e26c633bfa104c863fffac5190fdec1ec24b7c03eb5d67d2e1de

返回示例

HTTP/1.1 200 OK
x-bce-request-id: 1214cca7-4ad5-451d-9215-71cb844c0a50
Date: Wed, 03 Dec 2014 06:42:19 GMT
Content-Type: application/json;charset=UTF-8
Server: BWS

{
    "status": "processing",
    "end": "end",
    "floatingIp": "",
    "instanceId": "i-1XeaPYPQ",
    "region": "su",
    "internalIp": "",
    "serverStatus": "repairing",
    "taskId": "task-L3IKPZCl",
    "errResult": "test error",
    "instanceName": "MS_PQ"
}

授权维修任务

用户授权对维修任务进行维修

请求结构

POST /v{version}/task/authorize HTTP/1.1
Host: bbc.bj.baidubce.com
Authorization: authorization string

{
    "taskId": "taskId"
}

请求头域

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

请求参数

参数名称	类型	是否必需	参数位置	描述
version	String	是	URL参数	API版本号
taskId	String	是	Request Body参数	维修任务ID

返回头域

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

返回参数

无特殊返回参数

错误码

错误码	错误描述	HTTP状态码	中文解释
Rp.IllegalArguments	Bad request parameters or illegal request.	400	请求参数无效
Rp.UnexpectedStatus	Task current status cannot be authorized.	409	任务当前状态不可授权

请求示例

POST /v2/task/authorize HTTP/1.1
Host: bbc.bj.baidubce.com
ContentType: application/json
Authorization: bce-auth-v1/f81d3b34e48048fbb2634dc7882d7e21/2015-08-11T04:17:29Z/3600/host/74c506f68c65e26c633bfa104c863fffac5190fdec1ec24b7c03eb5d67d2e1de

{
    "taskId": "example"
}

返回示例

HTTP/1.1 200 OK
x-bce-request-id: 1214cca7-4ad5-451d-9215-71cb844c0a50
Date: Wed, 03 Dec 2014 06:42:19 GMT
Content-Type: application/json;charset=UTF-8
Server: BWS

暂不处理维修任务

用户暂不处理维修任务，后续还可以再授权维修

请求结构

POST /v{version}/task/unauthorize HTTP/1.1
Host: bbc.bj.baidubce.com
Authorization: authorization string

{
    "taskId": "taskId"
}

请求头域

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

请求参数

参数名称	类型	是否必需	参数位置	描述
version	String	是	URL参数	API版本号
taskId	String	是	Request Body参数	维修任务ID

返回头域

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

返回参数

无特殊返回参数

错误码

错误码	错误描述	HTTP状态码	中文解释
Rp.IllegalArguments	Bad request parameters or illegal request.	400	请求参数无效
Rp.UnexpectedStatus	Task current status cannot be unauthorized	409	任务当前状态不可暂不处理

请求示例

POST /v2/task/unauthorize HTTP/1.1
Host: bbc.bj.baidubce.com
ContentType: application/json
Authorization: bce-auth-v1/f81d3b34e48048fbb2634dc7882d7e21/2015-08-11T04:17:29Z/3600/host/74c506f68c65e26c633bfa104c863fffac5190fdec1ec24b7c03eb5d67d2e1de

{
    "taskId": "example"
}

返回示例

HTTP/1.1 200 OK
x-bce-request-id: 1214cca7-4ad5-451d-9215-71cb844c0a50
Date: Wed, 03 Dec 2014 06:42:19 GMT
Content-Type: application/json;charset=UTF-8
Server: BWS

确认故障恢复

确认故障已修复，维修任务关闭

请求结构

POST /v{version}/task/confirm HTTP/1.1
Host: bbc.bj.baidubce.com
Authorization: authorization string

{
    "taskId": "taskId"
}

请求头域

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

请求参数

参数名称	类型	是否必需	参数位置	描述
version	String	是	URL参数	API版本号
taskId	String	是	Request Body参数	维修任务ID

返回头域

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

返回参数

无特殊返回参数

错误码

错误码	错误描述	HTTP状态码	中文解释
Rp.IllegalArguments	Bad request parameters or illegal request.	400	请求参数无效
Rp.UnexpectedStatus	Task current status cannot be confirmed	409	任务当前状态不可确认故障已修复

请求示例

POST /v2/task/confirm HTTP/1.1
Host: bbc.bj.baidubce.com
ContentType: application/json
Authorization: bce-auth-v1/f81d3b34e48048fbb2634dc7882d7e21/2015-08-11T04:17:29Z/3600/host/74c506f68c65e26c633bfa104c863fffac5190fdec1ec24b7c03eb5d67d2e1de

{
    "taskId": "example"
}

返回示例

HTTP/1.1 200 OK
x-bce-request-id: 1214cca7-4ad5-451d-9215-71cb844c0a50
Date: Wed, 03 Dec 2014 06:42:19 GMT
Content-Type: application/json;charset=UTF-8
Server: BWS

确认故障未恢复

维修任务完成后，用户可以确认故障是否修复。如果确认故障未修复，用户可以填入新的故障名称，维修任务重新开始处理

请求结构

POST /v{version}/task/disconfirm HTTP/1.1
Host: bbc.bj.baidubce.com
Authorization: authorization string

{
    "taskId": "taskId",
    "newErrResult":"newErrResult"
}

请求头域

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

请求参数

参数名称	类型	是否必需	参数位置	描述
version	String	是	URL参数	API版本号
taskId	String	是	Request Body参数	维修任务ID
newErrResult	String	是	Request Body参数	新的故障名称，可自定义故障问题

返回头域

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

返回参数

无特殊返回参数

错误码

错误码	错误描述	HTTP状态码	中文解释
Rp.IllegalArguments	Bad request parameters or illegal request.	400	请求参数无效
Rp.UnexpectedStatus	Task current status cannot be disconfirmed	409	任务当前状态不可确认故障未修复

请求示例

POST /v2/task/disconfirm HTTP/1.1
Host: bbc.bj.baidubce.com
ContentType: application/json
Authorization: bce-auth-v1/f81d3b34e48048fbb2634dc7882d7e21/2015-08-11T04:17:29Z/3600/host/74c506f68c65e26c633bfa104c863fffac5190fdec1ec24b7c03eb5d67d2e1de

{
    "taskId": "example",
	"newErrResult": "test error"
}

返回示例

HTTP/1.1 200 OK
x-bce-request-id: 1214cca7-4ad5-451d-9215-71cb844c0a50
Date: Wed, 03 Dec 2014 06:42:19 GMT
Content-Type: application/json;charset=UTF-8
Server: BWS

任务操作记录

任务的操作记录

请求结构

POST /v{version}/task/record HTTP/1.1
Host: bbc.bj.baidubce.com
Authorization: authorization string

{
    "taskId": "taskId"
}

请求头域

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

请求参数

参数名称	类型	是否必需	参数位置	描述
version	String	是	URL参数	API版本号
taskId	String	是	Request Body参数	维修任务ID

返回头域

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

返回参数

参数名称	类型	描述
RepairRecord	OperationRecord	维修任务操作记录

错误码

错误码	错误描述	HTTP状态码	中文解释
Rp.IllegalArguments	Bad request parameters or illegal request.	400	请求参数无效

请求示例

POST /v2/task/record HTTP/1.1
Host: bbc.bj.baidubce.com
ContentType: application/json
Authorization: bce-auth-v1/f81d3b34e48048fbb2634dc7882d7e21/2015-08-11T04:17:29Z/3600/host/74c506f68c65e26c633bfa104c863fffac5190fdec1ec24b7c03eb5d67d2e1de

{
    "taskId": "example"
}

返回示例

HTTP/1.1 200 OK
x-bce-request-id: 1214cca7-4ad5-451d-9215-71cb844c0a50
Date: Wed, 03 Dec 2014 06:42:19 GMT
Content-Type: application/json;charset=UTF-8
Server: BWS

{
  "RepairRecord": [
    {
      "operator": "192.168.1.1",
      "operateTime": "2020-07-29T14:11:52Z",
      "name": "预授权维修任务"
    },
    {
      "operator": "系统",
      "operateTime": "2020-07-29T14:11:52Z",
      "name": "新建维修任务"
    }
  ]
}

预留实例券相关接口

预授权相关接口

百度智能云

云服务器 BCC

云服务器 BCC

维修任务相关接口

查询维修任务列表

维修任务详情

授权维修任务

暂不处理维修任务

确认故障恢复

确认故障未恢复

任务操作记录