本文属于机器翻译版本。若本译文内容与英语原文存在差异，则一律以英文原文为准。
CreateEntity
创建一个实体。
请求语法
POST /workspaces/workspaceId/entities HTTP/1.1
Content-type: application/json
{
"components": {
"string" : {
"componentTypeId": "string",
"description": "string",
"properties": {
"string" : {
"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,
"isRequiredInEntity": boolean,
"isStoredExternally": boolean,
"isTimeSeries": boolean
},
"updateType": "string",
"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",
"propertyNames": [ "string" ],
"updateType": "string"
}
}
}
},
"compositeComponents": {
"string" : {
"description": "string",
"properties": {
"string" : {
"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,
"isRequiredInEntity": boolean,
"isStoredExternally": boolean,
"isTimeSeries": boolean
},
"updateType": "string",
"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",
"propertyNames": [ "string" ],
"updateType": "string"
}
}
}
},
"description": "string",
"entityId": "string",
"entityName": "string",
"parentEntityId": "string",
"tags": {
"string" : "string"
}
}URI 请求参数
请求使用以下 URI 参数。
- workspaceId
-
包含实体的工作区 ID。
长度限制：长度下限为 1。长度上限为 128。
模式：
[a-zA-Z_0-9][a-zA-Z_\-0-9]*[a-zA-Z0-9]+必需：是
请求体
请求接受采用 JSON 格式的以下数据。
- components
-
将字符串映射到实体中的组件的对象。映射中的每个字符串对于该对象都必须是唯一的。
类型：字符串到 ComponentRequest 对象的映射
密钥长度限制：最小长度为 1。最大长度为 256。
密钥模式：
[a-zA-Z_\-0-9]+必需：否
- compositeComponents
-
这是一个将字符串映射到请求中
compositeComponent更新的对象。映射的每个键都代表compositeComponent的componentPath。类型：字符串到 CompositeComponentRequest 对象的映射
密钥长度限制：最小长度为 1。最大长度为 2048。
密钥模式：
[a-zA-Z_\-0-9/]+必需：否
- description
-
实体的描述。
类型：字符串
长度约束：最小长度为 0。最大长度为 2048。
模式：
.*必需：否
- 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]+必需：否
- entityName
-
实体名称。
类型：字符串
长度限制：最小长度为 1。最大长度为 256。
模式：
[^\u0000-\u001F\u007F]+必需：是
- parentEntityId
-
实体的父实体 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]+必需：否
-
可用于管理实体的元数据。
类型：字符串到字符串映射
映射条目：最低 0 项。最多 50 项。
密钥长度限制：最小长度为 1。长度上限为 128。
键模式：
([\p{L}\p{Z}\p{N}_.:/=+\-@]*)值长度限制：最小长度为 1。最大长度为 256。
价值模式：
.*必需：否
响应语法
HTTP/1.1 200
Content-type: application/json
{
"arn": "string",
"creationDateTime": number,
"entityId": "string",
"state": "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
-
创建实体的日期和时间。
类型：时间戳
- 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]+ - state
-
实体的当前状态。
类型：字符串
有效值：
CREATING | UPDATING | DELETING | ACTIVE | ERROR
错误
有关所有操作的常见错误信息，请参阅常见错误。
- AccessDeniedException
-
访问被拒绝。
HTTP 状态代码：403
- ConflictException
-
发生冲突。
HTTP 状态代码：409
- InternalServerException
-
出现意外错误。
HTTP 状态代码：500
- ServiceQuotaExceededException
-
已超出服务限额。
HTTP 状态代码：402
- ThrottlingException
-
速率超过限制。
HTTP 状态代码：429
- ValidationException
-
失败
HTTP 状态代码：400
另请参阅
有关在特定语言的 AWS SDK 中使用此 API 的更多信息，请参阅以下内容：
