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

# GetSyncJob
<a name="API_GetSyncJob"></a>

获取 SyncJob.

## 请求语法
<a name="API_GetSyncJob_RequestSyntax"></a>

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

## URI 请求参数
<a name="API_GetSyncJob_RequestParameters"></a>

请求使用以下 URI 参数。

 ** [syncSource](#API_GetSyncJob_RequestSyntax) **   <a name="tm-GetSyncJob-request-uri-syncSource"></a>
同步源。  
目前唯一支持的 syncSource 是 `SITEWISE `。
模式：`[a-zA-Z_0-9]+`  
是否必需：是

 ** [workspaceId](#API_GetSyncJob_RequestSyntax) **   <a name="tm-GetSyncJob-request-uri-workspaceId"></a>
工作区 ID。  
长度限制：最小长度为 1。最大长度为 128。  
模式：`[a-zA-Z_0-9][a-zA-Z_\-0-9]*[a-zA-Z0-9]+`

## 请求正文
<a name="API_GetSyncJob_RequestBody"></a>

该请求没有请求正文。

## 响应语法
<a name="API_GetSyncJob_ResponseSyntax"></a>

```
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"
}
```

## 响应元素
<a name="API_GetSyncJob_ResponseElements"></a>

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

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

 ** [arn](#API_GetSyncJob_ResponseSyntax) **   <a name="tm-GetSyncJob-response-arn"></a>
同步工作 ARN。  
类型：字符串  
长度约束：最小长度为 20。最大长度为 2048。  
模式：`arn:((aws)|(aws-cn)|(aws-us-gov)):iottwinmaker:[a-z0-9-]+:[0-9]{12}:[\/a-zA-Z0-9_\-\.:]+`

 ** [creationDateTime](#API_GetSyncJob_ResponseSyntax) **   <a name="tm-GetSyncJob-response-creationDateTime"></a>
创建日期和时间。  
类型：时间戳

 ** [status](#API_GetSyncJob_ResponseSyntax) **   <a name="tm-GetSyncJob-response-status"></a>
 SyncJob 响应状态。  
类型：[SyncJobStatus](API_SyncJobStatus.md) 对象

 ** [syncRole](#API_GetSyncJob_ResponseSyntax) **   <a name="tm-GetSyncJob-response-syncRole"></a>
同步 IAM 角色。  
类型：字符串  
长度约束：最小长度为 20。最大长度为 2048。  
模式：`arn:((aws)|(aws-cn)|(aws-us-gov)):iam::[0-9]{12}:role/.*`

 ** [syncSource](#API_GetSyncJob_ResponseSyntax) **   <a name="tm-GetSyncJob-response-syncSource"></a>
同步源。  
目前唯一支持的 syncSource 是 `SITEWISE`。
类型：字符串  
模式：`[a-zA-Z_0-9]+`

 ** [updateDateTime](#API_GetSyncJob_ResponseSyntax) **   <a name="tm-GetSyncJob-response-updateDateTime"></a>
更新日期和时间。  
类型：时间戳

 ** [workspaceId](#API_GetSyncJob_ResponseSyntax) **   <a name="tm-GetSyncJob-response-workspaceId"></a>
包含同步任务的工作区 ID。  
类型：字符串  
长度限制：最小长度为 1。最大长度为 128。  
模式：`[a-zA-Z_0-9][a-zA-Z_\-0-9]*[a-zA-Z0-9]+`

## 错误
<a name="API_GetSyncJob_Errors"></a>

有关所有操作的常见错误的信息，请参阅[常见错误类型](CommonErrors.md)。

 ** AccessDeniedException **   
访问被拒绝。  
HTTP 状态代码：403

 ** InternalServerException **   
出现意外错误。  
HTTP 状态代码：500

 ** ResourceNotFoundException **   
未找到资源。  
HTTP 状态代码：404

 ** ServiceQuotaExceededException **   
已超出服务限额。  
HTTP 状态代码：402

 ** ThrottlingException **   
速率超过限制。  
HTTP 状态代码：429

 ** ValidationException **   
失败  
HTTP 状态代码：400

## 另请参阅
<a name="API_GetSyncJob_SeeAlso"></a>

有关以特定语言之一使用此 API 的更多信息 AWS SDKs，请参阅以下内容：
+  [AWS 命令行界面 V2](https://docs.aws.amazon.com/goto/cli2/iottwinmaker-2021-11-29/GetSyncJob) 
+  [AWS 适用于.NET 的 SDK V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/iottwinmaker-2021-11-29/GetSyncJob) 
+  [AWS 适用于 C\$1\$1 的 SDK](https://docs.aws.amazon.com/goto/SdkForCpp/iottwinmaker-2021-11-29/GetSyncJob) 
+  [AWS 适用于 Go v2 的 SDK](https://docs.aws.amazon.com/goto/SdkForGoV2/iottwinmaker-2021-11-29/GetSyncJob) 
+  [AWS 适用于 Java 的 SDK V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/iottwinmaker-2021-11-29/GetSyncJob) 
+  [AWS JavaScript V3 版软件开发工具包](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/iottwinmaker-2021-11-29/GetSyncJob) 
+  [AWS 适用于 Kotlin 的 SDK](https://docs.aws.amazon.com/goto/SdkForKotlin/iottwinmaker-2021-11-29/GetSyncJob) 
+  [AWS 适用于 PHP 的 SDK V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/iottwinmaker-2021-11-29/GetSyncJob) 
+  [AWS Python 软件开发工具包](https://docs.aws.amazon.com/goto/boto3/iottwinmaker-2021-11-29/GetSyncJob) 
+  [AWS 适用于 Ruby V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForRubyV3/iottwinmaker-2021-11-29/GetSyncJob)