移動

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

接続の取得

get

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

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

接続の詳細を返します。

リクエスト

パス・パラメータ

• Id(必須): integer(int64)
  接続ID。

この操作にはリクエスト本文はありません。

先頭に戻る

レスポンス

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

• application/json

200 レスポンス

エージェント接続が正常に返されました。

本文()

ルート・スキーマ: Connection

タイプ: object

ソースの表示

• agentId: integer
  接続に関連付けられている管理対象エージェントIDを指定します。
• agentVersions: object AgentVersions
• availableTimezones: object availableTimezones
  タイムゾーンのリスト。
• dbType: string
  指定できる値: [ "NOTSPECIFIED", "ORACLE", "TANDEMNSK", "SQLSERVER", "SYBASE", "DB2", "TERADATA", "INFORMIX", "HIVE", "MYSQL", "POSTGRESQL", "MARIADB", "SINGLESTORE", "DATABRICKS", "SNOWFLAKE", "MONGODB", "JCT", "AJD", "COSMOS", "ATLAS", "docDB" ]

  データベース・タイプ。
• managed: boolean
  接続を管理対象エージェントに関連付けるかどうかを指定します。
• properties: array properties
• repairUsername: string
  修復アクセス権を持つDBユーザー。
• settings: array settings
• username: string
  データベース接続のユーザー名。

{
    "type":"object",
    "allOf":[
        {
            "$ref":"#/components/schemas/BaseConnection"
        }
    ],
    "example":{
        "createdOn":"2025-04-02T11:20:51.270Z",
        "description":"Connection to source Oracle Database",
        "host":"100.00.00.00",
        "id":1090,
        "name":"Oracle-Connection-Source",
        "port":7800,
        "availableTimezones":{
            "DEFAULT TIMEZONE":"DEFAULT",
            "(UTC-11:00) Midway - Samoa Time (ST)":"Pacific/Midway"
        },
        "dbType":"oracle",
        "managed":true,
        "agentId":1004,
        "agentVersions":{
            "agentVersion":"23.26.1.0.0",
            "protocolVersion":3
        },
        "properties":[
            {
                "datatype":"ARRAY",
                "datatypeNumber":2004,
                "defaultFormat":{
                    "defaultFormatType":"ggComparisonFormatBlob",
                    "formatName":"blob"
                },
                "searchable":true,
                "useDefault":true
            }
        ],
        "settings":[
            {
                "default":true,
                "defaultValue":true,
                "name":"useSourceTargetAsKeys",
                "type":"BOOLEAN",
                "value":true
            },
            {
                "default":true,
                "min":0,
                "max":100000,
                "defaultValue":3600,
                "name":"agentTimeout",
                "type":"INTEGER",
                "value":3600
            },
            {
                "default":true,
                "min":0,
                "max":100000,
                "defaultValue":1000,
                "name":"fetchSize",
                "type":"INTEGER",
                "value":1000
            }
        ],
        "updatedOn":"2025-04-02T11:20:51Z",
        "username":"User"
    },
    "properties":{
        "dbType":{
            "$ref":"#/components/schemas/DatabaseType"
        },
        "managed":{
            "type":"boolean",
            "nullable":true,
            "description":"Specifies whether the connection is associated with managed Agent."
        },
        "agentId":{
            "type":"integer",
            "nullable":true,
            "description":"Specifies the managed Agent id associated with connection."
        },
        "agentVersions":{
            "type":"object",
            "nullable":true,
            "description":"Specifies the version details for managed Agent associated with connection.",
            "$ref":"#/components/schemas/AgentVersions"
        },
        "username":{
            "type":"string",
            "description":"Database connection username."
        },
        "repairUsername":{
            "type":"string",
            "description":"DB user having repair access."
        },
        "properties":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/ConnectionProperty"
            }
        },
        "settings":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/RetrieveConnectionSettings"
            }
        },
        "availableTimezones":{
            "type":"object",
            "description":"List of timezones."
        }
    }
}

すべて一致

ソースの表示

• object BaseConnection

