Creare e gestire i report sull'inventario

Questa pagina descrive come creare e gestire le configurazioni dei report sull'inventario e i report sull'inventario generati, in modo da ottenere un riepilogo generale di tutti i metadati degli oggetti in un determinato bucket. Per una panoramica dei report sull'inventario, consulta la documentazione di panoramica dei report sull'inventario di Storage Insights.

Prima di iniziare

Ottenere i ruoli richiesti

Per ottenere le autorizzazioni necessarie per creare e gestire i report sull'inventario, chiedi all'amministratore di concederti i seguenti ruoli IAM per i bucket del progetto o di origine e di destinazione con cui gestirai i report sull'inventario.

  • Per creare e gestire le configurazioni dei report sull'inventario:

    • roles/storage.admin sul bucket di origine e sul bucket di destinazione

    • roles/storageinsights.admin sul progetto

  • Per leggere e scaricare i report sull'inventario:

    • roles/storage.objectViewer nel bucket di destinazione

    • roles/storageinsights.viewer sul progetto

Questi ruoli predefiniti contengono le autorizzazioni necessarie per creare e gestire configurazioni e report sull'inventario. Per visualizzare le autorizzazioni esatte richieste, espandi la sezione Autorizzazioni richieste:

Autorizzazioni obbligatorie

Per creare e gestire le configurazioni dei report sull'inventario:

  • storage.buckets.get nel bucket di origine
  • storage.objects.list nel bucket di origine
  • storage.buckets.getObjectInsights nel bucket di origine
  • storage.buckets.get nel bucket di destinazione
  • storage.objects.create nel bucket di destinazione
  • storageinsights.reportConfigs.delete sul progetto
  • storageinsights.reportConfigs.get sul progetto
  • storageinsights.reportConfigs.create sul progetto
  • storageinsights.reportConfigs.list sul progetto
  • storageinsights.reportConfigs.update sul progetto

Per leggere e scaricare i report sull'inventario:

  • storage.objects.get nel bucket di destinazione
  • storageinsights.reportDetails.get sul progetto
  • storageinsights.reportDetails.list sul progetto

Potresti anche ottenere queste autorizzazioni con altri ruoli predefiniti. Per visualizzare i ruoli associati a determinate autorizzazioni, consulta Ruoli IAM per Cloud Storage.

Per istruzioni sull'utilizzo dei ruoli per controllare l'accesso ai bucket, consulta Utilizzare IAM. Per istruzioni sull'utilizzo dei ruoli per controllare l'accesso ai progetti, consulta Gestire l'accesso.

Abilita l'API Storage Insights

Console

Per abilitare l'API storageinsights.googleapis.com, segui le istruzioni riportate in Abilitazione dei servizi.

Riga di comando

Per attivare l'API Storage Insights nel tuo progetto corrente, esegui il seguente comando:

gcloud services enable storageinsights.googleapis.com

Per ulteriori dettagli su come attivare i servizi per un progetto Google Cloud, consulta Attivare e disattivare i servizi.

API REST

API JSON

Utilizza la console Google Cloud o Google Cloud CLI per attivare l'API Storage Insights.

Creare una configurazione di report sull'inventario

Console

Per creare una configurazione del report sull'inventario:

  1. Nella console Google Cloud, vai alla pagina Bucket in Cloud Storage.

    Vai a Bucket

  2. Nell'elenco dei bucket, fai clic sul nome del bucket da utilizzare come bucket di origine.

  3. Nella pagina Dettagli bucket, fai clic sulla scheda Report sull'inventario.

  4. Fai clic su Crea configurazione di report.

  5. Nella sezione Identifica la configurazione dei report, crea un nome visualizzato per la configurazione del report sull'inventario. Il nome visualizzato può contenere fino a 256 caratteri.

  6. Nella sezione Scegli i campi dei metadati, seleziona i campi dei metadati da includere nei report sull'inventario.

  7. Fai clic su Continua.

  8. Nella sezione Scegli un formato file, seleziona il formato in cui vuoi generare i report sull'inventario.

  9. Nella sezione Scegli un bucket di destinazione, seleziona il bucket che vuoi utilizzare come bucket di destinazione.

    Nella sezione (Facoltativo) Inserisci il percorso di destinazione, se vuoi puoi specificare un percorso di destinazione in cui verranno generati i report sull'inventario.

  10. Nella sezione Opzioni di pianificazione, specifica la frequenza, la data di inizio e la data di fine per la generazione dei report.

  11. Fai clic su Crea.

    Viene visualizzata la pagina Dettagli configurazione report. Nella pagina vengono visualizzati i metadati dei report sull'inventario generati.

