Use relatórios de inventário

Esta página descreve como criar e gerir configurações de relatórios de inventário e relatórios de inventário gerados, para que possa obter um resumo de alto nível dos metadados de todos os seus objetos num determinado contentor. Para uma vista geral dos relatórios de inventário, consulte a documentação de vista geral dos relatórios de inventário.

Antes de começar

Obtenha as funções necessárias

Para receber as autorizações necessárias para criar e gerir relatórios de inventário, peça ao seu administrador que lhe conceda as seguintes funções do IAM no projeto ou nos contentores de origem e destino com os quais vai gerir os relatórios de inventário.

  • Para criar e gerir configurações de relatórios de inventário:

    • roles/storage.admin no contentor de origem e no contentor de destino

    • roles/storageinsights.admin no projeto

  • Para ler e transferir relatórios de inventário:

    • roles/storage.objectViewer no contentor de destino

    • roles/storageinsights.viewer no projeto

Estas funções predefinidas contêm as autorizações necessárias para criar e gerir relatórios e configurações de inventário. Para ver as autorizações exatas necessárias, expanda a secção Autorizações necessárias:

Autorizações necessárias

Para criar e gerir configurações de relatórios de inventário:

  • storage.buckets.get no contentor de origem
  • storage.objects.list no contentor de origem
  • storage.buckets.getObjectInsights no contentor de origem
  • storage.buckets.get no contentor de destino
  • storage.objects.create no contentor de destino
  • storageinsights.reportConfigs.delete no projeto
  • storageinsights.reportConfigs.get no projeto
  • storageinsights.reportConfigs.create no projeto
  • storageinsights.reportConfigs.list no projeto
  • storageinsights.reportConfigs.update no projeto

Para ler e transferir relatórios de inventário:

  • storage.objects.get no contentor de destino
  • storageinsights.reportDetails.get no projeto
  • storageinsights.reportDetails.list no projeto

Também pode conseguir estas autorizações com outras funções predefinidas. Para ver que funções estão associadas a que autorizações, consulte o artigo Funções de IAM para o Cloud Storage.

Para ver instruções sobre como usar funções para controlar o acesso aos contentores, consulte o artigo Use a IAM. Para ver instruções sobre como usar funções para controlar o acesso a projetos, consulte o artigo Gerir acesso.

Ative a API Storage Insights

Consola

Para ativar a API storageinsights.googleapis.com, siga as instruções em Ativar serviços.

Linha de comandos

Para ativar a API Storage Insights no seu projeto atual, execute o seguinte comando:

gcloud services enable storageinsights.googleapis.com

Para mais detalhes sobre como ativar serviços para um Google Cloud projeto, consulte o artigo Ativar e desativar serviços.

APIs REST

API JSON

Use a Google Cloud consola ou a CLI Google Cloud para ativar a API Storage Insights.

Crie uma configuração de relatório de inventário

Consola

Para criar uma configuração de relatório de inventário, conclua os seguintes passos:

  1. Na Google Cloud consola, aceda à página Recipientes do Cloud Storage.

    Aceda a Recipientes

  2. Na lista de contentores, clique no nome do contentor que quer usar como contentor de origem.

  3. Na página Detalhes do contentor, clique no separador Relatórios de inventário.

  4. Clique em Create report configuration.

  5. Na secção Identifique a configuração do relatório, crie um nome a apresentar para a configuração do relatório de inventário. O nome a apresentar pode conter até 256 carateres.

  6. Na secção Escolher campos de metadados, selecione os campos de metadados que quer incluir nos relatórios de inventário.

  7. Clique em Continuar.

  8. Na secção Escolha um formato de ficheiro, selecione o formato de ficheiro no qual quer gerar relatórios de inventário.

  9. Na secção Escolha um contentor de destino, selecione o contentor que quer usar como contentor de destino.

    Na secção Introduza o caminho de destino (opcional), pode especificar opcionalmente um caminho de destino onde os relatórios de inventário vão ser gerados.

  10. Na secção Opções de agendamento, especifique a frequência, a data de início e a data de fim para gerar relatórios.

  11. Clique em Criar.

    É apresentada a página Detalhes da configuração do relatório. Os metadados dos relatórios de inventário gerados aparecem na página.

