AWS IoT
开发人员指南
AWS 服务或AWS文档中描述的功能,可能因地区/位置而异。请点击 Amazon AWS 入门,可查看中国地区的具体差异

DescribeJob

描述任务。

请求语法:

GET /jobs/jobId

URI 请求参数:

名称

类型

请求?

描述

jobId

JobId

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

响应语法:

Content-type: application/json { "documentSource": "string", "job": { "jobArn": "string", "jobId": "string", "targetSelection": "string", "status": "string", "comment": "string", "targets": [ "string" ], "description": "string", "presignedUrlConfig": { "roleArn": "string", "expiresInSec": "long" }, "jobExecutionsRolloutConfig": { "maximumPerMinute": "integer" }, "createdAt": "timestamp", "lastUpdatedAt": "timestamp", "completedAt": "timestamp", "jobProcessDetails": { "processingTargets": [ "string" ], "numberOfCanceledThings": "integer", "numberOfSucceededThings": "integer", "numberOfFailedThings": "integer", "numberOfRejectedThings": "integer", "numberOfQueuedThings": "integer", "numberOfInProgressThings": "integer", "numberOfRemovedThings": "integer" }, "documentParameters": { "string": "string" } } }

响应正文参数:

名称

类型

请求?

描述

documentSource

JobDocumentSource

指向任务文档的 S3 链接。

任务

任务

该任务的相关信息。

错误:

InvalidRequestException

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

HTTP 响应代码:400

ResourceNotFoundException

指定的资源不存在。

HTTP 响应代码:404

ThrottlingException

速率超过限制。

HTTP 响应代码:429

ServiceUnavailableException

服务暂时不可用。

HTTP 响应代码:503

CLI

摘要:

aws iot describe-job \ --job-id <value> \ [--cli-input-json <value>] \ [--generate-cli-skeleton]

cli-input-json format:

{ "jobId": "string" }

cli-input-json 字段:

名称

类型

描述

jobId

字符串

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

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

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

输出:

{ "documentSource": "string", "job": { "jobArn": "string", "jobId": "string", "targetSelection": "string", "status": "string", "comment": "string", "targets": [ "string" ], "description": "string", "presignedUrlConfig": { "roleArn": "string", "expiresInSec": "long" }, "jobExecutionsRolloutConfig": { "maximumPerMinute": "integer" }, "createdAt": "timestamp", "lastUpdatedAt": "timestamp", "completedAt": "timestamp", "jobProcessDetails": { "processingTargets": [ "string" ], "numberOfCanceledThings": "integer", "numberOfSucceededThings": "integer", "numberOfFailedThings": "integer", "numberOfRejectedThings": "integer", "numberOfQueuedThings": "integer", "numberOfInProgressThings": "integer", "numberOfRemovedThings": "integer" }, "documentParameters": { "string": "string" } } }

cli 输出字段:

名称

类型

描述

documentSource

字符串

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

指向任务文档的 S3 链接。

任务

任务

该任务的相关信息。

jobArn

字符串

标识任务的 ARN,格式为“arn:aws:iot:region:account:job/jobId”。

jobId

字符串

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

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

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

targetSelection

字符串

枚举:CONTINUOUS | SNAPSHOT

java 类:com.amazonaws.iot.laser.TargetSelection

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

status

字符串

枚举:IN_PROGRESS | CANCELED | COMPLETED

java 类:ccom.amazonaws.iot.laser.common.JobStatus

任务的状态,为 IN_PROGRESSCANCELEDCOMPLETED 之一。

comment

字符串

最大长度:2028

模式:[^\\p{C}]+

如果任务已更新,介绍更新原因。

targets

列表

成员:TargetArn

任务应发送到的 IoT 事物和事物组的列表。

TargetArn

字符串

description

字符串

最大长度:2028

模式:[^\\p{C}]+

任务的简短文本描述。

presignedUrlConfig

PresignedUrlConfig

预签名 S3 URL 的配置。

roleArn

字符串

最大长度:2048,最小长度:20

IAM 角色的 ARN,该角色授予权限以从存储任务数据/更新的 S3 存储桶下载文件。该角色还必须授予 IoT 下载文件的权限。

expiresInSec

long

java 类:java.lang.Long

范围 – 最大值:3600,最小值:60

预签名 URL 的有效时间长度 (以秒为单位)。有效值为 60 – 3600,默认值为 3600 秒。预签名 URL 在 Jobs 接收任务文档的 MQTT 请求时生成。

jobExecutionsRolloutConfig

JobExecutionsRolloutConfig

允许您创建任务的分段部署。

maximumPerMinute

integer

java 类:java.lang.Integer

范围 – 最大值:1000,最小值:1

待处理任务每分钟通知事物的最大数量。此参数允许您创建分段部署。

createdAt

timestamp

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

lastUpdatedAt

timestamp

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

completedAt

timestamp

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

jobProcessDetails

JobProcessDetails

任务流程的详细信息。

processingTargets

列表

成员:ProcessingTargetName

java 类:java.util.List

执行任务的设备。

ProcessingTargetName

字符串

numberOfCanceledThings

integer

java 类:java.lang.Integer

取消了任务的事物数。

numberOfSucceededThings

integer

java 类:java.lang.Integer

成功完成任务的事物数。

numberOfFailedThings

integer

java 类:java.lang.Integer

任务执行失败的事物数。

numberOfRejectedThings

integer

java 类:java.lang.Integer

拒绝了任务的事物数。

numberOfQueuedThings

integer

java 类:java.lang.Integer

等待任务执行的事物数。

numberOfInProgressThings

integer

java 类:java.lang.Integer

当前正在执行任务的事物数。

numberOfRemovedThings

integer

java 类:java.lang.Integer

因其已从作为任务目标的组中被删除或移除而不再计划执行的事物的数量。

documentParameters

map

键:ParameterKey

值:ParameterValue

为任务文档指定的参数。

ParameterKey

字符串

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

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

ParameterValue

字符串

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

模式:[^\\p{C}]+

本页内容: