1. 接口描述
接口请求域名: bdrc.tencentcloudapi.com 。
查询备份组列表
默认接口请求频率限制:20次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数。
| 参数名称 | 必选 | 类型 | 描述 |
|---|---|---|---|
| Action | 是 | String | 公共参数,本接口取值:DescribeBackupGroups。 |
| Version | 是 | String | 公共参数,本接口取值:2026-03-30。 |
| Region | 是 | String | 公共参数,详见产品支持的 地域列表。 |
| Filters.N | 否 | Array of FilterModel | 过滤条件。backup-group-id - Array of String - 是否必填:否 -(过滤条件)按备份组ID过滤 ;backup-group-state - Array of String - 是否必填:否 -(过滤条件)按备份组状态过滤。(NORMAL: 正常 | CREATING:创建中 | ROLLBACKING:回滚中) ;backup-group-name - Array of String - 是否必填:否 -(过滤条件)按备份组名称过滤 ;backup-id - Array of String - 是否必填:否 -(过滤条件)按备份组内的备份ID过滤 |
| Offset | 否 | Integer | 偏移量,默认0 示例值:0 |
| Limit | 否 | Integer | 返回数量,默认20,最大500 示例值:20 |
| Order | 否 | String | 排序方式 示例值:ASC |
| OrderField | 否 | String | 排序字段。目前支持CREATE_TIME。 示例值:CREATE_TIME |
3. 输出参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
| TotalCount | Integer | 符合条件的总数量。 示例值:4 |
| BackupGroupSet | Array of BackupGroup | 备份列表详情。 |
| RequestId | String | 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 查询实例备份列表
输入示例
POST / HTTP/1.1
Host: bdrc.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeBackupGroups
<公共请求参数>
{
"Limit": 1
}
输出示例
{
"Response": {
"BackupGroupSet": [
{
"AccountName": "",
"AccountUin": "700002507474",
"AppId": 260094408,
"AutoBackupPolicyId": "abp-fys0uzmf",
"BackupBindDisk": [
{
"BackupId": "backup-lnlg6z35",
"DiskId": "disk-f6wjotd4"
}
],
"BackupGroupId": "cbackup-9mge8cx1",
"BackupGroupName": "auto_ins-kjpsunqm_20260430_00",
"BackupGroupState": "NORMAL",
"CreateTime": "2026-04-30T00:15:20+08:00",
"DeadlineTime": null,
"InstanceDetails": "{\"Placement\": {\"Zone\": \"ap-guangzhou-2\", \"HostId\": null, \"ProjectId\": 0, \"ProjectName\": \"\\u9ed8\\u8ba4\\u9879\\u76ee\"}, \"InstanceId\": \"ins-kjpsunqm\", \"Uuid\": \"15b65cc6-47b9-4271-a2a4-24552aba54dc\", \"OperatorUin\": \"4611686018428206758\", \"InstanceState\": \"STOPPED\", \"ApplicationRole\": \"\", \"RestrictState\": \"NORMAL\", \"InstanceType\": \"SA9.MEDIUM2\", \"CPU\": 2, \"Memory\": 2, \"InstanceName\": \"FROM cbackup-orpxx9gp\", \"InstanceChargeType\": \"PREPAID\", \"SystemDisk\": {\"DiskType\": \"CLOUD_BSSD\", \"DiskId\": \"disk-f6wjotd4\", \"DiskSize\": 50, \"Encrypt\": false, \"KmsKeyId\": null, \"ThroughputPerformance\": 0, \"CdcId\": null}, \"DataDisks\": [], \"PrivateIpAddresses\": [\"172.16.0.2\"], \"PublicIpAddresses\": null, \"IPv6Addresses\": null, \"InternetAccessible\": {\"InternetMaxBandwidthOut\": 1, \"InternetChargeType\": null}, \"VirtualPrivateCloud\": {\"VpcId\": \"vpc-hj1e0yef\", \"SubnetId\": \"subnet-8hu0ievu\", \"AsVpcGateway\": false, \"VpcName\": \"Default-VPC\", \"SubnetName\": \"Default-Subnet\"}, \"SecurityGroupIds\": [\"sg-kqieqb8n\"], \"LoginSettings\": {\"KeyIds\": null}, \"ImageId\": \"img-6n21msk1\", \"DefaultLoginUser\": \"root\", \"DefaultLoginPort\": 22, \"RenewFlag\": \"NOTIFY_AND_AUTO_RENEW\", \"CreatedTime\": \"2026-04-22T09:57:42Z\", \"ExpiredTime\": \"2026-05-22T09:57:42Z\", \"UnderwriteExpiredTime\": null, \"Tags\": [], \"PlatformProjectId\": null, \"DisasterRecoverGroupId\": \"\", \"DedicatedClusterId\": \"\", \"CamRoleName\": \"\", \"LatestOperation\": \"RollbackInstanceSnapshot\", \"LatestOperationState\": \"SUCCESS\", \"LatestOperationRequestId\": \"3e55411e-ce86-456e-8f17-7a17c41c7d10\", \"IsolatedSource\": \"NOTISOLATED\", \"ChcInstanceType\": \"\", \"HpcClusterId\": \"\", \"DisableApiTermination\": false, \"RdmaIpAddresses\": null, \"VmEniTrunking\": \"off\", \"OsName\": \"TencentOS Server 4 for x86_64\", \"EnableJumboFrame\": false, \"LicenseType\": \"TencentCloud\", \"StopChargingMode\": \"NOT_APPLICABLE\", \"CpuTopology\": {\"ThreadPerCore\": 2, \"CoreCount\": 1}, \"ImageType\": \"PUBLIC_IMAGE\", \"InstanceFamily\": \"SA9\", \"GPU\": 0, \"InnerVpcId\": 11314404, \"DeviceId\": 637560910, \"Architecture\": \"\", \"IsolatedTime\": null, \"IsSafeIsolated\": false, \"SafeIsolatedInfo\": null, \"NewCreationIdentify\": false, \"InstanceClass\": \"S\", \"KeyPairIds\": null, \"OperationMask\": 2002494157813, \"RunFlag\": 4, \"Hypervisor\": 0, \"SwapDisks\": {}, \"LatestOperationErrorMsg\": null, \"BootMode\": \"Legacy BIOS\"}",
"InstanceId": "ins-kjpsunqm",
"IsPermanent": false,
"ModifyTime": "2026-04-30T00:16:31+08:00",
"Percent": 100,
"SubAccountUin": "700002507474"
}
],
"TotalCount": 172,
"RequestId": "be6a944e-8e47-4a47-a61f-ad448e3a551a"
}
}
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: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for Java: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for PHP: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for Go: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for Node.js: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for .NET: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for C++: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for Ruby: CNB, GitHub, Gitee
命令行工具
6. 错误码
以下仅列出了接口业务逻辑相关的错误码,其他错误码详见 公共错误码。
| 错误码 | 描述 |
|---|---|
| InternalError | 内部错误。 |
| InternalError.ComponentError | 第三方组件错误 |
| InvalidParameter.InvalidFilter | 过滤参数非法 |
| InvalidParameter.MissingParameter | 参数缺失 |
| InvalidParameter.ParameterError | 参数错误 |
| InvalidParameterValue | 参数取值错误。 |
| MissingParameter | 缺少参数错误。 |
| UnauthorizedOperation | 未授权操作。 |