云数据库 SQL Server 查询跨地域备份实时统计列表-API 文档-文档中心-腾讯云

1. 接口描述

接口请求域名： sqlserver.tencentcloudapi.com 。

本接口(DescribeCrossBackupStatistical)用于查询跨地域备份实时统计列表。

默认接口请求频率限制：20次/秒。

推荐使用 API Explorer

点击调试

API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。

2. 输入参数

以下请求参数列表仅列出了接口请求参数和部分公共参数，完整公共参数列表见公共请求参数。

参数名称	必选	类型	描述
Action	是	String	公共参数，本接口取值：DescribeCrossBackupStatistical。
Version	是	String	公共参数，本接口取值：2018-03-28。
Region	是	String	公共参数，详见产品支持的地域列表。
Offset	是	Integer	分页,页数示例值：0
Limit	是	Integer	分页，页大小示例值：10
InstanceIdSet.N	否	Array of String	实例ID列表示例值：[mssql-6upluvd5]
InstanceNameSet.N	否	Array of String	实例名称列表示例值：[name]
CrossBackupStatus	否	String	跨地域备份状态，enable-开启，disable-关闭示例值：enable
CrossRegion	否	String	跨地域备份目标地域示例值：ap-guangzhou
OrderBy	否	String	排序字段，默认default-按照备份空间降序排序，data-按照数据备份排序，log-按照日志备份培训示例值：default
OrderByType	否	String	排序规则（desc-降序，asc-升序），默认desc 示例值：desc

3. 输出参数

参数名称	类型	描述
TotalCount	Integer	跨地域备份概览实时统计总条数示例值：1
Items	Array of CrossSummaryDetailRes	跨地域备份概览实时统计列表
RequestId	String	唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 查询跨地域备份实时统计列表

输入示例

https://sqlserver.tencentcloudapi.com/?Action=DescribeCrossBackupStatistical
&InstanceIdSet.0=mssql-6upluvd5
&InstanceNameSet.0=name
&CrossBackupStatus=enable
&CrossRegion=guangzhou
&OrderBy=default
&OrderByType=desc
&Offset=0
&Limit=10
&<公共请求参数>

输出示例

{
    "Response": {
        "RequestId": "1fed8472-f117-11ec-be47-525400853186",
        "TotalCount": 1,
        "Items": [
            {
                "ActualUsedCount": 4937,
                "ActualUsedSpace": 554778704,
                "CrossBackupEnabled": "enable",
                "CrossBackupSaveDays": 7,
                "CrossRegions": [
                    "ap-shanghai"
                ],
                "DataBackupCount": 1019,
                "DataBackupSpace": 550868544,
                "InstanceId": "mssql-1ybz12wb",
                "LastBackupStartTime": "2022-06-21 13:57:17",
                "LogBackupCount": 3918,
                "LogBackupSpace": 3910160,
                "Name": "xinyuanxu-new",
                "Region": "ap-guangzhou",
                "Status": 2
            }
        ]
    }
}

5. 开发者资源

腾讯云 API 平台

腾讯云 API 平台是综合 API 文档、错误码、API Explorer 及 SDK 等资源的统一查询平台，方便您从同一入口查询及使用腾讯云提供的所有 API 服务。

API Inspector

用户可通过 API Inspector 查看控制台每一步操作关联的 API 调用情况，并自动生成各语言版本的 API 代码，也可前往 API Explorer 进行在线调试。

SDK

云 API 3.0 提供了配套的开发工具集（SDK），支持多种编程语言，能更方便的调用 API。

Tencent Cloud SDK 3.0 for Python: GitHub Gitee
Tencent Cloud SDK 3.0 for Java: GitHub Gitee
Tencent Cloud SDK 3.0 for PHP: GitHub Gitee
Tencent Cloud SDK 3.0 for Go: GitHub Gitee
Tencent Cloud SDK 3.0 for Node.js: GitHub Gitee
Tencent Cloud SDK 3.0 for .NET: GitHub Gitee
Tencent Cloud SDK 3.0 for C++: GitHub Gitee
Tencent Cloud SDK 3.0 for Ruby: GitHub Gitee

命令行工具

Tencent Cloud CLI 3.0

6. 错误码

以下仅列出了接口业务逻辑相关的错误码，其他错误码详见公共错误码。

错误码	描述
FailedOperation.DBError	数据库错误。
InternalError.DBError	数据库错误。
InvalidParameter.InputIllegal	输入错误。
InvalidParameterValue.IllegalRegion	地域错误。
UnauthorizedOperation.PermissionDenied	cam鉴权错误。

查询跨地域备份实时统计列表

本页目录：