Call ModifyBackupSourceEndpoint to Update Backup Source - Data Management - Alibaba Cloud - Data Management

Modifies 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

Request parameters

Parameter	Type	Required	Description	Example
BackupPlanId	string	Yes	The backup plan ID. Call DescribeBackupPlanList to get this value.	dbs1h****usfa
SourceEndpointInstanceType	string	Yes	The location of the database. Call DescribeBackupPlanList to get this value. Valid values: RDS ECS Express: A database connected through a leased line, VPN Gateway, or Smart Access Gateway Agent: A database connected through a backup gateway DDS: A MongoDB instance on Alibaba Cloud Other: A database connected directly using an IP address and port	RDS
SourceEndpointRegion	string	No	The region where the database is located. Call DescribeBackupPlanList to get this value. Note You must specify this parameter when SourceEndpointInstanceType is RDS, ECS, DDS, Express, or Agent.	cn-hangzhou
SourceEndpointInstanceID	string	No	The database instance ID. Call DescribeBackupPlanList to get this value. Note You must specify this parameter when SourceEndpointInstanceType is RDS, ECS, DDS, or Express.	rm-bp1p8c29479jv****
SourceEndpointIP	string	No	The database endpoint. Call DescribeBackupPlanList to get this value. Note You must specify this parameter when SourceEndpointInstanceType is Express, Agent, or Other.	100...10:3306
SourceEndpointPort	integer	No	The database port. Call DescribeBackupPlanList to get this value. Note You must specify this parameter when SourceEndpointInstanceType is Express, Agent, Other, or ECS.	3306
SourceEndpointDatabaseName	string	No	The database name. You must specify this parameter for PostgreSQL or MongoDB databases. You must specify this parameter for Microsoft SQL Server databases connected through a backup gateway.	test
SourceEndpointUserName	string	No	The database account. Call DescribeBackupPlanList to get this value. This parameter is optional for Redis databases or for Microsoft SQL Server databases connected through a backup gateway. For all other cases, you must specify it.	test
SourceEndpointPassword	string	No	The password. This parameter is optional for Redis databases or for Microsoft SQL Server databases connected through a backup gateway. For all other cases, you must specify it.	test
BackupGatewayId	integer	No	The backup gateway ID. Call DescribeBackupPlanList to get this value. Note You must specify this parameter when SourceEndpointInstanceType is Agent.	21321323213
BackupObjects	string	No	The backup objects. This parameter is optional when SourceEndpointInstanceType is Agent. For all other cases, you must specify it. Call DescribeBackupPlanList to get this value.	[{ "DBName":"database_name", "SchemaName":"schema_name", "TableIncludes":[{ "TableName":"table_name" }], "TableExcludes":[{"TableName":"excluded_table_name" }] } ]
SourceEndpointOracleSID	string	No	The Oracle system ID (SID). You must specify this parameter for Oracle databases.	test
CrossAliyunId	string	No	The UID of the Alibaba Cloud account used for cross-account backup. Call DescribeRestoreTaskList to get this value.	2xxx7778xxxxxxxxxx
CrossRoleName	string	No	The RAM role name used for cross-account backup. Call DescribeRestoreTaskList to get this value.	test123
ClientToken	string	No	A unique string that ensures idempotence and prevents duplicate requests.	ETnLKlblzczshOTUbOCzxxxxxxx
EnableSourceEndpointSsl	string	No		true
SslCaPem	string	No		-----BEGIN CERTIFICATE----- ... -----END CERTIFICATE-----
SourceEndpointOracleHome	string	No		/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 succeeded. Valid values: true: The request succeeded. 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 this change triggers a precheck. If this value is true, call StartBackupPlan to restart 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.