創建觀察任務。

調試

您可以在OpenAPI Explorer中直接運行該接口，免去您計算簽名的困擾。運行成功后，OpenAPI Explorer可以自動生成SDK代碼示例。

請求參數

名稱 類型 是否必選 示例值 描述
Action String 是 CreateWatchTask

系統規定參數。取值：CreateWatchTask。

CorpId String 是 44B0E0XXXX

項目id，指定在哪個項目中創建觀察任務。
TaskName String 否 example

任務名稱，支持0~64個字符，支持中英文、數字、下劃線（_）、連字符（-）。
DeviceList String 否 ["1C44674CC97AXXXX", "915E4ACA5866XXXX"]

設備ID列表，JSON數組樣式，單次最大支持操作1萬個，單個任務最大支持1萬個。

指定要關注哪些設備產出的數據，為空時任務不生效，要關注指定項目下全部設備則傳遞“ALL”。

設備必須在指定CorpId 下，否則接口返回失敗。
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"}]

執行時間段。

ScheduleType為 LONG_RUNNING時可不填。

以JSON數組格式填寫StartTime和EndTime，格式為時分秒（HH:mm:ss）。

支持多段，指定多段時不能重合交錯。

StartTime和EndTime相同時，表示僅該時刻執行。
WatchPolicyIds String 是 ["30fXXXX","7c8XXXX","b48XXXX"]

關注策略ID列表，JSON數組格式。
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

返回消息。
Data Object

返回結果集。
WatchTaskId String 304E63XXXX

觀察任務ID。

示例

請求示例

http(s)://[Endpoint]/?Action=CreateWatchTask
&CorpId=44B0E0XXXX
&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

<CreateWatchTaskResponse>
    <RequestId>46329898-489C-4E63-9BA1-C1DA5C5D0986</RequestId>
    <Success>true</Success>
    <Code>200</Code>
    <Message>OK</Message>
    <Data>
        <WatchTaskId>304E63XXXX</WatchTaskId>
    </Data>
</CreateWatchTaskResponse>

JSON格式 

HTTP/1.1 200 OK
Content-Type:application/json

{
  "RequestId" : "46329898-489C-4E63-9BA1-C1DA5C5D0986",
  "Success" : true,
  "Code" : "200",
  "Message" : "OK",
  "Data" : {
    "WatchTaskId" : "304E63XXXX"
  }
}

錯誤碼

訪問錯誤中心查看更多錯誤碼。