Questa pagina è stata tradotta dall'API Cloud Translation.

Utilizzo dell'API Datastream

Panoramica

Datastream fornisce un'API REST per amministrare in modo programmatico le configurazioni di connettività privata, i profili di connessione e i flussi di dati. L'API REST è definita dalle risorse associate alla creazione e alla gestione di configurazioni di connettività privata, profili di connessione e flussi. Per maggiori dettagli su tutte le risorse e i relativi metodi, consulta la documentazione di riferimento dell'API Datastream.

Quando invii richieste direttamente all'API REST di Datastream, devi creare il formato corretto della richiesta, autorizzarla come utente autenticato ed elaborare le eventuali risposte restituite. Molte delle attività in questa documentazione forniscono esempi di API che utilizzano cURL.

Per altri esempi di utilizzo delle API, consulta la pagina relativa alla richiesta nel Riferimento API Datastream. Ogni pagina ha esempi di chiamate API in diversi linguaggi di programmazione, nonché un un Explorer specifico per ogni richiesta per aiutarti a capire cosa serve a creare una richiesta ben formulata. e cosa aspettarsi nella risposta.

Utilizzi l'API Datastream anche indirettamente quando utilizzi uno dei seguenti modi per amministrare le istanze:

Google Cloud CLI: un'interfaccia a riga di comando (CLI) che puoi utilizzare per lavorare con le tue istanze.
Console Google Cloud: una Graphic Web Interface.

Il vantaggio di utilizzare questi metodi, in particolare nella console Google Cloud, è che possono semplificare notevolmente l'amministrazione configurazioni di connettività privata, profili di connessione e stream (a seconda del caso d'uso). Se sei solo all'inizio Datastream, ti consigliamo di iniziare prima con uno di questi strumenti prima di lavorare direttamente con l'API REST.

Abilita l'API

Per utilizzare l'API Datastream, devi abilitarla:

Console

Abilita l'API Datastream.
Seleziona il progetto.
Seleziona Continua.

gcloud

Inserisci quanto segue per visualizzare gli ID progetto per il tuo account Google Cloud progetti:
```
gcloud projects list
```

Imposta il progetto predefinito:

gcloud config set project YOUR_PROJECT_ID

Abilita l'API Datastream:

gcloud services enable datastream.googleapis.com

Autorizzazioni

Devi disporre delle autorizzazioni necessarie per utilizzare l'API Datastream. Queste autorizzazioni includono:

Amministratore Datastream: con questa autorizzazione, un utente ottiene l'accesso a tutte le risorse di Datastream utilizzate per gestire le configurazioni di connettività privata, i profili di connessione e i flussi.
Visualizzatore Datastream: con questa autorizzazione, un utente ha accesso di sola lettura alle configurazioni di connettività privata, ai profili di connessione e ai flussi in Datastream.

Google Cloud offre Identity and Access Management (IAM), che ti consente di concedere un accesso più granulare a specifiche risorse Google Cloud e impedisce l'accesso indesiderato ad altre risorse. Puoi ottenere e impostare le autorizzazioni per Datastream utilizzando la Google Cloud Console, i metodi IAM dell'API o Google Cloud SDK. Per saperne di più, consulta Concessione, modifica e revoca dell'accesso alle risorse.

Esempi di API

Puoi vedere esempi di utilizzo dell'API Datastream con cURL nelle seguenti pagine della documentazione di Datastream:

Fornire dati JSON da un file

Quando utilizzi l'API con cURL, fornisci i valori delle proprietà utilizzando il comando dalla riga di comando. Se utilizzi valori sensibili come password o sicurezza e fornire queste chiavi nella riga di comando rappresenta un rischio per la sicurezza. Per una maggiore sicurezza, puoi creare un file contenente i dati JSON per la chiamata API e indica il percorso del file nella riga di comando.

Per fornire dati JSON alla chiamata API cURL da un file:

Crea un file che contenga tutto ciò che è racchiuso tra virgolette singole per il Campo --data.

Includi le parentesi graffe, ma non le virgolette singole.

Nella riga di comando, indica il percorso del file, preceduto dal @ carattere, come parametro --data:

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

Ad esempio, per creare un profilo di connessione per un'origine MySQL, puoi creare un file denominato request.json con il seguente contenuto:

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

Quindi, nella riga di comando dovresti utilizzare il seguente comando cURL:

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

Utilizzare le chiamate API a lunga esecuzione

Alcune chiamate API, come la creazione di oggetti, possono richiedere del tempo. Poiché l'API è asincrona, la chiamata viene restituita immediatamente, anche se l'operazione è ancora in corso. Se una chiamata API successiva utilizza l'oggetto appena creato, deve attendere il completamento della prima operazione prima di procedere.

Puoi utilizzare l'API Datastream per gestire le operazioni. tra cui:

Datastream e servizio di rilevamento delle API di Google

Google API Discovery Service è un servizio che puoi utilizzare per alla scoperta delle API di Google. Ad esempio, quando utilizzi Explorer API di Google , stai utilizzando il servizio di rilevamento.

Nel Discovery Service, Datastream è rappresentato come "datastream" (ad esempio: https://datastream.googleapis.com/$discovery/rest?version=v1).