Gestire le risorse API con Apigee Spaces

Questa pagina si applica ad Apigee e Apigee hybrid.

Visualizza la documentazione di Apigee Edge.

Questo argomento descrive come creare e gestire le risorse API in uno spazio. Puoi creare proxy API, flussi condivisi e prodotti API in uno spazio. Le risorse create nello spazio ereditano le stesse autorizzazioni dello spazio.

La creazione di risorse in uno spazio è uguale alla creazione di risorse in un'organizzazione Apigee, con la differenza che puoi selezionare uno spazio quando crei la risorsa. Puoi creare risorse API dalla riga di comando utilizzando le API Apigee o la console Apigee in Cloud.

Questa guida illustra i passaggi necessari per:

Per una panoramica di Apigee Spaces, vedi Apigee Spaces.

Per ulteriori informazioni sui tipi di risorse API Apigee, vedi:

Prima di iniziare

Prima di iniziare a creare risorse API in Apigee Spaces, assicurati di completare le seguenti attività:

  • Esegui il provisioning dell'organizzazione Apigee con abbonamento o con pagamento a consumo. Per ulteriori informazioni sui passaggi necessari per il provisioning di Apigee, vedi Configurare Apigee.
  • Crea uno spazio nella tua organizzazione Apigee. Per maggiori informazioni, vedi Creare spazi Apigee.
  • Assegnare membri a uno spazio. Per saperne di più, vedi Gestire membri e ruoli in uno spazio.

Ruoli e autorizzazioni richiesti

Con l'introduzione di Apigee Spaces, è cambiato il modo in cui IAM controlla le autorizzazioni necessarie per eseguire alcune operazioni sulle risorse API. Se la risorsa API esiste in uno spazio, IAM verificherà le autorizzazioni appropriate a livello di spazio per il membro dello spazio che esegue l'operazione. Per ulteriori informazioni, consulta Ruoli e autorizzazioni di Apigee Spaces e Gerarchia delle autorizzazioni IAM per Apigee Spaces.

Assegnare ruoli e autorizzazioni ai membri dello spazio

Sono disponibili tre ruoli personalizzati per i membri dello spazio:

  • apigee.spaceContentEditor: Fornisce l'accesso completo alle risorse che possono essere associate a uno spazio. Questo ruolo deve essere concesso a livello di spazio.
  • apigee.spaceContentViewer: Fornisce l'accesso di sola lettura alle risorse che possono essere associate a uno spazio. Questo ruolo deve essere concesso a livello di spazio.
  • apigee.spaceConsoleUser: fornisce le autorizzazioni minime necessarie per gestire le risorse in uno spazio utilizzando la console Google Cloud . Questo ruolo deve essere concesso a livello di progetto agli utenti con accesso alle risorse in questo spazio. Google Cloud

I ruoli personalizzati descritti in questa sezione non consentono ai membri dello spazio di eseguire il deployment o l'undeployment di proxy API o flussi condivisi. Se vuoi consentire a un membro dello spazio di gestire i deployment, imposta una policy IAM a livello di ambiente Apigee o di progetto Google Cloud che conceda il ruolo apigee.environment.admin al membro dello spazio.

Puoi assegnare uno o più ruoli a un membro di uno spazio utilizzando uno dei seguenti metodi:

  • Aggiungi il ruolo apigee.spaceContentEditor allo spazio utilizzando l'API e aggiungi il ruolo apigee.environmentAdmin all'ambiente di destinazione utilizzando l'API.
  • Aggiungi i ruoli al progetto utilizzando l'interfaccia utente IAM.

Per verificare i ruoli a livello di progetto Google Cloud :

  1. Nella console Google Cloud , 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 a quali gruppi appartieni, contatta il tuo amministratore.

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

Per concedere i ruoli

  1. Nella console Google Cloud , 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. Nell'elenco Seleziona un ruolo, seleziona un ruolo.
  6. Per concedere altri ruoli, fai clic su Aggiungi un altro ruolo e aggiungi ogni ruolo aggiuntivo.
  7. Fai clic su Salva.

Per verificare le policy IAM applicate a livello di spazio, consulta Gestire membri e ruoli in uno spazio.

Gestire i proxy API in uno spazio

I membri dell'organizzazione Apigee assegnati a uno spazio possono creare proxy API come risorse dello spazio. I membri assegnati solo ad altri spazi non potranno accedere a questi proxy o gestirli.

Crea un proxy API come risorsa Space utilizzando la console Apigee in Cloud o l'API, come descritto nelle sezioni seguenti.

Apigee nella console Cloud

