# 下载限速(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)中发帖求助。
#### 功能说明
下载限速是指在下载对象时对单链接请求的带宽进行限制，避免因单个下载请求占用过多带宽而影响其他业务。OBS C SDK通过在下载请求中设置download_limit参数实现下载限速，SDK会将限速值写入x-obs-traffic-limit请求头，由服务端进行限速控制。
支持下载限速的接口包括[对象下载（get_object）](https://support.huaweicloud.com/sdk-c-devg-obs/obs_20_0501.html)。
#### 接口约束
- 您必须是桶拥有者或拥有下载对象的权限，才能使用下载限速功能。建议使用IAM或桶策略进行授权，如果使用IAM则需授予obs:object:GetObject权限，如果使用桶策略则需授予GetObject权限。相关授权方式介绍可参见[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_0075.html)。
- OBS支持的Region与Endpoint的对应关系，详细信息请参见[地区与终端节点](https://console.huaweicloud.com/apiexplorer/#/endpoint/OBS)。
- 对于存储类别为归档存储或深度归档存储的对象，需要确认对象的状态为"已恢复"才能对其进行下载。
 
#### 方法定义
```
void get_object(const obs_options *options, obs_object_info *object_info,
    obs_get_conditions *get_conditions,
    server_side_encryption_params *encryption_params,
    obs_get_object_handler *handler, void *callback_data);
```
#### 请求参数
下载限速相关的参数在obs_get_conditions结构体中，可通过init_get_properties初始化该结构体。
表1obs_get_conditions中的限速相关参数 
| 参数名称           | 参数类型     | 是否必选 | 描述                                                                                                                                                                                                                                                                                                      |
|:---|:---|:---|:---|
| download_limit | uint64_t | 可选   | **参数解释：** 对单链接请求的带宽限制。 **约束限制：** 无 **取值范围：** 819200\~838860800，单位为bit/s。 **默认取值：** 0，表示不限速。 |
   
#### 代码示例
以下示例展示如何在下载对象时设置下载限速：
```
#include "eSDKOBS.h"
#include <stdio.h>
obs_status response_properties_callback(const obs_response_properties *properties, void *callback_data);
void response_complete_callback(obs_status status, const obs_error_details *error, void *callback_data);
obs_status get_object_data_callback(int buffer_size, const char *buffer, void *callback_data);
int main()
{
    obs_initialize(OBS_INIT_ALL);
    obs_options options;
    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");
    options.bucket_options.bucket_name = "example-bucket-name";
    // 设置下载条件，包含限速配置
    obs_get_conditions get_conditions;
    init_get_properties(&get_conditions);
    get_conditions.download_limit = 819200;  // 限速100 KB/s（819200 bit/s）
    obs_object_info object_info = {0};
    object_info.key = "objectname";
    obs_get_object_handler handler = {
        &response_properties_callback,
        &response_complete_callback,
        &get_object_data_callback
    };
    obs_status ret_status = OBS_STATUS_BUTT;
    get_object(&options, &object_info, &get_conditions, NULL, &handler, &ret_status);
    if (OBS_STATUS_OK == ret_status) {
        printf("get object with download limit successfully.\n");
    } else {
        printf("get object with download limit failed(%s).\n", obs_get_status_name(ret_status));
    }
    obs_deinitialize();
}
obs_status get_object_data_callback(int buffer_size, const char *buffer, void *callback_data)
{
    (void)buffer_size; (void)buffer; (void)callback_data;
    return OBS_STATUS_OK;
}
obs_status response_properties_callback(const obs_response_properties *properties, void *callback_data)
{
    (void)properties; (void)callback_data;
    return OBS_STATUS_OK;
}
void response_complete_callback(obs_status status, const obs_error_details *error, void *callback_data)
{
    if (callback_data) { *(obs_status*)callback_data = status; }
    if (error && error->message) { printf("Error: %s\n", error->message); }
}
```
![](https://support.huaweicloud.com/sdk-c-devg-obs/public_sys-resources/note_3.0-zh-cn.png)
- 通过操作对象输入流可将对象的内容读取到本地文件或者内存中。
- getcondition可以传空，表示下载整个对象。
 
#### 相关链接
- 关于下载限速的API说明，请参见[下载对象](https://support.huaweicloud.com/api-obs/obs_04_0083.html)。
- 下载限速过程中返回的错误码含义、问题原因及处理措施可参考[OBS错误码](https://support.huaweicloud.com/api-obs/obs_04_0115.html#section1)。