Entity - Get Header

참조

서비스:: Purview

API 버전:: 2023-09-01

GUID가 지정된 엔터티 헤더를 가져옵니다.

GET {endpoint}/datamap/api/atlas/v2/entity/guid/{guid}/header

URI 매개 변수

Name	In(다음 안에)	필수	형식	Description
endpoint	path	True	string
guid	path	True	string	엔터티의 전역적으로 고유한 식별자입니다.

응답

Name	형식	Description
200 OK	AtlasEntityHeader	요청이 성공했습니다.
Other Status Codes	AtlasErrorResponse	예기치 않은 오류 응답입니다.

보안

OAuth2Auth

형식: oauth2
Flow: implicit
권한 부여 URL: https://login.microsoftonline.com/common/oauth2/authorize

범위

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

예제

Entity_GetHeader

샘플 요청

HTTP

GET {endpoint}/datamap/api/atlas/v2/entity/guid/9fb74c11-ac48-4650-95bc-760665c5bd92/header

샘플 응답

상태 코드:: 200

{
  "classificationNames": [
    "MICROSOFT.PERSONAL.EMAIL"
  ],
  "displayText": "Example Storage Account",
  "guid": "9fb74c11-ac48-4650-95bc-760665c5bd92",
  "meaningNames": [],
  "meanings": [],
  "status": "ACTIVE",
  "lastModifiedTS": "3",
  "attributes": {
    "owner": "ExampleOwner",
    "createTime": 0,
    "qualifiedName": "https://exampleaccount.core.windows.net",
    "name": "ExampleStorageAccount"
  },
  "typeName": "azure_storage_account"
}

정의

Name	Description
AtlasClassification	분류의 instance, ID가 없으며, 이 개체는 엔터티와 연결된 경우에만 존재합니다.
AtlasEntityHeader	엔터티의 instance(예: hive_table, hive_database)
AtlasErrorResponse	서비스의 오류 응답
AtlasTermAssignmentHeader	용어 할당의 헤더입니다.
AtlasTermAssignmentStatus	용어 할당 상태
EntityStatus	상태 - 활성 또는 삭제 가능
TimeBoundary	시간 경계 세부 정보를 캡처합니다.

AtlasClassification

분류의 instance, ID가 없으며, 이 개체는 엔터티와 연결된 경우에만 존재합니다.

Name	형식	Description
attributes		구조체의 특성입니다.
entityGuid	string	엔터티의 GUID입니다.
entityStatus	EntityStatus	엔터티의 상태 - 활성 또는 삭제할 수 있습니다. 삭제된 엔터티는 제거되지 않습니다.
lastModifiedTS	string	동시성 제어를 위한 ETag입니다.
removePropagationsOnEntityDelete	boolean	엔터티 삭제 시 전파가 제거될지 여부를 결정합니다.
typeName	string	형식의 이름입니다.
validityPeriods	TimeBoundary[]	유효 기간을 나타내는 시간 경계의 배열입니다.

AtlasEntityHeader

엔터티의 instance(예: hive_table, hive_database)

Name	형식	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

서비스의 오류 응답

Name	형식	Description
errorCode	string	오류 코드입니다.
errorMessage	string	오류 메시지입니다.
requestId	string	요청 ID입니다.

AtlasTermAssignmentHeader

용어 할당의 헤더입니다.

Name	형식	Description
confidence	integer	용어 할당의 신뢰도입니다.
createdBy	string	레코드를 만든 사용자입니다.
description	string	용어 할당에 대한 설명입니다.
displayText	string	표시 텍스트입니다.
expression	string	용어 할당의 식입니다.
relationGuid	string	관계의 GUID입니다.
status	AtlasTermAssignmentStatus	용어 할당의 상태.
steward	string	용어의 청지기입니다.
termGuid	string	용어의 GUID입니다.

AtlasTermAssignmentStatus

용어 할당 상태

Name	형식	Description
DEPRECATED	string	상태 더 이상 사용되지 않습니다.
DISCOVERED	string	상태 검색됩니다.
IMPORTED	string	상태 가져옵니다.
OBSOLETE	string	상태 사용되지 않습니다.
OTHER	string	기타 상태.
PROPOSED	string	상태 제안됩니다.
VALIDATED	string	상태 유효성이 검사됩니다.

EntityStatus

상태 - 활성 또는 삭제 가능

Name	형식	Description
ACTIVE	string	상태 활성 상태입니다.
DELETED	string	상태 삭제됩니다.

TimeBoundary

시간 경계 세부 정보를 캡처합니다.

Name	형식	Description
endTime	string	시간 경계의 끝입니다.
startTime	string	시간 경계의 시작입니다.
timeZone	string	시간 경계의 표준 시간대입니다.

다음을 통해 공유