Per creare un proxy API come risorsa Space utilizzando la console Apigee in Cloud:

  1. Segui i passaggi descritti nella sezione Creazione di un proxy API.
  2. Nel passaggio 5, vedrai un campo aggiuntivo nella sezione Dettagli proxy in cui puoi selezionare uno spazio per il proxy API. Seleziona uno spazio dalla casella di elenco. Se non vuoi assegnare il proxy API a uno spazio, puoi saltare questo campo.
  3. Fai clic su Avanti per passare al passaggio di deployment facoltativo della creazione del proxy o fai clic su Crea per creare il proxy senza eseguirne il deployment.

API Apigee

Per creare un proxy API come risorsa Space utilizzando le API Apigee, utilizza il seguente comando: 

curl "https://apigee.googleapis.com/v1/organizations/ORG_NAME/apis?name=PROXY_NAME&space=SPACE_NAME&action=import" \
    -X POST -H "Authorization: Bearer $TOKEN" \
    -H "Content-type: multipart/form-data" \
    -F "file=@PROXY_BUNDLE"

Dove:

  • ORG_NAME è il nome della tua organizzazione Apigee.
  • PROXY_NAME è il nome del proxy API che stai creando. Il nome deve essere univoco a livello globale e non solo all'interno dello spazio.
  • SPACE_NAME è il nome dello spazio in cui stai creando il proxy API.
  • PROXY_BUNDLE è il nome del file del pacchetto proxy API.

Ad esempio, con il seguente comando, un membro del team red crea un proxy API denominato proxy-1 come risorsa spazio red nell'organizzazione acme utilizzando il file proxy-bundle.zip: 

curl "https://apigee.googleapis.com/v1/organizations/acme/apis?name=proxy-1&space=red&action=import" \
    -X POST -H "Authorization: Bearer $TOKEN" \
    -H "Content-type: multipart/form-data \
    -F "file=@proxy-bundle.zip"

L'esempio seguente mostra la risposta al comando: 

{
  "basepaths": ["/proxy-1"],
  "revision": 1,
  "apiProxyId": "proxy-1",
  "resourceName": "organizations/acme/apis/proxy-1/revisions/1",
  "space": "red",
  "createTime": ...,
  "updateTime": ...
}

Gestire i flussi condivisi come risorse dello spazio

I membri assegnati a uno spazio possono anche creare flussi condivisi come risorse dello spazio. I membri di altri spazi non potranno accedere a questi flussi condivisi o gestirli.

Crea un flusso condiviso come risorsa spazio utilizzando la console Apigee in Cloud o l'API, come descritto nelle sezioni seguenti.

Apigee nella console Cloud

Per creare un flusso condiviso come risorsa Space utilizzando Apigee nella console Google Cloud:
  1. segui i passaggi descritti in Creare un flusso condiviso nell'interfaccia utente Apigee per creare un nuovo flusso condiviso da zero o caricare un bundle di flussi esistente.
  2. Nel passaggio 4, nella finestra di dialogo Crea un flusso condiviso vedrai un campo aggiuntivo in cui puoi selezionare uno spazio per il proxy API. Seleziona uno spazio dalla casella di elenco. Se non vuoi assegnare il proxy API a uno spazio, puoi saltare questo campo.
  3. Fai clic su Crea per creare il flusso condiviso.

API Apigee

Per creare un flusso condiviso come risorsa Space utilizzando le API Apigee, utilizza il seguente comando: 

curl "https://apigee.googleapis.com/v1/organizations/ORG_NAME/sharedflows?name=FLOW_NAME&space=SPACE_NAME&action=import" \
    -X POST -H "Authorization: Bearer $TOKEN" \
    -H "Content-type: multipart/form-data" \
    -F "file=@SHARED_FLOW_BUNDLE"

Dove:

  • ORG_NAME è il nome della tua organizzazione Apigee.
  • FLOW_NAME è il nome del flusso condiviso che stai creando. Il nome deve essere univoco a livello globale e non solo all'interno dello spazio.
  • SPACE_NAME è il nome dello spazio in cui stai creando il flusso condiviso.
  • SHARED_FLOW_BUNDLE è il nome del file bundle del flusso condiviso.

Ad esempio, con il seguente comando, un membro del team red crea un flusso condiviso denominato flow-1 associato allo spazio red nell'organizzazione acme: 

curl "https://apigee.googleapis.com/v1/organizations/acme/sharedflows?name=flow-1&space=red&action=import" \
    -X POST -H "Authorization: Bearer $TOKEN" \
    -H "Content-type: multipart/form-data" \
    -F "file=@sharedflow-bundle.zip"

