エージェント接続の取得
get
http://{host}:{port}/veridata/v1/services/configuration/connections
必要なロール: Administrator、SuperUser、DetailMonitoringOperator、MonitoringOperator、CommandLineOperator
エージェント接続のリストを返します。
リクエスト
問合せパラメータ
- dbType: データベース・タイプ。
- description: string 接続の説明。
- name: string 接続の名前。
- properties: boolean trueに設定すると、接続プロパティがフェッチされます。デフォルト値:
false
- settings: boolean trueに設定すると、接続設定がフェッチされます。デフォルト値:
false
- ssl: string SSL対応の接続。デフォルト値:
all
指定できる値:[ "true", "false", "all" ]
この操作にはリクエスト本文はありません。
先頭に戻るレスポンス
サポートされるメディア・タイプ
- application/json
200 レスポンス
接続が正常に取得されました。
ネストされたスキーマ: 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" }