移動

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

エージェント接続の作成

post

http://{host}:{port}/veridata/v1/services/configuration/connections

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

エージェント接続を作成します。

リクエスト

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

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

• application/json

リクエスト本文 - 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
  データベース接続のユーザー名。

{
    "type":"object",
    "properties":{
        "name":{
            "type":"string",
            "description":"Connection Name."
        },
        "description":{
            "type":"string",
            "description":"Connection Description."
        },
        "host":{
            "type":"string",
            "description":"Veridata Agent Host."
        },
        "port":{
            "type":"integer",
            "description":"Veridata Agent Port.",
            "format":"int32"
        },
        "dbType":{
            "$ref":"#/components/schemas/DatabaseType"
        },
        "ssl":{
            "type":"boolean",
            "description":"SSL enabled Agent connection to the Server.",
            "default":false
        },
        "username":{
            "type":"string",
            "description":"Database connection username."
        },
        "password":{
            "type":"string",
            "description":"Encrypted Database connection password.",
            "format":"password"
        },
        "repairUsername":{
            "type":"string",
            "description":"DB user having repair access."
        },
        "repairPassword":{
            "type":"string",
            "description":"Encrypted DB password having repair access.",
            "format":"password"
        }
    },
    "required":[
        "name",
        "host",
        "port",
        "dbType",
        "username",
        "password"
    ]
}

先頭に戻る

レスポンス

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

• 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

{
    "type":"object",
    "properties":{
        "id":{
            "type":"integer",
            "description":"Connection Id.",
            "format":"int64"
        },
        "name":{
            "type":"string",
            "description":"Connection Name."
        },
        "description":{
            "type":"string",
            "description":"Connection Description."
        },
        "host":{
            "type":"string",
            "description":"Veridata Agent Host."
        },
        "port":{
            "type":"integer",
            "description":"Veridata Agent Port.",
            "format":"int32"
        },
        "createdOn":{
            "type":"string",
            "format":"date-time",
            "pattern":"YYYY-MM-DDTHH:mm:ss.sssZ",
            "example":"2024-02-03T10:15:30Z"
        },
        "updatedOn":{
            "type":"string",
            "format":"date-time",
            "pattern":"YYYY-MM-DDTHH:mm:ss.sssZ",
            "example":"2024-02-03T10:15:30Z"
        }
    }
}

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."
        }
    }
}

先頭に戻る