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 gli stream. L'API REST è definita dalle risorse associate alla creazione e alla gestione di configurazioni di connettività privata, profili di connessione e stream. Per informazioni dettagliate su tutte le risorse e i relativi metodi, consulta il riferimento all'API Datastream.

Quando invii richieste direttamente all'API REST Datastream, devi creare la forma corretta della richiesta, autorizzare la richiesta come utente autenticato ed elaborare le 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 dell'API Datastream. Ogni pagina contiene esempi di chiamate all'API in diversi linguaggi di programmazione, nonché un esploratore specifico per le richieste che ti aiuta a capire cosa viene inserito in una richiesta ben formattata e cosa aspettarti nella risposta.

Stai utilizzando anche l'API Datastream, indirettamente, quando utilizzi uno degli seguenti modi per amministrare le istanze:

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

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

Abilita l'API

Per utilizzare l'API Datastream, devi attivarla:

Console

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

gcloud

Inserisci quanto segue per visualizzare gli ID progetto per i tuoi progetti Google Cloud:
```
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 configurazioni di connettività privata, profili di connessione e stream.
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 ulteriori informazioni, vedi 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 la riga di comando. Se utilizzi valori sensibili come password o chiavi di sicurezza, fornirli sulla riga di comando comporta 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 contenente tutto ciò che è racchiuso tra virgolette 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 i seguenti contenuti:

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

Quindi, utilizza il seguente comando cURL nella riga di comando:

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

Il completamento di alcune chiamate API, come la creazione dell'oggetto, può richiedere del tempo. Poiché se 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, devi 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 API di Google

Google APIs Discovery Service è un servizio che puoi utilizzare per scoprire le API di Google. Ad esempio, quando utilizzi Explorer API di Google , stai utilizzando il servizio di rilevamento.

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