更新时间:2025-08-22 GMT+08:00

重启数据库实例

功能介绍

重启实例的数据库服务。

接口约束

  • 实例在创建、扩容、变更规格、备份、恢复、修改端口或冻结状态下不能重启。
  • RDS实例重启过程中将不可用,请谨慎操作。

URI

  • URI格式

    POST /v3/{project_id}/instances/{instance_id}/action

  • 参数说明
    表1 参数说明

    名称

    是否必选

    说明

    project_id

    参数解释

    租户在某一Region下的项目ID。

    获取方法请参见获取项目ID

    约束限制

    不涉及。

    取值范围

    不涉及。

    默认取值

    不涉及。

    instance_id

    参数解释

    实例ID。

    约束限制

    不涉及。

    取值范围

    不涉及。

    默认取值

    不涉及。

请求消息

表2 参数说明

名称

是否必选

参数类型

说明

restart

String

参数解释:

重启实例。对于MySQL和PostgreSQL引擎为空值,SQL Server引擎请参见表3

约束限制:

不涉及

表3 restart字段说明

名称

是否必选

参数类型

说明

restart_server

Boolean

参数解释:

是否重启虚拟机。

约束限制:

仅支持SQL Server引擎。

取值范围:

不涉及

默认取值:

不涉及

forcible

Boolean

参数解释:

是否强制重启。

约束限制:

  • 仅支持SQL Server引擎。
  • 强制重启会导致数据库服务中未提交的事务强制中断。

取值范围:

不涉及

默认取值:

不涉及

delay

Boolean

参数解释:

是否在可维护时间段内重启。

约束限制:

仅支持SQL Server引擎。

取值范围:

不涉及

默认取值:

不涉及

请求示例

  • 重启MySQL或PostgreSQL实例。
    POST https://{Endpoint}/v3/0483b6b16e954cb88930a360d2c4e663/instances/dsfae23fsfdsae3435in01/action
    {
          "restart": {}
    }
  • 重启SQL Server实例。
    { 
       "restart" : { 
         "restart_server" : false, 
         "forcible" : false, 
         "delay" : false 
       } 
     }
  • 强制重启SQL Server实例。
    { 
       "restart" : { 
         "restart_server" : false, 
         "forcible" : true, 
         "delay" : false 
       } 
     }
  • 在可维护时间段内重启SQL Server实例。
    { 
       "restart" : { 
         "restart_server" : false, 
         "forcible" : false, 
         "delay" : true 
       } 
     }
  • 重启SQL Server实例虚拟机。
    { 
       "restart" : { 
         "restart_server" : true, 
         "forcible" : false, 
         "delay" : false 
       } 
     }

响应消息

  • 正常响应要素说明
    表4 要素说明

    名称

    参数类型

    说明

    job_id

    String

    参数解释:

    任务ID。

    取值范围:

    不涉及

  • 正常响应样例
    {
        "job_id": "2b414788a6004883a02390e2eb0ea227"
    }
  • 异常响应

    请参见异常请求结果

状态码

错误码

请参见错误码