Gestisci deployment

Questa pagina si applica ad Apigee e Apigee hybrid.

Questo documento descrive come creare e gestire i deployment delle API. Consulta anche Introduzione ai deployment delle API. Dopo aver creato un'entità di deployment, puoi collegarla a una o più versioni dell'API.

Crea un deployment

Puoi creare un'entità di deployment nella console o con l'API REST.

Console

Per creare un nuovo deployment:

  1. Nella console Google Cloud, vai alla pagina Hub API.

    Vai ad API Hub
  2. Fai clic su API.
  3. Utilizza Filtra per specificare le parole chiave per filtrare l'elenco di API. Se necessario, utilizza la ricerca per trovare un'API.
  4. Fai clic su un'API per visualizzarne i dettagli.
  5. Nella scheda Deployment, fai clic su Aggiungi deployment.
  6. Specifica i dettagli del deployment nel modulo Crea deployment:
    • ID deployment: fai clic su Specifica ID univoco per fornire facoltativamente un ID univoco per il deployment. Se ometti l'ID, l'hub API ne crea uno per te. L'ID deve contenere da 4 a 500 caratteri e i caratteri validi sono /[A-Z][a-z][0-9]-/.
    • Nome del deployment: (obbligatorio) fornisci un nome visualizzato per il deployment.
    • Descrizione: inserisci una descrizione del deployment.
    • Tipo di deployment: seleziona il tipo di deployment. I valori possibili sono definiti in un attributo di sistema e puoi modificarli in Gestisci attributi.
    • URI risorsa: (obbligatorio) fornisci un URI per la risorsa di runtime. Questo URI può essere utilizzato per gestire la risorsa. Ad esempio, se la risorsa di runtime è un proxy API Apigee, questo campo deve contenere l'URI dell'interfaccia utente di gestione del proxy.
    • Ambiente: l'ambiente mappato a questo deployment. L'ambiente viene mappato all'attributo dell'ambiente definito dal sistema.
    • Documentazione: inserisci un link alla documentazione per il deployment.
    • SLO: specifica lo SLO per questo deployment. Questo corrisponde all'attributo SLO definito dal sistema. Puoi modificare i valori di questo attributo in Gestisci attributi.
    • Endpoint: (obbligatorio) fornisci gli endpoint su cui è in ascolto questa risorsa di deployment per le richieste API. Potrebbe trattarsi di un elenco di nomi host, indirizzi IP o URI completi.
    • Collega a una versione: collega il deployment a una o più versioni dell'API.
    • Attributi definiti dall'utente: coppie chiave/valore definite dall'utente. Puoi aggiungere attributi definiti dall'utente in Gestisci attributi.
  7. Fai clic su Crea.

REST

Per aggiungere un nuovo deployment utilizzando l'API Crea un deployment:

curl "https://apihub.googleapis.com/v1/projects/HUB_PROJECT/locations/HUB_LOCATION/deployments?deployment_id=DEPLOYMENT_ID"
  -H "Authorization: Bearer: $(gcloud auth print-access-token)" -X POST -H "Content-Type: application/json" \
  '{
    "display-name": DISPLAY_NAME
    }'

Sostituisci quanto segue:

  • HUB_PROJECT: il nome del progetto host di API Hub. Il progetto host è stato selezionato durante il provisioning dell'hub API.
  • HUB_LOCATION: la posizione del progetto host. La località è stata scelta al momento del provisioning dell'hub API.
  • DEPLOYMENT_ID: (facoltativo) l'identificatore dell'implementazione. Se non viene fornito, verrà utilizzato un ID generato dal sistema. Il nome deve essere una stringa di 4-500 caratteri, dove i caratteri validi sono /[a-z][A-Z][0-9]-_/.
  • DISPLAY_NAME: (obbligatorio) il nome visualizzato del deployment. Puoi utilizzare qualsiasi nome.
  • Attributi facoltativi: oltre al nome visualizzato obbligatorio, puoi associare a un deployment attributi ed entità facoltativi. Questi elementi aggiuntivi sono descritti nella descrizione della risorsa di deployment nel riferimento all'API REST.

Collegare un deployment a una versione dell'API

A una versione possono essere collegati uno o più implementazioni. Questa sezione spiega come collegare i deployment alle versioni. Puoi collegare i deployment a una versione al momento della sua creazione oppure puoi collegarli a una versione esistente modificandola. Consulta Creare una versione dell'API e Modificare una versione.

Per collegare un deployment a una versione nuova o esistente, il deployment deve già esistere. Vedi Creare un deployment.

Console

Per aggiungere un deployment a una versione:

  1. Nella console Google Cloud, vai alla pagina Hub API.

    Vai all'hub API
  2. Fai clic su API.
  3. Utilizza Filtra per specificare le parole chiave per filtrare l'elenco di API. Se necessario, utilizza la ricerca per trovare un'API.
  4. Seleziona un'API.
  5. Nella tabella Versioni, individua la versione che vuoi modificare.
  6. Seleziona Modifica dal menu Azioni a destra della riga della versione oppure seleziona la versione e fai clic su Modifica versione nella pagina dei dettagli.
  7. In Collega a un deployment, seleziona uno o più deployment da collegare alla versione e fai clic su Ok.
  8. Fai clic su Salva.

