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

Data Management:GetDataArchiveOrderDetail

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

get

*All Resource

*

なし なし

リクエストパラメーター

パラメーター

必須 / 任意

説明

OrderId

integer

必須

データアーカイブチケットの ID。

868****

Tid

integer

任意

テナント ID。

説明

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

5***

レスポンスフィールド

フィールド

説明

object

TraceId

string

サービスリクエストの追跡に使用されます。

0a06e1e316757357507896067d3780

Success

boolean

リクエストが成功したかどうかを示します。有効な値は以下のとおりです。

  • true

  • false

true

ErrorMessage

string

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

User [199295823****] not exist

ErrorCode

string

呼び出しが失敗した場合に返されるエラーコード。

NoPermission

RequestId

string

リクエスト ID。ログの照会や問題のトラブルシューティングに使用されます。

4161CE36-28DF-5191-8A6F-A17076A0B124

DataArchiveOrderDetail

object

データアーカイブチケットの詳細情報。

Comment

string

データアーカイブチケットの説明。

Archiving of test results

Committer

string

チケットを提出したユーザー。

dmstest

CommitterId

integer

チケットを提出したユーザーの ID。これはユーザー ID であり、Alibaba Cloud アカウントの ID ではありません。

26***

GmtCreate

string

チケットが作成された時刻。

2023-05-15 16:00:48

GmtModified

string

チケットが最後に変更された時刻。

2023-05-23 16:00:48

Id

integer

データアーカイブチケットの ID。

868****

PluginExtraData

object

チケットに関する追加情報。

DagInfo

object

ワークフローに関する情報。

CreatorId

string

タスクフローを作成したユーザーの ID。

59****

CronBeginDate

string

スケジューリングの開始時刻。この時刻より前にはタスクフローはスケジュールされません。

1970-01-01

CronEndDate

string

スケジューリングの終了時刻。この時刻以降にはタスクフローはスケジュールされません。

9999-01-01

CronTrigger

boolean

アーカイブタスクが定期タスクであるかどうかを示します。有効な値は以下のとおりです。

  • true

  • false

false

DWDevelop

boolean

タスクがデータウェアハウスの開発に使用されるかどうかを示します。

説明

このフィールドは未使用の予約フィールドです。

false

DagName

string

ワークフローの名前。

data-archive-9099197

DagOwnerId

string

ワークフローの所有者の ID。

13****

DeployId

integer

デプロイメントレコードの ID。

93***

Description

string

ワークフローの説明。

order id:9099197

EditDagId

integer

編集可能なワークフローバージョンの ID。

24***

GmtCreate

string

ワークフローが作成された時刻。

2023-05-15 16:00:48

GmtModified

string

ワークフローが最後に変更された時刻。

2023-06-15 16:00:48

Id

integer

タスクフローの ID。

24***

IsPublic

integer

ワークフローが公開されているかどうかを示します。有効な値は以下のとおりです。

  • 0: 非公開。

  • 1: 公開。

0

Legacy

boolean

タスクが過去のものであるかどうかを示します。有効な値は以下のとおりです。

  • true

  • false

false

System

boolean

タスクがシステムによって作成されたかどうかを示します。有効な値は以下のとおりです。

  • true

  • false

false

TenantId

string

テナント ID。

5***

TriggerOnce

boolean

ワークフローが 1 回だけ実行されるかどうかを示します。有効な値は以下のとおりです。

  • true

  • false

false

DbBaseInfo

object

データアーカイブチケットに関連するデータベース情報。

Alias

string

データベースインスタンスのエイリアス。

tf-testAccDMSEnterpriseLogicDatabase853****

AlterTimeout

integer

データベースに対するクエリのタイムアウト期間。

600

AssetControl

boolean

データ資産へのアクセス制御が有効になっているかどうかを示します。有効な値は以下のとおりです。

  • true

  • false

true

CatalogName

string

