Creare e gestire gli spazi Apigee

Questa pagina si applica ad Apigee e Apigee hybrid.

Visualizza Apigee Edge documentazione.

Questa pagina descrive come creare spazi Apigee nella tua organizzazione Apigee per gestire le policy Identity and Access Management (IAM) per le risorse API Apigee su larga scala.

Questa guida descrive i passaggi necessari per:

• Creare uno spazio
• Gestire membri e ruoli in uno spazio
• Elencare tutti gli spazi in un'organizzazione
• Visualizzare i dettagli dello spazio
• Aggiornare uno spazio
• Eliminare uno spazio

Per saperne di più sui vantaggi dell'utilizzo di Apigee Spaces per gestire le risorse API, consulta Apigee Spaces.

Prima di iniziare

Prima di iniziare a utilizzare gli spazi:

• Esegui il provisioning di Apigee. Verifica che l'organizzazione con abbonamento Apigee o con pagamento a consumo che vuoi utilizzare sia di cui è stato eseguito il provisioning. Per maggiori informazioni sui passaggi necessari per eseguire il provisioning di Apigee, consulta Introduzione al provisioning.
• Ottieni le credenziali di autenticazione. Prima di eseguire i comandi per creare e gestire gli spazi dalla riga di comando, ottieni le credenziali di autenticazione gcloud utilizzando il seguente comando:

  export TOKEN=$(gcloud auth print-access-token)

Ruoli e autorizzazioni richiesti

Assicurati di avere il seguente ruolo o i seguenti ruoli nel progetto: Apigee > Amministratore dell'organizzazione Apigee

Controlla i ruoli

1. Nella Google Cloud console vai alla pagina IAM.

   Vai a IAM
2. Seleziona il progetto.

3. Nella colonna Entità, trova tutte le righe che identificano te o un gruppo di cui fai parte. Per scoprire i gruppi di cui fai parte, contatta l' amministratore.

4. Per tutte le righe che ti specificano o ti includono, controlla la colonna Ruolo per verificare se l'elenco dei ruoli include i ruoli richiesti.

Concedi i ruoli

1. Nella Google Cloud console vai alla pagina IAM.

   Vai a IAM
2. Seleziona il progetto.
3. Fai clic su Concedi l'accesso.

4. Nel campo Nuove entità, inserisci il tuo identificatore dell'utente. In genere si tratta dell'indirizzo email di un Account Google.

5. Fai clic su Seleziona un ruolo, quindi cerca il ruolo.
6. Per concedere altri ruoli, fai clic su Aggiungi un altro ruolo e aggiungi ogni ruolo successivo.
7. Fai clic su Salva.

Creare uno spazio

Per eseguire questa attività, devi disporre dell'autorizzazione apigee.spaces.create. Questa autorizzazione è inclusa nel ruolo Apigee Organization Admin.

Crea uno spazio nella tua organizzazione Apigee utilizzando la console Apigee o l'API, come descritto nelle sezioni seguenti.

Console Apigee

Per creare uno spazio utilizzando l'interfaccia utente di Apigee:

1. Nell'interfaccia utente di Apigee nella console Google Cloud, vai alla pagina Spazi.
   Vai a Spazi
2. Fai clic su Crea. Si apre il riquadro Aggiungi dettagli dello spazio.
3. Nel campo Nome, inserisci un identificatore univoco per lo spazio. Il nome deve avere meno di 63 caratteri, iniziare con una lettera minuscola e contenere solo caratteri minuscoli. Per i requisiti di denominazione completi, consulta AIP-122: Resource names.
4. (Facoltativo) Nel campo Nome visualizzato, inserisci un'etichetta leggibile per lo spazio.
5. Fai clic su Aggiungi.

Dopo la creazione, i membri dell'organizzazione vedranno lo spazio come parametro disponibile durante la creazione delle risorse API.

API Apigee

Per creare uno spazio nella tua organizzazione Apigee, utilizza il seguente comando:

curl -X POST -H "Authorization: Bearer $TOKEN" -H "Content-Type: application/json" \
    "https://apigee.googleapis.com/v1/organizations/ORG_NAME/spaces" \
    --data-raw '{
       "name":"SPACE_NAME",
       "displayName":"DISPLAY_NAME"
    }'

Dove:

• ORG_NAME è il nome della tua organizzazione Apigee.
• SPACE_NAME è il nome e l'identificatore univoco dello spazio. Il nome deve avere meno di 63 caratteri, iniziare con una lettera minuscola e contenere solo caratteri minuscoli. Per i requisiti di denominazione completi, consulta AIP-122: Resource names.
• DISPLAY_NAME è il nome leggibile dello spazio visualizzato nell'interfaccia utente di Apigee nella console Google Cloud.

Gestire membri e ruoli in uno spazio

Dopo aver creato uno spazio, puoi aggiungere membri del team allo spazio e assegnare i ruoli IAM necessari per creare e gestire le risorse API.

Aggiungere un membro dell'organizzazione a uno spazio

Per eseguire questa attività, devi disporre dell'autorizzazione apigee.spaces.setIamPolicy.

