DescribeDBBlueGreenInstance--RDS for MySQL-Volcengine

Docs

RDS for MySQL

Managing instances

DescribeDBBlueGreenInstance

Call the DescribeDBBlueGreenInstance interface to query the blue-green deployment information of the instance.

Request type

Synchronous request.

Request parameters

Name	Type	Required	Example	Description
InstanceId	String	Yes	mysql-f83edc2e****	Instance ID.

Response parameters

Name	Type	Example	Description
GreenInstance	Object	Please refer to the return example.	The information of the green instance in the blue-green deployment.
DtsTaskId	String	9879df1b169e4271abeafc5b393****	The ID of the synchronization task in blue-green deployment. tip If the synchronization task for blue-green deployment has not been created yet, this field will return empty.
InstanceId	String	mysql-d4a1171e****	Instance ID.
DtsTaskName	String	BlueGreenTest	The name of the blue-green deployment synchronization task. tip If the synchronization task for blue-green deployment has not been created, this field will not be returned.
InstanceName	String	Test instance	Instance name.
DtsTaskStatus	String	Canceled	The status of the blue-green deployment synchronization task.
SecondsBehindMaster	Integer	17	The latency between blue-green instances.
BlueInstance	Object	Please refer to the return example.	The information of the blue instance in the blue-green deployment.
DtsTaskId	String	9879df1b169e4271abeafc5b393****	The ID of the synchronization task in blue-green deployment. tip If the synchronization task for blue-green deployment has not been created yet, this field will return empty.
InstanceId	String	mysql-d4a1171e****	Instance ID.
DtsTaskName	String	BlueGreenTest	The name of the blue-green deployment synchronization task. tip If the synchronization task for blue-green deployment has not been created, this field will not be returned.
InstanceName	String	Test instance	Instance name.
DtsTaskStatus	String	Canceled	The status of the blue-green deployment synchronization task.
SecondsBehindMaster	Integer	17	The latency between blue-green instances.

Sample request

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

Sample response

{
    "ResponseMetadata": {
        "RequestId": "202508122025128CD75BD341C74881E68C-402322",
        "Action": "DescribeDBBlueGreenInstance",
        "Version": "2022-01-01",
        "Service": "rds_mysql",
        "Region": "cn-chongqing-sdv"
    },
    "Result": {
        "BlueInstance": {
            "DtsTaskId": "9879df1b169e4271abeafc5b3939****",
            "InstanceId": "mysql-d4a1171e****",
            "InstanceName": "蓝绿部署-蓝色实例"
        },
        "GreenInstance": {
            "DtsTaskId": "879df1b169e4271abeafc5b3939****",
            "DtsTaskName": "test",
            "InstanceId": "mysql-23987082****",
            "InstanceName": "蓝绿部署-绿色实例",
            "SecondsBehindMaster": 17
        }
    }
}

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 #