# 列举桶内多版本对象(C SDK) ![](https://support.huaweicloud.com/sdk-c-devg-obs/public_sys-resources/notice_3.0-zh-cn.png) 开发过程中，您有任何问题可以在GitHub上[提交issue](https://github.com/huaweicloud/huaweicloud-sdk-c-obs/issues)，或者在[华为云对象存储服务论坛](https://bbs.huaweicloud.com/forum/forum-620-1.html)中发帖求助。 #### 功能说明 用列举桶内多版本对象接口，可列举指定桶内的部分或所有多版本对象的描述信息。您还可以通过设置前缀、数量、起始位置等参数，返回符合您筛选条件的多版本对象信息。返回结果以多版本对象名的字典序排序。 #### 接口约束 - 您必须是桶拥有者或拥有列举桶内多版本对象的权限，才能列举桶内多版本对象。建议使用IAM或桶策略进行授权，如果使用IAM则需授予obs:bucket:ListBucketVersions权限，如果使用桶策略则需授予ListBucketVersions权限。相关授权方式介绍可参见[OBS权限控制概述](https://support.huaweicloud.com/perms-cfg-obs/obs_40_0001.html)，配置方式详见[使用IAM自定义策略](https://support.huaweicloud.com/usermanual-obs/obs_03_0121.html)、[自定义创建桶策略](https://support.huaweicloud.com/usermanual-obs/obs_03_0123.html)。 - OBS支持的Region与Endpoint的对应关系，详细信息请参见[地区与终端节点](https://console.huaweicloud.com/apiexplorer/#/endpoint/OBS)。 #### 方法定义 ``` void list_versions(const obs_options *options, const char *prefix, const char *key_marker, const char *delimiter, int maxkeys, const char *version_id_marker, obs_list_versions_handler *handler, void *callback_data); ``` #### 请求参数说明 表1请求参数列表 | **参数名称** | **参数类型** | **是否必选** | **描述** | |:---|:---|:---|:---| | options | const [obs_options]\* | 必选 | **参数解释：** 请求桶的上下文，[配置option(C SDK)](https://support.huaweicloud.com/sdk-c-devg-obs/obs_20_0203.html)，通过obs_options设置AK、SK、endpoint、bucket、超时时间、临时鉴权。 **约束限制：** 无 | | prefix | char \* | 可选 | **参数解释：** 限定返回的对象名必须带有prefix前缀。 **约束限制：** 无 **取值范围：** 无 **默认取值：** 无 | | key_marker | char \* | 可选 | **参数解释：** 列举多版本对象的起始位置，返回的对象列表将是对象名按照字典序排序后该参数以后的所有对象。 **约束限制：** 无 **取值范围：** 无 **默认取值：** 无 | | delimiter | char \* | 可选 | **参数解释：** 用于对对象名进行分组的字符。对于对象名中包含delimiter的对象，其对象名（如果请求中指定了prefix，则此处的对象名需要去掉prefix）中从首字符至第一个delimiter之间的字符串将作为一个分组并作为common_prefixes返回。 **约束限制：** 无 **取值范围：** 无 **默认取值：** 无 | | version_id_marker | char \* | 可选 | **参数解释：** 与key_marker配合使用，返回的对象列表将是对象名和版本号按照字典序排序后该参数以后的所有对象。 **约束限制：** 无 **取值范围：** 无 **默认取值：** 无 | | maxkeys | int | 必选 | **参数解释：** 列举对象的最大数目。 **约束限制：** 当该参数超出1000时，按照默认的1000进行处理。 **取值范围：** \[1，1000\]，单位：个。 **默认取值：** 1000 | | handler | [obs_list_versions_handler] \* | 必选 | **参数解释：** 回调结构体，结构体内所有成员都是回调函数的指针，用于设置处理接口响应数据的回调函数。您可以通过设置回调函数，把服务端的响应数据复制到您的自定义回调数据callback_data中。 **约束限制：** 无 | | callback_data | void \* | 可选 | **参数解释：** 用户自定义回调数据。 **约束限制：** 无 **取值范围：** 无 **默认取值：** 无 | 表2obs_options | **参数名称** | **参数类型** | **是否必选** | **描述** | |:---|:---|:---|:---| | bucket_options | [obs_bucket_context] | 必选 | **参数解释：** 桶相关设置。 **约束限制：** 无 | | request_options | [obs_http_request_option] | 必选 | **参数解释：** 请求相关设置。 **约束限制：** 无 | | temp_auth | [temp_auth_configure]\* | 可选 | **参数解释：** 用于临时计算签名的结构体，不使用时请设置为NULL。 **约束限制：** 无 | 表3obs_bucket_context | **参数名称** | **参数类型** | **是否必选** | **描述** | |:---|:---|:---|:---| | host_name | char \* | 必选 | **参数解释** **：** 连接OBS的服务地址，请求使用的主机名，是指存放资源的服务器的域名，就是终端节点endpoint。 示例：host_name = "obs.cn-north-4.myhuaweicloud.com"; **约束限制：** 不需要带"http://"或"https://"前缀，通过[obs_protocol]控制是使用http协议还是https协议。 **取值范围：** 您可以从[这里](https://developer.huaweicloud.com/endpoint?OBS)查看OBS当前开通的服务地址。 **默认取值：** 无 | | bucket_name | char \* | 必选 | **参数解释** **：** 桶名。 **约束限制：** - 桶的名字需全局唯一，不能与已有的任何桶名称重复，包括其他用户创建的桶。 - 桶命名规则如下： - 3～63个字符，数字或字母开头，支持小写字母、数字、"-"、"."。 - 禁止使用IP地址。 - 禁止以"-"或"."开头及结尾。 - 禁止两个"."相邻（如："my..bucket"）。 - 禁止"."和"-"相邻（如："my-.bucket"和"my.-bucket"）。 - 同一用户在同一个区域多次创建同名桶不会报错，创建的桶属性以第一次请求为准。 **取值范围：** 无 **默认取值：** 无 | | useCname | bool | 可选 | **参数解释** **：** 是否通过自定义域名访问OBS服务。 **约束限制：** 无 **取值范围：** true：通过自定义域名访问OBS服务。 false：不通过自定义域名访问OBS服务。 **默认取值：** false | | protocol | [obs_protocol] | 可选 | **参数解释** **：** 是使用http协议还是https协议。 **约束限制：** 无 **取值范围：** 可详见[obs_protocol]。 **默认取值：** OBS_PROTOCOL_HTTPS（默认使用https协议） | | access_key | char \* | 必选 | **参数解释** **：** 访问密钥中的AK。 **约束限制：** 无 **取值范围：** 可详见[创建访问密钥](https://support.huaweicloud.com/sdk-c-devg-obs/obs_20_0102.html#obs_20_0102__l9411f8847bda4bb18a00b996423f8ee7)。 **默认取值：** 无 | | secret_access_key | char \* | 必选 | **参数解释** **：** 访问密钥中的SK。 **约束限制：** 无 **取值范围：** 可详见[创建访问密钥](https://support.huaweicloud.com/sdk-c-devg-obs/obs_20_0102.html#obs_20_0102__l9411f8847bda4bb18a00b996423f8ee7)。 **默认取值：** 无 | | storage_class | [obs_storage_class] | 可选 | **参数解释** **：** 创建桶时可指定的桶的存储类别。 **约束限制：** 无 **取值范围：** 可详见[obs_storage_class]。 **默认取值：** OBS_STORAGE_CLASS_STANDARD（指标准存储类别） | | token | char \* | 可选 | **参数解释** **：** 临时访问密钥中的SecurityToken。 **约束限制：** 无 **取值范围：** 可详见[创建访问密钥](https://support.huaweicloud.com/sdk-c-devg-obs/obs_20_0102.html#obs_20_0102__l9411f8847bda4bb18a00b996423f8ee7)。 **默认取值：** 无 | | epid | char \* | 可选 | **参数解释** **：** 创建桶时可指定的企业项目ID，开通企业项目的用户可以从企业项目服务获取。 **约束限制：** epid格式为uuid，未开通企业项目的用户可以不带该头域。 示例：9892d768-2d13-450f-aac7-ed0e44c2585f **默认取值：** 无 | | bucket_type | [obs_bucket_type] | 可选 | **参数解释** **：** 创建桶时，指定是对象桶还是并行文件系统。 **约束限制：** 无 **取值范围：** 可详见[obs_bucket_type]。 **默认取值：** OBS_BUCKET_OBJECT（指对象桶） | | bucket_list_type | [obs_bucket_list_type] | 可选 | **参数解释** **：** 列举桶时，确定列举桶的类型：所有桶、对象桶、并行文件系统。 **约束限制：** 无 **取值范围：** 可详见[obs_bucket_list_type]。 | 表4obs_storage_class | 常量名 | 原始值 | 说明 | |:---|:---|:---| | OBS_STORAGE_CLASS_STANDARD | STANDARD | 标准存储。 标准存储拥有低访问时延和较高的吞吐量，适用于有大量热点对象（平均一个月多次）或小对象（\<1MB），且需要频繁访问数据的业务场景。 | | OBS_STORAGE_CLASS_STANDARD_IA | STANDARD_IA | 低频访问存储。 低频访问存储适用于不频繁访问（平均一年少于12次）但在需要时也要求能够快速访问数据的业务场景。 | | OBS_STORAGE_CLASS_GLACIER | GLACIER | 归档存储。 归档存储适用于很少访问（平均一年访问一次）数据的业务场景。 | | OBS_STORAGE_CLASS_DEEP_ARCHIVE | DEEP_ARCHIVE | 深度归档存储 适用于长期不访问（平均几年访问一次）数据的业务场景。 | 表5obs_http_request_option | **参数名称** | **参数类型** | **是否必选** | **描述** | |:---|:---|:---|:---| | connect_time | int | 必选 | **参数解释** **：** 建立HTTP/HTTPS连接的超时时间（单位：毫秒）。 **约束限制：** 无 **取值范围：** \[10000, 60000\] **默认取值：** 60000 | | max_connected_time | int | 必选 | **参数解释** **：** 请求超时时间（单位：秒）。 **约束限制：** 无 **取值范围：** 无 **默认取值：** 0（指永远不会主动断开连接） | | proxy_auth | char\* | 可选 | **参数解释** **：** 代理认证信息，格式为username:password。 **约束限制：** 无 **取值范围：** 无 **默认取值：** 无 | | proxy_host | char\* | 可选 | **参数解释** **：** 代理服务器的IP地址或主机名。 **约束限制：** 无 **取值范围：** 无 **默认取值：** 无 | 表6obs_protocol | **常量名** | **原始值** | **说明** | |:---|:---|:---| | OBS_PROTOCOL_HTTPS | https | 使用https协议访问。 | | OBS_PROTOCOL_HTTP | http | 使用http协议访问。 | 表7obs_bucket_type | **常量名** | **原始值** | **说明** | |:---|:---|:---| | OBS_BUCKET_OBJECT | OBJECT | 对象桶。 | | OBS_BUCKET_PFS | POSIX | 并行文件系统。 | 表8obs_bucket_list_type | **常量名** | **原始值** | **说明** | |:---|:---|:---| | OBS_BUCKET_LIST_ALL | 不发送头域 | 列举所有桶。 | | OBS_BUCKET_LIST_OBJECT | OBJECT | 列举所有对象桶。 | | OBS_BUCKET_LIST_PFS | POSIX | 列举所有并行文件系统。 | 表9temp_auth_configure | **参数名称** | **参数类型** | **是否必选** | **描述** | |:---|:---|:---|:---| | expires | long long int | 必选 | **参数解释：** 临时鉴权的有效期（单位：秒）。 **约束限制：** 无 **取值范围：** \[0-630720000\] **默认取值**： 无 | | temp_auth_callback | void (\*[temp_auth_callback])(char \*temp_auth_url, uint64_t temp_auth_url_len, char\*temp_auth_headers, uint64_t temp_auth_headers_len, void\*callback_data) | 必选 | **参数解释：** 用户自定义回调函数指针，用于将临时url以及涉及的计算签名头域记录到用户自定义回调数据中。 **约束限制：** 无 | | callback_data | void \* | 必选 | **参数解释：** 用户自定义回调数据。 **约束限制：** 无 **取值范围：** 无 **默认取值**： 无 | 表10temp_auth_callback | **参数名称** | **参数类型** | **是否必选** | **描述** | |:---|:---|:---|:---| | temp_auth_url | char \* | 必选 | **参数解释：** 临时鉴权的URL。OBS服务支持用户构造一个特定操作的URL，这个URL的Query参数中会包含用户AK、签名、有效期等信息，任何拿到这个URL的人均可执行临时鉴权操作，OBS服务收到这个请求后认为该请求就是签发URL用户自己在执行操作。例如构造一个携带签名信息的下载对象的URL，拿到相应URL的人都能下载这个对象，但该URL只在Expires指定的失效时间内有效。 **约束限制：** 无 **取值范围：** 无 **默认取值**： 无 | | temp_auth_url_len | uint64_t | 必选 | **参数解释：** 临时鉴权的URL的长度。 **约束限制：** 无 **取值范围：** 无 **默认取值**： 无 | | temp_auth_headers | char \* | 必选 | **参数解释：** 临时鉴权的headers。 **约束限制：** 无 **取值范围：** 无 **默认取值**： 无 | | temp_auth_headers_len | uint64_t | 必选 | **参数解释：** 临时鉴权headers的缓冲区长度（字节数）。 **约束限制：** 无 **取值范围：** 无 **默认取值**： 无 | | callback_data | void \* | 必选 | **参数解释：** 用户自定义回调数据。 **约束限制：** 无 **取值范围：** 无 **默认取值**： 无 | 表11obs_list_versions_handler | **参数名称** | **参数类型** | **是否必选** | **描述** | |:---|:---|:---|:---| | response_handler | [obs_response_handler] \* | 必选 | **参数解释：** 响应回调函数结构体。 **约束限制：** 无 | | list_versions_callback | [obs_list_versions_callback] \* | 必选 | **参数解释：** 标签回调函数指针，可以在这个回调中把列举结果的具体内容记录到callback_data（用户自定义回调数据）中。 **约束限制：** 无 | 表12obs_response_handler | **参数名称** | **参数类型** | **是否必选** | **描述** | |:---|:---|:---|:---| | properties_callback | [obs_response_properties_callback] \* | 必选 | **参数解释：** 响应回调函数指针，可以在这个回调中把[obs_response_properties](https://support.huaweicloud.com/sdk-c-devg-obs/obs_20_0308.html#obs_20_0308__table13287123911192)的内容记录到callback_data（用户自定义回调数据）中。 **约束限制：** 无 | | complete_callback | [obs_response_complete_callback] \* | 必选 | **参数解释：** 结束回调函数指针，可以在这个回调中把[obs_status]和[obs_error_details]的内容记录到callback_data（用户自定义回调数据）中。 **约束限制：** 无 | 表13obs_response_properties_callback | **参数名称** | **参数类型** | **是否必选** | **描述** | |:---|:---|:---|:---| | properties | const [obs_response_properties]\* | 必选 | **参数解释：** 响应头域中的参数，建议将其内容记录到callback_data（用户自定义回调数据）中。 **约束限制：** 无 | | callback_data | void \* | 必选 | **参数解释：** 用户自定义回调数据指针。 **约束限制：** 无 **取值范围：** 无 **默认取值**： 无 | 表14obs_response_complete_callback | **参数名称** | **参数类型** | **是否必选** | **描述** | |:---|:---|:---|:---| | status | [obs_status] | 必选 | **参数解释：** SDK内部的请求状态码。 **约束限制：** 无 **取值范围：** 可详见[obs_status]。 | | error_details | const [obs_error_details]\* | 必选 | **参数解释：** 请求失败的错误详情，包含错误消息、资源信息等，建议将其内容记录到callback_data（用户自定义回调数据）中。 **约束限制：** 无 | | callback_data | void \* | 必选 | **参数解释：** 用户自定义回调数据指针 **约束限制：** 无 **取值范围：** 无 **默认取值**： 无 | 表15obs_response_properties | **参数名称** | **参数类型** | **是否必选** | **描述** | |:---|:---|:---|:---| | request_id | const char \* | 可选 | **参数解释：** 由OBS创建来唯一确定本次请求的值，可以通过该值来定位问题。 **约束限制：** 无 **取值范围：** 无 **默认取值**： 无 | | request_id2 | const char \* | 可选 | **参数解释：** 帮助定位问题的特殊符号。 **约束限制：** 无 **取值范围：** 无 **默认取值**： 无 | | content_type | const char \* | 可选 | **参数解释：** 对象的文件类型（MIME类型）。Content-Type（MIME）用于标识发送或接收数据的类型，浏览器根据该参数来决定数据的打开方式。 **约束限制：** 无 **取值范围：** 无 **默认取值**： 无 | | content_length | uint64_t | 可选 | **参数解释：** 响应消息体的字节长度。 **约束限制：** 无 **取值范围：** 无 **默认取值**： 无 | | server | const char \* | 可选 | **参数解释：** HTTP请求中的Server头域。 **约束限制：** 无 **取值范围：** 无 **默认取值**： 无 | | etag | const char \* | 可选 | **参数解释：** 对象的base64编码的128位MD5摘要。ETag是对象内容的唯一标识，可以通过该值识别对象内容是否有变化。比如上传对象时ETag为A，下载对象时ETag为B，则说明对象内容发生了变化。ETag只反映变化的内容，而不是其元数据。上传的对象或复制操作创建的对象，都有唯一的ETag。 **约束限制：** 当对象是服务端加密的对象时，ETag值不是对象的MD5值。 **取值范围：** 长度为32的字符串。 **默认取值：** 无 | | expiration | const char \* | 可选 | **参数解释：** 对象的详细过期信息。 **约束限制：** 无 **取值范围：** ISO 8601 格式的时间字符串，如"Web, 7 Nov 2012 00:00:00 GMT"。 **默认取值：** 无 | | website_redirect_location | const char \* | 可选 | **参数解释：** 当桶设置了Website配置，就可以设置对象元数据的这个属性，Website接入点返回301重定向响应，将获取这个对象的请求重定向到该属性指定的桶内另一个对象或一个外部的URL，该参数指明对象的重定向地址。 例如，重定向请求到桶内另一对象： x-obs-website-redirect-location:/anotherPage.html 或重定向请求到一个外部URL： x-obs-website-redirect-location:http://www.example.com/ OBS将这个值从头域中取出，保存在对象的元数据"WebsiteRedirectLocation"中。 **约束限制：** - 必须以"/"、"http://"或"https://"开头，长度不超过2KB。 - OBS仅支持为桶根目录下的对象设置重定向，不支持为桶中文件夹下的对象设置重定向。 **取值范围：** 无 **默认取值：** 无 | | version_id | const char \* | 可选 | **参数解释：** 对象的版本号。 **约束限制：** 如果该对象无版本号，则为NULL。 **取值范围：** 长度为32的字符串。 **默认取值**： 无 | | meta_data_count | int | 可选 | **参数解释：** meta_data数组中的元素个数。 **约束限制：** 无 **取值范围：** 无 **默认取值：** 无 | | meta_data | const [obs_name_value] \* | 可选 | **参数解释：** 对象的自定义元数据。OBS支持用户使用以"x-obs-meta-"开头的消息头来加入自定义的元数据，以便对对象进行自定义管理。当用户获取此对象或查询此对象元数据时，加入的自定义元数据将会在返回的消息头中出现。 **约束限制：** 无 **取值范围：** 无 **默认取值：** 无 | | use_server_side_encryption | char | 可选 | **参数解释：** 如果开启了服务端加密，会被置为'\\1'。 **约束限制：** 无 **取值范围：** 无 **默认取值：** 无 | | allow_origin | const char \* | 可选 | **参数解释：** 当桶设置了CORS配置，如果请求中的Origin满足服务端的CORS配置，则在响应中包含这个Origin。 **约束限制：** 无 **取值范围：** 符合CORS协议的取值范围。 **默认取值：** 无 | | allow_headers | const char \* | 可选 | **参数解释：** 当桶设置了CORS配置，如果请求的headers满足服务端的CORS配置，则在响应中包含这个headers。 **约束限制：** 最多可填写一个"\*"通配符，不支持\&、:、\<、空格以及中文字符。 **取值范围：** 符合CORS协议的取值范围。 **默认取值：** 无 | | max_age | const char \* | 可选 | **参数解释：** 桶CORS规则中的MaxAgeSeconds。MaxAgeSeconds指请求来源的客户端可以对跨域请求返回结果的缓存时间。 **约束限制：** 每个CORSRule可以包含至多一个MaxAgeSeconds。 **取值范围：** 大于等于0的整型数，单位：秒。 **默认取值：** 3000 | | allow_methods | const char \* | 可选 | **参数解释：** 当桶设置了CORS配置，如果请求的Access-Control-Request-Method满足服务端的CORS配置，则在响应中包含这条rule中的Methods。 **约束限制：** 无 **取值范围：** - GET - PUT - HEAD - POST - DELETE **默认取值：** 无 | | expose_headers | const char \* | 可选 | **参数解释：** 桶CORS规则中的ExposeHeader。ExposeHeader是指CORS规则允许响应中可返回的附加头域，给客户端提供额外的信息。默认情况下浏览器只能访问以下头域：Content-Length、Content-Type，如果需要访问其他头域，需要在附加头域中配置。 **约束限制：** 不支持\*、\&、:、\<、空格以及中文字符。 **取值范围：** 无 **默认取值：** 无 | | storage_class | const char \* | 可选 | **参数解释：** 对象的存储类别。 **约束限制：** 仅当对象为非标准存储类别时，会返回此头域。 **取值范围：** - WARM（指低频存储） - COLD（指归档存储） - DEEP_ARCHIVE（指深度归档存储） **默认取值：** 无 | | server_side_encryption | const char \* | 可选 | **参数解释：** 该头域表示服务端的加密方式。 示例：x-obs-server-side-encryption：kms **约束限制：** 如果服务端加密是SSE-KMS方式，响应包含该头域。 **取值范围：** - kms（指SSE-KMS加密方式） - obs（指SSE-OBS加密方式） **默认取值：** 无 | | kms_key_id | const char \* | 可选 | **参数解释：** 密钥ID。当加密方式为SSE-KMS且使用指定密钥加密时，需输入密钥ID。 **约束限制：** 当您设置了server_side_encryption且赋值为"kms"，即选择kms加密方式时，才能使用该头域指定加密密钥。 **取值范围：** 无 **默认取值：** 当您选择使用kms加密方式，但未设置此头域时，默认的主密钥将会被使用。如果默认主密钥不存在，系统将默认创建并使用。 | | customer_algorithm | const char \* | 可选 | **参数解释：** 如果服务端加密是SSE-C方式，响应包含该头域，该头域表示解密使用的算法。 **约束限制：** 无 **取值范围：** AES256（指AES256解密算法） **默认取值：** 无 | | customer_key_md5 | const char \* | 可选 | **参数解释：** 如果服务端加密是SSE-C方式，响应包含该头域，该头域表示解密使用的密钥的MD5值。 **约束限制：** 由密钥值经过MD5加密再经过Base64编码后得到，示例：4XvB3tbNTN+tIEVa0/fGaQ==。 **取值范围：** 密钥ID MD5的base64值。 **默认取值：** 无 | | bucket_location | const char \* | 可选 | **参数解释：** 桶的区域位置信息。 **约束限制：** 无 **取值范围：** 无 **默认取值：** 无 | | obs_version | const char \* | 可选 | **参数解释：** 桶所在的OBS服务版本号。 **约束限制：** 无 **取值范围：** - 3.0：最新版本的桶。 - --：表示老版本的桶。 **默认取值：** 无 | | restore | const char \* | 可选 | **参数解释：** 标识对象的恢复状态。 示例：正在恢复ongoing-request="true"；已恢复 ongoing-request="false", expiry-date="Wed, 7 Nov 2012 00:00:00 GMT"。其中expiry-date表示对象恢复后的失效时间。 **约束限制：** 仅当对象为归档存储或深度归档存储类别，并且处于正在恢复或已经恢复时，会返回此头域。 **取值范围：** 无 **默认取值：** 无 | | obs_object_type | const char \* | 可选 | **参数解释：** 对象的类型。 **约束限制：** 仅当对象为非Normal对象时，会返回此头域。 **取值范围：** Appendable **默认取值：** 无 | | obs_next_append_position | const char \* | 可选 | **参数解释：** 指明下一次请求应该提供的position。 **约束限制：** 仅当对象为Appendable对象时，会返回此头域。 **取值范围：** 无 **默认取值：** 无 | | obs_head_epid | const char \* | 可选 | **参数解释：** 当前桶的企业项目ID，开通企业项目的用户可以从企业项目服务获取。 **约束限制：** 格式为uuid，未开通企业项目的用户可以不带该头域。 **取值范围：** 无 **默认取值：** 无 | | reserved_indicator | const char \* | 可选 | **参数解释：** 帮助定位问题的特殊符号。 **约束限制：** 无 **取值范围：** 无 **默认取值：** 无 | 表16obs_error_details | **参数名称** | **参数类型** | **描述** | |:---|:---|:---| | message | const char\* | **参数解释：** 错误响应消息体XML中具体错误更全面、详细的英文解释。 **约束限制：** 无 **取值范围：** 取值范围可参见[错误码](https://support.huaweicloud.com/api-obs/obs_04_0115.html)。 **默认取值：** 无 | | resource | const char\* | **参数解释：** 该错误相关的桶或对象资源。 **约束限制：** 无 **取值范围：** 无 **默认取值：** 无 | | further_details | const char\* | **参数解释：** 错误响应消息体XML中的FurtherDetails元素的值。 **约束限制：** 无 **取值范围：** 无 **默认取值：** 无 | | extra_details_count | int | **参数解释：** 错误响应消息体XML中的其他元素的数量。 **约束限制：** 无 **取值范围：** 无 **默认取值：** 无 | | extra_details | [obs_name_value]\* | **参数解释：** 错误响应消息体XML中的其他元素的值。 **约束限制：** 无 | | error_headers_count | int | **参数解释：** error_headers的头域数量。 **约束限制：** 无 **取值范围：** 无 **默认取值：** 无 | | error_headers | char\*\* | **参数解释：** 响应头域中包含error的所有头域。 **约束限制：** 无 **取值范围：** 无 **默认取值：** 无 | 表17obs_name_value | **参数名称** | **参数类型** | **是否必选** | **描述** | |:---|:---|:---|:---| | name | char \* | 可选 | **参数解释：** 属性的键。 **约束限制：** 无 **取值范围：** 无 **默认取值：** 无 | | value | char \* | 可选 | **参数解释：** 属性的值。 **约束限制：** 无 **取值范围：** 无 **默认取值：** 无 | 表18obs_status | **常量名** | **原始值** | **说明** | |:---|:---|:---| | OBS_STATUS_OK | 0 | 请求成功。 | | OBS_STATUS_InitCurlFailed | 1 | 初始化curl失败。 | | OBS_STATUS_InternalError | 2 | 内部错误。 | | OBS_STATUS_OutOfMemory | 3 | 本地环境内存不足。 | | OBS_STATUS_FailedToIInitializeRequest | 6 | 初始化请求失败。 | | OBS_STATUS_XmlParseFailure | 23 | xml解析失败。 | | OBS_STATUS_NameLookupError | 33 | 域名解析失败。 | | OBS_STATUS_FailedToConnect | 34 | 无法连接到服务端。 | | OBS_STATUS_ConnectionFailed | 36 | 网络连接失败。 | | OBS_STATUS_PartialFile | 38 | 网络传输中断。 | | OBS_STATUS_InvalidParameter | 39 | 参数非法。 | | OBS_STATUS_NoToken | 40 | 当前并发数已经超过最大并发数（默认值1000）。此处的Token指并发请求令牌，非安全认证令牌。可通过set_online_request_max_count函数调整最大并发数。 | | OBS_STATUS_OpenFileFailed | 41 | 打开文件失败。 | | OBS_STATUS_AccessDenied | 43 | 请求被拒绝。 | | OBS_STATUS_MalformedPolicy | 44 | 请求policy格式不正确。 | | OBS_STATUS_MalformedXML | 45 | 请求xml格式不正确。 | | OBS_STATUS_MethodNotAllowed | 46 | 请求方法不允许。 | | OBS_STATUS_SignatureDoesNotMatch | 47 | 签名不匹配，检查ak、sk、token是否对应或有误。 | | OBS_STATUS_ServiceUnavailable | 48 | 服务端异常。 | | OBS_STATUS_SlowDown | 49 | 请求频率过快。 | 表19obs_list_versions_callback | **参数名称** | **参数类型** | **是否必选** | **描述** | |:---|:---|:---|:---| | is_truncated | int | 必选 | **参数解释：** 返回的结果列表是否截断。 **约束限制：** 无 **取值范围：** 无 **默认取值：** 无 | | next_key_marker | const char \* | 必选 | **参数解释：** 下次列举多版本对象请求的起始位置。如果本次没有返回全部结果，响应请求中将包含该元素，用于标明接下来请求的key_marker值。 **约束限制：** 该字段仅用于多版本列举。 **取值范围：** 长度大于0且不超过1024的字符串。 **默认取值：** 无 | | next_versionid_marker | const char \* | 必选 | **参数解释**： 下次列举多版本对象请求的起始位置，与next_key_marker配合使用。如果本次没有返回全部结果，响应请求中将包含该元素，用于标明接下来请求的version_id_marker值。 **约束限制：** 该字段只适用于多版本列举场景。 **取值范围：** 长度为32的字符串。 **默认取值：** 无 | | versions | const [obs_list_versions]\* | 必选 | **参数解释：** 列举出的多版本相关信息。 **约束限制：** 无 | | callback_data | void \* | 必选 | **参数解释：** 用户自定义回调数据指针。 **约束限制：** 无 **取值范围：** 无 **默认取值：** 无 | 表20obs_list_versions | **参数名称** | **参数类型** | **是否必选** | **描述** | |:---|:---|:---|:---| | bucket_name | const char \* | 可选 | **参数解释** **：** 桶名。 **约束限制：** - 桶的名字需全局唯一，不能与已有的任何桶名称重复，包括其他用户创建的桶。 - 桶命名规则如下： - 3～63个字符，数字或字母开头，支持小写字母、数字、"-"、"."。 - 禁止使用IP地址。 - 禁止以"-"或"."开头及结尾。 - 禁止两个"."相邻（如："my..bucket"）。 - 禁止"."和"-"相邻（如："my-.bucket"和"my.-bucket"）。 - 同一用户在同一个区域多次创建同名桶不会报错，创建的桶属性以第一次请求为准。 **取值范围：** 无 **默认取值：** 无 | | prefix | const char \* | 可选 | **参数解释：** 限定返回的对象名必须带有prefix前缀。 **约束限制：** 无 **取值范围：** 长度大于0且不超过1024的字符串。 **默认取值：** 无 | | key_marker | const char \* | 可选 | **参数解释：** 列举多版本对象的起始位置，返回的对象列表将是对象名按照字典序排序后该参数以后的所有对象。 **约束限制：** 该字段仅用于多版本列举。 **取值范围：** 上次请求返回体的nextKeyMarker值。 **默认取值：** 无 | | delimiter | const char \* | 可选 | **参数解释：** 将对象名进行分组的分隔符。如果指定了prefix，从prefix到第一次出现delimiter间具有相同字符串的对象名会被分成一组，形成一条CommonPrefixes；如果没有指定prefix，从对象名的首字符到第一次出现delimiter间具有相同字符串的对象名会被分成一组，形成一条CommonPrefixes。 例如，桶中有3个对象，分别为abcd、abcde、bbcde。如果指定delimiter为d，prefix为a，abcd、abcde会被分成一组，形成一条前缀为abcd的commonPrefix；如果只指定delimiter为d，abcd、abcde会被分成一组，形成一条前缀为abcd的commonPrefix，而bbcde会被单独分成一组，形成一条前缀为bbcd的commonPrefix。 对于并行文件系统，不携带此参数时默认列举是递归列举此目录下所有内容，会列举子目录。在大数据场景下（目录层级深、目录下文件多）的列举，建议设置\[delimiter=/\]，只列举当前目录下的内容，不列举子目录，提高列举效率。 **约束限制：** 无 **取值范围：** 长度大于0且不超过1024的字符串。 **默认取值：** 无 | | max_keys | const char \* | 可选 | **参数解释：** 列举多版本对象的最大数目，返回的对象列表将是按照字典顺序的最多前maxKeys个对象。 **约束限制：** 当该参数超出1000时，按照默认的1000进行处理。 **取值范围：** \[1，1000\]，单位：个。 **默认取值：** 1000 | | versions | [obs_version] \* | 可选 | **参数解释：** 对象信息 **约束限制：** 无 | | versions_count | int | 可选 | **参数解释：** versions的数量。 **约束限制：** 无 **取值范围：** 无 **默认取值：** 无 | | common_prefixes | const char \*\* | 可选 | **参数解释：** 当请求中设置了delimiter分组字符时，返回按delimiter分组后的对象名称前缀列表。 **约束限制：** 无 **取值范围：** 无 **默认取值：** 无 | | common_prefixes_count | int | 可选 | **参数解释：** common_prefixes的数量。 **约束限制：** 无 **取值范围：** 无 **默认取值：** 无 | 表21obs_version | **参数名称** | **参数类型** | **是否必选** | **描述** | |:---|:---|:---|:---| | key | const char \* | 可选 | **参数解释：** 对象名。对象名是对象在存储桶中的唯一标识。对象名是对象在桶中的完整路径，路径中不包含桶名。 例如，您对象的访问地址为examplebucket.obs.cn-north-4.myhuaweicloud.com/folder/test.txt 中，对象名为folder/test.txt。 **取值范围：** 长度大于0且不超过1024的字符串。 **默认取值：** 无 | | version_id | const char \* | 可选 | **参数解释：** 对象的版本号。 **约束限制：** 无 **取值范围：** 无 **默认取值：** 无 | | is_latest | const char \* | 可选 | **参数解释：** 标识对象是否是最新的版本。 **约束限制：** 无 **取值范围：** 无 **默认取值：** 无 | | last_modified | int64_t | 可选 | **参数解释：** 对象最近一次被修改的时间（UTC时间）。 **约束限制：** 无 **取值范围：** 长度大于0且不超过1024的字符串。 **默认取值：** 无 | | etag | const char \* | 可选 | **参数解释**： 对象的base64编码的128位MD5摘要。ETag是对象内容的唯一标识，可以通过该值识别对象内容是否有变化。比如上传对象时ETag为A，下载对象时ETag为B，则说明对象内容发生了变化。实际的ETag是对象的哈希值。ETag只反映变化的内容，而不是其元数据。上传的对象或复制操作创建的对象，通过MD5加密后都有唯一的ETag。 **约束限制：** 无 **取值范围：** 长度为32的字符串。 **默认取值：** 无 | | size | uint64_t | 可选 | **参数解释：** 对象的字节数。 **约束限制：** 无 **取值范围：** 无 **默认取值：** 无 | | owner_id | const char \* | 可选 | **参数解释：** 对象拥有者的domain_id（账号ID）。 **约束限制：** 无 **取值范围：** 如何获取桶所有者的账号ID请参见[如何获取账号ID和用户ID？](https://support.huaweicloud.com/sdk-c-devg-obs/obs_23_1712.html) **默认取值：** 无 | | storage_class | const char \* | 可选 | **参数解释：** 对象的存储类别。 **约束限制：** 无 **取值范围：** 无 **默认取值：** 无 | | is_delete | const char \* | 可选 | **参数解释：** 是否是删除标记。 **约束限制：** 无 **取值范围：** 无 **默认取值：** 无 | #### 代码示例：列举多版本对象 以下示例展示如何通过函数list_versions列举出桶里的多版本对象： ``` #include "eSDKOBS.h" #include #include #include // 响应回调函数，可以在这个回调中把properties的内容记录到callback_data(用户自定义回调数据)中 obs_status response_properties_callback(const obs_response_properties *properties, void *callback_data); typedef struct list_versions_callback_data { char bucket_name[1024]; char prefix[1024]; char key_marker[1024]; char delimiter[1024]; int max_keys; int is_truncated; char next_key_marker[1024]; char next_versionId_marker[1024]; int keyCount; int allDetails; obs_status ret_status; } list_versions_callback_data; static void list_versions_complete_callback(obs_status status, const obs_error_details *error, void *callback_data); static obs_status listVersionsCallback(int is_truncated, const char *next_key_marker, const char *next_versionId_marker, const obs_list_versions *list_versions, void *callback_data); int main() { // 以下示例展示如何通过函数list_versions列举出桶里的多版本对象。 // 在程序入口调用obs_initialize方法来初始化网络、内存等全局资源。 obs_status ret_status = obs_initialize(OBS_INIT_ALL); if (OBS_STATUS_OK != ret_status) { printf("obs_initialize failed(%s).\n", obs_get_status_name(ret_status)); return -1; } obs_options options; // 创建并初始化options，该参数包括访问域名(host_name)、访问密钥（access_key_id和access_key_secret）、桶名(bucket_name)、桶存储类别(storage_class)等配置信息 init_obs_options(&options); // host_name填写桶所在的endpoint, 此处以华北-北京四为例，其他地区请按实际情况填写。 options.bucket_options.host_name = "obs.cn-north-4.myhuaweicloud.com"; // 认证用的ak和sk硬编码到代码中或者明文存储都有很大的安全风险，建议在配置文件或者环境变量中密文存放，使用时解密，确保安全； // 本示例以ak和sk保存在环境变量中为例，运行本示例前请先在本地环境中设置环境变量ACCESS_KEY_ID和SECRET_ACCESS_KEY。 options.bucket_options.access_key = getenv("ACCESS_KEY_ID"); options.bucket_options.secret_access_key = getenv("SECRET_ACCESS_KEY"); // 填写Bucket名称，例如example-bucket-name。 char * bucket_name = "example-bucket-name"; options.bucket_options.bucket_name = bucket_name; char * prefix = "example"; char * key_marker = ""; char * delimiter = "/"; int maxkeys = 1000; // 设置响应回调函数 obs_list_versions_handler list_versions_handler = { { &response_properties_callback, &list_versions_complete_callback }, &listVersionsCallback }; // 创建并初始化回调数据 list_versions_callback_data data; char* version_id_marker = NULL; memset(&data, 0, sizeof(list_versions_callback_data)); data.ret_status = OBS_STATUS_BUTT; snprintf(data.next_key_marker, sizeof(data.next_key_marker), "%s", key_marker); if (version_id_marker) { snprintf(data.next_versionId_marker, sizeof(data.next_versionId_marker), "%s", version_id_marker); } data.keyCount = 0; data.allDetails = 1; data.is_truncated = 0; // 列举多版本对象，通过prefix指定对象前缀，maxkeys指定数目列举，可实现分页列举， // delimiter指定分组列举的字符，按文件夹分组，则delimiter设置为“/”, // 通过key_marker指定多版本起始位置，version_id_marker指定多版本起始版本号 list_versions(&options, prefix, key_marker, delimiter, maxkeys, version_id_marker, &list_versions_handler, &data); if (OBS_STATUS_OK == data.ret_status) { printf("list versions successfully. \n"); } else { printf("list versions failed(%s).\n", obs_get_status_name(data.ret_status)); } // 释放分配的全局资源 obs_deinitialize(); } // 响应回调函数，可以在这个回调中把properties的内容记录到callback_data(用户自定义回调数据)中 obs_status response_properties_callback(const obs_response_properties *properties, void *callback_data) { if (properties == NULL) { printf("error! obs_response_properties is null!"); return OBS_STATUS_OK; } // 打印响应信息 #define print_nonnull(name, field) \ do { \ if (properties-> field) { \ printf("%s: %s\n", name, properties->field); \ } \ } while (0) print_nonnull("request_id", request_id); print_nonnull("request_id2", request_id2); print_nonnull("content_type", content_type); if (properties->content_length) { printf("content_length: %llu\n", properties->content_length); } print_nonnull("server", server); print_nonnull("ETag", etag); print_nonnull("expiration", expiration); print_nonnull("website_redirect_location", website_redirect_location); print_nonnull("version_id", version_id); print_nonnull("allow_origin", allow_origin); print_nonnull("allow_headers", allow_headers); print_nonnull("max_age", max_age); print_nonnull("allow_methods", allow_methods); print_nonnull("expose_headers", expose_headers); print_nonnull("storage_class", storage_class); print_nonnull("server_side_encryption", server_side_encryption); print_nonnull("kms_key_id", kms_key_id); print_nonnull("customer_algorithm", customer_algorithm); print_nonnull("customer_key_md5", customer_key_md5); print_nonnull("bucket_location", bucket_location); print_nonnull("obs_version", obs_version); print_nonnull("restore", restore); print_nonnull("obs_object_type", obs_object_type); print_nonnull("obs_next_append_position", obs_next_append_position); print_nonnull("obs_head_epid", obs_head_epid); print_nonnull("reserved_indicator", reserved_indicator); int i; for (i = 0; i < properties->meta_data_count; i++) { printf("x-obs-meta-%s: %s\n", properties->meta_data[i].name, properties->meta_data[i].value); } return OBS_STATUS_OK; } void print_error_details(const obs_error_details *error) { if (error && error->message) { printf("Error Message: \n %s\n", error->message); } if (error && error->resource) { printf("Error Resource: \n %s\n", error->resource); } if (error && error->further_details) { printf("Error further_details: \n %s\n", error->further_details); } if (error && error->extra_details_count) { int i; for (i = 0; i < error->extra_details_count; i++) { printf("Error Extra Detail(%d):\n %s:%s\n", i, error->extra_details[i].name, error->extra_details[i].value); } } if (error && error->error_headers_count) { int i; for (i = 0; i < error->error_headers_count; i++) { const char *errorHeader = error->error_headers[i]; printf("Error Headers(%d):\n %s\n", i, errorHeader == NULL ? "NULL Header" : errorHeader); } } } static void list_versions_complete_callback(obs_status status, const obs_error_details *error, void *callback_data) { if (callback_data) { list_versions_callback_data *data = (list_versions_callback_data*)callback_data; data->ret_status = status; } else { printf("Callback_data is NULL"); } print_error_details(error); } static void printListVersionsHeader(int allDetails) { printf("%-30s %-20s %-5s %-32s", " Key", " Last Modified", " Size", " VersionId"); if (allDetails) { printf(" %-34s %-12s %-12s %-12s", " ETag", "Storage Class", "Owner ID", " Display Name"); } printf("\n"); printf("------------------------------ " "-------------------- ----- --------------------------------"); if (allDetails) { printf(" ---------------------------------- ------------ -------------------------------- ------------"); } printf("\n"); } static obs_status listVersionsCallback(int is_truncated, const char *next_key_marker, const char *next_versionId_marker, const obs_list_versions *list_versions, void *callback_data) { list_versions_callback_data *data = (list_versions_callback_data *)callback_data; data->is_truncated = is_truncated; if ((!next_key_marker || !next_key_marker[0]) && list_versions->versions_count) { next_key_marker = list_versions->versions[list_versions->versions_count - 1].key; } if (next_key_marker) { snprintf(data->next_key_marker, sizeof(data->next_key_marker), "%s", next_key_marker); } else { data->next_key_marker[0] = 0; } if ((!next_versionId_marker || !next_versionId_marker[0]) && list_versions->versions_count) { next_versionId_marker = list_versions->versions[list_versions->versions_count - 1].version_id; } if (next_versionId_marker) { snprintf(data->next_versionId_marker, sizeof(data->next_versionId_marker), "%s", next_versionId_marker); } else { data->next_versionId_marker[0] = 0; } if (NULL != list_versions->bucket_name) { printf("Name = %s\n", list_versions->bucket_name); } if (NULL != list_versions->prefix) { printf("prefix = %s\n", list_versions->prefix); } if (NULL != list_versions->key_marker) { printf("key_marker = %s\n", list_versions->key_marker); } if (NULL != list_versions->delimiter) { printf("delimiter = %s\n", list_versions->delimiter); } if (NULL != list_versions->max_keys) { printf("max_keys = %s\n", list_versions->max_keys); } if (list_versions->versions_count && !data->keyCount) { printListVersionsHeader(data->allDetails); } int i; for (i = 0; i < list_versions->versions_count; i++) { obs_version *version = &(list_versions->versions[i]); char timebuf[256] = { 0 }; time_t t = (time_t)version->last_modified; strftime(timebuf, sizeof(timebuf), "%Y-%m-%dT%H:%M:%SZ", gmtime(&t)); char sizebuf[16] = { 0 }; if (version->size < 100000) { sprintf_s(sizebuf, sizeof(sizebuf), "%5llu", (unsigned long long) version->size); } else if (version->size < (1024 * 1024)) { sprintf_s(sizebuf, sizeof(sizebuf), "%4lluK", ((unsigned long long) version->size) / 1024ULL); } else if (version->size < (10 * 1024 * 1024)) { float f = version->size; f /= (1024 * 1024); sprintf_s(sizebuf, sizeof(sizebuf), "%1.2fM", f); } else if (version->size < (1024 * 1024 * 1024)) { sprintf_s(sizebuf, sizeof(sizebuf), "%4lluM", ((unsigned long long) version->size) / (1024ULL * 1024ULL)); } else { float f = (version->size / 1024); f /= (1024 * 1024); sprintf_s(sizebuf, sizeof(sizebuf), "%1.2fG", f); } printf("%-30s %s %s %-32s", version->key, timebuf, sizebuf, version->version_id); if (data->allDetails) { printf(" %-34s %-12s %-32s %-12s", version->etag, version->storage_class, version->owner_id ? version->owner_id : "", version->owner_display_name ? version->owner_display_name : ""); } printf("\n"); } printf("versions_count=%d\n", list_versions->versions_count); printf("---------------------------------------------------------------------------------"); printf("--------------------------------"); printf("---------------------------------------------------------------------------------\n"); for (i = 0; i < list_versions->common_prefixes_count; i++) { printf("commonPrefix => prefix = %s\n", *(list_versions->common_prefixes + i)); } data->keyCount += list_versions->versions_count; return OBS_STATUS_OK; } ``` ![](https://support.huaweicloud.com/sdk-c-devg-obs/public_sys-resources/note_3.0-zh-cn.png) - 每次至多返回1000个多版本对象，如果指定桶包含的对象数量大于1000，则返回结果中is_truncated为true表明本次没有返回全部对象，并可通过next_key_marker和next_versionId_marker获取下次列举的起始位置。 - 如果想获取指定桶包含的所有多版本对象，可以采用分页列举的方式。 #### 相关链接 - 关于列举桶内多版本对象的API说明，请参见[列举桶内对象](https://support.huaweicloud.com/api-obs/obs_04_0022.html)。 - 更多关于列举桶内多版本对象的代码示例，请参见[Github示例](https://github.com/huaweicloud/huaweicloud-sdk-c-obs/blob/master/source/eSDK_OBS_API/eSDK_OBS_API_C++_Demo/demo.c)。 - 列举桶内多版本对象过程中返回的错误码含义、问题原因及处理措施可参考[OBS错误码](https://support.huaweicloud.com/api-obs/obs_04_0115.html#section1)。 - 桶和对象相关常见问题请参见[桶和对象相关常见问题](https://support.huaweicloud.com/obs_faq/obs_faq_1200.html)。