Linha de comandos

  1. Para criar uma configuração de relatório de inventário, execute o 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

    Substituição:

    • SOURCE_BUCKET_URL com o URL do bucket de origem. Por exemplo, gs://my_example_source_bucket.

    • SEPARATOR com o caráter usado para separar os registos no ficheiro CSV do relatório de inventário. Tem de ser \n ou \r\n. O valor predefinido é \n. Opcional. Se for usada a flag --csv-separator, não é possível usar --parquet.

    • DELIMITER com o delimitador que separa os campos no ficheiro CSV do relatório de inventário. O valor pode incluir um carácter e não pode ser o mesmo valor que SEPARATOR. O valor predefinido é ,. Opcional. Se for usado o --csv-delimiter, não é possível usar o --parquet.

    • --[no]-csv-header com a flag que indica se os cabeçalhos estão ou não incluídos no ficheiro CSV do relatório de inventário. Use --csv-header para incluir cabeçalhos e --no-csv-header para excluir cabeçalhos. Se usar qualquer uma das flags, não pode usar --parquet.

    • DISPLAY_NAME com o nome editável da configuração do relatório de inventário. Opcional.

    • --parquet com a flag que gera relatórios de inventário no formato Apache Parquet em vez de CSV. Se forem usados, não é possível usar --csv-delimiter, --csv-separator e --[no-]csv-header.

    • DESTINATION_PATH com o contentor ou a pasta no contentor onde os relatórios de inventário vão ser gerados. Por exemplo, gs://my_example_destination_bucket ou gs://my_example_destination_bucket/path/to/inventory/report.

      Quando especifica um caminho para uma pasta num contentor, pode usar palavras-chave no caminho, que são substituídas pelos respetivos valores quando o relatório é gerado. Isto permite-lhe gerar relatórios num formato particionado do Hive para que possa carregar ou consultar os dados no BigQuery sem processamento adicional.

    • METADATA_FIELD com uma lista separada por vírgulas de campos de metadados que quer incluir no relatório de inventário.

    • START_DATE com a data UTC em que quer começar a gerar relatórios de inventário. Por exemplo, 2022-01-15.

    • FREQUENCY com a frequência com que quer que os relatórios de inventário sejam gerados. Os valores são daily ou weekly.

    • END_DATE com a data UTC após a qual quer parar de gerar relatórios de inventário. Tem de ser um valor após START_DATE. Por exemplo, se especificar 2022-02-15, os relatórios de inventário vão deixar de ser gerados a partir de 16 de fevereiro de 2022.

Bibliotecas cliente

Java

Para mais informações, consulte a documentação de referência da API Java do Cloud Storage.

Para se autenticar no Cloud Storage, configure as Credenciais padrão da aplicação. Para mais informações, consulte o artigo Configure a autenticação para bibliotecas de cliente. 


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());
    }
  }
}

APIs REST

API JSON

