多段相关接口(Python SDK)-华为云

对象存储服务 OBS-分段上传-合并段(Python SDK):返回结果

返回结果表4 返回结果类型说明 GetResult 参数解释： SDK公共结果对象。表5 GetResult 参数名称参数类型描述 status int 参数解释： HTTP状态码。取值范围：状态码是一组从2xx（成功）到4xx或5xx（错误）的数字代码，状态码表示了请求响应的状态。完整的状态码列表请参见状态码。默认取值：无 reason str 参数解释： HTTP文本描述。默认取值：无 errorCode str 参数解释： OBS服务端错误码，当status参数小于300时为空。默认取值：无 errorMessage str 参数解释： OBS服务端错误描述，当status参数小于300时为空。默认取值：无 requestId str 参数解释： OBS服务端返回的请求ID。默认取值：无 indicator str 参数解释： OBS服务端返回的错误定位码。默认取值：无 hostId str 参数解释：请求的服务端ID，当status参数小于300时为空。默认取值：无 resource str 参数解释：发生错误时相关的桶或对象，当status参数小于300时为空。默认取值：无 header list 参数解释：响应消息头列表，由多个元组构成。每个元组均包含两个元素，代表响应头的键值对。默认取值：无 body object 参数解释：操作成功后的结果数据，当status大于300时为空。该值根据调用接口的不同而不同，参见“桶相关接口”章节和“对象相关接口”章节的详细描述。默认取值：无表6 GetResult.body GetResult.body类型说明 CompleteMultipartUploadResponse 参数解释：合并段响应结果。详见CompleteMultipartUploadResponse。表7 CompleteMultipartUploadResponse 参数名称参数类型描述 etag str 参数解释：合并段后根据各个段的ETag值计算出的结果。参数解释：对象的ETag值，即base64编码的128位MD5摘要。ETag是对象内容的唯一标识，可以通过该值识别对象内容是否有变化。比如上传对象时ETag为A，下载对象时ETag为B，则说明对象内容发生了变化。ETag只反映变化的内容，而不是其元数据。上传的对象或拷贝操作创建的对象，都有唯一的ETag。约束限制：当对象是服务端加密的对象时，ETag值不是对象的MD5值。取值范围：长度为32的字符串。默认取值：无 bucket str 参数解释：合并段所在的桶的桶名。约束限制：桶的名字需全局唯一，不能与已有的任何桶名称重复，包括其他用户创建的桶。桶命名规则如下： 3～63个字符，数字或字母开头，支持小写字母、数字、“-”、“.”。禁止使用IP地址。禁止以“-”或“.”开头及结尾。禁止两个“.”相邻（如：“my..bucket”）。禁止“.”和“-”相邻（如：“my-.bucket”和“my.-bucket”）。同一用户在同一个区域多次创建同名桶不会报错，创建的桶属性以第一次请求为准。默认取值：无 key str 参数解释：合并段后得到的对象名。对象名是对象在存储桶中的唯一标识。对象名是对象在桶中的完整路径，路径中不包含桶名。例如，您对象的访问地址为examplebucket.obs.cn-north-4.myhuaweicloud.com/folder/test.txt 中，对象名为folder/test.txt。取值范围：长度大于0且不超过1024的字符串。默认取值：无 location str 参数解释：合并段后得到的对象的url。例如：https://example-Bucket.obs.regions.myhuaweicloud.com/example-Object 默认取值：无 versionId str 参数解释：合并段后得到的对象版本号。取值范围：长度为32的字符串。默认取值：无 sseKms str 参数解释： SSE-KMS方式的算法。取值范围： kms，即以SSE-KMS方式加密对象。默认取值：无 sseKmsKey str 参数解释： SSE-KMS加密方式下使用的KMS主密钥的ID值。取值范围：有效值支持两种格式： regionID:domainID(账号ID):key/key_id key_id 其中： regionID是使用密钥所属region的ID，可在地区和终端节点页面获取； domainID是使用密钥所属账号的账号ID，获取方法参见如何获取账号ID和用户ID?(Python SDK)； key_id是从数据加密服务创建的密钥ID，获取方法请参见查看密钥。默认取值：如果用户没有提供该头域，那么默认的主密钥将会被使用。如果默认主密钥不存在，将默认创建并使用。 sseC str 参数解释： SSE-C方式的算法。取值范围： AES256。默认取值：无 sseCKeyMd5 str 参数解释： SSE-C方式下加密使用密钥的MD5值，该值用于验证密钥传输过程中是否出错。约束限制：由密钥值经过MD5加密再经过Base64编码后得到，示例：4XvB3tbNTN+tIEVa0/fGaQ== 默认取值：无 objectUrl str 参数解释：合并段后得到的对象的全路径。默认取值：无 encoding_type str 参数解释：用于指定对响应中的Key进行指定类型的编码。如果Key包含xml 1.0标准不支持的控制字符，可通过设置该参数对响应中的Key进行编码。取值范围：可选值为url。默认取值：无，不设置则不编码。

