CreateBackupPlan - AWS Backup
Sintaxe da SolicitaçãoURIParâmetros de solicitaçãoCorpo 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,
            "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"
}

URIParâmetros de solicitação

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

Corpo da Solicitação

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

BackupPlan

O corpo de um plano alternativo. 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 de 200.

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

AdvancedBackupSettings

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

Tipo: matriz de objetos AdvancedBackupSetting

BackupPlanArn

Um nome de 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 a hora em que um plano de backup é criado, no formato Unix e no 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: carimbo de data/hora

VersionId

Sequências de caracteres Unicode exclusivas, geradas aleatoriamente, codificadas em UTF -8, com no máximo 1.024 bytes de comprimento. 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.

HTTPCódigo de status: 400

InvalidParameterValueException

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

HTTPCódigo de status: 400

LimitExceededException

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

HTTPCódigo de status: 400

MissingParameterValueException

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

HTTPCódigo de status: 400

ServiceUnavailableException

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

HTTPCódigo de status: 500

Consulte também

Para obter mais informações sobre como usar isso API em um idioma específico AWS SDKs, consulte o seguinte: