调用该接口查询声码排程列表。
QPS限制
单个阿里云账号调用该接口的每秒请求数(QPS)最大限制为10。
说明 RAM用户共享阿里云账号配额。
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。
请求参数
名称 | 类型 | 是否必选 | 示例值 | 描述 |
---|---|---|---|---|
Action | String | 是 | QuerySoundCodeScheduleList |
系统规定参数。取值:QuerySoundCodeScheduleList。 |
IotInstanceId | String | 否 | iot_instc_pu****_c*-v64******** |
实例ID。您可在物联网平台控制台的实例概览页面,查看当前实例的ID。 注意
实例的更多信息,请参见如何获取实例ID。 |
PageSize | Integer | 否 | 1 |
指定每页返回的语料条数,取值范围:1~50,默认值为20。 |
PageId | Integer | 否 | 20 |
指定显示返回结果中的第几页。取值范围1~10,000,默认值为1。 |
调用API时,除了本文介绍的该API的特有请求参数,还需传入公共请求参数。公共请求参数说明,请参见公共参数文档。
返回数据
名称 | 类型 | 示例值 | 描述 |
---|---|---|---|
Code | String | iot.soundcodeservice.NotSigned |
调用失败时,返回的错误码。更多信息,请参见错误码。 |
Data | Struct |
返回数据。 |
|
List | Array of Items |
排程列表。 |
|
Items | |||
Description | String | test |
排程描述。 |
EndDate | String | 2022-03-28 |
排程结束工作日期。 |
EndTime | String | 23:59 |
排程每日结束工作时间。 |
GmtCreate | Long | 1620634297000 |
排程创建时间。 |
Name | String | test |
排程名称。 |
OpenType | String | INNER |
排程开放类型。
|
ScheduleCode | String | Md3ZiTL888K9llXDy7890*********** |
排程唯一标识。 |
StartDate | String | 2022-03-28 |
排程开始工作日期。 |
StartTime | String | 00:00 |
排程每日开始工作时间。 |
Status | String | WORKING |
排程状态。 |
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=QuerySoundCodeScheduleList
&<公共请求参数>
正常返回示例
XML
格式
<QuerySoundCodeScheduleListResponse>
<RequestId>66FF51D3-***-49F1-B1A2-***</RequestId>
<Data>
<PageId>1</PageId>
<PageSize>20</PageSize>
<Total>100</Total>
<List>
<Items>
<StartDate>2022-03-28</StartDate>
<Status>WORKING</Status>
<GmtCreate>1620634297000</GmtCreate>
<Description>test</Description>
<EndTime>23:59</EndTime>
<StartTime>00:00</StartTime>
<ScheduleCode>Md3ZiTL888K9llXDy7890***********</ScheduleCode>
<EndDate>2022-03-28</EndDate>
<Name>test</Name>
<OPenType>INNER</OpenType>
</Items>
</List>
</Data>
<Success>true</Success>
</QuerySoundCodeScheduleListResponse>
JSON
格式
{
"RequestId": "66FF51D3-***-49F1-B1A2-***",
"Data": {
"PageId": "1",
"PageSize": "20",
"Total": "100",
"List": {
"Items": [
{
"StartDate": "2022-03-28",
"Status": "WORKING",
"GmtCreate": "1620634297000",
"Description": "test",
"EndTime": "23:59",
"StartTime": "00:00",
"ScheduleCode": "Md3ZiTL888K9llXDy7890***********",
"EndDate": "2022-03-28",
"Name": "test",
"OpenType": "INNER"
}
]
}
},
"Success": "true"
}
错误码
HttpCode | 错误码 | 错误信息 | 描述 |
---|---|---|---|
403 | iot.soundcodeservice.NotSigned | sound code service has not been signed | 声码服务未开通 |
400 | iot.soundcodeschedule.InvalidIotInstanceId | invalid schedule IotInstanceId | 无效的实例ID |
400 | iot.soundcode.InvalidParam | invalid param | 无效的参数 |
访问错误中心查看更多错误码。