调用该接口创建声码排程。

QPS限制

单个阿里云账号调用该接口的每秒请求数(QPS)最大限制为2。

说明 RAM用户共享阿里云账号配额。

调试

您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

请求参数

名称 类型 是否必选 示例值 描述
Action String CreateSoundCodeSchedule

系统规定参数。取值:CreateSoundCodeSchedule。

EndDate String 2022-03-31

排程结束工作日期,格式为yyyy-MM-dd,不得早于StartDate。

Name String test

排程名称,长度为1~64个字符,一个汉字占两个字符,实例下保证唯一。

StartDate String 2022-03-31

排程开始工作日期,格式为yyyy-MM-dd。

IotInstanceId String iot_instc_pu****_c*-v64********

实例ID。您可在物联网平台控制台的实例概览页面,查看当前实例的ID

注意
  • 若有ID值,必须传入该ID值,否则调用会失败。
  • 若无ID值,则无需传入。

实例的更多信息,请参见如何获取实例ID

Description String test

排程描述,长度为1~64个字符,一个汉字占两个字符,实例下保证唯一。

OpenType String INNER

排程开放类型。

  • 内部(默认):取值为INNER,只允许排程所在实例下的设备请求声码解码。
  • 公开:取值为OPEN,可以发送邮件的方式配置白名单,允许跨实例的设备请求声码解码,跨实例解码的用量计算在声码所在的实例下。

调用API时,除了本文介绍的该API的特有请求参数,还需传入公共请求参数。公共请求参数说明,请参见公共参数文档

返回数据

名称 类型 示例值 描述
Code String iot.soundcodeservice.NotSigned

调用失败时,返回的错误码。更多信息,请参见错误码

Data String Md3ZiTL888K9llXDy7890***********

排程唯一标识。

ErrorMessage String sound code service has not been signed

调用失败时,返回的错误信息。

RequestId String 66FF51D3-***-49F1-B1A2-***

阿里云为该请求生成的唯一标识符。

Success Boolean true

是否调用成功。

  • true:调用成功。
  • false:调用失败。

示例

请求示例

http(s)://iot.cn-shanghai.aliyuncs.com/?Action=CreateSoundCodeSchedule
&EndDate=2022-03-31
&Name=test
&StartDate=2022-03-31
&<公共请求参数>

正常返回示例

XML格式

<CreateSoundCodeScheduleResponse>
  <RequestId>66FF51D3-***-49F1-B1A2-***</RequestId>
  <Data>Md3ZiTL888K9llXDy7890***********</Data>
  <Success>true</Success>
</CreateSoundCodeScheduleResponse>

JSON格式

{
    "RequestId": "66FF51D3-***-49F1-B1A2-***",
    "Data": "Md3ZiTL888K9llXDy7890***********",
    "Success": "true"
}

错误码

HttpCode 错误码 错误信息 描述
403 iot.soundcodeservice.NotSigned sound code service has not been signed 声码服务未开通
400 iot.soundcodeschedule.InvalidDesc invalid schedule description 无效的排程描述
400 iot.soundcodeschedule.InvalidName invalid schedule name 无效的排程名称
400 iot.soundcodeschedule.AlreadyExistsName already exists schedule name 已存在的排程名称
400 iot.soundcodeschedule.InvalidIotInstanceId invalid schedule IotInstanceId 无效的实例ID
400 iot.soundcodeschedule.LimitExceeded sound code schedule limit exceeded 排程超限
400 iot.soundcodeschedule.InvalidDate invalid sound code schedule date 无效的排程日期

访问错误中心查看更多错误码。