DescribeDBSwitchBlueGreenPrecheck--RDS for MySQL-Volcengine

Docs

RDS for MySQL

Managing instances

DescribeDBSwitchBlueGreenPrecheck

Call the DescribeDBSwitchBlueGreenPrecheck interface to query the pre-check result of the blue-green deployment switch.

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.
BeginTime	String	No	2025-07-24T09:20:52.477Z	Specify the starting time (UTC time) when querying the pre-check results according to the time range. The format is `yyyy-MM-ddTHH:mm:ss.sssZ`. tip There is no default value. If not set, the query results will be returned according to the query conditions set by other fields.
EventId	String	No	20250724171204259F91326A6ACD0B791D-5176f4	The ID of the pre-check event for blue-green deployment switching. tip There is no default value. If not set, it will return according to the query conditions set in other fields.

Response parameters

Name	Type	Example	Description
PrecheckResults	Object[]	Please refer to the return example.	The pre-check results of the blue-green deployment switch.
Result	String	Pass	Pre-check result. Value: `Pass`: Passed. `Failed`: Failed.
TaskId	String	2025072417253957250BB01665529D2515-961d25	Task ID.
Progress	Long	100	The progress of the pre-check. The unit is percentage.
CheckTime	String	2025-07-24T09:25:52.477Z	The initiation time of the pre-check (UTC time). The format is `yyyy-MM-ddTHH:mm:ss.sssZ`.
EffectiveTime	String	2025-07-25T09:25:52.477Z	The end point of the pre-check result validity period (UTC time). The format is `yyyy-MM-ddTHH:mm:ss.sssZ`.
PrecheckItems	Object[]	Please refer to the return example.	Pre-check items for blue-green deployment switching.
CheckDetail	Object	{ "Impact": "The sorting of the results returned after SQL execution may differ from that before the upgrade.", "Issue": "After the upgrade, the default character collation is changed to utf8mb4_0900_ai_ci." }	Detailed information on the inspection items that failed to pass.
Issue	String	The sorting of the results returned after SQL execution may differ from that before the upgrade.	Problems that cause the inspection items to fail.
Impact	String	After the upgrade, the default character order is changed to utf8mb4_0900_ai_ci.	The impact brought by the issues that caused the failure of the inspection items after the upgrade.
Description	String	initConnectCheck	Description information of the inspection item.
ItemName	String	initConnectCheck	The name of the inspection item.
RiskLevel	String	Warning	The risk level of the items that failed the check. Values: `Notice`: Prompt. `Warning`: Warning. `Error`: Error.
GreenInstanceId	String	mysql-06c7db72****	The ID of the green instance in the blue-green deployment.

Sample request

POST /?Action=DescribeDBSwitchBlueGreenPrecheck&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****"
}

Sample response

{
    "ResponseMetadata": {
        "RequestId": "202507241749444958F4F8739B10011CCC-32eedc",
        "Action": "DescribeDBSwitchBlueGreenPrecheck",
        "Version": "2022-01-01",
        "Service": "rds_mysql",
        "Region": "cn-guangzhou"
    },
    "Result": {
        "PrecheckResults": [
            {
                "CheckTime": "2025-07-24T09:25:52.477Z",
                "EffectiveTime": "2025-07-25T09:25:52.477Z",
                "GreenInstanceId": "mysql-06c7db72****",
                "PrecheckItems": [
                    {
                        "Description": "蓝色、绿色实例切换后，监控告警配置可能不一致。",
                        "ItemName": "check_monitor",
                        "RiskLevel": "Notice"
                    },
                    {
                        "Description": "切换蓝色、绿色实例不会迁移实例备份。",
                        "ItemName": "check_backup",
                        "RiskLevel": "Notice"
                    },
                    {
                        "Description": "蓝色、绿色实例切换过程中，不会切换 IP，仅切换您指定的终端的域名。",
                        "ItemName": "check_domain",
                        "RiskLevel": "Notice"
                    },
                    {
                        "Description": "检查蓝色实例和绿色实例的增量数据一致性。",
                        "ItemName": "check_dts_incr_data_validation",
                        "RiskLevel": "Warning"
                    }
                ],
                "Progress": 100,
                "Result": "Pass",
                "TaskId": "2025072417253957250BB01665529D2515-961d25"
            },
            {
                "CheckTime": "2025-07-24T09:12:17.139Z",
                "EffectiveTime": "2025-07-25T09:12:17.139Z",
                "GreenInstanceId": "mysql-06c7db72****",
                "PrecheckItems": [
                    {
                        "Description": "蓝色、绿色实例切换后，监控告警配置可能不一致。",
                        "ItemName": "check_monitor",
                        "RiskLevel": "Notice"
                    },
                    {
                        "Description": "切换蓝色、绿色实例不会迁移实例备份。",
                        "ItemName": "check_backup",
                        "RiskLevel": "Notice"
                    },
                    {
                        "Description": "蓝色、绿色实例切换过程中，不会切换 IP，仅切换您指定的终端的域名。",
                        "ItemName": "check_domain",
                        "RiskLevel": "Notice"
                    },
                    {
                        "Description": "检查蓝色实例和绿色实例的增量数据一致性。",
                        "ItemName": "check_dts_incr_data_validation",
                        "RiskLevel": "Warning"
                    }
                ],
                "Progress": 100,
                "Result": "Pass",
                "TaskId": "20250724171204259F91326A6ACD0B791D-5176f4"
            }
        ]
    }
}

Error codes

For more details, refer to Error codes.

Last updated: 2025.12.04 11:20:10

RDS for MySQL

Request type #

Request parameters #

Response parameters #

Sample request #