ALIYUN::DTS::SynchronizationJob2 は、データ同期タスクを構成するために使用されます。
構文
{
"Type": "ALIYUN::DTS::SynchronizationJob2",
"Properties": {
"Status": String,
"Reserve": Map,
"DataSynchronization": Boolean,
"DelayPhone": String,
"DedicatedClusterId": String,
"ErrorNotice": Boolean,
"DtsJobName": String,
"DelayRuleTime": Integer,
"DtsInstanceId": String,
"DbList": Map,
"FileOssUrl": String,
"DataCheckConfigure": Map,
"DtsBisLabel": String,
"Checkpoint": String,
"DisasterRecoveryJob": Boolean,
"DtsJobId": String,
"DelayNotice": Boolean,
"DataInitialization": Boolean,
"DestinationEndpoint": Map,
"SourceEndpoint": Map,
"ErrorPhone": String,
"StructureInitialization": Boolean,
"SynchronizationDirection": String
}
}プロパティ
プロパティ | タイプ | 必須 | 編集可能 | 説明 | 制約 |
Status | String | いいえ | はい | データ同期タスクのステータス。 | 有効な値:
|
Reserve | Map | いいえ | はい | Data Transmission Service (DTS) の予約済みプロパティ。 | このプロパティを使用して、ソースまたは宛先インスタンスの追加の構成を DTS タスクに追加できます。たとえば、宛先 ApsaraMQ for Kafka データベースのデータストレージフォーマットと、宛先 Cloud Enterprise Network (CEN) インスタンスの ID を指定できます。 |
DataSynchronization | Boolean | はい | はい | 増分データ移行または増分データ同期を実行するかどうかを指定します。 | 有効な値:
|
DelayPhone | String | いいえ | いいえ | 遅延関連のアラートが送信される携帯電話番号。 | 複数の携帯電話番号はコンマ (,) で区切ります。 説明
|
DedicatedClusterId | String | いいえ | いいえ | DTS 専用クラスタの ID。 | データ同期タスクを DTS 専用クラスタにスケジュールできます。 |
ErrorNotice | Boolean | いいえ | いいえ | タスクステータスを監視するかどうかを指定します。 | 有効な値:
|
DtsJobName | String | はい | はい | データ同期タスクの名前。 | 識別しやすいように、わかりやすい名前を指定することをお勧めします。一意の名前を使用する必要はありません。 |
DelayRuleTime | Integer | いいえ | いいえ | 遅延関連のアラートをトリガーするためのしきい値。 | 単位:秒。値は整数である必要があります。ビジネス要件に基づいてしきい値を設定できます。ネットワークおよびデータベースの過負荷によるジッターを防ぐために、しきい値を 10 秒以上に設定することをお勧めします。 説明 DelayNotice が true に設定されている場合は、このプロパティを指定する必要があります。 |
DtsInstanceId | String | いいえ | いいえ | データ同期インスタンスの ID。 | なし。 |
DbList | Map | はい | はい | データを同期するオブジェクト。 | 値は JSON 文字列です。詳細については、「DTS タスクのオブジェクト」をご参照ください。 |
FileOssUrl | String | いいえ | はい | データ同期タスクのファイルを保存するために使用する Object Storage Service (OSS) バケットの URL。 | なし。 |
DataCheckConfigure | Map | いいえ | いいえ | データ移行または同期インスタンスのデータ検証タスク。 | 値は JSON 文字列です。このプロパティを使用して、パラメータの制限やアラート構成などの情報を構成できます。詳細については、「DataCheckConfigure プロパティ」をご参照ください。 |
DtsBisLabel | String | いいえ | いいえ | DTS インスタンスの環境タグ。 | 有効な値:
|
Checkpoint | String | いいえ | いいえ | 増分データ移行または増分データ同期の開始オフセット。 | この値は、1970 年 1 月 1 日 00:00:00 UTC から経過したミリ秒数を表す UNIX タイムスタンプです。単位:秒。 |
DisasterRecoveryJob | Boolean | いいえ | いいえ | インスタンスがディザスタリカバリインスタンスかどうかを指定します。 | 有効な値:
|
DtsJobId | String | いいえ | いいえ | データ同期タスクの ID。 | なし。 |
DelayNotice | Boolean | いいえ | いいえ | タスクの遅延を監視するかどうかを指定します。 | 有効な値:
|
DataInitialization | Boolean | はい | はい | 完全データ移行または初期完全データ同期を実行するかどうかを指定します。 | 有効な値:
|
DestinationEndpoint | Map | はい | はい | 宛先インスタンスの構成。 | 詳細については、「DestinationEndpoint プロパティ」をご参照ください。 |
SourceEndpoint | Map | はい | はい | ソースインスタンスの構成。 | 詳細については、「SourceEndpoint プロパティ」をご参照ください。 |
ErrorPhone | String | いいえ | いいえ | ステータス関連のアラートが送信される携帯電話番号。 | 複数の携帯電話番号はコンマ (,) で区切ります。 説明
|
StructureInitialization | Boolean | はい | はい | スキーマ移行または初期スキーマ同期を実行するかどうかを指定します。 | 有効な値:
|
SynchronizationDirection | String | いいえ | はい | 同期方向。 | 有効な値:
説明 Reverse 値は、データ同期タスクのトポロジが双方向同期の場合にのみ有効になります。 |
DataCheckConfigure 構文
"DataCheckConfigure": {
"fullCheckMaxReadRps": Integer,
"dataCheckNoticePhone": String,
"incrementalCheckDelayNotice": Boolean,
"incrementalCheckDelayNoticeValue": Integer,
"incrementalCheckDelayNoticePeriod": Integer,
"dataCheckDbList": String,
"checkMaximumHourEnable": Integer,
"fullCheckRatio": Integer,
"checkMaximumHour": Integer,
"fullCheckFixData": Boolean,
"fullCheckModel": Integer,
"incrementalCheckValidFailNoticeValue": Integer,
"incrementalDataCheck": Boolean,
"incrementalCheckValidFailNoticeTimes": Integer,
"fullCheckMaxReadBps": Integer,
"fullCheckValidFailNotice": Boolean,
"fullCheckErrorNotice": Boolean,
"incrementalCheckValidFailNoticePeriod": Integer,
"incrementalCheckDelayNoticeTimes": Integer,
"fullCheckReferEndpoint": String,
"fullDataCheck": Boolean,
"incrementalCheckValidFailNotice": Boolean,
"fullCheckNoticeValue": Integer,
"incrementalCheckErrorNotice": Boolean
}DataCheckConfigure プロパティ
プロパティ | タイプ | 必須 | 編集可能 | 説明 | 制約 |
fullCheckMaxReadRps | Integer | いいえ | いいえ | 1 秒あたりに読み取られる最大行数。 | 有効な値:0 ~ 9007199254740991。値は整数である必要があります。 説明 値 0 は、制限が課されていないことを示します。 |
dataCheckNoticePhone | String | いいえ | いいえ | 完全または増分データ検証タスクのアラート連絡先の携帯電話番号。 | データ検証タスクでアラートがトリガーされると、DTS はショートメッセージを使用してアラート連絡先にアラート通知を送信します。 |
incrementalCheckDelayNotice | Boolean | いいえ | いいえ | 増分データ検証タスクのデータ遅延に関するアラートをトリガーするかどうかを指定します。 | 有効な値:
|
incrementalCheckDelayNoticeValue | Integer | いいえ | いいえ | 増分データ検証タスクのデータ遅延に関するアラートしきい値。 | 単位:秒。 説明 incrementalCheckDelayNotice が true に設定されている場合は、このプロパティを指定する必要があります。 |
incrementalCheckDelayNoticePeriod | Integer | いいえ | いいえ | 増分データ検証タスクのデータ遅延に関するアラートの統計期間。 | 有効な値:
説明 incrementalCheckDelayNotice が true に設定されている場合は、このプロパティを指定する必要があります。 |
dataCheckDbList | String | いいえ | いいえ | 検証するデータを持つオブジェクト。 | なし。 |
checkMaximumHourEnable | Integer | いいえ | いいえ | 完全データ検証タスクのタイムアウト期間を構成するかどうかを指定します。 | 有効な値:
説明 fullCheckModel が 1 に設定されている場合は、このプロパティを指定する必要があります。 |
fullCheckRatio | 整数 | いいえ | いいえ | 完全データ検証タスクのサンプリング比率。 | 有効な値:10 ~ 100。値は整数である必要があります。単位:パーセント。 説明 fullCheckModel が 1 に設定されている場合は、このプロパティを指定する必要があります。 |
checkMaximumHour | 整数 | いいえ | いいえ | 完全データ検証タスクのタイムアウト期間。 | 有効な値:1 ~ 72。値は整数である必要があります。完全データ検証タスクが開始された瞬間からカウントダウンが始まります。指定されたタイムアウト期間内にタスクが完了しない場合、タスクは強制的に停止されます。 |
fullCheckFixData | ブール値 | いいえ | いいえ | 不整合なデータを置き換えるかどうかを指定します。 | 有効な値:
|
fullCheckModel | Integer | いいえ | いいえ | 完全データ検証タスクのモード。 | 有効な値:
|
incrementalCheckValidFailNoticeValue | 整数 | いいえ | いいえ | 増分データ検証タスクによって検出された、不整合なデータエントリの警告しきい値。 | incrementalCheckValidFailNotice が true に設定されている場合は、このプロパティを指定する必要があります。 |
incrementalDataCheck | ブール値 | いいえ | いいえ | 増分データ検証を実行するかどうかを指定します。 | 有効な値:
|
incrementalCheckValidFailNoticeTimes | 整数 | いいえ | いいえ | 増分データ検証タスクによって検出された、不整合なデータエントリに関するアラートの統計期間の数。 | incrementalCheckValidFailNotice が true に設定されている場合は、このプロパティを指定する必要があります。 |
fullCheckMaxReadBps | 整数 | いいえ | いいえ | 1 秒あたりに読み取られるデータの最大量。単位:バイト。 | 有効な値:0 ~ 9007199254740991。値は整数である必要があります。 説明 値 0 は、制限が課されないことを示します。 |
fullCheckValidFailNotice | ブール値 | いいえ | いいえ | 完全データ検証タスクによって不整合なデータが検出された場合に、アラートをトリガーするかどうかを指定します。 | 有効な値:
|
fullCheckErrorNotice | ブール値 | いいえ | いいえ | 完全データ検証タスクが失敗した場合にアラートをトリガーするかどうかを指定します。 | 有効な値:
|
増分チェックの有効期限切れ通知期間 | 整数 | いいえ | いいえ | 増分データ検証タスクによって検出された、データ入力の不整合に関するアラートの統計期間です。 | 有効な値:
説明 incrementalCheckValidFailNotice が true に設定されている場合は、このプロパティを指定する必要があります。 |
増分チェック遅延通知回数 | 整数 | いいえ | いいえ | 増分データ検証タスクのデータ遅延に関するアラートの統計期間の数。 | incrementalCheckDelayNotice を true に設定した場合、このプロパティを指定する必要があります。 |
fullCheckReferEndpoint | String | いいえ | いいえ | 完全データ検証のベンチマーク。 | 有効な値:
|
fullDataCheck | ブール値 | いいえ | いいえ | 完全なデータ検証を実行するかどうかを指定します。 | 有効な値:
|
増分チェックの検証に失敗しました | ブール値 | いいえ | いいえ | 増分データ検証タスクによって不整合なデータが検出された場合にアラートをトリガーするかどうかを指定します。 | 有効な値:
|
fullCheckNoticeValue | 整数 | いいえ | いいえ | 完全データ検証タスクによって検出された、不整合なデータエントリの警告しきい値。 | fullCheckValidFailNotice が true に設定されている場合は、このプロパティを指定する必要があります。 |
増分チェックエラー通知 | ブール値 | いいえ | いいえ | 増分データ検証タスクが失敗した場合にアラートをトリガーするかどうかを指定します。 | 有効な値:
|
DestinationEndpoint 構文
"DestinationEndpoint": {
"Role": String,
"OracleSID": String,
"UserName": String,
"OwnerID": String,
"InstanceID": String,
"IP": String,
"Port": String,
"DatabaseName": String,
"Region": String,
"InstanceType": String,
"EngineName": String,
"Password": String
}DestinationEndpoint プロパティ
プロパティ | タイプ | 必須 | 編集可能 | 説明 | 制約 |
Role | String | いいえ | いいえ | 宛先インスタンスを所有する Alibaba Cloud アカウントの Resource Access Management (RAM) ロールの名前。 | 異なる Alibaba Cloud アカウント間でデータを移行または同期する場合、このプロパティを指定する必要があります。 |
OracleSID | String | いいえ | いいえ | Oracle データベースのシステム ID (SID)。 | DestinationEndpoint.EngineName が Oracle に設定されており、Oracle データベースが Real Application Clusters (RAC) アーキテクチャにデプロイされていない場合にのみ、このプロパティを指定する必要があります。 |
UserName | String | いいえ | いいえ | ターゲットデータベースのデータベースアカウント。 | データベースアカウントに必要な権限は、移行シナリオによって異なります。詳細については、「データ移行シナリオの概要」をご参照ください。 |
OwnerID | String | いいえ | いいえ | ターゲットデータベースが属する Alibaba Cloud アカウントの ID。 | 異なる Alibaba Cloud アカウント間でデータ移行を構成する場合にのみ、このプロパティを指定する必要があります。 |
InstanceID | String | いいえ | いいえ | 宛先インスタンスの ID。 | DestinationEndpoint.InstanceType が RDS、ECS、MongoDB、Redis、DRDS、PetaData、OceanBase、PolarDB、PolarDB_o、AnalyticDB、または Greenplum に設定されている場合にのみ、このプロパティを指定する必要があります。たとえば、DestinationEndpoint.InstanceType が ECS に設定されている場合は、DestinationEndpoint.InstanceID を Elastic Compute Service (ECS) インスタンスの ID に設定する必要があります。 |
IP | String | いいえ | いいえ | ターゲットデータベースの IP アドレス。 | DestinationEndpoint.InstanceType が LocalInstance または Express に設定されている場合にのみ、このプロパティを指定する必要があります。 |
Port | String | いいえ | いいえ | ターゲットデータベースのサービスポート。 | DestinationEndpoint.InstanceType が ECS、LocalInstance、または Express に設定されている場合にのみ、このプロパティを指定する必要があります。 |
DatabaseName | String | いいえ | いいえ | ターゲットデータベースまたは認証データベースの名前。 |
|
Region | String | いいえ | いいえ | ターゲットデータベースのリージョン ID。 | DestinationEndpoint.InstanceType が LocalInstance に設定されている場合、DestinationEndpoint.Region を cn-hangzhou または自己管理データベースのリージョンに最も近いリージョンの ID に設定できます。詳細については、「サポートされているリージョン」をご参照ください。 |
InstanceType | String | はい | いいえ | 宛先インスタンスのタイプ。 | 有効な値:
|
EngineName | String | いいえ | いいえ | ターゲットデータベースのエンジンの種類。 | 有効な値:
説明 DestionationEndpoint.InstanceType が RDS、PolarDB、ECS、LocalInstance、または Express に設定されている場合にのみ、このプロパティを指定する必要があります。 |
Password | String | いいえ | はい | ターゲットデータベースアカウントのパスワード。 | なし。 |
SourceEndpoint 構文
"SourceEndpoint": {
"OracleSID": String,
"UserName": String,
"InstanceID": String,
"IP": String,
"Port": String,
"VSwitchID": String,
"DatabaseName": String,
"EngineName": String,
"Role": String,
"OwnerID": String,
"Region": String,
"InstanceType": String,
"Password": String
}SourceEndpoint プロパティ
プロパティ | タイプ | 必須 | 編集可能 | 説明 | 制約 |
OracleSID | String | いいえ | いいえ | Oracle データベースの SID。 | SourceEndpoint.EngineName が Oracle に設定されていて、Oracle データベースが RAC アーキテクチャにデプロイされていない場合にのみ、このプロパティを指定する必要があります。 |
UserName | String | いいえ | いいえ | ソースデータベースのデータベースアカウント。 | データベースアカウントに必要な権限は、移行シナリオによって異なります。詳細については、「データ移行シナリオの概要」をご参照ください。 |
InstanceID | String | いいえ | いいえ | ソースデータベースをホストするインスタンスの ID。 |
|
IP | String | いいえ | いいえ | ソースデータベースの IP アドレス。 | SourceEndpoint.InstanceType が LocalInstance または Express に設定されている場合にのみ、このプロパティを指定する必要があります。 |
Port | String | いいえ | いいえ | ソースデータベースのサービスポート。 | SourceEndpoint.InstanceType が ECS、LocalInstance、または Express に設定されている場合にのみ、このプロパティを指定する必要があります。 |
VSwitchID | String | いいえ | いいえ | データ伝送リンクに使用する vSwitch の ID。 | なし。 |
DatabaseName | String | いいえ | いいえ | ソースデータベースまたは認証データベースの名前。 |
|
EngineName | String | いいえ | いいえ | ソースデータベースのエンジンの種類。 | 有効な値:
説明 SourceEndpoint.InstanceType が RDS、PolarDB、ECS、LocalInstance、または Express に設定されている場合にのみ、このプロパティを指定する必要があります。 |
Role | String | いいえ | いいえ | ソースインスタンスの RAM ロール。 | ソースインスタンスと宛先インスタンスが異なる Alibaba Cloud アカウントに属している場合は、このプロパティを指定する必要があります。 RAM ロールを使用して、宛先インスタンスを所有する Alibaba Cloud アカウントにソースインスタンスへのアクセスを承認できます。 説明 RAM ロールに必要な権限と権限の付与方法の詳細については、「アカウントをまたがる DTS タスクの RAM 認証を設定する」をご参照ください。 |
OwnerID | String | いいえ | いいえ | ソースインスタンスが属する Alibaba Cloud アカウントの ID。 | 異なる Alibaba Cloud アカウント間でデータ移行を設定する場合にのみ、このプロパティを指定する必要があります。 |
Region | String | いいえ | いいえ | ソースデータベースのリージョン ID。 | SourceEndpoint.InstanceType が LocalInstance に設定されている場合は、SourceEndpoint.Region を cn-hangzhou または自己管理データベースのリージョンに最も近いリージョンの ID に設定できます。詳細については、「サポートされているリージョン」をご参照ください。 |
InstanceType | String | はい | いいえ | ソースインスタンスのタイプ。 | 有効な値:
|
Password | String | いいえ | はい | ソースデータベースアカウントのパスワード。 | なし。 |
戻り値
Fn::GetAtt
DtsJobId: データ同期タスクの ID です。
DtsJobName: データ同期タスクの名前です。
DtsInstanceId: データ同期インスタンスの ID です。