16.20 - 構成の保存(RESTful API) - Teradata Data Mover

Teradata® Data Mover ユーザー ガイド

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

目的

save_configuration RESTful APIは、デーモンの構成設定、パフォーマンス設定、テーブル駆動型インターフェース、およびストアド プロシージャの構成設定を更新します。

save_configuration RESTful APIには、以下を実行する2つのバリエーションがあります。
  • 指定したプロパティを更新します
  • リクエストの本文で指定されたすべてのプロパティを更新します
save_configuration RESTful APIは以下のURLおよびメソッドを使用します。
アイテム 説明
URL

/datamover/daemonProperties/propertyName

/datamover/daemonProperties

メソッド PUT

リクエストのパラメータ(propertyName)

save_configuration RESTful APIのこのバリエーションでは、指定されたプロパティが更新されます。

propertyName
説明: 構成プロパティの名前
JSONデータ型: 文字列
必須: はい
values
説明: システムごとのプロパティ値
JSONデータ型: JSON配列(valueTypeオブジェクト)
必須: はい
unit
説明: 値の単位
JSONデータ型: 文字列
必須: いいえ
description
説明: 追加情報
JSONデータ型: 文字列
必須: はい
systemPairs
説明: ジョブの方向を強制するために使用されるシステムのペア
JSONデータ型: JSON配列(systemPairTypeオブジェクト)
必須: いいえ
groupPools
説明: ユーザー グループのプール
JSONデータ型: JSON配列(userGroupTypeオブジェクト)
必須: いいえ
targetUserPools
説明: ターゲット ユーザー プールのシステム
JSONデータ型: JSON配列(systemTypeオブジェクト)
必須: いいえ
neverTargetSystems
説明: ターゲット システムとして使用されないシステム
JSONデータ型: JSON配列(文字列)
必須: いいえ
defaultDatabases
説明: デフォルトのターゲット データベースまたはステージング データベースとしてシステム レベルで使用されるデータベース
JSONデータ型: JSON配列(systemLevelDatabaseTypeオブジェクト)
必須: いいえ

応答のパラメータ

messages
説明: プロパティ値が更新されたか同じままかを示すメッセージ。
JSONデータ型: JSON配列(文字列)
errors
説明: プロパティが保存されなかった場合のエラー メッセージ。
JSONデータ型: JSON配列(文字列)

応答の例(propertyName)

{
    "error":"The maximum value for property blocked.job.maxAllowedLimit cannot be greater that 25% of the maximum concurrent job limit. "
}

save_configuration RESTful APIの例(propertyName)

{
    "propertyName": "agentCollector.agentHeartbeatWaitMillis",
    "values":
    [
        {
            "value": "600000",
            "system": "ALL"
        }
    ],
    "description": "Purpose: To set the amount of time to wait for an Agent heartbeat before assuming it has gone out of service in milliseconds. Default: 600000"
}

リクエストのパラメータ(プロパティ)

save_configuration RESTful APIのこのバリエーションでは、リクエストの本文で指定されたすべてのプロパティが更新されます。

propertyName
説明: 構成プロパティの名前
JSONデータ型: 文字列
必須: はい
values
説明: システムごとのプロパティ値
JSONデータ型: JSON配列(valueTypeオブジェクト)
必須: はい
unit
説明: 値の単位
JSONデータ型: 文字列
必須: いいえ
description
説明: 追加情報
JSONデータ型: 文字列
必須: はい
systemPairs
説明: ジョブの方向を強制するために使用されるシステムのペア
JSONデータ型: JSON配列(systemPairTypeオブジェクト)
必須: いいえ
groupPools
説明: ユーザー グループのプール
JSONデータ型: JSON配列(userGroupTypeオブジェクト)
必須: いいえ
targetUserPools
説明: ターゲット ユーザー プールのシステム
JSONデータ型: JSON配列(systemTypeオブジェクト)
必須: いいえ
neverTargetSystems
説明: ターゲット システムとして使用されないシステム
JSONデータ型: JSON配列(文字列)
必須: いいえ
defaultDatabases
説明: デフォルトのターゲット データベースまたはステージング データベースとしてシステム レベルで使用されるデータベース
JSONデータ型: JSON配列(systemLevelDatabaseTypeオブジェクト)
必須: いいえ

save_configuration RESTful APIの例(プロパティ)

応答の例(プロパティ)

{
    "error":"The maximum value for property blocked.job.maxAllowedLimit cannot be greater that 25% of the maximum concurrent job limit. "
}