All Products
Search

This Product

    Tair (Redis® OSS-Compatible):DescribeBackupPolicy

    Document Center

    Tair (Redis® OSS-Compatible):DescribeBackupPolicy

    Last Updated:Jul 27, 2026

    Queries the backup policy of a Tair (Redis® OSS-Compatible) database instance, including the backup cycle and backup time.

    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

    kvstore:DescribeBackupPolicy

    get

    *DBInstance

    acs:kvstore:{#regionId}:{#accountId}:instance/{#instanceId}

    		 None None

    Request parameters

    Parameter

    Type

    Required

    Description

    Example
    InstanceId

    string

    Yes

    The instance ID.

    r-bp1zxszhcgatnx****

    Response elements

    Element

    Type

    Description

    Example

    object

    BackupRetentionPeriod

    string

    The number of days for which backup data is retained.

    7
    RequestId

    string

    The request ID.

    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 is in the yyyy-MM-ddTHH:mmZ format (UTC).

    2019-03-14T05:28Z
    PreferredBackupTime

    string

    The backup time. The time is in the HH:mmZ-HH:mmZ format (UTC).

    05:00Z-06:00Z
    EnableBackupLog

    integer

    Indicates whether incremental backup is enabled. Valid values:

    • 1: enabled.

    • 0: disabled.

    1
    BackupLogStartTime

    string

    AccessDeniedDetail

    object

    This parameter is deprecated. Ignore this parameter.

    AuthAction

    string

    Same as above.

    -
    AuthPrincipalDisplayName

    string

    Same as above.

    -
    AuthPrincipalOwnerId

    string

    Same as above.

    -
    AuthPrincipalType

    string

    Same as above.

    -
    EncodedDiagnosticMessage

    string

    Same as above.

    -
    NoPermissionType

    string

    Same as above.

    -
    PolicyType

    string

    Same as above.

    -
    DbsInstance

    string

    Indicates whether the backup service is enabled for the instance. Valid values:

    • 1: enabled.

    • 0: disabled.

    0

    Examples

    Success response

    JSON format

    {
  "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,
  "BackupLogStartTime": "",
  "AccessDeniedDetail": {
    "AuthAction": "_",
    "AuthPrincipalDisplayName": "_",
    "AuthPrincipalOwnerId": "_",
    "AuthPrincipalType": "_",
    "EncodedDiagnosticMessage": "_",
    "NoPermissionType": "_",
    "PolicyType": "_"
  },
  "DbsInstance": "0"
}

    Error response

    JSON format

    {
	"PreferredBackupPeriod": "Monday,Tuesday,Wednesday,Thursday,Friday,Saturday,Sunday",
	"RequestId": "90B82DB7-FB28-4CC2-ADBF-1F8659F30C26",
	"PreferredNextBackupTime": "2018-10-26T19:05Z",
	"PreferredBackupTime": "19:00Z-20:00Z",
	"BackupRetentionPeriod": "7"
}

    Error codes

    See Error Codes for a complete list.

    Release notes

    See Release Notes for a complete list.