Call the DescribeDBDisasterRecoveryInstances API to query the disaster recovery instance information of the instance.

Request type #

Synchronous request.

Request parameters #

Response parameters #

The range of returned parameters varies depending on the role of the incoming instance:

• If the incoming InstanceId is the disaster recovery instance ID, then DrDtsTaskId, TestTask, DrDtsTaskStatus, DrSecondsBehindMaster, MasterInstanceId, MasterInstanceName and MasterRegion are returned.
• If the incoming InstanceId is the primary instance ID, only DisasterRecoveryInstances are returned.
• When the disaster recovery link between the primary instance and the disaster recovery instance has not been created, regardless of whether the incoming InstanceId is the disaster recovery instance ID or the primary instance ID, DrDtsTaskId, TestTask and DrDtsTaskStatus are not returned.
• If the instance corresponding to the incoming InstanceId is neither the primary instance nor the disaster recovery instance, then an empty return is made.

Sample request #

POST /?Action=DescribeDBDisasterRecoveryInstances&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": "202507241529338A603E6C7E84B0047221-45a378",
        "Action": "DescribeDBDisasterRecoveryInstances",
        "Version": "2022-01-01",
        "Service": "rds_mysql",
        "Region": "cn-guangzhou"
    },
    "Result": {
        "DisasterRecoveryInstances": [
            {
                "DtsTaskId": "9c0c17a0b82f460b87b338d1db8d8189",
                "DtsTaskName": "TestTask",
                "DtsTaskStatus": "Running",
                "InstanceId": "mysql-6c7c35fb6aed",
                "InstanceName": "测试实例",
                "Region": "cn- hanghai",
                "SecondsBehindMaster": 1
            }
        ]
    }
}

Error codes #

For more details, refer to Error codes.