云服务器(KEC)

      文档中心 云服务器(KEC) API文档 历史版本 0530

      0530

      最近更新时间：2018-08-03 18:07:16

      查看PDF

      API Version (2016-03-04)
      Actions
      RunInstances（创建实例）
      从有访问权限的镜像（image）启动指定数量的实例。
      在启动实例时，实例属于“创建中”（pending）状态，在实例准备好时，会进入“运行中（running）”状态。
      Request Parameters（请求参数）
      ImageId
      镜像ID
      类型: String
      有效值：标准UUID格式，形如[1]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$
      是否可缺省: 否
      InstanceType
      实例套餐类型，如果调用时未指定实例套餐类型，默认值为I1.1A
      类型: 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
      具体套餐信息参考实例套餐类型定义
      是否可缺省: 是
      DataDiskGb
      数据卷容量，单位GB，容量限制依据实例套餐类型定义变化，如果调用时未指定，则为相应实例套餐类型最小值
      类型: Integer
      是否可缺省: 是
      MaxCount
      最大实例数，如果指定的实例数大于金山云在本region所能创建的最大实例数，则会创建大于MinCount数量的最大允许实例数。
      类型: Integer
      有效值: 最小值1，最大值为MIN(当前用户实例剩余配额，30），即用户剩余配额和100比较的小者
      是否可缺省: 否
      MinCount
      最小实例数，如果指定的实例数大于金山云在本region所能创建的最大实例数，则不会创建任何实例。
      类型: Integer
      有效值: 最小值1，最大值为MIN(当前用户实例剩余配额，30），即用户剩余配额和100比较的小者
      是否可缺省: 否
      SubnetId
      VPC环境下的子网ID，绑定到主网卡
      类型: String
      有效值：标准UUID格式，形如[2]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$
      是否可缺省: 否
      InstancePassword
      实例开机密码
      类型: String
      有效值：最短8字符，最长32字符，必须包含大小写英文字符和数字，支持其他可见字符
      是否可缺省: 否
      ChargeType
      计费类型，调用时需要明确指定，无默认值
      类型: String
      有效值：Monthly（包年包月）
      是否可缺省: 否
      PurchaseTime
      购买时长，单位月
      类型: Integer
      有效值：当计费类型为Monthly（包年包月）时，有效值1-36；其他计费类型时，强制要求参数值为0
      是否可缺省: 否
      SecurityGroupId
      安全组ID
      类型: String
      有效值：标准UUID格式，形如[3]{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字符，支持中英文
      是否可缺省: 是
      SriovNetSupport
      是否开启增强联网，目前只支持cn-beijing-6区域的IO优化型套餐，套餐类型只持8核、16核套餐，且只支持CentOS 6.6、6.7、7.0、7.1的镜像
      类型: Boolean
      有效值：true | false
      是否可缺省: 是
      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：在销毁实例时，如果实例是七层SLB的真实服务器成员，则不允许直接销毁，需要先从SLB上解绑实例。
      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
      有效值: 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
      具体套餐信息参考实例套餐类型定义
      是否可缺省: 否
      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（更换或者重新安装实例操作系统）
      重新安装/更换实例的操作系统
      Request Parameters（请求参数）
      InstanceId
      待更换或者重新安装操作系统的实例ID
      类型: String
      有效值：标准UUID格式，形如[4]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$
      是否可缺省: 否
      ImageId
      待更换的镜像ID；如果缺省，表明无需改变镜像，只需重新安装实例的操作系统。
      类型: String
      有效值：标准UUID格式，形如[5]{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格式，形如[6]{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>

      DescribeInstances（描述实例信息）
      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
      是否可缺省: 是
      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>
            <CreationDate>2014-05-26T12:00:00Z</CreationDate>
            <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>
                    <GroupSet>
                        <Item>
                            <GroupId>d92f3801-2cb3-4809-897e-8ba95f491e78</GroupId>
                        </Item>
                    </GroupSet>
                    <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）。
      特殊场景：如果跨VPC修改子网，则除子网ID外，必须同时指定新VPC的安全组信息。
      约束条件1：在更换子网时，如果网络接口已经绑定EIP，则不允许更改，需要先解绑EIP。
      约束条件2：在更换子网时，如果网络接口所属实例是某个SLB的真实服务器，则不允许更改，需要从SLB上先解绑真实服务器。
      Request Parameters（请求参数）
      InstanceId
      待修改属性的实例ID
      类型: String
      有效值：标准UUID格式，形如[7]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$
      是否可缺省: 否
      NetworkInterfaceId
      待修改属性的网络接口ID
      类型: String
      有效值：标准UUID格式，形如[8]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$
      是否可缺省: 否
      SecurityGroupId
      新的安全组ID
      类型: String
      有效值：标准UUID格式，形如[9]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$
      是否可缺省: 是
      SubnetId
      新的子网ID
      类型: String
      有效值：标准UUID格式，形如[10]{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>

      CreateImage（创建镜像）
      在实例关闭状态下，从实例根设备（系统卷）创建私有镜像
      Request Parameters（请求参数）
      InstanceId
      待创建镜像的实例ID
      类型: String
      有效值：标准UUID格式，形如[11]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$
      是否可缺省: 否
      Name
      新镜像的名称
      类型: String
      有效值：2-64个字符，支持中文、字母、数字以及[email protected]#.字符
      是否可缺省: 否
      Response Elements（返回值）
      RequestId
      请求ID
      类型: String
      是否可缺省: 否
      ImageId
      新创建的镜像ID
      类型: String
      有效值：标准UUID格式，形如[12]{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-05-25T19:56:08Z</CreationDate>
            <InstanceId>b7295d44-f362-4822-b263-dfec3d8cc1fc</InstanceId>
            <IsPublic>false</IsPublic>
            <Name>test</Name>
            <Platform>centos-6.5</Platform>
            <ImageState>active</ImageState>
            <ImageId>175be983-8622-409d-8573-51c17a802aaa</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>

      RemoveImage（删除镜像）
      删除私有镜像，一次调用只能删除一个镜像
      Request Parameters（请求参数）
      ImageId
      待删除的镜像ID
      类型: String
      有效值：标准UUID格式，形如[13]{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个字符，支持中文、字母、数字以及[email protected]#.字符
      是否可缺省: 否
      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格式，形如[14]{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格式，形如[15]{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.*
      具体套餐信息参考实例套餐类型定义
      是否可缺省: 是
      CreationDate
      实例创建时间
      类型: DateTime
      有效值：按照ISO8601标准，使用UTC时间，格式为”YYYY-MM-DDThh:mm:ssZ”例如，2014-05-26T12:00:00Z （为北京时间2014年5月26日20点0分0秒）
      是否可缺省: 是
      PrivateIpAddress
      私有IP地址
      类型: String
      有效值：标准IP地址格式
      是否可缺省: 是
      Monitoring
      监控状态，“创建实例”时不返回该信息，“描述实例”时返回该信息
      类型: 监控状态 （Monitoring） 类型
      是否可缺省: 是
      InstanceState
      实例状态，“创建实例”时不返回该信息，“描述实例”时返回该信息
      类型: 实例状态（InstanceState） 类型
      是否可缺省: 是
      SubnetId
      子网ID，“创建实例”时不返回该信息，“描述实例”时返回该信息
      类型: String
      有效值：标准UUID格式，形如[16]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$
      是否可缺省: 是
      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
      是否可缺省: 否
      SubnetId
      子网ID
      类型: String
      是否可缺省: 否
      MacAddress
      Mac地址
      类型: String
      是否可缺省: 否
      PrivateIpAddress
      私有IP地址
      类型: String
      是否可缺省: 否
      GroupSet
      实例绑定的安全组集合
      类型: 安全组标识（GroupIdentifier） 列表
      是否可缺省: 否
      GroupIdentifier(安全组标识类型)
      Contents(内容)
      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 列表
      是否可缺省: 否
      Image(镜像类型)
      Contents(内容)
      Name
      镜像名称
      类型: String
      是否可缺省: 否
      ImageId
      镜像ID
      类型: String
      有效值：标准UUID格式，形如[17]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$
      是否可缺省: 否
      InstanceId
      私有镜像类型的来源实例ID，公共镜像无此值
      类型: String
      有效值：标准UUID格式，形如[18]{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
      是否可缺省: 否
      ImageDeletion(镜像删除结果类型)
      Contents(内容)
      ImageId
      镜像ID
      类型: String
      有效值：标准UUID格式，形如[19]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$
      是否可缺省: 否
      Return
      镜像删除操作成功与否
      类型: String
      有效值：true（成功）| false（失败）
      是否可缺省: 否

      1. 0-9a-f ↩︎

      2. 0-9a-f ↩︎

      3. 0-9a-f ↩︎

      4. 0-9a-f ↩︎

      5. 0-9a-f ↩︎

      6. 0-9a-f ↩︎

      7. 0-9a-f ↩︎

      8. 0-9a-f ↩︎

      9. 0-9a-f ↩︎

      10. 0-9a-f ↩︎

      11. 0-9a-f ↩︎

      12. 0-9a-f ↩︎

      13. 0-9a-f ↩︎

      14. 0-9a-f ↩︎

      15. 0-9a-f ↩︎

      16. 0-9a-f ↩︎

      17. 0-9a-f ↩︎

      18. 0-9a-f ↩︎

      19. 0-9a-f ↩︎

      上一篇：0913
      下一篇：多类型主机的区别是什么？

      文档内容是否对您有帮助？

      根本没帮助
      文档较差
      文档一般
      文档不错
      文档很好

      在文档使用中是否遇到以下问题

      内容不全，不深入
      内容更新不及时
      描述不清晰，比较混乱
      系统或功能太复杂，缺乏足够的引导
      内容冗长

      更多建议

      0/200

      评价建议不能为空

      提交成功！

      非常感谢您的反馈，我们会继续努力做到更好！

      问题反馈