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

文档中心

立即注册

导航

RestartDBInstance

最近更新时间：2024.06.12 15:26:26首次发布时间：2023.11.15 22:39:52

调用 RestartDBInstance 接口重启实例。

请求类型

异步请求。

请求参数

名称类型是否必选示例值描述

InstanceId String 是 postgres-21a3333b**** 实例 ID。

名称	类型	是否必选	示例值	描述
InstanceId	String	是	postgres-21a3333b****	实例 ID。
ApplyScope	String	否	AllNode	重启场景，取值： `AllNode`：所有节点。 `CustomNode`：自定义只读节点。
CustomNodeIds	Array of String	否	["postgres-6a85fdfd**-ro30f7","postgres-6a85fdfd**-rod958"]	要重启的只读节点的 ID。当 `ApplyScope` 取值为 `AllNode` 时，会重启整个实例，不需要传入该参数。当 `ApplyScope` 取值为 `CustomNode` 时，该参数传入需要重启的只读节点 ID。

ApplyScope

String

否

AllNode

重启场景，取值：

AllNode：所有节点。
CustomNode：自定义只读节点。

CustomNodeIds

Array of String

否

["postgres-6a85fdfd****-ro30f7","postgres-6a85fdfd****-rod958"]

要重启的只读节点的 ID。

当 ApplyScope 取值为 AllNode 时，会重启整个实例，不需要传入该参数。
当 ApplyScope 取值为 CustomNode 时，该参数传入需要重启的只读节点 ID。

返回参数

null

请求示例

POST /?Action=RestartDBInstance&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-21a3333b****",
    "ApplyScope":"CustomNode",
    "CustomNodeIds":["postgres-857a4a97****-rod301"]
}

返回示例

正常返回示例

{
    "ResponseMetadata": {
        "RequestId": "202306192236493E0DA6BBDC4CB9AB1711",
        "Action": "RestartDBInstance",
        "Version": "2022-01-01",
        "Service": "rds_postgresql",
        "Region": "cn-beijing"
    },
    "Result": null
}