文档中心

20160913版本

云主机(KEC)openAPI 1.4

Actions RunInstances(创建实例)

Request Parameters(请求参数)

Response Elements(返回值)

Examples(例子)

Sample Request(请求)

Sample Response(返回)

TerminateInstances(销毁实例)

Request Parameters(请求参数)

Response Elements(返回值)

Examples(例子)

Sample Request(请求)

Sample Response(返回)

StartInstances(启动实例)

Request Parameters(请求参数)

Response Elements(返回值)

Examples(例子)

Sample Request(请求)

Sample Response(返回)

StopInstances(关闭实例)

Request Parameters(请求参数)

Response Elements(返回值)

Examples(例子)

Sample Request(请求)

Sample Response(返回)

RebootInstances(重启实例)

Request Parameters(请求参数)

Response Elements(返回值)

Examples(例子)

Sample Request(请求)

Sample Response(返回)

RebootInstances(重启实例)

Request Parameters(请求参数)

Response Elements(返回值)

Examples(例子)

Sample Request(请求)

Sample Response(返回)

MonitorInstances(启动实例监控)

Request Parameters(请求参数)

Response Elements(返回值)

Examples(例子)

Sample Request(请求)

Sample Response(返回)

UnmonitorInstances(取消实例监控)

Request Parameters(请求参数)

Response Elements(返回值)

Examples(例子)

Sample Request(请求)

Sample Response(返回)

ModifyInstanceType(升级实例套餐类型)

Request Parameters(请求参数)

Response Elements(返回值)

Examples(例子)

Sample Request(请求)

Sample Response(返回)

ModifyInstanceImage(更换或者重新安装实例操作系统)

Request Parameters(请求参数)

Response Elements(返回值)

Examples(例子)

Sample Request(请求)

Sample Response(返回)

ModifyInstanceAttribute(修改实例属性信息)

Request Parameters(请求参数)

Response Elements(返回值)

Examples(例子)

Sample Request(请求)

Sample Response(返回)

DescribeInstanceVnc(获取VNC信息)

Request Parameters(请求参数)

Response Elements(返回值)

Examples(例子)

Sample Request(请求)

Sample Response(返回)

DescribeInstances(描述实例信息)

Request Parameters(请求参数)

Response Elements(返回值)

Examples(例子)

Sample Request(请求)

Sample Response(返回)

ModifyNetworkInterfaceAttribute(修改网络接口属性信息)

Request Parameters(请求参数)

Response Elements(返回值)

Examples(例子) Sample Request(请求)

Sample Response(返回)

AttachNetworkInterface(为主机添加网卡)

Request Parameters(请求参数)

Response Elements(返回值)

Examples(例子)

Sample Request(请求)

Sample Response(返回)

DetachNetworkInterface(删除主机网络接口)

Request Parameters(请求参数)

Response Elements(返回值)

Examples(例子)

Sample Request(请求)

Sample Response(返回)

CreateImage(创建镜像)

Request Parameters(请求参数)

Response Elements(返回值)

Examples(例子)

Sample Request(请求)

Sample Response(返回)

DescribeImages(描述镜像信息)

Request Parameters(请求参数)

Response Elements(返回值)

Examples(例子)

Sample Request(请求)

Sample Response(返回)

RemoveImages(删除镜像)

Request Parameters(请求参数)

Response Elements(返回值)

Examples(例子)

Sample Request(请求)

Sample Response(返回)

ModifyImageAttribute(修改镜像属性信息)

Request Parameters(请求参数)

Response Elements(返回值)

Examples(例子)

Sample Request(请求)

Sample Response(返回)

Data Types Instance(实例类型)

Contents(内容)

InstanceConfigure(实例配置类型)

Contents(内容)

Monitoring(监控状态类型)

Contents(内容)

InstanceState(实例状态类型)

Contents(内容)

NetworkInterface(网络接口类型)

Contents(内容)

GroupIdentifier(安全组标识类型)

Contents(内容)

InstanceStateChange(实例状态改变类型)

Contents(内容)

InstanceMonitoring(实例监控状态类型)

Contents(内容)

Filter(过滤器类型)

Contents(内容)

Sort(筛选类型)

Contents(内容)

Image(镜像类型)

Contents(内容)

BlockDeviceMapping(块存储映射信息)

Contents(内容)

EbsBlockDevice(EBS块设备)

Description(描述)

Contents(内容)

ImageDeletion(镜像删除结果类型)

Contents(内容)

References(参考)

实例套餐类型定义

IO优化型套餐(原高性能主机)

联网增强型

计算优化型套餐

数据存储优化型套餐

通用型套餐(原EBS主机)

主机状态注释

主机任务状态

Actions

