文档首页/ 对象存储服务 OBS/ SDK参考/ C / 管理对象/ 列举对象
更新时间：2024-12-03 GMT+08:00
查看PDF
分享

列举对象

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

您可以通过函数list_bucket_objects列举出桶里的对象。

参数描述

字段名

类型

约束

说明

option

请求桶的上下文，配置option

必选

桶参数。

prefix

char *

可选

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

marker

char *

可选

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

delimiter

char *

可选

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

对于并行文件系统，不携带此参数时默认列举是递归列举此目录下所有内容，会列举子目录。在大数据场景下（目录层级深、目录下文件多）的列举，建议设置[delimiter="/"]，只列举当前目录下的内容，不列举子目录，提高列举效率。

maxkeys

int

必选

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

handler

obs_list_objects_handler *

必选

回调函数。

callback_data

void *

可选

回调数据。

示例代码

static void test_list_bucket_objects(char *bucket_name)
{
    // 创建并初始化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_objects_handler list_bucket_objects_handler =
    {
        { &response_properties_callback, &listobjects_complete_callback },
        &list_objects_callback
    };
    
    // 用户自定义回调数据
    list_bucket_callback_data data;
    memset(&data, 0, sizeof(list_bucket_callback_data)); 
    // 列举对象
    list_bucket_objects(&option, "<prefix>", "<marker>", "<delimiter>", "<maxkeys>", &list_bucket_objects_handler, &data); 
    if (OBS_STATUS_OK == data.ret_status) {
        printf("list bucket objects successfully. \n");
    }
    else
    {
        printf("list bucket objects failed(%s).\n", 
        obs_get_status_name(data.ret_status));
    }
}
  • 每次至多返回1000个对象，如果指定桶包含的对象数量大于1000，则返回结果中list_objects_data.is_truncated为true表明本次没有返回全部对象，并可通过list_objects_data.next_marker获取下次列举的起始位置。
  • 想获取所有对象，可以采用分页列举的方式。
父主题： 管理对象