Para criar uma configuração de relatório de inventário, conclua os seguintes passos:

  1. Ter a CLI gcloud instalada e inicializada, o que lhe permite gerar um token de acesso para o cabeçalho Authorization.

  2. Crie um ficheiro JSON que contenha as seguintes informações, em que todos os campos são obrigatórios, salvo indicação em contrário:

    {
  "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"
    }
  }
}

    Substituição:

    Por exemplo, o seguinte exemplo de código cria uma configuração de relatório de inventário denominada "Exemplo de configuração de relatório de inventário" que gera relatórios com uma frequência semanal:

    {
  "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. Para aplicar a configuração do relatório de inventário, use cURL para chamar a API JSON com um pedido Create 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" \

    Substituição:

    • JSON_FILE_NAME com o caminho para o ficheiro JSON que criou no passo anterior.

    • YOUR_PROJECT com o nome do projeto no qual residem os contentores de origem e de destino.

    • LOCATION com a localização dos contentores de origem e destino. Por exemplo, us-west1.

Conceda as funções necessárias ao agente do serviço

Um agente de serviço ao nível do projeto é criado automaticamente na primeira vez que configura uma configuração de relatório de inventário. O agente de serviço segue o formato de nomenclatura service-PROJECT_NUMBER@gcp-sa-storageinsights.iam.gserviceaccount.com e aparece na página IAM da Google Cloud consola quando seleciona a caixa de verificação Incluir concessões de funções fornecidas pela Google.

Para permitir que o Storage Insights gere e escreva relatórios de inventário, peça ao seu administrador para conceder ao agente de serviço as seguintes funções de IAM:

  • roles/storage.insightsCollectorService no contentor de origem, que inclui as autorizações storage.buckets.getObjectInsights e storage.buckets.get
  • roles/storage.objectCreator no contentor de destino, que inclui a autorização storage.objects.create

Para obter instruções sobre como conceder funções, consulte o artigo Use o IAM. Pode conceder a função roles/storage.insightsCollectorService através da consola ou da Google Cloud CLI. Google Cloud Por exemplo: 

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

Depois de o agente de serviço receber as autorizações necessárias, demora até 24 horas a escrever o primeiro relatório de inventário no contentor de destino.

Edite uma configuração de relatório de inventário

Depois de criar uma configuração de relatório de inventário, pode modificar determinadas propriedades da configuração.

Consola

Para editar uma configuração de relatório de inventário, siga os passos abaixo:

  1. Na Google Cloud consola, aceda à página Recipientes do Cloud Storage.

    Aceda a Recipientes

  2. Na lista de contentores, clique no nome do contentor de origem que contém a configuração do relatório de inventário que quer editar.

  3. Na página Detalhes do contentor do contentor de origem, clique no separador Relatórios de inventário.

  4. Clique no nome da configuração do relatório de inventário que quer editar.

  5. Na página Detalhes da configuração do relatório apresentada, edite as propriedades pretendidas através do botão Editar.

Linha de comandos

Para editar uma configuração de relatório de inventário, siga os passos abaixo:

  1. Para encontrar o nome da configuração do relatório de inventário que quer editar, liste todas as configurações de inventário no contentor de origem com o 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)"

    Substituição:

    • SOURCE_BUCKET com o URL do bucket de origem que contém a configuração do relatório de inventário.

    • EXPRESSION com um filtro booleano a aplicar a cada item de recurso a apresentar. Se a expressão for avaliada como Verdadeiro, o item é apresentado. Para ver mais detalhes e exemplos de expressões de filtro, execute $ gcloud topic filters.

    • SIZE com o número máximo de recursos por página. A predefinição é 50.

    • FIELD com uma lista separada por vírgulas de nomes de chaves de campos de recursos pelos quais ordenar. A ordem predefinida é ascendente. Adicione o prefixo ~ a um campo para ordenar por ordem descendente nesse campo.

    1. Edite os campos de configuração do relatório de inventário que quer atualizar através do comando gcloud storage insights inventory-reports update. O exemplo seguinte atualiza a configuração do relatório de inventário para gerar relatórios de inventário diariamente no formato Apache Parquet:

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

Bibliotecas cliente

Java

Para mais informações, consulte a documentação de referência da API Java do Cloud Storage.

Para se autenticar no Cloud Storage, configure as Credenciais padrão da aplicação. Para mais informações, consulte o artigo Configure a autenticação para bibliotecas de cliente. 


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);
    }
  }
}

APIs REST

API JSON

Para editar uma configuração de relatório de inventário, conclua os passos seguintes:

  1. Ter a CLI gcloud instalada e inicializada, o que lhe permite gerar um token de acesso para o cabeçalho Authorization.

  2. Obtenha o nome da configuração do relatório de inventário que quer editar usando cURL para chamar a API JSON com um pedido de 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" \

    Substituição:

    • YOUR_PROJECT com o nome do projeto no qual residem os contentores de origem e de destino.

    • LOCATION com a localização dos contentores de origem e destino. Por exemplo, us-west1.

    Se quiser obter todas as configurações de relatórios de inventário num contentor de origem específico, anexe o parâmetro de consulta filter à sua solicitação:

    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" \

    Substituição:

    • YOUR_PROJECT com o nome do projeto no qual residem os contentores de origem e de destino.
    • LOCATION com a localização dos contentores de origem e destino. Por exemplo, us-west1.
    • BUCKET_NAME com o nome do bucket de origem que contém as configurações do relatório de inventário que quer editar.

  3. Crie um ficheiro JSON que inclua as alterações às propriedades que quer editar. O exemplo seguinte atualiza a configuração do relatório de inventário para gerar relatórios de inventário diariamente no formato Apache Parquet:

    {
  "ReportConfig": {
    "frequency_options": {
      "frequency": "DAILY"
    },
    "parquet_options": {
    }
  }

  4. Para aplicar a configuração do relatório de inventário, use cURL para chamar a API JSON com um pedido 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" \

    Substituição:

    • YOUR_PROJECT com o nome do projeto no qual residem os contentores de origem e de destino.

    • LOCATION com a localização dos contentores de origem e destino. Por exemplo, us-west1.

    • REPORT_CONFIG_UUID com o UUID gerado automaticamente da configuração do relatório de inventário.

Apresente configurações de relatórios de inventário

Consola

Para listar as configurações do relatório de inventário num contentor de origem, conclua os passos abaixo:

  1. Na Google Cloud consola, aceda à página Recipientes do Cloud Storage.

    Aceda a Recipientes

  2. Na lista de contentores, clique no nome do contentor de origem que contém as configurações do relatório de inventário que quer ver.

  3. Na página Detalhes do contentor, clique no separador Relatórios de inventário.

    São apresentadas as configurações do relatório de inventário no contentor de origem.

Linha de comandos

Pode listar todas as configurações de inventário num contentor de origem usando o 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)"

