# 重启实例-RestartingaDBInstance #### 功能介绍 重启实例的数据库服务。 ![](https://support.huaweicloud.com/api-dds/public_sys-resources/notice_3.0-zh-cn.png) 文档数据库实例重启过程中将不可用，请谨慎操作。 #### 接口约束 实例状态非"normal"时，不允许重启实例。 #### 调试 您可以在[API Explorer](https://apiexplorer.developer.huaweicloud.com/apiexplorer/doc?product=DDS&api=RestartInstance)中调试该接口。 #### 授权信息 账号具备所有API的调用权限，如果使用账号下的IAM用户调用当前API，该IAM用户需具备调用API所需的权限。 - 如果使用角色与策略授权，具体权限要求请参见[权限和授权项](https://support.huaweicloud.com/api-dds/dds_api_permission.html)。 - 如果使用身份策略授权，需具备如下身份策略权限。 | 授权项 | 访问级别 | 资源类型（\*为必须） | 条件键 | 别名 | 依赖的授权项 | |:---|:---|:---|:---|:---|:---| | dds:instance:restart | write | instance | [g:EnterpriseProjectId](https://support.huaweicloud.com/api-dds/dds_api_0042.html#dds_api_0042__li1539015369314) | dds:instance:reboot | - | #### URI - URI格式 POST /v3/{project_id}/instances/{instance_id}/restart 表1路径参数 | 名称 | 是否必选 | 类型 | IN | 描述 | |:---|:---|:---|:---|:---| | project_id | 是 | string | path | **参数解释：** 租户在某一Region下的项目ID。请参考[获取项目ID](https://support.huaweicloud.com/api-dds/dds_projectid.html)章节获取项目编号。 **约束限制：** 不涉及。 **取值范围：** 不涉及。 **默认取值：** 不涉及。 | | instance_id | 是 | string | path | **参数解释：** 实例ID，可以调用"[查询实例列表和详情-QueryingInstancesandDetails](https://support.huaweicloud.com/api-dds/dds_api_0023.html)"接口获取。如果未申请实例，可以调用"[创建实例-CreatingaDBInstance](https://support.huaweicloud.com/api-dds/dds_api_0020.html)"接口创建。 **约束限制：** 不涉及。 **取值范围：** 不涉及。 **默认取值：** 不涉及。 | #### 请求参数 表2请求Header参数 | 名称 | 是否必选 | 类型 | IN | 描述 | |:---|:---|:---|:---|:---| | X-Auth-Token | 是 | string | header | **参数解释：** 从IAM服务获取的用户Token。请参考[认证鉴权](https://support.huaweicloud.com/api-dds/dds_api_0010.html)。 **约束限制：** 不涉及。 **取值范围：** 不涉及。 **默认取值：** 不涉及。 | 表3参数说明 | 名称 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | target_type | 否 | String | **参数解释：** 待重启对象的类型。 **约束限制：** 重启集群实例下的节点或组时，该参数必选。 - 重启mongos节点时，取值为"mongos"。 - 重启shard组时，取值为"shard"。 - 重启config组时，取值为"config"。 - 重启实例（集群、副本集、单节点）时，不传该参数。 **取值范围：** - **mongos** - **shard** - **config** **默认取值：** 不涉及。 | | target_id | 是 | String | **参数解释：** 待重启对象的ID，可以调用"查询实例列表"接口获取。如果未申请实例，可以调用"创建实例"接口创建。 **约束限制：** 节点状态为正常时，不允许重启主节点。 **取值范围：** - 重启整个实例时，取值为实例ID。 - 重启集群实例shard或config组时取值为shard或config的组ID。 - 重启单个节点时，取值为对应节点的节点ID。 **默认取值：** 不涉及。 | | is_serial | 否 | Boolean | **参数解释：** 是否选择节点串行重启。 **约束限制：** 只支持副本集实例。 **取值范围：** - true：表示节点串行重启。 - false：表示节点并行重启。 **默认取值：** false。 | | is_force | 否 | Boolean | **参数解释：** 是否强制重启。 **约束限制：** 仅支持节点状态为异常时进行强制重启。只读节点暂不支持强制重启。 **取值范围：** - true：表示异常节点进行强制重启。 - false：表示进行正常重启。 **默认取值：** false。 | #### 响应参数 表4参数说明 | 名称 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | job_id | 是 | String | **参数解释：** 工作流ID。 **取值范围：** 不涉及。 | #### 请求示例 - 根据target_id重启整个实例 ``` { "target_id":"9136fd2a9fcd405ea4674276ce36dae8in02" } ``` - 根据target_type和target_id重启shard组 ``` { "target_type":"shard", "target_id":"84e7c96b82aa4fedb3b00f98edd71ba4gr02" } ``` - 根据target_type和target_id重启config组 ``` { "target_type":"config", "target_id":"06439baa35c146d3a8965af59d370908gr02" } ``` - 根据target_type和target_id重启mongos节点 ``` { "target_type":"mongos", "target_id":"bd4dccbd53ae48d5bd3046bebf715079no02" } ``` - 串行重启 ``` POST https://{endpoint}/v3/054e292c9880d4992f02c0196d3ea468/instances/837f47dd0fa34219b1f5ce3f05cb5541in02/restart { "target_id" : "837f47dd0fa34219b1f5ce3f05cb5541in02", "is_serial" : false } ``` #### 响应示例 ``` { "job_id": "3711e2ad-5787-49bc-a47f-3f0b066af9f5" } ``` #### SDK 单击[文档数据库服务 DDS SDK](https://sdkcenter.developer.huaweicloud.com/?product=DDS)，下载SDK或查看SDK文档。SDK的安装、认证方式等在SDK文档中对应语言类型的【使用】目录下。 #### 状态码 详情请参见[状态码](https://support.huaweicloud.com/api-dds/dds_status_code.html)。 #### 错误码 详情请参见[错误码](https://support.huaweicloud.com/api-dds/dds_error_code.html)。