创建实例

最近更新时间:2024-03-12 01:29:16

我的收藏

1. 接口描述

接口请求域名: ecm.tencentcloudapi.com 。

创建ECM实例。

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

推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。

2. 输入参数

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

参数名称 必选 类型 描述
Action String 公共参数,本接口取值:RunInstances。
Version String 公共参数,本接口取值:2019-07-19。
Region String 公共参数,本接口不需要传递此参数。
ZoneInstanceCountISPSet.N Array of ZoneInstanceCountISP 需要创建实例的可用区及创建数目及运营商的列表。在单次请求的过程中,单个region下的请求创建实例数上限为100
Password String 实例登录密码。不同操作系统类型密码复杂度限制不一样,具体如下:
Linux实例密码必须8到30位,至少包括两项[a-z],[A-Z]、[0-9] 和 [( ) ~ ! @ # $ % ^ & - + = | { } [ ] : ; ' , . ? / ]中的特殊符。Windows实例密码必须12到30位,至少包括三项[a-z],[A-Z],[0-9] 和 [( ) ~ ! @ # $ % ^ & - + = | { } [ ] : ; ' , . ? /]中的特殊符号。
示例值:pwd123
InternetMaxBandwidthOut Integer 公网出带宽上限,单位:Mbps。
1.如果未传该参数或者传的值为0,则使用模块下的默认值。
2.如果未传该参数或者传的值为0且未指定模块,则使用InternetMaxBandwidthIn的值
示例值:100
ModuleId String 模块ID。如果未传该参数,则必须传ImageId,InstanceType,DataDiskSize,InternetMaxBandwidthOut参数
示例值:em-12345
ImageId String 镜像ID。如果未传该参数或者传的值为空,则使用模块下的默认值
示例值:img-12345
InstanceName String 实例显示名称。
不指定实例显示名称则默认显示‘未命名’。
购买多台实例,如果指定模式串{R:x},表示生成数字[x, x+n-1],其中n表示购买实例的数量,例如server_{R:3},购买1台时,实例显示名称为server_3;购买2台时,实例显示名称分别为server_3,server_4。
支持指定多个模式串{R:x}。
购买多台实例,如果不指定模式串,则在实例显示名称添加后缀1、2...n,其中n表示购买实例的数量,例如server_,购买2台时,实例显示名称分别为server_1,server_2。
如果购买的实例属于不同的地域或运营商,则上述规则在每个地域和运营商内独立计数。
最多支持60个字符(包含模式串)。
示例值:tsIns
HostName String 主机名称
点号(.)和短横线(-)不能作为 HostName 的首尾字符,不能连续使用。
Windows 实例:名字符长度为[2, 15],允许字母(不限制大小写)、数字和短横线(-)组成,不支持点号(.),不能全是数字。
其他类型(Linux 等)实例:字符长度为[2, 60],允许支持多个点号,点之间为一段,每段允许字母(不限制大小写)、数字和短横线(-)组成。
示例值:test
ClientToken String 用于保证请求幂等性的字符串。目前为保留参数,请勿使用。
示例值:qwerty**sfd
EnhancedService EnhancedService 增强服务。通过该参数可以指定是否开启云安全、腾讯云可观测平台等服务。若不指定该参数,则默认公共镜像开启腾讯云可观测平台、云安全服务
TagSpecification.N Array of TagSpecification 标签列表
UserData String 提供给实例使用的用户数据,需要以 base64 方式编码,支持的最大数据大小为 16KB
示例值:AA1234***==SG
InstanceType String 机型。如果未传该参数或者传的值为空,则使用模块下的默认值
示例值:S4.2XLARGE16
DataDiskSize Integer 数据盘大小,单位是G。如果未传该参数或者传的值为0,则使用模块下的默认值
示例值:50
SecurityGroupIds.N Array of String 实例所属安全组。该参数可以通过调用 DescribeSecurityGroups 的返回值中的sgId字段来获取。若不指定该参数,则绑定默认安全组。
示例值:[ "esg-g4k23455" ]
SystemDiskSize Integer 系统盘大小,单位是G。如果未传该参数或者传的值为0,则使用模块下的默认值
示例值:50
InternetMaxBandwidthIn Integer 公网入带宽上限,单位:Mbps。
1.如果未传该参数或者传的值为0,则使用对应模块的默认值。
2.如果未传该参数或者传的值为0且未指定模块,则使用InternetMaxBandwidthOut
示例值:100
InstanceChargeType Integer 实例计费类型。其中:
0,按资源维度后付费,计算当日用量峰值,例如CPU,内存,硬盘等,仅适用于非GNR系列机型;
1,按小时后付费,单价:xx元/实例/小时,仅适用于GNR机型,如需开通该计费方式请提工单申请;
2,按月后付费,单价:xx元/实例/月,仅适用于GNR机型;
该字段不填时,非GNR机型会默认选择0;GNR机型默认选择2。
示例值:0
KeyIds.N Array of String 密钥对。
示例值:["skey-dk12345"]
KeepImageLogin String 保持镜像的原始设置。该参数与Password或KeyIds.N不能同时指定。只有使用自定义镜像、共享镜像或外部导入镜像创建实例时才能指定该参数为TRUE。取值范围:
TRUE:表示保持镜像的登录设置
FALSE:表示不保持镜像的登录设置

默认取值:FALSE。
注意:此字段可能返回 null,表示取不到有效值。
示例值:TRUE
SystemDisk SystemDisk 系统盘信息。
DataDisks.N Array of DataDisk 数据盘信息。

3. 输出参数

参数名称 类型 描述
InstanceIdSet Array of String 创建中的实例ID列表
注意:此字段可能返回 null,表示取不到有效值。
示例值:["ein-8cnmds12"]
RequestId String 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 创建实例

使用模板创建实例

输入示例

POST / HTTP/1.1
Host: ecm.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: RunInstances
<公共请求参数>

{
    "ZoneInstanceCountISPSet": [
        {
            "ISP": "CUCC",
            "InstanceCount": 1,
            "Zone": "ap-qingdao-1"
        },
        {
            "ISP": "CMCC",
            "InstanceCount": 2,
            "Zone": "ap-zhengzhou-1"
        }
    ],
    "HostName": "oldhen_4986",
    "ImageId": "img-q9fy0if9",
    "InternetMaxBandwidthOut": 50,
    "InstanceChargeType": 0,
    "EnhancedService": {
        "SecurityService": {
            "Enabled": "false"
        },
        "MonitorService": {
            "Enabled": "false"
        }
    },
    "InstanceName": "直播弹幕",
    "ModuleId": "em-0vag13d1"
}

输出示例

{
    "Response": {
        "RequestId": "d40cdb72-7bc0-4b48-b3aa-25e8401f6999",
        "InstanceIdSet": [
            "ein-197252sp",
            "ein-19725win",
            "ein-19623ash"
        ]
    }
}

5. 开发者资源

腾讯云 API 平台

腾讯云 API 平台 是综合 API 文档、错误码、API Explorer 及 SDK 等资源的统一查询平台,方便您从同一入口查询及使用腾讯云提供的所有 API 服务。

API Inspector

用户可通过 API Inspector 查看控制台每一步操作关联的 API 调用情况,并自动生成各语言版本的 API 代码,也可前往 API Explorer 进行在线调试。

SDK

云 API 3.0 提供了配套的开发工具集(SDK),支持多种编程语言,能更方便的调用 API。

命令行工具

6. 错误码

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

错误码 描述
FailedOperation.BlockBalance 余额不足。
FailedOperation.InternalOperationFailure 内部操作错误。
FailedOperation.OperationConflict 其他操作正在运行,无法进行当前操作。
InvalidParameter.InvalidDataFormat 数据格式不正确。
InvalidParameter.ParameterConflict KeepImageLogin, Password, KeyIds 同时只能使用1个。
InvalidParameterValue 参数取值错误。
InvalidParameterValue.AddressQuotaLimitExceeded 申请数量超限。
InvalidParameterValue.Duplicate 重复数据。
InvalidParameterValue.FilterLimitExceeded Filter参数数值超过限制。
InvalidParameterValue.ImageSizeLargeThanSysDiskSize 镜像大小大于系统盘大小。
InvalidParameterValue.InstanceConfigNotMatch 实例配置不匹配。
InvalidParameterValue.InstanceNameTooLong 实例名字长度超出限制。
InvalidParameterValue.InstanceTypeNotMatchPid 实例机型和pid不匹配。
InvalidParameterValue.InvaildHostName HostName不合法。
InvalidParameterValue.InvaildModifyParam 参数错误。
InvalidParameterValue.InvaildPassword 密码不合法。
InvalidParameterValue.InvalidBandwidth 带宽大小不合法。
InvalidParameterValue.InvalidBandwidthIn 入带宽大小超过限额。
InvalidParameterValue.InvalidBandwidthInAndOut 出入带宽必须一致。
InvalidParameterValue.InvalidBillingType 该用户不支持当前所选择的计费类型。
InvalidParameterValue.InvalidDataDiskNum 数据盘个数不合法。
InvalidParameterValue.InvalidDataDiskSize 数据盘大小不合法。
InvalidParameterValue.InvalidDataDiskType 数据盘类型不合法。
InvalidParameterValue.InvalidEIPDirectService windows镜像不支持IP直通。
InvalidParameterValue.InvalidISPInNode 运营商不合法。
InvalidParameterValue.InvalidImageArchitecture 内存4G以上机型不支持32位操作系统镜像。
InvalidParameterValue.InvalidImageID 镜像ID不合法。
InvalidParameterValue.InvalidInstanceChargeType 实例计费类型不合法。
InvalidParameterValue.InvalidInstanceTypeConfigID 机型ID不合法。
InvalidParameterValue.InvalidInternetChargeType 计费类型不合法。
InvalidParameterValue.InvalidModuleID 模块ID不合法。
InvalidParameterValue.InvalidModuleIDAndInstanceTypeConfigID ModuleId和InstanceType参数不可同时为空。
InvalidParameterValue.InvalidModuleIDAndInstanceTypeID ModuleId和InstanceType参数不可同时为空。
InvalidParameterValue.InvalidPublicParam 公共参数不合法。
InvalidParameterValue.InvalidSecurityGroupID 全组ID不合法。
InvalidParameterValue.InvalidSystemDiskSize 系统盘大小不合法。
InvalidParameterValue.InvalidSystemDiskType 系统盘类型不合法。
InvalidParameterValue.InvalidZone zone不合法。
InvalidParameterValue.InvalidZoneInstanceCount 城市或者数量不合法。
InvalidParameterValue.InvalidZoneInstanceType 用区不支持此机型。
InvalidParameterValue.NodeNotSupportIPv6 节点不支持ipv6。
InvalidParameterValue.ParameterValueTooLarge 参数值超出限制。
InvalidParameterValue.SubnetNotExist 子网不存在。
InvalidParameterValue.TooLong 参数值太长。
InvalidParameterValue.UnmatchedBillingType 该机型不支持当前所选择的计费类型。
InvalidParameterValue.UserNotSupportIPv6 用户不支持ipv6。
LimitExceeded.AddressQuotaLimitExceeded 申请数量超限。
LimitExceeded.EniQuotaLimitExceeded 网卡配额不足。
LimitExceeded.InstanceSecurityGroupLimitExceeded 实例绑定的安全组超出限制。
LimitExceeded.NicOrIPLimitExceeded 弹性网卡或公网IP数超过CPU规定的限额。
LimitExceeded.SecurityGroupInstanceLimitExceeded 安全组绑定的实例数超限。
LimitExceeded.VcpuLimitExceeded 申请的cpu核数超限。
ResourceInUse 资源被占用。
ResourceInsufficient.IPQuotaNotEnough IP资源不足。
ResourceInsufficient.InstanceQuotaNotEnough 实例资源不足。
ResourceInsufficient.PrivateIPQuotaNotEnough 当前子网中内网IP不足
ResourceNotFound 资源不存在。
ResourcesSoldOut.SpecifiedInstanceType 特定机型售罄。
UnauthorizedOperation.ForbiddenOperation 没有权限进行该操作。
UnsupportedOperation.InstanceTypeNotSupportImage 当前机型不支持所选镜像。