Verbindungen herstellen

IBM® Cloudant® for IBM Cloud® wird über eine HTTP-API aufgerufen. In der folgenden Liste sind die verschiedenen Elemente aufgeführt, die Sie zum Verbinden mit IBM Cloudant verwenden:

  • Endpunkte
  • Serviceberechtigungsnachweise
  • Authentifizierung
  • Aufruf des IBM Cloudant-Dashboards
  • Programmgesteuerter Zugriff auf IBM Cloudant mithilfe von curl oder Client-Bibliotheken

Endpunkte

Auf IBM Cloudant wird über HTTP-API-Endpunkte zugegriffen. Die Endpunkte für eine Instanz werden im URL-Feld der Serviceberechtigungsnachweise angezeigt, die für die Instanz generiert werden, sowie unter Konto > Einstellungen im IBM Cloudant-Dashboard.

Auf alle IBM Cloudant-HTTP-Endpunkte muss über TLS zugegriffen werden und das Präfix https:// muss vorangestellt werden.

Der öffentlich zugängliche externe Endpunkt wird im folgenden Beispiel gezeigt:

https://$ACCOUNT.cloudant.com

Alle Instanzen, die nach dem 1. Januar 2019 erstellt wurden, enthalten einen Domänenendpunkt namens appdomain.cloud. Der öffentlich zugängliche externe Endpunkt wird im folgenden Beispiel gezeigt:

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

Private (interne) Endpunkte werden allen Instanzen hinzugefügt, die in Umgebungen mit einem Plan für dedizierte Hardware bereitgestellt werden. Im folgenden Beispiel wird der interne IBM Cloud Private-Netzendpunkt gezeigt:

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

Im vorherigen Beispiel ist „ ACCOUNT “ der Dienstname des Dienstinstanzbenutzers in der Datei „ URL “. Ein Beispiel für einen „ ACCOUNT “ ist de810d0e-763f-46a6-ae88-50823dc85581-bluemix, und der daraus resultierende externe Endpunkt wäre de810d0e-763f-46a6-ae88-50823dc85581-bluemix.cloudantnosqldb.appdomain.cloud.

Weitere Informationen zum Blockieren der öffentlichen Netzkonnektivität mithilfe der IP-allowlisting finden Sie unter Secure access control.

Serviceberechtigungsnachweise

Informationen zum Generieren von Serviceberechtigungsnachweisen für IBM Cloudant über das IBM Cloud-Dashboard finden Sie im Lernprogramm zum Erstellen einer IBM Cloudant-Instanz in IBM Cloud. Informationen zum Generieren von Serviceberechtigungsnachweisen über die IBM Cloud CLI finden Sie unter Erstellen einer Instanz mit CLI.

Das folgende Beispiel zeigt Serviceberechtigungsnachweise für eine IBM Cloudant-Instanz:

{
  "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"
}

Die Serviceberechtigungsnachweise beinhalten die folgenden Felder:

username
Benutzername, der erforderlich ist, damit Anwendungen auf die Serviceinstanz zugreifen können.
password
Das Kennwort für die traditionellen Berechtigungsnachweise, das für Anwendungen für den Zugriff auf die Serviceinstanz benötigt wird. Dieses Feld wird nur angezeigt, wenn die Option Use both legacy credentials and IAM ausgewählt wird.
host
Der Hostname, den Anwendungen verwenden, um die Dienstinstanz zu finden. Dieses Feld wird nur angezeigt, wenn die Option Use both legacy credentials and IAM ausgewählt wird.
port
Die HTTPS-Portnummer für den Zugriff auf die Serviceinstanz auf dem Host. Sie lautet '443', da von IBM Cloudant nur ein HTTPS-Zugriff zugelassen wird. Dieses Feld wird nur angezeigt, wenn die Option Use both legacy credentials and IAM ausgewählt wird.
url
Die HTTPS-URL für den Zugriff auf die IBM Cloudant-Instanz. Bei Auswahl der Option Use both legacy credentials and IAM enthält die URL auch den eingebetteten traditionellen Benutzernamen und das zugehörige Kennwort.
apikey
Der IAM-API-Schlüssel.
iam_apikey_description
Die Beschreibung des IAM-API-Schlüssels.
iam_apikey_name
Die ID des IAM-API-Schlüssels.
iam_role_crn
Die IAM-Rolle, die dem IAM-API-Schlüssel zugeordnet wurde.
iam_serviceid_crn
Der CRN der Service-ID.

Authentifizierung

Für IBM Cloudant sind zwei Authentifizierungsmethoden zur Bereitstellungszeit verfügbar: Use only IAM oder Use both legacy credentials and IAM. Die Details zu Ihren traditionellen Berechtigungsnachweisen können in den Serviceberechtigungsnachweisen nur angezeigt werden, wenn die Authentifizierungsmethode Use both legacy credentials and IAM ausgewählt wird. Die Berechtigungsnachweise werden auf der Registerkarte 'Serviceberechtigungsnachweise' Ihrer Instanz angezeigt. Weitere Informationen finden Sie im IAM-Leitfaden sowie im Dokument zur herkömmlichen Authentifizierung finden Sie weitere Informationen zur Verwendung von eine der beiden Authentifizierungsmethoden.

Das IBM Cloudant-Team empfiehlt, soweit möglich, die Verwendung der IAM-Zugriffssteuerung für die Authentifizierung. Wenn Sie die alte Authentifizierungsmethode von „ IBM Cloudant “ verwenden, müssen Sie für den programmgesteuerten Zugriff und für Replikationsaufträge API-Schlüssel anstelle von Anmeldedaten auf Kontoebene verwenden.

IBM Cloudant-Dashboard

Sie können das IBM Cloudant-Dashboard öffnen, indem Sie die Seite mit Instanzdetails auf der Registerkarte 'Verwalten' im IBM Cloud-Dashboard öffnen. Verwenden Sie entweder Launch oder Launch Cloudant Dashboard, um das Dashboard in einer neuen Browserregisterkarte zu öffnen. Über das IBM Cloudant-Dashboard können Sie die folgenden Tasks ausführen:

  • Aktuelle Nutzung der Instanz überwachen.
  • Erstell-, Abruf-, Aktualisierungs- und Löschoperationen für IBM Cloudant-Datenbanken, -Dokumente und -Indizes ausführen.
  • Replikationsjobs einrichten und anzeigen.
  • Aktive Tasks anzeigen.
  • Kontoinformationen wie bereitgestellte Durchsatzkapazität, Ankündigungen, CORS und Einstellungen anzeigen und aktualisieren.

Programmgesteuerter Zugriff

Befehlszeile (curl)

Sie können das Befehlszeilendienstprogramm 'curl' verwenden, um auf die IBM Cloudant-HTTPS-API zuzugreifen.

Weitere Informationen finden Sie im Abschnitt Mit curl arbeiten. Unter „Arbeiten mit curl“ finden Sie detaillierte Informationen zur Angabe eines Benutzernamens und eines Passworts für den Zugriff auf die „ IBM Cloudant “-API mit curl.

Wenn Sie die IBM Cloud IAM-Authentifizierung verwenden, müssen Sie zuerst mithilfe eines API-Schlüssels ein IBM Cloud IAM-Token abrufen. Übergeben Sie zum Authentifizieren das IAM-Token an die IBM Cloudant-Instanz. Weitere Informationen finden Sie im Tutorial „Übergeben eines IAM-Tokens von IBM Cloud zur Authentifizierung bei der API eines Dienstes“.

Eine direkte Authentifizierung mit einem IAM-API-Schlüssel ist bei IBM Cloudant nicht möglich.

Clientbibliotheken

IBM Cloudant verfügt über offizielle, unterstützte Client-Bibliotheken für Java™, Node.js, Python, Swift, Go und Mobile. In der Dokumentation für Clientbibliotheken finden Sie weitere Informationen zum Aufrufen der Bibliotheken sowie Beispiele zum Verbinden mit einer IBM Cloudant-Instanz über die einzelnen Bibliotheken.