文档首页/ 数据湖探索 DLI/ CLI参考/ CLI命令参考

更新时间：2026-09-14 GMT+08:00

CLI命令参考

权限相关API

API名称	命令	描述	操作
查看赋权对象的用者权限信息	hcloud DLI ListAuthorizationPrivileges	获取对象赋权用户的权限信息	去调试
数据赋权（用户、项目）	hcloud DLI RunAuthorizationAction	该API用于将DLI资源权限赋给、回收、更新指定的其他用户或项目。	去调试

全局变量相关API

API名称	命令	描述	操作
查询DLI全局变量列表	hcloud DLI ListGlobalVariables	查询全局变量列表。	去调试
创建DLI全局变量	hcloud DLI CreateGlobalVariable	创建全局变量。全局变量用于替换SQL作业中的敏感数据。	去调试
修改DLI全局变量	hcloud DLI UpdateGlobalVariable	修改全局变量。	去调试
删除DLI全局变量	hcloud DLI DeleteGlobalVariable	删除全局变量。	去调试

数据目录相关API

API名称	命令	描述	操作
获取项目下所有catalog信息	hcloud DLI ListCatalogs	该API获取指定项目下所有catalog信息	去调试
绑定/解绑catalog映射信息	hcloud DLI RunCatalogAction	该API创建DLI绑定/解绑到lakeformation等服务的元数据目录（CATALOG）相关信息。	去调试
描述catalog信息	hcloud DLI ShowCatalog	该API用于描述DLI catalog详情	去调试

资源标签相关API

API名称	命令	描述	操作
查询指定资源类型的标签信息	hcloud DLI ListResourcesTags	查询指定资源类型的标签信息。	去调试
查询资源实例列表	hcloud DLI ListResourcesByTags	查询资源实例列表。	去调试
查询资源实例数量	hcloud DLI CountResourcesByTags	查询资源实例数量。	去调试
批量添加资源标签	hcloud DLI BatchCreateResourceTags	批量添加资源标签。	去调试
批量删除资源标签	hcloud DLI BatchDeleteResourceTags	批量删除资源标签。	去调试
查询指定资源实例的标签信息	hcloud DLI ShowResourceTags	查询指定资源实例的标签信息。	去调试

动态脱敏策略相关API

API名称	命令	描述	操作
创建动态脱敏策略	hcloud DLI CreateDataMaskStrategy	该API用于动态脱敏策略，SQL执行的结果脱敏展示。	去调试
批量获取动态脱敏策略	hcloud DLI ListDataMaskStrategies	该API用于批量获取动态脱敏策略。	去调试
更新动态脱敏策略	hcloud DLI UpdateDataMaskStrategy	该API用于更新动态脱敏策略，SQL执行的结果脱敏展示。	去调试
删除动态脱敏策略	hcloud DLI DeleteDataMaskStrategy	该API用于删除动态脱敏策略。	去调试
获取动态脱敏策略	hcloud DLI ShowDataMaskStrategy	该API用于获取单个动态脱敏策略。	去调试
动态脱敏策略授权	hcloud DLI CreateDataMaskStrategyUserAuth	该API用于动态脱敏策略授权。	去调试
获取脱敏策略白名单	hcloud DLI ShowDataMaskStrategyUserAuth	该API用于获取脱敏策略权限。	去调试

增强型跨源连接相关API

