全部文档
当前文档

暂无内容

如果没有找到您期望的内容,请尝试其他搜索词

文档中心

List Bucket Inventory

最近更新时间:2024-06-25 19:26:39

List Bucket Inventory用于批量获取某个存储空间(Bucket)中的所有清单(Inventory)任务。使用此接口,需要是Bucket的拥有者或被授予ks3:ListBucketInventory权限的用户。

请求

请求语法

GET /?inventory HTTP/1.1
Host: {BucketName}.{endpoint}
Date: {date}
Authorization: {SignatureValue}
Content-Type: text/plain

注意:

请求参数

该请求不使用请求参数。

请求头部

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

请求内容

该接口不使用请求内容。

响应

响应头部

该接口将返回所有常用响应头部。获取更多信息,请点击公共响应头

响应内容

参数

描述

是否必选

ListInventoryConfigurationsResult

Bucket中所有清单任务信息的列表
类型:String

IsTruncated

是否列举全部的清单任务。

有效值:true或false

如果值为false,则表明存储空间中的所有清单任务已全部列出。

如果值为true,表示还未完整列出存储空间中的所有清单任务,您可以将NextContinuationToken字段的值作为下一次list请求的continuation-token参数,以获取下一页的清单配置列表。
父节点:ListInventoryConfigurationsResult

NextContinuationToken

当响应中的IsTruncated为true且NextContinuationToken非空时,使用该字段作为下一次list请求的continuation-token参数。
父节点:ListInventoryConfigurationsResult

InventoryConfiguration

存放单个清单任务参数的容器
类型:Container

Id

用户指定的清单名称,在单个Bucket下,清单名称唯一
类型:String

IsEnabled

清单是否启用
类型:Boolean
有效值:true/false

  • true:清单功能启用

  • false:清单功能关闭

Filter

指定扫描前缀信息
类型:Container

Prefix

指定清单扫描的前缀
类型:String
父节点:Filter

Destination

存放清单结果
类型:Container

KS3BucketDestination

清单结果导出后存放的Bucket信息
类型:Container
父节点:Destination

Format

导出清单文件的文件格式
类型:String
有效值:CSV、ORC、Parquet
父节点:KS3BucketDestination

Bucket

导出清单文件的Bucket
类型:String
父节点:KS3BucketDestination

Prefix

清单文件的存储路径
类型:String
父节点:KS3BucketDestination

Schedule

存放清单导出周期信息
类型:Container

Frequency

清单文件导出的周期
类型:String
有效值:Once、Daily、Weekly
父节点:Schedule

OptionalFields

设置清单结果中应包含的配置项
类型:Container

Field

清单结果中包含的配置项
类型:String
可选的配置项:Size、LastModifiedDate、ETag、StorageClass、IsMultipartUploaded、EncryptionStatus
父节点:OptionalFields

特殊错误

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

示例

请求示例

GET /?inventory HTTP/1.1
Host: BucketName.ks3-cn-beijing.ksyun.com
Date: Fri, 24 Feb 2012 03:55:00 GMT
Authorization: authorization string
Content-Type: text/plain

响应示例

HTTP/1.1 200 OK
x-kss-request-id: 56594298207FB3044385****
Date: Sat, 30 Apr 2016 23:29:37 GMT
Content-Type: application/xml
Content-Length: length
Connection: close
Server: ks3
  
<?xml version="1.0" encoding="UTF-8"?>
<ListInventoryConfigurationsResult>
  <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>
 <InventoryConfiguration">
  <Id>report1</Id>
  <IsEnabled>true</IsEnabled>
  <Destination>
     <KS3BucketDestination>
        <Format>CSV</Format>
        <AccountId>1000000000000000</AccountId>
        <Bucket>examplebucket</Bucket>
        <Prefix>prefix1</Prefix>
        <Encryption>
           <SSE-KS3/>
        </Encryption>
     </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>
  <IsTruncated>true</IsTruncated>
  <NextContinuationToken>...</NextContinuationToken>
</ListInventoryConfigurationsResult>

文档导读
纯净模式常规模式

纯净模式

点击可全屏预览文档内容
文档反馈