接続文字列の取得

UIで接続文字列を取得する

IBM Cloud® Databases for PostgreSQL に接続するには、ユーザーと接続文字列が必要です。デプロイメント用の接続文字列は、「概要」ページの「 エンドポイント 」パネルに表示されます。

Databases for PostgreSQL デプロイメントは、管理者ユーザーを使用してプロビジョンされます。管理者パスワードを設定した後は、管理者ユーザーの接続文字列を使用してデプロイメントに接続できます。

CLI で接続文字列を取得する

CLI から接続文字列を取得します。

ibmcloud cdb deployment-connections example-deployment -u <NEW_USERNAME> [--endpoint-type <ENDPOINT_TYPE>]

ibmcloud cdb deployment-connections コマンドに --all フラグを設定すると、完全な接続情報が戻されます。「example-deployment」という名前のデプロイメントの接続情報すべてを取得するには、次のコマンドを使用します。

ibmcloud cdb deployment-connections example-deployment -u <NEW_USERNAME> --all [--endpoint-type <ENDPOINT_TYPE>]

ユーザーを指定しない場合、deployment-connections コマンドによって、デフォルトでは管理ユーザーの情報が戻ります。エンドポイント・タイプを指定しない場合、デフォルトでは接続ストリングによってパブリック・エンドポイントが戻ります。デプロイメントに含まれるのがプライベート・エンドポイントのみの場合、--endpoint-type private を指定する必要があります。指定しないと、コマンドによってエラーが返ります。ユーザーとエンドポイント・タイプは強制されません。デプロイメントの任意のエンドポイントで任意のユーザーを使用できます (どちらもデプロイメントに存在する場合)。

ibmcloud cdb CLI コマンドを使用するには、Cloud Databasesプラグインをインストールする必要があります。

APIでの接続文字列の取得

API からユーザーの接続ストリングを取得するには、/users/{userid}/connections エンドポイントを使用します。パスには、返される接続文字列で使用するユーザーおよびエンドポイントの種類（パブリックまたはプライベート）を指定する必要があります。ユーザーとエンドポイント・タイプは強制されません。デプロイメントの任意のエンドポイントで任意のユーザーを使用できます (どちらもデプロイメントに存在する場合)。

curl -X GET -H "Authorization: Bearer $APIKEY" 'https://api.{region}.databases.cloud.ibm.com/v4/ibm/deployments/{id}/users/{userid}/connections/{endpoint_type}'

接続文字列の構成要素

PostgreSQL セクション

「 "PostgreSQL" 」タブには、 PostgreSQL に接続するアプリケーションに適した情報が記載されています。

PostgreSQL/URI 接続情報
フィールド名	索引	説明
`Type`		接続の種類 - 「 PostgreSQL, 」の場合は「URI」です。
`Scheme`		URIの構成規則 - PostgreSQL, の場合、URIは「postgresql」となります。
`Path`		URI のパス - PostgreSQL の場合はデータベース名。デフォルトは `ibmclouddb` です。
`Authentication`	`Username`	接続に使用するユーザー名。
`Authentication`	`Password`	ユーザーのパスワード ― `$PASSWORD` のように表示される場合があります。
`Authentication`	`Method`	認証が行われる方法。「direct」認証はドライバーによって処理されます。
`Hosts`	`0...`	ホスト名と接続先ポート。
`Composed`	`0...`	Scheme、認証、ホスト、およびパスを組み合わせたURI。
`Certificate`	`Name`	データベースのデプロイ用に割り当てられた、サービス専用証明書の名称。
`Certificate`	Base64	base64 でエンコードされたバージョンの証明書

0... は、配列内のこれらの項目の 1 つ以上を示します。

CLI セクション

「CLI」セクションには、 psql との接続に適した情報が記載されています。

psql/cli接続情報
フィールド名	索引	説明
`Bin`		接続を確立するためのバイナリ。この場合は、 `psql` です。
`Composed`		デプロイメントへの接続を確立するための構成済みのコマンド。このコマンドは、`Bin` 実行可能プログラムと `Environment` 変数設定を組み合わせ、コマンド・ライン・パラメーターとして `Arguments` を使用します。
`Environment`		環境変数として設定したキー/値のリスト。
`Arguments`	0...	Bin フィールドに示されているコマンドに引数として渡される情報
`Certificate`	Base64	アプリケーションが適切なサーバーに接続していることを確認するために使用される、サービス固有の証明書。 base64 でエンコードされています。
`Certificate`	名前	サービス専用証明書に割り当てられた名前。
`Type`		この接続情報を使用するパッケージのタイプ。この場合は `cli` です。

0... は、1 つの配列にこれらのエントリーが 1 つ以上ある可能性があることを示しています。