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

# GetEntity
<a name="API_GetEntity"></a>

检索有关实体的信息。

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

```
GET /workspaces/workspaceId/entities/entityId HTTP/1.1
```

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

请求使用以下 URI 参数。

 ** [entityId](#API_GetEntity_RequestSyntax) **   <a name="tm-GetEntity-request-uri-entityId"></a>
实体的 ID。  
长度限制：最小长度为 1。最大长度为 128。  
模式：`[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}|^[a-zA-Z0-9][a-zA-Z_\-0-9.:]*[a-zA-Z0-9]+`  
是否必需：是

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

## 请求体
<a name="API_GetEntity_RequestBody"></a>

该请求没有请求正文。

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

```
HTTP/1.1 200
Content-type: application/json

{
   "areAllComponentsReturned": boolean,
   "arn": "string",
   "components": { 
      "string" : { 
         "areAllCompositeComponentsReturned": boolean,
         "areAllPropertiesReturned": boolean,
         "componentName": "string",
         "componentTypeId": "string",
         "compositeComponents": { 
            "string" : { 
               "componentName": "string",
               "componentPath": "string",
               "componentTypeId": "string",
               "definedIn": "string",
               "description": "string",
               "propertyGroups": { 
                  "string" : { 
                     "groupType": "string",
                     "isInherited": boolean,
                     "propertyNames": [ "string" ]
                  }
               },
               "status": { 
                  "error": { 
                     "code": "string",
                     "message": "string"
                  },
                  "state": "string"
               },
               "syncSource": "string"
            }
         },
         "definedIn": "string",
         "description": "string",
         "properties": { 
            "string" : { 
               "areAllPropertyValuesReturned": boolean,
               "definition": { 
                  "configuration": { 
                     "string" : "string" 
                  },
                  "dataType": { 
                     "allowedValues": [ 
                        { 
                           "booleanValue": boolean,
                           "doubleValue": number,
                           "expression": "string",
                           "integerValue": number,
                           "listValue": [ 
                              "DataValue"
                           ],
                           "longValue": number,
                           "mapValue": { 
                              "string" : "DataValue"
                           },
                           "relationshipValue": { 
                              "targetComponentName": "string",
                              "targetEntityId": "string"
                           },
                           "stringValue": "string"
                        }
                     ],
                     "nestedType": "DataType",
                     "relationship": { 
                        "relationshipType": "string",
                        "targetComponentTypeId": "string"
                     },
                     "type": "string",
                     "unitOfMeasure": "string"
                  },
                  "defaultValue": { 
                     "booleanValue": boolean,
                     "doubleValue": number,
                     "expression": "string",
                     "integerValue": number,
                     "listValue": [ 
                        "DataValue"
                     ],
                     "longValue": number,
                     "mapValue": { 
                        "string" : "DataValue"
                     },
                     "relationshipValue": { 
                        "targetComponentName": "string",
                        "targetEntityId": "string"
                     },
                     "stringValue": "string"
                  },
                  "displayName": "string",
                  "isExternalId": boolean,
                  "isFinal": boolean,
                  "isImported": boolean,
                  "isInherited": boolean,
                  "isRequiredInEntity": boolean,
                  "isStoredExternally": boolean,
                  "isTimeSeries": boolean
               },
               "value": { 
                  "booleanValue": boolean,
                  "doubleValue": number,
                  "expression": "string",
                  "integerValue": number,
                  "listValue": [ 
                     "DataValue"
                  ],
                  "longValue": number,
                  "mapValue": { 
                     "string" : "DataValue"
                  },
                  "relationshipValue": { 
                     "targetComponentName": "string",
                     "targetEntityId": "string"
                  },
                  "stringValue": "string"
               }
            }
         },
         "propertyGroups": { 
            "string" : { 
               "groupType": "string",
               "isInherited": boolean,
               "propertyNames": [ "string" ]
            }
         },
         "status": { 
            "error": { 
               "code": "string",
               "message": "string"
            },
            "state": "string"
         },
         "syncSource": "string"
      }
   },
   "creationDateTime": number,
   "description": "string",
   "entityId": "string",
   "entityName": "string",
   "hasChildEntities": boolean,
   "parentEntityId": "string",
   "status": { 
      "error": { 
         "code": "string",
         "message": "string"
      },
      "state": "string"
   },
   "syncSource": "string",
   "updateDateTime": number,
   "workspaceId": "string"
}
```

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

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

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

 ** [areAllComponentsReturned](#API_GetEntity_ResponseSyntax) **   <a name="tm-GetEntity-response-areAllComponentsReturned"></a>
此标记注明 API 响应中是否返回了所有组件。返回的最大组件数为 30。  
类型：布尔值

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

 ** [components](#API_GetEntity_ResponseSyntax) **   <a name="tm-GetEntity-response-components"></a>
将字符串映射到实体中的组件的对象。映射中的每个字符串对于该对象都必须是唯一的。  
类型：字符串到 [ComponentResponse](API_ComponentResponse.md) 对象的映射  
密钥长度限制：最小长度为 1。最大长度为 256。  
键模式：`[a-zA-Z_\-0-9]+`

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

 ** [description](#API_GetEntity_ResponseSyntax) **   <a name="tm-GetEntity-response-description"></a>
实体的描述。  
类型：字符串  
长度约束：最小长度为 0。最大长度为 2048。  
模式：`.*`

 ** [entityId](#API_GetEntity_ResponseSyntax) **   <a name="tm-GetEntity-response-entityId"></a>
实体的 ID。  
类型：字符串  
长度限制：最小长度为 1。最大长度为 128。  
模式：`[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}|^[a-zA-Z0-9][a-zA-Z_\-0-9.:]*[a-zA-Z0-9]+`

 ** [entityName](#API_GetEntity_ResponseSyntax) **   <a name="tm-GetEntity-response-entityName"></a>
实体名称。  
类型：字符串  
长度限制：最小长度为 1。最大长度为 256。  
模式：`[^\u0000-\u001F\u007F]+`

 ** [hasChildEntities](#API_GetEntity_ResponseSyntax) **   <a name="tm-GetEntity-response-hasChildEntities"></a>
指定实体是否关联了子实体的布尔值。  
类型：布尔值

 ** [parentEntityId](#API_GetEntity_ResponseSyntax) **   <a name="tm-GetEntity-response-parentEntityId"></a>
该实体的父实体的 ID。  
类型：字符串  
长度限制：最小长度为 1。最大长度为 128。  
模式：`\$ROOT|^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}|^[a-zA-Z0-9][a-zA-Z_\-0-9.:]*[a-zA-Z0-9]+`

 ** [status](#API_GetEntity_ResponseSyntax) **   <a name="tm-GetEntity-response-status"></a>
实体的当前状态。  
类型：[Status](API_Status.md) 对象

 ** [syncSource](#API_GetEntity_ResponseSyntax) **   <a name="tm-GetEntity-response-syncSource"></a>
同步作业的 syncSource（如果该实体是由同步作业创建的）。  
类型：字符串  
模式：`[a-zA-Z_0-9]+`

 ** [updateDateTime](#API_GetEntity_ResponseSyntax) **   <a name="tm-GetEntity-response-updateDateTime"></a>
上次更新实体的日期和时间。  
类型：时间戳

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

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

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

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

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

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

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

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

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

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