Updating Details About a Task with a Specified ID

project_id

Yes

String

Project ID of a tenant in a region.

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

job_id

Yes

String

Task ID.

Content-Type

Yes

String

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.

The default value is application/json.

X-Auth-Token

Yes

String

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.

After a request is processed, the value of X-Subject-Token in the header is the token value.

X-Language

No

String

Request language type.

Default value: en-us

Enumerated values:

• en-us
• zh-cn

job

Yes

Object

Request body for updating a task with a specified ID.

For details, see Table 4.

type

Yes

String

Type of the task details to be updated with a specified ID.

If you update details about a single task, the values can be:

• name: Update the task name.
• description: Update the task description.
• endpoint: Update the source or destination database information if the connection test fails.
• policy: Update the task configuration.
• re_create: Recreate a task if VM resources of the task are deleted three days after it is in the Configuration state.
• expired_days: Update the number of days after which an abnormal task is automatically stopped.
• notify: Update task exception notification information.

Enumerated values:

• name
• description
• endpoint
• re_create
• expired_days
• policy
• notify

params

Yes

Object

Parameters of the task details to be updated with a specified ID.

For details, see Table 5.

job_id

No

String

ID of the task to be updated.

base_info

No

Object

Basic information body of a task. This parameter is mandatory when type is set to name or description.

For details, see Table 6.

source_endpoint

No

Array of objects

Source database information body of a task. This parameter is mandatory when type is set to endpoint.

For details, see Table 8.

target_endpoint

No

Array of objects

Destination database information body of a task. This parameter is mandatory when type is set to endpoint.

For details, see Table 8.

alarm_notify

No

Object

Information body for setting task exception notification.

For details, see Table 15.

speed_limit

No

Array of objects

Flow control information body. This parameter is mandatory when type is set to speed_limit.

• If you enable flow control, you can customize the maximum migration speed.
• If you disable flow control, the migration speed is not limited and the outbound bandwidth of the source database is maximally used,

which causes 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.

For details, see Table 16.

user_migration

No

Object

User migration information body.

For details, see Table 17.

policy_config

No

Object

Policy information body. This parameter is used to configure migration and synchronization policies, including the conflict policy, DROP DATASE filtering, and object synchronization scope. This parameter is mandatory when type is set to policy.

For details, see Table 20.

db_object

No

Object

Database object information body. This parameter is used to select databases or tables to be migrated for migration and synchronization tasks. This parameter is mandatory when type is set to db_object.

For details, see Table 21.

db_param

No

Object

Database parameter information body.

For details, see Table 27.

tuning_params

No

Object

Advanced setting information body. This parameter is mandatory when type is set to tuning_param.

For details, see Table 29.

period_order

No

Object

Yearly/Monthly information body.

For details, see Table 30.

node_info

No

Object

Information body of the DRS instance.

For details, see Table 31.

name

No

String

Task name. The task name can be 4 to 50 characters in length. It is case-insensitive and can contain only letters, digits, hyphens (-), and underscores (_).

• Minimum length: 4
• Maximum length: 50

Minimum length: 4

Maximum length: 50

job_type

No

String

Task scenario. Values:

• migration: real-time migration.
• sync: real-time synchronization.
• cloudDataGuard: real-time disaster recovery.

Enumerated values:

• migration
• sync
• cloudDataGuard

multi_write

No

Boolean

Whether the DR type is dual-active. Note:

• This parameter is mandatory when job_type is set to cloudDataGuard. If the DR type is dual-active, the value of multi_write is true. Otherwise, the value is false.
• If job_type is set to other values, multi_write is optional.

engine_type

No

String

Engine type. The value can be:

• oracle-to-gaussdbv5: Synchronization from Oracle to GaussDB distributed.
• redis-to-gaussredis: Migration from Redis to GeminiDB Redis.
• rediscluster-to-gaussredis: Migration from cluster Redis to GeminiDB Redis.

Enumerated values:

• oracle-to-gaussdbv5
• redis-to-gaussredis
• rediscluster-to-gaussredis

job_direction

No

String

Migration direction. Values:

• up: to-the-cloud scenarios and DR scenarios where the current cloud is the standby.
• down: out-of-cloud scenarios and DR scenarios where the current cloud is the active.
• non-dbs: self-built databases.

