修改观察任务。
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。
请求参数
名称 | 类型 | 是否必选 | 示例值 | 描述 |
---|---|---|---|---|
Action | String | 是 | UpdateWatchTask |
系统规定参数。取值:UpdateWatchTask。 |
WatchTaskId | String | 是 | 304E63XXXX |
观察任务ID。 |
TaskName | String | 否 | example |
任务名称,支持0~64个字符,支持中英文、数字、下划线(_)、连字符(-)。 |
DeviceList | String | 否 | ["1C44674CC97AXXXX", "915E4ACA5866XXXX"] |
设备ID列表,JSON数组样式,单次最大支持操作1万个,单个任务最大支持1万个。 |
ScheduleType | String | 否 | EVERYDAY |
调度类型,取值范围: ONCE:仅执行一次 EVERYDAY:每天定时执行 EVERY_WEEK:周计划, EVERY_MONTH:月计划 LONG_RUNNING:持续执行 |
ScheduleCycleDates | String | 否 | [1, 4, 6] |
ScheduleType为EVERY_WEEK、EVERY_MONTH时必填。JSON数组格式。 EVERY_MONTH:可填1~31,每个数字代表月内某一天。比如想设置每月1日、20日、25日、28日的执行实例,则填写1,20,25,28 EVERY_WEEK: 可填1~7,每个数字代表周内某一天。比如想设置每周周一、周四、周六,则填写1, 4, 6 |
ScheduleTimes | String | 否 | [{"StartTime":"10:00:00","EndTime":"11:00:00"}] |
执行时间段。 以JSON数组格式填写StartTime和EndTime,格式为时分秒(HH:mm:ss)。 支持多段,指定多段时不能重合交错。 StartTime和EndTime相同时,表示仅该时刻执行。 |
WatchPolicyIds | String | 否 | ["30fXXXX","7c8XXXX","b48XXXX"] |
关注策略ID列表,JSON数组格式。单次最大支持操作10个,单个任务最大支持10个。 |
MessageReceiver | String | 否 | { "MessageQueue": "Kafka", "Config": { "BootstrapServers": "127.0.0.1:9092,127.0.0.2:9092", "Topic": "topic_for_put_message", "Authorization": "SASL", "SASL": { "Type": "PLAIN", "Username": "username_for_put_message", "Password": "password_for_put_message" } } } |
接收通知的地址。需包含如下字段: MessageQueue:暂时只支持Kafka Config 表示字段1的详细配置信息 BootstrapServers:连接地址,支持多个「IP:Port」,之间用逗号分隔 Topic:Kafka消息队列 Authorization:授权方式,暂时只支持SASL SASL:SASL授权模式的详细信息 Type:授权类型,支持PLAIN、SCRAM两种模式 Username:用户名 Password:密码 |
Description | String | 否 | 闯入敏感区域 |
描述。支持0~256个字符,支持中英文、数字、下划线(_)、连字符(-)。 |
返回数据
名称 | 类型 | 示例值 | 描述 |
---|---|---|---|
RequestId | String | 46329898-489C-4E63-9BA1-C1DA5C5D0986 |
请求ID。 |
Success | Boolean | true |
是否调用成功。 |
Code | String | 200 |
响应 code。 |
Message | String | OK |
返回消息。 |
示例
请求示例
http(s)://[Endpoint]/?Action=UpdateWatchTask
&WatchTaskId=304E63XXXX
&TaskName=example
&DeviceList=["1C44674CC97AXXXX", "915E4ACA5866XXXX"]
&ScheduleType=EVERYDAY
&ScheduleCycleDates=[1, 4, 6]
&ScheduleTimes=[{"StartTime":"10:00:00","EndTime":"11:00:00"}]
&WatchPolicyIds=["30fXXXX","7c8XXXX","b48XXXX"]
&MessageReceiver={ "MessageQueue": "Kafka", "Config": { "BootstrapServers": "127.0.0.1:9092,127.0.0.2:9092", "Topic": "topic_for_put_message", "Authorization": "SASL", "SASL": { "Type": "PLAIN", "Username": "username_for_put_message", "Password": "password_for_put_message" } } }
&Description=闯入敏感区域
&公共请求参数
正常返回示例
XML
格式
HTTP/1.1 200 OK
Content-Type:application/xml
<UpdateWatchTaskResponse>
<RequestId>46329898-489C-4E63-9BA1-C1DA5C5D0986</RequestId>
<Success>true</Success>
<Code>200</Code>
<Message>OK</Message>
</UpdateWatchTaskResponse>
JSON
格式
HTTP/1.1 200 OK
Content-Type:application/json
{
"RequestId" : "46329898-489C-4E63-9BA1-C1DA5C5D0986",
"Success" : true,
"Code" : "200",
"Message" : "OK"
}
错误码
访问错误中心查看更多错误码。