You need to enable JavaScript to run this app.
导航
云数据库 PostgreSQL 版
  • 文档首页
    • /
  • 云数据库 PostgreSQL 版

ModifyDBInstanceSpec

最近更新时间：2023.12.14 10:51:50

首次发布时间：2023.11.15 22:39:52

我的收藏

调用 ModifyDBInstanceSpec 接口修改实例配置。

请求类型

异步请求。

请求参数

名称类型是否必选示例值描述
InstanceIdString是postgres-21a3333b****实例 ID。

NodeInfo

Array of NodeInfoObject

否

请参见请求示例。

实例规格配置。Primary 节点有且只有 1 个，Secondary 节点有且只有 1 个，Read-Only 节点可选 0~10 个。关于 NodeInfo 的更多详情，请参见数据结构。

说明

该参数与 StorageSpace 二者必选其一，且这两个参数可同时修改。

ModifyType

String

否

Temporary

变配方式。取值为：

  • Usually：常规变配，即立即变配。默认值。
  • Temporary：弹性升配，即临时升配。

RollbackTime

String

否

2023-12-16T03:59:10.000Z

还原时间，时间格式为 yyyy-MM-ddTHH:mm:ss.sssZ（UTC 时间）。

说明

  • 当 ModifyType 取值为 Temporary 时生效。
  • 设置的还原时间的时间点与调用接口的时间点相差应不超过 2 分钟，实际的还原时间的时间点以调用接口的时间点为准。
  • 可多次发起临时升配延长临时升配期，但总时长不能超过 30 天（以第一次发起临时升配的时间为准）。
  • 可多次发起临时升配，但不允许缩短临时升配期。如实例已处于临时升配期：
    • 新的还原时间不能早于已生效的还原时间。
    • 距离包年包月实例的到期时间不足五天时，不允许再次发起临时升配。

StorageType

String

否

LocalSSD

实例存储类型。取值固定为 LocalSSD（本地 SSD 盘）。

说明

  • 该参数与 NodeInfo 二者必选其一，且这两个参数可同时修改。
  • 当 ModifyType 取值为 Temporary 时，不支持设置该参数。

StorageSpace

Integer

否

100

实例存储空间。取值范围为 [20, 3000]，单位为 GB，步长为 10GB。

说明

该参数与 NodeInfo 二者必选其一，且这两个参数可同时修改。

  • 当 ModifyType 取值为 Temporary 时，不支持设置该参数。

返回参数

名称类型示例值描述
InstanceIdStringpostgres-21a3333b****实例 ID。
OrderIdStringOrder725743560891294****订单 ID。

请求示例

  • 常规升配示例（增加一个只读节点）

    POST /?Action=ModifyDBInstanceSpec&Version=2022-01-01 HTTP/1.1
Content-Type: application/json
Host: rds.volcengineapi.com
X-Date: 20231002T101010Z
Authorization: HMAC-SHA256 Credential=AKLTN2I0MmFiNzMxNWE5NDgzMzk4MmVjMTVkODlkZTZ****/20211202/cn-beijing/rds_postgresql/request,SignedHeaders=x-date, Signature=71d31fc7bcf990142851c9833c5656391486cda0ae2e0b8ada733b7c6458****
{
        "InstanceId": "postgres-ca7b7019****",
        "StorageType": "LocalSSD",
        "StorageSpace": 60,
        "NodeInfo": [{
                "NodeId": "postgres-ca7b7019****",
                "ZoneId": "cn-beijing-a",
                "NodeSpec": "rds.postgres.1c2g",
                "NodeType": "Primary"
        }, {
                "NodeId": "postgres-ca7b7019****-wmjy",
                "ZoneId": "cn-beijing-a",
                "NodeSpec": "rds.postgres.1c2g",
                "NodeType": "Secondary"
        }, {
                "ZoneId": "cn-beijing-a",
                "NodeSpec": "rds.postgres.1c2g",
                "NodeType": "ReadOnly",
                "NodeOperateType": "Create"
        }]
}

  • 临时升配示例（升级主备节点规格）

    POST /?Action=ModifyDBInstanceSpec&Version=2022-01-01 HTTP/1.1
Content-Type: application/json
Host: rds.volcengineapi.com
X-Date: 20231002T101010Z
Authorization: HMAC-SHA256 Credential=AKLTN2I0MmFiNzMxNWE5NDgzMzk4MmVjMTVkODlkZTZ****/20211202/cn-beijing/rds_postgresql/request,SignedHeaders=x-date, Signature=71d31fc7bcf990142851c9833c5656391486cda0ae2e0b8ada733b7c6458****
{
        "InstanceId": "postgres-ca7b7019****",
        "NodeInfo": [{
                "NodeId": "postgres-ca7b7019****",
                "ZoneId": "cn-beijing-a",
                "NodeSpec": "rds.postgres.2c4g",
                "NodeType": "Primary",
                "NodeOperateType":"Modify"
        }, {
                "NodeId": "postgres-ca7b7019****-wmjy",
                "ZoneId": "cn-beijing-a",
                "NodeSpec": "rds.postgres.2c4g",
                "NodeType": "Secondary",
                "NodeOperateType":"Modify
        }],
        "ModifyType":"Temporary",
        "RollbackTime":"2023-12-16T03:59:10.000Z"
}

返回示例

正常返回示例

{
    "ResponseMetadata": {
        "RequestId": "202308011557433BA18653C86F63A04B1B",
        "Action": "ModifyDBInstanceSpec",
        "Version": "2022-01-01",
        "Service": "rds_postgresql",
        "Region": "cn-beijing"
    },
    "Result": {
        "InstanceId": "postgres-21a3333b****",
        "OrderId": "Order725743560891294****"
    }
}