All Products
Search

This Product

    Data Transmission Service:ConfigureDtsJob

    Document Center

    Data Transmission Service:ConfigureDtsJob

    Last Updated:Jun 20, 2025

    Configures a data migration or synchronization task.

    • You can make the corresponding pre-configurations in the console according to your needs, and then preview the corresponding OpenAPI parameter information to help you fill in the request parameters. For more information, see Preview OpenAPI request parameters.
    • For Data Transmission Service (DTS) instances that run on a dedicated cluster, you must deploy them first. Then, you can purchase such an instance. Additionally, DTS dedicated clusters do not support DTS tasks that are configured to migrate or synchronize data across regions.

    Debug

    You can use OpenAPI Explorer to perform debugging. OpenAPI Explorer allows you to perform various operations to simplify API usage. For example, you can retrieve APIs, call APIs, and dynamically generate SDK example code.

    Request parameters

    Name

    Type

    Required

    Example

    Description
    Action String Yes ConfigureDtsJob

    The operation that you want to perform. Set the value to ConfigureDtsJob.
    DtsJobName String Yes rdsmysql_to_mysql

    The name of the DTS task.
    SourceEndpointInstanceType String Yes RDS

    The type of the source instance. Valid values:

    Alibaba Cloud database
    • RDS: ApsaraDB RDS for MySQL, ApsaraDB RDS for SQL Server, ApsaraDB RDS for PostgreSQL, or ApsaraDB RDS for MariaDB.
    • PolarDB: PolarDB for MySQL.
    • REDIS: ApsaraDB for Redis or Tair (compatible with Redis).
    • DISTRIBUTED_POLARDBX10: PolarDB-X 1.0 (formerly DRDS).
    • POLARDBX20: PolarDB-X 2.0.
    • MONGODB: ApsaraDB for MongoDB.
    • DISTRIBUTED_DMSLOGICDB: Data Management (DMS) logical database.
    Self-managed database
    • OTHER: self-managed database with a public IP address.
    • ECS: self-managed database on ECS.
    • EXPRESS: self-managed database connected over Express Connect.
    • CEN: self-managed database connected over Cloud Enterprise Network (CEN).
    • DG: self-managed database connected over Database Gateway.
    Note
    • If the source instance is a PolarDB for PostgreSQL (Compatible with Oracle) cluster, you must select OTHER or EXPRESS as the source instance type. The PolarDB for PostgreSQL (Compatible with Oracle) cluster is considered as a self-managed database that is connected over a public IP address or Express Connect.
      Note
      • For more information about the supported source and destination databases, see Supported databases.
        Note
        • If the source instance is a self-managed database, you must perform the required preparations. For more information, see Overview of preparations.
    SourceEndpointInstanceID String No rm-bp1imrtn6fq7h****

    The ID of the source instance.

    If the source instance is an Alibaba Cloud database instance, you must specify the database instance ID. For example, if the source instance is an ApsaraDB RDS for MySQL instance, you must specify the ID of the ApsaraDB RDS for MySQL instance.

    If the source instance is a self-managed database, the value of this parameter varies based on the value of SourceEndpointInstanceType. For example, if SourceEndpointInstanceType is set to:

    • ECS: You must specify the ID of the ECS instance.
    • DG: You must specify the ID of the database gateway.
    • EXPRESS or CEN: You must specify the ID of the VPC that is connected to the source database.
    Note If SourceEndpointInstanceType is set to CEN, you must also specify the ID of the CEN instance in the Reserve parameter. For more information, see Description of the Reserve parameter.
    SourceEndpointEngineName String No MYSQL

    The database engine of the source instance.

    • MYSQL: MySQL database, including ApsaraDB RDS for MySQL and self-managed MySQL.
    • MARIADB: ApsaraDB RDS for MariaDB.
    • PolarDB: PolarDB for MySQL.
    • POLARDB_O: PolarDB for PostgreSQL (Compatible with Oracle).
    • POLARDBX10: PolarDB-X 1.0 (formerly DRDS).
    • POLARDBX20: PolarDB-X 2.0.
    • ORACLE: self-managed Oracle.
    • POSTGRESQL: PostgreSQL database, including ApsaraDB RDS for PostgreSQL and self-managed PostgreSQL.
    • MSSQL: SQL Server database, including ApsaraDB RDS for SQL Server and self-managed SQL Server.
    • MONGODB: MongoDB database, including self-managed MongoDB and ApsaraDB for MongoDB.
    • DB2: self-managed DB2 LUW.
    • AS400: self-managed Db2 for i.
    • DMSPOLARDB: DMS logical database.
    • HBASE: self-managed HBase database.
    • TERADATA: Teradata database.
    • TiDB: TiDB database.
    • REDIS: Redis database, including self-managed Redis and ApsaraDB for Redis or Tair (compatible with Redis).
    Note
    • Default value: MYSQL.
    • If the database engine of the source instance is MONGODB, you must also specify some information in the Reserve parameter. For more information, see Description of the Reserve parameter.
    SourceEndpointRegion String No cn-hangzhou

    The region where the source instance resides. For more information, see Supported regions.

    Note If the source instance is an Alibaba Cloud database instance, this parameter is required.
    SourceEndpointIP String No 172.16.**.***

    The IP address of the source instance.

    Note This parameter is valid and required only if SourceEndpointInstanceType is set to OTHER, EXPRESS, DG, or CEN.
    SourceEndpointPort String No 3306

    The database service port of the source instance.

    Note This parameter is required only when the source instance is a self-managed database.
    SourceEndpointOracleSID String No testsid

    The system ID (SID) of the Oracle database.

    Note This parameter is valid and required only if SourceEndpointEngineName is set to OracleOracle and the Oracle database is a non-RAC instance.
    SourceEndpointDatabaseName String No dtstestdatabase

    The name of the database from which the objects are migrated or synchronized in the source instance.

    Note This parameter is required only when the source instance is a PolarDB for PostgreSQL cluster (compatible with Oracle), a PostgreSQL database, or a MongoDB database.
    SourceEndpointUserName String No dtstest

    The database account of the source database.

    Note
    SourceEndpointPassword String No Test123456

    The password of the account that is used to log on to the source database.
    SourceEndpointOwnerID String No 140692647406****

    The ID of the Alibaba Cloud account to which the source database belongs.

    Note If you specify this parameter, it indicates that you want to perform data migration or synchronization across Alibaba Cloud accounts. In this case, you must also specify the SourceEndpointRole parameter.
    SourceEndpointRole String No ram-for-dts

    The name of the Resource Access Management (RAM) role configured for the Alibaba Cloud account to which the source database belongs.

    Note This parameter is required when you perform data migration or synchronization across Alibaba Cloud accounts. For more information about the permissions that are required for the RAM role and how to grant the permissions, see Configure RAM authorization for data migration or synchronization from an instance attached to one Alibaba Cloud account to an instance attached to another Alibaba Cloud account.
    DestinationEndpointInstanceType String Yes EXPRESS

    The type of the destination instance. Valid values:

    Alibaba Cloud database
    • RDS: ApsaraDB RDS for MySQL, ApsaraDB RDS for SQL Server, ApsaraDB RDS for PostgreSQL, or ApsaraDB RDS for MariaDB.
    • PolarDB: PolarDB for MySQL.
    • DISTRIBUTED_POLARDBX10: PolarDB-X 1.0 (formerly DRDS).
    • POLARDBX20: PolarDB-X 2.0.
    • REDIS: ApsaraDB for Redis or Tair (compatible with Redis).
    • ADS: AnalyticDB for MySQL 2.0 or 3.0.
    • MONGODB: ApsaraDB for MongoDB.
    • GREENPLUM: AnalyticDB for PostgreSQL.
    • DATAHUB: DataHub.
    • ELK: Elasticsearch.
    • Tablestore: Tablestore.
    • ODPS: MaxCompute.
    Self-managed database
    • OTHER: self-managed database with a public IP address.
    • ECS: self-managed database on ECS.
    • EXPRESS: self-managed database connected over Express Connect.
    • CEN: self-managed database connected over CEN.
    • DG: self-managed database connected over Database Gateway.
    Note
    • If the destination instance is a PolarDB for PostgreSQL (Compatible with Oracle) cluster, you must select OTHER or EXPRESS as the destination instance type. The PolarDB for PostgreSQL (Compatible with Oracle) cluster is considered as a self-managed database that is connected over a public IP address or Express Connect.
    • If the destination instance is Message Queue for Apache Kafka, you must select ECS or EXPRESS as the destination instance type. Message Queue for Apache Kafka is considered as a self-managed database that is connected over ECS or Express Connect.
    • For more information about the supported source and destination databases, see Supported source and destination databases.
    • If the destination instance is a self-managed database, you must perform the required preparations. For more information, see Overview of preparations.
    DestinationEndpointInstanceID String No vpc-bp1opxu1zkhn00gzv****

    The ID of the destination instance.

    If the destination instance is an Alibaba Cloud database instance, you must specify the database instance ID. For example, if the destination instance is an ApsaraDB RDS for MySQL instance, you must specify the ID of the ApsaraDB RDS for MySQL instance.

    If the destination instance is a self-managed database, the value of this parameter varies based on the value of DestinationEndpointInstanceType. For example, if DestinationEndpointInstanceType is set to:

    • ECS: You must specify the ID of the ECS instance.
    • DG: You must specify the ID of the database gateway.
    • EXPRESS or CEN: You must specify the ID of the VPC that is connected to the source database.
    Note If DestinationEndpointInstanceType is set to CEN, you must also specify the ID of the CEN instance in the Reserve parameter. For more information, see Description of the Reserve parameter.
    DestinationEndpointEngineName String No MYSQL

    The database type of the destination instance.

    • MYSQL: MySQL database, including ApsaraDB RDS for MySQL and self-managed MySQL.
    • MARIADB: ApsaraDB RDS for MariaDB.
    • PolarDB: PolarDB for MySQL.
    • POLARDB_O: PolarDB for PostgreSQL (Compatible with Oracle).
    • POLARDBX10: PolarDB-X 1.0 (formerly DRDS).
    • POLARDBX20: PolarDB-X 2.0.
    • ORACLE: self-managed Oracle.
    • PostgreSQL: PostgreSQL database, including ApsaraDB RDS for PostgreSQL and self-managed PostgreSQL.
    • MSSQL: SQL Server database, including ApsaraDB RDS for SQL Server and self-managed SQL Server.
    • ADS: AnalyticDB for MySQL 2.0.
    • ADB30: AnalyticDB for MySQL 3.0.
    • MONGODB: MongoDB database, including self-managed MongoDB and ApsaraDB for MongoDB.
    • GREENPLUM: AnalyticDB for PostgreSQL.
    • KAFKA: Kafka database, including Message Queue for Apache Kafka and self-managed Kafka.
    • DATAHUB: DataHub.
    • DB2: self-managed DB2 LUW.
    • AS400: Db2 for i.
    • ODPS: MaxCompute.
    • Tablestore: Tablestore.
    • ELK: Elasticsearch.
    • REDIS: Redis database, including self-managed Redis and ApsaraDB for Redis or Tair (compatible with Redis).
    Note
    • Default value: MYSQL.
    • If the database type of the destination instance is KAFKA, MONGODB, or PolarDB, you must also specify some information in the Reserve parameter. For more information, see Description of the Reserve parameter.
    DestinationEndpointRegion String No cn-hangzhou

    The region where the destination instance resides. For more information, see Supported regions.

    Note If the destination instance is an Alibaba Cloud database instance, this parameter is required.
    DestinationEndpointIP String No 172.16.**.***

    The IP address of the destination instance.

    Note This parameter is valid and required only if DestinationEndpointInstanceType is set to OTHER, EXPRESS, DG, or CEN.
    DestinationEndpointPort String No 3306

    The port number of the destination instance.

    Note This parameter is valid and required only if the destination instance is a self-managed database.
    DestinationEndpointDataBaseName String No dtstestdata

    The name of the database to which the objects are migrated or synchronized in the destination instance.

    Note
    • This parameter is valid and required only if the destination database is a PolarDB for PostgreSQL (Compatible with Oracle) cluster, an AnalyticDB for PostgreSQL instance, a PostgreSQL database, a MaxCompute project, or a MongoDB database.
    • If the destination instance is a MaxCompute project, you must specify the MaxCompute project ID.
    DestinationEndpointUserName String No dtstest

    The database account of the destination database.

    Note
    DestinationEndpointPassword String No Test123456

    The password of the account that is used to log on to the destination database.

    Note If the destination database is a MaxCompute project, you must specify the AccessKey secret of your Alibaba Cloud account. For more information, see Create an AccessKey.
    DestinationEndpointOwnerID String No 140692647406****

    The ID of the Alibaba Cloud account to which the destination ApsaraDB RDS for MySQL instance belongs.

    Note
    • This parameter is available only if the destination instance is an ApsaraDB RDS for MySQL instance.
    • If you specify this parameter, it indicates that you want to perform data migration or synchronization across Alibaba Cloud accounts. In this case, you must also specify the DestinationEndpointRole parameter.
    DestinationEndpointRole String No ram-for-dts

    The name of the RAM role configured for the Alibaba Cloud account that owns the destination instance.

    Note This parameter is required when you perform data migration or synchronization across Alibaba Cloud accounts. For more information about the permissions that are required for the RAM role and how to grant the permissions, see Configure RAM authorization for data migration or synchronization from an instance attached to one Alibaba Cloud account to an instance attached to another Alibaba Cloud account.
    StructureInitialization Boolean Yes true

    Specifies whether to perform schema migration or schema synchronization. Default value: true. Valid values:

    • true: yes
    • false: no
    Note If JobType is set to CHECK, this parameter can be set only to false.
    DataInitialization Boolean Yes true

    Specifies whether to perform full data migration or full data synchronization. Default value: true. Valid values:

    • true: yes
    • false: no
    Note If JobType is set to CHECK, this parameter can be set only to false.
    DataSynchronization Boolean Yes true

    Specifies whether to perform incremental data migration or incremental data synchronization. Default value: false. Valid values:

    • false: no
    • true: yes
    Note If JobType is set to CHECK, this parameter can be set only to false.
    DbList String Yes {"dtstest":{"name":"dtstest","all":true}}

    The objects that you want to migrate or synchronize. The value is a JSON string. For more information, see Description of migration, synchronization, or subscription objects.

    • The DbList parameter can contain a maximum of 1 MB of data.
    • If the DbList parameter contains filter conditions, the total length of the DbList parameter (including filter conditions) can be a maximum of 1 MB.
    • For distributed tasks, such as migration or synchronization tasks from PolarDB-X 1.0, the DbList parameter is split based on physical tables to generate multiple subtasks. The DbList parameter of each subtask can contain a maximum of 1 MB of data.
    Reserve String No { "srcInstanceId": "cen-9kqshqum*******" }

    The reserved parameter of DTS. The value is a JSON string. You can specify this parameter to add more configurations of the source or destination instance to the DTS task. For example, you can specify the data storage format of the destination Kafka database and the CEN instance ID. For more information, see Description of the Reserve parameter.
    Checkpoint String No 1610540493

    The start offset of incremental data migration or data synchronization. This value is a UNIX timestamp. Unit: seconds.

    Note If you want to specify the Checkpoint parameter, you must make sure that no other DTS tasks that use the same source database as the destination DTS instance are running.
    DestinationEndpointOracleSID String No testsid

    The SID of the Oracle database.

    Note This parameter is valid and required only if DestinationEndpointEngineName is set to OracleOracle and the Oracle database is a non-RAC instance.
    JobType String Yes SYNC

    The type of the task. Valid values:

    • MIGRATION: data migration
    • SYNC: data synchronization
    • CHECK: data verification (purchased separately)
    Note
    • If this parameter is set to MIGRATION or SYNC, you can also configure a data verification task in the data migration or synchronization instance.
    • If you want to configure a data verification task, you must also specify the DataCheckConfigure parameter.
    DtsJobId String No k2gm967v16f****

    The ID of the data migration or synchronization task.

    Note You can call the DescribeDtsJobs operation to query the task ID.
    DtsInstanceId String No dtsk2gm967v16f****

    The ID of the data migration or synchronization instance.

    Note You can call the DescribeDtsJobs operation to query the instance ID.
    DelayPhone String No 1361234****,1371234****

    The mobile numbers to which latency-related alerts are sent. Separate multiple mobile numbers with commas (,).

    Note
    • This property can be used only for users of the China site (aliyun.com). Only mobile numbers in the Chinese mainland are supported. You can specify up to 10 mobile numbers.
    • This feature is not supported for users of the international site (alibabacloud.com). You can only configure alert rules for DTS tasks in Cloud Monitor.
    DelayRuleTime Long No 10

    The threshold for triggering latency alerts. Unit: seconds. The value must be an integer. You can set the threshold based on your business needs. To prevent jitters caused by network and database overloads, we recommend that you set the threshold to more than 10 seconds.

    Note This parameter is required if DelayNotice is set to true.
    DelayNotice Boolean No true

    Specifies whether to monitor task latency. Valid values:

    • true: yes
    • false: no
    ErrorPhone String No 1361234****,1371234****

    The mobile phone numbers to which exception-related alerts are sent. Separate multiple mobile phone numbers with commas (,).

    Note
    • This property can be used only for users of the China site (aliyun.com). Only mobile numbers in the Chinese mainland are supported. You can specify up to 10 mobile numbers.
    • This feature is not supported for users of the international site (alibabacloud.com). You can only configure alert rules for DTS tasks in Cloud Monitor.
    ErrorNotice Boolean No true

    Specifies whether to monitor task status. Valid values:

    • true: yes
    • false: no
    SynchronizationDirection String No Forward

    The synchronization direction. Valid values:

    • Forward: forward
    • Reverse: reverse
    Note
    • Default value: Forward.
    • This parameter can be set to Reverse only when the synchronization topology of the synchronization task is two-way synchronization.
    RegionId String No cn-hangzhou

    The region where the DTS instance resides. For more information, see Supported regions.
    DedicatedClusterId String No dtscluster_atyl3b5214uk***

    The ID of the DTS dedicated cluster on which the task runs.

    Note If this parameter is specified, the task is scheduled to the specified DTS dedicated cluster.
    FileOssUrl String No http://db-list-os-file.oss-cn-shanghai.aliyuncs.com/8e42_121852**********_79dd3aeabe2f43cdb**************

    The URL of the Object Storage Service (OSS) bucket that stores the files related to the DTS task.
    DataCheckConfigure String No {"fullCheckModel":1,"fullCheckRatio":20,"checkMaximumHourEnable":1,"checkMaximumHour":1,"fullCheckErrorNotice":true,"fullCheckValidFailNotice":true,"fullCheckNoticeValue":8,"incrementalCheckErrorNotice":true,"incrementalCheckValidFailNotice":true,"incrementalCheckValidFailNoticeTimes":2,"incrementalCheckValidFailNoticePeriod":1,"incrementalCheckValidFailNoticeValue":1,"incrementalCheckDelayNotice":true,"incrementalCheckDelayNoticeTimes":2,"incrementalCheckDelayNoticePeriod":1,"incrementalCheckDelayNoticeValue":60,"fullDataCheck":true,"incrementalDataCheck":true,"dataCheckNoticePhone":"13126800****","dataCheckDbList":{"dts":{"name":"dts","all":true}}}

    The parameters for data verification, including the configurations for data verification and alerts. The value is a JSON string. For more information, see Description of the DataCheckConfigure parameter.
    DisasterRecoveryJob Boolean No true

    Specifies whether the instance is a disaster recovery instance. Valid values:

    • true: yes
    • false: no
    SourceEndpointVSwitchID String No vsw-bp10df3mxae6lpmku****

    The ID of the vSwitch used for the data shipping link.
    DtsBisLabel String No normal

    The environment tag of the DTS instance. Valid values:

    • normal: normal
    • online: online
    SrcCaCertificateOssUrl String No ****

    The path of the certificate authority (CA) certificate that is used if the connection to the source database is encrypted by using SSL.

    Note This feature is not supported. Do not specify this parameter.
    SrcCaCertificatePassword String No ****

    The key of the CA certificate that is used if the connection to the source database is encrypted by using SSL.

    Note This feature is not supported. Do not specify this parameter.
    DestCaCertificateOssUrl String No ****

    The path of the CA certificate that is used if the connection to the destination database is encrypted by using SSL.

    Note This feature is not supported. Do not specify this parameter.
    DestCaCertificatePassword String No ****

    The key of the CA certificate that is used if the connection to the destination database is encrypted by using SSL.

    Note This feature is not supported. Do not specify this parameter.
    MinDu double No 1

    The lower limit of DU.

    Note This parameter is supported only for serverless instances.
    MaxDu double No 16

    The upper limit of DU.

    Note This parameter is supported only for serverless instances.
    SrcClientCertOssUrl String No ****

    The path to the client certificate that is used if the connection to the source database is encrypted by using SSL.

    Note This feature is not supported. Do not specify this parameter.
    SrcClientKeyOssUrl String No ****

    The path to the private key of the client certificate that is used if the connection to the source database is encrypted by using SSL.

    Note This feature is not supported. Do not specify this parameter.
    SrcClientPassword String No ****

    The password of the private key of the client certificate that is used if the connection to the source database is encrypted by using SSL.

    Note This feature is not supported. Do not specify this parameter.
    DestClientCertOssUrl String No ****

    The path to the client certificate that is used if the connection to the destination database is encrypted by using SSL.

    Note This feature is not supported. Do not specify this parameter.
    DestClientKeyOssUrl String No ****

    The path to the private key of the client certificate that is used if the connection to the destination database is encrypted by using SSL.

    Note This feature is not supported. Do not specify this parameter.
    DestClientPassword String No ****

    The password of the private key of the client certificate that is used if the connection to the destination database is encrypted by using SSL.

    Note This feature is not supported. Do not specify this parameter.
    SrcPrimaryVswId String No ****

    The primary vSwitch for the source of VPC NAT
    SrcSecondaryVswId String No ****

    The secondary vSwitch for the source of VPC NAT
    DestPrimaryVswId String No ****

    The primary vSwitch for the destination of VPC NAT
    DestSecondaryVswId String No ****

    The secondary vSwitch for the destination of VPC NAT
    ResourceGroupId String No rg-acfmzawhxxc****

    The resource group ID of the instance.

    Return data

    Name

    Type

    Example

    Description
    HttpStatusCode String 200

    The HTTP status code.
    RequestId String 224DB9F7-3100-4899-AB9C-C938BCCB****

    The request ID.
    ErrCode String InternalError

    The error code returned if the call failed.
    DtsJobId String k2gm967v16f****

    The ID of the data migration or synchronization task.
    DtsInstanceId String dtsk2gm967v16f****

    The ID of the data migration or synchronization instance.
    Success String true

    Indicates whether the request is successful.
    ErrMessage String The request processing has failed due to some unknown error.

    The error message returned if the request fails.

    Examples

    Query example

    http(s)://dts.aliyuncs.com/?Action=ConfigureDtsJob
