other_response_handlers

response_handler

obs_response_handler *

必选

参数解释：

响应回调函数结构体。

约束限制：

无

取值范围：

无

默认取值：

无

listServiceCallback

obs_list_service_obs_callback *

必选

参数解释：

回调函数指针，可以在这个回调中把回调的参数记录到callback_data（用户自定义回调数据）中。

约束限制：

无

取值范围：

无

默认取值：

无

owner_id

const char *

必选

参数解释：

桶所有者的账号ID，即domain_id。

约束限制：

无

取值范围：

如何获取桶所有者的账号ID请参见如何获取账号ID和用户ID？

默认取值：

无

bucket_name

const char *

必选

参数解释：

桶名。

约束限制：

• 桶的名字需全局唯一，不能与已有的任何桶名称重复，包括其他用户创建的桶。
• 桶命名规则如下：
  • 3～63个字符，数字或字母开头，支持小写字母、数字、“-”、“.”。
  • 禁止使用IP地址。
  • 禁止以“-”或“.”开头及结尾。
  • 禁止两个“.”相邻（如：“my..bucket”）。
  • 禁止“.”和“-”相邻（如：“my-.bucket”和“my.-bucket”）。
• 同一用户在同一个区域多次创建同名桶不会报错，创建的桶属性以第一次请求为准。

默认取值：

无

creation_date_seconds

int64_t

必选

参数解释：

桶的创建时间。

约束限制：

无

取值范围：

无

默认取值：

无

location

const char *

必选

参数解释：

桶所在的区域。

约束限制：

该参数定义了桶将会被创建在哪个区域，如果使用的终端节点是obs.myhuaweicloud.com，可以不携带此参数；如果使用的终端节点不是obs.myhuaweicloud.com，则必须携带此参数。

取值范围：

当前有效的OBS区域和终端节点的更多信息，请参考地区和终端节点。终端节点即调用API的请求地址，不同服务不同区域的终端节点不同，您可以向企业管理员获取区域和终端节点信息。

默认取值：

终端节点为obs.myhuaweicloud.com且用户未设定区域时，默认为华北-北京一（cn-north-1）。

callback_data

void *

必选

参数解释：

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

约束限制：

无

取值范围：

无

默认取值：

无

response_handler

obs_response_handler *

必选

参数解释：

响应回调函数结构体。

约束限制：

无

取值范围：

无

默认取值：

无

get_bucket_storage_class_callback

obs_get_bucket_storage_policy_callback *

必选

参数解释：

回调函数指针，可以在这个回调中把回调的参数记录到callback_data（用户自定义回调数据）中。

约束限制：

无

取值范围：

无

默认取值：

无

storage_class_policy

const char *

必选

参数解释：

桶的存储类别。

约束限制：

无

取值范围：

无

默认取值：

无

callback_data

void *

必选

参数解释：

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

约束限制：

无

取值范围：

无

默认取值：

无

response_handler

obs_response_handler *

必选

参数解释：

响应回调函数结构体。

约束限制：

无

取值范围：

无

默认取值：

无

put_object_data_callback

obs_put_object_data_callback *

必选

参数解释：

回调函数指针，用于把要上传的数据复制到待上传的数据缓冲区。

约束限制：

无

取值范围：

无

默认取值：

无

progress_callback

obs_progress_callback_internal *

必选

参数解释：

进度回调函数指针。

约束限制：

无

取值范围：

无

默认取值：

无

buffer_size

int

必选

参数解释：

buffer的长度。

约束限制：

无

取值范围：

无

默认取值：

无

buffer

char *

必选

参数解释：

待上传的数据缓冲区，把要上传的数据复制到这个缓冲区。

约束限制：

无

取值范围：

无

默认取值：

无

callback_data

void *

必选

参数解释：

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

约束限制：

无

取值范围：

无

默认取值：

无

now

uint64_t

必选

参数解释：

已上传的字节数。

约束限制：

无

取值范围：

无

默认取值：

无

total

uint64_t

必选

参数解释：

总共需要上传的字节数。

约束限制：

无

取值范围：

无

默认取值：

无

callback_data

void *

必选

参数解释：

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

约束限制：

无

取值范围：

无

默认取值：

无

response_handler

obs_response_handler *

必选

参数解释：

响应回调函数结构体。

约束限制：

无

取值范围：

无

默认取值：

无

upload_file_callback

obs_upload_file_callback *

必选

参数解释：

回调函数指针，可以在这个回调中把回调的参数记录到callback_data（用户自定义回调数据）中。

