调用该接口查询指定任务下各状态作业的统计信息。

QPS限制

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

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

调试

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

请求参数

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

系统规定参数。取值：QueryJobStatistics。
JobId String 是 sGWotgRkut***10001

任务ID。任务的全局唯一标识符。
IotInstanceId String 否 iot-cn-0pp1n8t****

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

重要
  • 若有ID值，必须传入该ID值，否则调用会失败。
  • 若无ID值，则无需传入。

实例的更多信息，请参见实例概述。

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

返回数据

名称 类型 示例值 描述
Code String iot.system.SystemException

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

Data Struct

调用成功时，返回的作业状态详情，请参见以下参数说明。
Cancelled Integer 3

对应任务下被取消的作业总数量。
Failed Integer 1

对应任务下执行失败的作业总数量。
InProgress Integer 13

对应任务下执行中的作业总数量。
Queued Integer 2

对应任务下待执行的作业总数量。
Rejected Integer 1

对应任务下被设备拒绝的作业总数量。
Sent Integer 3

对应任务下处于已推送状态的作业总数量。
Succeeded Integer 22

对应任务下执行成功的作业总数量。
TimeOut Integer 5

对应任务下执行超时的作业总数量。
Total Integer 50

对应任务下的作业总数量。
ErrorMessage String 系统异常

调用失败时，返回的出错信息。
RequestId String 512FF8FD-A97F-4AAF-B0A2-7BE3D3A19BB3

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

表示是否调用成功。

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

示例

请求示例

http(s)://iot.cn-shanghai.aliyuncs.com/?Action=QueryJobStatistics
&JobId=sGWotgRkut***10001
&<公共请求参数>

正常返回示例

XML格式 

<QueryJobStatisticsResponse>
  <RequestId>512FF8FD-A97F-4AAF-B0A2-7BE3D3A19BB3</RequestId>
  <Data>
        <Succeeded>22</Succeeded>
        <inProgress>13</inProgress>
        <TimeOut>5</TimeOut>
        <Failed>1</Failed>
        <Total>50</Total>
        <Canceled>3</Canceled>
        <Rejected>1</Rejected>
        <Queued>2</Queued>
        <Sent>3</Sent>
  </Data>
  <Success>true</Success>
</QueryJobStatisticsResponse>

JSON格式 

{
    "RequestId": "512FF8FD-A97F-4AAF-B0A2-7BE3D3A19BB3",
    "Data": {
        "Succeeded": 22,
        "inProgress": 13,
        "TimeOut": 5,
        "Failed": 1,
        "Total": 50,
        "Canceled": 3,
        "Rejected": 1,
        "Queued": 2,
        "Sent": 3
    },
    "Success": true
}

错误码

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