API名称	命令	描述	操作
查询增强型跨源连接	hcloud DLI ShowEnhancedConnection	该API用于查询该用户指定的已创建的增强型跨源连接。	去调试
修改增强型跨源主机信息	hcloud DLI UpdateEnhancedConnection	该API用于在跨源中修改数据源主机信息，仅支持全量覆盖。	去调试
删除增强型跨源连接	hcloud DLI DeleteEnhancedConnection	该API用于删除已创建的增强型跨源连接。	去调试
查询增强型跨源连接列表	hcloud DLI ListEnhancedConnections	该API用于查询该用户已创建的增强型跨源连接列表。	去调试
创建增强型跨源连接	hcloud DLI CreateEnhancedConnection	该API用于创建与其他服务的增强型跨源连接。	去调试
解绑队列	hcloud DLI DisassociateQueueFromEnhancedConnection	该API用于在增强型跨源中解绑已绑定的队列。	去调试
绑定队列	hcloud DLI AssociateQueueToEnhancedConnection	该API用于在已创建的增强型跨源中绑定队列。	去调试
查询增强型跨源授权信息	hcloud DLI ShowEnhancedConnectionPrivilege	该API用于查询增强型跨源连接授权的信息。	去调试
查询增强型跨源授权信息	hcloud DLI ListJobAuthInfos	该API用于查询跨源认证信息。	去调试
更新跨源认证	hcloud DLI UpdateJobAuthInfo	该API用于更新跨源认证信息。	去调试
创建跨源认证	hcloud DLI CreateJobAuthInfo	该API用于创建跨源认证。	去调试
删除跨源认证	hcloud DLI DeleteJobAuthInfo	该API用于删除跨源认证信息。	去调试
删除路由	hcloud DLI DeleteRouteFromEnhancedConnection	该API用于删除跨源需要的路由。	去调试
创建路由	hcloud DLI CreateRouteToEnhancedConnection	该API用于创建跨源需要的路由。	去调试

配额相关API

API名称	命令	描述	操作
查询配额	hcloud DLI ShowQuota	该API用于获取用户配额信息列表。	去调试

弹性资源池相关API

API名称	命令	描述	操作
查询所有弹性资源池	hcloud DLI ListElasticResourcePools	查询所有弹性资源池	去调试
创建弹性资源池	hcloud DLI CreateElasticResourcePool	创建弹性资源池	去调试
修改弹性资源池信息	hcloud DLI UpdateElasticResourcePool	修改弹性资源池信息	去调试
删除弹性资源池	hcloud DLI DeleteElasticResourcePool	删除弹性资源池	去调试
查询弹性资源池所属队列	hcloud DLI ListElasticResourcePoolQueues	查询弹性资源池所属队列	去调试
关联队列到弹性资源池	hcloud DLI AssociateQueueToElasticResourcePool	关联队列到弹性资源池	去调试
修改弹性资源池关联的队列优先级	hcloud DLI UpdateElasticResourcePoolQueue	设置弹性资源池指定队列的扩缩容策略信息。	去调试
弹性资源池扩缩容历史记录	hcloud DLI ListElasticResourcePoolScaleRecords	查询当前弹性资源池扩缩容历史记录	去调试
创建包周期弹性资源池	hcloud DLI CreatePeriodElasticResourcePoolOrder	创建包周期弹性资源池	去调试
包周期弹性资源池规格变更下单接口	hcloud DLI CreatePeriodElasticResourcePoolSpecChangeOrder	包周期弹性资源池规格变更下单接口	去调试

队列相关API

API名称	命令	描述	操作
查询所有队列	hcloud DLI ListQueues	该API用于列出该project下所有的队列。	去调试
创建队列	hcloud DLI CreateQueue	该API用于创建队列，该队列将会绑定用户指定的计算资源。	去调试
查询队列详情	hcloud DLI ShowQueue	该API用于列出该project下指定的队列详情。	去调试
删除队列	hcloud DLI DeleteQueue	该API用于删除指定队列。	去调试
重启/扩容/缩容队列	hcloud DLI RunQueueAction	该功能用于重新启动队列、扩容队列、缩容队列。	去调试
创建地址连通性请求	hcloud DLI CreateConnectivityTask	创建地址连通性请求API接口，往指定集群发送地址连通性测试请求，并将测试地址插入表内	去调试
查询指定地址连通性测试详情	hcloud DLI ShowConnectivityTask	该API用于在连通性测试提交后查询连通性结果。	去调试
新增队列属性	hcloud DLI CreateQueueProperty	该接口用于增加队列属性, 一次可增加多个属性。	去调试
获取队列属性	hcloud DLI ListQueueProperties	获取队列配置的属性	去调试
更新队列属性	hcloud DLI UpdateQueueProperty	更新队列属性	去调试
删除队列的属性	hcloud DLI DeleteQueueProperty	该接口用于删除队列的属性，一次可删除多个属性值。	去调试

