Invio di richieste batch

Questo documento mostra come effettuare chiamate API JSON in batch per ridurre il numero di connessioni HTTP che il tuo client deve effettuare quando accede a Cloud Storage.

Panoramica

Ogni connessione HTTP stabilita dal client comporta un determinato overhead. L'API JSON di Cloud Storage supporta il raggruppamento in batch per consentire al client di inserire più chiamate API in una singola richiesta HTTP.

Esempi di situazioni in cui potresti voler utilizzare il raggruppamento in batch:

• Aggiornamento dei metadati, ad esempio le autorizzazioni, su molti oggetti.
• Eliminazione di molti oggetti.

In ogni caso, anziché inviare ogni chiamata separatamente, puoi raggrupparle in un'unica richiesta HTTP. Tutte le richieste interne devono essere indirizzate all'API JSON di Cloud Storage.

Non devi includere più di 100 chiamate in una singola richiesta batch. Se devi effettuare più chiamate, utilizza più richieste batch. Il payload totale della richiesta batch deve essere inferiore a 10 MB.

Nota: il sistema batch per l'API JSON di Cloud Storage utilizza la stessa sintassi del sistema di elaborazione batch OData, ma la semantica è diversa.

Nota: Cloud Storage non supporta le operazioni batch per il caricamento o il download.

Dettagli batch

Una richiesta batch è composta da più chiamate API combinate in un'unica richiesta HTTP, che può essere inviata all'endpoint batch di Cloud Storage , ovvero https://storage.googleapis.com/batch/storage/v1. Questa sezione descrive la sintassi batch in dettaglio; di seguito è riportato un esempio.

Nota: un insieme di n richieste raggruppate in batch viene conteggiato ai fini del limite di utilizzo e dei costi delle operazioni come n richieste, non come una singola richiesta. La richiesta batch viene suddivisa in un insieme di n richieste prima dell'elaborazione.

Formato di una richiesta batch

Una richiesta batch è una singola richiesta HTTP standard contenente più chiamate all'API JSON di Cloud Storage. Questa richiesta principale utilizza il tipo di contenuto multipart/mixed. All'interno della richiesta HTTP principale, sono presenti più parti, ognuna delle quali contiene una richiesta HTTP nidificata.

Ogni parte inizia con la propria intestazione HTTP Content-Type: application/http. La parte può anche avere un'intestazione Content-ID facoltativa. Queste intestazioni contrassegnano l'inizio della parte, ma sono separate dalla richiesta HTTP nidificata. Ciò significa che, dopo che il server ha scomposto la richiesta batch in richieste separate, le intestazioni delle parti vengono ignorate.

Il corpo di ogni parte è una richiesta HTTP completa, con verbo, URL, intestazioni e corpo. Queste richieste HTTP devono contenere solo la parte di percorso dell'URL; gli URL completi possono avere un comportamento non definito.

Le intestazioni HTTP per la richiesta batch esterna, ad eccezione delle Content- intestazioni come Content-Type, si applicano anche a ogni richiesta nidificata. Tuttavia, se specifichi una determinata intestazione HTTP sia nella richiesta esterna che in una richiesta nidificata, il valore dell'intestazione della richiesta nidificata esegue l'override del valore dell'intestazione della richiesta batch esterna per quella richiesta specifica.

Ad esempio, se fornisci un'intestazione Authorization per una richiesta nidificata specifica, questa intestazione si applica solo alla richiesta che l'ha specificata. Se fornisci un'intestazione Authorization per la richiesta esterna, questa intestazione si applica a tutte le richieste nidificate, a meno che non eseguano l'override con un'intestazione Authorization propria.

Quando Cloud Storage riceve la richiesta raggruppata in batch, applica i parametri di ricerca e le intestazioni della richiesta esterna (se opportuno) a ogni parte e poi tratta ogni parte come se fosse una richiesta HTTP separata.

Risposta a una richiesta batch

La risposta di Cloud Storage è una singola risposta HTTP standard con un tipo di contenuto multipart/mixed; ogni parte di questa risposta principale è la risposta a una delle richieste nella richiesta raggruppata in batch. L'ordine delle risposte è lo stesso delle richieste.

Come tutte le parti di una richiesta, ogni parte della risposta contiene una risposta HTTP completa, inclusi un codice di stato, le intestazioni e un corpo. E come le parti della richiesta, ogni parte della risposta è preceduta da un'intestazione Content-Type che contrassegna l'inizio della parte. Per ulteriori informazioni sui codici di stato, consulta Codici di stato ed errore HTTP per l'API JSON di Cloud Storage.

Se una determinata parte della richiesta aveva un'intestazione Content-ID, la parte corrispondente della risposta ha un'intestazione Content-ID corrispondente. L'Content-ID header della risposta inizia con response-, seguita dal valore Content-ID utilizzato nella richiesta, come mostrato nell'esempio.

