You need to enable JavaScript to run this app.
导航

获取资源上传URL

最近更新时间2023.08.17 21:05:36

首次发布时间2023.02.28 20:31:38

1. 接口说明
  • 请求方式:POST

  • 接口地址:http://cloud-vms.volcengineapi.com?Action=GetResourceUploadUrl&Version=2022-01-01

2. 请求参数

Header

参数数据类型是否必填示例值描述
X-DateString20201103T104027Z鉴权字段。请参考文档中心-火山引擎

Authorization

String

HMAC-SHA256 Credential***

鉴权字段。请参考文档中心-火山引擎

ServiceNameStringvms服务名称。语音服务的服务名称为vms
RegionStringcn-north-1区域名称。
Content-TypeStringapplication/json指定请求消息体的结构化格式。

Query

参数数据类型是否必填示例值描述
ActionStringGetResourceUploadUrl接口名称。该接口固定值为GetResourceUploadUrl
VersionString2022-01-01接口版本。语音服务接口默认版本为2022-01-01

Body

参数数据类型是否必选示例值描述

FileName

String

e7737a12667f4373a5c96220ecb395b5.mp3

文件名称,目前仅仅支持MP3和WAV格式的文件,文件名称必须唯一,可通过UUID生成文件名,用于幂等


3. 返回参数
参数数据类型描述
ResponseMetadataResponseMetadata响应公共参数。包含的参数说明请参见 ResponseMetadata。
ResultResult响应业务参数。包含的参数说明请参见 Result。

ResponseMetadata

参数数据类型描述
RequestIdString请求 ID。
ActionString请求的接口名称。
VersionString请求的版本号。
ServiceString请求的服务名称。
RegionString请求的区域。
ErrorError错误信息。如果请求没有异常则不会返回错误信息。包含的参数说明请参见 Error

Result

参数数据类型示例值描述

UploadUrl

String

http://volc-voice-resource-bucket.tos-cn-beijing.volces.com/2100056056/nihaolihuanying.wav?X-Tos-Algorithm=TOS4-HMAC-SHA256&X-Tos-Credential=AKLTMjYxYmZjZGFjMTg4NDc3NWIxYTFhOTllNjYzMmZhOTg/20211227/cn-north-2/tos/request&X-Tos-Expires=600&X-Tos-Date=20211227T134906Z&X-Tos-Signature=c71c4dcd8fd79acf461308d5d46499529101728948aafd675985051ce9e3781f&X-Tos-SignedHeaders=host

上传链接,10分钟有效(PUT)

Error

参数数据类型描述
CodeString错误码。
MessageString错误信息。

4. 示例

请求示例

curl --location --request POST 'http://cloud-vms.volcengineapi.com?Action=GetResourceUploadUrl&Version=2022-01-01' \
--header 'ServiceName: vms' \
--header 'Region: cn-north-1' \
--header 'Content-Type: application/json' \
--header 'X-Date: 20201103T104027Z' \
--header 'Authorization: HMAC-SHA256 Credential=***' \
--data-raw '{
    "FileName": "e7737a12667f4373a5c96220ec901235.mp3"
}'

返回示例

  • 正确返回示例
{
    "ResponseMetadata": {
        "RequestId": "20221229151233D93E8E7457EA52761513",
        "Action": "GetResourceUploadUrl",
        "Version": "2022-01-01",
        "Service": "vms",
        "Region": "cn-north-1"
    },
    "Result": {
        "UploadUrl": "http://volc-xxxx.xxxx-beijing.volces.com/xxxxx"
    }
}
  • 错误返回示例
{
    "ResponseMetadata": {
        "RequestId": "2022122915160114F34A84C4D2407806A0",
        "Action": "GetResourceUploadUrl",
        "Version": "2022-01-01",
        "Service": "vms",
        "Region": "cn-north-1",
        "Error": {
            "Code": "NOT_REPET_INVOCK",
            "Message": "不可重复调用"
        }
    },
    "Result": {}
}