ModifyDBInstanceSpec--云数据库 PostgreSQL 版-火山引擎

文档中心

立即注册

导航

ModifyDBInstanceSpec

最近更新时间：2025.10.14 14:43:14首次发布时间：2023.11.15 22:39:52

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

请求类型

异步请求。

调试

API Explorer

您可以通过 API Explorer 在线发起调用，无需关注签名生成过程，快速获取调用结果。

去调试

请求参数

参数	类型	是否必选	示例值	描述
InstanceId	String	是	postgres-21a3333b****	实例 ID。
NodeInfo	Object[]	否	请参见请求示例。	实例规格配置。Primary 节点有且只有 1 个，Secondary 节点有且只有 1 个，Read-Only 节点可选 0~10 个。说明该参数与 `StorageSpace` 二者必选其一，且这两个参数可同时修改。只需在该参数中传入变配涉及的节点。
ModifyType	String	否	Temporary	变配方式。取值为： `Usually`：常规变配，即立即变配。默认值。 `Temporary`：弹性升配，即临时升配。说明仅当实例的计费类型为包年包月实例时，支持为该参数取值为 `Temporary`。可通过调用 DescribeDBInstanceDetail 接口查询实例的计费类型。
RollbackTime	String	否	2023-12-16T03:59:10.000Z	还原时间，时间格式为 `yyyy-MM-ddTHH:mm:ss.sssZ`（UTC 时间）。说明当 ModifyType 取值为 `Temporary` 时，该参数为必选。该参数仅在 ModifyType 取值为 `Temporary` 时生效。设置的还原时间的时间点与调用接口的时间点相差应不超过 2 分钟，实际的还原时间的时间点以调用接口的时间点为准。可多次发起临时升配延长临时升配期，但总时长不能超过 30 天（以第一次发起临时升配的时间为准）。可多次发起临时升配，但不允许缩短临时升配期。如实例已处于临时升配期：新的还原时间不能早于已生效的还原时间。距离包年包月实例的到期时间不足五天时，不允许再次发起临时升配。
StorageType	String	否	LocalSSD	实例存储类型。取固定值 `LocalSSD`（本地 SSD 盘）。说明该参数与 `NodeInfo` 二者必选其一，且这两个参数可同时修改。当 ModifyType 取值为 `Temporary` 时，不支持设置该参数。
StorageSpace	Integer	否	100	实例存储空间。取值范围为 [20, 3000]，单位为 GB，步长为 10GB。说明该参数与 `NodeInfo` 二者必选其一，且这两个参数可同时修改。当 ModifyType 取值为 `Temporary` 时，不支持设置该参数。
EstimateOnly	Boolean	否	true	是否发起变配评估。取值： `true`：是。 `false`：否。默认值。说明如果发起，则按照其他字段确定的规格配置进行变配评估，实际不会执行变配动作。发起变配评估后，会返回 EstimationResult 参数，说明此次变配的影响。

返回参数

参数	类型	示例值	描述
InstanceId	String	postgres-21a3333b****	实例 ID。
OrderId	String	Order725743560891294****	订单 ID。说明当 EstimateOnly 取值为 `true` 时，该字段的返回值为空。
EstimationResult	Object	请参见返回示例。	按照当前配置变更后，预估会对实例产生的影响。说明当 EstimateOnly 取值为 `false` 或不为 EstimateOnly 传值时，不返回该字段。

示例

请求示例 1

常规变配

POST /?Action=ModifyDBInstanceSpec&Version=2022-01-01 HTTP/1.1
Content-Type: application/json
Host: rds-postgresql.cn-beijing.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"
        }
    ]
}

返回示例 1

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

请求示例 2

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

POST /?Action=ModifyDBInstanceSpec&Version=2022-01-01 HTTP/1.1
Content-Type: application/json
Host: rds-postgresql.cn-beijing.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"
}

返回示例 2

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

请求示例 3

变配影响预估

POST /?Action=ModifyDBInstanceSpec&Version=2022-01-01 HTTP/1.1
Content-Type: application/json
Host: rds-postgresql.cn-beijing.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"
        }
    ],
    "EstimateOnly": true
}

返回示例 3

{
    "ResponseMetadata": {
        "RequestId": "202510101646419FA4685B4AC9EDAF4B05-85d668",
        "Action": "ModifyDBInstanceSpec",
        "Version": "2022-01-01",
        "Service": "rds_postgresql",
        "Region": "cn-beijing"
    },
    "Result": {
        "EstimationResult": {
            "Effects": [
                "ReadWriteConnectionTransientError"
            ],
            "Plans": [
                "AddNode"
            ]
        },
        "InstanceId": "postgres-36cd1f06e9f3",
        "OrderId": ""
    }
}