L'esempio seguente mostra la risposta al comando: 

{
  "name": "organizations/acme/sharedflows/flow-1",
  "revision": 1,
  "sharedFlowId": "flow-1",
  "space": "red",
  "createTime": ...,
  "updateTime": ...
}

Gestire un prodotto API come risorsa di uno spazio

I membri assegnati a uno spazio possono creare un prodotto API per raggruppare i propri proxy API. Quando creano prodotti API, i membri dello spazio possono selezionare qualsiasi proxy API accessibile, inclusi i proxy creati direttamente nell'organizzazione e i proxy API creati come risorse negli spazi in cui sono membri. I membri di altri spazi non potranno accedere a questi prodotti API o gestirli.

Crea un prodotto API come risorsa spazio utilizzando la console Apigee in Cloud o l'API, come descritto nelle sezioni seguenti.

Apigee nella console Cloud

Per creare un prodotto API come risorsa Space utilizzando Apigee in Cloud Console:

  1. Segui i passaggi descritti in Creare un prodotto API.
  2. Nel passaggio 4, nella pagina Dettagli prodotto vedrai un campo aggiuntivo in cui puoi selezionare uno spazio per il prodotto API. Seleziona uno spazio dalla casella di elenco. Se non vuoi assegnare il prodotto API a uno spazio, puoi saltare questo campo.
  3. Completa le informazioni di configurazione rimanenti e fai clic su Salva.

API Apigee

Per creare un prodotto API come risorsa Space utilizzando l'API, invia una richiesta all'endpoint apiproducts/create e aggiungi la proprietà space.

Ad esempio, il seguente comando creerebbe un prodotto API denominato product-1 nell'organizzazione acme e associato allo spazio red: 

