CLI Command Reference

Viewing the Permissions Granted to a User

hcloud DLI ListAuthorizationPrivileges

This API is used to view the permissions granted to a user.

Debug

Granting Data Permissions to Users or Projects

hcloud DLI RunAuthorizationAction

This API is used to grant, revoke, or update DLI resource permissions for specified users or projects.

Debug

Querying the DLI Global Variable List

hcloud DLI ListGlobalVariables

This API is used to query the global variable list.

Debug

Creating a DLI Global Variable

hcloud DLI CreateGlobalVariable

This API is used to create a global variable. Global variables are used to replace sensitive data in SQL jobs.

Debug

Modifying a DLI Global Variable

hcloud DLI UpdateGlobalVariable

This API is used to modify a global variable.

Debug

Deleting a DLI Global Variable

hcloud DLI DeleteGlobalVariable

This API is used to delete a global variable.

Debug

Obtaining Information About All Catalogs in a Project

hcloud DLI ListCatalogs

This API is used to obtain information about all catalogs in a specified project.

Debug

Binding or Unbinding a Catalog Mapping

hcloud DLI RunCatalogAction

This API is used to create metadata catalogs for binding/unbinding DLI to services such as LakeFormation.

Debug

Describing Catalog Information

hcloud DLI ShowCatalog

This API is used to describe DLI catalog details.

Debug

Querying Tags of a Specified Resource Type

hcloud DLI ListResourcesTags

This API is used to query tags of a specified resource type.

Debug

Querying the Resource Instance List

hcloud DLI ListResourcesByTags

This API is used to query the resource instance list.

Debug

Querying the Number of Resource Instances

hcloud DLI CountResourcesByTags

This API is used to query the number of resource instances.

Debug

Batch Adding Resource Tags

hcloud DLI BatchCreateResourceTags

This API is used to add resource tags in batches.

Debug

Batch Deleting Resource Tags

hcloud DLI BatchDeleteResourceTags

This API is used to delete resource tags in batches.

Debug

Querying Tags of a Specified Resource Instance

hcloud DLI ShowResourceTags

This API is used to query tags of a specified resource instance.

Debug

Creating a Dynamic Masking Policy

hcloud DLI CreateDataMaskStrategy

This API is used for dynamic masking policies. SQL execution results are masked.

Debug

Obtaining Dynamic Masking Policies in Batches

hcloud DLI ListDataMaskStrategies

This API is used to obtain dynamic masking policies in batches.

Debug

Updating a Dynamic Masking Policy

hcloud DLI UpdateDataMaskStrategy

This API is used to update a dynamic masking policy. SQL execution results are masked.

Debug

Deleting a Dynamic Masking Policy

hcloud DLI DeleteDataMaskStrategy

This API is used to delete a dynamic masking policy.

Debug

Obtaining a Dynamic Masking Policy

hcloud DLI ShowDataMaskStrategy

This API is used to obtain a dynamic masking policy.

Debug

Authorizing a Dynamic Masking Policy

hcloud DLI CreateDataMaskStrategyUserAuth

This API is used to authorize a dynamic masking policy.

Debug

Obtaining the Masking Policy Trustlist

hcloud DLI ShowDataMaskStrategyUserAuth

This API is used to obtain the masking policy permission.

Debug

Querying an Enhanced Datasource Connection

hcloud DLI ShowEnhancedConnection

This API is used to query a created enhanced datasource connection.

Debug

Modifying the Host Information of an Enhanced Datasource Connection

hcloud DLI UpdateEnhancedConnection

This API is used to modify the host information of a connected datasource. Only full overwriting is supported.

Debug

Deleting an Enhanced Datasource Connection

hcloud DLI DeleteEnhancedConnection

This API is used to delete an enhanced datasource connection.

Debug

Querying an Enhanced Datasource Connection List

hcloud DLI ListEnhancedConnections

This API is used to query the list of created enhanced datasource connections.

Debug

