Esta página foi traduzida pela API Cloud Translation.

Gerenciar perfis de conexão usando a API

MySQL | PostgreSQL | PostgreSQL para AlloyDB

Visão geral

Nesta página, você vai aprender a usar a API Database Migration Service para gerenciar perfis de conexão de um banco de dados de origem PostgreSQL e um destino do AlloyDB.

Há duas maneiras de usar a API Database Migration Service. É possível fazer chamadas da API REST ou usar a Google Cloud CLI (CLI).

Para ver informações gerais sobre como usar o gcloud para gerenciar perfis de conexão do Database Migration Service, clique aqui.

Criar um perfil de conexão para um banco de dados de origem do PostgreSQL

A seguir, mostramos uma solicitação para criar um perfil de conexão para um banco de dados de origem do PostgreSQL.

REST

Antes de usar os dados da solicitação abaixo, faça as substituições a seguir:

project-id: o ID do projeto
region: a região do projeto
connection-profile-id: o ID do perfil de conexão
connection-profile-display-name: o nome de exibição do perfil de conexão
host-ip-address: o endereço IP de origem
username: o nome do usuário do banco de dados.
password: a senha do usuário do banco de dados

Método HTTP e URL:

POST https://datamigration.googleapis.com/v1/projects/project-id/locations/region/connectionProfiles?connectionProfileId=connection-profile-id

Corpo JSON da solicitação:

Para enviar a solicitação, expanda uma destas opções:

curl (Linux, macOS ou Cloud Shell)

Observação: o comando a seguir pressupõe que você tenha feito login na CLI do gcloud com sua conta de usuário executando gcloud init ou gcloud auth login, ou usando o Cloud Shell, que faz login automaticamente na CLI gcloud. . Para saber qual é a conta ativa no momento, execute o comando gcloud auth list.

Salve o corpo da solicitação em um arquivo com o nome request.json e execute o comando a seguir:

curl -X POST \
     -H "Authorization: Bearer $(gcloud auth print-access-token)" \
     -H "Content-Type: application/json; charset=utf-8" \
     -d @request.json \
     "https://datamigration.googleapis.com/v1/projects/project-id/locations/region/connectionProfiles?connectionProfileId=connection-profile-id"

PowerShell (Windows)

Observação: o comando a seguir pressupõe que você tenha feito login na CLI gcloud com sua conta de usuário executando gcloud init ou gcloud auth login . Para saber qual é a conta ativa no momento, execute o comando gcloud auth list.

Salve o corpo da solicitação em um arquivo com o nome request.json e execute o comando a seguir:

$cred = gcloud auth print-access-token
$headers = @{ "Authorization" = "Bearer $cred" }

Invoke-WebRequest `
    -Method POST `
    -Headers $headers `
    -ContentType: "application/json; charset=utf-8" `
    -InFile request.json `
    -Uri "https://datamigration.googleapis.com/v1/projects/project-id/locations/region/connectionProfiles?connectionProfileId=connection-profile-id" | Select-Object -Expand Content

Você receberá uma resposta JSON semelhante a esta:

{
  "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 informações gerais sobre como usar o gcloud para criar perfis de conexão do Database Migration Service, clique aqui.

Depois da criação, é possível conferir as informações sobre o perfil de conexão chamando o método connectionProfiles/get.

REST

Antes de usar os dados da solicitação abaixo, faça as substituições a seguir:

project-id: o ID do projeto
region: a região do projeto
connection-profile-id: o ID do perfil de conexão

Método HTTP e URL:

GET https://datamigration.googleapis.com/v1/projects/project-id/locations/region/connectionProfiles/connection-profile-id

Para enviar a solicitação, expanda uma destas opções:

curl (Linux, macOS ou Cloud Shell)

execute o seguinte comando:

curl -X GET \
     -H "Authorization: Bearer $(gcloud auth print-access-token)" \
     "https://datamigration.googleapis.com/v1/projects/project-id/locations/region/connectionProfiles/connection-profile-id"

PowerShell (Windows)

execute o seguinte comando:

$cred = gcloud auth print-access-token
$headers = @{ "Authorization" = "Bearer $cred" }

Invoke-WebRequest `
    -Method GET `
    -Headers $headers `
    -Uri "https://datamigration.googleapis.com/v1/projects/project-id/locations/region/connectionProfiles/connection-profile-id" | Select-Object -Expand Content

