You need to enable JavaScript to run this app.
导航
语音服务
  • 文档首页
    • /语音服务/API参考/语音/语音通知/语音通知文件管理/提交上传请求
提交上传请求
最近更新时间：2023.08.17 20:59:54首次发布时间：2023.02.28 20:31:38
我的收藏
1. 接口说明

  • 请求方式：POST

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

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

Authorization

String

是

HMAC-SHA256 Credential***

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

ServiceName

String

是

vms

服务名称。语音服务的服务名称是vms。

RegionString是cn-north-1区域名称，固定值cn-north-1。

Content-Type

String

是

application/json

指定请求消息体的结构化格式。语音服务的 Content-Type 为application/json。

Query

参数数据类型是否必填示例值描述
ActionString是CommitResourceUpload接口名称。该接口固定值为CommitResourceUpload。
VersionString是2022-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

参数数据类型示例值描述

Name

String

e7737a12667f4373a5c96220ecb395b5.mp3

文件名称，与请求参数相同

Suffix

String

.mp3

文件后缀

ResourceKeyString9facef29b86a4d52af1673bff3f40d82资源文件唯一标识符

Error

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

4. 示例

请求示例

curl --location --request POST 'https://cloud-vms.volcengineapi.com?Action=CommitResourceUpload&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": "e7737a12667f4373a56220ec901235.mp3"
}'

返回示例

  • 正确返回示例
{
    "ResponseMetadata": {
        "RequestId": "20221229152743817D1148D1F29E76622C",
        "Action": "CommitResourceUpload",
        "Version": "2022-01-01",
        "Service": "vms",
        "Region": "cn-north-1"
    },
    "Result": {
        "ResourceKey": "0f299353da3343e583xxxxx",
        "Suffix": ".mp3",
        "Name": "e7737a12667f4373a56220ec901235.mp3"
    }
}
  • 错误返回示例
{
    "ResponseMetadata": {
        "RequestId": "202212291528277521B3C400C0E177935C",
        "Action": "CommitResourceUpload",
        "Version": "2022-01-01",
        "Service": "vms",
        "Region": "cn-north-1",
        "Error": {
            "Code": "EMPTY_RESOURCE_BODY",
            "Message": "URL无效或资源文件体为空"
        }
    },
    "Result": {}
}