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

Entity - Create Or Update

在 Atlas 中创建或更新实体。 如果提供或唯一属性(例如:qualifiedName),则使用其唯一 guid 匹配现有实体。 不支持映射和集合数组。 例如,数组数组、数组<<映射<字符串、int>>。>

POST {Endpoint}/catalog/api/atlas/v2/entity

URI 参数

Name In Required Type Description
Endpoint
path True
  • string

Purview 帐户的目录终结点。 示例:https://{accountName}.purview.azure.com

请求正文

Name Type Description
entity

AtlasEntity
实体的实例 -例如hive_table,hive_database。

referredEntities
  • object

引用的实体。

响应

Name Type Description
200 OK

使用 EntityMutationResponse 创建。

Other Status Codes

描述操作失败的原因的错误响应。

安全性

azure_auth

Azure Active Directory OAuth2 Flow。

Type: oauth2
Flow: implicit
Authorization URL: https://login.microsoftonline.com/common/oauth2/authorize

Scopes

Name Description
user_impersonation 模拟用户帐户

示例

Entity_AddCustomAttribute
Entity_Create
Entity_Update

Entity_AddCustomAttribute

Sample Request

POST {Endpoint}/catalog/api/atlas/v2/entity

{
  "referredEntities": {},
  "entity": {
    "typeName": "azure_storage_account",
    "attributes": {
      "owner": "ExampleOwner",
      "modifiedTime": 0,
      "createTime": 0,
      "qualifiedName": "https://exampleaccount.core.windows.net",
      "name": "ExampleStorageAccount",
      "description": null,
      "publicAccessLevel": null
    },
    "customAttributes": {
      "custAttr1": "attr1",
      "custAttr2": "attr2"
    }
  }
}

Sample Response

{
  "mutatedEntities": {
    "CREATE": [
      {
        "typeName": "azure_storage_account",
        "attributes": {
          "owner": "ExampleOwner",
          "createTime": 0,
          "qualifiedName": "https://exampleaccount.core.windows.net",
          "name": "ExampleStorageAccount"
        },
        "lastModifiedTS": "1",
        "guid": "c696b935-2c76-4208-bc0d-8864553a67f1",
        "displayText": "ExampleStorageAccount",
        "classificationNames": [],
        "classifications": [],
        "meaningNames": [],
        "meanings": [],
        "isIncomplete": false,
        "labels": []
      }
    ]
  },
  "guidAssignments": {
    "-16806536444330": "c696b935-2c76-4208-bc0d-8864553a67f1"
  }
}

Entity_Create

Sample Request

POST {Endpoint}/catalog/api/atlas/v2/entity

{
  "referredEntities": {},
  "entity": {
    "typeName": "azure_storage_account",
    "attributes": {
      "owner": "ExampleOwner",
      "modifiedTime": 0,
      "createTime": 0,
      "qualifiedName": "https://exampleaccount.core.windows.net",
      "name": "ExampleStorageAccount",
      "description": null,
      "publicAccessLevel": null
    },
    "contacts": {
      "Expert": [
        {
          "id": "30435ff9-9b96-44af-a5a9-e05c8b1ae2df",
          "info": "Example Expert Info"
        }
      ],
      "Owner": [
        {
          "id": "30435ff9-9b96-44af-a5a9-e05c8b1ae2df",
          "info": "Example Owner Info"
        }
      ]
    },
    "status": "ACTIVE",
    "createdBy": "ExampleCreator",
    "updatedBy": "ExampleUpdator",
    "version": 0
  }
}

Sample Response

{
  "mutatedEntities": {
    "CREATE": [
      {
        "typeName": "azure_storage_account",
        "attributes": {
          "qualifiedName": "https://exampleaccount.core.windows.net"
        },
        "lastModifiedTS": "1",
        "guid": "38d3c41f-300c-434e-8dad-0b1a7cb5efd6",
        "status": "ACTIVE"
      }
    ]
  },
  "guidAssignments": {
    "-9514774903018162": "38d3c41f-300c-434e-8dad-0b1a7cb5efd6"
  }
}

Entity_Update

Sample Request

POST {Endpoint}/catalog/api/atlas/v2/entity

{
  "referredEntities": {},
  "entity": {
    "typeName": "azure_storage_account",
    "attributes": {
      "owner": "ExampleOwner",
      "modifiedTime": 0,
      "createTime": 0,
      "qualifiedName": "exampleaccount",
      "name": "ExampleStorageAccount",
      "description": null,
      "publicAccessLevel": null
    },
    "contacts": {
      "Expert": [
        {
          "id": "30435ff9-9b96-44af-a5a9-e05c8b1ae2df",
          "info": "Example Expert Info"
        }
      ],
      "Owner": [
        {
          "id": "30435ff9-9b96-44af-a5a9-e05c8b1ae2df",
          "info": "Example Owner Info"
        }
      ]
    },
    "status": "ACTIVE",
    "createdBy": "ExampleCreator",
    "updatedBy": "ExampleUpdator",
    "version": 0
  }
}

Sample Response