Creating an Enhanced Datasource Connection

hcloud DLI CreateEnhancedConnection

This API is used to create an enhanced datasource connection with other services.

Debug

Unbinding a Queue

hcloud DLI DisassociateQueueFromEnhancedConnection

This API is used to unbind a queue from an enhanced datasource connection.

Debug

Binding a Queue

hcloud DLI AssociateQueueToEnhancedConnection

This API is used to bind a queue to a created enhanced datasource connection.

Debug

Querying Authorization of an Enhanced Datasource Connection

hcloud DLI ShowEnhancedConnectionPrivilege

This API is used to query the authorization about an enhanced datasource connection.

Debug

Querying Authorization of an Enhanced Datasource Connection

hcloud DLI ListJobAuthInfos

This API is used to query datasource authentication information.

Debug

Updating Datasource Authentication

hcloud DLI UpdateJobAuthInfo

This API is used to update datasource authentication information.

Debug

Creating Datasource Authentication

hcloud DLI CreateJobAuthInfo

This API is used to create datasource authentication.

Debug

Deleting Datasource Authentication

hcloud DLI DeleteJobAuthInfo

This API is used to delete datasource authentication information.

Debug

Deleting a Route

hcloud DLI DeleteRouteFromEnhancedConnection

This API is used to delete a datasource connection route.

Debug

Creating a Route

hcloud DLI CreateRouteToEnhancedConnection

This API is used to create a datasource connection route.

Debug

Querying Quotas

hcloud DLI ShowQuota

This API is used to obtain the quota list of a user.

Debug

Querying All Elastic Resource Pools

hcloud DLI ListElasticResourcePools

This API is used to query all elastic resource pools.

Debug

Creating an Elastic Resource Pool

hcloud DLI CreateElasticResourcePool

This API is used to create an elastic resource pool.

Debug

Modifying Elastic Resource Pool Information

hcloud DLI UpdateElasticResourcePool

This API is used to modify elastic resource pool information.

Debug

Deleting an Elastic Resource Pool

hcloud DLI DeleteElasticResourcePool

This API is used to delete an elastic resource pool.

Debug

Querying the Queue to Which an Elastic Resource Pool Belongs

hcloud DLI ListElasticResourcePoolQueues

This API is used to query the queue to which an elastic resource pool belongs.

Debug

Associating a Queue with an Elastic Resource Pool

hcloud DLI AssociateQueueToElasticResourcePool

This API is used to associate a queue with an elastic resource pool.

Debug

Changing the Priority of Queues Associated with an Elastic Resource Pool

hcloud DLI UpdateElasticResourcePoolQueue

This API is used to set scaling policy of a specified queue in an elastic resource pool.

Debug

Viewing Scaling History of an Elastic Resource Pool

hcloud DLI ListElasticResourcePoolScaleRecords

This API is used to view scaling history of an elastic resource pool.

Debug

Creating a Yearly/Monthly Elastic Resource Pool

hcloud DLI CreatePeriodElasticResourcePoolOrder

This API is used to create a yearly/monthly elastic resource pool.

Debug

Placing an Order for Modifying the Specifications of a Yearly/Monthly Elastic Resource Pool

hcloud DLI CreatePeriodElasticResourcePoolSpecChangeOrder

This API is used to place an order for modifying the specifications of a yearly/monthly elastic resource pool.

Debug

Querying All Queues

hcloud DLI ListQueues

This API is used to list all queues under a project.

Debug

Creating a Queue

hcloud DLI CreateQueue

This API is used to create a queue. The queue will be bound to specified compute resources.

Debug

Querying Queue Details

hcloud DLI ShowQueue

This API is used to list details of a specific queue in a project.

Debug

Deleting a Queue

hcloud DLI DeleteQueue

This API is used to delete a specified queue.

Debug

Restarting, Scaling Out, and Scaling In Queues

hcloud DLI RunQueueAction

This function is used to restart, scale out, and scale in queues.

