获取资源上传URL--语音服务-火山引擎

文档中心

立即注册

导航

获取资源上传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-Date	String	是	20201103T104027Z	鉴权字段。请参考文档中心-火山引擎。
Authorization	String	是	HMAC-SHA256 Credential***	鉴权字段。请参考文档中心-火山引擎。
ServiceName	String	是	vms	服务名称。语音服务的服务名称为`vms`。
Region	String	是	cn-north-1	区域名称。
Content-Type	String	是	application/json	指定请求消息体的结构化格式。

Query

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

Body

参数	数据类型	是否必选	示例值	描述
FileName	String	是	e7737a12667f4373a5c96220ecb395b5.mp3	文件名称，目前仅仅支持MP3和WAV格式的文件，文件名称必须唯一，可通过UUID生成文件名，用于幂等

3. 返回参数

参数	数据类型	描述
ResponseMetadata	ResponseMetadata	响应公共参数。包含的参数说明请参见 ResponseMetadata。
Result	Result	响应业务参数。包含的参数说明请参见 Result。

ResponseMetadata

参数	数据类型	描述
RequestId	String	请求 ID。
Action	String	请求的接口名称。
Version	String	请求的版本号。
Service	String	请求的服务名称。
Region	String	请求的区域。
Error	Error	错误信息。如果请求没有异常则不会返回错误信息。包含的参数说明请参见 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

参数	数据类型	描述
Code	String	错误码。
Message	String	错误信息。

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": {}
}