インスタンス一覧におけるインスタンスの名前。

test

ClusterNode

string

インスタンスが DMS ホワイトリストに追加されているかどうかを示します。

whitelist_done

DbId

integer

データベースの ID。データベースの ID を照会するには、SearchDatabase 操作を呼び出します。

説明

物理データベースの ID を照会するには ListDatabases 操作を、論理データベースの ID を照会するには ListLogicDatabases 操作を呼び出します。

348****

DbType

string

データベースの種類。有効な値については、「DbType パラメーター」をご参照ください。

MySQL

DbaId

integer

インスタンスのデータベース管理者 (DBA) の ID。

16****

DbaName

string

インスタンスの DBA のニックネーム。

DBA

Description

string

データベースの完全なエンドポイント。

test@rm-2ze756u8837****.mysql.rds.aliyuncs.com:3306 [test]

Encoding

string

データベースのエンコード形式。

utf8

EnvType

string

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

  • product: 本番環境

  • dev: 開発環境

  • pre: ステージング環境

  • test: テスト環境

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

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

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

  • stag: STAG 環境

product

Follow

boolean

インスタンスに特別な注意が必要かどうかを示します。有効な値は以下のとおりです。

  • true

  • false

false

Host

string

データベースに接続するために使用されるエンドポイント。

rm-2ze756u8837****.mysql.rds.aliyuncs.com

Idc

string

データベースインスタンスが存在するリージョン。

cn-beijing

IdcTitle

string

データベースインスタンスが存在するリージョンの名前。

cn-beijing

InstanceId

integer

データベースが属するインスタンスの ID。

175****

InstanceSource

string

データベースインスタンスのソース。有効な値は以下のとおりです。

  • RDS: ApsaraDB RDS インスタンス。

  • ECS_OWN: Elastic Compute Service (ECS) インスタンス上で展開された自己管理データベース。

  • PUBLIC_OWN: インターネット経由で接続される自己管理データベースインスタンス。

  • VPC_ID: Express Connect 回線経由で接続される仮想プライベートクラウド (VPC) 内の自己管理データベースインスタンス。

  • GATEWAY: database gateway を使用して接続されるデータベースインスタンス。

RDS

LastSyncTime

string

データベース情報が最後に取得された時刻。

2023-05-14 18:34:45

Level

string

インスタンスレベル。

Logic

boolean

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

  • true

  • false

false

OwnerIds

array

データベースの所有者の ID(配列として格納)。所有者の ID を照会するには、GetUser または ListUsers 操作を呼び出します。

説明

OwnerIds の値は UserId の値と同じです。

integer

インスタンスの所有者の ID。

77****

OwnerNames

array

データベース所有者のユーザー名。

string

データベース所有者のユーザー名。

天天

Port

integer

データベースに接続するために使用されるポート。

3306

SchemaName

string

データベースの名前。

test

SearchName

string

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

test@rm-2ze756u8837****.mysql.rds.aliyuncs.com:3306 [test]

StandardGroup

object

インスタンスのコントロールモードの詳細。

DbType

string

インスタンスエンジンの種類。有効な値については、「DbType パラメーター」をご参照ください。

MySQL

Description

string

セキュリティルールセットの説明。

adb_mysql default

FreeOrStable

boolean

インスタンスが柔軟な管理モードまたは安定的な変更モードで管理されているかどうかを示します。有効な値は以下のとおりです。

  • true

  • false

false

GmtCreate

string

セキュリティルールが作成された時刻。

2020-05-24 14:12:32

GmtModified

string

セキュリティルールが最後に変更された時刻。

2020-05-25 14:12:32

GroupMode

string

インスタンスのコントロールモードの種類。有効な値は以下のとおりです。

  • COMMON: セキュリティコラボレーションモードで管理されます。

  • NONE_CONTROL: 柔軟な管理モードで管理されます。

  • STABLE: 安定的な変更モードで管理されます。