RunInstances(创建实例

从有访问权限的镜像(image)启动指定数量的实例。

在启动实例时,实例属于“创建中”(pending)状态,在实例准备好时,会进入“运行中(running)”状态。

Request Parameters(请求参数)

ImageId

镜像ID

类型: #### Request Parameters(请求参数)

有效值:标准UUID格式,形如^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$

是否可缺省: 否

InstanceType

实例套餐类型,如果调用时未指定实例套餐类型,默认值为I1.1A

类型: String

有效值: IO优化型:1.1A | I1.1B| I1.1C| I1.2A| I1.2B| I1.2C| I1.4A| I1.4B| I1.4C| I1.8A| I1.8B| I1.8C| I1.16A| I1.16B| I1.16C| I1.24A| I1.24C| I1.24B| I1.24D| I1.32A| I1.32B; 通用型:N1.1A | N1.1B | N1.1C | N1.2A | N1.2B | N1.2C | N1.4A | N1.4B | N1.4C | N1.8A | N1.8B | N1.8C | N1.16A | N1.16B | N1.26C | N1.32A | N1.32B

具体套餐信息参考实例套餐类型定义

是否可缺省: 是

DataDiskGb

数据卷容量,单位GB,容量限制依据实例套餐类型定义变化,如果调用时未指定,则为相应实例套餐类型最小值。InstanceType为通用型主机。此参数不生效。

类型: Integer

是否可缺省: 是

MaxCount

最大实例数,如果指定的实例数大于金山云在本region所能创建的最大实例数,则会创建大于MinCount数量的最大允许实例数。

类型: Integer

有效值: 最小值1,最大值为MIN(当前用户实例剩余配额,30),即用户剩余配额和100比较的小者

是否可缺省: 否

MinCount

最小实例数,如果指定的实例数大于金山云在本region所能创建的最大实例数,则不会创建任何实例。

类型: Integer

有效值: 最小值1,最大值为MIN(当前用户实例剩余配额,30),即用户剩余配额和100比较的小者

是否可缺省: 否

SubnetId

VPC环境下的子网ID,绑定到主网卡

类型: String

有效值:标准UUID格式,形如^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$

是否可缺省: 否

InstancePassword

实例开机密码

类型: String

有效值:最短8字符,最长32字符,必须包含大小写英文字符和数字,支持其他可见字符

是否可缺省: 否

ChargeType

计费类型,调用时需要明确指定,无默认值

类型: String

有效值:Monthly(包年包月) 、按日月结Daily

是否可缺省: 否

PurchaseTime

购买时长,单位月

类型: Integer

有效值:当计费类型为Monthly(包年包月)时,有效值1-36;其他计费类型时,强制要求参数值为0

是否可缺省: 否

SecurityGroupId

实例绑定的安全组,目前仅支持绑定一个安全组

类型: String列表

有效值:标准UUID格式,形如^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$

是否可缺省: 否

PrivateIpAddress

私有IP地址,指定子网IP地址范围内的任意有效值,代表实例的主IP地址,只能选择一个,绑定到主网卡;如果未指定该参数,系统自动从有效地址池中随机选取一个

类型: String

有效值:标准IP地址格式

是否可缺省: 是

InstanceName

实例名称,如果未指定,则自动生成,形如KSC-IN-[A-Z0-9]{10}

类型: String

有效值:最短2字符,最长64字符,支持中英文

是否可缺省: 是

InstanceNameSuffix

实例名称后缀,InstanceName参数如果缺省,此参数不生效;当大于1台的批量创建主机,后缀编号自动+1,例如后缀输入5,主机名输入”host”,批量3台,则生成的三台主机名分别为:”host-5”、”host-6”、”host-7”;

类型: String

默认值:空

有效值:0到9999

是否可缺省: 是

SriovNetSupport

开启增强联网,只支持IO优化型8核、16核套餐,只支持- CentOS操作系统6.5、6.6、6.7、7.0、7.1,Ubuntu 14.04操作系统。

默认值:false

类型:Boolean

是否可缺省:是

Response Elements(返回值)

RequestId

请求ID

类型: String

是否可缺省: 否

InstancesSet

实例集合

类型: 实例(Instance) 列表

是否可缺省: 否

Examples(例子)

在默认region,创建一个实例,实例套餐类型C1.1A,数据盘大小50GB,计费类型包年包月,购买时长一个月,实例名称test_2

Sample Request(请求)

http://kec.api.ksyun.com/?Action=RunInstances&Version=2016-03-04
&MaxCount=1
&MinCount=1
&ImageId=314bbaa0-6ea3-4042-ae58-4d499a0a607b
&SubnetId=d91f7510-2b59-4600-bc26-9c34c1b38493
&InstancePassword=1qaz2wsx!Q
&SecurityGroupId=c032ce42-b457-4f36-a557-297994f172ac
&DataDiskGb=50
&ChargeType=Monthly
&InstanceType=C1.1A
&PurchaseTime=1
&InstanceName=test_2
&AUTHPARAMS

Sample Response(返回)

<?xml version="1.0" encoding="UTF-8"?>
<RunInstancesResponse xmlns="http://vm.ksyun.com/doc/2016-3-09/">
     <RequestId>d13fbf44-f6ac-4030-96a6-4f5b38e8ca86</RequestId>
     <InstancesSet>
         <Item>
             <InstanceName>test_2</InstanceName>
             <InstanceId>d7d3e0b3-eeb1-40a3-89f3-a6100f14522b</InstanceId>
         </Item>
     </InstancesSet>
</RunInstancesResponse>

TerminateInstances(销毁实例)

销毁一个或者多个实例。 约束条件1:在销毁实例时,需要先解绑实例已挂则的EBS数据盘、SLB、EIP资源。

Request Parameters(请求参数)

InstanceId.N

待销毁实例ID列表

类型: String 列表

是否可缺省: 否

Response Elements(返回值)

RequestId

请求ID

类型: String

是否可缺省: 否

InstancesSet

销毁实例集合

类型: 实例状态改变(InstanceStateChange) 列表

是否可缺省: 否

Examples(例子)

在默认region,销毁两个实例

Sample Request(请求)

http://kec.api.ksyun.com/?Action=TerminateInstances&Version=2016-03-04
&InstanceId.1=e1d996e9-d182-4510-a9c7-82b74b6d1b81
&InstanceId.2=b6a77e1a-c560-4c10-a087-84871616f067
&AUTHPARAMS

Sample Response(返回)

<?xml version="1.0" encoding="UTF-8"?>
<TerminateInstancesResponse xmlns="http://vm.ksyun.com/doc/2016-3-09/">
    <InstancesSet>
        <Item>
           <InstanceId>b6a77e1a-c560-4c10-a087-84871616f067</InstanceId>
           <Return>true</Return>
        </Item>        <Item>
            <InstanceId>e1d996e9-d182-4510-a9c7-82b74b6d1b81</InstanceId>
            <Return>true</Return>
       </Item>
   </InstancesSet>
   <RequestId>be000708-ceb5-4313-af1c-1e88c30db865</RequestId>
</TerminateInstancesResponse>

StartInstances(启动实例)

启动一个或者多个处于“停止状态(stopped)”的实例。

Request Parameters(请求参数)

InstanceId.N

待启动实例ID列表

类型: String 列表

是否可缺省: 否

Response Elements(返回值)

RequestId

请求ID

类型: String

是否可缺省: 否

InstancesSet

启动实例集合

类型: 实例状态改变(InstanceStateChange) 列表

是否可缺省: 否

Examples(例子)

在默认region,启动一个实例(没有成功启动)

Sample Request(请求)

http://kec.api.ksyun.com/?Action=StartInstances&Version=2016-03-04
&InstanceId.1=d7d3e0b3-eeb1-40a3-89f3-a6100f14522b
&AUTHPARAMS

Sample Response(返回)

<?xml version="1.0" encoding="UTF-8"?>
<StartInstancesResponse xmlns="http://vm.ksyun.com/doc/2016-3-09/"> 
    <InstancesSet> 
       <Item> 
           <InstanceId>d7d3e0b3-eeb1-40a3-89f3-a6100f14522b</InstanceId>
           <Return>false</Return> 
       </Item> 
    </InstancesSet> 
    <RequestId>93eb7041-659f-43f6-a10c-abdf0a48a051</RequestId>
</StartInstancesResponse>

StopInstances(关闭实例)

关闭一个或者多个处于“活动状态(active)”的实例,

Request Parameters(请求参数)

InstanceId.N

待关闭实例ID列表

类型: String 列表

是否可缺省: 否

Response Elements(返回值)

RequestId

请求ID

类型: String

是否可缺省: 否

InstancesSet

关闭实例集合

类型: 实例状态改变(InstanceStateChange) 列表

是否可缺省: 否

Examples(例子)

在默认region,关闭一个实例(成功关闭)

Sample Request(请求)

http://kec.api.ksyun.com/?Action=StopInstances&Version=2016-03-04
&InstanceId.1=e007579f-bea2-483e-bfcb-fec760c58167
&AUTHPARAMS

Sample Response(返回)

<?xml version="1.0" encoding="UTF-8"?>
<StopInstancesResponse xmlns="http://vm.ksyun.com/doc/2016-3-09/">
     <InstancesSet>
         <Item>
             <InstanceId>e007579f-bea2-483e-bfcb-fec760c58167</InstanceId>
             <Return>true</Return>
        </Item>
    </InstancesSet>
    <RequestId>77492bfb-3567-4b9b-8f23-bbcc2ab5404c</RequestId>
</StopInstancesResponse>

RebootInstances(重启实例)

重启一个或者多个处于“活动状态(active)”的实例,

Request Parameters(请求参数)

InstanceId.N

待重启实例ID列表

类型: String 列表

是否可缺省: 否

Response Elements(返回值)

RequestId

请求ID

类型: String

是否可缺省: 否

InstancesSet

重启实例集合

类型: 实例状态改变(InstanceStateChange) 列表

是否可缺省: 否

Examples(例子)

在默认region,重启一个实例

Sample Request(请求)

http://kec.api.ksyun.com/?Action=RebootInstances&Version=2016-03-04
&InstanceId.1=e007579f-bea2-483e-bfcb-fec760c58167
&AUTHPARAMS

Sample Response(返回)

<?xml version="1.0" encoding="UTF-8"?>
<RebootInstancesResponse xmlns="http://vm.ksyun.com/doc/2016-3-09/"> 
    <InstancesSet>  
        <Item> 
            <InstanceId>e007579f-bea2-483e-bfcb-fec760c58167</InstanceId> 
            <Return>true</Return> 
        </Item> 
    </InstancesSet> 
    <RequestId>09bbe322-a83b-4fc4-8178-39062c7a6c10</RequestId></RebootInstancesResponse>

MonitorInstances(启动实例监控)

启动对一个或者多个实例的监控

Request Parameters(请求参数)

InstanceId.N

待启动监控的实例ID列表

类型: String 列表

是否可缺省: 否

Response Elements(返回值)

RequestId

请求ID

类型: String

是否可缺省: 否

InstancesSet

实例监控信息集合

类型: 实例监控状态(InstanceMonitoring) 列表

是否可缺省: 否

Examples(例子)

在默认region,启动对一个实例的监控

Sample Request(请求)

http://kec.api.ksyun.com/?Action=MonitorInstances&Version=2016-03-04
&InstanceId.1=e007579f-bea2-483e-bfcb-fec760c58167
&AUTHPARAMS

Sample Response(返回)

<?xml version="1.0" encoding="UTF-8"?>
<MonitorInstancesResponse> 
    <InstancesSet> 
       <Item> 
           <InstanceId>e007579f-bea2-483e-bfcb-fec760c58167</InstanceId> 
           <Monitoring> 
                <State>enabled</State> 
           </Monitoring> 
       </Item> 
    </InstancesSet> 
    <RequestId>42825742-becb-4837-a0bf-88522db3b6fd</RequestId></MonitorInstancesResponse>

UnmonitorInstances(取消实例监控)

取消对一个或者多个实例的监控

Request Parameters(请求参数) InstanceId.N

待取消监控的实例ID列表

类型: String 列表

是否可缺省: 否

Response Elements(返回值)

RequestId

请求ID

类型: String

是否可缺省: 否

InstancesSet

实例监控信息集合

类型: 实例监控状态(InstanceMonitoring) 列表

是否可缺省: 否

Examples(例子)

在默认region,取消对一个实例的监控

Sample Request(请求)

http://kec.api.ksyun.com/?Action=UnmonitorInstances&Version=2016-03-04
&InstanceId.1=e007579f-bea2-483e-bfcb-fec760c58167
&AUTHPARAMS

Sample Response(返回)

<?xml version="1.0" encoding="UTF-8"?>
<UnmonitorInstancesResponse> 
   <InstancesSet> 
        <Item> 
            <InstanceId>e007579f-bea2-483e-bfcb-fec760c58167</InstanceId> 
            <Monitoring> 
                <State>disabled</State> 
            </Monitoring> 
        </Item> 
   </InstancesSet> 
   <RequestId>2995fd12-3193-412f-a31e-52983b6c6bf7</RequestId></UnmonitorInstancesResponse>

ModifyInstanceType(升级实例套餐类型)

升级实例的套餐类型,即配置信息(VCPU个数和内存大小),金山云只支持从低级别套餐升级为高级别套餐 升级配置暂不支持存储优化型和通用型主机

Request Parameters(请求参数)

InstanceId

待升级套餐类型的实例ID

类型: String

是否可缺省: 否

InstanceType

实例套餐类型

类型: String

有效值: IO优化型:1.1A | I1.1B| I1.1C| I1.2A| I1.2B| I1.2C| I1.4A| I1.4B| I1.4C| I1.8A| I1.8B| I1.8C| I1.16A| I1.16B| I1.16C| I1.24A| I1.24C| I1.24B| I1.24D| I1.32A| I1.32B; 计算优化型:C1.1A | C1.1B | C1.1C | C1.2A | C1.2B | C1.2C | C1.4A | C1.4B | C1.4C | C1.8A | C1.8B | C1.8C | C1.16A | C1.16B | C1.16C| C1.24A | C1.24B | C1.24C | C1.24D | C1.32A | C1.32B ;

具体套餐信息参考实例套餐类型定义

是否可缺省: 否

DataDiskGb

数据卷容量,单位GB,数据卷只能扩容或者保持不变,且不能低于实例套餐类型定义的最小值

类型: Integer

是否可缺省: 否

Response Elements(返回值)

RequestId

请求ID

类型: String

是否可缺省: 否

Return

升级实例套餐类型成功与否

类型: String

有效值:true(成功)| false(失败)

是否可缺省: 否

Examples(例子)

在默认region,将一个实例升级到更高套餐级别,数据盘大小维持不变

Sample Request(请求)

http://kec.api.ksyun.com/?Action=ModifyInstanceType&Version=2016-03-04
&InstanceType=C1.1B
&DataDiskGb=1
&InstanceId=e007579f-bea2-483e-bfcb-fec760c58167
&AUTHPARAMS

Sample Response(返回)

<?xml version="1.0" encoding="UTF-8"?>
<ModifyInstanceTypeResponse xmlns="http://vm.ksyun.com/doc/2016-3-09/"> 
    <Return>true</Return> 
    <RequestId>09bbe322-a83b-4fc4-8178-39062c7a6c10</RequestId>
</ModifyInstanceTypeResponse>

ModifyInstanceImage(更换或者重新安装实例操作系统)

重新安装/更换实例的操作系统;

约束条件1: 联网增强主机重装系统,只能安装联网增强型的标准系统镜像,暂不支持自定义镜像安装;

Request Parameters(请求参数)

InstanceId

待更换或者重新安装操作系统的实例ID

类型: String

有效值:标准UUID格式,形如^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$

是否可缺省: 否

ImageId

待更换的镜像ID;如果缺省,表明无需改变镜像,只需重新安装实例的操作系统。

类型: String

有效值:标准UUID格式,形如^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$

是否可缺省: 是

InstancePassword

实例开机密码

类型: String

有效值:最短8字符,最长32字符,必须包含大小写英文字符和数字,支持其他可见字符

是否可缺省: 否

Response Elements(返回值)

RequestId

请求ID

类型: String

是否可缺省: 否

Return

更换或者重装实例操作系统成功与否

类型: String

有效值:true(成功)| false(失败)

是否可缺省: 否

Examples(例子)

在默认region,为一个实例更换操作系统

Sample Request(请求)

http://kec.api.ksyun.com/?Action=ModifyInstanceImage&Version=2016-03-04
&InstanceId=efa35216-2fde-4e38-9b7e-2d0646f33d0f
&ImageId=8f12ad9e-ae9a-44b9-95f3-c4e65ce582e2
&InstancePassword=1qaQ!abc
&AUTHPARAMS

Sample Response(返回)

<?xml version="1.0" encoding="UTF-8"?>
<ModifyInstanceImageResponse xmlns="http://vm.ksyun.com/doc/2016-3-09/"> 
    <Return>true</Return> 
    <RequestId>09bbe322-a83b-4fc4-8178-39062c7a6c10</RequestId>
</ModifyInstanceImageResponse>

ModifyInstanceAttribute(修改实例属性信息)

修改指定实例的实例名称或者开机密码;一次调用只能修改一个实例属性;修改实例密码必须关机操作,且后台为异步操作,需要等待时间较长(大约7秒)。

Request Parameters(请求参数)

InstanceId

待修改属性的实例ID

类型: String

有效值:标准UUID格式,形如^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$

是否可缺省: 否

InstanceName

实例名称,修改实例名称不需要关闭实例

类型: String

有效值:最短2字符,最长64字符,支持中英文

是否可缺省: 是

InstancePassword 实例开机密码,修改实例开机密码需要关闭实例

类型: String

有效值:最短8字符,最长32字符,必须包含大小写英文字符和数字,支持其他可见字符

是否可缺省: 是

Response Elements(返回值)

RequestId

请求ID

类型: String

是否可缺省: 否

Return

修改实例属性信息成功与否

类型: String

有效值:true(成功)| false(失败)

是否可缺省: 否

Examples(例子)

在默认region,为一个实例修改实例名称

Sample Request(请求)

http://kec.api.ksyun.com/?Action=ModifyInstanceAttribute&Version=2016-03-04
&InstanceId=e007579f-bea2-483e-bfcb-fec760c58167
&InstanceName=testmodifyname
&AUTHPARAMS

Sample Response(返回)

<?xml version="1.0" encoding="UTF-8"?>
<ModifyInstanceAttributeResponse xmlns="http://vm.ksyun.com/doc/2016-3-09/"> 
    <RequestId>91c2d855-df39-457d-9e62-dd01e8e5fc62</RequestId>
    <Return>true</Return>
</ModifyInstanceAttributeResponse>

DescribeInstanceVnc(获取VNC信息)

获取指定实例的VNC信息

Request Parameters(请求参数) InstanceId

要获取实例VNC信息的实例ID

类型: String

是否可缺省: 否

Response Elements(返回值)

RequestId

请求ID

类型: String

是否可缺省: 否

vncUrl

VNC的URL

类型: String

是否可缺省: 否

Examples(例子)

获取实例的VNC信息

Sample Request(请求)

https://kec.api.ksyun.com/?Action= DescribeInstanceVnc&Version=2016-03-04
&AUTHPARAMS
&InstanceId=efa35216-2fde-4e38-9b7e-2d0646f33d0f

Sample Response(返回)

<?xml version="1.0" encoding="UTF-8"?>
<DescribeInstanceVncResponse xmlns="http://vm.ksyun.com/doc/2016-3-09/"> 
    <requestId>123</requestId>
    <vncUrl>http://192.168.16.97:6080/vnc_auto.html?token=f331aca5-c6ed-4ab2-a35e-4fef5b173ddc</vncUrl>
</DescribeInstanceVncResponse>

DescribeInstances(描述实例信息)

主网卡信息直接在返回值中体现;

NetworkInterfaceSet体现所有网卡的信息;

Request Parameters(请求参数)

MaxResults

单次调用所返回的最大实例数目,取值为5~1000,超过1000记为1000

类型: Integer

缺省: 10

是否可缺省: 是

Marker

分页标识,单次调用未返回全部实例时,标记下次调用的返回值的起点,默认值是0

类型: Integer

是否可缺省: 是

InstanceId.N

待返回描述信息的实例ID列表

类型: String 列表

缺省: 返回全部实例描述信息

是否可缺省: 是

Filter.N

一个或者多个过滤器

类型: 过滤器(Filter)列表

有效值:支持如下过滤器名称

instance-id 实例ID

subnet-id 子网ID

vpc-id vpc ID

network-interface.subnet-id 网络接口关联的子网ID

network-interface.network-interface-id 网络接口的ID

network-interface.group-id 网络接口关联的安全组ID

instance-state.name-实例状态

是否可缺省: 是

Sort:

筛选器

类型: 过滤器(Sort)列表

有效值:支持如下筛选器名称

InstanceName –主机名称

CreationDate –创建时间

PrivateIpAddress - 主机内网IP(主网卡)

是否可缺省:是

Search:

搜索条件,模糊匹配,可搜索字段如下:

类型:string

支持字段:实例名(InstanceName)、主网卡私有IP地址(PrivateIpAddress)

是否可缺省:是

Response Elements(返回值)

RequestId

请求ID

类型: String

是否可缺省: 否

Marker

分页标识,如果调用未返回全部实例,标记下次调用的返回值的起点,如果已返回全部实例,则其值为0

类型: Integer

是否可缺省: 否

InstanceCount

实例总数

类型: Integer

是否可缺省: 否

InstancesSet

实例集合

类型: 实例(Instance) 列表

是否可缺省: 否

Examples(例子)

描述某个region的全部实例信息

Sample Request(请求)

https://kec.api.ksyun.com/?Action=DescribeInstances&Version=2016-03-04
&AUTHPARAMS

Sample Response(返回)

<?xml version="1.0" encoding="UTF-8"?>
<DescribeInstancesResponse xmlns="http://vm.ksyun.com/doc/2016-3-09/">
     <Marker>0</Marker>
     <InstanceCount>35</InstanceCount>
     <RequestId>95085c36-35fd-4d48-a3b4-6e22b6133373</RequestId>
     <InstancesSet> 
         <Item> 
             <ImageId>1b071046-d0ba-44de-a167-7cf7f6544364</ImageId> 
             <InstanceConfigure> 
                 <DataDiskType>SSD</DataDiskType>
                 <DataDiskGb>20</DataDiskGb> 
                 <MemoryGb>1</MemoryGb> 
                 <VCPU>1</VCPU> 
             </InstanceConfigure> 
             <InstanceId>6e75f4cc-a450-4a89-b56a-66980d500ab1</InstanceId> 
             <InstanceName>testvm2</InstanceName> 
             <InstanceState> 
                 <Name>active</Name> 
             </InstanceState> 
             <Monitoring> 
                 <State>disabled</State> 
             </Monitoring> 
             <NetworkInterfaceSet> 
                 <Item> 
                     <SecurityGroupSet> 
                         <Item> 
                             <SecurityGroupGroupId>d92f3801-2cb3-4809-897e-8ba95f491e78</SecurityGroupGroupId> 
                         </Item> 
                     </SecurityGroupSet>
                     <MacAddress>fa:16:3e:3f:68:8a</MacAddress>
                     <NetworkInterfaceId>ef0277e9-4569-4e49-9a3c-ff56b5083b35</NetworkInterfaceId>
                <PrivateIpAddress>192.168.0.219</PrivateIpAddress>
                     <SubnetId>0666c7b3-dd12-4854-a390-2e31eb0368b5</SubnetId> 
                </Item> 
            </NetworkInterfaceSet> 
            <SubnetId>0666c7b3-dd12-4854-a390-2e31eb0368b5</SubnetId> 
         </Item> 
     </InstancesSet>
</DescribeInstancesResponse>

ModifyNetworkInterfaceAttribute(修改网络接口属性信息)

修改指定网络接口的属性,当前支持修改安全组、子网或者DNS信息。 接口调用可修改一个或多个属性(安全组、子网、DNS、IP)。

特殊场景:如果跨VPC修改子网,SubnetID和SecurityGroupId必须在同一个VPC下

约束条件1:在更换主网卡SubnetId、PrivateIpAddress时,如果网络接口已经绑定EIP、属于SLB的真实服务器或绑定Portforword时,则不允许更改,需要先解绑相应配置。

约束条件2:修改副网卡网络信息时,DNS1和DNS2必须缺省,DNS与主网卡保持一致。

约束条件3:当SubnetId与接口调用前一致,PrivateIpAddress缺省代表与接口调用前相同,当SubnetId与接口调用前不一致,PrivateIpAddress缺省代表在新的子网Ip范围内自动分配。

Request Parameters(请求参数)

InstanceId

待修改属性的实例ID

类型: String

有效值:标准UUID格式,形如^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$

是否可缺省: 否

NetworkInterfaceId

待修改属性的网络接口ID

类型: String

有效值:标准UUID格式,形如^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$

是否可缺省: 否

SecurityGroupId(SecurityGroupId.N只识别第一个数组成员)

实例绑定的安全组

类型: String列表

有效值:标准UUID格式,形如^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$

是否可缺省: 否

SubnetId

新的子网ID

类型: String

有效值:标准UUID格式,形如^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$

是否可缺省: 否

PrivateIpAddress

私有IP地址,子网IP地址范围内的任意有效值

类型: String

有效值:标准IP地址格式

是否可缺省: 是

DNS1

DNS 1的值,当通过该接口进行修改网络配置时不填写此参数,保持与之前不变。

类型: String

有效值: 标准IP地址

是否可缺省: 是

DNS2

DNS 2的值,当通过该接口进行修改网络配置时不填写此参数,保持与之前不变。

类型: String

有效值: 标准IP地址

是否可缺省: 是

Response Elements(返回值) RequestId

请求ID

类型: String

是否可缺省: 否

Return

修改网络接口属性信息成功与否

类型: String

有效值:true(成功)| false(失败)

是否可缺省: 否

Examples(例子)

在默认region,为一个网络接口修改子网信息

Sample Request(请求)

http://kec.api.ksyun.com/?Action=ModifyNetworkInterfaceAttribute&Version=2016-03-04
&InstanceId=e007579f-bea2-483e-bfcb-fec760c58167
&NetworkInterfaceId=2f93aaba-6368-4cec-b50f-9f199138023f
&SubnetId=c6839580-6ce4-453a-8533-b4fd659eff36
&AUTHPARAMS

Sample Response(返回)

<?xml version="1.0" encoding="UTF-8"?>
<ModifyNetworkInterfaceAttributeResponse xmlns="http://vm.ksyun.com/doc/2016-3-09/"> 
     <RequestId>f2d20e49-63d9-4e6c-b598-050d2fc2631a</RequestId>
     <Return>true</Return>
</ModifyNetworkInterfaceAttributeResponse>

AttachNetworkInterface(为主机添加网卡)

为一个主机实例添加辅网卡

约束条件1:每个主机实例默认拥有主网卡,只能用该接口添加一个辅网卡。

Request Parameters(请求参数)

InstanceId

待添加网卡的实例ID

类型: String

有效值:标准UUID格式,形如^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$

是否可缺省: 否

SecurityGroupId.N

实例绑定的安全组集合(只识别第一个数组成员)

类型: String列表

有效值:标准UUID格式,形如^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$

是否可缺省: 否

SubnetId

新的子网ID

类型: String

有效值:标准UUID格式,形如^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$

是否可缺省: 否

PrivateIpAddress 私有IP地址,新的子网IP地址范围内的任意有效值,只有在更改子网时可同步设置此参数,如果在更改子网时未指定该参数,系统自动从新的子网有效地址池中随机选取一个

类型: String

有效值:标准IP地址格式

是否可缺省: 是

Response Elements(返回值)

RequestId

请求ID

类型: String

是否可缺省: 否

Return

返回状态

类型: Bool

是否可缺省: 否

Examples(例子)

Sample Request(请求)

http://kec.api.ksyun.com/?Action=AttachNetworkInterface&Version=2016-03-04
&InstanceId=98284100-f6d1-4bbf-886a-1b0765024738
&SubnetId=4d68d87b-5cbb-4b1a-b761-562ecaf143d6
&SecurityGroupId.1=d386fa74-4bcc-4bf9-bb67-3f0e7cb3d50b
&PrivateIpAddress=10.0.0.1

Sample Response(返回)

<?xml version="1.0" encoding="UTF-8"?>
<AttachNetworkInterface Response xmlns="http://vm.ksyun.com/doc/2016-3-09/"> 
    <RequestId>be000708-ceb5-4313-af1c-1e88c30db865</RequestId>
    <Return>true</Return>
</AttachNetworkInterface Response>

DetachNetworkInterface(删除主机网络接口)

删除主机的辅网卡

约束条件1:只能删除主机的辅网卡。

Request Parameters(请求参数)

InstanceId

待删除网卡的实例ID

类型: String

有效值:标准UUID格式,形如^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$

是否可缺省: 否

NetworkInterfaceId

待删除的网络接口ID

类型: String

是否可缺省: 否

Return

返回状态

类型: Bool

是否可缺省: 否

Response Elements(返回值)

RequestId

请求ID

类型: String

是否可缺省: 否

Examples(例子)

在默认region,销毁两个实例

Sample Request(请求)

http://kec.api.ksyun.com/?Action=DetachNetworkInterface&Version=2016-03-04
&InstanceId=98284100-f6d1-4bbf-886a-1b0765024738
&NetworkInterfaceId=0015b5da-e1f6-43f6-9fe4-fecdc0640626

Sample Response(返回)

<?xml version="1.0" encoding="UTF-8"?>
<DetachNetworkInterfaceResponse xmlns="http://vm.ksyun.com/doc/2016-3-09/"> 
   <RequestId>be000708-ceb5-4313-af1c-1e88c30db865</RequestId>
   <Return>true</Return>
</DetachNetworkInterfaceResponse>

CreateImage(创建镜像)

支持实例在开机状态下,从实例根设备(系统卷)创建私有镜像

Request Parameters(请求参数)

InstanceId

待创建镜像的实例ID

类型: String

有效值:标准UUID格式,形如^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$

是否可缺省: 否

Name

新镜像的名称

类型: String

有效值:2-64个字符,支持中文、字母、数字以及-_@#.字符

是否可缺省: 否

Response Elements(返回值)

RequestId

请求ID

类型: String

是否可缺省: 否

ImageId

新创建的镜像ID

类型: String

有效值:标准UUID格式,形如^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$

是否可缺省: 否

Examples(例子)

在默认region,为一个实例创建新镜像

Sample Request(请求)

http://kec.api.ksyun.com/?Action=CreateImage&Version=2016-03-04
&InstanceId=e007579f-bea2-483e-bfcb-fec760c58167
&Name=newimage
&AUTHPARAMS

Sample Response(返回)

<?xml version="1.0" encoding="UTF-8"?>
<CreateImageResponse xmlns="http://vm.ksyun.com/doc/2016-3-09/">
     <RequestId>27fb86b1-2c8e-4156-8845-f41faff65a3b</RequestId>
     <ImageId>15754278-6194-4b29-a3cd-677182c69b77</ImageId>
</CreateImageResponse>

DescribeImages(描述镜像信息)

描述当前可使用的镜像信息,包括私有镜像和公共镜像

Request Parameters(请求参数)

ImageId

镜像ID

类型: String

是否可缺省: 是

Response Elements(返回值)

RequestId 请求ID

类型: String

是否可缺省: 否

ImagesSet

镜像集合

类型: 镜像(Image) 列表

是否可缺省: 否

Examples(例子)

在默认region,描述全部可用镜像

Sample Request(请求)

http://kec.api.ksyun.com/?Action=DescribeImages&Version=2016-03-04
&AUTHPARAMS

Sample Response(返回)

<?xml version="1.0" encoding="UTF-8"?>
<DescribeImagesResponse xmlns="http://vm.ksyun.com/doc/2016-3-09/"> 
    <RequestId>5bec3a7e-8b58-4b48-a947-45cf85ed75c3</RequestId>
    <ImagesSet> 
        <Item> 
            <CreationDate>2016-04-30T16:29:00Z</CreationDate>
            <IsPublic>false</IsPublic> 
            <Name>newimage</Name> 
            <Platform>centos-6.5</Platform>
            <ImageState>ACTIVE</ImageState> 
            <ImageId>15754278-6194-4b29-a3cd-677182c69b77</ImageId> 
        </Item> 
        ... 
        <Item> 
            <CreationDate>2016-04-11T18:28:21Z</CreationDate>
            <IsPublic>true</IsPublic> 
            <Name>Centos-6.5-x86_64</Name> 
            <Platform>centos-6.5</Platform>
            <ImageState>ACTIVE</ImageState> <ImageId>667e731a-1c9a-4c44-9613-94a713b9ef94</ImageId> 
        </Item> 
    </ImagesSet>
</DescribeImagesResponse>

RemoveImages(删除镜像)

删除私有镜像,一次调用只能删除一个镜像(后续迭代增加批量)

Request Parameters(请求参数)

ImageId

待删除的镜像ID

类型: String

有效值:标准UUID格式,形如^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$

是否可缺省: 否

Response Elements(返回值)

RequestId 请求ID

类型: String

是否可缺省: 否

ReturnSet

镜像删除结果集合

类型: 镜像删除结果(ImageDeletion) 列表

是否可缺省: 否

Examples(例子)

在默认region,删除一个私有镜像

Sample Request(请求)

http://kec.api.ksyun.com/?Action=RemoveImages&Version=2016-03-04
&ImageId.1=15754278-6194-4b29-a3cd-677182c69b77
&AUTHPARAMS

Sample Response(返回)

<?xml version="1.0" encoding="UTF-8"?>
<RemoveImageResponse xmlns="http://vm.ksyun.com/doc/2016-3-09/">
    <ReturnSet> 
        <item> 
            <ImageId>15754278-6194-4b29-a3cd-677182c69b77</ImageId> 
            <Return>true</Return> 
        </item> 
    </ReturnSet> 
    <RequestId>b3ded367-781f-4c9e-aa05-b34a5a666610</RequestId>
</RemoveImageResponse>

ModifyImageAttribute(修改镜像属性信息)

修改私有镜像属性,当前只支持修改私有镜像名称,不能够修改公共镜像属性

Request Parameters(请求参数)

ImageId

待修改属性的镜像ID

类型: String 列表

是否可缺省: 否

Name

新镜像的名称

类型: String

有效值:2-64个字符,支持中文、字母、数字以及-_@#.字符

是否可缺省: 否

Response Elements(返回值) RequestId

请求ID

类型: String

是否可缺省: 否

Return

修改实例属性成功与否

类型: String

有效值:true(成功)| false(失败)

是否可缺省: 否

Examples(例子)

在默认region,修改一个私有镜像的名称

Sample Request(请求)

http://kec.api.ksyun.com/?Action=ModifyImageAttribute&Version=2016-03-04
&ImageId=16f55e1d-8ab3-4026-ba4d-5ae9e6f083db
&Name=test1234
&AUTHPARAMS

Sample Response(返回)

<?xml version="1.0" encoding="UTF-8"?>
<ModifyImageAttributeResponse xmlns="http://vm.ksyun.com/doc/2016-3-09/"> 
     <Return>true</Return> 
     <RequestId>b3ded367-781f-4c9e-aa05-b34a5a666610</RequestId>
</ModifyImageAttributeResponse>

Data Types

Instance(实例类型)

Contents(内容)

InstanceId

实例ID

类型: String

有效值:标准UUID格式,形如^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$

是否可缺省: 否

InstanceName

实例名称

类型: String

是否可缺省: 否

InstanceConfigure

实例配置,“创建实例”时不返回该信息,“描述实例”时返回该信息

类型: 实例配置( InstanceConfigure) 类型

是否可缺省: 是

ImageId

镜像ID,“创建实例”时不返回该信息,“描述实例”时返回该信息

类型: String

有效值:标准UUID格式,形如^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$

是否可缺省: 是

InstanceType

实例套餐类型,“创建实例”时不返回该信息,“描述实例”时返回该信息

类型: String

有效值: I1.1A | I1.1B| I1.1C| I1.2A| I1.2B| I1.2C| I1.4A| I1.4B| I1.4C| I1.8A| I1.8B| I1.8C| I1.16A| I1.16B| I1.16C| I1.24A| I1.24C| I1.24B| I1.24D| I1.32A| I1.32B; C1.1A | C1.1B | C1.1C | C1.2A | C1.2B | C1.2C | C1.4A | C1.4B | C1.4C | C1.8A | C1.8B | C1.8C | C1.16A | C1.16B | C1.16C| C1.24A | C1.24B | C1.24C | C1.24D | C1.32A | C1.32B ;S1.4A | S1.8A | S1.16A | S1.32A | I0. | N0. 具体套餐信息参考实例套餐类型定义

是否可缺省: 是

InstanceState

实例状态,“创建实例”时不返回该信息,“描述实例”时返回该信息

类型: 实例状态(InstanceState) 类型

是否可缺省: 是

SubnetId

主网卡子网ID,“创建实例”时不返回该信息,“描述实例”时返回该信息

类型: String

有效值:标准UUID格式,形如^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$

是否可缺省: 是

VpcId

主网卡VPCID,“创建实例”时不返回该信息,“描述实例”时返回该信息

类型: String

有效值:标准UUID格式,形如^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$

是否可缺省: 是

PrivateIpAddress

主网卡私有IP地址

类型: String

有效值:标准IP地址格式

是否可缺省: 是

Monitoring

监控状态,“创建实例”时不返回该信息,“描述实例”时返回该信息

类型: 监控状态 (Monitoring) 类型

是否可缺省: 是

SriovNetSupport

开启增强联网

类型:Boolean

是否可缺省:是

CreationDate

创建时间,“创建实例”时不返回该信息,“描述实例”时返回该信息

类型: String

有效值:按照ISO8601标准,使用UTC时间,格式为”YYYY-MM-DDThh:mm:ssZ”例如,2014-05-26T12:00:00Z (为北京时间2014年5月26日20点0分0秒)

是否可缺省: 否

NetworkInterfaceSet

网络接口集合,“创建实例”时不返回该信息,“描述实例”时返回该信息

类型: 网络接口(NetworkInterface) 列表

是否可缺省: 是

InstanceConfigure(实例配置类型)

Contents(内容)

VCPU

实例VCPU的个数

类型: Integer

是否可缺省: 否

MemoryGb

实例内存的大小,单位GB

类型: Integer

是否可缺省: 否

DataDiskType 数据磁盘类型

类型: String

有效值: SSD | SATA

是否可缺省: 否

DataDiskGb

数据磁盘大小,单位GB

类型: Integer

是否可缺省: 否

Monitoring(监控状态类型)

Contents(内容)

State

监控状态

类型: String

有效值: disabled | enabled

是否可缺省: 否

InstanceState(实例状态类型) Contents(内容)

Name

实例状态

类型: String

有效值: active | building | paused | suspended | stopped | rescued | resized | soft-delete | deleted | deleting | error | scheduling | block_device_mapping | networking | spawning | image_snapshot | image_backup | updating_password | resize_prep | resize_migrating | resize_migrated | resize_finish | resize_finish | resize_reverting | resize_confirming | migrating | rebooting | rebooting_hard | pausing | unpausing | suspending | resuming | stopping | starting | powering-off | powering-on | rescuing | unrescuing | rebuilding | rebuild_block_device_mapping | rebuild_spawning | deleting 主机状态注释

是否可缺省: 否

NetworkInterface(网络接口类型) Contents(内容)

NetworkInterfaceId

网络接口ID

类型: String

是否可缺省: 否

NetworkInterfaceType

网卡的类型

有效值:primary|extension

类型:String

是否可缺省: 否

MacAddress

网卡的MAC地址

类型:String

是否可缺省: 否

SubnetId

子网ID

类型: String

是否可缺省: 否

MacAddress

Mac地址

类型: String

是否可缺省: 否

PrivateIpAddress

私有IP地址

类型: String

是否可缺省: 否

SecurityGroupSet

实例绑定的安全组集合

类型: 安全组标识(GroupIdentifier) 列表

是否可缺省: 否

DNS1

网卡的DNS1

类型:String

是否可缺省: 否

DNS2

网卡的DNS2

类型:String

是否可缺省: 否

GroupIdentifier(安全组标识类型)

Contents(内容)

SecurityGroupId(兼容GroupId)

安全组ID

类型: String

是否可缺省: 否

InstanceStateChange(实例状态改变类型)

Contents(内容)

InstanceId

实例ID

类型: String

是否可缺省: 否

Return

实例状态改变成功与否

类型: String

有效值:true(成功)| false(失败)

是否可缺省: 否

InstanceMonitoring(实例监控状态类型)

Contents(内容)

InstanceId

实例ID

类型: String

是否可缺省: 否

Monitoring

监控状态

类型: 监控状态 (Monitoring) 类型

是否可缺省: 否

Filter(过滤器类型)

Contents(内容)

Name

过滤器名称,大小写敏感

类型: String

是否可缺省: 否

Value

一个或者多个过滤器值

类型: String 列表

是否可缺省: 否

Sort(筛选类型) Contents(内容)

Name

筛选名称,大小写敏感

类型: String

是否可缺省: 否

Value

筛选值

类型: String 列表

有效值:ACS(正序排列) | DESC(倒序排列)

是否可缺省: 否

Image(镜像类型)

Contents(内容)

Name

镜像名称

类型: String

是否可缺省: 否

ImageId

镜像ID

类型: String

有效值:标准UUID格式,形如^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$

是否可缺省: 否

CreationDate

创建时间

类型: String

有效值:按照ISO8601标准,使用UTC时间,格式为”YYYY-MM-DDThh:mm:ssZ”例如,2014-05-26T12:00:00Z (为北京时间2014年5月26日20点0分0秒)

是否可缺省: 否

IsPublic

是否为公共镜像

类型: String

有效值: true(公共镜像)| false(私有镜像)

是否可缺省: 否

Platform

镜像操作系统平台

类型: String

是否可缺省: 否

ImageState

镜像状态

类型: String

有效值: queued | saving | active | deactived | killed | deleted | pending_delete

是否可缺省: 否

InstanceId

关联实例ID

类型: String

是否可缺省: 否

BlockDeviceMapping(块存储映射信息)

Contents(内容)

DeviceName

EBS信息,从/dev/vda 开始到 /dev/vdz ,/dev/vda 则为系统盘,一台云服务器只有一个系统盘。如果主机类型不为通用型、超级云主机,则不可为/dev/vda。

类型: String

默认值:/dev/vda

是否可缺省: 是

Ebs

EBS属性

类型: EbsBlockDevice

是否可缺省: 否

EbsBlockDevice(EBS块设备)

Description(描述)

块设备描述。

Contents(内容)

VolumeName

EBS名字,2-40字符

类型: string

默认值:ksc-ebs+创建日期

是否可缺省: 是

VolumeDescription

EBS描述,2-40字符

类型: string

默认值:空

是否可缺省: 是

DeleteOnTermination

主机实例删除时是否同时删除。

类型: Boolean

默认值:当为系统盘无论是否输入false该参数均为true,数据盘默认为false。

是否可缺省: 是

VolumeSize

硬盘大小,单位GB

类型: Integer

有效值:系统盘,最小值为40,以10G为步进,最大500GB;数据盘,最小10GB,以10G为步进,最大16T(16384G)。

是否可缺省: 否

VolumeType

EBS类型

类型: String

默认值:SSD

有效值:SSD

是否可缺省: 是

SnapshotId

用来创建EBS数据盘的快照ID,系统盘不支持该参数。

类型:String

是否可缺省:是

ImageDeletion(镜像删除结果类型)

Contents(内容)

ImageId

镜像ID

类型: String

有效值:标准UUID格式,形如^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$

是否可缺省: 否

Return

镜像删除操作成功与否

类型: String

有效值:true(成功)| false(失败)

是否可缺省: 否

References(参考)

实例套餐类型定义

实例套餐类型:IO优化型(原高性能主机)、计算优化型、数据存储型

用户能够创建使用的实例套餐类型由账户和Region而异,当前各region支持的实例套餐类型如下

region IO优化型 IO优化型-支持联网增强 计算优化型 数据存储型
cn-beijing-6 支持 不支持 支持 支持
cn-shanghai-2 支持 支持 不支持 支持

IO优化型套餐(原高性能主机)

IO优化型套餐是利用本地SSD磁盘为云主机实例提供更高的随机IOPS和更低的IO延时。

使用场景:各类数据库如MongoDB、SQL Server和游戏应用等。

系统卷容量:linux操作系统 20GB、windows 操作系统 50GB

套餐明细

套餐类型名 VCPU(个) 内存容量(GB) 数据卷容量(GB本地SSD卷)
I1.1A 1 1 10-50
I1.1B 1 2 10-50
I1.1C 1 4 10-50
I1.2A 2 2 10-200
I1.2B 2 4 10-200
I1.2C 2 8 10-200
I1.4A 4 4 10-500
I1.4B 4 8 10-500
I1.4C 4 16 10-500
I1.8A 8 8 10-800
I1.8B 8 16 10-800
I1.8C 8 32 10-800
I1.16A 16 16 10-1000
I1.16B 16 32 10-1000
I1.16C 16 64 10-1000
I1.24A 24 24 10-1500
I1.24B 24 32 10-1500
I1.24C 24 48 10-1500
I1.24D 24 64 10-1500
I1.32A 32 32 10-2000
I1.32AB 32 64 10-2000

联网增强型

联网增强性主机大幅度提升网络的每秒数据包数 (PPS) 性能,降低网络抖动,并减少延迟。

联网增强型套餐目前只支持IO优化型,PPS指标不低于20w的PPS

使用场景:视频直播、即时通讯、房间式强联网网游等对网络实时性要求较高的应用。

套餐明细(基于IO优化型)

套餐类型名 VCPU(个) 内存容量(GB) 数据卷容量(GB本地SSD卷)
I1.8A 8 8 10-800
I1.8B 8 16 10-800
I1.8C 8 32 10-800
I1.16A 16 16 10-1000
I1.16B 16 32 10-1000
I1.16C 16 64 10-1000

计算优化型套餐

计算优化型套餐提供高CPU计算能力,采用Intel 志强 2680V3系列CPU。

使用场景:高负载前端集群、Web 服务器、批量处理、大规模分布式分析、高负载科学和工程应用、广告服务、MMO 游戏、视频编码和分布式分析等。

系统卷容量:linux操作系统 20GB、windows 操作系统 50GB

套餐明细

套餐类型名 VCPU(个) 内存容量(GB) 数据卷容量(GB本地SSD卷)
C1.1A 1 1 10-50
C1.1B 1 2 10-50
C1.1C 1 4 10-50
C1.2A 2 2 10-200
C1.2B 2 4 10-200
C1.2C 2 8 10-200
C1.4A 4 4 10-500
C1.4B 4 8 10-500
C1.4C 4 16 10-500
C1.8A 8 8 10-800
C1.8B 8 16 10-800
C1.8C 8 32 10-800
C1.16A 16 16 10-1000
C1.16B 16 32 10-1000
C1.16C 16 64 10-1000
C1.24A 24 24 10-1500
C1.24B 24 32 10-1500
C1.24C 24 48 10-1500
C1.24D 24 64 10-1500
C1.32A 32 32 10-2000
C1.32B 32 64 10-2000

数据存储优化型套餐

数据存储优化型套餐提供基于本地SATA卷的高磁盘配比的云主机。

使用场景:大规模并行处理数据仓库、MapReduce 和 Hadoop 分布式计算、分布式文件系统、网络文件系统、日志或数据处理应用。

系统卷容量:linux操作系统 20GB、windows 操作系统 50GB

套餐明细

套餐类型名 VCPU(个) 内存容量(GB) 数据卷容量(GB本地SATA卷)
S1.4A 4 16 1200
S1.8A 8 32 2500
S1.16A 16 64 5000
S1.32A 32 128 10000

通用型套餐(原EBS主机)

对IO、网络、磁盘大小、内存大小没有特殊要求的大多数应用场景。

使用场景:中小型Web应用、手机应用等对资源没有特殊要求场景。

系统盘容量:linux 20GB、windows50GB

套餐明细

套餐类型名 VCPU(个) 内存容量(GB) 数据卷容量(GB,EBS)
N1.1A 1 1 3块,1GB<大小<16GB
N1.1B 1 2 同上
N1.1C 1 4 同上
N1.2A 2 2 同上
N1.2B 2 4 同上
N1.2C 2 8 同上
N1.4A 4 4 同上
N1.4B 4 8 同上
N1.4C 4 16 同上
N1.8A 8 8 同上
N1.8B 8 16 同上
N1.8C 8 32 同上
N1.16A 16 16 同上
N1.16B 16 32 同上
N1.16C 16 64 同上
N1.24A 24 24 同上
N1.24B 24 32 同上
N1.24C 24 48 同上
N1.32A 32 32 同上
N1.32B 32 64 同上

主机状态注释

序号 状态 解释
1 active 运行正常
2 building 创建中
3 paused 暂停
4 suspended 挂起
5 stopped 关机
6 ressued 用指定的image作为启动盘引导instance,将instance本身的系统盘作为第二个磁盘挂载到操作系统上,是OpenStack提供的一种故障恢复机制
7 resized 离线迁移完成待确定/回退
8 soft-delete 已延迟删除,设定周期后自动强制删除
9 deleted 已删除
10 deleting 删除中
11 error 错误

主机任务状态

序号 状态 对应主机功能
1 scheduling 调度中,创建主机
2 block_device_mapping 调度中,创建主机
3 networking 创建网络中,创建主机
4 spawning 主机生成中,创建主机
5 image_snapshot 快照创建中,创建快照
6 image_backup 备份创建中,创建备份
7 updating_password 主机修改密码中,修改密码
8 resize_prep 准备升级配置/准备离线迁移,升级配置/离线迁移
9 resize_migrating 离线迁移中,离线迁移
10 resize_migrated 已离线迁移,离线迁移
11 resize_finish 离线迁移完成,离线迁移
12 resize_reverting 离线迁移回退中,离线迁移
13 resize_confirming 离线迁移确认中,离线迁移
14 migrating 在线迁移中,在线迁移
15 rebooting 重启中,重启
16 rebooting_hard 硬重启中,硬重启
17 pausing 暂停中,暂停主机
18 unpausing 取消暂停中,取消暂停
19 suspending 挂起中,挂起
20 resuming 挂起恢复中,挂起恢复
21 stopping 关机中,关机
22 starting 开机中,开机
23 powering_off 电源关闭中,主机延迟删除(soft—delete)
24 powering_on 电源开启中,主机延迟删除恢复(restore)
25 rescuing 故障恢复中,主机rescue
26 unrescuing 解除故障恢复状态中,主机unrescue
27 rebuilding 重装系统中,主机重装系统
28 rebuild_block_device_mapping 重装系统块设备映射中,主机重装系统
29 rebuild_spawning 重装系统主机生成中,主机重装系统
30 deleting 删除中