API オペレーションのリクエストパラメータのプレビュー - Data Transmission Service

Data Transmission Service (DTS) タスクの OpenAPI リクエストパラメータを DTS コンソールから直接プレビューします。プレビューしたパラメータは、対応する API オペレーションをプログラムで呼び出す際の参照として使用できます。

説明

パラメータの表示のみを目的とする場合は、プレビューのステップで停止し、次のアクションに進まないでください。次のアクションに進むと、関連するオペレーションが有効になり、料金が発生したり、インスタンスの設定が変更されたりする可能性があります。

前提条件

開始する前に、次のことを確認してください。

データ同期、データ移行、変更追跡、またはデータ検証のいずれかのカテゴリに属する DTS タスク
DTS コンソールへのアクセス

API パラメータのプレビュー

DTS コンソールにログインします。
左側のナビゲーションペインで、タスクの種類に応じてデータ同期、データの移行、変更の記録、またはデータ検証をクリックします。
上部メニューで、DTS インスタンスがあるリージョンを選択します。
タスク設定ページに移動します。タスク設定ページは、タスクの作成、同期または追跡するオブジェクトの変更、または既存のタスクに類似したタスクの作成時にアクセスできます。詳細については、「データ同期シナリオの概要」、「データ移行シナリオの概要」、「変更追跡シナリオの概要」、「データ検証タスクの設定」、「同期対象オブジェクトの変更」、「変更追跡の対象オブジェクトの変更」、および「類似インスタンスの作成」をご参照ください。
タスクオブジェクトの設定 ステップを完了し、ページの下部に 次：タスク設定の保存と事前チェック または 次：タスクの事前チェックと起動 ボタンが表示されるまで進めます。タスクタイプ、ソースデータベースタイプ、および宛先データベースタイプによっては、このボタンが表示される前に 詳細設定、データ検証、または データベース設定とテーブルのフィールド設定 フェーズを実行する必要がある場合があります。
次：タスク設定の保存と事前チェック または 次：タスクの事前チェックと起動 ボタンにカーソルを合わせ、OpenAPI パラメーターのプレビュー をクリックします。
OpenAPI 入力パラメータのプレビュー ダイアログボックスで、[JSON] タブまたは [ツリー] タブをクリックして、パラメーターを表示します。
[プレビュー API リクエストパラメーター] ダイアログボックスでは、[アクション] は ConfigureDtsJob であり、[JSON] タブには、次の主な OpenAPI リクエストパラメーターが表示されます。
- jobType：SYNC
- sourceEndpointEngineName と destinationEndpointEngineName：MSSQL
- sourceEndpointInstanceType と destinationEndpointInstanceType：RDS
- sourceEndpointRegion と destinationEndpointRegion：cn-hangzhou
- dbList：データベースとテーブルのマッピング設定。この設定では、srcSchema と destSchema は両方とも dbo です。
- structureInitialization、dataInitialization、および dataSynchronization：true
ダイアログボックスの下部には、[パラメーターのコピー] ボタンと [閉じる] ボタンがあります。ダイアログボックスの上部には、[コピー] リンクと [API ドキュメント] リンクがあります。

使用前のパラメータのクリーンアップ

[プレビュー API リクエストパラメーター] ダイアログボックスに表示されるパラメーターは参考用です。実際の API コールで使用する前に、出力をクリーンアップしてください：

余分なバックスラッシュ (\)、改行、スペースを削除してください。
ネストされた二重引用符 (") を修正してください。パラメータ値に、別の二重引用符で囲まれた文字列内にネストされた二重引用符で囲まれた文字列が含まれている場合は、内側の引用符をバックスラッシュ (\) でエスケープするか、形式が許す場合は外側の引用符を削除してください。

次のステップ

プレビューしたパラメータを次の API オペレーションで使用できます。