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à.
ListBackupJobs
Restituisce un elenco di processi di backup esistenti per un account autenticato negli ultimi 30 giorni. Per un periodo di tempo più lungo, prendere in considerazione l'utilizzo di questi strumenti di monitoraggio.
Sintassi della richiesta
GET /backup-jobs/?accountId=ByAccountId
&backupVaultName=ByBackupVaultName
&completeAfter=ByCompleteAfter
&completeBefore=ByCompleteBefore
&createdAfter=ByCreatedAfter
&createdBefore=ByCreatedBefore
&maxResults=MaxResults
&messageCategory=ByMessageCategory
&nextToken=NextToken
&parentJobId=ByParentJobId
&resourceArn=ByResourceArn
&resourceType=ByResourceType
&state=ByState
HTTP/1.1
URIParametri della richiesta
La richiesta utilizza i seguenti URI parametri.
- ByAccountId
-
L'ID account da cui elencare i processi. Restituisce solo i processi di backup associati all'ID account specificato.
Se utilizzato da un account di AWS Organizations gestione, Passing
*
restituisce tutti i job all'interno dell'organizzazione.Modello:
^[0-9]{12}$
- ByBackupVaultName
-
Restituisce solo i processi di backup che verranno archiviati nel vault di backup specificato. I vault di backup sono identificati da nomi univoci per l'account utilizzato per crearli e per la Regione AWS in cui sono stati creati.
Modello:
^[a-zA-Z0-9\-\_]{2,50}$
- ByCompleteAfter
-
Restituisce solo i processi di backup completati dopo una data espressa in formato Unix e Coordinated Universal Time (UTC).
- ByCompleteBefore
-
Restituisce solo i processi di backup completati prima di una data espressa in formato Unix e Coordinated Universal Time ()UTC.
- ByCreatedAfter
-
Restituisce solo i processi di backup creati dopo la data specificata.
- ByCreatedBefore
-
Restituisce solo i processi di backup creati prima della data specificata.
- ByMessageCategory
-
Si tratta di un parametro opzionale che può essere utilizzato per filtrare i lavori con un valore MessageCategory che corrisponde al valore immesso.
Stringhe di esempio possono essere
AccessDenied
,SUCCESS
,AGGREGATE_ALL
eInvalidParameters
.Consulta Monitoraggio.
Il carattere jolly () 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. - ByParentJobId
-
Si tratta di un filtro per elencare i processi (nidificati) figlio in base all'ID del processo padre.
- ByResourceArn
-
Restituisce solo i job di backup che corrispondono alla risorsa specificata Amazon Resource Name (ARN).
- ByResourceType
-
Restituisce solo i processi di backup per le risorse specificate:
-
Aurora
per Amazon Aurora -
CloudFormation
per AWS CloudFormation -
DocumentDB
per Amazon DocumentDB (compatibile con MongoDB) -
DynamoDB
per Amazon DynamoDB -
EBS
per Amazon Elastic Block Store -
EC2
per Amazon Elastic Compute Cloud -
EFS
per Amazon Elastic File System -
FSx
per Amazon FSx -
Neptune
per Amazon Neptune -
RDS
per Amazon Relational Database Service -
Redshift
per Amazon Redshift -
S3
per Amazon Simple Storage Service (Amazon S3) -
SAP HANA on Amazon EC2
per SAP HANA database su istanze Amazon Elastic Compute Cloud -
Storage Gateway
per AWS Storage Gateway -
Timestream
per Amazon Timestream -
VirtualMachine
per macchine VMware virtuali
Modello:
^[a-zA-Z0-9\-\_\.]{1,50}$
-
- ByState
-
Restituisce solo i processi di backup che si trovano nello stato specificato.
Completed with issues
è uno stato specifico della console AWS Backup . InfattiAPI, questo stato si riferisce ai lavori con uno stato pari aCOMPLETED
e aMessageCategory
con un valore diverso daSUCCESS
; vale a dire, lo stato è completato ma viene fornito con un messaggio di stato.Per ottenere il numero di lavori per cui
Completed with issues
, esegui due GET richieste e sottrai il secondo numero più piccolo:GET/backup-jobs/? stato= COMPLETED
GET/backup-jobs/? messageCategory= &stato= SUCCESS COMPLETED
Valori validi:
CREATED | PENDING | RUNNING | ABORTING | ABORTED | COMPLETED | FAILED | EXPIRED | PARTIAL
- MaxResults
-
Il numero massimo di elementi da restituire.
Intervallo valido: valore minimo di 1. Valore massimo pari a 1000.
- NextToken
-
L'elemento successivo che segue un elenco parziale di elementi restituiti. Ad esempio, se viene effettuata una richiesta per restituire il numero
MaxResults
di elementi,NextToken
consente di restituire più elementi dell'elenco a partire dalla posizione indicata dal token successivo.
Corpo della richiesta
La richiesta non ha un corpo della richiesta.
Sintassi della risposta
HTTP/1.1 200
Content-type: application/json
{
"BackupJobs": [
{
"AccountId": "string",
"BackupJobId": "string",
"BackupOptions": {
"string" : "string"
},
"BackupSizeInBytes": number,
"BackupType": "string",
"BackupVaultArn": "string",
"BackupVaultName": "string",
"BytesTransferred": number,
"CompletionDate": number,
"CreatedBy": {
"BackupPlanArn": "string",
"BackupPlanId": "string",
"BackupPlanVersion": "string",
"BackupRuleId": "string"
},
"CreationDate": number,
"ExpectedCompletionDate": number,
"IamRoleArn": "string",
"InitiationDate": number,
"IsParent": boolean,
"MessageCategory": "string",
"ParentJobId": "string",
"PercentDone": "string",
"RecoveryPointArn": "string",
"ResourceArn": "string",
"ResourceName": "string",
"ResourceType": "string",
"StartBy": number,
"State": "string",
"StatusMessage": "string"
}
],
"NextToken": "string"
}
Elementi di risposta
Se l'azione ha esito positivo, il servizio restituisce una HTTP risposta di 200.
I seguenti dati vengono restituiti in JSON formato dal servizio.
- BackupJobs
-
Una serie di strutture contenenti metadati sui processi di backup è stata restituita in JSON formato.
Tipo: matrice di oggetti BackupJob
- NextToken
-
L'elemento successivo che segue un elenco parziale di elementi restituiti. Ad esempio, se viene effettuata una richiesta per restituire il numero
MaxResults
di elementi,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.
HTTPCodice di stato: 400
- ServiceUnavailableException
-
La richiesta non è riuscita a causa di un errore temporaneo del server.
HTTPCodice di stato: 500
Vedi anche
Per ulteriori informazioni sull'utilizzo API in una delle lingue specifiche AWS SDKs, consulta quanto segue: