接続情報作成
- Print
- PDF
接続情報作成
- Print
- PDF
Article summary
Did you find this summary helpful?
Thank you for your feedback
Post
/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
Body parameters
object
Example{ "name": "サンプル", "description": "desc", "resource_group_id": 1 }
name
string Required
接続情報名
Exampleサンプル
description
string
接続情報の説明
Exampledesc
resource_group_id
integer (int64)
リソースグループID
Example1
service_account_json_key
string
BigQuery, GCS, Google Spreadsheetsの場合: サービスアカウント認証を使用する場合はサービスアカウントJSONキーを指定します。
project_id
string
BigQuery, GCSの場合: プロジェクトID
host
string
Snowflake, MySQL, PostgreSQLの場合: ホスト名
Example********.********.********.snowflakecomputing.com
auth_method
string
Snowflakeの場合: 認証方法
Valid values[ "user_password", "key_pair" ]
Default"user_password"
Examplekey_pair
user_name
string
Snowflake, MySQL, PostgreSQLの場合: ユーザー名
Exampletest
private_key
string
Snowflakeの場合: キーペア認証を使用する場合は秘密鍵を指定します。
password
string
Snowflake, MySQL, PostgreSQLの場合: ユーザー・パスワード認証を使用する場合はパスワードを指定します。
Example********
role
string
Snowflakeの場合: クエリの実行に使用するロール。未入力の場合、Snowflakeのデフォルトの設定が利用されます。
application_name
string
GCSの場合: APIリクエスト時のUserAgentとして利用されます。転送先Google Cloud Storageでのみ使用されます
Default"trocco"
port
integer
MySQL, PostgreSQLの場合: 接続先ポート
ssl
boolean
MySQL, PostgreSQLの場合: SSL
ExampleTrue
ssl_ca
string
MySQL, PostgreSQLの場合: CA証明書
ssl_cert
string
MySQLの場合: 証明書 (CRTファイル)
ssl_key
string
MySQLの場合: 鍵 (KEYファイル)
ssl_client_ca
string
PostgreSQLの場合: クライアント証明書
ssl_client_key
string
PostgreSQLの場合: クライアント秘密鍵
ssl_mode
string
PostgreSQLの場合: SSLモード
Valid values[ "require", "verify-ca" ]
driver
string
PostgreSQLの場合: JDBCドライバのバージョン
Valid values[ "postgresql_42_5_1", "postgresql_9_4_1205_jdbc41" ]
gateway_enabled
boolean
MySQL, PostgreSQLの場合: SSHトンネルを使用する場合はtrueを指定します。
gateway_host
string
MySQL, PostgreSQLの場合: SSHホスト
gateway_port
integer
MySQL, PostgreSQLの場合: SSHポート
gateway_user_name
string
MySQL, PostgreSQLの場合: SSHユーザー
gateway_password
string
MySQL, PostgreSQLの場合: SSHパスワード
gateway_key
string
MySQL, PostgreSQLの場合: SSH秘密鍵
gateway_key_passphrase
string
MySQL, PostgreSQLの場合: SSH秘密鍵のパスフレーズ
aws_auth_type
string
S3の場合: AWS認証方式
Valid values[ "iam_user", "assume_role" ]
Default"iam_user"
aws_access_key_id
string
S3の場合: アクセスキーID
aws_secret_access_key
string
S3の場合: シークレットアクセスキー
aws_assume_role_account_id
integer
S3の場合: AssumeRoleのAWSアカウントID
aws_assume_role_name
string
S3の場合: AssumeRoleのIAMロール名
Responses
201
指定した接続情報の詳細を返します。
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
400
不正なリクエストです。
401
API KEYが不正です。
404
指定した接続情報種別が存在しません。
Was this article helpful?