重启实例

接口说明

重启实例的数据库服务。

文档数据库实例重启过程中将不可用，请谨慎操作。

约束说明

实例状态非“normal”时，不允许重启实例。

调试

您可以在API Explorer中调试该接口。

URI

• URI格式

  POST https://{Endpoint}/v3/{project_id}/instances/{instance_id}/restart

• URI样例

  https://dds.cn-north-1.myhuaweicloud.com/v3/0549b4a43100d4f32f51c01c2fe4acdb/instances/9136fd2a9fcd405ea4674276ce36dae8in02/restart

请求消息

• 参数说明

  表2 参数说明

  名称	参数类型	是否必选	描述
  target_type	String	否	待重启对象的类型。 重启集群实例下的节点或组时，该参数必选。 重启mongos节点时，取值为“mongos”。 重启shard组时，取值为“shard”。 重启config组时，取值为“config”。 重启只读节点时，取值为readonly。 重启副本集实例下的节点。 重启readonly节点时，取值为“readonly”。 重启实例（集群、副本集、单节点）时，不传该参数。 枚举值： mongos shard config readonly
  target_id	String	是	待重启对象的ID，可以调用“查询实例列表”接口获取。如果未申请实例，可以调用“创建实例”接口创建。 重启集群实例下的节点时，对于mongos节点，取值为mongos节点ID，对于只读节点，取值为只读节点ID，对于shard和config组，取值为shard和config组ID。 重启整个实例时，取值为实例ID。 重启副本集实例时，取值为实例ID。对于readonly节点，取值为readonly节点ID。 重启单节点实例时，取值为实例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"
  }

响应消息

• 参数说明

  表3 参数说明

  名称	参数类型	是否必选	描述
  job_id	String	是	工作流ID。

• 响应示例

  { 
      "job_id": "3711e2ad-5787-49bc-a47f-3f0b066af9f5" 
  }

SDK

单击文档数据库服务 DDS SDK，下载SDK或查看SDK文档。SDK的安装、认证方式等在SDK文档中对应语言类型的【使用】目录下。

状态码

详情请参见状态码。

错误码

详情请参见错误码。