Endpoints

IBM Cloudant には HTTP API エンドポイントを介してアクセスします。 インスタンスのエンドポイントは、インスタンスに対して生成されるサービス資格情報の URL フィールドと、インスタンスの勘定科目 > 設定の両方に表示されます。 IBM Cloudant ダッシュボード。

すべての IBM Cloudant HTTP エンドポイントには TLS 経由でアクセスする必要があり、https:// が先頭に必要です。

以下の例には、パブリック・ネットワークに接している外部エンドポイントが示されています。

https://$ACCOUNT.cloudant.com

2019 年 1 月 1 日以降に作成されるすべてのインスタンスには、appdomain.cloud ドメイン・エンドポイントが含まれています。 以下の例には、パブリック・ネットワークに接している外部エンドポイントが示されています。

https://$ACCOUNT.cloudantnosqldb.appdomain.cloud

プライベート (内部) エンドポイントは、専用ハードウェア・プラン環境にデプロイされたすべてのインスタンスに追加されます。 以下の例には、IBM Cloud プライベート (内部) ネットワーク・エンドポイントが示されています。

https://$ACCOUNT.private.cloudantnosqldb.appdomain.cloud

前の例では、 ACCOUNT は、 URL におけるサービスインスタンスユーザーのサービス名です。 ACCOUNT の例としては、 de810d0e-763f-46a6-ae88-50823dc85581-bluemix があり、その結果として得られる外部エンドポイントの例は、 de810d0e-763f-46a6-ae88-50823dc85581-bluemix.cloudantnosqldb.appdomain.cloud となります。

IP 許可リストを使用してパブリック・ネットワーク接続をブロックする方法について詳しくは、セキュアなアクセス制御を参照してください。

サービス資格情報

IBM Cloud を使用して IBM Cloudant のサービス資格情報を生成するには、以下のようにします。 ダッシュボード、 IBM Cloud での IBM Cloudant インスタンスの作成のチュートリアルを参照してください。 IBM Cloud CLI からサービス資格情報を生成するには、CLI によるインスタンスの作成を参照してください。

IBM Cloudant インスタンスのサービス資格情報の例を以下に示します。

{
  "apikey": "MxVp86XHkU82Wc97tdvDF8qM8B0Xdit2RqR1mGfVXPWz",
  "host": "76838001-b883-444d-90d0-46f89e942a15-bluemix.cloudant.com",
  "iam_apikey_description": "Auto generated apikey during resource-key [...]",
  "iam_apikey_name": "auto-generated-apikey-050d21b5-5f[...]",
  "iam_role_crn": "crn:v1:bluemix:public:iam::::serviceRole:Manager",
  "iam_serviceid_crn": "crn:v1:staging:public:iam-identity::[...]",
  "password": "8fb6a16b48903e87b769e7f4968521e85c2394ed8f0e69b2769e56dcb27d2e76",
  "port": 443,
  "url": "https://<username>:<password>@76838001-b883-444d-90d0-46f89e942a15-bluemix.cloudant.com",
  "username": "apikey-v2-58B528DF5397465BB6673E1B79482A8C"
}

サービス資格情報には以下のフィールドがあります。

username

アプリケーションがサービス・インスタンスにアクセスするために必要なユーザー名。

password

アプリケーションがサービス・インスタンスにアクセスするために必要なレガシー資格情報のパスワード。 このフィールドは、「Use both legacy credentials and IAM」オプションが選択されている場合にのみ表示されます。

host

アプリケーションがサービスインスタンスを特定するために使用するホスト名。 このフィールドは、「Use both legacy credentials and IAM」オプションが選択されている場合にのみ表示されます。

port

ホスト上のサービス・インスタンスにアクセスするための HTTPS ポート番号。 IBM Cloudant では HTTPS アクセスのみが許可されるため、これは 443 になります。 このフィールドは、「Use both legacy credentials and IAM」オプションが選択されている場合にのみ表示されます。

url

IBM Cloudant インスタンスにアクセスするための HTTPS URL。 「Use both legacy credentials and IAM」オプションが選択されている場合は、組み込まれたレガシー・ユーザー名とパスワードも含まれます。

apikey

IAM API キー。

iam_apikey_description

IAM API キーの説明。

iam_apikey_name

IAM API キーの ID。

iam_role_crn

IAM API キーの IAM 役割。

iam_serviceid_crn

サービス ID の CRN。

認証

IBM Cloudant では、プロビジョニング時に以下の 2 つの認証方式を使用できます。 Use only IAMまたはUse both legacy credentials and IAM。 「サービス資格情報」でレガシー資格情報についての詳細を表示できるのは、「Use both legacy credentials and IAM」認証方式を選択した場合のみになります。 資格情報は、インスタンスの「サービス資格情報」タブに表示されます。 詳細については、 IAMガイド を参照してください および、使用方法の詳細については、 従来の認証 に関するドキュメントを参照してください いずれかの認証方式。

IBM Cloudant チームでは、可能な場合は認証に IAM アクセス制御を使用することをお勧めしています。 IBM Cloudant のレガシー認証を使用している場合は、プログラムによるアクセスやレプリケーションジョブにおいて、 アカウント認証情報ではなく APIキー を使用する必要があります。

IBM Cloudant ダッシュボード

IBM Cloudant ダッシュボードのインスタンスの詳細ページの「管理」タブにアクセスすると、ご使用のインスタンスの IBM Cloud ダッシュボードを開くことができます。 LaunchまたはLaunch Cloudant Dashboardのいずれかを使用して、新規ブラウザー・タブでダッシュボードを開くことができます。 IBM Cloudant ダッシュボードを使用して、以下の作業を行うことができます。

• インスタンスの現在の使用量のモニター。
• IBM Cloudant のデータベース、文書、および索引に対する作成、検索、更新、削除の実行。
• 複製ジョブのセットアップと表示。
• アクティブ・タスクの表示。
• プロビジョン済みスループット能力、発表、CORS、および設定などのアカウント情報の表示と更新。

プログラマチック・アクセス