该接口用于修改数据库引擎迁移任务的配置或迁移参数,支持调整源库、目标库、迁移对象或迁移模式等设置。
接口说明
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。
调试
授权信息
|
操作 |
访问级别 |
资源类型 |
条件关键字 |
关联操作 |
|
polardbx:ModifyEngineMigration |
none |
*全部资源
|
无 | 无 |
请求参数
|
名称 |
类型 |
必填 |
描述 |
示例值 |
| RegionId |
string |
否 |
地域 ID。 |
cn-shanghai |
| DBInstanceName |
string |
否 |
实例 ID。 |
pxc-htri0****r4k9p |
| SourceDBInstanceName |
string |
否 |
源数据库实例名称。 |
source456 |
| NewMasterDBInstanceName |
string |
否 |
迁移完成后的新主实例名称。 |
newmaster789 |
| SwapConnectionString |
string |
否 |
是否自动交换连接字符串:
|
true |
| ConnectionStrings |
string |
否 |
需要切换的具体连接地址。取值为需要两两交换的地址对应的 JSON 串。 说明
当 SwapConnectionString 取值为 true 时生效。 |
{\"pc-bp1m9tt23o5kh834y.rwlb.rds.aliyuncs.com\":\"rm-bp1ycl5o6ojs957o0.mysql.rds.aliyuncs.com\"} |
返回参数
|
名称 |
类型 |
描述 |
示例值 |
|
object |
Schema of Response |
||
| RequestId |
string |
Id of the request |
C458B1E8-1683-3645-B154-6BA32080EEA |
| Code |
string |
接口返回 Code |
200 |
| Message |
string |
接口额外返回信息,成功返回 success,错误返回对应错误码。 |
Success |
| HttpStatusCode |
string |
请求状态码 |
200 |
| SuccessResponse |
string |
请求是否成功。 |
true |
| Data |
object |
返回结果。 |
|
| DBInstanceName |
string |
实例 Id |
pxc-********* |
| TaskId |
string |
任务 ID。 |
42292**** |
示例
正常返回示例
JSON格式
{
"RequestId": "C458B1E8-1683-3645-B154-6BA32080EEA",
"Code": "200",
"Message": "Success",
"HttpStatusCode": "200",
"SuccessResponse": "true",
"Data": {
"DBInstanceName": "pxc-*********",
"TaskId": "42292****"
}
}
错误码
访问错误中心查看更多错误码。
变更历史
更多信息,参考变更详情。