Questa pagina si applica a Apigee e Apigee ibrido.
Questo documento descrive come creare e gestire i deployment 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:
Nella console Google Cloud, vai alla pagina dell'hub API.
Vai all'hub API- Fai clic su API.
- Utilizza Filtra per specificare le parole chiave per filtrare l'elenco delle API. Se necessario, utilizza la ricerca per individuare un'API.
- Fai clic su un'API per visualizzarne i dettagli.
- Nella scheda Deployment, fai clic su Aggiungi deployment.
- 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 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 della risorsa di runtime. Questo URI può essere utilizzato per gestire la risorsa. Ad esempio, se la risorsa runtime è un proxy API Apigee, questo campo conterrà l'URI dell'interfaccia utente di gestione del proxy.
- Ambiente: l'ambiente mappato a questo deployment. L'ambiente viene mappato sull'attributo di ambiente definito dal sistema.
- Documentazione: inserisci un link alla documentazione per il deployment.
- SLO: fornisci lo SLO per questo deployment. Questo viene mappato all'attributo definito dal sistema SLO. Puoi modificare i valori di questo attributo in Gestisci attributi.
- Endpoint: (obbligatorio) fornisci gli endpoint in cui questa risorsa di deployment sta ascoltando le richieste API. Potrebbe trattarsi di un elenco di URI, nomi host o indirizzi IP 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.
- 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
- Fai clic su Crea.
REST
Per aggiungere un nuovo deployment utilizzando l'API Create a deployment (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 dell'hub API. Il progetto host è stato selezionato durante il provisioning dell'hub API.
- HUB_LOCATION: la località del progetto host. La località è stata scelta al momento del provisioning dell'hub API.
- DEPLOYMENT_ID: (facoltativo) l'identificatore del deployment. 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 il nome che preferisci.
- Attributi facoltativi: oltre al nome visualizzato obbligatorio, puoi collegare entità ed attributi facoltativi a un deployment. Questi elementi aggiuntivi sono descritti nella descrizione delle risorse di deployment nel riferimento dell'API REST.
Collega un deployment a una versione API
Una versione può avere uno o più deployment collegati. Questa sezione spiega come collegare i deployment alle versioni. Puoi collegare i deployment a una versione al momento della creazione della versione oppure puoi collegare i deployment a una versione esistente modificandola. Consulta gli articoli Creare una versione API e Modificare una versione.
Per collegare un deployment a una versione nuova o esistente, il deployment deve già esistere. Consulta Creare un deployment.
Console
Per aggiungere un deployment a una versione:
Nella console Google Cloud, vai alla pagina dell'hub API.
Vai all'hub API- Fai clic su API.
- Utilizza Filtra per specificare le parole chiave per filtrare l'elenco delle API. Se necessario, utilizza la ricerca per individuare un'API.
- Seleziona un'API.
- Nella tabella Versioni, individua la versione da modificare.
- Seleziona Modifica dal menu Azioni sul lato destro della riga della versione o seleziona la versione e fai clic su Modifica versione nella pagina dei dettagli.
- In Collega a un deployment, seleziona uno o più deployment da collegare alla versione e fai clic su Ok.
- 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 dell'hub API. Il progetto host è stato selezionato durante il provisioning dell'hub API.
- HUB_LOCATION: la località del progetto host. La località è stata scelta al momento del provisioning dell'hub API.
- API_NAME: il nome dell'API contenente 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 tutti i deployment associati a una versione specifica.
Console
Per elencare i deployment con l'interfaccia utente:
Nella console Google Cloud, vai alla pagina dell'hub API.
Vai all'hub API- Fai clic su API.
- Utilizza Filtra per specificare le parole chiave per filtrare l'elenco delle API. Se necessario, utilizza la ricerca per individuare un'API.
- Fai clic su un'API per visualizzarne i dettagli.
- Seleziona la scheda Deployment per elencare tutti i deployment associati all'API.
- Dalla scheda Versioni, seleziona una versione se vuoi vedere i deployment associati a quella versione.
REST
Per elencare tutti i deployment, utilizza l'API List deployment:
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 dell'hub API. Il progetto host è stato selezionato durante il provisioning dell'hub API.
- HUB_LOCATION: la località del progetto host. La località è stata scelta al momento del provisioning dell'hub API.
Ottieni dettagli di deployment
Questa sezione spiega come ottenere i dettagli sul deployment di un'API.
Console
Per visualizzare i dettagli di un deployment:
Nella console Google Cloud, vai alla pagina dell'hub API.
Vai all'hub API- Fai clic su API.
- Utilizza Filtra per specificare le parole chiave per filtrare l'elenco delle API. Se necessario, utilizza la ricerca per individuare un'API.
- Fai clic su un'API per visualizzarne i dettagli.
- Seleziona la scheda Deployment per elencare tutti i deployment associati all'API.
- Seleziona il deployment per visualizzare la relativa pagina dei dettagli.
REST
Per visualizzare i dettagli di un deployment, utilizza l'API Ottieni i dettagli del 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 GET -H "Content-Type: application/json"
Sostituisci quanto segue:
- HUB_PROJECT: il nome del progetto host dell'hub API. Il progetto host è stato selezionato durante il provisioning dell'hub API.
- HUB_LOCATION: la località del progetto host. La località è stata scelta al momento del provisioning dell'hub API.
- DEPLOYMENT_ID: l'ID univoco del deployment.
Elimina un deployment API
Questa sezione spiega come eliminare il deployment dell'API.
Console
Per eliminare le risorse API con l'interfaccia utente:
Nella console Google Cloud, vai alla pagina dell'hub API.
Vai all'hub API- Fai clic su API.
- Utilizza Filtra per specificare le parole chiave per filtrare l'elenco delle API. Se necessario, utilizza la ricerca per individuare un'API.
- Fai clic su un'API per visualizzarne i dettagli.
- Seleziona la scheda Deployment per elencare tutti i deployment associati all'API.
- Individua il deployment da eliminare.
- Seleziona Elimina 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 dell'hub API. Il progetto host è stato selezionato durante il provisioning dell'hub API.
- HUB_LOCATION: la località del progetto host. La località è stata scelta al momento del provisioning dell'hub API.
- DEPLOYMENT_ID: l'ID univoco del deployment da eliminare.
Modifica un deployment
Questa sezione spiega come modificare un deployment.
Console
Nella console Google Cloud, vai alla pagina dell'hub API.
Vai all'hub API- Fai clic su API.
- Utilizza Filtra per specificare le parole chiave per filtrare l'elenco delle API. Se necessario, utilizza la ricerca per individuare un'API.
- Fai clic su un'API per visualizzarne i dettagli.
- Seleziona la scheda Deployment per elencare tutti i deployment associati all'API.
- Individua il deployment che vuoi modificare.
- Seleziona Modifica dal menu Azioni del deployment oppure fai clic sul deployment, quindi su Modifica deployment nel riquadro Dettagli 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 dell'hub API. Il progetto host è stato selezionato durante il provisioning dell'hub API.
- HUB_LOCATION: la località 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: collega gli attributi che vuoi modificare nel corpo della richiesta. Gli attributi modificabili sono descritti nella sezione relativa alla descrizione delle risorse di deployment nel riferimento dell'API REST.