接口介绍
开启日志转存功能，将日志按照固定命名规则，以小时为单位生成日志文件写入指定的存储桶。
接口约束
支持的线上资源池 ：上海7、南京3、南京5、杭州2、合肥2、九江、广州6、武汉4、福州25、厦门3、郴州2、海口2、北京5、雄安2、石家庄20、内蒙6、晋中、辽阳1、西安5、乌鲁木齐4、乌鲁木齐27、中卫5、兰州2、西宁2、拉萨3、昆明2、重庆2、成都4、贵州3、上海33、宁波边缘云、华东1、上海36、南昌5、青岛20、武汉41、长沙42、长沙37、南宁23、北京行业云20、华北2、西南1、上海32。
URI
POST /v4/oss/put-bucket-logging
请求参数
请求体 JSON Body 参数
| 参数 | 是否必填 | 参数类型 | 说明 | 示例 |
|---|---|---|---|---|
| bucket | 是 | String | 桶名 | bucket1 |
| regionID | 是 | String | 区域 ID | 332232eb-63aa-465e-9028-52e5123866f0 |
| bucketLoggingStatus | 是 | Object | 日志转存配置 | 见下级对象 |
表 bucketLoggingStatus
| 参数 | 是否必填 | 参数类型 | 说明 | 示例 |
|---|---|---|---|---|
| loggingEnabled | 是 | Object | 日志转存配置 | 见下级对象 |
表 loggingEnabled
| 参数 | 是否必填 | 参数类型 | 说明 | 示例 |
|---|---|---|---|---|
| targetPrefix | 是 | String | 所有日志对象键的前缀。如果你在一个桶中存储来自多个桶的日志文件，你可以使用前缀来区分哪些日志文件来自哪个桶。 | nn_ |
| targetBucket | 是 | String | 指定希望ZOS存储服务器访问日志的桶。你可以让你的日志传递到你拥有的任何桶，包括被记录的同一个桶。你也可以配置多个桶，将它们的日志传递到同一个目标桶。在这种情况下，你应该为每个源桶选择一个不同的TargetPrefix，以便交付的日志文件可以通过密钥区分 | tbk1 |
| targetGrants | 否 | Array of Objects | 授权信息的容器。对对象所有权使用桶所有者强制设置桶不支持目标授予 | 见下级对象 |
表 targetGrants
| 参数 | 是否必填 | 参数类型 | 说明 | 示例 |
|---|---|---|---|---|
| grantee | 是 | Object | 被授予权限的人的容器 | 见下级对象 |
| permission | 是 | String | 分配给桶的被授权者的日志记录权限。 支持 FULL_CONTROL，READ，WRITE | FULL_CONTROL |
表 grantee
| 参数 | 是否必填 | 参数类型 | 说明 | 示例 |
|---|---|---|---|---|
| type | 是 | String | 被授权者类型， CanonicalUser，AmazonCustomerByEmail 两者之一。 type 为 CanonicalUser 时，必填 ID；为 AmazonCustomerByEmail，必填 emailAddress | CanonicalUser |
| emailAddress | 否 | String | 被授权者的邮箱 | example@xx.com |
| displayName | 否 | String | 被授权者的显示名 | dname1 |
| ID | 否 | String | 被授权者的 ID | user1 |
响应参数
| 参数 | 参数类型 | 说明 | 示例 |
|---|---|---|---|
| statusCode | Integer | 返回码 取值范围：800 成功 |
800 |
| message | String | 状态描述 | SUCCESS |
| description | String | 状态描述，一般为中文 | 成功 |
| errorCode | String | 业务细分码（仅失败时具有此参数），为product.module.code三段式码 | openapi.userPermission.accessFailed |
请求示例
{
"bucket": "bucket1",
"regionID": "332232eb-63aa-465e-9028-52e5123866f0",
"bucketLoggingStatus": {
"loggingEnabled": {
"targetPrefix": "nn_",
"targetBucket": "tbk1",
"targetGrants": [
{
"grantee": {
"type": "CanonicalUser",
"emailAddress": "example@xx.com",
"displayName": "dname1",
"ID": "user1"
},
"permission": "FULL_CONTROL"
}
]
}
}
}
响应示例
{
"message": "SUCCESS",
"description": "成功",
"statusCode": 800
}
状态码
| 状态码 | 描述 |
|---|---|
| 800 | 表示请求成功。 |
| 900 | 表示请求失败。 |
错误码
errorCode 枚举值，见错误码总表
