DDoS原生防护接口调用是向DDoS原生防护API的服务端地址发送HTTP GET请求,并按照接口说明在请求中加入相应请求参数,调用后系统会返回处理结果。请求及返回结果都使用UTF-8字符集进行编码。

请求结构

DDoS原生防护API是RPC风格,您可以通过发送HTTP GET请求调用DDoS原生防护 API。其请求结构如下:
https://Endpoint/?Action=xx&Parameters
参数释义:
  • Endpoint:DDoS原生防护API的服务接入地址。
    Endpoint 支持的地域
    ddosbgp.aliyuncs.com
    • 中国内地
      • 华东1(杭州):cn-hangzhou
      • 华东2(上海):cn-shanghai
      • 华北1(青岛):cn-qingdao
      • 华北2(北京):cn-beijing
      • 华北3(张家口):cn-zhangjiakou
      • 华北5(呼和浩特):cn-huhehaote
      • 华北6(乌兰察布 ):cn-wulanchabu
      • 华南1(深圳):cn-shenzhen
      • 华南2(河源):cn-heyuan
      • 西南1(成都):cn-chengdu
    • 海外地区
      • 英国(伦敦):eu-west-1
      • 德国(法兰克福):eu-central-1
      • 日本(东京):ap-northeast-1
      • 澳大利亚(悉尼):ap-southeast-2
      • 马来西亚(吉隆坡):ap-southeast-3
      • 印度尼西亚(雅加达):ap-southeast-5
      • 印度(孟买):ap-south-1
      • 阿联酋(迪拜):me-east-1
      • 俄罗斯(莫斯科):rus-west-1
    ddosbgp.cn-hongkong.aliyuncs.com 中国香港:cn-hongkong
    ddosbgp.ap-southeast-1.aliyuncs.com 新加坡:ap-southeast-1
    ddosbgp.us-west-1.aliyuncs.com 美国(硅谷):us-west-1
    ddosbgp.us-east-1.aliyuncs.com 美国(弗吉尼亚):us-east-1
  • Action:要执行的操作。例如使用DescribeInstanceList查询DDoS原生防护的实例信息。
  • Version:要使用的API版本。当前目录下DDoS原生防护API的版本是2018-07-20
  • Parameters:请求参数,多个参数之间用“&”连接。

    请求参数由公共请求参数和API自定义参数组成。公共参数中包含API版本号、身份验证等信息,详情参见公共参数

下面是一个调用DescribeInstanceList接口查询DDoS原生防护实例信息的示例:
说明 为了便于您查看,本文档中的示例都做了格式化处理。
https://ddosbgp.aliyuncs.com/?Action=DescribeInstanceList
&DdosRegionId=cn-hangzhou
&InstanceId=ddosbgp-cn-xxx
&Format=xml
&Version=2018-07-20
&Signature=xxxx%xxxx%3D
&SignatureMethod=HMAC-SHA1
&SignatureNonce=15215528852396
&SignatureVersion=1.0
&AccessKeyId=key-test
&TimeStamp=2012-06-01T12:00:00Z

API授权

为了确保您的账号安全,建议您使用子账号的身份凭证调用API。如果您使用RAM账号调用DDoS原生防护API,您需要为该RAM账号创建、附加相应的授权策略。

API签名

DDoS原生防护服务会对每个API请求进行身份验证,无论使用HTTP还是HTTPS协议提交请求,都需要在请求中包含签名(Signature)信息。

RPC API需按如下格式在请求中增加签名(Signature):
https://endpoint/?SignatureVersion=1.0&SignatureMethod=HMAC-SHA1&Signature=CT9X0VtwR86fNWSnsc6v8YGOjuE%3D&SignatureNonce=3ee8c1b8-83d3-44af-a94f-4e0ad82fd6cf