Riga di comando

  1. Per creare una configurazione di report dell'inventario, esegui il comando gcloud storage insights inventory-reports create:

    gcloud storage insights inventory-reports create SOURCE_BUCKET_URL \
      --csv-separator=SEPARATOR \
      --csv-delimiter=DELIMITER \
      --[no]-csv-header \
      --parquet \
      --display-name=DISPLAY_NAME \
      --destination=DESTINATION_PATH \
      --metadata-fields=METADATA_FIELD \
      --schedule-starts=START_DATE \
      --schedule-repeats=FREQUENCY \
      --schedule-repeats-until=END_DATE

    Sostituisci:

    • SOURCE_BUCKET_URL con l'URL del bucket di origine. Ad esempio, gs://my_example_source_bucket.

    • SEPARATOR con il carattere utilizzato per separare i record nel file CSV del report sull'inventario. Deve essere \n o \r\n. Il valore predefinito è \n. Facoltativo. Se viene utilizzato il flag --csv-separator, non è possibile utilizzare --parquet.

    • DELIMITER con il delimitatore che separa i campi nel file CSV del report sull'inventario. Il valore può includere un carattere e non può essere uguale a SEPARATOR. Il valore predefinito è ,. Facoltativo. Se viene utilizzato --csv-delimiter, non è possibile utilizzare --parquet.

    • --[no]-csv-header con il flag che indica se le intestazioni sono incluse o meno nel file CSV del report sull'inventario. Utilizza --csv-header per includere le intestazioni e --no-csv-header per escluderle. Se viene utilizzato uno dei due flag, --parquet non può essere utilizzato.

    • DISPLAY_NAME con il nome modificabile della configurazione del report sull'inventario. Facoltativo.

    • --parquet con il flag che genera i report sull'inventario in formato Apache Parquet anziché CSV. Se utilizzati, --csv-delimiter, --csv-separator e --[no-]csv-header non possono essere utilizzati.

    • DESTINATION_PATH con il bucket o la cartella nel bucket in cui verranno generati i report sull'inventario. Ad esempio, gs://my_example_destination_bucket o gs://my_example_destination_bucket/path/to/inventory/report.

      Quando specifichi il percorso di una cartella all'interno di un bucket, puoi utilizzare parole chiave nel percorso, che vengono sostituite con i relativi valori corrispondenti al momento della generazione del report. In questo modo, puoi generare report in un formato partizionato Hive in modo da poter caricare o eseguire query sui dati in BigQuery senza ulteriore elaborazione.

    • METADATA_FIELD con un elenco separato da virgole di campi dei metadati da includere nel report sull'inventario.

    • START_DATE con la data UTC in cui vuoi iniziare a generare report sull'inventario. Ad esempio, 2022-01-15.

    • FREQUENCY con la frequenza con cui vuoi generare i report sull'inventario. I valori sono daily o weekly.

    • END_DATE con la data UTC dopo la quale vuoi interrompere la generazione dei report sull'inventario. Deve essere un valore successivo a START_DATE. Ad esempio, se specifichi 2022-02-15, i report sull'inventario non verranno più generati dal 16 febbraio 2022.

Librerie client

Java

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

Per autenticarti a Cloud Storage, configura le Credenziali predefinite dell'applicazione. Per saperne di più, consulta Configurare l'autenticazione per le librerie client.


import com.google.cloud.storageinsights.v1.CSVOptions;
import com.google.cloud.storageinsights.v1.CloudStorageDestinationOptions;
import com.google.cloud.storageinsights.v1.CloudStorageFilters;
import com.google.cloud.storageinsights.v1.CreateReportConfigRequest;
import com.google.cloud.storageinsights.v1.FrequencyOptions;
import com.google.cloud.storageinsights.v1.LocationName;
import com.google.cloud.storageinsights.v1.ObjectMetadataReportOptions;
import com.google.cloud.storageinsights.v1.ReportConfig;
import com.google.cloud.storageinsights.v1.StorageInsightsClient;
import com.google.common.collect.ImmutableList;
import com.google.type.Date;
import java.io.IOException;

public class CreateInventoryReportConfig {

  public static void createInventoryReportConfig(
      String projectId, String bucketLocation, String sourceBucket, String destinationBucket)
      throws IOException {
    try (StorageInsightsClient storageInsightsClient = StorageInsightsClient.create()) {
      ReportConfig reportConfig =
          ReportConfig.newBuilder()
              .setDisplayName("Example inventory report configuration")
              .setFrequencyOptions(
                  FrequencyOptions.newBuilder()
                      .setFrequency(FrequencyOptions.Frequency.WEEKLY)
                      .setStartDate(Date.newBuilder().setDay(15).setMonth(8).setYear(3022).build())
                      .setEndDate(Date.newBuilder().setDay(15).setMonth(9).setYear(3022).build())
                      .build())
              .setCsvOptions(
                  CSVOptions.newBuilder()
                      .setDelimiter(",")
                      .setRecordSeparator("\n")
                      .setHeaderRequired(true)
                      .build())
              .setObjectMetadataReportOptions(
                  ObjectMetadataReportOptions.newBuilder()
                      .addAllMetadataFields(ImmutableList.of("project", "name", "bucket"))
                      .setStorageFilters(
                          CloudStorageFilters.newBuilder().setBucket(sourceBucket).build())
                      .setStorageDestinationOptions(
                          CloudStorageDestinationOptions.newBuilder()
                              .setBucket(destinationBucket)
                              .build())
                      .build())
              .build();
      CreateReportConfigRequest request =
          CreateReportConfigRequest.newBuilder()
              .setParent(LocationName.of(projectId, bucketLocation).toString())
              .setReportConfig(reportConfig)
              .build();
      ReportConfig response = storageInsightsClient.createReportConfig(request);
      System.out.println("Created inventory report config with name " + response.getName());
    }
  }
}

API REST

API JSON

