Creare e gestire report sull'inventario

In questa pagina viene descritto come creare e gestire le configurazioni dei report sull'inventario e i report generati sull'inventario, 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 riepilogo dei report sull'inventario di Storage Insights.

Prima di iniziare

Ottieni 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 sul progetto o sui bucket di origine e 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 nel progetto

  • Per leggere e scaricare i report sull'inventario:

    • roles/storage.objectViewer nel bucket di destinazione

    • roles/storageinsights.viewer nel progetto

Questi ruoli predefiniti contengono le autorizzazioni necessarie per creare e gestire le configurazioni e i report di inventario. Per visualizzare con esattezza le autorizzazioni necessarie, espandi la sezione Autorizzazioni obbligatorie:

Autorizzazioni obbligatorie

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

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

Per leggere e scaricare i report sull'inventario:

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

Potresti anche riuscire a ottenere queste autorizzazioni con altri ruoli predefiniti. Per sapere quali ruoli sono associati a quali autorizzazioni, vedi 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 in Attivazione dei servizi.

Riga di comando

Per abilitare l'API Storage Insights nel progetto attuale, esegui questo comando:

gcloud services enable storageinsights.googleapis.com

Per maggiori dettagli su come abilitare i servizi per un progetto Google Cloud, consulta Attivazione e disattivazione dei servizi.

API REST

API JSON

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

Creare una configurazione di report sull'inventario

Console

Per creare una configurazione di report sull'inventario, completa i seguenti passaggi:

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

    Vai a Bucket

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

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

  4. Fai clic su Crea configurazione report.

  5. Nella sezione Identifica la configurazione del 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 che vuoi includere nei report sull'inventario.

  7. Fai clic su Continua.

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

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

    Nella sezione Inserisci percorso di destinazione (facoltativo), puoi specificare facoltativamente 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. I metadati dei report sull'inventario generati verranno visualizzati nella pagina.

Riga di comando

  1. Per creare una configurazione del report sull'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 usato il flag --csv-separator, non è possibile usare --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 usato --csv-delimiter, non è possibile usare --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 si utilizza uno dei due flag, non è possibile usare --parquet.

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

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

    • 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 le parole chiave nel percorso, che vengono sostituite con i rispettivi valori quando viene generato il report. Ciò consente di generare report in un formato partizionato per Hive, in modo da poter caricare o eseguire query sui dati in BigQuery senza ulteriori elaborazioni.

    • METADATA_FIELD con un elenco separato da virgole di campi di 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 non vuoi più generare report sull'inventario. Deve essere un valore dopo START_DATE. Ad esempio, se specifichi 2022-02-15, i report sull'inventario non verranno più generati a partire dal 16 febbraio 2022.

Librerie client

Java

Per ulteriori informazioni, consulta la documentazione di riferimento dell'API Java di Cloud Storage.

