修改数据库备份源 - 数据库备份 DBS

调试

您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。

请求参数


名称	类型	是否必选	示例值	描述
Action	String	是	ModifyBackupSourceEndpoint	系统规定参数。取值：ModifyBackupSourceEndpoint。
BackupPlanId	String	是	dbs1h****usfa	备份计划ID，可通过调用DescribeBackupPlanList接口获取该参数的值。
SourceEndpointInstanceType	String	是	RDS	数据库所在位置，可通过调用DescribeBackupPlanList接口获取该参数的值。取值如下： RDS ECS Express：通过专线/VPN网关/智能网关接入的数据库 Agent：通过备份网关接入的数据库 DDS：云MongoDB Other：通过IP:Port直连的数据库
SourceEndpointRegion	String	否	cn-hangzhou	数据库地域，可通过调用DescribeBackupPlanList接口获取该参数的值。说明 SourceEndpointInstanceType为RDS、ECS、DDS、Express、Agent时，该参数必传。
SourceEndpointInstanceID	String	否	rm-bp1p8c29479jv****	数据库实例ID，可通过调用DescribeBackupPlanList接口获取该参数的值。说明 SourceEndpointInstanceType为RDS、ECS、DDS、Express时，该参数必传。
SourceEndpointIP	String	否	100...10:3306	数据库连接地址，可通过调用DescribeBackupPlanList接口获取该参数的值。说明 SourceEndpointInstanceType为Express、Agent、Other时该参数必传。
SourceEndpointPort	Integer	否	3306	数据库端口，可通过调用DescribeBackupPlanList接口获取该参数的值。说明 SourceEndpointInstanceType为Express、Agent、Other、ECS，该参数必传。
SourceEndpointDatabaseName	String	否	test	数据库名称。数据库类型为PostgreSQL、MongoDB时，该参数必传。数据库所在位置为Agent且数据库类型为MSSQL时，该参数必传。
SourceEndpointUserName	String	否	test	数据库账号，可通过调用DescribeBackupPlanList接口获取该参数的值。数据库类型为Redis，或者数据库所在位置为Agent且数据库类型为MSSQL时该参数非必须，其他场景均必传。
SourceEndpointPassword	String	否	test	密码。数据库类型为Redis，或者数据库所在位置为Agent且数据库类型为MSSQL时该参数非必须，其他场景均必传。
BackupGatewayId	Long	否	21321323213	备份网关ID，可通过调用DescribeBackupPlanList接口获取该参数的值。说明 SourceEndpointInstanceType为Agent时，该参数必传。
BackupObjects	String	否	[{ "DBName":"待备份库名", "SchemaName":"待备份 Schema 名", "TableIncludes":[{ "TableName":"待备份表表名" }], "TableExcludes":[{"TableName":"待备份库名不需要备份表的表名" }] } ]	备份对象，当数据库所在位置为Agent时，该参数非必须，其他场景均必传。可通过调用DescribeBackupPlanList接口获取该参数的值。
SourceEndpointOracleSID	String	否	test	Oracle SID名称，数据库类型为Oracle时，该参数必传。
CrossAliyunId	String	否	2xxx7778xxxxxxxxxx	跨阿里云账号备份的UID，可通过调用DescribeRestoreTaskList接口获取该参数的值。
CrossRoleName	String	否	test123	跨阿里云账号备份的RAM角色名称，可通过调用DescribeRestoreTaskList接口获取该参数的值。
RegionId	String	否	cn-hangzhou	地域ID，可通过调用DescribeRegions接口获取该参数的值。
ClientToken	String	否	ETnLKlblzczshOTUbOCzxxxxxxx	任意字符串，用于保证请求的幂等性，防止重复提交请求。

返回数据


名称	类型	示例值	描述
HttpStatusCode	Integer	200	HTTP状态码。
RequestId	String	D6E068C3-25BC-455A-85FE-45F0B22E****	请求ID。
ErrCode	String	Param.NotFound	错误码。
Success	Boolean	true	请求是否成功，返回值如下： true：请求成功 false：请求失败
ErrMessage	String	The specified parameter %s value is not valid.	错误信息。
BackupPlanId	String	dbs1h****usfa	备份计划ID。
NeedPrecheck	Boolean	false	本次修改是否会触发预检查，如果为true则需要再调用StartBackupPlan接口启动备份计划。

示例

请求示例

http(s)://dbs-api.cn-hangzhou.aliyuncs.com/?Action=ModifyBackupSourceEndpoint
&BackupPlanId=dbs1h****usfa
&SourceEndpointInstanceType=RDS
&<公共请求参数>

正常返回示例

XML格式

HTTP/1.1 200 OK
Content-Type:application/xml

<ModifyBackupSourceEndpointResponse>
    <RequestId>D6E068C3-25BC-455A-85FE-45F0B22E****</RequestId>
    <HttpStatusCode>200</HttpStatusCode>
    <BackupPlanId>dbs1h****usfa</BackupPlanId>
    <NeedPrecheck>false</NeedPrecheck>
    <Success>true</Success>
</ModifyBackupSourceEndpointResponse>

JSON格式

HTTP/1.1 200 OK
Content-Type:application/json

{
  "RequestId" : "D6E068C3-25BC-455A-85FE-45F0B22E****",
  "HttpStatusCode" : 200,
  "BackupPlanId" : "dbs1h****usfa",
  "NeedPrecheck" : false,
  "Success" : true
}

错误码

访问错误中心查看更多错误码。