Enumerated values:

• up
• down
• non-dbs

task_type

No

String

Migration type. Values:

• FULL_TRANS: full migration.
• FULL_INCR_TRANS: full+incremental migration.
• INCR_TRANS: incremental migration.

Enumerated values:

• FULL_TRANS
• FULL_INCR_TRANS
• INCR_TRANS

net_type

No

String

Network type. Values:

• eip: public network.
• vpc: VPC network. The VPC network cannot be selected in DR scenarios.
• vpn: VPN or Direct Connect.

Enumerated values:

• eip
• vpc
• vpn

charging_mode

No

String

Billing mode. The pay-per-use billing is used by default. Values:

• period: indicates the yearly/monthly billing.
• on_demand: indicates the pay-per-use billing.

Enumerated values:

• period
• on_demand

enterprise_project_id

No

String

Enterprise project ID. The default value is 0, indicating the default enterprise project.

Default value: 0

description

No

String

Task description. The task description can contain a maximum of 256 characters and cannot contain the following special characters: !<>'&"\

Minimum length: 0

Maximum length: 256

start_time

No

String

Scheduled start time of a task.

expired_days

No

String

Number of days after which an abnormal task automatically stops. The unit is day. The value ranges from 14 to 100. If this parameter is not specified, the default value is 14.

Default value: 14

tags

No

Array of objects

Tag information. Up to 20 tags can be added.

For details, see Table 7.

is_open_fast_clean

No

Boolean

Specifies whether to enable binlog clearing for RDS for MySQL or RDS for MariaDB. If this parameter is not transferred, the default value false is used, indicating that quick binlog clearing is disabled.

key

No

String

Tag key. The value can contain a maximum of 36 characters, including letters, digits, underscores (_), and hyphens (-).

Minimum length: 1

Maximum length: 36

value

No

String

Tag value. The value can contain a maximum of 43 characters, including letters, digits, underscores (_), and hyphens (-).

Minimum length: 1

Maximum length: 43

db_type

Yes

String

Database type. Values:

• oracle: Oracle.
• gaussdbv5: GaussDB distributed.
• redis: Redis.
• rediscluster: Cluster Redis.
• gaussredis: GeminiDB Redis.

Enumerated values:

• oracle
• gaussdbv5
• redis
• rediscluster
• gaussredis

endpoint_type

Yes

String

DB instance type. Values:

• offline: indicates an on-premises database.
• ecs: indicates a database built on Huawei Cloud ECSs.
• cloud: indicates a Huawei cloud database.

Enumerated values:

• offline
• ecs
• cloud

endpoint_role

Yes

String

DB instance role. Values:

• so: indicates the source database.
• ta: indicates the destination database.

Enumerated values:

• so
• ta

endpoint

Yes

Object

Basic information body of the database.

For details, see Table 9.

cloud

No

Object

Region and project where a DB instance is located.

For details, see Table 10.

vpc

No

Object

Information about the VPC, subnet, and security group where a DB instance resides.

For details, see Table 11.

config

No

Object

Basic information body of database settings.

For details, see Table 12.

ssl

No

Object

Information body of the database SSL certificate.

For details, see Table 13.

customized_dns

No

Object

Custom DNS server.

For details, see Table 14.

id

No

String

Database information ID.

endpoint_name

Yes

String

Database scenario type. Values:

• oracle: indicates the on-premises Oracle database.
• ecs_oracle: indicates the Oracle database built on Huawei Cloud ECSs.
• cloud_gaussdbv5: indicates the Huawei Cloud distributed GaussDB database.
• mysql: indicates the MySQL database built on other clouds or on-premises MySQL database.
• ecs_mysql: indicates the MySQL database built on Huawei Cloud ECSs.
• cloud_mysql: indicates the Huawei Cloud RDS for MySQL database.
• redis: On-premises Redis database.
• ecs_redis: Redis database built on Huawei Cloud ECSs.
• rediscluster: On-premises cluster Redis database.
• ecs_rediscluster: Cluster Redis database built on Huawei Cloud ECSs.
• cloud_gaussdb_redis: Huawei Cloud GeminiDB Redis.