Attenzione: il server potrebbe eseguire le richieste in qualsiasi ordine. Non fare affidamento sull'esecuzione delle richieste nell'ordine in cui le specifichi. Per assicurarti che due chiamate avvengano in un ordine specifico, invia la prima da sola, poi attendi la risposta alla prima prima di inviare la seconda.

Esempio

L'esempio batch seguente aggiorna i metadati personalizzati per tre oggetti in example-bucket.

Esempio di richiesta HTTP batch

HTTP

POST /batch/storage/v1 HTTP/1.1
Host: storage.googleapis.com
Content-Length: 960
Content-Type: multipart/mixed; boundary="===============7330845974216740156=="
Authorization: Bearer ya29.AHES6ZRVmB7fkLtd1XTmq6mo0S1wqZZi3-Lh_s-6Uw7p8vtgSwg

--===============7330845974216740156==
Content-Type: application/http
Content-Transfer-Encoding: binary
Content-ID: <b29c5de2-0db4-490b-b421-6a51b598bd22+1>

PATCH /storage/v1/b/example-bucket/o/obj1 HTTP/1.1
Content-Type: application/json
accept: application/json
content-length: 31

{"metadata": {"type": "tabby"}}
--===============7330845974216740156==
Content-Type: application/http
Content-Transfer-Encoding: binary
Content-ID: <b29c5de2-0db4-490b-b421-6a51b598bd22+2>

PATCH /storage/v1/b/example-bucket/o/obj2 HTTP/1.1
Content-Type: application/json
accept: application/json
content-length: 32

{"metadata": {"type": "tuxedo"}}
--===============7330845974216740156==
Content-Type: application/http
Content-Transfer-Encoding: binary
Content-ID: <b29c5de2-0db4-490b-b421-6a51b598bd22+3>

PATCH /storage/v1/b/example-bucket/o/obj3 HTTP/1.1
Content-Type: application/json
accept: application/json
content-length: 32

{"metadata": {"type": "calico"}}
--===============7330845974216740156==--

Librerie client

C++

La libreria client C++ non supporta le richieste batch.

C#

La libreria client C# non supporta le richieste batch.

Vai

La libreria client Go non supporta le richieste batch.

Java

Per saperne di più, consulta la documentazione di riferimento dell'API Java di Cloud Storage.

import com.google.api.gax.paging.Page;
import com.google.cloud.storage.Blob;
import com.google.cloud.storage.BlobInfo;
import com.google.cloud.storage.Storage;
import com.google.cloud.storage.StorageBatch;
import com.google.cloud.storage.StorageBatchResult;
import com.google.cloud.storage.StorageException;
import com.google.cloud.storage.StorageOptions;
import java.util.HashMap;
import java.util.List;
import java.util.Map;
import java.util.Objects;
import java.util.stream.Collectors;

public class BatchSetObjectMetadata {
  public static void batchSetObjectMetadata(
      String projectId, String bucketName, String pathPrefix) {
    // The ID of your GCP project
    // String projectId = "your-project-id";

    // The ID of your GCS bucket
    // String bucketName = "your-unique-bucket-name";

    // The directory prefix. All objects in the bucket with this prefix will have their metadata
    // updated
    // String pathPrefix = "yourPath/";

    Storage storage = StorageOptions.newBuilder().setProjectId(projectId).build().getService();
    Map<String, String> newMetadata = new HashMap<>();
    newMetadata.put("keyToAddOrUpdate", "value");
    Page<Blob> blobs =
        storage.list(
            bucketName,
            Storage.BlobListOption.prefix(pathPrefix),
            Storage.BlobListOption.delimiter("/"));
    StorageBatch batchRequest = storage.batch();

    // Add all blobs with the given prefix to the batch request
    List<StorageBatchResult<Blob>> batchResults =
        blobs
            .streamAll()
            .map(blob -> batchRequest.update(blob.toBuilder().setMetadata(newMetadata).build()))
            .collect(Collectors.toList());

    // Execute the batch request
    batchRequest.submit();
    List<StorageException> failures =
        batchResults.stream()
            .map(
                r -> {
                  try {
                    BlobInfo blob = r.get();
                    return null;
                  } catch (StorageException e) {
                    return e;
                  }
                })
            .filter(Objects::nonNull)
            .collect(Collectors.toList());

    System.out.println(
        (batchResults.size() - failures.size())
            + " blobs in bucket "
            + bucketName
            + " with prefix '"
            + pathPrefix
            + "' had their metadata updated successfully.");

    if (!failures.isEmpty()) {
      System.out.println("While processing, there were " + failures.size() + " failures");

      for (StorageException failure : failures) {
        failure.printStackTrace(System.out);
      }
    }
  }
}

Node.js

La libreria client Node.js non supporta le richieste batch.

PHP

La libreria client PHP non supporta le richieste batch.

Python

Per saperne di più, consulta la documentazione di riferimento dell'API Python di Cloud Storage.

from google.cloud import storage


