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

RDS for PostgreSQL

Copy page
Download PDF
Managing instances
ModifyDBInstanceAvailabilityZone
Copy page
Download PDF
ModifyDBInstanceAvailabilityZone
Call the ModifyDBInstanceAvailabilityZone API to migrate nodes from one AZ to another AZ in the same region.​
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-aa7e1633****​
Instance ID.​
NodeInfo​
Array of NodeZoneInfoObject​
Yes​
Refer to the request example.​
Nodes to be migrated and the destination availability zone.​
  • Only migrating a single-availability-zone instance to a multi-availability-zone instance is supported.​
  • Only support migrating secondary nodes or read-only nodes, and support migrating secondary nodes and read-only nodes simultaneously.​
​
NodeZoneInfoObject​
​
Parameter​
Type​
Required?​
Example​
Description​
NodeId​
String​
Yes​
postgres-ca7b7019****​
Node ID. You can call the DescribeDBInstanceDetail API to query the node information of the instance.​
ZoneId​
String​
Yes​
cn-beijing-a​
The availability zone of each node in the instance. You can call the DescribeAvailabilityZones API to query the availability zone information of the current region.​
​
Response parameters​
​
Parameter​
Type​
Example​
Description​
InstanceId​
String​
postgres-aa7e1633****​
Instance ID.​
OrderId​
String​
​
Order ID.​
tip​
The return value of this field is empty.​
​
Sample​
Sample request​
​
POST /?Action=ModifyDBInstanceAvailabilityZone&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-aa7e1633****",​
"NodeInfo": [​
{​
"NodeId": "postgres-aa7e1633****",​
"ZoneId": "cn-beijing-b"​
},​
{​
"NodeId": "postgres-aa7e1633****-pxcm",​
"ZoneId": "cn-beijing-c"​
},​
{​
"NodeId": "postgres-aa7e1633****-roe6c0",​
"ZoneId": "cn-beijing-b"​
}​
]​
}​
​
Sample response​
​
{​
"ResponseMetadata": {​
"RequestId": "202401082241020D9550F8209B0738F56A",​
"Action": "ModifyDBInstanceAvailabilityZone",​
"Version": "2022-01-01",​
"Service": "rds_postgresql",​
"Region": "cn-beijing"​
},​
"Result": {​
"InstanceId": "postgres-aa7e1633****",​
"OrderId": ""​
}​
}​
​
Last updated: 2026.03.31 10:45:18