Pre-authorization Related Interfaces
The service domain name for the maintenance platform, a global service API, is: bbc.bj.baidubce.com
Query pre-authorization rule list
Query user's pre-authorization rule list
Request structure
1GET /v{version}/rule?marker={marker}&maxKeys=1&ruleId={ruleId}&ruleName={ruleName} HTTP/1.1
2Host: bbc.bj.baidubce.com
3Authorization: authorization stringRequest 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. |
| ruleId | String | No | Query | Pre-authorization rule ID |
| ruleName | String | No | Request Body parameters | Pre-authorization rule name |
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 |
| RuleList | List<[RuleModel](BCC/API Reference/Appendix.md#RuleModel)> | Pre-authorization rule information, a collection composed of RuleModel |
Error codes
No special error codes are returned
Request example
1GET /v2/rule?marker=rule-uKxDO5cr&maxKeys=1 HTTP/1.1
2Host: bbc.bj.baidubce.com
3ContentType: application/json
4Authorization: bce-auth-v1/f81d3b34e48048fbb2634dc7882d7e21/2015-08-11T04:17:29Z/3600/host/74c506f68c65e26c633bfa104c863fffac5190fdec1ec24b7c03eb5d67d2e1deResponse example
1{
2 "marker": "",
3 "isTruncated": false,
4 "maxKeys": 1000,
5 "RuleList": [
6 {
7 "ruleId": "rule-uKxDO5cr",
8 "ruleName": "q",
9 "tagCount": 1,
10 "associateBbcNum": 13,
11 "errorBbcNum": 0,
12 "limit": 10000,
13 "status": "disabled"
14 }
15 ]
16}
17
18# Maintenance task detailsPre-authorization rule details
Request structure
1GET /v{version}/rule/{ruleId} HTTP/1.1
2Host: bbc.bj.baidubce.com
3Authorization: authorization stringRequest 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 |
| ruleId | String | Yes | URL parameter | Pre-authorization rule ID |
Response headers
No special headers are required beyond the standard ones.
Response parameters
| Parameter name | Types | Description |
|---|---|---|
| RuleDetail | [RuleDetail](BCC/API Reference/Appendix.md#RuleDetail) | Detailed pre-authorization rule information |
Error codes
No special error codes are returned
Request example
1GET /v2/rule/rule-uKxDO5cr HTTP/1.1
2Host: bbc.bj.baidubce.com
3ContentType: application/json
4Authorization: bce-auth-v1/f81d3b34e48048fbb2634dc7882d7e21/2015-08-11T04:17:29Z/3600/host/74c506f68c65e26c633bfa104c863fffac5190fdec1ec24b7c03eb5d67d2e1deResponse 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 "ruleId": "rule-uKxDO5cr",
9 "ruleName": "q",
10 "tagCount": 1,
11 "tags": [
12 {
13 "tagKey": "Default project",
14 "tagValue": ""
15 }
16 ],
17 "associateBbcNum": 13,
18 "errorBbcNum": 0,
19 "limit": 10000,
20 "status": "disabled"
21}Create a pre-authorization rule
Create a pre-authorization rule
Request structure
1POST /v{version}/rule/create HTTP/1.1
2Host: bbc.bj.baidubce.com
3Authorization: authorization string
4
5{
6 "ruleName":"ruleName",
7 "limit":limit,
8 "enabled":enabled
9 "tagStr":"tagStr"
10}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 |
| ruleName | String | Yes | Request Body parameters | Pre-authorization rule name |
| limit | int | Yes | Request Body parameters | Pre-authorization rule cap |
| enabled | int | No | Request Body parameters | Rule enabling status. 0: not enabled, 1: enabled. Default is 0. |
| tagStr | String | Yes | Request Body parameters | Associated tag, format: tagKey:tagValue |
Response headers
No special headers are required beyond the standard ones.
Response parameters
| Parameter name | Types | Description |
|---|---|---|
| ruleId | String | Pre-authorization rule ID |
Error codes
No special error codes are returned
Request example
1POST /v2/rule/create 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 "ruleName":"test-rule",
8 "limit":10,
9 "tagStr":"tag1:value1"
10}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 "ruleId": "rule-xxx"
9}Delete a pre-authorization rule
Delete a pre-authorization rule. Only disabled rules can be deleted
Request structure
1POST /v{version}/rule/delete HTTP/1.1
2Host: bbc.bj.baidubce.com
3Authorization: authorization string
4
5{
6 "ruleId":"ruleId"
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 |
| ruleId | String | Yes | Request Body parameters | Pre-authorization rule ID |
Response headers
No special headers are required beyond the standard ones.
Response parameters
There are no special response parameters
Error codes
No special error codes are returned
Request example
1PUT /v2/rule/delete 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 "ruleId":"test-rule"
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: BWSEnable a pre-authorization rule
Enable a pre-authorization rule. Only disabled rules can be enabled
Request structure
1POST /v{version}/rule/enable HTTP/1.1
2Host: bbc.bj.baidubce.com
3Authorization: authorization string
4
5{
6 "ruleId":"ruleId"
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 |
| ruleId | String | Yes | Request Body parameters | Pre-authorization rule ID |
Response headers
No special headers are required beyond the standard ones.
Response parameters
There are no special response parameters
Error codes
No special error codes are returned
Request example
1PUT /v2/rule/enable 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 "ruleId":"test-rule"
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: BWSDisable a pre-authorization rule
Disable a pre-authorization rule. Only enabled rules can be disabled
Request structure
1POST /v{version}/rule/disable HTTP/1.1
2Host: bbc.bj.baidubce.com
3Authorization: authorization string
4
5{
6 "ruleId":"ruleId"
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 |
| ruleId | String | Yes | Request Body parameters | Pre-authorization rule ID |
Response headers
No special headers are required beyond the standard ones.
Response parameters
There are no special response parameters
Error codes
No special error codes are returned
Request example
1PUT /v2/rule/disable 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 "ruleId":"test-rule"
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