DescribeRecoveryPoint - AWS Backup
Sintaxe da SolicitaçãoParâmetros da Solicitação de URICorpo da SolicitaçãoSintaxe da respostaElementos de RespostaErrosConsulte também

DescribeRecoveryPoint

Retorna metadados associados a um ponto de recuperação, incluindo o ID, o status, a criptografia e o ciclo de vida.

Sintaxe da Solicitação

GET /backup-vaults/backupVaultName/recovery-points/recoveryPointArn?backupVaultAccountId=BackupVaultAccountId HTTP/1.1

Parâmetros da Solicitação de URI

A solicitação usa os seguintes parâmetros de URI:

BackupVaultAccountId

O ID da conta do cofre de backup especificado.

Padrão: : ^[0-9]{12}$

backupVaultName

O nome de um contêiner lógico onde os backups são armazenados. Os cofres de backup são identificados por nomes que são exclusivos da conta usada para criá-los e a região da AWS em que são criados.

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

Exigido: Sim

recoveryPointArn

Um Nome do recurso da Amazon (ARN) que identifica de forma exclusiva um ponto de recuperação. Por exemplo, arn:aws:backup:us-east-1:123456789012:recovery-point:1EB3B5E7-9EB0-435A-A80B-108B488B0D45.

Obrigatório: Sim

Corpo da Solicitação

Essa solicitação não tem corpo.

Sintaxe da resposta

HTTP/1.1 200
Content-type: application/json

