接続情報取得

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

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

Security
API Key: ApiKeyAuth
Header parameter nameAuthorization

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

Path parameters
connection_type
stringRequired

接続情報種別

Valid values[ "athena", "bigquery", "gcs", "google_spreadsheets", "snowflake", "mysql", "s3", "salesforce", "postgresql", "google_analytics4", "kintone" ]
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, GoogleAnalytics4, Google SpreadSheets の場合: OAuth認証を使用しているかどうか

Exampletrue
has_service_account_json_key
boolean

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

Examplefalse
project_id
string

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

ExampleMyProject
google_oauth2_credential_id
integer (int64) | null

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

Example1
host
string

Snowflake, PostgreSQLの場合: ホスト名

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

PostgreSQLの場合: ポート

Example5432
auth_method
string

Salesforce, Snowflakeの場合: 認証方法

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

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

Exampletest
role
string | null

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

ExampleTEST
aws_privatelink_enabled
boolean

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

Examplefalse
driver
string | null

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

Example3.14.2
salesforce_oauth2_credential_id
integer (int64) | null

Salesforceの場合: OAuth認証情報ID

Example1
is_sandbox
boolean

Salesforceの場合: サンドボックス環境を使用しているかどうか

Examplefalse
has_security_token
boolean

Salesforceの場合: セキュリティトークンが登録されているかどうか

Examplefalse
auth_end_point
string

Salesforceの場合: 認証エンドポイント

Default"https://login.salesforce.com/services/Soap/u/"
Examplehttps://login.salesforce.com/services/Soap/u/
has_password
boolean

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

Exampletrue
ssl
boolean

PostgreSQLの場合の場合: SSL

Exampletrue
ssl_mode
string | null

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

Examplerequire
gateway_enabled
boolean

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

Exampletrue
domain
string

kintoneの場合の場合: ドメイン

Exampleexample.com
login_method
string

kintoneの場合の場合: ログイン方法

Valid values[ "username_and_password", "token" ]
Exampleusername_and_password
username
string | null

kintoneの場合の場合: ユーザーネーム

Exampleテストユーザー
basic_auth_username
string

kintoneの場合の場合: ベーシック認証ユーザーネーム

Exampleテストベーシック認証ユーザー
401

API KEYが不正です。

404

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