Per creare una configurazione del report sull'inventario:

  1. Avere installato e inizializzatogcloud CLI, che consente di generare un token di accesso per l'intestazione Authorization.

  2. Crea un file JSON contenente le seguenti informazioni, dove tutti i campi sono obbligatori, se non diversamente indicato:

    {
      "display_name": "DISPLAY_NAME",
      "frequency_options": {
        "frequency": "FREQUENCY",
        "start_date": "START_DATE",
        "end_date": "END_DATE",
      },
      "csv_options": {
        "record_separator": "RECORD_SEPARATOR",
        "delimiter": "DELIMITER",
        "header_required": HEADER_REQUIRED
      },
      "object_metadata_report_options": {
         "metadata_fields": [
          "METADATA_FIELD",
          ...
        ],
        "storage_filters": {
          "bucket": "SOURCE_BUCKET_NAME"
        },
        "storage_destination_options": {
          "bucket": "DESTINATION_BUCKET_NAME",
          "destination_path": "DESTINATION_PATH"
        }
      }
    }

    Sostituisci:

    Ad esempio, il seguente esempio di codice crea una configurazione del report di inventario denominata "Configurazione del report di inventario di esempio" che genera report con una frequenza settimanale:

    {
      "display_name": "Example inventory report configuration",
      "frequency_options": {
        "frequency": "WEEKLY",
        "start_date": {
          "day": 15,
          "month": 8,
          "year": 2022
        },
        "end_date": {
          "day": 15,
          "month": 9,
          "year": 2022
        },
      },
      "csv_options": {
        "record_separator": "\n",
        "delimiter": ",",
        "header_required": true
      },
      "object_metadata_report_options": {
         "metadata_fields": [
          "project",
          "name",
          "bucket"
        ],
        "storage_filters": {
          "bucket": "example_source_bucket"
        },
        "storage_destination_options": {
          "bucket": "example_destination_bucket"
        }
      }
    }
  3. Per applicare la configurazione del report sull'inventario, utilizza cURL per chiamare l'API JSON con una Insert ReportConfig richiesta:

    curl -X POST --data-binary @JSON_FILE_NAME \
    "https://storageinsights.googleapis.com/v1/projects/YOUR_PROJECT/locations/LOCATION/reportConfigs" \
      --header "Authorization: Bearer $(gcloud auth print-access-token)" \
      --header "Accept: application/json" \
      --header "Content-Type: application/json" \
    

    Sostituisci:

    • JSON_FILE_NAME con il percorso del file JSON che hai creato nel passaggio precedente.

    • YOUR_PROJECT con il nome del progetto in cui si trovano i bucket di origine e di destinazione.

    • LOCATION con la posizione dei bucket di origine e di destinazione. Ad esempio: us-west1.

Concedi i ruoli richiesti all'agente di servizio

Un agente di servizio a livello di progetto viene creato automaticamente la prima volta che configuri una configurazione del report di inventario. L'agente di servizio segue il formato di denominazioneservice-PROJECT_NUMBER@gcp-sa-storageinsights.iam.gserviceaccount.com e viene visualizzato nella pagina IAM della console Google Cloud quando selezioni la casella di controllo Includi concessioni di ruoli fornite da Google.

Per consentire a Storage Insights di generare e scrivere report sull'inventario, chiedi all'amministratore di concedere all'agente di servizio i seguenti ruoli IAM:

  • roles/storage.insightsCollectorService nel bucket di origine, che include le autorizzazioni storage.buckets.getObjectInsights e storage.buckets.get
  • roles/storage.objectCreator nel bucket di destinazione, che include l'autorizzazione storage.objects.create

Per istruzioni sulla concessione dei ruoli, consulta Utilizzare IAM. Puoi concedere il ruolo roles/storage.insightsCollectorService utilizzando la console Google Cloud o Google Cloud CLI. Ad esempio:

gcloud storage buckets add-iam-policy-binding SOURCE_BUCKET_URL \
    --member=serviceAccount:service-PROJECT_NUMBER@gcp-sa-storageinsights.iam.gserviceaccount.com \
    --role=roles/storage.insightsCollectorService

Una volta concesse le autorizzazioni richieste all'agente di servizio, sono necessarie fino a 24 ore per scrivere il primo report sull'inventario nel bucket di destinazione.

Modificare una configurazione di report sull'inventario

Una volta creata una configurazione del report di inventario, puoi modificare determinate proprietà della configurazione.

Console

Per modificare la configurazione di un report sull'inventario:

  1. Nella console Google Cloud, vai alla pagina Bucket in Cloud Storage.

    Vai a Bucket

  2. Nell'elenco dei bucket, fai clic sul nome del bucket di origine che contiene la configurazione del report sull'inventario da modificare.

  3. Nella pagina Dettagli bucket del bucket di origine, fai clic sulla scheda Report sull'inventario.

  4. Fai clic sul nome della configurazione del report sull'inventario da modificare.

  5. Nella pagina Dettagli sulla configurazione del report visualizzata, modifica le proprietà che ti interessano utilizzando il pulsante Modifica.

Riga di comando

Per modificare la configurazione di un report sull'inventario:

  1. Per trovare il nome della configurazione del report sull'inventario da modificare, elenca tutte le configurazioni dell'inventario nel bucket di origine utilizzando il comando gcloud storage insights inventory-reports list:

    gcloud storage insights inventory-reports list \
      --source=SOURCE_BUCKET \
      --filter=EXPRESSION \
      --page-size=SIZE \
      --sort-by=FIELD \
      --format="yaml(name)"

    Sostituisci:

    • SOURCE_BUCKET con l'URL del bucket di origine che contiene la configurazione del report sull'inventario.

    • EXPRESSION con un filtro booleano da applicare a ogni elemento della risorsa da elencare. Se l'espressione restituisce True, l'elemento è elencato. Per maggiori dettagli ed esempi di espressioni di filtro, esegui $ gcloud topic filters.

    • SIZE con il numero massimo di risorse per pagina. Il valore predefinito è 50.

    • FIELD con un elenco separato da virgole di nomi di chiavi di campi della risorsa in base ai quali ordinare. L'ordine predefinito è crescente. Prefissa un campo con ~ per l'ordinamento decrescente in quel campo.

    1. Modifica i campi di configurazione dei report sull'inventario che vuoi aggiornare utilizzando il comando gcloud storage insights inventory-reports update. Il seguente esempio aggiorna la configurazione del report dell'inventario per generare report giornalieri sull'inventario nel formato Apache Parquet:

      gcloud storage insights inventory-reports update CONFIG_NAME \
      --parquet \
      --schedule-repeats="daily"

