tencent cloud

PrevNext

Feedback

search by keyword

Recent Pages

Documentation
Documentation

Data Types

Last updated: 2024-12-04 15:33:40

    CheckStep

    Check step

    Used by actions: DescribeMigrationCheckJob.

    Name Type Description
    StepNo Integer Step number
    Note: This field may return null, indicating that no valid values can be obtained.
    StepId String Step ID such as ConnectDBCheck, VersionCheck, and SrcPrivilegeCheck. The specific check items are subject to source and target instances.
    Note: This field may return null, indicating that no valid values can be obtained.
    StepName String Step name
    Note: This field may return null, indicating that no valid values can be obtained.
    StepStatus String Result of this check step. Valid values: pass, failed, notStarted, blocked, warning.
    Note: This field may return null, indicating that no valid values can be obtained.
    StepMessage String Error message in this check step
    Note: This field may return null, indicating that no valid values can be obtained.
    DetailCheckItems Array of DetailCheckItem Specific check item in this check step
    Note: This field may return null, indicating that no valid values can be obtained.
    HasSkipped Boolean Whether this step was skipped
    Note: This field may return null, indicating that no valid values can be obtained.

    CheckStepInfo

    Check task running details

    Used by actions: DescribeMigrationDetail.

    Name Type Description
    StartAt String Task start time
    Note: This field may return null, indicating that no valid values can be obtained.
    EndAt String Task end time
    Note: This field may return null, indicating that no valid values can be obtained.
    Progress ProcessProgress Task step information
    Note: This field may return null, indicating that no valid values can be obtained.

    Column

    Column information in data sync

    Used by actions: ConfigureSyncJob, DescribeSyncJobs, ModifySyncJobConfig.

    Name Type Required Description
    ColumnName String No Column nameNote: This field may return null, indicating that no valid values can be obtained.
    NewColumnName String No New column name
    Note: This field may return null, indicating that no valid values can be obtained.

    CompareAbstractInfo

    Summary information of data consistency check

    Used by actions: DescribeCompareReport.

    Name Type Description
    Options CompareOptions Configuration parameters of the check task
    Note: This field may return null, indicating that no valid values can be obtained.
    Objects CompareObject Consistency check objects
    Note: This field may return null, indicating that no valid values can be obtained.
    Conclusion String Comparison conclusion. Valid values: same, different.
    Note: This field may return null, indicating that no valid values can be obtained.
    Status String Task status. Valid values: success, failed.
    Note: This field may return null, indicating that no valid values can be obtained.
    TotalTables Integer Total number of tables
    Note: This field may return null, indicating that no valid values can be obtained.
    CheckedTables Integer Number of checked tables
    Note: This field may return null, indicating that no valid values can be obtained.
    DifferentTables Integer Number of inconsistent tables
    Note: This field may return null, indicating that no valid values can be obtained.
    SkippedTables Integer Number of skipped tables
    Note: This field may return null, indicating that no valid values can be obtained.
    NearlyTableCount Integer The estimated number of tables
    Note: This field may return null, indicating that no valid values can be obtained.
    DifferentRows Integer Number of inconsistent data rows
    Note: This field may return null, indicating that no valid values can be obtained.
    SrcSampleRows Integer Source database row count, which takes effect only when the comparison type is Row count comparison.
    Note: This field may return null, indicating that no valid values can be obtained.
    DstSampleRows Integer Target database row count, which takes effect only when the comparison type is Row count comparison.
    Note: This field may return null, indicating that no valid values can be obtained.
    StartedAt String Start time
    Note: This field may return null, indicating that no valid values can be obtained.
    FinishedAt String End time
    Note: This field may return null, indicating that no valid values can be obtained.

    CompareColumnItem

    Column options

    Used by actions: CreateCompareTask, DescribeCompareReport, ModifyCompareTask.

    Name Type Required Description
    ColumnName String No Column nameNote: This field may return null, indicating that no valid values can be obtained.

    CompareDetailInfo

    Data consistency check details

    Used by actions: DescribeCompareReport.

    Name Type Description
    Difference DifferenceDetail Details of inconsistent tables
    Note: This field may return null, indicating that no valid values can be obtained.
    Skipped SkippedDetail Details of skipped tables
    Note: This field may return null, indicating that no valid values can be obtained.

    CompareObject

    Configuration of the data consistency check object

    Used by actions: CreateCompareTask, DescribeCompareReport, DescribeCompareTasks, ModifyCompareTask.

    Name Type Required Description
    ObjectMode String Yes Data comparison object mode (all: Entire instance; partial: Some objects)
    Note: This field may return null, indicating that no valid values can be obtained.
    ObjectItems Array of CompareObjectItem No Object list
    Note: This field may return null, indicating that no valid values can be obtained.
    AdvancedObjects Array of String No Advanced object types, such as account, index, shardkey, schema.Note: This field may return null, indicating that no valid values can be obtained.

    CompareObjectItem

    Database/Table objects for data consistency check

    Used by actions: CreateCompareTask, DescribeCompareReport, ModifyCompareTask.

    Name Type Required Description
    DbName String Yes Database name
    Note: This field may return null, indicating that no valid values can be obtained.
    DbMode String Yes Database selection mode. Valid values: all, partial.
    Note: This field may return null, indicating that no valid values can be obtained.
    SchemaName String No Schema name
    Note: This field may return null, indicating that no valid values can be obtained.
    TableMode String No Schema selection mode. Valid values: all, partial.
    Note: This field may return null, indicating that no valid values can be obtained.
    Tables Array of CompareTableItem No Table configuration for data consistency check, which is required if TableMode is partial.
    Note: This field may return null, indicating that no valid values can be obtained.
    ViewMode String No View selection mode: all refers to all view objects under the current object, partial refers to partial view objects (consistency check does not check views, and the current parameters are disabled).Note: This field may return null, indicating that no valid values can be obtained.
    Views Array of CompareViewItem No View configuration used for consistency check. When ViewMode is partial, it needs to be filled in (consistency check does not check views, and the current parameters are disabled).Note: This field may return null, indicating that no valid values can be obtained.

    CompareOptions

    Consistency check options

    Used by actions: CreateCompareTask, DescribeCompareReport, DescribeCompareTasks, ModifyCompareTask.

    Name Type Required Description
    Method String No Comparative Method: dataCheck (Complete Data Comparison), sampleDataCheck (Sampling Data Comparison), rowsCount (Row Count Comparison)Note: This field may return null, indicating that no valid value can be obtained.
    SampleRate Integer No Sampling rate. Value range: 0-100%.
    Note: This field may return null, indicating that no valid values can be obtained.
    ThreadCount Integer No The number of threads, which defaults to 1. Value range: 1-5.
    Note: This field may return null, indicating that no valid values can be obtained.

    CompareTableItem

    Table configuration for data consistency check

    Used by actions: CreateCompareTask, DescribeCompareReport, ModifyCompareTask.

    Name Type Required Description
    TableName String No Table name
    Note: This field may return null, indicating that no valid values can be obtained.
    ColumnMode String No In column mode, all refers to all data, while partial refers to part of the data (this parameter is only valid for data sync tasks).Note: This field may return null, indicating that no valid values can be obtained.
    Columns Array of CompareColumnItem No This field is required when ColumnMode is set to partial (this parameter is only valid for data sync tasks).Note: This field may return null, indicating that no valid values can be obtained.

    CompareTaskInfo

    Data consistency check result

    Used by actions: DescribeMigrationDetail, DescribeMigrationJobs.

    Name Type Description
    CompareTaskId String Data consistency check task ID
    Note: This field may return null, indicating that no valid values can be obtained.
    Status String Data consistency check result. Valid values: unstart (the task is not started); running (the task is running); canceled (the task is stopped); failed (the task failed); inconsistent (the data is inconsistent); consistent (the data is consistent); notexist (the task does not exist).
    Note: This field may return null, indicating that no valid values can be obtained.

    CompareTaskItem

    Information of the data consistency check object

    Used by actions: DescribeCompareTasks.

    Name Type Description
    JobId String Task ID
    Note: This field may return null, indicating that no valid values can be obtained.
    CompareTaskId String Data consistency check task ID
    Note: This field may return null, indicating that no valid values can be obtained.
    TaskName String Data consistency check task name
    Note: This field may return null, indicating that no valid values can be obtained.
    Status String Data consistency check task status. Valid values: created, readyRun, running, success, stopping, failed, canceled.
    Note: This field may return null, indicating that no valid values can be obtained.
    Config CompareObject Data consistency check task configuration
    Note: This field may return null, indicating that no valid values can be obtained.
    CheckProcess ProcessProgress Check details of the data consistency check task
    Note: This field may return null, indicating that no valid values can be obtained.
    CompareProcess ProcessProgress Running details of the data consistency check task
    Note: This field may return null, indicating that no valid values can be obtained.
    Conclusion String Comparison result. Valid values: same, different, skipAll.
    Note: This field may return null, indicating that no valid values can be obtained.
    CreatedAt String Task creation time
    Note: This field may return null, indicating that no valid values can be obtained.
    StartedAt String Task start time
    Note: This field may return null, indicating that no valid values can be obtained.
    FinishedAt String Comparison end time
    Note: This field may return null, indicating that no valid values can be obtained.
    Method String Comparison type: (dataCheck: Full data comparison; sampleDataCheck: Sampling data comparison; rowsCount: Row count comparison)
    Note: This field may return null, indicating that no valid values can be obtained.
    Options CompareOptions Configuration information of the comparison task
    Note: This field may return null, indicating that no valid values can be obtained.
    Message String Consistency check prompt message
    Note: This field may return null, indicating that no valid values can be obtained.

    CompareViewItem

    View configuration for data consistency check

    Used by actions: CreateCompareTask, DescribeCompareReport, ModifyCompareTask.

    Name Type Required Description
    ViewName String No View name
    Note: This field may return null, indicating that no valid values can be obtained.

    ConflictHandleOption

    Detailed description of conflict processing

    Used by actions: ConfigureSyncJob, DescribeSyncJobs, ModifySyncJobConfig.

    Name Type Required Description
    ConditionColumn String No Conditionally overwritten column
    Note: This field may return null, indicating that no valid values can be obtained.
    ConditionOperator String No Conditional overwrite operation
    Note: This field may return null, indicating that no valid values can be obtained.
    ConditionOrderInSrcAndDst String No Conditional overwrite priority configuration
    Note: This field may return null, indicating that no valid values can be obtained.

    ConsistencyOption

    Data consistency check option. Data consistency check is disabled by default.

    Used by actions: DescribeMigrationDetail, ModifyMigrationJob.

    Name Type Required Description
    Mode String No Data consistency check type. Valid values: full, noCheck, notConfigured.
    Note: This field may return null, indicating that no valid values can be obtained.

    DBEndpointInfo

    Instance information

    Used by actions: DescribeMigrationDetail, DescribeMigrationJobs, ModifyMigrationJob.

    Name Type Required Description
    Region String Yes Instance region
    Note: This field may return null, indicating that no valid values can be obtained.
    AccessType String Yes Instances network access type. Valid values: extranet (public network); ipv6 (public IPv6); cvm (self-build on CVM); dcg (Direct Connect); vpncloud (VPN access); cdb (database); ccn (CCN); intranet (intranet); vpc (VPC). Note that the valid values are subject to the current link.
    Note: This field may return null, indicating that no valid values can be obtained.
    DatabaseType String Yes Database type, such as mysql, redis, mongodb, postgresql, mariadb, and percona.
    Note: This field may return null, indicating that no valid values can be obtained.
    NodeType String Yes Node type, empty or simple indicates a general node, cluster indicates a cluster node; for mongo services, valid values: replicaset (mongodb replica set), standalone (mongodb single node), cluster (mongodb cluster); for redis instances, valid values: empty or simple (single node), cluster (cluster), cluster-cache (cache cluster), cluster-proxy (proxy cluster).Note: This field may return null, indicating that no valid values can be obtained.
    Info Array of DBInfo Yes Database information
    Note: This field may return null, indicating that no valid values can be obtained.
    Supplier String No Instance service provider, such as "aliyun" and "others".
    Note: This field may return null, indicating that no valid values can be obtained.
    ExtraAttr Array of KeyValuePairOption No For MongoDB, you can define the following parameters: ['AuthDatabase':'admin',
    'AuthFlag': "1", 'AuthMechanism':"SCRAM-SHA-1"]
    Note: This field may return null, indicating that no valid values can be obtained.
    DatabaseNetEnv String No Network environment of the database. This parameter is required when AccessType is ccn. Valid values: UserIDC (user IDC), TencentVPC (Tencent Cloud VPC).
    Note: This field may return null, indicating that no valid values can be obtained.
    ConnectType String No

    DBInfo

    Database information

    Used by actions: DescribeMigrationDetail, DescribeMigrationJobs, ModifyMigrationJob.

    Name Type Required Description
    Role String No Node role in a distributed database, such as the mongos node in MongoDB.
    Note: This field may return null, indicating that no valid values can be obtained.
    DbKernel String No Kernel version, such as the different kernel versions of MariaDB.
    Note: This field may return null, indicating that no valid values can be obtained.
    Host String No Instance IP address, which is required for the following access types: public network, Direct Connect, VPN, CCN, intranet, and VPC.
    Note: This field may return null, indicating that no valid values can be obtained.
    Port Integer No Instance port, which is required for the following access types: public network, self-build on CVM, Direct Connect, VPN, CCN, intranet, and VPC.
    Note: This field may return null, indicating that no valid values can be obtained.
    User String No Instance username
    Note: This field may return null, indicating that no valid values can be obtained.
    Password String No Instance password
    Note: This field may return null, indicating that no valid values can be obtained.
    CvmInstanceId String No Short CVM instance ID in the format of ins-olgl39y8, which is required if the access type is cvm. It is the same as the instance ID displayed in the CVM console.
    Note: This field may return null, indicating that no valid values can be obtained.
    UniqVpnGwId String No VPN gateway ID in the format of vpngw-9ghexg7q, which is required if the access type is vpncloud.
    Note: This field may return null, indicating that no valid values can be obtained.
    UniqDcgId String No Direct Connect gateway ID in the format of dcg-0rxtqqxb, which is required if the access type is dcg.
    Note: This field may return null, indicating that no valid values can be obtained.
    InstanceId String No Database instance ID in the format of cdb-powiqx8q, which is required if the access type is cdb.
    Note: This field may return null, indicating that no valid values can be obtained.
    CcnGwId String No CCN instance ID such as ccn-afp6kltc
    Note: This field may return null, indicating that no valid values can be obtained.
    VpcId String No VPC ID in the format of vpc-92jblxto, which is required if the access type is vpc, vpncloud, ccn, or dcg.
    Note: This field may return null, indicating that no valid values can be obtained.
    SubnetId String No ID of the subnet in the VPC in the format of subnet-3paxmkdz, which is required if the access type is vpc, vpncloud, ccn, or dcg.
    Note: This field may return null, indicating that no valid values can be obtained.
    EngineVersion String No Database version in the format of 5.6 or 5.7, which takes effect only if the instance is an RDS instance. Default value: 5.6.
    Note: This field may return null, indicating that no valid values can be obtained.
    Account String No Instance account
    Note: This field may return null, indicating that no valid values can be obtained.
    AccountRole String No The role used for cross-account migration, which can contain [a-zA-Z0-9-_]+.
    Note: This field may return null, indicating that no valid values can be obtained.
    AccountMode String No The account to which the resource belongs. Valid values: empty or self (the current account); other (another account).
    Note: This field may return null, indicating that no valid values can be obtained.
    TmpSecretId String No Temporary SecretId, you can obtain the temporary key by GetFederationToken.Note: This field may return null, indicating that no valid values can be obtained.
    TmpSecretKey String No Temporary SecretKey, you can obtain the temporary key by GetFederationToken.Note: This field may return null, indicating that no valid values can be obtained.
    TmpToken String No Temporary token, you can obtain the temporary key by GetFederationToken.Note: This field may return null, indicating that no valid values can be obtained.

    DBItem

    Migration object information, which is case-sensitive when objects such as databases, tables, and views are configured.

    Used by actions: DescribeMigrationDetail, ModifyMigrationJob.

    Name Type Required Description
    DbName String No Name of the database to be migrated or synced, which is required if ObjectMode is partial.
    Note: This field may return null, indicating that no valid values can be obtained.
    NewDbName String No Name of the database after migration or sync, which is the same as the source database name by default.
    Note: This field may return null, indicating that no valid values can be obtained.
    SchemaName String No The schema to be migrated or synced
    Note: This field may return null, indicating that no valid values can be obtained.
    NewSchemaName String No Name of the schema after migration or sync
    Note: This field may return null, indicating that no valid values can be obtained.
    DBMode String No Database selection mode, which is required if ObjectMode is partial. Valid values: all, partial.
    Note: This field may return null, indicating that no valid values can be obtained.
    SchemaMode String No Schema selection mode. Valid values: all, partial.
    Note: This field may return null, indicating that no valid values can be obtained.
    TableMode String No Table selection mode, which is required if DBMode is partial. Valid values: all, partial.
    Note: This field may return null, indicating that no valid values can be obtained.
    Tables Array of TableItem No The set of table objects, which is required if TableMode is partial.
    Note: This field may return null, indicating that no valid values can be obtained.
    ViewMode String No View selection mode. Valid values: all, partial.
    Note: This field may return null, indicating that no valid values can be obtained.
    Views Array of ViewItem No The set of view objects, which is required if ViewMode is partial.
    Note: This field may return null, indicating that no valid values can be obtained.
    RoleMode String No Role selection mode, which is exclusive to PostgreSQL. Valid values: all, partial.
    Note: This field may return null, indicating that no valid values can be obtained.
    Roles Array of RoleItem No Role, which is exclusive to PostgreSQL and required if RoleMode is partial.
    Note: This field may return null, indicating that no valid values can be obtained.
    FunctionMode String No Sync mode. Valid values: partial, all.
    Note: This field may return null, indicating that no valid values can be obtained.
    TriggerMode String No Sync mode. Valid values: partial, all.
    Note: This field may return null, indicating that no valid values can be obtained.
    EventMode String No Sync mode. Valid values: partial, all.
    Note: This field may return null, indicating that no valid values can be obtained.
    ProcedureMode String No Sync mode. Valid values: partial, all.
    Note: This field may return null, indicating that no valid values can be obtained.
    Functions Array of String No This parameter is required if FunctionMode is partial.
    Note: This field may return null, indicating that no valid values can be obtained.
    Procedures Array of String No This parameter is required if ProcedureMode is partial.
    Note: This field may return null, indicating that no valid values can be obtained.
    Events Array of String No This parameter is required if EventMode is partial.
    Note: This field may return null, indicating that no valid values can be obtained.
    Triggers Array of String No This parameter is required if TriggerMode is partial.
    Note: This field may return null, indicating that no valid values can be obtained.

    Database

    The database/table objects to be synced

    Used by actions: ConfigureSyncJob, DescribeSyncJobs, ModifySyncJobConfig.

    Name Type Required Description
    DbName String No Name of the database to be migrated or synced, which is required if ObjectMode is Partial.
    Note: This field may return null, indicating that no valid values can be obtained.
    NewDbName String No Name of the database after migration or sync, which is the same as the source database name by default.
    Note: This field may return null, indicating that no valid values can be obtained.
    DbMode String No Database selection mode, which is required if Mode is Partial. Valid values: All, Partial. Note that the sync of advanced objects does not depend on this parameter. To sync an entire database, set this parameter to All.
    Note: This field may return null, indicating that no valid values can be obtained.
    SchemaName String No The schema to be migrated or synced
    Note: This field may return null, indicating that no valid values can be obtained.
    NewSchemaName String No Name of the schema after migration or sync
    Note: This field may return null, indicating that no valid values can be obtained.
    TableMode String No Table selection mode, which is required if DBMode is Partial. Valid values: All, Partial. To sync an entire database, set this parameter to All.
    Note: This field may return null, indicating that no valid values can be obtained.
    Tables Array of Table No The set of table objects, which is required if TableMode is Partial.
    Note: This field may return null, indicating that no valid values can be obtained.
    ViewMode String No View selection mode. Valid values: All, Partial. To sync an entire database, set this parameter to All.
    Note: This field may return null, indicating that no valid values can be obtained.
    Views Array of View No The set of view objects, which is required if ViewMode is Partial.
    Note: This field may return null, indicating that no valid values can be obtained.
    FunctionMode String No Sync mode. Valid values: All, Partial. To sync an entire database, set this parameter to All.
    Note: This field may return null, indicating that no valid values can be obtained.
    Functions Array of String No This parameter is required if FunctionMode is Partial.
    Note: This field may return null, indicating that no valid values can be obtained.
    ProcedureMode String No Sync mode. Valid values: All, Partial. To sync an entire database, set this parameter to All.
    Note: This field may return null, indicating that no valid values can be obtained.
    Procedures Array of String No This parameter is required if ProcedureMode is Partial.
    Note: This field may return null, indicating that no valid values can be obtained.
    TriggerMode String No Trigger sync mode. Valid values: All, Partial. To sync an entire database, set this parameter to All. Currently, the advanced object “trigger” is not supported for data sync.
    Note: This field may return null, indicating that no valid values can be obtained.
    Triggers Array of String No This parameter is used to specify the names of the triggers to be migrated when the value of TriggerMode is partial.
    Note: This field may return null, indicating that no valid values can be obtained.
    EventMode String No Event sync mode. Valid values: All, Partial. To sync an entire database, set this parameter to All. Currently, the advanced object “event” is not supported for data sync.
    Note: This field may return null, indicating that no valid values can be obtained.
    Events Array of String No This parameter is used to specify the names of the events to be migrated when the value of EventMode is partial.
    Note: This field may return null, indicating that no valid values can be obtained.

    DatabaseTableObject

    Migration object options, which tell DTS which database/table objects should be migrated.

    Used by actions: DescribeMigrationDetail, ModifyMigrationJob.

    Name Type Required Description
    ObjectMode String Yes Migration object type. Valid values: all, partial.
    Note: This field may return null, indicating that no valid values can be obtained.
    Databases Array of DBItem No Migration object, which is required if ObjectMode is partial.
    Note: This field may return null, indicating that no valid values can be obtained.
    AdvancedObjects Array of String No Advanced object types, such as trigger, function, procedure, event. Note: If you want to migrate and synchronize advanced objects, the corresponding advanced object type should be included in this configuration.Note: This field may return null, indicating that no valid values can be obtained.

    DdlOption

    DDL statement sync processing during data sync

    Used by actions: ConfigureSyncJob, DescribeSyncJobs, ModifySyncJobConfig.

    Name Type Required Description
    DdlObject String No DDL type, such as database, table, view, and index.
    Note: This field may return null, indicating that no valid values can be obtained.
    DdlValue Array of String No DDL value. Valid values: [Create,Drop,Alter] for database
    [Create,Drop,Alter,Truncate,Rename] for table
    [Create,Drop] for view
    [Create,Drop] for index
    Note: This field may return null, indicating that no valid values can be obtained.

    DetailCheckItem

    Specific check item in this check step

    Used by actions: DescribeMigrationCheckJob.

    Name Type Description
    CheckItemName String Check item name, such as source database permission check.
    Note: This field may return null, indicating that no valid values can be obtained.
    Description String Check item details
    Note: This field may return null, indicating that no valid values can be obtained.
    CheckResult String Check item result. Valid values: pass (pass); failed (failure); warning (pass with warning).
    Note: This field may return null, indicating that no valid values can be obtained.
    FailureReason String The cause of the check item failure
    Note: This field may return null, indicating that no valid values can be obtained.
    Solution String Solution
    Note: This field may return null, indicating that no valid values can be obtained.
    ErrorLog Array of String Execution error log
    Note: This field may return null, indicating that no valid values can be obtained.
    HelpDoc Array of String URL of the detailed help document
    Note: This field may return null, indicating that no valid values can be obtained.
    SkipInfo String Prompt text for ignoring a risk
    Note: This field may return null, indicating that no valid values can be obtained.

    DifferenceDetail

    Details of inconsistent tables

    Used by actions: DescribeCompareReport.

    Name Type Description
    TotalCount Integer Number of inconsistent tables
    Note: This field may return null, indicating that no valid values can be obtained.
    Items Array of DifferenceItem Details of inconsistent tables
    Note: This field may return null, indicating that no valid values can be obtained.

    DifferenceItem

    Details of inconsistent tables

    Used by actions: DescribeCompareReport.

    Name Type Description
    Db String Database name
    Note: This field may return null, indicating that no valid values can be obtained.
    Table String Table name
    Note: This field may return null, indicating that no valid values can be obtained.
    Chunk Integer Chunk ID
    Note: This field may return null, indicating that no valid values can be obtained.
    SrcItem String Source database value
    Note: This field may return null, indicating that no valid values can be obtained.
    DstItem String Target database value
    Note: This field may return null, indicating that no valid values can be obtained.
    IndexName String Index name
    Note: This field may return null, indicating that no valid values can be obtained.
    LowerBoundary String First index key
    Note: This field may return null, indicating that no valid values can be obtained.
    UpperBoundary String Last index key
    Note: This field may return null, indicating that no valid values can be obtained.
    CostTime Float Comparison time in ms
    Note: This field may return null, indicating that no valid values can be obtained.
    FinishedAt String Completion time
    Note: This field may return null, indicating that no valid values can be obtained.

    DistributeRule

    Kafka partition rules for subscription tasks. Data that matches the regex of the database name and table name will be delivered to the Kafka partition according to the RuleType . If multiple rules are configured, the first hit rule will take effect according to the configured order.

    Used by actions: ConfigureSubscribeJob, DescribeSubscribeDetail, ModifySubscribeObjects.

    Name Type Required Description
    RuleType String Yes Rule type. Valid values for non-mongo products: table (partitioned by table name); pk (partitioned by table name + primary key); cols (partitioned by column name). Valid values for mongo: collection (partitioned by collection name); collectionAndObjectId (partitioned by collection + primary key). Note: This field may return null, indicating that no valid values can be obtained.
    DbPattern String Yes Database name matching rule, please fill in the regular expression.Note: This field may return null, indicating that no valid values can be obtained.
    TablePattern String Yes Table name matching rule. If DatabaseType is mongodb, it matches the collection name.Note: This field may return null, indicating that no valid values can be obtained.
    Columns Array of String No Column name. This field is required if RuleType is cols. The subscription task will use the value of this column to calculate the partition. Mongo does not partition by column, so there is no need to pass this field.Note: This field may return null, indicating that no valid values can be obtained.

    DynamicOptions

    Data sync options

    Used by actions: ModifySyncJobConfig.

    Name Type Required Description
    OpTypes Array of String Yes DML and DDL options to be synced. Valid values: Insert (INSERT), Update (UPDATE), Delete (DELETE), DDL (structure sync), PartialDDL (custom option, which is used together with DdlOptions). This parameter is required, and its value will overwrite the previous value. Note: This field may return null, indicating that no valid values can be obtained.
    DdlOptions Array of DdlOption Yes DDL options to be synced. This parameter is required when OpTypes is PartialDDL, and its value will overwrite the previous value. Note: This field may return null, indicating that no valid values can be obtained.
    ConflictHandleType String No Conflict resolution method. Valid values: ReportError (Report error), Ignore (Ignore), Cover (Overwrite), ConditionCover (Conditionally overwrite). Currently, this parameter cannot be modified if the target of the link is Kafka. Note: This field may return null, indicating that no valid values can be obtained.
    ConflictHandleOption ConflictHandleOption No Detailed options of the conflict resolution method, such as the conditionally overwritten rows and condition operations for the “conditionally overwrite” method. The internal field of this parameter cannot be modified separately. If this parameter needs to be updated, update it fully. Note: This field may return null, indicating that no valid values can be obtained.

    Endpoint

    Information of the source and target databases in data sync

    Used by actions: ConfigureSyncJob, DescribeSyncJobs.

    Name Type Required Description
    Region String No Region name, such as ap-guangzhou.
    Note: This field may return null, indicating that no valid values can be obtained.
    Role String No Node type of TDSQL for MySQL. Enumerated values: proxy, set.
    Note: This field may return null, indicating that no valid values can be obtained.
    DbKernel String No Database kernel type, which is used to distinguish between different kernels in TDSQL. Valid values: percona, mariadb, mysql.
    Note: This field may return null, indicating that no valid values can be obtained.
    InstanceId String No Database instance ID in the format of cdb-powiqx8q
    Note: This field may return null, indicating that no valid values can be obtained.
    Ip String No Instance IP address, which is required if the access type is not cdb.
    Note: This field may return null, indicating that no valid values can be obtained.
    Port Integer No Instance port, which is required if the access type is not cdb.
    Note: This field may return null, indicating that no valid values can be obtained.
    User String No Username, which is required for an instance authenticated by username and password.
    Note: This field may return null, indicating that no valid values can be obtained.
    Password String No Password, which is required for an instance authenticated by username and password.
    Note: This field may return null, indicating that no valid values can be obtained.
    DbName String No Database name, which is required if the database type is cdwpg.
    Note: This field may return null, indicating that no valid values can be obtained.
    VpcId String No VPC ID in the format of vpc-92jblxto, which is required if the access type is vpc, dcg, or vpncloud.
    Note: This field may return null, indicating that no valid values can be obtained.
    SubnetId String No ID of the subnet in the VPC in the format of subnet-3paxmkdz, which is required if the access type is vpc, dcg, or vpncloud.
    Note: This field may return null, indicating that no valid values can be obtained.
    CvmInstanceId String No Short CVM instance ID in the format of ins-olgl39y8, which is required if the access type is cvm. It is the same as the instance ID displayed in the CVM console.
    Note: This field may return null, indicating that no valid values can be obtained.
    UniqDcgId String No Direct Connect gateway ID in the format of dcg-0rxtqqxb, which is required if the access type is dcg.
    Note: This field may return null, indicating that no valid values can be obtained.
    UniqVpnGwId String No VPN gateway ID in the format of vpngw-9ghexg7q, which is required if the access type is vpncloud.
    Note: This field may return null, indicating that no valid values can be obtained.
    CcnId String No CCN instance ID in the format of ccn-afp6kltc, which is required if the access type is ccn.
    Note: This field may return null, indicating that no valid values can be obtained.
    Supplier String No Cloud vendor type. For Alibaba Cloud ApsaraDB for RDS instances, enter aliyun; otherwise, enter others. Default value: others.
    Note: This field may return null, indicating that no valid values can be obtained.
    EngineVersion String No Database version in the format of 5.6 or 5.7, which takes effect only if the instance is an RDS instance. Default value: 5.6.
    Note: This field may return null, indicating that no valid values can be obtained.
    Account String No Instance account, which is required if the operation is performed across accounts.
    Note: This field may return null, indicating that no valid values can be obtained.
    AccountMode String No The account to which the resource belongs. Valid values: empty or self (the current account); other (another account).
    Note: This field may return null, indicating that no valid values can be obtained.
    AccountRole String No The role used for cross-account sync, which can contain [a-zA-Z0-9-_]+ and is required if the operation is performed across accounts.
    Note: This field may return null, indicating that no valid values can be obtained.
    RoleExternalId String No External role ID
    Note: This field may return null, indicating that no valid values can be obtained.
    TmpSecretId String No Temporary SecretId, you can obtain the temporary key by GetFederationToken. This field is required if it is a cross-account instance.Note: This field may return null, indicating that no valid values can be obtained.
    TmpSecretKey String No Temporary SecretKey, you can obtain the temporary key by GetFederationToken. This field is required if it is a cross-account instance.Note: This field may return null, indicating that no valid values can be obtained.
    TmpToken String No Temporary token, you can obtain the temporary key by GetFederationToken. This field is required if it is a cross-account instance. Note: This field may return null, indicating that no valid values can be obtained.
    EncryptConn String No Whether to enable encrypted transfer (UnEncrypted: No; Encrypted: Yes). Default value: UnEncrypted.
    Note: This field may return null, indicating that no valid values can be obtained.
    DatabaseNetEnv String No Network environment of the database. This parameter is required when AccessType is ccn. Valid values: UserIDC (user IDC), TencentVPC (Tencent Cloud VPC).
    Note: This field may return null, indicating that no valid values can be obtained.
    CcnOwnerUin String No The root account of CCN in the scenario where the database is connected to CCN under another Tencent Cloud account
    Note: This field may return null, indicating that no valid values can be obtained.
    ChildInstanceId String No
    ChildInstanceType String No
    SetId String No

    EndpointItem

    Instance node information of data subscription

    Used by actions: ConfigureSubscribeJob, DescribeSubscribeDetail, DescribeSubscribeJobs.

    Name Type Required Description
    DatabaseRegion String Yes Region of the source database. If AccessType is ccn, please fill in the region where vpc is located because the region of the source database is unknown. For other access methods, please fill in the region where the subscription task is located, as ensuring the subscription task and the source database are in the same region is the optimal network solution.Note: This field may return null, indicating that no valid values can be obtained.
    User String Yes UsernameNote: This field may return null, indicating that no valid values can be obtained.
    Password String Yes Password. It is required when used as an input parameter and empty when used as an output parameter.Note: This field may return null, indicating that no valid values can be obtained.
    InstanceId String No Target instance ID. This field is required when AccessType is cdb. When configuring the InstanceId, the instance information is queried and checked. The mysql query interface has been authenticated. Please ensure that the sub-user has the cdb:DescribeDBInstances interface permission.Note: This field may return null, indicating that no valid values can be obtained.
    CvmInstanceId String No Cloud Virtual Machine ID. This field is required when AccessType is cvm.Note: This field may return null, indicating that no valid values can be obtained.
    UniqDcgId String No Direct Connect gateway ID. This field is required when AccessType is dcg.Note: This field may return null, indicating that no valid values can be obtained.
    CcnId String No Cloud Connect Network ID. This field is required when AccessType is ccn.Note: This field may return null, indicating that no valid values can be obtained.
    UniqVpnGwId String No VPN gateway ID. This field is required when AccessType is vpncloud.Note: This field may return null, indicating that no valid values can be obtained.
    VpcId String No VpcID. This field is required when AccessType is dcg\ccn\vpncloud\vpc.Note: This field may return null, indicating that no valid values can be obtained.
    SubnetId String No Subnet ID. This field is required when AccessType is dcg\ccn\vpncloud\vpc.Note: This field may return null, indicating that no valid values can be obtained.
    HostName String No Database address, supports domain name and IP. This field is required when AccessType is dcg\ccn\vpncloud\vpc\extranet\intranet.Note: This field may return null, indicating that no valid values can be obtained.
    Port Integer No Database port. This field is required when AccessType is dcg\ccn\vpncloud\vpc\extranet\intranet\cvm.Note: This field may return null, indicating that no valid values can be obtained.
    EncryptConn String No Whether to use encrypted transmission. Valid values: UnEncrypted; Encrypted. Only mysql supports it. If it is not filled in, it will not be encrypted by default. Other products do not need to fill in this.Note: This field may return null, indicating that no valid values can be obtained.
    DatabaseNetEnv String No Database network environment. This field is required when AccessType is ccn. Valid values: UserIDC; TencentVPC; Aws; AliYun; Others.Note: This field may return null, indicating that no valid values can be obtained.
    CcnOwnerUin String No The UIN of the main account to which the Cloud Connect Network gateway belongs. It is required for cross-account CCN.Note: This field may return null, indicating that no valid values can be obtained.
    ExtraAttr Array of KeyValuePairOption No Additional information added for the business. Parameter name is called key, parameter value is called value. Mandatory parameters for tdpg: PgDatabase (subscribed database name).Note: This field may return null, indicating that no valid values can be obtained.
    ChildInstanceId String No
    ChildInstanceType String No

    ErrInfo

    Error information and the corresponding solution

    Used by actions: DescribeSyncJobs.

    Name Type Description
    Reason String Cause of the error
    Message String Error message
    Note: This field may return null, indicating that no valid values can be obtained.
    Solution String Solution
    Note: This field may return null, indicating that no valid values can be obtained.

    ErrorInfoItem

    Task error information

    Used by actions: DescribeMigrationDetail.

    Name Type Description
    Code String Error code
    Note: This field may return null, indicating that no valid values can be obtained.
    Solution String Solution
    Note: This field may return null, indicating that no valid values can be obtained.
    ErrorLog String Error log
    Note: This field may return null, indicating that no valid values can be obtained.
    HelpDoc String Help document
    Note: This field may return null, indicating that no valid values can be obtained.

    GroupInfo

    Kafka consumer group details

    Used by actions: DescribeConsumerGroups.

    Name Type Description
    Account String Consumer group account
    ConsumerGroupName String Consumer group name
    Description String Consumer group descriptionNote: This field may return null, indicating that no valid values can be obtained.
    ConsumerGroupOffset Integer Consumer group offset. This field is for compatibility with the previous single partition scenario, where the value is the offset of the last partition. For the offset of each partition, please refer to the StateOfPartition field.
    ConsumerGroupLag Integer The amount of data that has not been consumed by the consumer group. This field is for compatibility with the previous single partition scenario, where the value is the amount of unconsumed data in the last partition. For the amount of unconsumed data in each partition, refer to the StateOfPartition field.
    Latency Integer Consumption delay (in seconds)
    StateOfPartition Array of MonitorInfo Consumption status of each partition
    CreatedAt String Consumer group creation time, the format is: YYYY-MM-DD hh:mm:ss.
    UpdatedAt String Consumer group update time, the format is: YYYY-MM-DD hh:mm:ss.
    ConsumerGroupState String Consumer group states, including Dead, Empty, Stable, etc. Only Dead and Empty states can perform reset operations.
    PartitionAssignment Array of PartitionAssignment The partition is being consumed by each consumer.Note: This field may return null, indicating that no valid values can be obtained.

    JobItem

    Migration task list

    Used by actions: DescribeMigrationJobs.

    Name Type Description
    JobId String Data migration task ID
    Note: This field may return null, indicating that no valid values can be obtained.
    JobName String Data migration task name
    Note: This field may return null, indicating that no valid values can be obtained.
    CreateTime String Task creation (submission) time in the format of yyyy-mm-dd hh:mm:ss
    Note: This field may return null, indicating that no valid values can be obtained.
    UpdateTime String Task update time in the format of yyyy-mm-dd hh:mm:ss
    Note: This field may return null, indicating that no valid values can be obtained.
    StartTime String Task start time in the format of yyyy-mm-dd hh:mm:ss
    Note: This field may return null, indicating that no valid values can be obtained.
    EndTime String Task end time in the format of yyyy-mm-dd hh:mm:ss
    Note: This field may return null, indicating that no valid values can be obtained.
    BriefMsg String Migration task error message
    Note: This field may return null, indicating that no valid values can be obtained.
    Status String Task status. Valid values: creating (Creating), created(Created), checking (Checking), checkPass (Check passed), checkNotPass (Check not passed), readyRun (Ready for running), running (Running), readyComplete (Preparation completed), success (Successful), failed (Failed), stopping (Stopping), completing (Completing), pausing (Pausing), manualPaused (Paused). Note: This field may return null, indicating that no valid values can be obtained.
    RunMode String Task running mode. Valid values: immediate, timed.
    Note: This field may return null, indicating that no valid values can be obtained.
    ExpectRunTime String Expected start time in the format of "2022-07-11 16:20:49", which is required if RunMode is timed.
    Note: This field may return null, indicating that no valid values can be obtained.
    Action MigrateAction Task operation information
    Note: This field may return null, indicating that no valid values can be obtained.
    StepInfo MigrateDetailInfo Information of the migration task execution process
    Note: This field may return null, indicating that no valid values can be obtained.
    SrcInfo DBEndpointInfo Source instance information
    Note: This field may return null, indicating that no valid values can be obtained.
    DstInfo DBEndpointInfo Target database information
    Note: This field may return null, indicating that no valid values can be obtained.
    CompareTask CompareTaskInfo Data consistency check result
    Note: This field may return null, indicating that no valid values can be obtained.
    TradeInfo TradeInfo Billing status information
    Note: This field may return null, indicating that no valid values can be obtained.
    Tags Array of TagItem Tag information
    Note: This field may return null, indicating that no valid values can be obtained.
    AutoRetryTimeRangeMinutes Integer Information of automatic retry time
    Note: This field may return null, indicating that no valid values can be obtained.
    DumperResumeCtrl String Whether the task can be reentered in the full export stage. Valid values: yes, no. yes: The current task can be reentered. no: The current task is in the full export stage which cannot be reentered. If the value of this parameter is no, the checkpoint restart is not supported when the task is restarted in the export stage.
    Note: This field may return null, indicating that no valid values can be obtained.

    KafkaOption

    Sync options configured when the target database is Kafka

    Used by actions: ConfigureSyncJob, DescribeSyncJobs.

    Name Type Required Description
    DataType String No Data type delivered to Kafka, such as Avro, Json, canal-pb, canal-json
    TopicType String No Topic sync policy, such as Single (deliver all data to a single topic), Multi (deliver data to multiple custom topics).
    DDLTopicName String No Topic for DDL storage
    TopicRules Array of TopicRule No Topic description

    KeyValuePairOption

    Additional configuration information

    Used by actions: ConfigureSubscribeJob, DescribeMigrationDetail, DescribeMigrationJobs, DescribeSubscribeDetail, ModifyMigrateRuntimeAttribute, ModifyMigrationJob.

    Name Type Required Description
    Key String No Option key
    Note: This field may return null, indicating that no valid values can be obtained.
    Value String No Option value
    Note: This field may return null, indicating that no valid values can be obtained.

    MigrateAction

    Task operation information, which contains the list of all operations in the migration task as well as the list of allowed operations under the current status.

    Used by actions: DescribeMigrationDetail, DescribeMigrationJobs.

    Name Type Description
    AllAction Array of String List of all operations in the task
    Note: This field may return null, indicating that no valid values can be obtained.
    AllowedAction Array of String List of allowed operations in the task under the current status
    Note: This field may return null, indicating that no valid values can be obtained.

    MigrateDBItem

    Object in the migration task instance list

    Used by actions: DescribeMigrateDBInstances.

    Name Type Description
    InstanceId String Instance ID
    InstanceName String Instance name
    Vip String Instance VIP
    Vport Integer Instance Vport
    Usable Integer Whether the instance can be migrated. Valid values: 1 (yes); 0` (no).
    Hint String The cause why the instance cannot be migrated

    MigrateDetailInfo

    Information of the migration task execution process

    Used by actions: DescribeMigrationDetail, DescribeMigrationJobs.

    Name Type Description
    StepAll Integer Total number of steps
    Note: This field may return null, indicating that no valid values can be obtained.
    StepNow Integer Current step
    Note: This field may return null, indicating that no valid values can be obtained.
    MasterSlaveDistance Integer Source-replica lag in MB. This parameter takes effect only when the task is normal and is in the last step of migration or sync (binlog sync). If it is invalid, -1 will be returned.
    Note: This field may return null, indicating that no valid values can be obtained.
    SecondsBehindMaster Integer Source-replica lag in seconds. This parameter takes effect only when the task is normal and is in the last step of migration or sync (binlog sync). If it is invalid, -1 will be returned.
    Note: This field may return null, indicating that no valid values can be obtained.
    StepInfo Array of StepDetailInfo Step information
    Note: This field may return null, indicating that no valid values can be obtained.

    MigrateOption

    Migration options, which describe how the task performs migration.

    Used by actions: DescribeMigrationDetail, ModifyMigrationJob.

    Name Type Required Description
    DatabaseTable DatabaseTableObject Yes Migration object options, which tell DTS which database/table objects should be migrated.
    Note: This field may return null, indicating that no valid values can be obtained.
    MigrateType String No Migration type. Valid values: full, structure, fullAndIncrement. Default value: fullAndIncrement.
    Note: This field may return null, indicating that no valid values can be obtained.
    Consistency ConsistencyOption No Data consistency check option. Data consistency check is disabled by default.
    Note: This field may return null, indicating that no valid values can be obtained.
    IsMigrateAccount Boolean No Whether to migrate accounts. Valid values: yes, no.
    Note: This field may return null, indicating that no valid values can be obtained.
    IsOverrideRoot Boolean No Whether to use the Root account in the source database to overwrite that in the target database. Valid values: false, true. For database/table or structural migration, you should specify false. Note that this parameter takes effect only for OldDTS.
    Note: This field may return null, indicating that no valid values can be obtained.
    IsDstReadOnly Boolean No Whether to set the target database to read-only during migration, which takes effect only for MySQL databases. Valid values: true, false. Default value: false.
    Note: This field may return null, indicating that no valid values can be obtained.
    ExtraAttr Array of KeyValuePairOption No Additional information. You can set additional parameters for certain database types. For Redis, you can define the following parameters:
    ["DstWriteMode": normal. Target database write mode. Valid values: clearData (Clear the target instance data), overwrite(Execute the task in overwriting mode),normal(Follow the normal steps) "IsDstReadOnly":true. Whether to set the target database to read-only for a migration task. Valid values: true(Yes),false` (No) "ClientOutputBufferHardLimit": 512. Hard limit of the replica buffer zone capacity in MB. "ClientOutputBufferSoftLimit": 512. Soft limit of the replica buffer zone capacity in MB. "ClientOutputBufferPersistTime": 60. Soft limit duration of the replica buffer zone in seconds. "ReplBacklogSize": 512, Limit of the circular buffer zone capacity in MB. "ReplTimeout":120, Replication timeout period in seconds]
    Note: This field may return null, indicating that no valid values can be obtained.
    MigrateWay String No

    ModifiedSubscribeObject

    The object of the data subscription is used in the ModifySubscribeObjects interface. Similar to the SubscribeObject structure, only the type and parameter names differ.

    Used by actions: ModifySubscribeObjects.

    Name Type Required Description
    ObjectsType Integer Yes Subscription object type. Valid values: 0 (database); 1 (table, for mongo tasks, this corresponds to a collection).Note: mongo only supports full instance, single database or single collection subscription, so this field should not conflict with SubscribeObjectType. For example, when SubscribeObjectType=4, it means mongo single database subscription, then 0 should be passed in this field.Note: This field may return null, indicating that no valid values can be obtained.
    DatabaseName String Yes Subscription database nameNote: This field may return null, indicating that no valid values can be obtained.
    TableNames Array of String No Name of the table (or collection) in the subscription database. If ObjectsType is 1, this field is required and not empty;

    MonitorInfo

    Partition details of Kafka consumer group

    Used by actions: DescribeConsumerGroups.

    Name Type Description
    PartitionNo Integer The number of the current partition, starting from 0.
    ConsumerGroupOffset Integer The offset of the current partition.
    ConsumerGroupLag Integer The amount of unconsumed data in the current partition.
    Latency Integer The consumption delay of the current partition (in seconds).

    Objects

    Description of synced database objects

    Used by actions: ConfigureSyncJob, DescribeSyncJobs, ModifySyncJobConfig.

    Name Type Required Description
    Mode String No Sync object type. Valid value: Partial (Partial objects). Note: This field may return null, indicating that no valid values can be obtained.
    Databases Array of Database No Sync object, which is required if Mode is Partial.
    Note: This field may return null, indicating that no valid values can be obtained.
    AdvancedObjects Array of String No Advanced object types, such as function and procedure. Note: If you want to migrate and synchronize advanced objects, the corresponding advanced object type should be included in this configuration. When advanced objects need to be synchronized, the initialization type must include the structure initialization type, that is, the Options.InitType value of the task is Structure or Full.Note: This field may return null, indicating that no valid values can be obtained.
    OnlineDDL OnlineDDL No A redundant field that specifies the online DDL type
    Note: This field may return null, indicating that no valid values can be obtained.

    OffsetTimeMap

    Checkpoint information in Kafka partition for data subscription.

    Used by actions: DescribeOffsetByTime.

    Name Type Description
    PartitionNo Integer Kafka partition numberNote: This field may return null, indicating that no valid values can be obtained.
    Offset Integer Kafka offsetNote: This field may return null, indicating that no valid values can be obtained.

    OnlineDDL

    Online DDL type

    Used by actions: ConfigureSyncJob, DescribeSyncJobs, ModifySyncJobConfig.

    Name Type Required Description
    Status String Yes Status
    Note: This field may return null, indicating that no valid values can be obtained.

    Options

    Data sync options

    Used by actions: ConfigureSyncJob, DescribeSyncJobs.

    Name Type Required Description
    InitType String No Sync initialization option. Valid values: data (full data initialization); Structure (structure initialization); Full (full data and structure initialization); None (incremental data only). Default value: Full.
    Note: This field may return null, indicating that no valid values can be obtained.
    DealOfExistSameTable String No Processing method for duplicate tables. Valid values: ReportErrorAfterCheck, InitializeAfterDelete, ExecuteAfterIgnore. Default value: ReportErrorAfterCheck.
    Note: This field may return null, indicating that no valid values can be obtained.
    ConflictHandleType String No Conflict processing option. Valid values: ReportError (report an error); Ignore (ignore); Cover (overwrite); ConditionCover (conditionally overwrite). Default value: ReportError.
    Note: This field may return null, indicating that no valid values can be obtained.
    AddAdditionalColumn Boolean No Whether to add the additional column
    Note: This field may return null, indicating that no valid values can be obtained.
    OpTypes Array of String No DML and DDL options to be synced. Valid values: Insert (INSERT operations); Update (UPDATE operations); Delete (DELETE operations); DDL (structure sync); PartialDDL (custom option, which is used together with DdlOptions). You can also leave this parameter empty.
    Note: This field may return null, indicating that no valid values can be obtained.
    ConflictHandleOption ConflictHandleOption No Detailed option for conflict processing, such as condition rows and operations in conditional overwrite.
    Note: This field may return null, indicating that no valid values can be obtained.
    DdlOptions Array of DdlOption No DDL statements to be synced
    Note: This field may return null, indicating that no valid values can be obtained.
    KafkaOption KafkaOption No Kafka sync options
    Note: This field may return null, indicating that no valid values can be obtained.
    RateLimitOption RateLimitOption No Task speed limit information
    Note: This field may return null, indicating that no valid values can be obtained.
    AutoRetryTimeRangeMinutes Integer No Settings of the automatic retry time range
    Note: This field may return null, indicating that no valid values can be obtained.
    FilterBeginCommit Boolean No
    FilterCheckpoint Boolean No

    PartitionAssignment

    The partition allocation of Kafka consumer groups in data subscriptions. This data is queried in real time. If you need the latest data, you need to call the interface again.

    Used by actions: DescribeConsumerGroups.

    Name Type Description
    ClientId String The clientId of the consumer
    PartitionNo Array of Integer The partition is being consumed by this consumer.Note: This field may return null, indicating that no valid values can be obtained.

    PipelineInfo

    Mongo output aggregation settings. Default value: Change Event.

    Used by actions: ConfigureSubscribeJob, DescribeSubscribeDetail, ModifySubscribeObjects.

    Name Type Required Description
    AggOp String No Aggregation operators: $addFields, $match, $project, $replaceRoot, $redact, $replaceWith, $set, $unset. $replaceWith, $set, $unset are available options for subscription instances that are version 4.2 or higher.Note: This field may return null, indicating that no valid values can be obtained.
    AggCmd String No Aggregation expression must be in json format.Note: This field may return null, indicating that no valid values can be obtained.

    ProcessProgress

    Task step information

    Used by actions: DescribeCompareTasks, DescribeMigrationDetail.

    Name Type Description
    Status String Step status. Valid values: notStarted, running, success, failed.
    Note: This field may return null, indicating that no valid values can be obtained.
    Percent Integer Progress information
    Note: This field may return null, indicating that no valid values can be obtained.
    StepAll Integer Total number of steps
    Note: This field may return null, indicating that no valid values can be obtained.
    StepNow Integer Current step
    Note: This field may return null, indicating that no valid values can be obtained.
    Message String The prompt output in the current step
    Note: This field may return null, indicating that no valid values can be obtained.
    Steps Array of StepDetailInfo Step information
    Note: This field may return null, indicating that no valid values can be obtained.

    ProcessStepTip

    Object of the error or warning information

    Used by actions: DescribeCompareTasks, DescribeMigrationDetail, DescribeMigrationJobs.

    Name Type Description
    Message String Prompt message
    Note: This field may return null, indicating that no valid values can be obtained.
    Solution String Solution
    Note: This field may return null, indicating that no valid values can be obtained.
    HelpDoc String Help document
    Note: This field may return null, indicating that no valid values can be obtained.

    RateLimitOption

    Speed limit details of migration and sync tasks

    Used by actions: ConfigureSyncJob, DescribeMigrationDetail, DescribeSyncJobs.

    Name Type Required Description
    CurrentDumpThread Integer Yes The number of full export threads currently in effect. The value of this field can be adjusted when configuring the task. Note: If it is not set or set to 0, it means the current value is maintained. The maximum value is 16.Note: This field may return null, indicating that no valid values can be obtained.
    DefaultDumpThread Integer Yes The default number of full export threads. This field is only meaningful in the output parameter.Note: This field may return null, indicating that no valid values can be obtained.
    CurrentDumpRps Integer Yes The full export Rps currently in effect. The value of this field can be adjusted when configuring the task. Note: If it is not set or set to 0, it means the current value is maintained. The maximum value is 50,000,000.Note: This field may return null, indicating that no valid values can be obtained.
    DefaultDumpRps Integer Yes The default full export Rps. This field is only meaningful in the output parameter.Note: This field may return null, indicating that no valid values can be obtained.
    CurrentLoadThread Integer Yes The number of full import threads currently in effect. The value of this field can be adjusted when configuring the task. Note: If it is not set or set to 0, it means the current value is maintained. The maximum value is 16.Note: This field may return null, indicating that no valid values can be obtained.
    DefaultLoadThread Integer Yes The default number of full import threads. This field is only meaningful in the output parameter.Note: This field may return null, indicating that no valid values can be obtained.
    CurrentLoadRps Integer Yes The full import Rps currently in effect. The value of this field can be adjusted when configuring the task. Note: If it is not set or set to 0, it means the current value is maintained. The maximum value is 50,000,000.Note: This field may return null, indicating that no valid values can be obtained.
    DefaultLoadRps Integer Yes The default full import Rps. This field is only meaningful in the output parameter.Note: This field may return null, indicating that no valid values can be obtained.
    CurrentSinkerThread Integer Yes The number of incremental import threads currently in effect. The value of this field can be adjusted when configuring the task. Note: If it is not set or set to 0, it means the current value is maintained. The maximum value is 128.Note: This field may return null, indicating that no valid values can be obtained.
    DefaultSinkerThread Integer Yes The default number of incremental import threads. This field is only meaningful in the output parameter.
    Note: This field may return null, indicating that no valid values can be obtained.
    HasUserSetRateLimit String Yes enum:"no"/"yes", no: the user has not set a speed limit; yes: a speed limit has been set. This field is only meaningful in the output parameter.Note: This field may return null, indicating that no valid values can be obtained.

    RoleItem

    Role object, which is exclusive to PostgreSQL.

    Used by actions: DescribeMigrationDetail, ModifyMigrationJob.

    Name Type Required Description
    RoleName String No Role name
    Note: This field may return null, indicating that no valid values can be obtained.
    NewRoleName String No Role name after migration
    Note: This field may return null, indicating that no valid values can be obtained.

    SkippedDetail

    Details of skipped tables

    Used by actions: DescribeCompareReport.

    Name Type Description
    TotalCount Integer Number of skipped tables
    Note: This field may return null, indicating that no valid values can be obtained.
    Items Array of SkippedItem Details of skipped tables
    Note: This field may return null, indicating that no valid values can be obtained.

    SkippedItem

    Details of skipped tables

    Used by actions: DescribeCompareReport.

    Name Type Description
    Db String Database name
    Note: This field may return null, indicating that no valid values can be obtained.
    Table String Table name
    Note: This field may return null, indicating that no valid values can be obtained.
    Reason String The cause why check is not initiated
    Note: This field may return null, indicating that no valid values can be obtained.

    StepDetailInfo

    Step information

    Used by actions: DescribeCompareTasks, DescribeMigrationDetail, DescribeMigrationJobs.

    Name Type Description
    StepNo Integer Step number
    Note: This field may return null, indicating that no valid values can be obtained.
    StepName String Step name
    Note: This field may return null, indicating that no valid values can be obtained.
    StepId String Step ID
    Note: This field may return null, indicating that no valid values can be obtained.
    Status String Step status. Valid values: success, failed, running, notStarted. Default value: notStarted.
    Note: This field may return null, indicating that no valid values can be obtained.
    StartTime String Start time of the current step in the format of "yyyy-mm-dd hh:mm:ss". If this field does not exist or is empty, it is meaningless.
    Note: This field may return null, indicating that no valid values can be obtained.
    StepMessage String Step error message
    Note: This field may return null, indicating that no valid values can be obtained.
    Percent Integer Execution progress
    Note: This field may return null, indicating that no valid values can be obtained.
    Errors Array of ProcessStepTip Error message
    Note: This field may return null, indicating that no valid values can be obtained.
    Warnings Array of ProcessStepTip Warning
    Note: This field may return null, indicating that no valid values can be obtained.

    StepInfo

    Step details

    Used by actions: DescribeCheckSyncJobResult, DescribeModifyCheckSyncJobResult, DescribeSyncJobs.

    Name Type Required Description
    StepNo Integer No Step number
    Note: This field may return null, indicating that no valid values can be obtained.
    StepName String No Step name
    Note: This field may return null, indicating that no valid values can be obtained.
    StepId String No Step ID
    Note: This field may return null, indicating that no valid values can be obtained.
    Status String No Status of the current step. Valid values: notStarted, running, failed, finished, skipped, paused`.
    Note: This field may return null, indicating that no valid values can be obtained.
    StartTime String No Step start time, which may be null.
    Note: This field may return null, indicating that no valid values can be obtained.
    Errors Array of StepTip No Error message
    Note: This field may return null, indicating that no valid values can be obtained.
    Warnings Array of StepTip No Warning message
    Note: This field may return null, indicating that no valid values can be obtained.
    Progress Integer No Current step progress. Value range: 0-100. The value -1 indicates that the progress of the current step is unavailable. Note: This field may return null, indicating that no valid values can be obtained.

    StepTip

    Error or warning information in the current step

    Used by actions: DescribeCheckSyncJobResult, DescribeModifyCheckSyncJobResult.

    Name Type Required Description
    Code String No Error code
    Note: This field may return null, indicating that no valid values can be obtained.
    Message String No Error message
    Note: This field may return null, indicating that no valid values can be obtained.
    Solution String No Solution
    Note: This field may return null, indicating that no valid values can be obtained.
    HelpDoc String No Help document
    Note: This field may return null, indicating that no valid values can be obtained.
    SkipInfo String No Whether the current step is skipped
    Note: This field may return null, indicating that no valid values can be obtained.

    SubsErr

    Subscription error message

    Used by actions: DescribeSubscribeDetail, DescribeSubscribeJobs.

    Name Type Description
    Message String Error message

    SubscribeCheckStepInfo

    Information about each step of the subscription check task.

    Used by actions: DescribeSubscribeCheckJob.

    Name Type Description
    StepName String Step name
    Note: This field may return null, indicating that no valid values can be obtained.
    StepId String Step Id
    Note: This field may return null, indicating that no valid values can be obtained.
    StepNo Integer Step number, starting from 1
    Note: This field may return null, indicating that no valid values can be obtained.
    Status String Current step status. Valid values: notStarted, running, finished, failed.Note: This field may return null, indicating that no valid values can be obtained.
    Percent Integer Current step progressNote: This field may return null, indicating that no valid values can be obtained.
    Errors Array of SubscribeCheckStepTip Error messageNote: This field may return null, indicating that no valid values can be obtained.
    Warnings Array of SubscribeCheckStepTip Warning messageNote: This field may return null, indicating that no valid values can be obtained.

    SubscribeCheckStepTip

    Prompts for subscription check tasks

    Used by actions: DescribeSubscribeCheckJob.

    Name Type Description
    Message String Error or warning detailsNote: This field may return null, indicating that no valid values can be obtained.
    HelpDoc String Help documentation
    Note: This field may return null, indicating that no valid values can be obtained.

    SubscribeInfo

    Subscription instance information

    Used by actions: DescribeSubscribeJobs.

    Name Type Description
    SubscribeId String Data subscription instance ID
    SubscribeName String Data subscription instance name
    Topic String Kafka topic for data sent by the subscription instance
    Note: This field may return null, indicating that no valid values can be obtained.
    Product String Subscription instance type. Currently, cynosdbmysql, mariadb, mongodb, mysql, percona, tdpg, tdsqlpercona are supported.
    InstanceId String The subscribed database instance ID (if the subscription is a cloud database). If the instance is not on Tencent Cloud, this value is empty.Note: This field may return null, indicating that no valid values can be obtained.
    InstanceStatus String Cloud database status: running, isolated, offline. If it is not on the cloud, this value is empty.Note: This field may return null, indicating that no valid values can be obtained.
    Status String Data subscription lifecycle status. Valid values: normal (normal), isolating (isolating), isolated (isolated), offlining (offlining), post2PrePayIng (changing from pay-as-you-go to monthly subscription).
    SubsStatus String Data subscription status. Valid values: notStarted, checking, checkNotPass, checkPass, starting, running, error.
    ModifyTime String Last modification time, the format is: Y-m-d h:m:s.Note: This field may return null, indicating that no valid values can be obtained.
    CreateTime String Creation time, the format is: Y-m-d h:m:s.Note: This field may return null, indicating that no valid values can be obtained.
    IsolateTime String Isolation time, the format is: Y-m-d h:m:s. Default time: 0000-00-00 00:00:00.Note: This field may return null, indicating that no valid values can be obtained.
    ExpireTime String Expiration time for monthly subscription tasks, the format is: Y-m-d h:m:s. Default time: 0000-00-00 00:00:00.Note: This field may return null, indicating that no valid values can be obtained.
    OfflineTime String Offline time, the format is: Y-m-d h:m:s. Default time: 0000-00-00 00:00:00.Note: This field may return null, indicating that no valid values can be obtained.
    PayType Integer Billing mode. 1: pay-as-you-go
    AutoRenewFlag Integer Auto-renewal flag. It is meaningful only when PayType=0. Valid values: 0 (auto-renewal disabled); 1 (auto-renewal enabled).
    Region String Data subscription instance region
    AccessType String Access type. Valid values: extranet (public network); vpncloud (VPN access); dcg (Direct Connect); ccn (CCN); cdb (database); cvm (self-build on CVM); intranet (intranet); vpc (VPC).Note: This field may return null, indicating that no valid values can be obtained.
    Endpoints Array of EndpointItem Database node information
    Note: This field may return null, indicating that no valid values can be obtained.
    SubscribeVersion String Data subscription version, only Kafka version is currently supported.Note: This field may return null, indicating that no valid values can be obtained.
    Tags Array of TagItem TagNote: This field may return null, indicating that no valid values can be obtained.
    Errors Array of SubsErr Task error messageNote: This field may return null, indicating that no valid values can be obtained.

    SubscribeKafkaConfig

    Number of subscribed Kafka partitions and partition rules. mariadb, percona, tdsqlmysql, tdpg do not support custom partitions, so DistributeRules and DefaultRuleType can be left blank, but NumberOfPartitions is required.

    Used by actions: ConfigureSubscribeJob, DescribeSubscribeDetail.

    Name Type Required Description
    NumberOfPartitions Integer Yes Number of Kafka partitions. Valid values: 1, 4, 8.Note: This field may return null, indicating that no valid values can be obtained.
    DistributeRules Array of DistributeRule No Partition rules. This field is required when NumberOfPartitions > 1.Note: This field may return null, indicating that no valid values can be obtained.
    DefaultRuleType String No Default partitioning policy. If NumberOfPartitions > 1, this field is required. Data that does not meet the regex in DistributeRules will be partitioned according to the default partitioning policy.Valid values for non-mongo products: table (partitioned by table name); pk (partitioned by table name + primary key). Valid values for mongo: collection (partitioned by collection name). This field is used in conjunction with DistributeRules. If this field is configured, it is considered as configuring a DistributeRules.
    Note: This field may return null, indicating that no valid values can be obtained.

    SubscribeObject

    Subscription database and table information, used to configure and query the subscription task interfaces.

    Used by actions: ConfigureSubscribeJob, DescribeSubscribeDetail.

    Name Type Required Description
    ObjectType String Yes Subscription data type. Valid values: database; table (if DatabaseType is mongodb, it means a collection).Note: This field may return null, indicating that no valid values can be obtained.
    Database String Yes Subscribed database name
    Note: This field may return null, indicating that no valid values can be obtained.
    Tables Array of String No Name of the table in the subscribed database. If DatabaseType is mongodb, fill in the collection name. MongoDB only supports subscribing to a single database or a single collection.Note: This field may return null, indicating that no valid values can be obtained.

    SyncDBEndpointInfos

    Node information of multi-node databases configured for data sync. This data structure is valid for multi-node databases such as TDSQL for MySQL. For single-node databases such as MySQL, use Endpoint instead.

    Used by actions: ConfigureSyncJob, DescribeSyncJobs.

    Name Type Required Description
    Region String Yes Region of the database
    Note: This field may return null, indicating that no valid values can be obtained.
    AccessType String Yes Instance network access type. Valid values: extranet (public network); ipv6 (public IPv6); cvm (self-build on CVM); dcg (Direct Connect); vpncloud (VPN access); cdb (database); ccn (CCN); intranet (intranet); vpc (VPC). Note that the valid values are subject to the current link.
    Note: This field may return null, indicating that no valid values can be obtained.
    DatabaseType String Yes Database type, such as mysql, redis, mongodb, postgresql, mariadb, and percona.
    Note: This field may return null, indicating that no valid values can be obtained.
    Info Array of Endpoint Yes Database information. Note: If the data type is tdsqlmysql, the order of this Endpoint array should correspond to the set order, and the first shard (shardkey range starting from 0) must be entered first.Note: This field may return null, indicating that no valid values can be obtained.

    SyncDetailInfo

    Step information of the sync task

    Used by actions: DescribeSyncJobs.

    Name Type Description
    StepAll Integer Total number of steps
    Note: This field may return null, indicating that no valid values can be obtained.
    StepNow Integer Current step
    Note: This field may return null, indicating that no valid values can be obtained.
    Progress Integer Overall progress
    Note: This field may return null, indicating that no valid values can be obtained.
    CurrentStepProgress Integer Progress of the current step. Value range: 0-100. The value of -1 indicates that you can't check the progress of the current step.
    Note: This field may return null, indicating that no valid values can be obtained.
    MasterSlaveDistance Integer Data volume difference between the sync source and target
    Note: This field may return null, indicating that no valid values can be obtained.
    SecondsBehindMaster Integer Time difference between the sync source and target
    Note: This field may return null, indicating that no valid values can be obtained.
    Message String Overall description
    Note: This field may return null, indicating that no valid values can be obtained.
    StepInfos Array of StepInfo Step details
    Note: This field may return null, indicating that no valid values can be obtained.
    CauseOfCompareDisable String Cause of the failure of initiating data consistency check
    Note: This field may return null, indicating that no valid values can be obtained.
    ErrInfo ErrInfo Task error and the corresponding solution
    Note: This field may return null, indicating that no valid values can be obtained.

    SyncJobInfo

    Sync task information

    Used by actions: DescribeSyncJobs.

    Name Type Description
    JobId String Sync task ID, such as sync-btso140.
    Note: This field may return null, indicating that no valid values can be obtained.
    JobName String Sync task name
    Note: This field may return null, indicating that no valid values can be obtained.
    PayMode String Billing mode. Valid values: PostPay (pay-as-you-go); PrePay (monthly subscription).
    Note: This field may return null, indicating that no valid values can be obtained.
    RunMode String Running mode. Valid values: Immediate, Timed. Default value: Immediate.
    Note: This field may return null, indicating that no valid values can be obtained.
    ExpectRunTime String Expected execution time in the format of yyyy-mm-dd hh:mm:ss
    Note: This field may return null, indicating that no valid values can be obtained.
    AllActions Array of String All supported operations
    Note: This field may return null, indicating that no valid values can be obtained.
    Actions Array of String Operations that can be performed under the current status
    Note: This field may return null, indicating that no valid values can be obtained.
    Options Options Sync options
    Note: This field may return null, indicating that no valid values can be obtained.
    Objects Objects Sync database/table objects
    Note: This field may return null, indicating that no valid values can be obtained.
    Specification String Task specification
    Note: This field may return null, indicating that no valid values can be obtained.
    ExpireTime String Expiration time in the format of yyyy-mm-dd hh:mm:ss
    Note: This field may return null, indicating that no valid values can be obtained.
    SrcRegion String Source database region, such as ap-guangzhou.
    Note: This field may return null, indicating that no valid values can be obtained.
    SrcDatabaseType String Source database type, such as mysql, cynosdbmysql, tdapg, tdpg, and tdsqlmysql.
    Note: This field may return null, indicating that no valid values can be obtained.
    SrcAccessType String Source database access type. Valid values: cdb (database); cvm (self-build on CVM); vpc (VPC); extranet (public network); vpncloud (VPN access); dcg (Direct Connect); ccn (CCN); intranet (intranet).
    Note: This field may return null, indicating that no valid values can be obtained.
    SrcInfo Endpoint Source database information. This parameter is used by single-node databases.
    Note: This field may return null, indicating that no valid values can be obtained.
    SrcNodeType String Valid values: cluster, single. single: For single-node source databases; cluster: For multi-node source databases.
    Note: This field may return null, indicating that no valid values can be obtained.
    SrcInfos SyncDBEndpointInfos Source database information. This parameter is used for multi-node databases.
    Note: This field may return null, indicating that no valid values can be obtained.
    DstRegion String Target database region, such as ap-guangzhou.
    Note: This field may return null, indicating that no valid values can be obtained.
    DstDatabaseType String Target database type, such as mysql, cynosdbmysql, tdapg, tdpg, and tdsqlmysql.
    Note: This field may return null, indicating that no valid values can be obtained.
    DstAccessType String Target database access type. Valid values: cdb (database); cvm (self-build on CVM); vpc (VPC); extranet (public network); vpncloud (VPN access); dcg (Direct Connect); ccn (CCN); intranet (intranet).
    Note: This field may return null, indicating that no valid values can be obtained.
    DstInfo Endpoint Target database information. This parameter is used by single-node databases.
    Note: This field may return null, indicating that no valid values can be obtained.
    DstNodeType String Valid values: cluster, single. single: For single-node target databases; cluster: For multi-node target databases.
    Note: This field may return null, indicating that no valid values can be obtained.
    DstInfos SyncDBEndpointInfos Target database information. This parameter is used for multi-node databases.
    Note: This field may return null, indicating that no valid values can be obtained.
    CreateTime String Creation time in the format of yyyy-mm-dd hh:mm:ss
    Note: This field may return null, indicating that no valid values can be obtained.
    StartTime String Start time in the format of yyyy-mm-dd hh:mm:ss
    Note: This field may return null, indicating that no valid values can be obtained.
    Status String Task status. Valid values: UnInitialized, Initialized, Checking, CheckPass, CheckNotPass, ReadyRunning, Running, Pausing, Paused, Stopping, Stopped, ResumableErr, Resuming, Failed, Released, Resetting, Unknown.
    Note: This field may return null, indicating that no valid values can be obtained.
    EndTime String End time in the format of yyyy-mm-dd hh:mm:ss
    Note: This field may return null, indicating that no valid values can be obtained.
    Tags Array of TagItem Tag information
    Note: This field may return null, indicating that no valid values can be obtained.
    Detail SyncDetailInfo Step information of the sync task
    Note: This field may return null, indicating that no valid values can be obtained.
    TradeStatus String Billing status. Valid values: Normal, Resizing, Renewing, Isolating, Isolated, Offlining, Offlined, NotBilled, Recovering, PostPay2Prepaying, PrePay2Postpaying.
    Note: This field may return null, indicating that no valid values can be obtained.
    InstanceClass String Sync link specification, such as micro, small, medium, and large.
    Note: This field may return null, indicating that no valid values can be obtained.
    AutoRenew Integer Auto-renewal flag, which takes effect if PayMode is PrePay. Valid values: 1 (auto-renewal enabled); 0 (auto-renewal disabled).
    Note: This field may return null, indicating that no valid values can be obtained.
    OfflineTime String Deletion time in the format of yyyy-mm-dd hh:mm:ss
    Note: This field may return null, indicating that no valid values can be obtained.
    AutoRetryTimeRangeMinutes Integer Settings of automatic retry time
    Note: This field may return null, indicating that no valid values can be obtained.
    DumperResumeCtrl String Whether the task can be reentered in the full export stage. Valid values: yes, no. yes: The current task can be reentered. no: The current task is in the full export stage which cannot be reentered. If the value of this parameter is no, the checkpoint restart is not supported when the task is restarted in the export stage.
    Note: This field may return null, indicating that no valid values can be obtained.

    Table

    Synced table description

    Used by actions: ConfigureSyncJob, DescribeSyncJobs, ModifySyncJobConfig.

    Name Type Required Description
    TableName String No Table name
    Note: This field may return null, indicating that no valid values can be obtained.
    NewTableName String No New table name
    Note: This field may return null, indicating that no valid values can be obtained.
    FilterCondition String No Filter condition
    Note: This field may return null, indicating that no valid values can be obtained.
    ColumnMode String No Whether to synchronize all columns in the table. All: all columns under the current table; Partial (the corresponding field ColumnMode in ModifySyncJobConfig interface does not support Partial at the moment): some columns under the current table, detailed table information is provided by filling the Columns field.Note: This field may return null, indicating that no valid values can be obtained.
    Columns Array of Column No Column information in data sync. This field is required when ColumnMode is set to Partial.Note: This field may return null, indicating that no valid values can be obtained.
    TmpTables Array of String No The temp tables to be synced. This parameter is mutually exclusive with NewTableName. It is valid only when the configured sync objects are table-level ones and TableEditMode is pt. To sync temp tables generated when pt-osc or other tools are used during the sync process, you must configure this parameter first. For example, if you want to perform the pt-osc operation on a table named "t1", configure this parameter as ["_t1_new","_t1_old"]; to perform the gh-ost operation on t1, configure it as ["_t1_ghc","_t1_gho","_t1_del"]. Temp tables generated by pt-osc and gh-ost operations can be configured at the same time.
    Note: This field may return null, indicating that no valid values can be obtained.
    TableEditMode String No Table editing type. Valid values: rename (table mapping); pt (additional table sync).
    Note: This field may return null, indicating that no valid values can be obtained.

    TableItem

    The set of table objects, which is required if TableMode is partial.

    Used by actions: DescribeMigrationDetail, ModifyMigrationJob.

    Name Type Required Description
    TableName String No Name of the migrated table, which is case-sensitive
    Note: This field may return null, indicating that no valid values can be obtained.
    NewTableName String No New name of the migrated table. This parameter is required when TableEditMode is rename. It is mutually exclusive with TmpTables.
    Note: This field may return null, indicating that no valid values can be obtained.
    TmpTables Array of String No The temp tables to be migrated. This parameter is mutually exclusive with NewTableName. It is valid only when the configured migration objects are table-level ones and TableEditMode is pt. To migrate temp tables generated when pt-osc or other tools are used during the migration process, you must configure this parameter first. For example, if you want to perform the pt-osc operation on a table named "t1", configure this parameter as ["_t1_new","_t1_old"]; to perform the gh-ost operation on t1, configure it as ["_t1_ghc","_t1_gho","_t1_del"]. Temp tables generated by pt-osc and gh-ost operations can be configured at the same time.
    Note: This field may return null, indicating that no valid values can be obtained.
    TableEditMode String No Table editing type. Valid values: rename (table mapping); pt (additional table sync).
    Note: This field may return null, indicating that no valid values can be obtained.

    TagFilter

    Tag filter

    Used by actions: DescribeMigrationJobs, DescribeSubscribeJobs, DescribeSyncJobs.

    Name Type Required Description
    TagKey String Yes Tag key
    TagValue Array of String No Tag value

    TagItem

    Tag

    Used by actions: CreateMigrationService, CreateSubscribe, CreateSyncJob, DescribeMigrationDetail, DescribeMigrationJobs, DescribeSubscribeDetail, DescribeSubscribeJobs, DescribeSyncJobs, ModifyMigrationJob.

    Name Type Required Description
    TagKey String No Tag key
    Note: This field may return null, indicating that no valid values can be obtained.
    TagValue String No Tag value
    Note: This field may return null, indicating that no valid values can be obtained.

    TopicRule

    Topic description

    Used by actions: ConfigureSyncJob, DescribeSyncJobs.

    Name Type Required Description
    TopicName String No Topic name
    PartitionType String No Topic partitioning policy. If the topic sync policy is delivering data to multiple custom topics (TopicType = Multi), the value of this parameter is Random (deliver to a random partition). If the topic sync policy is delivering all data to a single topic (TopicType = Single), this parameter has three valid values: AllInPartitionZero (deliver all data to partition0), PartitionByTable (partition by table name), PartitionByTableAndKey (partition by table name and primary key).
    DbMatchMode String No Database name matching rule. This parameter takes effect only when TopicType is Multi. Valid values: Regular (match by regex), Default (default rule for the remaining databases that cannot be matched by regex). The default rule must be included in the array of matching rules.
    DbName String No Database name, which can only be matched by regex when TopicType is Multi and DbMatchMode is Regular.
    TableMatchMode String No Table name matching rule. This parameter takes effect only when TopicType is Multi. Valid values: Regular (match by regex), Default (default rule for the remaining databases that cannot be matched by regex). The default rule must be included in the array of matching rules.
    TableName String No Table name, which can only be matched by regex when TopicType is Multi and DbMatchMode is Regular.

    TradeInfo

    Billing status information

    Used by actions: DescribeMigrationDetail, DescribeMigrationJobs.

    Name Type Description
    DealName String Order number
    Note: This field may return null, indicating that no valid values can be obtained.
    LastDealName String Last order number
    Note: This field may return null, indicating that no valid values can be obtained.
    InstanceClass String Instance specification. Valid values: micro, small, medium, large, xlarge, 2xlarge.
    Note: This field may return null, indicating that no valid values can be obtained.
    TradeStatus String Task billing status. Valid values: normal (billed or to be billed); resizing (adjusting configuration); reversing (topping up, which is a short status); isolating (isolating, which is a short status); isolated (isolated); offlining (deleting); offlined (deleted); notBilled (not billed).
    Note: This field may return null, indicating that no valid values can be obtained.
    ExpireTime String Expiration time in the format of "yyyy-mm-dd hh:mm:ss"
    Note: This field may return null, indicating that no valid values can be obtained.
    OfflineTime String Deletion time in the format of "yyyy-mm-dd hh:mm:ss"
    Note: This field may return null, indicating that no valid values can be obtained.
    IsolateTime String Isolation time in the format of "yyyy-mm-dd hh:mm:ss"
    Note: This field may return null, indicating that no valid values can be obtained.
    OfflineReason String The cause of deletion
    Note: This field may return null, indicating that no valid values can be obtained.
    IsolateReason String The cause of isolation
    Note: This field may return null, indicating that no valid values can be obtained.
    PayType String Billing mode. Valid values: postpay (postpaid); prepay (prepaid).
    Note: This field may return null, indicating that no valid values can be obtained.
    BillingType String Task billing type. Valid values: billing (billed); notBilling (free); promotions (in promotion).
    Note: This field may return null, indicating that no valid values can be obtained.

    View

    Synced view description

    Used by actions: ConfigureSyncJob, DescribeSyncJobs, ModifySyncJobConfig.

    Name Type Required Description
    ViewName String No View name
    Note: This field may return null, indicating that no valid values can be obtained.
    NewViewName String No Reserved field. Currently, a view cannot be renamed. Note: This field may return null, indicating that no valid values can be obtained.

    ViewItem

    View object

    Used by actions: DescribeMigrationDetail, ModifyMigrationJob.

    Name Type Required Description
    ViewName String No View name
    Note: This field may return null, indicating that no valid values can be obtained.
    NewViewName String No View name after migration
    Note: This field may return null, indicating that no valid values can be obtained.
    Copyright © 2013-2024 Tencent Cloud. All Rights Reserved.
    Privacy PolicyLegalCookie Policy