更新时间:2022-04-12 GMT+08:00
分享

重启实例

功能介绍

重启实例的数据库服务。

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

接口约束

实例状态非“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

  • 参数说明
    表1 参数说明

    名称

    是否必选

    描述

    project_id

    租户在某一region下的project ID。

    instance_id

    实例ID,可以调用“查询实例列表”接口获取。如果未申请实例,可以调用“创建实例”接口创建。

请求消息

  • 参数说明
    表2 要素说明

    名称

    是否必选

    参数类型

    描述

    target_type

    String

    待重启对象的类型。

    • 重启集群实例下的节点或组时,该参数必选。
      • 重启mongos节点时,取值为“mongos”。
      • 重启shard组时,取值为“shard”。
      • 重启config组时,取值为“config”。
    • 重启整个实例时,不传该参数。

    target_id

    String

    待重启对象的ID,可以调用“查询实例列表”接口获取。如果未申请实例,可以调用“创建实例”接口创建。

    • 重启集群实例下的节点时,对于mongos节点,取值为mongos节点ID,对于shard和config组,取值为shard和config组ID。
    • 重启整个实例时,取值为实例ID。
  • 请求体样例
    重启整个实例:
    {
    	"target_id":"9136fd2a9fcd405ea4674276ce36dae8in02"
    }
    重启shard组:
    {
           "target_type":"shard",
           "target_id":"84e7c96b82aa4fedb3b00f98edd71ba4gr02"
    }
    重启config组:
    {
          "target_type":"config",
          "target_id":"06439baa35c146d3a8965af59d370908gr02"
    }
    重启mongos节点:
    {
          "target_type":"mongos",
          "target_id":"bd4dccbd53ae48d5bd3046bebf715079no02"
    }

响应消息

  • 要素说明
    表3 要素说明

    名称

    参数类型

    描述

    job_id

    String

    工作流ID。

  • 响应样例
    { 
        "job_id": "3711e2ad-5787-49bc-a47f-3f0b066af9f5" 
    }

状态码

详情请参见状态码

错误码

详情请参见错误码

分享:

    相关文档

    相关产品

关闭导读