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

CreateBackupPlan

Cria um plano de backup usando o nome do plano de backup e as regras de backup. Um plano de backup é um documento que contém informações AWS Backup usadas para agendar tarefas que criam pontos de recuperação para recursos.

Se chamar CreateBackupPlan com um plano existente, você receberá uma exceção AlreadyExistsException.

Sintaxe da Solicitação

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

{
   "BackupPlan": { 
      "AdvancedBackupSettings": [ 
         { 
            "BackupOptions": { 
               "string" : "string" 
            },
            "ResourceType": "string"
         }
      ],
      "BackupPlanName": "string",
      "Rules": [ 
         { 
            "CompletionWindowMinutes": number,
            "CopyActions": [ 
               { 
                  "DestinationBackupVaultArn": "string",
                  "Lifecycle": { 
                     "DeleteAfterDays": number,
                     "MoveToColdStorageAfterDays": number,
                     "OptInToArchiveForSupportedResources": boolean
                  }
               }
            ],
            "EnableContinuousBackup": boolean,
            "IndexActions": [ 
               { 
                  "ResourceTypes": [ "string" ]
               }
            ],
            "Lifecycle": { 
               "DeleteAfterDays": number,
               "MoveToColdStorageAfterDays": number,
               "OptInToArchiveForSupportedResources": boolean
            },
            "RecoveryPointTags": { 
               "string" : "string" 
            },
            "RuleName": "string",
            "ScheduleExpression": "string",
            "ScheduleExpressionTimezone": "string",
            "StartWindowMinutes": number,
            "TargetBackupVaultName": "string"
         }
      ]
   },
   "BackupPlanTags": { 
      "string" : "string" 
   },
   "CreatorRequestId": "string"
}

Parâmetros da solicitação de URI

A solicitação não usa nenhum parâmetro de URI.

Corpo da Solicitação

A solicitação aceita os dados a seguir no formato JSON.

BackupPlan

O corpo de um plano de backup. Inclui um BackupPlanName e um ou mais conjuntos de Rules.

Tipo: objeto BackupPlanInput

Obrigatório: Sim

BackupPlanTags

As tags a serem atribuídas ao plano de backup.

Tipo: mapa de string para string

Obrigatório: Não

CreatorRequestId

Identifica a solicitação e permite que as solicitações com falha sejam repetidas sem o risco de a operação ser executada duas vezes. Se a solicitação incluir um CreatorRequestId que corresponda a um plano de backup existente, esse plano será retornado. Esse parâmetro é opcional.

Se usado, esse parâmetro deve conter de 1 a 50 caracteres alfanuméricos ou “-_” .

Tipo: String

Obrigatório: Não

Sintaxe da Resposta

HTTP/1.1 200
Content-type: application/json

{
   "AdvancedBackupSettings": [ 
      { 
         "BackupOptions": { 
            "string" : "string" 
         },
         "ResourceType": "string"
      }
   ],
   "BackupPlanArn": "string",
   "BackupPlanId": "string",
   "CreationDate": number,
   "VersionId": "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.

AdvancedBackupSettings

As configurações de um tipo de recurso. Essa opção só está disponível para trabalhos de backup do Serviço de Cópias de Sombra de Volume (VSS) do Windows.

Tipo: matriz de objetos AdvancedBackupSetting

BackupPlanArn

Um Nome do recurso da Amazon (ARN) que identifica exclusivamente um plano de backup, por exemplo, arn:aws:backup:us-east-1:123456789012:plan:8F81F553-3A74-4A3F-B93D-B3360DC80C50.

Tipo: String

BackupPlanId

O ID do plano de backup.

Tipo: String

CreationDate

A data e hora em que o plano de backup foi criado, em formato de hora Unix e Tempo Universal Coordenado (UTC). O valor de CreationDate tem precisão de milissegundos. Por exemplo, o valor 1516925490,087 representa sexta-feira, 26 de janeiro de 2018, 0:11:30,087.

Tipo: Timestamp

VersionId

Strings Unicode exclusivas geradas aleatoriamente, codificadas em UTF-8 que têm no máximo 1.024 bytes. Eles não podem ser editados.

Tipo: String

Erros

Para obter informações sobre os erros comuns a todas as ações, consulte Erros comuns.

AlreadyExistsException

O recurso necessário já existe.

Arn

Context

CreatorRequestId

Type

Código de status HTTP: 400

InvalidParameterValueException

Indica que há algo errado com o valor de um parâmetro. Por exemplo, o valor está fora do intervalo.

Context

Type

Código de status HTTP: 400

LimitExceededException

Um limite na solicitação foi excedido; por exemplo, o número máximo de itens permitidos em uma solicitação.

Context

Type

Código de status HTTP: 400

MissingParameterValueException

Indica que um parâmetro necessário está ausente.

Context

Type

Código de status HTTP: 400

ServiceUnavailableException

Houve falha na solicitação devido a um erro temporário do servidor.

Context

Type

Código de status HTTP: 500

Consulte também

Para obter mais informações sobre como usar essa API em uma das linguagens específicas AWS SDKs, consulte o seguinte: