すべてのプロダクト
Search

このプロダクト

    Data Management:GetDataCorrectOrderDetail

    ドキュメントセンター

    Data Management:GetDataCorrectOrderDetail

    最終更新日:Mar 21, 2026

    Data Management (DMS) におけるデータ変更チケットの情報を照会します。

    今すぐお試しください

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

    get

    *All Resource

    *

    		 なし なし

    リクエストパラメーター

    パラメーター

    型

    必須 / 任意

    説明

    例
    Tid

    integer

    任意

    テナント ID。テナント ID を取得するには、GetUserActiveTenant または ListUserTenants 操作を呼び出します。

    3***
    OrderId

    integer

    必須

    チケット ID。チケット ID を取得するには、ListOrders 操作を呼び出します。

    420****

    レスポンスフィールド

    フィールド

    型

    説明

    例

    object

    レスポンスパラメーター。

    RequestId

    string

    リクエスト ID。

    427688B8-ADFB-4C4E-9D45-EF5C1FD6E23D
    DataCorrectOrderDetail

    object

    データ変更チケットの情報。

    PreCheckDetail

    object

    TaskCheckDO

    array<object>

    チケットの事前チェックの詳細情報。

    object

    UserTip

    string

    チェックステップ実行時に表示されるメッセージ。

    tip messsage
    CheckStatus

    string

    事前チェックの状態。有効な値は以下のとおりです。

    • WAITING：チケットが事前チェック待ちの状態です。

    • RUNNING：チケットが事前チェック中です。

    • SUCCESS：チケットが事前チェックに合格しました。

    • FAIL：チケットが事前チェックに失敗しました。

    SUCCESS
    CheckStep

    string

    事前チェックのチェックステップ。有効な値は以下のとおりです。

    • SQL_PARSE：SQL ステートメントの構文をチェックします。

    • SQL_TYPE_CHECK：SQL ステートメントの種類をチェックします。

    • PERMISSION_CHECK：データ変更に必要な権限をチェックします。

    • ROW_CHECK：影響を受ける行数をチェックします。

    PERMISSION_CHECK
    OrderDetail

    object

    チケットの詳細情報。

    RbSQL

    string

    データ変更をロールバックするために使用される SQL ステートメント。

    empty
    RbAttachmentName

    string

    データ変更をロールバックするために使用される SQL ステートメントを含む添付ファイルの名前。

    test
    Classify

    string

    データ変更の理由のカテゴリ。

    test
    ExeSQL

    string

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

    update t1 set name = 'xxx' where id <= 100
    EstimateAffectRows

    integer

    影響を受ける行数の推定値。

    100
    RbSQLType

    string

    データ変更をロールバックするために使用される SQL ステートメントの形式。有効な値は以下のとおりです。

    • TEXT：テキスト形式

    • ATTACHMENT：添付ファイル形式

    text
    ActualAffectRows

    integer

    事前チェックで得られた影響を受ける行数。

    100
    IgnoreAffectRows

    boolean

    事前チェック結果を無視するかどうかを示します。有効な値は以下のとおりです。

    • true：事前チェック結果を無視します。

    • false：事前チェック結果を無視しません。

    false
    AttachmentName

    string

    データ変更に使用される SQL ステートメントを含む添付ファイルの名前。

    xxx
    SqlType

    string

    データ変更に使用される SQL ステートメントの形式。有効な値は以下のとおりです。

    • TEXT：テキスト形式

    • ATTACHMENT：添付ファイル形式

    text
    IgnoreAffectRowsReason

    string

    事前チェック結果を無視する理由。

    test
    DatabaseList

    object

    Database

    array<object>

    データ変更が行われるデータベースの情報。

    object

    DbId

    integer

    データベース ID。

    1860****
    DbType

    string

    データベースエンジン。

    mysql
    Logic

    boolean

    データベースが論理データベースであるかどうかを示します。有効な値は以下のとおりです。

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

    • false：物理データベースです。

    false
    SearchName

    string

    データベースを検索するために使用される名前。

    xxx@xxx:3306
    EnvType

    string

    データベースが属する環境の種類。有効な値は以下のとおりです。

    • product：本番環境

    • dev：開発環境

    • pre：プレリリース環境

    • test：テスト環境

    • sit：統合テスト (SIT) 環境

    • uat：受け入れテスト (UAT) 環境

    • pet：ストレステスト環境

    • stag：ステージング環境

    product
    Status

    string

    データ変更チケットの具体的な状態。有効な値は以下のとおりです。

    説明

    チケットの状態は、チケットの状態コードとは厳密には等価ではありません。チケットの状態コードを照会するには、GetOrderBaseInfo 操作を呼び出し、応答内の StatusCode の値を確認してください。

    • new：チケットが作成されました。

    • precheck：チケットが事前チェックフェーズです。

    • precheckFailed：チケットが事前チェックに失敗しました。

    • precheck_success：チケットが事前チェックに合格し、承認のために送信待ちです。

    • toaudit：チケットが審査中です。

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

    • reject：チケットが拒否されました。

    • waiting：タスクが送信され、スケジュール待ちです。

    • processing：タスクが実行中です。

    • Success：タスクが成功しました。

    approved
    ExecMode

    string

    チケット承認後の実行モード。有効な値は以下のとおりです。

    • COMMITOR：チケットを提出したユーザーがデータ変更を実行します。

    • AUTO：チケット承認後に自動的にデータ変更が実行されます。

    • LAST_AUDITOR：チケットの最終承認者がデータ変更を実行します。

    COMMITOR
    ConfigDetail

    object

    チケットの構成。このパラメーターは、データ変更チケットタイプ固有の構成情報を格納するために使用されます。

    DetailType

    string

    チケットの種類。有効な値は以下のとおりです。

    • COMMON：通常のデータ変更

    • CHUNK_DML：ロックフリーのデータ変更

    • BIG_FILE：大規模データインポート

    • CRON_CLEAR_DATA：既存データのクリーンアップ

    • PROCEDURE：プログラマブルオブジェクトの変更

    BIG_FILE
    FileType

    string

    インポート対象のファイルの種類。このパラメーターは、DetailType の値が BIG_FILE の場合に有効です。有効な値は以下のとおりです。

    • SQL：SQL ファイル

    • CSV：CSV ファイル

    • EXCEL：Excel ファイル

    • JSON：JSON ファイル（MongoDB データベースのみサポート）

    CSV
    CsvTableName

    string

    データをインポートする先のテーブル名。このパラメーターは、DetailType の値が BIG_FILE の場合にのみ有効です。FileType の値が SQL の場合は、このパラメーターは空になります。

    tb_import_tb_name
    FileEncoding

    string

    ファイルのエンコーディング方式。このパラメーターは空の場合があり、その場合は AUTO を意味します。有効な値は以下のとおりです。

    • AUTO：自動識別

    • UTF-8：UTF-8 エンコーディング

    • GBK：GBK エンコーディング

    • ISO-8859-1：ISO-8859-1 エンコーディング

    UTF-8
    Cron

    boolean

    タスクが既存データのクリーンアップ用の定期タスクであるかどうかを示します。このパラメーターは予約済みパラメーターであり、DetailType の値が CRON_CLEAR_DATA の場合にのみ有効です。

    true
    CronCallTimes

    integer

    定期タスクの実行回数。このパラメーターは、DetailType の値が CRON_CLEAR_DATA の場合にのみ有効です。

    0
    CronFormat

    string

    定期タスクの CRON 式。このパラメーターは、DetailType の値が CRON_CLEAR_DATA の場合にのみ有効です。

    0 0 2 * * ?
    Duration

    integer

    定期タスクの実行時間。単位：時間。このパラメーターは、DetailType の値が CRON_CLEAR_DATA の場合にのみ有効です。値が 0 より大きい場合、実行時間が設定されます。

    1
    CronStatus

    string

    定期タスクの状態。このパラメーターが空の場合、タスクは実行されません。有効な値は以下のとおりです。

    • PAUSE：タスクが一時停止されています。

    • WAITING：タスクが実行待ちです。

    • SUCCESS：タスクが実行されました。

    SUCCESS
    CronLastCallStartTime

    string

    タスクが最後に実行された時刻。

    2024-04-19 02:00:00.0
    CronNextCallTime

    string

    タスクが次に実行される時刻。このパラメーターは、CronStatus の値が SUCCESS の場合にのみ返されます。

    2024-04-19 02:00:00

    CurrentTaskId

    integer

    現在のデータ変更タスクの ID。これは予約済みパラメーターであり、無視できます。

    13***
    ImportExtConfig

    object

    データインポートに関する追加構成情報。このパラメーターは、DetailType の値が BIG_FILE の場合に有効です。

    InsertType

    string

    データを宛先テーブルにインポートするモード。有効な値は以下のとおりです。

    • INSERT：データ挿入時にデータベースがプライマリキーをチェックします。プライマリキーが重複している場合、エラーが報告されます。

    • INSERT_IGNORE：インポートされるデータに宛先テーブルと同一のデータレコードが含まれている場合、新しいデータレコードは無視されます。

    • REPLACE_INTO：インポートされるデータに、宛先テーブルの既存の行と同じプライマリキーまたは一意なインデックスを持つ行が含まれている場合、システムは既存の行を削除し、新しい行を宛先テーブルに挿入します。

    説明

    このパラメーターは、FileType の値が CSV または EXCEL の場合に有効です。

    INSERT
    CsvFirstRowIsColumnDef

    boolean

    CSV ファイルの最初の行にフィールド名が含まれているかどうかを示します。有効な値は以下のとおりです。

    • true：CSV ファイルの最初の行にフィールド名が含まれています。

    • false：CSV ファイルの最初の行にデータが含まれています。

    説明

    このパラメーターは、FileType の値が CSV または EXCEL の場合に有効です。

    true
    IgnoreError

    boolean

    発生したエラーを無視するかどうかを示します。有効な値は以下のとおりです。

    • true：SQL ステートメントの実行中にエラーが発生した場合、DMS は現在の SQL ステートメントをスキップし、その後の SQL ステートメントの実行を継続します。

    • false：SQL ステートメントの実行中にエラーが発生した場合、DMS はその後の SQL ステートメントの実行を停止します。

    false
    ImportMode

    string

    インポートモード。有効な値は以下のとおりです。

    • FAST_MODE：高速モード。実行ステップでは、アップロードされたファイルが読み込まれ、SQL ステートメントが実行されてデータが指定されたターゲットデータベースにインポートされます。セキュリティモードと比較して、このモードは安全性は低いものの、より効率的なデータインポートが可能です。

    • SAFE_MODE：セキュリティモード。事前チェックステップでは、アップロードされたファイルが解析され、SQL ステートメントまたは CSV ファイルのデータがキャッシュされます。実行ステップでは、キャッシュされた SQL ステートメントが読み込まれて実行され、データがインポートされるか、またはキャッシュされた CSV ファイルのデータが読み込まれて指定されたターゲットデータベースにインポートされます。高速モードと比較して、このモードは安全性は高いものの、データインポートの効率は低くなります。

    FAST_MODE
    CronExtConfig

    object

    既存データのクリーンアップに関する追加構成情報。このパラメーターは、DetailType の値が CRON_CLEAR_DATA の場合にのみ有効です。

    OptimizeTableAfterEveryClearTimes

    integer

    「定期的にテーブルを最適化」機能が有効かどうかを示します。有効な値は以下のとおりです。

    • 0（デフォルト）：機能が無効です。

    • 0 より大きい値：機能が有効です。値は、最適化が実行されるまでのクリーンアップ回数を示します。

    0
    CurrentClearTaskCount

    integer

    最適化が実行された回数。このパラメーターは、OptimizeTableAfterEveryClearTimes の値が 0 より大きい場合にのみ有効です。

    0
    ErrorCode

    string

    リクエストが失敗した場合に返されるエラーコード。

    UnknownError
    ErrorMessage

    string

    リクエストが失敗した場合に返されるエラーメッセージ。

    UnknownError
    Success

    boolean

    操作が成功したかどうかを示します。有効な値は以下のとおりです。

    • true

    • false

    true

    例

    成功レスポンス

    JSONJSON

    {
  "RequestId": "427688B8-ADFB-4C4E-9D45-EF5C1FD6E23D",
  "DataCorrectOrderDetail": {
    "PreCheckDetail": {
      "TaskCheckDO": [
        {
          "UserTip": "tip messsage",
          "CheckStatus": "SUCCESS",
          "CheckStep": "PERMISSION_CHECK"
        }
      ]
    },
    "OrderDetail": {
      "RbSQL": "empty",
      "RbAttachmentName": "test",
      "Classify": "test",
      "ExeSQL": "update t1 set name = 'xxx' where id <= 100",
      "EstimateAffectRows": 100,
      "RbSQLType": "text",
      "ActualAffectRows": 100,
      "IgnoreAffectRows": false,
      "AttachmentName": "xxx",
      "SqlType": "text",
      "IgnoreAffectRowsReason": "test"
    },
    "DatabaseList": {
      "Database": [
        {
          "DbId": 0,
          "DbType": "mysql",
          "Logic": false,
          "SearchName": "xxx@xxx:3306",
          "EnvType": "product"
        }
      ]
    },
    "Status": "approved",
    "ExecMode": "COMMITOR",
    "ConfigDetail": {
      "DetailType": "BIG_FILE",
      "FileType": "CSV",
      "CsvTableName": "tb_import_tb_name",
      "FileEncoding": "UTF-8",
      "Cron": true,
      "CronCallTimes": 0,
      "CronFormat": "0 0 2 * * ?",
      "Duration": 1,
      "CronStatus": "SUCCESS",
      "CronLastCallStartTime": "2024-04-19 02:00:00.0",
      "CronNextCallTime": "2024-04-19 02:00:00\n",
      "CurrentTaskId": 0,
      "ImportExtConfig": {
        "InsertType": "INSERT",
        "CsvFirstRowIsColumnDef": true,
        "IgnoreError": false,
        "ImportMode": "FAST_MODE"
      },
      "CronExtConfig": {
        "OptimizeTableAfterEveryClearTimes": 0,
        "CurrentClearTaskCount": 0
      }
    }
  },
  "ErrorCode": "UnknownError",
  "ErrorMessage": "UnknownError",
  "Success": true
}

    エラーコード

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

    変更履歴

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