Per eseguire l'autenticazione su Cloud Storage, configura Credenziali predefinite dell'applicazione. Per maggiori informazioni, consulta Configurare l'autenticazione per un ambiente di sviluppo locale. 


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 di report sull'inventario, completa i seguenti passaggi:

  1. Installa e inizializzatogcloud CLI per generare un token di accesso per l'intestazione Authorization.

    In alternativa, puoi creare un token di accesso utilizzando OAuth 2.0 Playground e includerlo nell'intestazione Authorization.

  2. Crea un file JSON contenente le seguenti informazioni e 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:

    • DISPLAY_NAME con il nome visualizzato modificabile della configurazione del report sull'inventario. Può contenere fino a 256 caratteri.

    • FREQUENCY con la frequenza con cui generi report sull'inventario. I valori sono DAILY o WEEKLY.

    • START_DATE con la data UTC in cui vuoi iniziare a generare report sull'inventario. Non può essere la data corrente o una data nel passato. Il valore deve essere un oggetto contenente le chiavi day, month e year. Ad esempio: {"day": 15, "month": 8, "year": 2022}.

    • END_DATE con la data UTC dopo la quale non vuoi più generare report sull'inventario. Il valore deve essere un oggetto contenente le chiavi day, month e year. Ad esempio, se specifichi {"day": 15, "month": 9, "year": 2022}, i report sull'inventario non vengono più generati a partire dal 16 settembre 2022.

    • RECORD_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. Questo campo è facoltativo.

    • 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 RECORD_SEPARATOR. Il valore predefinito è ,. Questo campo è facoltativo.

    • HEADER_REQUIRED con il valore booleano che indica se le intestazioni sono incluse o meno nel file CSV. Questo campo è facoltativo.

    • SOURCE_BUCKET_NAME con il nome del bucket di origine che contiene gli oggetti per i quali generare i report dell'inventario. Ad esempio: my_example_bucket.

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

    • DESTINATION_BUCKET_NAME con il nome del bucket di destinazione in cui vengono generati e archiviati i report sull'inventario generati. Ad esempio: my_example_destination_bucket.

    • DESTINATION_PATH con il percorso nel bucket di destinazione in cui vengono generati i report sull'inventario. Questo campo è facoltativo.

      Quando specifichi il percorso di una cartella all'interno di un bucket, puoi utilizzare le parole chiave nel percorso, che vengono sostituite con i rispettivi valori quando viene generato il report. Ciò consente di generare report in un formato partizionato per Hive, in modo da poter caricare o eseguire query sui dati in BigQuery senza ulteriori elaborazioni.

    Il seguente esempio di codice crea una configurazione del report sull'inventario denominata "Configurazione del report sull'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 richiesta Insert ReportConfig:

    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 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 località 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 dei report sull'inventario. L'agente di servizio segue il formato di denominazione service-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 dei 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 sul bucket di origine, che include le autorizzazioni storage.buckets.getObjectInsights e storage.buckets.get
  • roles/storage.objectCreator sul 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 all'agente di servizio le autorizzazioni richieste, sono necessarie fino a 24 ore per scrivere il primo report sull'inventario nel bucket di destinazione.

Modificare la configurazione di un report sull'inventario

Dopo aver creato una configurazione del report sull'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 di 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 di configurazione dei report visualizzata, modifica le proprietà che preferisci utilizzando il pulsante Modifica di .

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 contenente la configurazione del report sull'inventario.

    • EXPRESSION con un filtro booleano da applicare a ogni elemento risorsa da elencare. Se l'espressione restituisce True, l'elemento viene elencato. Per altri 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 delle chiavi dei campi delle risorse in base ai quali ordinare. L'ordine predefinito è crescente. Aggiungi il prefisso ~ a un campo per definirne l'ordine decrescente.

    1. Modifica i campi di configurazione dei report sull'inventario da aggiornare utilizzando il comando gcloud storage insights inventory-reports update. L'esempio seguente aggiorna la configurazione dei report sull'inventario per generare report giornalieri sull'inventario in formato Apache Parquet:

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

Librerie client

Java

Per ulteriori informazioni, consulta la documentazione di riferimento dell'API Java di Cloud Storage.

Per eseguire l'autenticazione su Cloud Storage, configura Credenziali predefinite dell'applicazione. Per maggiori informazioni, consulta Configurare l'autenticazione per un ambiente di sviluppo locale. 


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. Installa e inizializzatogcloud CLI per generare un token di accesso per l'intestazione Authorization.

    In alternativa, puoi creare un token di accesso utilizzando OAuth 2.0 Playground e includerlo nell'intestazione Authorization.

  2. Ottieni il nome della configurazione del report sull'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 località 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 località 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. L'esempio seguente aggiorna la configurazione dei report sull'inventario per generare report giornalieri sull'inventario in 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 richiesta Patch ReportConfig:

    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 località 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, completa i seguenti passaggi:

  1. Nella console Google Cloud, vai alla pagina Bucket di 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 contenente la configurazione del report sull'inventario.

  • EXPRESSION con un filtro booleano da applicare a ogni elemento risorsa da elencare. Se l'espressione restituisce True, l'elemento viene elencato. Per altri 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 delle chiavi dei campi delle risorse in base ai quali ordinare. L'ordine predefinito è crescente. Aggiungi il prefisso ~ a un campo per definirne l'ordine decrescente.

