DescribeDBDisasterRecoveryInstances--云数据库 MySQL 版-火山引擎

文档中心

立即注册

导航

DescribeDBDisasterRecoveryInstances

最近更新时间：2025.07.30 15:44:31首次发布时间：2025.07.30 15:44:31

调用 DescribeDBDisasterRecoveryInstances 接口查询实例的灾备实例信息。

请求类型

同步请求。

调试

API Explorer

您可以通过 API Explorer 在线发起调用，无需关注签名生成过程，快速获取调用结果。

去调试

请求参数

参数	类型	是否必选	示例值	描述
InstanceId	String	是	mysql-f83edc2e****	实例 ID。

返回参数

返回参数的范围因传入的实例所处的角色而不同：

如果传入的 InstanceId 为灾备实例 ID，则返回 DrDtsTaskId、TestTask、DrDtsTaskStatus、DrSecondsBehindMaster、MasterInstanceId、MasterInstanceName 和 MasterRegion。
如果传入的 InstanceId 为主实例 ID，则仅返回 DisasterRecoveryInstances。
在主实例与灾备实例之间的灾备链路未创建时，无论传入的 InstanceId 为灾备实例 ID 还是主实例 ID，均不返回 DrDtsTaskId、TestTask 和 DrDtsTaskStatus。
如果传入的 InstanceId 所对应的实例既不是主实例也不是灾备实例，则返回为空。

参数	类型	示例值	描述
DisasterRecoveryInstances	Object[]	请参见返回示例。	实例的灾备实例的信息。
DrDtsTaskId	String	9c0c17a0b82f460b87b338d1db8d****	主实例与灾备实例之间同步任务的 ID。
DrDtsTaskName	String	TestTask	主实例与灾备实例之间同步任务的名称。
DrDtsTaskStatus	String	Running	主实例与灾备实例之间同步任务的状态。
DrSecondsBehindMaster	Integer	1	灾备实例与主实例之间的时延。
MasterInstanceId	String	mysql-f83edc2e****	主实例的 ID。
MasterInstanceName	String	测试实例	主实例的名称。
MasterRegion	String	cn-guangzhou	主实例所在的地域。

示例

请求示例

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****"
}

返回示例

{
    "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
            }
        ]
    }
}

错误码

更多详情，请参见错误码。