DescribeBackupPolicy - - Alibaba Cloud Documentation Center

Queries the backup policy of an ApsaraDB for Redis instance, including the backup cycle and backup time.

Debugging

You can run this interface directly in OpenAPI Explorer, saving you the trouble of calculating signatures. After running successfully, OpenAPI Explorer can automatically generate SDK code samples.

Debug

Authorization information

The following table shows the authorization information corresponding to the API. The authorization information can be used in the Action policy element to grant a RAM user or RAM role the permissions to call this API operation. Description:

Operation: the value that you can use in the Action element to specify the operation on a resource.
Access level: the access level of each operation. The levels are read, write, and list.
Resource type: the type of the resource on which you can authorize the RAM user or the RAM role to perform the operation. Take note of the following items:
- The required resource types are displayed in bold characters.
- If the permissions cannot be granted at the resource level, All Resources is used in the Resource type column of the operation.
Condition Key: the condition key that is defined by the cloud service.
Associated operation: other operations that the RAM user or the RAM role must have permissions to perform to complete the operation. To complete the operation, the RAM user or the RAM role must have the permissions to perform the associated operations.

Operation	Access level	Resource type	Condition key	Associated operation
kvstore:DescribeBackupPolicy	get	*DBInstance `acs:kvstore:{#regionId}:{#accountId}:instance/{#instanceId}`	none	none

Request parameters

Parameter	Type	Required	Description	Example
InstanceId	string	Yes	The ID of the instance.	r-bp1zxszhcgatnx****

Response parameters

Parameter	Type	Description	Example
	object
BackupRetentionPeriod	string	The retention period of the backup data. Unit: days.	7
RequestId	string	The ID of the request.	90B82DB7-FB28-4CC2-ADBF-1F8659F3****
PreferredBackupPeriod	string	The backup cycle. Valid values: Monday Tuesday Wednesday Thursday Friday Saturday Sunday	Monday,Tuesday,Wednesday,Thursday,Friday,Saturday,Sunday
PreferredNextBackupTime	string	The next backup time. The time follows the ISO 8601 standard in the yyyy-MM-ddTHH:mmZ format. The time is displayed in UTC.	2019-03-14T05:28Z
PreferredBackupTime	string	The time range during which the backup was created. The time follows the ISO 8601 standard in the HH:mmZ-HH:mmZ format. The time is displayed in UTC.	05:00Z-06:00Z
EnableBackupLog	integer	Indicates whether incremental data backup is enabled. Valid values: 1: Incremental data backup is enabled. 0: Incremental data backup is disabled.	1
AccessDeniedDetail	object	The following parameters are no longer used. Ignore the parameters.
AuthAction	string	This parameter is no longer used. Ignore this parameter.	_
AuthPrincipalDisplayName	string	This parameter is no longer used. Ignore this parameter.	_
AuthPrincipalOwnerId	string	This parameter is no longer used. Ignore this parameter.	_
AuthPrincipalType	string	This parameter is no longer used. Ignore this parameter.	_
EncodedDiagnosticMessage	string	This parameter is no longer used. Ignore this parameter.	_
NoPermissionType	string	This parameter is no longer used. Ignore this parameter.	_
PolicyType	string	This parameter is no longer used. Ignore this parameter.	_
DbsInstance	string	Indicates whether the backup-as-a-service feature is enabled for the instance. Valid values: 1: The backup-as-a-service feature is enabled for the instance. 0: The backup-as-a-service feature is disabled for the instance.	0

Examples

Sample success responses

JSONformat

{
  "BackupRetentionPeriod": "7",
  "RequestId": "90B82DB7-FB28-4CC2-ADBF-1F8659F3****",
  "PreferredBackupPeriod": "Monday,Tuesday,Wednesday,Thursday,Friday,Saturday,Sunday",
  "PreferredNextBackupTime": "2019-03-14T05:28Z",
  "PreferredBackupTime": "05:00Z-06:00Z",
  "EnableBackupLog": 1,
  "AccessDeniedDetail": {
    "AuthAction": "_",
    "AuthPrincipalDisplayName": "_",
    "AuthPrincipalOwnerId": "_",
    "AuthPrincipalType": "_",
    "EncodedDiagnosticMessage": "_",
    "NoPermissionType": "_",
    "PolicyType": "_"
  },
  "DbsInstance": "0"
}

Error codes

For a list of error codes, visit the Service error codes.

Change history

Change time	Summary of changes	Operation
2023-11-13	The response structure of the API has changed	View Change Details
2023-11-06	The response structure of the API has changed	View Change Details
2023-08-31	The response structure of the API has changed	View Change Details
2023-07-25	API Description Update. The response structure of the API has changed	View Change Details