&RegionId=cn-hangzhou
&SourceEndpointInstanceType=RDS
&DestinationEndpointInstanceType=EXPRESS
&StructureInitialization=true
&DataInitialization=true
&DataSynchronization=true
&DbList={"dtstest":{"name":"dtstest","all":true}}
&JobType=SYNC
&SourceEndpointInstanceID=rm-bp1imrtn6fq7h****
&SourceEndpointEngineName=MYSQL
&SourceEndpointRegion=cn-hangzhou
&SourceEndpointUserName=dtstest
&SourceEndpointPassword=Test123456
&DestinationEndpointInstanceID=vpc-bp1opxu1zkhn00gzv****
&DestinationEndpointEngineName=MYSQL
&DestinationEndpointIP=172.16.**.***
&DestinationEndpointRegion=cn-hangzhou
&DestinationEndpointPort=3306
&DestinationEndpointUserName=dtstest
&DestinationEndpointPassword=Test123456
&DtsJobId=k2gm967v16f****
&DtsInstanceId=dtsk2gm967v16f****
&DtsJobName=ApsaraDB RDS for MySQL to self-managed MySQL database connected over Express Connect
&<Common request parameters>

    Sample success responses

    XML format

    HTTP/1.1 200 OK
Content-Type:application/xml

<ConfigureDtsJobResponse>
    <DtsJobId>k2gm967v16f****</DtsJobId>
    <RequestId>224DB9F7-3100-4899-AB9C-C938BCCB****</RequestId>
    <HttpStatusCode>200</HttpStatusCode>
    <DtsInstanceId>dtsk2gm967v16f****</DtsInstanceId>
    <Success>true</Success>
