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

Entity - Set Labels By Unique Attribute

将标签设置为由其类型和唯一属性标识的给定实体。

如果标签为 null/空,则现有标签将全部删除。

除了 typeName 路径参数以外,还可以按以下格式提供属性键值对 () :attr:=。

注意:attrName 和 attrValue 在实体中应是唯一的,例如qualifiedName。

REST 请求如下所示:POST /v2/entity/uniqueAttribute/type/aType?attr:aTypeAttribute=someValue。

POST {endpoint}/datamap/api/atlas/v2/entity/uniqueAttribute/type/{typeName}/labels
POST {endpoint}/datamap/api/atlas/v2/entity/uniqueAttribute/type/{typeName}/labels?attr:qualifiedName={attr:qualifiedName}

URI 参数

名称 必需 类型 说明
endpoint
path True

string

typeName
path True

string

类型的名称。

attr:qualifiedName
query

string

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

请求正文

名称 类型 说明
body

string[]

要设置的标签集

响应

名称 类型 说明
204 No Content

没有要为此请求发送的内容,但标头可能很有用。

Other Status Codes

AtlasErrorResponse

意外的错误响应。

安全性

OAuth2Auth

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

作用域

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

示例

Entity_SetLabelsByUniqueAttribute

示例请求

POST {endpoint}/datamap/api/atlas/v2/entity/uniqueAttribute/type/Asset/labels?attr:qualifiedName=https://asset1

[
  "label1",
  "label2"
]

示例响应

定义

AtlasErrorResponse

来自服务的错误响应

名称 类型 说明
errorCode

string

错误代码。

errorMessage

string

错误消息。

requestId

string

请求 ID。