Lineage - Get By Unique Attribute

Ссылка

Служба:: Purview

Версия API:: 2023-09-01

Возвращает сведения о происхождении сущности.

В дополнение к параметру пути typeName пары "ключ-значение" атрибута можно указать в следующем формате.

attr:[attrName]=[attrValue]

ПРИМЕЧАНИЕ. AttrName и attrValue должны быть уникальными для разных сущностей, например. qualifiedName.

Запрос REST будет выглядеть примерно так:

GET /v2/lineage/uniqueAttribute/type/aType?attr:aTypeAttribute=someValue.

GET {endpoint}/datamap/api/atlas/v2/lineage/uniqueAttribute/type/{typeName}?direction={direction}

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

GET {endpoint}/datamap/api/atlas/v2/lineage/uniqueAttribute/type/{typeName}?depth={depth}&direction={direction}&attr:qualifiedName={attr:qualifiedName}

Параметры URI

Имя	В	Обязательно	Тип	Описание
endpoint	path	True	string
typeName	path	True	string	Имя типа.
direction	query	True	LineageDirection	Направление происхождения, которое может быть INPUT, OUTPUT или BOTH.
attr:qualifiedName	query		string	Полное имя сущности. (Это только пример. qualifiedName можно изменить на другие уникальные атрибуты)
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_GetByUniqueAttribute

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

HTTP

GET {endpoint}/datamap/api/atlas/v2/lineage/uniqueAttribute/type/azure_blob_path?depth=2&direction=BOTH&attr:qualifiedName=https://02cab97b-ba87-4675-972d-150b6cb522d3/entity.json/

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

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

{
  "baseEntityGuid": "9b2751f1-2633-4f06-a578-e14fab4c52fd",
  "lineageDirection": "BOTH",
  "lineageDepth": 2,
  "lineageWidth": 2,
  "childrenCount": -1,
  "guidEntityMap": {
    "9b2751f1-2633-4f06-a578-e14fab4c52fd": {
      "typeName": "azure_blob_path",
      "attributes": {
        "owner": "testOwner",
        "modifiedTime": 0,
        "qualifiedName": "https://02cab97b-ba87-4675-972d-150b6cb522d3/entity.json/",
        "isBlob": false,
        "accessTierInferred": false,
        "description": "testDesc",
        "committedBlockCount": 0,
        "path": "/test/AzureBlobPath.json",
        "size": 731,
        "createTime": 0,
        "name": "populate_azure_blob_path_02cab97b-ba87-4675-972d-150b6cb522d3",
        "blobType": "BlockBlob",
        "serverEncrypted": true
      },
      "lastModifiedTS": "1",
      "guid": "9b2751f1-2633-4f06-a578-e14fab4c52fd",
      "status": "ACTIVE",
      "displayText": "populate_azure_blob_path_02cab97b-ba87-4675-972d-150b6cb522d3",
      "classificationNames": [
        "MICROSOFT.PERSONAL.EMAIL",
        "MICROSOFT.PERSONAL.NAME"
      ],
      "meaningNames": [],
      "meanings": [],
      "isIncomplete": false,
      "labels": []
    }
  },
  "relations": [],
  "parentRelations": [],
  "widthCounts": {
    "INPUT": {
      "9b2751f1-2633-4f06-a578-e14fab4c52fd": 0
    },
    "OUTPUT": {
      "9b2751f1-2633-4f06-a578-e14fab4c52fd": 0
    }
  }
}

Определения

Имя	Описание
AtlasClassification	Экземпляр классификации; У него нет удостоверения, этот объект существует только в том случае, если он связан с сущностью.
AtlasEntityHeader	Экземпляр сущности, например hive_table, hive_database.
AtlasErrorResponse	Ответ об ошибке от службы
AtlasLineageInfo	Сведения о происхождении.
AtlasTermAssignmentHeader	Заголовок для назначения терминов.
AtlasTermAssignmentStatus	Состояние назначения терминов
EntityStatus	Состояние — может быть активным или удаленным.
LineageDirection	Направление происхождения
LineageRelation	Отношение происхождения с GUID объекта from и к сущности.
ParentRelation	Отношение родителей происхождения с GUID родительской сущности и к дочерней сущности.
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	Является ли это сущностью оболочки
labels	string[]	метки;
lastModifiedTS	string	ETag для управления параллелизмом.
meaningNames	string[]	Массив значений.
meanings	AtlasTermAssignmentHeader[]	Массив заголовков присваивания терминов.
status	EntityStatus	Состояние сущности — может быть активным или удаленным. Удаленные сущности не удаляются.
typeName	string	Имя типа.

AtlasErrorResponse

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

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

AtlasLineageInfo

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

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

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	Состояние удалено.

LineageDirection

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

Имя	Тип	Описание
BOTH	string	Оба варианта
INPUT	string	input
OUTPUT	string	output

LineageRelation

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

Имя	Тип	Описание
fromEntityId	string	Идентификатор GUID объекта from-entity.
relationshipId	string	GUID связи.
toEntityId	string	Guid объекта to-entity.

ParentRelation

Отношение родителей происхождения с GUID родительской сущности и к дочерней сущности.

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

TimeBoundary

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

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