创建轻量型云主机
接口功能介绍
该接口提供用户创建一台包年包月的轻量型云主机
接口约束
- 使用限制，本接口只支持在贵州3资源池进行公测
URI
POST /v4/ecs/lite/create
路径参数
无
Query参数
无
请求参数
请求头header参数
无
请求体body参数
| 参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|---|
| clientToken | 是 | String | 客户端存根，用于保证订单幂等性。要求单个云平台账户内唯一，使用同一个ClientToken值，其他请求参数相同时，则代表为同一个请求。保留时间为24小时 | 4cf2962d-e92c-4c00-9181-cfbb2218636c | |
| regionID | 是 | String | 资源池ID，您可以调用regionID查看最新的天翼云资源池列表 | 100054c0416811e9a6690242ac110002 | |
| displayName | 是 | String | 云主机显示名称，长度为2-15字符 | ecm-3300 | |
| flavorSetType | 是 | String | 规格套餐类型，取值范围：fix：固定套餐band：带宽套餐 | fix | |
| flavorName | 是 | String | 规格套餐名称 | lite1.fix.small.1 | |
| imageID | 是 | String | 镜像ID | 9d9e8998-8ed5-43b2-99cb-322f2b8cf6fa | |
| cycleCount | 是 | Integer | 订购时长 | 6 | |
| cycleType | 是 | String | 本参数表示订购周期类型 ，取值范围：MONTH：按月YEAR：按年最长订购周期为5年 | MONTH | |
| bootDiskSize | 否 | Integer | 带宽套餐时填写，系统盘大小单位为GiB，您可以调用[查询轻量型云主机规格资源]获取套餐系统盘取值范围 | 40 | |
| bandwidth | 否 | Integer | 带宽套餐时填写，带宽大小单位为Mbit/s ，您可以调用[查询轻量型云主机规格资源]获取套餐带宽取值范围 | 5 | |
| dataDiskList | 否 | Array of Objects | 数据盘 | disks | |
| userPassword | 否 | String | 用户密码，满足以下规则：长度在8～30个字符;必须包含大写字母、小写字母、数字以及特殊符号中的三项;特殊符号可选：()`~!@#$%^&*_-+=\｜{}[]:;'<>,.?/ 且不能以斜线号/开头 | 1qaz@WSX | |
| autoRenewStatus | 否 | Integer | 本参数表示是否自动续订 ，取值范围：0：不续费1：自动续费按月购买：自动续订周期为1个月;按年购买：自动续订周期为1年 | 1 |
表 disks
| 参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|---|
| diskName | 是 | String | 磁盘名称 ，长度2~63,不支持中文 | lite-disk | |
| diskSize | 是 | Integer | 磁盘容量大小单位为GiB，取值范围[10-32768] | 50 |
响应参数
| 参数 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|
| statusCode | Integer | 返回状态码(800为成功，900为失败) | 800 | |
| errorCode | String | 业务细分码，为product.module.code三段式码，详见错误码说明 | Openapi.PatternCheck.NotValid | |
| message | String | 失败时的错误描述，一般为英文描述 | SUCCESS | |
| description | String | 失败时的错误描述，一般为中文描述 | 成功 | |
| returnObj | Object | 成功时返回的数据 | returnObj |
表 returnObj
| 参数 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|
| masterOrderID | String | 订单ID。调用方在拿到masterOrderID之后，在若干错误情况下，可以使用materOrderID进一步确认订单状态及资源状态 | 235145e4489811eda8330242ac110002 | |
| masterOrderNO | String | 订单号 | 20221010142913884246 | |
| masterResourceID | String | 主资源ID | 3cda4bf48cac42b8b7db3b279d2fc6fb | |
| regionID | String | 资源所属资源池ID | 81f7728662dd11ec810800155d307d5b |
请求示例
请求头header
无
请求体body
{
"regionID": "81f7728662dd11ec810800155d307d5b",
"clientToken": "create-fix-lite-vm-0711-01",
"displayName": "openapi-fix-01",
"flavorSetType": "fix",
"flavorName": "lite1.fix.medium.2",
"imageID": "dca942b0-e934-4bd5-b5c1-4f5e1aad56a6",
"cycleCount": 2,
"cycleType": "MONTH",
"autoRenewStatus": 0,
"userPassword": "1qaz@WSX",
"dataDiskList": [{
"diskName": "vm-0710-01",
"diskSize": 20
}]
}
响应示例
{
"returnObj": {
"regionID": "81f7728662dd11ec810800155d307d5b",
"masterOrderID": "107e901c449611ed8b6a0242ac110002",
"masterResourceID": "34c7cc05a52b48eda0a84e34a82b346b",
"masterOrderNO": "20221009163836430197"
},
"message": "SUCCESS",
"description": "成功",
"statusCode": 800
}
状态码
| 状态码 | 描述 |
|---|---|
| 200 | 表示请求成功。 |
错误码
| errorCode | 描述 |
|---|---|
| Openapi.PatternCheck.NotValid | 请求参数无效 |
| LiteEcs.Parameter.InvalidError | 请求参数错误 |
| LiteEcs.RegionInfo.Empty | 查询资源池信息为空或资源池不存在，请确认资源池ID是否有效 |
| LiteEcs.RegionInfo.AccessFailed | 查询资源池失败，请重试。如果多次尝试失败，请提交工单 |
| LiteEcs.RegionInfo.DataDamaged | 查询资源池信息不符预期，请重试。如果多次尝试失败，请提交工单 |
| LiteEcs.RegionVersion.NotSupport | 当前API不支持该资源池，请切换资源池重试 |
| LiteEcs.UserVisibleRegions.DataDamaged | 查询用戶可见资源池信息格式错误，请重试。如果多次尝试失败，请提交工单 |
| LiteEcs.UserVisibleRegions.AccessFailed | 查询用戶可见资源池失败，请重试。如果多次尝试失败，请提交工单 |
| LiteEcs.Parameter.InvalidRegionID | 可见资源池信息为空，请确认regionID是否正确 |
| Openapi.CustomerAdmin.AccessFailed | 查询用户信息错误，请重试。如果多次尝试失败，请提交工单 |
| Openapi.CustomerAdmin.FormatError | 查询用户信息格式错误，请重试。如果多次尝试失败，请提交工单 |
| Openapi.CustomerCheck.UnknownError | 查询用户信息失败，请重试。如果多次尝试失败，请提交工单 |
| LiteEcs.UserQuota.AccessFailed | 查询用户配额信息失败，请重试。如果多次尝试失败，请提交工单 |
| LiteEcs.UserQuota.Empty | 查询用户配额信息为空，请重试。如果多次尝试失败，请提交工单 |
| LiteEcs.UserQuota.DataDamaged | 查询用户配额信息不符预期，请重试。如果多次尝试失败，请提交工单 |
| Openapi.PermissionAdmin.AccessFailed | 查询用户许可信息错误，请重试。如果多次尝试失败，请提交工单 |
| Openapi.PermissionAdmin.FormatError | 查询用户资源池许可信息错误，请重试。如果多次尝试失败，请提交工单 |
| Openapi.PermissionCheck.UnknownError | 查询用户许可信息失败，请重试。如果多次尝试失败，请提交工单 |
| LiteEcs.Instance.ParameterInvalid | 请求参数错误 |
| LiteEcs.Instance.FlavorNotFound | 未找到对应的云主机规格，请确认输入的云主机规格信息是否有效 |
| Openapi.FlavorAdmin.AccessFailed | 查询云主机规格失败，请重试。如果多次尝试失败，请提交工单 |
| Openapi.FlavorAdmin.FormatError | 查询云主机规格信息格式错误，请重试。如果多次尝试失败，请提交工单 |
| Openapi.EcsWorkorder.AccessFailed | 查询云主机失败，请重试。如果多次尝试失败，请提交工单 |
| Openapi.EcsFormat.FormatError | 查询云主机信息格式错误，请重试。如果多次尝试失败，请提交工单 |
| LiteEcs.Instance.QuotaExceed | 超出系统限额 |
| LiteEcs.Instance.QuotaUnknownError | 配额检查失败，请重试。如果多次尝试失败，请提交工单 |
| LiteEcs.UserPermission.AccessFailed | 查询用户权限失败，请重试。如果多次尝试失败，请提交工单 |
| LiteEcs.UserPermission.Empty | 查询用户权限信息为空，请重试。如果多次尝试失败，请提交工单 |
| LiteEcs.UserDetail.AccessFailed | 查询用户详情信息失败，请重试。如果多次尝试失败，请提交工单 |
| LiteEcs.UserDetail.Empty | 查询用户详情信息为空，请重试。如果多次尝试失败，请提交工单 |
| LiteEcs.UserDetail.DataDamaged | 查询用户详情信息不符预期，请重试。如果多次尝试失败，请提交工单 |
| Image.ImageFormat.FormatError | 查询镜像信息格式错误，请重试。如果多次尝试失败，请提交工单 |
| Image.ImageAdmin.AccessFailed | 查询镜像信息错误，请重试。如果多次尝试失败，请提交工单 |
| Image.ImageWorkorder.AccessFailed | 查询镜像信息错误，请重试。如果多次尝试失败，请提交工单 |
| Image.ImageCheck.NotFound | 镜像不存在或不符合要求，请确认镜像信息是否正确 |
| Image.ImageCheck.UnknownError | 查询镜像信息失败，请重试。如果多次尝试失败，请提交工单 |
| Openapi.SaleYacos.AccessFailed | 查询售罄信息错误，请重试。如果多次尝试失败，请提交工单 |
| Openapi.SaleFormats.FormatError | 查询售罄信息格式错误，请重试。如果多次尝试失败，请提交工单 |
| LiteEcs.Instance.FlavorSoldOut | 该规格云主机已售罄，请提交工单 |
| LiteEcs.Instance.EbsSoldOut | 该规格磁盘已售罄，请提交工单 |
| Openapi.SaleCheck.UnknownError | 售罄信息检查失败，请重试。如果多次尝试失败，请提交工单 |
| LiteEcs.Order.AccessFailed | 访问订单系统失败 |
