云数据库 SQL Server 查询数据库备份概览信息-API 文档-文档中心-腾讯云

1. 接口描述

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

本接口(DescribeBackupSummary)用于查询数据库备份概览信息。

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

推荐使用 API Explorer

点击调试

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

2. 输入参数

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

参数名称	必选	类型	描述
Action	是	String	公共参数，本接口取值：DescribeBackupSummary。
Version	是	String	公共参数，本接口取值：2018-03-28。
Region	是	String	公共参数，详见产品支持的地域列表。

3. 输出参数

参数名称	类型	描述
FreeSpace	Integer	实际免费总空间，单位(KB)。示例值：1024
ActualUsedSpace	Integer	备份实际使用空间，单位(KB)。示例值：1024
BackupFilesTotal	Integer	备份文件总个数。示例值：680
BillingSpace	Integer	备份占用收费空间，单位(KB)。示例值：1024
DataBackupSpace	Integer	数据备份使用空间，单位(KB)。示例值：1024
DataBackupCount	Integer	数据备份文件总个数。示例值：94
ManualBackupSpace	Integer	数据备份中手动备份使用空间，单位(KB)。示例值：1024
ManualBackupCount	Integer	数据备份中手动备份文件总个数。示例值：40
AutoBackupSpace	Integer	数据备份中自动备份使用空间，单位(KB)。示例值：1024
AutoBackupCount	Integer	数据备份中自动备份文件总个数。示例值：54
LogBackupSpace	Integer	日志备份使用空间，单位(KB)。示例值：1024
LogBackupCount	Integer	日志备份文件总个数。示例值：586
EstimatedAmount	Float	预估收费金额，单位（元/小时）。示例值：0.1
LocalBackupFilesTotal	Integer	本地备份文件总个数示例值：1
CrossBackupFilesTotal	Integer	跨地域备份文件总个数示例值：1
CrossBillingSpace	Integer	跨地域备份占用收费空间，单位（KB）示例值：1
CrossAutoBackupSpace	Integer	跨地域自动数据备份使用空间，单位（KB）示例值：1
CrossAutoBackupCount	Integer	跨地域自动数据备份文件总个数示例值：1
LocalLogBackupSpace	Integer	本地日志备份使用空间，单位（KB）示例值：1
LocalLogBackupCount	Integer	本地日志备份文件总个数示例值：1
CrossLogBackupSpace	Integer	跨地域日志备份使用空间，单位（KB）示例值：1
CrossLogBackupCount	Integer	跨地域日志备份文件总个数示例值：1
CrossEstimatedAmount	Float	跨地域备份预估收费金额，单位（元/小时）示例值：1
RequestId	String	唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 查询数据库备份概览信息

输入示例

https://sqlserver.tencentcloudapi.com/?Action=DescribeBackupSummary
&<公共请求参数>

输出示例

{
    "Response": {
        "ActualUsedSpace": 1193345364,
        "AutoBackupCount": 1615,
        "AutoBackupSpace": 953883130,
        "BackupFilesTotal": 16637,
        "BillingSpace": 605473752,
        "CrossAutoBackupCount": 288,
        "CrossAutoBackupSpace": 146231712,
        "CrossBackupFilesTotal": 3303,
        "CrossBillingSpace": 147469692,
        "CrossEstimatedAmount": 0.114,
        "CrossLogBackupCount": 3015,
        "CrossLogBackupSpace": 1237980,
        "DataBackupCount": 2046,
        "DataBackupSpace": 1183658714,
        "EstimatedAmount": 0.4616,
        "FreeSpace": 440401920,
        "LocalBackupFilesTotal": 13334,
        "LocalLogBackupCount": 11576,
        "LocalLogBackupSpace": 8448670,
        "LogBackupCount": 14591,
        "LogBackupSpace": 9686650,
        "ManualBackupCount": 143,
        "ManualBackupSpace": 83543872,
        "RequestId": "8b5d62cb-40f4-45ba-8a26-a2083d4f9eee"
    }
}

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	数据库错误。
FailedOperation.QueryPriceFailed	计费相关错误，查询价格失败。
InternalError	内部错误。
InternalError.DBError	数据库错误。
InternalError.UnknownError	未知错误。
InvalidParameterValue.IllegalRegion	地域错误。
ResourceNotFound.AccountNotExist	账号不存在。
UnauthorizedOperation.PermissionDenied	cam鉴权错误。

查询数据库备份概览信息

本页目录：