获取上传文件需要的签名。
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。
授权信息
下表是API对应的授权信息,可以在RAM权限策略语句的Action
元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:
- 操作:是指具体的权限点。
- 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
- 资源类型:是指操作中支持授权的资源类型。具体说明如下:
- 对于必选的资源类型,用背景高亮的方式表示。
- 对于不支持资源级授权的操作,用
全部资源
表示。
- 条件关键字:是指云产品自身定义的条件关键字。
- 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作 | 访问级别 | 资源类型 | 条件关键字 | 关联操作 |
---|---|---|---|---|
mpserverless:DescribeFileUploadSignedUrl | get |
|
| 无 |
请求参数
名称 | 类型 | 必填 | 描述 | 示例值 |
---|---|---|---|---|
Filename | string | 是 |
| wlop29.jpg |
Size | long | 是 | 文件大小,单位字节。 | 41836 |
SpaceId | string | 是 | 服务空间 ID。 | mp-0e16bb12-14af-****-b24c-5ac1a9a7bb9f |
ContentType | string | 是 | 文件类型:.pdf .xls .xlsx .doc .docx .ppt .pptx .txt | png |
FileId | string | 否 | 自定义上传文件路径,支持多级目录,路径支持字母、数字、中文、横线、下横线、点符号,总长度不超过 1024,必须以"/"开头,例如:
说明
| /abc/edf/hello.jpg |
返回参数
在获取到上传文件地址 SignUrl 之后,需要使用 PUT 对该地址上传文件。 PUT 请求必须在 headers 携带回调地址参数,该参数构造方法如下:
- 第一步:构造字符串
{"callbackUrl":"....","callbackBody":"{\"fileId\":\"....\",\"spaceId\":\"....\"}","callbackBodyType":"application/json"}
分别将参数 OssCallbackUrl、Id 以及 SpaceId 替换到上面的空缺部分。 - 第二步:对上述字符串进行 base64 编码。
- 第三步:在上传文件时添加 header
x-oss-callback
,值为第二步计算得到的字符串。
注意 请求参数 ContentType 也是签名计算的一部分,因此在上传文件时您需要添加 header Content-Type,并确保值和入参一致。
示例
正常返回示例
JSON
格式
{
"SignUrl": "https://bsppub.oss-cn-shanghai.aliyuncs.com/FBPSBVMO-myspace/41552d60-52de-xxx-a713-43e879b0717a.JPG?OSSAccessKeyId=LTAIk****dtFueLA&Expires=1582152512&Signature=sek1B0Xm2r***tNvfX9tX%2BBJxA%3D",
"RequestId": "E9A50E1B-5ECE-42D4-B261-C07D1BBE68DE",
"Id": "2fada31e-8fa5-****-b595-9698cd6b5f06",
"OssCallbackUrl": "https://api.next.bspapp.com/oss_upload_callback",
"Overwrite": true
}
错误码
访问错误中心查看更多错误码。
变更历史
变更时间 | 变更内容概要 | 操作 |
---|---|---|
2023-06-01 | OpenAPI 返回结构发生变更 | 查看变更详情 |
2023-04-20 | OpenAPI 入参发生变更 | 查看变更详情 |