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

Types - Get Relationship Def By Name

按其名称获取关系定义, (唯一) 。

GET {Endpoint}/catalog/api/atlas/v2/types/relationshipdef/name/{name}

URI 参数

Name In Required Type Description
Endpoint
path True
  • string

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

name
path True
  • string

关系的名称。

响应

Name Type Description
200 OK

没问题。 成功按其名称查找关系定义。

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 模拟用户帐户

示例

Types_GetRelationshipDefByName

Sample Request

GET {Endpoint}/catalog/api/atlas/v2/types/relationshipdef/name/storm_topology_nodes

Sample Response

{
  "category": "RELATIONSHIP",
  "guid": "695edde1-2782-4a3c-841b-0b3aba25fe45",
  "createdBy": "ExampleCreator",
  "updatedBy": "ExampleUpdator",
  "createTime": 1553065976797,
  "updateTime": 1553065976797,
  "version": 1,
  "name": "storm_topology_nodes",
  "description": "storm_topology_nodes",
  "typeVersion": "1.0",
  "attributeDefs": [],
  "relationshipCategory": "ASSOCIATION",
  "endDef1": {
    "type": "storm_topology",
    "name": "nodes",
    "isContainer": false,
    "cardinality": "SET",
    "isLegacyAttribute": true
  },
  "endDef2": {
    "type": "storm_node",
    "name": "topolgies",
    "isContainer": false,
    "cardinality": "SET",
    "isLegacyAttribute": false
  },
  "relationshipLabel": "r:storm_topology_nodes"
}

定义

AtlasAttributeDef

AtlasAttributeDef

AtlasConstraintDef

AtlasConstraintDef

AtlasRelationshipDef

AtlasRelationshipDef

AtlasRelationshipEndDef

AtlasRelationshipEndDef

Cardinality

基数

DateFormat

DateFormat

ErrorResponse

来自服务的错误响应

NumberFormat

NumberFormat

Params

约束定义的参数。

RelationshipCategory

RelationshipCategory

RoundingMode

RoundingMode

TimeZone

TimeZone

TypeCategory

TypeCategory

AtlasAttributeDef

AtlasAttributeDef

Name Type Description
cardinality

基数
单值属性或多值属性。

constraints

约束数组。

defaultValue
  • string

属性的默认值。

description
  • string

属性的说明。

includeInNotification
  • boolean

确定它是否包含在通知中。

isIndexable
  • boolean

确定它是可索引的。

isOptional
  • boolean

确定它是可选的。

isUnique
  • boolean

确定它是否是唯一的。

name
  • string

属性名。

options
  • object

属性的选项。

typeName
  • string

类型的名称。

valuesMaxCount
  • integer

值的最大计数。

valuesMinCount
  • integer

值的最小计数。

AtlasConstraintDef

AtlasConstraintDef

Name Type Description
params

约束定义的参数。

type
  • string

约束的类型。

AtlasRelationshipDef

AtlasRelationshipDef

Name Type Description
attributeDefs

属性定义的数组。

category

TypeCategory
类别的枚举。

createTime
  • number

记录的创建时间。

createdBy
  • string

创建记录的用户。

dateFormatter

DateFormat
日期格式。

description
  • string

类型定义的说明。

endDef1

AtlasRelationshipEndDef
relationshipEndDef 表示关系的结尾。 关系的结尾由类型、属性名称、基数以及它是否为关系的容器端定义。

endDef2

AtlasRelationshipEndDef
relationshipEndDef 表示关系的结尾。 关系的结尾由类型、属性名称、基数以及它是否为关系的容器端定义。

guid
  • string

类型定义的 GUID。

lastModifiedTS
  • string

lastModifiedTS
用于并发控制的 ETag。

name
  • string

类型定义的名称。

options
  • object

类型定义的选项。

relationshipCategory

RelationshipCategory
“关系”类别确定围绕包含和生命周期的关系样式。 UML 术语用于值。

ASSOCIATION 是一个没有包含的关系。
COMPOSITION 和 AGGREGATION 是包含关系。

容器及其子级的生命周期存在差异。 在 COMPOSITION 情况下,如果没有容器,子级就不能存在。 对于 AGGREGATION,容器和子级的生命周期完全独立。

relationshipLabel
  • string

关系的标签。

serviceType
  • string

服务类型。

typeVersion
  • string

类型的版本。

updateTime
  • number

记录的更新时间。

updatedBy
  • string

更新记录的用户。

version
  • number

记录的版本。

AtlasRelationshipEndDef

AtlasRelationshipEndDef

Name Type Description
cardinality

基数
单值属性或多值属性。

description
  • string

关系结束定义的说明。

isContainer
  • boolean

确定它是容器。

isLegacyAttribute
  • boolean

确定它是旧属性。

name
  • string

关系结束定义的名称。

type
  • string

关系结束的类型。

Cardinality

基数

Name Type Description
LIST
  • string
SET
  • string
SINGLE
  • string

DateFormat

DateFormat

Name Type Description
availableLocales
  • string[]

可用区域设置的数组。

calendar
  • number
dateInstance

DateFormat
日期格式。

dateTimeInstance

DateFormat
日期格式。

instance

DateFormat
日期格式。

lenient
  • boolean

确定日期格式的宽大。

numberFormat

NumberFormat
数字格式。

timeInstance

DateFormat
日期格式。

timeZone

TimeZone
时区信息。

ErrorResponse

来自服务的错误响应

Name Type Description
errorCode
  • string

错误代码。

errorMessage
  • string

错误消息。

requestId
  • string

请求 ID。

NumberFormat

NumberFormat

Name Type Description
availableLocales
  • string[]

数字格式。

currency
  • string

货币。

currencyInstance

NumberFormat
数字格式。

groupingUsed
  • boolean

确定是否使用分组。

instance

NumberFormat
数字格式。

integerInstance

NumberFormat
数字格式。

maximumFractionDigits
  • integer

小数位数的最大值。

maximumIntegerDigits
  • integer

整数位数的最大值。

minimumFractionDigits
  • integer

最小分数位数。

minimumIntegerDigits
  • integer

整数位数的最小值。

numberInstance

NumberFormat
数字格式。

parseIntegerOnly
  • boolean

确定是否只分析整数。

percentInstance

NumberFormat
数字格式。

roundingMode

RoundingMode
舍入模式的枚举。

Params

约束定义的参数。

Name Type Description

RelationshipCategory

RelationshipCategory

Name Type Description
AGGREGATION
  • string
ASSOCIATION
  • string
COMPOSITION
  • string

RoundingMode

RoundingMode

Name Type Description
CEILING
  • string
DOWN
  • string
FLOOR
  • string
HALF_DOWN
  • string
HALF_EVEN
  • string
HALF_UP
  • string
UNNECESSARY
  • string
UP
  • string

TimeZone

TimeZone

Name Type Description
availableIds
  • string[]

可用 ID 的数组。

default

TimeZone
时区信息。

displayName
  • string

时区的显示名称。

dstSavings
  • integer

夏令时的值。

id
  • string

时区的 ID。

rawOffset
  • integer

时区的原始偏移量。

TypeCategory

TypeCategory

Name Type Description
ARRAY
  • string
CLASSIFICATION
  • string
ENTITY
  • string
ENUM
  • string
MAP
  • string
OBJECT_ID_TYPE
  • string
PRIMITIVE
  • string
RELATIONSHIP
  • string
STRUCT
  • string
TERM_TEMPLATE
  • string