tencent cloud

文档反馈

删除对象

最后更新时间:2022-01-23 14:17:46

    简介

    本文档提供关于对象删除操作相关的 API 概览以及 SDK 示例代码。

    API 操作名 操作描述
    DELETE Object 删除单个对象 在存储桶中删除指定对象
    DELETE Multiple Objects 删除多个对象 在存储桶中批量删除对象

    删除单个对象

    功能说明

    在存储桶中删除指定对象。

    方法原型

    cos_status_t *cos_delete_object(const cos_request_options_t *options,
                                  const cos_string_t *bucket, 
                                  const cos_string_t *object, 
                                  cos_table_t **resp_headers);
    

    参数说明

    参数名称 参数描述 类型
    options COS 请求选项 Struct
    bucket 存储桶名称,存储桶的命名格式为 BucketName-APPID,此处填写的存储桶名称必须为此格式 String
    object Object 名称 String
    resp_headers 返回 HTTP 响应消息的头域 Struct

    返回结果说明

    返回结果 描述 类型
    code 错误码 Int
    error_code 错误码内容 String
    error_msg 错误码描述 String
    req_id 请求消息 ID String

    示例1:删除对象

    #include "cos_http_io.h"
    #include "cos_api.h"
    #include "cos_log.h"
    // endpoint 是 COS 访问域名信息,详情请参见 https://intl.cloud.tencent.com/document/product/436/6224?from_cn_redirect=1 文档
    static char TEST_COS_ENDPOINT[] = "cos.ap-guangzhou.myqcloud.com";
    // 开发者拥有的项目身份ID/密钥,可在 https://console.intl.cloud.tencent.com/cam/capi 页面获取
    static char *TEST_ACCESS_KEY_ID;                //your secret_id
    static char *TEST_ACCESS_KEY_SECRET;            //your secret_key
    // 开发者访问 COS 服务时拥有的用户维度唯一资源标识,用以标识资源,可在 https://console.intl.cloud.tencent.com/cam/capi 页面获取
    static char TEST_APPID[] = "<APPID>";    //your appid
    //the cos bucket name, syntax: [bucket]-[appid], for example: mybucket-1253666666,可在 https://console.intl.cloud.tencent.com/cos5/bucket 查看
    static char TEST_BUCKET_NAME[] = "<bucketname-appid>";  
    // 对象键,对象(Object)在存储桶(Bucket)中的唯一标识。有关对象与对象键的进一步说明,请参见 https://intl.cloud.tencent.com/document/product/436/13324?from_cn_redirect=1 文档
    static char TEST_OBJECT_NAME1[] = "1.txt";
    void init_test_config(cos_config_t *config, int is_cname)
    {
      cos_str_set(&config->endpoint, TEST_COS_ENDPOINT);
      cos_str_set(&config->access_key_id, TEST_ACCESS_KEY_ID);
      cos_str_set(&config->access_key_secret, TEST_ACCESS_KEY_SECRET);
      cos_str_set(&config->appid, TEST_APPID);
      config->is_cname = is_cname;
    }
    void init_test_request_options(cos_request_options_t *options, int is_cname)
    {
      options->config = cos_config_create(options->pool);
      init_test_config(options->config, is_cname);
      options->ctl = cos_http_controller_create(options->pool, 0);
    }
    void test_delete_object()
    {
      cos_pool_t *p = NULL;
      int is_cname = 0;
      cos_status_t *s = NULL;
      cos_request_options_t *options = NULL;
      cos_string_t bucket;
      cos_string_t object;
      cos_table_t *resp_headers = NULL;
       //创建内存池
      cos_pool_create(&p, NULL);
       //初始化请求选项
      options = cos_request_options_create(p);
      init_test_request_options(options, is_cname);
      cos_str_set(&bucket, TEST_BUCKET_NAME);
       //删除单个对象
      cos_str_set(&object, TEST_OBJECT_NAME1);
      s = cos_delete_object(options, &bucket, &object, &resp_headers);
      if (cos_status_is_ok(s)) {
          printf("delete object succeeded\n");
      } else {
          printf("delete object failed\n");
      }
       //销毁内存池
      cos_pool_destroy(p); 
    }
    int main(int argc, char *argv[])
    {
      // 通过环境变量获取 SECRETID 和 SECRETKEY
      TEST_ACCESS_KEY_ID     = getenv("COS_SECRETID");
      TEST_ACCESS_KEY_SECRET = getenv("COS_SECRETKEY");
        if (cos_http_io_initialize(NULL, 0) != COSE_OK) {
         exit(1);
      }
       //set log level, default COS_LOG_WARN
      cos_log_set_level(COS_LOG_WARN);
       //set log output, default stderr
      cos_log_set_output(NULL);
       test_delete_object();
       cos_http_io_deinitialize();
       return 0;
    }
    

    示例2:删除文件夹

    该请求不会删除文件夹内的对象,只会删除指定的 key。

    #include "cos_http_io.h"
    #include "cos_api.h"
    #include "cos_log.h"
    // endpoint 是 COS 访问域名信息,详情请参见 https://intl.cloud.tencent.com/document/product/436/6224?from_cn_redirect=1 文档
    static char TEST_COS_ENDPOINT[] = "cos.ap-guangzhou.myqcloud.com";
    // 开发者拥有的项目身份ID/密钥,可在 https://console.intl.cloud.tencent.com/cam/capi 页面获取
    static char *TEST_ACCESS_KEY_ID;                //your secret_id
    static char *TEST_ACCESS_KEY_SECRET;            //your secret_key
    // 开发者访问 COS 服务时拥有的用户维度唯一资源标识,用以标识资源,可在 https://console.intl.cloud.tencent.com/cam/capi 页面获取
    static char TEST_APPID[] = "<APPID>";    //your appid
    //the cos bucket name, syntax: [bucket]-[appid], for example: mybucket-1253666666,可在 https://console.intl.cloud.tencent.com/cos5/bucket 查看
    static char TEST_BUCKET_NAME[] = "<bucketname-appid>";  
    void init_test_config(cos_config_t *config, int is_cname)
    {
      cos_str_set(&config->endpoint, TEST_COS_ENDPOINT);
      cos_str_set(&config->access_key_id, TEST_ACCESS_KEY_ID);
      cos_str_set(&config->access_key_secret, TEST_ACCESS_KEY_SECRET);
      cos_str_set(&config->appid, TEST_APPID);
      config->is_cname = is_cname;
    }
    void init_test_request_options(cos_request_options_t *options, int is_cname)
    {
      options->config = cos_config_create(options->pool);
      init_test_config(options->config, is_cname);
      options->ctl = cos_http_controller_create(options->pool, 0);
    }
    void test_delete_dir()
    {
      cos_pool_t *p = NULL;
      int is_cname = 0;
      cos_status_t *s = NULL;
      cos_request_options_t *options = NULL;
      cos_string_t bucket;
      cos_string_t object;
      cos_table_t *resp_headers = NULL;
       //创建内存池
      cos_pool_create(&p, NULL);
       //初始化请求选项
      options = cos_request_options_create(p);
      init_test_request_options(options, is_cname);
      cos_str_set(&bucket, TEST_BUCKET_NAME);
       //删除目录对象
      cos_str_set(&object, "folder/");
      s = cos_delete_object(options, &bucket, &object, &resp_headers);
      if (cos_status_is_ok(s)) {
          printf("delete object succeeded\n");
      } else {
          printf("delete object failed\n");
      }
       //销毁内存池
      cos_pool_destroy(p); 
    }
    int main(int argc, char *argv[])
    {
      // 通过环境变量获取 SECRETID 和 SECRETKEY
      TEST_ACCESS_KEY_ID     = getenv("COS_SECRETID");
      TEST_ACCESS_KEY_SECRET = getenv("COS_SECRETKEY");
        if (cos_http_io_initialize(NULL, 0) != COSE_OK) {
         exit(1);
      }
       //set log level, default COS_LOG_WARN
      cos_log_set_level(COS_LOG_WARN);
       //set log output, default stderr
      cos_log_set_output(NULL);
       test_delete_dir();
       cos_http_io_deinitialize();
       return 0;
    }
    

    删除多个对象

    功能说明

    在存储桶中批量删除对象,最大支持单次删除1000个对象。对于返回结果,COS 提供 Verbose 和 Quiet 两种结果模式。Verbose 模式将返回每个 Object 的删除结果。Quiet 模式只返回报错的 Object 信息。

    方法原型

    cos_status_t *cos_delete_objects(const cos_request_options_t *options,
                                   const cos_string_t *bucket, 
                                   cos_list_t *object_list, 
                                   int is_quiet,
                                   cos_table_t **resp_headers, 
                                   cos_list_t *deleted_object_list);
    

    参数说明

    参数名称 参数描述 类型
    options COS 请求选项 Struct
    bucket 存储桶名称,存储桶的命名格式为 BucketName-APPID,此处填写的存储桶名称必须为此格式 String
    object_list Object 待删除列表 Struct
    key 待删除 Object 名称 String
    is_quiet 决定是否启动 Quiet 模式:
    True(1):启动 Quiet 模式,False(0):启动 Verbose 模式。默认为 False(0)
    Boolean
    resp_headers 返回 HTTP 响应消息的头域 Struct
    deleted_object_list Object 删除信息列表 Struct

    返回结果说明

    返回结果 描述 类型
    code 错误码 Int
    error_code 错误码内容 String
    error_msg 错误码描述 String
    req_id 请求消息 ID String

    示例1:删除多个对象

    #include "cos_http_io.h"
    #include "cos_api.h"
    #include "cos_log.h"
    // endpoint 是 COS 访问域名信息,详情请参见 https://intl.cloud.tencent.com/document/product/436/6224?from_cn_redirect=1 文档
    static char TEST_COS_ENDPOINT[] = "cos.ap-guangzhou.myqcloud.com";
    // 开发者拥有的项目身份ID/密钥,可在 https://console.intl.cloud.tencent.com/cam/capi 页面获取
    static char *TEST_ACCESS_KEY_ID;                //your secret_id
    static char *TEST_ACCESS_KEY_SECRET;            //your secret_key
    // 开发者访问 COS 服务时拥有的用户维度唯一资源标识,用以标识资源,可在 https://console.intl.cloud.tencent.com/cam/capi 页面获取
    static char TEST_APPID[] = "<APPID>";    //your appid
    //the cos bucket name, syntax: [bucket]-[appid], for example: mybucket-1253666666,可在 https://console.intl.cloud.tencent.com/cos5/bucket 查看
    static char TEST_BUCKET_NAME[] = "<bucketname-appid>";
    // 对象键,对象(Object)在存储桶(Bucket)中的唯一标识。有关对象与对象键的进一步说明,请参见 https://intl.cloud.tencent.com/document/product/436/13324?from_cn_redirect=1 文档
    static char TEST_OBJECT_NAME2[] = "test2.dat";
    static char TEST_OBJECT_NAME3[] = "test3.dat";
    void log_status(cos_status_t *s)
    {
      cos_warn_log("status->code: %d", s->code);
      if (s->error_code) cos_warn_log("status->error_code: %s", s->error_code);
      if (s->error_msg) cos_warn_log("status->error_msg: %s", s->error_msg);
      if (s->req_id) cos_warn_log("status->req_id: %s", s->req_id);
    }
    void init_test_config(cos_config_t *config, int is_cname)
    {
      cos_str_set(&config->endpoint, TEST_COS_ENDPOINT);
      cos_str_set(&config->access_key_id, TEST_ACCESS_KEY_ID);
      cos_str_set(&config->access_key_secret, TEST_ACCESS_KEY_SECRET);
      cos_str_set(&config->appid, TEST_APPID);
      config->is_cname = is_cname;
    }
    void init_test_request_options(cos_request_options_t *options, int is_cname)
    {
      options->config = cos_config_create(options->pool);
      init_test_config(options->config, is_cname);
      options->ctl = cos_http_controller_create(options->pool, 0);
    }
    void test_delete_objects()
    {
      cos_pool_t *p = NULL;
      int is_cname = 0;
      cos_string_t bucket;
      cos_status_t *s = NULL;
      cos_table_t *resp_headers = NULL;
      cos_request_options_t *options = NULL;
      char *object_name1 = TEST_OBJECT_NAME2;
      char *object_name2 = TEST_OBJECT_NAME3;
      cos_object_key_t *content1 = NULL;
      cos_object_key_t *content2 = NULL;
      cos_list_t object_list;
      cos_list_t deleted_object_list;
      int is_quiet = COS_TRUE;
       cos_pool_create(&p, NULL);
      options = cos_request_options_create(p);
      init_test_request_options(options, is_cname);
      cos_str_set(&bucket, TEST_BUCKET_NAME);
       cos_list_init(&object_list);
      cos_list_init(&deleted_object_list);
      content1 = cos_create_cos_object_key(p);
      cos_str_set(&content1->key, object_name1);
      cos_list_add_tail(&content1->node, &object_list);
      content2 = cos_create_cos_object_key(p);
      cos_str_set(&content2->key, object_name2);
      cos_list_add_tail(&content2->node, &object_list);
       s = cos_delete_objects(options, &bucket, &object_list, is_quiet,
          &resp_headers, &deleted_object_list);
      log_status(s);
    
      cos_pool_destroy(p);
       if (cos_status_is_ok(s)) {
          printf("delete objects succeeded\n");
      } else {
          printf("delete objects failed\n");
      }
    }
    int main(int argc, char *argv[])
    {
      // 通过环境变量获取 SECRETID 和 SECRETKEY
      TEST_ACCESS_KEY_ID     = getenv("COS_SECRETID");
      TEST_ACCESS_KEY_SECRET = getenv("COS_SECRETKEY");
        if (cos_http_io_initialize(NULL, 0) != COSE_OK) {
         exit(1);
      }
       //set log level, default COS_LOG_WARN
      cos_log_set_level(COS_LOG_WARN);
       //set log output, default stderr
      cos_log_set_output(NULL);
       test_delete_objects();
       cos_http_io_deinitialize();
       return 0;
    }
    

    示例2:删除文件夹及其文件

    对象存储中本身是没有文件夹和目录的概念的,为了满足用户使用习惯,用户可通过分隔符/来模拟“文件夹”。

    删除文件夹及其文件这一场景,实际在 COS 上相当于删除一批有着同样前缀的对象。目前 COS C SDK 没有提供一个接口去实现这样的操作,但是可以通过组合查询对象列表加上批量删除对象的基本操作,达到删除文件夹及其文件的效果。

    #include "cos_http_io.h"
    #include "cos_api.h"
    #include "cos_log.h"
    // endpoint 是 COS 访问域名信息,详情请参见 https://intl.cloud.tencent.com/document/product/436/6224 文档
    static char TEST_COS_ENDPOINT[] = "cos.ap-guangzhou.myqcloud.com";
    // 开发者拥有的项目身份ID/密钥,可在 https://console.intl.cloud.tencent.com/cam/capi 页面获取
    static char *TEST_ACCESS_KEY_ID;                //your secret_id
    static char *TEST_ACCESS_KEY_SECRET;            //your secret_key
    // 开发者访问 COS 服务时拥有的用户维度唯一资源标识,用以标识资源,可在 https://console.intl.cloud.tencent.com/cam/capi 页面获取
    static char TEST_APPID[] = "<APPID>";    //your appid
    //the cos bucket name, syntax: [bucket]-[appid], for example: mybucket-1253666666,可在 https://console.intl.cloud.tencent.com/cos5/bucket 查看
    static char TEST_BUCKET_NAME[] = "<bucketname-appid>";
    void log_status(cos_status_t *s)
    {
      cos_warn_log("status->code: %d", s->code);
      if (s->error_code) cos_warn_log("status->error_code: %s", s->error_code);
      if (s->error_msg) cos_warn_log("status->error_msg: %s", s->error_msg);
      if (s->req_id) cos_warn_log("status->req_id: %s", s->req_id);
    }
    void init_test_config(cos_config_t *config, int is_cname)
    {
      cos_str_set(&config->endpoint, TEST_COS_ENDPOINT);
      cos_str_set(&config->access_key_id, TEST_ACCESS_KEY_ID);
      cos_str_set(&config->access_key_secret, TEST_ACCESS_KEY_SECRET);
      cos_str_set(&config->appid, TEST_APPID);
      config->is_cname = is_cname;
    }
    void init_test_request_options(cos_request_options_t *options, int is_cname)
    {
      options->config = cos_config_create(options->pool);
      init_test_config(options->config, is_cname);
      options->ctl = cos_http_controller_create(options->pool, 0);
    }
    void test_delete_directory()
    {
      cos_pool_t *p = NULL;
      int is_cname = 0;
      cos_status_t *s = NULL;
      cos_request_options_t *options = NULL;
      cos_string_t bucket;
      cos_table_t *resp_headers;
      int is_truncated = 1;
      cos_string_t marker;
      cos_list_t deleted_object_list;
      int is_quiet = COS_TRUE;
       cos_pool_create(&p, NULL);
      options = cos_request_options_create(p);
      init_test_request_options(options, is_cname);
      cos_str_set(&bucket, TEST_BUCKET_NAME);
       //list object (get bucket)
      cos_list_object_params_t *list_params = NULL;
      list_params = cos_create_list_object_params(p);
      cos_str_set(&list_params->prefix, "folder/");
      cos_str_set(&marker, "");
      while (is_truncated) {
          list_params->marker = marker;
          s = cos_list_object(options, &bucket, list_params, &resp_headers);
          if (!cos_status_is_ok(s)) {
              printf("list object failed, req_id:%s\n", s->req_id);
              break;
          }
           s = cos_delete_objects(options, &bucket, &list_params->object_list, is_quiet, &resp_headers, &deleted_object_list);
          log_status(s);
          if (!cos_status_is_ok(s)) {
              printf("delete objects failed, req_id:%s\n", s->req_id);
          }
           is_truncated = list_params->truncated;
          marker = list_params->next_marker;
      }
      cos_pool_destroy(p);
    }
    int main(int argc, char *argv[])
    {
      // 通过环境变量获取 SECRETID 和 SECRETKEY
      TEST_ACCESS_KEY_ID     = getenv("COS_SECRETID");
      TEST_ACCESS_KEY_SECRET = getenv("COS_SECRETKEY");
        if (cos_http_io_initialize(NULL, 0) != COSE_OK) {
         exit(1);
      }
       //set log level, default COS_LOG_WARN
      cos_log_set_level(COS_LOG_WARN);
       //set log output, default stderr
      cos_log_set_output(NULL);
       test_delete_directory();
       cos_http_io_deinitialize();
       return 0;
    }
    
    联系我们

    联系我们,为您的业务提供专属服务。

    技术支持

    如果你想寻求进一步的帮助,通过工单与我们进行联络。我们提供7x24的工单服务。

    7x24 电话支持