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

文档中心

立即注册

导航

DescribeCrossRegionBackupDBInstances

最近更新时间：2025.01.22 12:04:51首次发布时间：2025.01.22 12:04:51

调用 DescribeCrossRegionBackupDBInstances 接口查询开启过和开启了跨地域备份功能的实例列表。

请求类型

同步请求。

调试

API Explorer

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

去调试

请求参数

参数	类型	是否必选	示例值	描述
InstanceId	String	否	mysql-ce1fee06****	实例 ID。说明传入该参数时，返回指定已删除实例的备份信息。不传时返回所有满足设定查询条件的结果。
InstanceName	String	否	测试实例	实例名称。支持模糊匹配。
PageNumber	Integer	否	1	当前页页码。最小值为 1。默认值为 1。
PageSize	Integer	否	10	每页记录数。最小值为 1，最大值不超过 100。默认值为 10。
EnableBeforeTime	String	否	2024-10-15T08:39:28.000Z	查询的时间范围的起点。格式为 yyyy-MM-ddTHH:mm:ss.sssZ（UTC 时间）。说明时间范围的起点应早于时间范围的终点（EnableBeforeTime）。
EnableAfterTime	String	否	2024-10-14T23:35:08.000Z	查询的时间范围的终点。格式为 yyyy-MM-ddTHH:mm:ss.sssZ（UTC 时间）。说明时间范围的终点应晚于时间范围的起点（EnableAfterTime）。
ProjectName	String	否	default	项目名称。支持按照项目进行查询。

返回参数

参数	类型	示例值	描述
Total	Integer	5	符合查询条件的结果总数。
Datas	Object[]	请参见返回示例。	符合查询条件的开启了跨地域备份功能的实例列表。

示例

请求示例

POST /?Action=DescribeCrossRegionBackupDBInstances&Version=2022-01-01 HTTP/1.1
Content-Type: application/json
Host: rds.volcengineapi.com
X-Date: 20211202T101010Z
Authorization: HMAC-SHA256 Credential=AKLTN2I0MmFiNzMxNWE5NDgzMzk4MmVjMTVkODlkZTZ****/20211202/cn-beijing/rds_mysql/request,SignedHeaders=x-date, Signature=71d31fc7bcf990142851c9833c5656391486cda0ae2e0b8ada733b7c6458****

返回示例

{
    "ResponseMetadata": {
        "RequestId": "20241015172037A586D37F7C4E5C98ACAD-59509f",
        "Action": "DescribeCrossRegionBackupDBInstances",
        "Version": "2022-01-01",
        "Service": "rds_mysql",
        "Region": "cn-beijing"
    },
    "Result": {
        "Datas": [
            {
                "BackupEnabled": true,
                "DBEngineVersion": "MySQL_5_7",
                "InstanceId": "mysql-1368c0b1****",
                "InstanceName": "开启跨地域备份实例1",
                "InstanceStatus": "Running",
                "LogBackupEnabled": false,
                "ProjectName": "default",
                "RegionId": "cn-shanghai",
                "Retention": 7,
                "ServiceEnableTime": "2024-05-14T12:05:34.000Z",
                "Status": "ON"
            },
            {
                "BackupEnabled": true,
                "DBEngineVersion": "MySQL_5_7",
                "InstanceId": "mysql-3c64f81e****",
                "InstanceName": "开启跨地域备份实例2",
                "InstanceStatus": "Running",
                "LogBackupEnabled": true,
                "ProjectName": "default",
                "RegionId": "cn-shanghai",
                "Retention": 7,
                "ServiceEnableTime": "2024-09-19T03:34:39.000Z",
                "Status": "ON"
            },
            {
                "BackupEnabled": true,
                "DBEngineVersion": "MySQL_5_7",
                "InstanceId": "mysql-7d930d46****",
                "InstanceName": "开启跨地域备份实例3",
                "InstanceStatus": "Running",
                "LogBackupEnabled": true,
                "ProjectName": "default",
                "RegionId": "cn-shanghai",
                "Retention": 7,
                "ServiceEnableTime": "2024-09-19T03:24:16.000Z",
                "Status": "ON"
            },
            {
                "BackupEnabled": true,
                "DBEngineVersion": "MySQL_8_0",
                "InstanceId": "mysql-d7378eba****",
                "InstanceName": "开启跨地域备份实例4",
                "InstanceStatus": "Running",
                "LogBackupEnabled": true,
                "ProjectName": "default",
                "RegionId": "cn-shanghai",
                "Retention": 7,
                "ServiceEnableTime": "2024-09-26T09:01:14.000Z",
                "Status": "ON"
            }
        ],
        "Total": 4
    }
}

错误码

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