对象存储服务 OBS 多段相关接口(Python SDK)

对象存储服务 OBS-分段上传-合并段(Python SDK):功能说明

功能说明如果用户上传完所有的段，就可以调用合并段接口，系统将在服务端将用户指定的段合并成一个完整的对象。在执行“合并段”操作以前，用户不能下载已经上传的数据。在合并段时需要将多段上传任务初始化时记录的附加消息头信息拷贝到对象元数据中，其处理过程和普通上传对象带这些消息头的处理过程相同。在并发合并段的情况下，仍然遵循Last Write Win策略，但“Last Write”的时间定义为段任务的初始化时间。已经上传的段，只要没有取消对应的多段上传任务，都要占用用户的容量配额；对应的多段上传任务“合并段”操作完成后，只有指定的多段数据占用容量配额，用户上传的其他此多段任务对应的段数据如果没有包含在“合并段”操作指定的段列表中，“合并段”完成后系统将删除多余的段数据，且同时释放容量配额。合并段时，OBS通过按升序的段编号规范化多段来创建对象。如果在初始化上传段任务中提供了任何对象元数据，则OBS会将该元数据与对象相关联。成功完成请求后，段将不再存在。合并段请求必须包括上传ID以及段编号和相应的ETag值的列表。OBS响应包括可唯一地识别组合对象数据的ETag。此ETag无需成为对象数据的MD5哈希。

对象存储服务 OBS 多段相关接口(Python SDK)

对象存储服务 OBS-分段上传-合并段(Python SDK):接口约束

接口约束您必须是桶拥有者或拥有合并段的权限，才能合并段。建议使用 IAM 或桶策略进行授权，如果使用IAM则需授予obs:object:PutObject权限，如果使用桶策略则需授予PutObject权限。相关授权方式介绍可参见OBS权限控制概述，配置方式详见使用IAM自定义策略、配置对象策略。 OBS支持的Region与Endpoint的对应关系，详细信息请参见地区与终端节点。如果上传了10个段，但合并时只选择了9个段进行合并，那么未被合并的段将会被系统自动删除，未被合并的段删除后不能恢复。在进行合并之前请使用列出已上传的段接口进行查询，仔细核对所有段，确保没有段被遗漏。

对象存储服务 OBS 多段相关接口(Python SDK)

对象存储服务 OBS-分段上传-合并段(Python SDK):请求参数

请求参数表1 请求参数列表参数名称参数类型是否必选描述 bucketName str 必选参数解释：桶名。约束限制：桶的名字需全局唯一，不能与已有的任何桶名称重复，包括其他用户创建的桶。桶命名规则如下： 3～63个字符，数字或字母开头，支持小写字母、数字、“-”、“.”。禁止使用IP地址。禁止以“-”或“.”开头及结尾。禁止两个“.”相邻（如：“my..bucket”）。禁止“.”和“-”相邻（如：“my-.bucket”和“my.-bucket”）。同一用户在同一个区域多次创建同名桶不会报错，创建的桶属性以第一次请求为准。默认取值：无 objectKey str 必选参数解释：对象名。对象名是对象在存储桶中的唯一标识。对象名是对象在桶中的完整路径，路径中不包含桶名。例如，您对象的访问地址为examplebucket.obs.cn-north-4.myhuaweicloud.com/folder/test.txt 中，对象名为folder/test.txt。取值范围：长度大于0且不超过1024的字符串。默认取值：无说明：对象链接地址格式为：https://桶名. 域名 /文件夹目录层级/对象名。如果该对象存在于桶的根目录下，则链接地址将不需要有文件夹目录层级。 uploadId str 必选参数解释：分段上传任务的ID，例如：000001648453845DBB78F2340DD460D8 取值范围：长度为32的字符串。默认取值：无 completeMultipartUploadRequest CompleteMultipartUploadRequest 必选参数解释：合并段请求参数。详见CompleteMultipartUploadRequest。 encoding_type str 可选参数解释：对响应中的key进行指定类型的编码。如果key包含xml 1.0标准不支持的控制字符，可通过设置该参数对响应中的key进行编码。取值范围：可选值为url。默认取值：无，不设置则不编码。表2 CompleteMultipartUploadRequest 参数名称参数类型是否必选描述 parts list of CompletePart 必选参数解释：待合并的段列表。详见CompletePart。表3 CompletePart 参数名称参数类型是否必选描述 partNum int 必选参数解释：段号。取值范围： [1,10000] 默认取值：无 etag str 必选参数解释：段的ETag值。分段的base64编码的128位MD5摘要。取值范围：长度为32的字符串。默认取值：无

