StartBackupJob

Avvia un processo di backup on demand per la risorsa specificata.

Sintassi della richiesta

PUT /backup-jobs HTTP/1.1
Content-type: application/json

{
   "BackupOptions": { 
      "string" : "string" 
   },
   "BackupVaultName": "string",
   "CompleteWindowMinutes": number,
   "IamRoleArn": "string",
   "IdempotencyToken": "string",
   "Lifecycle": { 
      "DeleteAfterDays": number,
      "MoveToColdStorageAfterDays": number,
      "OptInToArchiveForSupportedResources": boolean
   },
   "RecoveryPointTags": { 
      "string" : "string" 
   },
   "ResourceArn": "string",
   "StartWindowMinutes": number
}

URIParametri di richiesta

La richiesta non utilizza alcun URI parametro.

Corpo della richiesta

La richiesta accetta i seguenti dati nel JSON formato.

BackupOptions

L'opzione di backup per una risorsa selezionata. Questa opzione è disponibile solo per i job di backup di Windows Volume Shadow Copy Service (VSS).

Valori validi: impostata "WindowsVSS":"enabled" per abilitare l'opzione WindowsVSS di backup e creare un VSS backup di Windows. Imposta su "WindowsVSS""disabled" per creare un backup regolare. Per impostazione predefinita, l'opzione WindowsVSS non è abilitata.

Tipo: mappatura stringa a stringa

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

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

Campo obbligatorio: no

BackupVaultName

Il nome di un container logico in cui vengono archiviati i backup. 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.

Tipo: stringa

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

Campo obbligatorio: sì

CompleteWindowMinutes

Un valore in minuti durante il quale un backup avviato correttamente deve essere completato. In caso contrario, il processo verrà annullato da AWS Backup . Questo valore è facoltativo. Questo valore inizia il conto alla rovescia a partire dalla pianificazione del backup. Non aggiunge ulteriore tempo per StartWindowMinutes o se il backup è iniziato più tardi del previsto.

Analogamente a StartWindowMinutes, questo parametro ha un valore massimo di 100 anni (52.560.000 minuti).

Tipo: long

Campo obbligatorio: no

IamRoleArn

Speciifica il IAM ruolo ARN utilizzato per creare il punto di ripristino di destinazione, arn:aws:iam::123456789012:role/S3Access ad esempio.

Tipo: stringa

Campo obbligatorio: sì

IdempotencyToken

Una stringa scelta dal cliente che puoi usare per distinguere tra chiamate altrimenti identiche a StartBackupJob. Riprovare una richiesta riuscita con lo stesso token di idempotenza restituisce un messaggio di completamento senza alcuna azione eseguita.

Tipo: string

Campo obbligatorio: no

Lifecycle

Il ciclo di vita definisce quando una risorsa protetta viene trasferita alla conservazione a freddo e quando scade. AWS Backup eseguirà automaticamente la transizione e la scadenza dei backup in base al ciclo di vita definito.

I backup trasferiti allo storage dei dati inattivi devono essere archiviati nello storage dei dati inattivi per un minimo di 90 giorni. Pertanto, l'impostazione "conservazione" deve essere 90 giorni maggiore dell'impostazione "transizione a inattivo dopo". L'impostazione "transizione a inattivo dopo" non può essere modificata dopo che è stata eseguita la transizione di un backup a inattivo.

I tipi di risorse che possono passare alla conservazione a freddo sono elencati nella tabella Disponibilità delle funzionalità per risorsa. AWS Backup ignora questa espressione per altri tipi di risorse.

Questo parametro ha un valore massimo di 100 anni (36.5000 giorni).

Tipo: oggetto Lifecycle

Campo obbligatorio: no

RecoveryPointTags

I tag da assegnare alle risorse.

Tipo: mappatura stringa a stringa

Campo obbligatorio: no

ResourceArn

Un Amazon Resource Name (ARN) che identifica in modo univoco una risorsa. Il formato di ARN dipende dal tipo di risorsa.

Tipo: stringa

Campo obbligatorio: sì

StartWindowMinutes

Un valore in minuti dopo la pianificazione di un backup prima che un processo venga annullato se non viene avviato correttamente. Questo valore è facoltativo e l'impostazione predefinita è 8 ore. Se questo valore è incluso, devono essere necessari almeno 60 minuti per evitare errori.

Il valore massimo di questo parametro è 100 anni (52.560.000 minuti).

Durante la finestra di avvio, il processo di backup rimane in stato CREATED finché non viene avviato correttamente o fino alla scadenza della finestra di avvio. Se all'interno della finestra di avvio AWS Backup viene visualizzato un errore che consente di riprovare il lavoro, AWS Backup riproverà automaticamente a iniziare il processo almeno ogni 10 minuti fino all'avvio corretto del backup (lo stato del lavoro cambia inRUNNING) o fino a quando lo stato del lavoro non cambia a EXPIRED (cosa che dovrebbe verificarsi al termine della finestra di avvio).

Tipo: long

Campo obbligatorio: no

Sintassi della risposta

HTTP/1.1 200
Content-type: application/json

{
   "BackupJobId": "string",
   "CreationDate": number,
   "IsParent": boolean,
   "RecoveryPointArn": "string"
}

Elementi di risposta

Se l'azione ha esito positivo, il servizio restituisce una risposta di HTTP 200.

I seguenti dati vengono restituiti in JSON formato dal servizio.

BackupJobId

Identifica in modo univoco una richiesta di backup AWS Backup di una risorsa.

Tipo: stringa

CreationDate

Data e ora di creazione di un job di backup, in formato Unix e Coordinated Universal Time (). UTC Il valore di CreationDate è preciso al millisecondo. Ad esempio, il valore 1516925490.087 rappresenta venerdì 26 gennaio 2018 alle ore 12:11:30.087.

Tipo: Timestamp

IsParent

Questo è un valore booleano restituito che indica che si tratta di un processo di backup (composito) padre.

Tipo: Booleano

RecoveryPointArn

Nota: questo campo viene restituito solo per le risorse Amazon EFS e Advanced DynamoDB.

E ARN che identifica in modo univoco un punto di ripristino; ad esempio,. arn:aws:backup:us-east-1:123456789012:recovery-point:1EB3B5E7-9EB0-435A-A80B-108B488B0D45

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

InvalidRequestException

Indica che si è verificato un errore nell'input alla richiesta. Ad esempio, un parametro è del tipo errato.

HTTPCodice di stato: 400

LimitExceededException

È stato superato un limite nella richiesta, ad esempio il numero massimo di elementi consentiti in una richiesta.

HTTPCodice di stato: 400

MissingParameterValueException

Indica che manca un parametro obbligatorio.

HTTPCodice di stato: 400

ResourceNotFoundException

Una risorsa necessaria per l'azione non esiste.

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:

• Interfaccia a riga di comando AWS

• AWS SDKper. NET

• AWS SDKper C++

• AWS SDKper Go v2

• AWS SDKper Java V2

• AWS SDKper JavaScript V3

• AWS SDKper PHP V3

• AWS SDKper Python

• AWS SDKper Ruby V3