网络
虚拟私有云 VPC
弹性公网IP EIP
弹性负载均衡 ELB
NAT网关 NAT
云专线 DC
虚拟专用网络 VPN
云连接 CC
VPC终端节点 VPCEP
企业路由器 ER
企业交换机 ESW
全球加速 GA
企业连接 EC
云原生应用网络 ANC
安全与合规
安全技术与应用
Web应用防火墙 WAF
企业主机安全 HSS
云防火墙 CFW
安全云脑 SecMaster
DDoS防护 AAD
数据加密服务 DEW
数据库安全服务 DBSS
云堡垒机 CBH
数据安全中心 DSC
云证书管理服务 CCM
威胁检测服务 MTD
态势感知 SA
认证测试中心 CTC
边缘安全 EdgeSec
应用中间件
微服务引擎 CSE
分布式消息服务Kafka版
分布式消息服务RabbitMQ版
分布式消息服务RocketMQ版
API网关 APIG
分布式缓存服务 DCS
多活高可用服务 MAS
事件网格 EG
管理与监管
统一身份认证服务 IAM
消息通知服务 SMN
云监控服务 CES
应用运维管理 AOM
应用性能管理 APM
云日志服务 LTS
云审计服务 CTS
标签管理服务 TMS
配置审计 Config
应用身份管理服务 OneAccess
资源访问管理 RAM
组织 Organizations
资源编排服务 RFS
优化顾问 OA
IAM 身份中心
云运维中心 COC
资源治理中心 RGC
解决方案
高性能计算 HPC
SAP
混合云灾备
开天工业工作台 MIW
Haydn解决方案工厂
数字化诊断治理专家服务
云生态
云商店
合作伙伴中心
华为云开发者学堂
华为云慧通差旅
开发与运维
软件开发生产线 CodeArts
需求管理 CodeArts Req
流水线 CodeArts Pipeline
代码检查 CodeArts Check
编译构建 CodeArts Build
部署 CodeArts Deploy
测试计划 CodeArts TestPlan
制品仓库 CodeArts Artifact
移动应用测试 MobileAPPTest
CodeArts IDE Online
开源镜像站 Mirrors
性能测试 CodeArts PerfTest
应用管理与运维平台 ServiceStage
云应用引擎 CAE
开源治理服务 CodeArts Governance
华为云Astro轻应用
CodeArts IDE
Astro工作流 AstroFlow
代码托管 CodeArts Repo
漏洞管理服务 CodeArts Inspector
联接 CodeArtsLink
软件建模 CodeArts Modeling
Astro企业应用 AstroPro
CodeArts盘古助手
华为云Astro大屏应用
计算
弹性云服务器 ECS
Flexus云服务
裸金属服务器 BMS
云手机服务器 CPH
专属主机 DeH
弹性伸缩 AS
镜像服务 IMS
函数工作流 FunctionGraph
云耀云服务器(旧版)
VR云渲游平台 CVR
Huawei Cloud EulerOS
云化数据中心 CloudDC
网络
虚拟私有云 VPC
弹性公网IP EIP
弹性负载均衡 ELB
NAT网关 NAT
云专线 DC
虚拟专用网络 VPN
云连接 CC
VPC终端节点 VPCEP
企业路由器 ER
企业交换机 ESW
全球加速 GA
企业连接 EC
云原生应用网络 ANC
CDN与智能边缘
内容分发网络 CDN
智能边缘云 IEC
智能边缘平台 IEF
CloudPond云服务
安全与合规
安全技术与应用
Web应用防火墙 WAF
企业主机安全 HSS
云防火墙 CFW
安全云脑 SecMaster
DDoS防护 AAD
数据加密服务 DEW
数据库安全服务 DBSS
云堡垒机 CBH
数据安全中心 DSC
云证书管理服务 CCM
威胁检测服务 MTD
态势感知 SA
认证测试中心 CTC
边缘安全 EdgeSec
大数据
MapReduce服务 MRS
数据湖探索 DLI
表格存储服务 CloudTable
可信智能计算服务 TICS
推荐系统 RES
云搜索服务 CSS
数据可视化 DLV
数据接入服务 DIS
数据仓库服务 GaussDB(DWS)
数据治理中心 DataArts Studio
湖仓构建 LakeFormation
智能数据洞察 DataArts Insight
应用中间件
微服务引擎 CSE
分布式消息服务Kafka版
分布式消息服务RabbitMQ版
分布式消息服务RocketMQ版
API网关 APIG
分布式缓存服务 DCS
多活高可用服务 MAS
事件网格 EG
开天aPaaS
应用平台 AppStage
开天企业工作台 MSSE
开天集成工作台 MSSI
API中心 API Hub
云消息服务 KooMessage
交换数据空间 EDS
云地图服务 KooMap
云手机服务 KooPhone
组织成员账号 OrgID
云空间服务 KooDrive
管理与监管
统一身份认证服务 IAM
消息通知服务 SMN
云监控服务 CES
应用运维管理 AOM
应用性能管理 APM
云日志服务 LTS
云审计服务 CTS
标签管理服务 TMS
配置审计 Config
应用身份管理服务 OneAccess
资源访问管理 RAM
组织 Organizations
资源编排服务 RFS
优化顾问 OA
IAM 身份中心
云运维中心 COC
资源治理中心 RGC
区块链
区块链服务 BCS
数字资产链 DAC
华为云区块链引擎服务 HBS
解决方案
高性能计算 HPC
SAP
混合云灾备
开天工业工作台 MIW
Haydn解决方案工厂
数字化诊断治理专家服务
价格
成本优化最佳实践
专属云商业逻辑
云生态
云商店
合作伙伴中心
华为云开发者学堂
华为云慧通差旅
其他
管理控制台
消息中心
产品价格详情
系统权限
客户关联华为云合作伙伴须知
公共问题
宽限期保留期
奖励推广计划
活动
云服务信任体系能力说明
开发与运维
软件开发生产线 CodeArts
需求管理 CodeArts Req
流水线 CodeArts Pipeline
代码检查 CodeArts Check
编译构建 CodeArts Build
部署 CodeArts Deploy
测试计划 CodeArts TestPlan
制品仓库 CodeArts Artifact
移动应用测试 MobileAPPTest
CodeArts IDE Online
开源镜像站 Mirrors
性能测试 CodeArts PerfTest
应用管理与运维平台 ServiceStage
云应用引擎 CAE
开源治理服务 CodeArts Governance
华为云Astro轻应用
CodeArts IDE
Astro工作流 AstroFlow
代码托管 CodeArts Repo
漏洞管理服务 CodeArts Inspector
联接 CodeArtsLink
软件建模 CodeArts Modeling
Astro企业应用 AstroPro
CodeArts盘古助手
华为云Astro大屏应用
存储
对象存储服务 OBS
云硬盘 EVS
云备份 CBR
高性能弹性文件服务 SFS Turbo
弹性文件服务 SFS
存储容灾服务 SDRS
云硬盘备份 VBS
云服务器备份 CSBS
数据快递服务 DES
云存储网关 CSG
专属分布式存储服务 DSS
数据工坊 DWR
地图数据 MapDS
键值存储服务 KVS
容器
云容器引擎 CCE
云容器实例 CCI
容器镜像服务 SWR
云原生服务中心 OSC
应用服务网格 ASM
华为云UCS
数据库
云数据库 RDS
数据复制服务 DRS
文档数据库服务 DDS
分布式数据库中间件 DDM
云数据库 GaussDB
云数据库 GeminiDB
数据管理服务 DAS
数据库和应用迁移 UGO
云数据库 TaurusDB
人工智能
AI开发平台ModelArts
华为HiLens
图引擎服务 GES
图像识别 Image
文字识别 OCR
自然语言处理 NLP
内容审核 Moderation
图像搜索 ImageSearch
医疗智能体 EIHealth
企业级AI应用开发专业套件 ModelArts Pro
人脸识别服务 FRS
对话机器人服务 CBS
语音交互服务 SIS
人证核身服务 IVS
视频智能分析服务 VIAS
城市智能体
自动驾驶云服务 Octopus
盘古大模型 PanguLargeModels
IoT物联网
设备接入 IoTDA
全球SIM联接 GSL
IoT数据分析 IoTA
路网数字化服务 DRIS
IoT边缘 IoTEdge
设备发放 IoTDP
企业应用
域名注册服务 Domains
云解析服务 DNS
企业门户 EWP
ICP备案
商标注册
华为云WeLink
华为云会议 Meeting
隐私保护通话 PrivateNumber
语音通话 VoiceCall
消息&短信 MSGSMS
云管理网络
SD-WAN 云服务
边缘数据中心管理 EDCM
云桌面 Workspace
应用与数据集成平台 ROMA Connect
ROMA资产中心 ROMA Exchange
API全生命周期管理 ROMA API
政企自服务管理 ESM
视频
实时音视频 SparkRTC
视频直播 Live
视频点播 VOD
媒体处理 MPC
视频接入服务 VIS
数字内容生产线 MetaStudio
迁移
主机迁移服务 SMS
对象存储迁移服务 OMS
云数据迁移 CDM
迁移中心 MGC
专属云
专属计算集群 DCC
开发者工具
SDK开发指南
API签名指南
DevStar
华为云命令行工具服务 KooCLI
Huawei Cloud Toolkit
CodeArts API
云化转型
云架构中心
云采用框架
用户服务
账号中心
费用中心
成本中心
资源中心
企业管理
工单管理
客户运营能力
国际站常见问题
支持计划
专业服务
合作伙伴支持计划
我的凭证
华为云公共事业服务云平台
工业软件
工业数字模型驱动引擎
硬件开发工具链平台云服务
工业数据转换引擎云服务

回调

更新时间:2024-10-21 GMT+08:00
分享

功能介绍

用户可以在上传对象请求中设置回调参数,OBS在对象上传成功之后,将上传结果回调特定服务器,并将回调结果返回给用户。

说明:

目前只在POST上传对象、PUT上传对象以及多段操作中的合并段API中支持回调功能。

在对象上传成功之后才会回调特定服务器,如果对象上传失败则不会回调。

回调成功,返回回调结果给客户端,同时将上传对象的Etag以头域返回,当回调结果也包含Etag时,将对Etag拼接后返回。

回调失败,返回203,表示对象上传成功但是回调失败。

如果上传的图片大小超过25M,则无法通过imageInfo相关魔法变量获取图片基本信息,会导致回调失败。

POST上传对象API中,回调参数可以在表单中携带,也可以在policy中携带。两者只能选择其一。

如果在表单中携带,每个回调参数都需要增加一个表单元素,回调参数可以不做条件校验,即不需要在policy的conditions中增加回调参数。这种方式支持在回调消息体中使用用户自定义变量,自定义变量通过“x:”前缀携带。

如果通过policy携带,则不需要增加表单元素。但是不支持用户自定义变量,仅能使用系统变量。

通过表单携带的回调参数如表1所示。

表1 表单回调参数

参数名称

描述

是否必选

callbackUrl

对象上传成功之后,OBS向此url发送回调请求,请求方法为POST。

支持设置多个url,以英文分号(;)分隔,最多支持10个。

callbackUrl需要做url编码。例如:“http://www.example.com/中文?key=中文名”需要编码成“http://www.example.com/%E4%B8%AD%E6%96%87?key=%E4%B8%AD%E6%96%87%E5%90%8D”。

类型:String

callbackHost

发起回调请求的Host头域的值,如果不设置,会使用callbackUrl解析出来的Host。

类型:String

callbackBody

发起回调请求的body体。body体格式必须符合callbackBodyType中设置的媒体类型。

回调body体支持系统变量和自定义变量,系统变量如表3所示,自定义变量就是以x:开头的变量。例如:key=$(key)&hash=$(etag)&fileid=$(x:fileid),其中变量key、etag是系统变量,x:fileid是自定义变量。如果用户上传的对象是图片,可以在参数中设置imageInfo.width和imageInfo.height表示该图片的宽高。例如:key=$(key)&hash=$(etag)&w=$(imageInfo.width)&h=$(imageInfo.height)。

类型:String

callbackBodyType

发起回调请求的Content-Type头域的值。支持application/x-www-form-urlencoded、application/json。如果不设置,默认为

application/json。

类型:String

x:*

用户自定义变量,必须以 x: 开头。

通过policy携带的回调参数如表2所示。

表2 policy回调参数

参数名称

描述

是否必选

url

对象上传成功之后,OBS向此url发送回调请求,请求方法为POST。

支持设置多个url,以英文分号(;)分隔,最多支持10个。

url需要做url编码。例如:“http://www.example.com/中文?key=中文名”需要编码成“http://www.example.com/%E4%B8%AD%E6%96%87?key=%E4%B8%AD%E6%96%87%E5%90%8D”。

类型:String

host

发起回调请求的Host头域的值,如果不设置,会使用url解析出来的Host。

类型:String

body

发起回调请求的body体。body体格式必须符合body-type中设置的媒体类型。

body的内容必须经过URL安全base64编码。

回调body体支持使用系统变量,系统变量如表3所示。例如:key=$(key)&hash=$(etag),其中变量key、etag是系统变量,则body参数为:a2V5PSQoa2V5KSZoYXNoPSQoZXRhZyk=,是key=$(key)&hash=$(etag)的base64编码。如果用户上传的对象是图片,可以在参数中设置imageInfo.width和imageInfo.height表示该图片的宽高。例如:key=$(key)&hash=$(etag)&w=$(imageInfo.width)&h=$(imageInfo.height),body参数为:a2V5PSQoa2V5KSZoYXNoPSQoZXRhZykmdz0kKGltYWdlSW5mby53aWR0aCkmaD0kKGltYWdlSW5mby5oZWlnaHQp

类型:String

body-type

发起回调请求的Content-Type头域的值。支持application/x-www-form-urlencoded、application/json。如果不设置,默认为

application/json。

类型:String

表3 回调body体支持的系统变量

变量名称

参数类型

描述

fname

String

上传的原始文件名。

fsize

String

文件的大小,单位为字节。

名称兼容size。

etag

String

对象的ETag。

bucket

String

上传的对象所属桶名。

key

String

上传的对象名。

ext

String

上传文件的后缀名,通过自动检测的mimeType或者$(fname)的后缀来获取。

名称兼容mimeType。

override

String

上传对象是否产生覆盖,值只会是true或false。

上传对象的对象名在桶中已存在,即会产生覆盖,override为true,否则为false。当桶开启多版本时,不会产生覆盖写,override始终为false。

imageInfo

String

获取所上传图片的基本信息。只支持上传图片的场景。

该变量包含$(imageInfo.width)和$(imageInfo.height)两个子字段,分别表示图片的宽度和高度。

说明:

如果上传的图片大小超过25M,则无法通过imageInfo相关魔法变量获取图片基本信息,会导致回调失败。

PUT上传对象以及合并段API中,回调参数可以通过头域x-obs-callback或者请求参数x-obs-callback携带,二者只能选择其一。二者共存时,只有头域x-obs-callback携带的回调参数生效,携带的回调策略必须为经过BASE64编码的JSON字符串,该JSON字符串中能够携带的回调参数同表1,但是暂不支持自定义变量,回调body体支持的系统变量同表3

说明:

PUT上传对象以及合并段API中,使用回调时,与POST上传对象使用回调主要有以下几点不同:

  1. 回调参数是通过头域x-obs-callback或者请求参数x-obs-callback携带,携带的回调策略必须是经过BASE64编码的JSON字符串,否则OBS将返回400,Invalid Base64 encoding,对象上传失败。
  2. callbackUrl未配置或者配置为空时,视为未配置回调策略,对象仍正常上传,不执行回调。
  3. 不支持自定义变量。
JSON回调策略正确示例1:
{
"callbackUrl":"http://www.example.com/callback",
"callbackBody": "{\"bucket\":\"$(bucket)\",\"key\":\"$(key)\",\"override\":\"$(override)\"}",
"callbackBodyType":"application/json"
}

JSON回调策略正确示例2:

{
"callbackUrl":"http://www.example.com/callback1;http://www.example.com/callback2",
"callbackBody":"bucket=$(bucket)&key=$(key)&override=$(override)"
}

请求消息样式

通过表单携带回调参数的请求消息样式与POST上传对象相同,参考POST上传。policy的内容包含失效时间和条件元素,参考基于浏览器上传的表单中携带签名

通过policy携带回调参数的policy如下所示,比普通的policy增加了回调参数“callback”。请求消息样式与POST上传对象相同,参考POST上传

{ "expiration": "2017-12-31T12:00:00.000Z",
  "conditions": [
    {"x-obs-acl": "public-read" },
    {"x-obs-security-token": "YwkaRTbdY8g7q...." },
    {"bucket": "book" },
    ["starts-with", "$key", "user/"]
  ],
  "callback": [
    {"url": "http://www.example.com/callback" },
    {"host": "www.example.com" },
    {"body": "eyJrZXkiOiIkKGtleSkiLCJoYXNoIjoiJChldGFnKSJ9"},
    {"body-type": "application/json"}
  ]
}

在PUT上传对象和合并段API中,首先按照上文所述,构造JSON回调策略字符串,随后使用BASE64对其编码后,通过头域x-obs-callback或者请求参数x-obs-callback携带即可。

须知:

OBS在计算CanonicalizedHeaders和CanonicalizedResource时,会分别将头域x-obs-callback以及请求参数x-obs-callback纳入签名计算的范围,参考OBS签名机制概述

响应消息样式

1
2
3
4
5
6
7
HTTP/1.1 status_code
Content-Type: type
Server: OBS
Date: date
x-obs-request-id: request-id 
Content-Length: length
ETag: etag
须知:

在合并段API中,不使用回调功能时,响应消息body体中为合并段的结果(XML格式),参考合并段,当使用回调功能时,响应消息body体中为回调服务器返回的响应消息body体的内容,例如{"status":"success"}

返回码

带回调参数的POST上传对象的返回码与普通POST上传对象不同。普通POST上传对象HTTP状态码是“204 No Content”。带回调参数的POST上传对象、PUT上传对象以及合并段返回结果是回调结果,如果回调成功,一般会返回“200 OK”,如果回调失败,会返回203。

表4 回调请求返回码

HTTP状态码

说明

200 OK

上传对象成功,并且回调成功。

203 Non Authoritative Information

上传对象成功,但是回调失败。

请求示例

下面的几张表提供了一些回调请求的示例。

表5 通过policy携带回调参数

请求

说明

POST / HTTP/1.1
Host: examplebucket.obs.cn-north-4.myhuaweicloud.com
Content-Type: multipart/form-data; boundary=---------------------------7e329d630b26
Content-Length: 1597

-----------------------------7e32de17c166a
Content-Disposition: form-data; name="key"

file/obj1
-----------------------------7e32de17c166a
Content-Disposition: form-data; name="AccessKeyId"

UYNVCM2JJES4APB9FZUG
-----------------------------7e32de17c166a
Content-Disposition: form-data; name="policy"

ewogICJleHBpcmF0aW9uIjogIjIwMjAtMTAtMDFUMTI6MDA6MDAuMDAwWiIsCiAgImNvbmRpdGlvbnMiOiBbCiAgICB7ImJ1Y2tldCI6ICJleGFtcGxlYnVja2V0In0sCiAgICBbImVxIiwgIiRrZXkiLCAiZmlsZS9vYmoxIl0KICBdLAogICJjYWxsYmFjayI6IFsKICAgIHsidXJsIjogImh0dHA6Ly93d3cuZXhhbXBsZS5jb20vY2FsbGJhY2sifSwKICAgIHsiYm9keSI6ICJleUpyWlhraU9pSWtLR3RsZVNraUxDSm9ZWE5vSWpvaUpDaGxkR0ZuS1NKOSJ9LAogICAgeyJib2R5LXR5cGUiOiAiYXBwbGljYXRpb24vanNvbiJ9CiAgICBdCn0
-----------------------------7e32de17c166a
Content-Disposition: form-data; name="signature"

w0nW7iiC4Wfav9SXkU/NiSI99E8=
-----------------------------7e32de17c166a
Content-Disposition: form-data; name="file"; filename="E:\TEST_FILE\TEST.txt"
Content-Type: text/plain

123456
---------------------------7e32de17c166a
Content-Disposition: form-data; name="submit"

Upload
-----------------------------7e32de17c166a--

其中policy为:

{
"expiration": "2020-10-01T12:00:00.000Z",
"conditions": [
{"bucket": "examplebucket"},
["eq", "$key", "file/obj1"]
],
"callback": [
{"url": "http://www.example.com/callback"},
{"body": "eyJrZXkiOiIkKGtleSkiLCJoYXNoIjoiJChldGFnKSJ9"},
{"body-type": "application/json"}
]
}

回调body为:

{"key":"$(key)","hash":"$(etag)"}

其中系统变量key=file/obj1,etag=f447b20a7fcbf53a5d5be013ea0b15af,最终回调的消息体是:

{"key":"file/obj1","hash":"f447b20a7fcbf53a5d5be013ea0b15af"}
表6 通过表单携带回调参数,回调请求中只使用系统变量

请求

说明

POST / HTTP/1.1
Host: examplebucket.obs.cn-north-4.myhuaweicloud.com
Content-Type: multipart/form-data; boundary=---------------------------7e329d630b26
Content-Length: 1597

-----------------------------7e32de17c166a
Content-Disposition: form-data; name="key"

file/obj1
-----------------------------7e32de17c166a
Content-Disposition: form-data; name="AccessKeyId"

UYNVCM2JJES4APB9FZUG
-----------------------------7e32de17c166a
Content-Disposition: form-data; name="policy"

ewogICJleHBpcmF0aW9uIjogIjIwMjAtMTAtMDFUMTI6MDA6MDAuMDAwWiIsCiAgImNvbmRpdGlvbnMiOiBbCiAgICB7ImJ1Y2tldCI6ICJleGFtcGxlYnVja2V0In0sCiAgICBbImVxIiwgIiRrZXkiLCAiZmlsZS9vYmoxIl0KICBdCn0
-----------------------------7e32de17c166a
Content-Disposition: form-data; name="signature"

w0nW7iiC4Wfav9SXkU/NiSI99E8=
-----------------------------7e32de17c166a
Content-Disposition: form-data; name="callbackUrl"

http://my.callback.com:8080/api/callback
-----------------------------7e32de17c166a
Content-Disposition: form-data; name="callbackBody"

key=$(key)&hash=$(etag)&fname=$(fname)&fsize=$(size)
-----------------------------7e32de17c166a
Content-Disposition: form-data; name="file"; filename="E:\TEST_FILE\TEST.txt"
Content-Type: text/plain

123456
---------------------------7e32de17c166a
Content-Disposition: form-data; name="submit"

Upload
-----------------------------7e32de17c166a--

其中policy为:

{
"expiration": "2020-10-01T12:00:00.000Z",
"conditions": [
{"bucket": "examplebucket"},
["eq", "$key", "file/obj1"]
]
}

policy中可以不包含callbackUrl和callbackBody这两个回调参数。bucket、key为必须包含的表单元素。

回调body为:

key=$(key)&hash=$(etag)&fname=$(fname)&fsize=$(size)

其中系统变量key=file/obj1,etag=f447b20a7fcbf53a5d5be013ea0b15af,fname=E:\TEST_FILE\TEST.txt,fsize=7。

最终回调的消息体是:

key=file/obj1&hash=f447b20a7fcbf53a5d5be013ea0b15af&fname=E:\TEST_FILE\TEST.txt&fsize=7
表7 通过表单携带回调参数,回调请求中使用系统变量和自定义变量,同时设置自定义元数据

请求

说明

POST / HTTP/1.1
Host: examplebucket.obs.cn-north-4.myhuaweicloud.com
Content-Type: multipart/form-data; boundary=---------------------------7e329d630b26
Content-Length: 1597

-----------------------------7e32de17c166a
Content-Disposition: form-data; name="key"

file/obj1
-----------------------------7e32de17c166a
Content-Disposition: form-data; name="AccessKeyId"

UYNVCM2JJES4APB9FZUG
-----------------------------7e32de17c166a
Content-Disposition: form-data; name="policy"

ewogICJleHBpcmF0aW9uIjogIjIwMjAtMTAtMDFUMTI6MDA6MDAuMDAwWiIsCiAgImNvbmRpdGlvbnMiOiBbCiAgICB7ImJ1Y2tldCI6ICJleGFtcGxlYnVja2V0In0sCiAgICBbImVxIiwgIiRrZXkiLCAiZmlsZS9vYmoxIl0sCgl7Ingtb2JzLW1ldGEtdGVzdDEiOiJ2YWx1ZTEifQogIF0KfQ
-----------------------------7e32de17c166a
Content-Disposition: form-data; name="signature"

w0nW7iiC4Wfav9SXkU/NiSI99E8=
-----------------------------7e32de17c166a
Content-Disposition: form-data; name="x-obs-meta-test1"

value1
-----------------------------7e32de17c166a
Content-Disposition: form-data; name="callbackUrl"

http://my.callback.com:8080/api/callback
-----------------------------7e32de17c166a
Content-Disposition: form-data; name="callbackBody"

{"bucketName": "$(bucket)","key": "$(key)","hash": "$(etag)","id": "$(x:id)","createtime": "$(x:time)"}
-----------------------------7e32de17c166a
Content-Disposition: form-data; name="callbackHost"

my.callback.com
-----------------------------7e32de17c166a
Content-Disposition: form-data; name="callbackBodyType"

application/json
-----------------------------7e32de17c166a
Content-Disposition: form-data; name="x:id"

test-example-id
-----------------------------7e32de17c166a
Content-Disposition: form-data; name="x:time"

2019-12-06 18:01:34
-----------------------------7e32de17c166a
Content-Disposition: form-data; name="file"; filename="E:\TEST_FILE\TEST.txt"
Content-Type: text/plain

