All Products
Search
Document Center

ModifyBackupSourceEndpoint

Last Updated: Mar 27, 2020

Description

You can call this operation to modify a backup source.

Request parameters

Parameter Type Required Description
Action String Yes The operation that you want to perform. Set the value to ModifyBackupSourceEndpoint.
BackupPlanId String Yes The ID of the backup schedule.
SourceEndpointInstanceType String Yes The location of the database. Valid values:
  • rds
  • ecs
  • express: for databases connected to Alibaba Cloud through Express Connect, VPN Gateway, or Smart Access Gateway.
  • agent: for databases connected to Alibaba Cloud through a backup gateway.
  • dds: for ApsaraDB for MongoDB databases.
  • other: for databases connected to Alibaba Cloud through IP addresses and port numbers.
SourceEndpointRegion String No The region of the database. This parameter is required if the value of the SourceEndpointInstanceType parameter is rds, ecs, dds, express, or agent.
SourceEndpointInstanceID String No The ID of the database instance. This parameter is required if the value of the SourceEndpointInstanceType parameter is rds, ecs, dds, or express.
SourceEndpointIP String No The connection endpoint of the database. This parameter is required if the value of the SourceEndpointInstanceType parameter is express, agent, or other.
SourceEndpointPort Integer No The port number of the database. This parameter is required if the value of the SourceEndpointInstanceType parameter is express, agent, other, or ecs.
SourceEndpointDatabaseName String No The name of the database. This parameter is required for PostgreSQL databases, MongoDB databases, and agent-based MSSQL databases.
SourceEndpointUserName String No The username for logging on to the database. This parameter is required for most databases, except for Redis databases and agent-based MSSQL databases.
SourceEndpointPassword String No The password for logging on to the database. This parameter is required for most databases, except for Redis databases and agent-based MSSQL databases.
BackupGatewayId Long No The ID of the backup gateway. This parameter is required if the value of the SourceEndpointInstanceType parameter is agent.
BackupObjects String No The objects to be backed up. For more information, see the description of the BackupObjects parameter. This parameter is required for most databases, except for agent-based databases.
SourceEndpointOracleSID String No The system ID (SID) of the Oracle database. This parameter is required for Oracle databases.

Response parameters

Parameter Type Description
BackupPlanId String The ID of the backup schedule.
NeedPrecheck Boolean Indicates whether the modification triggered precheck. If the value is true, you need to call the StartBackupPlan operation to start the backup schedule.

Error codes

Error code Error message Description
BackupPlanNotModify modify backup source endpoint fail. The error message returned because the backup source failed to be modified.