All Products
Search
Document Center

Database Backup:ModifyBackupSourceEndpoint

Last Updated:Nov 09, 2022

Modifies the information of a backup source.

Authorization information

The following table is the authorization information corresponding to the API, which can be found in the RAM permission policy statement.Action Used in the element to grant the RAM user or RAM role permission to call this API. The specific instructions are as follows:

  • Operation: the value that you can use in the Action element to specify the operation on a resource.
  • Access level: the access level of each operation. The levels are read, write, and list.
  • Resource type: the type of the resource on which you can authorize the RAM user or the RAM role to perform the operation. Take note of the following items:
    • The required resource types are displayed in bold characters.
    • If the permissions cannot be granted at the resource level, All resources is used in the Resource type column of the operation.
  • Condition keyword: refers to the condition keyword defined by the cloud product itself.
  • Associated operation: other operations that the RAM user or the RAM role must have permissions to perform to complete the operation. To complete the operation, the RAM user or the RAM role must have the permissions to perform the associated operations.
Operateaccess levelResource typeconditional keywordAssociation operation
dbs:ModifyBackupSourceEndpointRead
    All resources
    without
without

Request parameters

ParameterTypeRequiredDescriptionExample
BackupPlanIdstringYes

The ID of the backup schedule. You can call the DescribeBackupPlanList operation to obtain the ID of the backup schedule.

dbs1h****usfa
SourceEndpointInstanceTypestringYes

The location of the database. You can call the DescribeBackupPlanList operation to obtain the location. Valid values:

  • RDS
  • ECS
  • Express: The database is connected to DBS by using Express Connect, VPN Gateway, or Smart Access Gateway.
  • Agent: The database is connected to DBS over a DBS backup gateway.
  • DDS: The database is an ApsaraDB for MongoDB database.
  • Other: The database is connected to DBS by using the IP address and port of the database.
RDS
SourceEndpointRegionstringNo

The region in which the database you want to back up resides. You can call the DescribeBackupPlanList operation to obtain the region.

NoteThis parameter is required if the SourceEndpointInstanceType parameter is set to RDS, ECS, DDS, Express, or Agent.
cn-hangzhou
SourceEndpointInstanceIDstringNo

The ID of the database instance. You can call the DescribeBackupPlanList operation to obtain the instance ID of the database.

NoteThis parameter is required if the SourceEndpointInstanceType parameter is set to RDS, ECS, DDS, or Express.
rm-bp1p8c29479jv****
SourceEndpointIPstringNo

The endpoint of the database. You can call the DescribeBackupPlanList operation to obtain the endpoint of the database.

NoteThis parameter is required if the SourceEndpointInstanceType parameter is set to Express, Agent, or Other.
100.*.*.10:3306
SourceEndpointPortintegerNo

The port that is used to connect to the database. You can call the DescribeBackupPlanList operation to obtain the port.

NoteThis parameter is required if the SourceEndpointInstanceType parameter is set to Express, Agent, Other, or ECS.
3306
SourceEndpointDatabaseNamestringNo

The name of the database.

  • This parameter is required if the database is a PostgreSQL or MongoDB database.
  • This parameter is required is the database is an SQL Server database that is connected to DBS over a DBS backup gateway.
test
SourceEndpointUserNamestringNo

The account that is used to log on to the database. You can call the DescribeBackupPlanList operation to the account.

This parameter is required except that the database is an SQL Server database that is connected to DBS over a DBS backup gateway or a Redis database.

test
SourceEndpointPasswordstringNo

The password of the account that is used to connect to the database.

This parameter is required except that the database is an SQL Server database that is connected to DBS over a DBS backup gateway or a Redis database.

test
BackupGatewayIdlongNo

The ID of the backup gateway. You can call the DescribeBackupPlanList operation to obtain the ID of the backup gateway.

NoteThis parameter is required if the SourceEndpointInstanceType parameter is set to Agent.
21321323213
BackupObjectsstringNo

The objects to be backed up. This parameter is required except that the database is connected to DBS over a DBS backup gateway. You can call the DescribeBackupPlanList operation to obtain the objects to be backed up.

\[{ "DBName":"Name of the database to be backed up", "SchemaName":"Name of the schema to be backed up", "TableIncludes":\[{ "TableName":"Name of the table to be backed up" }], "TableExcludes":\[{"TableName":"Name of the table to be excluded during the backup" }] } ]
SourceEndpointOracleSIDstringNo

The SID of the Oracle source database. If the database is an Oracle database, this parameter is required.

test
CrossAliyunIdstringNo

The unique ID (UID) of the Alibaba Cloud account to which the backup schedule belongs. You can call the DescribeRestoreTaskList operation to obtain the UID.

2xxx7778xxxxxxxxxx
CrossRoleNamestringNo

The name of the RAM role that is used to perform backups across Alibaba Cloud accounts. You can call the DescribeRestoreTaskList operation to obtain the RAM role.

test123
ClientTokenstringNo

The client token that is used to ensure the idempotence of the request.

ETnLKlblzczshOTUbOCzxxxxxxx

Response parameters

ParameterTypeDescriptionExample
object
HttpStatusCodeinteger

The HTTP status code.

200
RequestIdstring

The ID of the request.

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

The error code.

Param.NotFound
Successboolean

Indicates whether the request is successful. Valid values:

  • true: The request is successful.
  • false: The request fails.
true
ErrMessagestring

The error message.

The specified parameter %s value is not valid.
BackupPlanIdstring

The ID of the backup schedule.

dbs1h****usfa
NeedPrecheckboolean

Indicates whether a precheck is triggered. If the value of this parameter is true, you must start the backup schedule by calling the StartBackupPlan operation.

false

Example

Normal return example

JSONFormat

{
  "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": true
}

Error codes

For a list of error codes, visit the API error center.