123456
---------------------------7e32de17c166a
Content-Disposition: form-data; name="submit"

Upload
-----------------------------7e32de17c166a--

其中policy为:

{
"expiration": "2020-10-01T12:00:00.000Z",
"conditions": [
{"bucket": "examplebucket"},
["eq", "$key", "file/obj1"],
{"x-obs-meta-test1":"value1"}
]
}

policy中可以不包含callbackUrl、callbackBody、callbackHost、callbackBodyType、x:id、x:time这六个回调参数。bucket、key、x-obs-meta-test1为必须包含的表单元素。

回调body为:

{"bucketName": "$(bucket)","key": "$(key)","hash": "$(etag)","id": "$(x:id)","createtime": "$(x:time)"}

其中系统变量bucket=examplebucket,key=file/obj1,etag=f447b20a7fcbf53a5d5be013ea0b15af,自定义变量x:id=test-example-id,x:time=2019-12-06 18:01:34。

最终回调的json消息体是:

{"bucketName": "examplebucket","key": "file/obj1","hash": "f447b20a7fcbf53a5d5be013ea0b15af","id": "test-example-id","createtime": "2019-12-06 18:01:34"}
表8 通过表单携带回调参数,并且校验部分回调参数

请求

说明

POST / HTTP/1.1
Host: examplebucket.obs.cn-north-4.myhuaweicloud.com
Content-Type: multipart/form-data; boundary=---------------------------7e329d630b26
Content-Length: 1597

-----------------------------7e32de17c166a
Content-Disposition: form-data; name="key"

file/obj1
-----------------------------7e32de17c166a
Content-Disposition: form-data; name="AccessKeyId"

UYNVCM2JJES4APB9FZUG
-----------------------------7e32de17c166a
Content-Disposition: form-data; name="policy"

eyJleHBpcmF0aW9uIjogIjIwMjAtMTAtMDFUMTI6MDA6MDAuMDAwWiIsImNvbmRpdGlvbnMiOiBbeyJidWNrZXQiOiAiZXhhbXBsZWJ1Y2tldCJ9LFsiZXEiLCAiJGtleSIsICJmaWxlL29iajEiXSx7Ingtb2JzLW1ldGEtdGVzdDEiOiJ2YWx1ZTEifSx7ImNhbGxiYWNrVXJsIjoiaHR0cDovL215LmNhbGxiYWNrLmNvbTo4MDgwL2FwaS9jYWxsYmFjayJ9LHsiY2FsbGJhY2tCb2R5Ijoie1wiYnVja2V0TmFtZVwiOiAkKGJ1Y2tldCksXCJrZXlcIjogJChrZXkpLFwiaGFzaFwiOiAkKGV0YWcpLFwiaWRcIjogJHt4OmlkfSxcImNyZWF0ZXRpbWVcIjogJHt4OnRpbWV9fSJ9LHsieDp0aW1lIjoiMjAxOS0xMi0wNiAxODowMTozNCJ9XX0
-----------------------------7e32de17c166a
Content-Disposition: form-data; name="signature"

w0nW7iiC4Wfav9SXkU/NiSI99E8=
-----------------------------7e32de17c166a
Content-Disposition: form-data; name="x-obs-meta-test1"

value1
-----------------------------7e32de17c166a
Content-Disposition: form-data; name="callbackUrl"

http://my.callback.com:8080/api/callback
-----------------------------7e32de17c166a
Content-Disposition: form-data; name="callbackBody"

{"bucketName": $(bucket),"key": $(key),"hash": $(etag),"id": $(x:id),"createtime": $(x:time)}
-----------------------------7e32de17c166a
Content-Disposition: form-data; name="callbackHost"

my.callback.com
-----------------------------7e32de17c166a
Content-Disposition: form-data; name="callbackBodyType"

application/json
-----------------------------7e32de17c166a
Content-Disposition: form-data; name="x:id"

test-example-id
-----------------------------7e32de17c166a
Content-Disposition: form-data; name="x:time"

2019-12-06 18:01:34
-----------------------------7e32de17c166a
Content-Disposition: form-data; name="file"; filename="E:\TEST_FILE\TEST.txt"
Content-Type: text/plain

123456
---------------------------7e32de17c166a
Content-Disposition: form-data; name="submit"

Upload
-----------------------------7e32de17c166a--

其中policy为:

{
"expiration": "2020-10-01T12:00:00.000Z",
"conditions": [
{"bucket": "examplebucket"},
["eq", "$key", "file/obj1"],
{"x-obs-meta-test1":"value1"},
{"callbackUrl":"http://my.callback.com:8080/api/callback"},
{"callbackBody":"{\"bucketName\": $(bucket),\"key\": $(key),\"hash\": $(etag),\"id\": $(x:id),\"createtime\": $(x:time)}"},
{"x:time":"2019-12-06 18:01:34"}
]
}

policy中包含了callbackUrl、callbackBody、x:time这三个回调参数,会对这三个参数做条件校验,没有包含callbackHost、callbackBodyType、x:id这三个回调参数,不对这三个参数做条件校验。

policy中可以不包含回调参数,也可以包含部分/全部回调参数。

bucket、key、x-obs-meta-test1为必须包含的表单元素。

回调body为:

