创建云硬盘

最近更新时间:2024-03-12 01:38:06

我的收藏

1. 接口描述

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

本接口(CreateDisks)用于创建一个或多个云硬盘。

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

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

2. 输入参数

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

参数名称 必选 类型 描述
Action String 公共参数,本接口取值:CreateDisks。
Version String 公共参数,本接口取值:2020-03-24。
Region String 公共参数,详见产品支持的 地域列表
Zone String 可用区。可通过DescribeZones返回值中的Zone获取。
示例值:ap-hongkong-2
DiskSize Integer 云硬盘大小, 单位: GB。
示例值:20
DiskType String 云硬盘介质类型。取值: "CLOUD_PREMIUM"(高性能云盘), "CLOUD_SSD"(SSD云硬盘)。
示例值:CLOUD_SSD
DiskChargePrepaid DiskChargePrepaid 云硬盘包年包月相关参数设置。
DiskName String 云硬盘名称。最大长度60。
示例值:test
DiskCount Integer 云硬盘个数。取值范围: [1, 30]。默认值: 1。
示例值:1
DiskBackupQuota Integer 指定云硬盘备份点配额,取值范围: [0, 500]。不传时默认为不带备份点配额。
示例值:1
AutoVoucher Boolean 是否自动使用代金券。默认不使用。
示例值:false
AutoMountConfiguration AutoMountConfiguration 自动挂载并初始化数据盘。

3. 输出参数

参数名称 类型 描述
DiskIdSet Array of String 当通过本接口来创建云硬盘时会返回该参数,表示一个或多个云硬盘ID。返回云硬盘ID列表并不代表云硬盘创建成功。

可根据 DescribeDisks 接口查询返回的DiskSet中对应云硬盘的ID的状态来判断创建是否完成;如果云硬盘状态由“PENDING”变为“UNATTACHED”或“ATTACHED”,则为创建成功。
示例值:["lhdisk-2q0cs4oe"]
RequestId String 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 创建云硬盘

创建云硬盘

输入示例

POST / HTTP/1.1
Host: lighthouse.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: CreateDisks
<公共请求参数>

{
    "DiskCount": 1,
    "DiskChargePrepaid": {
        "Period": 1,
        "TimeUnit": "m"
    },
    "DiskName": "test",
    "DiskType": "CLOUD_PREMIUM",
    "DiskSize": 20,
    "Zone": "ap-hongkong-2",
    "DiskBackupQuota": 1
}

输出示例

{
    "Response": {
        "DiskIdSet": [
            "lhdisk-2q0cs4oe"
        ],
        "RequestId": "69765fd3-56a6-4633-8afd-72ca7805226b"
    }
}

5. 开发者资源

腾讯云 API 平台

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

API Inspector

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

SDK

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

命令行工具

6. 错误码

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

错误码 描述
FailedOperation 操作失败。
FailedOperation.CreateDisksFailed 创建云硬盘失败。
FailedOperation.InsufficientBalance 账户余额不足, 请及时充值。
InvalidParameterValue.DiskInstanceZoneNotMatch 云硬盘的可用区与实例的可用区不匹配。
InvalidParameterValue.InvalidDiskType 云硬盘类型非法。
InvalidParameterValue.InvalidZone 参数Zone的取值不合法。
InvalidParameterValue.PlatformTypeNotSupportFileSystem 实例操作系统不支持该文件系统。
InvalidParameterValue.PlatformTypeNotSupportMountPoint 实例操作系统不支持指定挂载点。
LimitExceeded.AttachDataDiskQuotaLimitExceeded 实例挂载数据盘配额不足,无法挂载云硬盘。
LimitExceeded.DiskQuotaLimitExceeded 当前配额不足,无法创建新的云硬盘。
ResourceNotFound.InstanceIdNotFound 实例 ID 不存在。
UnsupportedOperation.InvalidInstanceState 不支持的操作,实例状态不合法。
UnsupportedOperation.LatestOperationUnfinished 不支持的操作,实例最近一次的操作尚未完成。
UnsupportedOperation.TatAgentNotOnline 实例上腾讯云助手 agent 不在线。