Librerie client

Java

Per ulteriori informazioni, consulta la documentazione di riferimento dell'API Java di Cloud Storage.

Per eseguire l'autenticazione su Cloud Storage, configura Credenziali predefinite dell'applicazione. Per maggiori informazioni, consulta Configurare l'autenticazione per un ambiente di sviluppo locale. 


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. Installa e inizializzatogcloud CLI per generare un token di accesso per l'intestazione Authorization.

    In alternativa, puoi creare un token di accesso utilizzando OAuth 2.0 Playground e includerlo nell'intestazione Authorization.

  2. Puoi elencare tutte le configurazioni dei report sull'inventario in un progetto per una determinata località utilizzando una richiesta di elenco delle configurazioni dei report sull'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 località 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 località dei bucket di origine e di destinazione. Ad esempio: us-west1.

    • BUCKET_NAME con il nome del bucket di origine contenente le configurazioni del 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, procedi nel seguente modo:

  1. Nella console Google Cloud, vai alla pagina Bucket di 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 sia selezionata la scheda Oggetti.

  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 relativa configurazione da cui è stato generato:

  1. Nella console Google Cloud, vai alla pagina Bucket di 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 di configurazione del report visualizzata, vai alla sezione Cronologia report sull'inventario, poi 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 gli shard del report

Per scaricare un report sull'inventario suddiviso in uno o più sezioni, completa i seguenti passaggi:

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

    Vai a Bucket

  2. Nell'elenco dei bucket, fai clic sul nome del bucket di destinazione specificato al momento della configurazione del report sull'inventario.

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

    Un nome di file manifest di esempio è 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 shard che vuoi scaricare dal campo report_shards_file_names.

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

Riga di comando

Scaricare singoli report

Per scaricare un report sull'inventario, procedi nel seguente modo:

  1. Per elencare tutti i report sull'inventario generati da una configurazione di report sull'inventario e recuperare 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 sull'inventario, nel formato projects/PROJECT/locations/LOCATION/reportConfigs/REPORT_CONFIG_UUID.

    • EXPRESSION con un filtro booleano da applicare a ciascun elemento risorsa da elencare. Se l'espressione restituisce True, l'elemento viene elencato. Per ulteriori 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 delle chiavi dei campi delle risorse in base ai quali ordinare. L'ordine predefinito è crescente. Aggiungi il prefisso ~ a un campo per definirne l'ordine decrescente.

    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 ReportDettagli. Per ottenere l'reportPathPrefix di un report, utilizza il comando gcloud storage insights inventory-reports details describe:

    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 gli shard del report

Per scaricare un report sull'inventario suddiviso in uno o più sezioni, completa i seguenti passaggi:

  1. Scarica il file manifest del report sull'inventario utilizzando il comando gcloud 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, nella seguente convenzione di denominazione:

      REPORT_CONFIG_UUID_TARGET_DATETIME_manifest.json

      Dove:

      • REPORT_CONFIG_UUID è l'UUID generato automaticamente della configurazione del report sull'inventario che ha generato gli shard del report da 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 file system in cui vuoi salvare il report sull'inventario. Ad esempio, ./example_report.csv.

  2. Per scaricare un file shard, 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 con codifica URL del file shard che vuoi scaricare. Ad esempio, fc95c52f-157a-494f-af4a-d4a53a69ba66_2022-11-30T00:54_0.csv.

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

Librerie client

Java

Per ulteriori informazioni, consulta la documentazione di riferimento dell'API Java di Cloud Storage.