{"bucketName": $(bucket),"key": $(key),"hash": $(etag),"id": $(x:id),"createtime": $(x:time)}

其中系统变量bucket=examplebucket,key=file/obj1,etag=f447b20a7fcbf53a5d5be013ea0b15af,自定义变量x:id=test-example-id,x:time=2019-12-06 18:01:34。

最终回调的json消息体是:

{"bucketName": "examplebucket","key": "file/obj1","hash": "f447b20a7fcbf53a5d5be013ea0b15af","id": "test-example-id","createtime": "2019-12-06 18:01:34"}
表9 在PUT上传对象API中,通过请求参数x-obs-callback携带回调策略

请求

说明

PUT /example.txt?x-obs-callback=eyJjYWxsYmFja0JvZHkiOiAie1wib2JqZWN0TmFtZVwiOiBcIiQoa2V5KVwiLCBcImJ1Y2tldFwiOiBcIiQoYnVja2V0KVwiLCBcImV4dFwiOiBcIiQoZXh0KVwiLCBcImV0YWdcIjogXCIkKGV0YWcpXCIsIFwib3ZlcnJpZGVcIjogXCIkKG92ZXJyaWRlKVwiLCBcInNpemVcIjogXCIkKHNpemUpXCJ9IiwgImNhbGxiYWNrVXJsIjogImh0dHA6Ly93d3cuZXhhbXBsZS5jb20vY2FsbGJhY2sifQ== HTTP/1.1
User-Agent: curl/7.29.0
Host: examplebucket.obs.cn-north-4.myhuaweicloud.com
Accept: */*
Date: WED, 14 Oct 2020 04:11:15 GMT
Authorization: OBS H4IPJX0TQTHTHEBQQCEC:gYqplLq30dEX7GMi2qFWyjdFsyw=
Content-Length: 1024
Expect: 100-continue
[1024 Byte data content]

其中回调策略JSON字符串为:

{"callbackBody": "{\"objectName\": \"$(key)\", \"bucket\": \"$(bucket)\", \"ext\": \"$(ext)\", \"etag\": \"$(etag)\", \"override\": \"$(override)\", \"size\": \"$(size)\"}", "callbackUrl": "http://www.example.com/callback"}

在回调策略中包含了callbackUrl和callbackBody两个回调参数,该回调策略JSON字符串经过BASE64编码之后即为:eyJjYWxsYmFja0JvZHkiOiAie1wib2JqZWN0TmFtZVwiOiBcIiQoa2V5KVwiLCBcImJ1Y2tldFwiOiBcIiQoYnVja2V0KVwiLCBcImV4dFwiOiBcIiQoZXh0KVwiLCBcImV0YWdcIjogXCIkKGV0YWcpXCIsIFwib3ZlcnJpZGVcIjogXCIkKG92ZXJyaWRlKVwiLCBcInNpemVcIjogXCIkKHNpemUpXCJ9IiwgImNhbGxiYWNrVXJsIjogImh0dHA6Ly93d3cuZXhhbXBsZS5jb20vY2FsbGJhY2sifQ==

最后通过请求参数x-obs-callback携带。

如果该桶中不存在对象名为example.txt的对象,则最终回调消息体是:

{"objectName":"example.txt","bucket":"examplebucket","ext":"txt","etag":"f447b20a7fcbf53a5d5be013ea0b15af","override":"false","size":"1024"}
表10 在PUT上传对象API中,通过头域x-obs-callback携带回调策略

请求

说明

PUT /example.txt? HTTP/1.1
User-Agent: curl/7.29.0
Host: examplebucket.obs.cn-north-4.myhuaweicloud.com
Accept: */*
Date: WED, 14 Oct 2020 04:11:15 GMT
Authorization: OBS H4IPJX0TQTHTHEBQQCEC:gYqplLq30dEX7GMi2qFWyjdFsyw=
x-obs-callback: eyJjYWxsYmFja0JvZHkiOiAia2V5PSQoa2V5KSZvdmVycmlkZT0kKG92ZXJyaWRlKSIsICJjYWxsYmFja1VybCI6ICJodHRwOi8vd3d3LmV4YW1wbGUuY29tL2NhbGxiYWNrMTtodHRwOi8vd3d3LmV4YW1wbGUuY29tL2NhbGxiYWNrMiJ9
Content-Length: 1024
Expect: 100-continue
[1024 Byte data content]

其中回调策略JSON字符串为:

{"callbackBody": "key=$(key)&override=$(override)", "callbackUrl": "http://www.example.com/callback1;http://www.example.com/callback2"}

在回调策略中包含了callbackUrl和callbackBody两个回调参数,该回调策略JSON字符串经过BASE64编码之后即为:eyJjYWxsYmFja0JvZHkiOiAia2V5PSQoa2V5KSZvdmVycmlkZT0kKG92ZXJyaWRlKSIsICJjYWxsYmFja1VybCI6ICJodHRwOi8vd3d3LmV4YW1wbGUuY29tL2NhbGxiYWNrMTtodHRwOi8vd3d3LmV4YW1wbGUuY29tL2NhbGxiYWNrMiJ9

最后通过头域x-obs-callback携带。

如果example.txt对象名在该桶中已经存在,那么最终回调消息体为:

key=example.txt&override=true
表11 在合并段API中,通过头域x-obs-callback携带回调策略