{
    "type":"object",
    "allOf":[
        {
            "$ref":"#/components/schemas/BaseConnection"
        }
    ],
    "example":{
        "createdOn":"2025-04-02T11:20:51.270Z",
        "description":"Connection to source Oracle Database",
        "host":"100.00.00.00",
        "id":1090,
        "name":"Oracle-Connection-Source",
        "port":7800,
        "availableTimezones":{
            "DEFAULT TIMEZONE":"DEFAULT",
            "(UTC-11:00) Midway - Samoa Time (ST)":"Pacific/Midway"
        },
        "dbType":"oracle",
        "managed":true,
        "agentId":1004,
        "agentVersions":{
            "agentVersion":"23.26.1.0.0",
            "protocolVersion":3
        },
        "properties":[
            {
                "datatype":"ARRAY",
                "datatypeNumber":2004,
                "defaultFormat":{
                    "defaultFormatType":"ggComparisonFormatBlob",
                    "formatName":"blob"
                },
                "searchable":true,
                "useDefault":true
            }
        ],
        "settings":[
            {
                "default":true,
                "defaultValue":true,
                "name":"useSourceTargetAsKeys",
                "type":"BOOLEAN",
                "value":true
            },
            {
                "default":true,
                "min":0,
                "max":100000,
                "defaultValue":3600,
                "name":"agentTimeout",
                "type":"INTEGER",
                "value":3600
            },
            {
                "default":true,
                "min":0,
                "max":100000,
                "defaultValue":1000,
                "name":"fetchSize",
                "type":"INTEGER",
                "value":1000
            }
        ],
        "updatedOn":"2025-04-02T11:20:51Z",
        "username":"User"
    },
    "properties":{
        "dbType":{
            "$ref":"#/components/schemas/DatabaseType"
        },
        "managed":{
            "type":"boolean",
            "nullable":true,
            "description":"Specifies whether the connection is associated with managed Agent."
        },
        "agentId":{
            "type":"integer",
            "nullable":true,
            "description":"Specifies the managed Agent id associated with connection."
        },
        "agentVersions":{
            "type":"object",
            "nullable":true,
            "description":"Specifies the version details for managed Agent associated with connection.",
            "$ref":"#/components/schemas/AgentVersions"
        },
        "username":{
            "type":"string",
            "description":"Database connection username."
        },
        "repairUsername":{
            "type":"string",
            "description":"DB user having repair access."
        },
        "properties":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/ConnectionProperty"
            }
        },
        "settings":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/RetrieveConnectionSettings"
            }
        },
        "availableTimezones":{
            "type":"object",
            "description":"List of timezones."
        }
    }
}

例:

{
    "createdOn":"2025-04-02T11:20:51.270Z",
    "description":"Connection to source Oracle Database",
    "host":"100.00.00.00",
    "id":1090,
    "name":"Oracle-Connection-Source",
    "port":7800,
    "availableTimezones":{
        "DEFAULT TIMEZONE":"DEFAULT",
        "(UTC-11:00) Midway - Samoa Time (ST)":"Pacific/Midway"
    },
    "dbType":"oracle",
    "managed":true,
    "agentId":1004,
    "agentVersions":{
        "agentVersion":"23.26.1.0.0",
        "protocolVersion":3
    },
    "properties":[
        {
            "datatype":"ARRAY",
            "datatypeNumber":2004,
            "defaultFormat":{
                "defaultFormatType":"ggComparisonFormatBlob",
                "formatName":"blob"
            },
            "searchable":true,
            "useDefault":true
        }
    ],
    "settings":[
        {
            "default":true,
            "defaultValue":true,
            "name":"useSourceTargetAsKeys",
            "type":"BOOLEAN",
            "value":true
        },
        {
            "default":true,
            "min":0,
            "max":100000,
            "defaultValue":3600,
            "name":"agentTimeout",
            "type":"INTEGER",
            "value":3600
        },
        {
            "default":true,
            "min":0,
            "max":100000,
            "defaultValue":1000,
            "name":"fetchSize",
            "type":"INTEGER",
            "value":1000
        }
    ],
    "updatedOn":"2025-04-02T11:20:51Z",
    "username":"User"
}

ネストされたスキーマ: AgentVersions

タイプ: object

ソースの表示

• protocolVersion: string
• version: string

