1. 接口描述
接口请求域名: cbs.tencentcloudapi.com 。
本接口用于创建弹性单副本SSD硬盘并自动挂载到指定实例。弹性盘在创建时就需要绑定目标实例,计费回调后由CBS自身完成装箱+挂载的全流程。
默认接口请求频率限制:20次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数。
| 参数名称 | 必选 | 类型 | 描述 |
|---|---|---|---|
| Action | 是 | String | 公共参数,本接口取值:CreateRemoteDisks。 |
| Version | 是 | String | 公共参数,本接口取值:2017-03-12。 |
| Region | 是 | String | 公共参数,详见产品支持的 地域列表。 |
| DiskChargeType | 是 | String | 单副本SSD硬盘计费类型。 枚举值:
示例值:PREPAID |
| DiskSize | 是 | Integer | 单副本SSD硬盘大小,单位为GiB。 取值范围:[2000, 7000] 示例值:2000 |
| InstanceId | 是 | String | 待挂载单副本SSD硬盘的CVM实例ID。 示例值:ins-75askm1r |
| Placement | 是 | Placement | 实例所在的位置。通过该参数可以指定实例所属可用区,所属项目。若不指定项目,将在默认项目下进行创建。 |
| DiskChargePrepaid | 否 | RemoteDiskChargePrepaid | 预付费模式,即包年包月相关参数设置。通过该参数指定包年包月单副本SSD硬盘的购买时长、是否设置自动续费等属性。 创建预付费单副本SSD硬盘该参数必传,创建按小时后付费单副本SSD硬盘无需传该参数。 |
| DiskCount | 否 | Integer | 创建单副本SSD硬盘数量,不传则默认为1。 示例值:1 |
| DiskName | 否 | String | 单副本SSD的显示名称。 示例值:TestRemoteDisk |
3. 输出参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
| RequestId | String | 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 创建弹性单副本SSD硬盘
创建并挂载一块弹性单副本SSD硬盘到指定实例。
输入示例
POST / HTTP/1.1
Host: cbs.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: CreateRemoteDisks
<公共请求参数>
{
"InstanceId": "ins-23kmz0bd",
"DiskSize": 2000,
"DiskChargeType": "PREPAID",
"Placement": {
"Zone": "ap-qingyuan-1"
},
"DiskCount": 1,
"DiskName": "helloworld",
"DiskChargePrepaid": {
"Period": 1
}
}
输出示例
{
"Response": {
"RequestId": "a285b92a-3328-42d0-90df-3aa663c6cb76"
}
}
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. 错误码
该接口暂无业务逻辑相关的错误码,其他错误码详见 公共错误码。