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. CaaS雲伺服器會有三張網卡,但部份網卡保留,不可被使用
  7. CVPC雲伺服器會有五張網卡
  8. 當雲伺服器做成用戶範本時,此用戶範本會記錄當下雲伺服器網卡狀態
  9. 網卡狀態分成三種
    • 0: 不存在
    • 1: 停用
    • 2: 啟用
  10. 雲伺服器複製雲伺服器時,需注意要與新申請雲伺服器的網卡狀態與所對應的子網段服務識別碼的關係, 若沒有輸入 vnic1AdapterStatus, vnic2AdapterStatus, vnic3AdapterStatus,則這三個值預設會和原本雲伺服器的三張網卡的狀態的值一致, 例如: 原本的雲伺服器三張網卡分別為 vnic 1 啟用,vnic 2 停用, vnic 3 不存在,則預設值 vnic1AdapterStatus=2 , vnic2AdapterStatus=1, vnic3AdapterStatus=0
  11. 關於 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
  12. 關於 CVPC 的雲伺服器
    1. 申請 CVPC 的雲伺服器時,必需指定 vpcBusinessServiceId及IpVersion
    2. CVPC 的雲伺服器最多有五張網卡
    3. 採用公用範本申請 CVPC 雲伺服器時, vnic2SubnetBusinessServiceId, vnic3SubnetBusinessServiceId, vnic4SubnetBusinessServiceId,vnic5SubnetBusinessServiceId, vnic2UserAssignIp, vnic3UserAssignIp,vnic4UserAssignIp,vnic5UserAssignIp, vnic2AdapterStatus, vnic3AdapterStatus, vnic4AdapterStatus, vnic5AdapterStatus 值不可設定;vnic1AdapterStatus 預設值為 2 且不可被設定成 0 或 1,vnic1IpVersion 為必填欄位 0表示IPv4,1表示IPv6 vnic1SubnetBusinessServiceId 為必填欄位,用來設定網卡 1 子網段服務識別碼, 也可透過參數 vnic1UserAssignIp 來指定 ip
    4. 採用 CVPC 雲伺服器複製 CVPC 雲伺服器時,需注意:原本雲伺服器的五張網卡的狀態要與新申請雲伺服器的網卡所對應的子網段服務識別碼的對應關係, 如:當原始的用戶範本的網卡狀態為vnic1AdapterStatus=2 (啟用), vnic2AdapterStatus=1(停用), vnic3AdapterStatus=0 (不存在),vnic4AdapterStatus=0 (不存在),vnic5AdapterStatus=0 (不存在) 則 vnic1SubnetBusinessServiceId 為必填, vnic2SubnetBusinessServiceId 不可填, vnic3SubnetBusinessServiceId 不可填, vnic4SubnetBusinessServiceId 不可填, vnic5SubnetBusinessServiceId 不可填
    5. 採用用戶範本複製雲伺服器時, 需注意範本有多少張網卡,就需提供相對應的網卡資訊。若範本有三張網卡,則需指定vnic1IpVersion、vnic1SubnetBusinessServiceId、vnic2IpVersion、vnic2SubnetBusinessServiceId、vnic3IpVersion、vnic3SubnetBusinessServiceId

Request參數

參數 說明 備註

imageId

(非必要參數)

雲伺服器公用或用戶範本編號
類型 : String
預設值 : 無
使用情境 : 根據需求選定雲伺服器範本編號
是否為複數型態 : 否
不同的雲伺服器範本其預裝軟體會有所不同

當為公用範本時,格式為 “虛擬機範本編號”,如: hi-qpo357q7用戶範本複製雲伺服器

當為 “用戶範本複製雲伺服器” ,格式為範本服務識別碼列表,如:BT550100010001

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
預設值 : 無
是否為複數型態 : 否

vnic4SubnetBusinessServiceId

(非必要參數)

網卡 4 子網段服務識別碼
類型 : String
預設值 : 無
是否為複數型態 : 否

vnic5SubnetBusinessServiceId

(非必要參數)

網卡 5 子網段服務識別碼
類型 : String
預設值 : 無
是否為複數型態 : 否

vnic1UserAssignIp

(非必要參數)

網卡 1 用戶選定 IP
類型 : String
預設值 : 無
是否為複數型態 : 否

vnic2UserAssignIp

(非必要參數)

網卡 2 用戶選定 IP
類型 : String
預設值 : 無
是否為複數型態 : 否

vnic3UserAssignIp

(非必要參數)

網卡 3 用戶選定 IP
類型 : String
預設值 : 無
是否為複數型態 : 否

vnic4UserAssignIp

(非必要參數)

網卡 4 用戶選定 IP
類型 : String
預設值 : 無
是否為複數型態 : 否

vnic5UserAssignIp

(非必要參數)

網卡 5 用戶選定 IP
類型 : String
預設值 : 無
是否為複數型態 : 否

vnic1AdapterStatus

(非必要參數)

網卡 1 狀態, 0: 不存在, 1: 停用, 2: 啟用
類型 : String
預設值 : 無
是否為複數型態 : 否

vnic2AdapterStatus

(非必要參數)

網卡 2 狀態, 0: 不存在, 1: 停用, 2: 啟用
類型 : String
預設值 : 無
是否為複數型態 : 否

vnic3AdapterStatus

(非必要參數)

網卡 3 狀態, 0: 不存在, 1: 停用, 2: 啟用
類型 : String
預設值 : 無
是否為複數型態 : 否

vnic4AdapterStatus

(非必要參數)

網卡 4 狀態, 0: 不存在, 1: 停用, 2: 啟用
類型 : String
預設值 : 無
是否為複數型態 : 否

vnic5AdapterStatus

(非必要參數)

網卡 5 狀態, 0: 不存在, 1: 停用, 2: 啟用
類型 : String
預設值 : 無
是否為複數型態 : 否

vnic1IpVersion

(非必要參數)

網卡 1 IP版本, 0: IPV4, 1: IPV6
類型 : String
預設值 : 無
是否為複數型態 : 否

vnic2IpVersion

(非必要參數)

網卡 2 IP版本, 0: IPV4, 1: IPV6
類型 : String
預設值 : 無
是否為複數型態 : 否

vnic3IpVersion

(非必要參數)

網卡 3 IP版本, 0: IPV4, 1: IPV6
類型 : String
預設值 : 無
是否為複數型態 : 否

vnic4IpVersion

(非必要參數)

網卡 4 IP版本, 0: IPV4, 1: IPV6
類型 : String
預設值 : 無
是否為複數型態 : 否

vnic5IpVersion

(非必要參數)

網卡 5 IP版本, 0: IPV4, 1: IPV6
類型 : 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"]
}