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

DescribeJobExecution

描述任务执行。

请求语法:

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

URI 请求参数:

名称

类型

请求?

描述

jobId

JobId

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

thingName

ThingName

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

executionNumber

ExecutionNumber

一个由从“0”到“9”的数字组成的字符串,用于指定特定设备上的特定任务执行。

响应语法:

Content-type: application/json { "execution": { "jobId": "string", "status": "string", "statusDetails": { "detailsMap": { "string": "string" } }, "thingArn": "string", "queuedAt": "timestamp", "startedAt": "timestamp", "lastUpdatedAt": "timestamp", "executionNumber": "long" } }

响应正文参数:

名称

类型

请求?

描述

execution

JobExecution

任务执行的相关信息。

错误:

InvalidRequestException

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

HTTP 响应代码:400

ResourceNotFoundException

指定的资源不存在。

HTTP 响应代码:404

ThrottlingException

速率超过限制。

HTTP 响应代码:429

ServiceUnavailableException

服务暂时不可用。

HTTP 响应代码:503

CLI

摘要:

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

cli-input-json format:

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

cli-input-json 字段:

名称

类型

描述

jobId

字符串

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

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

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

thingName

字符串

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

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

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

executionNumber

long

java 类:java.lang.Long

一个由从“0”到“9”的数字组成的字符串,用于指定特定设备上的特定任务执行。

输出:

{ "execution": { "jobId": "string", "status": "string", "statusDetails": { "detailsMap": { "string": "string" } }, "thingArn": "string", "queuedAt": "timestamp", "startedAt": "timestamp", "lastUpdatedAt": "timestamp", "executionNumber": "long" } }

cli 输出字段:

名称

类型

描述

execution

JobExecution

任务执行的相关信息。

jobId

字符串

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

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

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

status

字符串

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

java 类:com.amazonaws.iot.laser.common.JobExecutionStatus

任务执行的状态 (IN_PROGRESS、QUEUED、FAILED、SUCCESS、CANCELED 或 REJECTED)。

statusDetails

JobExecutionStatusDetails

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

detailsMap

map

键:DetailsKey

值:DetailsValue

任务执行状态。

DetailsKey

字符串

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

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

DetailsValue

字符串

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

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

thingArn

字符串

正在运行任务执行的事物的 ARN。

queuedAt

timestamp

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

startedAt

timestamp

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

lastUpdatedAt

timestamp

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

executionNumber

long

java 类:java.lang.Long

一个由从“0”到“9”的数字组成的字符串,用于标识此特定设备上的该特定任务执行。它可在返回或更新任务执行信息的命令中使用。

本页内容: