CLI Command Reference

Listing Migration Tasks

hcloud OMS ListTasks

This API is used to list all migration tasks in a user account.

Go debug

Creating a Migration Task

hcloud OMS CreateTask

This API is used to create a migration task. After the migration task is created, it will be automatically started. You do not need to perform further operations

Go debug

Querying a Migration Task

hcloud OMS ShowTask

Querying a Migration Task

Go debug

Deleting a Migration Task

hcloud OMS DeleteTask

This API is used to delete a migration task.

Go debug

Pausing a Migration Task

hcloud OMS StopTask

This API is used to pause a migration task in migrating status.

Go debug

Starting a Migration Task

hcloud OMS StartTask

This API is used to start a migration task in paused or failed status.

Go debug

Updating the Traffic Limit Rules of a Migration Task

hcloud OMS UpdateBandwidthPolicy

This API is used to update the traffic limit rules for a migration task before it is completed.

Go debug

Batch Update Task

hcloud OMS BatchUpdateTasks

Batch Update Task by group_id or specific task_id.

Go debug

Listing API Versions

hcloud OMS ListApiVersions

This API is used to query all API versions of OMS.

Go debug

Querying an API Version

hcloud OMS ShowApiInfo

This API is used to query a specified API version of OMS.

Go debug

Creating a Synchronization Event

hcloud OMS CreateSyncEvents

This API is used to create a synchronization event when objects in the source bucket need to be synchronized. Then the system synchronizes the objects contained in the synchronization event.(Available in regions cn-north-4, cn-north-1 only.)

Go debug

This API is used to query information about all synchronization tasks of a tenant.

hcloud OMS ListSyncTasks

This API is used to query information about all synchronization tasks of a tenant. Currently, this API is available in regions CN North-Beijing4 and CN East-Shanghai1.

Go debug

Creating a Synchronization Task

hcloud OMS CreateSyncTask

This API is used to create a synchronization task. After the synchronization task is created, it will be automatically started.

Go debug

Querying a Synchronization Task

hcloud OMS ShowSyncTask

This API is used to query details about a synchronization task with a specified ID. Currently, this API is available only in CN North-Beijing4 and CN East-Shanghai1.

Go debug

Deleting a Synchronization Task

hcloud OMS DeleteSyncTask

This API is used to delete a synchronization task. Tasks that are being synchronized cannot be deleted.

Go debug

Querying the Statistics About a Synchronization Task

hcloud OMS ListSyncTaskStatistic

This API is used to query the statistics of a synchronization task, which includes the number of objects that are covered in synchronization requests, the number of objects that are successfully synchronized, the number of objects that fail to be synchronized, the number of objects that are skipped during synchronization, and the size of objects that are successfully synchronized. Currently, this API is available only in CN North-Beijing4 and CN East-Shanghai1.

Go debug

Pausing a Synchronization Task

hcloud OMS StopSyncTask

This API is used to pause a synchronization task that is being synchronized. Currently, this API is only CN North-Beijing4, CN East-Shanghai1 and Southwest-Guiyang1.

Go debug

Starting a Synchronization Task

hcloud OMS StartSyncTask

This API is used to start a paused a synchronization task. Currently, this API is only available CN North-Beijing4, CN East-Shanghai1 and CN Southwest-Guiyang1.

Go debug

Agree to the Privacy Agreement.

hcloud OMS UpdatePrivacyAgreementRecord

When creating migration tasks, task groups, and evaluation tasks, record the user's agreement to the privacy agreement.

Go debug

Creating a Migration Task Group

hcloud OMS CreateTaskGroup

This API is used to create a migration task group. After a migration task group is created, migration tasks are automatically created in the task group. You do not need to call APIs to create migration tasks.

Go debug

This API is used to obtain information about a migration task group by ID.

hcloud OMS ShowTaskGroup

This API is used to obtain information about a migration task group by ID.

Go debug

Deleting a Migration Task Group

hcloud OMS DeleteTaskGroup

This API is used to delete a migration task group by ID.

Go debug

Pausing a Migration Task Group

hcloud OMS StopTaskGroup

This API is used to pause a migration task group by ID when the migration task group is in creating or monitoring state.

Go debug

Resuming a Migration Task Group

hcloud OMS StartTaskGroup

This API is used to resume a paused migration task group by ID.

Go debug

Restarting a Migration Task Group

hcloud OMS RetryTaskGroup

This API is used to restart a failed migration task group by ID.

Go debug

Modifying Traffic Limit Rules for a Migration Task Group

hcloud OMS UpdateTaskGroup

This API is used to update the traffic limit rules for a migration task group before it is completed.

Go debug

Listing Objects in a Bucket

hcloud OMS ShowBucketObjects

This API is used to list objects in a bucket.

Go debug

Querying the CDN Information of a Bucket

hcloud OMS ShowCdnInfo

This API is used to query the CDN information of a bucket.

Go debug

Listing Buckets

hcloud OMS ShowBucketList

This API is used to list buckets.

Go debug

Querying the Region of a Bucket

hcloud OMS ShowBucketRegion

This API is used to query the region of a bucket.

Go debug

Checking Whether a Prefix Is Found in a Source Bucket

hcloud OMS CheckPrefix

This API is used to check whether a prefix is found in a source bucket.

Go debug

Checking the format of the URL source list file.

hcloud OMS CheckUrlSourceListFileFormat

Check whether the format of the URL source list file is valid.

Go debug

Querying All Supported Cloud Vendors

hcloud OMS ShowCloudType

This API is used to query supported cloud vendors.

Go debug

Querying Regions Supported for a Cloud Vendor

hcloud OMS ShowRegionInfo

This API is used to query regions supported for a cloud vendor.

Go debug