CreateDataArchiveOrder API によるデータアーカイブの自動化 - DMS

専用ストレージスペースや ApsaraDB RDS for MySQL インスタンスなどの送信先にデータをアーカイブするためのデータアーカイブチケットを作成します。

操作説明

この API オペレーションは、セキュリティコラボレーションモードで管理されているデータベースインスタンスに対してのみ呼び出すことができます。

今すぐお試しください

この 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:CreateDataArchiveOrder

create

*All Resource

*

なし

リクエストパラメーター

パラメーター	型	必須 / 任意	説明	例
Comment	string	必須	タスクの説明。	业务测试
Tid	integer	任意	テナント ID。GetUserActiveTenant または ListUserTenants オペレーションを呼び出して、テナント ID を取得できます。	3***
PluginType	string	任意	プラグインのタイプ。デフォルト値：DATA_ARCHIVE。	DATA_ARCHIVE
RelatedUserList	array	任意	関連ユーザーのリスト。
	string	任意	チケットに関連するオペレーターの ID。	123***
ParentId	integer	任意	親チケットの ID。親チケットは、子チケットが作成された場合にのみ生成されます。	896****
Param	object	必須	データアーカイブのパラメーター。
ArchiveMethod	string	必須	データをアーカイブするアーカイブ送信先。有効な値：説明 ArchiveMethod を inner_oss 以外の値に設定する場合、データアーカイブチケットを作成する前に、対応するターゲットデータベースを Data Management (DMS) に登録する必要があります。データベースが DMS に登録されると、そのデータベースは DMS コンソールの [インスタンス接続済み] セクションに表示されます。 inner_oss: 専用ストレージ。これは組み込みの Object Storage Service (OSS) バケットです。 oss_userself: ユーザーの OSS バケット。 mysql: ApsaraDB RDS for MySQL インスタンス。 polardb: PolarDB for MySQL クラスター。 adb_mysql: AnalyticDB for MySQL V3.0 クラスター。 lindorm: Lindorm インスタンス。	adb_mysql
RunMethod	string	必須	データアーカイブタスクを実行するために使用されるメソッド。有効な値： schedule: データアーカイブタスクは定期的にスケジュールされます。 now: データアーカイブタスクは直ちに実行されます。	now
Variables	array<object>	任意	アーカイブ変数の構成。時間変数をデータアーカイブのフィルター条件として使用できます。各変数には、name と pattern の2つの属性があります。
	object	任意	アーカイブ変数の構成。	{name: "time", pattern: "yyyy-MM-dd\|+2d"}
Name	string	任意	時間変数の名前。時間変数がデータアーカイブのフィルター条件として使用される場合、変数名は TableWhere で指定されたものと同じである必要があります。	t
Pattern	string	任意	時間変数のフォーマット。このフォーマットは、時間変数の値を定義するために使用されます。詳細については、「変数を構成する」をご参照ください。時間変数のフォーマットの例を次に示します。 yyyy-MM-dd\|-3d: タスクが実行される時点の3日前。 yyyy-MM-dd\|-1w: タスクが実行される時点の7日前。 yyyy-MM-dd\|-4M: タスクが実行される時点の4ヶ月前。 yyyy-MM-dd\|-2y: タスクが実行される時点の2年前。 yyyy-MM-dd\|-3h: タスクが実行される時点の3時間前。 yyyy-MM-dd\|+5m: タスクが実行される時点の5分後。説明これらの例では、yyyy-MM-dd\| は固定値を示します。残りの部分では、ハイフン (-) はタスクが実行される時点より前の時間を示し、プラス記号 (+) はタスクが実行される時点より後の時間を示します。	yyyy-MM-dd\|-3d
Logic	boolean	任意	データベースが論理データベースであるかどうかを指定します。	false
TableIncludes	array<object>	必須	アーカイブするテーブルのコレクション。
	object	必須