Librerie client

Java

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

Per autenticarti a Cloud Storage, configura le Credenziali predefinite dell'applicazione. Per saperne di più, consulta Configurare l'autenticazione per le librerie client.


import com.google.cloud.storageinsights.v1.ReportConfig;
import com.google.cloud.storageinsights.v1.ReportConfigName;
import com.google.cloud.storageinsights.v1.StorageInsightsClient;
import com.google.cloud.storageinsights.v1.UpdateReportConfigRequest;
import com.google.protobuf.FieldMask;
import java.io.IOException;

public class EditInventoryReportConfig {


  public static void editInventoryReportConfig(
          String projectId, String location, String inventoryReportConfigUuid) throws IOException {
    try (StorageInsightsClient storageInsightsClient = StorageInsightsClient.create()) {
      ReportConfigName name = ReportConfigName.of(projectId, location, inventoryReportConfigUuid);
      ReportConfig reportConfig = storageInsightsClient.getReportConfig(name);

      // Set any other fields you want to update here
      ReportConfig updatedReportConfig =
              reportConfig.toBuilder().setDisplayName("Updated Display Name").build();

      storageInsightsClient.updateReportConfig(
              UpdateReportConfigRequest.newBuilder()
                      // Add any fields that you want to update to the update mask, in snake case
                      .setUpdateMask(FieldMask.newBuilder().addPaths("display_name")
                              .build())
                      .setReportConfig(updatedReportConfig).build());

      System.out.println("Edited inventory report config with name " + name);
    }
  }
}

API REST

API JSON

