创建云硬盘参数转换

最近更新时间: 2026-09-17 00:00:49

1. 接口描述

接口请求域名： cbs.api3.fincloud.tencent.cn。

本接口（SwitchParameterCreateDisks）用于得到创建云硬盘的订单参数。

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

接口更新时间：2024-07-16 06:58:53。

接口只验签名不鉴权。

2. 输入参数

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

参数名称	必选	允许NULL	类型	描述
Action	是	否	String	公共参数，本接口取值：SwitchParameterCreateDisks
Version	是	否	String	公共参数，本接口取值：2017-03-12
Region	是	否	String	公共参数，地域信息可通过DescribeRegions接口查看产品支持的地域列表
DiskSize	否	否	Uint64	云硬盘大小，单位为GB。如果传入`SnapshotId`则可不传`DiskSize`，此时新建云盘的大小为快照大小如果传入`SnapshotId`同时传入`DiskSize`，则云盘大小必须大于或等于快照大小云盘大小取值范围：普通云硬盘:10GB ~~4000G；高性能云硬盘:50GB~~ 4000GB；SSD云硬盘:100GB ~ 4000GB。步长均为10GB 示例值： 10
DiskType	是	否	String	硬盘介质类型。取值范围： CLOUD_BASIC：表示普通云硬盘 CLOUD_PREMIUM：表示高性能云硬盘 CLOUD_SSD：表示SSD云硬盘。示例值： CLOUD_BASIC
DiskCount	否	否	Uint64	购买数量。单次请求最多可创建的云盘数有限制，具体参见云硬盘使用限制。默认取值为1。示例值： 1
DiskChargeType	是	否	String	付费模式，目前只有预付费，即只能取值为PREPAID。示例值： PREPAID
DiskUsage	否	否	String	指定创建系统盘或数据盘。取值范围： SYSTEM_DISK：表示系统盘 DATA_DISK：表示数据盘。示例值： DATA_DISK
DiskChargePrepaid	是	否	DiskChargePrepaid	预付费模式，即包年包月相关参数设置。通过该参数可以指定包年包月云盘的购买时长、是否设置自动续费等属性。示例值：查看
Placement	是	否	Placement	云硬盘所在的位置。通过该参数可以指定云硬盘所属可用区，所属项目。若不指定项目，将在默认项目下进行创建。示例值：查看
SnapshotId	否	否	String	快照ID，如果传入则根据此快照创建云硬盘，快照类型必须为数据盘快照，可通过DescribeSnapshots接口查询快照，见输出参数DiskUsage解释。示例值： snap-4zgc8cnk
DiskName	否	否	String	云盘显示名称。不传则默认为“未命名”。最大长度不能超60个字节。示例值： Untitled
Encrypt	否	否	String	传入该参数用于创建加密云盘，取值固定为ENCRYPT。示例值： ENCRYPT
Tags	否	否	Array of Tag	云盘绑定的标签。示例值：查看
AutoSnapshotPolicyId	否	否	String	定期快照策略ID。传入此参数时，当云硬盘创建成功后将会自动绑定该定期快照策略示例值： asp-mrsrn243
Shareable	否	否	Bool	可选参数，默认为False。传入True时，云盘将创建为共享型云盘。示例值： False
DiskStoragePoolGroup	否	否	String	资源池组示例值： pool-ec
PlatformProjectId	否	否	String	项目ID 示例值： pr-42749a13

3. 输出参数

参数名称	类型	描述
DiskOrder	Array of DiskOrder	计费订单参数。示例值：查看
RequestId	String	唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。

4. 错误码

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

错误码	描述
MissingParameter	参数缺失。请求没有带必选参数。
InvalidParameterValue	无效参数值。参数值格式错误或者参数值不被支持等。

5. 示例

示例1 创建云盘订单参数转换

输入示例

https://cbs.api3.fincloud.tencent.cn/?Action=SwitchParameterCreateDisks
&Version=2017-03-12
&DiskType=CLOUD_BASIC
&DiskCount=1
&DiskSize=10
&Placement.Zone=ap-region1-2
&Placement.ProjectId=0
&DiskChargeType=PREPAID
&DiskChargePrepaid.Period=2
&DiskChargePrepaid.RenewFlag=NOTIFY_AND_AUTO_RENEW
&<公共请求参数>

输出示例

{
    "Response": {
        "DiskOrder": {
            "GoodsCategoryId": 100058,
            "GoodsNum": 1,
            "ProjectId": 0,
            "GoodsDetail": {
                "TimeSpan": 2,
                "Pid": 10381,
                "DiskType": "data",
                "ProductInfo": [
                    {
                        "Name": "磁盘属性",
                        "Value": "数据盘"
                    },
                    {
                        "Name": "磁盘类型",
                        "Value": "普通云盘"
                    },
                    {
                        "Name": "容量",
                        "Value": "10GB"
                    },
                    {
                        "Name": "可用区",
                        "Value": "region1二区"
                    }
                ],
                "MediumType": "cbs",
                "TimeUnit": "m",
                "CbsSize": 10
            },
            "RegionId": "1",
            "ZoneId": 100002,
            "PayMode": 1,
            "Type": "cbs"
        },
        "RequestId": "55db49cf-b9d7-da27-825b-5a02ba6884ca"
    }
}