TableName	string	必須	テーブル名。	table1
TableWhere	string	任意	アーカイブ構成の WHERE 句で指定されるフィルター条件。時間変数がフィルター条件で使用される場合、フィルター条件は「フィールド名 <='${変数名}'」のフォーマットで指定されます。フィルター条件内の変数名は、Variables パラメーターで指定された時間変数名と同じである必要があります。	gmt_modified<'${t}'
TableMapping	array	任意	ターゲットデータベースにマップされるテーブル名。このパラメーターは必須ではなく、デフォルト値が使用されます。
	string	任意	ターゲットデータベースにマップされるテーブル名。	table1
OrderAfter	array	任意	後処理動作。
	string	任意	後処理動作。有効な値： delete: ソースデータベースからアーカイブされたデータを削除します。 check: アーカイブされたデータを検証します。この操作には時間がかかります。 clear: 一時テーブルを削除します。この値は、このパラメーターの他の2つの値を同時に選択した場合にのみ有効になります。	delete
SourceCatalogName	string	必須	ソースデータベースのカタログ。有効な値： def: ソースデータベースが MySQL データベース、PolarDB for MySQL クラスター、または AnalyticDB for MySQL インスタンスのような2層論理スキーマである場合、このパラメーターを def に設定します。 Empty string: ソースデータベースが Lindorm または ApsaraDB for MongoDB インスタンスである場合、このパラメーターを空の文字列に設定します。 Catalog name: ソースデータベースが PostgreSQL データベースのような3層論理スキーマである場合、このパラメーターをソースデータベースのカタログ名に設定します。	def
SourceSchemaName	string	必須	ソースデータベースのスキーマ名。ソースデータベースのスキーマ名は、ターゲットデータベースのスキーマ名と同じです。ソースデータベースが MySQL データベースの場合、このパラメーターはソースデータベースの名前を指定します。ソースデータベースが PostgreSQL データベースの場合、このパラメーターはソースデータベースのスキーマ名を指定します。	schema_test
SourceInstanceName	string	必須	ソースインスタンスの名前。データベースインスタンスが自己管理データベースまたはサードパーティクラウドデータベースの場合、GetInstance オペレーションを呼び出してインスタンス ID をクエリできます。	rm-bp187l****380w
TargetInstanceHost	string	必須	宛先インスタンスのホスト。宛先インスタンスが内部ネットワークまたはインターネット経由でアクセスできる場合、優先的に宛先インスタンスの内部エンドポイントに値を設定します。データが OSS バケットにアーカイブされる場合、値をバケットの名前に設定します。データが専用ストレージスペースにアーカイブされる場合、値を inner_oss に設定します。	amv-bp1****00444.ads.aliyuncs.com
CronStr	string	任意	データアーカイブタスクのスケジューリングサイクルを指定する crontab 式。詳細については、「同期用のシャドウテーブルを作成する」トピックの「Crontab 式」セクションをご参照ください。RunMethod を schedule に設定する場合、このパラメーターを指定する必要があります。	00 05 11 * * ?
DatabaseId	string	任意	データベース ID。データベースが自己管理データベースまたはサードパーティクラウドデータベースの場合、GetDatabase オペレーションを呼び出してデータベース ID をクエリできます。データベースが Alibaba Cloud データベースの場合、このパラメーターは無視します。	1***

レスポンスフィールド

フィールド	型	説明	例
	object	応答のスキーマ。
RequestId	string	リクエストの ID。ログをクエリし、問題をトラブルシューティングするために使用されます。	283C461F-11D8-48AA-B695-DF092DA32AF3
Success	boolean	リクエストが成功したかどうかを示します。有効な値： true false	true
ErrorMessage	string	リクエストが失敗した場合に返されるエラーメッセージ。	UnknownError
ErrorCode	string	リクエストが失敗した場合に返されるエラーコード。	UnknownError
CreateOrderResult	array	データアーカイブチケットの ID。
	integer	データアーカイブチケット ID。	12*****

例

成功レスポンス

JSONJSON

{
  "RequestId": "283C461F-11D8-48AA-B695-DF092DA32AF3",
  "Success": true,
  "ErrorMessage": "UnknownError",
  "ErrorCode": "UnknownError",
  "CreateOrderResult": [
    0
  ]
}

エラーコード

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

変更履歴

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