华为云用户手册

数据湖探索 DLI-删除组内资源包（废弃）:URI

URI URI格式： DELETE /v2.0/{project_id}/resources/{resource_name} 参数说明表1 URI参数说明参数名称是否必选参数类型说明 project_id 是 String 项目编号，用于资源隔离。获取方式请参考获取项目ID。 resource_name 是 String 上传的资源包名。表2 query参数说明参数名称是否必选参数类型说明 group 否 String 上传资源包时，返回的资源组名。带入query参数的URL示例如下： DELETE /v2.0/{project_id}/resources/{resource_name}?group={group}

数据湖探索 DLI
数据湖探索 DLI-查询所有SQL样例模板（废弃）:响应参数

响应参数表2 响应参数参数参数类型说明 is_success Boolean 请求执行是否成功。“true”表示请求执行成功。 message String 系统提示信息，执行成功时，信息可能为空。执行失败时，用于显示执行失败的原因。 sqls Array of Object 样例模板信息，具体参数说明请参见表3。 sqlCount Integer 样例模板个数。表3 sqls参数说明参数参数类型说明 lang String 语言。 name String 样例模板名称。 sql String 样例模板内容。 description String 样例模板描述。 group String 样例模板分组。

数据湖探索 DLI 模板相关API（废弃）
数据湖探索 DLI-解绑队列:URI

URI URI格式 POST /v2.0/{project_id}/datasource/enhanced-connections/{connection_id}/disassociate-queue 参数说明表1 URI参数参数名称是否必选参数类型说明 project_id 是 String 项目编号，用于资源隔离。获取方式请参考获取项目ID。 connection_id 是 String 连接ID，用于标识跨源连接的UUID。

数据湖探索 DLI 增强型跨源连接相关API
数据湖探索 DLI-创建DLI委托（废弃）:请求示例

请求示例创建 DLI 用户委托，该委托包含以下权限：访问和使用CloudTable（表格存储服务）的CloudTable Administrator权限；使用VPC（虚拟私有云）的VPC Administrator权限；访问和使用DIS数据源（数据接入服务）的DIS Administrator权限；使用 SMN （消息通知服务）的SMN Administrator权限；DLI获得访问和使用OBS的委托权限。 { "roles": [ "ctable_adm", "vpc_netadm", "dis_adm", "smn_adm", "obs_adm" ] }

数据湖探索 DLI 委托相关API（废弃）
数据湖探索 DLI-创建DLI委托（废弃）:请求消息

请求消息表2 请求参数参数名称是否必选参数类型说明 roles 是 Array of Strings 角色。目前只支持：obs_adm、dis_adm、ctable_adm、vpc_netadm、smn_adm、te_admin。具体含义如下： obs_adm：DLI获得访问和使用OBS的委托权限。 dis_adm：访问和使用DIS数据源，需要获得访问和使用DIS（数据接入服务）DIS Administrator权限。 ctable_adm：访问和使用CloudTable（表格存储服务）的CloudTable Administrator权限。 vpc_netadm：使用VPC（虚拟私有云）的VPC Administrator权限。 smn_adm：使用SMN（消息通知服务）的SMN Administrator权限。 te_admin：具有Tenant Administrator权限。

数据湖探索 DLI 委托相关API（废弃）
数据湖探索 DLI-查询作业执行进度信息:响应示例

响应示例 { "is_success": true, "message": "", "job_id": "85798b38-ae44-48eb-bb90-7cf0dcdafe7b", "status": "RUNNING", "sub_job_id": 0, "progress": 0, "sub_jobs": [ { "id": 0, "name": "runJob at FileFormatWriter.scala:266", "submission_time": "Mon Jul 27 17:24:03 CS T 2020", "stage_ids": [ 0 ], "job_group": "85798b38-ae44-48eb-bb90-7cf0dcdafe7b", "status": "RUNNING", "num_tasks": 1, "num_active_tasks": 1, "num_completed_tasks": 0, "num_skipped_tasks": 0, "num_failed_tasks": 0, "num_killed_tasks": 0, "num_completed_indices": 0, "num_active_stages": 1, "num_completed_stages": 0, "num_skipped_stages": 0, "num_failed_stages": 0 } ] }

数据湖探索 DLI
数据湖探索 DLI-批量删除队列定时扩缩容计划（废弃）:URI

URI URI格式： POST /v1/{project_id}/queues/{queue_name}/plans/batch-delete 参数说明表1 URI参数参数名称是否必选参数类型说明 project_id 是 String 项目编号，用于资源隔离。获取方式请参考获取项目ID。 queue_name 是 String 待删除定时扩缩计划的队列名称。名称长度为1~128个字符，多个队列名称使用逗号“,”分隔。

数据湖探索 DLI
数据湖探索 DLI-获取全部集群信息（废弃）:示例

示例请求样例： None 成功响应样例： { "clusters": [ { "create_time": 1508143955000, "cu_count": 16, "description": "test", "owner": "tenant1", "cluster_name": "cluster1", "status": "AVAILABLE", "resource_mode": 0 } ] } 调用接口出错后，将不会返回上述结果，而是返回错误码和错误信息，详细介绍请参见错误码。

数据湖探索 DLI
数据湖探索 DLI-获取全部集群信息（废弃）:响应消息

响应消息返回码成功返回200。响应参数表2 响应参数说明参数是否必选参数类型说明 create_time 是 Long 创建集群的时间。 description 否 String 集群的描述信息。 cu_count 是 Integer 与集群绑定的计算单元个数。 owner 是 String 创建集群的用户。 cluster_name 是 String 集群名称。 status 是 String 具体集群状态信息可参见表3。 resource_mode 是 Integer 集群类型。 0：共享集群 1：专属集群

数据湖探索 DLI
数据湖探索 DLI-创建集群（废弃）:请求消息

请求消息创建集群除公共请求消息头参数以外，还有特殊的请求消息头参数，具体如表2所示。表2 Header说明名称是否必选说明 X-Auth-Token 是从 IAM 服务获取的用户Token。 Accept 是默认值application/json。 Content-Type 是指定类型为application/json。 charset 是指定编码格式为utf8。请求参数如表3所示。表3 请求参数说明参数是否必选参数类型说明 cluster_name 是 String 新建的集群名称，名称只能包含数字、英文字母和下划线，但不能是纯数字，且不能以下划线开头。 description 否 String 集群的描述信息。 cu_count 是 Integer 与集群绑定的计算单元个数，同时是计费的单元。可选择16CU，64CU和256CU三种规格，如果需要更大配额，请联系DLI服务管理员。 cidr_in_vpc 否 String vpc的网段。 cidr_in_mgntsubnet 否 String 管理子网的网段。 cidr_in_subnet 否 String 特殊子网网段。

数据湖探索 DLI 集群相关API（废弃）
数据湖探索 DLI-查询批处理作业日志（废弃）:URI

URI URI格式： GET /v2.0/{project_id}/batches/{batch_id}/log 参数说明表1 URI参数参数名称是否必选参数类型说明 project_id 是 String 项目编号，用于资源隔离。获取方式请参考获取项目ID。 batch_id 是 String 批处理作业的ID。表2 请求参数说明参数名称是否必选参数类型说明 from 否 Integer 起始日志的行号，默认显示最后100行日志。如果日志不足100行，从0行开始显示。 size 否 Integer 查询日志的数量。 type 否 String 当“type”为“driver”时，输出Spark Driver日志。 index 否 Integer 当提交的作业进行重试时，会有多个driver日志。“index”用于指定driver日志的索引号，默认为“0”。需要与“type”参数一起使用。如果只指定“index”，则“type”默认为“driver”。

数据湖探索 DLI Spark批处理相关API（废弃）
数据湖探索 DLI-创建数据库（废弃）:请求消息

请求消息表2 请求参数参数名称是否必选参数类型说明 database_name 是 String 新增数据库名称。数据库名称只能包含数字、英文字母和下划线，但不能是纯数字，且不能以下划线开头。数据库名称大小写不敏感且不能为空。输入长度不能超过128个字符。说明： “default”为内置数据库，不能创建名为“default”的数据库。 description 否 String 新增数据库的描述信息。 enterprise_project_id 否 String 企业项目ID，“0”表示default，即默认的企业项目。关于如何设置企业项目请参考《企业管理用户指南》。说明：开通了企业管理服务的用户可设置该参数绑定指定的项目。 tags 否 Array of Objects 数据库的标签。具体请参考表3。表3 tags参数参数名称是否必选参数类型说明 key 是 String 标签的键。说明：标签的键的最大长度为128个字符，标签的键可以包含任意语种字母、数字、空格和_ . : =+-@ ,但首尾不能含有空格，不能以_sys_开头。 value 是 String 标签的值。说明：标签值的最大长度为225个字符，标签的值可以包含任意语种字母、数字、空格和_ . : =+-@ ,但首尾不能含有空格。

