移動

• リクエスト
• レスポンス

エージェント接続の検証

post

http://{host}:{port}/veridata/v1/services/validate/connection

必要なロール: Administrator、SuperUser、DetailMonitoringOperator、MonitoringOperator、CommandLineOperator

エージェント接続を検証します。

リクエスト

この操作にはリクエスト・パラメータはありません。

サポートされるメディア・タイプ

• application/json

リクエスト本文 - application/json ()

ルート・スキーマ: schema

タイプ: object

ソースの表示

• dbType: string
  指定できる値: [ "ORACLE", "TANDEMNSK", "SQLSERVER", "SYBASE", "DB2", "TERADATA", "INFORMIX", "HIVE", "MYSQL", "POSTGRESQL" ]

  データベース・タイプ。
• host(必須): string
  エージェントのホスト。
• port(必須): integer
  エージェントのポート。
• ssl: boolean
  デフォルト値: false

  サーバー-エージェント通信にSecure Socket Layer (SSL)を使用します。

{
    "type":"object",
    "properties":{
        "host":{
            "type":"string",
            "description":"Agent host."
        },
        "port":{
            "type":"integer",
            "description":"Agent port."
        },
        "ssl":{
            "type":"boolean",
            "description":"Use Secure Socket Layer (SSL) for Server-Agent communication.",
            "default":false
        },
        "dbType":{
            "$ref":"#/components/schemas/DatabaseType"
        }
    },
    "required":[
        "host",
        "port"
    ]
}

先頭に戻る

レスポンス

サポートされるメディア・タイプ

• application/json

200 レスポンス

エージェント接続が有効です。

本文()

ルート・スキーマ: schema

タイプ: object

ソースの表示

• dbType: string
  指定できる値: [ "ORACLE", "TANDEMNSK", "SQLSERVER", "SYBASE", "DB2", "TERADATA", "INFORMIX", "HIVE", "MYSQL", "POSTGRESQL" ]

  データベース・タイプ。
• host(必須): string
  エージェントのホスト。
• port(必須): integer
  エージェントのポート。
• ssl: boolean
  デフォルト値: false

  サーバー-エージェント通信にSecure Socket Layer (SSL)を使用します。

{
    "type":"object",
    "properties":{
        "host":{
            "type":"string",
            "description":"Agent host."
        },
        "port":{
            "type":"integer",
            "description":"Agent port."
        },
        "ssl":{
            "type":"boolean",
            "description":"Use Secure Socket Layer (SSL) for Server-Agent communication.",
            "default":false
        },
        "dbType":{
            "$ref":"#/components/schemas/DatabaseType"
        }
    },
    "required":[
        "host",
        "port"
    ]
}

400 レスポンス

不正なリクエスト。

本文()

ルート・スキーマ: Error

タイプ: object

ソースの表示

• errCode: string
  Veridataのエラー・コード。
• errMsg: string
  Veridataのエラー・メッセージ。

{
    "type":"object",
    "properties":{
        "errCode":{
            "type":"string",
            "description":"Veridata Error Code."
        },
        "errMsg":{
            "type":"string",
            "description":"Veridata Error Message."
        }
    }
}

401 レスポンス

権限がありません。

本文()

ルート・スキーマ: Error

タイプ: object

ソースの表示

• errCode: string
  Veridataのエラー・コード。
• errMsg: string
  Veridataのエラー・メッセージ。

{
    "type":"object",
    "properties":{
        "errCode":{
            "type":"string",
            "description":"Veridata Error Code."
        },
        "errMsg":{
            "type":"string",
            "description":"Veridata Error Message."
        }
    }
}

404 レスポンス

見つかりません。

本文()

ルート・スキーマ: Error

タイプ: object

ソースの表示

• errCode: string
  Veridataのエラー・コード。
• errMsg: string
  Veridataのエラー・メッセージ。

{
    "type":"object",
    "properties":{
        "errCode":{
            "type":"string",
            "description":"Veridata Error Code."
        },
        "errMsg":{
            "type":"string",
            "description":"Veridata Error Message."
        }
    }
}

500 レスポンス

サーバー・エラー。

本文()

ルート・スキーマ: Error

タイプ: object

ソースの表示

• errCode: string
  Veridataのエラー・コード。
• errMsg: string
  Veridataのエラー・メッセージ。

{
    "type":"object",
    "properties":{
        "errCode":{
            "type":"string",
            "description":"Veridata Error Code."
        },
        "errMsg":{
            "type":"string",
            "description":"Veridata Error Message."
        }
    }
}

先頭に戻る