Você receberá uma resposta JSON semelhante a esta:

gcloud

Para saber como usar o gcloud para recuperar informações sobre o perfil de conexão, clique aqui.

Criar um perfil de conexão para um banco de dados de origem do Cloud SQL para PostgreSQL

A seguir, mostramos uma solicitação para criar um perfil de conexão de um banco de dados de origem do Cloud SQL para PostgreSQL. Este exemplo usa um perfil de conexão do PostgreSQL porque ele se conecta ao mecanismo de banco de dados do PostgreSQL, e não à camada de gerenciamento do Cloud SQL.

Para criar o pareamento entre a origem e a réplica usando o Cloud SQL, forneça o ID da instância do seu banco de dados do Cloud SQL. Para encontrar o valor do ID da instância, use o método databases/list da API Cloud SQL Admin.

REST

Antes de usar os dados da solicitação abaixo, faça as substituições a seguir:

project-id: o ID do projeto
region: a região do projeto
connection-profile-id: o ID do perfil de conexão
connection-profile-display-name: o nome de exibição do perfil de conexão
host-ip-address: o endereço IP de origem
username: o nome do usuário do banco de dados.
password: a senha do usuário do banco de dados
cloud-sql-instance-id: o ID da instância do Cloud SQL

Método HTTP e URL:

POST https://datamigration.googleapis.com/v1/projects/project-id/locations/region/connectionProfiles?connectionProfileId=connection-profile-id

Corpo JSON da solicitação:

Para enviar a solicitação, expanda uma destas opções:

curl (Linux, macOS ou Cloud Shell)

Salve o corpo da solicitação em um arquivo com o nome request.json e execute o comando a seguir:

curl -X POST \
     -H "Authorization: Bearer $(gcloud auth print-access-token)" \
     -H "Content-Type: application/json; charset=utf-8" \
     -d @request.json \
     "https://datamigration.googleapis.com/v1/projects/project-id/locations/region/connectionProfiles?connectionProfileId=connection-profile-id"

PowerShell (Windows)

Salve o corpo da solicitação em um arquivo com o nome request.json e execute o comando a seguir:

$cred = gcloud auth print-access-token
$headers = @{ "Authorization" = "Bearer $cred" }

Invoke-WebRequest `
    -Method POST `
    -Headers $headers `
    -ContentType: "application/json; charset=utf-8" `
    -InFile request.json `
    -Uri "https://datamigration.googleapis.com/v1/projects/project-id/locations/region/connectionProfiles?connectionProfileId=connection-profile-id" | Select-Object -Expand Content

Você receberá uma resposta JSON semelhante a esta:

{
  "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 informações gerais sobre como usar o gcloud para criar perfis de conexão do Database Migration Service, clique aqui.

Criar um perfil de conexão para um destino do AlloyDB para PostgreSQL

A seguir, mostramos uma solicitação para criar um perfil de conexão de um destino do AlloyDB para PostgreSQL. O Database Migration Service usa as informações desta solicitação para criar uma instância do AlloyDB.

REST

Antes de usar os dados da solicitação abaixo, faça as substituições a seguir:

project-id: o ID do projeto
region: a região do projeto
connection-profile-id: o ID do perfil de conexão
connection-profile-display-name: o nome de exibição do perfil de conexão
cluster-id: o ID do cluster do AlloyDB a ser criado
user: o nome de usuário a ser atribuído ao usuário inicial
password: a senha do usuário inicial
vpc-network: a rede VPC a que o cluster do AlloyDB será conectado
instance-id: o ID da instância do AlloyDB a ser criada
cpu-count: o número de CPUs para configurar a instância

Todos os dados armazenados em Google Cloud são criptografados em repouso usando os mesmos sistemas de gerenciamento de chaves protegidos que usamos para nossos próprios dados criptografados. Esses sistemas de gerenciamento de chaves fornecem controles de auditoria e chaves de acesso rigorosos e criptografam dados do usuário em repouso usando padrões de criptografia AES-256. Nenhuma configuração ou gerenciamento é necessário.A criptografia padrão em repouso do Google Cloudé a melhor opção para usuários que não têm requisitos específicos relacionados à conformidade ou à localização do material criptográfico.

Método HTTP e URL:

POST https://datamigration.googleapis.com/v1/projects/project-id/locations/region/connectionProfiles?connectionProfileId=connection-profile-id

Corpo JSON da solicitação:

{
  "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 a solicitação, expanda uma destas opções:

curl (Linux, macOS ou Cloud Shell)

Salve o corpo da solicitação em um arquivo com o nome request.json e execute o comando a seguir:

curl -X POST \
     -H "Authorization: Bearer $(gcloud auth print-access-token)" \
     -H "Content-Type: application/json; charset=utf-8" \
     -d @request.json \
     "https://datamigration.googleapis.com/v1/projects/project-id/locations/region/connectionProfiles?connectionProfileId=connection-profile-id"

PowerShell (Windows)

Salve o corpo da solicitação em um arquivo com o nome request.json e execute o comando a seguir:

$cred = gcloud auth print-access-token
$headers = @{ "Authorization" = "Bearer $cred" }

Invoke-WebRequest `
    -Method POST `
    -Headers $headers `
    -ContentType: "application/json; charset=utf-8" `
    -InFile request.json `
    -Uri "https://datamigration.googleapis.com/v1/projects/project-id/locations/region/connectionProfiles?connectionProfileId=connection-profile-id" | Select-Object -Expand Content

