CaaS / CVPC API 开发者中心

云服务器

使用说明

runInstances主要是用于产生一个或多个云服务器

  1. 制作云用云伺服器的方法有以下三种
    1. 采用公用范本申请云伺服器 (create vm from public image)
    2. 采用云伺服器复制云伺服器 (clone vm from vm)
    3. 采用用户范本复制云伺服器 (create vm from template)
  2. 采用公用范本或是用户范本复制云伺服器时，imageId, instanceType 参数为必填
  3. 采用云伺服器复制云伺服器时，instanceId参数为必填，此时imageId, instanceType, monitoringEnabled 的参数将被忽略
  4. 采用用户范本复制云伺服器时，此时 monitoringEnabled 的参数将被忽略
  5. 若云伺服器有关连的快照或备份，则无法执行云伺服器复制云伺服器
  6. 云伺服器会有三张网卡，但部份网卡保留，不可被使用
  7. 当云伺服器做成用户范本时，此用户范本会记录当下云伺服器网卡状态
  8. 网卡状态分成三种
    • 0: 不存在
    • 1: 停用
    • 2: 启用
  9. 云伺服器复制云伺服器时，需注意要与新申请云伺服器的网卡状态与所对应的子网段服务识别码的关系， 若没有输入 vnic1AdapterStatus, vnic2AdapterStatus, vnic3AdapterStatus，则这三个值预设会和原本云伺服器的三张网卡的状态的值一致， 例如: 原本的云伺服器三张网卡分别为 vnic 1 启用，vnic 2 停用， vnic 3 不存在，则预设值 vnic1AdapterStatus=2 , vnic2AdapterStatus=1, vnic3AdapterStatus=0
  10. 关于 CaaS 的云伺服器
    1. 申请 CaaS 的云伺服器时，不可指定 vpcBusinessServiceId
    2. CaaS 的云伺服器最多有三张网卡，但只 vnic 1 和 vnic 3 可使用， vnic 2 保留；其中 vnic 1 是不可被移除的 (vnic1AdapterStatus 必需为 2)，不可指定 ip (vnic1UserAssignIp 需为 null)，也不可指定子网段 (vnic1SubnetBusinessServiceId 需为 null)； vnic 2 无作用，不可指定相关的参数 vnic2SubnetBusinessServiceId, vnic2AdapterStatus 和 vnic2UserAssignIp ；而 vnic 3 为子网段的网卡，不一定需存在
    3. 采用公用范本申请 CaaS 云伺服器时，vnic1SubnetBusinessServiceId, vnic2SubnetBusinessServiceId, vnic3SubnetBusinessServiceId, vnic1UserAssignIp, vnic2UserAssignIp, vnic3UserAssignIp, vnic2AdapterStatus, vnic3AdapterStatus 值不可设定；vnic1AdapterStatus 预设值为 2 且不可被设定成 0 或 1
    4. 采用 CaaS 云伺服器复制 CaaS 云伺服器时， vnic1SubnetBusinessServiceId, vnic2SubnetBusinessServiceId, vnic1UserAssignIp, vnic2UserAssignIp, vnic2AdapterStatus 值不可设定；vnic1AdapterStatus 预设值为 2 且不可被设定成 0 或 1；如果要设定子网段网卡，则 vnic3AdapterStatus 需为 2 ， vnic3SubnetBusinessServiceId 用来设定网卡 3 子网段服务识别码 ，也可透过参数 vnic3UserAssignIp 来指定 ip
    5. 采用用户范本复制云伺服器时，vnic1SubnetBusinessServiceId, vnic2SubnetBusinessServiceId, vnic1UserAssignIp, vnic2UserAssignIp, vnic2AdapterStatus 值不可设定；vnic1AdapterStatus 预设值为 2 且不可被设定成 0 或 1；如果要设定子网段网卡，则 vnic3AdapterStatus 需为 2 ， vnic3SubnetBusinessServiceId 用来设定网卡 3 子网段服务识别码 ，也可透过参数 vnic3UserAssignIp 来指定 ip
  11. 关于 CVPC 的云伺服器
    1. 申请 CVPC 的云伺服器时，必需指定 vpcBusinessServiceId
    2. CVPC 的云伺服器最多有三张网卡，但只 vnic 1 和 vnic 2可使用， vnic 3 保留；其中vnic 1 和 vnic 2，两张网卡均为子网段的网卡，至少需存在一张网卡，不必为第一张网卡；vnic 3 无作用，不可指定相关的参数 vnic3SubnetBusinessServiceId, vnic3AdapterStatus 和 vnic3UserAssignIp
    3. 采用公用范本申请 CVPC 云伺服器时， vnic2SubnetBusinessServiceId, vnic3SubnetBusinessServiceId, vnic2UserAssignIp, vnic3UserAssignIp, vnic2AdapterStatus, vnic3AdapterStatus 值不可设定；vnic1AdapterStatus 预设值为 2 且不可被设定成 0 或 1，vnic1SubnetBusinessServiceId 为必填栏位，用来设定网卡 1 子网段服务识别码， 也可透过参数 vnic1UserAssignIp 来指定 ip
    4. 采用 CVPC 云伺服器复制 CVPC 云伺服器时，需注意：原本云伺服器的三张网卡的状态要与新申请云伺服器的网卡所对应的子网段服务识别码的对应关系， 如：当原始的用户范本的网卡状态为vnic1AdapterStatus=2 (启用), vnic2AdapterStatus=1(停用), vnic3AdapterStatus=0 (不存在)， 则 vnic1SubnetBusinessServiceId 为必填， vnic2SubnetBusinessServiceId 不可填， vnic3SubnetBusinessServiceId 不可填
    5. 采用用户范本复制云伺服器时，vnic3SubnetBusinessServiceId, vnic3UserAssignIp, vnic3AdapterStatus 值不可设定

Request 参数

参数 说明 备注

imageId

(非必要参数)

 云服务器模板编号
类型 : String
默认值 : 无
使用情境 : 根据需求选定云服务器模板编号
是否为复数型态 : 否
 不同的云服务器模板其预装软件会有所不同

instanceType

(非必要参数)

 运算规格
类型 : String
默认值 : 无
使用情境 : 不同运算规格 (包含：cpu、memory, os) 其计价与运算能力均不相同
是否为复数型态 : 否

可使用的值请参考 产品与运算规格资讯表

monitoringEnabled

(非必要参数)

 是否要供装监控
类型 : Boolean
默认值 : false
是否为复数型态 : 否
  

instanceName

(非必要参数)

 云服务器名称
类型 : String
默认值 : 无
是否为复数型态 : 否
 为你的云服务器指定一个容易标识的名称

count

(非必要参数)

 数量
类型 : Integer
默认值: 1
是否为复数型态 : 否
 最大值为10，最小值为 1

instanceId

(非必要参数)

 来源主机服务标识号
类型 : String
默认值 : 无
是否为复数型态 : 否

regionId

(非必要参数)

 区域机房代码
类型 : String
预设值 : 无
是否为复数型态 : 否

已不在需使用此参数

区域机房代码资讯请参考产品与运算规格资讯表

"region-tw-1": 第一区域
"region-tw-2": 第二区域
"region-hgr-1": HGR第一区域
"region-hgr-2": HGR第二区域

vpcBusinessServiceId

(非必要参数)

 软体资料中心服务识别码
类型 : String
预设值 : 无
是否为复数型态 : 否

vnic1SubnetBusinessServiceId

(非必要参数)

 网卡 1 子网段服务识别码
类型 : String
预设值 : 无
是否为复数型态 : 否

vnic2SubnetBusinessServiceId

(非必要参数)

 网卡 2 子网段服务识别码
类型 : String
预设值 : 无
是否为复数型态 : 否

vnic3SubnetBusinessServiceId

(非必要参数)

 网卡 3 子网段服务识别码
类型 : String
预设值 : 无
是否为复数型态 : 否

vnic1UserAssignIp

(非必要参数)

 网卡 1 用户选定 IP
类型 : String
预设值 : 无
是否为复数型态 : 否

vnic2UserAssignIp

(非必要参数)

 网卡 2 用户选定 IP
类型 : String
预设值 : 无
是否为复数型态 : 否

vnic3UserAssignIp

(非必要参数)

 网卡 3 用户选定 IP
类型 : String
预设值 : 无
是否为复数型态 : 否

vnic1AdapterStatus

(非必要参数)

 网卡 1 状态, 1: 停用, 2: 启用
类型 : String
预设值 : 无
是否为复数型态 : 否

vnic2AdapterStatus

(非必要参数)

 网卡 2 状态, 1: 停用, 2: 启用
类型 : String
预设值 : 无
是否为复数型态 : 否

vnic3AdapterStatus

(非必要参数)

 网卡 3 状态, 1: 停用, 2: 启用
类型 : String
预设值 : 无
是否为复数型态 : 否

Response 参数

参数 说明 备注

requestId

(非必要参数)

 请求标识号
类型 : JSON value : string
是否为复数型态 : 否 		系统自动生成
orderUuidList 订单编号列表
类型 : JSON value : array
使用情境 : 供订单查询使用
是否为复数型态 : 是
 string列表

Request示例

范例 1 (公用范本):		
https://hws.hicloud.hinet.net/cloud_hws/api/hws/?action=runInstances
&imageId=hi-cuium8up
&instanceType=HC1.S.WIN
&monitoringEnabled=false
&instanceName=myInstance
&count=1
&regionId=${regionId}
&chtAuthType=hwspass
&version=${version}
&expires=${expires}
&accessKey=${accessKey}
&signature=${signature}

范例 2 (云伺服器复制云伺服器):
https://hws.hicloud.hinet.net/cloud_hws/api/hws/?action=runInstances
&instanceId=BV550100010001
&monitoringEnabled=false
&instanceName=myInstance
&count=1
&chtAuthType=hwspass
&version=${version}
&expires=${expires}
&accessKey=${accessKey}
&signature=${signature}

范例 3 (用户范本复制云伺服器):
https://hws.hicloud.hinet.net/cloud_hws/api/hws/?action=runInstances
&imageId=BT550100010001
&instanceType=HC1.S.WIN
&instanceName=myInstance
&chtAuthType=hwspass
&version=${version}
&expires=${expires}
&accessKey=${accessKey}
&signature=${signature}

Response示例

	{
		"requestId": "xxxEXAMPLE",
		"orderUuidList": ["b8b5a2c9-760a-4106-b1c7-c7963d5d7e84"]
	}

相关链接

terminateInstances
describeInstances

错误信息

IncorrectDefaultContectPerson
IncorrectOrderProcessResultCode
InvalidParameterValue
OrderProcessFail
客服专线：0800-080-365　联系我们：hicloud@cht.com.tw
中华电信版权所有 © 2011 Chunghwa Telecom All Rights Reserved. 隐私权保护