请求

说明

POST /example.txt?uploadId=00000163D46218698DF407362295674C HTTP/1.1
User-Agent: curl/7.29.0
Host: examplebucket.obs.cn-north-4.myhuaweicloud.com
Accept: */*
Date: WED, 14 Oct 2020 04:11:15 GMT
Authorization: OBS H4IPJX0TQTHTHEBQQCEC:dOfK9iILcKxo58tRp3fWeDoYzKA=
x-obs-callback: eyJjYWxsYmFja0JvZHkiOiAie1wiaGFzaFwiOiBcIiQoZXRhZylcIiwgXCJrZXlcIjogXCIkKGtleSlcIn0iLCAiY2FsbGJhY2tVcmwiOiAiaHR0cDovL3d3dy5leGFtcGxlLmNvbS9jYWxsYmFjayJ9
Content-Length: 422

<?xml version="1.0" encoding="utf-8"?>
<CompleteMultipartUpload>
<Part>
<PartNumber>1</PartNumber>
<ETag>a54357aff0632cce46d942af68356b38</ETag>
</Part>
<Part>
<PartNumber>2</PartNumber>
<ETag>0c78aef83f66abc1fa1e8477f296d394</ETag>
</Part>
<Part>
<PartNumber>3</PartNumber>
<ETag>acbd18db4cc2f85cedef654fccc4a4d8</ETag>
</Part>
</CompleteMultipartUpload>

其中回调策略JSON字符串为:

{"callbackBody": "{\"hash\": \"$(etag)\", \"key\": \"$(key)\"}", "callbackUrl": "http://www.example.com/callback"}

在回调策略中包含了callbackUrl和callbackBody两个回调参数,该回调策略JSON字符串经过BASE64编码之后即为:

eyJjYWxsYmFja0JvZHkiOiAie1wiaGFzaFwiOiBcIiQoZXRhZylcIiwgXCJrZXlcIjogXCIkKGtleSlcIn0iLCAiY2FsbGJhY2tVcmwiOiAiaHR0cDovL3d3dy5leGFtcGxlLmNvbS9jYWxsYmFjayJ9

最后通过头域x-obs-callback携带。

最终回调消息体为:

{"hash":"aa2a0304e377796ad5f9793f237f22a1-3","key":"example.txt"}
表12 在合并段API中,通过请求参数x-obs-callback携带回调策略

请求

说明

POST /example.txt?uploadId=00000163D46218698DF407362295674C&x-obs-callback=eyJjYWxsYmFja0JvZHkiOiAib3ZlcnJpZGU9JChvdmVycmlkZSkmZnNpemU9JChmc2l6ZSkiLCAiY2FsbGJhY2tVcmwiOiAiaHR0cDovL3d3dy5leGFtcGxlLmNvbS9jYWxsYmFjazE7aHR0cDovL3d3dy5leGFtcGxlLmNvbS9jYWxsYmFjMjtodHRwOi8vd3d3LmV4YW1wbGUuY29tL2NhbGxiYWNrMyJ9 HTTP/1.1
User-Agent: curl/7.29.0
Host: examplebucket.obs.cn-north-4.myhuaweicloud.com
Accept: */*
Date: WED, 14 Oct 2020 04:11:15 GMT
Authorization: OBS H4IPJX0TQTHTHEBQQCEC:dOfK9iILcKxo58tRp3fWeDoYzKA=
Content-Length: 422

<?xml version="1.0" encoding="utf-8"?>
<CompleteMultipartUpload>
<Part>
<PartNumber>1</PartNumber>
<ETag>a54357aff0632cce46d942af68356b38</ETag>
</Part>
<Part>
<PartNumber>2</PartNumber>
<ETag>0c78aef83f66abc1fa1e8477f296d394</ETag>
</Part>
<Part>
<PartNumber>3</PartNumber>
<ETag>acbd18db4cc2f85cedef654fccc4a4d8</ETag>
</Part>
</CompleteMultipartUpload>

其中回调策略JSON字符串为:

{"callbackBody": "override=$(override)&fsize=$(fsize)", "callbackUrl": "http://www.example.com/callback1;http://www.example.com/callbac2;http://www.example.com/callback3"}

在回调策略中包含了callbackUrl和callbackBody两个回调参数,callbackUrl指定了3个,callbackBody中使用了魔法变量$(override)以及$(fsize)。该回调策略JSON字符串经过BASE64编码之后即为:

eyJjYWxsYmFja0JvZHkiOiAib3ZlcnJpZGU9JChvdmVycmlkZSkmZnNpemU9JChmc2l6ZSkiLCAiY2FsbGJhY2tVcmwiOiAiaHR0cDovL3d3dy5leGFtcGxlLmNvbS9jYWxsYmFjazE7aHR0cDovL3d3dy5leGFtcGxlLmNvbS9jYWxsYmFjMjtodHRwOi8vd3d3LmV4YW1wbGUuY29tL2NhbGxiYWNrMyJ9

最后通过请求参数x-obs-callback携带。

如果该桶中已经存在名为example.txt的对象,那么最终回调消息体为:

override=true&fsize=104858
提示

您即将访问非华为云网站,请注意账号财产安全

文档反馈

文档反馈

意见反馈

0/500

标记内容

同时提交标记内容