Esta página foi traduzida pela API Cloud Translation.

Use a API Datastream

A stream de dados fornece uma API REST para administrar as suas configurações de conetividade privada, perfis de ligação e streams de forma programática. A API REST é definida por recursos associados à criação e gestão de configurações de conetividade privada, perfis de ligação e streams. Para ver detalhes sobre todos os recursos e respetivos métodos, consulte a Referência da API Datastream.

Quando envia pedidos diretamente para a API REST do Datastream, tem de criar a forma correta do pedido, autorizar o pedido como um utilizador autenticado e processar todas as respostas devolvidas. Muitas das tarefas nesta documentação fornecem exemplos de API com cURL.

Para ver mais exemplos de utilização das APIs, consulte a página do pedido na referência da API Datastream. Cada página tem exemplos que chamam a API em várias linguagens de programação, bem como um explorador específico do pedido para ajudar a ver o que é necessário para um pedido bem formado e o que esperar na resposta.

Também está a usar a API Datastream, indiretamente, quando usa qualquer uma das seguintes formas de administrar instâncias:

CLI do Google Cloud: uma interface de linhas de comando (CLI) que pode usar para trabalhar com as suas instâncias.
Google Cloud console: Uma interface Web gráfica.

A vantagem de usar estes métodos, especialmente a Google Cloud consola, é que podem simplificar muito a administração das suas configurações de conetividade privada, perfis de ligação e streams (consoante o seu exemplo de utilização). Se está a começar a usar o Datastream, recomendamos que comece por usar uma destas ferramentas antes de trabalhar diretamente com a API REST.

Ative a API

Para usar a API Datastream, tem de a ativar:

Consola

Ative a API Datastream.
Selecione o seu projeto.
Selecione Continuar.

gcloud

Introduza o seguinte para apresentar os IDs dos seus Google Cloud projetos:
```
gcloud projects list
```

Defina o projeto predefinido:

gcloud config set project YOUR_PROJECT_ID

Ative a API Datastream:

gcloud services enable datastream.googleapis.com

Autorizações

Tem de ter as autorizações necessárias para usar a API Datastream. Estas autorizações incluem:

Administrador da stream de dados: com esta autorização, um utilizador ganha acesso a todos os recursos da stream de dados usados para gerir configurações de conetividade privada, perfis de ligação e streams.
Visualizador de streams de dados: com esta autorização, um utilizador tem acesso só de leitura a configurações de conetividade privadas, perfis de ligação e streams no Datastream.

Google Cloud oferece a gestão de identidade e de acesso (IAM), que lhe permite conceder acesso mais detalhado a recursos Google Cloud específicos e impede o acesso indesejado a outros recursos. Pode obter e definir autorizações para o fluxo de dados através da Google Cloud consola, dos métodos IAM da API ou do Google Cloud SDK. Para mais informações, consulte o artigo Conceder, alterar e revogar o acesso a recursos.

Exemplos de APIs

Pode ver exemplos de utilização da API Datastream com cURL nas seguintes páginas da documentação do Datastream:

Forneça dados JSON a partir de um ficheiro

Quando usa a API com o cURL, fornece valores de propriedades através da linha de comandos. Se estiver a trabalhar com valores confidenciais, como palavras-passe ou chaves de segurança, fornecê-los na linha de comandos representa um risco de segurança. Para aumentar a segurança, pode criar um ficheiro que contenha os dados JSON para a chamada API e fornecer o caminho para o ficheiro na linha de comandos.

Para fornecer dados JSON à sua chamada da API cURL a partir de um ficheiro:

Crie um ficheiro que contenha tudo o que está entre aspas simples para o campo --data.

Inclua as chavetas, mas não inclua as aspas simples.

Na linha de comandos, indique o caminho para o ficheiro, precedido pelo caráter @, como o parâmetro --data:

--data @<path-to-file>/<filename>

Por exemplo, para criar um perfil de ligação para uma origem MySQL, pode criar um ficheiro denominado request.json com o seguinte conteúdo:

{
  "displayName": "my MySQL connection profile",
  "mysql": {
    "host": "10.11.12.13",
    "port": 3306,
    "username": "myusername",
    "password": "mypassword"
  }
}

Em seguida, usaria o seguinte comando cURL na linha de comandos:

curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \
     --header 'Content-Type: application/json' \
     --data @./request.json \
     -X POST \
     https://datastream.googleapis.com/v1/projects/myProject/locations/myLocation/connectionProfiles?connectionProfileId=myMySQLconnectionprofile

Trabalhe com chamadas de API de execução prolongada

Algumas chamadas API, como a criação de objetos, podem demorar algum tempo a concluir. Uma vez que a API é assíncrona, a chamada é devolvida imediatamente, mesmo que a operação ainda esteja em curso. Se uma chamada de API subsequente usar o objeto recém-criado, tem de aguardar que a primeira operação seja concluída antes de continuar.

Pode usar a API Datastream para gerir operações. Isto inclui:

Datastream e serviço de descoberta de APIs Google

O Serviço de descoberta de APIs Google é um serviço que pode usar para descobrir APIs Google. Por exemplo, quando usa a ferramenta Google APIs Explorer , está a usar o serviço Discovery.

No serviço Discovery, o Datastream é representado como "datastream" (por exemplo: https://datastream.googleapis.com/$discovery/rest?version=v1).