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

Relationship - Get

参考

服务:: Purview

API 版本:: 2023-09-01

按 GUID 获取实体之间的关系信息。

GET {endpoint}/datamap/api/atlas/v2/relationship/guid/{guid}

具有可选参数:

GET {endpoint}/datamap/api/atlas/v2/relationship/guid/{guid}?extendedInfo={extendedInfo}

URI 参数

名称	在	必需	类型	说明
endpoint	path	True	string
guid	path	True	string	关系的全局唯一标识符。
extendedInfo	query		boolean	限制是否包含扩展信息。

响应

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

安全性

OAuth2Auth

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

作用域

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

示例

Relationship_Get

示例请求

HTTP

GET {endpoint}/datamap/api/atlas/v2/relationship/guid/5cf8a9e5-c9fd-abe0-2e8c-d40024263dcb?extendedInfo=false

示例响应

状态代码:: 200

{
  "relationship": {
    "typeName": "AtlasGlossarySynonym",
    "attributes": {
      "expression": null,
      "steward": null,
      "description": null,
      "source": null,
      "status": null
    },
    "guid": "de23cd5a-021c-413d-98a5-98752a1f7a3b",
    "end1": {
      "guid": "856d31e6-e342-a1ce-6273-22ddb77029c6",
      "typeName": "AtlasGlossaryTerm"
    },
    "end2": {
      "guid": "b0942506-2d7d-1f45-d286-c29ca9e7f2ef",
      "typeName": "AtlasGlossaryTerm"
    },
    "label": "r:AtlasGlossarySynonym",
    "status": "ACTIVE",
    "createdBy": "ExampleCreator",
    "updatedBy": "ExampleUpdator",
    "createTime": 1553838993803,
    "updateTime": 1553838993803,
    "version": 0
  }
}

定义

名称	说明
AtlasClassification	分类的实例;它没有标识，此对象仅在与实体关联时才存在。
AtlasEntityHeader	实体的实例-例如hive_table、hive_database。
AtlasErrorResponse	来自服务的错误响应
AtlasObjectId	对类型的对象实例的引用 - 类似于实体。
AtlasRelationship	Atlas 关系实例。
AtlasRelationshipWithExtInfo	与扩展信息的关系。
AtlasTermAssignmentHeader	术语分配的标头。
AtlasTermAssignmentStatus	术语分配的状态
EntityStatus	状态 - 可以是活动状态，也可以已删除
StatusAtlasRelationship	atlas 关系的状态
TimeBoundary	捕获时间边界详细信息

AtlasClassification

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

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

AtlasEntityHeader

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

名称	类型	说明
attributes		结构的属性。
classificationNames	string[]	分类名称的数组。
classifications	AtlasClassification[]	分类数组。
displayText	string	显示文本。
guid	string	记录的 GUID。
isIncomplete	boolean	是否为 shell 实体
labels	string[]	标签
lastModifiedTS	string	用于并发控制的 ETag。
meaningNames	string[]	含义数组。
meanings	AtlasTermAssignmentHeader[]	术语分配标头的数组。
status	EntityStatus	实体的状态 - 可以是活动状态，也可以是已删除的。不会删除已删除的实体。
typeName	string	类型的名称。

AtlasErrorResponse

来自服务的错误响应

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

AtlasObjectId

对类型的对象实例的引用 - 类似于实体。

名称	类型	说明
guid	string	对象的 GUID。
typeName	string	类型的名称。
uniqueAttributes		对象的唯一属性。

AtlasRelationship

Atlas 关系实例。

名称	类型	说明
attributes		结构的属性。
createTime	integer	记录的创建时间。
createdBy	string	创建记录的用户。
end1	AtlasObjectId	对类型的对象实例的引用 - 类似于实体。
end2	AtlasObjectId	对类型的对象实例的引用 - 类似于实体。
guid	string	关系的 GUID。
homeId	string	关系的主 ID。
label	string	关系的标签。
lastModifiedTS	string	用于并发控制的 ETag。
provenanceType	integer	用于记录实体或关系的实例的来源
status	StatusAtlasRelationship	关系状态的枚举。
typeName	string	类型的名称。
updateTime	integer	记录的更新时间。
updatedBy	string	更新记录的用户。
version	integer	关系的版本。

AtlasRelationshipWithExtInfo

与扩展信息的关系。

名称	类型	说明
referredEntities	<string, AtlasEntityHeader>	引用的实体标头。
relationship	AtlasRelationship	Atlas 关系实例。

AtlasTermAssignmentHeader

术语分配的标头。

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

AtlasTermAssignmentStatus

术语分配的状态

名称	类型	说明
DEPRECATED	string	状态已弃用。
DISCOVERED	string	状态已发现。
IMPORTED	string	状态为“已导入”。
OBSOLETE	string	状态已过时。
OTHER	string	其他状态。
PROPOSED	string	建议状态。
VALIDATED	string	状态已验证。

EntityStatus

状态 - 可以是活动状态，也可以已删除

名称	类型	说明
ACTIVE	string	状态为“活动”。
DELETED	string	状态已删除。

StatusAtlasRelationship

atlas 关系的状态

名称	类型	说明
ACTIVE	string	活动
DELETED	string	deleted

TimeBoundary

捕获时间边界详细信息

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

通过