ListBackupJobSummaries

Essa é uma solicitação para um resumo dos trabalhos de backup criados ou em execução nos últimos 30 dias. Você pode incluir os parâmetros AccountId, State,,, ResourceType, MessageCategory AggregationPeriod MaxResults, NextToken ou para filtrar os resultados.

Essa solicitação retorna um resumo que contém região, conta, estado ResourceType, MessageCategory, StartTime, EndTime, e contagem de trabalhos incluídos.

Sintaxe da Solicitação

GET /audit/backup-job-summaries?AccountId=AccountId&AggregationPeriod=AggregationPeriod&MaxResults=MaxResults&MessageCategory=MessageCategory&NextToken=NextToken&ResourceType=ResourceType&State=State HTTP/1.1

Parâmetros da Solicitação de URI

A solicitação usa os seguintes parâmetros de URI:

AccountId

Retorna a contagem de trabalhos para a conta especificada.

Se a solicitação for enviada de uma conta de membro ou de uma conta que não faz parte de AWS Organizations, os trabalhos na conta do solicitante serão devolvidos.

As contas raiz, de administrador e de administrador delegado podem usar o valor ANY para retornar as contagens de trabalhos de todas as contas da organização.

AGGREGATE_ALL agrega as contagens de trabalhos de todas as contas da organização autenticada e retorna a soma.

Padrão: ^[0-9]{12}$

AggregationPeriod

O período para os resultados retornados.

• ONE_DAY- A contagem diária de trabalhos dos 14 dias anteriores.

• SEVEN_DAYS- A contagem agregada de trabalhos dos 7 dias anteriores.

• FOURTEEN_DAYS- A contagem agregada de empregos dos 14 dias anteriores.

Valores Válidos: ONE_DAY | SEVEN_DAYS | FOURTEEN_DAYS

MaxResults

O número máximo de itens a serem retornados.

O valor é um inteiro. O intervalo de valores aceitos é de 1 a 500.

Faixa válida: valor mínimo de 1. Valor máximo de 1.000.

MessageCategory

Esse parâmetro retorna a contagem de trabalhos para a categoria de mensagem especificada.

Exemplos de strings aceitas incluem AccessDenied, Success e InvalidParameters. Consulte Monitoramento para obter uma lista de MessageCategory sequências de caracteres aceitas.

O valor ANY retorna a contagem de todas as categorias de mensagens.

AGGREGATE_ALL agrega as contagens de trabalhos de todas as categorias de mensagens e retorna a soma.

NextToken

O próximo item após uma lista parcial dos recursos retornados. Por exemplo, se uma solicitação for feita para retornar o número MaxResults de recursos, o NextToken permitirá que você retorne mais itens em sua lista começando pelo local apontado pelo próximo token.

ResourceType

Retorna a contagem de trabalhos para o tipo de recurso especificado. Use a solicitação GetSupportedResourceTypes a fim de obter as strings para os tipos de recurso compatíveis.

O valor ANY retorna a contagem de todos os tipos de recurso.

AGGREGATE_ALL agrega as contagens de trabalhos para todos os tipos de recurso e retorna a soma.

O tipo de AWS recurso a ser copiado; por exemplo, um volume do Amazon Elastic Block Store (Amazon EBS) ou um banco de dados do Amazon Relational Database Service (Amazon RDS).

Padrão: ^[a-zA-Z0-9\-\_\.]{1,50}$

State

Esse parâmetro retorna a contagem dos trabalhos que estão no estado especificado.

O valor ANY retorna a contagem de todos os estados.

AGGREGATE_ALL agrega as contagens de trabalhos para todos os estados e retorna a soma.

Completed with issues é um status encontrado somente no console do AWS Backup . Para a API, esse status se refere a trabalhos com um estado de COMPLETED e a uma MessageCategory com um valor diferente de SUCCESS, o que significa que o status é Concluído, mas vem com uma mensagem de status. Para obter a contagem de trabalhos Completed with issues, execute duas solicitações GET e subtraia o número menor:

OBTENHA /audit/backup-job-summaries? AggregationPeriod=Quatorze_dias&state=Concluído

OBTENHA /audit/backup-job-summaries? AggregationPeriod=FOURTEEN_DAYS& MessageCategory =SUCESSO&STATE=Concluído

Valores Válidos: CREATED | PENDING | RUNNING | ABORTING | ABORTED | COMPLETED | FAILED | EXPIRED | PARTIAL | AGGREGATE_ALL | ANY

Corpo da Solicitação

Essa solicitação não tem corpo.

Sintaxe da Resposta

HTTP/1.1 200
Content-type: application/json

{
   "AggregationPeriod": "string",
   "BackupJobSummaries": [ 
      { 
         "AccountId": "string",
         "Count": number,
         "EndTime": number,
         "MessageCategory": "string",
         "Region": "string",
         "ResourceType": "string",
         "StartTime": number,
         "State": "string"
      }
   ],
   "NextToken": "string"
}

Elementos de Resposta

Se a ação for bem-sucedida, o serviço retornará uma resposta HTTP 200.

Os dados a seguir são retornados no formato JSON pelo serviço.

AggregationPeriod

O período para os resultados retornados.

• ONE_DAY- A contagem diária de trabalhos dos 14 dias anteriores.

• SEVEN_DAYS- A contagem agregada de trabalhos dos 7 dias anteriores.

• FOURTEEN_DAYS- A contagem agregada de empregos dos 14 dias anteriores.

Tipo: sequência

BackupJobSummaries

As informações resumidas.

Tipo: matriz de objetos BackupJobSummary

NextToken

O próximo item após uma lista parcial dos recursos retornados. Por exemplo, se uma solicitação for feita para retornar o número MaxResults de recursos, o NextToken permitirá que você retorne mais itens em sua lista começando pelo local apontado pelo próximo token.

Tipo: sequência

Erros

Para obter informações sobre os erros comuns a todas as ações, consulte Erros comuns.

InvalidParameterValueException

Indica que há algo errado com o valor de um parâmetro. Por exemplo, o valor está fora do intervalo.

Código de Status HTTP: 400

ServiceUnavailableException

Houve falha na solicitação devido a um erro temporário do servidor.

Código de Status HTTP: 500

Consulte também

Para obter mais informações sobre como usar essa API em um dos AWS SDKs específicos da linguagem, consulte o seguinte:

• AWS Command Line Interface

• AWS SDK para .NET

• AWS SDK para C++

• AWS SDK para Go v2

• AWS SDK para Java V2

• AWS SDK para JavaScript V3

• AWS SDK para PHP V3

• AWS SDK para Python

• AWS SDK para Ruby V3