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

文档中心

立即注册

导航

DescribeCrossRegionBackupDBInstances

最近更新时间：2025.06.06 10:53:59首次发布时间：2025.06.06 10:13:03

调用 DescribeCrossRegionBackupDBInstances 接口查询当前地域下已开启跨地域备份的实例列表。

请求类型

同步请求。

调试

API Explorer

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

去调试

请求参数

名称	类型	是否必选	示例值	描述
InstanceId	String	否	vedbm-gzwdsf9b****	实例 ID。说明您可以调用 DescribeDBInstances 接口查询实例 ID。
ProjectName	String	否	default	实例所属项目名称。
PageSize	Integer	否	10	每页记录数。取值范围 1~1000，默认值为 10。
PageNumber	Integer	否	1	页码，取值大于等于 1，且不超过 Integer 的最大值，默认值为 1。

返回参数

名称	类型	示例值	描述
Total	Integer	5	符合查询条件的结果总数。
CrossRegionBackupDBInstance	Array of CrossRegionBackupDBInstance	请参见返回示例。	已开启跨地域备份的实例列表信息。关于 CrossRegionBackupDBInstance 的详细信息，请参见 CrossRegionBackupDBInstance。

请求示例

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

{
    "PageSize": 10,
    "PageNumber": 1
}

返回示例

{
    "ResponseMetadata": {
        "RequestId": "20250320172531DA7156E758727CC237FF-de1d98",
        "Action": "DescribeCrossRegionBackupDBInstances",
        "Version": "2022-01-01",
        "Service": "vedbm",
        "Region": "cn-beijing"
    },
    "Result": {
        "CrossRegionBackupDBInstance": [
            {
                "CrossRegionBackup": true,
                "DBEngineVersion": "MySQL_8_0",
                "DBRevisionVersion": "3.0.1.1",
                "InstanceId": "vedbm-d4mx2akm****",
                "LowerCaseTableNames": "1",
                "ProjectName": "default",
                "RegionId": "cn-beijing",
                "Retention": 7,
                "TargetRegion": "cn-shanghai"
                "TimeZone": "UTC +08:00"
            }
        ],
        "Total": 1
    }
}

错误码

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