SQL作业-作业相关API

API名称	命令	描述	操作
查询所有作业	hcloud DLI ListSqlJobs	该API用于查询当前工程下面的所有作业的信息。	去调试
提交SQL作业	hcloud DLI CreateSqlJob	该API用于通过执行SQL语句的方式向队列提交作业。	去调试
查询作业状态	hcloud DLI ShowSqlJobStatus	该API用于在作业提交后查询作业状态。	去调试
查询作业详细信息	hcloud DLI ShowSqlJobDetail	该API用于查询作业的详细信息，如作业的databasename、tablename、file size和export mode等信息。	去调试
取消作业	hcloud DLI CancelSqlJob	该API用于取消已经提交的作业，若作业已经执行结束或失败则无法取消。	去调试
导出查询结果	hcloud DLI ExportSqlJobResult	该API用于将SQL语句的查询结果导出到OBS对象存储中，只支持导出“QUERY”类型作业的查询结果。	去调试
预览SQL作业查询结果	hcloud DLI PreviewSqlJobResult	该API用于在执行SQL查询语句的作业完成后，查看该作业执行的结果。目前仅支持查看“QUERY”类型作业的执行结果。	去调试
检查SQL语法	hcloud DLI CheckSql	该API用于检查SQL语法。	去调试
查询作业执行进度信息	hcloud DLI ShowSqlJobProgress	该API用于获取作业执行进度信息，如果作业正在执行，可以获取到子作业的信息，如果作业刚开始或者已经结束，不可以获取到子作业信息。	去调试

SQL作业-模板相关API

API名称	命令	描述	操作
存储指定SQL语句	hcloud DLI CreateSqlJobTemplate	该API用于存储指定的SQL语句，后续可以重复使用。	去调试
查看所有SQL模板	hcloud DLI ListSqlJobTemplates	该API用查看用户保存的所有SQL模板。	去调试
更新SQL模板	hcloud DLI UpdateSqlJobTemplate	该API用于更新SQL模板。	去调试
批量删除SQL模板	hcloud DLI BatchDeleteSqlJobTemplates	该API用于批量删除SQL模板。	去调试

SQL作业-拦截规则相关API

API名称	命令	描述	操作
创建SQL拦截规则	hcloud DLI CreateSqlJobDefendRule	该API用于创建SQL拦截规则，拦截匹配规则的SQL。	去调试
批量获取SQL拦截规则	hcloud DLI ListSqlJobDefendRules	该API用于批量获取SQL拦截规则。	去调试
更新SQL拦截规则	hcloud DLI UpdateSqlJobDefendRule	该API用于更新SQL拦截规则，拦截匹配规则的SQL。	去调试
删除SQL拦截规则	hcloud DLI DeleteSqlJobDefendRule	该API用于删除SQL拦截规则。	去调试
获取SQL拦截规则	hcloud DLI ShowSqlJobDefendRule	该API用于获取单个SQL拦截规则。	去调试
批量获取系统预置SQL拦截规则	hcloud DLI ListSqlJobSystemDefendRules	该API用于获取系统预置SQL拦截规则。	去调试
获取单个系统预置SQL拦截规则	hcloud DLI ShowSqlJobSystemDefendRule	该API用于获取系统预置SQL拦截规则。	去调试

Flink作业-作业相关API