约束限制：

无

取值范围：

无

默认取值：

无

progress_callback

obs_progress_callback *

必选

参数解释：

进度回调函数指针。

约束限制：

无

取值范围：

无

默认取值：

无

status

obs_status

必选

参数解释：

请求状态。

约束限制：

无

取值范围：

无

默认取值：

无

result_message

char *

必选

参数解释：

上传结果。

约束限制：

无

取值范围：

无

默认取值：

无

part_count_return

int

必选

参数解释：

段数。

约束限制：

无

取值范围：

无

默认取值：

无

upload_info_list

obs_upload_file_part_info *

必选

参数解释：

段信息。

约束限制：

无

取值范围：

无

默认取值：

无

callback_data

void *

必选

参数解释：

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

约束限制：

无

取值范围：

无

默认取值：

无

part_num

obs_response_handler *

必选

参数解释：

分段号。

约束限制：

无

取值范围：

无

默认取值：

无

start_byte

uint64_t

必选

参数解释：

分段起始位置。

约束限制：

无

取值范围：

无

默认取值：

无

part_size

uint64_t

必选

参数解释：

分段大小。

约束限制：

无

取值范围：

无

默认取值：

无

status_return

part_upload_status

必选

参数解释：

分段状态。

约束限制：

无

取值范围：

无

默认取值：

无

UPLOAD_NOTSTART

上传未开始。

UPLOADING

上传中。

UPLOAD_FAILED

上传失败。

UPLOAD_SUCCESS

上传成功。

STATUS_BUTT

默认的状态。

progress

double

必选

参数解释：

进度百分比。

约束限制：

无

取值范围：

无

默认取值：

无

uploadedSize

uint64_t

必选

参数解释：

已上传的字节数。

约束限制：

无

取值范围：

无

默认取值：

无

fileTotalSize

uint64_t

必选

参数解释：

总共需要上传的字节数。

约束限制：

无

取值范围：

无

默认取值：

无

callback_data

void *

必选

参数解释：

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

约束限制：

无

取值范围：

无

默认取值：

无

response_handler

obs_response_handler *

必选

参数解释：

响应回调函数结构体。

约束限制：

无

取值范围：

无

默认取值：

无

append_object_data_callback

obs_append_object_data_callback *

必选

参数解释：

回调函数指针，用于把要上传的数据复制到待上传的数据缓冲区。

约束限制：

无

取值范围：

无

默认取值：

无

buffer_size

int

必选

参数解释：

buffer的长度。

约束限制：

无

取值范围：

无

默认取值：

无

buffer

char *

必选

参数解释：

待上传的数据缓冲区，把要上传的数据复制到这个缓冲区。

约束限制：

无

取值范围：

无

默认取值：

无

callback_data

void *

必选

参数解释：

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

约束限制：

无

取值范围：

无

默认取值：

无

response_handler

obs_response_handler *

必选

参数解释：

响应回调函数结构体。

约束限制：

无

取值范围：

无

默认取值：

无

modify_object_data_callback

obs_modify_object_data_callback *

必选

参数解释：

回调函数指针，用于把要上传的数据复制到待上传的数据缓冲区。

约束限制：

无

取值范围：

无

默认取值：

无

buffer_size

int

必选

参数解释：

buffer的长度。

约束限制：

无

取值范围：

无

默认取值：

无

buffer

char *

必选

参数解释：

待上传的数据缓冲区，把要上传的数据复制到这个缓冲区。

约束限制：

无

取值范围：

无

默认取值：

无

callback_data

void *

必选

参数解释：

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

约束限制：

无

取值范围：

无

默认取值：

无

response_handler

obs_response_handler *

必选

参数解释：

响应回调函数结构体。

约束限制：

无

取值范围：

无

默认取值：

无

list_Objects_callback

obs_list_objects_callback *

必选

参数解释：

回调函数指针，用于把要上传的数据复制到待上传的数据缓冲区。

约束限制：

无

取值范围：

无

默认取值：

无

is_truncated

int

必选

参数解释：

结果是否截断。

约束限制：

无

取值范围：

• 0（代表已返回了全部结果）
• 1（代表没有返回全部结果）

默认取值：

无

next_marker

const char *

必选

参数解释：

下次列举对象请求的起始位置。如果本次没有返回全部结果，响应请求中将包含该元素，用于标明接下来请求的key_marker值。

约束限制：

该字段仅用于多版本列举。

取值范围：

长度大于0且不超过1024的字符串。

默认取值：

无

