接続情報更新

Prev Next
Patch
/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
Body parameters
object
Example{ "name": "サンプル", "description": "desc", "resource_group_id": 1 }
name
string

接続情報名

Exampleサンプル
description
string

接続情報の説明

Exampledesc
resource_group_id
integer (int64)

リソースグループID

Example1
athena_url
string

Athenaの場合: AthenaのURL

s3_staging_directory
string

Athenaの場合: S3ステージングディレクトリ

aws_access_key_id
string

Athena, S3の場合: AWSアクセスキーID

aws_secret_access_key
string

Athena, S3の場合: AWSシークレットアクセスキー

service_account_json_key
string

BigQuery, GCS, Google Spreadsheets、GoogleAnalytics4の場合: サービスアカウント認証を使用する場合はサービスアカウント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, Kintoneの場合: ユーザー・パスワード認証を使用する場合はパスワードを指定します。

Example********
role
string

Snowflakeの場合: クエリの実行に使用するロール。未入力の場合、Snowflakeのデフォルトの設定が利用されます。

application_name
string

GCSの場合: APIリクエスト時のUserAgentとして利用されます。転送先Google Cloud Storageでのみ使用されます

Default"trocco"
service_account_email
string

GCSの場合: サービスアカウント認証を使用する場合はサービスアカウントのメールアドレスを指定します。サービスアカウントEmailの取得方法はドキュメントをご参照ください。

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" ]
aws_assume_role_account_id
integer

S3の場合: AssumeRoleのAWSアカウントID

aws_assume_role_name
string

S3の場合: AssumeRoleのIAMロール名

auth_end_point
string

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

Default"https://login.salesforce.com/services/Soap/u/"
security_token
string

Salesforceの場合: セキュリティトークン

domain
string

Kintoneの場合: ドメイン

username
string

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

token
string

Kintoneの場合: トークン

basic_auth_username
string

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

basic_auth_password
string

Kintoneの場合: ベーシック認証パスワード

login_method
string

Kintoneの場合: ログイン方法

Valid values[ "token", "username_and_password" ]
Default"username_and_password"
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テストベーシック認証ユーザー
400

不正なリクエストです。

401

API KEYが不正です。

404

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