查看观察任务。

调试

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

请求参数

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

系统规定参数。取值：DescribeWatchTasks。

PageNumber Long 是 1

获取第几个分页。
PageSize Long 是 10

获取的分页大小。最大100
WatchTaskIds String 否 ["C1DAXXXX", "C5D0XXXX"]

观察任务ID列表，JSON数组格式，一次最多输入100个ID。不指定时，返回本账号下的全部任务。

返回数据

名称 类型 示例值 描述
RequestId String 46329898-489C-4E63-9BA1-C1DA5C5D0986

请求ID。
Success Boolean true

是否调用成功。
Code String 200

响应 code。
Message String OK

返回消息。
Data Object

返回结果数据
TotalCount Long 10

结果总数。
PageSize Long 10

每个分页大小。
PageNumber Long 1

当前是第几个分页。
Records Array of Record

数组。
WatchTaskId String 304E63XXXX

任务ID。
TaskName String example

任务名称。
CorpId String 44B0E0XXXX

所属项目ID。
DeviceList String ["1C44674CC97AXXXX", "915E4ACA5866XXXX"]

设备ID列表，JSON数组样式。
ScheduleType String EVERYDAY

调度类型，取值范围：

ONCE：仅执行一次

EVERYDAY：每天定时执行，

EVERY_WEEK：周计划，

EVERY_MONTH：月计划

LONG_RUNNING：持续执行
ScheduleCycleDates String [1, 4, 6]

JSON数组格式。含义随ScheduleType取值不同。

EVERY_MONTH：每个数字代表月内某一天。比如1,20,25,28表示每月1日、20日、25日、28日。

EVERY_WEEK： 每个数字代表周内某一天。比如1, 4, 6表示每周周一、周四、周六。

ScheduleTimes String [{"StartTime":"10:00:00","EndTime":"11:00:00"}]

执行时间段，以JSON格式填写StartTime和EndTime，格式为时分秒（HH:mm:ss）。
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 字段。
Description String 闯入敏感区域

描述。

示例

请求示例

http(s)://[Endpoint]/?Action=DescribeWatchTasks
&PageNumber=1
&PageSize=10
&WatchTaskIds=["C1DAXXXX", "C5D0XXXX"]
&公共请求参数

正常返回示例

XML格式 

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

<DescribeWatchTasksResponse>
    <RequestId>46329898-489C-4E63-9BA1-C1DA5C5D0986</RequestId>
    <Success>true</Success>
    <Code>200</Code>
    <Message>OK</Message>
    <Data>
        <TotalCount>10</TotalCount>
        <PageSize>10</PageSize>
        <PageNumber>1</PageNumber>
        <Records>
            <WatchTaskId>304E63XXXX</WatchTaskId>
            <TaskName>example</TaskName>
            <CorpId>44B0E0XXXX</CorpId>
            <DeviceList>["1C44674CC97AXXXX", "915E4ACA5866XXXX"]</DeviceList>
            <ScheduleType>EVERYDAY</ScheduleType>
            <ScheduleCycleDates>[1, 4, 6]</ScheduleCycleDates>
            <ScheduleTimes>[{"StartTime":"10:00:00","EndTime":"11:00:00"}]</ScheduleTimes>
            <WatchPolicyIds>["30fXXXX","7c8XXXX","b48XXXX"]</WatchPolicyIds>
            <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"     }   } }</MessageReceiver>
            <Description>闯入敏感区域</Description>
        </Records>
    </Data>
</DescribeWatchTasksResponse>

JSON格式 

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

{
  "RequestId" : "46329898-489C-4E63-9BA1-C1DA5C5D0986",
  "Success" : true,
  "Code" : "200",
  "Message" : "OK",
  "Data" : {
    "TotalCount" : 10,
    "PageSize" : 10,
    "PageNumber" : 1,
    "Records" : [ {
      "WatchTaskId" : "304E63XXXX",
      "TaskName" : "example",
      "CorpId" : "44B0E0XXXX",
      "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\"     }   } }",
      "Description" : "闯入敏感区域"
    } ]
  }
}

错误码

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