Nota: il ruolo IAM apigee.spaceContentEditor contiene molte delle autorizzazioni necessarie per gestire le risorse dello spazio. Ti consigliamo di concedere questo ruolo, come minimo, agli utenti dello spazio. Tuttavia, potresti dover concedere ruoli aggiuntivi agli utenti per eseguire attività specifiche. Per maggiori informazioni, consulta Gerarchia delle autorizzazioni IAM negli spazi.

Console Apigee

Per concedere a un membro l'accesso a uno spazio utilizzando l'interfaccia utente di Apigee:

1. Nell'interfaccia utente di Apigee nella console Google Cloud, vai alla pagina Spazi.
2. Fai clic sul nome dello spazio che vuoi gestire.
3. Nella sezione Dettagli accesso, fai clic su Concedi l'accesso.
4. Nel campo Aggiungi membri, inserisci gli indirizzi email degli utenti o dei gruppi che vuoi aggiungere.
5. In Assegna ruolo, seleziona Editor di contenuti o Visualizzatore di contenuti.
6. Fai clic su Aggiungi.

Nota: se disponi dell'autorizzazione resourcemanager.projects.setIamPolicy il sistema concede automaticamente a ogni nuovo membro il ruolo Utente della console dello spazio Apigee a livello di progetto, consentendogli di accedere all'interfaccia utente di Apigee nella console Google Cloud. Se non disponi di questa autorizzazione, vedrai un avviso e un amministratore del progetto deve concedere manualmente questo ruolo agli utenti.

API Apigee

Per aggiungere un membro dell'organizzazione a uno spazio e assegnare un ruolo IAM, utilizza il seguente comando:

curl -X POST -H "Authorization: Bearer $TOKEN" -H "Content-type: application/json" \
    "https://apigee.googleapis.com/v1/organizations/ORG_NAME/spaces/SPACE_NAME:setIamPolicy" -d \
      '{
        "policy":{
          "bindings":[
            {
              "members": ["user:USER_EMAIL"],
              "role": "roles/IAM_ROLE"
            }
          ]
        }
      }'

Dove:

• ORG_NAME è il nome della tua organizzazione Apigee.
• SPACE_NAME è il nome dello spazio.
• USER_EMAIL è l'indirizzo email dell'utente che stai aggiungendo allo spazio. Per aggiungere un gruppo Google anziché un singolo utente, modifica il prefisso da user: a group: e fornisci l'indirizzo email del gruppo.
• IAM_ROLE è il nome del ruolo IAM che stai assegnando al membro.

Rimuovere membri da uno spazio

Per eseguire questa attività, devi disporre dell'autorizzazione apigee.spaces.setIamPolicy.

Console Apigee

Per rimuovere un membro da uno spazio utilizzando l'interfaccia utente di Apigee:

1. Nell'interfaccia utente di Apigee nella console Google Cloud, vai alla pagina Spazi e fai clic sul nome dello spazio.
2. Nella tabella Dettagli accesso, seleziona la casella di controllo accanto a uno o più membri che vuoi rimuovere.
3. Fai clic su Rimuovi accesso.
4. Nella finestra di dialogo di conferma, fai clic su Conferma.

API Apigee

Per rimuovere i membri da uno spazio, imposta una nuova policy IAM per lo spazio con l' elenco rivisto dei membri utilizzando il metodo setIamPolicy. L'utilizzo di questo metodo crea una nuova policy IAM che sostituisce quella esistente.

Ad esempio, per aggiornare i membri dello spazio del team blue, puoi prima controllare la policy IAM attuale utilizzando il seguente comando:

curl -X GET -H "Authorization: Bearer $TOKEN" \
  "https://apigee.googleapis.com/v1/organizations/acme/spaces/blue:getIamPolicy"

L'output del comando restituisce la policy IAM attuale per lo spazio e dovrebbe essere simile al seguente:

{
  "version": "0",
  "bindings": [
    {
      "role": "roles/apigee.spaceContentEditor",
      "members": [
        "group:[e-mail]",
        "user:[e-mail]",
        "user:[e-mail]",
        "user:[e-mail]"
      ]
    }
  ]
}

Per rimuovere [e-mail] dallo spazio, utilizza il seguente comando:

curl -X POST -H "Authorization: Bearer $TOKEN" -H "Content-type: application/json" \
  "https://apigee.googleapis.com/v1/organizations/acme/spaces/blue:setIamPolicy" -d \
    '{
      "policy":{
        "bindings":[
          {
            "members": [
              "group:[e-mail]",
              "user:[e-mail]",
              "user:[e-mail]"
            ],
            "role": "roles/apigee.spaceContentEditor"
          }
        ]
      }
    }'

La nuova policy IAM per lo spazio non includerà più [e-mail].

Per rimuovere un membro da un gruppo incluso in uno spazio, rimuovi prima il membro dal gruppo e poi esegui di nuovo il comando setIamPolicy per aggiornare la policy IAM per lo spazio con l'appartenenza corretta per l' alias email del gruppo.

Elencare tutti gli spazi in un'organizzazione

