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

RestartDBInstance

最近更新时间：2023.12.04 15:06:11

首次发布时间：2023.02.02 17:41:21

我的收藏

调用 RestartDBInstance 接口重启实例。

请求类型

异步请求。

请求参数

名称类型是否必选示例值描述
InstanceIdString是mysql-e26822cf****实例 ID。

ApplyScope

String

否

AllNode

重启场景，取值：

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

CustomNodeIds

Array of String

否

["mysql-e26822cf****-r90ab","mysql-e26822cf****-r84eb"]

需要重启的节点 ID，多个节点 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: 20211202T101010Z
Authorization: HMAC-SHA256 Credential=AKLTN2I0MmFiNzMxNWE5NDgzMzk4MmVjMTVkODlkZTZ****/20211202/cn-beijing/rds_mysql/request,SignedHeaders=x-date, Signature=71d31fc7bcf990142851c9833c5656391486cda0ae2e0b8ada733b7c645a****

{
    "InstanceId":"mysql-759174bd****",
    "ApplyScope":"AllNode"
}

  • 重启指定只读节点

    POST /?Action=RestartDBInstance&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=71d31fc7bcf990142851c9833c5656391486cda0ae2e0b8ada733b7c645a****

{
    "InstanceId":"mysql-759174bd****",
    "ApplyScope":"CustomNode",
    "CustomNodeIds":[
    	"mysql-e26822cf****-r90ab",
    	"mysql-e26822cf****-r84eb"
    ]
}

返回示例

正常返回示例

{
    "ResponseMetadata" : {
        "RequestId": "2023120413593055A48DA4D95A611CCBDF",
        "Action": "RestartDBInstance",
        "Version": "2022-01-01",
        "Service": "rds_mysql",
        "Region": "cn-beijing"
    },
    "Result":  null
}

错误码

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