保护连接

IBM® Cloudant® for IBM Cloud® 通过 HTTP API 进行访问。本文档介绍用于连接IBM Cloudant不同组件：

端点 (公共和专用)
服务凭证
认证
访问 IBM Cloudant 仪表板
通过 curl 或客户机库以编程方式访问 IBM Cloudant

端点 (公共和专用)

通过 HTTP API 端点访问 IBM Cloudant。实例的端点显示在为实例生成的服务凭据的 URL 字段中，以及在“账户”>“设置”的 IBM Cloudant 仪表板。

因此，所有IBM CloudantHTTP 端点都必须通过 TLS 访问，并以 https:// 作为前缀。

公共端点

以下示例中显示了面向公共的外部端点:

https://$ACCOUNT.cloudant.com

2019 年 1 月 1 日后创建的所有实例都包含一个 appdomain.cloud 域端点。以下示例中显示了面向公共的外部端点:

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

在本例中，ACCOUNT 是 URL 中服务实例用户的服务名称。 ACCOUNT 示例为 de810d0e-763f-46a6-ae88-50823dc85581-bluemix，由此产生的公共端点示例为 de810d0e-763f-46a6-ae88-50823dc85581-bluemixcloudantnosqldb.appdomain.cloud.

专用端点

专用 (内部) 端点将添加到“专用硬件”套餐环境上部署的所有实例。以下示例中显示了 IBM Cloud 内部网络端点:

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

在本例中，ACCOUNT 是 URL 中服务实例用户的服务名称。 ACCOUNT 示例为de810d0e-763f-46a6-ae88-50823dc85581-bluemix，由此产生的私有端点示例为 de810d0e-763f-46a6-ae88-50823dc85581-bluemixprivate.cloudantnosqldb.appdomain.cloud.

有关专用端点的更多信息，请参阅服务端点文档。

有关如何使用 IP 允许列表来阻止公用网络连接的更多信息，请参阅安全访问控制。

服务凭证

使用 IBM Cloud 为 IBM Cloudant 生成服务凭证仪表板，请参阅在 IBM Cloud 上创建 IBM Cloudant 实例。 To generate service credentials from the IBM Cloud CLI, see 为您的IBM Cloudant创建证书服务。

以下示例显示了 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 端口号。这是 443，因为 IBM Cloudant仅允许 HTTPS 访问。只有选择 `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 密钥的标识。
`iam_role_crn`	IAM API 密钥具有的 IAM 角色。
`iam_serviceid_crn`	服务标识的 CRN。

认证

IBM Cloudant 具有两种在供应时可用的认证方法，或者 Use only IAM or 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 和设置。

以编程方式访问

命令行 (curl)

您可以利用 curl 命令行工具访问IBM CloudantAPI。HTTPS API。

有关 IBM Cloudant 旧认证的更多信息，请参阅 API 和 SDK 参考。在 API 参考示例中，您可以找到有关提供用户名和密码以使用 curl 访问 IBM Cloudant API 的详细信息。

如果使用 IBM Cloud IAM 认证，您必须先使用 API 密钥获取 IBM Cloud IAM 令牌。然后，将 IAM 令牌传递到 IBM Cloudant 实例以进行认证。有关更多信息，请参阅传递 IBM Cloud IAM 令牌以使用服务的 API 进行认证教程。

您不能直接使用 IAM API 密钥对IBM Cloudant 进行身份验证。

客户机库

IBM Cloudant拥有Java™、Node.js、Python、Swift 和 Mobile 官方客户端库。如需了解更多信息，请参阅客户端库文档以访问这些库，并查看连接到IBM Cloudant示例实例。