Puntos finales

Se accede a IBM Cloudant a través de puntos finales de API HTTP. Los puntos finales de una instancia se muestran en el campo de URL de las credenciales de servicio que se generan para la instancia, y en Cuenta > Valores del panel de control de IBM Cloudant.

Se debe acceder a todos los puntos finales HTTP de IBM Cloudant a través de TLS y deben llevar como prefijo https://.

El punto final externo de cara al público se muestra en el ejemplo siguiente:

https://$ACCOUNT.cloudant.com

Todas las instancias creadas después del 1 de enero de 2019 incluye un punto final de dominio de appdomain.cloud. El punto final externo de cara al público se muestra en el ejemplo siguiente:

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

Los puntos finales privados (internos) se añaden a todas las instancias desplegadas en entornos del plan Hardware dedicado. El punto final privado (interno) de red de IBM Cloud se muestra en el ejemplo siguiente:

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

En el ejemplo anterior, " ACCOUNT " es el nombre de servicio del usuario de la instancia de servicio en la URL. Un ejemplo de " ACCOUNT " es de810d0e-763f-46a6-ae88-50823dc85581-bluemix, y el endpoint externo de ejemplo resultante sería de810d0e-763f-46a6-ae88-50823dc85581-bluemix.cloudantnosqldb.appdomain.cloud.

Para obtener más información sobre cómo bloquear la conectividad de red pública utilizando una lista de elementos permitidos de IP, consulte Control de accesos seguro.

Credenciales de servicio

Para generar credenciales de servicio para IBM Cloudant utilizando el panel de control de IBM Cloud, consulte la guía de aprendizaje Creación de una instancia de IBM Cloudant en IBM Cloud. Para generar credenciales de servicio desde la CLI de IBM Cloud, consulte Creación de una instancia con la CLI.

En el ejemplo siguiente se muestran las credenciales de servicio para una instancia de 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"
}

Las credenciales de servicio incluyen los campos siguientes:

username

El nombre de usuario que necesitan las aplicaciones para acceder a la instancia de servicio.

password

La contraseña de las credenciales heredadas que es necesaria para que las aplicaciones accedan a la instancia de servicio. Este campo solamente se muestra si se elige la opción Use both legacy credentials and IAM.

host

El nombre de host que utilizan las aplicaciones para localizar la instancia de servicio. Este campo solamente se muestra si se elige la opción Use both legacy credentials and IAM.

port

El número de puerto HTTPS para acceder a la instancia de servicio en el host. Es 443 ya que IBM Cloudant solo permite el acceso HTTPS. Este campo solamente se muestra si se elige la opción Use both legacy credentials and IAM.

url

El URL HTTPS para acceder a la instancia de IBM Cloudant. Si se selecciona la opción Use both legacy credentials and IAM, también se incluye el nombre de usuario y contraseña heredados.

apikey

La clave de API de IAM.

iam_apikey_description

Descripción de la clave de API de IAM.

iam_apikey_name

ID de la clave de API de IAM.

iam_role_crn

El rol de IAM que tiene la clave de API de IAM.

iam_serviceid_crn

La CRN del ID de servicio.

Autenticación

IBM Cloudant tiene dos métodos de autenticación disponibles en el momento del suministro, ya sea Use only IAM o Use both legacy credentials and IAM. Puede ver los detalles sobre las credenciales heredadas en las credenciales de servicio únicamente si se ha elegido el método de autenticación Use both legacy credentials and IAM. Las credenciales se muestran en el separador Credenciales de servicio de la instancia. Para obtener más información, consulte la guía de IAM y el documento de autenticación heredada para obtener detalles sobre el uso de cualquier estilo de autenticación.

El equipo de IBM Cloudant recomienda el uso de controles de acceso de IAM para la autenticación siempre que sea posible. Si utiliza la autenticación heredada IBM Cloudant, debe utilizar claves de API en lugar de credenciales de nivel de cuenta para el acceso programático y los trabajos de replicación.

Panel de control de IBM Cloudant

Puede abrir el panel de control de IBM Cloudant de la instancia accediendo al separador Gestionar de la página de detalles de la instancia del panel de control de IBM Cloud. Puede utilizar Launch o Launch Cloudant Dashboard para abrir el panel de control en un nuevo separador de navegador. Puede realizar las siguientes tareas utilizando el panel de control de IBM Cloudant:

• Supervisar el consumo actual de la instancia.
• Realizar operaciones de creación, recuperación, actualización y supresión sobre índices, documentos y bases de datos de IBM Cloudant.
• Configurar y visualizar trabajos de réplica.
• Ver las tareas activas.
• Ver y actualizar información de cuenta como la capacidad de rendimiento suministrada, anuncios, CORS y valores.

Acceso programático