数据湖探索 DLI 数据库相关API（废弃）
数据湖探索 DLI-创建经典型跨源连接:请求示例

请求示例 { "name": "test1", "security_group_id": "a07ab107-a4ad-4835-ad09-08a2f2efccdb", "network_id": "e83ba67d-e812-42d3-908d-6ea0b2cc5ecb", "url": "cloudtable-8636-zk2-ldQklrNa.mycloudtable.com:2181,cloudtable-8636-zk3-N9EEH4mI.mycloudtable.com:2181,cloudtable-8636-zk1-78Lt0l8L.mycloudtable.com:2181", "service": "ct" }

数据湖探索 DLI
数据湖探索 DLI-创建经典型跨源连接:请求消息

请求消息表2 请求参数参数名称是否必选参数类型说明 name 是 String 连接名称。名称只能包含数字、英文字母、下划线和中划线。不能为空。输入长度不能超过64个字符。 service 是 String 服务名称，目前为CloudTable.OpenTSDB/CloudTable， MRS .OPENTSDB，DWS，RDS， CSS 。说明：不区分大小写。 security_group_id 是 String 用户指定安全组ID，即为需要建立连接的服务所在的安全组。 network_id 是 String 对应服务的子网网络ID，即为需要建立连接的服务所在的子网。 url 是 String 对应服务对外提供的访问url。长度不能超过512个字符。获取方式请参考表4。 tags 否 Array of Objects 队列的标签。具体请参考表3。表3 tags参数参数名称是否必选参数类型说明 key 是 String 标签的键。说明：标签的键的最大长度为128个字符，标签的键可以包含任意语种字母、数字、空格和_ . : =+-@ ,但首尾不能含有空格，不能以_sys_开头。 value 是 String 标签的值。说明：标签值的最大长度为225个字符，标签的值可以包含任意语种字母、数字、空格和_ . : =+-@ ,但首尾不能含有空格。表4 各服务URL获取方式服务名称 URL获取方式 Cloud Table HBase OpenTSDB DWS RDS CSS MRS

数据湖探索 DLI
数据湖探索 DLI-查询作业执行计划:响应示例

响应示例 { "is_success": "true", "message": "查询作业执行流图成功", "execute_graph": { "jid": "4e966f43f2c90b0e1bf3188ecf55504b", "name": "", "isStoppable": false, "state": "RUNNING", "start-time": 1578904488436, "end-time": -1, "duration": 516274 } }

数据湖探索 DLI
数据湖探索 DLI-查询作业执行计划:响应消息

响应消息表2 响应参数说明参数名称是否必选参数类型说明 is_success 否 Boolean 请求是否成功。 message 否 String 消息内容。 execute_graph 否 Object 查询作业计划的响应参数。具体请参考表3。表3 execute_graph参数说明参数名称是否可选参数类型说明 jid 否 String flink作业id。 name 否 String flink作业名字。 isStoppable 否 Boolean 是否可停止。 state 否 String 作业运行状态。 start-time 否 Long 作业启动时间。 end-time 否 Long 作业停止时间。 duration 否 Long 作业运行时长。

数据湖探索 DLI
数据湖探索 DLI-IEF系统事件上报（废弃）:请求示例

请求示例上报IEF系统事件，事件类型deployment、事件操作类型updated。 { "data": { "event_type": "deployment", "operation": "updated", "timestamp": 1591879887, "topic": "$hw/events/deployment/+/updated", "name": "edge-cs", "attributes": {} } }

数据湖探索 DLI IEF相关API（废弃）
数据湖探索 DLI-IEF系统事件上报（废弃）:请求消息

请求消息表2 请求参数说明参数名称是否必选参数类型说明 data 是 Object 系统事件数据。具体参数内容详见表3说明。表3 data参数说明参数名称是否必选参数类型说明 event_type 是 String 事件类型。 operation 是 String 事件的操作类型。 timestamp 是 Integer 事件产生的时间戳。 topic 是 String 消息发送的Topic。 name 是 String 资源名称。 attributes 否 String 资源的属性。

数据湖探索 DLI IEF相关API（废弃）
数据湖探索 DLI-新建模板:请求消息

