CLI Command Reference (V5)

Querying Information about Available Links

hcloud DRS ListLinks/v5

This API is used to query information about available links for real-time migration, real-time synchronization, and real-time disaster recovery, based on different parameters.

Go debug

Querying Information About All Feature Whitelists

hcloud DRS ListFeatures/v5

This API is used to query the statuses of all feature switches based on different parameters.

Go debug

Querying Tasks

hcloud DRS ListJobs/v5

This API is used to query tenant tasks by enterprise project, engine type, network type, task status, task name, or task ID.

Go debug

Creating a Task

hcloud DRS CreateJob/v5

This API is used to create a single task. You can create a real-time migration, synchronization, or DR task based on different request parameters.

Go debug

Deleting Tasks in Batches

hcloud DRS BatchDeleteJobsById/v5

This API is used to delete tasks with specified IDs in batches.

Go debug

Updating Details About a Task with a Specified ID

hcloud DRS UpdateJob/v5

This API is used to update details about a task with a specified ID.

Go debug

Deleting a Task with a Specified ID

hcloud DRS DeleteJob/v5

This API is used to delete a task with a specified ID.

Go debug

Cloning a Task

hcloud DRS CopyJob/v5

This API allows you to clone the configuration of existing synchronization tasks.

Go debug

Changing the Billing Mode from Pay-per-Use to Yearly/Monthly

hcloud DRS ChangeToPeriod/v5

This API is used to change the billing mode of a real-time synchronization or DR task from pay-per-use to yearly/monthly.

Go debug

Exporting a Creation Template

hcloud DRS ExportCreationTemplate/v5

This API is used to export a template based on an existing task. (This is an asynchronous operation. You need to call the API for querying the export progress to query the result.)

Go debug

Querying the Progress of Exporting Task Creation Templates

hcloud DRS ShowExportProgress/v5

This API is used to query the progress of exporting task batch creation templates.

Go debug

Querying the List of Task Creation Templates

hcloud DRS ListTemplates/v5

This API is used to query the batch creation template list.

Go debug

Downloading Task Creation Templates

hcloud DRS DownloadCreateTemplate/v5

This API is used to download a template exported based on an existing task.

Go debug

Querying Database Object Information

hcloud DRS ListDbObjects/v5

This API is used to query database object information.

Go debug

Uploading the Object Import Template

hcloud DRS UploadDbObjectTemplate/v5

This API is used to upload the object import template of a task.

Go debug

Downloading the Object Import Template

hcloud DRS DownloadDbObjectTemplate/v5

This API is used to download the object import template of a task.

Go debug

Querying the Progress of Uploading the Object Import Template

hcloud DRS ShowDbObjectTemplateProgress/v5

This API is used to query the progress of uploading the object import template of a task.

Go debug

Obtaining the Result of Uploading the Object Import Template

hcloud DRS ShowDbObjectTemplateResult/v5

This API is used to obtain the result of uploading the object import template of a task.

Go debug

Obtaining the Result of Querying Database Object Information

hcloud DRS ShowDbObjectCollectionStatus/v5

This API is used to obtain the result of querying database object information.

Go debug

Obtaining the Progress of Saving Objects

hcloud DRS ShowUpdateObjectSavingStatus/v5

This API is used to obtain the progress of saving objects.

Go debug

Submitting the Query of Database Object Information

hcloud DRS CollectDbObjectsAsync/v5

This API is used to submit the query of database object information. Example:

Go debug

Querying the Synchronization Mapping List

hcloud DRS ShowObjectMapping/v5

This API is used to query the objects that can be mapped to the destination include databases, schemas, tables, and columns (in data processing).

Go debug

Querying Whether Object Selection and Column Mapping Are Supported

hcloud DRS ShowSupportObjectType/v5

This API is used to query information such as the object selection type, column mapping, and object type that can be searched for supported by a task.

Go debug

Submitting the Query of Database Object Information

hcloud DRS CollectDbObjectsInfo/v5

This API is used to submit the query of database object information. Example:

Go debug

Querying Database Object Information

hcloud DRS ShowDbObjectsList/v5

This API is used to query database object information.

Go debug

Querying Column Information (Column Mapping and Column Filtering) of an Object

hcloud DRS ShowColumnInfos/v5