{
   "BackupSizeInBytes": number,
   "BackupVaultArn": "string",
   "BackupVaultName": "string",
   "CalculatedLifecycle": { 
      "DeleteAt": number,
      "MoveToColdStorageAt": number
   },
   "CompletionDate": number,
   "CompositeMemberIdentifier": "string",
   "CreatedBy": { 
      "BackupPlanArn": "string",
      "BackupPlanId": "string",
      "BackupPlanName": "string",
      "BackupPlanVersion": "string",
      "BackupRuleCron": "string",
      "BackupRuleId": "string",
      "BackupRuleName": "string",
      "BackupRuleTimezone": "string"
   },
   "CreationDate": number,
   "EncryptionKeyArn": "string",
   "IamRoleArn": "string",
   "IndexStatus": "string",
   "IndexStatusMessage": "string",
   "InitiationDate": number,
   "IsEncrypted": boolean,
   "IsParent": boolean,
   "LastRestoreTime": number,
   "Lifecycle": { 
      "DeleteAfterDays": number,
      "MoveToColdStorageAfterDays": number,
      "OptInToArchiveForSupportedResources": boolean
   },
   "ParentRecoveryPointArn": "string",
   "RecoveryPointArn": "string",
   "ResourceArn": "string",
   "ResourceName": "string",
   "ResourceType": "string",
   "SourceBackupVaultArn": "string",
   "Status": "string",
   "StatusMessage": "string",
   "StorageClass": "string",
   "VaultType": "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.

BackupSizeInBytes

O tamanho de um backup, em bytes.

Tipo: longo

BackupVaultArn

Um ARN que identifica de forma exclusiva um cofre de backup. Por exemplo, arn:aws:backup:us-east-1:123456789012:backup-vault:aBackupVault.

Tipo: String

BackupVaultName

O nome de um contêiner lógico onde os backups são armazenados. Os cofres de backup são identificados por nomes que são exclusivos da conta usada para criá-los e a região da em que são criados.

Tipo: sequência

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

CalculatedLifecycle

Um objeto CalculatedLifecycle contendo timestamps DeleteAt e MoveToColdStorageAt.

Tipo: objeto CalculatedLifecycle

CompletionDate

A data e hora em que um trabalho para criar um ponto de recuperação foi concluído, em formato Unix e Tempo Universal Coordenado (UTC). O valor de CompletionDate 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

CompositeMemberIdentifier

O identificador de um recurso dentro de um grupo composto, como um ponto de recuperação aninhado (filho) que pertence a uma pilha composta (pai). O ID é transferido do ID lógico dentro de uma pilha.

Tipo: String

CreatedBy

Contém informações de identificação sobre a criação de um ponto de recuperação, incluindo o BackupPlanArn, o BackupPlanId, a BackupPlanVersion e o BackupRuleId do plano de backup usado para criá-lo.

Tipo: objeto RecoveryPointCreator

CreationDate

A data e hora em que um ponto de recuperação foi criado, em formato 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

EncryptionKeyArn

A chave de criptografia no lado do servidor usada para proteger seus backups. Por exemplo, arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab.

Tipo: String

IamRoleArn

Especifica o ARN do perfil do IAM usado para criar o ponto de recuperação de destino. Por exemplo, arn:aws:iam::123456789012:role/S3Access.

Tipo: String

IndexStatus

Esse é o status atual do índice de backup associado ao ponto de recuperação especificado.

Os status são: PENDING | ACTIVE | FAILED | DELETING

Um ponto de recuperação com um índice que possui o status de ACTIVE pode ser incluído em uma pesquisa.

Tipo: String

Valores Válidos: PENDING | ACTIVE | FAILED | DELETING

IndexStatusMessage

Uma string na forma de uma mensagem detalhada explicando o status de um índice de backup associado ao ponto de recuperação.

Tipo: String

InitiationDate

A data e hora em que o trabalho de backup que criou esse ponto de recuperação foi iniciado, em formato Unix e Tempo Universal Coordenado (UTC).

Tipo: Timestamp

IsEncrypted

Um valor booliano que é retornado como TRUE se o ponto de recuperação especificado estiver criptografado ou FALSE se o ponto de recuperação não estiver criptografado.

Tipo: booliano

IsParent

Isso retorna o valor booliano de que um ponto de recuperação é um trabalho pai (composto).

Tipo: booliano

LastRestoreTime

A data e hora em que um ponto de recuperação foi restaurado pela última vez, em formato Unix e Tempo Universal Coordenado (UTC). O valor de LastRestoreTime 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

Lifecycle

O ciclo de vida define quando um recurso protegido é transferido para o armazenamento "frio" e quando ele expira. O AWS Backup faz a transição e a expiração de backups automaticamente de acordo com o ciclo de vida que você definir.

Os backups transferidos para o armazenamento "frio" devem ficar armazenados lá por no mínimo 90 dias. Portanto, a configuração de “retenção” deve ser 90 dias maior do que a configuração de “número de dias para transição para armazenamento frio”. A configuração de “número de dias para transferência ao armazenamento a frio” não pode ser alterada depois que um backup é transferido para o armazenamento a frio.

Os tipos de recursos que podem ser transferidos para o armazenamento a frio estão listados na tabela Disponibilidade de recursos por recurso. O AWS Backup ignora essa expressão para outros tipos de recurso.

Tipo: objeto Lifecycle

ParentRecoveryPointArn

Isso é um ARN que identifica de forma exclusiva um ponto de recuperação pai (composto). Por exemplo, arn:aws:backup:us-east-1:123456789012:recovery-point:1EB3B5E7-9EB0-435A-A80B-108B488B0D45.

Tipo: String

RecoveryPointArn

Um ARN que identifica de forma exclusiva um ponto de recuperação. Por exemplo, arn:aws:backup:us-east-1:123456789012:recovery-point:1EB3B5E7-9EB0-435A-A80B-108B488B0D45.

Tipo: String

ResourceArn

Um ARN identifica de forma exclusiva um recurso salvo. O formato do ARN depende do tipo de recurso.

Tipo: String

ResourceName

O nome do recurso que pertence ao backup especificado.

Tipo: String

ResourceType

O tipo de recurso da AWS a ser salvo como ponto de recuperação. Por exemplo, um volume do Amazon Elastic Block Service (Amazon RDS) ou um banco de dados do Amazon Relational Database Service (Amazon RDS).

Tipo: sequência

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

SourceBackupVaultArn

Um Nome do recurso da Amazon (ARN) que identifica de forma exclusiva o cofre de origem em que o backup do recurso foi feito originalmente. Por exemplo, arn:aws:backup:us-east-1:123456789012:backup-vault:aBackupVault. Se a recuperação for restaurada na mesma conta ou região da AWS, esse valor será null.

Tipo: String

Status

Um código de status que especifica o estado do ponto de recuperação. Consulte mais informações em Status do ponto de recuperação no Guia do desenvolvedor do AWS Backup.

  • O status CREATING indica que um trabalho do AWS Backup foi iniciado para um recurso. O processo de backup foi iniciado e está processando ativamente um trabalho de backup para o ponto de recuperação associado.

  • O status AVAILABLE indica que o backup foi criado com sucesso para o ponto de recuperação. O processo de backup foi concluído sem problemas e o ponto de recuperação agora está pronto para uso.

  • O status PARTIAL indica que um ponto de recuperação composto tem um ou mais pontos de recuperação aninhados que não estavam no backup.

  • O status EXPIRED indica que o ponto de recuperação excedeu seu período de retenção, mas o AWS Backup não tem permissão ou não consegue excluí-lo. Para excluir manualmente esses pontos de recuperação, consulte Etapa 3: Excluir os pontos de recuperação na seção Limpar recursos da Introdução.

  • O status STOPPED ocorre em um backup contínuo em que um usuário executou alguma ação que faz com que o backup contínuo seja desativado. Isso pode ser causado pela remoção de permissões, pela desativação do versionamento, pela desativação do envio de eventos para o EventBridge ou pela desativação das regras do EventBridge estabelecidas pelo AWS Backup. Para pontos de recuperação de recursos do Amazon S3, Amazon RDS e Amazon Aurora, esse status ocorre quando o período de retenção de uma regra de backup contínuo é alterado.

    Para resolver o status STOPPED, certifique-se de que todas as permissões solicitadas estejam em vigor e que o versionamento esteja habilitado no bucket do S3. Quando essas condições forem atendidas, a próxima instância de uma regra de backup em execução resultará na criação de um ponto de recuperação contínuo. Os pontos de recuperação com status PARADO não precisam ser excluídos.

    Para o SAP HANA no Amazon EC2, o status STOPPED ocorre devido à ação do usuário, à configuração incorreta da aplicação ou à falha no backup. Para garantir que futuros backups contínuos tenham êxito, consulte o status do ponto de recuperação e verifique o SAP HANA para obter detalhes.

Tipo: String

Valores Válidos: COMPLETED | PARTIAL | DELETING | EXPIRED | AVAILABLE | STOPPED | CREATING

StatusMessage

Uma mensagem de status explicando o status do ponto de recuperação.

Tipo: String

StorageClass

Especifica a classe de armazenamento do ponto de recuperação. Os valores válidos são WARM ou COLD.

Tipo: String

Valores Válidos: WARM | COLD | DELETED

VaultType

O tipo de cofre em que o ponto de recuperação descrito é armazenado.

Tipo: String

Valores Válidos: BACKUP_VAULT | LOGICALLY_AIR_GAPPED_BACKUP_VAULT | RESTORE_ACCESS_BACKUP_VAULT

Erros

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

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

MissingParameterValueException

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

Context

Type

Código de Status HTTP: 400

ResourceNotFoundException

Um recurso necessário para a ação não existe.

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 um dos SDKs específicos de linguagem AWS, consulte: