华为云对象存储OBS上传对象-基于表单上传(Python SDK)_云淘科技

功能说明

基于表单上传是使用HTML表单形式上传对象到指定桶中,对象最大不能超过5GB。可以通过ObsClient.createPostSignature生成基于表单上传的请求参数。使用代码模拟表单上传的完整代码示例,参见post_object_sample。您也可以通过如下步骤进行表单上传:

使用ObsClient.createPostSignature生成用于鉴权的请求参数。
准备表单HTML页面。
将生成的请求参数填入HTML页面。
选择本地文件,进行表单上传。

使用SDK生成用于鉴权的请求参数包括两个:

policy,对应表单中policy字段。
signature,对应表单中的signature字段。

接口约束

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

HTML表单中的policy,signature的值均是从ObsClient.createPostSignature的返回结果中获取。您可以直接下载表单HTML示例PostDemo。

方法定义

ObsClient.createPostSignature(bucketName, objectKey, expires, formParams)

请求参数

表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的字符串。

默认取值:

expires

int

可选

参数解释:

表单上传鉴权的过期时间。

取值范围:

正整数。单位:秒。

默认取值:

300

formParams

dict

可选

参数解释:

除key,policy,signature外,表单上传时的其他参数

取值范围:

(注:以下值使用时,需要添加x-obs的前缀,以acl为例,formParams[‘x-obs-acl’]=’public-read’,各值的取值范围请参照API中响应头域的介绍)

acl
cache-control
content-type
content-disposition
content-encoding
expires

默认取值:

返回结果

表2 返回结果

参数名称

参数类型

描述

originPolicy

str

参数解释:

Policy未经过base64编码之前的值,仅用于校验。示例如下:

{“expiration”:”2023-09-12T12:52:59Z”,”conditions”:[{“content-type”:”text/plain”},{“bucket”:”examplebucket”},{“key”:”example/objectname”},]}”

默认取值:

policy

str

参数解释:

表单中的policy经过base64编码之后的值。示例如下:

eyJleHBpcmF0aW9uIjoiMjAyMy0wOS0xMlQxMjo1Mjo1OVoiLCJjb25kaXRpb25zIjpbeyJjb250ZW50LXR5cGUiOiJ0ZXh0L3BsYWluIn0seyJidWNrZXQiOiJleGFtcGxlYnVja2V0In0seyJrZXkiOiJleGFtcGxlL29iamVjdG5hbWUifSxdfQ==

默认取值:

signature

str

参数解释:

表单中的signature。示例如下:

g0jQr4v9VWd1Q2FOFDG6LGfV9Cw=

默认取值:

代码样例

此用例用于生成带授权信息的表单上传参数policy和signature。

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
from obs import ObsClient
import os
import traceback

# 推荐通过环境变量获取AKSK,这里也可以使用其他外部引入方式传入,如果使用硬编码可能会存在泄露风险。
# 您可以登录访问管理控制台获取访问密钥AK/SK,获取方式请参见https://support.huaweicloud.com/usermanual-ca/ca_01_0003.html。
ak = os.getenv("AccessKeyID")
sk = os.getenv("SecretAccessKey")
# 【可选】如果使用临时AKSK和SecurityToken访问OBS,则同样推荐通过环境变量获取
security_token = os.getenv("SecurityToken")
#  server填写Bucket对应的Endpoint, 这里以华北-北京四为例,其他地区请按实际情况填写。
server = "https://obs.cn-north-4.myhuaweicloud.com"
# 创建obsClient实例
# 如果使用临时AKSK和SecurityToken访问OBS,需要在创建实例时通过security_token参数指定securityToken值
obsClient = ObsClient(access_key_id=ak, secret_access_key=sk, server=server)
try:
    bucketName = "examplebucket"
    objectKey = "objectname"
    # 设置表单上传请求有效期,单位:秒,此处以3600秒为例
    expires = 3600
    # 除key,policy,signature外,表单上传时的其他参数,此处设置acl为私有、content-type为text/plain
    formParams = {'x-obs-acl': 'private', 'content-type': 'text/plain'}
    # 生成带授权信息的表单上传参数
    resp = obsClient.createPostSignature(bucketName, objectKey, expires, formParams)

    print('originPolicy:', resp.originPolicy)
    print('policy:', resp.policy)
    print('signature:', resp.signature)
except:
    print(traceback.format_exc())

示例表单HTML代码如下:

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
    
        
    
    
        
            

Object key

ACL

Content-Type

HTML表单中的policy,signature的值均是从ObsClient.createPostSignature的返回结果中获取。
您可以直接下载表单HTML示例PostDemo。

相关链接

关于上传对象-POST上传的API说明,请参见POST上传。
更多关于上传对象的示例代码,请参见Github示例。
上传对象过程中返回的错误码含义、问题原因及处理措施可参考OBS错误码。
上传对象常见问题请参见上传对象失败。

父主题: 对象相关接口

同意关联代理商云淘科技,购买华为云产品更优惠(QQ 78315851)

内容没看懂? 不太想学习?想快速解决? 有偿解决: 联系专家