Exporting a Task List

project_id

Yes

String

Definition

Project ID of a tenant in a region.

For details about how to obtain the project ID, see Obtaining a Project ID.

Constraints

N/A

Range

N/A

Default Value

N/A

Content-Type

No

String

Definition

MIME type of the request body. Use the default value application/json. For APIs used to upload objects or images, the value varies depending on the flow type.

Constraints

N/A

Range

application/json

Default Value

application/json

X-Auth-Token

Yes

String

Definition

User token obtained from IAM. It is a response to the API for obtaining a user token. This API is the only one that does not require authentication. The token is the value of X-Subject-Token in the response header.

Constraints

N/A

Range

N/A

Default Value

N/A

X-Language

No

String

Definition

Request language type.

Constraints

Specify the request language type based on the supported languages.

Range

• en-us: English
• zh-cn: Chinese
• es-us: Spanish
• pt-br: Portuguese

Default Value

en-us

job_type

Yes

String

Definition

Service scenario type of DRS tasks, which is used to filter tasks of a specific service type.

Constraints

N/A

Range

• backupMigration: backup migration
• subscription: subscription

Default Value

N/A

name

No

String

Definition

Task name.

Constraints

N/A

Range

N/A

Default Value

N/A

status

No

String

Definition

Task status. By default, tasks in all statuses are queried.

Constraints

N/A

Range

When job_type is migration, sync, or cloudDataGuard:

Values:

• CREATING: The task is being created.
• CREATE_FAILED: The task failed to be created.
• CONFIGURATION: The task is being configured.
• STARTJOBING: The task is being started.
• WAITING_FOR_START: The task is waiting to be started.
• START_JOB_FAILED: The task failed to be started.
• FULL_TRANSFER_STARTED: Full migration is in progress. For DR scenarios, initialization is in progress.
• FULL_TRANSFER_FAILED: Full migration failed. For DR scenarios, initialization failed.
• FULL_TRANSFER_COMPLETE: Full migration is complete. For DR scenarios, initialization is complete.
• INCRE_TRANSFER_STARTED: Incremental migration is in progress. For DR scenarios, disaster recovery is in progress.
• INCRE_TRANSFER_FAILED: Incremental migration failed. For DR scenarios, a DR exception occurs.
• RELEASE_RESOURCE_STARTED: The task is being stopped.
• RELEASE_RESOURCE_FAILED: The task failed to be stopped.
• RELEASE_RESOURCE_COMPLETE: The task is stopped.
• CHANGE_JOB_STARTED: The task is being changed.
• CHANGE_JOB_FAILED: The task failed to be changed.
• CHILD_TRANSFER_STARTING: The subtask is being started.
• CHILD_TRANSFER_STARTED: The subtask is in progress.
• CHILD_TRANSFER_COMPLETE: The subtask is complete.
• CHILD_TRANSFER_FAILED: The subtask failed.
• RELEASE_CHILD_TRANSFER_STARTED: The subtask is being stopped.
• RELEASE_CHILD_TRANSFER_COMPLETE: The subtask is stopped.
• You can query an abnormal status separately or query all abnormal tasks in the following statuses: CREATE_FAILED, START_JOB_FAILED, FULL_TRANSFER_FAILED, INCRE_TRANSFER_FAILED, RELEASE_RESOURCE_FAILED, CHANGE_JOB_FAILED, and CHILD_TRANSFER_FAILED.

When job_type is backupMigration:

Values:

• SUCCESS: The backup migration is successful.
• TRANSFERRING: The backup migration is in progress.
• FAILED: The backup migration failed.
• PRECHECK FAILED: The precheck failed.

When job_type is subscription:

Values:

• SUBSCRIPTION_STARTED: The task is being created.
• CREATE_FAILED: The task failed to be created.
• SUBSCRIPTION_FAILED: The subscription failed.
• CONFIGURATION: The task is being configured.
• STARTJOBING: The task is being started.
• REBUILD_NODE_STARTED: The task is being recovered.
• REBUILD_NODE_FAILED: The task failed to be recovered.
• START_JOB_FAILED: The task failed to be started.

Default Value

N/A

dbs_instance_ids

No

Array of strings

Definition

DB instance IDs.

Constraints

A maximum of 10 DB instance IDs are allowed.

Range

N/A

Default Value

N/A

description

No

String

Definition

Description.

Constraints

N/A

Range

N/A

Default Value

N/A

create_at

No

String

Definition

Creation time.

Constraints

