PUT Bucket Inventory

PUT Bucket Inventory接口用于为某个Bucket配置存储清单规则。

提示：为避免出错，推荐用户在控制台进行存储清单规则的设置，更加简单高效。

用户设置规则后，KS3会根据用户的设置，导出一份清单报告

说明

• 只有Bucket的拥有者或被授予KS3:PutBucketInventory权限的用户才能调用该接口。

• 首次使用清单功能时，需进入KS3 控制台，通过控制台指引，跳转至授权服务页进行授权，如果没有进行授权，则无法使用该接口。

• 单个Bucket最多只能配置10条清单规则。

• 配置清单的源Bucket与存放导出的清单文件所在的目标Bucket必须位于同一个Region。

请求

请求语法

PUT /?inventory&id=example-inventory HTTP/1.1
Host: {BucketName}.{endpoint}
Date: {date}
Authorization: {SignatureValue}
Content-Length: {length}
Content-MD5:{MD5}
 
<?xml version="1.0" encoding="UTF-8"?>
<InventoryConfiguration>
   <Id>example-inventory</Id>
   <IsEnabled>true</IsEnabled>
   <Filter>
      <Prefix>filterPrefix</Prefix>
   </Filter>
   <Destination>
      <KS3BucketDestination>
         <Format>CSV</Format>
         <AccountId>1234567890</AccountId>
         <Bucket>examplebucket</Bucket>
         <Prefix>ks3-inventory</Prefix>
      </KS3BucketDestination>
   </Destination>
   <Schedule>
      <Frequency>Daily</Frequency>
   </Schedule>
   <OptionalFields>
      <Field>Size</Field>
      <Field>LastModifiedDate</Field>
      <Field>ETag</Field>
      <Field>StorageClass</Field>
      <Field>IsMultipartUploaded</Field>
      <Field>EncryptionStatus</Field>
   </OptionalFields>
</InventoryConfiguration>

注意

• endpoint与Region对应关系
• SignatureValue签名算法

请求参数

参数	描述	是否必选
InventoryConfiguration	清单的配置参数 类型：Container	是
id	用户指定的清单名称，在单个Bucket下，清单名称唯一 类型：String	是
IsEnabled	清单功能是否启用，不区分大小写 类型：Boolean 有效值true/false true：清单功能启用 false：清单功能关闭	是
Filter	指定扫描前缀信息 类型：Container	否
Prefix	指定清单扫描的前缀 类型：String 父节点：Filter	否
LastModifyBeginTimeStamp	筛选文件最后修改时间的起始时间戳，单位为秒 类型：int 父节点：Filter	否
LastModifyEndTimeStamp	筛选文件最后修改时间的终止时间戳，单位为秒 类型：int 父节点：Filter	否
Destination	存放清单结果 类型：Container	是
KS3BucketDestination	清单结果导出后存放的Bucket信息 类型：Container 父节点：Destination	是
Format	清单文件的文件格式，清单文件导出后的格式为使用GZIP压缩的CSV文件 类型：String 父节点：Destination	是
AccountId	Bucket所有者的账号ID 类型：int 父节点：KS3BucketDestination	否
Bucket	存放导出的清单文件的Bucket 类型：String 父节点：KS3BucketDestination	是
Prefix	清单文件的存储路径前缀 类型：String 父节点：KS3BucketDestination	否
Schedule	存放清单导出周期信息的容器 类型：Container 父节点：InventoryConfiguration	是
Frequency	清单文件导出的周期 类型：String 有效值：Once、Weekly 父节点：Schedule	是
OptionalFields	设置清单结果中包含的配置项 类型：Container 父节点：InventoryConfiguration	是
Field	清单结果中包含的配置项 类型：String 有效值： Size：Object的大小 LastModifiedDate：Object的最后修改时间 ETag：Object的ETag值，用于标识Object的内容 StorageClass：Object的存储类型 IsMultipartUploaded：是否为通过分片上传方式上传的Object EncryptionStatus：Object是否加密。若Object已加密，则该字段值为True，否则为False	否

请求头部

该接口只使用常用请求头部。获取更多信息，请点击 公共请求头。

请求内容

该接口不使用请求内容。

响应

响应头部

该接口可以使用所有常用响应头部。获取更多信息，请点击 公共响应头。

响应内容

该接口不返回响应内容。

特殊错误

该接口不返回任何特殊错误。

示例

请求示例

PUT /?inventory&id=inventoryId HTTP/1.1
Host: <BucketName>.<Region>.ksyun.com
Date: GMT Date
Authorization: Auth String
Content-Length: length
Content-MD5:MD5
  
<InventoryConfiguration>
    <Id>list1</Id>
    <IsEnabled>true</IsEnabled>
    <Destination>
        <KS3BucketDestination>
            <Format>CSV</Format>
            <AccountId>100000000001</AccountId>
            <Bucket>examplebucket</Bucket>
            <Prefix>list1</Prefix>
        </KS3BucketDestination>
    </Destination>
    <Schedule>
        <Frequency>Daily</Frequency>
    </Schedule>
    <Filter>
        <Prefix>myPrefix</Prefix>
        <LastModifyBeginTimeStamp>1637883649</LastModifyBeginTimeStamp>
        <LastModifyEndTimeStamp>1638347592</LastModifyEndTimeStamp>
    </Filter>
    <IncludedObjectVersions>All</IncludedObjectVersions>
    <OptionalFields>
        <Field>Size</Field>
        <Field>LastModifiedDate</Field>
        <Field>ETag</Field>
        <Field>StorageClass</Field>
        <Field>IsMultipartUploaded</Field>
        <Field>EncryptionStatus</Field>
    </OptionalFields>
    <OrderBy>LastModifiedDate</OrderBy>
</InventoryConfiguration>

响应示例

HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length:0
date: Tue,09Apr202003:00:33GMT
Server: ks3
x-ks3-request-id: 5CAC0AD16D0232E2051B****

错误码

错误码	HTTP状态码	描述
InvalidArgument	400	传入非法参数
AccessDenied	403	用户无操作权限