Introduzione all'API Admin

ID regione

REGION_ID è un codice abbreviato assegnato da Google in base alla regione selezionata al momento della creazione dell'app. Il codice non corrispondono a un paese o a una provincia, anche se potrebbero essere visualizzati alcuni ID regione in modo simile ai codici paese e provincia di uso comune. Per le app create dopo febbraio 2020, REGION_ID.r è incluso negli URL di App Engine. Per le app esistenti create prima di questa data, l'ID regione è facoltativo nell'URL.

Scopri di più sugli ID regione.

Questa guida è progettata per aiutarti a scoprire come utilizzare l'API App Engine Admin per eseguire il deployment di un'applicazione Python di esempio in App Engine. Puoi utilizzare la procedura generale Acquisisci informazioni su come creare codice per gestire e gestire in modo programmatico e deployment delle tue app.

In questa guida, l'esempio utilizzato è una semplice app Hello World che visualizza il testo "Hello, World!" ed è disponibile su GitHub. Per l'autorizzazione con la console Google Cloud, vengono utilizzati un ID client OAuth e un browser web. Per illustrare i singoli passaggi della procedura, cURL vengono forniti in modo che tu possa inviare richieste HTTP dal tuo terminale.

Obiettivi

  • Abilita le API nel progetto della console Google Cloud e crea OAuth e credenziali dell'ID client.
  • Ottieni i token di accesso per l'autenticazione con App Engine.
  • Utilizza l'API Admin per eseguire il deployment dell'app di esempio in App Engine.
  • (Facoltativo) Configura il traffico verso la versione in cui hai eseguito il deployment dell'app di esempio.

Prima di iniziare

Configurazione del tuo progetto Google Cloud

Abilita le API App Engine Admin e Cloud Storage nel tuo progetto Google Cloud, quindi configura le credenziali:

  1. Abilita le API nella console Google Cloud:

    Abilita le API

  2. Nella procedura guidata, seleziona un progetto esistente dall'elenco o fai clic su Continua per creare un nuovo progetto.

  3. Fai clic su Continua per creare una credenziale per l'ID client OAuth:

    1. Nella schermata per il consenso OAuth, specifica almeno il tuo Indirizzo email e Nome del prodotto mostrato agli utenti.
    2. Salva le impostazioni della schermata per il consenso e passa allo Scheda Credenziali facendo clic su Salva.
    3. Fai clic su Crea credenziali e poi su ID client OAuth per creare un ID client.
    4. Fai clic su Applicazione web, specifica un nome e utilizza https://www.google.com come URI di reindirizzamento.

    5. Fai clic su Crea per salvare la credenziale.

    6. Prendi nota dell'ID client che viene visualizzato perché verrà utilizzato in un passaggio successivo per richiedere il token di accesso.

Per saperne di più sulla creazione delle credenziali per l'API Admin, consulta Accesso all'API.

Creazione di un file di configurazione

Crea un file di configurazione che definisca il deployment dell'app Hello World. In un denominato app.json, tu definisci il bucket Cloud Storage di Hello World nel campo sourceUrl e le informazioni di configurazione relative alla versione, incluso l'ID versione nel campo id.

{
  "deployment": {
    "files": {
      "main.py": {
        "sourceUrl": "https://storage.googleapis.com/admin-api-public-samples/hello_world/main.py"
      },
    }
  },
  "handlers": [
    {
      "script": {
        "scriptPath": "main.app"
      },
      "urlRegex": "/.*"
    }
  ],
  "runtime": "python27",
  "threadsafe": true,
  "id": "appengine-helloworld",
  "inboundServices": [
    "INBOUND_SERVICE_WARMUP"
  ]
}

Ad esempio, root/python-docs-samples/appengine/standard/hello_world/app.json

Autorizzazione delle richieste HTTP

Esegui l'autenticazione con App Engine per poter inviare richieste HTTP con l'API Admin.

Utilizza una delle seguenti opzioni per iniziare rapidamente. Entrambi le opzioni HTTPS e gcloud forniscono passaggi manuali ma semplici per ottenere i token di accesso per provare l'API Admin.

HTTPS

