本文属于机器翻译版本。若本译文内容与英语原文存在差异，则一律以英文原文为准。
ListProperties
此 API 列出了组件的属性。
请求语法
POST /workspaces/workspaceId/properties-list HTTP/1.1
Content-type: application/json
{
"componentName": "string",
"componentPath": "string",
"entityId": "string",
"maxResults": number,
"nextToken": "string"
}URI 请求参数
请求使用以下 URI 参数。
- workspaceId
-
工作区 ID。
长度限制：长度下限为 1。长度上限为 128。
模式：
[a-zA-Z_0-9][a-zA-Z_\-0-9]*[a-zA-Z0-9]+必需：是
请求体
请求接受采用 JSON 格式的以下数据。
- componentName
-
操作返回其属性的组件名称。
类型：字符串
长度限制：最小长度为 1。最大长度为 256。
模式：
[a-zA-Z_\-0-9]+必需：否
- componentPath
-
此字符串指定从顶层组件开始的复合组件路径。
类型：字符串
长度限制：最小长度为 0。最大长度为 2048。
模式：
[a-zA-Z_\-0-9/]+必需：否
- entityId
-
操作返回其元数据（组件/属性）的实体的 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
-
一次性返回的最大结果数。默认值为 25。
类型：整数
有效范围：最小值为 0。最大值为 200。
必需：否
- nextToken
-
指定下一页结果的字符串。
类型：字符串
长度约束：最小长度为 0。最大长度为 17880。
模式：
.*必需：否
响应语法
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"
}
}
]
}响应元素
如果此操作成功，则该服务将会发送回 HTTP 200 响应。
服务以 JSON 格式返回以下数据。
- nextToken
-
指定下一页属性结果的字符串。
类型：字符串
长度约束：最小长度为 0。最大长度为 17880。
模式：
.* - propertySummaries
-
包含属性信息的对象列表。
类型：PropertySummary 对象数组
错误
有关所有操作的常见错误信息，请参阅常见错误。
- AccessDeniedException
-
访问被拒绝。
HTTP 状态代码：403
- InternalServerException
-
出现意外错误。
HTTP 状态代码：500
- ResourceNotFoundException
-
未找到资源。
HTTP 状态代码：404
- ThrottlingException
-
速率超过限制。
HTTP 状态代码：429
- ValidationException
-
失败
HTTP 状态代码：400
另请参阅
有关在特定语言的 AWS SDK 中使用此 API 的更多信息，请参阅以下内容：
