Información general
En esta página, se explica cómo usar la API de Database Migration Service para gestionar los perfiles de conexión de una base de datos de origen de PostgreSQL y un destino de AlloyDB.
Hay dos formas de usar la API de Database Migration Service. Puedes hacer llamadas a la API REST o usar Google Cloud CLI (CLI).
Para ver información general sobre el uso de gcloud
para gestionar los perfiles de conexión de Database Migration Service, haz clic aquí.
Crear un perfil de conexión para una base de datos de origen PostgreSQL
A continuación, se muestra una solicitud para crear un perfil de conexión de una base de datos de origen de PostgreSQL.
REST
Antes de usar los datos de la solicitud, haz las siguientes sustituciones:
- project-id: el ID del proyecto
- region: la región del proyecto
- connection-profile-id: ID de perfil de conexión
- connection-profile-display-name: el nombre visible del perfil de conexión
- host-ip-address: la dirección IP de origen
- username: nombre de usuario de la base de datos
- password: la contraseña del usuario de la base de datos
Método HTTP y URL:
POST https://datamigration.googleapis.com/v1/projects/project-id/locations/region/connectionProfiles?connectionProfileId=connection-profile-id
Cuerpo JSON de la solicitud:
Para enviar tu solicitud, despliega una de estas opciones:
Deberías recibir una respuesta JSON similar a la siguiente:
{ "name": "projects/project-id/locations/region/operations/operation-1591973161667-5a7e422cb0ba4-3004980d-2ae97165", "metadata": { "@type": "type.googleapis.com/google.cloud.clouddms.v1.OperationMetadata", "createTime": "2020-06-12T14:46:01.744267779Z", "target": "projects/project-id/locations/region/connectionProfiles/connection-profile-id", "verb": "create", "requestedCancellation": false, "apiVersion": "v1" }, "done": false }
gcloud
Para ver información general sobre cómo usar gcloud
para crear perfiles de conexión de Database Migration Service, haz clic aquí.
Una vez creado, puedes ver la información sobre tu perfil de conexión
llamando al método connectionProfiles/get
.
REST
Antes de usar los datos de la solicitud, haz las siguientes sustituciones:
- project-id: el ID del proyecto
- region: la región del proyecto
- connection-profile-id: ID de perfil de conexión
Método HTTP y URL:
GET https://datamigration.googleapis.com/v1/projects/project-id/locations/region/connectionProfiles/connection-profile-id
Para enviar tu solicitud, despliega una de estas opciones:
Deberías recibir una respuesta JSON similar a la siguiente:
gcloud
Para obtener más información sobre cómo usar gcloud
para recuperar información sobre tu perfil de conexión, haz clic aquí.
Crear un perfil de conexión para una base de datos de origen de Cloud SQL para PostgreSQL
A continuación, se muestra una solicitud para crear un perfil de conexión para una base de datos de origen de Cloud SQL para PostgreSQL. En este ejemplo se usa un perfil de conexión de PostgreSQL porque se conecta al motor de base de datos de PostgreSQL y no a la capa de gestión de Cloud SQL.
Para crear la vinculación entre el origen y la réplica con Cloud SQL, debes proporcionar el ID de instancia de tu base de datos de Cloud SQL. Para encontrar el valor del ID de instancia, usa el método
databases/list
de la API Admin de Cloud SQL.
REST
Antes de usar los datos de la solicitud, haz las siguientes sustituciones:
- project-id: el ID del proyecto
- region: la región del proyecto
- connection-profile-id: ID de perfil de conexión
- connection-profile-display-name: el nombre visible del perfil de conexión
- host-ip-address: la dirección IP de origen
- username: nombre de usuario de la base de datos
- password: la contraseña del usuario de la base de datos
- cloud-sql-instance-id: el ID de la instancia de Cloud SQL
Método HTTP y URL:
POST https://datamigration.googleapis.com/v1/projects/project-id/locations/region/connectionProfiles?connectionProfileId=connection-profile-id
Cuerpo JSON de la solicitud:
Para enviar tu solicitud, despliega una de estas opciones:
Deberías recibir una respuesta JSON similar a la siguiente:
{ "name": "projects/project-id/locations/region/operations/operation-1591973161667-5a7e422cb0ba4-3004980d-2ae97165", "metadata": { "@type": "type.googleapis.com/google.cloud.clouddms.v1.OperationMetadata", "createTime": "2020-06-12T14:46:01.744267779Z", "target": "projects/project-id/locations/region/connectionProfiles/connection-profile-id", "verb": "create", "requestedCancellation": false, "apiVersion": "v1" }, "done": false }
gcloud
Para ver información general sobre cómo usar gcloud
para crear perfiles de conexión de Database Migration Service, haz clic aquí.
Crear un perfil de conexión para un destino de AlloyDB para PostgreSQL
A continuación, se muestra una solicitud para crear un perfil de conexión para un destino de AlloyDB para PostgreSQL. Database Migration Service usa la información de esta solicitud para crear una instancia de AlloyDB.
REST
Antes de usar los datos de la solicitud, haz las siguientes sustituciones:
- project-id: el ID del proyecto
- region: la región del proyecto
- connection-profile-id: ID de perfil de conexión
- connection-profile-display-name: el nombre visible del perfil de conexión
- cluster-id: el ID del clúster de AlloyDB que se va a crear
- user: nombre de usuario que se le asignará al usuario inicial.
- password: contraseña que se asignará al usuario inicial.
- vpc-network: la red de VPC a la que se conectará el clúster de AlloyDB
- instance-id: ID de la instancia de AlloyDB que se va a crear.
- cpu-count: número de CPUs con las que se configurará la instancia.
Todos los datos almacenados en Google Cloud se cifran en reposo con los mismos sistemas reforzados de gestión de claves que utilizamos para proteger nuestros propios datos cifrados. Estos sistemas de gestión de claves proporcionan estrictos controles de acceso a claves y auditorías, y cifran los datos de los usuarios en reposo con los estándares de cifrado AES-256. No se requiere ninguna configuración ni gestión. Google CloudEl cifrado predeterminado en reposo de Google Cloudes la mejor opción para los usuarios que no tienen requisitos específicos relacionados con el cumplimiento o la ubicación del material criptográfico.
Método HTTP y URL:
POST https://datamigration.googleapis.com/v1/projects/project-id/locations/region/connectionProfiles?connectionProfileId=connection-profile-id
Cuerpo JSON de la solicitud:
{ "displayName": "connection-profile-display-name", "alloydb": { "cluster_id": "cluster-id" "settings": { "initial_user": { "user": "user", "password": "password", } "vpc_network": "vpc-network", "primary_instance_settings": { "id": "instance-id", "machine_config": { "cpu_count": cpu-count } } } } }
Para enviar tu solicitud, despliega una de estas opciones:
Deberías recibir una respuesta JSON similar a la siguiente:
{ "name": "projects/project-id/locations/region/operations/operation-1591975557292-5a7e4b195623c-e350e3da-713dee7d", "metadata": { "@type": "type.googleapis.com/google.cloud.clouddms.v1.OperationMetadata", "createTime": "2020-06-12T15:25:57.430715421Z", "target": "projects/project-id/locations/region/connectionProfiles/connection-profile-id", "verb": "create", "requestedCancellation": false, "apiVersion": "v1" }, "done": false }
gcloud
Para ver información general sobre cómo usar gcloud
para crear perfiles de conexión de Database Migration Service, haz clic aquí.
Obtener información sobre un perfil de conexión
REST
Antes de usar los datos de la solicitud, haz las siguientes sustituciones:
- project-id: el ID del proyecto
- region: la región del proyecto
- connection-profile-id: ID de perfil de conexión
Método HTTP y URL:
GET https://datamigration.googleapis.com/v1/projects/project-id/locations/region/connectionProfiles/connection-profile-id
Para enviar tu solicitud, despliega una de estas opciones:
Deberías recibir una respuesta JSON similar a la siguiente:
gcloud
Para obtener más información sobre cómo usar gcloud
para recuperar información sobre tu perfil de conexión, haz clic aquí.
Mostrar perfiles de conexión
A continuación, se muestra una solicitud para obtener información sobre todos tus perfiles de conexión.
REST
Antes de usar los datos de la solicitud, haz las siguientes sustituciones:
- project-id: el ID del proyecto
- region: la región del proyecto
orderBy:
Usa este filtro para obtener una lista de todos los perfiles de conexión de una región concreta en orden alfabético. Por ejemplo, el filtroorderBy=name
devuelve todos los perfiles de conexión por orden alfabético según el nombre.-
pageSize:
Use este filtro para especificar el número máximo de perfiles de conexión que recupera y muestra el servicio de migración de bases de datos en una página. Por ejemplo, si se definepageSize=10
, el servicio de migración de bases de datos devolverá hasta 10 perfiles de conexión por página.
Si hay más de 10 perfiles de conexión, aparecerán en otras páginas. Al final de cada página, aparecen un parámetro nextPageToken
y un identificador único. Usa el identificador para obtener la lista de perfiles de conexión de la página siguiente.
Método HTTP y URL:
GET https://datamigration.googleapis.com/v1/projects/project-id/locations/region/connectionProfiles
Para enviar tu solicitud, despliega una de estas opciones:
Deberías recibir una respuesta JSON similar a la siguiente:
gcloud
Para obtener más información sobre cómo usar gcloud
para recuperar información sobre todos tus perfiles de conexión, haz clic aquí.
Actualizar un perfil de conexión
A continuación, se muestra una solicitud para actualizar los campos de nombre de usuario y contraseña de un perfil de conexión. Si usas el parámetro updateMask
en la solicitud, solo tendrás que incluir estos campos en el cuerpo de la solicitud.
REST
Antes de usar los datos de la solicitud, haz las siguientes sustituciones:
- project-id: el ID del proyecto
- region: la región del proyecto
- connection-profile-id: ID de perfil de conexión
- username: nombre de usuario de la base de datos
- password: la contraseña del usuario de la base de datos
Método HTTP y URL:
PATCH
Cuerpo JSON de la solicitud:
Para enviar tu solicitud, despliega una de estas opciones:
Deberías recibir una respuesta JSON similar a la siguiente:
{ "name": "projects/project-id/locations/region/operations/operation-1591973161667-5a7e422cb0ba4-3004980d-2ae97165", "metadata": { "@type": "type.googleapis.com/google.cloud.clouddms.v1.OperationMetadata", "createTime": "2020-06-12T14:46:01.744267779Z", "target": "projects/project-id/locations/region/connectionProfiles/connection-profile-id", "verb": "update", "requestedCancellation": false, "apiVersion": "v1" }, "done": false }
gcloud
Para obtener más información sobre cómo usar gcloud
para actualizar tu perfil de conexión, haz clic aquí.
Eliminar un perfil de conexión
REST
Antes de usar los datos de la solicitud, haz las siguientes sustituciones:
- project-id: el ID del proyecto
- region: la región del proyecto
- connection-profile-id: ID de perfil de conexión
Método HTTP y URL:
DELETE https://datamigration.googleapis.com/v1/projects/project-id/locations/region/connectionProfiles/connection-profile-id
Para enviar tu solicitud, despliega una de estas opciones:
Deberías recibir una respuesta JSON similar a la siguiente:
{ "name": "projects/project-id/locations/region/operations/operation-1591973161667-5a7e422cb0ba4-3004980d-2ae97165", "metadata": { "@type": "type.googleapis.com/google.cloud.clouddms.v1.OperationMetadata", "createTime": "2020-06-12T14:46:01.744267779Z", "target": "projects/project-id/locations/region/connectionProfiles/connection-profile-id", "verb": "delete", "requestedCancellation": false, "apiVersion": "v1" }, "done": false }
gcloud
Para obtener más información sobre cómo usar gcloud
para eliminar tu perfil de conexión, haz clic aquí.
Eliminar un perfil de conexión y la instancia de AlloyDB asociada
A continuación, se muestra una solicitud para eliminar un perfil de conexión de destino, así como para eliminar en cascada la instancia de AlloyDB asociada.
REST
Antes de usar los datos de la solicitud, haz las siguientes sustituciones:
- project-id: el ID del proyecto
- region: la región del proyecto
- connection-profile-id: ID de perfil de conexión
Método HTTP y URL:
DELETE https://datamigration.googleapis.com/v1/projects/project-id/locations/region/connectionProfiles/connection-profile-id?force=true
Para enviar tu solicitud, despliega una de estas opciones:
Deberías recibir una respuesta JSON similar a la siguiente:
{ "name": "projects/project-id/locations/region/operations/operation-1591973161667-5a7e422cb0ba4-3004980d-2ae97165", "metadata": { "@type": "type.googleapis.com/google.cloud.clouddms.v1.OperationMetadata", "createTime": "2020-06-12T14:46:01.744267779Z", "target": "projects/project-id/locations/region/connectionProfiles/connection-profile-id", "verb": "create", "requestedCancellation": false, "apiVersion": "v1" }, "done": false }
gcloud
Para obtener más información sobre cómo usar gcloud
para eliminar tanto tu perfil de conexión como la instancia de AlloyDB asociada, haz clic aquí.