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

Lineage - Get By Unique Attribute

返回有关实体的世系信息。

除了 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 或两者。

attr:qualifiedName
query

string

实体的限定名称。 (这只是一个示例。qualifiedName 可以更改为其他唯一属性)

depth
query

integer

int32

世系的跃点数。

响应

名称 类型 说明
200 OK

AtlasLineageInfo

请求已成功。

Other Status Codes

AtlasErrorResponse

意外的错误响应。

安全性

OAuth2Auth

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

作用域

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

示例

Lineage_GetByUniqueAttribute

示例请求

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/

示例响应

{
  "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

与 from 和 to 实体的 GUID 的世系关系。

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

是否为 shell 实体

labels

string[]

标签

lastModifiedTS

string

用于并发控制的 ETag。

meaningNames

string[]

含义数组。

meanings

AtlasTermAssignmentHeader[]

术语分配标头的数组。

status

EntityStatus

实体的状态 - 可以是活动状态,也可以是已删除的。 不会删除已删除的实体。

typeName

string

类型的名称。

AtlasErrorResponse

来自服务的错误响应

名称 类型 说明
errorCode

string

错误代码。

errorMessage

string

错误消息。

requestId

string

请求 ID。

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

Azure 和 AppSource

INPUT

string

input

OUTPUT

string

输出

LineageRelation

与 from 和 to 实体的 GUID 的世系关系。

名称 类型 说明
fromEntityId

string

from-entity 的 GUID。

relationshipId

string

关系的 GUID。

toEntityId

string

to-entity 的 GUID。

ParentRelation

世系父级与父实体的 GUID 以及与子实体的关系。

名称 类型 说明
childEntityId

string

子实体的 GUID。

parentEntityId

string

父实体的 GUID。

relationshipId

string

关系的 GUID。

TimeBoundary

捕获时间边界详细信息

名称 类型 说明
endTime

string

时间边界的结束。

startTime

string

时间边界的开始。

timeZone

string

时间边界的时区。