Maintenance Task Related Interfaces
The service domain name for the maintenance platform, a global service API, is: bbc.bj.baidubce.com
Query maintenance task list
Query all unclosed maintenance tasks
Request structure
1GET /v{version}/task?marker={marker}&maxKeys={maxKeys}&startTime={startTime}&endTime={endTime} HTTP/1.1
2Host: bbc.bj.baidubce.com
3Authorization: authorization string
Request headers
There are no special headers required beyond the common headers.
Request parameters
| Parameter name | Types | Whether required | Parameter location | Description |
|---|---|---|---|---|
| version | String | Yes | URL parameter | API version number |
| marker | String | No | Query | The starting position of the batch list query is a system-generated string |
| maxKeys | int | No | Query | The maximum number of items per page is 1,000, with a default value of 1,000. |
| instanceId | String | No | Query | ID of the faulty instance |
| internalIp | String | No | Query | Intranet IP of the faulty instance |
| status | String | No | Request Body parameters | Task status |
| timeRangeType | String | No | Request Body parameters | Time node type. Current supported types: errStart, newTask, authorizeTask, unAuthorizeTask |
| timeRangeStart | String | No | Request Body parameters | Start time for timeRangeType, e.g., 2021-06-29 19:00:00. If left empty, only timeRangeEnd will apply. |
| timeRangeEnd | String | No | Request Body parameters | End time for timeRangeType, e.g., 2021-06-29 19:00:00. If left empty, only timeRangeStart will apply. |
Response headers
No special headers are required beyond the standard ones.
Response parameters
| Parameter name | Types | Description |
|---|---|---|
| marker | String | Mark the starting position of the query. |
| isTruncated | boolean | true indicates there is more data later, false indicates it is the last page |
| nextMarker | String | The marker value needed to fetch the next page. This field is absent when isTruncated is false. |
| maxKeys | int | Maximum number of items included per page |
| RepairTask | List<[TaskModel](BCC/API Reference/Appendix.md#TaskModel)> | Maintenance task information, a collection composed of TaskModel |
Error codes
No special error codes are returned
Request example
1GET /v2/task?marker=task-IyWRtII7&maxKeys=1&startTime=2021-06-29 19:00:00&endTime=2021-07-07 10:26:35 HTTP/1.1
2Host: bbc.bj.baidubce.com
3ContentType: application/json
4Authorization: bce-auth-v1/f81d3b34e48048fbb2634dc7882d7e21/2015-08-11T04:17:29Z/3600/host/74c506f68c65e26c633bfa104c863fffac5190fdec1ec24b7c03eb5d67d2e1de
Response example
1HTTP/1.1 200 OK
2x-bce-request-id: 1214cca7-4ad5-451d-9215-71cb844c0a50
3Date: Wed, 03 Dec 2014 06:42:19 GMT
4Content-Type: application/json;charset=UTF-8
5Server: BWS
6
7{
8 "nextMarker": "task-xktdeMSf",
9 "marker": "task-IyWRtII7",
10 "maxKeys": 1,
11 "isTruncated": true,
12 "RepairTask": [
13 {
14 "taskId": "task-IyWRtII7",
15 "instanceId": "i-j93wzbn1",
16 "internalIp": "192.168.1.1",
17 "status": "processing",
18 "errResult": "test error"
19 }
20 ]
21}
Maintenance task details
Query maintenance task details
Request structure
1GET /v{version}/task/{taskId} HTTP/1.1
2Host: bbc.bj.baidubce.com
3Authorization: authorization string
Request headers
There are no special headers required beyond the common headers.
Request parameters
| Parameter name | Types | Whether required | Parameter location | Description |
|---|---|---|---|---|
| version | String | Yes | URL parameter | API version number |
| taskId | String | Yes | URL parameter | Maintenance task ID |
Response headers
No special headers are required beyond the standard ones.
Response parameters
| Parameter name | Types | Description |
|---|---|---|
| RepairTaskDetail | [RepairTaskDetail](BCC/API Reference/Appendix.md#RepairTaskDetail) | Detailed maintenance task information |
Error codes
No special error codes are returned
Request example
1GET /v2/task/task-tv9xpdWi HTTP/1.1
2Host: bbc.bj.baidubce.com
3ContentType: application/json
4Authorization: bce-auth-v1/f81d3b34e48048fbb2634dc7882d7e21/2015-08-11T04:17:29Z/3600/host/74c506f68c65e26c633bfa104c863fffac5190fdec1ec24b7c03eb5d67d2e1de
Response example
1HTTP/1.1 200 OK
2x-bce-request-id: 1214cca7-4ad5-451d-9215-71cb844c0a50
3Date: Wed, 03 Dec 2014 06:42:19 GMT
4Content-Type: application/json;charset=UTF-8
5Server: BWS
6
7{
8 "status": "processing",
9 "end": "end",
10 "floatingIp": "",
11 "instanceId": "i-1XeaPYPQ",
12 "region": "su",
13 "internalIp": "",
14 "serverStatus": "repairing",
15 "taskId": "task-L3IKPZCl",
16 "errResult": "test error",
17 "instanceName": "MS_PQ"
18}
Authorize maintenance task
User authorizes the maintenance of the maintenance task
Request structure
1POST /v{version}/task/authorize HTTP/1.1
2Host: bbc.bj.baidubce.com
3Authorization: authorization string
4
5{
6 "taskId": "taskId"
7}
Request headers
There are no special headers required beyond the common headers.
Request parameters
| Parameter name | Types | Whether required | Parameter location | Description |
|---|---|---|---|---|
| version | String | Yes | URL parameter | API version number |
| taskId | String | Yes | Request Body parameters | Maintenance task ID |
Response headers
No special headers are required beyond the standard ones.
Response parameters
There are no special response parameters
Error codes
| Error code | Error description | HTTP status code | Chinese explanation |
|---|---|---|---|
| Rp.IllegalArguments | Bad request parameters or illegal request. | 400 | Invalid request parameters |
| Rp.UnexpectedStatus | Task current status cannot be authorized. | 409 | The current task status does not allow authorization |
Request example
1POST /v2/task/authorize HTTP/1.1
2Host: bbc.bj.baidubce.com
3ContentType: application/json
4Authorization: bce-auth-v1/f81d3b34e48048fbb2634dc7882d7e21/2015-08-11T04:17:29Z/3600/host/74c506f68c65e26c633bfa104c863fffac5190fdec1ec24b7c03eb5d67d2e1de
5
6{
7 "taskId": "example"
8}
Response example
1HTTP/1.1 200 OK
2x-bce-request-id: 1214cca7-4ad5-451d-9215-71cb844c0a50
3Date: Wed, 03 Dec 2014 06:42:19 GMT
4Content-Type: application/json;charset=UTF-8
5Server: BWS
Temporarily do not handle the maintenance task
The user temporarily does not handle the maintenance task but can authorize maintenance later
Request structure
1POST /v{version}/task/unauthorize HTTP/1.1
2Host: bbc.bj.baidubce.com
3Authorization: authorization string
4
5{
6 "taskId": "taskId"
7}
Request headers
There are no special headers required beyond the common headers.
Request parameters
| Parameter name | Types | Whether required | Parameter location | Description |
|---|---|---|---|---|
| version | String | Yes | URL parameter | API version number |
| taskId | String | Yes | Request Body parameters | Maintenance task ID |
Response headers
No special headers are required beyond the standard ones.
Response parameters
There are no special response parameters
Error codes
| Error code | Error description | HTTP status code | Chinese explanation |
|---|---|---|---|
| Rp.IllegalArguments | Bad request parameters or illegal request. | 400 | Invalid request parameters |
| Rp.UnexpectedStatus | Task current status cannot be unauthorized | 409 | The current task status does not allow temporary non-handling |
Request example
1POST /v2/task/unauthorize HTTP/1.1
2Host: bbc.bj.baidubce.com
3ContentType: application/json
4Authorization: bce-auth-v1/f81d3b34e48048fbb2634dc7882d7e21/2015-08-11T04:17:29Z/3600/host/74c506f68c65e26c633bfa104c863fffac5190fdec1ec24b7c03eb5d67d2e1de
5
6{
7 "taskId": "example"
8}
Response example
1HTTP/1.1 200 OK
2x-bce-request-id: 1214cca7-4ad5-451d-9215-71cb844c0a50
3Date: Wed, 03 Dec 2014 06:42:19 GMT
4Content-Type: application/json;charset=UTF-8
5Server: BWS
Confirm fault resolved
Confirm that the fault has been resolved, and the maintenance task is closed
Request structure
1POST /v{version}/task/confirm HTTP/1.1
2Host: bbc.bj.baidubce.com
3Authorization: authorization string
4
5{
6 "taskId": "taskId"
7}
Request headers
There are no special headers required beyond the common headers.
Request parameters
| Parameter name | Types | Whether required | Parameter location | Description |
|---|---|---|---|---|
| version | String | Yes | URL parameter | API version number |
| taskId | String | Yes | Request Body parameters | Maintenance task ID |
Response headers
No special headers are required beyond the standard ones.
Response parameters
There are no special response parameters
Error codes
| Error code | Error description | HTTP status code | Chinese explanation |
|---|---|---|---|
| Rp.IllegalArguments | Bad request parameters or illegal request. | 400 | Invalid request parameters |
| Rp.UnexpectedStatus | Task current status cannot be confirmed | 409 | The current task status does not allow "resolved" confirmation |
Request example
1POST /v2/task/confirm HTTP/1.1
2Host: bbc.bj.baidubce.com
3ContentType: application/json
4Authorization: bce-auth-v1/f81d3b34e48048fbb2634dc7882d7e21/2015-08-11T04:17:29Z/3600/host/74c506f68c65e26c633bfa104c863fffac5190fdec1ec24b7c03eb5d67d2e1de
5
6{
7 "taskId": "example"
8}
Response example
1HTTP/1.1 200 OK
2x-bce-request-id: 1214cca7-4ad5-451d-9215-71cb844c0a50
3Date: Wed, 03 Dec 2014 06:42:19 GMT
4Content-Type: application/json;charset=UTF-8
5Server: BWS
Confirm fault not resolved
Once the maintenance task is completed, the user can confirm whether the issue has been resolved. If the issue persists, the user can enter a new fault name, and the maintenance task will resume.
Request structure
1POST /v{version}/task/disconfirm HTTP/1.1
2Host: bbc.bj.baidubce.com
3Authorization: authorization string
4
5{
6 "taskId": "taskId",
7 "newErrResult":"newErrResult"
8}
Request headers
There are no special headers required beyond the common headers.
Request parameters
| Parameter name | Types | Whether required | Parameter location | Description |
|---|---|---|---|---|
| version | String | Yes | URL parameter | API version number |
| taskId | String | Yes | Request Body parameters | Maintenance task ID |
| newErrResult | String | Yes | Request Body parameters | New fault name, customizable fault description |
Response headers
No special headers are required beyond the standard ones.
Response parameters
There are no special response parameters
Error codes
| Error code | Error description | HTTP status code | Chinese explanation |
|---|---|---|---|
| Rp.IllegalArguments | Bad request parameters or illegal request. | 400 | Invalid request parameters |
| Rp.UnexpectedStatus | Task current status cannot be disconfirmed | 409 | The current task status does not allow "unresolved" confirmation |
Request example
1POST /v2/task/disconfirm HTTP/1.1
2Host: bbc.bj.baidubce.com
3ContentType: application/json
4Authorization: bce-auth-v1/f81d3b34e48048fbb2634dc7882d7e21/2015-08-11T04:17:29Z/3600/host/74c506f68c65e26c633bfa104c863fffac5190fdec1ec24b7c03eb5d67d2e1de
5
6{
7 "taskId": "example",
8 "newErrResult": "test error"
9}
Response example
1HTTP/1.1 200 OK
2x-bce-request-id: 1214cca7-4ad5-451d-9215-71cb844c0a50
3Date: Wed, 03 Dec 2014 06:42:19 GMT
4Content-Type: application/json;charset=UTF-8
5Server: BWS
Task operation records
Task operation records
Request structure
1POST /v{version}/task/record HTTP/1.1
2Host: bbc.bj.baidubce.com
3Authorization: authorization string
4
5{
6 "taskId": "taskId"
7}
Request headers
There are no special headers required beyond the common headers.
Request parameters
| Parameter name | Types | Whether required | Parameter location | Description |
|---|---|---|---|---|
| version | String | Yes | URL parameter | API version number |
| taskId | String | Yes | Request Body parameters | Maintenance task ID |
Response headers
No special headers are required beyond the standard ones.
Response parameters
| Parameter name | Types | Description |
|---|---|---|
| RepairRecord | OperationRecord | Maintenance task operation records |
Error codes
| Error code | Error description | HTTP status code | Chinese explanation |
|---|---|---|---|
| Rp.IllegalArguments | Bad request parameters or illegal request. | 400 | Invalid request parameters |
Request example
1POST /v2/task/record HTTP/1.1
2Host: bbc.bj.baidubce.com
3ContentType: application/json
4Authorization: bce-auth-v1/f81d3b34e48048fbb2634dc7882d7e21/2015-08-11T04:17:29Z/3600/host/74c506f68c65e26c633bfa104c863fffac5190fdec1ec24b7c03eb5d67d2e1de
5
6{
7 "taskId": "example"
8}
Response example
1HTTP/1.1 200 OK
2x-bce-request-id: 1214cca7-4ad5-451d-9215-71cb844c0a50
3Date: Wed, 03 Dec 2014 06:42:19 GMT
4Content-Type: application/json;charset=UTF-8
5Server: BWS
6
7{
8 "RepairRecord": [
9 {
10 "operator": "192.168.1.1",
11 "operateTime": "2020-07-29T14:11:52Z",
12 "name": "pre-authorize maintenance task"
13 },
14 {
15 "operator": "system",
16 "operateTime": "2020-07-29T14:11:52Z",
17 "name": "new maintenance task"
18 }
19 ]
20}