This API is used to query the column information (column mapping and column filtering) of an object.

Go debug

Deleting Column Information (Column Mapping and Column Filtering) of an Object

hcloud DRS DeleteColumnInfos/v5

This API is used to delete the column information (column mapping and column filtering) of an object.

Go debug

Modifying Column Information (Column Mapping and Column Filtering) of an Object

hcloud DRS ModifyColumnInfos/v5

This API is used to modify the column information (column mapping and column filtering) of an object.

Go debug

Querying Task Details

hcloud DRS ShowJobDetail/v5

This API is used to query task details.

Go debug

Obtaining Task Pricing Details

hcloud DRS ShowMetering/v5

This API is used to query the task pricing details.

Go debug

Querying the Abnormal Data List

hcloud DRS ShowDirtyData/v5

This API is used to query the abnormal data list.

Go debug

Exporting Task Operation Statistics

hcloud DRS ExportOperationInfo/v5

This API is used to export the operation statistics of a specified task.

Go debug

Querying Monitoring Data

hcloud DRS ShowMonitorData/v5

This API is used to obtain task monitoring data.

Go debug

Querying Incremental Component Details

hcloud DRS ShowIncrementComponentsDetail/v5

This API is used to query details about incremental components for an incremental or full+incremental task. For details, see Querying the Synchronization Progress.

Go debug

Performing Operations on a Task with a Specified ID

hcloud DRS ExecuteJobAction/v5

This API is used to perform operations on a task with a specified ID.

Go debug

Stopping a Task

hcloud DRS StopJobAction/v5

This API is used to stop a task with a specified ID.

Go debug

Batch Performing Operations on Tasks with Specified IDs

hcloud DRS BatchExecuteJobActions/v5

This API is used to batch perform operations on tasks with specified IDs.

Go debug

Obtaining the Operations Allowed in a Specified Task

hcloud DRS ShowActions/v5

This API is used to obtain information about allowed, not allowed, and current operations of a specified task.

Go debug

Verifying a Task Name

hcloud DRS ValidateJobName/v5

This API is used to verify a task name during task creation.

Go debug

Batch Stopping Tasks

hcloud DRS BatchStopJobsAction/v5

This API is used to batch stop tasks with a specified ID.

Go debug

Updating the Start Point of an Incremental Task

hcloud DRS UpdateStartPosition/v5

This API is used to update the start point of an incremental task.

Go debug

Collecting Database Position Information

hcloud DRS CollectPositionAsync/v5

This API is used to collect database position information.

Go debug

Obtaining the Result for Querying Database Position

hcloud DRS ShowPositionResult/v5

This API is used to obtain the result for querying the database position.

Go debug

Uploading a Driver File (Deprecated)

hcloud DRS UploadJdbcDriver/v5

This API is used to upload a driver file.

Go debug

Uploading a Driver File

hcloud DRS UploadUserJdbcDriver/v5

This API is used to upload a driver file.

Go debug

Deleting a Driver File (Deprecated)

hcloud DRS DeleteJdbcDriver/v5

This API is used to delete a driver file.

Go debug

Querying the Driver File List (Deprecated)

hcloud DRS ListJdbcDrivers/v5

This API is used to query the driver file list.

Go debug

Synchronizing a Driver File (Deprecated)

hcloud DRS SyncJdbcDriver/v5

This API is used to synchronize a driver file.

Go debug

Synchronizing a Driver File

hcloud DRS SyncUserJdbcDriver/v5

This API is used to synchronize a driver file.

Go debug

Deleting a Driver File

hcloud DRS DeleteUserJdbcDriver/v5

This API is used to delete a driver file.

Go debug

Querying the Driver File List

hcloud DRS ListUserJdbcDrivers/v5

This API is used to query the driver file list.

Go debug

Querying the Comparison Policy

hcloud DRS ShowComparePolicy/v5

This API is used to query the comparison policy.

Go debug

Modifying the Comparison Policy

hcloud DRS UpdateComparePolicy/v5

