設置桶日志轉存
更新時間 2025-06-11 14:55:20
最近更新時間: 2025-06-11 14:55:20
分享文章
接口介紹
開啟日志轉存功能，將日志按照固定命名規則，以小時為單位生成日志文件寫入指定的存儲桶。
接口約束
支持的線上資源池 ：上海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 枚舉值，見錯誤碼總表
