CLI Command Reference (V3)
Quota
| API Name | Command | Description | Operation |
|---|---|---|---|
| Querying Quotas | hcloud DRS ShowQuotas/v3 | This API is used to query DRS quotas of a tenant in a project. |
Public API Management
| API Name | Command | Description | Operation |
|---|---|---|---|
| Creating Tasks in Batches | hcloud DRS BatchCreateJobs/v3 | This API is used to create real-time migration, real-time synchronization, and real-time DR tasks in batches based on different request parameters. | |
| Testing connections in batches | hcloud DRS BatchValidateConnections/v3 | This API is used to test connections in batches. | |
| Testing Connections in Batches (Cluster Mode) | hcloud DRS BatchValidateClustersConnections/v3 |
| |
| Selecting Database Objects in Batches | hcloud DRS BatchSetObjects/v3 | This API is used to select the databases or tables to be migrated. | |
| Performing a Batch Pre-Check | hcloud DRS BatchCheckJobs/v3 | This API is used to perform batch pre-check to check whether the migration can be performed. | |
| Querying Pre-check Results in Batches | hcloud DRS BatchCheckResults/v3 | This API is used to query the pre-check results of tasks in batches. | |
| Configuring Flow Control for Tasks | hcloud DRS BatchSetSpeed/v3 | This API is used to enable or disable flow control for tasks. By default, the migration speed is not limited after a task is created.- Control: You can customize the maximum migration speed.- No control: The migration speed is not limited and the outbound bandwidth of the source database is maximally used, which drives up read consumption on the source database accordingly. For example, if the outbound bandwidth of the source database is 100 MB/s and 80% bandwidth is used, the I/O consumption on the source database is 80 MB/s. | |
| Obtaining Database Parameters in Batches | hcloud DRS BatchShowParams/v3 | To ensure that service applications are not affected after the migration, DRS provides parameter comparison to help you compare parameters between the source and destination databases. This API is used to obtain database parameters of the source and destination databases. | |
| Modifying Database Parameters | hcloud DRS UpdateParams/v3 | This API is to modify database parameters. | |
| Starting Tasks in Batches | hcloud DRS BatchStartJobs/v3 | This API is used to start real-time migration, synchronization, and disaster recovery tasks in batches. | |
| Resuming or Retrying Tasks in Batches | hcloud DRS BatchRestoreTask/v3 | This API is used to retry failed migration tasks. | |
| Pausing Tasks in Batches | hcloud DRS BatchStopJobs/v3 | This API is used to pause tasks in batches. | |
| Stopping or Deleting Tasks in Batches | hcloud DRS BatchDeleteJobs/v3 | This API is used to stop tasks in batches or delete real-time migration, real-time synchronization, and real-time DR tasks. | |
| Modifying Tasks in Batches | hcloud DRS BatchUpdateJob/v3 | This API is used to modify task names or descriptions in batches and set exception notification. | |
| Changing the Passwords of the Source and Destination Databases in Batches | hcloud DRS BatchResetPassword/v3 | This API is used to change the passwords of the source and destination databases after a task is started. | |
| Setting Definers in Batches | hcloud DRS BatchSetDefiner/v3 | The API is used to set whether to migrate all Definers to the user in batches.- If you select Yes, the Definers of all source database objects will be migrated to the user. Other users do not have permissions on database objects unless they are authorized.- If you select No, the Definers of all source database objects will not be changed. You need to migrate all accounts and permissions of the source database in the next step. | |
| Create a task. | hcloud DRS CreateCompareTask/v3 | This API is used to create a comparison task | |
| Querying Comparison Results | hcloud DRS ListCompareResult/v3 | This API is used to query the comparison result. | |
| Querying Task Progress in Batches | hcloud DRS BatchListProgresses/v3 | This API is used to query the full progress and incremental delay information in batches based on the task ID. | |
| Querying Task Details in Batches | hcloud DRS BatchListJobDetails/v3 | This API is used to query task details in batches by task ID. | |
| Tenant Task Query | hcloud DRS ShowJobList/v3 | This API is used to query tenant tasks by engine type, network type, task status, task name, or task ID. | |
| Querying Task Statuses in Batches | hcloud DRS BatchListJobStatus/v3 | This API is used to query task statuses in batches by task ID. | |
| Batch Configure Exception Notifications | hcloud DRS BatchSetSmn/v3 | This API is used to set exception notifications in batches. This parameter cannot be set for stopped tasks. | |
| Querying AZs Where Flavors Are Not Sold Out | hcloud DRS ListAvailableZone/v3 | This API is used to querying AZs where flavors are not sold out. | |
| Querying Available Node Specifications | hcloud DRS ListAvailableNodeTypes/v3 | This API is used to query available node specifications. | |
| Querying Data-level Table Comparison Tasks | hcloud DRS ListDataLevelTableCompareJobs/v3 | This API is used to query data-level table comparison tasks. | |
| Creating a Data-level Table Comparison Task | hcloud DRS CreateDataLevelTableCompareJob/v3 | This API is used to create a data-level table comparison task. | |
| Canceling a Comparison Task | hcloud DRS DeleteCompareJob/v3 | This API is used to cancel a comparison task. | |
| Immediately Starting a Data-level Table Comparison Task | hcloud DRS StartPromptlyDataLevelTableCompareJob/v3 | This API is used to immediately start a data-level table comparison task. | |
| Querying Row Comparison Overview | hcloud DRS ListDataCompareOverview/v3 | This API is used to query the row comparison overview. | |
| Querying Row Comparison Details | hcloud DRS ListDataCompareDetail/v3 | This API is used to query row comparison details. | |
| Querying Value Comparison Overview | hcloud DRS ListContentCompareOverview/v3 | This API is used to query the value comparison overview. | |
| Querying Value Comparison Details | hcloud DRS ListContentCompareDetail/v3 | This API is used to query value comparison details. | |
| Creating an Object-level Comparison Task | hcloud DRS CreateObjectLevelCompareJob/v3 | This API is used to create an object-level comparison task. | |
| Querying the Overview of an Object Comparison Task | hcloud DRS ListObejectLevelCompareOverview/v3 | This API is used to query the overview of an object comparison task. | |
| Querying Details About an Object Comparison Task | hcloud DRS ListObejectLevelCompareDetail/v3 | This API is used to query details about an object comparison task. | |
| Querying Value Comparison Differences | hcloud DRS ListContentCompareDifference/v3 | This API is used to query value comparison differences. | |
| Exporting the Result File of a Comparison Task | hcloud DRS CreateCompareResultFile/v3 | This API is used to export the comparison result file. | |
| Downloading the Result File of a Comparison Task | hcloud DRS DownloadCompareResultFile/v3 | This API is used to download the comparison result file. | |
| Querying the LTS Configuration | hcloud DRS SelectGroupAndStream/v3 | This API is used to query the LTS configuration of a task. | |
| Updating the LTS Configuration | hcloud DRS ModifyGroupAndStream/v3 | This API is used to update the LTS configuration of a task. |
Real-Time Synchronization Management
| API Name | Command | Description | Operation |
|---|---|---|---|
| Processing Data in Batches | hcloud DRS BatchChangeData/v3 | DRS processes synchronized objects and allows you to add rules for selected objects. | |
| Configuring Synchronization Policies in Batches | hcloud DRS BatchSetPolicy/v3 |
| |
| Advanced Settings | hcloud DRS UpdateTuningParams/v3 | This API is used to change the values of tuning parameters. | |
| Querying Advanced Settings | hcloud DRS QueryTuningParams/v3 | This API is used to query advanced settings. |
Real-Time Disaster Recovery Management
| API Name | Command | Description | Operation |
|---|---|---|---|
| Performing a Batch Primary/Standby Switchover | hcloud DRS BatchSwitchover/v3 | This API is used to perform a batch primary/standby switchover. | |
| Querying RPO and RTO in Batches | hcloud DRS BatchListRposAndRtos/v3 | This API is used to query Recovery Point Objective (RPO) and Recovery Time Objective (RTO). | |
| Querying DR Monitoring Data | hcloud DRS ShowMonitoringData/v3 | This API is used to query DR monitoring data based on the task ID. | |
| Querying the DR Initialization Progress in Batches | hcloud DRS BatchListStructProcess/v3 | This API is used to query the DR initialization progress in batches based on the task ID. Virtual IDs cannot be queried. | |
| Querying DR Initialization Object Details in Batches | hcloud DRS BatchListStructDetail/v3 | This API is used to query details about DR initialization objects in batches by task ID. |
Real-Time Migration Management
| API Name | Command | Description | Operation |
|---|---|---|---|
| Updating Migrated User Information in Batches | hcloud DRS BatchUpdateUser/v3 | This API is used to set the users and roles to be migrated in batches. | |
| Obtaining Migration Users of the Source Database | hcloud DRS ListUsers/v3 | This API is used to query the user information of the source database. |
What is your overall rating for this page?
Thank you very much for your feedback. We will continue working to improve the documentation.See the reply and handling status in My Cloud VOC.
For any further questions, feel free to contact us through the chatbot.
Chatbot
