Use CreateStructSyncOrder to create a schema synchronization ticket - Data Management (DMS)

スキーマ同期チケットを作成します。

操作説明

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

create

*All Resource

*

なし

リクエストパラメーター

パラメーター	型	必須 / 任意	説明	例
Comment	string	必須	チケットの備考です。	test
RelatedUserList	array	任意	関係者の ID です。
	integer	任意	関係者の ID です。	432***
Param	object	必須	チケットのパラメーターです。
Source	object	必須	基盤データベースに関する情報です。
DbId	integer	必須	データベースの ID です。データベースの ID を照会するには、SearchDatabases 操作を呼び出します。	432****
DbSearchName	string	必須	データベースを検索するために使用する名前です。データベースの名前を照会するには、SearchDatabases 操作を呼び出します。	test
Logic	boolean	任意	データベースが論理データベースであるかどうかを指定します。有効な値は以下のとおりです。 true: 論理データベースです。 false: 論理データベースではありません。	false
VersionId	string	任意	スキーマのバージョン番号です。デフォルト値は最新のスキーマバージョン番号です。「スキーマバージョンの管理」をご参照ください。	e179bbb8163dcdcfacda24858bedb4d8006ae2b8
Target	object	必須	テーブルのスキーマを同期する先のデータベースに関する情報です。
DbId	integer	必須	データベースの ID です。データベースの ID を照会するには、SearchDatabases 操作を呼び出します。	432***
DbSearchName	string	必須	データベースを検索するために使用する名前です。データベースの名前を照会するには、SearchDatabases 操作を呼び出します。	test
Logic	boolean	任意	データベースが論理データベースであるかどうかを指定します。有効な値は以下のとおりです。 true: 論理データベースです。 false: 論理データベースではありません。	false
VersionId	string	任意	バージョン番号です。デフォルトでは空欄のままにします。説明送信先データベースのスキーマバージョン番号を指定した場合、Data Management (DMS) は 2 つのデータベースのスキーマのみを比較します。	e179bbb8163dcdcfacda24858bedb4d8006ae2b8
IgnoreError	boolean	任意	SQL ステートメントの実行中に発生したエラーを無視するかどうかを指定します。有効な値は以下のとおりです。 true: SQL ステートメントの実行中にエラーが発生した場合でも、その後の SQL ステートメントの実行を継続します。 false: SQL ステートメントの実行中にエラーが発生した場合、その後の SQL ステートメントの実行を中止します。	false
TableInfoList	array<object>	任意	スキーマを同期するテーブルに関する情報です。
	object	任意	スキーマを同期するテーブルです。
SourceTableName	string	任意	ソーステーブルの名前です。	test_tbl
TargetTableName	string	任意	送信先テーブルの名前です。	test_tbl
AttachmentKey	string	任意	添付ファイルをアップロード後に返されるキーです。添付ファイルのキーを照会するには、GetUserUploadFileJob 操作を呼び出します。	upload_3c7edea3-e4c3-4403-857d-737043036f69_test.sql
Tid	integer	任意	テナントの ID です。説明テナント ID を表示するには、DMS コンソールの右上隅にあるプロフィール画像にポインターを合わせます。「DMS テナントの管理」をご参照ください。	3***

レスポンスフィールド

フィールド	型	説明	例
	object	応答のスキーマです。
RequestId	string	リクエストの ID です。	4E1D2B4D-3E53-4ABC-999D-1D2520B3471A
Success	boolean	リクエストが成功したかどうかを示します。	true
ErrorMessage	string	エラーメッセージです。	UnknownError
ErrorCode	string	エラーコードです。	UnknownError
CreateOrderResult	array	チケット作成の結果です。
	integer	チケットの ID です。	432****

例

成功レスポンス

JSONJSON

{
  "RequestId": "4E1D2B4D-3E53-4ABC-999D-1D2520B3471A",
  "Success": true,
  "ErrorMessage": "UnknownError",
  "ErrorCode": "UnknownError",
  "CreateOrderResult": [
    0
  ]
}

エラーコード

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

変更履歴

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