切换或回滚RDS一键升级到PolarDB的迁移任务。
接口说明
- 在切换前调用该接口会进行切换。
- 在切换完成后调用该接口会进行回滚。
说明
调用该接口时，集群必须已经创建了一键升级任务。创建一键升级任务的接口为 CreateDBCluster ，参数 CreationOption 取值需为 MigrationFromRDS。更多信息，请参见一键升级 RDS MySQL 到 PolarDB MySQL 版。
调试
您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。
授权信息
下表是API对应的授权信息，可以在RAM权限策略语句的Action元素中使用，用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下：
- 操作：是指具体的权限点。
- 访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。
- 资源类型：是指操作中支持授权的资源类型。具体说明如下：
- 对于必选的资源类型，用前面加 * 表示。
- 对于不支持资源级授权的操作，用
全部资源表示。
- 条件关键字：是指云产品自身定义的条件关键字。
- 关联操作：是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限，操作才能成功。
| 操作 | 访问级别 | 资源类型 | 条件关键字 | 关联操作 |
|---|---|---|---|---|
| polardb:ModifyDBClusterMigration | update | *dbcluster acs:polardb:{#regionId}:{#accountId}:dbcluster/{#dbclusterId} |
| 无 |
请求参数
| 名称 | 类型 | 必填 | 描述 | 示例值 |
|---|---|---|---|---|
| DBClusterId | string | 是 | PolarDB 集群 ID。 | pc-************** |
| SourceRDSDBInstanceId | string | 是 | 源 RDS 实例 ID。 | rm-************ |
| NewMasterInstanceId | string | 是 | 新的实例 ID 或集群 ID，取值范围如下：
| pc-************** |
| SwapConnectionString | string | 否 | 是否需要切换连接地址，取值：
默认为 false。 | false |
| ConnectionStrings | string | 否 | 需要切换的具体连接地址。取值为需要两两交换的地址对应的 JSON 串。 说明
当 SwapConnectionString 取值为 true 时生效。
| {"rm-2ze73el581cs*****.mysql.pre.rds.aliyuncs.com":"pc-2ze8200s298e*****.mysql.polardb.pre.rds.aliyuncs.com","rm-2ze73el581cs86*****.mysql.pre.rds.aliyuncs.com":"test-p*****.mysql.polardb.pre.rds.aliyuncs.com"} |
返回参数
示例
正常返回示例
JSON格式
{
"RequestId": "A1B303A5-653F-4AEE-A598-023FF9******"
}错误码
| HTTP status code | 错误码 | 错误信息 | 描述 |
|---|---|---|---|
| 400 | InvalidConnectionString.Malformed | The specified parameter ConnectionString is not valid. | 指定的参数ConnectionString无效。 |
| 404 | InvalidDBCluster.NotFound | The DBClusterId provided does not exist in our records. | 当前的记录中不存在提供的DBClusterId。 |
| 404 | InvalidDBClusterId.NotFound | The DBInstanceId provided does not exist in our records. | 当前的记录中不存在提供的DBClusterId。 |
访问错误中心查看更多错误码。
变更历史
| 变更时间 | 变更内容概要 | 操作 |
|---|---|---|
| 2023-09-12 | OpenAPI 错误码发生变更 | 查看变更详情 |
| 2022-07-27 | OpenAPI 错误码发生变更、OpenAPI 入参发生变更 | 查看变更详情 |