When job_type is set to migration, sync, or cloudDataGuard, this parameter indicates the task creation time, for example, "2026-05-25T13:41:00.127Z|2026-05-28T13:41:00.999Z".

When job_type is set to backupMigration, this parameter indicates the task creation time, for example, "2026-05-25T13:41:00.127Z|2026-05-28T13:41:00.999Z".

When job_type is set to subscription, this parameter indicates the consumption start time, for example, "2026-05-25T13:25:46.383Z|2026-05-28T13:25:46.999Z".

Range

N/A

Default Value

N/A

completed_at

No

String

Definition

Completion time.

Constraints

When job_type is set to backupMigration, this parameter can be specified, indicating the task completion time, for example, "2026-05-25T13:41:00.127Z|2026-05-28T13:41:00.999Z".

Range

N/A

Default Value

N/A

enterprise_project_id

No

String

Definition

Enterprise project ID.

Constraints

N/A

Range

N/A

Default Value

N/A

engine_type

No

String

Definition

Engine type.

Constraints

When job_type is set to backupMigration, the value of this parameter is sqlserver.

Range

N/A

Default Value

N/A

net_type

No

String

Definition

Network type.

Constraints

This parameter can be set when job_type is set to migration, sync, or cloudDataGuard.

Range

• eip: public network
• vpc: VPC network
• vpn: VPN or Direct Connect

Default Value

N/A

billing_tag

No

String

Definition

Billing tag.

Constraints

This parameter can be set when job_type is set to migration, sync, cloudDataGuard, or subscription.

Range

• 0: being billed
• 1: not being billed

Default Value

N/A

billing_mode

No

String

Definition

Billing mode.

Constraints

This parameter can be set when job_type is set to migration, sync, cloudDataGuard, or subscription.

Range

• 0: pay-per-use
• 1: yearly/monthly

Default Value

N/A

public_ip

No

String

Definition

EIP bound to the DB instance.

Constraints

This parameter can be set when job_type is set to migration, sync, or cloudDataGuard.

Range

N/A

Default Value

N/A

instance_ip

No

String

Definition

IP address bound to a DRS task.

Constraints

This parameter can be set when job_type is set to migration, sync, or cloudDataGuard.

Range

N/A

Default Value

N/A

inner_ip

No

String

Definition

Private IP address bound to a DRS task.

Constraints

This parameter can be set when job_type is set to migration, sync, or cloudDataGuard.

Range

N/A

Default Value

N/A

spec_type

No

String

Definition

Specification type.

Constraints

This parameter can be set when job_type is set to migration, sync, or cloudDataGuard.

Range

• 2xlarge: macro specifications
• xlarge: ultra-large specifications
• high: large specifications
• medium: medium specifications
• small: small specifications
• micro: micro specifications

Default Value

N/A

direction

No

String

Definition

Data flow direction.

Constraints

This parameter can be specified when job_type is set to migration or sync.

Values:

• up: to the cloud
• down: out of the cloud
• non-dbs: between self-built databases
• multiWrite: two-way synchronization

This parameter can be specified when job_type is set to cloudDataGuard.

Values:

• up: current cloud as standby
• down: current cloud as active
• multiWrite: dual-active DR

Range

• up
• down
• non-dbs
• multiWrite

Default Value

N/A

task_type

No

String

Definition

Synchronization type.

Constraints

This parameter can be specified when job_type is set to migration or sync.

Range

• FULL_INCR_TRANS
• FULL_TRANS
• INCR_TRANS

Default Value

N/A

sort_key

No

String

Definition

The keyword based on which the returned results are sorted.

Constraints

N/A

Range

• name
• status
• create_time
• net_type
• job_direction
• pay_mode

Default Value

create_time

sort_dir

No

String

Definition

Descending or ascending order

Constraints

N/A

Range

• desc: descending order
• asc: ascending order

Default Value

desc

tag

No

String

Definition

Tag

Constraints

N/A

Range

N/A

Default Value

N/A

id

String

Definition

Unique ID of an asynchronous task, which is used to query the task execution progress.

Constraints

N/A

Range

N/A

error_code

String

Definition

Error code returned when an error occurs during task execution.

Constraints

• Minimum length: 12 characters
• Maximum length: 12 characters

Range

The format is DRS.XXXXXX.

error_msg

String

Definition

Detailed error description returned when a task fails to be executed.

Constraints

• Minimum length: 1 character
• Maximum length: 512 characters

Range

N/A

200

OK

400

Bad Request