Debug

Creating an Address Connectivity Request

hcloud DLI CreateConnectivityTask

This API is used to send an address connectivity test request to a specified cluster, and insert the test address into the table.

Debug

Querying Connectivity Test Details of a Specified Address

hcloud DLI ShowConnectivityTask

This API is used to query the connectivity test result after the test is submitted.

Debug

Adding Queue Properties

hcloud DLI CreateQueueProperty

This API is used to add queue properties. You can add multiple properties at a time.

Debug

Querying Queue Properties

hcloud DLI ListQueueProperties

This API is used to obtain configured queue properties.

Debug

Updating Queue Properties

hcloud DLI UpdateQueueProperty

This API is used to update queue properties.

Debug

Deleting Queue Properties

hcloud DLI DeleteQueueProperty

This API is used to delete queue properties. You can delete multiple property values at a time.

Debug

Querying All Jobs

hcloud DLI ListSqlJobs

This API is used to query information about all jobs in the current project.

Debug

Submitting a SQL Job

hcloud DLI CreateSqlJob

This API is used to submit jobs to a queue using SQL statements.

Debug

Querying the Job Status

hcloud DLI ShowSqlJobStatus

This API is used to query the status of a submitted job.

Debug

Querying Job Details

hcloud DLI ShowSqlJobDetail

This API is used to query details about jobs, including databasename, tablename, file size, and export mode.

Debug

Canceling a Job

hcloud DLI CancelSqlJob

This API is used to cancel a submitted job. If execution of a job completes or fails, this job cannot be canceled.

Debug

Exporting Query Results

hcloud DLI ExportSqlJobResult

This API is used to export results returned from the query using SQL statements to OBS. Only the query result of QUERY jobs can be exported.

Debug

Previewing SQL Job Query Results

hcloud DLI PreviewSqlJobResult

This API is used to view the job execution result after a job is executed using SQL query statements. Currently, you can only query execution results of jobs of the QUERY type.

Debug

Checking SQL Syntax

hcloud DLI CheckSql

This API is used to check the SQL syntax.

Debug

Querying the Job Execution Progress

hcloud DLI ShowSqlJobProgress

This API is used to obtain the job execution progress. If a job is being executed, information about its subjobs can be obtained. If a job has just started or has ended, information about its subjobs cannot be obtained.

Debug

Storing Specified SQL Statements

hcloud DLI CreateSqlJobTemplate

This API is used to store specified SQL statements for future reuse.

Debug

Viewing All SQL Templates

hcloud DLI ListSqlJobTemplates

This API is used to view all SQL templates saved by a user.

Debug

Updating a SQL Template

hcloud DLI UpdateSqlJobTemplate

This API is used to update a SQL template.

Debug

Batch Deleting SQL Templates

hcloud DLI BatchDeleteSqlJobTemplates

This API is used to delete SQL templates in batches.

Debug

Creating a SQL Interception Rule

hcloud DLI CreateSqlJobDefendRule

This API is used to create a SQL interception rule to intercept SQL statements that match the rule.

Debug

Batch Querying SQL Interception Rules

hcloud DLI ListSqlJobDefendRules

This API is used to query SQL interception rules in batches.

Debug

Updating a SQL Interception Rule

hcloud DLI UpdateSqlJobDefendRule

This API is used to update a SQL interception rule to intercept SQL statements that match the rule.

Debug

Deleting a SQL Interception Rule

hcloud DLI DeleteSqlJobDefendRule

This API is used to delete a SQL interception rule.

Debug

Querying a SQL Interception Rule

hcloud DLI ShowSqlJobDefendRule

This API is used to query a single SQL interception rule.

Debug

Batch Querying Preset SQL Interception Rules

hcloud DLI ListSqlJobSystemDefendRules

This API is used to query preset SQL interception rules.

Debug

Querying a Preset SQL Interception Rule

hcloud DLI ShowSqlJobSystemDefendRule

