GetBackup - Key Management Service - Alibaba Cloud Documentation Center

Retrieves information about a specific backup.

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.
API: The API that you can call to perform the action.
Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.
Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.
- For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.
- For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.
Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.
Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

Action

Access level

Resource type

Condition key

Dependent action

yundun-hsm:GetBackup

get

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
BackupId	string	No	The backup ID.	backup-fdb897sdf****

Response parameters

Parameter	Type	Description	Example
	object	The response.
Backup	object	The backup information.
AutoImageCount	integer	The number of automatic backup images.	1
BackupHourInDay	string	The backup time. This is an integer on the hour in a 24-hour format.	10
BackupId	string	The backup ID.	backup-fdb897sdf****
BackupPeriod	integer	The automatic backup cycle in days.	3
CreateTime	integer	The time when the backup was created. This is a UNIX timestamp. Unit: milliseconds.	1682417553781
ExpireTime	integer	The time when the backup expires. This is a UNIX timestamp. Unit: milliseconds.	1682417553781
InstanceId	string	The ID of the HSM instance that is associated with the backup.	hsm-cn-5yd35431****
MaxImageCount	string	The maximum number of images.	3
Name	string	The backup name.	backup-te****
NextImageCreateTime	integer	The time when the next image will be created. This is a UNIX timestamp. Unit: milliseconds.	1682417553781
OwnerInstanceId	string	The ID of the HSM instance to which the backup belongs. This property is available only for backups of HSM instances outside the Chinese mainland and has the same value as InstanceId.	hsm-cn-huoahd****
RegionId	string	The region ID.	cn-hangzhou
ReleaseTime	integer	The time when the backup was released. This is a UNIX timestamp. Unit: milliseconds.	1641275680000
Remark	string	The backup remarks.	test
SpInstanceId	string	The backup ID in the sales domain. This property is available only for backups of HSM instances in the Chinese mainland.	backup-fdb897sdfg53****
Status	string	The backup status. NEW: The backup is not enabled. EXPIRED: The backup has expired. ENABLED: The backup is enabled.	NEW
Type	string	The backup type. DEFAULT: The default backup. NORMAL: The normal backup.	DEFAULT
RequestId	string	The ID of the request. This ID is a unique identifier generated by Alibaba Cloud for the request. You can use this ID to troubleshoot issues.	4C467B38-3910-447D-87BC-AC049166F216

Examples

Success response

JSON format

{
  "Backup": {
    "AutoImageCount": 1,
    "BackupHourInDay": "10",
    "BackupId": "backup-fdb897sdf****",
    "BackupPeriod": 3,
    "CreateTime": 1682417553781,
    "ExpireTime": 1682417553781,
    "InstanceId": "hsm-cn-5yd35431****",
    "MaxImageCount": "3",
    "Name": "backup-te****",
    "NextImageCreateTime": 1682417553781,
    "OwnerInstanceId": "hsm-cn-huoahd****",
    "RegionId": "cn-hangzhou",
    "ReleaseTime": 1641275680000,
    "Remark": "test",
    "SpInstanceId": "backup-fdb897sdfg53****",
    "Status": "NEW",
    "Type": "DEFAULT"
  },
  "RequestId": "4C467B38-3910-447D-87BC-AC049166F216"
}

Error codes

HTTP status code	Error code	Error message	Description
403	NoPermission	caller has no permission

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.