Connessione

Si accede a IBM® Cloudant® for IBM Cloud® tramite un'API HTTP. Nell'elenco seguente puoi vedere i vari elementi necessari per collegarti a IBM Cloudant:

  • Endpoint
  • Credenziali del servizio
  • Autenticazione
  • Accesso al dashboard IBM Cloudant
  • Accesso programmatico a IBM Cloudant tramite curl o librerie client

Endpoint

Si accede a IBM Cloudant tramite gli endpoint dell'API HTTP. Gli endpoint di un'istanza sono indicati sia nel campo " URL " delle credenziali di servizio generate per l'istanza, sia in Account > Impostazioni della IBM Cloudant Pannello di controllo.

È necessario accedere a tutti gli endpoint IBM Cloudant HTTP tramite TLS, precedendoli da https://.

L'endpoint esterno rivolto pubblicamente è mostrato nel seguente esempio:

https://$ACCOUNT.cloudant.com

Tutte le istanze create dopo il 1° gennaio 2019 includono un endpoint di dominio appdomain.cloud. L'endpoint esterno rivolto pubblicamente è mostrato nel seguente esempio:

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

Gli endpoint privati (interni) vengono aggiunti a tutte le istanze distribuite sugli ambienti del piano Hardware Dedicato. L'endpoint di rete IBM Cloud L'endpoint di rete (interno) è riportato nel seguente esempio:

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

Nell'esempio precedente, ACCOUNT è il nome del servizio associato all'utente dell'istanza di servizio presente in URL. Un esempio di ACCOUNT è de810d0e-763f-46a6-ae88-50823dc85581-bluemix, e l'endpoint esterno risultante sarebbe de810d0e-763f-46a6-ae88-50823dc85581-bluemix.cloudantnosqldb.appdomain.cloud.

Per ulteriori informazioni su come bloccare la connettività di rete pubblica utilizzando IP allowlisting, consultare Secure access control.

Credenziali del servizio

Per generare le credenziali di servizio per IBM Cloudant utilizzando il IBM Cloud Dashboard, consultare la sezione Creazione di un'istanza IBM Cloudant su IBM Cloud tutorial. Per generare le credenziali di servizio dal IBM Cloud CLI, consultare Creazione di un'istanza con CLI.

Il seguente esempio mostra le credenziali di servizio per un'istanza 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"
}

Le credenziali del servizio includono i seguenti campi:

username
Il nome utente necessario alle applicazioni per accedere all'istanza del servizio.
password
La password delle credenziali legacy obbligatoria alle applicazioni per accedere all'istanza del servizio. Questo campo viene visualizzato solo se è selezionata l'opzione " Use both legacy credentials and IAM ".
host
Il nome host utilizzato dalle applicazioni per individuare l'istanza del servizio. Questo campo viene visualizzato solo se è selezionata l'opzione " Use both legacy credentials and IAM ".
port
Il numero di porta HTTPS per l'accesso all'istanza del servizio sull'host. È 443, poiché IBM Cloudant consente solo l'accesso di tipo " HTTPS ". Questo campo viene visualizzato solo se è selezionata l'opzione " Use both legacy credentials and IAM ".
url
L'URL HTTPS per accedere all'istanza IBM Cloudant. Se si seleziona l'opzione " Use both legacy credentials and IAM ", vengono inclusi anche il nome utente e la password legacy incorporati.
apikey
La chiave API IAM.
iam_apikey_description
La descrizione della chiave API IAM.
iam_apikey_name
L'ID della chiave API IAM.
iam_role_crn
Il ruolo IAM che ha la chiave API IAM.
iam_serviceid_crn
Il CRN dell'ID servizio.

Autenticazione

IBM Cloudant dispone di due metodi di autenticazione disponibili al momento del provisioning, sia Use only IAM oppure Use both legacy credentials and IAM. Puoi vedere i dettagli relativi alle tue credenziali legacy nelle credenziali del servizio solo se è stato scelto il metodo di autenticazione Use both legacy credentials and IAM. Le credenziali vengono visualizzate nella scheda Credenziali del servizio per la tua istanza. Per ulteriori informazioni, consultare la guida IAM e il documento di autenticazione tradizionale per ulteriori dettagli sull'utilizzo di entrambi i tipi di autenticazione.

Il team di IBM Cloudant consiglia di utilizzare i controlli di accesso IAM per l'autenticazione ogni volta che è possibile. Se si utilizza l'autenticazione legacy di IBM Cloudant, è necessario utilizzare le chiavi API anziché le credenziali a livello di account per l'accesso programmatico e i processi di replica.

Dashboard IBM Cloudant

Puoi aprire il dashboard IBM Cloudant per la tua istanza andando alla scheda Manage della pagina dei dettagli dell'istanza del dashboard IBM Cloud. È possibile utilizzare sia Launch che Launch Cloudant Dashboard per aprire la dashboard in una nuova scheda del browser. È possibile effettuare le seguenti attività utilizzando il dashboard IBM Cloudant:

  • Controlla il consumo attuale dell'istanza.
  • Eseguire creare, richiamare, aggiornare, eliminare su IBM Cloudant database, documenti e indici.
  • Configurare e visualizzare i processi di replica.
  • Visualizza attività attive.
  • Visualizza e aggiorna le informazioni relative all'account, quali la capacità di throughput assegnata, gli annunci, l' CORS e le impostazioni.

Accesso programmatico

Riga di comando (curl)

È possibile utilizzare l'utilità da riga di comando curl per accedere all'API IBM Cloudant HTTPS.

Per ulteriori informazioni, consultare la sezione " Utilizzo di curl ". Lavorare con curl fornisce dettagli sulla fornitura di un username e di una password per accedere al IBM Cloudant API con curl.

Se utilizzi l'autenticazione IAM IBM Cloud, devi innanzitutto ottenere un token IAM IBM Cloud utilizzando una chiave API. Per effettuare l'autenticazione, è necessario trasmettere il token IAM all'istanza di IBM Cloudant. Per ulteriori informazioni, consulta il tutorial " Come trasmettere un token IAM di IBM Cloud per l'autenticazione tramite l'API di un servizio " .

Non è possibile utilizzare direttamente una chiave API IAM per l'autenticazione su IBM Cloudant.

Librerie client

IBM Cloudant ha librerie client ufficiali e supportate per Java™, Node.js, Python, Swift, Go e Mobile. Per ulteriori informazioni, consultare la documentazione sulle librerie client per accedere alle librerie e gli esempi relativi alla connessione a un IBM Cloudant istanza da ciascuno.