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

Type - Get Struct Def By Name

按其名称获取结构定义 (唯一) 。

GET {endpoint}/datamap/api/atlas/v2/types/structdef/name/{name}

URI 参数

名称 必需 类型 说明
endpoint
path True

string

name
path True

string

结构的名称。

响应

名称 类型 说明
200 OK

AtlasStructDef

请求已成功。

Other Status Codes

AtlasErrorResponse

意外的错误响应。

安全性

OAuth2Auth

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

作用域

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

示例

Type_GetStructDefByName

示例请求

GET {endpoint}/datamap/api/atlas/v2/types/structdef/name/hive_order

示例响应

{
  "category": "STRUCT",
  "guid": "f1571b6e-ad08-4040-a9a7-c30ed935d437",
  "createdBy": "ExampleCreator",
  "updatedBy": "ExampleUpdator",
  "createTime": 1553065968145,
  "updateTime": 1553065968145,
  "version": 1,
  "name": "hive_order",
  "description": "hive_order",
  "typeVersion": "1.0",
  "attributeDefs": [
    {
      "name": "order",
      "typeName": "int",
      "isOptional": false,
      "cardinality": "SINGLE",
      "valuesMinCount": 1,
      "valuesMaxCount": 1,
      "isUnique": false,
      "isIndexable": false,
      "includeInNotification": false
    },
    {
      "name": "col",
      "typeName": "string",
      "isOptional": false,
      "cardinality": "SINGLE",
      "valuesMinCount": 1,
      "valuesMaxCount": 1,
      "isUnique": false,
      "isIndexable": false,
      "includeInNotification": false
    }
  ]
}

定义

名称 说明
AtlasAttributeDef

捕获结构特性详细信息的类。

AtlasConstraintDef

捕获约束详细信息的类。

AtlasErrorResponse

来自服务的错误响应

AtlasStructDef

捕获结构类型的详细信息的类。

CardinalityValue

基数

DateFormat

日期格式。

NumberFormat

数字格式。

RoundingMode

舍入模式

TimeZone

时区信息。

TypeCategory

类型类别

AtlasAttributeDef

捕获结构特性详细信息的类。

名称 类型 说明
cardinality

CardinalityValue

单值属性或多值属性。

constraints

AtlasConstraintDef[]

约束数组。

defaultValue

string

特性的默认值。

description

string

特性的说明。

includeInNotification

boolean

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

isIndexable

boolean

确定它是否可编制索引。

isOptional

boolean

确定它是否为可选。

isUnique

boolean

确定它是否唯一。

name

string

属性名。

options

object

属性的选项。

typeName

string

类型的名称。

valuesMaxCount

integer

值的最大计数。

valuesMinCount

integer

值的最小计数。

AtlasConstraintDef

捕获约束详细信息的类。

名称 类型 说明
params

约束定义的参数。

type

string

约束的类型。

AtlasErrorResponse

来自服务的错误响应

名称 类型 说明
errorCode

string

错误代码。

errorMessage

string

错误消息。

requestId

string

请求 ID。

AtlasStructDef

捕获结构类型的详细信息的类。

名称 类型 说明
attributeDefs

AtlasAttributeDef[]

属性定义的数组。

category

TypeCategory

类型为类别的枚举。

createTime

integer

记录的创建时间。

createdBy

string

创建记录的用户。

dateFormatter

DateFormat

日期格式。

description

string

类型定义的说明。

guid

string

类型定义的 GUID。

lastModifiedTS

string

用于并发控制的 ETag。

name

string

类型定义的名称。

options

object

类型定义的选项。

serviceType

string

服务类型。

typeVersion

string

类型的版本。

updateTime

integer

记录的更新时间。

updatedBy

string

更新记录的用户。

version

integer

记录的版本。

CardinalityValue

基数

名称 类型 说明
LIST

string

list

SET

string

set

SINGLE

string

single

DateFormat

日期格式。

名称 类型 说明
availableLocales

string[]

可用区域设置的数组。

calendar

number

日历

dateInstance

DateFormat

日期格式。

dateTimeInstance

DateFormat

日期格式。

instance

DateFormat

日期格式。

lenient

boolean

确定日期格式的宽大程度。

numberFormat

NumberFormat

数字格式。

timeInstance

DateFormat

日期格式。

timeZone

TimeZone

时区信息。

NumberFormat

数字格式。

名称 类型 说明
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

舍入模式的枚举。

RoundingMode

舍入模式

名称 类型 说明
CEILING

string

ceiling

DOWN

string

FLOOR

string

floor

HALF_DOWN

string

一半向下

HALF_EVEN

string

一半偶数

HALF_UP

string

一半向上

UNNECESSARY

string

不必要

UP

string

已启动

TimeZone

时区信息。

名称 类型 说明
availableIds

string[]

可用 ID 的数组。

default

TimeZone

时区信息。

displayName

string

时区的显示名称。

dstSavings

integer

夏令时的值。

id

string

时区的 ID。

rawOffset

integer

时区的原始偏移量。

TypeCategory

类型类别

名称 类型 说明
ARRAY

string

array

CLASSIFICATION

string

分类

ENTITY

string

实体

ENUM

string

枚举

MAP

string

map

OBJECT_ID_TYPE

string

对象 ID 类型

PRIMITIVE

string

基元

RELATIONSHIP

string

关系 (relationship)

STRUCT

string

struct

TERM_TEMPLATE

string

术语模板