Se usó la API de Cloud Translation para traducir esta página.

Usar la API de Datastream

Descripción general

Datastream proporciona una API de REST para administrar tus parámetros de configuración de conectividad privada, perfiles de conexión y transmisiones de forma programática. La API de REST se define por recursos asociados con la creación y administración de configuraciones de conectividad privada, perfiles de conexión y transmisiones. Para obtener detalles sobre todos los recursos y sus métodos, consulta la Referencia de la API de Datastream.

Cuando envías solicitudes directamente a la API de REST de Datastream, debes crear el formulario correcto de la solicitud, autorizarla como un usuario autenticado y procesar las respuestas que se devuelven. Muchas de las tareas de esta documentación proporcionan ejemplos de API con cURL.

Para obtener más ejemplos del uso de las APIs, consulta la página de la solicitud en el Referencia de la API de Datastream. Cada página tiene ejemplos que llaman a la API en varios lenguajes de programación, así como un explorador específico de la solicitud para ayudarte a ver qué incluye una solicitud bien formada y qué esperar en la respuesta.

También usas la API de Datastream, de forma indirecta, cuando usas cualquiera de las siguientes formas de administración de instancias:

Google Cloud CLI: Una interfaz de línea de comandos (CLI) que puedes usar para trabajar con tus instancias.
Consola de Google Cloud: Una interfaz web gráfica.

La ventaja de usar estos métodos, en especial la console de Google Cloud, es que pueden simplificar en gran medida la administración de tus parámetros de configuración, perfiles de conexión y transmisiones de conectividad privada (según tu caso de uso). Si estás dando los primeros pasos Datastream, te recomendamos que primero comiences con una de estas herramientas antes de trabajar directamente con la API de REST.

Habilite la API

Para usar la API de Datastream, debes habilitarla:

Console

Habilita la API de Datastream.
Selecciona tu proyecto.
Selecciona Continuar.

gcloud

Ingresa lo siguiente para mostrar los ID de tus proyectos de Google Cloud:
```
gcloud projects list
```

Configura el proyecto predeterminado:

gcloud config set project YOUR_PROJECT_ID

Habilita la API de Datastream:

gcloud services enable datastream.googleapis.com

Permisos

Debes tener los permisos necesarios para usar la API de Datastream. Estos permisos incluyen los siguientes:

Administrador de Datastream: Con este permiso, un usuario obtiene acceso a todos los recursos de Datastream que se usan para administrar configuraciones de conectividad privada, perfiles de conexión y transmisiones.
Visualizador de Datastream: Con este permiso, un usuario tiene acceso de solo lectura a las configuraciones de conectividad privada, los perfiles de conexión y las transmisiones en Datastream.

Google Cloud ofrece la administración de identidades y accesos (IAM), que te permite brindar acceso más detallado a recursos específicos de Google Cloud y evita el acceso no deseado a otros recursos. Puedes obtener y configurar permisos para Datastream con la consola de Google Cloud, los métodos de IAM de la API o el SDK de Google Cloud. Para obtener más información, consulta Otorga, cambia y revoca el acceso a los recursos.

Ejemplos de API

Puedes ver ejemplos del uso de la API de Datastream con cURL en las siguientes páginas de la documentación de Datastream:

Proporciona datos JSON desde un archivo

Cuando usas la API con cURL, proporcionas los valores de las propiedades con la línea de comandos. Si trabajas con valores sensibles, como contraseñas o seguridad proporcionarlas en la línea de comandos representa un riesgo de seguridad. Para mayor seguridad, puedes crear un archivo que contenga los datos JSON de la llamada a la API y proporcionar la ruta de acceso al archivo en la línea de comandos.

Para proporcionar datos JSON a tu llamada a la API de cURL desde un archivo, haz lo siguiente:

Crea un archivo que contenga todo lo encerrado entre comillas simples para el campo --data.

Incluye los corchetes, pero no las comillas simples.

En la línea de comandos, proporciona la ruta de acceso al archivo, precedida por el carácter @, como el parámetro --data:

--data @<path-to-file>/<filename>

Por ejemplo, para crear un perfil de conexión para una fuente de MySQL, puedes crear un archivo llamado request.json con el siguiente contenido:

{
  "displayName": "my MySQL connection profile",
  "mysql": {
    "host": "10.11.12.13",
    "port": 3306,
    "username": "myusername",
    "password": "mypassword"
  }
}

Luego, usarías el siguiente comando cURL en la línea de comandos:

curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \
     --header 'Content-Type: application/json' \
     --data @./request.json \
     -X POST \
     https://datastream.googleapis.com/v1/projects/myProject/locations/myLocation/connectionProfiles?connectionProfileId=myMySQLconnectionprofile

Trabaja con llamadas a la API de larga duración

Algunas llamadas a la API, como la creación de objetos, pueden tardar en completarse. Porque Si la API es asíncrona, la llamada se muestra inmediatamente, incluso si la operación se en curso. Si una llamada a la API posterior usa el objeto creado recientemente, debes esperar a que se complete la primera operación antes de continuar.

Puedes usar la API de Datastream para administrar operaciones. Esto incluye lo siguiente:

Datastream y el Servicio de descubrimiento de API de Google

El Servicio de descubrimiento de APIs de Google es un servicio que puedes usar para descubrir las APIs de Google. Por ejemplo, cuando usas el Explorador de APIs de Google , estás usando el Servicio de descubrimiento.

En el servicio de descubrimiento, Datastream se representa como "datastream" (por ejemplo: https://datastream.googleapis.com/$discovery/rest?version=v1).