Help Center/ Document Database Service/ API Reference (Ally Region)/ APIs V3.0 (Recommended)/ DB Instance Management/ Restarting a DB Instance
Updated on 2026-01-08 GMT+08:00
View PDF
Share

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

Table 1 Path parameters

Parameter

Type

IN

Mandatory

Description

project_id

string

path

Yes

Project ID of a tenant in a region. To obtain the project ID, see Obtaining a Project ID.

instance_id

string

path

Yes

Instance ID, which can be obtained by calling the API described in Querying Instances and Details. If you do not have an instance, call the API described in Creating a DB Instance to create one.

Request Parameters

Table 2 Request header parameters

Parameter

Type

IN

Mandatory

Description

X-Auth-Token

string

header

Yes

User token
Table 3 Parameter description

Parameter

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 mandatory when you restart the node of a replica set instance.
    • Set the value to readonly if read replicas are restarted.
  • This parameter is not specified when a DB instance (cluster, replica set, or single node) is restarted.
  • Enumerated values:
    • mongos
    • shard
    • config
    • readonly

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.
  • When you restart a replica set instance, the value is the DB instance ID. When you restart a read replica, the value is the read replica ID.
  • When you restart a single node instance, the value is the DB instance ID.

Response Parameters

Table 4 Parameter description

Parameter

Type

Mandatory

Description

job_id

String

Yes

The workflow ID.

Example Request

Restart the DB instance. 
{
	"target_id":"9136fd2a9fcd405ea4674276ce36dae8in02"
}
Restart a shard group. 
{
       "target_type":"shard",
       "target_id":"84e7c96b82aa4fedb3b00f98edd71ba4gr02"
}
Restart a config group. 
{
      "target_type":"config",
      "target_id":"06439baa35c146d3a8965af59d370908gr02"
}
Restart a mongos node. 
{
      "target_type":"mongos",
      "target_id":"bd4dccbd53ae48d5bd3046bebf715079no02"
}
Restart a read replica of a replica set instance. 
{ 
   "target_type" : "readonly", 
   "target_id" : "886485522d0c4a14b067446a89873962no02" 
 }

Example Response

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

Status Code

For details, see Status Code.

Error Code

For details, see Error Code.

Parent topic: DB Instance Management