エージェント接続の作成
post
http://{host}:{port}/veridata/v1/services/configuration/connections
必要なロール: Administrator、SuperUser、CommandLineOperator
エージェント接続を作成します。
リクエスト
この操作にはリクエスト・パラメータはありません。
サポートされるメディア・タイプ
- application/json
ルート・スキーマ: schema
タイプ:
ソースの表示 object- dbType(必須): string 指定できる値:
[ "ORACLE", "TANDEMNSK", "SQLSERVER", "SYBASE", "DB2", "TERADATA", "INFORMIX", "HIVE", "MYSQL", "POSTGRESQL" ]データベース・タイプ。 - description: string 接続の説明。
- host(必須): string Veridataエージェントのホスト。
- name(必須): string 接続名。
- password(必須): string (password) 暗号化されたデータベース接続パスワード。
- port(必須): integer (int32) Veridataエージェントのポート。
- repairPassword: string (password) 修復アクセス権を持つ暗号化されたDBパスワード。
- repairUsername: string 修復アクセス権を持つDBユーザー。
- ssl: boolean デフォルト値:
falseサーバーへのSSL対応のエージェント接続。 - username(必須): string データベース接続のユーザー名。
例:
{ "name":"Oracle-Connection-Source", "description":"Connection to source Oracle database", "host":"100.00.00.00", "port":"7850", "dbType":"ORACLE", "ssl":"false", "username":"User", "password":"Abc@123" }レスポンス
サポートされるメディア・タイプ
- application/json
201 レスポンス
エージェント接続が正常に作成されました。
ルート・スキーマ: 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 }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" }