Per modificare la configurazione di un report sull'inventario:

  1. Avere installato e inizializzatogcloud CLI, che consente di generare un token di accesso per l'intestazione Authorization.

  2. Ottieni il nome della configurazione del report di inventario che vuoi modificare utilizzando cURL per chiamare l'API JSON con una richiesta Get ReportConfig:

    curl --request GET \
    "https://storageinsights.googleapis.com/v1/projects/YOUR_PROJECT/locations/LOCATION/reportConfigs?" \
      --header "Authorization: Bearer $(gcloud auth print-access-token)" \
      --header "Accept: application/json" \
      --header "Content-Type: application/json" \
    

    Sostituisci:

    • YOUR_PROJECT con il nome del progetto in cui si trovano i bucket di origine e di destinazione.

    • LOCATION con la posizione dei bucket di origine e di destinazione. Ad esempio: us-west1.

    Se vuoi recuperare tutte le configurazioni dei report sull'inventario in un bucket di origine specifico, aggiungi il parametro di query filter alla richiesta:

    curl --request GET \
    "https://storageinsights.googleapis.com/v1/projects/YOUR_PROJECT/locations/LOCATION/reportConfigs?filter=objectMetadataReportOptions.storageFilters.bucket=BUCKET_NAME" \
      --header "Authorization: Bearer $(gcloud auth print-access-token)" \
      --header "Accept: application/json" \
      --header "Content-Type: application/json" \
    

    Sostituisci:

    • YOUR_PROJECT con il nome del progetto in cui si trovano i bucket di origine e di destinazione.
    • LOCATION con la posizione dei bucket di origine e di destinazione. Ad esempio: us-west1.
    • BUCKET_NAME con il nome del bucket di origine contenente le configurazioni dei report sull'inventario da modificare.
  3. Crea un file JSON che includa le modifiche alle proprietà che vuoi modificare. Il seguente esempio aggiorna la configurazione del report dell'inventario per generare report giornalieri sull'inventario nel formato Apache Parquet:

    {
      "ReportConfig": {
        "frequency_options": {
          "frequency": "DAILY"
        },
        "parquet_options": {
        }
      }
  4. Per applicare la configurazione del report sull'inventario, utilizza cURL per chiamare l'API JSON con una Patch ReportConfig richiesta:

    curl --request PATCH \
    "https://storageinsights.googleapis.com/v1/projects/YOUR_PROJECT/locations/LOCATION/reportConfigs/REPORT_CONFIG_UUID" \
      --header "Authorization: Bearer $(gcloud auth print-access-token)" \
      --header "Accept: application/json" \
      --header "Content-Type: application/json" \
      --data-binary "@JSON_FILE_NAME.json" \
    

    Sostituisci:

    • YOUR_PROJECT con il nome del progetto in cui si trovano i bucket di origine e di destinazione.

    • LOCATION con la posizione dei bucket di origine e di destinazione. Ad esempio: us-west1.

    • REPORT_CONFIG_UUID con l'UUID generato automaticamente della configurazione del report sull'inventario.

Elencare le configurazioni dei report sull'inventario

Console

Per elencare le configurazioni dei report sull'inventario in un bucket di origine:

  1. Nella console Google Cloud, vai alla pagina Bucket in Cloud Storage.

    Vai a Bucket

  2. Nell'elenco dei bucket, fai clic sul nome del bucket di origine che contiene le configurazioni dei report sull'inventario da visualizzare.

  3. Nella pagina Dettagli bucket, fai clic sulla scheda Report sull'inventario.

    Vengono visualizzate le configurazioni dei report sull'inventario nel bucket di origine.

Riga di comando

Puoi elencare tutte le configurazioni dell'inventario in un bucket di origine utilizzando il comando gcloud storage insights inventory-reports list:

gcloud storage insights inventory-reports list \
  --source=SOURCE_BUCKET \
  --filter=EXPRESSION \
  --page-size=SIZE \
  --sort-by=FIELD \
  --format="yaml(name)"
  

Sostituisci:

  • SOURCE_BUCKET con l'URL del bucket di origine che contiene la configurazione del report sull'inventario.

  • EXPRESSION con un filtro booleano da applicare a ogni elemento della risorsa da elencare. Se l'espressione restituisce True, l'elemento è elencato. Per maggiori dettagli ed esempi di espressioni di filtro, esegui $ gcloud topic filters.

  • SIZE con il numero massimo di risorse per pagina. Il valore predefinito è 50.

  • FIELD con un elenco separato da virgole di nomi di chiavi di campi della risorsa in base ai quali ordinare. L'ordine predefinito è crescente. Prefissa un campo con ~ per l'ordinamento decrescente in quel campo.

Librerie client

Java

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

Per autenticarti a Cloud Storage, configura le Credenziali predefinite dell'applicazione. Per saperne di più, consulta Configurare l'autenticazione per le librerie client.


import com.google.cloud.storageinsights.v1.LocationName;
import com.google.cloud.storageinsights.v1.ReportConfig;
import com.google.cloud.storageinsights.v1.StorageInsightsClient;
import java.io.IOException;

public class ListInventoryReportConfigs {


  public static void listInventoryReportConfigs(String projectId, String location)
      throws IOException {
    try (StorageInsightsClient storageInsightsClient = StorageInsightsClient.create()) {
      System.out.println(
          "Printing inventory report configs in project "
              + projectId
              + " and location "
              + location);
      for (ReportConfig config :
          storageInsightsClient
              .listReportConfigs(LocationName.of(projectId, location))
              .iterateAll()) {
        System.out.println(config.getName());
      }
    }
  }
}

API REST

API JSON

  1. Avere installato e inizializzatogcloud CLI, che consente di generare un token di accesso per l'intestazione Authorization.

  2. Puoi elencare tutte le configurazioni dei report di inventario in un progetto per una determinata località utilizzando una richiesta per elencare le configurazioni dei report di inventario:

    curl --request GET \
    "https://storageinsights.googleapis.com/v1/projects/YOUR_PROJECT/locations/LOCATION/reportConfigs?" \
      --header "Authorization: Bearer $(gcloud auth print-access-token)" \
      --header "Accept: application/json" \
      --header "Content-Type: application/json" \
    

    Sostituisci:

    • YOUR_PROJECT con il nome del progetto in cui si trovano i bucket di origine e di destinazione.

    • LOCATION con la posizione dei bucket di origine e di destinazione. Ad esempio: us-west1.

    Se vuoi elencare tutte le configurazioni dei report sull'inventario in un bucket di origine specifico, aggiungi il parametro di query filter alla richiesta:

    curl --request GET \
    "https://storageinsights.googleapis.com/v1/projects/YOUR_PROJECT/locations/LOCATION/reportConfigs?filter=objectMetadataReportOptions.storageFilters.bucket=BUCKET_NAME" \
      --header "Authorization: Bearer $(gcloud auth print-access-token)" \
      --header "Accept: application/json" \
      --header "Content-Type: application/json" \
    

    Sostituisci:

    • YOUR_PROJECT con il nome del progetto in cui si trovano i bucket di origine e di destinazione.

    • LOCATION con la posizione dei bucket di origine e di destinazione. Ad esempio: us-west1.

    • BUCKET_NAME con il nome del bucket di origine contenente le configurazioni dei report sull'inventario da elencare.

Scaricare un report sull'inventario

Console

Scaricare singoli report

I report sull'inventario vengono generati e archiviati come oggetti nel bucket di destinazione, quindi puoi scaricarli come faresti con un normale oggetto.

Per scaricare un report sull'inventario:

  1. Nella console Google Cloud, vai alla pagina Bucket in Cloud Storage.

    Vai a Bucket

  2. Nell'elenco dei bucket, fai clic sul nome del bucket di destinazione che contiene il report sull'inventario da scaricare.

  3. Nella pagina Dettagli bucket, assicurati che la scheda Oggetti sia selezionata.

  4. Fai clic su Scarica associato al report sull'inventario che vuoi scaricare.

Se non conosci il bucket di destinazione, puoi anche scaricare un report sull'inventario tramite la configurazione del report sull'inventario da cui è stato generato:

  1. Nella console Google Cloud, vai alla pagina Bucket in Cloud Storage.

    Vai a Bucket

  2. Nell'elenco dei bucket, fai clic sul nome del bucket di origine contenente la configurazione del report sull'inventario che ha generato il report da scaricare.

  3. Nella pagina Dettagli bucket, fai clic sul nome della configurazione del report sull'inventario.

  4. Nella pagina Dettagli sulla configurazione del report visualizzata, vai alla sezione Cronologia report sull'inventario e fai clic sul percorso dell'oggetto di destinazione del report sull'inventario che vuoi scaricare.

    Viene visualizzata la pagina Dettagli bucket per il bucket di destinazione che contiene il report sull'inventario.

  5. Fai clic su Scarica associato al report sull'inventario che vuoi scaricare.

Scaricare i frammenti di report

Per scaricare un report sull'inventario suddiviso in uno o più segmenti:

  1. Nella console Google Cloud, vai alla pagina Bucket in Cloud Storage.

    Vai a Bucket

  2. Nell'elenco dei bucket, fai clic sul nome del bucket di destinazione specificato quando hai creato la configurazione del report sull'inventario.

  3. Nella pagina Dettagli bucket, controlla la presenza di un file manifest. La presenza di un file manifest indica che tutti gli shard di un report sull'inventario sono stati generati.

    Un esempio di nome file manifest è fc95c52f-157a-494f-af4a-d4a53a69ba66_2022-11-30T00:00_manifest.json.

  4. Nel bucket di destinazione, fai clic su Scarica associato al file manifest. Prendi nota dei nomi dei file dei frammenti che vuoi scaricare dal campo report_shards_file_names.

  5. Nel bucket di destinazione, fai clic su Scarica associato ai file del frammento che vuoi scaricare.

Riga di comando

Scaricare singoli report

Per scaricare un report sull'inventario:

  1. Per elencare tutti i report di inventario generati da una configurazione dei report di inventario e recuperarne i relativi REPORT_DETAIL_ID, utilizza il comando gcloud storage insights inventory-reports details list:

    gcloud storage insights inventory-reports details list CONFIG_NAME \
      --filter=EXPRESSION \
      --page-size=SIZE \
      --sort-by=FIELD

    Sostituisci:

    • CONFIG_NAME con il nome univoco della configurazione del report dell'inventario, nel formato projects/PROJECT/locations/LOCATION/reportConfigs/REPORT_CONFIG_UUID.

    • EXPRESSION con un filtro booleano da applicare a ogni elemento della risorsa da elencare. Se l'espressione restituisce True, l'elemento viene elencato. Per maggiori dettagli ed esempi di espressioni di filtro, esegui $ gcloud topic filters.

    • SIZE con il numero massimo di risorse per pagina. Il valore predefinito è 50.

    • FIELD con un elenco separato da virgole di nomi di chiavi di campi della risorsa in base ai quali ordinare. L'ordine predefinito è crescente. Prefissa un campo con ~ per l'ordinamento decrescente in quel campo.

    In caso di esito positivo, il comando restituisce un output simile al seguente:

    REPORT_DETAIL_ID            SNAPSHOT_TIME
    Report_2023-04-10T00-00     2023-04-10T00:53:03Z
    Report_2023-04-12T00-00     2023-04-12T00:52:54Z
    Report_2023-04-05T00-00     2023-04-05T00:53:01Z
  2. Per scaricare un report sull'inventario, devi prima recuperare la proprietà reportPathPrefix dell'oggetto ReportDetail. Per ottenere il reportPathPrefix di un report, utilizza il gcloud storage insights inventory-reports details describe comando:

    gcloud storage insights inventory-reports details describe REPORT_DETAIL_NAME

    Sostituisci REPORT_DETAIL_NAME con il nome del report sull'inventario nel formato projects/PROJECT/locations/LOCATION/reportConfigs/REPORT_CONFIG_UUID/reportDetails/REPORT_DETAIL_ID.

Scaricare i frammenti di report

Per scaricare un report sull'inventario suddiviso in uno o più segmenti:

  1. Scarica il file manifest del report sull'inventario utilizzando il comandogcloud storage cp:

    gcloud storage cp gs://BUCKET_NAME/MANIFEST_FILE_NAME DOWNLOAD_PATH

    Sostituisci:

    • BUCKET_NAME con il nome del bucket di destinazione.

    • MANIFEST_FILE_NAME con il nome del file manifest nel bucket di destinazione, secondo la seguente convenzione di nomenclatura:

      REPORT_CONFIG_UUID_TARGET_DATETIME_manifest.json

      Dove:

      • REPORT_CONFIG_UUID è l'UUID generato automaticamente della configurazione del report di inventario che ha generato i frammenti di report che vuoi scaricare.

      • TARGET_DATETIME è la data e l'ora in cui è stato generato il report sull'inventario.

      Ad esempio, fc95c52f-157a-494f-af4a-d4a53a69ba66_2022-11-30T00:00_manifest.json.

    • DOWNLOAD_PATH con il percorso del sistema di file in cui vuoi salvare il report sull'inventario. Ad esempio, ./example_report.csv.

  2. Per scaricare un file del frammento, utilizza il comando gcloud storage cp:

    gcloud storage cp gs://BUCKET_NAME/SHARD_FILE_NAME DOWNLOAD_PATH

    Sostituisci:

    • BUCKET_NAME con il nome del bucket di destinazione.

    • SHARD_FILE_NAME con il nome codificato dell'URL del file del frammento che vuoi scaricare. Ad esempio, fc95c52f-157a-494f-af4a-d4a53a69ba66_2022-11-30T00:54_0.csv.

    • DOWNLOAD_PATH con il percorso del sistema di file in cui vuoi salvare il report sull'inventario. Ad esempio, ./example_report.csv.

Librerie client

Java

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

Per autenticarti a Cloud Storage, configura le Credenziali predefinite dell'applicazione. Per saperne di più, consulta Configurare l'autenticazione per le librerie client.


import com.google.cloud.storageinsights.v1.ReportConfig;
import com.google.cloud.storageinsights.v1.ReportConfigName;
import com.google.cloud.storageinsights.v1.ReportDetail;
import com.google.cloud.storageinsights.v1.StorageInsightsClient;
import java.io.IOException;

public class GetInventoryReportNames {


  public static void getInventoryReportNames(
      String projectId, String location, String reportConfigUuid) throws IOException {
    try (StorageInsightsClient storageInsightsClient = StorageInsightsClient.create()) {
      ReportConfig config =
          storageInsightsClient.getReportConfig(
              ReportConfigName.of(projectId, location, reportConfigUuid));
      String extension = config.hasCsvOptions() ? "csv" : "parquet";
      System.out.println(
          "You can use the Google Cloud Storage Client "
              + "to download the following objects from Google Cloud Storage:");
      for (ReportDetail reportDetail :
          storageInsightsClient.listReportDetails(config.getName()).iterateAll()) {
        for (long index = reportDetail.getShardsCount() - 1; index >= 0; index--) {
          System.out.println(reportDetail.getReportPathPrefix() + index + "." + extension);
        }
      }
    }
  }
}

API REST

API JSON

Scaricare singoli report

Per scaricare un report sull'inventario:

  1. Avere installato e inizializzatogcloud CLI, che consente di generare un token di accesso per l'intestazione Authorization.

  2. Elenca tutti i report di inventario generati da una configurazione dei report di inventario utilizzando cURL per chiamare l'API JSON con una richiesta per elencare i dettagli dei report di inventario:

    curl --request GET \
    "https://storageinsights.googleapis.com/v1/projects/YOUR_PROJECT/locations/LOCATION/reportConfigs/REPORT_CONFIG_UUID/reportDetails/" \
      --header "Authorization: Bearer $(gcloud auth print-access-token)" \
      --header "Accept: application/json" \
      --header "Content-Type: application/json" \
    

    Sostituisci:

    • YOUR_PROJECT con il nome del progetto in cui si trovano i bucket di origine e di destinazione.

    • LOCATION con la posizione dei bucket di origine e di destinazione. Ad esempio: us-west1.

    • REPORT_CONFIG_UUID con l'UUID generato automaticamente della configurazione del report di inventario che ha generato il report che vuoi scaricare.

  3. Per ottenere i dettagli di un singolo report, utilizza cURL per chiamare l'API JSON con una richiesta Get ReportDetails:

    curl --request GET \
    "https://storageinsights.googleapis.com/v1/projects/YOUR_PROJECT/locations/LOCATION/reportConfigs/REPORT_CONFIG_UUID/reportDetails/REPORT_DETAIL_ID" \
      --header "Authorization: Bearer $(gcloud auth print-access-token)" \
      --header "Accept: application/json" \
      --header "Content-Type: application/json" \
    

    Sostituisci:

    • YOUR_PROJECT con il nome del progetto in cui si trovano i bucket di origine e di destinazione.

    • LOCATION con la posizione dei bucket di origine e di destinazione. Ad esempio: us-west1.

    • REPORT_CONFIG_UUID con l'UUID generato automaticamente della configurazione del report di inventario che ha generato il report che vuoi scaricare.

    • REPORT_DETAIL_ID con il nome del report sull'inventario da scaricare.

Scaricare i frammenti di report

Per scaricare un report sull'inventario suddiviso in uno o più segmenti:

  1. Avere installato e inizializzatogcloud CLI, che consente di generare un token di accesso per l'intestazione Authorization.

  2. Per scaricare il file manifest del report sull'inventario, utilizza cURL per chiamare l'API JSON con una richiesta di GET Object:

    curl -X GET \
      --header "Authorization: Bearer $(gcloud auth print-access-token)" \
      --header "Accept: application/json" \
      --header "Content-Type: application/json" \
      "https://storage.googleapis.com/storage/v1/b/BUCKET_NAME/o/MANIFEST_FILE_NAME?alt=media" \

    Sostituisci:

    • BUCKET_NAME con il nome del bucket di destinazione.

    • MANIFEST_FILE_NAME con il nome del file manifest nel bucket di destinazione, secondo la seguente convenzione di nomenclatura:

      REPORT_CONFIG_UUID_TARGET_DATETIME_manifest.json

      Dove:

      • REPORT_CONFIG_UUID è l'UUID generato automaticamente della configurazione del report di inventario che ha generato i frammenti di report che vuoi scaricare.

      • TARGET_DATETIME è la data in cui è stato generato il report sull'inventario.

    Ad esempio, fc95c52f-157a-494f-af4a-d4a53a69ba66_2022-11-30T00:00_manifest.json.

    Il campo report_shards_file_names del file manifest contiene i nomi degli shard dei report sull'inventario che puoi scaricare.

  3. Per scaricare i file dei frammenti del report di inventario, utilizza curl per chiamare l'API JSON di Cloud Storage con una richiesta di oggetto Get:

    curl -X GET \
      --header "Authorization: Bearer $(gcloud auth print-access-token)" \
      -o "DOWNLOAD_PATH" \
      "https://storage.googleapis.com/storage/v1/b/BUCKET_NAME/o/SHARD_FILE_NAME?alt=media"

    Sostituisci:

    • DOWNLOAD_PATH con il percorso del file system locale in cui vuoi salvare l'oggetto. Ad esempio, Desktop/dog.png.

    • BUCKET_NAME con il nome del bucket di destinazione contenente il report sull'inventario. Ad esempio, my-bucket.

    • SHARD_FILE_NAME con il nome codificato dell'URL del file del frammento che vuoi scaricare. Ad esempio, fc95c52f-157a-494f-af4a-d4a53a69ba66_2022-11-30T00:54_0.csv.

Eliminare una configurazione dei report sull'inventario

Console

Per eliminare una configurazione del report sull'inventario:

  1. Nella console Google Cloud, vai alla pagina Bucket in Cloud Storage.

    Vai a Bucket

  2. Nell'elenco dei bucket, fai clic sul nome del bucket di origine che contiene la configurazione del report sull'inventario da eliminare.

  3. Nella pagina Dettagli bucket del bucket di origine, fai clic sulla scheda Report sull'inventario.

  4. Fai clic sul nome della configurazione del report sull'inventario che vuoi eliminare.

  5. Nella pagina Dettagli configurazione report visualizzata, fai clic su Elimina.

Riga di comando

Per eliminare una configurazione dei report sull'inventario, utilizza il comando gcloud storage insights inventory-reports delete:

gcloud storage insights inventory-reports delete CONFIG_NAME
  --force

Sostituisci CONFIG_NAME con il nome univoco della configurazione del report dell'inventario, nel formato projects/PROJECT/locations/LOCATION/reportConfigs/REPORT_CONFIG_UUID.

Il flag --force elimina i metadati di tutti i report sull'inventario generati dalla configurazione del report sull'inventario specificata. Gli oggetti dei report sull'inventario stessi non verranno eliminati.

Librerie client

Java

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

Per autenticarti a Cloud Storage, configura le Credenziali predefinite dell'applicazione. Per saperne di più, consulta Configurare l'autenticazione per le librerie client.


import com.google.cloud.storageinsights.v1.ReportConfigName;
import com.google.cloud.storageinsights.v1.StorageInsightsClient;
import java.io.IOException;

public class DeleteInventoryReportConfig {


  public static void deleteInventoryReportConfig(
      String projectId, String location, String inventoryReportConfigUuid) throws IOException {
    try (StorageInsightsClient storageInsightsClient = StorageInsightsClient.create()) {
      ReportConfigName name = ReportConfigName.of(projectId, location, inventoryReportConfigUuid);
      storageInsightsClient.deleteReportConfig(name);

      System.out.println("Deleted inventory report config with name " + name);
    }
  }
}

API REST

API JSON

Per eliminare una configurazione del report sull'inventario:

  1. Avere installato e inizializzatogcloud CLI, che consente di generare un token di accesso per l'intestazione Authorization.

  2. Per eliminare una configurazione dei report sull'inventario, utilizza cURL per chiamare l'API JSON con una richiesta Delete ReportConfig:

    curl --request DELETE \
    'https://storageinsights.googleapis.com/v1/projects/YOUR_PROJECT/locations/LOCATION/reportConfigs/REPORT_CONFIG_UUID?force=true' \
      --header 'Authorization: Bearer $(gcloud auth print-access-token)' \
      --header 'Accept: application/json' \
      --header 'Content-Type: application/json' \
    

    Sostituisci:

    • YOUR_PROJECT con il nome del progetto in cui si trovano i bucket di origine e di destinazione.

    • LOCATION con la posizione dei bucket di origine e di destinazione. Ad esempio: us-west1.

    • REPORT_CONFIG_UUID con l'UUID generato automaticamente della configurazione del report sull'inventario da eliminare.

Il parametro di query force elimina i metadati di tutti i report sull'inventario generati dalla configurazione specificata. Gli oggetti dei report sull'inventario stessi non verranno eliminati.

Avanzato: genera report sull'inventario in un formato partizionato Hive

Quando crei una configurazione del report sull'inventario, puoi specificare un percorso di destinazione, ovvero una posizione nel bucket di destinazione in cui verranno generati i report sull'inventario. In questo modo puoi generare report sull'inventario in un formato partizionato Hive.

Specifica un percorso di destinazione utilizzando le parole chiave segnaposto. Le parole chiave nel percorso di destinazione vengono sostituite con i valori corrispondenti al momento della generazione del report sull'inventario. Ad esempio, il percorso di destinazioneconfig={{report-config-id}}/date={{date}} può risolvere in config=1A34-F2E456-12B456-1C3D/date=2022-05-20.

Parole chiave per il percorso di destinazione

Puoi specificare le parole chiave report-config-id, date o datetime, racchiuse tra {{ e }}, dove:

  • report-config-id è l'UUID della configurazione del report sull'inventario.

  • date è la data in cui viene generato il report sull'inventario. Segue il formato ISO 8601.

  • datetime è la data e l'ora in cui viene generato il report sull'inventario. Deve seguire il formato ISO 8601.

Le parole chiave possono essere specificate utilizzando uno dei seguenti strumenti:

  • Quando utilizzi la console Google Cloud, specifica le parole chiave nella sezione Inserisci il percorso di destinazione (facoltativo). Questa sezione viene visualizzata quando crei una configurazione dei report di inventario.

  • Quando utilizzi Google Cloud CLI, specifica le parole chiave segnaposto utilizzando il flag --destination.

  • Quando utilizzi l'API JSON, specifica le parole chiave segnaposto nel storage_destination_options.destination_path campo dell'oggetto ReportConfig.

Controllo dell'accesso e sicurezza

I seguenti consigli e considerazioni riguardano la sicurezza e l'utilizzo di configurazioni e report sull'inventario:

  • Consigliamo agli utenti con il ruolo roles/storage.admin di disporre anche delle autorizzazioni storageinsights.reportConfigs.* per poter mantenere il controllo sull'utilizzo di tutte le risorse nei loro bucket, ad esempio la lettura degli oggetti e dei relativi metadati.

  • Ti consigliamo di limitare l'accesso alle risorse dei report di inventario concedendo le autorizzazioni storageinsights.reportConfigs.* solo alle persone necessarie.

  • Una volta creata, la configurazione dei report di inventario continua a generare report di inventario anche se l'utente che ha creato la configurazione non dispone più delle autorizzazioni richieste. Per interrompere la generazione dei report sull'inventario, puoi modificare la data di fine nella configurazione dei report sull'inventario o eliminare completamente la configurazione.

Passaggi successivi

  • Se riscontri problemi con la generazione di report sull'inventario, consulta la sezione Risoluzione dei problemi per ricevere assistenza.