IBM Cloud Docs
接続文字列の取得

接続文字列の取得

IBM Cloud® Databases for Redis サービスは、認証が有効にされた状態でプロビジョンされます。 接続してコマンドを発行するには、ユーザー名、パスワード、および接続ストリングが必要です。

配置の接続文字列は、[概要]ページの[エンドポイント]パネルに表示されます。 デプロイメント上のすべてのユーザーは、パブリック・エンドポイントまたはプライベート・エンドポイントの接続ストリングなどの接続ストリングを使用できます。

接続ストリングはデフォルトでデータベース 0 になります。 ただし、 0 以外のデータベースに接続するように接続を変更することはサポートされています。

Redis デプロイメントは、管理者ユーザー付きでプロビジョンされます。 管理者パスワードを使用してデータベースに接続するために、先に管理者パスワードを設定する必要があります。 詳しくは、管理者パスワードの設定のページを参照してください。

UIから接続文字列を取得する

以下の手順に従って、Databases for Redisインスタンスの接続文字列を取得してください：

  1. 配置の[概要]ページで、[*エンドポイント]*セクションまで下にスクロールします。
  2. Endpoints（エンドポイント）セクションには、以下のセクションがあるQuick start（クイックスタート）タブがあります：
    • CLIを使って接続する- This section contains information for connecting to your deployment through the IBM CLI.
    • Redisクライアントを使用して接続する- このセクションでは、TLS 証明書を取得し、デプロイメントに接続します。

CLI からの接続ストリングの取得

CLI から接続ストリングを取得できます。

ibmcloud cdb deployment-connections <INSTANCE_NAME_OR_CRN> -u <NEWUSERNAME> [--endpoint-type <endpoint type>]

ibmcloud cdb deployment-connections コマンドに --all フラグを設定すると、完全な接続情報が戻されます。 配置のすべての接続情報を取得するには、次のコマンドを使用します：

ibmcloud cdb deployment-connections <INSTANCE_NAME_OR_CRN> -u <NEWUSERNAME> --all [--endpoint-type <endpoint type>]

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

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

API からの接続ストリングの取得

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

curl -X GET https://api.{region}.databases.cloud.ibm.com/v5/ibm/deployments/{id}/users/{user_type}/{user_id}/connections/{endpoint_type} \
-H 'Authorization: Bearer <>' \

その他のユーザーと接続ストリング

Databases for Redis デプロイメントへのアクセスは、管理者ユーザーに限定されません。 _サービス資格情報_ページ、IBMクラウドCLIを使用してユーザを作成できます。クラウドCLI、またはIBMを使用してユーザを作成できます。Cloud DatabasesAPI を使用します。

デプロイメント上のすべてのユーザーは、パブリック・エンドポイントまたはプライベート・エンドポイントの接続ストリングなどの接続ストリングを使用できます。

UIからユーザーを作成する

  1. サービスのリソース詳細ページに移動します。
  2. サービス資格情報をクリックして、_サービス資格情報_ページを開きます。
  3. **「新規資格情報」**をクリックします。
  4. 新規資格情報にわかりやすい名前を選びます。
  5. (オプション) 新規資格情報でパブリック・エンドポイントまたはプライベート・エンドポイントのどちらを使用するかを指定します。 _「インラインの構成パラメーターの追加」_フィールドで { "service-endpoints": "public" } / { "service-endpoints": "private" } のいずれかを使用すると、指定したエンドポイントを使用した接続文字列を生成できます。 エンドポイントは、接続文字列に含まれるホスト名を制御するため、その使用は強制されない。 パブリック・エンドポイントはデフォルトで生成されます。
  6. **「追加」**をクリックして新規資格情報をプロビジョンします。 ユーザー名とパスワード、関連するRedisユーザーが自動生成されます。

新しい資格情報が表に表示されます。接続文字列は JSON として_「資格情報の表示」_のクリックしてコピーできるフィールドに表示されます。

CLIからユーザーを作成する

IBM Cloud CLI と Cloud Databases プラグインを使用してサービスを管理する場合は、cdb user-create を使用して新規ユーザーを作成できます。 例えば、「example-deployment」に新規ユーザーを作成するには、次のコマンドを使用します。

ibmcloud cdb user-create example-deployment <NEWUSERNAME> <NEWPASSWORD>

タスクが終了したら、ibmcloud cdb deployment-connections コマンドを使用して、新規ユーザーの接続ストリングを取得できます。

APIでユーザーを作成する

サービスの_「概要」パネルに表示される「ファウンデーション・エンドポイント (Foundation Endpoint)」_には、API を使用してこのデプロイメントにアクセスするための基本 URL が示されています。 ユーザーを作成および管理するには、その基本 URL に /users エンドポイントを付けて使用します。

curl -X POST 'https://api.{region}.databases.cloud.ibm.com/v5/ibm/deployments/{id}/users/{user_type}' \
-H "Authorization: Bearer $APIKEY" \
-H "Content-Type: application/json" \
-d '{"user": {"username": "user", "password": "v3ry-1-secUre-pAssword-2"}}'

ユーザーの接続文字列を取得するには、基本 URL に /users/{userid}/connections エンドポイントを付けて使用します。

UI で_サービス資格_情報にユーザーを追加する

CLI から新規ユーザーを作成しても、そのユーザーの接続文字列は_サービス資格情報_に自動的に入力されません。 ここにユーザーを追加するには、既存のユーザー情報を使用して新規資格情報を作成します。

JSON フィールドの_「インラインの構成パラメーターの追加」_にユーザー名およびパスワードを入力するか、JSON 情報を保管するファイルを指定します。 例えば、フィールドに {"existing_credentials":{"username":"Robert","password":"supersecure"}} と入力すると、ユーザー名「Robert」とパスワード「supersecure」が接続文字列に入力された_サービス資格情報_が生成されます。

既存のユーザーの資格情報を生成するときに、そのユーザーが存在するか検査されたり、そのユーザーが作成されたりすることはありません。

接続文字列の構成要素

Redis セクション

Service credentialsページで作成したクレデンシャルのRedis" セクションには、Redis に接続するアプリケーションに適した情報が含まれています。

Redis接続情報
フィールド名 索引 説明
Type 接続のタイプ -Redisの場合は "URI"。
Scheme URIのスキーム。Redisの場合は "rediss"。
Path URIのパス -Redisの場合はデータベース番号。
Authentication Username 接続に使用するユーザー名。
Authentication Password ユーザーのパスワードは'$PASSWORD と表示されます。
Authentication Method 認証が行われる方法。「direct」認証はドライバーによって処理されます。
Hosts 0... ホスト名と接続先ポート。
Composed 0... Scheme、認証、ホスト、パスを組み合わせたURI。
Certificate Name データベース展開用の自己署名証明書の割り当て名。
Certificate Base64 base64 でエンコードされたバージョンの証明書
  • 0... は、1 つの配列にこれらのエントリーが 1 つ以上ある可能性があることを示しています。

詳細については、外部アプリケーションの接続 を参照してください。

CLI セクション

Service credentialsページで作成されたクレデンシャルの "CLI "セクションには、Redisに接続するコマンドラインクライアントに適した情報が含まれています。

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

詳細については、コマンドラインクライアントでの接続 を参照してください。