你当前正在访问 Microsoft Azure Global Edition 技术文档网站。 如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站，请访问 https://docs.azure.cn。

Entity - Get By Unique Attributes

服务:

Purview

API 版本:

2023-09-01

获取给定实体类型和唯一属性的完整定义。

除了 typeName 路径参数，还可以使用以下格式提供属性键值对：attr：<attrName>=。

注意：attrName 和 attrValue 在实体中应是唯一的，例如。qualifiedName。

REST 请求如下所示：GET /v2/entity/uniqueAttribute/type/aType？attr：aTypeAttribute=someValue。

GET {endpoint}/datamap/api/atlas/v2/entity/uniqueAttribute/type/{typeName}

具有可选参数:

GET {endpoint}/datamap/api/atlas/v2/entity/uniqueAttribute/type/{typeName}?minExtInfo={minExtInfo}&ignoreRelationships={ignoreRelationships}&attr:qualifiedName={attr:qualifiedName}

URI 参数

名称	在	必需	类型	说明
endpoint	path	True	string (uri)
typeName	path	True	string	类型的名称。
attr:qualifiedName	query		string	实体的限定名称。 （这只是一个示例。qualifiedName 可以更改为其他唯一属性）
ignoreRelationships	query		boolean	是否忽略关系属性。
minExtInfo	query		boolean	是否返回引用实体的最小信息。

响应

名称	类型	说明
200 OK	AtlasEntityWithExtInfo	请求已成功。
Other Status Codes	AtlasErrorResponse	意外的错误响应。

安全性

OAuth2Auth

类型: oauth2
流向: implicit
授权 URL: https://login.microsoftonline.com/common/oauth2/authorize

作用域

名称	说明
https://purview.azure.net/.default

示例

Entity_GetByUniqueAttributes

示例请求

HTTP

GET {endpoint}/datamap/api/atlas/v2/entity/uniqueAttribute/type/azure_storage_account?minExtInfo=True&attr:qualifiedName=https://exampleaccount.core.windows.net

示例响应

状态代码:

200

{
  "entity": {
    "createTime": 1605703532110,
    "createdBy": "8c062c84-5d25-449f-a990-9d8ab70b8ec7",
    "guid": "e0ba3f20-f3b5-4d52-b769-ed35a02df60a",
    "relationshipAttributes": {
      "services": [],
      "meanings": []
    },
    "status": "ACTIVE",
    "updateTime": 1605703532110,
    "updatedBy": "8c062c84-5d25-449f-a990-9d8ab70b8ec7",
    "lastModifiedTS": "2",
    "version": 0,
    "attributes": {
      "owner": "ExampleOwner",
      "qualifiedName": "https://exampleaccount.core.windows.net",
      "createTime": 0,
      "name": "ExampleNewName"
    },
    "typeName": "azure_storage_account"
  },
  "referredEntities": {}
}

定义

名称	说明
AtlasClassification	分类的实例;它没有标识，此对象仅在与实体关联时才存在。
AtlasEntity	实体的实例 - 例如hive_table，hive_database。
AtlasEntityWithExtInfo	实体的实例以及扩展的信息（如hive_table）hive_database。
AtlasErrorResponse	来自服务的错误响应
AtlasTermAssignmentHeader	术语分配的标头。
AtlasTermAssignmentStatus	术语分配的状态
EntityStatus	状态 - 可以处于活动状态或删除
TimeBoundary	捕获时间边界详细信息

AtlasClassification

Object

分类的实例;它没有标识，此对象仅在与实体关联时才存在。

名称	类型	说明
attributes		结构的属性。
entityGuid	string	实体的 GUID。
entityStatus	EntityStatus	实体的状态 - 可以处于活动状态或删除。 不会删除已删除的实体。
lastModifiedTS	string	用于并发控制的 ETag。
removePropagationsOnEntityDelete	boolean	确定在删除实体时是否删除传播。
typeName	string	类型的名称。
validityPeriods	TimeBoundary[]	指示有效期的时间边界数组。

AtlasEntity

Object

实体的实例 - 例如hive_table，hive_database。

名称	类型	说明
attributes		结构的属性。
businessAttributes		业务属性
classifications	AtlasClassification[]	分类数组。
collectionId	string	实体的集合 ID。
contacts	object	实体的联系人字典。 密钥可以是专家或所有者。
createTime	integer (int64)	记录的创建时间。
createdBy	string	创建记录的用户。
customAttributes	object	自定义属性
guid	string	实体的 GUID。
homeId	string	实体的主 ID。
isIncomplete	boolean	它是否为 shell 实体
labels	string[]	标签
lastModifiedTS	string	用于并发控制的 ETag。
meanings	AtlasTermAssignmentHeader[]	术语分配标头数组，指示实体的含义。
provenanceType	integer (int32)	用于记录实体或关系的实例的证明。
proxy	boolean	确定是否存在代理。
relationshipAttributes		关系的属性。
status	EntityStatus	实体的状态 - 可以处于活动状态或删除。 不会删除已删除的实体。
typeName	string	类型的名称。
updateTime	integer (int64)	记录的更新时间。
updatedBy	string	更新记录的用户。
version	integer (int64)	实体的版本。

AtlasEntityWithExtInfo

Object

实体的实例以及扩展的信息（如hive_table）hive_database。

名称	类型	说明
entity	AtlasEntity	实体的实例 - 例如hive_table，hive_database。
referredEntities	<string,  AtlasEntity>	引用的实体。

AtlasErrorResponse

Object

来自服务的错误响应

名称	类型	说明
errorCode	string	错误代码。
errorMessage	string	错误消息。
requestId	string (uuid)	请求 ID。

AtlasTermAssignmentHeader

Object

术语分配的标头。

名称	类型	说明
confidence	integer (int32)	术语分配的置信度。
createdBy	string	创建记录的用户。
description	string	术语分配的说明。
displayText	string	显示文本。
expression	string	术语赋值表达式。
relationGuid	string (uuid)	关系的 GUID。
status	AtlasTermAssignmentStatus	术语分配的状态。
steward	string	术语的管家。
termGuid	string (uuid)	术语的 GUID。

AtlasTermAssignmentStatus

枚举

术语分配的状态

值	说明
DEPRECATED	状态已弃用。
DISCOVERED	发现状态。
IMPORTED	导入状态。
OBSOLETE	状态已过时。
OTHER	其他状态。
PROPOSED	建议状态。
VALIDATED	状态已验证。

EntityStatus

枚举

状态 - 可以处于活动状态或删除

值	说明
ACTIVE	状态处于活动状态。
DELETED	状态已删除。

TimeBoundary

Object

捕获时间边界详细信息

名称	类型	说明
endTime	string	时间边界的结束。
startTime	string	时间边界的开始。
timeZone	string	时间边界的时区。