1. 接口描述
接口请求域名： cbs.tencentcloudapi.com 。
本接口用于查询已购买的单副本SSD硬盘列表。可根据单副本SSD硬盘ID、类型、状态等条件过滤查询结果。
默认接口请求频率限制：20次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数，完整公共参数列表见 公共请求参数。
| 参数名称 | 必选 | 类型 | 描述 |
|---|---|---|---|
| Action | 是 | String | 公共参数，本接口取值：DescribeRemoteDisks。 |
| Version | 是 | String | 公共参数，本接口取值：2017-03-12。 |
| Region | 是 | String | 公共参数，详见产品支持的 地域列表。 |
| Filters.N | 否 | Array of Filter | 过滤条件。此参数不支持与 RemoteDiskIds 同时指定。 |
3. 输出参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
| RemoteDiskSet | Array of RemoteDiskDetail | 单副本SSD硬盘的详细信息列表。 |
| TotalCount | Integer | 符合条件的单副本SSD硬盘数量。 示例值：1 |
| RequestId | String | 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 按条件查询单副本SSD硬盘列表
按状态过滤查询单副本SSD硬盘。
输入示例
POST / HTTP/1.1
Host: cbs.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeRemoteDisks
<公共请求参数>
{
"Filters": [
{
"Name": "remote-disk-state",
"Values": [
"ATTACHED"
]
}
]
}输出示例
{
"Response": {
"RemoteDiskSet": [
{
"CreateTime": "2026-08-17T09:57:06+08:00",
"DeadlineTime": "2026-10-17T18:11:09+08:00",
"DiskChargeType": "PREPAID",
"DiskSize": 2000,
"InstanceId": "ins-1zmijkcu",
"Placement": {
"CageId": "",
"CdcId": "",
"CdcName": "",
"DedicatedClusterId": "",
"ProjectId": 0,
"ProjectName": "",
"Zone": "ap-guangzhou-2"
},
"RemoteDiskId": "rdisk-80wdaldb",
"RemoteDiskName": "未命名",
"RemoteDiskState": "ATTACHED",
"RemoteDiskType": "ELASTIC_REMOTE_SSD",
"RenewFlag": "DISABLE_NOTIFY_AND_MANUAL_RENEW"
}
],
"TotalCount": 2,
"RequestId": "55e81553-b057-4a64-8e63-590d84aa2d7f"
}
}示例2 查询单副本SSD硬盘列表
输入示例
POST / HTTP/1.1
Host: cbs.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeRemoteDisks
<公共请求参数>
{}输出示例
{
"Response": {
"RemoteDiskSet": [
{
"CreateTime": "2026-05-22T03:44:36+08:00",
"DeadlineTime": "2026-06-22T11:44:36+08:00",
"DiskChargeType": "PREPAID",
"DiskSize": 3000,
"InstanceId": "ins-kmmjtaxw",
"Placement": {
"CageId": "",
"CdcId": "",
"CdcName": "",
"DedicatedClusterId": "",
"ProjectId": 0,
"ProjectName": "",
"Zone": "ap-guangzhou-2"
},
"RemoteDiskId": "rdisk-4idfknif",
"RemoteDiskName": "未命名",
"RemoteDiskState": "ATTACHED",
"RemoteDiskType": "ELASTIC_REMOTE_SSD",
"RenewFlag": "NOTIFY_AND_MANUAL_RENEW"
}
],
"TotalCount": 1,
"RequestId": "b15edc0e-549d-4160-8796-78881ea55d48"
}
}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. 错误码
该接口暂无业务逻辑相关的错误码，其他错误码详见 公共错误码。