对象存储服务 OBS 多段相关接口(Python SDK)

对象存储服务 OBS-分段上传-上传段(Python SDK):返回结果

返回结果表3 返回结果类型说明 GetResult 参数解释： SDK公共结果对象。表4 GetResult 参数名称参数类型描述 status int 参数解释： HTTP状态码。取值范围：状态码是一组从2xx（成功）到4xx或5xx（错误）的数字代码，状态码表示了请求响应的状态。完整的状态码列表请参见状态码。默认取值：无 reason str 参数解释： HTTP文本描述。默认取值：无 errorCode str 参数解释： OBS服务端错误码，当status参数小于300时为空。默认取值：无 errorMessage str 参数解释： OBS服务端错误描述，当status参数小于300时为空。默认取值：无 requestId str 参数解释： OBS服务端返回的请求ID。默认取值：无 indicator str 参数解释： OBS服务端返回的错误定位码。默认取值：无 hostId str 参数解释：请求的服务端ID，当status参数小于300时为空。默认取值：无 resource str 参数解释：发生错误时相关的桶或对象，当status参数小于300时为空。默认取值：无 header list 参数解释：响应消息头列表，由多个元组构成。每个元组均包含两个元素，代表响应头的键值对。默认取值：无 body object 参数解释：操作成功后的结果数据，当status大于300时为空。该值根据调用接口的不同而不同，参见“桶相关接口”章节和“对象相关接口”章节的详细描述。默认取值：无表5 GetResult.body GetResult.body类型说明 UploadPartResponse 参数解释：上传段响应结果。表6 UploadPartResponse 参数名称参数类型描述 etag str 参数解释：段的base64编码的128位MD5摘要。ETag是段内容的唯一标识，可以通过该值识别段内容是否有变化。取值范围：长度为32的字符串。默认取值：无 sseKms str 参数解释：表示服务端加密是SSE-KMS方式。对象使用SSE-KMS方式加密。取值范围：可选值：kms，即选择SSE-KMS方式加密对象。默认取值：无 sseKmsKey str 参数解释： SSE-KMS加密方式下使用的KMS主密钥的ID值。取值范围：有效值支持两种格式： regionID:domainID(账号ID):key/key_id key_id 其中： regionID是使用密钥所属region的ID，可在地区和终端节点页面获取； domainID是使用密钥所属账号的账号ID，获取方法参见如何获取账号ID和用户ID?(Python SDK)； key_id是从数据加密服务创建的密钥ID，获取方法请参见查看密钥。默认取值：如果用户没有提供该头域，那么默认的主密钥将会被使用。如果默认主密钥不存在，将默认创建并使用。 sseC str 参数解释：使用SSE-C方式加解密对象时，选择的加解密算法。取值范围：支持的值为AES256，即高级加密标准（Advanced Encryption Standard，AES）。默认取值：无 sseCKeyMd5 str 参数解释： SSE-C方式下加密使用密钥的MD5值，该值用于验证密钥传输过程中是否出错。约束限制：由密钥值经过MD5加密再经过Base64编码后得到，示例：4XvB3tbNTN+tIEVa0/fGaQ== 默认取值：无

对象存储服务 OBS 多段相关接口(Python SDK)

对象存储服务 OBS-分段上传-上传段(Python SDK):接口约束

接口约束您必须是桶拥有者或拥有上传段的权限，才能上传段。建议使用IAM或桶策略进行授权，如果使用IAM则需授予obs:object:PutObject权限，如果使用桶策略则需授予PutObject权限。相关授权方式介绍可参见OBS权限控制概述，配置方式详见使用IAM自定义策略、配置对象策略。 OBS支持的Region与Endpoint的对应关系，详细信息请参见地区与终端节点。初始化上传段任务并上传一个或多个段之后，您必须合并段或取消多段上传任务，才能停止收取已上传的段的存储费用。仅当在合并段或取消多段上传任务之后，OBS才释放段存储并停止向您收取段存储费用。段任务中的partNumber是唯一的，重复上传相同partNumber的段，后一次上传会覆盖前一次上传内容。多并发上传同一对象的同一partNumber时，服务端遵循Last Write Win策略，但“Last Write”的时间定义为段元数据创建时间。为了保证数据准确性，客户端需要加锁保证同一对象的同一个段上传的并发性。同一对象的不同段并发上传不需要加锁。

对象存储服务 OBS 多段相关接口(Python SDK)

对象存储服务 OBS-分段上传-上传段(Python SDK):请求参数

