Restarting a DB Instance

API Description

This API is used to restart a DB instance.

The DDS DB instance will be unavailable during the restart process. Exercise caution when performing this operation.

Restrictions

If the instance status is not normal, the instance cannot be restarted.

URI

• URI format

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

• URI example

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

Requests

• Parameter description

  Table 2 Parameter description

  Name	Type	Mandatory	Description
  target_type	String	No	The type of the object to restart. This parameter is mandatory when you restart one or more nodes of a cluster instance. Set the value to mongos if mongos nodes are restarted. Set the value to shard if shard nodes are restarted. Set the value to config if config nodes are restarted. This parameter is not transferred when the DB instance is restarted.
  target_id	String	Yes	The ID of the object to be restarted, which can be obtained by calling the API for querying instances. If you do not have an instance, you can call the API used for creating an instance. In a cluster instance, the value is the ID of the node to restart. When you restart the entire DB instance, the value is the DB instance ID.

• Request example
  Restart the DB instance.

  {
  	"target_id":"9136fd2a9fcd405ea4674276ce36dae8in02"
  }

  Restart shards.

  {
         "target_type":"shard",
         "target_id":"84e7c96b82aa4fedb3b00f98edd71ba4gr02"
  }

  Restart configs.

  {
        "target_type":"config",
        "target_id":"06439baa35c146d3a8965af59d370908gr02"
  }

  Restart mongos.

  {
        "target_type":"mongos",
        "target_id":"bd4dccbd53ae48d5bd3046bebf715079no02"
  }

Responses

• Parameter description

  Table 3 Parameter description

  Name	Type	Mandatory	Description
  job_id	String	Yes	The workflow ID.

• Response example

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

Status Code

For more information, see Status Code.

Error Code

For more information, see Error Code.