公共參數
更新時間:
介紹每個接口都需要使用的請求參數和返回參數。
公共請求參數
名稱 | 類型 | 是否必選 | 描述 |
Format | String | 否 | 返回消息的格式。取值: JSON(默認值) | XML |
Version | String | 是 | API版本號,使用YYYY-MM-DD日期格式。取值: 2019-12-12 |
AccessKeyId | String | 是 | 訪問服務使用的密鑰ID。 |
Signature | String | 是 | 簽名結果串。 |
SignatureMethod | String | 是 | 簽名方式,取值: HMAC-SHA1 |
Timestamp | String | 是 | 請求的時間戳,為日期格式。使用UTC時間按照ISO8601標準,格式為YYYY-MM-DDThh:mm:ssZ。 例如,北京時間2013年1月10日20點0分0秒,表示為2013-01-10T20:00:00Z。 |
SignatureVersion | String | 是 | 簽名算法版本,取值: 1.0 |
SignatureNonce | String | 是 | 唯一隨機數,用于防止網絡重放攻擊。 在不同請求間要使用不同的隨機數值,建議使用通用唯一識別碼(Universally Unique Identifier, UUID)。 |
ResourceOwnerAccount | String | 否 | 本次API請求訪問到的資源擁有者賬戶,即登錄用戶名。 |
示例
https://amqp-open.aliyuncs.com/?Action=ListInstances
&Format=JSON
&Version=2019-12-12
&Signature=xxxx%xxxx%3D
&SignatureMethod=HMAC-SHA1
&SignatureNonce=e7b1f31150be45594905ce6d28561286
&SignatureVersion=1.0
&AccessKeyId=key-test
&TimeStamp=2020-02-10T08%3A43%3A05Z
…
公共返回參數
API返回結果采用統一格式,調用成功返回的數據格式有XML和JSON兩種,可以在發送請求時指定返回的數據格式,默認為JSON格式。每次接口調用,無論成功與否,系統都會返回一個唯一識別碼RequestId。
返回
2xx
HTTP狀態碼表示調用成功。返回
4xx
或5xx
HTTP狀態碼表示調用失敗。
公共返回參數示例如下:
XML格式
<?xml version="1.0" encoding="utf-8"?> <!--結果的根結點--> <接口名稱+Response> <!--返回請求標簽--> <RequestId>D6660A81-1A96-43F3-AC00-4EE473C70AEC</RequestId> <!--返回結果數據--> </接口名稱+Response>
JSON格式
{ "RequestId":"D6660A81-1A96-43F3-AC00-4EE473C70AEC", /*返回結果數據*/ }
文檔內容是否對您有幫助?