17.00 - ジョブ定義の表示(RESTful API) - Teradata Data Mover

Teradata® Data Mover ユーザー ガイド

Product
Teradata Data Mover
Release Number
17.00
Published
2021年11月
Content Type
ユーザー ガイド
Publication ID
B035-4101-030K-JPN
Language
日本語 (日本)

目的

以下のURLとメソッドを使用して、ジョブの定義を表示します。
アイテム 説明
URL /datamover/jobs/job-name
メソッド GET

要求のパラメータ

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

応答のパラメータ

jobName
説明: ジョブ名
JSONデータ型: 文字列
uowid
説明: 作業単位ID
JSONデータ型: 文字列
sourceLogin
説明: ソース システムのプロパティ
JSONデータ型: オブジェクト(LoginType)
targetLogin
説明: ターゲット システムのプロパティ
JSONデータ型: オブジェクト(LoginType)
settings
説明: ジョブ構成プロパティ
JSONデータ型: オブジェクト(SettingsType)
objects
説明: コピーするオブジェクト
JSONデータ型: オブジェクト(DbObjectType)
ジョブの作成または編集時にjobSecurityの詳細が指定されても、jobSecurityの詳細はlist job definitionに表示されません。

応答の例(TeradataからTeradata UserPoolへ)

{
    "jobName": "tdToTdJob",
    "sourceLogin":
    {
        "teradata":
        {
            "tdpid": "sourceSystem",
            "username": "user",
            "password": "",
            "sessionCharset": "UTF8",
            "passwordEncrypted": "false"
        }
    },
    "targetLogin":
    {
        "userPool": "poolA"
    },
    "settings":
    {
        "priority": "MEDIUM",
        "overwriteExistingObjects": "true",
        "freezeJobSteps": "false",
        "targetDatabase": "targetDatabaseJobLevel",
        "compareDDL": "true",
        "logLevel": "99",
        "tdTdSettings":
        {
            "forceUtility": "DSA",
            "dataStreams": 5,
            "sourceSessions": 10,
            "targetSessions": 10,
            "onlineArchive": "false"
        }
    },
    "objects":
        {
            "database":
            [
                {
                    "name": "sourceDb",
                    "compareDDL": "false",
                    "journaling": "false",
                    "replaceDatabase": "false",
                    "selection": "unselected",
                    "table":
                    [
                        {
                            "name": "srcTableA",
                            "stagingDatabase": "stagingDBA",
                            "stagingDatabaseForTable": "stagingDBAB",
                            "targetDatabase": "targetDBA",
                            "targetName": "tgtTableA",
                            "validateRowCount": "ALL",
                            "compareDDL": "false",
                            "forceTargetStagingTable": "true",
                            "selection": "included",
                            "exportWithoutSpool": "false"
                        },
                        {
                            "name": "srcTableB",
                            "compareDDL": "true",
                            "selection": "included",
                            "exportWithoutSpool": "true",
                            "partialTableParameters":
                            {
                                "sqlWhereClause": "where columnA < 100",
                                "keyColumns":
                                [
                                    "columnA"
                                ]
                            },
                            "teradataParameters":
                            {
                                "copyStats": "false",
                                "allowTPTLoadMultiset": "true",
                                "journaling": "false",
                                "overrideLockAccess": "false"
                            }
                        }
                    ]
                }
            ],
            "trigger":
            [
                {
                    "database": "databaseA",
                    "subjectTableDatabase": "subjectDatabaseA",
                    "table": "tableA",
                    "name": "triggerA",
                    "actionTime":
                    {
                        "action": "AFTER",
                        "enabled": "NO"
                    },
                    "selection": "included"
                },
                {
                    "database": "databaseB",
                    "subjectTableDatabase": "subjectDatabaseB",
                    "table": "tableB",
                    "name": "triggerB",
                    "actionTime":
                    {
                        "action": "AFTER",
                        "enabled": "YES"
                    },
                    "selection": "included"
                }
            ],
            "view":
            [
                {
                    "name": "ViewA",
                    "database": "ViewDatabase",
                    "viewDataTable":
                    {
                        "targetTable": "tableA",
                        "targetDatabase": "dbA"
                    },
                    "compareDDL": "false",
                    "selection": "included",
                    "copyData": "false"
                },
                {
                    "name": "ViewB",
                    "database": "ViewDatabaseB",
                    "viewDataTable":
                    {
                        "targetTable": "tableA",
                        "targetDatabase": "dbA"
                    },
                    "compareDDL": "false",
                    "forceTargetStagingTable": "true",
                    "selection": "included",
                    "copyData": "false"
                }
            ],
            "foreignServer":
            [
                {
                    "name": "foreignServer1",
                    "selection": "included"
                },
                {
                    "name": "foreignServer2",
                    "selection": "included"
                }
            ],
            "functionAliases":
            [
                {    
                   "name": "faObj",
                   "database": "dmguest",
                   "selection": "included"
                },
                {
                   "name": "FAObjForForeignSer",
                   "database": "myDB",
                   "selection": "included"
                }
            ]
            "journal":
            [
                {
                    "name": "journal",
                    "database": "journalDB",
                    "selection": "included"
                }
            ],
            "macro":
            [
                {
                    "name": "macroA",
                    "database": "macroDB",
                    "selection": "included"
                },
                {
                    "name": "macroB",
                    "database": "macroDB",
                    "selection": "included"
                }
            ],
            "indices":
            [
                {
                    "name": "OrdersHI",
                    "indexDatabase": "indexDB",
                    "indexType": "hash_index",
                    "selection": "included"
                },
                {
                    "name": "sji",
                    "indexDatabase": "indexDB",
                    "indexType": "join_index",as
                    "copyStats": true,
                    "selection": "included"
                }
            ],
            "schema":
            [
                {
                    "name": "avroRecordSchema",
                    "compareDDL": true,
                    "selection": "included"
                }
            ],
            "storedProcedure":
            [
                {
                    "name": "storedProcedureA",
                    "database": "storedProcedureDB",
                    "selection": "included"
                },
                {
                    "name": "storedProcedureB",
                    "database": "storedProcedureDB",
                    "selection": "included"
                }
            ]
        }