O Database Migration Service fornece uma API REST para administrar seus perfis de conexão e trabalhos de migração de forma programática. A API REST é definida por recursos associados à criação e gerenciamento de perfis de conexão e trabalhos de migração. Para obter detalhes sobre todos os recursos e seus métodos, consulte Referência da API do Database Migration Service .
Ao enviar solicitações diretamente para a API REST do Database Migration Service, você deve criar o formulário correto da solicitação, autorizar a solicitação como um usuário autenticado e processar quaisquer respostas retornadas. Muitas das tarefas nesta documentação fornecem exemplos de API usando cURL .
Para obter mais exemplos de uso das APIs, consulte a página da solicitação na Referência da API do Database Migration Service . Cada página tem exemplos de chamadas à API em diversas linguagens de programação, bem como um Explorer específico da solicitação para ajudá-lo a ver o que acontece em uma solicitação bem formada e o que esperar da resposta.
Você também está usando a API Database Migration Service, indiretamente, quando usa qualquer uma das seguintes formas de administrar instâncias:
CLI do Google Cloud : uma interface de linha de comando (CLI) que você pode usar para trabalhar com suas instâncias.
Google Cloud console : Uma interface gráfica da web.
A vantagem de usar esses métodos, especialmente oGoogle Cloud console, é que eles podem simplificar bastante a administração de seus perfis de conexão e trabalhos de migração (dependendo do seu caso de uso). Se você está apenas começando com o Database Migration Service, recomendamos que comece com uma dessas ferramentas antes de trabalhar diretamente com a API REST.
Habilite a API
Para usar a API do Database Migration Service, você precisa habilitá-la:
Console
- Habilite a API do serviço de migração de banco de dados .
- Selecione seu projeto.
- Selecione Continuar .
gcloud
- Insira 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 do serviço de migração de banco de dados:
gcloud services enable datamigration.googleapis.com
Permissões
Você deve ter as permissões necessárias para usar a API do Database Migration Service. 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 Database Migration Service 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 a perfis de conexão e trabalhos de migração no Database Migration Service.
Google Cloud oferece gerenciamento de identidade e acesso (IAM), que permite fornecer acesso mais granular a Google Cloud recursos e impede o acesso indesejado a outros recursos. Você pode obter e definir permissões para o Database Migration Service usando o Google Cloud console, os métodos IAM da API ou a CLI do Google Cloud. Para obter mais informações, consulte Concedendo, alterando e revogando acesso a recursos .
Forneça dados JSON de um arquivo
Ao usar a API com cURL, você fornece valores de propriedade usando a linha de comando. Se você estiver trabalhando com valores confidenciais, como senhas ou chaves de segurança, fornecê-los na linha de comando representa um risco à segurança. Para aumentar a segurança, você pode criar um arquivo contendo os dados JSON para a chamada de API e fornecer o caminho para o arquivo na linha de comando.
Para fornecer dados JSON para sua chamada de API cURL a partir de um arquivo:
Crie um arquivo contendo tudo entre aspas simples para o campo
--data
.Inclua as chaves, mas não inclua aspas simples.
Na linha de comando, forneça o caminho para o arquivo, precedido pelo caractere
@
, como parâmetro--data
:--data @<path-to-file>/<filename>
Trabalhe 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 continuar.
Você pode usar a API do Database Migration Service 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 Discovery Service.No Discovery Service, o Database Migration Service é representado como "datamigration" (por exemplo: https:// datamigration .googleapis.com/$discovery/rest?version=v1).
,O Database Migration Service fornece uma API REST para administrar seus perfis de conexão e trabalhos de migração de forma programática. A API REST é definida por recursos associados à criação e gerenciamento de perfis de conexão e trabalhos de migração. Para obter detalhes sobre todos os recursos e seus métodos, consulte Referência da API do Database Migration Service .
Ao enviar solicitações diretamente para a API REST do Database Migration Service, você deve criar o formulário correto da solicitação, autorizar a solicitação como um usuário autenticado e processar quaisquer respostas retornadas. Muitas das tarefas nesta documentação fornecem exemplos de API usando cURL .
Para obter mais exemplos de uso das APIs, consulte a página da solicitação na Referência da API do Database Migration Service . Cada página tem exemplos de chamadas à API em diversas linguagens de programação, bem como um Explorer específico da solicitação para ajudá-lo a ver o que acontece em uma solicitação bem formada e o que esperar da resposta.
Você também está usando a API Database Migration Service, indiretamente, quando usa qualquer uma das seguintes formas de administrar instâncias:
CLI do Google Cloud : uma interface de linha de comando (CLI) que você pode usar para trabalhar com suas instâncias.
Google Cloud console : Uma interface gráfica da web.
A vantagem de usar esses métodos, especialmente oGoogle Cloud console, é que eles podem simplificar bastante a administração de seus perfis de conexão e trabalhos de migração (dependendo do seu caso de uso). Se você está apenas começando com o Database Migration Service, recomendamos que comece com uma dessas ferramentas antes de trabalhar diretamente com a API REST.
Habilite a API
Para usar a API do Database Migration Service, você precisa habilitá-la:
Console
- Habilite a API do serviço de migração de banco de dados .
- Selecione seu projeto.
- Selecione Continuar .
gcloud
- Insira 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 do serviço de migração de banco de dados:
gcloud services enable datamigration.googleapis.com
Permissões
Você deve ter as permissões necessárias para usar a API do Database Migration Service. 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 Database Migration Service 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 a perfis de conexão e trabalhos de migração no Database Migration Service.
Google Cloud oferece gerenciamento de identidade e acesso (IAM), que permite fornecer acesso mais granular a Google Cloud recursos e impede o acesso indesejado a outros recursos. Você pode obter e definir permissões para o Database Migration Service usando o Google Cloud console, os métodos IAM da API ou a CLI do Google Cloud. Para obter mais informações, consulte Concedendo, alterando e revogando acesso a recursos .
Forneça dados JSON de um arquivo
Ao usar a API com cURL, você fornece valores de propriedade usando a linha de comando. Se você estiver trabalhando com valores confidenciais, como senhas ou chaves de segurança, fornecê-los na linha de comando representa um risco à segurança. Para aumentar a segurança, você pode criar um arquivo contendo os dados JSON para a chamada de API e fornecer o caminho para o arquivo na linha de comando.
Para fornecer dados JSON para sua chamada de API cURL a partir de um arquivo:
Crie um arquivo contendo tudo entre aspas simples para o campo
--data
.Inclua as chaves, mas não inclua aspas simples.
Na linha de comando, forneça o caminho para o arquivo, precedido pelo caractere
@
, como parâmetro--data
:--data @<path-to-file>/<filename>
Trabalhe 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 continuar.
Você pode usar a API do Database Migration Service 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 Discovery Service.No Discovery Service, o Database Migration Service é representado como "datamigration" (por exemplo: https:// datamigration .googleapis.com/$discovery/rest?version=v1).