{
  "mutatedEntities": {
    "UPDATE": [
      {
        "typeName": "azure_storage_account",
        "attributes": {
          "qualifiedName": "exampleaccount"
        },
        "lastModifiedTS": "2",
        "guid": "029d5668-a36c-40a9-bc11-6f352bafdc3b"
      }
    ]
  },
  "guidAssignments": {
    "-9514774903018167": "029d5668-a36c-40a9-bc11-6f352bafdc3b"
  }
}

定义

AtlasClassification

AtlasClassification

AtlasEntity

AtlasEntity

AtlasEntityHeader

AtlasEntityHeader

AtlasEntityWithExtInfo

AtlasEntityWithExtInfo

AtlasTermAssignmentHeader

AtlasTermAssignmentHeader

AtlasTermAssignmentStatus

AtlasTermAssignmentStatus

Attributes

结构的属性。

EntityMutationResponse

EntityMutationResponse

ErrorResponse

服务的错误响应

RelationshipAttributes

关系的属性。

SourceDetails

有关源信息的更多详细信息

Status

状态

TimeBoundary

TimeBoundary

AtlasClassification

AtlasClassification

Name Type Description
attributes

结构的属性。

entityGuid
  • string

实体的 GUID。

entityStatus

状态
实体的状态 - 可以是活动或删除的。 删除的实体不会从 Atlas 存储中删除。

lastModifiedTS
  • string

lastModifiedTS
用于并发控制的 ETag。

removePropagationsOnEntityDelete
  • boolean

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

source
  • string

指示创建分类详细信息的源

sourceDetails

有关源信息的更多详细信息

typeName
  • string

类型的名称。

validityPeriods

一个时间边界数组,指示有效期。

AtlasEntity

AtlasEntity

Name Type Description
attributes

结构的属性。

businessAttributes
  • object

业务属性

classifications

分类数组。

contacts
  • object

术语的联系人字典。 密钥可以是专家或所有者。

createTime
  • number

记录的创建时间。

createdBy
  • string

创建记录的用户。

customAttributes
  • object

自定义属性

guid
  • string

实体的 GUID。

homeId
  • string

实体的主 ID。

isIncomplete
  • boolean

它是否为 shell 实体

labels
  • string[]

标签

lastModifiedTS
  • string

lastModifiedTS
用于并发控制的 ETag。

meanings

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

provenanceType
  • number

用于记录实体或关系的实例的证明。

proxy
  • boolean

确定是否存在代理。

relationshipAttributes

关系的属性。

source
  • string

指示创建分类详细信息的源

sourceDetails

有关源信息的更多详细信息

status

状态
实体的状态 - 可以是活动或删除的。 删除的实体不会从 Atlas 存储中删除。

typeName
  • string

类型的名称。

updateTime
  • number

记录的更新时间。

updatedBy
  • string

更新记录的用户。

version
  • number

实体的版本。

AtlasEntityHeader

AtlasEntityHeader

Name Type Description
attributes

结构的属性。

classificationNames
  • string[]

分类名称数组。

classifications

分类数组。

displayText
  • string

显示文本。

guid
  • string

记录的 GUID。

isIncomplete
  • boolean

它是否为 shell 实体

labels
  • string[]

标签

lastModifiedTS
  • string

lastModifiedTS
用于并发控制的 ETag。

meaningNames
  • string[]

含义数组。

meanings

术语分配标头数组。

status

状态
实体的状态 - 可以是活动或删除的。 删除的实体不会从 Atlas 存储中删除。

typeName
  • string

类型的名称。

AtlasEntityWithExtInfo

AtlasEntityWithExtInfo

Name Type Description
entity

AtlasEntity
实体的实例 -例如hive_table,hive_database。

referredEntities
  • object

引用的实体。

AtlasTermAssignmentHeader

AtlasTermAssignmentHeader

Name Type Description
confidence
  • integer

术语分配的置信度。

createdBy
  • string

创建记录的用户。

description
  • string

术语分配的说明。

displayText
  • string

显示文本。

expression
  • string

术语赋值表达式。

relationGuid
  • string

关系的 GUID。

source
  • string

术语的源。

status

AtlasTermAssignmentStatus
术语分配的状态。

steward
  • string

术语的管家。

termGuid
  • string

术语的 GUID。

AtlasTermAssignmentStatus

AtlasTermAssignmentStatus

Name Type Description
DEPRECATED
  • string
DISCOVERED
  • string
IMPORTED
  • string
OBSOLETE
  • string
OTHER
  • string
PROPOSED
  • string
VALIDATED
  • string

Attributes

结构的属性。

Name Type Description

EntityMutationResponse

EntityMutationResponse

Name Type Description
guidAssignments
  • object

包含实体的 GUID 分配映射。

mutatedEntities
  • object

可变实体的实体标头。

partialUpdatedEntities

部分更新的实体标头数组。

ErrorResponse

服务的错误响应

Name Type Description
errorCode
  • string

错误代码。

errorMessage
  • string

错误消息。

requestId
  • string

请求 ID。

RelationshipAttributes

关系的属性。

Name Type Description

SourceDetails

有关源信息的更多详细信息

Name Type Description

Status

状态

Name Type Description
ACTIVE
  • string
DELETED
  • string

TimeBoundary

TimeBoundary

Name Type Description
endTime
  • string

时间边界的结束。

startTime
  • string

时间边界的开始。

timeZone
  • string

时间边界的时区。