This API is used to modify the periodic comparison policy. This function is available only for MySQL-to-MySQL, MySQL-to-GaussDB(for MySQL), MySQL-to-GaussDB(DWS) and GaussDB(for MySQL)-to-MySQL synchronization tasks, MySQL-to-MySQL and MySQL-to-GaussDB(for MySQL) migration tasks, and MySQL-to-MySQL, MySQL-to-GaussDB(for MySQL), GaussDB(for MySQL)-to-GaussDB(for MySQL), DDM-to-DDM, and DDS-to-DDS disaster recovery tasks.

Go debug

Querying the Health Comparison List

hcloud DRS ShowHealthCompareJobList/v5

This API is used to query the health comparison list.

Go debug

Querying the Data-Level Streaming Comparison List

hcloud DRS ShowProgressData/v5

This API is used to query the migration progress of different migration tasks.

Go debug

Querying Details About a Health Comparison Task

hcloud DRS ShowHealthCompareJobDetail/v5

This API is used to query details about a health comparison task.

Go debug

Obtaining the Overview of an Object-Level Health Comparison

hcloud DRS ShowHealthObjectCompareJobOverview/v5

This API is used to obtain the overview of an object-level health comparison.

Go debug

Querying the Comparison Task Progress

hcloud DRS ShowCompareProgress/v5

This API is used to query the comparison progress of a running comparison task.

Go debug

Querying Enterprise Projects

hcloud DRS ShowEnterpriseProject/v5

This API is used to query the enterprise projects.

Go debug

Updating Data Processing Rules for a Specified Task

hcloud DRS UpdateDataProgress/v5

This API is used to update the data processing rules for a specified task.

Go debug

Querying Data Processing Rules

hcloud DRS ShowDataProgress/v5

This API is used to query data processing rules, including database table mapping information, column information, data filtering information, additional column information, DDL information, and DML information.

Go debug

Obtaining the Data Processing Rule Update Result for a Specified Task

hcloud DRS ShowDataProcessingRulesResult/v5

This API is used to obtain the data processing rule update result for a specified task.

Go debug

Verifying Data Filtering Rules

hcloud DRS CheckDataFilter/v5

This API is used to verify data filtering rules.

Go debug

Obtaining the Data Filtering Verification Result

hcloud DRS ShowDataFilteringResult/v5

This API is used to obtain the data filtering verification result.

Go debug

Collecting Column Information About a Specified Database Table

hcloud DRS CollectColumns/v5

This API is used to collect the column information about a specified database table.

Go debug

Obtaining Column Information About a Specified Database Table

hcloud DRS ShowColumnInfoResult/v5

This API is used to obtain the column information about a specified database table.

Go debug

Batch Adding or Deleting Tags

hcloud DRS BatchTagAction/v5

This API is used to add or delete tags in batches.

Go debug

Querying Tags of a Specified Project

hcloud DRS ListProjectTags/v5

This API is used to query all tags of different task types in a project with a specified ID.

Go debug

Querying Tags of a Task

hcloud DRS ShowInstanceTags/v5

This API is used to query tags of a specified task.

Go debug

Adding Resource Tags in Batches

hcloud DRS BatchCreateTags/v5

This API is used to add resource tags in batches.

Go debug

Deleting Resource Tags in Batches

hcloud DRS BatchDeleteTags/v5

This API is used to batch delete tags from a specified instance.

Go debug

Querying the Resource Instance List

hcloud DRS ListInstanceByTags/v5

This API is used to query the resource instance list.

Go debug

Querying the Number of Resource Instances

hcloud DRS CountInstanceByTags/v5

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

Go debug

Querying Tags of a Task

hcloud DRS ListInstanceTags/v5

This API is used to query tags of a specified task.

Go debug

Querying Tags of a Specified Project

hcloud DRS ListTags/v5

This API is used to query the tags of all resources owned by a tenant in a specific project.

Go debug

Updating Task Parameters

hcloud DRS UpdateJobConfigurations/v5

This API is used to update task parameters.

Go debug

Querying Task Parameter Configuration List

hcloud DRS ListJobParameters/v5

This API is used to query task parameter configuration list.

Go debug

Querying Task Parameter Change History

hcloud DRS ListJobHistoryParameters/v5

This API is used to query the change history of task parameters.

Go debug

Querying the Permissions of an Agency

hcloud DRS ListsAgencyPermissions/v5

This API is used to obtain the permissions required by the agency based on the source database type, destination database type, and whether the database is self-managed.

Go debug

Querying Agency Permission Details

