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

# ListProperties
<a name="API_ListProperties"></a>

此 API 列出了组件的属性。

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

```
POST /workspaces/workspaceId/properties-list HTTP/1.1
Content-type: application/json

{
   "componentName": "string",
   "componentPath": "string",
   "entityId": "string",
   "maxResults": number,
   "nextToken": "string"
}
```

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

请求使用以下 URI 参数。

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

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

请求接受采用 JSON 格式的以下数据。

 ** [componentName](#API_ListProperties_RequestSyntax) **   <a name="tm-ListProperties-request-componentName"></a>
操作返回其属性的组件名称。  
类型：字符串  
长度限制：最小长度为 1。最大长度为 256。  
模式：`[a-zA-Z_\-0-9]+`  
必需：否

 ** [componentPath](#API_ListProperties_RequestSyntax) **   <a name="tm-ListProperties-request-componentPath"></a>
此字符串指定从顶层组件开始的复合组件路径。  
类型：字符串  
长度限制：最小长度为 1。最大长度为 2048。  
模式：`[a-zA-Z_\-0-9/]+`  
必需：否

 ** [entityId](#API_ListProperties_RequestSyntax) **   <a name="tm-ListProperties-request-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]+`  
是否必需：是

 ** [maxResults](#API_ListProperties_RequestSyntax) **   <a name="tm-ListProperties-request-maxResults"></a>
一次性返回的最大结果数。默认值为 25。  
类型：整数  
有效范围：最小值为 0。最大值为 200。  
必需：否

 ** [nextToken](#API_ListProperties_RequestSyntax) **   <a name="tm-ListProperties-request-nextToken"></a>
指定下一页结果的字符串。  
类型：字符串  
长度限制：最小长度为 0。最大长度为 17880。  
模式：`.*`  
必需：否

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

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

{
   "nextToken": "string",
   "propertySummaries": [ 
      { 
         "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
         },
         "propertyName": "string",
         "value": { 
            "booleanValue": boolean,
            "doubleValue": number,
            "expression": "string",
            "integerValue": number,
            "listValue": [ 
               "DataValue"
            ],
            "longValue": number,
            "mapValue": { 
               "string" : "DataValue"
            },
            "relationshipValue": { 
               "targetComponentName": "string",
               "targetEntityId": "string"
            },
            "stringValue": "string"
         }
      }
   ]
}
```

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

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

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

 ** [nextToken](#API_ListProperties_ResponseSyntax) **   <a name="tm-ListProperties-response-nextToken"></a>
指定下一页属性结果的字符串。  
类型：字符串  
长度限制：最小长度为 0。最大长度为 17880。  
模式：`.*`

 ** [propertySummaries](#API_ListProperties_ResponseSyntax) **   <a name="tm-ListProperties-response-propertySummaries"></a>
包含属性信息的对象列表。  
类型：[PropertySummary](API_PropertySummary.md) 对象数组

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

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

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

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

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

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

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

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

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