Utilice la API del servicio de migración de bases de datos

Organízate con las colecciones Guarda y clasifica el contenido según tus preferencias.

Descripción general

El Servicio de migración de bases de datos proporciona una API REST para administrar sus perfiles de conexión y trabajos de migración mediante programación. La API REST está definida por los recursos asociados con la creación y administración de perfiles de conexión y trabajos de migración. Para obtener detalles sobre todos los recursos y sus métodos, consulte la Referencia de API del servicio de migración de bases de datos .

Cuando envía solicitudes directamente a la API REST del Servicio de migración de bases de datos, debe crear el formato correcto de la solicitud, autorizar la solicitud como usuario autenticado y procesar las respuestas devueltas. Muchas de las tareas de esta documentación proporcionan ejemplos de API utilizando cURL .

Para obtener más ejemplos de uso de las API, consulte la página de la solicitud en la Referencia de API del servicio de migración de bases de datos . Cada página tiene ejemplos de llamadas a la API en varios lenguajes de programación, así como un Explorador de solicitudes específicas para ayudarlo a ver qué incluye una solicitud bien formada y qué esperar en la respuesta.

También estás utilizando la API del Servicio de migración de bases de datos, indirectamente, cuando utilizas cualquiera de las siguientes formas de administrar instancias:

• CLI de Google Cloud : una interfaz de línea de comandos (CLI) que puede utilizar para trabajar con sus instancias.

• Google Cloud console: Una interfaz web gráfica.

La ventaja de utilizar estos métodos, especialmente elGoogle Cloud consola, es que pueden simplificar enormemente la administración de sus perfiles de conexión y trabajos de migración (según su caso de uso). Si recién está comenzando con el Servicio de migración de bases de datos, le recomendamos que comience con una de estas herramientas antes de trabajar directamente con la API REST.

Habilitar la API

Para utilizar la API del servicio de migración de bases de datos, debe habilitarla:

Permisos

Debe tener los permisos necesarios para utilizar la API del servicio de migración de bases de datos. Estos permisos incluyen:

• Administrador de migración de bases de datos: con este permiso, un usuario obtiene acceso a todos los recursos del Servicio de migración de bases de datos utilizados para administrar perfiles de conexión y trabajos de migración.
• Visor de migración de bases de datos: con este permiso, un usuario tiene acceso de solo lectura a los perfiles de conexión y trabajos de migración en el Servicio de migración de bases de datos.
• Administrador de Cloud SQL: con este permiso, un usuario puede crear y administrar perfiles de conexión y trabajos de migración para Cloud SQL en el Servicio de migración de bases de datos.

Google Cloud ofrece administración de identidad y acceso (IAM), que le permite brindar un acceso más granular a recursos específicos de Google Cloud y evita el acceso no deseado a otros recursos. Puede obtener y establecer permisos para el Servicio de migración de bases de datos utilizando el Google Cloud console, los métodos IAM de la API o la CLI de Google Cloud. Para obtener más información, consulte Conceder, cambiar y revocar acceso a recursos .

Ejemplos de API

Para ver ejemplos de uso de la API del servicio de migración de bases de datos con cURL, consulte Administrar perfiles de conexión mediante la API y Administrar trabajos de migración mediante la API .

Proporcionar datos JSON desde un archivo

Cuando usa la API con cURL, proporciona valores de propiedad usando la línea de comando. Si trabaja con valores confidenciales, como contraseñas o claves de seguridad, proporcionarlos en la línea de comando representa un riesgo para la seguridad. Para mayor seguridad, puede crear un archivo que contenga los datos JSON para la llamada API y proporcionar la ruta al archivo en la línea de comando.

Para proporcionar datos JSON a su llamada API de cURL desde un archivo:

1. Cree un archivo que contenga todo lo incluido entre comillas simples para el campo --data .

   Incluya las llaves, pero no incluya las comillas simples.

2. En la línea de comando, proporcione la ruta al archivo, precedida por el carácter @ , como parámetro --data :

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

   Por ejemplo, para crear un perfil de conexión para una base de datos de origen de Cloud SQL, puede crear un archivo llamado request.json con el siguiente contenido:

   {
     "displayName": "my Cloud SQL connection profile",
     "mysql": {
       "host": "10.11.12.13",
       "port": 5432,
       "username": "myusername",
       "password": "mypassword"
     }
   }
   

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

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

Trabajar con llamadas API de larga duración

Algunas llamadas a la API, como la creación de objetos, pueden tardar algún tiempo en completarse. Como la API es asincrónica, la llamada regresa inmediatamente, incluso si la operación aún está en progreso. Si una llamada API posterior utiliza el objeto recién creado, debe esperar a que se complete la primera operación antes de continuar.

Puede utilizar la API del servicio de migración de bases de datos para administrar las operaciones . Esto incluye:

• Mostrar detalles sobre una operación
• Operaciones de listado para una región
• Eliminar una operación

Servicio de migración de bases de datos y servicio de descubrimiento de API de Google

El servicio de descubrimiento de API de Google es un servicio que puede utilizar para descubrir las API de Google. Por ejemplo, cuando utiliza la herramienta Explorador de API de Google , está utilizando el servicio Discovery.

En Discovery Service, el servicio de migración de bases de datos se representa como "migración de datos" (por ejemplo: https://datamigration.googleapis.com/$discovery/rest?version=v1 ).