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 參數

名稱	位於	必要	類型	Description
endpoint	path	True	string
guid	path	True	string	實體的全域唯一標識碼。
direction	query	True	LineageDirection	譜系的方向，可以是 INPUT、OUTPUT 或 BOTH。
depth	query		integer int32	譜系的躍點數目。

回應

名稱	類型	Description
200 OK	AtlasLineageInfo	要求已成功。
Other Status Codes	AtlasErrorResponse	未預期的錯誤回應。

安全性

OAuth2Auth

類型: oauth2
Flow: implicit
授權 URL: https://login.microsoftonline.com/common/oauth2/authorize

範圍

名稱	Description
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": []
}

定義

名稱	Description
AtlasClassification	分類的實例;它沒有身分識別，只有與實體相關聯的物件存在。
AtlasEntityHeader	實體的實例，例如hive_table，hive_database。
AtlasErrorResponse	來自服務的錯誤回應
AtlasLineageInfo	譜系資訊。
AtlasTermAssignmentHeader	字詞指派的標頭。
AtlasTermAssignmentStatus	字詞指派的狀態
EntityStatus	狀態 - 可以是作用中或刪除
LineageDirection	譜系方向
LineageRelation	從和到實體之 GUID 的譜系關聯性。
ParentRelation	與父實體 GUID 和子實體的譜系父系關聯性。
TimeBoundary	擷取時間界限詳細數據

AtlasClassification

分類的實例;它沒有身分識別，只有與實體相關聯的物件存在。

名稱	類型	Description
attributes		結構的屬性。
entityGuid	string	實體的 GUID。
entityStatus	EntityStatus	實體的狀態 - 可以是作用中或刪除。不會移除已刪除的實體。
lastModifiedTS	string	並行控制的 ETag。
removePropagationsOnEntityDelete	boolean	判斷是否會在實體刪除時移除傳播。
typeName	string	型別的名稱。
validityPeriods	TimeBoundary[]	指出有效期間的時間界限陣列。

AtlasEntityHeader

實體的實例，例如hive_table，hive_database。

名稱	類型	Description
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

來自服務的錯誤回應

名稱	類型	Description
errorCode	string	錯誤碼。
errorMessage	string	錯誤訊息。
requestId	string	要求識別碼。

AtlasLineageInfo

譜系資訊。

名稱	類型	Description
baseEntityGuid	string	基底實體的 GUID。
childrenCount	integer	子節點的數目。
guidEntityMap	<string, AtlasEntityHeader>	GUID 實體對應。
lineageDepth	integer	譜系深度。
lineageDirection	LineageDirection	譜系方向的列舉。
lineageWidth	integer	譜系的寬度。
parentRelations	ParentRelation[]	parentRelations 關聯的陣列。
relations	LineageRelation[]	譜系關聯數位。
widthCounts	object	特定方向的實體計數。

AtlasTermAssignmentHeader

字詞指派的標頭。

名稱	類型	Description
confidence	integer	字詞指派的信賴度。
createdBy	string	建立記錄的使用者。
description	string	指派一詞的描述。
displayText	string	顯示文字。
expression	string	字詞指派的表達式。
relationGuid	string	關聯性的 GUID。
status	AtlasTermAssignmentStatus	條款指派的狀態。
steward	string	詞彙的負責人。
termGuid	string	詞彙的 GUID。

AtlasTermAssignmentStatus

字詞指派的狀態

名稱	類型	Description
DEPRECATED	string	狀態已被取代。
DISCOVERED	string	探索到狀態。
IMPORTED	string	狀態已匯入。
OBSOLETE	string	狀態已過時。
OTHER	string	其他狀態。
PROPOSED	string	建議狀態。
VALIDATED	string	狀態已驗證。

EntityStatus

狀態 - 可以是作用中或刪除

名稱	類型	Description
ACTIVE	string	狀態為作用中。
DELETED	string	狀態已刪除。

LineageDirection

譜系方向

名稱	類型	Description
BOTH	string	兩者皆可
INPUT	string	輸入
OUTPUT	string	output

LineageRelation

從和到實體之 GUID 的譜系關聯性。

名稱	類型	Description
fromEntityId	string	from-entity 的 GUID。
relationshipId	string	關聯性的 GUID。
toEntityId	string	to-entity 的 GUID。

ParentRelation

與父實體 GUID 和子實體的譜系父系關聯性。

名稱	類型	Description
childEntityId	string	子實體的 GUID。
parentEntityId	string	父實體的 GUID。
relationshipId	string	關聯性的 GUID。

TimeBoundary

擷取時間界限詳細數據

名稱	類型	Description
endTime	string	時間界限的結尾。
startTime	string	時間界限的開始。
timeZone	string	時間界限的時區。

共用方式為