CreateMetaEntityDef - 创建元数据实体类型定义

更新时间:
复制 MD 格式

创建元数据实体定义(包括纯自定义类型和扩展表类型)

接口说明

需要购买 DataWorks 专业版及以上版本才能使用。

调试

您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

调试

授权信息

下表是API对应的授权信息,可以在RAM权限策略语句的Action元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:

  • 操作:是指具体的权限点。

  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。

  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:

    • 对于必选的资源类型,用前面加 * 表示。

    • 对于不支持资源级授权的操作,用全部资源表示。

  • 条件关键字:是指云产品自身定义的条件关键字。

  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。

操作

访问级别

资源类型

条件关键字

关联操作

dataworks:CreateMetaEntityDef

create

*全部资源

*

请求语法

POST  HTTP/1.1

请求参数

名称

类型

必填

描述

示例值

Name

string

类型定义名称。纯自定义类型需匹配 ^[a-z0-9][a-z0-9_]*$;扩展表类型需匹配 ^[a-z0-9][a-z0-9_]*-table$

biz_api

DisplayName

string

展示名称,最长 32 个字符

Business API

Description

string

描述

description

Extend

string

扩展模式。

  • NONE,默认值,表示纯自定义实体,属性自由定义;

  • TABLE 表示扩展表类型,参考数据地图已有表类型的方式介入,不需要提供属性定义,可以创建对应的 Database/Table 对象

枚举值:

  • TABLE :

    扩展表实体

  • NONE :

    纯自定义实体

TABLE

AttributeDefs

array

纯自定义实体的属性定义列表。extend=TABLE 时不能传入

[]

MetaEntityAttributeDef

属性定义

返回参数

名称

类型

描述

示例值

object

Schema of Response

RequestId

string

请求 ID。

0A04C673-BEFA-5803-94E5-89E2D9F8C567

Success

boolean

请求是否成功

true

EntityType

string

创建后的实体类型

custom_entity-biz_api

示例

正常返回示例

JSON格式

{
  "RequestId": "0A04C673-BEFA-5803-94E5-89E2D9F8C567",
  "Success": true,
  "EntityType": "custom_entity-biz_api"
}

错误码

访问错误中心查看更多错误码。

变更历史

更多信息,参考变更详情