This API is used to query preset SQL interception rules.

Debug

Querying Flink Job Details

hcloud DLI ShowFlinkJob

This API is used to view details about a Flink job.

Debug

Deleting a Job

hcloud DLI DeleteFlinkJob

This API is used to delete a job in any status.

Debug

Querying the Flink Job List

hcloud DLI ListFlinkJobs

This API is used to list the current user's jobs. You can set the job ID as the ID and query jobs whose IDs are greater than or less than the ID. You can also query jobs in specific status, for example, in running status or other. By default, all jobs are queried.

Debug

Creating a Flink SQL Job

hcloud DLI CreateFlinkSqlJob

This API is used to use the POST method to submit a stream SQL job in JSON format.

Debug

Updating a Flink SQL Job

hcloud DLI UpdateFlinkSqlJob

The Stream SQL syntax is built upon Apache Flink SQL.

Debug

Creating a Flink Jar Job

hcloud DLI CreateFlinkJarJob

This API is used to create user-defined jobs, which currently support the Jar format and run in exclusive clusters.

Debug

Updating a Flink Jar Job

hcloud DLI UpdateFlinkJarJob

This API is used to update user-defined jobs, which currently support the Jar format and run in exclusive clusters.

Debug

Running Flink Jobs in Batches

hcloud DLI BatchRunFlinkJobs

This API is used to run Flink jobs in batches.

Debug

Stopping Flink Jobs in Batches

hcloud DLI BatchStopFlinkJobs

This API is used to stop running Flink jobs in batches.

Debug

Deleting Flink Jobs in Batches

hcloud DLI BatchDeleteFlinkJobs

This API is used to delete jobs in any status in batches.

Debug

Querying the Flink Job Execution Plan

hcloud DLI ShowFlinkJobExecutionGraph

This API is used to query the Flink job execution plan.

Debug

Exporting Flink Jobs

hcloud DLI ExportFlinkJobs

This API is used to use the POST method to export Flink jobs. The request body is in JSON format.

Debug

Importing Flink Jobs

hcloud DLI ImportFlinkJobs

This API is used to use the POST method to import Flink jobs. The request body is in JSON format.

Debug

Generating a Static Stream Graph for a Flink SQL Job

hcloud DLI CreateFlinkSqlJobGraph

This API is used to generate a static stream graph of a Flink SQL job.

Debug

Querying the Flink Job Template List

hcloud DLI ListFlinkSqlJobTemplates

This API is used to query the Flink job template list. Currently, only user-defined templates can be queried.

Debug

Creating a Flink Job Template

hcloud DLI CreateFlinkSqlJobTemplate

This API is used to create a Flink job template in DLI. A maximum of 100 templates can be created.

Debug

Updating a Flink Job Template

hcloud DLI UpdateFlinkSqlJobTemplate

This API is used to update an existing Flink job template in DLI.

Debug

Deleting a Flink Job Template

hcloud DLI DeleteFlinkSqlJobTemplate

This API is used to delete a Flink job template. A template used by jobs can also be deleted.

Debug

Importing Savepoints for Flink Jobs

hcloud DLI ImportFlinkJobSavepoint

This API is used to import savepoints for Flink jobs.

Debug

Triggering Savepoints for Flink Jobs

hcloud DLI ExecuteFlinkJobSavepoint

This API is used to trigger savepoints for Flink jobs.

Debug

Querying the Batch Processing Job List

hcloud DLI ListSparkJobs

This API is used to list batch processing jobs in a queue of a project.

Debug

Creating a Batch Processing Job

hcloud DLI CreateSparkJob

This API is used to create a batch processing job in a queue.

Debug

Querying Batch Processing Job Details

hcloud DLI ShowSparkJob

This API is used to query details about a batch processing job based on the job ID.

Debug

Canceling a Batch Processing Job

hcloud DLI CancelSparkJob

This API is used to cancel a batch processing job.

Debug

Querying the Status of a Batch Processing Job

