最近更新时间：2023.08.17 21:00:14
首次发布时间：2023.02.28 20:31:38
查询账户下的语音资源列表信息。
请求方式：POST
接口地址：http://cloud-vms.volcengineapi.com?Action=QueryOpenGetResource&Version=2022-01-01
| 参数 | 数据类型 | 是否必填 | 示例值 | 描述 |
|---|---|---|---|---|
| X-Date | String | 是 | 20201103T104027Z | 鉴权字段。请参考文档中心-火山引擎。 |
Authorization | String | 是 | HMAC-SHA256 Credential*** | 鉴权字段。请参考文档中心-火山引擎。 |
ServiceName | String | 是 | vms | 服务名称。语音服务的服务名称是 |
| Region | String | 是 | cn-north-1 | 区域名称，固定值cn-north-1。 |
Content-Type | String | 是 | application/json | 指定请求消息体的结构化格式。语音服务的 Content-Type 为 |
| 参数 | 数据类型 | 是否必填 | 示例值 | 描述 |
|---|---|---|---|---|
| Action | String | 是 | QueryOpenGetResource | 接口名称。该接口固定值为QueryOpenGetResource。 |
| Version | String | 是 | 2022-01-01 | 接口版本。语音服务接口默认版本为2022-01-01。 |
| 参数 | 数据类型 | 是否必填 | 示例值 | 描述 |
|---|---|---|---|---|
| Type | Integer | 是 | 0（0 语音通知文件 1文本转语音模板 2 智能语音交互文件） | 语音资源类型 |
| Keyword | String | 否 | test | 语音资源名称或者key |
| State | Integer | 否 | 0 | 语音资源状态（0代表审核中, 1代表审核通过, 2代表审核未通过） |
| Limit | Integer | 否 | 10 | 每页大小，默认值10，最小为1，最大100 |
| Offset | Integer | 是 | 0 | 偏移量，默认为0，第一页偏移量为0，第二页偏移量为Limit的数值，以此类推 |
| 参数 | 数据类型 | 描述 |
|---|---|---|
| ResponseMetadata | ResponseMetadata | 响应公共参数。包含的参数说明请参见 ResponseMetadata。 |
| Result | Result | 响应业务参数。包含的参数说明请参见 Result。 |
| 参数 | 数据类型 | 描述 |
|---|---|---|
| RequestId | String | 请求 ID。 |
| Action | String | 请求的接口名称。 |
| Version | String | 请求的版本号。 |
| Service | String | 请求的服务名称。 |
| Region | String | 请求的区域。 |
| Error | Error | 错误信息。如果请求没有异常则不会返回错误信息。包含的参数说明请参见 Error。 |
| 参数 | 数据类型 | 示例值 | 描述 |
|---|---|---|---|
| Records | List | 语音资源记录 | |
| Total | Integer | 2 | 总数量 |
| Limit | Integer | 10 | 每页大小 |
| Offset | Integer | 0 | 偏移量 |
| 参数 | 数据类型 | 示例值 | 描述 |
|---|---|---|---|
| ResourceKey | String | e6eaa926a2ed41df8f52d63c046b7d78 | 语音资源唯一标识符 |
| Name | String | test | 语音资源名称 |
| Suffix | String | .wav | 语音资源后缀 |
| Duration | Integer | 4 | 时长（S） |
| State | Integer | 1 | 状态(0代表审核中, 1代表审核通过, 2代表审核未通过) |
| CreateTime | Date | 2021-05-19 11:07:13 | 创建时间 |
| Type | Integer | 0 | 语音资源类型(0语音通知文件 1文本转语音模板 2语音交互文件) |
| Remark | String | 测试 | 备注 |
| 参数 | 数据类型 | 描述 |
|---|---|---|
| Code | String | 错误码。 |
| Message | String | 错误信息。 |
curl --location --request POST 'http://cloud-vms.volcengineapi.com?Action=QueryOpenGetResource&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 '{ "Type":0, "Keyword":"0f299353da3343e5837310000" }'
{ "ResponseMetadata": { "RequestId": "2022122916224212DFB47AFC1F0179A250", "Action": "QueryOpenGetResource", "Version": "2022-01-01", "Service": "vms", "Region": "cn-north-1" }, "Result": { "Records": [ { "ID": 3419, "ResourceKey": "0f299353da3343e5837300000", "Suffix": ".mp3", "Name": "e7737a12667f4373a56200000.mp3", "Duration": 17, "State": 1, "CreateTime": "2022-12-29 15:27:46", "Type": 0, "Remark": "" } ], "Total": 1, "Limit": 10, "Offset": 0 } }
{ "ResponseMetadata": { "RequestId": "202212291628587CA24F54ACD4A677C431", "Action": "QueryOpenGetResource", "Version": "2022-01-01", "Service": "vms", "Region": "cn-north-1", "Error": { "Code": "RequestParametersError", "Message": "[type:must not be null]" } } }