hcloud DRS ShowAgencyInfo/v5

This API is used to query agency permission details.

Go debug

Updating an Agency Permission Policy

hcloud DRS UpdateAgencyPolicy/v5

This API is used to update an agency permission policy.

Go debug

Querying the Progress of a Workload Replay Task

hcloud DRS ShowReplayProgress/v5

This API is used to query the progress of a workload replay task.

Go debug

Querying the Connection List

hcloud DRS ListConnections/v5

This API is used to query the connection list by connection type.

Go debug

Creating a Connection

hcloud DRS CreateConnection/v5

This API is used to create a single connection. The connection database can be an on-premises database or an RDS DB instance. Currently, the supported DB engines include MySQL, PostgreSQL, Oracle, and MongoDB.

Go debug

Modifying a Connection

hcloud DRS ModifyConnection/v5

This API is used to modify a connection.

Go debug

Deleting a Connection

hcloud DRS DeleteConnection/v5

This API is used to delete a specified connection of the tenant.

Go debug

Querying the Incremental DDL List

hcloud DRS ListJobDdls/v5

This API is used to query the incremental DDL list by DDL status.

Go debug

Clearing DDL Alarms

hcloud DRS CleanAlarms/v5

This API is used to clear DDL alarms.

Go debug

Querying the Backup Migration Task List

hcloud DRS ListReplicationJobs/v5

This API is used to obtain the list of backup migration tasks except deleted tasks.

Go debug

Creating a Backup Migration Task

hcloud DRS CreateReplicationJob/v5

This API is used to configure backup migration tasks in three common scenarios.

Go debug

Deleting a Backup Migration Task

hcloud DRS DeleteReplicationJob/v5

This API is used to delete a backup migration task that has been completed.

Go debug

Querying Details About a Backup Migration Task

hcloud DRS ShowReplicationJob/v5

This API is used to obtain detailed information of a specific backup migration task.

Go debug

Modifying Backup Migration Task Details

hcloud DRS UpdateReplicationJob/v5

Thi API is used to modify the information, name, and description of a specified backup migration task.

Go debug

Asynchronously Creating Tasks in Batches

hcloud DRS BatchCreateJobsAsync/v5

This API is used to asynchronously create real-time migration, synchronization, or DR tasks in batches based on different request parameters.

Go debug

Querying the List of Tasks Asynchronously Created in Batches

hcloud DRS ListAsyncJobs/v5

This API is used to query the list of tasks asynchronously created in batches.

Go debug

Submitting Tasks Created Asynchronously in Batches

hcloud DRS CommitAsyncJob/v5

This API is used to submit the tasks created asynchronously in batches. After tasks are asynchronously created in batches or parameters are updated, the system automatically verifies the parameters. After the parameters of all tasks are verified and no error is reported, you can call this API to create DRS instances.

Go debug

Querying Details About Tasks Created Asynchronously in Batches with a Specified ID

hcloud DRS ListAsyncJobDetail/v5

This API is used to query details about the tasks created asynchronously in batches with a specified ID. By default, the return results are sorted by create_time in descending order. Pagination query is supported.

Go debug

Updating Details About Tasks Created Asynchronously in Batches with a Specified ID

hcloud DRS UpdateBatchAsyncJobs/v5

This API is used to update details about the tasks created asynchronously in batches with a specified ID.

Go debug

Downloading the Task Import Template

hcloud DRS DownloadBatchCreateTemplate/v5

This API is used to download the template for importing tasks in batches.

Go debug

Importing Tasks in Batches

hcloud DRS ImportBatchCreateJobs/v5

This API is used to import the task template to create tasks in batches.

Go debug

Querying the Traffic Replay Result

hcloud DRS ShowReplayResults/v5

This API is used to obtain replay results, including time-based replay statistics, abnormal SQL details and statistics, and slow SQL details and statistics.

Go debug

Displaying Timeline Information

hcloud DRS ShowTimeline/v5

This API is used to display the timeline information about operations such as the creation time, start time, retry, and reset of the current task by specifying different task IDs.

Go debug

Querying the Subscription Task List

hcloud DRS ShowSubscriptionLists/v5

This API is used to query subscription tasks by enterprise project, engine type, network type, task status, task name, or task ID.

Go debug