创建任务

最近更新时间:2019-07-24 15:21:30

1. 接口描述

接口请求域名: iotcloud.tencentcloudapi.com 。

本接口(CreateTask)用于创建一个批量任务。目前此接口可以创建批量更新影子以及批量下发消息的任务

默认接口请求频率限制:100次/秒。

2. 输入参数

以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数

参数名称 必选 类型 描述
Action String 公共参数,本接口取值:CreateTask
Version String 公共参数,本接口取值:2018-06-14
Region String 公共参数,本接口不需要传递此参数。
TaskType String 任务类型,取值为 “UpdateShadow” 或者 “PublishMessage”
ProductId String 执行任务的产品ID
DeviceNameFilter String 执行任务的设备名的正则表达式
ScheduleTimeInSeconds Integer 任务开始执行的时间。 取值为 Unix 时间戳,单位秒,且需大于等于当前时间时间戳,0为系统当前时间时间戳,即立即执行,最大为当前时间86400秒后,超过则取值为当前时间86400秒后
Tasks Task 任务描述细节,描述见下 Task
MaxExecutionTimeInSeconds Integer 最长执行时间,单位秒,被调度后超过此时间仍未有结果则视为任务失败。取值为0-86400,默认为86400

3. 输出参数

参数名称 类型 描述
TaskId String 创建的任务ID
RequestId String 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 创建任务

输入示例

https://iotcloud.tencentcloudapi.com/?Action=CreateTask
&TaskType=UpdateShadow
&ProductId=ABCDE12345
&DeviceNameFilter=
&ScheduleTimeInSeconds=0
&MaxExecutionTimeInSeconds=
&Tasks.UpdateShadowTask.Desired={\"color\":\"red\"}
&<公共请求参数>

输出示例

{
  "Response": {
    "TaskId": "dsaudhuisadhada",
    "RequestId": "xxxxxxxxxxxxxxxxxxxxxxx"
  }
}

5. 开发者资源

API Explorer

该工具提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力,能显著降低使用云 API 的难度,推荐使用。

SDK

云 API 3.0 提供了配套的开发工具集(SDK),支持多种编程语言,能更方便的调用 API。

命令行工具

6. 错误码

以下仅列出了接口业务逻辑相关的错误码,其他错误码详见 公共错误码

错误码 描述
InternalError 内部错误
InvalidParameterValue 参数取值错误
LimitExceeded.PengingOrProcessingTasksExceedLimit 等待和处理中的任务数过多。
ResourceNotFound.ProductNotExist 产品不存在。