Enumerated values:

• oracle
• ecs_oracle
• cloud_gaussdbv5
• mysql
• ecs_mysql
• cloud_mysql
• redis
• ecs_redis
• rediscluster
• ecs_rediscluster
• cloud_gaussdb_redis

ip

No

String

Database IP address. Note:

• If an on-premises MongoDB database is used, use colons (:) to separate the database IP address and port number, and use commas (,) to separate multiple values. A maximum of three IP addresses or domain names can be entered.
• If a DDS instance is used, use colons (:) to separate the database IP address and port number, and use commas (,) to separate multiple values.
• If the database is a cluster Redis database, enter the IP addresses and port numbers of all shards in the source cluster Redis database. Use colons (:) to separate a database IP address and port number. Use commas (,) to separate multiple values. You are advised to enter the IP address of the slave node of a cluster shard. Up to 32 IP addresses or domain names can be entered. Use commas (,) to separate multiple IP addresses or domain names.

Example:

• MongoDB: 192.168.0.10:8080,192.168.0.11:8080,192.168.0.12:8080
• DDS: 192.168.205.130:8635,192.168.250.64:8635
• Cluster Redis: 192.168.0.1:8080,192.168.0.2:8080

db_port

No

String

Database port.

The value is an integer ranging from 1 to 65535.

db_user

Yes

String

Database username.

db_password

Yes

String

Database password.

instance_id

No

String

ID of a Huawei Cloud DB instance.

instance_name

No

String

Name of a Huawei Cloud DB instance.

db_name

No

String

Database name. Example:

• oracle: serviceName.orcl.

source_sharding

No

Array of objects

Information about the physical source database.

For details, see Table 9.

region

Yes

String

Region ID. This parameter is mandatory when DB Instance Type is set to ecs (database built on Huawei Cloud ECSs) or cloud (Huawei cloud database). For details, see Regions and Endpoints. Note: If there are subprojects in a region, the region ID is a combination of the regional project ID and subproject ID, which are combined using an underscore (_).

project_id

Yes

String

Project ID of a tenant in a region.

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

az_code

No

String

Name of the AZ where the database is located.

vpc_id

Yes

String

ID of the VPC where a DB instance is located. To obtain the ID, perform the following steps: Method 1: Log in to the VPC console and view the VPC ID on the VPC details page. Method 2: Call the API for querying VPCs. For details, see Querying VPCs.

subnet_id

Yes

String

ID of the subnet where a DB instance is located. To obtain the ID, perform the following steps: Method 1: Log in to the VPC console and click the target subnet on the Subnets page to view the network ID on the displayed page. Method 2: Call the API for querying subnets. For details, see Querying Subnets.

security_group_id

No

String

ID of the security group where a DB instance is located. To obtain the ID, perform the following steps: Method 1: Log in to the VPC console. Choose Access Control > Security Groups in the navigation pane on the left. On the displayed page, click the target security group. You can view the security group ID on the displayed page. Method 2: Call the API for querying security groups. For details, see Querying Security Groups.

is_target_readonly

No

Boolean

Whether the destination DB instance is set to read-only. This parameter is available only when job_direction is set to up during MySQL migration and DR. In the DR scenario, this parameter is mandatory and set to true if the current cloud is the standby in single-active DR. If this parameter is not specified, the default value is true.

Default value: true

node_num

No

Integer

Number of subtasks connected to the source cluster Redis instance for data migration from cluster Redis to GeminiDB Redis. The value ranges from 1 to 16 and cannot be greater than the number of shards in the source cluster Redis instance. Set this parameter based on the scale of the source cluster Redis instance. You are advised to set one subtask to connect to four shards in the source cluster Redis instance.

Minimum value: 1

Maximum value: 16

Default value: 0

ssl_link

No

Boolean

Whether SSL is enabled. If SSL is enabled, the value of this parameter is true.

ssl_cert_name

No

String

SSL certificate name.

ssl_cert_key

No

String

SSL certificate content, which is encrypted using Base64.

ssl_cert_check_sum

No

String

The checksum value of the SSL certificate, which is used for backend verification. This parameter is mandatory for secure connection to the source database.

ssl_cert_password

No

String

