Lineage - Get By Unique Attribute

Servicio:

Purview

Versión de la API:

2023-09-01

Devuelve información de linaje sobre la entidad.

Además del parámetro de ruta de acceso typeName, se pueden proporcionar pares clave-valor de atributo en el formato siguiente.

attr:[attrName]=[attrValue]

NOTA: AttrName y attrValue deben ser únicos entre entidades, por ejemplo. qualifiedName.

La solicitud REST tendría un aspecto similar al siguiente:

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

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

Con parámetros opcionales:

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

Parámetros de identificador URI

Nombre	En	Requerido	Tipo	Description
endpoint	path	True	string
typeName	path	True	string	Nombre del tipo.
direction	query	True	LineageDirection	Dirección del linaje, que podría ser INPUT, OUTPUT o BOTH.
attr:qualifiedName	query		string	Nombre completo de la entidad. (Este es solo un ejemplo. qualifiedName se puede cambiar a otros atributos únicos).
depth	query		integer int32	Número de saltos de linaje.

Respuestas

Nombre	Tipo	Description
200 OK	AtlasLineageInfo	La solicitud se ha realizado correctamente.
Other Status Codes	AtlasErrorResponse	Respuesta de error inesperada.

Seguridad

OAuth2Auth

Tipo: oauth2
Flujo: implicit
Dirección URL de autorización: https://login.microsoftonline.com/common/oauth2/authorize

Ámbitos

Nombre	Description
https://purview.azure.net/.default

Ejemplos

Lineage_GetByUniqueAttribute

Solicitud de ejemplo

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/

Respuesta de muestra

status code:

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
    }
  }
}

Definiciones

Nombre	Description
AtlasClassification	Instancia de una clasificación; no tiene una identidad, este objeto solo existe cuando está asociado a una entidad.
AtlasEntityHeader	Una instancia de una entidad, como hive_table, hive_database.
AtlasErrorResponse	Respuesta de error del servicio
AtlasLineageInfo	Información de linaje.
AtlasTermAssignmentHeader	Encabezado para la asignación de términos.
AtlasTermAssignmentStatus	Estado de la asignación de términos
EntityStatus	Estado: puede estar activo o eliminado.
LineageDirection	Dirección del linaje
LineageRelation	Relación de linaje con el GUID de la entidad de y hacia .
ParentRelation	Relación de los elementos primarios de linaje con el GUID de la entidad primaria y de la entidad secundaria.
TimeBoundary	Captura los detalles del límite de tiempo

AtlasClassification

Instancia de una clasificación; no tiene una identidad, este objeto solo existe cuando está asociado a una entidad.

Nombre	Tipo	Description
attributes		Atributos de la estructura.
entityGuid	string	GUID de la entidad.
entityStatus	EntityStatus	Estado de la entidad: puede estar activo o eliminado. No se quitan las entidades eliminadas.
lastModifiedTS	string	ETag para el control de simultaneidad.
removePropagationsOnEntityDelete	boolean	Determina si se quitarán las propagaciones en la eliminación de entidades.
typeName	string	Nombre del tipo.
validityPeriods	TimeBoundary[]	Matriz de límites de tiempo que indica períodos de validez.

AtlasEntityHeader

Una instancia de una entidad, como hive_table, hive_database.

Nombre	Tipo	Description
attributes		Atributos de la estructura.
classificationNames	string[]	Matriz de nombres de clasificación.
classifications	AtlasClassification[]	Matriz de clasificaciones.
displayText	string	Texto que se muestra.
guid	string	GUID del registro.
isIncomplete	boolean	Si es una entidad de shell
labels	string[]	labels
lastModifiedTS	string	ETag para el control de simultaneidad.
meaningNames	string[]	Matriz de significados.
meanings	AtlasTermAssignmentHeader[]	Matriz de encabezados de asignación de términos.
status	EntityStatus	Estado de la entidad: puede estar activo o eliminado. No se quitan las entidades eliminadas.
typeName	string	Nombre del tipo.

AtlasErrorResponse

Respuesta de error del servicio

Nombre	Tipo	Description
errorCode	string	Código de error.
errorMessage	string	El mensaje de error.
requestId	string	El identificador de solicitud.

AtlasLineageInfo

Información de linaje.

Nombre	Tipo	Description
baseEntityGuid	string	GUID de la entidad base.
childrenCount	integer	Número de nodos secundarios.
guidEntityMap	<string,  AtlasEntityHeader>	Mapa de entidades GUID.
lineageDepth	integer	Profundidad del linaje.
lineageDirection	LineageDirection	Enumeración de la dirección del linaje.
lineageWidth	integer	Ancho del linaje.
parentRelations	ParentRelation[]	Matriz de relaciones parentRelations.
relations	LineageRelation[]	Matriz de relaciones de linaje.
widthCounts	object	Recuento de entidades en dirección específica.

AtlasTermAssignmentHeader

Encabezado para la asignación de términos.

Nombre	Tipo	Description
confidence	integer	Confianza de la asignación de términos.
createdBy	string	El usuario que creó el registro.
description	string	Descripción de la asignación de términos.
displayText	string	Texto que se muestra.
expression	string	Expresión de la asignación de términos.
relationGuid	string	GUID de la relación.
status	AtlasTermAssignmentStatus	Estado de la asignación de términos.
steward	string	Administrador del término.
termGuid	string	GUID del término.

AtlasTermAssignmentStatus

Estado de la asignación de términos

Nombre	Tipo	Description
DEPRECATED	string	El estado está en desuso.
DISCOVERED	string	Se detecta el estado.
IMPORTED	string	El estado se importa.
OBSOLETE	string	El estado está obsoleto.
OTHER	string	Otro estado.
PROPOSED	string	Se propone el estado.
VALIDATED	string	El estado se valida.

EntityStatus

Estado: puede estar activo o eliminado.

Nombre	Tipo	Description
ACTIVE	string	El estado está activo.
DELETED	string	El estado se elimina.

LineageDirection

Dirección del linaje

Nombre	Tipo	Description
BOTH	string	Ambos
INPUT	string	input
OUTPUT	string	output

LineageRelation

Relación de linaje con el GUID de la entidad de y hacia .

Nombre	Tipo	Description
fromEntityId	string	GUID de from-entity.
relationshipId	string	GUID de la relación.
toEntityId	string	GUID de a entidad.

ParentRelation

Relación de los elementos primarios de linaje con el GUID de la entidad primaria y de la entidad secundaria.

Nombre	Tipo	Description
childEntityId	string	GUID de la entidad secundaria.
parentEntityId	string	GUID de la entidad primaria.
relationshipId	string	GUID de la relación.

TimeBoundary

Captura los detalles del límite de tiempo

Nombre	Tipo	Description
endTime	string	Fin del límite de tiempo.
startTime	string	Inicio del límite de tiempo.
timeZone	string	Zona horaria del límite de tiempo.