エージェント接続の更新
patch
http://{host}:{port}/veridata/v1/services/configuration/connections/{Id}
必要なロール: Administrator、SuperUser、CommandLineOperator
エージェント接続を更新します。
リクエスト
パス・パラメータ
- Id(必須): integer(int64) 更新する接続のID。
サポートされるメディア・タイプ
- application/json
ルート・スキーマ: schema
タイプ:
ソースの表示 object- description: string 接続の説明。
- host: string Veridataエージェントのホスト。
- password: string (password) 暗号化されたデータベース接続パスワード。
- port: integer (int32) Veridataエージェントのポート。
- properties: array properties
- repairPassword: string (password) 修復アクセス権を持つ暗号化されたDBパスワード。
- repairUsername: string 修復アクセス権を持つDBユーザー。
- settings: object ConnectionSettings
- ssl: boolean デフォルト値:
falseサーバーへのSSL対応のエージェント接続。 - username: string データベース接続のユーザー名。
例:
{ "description":"Updated description", "host":"100.00.00.01", "port":7851, "ssl":false, "username":"User1", "password":"Abc@1234", "repairUsername":"User1", "repairPassword":"Abc@1234", "properties":[ { "datatype":"string", "compareFormat":{ "formatName":"blob", "precision":0, "scale":0, "timezone":"string" } } ], "settings":{ "agentTimeout":3000, "trimTrailingSpaces":true, "fetchSize":5000, "ssl":false, "useSourceTargetAsKeys":true, "useAllColsAsKeys":true } }ネストされたスキーマ: ConnectionSettings
タイプ:
ソースの表示 object- agentTimeout: integer (int32) デフォルト値:
3600エージェント・メッセージ・タイムアウト(秒)。 - fetchSize: integer (int32) デフォルト値:
1000初回比較フェッチ・バッチ・サイズ。 - ssl: boolean デフォルト値:
falseサーバー-エージェント通信にSecure Socket Layer (SSL)を使用します。 - trimTrailingSpaces: boolean デフォルト値:
true値の比較時に末尾のスペースを切り捨てます。 - useAllColsAsKeys: boolean デフォルト値:
true比較ペアの生成時にすべての列をキー列として使用します。 - useSourceTargetAsKeys: boolean デフォルト値:
true比較の生成時に、ソース列またはターゲット列をキー列として使用します。ペア
ネストされたスキーマ: UpdateCompareFormat
タイプ:
ソースの表示 object- formatName: string 指定できる値:
[ "string", "string_en", "binary", "timestamp", "timestamp_tz", "date", "time", "datetime", "smalldatetime", "clob", "blob", "Float", "dec_float", "interval", "number", "binary_timestamp", "string_nfc", "clob_nfc", "sybtime", "bit", "Double" ]比較形式。 - precision: integer (int32)
- scale: integer (int32)
- timezone: string
レスポンス
サポートされるメディア・タイプ
- application/json
200 レスポンス
接続が更新されました。
ルート・スキーマ: Connection
タイプ:
ソースの表示 object- availableTimezones: object availableTimezones タイムゾーンのリスト。
- dbType: string 指定できる値:
[ "ORACLE", "TANDEMNSK", "SQLSERVER", "SYBASE", "DB2", "TERADATA", "INFORMIX", "HIVE", "MYSQL", "POSTGRESQL" ]データベース・タイプ。 - properties: array properties
- repairUsername: string 修復アクセス権を持つDBユーザー。
- settings: object ConnectionSettings
- username: string データベース接続のユーザー名。
すべて一致
ソースの表示 例:
{ "createdOn":"2025-04-02T11:20:51.270Z", "description":"Connection to source Oracle database", "host":"100.00.00.00", "id":1090, "name":"Oracle-Connection-Source", "port":7800, "availableTimezones":{ "DEFAULT TIMEZONE":"DEFAULT", "(UTC-11:00) Midway - Samoa Time (ST)":"Pacific/Midway" }, "dbType":"oracle", "properties":[ { "datatype":"ARRAY", "datatypeNumber":2004, "defaultFormat":{ "defaultFormatType":"ggComparisonFormatBlob", "formatName":"blob" }, "searchable":true, "useDefault":true } ], "settings":{ "useSourceTargetAsKeys":"true", "useAllColsAsKeys":"true" }, "updatedOn":"2025-04-02T11:20:51Z", "username":"User" }ネストされたスキーマ: availableTimezones
タイプ:
objectタイムゾーンのリスト。
ネストされたスキーマ: ConnectionSettings
タイプ:
ソースの表示 object- agentTimeout: integer (int32) デフォルト値:
3600エージェント・メッセージ・タイムアウト(秒)。 - fetchSize: integer (int32) デフォルト値:
1000初回比較フェッチ・バッチ・サイズ。 - ssl: boolean デフォルト値:
falseサーバー-エージェント通信にSecure Socket Layer (SSL)を使用します。 - trimTrailingSpaces: boolean デフォルト値:
true値の比較時に末尾のスペースを切り捨てます。 - useAllColsAsKeys: boolean デフォルト値:
true比較ペアの生成時にすべての列をキー列として使用します。 - useSourceTargetAsKeys: boolean デフォルト値:
true比較の生成時に、ソース列またはターゲット列をキー列として使用します。ペア
ネストされたスキーマ: BaseConnection
タイプ:
ソースの表示 object- createdOn: string (date-time) パターン:
YYYY-MM-DDTHH:mm:ss.sssZ例:2024-02-03T10:15:30Z - description: string 接続の説明。
- host: string Veridataエージェントのホスト。
- id: integer (int64) 接続ID。
- name: string 接続名。
- port: integer (int32) Veridataエージェントのポート。
- updatedOn: string (date-time) パターン:
YYYY-MM-DDTHH:mm:ss.sssZ例:2024-02-03T10:15:30Z
例:
{ "createdOn":"2025-04-02T11:20:51.269Z", "description":"Connection to source Oracle database", "host":"100.00.00.00", "id":1090, "name":"Oracle-Connection-Source", "port":7800 }ネストされたスキーマ: ConnectionProperty
タイプ:
ソースの表示 object- compareFormat: string 指定できる値:
[ "string", "string_en", "binary", "timestamp", "timestamp_tz", "date", "time", "datetime", "smalldatetime", "clob", "blob", "Float", "dec_float", "interval", "number", "binary_timestamp", "string_nfc", "clob_nfc", "sybtime", "bit", "Double" ]比較形式。 - dataType: string
- isDefault: boolean デフォルト値:
trueデフォルト・プロパティを使用するかどうかを定義します。 - precision: integer (int32)
- scale: integer (int32)
- timezone: string
400 レスポンス
不正なリクエスト。
ルート・スキーマ: Error
タイプ:
ソースの表示 object- errCode: string Veridataのエラー・コード。
- errMsg: string Veridataのエラー・メッセージ。
例:
{ "errCode":"OGGV-00001", "errMsg":"Error message" }401 レスポンス
権限がありません。
ルート・スキーマ: Error
タイプ:
ソースの表示 object- errCode: string Veridataのエラー・コード。
- errMsg: string Veridataのエラー・メッセージ。
例:
{ "errCode":"OGGV-00001", "errMsg":"Error message" }404 レスポンス
見つかりません。
ルート・スキーマ: Error
タイプ:
ソースの表示 object- errCode: string Veridataのエラー・コード。
- errMsg: string Veridataのエラー・メッセージ。
例:
{ "errCode":"OGGV-00001", "errMsg":"Error message" }500 レスポンス
サーバー・エラー。
ルート・スキーマ: Error
タイプ:
ソースの表示 object- errCode: string Veridataのエラー・コード。
- errMsg: string Veridataのエラー・メッセージ。
例:
{ "errCode":"OGGV-00001", "errMsg":"Error message" }