すべてのプロダクト
Search

このプロダクト

    Data Management:GetStructSyncJobDetail

    ドキュメントセンター

    Data Management:GetStructSyncJobDetail

    最終更新日: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:GetStructSyncJobDetail

    get

    *All Resource

    *

    		 なし なし

    リクエストパラメーター

    パラメーター

    型

    必須 / 任意

    説明

    例
    OrderId

    integer

    必須

    チケット ID。

    4324321
    Tid

    integer

    任意

    テナント ID。

    説明

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

    1

    レスポンスフィールド

    フィールド

    型

    説明

    例

    object

    応答のスキーマ

    RequestId

    string

    リクエスト ID。

    48602B78-0DDF-414C-8688-70CAB6070115
    Success

    boolean

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

    true
    ErrorMessage

    string

    エラーメッセージ。

    UnknownError
    ErrorCode

    string

    エラーコード。

    UnknownError
    StructSyncJobDetail

    object

    スキーマ同期タスクの詳細。

    JobStatus

    string

    タスクのステータス。有効な値：

    • NEW：タスクが作成されました。

    • COMPARING：テーブルのスキーマが比較中です。

    • COMPARE_BREAK：スキーマの比較が中断されました。

    • COMPARE_FINISH：比較が完了しました。

    • NOT_SCRIPTS：比較は完了しましたが、実行可能なスクリプトはありません。

    • SUBMITED_DBTASK：タスクが送信されました。

    • DBTASK_SUCCESS：タスクが完了しました。

    • SUBMITED_WORKFLOW：チケットが送信されました。

    • WORKFLOW_SUCCESS：チケットが承認されました。

    DBTASK_SUCCESS
    Message

    string

    タスクの説明。

    test
    TableAnalyzed

    integer

    分析されたテーブルの数。

    2
    TableCount

    integer

    テーブルの総数。

    2
    SqlCount

    integer

    SQL ステートメントの総数。

    1
    ExecuteCount

    integer

    実行された SQL ステートメントの数。

    1
    SecurityRule

    string

    セキュリティルールのタイプ。有効な値：

    • CANNOT_SYNC：同期は実行できません。

    • WITH_APPROVE：チケットが承認された後、スキーマ同期を実行できます。SubmitStructSyncOrderApproval 操作を呼び出して、承認のためにチケットを送信できます。

    • WITHOUT_APPROVE：承認なしでスキーマ同期を実行できます。

    WITHOUT_APPROVE
    DBTaskGroupId

    integer

    SQL タスクグループの ID。

    12345

    例

    成功レスポンス

    JSONJSON

    {
  "RequestId": "48602B78-0DDF-414C-8688-70CAB6070115",
  "Success": true,
  "ErrorMessage": "UnknownError",
  "ErrorCode": "UnknownError",
  "StructSyncJobDetail": {
    "JobStatus": "DBTASK_SUCCESS",
    "Message": "test",
    "TableAnalyzed": 2,
    "TableCount": 2,
    "SqlCount": 1,
    "ExecuteCount": 1,
    "SecurityRule": "WITHOUT_APPROVE",
    "DBTaskGroupId": 12345
  }
}

    エラーコード

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

    変更履歴

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