Per simulare un flusso OAuth 2.0 lato client, aggiungi il tuo ID client OAuth le credenziali a un URI e poi inviare la richiesta HTTPS Browser:

  1. Nel browser web, richiedi un token di accesso utilizzando l'ID client di le credenziali dell'API. Il seguente esempio utilizza client_id=[MY_CLIENT_ID] e redirect_uri=https://www.google.com, dove [MY_CLIENT_ID] è l'ID cliente della credenziale che hai creato in precedenza:

    https://accounts.google.com/o/oauth2/v2/auth?response_type=token&client_id=[MY_CLIENT_ID]&scope=https://www.googleapis.com/auth/cloud-platform&redirect_uri=https://www.google.com
    
  2. Recupera il token di accesso dalla risposta alla richiesta.

    Il campo dell'indirizzo nel browser web deve contenere l'URI di reindirizzamento specificato nelle tue credenziali insieme al token di accesso aggiunto all'URI, ad esempio:

    https://www.google.com/#access_token=[MY_ACCESS_TOKEN]&token_type=Bearer&expires_in=3600
    

    Ora puoi utilizzare il token di accesso [MY_ACCESS_TOKEN] fornito nel campo access_token per inviare richieste HTTP al tuo progetto Google Cloud.

gcloud

Per recuperare semplicemente un token di accesso, esegui i seguenti comandi gcloud:

  1. Imposta la credenziale predefinita dell'applicazione (ADC) che vuoi utilizzare per richiedere un token di accesso:

    gcloud auth application-default login
    
  2. Richiedi il token di accesso:

    gcloud auth application-default print-access-token
    

Per maggiori dettagli su questi comandi, vedi gcloud auth application-default.

Ricorda: il token di accesso scade circa 60 minuti dopo l'emissione.

Le opzioni riportate sopra non sono destinate all'utilizzo nell'implementazione programmatica, ma le informazioni su come implementare un flusso di autorizzazione OAuth 2.0 sono disponibili in Accedere all'API Admin.

Deployment dell'app Hello World