API名称	命令	描述	操作
查询Flink作业详情	hcloud DLI ShowFlinkJob	查看一个Flink作业的详情信息。	去调试
删除作业	hcloud DLI DeleteFlinkJob	删除任何状态的作业。	去调试
查询Flink作业列表	hcloud DLI ListFlinkJobs	查询当前用户的作业列表，可以根据作业ID作为ID，查询大于ID或小于ID的限定条数的作业，默认查询全部状态的作业，也可以设定运行中或其他状态条件。	去调试
新建Flink SQL作业	hcloud DLI CreateFlinkSqlJob	通过POST方式，提交流式SQL作业，请求体为JSON格式。	去调试
更新Flink SQL作业	hcloud DLI UpdateFlinkSqlJob	Stream SQL的语法扩展了Apache Flink SQL。	去调试
新建Flink Jar作业	hcloud DLI CreateFlinkJarJob	用户自定义作业目前支持jar格式，运行在独享集群中。	去调试
更新Flink Jar作业	hcloud DLI UpdateFlinkJarJob	更新用户自定义作业，目前支持jar格式，运行在独享集群中。	去调试
批量运行Flink作业	hcloud DLI BatchRunFlinkJobs	触发批量运行Flink作业。	去调试
批量停止Flink作业	hcloud DLI BatchStopFlinkJobs	批量停止正在运行的Flink作业。	去调试
批量删除Flink作业	hcloud DLI BatchDeleteFlinkJobs	批量删除任何状态的作业。	去调试
查询Flink作业执行计划	hcloud DLI ShowFlinkJobExecutionGraph	查询Flink作业执行计划。	去调试
flink作业导出	hcloud DLI ExportFlinkJobs	通过POST方式，导出flink作业，请求体为JSON格式。	去调试
flink作业导入	hcloud DLI ImportFlinkJobs	通过POST方式，导入flink作业，请求体为JSON格式。	去调试
生成flink SQL作业的静态流图	hcloud DLI CreateFlinkSqlJobGraph	生成flink SQL作业的静态流图	去调试

Flink作业-模板相关API

API名称	命令	描述	操作
查询Flink作业模板列表	hcloud DLI ListFlinkSqlJobTemplates	查询Flink作业模板列表。当前只支持查询用户自定义模板。	去调试
新建Flink作业模板	hcloud DLI CreateFlinkSqlJobTemplate	在DLI服务中新建一个Flink作业模板，最多100个。	去调试
更新Flink作业模板	hcloud DLI UpdateFlinkSqlJobTemplate	对DLI服务中已有的Flink作业模板进行更新。	去调试
删除Flink作业模板	hcloud DLI DeleteFlinkSqlJobTemplate	删除一个Flink作业模板，即使当前模板正在被作业使用，也允许删除。	去调试

Flink作业-管理相关API

API名称	命令	描述	操作
导入Flink作业保存点	hcloud DLI ImportFlinkJobSavepoint	导入Flink作业保存点。	去调试
触发Flink作业保存点	hcloud DLI ExecuteFlinkJobSavepoint	触发Flink作业保存点。	去调试

Spark作业-作业相关API

API名称	命令	描述	操作
查询批处理作业列表	hcloud DLI ListSparkJobs	该API用于查询Project下某队列批处理作业的列表。	去调试
创建批处理作业	hcloud DLI CreateSparkJob	该API用于在某个队列上创建作业。	去调试
查询批处理作业详情	hcloud DLI ShowSparkJob	该API用于根据批处理作业的id查询作业详情。	去调试
取消批处理作业	hcloud DLI CancelSparkJob	该API用于取消批处理作业。	去调试
查询批处理作业状态	hcloud DLI ShowSparkJobStatus	该API用于查询批处理作业的状态。	去调试

Spark作业-模板相关API