请求消息表2 请求参数说明参数名称是否必选参数类型说明 name 是 String 模板名称。长度限制：1-64个字符。 desc 否 String 模板描述。长度限制：0-512个字符。 sql_body 否 String Stream SQL语句，至少包含source，query，sink三个部分。长度限制：0-2048个字符。 tags 否 Array of Objects Flink作业模板的标签。具体请参考表3。 job_type 否 String Flink作业模板类型。默认值为"flink_sql_job"，若填写则只能为"flink_sql_job"或者"flink_opensource_sql_job"。表3 tags参数参数名称是否必选参数类型说明 key 是 String 标签的键。说明：标签的键的最大长度为128个字符，标签的键可以包含任意语种字母、数字、空格和_ . : =+-@ ,但首尾不能含有空格，不能以_sys_开头。 value 是 String 标签的值。说明：标签值的最大长度为225个字符，标签的值可以包含任意语种字母、数字、空格和_ . : =+-@ ,但首尾不能含有空格。

数据湖探索 DLI
数据湖探索 DLI-新建模板:响应示例

响应示例 { "is_success": true, "message": "新建成功", "template": { "template_id": 0, "name": "IoT_example", "desc": "快速上手示例", "create_time": 1516952710040, "job_type": "flink_opensource_sql_job" } }

数据湖探索 DLI
数据湖探索 DLI-新建模板:响应消息

响应消息表4 响应参数说明参数名称是否必选参数类型说明 is_success 否 Boolean 请求是否成功。 message 否 String 消息内容。 template 否 Object 作业更新信息。请参见表5 表5 template参数说明参数名称是否必选参数类型说明 template_id 否 Long 模板ID。 name 否 String 模板名称。 desc 否 String 模板描述。 create_time 否 Long 模板创建时间。 job_type 否 String 作业模板类型。

数据湖探索 DLI
数据湖探索 DLI-查询所有全局变量:响应示例

响应示例 { "is_success": true, "message": "string", "count": 0, "global_vars": [ { "id": 0, "var_name": "string", "var_value": "string", "project_id": "string", "user_id": "string" } ] }

数据湖探索 DLI 全局变量相关API
数据湖探索 DLI-查询所有全局变量:URI

URI URI格式 GET /v1.0/{project_id}/variables 参数说明表1 URI参数说明参数名称是否必选参数类型说明 project_id 是 String 项目编号，用于资源隔离。获取方式请参考获取项目ID。表2 query参数说明参数名称是否必选参数类型说明 limit 否 Integer 每页显示的返回信息的个数，默认值为“100”。 offset 否 Integer 偏移量，默认值为“0”。

数据湖探索 DLI 全局变量相关API
数据湖探索 DLI-查询所有全局变量:响应消息

响应消息表3 响应参数说明参数名称是否必选参数类型说明 is_success 否 Boolean 执行请求是否成功。“true”表示请求执行成功。 message 否 String 系统提示信息，执行成功时，信息可能为空。 count 否 Integer 全局变量数量。 global_vars 否 Array of Objects 全局变量信息。请参见表4。表4 global_vars参数说明参数名称是否必选参数类型说明 id 否 Long 全局变量ID。 var_name 是 String 全局变量名称。 var_value 是 String 全局变量值。 project_id 否 String 项目ID。 user_id 否 String 用户ID。 user_name 否 String 用户名。 is_sensitive 否 Boolean 是否设置为敏感变量。 create_time 否 Long 创建时间。 update_time 否 Long 更新时间。

数据湖探索 DLI 全局变量相关API
数据湖探索 DLI-上传pyfile类型分组资源（废弃）:响应示例

响应示例 { "group_name": "gatk", "status": "READY", "resources": [ "dli_tf.py" ], "details":[ { "create_time":1608804435312, "update_time":1608804435312, "resource_type":"pyFile", "resource_name":"dli_tf.py", "status":"READY", "underlying_name":"dli_tf.py" } ], "create_time": 1521532893736, "update_time": 1521552364503, "is_async":false }

数据湖探索 DLI 分组资源相关API（废弃）
数据湖探索 DLI-上传pyfile类型分组资源（废弃）:响应消息