Puoi utilizzare una richiesta HTTP per eseguire il deployment dell'app Hello World con API Admin:

  1. Invia un HTTP POST richiesta utilizzando l'API Admin per eseguire il deployment di una versione dell'app Hello World dell'applicazione App Engine, ad esempio:

    POST https://appengine.googleapis.com/v1/apps/[MY_PROJECT_ID]/services/default/versions app.json
    

    Comando cURL di esempio:

    Esegui il comando dalla directory in cui hai creato il file di configurazione app.json, ad esempio:

    cd root/python-docs-samples/appengine/standard/hello_world/
    
    curl -X POST -T "app.json" -H "Content-Type: application/json" -H "Authorization: Bearer [MY_ACCESS_TOKEN]" https://appengine.googleapis.com/v1/apps/[MY_PROJECT_ID]/services/default/versions
    

    Dove:

    • [MY_ACCESS_TOKEN] è il token di accesso che hai ottenuto per autorizzare le tue richieste HTTP.
    • [MY_PROJECT_ID] è l'ID del progetto in cui vuoi eseguire il deployment completamente gestita.

    Risposta di esempio:

    {
      "name": "apps/[MY_PROJECT_ID]/operations/89729825-ef1f-4ffa-b3e3-e2c25eb66a85",
      "metadata": {
        "@type": "type.googleapis.com/google.appengine.v1.OperationMetadataV1",
        "insertTime": "2016-07-29T17:12:44.679Z",
        "method": "google.appengine.v1.Versions.CreateVersion",
        "target": "apps/[MY_PROJECT_ID]/services/default/versions/appengine-helloworld",
        "user": "me@example.com"
      }
    }
    

    dove [MY_PROJECT_ID] è l'ID progetto Google Cloud.

  2. Verifica che la versione dell'app Hello World sia stata dipiattaformata correttamente nella tua applicazione App Engine:

    1. Visualizza lo stato dell'effettiva operazione di deployment utilizzando il nome l'operazione restituita nel passaggio precedente come campo name in un'istanza HTTP GET , Ad esempio:

      GET https://appengine.googleapis.com/v1/[OPERATION_NAME]
      

      Comando cURL di esempio:

      curl -H "Authorization: Bearer [MY_ACCESS_TOKEN]" https://appengine.googleapis.com/v1/[OPERATION_NAME]
      

      Dove:

      • [OPERATION_NAME] è il valore del campo name restituito nel passaggio precedente quando hai eseguito il deployment dell'app, ad esempio apps/[MY_PROJECT_ID]/operations/89729825-ef1f-4ffa-b3e3-e2c25eb66a85.
      • [MY_ACCESS_TOKEN] è il token di accesso che hai ottenuto per autorizzare per le tue richieste HTTP.
      • [MY_PROJECT_ID] è l'ID del progetto in cui vuoi eseguire il deployment completamente gestita.

      Risposta di esempio:

      {
        "done": true,
        "metadata": {
          "@type": "type.googleapis.com/google.appengine.v1.OperationMetadataV1",
          "endTime": "2016-07-29T17:13:20.424Z",
          "insertTime": "2016-07-29T17:12:44.679Z",
          "method": "google.appengine.v1.Versions.CreateVersion",
          "target": "apps/[MY_PROJECT_ID]/services/default/versions/appengine-helloworld",
          "user": "me@example.com"
        },
        "name": "apps/[MY_PROJECT_ID]/operations/89729825-ef1f-4ffa-b3e3-e2c25eb66a85",
        "response": {
          "@type": "type.googleapis.com/google.appengine.v1.Version",
          "creationTime": "2016-07-29T17:12:46.000Z",
          "deployer": "me@example.com",
          "id": "appengine-helloworld",
          "name": "apps/[MY_PROJECT_ID]/services/default/versions/appengine-helloworld",
          "runtime": "python27",
          "servingStatus": "SERVING",
          "threadsafe": true,
        }
      }
      

      dove [MY_PROJECT_ID] è l'ID progetto Google Cloud.

    2. Verifica che la versione dell'app Hello World sia stata creata nella tua app dell'applicazione motore utilizzando una richiesta GET HTTP per visualizzare i dettagli della versione, ad esempio:

      GET https://appengine.googleapis.com/v1/apps/[MY_PROJECT_ID]/services/default/versions/appengine-helloworld/?view=FULL
      

      Comando cURL di esempio:

      curl -H "Authorization: Bearer [MY_ACCESS_TOKEN]" https://appengine.googleapis.com/v1/apps/[MY_PROJECT_ID]/services/default/versions/appengine-helloworld/?view=FULL
      

      Dove:

      • [MY_ACCESS_TOKEN] è il token di accesso che hai ottenuto per autorizzare le tue richieste HTTP.
      • [MY_PROJECT_ID] è l'ID del progetto in cui vuoi eseguire il deployment completamente gestita.

      Risposta di esempio:

      {
        "creationTime": "2016-07-29T17:12:46.000Z",
        "deployer": "me@example.com",
        "deployment": {
          "files": {
            "main.py": {
              "sha1Sum": "13f7ea1e24f7cd2de5c66660525f2b509da37c14",
              "sourceUrl": "https://storage.googleapis.com/admin-api-public-samples/hello_world/main.py"
            }
          }
        },
        "handlers": [
          {
            "authFailAction": "AUTH_FAIL_ACTION_REDIRECT",
            "login": "LOGIN_OPTIONAL",
            "script": {
              "scriptPath": "main.app",
            },
            "securityLevel": "SECURE_OPTIONAL",
            "urlRegex": "/.*"
          }
        ]
        "id": "appengine-helloworld",
        "name": "apps/[MY_PROJECT_ID]/services/default/versions/appengine-helloworld",
        "runtime": "python27",
        "servingStatus": "SERVING",
        "threadsafe": true,
        "versionUrl": "https://appengine-helloworld-dot-[MY_PROJECT_ID].[REGION_ID].r.appspot"
      }
      

      dove [MY_PROJECT_ID] è l'ID progetto Google Cloud.

  3. Visualizza l'app Hello World nel tuo browser web visitando l'URL specificato in il campo versionUrl della risposta HTTP del passaggio precedente, per esempio:

    https://appengine-helloworld-dot-[MY_PROJECT_ID].[REGION_ID].r.appspot.com
    

    dove [MY_PROJECT_ID] è l'ID progetto Google Cloud.

    REGION_ID è un codice abbreviato assegnato da Google in base alla regione selezionata quando crei l'app. Il codice non corrisponde a un paese o a una provincia, anche se alcuni ID regione possono sembrare simili ai codici di paesi e province di uso comune. Per le app create dopo il giorno Febbraio 2020, REGION_ID.r è incluso in URL di App Engine. Per le app esistenti create prima di questa data, l'ID regione è facoltativo nell'URL.

  4. Configura il traffico verso l'app Hello World.

    Per impostazione predefinita, la versione iniziale di cui esegui il deployment in una nuova applicazione App Engine riceve automaticamente il 100% del traffico e le eventuali versioni successive non ricevono traffico.

    1. Per verificare se la tua versione è configurata per ricevere traffico, invia una HTTP GET richiesta, Ad esempio:

      GET https://appengine.googleapis.com/v1/apps/[MY_PROJECT_ID]/services/default
      

      Comando cURL di esempio:

      curl -H "Authorization: Bearer [MY_ACCESS_TOKEN]" https://appengine.googleapis.com/v1/apps/[MY_PROJECT_ID]/services/default
      

      Dove:

      • [MY_ACCESS_TOKEN] è il token di accesso che hai ottenuto per autorizzare le tue richieste HTTP.
      • [MY_PROJECT_ID] è l'ID del progetto in cui vuoi eseguire il deployment completamente gestita.

      Risposta di esempio:

      {
        "name": "apps/[MY_PROJECT_ID]/services/default/",
        "id": "default",
        "split": {
          "allocations": {
            "appengine-helloworld": 1
          }
        }
      }
      

      dove [MY_PROJECT_ID] è l'ID progetto Google Cloud.

    2. Per spostare tutto il traffico in una versione, invia una richiesta HTTP PATCH, ad esempio:

      PATCH https://appengine.googleapis.com/v1/apps/[MY_PROJECT_ID]/services/default/?updateMask=split {"split": { "allocations": { "appengine-helloworld": 1 } } }
      

      Esempio di comando cURL:

      curl -X PATCH -H "Content-Type: application/json" -d "{ 'split': { 'allocations': { 'appengine-helloworld': '1' } } }" -H "Authorization: Bearer [MY_ACCESS_TOKEN]" https://appengine.googleapis.com/v1/apps/[MY_PROJECT_ID]/services/default/?updateMask=split
      

      Dove:

      • [MY_ACCESS_TOKEN] è il token di accesso che hai ottenuto per autorizzare le tue richieste HTTP.
      • [MY_PROJECT_ID] è l'ID del progetto in cui vuoi eseguire il deployment completamente gestita.

      Risposta di esempio:

      {
        "name": "apps/[MY_PROJECT_ID]/operations/bdda402c-77a9-4c6d-b022-f2f69ba78420",
        "metadata": {
          "@type": "type.googleapis.com/google.appengine.v1.OperationMetadataV1",
          "insertTime": "2016-07-29T17:25:30.413Z",
          "method": "com.google.appengine.v1.Services.UpdateService",
          "target": "apps/[MY_PROJECT_ID]/services/default",
          "user": "me@example.com"
        }
      }
      

      Dove [MY_PROJECT_ID] è l'ID progetto Google Cloud.