Substituição:

  • SOURCE_BUCKET com o URL do bucket de origem que contém a configuração do relatório de inventário.

  • EXPRESSION com um filtro booleano a aplicar a cada item de recurso a apresentar. Se a expressão for avaliada como Verdadeiro, o item é apresentado. Para ver mais detalhes e exemplos de expressões de filtro, execute $ gcloud topic filters.

  • SIZE com o número máximo de recursos por página. A predefinição é 50.

  • FIELD com uma lista separada por vírgulas de nomes de chaves de campos de recursos pelos quais ordenar. A ordem predefinida é ascendente. Adicione o prefixo ~ a um campo para ordenar por ordem descendente nesse campo.

Bibliotecas cliente

Java

Para mais informações, consulte a documentação de referência da API Java do Cloud Storage.

Para se autenticar no Cloud Storage, configure as Credenciais padrão da aplicação. Para mais informações, consulte o artigo Configure a autenticação para bibliotecas de cliente. 


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());
      }
    }
  }
}

APIs REST

API JSON

  1. Ter a CLI gcloud instalada e inicializada, o que lhe permite gerar um token de acesso para o cabeçalho Authorization.

  2. Pode listar todas as configurações de relatórios de inventário num projeto para uma determinada localização através de um pedido para listar configurações de relatórios de inventário:

    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" \

    Substituição:

    • YOUR_PROJECT com o nome do projeto no qual residem os contentores de origem e de destino.

    • LOCATION com a localização dos contentores de origem e destino. Por exemplo, us-west1.

    Se quiser listar todas as configurações de relatórios de inventário num contentor de origem específico, anexe o parâmetro de consulta filter à sua solicitação:

    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" \

    Substituição:

    • YOUR_PROJECT com o nome do projeto no qual residem os contentores de origem e destino.

    • LOCATION com a localização dos contentores de origem e destino. Por exemplo, us-west1.

    • BUCKET_NAME com o nome do contentor de origem que contém as configurações do relatório de inventário que quer listar.

Transfira um relatório de inventário

Consola

Transfira relatórios individuais

Os relatórios de inventário são gerados e armazenados como objetos no contentor de destino, pelo que pode transferi-los como faria com um objeto normal.

Para transferir um relatório de inventário, conclua os seguintes passos:

  1. Na Google Cloud consola, aceda à página Recipientes do Cloud Storage.

    Aceda a Recipientes

  2. Na lista de contentores, clique no nome do contentor de destino que contém o relatório de inventário que quer transferir.

  3. Na página Detalhes do contentor, certifique-se de que o separador Objetos está selecionado.

  4. Clique em Transferir associado ao relatório de inventário que quer transferir.

Se não souber o bucket de destino, também pode transferir um relatório de inventário através da configuração do relatório de inventário a partir da qual foi gerado:

  1. Na Google Cloud consola, aceda à página Recipientes do Cloud Storage.

    Aceda a Recipientes

  2. Na lista de contentores, clique no nome do contentor de origem que contém a configuração do relatório de inventário que gerou o relatório que quer transferir.

  3. Na página Detalhes do contentor, clique no nome da configuração da configuração do relatório de inventário.

  4. Na página Detalhes da configuração do relatório apresentada, navegue para a secção Histórico do relatório de inventário e, de seguida, clique no caminho do objeto de destino do relatório de inventário que quer transferir.

    A página Detalhes do contentor é apresentada para o contentor de destino que contém o relatório de inventário.

  5. Clique em Transferir associado ao relatório de inventário que quer transferir.