COMMON

GroupName

string

コントロールモードに対応するセキュリティルールの名前。

adb_mysql default

Id

integer

セキュリティルールの ID。

24***

LastMenderId

integer

最後に変更されたセキュリティルールのユーザー ID。

12****

State

string

データベースのステータス。有効な値は以下のとおりです。

  • NORMAL: データベースが正常に稼働しています。

  • DISABLE: データベースが無効化されています。

  • OFFLINE: データベースが非公開になっています。

  • NOT_EXIST: データベースが存在しません。

NORMAL

TableCount

integer

テーブル数。

201

TnsName

string

TNS 名。

TNS_4010

UnitType

string

単位タイプ。

-1

InstanceTotal

integer

アーカイブタスクの合計数。

2

Instances

array<object>

アーカイブタスクのリスト。

object

BusinessTime

string

タスクフローの業務日時。yyyy-MM-DD HH:mm:ss 形式で表示されます。

2023-05-14 16:00:57

DagId

integer

タスクフロー ID。このパラメーターの値を取得するには、ListTaskFlow または ListLhTaskFlowAndScenario 操作を呼び出します。

37***

EndTime

string

タスクフローの終了時刻。yyyy-MM-DD HH:mm:ss 形式で表示されます。

2022-06-04 15:14:00

GmtCreate

string

タスクフローが作成された時刻。

2023-05-14 16:00:57

GmtModified

string

タスクフローが最後に変更された時刻。

2023-05-14 16:00:57

HistoryDagId

integer

履歴タスクフローの ID。

32***

Id

integer

実行中のタスクフロー内のインスタンスの ID。

24***

LastRunningContext

string

タスクフローの前回実行時のコンテキスト。

{ "nodes": [ 48** ], "edges": {} }

Msg

string

タスクフローの現在の実行時のコンテキスト。

归档任务日志:2023-05-15 16:37:48[GMT+08:00] INFO - Resource Control is active!\n2023-05-15 16:37:48[GMT+08:00] INFO - Starting job j_4834 at Mon May 15 16:37:48 CST 2023

Status

integer

タスクのステータス。有効な値は以下のとおりです。

  • 0: タスクは実行待ちです。

  • 1: タスクは進行中です。

  • 2: タスクは一時停止しています。

  • 3: タスクは失敗しました。

  • 4: タスクは成功しました。

  • 5: タスクは完了しました。

4

TenantId

string

テナント ID。

5***

TriggerType

integer

タスクフローがトリガーされたモード。有効な値は以下のとおりです。

  • 0: スケジュールに基づいてトリガーされました。

  • 1: 手動でトリガーされました。

1

Version

string

バージョン番号。

1

NextFireTimeResult

object

次のタスクがトリガーされる時刻。

CronFireType

string

スケジュールによるトリガーの種類。

NOT_SET

PageIndex

integer

ページ番号。

10

PageSize

integer

1 ページあたりのエントリー数。

20

TempTableNameMap

object

アーカイブタスクによって生成された一時テーブルの名前(アーカイブタスク ID で示されます)。

{ "803***": [ "tmp_dms_21321_20230704144336_temp_test_check" ] }

PluginParam

object

チケット作成パラメーター。値は JSON 文字列です。詳細については、「PluginType パラメーター」をご参照ください。

ArchiveMethod

string

アーカイブ先の種類。

inner_oss

DbSchema

string

アーカイブ対象のデータベースおよびテーブルのスキーマ。

test

Logic

boolean

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

  • true

  • false

true

OrderAfter

array

アーカイブ後の動作。

string

アーカイブ後の動作。この動作では、DELETE 文を使用してテーブルをクリーンアップします。

delete

RunMethod

string

タスクをすぐに実行するか、特定の時刻に実行するかを示す実行方法。

now

SourceDatabaseId

integer

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

12***

TableIncludes

array<object>

アーカイブされたテーブルのリストとフィルター条件。

