设置镜像回源规则(C SDK)

功能介绍

镜像回源是OBS提供的一种数据自动获取功能。调用设置桶镜像回源规则接口，您可为指定桶配置镜像回源规则，当客户端访问桶中不存在的对象时，OBS会自动从源站获取数据并返回给客户端，同时将数据存储到桶中。

接口约束

• 您必须是桶拥有者或拥有设置桶镜像回源规则的权限，才能设置桶镜像回源规则。建议使用IAM或桶策略进行授权，如果使用IAM则需授予obs:bucket:PutBucketMirrorBackToSource权限，如果使用桶策略则需授予PutBucketMirrorBackToSource权限。相关授权方式介绍可参见OBS权限控制概述，配置方式详见使用IAM自定义策略、自定义创建桶策略。
• OBS支持的Region与Endpoint的对应关系，详细信息请参见地区与终端节点。
• 每个桶最多配置10条镜像回源规则。
• 规则ID在桶内必须唯一。

方法定义

void set_bucket_mirror_back_to_source(const obs_options *options,
    obs_mirror_back_to_source_rule *mirror_back_to_source_rules,
    unsigned int rule_number,
    obs_response_handler *handler, void *callback_data);

请求参数说明

代码示例

以下示例展示如何设置简单的镜像回源规则（404回源）。

#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);
int main()
{
    obs_initialize(OBS_INIT_ALL);
    obs_options options;
    init_obs_options(&options);
    // host_name填写桶所在的endpoint, 此处以中国-香港为例，其他地区请按实际情况填写。
    options.bucket_options.host_name = "obs.ap-southeast-1.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";
    // 配置主源站地址
    char *master_endpoints[] = {"https://source.example.com"};
    obs_mirror_back_to_source_source_endpoint source_endpoint = {0};
    source_endpoint.master = master_endpoints;
    source_endpoint.master_number = 1;
    // 配置源站信息
    obs_mirror_back_to_source_public_source public_source = {0};
    public_source.source_endpoint = source_endpoint;
    // 配置镜像回源重定向规则
    obs_mirror_back_to_source_redirect redirect = {0};
    redirect.agency = "your-agency-name";
    redirect.public_source = public_source;
    redirect.pass_query_string = 1;
    // 配置镜像回源条件
    obs_mirror_back_to_source_condition condition = {0};
    condition.http_error_code_returned_equals = "404";
    condition.key_prefix_equals = "image/";
    // 配置镜像回源规则
    obs_mirror_back_to_source_rule rule = {0};
    rule.id = "rule1";
    rule.condition = condition;
    rule.redirect = redirect;
    obs_response_handler response_handler = {&response_properties_callback, &response_complete_callback};
    obs_status ret_status = OBS_STATUS_BUTT;
    set_bucket_mirror_back_to_source(&options, &rule, 1, &response_handler, &ret_status);
    if (OBS_STATUS_OK == ret_status) {
        printf("set bucket mirror back to source successfully.\n");
    } else {
        printf("set bucket mirror back to source failed(%s).\n", obs_get_status_name(ret_status));
    }
    obs_deinitialize();
}
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); }
}

相关链接

• 关于设置桶镜像回源规则的API说明，请参见设置桶镜像回源规则。
• 设置桶镜像回源规则过程中返回的错误码含义、问题原因及处理措施可参考OBS错误码。