{
    "type":"object",
    "properties":{
        "version":{
            "type":"string"
        },
        "protocolVersion":{
            "type":"string"
        }
    },
    "example":{
        "agentVersion":"23.26.1.0.0",
        "protocolVersion":"3"
    }
}

例:

{
    "agentVersion":"23.26.1.0.0",
    "protocolVersion":"3"
}

ネストされたスキーマ: availableTimezones

タイプ: object

タイムゾーンのリスト。

ネストされたスキーマ: properties

タイプ: array

ソースの表示

• 配列: object ConnectionProperty

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/ConnectionProperty"
    }
}

ネストされたスキーマ: settings

タイプ: array

ソースの表示

• 配列: object RetrieveConnectionSettings

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/RetrieveConnectionSettings"
    }
}

ネストされたスキーマ: 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"
        }
    },
    "example":{
        "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
    }
}

例:

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

ネストされたスキーマ: ConnectionProperty

タイプ: object

ソースの表示

• compareFormat: string
  指定できる値: [ "string", "string_en", "binary", "timestamp", "timestamp_tz", "date", "time", "datetime", "smalldatetime", "clob", "blob", "Float", "dec_float", "interval", "number", "binary_timestamp", "string_nfc", "clob_nfc", "sybtime", "bit", "Double" ]

  比較形式。
• dataType: string
• isDefault: boolean
  デフォルト値: true

  デフォルト・プロパティを使用するかどうかを定義します。
• precision: integer (int32)
• scale: integer (int32)
• timezone: string

{
    "type":"object",
    "properties":{
        "dataType":{
            "type":"string"
        },
        "compareFormat":{
            "$ref":"#/components/schemas/CompareFormat"
        },
        "precision":{
            "type":"integer",
            "format":"int32"
        },
        "scale":{
            "type":"integer",
            "format":"int32"
        },
        "timezone":{
            "type":"string"
        },
        "isDefault":{
            "type":"boolean",
            "description":"Defines if default property is used or not.",
            "default":true
        }
    }
}

ネストされたスキーマ: RetrieveConnectionSettings

タイプ: object

ソースの表示

• default: boolean
• defaultValue: object defaultValue
• max: integer
• min: integer
• name: string
• type: string
  指定できる値: [ "BOOLEAN", "ENUM", "INTEGER", "STRING" ]
• value: object value

{
    "type":"object",
    "properties":{
        "name":{
            "type":"string"
        },
        "default":{
            "type":"boolean"
        },
        "defaultValue":{
            "type":"object"
        },
        "value":{
            "type":"object"
        },
        "type":{
            "type":"string",
            "enum":[
                "BOOLEAN",
                "ENUM",
                "INTEGER",
                "STRING"
            ]
        },
        "min":{
            "type":"integer"
        },
        "max":{
            "type":"integer"
        }
    },
    "example":[
        {
            "default":true,
            "defaultValue":true,
            "name":"useSourceTargetAsKeys",
            "type":"BOOLEAN",
            "value":"true"
        },
        {
            "default":true,
            "defaultValue":true,
            "name":"useAllColsAsKeys",
            "type":"BOOLEAN",
            "value":"true"
        },
        {
            "default":true,
            "defaultValue":1000,
            "name":"fetchSize",
            "type":"INTEGER",
            "value":"1000"
        },
        {
            "default":true,
            "min":0,
            "max":10000000,
            "defaultValue":3600,
            "name":"agentTimeout",
            "type":"INTEGER",
            "value":"3600"
        }
    ]
}

例:

[
    {
        "default":true,
        "defaultValue":true,
        "name":"useSourceTargetAsKeys",
        "type":"BOOLEAN",
        "value":"true"
    },
    {
        "default":true,
        "defaultValue":true,
        "name":"useAllColsAsKeys",
        "type":"BOOLEAN",
        "value":"true"
    },
    {
        "default":true,
        "defaultValue":1000,
        "name":"fetchSize",
        "type":"INTEGER",
        "value":"1000"
    },
    {
        "default":true,
        "min":0,
        "max":10000000,
        "defaultValue":3600,
        "name":"agentTimeout",
        "type":"INTEGER",
        "value":"3600"
    }
]

ネストされたスキーマ: defaultValue

タイプ: object

ネストされたスキーマ: value

タイプ: object

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

先頭に戻る