API概述
概述?
- 星界鏈向用戶開放資源操作相關的API,我們的API是通過 HTTP GET 方式來進行調用的。
- 在調用我們的API之前,您需要先在我們的申請 API密鑰 , 包括 API密鑰ID ( AccessKeyId ) 和 API密鑰的私鑰 ( AccessKeySecret)。
- API密鑰ID 將作為參數包含在每一個請求中發送;而 API密鑰的私鑰 負責生成請求串的簽名,API密鑰的私鑰 需要被妥善保管,請勿外傳。
機房Region?
- 云服務以機房區域(Region)為單位部署,一個區域一般代表一個數據中心或者是一組低延時鏈路互聯的數據中心,各個區域之間相互獨立。(注:一個區域代表云服務的一個獨立部署)。
API請求方式?
- API 請求可以通過 HTTP 的 GET 請求發起。也可以使用星界鏈提供的 SDK。
- 所有 API 參數都放在 URL 中提供。
API請求限制?
- 單位時間內請求次數限制,用戶需要合理安排。
- 返回數據集長度限制,用戶應當分批獲取。
API請求類型?
我們的API請(qing)求(qiu)主要分(fen)為 延遲請(qing)求(qiu) 和 實時請(qing)求(qiu) 兩種。
- 延遲請求 這種操作,在 API 響應中會返回 TaskId,普通用戶可以通過查看資源狀態來確認操作是否完成、成功還是失敗。例如,在提交 RunInstance 操作之后,用戶可以通過 DescribeInstances 來查看 Instance的狀態以確認Instance是否創建成功。
- 實時請求 這種操作會立刻返回操作結果。
API請求地址?
- 新版地址:
- 舊版地址:
Demo示例?
對接API時,簽名驗證部分可參考demo代碼編寫(包含java、python、php、go語言的示例)
API請求樣例?
新版:
//api.cn-henji.com/v2/?Action=RunInstance&Region=cn-wuxi1&AccessKeyId=569f60d78a704c84920550b21577ae1b&Version=1.0&Date=2016-09-02T16%3A59%3A00%20%2B0800&Signature=JJ16Ph8pnOluwPULqudHGGNUf9IRPgScpiWrCHkvn%2Bw%3D&ImageId=i-sdddxxx&Volumes.0.Type=normal&PayType=ONDEMAND&Period=1&InstanceSeries=SERIES_STANDARD舊版:
//api.cn-henji.com/?Action=RunInstance&Region=cn-wuxi1&AccessKeyId=569f60d78a704c84920550b21577ae1b&Version=1.0&Date=2016-09-02T16%3A59%3A00%20%2B0800&Signature=JJ16Ph8pnOluwPULqudHGGNUf9IRPgScpiWrCHkvn%2Bw%3D&ImageId=i-sdddxxx&Volumes.0.Type=normal&PayType=ONDEMAND&Period=1&InstanceSeries=SERIES_STANDARD
為(wei)了方便(bian)查看(kan),我(wo)們將文檔中(zhong)的請求都(dou)進行(xing)換(huan)行(xing)來顯示:
//api.cn-henji.com/v2/?Action=RunInstance
&Region=cn-wuxi1
&AccessKeyId=569f60d78a704c84920550b21577ae1b
&Version=1.0
&Date=2016-09-02T16%3A59%3A00%20%2B0800
&Signature=JJ16Ph8pnOluwPULqudHGGNUf9IRPgScpiWrCHkvn%2Bw%3D
&ImageId=i-sdddxxx
&Volumes.0.Type=normal
&PayType=ONDEMAND
&Period=1
&InstanceSeries=SERIES_STANDARD
API返回結構?
響(xiang)應信(xin)息使用 JSON 格式,一般會返回以下的(de)值:
舊版:
參數名稱 描述 TaskId 每個請求都有一個TaskId Code 如果該請求執行失敗,會返回一個Code,如果執行成功,沒有Code,詳情可見錯誤代碼 ErrorMessage 如果有ErrorCode就會有對應的ErrorMessage,是對執行失敗原因的描述 Action 每個請求都會返回對應的一個Action操作名稱 返回參數 其他操作返回的參數見相關API操作文檔 對(dui)于查詢(xun)類的(de)操(cao)作,一(yi)般會返回一(yi)個(ge) XXXSet(其中(zhong) XXX 部分是資源(yuan)名稱,比(bi)如(ru) VolumeSet),放置所查詢(xun)的(de)資源(yuan)的(de)詳(xiang)細信息列表。
對于創(chuang)建(jian)(jian)類的(de)操作,一(yi)般會返回一(yi)個(ge)(ge) XXXId(如(ru)果創(chuang)建(jian)(jian)單個(ge)(ge)資(zi)源(yuan),比(bi)如(ru) InstanceId)或者 XXXs(資(zi)源(yuan)名稱復數(shu),用于創(chuang)建(jian)(jian)多個(ge)(ge)資(zi)源(yuan)的(de)場景,比(bi)如(ru) Instances),指示所創(chuang)建(jian)(jian)資(zi)源(yuan)的(de) ID。
新版:
參數名稱 描述 code 如果該請求執行失敗,會返回一個code,如果執行成功返回10000,詳情可見錯誤代碼 message 請求錯誤信息,是對執行失敗原因的描述 data 返回通信數據,舊版的返回信息統一放到新版的data里面