Query the details and progress of an OnlineDDL task with GetOnlineDDLProgress - Data Management (DMS)

OnlineDDL タスクの詳細および進行状況を照会します。

今すぐお試しください

この API を OpenAPI Explorer でお試しください。手作業による署名は必要ありません。呼び出しに成功すると、入力したパラメーターに基づき、資格情報が組み込まれた SDK コードが自動的に生成されます。このコードをダウンロードしてローカルで使用できます。

テスト

RAM 認証

下表に、この API を呼び出すために必要な認証情報を示します。認証情報は、RAM (Resource Access Management) ポリシーを使用して定義できます。以下で各列名について説明します。

アクション：特定のリソースに対して実行可能な操作。ポリシー構文ではAction要素として指定します。
API：アクションを具体的に実行するための API。
アクセスレベル：各 API に対して事前定義されているアクセスの種類。有効な値：create、list、get、update、delete。
リソースタイプ：アクションが作用するリソースの種類。リソースレベルでの権限をサポートするかどうかを示すことができます。ポリシーの有効性を確保するため、アクションの対象として適切なリソースを指定してください。
- リソースレベルの権限を持つ API の場合、必要なリソースタイプはアスタリスク (*) でマークされます。ポリシーのResource要素で対応する ARN を指定してください。
- リソースレベルの権限を持たない API の場合、「すべてのリソース」と表示され、ポリシーのResource要素でアスタリスク (*) でマークされます。
条件キー：サービスによって定義された条件のキー。このキーにより、きめ細やかなアクセス制御が可能になります。この制御は、アクション単体に適用することも、特定のリソースに対するアクションに適用することもできます。Alibaba Cloud は、サービス固有の条件キーに加えて、すべての RAM 統合サービスに適用可能な一連の共通条件キーを提供しています。
依存アクション：ある特定のアクションを実行するために、前提として実行が必要となる他のアクション。依存アクションの権限も RAM ユーザーまたは RAM ロールに付与する必要があります。

アクション

アクセスレベル

リソースタイプ

条件キー

依存アクション

dms:GetOnlineDDLProgress

get

*All Resource

*

なし

リクエストパラメーター

パラメーター	型	必須 / 任意	説明	例
Tid	integer	任意	テナントの ID です。説明テナントの ID を確認するには、Data Management (DMS) コンソールにログインし、右上隅のプロフィール画像にカーソルを合わせます。詳細については、「DMS テナントの管理」トピックの「現在のテナントに関する情報を表示する」セクションをご参照ください。	3***
JobDetailId	integer	必須	OnlineDDL SQL タスクの詳細 ID です。この ID は、ListDBTaskSQLJobDetail API を呼び出して取得できます。	15***

レスポンスフィールド

フィールド	型	説明	例
	object	応答のスキーマ
