查询备份实时统计列表

最近更新时间:2024-03-12 01:47:21

我的收藏

1. 接口描述

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

本接口(DescribeBackupStatistical)用于查询备份实时统计列表。

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

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

2. 输入参数

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

参数名称 必选 类型 描述
Action String 公共参数,本接口取值:DescribeBackupStatistical。
Version String 公共参数,本接口取值:2018-03-28。
Region String 公共参数,详见产品支持的 地域列表
Limit Integer 分页返回,每页返回的数目,取值为1-100,默认值为100
示例值:10
Offset Integer 分页返回,页编号,默认值为第0页。
示例值:0
InstanceIdSet.N Array of String 一个或者多个实例ID。实例ID,格式如:mssql-si2823jyl。
示例值:[mssql-7vfv3rk3]
InstanceNameSet.N Array of String 实例名称列表,模糊查询。
示例值:[name]
OrderBy String 排序字段,默认default,则按照备份空间降序。
default 按照备份空间排序
data 数据备份排序
log 日志备份排序
auto 自动备份排序
manual 手动备份排序
示例值:default
OrderByType String 默认降序,[desc-降序,asc-升序]。
示例值:desc

3. 输出参数

参数名称 类型 描述
TotalCount Integer 符合条件的实例总数。分页返回的话,这个值指的是所有符合条件的实例的个数,而非当前根据Limit和Offset值返回的实例个数。
示例值:1
Items Array of SummaryDetailRes 实例列表。
RequestId String 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。

4. 示例

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

输入示例

https://sqlserver.tencentcloudapi.com/?Action=DescribeBackupStatistical
&InstanceIdSet.0=mssql-3l3fgqn7
&InstanceNameSet.0=数仓
&Offset=0
&Limit=3
&OrderBy=data
&OrderByType=desc
&<公共请求参数>

输出示例

{
    "Response": {
        "Items": [
            {
                "ActualUsedSpace": 1003844420,
                "AutoBackupCount": 9190,
                "AutoBackupSpace": 920300548,
                "DataBackupCount": 1706,
                "DataBackupSpace": 996004980,
                "InstanceId": "mssql-1ybz12wb",
                "LogBackupCount": 7627,
                "LogBackupSpace": 7839440,
                "ManualBackupCount": 143,
                "ManualBackupSpace": 83543872,
                "Name": "xinyuanxu-new",
                "Region": "ap-guangzhou",
                "RegionId": 1,
                "Status": 2
            }
        ],
        "RequestId": "c3ea3ea0-f0a2-11ec-94dd-525400853186",
        "TotalCount": 17
    }
}

5. 开发者资源

腾讯云 API 平台

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

API Inspector

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

SDK

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

命令行工具

6. 错误码

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

错误码 描述
FailedOperation.DBError 数据库错误。
InternalError 内部错误。
UnauthorizedOperation.PermissionDenied cam鉴权错误。