调用ModifyBackupSourceEndpoint接口,修改数据库备份源。
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。
请求参数
名称 | 类型 | 是否必选 | 示例值 | 描述 |
---|---|---|---|---|
Action | String | 是 | ModifyBackupSourceEndpoint |
系统规定参数,取值:ModifyBackupSourceEndpoint。 |
BackupPlanId | String | 是 | dbs1h****usfa |
备份计划ID。 |
SourceEndpointInstanceType | String | 是 | RDS |
数据库所在位置,取值:
|
SourceEndpointRegion | String | 否 | cn-hangzhou |
数据库地域,SourceEndpoint.InstanceType为RDS、ECS、DDS、Express、Agent时,该参数必传。 |
SourceEndpointInstanceID | String | 否 | rm-bp1p8c29479jvXXXX |
数据库实例ID,SourceEndpoint.InstanceType为RDS、ECS、DDS、Express时,该参数必传。 |
SourceEndpointIP | String | 否 | 100.*.*.10:33204 |
数据库连接地址,SourceEndpoint.InstanceType为express、agent、other,该参数必传。 |
SourceEndpointPort | Integer | 否 | 3306 |
数据库端口,SourceEndpoint.InstanceType为express、agent、other、ECS,该参数必传。 |
SourceEndpointDatabaseName | String | 否 | test |
数据库名称,数据库类型为PostgreSQL、MongoDB时,该参数必传;数据库所在位置为agent且数据库类型为MSSQL时,该参数必传。 |
SourceEndpointUserName | String | 否 | test |
数据库账号,数据库类型为Redis,或者数据库所在位置为agent且数据库类型为MSSQL时该参数非必须,其他场景均必传。 |
SourceEndpointPassword | String | 否 | test |
密码,数据库类型为Redis,或者数据库所在位置为agent且数据库类型为MSSQL时该参数非必须,其他场景均必传。 |
BackupGatewayId | Long | 否 | 21321323213 |
备份网关ID,SourceEndpoint.InstanceType为agent时,该参数必传。 |
BackupObjects | String | 否 | [{ "DBName":"待备份库名", "SchemaName":"待备份 Schema 名", "TableIncludes":[{ "TableName":"待备份表表名" }], "TableExcludes":[{"TableName":"待备份库名不需要备份表的表名" }] } ] |
备份对象,当数据库所在位置为agent时,该参数非必须,其他场景均必传。 |
SourceEndpointOracleSID | String | 否 | test |
Oracle SID名称,数据库类型为Oracle时,该参数必传。 |
RegionId | String | 否 | cn-hangzhou |
地域ID,调用DescribeRegions接口查看DBS支持地域。 |
ClientToken | String | 否 | ETnLKlblzczshOTUbOCzxxxxxxx |
用于保证请求的幂等性,防止重复提交请求。 |
返回数据
名称 | 类型 | 示例值 | 描述 |
---|---|---|---|
BackupPlanId | String | dbs1h****usfa |
备份计划ID。 |
ErrCode | String | Param.NotFound |
错误码。 |
ErrMessage | String | The specified parameter %s value is not valid. |
错误信息。 |
HttpStatusCode | Integer | 200 |
HTTP状态码。 |
NeedPrecheck | Boolean | false |
本次修改是否会触发预检查,如果为true则需要再调用StartBackupPlan接口启动备份计划。 |
RequestId | String | D6E068C3-25BC-455A-85FE-45F0B22ECB1F |
请求ID。 |
Success | Boolean | true |
是否成功。 |
示例
请求示例
http(s)://dbs-api.cn-hangzhou.aliyuncs.com/?Action=ModifyBackupSourceEndpoint
&BackupPlanId=dbs1h****usfa
&SourceEndpointInstanceType=rds
&<公共请求参数>
正常返回示例
XML
格式
<ModifyBackupSourceEndpointReponse>
<RequestId>D6E068C3-25BC-455A-85FE-45F0B22ECB1F</RequestId>
<HttpStatusCode>200</HttpStatusCode>
<BackupPlanId>dbs1h****usfa</BackupPlanId>
<NeedPrecheck>false</NeedPrecheck>
<Success>true</Success>
</ModifyBackupSourceEndpointReponse>
JSON
格式
{
"RequestId": "D6E068C3-25BC-455A-85FE-45F0B22ECB1F",
"HttpStatusCode": 200,
"BackupPlanId": "dbs1h****usfa",
"NeedPrecheck": false,
"Success": true
}
错误码
访问错误中心查看更多错误码。
在文档使用中是否遇到以下问题
更多建议
匿名提交