请求参数表1 请求参数列表参数名称参数类型是否必选描述 bucketName str 必选参数解释：桶名。约束限制：桶的名字需全局唯一，不能与已有的任何桶名称重复，包括其他用户创建的桶。桶命名规则如下： 3～63个字符，数字或字母开头，支持小写字母、数字、“-”、“.”。禁止使用IP地址。禁止以“-”或“.”开头及结尾。禁止两个“.”相邻（如：“my..bucket”）。禁止“.”和“-”相邻（如：“my-.bucket”和“my.-bucket”）。同一用户在同一个区域多次创建同名桶不会报错，创建的桶属性以第一次请求为准。默认取值：无 objectKey str 必选参数解释：对象名。对象名是对象在存储桶中的唯一标识。对象名是对象在桶中的完整路径，路径中不包含桶名。例如，您对象的访问地址为examplebucket.obs.cn-north-4.myhuaweicloud.com/folder/test.txt 中，对象名为folder/test.txt。取值范围：长度大于0且不超过1024的字符串。默认取值：无说明：对象链接地址格式为：https://桶名.域名/文件夹目录层级/对象名。如果该对象存在于桶的根目录下，则链接地址将不需要有文件夹目录层级。 partNumber int 必选参数解释：段号。取值范围： [1,10000] 默认取值：无 uploadId str 必选参数解释：分段上传任务的ID。任务ID可以通过初始化分段上传任务生成。例如：000001648453845DBB78F2340DD460D8。约束限制：长度为32的字符串。默认取值：无 object str 或 readable object 必选参数解释：待上传段的内容。取值范围：字符串或者可读对象。说明：如果object是可读对象（包含“read”属性），则从中读取数据，否则作为字符串处理。默认取值：无 isFile bool 可选参数解释：指明object字段是否代表文件路径。取值范围： True：object字段代表文件路径。 False：object字段不代表文件路径。默认取值： False offset int 可选参数解释：源文件中某一分段的起始偏移大小。取值范围：非负整数，不大于待上传对象的大小，单位：字节。默认取值： 0 partSize int 可选参数解释：当前段的长度。取值范围： 100KB~5GB，单位：字节。默认取值： 102400字节 sseHeader SseCHeader 可选参数解释：服务端加密头域。详见SseCHeader。默认取值：无 isAttachMd5 bool 可选参数解释：是否自动计算待上传数据的MD5值。约束限制： isAttachMd5和md5同时使用时，忽略isAttachMd5字段。取值范围： True：自动计算上传数据的MD5值。 False：不自动计算上传数据的MD5值。默认取值： False md5 str 可选参数解释：待上传段数据的MD5值（经过Base64编码），是上传段数据内容的唯一标识，可以通过该值识别对象内容是否有变化。约束限制： isAttachMd5和md5同时使用时，忽略isAttachMd5字段。取值范围：长度为32的字符串。默认取值：无 progressCallback callable 可选参数解释：获取上传进度的回调函数。默认取值：无说明：该回调函数依次包含三个参数：已上传的字节数、总字节数、已使用的时间（单位：秒）。 autoClose bool 可选参数解释：上传完成后，自动关闭数据流。取值范围： True：自动关闭数据流。 False：不自动关闭数据流。默认取值： True 表2 SseCHeader 参数名称参数类型是否必选描述 encryption str 必选参数解释：以SSE-C方式加密对象。取值范围： AES256，即高级加密标准（Advanced Encryption Standard，AES）。默认取值：无 key str 必选参数解释： SSE-C方式下加密的密钥，与加密方式对应，如encryption=‘AES256’，name密钥就是由AES256加密算法得到的密钥。取值范围：长度为32字符串。默认取值：无

对象存储服务 OBS 多段相关接口(Python SDK)

对象存储服务 OBS-分段上传-上传段(Python SDK):功能说明

功能说明初始化分段上传任务后，通过分段上传任务的ID，上传段到指定桶中。除了最后一段以外，其他段的大小范围是100KB~5GB；最后一段的大小范围是0~5GB。上传的段的编号也有范围限制，其范围是1~10000。上传段时，除了指定上传ID，还必须指定段编号。您可以选择1和10000之间的任意段编号。段编号在您正在上传的对象中唯一地标示了段及其位置。如果您使用之前上传的段的同一段编号上传新段，则之前上传的段将被覆盖。无论您何时上传段，OBS都将在其响应中返回ETag标头。对于每个段上传任务，您必须记录每个段编号和ETag值。您在随后的请求中需要添加这些值以完成多段上传。

对象存储服务 OBS 多段相关接口(Python SDK)

云服务器内容精选

多段相关接口(Python SDK)

7*24

备案

专业服务

退订

建议反馈

售前咨询热线