def batch_request(bucket_name, prefix=None):
    """
    Use a batch request to patch a list of objects with the given prefix in a bucket.

    Note that Cloud Storage does not support batch operations for uploading or downloading.
    Additionally, the current batch design does not support library methods whose return values
    depend on the response payload.
    See https://cloud.google.com/python/docs/reference/storage/latest/google.cloud.storage.batch
    """
    # The ID of your GCS bucket
    # bucket_name = "my-bucket"
    # The prefix of the object paths
    # prefix = "directory-prefix/"

    client = storage.Client()
    bucket = client.bucket(bucket_name)

    # Accumulate in a list the objects with a given prefix.
    blobs_to_patch = [blob for blob in bucket.list_blobs(prefix=prefix)]

    # Use a batch context manager to edit metadata in the list of blobs.
    # The batch request is sent out when the context manager closes.
    # No more than 100 calls should be included in a single batch request.
    with client.batch():
        for blob in blobs_to_patch:
            metadata = {"your-metadata-key": "your-metadata-value"}
            blob.metadata = metadata
            blob.patch()

    print(
        f"Batch request edited metadata for all objects with the given prefix in {bucket.name}."
    )

Ruby

Per scoprire come effettuare una richiesta batch utilizzando Ruby, consulta la documentazione di riferimento dell'API Ruby di Cloud Storage.

Esempio di risposta HTTP batch

Questa è la risposta alla richiesta di esempio HTTP nella sezione precedente.

HTTP/1.1 200 OK
Content-Type: multipart/mixed; boundary=batch_pK7JBAk73-E=_AA5eFwv4m2Q=
Date: Mon, 22 Jan 2018 18:56:00 GMT
Expires: Mon, 22 Jan 2018 18:56:00 GMT
Cache-Control: private, max-age=0
Content-Length: 3767

--batch_pK7JBAk73-E=_AA5eFwv4m2Q=
Content-Type: application/http
Content-ID: <response-b29c5de2-0db4-490b-b421-6a51b598bd22+1>

HTTP/1.1 200 OK
ETag: "lGaP-E0memYDumK16YuUDM_6Gf0/V43j6azD55CPRGb9b6uytDYl61Y"
Content-Type: application/json; charset=UTF-8
Date: Mon, 22 Jan 2018 18:56:00 GMT
Expires: Mon, 22 Jan 2018 18:56:00 GMT
Cache-Control: private, max-age=0
Content-Length: 846

{
 "kind": "storage#object",
 "id": "example-bucket/obj1/1495822576643790",
 .
 .
 .
 "metadata": {
  "type": "tabby"
  },
  .
  .
  .
}

--batch_pK7JBAk73-E=_AA5eFwv4m2Q=
Content-Type: application/http
Content-ID: <response-b29c5de2-0db4-490b-b421-6a51b598bd22+2>

HTTP/1.1 200 OK
ETag: "lGaP-E0memYDumK16YuUDM_6Gf0/91POdd-sxSAkJnS8Dm7wMxBSDKk"
Content-Type: application/json; charset=UTF-8
Date: Mon, 22 Jan 2018 18:56:00 GMT
Expires: Mon, 22 Jan 2018 18:56:00 GMT
Cache-Control: private, max-age=0
Content-Length: 846

{
 "kind": "storage#object",
 "id": "example-bucket/obj2/1495822576643790",
 .
 .
 .
 "metadata": {
  "type": "tuxedo"
  },
  .
  .
  .
}

--batch_pK7JBAk73-E=_AA5eFwv4m2Q=
Content-Type: application/http
Content-ID: <response-b29c5de2-0db4-490b-b421-6a51b598bd22+3>

HTTP/1.1 200 OK
ETag: "lGaP-E0memYDumK16YuUDM_6Gf0/d2Z1F1_ZVbB1dC0YKM9rX5VAgIQ"
Content-Type: application/json; charset=UTF-8
Date: Mon, 22 Jan 2018 18:56:00 GMT
Expires: Mon, 22 Jan 2018 18:56:00 GMT
Cache-Control: private, max-age=0
Content-Length: 846

{
 "kind": "storage#object",
 "id": "example-bucket/obj3/1495822576643790",
 .
 .
 .
 "metadata": {
  "type": "calico"
  },
  .
  .
  .
}

--batch_pK7JBAk73-E=_AA5eFwv4m2Q=--

Se la richiesta complessiva non è formattata correttamente e Cloud Storage non è in grado di analizzarla in sottorichieste, riceverai un errore 400. In caso contrario, Cloud Storage restituisce un codice di stato 200, anche se alcune o tutte le sottorichieste non vanno a buon fine.

Quando la richiesta complessiva restituisce un codice di stato 200, la risposta contiene i risultati per ogni sottorichiesta, incluso un codice di stato per ciascuna, che indica se la sottorichiesta è andata a buon fine o meno. Ad esempio, quando elimini oggetti in batch, ogni sottorichiesta riuscita contiene un codice di stato 204 No Content.