All Products
Search

This Product

    Data Management:ModifyBackupSourceEndpoint

    Document Center

    Data Management:ModifyBackupSourceEndpoint

    Last Updated:Jan 13, 2026

    Modifies the source endpoint of a database 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

    dbs:ModifyBackupSourceEndpoint

    update

    *All Resource

    *

    		 None None

    Request parameters

    Parameter

    Type

    Required

    Description

    Example
    BackupPlanId

    string

    Yes

    The ID of the backup plan. Call the DescribeBackupPlanList operation to obtain the value of this parameter.

    dbs1h****usfa
    SourceEndpointInstanceType

    string

    Yes

    The location of the database. Call the DescribeBackupPlanList operation to obtain the value of this parameter. Valid values:

    • RDS

    • ECS

    • Express: A database connected over a leased line, VPN Gateway, or Smart Access Gateway.

    • Agent: A database connected through a backup gateway.

    • DDS: An ApsaraDB for MongoDB instance.

    • Other: A database connected using an IP address and a port number.

    RDS
    SourceEndpointRegion

    string

    No

    The region of the database. Call the DescribeBackupPlanList operation to obtain the value of this parameter.

    Note

    This parameter is required if SourceEndpointInstanceType is set to RDS, ECS, DDS, Express, or Agent.

    cn-hangzhou
    SourceEndpointInstanceID

    string

    No

    The ID of the database instance. Call the DescribeBackupPlanList operation to obtain the value of this parameter.

    Note

    This parameter is required if SourceEndpointInstanceType is set to RDS, ECS, DDS, or Express.

    rm-bp1p8c29479jv****
    SourceEndpointIP

    string

    No

    The database endpoint. Call the DescribeBackupPlanList operation to obtain the value of this parameter.

    Note

    This parameter is required if SourceEndpointInstanceType is set to Express, Agent, or Other.

    100.*.*.10:3306
    SourceEndpointPort

    integer

    No

    The database port. Call the DescribeBackupPlanList operation to obtain the value of this parameter.

    Note

    This parameter is required if SourceEndpointInstanceType is set to Express, Agent, Other, or ECS.

    3306
    SourceEndpointDatabaseName

    string

    No

    The database name.

    • This parameter is required if the database type is PostgreSQL or MongoDB.

    • This parameter is required if SourceEndpointInstanceType is set to Agent and the database type is MSSQL.

    test
    SourceEndpointUserName

    string

    No

    The database account. Call the DescribeBackupPlanList operation to obtain the value of this parameter.

    This parameter is optional if the database type is Redis, or if SourceEndpointInstanceType is set to Agent and the database type is MSSQL. In all other scenarios, this parameter is required.

    test
    SourceEndpointPassword

    string

    No

    The password.

    This parameter is optional if the database type is Redis, or if SourceEndpointInstanceType is set to Agent and the database type is MSSQL. In all other scenarios, this parameter is required.

    test
    BackupGatewayId

    integer

    No

    The ID of the backup gateway. Call the DescribeBackupPlanList operation to obtain the value of this parameter.

    Note

    This parameter is required if SourceEndpointInstanceType is set to Agent.

    21321323213
    BackupObjects

    string

    No

    The backup objects. This parameter is optional if SourceEndpointInstanceType is set to Agent. In all other scenarios, this parameter is required. Call the DescribeBackupPlanList operation to obtain the value of this parameter.

    [{ "DBName":"待备份库名", "SchemaName":"待备份 Schema 名", "TableIncludes":[{ "TableName":"待备份表表名" }], "TableExcludes":[{"TableName":"待备份库名不需要备份表的表名" }] } ]
    SourceEndpointOracleSID

    string

    No

    The Oracle system ID (SID). This parameter is required if the database type is Oracle.

    test
    CrossAliyunId

    string

    No

    The UID of the Alibaba Cloud account that is used for cross-account backup. Call the DescribeRestoreTaskList operation to obtain the value of this parameter.

    2xxx7778xxxxxxxxxx
    CrossRoleName

    string

    No

    The name of the RAM role that is created for cross-account backup. Call the DescribeRestoreTaskList operation to obtain the value of this parameter.

    test123
    ClientToken

    string

    No

    A string that is used to ensure the idempotence of the request. This prevents repeated request submissions.

    ETnLKlblzczshOTUbOCzxxxxxxx

    Response elements

    Element

    Type

    Description

    Example

    object

    HttpStatusCode

    integer

    The HTTP status code.

    200
    RequestId

    string

    The request ID.

    D6E068C3-25BC-455A-85FE-45F0B22E****
    ErrCode

    string

    The error code.

    Param.NotFound
    Success

    boolean

    Indicates whether the request was successful. Valid values:

    • true: The request was successful.

    • false: The request failed.

    true
    ErrMessage

    string

    The error message.

    The specified parameter %s value is not valid.

    BackupPlanId

    string

    The ID of the backup plan.

    dbs1h****usfa
    NeedPrecheck

    boolean

    Indicates whether the modification triggers a precheck. If the value is true, you must call the StartBackupPlan operation to start the backup plan.

    false

    Examples

    Success response

    JSON format

    {
  "HttpStatusCode": 200,
  "RequestId": "D6E068C3-25BC-455A-85FE-45F0B22E****",
  "ErrCode": "Param.NotFound",
  "Success": true,
  "ErrMessage": "The specified parameter %s value is not valid. ",
  "BackupPlanId": "dbs1h****usfa",
  "NeedPrecheck": false
}

    Error codes

    HTTP status code

    Error code

    Error message

    Description
    403 Request.Forbidden Have no Permissions

    See Error Codes for a complete list.

    Release notes

    See Release Notes for a complete list.