Data Integration で作成した新バージョンの同期タスクに関する情報を照会します。サポートされる同期タスクの種類には、MySQL データベース内の全データを Hologres へリアルタイム同期するものがあります。
今すぐお試しください
テスト
RAM 認証
|
アクション |
アクセスレベル |
リソースタイプ |
条件キー |
依存アクション |
|
dataworks:* |
get |
*All Resource
|
なし | なし |
リクエストパラメーター
|
パラメーター |
型 |
必須 / 任意 |
説明 |
例 |
| DIJobId |
integer |
必須 |
同期タスクの ID です。 |
11588 |
| WithDetails |
boolean |
任意 |
変換ルール (TransformationRules)、テーブルマッピング (TableMappings)、ジョブ設定 (JobSettings) を含む詳細な構成情報を返すかどうかを指定します。有効な値:true、false。デフォルト値:true。 |
true |
レスポンスフィールド
|
フィールド |
型 |
説明 |
例 |
|
object |
応答結果です。 |
||
| Data |
object |
同期タスクの情報です。 |
|
| ProjectId |
integer |
ワークスペース ID です。 |
22 |
| DIJobId |
integer |
同期タスクの ID です。 |
11588 |
| JobName |
string |
同期タスクの名前です。 |
mysql_to_holo_sync_445 |
| Description |
string |
同期タスクの説明です。 |
Synchronize mysql to hologres |
| MigrationType |
string |
同期タイプです。有効な値は以下のとおりです。
|
FullAndRealtimeIncremental |
| SourceDataSourceType |
string |
ソースタイプです。「MySQL」が返されます。 |
MySQL |
| DestinationDataSourceType |
string |
送信先タイプです。有効な値:Hologres、Hive。 |
Hologres |
| SourceDataSourceSettings |
array<object> |
ソースの設定です。単一のソースのみサポートされます。 |
|
|
array<object> |
|||
| DataSourceName |
string |
データソースの名前です。 |
mysql_datasource_1 |
| DataSourceProperties |
object |
データソースのプロパティです。 |
|
|
string |
ソースのプロパティです。MySQL データソースのプロパティには、TimeZone および Encoding が含まれます。 |
TimeZone |
|
| DestinationDataSourceSettings |
array<object> |
送信先の設定です。単一の送信先のみサポートされます。 |
|
|
array<object> |
|||
| DataSourceName |
string |
データソースの名前です。 |
holo_datasource_1 |
| DataSourceProperties |
object |
データソースのプロパティです。 |
|
|
string |
送信先のプロパティです。DataWorks では Hologres データソースのプロパティを設定できないため、プロパティは返されません。 |
TimeZone |
|
| ResourceSettings |
object |
リソース設定です。 |
|
| OfflineResourceSettings |
object |
バッチ同期に使用されるリソースです。 |
|
| ResourceGroupIdentifier |
string |
バッチ同期に使用される Data Integration のリソースグループ識別子です。 |
S_res_group_111_222 |
| RealtimeResourceSettings |
object |
リアルタイム同期に使用されるリソースです。 |
|
| ResourceGroupIdentifier |
string |
リアルタイム同期に使用される Data Integration のリソースグループ識別子です。 |
S_res_group_111_222 |
| RequestedCu |
number |
増分同期および完全同期に使用されるリソースグループ内の計算ユニット (CU) 数です。 |
2.0 |
| TransformationRules |
array<object> |
ソースから選択された同期対象オブジェクトに適用される変換ルールの一覧です。リスト内の各エントリは、1 つの変換ルールを定義します。 |
|
|
object |
ソースから選択された同期対象オブジェクトに適用される変換ルールです。 |
||
| RuleActionType |
string |
操作タイプです。有効な値は以下のとおりです。
|
Rename |
| RuleExpression |
string |
ルールの式です。式は JSON 文字列です。
|
{"expression":"${srcDatasoureName}_${srcDatabaseName}"} |
| RuleName |
string |
ルールの名前です。複数の変換ルールで RuleActionType パラメーターと RuleTargetType パラメーターの値が同じである場合、変換ルールの名前は一意である必要があります。 |
rename_rule_1 |
| RuleTargetType |
string |
操作対象のオブジェクトのタイプです。有効な値:
|
Table |
| TableMappings |
array<object> |
ソースから同期対象オブジェクトを選択するためのルールと、選択された同期対象オブジェクトに適用される変換ルールとの間のマッピング一覧です。リスト内の各エントリは、同期対象オブジェクトを選択するルールと、それらのオブジェクトに適用される変換ルールとのマッピングを表示します。 |
|
|
array<object> |
ソースから同期対象オブジェクトを選択するルールと、選択された同期対象オブジェクトに適用される変換ルールとのマッピングです。 |
||
| SourceObjectSelectionRules |
array<object> |
ソースから同期対象オブジェクトを選択するためのルールの一覧です。 |
|
|
object |
ソースから同期対象オブジェクト(データベースまたはテーブル)を選択するためのルールです。 |
||
| Expression |
string |
式です。 |
mysql_table_1 |
| ObjectType |
string |
オブジェクトタイプです。有効な値:
|
Table |
| TransformationRules |
array<object> |
ソースから選択された同期対象オブジェクトに適用される変換ルールの一覧です。 |
|
|
object |
ソースから選択された同期対象オブジェクトに適用される変換ルールです。 |
||
| RuleActionType |
string |
操作タイプです。有効な値:
|
Rename |
| RuleName |
string |
ルールの名前です。複数の変換ルールで RuleActionType パラメーターと RuleTargetType パラメーターの値が同じである場合、変換ルールの名前は一意である必要があります。 |
rename_rule_1 |
| RuleTargetType |
string |
操作対象のオブジェクトのタイプです。有効な値:
|
Table |
| JobSettings |
object |
同期タスクのディメンションに関する設定です。設定には、DDL メッセージの処理ポリシー、ソースフィールドと送信先フィールド間のデータ型マッピングのポリシー、同期タスクの実行時パラメーターが含まれます。 |
|
| ColumnDataTypeSettings |
array<object> |
ソースフィールドと送信先フィールド間のデータ型マッピングの設定です。このパラメーターの値は配列です。 |
|
|
object |
|||
| SourceDataType |
string |
ソースフィールドのデータの型です。 |
bigint |
| DestinationDataType |
string |
送信先フィールドのデータの型です。 |
text |
| DdlHandlingSettings |
array<object> |
DDL メッセージの処理設定です。このパラメーターの値は配列です。 |
|
|
object |
特定のタイプの DDL メッセージに対する処理設定です。 |
||
| Action |
string |
処理ポリシーです。有効な値:
|
Critical |
| Type |
string |
DDL 操作のタイプです。有効な値:
|
AddColumn |
| RuntimeSettings |
array<object> |
実行時設定です。このパラメーターの値は配列です。 |
|
|
object |
実行時設定です。 |
||
| Name |
string |
設定項目の名前です。有効な値:
|
runtime.offline.concurrent |
| Value |
string |
設定項目の値です。 |
1 |
| CycleScheduleSettings |
object |
定期スケジューリングの設定です。 |
|
| CycleMigrationType |
string |
定期スケジューリングを必要とする同期タイプです。有効な値:
|
Full |
| ScheduleParameters |
string |
スケジューリングパラメーターです。 |
bizdate=$bizdate |
| ChannelSettings |
string |
同期タスクのチャネル制御設定です。このパラメーターの値は JSON 文字列です。 |
{"structInfo":"MANAGED","storageType":"TEXTFILE","writeMode":"APPEND","partitionColumns":[{"columnName":"pt","columnType":"STRING","comment":""}],"fieldDelimiter":""} |
| CreatedTime |
integer |
同期タスクが作成されたタイムスタンプです。秒単位の精度です。 |
1671516776 |
| CreatedUid |
string |
同期タスクを作成したユーザーの ID です。 |
100000001 |
| UpdatedTime |
integer |
同期タスクが最後に変更されたタイムスタンプです。秒単位の精度です。 |
1673859985 |
| UpdatedUid |
string |
同期タスクを最後に変更したユーザーの ID です。 |
100000001 |
| StartedTime |
integer |
同期タスクが最後に開始されたタイムスタンプです。秒単位の精度です。 |
1673859999 |
| StartedUid |
string |
同期タスクを最後に開始したユーザーの ID です。 |
100000001 |
| JobStatus |
string |
同期タスクのステータスです。有効な値:
|
Finished |
| ErrorMessage |
string |
JobStatus パラメーターの値が Failed の場合に返されるエラーメッセージです。 |
error details xxx |
| RunStats |
object |
同期タスクの実行に関する情報です。 |
|
|
string |
同期タスクの実行に関する詳細な統計情報です。
|
StructureMigrationTotalTables |
|
| RequestId |
string |
リクエスト ID です。 |
0000-ABCD-EFG**** |
例
成功レスポンス
JSONJSON
{
"Data": {
"ProjectId": 22,
"DIJobId": 11588,
"JobName": "mysql_to_holo_sync_445",
"Description": "Synchronize mysql to hologres\n",
"MigrationType": "FullAndRealtimeIncremental",
"SourceDataSourceType": "MySQL",
"DestinationDataSourceType": "Hologres",
"SourceDataSourceSettings": [
{
"DataSourceName": "mysql_datasource_1",
"DataSourceProperties": {
"key": "TimeZone"
}
}
],
"DestinationDataSourceSettings": [
{
"DataSourceName": "holo_datasource_1",
"DataSourceProperties": {
"key": "TimeZone"
}
}
],
"ResourceSettings": {
"OfflineResourceSettings": {
"ResourceGroupIdentifier": "S_res_group_111_222"
},
"RealtimeResourceSettings": {
"ResourceGroupIdentifier": "S_res_group_111_222"
},
"RequestedCu": 2
},
"TransformationRules": [
{
"RuleActionType": "Rename",
"RuleExpression": "{\"expression\":\"${srcDatasoureName}_${srcDatabaseName}\"}",
"RuleName": "rename_rule_1",
"RuleTargetType": "Table"
}
],
"TableMappings": [
{
"SourceObjectSelectionRules": [
{
"Expression": "mysql_table_1",
"ObjectType": "Table"
}
],
"TransformationRules": [
{
"RuleActionType": "Rename",
"RuleName": "rename_rule_1",
"RuleTargetType": "Table"
}
]
}
],
"JobSettings": {
"ColumnDataTypeSettings": [
{
"SourceDataType": "bigint",
"DestinationDataType": "text"
}
],
"DdlHandlingSettings": [
{
"Action": "Critical",
"Type": "AddColumn"
}
],
"RuntimeSettings": [
{
"Name": "runtime.offline.concurrent",
"Value": "1"
}
],
"CycleScheduleSettings": {
"CycleMigrationType": "Full",
"ScheduleParameters": "bizdate=$bizdate"
},
"ChannelSettings": "{\"structInfo\":\"MANAGED\",\"storageType\":\"TEXTFILE\",\"writeMode\":\"APPEND\",\"partitionColumns\":[{\"columnName\":\"pt\",\"columnType\":\"STRING\",\"comment\":\"\"}],\"fieldDelimiter\":\"\"}\n"
},
"CreatedTime": 1671516776,
"CreatedUid": "100000001",
"UpdatedTime": 1673859985,
"UpdatedUid": "100000001",
"StartedTime": 1673859999,
"StartedUid": "100000001",
"JobStatus": "Finished",
"ErrorMessage": "error details xxx",
"RunStats": {
"key": "StructureMigrationTotalTables"
}
},
"RequestId": "0000-ABCD-EFG****"
}
エラーコード
|
HTTP ステータスコード |
エラーコード |
エラーメッセージ |
説明 |
|---|---|---|---|
| 500 | InternalError.System | An internal system error occurred. Try again later. | |
| 500 | InternalError.UserId.Missing | An internal system error occurred. Try again later. | |
| 429 | Throttling.Api | The request for this resource has exceeded your available limit. | |
| 429 | Throttling.System | The DataWorks system is busy. Try again later. | |
| 429 | Throttling.User | Your request is too frequent. Try again later. |
完全なリストについては、「エラーコード」をご参照ください。
変更履歴
完全なリストについては、「変更履歴」をご参照ください。