You need to enable JavaScript to run this app.
RDS for PostgreSQL

RDS for PostgreSQL

Copy page
Download PDF
Managing instances
RestartDBInstance
Copy page
Download PDF
RestartDBInstance
Call the RestartDBInstance API to restart an instance.​
Request type​
Asynchronous request.​
Debug​
API Explorer
You can initiate calls online through API Explorer without paying attention to the signature generation process and quickly obtain the call results.
​
Request parameters​
​
Parameter​
Type​
Required?​
Example​
Description​
InstanceId​
String​
Yes​
postgres-21a3333b****​
Instance ID.​
ApplyScope​
String​
No​
AllNode​
Restart scenario. The value can be:​
  • AllNode: all nodes. Default value.​
  • CustomNode: custom read-only nodes.​
CustomNodeIds​
Array of String​
No​
["postgres-6a85fdfd****-ro30f7","postgres-6a85fdfd****-rod958"]​
ID of the read-only node to restart.​
  • When ApplyScope is set to All nodes, the entire instance restarts, and the CustomNodeIds parameter cannot be set.​
  • When ApplyScope is set to CustomNode, this parameter requires the IDs of the read-only nodes to restart.​
​
Response parameter​
null​
Sample​
Sample request​
​
POST /?Action=RestartDBInstance&Version=2022-01-01 HTTP/1.1​
Content-Type: application/json​
Host: rds-postgresql.cn-beijing.volcengineapi.com​
X-Date: 20231002T101010Z​
Authorization: HMAC-SHA256 Credential=AKLTN2I0MmFiNzMxNWE5NDgzMzk4MmVjMTVkODlkZTZ****/20211202/cn-beijing/rds_postgresql/request,SignedHeaders=x-date, Signature=71d31fc7bcf990142851c9833c5656391486cda0ae2e0b8ada733b7c6458****​
{​
"InstanceId": "postgres-21a3333b****",​
"ApplyScope": "CustomNode",​
"CustomNodeIds": [​
"postgres-857a4a97****-rod301"​
]​
}​
​
Sample response​
​
{​
"ResponseMetadata": {​
"RequestId": "202306192236493E0DA6BBDC4CB9AB1711",​
"Action": "RestartDBInstance",​
"Version": "2022-01-01",​
"Service": "rds_postgresql",​
"Region": "cn-beijing"​
},​
"Result": null​
}​
​
Last updated: 2026.03.31 10:45:18