Updated on 2025-12-04 GMT+08:00

API Overview

OMS provides version query APIs and task management APIs.

Table 1 OMS APIs

API

Description

Obtaining a Project ID and Task ID

Query a project ID and task ID.

Listing API Versions

Query all API versions of OMS.

Querying an API Version

Query a specified API version of OMS.

Listing Migration Tasks

Query information about all tasks under a user account.

Querying a Migration Task

Query details about a migration task with a specified ID.

Creating a Migration Task

Create a migration task.

Starting a Migration Task

Start a migration task after the migration task has been paused or failed.

Pausing a Migration Task

Stop a migration task that is in the Migrating state.

Deleting a Migration Task

Delete a migration task based on its ID.

Updating the Traffic Limiting Rules of a Migration Task

Update the traffic limiting rules for a migration task before the task is complete.

Updating Tasks in Batches

Update migration tasks in batches. You can update all migration tasks in a migration task group or specify IDs of migration tasks to update them in batches.

Listing Migration Task Groups

List all migration task groups in an account.

Creating a Migration Task Group

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 manually call APIs to create migration tasks.

Querying a Migration Task Group

Query the information about a migration task group with a specified ID.

Deleting a Migration Task Group

Delete a migration task group.

Pausing a Migration Task Group

Pause a migration task group when it is in Creating or Monitoring status.

Resuming a Migration Task Group

Resume a paused migration task group with a specified ID.

Restarting a Migration Task Group

Restart a failed migration task group with a specified ID.

Modifying Traffic Limiting Rules for a Migration Task Group

Update the traffic limiting rules for a migration task group before it is completed.

Listing Objects in a Bucket

List objects in a bucket.

Querying CDN Information of a Bucket

Query the CDN information of a bucket.

Listing Buckets

List all buckets.

Querying the Region of a Bucket

Query the region of a bucket.

Checking Whether a Source Bucket Has Objects with a Specified Prefix

Check whether there are objects with a specified prefix in a source bucket.

Querying All Supported Cloud Vendors

Query supported cloud vendors.

Querying Regions Supported for a Cloud Vendor

Query regions supported for a cloud vendor.