Per eseguire questa attività, devi disporre dell'autorizzazione apigee.spaces.list.

Console Apigee

Per visualizzare tutti gli spazi, vai alla pagina Spazi nell' interfaccia utente di Apigee nella console Google Cloud.

Vai a Spazi

La tabella Spazi elenca tutti gli spazi della tua organizzazione, inclusi i loro Nome, Nome visualizzato e il numero totale di Membri.

API Apigee

Per elencare tutti gli spazi in un'organizzazione Apigee, utilizza il seguente comando:

curl -X GET -H "Authorization: Bearer $TOKEN" \
    "https://apigee.googleapis.com/v1/organizations/ORG_NAME/spaces"

Dove:

• ORG_NAME è il nome della tua organizzazione Apigee.

Visualizzare i dettagli dello spazio

Per eseguire questa attività, devi disporre dell'autorizzazione apigee.spaces.get.

Console Apigee

Per visualizzare i dettagli dello spazio nell'interfaccia utente di Apigee:

1. Nell'interfaccia utente di Apigee nella console Google Cloud, vai alla pagina Spazi.
2. Fai clic sul nome dello spazio che vuoi visualizzare. La pagina dei dettagli mostra il Nome, Nome visualizzato, i dettagli di accesso, e l'elenco Membri.

API Apigee

Per visualizzare i dettagli di uno spazio, utilizza il seguente comando:

curl -X GET -H "Authorization: Bearer $TOKEN" \
    "https://apigee.googleapis.com/v1/organizations/ORG_NAME/spaces/SPACE_NAME"

Dove:

• ORG_NAME è il nome della tua organizzazione Apigee.
• SPACE_NAME è il nome dello spazio.

Aggiornare uno spazio

Per eseguire questa attività, devi disporre dell'autorizzazione apigee.spaces.update.

Puoi modificare il Nome visualizzato di uno spazio esistente. Il nome univoco non può essere modificato dopo la creazione.

Console Apigee

Per aggiornare uno spazio nell'interfaccia utente di Apigee:

1. Nell'interfaccia utente di Apigee nella console Google Cloud, vai alla pagina Spazi e fai clic sul nome dello spazio che vuoi aggiornare.
2. Fai clic sul pulsante Modifica (icona a forma di matita) accanto all' intestazione "Dettagli dello spazio".
3. Modifica il Nome visualizzato in base alle esigenze.
4. Fai clic su Salva.

API Apigee

Per aggiornare uno spazio utilizzando l'API, utilizza il seguente comando:

curl -X PATCH -H "Authorization: Bearer $TOKEN" -H "Content-Type: application/json" \
    "https://apigee.googleapis.com/v1/organizations/ORG_NAME/spaces/SPACE_NAME" \
      --data-raw '{
        "displayName":"DISPLAY_NAME"
      }'

Dove:

• ORG_NAME è il nome della tua organizzazione Apigee.
• SPACE_NAME è il nome dello spazio.
• DISPLAY_NAME è il nuovo nome visualizzato per lo spazio.

Eliminare uno spazio

Per eseguire questa attività, devi disporre dell'autorizzazione apigee.spaces.delete.

Console Apigee

Avviso: l'eliminazione di uno spazio causa la rimozione immediata dell'accesso dei membri dello spazio a proxy API, flussi condivisi e prodotti API di proprietà dello spazio. L'operazione non può essere annullata.

Per eliminare uno spazio utilizzando l'interfaccia utente di Apigee:

1. Nell'interfaccia utente di Apigee nella console Google Cloud, vai alla pagina Spazi.
2. Fai clic su Elimina nella riga dello spazio che vuoi eliminare.
3. Nella finestra di dialogo di conferma, digita il nome esatto dello spazio per confermare.
4. Fai clic su Elimina.

Nota: se lo spazio contiene ancora risorse attive, l'eliminazione non andrà a buon fine. Elimina o sposta tutte le risorse nello spazio prima di tentare di eliminarlo.

API Apigee

Prima di eliminare uno spazio utilizzando l'API, assicurati che tutte le risorse in lo spazio siano state eliminate o spostate.

curl -X DELETE -H "Authorization: Bearer $TOKEN" \
    "https://apigee.googleapis.com/v1/organizations/ORG_NAME/spaces/SPACE_NAME"

Dove:

• ORG_NAME è il nome della tua organizzazione Apigee.
• SPACE_NAME è il nome dello spazio.

Se tenti di eliminare uno spazio che contiene ancora risorse attive, l'eliminazione non andrà a buon fine e riceverai una risposta simile alla seguente:

{
  "error": {
    "code": 400,
    "message": "Space \"red\" has resources associated with it. Please delete the resources before deleting the space.",
    "status": "FAILED_PRECONDITION"
  }
}

Per risolvere questo errore, elimina o sposta tutte le risorse nello spazio prima di tentare di eliminarlo.

Passaggi successivi

• Scopri di più su Apigee Spaces.
• Scopri come gestire le risorse API con Apigee Spaces.
• Consulta la documentazione di Identity and Access Management (IAM) documentation.