GetSyncJob - AWS IoT TwinMaker

本文属于机器翻译版本。若本译文内容与英语原文存在差异,则一律以英文原文为准。

GetSyncJob

获取 SyncJob.

请求语法

GET /sync-jobs/syncSource?workspace=workspaceId HTTP/1.1

URI 请求参数

请求使用以下 URI 参数。

syncSource

同步源。

注意

目前唯一支持的 syncSource 是 SITEWISE

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

必需:是

workspaceId

工作区 ID。

长度限制:长度下限为 1。长度上限为 128。

模式:[a-zA-Z_0-9][a-zA-Z_\-0-9]*[a-zA-Z0-9]+

请求正文

该请求没有请求正文。

响应语法

HTTP/1.1 200 Content-type: application/json { "arn": "string", "creationDateTime": number, "status": { "error": { "code": "string", "message": "string" }, "state": "string" }, "syncRole": "string", "syncSource": "string", "updateDateTime": number, "workspaceId": "string" }

响应元素

如果此操作成功,则该服务将会发送回 HTTP 200 响应。

服务以 JSON 格式返回以下数据。

arn

同步工作 ARN。

类型:字符串

长度约束:最小长度为 20。最大长度为 2048。

模式:arn:((aws)|(aws-cn)|(aws-us-gov)):iottwinmaker:[a-z0-9-]+:[0-9]{12}:[\/a-zA-Z0-9_\-\.:]+

creationDateTime

创建日期和时间。

类型:时间戳

status

SyncJob 响应状态。

类型:SyncJobStatus 对象

syncRole

同步 IAM 角色。

类型:字符串

长度约束:最小长度为 20。最大长度为 2048。

模式:arn:((aws)|(aws-cn)|(aws-us-gov)):iam::[0-9]{12}:role/.*

syncSource

同步源。

注意

目前唯一支持的 syncSource 是 SITEWISE

类型:字符串

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

updateDateTime

更新日期和时间。

类型:时间戳

workspaceId

包含同步任务的工作区 ID。

类型:字符串

长度限制:长度下限为 1。长度上限为 128。

模式:[a-zA-Z_0-9][a-zA-Z_\-0-9]*[a-zA-Z0-9]+

错误

有关所有操作的常见错误信息,请参阅常见错误

AccessDeniedException

访问被拒绝。

HTTP 状态代码:403

InternalServerException

出现意外错误。

HTTP 状态代码:500

ResourceNotFoundException

未找到资源。

HTTP 状态代码:404

ServiceQuotaExceededException

已超出服务限额。

HTTP 状态代码:402

ThrottlingException

速率超过限制。

HTTP 状态代码:429

ValidationException

失败

HTTP 状态代码:400

另请参阅

有关在特定语言的 AWS SDK 中使用此 API 的更多信息,请参阅以下内容: