Descripción general
En esta página, aprenderás a usar la API de Database Migration Service para administrar perfiles de conexión para una base de datos de origen de PostgreSQL y un destino de AlloyDB.
Existen dos formas de usar la API de Database Migration Service. Puedes realizar llamadas a la API de REST o usar Google Cloud CLI (CLI).
Para ver información de alto nivel sobre el uso de gcloud
para administrar perfiles de conexión de Database Migration Service, haz clic aquí.
Crea un perfil de conexión para una base de datos de origen de PostgreSQL
A continuación, se muestra una solicitud para crear un perfil de conexión para una base de datos de origen de PostgreSQL.
REST
Antes de usar cualquiera de los datos de solicitud a continuación, realiza los siguientes reemplazos:
- project-id: el ID del proyecto
- region: La región del proyecto
- connection-profile-id: El ID del 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: El 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, expande una de estas opciones:
Deberías recibir una respuesta JSON similar a la que se muestra a continuación:
{ "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 detallada sobre el uso de gcloud
para crear perfiles de conexión de Database Migration Service, haz clic aquí.
Después de la creación, puedes ver la información sobre tu perfil de conexión llamando al método connectionProfiles/get
.
REST
Antes de usar cualquiera de los datos de solicitud a continuación, realiza los siguientes reemplazos:
- project-id: el ID del proyecto
- region: La región del proyecto
- connection-profile-id: El ID del 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, expande una de estas opciones:
Deberías recibir una respuesta JSON similar a la que se muestra a continuación:
gcloud
Si deseas obtener más información sobre el uso de gcloud
para recuperar información sobre tu perfil de conexión, haz clic aquí.
Crea 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 administración de Cloud SQL.
Para crear la vinculación entre la fuente y la réplica con
Cloud SQL, debes proporcionar el ID de instancia de tu
base de datos de Cloud SQL. Puedes encontrar el valor del ID de la instancia con el método databases/list
de la API de Cloud SQL Admin.
REST
Antes de usar cualquiera de los datos de solicitud a continuación, realiza los siguientes reemplazos:
- project-id: el ID del proyecto
- region: La región del proyecto
- connection-profile-id: El ID del 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: El nombre de usuario de la base de datos
- password: La contraseña del usuario de la base de datos
- cloud-sql-instance-id: Es 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, expande una de estas opciones:
Deberías recibir una respuesta JSON similar a la que se muestra a continuación:
{ "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 detallada sobre el uso de gcloud
para crear perfiles de conexión de Database Migration Service, haz clic aquí.
Crea 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 nueva instancia de AlloyDB.
REST
Antes de usar cualquiera de los datos de solicitud a continuación, realiza los siguientes reemplazos:
- project-id: el ID del proyecto
- region: La región del proyecto
- connection-profile-id: El ID del perfil de conexión
- connection-profile-display-name: El nombre visible del perfil de conexión
- cluster-id: Es el ID del clúster de AlloyDB que se creará.
- user: Es el nombre de usuario que se le asignará al usuario inicial.
- password: Es la contraseña que se le dará al usuario inicial.
- vpc-network: Es la red de VPC con la que se conectará el clúster de AlloyDB.
- instance-id: Es el ID de la instancia de AlloyDB que se creará.
- cpu-count: Es la cantidad de CPUs con las que se configurará la instancia.
Todos los datos almacenados en Google Cloud están encriptados en reposo con los mismos sistemas de administración de claves endurecidos que usamos para nuestros propios datos encriptados. Estos sistemas de administración de claves proporcionan auditorías y controles de acceso a claves estrictos, y encriptan los datos en reposo del usuario con estándares de encriptación AES-256. No se requiere configuración ni administración.La encriptación en reposo predeterminada de Google Cloudes la mejor opción para los usuarios que no tienen requisitos específicos relacionados con el cumplimiento o la localidad 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, expande una de estas opciones:
Deberías recibir una respuesta JSON similar a la que se muestra a continuación:
{ "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 detallada sobre el uso de gcloud
para crear perfiles de conexión de Database Migration Service, haz clic aquí.
Obtén información sobre un perfil de conexión
REST
Antes de usar cualquiera de los datos de solicitud a continuación, realiza los siguientes reemplazos:
- project-id: el ID del proyecto
- region: La región del proyecto
- connection-profile-id: El ID del 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, expande una de estas opciones:
Deberías recibir una respuesta JSON similar a la que se muestra a continuación:
gcloud
Si deseas obtener más información sobre el uso de gcloud
para recuperar información sobre tu perfil de conexión, haz clic aquí.
Enumera perfiles de conexión
A continuación, se muestra una solicitud para recuperar información sobre todos tus perfiles de conexión.
REST
Antes de usar cualquiera de los datos de solicitud a continuación, realiza los siguientes reemplazos:
- project-id: el ID del proyecto
- region: La región del proyecto
orderBy:
Usa este filtro para recuperar una lista de todos los perfiles de conexión de una región en particular en orden alfabético. Por ejemplo, el filtroorderBy=name
muestra todos los perfiles de conexión, alfabéticamente, por nombre.-
pageSize:
Usa este filtro para especificar la cantidad máxima de perfiles de conexión que recupera y muestra Database Migration Service en una página. Por ejemplo, si configuraspageSize=10
, Database Migration Service mostrará hasta 10 perfiles de conexión para una 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 recuperar la lista de los perfiles de conexión de la siguiente página.
Método HTTP y URL:
GET https://datamigration.googleapis.com/v1/projects/project-id/locations/region/connectionProfiles
Para enviar tu solicitud, expande una de estas opciones:
Deberías recibir una respuesta JSON similar a la que se muestra a continuación:
gcloud
Si deseas obtener más información sobre el uso de gcloud
para recuperar información sobre todos tus perfiles de conexión, haz clic aquí.
Actualiza 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 existente. Cuando usas el parámetro updateMask
en la solicitud, solo se deben incluir estos campos en el cuerpo de la solicitud.
REST
Antes de usar cualquiera de los datos de solicitud a continuación, realiza los siguientes reemplazos:
- project-id: el ID del proyecto
- region: La región del proyecto
- connection-profile-id: El ID del perfil de conexión
- username: El 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, expande una de estas opciones:
Deberías recibir una respuesta JSON similar a la que se muestra a continuación:
{ "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
Si deseas obtener más información para usar gcloud
y actualizar tu perfil de conexión, haz clic aquí.
Borrar un perfil de conexión
REST
Antes de usar cualquiera de los datos de solicitud a continuación, realiza los siguientes reemplazos:
- project-id: el ID del proyecto
- region: La región del proyecto
- connection-profile-id: El ID del 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, expande una de estas opciones:
Deberías recibir una respuesta JSON similar a la que se muestra a continuación:
{ "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
Si deseas obtener más información para usar gcloud
y borrar tu perfil de conexión, haz clic aquí.
Borra un perfil de conexión y la instancia de AlloyDB asociada
A continuación, se muestra una solicitud para borrar un perfil de conexión de destino, así como borrar de forma intercalada la instancia asociada de AlloyDB.
REST
Antes de usar cualquiera de los datos de solicitud a continuación, realiza los siguientes reemplazos:
- project-id: el ID del proyecto
- region: La región del proyecto
- connection-profile-id: El ID del 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, expande una de estas opciones:
Deberías recibir una respuesta JSON similar a la que se muestra a continuación:
{ "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
Si deseas obtener más información para usar gcloud
y borrar tu perfil de conexión y la instancia de AlloyDB asociada, haz clic aquí.