Transfira fragmentos de relatórios

Para transferir um relatório de inventário que foi dividido em um ou mais fragmentos, conclua os seguintes passos:

  1. Na Google Cloud consola, aceda à página Recipientes do Cloud Storage.

    Aceda a Recipientes

  2. Na lista de contentores, clique no nome do contentor de destino que especificou quando criou a configuração do relatório de inventário.

  3. Na página Detalhes do contentor, verifique a presença de um ficheiro de manifesto. A presença de um ficheiro de manifesto indica que todos os fragmentos de um relatório de inventário foram gerados.

    Um exemplo de nome de ficheiro de manifesto é fc95c52f-157a-494f-af4a-d4a53a69ba66_2022-11-30T00:00_manifest.json.

  4. No contentor de destino, clique em Transferir associado ao ficheiro de manifesto. Tome nota dos nomes dos ficheiros de fragmentos que quer transferir no campo report_shards_file_names.

  5. No contentor de destino, clique em Transferir associado aos ficheiros de fragmentos que quer transferir.

Linha de comandos

Transfira relatórios individuais

Para transferir um relatório de inventário, conclua os seguintes passos:

  1. Para listar todos os relatórios de inventário que foram gerados por uma configuração de relatório de inventário e obter os respetivos REPORT_DETAIL_ID, use o 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

    Substituição:

    • CONFIG_NAME com o nome exclusivo da configuração do relatório de inventário, no formato projects/PROJECT/locations/LOCATION/reportConfigs/REPORT_CONFIG_UUID.

    • EXPRESSION com um filtro booleano a aplicar a cada item de recurso a apresentar. Se a expressão for avaliada como Verdadeira, esse item é apresentado. Para ver mais detalhes e exemplos de expressões de filtro, execute $ gcloud topic filters.

    • SIZE com o número máximo de recursos por página. A predefinição é 50.

    • FIELD com uma lista separada por vírgulas de nomes de chaves de campos de recursos pelos quais ordenar. A ordem predefinida é ascendente. Adicione o prefixo ~ a um campo para ordenar por ordem descendente nesse campo.

    Se for bem-sucedido, o comando devolve uma saída semelhante à seguinte:

    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. Para transferir um relatório de inventário, tem de obter primeiro a propriedade reportPathPrefix do objeto ReportDetail. Para obter o reportPathPrefix de um relatório, use o comando gcloud storage insights inventory-reports details describe:

    gcloud storage insights inventory-reports details describe REPORT_DETAIL_NAME

    Substitua REPORT_DETAIL_NAME pelo nome do relatório de inventário no formato projects/PROJECT/locations/LOCATION/reportConfigs/REPORT_CONFIG_UUID/reportDetails/REPORT_DETAIL_ID.

Transfira fragmentos de relatórios

Para transferir um relatório de inventário que foi dividido em um ou mais fragmentos, conclua os seguintes passos:

  1. Transfira o ficheiro de manifesto do relatório de inventário através do comando gcloud storage cp:

    gcloud storage cp gs://BUCKET_NAME/MANIFEST_FILE_NAME DOWNLOAD_PATH

    Substituição:

    • BUCKET_NAME com o nome do contentor de destino.

    • MANIFEST_FILE_NAME com o nome do ficheiro de manifesto no contentor de destino, de acordo com a seguinte convenção de nomenclatura:

      REPORT_CONFIG_UUID_TARGET_DATETIME_manifest.json

      Onde:

      • REPORT_CONFIG_UUID é o UUID gerado automaticamente da configuração do relatório de inventário que gerou os fragmentos de relatório que quer transferir.

      • TARGET_DATETIME é a data/hora em que o relatório de inventário foi gerado.

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

    • DOWNLOAD_PATH com o caminho para o seu sistema de ficheiros onde quer guardar o relatório de inventário. Por exemplo, ./example_report.csv.

  2. Para transferir um ficheiro de fragmento, use o comando gcloud storage cp:

    gcloud storage cp gs://BUCKET_NAME/SHARD_FILE_NAME DOWNLOAD_PATH

    Substituição:

    • BUCKET_NAME com o nome do contentor de destino.

    • SHARD_FILE_NAME com o nome com codificação URL do ficheiro de fragmento que quer transferir. Por exemplo, fc95c52f-157a-494f-af4a-d4a53a69ba66_2022-11-30T00:54_0.csv.

    • DOWNLOAD_PATH com o caminho para o seu sistema de ficheiros onde quer guardar o relatório de inventário. Por exemplo, ./example_report.csv.