RequestId	string	リクエストの ID です。	34E01EDD-6A16-4CF0-9541-C644D1BE01AA
Success	boolean	リクエストが成功したかどうかを示します。有効な値は以下のとおりです。 true：リクエストが成功しました。 false：リクエストが失敗しました。	true
ErrorMessage	string	リクエストが失敗した場合に返されるエラーメッセージです。	UnknownError
ErrorCode	string	リクエストが失敗した場合に返されるエラーコードです。	403
OnlineDDLTaskDetail	object	タスクの詳細です。
JobStatus	string	タスクの状態です。有効な値は以下のとおりです。 INIT：タスクが初期化中です。 SUCCESS：タスクが完了しました。 RUNNING：タスクが実行中です。 WAITING_CUTOVER：タスクが切り替え（cut-over）を待機中です。 RESTARTING：タスクが再起動中です。 PAUSE：タスクが一時停止中です。 UNSUPPORTED：タスクはサポートされていません。 CANCELED：タスクがキャンセルされました。 FAIL：タスクが失敗しました。 INTERRUPT：タスクが中断されました。	SUCCESS
StatusDesc	string	タスクの状態に関する説明です。	Success
DelaySeconds	integer	DMS のレプリケーション遅延（単位：秒）です。これは、テーブルのバイナリログを一時テーブルへ再生（replay）するのに要する時間であり、プライマリデータベースとセカンダリデータベース間のデータ移行遅延を意味するものではありません。	0
CopyTotal	integer	データの推定総行数です。この値は、information_schema データベース内の統計情報から取得されます。ほとんどの場合、推定総行数はテーブルの実際の行数より小さくなります。	10
CopyCount	integer	ロックフリー変更操作において、元のテーブルから実際に複製されたデータ量です。	9
ProgressRatio	string	推定実行進捗率です。実際の進捗はタスクの状態に基づきます。	90%
CutoverLockTimeSeconds	integer	切り替え（cut-over）中にテーブルがロックされる最大期間（単位：秒）です。	2
CutoverFailRetryTimes	integer	切り替え（cut-over）が失敗した場合の再試行回数です。	3
CleanStrategy	string	切り替え（cut-over）後の元のテーブルに対するクリーンアップポリシーです。有効な値は以下のとおりです。 DROP：無効となった元のテーブルは削除されます。 MOVE：無効となった元のテーブルはテストデータベースに移動されます。手動で削除できます。 NOTHING：無効となった元のテーブルは元のデータベースに残されます。手動で削除できます。	DROP
CopyChunkSize	integer	データ複製に使用される各チャンクのサイズです。このパラメーターにより、各チャンクのサイズを指定します。チャンクサイズを大きくすると、複製効率が向上しますが、業務アプリケーションのパフォーマンスに影響を与える可能性があります。説明フルレプリケーションでは、元のテーブルが N 個の小さなチャンクに分割され、各チャンクが順次一時テーブルへ複製されます。デフォルトでは、DMS がチャンクサイズを動的に調整します。	1000
CopyChunkMode	string	フルレプリケーションのポリシーです。有効な値は以下のとおりです。 AUTO：DMS がデータベースのパフォーマンスに基づいてチャンクサイズを動的に調整します。単一の複製操作におけるテーブルのロック時間は 1.5 秒未満となります。 RUNNING：DMS が CopyChunkSize パラメーターで指定された値を使用します。CopyChunkSize の有効範囲は 1～60000 です。RUNNING を指定する場合は、CopyChunkSize パラメーターも必ず指定してください。	AUTO
CutoverWindowStartTime	string	切り替え（cut-over）操作のタイムウィンドウの開始時刻です。デフォルト値は 00:00:00 です。このパラメーターにより、切り替え操作の実行可能時間帯が制御されます。切り替え条件が満たされ、かつ指定されたタイムウィンドウ内である場合にのみ切り替えが実行されます。タイムウィンドウ外の場合は、開始時刻に達するまで切り替え操作は実行されません。	12:00:00
CutoverWindowEndTime	string	切り替え（cut-over）操作のタイムウィンドウの終了時刻です。この値は CutoverWindowStartTime より少なくとも 30 分後である必要があります。デフォルト値は 23:59:59 です。	13:00:00

例

成功レスポンス

JSONJSON

{
  "RequestId": "34E01EDD-6A16-4CF0-9541-C644D1BE01AA",
  "Success": true,
  "ErrorMessage": "UnknownError",
  "ErrorCode": "403",
  "OnlineDDLTaskDetail": {
    "JobStatus": "SUCCESS",
    "StatusDesc": "Success",
    "DelaySeconds": 0,
    "CopyTotal": 10,
    "CopyCount": 9,
    "ProgressRatio": "90%",
    "CutoverLockTimeSeconds": 2,
    "CutoverFailRetryTimes": 3,
    "CleanStrategy": "DROP",
    "CopyChunkSize": 1000,
    "CopyChunkMode": "AUTO",
    "CutoverWindowStartTime": "12:00:00",
    "CutoverWindowEndTime": "13:00:00"
  }
}

エラーコード

完全なリストについては、「エラーコード」をご参照ください。

変更履歴

完全なリストについては、「変更履歴」をご参照ください。