调用该接口查询声码列表。
QPS限制
单个阿里云账号调用该接口的每秒请求数(QPS)最大限制为10。
说明 RAM用户共享阿里云账号配额。
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。
请求参数
名称 | 类型 | 是否必选 | 示例值 | 描述 |
---|---|---|---|---|
Action | String | 是 | QuerySoundCodeList | 系统规定参数。取值:QuerySoundCodeList。 |
IotInstanceId | String | 否 | iot_instc_pu****_c*-v64******** | 实例ID。您可在物联网平台控制台的实例概览页面,查看当前实例的ID。 重要
实例的更多信息,请参见如何获取实例ID。 |
PageSize | Integer | 否 | 20 | 指定每页返回的语料条数,取值范围:1~50,默认值为20。 |
PageId | Integer | 否 | 1 | 指定显示返回结果中的第几页。取值范围:1~10,000,默认值为1。 |
调用API时,除了本文介绍的该API的特有请求参数,还需传入公共请求参数。公共请求参数说明,请参见公共参数文档。
返回数据
名称 | 类型 | 示例值 | 描述 |
---|---|---|---|
Code | String | iot.soundcodeservice.NotSigned | 调用失败时,返回的错误码。更多信息,请参见错误码。 |
Data | Struct | 返回数据。 |
|
List | Array of Items | 声码列表。 |
|
Items | |||
Duration | Integer | 2 | 声码持续时长,单位:秒。 |
GmtCreate | Long | 1620634297000 | 声码创建时间的毫秒级时间戳。 |
Name | String | test | 声码名称。 |
OpenType | String | INNER | 声码开放类型。
|
SoundCode | String | Md3ZiTL888K9llXDy7890*********** | 声码的唯一标识。 |
SoundCodeContent | String | www.taobao.com | 声码营销内容。 |
PageId | Integer | 1 | 当前页号。 |
PageSize | Integer | 20 | 每页返回的语料条数。 |
Total | Integer | 100 | 查询返回的语料总条数。 |
ErrorMessage | String | sound code service has not been signed | 调用失败时,返回的错误信息。 |
RequestId | String | 66FF51D3-***-49F1-B1A2-*** | 阿里云为该请求生成的唯一标识符。 |
Success | Boolean | true | 是否调用成功。
|
示例
请求示例
http(s)://iot.cn-shanghai.aliyuncs.com/?Action=QuerySoundCodeList
&<公共请求参数>
正常返回示例
XML
格式
</QuerySoundCodeListResponse>
<RequestId>66FF51D3-***-49F1-B1A2-***</RequestId>
<Data>
<PageId>1</PageId>
<PageSize>20</PageSize>
<Total>100</Total>
<List>
<Items>
<GmtCreate>1620634297000</GmtCreate>
<Duration>2</Duration>
<Name>test</Name>
<OpenType>INNER</OpenType>
<SoundCodeContent>www.taobao.com</SoundCodeContent>
<SoundCode>Md3ZiTL888K9llXDy7890***********</SoundCode>
</Items>
</List>
</Data>
<Success>true</Success>
</QuerySoundCodeListResponse>
JSON
格式
{
"RequestId": "66FF51D3-***-49F1-B1A2-***",
"Data": {
"PageId": "1",
"PageSize": "20",
"Total": "100",
"List": {
"Items": [
{
"GmtCreate": "1620634297000",
"Duration": "2",
"Name":" test",
"OpenType": "INNER",
"SoundCodeContent": "www.taobao.com",
"SoundCode": "Md3ZiTL888K9llXDy7890***********"
}
]
}
},
"Success": true
}
错误码
HttpCode | 错误码 | 错误信息 | 描述 |
---|---|---|---|
400 | iot.soundcode.InvalidIotInstanceId | invalid iot instance id | 无效的实例ID |
400 | iot.soundcode.InvalidParam | invalid param | 无效的参数 |
访问错误中心查看更多错误码。