- v1.12 (più recente)
- Versione 1.11
- Versione 1.10
- Elenco delle versioni supportate
- Versione 1.9
- Versione 1.8
- Versione 1.7
- Versione 1.6
- Versione 1.5
- Versione 1.4
- Versione 1.3
- Versione 1.2
- Versione 1.1
Versioni supportate:
Versioni non supportate:
Hai creato un account e un progetto Google Cloud e abilitato le API. Ora puoi creare la tua organizzazione.
Prerequisito
Per creare un'organizzazione, devi soddisfare una delle seguenti condizioni:
- Avere un account di valutazione. Gli account di valutazione scadono dopo 60 giorni. A quel punto, l'organizzazione verrà eliminata.
- Avere un account a pagamento
Se nessuna di queste condizioni è vera, devi contattare il team di vendita Apigee prima di poter continuare.
Per creare una nuova organizzazione ed eseguirne il provisioning:
-
Nella riga di comando, recupera le tue credenziali di autenticazione
gcloud
, come mostrato nell'esempio seguente:TOKEN=$(gcloud auth print-access-token)
Per verificare che il token sia stato compilato, utilizza
echo
, come illustrato nell'esempio seguente:echo $TOKEN
Il token dovrebbe essere visualizzato come stringa codificata.
Per maggiori informazioni, consulta la panoramica dello strumento a riga di comando gcloud.
- Invia una richiesta
POST
autenticata all'API Create organizzazioni.L'esempio seguente mostra la struttura della richiesta che crea un'organizzazione:
curl -H "Authorization: Bearer $TOKEN" -X POST -H "content-type:application/json" \ -d '{ "name":"org_name", "displayName":"display_name", "description":"organization_description", "runtimeType":"runtime_type", "analyticsRegion":"analytics_region" }' \ "https://apigee.googleapis.com/v1/organizations?parent=projects/project_ID"
Dove:
- (Obbligatorio) org_name è l'ID pubblicità programmatica
che vuoi per la tua organizzazione ibrida. L'ID organizzazione deve corrispondere all'ID progetto Google Cloud che hai creato nel Passaggio 2: crea un progetto Google Cloud. Ad esempio:
hybrid-42
. - (Obbligatorio) runtime_type è il tipo di runtime dell'organizzazione Apigee, dove HYBRID è il runtime ibrido Apigee gestito dall'utente.
- (Obbligatorio) analytics_region è la regione principale per l'archiviazione dei dati di analisi. Scegliere una delle opzioni seguenti:
asia-northeast1
australia-southeast1
us-west1
us-central1
us-east1
europe-west1
europe-west2
Forniamo questa opzione per consentirti di scegliere una regione geograficamente vicina o se la tua organizzazione ha altri requisiti di archiviazione.
- (Obbligatorio) project_ID è il progetto Google Cloud che vuoi associare alla nuova organizzazione ibrida. Questo è l'ID che Google ha generato per te nel Passaggio 2: crea un progetto Google Cloud.
- (Facoltativo) display_name è il nome facile da usare della tua organizzazione. Questo valore non deve essere necessariamente univoco e può includere spazi e caratteri speciali. Ad esempio, "La mia organizzazione ibrida".
- (Facoltativo) organization_description contiene le informazioni sull'organizzazione che vuoi utilizzare come promemoria del suo scopo. Ad esempio, "La mia prima organizzazione".
Se la richiesta di creazione viene approvata, l'API APIs deve rispondere con un messaggio simile al seguente:
{ "name": "organizations/organization_ID/operations/long_running_operation_ID", "metadata": { "@type": "type.googleapis.com/google.cloud.apigee.v1.OperationMetadata", "operationType": "INSERT", "targetResourceName": "organizations/organization_ID", "state": "IN_PROGRESS" } }
Dove:
- long_running_operation_ID è l'UUID di un'operazione asincrona a lunga esecuzione. Puoi utilizzare questo ID per controllare lo stato della richiesta di creazione dell'organizzazione (descritto più avanti).
- organization_ID è l'ID della nuova organizzazione attualmente in fase di creazione.
Come indica la proprietà
state
nella risposta, Apigee ha iniziato a creare la nuova organizzazione, quindi il suo stato èIN_PROGRESS
. Questa procedura può richiedere diversi minuti.Se viene visualizzato un errore, vedi Risoluzione dei problemi relativi alla creazione dell'organizzazione.
- (Obbligatorio) org_name è l'ID pubblicità programmatica
che vuoi per la tua organizzazione ibrida. L'ID organizzazione deve corrispondere all'ID progetto Google Cloud che hai creato nel Passaggio 2: crea un progetto Google Cloud. Ad esempio:
- Puoi controllare lo stato dell'operazione a lunga esecuzione il cui ID Apigee ha restituito nella tua richiesta di creazione iniziale. A questo scopo, utilizza l'API Operations, come mostrato nell'esempio seguente:
curl -H "Authorization: Bearer $TOKEN" \ "https://apigee.googleapis.com/v1/organizations/organization_ID/operations/long_running_operation_ID"
I seguenti esempi mostrano possibili risposte a questa richiesta:
COMPLETATO
Una volta eseguito il provisioning dell'organizzazione, lo stato dell'operazione a lunga esecuzione è
FINISHED
, come mostrato nell'esempio seguente:{ "operations": [ { "name": "organizations/organization_ID/operations/long_running_operation_ID", "metadata": { "@type": "type.googleapis.com/google.cloud.apigee.v1.OperationMetadata", "operationType": "INSERT", "targetResourceName": "organizations/organization_ID", "state": "FINISHED" }, "done": true, "response": { "@type": "type.googleapis.com/google.cloud.apigee.v1.Organization", "name": "organization_ID", "createdAt": "1572550611", "lastModifiedAt": "1572550611", "displayName": "display_name" "description": "description" "properties": { "property": [ { "name": "features.hybrid.enabled", "value": "true" } ] }, "analyticsRegion": "us-east1" "runtimeType": "HYBRID", } } ] }
Se non hai inserito una descrizione, il campo non verrà visualizzato nella risposta.
Complimenti! Hai creato una nuova organizzazione ed è pronta per essere utilizzata. Puoi andare al Passaggio 5: aggiungi un ambiente.
IN_PROGRESS
Se Apigee è ancora in fase di creazione dell'organizzazione, Apigee risponde con uno stato di
IN_PROGRESS
, come mostrato nell'esempio seguente:{ "name": "organizations/organization_ID/operations/long_running_operation_ID", "metadata": { "@type": "type.googleapis.com/google.cloud.apigee.v1.OperationMetadata", "operationType": "INSERT", "targetResourceName": "organizations/organization_ID", "state": "IN_PROGRESS" } }
Dovresti attendere un po' più a lungo prima di provare a verificare che il processo di creazione sia completo.
Risolvere i problemi relativi alla creazione dell'organizzazione
Quando crei un'organizzazione con l'API Create organizzazioni, potresti ricevere una risposta di errore. Le risposte hanno il seguente aspetto:
{ "error": { "code": HTTP_error_code, "message": "short_error_message", "status": "high_level_error_type", "details": [ { "@type": "specific_error_type", "detail": "expanded_error_description" } ] } }
L'esempio seguente mostra una risposta a un errore comune. L'ID organizzazione contiene caratteri illegali (gli ID organizzazione non sono consentiti per caratteri maiuscoli):
{ "error": { "code": 400, "message": "invalid Organization ID \"MY-ORG\": \"MY-ORG\" is an invalid Organization ID", "status": "INVALID_ARGUMENT", "details": [ { "@type": "type.googleapis.com/google.rpc.DebugInfo", "detail": "[ORIGINAL ERROR] generic::invalid_argument: invalid Organization ID \"MY-ORG\": \"My-ORG\" is an invalid Organization ID [google.rpc.error_details_ext] { message: \"invalid Organization ID \\\"MY-ORG\\\": \\\"MY-ORG\\\" is an invalid Organization ID\" }" } ] } }
In questo caso, puoi rinominare l'organizzazione con lettere minuscole e inviare nuovamente la richiesta.
Nella tabella seguente sono elencati gli errori che potresti ricevere e le potenziali soluzioni quando provi a creare una nuova organizzazione:
Codice di errore HTTP | Errore HTTP | Descrizione |
---|---|---|
400 |
Invalid JSON payload received |
La struttura dei dati nella richiesta contiene un errore di sintassi oppure il percorso dell'endpoint non è corretto. |
400 |
Invalid organization ID |
L'ID organizzazione richiesto non può contenere lettere maiuscole o caratteri speciali diversi dai trattini. Deve contenere solo lettere minuscole, numeri e/o trattini. Può contenere un massimo di 32 caratteri. |
400 |
Unsupported analytics region |
Non hai specificato il valore di analyticsRegion nel corpo della richiesta oppure il valore specificato non è tra le opzioni valide. |
400 |
Does not have an Apigee entitlement |
Il tuo progetto Google Cloud (che hai creato nel Passaggio 2: crea un progetto Google Cloud) non è ancora stato abilitato per l'ambiente ibrido. Questo potrebbe indicare un problema di fatturazione o altri errori relativi al tuo account Google Cloud. Per ulteriori informazioni, contatta il team di vendita Apigee. |
401 |
Request had invalid authentication credentials |
Il token di autenticazione gcloud è errato o obsoleto oppure non ne hai incluso uno nella richiesta. Genera un nuovo token e invia di nuovo l'indirizzo. |
403 |
Permission denied on resource project project_ID |
Potresti aver inviato una richiesta contenente un ID o un percorso progetto errati. |
403 |
Unable to retrieve project information |
L'organizzazione non è ancora stata creata o non è stato eseguito il provisioning. Puoi inviare una richiesta all'API Operations per verificare lo stato dell'operazione a lunga esecuzione, come descritto nella procedura precedente. |
409 |
Organization already exists |
Hai provato a creare più di un'organizzazione per il progetto Google Cloud. Puoi creare una sola organizzazione per progetto. |
409 |
Org proposed_organization_ID already exists |
Hai provato a creare un'organizzazione che ha lo stesso ID di un'organizzazione già esistente. Gli ID organizzazione devono essere univoci per tutti i clienti ibridi. Invia di nuovo con un nuovo ID organizzazione proposto; ad esempio, aggiungi un valore numerico alla fine dell'ID precedente che hai provato. |
Recupera le informazioni sull'organizzazione
Puoi ottenere un elenco di tutte le organizzazioni a cui ha accesso il tuo account o puoi ottenere i dettagli su un'organizzazione specifica in base al relativo ID. Per eseguire queste azioni, utilizza l'API Organization.
Elenco organizzazioni
Per ottenere un elenco di tutte le organizzazioni:
Invia una richiesta GET
(senza corpo) al seguente endpoint dell'API List Organization:
https://apigee.googleapis.com/v1/organizations
Ad esempio:
curl -H "Authorization: Bearer $TOKEN" "https://apigee.googleapis.com/v1/organizations"
La risposta alla tua richiesta contiene un array di tutte le organizzazioni abilitate per l'ibrido a cui hai accesso, in formato JSON.
L'esempio seguente mostra una risposta con una singola organizzazione, "my-org-42":
{ "organizations": [ { "organization": "my-org-42", "projectIds": [ "my-project" ] } ] }
Scopri i dettagli
Per visualizzare i dettagli di una singola organizzazione:
Invia una richiesta GET
(senza corpo) al seguente endpoint Ottieni l'API Per le organizzazioni:
https://apigee.googleapis.com/v1/organizations/organization_ID
Nell'esempio seguente vengono recuperati i dettagli sull'organizzazione "my-org-42":
curl -H "Authorization: Bearer $TOKEN" "https://apigee.googleapis.com/v1/organizations/my-org-42"
La risposta alla tua richiesta contiene i dettagli relativi all'organizzazione specificata in formato JSON.
L'esempio seguente mostra una risposta con dettagli sull'organizzazione "my-org-42":
{ "name": "my-org-42", "createdAt": "1572550611", "lastModifiedAt": "1572550611", "environments": [ "my-environment" ], "analyticsRegion": "us-east1" }