移動

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

エージェント・データベースの検証

post

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

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

エージェント・データベース接続を検証します。

リクエスト

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

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

• application/json

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

ルート・スキーマ: schema

タイプ: object

ソースの表示

• host(必須): string
  Veridataエージェントのホスト。
• password(必須): string (password)
  暗号化されたデータベース接続パスワード。
• port(必須): integer
  Veridataエージェントのポート。
• ssl: boolean
  デフォルト値: false

  サーバー-エージェント通信にSecure Socket Layer (SSL)を使用します。
• username(必須): string
  データベース接続のユーザー名。

{
    "type":"object",
    "properties":{
        "host":{
            "type":"string",
            "description":"Veridata Agent Host."
        },
        "port":{
            "type":"integer",
            "description":"Veridata Agent Port."
        },
        "username":{
            "type":"string",
            "description":"Database Connection Username."
        },
        "password":{
            "type":"string",
            "description":"Encrypted Database connection password.",
            "format":"password"
        },
        "ssl":{
            "type":"boolean",
            "description":"Use Secure Socket Layer (SSL) for Server-Agent communication.",
            "default":false
        }
    },
    "required":[
        "host",
        "port",
        "username",
        "password"
    ],
    "example":{
        "host":"100.101.98.100",
        "port":8089,
        "username":"user1",
        "password":"Welcome@123",
        "ssl":false
    }
}

例:

{
    "host":"100.101.98.100",
    "port":8089,
    "username":"user1",
    "password":"Welcome@123",
    "ssl":false
}

先頭に戻る

レスポンス

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

• application/json
• */*

200 レスポンス

データベース接続に成功しました。

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."
        }
    },
    "example":{
        "errCode":"OGGV-00001",
        "errMsg":"Error message"
    }
}

例:

{
    "errCode":"OGGV-00001",
    "errMsg":"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."
        }
    },
    "example":{
        "errCode":"OGGV-00001",
        "errMsg":"Error message"
    }
}

例:

{
    "errCode":"OGGV-00001",
    "errMsg":"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."
        }
    },
    "example":{
        "errCode":"OGGV-00001",
        "errMsg":"Error message"
    }
}

例:

{
    "errCode":"OGGV-00001",
    "errMsg":"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."
        }
    },
    "example":{
        "errCode":"OGGV-00001",
        "errMsg":"Error message"
    }
}

例:

{
    "errCode":"OGGV-00001",
    "errMsg":"Error message"
}

先頭に戻る