公共參數(shù)
介紹每個接口都需要使用的請求參數(shù)和返回參數(shù)。
公共請求參數(shù)
名稱 | 類型 | 是否必須 | 描述 |
Format | String | 否 | 返回消息的格式。取值： JSON | XML （默認(rèn)值） |
Version | String | 是 | API版本號，使用YYYY-MM-DD日期格式。取值： 2018-12-01 |
AccessKeyId | String | 是 | 訪問服務(wù)使用的密鑰ID。 |
Signature | String | 是 | 簽名結(jié)果串。 |
SignatureMethod | String | 是 | 簽名方式，取值： HMAC-SHA1 |
Timestamp | String | 是 | 請求的時間戳，為日期格式。使用UTC時間按照 ISO8601標(biāo)準(zhǔn)，格式為YYYY-MM-DDThh:mm:ssZ。 例如，北京時間2013年1月10日20點(diǎn)0分0秒，表示為2013-01-10T20:00:00Z。 |
SignatureVersion | String | 是 | 簽名算法版本，取值： 1.0 |
SignatureNonce | String | 是 | 唯一隨機(jī)數(shù)，用于防止網(wǎng)絡(luò)重放攻擊。 在不同請求間要使用不同的隨機(jī)數(shù)值。 |
ResourceOwnerAccount | String | 否 | 本次API請求訪問到的資源擁有者賬戶，即登錄用戶名。 |
示例
http(s)://[Endpoint]/?Action=GetInstance
&InstanceId=cri-xkx6vujuhay0tasd
&TimeStamp=2014-05-19T10%3A33%3A56Z
&Format=xml
&AccessKeyId=testid
&SignatureMethod=Hmac-SHA1
&SignatureNonce=NwDAxvLU6tFE0DVb
&Version=2018-12-01
&SignatureVersion=1.0
&Signature=Signature公共返回參數(shù)
API返回結(jié)果采用統(tǒng)一格式，調(diào)用成功返回的數(shù)據(jù)格式有XML和JSON兩種，可以在發(fā)送請求時指定返回的數(shù)據(jù)格式，默認(rèn)為XML格式。每次接口調(diào)用，無論成功與否，系統(tǒng)都會返回一個唯一識別碼RequestId。
返回
2xxHTTP狀態(tài)碼表示調(diào)用成功。返回
4xx或5xxHTTP狀態(tài)碼表示調(diào)用失敗。
公共返回參數(shù)示例如下：
XML格式
<?xml version="1.0" encoding="utf-8"?> <!--結(jié)果的根結(jié)點(diǎn)--> <接口名稱+Response> <!--返回請求標(biāo)簽--> <RequestId>4C467B38-3910-447D-87BC-AC049166F216</RequestId> <!--返回結(jié)果數(shù)據(jù)--> </接口名稱+Response>JSON格式
{ "RequestId":"4C467B38-3910-447D-87BC-AC049166F216", }