Esta página se ha traducido con Cloud Translation API.

Usar la API DataStream

Datastream proporciona una API REST para administrar las configuraciones de conectividad privada, los perfiles de conexión y los flujos de forma programática. La API REST se define mediante recursos asociados a la creación y gestión de configuraciones de conectividad privada, perfiles de conexión y flujos. Para obtener información sobre todos los recursos y sus métodos, consulta la referencia de la API Datastream.

Cuando envías solicitudes directamente a la API REST de Datastream, debes crear la forma correcta de la solicitud, autorizarla como usuario autenticado y procesar las respuestas devueltas. En muchas de las tareas de esta documentación se proporcionan ejemplos de API con cURL.

Para ver más ejemplos de uso de las APIs, consulta la página de la solicitud en la referencia de la API DataStream. Cada página incluye ejemplos de llamadas a la API en varios lenguajes de programación, así como un explorador específico de la solicitud para ayudarte a ver qué se incluye en una solicitud bien formada y qué se espera en la respuesta.

También usas la API Datastream de forma indirecta cuando utilizas cualquiera de las siguientes formas de administrar instancias:

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

La ventaja de usar estos métodos, especialmente la consolaGoogle Cloud , es que pueden simplificar en gran medida la administración de tus configuraciones de conectividad privada, perfiles de conexión y flujos (en función de tu caso de uso). Si acabas de empezar a usar Datastream, te recomendamos que primero utilices una de estas herramientas antes de trabajar directamente con la API REST.

Activar la API

Para usar la API Datastream, debe habilitarla:

Consola

Habilita la API Datastream.
Selecciona el proyecto.
Selecciona Continuar.

gcloud

Introduce lo siguiente para mostrar los IDs de tus Google Cloud proyectos:
```
gcloud projects list
```

Configura tu proyecto predeterminado:

gcloud config set project YOUR_PROJECT_ID

Habilita la API Datastream:

gcloud services enable datastream.googleapis.com

Permisos

Debe tener los permisos necesarios para usar la API Datastream. Estos permisos incluyen lo siguiente:

Administrador de Datastream: con este permiso, un usuario obtiene acceso a todos los recursos de Datastream que se usan para gestionar configuraciones de conectividad privada, perfiles de conexión y flujos.
Lector de Datastream: con este permiso, un usuario tiene acceso de solo lectura a las configuraciones de conectividad privada, los perfiles de conexión y los flujos de Datastream.

Google Cloud ofrece Gestión de Identidades y Accesos (IAM), que te permite conceder un acceso más granular a recursos Google Cloud específicos e impide el acceso no deseado a otros recursos. Puedes obtener y definir permisos para Datastream mediante la Google Cloud consola, los métodos de gestión de identidades y accesos de la API o el Google Cloud SDK. Para obtener más información, consulta Conceder, cambiar y revocar el acceso a los recursos.

Ejemplos de la API

Puedes ver ejemplos de cómo usar la API Datastream con cURL en las siguientes páginas de la documentación de Datastream:

Proporcionar datos JSON de un archivo

Cuando usas la API con cURL, proporcionas los valores de las propiedades mediante la línea de comandos. Si trabajas con valores sensibles, como contraseñas o claves de seguridad, proporcionarlos en la línea de comandos supone un riesgo para la seguridad. Para aumentar la seguridad, puede crear un archivo que contenga los datos JSON de la llamada a la API y proporcionar la ruta al archivo en la línea de comandos.

Para proporcionar datos JSON a tu llamada a la API cURL desde un archivo, sigue estos pasos:

Crea un archivo que contenga todo lo que esté entre comillas simples en el campo --data.

Incluye las llaves, pero no las comillas simples.

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

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

Por ejemplo, para crear un perfil de conexión para una fuente 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"
  }
}

A continuación, 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

Trabajar con llamadas a la API de larga duración

Algunas llamadas a la API, como la creación de objetos, pueden tardar un tiempo en completarse. Como la API es asíncrona, la llamada se devuelve inmediatamente, aunque la operación aún esté en curso. Si una llamada a la API posterior usa el objeto recién creado, debes esperar a que se complete la primera operación antes de continuar.

Puede usar la API Datastream para gestionar operaciones. Entre los datos que recoge se incluyen los siguientes:

Datastream y el servicio de descubrimiento de APIs de Google

El servicio de descubrimiento para APIs de Google es un servicio que puedes usar para descubrir APIs de Google. Por ejemplo, cuando usas la herramienta 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).