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

RDS for MySQL

  • Documentation
    • RDS for MySQLAPI referenceV2（2022-01-01）Managing instancesSwitchDBPrecheckBlueGreen
Copy page
Download PDF
Managing instances
SwitchDBPrecheckBlueGreen
Copy page
Download PDF
SwitchDBPrecheckBlueGreen

Call the SwitchDBPrecheckBlueGreen interface to initiate a pre-check for blue-green deployment switching.

Request type

Synchronous request.

Request parameters

Name
Type
Required
Example
Description
InstanceId
String
Yes
mysql-f83edc2e****
The ID of the blue instance in blue-green deployment.
Recheck
Boolean
No
false

Whether to initiate the pre-check again. Value:

  • true: Yes, initiate the pre-check again and return the event ID of this pre-check.
  • false: No: If the instance has been pre-checked before and the pre-check result is still within the validity period, the pre-check will not be initiated again and the event ID of the last successful pre-check will be returned; if the instance has not been pre-checked before or has been pre-checked but the check result has exceeded the validity period, the pre-check will be initiated again. Default value.

tip

This parameter has no default value.

Endpoints
Object[]
No
Please refer to the request example.
Connection information of the instance.
OriginEndpointId
String
Yes
mysql-f83edc2e****-cluster
The connection terminal ID of the blue instance.
TargetEndpointId
String
Yes
mysql-06c7db72****-cluster
The connection terminal ID of the green instance.

Response parameters

Name
Type
Example
Description
EventId
String
20250724171204259F91326A6ACD0B****-5176f4
Event ID.

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 codes

For more details, refer to Error codes.

Last updated: 2025.12.04 11:20:10