hcloud DLI ShowSparkJobStatus

This API is used to obtain the execution status of a batch processing job.

Debug

Creating a Job Template

hcloud DLI CreateSparkJobTemplate

This API is used to create a job template.

Debug

Querying the Job Template List

hcloud DLI ListSparkJobTemplates

This API is used to list job templates.

Debug

Modifying a Job Template

hcloud DLI UpdateSparkJobTemplate

This API is used to modify a job template.

Debug

Obtaining a Job Template

hcloud DLI ShowSparkJobTemplate

This API is used to obtain a job template.

Debug

Obtaining DLI Agency Information

hcloud DLI ShowDliAgency

This API is used to obtain DLI agency information.

Debug

Creating a DLI Agency

hcloud DLI CreateDliAgency

This API is used to create a DLI agency.

Debug

Granting Permissions to a Queue

hcloud DLI RegisterAuthorizedQueue

This API is used to share a specific queue with other users. You can grant users with the permission to use the specified queue or revoke the permission.

Debug

Querying Table Users

hcloud DLI ListTableUsers

This API is used to query users who have permission to access the specified table or column in the table.

Debug

Granting Data Permission to Users

hcloud DLI RunDataAuthorizationAction

This API is used to grant database or table data usage permission to specified users.

Debug

Querying a User's Table Permissions

hcloud DLI ListTablePrivileges

This API is used to query the permission of a specified user on a table.

Debug

Querying Database Users

hcloud DLI ListDatabaseUsers

This API is used to query names of all users who can use a specified queue.

Debug

Querying Queue Users

hcloud DLI ListQueueUsers

This API is used to query names of all users who can use a specified queue.

Debug

Uploading a File Package Group

hcloud DLI UploadFileJobResources

This API is used to upload a group of file packages to a project.

Debug

Uploading a PyFile Package Group

hcloud DLI UploadPythonFileJobResources

This API is used to upload a group of PyFile packages to a project.

Debug

Viewing Resource Packages in a Group

hcloud DLI ShowJobResource

This API is used to view resource information of a package group in a project.

Debug

Deleting a Resource Package from a Group

hcloud DLI DeleteJobResource

This API is used to delete resource packages in a group in a project.

Debug

Viewing Package Group List

hcloud DLI ListJobResources

This API is used to view all resources in a project, including groups.

Debug

Uploading a Package Group

hcloud DLI UploadJobResources

This API is used to upload a package group to a project.

Debug

Uploading a JAR Package Group

hcloud DLI UploadJarJobResources

This API is used to upload a group of JAR packages to a project.

Debug

Changing the Owner of a Group or Resource Package

hcloud DLI UpdateJobResourceOwner

This API is used to change the owner of a program package.

Debug

Listing Datasource Authentications

hcloud DLI ListAuthInfo

This API is used to query datasource authentication information.

Debug

Updating Datasource Authentication

hcloud DLI UpdateAuthInfo

This API is used to update datasource authentication information.

Debug

Creating Datasource Authentication

hcloud DLI CreateAuthInfo

This API is used to create datasource authentication.

Debug

Deleting Datasource Authentication

hcloud DLI DeleteAuthInfo

This API is used to delete datasource authentication information.

Debug

Deleting a Route

hcloud DLI DeleteEnhancedConnectionRoutes

This API is used to delete a datasource connection route.

Debug

Creating a Route

hcloud DLI CreateEnhancedConnectionRoutes

This API is used to create a datasource connection route.

Debug

Listing Basic Datasource Connections

hcloud DLI ListDatasourceConnections

This API is used to list the created basic datasource connections.

Debug

Creating a Basic Datasource Connection

hcloud DLI CreateDatasourceConnection

This API is used to create a basic datasource connection with other services.

Debug

Querying a Basic Datasource Connection

hcloud DLI ShowDatasourceConnection

This API is used to query a created basic datasource connection.

Debug

Deleting a Basic Datasource Connection

