更新时间:2026-07-31 GMT+08:00

获取镜像回源规则(C SDK)

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

功能介绍

调用获取桶镜像回源规则接口,您可获取指定桶的镜像回源规则配置。

接口约束

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

方法定义

void get_bucket_mirror_back_to_source(const obs_options *options,
    obs_get_bucket_mirror_back_to_source_handler *handler, void *callback_data);

请求参数说明

表1 请求参数列表

参数名称

参数类型

是否必选

描述

options

const obs_options*

必选

参数解释:

请求桶的上下文,通过obs_options设置AK、SK、endpoint、bucket、超时时间、临时鉴权。

约束限制:

取值范围:

默认取值:

handler

表2 obs_get_bucket_mirror_back_to_source_handler*

必选

参数解释:

回调结构体,用于设置处理接口响应数据的回调函数。

约束限制:

取值范围:

默认取值:

callback_data

void *

可选

参数解释:

用户自定义回调数据。

约束限制:

取值范围:

默认取值:

表2 obs_get_bucket_mirror_back_to_source_handler

参数名称

参数类型

是否必选

描述

response_handler

obs_response_handler

必选

参数解释:

响应回调函数结构体。

约束限制:

取值范围:

默认取值:

get_bucket_mirror_back_to_source_callback

表3 obs_get_bucket_mirror_back_to_source_callback*

必选

参数解释:

镜像回源规则回调函数指针,可以在这个回调中把mirror_back_to_source_rules_return的内容记录到callback_data中。

约束限制:

取值范围:

默认取值:

表3 obs_get_bucket_mirror_back_to_source_callback

参数名称

参数类型

是否必选

描述

mirror_back_to_source_rules_return

表4 obs_mirror_back_to_source_rule*

必选

参数解释:

镜像回源规则结构体数组,包含id、condition、redirect等信息。

约束限制:

该结构体及其中指针指向的内存在回调返回后会被SDK释放,如需保留请自行复制。

取值范围:

默认取值:

rule_number

unsigned int

必选

参数解释:

镜像回源规则的数量。

约束限制:

取值范围:

默认取值:

callback_data

void *

必选

参数解释:

用户自定义回调数据指针。

约束限制:

取值范围:

默认取值:

表4 obs_mirror_back_to_source_rule

参数名称

参数类型

是否必选

描述

id

char *

必选

参数解释:

规则ID,在桶内唯一标识一条镜像回源规则。

约束限制:

取值范围:

长度为1~256的字符串。

默认取值:

condition

表1 obs_mirror_back_to_source_condition

必选

参数解释:

镜像回源条件,指定触发回源请求的条件。

约束限制:

取值范围:

默认取值:

redirect

表6

必选

参数解释:

重定向配置,指定回源时的目标源站及重定向行为。

约束限制:

取值范围:

默认取值:

表5 obs_mirror_back_to_source_condition

参数名称

参数类型

是否必选

描述

http_error_code_returned_equals

char *

必选

参数解释:

OBS返回的HTTP错误码,当OBS返回该错误码时触发镜像回源。

约束限制:

取值范围:

HTTP状态码,如404、403。

默认取值:

key_prefix_equals

char *

可选

参数解释:

对象名前缀,仅当访问的对象名匹配该前缀时才触发回源。

约束限制:

取值范围:

默认取值:

表6 obs_mirror_back_to_source_redirect

参数名称

参数类型

是否必选

描述

agency

char *

必选

参数解释:

IAM委托名称,用于授权OBS服务访问源站。

约束限制:

取值范围:

默认取值:

public_source

表1 obs_mirror_back_to_source_public_source

必选

参数解释:

源站配置,指定镜像回源的目标源站地址。

约束限制:

取值范围:

默认取值:

retry_conditions

char **

可选

参数解释:

重试条件列表,当回源请求满足指定条件时进行重试。

约束限制:

最多20个重试条件。

取值范围:

默认取值:

retry_conditions_number

unsigned int

可选

参数解释:

重试条件的数量。

约束限制:

取值范围:

[0, 20]

默认取值:

0

pass_query_string

int

可选

参数解释:

是否透传查询字符串到源站。

约束限制:

取值范围:

  • 0:不透传
  • 1:透传

默认取值:

0

mirror_follow_redirect

int

可选

参数解释:

是否跟随源站的重定向响应。

约束限制:

取值范围:

  • 0:不跟随
  • 1:跟随

默认取值:

0

mirror_http_header

表2 obs_mirror_back_to_source_http_header

可选

参数解释:

HTTP头部配置,用于控制回源请求中HTTP头部的透传、移除和设置行为。

约束限制:

取值范围:

默认取值:

replace_key_with

char *

可选

参数解释:

回源时将对象名替换为指定值。

约束限制:

取值范围:

默认取值:

replace_key_prefix_with

char *

可选

参数解释:

回源时将对象名前缀替换为指定值。

约束限制:

取值范围:

默认取值:

vpc_endpoint_urn

char *

可选

参数解释:

VPC终端节点URN,用于通过VPC终端节点访问源站。

约束限制:

