862      阿裏雲

API調用示例__快速入門（調用API）_API 網關-阿裏雲

您可以直接用API網關控製台為您提供的多語言調用示例來測試調用。您也可以自行編輯HTTP(s)請求調用API。簽名方式您可以參照控製台的SDK示例下載。

通過上述步驟，您已經獲取了API定義文檔、創建了APP、建立了授權關係。

您可以調用API了。API的請求說明如下：

請求

請求地址

https://e710888d3ccb4638a723ff8d03837095-cn-qingdao.aliapi.com/demo/post

請求方法

POST

請求體

FormParam1=FormParamValue1&FormParam2=FormParamValue2 
//HTTP Request Body

請求頭部

Host: e710888d3ccb4638a723ff8d03837095-cn-qingdao.aliapi.com
Date: Mon, 22 Aug 2016 11:21:04 GMT
User-Agent: Apache-HttpClient/4.1.2 (java 1.6)
Content-Type: application/x-www-form-urlencoded; charset=UTF-8 
//請求體類型，請根據實際請求體內容設置
Accept: application/json 
//請求響應體類型，部分API可以根據指定的響應類型來返回對應數據格式，建議手動指定此請求頭，如果不設置，部分HTTP客戶端會設置默認值*/*，導致簽名錯誤
X-Ca-Request-Mode: debug 
//是否開啟Debug模式，大小寫不敏感，不設置默認關閉，一般API調試階段可以打開此設置
X-Ca-Version: 1  
//API版本號，目前所有API僅支持版本號『1』，可以不設置此請求頭，默認版本號為『1』
X-Ca-Signature-Headers: X-Ca-Request-Mode,X-Ca-Version,X-Ca-Stage,X-Ca-Key,X-Ca-Timestamp 
//參與簽名的自定義請求頭，服務端將根據此配置讀取請求頭進行簽名，此處設置不包含Content-Type、Accept、Content-MD5、Date請求頭，這些請求頭已經包含在了基礎的簽名結構中，詳情參照請求簽名說明文檔
X-Ca-Stage: RELEASE  
//請求API的Stage，目前支持TEST、RELEASE兩個Stage，大小寫不敏感，API提供者可以選擇發布到哪個Stage，隻有發布到指定Stage後API才可以調用，否則會提示API找不到或Invalid Url
X-Ca-Key: 60022326  
//請求的AppKey，請到API網關控製台生成，隻有獲得API授權後才可以調用，通過雲市場等渠道購買的API默認已經給APP授過權，阿裏雲所有雲產品共用一套AppKey體係，刪除ApppKey請謹慎，避免影響到其他已經開通服務的雲產品
X-Ca-Timestamp: 1471864864235 
//請求的時間戳，值為當前時間的毫秒數，也就是從1970年1月1日起至今的時間轉換為毫秒，時間戳有效時間為15分鍾
X-Ca-Nonce:b931bc77-645a-4299-b24b-f3669be577ac  
//請求唯一標識，15分鍾內AppKey+API+Nonce不能重複，與時間戳結合使用才能起到防重放作用
X-Ca-Signature: FJleSrCYPGCU7dMlLTG+UD3Bc5Elh3TV3CWHtSKh1Ys= 
//請求簽名
CustomHeader: CustomHeaderValue  
//自定義請求頭，此處僅作為示例，實際請求中根據API定義可以設置多個自定義請求頭

響應

狀態碼

400  
//響應狀態碼，大於等於200小於300表示成功；大於等於400小於500為客戶端錯誤；大於500為服務端錯誤

響應頭

X-Ca-Request-Id: 7AD052CB-EE8B-4DFD-BBAF-EFB340E0A5AF 
//請求唯一ID，請求一旦進入API網關應用後，API網關就會生成請求ID並通過響應頭返回給客戶端，建議客戶端與後端服務都記錄此請求ID，可用於問題排查與跟蹤
X-Ca-Error-Message: Invalid Url  
//API網關返回的錯誤消息，當請求出現錯誤時API網關會通過響應頭將錯誤消息返回給客戶端
X-Ca-Debug-Info: {"ServiceLatency":0,"TotalLatency":2}  
//當打開Debug模式後會返回Debug信息，此信息後期可能會有變更，僅用做聯調階段參考

您調用API時，無論使用HTTP還是HTTPS協議提交請求，都需要在請求中包含簽名信息。詳細加密簽名的計算傳遞方式，請查看文檔——請求簽名說明文檔