本文介紹調用風險識別API時使用的公共請求參數和公共返回參數。
公共請求參數
風險識別API接口的入參參數包含公共請求參數和具體服務事件參數,公共請求參數是指每一個接口都需要使用到的參數,以下表格是公共請求參數的詳細介紹。
名稱 | 類型 | 是否必須 | 描述 |
Format | String | 是 | 返回消息的格式。取值:
|
Version | String | 是 | API版本號,使用YYYY-MM-DD日期格式,本版本對應為2019-05-21。 |
AccessKeyId | String | 是 | 阿里云頒發給用戶的訪問服務所用的密鑰ID。 |
Signature | String | 是 | 簽名結果串,關于簽名的計算方法,請參見簽名機制調用方式第2.0節。 |
SignatureMethod | String | 是 | 簽名方式,目前支持HMAC-SHA1。 |
Timestamp | String | 是 | 請求的時間戳。日期格式按照ISO8601標準表示,并需要使用UTC時間。格式為:yyyy-MM-ddTHH:mm:ssZ。例如,北京時間2019年8月22日09點44分35秒表示為2019-08-22T01:44:35Z。 |
SignatureVersion | String | 是 | 簽名算法版本,取值為1.0。 |
SignatureNonce | String | 是 | 唯一隨機數,用于防止網絡重放攻擊。不同請求要使用不同的隨機數值。 |
Action | String | 是 | 值必須是ExecuteRequest。 |
Service | String | 是 | 阿里云云盾頒發的服務code,不可隨意設置。以下是各服務對應的code列表:
|
ServiceParameters | String | 是 | 服務參數列表的JSON格式為 |
以下是注冊風險識別-增強版服務的請求示例:
https://saf.cn-shanghai.aliyuncs.com/
?Format=JSON
&Version=2020-07-06
&Signature=vpEEL0zFHfxXYzSFV0n7%2FZiFL9o%3D
&SignatureMethod=Hmac-SHA1
&SignatureNonce=15215528852396
&SignatureVersion=1.0
&Action=ExecuteRequest
&AccessKeyId=123****saf
&Timestamp=2018-06-01T12:00:00Z
&Service=account_abuse_pro
&ServiceParameters={"accountId":1012**** …該事件下其他請求參數,詳見具體服務的事件參數}
公共返回參數
您發送的每次接口調用請求,無論成功與否,系統都會返回唯一識別碼RequestId。其他返回參數包含score(分數)、tags(標簽)、extend(自定義返回參數),服務不同返回的參數不同,詳見具體服務對應的文檔。
以下是注冊風險識別-增強版服務返回參數的JSON
示例:
{
//service:account_abuse_pro
"Data": {
"score": 85.92, //風險得分,取值范圍:0~100,double格式
"tags": "rm0101" //風險標簽,string格式
},
"Message": "OK",
"Code": 200, //200表示請求成功
"RequestId": "4EF9AEE5-288F-4176-8110-00EDC91A614E"
}
本文中的返回示例為了便于閱讀,做了格式化處理,實際返回結果沒有進行換行、縮進等格式化處理。
以下是郵箱畫像服務返回參數的JSON
示例:
{
"Data": {
"tags": "temp_email,gibberish_email" //string格式
},
"Message": "OK",
"Code": 200, //200表示請求成功
"RequestId": "4EF9AEE5-288F-4176-8110-00EDC91A614E"
}
錯誤碼
Code | 含義描述 |
200 | 請求成功。 |
400 | ServiceParameters(事件參數)不合法。 |
402 | QPS超過已購規格,限流。 |
403 | 權限不足,服務未開通或已到期。 |
404 | Service(服務參數)不合法。 |
500 | 內部服務器錯誤。 |