O Database Migration Service fornece uma API REST para administrar seus perfis de conexão e tarefas de migração programaticamente. A API REST é definida por recursos associados à criação e ao gerenciamento de perfis de conexão e tarefas de migração. Para obter detalhes sobre todos os recursos e seus métodos, consulte a Referência da API do Database Migration Service .
Ao enviar solicitações diretamente para a API REST do Serviço de Migração de Banco de Dados, você deve criar o formulário correto da solicitação, autorizá-la como um usuário autenticado e processar todas as respostas retornadas. Muitas das tarefas nesta documentação fornecem exemplos de API usando cURL .
Para mais exemplos de uso das APIs, consulte a página da solicitação na Referência de API do Serviço de Migração de Banco de Dados . Cada página contém exemplos de chamadas da API em diversas linguagens de programação, além de um Explorador específico para cada solicitação, para ajudar você a entender o que compõe uma solicitação bem-formatada e o que esperar da resposta.
Você também está usando a API do Database Migration Service, indiretamente, quando usa qualquer uma das seguintes maneiras de administrar instâncias:
Google Cloud CLI : uma interface de linha de comando (CLI) que você pode usar para trabalhar com suas instâncias.
Google Cloud console : Uma interface gráfica web.
A vantagem de usar esses métodos, especialmente oGoogle Cloud console, é que eles podem simplificar bastante a administração dos seus perfis de conexão e tarefas de migração (dependendo do seu caso de uso). Se você está começando a usar o Database Migration Service, recomendamos que comece com uma dessas ferramentas antes de trabalhar diretamente com a API REST.
Habilitar a API
Para usar a API do Serviço de Migração de Banco de Dados, você precisa habilitá-la:
Console
- Habilitar a API do Serviço de Migração de Banco de Dados .
- Selecione seu projeto.
- Selecione Continuar .
gcloud
- Digite o seguinte para exibir os IDs do projeto para seu Google Cloudprojetos:
gcloud projects list
- Defina seu projeto padrão:
gcloud config set project YOUR_PROJECT_ID
- Habilite a API de administração do Cloud SQL:
gcloud services enable datamigration.googleapis.com
Permissões
Você precisa ter as permissões necessárias para usar a API do Serviço de Migração de Banco de Dados. Essas permissões incluem:
- Administrador de migração de banco de dados: com essa permissão, um usuário obtém acesso a todos os recursos do serviço de migração de banco de dados usados para gerenciar perfis de conexão e trabalhos de migração.
- Visualizador de Migração de Banco de Dados: com essa permissão, um usuário tem acesso somente leitura aos perfis de conexão e trabalhos de migração no Serviço de Migração de Banco de Dados.
- Administrador do Cloud SQL: com essa permissão, um usuário pode criar e gerenciar perfis de conexão e tarefas de migração para o Cloud SQL no Database Migration Service.
Google Cloud oferece Gerenciamento de Identidade e Acesso (IAM), que permite que você forneça acesso mais granular a dados específicos Google Cloud recursos e impede o acesso indesejado a outros recursos. Você pode obter e definir permissões para o Serviço de Migração de Banco de Dados usando o Google Cloud console, os métodos do IAM da API ou a Google Cloud CLI. Para obter mais informações, consulte Conceder, alterar e revogar acesso a recursos .
Fornecer dados JSON de um arquivo
Ao usar a API com cURL, você fornece valores de propriedade usando a linha de comando. Se estiver trabalhando com valores confidenciais, como senhas ou chaves de segurança, fornecê-los na linha de comando representa um risco à segurança. Para maior segurança, você pode criar um arquivo contendo os dados JSON para a chamada da API e fornecer o caminho para o arquivo na linha de comando.
Para fornecer dados JSON para sua chamada de API cURL de um arquivo:
Crie um arquivo contendo tudo entre aspas simples para o campo
--data
.Inclua as chaves, mas não as aspas simples.
Na linha de comando, forneça o caminho para o arquivo, precedido pelo caractere
@
, como o parâmetro--data
:--data @<path-to-file>/<filename>
Trabalhar com chamadas de API de longa duração
Algumas chamadas de API, como a criação de objetos, podem levar algum tempo para serem concluídas. Como a API é assíncrona, a chamada retorna imediatamente, mesmo que a operação ainda esteja em andamento. Se uma chamada de API subsequente usar o objeto recém-criado, você deverá aguardar a conclusão da primeira operação antes de prosseguir.
Você pode usar a API do Serviço de Migração de Banco de Dados para gerenciar operações . Isso inclui:
Serviço de Migração de Banco de Dados e Serviço de Descoberta de APIs do Google
O Serviço de Descoberta de APIs do Google é um serviço que você pode usar para descobrir APIs do Google. Por exemplo, ao usar a ferramenta Google APIs Explorer , você está usando o Serviço de Descoberta.No Discovery Service, o Database Migration Service é representado como "datamigration" (por exemplo: https://datamigration.googleapis.com/$discovery/rest?version=v1 ).