As traduções são geradas por tradução automática. Em caso de conflito entre o conteúdo da tradução e da versão original em inglês, a versão em inglês prevalecerá.
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 ou NextToken para filtrar os resultados.
Essa solicitação retorna um resumo que contém Region, Account, State, ResourceType, MessageCategory, StartTime, EndTime e Count dos 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 do AWS Organizations, os trabalhos na conta do solicitante serão retornados.
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_ALLagrega 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 últimos 14 dias. -
SEVEN_DAYS: A contagem agregada de trabalhos dos últimos 7 dias. -
FOURTEEN_DAYS: A contagem agregada de trabalhos dos últimos 14 dias.
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,SuccesseInvalidParameters. Consulte Monitoring para conferir uma lista de strings de MessageCategory aceitas.O valor ANY retorna a contagem de todas as categorias de mensagens.
AGGREGATE_ALLagrega 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
MaxResultsde recursos, oNextTokenpermitirá 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
GetSupportedResourceTypesa 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_ALLagrega as contagens de trabalhos para todos os tipos de recurso e retorna a soma.O tipo de recurso da AWS ter o backup feito. 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_ALLagrega 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 deCOMPLETEDe a umaMessageCategorycom um valor diferente deSUCCESS, o que significa que o status é Concluído, mas vem com uma mensagem de status. Para obter a contagem de trabalhosCompleted with issues, execute duas solicitações GET e subtraia o número menor:GET /audit/backup-job-summaries?AggregationPeriod=FOURTEEN_DAYS&State=COMPLETED
GET /audit/backup-job-summaries?AggregationPeriod=FOURTEEN_DAYS&MessageCategory=SUCCESS&State=COMPLETED
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 últimos 14 dias. -
SEVEN_DAYS: A contagem agregada de trabalhos dos últimos 7 dias. -
FOURTEEN_DAYS: A contagem agregada de trabalhos dos últimos 14 dias.
Tipo: string
-
- 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
MaxResultsde recursos, oNextTokenpermitirá que você retorne mais itens em sua lista começando pelo local apontado pelo próximo token.Tipo: string
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 SDKs específicos de linguagem AWS, consulte:
