You need to enable JavaScript to run this app.
导航
语音服务
  • 文档首页
    • /
  • 语音服务

修改语音资源

最近更新时间：2023.08.17 20:59:59

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

我的收藏

通过该接口可以修改语音资源的名称信息。

1. 接口说明

  • 请求方式：POST

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

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

Authorization

String

是

HMAC-SHA256 Credential***

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

ServiceName

String

是

vms

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

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

Query

参数数据类型是否必填示例值描述
ActionString是OpenUpdateResource接口名称。该接口固定值为OpenUpdateResource。
VersionString是2022-01-01接口版本。语音服务接口默认版本为2022-01-01。
ResourceKeyString是e6eaa926a2ed41df8f52d63c046b7d78语音资源唯一标识符
NameString是test语音资源名称

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

ResponseMetadata

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

Result

参数数据类型示例值描述
ResourceKeyStringe6eaa926a2ed41df8f52d63c046b7d78语音资源唯一标识符
NameStringtest语音文件名称

Error

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

4. 示例

请求示例

curl --location --request POST 'http://cloud-vms.volcengineapi.com?Action=OpenUpdateResource&Version=2022-01-01&ResourceKey=key&Name=name.mp3' \
--header 'X-Date: 20201103T104027Z' \
--header 'Authorization: HMAC-SHA256 Credential=***' \
--header 'ServiceName: vms' \
--header 'Region: cn-north-1'

返回示例

  • 正确返回示例
{
    "ResponseMetadata": {
        "RequestId": "20221229155832B910B03FC46633760AD0",
        "Action": "OpenUpdateResource",
        "Version": "2022-01-01",
        "Service": "vms",
        "Region": "cn-north-1",
        "Error": {
            "Code": "OK",
            "Message": "成功"
        }
    },
    "Result": {
        "ResourceKey": "1ca08a45a937411ebd780000000",
        "Name": "name.mp3"
    }
}
  • 错误返回示例
{
    "ResponseMetadata": {
        "RequestId": "20221229155620EFFB37E3C4D44B7A1002",
        "Action": "OpenUpdateResource",
        "Version": "2022-01-01",
        "Service": "vms",
        "Region": "cn-north-1",
        "Error": {
            "Code": "RESOURCE_KEY_IS_NOT_EXIST",
            "Message": "语音资源key不存在"
        }
    },
    "Result": {}
}