MENU
    接続情報取得

      接続情報取得


      Article summary

      Get
      /api/connections/{connection_type}/{connection_id}

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

      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", "snowflake" ]
      Examplebigquery
      connection_id
      integer (int64) Required

      接続情報ID

      Example1
      Responses
      200

      指定した接続情報の詳細を返します。

      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の場合: 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の場合: OAuth認証情報ID

      Example1
      host
      string

      Snowflakeの場合: Snowflakeのホスト

      Example********.********.********.snowflakecomputing.com
      auth_method
      string

      Snowflakeの場合: 認証方法

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

      Snowflakeの場合: ユーザー名

      Exampletest
      role
      string | null

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

      ExampleTEST
      aws_privatelink_enabled
      boolean

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

      ExampleFalse
      driver
      string

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

      Example3.14.2
      401

      API KEYが不正です。

      404

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

      Authentication
      Token
      *
      URL
      Base URL
      https://trocco.io
      Parameters
      connection_type*
      connection_id*
      Response
      Click Try It! to start a request and see the response here!
      Code Samples

      Was this article helpful?

      Authentication
      Token
      *
      URL
      Base URL
      https://trocco.io
      Parameters
      connection_type*
      connection_id*
      Response
      Click Try It! to start a request and see the response here!
      Code Samples