All Products
Search

This Product

    Cloud Backup:DescribePoliciesV2

    Document Center

    Cloud Backup:DescribePoliciesV2

    Last Updated:Aug 06, 2026

    Queries one or more policies.

    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

    hbr:DescribePoliciesV2

    list

    *All Resource

    *

    		 None None

    Request parameters

    Parameter

    Type

    Required

    Description

    Example
    NextToken

    string

    No

    The token required to retrieve the next page of policies.

    caeba0bbb2be03f84eb48b699f0a
    MaxResults

    integer

    No

    The number of results per query.

    Valid values: 10 to 100. Default value: 10.

    10
    PolicyId

    string

    No

    The policy ID.

    po-000************2l6

    Response elements

    Element

    Type

    Description

    Example

    object

    DescribePoliciesResponse

    Policies

    array<object>

    The list of policies.

    array<object>

    The policy details.

    CreatedTime

    integer

    The creation time. UNIX timestamp, in seconds.

    1650248136
    UpdatedTime

    integer

    The update time. UNIX timestamp, in seconds.

    1662080404
    PolicyId

    string

    The policy ID.

    po-000************bkz
    PolicyName

    string

    The policy name.

    Daily backup + geo-redundancy backup
    PolicyDescription

    string

    The policy description.

    Back up every day at 10:00 AM and replicate to Shanghai
    Rules

    array<object>

    The list of policy rules.

    array<object>

    The policy rule details.

    RuleId

    string

    The rule ID.

    rule-000************f1e
    RuleType

    string

    The rule type. Each policy must have at least one BACKUP rule and exactly one TRANSITION rule. Valid values:

    • BACKUP: backup rule.

    • TRANSITION: lifecycle rule.

    • REPLICATION: replication rule.

    BACKUP
    Schedule

    string

    This parameter is required only when RuleType is set to BACKUP. The backup schedule. Optional format: I|{startTime}|{interval}. This indicates that a backup job is executed at every {interval} starting from {startTime}. Backup jobs for past time periods are not compensated. If the previous backup job is not completed, the next backup job is not triggered. For example, I|1631685600|P1D indicates that a backup is performed once a day starting from 2021-09-15 14:00:00.

    • startTime: the start time of the backup. UNIX timestamp, in seconds.

    • interval: the ISO 8601 time interval. For example, PT1H indicates an interval of one hour. P1D indicates an interval of one day.

    I|1648647166|P1D
    BackupType

    string

    This parameter is required only when RuleType is set to BACKUP. The backup type. The value is COMPLETE, which indicates a full backup.

    COMPLETE
    VaultId

    string

    This parameter is required only when RuleType is set to BACKUP. The backup vault ID.

    v-000**************kgm
    ReplicationRegionId

    string

    This parameter is required only when RuleType is set to REPLICATION. The destination region ID for replication.

    cn-shanghai
    Retention

    integer

    This parameter is required only when RuleType is set to TRANSITION or REPLICATION.

    • RuleType is set to TRANSITION: the retention period of backups. Minimum value: 1. Unit: days.

    • RuleType is set to REPLICATION: the retention period of geo-redundancy backups. Minimum value: 1. Unit: days.

    7
    RetentionRules

    array<object>

    This parameter is required only when RuleType is set to TRANSITION. The list of special retention rules.

    object

    The special retention rule.

    AdvancedRetentionType

    string

    The type of the special retention rule. Valid values:

    • WEEKLY: weekly backup.

    • MONTHLY: monthly backup.

    • YEARLY: yearly backup.

    YEARLY
    WhichSnapshot

    integer

    The backup to which the rule applies. Currently, only the first backup is supported. The value is 1.

    1
    Retention

    integer

    The special retention period of the backup. Minimum value: 1. Unit: days.

    730
    ArchiveDays

    integer

    This parameter is required only when RuleType is set to TRANSITION. The number of days after which the backup is converted to archive storage. Unit: days.

    30
    KeepLatestSnapshots

    integer

    Specifies whether to retain at least one backup version. Valid values:

    • 0: disabled.

    • 1: enabled.

    1
    DataSourceFilters

    array<object>

    This parameter is required only when RuleType is set to TAG. The data source filter rules.

    object

    SourceType

    string

    The data source type. Valid values:

    • UDM_ECS: ECS instance backup.

    • OSS: OSS backup.

    • NAS: Alibaba Cloud NAS backup.

    • ECS_FILE: ECS file backup.

    • OTS: Tablestore backup.

    UDM_ECS
    DataSourceIds deprecated

    array

    Deprecated.

    Deprecated.
    deprecated

    string

    Deprecated.

    Deprecated
    TagFilters

    array<object>

    This parameter is required only when RuleType is set to TAG. The resource tag filter rules.

    object

    Key

    string

    The tag key.

    env
    Value

    string

    The tag value. An empty value indicates any value.

    prod
    Operator

    string

    The tag matching rule. Valid values:

    • EQUAL: matches both the tag key and tag value.

    • NOT: matches the tag key but not the tag value.

    EQUAL
    Immutable

    boolean

    This parameter is valid only when PolicyType is set to UDM_ECS_ONLY. Specifies whether to enable backup locking.

    true
    PolicyBindingCount

    integer

    The number of data sources bound to the policy.

    5
    PolicyType

    string

    The policy type. Valid values:

    • STANDARD: general backup policy. Supports backing up data sources other than ECS instance backup.

    • UDM_ECS_ONLY: ECS instance backup policy. Supports backing up only ECS instances.

    STANDARD
    BusinessStatus

    string

    The user business status.

    ACTIVE
    NextToken

    string

    The token required to retrieve the next page of policies.

    caeba0bbb2be03f84eb48b699f0a
    MaxResults

    integer

    The number of results per query.

    Valid values: 10 to 100. Default value: 10.

    10
    TotalCount

    integer

    The total number of records.

    12
    Success

    boolean

    Indicates whether the request was successful. Valid values:

    • true: Successful.

    • false: Failed.

    true
    Code

    string

    The response code. 200 indicates success.

    200
    Message

    string

    The returned message. The value "successful" is returned for a successful request. An error message is returned for a failed request.

    successful
    RequestId

    string

    The request ID.

    473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E

    Examples

    Success response

    JSON format

    {
  "Policies": [
    {
      "CreatedTime": 1650248136,
      "UpdatedTime": 1662080404,
      "PolicyId": "po-000************bkz",
      "PolicyName": "Daily backup + offsite backup",
      "PolicyDescription": "Data is backed up at 10:00:00 every day and replicated to the China (Shanghai) region.",
      "Rules": [
        {
          "RuleId": "rule-000************f1e",
          "RuleType": "BACKUP",
          "Schedule": "I|1648647166|P1D",
          "BackupType": "COMPLETE",
          "VaultId": "v-000**************kgm",
          "ReplicationRegionId": "cn-shanghai",
          "Retention": 7,
          "RetentionRules": [
            {
              "AdvancedRetentionType": "YEARLY",
              "WhichSnapshot": 1,
              "Retention": 730
            }
          ],
          "ArchiveDays": 30,
          "KeepLatestSnapshots": 1,
          "DataSourceFilters": [
            {
              "SourceType": "UDM_ECS",
              "DataSourceIds": [
                "Deprecated"
              ]
            }
          ],
          "TagFilters": [
            {
              "Key": "env",
              "Value": "prod",
              "Operator": "EQUAL"
            }
          ],
          "Immutable": true
        }
      ],
      "PolicyBindingCount": 5,
      "PolicyType": "STANDARD",
      "BusinessStatus": "ACTIVE"
    }
  ],
  "NextToken": "caeba0bbb2be03f84eb48b699f0a",
  "MaxResults": 10,
  "TotalCount": 12,
  "Success": true,
  "Code": "200",
  "Message": "successful",
  "RequestId": "473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E"
}

    Error codes

    See Error Codes for a complete list.

    Release notes

    See Release Notes for a complete list.