</ConfigureDtsJobResponse>

    JSON format

    HTTP/1.1 200 OK
Content-Type:application/json

{
  "DtsJobId" : "k2gm967v16f****",
  "RequestId" : "224DB9F7-3100-4899-AB9C-C938BCCB****",
  "HttpStatusCode" : 200,
  "DtsInstanceId" : "dtsk2gm967v16f****",
  "Success" : true
}

    Error codes

    HttpCode

    Error code

    Error message

    Description
    403 InvalidParameter.DelayPhoneInvalid The parameter DelayPhone is invalid. The DelayPhone parameter is invalid.
    403 InvalidParameter.ErrorPhoneInvalid The parameter ErrorPhone is invalid. The ErrorPhone parameter is invalid.
    403 InvalidParameter.CheckpointInvalid The parameter Checkpoint is invalid. The Checkpoint parameter is invalid.
    403 InvalidParameter.DedicatedClusterIdInvalid The parameter DedicatedClusterId is invalid. The DedicatedClusterId parameter is invalid.
    403 InvalidParameter.FileOssUrlInvalid The parameter FileOssUrl is invalid. The FileOssUrl parameter is invalid.
    403 InvalidParameter.DtsBisLabelInvalid The parameter DtsBisLabel is invalid. The DtsBisLabel parameter is invalid.
    403 InvalidParameter.SourceEndpointRoleInvalid The parameter SourceEndpointRole is invalid. The SourceEndpointRole parameter is invalid.
    403 InvalidParameter.DestinationEndpointRoleInvalid The parameter DestinationEndpointRole is invalid. The DestinationEndpointRole parameter is invalid.
    403 InvalidParameter.SourceEndpointOwnerIDInvalid The parameter SourceEndpointOwnerID is invalid. The SourceEndpointOwnerID parameter is invalid.
    403 InvalidParameter.DestinationEndpointOwnerIDInvalid The parameter DestinationEndpointOwnerID is invalid. The DestinationEndpointOwnerID parameter is invalid.
    403 InvalidParameter.SourceEndpointRoleEmpty The parameter SourceEndpointRole should not be null. The SourceEndpointRole parameter cannot be empty.
    403 InvalidParameter.DestinationEndpointRoleEmpty The parameter DestinationEndpointRole should not be null. The DestinationEndpointRole parameter cannot be empty.
    403 InvalidParameter.SourceEndpointVSwitchIDInvalid The parameter SourceEndpointVSwitchID is invalid. The SourceEndpointVSwitchID parameter is invalid.
    403 InvalidParameter.MinDuInvalid The parameter MinDu is invalid. The MinDu parameter is invalid.
    403 InvalidParameter.MaxDuInvalid The parameter MaxDu is invalid. The MaxDu parameter is invalid.
    403 InvalidParameter.SrcPrimaryVswIdInvalid The parameter SrcPrimaryVswId is invalid. The SrcPrimaryVswId parameter is invalid.
    403 InvalidParameter.SrcSecondaryVswIdInvalid The parameter SrcSecondaryVswId is invalid. The SrcSecondaryVswId parameter is invalid.
    403 InvalidParameter.DestPrimaryVswIdInvalid The parameter DestPrimaryVswId is invalid. The DestPrimaryVswId parameter is invalid.
    403 InvalidParameter.DestSecondaryVswIdInvalid The parameter DestSecondaryVswId is invalid. The DestSecondaryVswId parameter is invalid.

    Access the Error Center to view more error codes.

    OSZAR »