ListBackupJobSummaries - AWS Backup

Le traduzioni sono generate tramite traduzione automatica. In caso di conflitto tra il contenuto di una traduzione e la versione originale in Inglese, quest'ultima prevarrà.

ListBackupJobSummaries

È la richiesta di riepilogo dei processi di backup creati o eseguiti negli ultimi 30 giorni. È possibile includere i parametri AccountID, State,, ResourceType, MessageCategory AggregationPeriod MaxResults, o NextToken per filtrare i risultati.

Questa richiesta restituisce un riepilogo che contiene Regione, Account ResourceType, Stato MessageCategory, StartTime, EndTime, e Numero di lavori inclusi.

Sintassi della richiesta

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

Parametri della richiesta URI

La richiesta utilizza i seguenti parametri URI.

AccountId

Restituisce il numero di processi per l'account specificato.

Se la richiesta viene inviata da un account membro o da un account che non fa parte di AWS Organizations, verranno restituiti i lavori all'interno dell'account del richiedente.

Gli account root, amministratore e amministratore delegato possono utilizzare il valore ANY per restituire il numero di processi di ogni account dell'organizzazione.

AGGREGATE_ALL aggrega i numeri dei processi di tutti gli account dell'organizzazione autenticata, quindi restituisce la somma.

Modello: ^[0-9]{12}$

AggregationPeriod

Periodo per i risultati restituiti.

  • ONE_DAY- Il numero di lavori giornalieri per i 14 giorni precedenti.

  • SEVEN_DAYS- Il numero aggregato dei lavori per i 7 giorni precedenti.

  • FOURTEEN_DAYS- Il numero aggregato dei lavori per i 14 giorni precedenti.

Valori validi: ONE_DAY | SEVEN_DAYS | FOURTEEN_DAYS

MaxResults

Il numero massimo di elementi da restituire.

Il valore è un numero intero. L'intervallo di valori validi è compreso tra 1 e 500.

Intervallo valido: valore minimo di 1. Valore massimo pari a 1000.

MessageCategory

Questo parametro restituisce il numero di processi per la categoria di messaggi specificata.

Stringhe di esempio valide sono AccessDenied, Success e InvalidParameters. Vedi Monitoraggio per un elenco delle MessageCategory stringhe accettate.

Il valore ANY restituisce il conteggio di tutte le categorie di messaggi.

AGGREGATE_ALL aggrega i numeri dei processi per tutte le categorie di messaggi e restituisce la somma.

NextToken

L'elemento successivo che segue un elenco parziale di risorse restituite. Ad esempio, se viene effettuata una richiesta per restituire il numero MaxResults di risorse, NextToken consente di restituire più elementi dell'elenco a partire dalla posizione indicata dal token successivo.

ResourceType

Restituisce il numero di processi per il tipo di risorsa specificato. Usa la richiesta GetSupportedResourceTypes per ottenere le stringhe per i tipi di risorsa supportati.

Il valore ANY restituisce il conteggio di tutti i tipi di risorse.

AGGREGATE_ALL aggrega i numeri dei processi per tutti i tipi di risorsa e restituisce la somma.

Il tipo di AWS risorsa di cui eseguire il backup; ad esempio, un volume Amazon Elastic Block Store (Amazon EBS) o un database Amazon Relational Database Service (Amazon RDS).

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

State

Questo parametro restituisce il numero di processi con lo stato specificato.

Il valore ANY restituisce il conteggio di tutti gli stati.

AGGREGATE_ALL aggrega i numeri dei processi per tutti gli stati e restituisce la somma.

Completed with issues è uno stato specifico della console AWS Backup . Per l'API, questo stato si riferisce ai processi COMPLETED e a MessageCategory con un valore diverso da SUCCESS, vale a dire, lo stato è completato ma è accompagnato da un messaggio di stato. Per ottenere il numero di processi per Completed with issues, esegui due richieste GET e sottrai il secondo numero più piccolo:

OTTIENI /audit/? backup-job-summaries AggregationPeriod=fourteen_days&state=Completato

OTTIENI /audit/? backup-job-summaries AggregationPeriod=QUATTORDICI_GIORNI& =successo&state=Completato MessageCategory

Valori validi: CREATED | PENDING | RUNNING | ABORTING | ABORTED | COMPLETED | FAILED | EXPIRED | PARTIAL | AGGREGATE_ALL | ANY

Corpo della richiesta

La richiesta non ha un corpo della richiesta.

Sintassi della risposta

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

Elementi di risposta

Se l'operazione riesce, il servizio restituisce una risposta HTTP 200.

I dati seguenti vengono restituiti in formato JSON mediante il servizio.

AggregationPeriod

Il periodo per i risultati restituiti.

  • ONE_DAY- Il numero di lavori giornalieri per i 14 giorni precedenti.

  • SEVEN_DAYS- Il numero aggregato dei lavori per i 7 giorni precedenti.

  • FOURTEEN_DAYS- Il numero aggregato dei lavori per i 14 giorni precedenti.

▬Tipo: stringa

BackupJobSummaries

Le informazioni di riepilogo.

Tipo: matrice di oggetti BackupJobSummary

NextToken

L'elemento successivo che segue un elenco parziale di risorse restituite. Ad esempio, se viene effettuata una richiesta per restituire il numero MaxResults di risorse, NextToken consente di restituire più elementi dell'elenco a partire dalla posizione indicata dal token successivo.

▬Tipo: stringa

Errori

Per informazioni sugli errori comuni a tutte le operazioni, consultare Errori comuni.

InvalidParameterValueException

Indica che si è verificato un errore con il valore di un parametro. Ad esempio, il valore non è compreso nell'intervallo.

Codice di stato HTTP: 400

ServiceUnavailableException

La richiesta non è riuscita a causa di un errore temporaneo del server.

Codice di stato HTTP: 500

Vedi anche

Per ulteriori informazioni sull'utilizzo di questa API in uno degli AWS SDK specifici della lingua, consulta quanto segue: