ModifyDBNodeTemporarySpec--云数据库 MySQL 版-火山引擎

文档中心

立即注册

导航

ModifyDBNodeTemporarySpec

最近更新时间：2025.01.22 12:04:50首次发布时间：2025.01.22 12:04:50

调用 ModifyDBNodeTemporarySpec 接口为实例进行临时升配。

请求类型

异步请求。

调试

API Explorer

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

去调试

请求参数

参数	类型	是否必选	示例值	描述
InstanceId	String	是	mysql-db6d920e****	实例 ID。
NodeInfo	Object[]	是	请参见请求示例。	实例的节点变配信息。
RollbackTime	String	是	2024-10-16T03:59:10.000Z	临时升配的还原时间。还原时间可设置在当前时间之后 5 天到 30 天之间的任意时间。时间格式为 `yyyy-MM-ddTHH:mm:ss.sssZ`（UTC 时间）。
SwitchType	String	否	MaintainTime	执行时间，取值： `Immediate`：立即切换（默认）。 `MaintainTime`：可维护时间段内进行切换。 `SpecifiedTime`：指定时间段内进行切换。说明取值为 `SpecifiedTime` 时，需要在参数 SpecifiedSwitchStartTime 和 SpecifiedSwitchEndTime 中设定时间段的起止时间。
RequestSource	String	否	EventType_Web	请求来源。取值： `EventType_Web`：来自 Web。 `EventType_OpenAPI`：来自 Open API。
EstimateOnly	Boolean	否	true	是否发起变配评估。取值： `true`：是。 `false`：否。默认值。说明如果发起，则按照其他字段确定的规格配置进行变配评估，实际不会执行变配动作。发起变配评估后，会返回 EstimationResult 参数，说明此次变配的影响。
SpecifiedSwitchStartTime	String	否	2024-12-25T14:00:00Z	指定时间段执行时时间段的起始时间。时间格式为 `yyyy-MM-ddTHH:mm:ssZ`。说明 SwitchType 取值为 `SpecifiedTime` 时，该参数为必填参数。
SpecifiedSwitchEndTime	String	否	2024-12-25T15:59:00Z	指定时间段执行时时间段的结束时间。时间格式为 `yyyy-MM-ddTHH:mm:ssZ`。说明 SwitchType 取值为 `SpecifiedTime` 时，该参数为必填参数。指定时间段的最短时长为一小时五十九分钟。

返回参数

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

示例

请求示例

POST /?Action=ModifyDBNodeTemporarySpec&Version=2022-01-01 HTTP/1.1
Content-Type: application/json
Host: rds.volcengineapi.com
X-Date: 20211202T101010Z
Authorization: HMAC-SHA256 Credential=AKLTN2I0MmFiNzMxNWE5NDgzMzk4MmVjMTVkODlkZTZ****/20211202/cn-beijing/rds_mysql/request,SignedHeaders=x-date, Signature=71d31fc7bcf990142851c9833c5656391486cda0ae2e0b8ada733b7c6458****
{
    "InstanceId": "mysql-66347599****",
    "NodeInfo": [
        {
            "NodeId": "mysql-66347599****-rd49e",
            "ZoneId": "cn-beijing-a",
            "NodeType": "ReadOnly",
            "NodeSpec": "rds.mysql.d1.n.2c8g",
            "NodeOperateType": "Modify"
        }
    ],
    "RollbackTime": "2024-11-28T10:59:10.000Z"
}

返回示例

{
    "ResponseMetadata": {
        "RequestId": "2024112020583642C7DB9CF0747D184FAA-f990a2",
        "Action": "ModifyDBNodeTemporarySpec",
        "Version": "2022-01-01",
        "Service": "rds_mysql",
        "Region": "cn-beijing"
    },
    "Result": {
        "InstanceId": "mysql-c9b0dce8****",
        "OrderId": "Order2180008796437128674"
    }
}

错误码

更多详情，请参见错误码。