Apprendimento esteso

Se hai più di una versione di un'app, puoi svolgere i seguenti passaggi per suddividere il traffico tra queste versioni:

  1. Per eseguire il deployment di una seconda versione dell'app Hello World nello stesso App Engine: applicazione:

    1. Nel file di configurazione app.json esistente dell'app Ciao Mondo che hai creato in precedenza, aggiorna il campo id per specificare una versione diversa. Ad esempio, aggiungi -2:

      "id": "appengine-helloworld-2"
      
    2. Ripeti tutti gli stessi passaggi per eseguire il deployment di una versione appengine-helloworld-2, ad esempio:

      1. Esegui l'autenticazione nel progetto.
      2. Esegui il deployment della nuova versione di appengine-helloworld-2.
      3. Verifica che il deployment della versione appengine-helloworld-2 sia andato a buon fine.
      4. Visualizza l'app in esecuzione nel browser web.
  2. Segui le istruzioni per la suddivisione del traffico in Eseguire la migrazione e suddividere il traffico, ad esempio invia una richiesta HTTP PATCH:

    PATCH https://appengine.googleapis.com/v1/apps/[MY_PROJECT_ID]/services/default/?updateMask=split { 'split': { 'shardBy': 'IP', 'allocations': { 'appengine-helloworld': '0.5', 'appengine-helloworld-2': '0.5' } } }
    

    Esempio di comando cURL:

    curl -X PATCH -H "Content-Type: application/json" -d "{ 'split': { 'shardBy': 'IP', 'allocations': { 'appengine-helloworld': '0.5', 'appengine-helloworld-2': '0.5' } } }" -H "Authorization: Bearer [MY_ACCESS_TOKEN]" https://appengine.googleapis.com/v1/apps/[MY_PROJECT_ID]/services/default/?updateMask=split
    

    Dove:

    • [MY_ACCESS_TOKEN] è il token di accesso che hai ottenuto per autorizzare le tue richieste HTTP.
    • [MY_PROJECT_ID] è l'ID del progetto in cui vuoi eseguire il deployment della versione.

Passaggi successivi

  • Crea, configura e imposta le credenziali per le tue applicazioni: Accesso all'API