升级后付费实例
最近更新时间: 2024-09-03 18:49:57
1. 接口描述
接口请求域名： dcdb.api3.cloud.sunhongs.com。
本接口（UpgradeHourDCDBInstance）用于升级后付费分布式数据库实例。
默认接口请求频率限制：20次/秒。
接口更新时间：2023-07-13 11:54:59。
接口只验签名不鉴权。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数，完整公共参数列表见公共请求参数。
| 参数名称 | 必选 | 允许NULL | 类型 | 描述 |
|---|---|---|---|---|
| Action | 是 | 否 | String | 公共参数，本接口取值：UpgradeHourDCDBInstance |
| Version | 是 | 否 | String | 公共参数，本接口取值：2018-04-11 |
| Region | 是 | 否 | String | 公共参数，详见产品支持的地域列表(TODO) |
| InstanceId | 是 | 否 | String | 待升级的实例ID。形如：dcdbt-ow728lmc，可以通过 DescribeDCDBInstances 查询实例详情获得。 |
| UpgradeType | 是 | 否 | String | 升级类型，取值范围: <br><li> ADD: 新增分片 </li> <br> <li> EXPAND: 升级实例中的已有分片 </li> <br> <li> SPLIT: 将已有分片中的数据切分到新增分片上</li> |
| AddShardConfig | 否 | 否 | AddShardConfig | 新增分片配置，当UpgradeType为ADD时生效。 |
| ExpandShardConfig | 否 | 否 | ExpandShardConfig | 扩容分片配置，当UpgradeType为EXPAND时生效。 |
| SplitShardConfig | 否 | 否 | SplitShardConfig | 切分分片配置，当UpgradeType为SPLIT时生效。 |
| SwitchStartTime | 否 | 否 | Datetime | 切换开始时间，格式如: "2019-12-12 07:00:00"。开始时间必须在当前时间一个小时以后，3天以内。 |
| SwitchEndTime | 否 | 否 | Datetime | 切换结束时间, 格式如: "2019-12-12 07:15:00"，结束时间必须大于开始时间。 |
| SwitchAutoRetry | 否 | 否 | Int64 | 是否自动重试。 0：不自动重试 1：自动重试 |
| Zones | 否 | 否 | Array of String | 用于变更部署，变更配置传空 |
3. 输出参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
| RequestId | String | 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。 |
4. 错误码
以下仅列出了接口业务逻辑相关的错误码，其他错误码详见公共错误码。
| 错误码 | 描述 |
|---|---|
| FailedOperation.CreateOrderFailed | |
| InternalError.CreateFlowError | |
| InternalError.DbOperationFailed | |
| InternalError.OperateDatabaseFailed | |
| InvalidParameter | |
| InvalidParameter.InstanceNotFound | |
| InvalidParameter.SpecNotFound | |
| InvalidParameterValue.ShardNotExist | |
| InvalidParameterValue.SpecIdIllegal | |
| ResourceNotFound.NoInstanceFound | |
| ResourceUnavailable.InstanceStatusAbnormal |