object

TableName

string

テーブル名。

tm_insured_cb

TableWhere

string

フィルター条件。

id<1000或者gmt_create<'2023-05-14 16:00:57'

TableMapping

array

スキーマのマッピング。

string

ソーステーブル名、ソース列名、宛先テーブル名、および宛先列のマッピング。

{ "schema": "oracle_info", "tarTb": "eoa_context_test", "tbPartKey": [], "oriTb": "eoa_context", "columns": [ { "tName": "dbid_test", "oName": "dbid" } ], "dbPartKey": [], "customPk": [ "id" ] }

TargetInstanceId

string

宛先インスタンスの ID。

12***

Variables

array

スケジュールされたアーカイブ用に定義された時間変数。

string

現在の時刻の前の日に基づいてオフセットを計算する時間変数。

{ "name": "test", "pattern": "yyyy-MM-dd|-10d" }

PluginType

string

チケットの種類に対応するプラグインの種類。データアーカイブのプラグインの種類は DATA_ARCHIVE です。詳細については、「PluginType パラメーター」をご参照ください。

DATA_ARCHIVE

RelatedUserList

array

チケットに関連するユーザー ID。

integer

チケットに関連するユーザー ID。

65****

RelatedUserNickList

array

チケットに関連するユーザーのニックネーム。

string

チケットに関連付けられたユーザーのニックネーム。

publicyuhzou

StatusCode

string

チケットのステータスコード。有効な値は以下のとおりです。

  • new: 新規作成。

  • toaudit: レビュー中。

  • Approved: 承認済み。

  • reject: 拒否済み。

  • processing: 実行中。

  • Success: 成功。

  • closed: 無効。

processing

StatusDesc

string

チケットのステータス説明。

正在执行工单任务。

WorkflowInstanceId

integer

承認プロセスの ID。承認プロセスの ID を取得するには、GetOrderBaseInfo 操作を呼び出します。

29****

WorkflowStatusDesc

string

承認プロセスの説明。

审批通过

成功レスポンス

JSONJSON

