任务设备 HTTP API - Amazon IoT Core
Amazon Web Services 文档中描述的 Amazon Web Services 服务或功能可能因区域而异。要查看适用于中国区域的差异,请参阅中国的 Amazon Web Services 服务入门

任务设备 HTTP API

设备可以使用端口443 上的 HTTP 签名版本 4 与 Amazon IoT Jobs 通信。这是由Amazon SDK 和 CLI 使用的方法。有关这些工具的更多信息,请参阅 Amazon CLI 命令引用:iot-jobs-dataAmazon SDK 和工具

以下命令可用于执行任务的设备。有关将 API 操作与 MQTT 协议结合使用的信息,请参阅任务设备 MQTT API

针对指定的事物,获取未处于最终状态的所有任务的列表。

HTTPS request
GET /things/thingName/jobs

响应:

{ "inProgressJobs" : [ JobExecutionSummary ... ], "queuedJobs" : [ JobExecutionSummary ... ] }

有关更多信息,请参阅GetPendingJobExecutions

CLI syntax
aws iot-jobs-data get-pending-job-executions \ --thing-name <value> \ [--cli-input-json <value>] \ [--generate-cli-skeleton]

cli-input-json 格式:

{ "thingName": "string" }

有关更多信息,请参阅get-pending-job-executions

获取并启动事物的下一个待处理任务执行(状态为 IN_PROGRESSQUEUED)。

  • 首先返回状态为 IN_PROGRESS 的所有任务执行。

  • 按任务执行的创建顺序返回这些执行。

  • 如果下一个待处理任务执行的状态为 QUEUED,则其状态将更改为 IN_PROGRESS,并且任务执行的状态详细信息将设定为指定内容。

  • 如果下一个待处理任务执行已处于 IN_PROGRESS 状态,其状态详细信息不会发生变化。

  • 如果没有待处理的任务执行,则响应不包括 execution 字段。

  • (可选)您可以通过为 stepTimeoutInMinutes 属性设置值来创建步骤计时器。如果您没有通过运行 UpdateJobExecution 更新此属性的值,任务执行将在步骤计时器到期时超时。

HTTPS request

以下示例显示请求语法:

PUT /things/thingName/jobs/$next { "statusDetails": { "string": "string" ... }, "stepTimeoutInMinutes": long }

有关更多信息,请参阅StartNextPendingJobExecution

CLI syntax

摘要:

aws iot-jobs-data start-next-pending-job-execution \ --thing-name <value> \ {--step-timeout-in-minutes <value>] \ [--status-details <value>] \ [--cli-input-json <value>] \ [--generate-cli-skeleton]

cli-input-json 格式:

{ "thingName": "string", "statusDetails": { "string": "string" }, "stepTimeoutInMinutes": long }

有关更多信息,请参阅start-next-pending-job-execution

获取有关任务执行的详细信息。

您可以将 jobId 设置为 $next 以返回事物的下一个待处理任务执行。任务的执行状态必须为 QUEUEDIN_PROGRESS

HTTPS request

请求:

GET /things/thingName/jobs/jobId?executionNumber=executionNumber&includeJobDocument=includeJobDocument

响应:

{ "execution" : JobExecution, }

有关更多信息,请参阅DescribeJobExecution

CLI syntax

摘要:

aws iot-jobs-data describe-job-execution \ --job-id <value> \ --thing-name <value> \ [--include-job-document | --no-include-job-document] \ [--execution-number <value>] \ [--cli-input-json <value>] \ [--generate-cli-skeleton]

cli-input-json 格式:

{ "jobId": "string", "thingName": "string", "includeJobDocument": boolean, "executionNumber": long }

有关更多信息,请参阅describe-job-execution

更新任务执行的状态。(可选)您可以通过为 stepTimeoutInMinutes 属性设置值来创建步骤计时器。如果您没有通过再次运行 UpdateJobExecution 更新此属性的值,任务执行将在步骤计时器到期时超时。

HTTPS request

请求:

POST /things/thingName/jobs/jobId { "status": "job-execution-state", "statusDetails": { "string": "string" ... }, "expectedVersion": "number", "includeJobExecutionState": boolean, "includeJobDocument": boolean, "stepTimeoutInMinutes": long, "executionNumber": long }

有关更多信息,请参阅UpdateJobExecution

CLI syntax

摘要:

aws iot-jobs-data update-job-execution \ --job-id <value> \ --thing-name <value> \ --status <value> \ [--status-details <value>] \ [--expected-version <value>] \ [--include-job-execution-state | --no-include-job-execution-state] \ [--include-job-document | --no-include-job-document] \ [--execution-number <value>] \ [--cli-input-json <value>] \ [--step-timeout-in-minutes <value>] \ [--generate-cli-skeleton]

cli-input-json 格式:

{ "jobId": "string", "thingName": "string", "status": "string", "statusDetails": { "string": "string" }, "stepTimeoutInMinutes": number, "expectedVersion": long, "includeJobExecutionState": boolean, "includeJobDocument": boolean, "executionNumber": long }

有关更多信息,请参阅update-job-execution