REST

Esempio di aggiunta di un deployment a una versione:

curl "https://apihub.googleapis.com/v1/projects/HUB_PROJECT/locations/HUB_LOCATION/apis/API_NAME/versions/VERSION_ID"
  -H "Authorization: Bearer: $(gcloud auth print-access-token)" -X PATCH -H "Content-Type: application/json" \
  '{
    "deployments": "DEPLOYMENTS"
  }'

Sostituisci quanto segue:

  • HUB_PROJECT: il nome del progetto host di API Hub. Il progetto host è stato selezionato durante il provisioning dell'hub API.
  • HUB_LOCATION: la posizione del progetto host. La località è stata scelta al momento del provisioning dell'hub API.
  • API_NAME: il nome dell'API con la versione che vuoi modificare.
  • VERSION_ID: l'ID univoco della versione da modificare.
  • DEPLOYMENTS: il nome completo della risorsa di uno o più deployment. Ad esempio: "projects/myproject/locations/us-central1/deployments/mydeployment-1, projects/myproject/locations/us-central1/deployments/mydeployment-2"

Elenca implementazioni

Questa sezione spiega come elencare i deployment. Puoi elencare tutti i deployment associati a tutte le versioni di un'API o elencare tutti i deployment associati a una versione specifica.

Console

Per elencare i deployment con l'interfaccia utente:

  1. Nella console Google Cloud, vai alla pagina Hub API.

    Vai ad API Hub
  2. Fai clic su API.
  3. Utilizza Filtra per specificare le parole chiave per filtrare l'elenco di API. Se necessario, utilizza la ricerca per trovare un'API.
  4. Fai clic su un'API per visualizzarne i dettagli.
  5. Seleziona la scheda Deployment per elencare tutti i deployment associati all'API.
  6. Nella scheda Versioni, seleziona una versione se vuoi visualizzare i deployment associati.

REST

Per elencare tutti i deployment, utilizza l'API List deployments:

curl "https://apihub.googleapis.com/v1/projects/HUB_PROJECT/locations/HUB_LOCATION/deployments"
        -H "Authorization: Bearer: $(gcloud auth print-access-token)" -X GET -H "Content-Type: application/json"

Sostituisci quanto segue:

  • HUB_PROJECT: il nome del progetto host di API Hub. Il progetto host è stato selezionato durante il provisioning dell'hub API.
  • HUB_LOCATION: la posizione del progetto host. La località è stata scelta al momento del provisioning dell'hub API.

Ottieni i dettagli del deployment

Questa sezione spiega come ottenere i dettagli su un deployment dell'API.

Console

Per visualizzare i dettagli di un deployment:

  1. Nella console Google Cloud, vai alla pagina Hub API.

    Vai ad API Hub
  2. Fai clic su API.
  3. Utilizza Filtra per specificare le parole chiave per filtrare l'elenco di API. Se necessario, utilizza la ricerca per trovare un'API.
  4. Fai clic su un'API per visualizzarne i dettagli.
  5. Seleziona la scheda Deployment per elencare tutti i deployment associati all'API.
  6. Seleziona il deployment per visualizzarne la pagina dei dettagli.

REST

Per visualizzare i dettagli di un deployment, utilizza l'API Get deployment details:

curl "https://apihub.googleapis.com/v1/projects/HUB_PROJECT/locations/HUB_LOCATION/deployments/DEPLOYMENT_ID"
    -H "Authorization: Bearer: $(gcloud auth print-access-token)" -X GET -H "Content-Type: application/json"

Sostituisci quanto segue:

  • HUB_PROJECT: il nome del progetto host di API Hub. Il progetto host è stato selezionato durante il provisioning dell'hub API.
  • HUB_LOCATION: la posizione del progetto host. La località è stata scelta al momento del provisioning dell'hub API.
  • DEPLOYMENT_ID: l'ID univoco del deployment.

Eliminare un deployment di API da un'API

Questa sezione spiega come eliminare il deployment dell'API. Quando elimini un deployment di API da un'API, viene prima scollegato da tutte le versioni dell'API e poi eliminato dall'API. Una volta eliminato, un deployment non verrà più visualizzato nell'elenco dei deployment e non potrai filtrare le API in base al deployment eliminato.

Console

Per eliminare un deployment con l'interfaccia utente:

  1. Nella console Google Cloud, vai alla pagina Hub API.

    Vai ad API Hub
  2. Fai clic su API.
  3. Utilizza Filtra per specificare le parole chiave per filtrare l'elenco di API. Se necessario, utilizza la ricerca per trovare un'API.
  4. Fai clic su un'API per visualizzarne i dettagli.
  5. Seleziona la scheda Deployment per elencare tutti i deployment associati all'API.
  6. Individua il deployment che vuoi eliminare.
  7. Seleziona Elimina dal menu Azione del deployment.