Bibliotecas cliente

Java

Para mais informações, consulte a documentação de referência da API Java do Cloud Storage.

Para se autenticar no Cloud Storage, configure as Credenciais padrão da aplicação. Para mais informações, consulte o artigo Configure a autenticação para bibliotecas de cliente. 


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);
        }
      }
    }
  }
}

APIs REST

API JSON

Transfira relatórios individuais

Para transferir um relatório de inventário, conclua os seguintes passos:

  1. Ter a CLI gcloud instalada e inicializada, o que lhe permite gerar um token de acesso para o cabeçalho Authorization.

  2. Liste todos os relatórios de inventário gerados por uma configuração de relatório de inventário usando cURL para chamar a API JSON com um pedido para listar os detalhes do relatório de inventário:

    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" \

    Substituição:

    • YOUR_PROJECT com o nome do projeto no qual residem os contentores de origem e de destino.

    • LOCATION com a localização dos contentores de origem e destino. Por exemplo, us-west1.

    • REPORT_CONFIG_UUID com o UUID gerado automaticamente da configuração do relatório de inventário que gerou o relatório que quer transferir.

  3. Para obter os detalhes de um relatório individual, use cURL para chamar a API JSON com um pedido 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" \

    Substituição:

    • YOUR_PROJECT com o nome do projeto no qual residem os contentores de origem e de destino.

    • LOCATION com a localização dos contentores de origem e destino. Por exemplo, us-west1.

    • REPORT_CONFIG_UUID com o UUID gerado automaticamente da configuração do relatório de inventário que gerou o relatório que quer transferir.

    • REPORT_DETAIL_ID com o nome do relatório de inventário que quer transferir.

Transfira fragmentos de relatórios

Para transferir um relatório de inventário que foi dividido em um ou mais fragmentos, conclua os seguintes passos:

  1. Ter a CLI gcloud instalada e inicializada, o que lhe permite gerar um token de acesso para o cabeçalho Authorization.

  2. Para transferir o ficheiro de manifesto do relatório de inventário, use cURL para chamar a API JSON com um pedido de GET objeto:

    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" \

    Substituição:

    • BUCKET_NAME com o nome do contentor de destino.

    • MANIFEST_FILE_NAME com o nome do ficheiro de manifesto no contentor de destino, de acordo com a seguinte convenção de nomenclatura:

      REPORT_CONFIG_UUID_TARGET_DATETIME_manifest.json

      Onde:

      • REPORT_CONFIG_UUID é o UUID gerado automaticamente da configuração do relatório de inventário que gerou os fragmentos de relatório que quer transferir.

      • TARGET_DATETIME é a data em que o relatório de inventário foi gerado.

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

    O campo report_shards_file_names do ficheiro do manifesto contém os nomes dos fragmentos do relatório de inventário que pode transferir.

  3. Para transferir os ficheiros de fragmentos do relatório de inventário, use curl para chamar a API JSON do Cloud Storage com um pedido de Get objeto:

    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"

    Substituição:

    • DOWNLOAD_PATH com o caminho para o seu sistema de ficheiros local onde quer guardar o objeto. Por exemplo, Desktop/dog.png.

    • BUCKET_NAME com o nome do contentor de destino que contém o relatório de inventário. Por exemplo, my-bucket.

    • SHARD_FILE_NAME com o nome com codificação URL do ficheiro de fragmento que quer transferir. Por exemplo, fc95c52f-157a-494f-af4a-d4a53a69ba66_2022-11-30T00:54_0.csv.

Elimine uma configuração de relatório de inventário

Consola

Para eliminar uma configuração de relatório de inventário, conclua os passos seguintes:

  1. Na Google Cloud consola, aceda à página Recipientes do Cloud Storage.

    Aceda a Recipientes

  2. Na lista de contentores, clique no nome do contentor de origem que contém a configuração do relatório de inventário que quer eliminar.

  3. Na página Detalhes do contentor do contentor de origem, clique no separador Relatórios de inventário.

  4. Clique no nome da configuração da configuração do relatório de inventário que quer eliminar.

  5. Na página Detalhes da configuração do relatório apresentada, clique em Eliminar.

