本文属于机器翻译版本。若本译文内容与英语原文存在差异,则一律以英文原文为准。
DescribeRecoveryPoint
Returns metadata associated with a recovery point, including ID, status, encryption, and lifecycle.
Request Syntax
GET /backup-vaults/backupVaultName
/recovery-points/recoveryPointArn
HTTP/1.1
URI Request Parameters
The request uses the following URI parameters.
- backupVaultName
-
The name of a logical container where backups are stored. Backup vaults are identified by names that are unique to the account used to create them and the AWS Region where they are created. They consist of lowercase letters, numbers, and hyphens.
Pattern:
^[a-zA-Z0-9\-\_]{2,50}$
Required: Yes
- recoveryPointArn
-
An Amazon Resource Name (ARN) that uniquely identifies a recovery point; for example,
arn:aws:backup:us-east-1:123456789012:recovery-point:1EB3B5E7-9EB0-435A-A80B-108B488B0D45
.Required: Yes
Request Body
The request does not have a request body.
Response Syntax
HTTP/1.1 200
Content-type: application/json
{
"BackupSizeInBytes": number,
"BackupVaultArn": "string",
"BackupVaultName": "string",
"CalculatedLifecycle": {
"DeleteAt": number,
"MoveToColdStorageAt": number
},
"CompletionDate": number,
"CreatedBy": {
"BackupPlanArn": "string",
"BackupPlanId": "string",
"BackupPlanVersion": "string",
"BackupRuleId": "string"
},
"CreationDate": number,
"EncryptionKeyArn": "string",
"IamRoleArn": "string",
"IsEncrypted": boolean,
"LastRestoreTime": number,
"Lifecycle": {
"DeleteAfterDays": number,
"MoveToColdStorageAfterDays": number
},
"RecoveryPointArn": "string",
"ResourceArn": "string",
"ResourceType": "string",
"SourceBackupVaultArn": "string",
"Status": "string",
"StorageClass": "string"
}
Response Elements
If the action is successful, the service sends back an HTTP 200 response.
The following data is returned in JSON format by the service.
- BackupSizeInBytes
-
The size, in bytes, of a backup.
Type: Long
- BackupVaultArn
-
An ARN that uniquely identifies a backup vault; for example,
arn:aws:backup:us-east-1:123456789012:vault:aBackupVault
.Type: String
- BackupVaultName
-
The name of a logical container where backups are stored. Backup vaults are identified by names that are unique to the account used to create them and the Region where they are created. They consist of lowercase letters, numbers, and hyphens.
Type: String
Pattern:
^[a-zA-Z0-9\-\_]{2,50}$
- CalculatedLifecycle
-
A
CalculatedLifecycle
object containingDeleteAt
andMoveToColdStorageAt
timestamps.Type: CalculatedLifecycle object
- CompletionDate
-
The date and time that a job to create a recovery point is completed, in Unix format and Coordinated Universal Time (UTC). The value of
CompletionDate
is accurate to milliseconds. For example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM.Type: Timestamp
- CreatedBy
-
Contains identifying information about the creation of a recovery point, including the
BackupPlanArn
,BackupPlanId
,BackupPlanVersion
, andBackupRuleId
of the backup plan used to create it.Type: RecoveryPointCreator object
- CreationDate
-
The date and time that a recovery point is created, in Unix format and Coordinated Universal Time (UTC). The value of
CreationDate
is accurate to milliseconds. For example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM.Type: Timestamp
- EncryptionKeyArn
-
The server-side encryption key used to protect your backups; for example,
arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab
.Type: String
- IamRoleArn
-
Specifies the IAM role ARN used to create the target recovery point; for example,
arn:aws:iam::123456789012:role/S3Access
.Type: String
- IsEncrypted
-
A Boolean value that is returned as
TRUE
if the specified recovery point is encrypted, orFALSE
if the recovery point is not encrypted.Type: Boolean
- LastRestoreTime
-
The date and time that a recovery point was last restored, in Unix format and Coordinated Universal Time (UTC). The value of
LastRestoreTime
is accurate to milliseconds. For example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM.Type: Timestamp
- Lifecycle
-
The lifecycle defines when a protected resource is transitioned to cold storage and when it expires. AWS Backup transitions and expires backups automatically according to the lifecycle that you define.
Backups that are transitioned to cold storage must be stored in cold storage for a minimum of 90 days. Therefore, the “expire after days” setting must be 90 days greater than the “transition to cold after days” setting. The “transition to cold after days” setting cannot be changed after a backup has been transitioned to cold.
Only Amazon EFS file system backups can be transitioned to cold storage.
Type: Lifecycle object
- RecoveryPointArn
-
An ARN that uniquely identifies a recovery point; for example,
arn:aws:backup:us-east-1:123456789012:recovery-point:1EB3B5E7-9EB0-435A-A80B-108B488B0D45
.Type: String
- ResourceArn
-
An ARN that uniquely identifies a saved resource. The format of the ARN depends on the resource type.
Type: String
- ResourceType
-
The type of AWS resource to save as a recovery point; for example, an Amazon Elastic Block Store (Amazon EBS) volume or an Amazon Relational Database Service (Amazon RDS) database.
Type: String
Pattern:
^[a-zA-Z0-9\-\_\.]{1,50}$
- SourceBackupVaultArn
-
An Amazon Resource Name (ARN) that uniquely identifies the source vault where the resource was originally backed up in; for example,
arn:aws:backup:us-east-1:123456789012:vault:BackupVault
. If the recovery is restored to the same AWS account or Region, this value will benull
.Type: String
- Status
-
A status code specifying the state of the recovery point.
注意 A partial status indicates that the recovery point was not successfully re-created and must be retried.
Type: String
Valid Values:
COMPLETED | PARTIAL | DELETING | EXPIRED
- StorageClass
-
Specifies the storage class of the recovery point. Valid values are
WARM
orCOLD
.Type: String
Valid Values:
WARM | COLD | DELETED
Errors
For information about the errors that are common to all actions, see Common Errors.
- InvalidParameterValueException
-
Indicates that something is wrong with a parameter's value. For example, the value is out of range.
HTTP Status Code: 400
- MissingParameterValueException
-
Indicates that a required parameter is missing.
HTTP Status Code: 400
- ResourceNotFoundException
-
A resource that is required for the action doesn't exist.
HTTP Status Code: 400
- ServiceUnavailableException
-
The request failed due to a temporary failure of the server.
HTTP Status Code: 500
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following: