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

RDS for MySQL

Copy page
Download PDF
Managing instances
SwitchDBPrecheckBlueGreen
Copy page
Download PDF
SwitchDBPrecheckBlueGreen
Call the SwitchDBPrecheckBlueGreen API to initiate a pre-check for a blue-green deployment switch.​
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​
Is it required?​
Example​
Description​
InstanceId​
String​
Yes​
mysql-f83edc2e****​
The ID of the blue instance in the blue-green deployment.​
Recheck​
Boolean​
No​
false​
Whether to restart the pre-check. Values:​
  • true: yes. Restarts the pre-check and returns the event ID of the current pre-check.​
  • false: no. If the instance has a valid pre-check result, the system returns the event ID of the last successful pre-check without starting a new one. Otherwise, the system starts a new pre-check. Default value.​
tip​
This parameter has no default value.​
Endpoints​
Array of SwitchDBEndpoint​
No​
See the request example.​
Instance connection information.​
​
SwitchDBEndpoint​
​
Parameter​
Type​
Is it required?​
Sample value​
Description​
OriginEndpointId​
String​
Yes​
mysql-f83edc2e****-cluster​
The connection endpoint ID of the blue instance.​
TargetEndpointId​
String​
Yes​
mysql-06c7db72****-cluster​
The connection endpoint ID of the green instance.​
​
Response parameters​
​
Parameter​
Type​
Sample value​
Description​
EventId​
String​
20250724171204259F91326A6ACD0B****-5176f4​
Event ID.​
​
Sample​
Sample request​
​
POST /?Action=SwitchDBPrecheckBlueGreen&Version=2022-01-01 HTTP/1.1​
Content-Type: application/json​
Host: rds-mysql.cn-beijing.volcengineapi.com​
X-Date: 20211202T101010Z​
Authorization: HMAC-SHA256 Credential=AKLTN2I0MmFiNzMxNWE5NDgzMzk4MmVjMTVkODlkZTZ****/20211202/cn-beijing/rds_mysql/request,SignedHeaders=x-date, Signature=71d31fc7bcf990142851c9833c5656391486cda0ae2e0b8ada733b7c6458****​
{​
"InstanceId": "mysql-f83edc2e****",​
"Recheck": false​
}​
​
Sample response​
​
{​
"ResponseMetadata": {​
"RequestId": "202507241749444958F4F8739B10011CCC-32eedc",​
"Action": "SwitchDBPrecheckBlueGreen",​
"Version": "2022-01-01",​
"Service": "rds_mysql",​
"Region": "cn-guangzhou"​
},​
"Result": {​
"EventId": "20250724171204259F91326A6ACD0B****-5176f4"​
}​
}​
​
Error code​
For more details, refer to Error codes.​
Last updated: 2026.06.12 17:17:53