すべてのプロダクト
Search
ドキュメントセンター

Data Management:GetStructSyncOrderDetail

最終更新日:Mar 21, 2026

スキーマ同期チケットの詳細を照会します。

今すぐお試しください

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

get

*All Resource

*

なし なし

リクエストパラメーター

パラメーター

必須 / 任意

説明

OrderId

integer

必須

チケットの ID。

43****

Tid

integer

任意

テナントの ID。

説明

テナント ID を表示するには、Data Management (DMS) コンソールの右上隅にあるプロフィール画像にポインターを合わせます。 詳細については、「DMS テナントの管理」をご参照ください。

1

レスポンスフィールド

フィールド

説明

object

応答のスキーマ。

RequestId

string

リクエストの ID。

4E1D2B4D-3E53-4ABC-999D-1D2520B3471A

Success

boolean

リクエストが成功したかどうかを示します。

true

ErrorMessage

string

エラーメッセージ。

UnknownError

ErrorCode

string

エラーコード。

UnknownError

StructSyncOrderDetail

object

スキーマ同期チケットの詳細。

SourceDatabaseInfo

object

ソースデータベースに関する情報。

DbId

integer

ソースデータベースの ID。

432532

SearchName

string

データベースの検索に使用される名前。

test

DbType

string

データベースエンジンのタイプ。

MySQL

EnvType

string

データベースインスタンスが属する環境のタイプ。 詳細については、「インスタンスの環境タイプの変更」をご参照ください。

dev

Logic

boolean

データベースが論理データベースであるかどうかを示します。 有効な値:

  • true:データベースは論理データベースです。

  • false:データベースは論理データベースではありません。

false

TargetDatabaseInfo

object

ターゲットデータベースに関する情報。

DbId

integer

ターゲットデータベースの ID。

432543

SearchName

string

データベースの検索に使用される名前。

test

DbType

string

データベースエンジンのタイプ。

MySQL

EnvType

string

データベースインスタンスが属する環境のタイプ。 詳細については、「インスタンスの環境タイプの変更」をご参照ください。

dev

Logic

boolean

データベースが論理データベースであるかどうかを示します。 有効な値:

  • true:データベースは論理データベースです。

  • false:データベースは論理データベースではありません。

false

SourceType

string

ソースデータベースのスキーマバージョン。 有効な値:

  • DATASOURCE:システムのデフォルトの最新バージョン

  • VERSION:手動で指定した以前のスキーマバージョン

VERSION

SourceVersionInfo

object

ソースインスタンスに関するバージョン情報。

説明

このパラメーターは、SourceType パラメーターの値が VERSION の場合にのみ表示されます。

VersionId

string

バージョン番号。

e179bbb8163dcdcfacda24858bedb4d8006ae2b8

TargetType

string

ターゲットデータベースのスキーマバージョン。 有効な値:

  • DATASOURCE:システムのデフォルトの最新バージョン

  • VERSION:手動で指定した以前のスキーマバージョン

DATASOURCE

TargetVersionInfo

object

宛先インスタンスのバージョン情報です。

説明

このパラメーターは、SourceType パラメーターの値が VERSION の場合にのみ表示されます。

VersionId

string

バージョン番号。

e179bbb8163dcdcfacda24858bedb4d8006ae2b8

TableInfoList

array<object>

スキーマを同期するテーブルに関する情報。

object

スキーマを同期するテーブル。

SourceTableName

string

スキーマを同期するテーブルの名前。

test_tbl

TargetTableName

string

テーブルのスキーマを同期する先のテーブルの名前。

test_tbl

IgnoreError

boolean

エラーをスキップするかどうかを示します。 有効な値:

  • true:エラーをスキップし、SQL ステートメントの実行を続行します。

  • false:SQL ステートメントの実行を停止します。

false

成功レスポンス

JSONJSON

{
  "RequestId": "4E1D2B4D-3E53-4ABC-999D-1D2520B3471A",
  "Success": true,
  "ErrorMessage": "UnknownError",
  "ErrorCode": "UnknownError",
  "StructSyncOrderDetail": {
    "SourceDatabaseInfo": {
      "DbId": 432532,
      "SearchName": "test",
      "DbType": "MySQL",
      "EnvType": "dev",
      "Logic": false
    },
    "TargetDatabaseInfo": {
      "DbId": 432543,
      "SearchName": "test",
      "DbType": "MySQL",
      "EnvType": "dev",
      "Logic": false
    },
    "SourceType": "VERSION",
    "SourceVersionInfo": {
      "VersionId": "e179bbb8163dcdcfacda24858bedb4d8006ae2b8"
    },
    "TargetType": "DATASOURCE",
    "TargetVersionInfo": {
      "VersionId": "e179bbb8163dcdcfacda24858bedb4d8006ae2b8"
    },
    "TableInfoList": [
      {
        "SourceTableName": "test_tbl",
        "TargetTableName": "test_tbl"
      }
    ],
    "IgnoreError": false
  }
}

エラーコード

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

変更履歴

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