本文介绍了每个API都需要使用的请求参数和返回数据。

公共请求参数

名称 类型 是否必须 描述
Format String 返回数据的语言类型。取值:
  • JSON(默认值)
  • XML
Version String API的版本号。取值:

2017-05-18

AccessKeyId String 接口调用者使用的AccessKey ID。
Signature String 签名结果串。
SignatureMethod String 签名方式,取值:

HMAC-SHA1

Timestamp String 请求的时间戳。按照ISO8601标准表示,并使用UTC+0时间,格式为YYYY-MM-DDThh:mm:ssZ

例如,北京时间2021年10月10日20点0分0秒,表示为2021-10-10T12:00:00Z。

SignatureVersion String 签名算法版本,取值:

1.0

SignatureNonce String 唯一随机数,用于防止网络重放攻击。

在不同请求间要使用不同的随机数值。

示例
http://antiddos.aliyuncs.com/?Action=<API Name>
&TimeStamp=2021-10-10T12:00:00Z
&Format=JSON
&AccessKeyId=LTAI4G9eF7aVG3DabzRM****
&SignatureMethod=HMAC-SHA1
&SignatureNonce=15215528852396
&Version=2017-05-18
&SignatureVersion=1.0
&Signature=Pc5WB8gokVn0xfeu%2FZV%2BiNM1dgI%3D

公共返回数据

API返回结果采用统一格式。调用成功返回的数据格式有XML和JSON两种,您可以在发送请求时指定返回的数据格式,默认为JSON格式。每次接口调用,无论成功与否,系统都会返回本次调用请求的唯一识别码RequestId

返回数据中包含HTTP状态码,表示调用是否成功:
  • 返回2xxHTTP状态码表示调用成功。
  • 返回4xx5xxHTTP状态码表示调用失败。
公共返回数据示例如下:
  • XML格式
    <?xml version="1.0" encoding="utf-8"?> 
        <!--结果的根结点-->
        <接口名称+Response>
            <!--返回请求标签-->
            <RequestId>4C467B38-3910-447D-87BC-AC049166F216</RequestId>
            <!--返回结果数据-->
        </接口名称+Response>
                            
  • JSON格式
    {
        "RequestId":"4C467B38-3910-447D-87BC-AC049166F216",
        /*返回结果数据*/
        }