curl -X POST "https://apigee.googleapis.com/v1/organizations/acme/apiproducts" \
    -H "Authorization: Bearer $TOKEN" \
    -H "Content-type: application/json" -d \
      `{
        "name": "product-1",
        "displayName": "product-1",
        "approvalType": "auto",
        "attributes": [
          {
            "name": "access",
            "value": "internal"
          }
        ],
        "environments": [
          "test"
        ],
        "operationGroup": {
          "operationConfigs": [
            {
              "apiSource": "proxy-1",
              "operations": [
                {
                  "resource": "/",
                  "methods": [
                    "GET"
                  ]
                }
              ]
            }
          ],
          "operationConfigType": "proxy"
        },
        "space": "red"
      }'

L'esempio seguente mostra la risposta al comando: 

{
  "name": "product-1",
  "displayName": "product-1",
  "approvalType": "auto",
    "attributes": [
      {
        "name": "access",
        "value": "internal"
      }
    ],
    "environments": [
    "test"
  ],
  "createdAt": "1741977778448",
  "lastModifiedAt": "1741977778448",
  "operationGroup": {
    "operationConfigs": [
      {
        "apiSource": "proxy-1",
        "operations": [
          {
            "resource": "/",
            "methods": [
              "GET"
            ]
          }
        ]
      }
    ],
    "operationConfigType": "proxy"
  },
  "space": "red"
}

Elenca tutte le risorse API associate a uno spazio

Per tutte le operazioni di elenco, inclusi ListApiProxies, ListSharedFlows e ListApiProducts, puoi specificare un nome dello spazio per elencare tutte le risorse associate a quello spazio. Se non specifichi un nome dello spazio, l'operazione di elenco restituirà tutte le risorse dell'organizzazione a cui hai l'autorizzazione di accedere, indipendentemente dal fatto che siano associate o meno a uno spazio.

È importante notare che, quando si utilizza la funzionalità Spazi Apigee, i risultati delle operazioni list per le risorse API assegnate a uno spazio saranno limitati ai risultati degli spazi a cui il principal può accedere. Ad esempio, se a acme-team@acme.com viene assegnato il ruolo apigee.spaceContentEditor per lo spazio red, i membri del team acme-team che utilizzano l'operazione list vedranno solo i proxy API associati allo spazio red e non tutti i proxy API dell'organizzazione.

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

Elenca le risorse API associate a uno spazio specifico

Elenca tutte le risorse API associate a uno spazio specifico nella console Apigee in Cloud o utilizzando l'API, come descritto nelle sezioni seguenti.

Apigee nella console Cloud

Per elencare tutte le risorse API associate a uno spazio specifico nella console Apigee in Cloud, apri la pagina di panoramica per il tipo di risorsa pertinente (proxy API, flussi condivisi o prodotti API). Nella casella Filtro, seleziona l'opzione Spazio dall'elenco, poi inserisci il nome dello spazio. Viene visualizzato l'elenco delle risorse assegnate a questo spazio. Tieni presente che vengono visualizzate solo le risorse associate a uno spazio di cui l'utente è membro.

API Apigee

Per elencare tutte le risorse API associate a uno spazio specificato, utilizza il seguente comando: 

curl -H "Authorization: Bearer $TOKEN" "https://apigee.googleapis.com/v1/organizations/ORG_NAME/RESOURCE_TYPE?space=SPACE_NAME"

Dove:

  • ORG_NAME è il nome della tua organizzazione Apigee.
  • RESOURCE_TYPE è il tipo di risorsa che stai elencando. I valori validi includono:
    • apis
    • sharedFlows
    • apiProducts
  • SPACE_NAME è il nome dello spazio in cui stai elencando la risorsa.

Ad esempio, con il seguente comando, un membro del team red elenca tutti i proxy API associati allo spazio red nell'organizzazione acme: 

curl -H  "Authorization: Bearer $TOKEN" "https://apigee.googleapis.com/v1/organizations/acme/apis?space=red"

L'esempio seguente mostra la risposta al comando: 

{
  "proxies": [
    {
      "basepaths": "/proxy-1",
      "revision": "1",
      "apiProxyId": "proxy-1",
      "resourceName": "organizations/acme/apis/proxy-1/revisions/1",
      "space": "red",
      "createTime": ...,
      ....
    }
  ]
}

Elenca le risorse API senza specificare uno spazio

Elenca tutte le risorse API senza specificare uno spazio in Apigee nella console Google Cloud o utilizzando l'API, come descritto nelle sezioni seguenti.

Apigee nella console Cloud

Per visualizzare un elenco di tutte le risorse API di un determinato tipo in Apigee nella console Cloud, indipendentemente dall'associazione allo spazio, apri la pagina di panoramica per il tipo di risorsa pertinente (proxy API, flussi condivisi o prodotti API). Viene visualizzato un elenco di tutte le risorse disponibili. Tieni presente che vengono visualizzate solo le risorse per cui l'utente dispone dell'autorizzazione di visualizzazione. Sono incluse le risorse associate a uno spazio o a spazi di cui l'utente è membro oppure le risorse non associate a uno spazio.

API Apigee

Puoi anche elencare le risorse API senza specificare uno spazio utilizzando il seguente comando: 

curl -H "Authorization: Bearer $TOKEN" "https://apigee.googleapis.com/v1/organizations/ORG_NAME/RESOURCE_TYPE"

Dove:

  • ORG_NAME è il nome della tua organizzazione Apigee.
  • RESOURCE_TYPE è il tipo di risorsa che stai elencando. I valori validi includono:
    • apis
    • sharedFlows
    • apiProducts

Ad esempio, un utente con accesso Organization Admin a tutte le risorse dell'organizzazione può utilizzare il seguente comando per elencare tutti i proxy API nell'organizzazione acme: 

curl -H  "Authorization: Bearer $TOKEN" "https://apigee.googleapis.com/v1/organizations/acme/apis"

Se l'organizzazione acme ha tre proxy, il comando restituirà i dettagli di tutti e tre. Ad esempio: 

{
  "proxies": [
    {
      "basepaths": "/proxy-1",
      "revision": "1",
      "apiProxyId": "proxy-1",
      "resourceName": "organizations/acme/apis/proxy-1/revisions/1",
      "space": "red",
      "createTime": ...,
      ....
    },
    {
      "basepaths": "/proxy-2",
      "revision": "1",
      "apiProxyId": "proxy-2",
      "resourceName": "organizations/acme/apis/proxy-2/revisions/1",
      "space": "blue",
      "createTime": ...,
      ....
    },
    {
      "basepaths": "/proxy-3",
      "revision": "1",
      "apiProxyId": "proxy-3",
      "resourceName": "organizations/acme/apis/proxy-3/revisions/1",
      "space": "green",
      "createTime": ...,
      ....
    }
  ]
}

Se un altro utente con accesso apiAdmin alle risorse nello spazio red utilizza lo stesso comando, il comando restituirà solo i dettagli di proxy-1. La risposta sarà simile alla seguente: 

{
  "proxies": [
    {
      "basepaths": "/proxy-1",
      "revision": "1",
      "apiProxyId": "proxy-1",
      "resourceName": "organizations/acme/apis/proxy-1/revisions/1",
      "space": "red",
      "createTime": ...,
      ....
    }
  ]
}

Passaggi successivi