取值范围:

默认取值:

redirect_without_referer

int

可选

参数解释:

是否不带Referer头回源。

约束限制:

取值范围:

  • 0:带Referer
  • 1:不带Referer

默认取值:

0

mirror_allow_http_method

char **

可选

参数解释:

允许的HTTP方法列表。

约束限制:

最多2个HTTP方法。

取值范围:

默认取值:

mirror_allow_http_method_number

unsigned int

可选

参数解释:

允许的HTTP方法数量。

约束限制:

取值范围:

[0, 2]

默认取值:

0

表7 obs_mirror_back_to_source_public_source

参数名称

参数类型

是否必选

描述

source_endpoint

表1 obs_mirror_back_to_source_source_endpoint

必选

参数解释:

源站终端节点配置,指定主备源站地址。

约束限制:

取值范围:

默认取值:

表8 obs_mirror_back_to_source_source_endpoint

参数名称

参数类型

是否必选

描述

master

char **

必选

参数解释:

主源站地址列表。

约束限制:

最多5个主源站地址。

master_number

unsigned int

必选

参数解释:

主源站地址的数量。

约束限制:

取值范围:

[1, 5]

默认取值:

slave

char **

可选

参数解释:

备源站地址列表,当主源站不可用时使用。

约束限制:

最多5个备源站地址。

slave_number

unsigned int

可选

参数解释:

备源站地址的数量。

约束限制:

取值范围:

[0, 5]

默认取值:

0

表9 obs_mirror_back_to_source_http_header

参数名称

参数类型

是否必选

描述

pass_all

int

可选

参数解释:

是否透传所有HTTP头部到源站。

约束限制:

取值范围:

  • 0:不透传所有头部
  • 1:透传所有头部

默认取值:

0

pass

char **

可选

参数解释:

需要透传的HTTP头部名称列表。

约束限制:

最多10个头部名称。

取值范围:

默认取值:

pass_number

unsigned int

可选

参数解释:

需要透传的HTTP头部数量。

约束限制:

取值范围:

[0, 10]

默认取值:

0

remove

char **

可选

参数解释:

需要移除的HTTP头部名称列表。

约束限制:

最多10个头部名称。

取值范围:

默认取值:

remove_number

unsigned int

可选

参数解释:

需要移除的HTTP头部数量。

约束限制:

取值范围:

[0, 10]

默认取值:

0

set

表10*

可选

参数解释:

需要设置的HTTP头部列表。

约束限制:

最多10个头部。

取值范围:

默认取值:

set_number

unsigned int

可选

参数解释:

需要设置的HTTP头部数量。

约束限制:

取值范围:

[0, 10]

默认取值:

0

表10 obs_mirror_back_to_source_set_http_header

参数名称

参数类型

是否必选

描述

key

char *

必选

参数解释:

HTTP头部的名称。

约束限制:

取值范围:

默认取值:

value

char *

必选

参数解释:

HTTP头部的值。

约束限制:

取值范围:

默认取值:

代码示例

以下示例展示如何获取桶镜像回源规则配置:
#include "eSDKOBS.h"
#include <stdio.h>
#include <string.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_mirror_back_to_source_callback(obs_mirror_back_to_source_rule *mirror_back_to_source_rules_return,
    unsigned int rule_number, void *callback_data);
typedef struct MirrorBackInfo {
    unsigned int rule_count;
    obs_status ret_status;
} MirrorBackInfo;
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";
    obs_response_handler response_handler = {&response_properties_callback, &response_complete_callback};
    obs_get_bucket_mirror_back_to_source_handler get_mirror_handler = {
        response_handler,
        &get_mirror_back_to_source_callback
    };
    MirrorBackInfo mirror_info = {0};
    mirror_info.ret_status = OBS_STATUS_BUTT;
    get_bucket_mirror_back_to_source(&options, &get_mirror_handler, &mirror_info);
    if (OBS_STATUS_OK == mirror_info.ret_status) {
        printf("get bucket mirror back to source successfully. rule_count: %u\n", mirror_info.rule_count);
    } else {
        printf("get bucket mirror back to source failed(%s).\n", obs_get_status_name(mirror_info.ret_status));
    }
    obs_deinitialize();
}
obs_status get_mirror_back_to_source_callback(obs_mirror_back_to_source_rule *mirror_back_to_source_rules_return,
    unsigned int rule_number, void *callback_data)
{
    MirrorBackInfo *info = (MirrorBackInfo *)callback_data;
    info->rule_count = rule_number;
    if (mirror_back_to_source_rules_return) {
        unsigned int i;
        for (i = 0; i < rule_number; i++) {
            obs_mirror_back_to_source_rule *rule = &mirror_back_to_source_rules_return[i];
            printf("rule[%u]: id=%s, agency=%s\n",
                i,
                rule->id ? rule->id : "",
                rule->redirect.agency ? rule->redirect.agency : "");
        }
    }
    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) { ((MirrorBackInfo*)callback_data)->ret_status = status; }
    if (error && error->message) { printf("Error: %s\n", error->message); }
}

相关链接

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