介紹每個接口都需要使用的請求參數和返回參數。
公共請求參數
名稱 | 類型 | 是否必須 | 描述 |
Format | String | 否 | 返回消息的格式。取值: XML(默認值) | JSON |
Version | String | 是 | API版本號,使用YYYY-MM-DD日期格式。固定取值: 2019-11-18 |
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-10T12:00:00Z。 |
SignatureVersion | String | 是 | 簽名算法版本,取值: 1.0 |
SignatureNonce | String | 是 | 唯一隨機數,用于防止網絡重放攻擊。 在不同請求間要使用不同的隨機數值。 |
ResourceOwnerAccount | String | 否 | 本次API請求訪問到的資源擁有者賬戶,即登錄用戶名。 |
示例
https://address-purification.cn-hangzhou.aliyuncs.com/?Action=ClassifyPOI
&Timestamp=2014-05-19T10%3A33%3A56Z
&Format=xml
&AccessKeyId=testid
&SignatureMethod=Hmac-SHA1
&SignatureNonce=NwDAxvLU6tFE0DVb
&Version=2019-11-18
&SignatureVersion=1.0
&Signature=Signature
公共返回參數
API返回結果采用統一格式,調用成功返回的數據格式有XML和JSON兩種,可以在發送請求時指定返回的數據格式,默認為XML格式。每次接口調用,無論成功與否,系統都會返回一個唯一識別碼RequestId。
返回
2xx
HTTP狀態碼表示調用成功。返回
4xx
或5xx
HTTP狀態碼表示調用失敗。
公共返回參數示例如下:
XML格式
<?xml version="1.0" encoding="utf-8"?> <!—結果的根結點--> <接口名稱+Response> <!—返回請求標簽--> <RequestId>4C467B38-3910-447D-87BC-AC049166F216</RequestId> <!—返回結果數據--> </接口名稱+Response>
JSON格式
{ "RequestId":"4C467B38-3910-447D-87BC-AC049166F216", /*返回結果數據*/ }
文檔內容是否對您有幫助?