华为云用户手册

  • 响应示例 状态码: 202 Successful { "create_account_status" : { "account_id" : "0a6d25d23900d45c0faac010e0fb4de0", "account_name" : "paas_iam_573331", "completed_at" : "2022-08-24T06:41:15Z", "created_at" : "2022-08-24T06:41:15Z", "id" : "h-awjp43m7bz3b8jgy5v61jrfwakt3og8w", "state" : "in_progress", "failure_reason" : "string" } }
  • 响应参数 状态码: 202 表4 响应Body参数 参数 参数类型 描述 create_account_status CreateAccountStatusDto object 包含有关在组织中创建账号的CreateAccount请求的状态。 表5 CreateAccountStatusDto 参数 参数类型 描述 account_id String 如果账号创建成功,则为新账号的唯一标识符(ID)。 最大长度:36 account_name String 账号名称。 最大长度:64 completed_at String 创建账号和完成请求的日期和时间。 created_at String 请求创建账号的日期和时间。 id String 请求的唯一标识符(ID)。您可以从创建账号的初始CreateAccount请求的响应中获得此值。 最大长度:36 state String 创建账号的异步请求的状态,in_progress:处理中,succeeded:成功,failed:失败。 最小长度:1 最大长度:64 failure_reason String 如果请求失败,则说明失败原因。
  • 请求参数 表1 请求Header参数 参数 是否必选 参数类型 描述 X-Security-Token 否 String 如果正在使用临时安全凭据,则此header是必需的,该值是临时安全凭据的安全令牌(会话令牌)。 最小值:1 最大长度:2048 表2 请求Body参数 参数 是否必选 参数类型 描述 name 是 String 账号名称。 最大长度:64 email 否 String 邮箱。 最小长度:1 最大长度:64 phone 否 String 手机号码。 最小长度:1 最大长度:32 agency_name 否 String 委托名称。 最小长度:1 最大长度:32 tags 否 Array of TagDto objects 要绑定到新创建的账号的标签列表。 表3 TagDto 参数 是否必选 参数类型 描述 key 是 String 标签键的密钥标识符或名称。 最小长度:1 最大长度:128 value 是 String 与标签键关联的字符串值。您可以将标签的值设置为空字符串,但不能将标签的值设置为NULL。 最小长度:0 最大长度:255
  • 请求示例 创建账号 POST https://{hostname}/v1/organizations/accounts { "name" : "C9Qzukfn6FIyxAmC3dQclrwZW34UDu_rPSRrCQ4aGFm0-r1zC2RDHt5oHA-aY21B", "tags" : [ { "key" : "keystring", "value" : "valuestring" } ] }
  • 标签策略简介 标签策略是策略的一种类型,可帮助您在组织账号中对资源添加的标签进行标准化管理。标签策略对未添加标签的资源或未在标签策略中定义的标签不会生效。 例如:标签策略规定为某资源添加的标签A,需要遵循标签策略中定义的大小写规则和标签值。若标签A使用的大小写、标签值不符合标签策略,则资源将会被标记为不合规。 标签策略有如下两种应用方式: 1. 事后检查 —— 资源标签如果违反标签策略,则在资源在合规性结果中显示为不合规。 2. 事前拦截 —— 标签策略开启强制执行后,则会阻止在指定的资源类型上完成不合规的标记操作。 标签策略可以绑定到组织的根、OU和账号。当绑定到根和OU时,所有子OU和子账号都继承该标签策略。账号继承的所有标签策略和直接绑定到账户上的所有标签策略,根据继承运算符最终聚合为有效标签策略。
  • 继承运算符 在标签策略样例中,标签键,标签值和强制执行中使用了"@@assign"标识,该标识即为继承运算符。 继承运算符指定标签策略如何与组织树中的其他标签策略合并,以创建账号的有效标签策略。运算符包括值设置运算符和子控制运算符。 值设置运算符 您可以使用以下值设置运算符来控制策略与其父策略交互的方式: 表1 值设置运算符 运算符 说明 @@assign 用指定设置覆盖任何继承的策略设置。如果未继承指定的设置,则此运算符会将该设置添加到有效策略中。此运算符可以应用于任何类型的任何策略设置。 对于单值设置,此运算符将继承的值替换为指定值。 对于多值设置(JSON 数组),此运算符将删除所有继承的值,并将其替换为此策略指定的值。 @@append 向继承的设置添加指定的设置(而不删除任何设置)。如果未继承指定的设置,则此运算符会将该设置添加到有效策略中。只能将此运算符用于多值设置。 此运算符将指定的值添加到继承数组中的任何值。 @@remove 从有效策略中删除指定的继承设置(如果存在)。只能将此运算符用于多值设置。 此运算符仅从继承自父策略的值数组中删除指定值。其他值可以继续存在于数组中,并且可由子策略继承。 子控制运算符 默认情况下,允许所有运算符 (@@all)。 "@@operators_allowed_for_child_policies":["@@all"]表示:子OU和账号可以在策略中使用任何运算符。默认情况下,子策略中允许使用所有运算符。 "@@operators_allowed_for_child_policies":["@@assign", "@@append", "@@remove"]表示:子OU和账号只能在子策略中使用指定的运算符。您可以在此子控制运算符中指定一个或多个值设置运算符。 "@@operators_allowed_for_child_policies":["@@none"]表示:子OU和账号不能在策略中使用运算符。可以使用此运算符有效锁定在父策略中定义的值,以使子策略无法添加、追加或删除这些值。
  • API概览 微服务引擎API为开发者、合作伙伴提供微服务开发的开放接口,帮助用户快速、低成本地实现业务上云,使能微服务应用的高效运行。 对应的接口参考请参考下表: 表1 接口简介 类型 子类型 说明 CS E接口 动态配置 提供从配置管理中心导入、导出配置信息的接口。 引擎管理 提供创建、查询、删除微服务引擎的引擎管理接口。 微服务治理 提供治理策略的创建、修改、删除和查询等相关治理接口。 Nacos接口 Nacos API 提供命名空间创建、修改、查询和删除等相关接口。 ServiceComb原生接口 认证 提供微服务身份认证功能的相关操作接口。 微服务 提供微服务管理的相关操作接口。 契约 提供微服务契约查询、上传等相关操作接口。 微服务实例 提供微服务实例注册、上报心跳等相关操作接口。 依赖关系 提供微服务依赖关系查询接口。 配置管理 提供配置中心配置管理功能的相关操作接口。 微服务、契约、微服务实例、依赖关系接口只在华北-北京一、华北-北京四、华北-乌兰察布一、华东-上海一、华东-上海二、华南-广州、西南-贵阳一、中国-香港、亚太-新加坡、拉美-墨西哥城二、中东-利雅德局点支持。
  • 资源和成本规划 表1 资源和成本规划内容说明 华为云服务产品* 规格* 可用区 计费模式 购买个数* 单价 (¥) 合计(¥) 弹性公网IP 带宽费用: 独享 | 全动态BGP | 按带宽计费 | 5Mbit/s 华北-北京四,通用可用区, 包月 1 115.00 115.00 虚拟专用网络 规格: 全动态BGP | 按带宽计费 | 5Mbit/s | 连接(个): 10 华北-北京四,通用可用区, 包月 1 375 375.00 弹性负载均衡 实例规格类型: 共享型负载均衡 带宽: 全动态BGP | 带宽 | 5Mbit/s IP费用: 1个 | 全动态BGP 华北-北京四,通用可用区, 包月 1 265 265.00 云服务器ECS 规格: X86计算 | 通用计算增强型 | c3ne.xlarge.2 | 4核 | 8GB 镜像: Ubuntu | Ubuntu 20.04 server 64bit 系统盘: 通用型SSD | 40GB 弹性公网IP: 全动态BGP | 独享 | 按带宽计费 | 5Mbit/s 华北-北京四,通用可用区, 包月 2 604 1,208.00 Web应用防火墙 入门版 华北-北京四,通用可用区, 包月 1 99 99.00 企业主机安全 基础版 华北-北京四,通用可用区, 包月 2 10 20.00 云备份 存储库类型: 云服务器备份存储库 | 1000GB 华北-北京四,通用可用区, 包月 1 200 200.00 云监控服务 500M 华北-北京四,通用可用区, 包月 1 免费 0.00 云日志 服务 日志读写流量: 59.51 GB 日志索引流量: 299.51 GB 日志存储空间: 2096.09 GB 华北-北京四,通用可用区, 包月 1 130.65 130.65 Anti-DDoS流量清洗 500M 华北-北京四,通用可用区, 包月 1 免费 0.00 弹性伸缩 500M 华北-北京四,通用可用区, 包月 1 免费 0.00 数据库安全服务 数据库安全审计 | 基础版 华北-北京四,通用可用区, 包月 2 3000 6,000.00 云堡垒机 实例类型: 单机 性能规格: 10资产标准版 华北-北京四,通用可用区, 包月 1 700 700.00 分布式缓存服务Redis 基础版 | 5.0 | 主备 | X86 | D RAM | 2 | 128 MB 华北-北京四,通用可用区, 包月 2 8.44 16.88 分布式消息服务 Kafka版 kafka.2u4g.cluster | 代理个数:3 单个代理存储空间: 超高IO | 100GB 华北-北京四,通用可用区, 包月 1 2190 2,190.00 云数据库 GaussDB (for Influx) InfluxDB | 集群 | 1.7 | x86 | 2核8GB | 2 个 存储空间: 超高IO | 100GB 冷存储空间: 冷数据 | 500GB 华北-北京四,通用可用区, 包月 1 1545.6 1,545.60 云数据库 RDS(for PostgreSQL) PostgreSQL | 12 | 主备 | 通用型 | 2核4GB 存储空间: SSD云盘 | 40GB 华北-北京四,通用可用区, 包月 2 470 940.00 消息&短信 通用可用区 | 按需计费 | 验证码和通知短信 按需 华北-北京四,通用可用区, 按需 1 0.07/条 0.07 域名注册 英文域名 | 注册 | 1年 华北-北京四,通用可用区, 包年 1 34 34
  • 响应参数 状态码: 200 表4 响应Body参数 参数 参数类型 描述 data Object 返回的数据信息 状态码: 400 表5 响应Body参数 参数 参数类型 描述 error_code String 错误码,如DS.000,请求处理成功 error_msg String 错误信息 data Object 返回的数据信息 状态码: 401 表6 响应Body参数 参数 参数类型 描述 error_code String 错误码,如DS.000,请求处理成功 error_msg String 错误信息 data Object 返回的数据信息 状态码: 403 表7 响应Body参数 参数 参数类型 描述 error_code String 错误码,如DS.000,请求处理成功 error_msg String 错误信息 data Object 返回的数据信息 状态码: 404 表8 响应Body参数 参数 参数类型 描述 error_code String 错误码,如DS.000,请求处理成功 error_msg String 错误信息 data Object 返回的数据信息
  • 请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String IAM Token workspace 是 String DataArts Studio 工作空间ID 表3 请求Body参数 参数 是否必选 参数类型 描述 ids 是 Array of longs ID列表 del_types 否 String 删除物理表 枚举值: PHYSICAL_TABLE
  • 响应参数 状态码: 200 表5 响应Body参数 参数 参数类型 描述 data Object 返回的数据信息 状态码: 400 表6 响应Body参数 参数 参数类型 描述 data Object 返回的数据信息 状态码: 401 表7 响应Body参数 参数 参数类型 描述 data Object 返回的数据信息 状态码: 403 表8 响应Body参数 参数 参数类型 描述 data Object 返回的数据信息
  • URI POST /v2/{project_id}/design/models/action 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 项目id 表2 Query参数 参数 是否必选 参数类型 描述 action-id 是 String 需要执行的动作,根据导入的对象不同而选择不同的导入动作 枚举值: import_relation import_dimension import_codetable import_datastandard import_bizmetric import_bizcatalog import_atomic import_derivative import_compound import_aggregation model_id 否 String 模型id,在导入模型(import_relation)时必填 directory_id 否 String 导入的目录id,在导入码表(import_datastandard)和数据标准(import_datastandard)时生效,选填 skip-exist 否 Boolean 是否需要覆盖更新已有的实体 缺省值:false
  • 响应示例 状态码: 200 Success,返回data数据是 AtomicIndexVO 数组, 以及总数 { "data" : { "value" : { "records" : [ { "id" : "873264909264257024", "name_en" : "sum_total_amount", "name_ch" : "总车费", "description" : "", "create_by" : "abc", "cal_exp" : "sum(${873264563087376397})", "cal_fn_ids" : null, "l1_id" : "873232498044411904", "l2_id" : "873232716601204736", "l3_id" : "873233440420560896", "table_id" : "873264563070599168", "tb_name" : "行程订单", "dw_type" : " DLI ", "field_ids" : [ "873264563087376397" ], "field_names" : null, "status" : "PUBLISHED", "biz_type" : "FACT_ LOG IC_TABLE", "create_time" : "2021-08-06T18:02:59+08:00", "update_time" : "2021-08-06T18:02:59+08:00", "l1" : "城市交通", "l2" : "行程记录", "l3" : "行程事实", "approval_info" : { "id" : "873264909926957056", "tenant_id" : null, "name_ch" : null, "name_en" : null, "biz_id" : "873264909264257024", "biz_type" : null, "biz_info" : null, "biz_info_obj" : null, "biz_version" : 0, "biz_status" : "PUBLISHED", "approval_status" : "APPROVED", "approval_type" : null, "submit_time" : "2021-08-06T18:02:59+08:00", "create_by" : null, "l1" : null, "l2" : null, "l3" : null, "approval_time" : "2021-08-06T18:02:59+08:00", "approver" : "abc", "email" : null, "msg" : "Fast Approval OK.", "directory_path" : null }, "new_biz" : null } ] } } }
  • 响应参数 状态码: 200 表4 响应Body参数 参数 参数类型 描述 data data object 表5 data 参数 参数类型 描述 value value object 表6 value 参数 参数类型 描述 records Array of AtomicIndexVO objects AtomicIndexVO数组 total Integer 总数 表7 AtomicIndexVO 参数 参数类型 描述 id Long 编码 name_en String 字段名 最大长度:200 name_ch String 业务属性 最大长度:200 description String 最大长度:600 create_by String 创建人 cal_exp String 计算表达式,形如'sum(${fact_column_id})',其中fact_column_id表示引用事实表中的字段ID 最大长度:200 cal_fn_ids Array of longs 引用函数id l1_id Long 主题域分组id l2_id String 主题域id l3_id Long 业务对象guid table_id Long 表id tb_name String 表名称 dw_type String 数据连接类型 field_ids Array of longs 字段id信息 field_names Array of strings 字段名称信息 status String 业务状态 枚举值: DRAFT PUBLISH_DEVELOPING PUBLISHED OFFLINE_DEVELOPING OFFLINE REJECT biz_type String 业务类型 枚举值: ATOMIC_INDEX DERIVATIVE_INDEX DIMENSION DIMENSION_ATTRIBUTE DIMENSION_HIERARCHIES CONDITION_GROUP TIME_CONDITION COMMON_CONDITION FACT_LOGIC_TABLE TABLE_MODEL DIMENSION_LOGIC_TABLE STANDARD_ELEMENT AGGREGATION_LOGIC_TABLE TAG CODE_TABLE TABLE_MODEL_ATTRIBUTE FACT_DIMENSION FACT_ATTRIBUTE FACT_MEASURE SUMMARY_DIMENSION_ATTRIBUTE SUMMARY_TIME DIMENSION_TABLE_ATTRIBUTE QUALITY_RULE BIZ_METRIC COMPOUND_METRIC INFO_ARCH DEGENERATE_DIMENSION TABLE_MODEL_LOGIC SUBJECT create_time String 创建时间 update_time String 更新时间 l1 String 主题域分组中文名 l2 String 主题域中文名 l3 String 业务对象中文名 approval_info ApprovalVO object 审批信息 new_biz BizVersionManageVO object 业务版本管理. 表8 ApprovalVO 参数 参数类型 描述 id Long ID tenant_id String tenant id name_ch String 业务中文名 name_en String 业务英文名 biz_id Long 业务ID biz_type String 业务类型 枚举值: ATOMIC_INDEX DERIVATIVE_INDEX DIMENSION DIMENSION_ATTRIBUTE DIMENSION_HIERARCHIES CONDITION_GROUP TIME_CONDITION COMMON_CONDITION FACT_LOGIC_TABLE TABLE_MODEL DIMENSION_LOGIC_TABLE STANDARD_ELEMENT AGGREGATION_LOGIC_TABLE TAG CODE_TABLE TABLE_MODEL_ATTRIBUTE FACT_DIMENSION FACT_ATTRIBUTE FACT_MEASURE SUMMARY_DIMENSION_ATTRIBUTE SUMMARY_TIME DIMENSION_TABLE_ATTRIBUTE QUALITY_RULE BIZ_METRIC COMPOUND_METRIC INFO_ARCH DEGENERATE_DIMENSION TABLE_MODEL_LOGIC SUBJECT biz_info String 业务详情 biz_info_obj Object 业务详情 biz_version Integer 业务版本 biz_status String 业务状态 枚举值: DRAFT PUBLISH_DEVELOPING PUBLISHED OFFLINE_DEVELOPING OFFLINE REJECT approval_status String 业务审批状态 枚举值: DEVELOPING APPROVED REJECT WITHDREW approval_type String 业务审核类型 枚举值: PUBLISH OFFLINE submit_time String 提交时间 create_by String 创建者 l1 String 主题域分组 l2 String 主题域 l3 String 业务对象 approval_time String 审核时间 approver String 审核人 email String 审核人邮箱 msg String 审核信息 directory_path String 目录树 表9 BizVersionManageVO 参数 参数类型 描述 id Long ID信息 biz_type String 业务类型 枚举值: ATOMIC_INDEX DERIVATIVE_INDEX DIMENSION DIMENSION_ATTRIBUTE DIMENSION_HIERARCHIES CONDITION_GROUP TIME_CONDITION COMMON_CONDITION FACT_LOGIC_TABLE TABLE_MODEL DIMENSION_LOGIC_TABLE STANDARD_ELEMENT AGGREGATION_LOGIC_TABLE TAG CODE_TABLE TABLE_MODEL_ATTRIBUTE FACT_DIMENSION FACT_ATTRIBUTE FACT_MEASURE SUMMARY_DIMENSION_ATTRIBUTE SUMMARY_TIME DIMENSION_TABLE_ATTRIBUTE QUALITY_RULE BIZ_METRIC COMPOUND_METRIC INFO_ARCH DEGENERATE_DIMENSION TABLE_MODEL_LOGIC SUBJECT biz_id Long 业务id biz_info String 业务对象信息 status String 业务状态 枚举值: DRAFT PUBLISH_DEVELOPING PUBLISHED OFFLINE_DEVELOPING OFFLINE REJECT biz_version Integer 业务版本 create_time String 创建时间 update_time String 更新时间 状态码: 400 表10 响应Body参数 参数 参数类型 描述 error_code String 错误码,如DS.000,请求处理成功 error_msg String 错误信息 data Object 返回的数据信息 状态码: 401 表11 响应Body参数 参数 参数类型 描述 error_code String 错误码,如DS.000,请求处理成功 error_msg String 错误信息 data Object 返回的数据信息 状态码: 403 表12 响应Body参数 参数 参数类型 描述 error_code String 错误码,如DS.000,请求处理成功 error_msg String 错误信息 data Object 返回的数据信息
  • URI GET /v2/{project_id}/design/atomic-indexs 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 项目id 表2 Query参数 参数 是否必选 参数类型 描述 name 否 String 按名称或编码模糊查询 create_by 否 String 按创建者查询 approver 否 String 按审核人查询 status 否 String 业务状态 枚举值: DRAFT PUBLISH_DEVELOPING PUBLISHED OFFLINE_DEVELOPING OFFLINE REJECT begin_time 否 String 时间过滤左边界,与end_time一起使用,只支持时间范围过滤,单边过滤无效 end_time 否 String 时间过滤右边界,与begin_time一起使用只支持时间范围过滤,单边过滤无效 l3_id 否 Long 业务对象l3 id table_id 否 Long 关联表id limit 否 Integer 查询条数,即查询Y条数据。默认值50,取值范围[1,100] 最大值:100 缺省值:50 offset 否 Integer 查询起始坐标,即跳过X条数据,仅支持0或limit的整数倍,不满足则向下取整。默认值0 缺省值:0
  • 响应参数 状态码: 200 表4 响应Body参数 参数 参数类型 描述 data Object 返回的数据信息 状态码: 400 表5 响应Body参数 参数 参数类型 描述 error_code String 错误码,如DS.000,请求处理成功 error_msg String 错误信息 data Object 返回的数据信息 状态码: 401 表6 响应Body参数 参数 参数类型 描述 error_code String 错误码,如DS.000,请求处理成功 error_msg String 错误信息 data Object 返回的数据信息 状态码: 403 表7 响应Body参数 参数 参数类型 描述 error_code String 错误码,如DS.000,请求处理成功 error_msg String 错误信息 data Object 返回的数据信息 状态码: 404 表8 响应Body参数 参数 参数类型 描述 error_code String 错误码,如DS.000,请求处理成功 error_msg String 错误信息 data Object 返回的数据信息
  • 请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String IAM Token workspace 是 String DataArts Studio工作空间ID 表3 请求Body参数 参数 是否必选 参数类型 描述 ids 是 Array of longs ID列表 del_types 否 String 删除物理表 枚举值: PHYSICAL_TABLE
  • 响应参数 状态码: 200 表5 响应Body参数 参数 参数类型 描述 data Object 返回的数据信息 状态码: 400 表6 响应Body参数 参数 参数类型 描述 data Object 返回的数据信息 状态码: 401 表7 响应Body参数 参数 参数类型 描述 data Object 返回的数据信息 状态码: 403 表8 响应Body参数 参数 参数类型 描述 data Object 返回的数据信息
  • 请求示例 修改脚本名称为echoTimeShell的脚本内容,脚本类型为Shell,脚本内容为echo a,脚本关联的连接名称为con。 PUT /v1/b384b9e9ab9b4ee8994c8633aabc9505/scripts/echoTimeShell { "name": "echoTimeShell", "type": "Shell", "content": "echo a", "queueName": "default", "connectionName": "con" }
  • URI URI格式 GET /v1/{project_id}/jobs/{job_name}/instances/{instance_id} 参数说明 表1 URI参数说明 参数名 是否必选 参数类型 说明 project_id 是 String 项目编号,获取方法请参见项目ID和帐号ID。 job_name 是 String 作业名称 instance_id 是 Long 作业实例ID,获取方法请参见查询作业实例列表的响应参数。
  • 响应示例 成功响应 { "jobName":"job_batch", "instanceId":34765, "instanceType": 2, "status":"fail", "planTime":1551425326540, "startTime":1551425327000, "endTime":1551425387000, "executeTime":1, "forceSuccess":false, "ignoreSuccess":false, "total":2, "nodes":[ { "endTime":1551671590000, "inputRowCount":0, "instanceId":34765, "nodeName":"Dummy_8556", "queue":dlf_notdelete, "planTime":1551671580000, "retryTimes":0, "startTime":1551671584000, "status":"success", "type":"Dummy" }, { "endTime":1551671598000, "inputRowCount":0, "instanceId":34765, "logPath":"obs://dlf-test-log/job_batch/2019-03-04 11_53_00.000/error/error.job", "nodeName":"error", "planTime":1551671580000, "retryTimes":0, "startTime":1551671594000, "status":"success", "type":"DWS SQL" } ] } 失败响应 HTTP状态码 400 { "error_code":"DLF.0137", "error_msg":"Job instance does not exist." }
  • 响应示例 调用查询作业详情接口时,如果在参数中带上dependencies=true,则会返回下游依赖当前作业的作业,只返回第一层。 GET /v1/b384b9e9ab9b4ee8994c8633aabc9505/jobs/xxx_1?dependencies=true xxx_1表示作业名。 响应消息会返回下游依赖当前作业的作业,如下示例中的响应结果消息字段downstreamJobs。 成功响应 { "basicConfig": { "agency": "", "customFields": {}, "executeUser": "", "instanceTimeout": 0, "owner": "test_user", "priority": 0, "tags": {} }, "cleanoverdueDays": "60", "cleanWaitingJob": "cleanup", "createTime": "1695642745000", "downstreamJobs": [ { "jobId": "163240", "jobName": "xxx_2", "workSpace": "workspace_name" } ], "description": "", "emptyRunningJob": "0", "id": 608627, "lastUpdateUser": "test_user", "logPath": "obs://dlf-test-log", "name": "myJob", "nodes": [ { "failPolicy": "FAIL_CHILD", "location": { "x": "-45.5", "y": "-134.5" }, "maxExecutionTime": 360, "name": " MRS _Hive_SQL", "pollingInterval": 20, "preNodeName": [], "properties": [ { "name": "scriptName", "value": "test_hive_sql" }, { "name": "connectionName", "value": "mrs_hive_test" }, { "name": "database", "value": "default" }, { "name": "scriptArgs", "value": "test_var=111" } ], "retryInterval": 120, "retryTimes": 0, "type": "HiveSQL" } ], "processType": "BATCH", "schedule": { "type": "CRON" } } 失败响应 HTTP状态码 400 { "error_code":"DLF.0100", "error_msg":"The job does not exists." }
  • 响应示例 状态码: 200 Success,返回data数据是 TableModelVO { "data" : { "value" : { "id" : "1012314146584301568", "model_id" : "873242752312385536", "parent_table_id" : null, "parent_table_name" : null, "parent_table_code" : null, "model" : null, "data_format" : "Parquet", "obs_bucket" : null, "obs_location" : null, "configs" : "{}", "table_type" : "MANAGED", "owner" : "", "tb_name" : "staff_info", "dw_id" : "2c9080f07b03db8d017b198a4a20002f", "db_name" : "ctz_test", "queue_name" : "default", "schema" : "", "extend_info" : "{\"dirtyOutDatabase\":\"\",\"dirtyOutPrefix\":\"\",\"dirtyOutSuffix\":\"\",\"dirtyOutSwitch\":\"false\"}", "tb_guid" : null, "tb_id" : "NativeTable-2c9080f07b03db8d017b198a4a20002f-ctz_test-staff_info", "logic_tb_name" : "staff_info", "logic_tb_guid" : "1ab1a58b-9412-4901-bb80-4ccaaa0580e4", "description" : "无", "status" : "PUBLISHED", "logic_tb_id" : null, "biz_catalog_id" : "1012306178602041344", "catalog_path" : "工厂/人员管理/人员档案", "create_by" : "abc", "update_by" : "abc", "create_time" : "2022-08-25T10:55:00+08:00", "update_time" : "2022-08-25T10:55:45+08:00", "tags" : [ ], "approval_info" : null, "new_biz" : null, "attributes" : [ { "id" : "1012314146626244608", "name_en" : "id", "name_ch" : "主键", "description" : "", "obs_location" : null, "create_by" : "abc", "update_by" : "abc", "data_type" : "STRING", "domain_type" : "STRING", "data_type_extend" : "", "is_primary_key" : true, "is_partition_key" : false, "is_foreign_key" : false, "extend_field" : false, "not_null" : true, "ordinal" : 1, "table_model_id" : null, "create_time" : "2022-08-25T10:55:00+08:00", "update_time" : "2022-08-25T10:55:00+08:00", "tags" : [ ], "stand_row_id" : null, "stand_row_name" : null, "quality_infos" : null, "alias" : "", "self_defined_fields" : [ ] }, { "id" : "1012314146626244609", "name_en" : "name", "name_ch" : "名称", "description" : "", "obs_location" : null, "create_by" : "abc", "update_by" : "abc", "data_type" : "STRING", "domain_type" : "STRING", "data_type_extend" : "", "is_primary_key" : false, "is_partition_key" : false, "is_foreign_key" : false, "extend_field" : false, "not_null" : false, "ordinal" : 2, "table_model_id" : null, "create_time" : "2022-08-25T10:55:00+08:00", "update_time" : "2022-08-25T10:55:00+08:00", "tags" : [ ], "stand_row_id" : null, "stand_row_name" : null, "quality_infos" : null, "alias" : "", "self_defined_fields" : [ ] }, { "id" : "1012314146592690176", "name_en" : "age", "name_ch" : "年龄", "description" : "", "obs_location" : null, "create_by" : "abc", "update_by" : "abc", "data_type" : "STRING", "domain_type" : "STRING", "data_type_extend" : "", "is_primary_key" : false, "is_partition_key" : false, "is_foreign_key" : false, "extend_field" : false, "not_null" : false, "ordinal" : 3, "table_model_id" : null, "create_time" : "2022-08-25T10:55:00+08:00", "update_time" : "2022-08-25T10:55:00+08:00", "tags" : [ ], "stand_row_id" : null, "stand_row_name" : null, "quality_infos" : null, "alias" : "", "self_defined_fields" : [ ] } ], "mappings" : null, "relations" : [ ], "dw_type" : "DLI", "dw_name" : null, "l1" : "工厂", "l2" : "人员管理", "l3" : "人员档案", "l1_id" : "1012305751919689728", "l2_id" : "1012306048792526848", "l3_id" : "1012306178602041344", "partition_conf" : null, "dlf_task_id" : null, "use_recently_partition" : false, "reversed" : null, "dirty_out_switch" : false, "dirty_out_database" : "", "dirty_out_prefix" : "", "dirty_out_suffix" : "", "quality_owner" : null, "quality_id" : "1012314332484304897", "distribute" : null, "distribute_column" : null, "is_partition" : false, "physical_table" : "CREATE_SUC CES S", "technical_asset" : "CREATE_FAILED", "business_asset" : "UPDATE_SUCCESS", "meta_data_link" : "UPDATE_FAILED", "data_quality" : "CREATE_SUCCESS", "summary_status" : "SUMMARY_FAILED", "alias" : null, "self_defined_fields" : null } } }
  • 请求示例 { "id" : "1012314146584301568", "model_id" : "873242752312385536", "parent_table_id" : null, "parent_table_name" : null, "parent_table_code" : null, "model" : { "name" : "test", "type" : "THIRD_NF" }, "data_format" : "Parquet", "obs_bucket" : null, "obs_location" : null, "configs" : "{}", "table_type" : "MANAGED", "owner" : "", "tb_name" : "staff_info", "dw_id" : "2c9080f07b03db8d017b198a4a20002f", "db_name" : "ctz_test", "queue_name" : "default", "schema" : "", "extend_info" : "{\"dirtyOutDatabase\":\"\",\"dirtyOutPrefix\":\"\",\"dirtyOutSuffix\":\"\",\"dirtyOutSwitch\":\"false\"}", "tb_guid" : null, "tb_id" : "NativeTable-2c9080f07b03db8d017b198a4a20002f-ctz_test-staff_info", "logic_tb_name" : "staff_info", "logic_tb_guid" : "1ab1a58b-9412-4901-bb80-4ccaaa0580e4", "description" : "无", "status" : "PUBLISHED", "logic_tb_id" : null, "biz_catalog_id" : "1012306178602041344", "catalog_path" : "工厂/人员管理/人员档案", "create_by" : "abc", "update_by" : "abc", "create_time" : "2022-08-25T10:55:00+08:00", "update_time" : "2022-08-25T10:55:45+08:00", "tags" : [ { "name" : 123 } ], "approval_info" : { "id" : "1012314318533988352", "tenant_id" : null, "name_ch" : null, "name_en" : null, "biz_id" : "1012314146584301568", "biz_type" : null, "biz_info" : null, "biz_info_obj" : null, "biz_version" : 0, "biz_status" : "PUBLISHED", "approval_status" : "APPROVED", "approval_type" : null, "submit_time" : "2022-08-25T10:55:41+08:00", "create_by" : null, "l1" : null, "l2" : null, "l3" : null, "approval_time" : "2022-08-25T10:55:41+08:00", "approver" : "abc", "email" : null, "msg" : "Fast Approval OK.", "directory_path" : null }, "new_biz" : null, "attributes" : [ { "id" : "1012314146626244608", "name_en" : "id", "name_ch" : "主键", "description" : "", "obs_location" : null, "create_by" : "abc", "update_by" : "abc", "data_type" : "STRING", "domain_type" : "STRING", "data_type_extend" : "", "is_primary_key" : true, "is_partition_key" : false, "is_foreign_key" : false, "extend_field" : false, "not_null" : true, "ordinal" : 1, "table_model_id" : null, "create_time" : "2022-08-25T10:55:00+08:00", "update_time" : "2022-08-25T10:55:00+08:00", "tags" : [ { "name" : 123 } ], "stand_row_id" : null, "stand_row_name" : null, "quality_infos" : [ { "data_quality_id" : 3 } ], "alias" : "", "self_defined_fields" : [ ] }, { "id" : "1012314146626244609", "name_en" : "name", "name_ch" : "名称", "description" : "", "obs_location" : null, "create_by" : "abc", "update_by" : "abc", "data_type" : "STRING", "domain_type" : "STRING", "data_type_extend" : "", "is_primary_key" : false, "is_partition_key" : false, "is_foreign_key" : false, "extend_field" : false, "not_null" : false, "ordinal" : 2, "table_model_id" : null, "create_time" : "2022-08-25T10:55:00+08:00", "update_time" : "2022-08-25T10:55:00+08:00", "tags" : [ { "name" : 123 } ], "stand_row_id" : null, "stand_row_name" : null, "quality_infos" : [ { "data_quality_id" : 3 } ], "alias" : "", "self_defined_fields" : [ ] }, { "id" : "1012314146592690176", "name_en" : "age", "name_ch" : "年龄", "description" : "", "obs_location" : null, "create_by" : "abc", "update_by" : "abc", "data_type" : "STRING", "domain_type" : "STRING", "data_type_extend" : "", "is_primary_key" : false, "is_partition_key" : false, "is_foreign_key" : false, "extend_field" : false, "not_null" : false, "ordinal" : 3, "table_model_id" : null, "create_time" : "2022-08-25T10:55:00+08:00", "update_time" : "2022-08-25T10:55:00+08:00", "tags" : [ { "name" : 123 } ], "stand_row_id" : null, "stand_row_name" : null, "quality_infos" : [ { "data_quality_id" : 3 } ], "alias" : "", "self_defined_fields" : [ ] } ], "mappings" : [ { "name" : "test_mapping" } ], "relations" : [ { "name" : "test_relation" } ], "dw_type" : "DLI", "dw_name" : null, "l1" : "工厂", "l2" : "人员管理", "l3" : "人员档案", "l1_id" : "1012305751919689728", "l2_id" : "1012306048792526848", "l3_id" : "1012306178602041344", "partition_conf" : null, "dlf_task_id" : null, "use_recently_partition" : false, "reversed" : null, "dirty_out_switch" : false, "dirty_out_database" : "", "dirty_out_prefix" : "", "dirty_out_suffix" : "", "quality_owner" : null, "quality_id" : "1012314332484304897", "distribute" : null, "distribute_column" : null, "is_partition" : false, "physical_table" : "CREATE_SUCCESS", "technical_asset" : "CREATE_FAILED", "business_asset" : "UPDATE_SUCCESS", "meta_data_link" : "UPDATE_FAILED", "data_quality" : "CREATE_SUCCESS", "summary_status" : "SUMMARY_FAILED", "alias" : null, "self_defined_fields" : null }
  • 响应参数 状态码: 200 表18 响应Body参数 参数 参数类型 描述 data Object 返回的数据信息 状态码: 400 表19 响应Body参数 参数 参数类型 描述 error_code String 错误码,如DS.000,请求处理成功 error_msg String 错误信息 data Object 返回的数据信息 状态码: 401 表20 响应Body参数 参数 参数类型 描述 error_code String 错误码,如DS.000,请求处理成功 error_msg String 错误信息 data Object 返回的数据信息 状态码: 403 表21 响应Body参数 参数 参数类型 描述 error_code String 错误码,如DS.000,请求处理成功 error_msg String 错误信息 data Object 返回的数据信息
  • 请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String IAM Token workspace 是 String DataArts Studio工作空间ID 表3 请求Body参数 参数 是否必选 参数类型 描述 id 是 Long 编码 model_id 是 Long 模型id parent_table_id 否 Long 父表id parent_table_name 否 String 父表名称 parent_table_code 否 String 父表编码 model 否 WorkspaceVO object 模型 data_format 否 String 数据格式 最大长度:100 obs_bucket 否 String obs桶 最大长度:200 obs_location 否 String obs路径 最大长度:2000 configs 否 String 其他配置 最大长度:1024 table_type 否 String 表类型 owner 否 String 最大长度:100 tb_name 是 String 表名 最大长度:400 dw_id 否 String 数据连接id db_name 否 String 数据库名 queue_name 否 String dli数据连接执行sql所需的队列,数据连接类型为DLI时必须 schema 否 String DWS类型需要 extend_info 否 String 扩展信息 tb_guid 否 String 表物化后的guid tb_id 否 String 数据表id logic_tb_name 是 String 逻辑实体名 最大长度:200 logic_tb_guid 否 String 逻辑实体的guid description 是 String 描述 最大长度:600 status 否 String 业务状态 枚举值: DRAFT PUBLISH_DEVELOPING PUBLISHED OFFLINE_DEVELOPING OFFLINE REJECT logic_tb_id 否 Long 逻辑实体的id biz_catalog_id 否 Long 归属的业务分类的id catalog_path 否 String 归属的业务分类的路径 {"l1Id":"","l2Id":"","l3Id":""} create_by 否 String 创建人 update_by 否 String 更新人 create_time 否 String 创建时间 update_time 否 String 更新时间 tags 否 Array of TagVO objects 表标签 approval_info 否 ApprovalVO object 审批信息 new_biz 否 BizVersionManageVO object 业务版本管理. attributes 是 Array of TableModelAttributeVO objects 表属性信息 mappings 否 Array of TableMappingVO objects 表映射信息 relations 否 Array of RelationVO objects 关系 dw_type 是 String 数据连接类型 dw_name 否 String 数据连接名称 l1 否 String 主题域分组中文名 l2 否 String 主题域中文名 l3 否 String 业务对象中文名 l1_id 否 Long 主题域分组id l2_id 否 String 主题域id l3_id 否 Long 业务对象id partition_conf 否 String 分区表达式 dlf_task_id 否 String DLF 作业 ID use_recently_partition 否 Boolean 是否使用最新分区 缺省值:false reversed 否 Boolean 是否是逆向的 缺省值:false dirty_out_switch 否 Boolean 异常数据输出开关 缺省值:false dirty_out_database 否 String 异常数据输出库 dirty_out_prefix 否 String 异常表前缀 dirty_out_suffix 否 String 异常表后缀 quality_owner 否 String 质量责任人 quality_id 否 Long 质量id distribute 否 String DISTRIBUTE BY [HASH(column)|REPLICATION] 枚举值: HASH REPLICATION distribute_column 否 String DISTRIBUTE BY HASH column is_partition 否 Boolean 是否分区表 缺省值:false physical_table 否 String 创建表状态 枚举值: NO_NEED CREATE_SUCCESS CREATE_FAILED UPDATE_SUCCESS UPDATE_FAILED SUMMARY_SUCCESS SUMMARY_FAILED RUNNING OFFLINE technical_asset 否 String 技术资产同步状态 枚举值: NO_NEED CREATE_SUCCESS CREATE_FAILED UPDATE_SUCCESS UPDATE_FAILED SUMMARY_SUCCESS SUMMARY_FAILED RUNNING OFFLINE business_asset 否 String 业务资产同步状态 枚举值: NO_NEED CREATE_SUCCESS CREATE_FAILED UPDATE_SUCCESS UPDATE_FAILED SUMMARY_SUCCESS SUMMARY_FAILED RUNNING OFFLINE meta_data_link 否 String 资产关联状态 枚举值: NO_NEED CREATE_SUCCESS CREATE_FAILED UPDATE_SUCCESS UPDATE_FAILED SUMMARY_SUCCESS SUMMARY_FAILED RUNNING OFFLINE data_quality 否 String 质量作业状态 枚举值: NO_NEED CREATE_SUCCESS CREATE_FAILED UPDATE_SUCCESS UPDATE_FAILED SUMMARY_SUCCESS SUMMARY_FAILED RUNNING OFFLINE summary_status 否 String 同步整体状态 枚举值: NO_NEED CREATE_SUCCESS CREATE_FAILED UPDATE_SUCCESS UPDATE_FAILED SUMMARY_SUCCESS SUMMARY_FAILED RUNNING OFFLINE alias 否 String 别名 self_defined_fields 否 Array of SelfDefinedFieldVO objects 自定义项 表4 WorkspaceVO 参数 是否必选 参数类型 描述 id 否 Long 编号 name 是 String 工作区名字 最大长度:250 description 否 String 最大长度:600 is_physical 否 Boolean 是否为物理表 缺省值:true frequent 否 Boolean 是否为常用 缺省值:true top 否 Boolean 分层治理 缺省值:true level 否 String 数据治理 分层 枚举值: SDI DWI DWR DM dw_type 否 String 数据连接类型 create_time 否 String 创建时间 update_time 否 String 更新时间 create_by 否 String 创建人 update_by 否 String 更新人 type 是 String 工作区类型枚举 枚举值: THIRD_NF DIMENSION biz_catalog_ids 否 String 关联的业务分层的id列表 {"l1Ids":[],"l2Ids":[],"l3Ids":[]} databases 否 Array of strings 数据库名称数组 表5 ApprovalVO 参数 是否必选 参数类型 描述 id 否 Long ID tenant_id 否 String tenant id name_ch 否 String 业务中文名 name_en 否 String 业务英文名 biz_id 否 Long 业务ID biz_type 否 String 业务类型 枚举值: ATOMIC_INDEX DERIVATIVE_INDEX DIMENSION DIMENSION_ATTRIBUTE DIMENSION_HIERARCHIES CONDITION_GROUP TIME_CONDITION COMMON_CONDITION FACT_LOGIC_TABLE TABLE_MODEL DIMENSION_LOGIC_TABLE STANDARD_ELEMENT AGGREGATION_LOGIC_TABLE TAG CODE_TABLE TABLE_MODEL_ATTRIBUTE FACT_DIMENSION FACT_ATTRIBUTE FACT_MEASURE SUMMARY_DIMENSION_ATTRIBUTE SUMMARY_TIME DIMENSION_TABLE_ATTRIBUTE QUALITY_RULE BIZ_METRIC COMPOUND_METRIC INFO_ARCH DEGENERATE_DIMENSION TABLE_MODEL_LOGIC SUBJECT biz_info 否 String 业务详情 biz_info_obj 否 Object 业务详情 biz_version 否 Integer 业务版本 biz_status 否 String 业务状态 枚举值: DRAFT PUBLISH_DEVELOPING PUBLISHED OFFLINE_DEVELOPING OFFLINE REJECT approval_status 否 String 业务审批状态 枚举值: DEVELOPING APPROVED REJECT WITHDREW approval_type 否 String 业务审核类型 枚举值: PUBLISH OFFLINE submit_time 否 String 提交时间 create_by 否 String 创建者 l1 否 String 主题域分组 l2 否 String 主题域 l3 否 String 业务对象 approval_time 否 String 审核时间 approver 否 String 审核人 email 否 String 审核人邮箱 msg 否 String 审核信息 directory_path 否 String 目录树 表6 TableModelAttributeVO 参数 是否必选 参数类型 描述 id 否 Long 编码 name_en 是 String 字段名 最大长度:600 name_ch 是 String 业务属性 最大长度:200 description 否 String 最大长度:600 obs_location 否 String obs路径,子路径 最大长度:600 create_by 否 String 创建人 update_by 否 String 更新人 data_type 是 String 字段类型 domain_type 否 String 字段类型所属域 枚举值: NUMBER STRING DATETIME BLOB OTHER data_type_extend 否 String 数据类型扩展字段 最大长度:50 is_primary_key 是 Boolean 是否主键 缺省值:false is_partition_key 否 Boolean 是否分区键 缺省值:false is_foreign_key 否 Boolean 是否外键 缺省值:false extend_field 否 Boolean 是否继承的属性 缺省值:false not_null 否 Boolean 是否不为空 缺省值:false ordinal 否 Integer 序号 table_model_id 否 Long 所属表模型id create_time 否 String 创建时间 update_time 否 String 更新时间 tags 否 Array of TagVO objects 表标签 stand_row_id 否 Long 关联的数据标准的id stand_row_name 否 String 最大长度:600 quality_infos 否 Array of QualityInfoVO objects 质量信息 alias 否 String 别名 self_defined_fields 否 Array of SelfDefinedFieldVO objects 自定义项 表7 TagVO 参数 是否必选 参数类型 描述 id 否 Long 编码 name 是 String 标签名 最大长度:250 description 否 String 最大长度:600 create_by 否 String 创建人 update_by 否 String 更新人 create_time 否 String 创建时间 update_time 否 String 更新时间 new_biz 否 BizVersionManageVO object 业务版本管理. 表8 BizVersionManageVO 参数 是否必选 参数类型 描述 id 否 Long ID信息 biz_type 否 String 业务类型 枚举值: ATOMIC_INDEX DERIVATIVE_INDEX DIMENSION DIMENSION_ATTRIBUTE DIMENSION_HIERARCHIES CONDITION_GROUP TIME_CONDITION COMMON_CONDITION FACT_LOGIC_TABLE TABLE_MODEL DIMENSION_LOGIC_TABLE STANDARD_ELEMENT AGGREGATION_LOGIC_TABLE TAG CODE_TABLE TABLE_MODEL_ATTRIBUTE FACT_DIMENSION FACT_ATTRIBUTE FACT_MEASURE SUMMARY_DIMENSION_ATTRIBUTE SUMMARY_TIME DIMENSION_TABLE_ATTRIBUTE QUALITY_RULE BIZ_METRIC COMPOUND_METRIC INFO_ARCH DEGENERATE_DIMENSION TABLE_MODEL_LOGIC SUBJECT biz_id 否 Long 业务id biz_info 否 String 业务对象信息 status 否 String 业务状态 枚举值: DRAFT PUBLISH_DEVELOPING PUBLISHED OFFLINE_DEVELOPING OFFLINE REJECT biz_version 否 Integer 业务版本 create_time 否 String 创建时间 update_time 否 String 更新时间 表9 QualityInfoVO 参数 是否必选 参数类型 描述 id 否 Long 编码 table_id 否 Long 表id attr_id 否 Long 属性id biz_type 否 String 业务类型 枚举值: ATOMIC_INDEX DERIVATIVE_INDEX DIMENSION DIMENSION_ATTRIBUTE DIMENSION_HIERARCHIES CONDITION_GROUP TIME_CONDITION COMMON_CONDITION FACT_LOGIC_TABLE TABLE_MODEL DIMENSION_LOGIC_TABLE STANDARD_ELEMENT AGGREGATION_LOGIC_TABLE TAG CODE_TABLE TABLE_MODEL_ATTRIBUTE FACT_DIMENSION FACT_ATTRIBUTE FACT_MEASURE SUMMARY_DIMENSION_ATTRIBUTE SUMMARY_TIME DIMENSION_TABLE_ATTRIBUTE QUALITY_RULE BIZ_METRIC COMPOUND_METRIC INFO_ARCH DEGENERATE_DIMENSION TABLE_MODEL_LOGIC SUBJECT data_quality_id 是 Long 质量id show_control 否 Integer 是否要显示 正则表达式 data_quality_name 否 String 质量名称 alert_conf 否 String 告警配置 expression 否 String 正则相关校验规则中正则配置 extend_info 否 String 扩展信息 from_standard 否 Boolean 是否来源于数据标准质量配置 缺省值:false result_description 否 String 结果说明 create_by 否 String 创建人 update_by 否 String 更新人 create_time 否 String 创建时间 update_time 否 String 更新时间 表10 TableMappingVO 参数 是否必选 参数类型 描述 id 否 Long 编码 name 是 String 名称 description 否 String 最大长度:600 target_table_id 否 Long 目的表id src_model_id 否 Long 来源表所属模型id src_model_name 否 String 来源模型名称 view_text 否 String 采集的视图来源,dws视图逆向使用 target_table_name 否 String 目的表名称 details 否 Array of TableMappingDetailVO objects 详情 source_tables 否 Array of MappingSourceTableVO objects 映射的表信息 source_fields 否 Array of MappingSourceFieldVO objects 映射的字段信息 create_time 否 String 创建时间 update_time 否 String 更新时间 create_by 否 String 创建人 update_by 否 String 更新人 表11 TableMappingDetailVO 参数 是否必选 参数类型 描述 id 否 Long 编码 mapping_id 否 String 名称 target_attr_id 否 Long 目的字段id target_attr_name 是 String 目的字段排序 src_table_ids 否 String 源表id, 通过,join src_table_names 否 Array of strings 源表名称数组 src_table_db_names 否 Array of strings 源表db名称数组 src_table_model_ids 否 Array of longs 源表模型id数组 src_table_id_list 否 Array of longs 源表id数组 src_attr_ids 否 String 源表字段id, 通过,join src_attr_names 否 Array of strings 源表字段名称数组 src_attr_id_list 否 Array of longs 源表字段id数组 remark 否 String 备注 create_time 否 String 创建时间 update_time 否 String 更新时间 create_by 否 String 创建人 update_by 否 String 更新人 target_attr 否 Object 目标属性 表12 MappingSourceTableVO 参数 是否必选 参数类型 描述 table1_id 是 Long 表id table2_id 否 Long 表id 缺省值:0 table1_name 是 String 表1名称 table2_name 否 String 表2名称 join_type 是 String 关联类型,左外连接,右外连接,内连接,全连接 缺省值:LEFT 枚举值: LEFT RIGHT INNER FULL join_fields 是 Array of MappingJoinFieldVO objects on条件 表13 MappingJoinFieldVO 参数 是否必选 参数类型 描述 field1_id 是 Long 属性id field2_id 是 Long 属性id field1_name 是 String 名称 field2_name 是 String 名称 表14 MappingSourceFieldVO 参数 是否必选 参数类型 描述 target_field_id 否 Long 目标字段ID,当前表的某个字段 target_field_name 是 String 目标字段编码 field_ids 否 String 来源字段id,多个id以逗号分隔 transform_expression 否 String 转换表达式 field_names 否 Array of strings 来源字段名称列表 changed 否 Boolean 字段是否发生变化 表15 RelationVO 参数 是否必选 参数类型 描述 id 否 Long 编码 source_table_id 否 Long 源表id target_table_id 否 Long 目标表id name 是 String 关系名称 source_table_name 否 String 源表名称 target_table_name 否 String 目的表名称 role 否 String 角色 tenant_id 否 String 租户id source_type 否 String 关系类型 枚举值: ONE ZERO_OR_ONE ZERO_OR_N ONE_OR_N target_type 否 String 关系类型 枚举值: ONE ZERO_OR_ONE ZERO_OR_N ONE_OR_N create_by 否 String 创建人 update_by 否 String 更新人 create_time 否 String 创建时间 update_time 否 String 更新时间 mappings 否 Array of RelationMappingVO objects 表属性信息 表16 RelationMappingVO 参数 是否必选 参数类型 描述 id 否 Long 编码 relation_id 否 Long 关系id source_field_id 否 Long 源字段id target_field_id 否 Long 目标字段id source_field_name 否 String 源表名称 target_field_name 否 String 目的表名称 create_by 否 String 创建人 update_by 否 String 更新人 create_time 否 String 创建时间 update_time 否 String 更新时间 表17 SelfDefinedFieldVO 参数 是否必选 参数类型 描述 fd_name_ch 否 String 自定义项中文名 最大长度:200 fd_name_en 否 String 自定义项英文名 最大长度:200 not_null 否 Boolean 是否必填 fd_value 否 String 属性值
  • 响应参数 状态码: 200 表4 响应Body参数 参数 参数类型 描述 data Object 返回的数据信息 状态码: 400 表5 响应Body参数 参数 参数类型 描述 error_code String 错误码,如DS.000,请求处理成功 error_msg String 错误信息 data Object 返回的数据信息 状态码: 401 表6 响应Body参数 参数 参数类型 描述 error_code String 错误码,如DS.000,请求处理成功 error_msg String 错误信息 data Object 返回的数据信息 状态码: 403 表7 响应Body参数 参数 参数类型 描述 error_code String 错误码,如DS.000,请求处理成功 error_msg String 错误信息 data Object 返回的数据信息 状态码: 404 表8 响应Body参数 参数 参数类型 描述 error_code String 错误码,如DS.000,请求处理成功 error_msg String 错误信息 data Object 返回的数据信息
  • 请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String IAM Token workspace 是 String DataArts Studio工作空间ID 表3 请求Body参数 参数 是否必选 参数类型 描述 ids 是 Array of longs ID列表 del_types 否 String 删除物理表 枚举值: PHYSICAL_TABLE
  • 响应参数 状态码: 200 表5 响应Body参数 参数 参数类型 描述 data Object 返回的数据信息 状态码: 400 表6 响应Body参数 参数 参数类型 描述 error_code String 错误码,如DS.000,请求处理成功 error_msg String 错误信息 data Object 返回的数据信息 状态码: 401 表7 响应Body参数 参数 参数类型 描述 error_code String 错误码,如DS.000,请求处理成功 error_msg String 错误信息 data Object 返回的数据信息 状态码: 403 表8 响应Body参数 参数 参数类型 描述 error_code String 错误码,如DS.000,请求处理成功 error_msg String 错误信息 data Object 返回的数据信息 状态码: 404 表9 响应Body参数 参数 参数类型 描述 error_code String 错误码,如DS.000,请求处理成功 error_msg String 错误信息 data Object 返回的数据信息
  • 请求示例 创建一个脚本名称为echoTimeShell的脚本,脚本类型为Shell,脚本内容为echo a,脚本关联的连接名称为con。 POST /v1/b384b9e9ab9b4ee8994c8633aabc9505/scripts { "name": "echoTimeShell", "type": "Shell", "content": "echo a", "queueName": "default", "connectionName": "con" }
共100000条