Você receberá uma resposta JSON semelhante a esta:

{
  "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 informações gerais sobre como usar o gcloud para criar perfis de conexão do Database Migration Service, clique aqui.

Receber informações sobre um perfil de conexão

REST

Antes de usar os dados da solicitação abaixo, faça as substituições a seguir:

project-id: o ID do projeto
region: a região do projeto
connection-profile-id: o ID do perfil de conexão

Método HTTP e URL:

GET https://datamigration.googleapis.com/v1/projects/project-id/locations/region/connectionProfiles/connection-profile-id

Para enviar a solicitação, expanda uma destas opções:

curl (Linux, macOS ou Cloud Shell)

execute o seguinte comando:

curl -X GET \
     -H "Authorization: Bearer $(gcloud auth print-access-token)" \
     "https://datamigration.googleapis.com/v1/projects/project-id/locations/region/connectionProfiles/connection-profile-id"

PowerShell (Windows)

execute o seguinte comando:

$cred = gcloud auth print-access-token
$headers = @{ "Authorization" = "Bearer $cred" }

Invoke-WebRequest `
    -Method GET `
    -Headers $headers `
    -Uri "https://datamigration.googleapis.com/v1/projects/project-id/locations/region/connectionProfiles/connection-profile-id" | Select-Object -Expand Content

Você receberá uma resposta JSON semelhante a esta:

gcloud

Para saber como usar o gcloud para recuperar informações sobre o perfil de conexão, clique aqui.

Listar perfis de conexão

O exemplo a seguir mostra uma solicitação para recuperar informações sobre todos os perfis de conexão.

REST

Antes de usar os dados da solicitação abaixo, faça as substituições a seguir:

project-id: o ID do projeto
region: a região do projeto

Também é possível filtrar a lista de perfis de conexão recuperados pelo Database Migration Service da seguinte maneira:

orderBy: Use este filtro para recuperar uma lista de todos os perfis de conexão de uma região específica em ordem alfabética. Por exemplo, o filtro orderBy=name retorna todos os perfis de conexão em ordem alfabética por nome.
pageSize: Use este filtro para especificar o número máximo de perfis de conexão que o Database Migration Service recupera e mostra em uma página. Por exemplo, ao definir pageSize=10, o Database Migration Service vai retornar até 10 perfis de conexão para uma página.

Se houver mais de 10 perfis de conexão, eles vão aparecer em outras páginas. No final de cada página, um parâmetro nextPageToken e um identificador exclusivo aparecem. Use o identificador para extrair a lista de perfis de conexão da página a seguir.

Método HTTP e URL:

GET https://datamigration.googleapis.com/v1/projects/project-id/locations/region/connectionProfiles

Para enviar a solicitação, expanda uma destas opções:

curl (Linux, macOS ou Cloud Shell)

execute o seguinte comando:

curl -X GET \
     -H "Authorization: Bearer $(gcloud auth print-access-token)" \
     "https://datamigration.googleapis.com/v1/projects/project-id/locations/region/connectionProfiles"

PowerShell (Windows)

execute o seguinte comando:

$cred = gcloud auth print-access-token
$headers = @{ "Authorization" = "Bearer $cred" }

Invoke-WebRequest `
    -Method GET `
    -Headers $headers `
    -Uri "https://datamigration.googleapis.com/v1/projects/project-id/locations/region/connectionProfiles" | Select-Object -Expand Content

Você receberá uma resposta JSON semelhante a esta:

gcloud

Para saber como usar o gcloud para recuperar informações sobre todos os seus perfis de conexão, clique aqui.

Atualizar um perfil de conexão

A seguir, mostramos uma solicitação para atualizar os campos de nome de usuário e senha de um perfil de conexão existente. Usando o parâmetro updateMask na solicitação, apenas esses campos precisam ser incluídos no corpo da solicitação.

REST

Antes de usar os dados da solicitação abaixo, faça as substituições a seguir:

project-id: o ID do projeto
region: a região do projeto
connection-profile-id: o ID do perfil de conexão
username: o nome do usuário do banco de dados.
password: a senha do usuário do banco de dados

Método HTTP e URL:

PATCH

Corpo JSON da solicitação:

Para enviar a solicitação, expanda uma destas opções:

curl (Linux, macOS ou Cloud Shell)

Salve o corpo da solicitação em um arquivo com o nome request.json e execute o comando a seguir:

curl -X PATCH \
     -H "Authorization: Bearer $(gcloud auth print-access-token)" \
     -H "Content-Type: application/json; charset=utf-8" \
     -d @request.json \
     ""

PowerShell (Windows)

Salve o corpo da solicitação em um arquivo com o nome request.json e execute o comando a seguir:

$cred = gcloud auth print-access-token
$headers = @{ "Authorization" = "Bearer $cred" }

Invoke-WebRequest `
    -Method PATCH `
    -Headers $headers `
    -ContentType: "application/json; charset=utf-8" `
    -InFile request.json `
    -Uri "" | Select-Object -Expand Content

Você receberá uma resposta JSON semelhante a esta:

{
  "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 saber como usar o gcloud para atualizar seu perfil de conexão, clique aqui.

Excluir um perfil de conexão

Importante:só é possível excluir um perfil de conexão se não houver jobs de migração ativos associados a ele. Se um perfil de conexão tiver jobs de migração ativos, promova ou exclua os jobs.

Para saber se um perfil de conexão tem jobs de migração ativos associados a ele, execute o seguinte comando:

GET https://datamigration.googleapis.com/v1/projects/project-id/locations/region/migrationJobs?filter=state:STATE_NAME OR state:STATE_NAME AND source:projects/project-id/locations/region/connectionProfiles/connection-profile-id

Exemplo:

GET https://datamigration.googleapis.com/v1/projects/myproject/locations/myregion/migrationJobs?filter=state:RUNNING OR state:FAILED AND source:projects/myproject/locations/myregion/connectionProfiles/postgresql-to-alloydb-src1

Os vários estados (status) do job de migração são:

NOT STARTED: O job de migração foi criado, mas ainda não foi iniciado.
STARTING: O job de migração está sendo iniciado.
RUNNING: O job de migração está em execução e pode ser usado para migrar dados do banco de dados de origem para o de destino.
STOPPING: O job de migração está sendo interrompido.
STOPPED: O job de migração está pausado e não está mais migrando dados para o banco de dados de destino.
RESUMING: O job de migração pausado está em execução.
FAILED: Ocorreu um problema durante a execução do job de migração.
RESTARTING: O Database Migration Service faz um novo snapshot do banco de dados de origem, carrega o despejo inicial no banco de dados de destino e processa as mudanças contínuas de dados do banco de dados de origem para o de destino.

Se um usuário tiver um job de migração em qualquer um desses status e tentar excluir o perfil de conexão, a ação vai falhar.

REST

Antes de usar os dados da solicitação abaixo, faça as substituições a seguir:

project-id: o ID do projeto
region: a região do projeto
connection-profile-id: o ID do perfil de conexão

Método HTTP e URL:

DELETE https://datamigration.googleapis.com/v1/projects/project-id/locations/region/connectionProfiles/connection-profile-id

Para enviar a solicitação, expanda uma destas opções:

curl (Linux, macOS ou Cloud Shell)

execute o seguinte comando:

curl -X DELETE \
     -H "Authorization: Bearer $(gcloud auth print-access-token)" \
     "https://datamigration.googleapis.com/v1/projects/project-id/locations/region/connectionProfiles/connection-profile-id"

PowerShell (Windows)

execute o seguinte comando:

$cred = gcloud auth print-access-token
$headers = @{ "Authorization" = "Bearer $cred" }

Invoke-WebRequest `
    -Method DELETE `
    -Headers $headers `
    -Uri "https://datamigration.googleapis.com/v1/projects/project-id/locations/region/connectionProfiles/connection-profile-id" | Select-Object -Expand Content

Você receberá uma resposta JSON semelhante a esta:

{
  "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 mais informações sobre como usar o gcloud para excluir seu perfil de conexão, clique aqui.

Excluir um perfil de conexão e a instância do AlloyDB associada

A seguir, mostramos uma solicitação para excluir um perfil de conexão de destino e excluir em cascata a instância associada do AlloyDB.

REST

Antes de usar os dados da solicitação abaixo, faça as substituições a seguir:

project-id: o ID do projeto
region: a região do projeto
connection-profile-id: o ID do perfil de conexão

Método HTTP e URL:

DELETE https://datamigration.googleapis.com/v1/projects/project-id/locations/region/connectionProfiles/connection-profile-id?force=true

Para enviar a solicitação, expanda uma destas opções:

curl (Linux, macOS ou Cloud Shell)

execute o seguinte comando:

curl -X DELETE \
     -H "Authorization: Bearer $(gcloud auth print-access-token)" \
     "https://datamigration.googleapis.com/v1/projects/project-id/locations/region/connectionProfiles/connection-profile-id?force=true"

PowerShell (Windows)

execute o seguinte comando:

$cred = gcloud auth print-access-token
$headers = @{ "Authorization" = "Bearer $cred" }

Invoke-WebRequest `
    -Method DELETE `
    -Headers $headers `
    -Uri "https://datamigration.googleapis.com/v1/projects/project-id/locations/region/connectionProfiles/connection-profile-id?force=true" | Select-Object -Expand Content

Você receberá uma resposta JSON semelhante a esta:

{
  "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 mais informações sobre como usar o gcloud para excluir seu perfil de conexão e a instância do AlloyDB associada, clique aqui.

Gerenciar perfis de conexão usando a API Mantenha tudo organizado com as coleções Salve e categorize o conteúdo com base nas suas preferências.

Visão geral

Criar um perfil de conexão para um banco de dados de origem do PostgreSQL

REST

curl (Linux, macOS ou Cloud Shell)

PowerShell (Windows)

gcloud

REST

curl (Linux, macOS ou Cloud Shell)

PowerShell (Windows)

gcloud

Criar um perfil de conexão para um banco de dados de origem do Cloud SQL para PostgreSQL

REST

curl (Linux, macOS ou Cloud Shell)

PowerShell (Windows)

gcloud

Criar um perfil de conexão para um destino do AlloyDB para PostgreSQL

REST

curl (Linux, macOS ou Cloud Shell)

PowerShell (Windows)

gcloud

Receber informações sobre um perfil de conexão

REST

curl (Linux, macOS ou Cloud Shell)

PowerShell (Windows)

gcloud

Listar perfis de conexão

REST

curl (Linux, macOS ou Cloud Shell)

PowerShell (Windows)

gcloud

Atualizar um perfil de conexão

REST

curl (Linux, macOS ou Cloud Shell)

PowerShell (Windows)

gcloud

Excluir um perfil de conexão

REST

curl (Linux, macOS ou Cloud Shell)

PowerShell (Windows)

gcloud

Excluir um perfil de conexão e a instância do AlloyDB associada

REST

curl (Linux, macOS ou Cloud Shell)

PowerShell (Windows)

gcloud

Gerenciar perfis de conexão usando a API