ListRestoreJobSummaries - AWS Backup
Sintaxe da SolicitaçãoParâmetros da Solicitação de URICorpo da SolicitaçãoSintaxe da RespostaElementos de RespostaErrosConsulte também

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á.

ListRestoreJobSummaries

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

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

Sintaxe da Solicitação

GET /audit/restore-job-summaries?AccountId=AccountId&AggregationPeriod=AggregationPeriod&MaxResults=MaxResults&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

Esse é o período que define os limites para os resultados retornados.

Os valores aceitáveis incluem:

  • ONE_DAY para uma contagem diária de trabalhos dos últimos 14 dias.

  • SEVEN_DAYS para a contagem agregada de trabalhos dos últimos 7 dias.

  • FOURTEEN_DAYS para a contagem agregada de trabalhos dos últimos 14 dias.

Valores Válidos: ONE_DAY | SEVEN_DAYS | FOURTEEN_DAYS

MaxResults

Esse parâmetro define o número máximo de itens a serem retornados.

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

Intervalo válido: valor mínimo de 1. Valor máximo de 1.000.

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.

Valores Válidos: CREATED | PENDING | RUNNING | ABORTED | COMPLETED | FAILED | 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",
   "NextToken": "string",
   "RestoreJobSummaries": [ 
      { 
         "AccountId": "string",
         "Count": number,
         "EndTime": number,
         "Region": "string",
         "ResourceType": "string",
         "StartTime": number,
         "State": "string"
      }
   ]
}

Elementos de Resposta

Se a ação tiver êxito, o serviço enviará de volta uma resposta HTTP 200.

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

AggregationPeriod

Esse é o período que define os limites para os resultados retornados.

  • ONE_DAY para uma contagem diária de trabalhos dos últimos 14 dias.

  • SEVEN_DAYS para a contagem agregada de trabalhos dos últimos 7 dias.

  • FOURTEEN_DAYS para a contagem agregada de trabalhos dos últimos 14 dias.

Tipo: string

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: string

RestoreJobSummaries

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

Tipo: matriz de objetos RestoreJobSummary

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: