全部产品
云市场

公共参数

更新时间:2019-08-29 22:25:18

公共请求参数

服务接口的入参参数包含公共请求参数具体服务事件参数,公共请求参数是指每一个接口都需要使用到的参数,以下为公共请求参数。

名称 类型 必填项 描述
Format String 返回值的类型,支持JSON与XML,默认为XML。
Version String API版本号,为日期形式:YYYY-MM-DD,本版本对应为2018-09-19。
AccessKeyId String 阿里云颁发给用户的访问服务所用的密钥ID。
Signature String 签名结果串,关于签名的计算方法,请参见签名机制
SignatureMethod String 签名方式,目前支持HMAC-SHA1。
Timestamp String 请求的时间戳。日期格式按照ISO8601标准表示,并需要使用UTC时间。格式为:yyyy-MM-ddTHH:mm:ssZ
例如,2019-08-22T01:44:35Z(为北京时间2019年8月22日的09点44分35秒)。
SignatureVersion String 签名算法版本,目前版本是1.0。
SignatureNonce String 唯一随机数,用于防止网络重放攻击。用户在不同请求间要使用不同的随机数值。
Action String 值必须是ExecuteRequest。
Service String 阿里云云盾颁发的服务code,不可随意设置。注册风险识别-增强版服务的code是account_abuse_pro,注册风险识别服务的code是account_abuse,营销风险识别-增强版服务的code是coupon_abuse_pro,营销风险识别服务的code是coupon_abuse,登录风险识别-增强版服务的code是account_takeover_pro,登录风险识别服务的code是account_takeover,设备风险识别服务的code是device_risk,风险情报服务的code是risk_intelligence,邮箱画像服务的code是email_risk,地址评分服务的code是address_validation,蚁盾.手机RAIN评分服务的code是yd_mobile_rain,蚁盾.营销保护服务的code是yd_coupon_abuse,先享后付服务的code是yd_after_pay,蚁盾.身份伪冒识别服务的code是yd_identity_forgery ,IP风险画像服务的code是risk_intelligence_ip
ServiceParameters String 服务参数列表的json格式,{“accountId”:101234567 …该事件下其他传参}。具体字段和参数值的格式见注册风险识别-增强版事件参数注册风险识别事件参数营销风险识别-增强版事件参数营销风险识别事件参数登录风险识别-增强版事件参数登录风险识别事件参数设备风险识别事件参数风险情报事件参数邮箱画像事件参数地址评分事件参数

注册风险识别服务为示例:

  1. https://saf.cn-shanghai.aliyuncs.com/
  2. ?Format=JSON
  3. &Version=2018-09-19
  4. &Signature=vpEEL0zFHfxXYzSFV0n7%2FZiFL9o%3D
  5. &SignatureMethod=Hmac-SHA1
  6. &SignatureNonce=15215528852396
  7. &SignatureVersion=1.0
  8. &Action=ExecuteRequest
  9. &AccessKeyId=1234567saf
  10. &Timestamp=2018-06-01T12:00:00Z
  11. &Service=account_abuse_pro
  12. &ServiceParameters={"accountId":10123567 …该事件下其他传参,详见具体服务的事件参数}

公共返回参数

用户发送的每次接口调用请求,无论成功与否,系统都会返回一个唯一识别码RequestId给用户。其他返回参数根据服务不同有不同的业务含义,详情见具体服务。

注册风险识别-增强版服务的json示例:

  1. {
  2. "Data": {
  3. "score": 85.92, //0100分得风险分数,double格式
  4. "tags": "rm0101" //风险标签,string格式
  5. },
  6. "Message": "OK",
  7. "Code": 200, //200表示请求成功
  8. "RequestId": "4EF9AEE5-288F-4176-8110-00EDC91A614E"
  9. }

邮箱画像服务的json示例:

  1. {
  2. "Data": {
  3. "tags": "temp_email,gibberish_email" //string格式
  4. },
  5. "Message": "OK",
  6. "Code": 200, //200表示请求成功
  7. "RequestId": "4EF9AEE5-288F-4176-8110-00EDC91A614E"
  8. }

返回参数说明

返回Code的说明

Code 含义描述
200 请求正常。
400 ServiceParameters(事件参数)不合法
402 日QPS超过已购规格,限流。
403 权限不足,服务未开通或已到期。
404 Service(服务参数)不合法。
500 内部服务器错误。

注意:文档中的返回示例为了便于阅读,做了格式化处理,实际返回结果是没有进行换行、缩进等处理。