调用CreateInstance创建实例。
接口说明
- 单用户调用频率:10 次/秒。
- 由于创建实例是异步操作,建议您适当增加请求时间。当 API 返回 Code=0 时仅代表请求成功,并不代表成功创建实例,在请求成功时会返回实例 ID,然后您可以根据实例 ID 查询实例是否创建成功。
- InvalidUserData.NotInWhiteList 接口限制条件:只有配置了购买权限的相关白名单才可以进行创建,否则报错。
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。
授权信息
下表是API对应的授权信息,可以在RAM权限策略语句的Action
元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:
- 操作:是指具体的权限点。
- 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
- 资源类型:是指操作中支持授权的资源类型。具体说明如下:
- 对于必选的资源类型,用背景高亮的方式表示。
- 对于不支持资源级授权的操作,用
全部资源
表示。
- 条件关键字:是指云产品自身定义的条件关键字。
- 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作 | 访问级别 | 资源类型 | 条件关键字 | 关联操作 |
---|---|---|---|---|
ens:CreateInstance | create |
|
| 无 |
请求参数
名称 | 类型 | 必填 | 描述 | 示例值 |
---|---|---|---|---|
InstanceType | string | 是 | 实例规格。 实例规格详情请参见使用限制。 | ens.se1.tiny |
EnsRegionId | string | 是 | 地域。 | cn-hangzhou |
Password | string | 否 | 实例的密码。 长度为 8 至 30 个字符,必须同时包含大小写英文字母、数字和特殊符号中的三类字符。可以设置以下特殊符号: | yourPassword:1 |
Period | string | 是 | 购买资源的时长,取值范围:1~9 和 12,单位:月。 | 12 |
ImageId | string | 否 | 镜像文件 ID,启动实例时选择的镜像资源。 | yourImage ID |
SystemDisk.Size | string | 否 | 系统盘大小,单位为 GiB。取值:20,40,不能比镜像小,需要为 10 的倍数。 | 40 |
Quantity | string | 是 | 实例数量。 | 1 |
DataDisk.1.Size | string | 否 | 第一块数据盘的容量大小,单位为 GiB,容量至少为 20 GiB 且为 10 的倍数。 | 50 |
InternetChargeType | string | 否 | 如果您第一次创建该参数为必传。如果已有实例资源,则默认按照已存在的计费方式。取值:
| 95BandwidthByMonth |
AutoRenewPeriod | string | 否 | 每次自动续费的时长,当参数 AutoRenew 取值 True 时为必填。取值:1~12,单位:月。 | 12 |
AutoRenew | string | 否 | 是否要自动续费。取值:True|False(默认值)。 | True |
IpType | string | 否 | IP 类型。取值:
| ipv4 |
KeyPairName | string | 否 | 密钥对名称。仅支持传单个名称。 | TestKeyPairName |
UserData | string | 否 | 自定义数据,以 您可传入自定义数据。数据以 Base64 的方式编码。调用 API 发起请求时,不会加密您设置的自定义数据,建议您不要以明文方式传入机密的信息,例如:密码和私钥等。如果需要传入密码和私钥等内容,请您对内容进行加密后,然后以 Base64 的方式编码后再传入。在实例内部以同样的方式反解密。 详情请参见数据格式。 | #!/bin/sh echo "Hello World. The time is now $(date -R)!" | tee /home/output.txt |
VSwitchId | string | 否 | 交换机 ID。 | YourVSwitchId |
PrivateIpAddress | string | 否 | 内网地址。 如果传了内网地址,则 vSwitch 必传。vSwitch 需要先创建好,否则会报错。 | 10.10.10.10 |
PaymentType | string | 否 | 支付方式。目前为固定值 Subscription:预付费实例,暂不支持修改。 | Subscription |
InstanceName | string | 否 | 实例的名称。命名规则如下所示:
如果没有指定该参数,默认值为实例的 InstanceId。 | test:Instance_Name.1-2 |
HostName | string | 否 | 云服务器的主机名。 通用命名规则:英文句号(.)和短横线(-)不能作为首尾字符,更不能连续使用。 具体实例命名规则如下:
| test-HostName |
UniqueSuffix | boolean | 否 | 是否为 HostName 和 InstanceName 添加有序后缀。有序后缀从 001 开始递增,最大不能超过 999。 例如:LocalHost001,LocalHost002 和 MyInstance001,MyInstance002。 默认值:false。 | false |
PublicIpIdentification | boolean | 否 | 公网 IP 是否可以分配给指定实例。取值:
| true |
PasswordInherit | boolean | 否 | 是否使用镜像预设的密码。取值:
| false |
返回参数
示例
正常返回示例
JSON
格式
{
"RequestId": "4A431388-2D4B-46F4-A96B-D4E6BD0688C1",
"InstanceIds": {
"InstanceId": [
"[i-7ecpqvkicnchxccozrp****,i-6ecpqvkicnchxccozrp****]"
]
},
"Code": 0
}
错误码
HTTP status code | 错误码 | 错误信息 | 描述 |
---|---|---|---|
400 | StockNotEnough | The specified instance type has insufficient resource. | - |
400 | InvalidUserData.NotInWhiteList | The specified user is not authroized to perform this operation. | - |
400 | MissingParameter | The input parameter that is mandatory for processing this request is not supplied. | - |
400 | InstanceIdNotFound | The input parameter instancdId that is not found. | 指定的实例ID不存在。 |
400 | NoPermission | Permission denied. | 没有足够的权限,请联系云账号管理员授予您相应权限。 |
400 | CallInterface | Call Interface Happen Error. | 接口调用出错。 |
400 | InvalidParameter | The input parameter is Invalid. | - |
400 | StockNotEnough | The specified configuration is unavailable. Reconfigure and try again. | - |
400 | InvalidParameter.%s | The specified field %s invalid. Please check it again. | - |
400 | InvalidParameter | The errorMessage is %s. Please check it again. | - |
400 | StockNotEnough | The specified EnsRegionId is unavailable. Reconfigure and try again. | - |
400 | StockNotEnough | The specified InstanceSpec is unavailable. Reconfigure and try again. | - |
400 | InvalidDiskSize.ValueNotSupported | The specified disk capacity is invalid. Specify another capacity and try again. | - |
400 | InvalidParameter.Bandwidth | The specified parameter InternetChargeType is not valid. | - |
400 | StockNotEnough | The specified node has insufficient resource. | - |
400 | InvalidParameter.Image | The specified image does not support. | - |
400 | StockNotEnough | You have reached the purchase default limit. | - |
400 | InvalidParameter.InstanceType | The specified parameter InstanceType is not valid. | - |
400 | InvalidAccountStatus.NotEnoughBalance | Your account does not have enough balance. | - |
400 | unsupported_Ipv6Feature | This ensregion does not support creating instance of the IPv6 type. Select another type. | - |
400 | Forbidden.CreateInstance | The user is not in the Goods whitelist of creating instance interface. | - |
400 | ENS_OperationUnsupported_KeyPairName | The KeyPairNameis not available or image not support ssh key. | - |
400 | ENS_DependencyViolation_WindowsInstance | The instance creating is window, only user password to login. | - |
400 | ENS_PASSWORDORKEYPAIRNAME_MODULE_NOT_CHOOSEN | The required module pwd or keyPairName is not inputed | - |
400 | MissingParameter | The input parameter %s that is mandatory for processing this request is not supplied. | - |
400 | InvalidPrivateIpAddress | Specified private IP address is not in the CIDR block of virtual switch. | - |
400 | InvalidVSwitchId.NotFound | Specified virtual switch does not exist. | - |
400 | InvalidPrivateIpAddress.Duplicated | Specified private IP address is duplicated. | - |
400 | InvalidPasswordParam.Mismatch | The input password should be null when passwordInherit is true. | - |
访问错误中心查看更多错误码。
变更历史
变更时间 | 变更内容概要 | 操作 |
---|---|---|
2023-10-12 | OpenAPI 错误码发生变更 | 查看变更详情 |
2023-03-03 | OpenAPI 错误码发生变更 | 查看变更详情 |