REST

Per eliminare un deployment dall'hub API, utilizza l'API Delete deployment:

curl "https://apihub.googleapis.com/v1/projects/HUB_PROJECT/locations/HUB_LOCATION/deployments/DEPLOYMENT_ID"
    -H "Authorization: Bearer: $(gcloud auth print-access-token)" -X DELETE -H "Content-Type: application/json"

Sostituisci quanto segue:

  • HUB_PROJECT: il nome del progetto host di API Hub. Il progetto host è stato selezionato durante il provisioning dell'hub API.
  • HUB_LOCATION: la posizione del progetto host. La località è stata scelta al momento del provisioning dell'hub API.
  • DEPLOYMENT_ID: l'ID univoco del deployment da eliminare.

Scollegare un deployment dell'API da un'API o una versione

Questa sezione spiega come scollegare un deployment dell'API da un'API o una versione. Se scolleghi un deployment da un'API, il deployment viene scollegato da tutte le versioni dell'API. Se un deployment viene sganciato, non viene più visualizzato nell'elenco dei deployment.

Console

Per scollegare un deployment da un'API con l'interfaccia utente:

  1. Nella console Google Cloud, vai alla pagina Hub API.

    Vai ad API Hub
  2. Fai clic su API.
  3. Utilizza Filtra per specificare le parole chiave per filtrare l'elenco di API. Se necessario, utilizza la ricerca per trovare un'API.
  4. Fai clic su un'API per visualizzarne i dettagli.
  5. Seleziona la scheda Deployment per elencare tutti i deployment associati all'API.
  6. Individua il deployment da scollegare.
  7. Seleziona Scollega dall'API dal menu Azione del deployment.

Per scollegare un deployment da una versione con l'interfaccia utente:

  1. Nella console Google Cloud, vai alla pagina Hub API.

    Vai ad API Hub
  2. Fai clic su API.
  3. Utilizza Filtra per specificare le parole chiave per filtrare l'elenco di API. Se necessario, utilizza la ricerca per trovare un'API.
  4. Fai clic su un'API per visualizzarne i dettagli.
  5. Seleziona una versione.
  6. Nella sezione Deployment, individua il deployment da scollegare.
  7. Seleziona Scollega dalla versione dal menu Azione del deployment.

REST

Per eliminare una risorsa API dall'hub API, utilizza l'API Delete deployment:

curl "https://apihub.googleapis.com/v1/projects/HUB_PROJECT/locations/HUB_LOCATION/deployments/DEPLOYMENT_ID"
    -H "Authorization: Bearer: $(gcloud auth print-access-token)" -X DELETE -H "Content-Type: application/json"

Sostituisci quanto segue:

  • HUB_PROJECT: il nome del progetto host di API Hub. Il progetto host è stato selezionato durante il provisioning dell'hub API.
  • HUB_LOCATION: la posizione del progetto host. La località è stata scelta al momento del provisioning dell'hub API.
  • DEPLOYMENT_ID: l'ID univoco del deployment da eliminare.

Modificare un deployment

Questa sezione spiega come modificare un deployment.

Console

  1. Nella console Google Cloud, vai alla pagina Hub API.

    Vai ad API Hub
  2. Fai clic su API.
  3. Utilizza Filtra per specificare le parole chiave per filtrare l'elenco di API. Se necessario, utilizza la ricerca per trovare un'API.
  4. Fai clic su un'API per visualizzarne i dettagli.
  5. Seleziona la scheda Deployment per elencare tutti i deployment associati all'API.
  6. Individua il deployment da modificare.
  7. Seleziona Modifica dal menu Azione del deployment oppure fai clic sul deployment e poi su Modifica deployment nel riquadro dei dettagli del deployment.

REST

Per modificare un deployment, utilizza l'API Patch deployment:

curl "https://apihub.googleapis.com/v1/projects/HUB_PROJECT/locations/HUB_LOCATION/deployments/DEPLOYMENT_ID"
      -H "Authorization: Bearer: $(gcloud auth print-access-token)" -X PATCH -H "Content-Type: application/json"
      '{
        DEPLOYMENT_ATTRIBUTES
      {'

Sostituisci quanto segue:

  • HUB_PROJECT: il nome del progetto host di API Hub. Il progetto host è stato selezionato durante il provisioning dell'hub API.
  • HUB_LOCATION: la posizione del progetto host. La località è stata scelta al momento del provisioning dell'hub API.
  • DEPLOYMENT_ID: l'ID univoco del deployment da modificare.
  • DEPLOYMENT_ATTRIBUTES: allega gli attributi che vuoi modificare nel corpo della richiesta. Gli attributi modificabili sono descritti nella descrizione della risorsa di deployment nel riferimento all'API REST.