# Alibaba Cloud Data Transmission API > Alibaba Cloud Data Transmission API on Apizie: 125 endpoints (Configures a data migration or synchronization task, Configures a legacy data migration task, Configures monitoring alerts for the latency and abnormal status of a migration task, Configures a DTS change tracking task, …) returned as clean JSON through one API key. Send your own provider key in the x-upstream-key header. Call it over REST at https://apizie.tech/v1/cloud:aliyun-dts/{endpoint} or from Claude, ChatGPT and Cursor through the Apizie MCP server. Free plan: 1,000 requests a month. - Project key: `cloud:aliyun-dts` - Category: Cloud - Status: byok - Source: https://api.alibabacloud.com/product/dts - Page: https://apizie.tech/api/cloud/aliyun-dts - OpenAPI: https://apizie.tech/api/cloud/aliyun-dts/openapi.json Alibaba Cloud OpenAPI for Data Transmission (dts, version 2020-01-01). Calls are signed with ACS3-HMAC-SHA256 using your AccessKey ID and secret. ## Endpoints ### Configures a data migration or synchronization task `POST https://apizie.tech/v1/cloud:aliyun-dts/configure-dts-job` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://dts.ap-southeast-1.aliyuncs.com | | DtsJobName | string | yes | The name of the DTS instance | | SourceEndpointInstanceType | string | yes | The type of the source instance. Valid values: Alibaba Cloud databases RDS: ApsaraDB RDS for MySQL, ApsaraDB RDS for SQL Server, ApsaraDB… | | SourceEndpointInstanceID | string | no | The instance ID of the source instance. If the source instance is an ApsaraDB database such as ApsaraDB RDS for MySQL, you must specify… | | SourceEndpointEngineName | string | no | The database type of the source instance. Valid values: MYSQL: MySQL database, including ApsaraDB RDS for MySQL and self-managed MySQL.… | | SourceEndpointRegion | string | no | The area of the source instance. For details, see https://help.aliyun.com/document_detail/141033.html. This parameter is required if the… | | SourceEndpointIP | string | no | The IP address of the source instance. This parameter is available and required only when SourceEndpointInstanceType is set to OTHER,… | | SourceEndpointPort | string | no | The database service port of the source instance. This parameter is available and required only when the source instance is a self-managed… | | SourceEndpointOracleSID | string | no | The system ID (SID) of the Oracle database. This parameter is available and required only when SourceEndpointEngineName is set to Oracle… | | SourceEndpointDatabaseName | string | no | The name of the database to which the migration objects belong in the source instance. This parameter is available and required only when… | | SourceEndpointUserName | string | no | The database account of the source database. In most cases, you must specify the database account of the source database. The permissions… | | SourceEndpointPassword | string | no | The password of the database account of the source database | | SourceEndpointOwnerID | string | no | The Alibaba Cloud account ID to which the source instance belongs. Specifying this parameter indicates that you execute cross-Alibaba… | | SourceEndpointRole | string | no | The name of the role configured for the Alibaba Cloud account to which the source instance belongs. This parameter is required when you… | | DestinationEndpointInstanceType | string | yes | The target instance type. Valid values: Alibaba Cloud databases RDS: ApsaraDB RDS for MySQL, ApsaraDB RDS for SQL Server, ApsaraDB RDS for… | | DestinationEndpointInstanceID | string | no | The instance ID of the destination instance. If the destination instance is an ApsaraDB database such as ApsaraDB RDS for MySQL, you must… | | DestinationEndpointEngineName | string | no | The database type of the destination instance. Valid values: MYSQL: MySQL database, including ApsaraDB RDS for MySQL and self-managed… | | DestinationEndpointRegion | string | no | The area of the destination instance. For details, see https://help.aliyun.com/document_detail/141033.html. This parameter is required if… | | DestinationEndpointIP | string | no | The IP address of the destination instance. This parameter is available and required only when DestinationEndpointInstanceType is set to… | | DestinationEndpointPort | string | no | The database service port of the destination instance. This parameter is available and required only when the destination instance is a… | | DestinationEndpointDataBaseName | string | no | The name of the database to which the migration objects belong in the destination instance. This parameter is available and required only… | | DestinationEndpointUserName | string | no | The database account of the destination database. In most cases, you must specify the database account of the destination database. The… | | DestinationEndpointPassword | string | no | The password of the database account of the destination database. If the destination database is MaxCompute, you must specify the… | | DestinationEndpointOwnerID | string | no | The Alibaba Cloud account ID to which the destination ApsaraDB RDS for MySQL instance belongs. This parameter can be configured only when… | | DestinationEndpointRole | string | no | The name of the role configured for the Alibaba Cloud account to which the destination instance belongs. This parameter is required when… | | StructureInitialization | string | yes | Specifies whether to perform schema migration or initial schema synchronization. Valid values: true: Yes. This is the default value.… | | DataInitialization | string | yes | Specifies whether to perform full data migration or initial full data synchronization. Valid values: true: Yes. This is the default value.… | | DataSynchronization | string | yes | Specifies whether to perform incremental data migration or synchronization. Valid values: false: No. This is the default value. true: Yes.… | | DbList | string | no | The objects to be migrated or synchronized, in JSON format. For more information, see https://help.aliyun.com/document_detail/209545.html.… | | Reserve | string | no | The reserved parameter of DTS, in JSON character string format. You can specify this parameter to supplement the information about the… | | Checkpoint | string | no | The start offset for incremental data migration or the synchronization checkpoint, in UNIX timestamp format. Unit: seconds. If you specify… | | DestinationEndpointOracleSID | string | no | The SID of the Oracle database. This parameter is available and required only when DestinationEndpointEngineName is set to Oracle and the… | | JobType | string | yes | The node type. Valid values: MIGRATION: data migration. SYNC: data synchronization. CHECK: data validation (purchased separately). If the… | | DtsJobId | string | no | The ID of the data migration or synchronization task. You can call the https://help.aliyun.com/document_detail/209702.html operation to… | | DtsInstanceId | string | no | The ID of the data migration or synchronization instance. You can call the https://help.aliyun.com/document_detail/209702.html operation… | | DelayPhone | string | no | The mobile phone numbers of the contacts to receive latency alerts. Separate multiple mobile phone numbers with commas (,). This parameter… | | DelayRuleTime | integer | no | The threshold for triggering latency alerts. Unit: seconds. The value must be an integer. You can set the threshold based on your business… | | DelayNotice | string | no | Specifies whether to monitor the latency status. Valid values: true: Yes. false: No | | ErrorPhone | string | no | The mobile phone numbers of the contacts to receive exception alerts. Separate multiple mobile phone numbers with commas (,). This… | | ErrorNotice | string | no | Specifies whether to monitor the exception status. Valid values: true: Yes. false: No | | SynchronizationDirection | string | no | The synchronization direction. Valid values: Forward: Forward. Reverse: Reverse. Default value: Forward. This parameter takes effect only… | | RegionId | string | no | The region of the DTS instance. For more information, see https://help.aliyun.com/document_detail/141033.html | | DedicatedClusterId | string | no | The ID of the dedicated DTS cluster. When the ID of a dedicated cluster is specified, the task is scheduled to the corresponding cluster | | FileOssUrl | string | no | The OSS URL of the task file | | DataCheckConfigure | string | no | The parameters for the data validation task, in JSON character string format, such as parameter limits and alert configuration. For more… | | DisasterRecoveryJob | string | no | Specifies whether the instance is a disaster recovery instance. Valid values: true: Yes. false: No | | SourceEndpointVSwitchID | string | no | The instance ID of the vSwitch for the data delivery link | | DtsBisLabel | string | no | The environment tag of the DTS instance. Valid values: normal: Normal. online: Online | | SrcCaCertificateOssUrl | string | no | The path of the CA certificate when the source database is connected over SSL. This feature is not supported. Do not specify this parameter | | SrcCaCertificatePassword | string | no | The password of the CA certificate when the source database is connected over SSL. This feature is not supported. Do not specify this… | | DestCaCertificateOssUrl | string | no | The path of the CA certificate when the destination database is connected over SSL. This feature is not supported. Do not specify this… | | DestCaCertificatePassword | string | no | The password of the CA certificate when the destination database is connected over SSL. This feature is not supported. Do not specify this… | | MinDu | number | no | The minimum number of DUs. This parameter is supported only for serverless instances | | MaxDu | number | no | The maximum number of DUs. This parameter is supported only for serverless instances | | SrcClientCertOssUrl | string | no | The path of the client certificate when the source database is connected over SSL. This feature is not supported. Do not specify this… | | SrcClientKeyOssUrl | string | no | The path of the client certificate private key when the source database is connected over SSL. This feature is not supported. Do not… | | SrcClientPassword | string | no | The password of the client certificate private key when the source database is connected over SSL. This feature is not supported. Do not… | | DestClientCertOssUrl | string | no | The path of the client certificate when the destination database is connected over SSL. This feature is not supported. Do not specify this… | | DestClientKeyOssUrl | string | no | The path of the client certificate private key when the destination database is connected over SSL. This feature is not supported. Do not… | | DestClientPassword | string | no | The password of the client certificate private key when the destination database is connected over SSL. This feature is not supported. Do… | | SrcPrimaryVswId | string | no | The primary vSwitch at the source end of the VPC NAT gateway | | SrcSecondaryVswId | string | no | The secondary vSwitch at the source end of the VPC NAT gateway | | DestPrimaryVswId | string | no | The primary vSwitch at the destination end of the VPC NAT gateway | | DestSecondaryVswId | string | no | The secondary vSwitch at the destination end of the VPC NAT gateway | | ResourceGroupId | string | no | The ID of the resource group | ### Configures a legacy data migration task `POST https://apizie.tech/v1/cloud:aliyun-dts/configure-migration-job` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://dts.ap-southeast-1.aliyuncs.com | | RegionId | string | no | The ID of the region where the data migration instance resides. For more information, see… | | MigrationJobId | string | yes | The ID of the data migration instance. You can call the DescribeMigrationJobs operation to query the instance ID | | MigrationJobName | string | yes | The name of the migration task. The name can be up to 32 characters in length. Specify a descriptive name for easy identification. The… | | SourceEndpoint.InstanceType | string | yes | The instance type of the source database. Valid values: RDS: ApsaraDB RDS instance. ECS: Self-managed database hosted on Elastic Compute… | | SourceEndpoint.InstanceID | string | no | The ID of the source instance. This parameter is available and required only when SourceEndpoint.InstanceType is set to RDS, ECS, Express,… | | SourceEndpoint.EngineName | string | no | The database engine of the source database. Valid values: MySQL, TiDB, SQLServer, PostgreSQL, Oracle, MongoDB, Redis, POLARDB, and… | | SourceEndpoint.Region | string | no | The ID of the region where the source database resides. When SourceEndpoint.InstanceType is set to LocalInstance, you can specify… | | SourceEndpoint.IP | string | no | The endpoint of the source database. This parameter is available and required only when SourceEndpoint.InstanceType is set to… | | SourceEndpoint.Port | string | no | The service port number of the source database. This parameter is available and required only when SourceEndpoint.InstanceType is set to… | | SourceEndpoint.OracleSID | string | no | The system ID (SID) of the Oracle database. This parameter is available and required only when SourceEndpoint.EngineName is set to Oracle… | | SourceEndpoint.DatabaseName | string | no | The name of the database to be migrated or the authentication database. This parameter is available and required only when… | | SourceEndpoint.UserName | string | no | The database account of the source database. Note: The required permissions vary based on the database engine. For more information, see… | | SourceEndpoint.Password | string | no | The password of the source database account | | SourceEndpoint.OwnerID | string | no | The Alibaba Cloud account ID to which the source instance belongs. This parameter is active and required only when you configure a… | | SourceEndpoint.Role | string | no | The RAM role that is authorized to the destination Alibaba Cloud account to access the source instance. This parameter is required when… | | DestinationEndpoint.InstanceType | string | yes | The instance type of the destination database. Valid values: ECS: Self-managed database hosted on ECS. LocalInstance: Self-managed… | | DestinationEndpoint.InstanceID | string | no | The ID of the destination instance. This parameter is available and required only when DestinationEndpoint.InstanceType is set to RDS,… | | DestinationEndpoint.EngineName | string | no | The database engine of the destination database. Valid values: MySQL, DRDS, SQLServer, PostgreSQL, PPAS, MongoDB, Redis, POLARDB, and… | | DestinationEndpoint.Region | string | no | The ID of the region where the destination database resides. When DestinationEndpoint.InstanceType is set to LocalInstance, you can… | | DestinationEndpoint.IP | string | no | The endpoint of the destination database. This parameter is available and required only when DestinationEndpoint.InstanceType is set to… | | DestinationEndpoint.Port | string | no | The service port number of the destination database. This parameter is available and required only when DestinationEndpoint.InstanceType… | | DestinationEndpoint.DataBaseName | string | no | The name of the destination database or the authentication database. This parameter is available and required only when… | | DestinationEndpoint.UserName | string | no | The database account of the destination database. Note: The required permissions vary based on the database engine. For more information,… | | DestinationEndpoint.Password | string | no | The password of the destination database account | | MigrationMode.StructureIntialization | string | yes | Specifies whether to perform schema migration. Valid values: true: Yes. false: No. The support for schema migration varies based on the… | | MigrationMode.DataIntialization | string | yes | Specifies whether to perform full data migration. Valid values: true: Yes. false: No. The support for full data migration varies based on… | | MigrationMode.DataSynchronization | string | yes | Specifies whether to perform incremental data migration. Valid values: true: Yes. false: No. The support for incremental data migration… | | MigrationObject | string | yes | The objects to be migrated. The value is a JSON string and supports specific regular expressions. For more information, see [Configure… | | MigrationReserved | string | no | The reserved parameters of DTS. The value is a JSON string. You can specify this parameter to meet specific requirements, such as… | | Checkpoint | string | no | The start checkpoint for incremental data migration. The value is a UNIX timestamp in seconds | | AccountId | string | no | The ID of the Alibaba Cloud account. You do not need to specify this parameter. This parameter is pending deprecation | | DestinationEndpoint.OracleSID | string | no | The SID of the Oracle database. This parameter is available and required only when DestinationEndpoint.EngineName is set to Oracle and the… | | ResourceGroupId | string | no | The ID of the resource group | ### Configures monitoring alerts for the latency and abnormal status of a migration task `POST https://apizie.tech/v1/cloud:aliyun-dts/configure-migration-job-alert` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://dts.ap-southeast-1.aliyuncs.com | | RegionId | string | no | The ID of the region where the data migration instance resides. For more information, see the list of supported regions | | MigrationJobId | string | yes | Instance ID of the data migration instance. You can call the DescribeMigrationJobs operation to query instance ID | | DelayAlertStatus | string | no | Specifies whether to monitor the latency status. Valid values: enable: Yes. disable: No. Default value: enable. You must specify at least… | | DelayAlertPhone | string | no | The mobile phone numbers of the contacts to receive latency alerts. Separate multiple mobile phone numbers with commas (,). This parameter… | | ErrorAlertStatus | string | no | Specifies whether to monitor the abnormal status. Valid values: enable: Yes. disable: No. Default value: enable. You must specify at least… | | ErrorAlertPhone | string | no | The mobile phone numbers of the contacts to receive abnormal status alerts. Separate multiple mobile phone numbers with commas (,). This… | | DelayOverSeconds | string | no | The threshold for triggering a latency alert. The value must be an integer in seconds. You can set the threshold based on your business… | | AccountId | string | no | The ID of the Alibaba Cloud account. You do not need to specify this parameter. This parameter is about to be deprecated | | ResourceGroupId | string | no | The ID of the resource group | ### Configures a DTS change tracking task `POST https://apizie.tech/v1/cloud:aliyun-dts/configure-subscription` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://dts.ap-southeast-1.aliyuncs.com | | RegionId | string | yes | The region where the change tracking instance resides. For more information, see https://help.aliyun.com/document_detail/141033.html | | DtsJobName | string | yes | The name of the change tracking task. Specify a name that reflects the business purpose to facilitate subsequent identification. The name… | | DtsInstanceId | string | no | The ID of the change tracking instance. You can call the https://help.aliyun.com/document_detail/209702.html operation to query the… | | DtsJobId | string | no | The ID of the change tracking task. You can call the https://help.aliyun.com/document_detail/209702.html operation to query the task ID | | SourceEndpointEngineName | string | no | The type of the source database. Valid values: MySQL, PostgreSQL, and Oracle. If the source database is a self-managed database, this… | | SourceEndpointInstanceType | string | no | The instance type of the source database. Valid values: RDS: ApsaraDB RDS. PolarDB: PolarDB for MySQL. DRDS: PolarDB-X 1.0. LocalInstance:… | | SourceEndpointRegion | string | no | The region where the source instance resides. For more information, see https://help.aliyun.com/document_detail/141033.html. If the source… | | SourceEndpointInstanceID | string | no | The source instance ID. This parameter is active and required only when the instance type of the source database is ApsaraDB RDS for… | | SourceEndpointIP | string | no | The endpoint of the source database. This parameter is available and required only when the source database is a self-managed database | | SourceEndpointPort | string | no | The service port number of the source database. This parameter is available and required only when the source database is a self-managed… | | SourceEndpointOracleSID | string | no | The system ID (SID) of the Oracle database. This parameter is available and required only when the source database is a self-managed… | | SourceEndpointDatabaseName | string | no | The name of the database to be tracked | | SourceEndpointUserName | string | no | The database account of the source instance. The required permissions vary based on the database to be tracked. For more information, see… | | SourceEndpointPassword | string | no | The password of the database account of the source instance | | SourceEndpointOwnerID | string | no | The Alibaba Cloud account ID to which the source instance belongs. This parameter is available and required only when you configure a… | | SourceEndpointRole | string | no | The RAM role that is authorized to access the source instance. If the source instance and the change tracking task belong to different… | | DbList | string | yes | The objects to be tracked. The value is a JSON string. For more information, see https://help.aliyun.com/document_detail/209545.html | | Reserve | string | no | The reserved parameters of DTS. The value is a JSON string. You can specify this parameter to supplement the information about the source… | | Checkpoint | string | no | The start time of the change tracking task. The value is a UNIX timestamp in seconds. You can use a search engine to obtain a UNIX… | | SubscriptionInstanceNetworkType | string | yes | The network type of the change tracking task. Set the value to vpc, which specifies a virtual private cloud (VPC). If you specify this… | | SubscriptionInstanceVPCId | string | no | The VPC ID of the change tracking instance. This parameter is available and required only when SubscriptionInstanceNetworkType is set to vpc | | SubscriptionInstanceVSwitchId | string | no | The vSwitch ID of the change tracking instance. This parameter is available and required only when SubscriptionInstanceNetworkType is set… | | SubscriptionDataTypeDDL | string | no | Specifies whether to track DDL statements. Valid values: true: Yes. This is the default value. false: No | | SubscriptionDataTypeDML | string | no | Specifies whether to track DML statements. Valid values: true: Yes. This is the default value. false: No | | DelayPhone | string | no | The mobile phone numbers of the contacts to receive latency alerts. Separate multiple mobile phone numbers with commas (,). This parameter… | | DelayRuleTime | integer | no | The threshold for triggering a latency alert. The value must be an integer in seconds. You can set the threshold based on your business… | | DelayNotice | string | no | Specifies whether to monitor the latency status. Valid values: true: Yes. false: No | | ErrorPhone | string | no | The mobile phone numbers of the contacts to receive exception alerts. Separate multiple mobile phone numbers with commas (,). This… | | ErrorNotice | string | no | Specifies whether to monitor the exception status. Valid values: true: Yes. false: No | | DedicatedClusterId | string | no | The ID of the dedicated DTS cluster. This parameter is used to schedule the change tracking task to a specified dedicated DTS cluster | | DtsBisLabel | string | no | The environment tag of the DTS instance. Valid values: normal: Normal. online: Online | | MinDu | number | no | The minimum number of DUs for the serverless instance. Valid values: 1, 2, 4, 8, and 16. This feature is not supported. Do not specify… | | MaxDu | number | no | The maximum number of DUs for the serverless instance. Valid values: 2, 4, 8, and 16. This feature is not supported. Do not specify this… | | SrcCaCertificateOssUrl | string | no | The path of the CA certificate when the source database is connected over SSL. This feature is not supported. Do not specify this parameter | | SrcCaCertificatePassword | string | no | The password of the CA certificate when the source database is connected over SSL. This feature is not supported. Do not specify this… | | SrcClientCertOssUrl | string | no | The path of the client certificate when the source database is connected over SSL. This feature is not supported. Do not specify this… | | SrcClientKeyOssUrl | string | no | The path of the private key of the client certificate when the source database is connected over SSL. This feature is not supported. Do… | | SrcClientPassword | string | no | The password of the private key of the client certificate when the source database is connected over SSL. This feature is not supported.… | | ResourceGroupId | string | no | The ID of the resource group | ### Configures a legacy change tracking channel `POST https://apizie.tech/v1/cloud:aliyun-dts/configure-subscription-instance` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://dts.ap-southeast-1.aliyuncs.com | | RegionId | string | no | The ID of the region where the change tracking instance resides. For more information, see… | | SubscriptionInstanceId | string | yes | The ID of the change tracking instance. You can call the https://help.aliyun.com/document_detail/49442.html operation to query the… | | SubscriptionInstanceName | string | no | The name of the change tracking instance. Specify a descriptive name for easy identification. The name does not need to be unique | | SourceEndpoint.InstanceType | string | no | The instance type of the source database. Valid values: RDS: ApsaraDB RDS for MySQL. PolarDB: PolarDB for MySQL. LocalInstance: a… | | SourceEndpoint.InstanceID | string | no | The instance ID of the source instance. This parameter is available and required only when the source database is an ApsaraDB RDS for… | | SubscriptionDataType.DDL | string | yes | Specifies whether to track data definition language (DDL) operations. Valid values: true: yes. This is the default value. false: no | | SubscriptionDataType.DML | string | yes | Specifies whether to track data manipulation language (DML) operations. Valid values: true: yes. This is the default value. false: no | | SubscriptionObject | string | yes | The objects to be tracked. The value is a JSON string and supports specific regular expressions. For more information, see… | | SourceEndpoint.IP | string | no | The endpoint of the source database. This parameter is available and required only when the source database is a self-managed database | | SourceEndpoint.Port | string | no | The service port number of the source database. This parameter is available and required only when the source database is a self-managed… | | SourceEndpoint.UserName | string | no | The database account of the source instance. The required permissions vary based on the database to be tracked. For more information, see… | | SourceEndpoint.Password | string | no | The password of the database account of the source instance | | SourceEndpoint.OracleSID | string | no | The system ID (SID) of the Oracle database. This parameter is available and required only when the source database is a self-managed… | | SourceEndpoint.DatabaseName | string | no | The name of the database to be tracked | | SourceEndpoint.OwnerID | string | no | The Alibaba Cloud account ID of the source instance. This parameter is available and required only when you configure change tracking… | | SourceEndpoint.Role | string | no | The RAM role that is authorized to access the source instance. If the source instance and the change tracking task belong to different… | | SubscriptionInstanceNetworkType | string | no | The network type of the change tracking instance. Set the value to vpc, which specifies a virtual private cloud (VPC). If you specify this… | | SubscriptionInstance.VPCId | string | no | The VPC ID of the change tracking instance. This parameter is available and required only when SubscriptionInstanceNetworkType is set to vpc | | SubscriptionInstance.VSwitchId | string | no | The vSwitch ID of the change tracking instance. This parameter is available and required only when SubscriptionInstanceNetworkType is set… | | AccountId | string | no | The ID of the Alibaba Cloud account. You do not need to specify this parameter because it will be deprecated soon | | ResourceGroupId | string | no | The ID of the resource group | ### Configures monitoring alerts to monitor the latency and abnormal status of a change tracking channel `POST https://apizie.tech/v1/cloud:aliyun-dts/configure-subscription-instance-alert` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://dts.ap-southeast-1.aliyuncs.com | | RegionId | string | no | The region ID of the change tracking instance. For more information, see https://help.aliyun.com/document_detail/141033.html | | SubscriptionInstanceId | string | yes | The ID of the change tracking instance. You can call the DescribeSubscriptionInstances operation to query the instance ID | | DelayAlertStatus | string | no | Specifies whether to monitor the latency status. Valid values: enable: Yes. disable: No. Default value: enable. You must specify at least… | | DelayAlertPhone | string | no | The mobile phone numbers of the contacts to receive latency alerts. Separate multiple mobile phone numbers with commas (,). This parameter… | | ErrorAlertStatus | string | no | Specifies whether to monitor the abnormal status. Valid values: enable: Yes. disable: No. Default value: enable. You must specify at least… | | ErrorAlertPhone | string | no | The mobile phone numbers of the contacts to receive abnormal status alerts. Separate multiple mobile phone numbers with commas (,). This… | | DelayOverSeconds | string | no | The threshold for triggering a latency alert. Unit: seconds. The value must be an integer. You can set the threshold based on your… | | AccountId | string | no | The ID of the Alibaba Cloud account. You do not need to specify this parameter. This parameter will be deprecated | | ResourceGroupId | string | no | The ID of the resource group | ### Configures a legacy data synchronization task `POST https://apizie.tech/v1/cloud:aliyun-dts/configure-synchronization-job` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://dts.ap-southeast-1.aliyuncs.com | | RegionId | string | no | The ID of the region where the data synchronization instance resides. For more information, see… | | SynchronizationJobName | string | no | The name of the synchronization task. Specify a descriptive name that is easy to identify. The name does not need to be unique | | SynchronizationJobId | string | yes | The ID of the data synchronization instance. You can call the https://help.aliyun.com/document_detail/49454.html operation to query the… | | SynchronizationDirection | string | no | The synchronization direction. Valid values: Forward: Forward synchronization. Reverse: Reverse synchronization. Default value: Forward.… | | SourceEndpoint.InstanceId | string | no | The instance ID of the source instance | | SourceEndpoint.InstanceType | string | no | The type of the source instance. Valid values: RDS: ApsaraDB RDS instance. Redis: Alibaba Cloud Redis instance. PolarDB: PolarDB cluster… | | SourceEndpoint.IP | string | no | The IP address of the source database. This parameter is available and required only when the SourceEndpoint.InstanceType parameter is set… | | SourceEndpoint.Port | string | no | The service port number of the source database. This parameter is available and required only when the SourceEndpoint.InstanceType… | | SourceEndpoint.UserName | string | no | The database account of the source database. This parameter is available and required only when the SourceEndpoint.InstanceType parameter… | | SourceEndpoint.Password | string | no | The password of the database account for the source database. This parameter is required only when the SourceEndpoint.InstanceType… | | DestinationEndpoint.InstanceId | string | no | The instance ID of the destination instance for synchronization. When the DestinationEndpoint.InstanceType parameter is set to MaxCompute… | | DestinationEndpoint.InstanceType | string | no | The destination instance type. Valid values: Redis: Alibaba Cloud Redis instance. RDS: ApsaraDB RDS instance. PolarDB: PolarDB cluster… | | DestinationEndpoint.IP | string | no | The IP address of the destination database. This parameter is available and required only when the DestinationEndpoint.InstanceType… | | DestinationEndpoint.Port | string | no | The service port number of the destination database. This parameter is available and required only when the… | | DestinationEndpoint.UserName | string | no | The database account of the destination database. The permissions required for synchronizing different databases vary. For more… | | DestinationEndpoint.Password | string | no | The password of the database account for the destination database. This parameter is required when the DestinationEndpoint.InstanceType… | | StructureInitialization | string | yes | Specifies whether to perform initial schema synchronization. Valid values: true: Yes. false: No. Default value: true | | DataInitialization | string | yes | Specifies whether to perform initial full data synchronization. Valid values: true: Yes. false: No. Default value: true | | SynchronizationObjects | string | yes | The objects to be synchronized. The value is a JSON string and supports specific regular expressions. For more information, see… | | SourceEndpoint.OwnerID | string | no | The Alibaba Cloud account ID to which the source ApsaraDB RDS instance belongs. Specifying this parameter indicates that cross-Alibaba… | | SourceEndpoint.Role | string | no | The name of the RAM role configured for the Alibaba Cloud account to which the source instance belongs. This parameter is required for… | | PartitionKey.ModifyTime_Year | string | no | Specifies whether the incremental log table contains partitions defined by the year of the incremental update time. Valid values: true and… | | PartitionKey.ModifyTime_Month | string | no | Specifies whether the incremental log table contains partitions defined by the month of the incremental update time. Valid values: true… | | PartitionKey.ModifyTime_Day | string | no | Specifies whether the incremental log table contains partitions defined by the day of the incremental update time. Valid values: true and… | | PartitionKey.ModifyTime_Hour | string | no | Specifies whether the incremental log table contains partitions defined by the hour of the incremental update time. Valid values: true and… | | PartitionKey.ModifyTime_Minute | string | no | Specifies whether the incremental log table contains partitions defined by the minute of the incremental update time. Valid values: true… | | MigrationReserved | string | no | The reserved parameter for DTS. The value is a JSON string. You can specify this parameter to meet specific requirements, such as whether… | | Checkpoint | string | no | The synchronization checkpoint | | AccountId | string | no | The ID of the Alibaba Cloud account. You do not need to specify this parameter. This parameter will be deprecated soon | | SourceEndpoint.DatabaseName | string | no | The name of the database to which the synchronization objects in the source instance belong | | DestinationEndpoint.DataBaseName | string | no | The name of the database to which the synchronization objects in the destination instance belong | | ResourceGroupId | string | no | The ID of the resource group | ### Configures monitoring and alerting to monitor the latency and exception status of a synchronization task `POST https://apizie.tech/v1/cloud:aliyun-dts/configure-synchronization-job-alert` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://dts.ap-southeast-1.aliyuncs.com | | RegionId | string | no | The region ID. Specify this parameter to indicate the region where the instance resides. For more information, see… | | SynchronizationJobId | string | yes | Instance ID of the data synchronization instance. You can call the DescribeSynchronizationJobs operation to query instance ID | | SynchronizationDirection | string | no | The synchronization direction. Valid values: Forward: forward. Reverse: reverse. Default value: Forward | | DelayAlertStatus | string | no | Specifies whether to monitor the latency status. Valid values: enable: yes. disable: no. Default value: enable. You must specify at least… | | DelayAlertPhone | string | no | The mobile phone numbers of contacts for latency alerts. Separate multiple phone numbers with commas (,). Note This parameter is supported… | | ErrorAlertStatus | string | no | Specifies whether to monitor the exception status. Valid values: enable: yes. disable: no. Default value: enable. You must specify at… | | ErrorAlertPhone | string | no | The mobile phone numbers of contacts for exception alerts. Separate multiple phone numbers with commas (,). Note This parameter is… | | DelayOverSeconds | string | no | The threshold for triggering a latency alert. Unit: seconds. The value must be an integer. Set the threshold based on your business… | | AccountId | string | no | The ID of the Alibaba Cloud account. You do not need to specify this parameter because it will be deprecated | | ResourceGroupId | string | no | The resource group ID | ### Configures the full-image matching switch for synchronization `POST https://apizie.tech/v1/cloud:aliyun-dts/configure-synchronization-job-replicator-compare` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://dts.ap-southeast-1.aliyuncs.com | | RegionId | string | no | The region ID. For more information, see https://help.aliyun.com/document_detail/141033.html | | SynchronizationJobId | string | yes | The ID of the data synchronization instance. You can call the https://help.aliyun.com/document_detail/49454.html operation to query the… | | SynchronizationDirection | string | no | The synchronization direction. Valid values: Forward: forward synchronization. Reverse: reverse synchronization. Default value: Forward.… | | SynchronizationReplicatorCompareEnable | string | no | Specifies whether to enable the full-image matching switch. Valid values: true: enabled. false: disabled | | ClientToken | string | no | The client token that is used to ensure the idempotence of the request. You can use the client to generate the value, but you must make… | | AccountId | string | no | The ID of the Alibaba Cloud account. You do not need to specify this parameter. This parameter will be deprecated soon | | ResourceGroupId | string | no | The ID of the resource group | ### Transfers a DTS instance to a different resource group `POST https://apizie.tech/v1/cloud:aliyun-dts/convert-instance-resource-group` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://dts.ap-southeast-1.aliyuncs.com | | DtsJobId | string | no | A legacy parameter. This parameter does not take effect. You do not need to pass this parameter | | RegionId | string | no | The region in which the DTS instance resides | | ResourceId | string | no | The ID of the DTS instance. You can view the ID in the ID/Name column on the task list page in the console. This parameter is required | | NewResourceGroupId | string | no | The ID of the new resource group. You can obtain the ID from the Resource Management console. For more information, see… | | ZeroEtlJob | string | no | A parameter reserved for special business scenarios. You do not need to pass this parameter | | ResourceGroupId | string | no | A parameter reserved for special business scenarios. You do not need to pass this parameter | ### Queries the count of tasks by conditions `POST https://apizie.tech/v1/cloud:aliyun-dts/count-job-by-condition` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://dts.ap-southeast-1.aliyuncs.com | | Type | string | no | The query type. Valid values: name: queries by job name. rds: queries by destination instance ID. instance: queries by DTS instance ID.… | | Region | string | yes | The region ID used as a filter condition. For more information, see https://help.aliyun.com/document_detail/141033.html | | RegionId | string | yes | The ID of the region where the DTS instance resides. For more information, see https://help.aliyun.com/document_detail/141033.html | | JobType | string | no | The task type. Valid values: MIGRATION: data migration. SYNC: data synchronization. SUBSCRIBE: change tracking | | Params | string | no | The query value that corresponds to JobType | | Status | string | no | The instance status of the DTS instance. Valid values: Data migration node statuses: NotStarted: not started. Prechecking: running a dry… | | GroupId | string | no | The parent task ID of a distributed synchronization task | | SrcDbType | string | no | The type of the source database | | DestDbType | string | no | The type of the destination database | | ResourceGroupId | string | no | The resource group ID. This is a global parameter and does not need to be passed for this API operation | ### Creates a consumer group for a change tracking task `POST https://apizie.tech/v1/cloud:aliyun-dts/create-consumer-channel` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://dts.ap-southeast-1.aliyuncs.com | | RegionId | string | yes | The ID of the region where the DTS change tracking instance resides. For more information, see… | | DtsInstanceId | string | no | The ID of the change tracking instance. You can call the https://help.aliyun.com/document_detail/209702.html operation to query the… | | DtsJobId | string | no | The ID of the change tracking task. You can call the https://help.aliyun.com/document_detail/209702.html operation to query the task ID.… | | ConsumerGroupName | string | yes | The name of the consumer group. The name can be up to 128 characters in length. Specify a descriptive name for easy identification | | ConsumerGroupPassword | string | yes | The password of the account for the consumer group. The password must contain at least two of the following character types: uppercase… | | ConsumerGroupUserName | string | yes | The account name for the consumer group. The account name can contain uppercase letters, lowercase letters, digits, and underscores. The… | | ResourceGroupId | string | no | The ID of the resource group | ### Creates a consumer group for a change tracking instance `POST https://apizie.tech/v1/cloud:aliyun-dts/create-consumer-group` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://dts.ap-southeast-1.aliyuncs.com | | RegionId | string | no | The ID of the region where the change tracking instance resides. For more information, see… | | SubscriptionInstanceId | string | yes | The ID of the change tracking instance. You can call the DescribeSubscriptionInstances operation to query the instance ID | | ConsumerGroupName | string | yes | The name of the consumer group. The name can be up to 128 characters in length. We recommend that you use a descriptive name for easy… | | ConsumerGroupUserName | string | yes | The account of the consumer group. The account can contain uppercase letters, lowercase letters, digits, and underscores (_). The account… | | ConsumerGroupPassword | string | yes | The password of the consumer group account. The password must contain characters from at least two of the following categories: uppercase… | | AccountId | string | no | The ID of the Alibaba Cloud account. You do not need to specify this parameter because it will be deprecated | | ResourceGroupId | string | no | The resource group ID | ### Creates an alert rule by calling the CreateDedicatedClusterMonitorRule operation `POST https://apizie.tech/v1/cloud:aliyun-dts/create-dedicated-cluster-monitor-rule` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://dts.ap-southeast-1.aliyuncs.com | | InstanceId | string | no | The instance ID | | DedicatedClusterId | string | yes | The cluster ID | | NoticeSwitch | integer | no | The alert switch. Valid values: 1: on. 0: off | | DuAlarmThreshold | integer | no | The DU alert threshold. Unit: % | | CpuAlarmThreshold | integer | no | The CPU alert threshold. Unit: % | | MemAlarmThreshold | integer | no | The memory alert threshold. Unit: % | | DiskAlarmThreshold | integer | no | The disk alert threshold. Unit: % | | Phones | string | yes | The alert phone numbers. Separate multiple phone numbers with commas (,) | | RegionId | string | no | The region in which the DTS instance resides | | ResourceGroupId | string | no | The resource group ID. This is a global parameter and does not need to be passed in for this API operation | ### Creates a document parsing task `POST https://apizie.tech/v1/cloud:aliyun-dts/create-doc-parser-job` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://dts.ap-southeast-1.aliyuncs.com | | RegionId | string | no | The region ID of the document parsing task. For more information, see https://help.aliyun.com/document_detail/141033.html | | ResourceGroupId | string | no | The resource group ID | | FileUrl | string | no | The OSS URL of the document to be parsed. This parameter is automatically populated when you call this operation by using an SDK | | FileName | string | no | The name of the document to be parsed. The name must include the file name extension. Currently, only .pdf is supported | | ResultType | string | no | The output format of the parsing result after the task is complete. Valid values: zip: a ZIP compressed file. content: plain text | | RagInstanceId | string | no | The RagInstanceId | ### Purchases a DTS instance by calling the CreateDtsInstance operation `POST https://apizie.tech/v1/cloud:aliyun-dts/create-dts-instance` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://dts.ap-southeast-1.aliyuncs.com | | JobId | string | no | The task ID (DtsJobId) obtained by calling the ConfigureDtsJob operation. If you specify this parameter, you do not need to specify… | | InstanceClass | string | no | The specification of the data migration or data synchronization instance. Specifications supported by data migration instances: xxlarge,… | | PayType | string | no | The billing method. Valid values: PrePaid: subscription. PostPaid: pay-as-you-go. Correction: This parameter is required | | Period | string | no | The billing method of the subscription instance. Valid values: Year and Month. This parameter is valid and required only when PayType is… | | SyncArchitecture | string | no | The synchronization topology. Valid values: oneway: one-way synchronization. This is the default value. bidirectional: two-way… | | AutoStart | string | no | Specifies whether to automatically start the task after the purchase is complete. Valid values: false: no. This is the default value.… | | UsedTime | integer | no | The subscription duration of the subscription instance. If Period is set to Month, valid values are 1, 2, 3, 4, 5, 6, 7, 8, and 9. If… | | Quantity | integer | no | The number of instances to purchase. A maximum of one instance can be purchased per call | | AutoPay | string | no | Specifies whether to enable auto-renewal upon expiration. Valid values: false: no. This is the default value. true: yes | | Type | string | no | The instance type. Valid values: MIGRATION: data migration. SYNC: data synchronization. SUBSCRIBE: change tracking. You must specify this… | | DatabaseCount | integer | no | The number of private custom ApsaraDB RDS instances under PolarDB-X. Default value: 1. This parameter is required only when… | | SourceRegion | string | no | The region of the source instance. For more information, see https://help.aliyun.com/document_detail/141033.html. You must specify this… | | DestinationRegion | string | no | The region of the destination instance. For more information, see https://help.aliyun.com/document_detail/141033.html. You must specify… | | SourceEndpointEngineName | string | no | The database engine type of the source instance. Valid values: MySQL: MySQL database, including ApsaraDB RDS for MySQL and self-managed… | | DestinationEndpointEngineName | string | no | The database engine type of the destination instance. Valid values: MySQL: MySQL database, including ApsaraDB RDS for MySQL and… | | ComputeUnit | integer | no | The specifications of the ETL instance. Unit: compute unit (CU). 1 CU = 1 vCPU + 4 GB memory. Valid values: integers that are greater than… | | RegionId | string | no | The region ID of the instance. For more information, see https://help.aliyun.com/document_detail/141033.html | | FeeType | string | no | The billing type for change tracking. Valid values: ONLY_CONFIGURATION_FEE, which indicates that only configuration fees are charged and… | | Du | integer | no | The number of DU resources to allocate to the DTS task on a DTS dedicated cluster. Valid values: 1 to 100. The value must be within the… | | ResourceGroupId | string | no | The resource group ID | | MinDu | number | no | The minimum number of DUs. This parameter is supported only for serverless instances | | MaxDu | number | no | The maximum number of DUs. This parameter is supported only for serverless instances | | DtsRegion | string | no | The region to which the instance belongs. The value must be the same as the value of RegionId | | InsightModule | string | no | The InsightModule | ### Creates or modifies an alert rule for a DTS task `POST https://apizie.tech/v1/cloud:aliyun-dts/create-job-monitor-rule` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://dts.ap-southeast-1.aliyuncs.com | | DtsJobId | string | yes | The ID of the data migration, data synchronization, or change tracking task. You can call… | | Type | string | no | The type of the alert metric. Valid values: delay: the Latency metric. error: the Migration Status metric. full_timeout: the Full… | | State | string | no | Specifies whether to enable the alert rule. Valid values: Y: Enable the alert rule. N: Disable the alert rule. Default value: Y | | Phone | string | no | The mobile phone numbers of alert contacts, separated by commas (,). This parameter is supported only on the China site (aliyun.com) and… | | DelayRuleTime | integer | no | The threshold for triggering an alert. If Type is set to delay, the unit is seconds and the value must be an integer. Set the threshold… | | RegionId | string | no | The region in which the DTS instance resides. For more information, see https://help.aliyun.com/document_detail/141033.html | | Period | integer | no | The statistical period of the incremental verification task. Unit: minutes. Valid values: 1, 5, 10, and 30 | | Times | integer | no | The number of statistical periods for the incremental verification task | | NoticeValue | integer | no | The alert threshold | | ResourceGroupId | string | no | The resource group ID | ### Purchases a data migration instance `POST https://apizie.tech/v1/cloud:aliyun-dts/create-migration-job` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://dts.ap-southeast-1.aliyuncs.com | | RegionId | string | no | The region where the data migration instance resides. You do not need to specify this parameter because it will be deprecated | | Region | string | yes | The region where the data migration instance resides. This is the region where the destination database instance resides. For more… | | MigrationJobClass | string | yes | The specifications of the data migration instance. Valid values: small, medium, large, xlarge, and 2xlarge. For the test performance of… | | ClientToken | string | no | Ensures the idempotence of the request. You can generate the value on your client to ensure that it is unique across different requests.… | | AccountId | string | no | The ID of the Alibaba Cloud account. You do not need to specify this parameter because it will be deprecated | | ResourceGroupId | string | no | The ID of the resource group | ### Creates a reverse task for a specified synchronization or migration task `POST https://apizie.tech/v1/cloud:aliyun-dts/create-reverse-dts-job` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://dts.ap-southeast-1.aliyuncs.com | | DtsJobId | string | yes | The ID of the synchronization or migration task. You can call the https://help.aliyun.com/document_detail/209702.html operation to query… | | ShardUsername | string | no | The username of the shard in the MongoDB sharded cluster instance | | ShardPassword | string | no | The password of the shard in the MongoDB sharded cluster instance. This parameter is available and required only when the source database… | | ResourceGroupId | string | no | The ID of the resource group. This is a global parameter and is not required for this operation | ### Creates a legacy change tracking instance `POST https://apizie.tech/v1/cloud:aliyun-dts/create-subscription-instance` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://dts.ap-southeast-1.aliyuncs.com | | RegionId | string | no | The region of the change tracking instance. You do not need to specify this parameter because it is about to be deprecated | | Region | string | yes | The region ID. It must be the same as the region where the source object resides. For more information, see… | | SourceEndpoint.InstanceType | string | no | The instance type for change tracking. Valid values: MySQL, PolarDB, DRDS, and Oracle. Default value: MySQL | | PayType | string | no | The billing method. Valid values: Postpaid: pay-as-you-go. This is the default value. Prepaid: subscription | | Period | string | no | The billing method for a subscription instance. Valid values: Year: yearly. Month: monthly. This parameter is valid and required only when… | | UsedTime | integer | no | The purchase duration of a subscription instance. If the billing method is set to Year, valid values are 1 to 5. If the billing method is… | | ClientToken | string | no | The client token that is used to ensure the idempotence of the request. You can use the client to generate the value, but you must ensure… | | AccountId | string | no | The ID of the Alibaba Cloud account. You do not need to specify this parameter because it is about to be deprecated | | ResourceGroupId | string | no | The ID of the resource group | ### Creates a legacy data synchronization job instance `POST https://apizie.tech/v1/cloud:aliyun-dts/create-synchronization-job` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://dts.ap-southeast-1.aliyuncs.com | | RegionId | string | no | The region ID of the data synchronization instance. The value must be the same as the value of the DestRegion parameter | | SourceRegion | string | yes | The region ID of the source database. For more information, see https://help.aliyun.com/document_detail/141033.html | | DestRegion | string | yes | The region ID of the destination database. For more information, see https://help.aliyun.com/document_detail/141033.html. If the region… | | Topology | string | no | The synchronization topology. Valid values: oneway: one-way synchronization. bidirectional: two-way synchronization. Default value:… | | SynchronizationJobClass | string | yes | The specifications of the data synchronization link. Valid values: micro, small, medium, and large. For more information about the… | | PayType | string | yes | The billing method. Valid values: PrePaid: upfront. PostPaid: pay-as-you-go. This is the default value | | Period | string | no | The billing method of the upfront instance. Valid values: Year: yearly. Month: monthly. This parameter is valid and required only when the… | | UsedTime | integer | no | The subscription duration of the upfront instance. When the billing method is set to Year (yearly), valid values are 1 to 5. When the… | | ClientToken | string | no | The client token that is used to ensure the idempotence of the request. You can use the client to generate the value, but you must ensure… | | SourceEndpoint.InstanceType | string | no | The instance type of the source database. Valid values: MySQL: MySQL databases, including ApsaraDB RDS for MySQL instances and… | | DestinationEndpoint.InstanceType | string | no | The instance type of the destination database. Valid values: MySQL: MySQL databases, including ApsaraDB RDS for MySQL instances and… | | networkType | string | no | The network type of Data Transmission Service. The value is fixed to Intranet (Express Connect circuit) | | AccountId | string | no | The ID of the Alibaba Cloud account. You do not need to specify this parameter because it will be deprecated soon | | DBInstanceCount | integer | no | The number of private custom ApsaraDB RDS instances attached to the source PolarDB-X instance. This parameter is required only when the… | | ResourceGroupId | string | no | The ID of the resource group | ### Deletes a consumer group for a change tracking task `POST https://apizie.tech/v1/cloud:aliyun-dts/delete-consumer-channel` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://dts.ap-southeast-1.aliyuncs.com | | RegionId | string | yes | The ID of the region where the DTS change tracking instance resides. For more information, see… | | DtsInstanceId | string | no | The ID of the change tracking instance. You can call the https://help.aliyun.com/document_detail/209702.html operation to query the… | | DtsJobId | string | no | The ID of the change tracking task. You can call the https://help.aliyun.com/document_detail/209702.html operation to query the task ID.… | | ConsumerGroupId | string | yes | The ID of the consumer group. You can call the https://help.aliyun.com/document_detail/264169.html operation to query the consumer group ID | | ResourceGroupId | string | no | The ID of the resource group | ### Deletes a consumer group from a change tracking channel `POST https://apizie.tech/v1/cloud:aliyun-dts/delete-consumer-group` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://dts.ap-southeast-1.aliyuncs.com | | RegionId | string | no | The region ID. Specify this parameter to indicate the region where the instance resides. For more information, see… | | SubscriptionInstanceId | string | yes | The ID of the change tracking instance. You can call the DescribeSubscriptionInstances operation to query the instance ID | | ConsumerGroupID | string | yes | The ID of the consumer group. You can call the https://help.aliyun.com/document_detail/122886.html operation to query the consumer group ID | | AccountId | string | no | The ID of the Alibaba Cloud account. You do not need to specify this parameter because this parameter is about to be deprecated | | ResourceGroupId | string | no | The resource group ID | ### Releases a data migration, data synchronization, or change tracking instance `POST https://apizie.tech/v1/cloud:aliyun-dts/delete-dts-job` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://dts.ap-southeast-1.aliyuncs.com | | DtsJobId | string | no | The ID of the data migration, data synchronization, or change tracking task | | DtsInstanceId | string | no | The data migration, data synchronization, or subscribe instance ID | | SynchronizationDirection | string | no | The synchronization direction. Valid values: Forward: forward synchronization. Reverse: reverse synchronization. Default value: Forward.… | | RegionId | string | no | The region ID of the data migration or data synchronization instance. For more information, see… | | JobType | string | no | The task type of the DTS instance. Valid values: MIGRATION: data migration. SYNC: data synchronization. SUBSCRIBE: change tracking | | ZeroEtlJob | string | no | The field reserved for special business scenarios. You do not need to specify this parameter | | ResourceGroupId | string | no | The field reserved for special business scenarios. You do not need to specify this parameter | ### Releases multiple data migration, data synchronization, or change tracking tasks `POST https://apizie.tech/v1/cloud:aliyun-dts/delete-dts-jobs` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://dts.ap-southeast-1.aliyuncs.com | | DtsJobIds | string | yes | The IDs of the data migration, data synchronization, or change tracking tasks. You can specify up to 10 task IDs. Separate multiple task… | | RegionId | string | no | The region where the DTS instance resides. For more information, see https://help.aliyun.com/document_detail/141033.html | | ZeroEtlJob | string | no | A dedicated field for special business scenarios. You do not need to specify this parameter | | ResourceGroupId | string | no | A dedicated field for special business scenarios. You do not need to specify this parameter | ### Releases a data migration instance `POST https://apizie.tech/v1/cloud:aliyun-dts/delete-migration-job` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://dts.ap-southeast-1.aliyuncs.com | | RegionId | string | no | The region ID. Specify this parameter to indicate the region where the instance resides. For more information, see… | | MigrationJobId | string | yes | The ID of the data migration instance. You can call the DescribeMigrationJobs operation to query the instance ID | | AccountId | string | no | The ID of the Alibaba Cloud account. You do not need to specify this parameter because this parameter is about to be discontinued | | ResourceGroupId | string | no | The resource group ID | ### Releases the channel of a change tracking instance `POST https://apizie.tech/v1/cloud:aliyun-dts/delete-subscription-instance` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://dts.ap-southeast-1.aliyuncs.com | | RegionId | string | no | The ID of the region where the change tracking instance resides. For more information, see… | | SubscriptionInstanceId | string | yes | The ID of the change tracking instance. You can call the https://help.aliyun.com/document_detail/49442.html operation to query the… | | AccountId | string | no | The ID of the Alibaba Cloud account. You do not need to specify this parameter. This parameter will be deprecated soon | | ResourceGroupId | string | no | The ID of the resource group | ### Releases a data synchronization instance `POST https://apizie.tech/v1/cloud:aliyun-dts/delete-synchronization-job` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://dts.ap-southeast-1.aliyuncs.com | | RegionId | string | no | The ID of the region where the data synchronization instance resides. For more information, see… | | SynchronizationJobId | string | yes | The ID of the data synchronization instance. You can call the https://help.aliyun.com/document_detail/49454.html operation to query the… | | AccountId | string | no | The ID of the Alibaba Cloud account. You do not need to specify this parameter because this parameter is about to be deprecated | | ResourceGroupId | string | no | The ID of the resource group | ### Contains data validation tasks associated with data migration tasks and data synchronization tasks `POST https://apizie.tech/v1/cloud:aliyun-dts/describe-check-jobs` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://dts.ap-southeast-1.aliyuncs.com | | PageSize | integer | no | The number of records per page. Valid values: 30, 50, and 100. Default value: 30 | | PageNumber | integer | no | The page number | | CheckType | integer | no | The data validation method. Valid values: 1: full data validation. 2: incremental data validation. 3: all | | InstanceId | string | no | The ID of the data migration instance. You can call the DescribeMigrationJobs operation to query the ID | | JobName | string | no | The name of the data migration or data synchronization task | | CheckJobId | string | no | The ID of the data validation task | | ResourceGroupId | string | no | The resource group ID | ### Queries the operation logs of a DTS cluster `POST https://apizie.tech/v1/cloud:aliyun-dts/describe-cluster-operate-logs` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://dts.ap-southeast-1.aliyuncs.com | | StartTime | integer | no | The start timestamp. If you do not specify this parameter, the logs generated within the last seven days are returned by default. Unit:… | | EndTime | integer | no | The end timestamp. Unit: milliseconds | | DedicatedClusterId | string | yes | The ID of the dedicated DTS cluster | | PageSize | integer | no | The number of entries to return on each page. Default value: 20 | | PageNumber | integer | no | The page number. The value must be greater than 0 and cannot exceed the maximum value of the Integer data type. Default value: 1 | | DtsJobId | string | no | The ID of the data migration or synchronization task | | OwnerID | string | no | OwnerID | | ClientToken | string | no | The client token that is used to ensure the idempotence of the request. You can generate the value from your client. Make sure that the… | | AccountId | string | no | The ID of the Alibaba Cloud account | | ResourceGroupId | string | no | The ID of the resource group | ### Queries the current usage of a cluster `POST https://apizie.tech/v1/cloud:aliyun-dts/describe-cluster-used-utilization` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://dts.ap-southeast-1.aliyuncs.com | | DedicatedClusterId | string | yes | The ID of the dedicated cluster. Specify this parameter when MetricType is set to CLUSTER. Otherwise, specify the node ID | | Env | string | no | The environment. Default value: ALIYUN | | MetricType | string | no | The type of the resource to query. Valid values: CLUSTER (default): cluster. NODE: node | | RegionId | string | no | The region ID of the instance | | DtsJobId | string | no | The ID of the migration or synchronization task | | OwnerID | string | no | OwnerID | | ClientToken | string | no | The client token that is used to ensure the idempotence of the request. You can use the client to generate the value, but you must ensure… | | AccessKeyId | string | no | callType=AssumedRoleUser | | SecurityToken | string | no | callType=AssumedRoleUser | | AccountId | string | no | The ID of the Alibaba Cloud account. You do not need to specify this parameter. This parameter will be deprecated soon | | ResourceGroupId | string | no | The ID of the resource group | ### Tests the connectivity between the execution node of a data migration task and the source and destination… `POST https://apizie.tech/v1/cloud:aliyun-dts/describe-connection-status` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://dts.ap-southeast-1.aliyuncs.com | | SourceEndpointArchitecture | string | no | This parameter is required only when SourceEndpointEngineName is set to Oracle. Valid values: SID: Non-cluster architecture. RAC: Cluster… | | SourceEndpointInstanceType | string | yes | The type of the source instance. Valid values: RDS: ApsaraDB RDS instance. LocalInstance: Self-managed database. ECS: Self-managed… | | SourceEndpointInstanceID | string | no | The instance ID of the source instance | | SourceEndpointEngineName | string | no | The database engine type of the source instance. Valid values: MySQL, TiDB, SQLServer, PostgreSQL, Oracle, MongoDB, and Redis. Default… | | SourceEndpointRegion | string | no | The region where the source instance resides. For more information, see https://help.aliyun.com/document_detail/141033.html | | SourceEndpointIP | string | no | The endpoint of the source database. This parameter is available and required only when SourceEndpointInstanceType is set to LocalInstance… | | SourceEndpointPort | string | no | The service port of the source database. This parameter is available and required only when SourceEndpointInstanceType is set to ECS,… | | SourceEndpointOracleSID | string | no | The system ID (SID) of the Oracle database. This parameter is available and required only when SourceEndpointEngineName is set to Oracle… | | SourceEndpointDatabaseName | string | no | The name of the database to be migrated or the authentication database. This parameter is available and required only when… | | SourceEndpointUserName | string | no | The database account of the source database | | SourceEndpointPassword | string | no | The password of the database account for the source database | | DestinationEndpointInstanceType | string | yes | The instance type of the destination database. Valid values: ECS: Self-managed database hosted on ECS. LocalInstance: Self-managed… | | DestinationEndpointInstanceID | string | no | The instance ID of the destination instance | | DestinationEndpointEngineName | string | no | The database engine type of the destination database. Valid values: MySQL, DRDS, SQLServer, PostgreSQL, PPAS, MongoDB, and Redis. This… | | DestinationEndpointRegion | string | no | The region where the destination instance resides. For more information, see https://help.aliyun.com/document_detail/141033.html | | DestinationEndpointIP | string | no | The endpoint of the destination database. This parameter is available and required only when DestinationEndpointInstanceType is set to… | | DestinationEndpointPort | string | no | The service port of the destination database. This parameter is available and required only when SourceEndpointInstanceType is set to ECS,… | | DestinationEndpointDatabaseName | string | no | The name of the destination database or the authentication database. This parameter is available and required only when… | | DestinationEndpointUserName | string | no | The database account of the destination database | | DestinationEndpointPassword | string | no | The password of the database account for the destination database | | DestinationEndpointOracleSID | string | no | This parameter is required only when DestinationEndpointEngineName is set to Oracle. Valid values: SID: Non-cluster architecture. RAC:… | | DestinationEndpointArchitecture | string | no | This parameter is required only when SourceEndpointEngineName is set to Oracle. Valid values: SID: Non-cluster architecture. RAC: Cluster… | | RegionId | string | no | The region where the DTS instance resides. For details, see https://help.aliyun.com/document_detail/141033.html | | ResourceGroupId | string | no | The ID of the resource group | ### Queries the consumer group information of a DTS change tracking task, such as the consumer group ID, name,… `POST https://apizie.tech/v1/cloud:aliyun-dts/describe-consumer-channel` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://dts.ap-southeast-1.aliyuncs.com | | RegionId | string | yes | The region ID of the DTS change tracking instance. For more information, see https://help.aliyun.com/document_detail/141033.html | | DtsInstanceId | string | no | The ID of the change tracking instance. You can call https://help.aliyun.com/document_detail/209702.html to query the instance ID. You… | | DtsJobId | string | no | The ID of the change tracking task. You can call https://help.aliyun.com/document_detail/209702.html to query the task ID. You must… | | PageSize | integer | no | The number of records per page. Valid values: 1 to 100. Default value: 20 | | PageNumber | integer | no | The page number. The value must be a positive integer that does not exceed the maximum value of the Integer data type. Default value: 1 | | ParentChannelId | string | no | The parent task ChannelId of the distributed task | | ResourceGroupId | string | no | The resource group ID | ### Queries the details of consumer groups in a change tracking instance `POST https://apizie.tech/v1/cloud:aliyun-dts/describe-consumer-group` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://dts.ap-southeast-1.aliyuncs.com | | RegionId | string | no | The ID of the region where the change tracking instance resides. For more information, see… | | PageSize | integer | no | The number of records per page. Valid values: 30, 50, and 100. Default value: 30 | | PageNum | integer | no | The page number. The value must be an integer that is greater than 0 and does not exceed the maximum value of the Integer data type.… | | SubscriptionInstanceId | string | yes | The ID of the change tracking instance. You can call the DescribeSubscriptionInstances operation to query the instance ID | | AccountId | string | no | The ID of the Alibaba Cloud account. You do not need to specify this parameter because this parameter will be deprecated | | ResourceGroupId | string | no | The resource group ID | ### Queries the DTS IP addresses that must be added to the whitelists of both the source and destination databases `POST https://apizie.tech/v1/cloud:aliyun-dts/describe-dtsip` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://dts.ap-southeast-1.aliyuncs.com | | RegionId | string | no | The region where the DTS task instance resides. For more information, see https://help.aliyun.com/document_detail/141033.html | | SourceEndpointRegion | string | yes | The region ID of the source instance. For more information, see https://help.aliyun.com/document_detail/141033.html. If the source… | | DestinationEndpointRegion | string | no | The region ID of the destination instance. For more information, see https://help.aliyun.com/document_detail/141033.html. If the… | | ResourceGroupId | string | no | The resource group ID | ### Retrieves the download link for the list of inconsistent data `POST https://apizie.tech/v1/cloud:aliyun-dts/describe-data-check-report-url` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://dts.ap-southeast-1.aliyuncs.com | | CheckType | integer | yes | The data validation method. Valid values: 1: full validation. Currently, only 1 is supported | | DbName | string | yes | The name of the source database to be verified | | TbName | string | yes | The name of the table to be verified in the source database | | DtsJobId | string | yes | The ID of the DTS task. You can call the https://help.aliyun.com/document_detail/209702.html operation to obtain the task ID | | ResourceGroupId | string | no | The ID of the resource group | ### Queries data consistency verification results at the table level `POST https://apizie.tech/v1/cloud:aliyun-dts/describe-data-check-table-details` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://dts.ap-southeast-1.aliyuncs.com | | Status | string | no | The status of the verification result. Valid values: -1 (default): all statuses. 6: tables with inconsistent data | | PageSize | integer | no | The number of records per page | | PageNumber | integer | no | The page number. The value must be a positive integer that does not exceed the maximum value of the Integer data type. Default value: 1 | | CheckType | integer | yes | The data validation method. Valid values: 1: full data validation. 2: incremental data validation | | TableName | string | no | The name of the table to be verified in the source database | | DtsJobId | string | yes | The ID of the data migration or data synchronization task. You can call the https://help.aliyun.com/document_detail/209702.html operation… | | SchemaName | string | no | The schema name of the object to be verified in the source database | | ResourceGroupId | string | no | The resource group ID | ### Lists data inconsistency results grouped by inconsistent data `POST https://apizie.tech/v1/cloud:aliyun-dts/describe-data-check-table-diff-details` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://dts.ap-southeast-1.aliyuncs.com | | CheckType | integer | yes | The data validation method. Valid values: 1: full verification. 2: incremental verification | | DbName | string | yes | The name of the database that contains the table with inconsistent data | | TbName | string | yes | The name of the table that contains inconsistent data | | PageSize | integer | no | The number of records per page | | PageNumber | integer | no | The page number. The value must be a positive integer that does not exceed the maximum value of the Integer data type. Default value: 1 | | DtsJobId | string | yes | The ID of the data migration or data synchronization task. You can call the https://help.aliyun.com/document_detail/209702.html operation… | | ResourceGroupId | string | no | The resource group ID | ### Queries the details of a dedicated cluster `POST https://apizie.tech/v1/cloud:aliyun-dts/describe-dedicated-cluster` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://dts.ap-southeast-1.aliyuncs.com | | DedicatedClusterId | string | yes | The ID of the dedicated cluster | | RegionId | string | no | The region ID of the instance | | ResourceGroupId | string | no | The ID of the resource group | ### Queries the alert rules `POST https://apizie.tech/v1/cloud:aliyun-dts/describe-dedicated-cluster-monitor-rule` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://dts.ap-southeast-1.aliyuncs.com | | DedicatedClusterId | string | no | The cluster ID | | RegionId | string | no | The region where the instance resides | | ResourceGroupId | string | no | The resource group ID. This is a global parameter and is not required for this API operation | ### Retrieves the result of a document parsing task `POST https://apizie.tech/v1/cloud:aliyun-dts/describe-doc-parser-job-result` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://dts.ap-southeast-1.aliyuncs.com | | DtsJobId | string | no | The task ID (DtsJobId) returned when the document parsing task was created | | RegionId | string | no | The region ID of the task. For more information, see https://help.aliyun.com/document_detail/141033.html | | ResourceGroupId | string | no | The resource group ID | | RagInstanceId | string | no | The instance ID of the DTS RagFlow instance | ### Queries the execution status of a document parsing task `POST https://apizie.tech/v1/cloud:aliyun-dts/describe-doc-parser-job-status` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://dts.ap-southeast-1.aliyuncs.com | | DtsJobId | string | no | The task ID (DtsJobId) returned when the document parsing task is created | | RegionId | string | no | The region ID of the task. For more information, see https://help.aliyun.com/document_detail/141033.html | | ResourceGroupId | string | no | The resource group ID | | RagInstanceId | string | no | The RagInstanceId | ### Queries the details of an ETL task `POST https://apizie.tech/v1/cloud:aliyun-dts/describe-dts-etl-job-version-info` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://dts.ap-southeast-1.aliyuncs.com | | PageSize | integer | no | The paging Settings for the number of entries per page in a paged query. Default value: 20 | | PageNumber | integer | no | The page number of the instance status list. Default value: 1 | | DtsInstanceId | string | yes | The ID of the DTS instance. You can call the https://help.aliyun.com/document_detail/209702.html operation to query the instance ID | | DtsJobId | string | no | The ID of the ETL task. You can call the https://help.aliyun.com/document_detail/209702.html operation to query the task ID | | RegionId | string | no | The region ID of the DTS instance. You can call the https://help.aliyun.com/document_detail/25609.html operation to query the list of… | | ResourceGroupId | string | no | The ID of the resource group | ### Queries the details of a DTS task `POST https://apizie.tech/v1/cloud:aliyun-dts/describe-dts-job-detail` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://dts.ap-southeast-1.aliyuncs.com | | DtsJobId | string | no | The ID of the data migration, data synchronization, or change tracking task | | DtsInstanceID | string | no | The data migration, data synchronization, or subscribe instance ID | | SynchronizationDirection | string | no | The synchronization direction. Valid values: Forward: forward. Reverse: reverse. Default value: Forward. This parameter takes effect only… | | RegionId | string | no | The region ID of the task. For more information, see https://help.aliyun.com/document_detail/141033.html | | SyncSubJobHistory | string | no | Specifies whether to return the information about all synchronization subtasks. Default value: false. If this parameter is set to false,… | | ZeroEtlJob | string | no | Specifies whether the node is a seamless integration (Zero-ETL) node. Valid values: true: yes. false: no | | ResourceGroupId | string | no | The ID of the resource group | | DbObjectOutputType | string | no | The output type of the migration object information | ### Queries the list of DTS tasks and the execution details of each task `POST https://apizie.tech/v1/cloud:aliyun-dts/describe-dts-jobs` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://dts.ap-southeast-1.aliyuncs.com | | Type | string | no | The conditional query parameter. Valid values: instance: queries by DTS instance ID. name: queries by DTS instance name. Fuzzy match is… | | Params | string | no | The specific content of the query condition. Specify Type in advance to define the query condition | | Region | string | no | The region in which the DTS instance resides. For more information, see https://help.aliyun.com/document_detail/141033.html | | Status | string | no | The instance status of the DTS instance. Valid values: Data migration task statuses: NotStarted: not started. Prechecking: running a… | | OrderDirection | string | no | The sort order of instances. Valid values: ASC: ascending order. This is the default value. DESC: descending order | | OrderColumn | string | no | The sort criterion when the response contains multiple DTS instances. Valid values: CreateTime: sorts by task creation time. FinishTime:… | | Tags | string | no | The tag-based search condition in JSON format. You can call the ListTagResources operation to query tag keys and values | | PageSize | integer | no | The number of records per page. Valid values: 10, 20, and 30. Default value: 20. Maximum value: 30 | | PageNumber | integer | no | The page number. The value must be a positive integer that does not exceed the maximum value of the Integer data type. Default value: 1 | | JobType | string | no | The task type of the DTS instance. Valid values: MIGRATION: data migration (default). SYNC: data synchronization. SUBSCRIBE: change tracking | | RegionId | string | no | Deprecated parameter | | GroupId | string | no | The DTS task ID. In most cases, you do not need to set this parameter | | DedicatedClusterId | string | no | The ID of the DTS dedicated cluster | | DtsJobId | string | no | The ID of the data migration, data synchronization, or change tracking task. Separate multiple task IDs with commas (,). Make sure that… | | DtsInstanceId | string | no | The ID of the data migration, data synchronization, or change tracking instance. Separate multiple instance IDs with commas (,). Make sure… | | ResourceGroupId | string | no | The resource group ID | | WithoutDbList | string | no | Specifies whether to exclude task objects from the response (not return the DbObject parameter). Valid values: true: excludes DbObject… | | DtsBisLabel | string | no | The environment label of the DTS instance. Valid values: normal: normal online: online | | ZeroEtlJob | string | no | Specifies whether the node is a seamless integration (Zero-ETL) node. Valid values: false: No. true: Yes | | InstanceType | string | no | The type of the source or destination database instance | | InstanceId | string | no | The ID of the source or destination database instance that corresponds to the InstanceType request parameter | | DestProductType | string | no | The type of the source database instance | | SrcProductType | string | no | The type of the destination database instance | ### Queries the log information of a data migration or synchronization task `POST https://apizie.tech/v1/cloud:aliyun-dts/describe-dts-service-log` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://dts.ap-southeast-1.aliyuncs.com | | DtsJobId | string | no | The ID of the migration or synchronization task | | PageSize | integer | no | The number of log entries to return on each page. Valid values: 20, 50, 100, 500, and 1000. Default value: 20 | | PageNumber | integer | no | The page number. The value must be a positive integer. Default value: 1 | | StartTime | integer | no | The start time of the logs. To query the logs of a DTS subtask within a specific time range, call the… | | EndTime | integer | no | The end time of the logs. You can call the https://help.aliyun.com/document_detail/209718.html operation to query the time. To query the… | | Status | string | no | The log level. Separate multiple log levels with commas (,). Valid values: NORMAL: Normal. WARN: Warning. ERROR: Error | | SubJobType | string | no | The specific sub-node type of the DTS task. Valid values: DATA_LOAD: Full data migration or full data synchronization. ONLINE_WRITER:… | | Keyword | string | no | The keyword used to filter the logs. Fuzzy matching is supported and the keyword is case-sensitive | | RegionId | string | no | The ID of the region where the instance resides. For more information, see https://help.aliyun.com/document_detail/141033.html | | ZeroEtlJob | string | no | Specifies whether the node is a seamless integration (Zero-ETL) node. Valid values: true: Yes. false: No | | ResourceGroupId | string | no | The ID of the resource group | ### Queries the execution status of a task `POST https://apizie.tech/v1/cloud:aliyun-dts/describe-endpoint-switch-status` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://dts.ap-southeast-1.aliyuncs.com | | RegionId | string | no | The region ID. Specify this parameter to indicate the region where the instance resides. For more information, see… | | TaskId | string | yes | The task ID. This value is returned after a successful call to the https://help.aliyun.com/document_detail/201858.html operation | | ClientToken | string | no | The client token that is used to ensure the idempotence of the request. You can generate the value from your client. Make sure that the… | | AccountId | string | no | The ID of the Alibaba Cloud account. You do not need to specify this parameter because it will be deprecated soon | | ResourceGroupId | string | no | The resource group ID | ### Queries the running logs of an ETL task `POST https://apizie.tech/v1/cloud:aliyun-dts/describe-etl-job-logs` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://dts.ap-southeast-1.aliyuncs.com | | DtsJobId | string | yes | The ID of the ETL task. You can call the https://help.aliyun.com/document_detail/209702.html operation to query the task ID | | RegionId | string | no | The region ID of the DTS instance. You can call the https://help.aliyun.com/document_detail/25609.html operation to query the list of… | | ResourceGroupId | string | no | The ID of the resource group | ### Queries the running details of a full data migration task `POST https://apizie.tech/v1/cloud:aliyun-dts/describe-full-process-list` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://dts.ap-southeast-1.aliyuncs.com | | DtsJobId | string | yes | The ID of the migration, synchronization, or change tracking task | | RegionId | string | no | The region ID. Specify this parameter to indicate the region where the instance resides. For more information, see… | | ZeroEtlJob | string | no | Specifies whether the node is a zero-ETL seamless integration node. Valid values: true: The node is a zero-ETL seamless integration node.… | | ResourceGroupId | string | no | The resource group ID | ### Queries a list of GAD instances `POST https://apizie.tech/v1/cloud:aliyun-dts/describe-gad-instances` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://dts.ap-southeast-1.aliyuncs.com | | ResourceGroupId | string | no | The resource group ID | | RegionId | string | no | The region ID. Specify this parameter to indicate the region where the instance resides. For more information, see… | | InstanceName | string | no | The name of the active geo-redundancy instance group | | PageSize | integer | no | The number of entries per page. Valid values: 1 to 100. Default value: 20 | | PageNumber | integer | no | The page number | | MasterDbInstanceId | string | no | The MasterDbInstanceId | | SlaveDbInstanceId | string | no | The ID of the secondary database instance | | DbEngineTypes | string | no | The list of database engine types. Separate multiple types with commas (,) | ### Queries the initialization status. This is an earlier version of the operation `POST https://apizie.tech/v1/cloud:aliyun-dts/describe-initialization-status` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://dts.ap-southeast-1.aliyuncs.com | | RegionId | string | no | The ID of the region where the data synchronization instance resides. For more information, see… | | SynchronizationJobId | string | yes | The ID of the data synchronization instance. You can call the https://help.aliyun.com/document_detail/49454.html operation to query the… | | PageSize | integer | no | The number of entries per page. Valid values: 1 to 100. Default value: 30 | | PageNum | integer | no | The page number. The value must be greater than 0 and cannot exceed the maximum value of the Integer data type. Default value: 1 | | AccountId | string | no | The ID of the Alibaba Cloud account. You do not need to specify this parameter. This parameter will be discontinued | | ResourceGroupId | string | no | The resource group ID | ### Queries the alert rules of a DTS task by calling DescribeJobMonitorRule `POST https://apizie.tech/v1/cloud:aliyun-dts/describe-job-monitor-rule` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://dts.ap-southeast-1.aliyuncs.com | | DtsJobId | string | yes | The ID of the data migration, data synchronization, or change tracking task. You can call… | | RegionId | string | no | The region in which the DTS instance resides. For more information, see https://help.aliyun.com/document_detail/141033.html | | ResourceGroupId | string | no | The resource group ID | ### Queries cluster monitoring information by calling the DescribeMetricList operation `POST https://apizie.tech/v1/cloud:aliyun-dts/describe-metric-list` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://dts.ap-southeast-1.aliyuncs.com | | MetricType | string | no | Specifies whether to query a cluster or a node. Valid values: CLUSTER: cluster. NODE: node | | MetricName | string | yes | InternetOut: outbound Internet traffic, in bytes. diskusage_utilization: disk usage. IntranetInRate: inbound internal network traffic, in… | | Period | integer | no | The observation interval in seconds. The minimum interval is 15 seconds | | Param | string | yes | The observation value. If MetricType is set to NODE, the value is nodeid | | StartTime | integer | no | The start timestamp, in milliseconds | | EndTime | integer | no | The end timestamp, in milliseconds | | Env | string | no | Default value: ALIYUN | | DtsJobId | string | no | The ID of the data migration or data synchronization task | | OwnerID | string | no | OwnerID | | ClientToken | string | no | Ensures the idempotency of the request. Generate a parameter value from your client to make sure that the value is unique among different… | | AccessKeyId | string | no | callType=AssumedRoleUser | | AccountId | string | no | The ID of the Alibaba Cloud account | | ResourceGroupId | string | no | The resource group ID | ### Queries the monitoring and alert settings of a data migration task `POST https://apizie.tech/v1/cloud:aliyun-dts/describe-migration-job-alert` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://dts.ap-southeast-1.aliyuncs.com | | RegionId | string | no | The ID of the region where the data migration instance resides. For more information, see… | | MigrationJobId | string | yes | The ID of the data migration instance. You can call the DescribeMigrationJobs operation to query the ID | | ClientToken | string | no | The client token that is used to ensure the idempotence of the request. You can use the client to generate the value, but you must make… | | AccountId | string | no | The ID of the Alibaba Cloud account. You do not need to specify this parameter because this parameter is about to be discontinued | | ResourceGroupId | string | no | The resource group ID | ### Queries the execution details of a data migration task. This is a legacy operation `POST https://apizie.tech/v1/cloud:aliyun-dts/describe-migration-job-detail` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://dts.ap-southeast-1.aliyuncs.com | | RegionId | string | no | The ID of the region where the data migration instance resides. For more information, see… | | PageSize | integer | no | The number of records per page. Valid values: 30, 50, and 100. Default value: 30 | | PageNum | integer | no | The page number. The value must be an integer greater than 0 and must not exceed the maximum value of the Integer data type. Default… | | MigrationJobId | string | yes | Instance ID of the data migration instance. You can call the DescribeMigrationJobs operation to query instance ID | | MigrationMode.StructureInitialization | string | no | Specifies whether to query the details of schema migration. Valid values: true: yes. false: no. Default value: false | | MigrationMode.DataInitialization | string | no | Specifies whether to query the details of full data migration. Valid values: true: yes. false: no. Default value: false | | MigrationMode.DataSynchronization | string | no | Specifies whether to query the details of incremental data migration. Valid values: true: yes. false: no. Default value: false | | ClientToken | string | no | The client token that is used to ensure the idempotence of the request. Generate a value from your client to ensure that the value is… | | AccountId | string | no | The ID of the Alibaba Cloud account. You do not need to specify this parameter because it will be discontinued | | ResourceGroupId | string | no | The resource group ID | ### Queries the status of a data migration task. This is a legacy operation `POST https://apizie.tech/v1/cloud:aliyun-dts/describe-migration-job-status` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://dts.ap-southeast-1.aliyuncs.com | | RegionId | string | no | The ID of the region where the data migration instance resides. For more information, see… | | MigrationJobId | string | yes | The ID of the data migration instance. You can call the DescribeMigrationJobs operation to query the instance ID | | ClientToken | string | no | The client token that is used to ensure the idempotence of the request. You can use the client to generate the value, but you must make… | | AccountId | string | no | The ID of the Alibaba Cloud account. You do not need to specify this parameter because it will be discontinued | | ResourceGroupId | string | no | The resource group ID | ### Queries a list of data migration instances and their details `POST https://apizie.tech/v1/cloud:aliyun-dts/describe-migration-jobs` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://dts.ap-southeast-1.aliyuncs.com | | RegionId | string | no | The region ID of the data migration instances. For more information, see https://help.aliyun.com/document_detail/141033.html | | PageSize | integer | no | The number of data migration instance records to return on each page. Valid values: 10, 20, and 30. Default value: 30. Maximum value: 30 | | PageNum | integer | no | The page number. Valid values: an integer greater than 0 and up to the maximum value of the Integer data type. Default value: 1 | | MigrationJobName | string | no | The name of the data migration instance. Fuzzy match is supported | | AccountId | string | no | The ID of the Alibaba Cloud account. You do not need to specify this parameter because it will be deprecated | | Tag | string | no | The tags of the data migration instances used as a filter. If this parameter is specified, only instances with the specified tags are… | | ResourceGroupId | string | no | The ID of the resource group | ### Queries the result of the precheck task for creating a GAD order `POST https://apizie.tech/v1/cloud:aliyun-dts/describe-pre-check-create-gad-order-result` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://dts.ap-southeast-1.aliyuncs.com | | ResourceGroupId | string | no | The ID of the resource group | | RegionId | string | no | The region ID. You can set this parameter to specify the region where the instance resides. For more information, see… | | InstanceId | string | no | The instance ID of the global active database (GAD) instance group | | TaskId | string | no | The ID of the precheck task | ### Queries the execution details of subtasks for a DTS task, including the precheck, schema migration or… `POST https://apizie.tech/v1/cloud:aliyun-dts/describe-pre-check-status` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://dts.ap-southeast-1.aliyuncs.com | | DtsJobId | string | yes | The ID of the data migration, data synchronization, or change tracking task | | PageNo | string | no | The page number. Valid values: an integer greater than 0 and less than or equal to the maximum value of the Integer data type. Default… | | PageSize | string | no | The number of entries per page. Default value: 20 | | JobCode | string | yes | The task code. Set this parameter to specify the type of the subtask for the DTS task to query. Valid values: 01: Precheck. 02: Database… | | StructType | string | no | The type of the schema definition. Valid values: before: Schema migration or initial schema synchronization. after: DDL operations in… | | RegionId | string | no | The region ID of the DTS instance. For more information, see https://help.aliyun.com/document_detail/141033.html | | StructPhase | string | no | The filter condition for schema migration. Valid values: tables, views, and functions | | Name | string | no | The filter condition used to perform a fuzzy match on table names | | ZeroEtlJob | string | no | Specifies whether the task is a seamless integration (Zero-ETL) task. Valid values: false: No. true: Yes | | ResourceGroupId | string | no | The ID of the resource group | ### Queries the details of the monitoring and alerting settings for a change tracking instance `POST https://apizie.tech/v1/cloud:aliyun-dts/describe-subscription-instance-alert` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://dts.ap-southeast-1.aliyuncs.com | | RegionId | string | no | The ID of the region where the change tracking instance resides. For more information, see… | | SubscriptionInstanceId | string | yes | The ID of the change tracking instance. You can call the DescribeSubscriptionInstances operation to query the instance ID | | ClientToken | string | no | The client token that is used to ensure the idempotence of the request. You can use the client to generate the value, and you must ensure… | | AccountId | string | no | The ID of the Alibaba Cloud account. You do not need to specify this parameter because it will be deprecated soon | | ResourceGroupId | string | no | The ID of the resource group | ### Queries the instance status details of a change tracking channel. This is a legacy operation `POST https://apizie.tech/v1/cloud:aliyun-dts/describe-subscription-instance-status` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://dts.ap-southeast-1.aliyuncs.com | | RegionId | string | no | The ID of the region where the change tracking instance resides. For more information, see… | | SubscriptionInstanceId | string | yes | The ID of the change tracking instance. You can call the https://help.aliyun.com/document_detail/49442.html operation to query the… | | AccountId | string | no | The ID of the Alibaba Cloud account. You do not need to specify this parameter because it will be deprecated | | ResourceGroupId | string | no | The resource group ID | ### Queries the list of change tracking instances and the details of each instance `POST https://apizie.tech/v1/cloud:aliyun-dts/describe-subscription-instances` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://dts.ap-southeast-1.aliyuncs.com | | RegionId | string | no | The ID of the region where the change tracking instance resides. For more information, see… | | PageSize | integer | no | The number of entries to return on each page. Valid values: 30, 50, and 100. Default value: 30 | | PageNum | integer | no | The page number. The value must be greater than 0 and no more than the maximum value of the Integer data type. Default value: 1 | | SubscriptionInstanceName | string | no | The name of the change tracking instance. If you specify this parameter, DTS returns the change tracking instances whose names contain the… | | ClientToken | string | no | The client token that is used to ensure the idempotence of the request. You can generate the value from your client. Make sure that the… | | AccountId | string | no | The ID of the Alibaba Cloud account. You do not need to specify this parameter because it will be deprecated soon | | Tag | string | no | The tags of the data migration instances. This parameter is used as a filter. If this parameter is specified, only instances that have the… | | ResourceGroupId | string | no | The ID of the resource group | ### Queries the information about subtasks of a PolarDB-X 1.0 distributed change tracking task `POST https://apizie.tech/v1/cloud:aliyun-dts/describe-subscription-meta` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://dts.ap-southeast-1.aliyuncs.com | | Sid | string | yes | The consumer group ID | | DtsInstanceId | string | no | The instance ID of the distributed change tracking task. This parameter is required | | SubMigrationJobIds | string | no | The IDs of all change tracking subtasks under the distributed change tracking task. Separate multiple subtask IDs with commas (,). You… | | Topics | string | no | All change tracking topics under the distributed change tracking task. Separate multiple topics with commas (,). You must specify at least… | | RegionId | string | no | The region where the change tracking instance resides | | ResourceGroupId | string | no | The resource group ID | ### Queries the monitoring and alerting settings of a synchronization task `POST https://apizie.tech/v1/cloud:aliyun-dts/describe-synchronization-job-alert` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://dts.ap-southeast-1.aliyuncs.com | | RegionId | string | no | The region ID. Specify this parameter to indicate the region where the subscription channel resides. For more information, see… | | SynchronizationJobId | string | yes | Instance ID of the data synchronization instance. You can call the DescribeSynchronizationJobs operation to query instance ID | | SynchronizationDirection | string | no | The synchronization direction. Valid values: Forward: forward. Reverse: reverse. Default value: Forward | | ClientToken | string | no | The client token that is used to ensure the idempotence of the request. You can use the client to generate the value, but you must make… | | AccountId | string | no | The ID of the Alibaba Cloud account. You do not need to specify this parameter because this parameter is about to be discontinued | | ResourceGroupId | string | no | The resource group ID | ### Retrieves the current image matching switch configuration. This is a legacy operation `POST https://apizie.tech/v1/cloud:aliyun-dts/describe-synchronization-job-replicator-compare` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://dts.ap-southeast-1.aliyuncs.com | | RegionId | string | no | The region ID. Specify this parameter to indicate the region where the instance resides. For more information, see… | | SynchronizationJobId | string | yes | The ID of the data synchronization instance. You can call the https://help.aliyun.com/document_detail/49454.html operation to query the… | | SynchronizationDirection | string | no | The synchronization direction. Valid values: Forward: forward. Reverse: reverse. Default value: Forward. You need to specify this… | | ClientToken | string | no | The client token that is used to ensure the idempotence of the request. Generate a value from your client to ensure uniqueness across… | | AccountId | string | no | The ID of the Alibaba Cloud account. You do not need to specify this parameter because it will be deprecated | | ResourceGroupId | string | no | The resource group ID | ### Queries the running status of a data synchronization task. This is a legacy API operation `POST https://apizie.tech/v1/cloud:aliyun-dts/describe-synchronization-job-status` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://dts.ap-southeast-1.aliyuncs.com | | RegionId | string | no | The region ID of the data synchronization instance. For more information, see https://help.aliyun.com/document_detail/141033.html | | SynchronizationJobId | string | yes | The ID of the data synchronization instance. You can call the https://help.aliyun.com/document_detail/49454.html operation to query the… | | SynchronizationDirection | string | no | The synchronization direction. Valid values: Forward: forward. Reverse: reverse. Default value: Forward. The value Reverse takes effect… | | ClientToken | string | no | The client token that is used to ensure the idempotence of the request. You can use the client to generate the value, but you must make… | | AccountId | string | no | The ID of the Alibaba Cloud account. You do not need to specify this parameter because it will be discontinued | | ResourceGroupId | string | no | The resource group ID | ### Queries the status list of synchronization jobs in the legacy version `POST https://apizie.tech/v1/cloud:aliyun-dts/describe-synchronization-job-status-list` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://dts.ap-southeast-1.aliyuncs.com | | RegionId | string | no | The region ID. You can specify the region where the instance resides by using this parameter. For more information, see… | | SynchronizationJobIdListJsonStr | string | yes | Instance IDs of the data synchronization instances. The value is a JSON array. You can call the… | | ClientToken | string | no | The client token that is used to ensure the idempotence of the request. You can generate the value from your client and make sure that the… | | AccountId | string | no | The ID of the Alibaba Cloud account. You do not need to specify this parameter because it will be deprecated | | ResourceGroupId | string | no | The ID of the resource group | ### Queries the list of data synchronization instances and the details of each synchronization instance `POST https://apizie.tech/v1/cloud:aliyun-dts/describe-synchronization-jobs` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://dts.ap-southeast-1.aliyuncs.com | | RegionId | string | no | The ID of the region where the data synchronization instance resides. For more information, see… | | PageSize | integer | no | The number of entries per page. Valid values: 10, 20, and 30. Default value: 30. Maximum value: 30 | | PageNum | integer | no | The page number. The value must be an integer greater than 0 and less than or equal to the maximum value of the Integer data type. Default… | | SynchronizationJobName | string | no | The name of the synchronization instance. Fuzzy matching is supported | | ClientToken | string | no | The client token that is used to ensure the idempotence of the request. You can use the client to generate the token, and you must ensure… | | AccountId | string | no | The ID of the Alibaba Cloud account. You do not need to specify this parameter because it is about to be deprecated | | Tag | string | no | The tags of the data synchronization instance, which are used as a filter. If this parameter is not empty, only the instances that have… | | ResourceGroupId | string | no | The ID of the resource group | ### Queries the execution status of a task that modifies synchronization objects. This is a legacy operation `POST https://apizie.tech/v1/cloud:aliyun-dts/describe-synchronization-object-modify-status` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://dts.ap-southeast-1.aliyuncs.com | | RegionId | string | no | The ID of the region where the data synchronization instance resides. For more information, see… | | TaskId | string | yes | The task ID, which is returned when you call the https://help.aliyun.com/document_detail/49451.html operation to modify synchronization… | | ClientToken | string | no | The client token that is used to ensure the idempotence of the request. You can use the client to generate the value, but you must make… | | AccountId | string | no | The ID of the Alibaba Cloud account. You do not need to specify this parameter because it will be discontinued | | ResourceGroupId | string | no | The resource group ID | ### Queries all tags that are bound to a data migration, data synchronization, or change tracking instance `POST https://apizie.tech/v1/cloud:aliyun-dts/describe-tag-keys` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://dts.ap-southeast-1.aliyuncs.com | | PageSize | integer | no | The number of tag keys to return on each page. Default value: 20 | | PageNumber | integer | no | The page number. The value must be a positive integer that does not exceed the maximum value of the Integer data type. This parameter is… | | ResourceType | string | no | The resource type. Set the value to ALIYUN::DTS::INSTANCE | | ResourceId | string | no | The ID of the data migration, data synchronization, or change tracking instance. You can call the… | | Category | string | no | The tag type. Valid values: System: tags created by the system. Custom: tags added by users. If this parameter is left empty, publicly… | | RegionId | string | no | The region in which the DTS instance resides. For more information, see https://help.aliyun.com/document_detail/141033.html | | ResourceGroupId | string | no | The resource group ID | ### Queries all values of a tag key that is attached to a data migration, data synchronization, or change… `POST https://apizie.tech/v1/cloud:aliyun-dts/describe-tag-values` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://dts.ap-southeast-1.aliyuncs.com | | PageSize | integer | no | The number of tag values to return per page when a tag key has multiple tag values. Default value: 20 | | PageNumber | integer | no | The page number. Specifies the page to return when a tag key has multiple tag values. The value must be a positive integer that does not… | | ResourceType | string | no | The resource type defined by the system. Set the value to ALIYUN::DTS::INSTANCE | | ResourceId | string | no | The ID of the data migration, data synchronization, or change tracking instance. You can call the… | | Category | string | no | The type of the tag key. Valid values: Custom: a user-added tag key. System: a system-created tag key. If this parameter is left empty,… | | Key | string | no | The key of the tag. This parameter is required | | RegionId | string | no | The region in which the DTS instance resides. For more information, see https://help.aliyun.com/document_detail/141033.html | | ResourceGroupId | string | no | The resource group ID | ### Removes a secondary role `POST https://apizie.tech/v1/cloud:aliyun-dts/detach-gad-instance-db-member` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://dts.ap-southeast-1.aliyuncs.com | | ResourceGroupId | string | no | The resource group ID | | RegionId | string | no | The region ID. Specify this parameter to indicate the region where the instance resides. For more information, see the list of supported… | | InstanceId | string | no | The instance ID of the active geo-redundancy instance group | | SlaveDbInstanceId | string | no | The instance ID of the secondary role | ### Initializes a built-in account in a node of a global active-active database cluster. Data Transmission… `POST https://apizie.tech/v1/cloud:aliyun-dts/init-dts-rds-instance` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://dts.ap-southeast-1.aliyuncs.com | | RegionId | string | no | The region where the global active-active database cluster resides | | EndpointInstanceType | string | no | The instance type of the unit node. Valid values: RDS: ApsaraDB RDS for MySQL instance CEN: self-managed MySQL database connected through… | | EndpointRegion | string | no | The region where the ApsaraDB RDS for MySQL instance resides. This parameter is required if the unit node is an ApsaraDB RDS for MySQL… | | EndpointInstanceId | string | no | The instance ID of the ApsaraDB RDS for MySQL instance. This parameter is required if the unit node is an ApsaraDB RDS for MySQL instance.… | | EndpointCenId | string | no | The CEN instance ID. This parameter is required if the unit node is a self-managed MySQL database connected through CEN. You must specify… | | DtsInstanceId | string | no | The instance ID of the synchronization node | | ResourceGroupId | string | no | The ID of the resource group. This is a global parameter and is not required for this operation | ### Queries all clusters created by the current user, or filters specific clusters based on specified conditions `POST https://apizie.tech/v1/cloud:aliyun-dts/list-dedicated-cluster` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://dts.ap-southeast-1.aliyuncs.com | | RegionId | string | no | The region ID | | Type | string | no | The query key. Valid values: NAME: The cluster name. INSTANCE: The cluster instance ID. DEDICATEDCLUSTERID: The dedicated cluster ID. You… | | Params | string | no | The specific content of the query condition. You must specify Type to define the query key | | State | string | no | The cluster status. Valid values: init: Initializing. schedule: Pending scheduling. running: Running. upgrade: Upgrading. downgrade:… | | OrderDirection | string | no | The sort order. Valid values: asc: Ascending order. This is the default value. desc: Descending order | | OrderColumn | string | no | The sort field when the response contains multiple DTS dedicated cluster instances. Valid values: gmtCreated: Creation time. orderCount:… | | PageSize | integer | no | The number of clusters to return on each page | | PageNumber | integer | no | The page number. The value must be an integer greater than 0 and less than or equal to the maximum value of the Integer data type. Default… | | ResourceGroupId | string | no | The resource group ID | ### Queries the list of job steps `POST https://apizie.tech/v1/cloud:aliyun-dts/list-job-step` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://dts.ap-southeast-1.aliyuncs.com | | DtsJobId | string | yes | The ID of the migration or synchronization task | | RegionId | string | no | The region ID of the DTS instance. For more information, see https://help.aliyun.com/document_detail/141033.html | | ZeroEtlJob | string | no | Specifies whether the task is a seamless integration (Zero-ETL) task. Valid values: true: Yes. false: No | | ResourceGroupId | string | no | The ID of the resource group | ### Queries the tags bound to data migration, data synchronization, and change tracking instances, or queries… `POST https://apizie.tech/v1/cloud:aliyun-dts/list-tag-resources` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://dts.ap-southeast-1.aliyuncs.com | | RegionId | string | yes | The region ID. Specify this parameter to indicate the region where the instances reside. For more information, see… | | ResourceType | string | yes | The resource type. Set the value to ALIYUN::DTS::INSTANCE | | NextToken | string | no | The query token. If a single query does not return all results, you can include the NextToken value returned from the previous query in… | | ResourceId | string | no | The IDs of the data migration, data synchronization, and change tracking instances. You can obtain the instance IDs by calling the… | | Tag | string | no | The tag values that correspond to the tag keys (JSON-encoded) | | ResourceGroupId | string | no | The resource group ID | ### Modifies the information about a consumer group in a change tracking channel `POST https://apizie.tech/v1/cloud:aliyun-dts/modify-consumer-channel` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://dts.ap-southeast-1.aliyuncs.com | | RegionId | string | yes | The ID of the region where the DTS change tracking instance resides. For more information, see… | | DtsInstanceId | string | no | The ID of the change tracking instance. You can call the https://help.aliyun.com/document_detail/209702.html operation to query the… | | DtsJobId | string | no | The ID of the change tracking task. You can call the https://help.aliyun.com/document_detail/209702.html operation to query the task ID.… | | ConsumerGroupId | string | yes | The ID of the consumer group. You can call the https://help.aliyun.com/document_detail/264169.html operation to query the consumer group ID | | ConsumerGroupPassword | string | no | The new password of the consumer group account. The password must contain at least two of the following character types: uppercase… | | ConsumerGroupUserName | string | no | The new username of the consumer group account. The username can contain uppercase letters, lowercase letters, digits, and underscores… | | ConsumerGroupName | string | no | The new name of the consumer group. The name can be up to 128 characters in length. Specify a descriptive name for easy identification | | ResourceGroupId | string | no | The ID of the resource group | ### Modifies the password of a consumer group. This is a legacy operation `POST https://apizie.tech/v1/cloud:aliyun-dts/modify-consumer-group-password` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://dts.ap-southeast-1.aliyuncs.com | | RegionId | string | no | The ID of the region where the change tracking instance resides. For more information, see… | | SubscriptionInstanceId | string | yes | The ID of the change tracking instance. You can call the DescribeSubscriptionInstances operation to query the instance ID | | ConsumerGroupID | string | yes | The ID of the consumer group. You can call the https://help.aliyun.com/document_detail/122886.html operation to query the consumer group ID | | ConsumerGroupName | string | no | The name of the consumer group. You can call the https://help.aliyun.com/document_detail/122886.html operation to query the consumer group… | | ConsumerGroupUserName | string | no | The username of the consumer group. You can call the DescribeConsumerGroup operation to query the username | | ConsumerGroupPassword | string | yes | The current password of the consumer group | | consumerGroupNewPassword | string | yes | The new password of the consumer group. The password must contain characters from at least two of the following categories: uppercase… | | AccountId | string | no | The ID of the Alibaba Cloud account. You do not need to specify this parameter because it will be deprecated | | ResourceGroupId | string | no | The resource group ID | ### Modifies the consumption checkpoint of a change tracking instance channel `POST https://apizie.tech/v1/cloud:aliyun-dts/modify-consumption-timestamp` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://dts.ap-southeast-1.aliyuncs.com | | RegionId | string | no | The region ID. For more information, see https://help.aliyun.com/document_detail/141033.html | | SubscriptionInstanceId | string | yes | The ID of the change tracking instance. You can call the DescribeSubscriptionInstances operation to query the instance ID | | ConsumptionTimestamp | string | yes | The consumption checkpoint. The time is in the yyyy-MM-dd T HH:mm:ss Z format (UTC time) | | AccountId | string | no | The ID of the Alibaba Cloud account. This parameter is not required and will be deprecated | | ResourceGroupId | string | no | The ID of the resource group | ### Modifies the configuration of a dedicated cluster by calling the ModifyDedicatedCluster operation `POST https://apizie.tech/v1/cloud:aliyun-dts/modify-dedicated-cluster` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://dts.ap-southeast-1.aliyuncs.com | | InstanceId | string | no | The instance ID of the cluster. Either the InstanceId or DedicatedClusterId parameter must be specified | | DedicatedClusterId | string | no | The ID of the dedicated cluster. Either InstanceId or DedicatedClusterId must be specified | | DedicatedClusterName | string | no | The name of the cluster | | OversoldRatio | integer | no | The overcommit ratio. Unit: % | | RegionId | string | no | The region in which the DTS instance resides | | ResourceGroupId | string | no | The resource group ID | ### Modifies a data synchronization task `POST https://apizie.tech/v1/cloud:aliyun-dts/modify-dts-job` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://dts.ap-southeast-1.aliyuncs.com | | RegionId | string | no | The region where the instance resides. For more information, see https://help.aliyun.com/document_detail/141033.html | | DtsInstanceId | string | yes | The instance ID of the data synchronization instance | | SynchronizationDirection | string | no | Specifies the synchronization direction. Valid values: Forward: forward synchronization. Reverse: reverse synchronization. Default value:… | | ClientToken | string | no | Ensures the idempotence of the request. You can generate a parameter value from your client to ensure that the value is unique across… | | DbList | string | no | The modified synchronization objects, in the format of a JSON string. For detailed definitions, see… | | EtlOperatorColumnReference | string | no | The dedicated field for T+1 business and ETL operators | | ModifyTypeEnum | string | no | Specifies the method to modify the synchronization task. If you do not specify this parameter, the synchronization objects are modified by… | | Reserved | string | no | The reserved parameters of DTS. The update method is addition rather than overwrite. The format is a MAP JSON string. You can specify this… | | FileOssUrl | string | no | The OSS URL of the synchronization file | | FilterTableName | string | no | The name of the table to be filtered | | StructureInitialization | string | no | Specifies whether to perform schema migration or initial schema synchronization. Valid values: true: yes. false: no | | DataInitialization | string | no | Specifies whether to perform full data migration or initial full data synchronization. Valid values: true: yes. false: no | | DataSynchronization | string | no | Specifies whether to perform incremental data migration or incremental data synchronization. Valid values: false: no. true: yes | | DtsJobId | string | no | The ID of the synchronization task. You can call the https://help.aliyun.com/document_detail/209702.html operation to query the ID | | ZeroEtlJob | string | no | Specifies whether the task is a zero-ETL task. Valid values: true: yes. false: no | | ResourceGroupId | string | no | The ID of the resource group | ### Modifies the parameters of a DTS task by calling the ModifyDtsJobConfig operation `POST https://apizie.tech/v1/cloud:aliyun-dts/modify-dts-job-config` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://dts.ap-southeast-1.aliyuncs.com | | RegionId | string | no | The region in which the instance resides. For more information, see https://help.aliyun.com/document_detail/141033.html | | DtsJobId | string | no | The ID of the DTS task. You can call https://help.aliyun.com/document_detail/209702.html to query the task ID | | Parameters | string | no | The parameters to be modified, in JSON character string format. For more information, see… | | ResourceGroupId | string | no | The resource group ID | ### Changes the dedicated cluster on which a task runs `POST https://apizie.tech/v1/cloud:aliyun-dts/modify-dts-job-dedicated-cluster` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://dts.ap-southeast-1.aliyuncs.com | | DtsJobIds | string | no | The task IDs. The value can be a JSON array that contains multiple task IDs. Separate multiple IDs with commas (,) | | DedicatedClusterId | string | no | The ID of the dedicated cluster | | RegionId | string | no | The region where the DTS instance resides. For more information about the regions supported by dedicated clusters, see… | | ResourceGroupId | string | no | The ID of the resource group | ### Modifies the DU limit for a task `POST https://apizie.tech/v1/cloud:aliyun-dts/modify-dts-job-du-limit` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://dts.ap-southeast-1.aliyuncs.com | | DtsJobId | string | yes | The ID of the DTS data migration, data synchronization, or change tracking task | | DuLimit | integer | yes | The DU limit for the task. The minimum value is 1 | | RegionId | string | no | The region ID | | ResourceGroupId | string | no | The resource group ID | ### Modifies the source or destination instance of a DTS synchronization or migration task `POST https://apizie.tech/v1/cloud:aliyun-dts/modify-dts-job-endpoint` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://dts.ap-southeast-1.aliyuncs.com | | RegionId | string | no | The region to which the DTS instance belongs | | DtsJobId | string | no | The ID of the DTS task. You can call https://help.aliyun.com/document_detail/209702.html to query the task ID. If you do not specify this… | | DtsInstanceId | string | no | The ID of the DTS instance. If you do not specify this parameter, you must specify DtsJobId | | SynchronizationDirection | string | no | The synchronization direction. Valid values: Forward (default): forward. Reverse: reverse | | Endpoint | string | yes | The database instance to be modified. Valid values: src: source instance. dest: destination instance | | EndpointRegionId | string | no | The region to which the database instance belongs | | EndpointInstanceType | string | yes | The type of the database instance. Valid values: rds: ApsaraDB RDS for MySQL or ApsaraDB RDS for PostgreSQL. polardb: PolarDB for MySQL or… | | EndpointInstanceId | string | no | The ID of the database instance | | EndpointIp | string | no | The IP address of the database instance | | EndpointPort | string | no | The port of the database instance | | Database | string | no | The database name when the database type is PostgreSQL, PolarDB for PostgreSQL, or AnalyticDB PostgreSQL. The authentication database name… | | ModifyAccount | string | no | Specifies whether to modify the account and password. Valid values: true: Yes. false (default): No | | Username | string | no | The database account. This parameter takes effect only when ModifyAccount is set to true | | Password | string | no | The database password. This parameter takes effect only when ModifyAccount is set to true | | ShardUsername | string | no | The account of the shard in the MongoDB sharded cluster instance. This parameter is available and required only when the source database… | | ShardPassword | string | no | The password of the shard in the MongoDB sharded cluster instance. This parameter is available and required only when the source database… | | RoleName | string | no | The name of the RAM role for cross-account access. Specify this parameter when performing cross-account data synchronization. For the… | | AliyunUid | string | no | The ID of the Alibaba Cloud account that owns the database instance. Specifying this parameter indicates cross-account data… | | DryRun | string | no | Specifies whether to perform only a dry run. Valid values: true: Yes. After the dry run succeeds, the instance is not modified. false… | | ResourceGroupId | string | no | The resource group ID | | ZeroEtlJob | string | no | Specifies whether this is a seamless integration (zero-ETL) node. Valid values: true: Yes. false: No | | EndpointVpcId | string | no | The VPC ID for Express Connect access | | EndpointPrimaryVswId | string | no | The primary vSwitch for Express Connect access | | EndpointSecondaryVswId | string | no | The secondary vSwitch for Express Connect access | ### Modifies the name of a DTS task `POST https://apizie.tech/v1/cloud:aliyun-dts/modify-dts-job-name` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://dts.ap-southeast-1.aliyuncs.com | | DtsJobId | string | yes | The ID of the data migration, data synchronization, or change tracking task | | DtsJobName | string | yes | The new name of the task. Specify a meaningful name for your business to facilitate identification. The name does not need to be unique | | RegionId | string | no | The region ID of the task. For more information, see https://help.aliyun.com/document_detail/141033.html | | ZeroEtlJob | string | no | Specifies whether the node is a seamless integration (Zero-ETL) node. Valid values: true: Yes. false: No | | ResourceGroupId | string | no | The ID of the resource group | ### Modifies the password of a job `POST https://apizie.tech/v1/cloud:aliyun-dts/modify-dts-job-password` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://dts.ap-southeast-1.aliyuncs.com | | DtsJobId | string | no | The ID of the data migration, data synchronization, or change tracking task | | UserName | string | no | The name of the database account | | Password | string | no | The new password of the database account. This parameter is required and cannot be the same as the current password | | Endpoint | string | no | The database to which the account and password to be modified belong. Valid values: src: The source database. dest: The destination… | | RegionId | string | no | The region ID of the instance. For more information, see https://help.aliyun.com/document_detail/141033.html | | ZeroEtlJob | string | no | Specifies whether the node is a seamless integration (Zero-ETL) node. Valid values: true: Yes. false: No | | DtsInstanceId | string | no | The instance ID of the data migration, data synchronization, or subscribe instance | | SynchronizationDirection | string | no | Specifies the synchronization direction. Valid values: Forward: Forward. Reverse: Reverse. Default value: Forward. This parameter is… | | ResourceGroupId | string | no | The ID of the resource group | ### Adjusts the migration rate of a data synchronization or migration instance `POST https://apizie.tech/v1/cloud:aliyun-dts/modify-dynamic-config` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://dts.ap-southeast-1.aliyuncs.com | | DtsJobId | string | yes | The ID of the data synchronization or migration task. You can call https://help.aliyun.com/document_detail/209702.html to obtain the task ID | | JobCode | string | yes | The task code. Valid values: 03: full data synchronization or migration task. 04: incremental data migration task. 07: incremental data… | | RegionId | string | no | The ID of the region where the DTS instance resides. For more information, see https://help.aliyun.com/document_detail/141033.html | | ConfigList | string | no | The rate limit configurations. dts.datamove.blaster.qps.max: the queries per second (QPS) for querying the source database.… | | EnableLimit | string | no | Specifies whether to limit the migration rate of the full data synchronization or migration task. Valid values: true and false. This… | | ResourceGroupId | string | no | The resource group ID | ### Modifies the name of a Global Active Database (GAD) instance `POST https://apizie.tech/v1/cloud:aliyun-dts/modify-gad-instance-name` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://dts.ap-southeast-1.aliyuncs.com | | ResourceGroupId | string | no | The resource group ID | | RegionId | string | no | The region ID of the task. For more information, see https://help.aliyun.com/document_detail/141033.html | | InstanceId | string | no | The instance ID of the active geo-redundancy instance group | | InstanceName | string | no | The instance name of the active geo-redundancy instance group | ### Modify the offset for incremental data writing `POST https://apizie.tech/v1/cloud:aliyun-dts/modify-job-step-checkpoint` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://dts.ap-southeast-1.aliyuncs.com | | RegionId | string | yes | The region where the DTS instance resides. For regions that support dedicated clusters, see… | | DtsJobId | string | no | The ID of the migration, synchronization, or tracking task | | JobStepId | string | no | The task step ID, which corresponds to the synchronization step ID returned by the ListJobStep API | | NewCheckPoint | integer | no | The new offset as a UNIX timestamp in seconds. The specified value must fall within the offset range of the incremental data collection step | | ResourceGroupId | string | no | The ID of the resource group | ### Modifies a change tracking task (new version) `POST https://apizie.tech/v1/cloud:aliyun-dts/modify-subscription` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://dts.ap-southeast-1.aliyuncs.com | | RegionId | string | no | The region in which the DTS instance resides. For more information, see https://help.aliyun.com/document_detail/141033.html | | DtsInstanceId | string | no | The ID of the change tracking instance. You can call https://help.aliyun.com/document_detail/209702.html to query the instance ID | | DbList | string | no | The modified subscription objects, in JSON format. For more information about the definition, see… | | DtsJobId | string | no | The ID of the change tracking task. You can call https://help.aliyun.com/document_detail/209702.html to query the task ID | | SubscriptionDataTypeDDL | string | no | Specifies whether the modified task subscribes to DDL data. Valid values: true: The task subscribes to DDL data. false: The task does not… | | SubscriptionDataTypeDML | string | no | Specifies whether the modified task subscribes to DML data. Valid values: true: The task subscribes to DML data. false: The task does not… | | ResourceGroupId | string | no | The ID of the resource group | | Reserved | string | no | The Reserved | | ModifyType | string | no | The ModifyType | ### Modifies the subscription objects of a change tracking task. This is a legacy operation `POST https://apizie.tech/v1/cloud:aliyun-dts/modify-subscription-object` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://dts.ap-southeast-1.aliyuncs.com | | RegionId | string | no | The region ID. Specify this parameter to indicate the region where the instance resides. For more information, see… | | SubscriptionInstanceId | string | yes | The ID of the change tracking instance. You can call the https://help.aliyun.com/document_detail/49442.html operation to query the… | | SubscriptionObject | string | yes | The subscription objects. The value is a JSON string that supports regular expressions. For more information, see… | | AccountId | string | no | The ID of the Alibaba Cloud account. You do not need to specify this parameter because this parameter is about to be deprecated | | ResourceGroupId | string | no | The resource group ID | ### Modifies the synchronization objects in a legacy data synchronization job instance `POST https://apizie.tech/v1/cloud:aliyun-dts/modify-synchronization-object` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://dts.ap-southeast-1.aliyuncs.com | | RegionId | string | no | The region ID. For more information, see https://help.aliyun.com/document_detail/141033.html | | SynchronizationJobId | string | yes | Instance ID of the data synchronization instance. You can call the https://help.aliyun.com/document_detail/49454.html operation to query… | | SynchronizationObjects | string | yes | The modified synchronization objects. The value is a JSON string and supports specific regular expressions. For more information, see… | | SynchronizationDirection | string | no | The synchronization direction. Valid values: Forward: Forward. Reverse: Reverse. Default value: Forward. This parameter is required only… | | AccountId | string | no | The ID of the Alibaba Cloud account. You do not need to specify this parameter because it will soon be deprecated | | ResourceGroupId | string | no | The ID of the resource group | ### Prechecks the creation of a GAD order `POST https://apizie.tech/v1/cloud:aliyun-dts/pre-check-create-gad-order` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://dts.ap-southeast-1.aliyuncs.com | | ResourceGroupId | string | no | The ID of the resource group | | RegionId | string | no | The region where the DTS instance resides. For more information, see https://help.aliyun.com/document_detail/141033.html | | InstanceId | string | no | The ID of the global active instance group | | SlaveDbInstanceId | string | no | The instance ID of the secondary database | | SlaveDbInstanceRegion | string | no | The region of the secondary database instance | | MasterDatabaseName | string | no | The name of the primary database | | MasterEngineArchType | string | no | The MasterEngineArchType | | MasterShardAccountName | string | no | The MasterShardAccountName | | MasterShardAccountPassword | string | no | The MasterShardAccountPassword | | SlaveDatabaseName | string | no | The name of the secondary database | | SlaveEngineArchType | string | no | The architecture type of the secondary database engine | ### Promotes a secondary geo-disaster recovery instance to the primary role `POST https://apizie.tech/v1/cloud:aliyun-dts/promote-to-master` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://dts.ap-southeast-1.aliyuncs.com | | RegionId | string | no | The region ID. Specify this parameter to indicate the region where the instance resides. For more information, see the list of supported… | | InstanceId | string | no | The instance ID | | MasterDbInstanceId | string | no | The instance ID of the primary instance | | SlaveDbInstanceId | string | no | The instance ID of the secondary instance | | ResourceGroupId | string | no | The resource group ID | ### Renews a Data Transmission Service (DTS) instance. This operation is applicable only to subscription DTS… `POST https://apizie.tech/v1/cloud:aliyun-dts/renew-instance` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://dts.ap-southeast-1.aliyuncs.com | | DtsJobId | string | yes | The ID of the synchronization or change tracking task. You can call the https://help.aliyun.com/document_detail/209702.html operation to… | | ChargeType | string | yes | The billing method. Set the value to PREPAY, which indicates the subscription billing method | | Period | string | no | The billing method for the renewed instance. Valid values: Year: Yearly. Month: Monthly. This is the default value | | BuyCount | string | no | The subscription duration of the renewed instance. Default value: 1. If Period is set to Year, valid values are 1 to 5. If Period is set… | | RegionId | string | no | The region ID of the DTS instance. For more information, see https://help.aliyun.com/document_detail/141033.html | | ResourceGroupId | string | no | The ID of the resource group | ### Resets a data synchronization or change tracking task `POST https://apizie.tech/v1/cloud:aliyun-dts/reset-dts-job` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://dts.ap-southeast-1.aliyuncs.com | | DtsJobId | string | no | The ID of the data synchronization or change tracking task | | DtsInstanceId | string | no | The ID of the data synchronization or subscribe instance | | SynchronizationDirection | string | no | The synchronization direction. Valid values: Forward: Forward. Reverse: Reverse. Default value: Forward. You can set this parameter to… | | RegionId | string | no | The region where the DTS instance resides. For more information, see https://help.aliyun.com/document_detail/141033.html | | ResourceGroupId | string | no | The ID of the resource group | ### Resets the configuration of a data synchronization task `POST https://apizie.tech/v1/cloud:aliyun-dts/reset-synchronization-job` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://dts.ap-southeast-1.aliyuncs.com | | RegionId | string | no | The region ID. Specify this parameter to indicate the region where the instance resides. For more information, see… | | SynchronizationJobId | string | yes | The ID of the data synchronization instance. You can call the DescribeSynchronizationJobs operation to query the instance ID | | SynchronizationDirection | string | no | The synchronization direction. Valid values: Forward: forward. Reverse: reverse. Default value: Forward. You can set this parameter to… | | AccountId | string | no | The ID of the Alibaba Cloud account. You do not need to specify this parameter because this parameter is about to be discontinued | | ResourceGroupId | string | no | The resource group ID | ### Skips the precheck for a legacy data migration or synchronization task `POST https://apizie.tech/v1/cloud:aliyun-dts/shield-precheck` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://dts.ap-southeast-1.aliyuncs.com | | RegionId | string | no | The ID of the region where the instance resides. For more information, see https://help.aliyun.com/document_detail/141033.html | | DtsInstanceId | string | yes | The ID of the data migration or synchronization instance. You can call the DescribeMigrationJobs or DescribeSynchronizationJobs operation… | | PrecheckItems | string | yes | The precheck items to skip. Separate multiple items with commas (,). Valid values: CHECK_SAME_OBJ: checks whether objects with the same… | | ResourceGroupId | string | no | The resource group ID | ### Skips tables that do not need to be synchronized during the full data phase `POST https://apizie.tech/v1/cloud:aliyun-dts/skip-full-job-table` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://dts.ap-southeast-1.aliyuncs.com | | DtsJobId | string | no | The ID of the data migration, data synchronization, or change tracking task. [Deprecated] This parameter is deprecated and no longer takes… | | RegionId | string | no | The region where the DTS instance resides. For more information, see https://help.aliyun.com/document_detail/141033.html | | JobProgressId | string | no | The primary key ID of JobProgress. Each object in a full data migration task corresponds to a JobProgress record. Specify this parameter… | | ZeroEtlJob | string | no | Specifies whether the node is a seamless integration (Zero-ETL) node. Valid values: true: yes false: no | | ResourceGroupId | string | no | The ID of the resource group | ### Suppresses or unsuppresses precheck alert items `POST https://apizie.tech/v1/cloud:aliyun-dts/skip-pre-check` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://dts.ap-southeast-1.aliyuncs.com | | JobId | string | no | The ID of the precheck task. You can call DescribePreCheckStatus to query the ID | | Skip | string | yes | Specifies whether to suppress the precheck item. Valid values: true: Suppress the precheck item. false: Unsuppress the precheck item | | SkipPreCheckItems | string | no | The abbreviated names of the precheck items to suppress or unsuppress. Valid values: ["CHECK_SAME_OBJ"]: check for objects with the same… | | SkipPreCheckNames | string | no | The full names of the precheck items to suppress or unsuppress. This parameter corresponds to the SkipPreCheckItems parameter. Valid… | | DtsJobId | string | yes | The ID of the data migration, data synchronization, or change tracking task | | RegionId | string | no | The region in which the DTS instance resides. For more information, see https://help.aliyun.com/document_detail/141033.html | | ResourceGroupId | string | no | The resource group ID | ### Starts a data migration, data synchronization, or change tracking task by calling the StartDtsJob operation `POST https://apizie.tech/v1/cloud:aliyun-dts/start-dts-job` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://dts.ap-southeast-1.aliyuncs.com | | DtsJobId | string | no | The ID of the data migration, data synchronization, or change tracking task | | DtsInstanceId | string | no | The ID of the data migration, data synchronization, or change tracking instance. You can query the instance ID by invoking… | | SynchronizationDirection | string | no | The synchronization direction. Valid values: Forward: forward. This is the default value. Reverse: reverse. You can set this parameter to… | | RegionId | string | no | The region in which the DTS instance resides. For more information, see https://help.aliyun.com/document_detail/141033.html | | ZeroEtlJob | string | no | Specifies whether the node is a zero-ETL node. Valid values: false: no. true: yes | | ResourceGroupId | string | no | The resource group ID | ### Starts multiple data migration or synchronization tasks in a batch by calling the StartDtsJobs operation `POST https://apizie.tech/v1/cloud:aliyun-dts/start-dts-jobs` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://dts.ap-southeast-1.aliyuncs.com | | DtsJobIds | string | yes | The IDs of the data migration or synchronization tasks. Separate multiple task IDs with commas (,). You can call… | | RegionId | string | no | The region in which the DTS instance resides. For more information, see https://help.aliyun.com/document_detail/141033.html | | ZeroEtlJob | string | no | Specifies whether the node is a seamless integration (zero-ETL) node. Valid values: false: No. true: Yes | | ResourceGroupId | string | no | The resource group ID | ### Starts a data migration task of Data Transmission Service (DTS) `POST https://apizie.tech/v1/cloud:aliyun-dts/start-migration-job` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://dts.ap-southeast-1.aliyuncs.com | | RegionId | string | no | The region ID. Specify this parameter to indicate the region where the instance resides. For more information, see… | | MigrationJobId | string | yes | Instance ID of the data migration instance. You can call the DescribeMigrationJobs operation to query instance ID | | AccountId | string | no | The ID of the Alibaba Cloud account. You do not need to specify this parameter because this parameter is about to be deprecated | | ResourceGroupId | string | no | The ID of the resource group | ### Starts a reverse task that is created by calling the CreateReverseDtsJob operation `POST https://apizie.tech/v1/cloud:aliyun-dts/start-reverse-writer` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://dts.ap-southeast-1.aliyuncs.com | | DtsJobId | string | yes | The ID of the task generated by calling the CreateReverseDtsJob operation | | CheckPoint | string | no | The checkpoint of the incremental write module. The value is a UNIX timestamp. Default value: the checkpoint that is automatically saved… | | ResourceGroupId | string | no | The resource group ID. This is a global parameter and does not need to be passed in for this operation | ### Starts the channel for a legacy change tracking instance `POST https://apizie.tech/v1/cloud:aliyun-dts/start-subscription-instance` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://dts.ap-southeast-1.aliyuncs.com | | RegionId | string | no | The ID of the region where the change tracking instance resides. For more information, see… | | SubscriptionInstanceId | string | yes | The ID of the change tracking instance. You can call the https://help.aliyun.com/document_detail/49442.html operation to query the… | | AccountId | string | no | The ID of the Alibaba Cloud account. You do not need to specify this parameter. This parameter will be deprecated soon | | ResourceGroupId | string | no | The ID of the resource group | ### Starts a data synchronization task `POST https://apizie.tech/v1/cloud:aliyun-dts/start-synchronization-job` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://dts.ap-southeast-1.aliyuncs.com | | RegionId | string | no | The ID of the region where the data synchronization instance resides. For more information, see… | | SynchronizationJobId | string | yes | Instance ID of the data synchronization instance. You can call the DescribeSynchronizationJobs operation to query instance ID | | SynchronizationDirection | string | no | The synchronization direction. Valid values: Forward: Forward. Reverse: Reverse. Default value: Forward. You can set this parameter to… | | AccountId | string | no | The ID of the Alibaba Cloud account. You do not need to specify this parameter. This parameter will be deprecated | | ResourceGroupId | string | no | The ID of the resource group | ### Releases a dedicated cluster `POST https://apizie.tech/v1/cloud:aliyun-dts/stop-dedicated-cluster` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://dts.ap-southeast-1.aliyuncs.com | | InstanceId | string | no | The instance ID. You must specify either the InstanceId or DedicatedClusterId parameter | | DedicatedClusterId | string | no | The dedicated cluster ID. You must specify either the InstanceId or DedicatedClusterId parameter | | DedicatedClusterName | string | no | The dedicated cluster name | | RegionId | string | no | The region where the instance resides | | ResourceGroupId | string | no | The resource group ID. This is a global parameter and is not required for this API operation | ### Stops a data migration, data synchronization, or change tracking task `POST https://apizie.tech/v1/cloud:aliyun-dts/stop-dts-job` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://dts.ap-southeast-1.aliyuncs.com | | DtsJobId | string | no | The ID of the data migration, data synchronization, or change tracking task | | DtsInstanceId | string | no | The ID of the data migration, data synchronization, or subscribe instance | | SynchronizationDirection | string | no | The synchronization direction. Valid values: Forward: Forward synchronization. Reverse: Reverse synchronization. Default value: Forward.… | | RegionId | string | no | The region where the DTS instance resides. For more information, see https://help.aliyun.com/document_detail/141033.html | | ZeroEtlJob | string | no | Specifies whether the task is a seamless integration (Zero-ETL) task. Valid values: false: No. true: Yes | | ResourceGroupId | string | no | The ID of the resource group | ### Stops multiple DTS tasks `POST https://apizie.tech/v1/cloud:aliyun-dts/stop-dts-jobs` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://dts.ap-southeast-1.aliyuncs.com | | DtsJobIds | string | yes | The IDs of the migration and synchronization tasks. Separate multiple task IDs with commas (,). Call the… | | RegionId | string | no | The region where the DTS instance resides. For more information, see https://help.aliyun.com/document_detail/141033.html | | ZeroEtlJob | string | no | Specifies whether the node is a seamless integration (Zero-ETL) node. Valid values: false: No. true: Yes | | ResourceGroupId | string | no | The ID of the resource group | ### Ends a data migration task that is in the migrating state `POST https://apizie.tech/v1/cloud:aliyun-dts/stop-migration-job` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://dts.ap-southeast-1.aliyuncs.com | | RegionId | string | no | The region ID. Specify this parameter to indicate the region where the instance resides. For more information, see… | | MigrationJobId | string | yes | Instance ID of the data migration instance. You can call the DescribeMigrationJobs operation to query instance ID | | ClientToken | string | no | The client token that is used to ensure the idempotence of the request. You can use the client to generate the token, but you must make… | | AccountId | string | no | The ID of the Alibaba Cloud account. You do not need to specify this parameter. This parameter is about to be deprecated | | ResourceGroupId | string | no | The ID of the resource group | ### Queries the number of migrated tables in a Data Transmission Service (DTS) data migration or synchronization… `POST https://apizie.tech/v1/cloud:aliyun-dts/summary-job-detail` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://dts.ap-southeast-1.aliyuncs.com | | DtsJobId | string | yes | The ID of the migration or synchronization task | | JobCode | string | yes | The migration phase. Valid values: 02: schema migration phase. 03: incremental data migration phase | | SynchronizationDirection | string | no | The direction of the synchronization link. Valid values: Forward: forward. Reverse: reverse. Default value: Forward. You can set this… | | RegionId | string | no | The region where the DTS instance resides. For more information, see https://help.aliyun.com/document_detail/141033.html | | DtsInstanceId | string | no | The migration or synchronization instance ID | | StructType | string | no | The type of schema definition. Valid values: before: schema migration or initial schema synchronization for databases and tables. after:… | | ZeroEtlJob | string | no | Specifies whether the node is a seamless integration (Zero-ETL) node. Valid values: true: yes. false: no | | ResourceGroupId | string | no | The ID of the resource group | ### Suspends a data migration or synchronization task. Change tracking tasks are not supported. Change tracking… `POST https://apizie.tech/v1/cloud:aliyun-dts/suspend-dts-job` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://dts.ap-southeast-1.aliyuncs.com | | DtsJobId | string | no | The ID of the data migration, synchronization, or change tracking task. You can call the… | | DtsInstanceId | string | no | The migration, synchronization, or subscribe instance ID | | SynchronizationDirection | string | no | The synchronization direction. Valid values: Forward: forward. Reverse: reverse. The default value is Forward. You can set this parameter… | | RegionId | string | no | The region in which the DTS instance resides. For more information, see https://help.aliyun.com/document_detail/141033.html | | ZeroEtlJob | string | no | Specifies whether the node is a seamless integration (Zero-ETL) node. Valid values: false: no. true: yes | | ResourceGroupId | string | no | The resource group ID | ### Suspends multiple DTS tasks at a time `POST https://apizie.tech/v1/cloud:aliyun-dts/suspend-dts-jobs` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://dts.ap-southeast-1.aliyuncs.com | | DtsJobIds | string | yes | The IDs of the migration or synchronization tasks. Separate multiple task IDs with commas (,). Call… | | RegionId | string | no | The region in which the DTS instance resides. For more information, see https://help.aliyun.com/document_detail/141033.html | | ZeroEtlJob | string | no | Specifies whether the node is a seamless integration (Zero-ETL) node. Valid values: false: No. true: Yes | | ResourceGroupId | string | no | The resource group ID | ### Suspends a data migration task that is in progress `POST https://apizie.tech/v1/cloud:aliyun-dts/suspend-migration-job` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://dts.ap-southeast-1.aliyuncs.com | | RegionId | string | no | The region ID. Specify this parameter to indicate the region where the instance resides. For more information, see… | | MigrationJobId | string | yes | Instance ID of the data migration instance. You can call the DescribeMigrationJobs operation to query instance ID | | ClientToken | string | no | The client token that is used to ensure the idempotence of the request. Generate a value from your client to ensure uniqueness across… | | AccountId | string | no | The ID of the Alibaba Cloud account. You do not need to specify this parameter because this parameter will be discontinued | | ResourceGroupId | string | no | The resource group ID | ### Pauses a data synchronization task that is in the Synchronizing state `POST https://apizie.tech/v1/cloud:aliyun-dts/suspend-synchronization-job` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://dts.ap-southeast-1.aliyuncs.com | | RegionId | string | no | The region ID. Specify this parameter to indicate the region where the instance resides. For more information, see… | | SynchronizationJobId | string | yes | Instance ID of the data synchronization instance. You can call the DescribeSynchronizationJobs operation to query instance ID | | SynchronizationDirection | string | no | The synchronization direction. Valid values: Forward: forward. Reverse: reverse. Default value: Forward. You can set this parameter to… | | AccountId | string | no | The ID of the Alibaba Cloud account. You do not need to specify this parameter because this parameter is about to be deprecated | | ResourceGroupId | string | no | The resource group ID | ### Performs physical migration of an MSSQL database to Alibaba Cloud `POST https://apizie.tech/v1/cloud:aliyun-dts/switch-physical-dts-job-to-cloud` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://dts.ap-southeast-1.aliyuncs.com | | DtsJobId | string | no | The ID of the data migration or synchronization task. You can call the DescribeDtsJobs operation to query the ID | | DtsInstanceId | string | no | The ID of the migration, synchronization, or change tracking instance | | SynchronizationDirection | string | no | The synchronization direction. Valid values: Forward: forward. Reverse: reverse. Default value: Forward. You can set this parameter to… | | RegionId | string | no | The region ID. Specify this parameter to indicate the region where the instance resides. For more information, see the list of supported… | | ResourceGroupId | string | no | The resource group ID | ### Passes the connection information of the new database to DTS after a primary/secondary switchover. DTS… `POST https://apizie.tech/v1/cloud:aliyun-dts/switch-synchronization-endpoint` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://dts.ap-southeast-1.aliyuncs.com | | RegionId | string | no | The region ID. Specify this parameter to indicate the region where the instance resides. For more information, see… | | SynchronizationJobId | string | yes | Instance ID of the data synchronization instance. You can call the DescribeSynchronizationJobs operation to query instance ID | | SynchronizationDirection | string | no | The synchronization direction. Valid values: Forward: forward. Reverse: reverse. Default value: Forward. The value Reverse takes effect… | | Endpoint.Type | string | yes | 待调整连接信息的实例，取值： Source：源实例。 Destination：目标实例 | | Endpoint.InstanceType | string | yes | 新数据库所属的实例类型，取值： LocalInstance：有公网IP的自建数据库； ECS：ECS上的自建数据库。 Express：通过专线接入的自建数据库 | | Endpoint.InstanceId | string | yes | ECS或专有网络的实例ID。 当Endpoint.InstanceType取值为ECS时，本参数需传入ECS实例的ID。 当Endpoint.InstanceType取值为Express时，本参数需传入专有网络ID | | Endpoint.IP | string | no | 新数据库的IP地址。 当Endpoint.InstanceType取值为Express时，本参数才可用且必须传入 | | Endpoint.Port | string | yes | 新的数据库服务端口 | | SourceEndpoint.OwnerID | string | no | 当源实例与目标实例所属阿里云账号不同时，您需要传入该参数指定源实例的所属阿里云账号的ID | | SourceEndpoint.Role | string | no | 当源实例与目标实例所属阿里云账号不同时，需传入该参数，来指定源实例的授权角色，以允许目标实例阿里云账号访问源实例的实例信息。 角色所需的权限及授权方式，请参见https://help.aliyun.com/document_detail/48468.html | | AccountId | string | no | The Alibaba Cloud account ID. You do not need to specify this parameter because it will be deprecated | | ResourceGroupId | string | no | The resource group ID | ### Binds tags to one or more data migration, synchronization, and change tracking instances by calling the… `POST https://apizie.tech/v1/cloud:aliyun-dts/tag-resources` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://dts.ap-southeast-1.aliyuncs.com | | RegionId | string | yes | The region ID. Specify this parameter to indicate the region where the instance resides. For more information, see… | | ResourceType | string | no | The resource type. Set the value to ALIYUN::DTS::INSTANCE | | ResourceId | string | yes | The ID of the data migration, synchronization, or change tracking instance. You can call the… | | Tag | string | yes | The list of tags (key-value pairs) to bind (JSON-encoded) | | ResourceGroupId | string | no | The resource group ID | ### Upgrades or downgrades the specifications of a DTS instance `POST https://apizie.tech/v1/cloud:aliyun-dts/transfer-instance-class` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://dts.ap-southeast-1.aliyuncs.com | | OrderType | string | yes | Set this parameter to UPGRADE | | InstanceClass | string | yes | The instance specifications after the upgrade. You can call https://help.aliyun.com/document_detail/208925.html to query the instance… | | RegionId | string | no | The ID of the region in which the DTS instance resides. For more information, see https://help.aliyun.com/document_detail/141033.html | | DtsJobId | string | yes | The ID of the data migration or data synchronization task. You can call https://help.aliyun.com/document_detail/209702.html to query the… | | ResourceGroupId | string | no | The resource group ID | | DatabaseCount | integer | no | The DatabaseCount | …and 5 more. See the OpenAPI spec. ## Example ``` curl "https://apizie.tech/v1/cloud:aliyun-dts/configure-dts-job" \ -H "x-api-key: $APIZIE_KEY" \ -H "x-upstream-key: $PROVIDER_KEY" ``` ## FAQ ### How do I call the Alibaba Cloud Data Transmission API? Create a free Apizie key, then send POST https://apizie.tech/v1/cloud:aliyun-dts/configure-dts-job with the header x-api-key. Every endpoint returns { project, data, timestamp }. ### Is the Alibaba Cloud Data Transmission API free on Apizie? Yes. The Free plan includes 1,000 requests a month at 100 requests a minute, no credit card. Alibaba Cloud Data Transmission itself also needs your own key from aliyuncs.com. ### Can AI agents use the Alibaba Cloud Data Transmission API? Yes. Add the Apizie MCP server (https://apizie.tech/mcp) to Claude, ChatGPT, Cursor or VS Code, then ask in plain language. The agent calls run_scraper with project key cloud:aliyun-dts. ### What is the status of the Alibaba Cloud Data Transmission API? Needs your own provider key (bring your own key)