SSL certificate password. This parameter is mandatory if the certificate file name extension is .p12.

is_set_dns

Yes

Boolean

Specifies whether to set your own DNS server.

set_dns_action

Yes

String

Behavior of setting your own DNS server.

• add: Add a customized DNS server IP address.
• keep: Retain the DNS server IP address.
• update: Update the customized DNS server IP address. (The update takes effect when the DNS server IP address changes.)
• recover: Restore the default DNS server IP address. (Restoration may cause domain name resolution failures. Exercise caution when performing this operation.)

Enumerated values:

• add
• keep
• update
• recover

dns_ip

Yes

String

DNS server IP address.

Minimum length: 0

Maximum length: 15

alarm_to_user

Yes

Boolean

Whether to notify users of alarms.

Default value: false

topic_urn

No

String

SMN topic URN.

delay_time

No

Long

Delay threshold, in seconds. Values:

• Minimum value: 1
• Maximum value: 3600
• Default value: 0

rpo_delay

No

Long

RPO delay threshold, in seconds. Values:

• Minimum value: 1
• Maximum value: 3600
• Default value: 0

rto_delay

No

Long

RTO delay threshold, in seconds. Values:

• Minimum value: 1
• Maximum value: 3600
• Default value: 0

begin

Yes

String

Start time (UTC) of flow control. The start time is an integer in hh:mm format and the minutes part is ignored. hh indicates the hour, for example, 01:00.

end

Yes

String

End time (UTC) in the format of hh:mm, for example, 15:59. The value must end with 59.

speed

Yes

String

Speed. The value ranges from 1 to 9,999, in MB/s.

is_migrate_user

Yes

Boolean

Whether to migrate users.

is_set_password

Yes

Boolean

Whether to reset a unified password. Values:

• true: Reset a unified password.
• false: Do not reset a unified password. The following scenarios are supported:
• Real-time migration: MySQL migration.

password

No

String

Unified password. This parameter is mandatory when is_set_password is set to true. The password cannot be empty.

user_list

No

Array of objects

User list in the migration objects. The following scenarios are supported:

• Real-time migration: MySQL-to-MySQL migration and MongoDB-to-DDS migration.

For details, see Table 18.

role_list

No

Array of objects

User role in the migration objects. The following scenarios are supported:

• Real-time migration: MongoDB-to-DDS migration.

For details, see Table 19.

id

Yes

String

User ID.

account

Yes

String

User.

is_set_password

No

Boolean

Whether to reset the user password. The following scenarios are supported:

• Real-time migration: MySQL migration.

password

No

String

New password. This parameter is mandatory when is_set_password is set to true. The password cannot be empty.

role

Yes

String

Role.

filter_ddl_policy

No

String

DDL filtering policy. Values:

• drop_database

Scenarios:

• Real-time migration: For MySQL migration, this parameter can be set to "", indicating that DROP DATABASE is not filtered.
• Real-time synchronization: For MySQL synchronization, this parameter can only be set to drop_database.

Enumerated values:

• drop_database

conflict_policy

No

String

Incremental conflict policy. The conflict policy refers to the conflict handling policy during incremental synchronization. By default, conflicts in the full synchronization phase are ignored. Values:

• ignore: Ignore the conflict. The system will ignore the conflicting data and continue the subsequent synchronization process.
• stop: Report an error. The synchronization task will be stopped and fail. You can view the details in synchronization logs.
• overwrite: Overwrite the existing data with the synchronized data. Conflicting data will be overwritten.

Scenarios:

• Real-time migration: Not supported.
• Real-time synchronization: Supported.

Enumerated values:

• ignore
• stop
• overwrite

index_trans

No

Boolean

Object synchronization scope: indicates whether to synchronize normal indexes. By default, DRS synchronizes the primary key or unique index. A normal index refers to an index other than the primary key or unique index. Values:

• true: All indexes will be synchronized.
• false: Only primary key or unique indexes are synchronized.

Default value: true

ddl_trans

No

Boolean

Object synchronization scope: indicates whether to synchronize DDLs in the incremental phase. Values:

• true: DDLs are synchronized in the incremental phase.
• false: DDLs are not synchronized in the incremental phase.

Default value: true

data_sync_topology_type

No

String

Data synchronization topology. Data synchronization supports multiple synchronization topologies. You can plan your synchronization instances based on service requirements. Values:

• one2one: one-to-one.
• one2many: one-to-many.
• many2one: many-to-one.

Default value: one2one

Enumerated values:

• one2one
• one2many
• many2one

support_ddl_info

No

String

DDLs to be synchronized. Values:

• CREATE_TABLE: Create a table.
• ADD_COLUMN: Add a column.
• MODIFY_COLUMN: Modify column attribute.
• CHANGE_COLUMN: Change column attribute.
• DROP_INDEX: Delete an index.
• ADD_INDEX: Add an index.
• CREATE_INDEX: Create an index.
• RENAME_INDEX: Rename an index.

Note:

• In one-to-one and one-to-many scenarios, if the DDL usage of the source and destination databases must be consistent, high-risk DDLs must be synchronized.
• In one-to-one and one-to-many scenarios, if you do not want a high-risk DDL to be performed in the destination, deselect the high-risk DDL to protect destination data. However, filtering DDL may cause synchronization to fail, for example, column deletion.
• In many-to-one data synchronization tasks, it is recommended that only the ADD COLUMN operation is synchronized, or tasks may fail or data may be inconsistent due to changes in destination tables. Typical failure scenarios are as follows:
  • Synchronizing the TRUNCATE operation clears all destination data.
  • Synchronizing the CREATE INDEX operation locks the destination table.
  • Synchronizing the RENAME operation causes other task failure because the destination table cannot be found.
  • Synchronizing the MODIFY COLUMN operation causes other task failure due to incompatible data types.

Enumerated values:

• CREATE_TABLE
• ADD_COLUMN
• MODIFY_COLUMN
• CHANGE_COLUMN
• DROP_INDEX
• ADD_INDEX
• CREATE_INDEX
• RENAME_INDEX

sync_type_policy

No

String

Synchronization object type. Values:

• supportAllType: All types.
• tableData: Data.
• tableStructure: Table structure.
• constraintData: Index.

increment_read_mode

No

String

Incremental log reading mode for synchronization from Oracle to GaussDB: logminer or xstream.

dml_types

No

String

DML synchronization type. The value can be:

• i: INSERT
• u: UPDATE
• d: DELETE

object_scope

Yes

String

Migration or synchronization object scope. Values:

• all: Migrate or synchronize all objects.
• database: database-level migration or synchronization.
• table: table-level migration or synchronization.

Enumerated values:

• all
• database
• table

target_root_db

No

Object

Destination database for database object migration or synchronization. This parameter is mandatory for database synchronization from Layer 2 to Layer 3.

For details, see Table 22.

object_info

No

Map<String,DatabaseObject>

Object information for migration or synchronization. If object_scope is set to all, leave this parameter blank. If object_scope is set to database or table, this parameter is mandatory.

For details, see Table 23.

db_name

No

String

Database name.

db_encoding

No

String

Encoding format. The default value is UTF-8.

sync_type

No

String

Type of the database in real-time synchronization. Values:

config: This parameter is mandatory only when the database is used as an association database in advanced settings for data filtering. In this case, the database and its schemas and tables will not be synchronized to the destination database. The name and all parameters do not take effect. Enter the associated objects in schemas and tables.

Enumerated values:

• config

name

No

String

Name of the database in the destination database (database name mapping).

all

No

Boolean

Whether to migrate or synchronize the entire database.

schemas

No

Map<String,SchemaObject>

Schema to be migrated or synchronized. This parameter is mandatory when all is set to false.

For details, see Table 24.

tables

No

Map<String,TableObject>

Table to be migrated or synchronized. This parameter is mandatory when all is set to false.

For details, see Table 25.

total_table_num

No

Integer

Number of tables in the database. If the number of tables exceeds the threshold, this parameter is not displayed.

is_synchronized

No

Boolean

Whether synchronization has been performed.

sync_type

No

String

Type of the schema in real-time synchronization. Values:

config: This parameter is mandatory only when the schema is used as an association schema in advanced settings for data filtering. In this case, the schema and its tables will not be synchronized to the destination database. The name and all parameters do not take effect. Enter the associated objects in tables.

