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

URIParâmetros de solicitação

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

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 de 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",
      "BackupPlanVersion": "string",
      "BackupRuleId": "string"
   },
   "CreationDate": number,
   "EncryptionKeyArn": "string",
   "IamRoleArn": "string",
   "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 de 200.

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

BackupSizeInBytes

O tamanho de um backup, em bytes.

Tipo: longo

BackupVaultArn

E 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: string

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

CalculatedLifecycle

Um objeto CalculatedLifecycle contendo timestamps DeleteAt e MoveToColdStorageAt.

Tipo: objeto CalculatedLifecycle

CompletionDate

A data e a hora em que um trabalho para criar um ponto de recuperação é concluído, no formato Unix e no 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: carimbo de data/hora

CompositeMemberIdentifier

O identificador de um recurso em um grupo composto, como um ponto de recuperação aninhado (filho) pertencente a uma pilha composta (principal). 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 a hora em que um ponto de recuperação é 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

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 a IAM função ARN usada para criar o ponto de recuperação de destino; por exemplo,arn:aws:iam::123456789012:role/S3Access.

Tipo: string

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 a hora em que um ponto de recuperação foi restaurado pela última vez, no formato Unix e no 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: carimbo de data/hora

Lifecycle

O ciclo de vida define quando um recurso protegido é transferido para o armazenamento refrigerado e quando ele expira. AWS Backup faz a transição e expira os backups automaticamente de acordo com o ciclo de vida definido por você.

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 'frio'" não poderá ser alterada depois que um backup for transferido para o armazenamento "frio".

Os tipos de recursos que podem fazer a transição para o armazenamento refrigerado estão listados na tabela Disponibilidade de recursos por recursos. AWS Backup ignora essa expressão para outros tipos de recursos.

Tipo: objeto Lifecycle

ParentRecoveryPointArn

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

Tipo: string

RecoveryPointArn

E 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

E ARN isso 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 AWS recurso a ser salvo como ponto de recuperação; por exemplo, um volume do Amazon Elastic Block Store (AmazonEBS) ou um banco de dados do Amazon Relational Database Service (RDSAmazon).

Tipo: string

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

SourceBackupVaultArn

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

Tipo: string

Status

Um código de status que especifica o estado do ponto de recuperação.

PARTIALo status indica que não AWS Backup foi possível criar o ponto de recuperação antes que a janela de backup fosse fechada. Para aumentar a janela do seu plano de backup usando oAPI, consulte UpdateBackupPlan. Você também pode aumentar a janela do plano de backup usando o console, escolhendo e editando o plano de backup.

EXPIREDo status indica que o ponto de recuperação excedeu seu período de retenção, mas 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 controle de versão, pela desativação do envio de EventBridge eventos ou pela desativação das EventBridge regras estabelecidas pelo. AWS Backup Para pontos de recuperação de recursos do Amazon S3RDS, Amazon 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 STOPPED status não precisam ser excluídos.

O EC2 STOPPED status For SAP HANA on Amazon ocorre devido à ação do usuário, à configuração incorreta do aplicativo ou à falha no backup. Para garantir que futuros backups contínuos sejam bem-sucedidos, consulte o status do ponto de recuperação e verifique SAP HANA os detalhes.

Tipo: sequências

Valores Válidos: COMPLETED | PARTIAL | DELETING | EXPIRED

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: sequências

Valores Válidos: WARM | COLD | DELETED

VaultType

O tipo de cofre no qual o ponto de recuperação descrito é armazenado.

Tipo: sequências

Valores Válidos: BACKUP_VAULT | LOGICALLY_AIR_GAPPED_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.

HTTPCódigo de status: 400

MissingParameterValueException

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

HTTPCódigo de status: 400

ResourceNotFoundException

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

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:

• AWS Command Line Interface

• AWS SDKpara. NET

• AWS SDKpara C++

• AWS SDKpara Go v2

• AWS SDKpara Java V2

• AWS SDKpara JavaScript V3

• AWS SDKpara PHP V3

• AWS SDKpara Python

• AWS SDKpara Ruby V3