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

Entity - List By Guids

列出按其 GUID 批量标识的实体。

GET {endpoint}/datamap/api/atlas/v2/entity/bulk?guid={guid}
GET {endpoint}/datamap/api/atlas/v2/entity/bulk?api-version=2023-09-01&guid={guid}&minExtInfo={minExtInfo}&ignoreRelationships={ignoreRelationships}

URI 参数

名称 必需 类型 说明
endpoint
path True

string

guid
query True

string[]

要列出的实体的 GUID 数组。

api-version
query

string

要用于此操作的 API 版本。

ignoreRelationships
query

boolean

是否忽略关系属性。

minExtInfo
query

boolean

是否返回引用实体的最少信息。

响应

名称 类型 说明
200 OK

AtlasEntitiesWithExtInfo

请求已成功。

Other Status Codes

AtlasErrorResponse

意外的错误响应。

安全性

OAuth2Auth

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

作用域

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

示例

Entity_ListByGuids

示例请求

GET {endpoint}/datamap/api/atlas/v2/entity/bulk?api-version=2023-09-01&guid=784c0f2f-afd2-e26b-f9cb-984f6c2c5021&guid=b4ebc8be-cef4-860a-bee9-28cc34cb5caa&minExtInfo=True

示例响应

{
  "referredEntities": {},
  "entities": [
    {
      "typeName": "column",
      "attributes": {
        "owner": null,
        "qualifiedName": "adl://exampleaccount.azuredatalakestore.net/123/1/DP_TFS/CBT/Extensions/DTTP.targets#:xml/Project/PropertyGroup/ExampleName1",
        "name": "ExampleName1",
        "description": null,
        "type": "string"
      },
      "guid": "784c0f2f-afd2-e26b-f9cb-984f6c2c5021",
      "status": "ACTIVE",
      "createdBy": "ExampleCreator",
      "updatedBy": "ExampleUpdator",
      "createTime": 1553072455110,
      "updateTime": 1553072455110,
      "version": 0,
      "relationshipAttributes": {
        "schema": [],
        "inputToProcesses": [],
        "composeSchema": {
          "guid": "cc6652ae-dc6d-90c9-1899-252eabc0e929",
          "typeName": "tabular_schema",
          "displayText": "tabular_schema",
          "relationshipGuid": "400fd8e4-97bd-45eb-a21c-880b4094ce5b",
          "relationshipStatus": "ACTIVE",
          "relationshipAttributes": {
            "typeName": "tabular_schema_columns"
          }
        },
        "meanings": [],
        "outputFromProcesses": [],
        "tabular_schema": null
      },
      "contacts": {
        "Expert": [
          {
            "id": "30435ff9-9b96-44af-a5a9-e05c8b1ae2df",
            "info": "Example Expert Info"
          }
        ],
        "Owner": [
          {
            "id": "30435ff9-9b96-44af-a5a9-e05c8b1ae2df",
            "info": "Example Owner Info"
          }
        ]
      }
    },
    {
      "typeName": "column",
      "attributes": {
        "owner": null,
        "qualifiedName": "adl://exampleaccount.azuredatalakestore.net/123/1/Experience/CBT/Extensions/CodeAnalysis.targets#:xml/Project/PropertyGroup/ExampleName2",
        "name": "ExampleName2",
        "description": null,
        "type": "string"
      },
      "guid": "b4ebc8be-cef4-860a-bee9-28cc34cb5caa",
      "status": "ACTIVE",
      "createdBy": "ExampleCreator",
      "updatedBy": "ExampleUpdator",
      "createTime": 1553072455110,
      "updateTime": 1553072455110,
      "version": 0,
      "relationshipAttributes": {
        "schema": [],
        "inputToProcesses": [],
        "composeSchema": {
          "guid": "381dd3e6-dad5-7409-c21d-ea55b666e420",
          "typeName": "tabular_schema",
          "displayText": "tabular_schema",
          "relationshipGuid": "0b652860-ab79-48cd-a0cf-0867fbba31a3",
          "relationshipStatus": "ACTIVE",
          "relationshipAttributes": {
            "typeName": "tabular_schema_columns"
          }
        },
        "meanings": [],
        "outputFromProcesses": [],
        "tabular_schema": null
      },
      "contacts": {
        "Expert": [
          {
            "id": "30435ff9-9b96-44af-a5a9-e05c8b1ae2df",
            "info": "Example Expert Info"
          }
        ],
        "Owner": [
          {
            "id": "30435ff9-9b96-44af-a5a9-e05c8b1ae2df",
            "info": "Example Owner Info"
          }
        ]
      }
    }
  ]
}

定义

名称 说明
AtlasClassification

分类的实例;它没有标识,此对象仅在与实体关联时才存在。

AtlasEntitiesWithExtInfo

实体的实例以及扩展信息(如hive_table、hive_database)。

AtlasEntity

实体的实例-例如hive_table、hive_database。

AtlasErrorResponse

来自服务的错误响应

AtlasTermAssignmentHeader

术语分配的标头。

AtlasTermAssignmentStatus

术语分配的状态

EntityStatus

状态 - 可以是活动状态,也可以已删除

TimeBoundary

捕获时间边界详细信息

AtlasClassification

分类的实例;它没有标识,此对象仅在与实体关联时才存在。

名称 类型 说明
attributes

结构的属性。

entityGuid

string

实体的 GUID。

entityStatus

EntityStatus

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

lastModifiedTS

string

用于并发控制的 ETag。

removePropagationsOnEntityDelete

boolean

确定是否在删除实体时删除传播。

typeName

string

类型的名称。

validityPeriods

TimeBoundary[]

指示有效期的时间边界数组。

AtlasEntitiesWithExtInfo

实体的实例以及扩展信息(如hive_table、hive_database)。

名称 类型 说明
entities

AtlasEntity[]

实体数组。

referredEntities

<string,  AtlasEntity>

引用的实体。

AtlasEntity

实体的实例-例如hive_table、hive_database。

名称 类型 说明
attributes

结构的属性。

businessAttributes

业务属性

classifications

AtlasClassification[]

分类数组。

collectionId

string

实体的集合 ID。

contacts

object

实体的联系人字典。 密钥可以是“专家”或“所有者”。

createTime

integer

记录的创建时间。

createdBy

string

创建记录的用户。

customAttributes

object

自定义属性

guid

string

实体的 GUID。

homeId

string

实体的主 ID。

isIncomplete

boolean

是否为 shell 实体

labels

string[]

标签

lastModifiedTS

string

用于并发控制的 ETag。

meanings

AtlasTermAssignmentHeader[]

表示实体含义的术语赋值标头数组。

provenanceType

integer

用于记录实体或关系的实例的来源。

proxy

boolean

确定是否有代理。

relationshipAttributes

关系的属性。

status

EntityStatus

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

typeName

string

类型的名称。

updateTime

integer

记录的更新时间。

updatedBy

string

更新记录的用户。

version

integer

实体的版本。

AtlasErrorResponse

来自服务的错误响应

名称 类型 说明
errorCode

string

错误代码。

errorMessage

string

错误消息。

requestId

string

请求 ID。

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

状态已删除。

TimeBoundary

捕获时间边界详细信息

名称 类型 说明
endTime

string

时间边界的结束。

startTime

string

时间边界的开始。

timeZone

string

时间边界的时区。