接口功能介绍

该接口提供用户创建一台包年包月的轻量型云主机
准备工作：
构造请求：在调用前需要了解如何构造请求，详情查看构造请求
认证鉴权：openapi请求需要进行加密调用，详细查看认证鉴权
计费模式：确认开通云主机的计费模式及计费项，详细查看计费方式及计费项
产品选型：购买轻量型云主机前，请先阅读实例套餐了解轻量型云主机的规格套餐，并通过查询轻量型云主机的规格套餐资源接口，获取当前资源池可用轻量型云主机规格信息
注意事项：
成本估算：了解云主机的计费项，详细查看价格总览进行成本估算
用户配额：确认个人在不同资源池下资源配额，可以通过用户配额查询接口进行查询
异步接口：该接口为异步接口，下单过后会拿到主订单ID（masterOrderID），后续可以调用根据masterOrderID查询云主机ID，使用主订单ID来对订单情况与开通成功后的资源ID进行查询

接口约束

1. 使用限制，本接口只支持在部分资源池进行公测

URI

POST /v4/ecs/lite/create

路径参数
无

Query参数
无

请求参数

请求头header参数
无

请求体body参数

参数	是否必填	参数类型	说明	示例	下级对象
clientToken	是	String	客户端存根，用于保证订单幂等性。要求单个云平台账户内唯一，使用同一个ClientToken值，其他请求参数相同时，则代表为同一个请求。保留时间为24小时	4cf2962d-e92c-4c00-9181-cfbb2218636c
regionID	是	String	资源池ID，您可以查看地域和可用区来了解资源池获取：查资源池列表查询	bb9fdb42056f11eda1610242ac110002
azName	否	String	可用区名称，如果是4.0资源池，必须提供可用区名称。您可以查看地域和可用区来了解可用区获取：查资源池可用区查询注：查询结果中zoneList内返回存在可用区名称(即多可用区，本字段填写实际可用区名称)，若查询结果中zoneList为空（即为单可用区，本字段填写default）	cn-huadong1-jsnj1A-public-ctcloud
displayName	是	String	云主机显示名称，长度为2~15字符	ecm-3300
flavorSetType	是	String	规格套餐类型，取值范围： fix（固定套餐） band（带宽套餐）。选择带宽套餐必须设置系统盘大小和带宽大小，选择固定套餐会忽略传入的系统盘大小和带宽大小。	fix
flavorName	是	String	规格套餐名称，获取：查查询轻量型云主机的规格套餐资源	lite1.fix.small.1
imageID	是	String	镜像ID，您可以查看镜像概述来了解云主机镜像获取：查查询可以使用的镜像资源创创建私有镜像（云主机系统盘）创创建私有镜像（云主机数据盘）注：同一镜像名称在不同资源池的镜像ID是不同的，调用前需确认镜像ID是否归属当前资源池	9d9e8998-8ed5-43b2-99cb-322f2b8cf6fa
cycleCount	是	Integer	订购时长，该参数需要与cycleType一同使用注：最长订购周期为60个月（5年）；cycleType与cycleCount一起填写；按量付费（即onDemand为true）时，无需填写该参数（填写无效）	6
cycleType	是	String	订购周期类型，取值范围： MONTH：按月， YEAR：按年。注：cycleType与cycleCount一起填写；按量付费（即onDemand为true）时，无需填写该参数（填写无效）	MONTH
ipVersion	否	String	弹性IP版本，取值范围： ipv4（v4地址）， ipv6（v6地址），不指定默认为ipv4。注：请先确认该资源池是否支持ipv6	ipv4
bootDiskSize	否	Integer	系统盘大小，带宽套餐时填写，固定套餐时填写会忽略，单位：GiB，取值范围获取：查查询轻量型云主机的规格套餐资源	40
bandwidth	否	Integer	带宽大小带，带宽套餐时填写，固定套餐时填写会忽略，单位：Mbit/s。取值范围获取：查查询轻量型云主机的规格套餐资源	5
dataDiskList	否	Array of Objects	数据盘信息列表，注：同一云主机下最多可挂载5块数据盘		disks
userPassword	否	String	用户密码，满足以下规则：长度在8～30个字符；必须包含大写字母、小写字母、数字以及特殊符号中的三项；特殊符号可选：()`~!@#$%^&*_-+=｜{}[]:;'<>,.?/\且不能以斜线号 / 开头；不能包含3个及以上连续字符； Linux镜像不能包含镜像用户名（root）、用户名的倒序（toor）、用户名大小写变化（如RoOt、rOot等）； Windows镜像不能包含镜像用户名（Administrator）、用户名大小写变化（adminiSTrator等）	1qaz@WSX
autoRenewStatus	否	Integer	本参数表示是否自动续订,取值范围： 0（不续费）， 1（自动续费）。注：按月购买，自动续订周期为1个月；按年购买，自动续订周期为1年	1

表 disks

参数	是否必填	参数类型	说明	示例	下级对象
diskType	是	String	云硬盘类型，取值范围： SATA（普通IO）， SAS（高IO）， SSD（超高IO）， SSD-genric（通用型SSD）， FAST-SSD（极速型SSD）您可以查看磁盘类型及性能介绍磁盘类型相关信息	SATA
diskSize	是	Integer	磁盘容量大小单位为GiB，取值范围：[10-32768]	50

响应参数

参数	参数类型	说明	示例	下级对象
statusCode	Integer	返回状态码（800为成功，900为失败）	800
errorCode	String	错误码，为product.module.code三段式码	Openapi.PatternCheck.NotValid
error	String	错误码，为product.module.code三段式码	Openapi.PatternCheck.NotValid
message	String	失败时的错误描述，一般为英文描述	SUCCESS
description	String	失败时的错误描述，一般为中文描述	成功
returnObj	Object	成功时返回的数据		returnObj

表 returnObj

参数	参数类型	说明	示例
masterOrderID	String	主订单ID。调用方在拿到masterOrderID之后，可以使用materOrderID进一步确认订单状态及资源状态查询订单状态及资源UUID: 查根据masterOrderID查询云主机ID	235145e4489811eda8330242ac110002
masterOrderNO	String	订单号	20221010142913884246
masterResourceID	String	主资源ID	3cda4bf48cac42b8b7db3b279d2fc6fb
regionID	String	资源所属资源池ID	aaf589124d5d11eaa04d0242ac110002

枚举参数

无

请求示例

请求url

无

请求头header

无

请求体body

{
  "regionID": "bb9fdb42056f11eda1610242ac110002",
  "clientToken": "create-fix-lite-vm-0711-01",
  "azName": "cn-huadong1-jsnj1A-public-ctcloud",
  "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": [
    {
      "diskType": "SAS",
      "diskSize": 20
    }
  ]
}

响应示例

{
    "returnObj": {
        "regionID": "aaf589124d5d11eaa04d0242ac110002",
        "masterOrderID": "107e901c449611ed8b6a0242ac110002",
        "masterResourceID": "34c7cc05a52b48eda0a84e34a82b346b",
        "masterOrderNO": "20221009163836430197"
    },
    "message": "SUCCESS",
    "description": "成功",
    "statusCode": 800
}

状态码

请参考状态码

错误码

请参考错误码

应用商城

合作伙伴

开发者

支持与服务

了解天翼云

查看所有产品

弹性云主机

弹性云主机

接口功能介绍

接口约束

URI

请求参数

响应参数

枚举参数

请求示例

响应示例

状态码

错误码

活动

应用商城

合作伙伴

开发者

支持与服务

了解天翼云

查看所有产品

弹性云主机

弹性云主机

接口功能介绍

接口约束

URI

请求参数

响应参数

枚举参数

请求示例

响应示例

状态码

错误码