Contents x
    接続情報一覧取得
      • Print
      • PDF
      Contents

      接続情報一覧取得

        • Print
        • PDF
        Article summary

        Get
        /api/connections/{connection_type}

        接続情報一覧を取得します。
        接続情報の詳細についてはヘルプを参照してください。

        Security
        API Key
        Header parameter nameAuthorization

        認証キーとなるAPI KEYをAuthorization: Token {{API KEY}}の形式でヘッダーにセットします。
        API KEYがabc123の場合は、Authorization: Token abc123とします。
        API KEYの作成方法は、trocco APIについてを参照ください。

        Path parameters
        connection_type
        stringRequired

        接続情報種別

        Valid values[ "bigquery", "gcs", "google_spreadsheets", "snowflake", "mysql", "s3", "postgresql" ]
        Examplebigquery
        Query parameters
        limit
        integer (int64)

        取得する接続情報一覧の最大件数

        Maximum200
        Default50
        Example10
        cursor
        string

        取得する接続情報一覧の最初のレコードを示すページネーションカーソル
        レスポンスに含まれるnext_cursorをセットすると、後続の接続情報一覧を取得できます。

        ExampleeyJpZCI6MjF9
        Responses
        200

        接続情報一覧を返します。

        Expand All
        object
        items
        Array of object
        object
        Example{ "id": 1, "name": "サンプル", "description": "desc", "resource_group_id": 1, "is_oauth": true, "has_service_account_json_key": false, "project_id": "0", "google_oauth2_credential_id": 0 }
        id
        integer (int64)

        接続情報ID

        Example1
        name
        string

        接続情報名

        Exampleサンプル
        description
        string

        接続情報の説明

        Exampledesc
        resource_group_id
        integer (int64) | null

        リソースグループID

        Example1
        is_oauth
        boolean

        BigQuery, Google SpreadSheets の場合: OAuth認証を使用しているかどうか

        ExampleTrue
        has_service_account_json_key
        boolean

        BigQueryの場合: サービスアカウントのJSONキーが登録されているかどうか

        ExampleFalse
        project_id
        string

        BigQueryの場合: プロジェクトID

        ExampleMyProject
        google_oauth2_credential_id
        integer (int64) | null

        BigQuery, Google SpreadSheets の場合: OAuth認証情報ID

        Example1
        host
        string

        Snowflake, PostgreSQLの場合: ホスト名

        Example********.********.********.snowflakecomputing.com
        port
        integer

        PostgreSQLの場合: ポート

        Example5432
        auth_method
        string

        Snowflakeの場合: 認証方法

        Valid values[ "user_password", "key_pair" ]
        Examplekey_pair
        user_name
        string

        Snowflake, PostgreSQLの場合: ユーザー名

        Exampletest
        role
        string | null

        Snowflakeの場合: クエリの実行に使用するロールを指定します。

        ExampleTEST
        aws_privatelink_enabled
        boolean

        Snowflakeの場合: AWS PrivateLinkを使用しているかどうか

        ExampleFalse
        driver
        string

        Snowflake, PostgreSQLの場合: JDBCドライバのバージョン

        Example3.14.2
        has_password
        boolean

        PostgreSQLの場合の場合: passwordを設定しているかどうか

        ExampleTrue
        ssl
        boolean

        PostgreSQLの場合の場合: SSL

        ExampleTrue
        ssl_mode
        string | null

        PostgreSQLの場合の場合: SSLモード

        Examplerequire
        gateway_enabled
        boolean

        PostgreSQLの場合の場合: SSHトンネルを使用する場合はtrueを指定します。

        ExampleTrue
        next_cursor
        string

        後続のページネーションリクエストの取得開始レコードを示すカーソル値です。

        401

        認証エラーです。API KEYをご確認ください。

        404

        指定した接続情報種別が存在しません。

        Was this article helpful?
        What's Next