你当前正在访问 Microsoft Azure Global Edition 技术文档网站。 如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站,请访问 https://docs.azure.cn。
Entity - Partial Update By Unique Attributes
部分更新实体 - 允许在实体上更新属性子集,该实体由其类型和唯一属性标识,例如:Referenceable.qualifiedName。 无法进行 Null 更新。
除了 typeName 路径参数外,还可以使用以下格式提供属性键值对 () :
attr:=. 注意:attrName 和 attrValue 在实体中应是唯一的,例如qualifiedName。
REST 请求将如下所示:PUT /v2/entity/uniqueAttribute/type/aType?attr:aTypeAttribute=someValue。
PUT {endpoint}/datamap/api/atlas/v2/entity/uniqueAttribute/type/{typeName}
PUT {endpoint}/datamap/api/atlas/v2/entity/uniqueAttribute/type/{typeName}?attr:qualifiedName={attr:qualifiedName}
URI 参数
名称 | 在 | 必需 | 类型 | 说明 |
---|---|---|---|---|
endpoint
|
path | True |
string |
|
type
|
path | True |
string |
类型的名称。 |
attr:qualified
|
query |
string |
实体的限定名称。 (这只是一个示例。qualifiedName 可以更改为其他唯一属性) |
请求正文
名称 | 类型 | 说明 |
---|---|---|
entity |
实体的实例-例如hive_table、hive_database。 |
|
referredEntities |
<string,
Atlas |
引用的实体。 |
响应
名称 | 类型 | 说明 |
---|---|---|
200 OK |
请求已成功。 |
|
Other Status Codes |
意外的错误响应。 |
安全性
OAuth2Auth
Type:
oauth2
Flow:
implicit
Authorization URL:
https://login.microsoftonline.com/common/oauth2/authorize
Scopes
名称 | 说明 |
---|---|
https://purview.azure.net/.default |
示例
Entity_PartialUpdateByUniqueAttributes
Sample Request
PUT {endpoint}/datamap/api/atlas/v2/entity/uniqueAttribute/type/azure_storage_account?attr:qualifiedName=https://exampleaccount.core.windows.net
{
"entity": {
"createTime": 1605766397985,
"createdBy": "8c062c84-5d25-449f-a990-9d8ab70b8ec7",
"guid": "dc507ccf-0c57-4165-9327-f37b0d13fda0",
"relationshipAttributes": {
"services": [],
"meanings": []
},
"status": "ACTIVE",
"updateTime": 1605766397985,
"updatedBy": "8c062c84-5d25-449f-a990-9d8ab70b8ec7",
"lastModifiedTS": "1",
"version": 0,
"attributes": {
"owner": "ExampleOwner",
"qualifiedName": "https://exampleaccount.core.windows.net",
"createTime": 0,
"name": "ExampleNewName"
},
"typeName": "azure_storage_account"
},
"referredEntities": {}
}
Sample Response
{
"guidAssignments": {},
"mutatedEntities": {
"PARTIAL_UPDATE": [
{
"guid": "dc507ccf-0c57-4165-9327-f37b0d13fda0",
"lastModifiedTS": "2",
"attributes": {
"qualifiedName": "https://exampleaccount.core.windows.net"
},
"typeName": "azure_storage_account"
}
]
},
"partialUpdatedEntities": [
{
"guid": "dc507ccf-0c57-4165-9327-f37b0d13fda0",
"lastModifiedTS": "2",
"attributes": {
"qualifiedName": "https://exampleaccount.core.windows.net"
},
"typeName": "azure_storage_account"
}
]
}
定义
名称 | 说明 |
---|---|
Atlas |
分类的实例;它没有标识,此对象仅在与实体关联时才存在。 |
Atlas |
实体的实例-例如hive_table、hive_database。 |
Atlas |
实体的实例-例如hive_table、hive_database。 |
Atlas |
实体的实例以及扩展信息(如hive_table、hive_database)。 |
Atlas |
来自服务的错误响应 |
Atlas |
术语分配的标头。 |
Atlas |
术语分配的状态 |
Entity |
实体的突变响应结果。 |
Entity |
状态 - 可以是活动状态,也可以已删除 |
Time |
捕获时间边界详细信息 |
AtlasClassification
分类的实例;它没有标识,此对象仅在与实体关联时才存在。
名称 | 类型 | 说明 |
---|---|---|
attributes |
结构的属性。 |
|
entityGuid |
string |
实体的 GUID。 |
entityStatus |
实体的状态 - 可以是活动状态,也可以是已删除的。 不会删除已删除的实体。 |
|
lastModifiedTS |
string |
用于并发控制的 ETag。 |
removePropagationsOnEntityDelete |
boolean |
确定是否在删除实体时删除传播。 |
typeName |
string |
类型的名称。 |
validityPeriods |
指示有效期的时间边界数组。 |
AtlasEntity
实体的实例-例如hive_table、hive_database。
名称 | 类型 | 说明 |
---|---|---|
attributes |
结构的属性。 |
|
businessAttributes |
业务属性 |
|
classifications |
分类数组。 |
|
collectionId |
string |
实体的集合 ID。 |
contacts |
object |
实体的联系人字典。 密钥可以是“专家”或“所有者”。 |
createTime |
integer |
记录的创建时间。 |
createdBy |
string |
创建记录的用户。 |
customAttributes |
object |
自定义属性 |
guid |
string |
实体的 GUID。 |
homeId |
string |
实体的主 ID。 |
isIncomplete |
boolean |
是否为 shell 实体 |
labels |
string[] |
标签 |
lastModifiedTS |
string |
用于并发控制的 ETag。 |
meanings |
表示实体含义的术语赋值标头数组。 |
|
provenanceType |
integer |
用于记录实体或关系的实例的来源。 |
proxy |
boolean |
确定是否有代理。 |
relationshipAttributes |
关系的属性。 |
|
status |
实体的状态 - 可以是活动状态,也可以是已删除的。 不会删除已删除的实体。 |
|
typeName |
string |
类型的名称。 |
updateTime |
integer |
记录的更新时间。 |
updatedBy |
string |
更新记录的用户。 |
version |
integer |
实体的版本。 |
AtlasEntityHeader
实体的实例-例如hive_table、hive_database。
名称 | 类型 | 说明 |
---|---|---|
attributes |
结构的属性。 |
|
classificationNames |
string[] |
分类名称的数组。 |
classifications |
分类数组。 |
|
displayText |
string |
显示文本。 |
guid |
string |
记录的 GUID。 |
isIncomplete |
boolean |
是否为 shell 实体 |
labels |
string[] |
标签 |
lastModifiedTS |
string |
用于并发控制的 ETag。 |
meaningNames |
string[] |
含义数组。 |
meanings |
术语分配标头的数组。 |
|
status |
实体的状态 - 可以是活动状态,也可以是已删除的。 不会删除已删除的实体。 |
|
typeName |
string |
类型的名称。 |
AtlasEntityWithExtInfo
实体的实例以及扩展信息(如hive_table、hive_database)。
名称 | 类型 | 说明 |
---|---|---|
entity |
实体的实例-例如hive_table、hive_database。 |
|
referredEntities |
<string,
Atlas |
引用的实体。 |
AtlasErrorResponse
来自服务的错误响应
名称 | 类型 | 说明 |
---|---|---|
errorCode |
string |
错误代码。 |
errorMessage |
string |
错误消息。 |
requestId |
string |
请求 ID。 |
AtlasTermAssignmentHeader
术语分配的标头。
名称 | 类型 | 说明 |
---|---|---|
confidence |
integer |
字词分配的置信度。 |
createdBy |
string |
创建记录的用户。 |
description |
string |
术语分配的说明。 |
displayText |
string |
显示文本。 |
expression |
string |
字词赋值的表达式。 |
relationGuid |
string |
关系的 GUID。 |
status |
术语分配的状态。 |
|
steward |
string |
术语的管理员。 |
termGuid |
string |
术语的 GUID。 |
AtlasTermAssignmentStatus
术语分配的状态
名称 | 类型 | 说明 |
---|---|---|
DEPRECATED |
string |
状态已弃用。 |
DISCOVERED |
string |
状态已发现。 |
IMPORTED |
string |
状态为“已导入”。 |
OBSOLETE |
string |
状态已过时。 |
OTHER |
string |
其他状态。 |
PROPOSED |
string |
建议状态。 |
VALIDATED |
string |
状态已验证。 |
EntityMutationResult
实体的突变响应结果。
名称 | 类型 | 说明 |
---|---|---|
guidAssignments |
object |
包含实体的 GUID 分配的映射。 |
mutatedEntities |
object |
可变实体的实体标头。 |
partialUpdatedEntities |
部分更新的实体标头数组。 |
EntityStatus
状态 - 可以是活动状态,也可以已删除
名称 | 类型 | 说明 |
---|---|---|
ACTIVE |
string |
状态为“活动”。 |
DELETED |
string |
状态已删除。 |
TimeBoundary
捕获时间边界详细信息
名称 | 类型 | 说明 |
---|---|---|
endTime |
string |
时间边界的结束。 |
startTime |
string |
时间边界的开始。 |
timeZone |
string |
时间边界的时区。 |