All Products
Search

This Product

    Data Management:ModifyBackupSourceEndpoint

    Document Center

    Data Management:ModifyBackupSourceEndpoint

    Last Updated:Apr 24, 2026

    Modify a DBS backup source endpoint.

    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

    *BackupPlan

    acs:dbs:{#regionId}:{#accountId}:backupplan/{#BackupPlanId}

    		 None None

    Request parameters

    Parameter

    Type

    Required

    Description

    Example
    BackupPlanId

    string

    Yes

    The backup plan ID. You can call the DescribeBackupPlanList operation to get this value.

    dbs1h****usfa
    SourceEndpointInstanceType

    string

    Yes

    The type of the source instance. You can call the DescribeBackupPlanList operation to get this value. Valid values:

    • RDS: an RDS instance

    • ECS: a self-managed database on an ECS instance

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

    • Agent: a database connected over a backup gateway

    • DDS: an ApsaraDB for MongoDB instance

    • Other: a database connected over an IP address and port

    RDS
    SourceEndpointRegion

    string

    No

    The database region. You can call the DescribeBackupPlanList operation to get this value.

    Note

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

    cn-hangzhou
    SourceEndpointInstanceID

    string

    No

    The database instance ID. You can call the DescribeBackupPlanList operation to get this value.

    Note

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

    rm-bp1p8c29479jv****
    SourceEndpointIP

    string

    No

    The IP address of the database. You can call the DescribeBackupPlanList operation to get this value.

    Note

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

    100.*.*.10:3306
    SourceEndpointPort

    integer

    No

    The database port. You can call the DescribeBackupPlanList operation to get this value.

    Note

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

    3306
    SourceEndpointDatabaseName

    string

    No

    The database name.

    • This parameter is required for PostgreSQL and MongoDB databases.

    • This parameter is also required for Microsoft SQL Server databases when the SourceEndpointInstanceType parameter is set to 'Agent'.

    test
    SourceEndpointUserName

    string

    No

    The username of the database account. You can call the DescribeBackupPlanList operation to get this value.

    This parameter is required for all database engines except for Redis and Microsoft SQL Server (when the SourceEndpointInstanceType parameter is set to 'Agent').

    test
    SourceEndpointPassword

    string

    No

    The password for the database account.

    This parameter is required for all database engines except for Redis and Microsoft SQL Server (when the SourceEndpointInstanceType parameter is set to 'Agent').

    test
    BackupGatewayId

    integer

    No

    The backup gateway ID. You can call the DescribeBackupPlanList operation to get this value.

    Note

    This parameter is required if the SourceEndpointInstanceType parameter is set to Agent.

    21321323213
    BackupObjects

    string

    No

    Backup objects: This parameter is optional if the database is located on an agent, but required for all other scenarios. You can call the DescribeBackupPlanList operation to obtain the value of this parameter.

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

    string

    No

    The Oracle SID. This parameter is required for Oracle databases.

    test
    CrossAliyunId

    string

    No

    The UID for cross-account backup.

    2xxx7778xxxxxxxxxx
    CrossRoleName

    string

    No

    The RAM role name for cross-account backup.

    test123
    ClientToken

    string

    No

    A client-generated token to ensure request idempotence.

    ETnLKlblzczshOTUbOCzxxxxxxx
    EnableSourceEndpointSsl

    string

    No

    Specifies whether to use an SSL connection to back up the source database.

    true
    SslCaPem

    string

    No

    The PEM certificate for the SSL connection.

    -----BEGIN CERTIFICATE----- ... -----END CERTIFICATE-----
    SourceEndpointOracleHome

    string

    No

    The Oracle Home path.

    /home/test

    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 backup plan ID.

    dbs1h****usfa
    NeedPrecheck

    boolean

    Indicates whether the modification triggers a precheck. If this parameter is set to 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.