hcloud DLI DeleteDatasourceConnection

This API is used to delete a created basic datasource connection.

Debug

Modifying the CIDR Block of a Queue

hcloud DLI UpdateQueueCidr

This API is used to modify the CIDR block of the queues using the yearly/monthly packages.

Debug

Viewing a Scheduled CU Change

hcloud DLI ListQueuePlans

This API is used to view the scheduled CU change and list the change of a specified queue.

Debug

Creating a Scheduled CU Change

hcloud DLI CreateQueuePlan

This API is used to create a scheduled CU change, that is, to create a scheduled CU change for a specified queue.

Debug

Deleting Scheduled CU Changes in Batches

hcloud DLI BatchDeleteQueuePlans

This API is used to delete scheduled CU changes in batches.

Debug

Modifying a Scheduled CU Change

hcloud DLI UpdateQueuePlan

This API is used to modify a scheduled CU change for a queue with a specified ID.

Debug

Deleting a Scheduled CU Change

hcloud DLI DeleteQueuePlan

This API is used to delete a scheduled CU change for a queue with a specified ID.

Debug

Exporting Table Data

hcloud DLI ExportTable

This API is used to export results returned from the query using SQL statements to OBS. Only the query result of QUERY jobs can be exported.

Debug

Importing Data

hcloud DLI ImportTable

This API is used to import data from a file to a DLI or OBS table. Currently, only OBS data can be imported to a DLI or OBS table.

Debug

Querying All Databases

hcloud DLI ListDatabases

This API is used to query the information about all the databases.

Debug

Creating a Database

hcloud DLI CreateDatabase

This API is used to add a database.

Debug

Modifying a Database Owner

hcloud DLI UpdateDatabaseOwner

This API is used to modify the owner of a database.

Debug

Deleting a Database

hcloud DLI DeleteDatabase

This API is used to delete an empty database. If the database to be deleted contains tables, delete all the tables first.

Debug

Querying All Tables

hcloud DLI ListTables

This API is used to query information about tables that meet the filtering criteria or all the tables in the specified database.

Debug

Creating a Table

hcloud DLI CreateTable

This API is used to create a table.

Debug

Modifying a Table Owner

hcloud DLI UpdateTableOwner

This API is used to modify the owner of a table.

Debug

Describing Table Information

hcloud DLI ShowTable

This API is used to describe metadata information in the specified table.

Debug

Deleting a Table

hcloud DLI DeleteTable

This API is used to delete a specified table.

Debug

Previewing a Table

hcloud DLI PreviewTable

This API is used to preview the first 10 rows in a table.

Debug

Obtaining the Partition List

hcloud DLI ListPartitions

This API is used to obtain the partition list.

Debug

Querying All Sample SQL Templates

hcloud DLI ListSqlSampleTemplates

This API is used to query all sample SQL templates.

Debug

Granting OBS Permissions to DLI

hcloud DLI RegisterBucket

This API is used to grant DLI the permission to access OBS buckets for saving job checkpoints and run logs.

Debug

Querying Flink Job Monitoring Information

hcloud DLI ShowFlinkMetric

This API is used to query the monitoring information of Flink jobs. You can query the monitoring information of multiple Flink jobs at the same time.

Debug

Creating an IEF Message Channel

hcloud DLI CreateIefMessageChannel

This API is used to create an IEF message channel.

Debug

Reporting the Flink Edge Job Status

hcloud DLI UpdateFlinkJobStatusReport

This API is used to process the reported information about the Flink edge job status.

Debug

Action Status Callback of Flink Edge Jobs

hcloud DLI RunIefJobActionCallBack

This API is used to process the action callback information of an IEF Flink job.

Debug

Reporting an IEF System Event

hcloud DLI CreateIefSystemEvents

This API is used to report IEF system events.

Debug

Querying Batch Job Logs

hcloud DLI ShowSparkJobLog

This API is used to query the back-end logs of batch processing jobs.

Debug