Per eseguire l'autenticazione su Cloud Storage, configura Credenziali predefinite dell'applicazione. Per maggiori informazioni, consulta Configurare l'autenticazione per un ambiente di sviluppo locale. 


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, procedi nel seguente modo:

  1. Installa e inizializzatogcloud CLI per generare un token di accesso per l'intestazione Authorization.

    In alternativa, puoi creare un token di accesso utilizzando OAuth 2.0 Playground e includerlo nell'intestazione Authorization.

  2. Elenca tutti i report sull'inventario generati da una configurazione di report sull'inventario utilizzando cURL per chiamare l'API JSON con una richiesta di elencare i dettagli del report sull'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 località 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 che ha generato il report da 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 località 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 che ha generato il report da scaricare.

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

Scaricare gli shard del report

Per scaricare un report sull'inventario suddiviso in uno o più sezioni, completa i seguenti passaggi:

  1. Installa e inizializzatogcloud CLI per generare un token di accesso per l'intestazione Authorization.

    In alternativa, puoi creare un token di accesso utilizzando OAuth 2.0 Playground e includerlo nell'intestazione Authorization.

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

    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, nella seguente convenzione di denominazione:

      REPORT_CONFIG_UUID_TARGET_DATETIME_manifest.json

      Dove:

      • REPORT_CONFIG_UUID è l'UUID generato automaticamente della configurazione del report sull'inventario che ha generato gli shard del report da 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 del report sull'inventario che puoi scaricare.

  3. Per scaricare i file di shard del report sull'inventario, utilizza curl per chiamare l'API JSON di Cloud Storage con una richiesta 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 nell'URL del file shard che vuoi scaricare. Ad esempio, fc95c52f-157a-494f-af4a-d4a53a69ba66_2022-11-30T00:54_0.csv.

Eliminare una configurazione del report sull'inventario

Console

Per eliminare la configurazione di un report sull'inventario:

  1. Nella console Google Cloud, vai alla pagina Bucket di 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 da eliminare.

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

Riga di comando

Per eliminare la configurazione di un 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 sull'inventario, nel formato projects/PROJECT/locations/LOCATION/reportConfigs/REPORT_CONFIG_UUID.

Il flag --force elimina i metadati per tutti i report sull'inventario generati dalla configurazione specifica dei report sull'inventario. Gli oggetti dei report dell'inventario non verranno eliminati.

Librerie client

Java

Per ulteriori informazioni, consulta la documentazione di riferimento dell'API Java di Cloud Storage.

Per eseguire l'autenticazione su Cloud Storage, configura Credenziali predefinite dell'applicazione. Per maggiori informazioni, consulta Configurare l'autenticazione per un ambiente di sviluppo locale. 


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 la configurazione di un report sull'inventario:

  1. Installa e inizializzatogcloud CLI per generare un token di accesso per l'intestazione Authorization.

    In alternativa, puoi creare un token di accesso utilizzando OAuth 2.0 Playground e includerlo nell'intestazione Authorization.

  2. Per eliminare la configurazione di un 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 località 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 per tutti i report sull'inventario generati dalla configurazione specifica dei report sull'inventario. Gli oggetti dei report sull'inventario stessi non verranno eliminati.

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

Quando crei una configurazione per il report sull'inventario, puoi specificare un percorso di destinazione, ovvero una posizione nel bucket di destinazione in cui verranno generati i report sull'inventario. Ciò consente di generare report sull'inventario in un formato partizionato per Hive.

Devi specificare un percorso di destinazione utilizzando le parole chiave segnaposto. Le parole chiave nel percorso di destinazione vengono sostituite con i valori corrispondenti quando viene generato il report sull'inventario. Ad esempio, il percorso di destinazione config={{report-config-id}}/date={{date}} può risolversi in config=1A34-F2E456-12B456-1C3D/date=2022-05-20.

Parole chiave 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 indica la data e l'ora in cui viene generato il report sull'inventario. Segue 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 per i report sull'inventario.

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

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

Controllo dell'accesso e sicurezza

I seguenti consigli e considerazioni si riferiscono alla sicurezza e all'utilizzo dei report e delle configurazioni dell'inventario:

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

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

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

Passaggi successivi

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