硅云幫助文檔中心
搜索文檔
熱門搜索詞:
產(chǎn)品簡介
產(chǎn)品定價
入門指南
經(jīng)典案例
快照
常見問題
知識拓展
名詞解釋
API參考
產(chǎn)品規(guī)格相關接口
服務器實例相關接口
安全組相關接口
磁盤相關接口
通用說明
支持協(xié)議: https
服務域名 : api.vpsor.cn
請求頭 | 描述 |
request_id | 請求id,作為鏈路追蹤和密鑰簽名使用,由字母和數(shù)字組成不要出現(xiàn)需經(jīng)過url編碼的字符,建議使用uuid作為request_id,request_id長度為16到64位 |
api_key | 接口api_key,在官網(wǎng)創(chuàng)建,需要實名之后才能創(chuàng)建 |
signature | 簽名 |
簽名 signature=SHA-256(requestUrl+request_id+api密鑰):
SHA-256:調(diào)用HMAC SHA256算法,并把結(jié)果轉(zhuǎn)換為小寫形式的十六進制字符串
requestUrl:接口地址不含?以后的數(shù)據(jù),如https://api.vpsor.cn/ncs-server/api/v1/host/create?test=1 requestUrl 為: /ncs-server/api/v1/host/create
request_id: 作為鏈路追蹤和密鑰簽名使用,由字母和數(shù)字組成不要出現(xiàn)需經(jīng)過url編碼的字符,建議使用uuid作為request_id,request_id長度為16到64位,請不要使用固定的request_id
api密鑰: 和api_key對應的api_密鑰,在官網(wǎng)生成后請不要泄漏
安全性: 安全性主要由api密鑰不泄露和白名單保證
例子: requestUrl=/ncs-server/api/v1/host/create
request_id=2942183558593ffc9d75fb8e16793ff
api密鑰=LSh9hu7pVwYYSG2ySh6NVS4z3ZTWFqLJ
此時簽名=6c3d41ac0e7439898e750c337413dbe7660ba95bcfc1dc73f3eca8a4b3328735
數(shù)據(jù)交換格式為JSON,所有request/response body內(nèi)容均采用UTF-8編碼。
請求參數(shù)包括如下4種:
URI | 通常用于指明操作實體,如:POST /ncs-server/api/v1/host/create |
Query參數(shù) | URL中攜帶的請求參數(shù),如 GET /ncs-server/api/v1/host/get?id=1 |
HEADER | 請求頭,request_id,api_key,signature 為必須攜帶的請求頭 |
RequestBody | 通過JSON格式組織的請求數(shù)據(jù)體 |
http 狀態(tài)碼:
200 : 此狀態(tài)碼表示接口調(diào)用成功,但結(jié)果不一定成功,看ResponseBody判斷結(jié)果是否符合預期
403 : 此狀態(tài)碼表示接口調(diào)用沒有權(quán)限,請查看返回消息,檢查 api_key 和 signature 是否傳遞有錯誤
ResponseBody結(jié)構(gòu):
{ "status":2000, //狀態(tài)碼,int類型,2000為成功,否則為失敗,具體參考錯誤狀態(tài)碼 "message": "success", //提示消息,string類型, "data":object //返回數(shù)據(jù),泛型,當為空時不返回 }
所有涉及密碼的接口參數(shù)都需要加密,禁止明文傳輸。密碼一律采用AES 128位加密算法進行加密,用api密鑰的前16位作為密鑰,加密后生成的二進制字節(jié)流經(jīng)過base64二次編碼,并以字符串的形式傳到服務端。具體步驟如下:
byte[] bCiphertext= AES128(明文,api密鑰前16位)
String strBase64 = Base64(bCiphertext)
例子: 明文=123456
api密鑰=LSh9hu7pVwYYSG2ySh6NVS4z3ZTWFqLJ
strBase64=FDyaCCrqZphejQDcdUP/Tg==
您對該文檔有什么建議?
本文導航