name

No

String

Name of the schema in the destination database (schema name mapping).

all

No

Boolean

Whether to migrate or synchronize the entire schema.

tables

No

Map<String,TableObject>

Table to be migrated or synchronized. This parameter is mandatory when all is set to false.

For details, see Table 25.

sync_type

No

String

Type of the table in real-time synchronization. Values:

config: This parameter is mandatory only when the table is used as an association table in advanced settings for data filtering. In this case, the table and its columns will not be synchronized to the destination database. The name, all, filtered, and filter_conditions parameters do not take effect. Enter the associated objects in columns and the configuration criteria in advanced settings for data filtering in config_conditions.

type

No

String

Object type. Values:

• table: indicates a table.
• view: indicates a view.
• procedure: indicates a stored procedure.

Enumerated values:

• table
• view
• procedure

name

No

String

Name of the table in the destination database (table name mapping).

all

No

Boolean

Whether to migrate or synchronize the entire table.

db_alias_name

No

String

Mapping of database names at the table level in the one-to-many scenario.

schema_alias_name

No

String

Mapping of schema names at the table level in the one-to-many scenario.

filtered

No

Boolean

Whether to filter data in the table.

filter_conditions

No

Array of strings

Filtering criteria for the table data. The processing rule value is a SQL statement. The value contains a maximum of 512 characters.

Minimum length: 0

Maximum length: 512

config_conditions

No

Array of strings

Configuration criteria in advanced settings for data filtering of the table. This parameter is mandatory when the table is used as an association table for query. The processing rule value is a SQL statement. The value contains a maximum of 512 characters.

Minimum length: 0

Maximum length: 512

is_synchronized

No

Boolean

Whether synchronization has been performed.

columns

No

Map<String,ColumnObject>

Columns to be synchronized, mapped, filtered, or added. This parameter is mandatory when column filtering, column mapping, and additional columns are required. This parameter takes effect only in real-time synchronization tasks. This parameter is mandatory when all is set to false.

For details, see Table 26.

sync_type

No

String

Type of the column in real-time synchronization. Values:

config: This parameter is mandatory only when the column is used as an association column in advanced settings for data filtering. If the column is a primary key column or index column required for optimizing the query, primary_key_for_data_filtering or index_for_data_filtering is mandatory.

primary_key_for_data_filtering

No

String

Whether the column is a primary key column in advanced settings for data filtering. If the column is a primary key column, set this parameter to the column name. Otherwise, leave this parameter blank.

index_for_data_filtering

No

String

Whether the column is an index column required for optimizing the query. The index is added to the cached data. It does not affect the source table. If the column is an index column in advanced settings for data filtering, this parameter is mandatory. Otherwise, leave this parameter blank.

name

No

String

Name of the column in the destination database (column name mapping). If the column is an additional column, the value must be the same as the column name in the table-level object.

type

No

String

Data type of the column. Column filtering: Enter the data type of the source column. Additional column adding: Enter the data type of the new column. The values and constraints vary depending on the operation type. Values:

• Default: The value can be int, long, varchar(256), datetime, or timestamp.
• create_time: The value can be long, datetime, or timestamp.
• update_time: The value can be long, datetime, or timestamp.
• Expression: The value can be varchar (256), and the column value must be concat(__current_database, '@', __current_table).
• serverName@database@table: The value can be varchar(256).

primary_key_for_column_filtering

No

String

Whether the column is a primary key column in column mapping. If the column is a primary key column, set this parameter to PRI. Otherwise, leave this parameter blank.

filtered

No

Boolean

Whether the column is filtered out. This parameter cannot be used together with the additional parameter. Values:

• true: indicates that the column will be synchronized.
• false: indicates that the column is filtered out and will not be synchronized.

additional

No

Boolean

Whether the column is an additional column. If the column is an additional column, the value of name must be the same as the column name in the table-level object and cannot be used together with the filtered parameter.

operation_type

No

String

Operation type. The new column is filled with a specific operation type. Values:

• Default: "operation_type":"ADDITIONALCOLUMN,default_value"
• create_time: "operation_type":"ADDITIONALCOLUMN,create_time"
• update_time: "operation_type":"ADDITIONALCOLUMN,update_time"
• Expression: "operation_type":"ADDITIONALCOLUMN,expression"
• serverName@database@table: "operation_type":"ADDITIONALCOLUMN,server_database_table"

value

No

String

Value of the additional column. Note:

• This parameter is mandatory only when operation type is set to Default or serverName@database@table.
• When operation type is set to Expression, this parameter has a fixed value of concat(__current_database, '@', __current_table).

common

No

Array of objects

Common parameter. Only the values of destination database parameters whose comparison results are inconsistent can be changed.

For details, see Table 28.

performance

No

Array of objects

Performance parameter. If the comparison results are consistent, you can also change the values of destination database parameters.

For details, see Table 28.

key

Yes

String

Database parameter name.

target_value

Yes

String

Parameter value of the destination database.

full_sync

No

Map<String,String>

Names and values of full migration parameters.

incre_capture

Yes

Map<String,String>

Names and values of incremental capture parameters.

incre_apply

Yes

Map<String,String>

Names and values of incremental replay parameters.

incre_relay

No

Map<String,String>

Names and values of incremental log extraction parameters.

recovery

No

Boolean

Whether to restore to the default value.

period_type

Yes

Integer

Subscription period type. Values:

• 2: indicates that the service is subscribed by month.
• 3: indicates that the service is subscribed by year.

Default value: 3

Enumerated values:

• 2
• 3

period_num

Yes

Integer

Number of subscription periods. This parameter depends on the value of period_type. For example:

• When period_type is set to 2, the value 1 indicates one month.
• When period_type is set to 3, the value 1 indicates one year.

is_auto_renew

No

Integer

Whether auto renewal is enabled. Values:

• 0: indicates that auto renewal is disabled. This is the default value. You need to pay manually.
• 1: indicates that auto renewal is enabled.

Default value: 0

Enumerated values:

• 0
• 1

spec

Yes

Object

Information body of DRS instance specifications.

For details, see Table 32.

vpc

No

Object

Information body of DRS instance VPC. This parameter is mandatory for self-built databases.

For details, see Table 33.

base_info

No

Object

Information body of DRS instance VPC. This parameter is mandatory for self-built databases.

For details, see Table 34.

node_type

Yes

String

Specification code. Values:

• micro: minimum specifications.
• small: small specifications.
• medium: medium specifications.
• high: large specifications.

Enumerated values:

• micro
• small
• medium
• high

vpc_id

Yes

String

ID of the VPC where the DRS instance is located.

subnet_id

Yes

String

ID of the subnet where the DRS instance is located.

custom_node_ip

No

String

IP address of the DRS instance to be created. Use commas (,) to separate multiple values. Only IPv4 addresses are supported. To obtain the IP address, perform the following steps:

• Method 1: Log in to the VPC console and click the target subnet on the Subnets page. View the subnet CIDR block and select an IP address that is not in use.
• Method 2: Call the API for querying private IP addresses. For details, see Querying Private IP Addresses. Select a private IP address whose device_owner is left blank. Example: 192.168.0.10,192.168.0.11

security_group_id

No

String

ID of the security group where the DRS instance is located.

instance_type

Yes

String

DB instance type. The value can be:

• single: single instance.
• ha: primary/standby instance.

Enumerated values:

• single
• ha

arch

Yes

String

CPU architecture. The value can be:

• x86
• arm

Enumerated values:

• x86
• arm

availability_zone

Yes

String

AZ ID. If the task instance is not a single instance, you need to specify an AZ for each node of the instance and separate the AZs with commas (,). Example:

• If instance_type is set to single, the value is cn-north-4a.
• If instance_type is set to ha, the value is cn-north-4a,cn-north-4b.

status

No

String

Status.

role

No

String

Primary/Standby role of a task.

error_code

String

Error code.

Minimum length: 12

Maximum length: 12

error_msg

String

Error message.

Minimum length: 1

Maximum length: 512

id

String

Task ID.

name

String

Task name.

status

String

Operation result.

error_code

String

Error code.

Minimum length: 12

Maximum length: 12

error_msg

String

Error message.

Minimum length: 1

Maximum length: 512

200

OK

400

Bad Request