{
  "TraceId": "0a06e1e316757357507896067d3780",
  "Success": true,
  "ErrorMessage": "User [199295823****] not exist",
  "ErrorCode": "NoPermission",
  "RequestId": "4161CE36-28DF-5191-8A6F-A17076A0B124",
  "DataArchiveOrderDetail": {
    "Comment": "Archiving of test results",
    "Committer": "dmstest",
    "CommitterId": 0,
    "GmtCreate": "2023-05-15 16:00:48",
    "GmtModified": "2023-05-23 16:00:48",
    "Id": 0,
    "PluginExtraData": {
      "DagInfo": {
        "CreatorId": "59****",
        "CronBeginDate": "1970-01-01",
        "CronEndDate": "9999-01-01",
        "CronTrigger": false,
        "DWDevelop": false,
        "DagName": "data-archive-9099197",
        "DagOwnerId": "13****",
        "DeployId": 0,
        "Description": "order id:9099197",
        "EditDagId": 0,
        "GmtCreate": "2023-05-15 16:00:48",
        "GmtModified": "2023-06-15 16:00:48",
        "Id": 0,
        "IsPublic": 0,
        "Legacy": false,
        "System": false,
        "TenantId": "5***",
        "TriggerOnce": false
      },
      "DbBaseInfo": {
        "Alias": "tf-testAccDMSEnterpriseLogicDatabase853****",
        "AlterTimeout": 600,
        "AssetControl": true,
        "CatalogName": "test",
        "ClusterNode": "whitelist_done",
        "DbId": 0,
        "DbType": "MySQL",
        "DbaId": 0,
        "DbaName": "DBA",
        "Description": "test@rm-2ze756u8837****.mysql.rds.aliyuncs.com:3306 [test]",
        "Encoding": "utf8",
        "EnvType": "product",
        "Follow": false,
        "Host": "rm-2ze756u8837****.mysql.rds.aliyuncs.com",
        "Idc": "cn-beijing",
        "IdcTitle": "cn-beijing",
        "InstanceId": 0,
        "InstanceSource": "RDS",
        "LastSyncTime": "2023-05-14 18:34:45",
        "Level": "中",
        "Logic": false,
        "OwnerIds": [
          0
        ],
        "OwnerNames": [
          "天天"
        ],
        "Port": 3306,
        "SchemaName": "test",
        "SearchName": "test@rm-2ze756u8837****.mysql.rds.aliyuncs.com:3306 [test]",
        "StandardGroup": {
          "DbType": "MySQL",
          "Description": "adb_mysql default",
          "FreeOrStable": false,
          "GmtCreate": "2020-05-24 14:12:32",
          "GmtModified": "2020-05-25 14:12:32",
          "GroupMode": "COMMON",
          "GroupName": "adb_mysql default",
          "Id": 0,
          "LastMenderId": 0
        },
        "State": "NORMAL",
        "TableCount": 201,
        "TnsName": "TNS_4010",
        "UnitType": "-1"
      },
      "InstanceTotal": 2,
      "Instances": [
        {
          "BusinessTime": "2023-05-14 16:00:57",
          "DagId": 0,
          "EndTime": "2022-06-04 15:14:00",
          "GmtCreate": "2023-05-14 16:00:57",
          "GmtModified": "2023-05-14 16:00:57",
          "HistoryDagId": 0,
          "Id": 0,
          "LastRunningContext": "{\n      \"nodes\": [\n            48**\n      ],\n      \"edges\": {}\n}",
          "Msg": "归档任务日志:2023-05-15 16:37:48[GMT+08:00] INFO - Resource Control is active!\\n2023-05-15 16:37:48[GMT+08:00] INFO - Starting job j_4834 at Mon May 15 16:37:48 CST 2023",
          "Status": 4,
          "TenantId": "5***",
          "TriggerType": 1,
          "Version": "1"
        }
      ],
      "NextFireTimeResult": {
        "CronFireType": "NOT_SET"
      },
      "PageIndex": 10,
      "PageSize": 20,
      "TempTableNameMap": {
        "803***": [
          "tmp_dms_21321_20230704144336_temp_test_check"
        ]
      }
    },
    "PluginParam": {
      "ArchiveMethod": "inner_oss",
      "DbSchema": "test",
      "Logic": true,
      "OrderAfter": [
        "delete"
      ],
      "RunMethod": "now",
      "SourceDatabaseId": 0,
      "TableIncludes": [
        {
          "TableName": "tm_insured_cb",
          "TableWhere": "id<1000或者gmt_create<'2023-05-14 16:00:57'"
        }
      ],
      "TableMapping": [
        "{\n                    \"schema\": \"oracle_info\",\n                    \"tarTb\": \"eoa_context_test\",\n                    \"tbPartKey\": [],\n                    \"oriTb\": \"eoa_context\",\n                    \"columns\": [\n                        {\n                            \"tName\": \"dbid_test\",\n                            \"oName\": \"dbid\"\n                        }\n                    ],\n                    \"dbPartKey\": [],\n                    \"customPk\": [\n                        \"id\"\n                    ]\n                }"
      ],
      "TargetInstanceId": "12***",
      "Variables": [
        "{\n                    \"name\": \"test\",\n                    \"pattern\": \"yyyy-MM-dd|-10d\"\n                }"
      ]
    },
    "PluginType": "DATA_ARCHIVE",
    "RelatedUserList": [
      0
    ],
    "RelatedUserNickList": [
      "publicyuhzou"
    ],
    "StatusCode": "processing",
    "StatusDesc": "正在执行工单任务。",
    "WorkflowInstanceId": 0,
    "WorkflowStatusDesc": "审批通过"
  }
}

エラーコード

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

変更履歴

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