获取文件上传参数。
接口说明
通过此接口获取文件上传参数。如果返回参数中的 FileExist 的值为 true，表示待检测文件在云端已存在，不需要再上传，可以直接推送检测。如果 FileExist 的值为 false，需要用此接口返回的参数，通过表单上传的方式将文件上传至指定存储位置。
表单上传服务由 OSS 产品提供，请参考表单上传。
文件检测相关接口均包含 HashKey 参数，表示文件唯一标识，目前仅支持文件完整内容的十六进制 md5 值，请在使用接口前计算该值。
计算文件内容的十六进制 md5 值可以参考以下两个步骤：
1.使用 MD5 算法对数据进行加密，生成 128 位的散列值。现有工具库包括 Java 的 MessageDigest 工具、Python 的 hashlib 库等。
2.将生成的散列值转换为 16 进制字符串形式。现有工具库包括 Java 的 Codec 工具、Python 的 hex 函数等。
调试
您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。
授权信息
当前API暂无授权信息透出。
请求参数
| 名称 | 类型 | 必填 | 描述 | 示例值 |
|---|---|---|---|---|
| HashKeyList | array | 否 | 文件标识。目前仅支持 MD5。列表最多传入 100 个元素。 说明
HashKeyList 和 HashKeyContextList 不能同时为空。
| |
| string | 否 | 文件标识。目前仅支持 MD5。 | 0a212417e65c26ff133cfff28f6c**** | |
| Type | integer | 是 | 文件类型。取值：
| 0 |
| HashKeyContextList | array<object> | 否 | 文件标识。目前仅支持 MD5。列表最多传入 100 个元素。 说明
HashKeyList 和 HashKeyContextList 不能同时为空。
| |
| object | 否 | 文件 HASH。 | ||
| HashKey | string | 否 | 文件 HASH。 | 30319dd5cee8f894766e479cac170da0 |
| FileSize | integer | 否 | 文件大小。如果文件大小超过限制，将不会返回上传参数。单位：字节。 | 2698557 |
返回参数
示例
正常返回示例
JSON格式
{
"RequestId": "09969D2C-4FAD-429E-BFBF-9A60DEF8BF6F",
"UploadUrlList": [
{
"PublicUrl": "http://example.com",
"InternalUrl": "http://example.com",
"Expire": "1658562101370",
"Context": {
"AccessId": "LTAI4G1mgPbjvGQuiV1X****",
"Policy": "eyJleHBpcmF0aW9uIjoiMjAyMi0wNy0yM1QxMDo1ODoxMC****",
"Signature": "wDhPgVdnY/bkKFYcYFl+4crl****",
"OssKey": "1/2022/06/23/15/41/16559701077444693a0c6-33b2-4cc2-a99f-9f38b8b8****"
},
"FileExist": false,
"HashKey": "0a212417e65c26ff133cfff28f6c****",
"Code": "200",
"Message": "successful"
}
]
}错误码
| HTTP status code | 错误码 | 错误信息 | 描述 |
|---|---|---|---|
| 400 | RequestTooFrequently | Request too frequently, please try again later | 请求太频繁，请稍后再试 |
| 400 | InvalidApiDetectType | Unsupported Api Detect Type. | 不支持的文件类型。 |
| 403 | NoPermission | caller has no permission | 当前操作未被授权，请联系主账号在RAM控制台进行授权后再执行操作。 |
| 500 | ServerError | ServerError | 服务故障，请稍后重试！ |
| 500 | SystemBusy | System busy, please try again later. | 系统繁忙，请稍后重试。 |
访问错误中心查看更多错误码。
变更历史
| 变更时间 | 变更内容概要 | 操作 |
|---|---|---|
| 2023-06-19 | OpenAPI 描述信息更新、OpenAPI 错误码发生变更 | 查看变更详情 |
| 2022-08-22 | OpenAPI 错误码发生变更、OpenAPI 入参发生变更、OpenAPI 返回结构发生变更 | 查看变更详情 |
| 2022-08-22 | OpenAPI 错误码发生变更、OpenAPI 入参发生变更、OpenAPI 返回结构发生变更 | 查看变更详情 |