Linha de comandos

Para eliminar uma configuração de relatório de inventário, use o comando: gcloud storage insights inventory-reports delete 

gcloud storage insights inventory-reports delete CONFIG_NAME
  --force

Substitua CONFIG_NAME pelo nome exclusivo da configuração do relatório de inventário no formato projects/PROJECT/locations/LOCATION/reportConfigs/REPORT_CONFIG_UUID.

A flag --force elimina os metadados de todos os relatórios de inventário gerados pela configuração de relatório de inventário especificada. Os próprios objetos do relatório de inventário não são eliminados.

Bibliotecas cliente

Java

Para mais informações, consulte a documentação de referência da API Java do Cloud Storage.

Para se autenticar no Cloud Storage, configure as Credenciais padrão da aplicação. Para mais informações, consulte o artigo Configure a autenticação para bibliotecas de cliente. 


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);
    }
  }
}

APIs REST

API JSON

Para eliminar uma configuração de relatório de inventário, conclua os passos seguintes:

  1. Ter a CLI gcloud instalada e inicializada, o que lhe permite gerar um token de acesso para o cabeçalho Authorization.

  2. Para eliminar uma configuração de relatório de inventário, use cURL para chamar a API JSON com um pedido 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' \

    Substituição:

    • YOUR_PROJECT com o nome do projeto no qual residem os contentores de origem e de destino.

    • LOCATION com a localização dos contentores de origem e destino. Por exemplo, us-west1.

    • REPORT_CONFIG_UUID com o UUID gerado automaticamente da configuração do relatório de inventário que quer eliminar.

O parâmetro de consulta force elimina os metadados de todos os relatórios de inventário gerados pela configuração de relatórios de inventário especificada. Os próprios objetos do relatório de inventário não são eliminados.

Avançado: gere relatórios de inventário num formato particionado do Hive

Quando cria uma configuração de relatório de inventário, pode especificar um caminho de destino, que é uma localização no contentor de destino onde os relatórios de inventário são gerados. Isto permite-lhe gerar relatórios de inventário num formato particionado do Hive.

Especifica um caminho de destino através de palavras-chave de marcadores de posição. As palavras-chave no caminho de destino são substituídas pelos respetivos valores quando o relatório de inventário é gerado. Por exemplo, o caminho de destino config={{report-config-id}}/date={{date}} pode ser resolvido como config=1A34-F2E456-12B456-1C3D/date=2022-05-20.

Palavras-chave do caminho de destino

Pode especificar as palavras-chave report-config-id, date ou datetime, incluídas entre {{ e }}, em que:

  • report-config-id é o UUID da configuração do relatório de inventário.

  • date é a data em que o relatório de inventário é gerado. Segue o formato ISO 8601.

  • datetime é a data e a hora em que o relatório de inventário é gerado. Segue o formato ISO 8601.

As palavras-chave podem ser especificadas através de qualquer uma das seguintes ferramentas:

  • Quando usar a Google Cloud consola, especifique palavras-chave na secção Introduza o caminho de destino (opcional). Esta secção aparece quando cria uma configuração de relatório de inventário.

  • Quando usar a Google Cloud CLI, especifique palavras-chave de marcadores de posição através da flag --destination.

  • Quando usar a API JSON, especifique palavras-chave de marcadores de posição no campo storage_destination_options.destination_path do objeto ReportConfig.

Controlo de acesso e segurança

As seguintes recomendações e considerações estão relacionadas com a segurança e a utilização de relatórios e configurações de inventário:

  • Recomendamos que os utilizadores com a função roles/storage.admin também tenham as autorizações storageinsights.reportConfigs.* para poderem manter o controlo sobre a utilização de todos os recursos nos respetivos contentores, como a leitura de objetos e os respetivos metadados.

  • Recomendamos que limite o acesso aos recursos do relatório de inventário concedendo as autorizações storageinsights.reportConfigs.* apenas aos indivíduos necessários.

  • Depois de criar uma configuração de relatório de inventário, esta continua a gerar relatórios de inventário, mesmo que o utilizador que criou a configuração já não tenha as autorizações necessárias. Para parar de gerar relatórios de inventário, pode editar a data de conclusão na configuração do relatório de inventário ou eliminar a configuração por completo.

O que se segue?

  • Se tiver problemas com a geração de relatórios de inventário, consulte a secção de Resolução de problemas para receber ajuda.