名称 | 类型 | IN | 必选 | 描述 |
---|---|---|---|---|
Authorization
|
string | header | 是 |
请求消息中可带的签名信息。 |
Date
|
string | header | 否 |
请求发起端的日期和时间,例如:Wed, 27 Jun 2018 13:39:15 +0000。 默认值:无。 条件:如果消息头中带了x-obs-date字段,则可以不带该字段,其他情况下必选。 |
bucket_name
|
string | query | 是 |
请求的桶名称。 |
inventory
|
string | query | 是 |
inventory表示请求桶清单API。 |
id
|
string | query | 是 |
清单配置的id,必须和消息体中的清单配置id一致。 有效字符:"a-z"、"A-Z"、"0-9"、"-"、"_"和"." |
名称 | 类型 | 必选 | 描述 |
---|---|---|---|
Id
|
string | 是 |
清单配置的id,必须和请求参数中的清单配置id一致。 有效字符:"a-z"、"A-Z"、"0-9"、"-"、"_"和"." |
IsEnabled
|
boolean | 是 |
规则是否启用,如果设置为true,则生成清单,反之不生成。 |
Filter
|
Filter object | 否 |
清单过滤器配置,清单只包含符合过滤器规则的对象(只支持按对象名前缀进行过滤),如果没有配置过滤器,则包含所有对象。 |
Destination
|
Destination object | 是 |
清单的目标配置。 |
Schedule
|
Schedule object | 是 |
清单文件的生成周期。 |
IncludedObjectVersions
|
string | 是 |
清单文件中包含对象的多版本配置。 如果设置为All,清单会包含对象所有的版本,清单中会增加版本相关的字段:VersionId、IsLatest、和DeleteMarker。 如果设置为Current,则清单文件中只会列出当前版本信息,不会出现版本相关字段。 |
OptionalFields
|
Array of strings | 否 |
在此选项中可以添加一些额外的对象元数据字段,生成的清单文件中会包含OptionalFields中配置的字段。 |
名称 | 类型 | 必选 | 描述 |
---|---|---|---|
Prefix
|
string | 否 |
前缀过滤条件,清单文件中只生成以此前缀开头的对象列表。 |
名称 | 类型 | 必选 | 描述 |
---|---|---|---|
Format
|
string | 是 |
生成的清单文件的格式,现只支持CSV格式。 |
Bucket
|
string | 是 |
存放清单文件的目标桶的桶名。 |
Prefix
|
string | 否 |
生成的清单文件对象名会以此前缀开头,如果不配置前缀,则生成的清单文件对象名默认以BucketInventory开头。 |
名称 | 类型 | 必选 | 描述 |
---|---|---|---|
Frequency
|
string | 是 |
清单文件的生成周期,只支持按天和按周生成清单,第一次配置完桶清单,任务会在一个小时内启动,之后每隔一个周期启动一次。 |
请求成功响应消息。
名称 | 类型 | 必选 | 描述 |
---|---|---|---|
Content-Length
|
string | 否 |
响应消息体的字节长度。 |
Connection
|
string | 否 |
指明与服务器的连接是长连接还是短连接。 |
Date
|
string | 否 |
OBS系统响应的时间。 |
ETag
|
string | 否 |
对象的base64编码的128位MD5摘要。ETag是对象内容的唯一标识,可以通过该值识别对象内容是否有变化。比如上传对象时ETag为A,下载对象时ETag为B,则说明对象内容发生了变化。实际的ETag是对象的哈希值。ETag只反映变化的内容,而不是其元数据。上传的对象或拷贝操作创建的对象,通过MD5加密后都有唯一的ETag。如果通过多段上传对象,则无论加密方法如何,MD5会拆分ETag,此类情况ETag就不是MD5的摘要。 |
x-obs-id-2
|
string | 否 |
帮助定位问题的特殊符号。 |
x-obs-request-id
|
string | 否 |
由OBS创建来唯一确定本次请求的值,可以通过该值来定位问题。 |
请求失败响应消息。 除了公共的错误码外,此接口还会返回一些其他的错误码。下面列出本接口的一些常见错误,以及可能原因。
错误码 | 描述 | HTTP状态码 |
---|---|---|
MalformedXML | 清单的XML配置格式错误。 | 400 Bad Request |
InvalidArgument | 无效参数。 | 400 Bad Request |
InventoryCountOverLimit | 配置清单数量超过最大限制。 | 400 Bad Request |
PrefixExistInclusionRelationship | 清单配置中的前缀存在包含关系。 | 400 Bad Request |