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

DescribeJobExecution

DescribeJobExecution

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

https

请求语法:

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

URI 请求参数:

名称

类型

请求?

描述

jobId

DescribeJobExecutionJobId

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

thingName

ThingName

与正在运行任务执行的设备关联的事物名称。

includeJobDocument

IncludeJobDocument

可选。设置为 true 时,响应将包含任务文档。默认为 false。

executionNumber

ExecutionNumber

可选。标识特定设备上的特定任务执行的数字。如果未指定,则返回最新的任务执行。

响应语法:

Content-type: application/json { "execution": { "jobId": "string", "thingName": "string", "status": "string", "statusDetails": { "string": "string" }, "queuedAt": "long", "startedAt": "long", "lastUpdatedAt": "long", "versionNumber": "long", "executionNumber": "long", "jobDocument": "string" } }

响应正文参数:

名称

类型

请求?

描述

execution

JobExecution

包含有关任务执行的数据。

错误:

InvalidRequestException

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

HTTP 响应代码:400

ResourceNotFoundException

指定的资源不存在。

HTTP 响应代码:404

ThrottlingException

速率超过限制。

HTTP 响应代码:429

ServiceUnavailableException

服务暂时不可用。

HTTP 响应代码:503

CertificateValidationException

证书无效。

HTTP 响应代码:400

TerminalStateException

任务处于最终状态。

HTTP 响应代码:410

cli

摘要:

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 format:

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

cli-input-json 字段:

名称

类型

描述

jobId

字符串

模式:[a-zA-Z0-9_-]+|^$next

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

thingName

字符串

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

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

与正在运行任务执行的设备关联的事物名称。

includeJobDocument

布尔值

可选。设置为 true 时,响应将包含任务文档。默认为 false。

executionNumber

long

可选。标识特定设备上的特定任务执行的数字。如果未指定,则返回最新的任务执行。

输出:

{ "execution": { "jobId": "string", "thingName": "string", "status": "string", "statusDetails": { "string": "string" }, "queuedAt": "long", "startedAt": "long", "lastUpdatedAt": "long", "versionNumber": "long", "executionNumber": "long", "jobDocument": "string" } }

cli 输出字段:

名称

类型

描述

execution

JobExecution

包含有关任务执行的数据。

jobId

字符串

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

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

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

thingName

字符串

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

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

正在执行任务的事物的名称。

status

字符串

任务执行的状态。可以为以下值之一:“QUEUED"、“IN_PROGRESS”、“FAILED”、“SUCCESS”、“CANCELED”、“REJECTED”或“REMOVED”。

枚举:QUEUED | IN_PROGRESS | SUCCEEDED | FAILED | REJECTED | REMOVED | CANCELED

statusDetails

map

描述任务执行状态的名称/值对的集合。

queuedAt

long

任务执行入队的时间,用从纪元开始的毫秒数表示。

startedAt

long

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

lastUpdatedAt

long

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

versionNumber

long

任务执行的版本。每次设备更新任务执行版本时,版本将递增。

executionNumber

long

标识特定设备上的特定任务执行的数字。它可随后在返回或更新任务执行信息的命令中使用。

jobDocument

字符串

最大长度:32768

任务文档的内容。

错误:

InvalidRequestException

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

ResourceNotFoundException

指定的资源不存在。

ThrottlingException

速率超过限制。

ServiceUnavailableException

服务暂时不可用。

CertificateValidationException

证书无效。

TerminalStateException

任务处于最终状态。