该接口用于发起RDS PostgreSQL实例大版本升级任务。
接口说明
适用引擎
RDS PostgreSQL
相关功能文档
该API操作涉及费用，请仔细阅读相关功能文档，确保完全了解使用接口产生的费用、前提条件及使用后造成的影响后，再进行操作。
RDS PostgreSQL升级数据库大版本
调试
您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI
Explorer可以自动生成SDK代码示例。
调试
调试
授权信息
下表是API对应的授权信息，可以在RAM权限策略语句的Action元素中使用，用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下：
- 操作：是指具体的权限点。
- 访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。
- 资源类型：是指操作中支持授权的资源类型。具体说明如下：
- 对于必选的资源类型，用背景高亮的方式表示。
- 对于不支持资源级授权的操作，用
全部资源表示。
- 条件关键字：是指云产品自身定义的条件关键字。
- 关联操作：是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限，操作才能成功。
| 操作 | 访问级别 | 资源类型 | 条件关键字 | 关联操作 |
|---|---|---|---|---|
| rds:UpgradeDBInstanceMajorVersion | Write |
|
|
无 |
请求参数
| 名称 | 类型 | 必填 | 描述 | 示例值 |
|---|---|---|---|---|
| DBInstanceClass | string | 否 |
升级后实例规格。CPU和内存配置必须大于等于原实例规格。 例如，原实例规格 说明 | pg.n2.medium.2c |
| DBInstanceStorage | integer | 否 | 升级后实例存储空间。 单位：GB 取值范围：
说明 | 20 |
| PayType | string | 是 | 计费方式。固定配置为按量付费，取值Postpaid。 说明 | Postpaid |
| InstanceNetworkType | string | 否 | 升级后实例网络类型。固定配置为VPC，当前只支持专有网络实例进行大版本升级。 如果网络类型为经典网络，请先切换为专有网络。关于如何查看或切换网络类型，请参见切换网络类型。 |
VPC |
| SwitchTimeMode | string | 否 |
该参数与SwitchOver配合使用，只有SwitchOver参数取值为true时有效。表示割接时间。 取值范围：
|
Immediate |
| SwitchTime | string | 否 |
预留参数，无需配置。 |
2021-07-10T13:15:12Z |
| SwitchOver | string | 否 |
割接配置，系统将创建一个新实例进行数据迁移。请选择迁移后是否自动切换至新实例。 取值范围：
说明
|
false |
| CollectStatMode | string | 否 |
选择在哪个时间点对数据库执行统计信息收集。
说明 | After |
| TargetMajorVersion | string | 否 | 升级后实例目标大版本。必须与执行升级前检查时设置的目标版本一致。 说明 | 13.0 |
| DBInstanceId | string | 否 | 原实例ID。 |
pgm-bp1gm3yh0ht1**** |
| VPCId | string | 否 |
VPC ID。可以通过DescribeDBInstanceAttribute接口查看原实例的VPC ID。 |
vpc-bp1opxu1zkhn00gzv**** |
| VSwitchId | string | 否 |
说明 | vsw-bp10aqj6o4lclxdrm****,vsw-bp10aqj6o4lclxdrm**** |
| PrivateIpAddress | string | 否 | 无需配置，表示目标实例的内网IP。系统默认通过VPCId和vSwitchId自动分配。 |
172.16.XX.XX |
| UsedTime | string | 否 |
预留参数，无需配置。 |
1 |
| Period | string | 否 |
预留参数，无需配置。 |
Month |
| DBInstanceStorageType | string | 否 |
表示升级后实例的存储类型。 取值范围：
版本升级功能基于云盘快照，当前升级后支持选择的存储类型如下。
|
cloud_essd |
| ZoneId | string | 否 |
目标主可用区ID。可以通过DescribeRegions接口查看可用区ID。 RDS PostgreSQL支持升级后将新的实例配置到与原实例同一地域的其他可用区。 |
cn-hangzhou-h |
| ZoneIdSlave1 | string | 否 |
仅当原实例为高可用系列时，该参数可配置，表示目标实例备可用区ID。 RDS PostgreSQL支持升级后将新的备实例配置到与原实例同一地域的其他可用区。 可以通过DescribeRegions接口查看可用区ID。 |
cn-hangzhou-h |
| ZoneIdSlave2 | string | 否 |
预留参数，无需配置。 |
cn-hangzhou-h |
返回参数
| 名称 | 类型 | 描述 | 示例值 |
|---|---|---|---|
| object |
返回参数详情。 |
||
| DBInstanceId | string |
实例ID。 |
pgm-bp1gm3yh0ht1**** |
| RequestId | string |
请求ID。 |
006729E5-2A33-5955-89E3-651D3F44EBE6 |
| OrderId | string |
订单ID。 |
21128667463**** |
| TaskId | long |
预留参数。 |
416980000 |
示例
正常返回示例
JSON格式
{
"DBInstanceId": "pgm-bp1gm3yh0ht1****",
"RequestId": "006729E5-2A33-5955-89E3-651D3F44EBE6",
"OrderId": "21128667463****",
"TaskId": 416980000
}错误码
| HTTP status code | 错误码 | 错误信息 | 描述 |
|---|---|---|---|
| 400 | InvalidUpgradePrecheckResult | The upgrade precheck failed. No successful precheck task found in the past 7 days | 升级前置检查失败，无七天内预检查成功任务 |
| 400 | TargetEngineVersion.Parameters.NotFound | targetEngineVersion is missing in the request. | 请求缺少目标数据库版本参数 |
| 400 | InvalidDBInstanceStorageType | The specified DBInstanceStorageType is invalid. | 指定的数据库实例存储类型无效 |
| 400 | InvalidInstanceNetworkType | The specified InstanceNetworkType is invalid. | 指定的实例网络类型无效 |
| 400 | InvalidVPCId | The specified VPCId is invalid. | 指定的虚拟专有网络无效 |
| 400 | InvalidDedicatedHostGroupId | The specified DedicatedHostGroupId is invalid. | 指定的专用主机组ID无效 |
| 400 | InvalidPayType | The specified PayType is invalid. | 指定的付款类型无效 |
| 400 | InvalidEngineVersion | The specified EngineVersion is invalid. | 指定的数据库版本号无效 |
| 400 | InvalidDBInstanceStorage | The specified DBInstanceStorage is invalid. | 指定的数据库实例存储无效 |
| 400 | InvalidSwitchOver | The specified SwitchOver is invalid. | 指定的割接模式无效 |
| 400 | PrimaryInstanceWithReadonlyNotSupport | The specified primary instance with the read-only instance does not support the operation. | 具有只读实例的指定主实例不支持此操作 |
| 400 | InvalidSwitchTimeMode | The specified SwitchTimeMode is invalid. | 指定的升级时间模式无效 |
| 400 | InvalidSwitchTime | The specified SwitchTime is invalid. | 指定的割接时间无效 |
| 400 | InvalidCollectStats | The specified CollectStats is invalid. | 指定的统计信息收集模式无效 |
| 400 | IncorrectDBInstanceState | The current instance state does not support this operation. | 当前实例状态不支持此操作。 |
| 400 | InvalidDBinstanceClass.ValueNotSupported | The specified parameter DBinstanceClass is invalid. | 指定的参数“实例规格”无效 |
| 404 | InvalidDBInstanceName.NotFound | The database instance does not exist. | 数据库实例名称不存在。请确认数据名称是否正确。 |
| 404 | IncorrectDBInstanceLockMode | Current DB instance lock mode does not support this operation. | 操作失败，实例处于锁定状态。 |
访问错误中心查看更多错误码。
变更历史
| 变更时间 | 变更内容概要 | 操作 |
|---|
暂无变更历史
内容没看懂？ 不太想学习？想快速解决？ 有偿解决： 联系专家
阿里云企业补贴进行中： 马上申请
腾讯云限时活动1折起，即将结束： 马上收藏
同尘科技为腾讯云授权服务中心。
购买腾讯云产品享受折上折，更有现金返利:同意关联，立享优惠
转转请注明出处：https://www.yunxiaoer.com/154069.html