阿里雲RDS文件概述——概述與請求方式
呼叫方式:
對RDS API介面呼叫是通過向RDS API的服務端地址傳送HTTP GET請求
並按照介面說明在請求中加入相應請求引數來完成的
根據請求的處理情況,系統會返回處理結果。
請求結構:
服務地址:
RDS API的服務接入地址為:rds.aliyuncs.com
通訊協議:
支援通過HTTP或HTTPS通道進行請求通訊。
為了獲得更高的安全性,推薦您使用HTTPS通道傳送請求。
請求方法:
支援HTTP GET方法傳送請求,這種方式下請求引數需要包含在請求的URL中。
請求引數:
每個請求都需要指定要執行的操作,即Action引數(例如CreateDatabase)
以及每個操作都需要包含的公共請求引數和指定操作所特有的請求引數。
字元編碼:
請求及返回結果都使用UTF-8字符集進行編碼。
公共引數:
公共請求引數:
公共請求引數是指每個介面都需要使用到的請求引數。
名稱 |
型別 |
是否必須 |
描述 |
Format |
String |
否 |
返回值的型別,支援JSON與XML。預設為XML |
Version |
String |
是 |
API版本號,為日期形式:YYYY-MM-DD,本版本對應為2014-08-15 |
AccessKeyId |
String |
是 |
阿里雲頒發給使用者的訪問服務所用的金鑰ID |
Signature |
String |
是 |
簽名結果串,關於簽名的計算方法,請參見簽名機制。 |
SignatureMethod |
String |
是 |
簽名方式,目前支援HMAC-SHA1 |
Timestamp |
String |
是 |
請求的時間戳。日期格式按照ISO8601標準表示,並需要使用UTC時間。 格式為: YYYY-MM-DDThh:mm:ssZ例如,2013-08-15T12:00:00Z |
SignatureVersion |
String |
是 |
簽名演算法版本,目前版本是1.0 |
SignatureNonce |
String |
是 |
唯一隨機數,用於防止網路重放攻擊。使用者在不同請求間要使用不同的隨機數值 |
示例:
?Format=xml
&Version=2013-08-15
&Signature=Pc5WB8gokVn0xfeu%2FZV%2BiNM1dgI%3D
&SignatureMethod=HMAC-SHA1
&SignatureNonce=15215528852396
&SignatureVersion=1.0
&AccessKeyId=key-test
&OwnerId=12345678
&Timestamp=2013-06-01T12:00:00Z
公共返回引數:
使用者傳送的每次介面呼叫請求,無論成功與否,系統都會返回一個唯一識別碼RequestId給使用者。
呼叫API服務後返回資料採用統一格式
返回的HTTP狀態碼為2xx,代表呼叫成功
返回4xx或5xx的HTTP狀態碼代表呼叫失敗。
呼叫成功返回的資料格式主要有XML和JSON兩種,外部系統可以在請求時傳入引數來制定返回的資料格式,預設為XML格式。
本文件中的返回示例為了便於使用者檢視,做了格式化處理,實際返回結果是沒有進行換行、縮排等處理的。
示例:
XML:
<?xmlversion="1.0" encoding="utf-8"?>
<!—結果的根結點-->
<介面名稱+Response>
<!—返回請求標籤-->
<RequestId>4C467B38-3910-447D-87BC-AC049166F216</RequestId>
<!—返回結果資料-->
</介面名稱+Response>
JSON:
{
"RequestId":"4C467B38-3910-447D-87BC-AC049166F216",
/*返回結果資料*/
}