创建启动配置

最近更新时间:2018-09-19 11:01:44

1. 接口描述

本接口(CreateScalingConfiguration)用于创建新的启动配置。
接口请求域名:

scaling.api.qcloud.com

1)启动配置无法编辑更改。如需使用新的启动配置,只能重新创建新的启动配置。

2)创建启动配置时,必须要选择镜像,用来确定新创建实例的系统盘配置。

3)创建启动配置时,当前仅支持指定一个安全组,具体相关限制详见创建实例

4)系统盘类型与数据盘类型一致。

5)每个项目最多只能创建20个启动配置,详见使用限制

2. 输入参数

以下请求参数列表仅列出了接口请求参数,正式调用时需要加上公共请求参数,见公共请求参数页面。其中,此接口的Action字段为CreateScalingConfiguration。

参数名称 是否必选 类型 描述
scalingConfigurationName String 用户设定的启动配置名称。
imageId String 镜像ID。请填写查询可用的镜像列表(DescribeImages)接口中返回的unImgId(统一镜像ID)字段。
cpu Int CPU核数,各个地域可选的CPU核数不一样,详情见文档CVM实例配置
mem Int 内存大小,单位为GB,各个地域可选的内存大小不一样,详情见文档CVM实例配置
storageType Int 数据盘类型。有四种取值:若为1,表示本地硬盘;若为2,表示普通云硬盘;若为3,表示本地SSD硬盘;若为5,表示SSD云硬盘;若为6,表示高性能云硬盘。
storageSize Int 数据盘大小,单位为GB,步长为10GB。若为本地盘,可选范围在0-500G;若为云硬盘,可选范围在0-4000G。具体限制详见产品分类
bandwidthType String 带宽的类型。只有两种取值:若为PayByHour,表示按带宽使用时长计费;若为PayByTraffic,表示按流量计费。如果是共享带宽用户,此参数取值将忽略。
bandwidth Int 公网带宽大小。单位为Mbps。若为0,表示不开通公网带宽。不同机型带宽上限范围不一致,具体限制详见公网网络带宽上限。如果是共享带宽用户,此参数取值范围为 0-200 或 65535,65535表示带宽无上限。
imageType Int 镜像类型。取值范围:
1:表示私有镜像;
2:表示公共镜像;
3:表示服务市场镜像。
rootSize Int 系统盘大小,单位为GB。linux系统默认为50GB,步长为1GB。windows不可调整,默认为50GB。
keyId String 密钥ID,可调用查询密钥(DescribeKeyPairs)接口查询。
password String 实例密码,未设置则密码为随机产生。linux主机的密码规则是:至少要包含字母、数字、特殊字符!@#$%^*() 中的两种,且密码长度为8-16个字符。 windows主机的密码规则是:至少要包含大写字母、小写字母、数字、特殊字符!@#*中的三种,且密码长度为12-16个字符。注意:密钥与密码不能同时指定。
needMonitorAgent Int 是否开启云监控服务。只有两种取值:若为1,表示开通,若为0,表示不开通。默认是开通的。
needSecurityAgent Int 是否开启云安全服务。只有两种取值:若为1,表示开通,若为0,表示不开通。默认是开通的。
wanIp Int 是否开通外网IP。只有两种取值:若为1,表示开通,若为0,表示不开通。默认是开通的。
sgId String 安全组ID,可调用查询安全组列表接口查询。
projectId String 项目ID,不传为0,表示默认项目。如需指定其他项目,可调用查询项目列表(DescribeProject)接口查询。
dataSnapshotId String 数据盘快照ID,如果使用数据盘快照功能,数据盘类型(storageType)须为云盘;并且数据盘快照的容量必须小于数据盘的容量(storageSize)。
cvmType String 选择云服务器类型。取值如下:
11:标准型S1
12:标准型S2
13:标准型S3
21:高IO型I1
22:高IO型I2
31:内存型M1
32:内存型M2
42:计算型C2
43:计算型C3

不传此字段默认为11(标准型S1)。

启动配置支持云服务器的CPU和内存大小详情见CVM实例配置

3. 输出参数

参数名称 类型 描述
code Int 公共错误码, 0表示成功,其他值表示失败。详见错误码页面的公共错误码
codeDesc String 业务侧错误码。成功时返回Success,错误时返回具体业务错误原因。
message String 模块错误信息描述,与接口相关。
data Array 输出结果,包含成功创建的启动配置列表信息。

其中,data参数的构成如下,只有一个元素scalingConfigurationIdSet。

参数名称 类型 描述
scalingConfigurationIdSet Array 创建的各个启动配置的Id。

4. 错误码

以下错误码表仅列出了该接口的业务逻辑错误码,更多公共错误码详见AS错误码

错误码 描述
QuotaExceeded.ScallingConfiguration 启动配置添加超过上限
NameDuplicate.ScallingConfiguration 启动配置名称已存在
InvalidParameter.SecurityGroupId 安全组Id不正确
IInvalidParameter.CbsNotMatchCpu 1C1G只能配置云盘
InvalidParameter.storageType 存储类型错误
QuotaExceeded.storageSize 数据盘大小超出范围
QuotaExceeded.rootSize 系统盘大小超出范围
OprationFail.CpuOrMemNotExsit 此cpu和mem的机型已售空或不存在

5. 示例

https://scaling.api.qcloud.com/v2/index.php?
&<Common request parameters>
&scalingConfigurationName=configuration_test
&imageType=2
&imageId=img-50mr2ow7
&cpu=1
&mem=2
&storageType=6
&storageSize=100
&bandwidthType=PayByTraffic
&bandwidth=1
&projectId=0
&cvmType=12

返回示例如下:

{
    "code":"0",
    "message":"",
    "codeDesc":"Success",      
    "data":{
        "scalingConfigurationIdSet":[
            "asc-4jwggk1l"
        ]
    }
}