ListMmsJobs API で MMS 移行タスクをクエリ - MaxCompute

移行ジョブの一覧を取得します。

今すぐお試しください

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

list

*project

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

なし

リクエスト構文

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

パスパラメーター

パラメーター	型	必須 / 任意	説明	例
sourceId	integer	必須	データソースの ID です。	2000002

リクエストパラメーター

パラメーター	型	必須 / 任意	説明	例
name	string	任意	データソースの名前です。	demo
srcDbName	string	任意	ソースデータベースの名前です。	test_db_1
srcTableName	string	任意	ソーステーブルの名前です。	test_table_1
dstDbName	string	任意	移行先の MaxCompute プロジェクトです。	mms_test
dstTableName	string	任意	移行先の MaxCompute テーブルです。	test_table_1
status	string	任意	移行ジョブのステータスです。列挙値: INIT : 移行が開始されていません。 DONE : 移行が正常に完了しました。 DOING : 移行が実行中です。 FAILED : 移行に失敗しました。	DOING
stopped	integer	任意	ジョブが停止しているかどうかを示します。	false
timerId	integer	任意	タイマー ID です。	1
pageNum	integer	任意	返すページ番号です。	1
pageSize	integer	任意	1 ページあたりに返す項目数です。	10
sorter.status	string	任意	ステータスで並べ替えます。列挙値: asc : 昇順 desc : 降順	desc

レスポンスフィールド

フィールド	型	説明	例
	object	応答として返されるデータです。
requestId	string	リクエスト ID です。	1112E7C7-C65F-57A2-A7C7-3B178AA257B6
data	object	応答データの詳細です。
total	integer	レコードの合計数です。	100
objectList	array<object>	移行ジョブの一覧です。
	array<object>	移行ジョブオブジェクトです。
id	integer	移行ジョブの ID です。	18
name	string	移行ジョブの名前です。	migrate_db_1
sourceId	integer	データソースの ID です。	2000015
dbId	integer	ソースデータベースの ID です。	196
sourceName	string	データソースの名前です。	demo
srcDbName	string	ソースデータベースの名前です。	test_db_1
srcSchemaName	string	ソーススキーマ名です。これは、第 3 層名前空間内のスキーマです。	test_table_1
dstDbName	string	移行先の MaxCompute プロジェクトです。	mms_test
dstSchemaName	string	移行先の MaxCompute スキーマです。	test_table_1
status	string	移行ジョブのステータスです。列挙値: INIT : ジョブが開始されていません。 DONE : ジョブが完了しました。 DOING : ジョブが実行中です。 FAILED : ジョブが失敗しました。	DONE
type	string	移行範囲です。有効な値は、Database、Tables、Partitions です。列挙値: Partitions : 複数のパーティションを移行します。 Database : 単一のデータベースを移行します。 Tables : 複数のテーブルを移行します。	Tables
taskNum	integer	ジョブ内の移行タスク数です。	10
stopped	boolean	移行ジョブが停止しているかどうかを示します。	false
createTime	string	移行ジョブが停止されているかどうかを示します。	2024-12-17 15:44:17
taskDone	integer	完了した移行タスク数です。	10
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 に設定されている場合、移行対象のテーブルを指定します。tableWhiteList を指定しない場合、指定されたデータベース内のすべてのテーブルが移行されます。
	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
pageNum	integer	ページ番号です。	1
pageSize	integer	1 ページあたりに返すエントリ数です。	10

例

成功レスポンス

JSONJSON

{
  "requestId": "1112E7C7-C65F-57A2-A7C7-3B178AA257B6",
  "data": {
    "total": 100,
    "objectList": [
      {
        "id": 18,
        "name": "migrate_db_1",
        "sourceId": 2000015,
        "dbId": 196,
        "sourceName": "demo",
        "srcDbName": "test_db_1",
        "srcSchemaName": "test_table_1",
        "dstDbName": "mms_test",
        "dstSchemaName": "test_table_1",
        "status": "DONE",
        "type": "Tables",
        "taskNum": 10,
        "stopped": false,
        "createTime": "2024-12-17 15:44:17\n",
        "taskDone": 10,
        "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}"
          },
          "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"
      }
    ],
    "pageNum": 1,
    "pageSize": 10
  }
}

エラーコード

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

変更履歴

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