API使用說明 游志誠 risc@cht.com.tw.

Presentation on theme: "API使用說明 游志誠 risc@cht.com.tw."— Presentation transcript:

1 API使用說明 游志誠

2 試用步驟說明(用戶)(1/5) 如何開始? 於API開發者平台瀏覽API說明文件，並了解如何發送REST請求
由CloudBOSS UP申請一組API試用金鑰 到UP去申請用戶唯一的一組使用金鑰(Access Key)與加密用的私密金鑰(Secret Key)。 於API開發者平台瀏覽關於計算簽名的方式或下載計算簽名方法的Java SDK 在API使用的說明文件中，瀏覽如何將URI參數計算簽名(signature)的方法。使用Java的開發者亦可下載具計算方法的SDK(software development kits)。 於API開發者平台瀏覽API說明文件，並了解如何發送REST請求 在API使用說明文件中，瀏覽各API的內容細節說明，其中包含請求參數、回應參數與範例。 對於如何發送REST請求亦有詳細的說明。 開始使用API 撰寫發送REST請求，來呼叫Hicloud CaaS等各種API服務。 API REST服務呼叫網址 hws.hicloud.hinet.net

3 試用步驟說明(用戶) (2/5) API開發者平台：http://hws.hicloud.hinet.net/hws-doc/

4 試用步驟說明(用戶) (3/5) 試用環境Cloud BOSS UP： 申請或查詢API試用金鑰 點擊後可檢視私密金鑰的內容。 點擊UP的”API資訊”連結，可進行金鑰的申請或查詢。 將兩把金鑰記錄下來，以 便計算簽名與發送REST請求。

5 試用步驟說明(用戶) (4/5) API開發者平台：http://hws.hicloud.hinet.net/hws-doc/
關於簽名(signature)計算的方式 在不用登入即可瀏覽的hicloud web services的API說明文件中，”呼叫REST的方法”連結內，有包含了簽名計算的方法說明。 在首頁點擊下載連結，可下載具簽名計算方法的Java SDK。

6 開發或使用能發出REST請求的Http Client程式
試用步驟說明(用戶) (5/5) 最後，開始使用API開發您的應用程式 請善加利用hicloud Web Services說明文件，內有共通參數說明與錯誤代碼等資訊，能加速您的應用程式開發。 發送帶有簽名的REST請求API 服務 開發或使用能發出REST請求的Http Client程式 使用秘密金鑰計算得到簽名字串

7 提供使用之API指令 分類 API Name Description 虛擬機 runInstances
建立虛擬機 (可指定 Clone From Template 或是虛擬機服務識別碼 Clone From VM) terminateInstances 刪除虛擬機 rebootInstances 重啟虛擬機 startInstances 啟動虛擬機 stopInstances 停止虛擬機 describeInstances 查詢虛擬機列表 modifyInstanceAttribute 虛擬機升降級 (含 CPU or RAM or Cloud Watch的異動) CloudWatch getInstancesStats 取得VM的各項監控項目的最新一筆資料 LoadBalancer describeLoadBalancerPolicies 查詢負載平衡規則資訊列表 createLoadBalancerPolicy 建立負載平衡規則 replaceLoadBalancerPolicy 修改負載平衡規則 deleteLoadBalancerPolicy 刪除負載平衡規則

8 使用REST Client呼叫API 使用工具
Firefox with RESTClient plug-in (或是其他REST Client) JsonView

9 取得金鑰 試用環境Cloud BOSS UP：https://hwsup.hicloud.hinet.net/cloud/登入
申請或查詢API試用金鑰 點擊後可檢視私密金鑰的內容。 點擊UP的”API資訊”連結，可進行金鑰的申請或查詢。 將兩把金鑰記錄下來，以 便計算簽名與發送REST請求。

10 計算Signature 詳細計算方式請參考

11 執行API指令 REST服務提供網址 +${resultQuery}

12 共通參數 action:要執行的API指令 version:指令版本 (目前版本:2013-03-29)
chtAuthType:認證機制 (需填hwspass) expires:該呼叫時間失效的時間點，採用ISO8601時間格式為YYYY-MM-DDThh:mm:ssZ accessKey:客戶所分配到之accessKey signature:驗證碼，驗證該呼叫是否合法

13 申租虛擬機(1/2) 對應指令runInstances 使用標準虛擬機template 參數 複製指定虛擬機
imageId:虛擬機範本編號 e.g. hi-qe4ug9ev instanceType:運算規格 e.g. HC1.XS.LINUX monitoringEnabled instanceName 複製指定虛擬機 vm id

14 申租虛擬機(2/2)

15 查詢虛擬主機資訊 查詢虛擬機:describeInstances 參數
businessServiceId或orderUuid (若沒給則是查詢全部)

16 虛擬機操作 開機:startInstances 關機: stopInstances 重開機: rebootInstances
參數: businessServiceId (可為複數) 關機: stopInstances 重開機: rebootInstances

17 虛擬機開機

18 虛擬機關機

19 虛擬機重開機(1/2)

20 虛擬機重開機(2/2)

21 虛擬機屬性異動(1/2) 相關指令:modifyInstanceAttribute 提供虛擬機做原機升降級或供裝虛擬機監控之功能
原機升降級可以轉換之虛擬機規格請參考「原機升降級群組與運算規格對應表」 參數 businessServiceId :異動之虛擬機服務識別碼 instanceType:異動之運算規格代碼 monitoringEnabled:是否進行監控 (參數中若包含instanceType，則monitoringEnabled 的參數將被忽略)

22 虛擬機屬性異動(2/2)

23 虛擬機監控 相關指令:getInstancesStats 參數: businessServiceId (可為複數)

24 LAB1 登入用戶入口 指令操作 申請金鑰 申租虛擬機-2擇1 進行虛擬機操作(開機、關機、重開機) 查詢虛擬機監控資訊 進行虛擬機升降級
imageId:hi-7ogdvkqh  instanceType:HC1.XS.WIN imageId:hi-qe4ug9ev instanceType:HC1.XS.LINUX 進行虛擬機操作(開機、關機、重開機) 查詢虛擬機監控資訊 進行虛擬機升降級 下載虛擬機密碼 登入虛擬機

25 複製虛擬機

26 申租負載平衡服務 相關指令:createLoadBalancerPolicy businessServiceId port

27 查詢負載平衡服務 相關指令:describeLoadBalancerPolicies
參數:businessServiceId (可複數、非必要)

28 異動負載平衡(1/2) 相關指令:replaceLoadBalancerPolicy 參數
businessServiceId:負載平衡服務識別碼 instanceBusinessServiceId:虛擬機服務識別碼 port

29 異動負載平衡(2/2)

30 退租負載平衡服務 相關指令:deleteLoadBalancerPolicy 參數: businessServiceId (可為複數)

31 虛擬機退租 相關指令:terminateInstances 參數: businessServiceId (可為複數)