All Products
Search

This Product

    Cloud Backup:ExecutePolicyV2

    Document Center

    Cloud Backup:ExecutePolicyV2

    Last Updated:Aug 28, 2026

    Execute a policy for one or all bound data sources.

    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:ExecutePolicyV2

    create

    *All Resource

    *

    		 None None

    Request parameters

    Parameter

    Type

    Required

    Description

    Example
    PolicyId

    string

    Yes

    Policy ID.

    po-000************hky
    DataSourceId

    string

    No

    Data source ID.

    i-bp1************dtv
    SourceType

    string

    No

    Data source type. Valid values:

    • UDM_ECS: ECS full machine backup.

    UDM_ECS
    RuleId

    string

    Yes

    Rule ID. Only rules with RuleType set to BACKUP can be executed.

    rule-0002*****ux8

    Response elements

    Element

    Type

    Description

    Example

    object

    ExecutePolicyResponse

    Success

    boolean

    Whether the request was successful.

    • true: Success

    • false: Failure

    true
    Code

    string

    Return code. A value of 200 indicates success.

    200
    Message

    string

    Return message. Returns successful on success, or an error message on failure.

    successful
    RequestId

    string

    Request ID.

    F4EEB401-DD21-588D-AE3B-1E835C7655E1
    JobId

    string

    Backup job ID.

    job-*********************

    Examples

    Success response

    JSON format

    {
  "Success": true,
  "Code": "200",
  "Message": "successful",
  "RequestId": "F4EEB401-DD21-588D-AE3B-1E835C7655E1",
  "JobId": "job-*********************"
}

    Error codes

    See Error Codes for a complete list.

    Release notes

    See Release Notes for a complete list.