更新时间:2023-11-09 GMT+08:00

列举多版本对象

开发过程中,您有任何问题可以在github上提交issue

您可以通过list_versions列举多版本对象。

该接口可设置的参数如下:

字段名

类型

约束

说明

option

请求桶的上下文,配置option

必选

桶参数。

prefix

char *

可选

限定返回的对象名必须带有prefix前缀。

key_marker

char *

可选

列举多版本对象的起始位置,返回的对象列表将是对象名按照字典序排序后该参数以后的所有对象。

delimiter

char *

可选

用于对对象名进行分组的字符。对于对象名中包含delimiter的对象,其对象名(如果请求中指定了prefix,则此处的对象名需要去掉prefix)中从首字符至第一个delimiter之间的字符串将作为一个分组并作为common_prefixes返回。

version_id_marker

char *

可选

与key_marker配合使用,返回的对象列表将是对象名和版本号按照字典序排序后该参数以后的所有对象。

maxkeys

int

必选

列举对象的最大数目,取值范围为1~1000,当超出范围时,按照默认的1000进行处理。

handler

obs_list_versions_handler *

必选

回调函数。

callback_data

void *

可选

回调数据。

  • 如果version_id_marker不是key_marker的一个版本号,则该参数无效。
  • list_versions返回结果包含多版本对象和对象删除标记。

以下代码展示如何列举多版本对象:

static void test_list_versions()
{
    char *prefix = "o";
    char *key_marker = "obj";  
    char *delimiter = "/";
    int maxkeys  =  10;
    // 创建并初始化option
    obs_options option;
    init_obs_options(&option);
    option.bucket_options.host_name = "<your-endpoint>";
    option.bucket_options.bucket_name = "<Your bucketname>";

    // 认证用的ak和sk硬编码到代码中或者明文存储都有很大的安全风险,建议在配置文件或者环境变量中密文存放,使用时解密,确保安全;本示例以ak和sk保存在环境变量中为例,运行本示例前请先在本地环境中设置环境变量ACCESS_KEY_ID和SECRET_ACCESS_KEY。
    // 您可以登录访问管理控制台获取访问密钥AK/SK,获取方式请参见https://support.huaweicloud.com/intl/zh-cn/usermanual-ca/ca_01_0003.html
    option.bucket_options.access_key = getenv("ACCESS_KEY_ID");
    option.bucket_options.secret_access_key = getenv("SECRET_ACCESS_KEY");
    // 设置响应回调函数
    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_bucket_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(&option, 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));
    }
}
  • 每次至多返回1000个多版本对象,如果指定桶包含的对象数量大于1000,则返回结果中is_truncated为true表明本次没有返回全部对象,并可通过next_key_marker和next_versionId_marker获取下次列举的起始位置。
  • 如果想获取指定桶包含的所有多版本对象,可以采用分页列举的方式。