Lineage - Get

Служба:

Purview

Версия API:

2023-09-01

Получение сведений о происхождении сущности, указанной GUID.

GET {endpoint}/datamap/api/atlas/v2/lineage/{guid}?direction={direction}

С использованием необязательных параметров:

GET {endpoint}/datamap/api/atlas/v2/lineage/{guid}?depth={depth}&direction={direction}

Параметры URI

Имя	В	Обязательно	Тип	Описание
endpoint	path	True	string (uri)
guid	path	True	string	Глобальный уникальный идентификатор сущности.
direction	query	True	LineageDirection	Направление происхождения, которое может быть INPUT, OUTPUT или ОБА.
depth	query		integer (int32)	Количество прыжков для происхождения.

Ответы

Имя	Тип	Описание
200 OK	AtlasLineageInfo	Запрос выполнен успешно.
Other Status Codes	AtlasErrorResponse	Непредвиденное сообщение об ошибке.

Безопасность

OAuth2Auth

Тип: oauth2
Flow: implicit
URL-адрес авторизации: https://login.microsoftonline.com/common/oauth2/authorize

Области

Имя	Описание
https://purview.azure.net/.default

Примеры

Lineage_Get

Образец запроса

HTTP

GET {endpoint}/datamap/api/atlas/v2/lineage/a6894eb3-81f3-829b-2adc-52f3e603411a?depth=1&direction=INPUT

Пример ответа

Код состояния:

200

{
  "baseEntityGuid": "a6894eb3-81f3-829b-2adc-52f3e603411a",
  "lineageDirection": "INPUT",
  "lineageDepth": 1,
  "lineageWidth": 1,
  "childrenCount": 1,
  "guidEntityMap": {},
  "widthCounts": {},
  "relations": [],
  "parentRelations": []
}

Определения

Имя	Описание
AtlasClassification	Экземпляр классификации; Он не имеет удостоверения, этот объект существует только при сопоставлении с сущностью.
AtlasEntityHeader	Экземпляр сущности, например hive_table, hive_database.
AtlasErrorResponse	Ответ об ошибке службы
AtlasLineageInfo	Сведения о происхождении.
AtlasTermAssignmentHeader	Заголовок для назначения терминов.
AtlasTermAssignmentStatus	Состояние назначения терминов
EntityStatus	Состояние — может быть активным или удаленным
LineageDirection	Направление происхождения
LineageRelation	Отношение происхождения с GUID объекта от и к сущности.
ParentRelation	Родители происхождения связаны с GUID родительской сущности и дочерней сущности.
TimeBoundary	Записывает сведения о границах времени

AtlasClassification

Object

Экземпляр классификации; Он не имеет удостоверения, этот объект существует только при сопоставлении с сущностью.

Имя	Тип	Описание
attributes		Атрибуты структуры.
entityGuid	string	GUID сущности.
entityStatus	EntityStatus	Состояние сущности — может быть активным или удаленным. Удаленные сущности не удаляются.
lastModifiedTS	string	ETag для элемента управления параллелизмом.
removePropagationsOnEntityDelete	boolean	Определяет, будут ли распространения удалены при удалении сущностей.
typeName	string	Имя типа.
validityPeriods	TimeBoundary[]	Массив границ времени, указывающий срок действия.

AtlasEntityHeader

Object

Экземпляр сущности, например hive_table, hive_database.

Имя	Тип	Описание
attributes		Атрибуты структуры.
classificationNames	string[]	Массив имен классификации.
classifications	AtlasClassification[]	Массив классификаций.
displayText	string	Отображаемый текст.
guid	string	GUID записи.
isIncomplete	boolean	Является ли она сущностью оболочки
labels	string[]	Метки
lastModifiedTS	string	ETag для элемента управления параллелизмом.
meaningNames	string[]	Массив значений.
meanings	AtlasTermAssignmentHeader[]	Массив заголовков назначения терминов.
status	EntityStatus	Состояние сущности — может быть активным или удаленным. Удаленные сущности не удаляются.
typeName	string	Имя типа.

AtlasErrorResponse

Object

Ответ об ошибке службы

Имя	Тип	Описание
errorCode	string	Код ошибки.
errorMessage	string	Сообщение об ошибке.
requestId	string (uuid)	Идентификатор запроса.

AtlasLineageInfo

Object

Сведения о происхождении.

Имя	Тип	Описание
baseEntityGuid	string	GUID базовой сущности.
childrenCount	integer (int32)	Число дочерних узлов.
guidEntityMap	<string,  AtlasEntityHeader>	Карта сущности GUID.
lineageDepth	integer (int32)	Глубина происхождения.
lineageDirection	LineageDirection	Перечисление направления происхождения.
lineageWidth	integer (int32)	Ширина происхождения.
parentRelations	ParentRelation[]	Массив отношений parentRelations.
relations	LineageRelation[]	Массив связей происхождения.
widthCounts	object	Число сущностей в определенном направлении.

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

Перечисление

Состояние назначения терминов

Значение	Описание
DISCOVERED	Состояние обнаруживается.
PROPOSED	Предлагается состояние.
IMPORTED	Состояние импортируется.
VALIDATED	Состояние проверяется.
DEPRECATED	Состояние устарело.
OBSOLETE	Состояние устарело.
OTHER	Другое состояние.

EntityStatus

Перечисление

Состояние — может быть активным или удаленным

Значение	Описание
ACTIVE	Состояние активно.
DELETED	Состояние удаляется.

LineageDirection

Перечисление

Направление происхождения

Значение	Описание
INPUT	input
OUTPUT	выпуск
BOTH	Оба варианта

LineageRelation

Object

Отношение происхождения с GUID объекта от и к сущности.

Имя	Тип	Описание
fromEntityId	string	GUID объекта from-entity.
relationshipId	string	GUID связи.
toEntityId	string	GUID сущности.

ParentRelation

Object

Родители происхождения связаны с GUID родительской сущности и дочерней сущности.

Имя	Тип	Описание
childEntityId	string	GUID дочерней сущности.
parentEntityId	string	GUID родительской сущности.
relationshipId	string	GUID связи.

TimeBoundary

Object

Записывает сведения о границах времени

Имя	Тип	Описание
endTime	string	Окончание границы времени.
startTime	string	Начало границы времени.
timeZone	string	Часовой пояс границы времени.