contents_count

const char *

必选

参数解释：

下次列举项请求的起始位置，与next_key_marker配合使用。如果本次没有返回全部结果，响应请求中将包含该元素，用于标明接下来请求的version_id_marker值。

约束限制：

该字段只适用于多版本列举场景。

取值范围：

长度为32的字符串。

默认取值：

无

contents

const obs_list_objects_content *

必选

参数解释：

列举出的对象相关信息。

约束限制：

无

取值范围：

无

默认取值：

无

common_prefixes_count

int

必选

参数解释：

common_prefixes的数量。

约束限制：

无

取值范围：

无

默认取值：

无

common_prefixes

const char **

必选

参数解释：

当请求中设置了delimiter分组字符时，返回按delimiter分组后的对象名称前缀列表。

约束限制：

无

取值范围：

长度大于0且不超过1024的字符串。

默认取值：

无

callback_data

void *

必选

参数解释：

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

约束限制：

无

取值范围：

无

默认取值：

无

key

const char *

可选

参数解释：

对象名。对象名是对象在存储桶中的唯一标识。对象名是对象在桶中的完整路径，路径中不包含桶名。

例如，您对象的访问地址为examplebucket.obs.cn-north-4.myhuaweicloud.com/folder/test.txt 中，对象名为folder/test.txt。

约束限制：

无

取值范围：

长度大于0且不超过1024的字符串。

默认取值：

无

last_modified

int64_t

可选

参数解释：

对象最近一次被修改的时间（UTC时间）。

约束限制：

无

取值范围：

长度大于0且不超过1024的字符串。

默认取值：

无

etag

const char *

可选

参数解释：

对象的base64编码的128位MD5摘要。ETag是对象内容的唯一标识，可以通过该值识别对象内容是否有变化。比如上传对象时ETag为A，下载对象时ETag为B，则说明对象内容发生了变化。实际的ETag是对象的哈希值。ETag只反映变化的内容，而不是其元数据。上传的对象或复制操作创建的对象，通过MD5加密后都有唯一的ETag。

约束限制：

无

取值范围：

长度为32的字符串。

默认取值：

无

size

uint64_t

可选

参数解释：

对象的字节数。

约束限制：

无

取值范围：

无

默认取值：

无

owner_id

const char *

可选

参数解释：

对象拥有者的domain_id（账号ID）。

约束限制：

无

取值范围：

无

默认取值：

无

storage_class

const char *

可选

参数解释：

对象的存储类别。

约束限制：

无

取值范围：

无

默认取值：

无

type

const char *

可选

参数解释：

对象类型，非Normal对象时返回。

约束限制：

无

取值范围：

无

默认取值：

无

response_handler

obs_response_handler *

必选

参数解释：

响应回调函数结构体。

约束限制：

无

取值范围：

无

默认取值：

无

get_access_label_callback_impl

get_access_label_callback*

必选

参数解释：

回调函数指针，可以在这个回调中把回调的参数记录到callback_data（用户自定义回调数据）中。

约束限制：

无

取值范围：

无

默认取值：

无

buffer_size

int

必选

参数解释：

buffer的长度。

约束限制：

无

取值范围：

无

默认取值：

无

buffer

char *

必选

参数解释：

待上传的数据缓冲区，把要上传的数据复制到这个缓冲区。

约束限制：

无

取值范围：

无

默认取值：

无

callback_data

void *

必选

参数解释：

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

约束限制：

无

取值范围：

无

默认取值：

无

response_handler

obs_response_handler *

必选

参数解释：

响应回调函数结构体。

约束限制：

无

取值范围：

无

默认取值：

无

get_bucket_website_conf_callback

obs_get_bucket_websiteconf_callback *

必选

参数解释：

回调函数指针，可以在这个回调中把回调的参数记录到callback_data（用户自定义回调数据）中。

约束限制：

无

取值范围：

无

默认取值：

无

hostname

const char *

必选

参数解释：

描述重定向的站点名。

约束限制：

无

取值范围：

无

默认取值：

无

protocol

const char *

必选

参数解释：

描述重定向请求时使用的协议（http，https），默认使用http协议。

约束限制：

无

取值范围：

无

默认取值：

无

suffix

const char *

必选

参数解释：

suffix元素被追加在对文件夹的请求的末尾，例如：suffix配置的是“index.html”，请求的是“samplebucket/images/”，返回的数据将是“samplebucket”桶内名为“images/index.html”的对象的内容。

约束限制：

suffix元素不能为空或者包含“/”字符。