API名称	命令	描述	操作
创建作业模板	hcloud DLI CreateSparkJobTemplate	该API用于创建作业模板。	去调试
查询作业模板列表	hcloud DLI ListSparkJobTemplates	该API用于查询作业模板列表。	去调试
修改作业模板	hcloud DLI UpdateSparkJobTemplate	该API用于修改作业模板。	去调试
获取作业模板	hcloud DLI ShowSparkJobTemplate	该API用于获取作业模板。	去调试

已弃用-委托与权限相关API

API名称	命令	描述	操作
获取dli委托信息	hcloud DLI ShowDliAgency	获取dli委托信息	去调试
创建DLI委托	hcloud DLI CreateDliAgency	创建DLI委托	去调试
队列赋权	hcloud DLI RegisterAuthorizedQueue	该API用于与其他用户共享指定的队列，可以给用户赋使用指定的队列的权限或者收回使用权限。	去调试
查看表的使用者	hcloud DLI ListTableUsers	该API用于查看有权访问指定表或表的列的所有用户。	去调试
数据赋权（用户）	hcloud DLI RunDataAuthorizationAction	该API用于将数据库或数据表的数据权限赋给指定的其他用户。	去调试
查看表的用户权限	hcloud DLI ListTablePrivileges	该API用于查询指定用户在表上的权限。	去调试
查看数据库的使用者	hcloud DLI ListDatabaseUsers	该API用于查询可以使用的指定队列的所有用户名称。	去调试
查看队列的使用者	hcloud DLI ListQueueUsers	该API用于查询可以使用的指定队列的所有用户名称。	去调试

已弃用-分组资源相关API

API名称	命令	描述	操作
上传file类型分组资源	hcloud DLI UploadFileJobResources	该API用于在project下上传file类型模块。	去调试
上传pyfile类型分组资源	hcloud DLI UploadPythonFileJobResources	该API用于在project下的上传pyfile类型模块。	去调试
查看组内资源包	hcloud DLI ShowJobResource	该API用于查看某个project某个分组下的具体资源信息。	去调试
删除组内资源包	hcloud DLI DeleteJobResource	该API用于删除某个project某个分组下的资源包	去调试
查看分组资源列表	hcloud DLI ListJobResources	该API用于查看某个project下的所有资源，其中包含Group。	去调试
上传分组资源	hcloud DLI UploadJobResources	该API用于上传分组资源到某个project下。	去调试
上传jar类型分组资源	hcloud DLI UploadJarJobResources	该API用于在project下上传jar类型分组资源。	去调试
修改组或者资源包拥有者	hcloud DLI UpdateJobResourceOwner	用于修改程序包的owner。	去调试

已弃用-跨源连接相关API

API名称	命令	描述	操作
获取跨源认证列表	hcloud DLI ListAuthInfo	该API用于查询跨源认证信息。	去调试
更新跨源认证	hcloud DLI UpdateAuthInfo	该API用于更新跨源认证信息。	去调试
创建跨源认证	hcloud DLI CreateAuthInfo	该API用于创建跨源认证。	去调试
删除跨源认证	hcloud DLI DeleteAuthInfo	该API用于删除跨源认证信息。	去调试
删除路由	hcloud DLI DeleteEnhancedConnectionRoutes	该API用于删除跨源需要的路由。	去调试
创建路由	hcloud DLI CreateEnhancedConnectionRoutes	该API用于创建跨源需要的路由。	去调试
查询经典型跨源连接列表	hcloud DLI ListDatasourceConnections	该API用于查询该用户已创建的经典型跨源连接列表。	去调试
创建经典型跨源连接	hcloud DLI CreateDatasourceConnection	该API用于创建与其他服务的经典型跨源连接。	去调试
查询经典型跨源连接	hcloud DLI ShowDatasourceConnection	该API用于查询该用户指定的已创建的经典型跨源连接。	去调试
删除经典型跨源连接	hcloud DLI DeleteDatasourceConnection	该API用于删除已创建的经典型跨源连接。	去调试

已弃用-队列相关API

