金山云-文档中心-GET Bucket Inventory

对象存储(KS3)

查看更多结果

未找到含当前关键字的文档标题

页面目录

全部展开全部收起

产品更新动态

未找到含该关键词的产品

文档中心

对象存储(KS3)

API文档

Bucket相关

清单（Inventory）

GET Bucket Inventory

最近更新时间：2024-11-20 10:15:18

GET Bucket Inventory用于查看某个存储空间（Bucket）中指定的清单（Inventory）任务。使用此接口，需要是Bucket的拥有者或被授予KS3:GetBucketInventory权限的用户。

请求

请求语法

GET /?Inventory&id=example-inventory HTTP/1.1
Host: {BucketName}.{endpoint}
Date: {date}
Authorization: {SignatureValue}

注意

请求参数

参数	描述	是否必选
id	查询的清单规则名称类型：string 示例：example-inventory	是

请求头部

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

请求内容

该接口不使用请求内容。

响应

响应头部

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

响应内容

参数	描述	是否必选
InventoryConfiguration	清单的配置参数类型：Container	是
Id	用户指定的清单名称，在单个Bucket下，清单名称唯一类型：String	是
IsEnabled	清单是否启用有效值：true/false true：清单功能启用 false：清单功能关闭	是
Filter	指定扫描前缀信息类型：Container	否
Prefix	指定清单扫描的前缀类型：String 父节点：Filter	否
Destination	存放清单结果类型：Container	是
KS3BucketDestination	清单结果导出后存放的Bucket信息类型：Container 父节点：Destination	是
Format	导出清单文件的文件格式类型：String 有效值：CSV、ORC、Parquet 父节点：KS3BucketDestination	是
AccountId	Bucket所有者的账号ID 类型：int 父节点：KS3BucketDestination	是
Bucket	导出清单文件的Bucket 类型：String 父节点：KS3BucketDestination	是
Prefix	清单文件的存储路径类型：String 父节点：KS3BucketDestination	否
Schedule	存放清单导出周期信息类型：Container	是
Frequency	清单文件导出的周期类型：String 有效值：Once、Daily、Weekly 父节点：Schedule	是
OptionalFields	设置清单结果中应包含的配置项类型：Container	否
OptionalFields	清单结果中包含的配置项类型：String 可选的配置项：Size、LastModifiedDate、ETag、StorageClass、IsMultipartUploaded、EncryptionStatus 父节点：OptionalFields	否

特殊错误

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

示例

请求示例

GET /?inventory&id=inventoryId HTTP/1.1
Host: <BucketName>.<Region>.ksyun.com
Date: GMT Date
Authorization: Auth String

响应示例

HTTP/1.1 200 OK
x-kss-request-id: 56594298207FB304438516F9
Date: Mon, 31 Oct 2016 12:00:00 GMT
Server: ks3
Content-Length: length
  
<?xml version="1.0" encoding="UTF-8"?>
 <InventoryConfiguration">
    <Id>report1</Id>
    <IsEnabled>true</IsEnabled>
    <Destination>
       <KS3BucketDestination>
          <Format>CSV</Format>
          <AccountId>1000000000000000</AccountId>
          <Bucket>examplebucket</Bucket>
          <Prefix>prefix1</Prefix>
       </KS3BucketDestination>
    </Destination>
    <Schedule>
       <Frequency>Daily</Frequency>
    </Schedule>
    <Filter>
      <Prefix>myprefix/</Prefix>
    </Filter>
    <IncludedObjectVersions>All</IncludedObjectVersions>
    <OptionalFields>
       <Field>Size</Field>
       <Field>LastModifiedDate</Field>
       <Field>ETag</Field>
       <Field>StorageClass</Field>
       <Field>IsMultipartUploaded</Field>
       <Field>EncryptionStatus</Field>
    </OptionalFields>
</InventoryConfiguration>

错误码

错误码	HTTP状态码	描述
NoSuchInventoryConfiguration	404	没有指定Id对应的清单配置
AccessDenied	403	用户无操作权限

文档导读

上一篇：PUT Bucket Inventory

下一篇：List Bucket Inventory

纯净模式常规模式

纯净模式

点击可全屏预览文档内容