响应消息表3 响应参数参数名称是否必选参数类型说明 group_name 否 String 分组名称。 status 否 String 上传分组资源状态。 resources 否 Array of strings 该模块包含的资源包名列表。 details 否 Array of body 分组资源包的详细信息。具体请参考表4。 create_time 否 Long 模块上传的unix时间戳。 update_time 否 Long 模块更新的unix时间戳。 is_async 否 Boolean 是否使用异步方式上传资源包。默认值为“false”，表示不使用异步方式。推荐使用异步方式上传资源包。 owner 否 String 资源包拥有者。 description 否 String 资源模块描述。 module_name 否 String 资源模块名 module_type 否 String 资源模块类型。 jar：用户jar文件; pyFile：用户python文件; file：用户文件。表4 details参数说明参数名称是否必选参数类型说明 create_time 否 Long 资源包上传的unix时间。是单位为“毫秒”的时间戳。 update_time 否 Long 更新已上传资源包的unix时间。是单位为“毫秒”的时间戳。 resource_type 否 String 资源类型，此处为pyFile。 resource_name 否 String 资源名。 status 否 String "UPLOADING"表示正在上传。 "READY"表示资源包已上传。 "FAILED"表示资源包上传失败。 underlying_name 否 String 资源包在队列中的名字。 is_async 否 Boolean 是否异步上传资源包。

数据湖探索 DLI 分组资源相关API（废弃）
数据湖探索 DLI-查询经典型跨源连接:响应消息

响应消息表2 响应参数参数名称是否必选参数类型说明 is_success 否 Boolean 执行请求是否成功。“true”表示请求执行成功。 message 否 String 系统提示信息，执行成功时，信息为空。 connection_id 否 String 连接ID，用于标识跨源连接的UUID。 destination 否 String 创建连接时，用户填写的队列的访问地址。 state 否 String 连接状态，具体状态请参见表4。 process 否 Double 正在创建的跨源连接进度，显示0.0至1.0代表0%至100%。 name 否 String 创建连接时，用户自定义的连接名称。 connection_url 否 String 用于建立跨源关联表时，需要使用到的连接url。 cluster_name 否 String Serverless Spark队列名称。SQL队列模式下建立的跨源连接，该字段为空。 service 否 String 创建连接时，用户指定的对端服务（CloudTable/CloudTable.OpenTSDB/MRS.OpenTSDB/DWS/RDS/CSS）。 create_time 否 Long 创建连接的时间。为UTC的时间戳。 available_queue_info 否 Array of Objects 各个队列创建跨源连接的信息，详细信息请参考表3。表3 available_queue_info参数说明参数名称是否必选参数类型说明 uuid 否 String 跨源连接ID。 status 否 String 连接状态，状态码请参考表4。 name 否 String 队列名称。 err_msg 否 String 状态为失败时的详细报错信息。 update_time 否 Long 更新时间。表4 连接状态名称含义说明 CREATING 创建中跨源连接正在创建中。 ACTIVE 已激活跨源连接创建成功，与目的地址连接正常。 FAILED 已失败跨源连接创建失败。 DELETED 已删除跨源连接已被删除。

数据湖探索 DLI 经典型跨源连接相关API（废弃）
数据湖探索 DLI-查询经典型跨源连接:响应示例

响应示例 { "message": "Can't get ready router.", "is_success": true, "connection_id": "8164e4fc-63e2-4e6c-a123-8d9cd2513322", "destination": "192.168.12.148:3306", "state": "FAILED", "process": 0.0, "name": "rds", "connection_url": "", "cluster_name": "", "service": "RDS", "create_time": 1652701307460 }

数据湖探索 DLI 经典型跨源连接相关API（废弃）
数据湖探索 DLI-查询经典型跨源连接:URI

URI URI格式 GET /v2.0/{project_id}/datasource-connection/{connection_id} 参数说明表1 URI参数参数名称是否必选参数类型说明 project_id 是 String 项目编号，用于资源隔离。获取方式请参考获取项目ID。 connection_id 是 String 连接ID，用于标识跨源连接的UUID。具体为创建经典型跨源连接或查询经典型跨源连接列表返回的连接ID。

数据湖探索 DLI 经典型跨源连接相关API（废弃）
数据湖探索 DLI-查询所有表（废弃）:示例

示例请求样例： None 成功响应样例： { "is_success": true, "message": "", "table_count": 1, "tables": [ { "create_time":1517364268000, "data_location":"OBS", "data_type":"csv", "last_access_time":1517364268000, "location":"obs://DLI/sqldata/data.txt", "owner":"test", "partition_columns": ["a0"], "table_name":"obs_t", "table_size":0, "table_type":"EXTERNAL" } ] } 调用API出错后，将不会返回上述结果，而是返回错误码和错误信息，详细介绍请参见错误码。

数据湖探索 DLI

共100000条

undefined

意见反馈

0/200

提交取消

提交成功！非常感谢您的反馈，我们会继续努力做到更好反馈提交失败！请稍后重试！

华为云用户手册

7*24

备案

专业服务

退订

建议反馈

售前咨询热线