最近更新时间:2023.08.29 19:44:34
首次发布时间:2021.02.23 10:42:24
本接口支持通过指定上传文件的指定存储服务和文件数量并获取文件上传地址等信息。
说明
veImageX 在全球多个区域部署,每个区域有自己对应的 OpenAPI 域名,不支持跨区域调用。具体详情请查看服务地址。
以下请求参数列表仅列出了该接口的部分公共参数,完整公共参数列表见公共参数。
参数 | 类型 | 是否必选 | 示例值 | 描述 |
---|---|---|---|---|
Action | String | 是 | ApplyImageUpload | 接口名称。veImageX 当前 API 的名称为 ApplyImageUpload 。 |
Version | String | 是 | 2018-08-01 | 接口版本。veImageX 当前 API 的版本为 2018-08-01 。 |
ServiceId | String | 是 |
| 服务 ID。 |
SessionKey | String | 否 |
| 一次上传会话 Key。 说明 本接口上一次请求的 |
UploadNum | Integer | 否 | 1 | 上传文件的数量,将决定下发的 StoreUri 的数量,取值范围为[1,10],默认为 1。 |
StoreKeys | Array of String | 否 |
| 上传文件的存储 Key。默认使用随机生成的字符串作为存储 Key。
说明 仅对于 veImageX 上传场景生效。 |
Prefix | String | 否 |
| 指定的上传文件路径。
说明 仅当未指定 |
FileExtension | String | 否 |
| 文件扩展名(如:.java, .txt, .go 等),最大长度限制为 8 个字节。 说明 仅当未指定 |
Overwrite | Boolean | 否 |
| 是否开启重名文件覆盖上传,取值如下所示:
注意 在指定 |
参数 | 类型 | 示例值 | 描述 |
---|---|---|---|
UploadAddress | Array of UploadAddress | 上传地址 | |
RequestId | String | 20221110162951010212162157127244C2 | 请求的唯一标识 ID。 |
参数 | 类型 | 示例值 | 描述 |
---|---|---|---|
StoreInfos | Array of StoreInfos | 上传 Uri 说明 数量由请求参数中的 | |
UploadHosts | Array of String | tos.test.com | 上传域名列表,可以用于客户端容灾,并行上传等。 |
SessionKey | String |
| 一次上传会话 Key。 |
参数 | 类型 | 示例值 | 描述 |
---|---|---|---|
StoreUri | String | tos-cn-i-mm**w2/31**a6.png | 资源 ID。 |
Auth | String | 6F**JL:-fU**zI=:Mz**5n | 上传凭证。 |
GET https://imagex.volcengineapi.com/?Action=ApplyImageUpload&Version=2018-08-01&ServiceId=WMK**UXe&StoreKeys=312**ea6.png
{ "ResponseMetadata": { "RequestId": "202307241740314A9411E1E466F1684AB7", "Action": "ApplyImageUpload", "Version": "2018-08-01", "Service": "imagex", "Region": "cn-north-1" }, "Result": { "UploadAddress": { "StoreInfos": [ { "StoreUri": "tos-i-mm**w2/31**a6.png", "Auth": "6F**JL:-fU**zI=:Mz**5n" } ], "UploadHosts": [ "upload-test.net" ], "SessionKey": "eyJh**In0=" }, "RequestId": "202307241740314A9411E1E466F1684AB7", "SDKParam": null } }
访问公共错误码获取详细信息。