接口功能介绍
在用户在某个region下开通事件总线功能时,可为指定的桶设置事件总线功能。
接口约束
仅支持已开通pass事件总线功能的部分资源池。
URI
POST v4/oss/put-bucket-event-bridge
路径参数
无
Query参数
无
请求参数
请求头header参数
无
请求体body参数
参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
---|---|---|---|---|---|
bucket | 是 | String | 桶名 | Bucket1 | |
regionID | 是 | String | 区域 ID | 332232eb-63aa-465e-9028-52e5123866f0 | |
bucketEventBridgeEnabled | 是 | Boolean | 桶的事件总线配置,ture启用桶的事件总线功能,false则关闭桶的事件总线功能 | true |
响应参数
参数 | 参数类型 | 说明 | 示例 | 下级对象 |
---|---|---|---|---|
statusCode | Integer | 返回码 取值范围:800 成功 | 800 | |
message | String | 状态描述 | SUCCESS | |
description | String | 状态描述,一般为中文 | 成功 | |
returnObj | Object | 响应对象 | ||
errorCode | String | 业务细分码(仅失败时具有此参数),为 product.module.code 三段式码 | openapi.userPermission.accessFailed | |
error | String | 业务细分码(大驼峰形式,仅失败时具有此参数),为 Product.Module.Code 三段式码 | Openapi.UserPermission.AccessFailed |
请求示例
请求url
无
请求头header
无
请求体body
{
"bucket": "bucket1",
"regionID": "332232eb-63aa-465e-9028-52e5123866f0",
"bucketEventBridgeEnabled": true
}
响应示例
{
"returnObj": {
},
"message": "SUCCESS",
"description": "成功",
"statusCode": 800
}
状态码
状态码 | 描述 |
---|---|
800 | 表示请求成功。 |
900 | 表示请求失败。 |
错误码
errorCode 及 error 枚举值,见错误码总表