预授权相关接口
更新时间：2024-07-02
维修平台为全局服务 API的服务域名为：bbc.bj.baidubce.com
查询预授权规则列表
查询用户的预授权规则列表
请求结构
GET /v{version}/rule?marker={marker}&maxKeys=1&ruleId={ruleId}&ruleName={ruleName} HTTP/1.1
Host: bbc.bj.baidubce.com
Authorization: authorization string请求头域
除公共头域外，无其它特殊头域。
请求参数
| 参数名称 | 类型 | 是否必需 | 参数位置 | 描述 |
|---|---|---|---|---|
| version | String | 是 | URL参数 | API版本号 |
| marker | String | 否 | Query参数 | 批量获取列表的查询的起始位置，是一个由系统生成的字符串 |
| maxKeys | int | 否 | Query参数 | 每页包含的最大数量，最大数量通常不超过1000。缺省值为1000 |
| ruleId | String | 否 | Query参数 | 预授权规则 ID |
| ruleName | String | 否 | Request Body参数 | 预授权规则名称 |
返回头域
除公共头域，无其它特殊头域。
返回参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
| marker | String | 标记查询的起始位置 |
| isTruncated | boolean | true表示后面还有数据，false表示已经是最后一页 |
| nextMarker | String | 获取下一页所需要传递的marker值。当isTruncated为false时，该域不出现 |
| maxKeys | int | 每页包含的最大数量 |
| RuleList | List<RuleModel> | 预授权规则信息，由 RuleModel 组成的集合 |
错误码
无特殊返回错误码
请求示例
GET /v2/rule?marker=rule-uKxDO5cr&maxKeys=1 HTTP/1.1
Host: bbc.bj.baidubce.com
ContentType: application/json
Authorization: bce-auth-v1/f81d3b34e48048fbb2634dc7882d7e21/2015-08-11T04:17:29Z/3600/host/74c506f68c65e26c633bfa104c863fffac5190fdec1ec24b7c03eb5d67d2e1de返回示例
{
"marker": "",
"isTruncated": false,
"maxKeys": 1000,
"RuleList": [
{
"ruleId": "rule-uKxDO5cr",
"ruleName": "q",
"tagCount": 1,
"associateBbcNum": 13,
"errorBbcNum": 0,
"limit": 10000,
"status": "disabled"
}
]
}
# 维修任务详情预授权规则详情
请求结构
GET /v{version}/rule/{ruleId} HTTP/1.1
Host: bbc.bj.baidubce.com
Authorization: authorization string请求头域
除公共头域外，无其它特殊头域。
请求参数
| 参数名称 | 类型 | 是否必需 | 参数位置 | 描述 |
|---|---|---|---|---|
| version | String | 是 | URL参数 | API版本号 |
| ruleId | String | 是 | URL参数 | 预授权规则ID |
返回头域
除公共头域，无其它特殊头域。
返回参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
| RuleDetail | RuleDetail | 预授权规则详细信息 |
错误码
无特殊返回错误码
请求示例
GET /v2/rule/rule-uKxDO5cr 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
{
"ruleId": "rule-uKxDO5cr",
"ruleName": "q",
"tagCount": 1,
"tags": [
{
"tagKey": "默认项目",
"tagValue": ""
}
],
"associateBbcNum": 13,
"errorBbcNum": 0,
"limit": 10000,
"status": "disabled"
}创建预授权规则
创建预授权规则
请求结构
POST /v{version}/rule/create HTTP/1.1
Host: bbc.bj.baidubce.com
Authorization: authorization string
{
"ruleName":"ruleName",
"limit":limit,
"enabled":enabled
"tagStr":"tagStr"
}请求头域
除公共头域外，无其它特殊头域。
请求参数
| 参数名称 | 类型 | 是否必需 | 参数位置 | 描述 |
|---|---|---|---|---|
| version | String | 是 | URL参数 | API版本号 |
| ruleName | String | 是 | Request Body参数 | 预授权规则名称 |
| limit | int | 是 | Request Body参数 | 预授权规则上限 |
| enabled | int | 否 | Request Body参数 | 是否开启规则，0：不开启，1：开启。默认为0 |
| tagStr | String | 是 | Request Body参数 | 关联的tag，tagKey:tagValue的格式 |
返回头域
除公共头域，无其它特殊头域。
返回参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
| ruleId | String | 预授权规则id |
错误码
无特殊返回错误码
请求示例
POST /v2/rule/create HTTP/1.1
Host: bbc.bj.baidubce.com
ContentType: application/json
Authorization: bce-auth-v1/f81d3b34e48048fbb2634dc7882d7e21/2015-08-11T04:17:29Z/3600/host/74c506f68c65e26c633bfa104c863fffac5190fdec1ec24b7c03eb5d67d2e1de
{
"ruleName":"test-rule",
"limit":10,
"tagStr":"tag1:value1"
}返回示例
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
{
"ruleId": "rule-xxx"
}删除预授权规则
删除预授权规则，只能是被禁用的规则
请求结构
POST /v{version}/rule/delete HTTP/1.1
Host: bbc.bj.baidubce.com
Authorization: authorization string
{
"ruleId":"ruleId"
}请求头域
除公共头域外，无其它特殊头域。
请求参数
| 参数名称 | 类型 | 是否必需 | 参数位置 | 描述 |
|---|---|---|---|---|
| version | String | 是 | URL参数 | API版本号 |
| ruleId | String | 是 | Request Body参数 | 预授权规则id |
返回头域
除公共头域，无其它特殊头域。
返回参数
无特殊返回参数
错误码
无特殊返回错误码
请求示例
PUT /v2/rule/delete HTTP/1.1
Host: bbc.bj.baidubce.com
ContentType: application/json
Authorization: bce-auth-v1/f81d3b34e48048fbb2634dc7882d7e21/2015-08-11T04:17:29Z/3600/host/74c506f68c65e26c633bfa104c863fffac5190fdec1ec24b7c03eb5d67d2e1de
{
"ruleId":"test-rule"
}返回示例
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}/rule/enable HTTP/1.1
Host: bbc.bj.baidubce.com
Authorization: authorization string
{
"ruleId":"ruleId"
}请求头域
除公共头域外，无其它特殊头域。
请求参数
| 参数名称 | 类型 | 是否必需 | 参数位置 | 描述 |
|---|---|---|---|---|
| version | String | 是 | URL参数 | API版本号 |
| ruleId | String | 是 | Request Body参数 | 预授权规则id |
返回头域
除公共头域，无其它特殊头域。
返回参数
无特殊返回参数
错误码
无特殊返回错误码
请求示例
PUT /v2/rule/enable HTTP/1.1
Host: bbc.bj.baidubce.com
ContentType: application/json
Authorization: bce-auth-v1/f81d3b34e48048fbb2634dc7882d7e21/2015-08-11T04:17:29Z/3600/host/74c506f68c65e26c633bfa104c863fffac5190fdec1ec24b7c03eb5d67d2e1de
{
"ruleId":"test-rule"
}返回示例
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}/rule/disable HTTP/1.1
Host: bbc.bj.baidubce.com
Authorization: authorization string
{
"ruleId":"ruleId"
}请求头域
除公共头域外，无其它特殊头域。
请求参数
| 参数名称 | 类型 | 是否必需 | 参数位置 | 描述 |
|---|---|---|---|---|
| version | String | 是 | URL参数 | API版本号 |
| ruleId | String | 是 | Request Body参数 | 预授权规则id |
返回头域
除公共头域，无其它特殊头域。
返回参数
无特殊返回参数
错误码
无特殊返回错误码
请求示例
PUT /v2/rule/disable HTTP/1.1
Host: bbc.bj.baidubce.com
ContentType: application/json
Authorization: bce-auth-v1/f81d3b34e48048fbb2634dc7882d7e21/2015-08-11T04:17:29Z/3600/host/74c506f68c65e26c633bfa104c863fffac5190fdec1ec24b7c03eb5d67d2e1de
{
"ruleId":"test-rule"
}返回示例
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