对象相关接口(Python SDK)-华为云

对象存储服务 OBS-下载对象-二进制下载(Python SDK):接口约束

接口约束您必须是桶拥有者或拥有下载对象的权限，才能下载对象。建议使用IAM或桶策略进行授权，如果使用IAM则需授予obs:object:GetObject权限，如果使用桶策略则需授予GetObject权限。相关授权方式介绍可参见OBS权限控制概述，配置方式详见使用IAM自定义策略、配置对象策略。 OBS支持的Region与Endpoint的对应关系，详细信息请参见地区与终端节点。对于存储类别为归档存储的对象，需要确认对象的状态为“已恢复”才能对其进行下载。

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

对象存储服务 OBS-上传对象-断点续传上传(Python SDK):返回结果

返回结果表9 返回结果类型说明 GetResult 参数解释： SDK公共结果对象。表10 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时为空。该值根据调用接口的不同而不同，参见“桶相关接口”章节和“对象相关接口”章节的详细描述。默认取值：无表11 GetResult.body GetResult.body类型说明 CompleteMultipartUploadResponse 参数解释：合并段响应结果，参考CompleteMultipartUploadResponse。表12 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):接口约束

接口约束您必须是桶拥有者或拥有上传对象的权限，才能上传对象。建议使用IAM或桶策略进行授权，如果使用IAM则需授予obs:object:PutObject权限，如果使用桶策略则需授予PutObject权限。相关授权方式介绍可参见OBS权限控制概述，配置方式详见使用IAM自定义策略、配置对象策略。 OBS支持的Region与Endpoint的对应关系，详细信息请参见地区与终端节点。断点续传上传接口传入的文件大小至少要100K以上。使用SDK的断点续传接口时，必须开启断点续传选项后才能在进程再次进入时读取上一次上传的进度。

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

对象存储服务 OBS-上传对象-断点续传上传(Python SDK):功能说明

功能说明对分段上传的封装和加强，解决上传大文件时由于网络不稳定或程序崩溃导致上传失败的问题。其原理是将待上传的文件分成若干个分段分别上传，并实时地将每段上传结果统一记录在checkpoint文件中，仅当所有分段都上传成功时返回上传成功的结果，否则返回错误信息提醒用户再次调用接口进行重新上传（重新上传时因为有checkpoint文件记录当前的上传进度，避免重新上传所有分段，从而节省资源提高效率）。

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

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

返回结果表10 返回结果类型说明 GetResult 参数解释： SDK公共结果对象。表11 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时为空。该值根据调用接口的不同而不同，参见“桶相关接口”章节和“对象相关接口”章节的详细描述。默认取值：无表12 GetResult.body GetResult.body类型说明 AppendObjectResponse 参数解释：追加上传的响应结果，参考AppendObjectResponse。表13 AppendObjectResponse 参数名称参数类型描述 storageClass str 参数解释：对象的存储类型。取值范围：当对象存储类型是标准存储时，该值为空。可选择的存储类型参见StorageClass。默认取值：无 etag str 参数解释：对象的etag值，即base64编码的128位MD5摘要。etag是对象内容的唯一标识，可以通过该值识别对象内容是否有变化。比如上传对象时etag为A，下载对象时etag为B，则说明对象内容发生了变化。etag只反映变化的内容，而不是其元数据。上传的对象或拷贝操作创建的对象，都有唯一的etag。约束限制：当对象是服务端加密的对象时，etag值不是对象的MD5值。取值范围：长度为32的字符串。默认取值：无 nextPosition int 参数解释：下次追加上传的位置。取值范围：大于等于0的整型数，单位：字节。默认取值：无 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 参数解释：对象的全路径。默认取值：无

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

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

接口约束您必须是桶拥有者或拥有上传对象的权限，才能上传对象。建议使用IAM或桶策略进行授权，如果使用IAM则需授予obs:object:PutObject权限，如果使用桶策略则需授予PutObject权限。相关授权方式介绍可参见OBS权限控制概述，配置方式详见使用IAM自定义策略、配置对象策略。 OBS支持的Region与Endpoint的对应关系，详细信息请参见地区与终端节点。用户上传的对象存储在桶中。用户必须对桶有WRITE权限，才可以在桶中上传对象。同一个桶中存储的对象名必须是唯一的。每次追加上传都会更新该对象的最后修改时间。服务端加密SSE-C方式，那么追加上传和初始化段一样，设置诸如x-obs-server-side-encryption之类的请求Header，后续追加上传也必须携带。服务端加密SSE-KMS方式，有且只有第一次上传且桶内不存在同名对象时，才设置诸如x-obs-server-side-encryption之类的请求Header，后续追加上传不携带。每次追加上传的长度不能超过对象长度上限5G的限制。每个Appendable对象追加写次数最多为10000次。如果对象存储类型为COLD（归档存储），则不能调用该接口。如果桶设置了跨区域复制配置，则不能调用该接口。并行文件系统不支持追加写对象。

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

云服务器内容精选

对象相关接口(Python SDK)

7*24

备案

专业服务

退订

建议反馈

售前咨询热线