AWS IoT
开发人员指南
AWS 文档中描述的 AWS 服务或功能可能因区域而异。要查看适用于中国区域的差异,请参阅 Amazon AWS 入门

ListJobs

ListJobs

列出任务。

https

请求语法:

GET /jobs?status=status&targetSelection=targetSelection&maxResults=maxResults&nextToken=nextToken&thingGroupName=thingGroupName&thingGroupId=thingGroupId

URI 请求参数:

名称

类型

请求?

描述

status

JobStatus

一个可选筛选条件,允许您搜索具有指定状态的任务。

targetSelection

TargetSelection

指定任务将继续运行 (CONTINUOUS),还是在指定作为目标的所有事物完成任务之后完成 (SNAPSHOT)。如果继续运行,则在检测到目标中出现更改时,任务也会在事物上运行。例如,当某个事物添加到目标组时会在该事物上运行任务,即使是组中原有的全部事物已经完成了任务。

maxResults

LaserMaxResults

每个请求返回的最大结果数。

nextToken

NextToken

用于检索下一组结果的令牌。

thingGroupName

ThingGroupName

一个筛选条件,用于将返回的任务限制为指定组的任务。

thingGroupId

ThingGroupId

一个筛选条件,用于将返回的任务限制为指定组的任务。

响应语法:

Content-type: application/json { "jobs": [ { "jobArn": "string", "jobId": "string", "thingGroupId": "string", "targetSelection": "string", "status": "string", "createdAt": "timestamp", "lastUpdatedAt": "timestamp", "completedAt": "timestamp" } ], "nextToken": "string" }

响应正文参数:

名称

类型

请求?

描述

jobs

JobSummaryList

任务列表。

nextToken

NextToken

下一组结果的令牌,没有更多结果时为 null

错误:

InvalidRequestException

请求的内容无效。例如,UpdateJobExecution 请求包含无效状态详细信息时,将返回此代码。消息包含有关错误的详细信息。

HTTP 响应代码:400

ResourceNotFoundException

指定的资源不存在。

HTTP 响应代码:404

ThrottlingException

速率超过限制。

HTTP 响应代码:429

ServiceUnavailableException

服务暂时不可用。

HTTP 响应代码:503

cli

摘要:

aws iot list-jobs \ [--status <value>] \ [--target-selection <value>] \ [--max-results <value>] \ [--next-token <value>] \ [--thing-group-name <value>] \ [--thing-group-id <value>] \ [--cli-input-json <value>] \ [--generate-cli-skeleton]

cli-input-json format:

{ "status": "string", "targetSelection": "string", "maxResults": "integer", "nextToken": "string", "thingGroupName": "string", "thingGroupId": "string" }

cli-input-json 字段:

名称

类型

描述

status

字符串

一个可选筛选条件,允许您搜索具有指定状态的任务。

枚举:IN_PROGRESS | CANCELED | COMPLETED

targetSelection

字符串

指定任务将继续运行 (CONTINUOUS),还是在指定作为目标的所有事物完成任务之后完成 (SNAPSHOT)。如果继续运行,则在检测到目标中出现更改时,任务也会在事物上运行。例如,当某个事物添加到目标组时会在该事物上运行任务,即使是组中原有的全部事物已经完成了任务。

枚举:CONTINUOUS | SNAPSHOT

maxResults

integer

范围 - 最大值:250,最小值:1

每个请求返回的最大结果数。

nextToken

字符串

用于检索下一组结果的令牌。

thingGroupName

字符串

最大长度:128,最小长度:1

模式:[a-zA-Z0-9:_-]+

一个筛选条件,用于将返回的任务限制为指定组的任务。

thingGroupId

字符串

最大长度:128,最小长度:1

模式:[a-zA-Z0-9-]+

一个筛选条件,用于将返回的任务限制为指定组的任务。

输出:

{ "jobs": [ { "jobArn": "string", "jobId": "string", "thingGroupId": "string", "targetSelection": "string", "status": "string", "createdAt": "timestamp", "lastUpdatedAt": "timestamp", "completedAt": "timestamp" } ], "nextToken": "string" }

cli 输出字段:

名称

类型

描述

jobs

列表

成员:Job Summary

java 类:java.util.List

任务列表。

jobArn

字符串

任务 ARN。

jobId

字符串

最大长度:64,最小长度:1

模式:[a-zA-Z0-9_-]+

您在创建此任务时向其分配的唯一标识符。

thingGroupId

字符串

最大长度:128,最小长度:1

模式:[a-zA-Z0-9-]+

事物组的 ID。

targetSelection

字符串

指定任务将继续运行 (CONTINUOUS),还是在指定作为目标的所有事物完成任务之后完成 (SNAPSHOT)。如果继续运行,则在检测到目标中出现更改时,任务也会在事物上运行。例如,当某个事物添加到目标组时会在该事物上运行任务,即使是组中原有的全部事物已经完成了任务。

枚举:CONTINUOUS | SNAPSHOT

status

字符串

任务摘要状态。

枚举:IN_PROGRESS | CANCELED | COMPLETED

createdAt

timestamp

创建任务的时间,用从纪元开始的毫秒数表示。

lastUpdatedAt

timestamp

上次更新任务的时间,用从纪元开始的毫秒数表示。

completedAt

timestamp

完成任务的时间,用从纪元开始的毫秒数表示。

nextToken

字符串

下一组结果的令牌,没有更多结果时为 null

错误:

InvalidRequestException

请求的内容无效。例如,UpdateJobExecution 请求包含无效状态详细信息时,将返回此代码。消息包含有关错误的详细信息。

ResourceNotFoundException

指定的资源不存在。

ThrottlingException

速率超过限制。

ServiceUnavailableException

服务暂时不可用。