API名称	命令	描述	操作
修改队列网段	hcloud DLI UpdateQueueCidr	该功能用于修改包年包月队列网段。	去调试
查看队列定时扩缩容计划	hcloud DLI ListQueuePlans	查看队列定时扩缩容计划接口，列出指定队列定时规格变更计划。	去调试
创建队列定时扩缩容计划	hcloud DLI CreateQueuePlan	创建队列定时扩缩容计划接口，对指定的队列创建定时规格变更计划。	去调试
批量删除队列定时扩缩容计划	hcloud DLI BatchDeleteQueuePlans	该API用于批量删除队列定时扩缩容计划。	去调试
修改队列定时扩缩容计划	hcloud DLI UpdateQueuePlan	该API用于修改指定ID的队列定时扩缩容计划。	去调试
单个删除队列定时扩缩容计划	hcloud DLI DeleteQueuePlan	该API用于删除指定ID的队列定时扩缩容计划。	去调试

已弃用-SQL作业相关API

API名称	命令	描述	操作
导出表数据	hcloud DLI ExportTable	该API用于将SQL语句的查询结果导出到OBS对象存储中，只支持导出“QUERY”类型作业的查询结果。	去调试
导入数据	hcloud DLI ImportTable	该API用于将数据从文件导入DLI或OBS表，目前仅支持将OBS上的数据导入DLI或OBS中。	去调试
查询所有数据库	hcloud DLI ListDatabases	该API用于查询出所有的数据库信息。	去调试
创建数据库	hcloud DLI CreateDatabase	该API用于新增数据库。	去调试
修改数据库用户	hcloud DLI UpdateDatabaseOwner	用于修改数据库的owner。	去调试
删除数据库	hcloud DLI DeleteDatabase	该API用于删除空数据库，若待删除的数据库中存在表，则需先删除其中的所有表。	去调试
查询所有表	hcloud DLI ListTables	该API用于查询指定数据库下符合过滤条件的或所有的表信息。	去调试
创建表	hcloud DLI CreateTable	该API用于创建新的表。	去调试
修改表用户	hcloud DLI UpdateTableOwner	用于修改表的owner。	去调试
描述表信息	hcloud DLI ShowTable	该API用于描述指定表的元数据信息。	去调试
删除表	hcloud DLI DeleteTable	该API用于删除指定的表。	去调试
预览表内容	hcloud DLI PreviewTable	该API用于用于预览表中前10行的内容。	去调试
获取分区信息列表	hcloud DLI ListPartitions	该API用于用于获取分区信息的列表。	去调试
查询所有SQL样例模板	hcloud DLI ListSqlSampleTemplates	该API用于查询所有SQL样例模板。	去调试

已弃用-Flink作业-作业相关API

API名称	命令	描述	操作
OBS授权给DLI服务	hcloud DLI RegisterBucket	用户主动授权OBS桶的操作权限给DLI服务, 用于保存用户作业的checkpoint、作业的运行日志等。	去调试
查询Flink作业监控信息	hcloud DLI ShowFlinkMetric	查询Flink作业监控信息, 支持同时查询多个Flink作业的监控信息。	去调试
创建IEF消息通道	hcloud DLI CreateIefMessageChannel	该API用于创建IEF消息通道	去调试
边缘Flink作业状态信息上报	hcloud DLI UpdateFlinkJobStatusReport	该API用于处理边缘Flink作业状态上报信息	去调试
边缘Flink作业Action状态回调	hcloud DLI RunIefJobActionCallBack	该API用于处理IEF Flink作业action回调信息	去调试
IEF系统事件上报	hcloud DLI CreateIefSystemEvents	该API用于处理IEF系统事件上报	去调试

已弃用-Spark作业-作业相关API

API名称	命令	描述	操作
查询批处理作业日志	hcloud DLI ShowSparkJobLog	该API用于查询批处理作业的后台日志。	去调试

上一篇：如何使用CLI