保存配置 (RESTful API) - Teradata Data Mover

Teradata® Data Mover 用户指南
Product
Teradata Data Mover
Release Number
17.05
Published
2020 年 10 月
Language
中文 (简体)
Last Update
2020-12-18
dita:mapPath
zh-CN/xxl1591023586203.ditamap
dita:ditavalPath
zh-CN/xxl1591023586203.ditaval
dita:id
B035-4101
Product Category
Analytical Ecosystem

用途

save_configuration RESTful API 可更新配置设置、性能设置、守护程序的表格型界面以及存储过程的配置设置。

save_configuration RESTful API 有两种变体，可执行以下操作：
  • 更新指定的属性
  • 更新在请求正文中指定的所有属性
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. "
}
相关信息