MMA 移行ジョブの GetMmsJob API リファレンス - MaxCompute

MaxCompute Migration Assist (MMA) の移行計画の詳細を取得します。

今すぐお試しください

この 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 ロールに付与する必要があります。

アクション

アクセスレベル

リソースタイプ

条件キー

依存アクション

odps:GetMmsJob

get

*project

acs:odps:{#regionId}:{#accountId}:mmsdatasource/{#sourceId}

なし

リクエスト構文

GET /api/v1/mms/datasources/{sourceId}/jobs/{jobId} HTTP/1.1

パスパラメーター

パラメーター	型	必須 / 任意	説明	例
sourceId	integer	必須	データソース ID。	2000015
jobId	integer	必須	ジョブ ID。	10

リクエストパラメーター

パラメーター

型

必須 / 任意

説明

例

リクエストパラメーターは必要ありません。

レスポンスフィールド

フィールド	型	説明	例
	object	ApiRes
requestId	string	リクエスト ID。	D9F872FD-5DDE-30A6-8C8A-1B8C6A81059F
data	object	移行ジョブオブジェクト。
id	integer	移行ジョブ ID。	10
name	string	移行ジョブの名前。	migrate_db_1
sourceId	integer	データソース ID。	2
dbId	integer	ソースデータベース ID。	23
sourceName	string	データソースの名前。	demo
srcDbName	string	ソースデータベースの名前。	mms_test
srcSchemaName	string	ソーススキーマの名前。このパラメーターは、レイヤー 3 名前空間内のスキーマを指定します。	default
dstDbName	string	宛先 MaxCompute プロジェクト。	mms_target
dstSchemaName	string	宛先 MaxCompute スキーマ。	default
status	string	移行タスクのステータス。列挙値: INIT : 未開始 DONE : 成功 DOING : 実行中 FAILED : 失敗	DOING
type	string	移行範囲。有効な値：Database、Tables、Partitions。列挙値: Partitions : 複数のパーティション Database : 単一のデータベース Tables : 複数のテーブル	Tables
taskNum	integer	ジョブに含まれる移行タスクの数。	100
stopped	boolean	停止済み。	false
createTime	string	ジョブが作成された時刻。	2024-12-17 15:44:17
taskDone	integer	完了した移行タスクの数。	100
config	object	移行ジョブの構成。
partitions	array	type が Partitions に設定されている場合、このパラメーターは移行対象のテーブルのパーティション ID のリストを指定します。
	integer	移行対象のテーブルのパーティション ID。	[123, 132]
tables	array	type が Tables に設定されている場合、このパラメーターは移行対象のテーブル名のリストを指定します。
	string	移行対象のテーブルの名前。	["student", "scores"]
taskType	string	非推奨。有効な値：MOCK、HIVE（Hive ユーザー定義のテーブル値関数 (UDTF) タスク）、HIVE_DATAX（Hive DataX タスク）、COPY_TASK（ODPS Copy タスク）、ODPS_INSERT_OVERWRITE（ODPS 単純 INSERT OVERWRITE タスク）、MC2MC_VERIFY、OSS、HIVE_OSS、HIVE_SPARK、BIGQUERY。	BIGQUERY
tableBlackList	array	type が Database に設定されている場合、このパラメーターは移行から除外するテーブルを指定します。
	string	type が Database に設定されている場合、このパラメーターは除外するテーブルを指定します。	["student", "scores"]
tableWhiteList	array	type が Database に設定されている場合、このパラメーターは移行対象のテーブルのリストを指定します。このパラメーターを指定しない場合は、データベース内のすべてのテーブルが移行されます。
	string	type が Database に設定されている場合、このパラメーターは移行対象のテーブルを指定します。	["student", "scores"]
partitionFilters	object	パーティションフィルター式。このパラメーターは、特定のテーブルに対するパーティションフィルター式を指定します。
	string	パーティションフィルター式。例：p1 >= '2022-03-04' and (p2 = 10 or p3 > 20) and p4 in ('abc', 'cde')。以下に式の説明を示します。 p1、p2、および p3 はパーティション名です。パーティション値は文字列または数値で指定できます。文字列は二重引用符またはシングル引用符で囲む必要があります。 INT および BIGINT 以外のデータ型のパーティションキー列の場合、パーティション値は文字列のみ指定可能です。サポートされる比較演算子：>、>=、=、<、<=、<>。パーティションフィルター式では IN 演算子がサポートされています。サポートされる論理演算子：AND、OR。括弧がサポートされています。	{ "student": "p1 >= '2022-03-04' and (p2 = 10 or p3 > 20) and p4 in ('abc', 'cde')" }
schemaOnly	boolean	非推奨	false
tableMapping	object	ソーステーブル名から宛先テーブル名へのマッピング。
	string	ソーステーブル名から宛先テーブル名へのマッピング。	{'a': 'a1'}
increment	boolean	増分移行。新規または変更されたパーティションのみを移行します。注：変更されたパーティションは再移行されます。	true
enableVerification	boolean	データ検証を有効化します。現在の検証方法は、ソースと宛先に対して SELECT COUNT 文を実行し、行数を比較することです。	true
tunnelQuota	string	非推奨	Depcreated
columnMapping	object	{ソース列名: 宛先列名}
	string	{ソース列名: 宛先列名}	{"c-1": "c_1"}
others	object	その他の構成情報。	{"spark.executor.mem": "2g"}
eta	string	移行の予定完了時刻。注：eta 値が小さいほど、移行タスクの優先度が高くなります。	2025-05-06

例

成功レスポンス

JSONJSON

{
  "requestId": "D9F872FD-5DDE-30A6-8C8A-1B8C6A81059F",
  "data": {
    "id": 10,
    "name": "migrate_db_1",
    "sourceId": 2,
    "dbId": 23,
    "sourceName": "demo",
    "srcDbName": "mms_test",
    "srcSchemaName": "default",
    "dstDbName": "mms_target",
    "dstSchemaName": "default",
    "status": "DOING",
    "type": "Tables",
    "taskNum": 100,
    "stopped": true,
    "createTime": "2024-12-17 15:44:17",
    "taskDone": 100,
    "config": {
      "partitions": [
        0
      ],
      "tables": [
        "[\"student\", \"scores\"]"
      ],
      "taskType": "BIGQUERY",
      "tableBlackList": [
        "[\"student\", \"scores\"]"
      ],
      "tableWhiteList": [
        "[\"student\", \"scores\"]"
      ],
      "partitionFilters": {
        "key": "{\n\"student\": \"p1 >= '2022-03-04' and (p2 = 10 or p3 > 20) and p4 in ('abc', 'cde')\" \n}\n"
      },
      "schemaOnly": false,
      "tableMapping": {
        "key": "{'a': 'a1'}"
      },
      "increment": true,
      "enableVerification": true,
      "tunnelQuota": "Depcreated",
      "columnMapping": {
        "key": "{\"c-1\": \"c_1\"}"
      },
      "others": {
        "spark.executor.mem": "2g"
      }
    },
    "eta": "2025-05-06"
  }
}

エラーコード

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

変更履歴

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