取值范围：

无

默认取值：

无

key

const char *

必选

参数解释：

当4XX错误出现时使用的对象的名称。这个元素指定了当错误出现时返回的页面。

约束限制：

无

取值范围：

无

默认取值：

无

routingrule

const bucket_website_routingrule *

必选

参数解释：

重定向规则的具体描述。

约束限制：

无

取值范围：

无

默认取值：

无

callback_data

void *

必选

参数解释：

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

约束限制：

无

取值范围：

无

默认取值：

无

response_handler

obs_response_handler *

必选

参数解释：

响应回调函数结构体。

约束限制：

无

取值范围：

无

默认取值：

无

get_bucket_tagging_callback

obs_get_bucket_tagging_callback *

必选

参数解释：

标签回调函数指针，可以在这个回调中把tagging_count和tagging_list的内容记录到callback_data（用户自定义回调数据）中。

约束限制：

无

取值范围：

无

默认取值：

无

tagging_count

int

必选

参数解释：

标签列表中标签的数目。

约束限制：

无

取值范围：

无

默认取值：

无

tagging_list

obs_name_value *

必选

参数解释：

标签列表。

约束限制：

无

取值范围：

无

默认取值：

无

callback_data

void *

必选

参数解释：

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

约束限制：

无

取值范围：

无

默认取值：

无

response_handler

obs_response_handler *

必选

参数解释：

响应回调函数结构体。

约束限制：

无

取值范围：

无

默认取值：

无

get_cors_callback

get_cors_configuration_callback *

必选

参数解释：

标签回调函数指针，可以在这个回调中把CORS规则具体内容记录到callback_data（用户自定义回调数据）中。

约束限制：

无

取值范围：

无

默认取值：

无

bucket_cors_conf

obs_bucket_cors_conf *

必选

参数解释：

CORS规则具体内容。

约束限制：

无

取值范围：

无

默认取值：

无

bcc_number

unsigned int

必选

参数解释：

bucket_cors_conf的数量。

约束限制：

无

取值范围：

无

默认取值：

无

callback_data

void *

必选

参数解释：

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

约束限制：

无

取值范围：

无

默认取值：

无

response_handler

obs_response_handler *

必选

参数解释：

响应回调函数结构体。

约束限制：

无

取值范围：

无

默认取值：

无

get_lifecycle_callback

get_lifecycle_configuration_callback *

必选

参数解释：

回调函数指针，可以在这个回调中把桶生命周期规则的具体内容记录到callback_data（用户自定义回调数据）中。

约束限制：

无

取值范围：

无

默认取值：

无

bucket_lifecycle_conf

obs_lifecycle_conf *

必选

参数解释：

桶生命周期规则具体内容。

约束限制：

无

取值范围：

无

默认取值：

无

blcc_number

unsigned int

必选

参数解释：

bucket_lifecycle_conf的数量。

约束限制：

无

取值范围：

无

默认取值：

无

callback_data

void *

必选

参数解释：

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

约束限制：

无

取值范围：

无

默认取值：

无

response_handler

obs_response_handler *

必选

参数解释：

响应回调函数结构体。

约束限制：

无

取值范围：

无

默认取值：

无

list_versions_callback

obs_list_versions_callback *

必选

参数解释：

标签回调函数指针，可以在这个回调中把列举结果的具体内容记录到callback_data（用户自定义回调数据）中。

约束限制：

无

取值范围：

无

默认取值：

无

is_truncated

int

必选

参数解释：

返回的结果列表是否截断。

约束限制：

无

取值范围：

无

默认取值：

无

next_key_marker

const char *

必选

参数解释：

下次列举多版本对象请求的起始位置。如果本次没有返回全部结果，响应请求中将包含该元素，用于标明接下来请求的key_marker值。

约束限制：

该字段仅用于多版本列举。

取值范围：

长度大于0且不超过1024的字符串。

默认取值：

无

next_versionid_marker

const char *

必选

参数解释：

下次列举多版本对象请求的起始位置，与next_key_marker配合使用。如果本次没有返回全部结果，响应请求中将包含该元素，用于标明接下来请求的version_id_marker值。

约束限制：

该字段只适用于多版本列举场景。

取值范围：

长度为32的字符串。

默认取值：

无

versions

const obs_list_versions *

必选

参数解释：

列举出的多版本相关信息。

约束限制：

无

取值范围：

无

默认取值：

无

callback_data

void *

必选

参数解释：

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

约束限制：

无

取值范围：

无

默认取值：

无