PutBucketInventory--对象存储-火山引擎

文档中心

立即注册

导航

对象存储

PutBucketInventory

最近更新时间：2024.08.01 20:30:32首次发布时间：2023.10.12 19:40:16

功能描述

此接口用于为存储桶创建桶清单。创建桶清单后，TOS 将按天或周输出对象的各类信息，包括对象的数量、大小、存储类型等。

注意事项

只有存储桶的拥有者以及拥有 PutBucketInventory 权限的用户才能创建桶清单。
每个存储桶最多只能配置 10 条桶清单规则。
创建桶清单的源存储桶与保存清单文件的目标存储桶不需要相同，但是必须位于同一个地域。

请求消息样式

PUT /?inventory&id=report HTTP/1.1
Host: BucketName.tos-cn-beijing.volces.com
Date: Mon, 31 Oct 2016 12:00:00 GMT
Authorization: authorization string
Content-Length: length

{
 "InventoryConfiguration": {
   "Id": "id",
   "IsEnabled": "true",
   "Filter": {
     "Prefix": "Pics/"
   },
   "Destination": {
     "TOSBucketDestination": {
       "Format": "CSV",
       "AccountId": "200000****", 
       "Role": "TosArchiveTOSInventory",
       "Bucket": "destination-bucket",
       "Prefix": "prefix1",
     }
   },
   "Schedule": { "Frequency": "Daily" },
   "IncludedObjectVersions": "All",
   "OptionalFields": {
     "Field": [
       "Size",
       "LastModifiedDate",
       "ETag",
       "StorageClass",
       "IsMultipartUploaded",
       "EncryptionStatus",
       "CRC64",
       "ReplicationStatus",
     ]
   }
 }
}

请求参数和消息头

该请求使用的公共请求消息头，请参见公共参数。

名称	位置	参数类型	是否必选	示例值	说明
inventory	Query	String	是	-	代表 PutBucketInventory 请求的特殊标识。
id	Query	String	是	report	桶清单名称，必须在当前 Bucket 下保持全局唯一。说明如下：长度为 0~64 个字符。只能包含小写字母 a-z、大写字母 A-Z、数字 0-9、中划线（-）、下划线（_）和英文句号（.）。开头和结尾只能是小写字母 a-z、大写字母 A-Z、数字 0-9 。注意消息头中的 `id` 必须和请求元素的 `Id` 保持一致。

名称

位置

参数类型

是否必选

示例值

说明

inventory

Query

String

是

代表 PutBucketInventory 请求的特殊标识。

Query

String

是

report

桶清单名称，必须在当前 Bucket 下保持全局唯一。说明如下：

长度为 0~64 个字符。
只能包含小写字母 a-z、大写字母 A-Z、数字 0-9、中划线（-）、下划线（_）和英文句号（.）。
开头和结尾只能是小写字母 a-z、大写字母 A-Z、数字 0-9 。

注意

消息头中的 id 必须和请求元素的 Id 保持一致。

请求元素

名称	参数类型	是否必填	示例值	说明
InventoryConfiguration	Array	是	-	桶清单规则
Id	String	是	report	桶清单名称，必须在当前 Bucket 下保持全局唯一。说明如下：长度为 0~64 个字符。只能包含小写字母 a-z、大写字母 A-Z、数字 0-9、中划线（-）、下划线（_）和英文句号（.）。开头和结尾只能是小写字母 a-z、大写字母 A-Z、数字 0-9 。注意请求元素的 `Id` 必须和消息头中的 `id` 保持一致。
IsEnabled	Bool	是	true	是否启用桶清单功能。取值如下： `true`：启用桶清单功能。 `false`：不启用桶清单功能。
Destination	Array	是	-	清单文件的相关信息。
TOSBucketDestination	Array	是	-	清单文件的存储桶相关信息。父节点：Destination
Format	String	是	CSV	清单文件的格式。取值 `CSV`，即清单文件的格式为使用 GZIP 压缩后的 CSV 格式。父节点：TOSBucketDestination
AccountId	String	是	200000****	存储桶所有者的账号 ID。父节点：TOSBucketDestination
Role	String	是	TosArchiveTOSInventory	角色名称，用于授予对象存储读取源存储桶所有文件和向目标存储桶写入文件的权限。该角色必须具有 TOS 的读写权限及服务访问权限，您也可以使用 TOS 默认角色 `TosArchiveTOSInventory`。父节点：TOSBucketDestination
Bucket	String	是	bucket_0001	指定保存清单文件的存储桶。父节点：TOSBucketDestination
Prefix	String	否	prefix1	清单文件的存储路径前缀。默认保存在目标存储桶的 `tos_bucket_inventory/sourceBucketName/inventoryId/YYYY-MM-DDTHH-MMZ/files` 路径下。父节点：TOSBucketDestination
Schedule	Array	是	-	桶清单导出周期信息。
Frequency	String	是	Daily	清单文件导出的周期。取值如下： `Daily`：按天导出清单文件。 `Weekly`：按周导出清单文件。父节点：Schedule
IncludedObjectVersions	String	是	All	导出的对象版本，取值如下： `All`：导出所有版本的对象信息。 `Current`：导出当前版本的对象信息。
Filter	Array	否	-	桶清单筛选的前缀。指定前缀后，桶清单将仅导出符合前缀设置的对象。
Prefix	String	否	Pics/	导出文件前缀匹配信息，如果不设置，默认生成桶中所有对象的清单。父节点：Filter
OptionalFields	Array	否	-	清单文件导出的信息。
Field	String	否	Size	清单文件需要导出的信息。支持多选，取值如下： `Size`：对象的大小。 `LastModifiedDate`：对象的最后修改时间。 `ETag`：对象的 ETag 值，用于标识对象的内容。 `StorageClass`：对象的存储类型。 `IsMultipartUploaded`：是否为通过分片上传方式上传的对象。 `EncryptionStatus`：对象是否加密。 `CRC64`：对象的 CRC64 值。 `ReplicationStatus`：对象的跨区域复制或同区域复制状态。说明查看跨区域复制和同区域复制源对象的复制状态功能目前处于邀测状态，如您需要使用该功能，请联系客户经理。默认导出所有信息。父节点：OptionalFields

响应消息头

该请求返回的公共响应消息头，请参见公共参数。

响应元素

该请求响应中无消息元素。

请求示例

PUT /?inventory&id=report HTTP/1.1
Host: BucketName.tos-cn-beijing.volces.com
Date: Sat, 07 Oct 2023 09:02:23 GMT
Authorization: authorization string

{
 "InventoryConfiguration": {
   "Id": "report",
   "IsEnabled": "true",
   "Filter": {
     "Prefix": "Pics/"
   },
   "Destination": {
     "TOSBucketDestination": {
       "Format": "CSV",
       "AccountId": "200000****", 
       "Role": "TosArchiveTOSInventory",
       "Bucket": "destination-bucket",
       "Prefix": "prefix1"
     }
   },
   "Schedule": { "Frequency": "Daily" },
   "IncludedObjectVersions": "All",
   "OptionalFields": {
     "Field": [
       "Size",
       "LastModifiedDate",
       "ETag",
       "StorageClass",
       "IsMultipartUploaded",
       "EncryptionStatus",
       "CRC64",         "ReplicationStatus"
     ]
   }
 }
}

响应示例

HTTP/1.1 200 OK
Date: Sat, 07 Oct 2023 09:02:23 GMT
Server: TosServer
x-tos-id-2: 1e89f203jld00006-a444fd0
x-tos-request-id: 1e89f203b2d00006-a444ed0
Content-Length: 0