接続文字列の取得

第2世代

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

IBM Cloud® Databases for PostgreSQL インスタンスの接続文字列を取得するには、以下の手順に従ってください：

  1. デプロイメントの 「概要」ページで、画面を下にスクロールして「 サービスエンドポイント 」セクションまで移動します。
  2. 「 サービスエンドポイント 」セクションには、利用可能な接続方法ごとのタブが表示されます：
  • PostgreSQL – デプロイメントの接続文字列、ホスト名、ポート、データベース名、認証ソース、およびレプリカセットを表示します。
  • CLI – 「 IBM 」CLI を使用した接続方法の詳細を説明します。

アーキテクチャ
接続文字列の取得 - 「サービスエンドポイント」 PostgreSQL タブ

Databases for PostgreSQL デプロイには、デフォルトの admin user が含まれなくなりました。 その代わりに、 IBM Cloud® のサービス認証情報インターフェース（UIまたはCLI）を使用して、「Manager」、「Writer」、または「Reader」のロールを割り当てたユーザーを作成します。 これにより、デプロイメントへの接続に使用できるユーザー名（ibm_...）、パスワード、および接続文字列が提供されます。

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

また、このエンドポイントは、サービスエンドポイントの「CLI」タブにも表示されています。

アーキテクチャ
接続文字列の取得 - 「サービスエンドポイント」の「CLI」タブ

また、 Cloud Databases のCLIプラグイン の「Connection」コマンドを使用して、接続文字列を取得することもできます。

コマンドは、以下のようになります。

ibmcloud resource service-instance <INSTANCE_NAME_OR_CRN>

詳細については、「 Connections」コマンドのオプションを 参照してください。

Databases for PostgreSQL デプロイメントには、デフォルトの管理者ユーザーが含められなくなりました。 その代わりに、顧客は、 IBM Cloud® サービスの認証情報インターフェース（UIまたはCLI経由）を使用して、「Manager」、「Writer」、または「Reader」のロールを割り当てたユーザーを作成します。 これにより、デプロイメントへの接続に使用できるユーザー名（ibm_...）、パスワード、および接続文字列が提供されます。 デプロイメントに含まれるのがプライベート・エンドポイントのみの場合、--endpoint-type private を指定する必要があります。指定しないと、コマンドによってエラーが返ります。 ユーザーとエンドポイント・タイプは強制されません。 プライベートエンドポイント（指定された接続オプション）を使用すれば、デプロイメント上のどのユーザーでも利用できます。

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

APIでの接続文字列の取得

Cloud Databases API からユーザーの接続文字列を取得するには、「 Connections」エンドポイントを使用します。 接続文字列を作成する際は、パスに使用する特定のユーザーとエンドポイントの種類が確実に含まれていることを確認してください。 user には、制限や強制的な規定はありません。 導入環境で利用可能なユーザーであれば、どのユーザーでも柔軟に利用することができます。

APIコマンドは次のようになります：

curl -X GET 'https://resource-controller.cloud.ibm.com/v2/resource_instances/{id}' -H "Authorization: Bearer <IAM token>""

{region}、 {id}、 {userid}、 {endpoint_type} を、それぞれ適切な値に置き換えることを忘れないでください。

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、Authentication、Host、およびPathを組み合わせたURI。
  • 0... 配列内のこれらのエントリのうち、1つ以上を示す。

CLI セクション

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

PostgreSQL/cli 接続情報
フィールド名 索引 説明
Bin 接続を確立するためのバイナリ。この場合は、 psql です。
Composed デプロイメントへの接続を確立するための構成済みのコマンド。 このコマンドは、Bin 実行可能プログラムと Environment 変数設定を組み合わせ、コマンド・ライン・パラメーターとして Arguments を使用します。
Environment 環境変数として設定したキー/値のリスト。
Arguments 0... Bin フィールドに示されているコマンドに引数として渡される情報
Type この接続情報を使用するパッケージのタイプ。この場合は cli です。
  • 0... は、1 つの配列にこれらのエントリーが 1 つ以上ある可能性があることを示しています。