文档

调用API创建DDoS高防实例

更新时间:

DDoS高防(中国内地&非中国内地)不提供创建实例的接口,您可以调用阿里云交易和账单管理API提供的CreateInstance接口来创建实例。本文介绍如何调用API创建DDoS高防实例。

背景信息

阿里云交易和账单管理API是一套通用的管理阿里云资源的接口,可以用于查询服务价格、管理实例、获取账单信息等。关于阿里云交易和账单管理API支持的所有接口,请参见API概览

您可以调用阿里云交易和账单管理API提供的CreateInstance - 实例创建服务接口,创建DDoS高防实例。关于该接口的调用方式,请参见签名机制

注意事项

  • 调用CreateInstance接口创建DDoS高防实例后,会自动支付。实例的费用详情,请参见计费说明

  • 使用国际站账号创建DDoS高防实例时,账号必须开通信控身份。如未开通信控身份,请联系商务经理申请开通。

创建DDoS高防(中国内地)实例

您在调用CreateInstance接口创建DDoS高防(中国内地)实例时,需要完成以下API请求参数设置。

说明

关于调用该接口所需的公共请求参数,请参见签名机制

表 1. 请求参数:创建DDoS高防(中国内地)实例

名称

类型

是否必选

示例值

描述

Action

String

CreateInstance

要执行的操作。取值:CreateInstance

ProductCode

String

ddos

实例所属服务的代码。

取值:ddos,表示DDoS高防服务。

ProductType

String

ddoscoo

实例所属服务的类型。

取值:

  • ddoscoo,表示DDoS高防(中国内地)中国站服务。

  • ddoscoo_intl,表示DDoS高防(中国内地)国际站服务。

SubscriptionType

String

Subscription

实例的计费方式。

取值:Subscription,表示包年包月方式。

Period

Integer

1

购买时长,单位:月。

取值:1234561224

Parameter.N.Code

String

FunctionVersion

Parameter.N.Code表示一个实例配置项,Parameter.N.Value表示该配置项的值。

您通过设置Parameter.N.CodeParameter.N.Value对,设置某项实例配置。其中,N表示配置项的序号,例如Parameter.1.Code和Parameter.1.Value配对,表示第1项配置。

关于DDoS高防(中国内地)实例的具体配置,请参见DDoS高防(中国内地)实例配置

Parameter.N.Value

String

0

RenewalStatus

String

ManualRenewal

实例的续费方式。取值:

  • ManualRenewal(默认):表示手动续费。

  • AutoRenewal:表示自动续费。

RenewPeriod

Integer

1

自动续费周期, 单位:月。

说明

RenewalStatusAutoRenewal(表示开启自动续费)时,必须设置该参数。

ClientToken

String

123e4567-e89b-12d3-a456-42665544****

保证请求幂等性。从您的客户端生成一个参数值,确保不同请求间该参数值唯一。ClientToken只支持ASCII字符,且不能超过64个字符。更多信息,请参见如何保证幂等性

说明

如果不设置该参数,则系统自动使用API请求的RequestId作为ClientToken标识。

创建DDoS高防(中国内地)实例时,您需要通过Parameter.N.CodeParameter.N.Value对,完成下表描述的实例配置。

表 2. DDoS高防(中国内地)实例配置

配置项(Code)

类型

示例值(Value)

描述

Edition

String

coop

防护套餐类型。取值:coop,表示专业版。

FunctionVersion

String

0

功能套餐类型。取值:

  • 0:表示标准功能。

  • 1:表示增强功能。

NormalQps

Float

3000

正常业务QPS。

取值范围:3000~100000,必须是100的整数倍。

PortCount

Float

50

防护端口数。

取值范围:50~400,必须是5的整数倍。

DomainCount

Float

50

防护域名数。

取值范围:50~2000,必须是10的整数倍。

ServiceBandwidth

Float

100

业务带宽,单位:Mbps。

取值范围:100~5000,必须是50的整数倍。

BaseBandwidth

Float

30

保底防护带宽,单位:Gbps。

取值:30、60、100、300、400、500、600。

Bandwidth

Float

50

弹性防护带宽,单位:Gbps。

弹性防护带宽必须大于或等于保底防护带宽。不同保底防护带宽(BaseBandwidth)支持的弹性防护带宽(Bandwidth)取值不同。具体说明如下:

  • BaseBandwidth为30时,Bandwidth取值:30、40、50、60、70、80、100、150、200、300。

  • BaseBandwidth为60时,Bandwidth取值:60、70、80、100、150、200、300、400、500、600。

  • BaseBandwidth为100时,Bandwidth取值:100、150、200、300、400、500、600。

  • BaseBandwidth为300时,Bandwidth取值:300、400、500、600。

  • BaseBandwidth为400时,Bandwidth取值:400、500、600。

  • BaseBandwidth为500时,Bandwidth取值:500、600。

  • BaseBandwidth为600时,Bandwidth取值:600。

ServicePartner

String

coop-line-001

防护线路类型。取值:coop-line-001,表示默认防护线路。

95BurstBandwidthMode

String

1

95弹性业务带宽计费模式。取值:

  • 0:表示不启用弹性业务带宽。

  • 1:表示启用弹性业务带宽,计费模式为日95模式。

  • 2:表示启用弹性业务带宽,计费模式为月95模式。

AddressType

String

Ipv4

IP地址的协议类型。取值:

  • Ipv4:表示IPv4协议。

  • Ipv6:表示IPv6协议。

创建DDoS高防(非中国内地)实例

您在调用CreateInstance接口创建DDoS高防(非中国内地)实例时,需要完成以下API请求参数设置。

说明

关于调用该接口所需的公共请求参数,请参见签名机制

表 3. 请求参数:创建DDoS高防(非中国内地)实例

名称

类型

是否必选

示例值

描述

Action

String

CreateInstance

要执行的操作。取值:CreateInstance

ProductCode

String

ddos

实例所属服务的代码。

取值:ddos,表示DDoS高防服务。

ProductType

String

ddosDip

实例所属服务的类型。

取值:ddosDip,表示DDoS高防(非中国内地)服务。

SubscriptionType

String

Subscription

实例的计费方式。

取值:Subscription,表示包年包月方式。

Period

Integer

3

购买时长,单位:月。

取值:361224

Parameter.N.Code

String

FunctionVersion

Parameter.N.Code表示一个实例配置项,Parameter.N.Value表示该配置项的值。

您通过设置Parameter.N.CodeParameter.N.Value对,设置某项实例配置。其中,N表示配置项的序号,例如Parameter.1.Code和Parameter.1.Value配对,表示第1项配置。

关于DDoS高防(非中国内地)实例的具体配置,请参见DDoS高防(非中国内地)实例配置

Parameter.N.Value

String

0

RenewalStatus

String

ManualRenewal

实例的续费方式。取值:

  • ManualRenewal(默认):表示手动续费。

  • AutoRenewal:表示自动续费。

RenewPeriod

Integer

1

自动续费周期, 单位:月。

说明

RenewalStatusAutoRenewal(表示开启自动续费)时,必须设置该参数。

ClientToken

String

123e4567-e89b-12d3-a456-42665544****

保证请求幂等性。从您的客户端生成一个参数值,确保不同请求间该参数值唯一。ClientToken只支持ASCII字符,且不能超过64个字符。更多信息,请参见如何保证幂等性

说明

如果不设置该参数,则系统自动使用API请求的RequestId作为ClientToken标识。

创建DDoS高防(非中国内地)实例时,您需要通过Parameter.N.CodeParameter.N.Value对,完成下表描述的实例配置。

表 4. DDoS高防(非中国内地)实例配置

配置项(Code)

类型

示例值(Value)

描述

Region

String

ap-southeast-1

服务地域。取值:ap-southeast-1,表示海外地区。

ProductPlan

String

0

实例类型。取值:

  • 0:表示保险版实例。

  • 1:表示无忧版实例。

  • 2:表示加速线路实例。

  • 3:表示安全加速线路实例。

FunctionVersion

Strinig

0

功能套餐类型。取值:

  • 0:表示标准功能。

  • 1:表示增强功能。

说明

ProductPlan为2(表示创建加速线路实例)时,无需配置该参数。

NormalQps

Float

500

业务QPS。

不同实例类型(ProductPlan)支持的业务QPS(NormalQps)取值范围不同。具体说明如下:

  • ProductPlan为0时,NormalQps取值范围:500~100000,必须是100的整数倍。

  • ProductPlan为1时,NormalQps取值范围:1000~100000,必须是100的整数倍。

  • ProductPlan为2时,无需配置该参数。

  • ProductPlan为3时,NormalQps取值范围:500~100000,必须是100的整数倍。

NormalBandwidth

String

100

业务带宽,单位:Mbps。

不同实例类型(ProductPlan)支持的业务带宽(NormalBandwidth)取值不同。具体说明如下:

  • ProductPlan为0时,NormalBandwidth取值:100、150、200、250、300。

  • ProductPlan为1时,NormalBandwidth取值:100、150、200、250、300。

  • ProductPlan为2时,NormalBandwidth取值:10、20、30、40、50、60、70、80、90、100。

  • ProductPlan为3时,NormalBandwidth取值:10、20、30、40、50、60、70、80、90、100、150、200。

PortCount

Float

5

防护端口数。

不同实例类型(ProductPlan)支持的防护端口数(PortCount)取值范围不同。具体说明如下:

  • ProductPlan为0时,PortCount取值范围:5~400,必须是5的整数倍。

  • ProductPlan为1时,PortCount取值范围:5~400,必须是5的整数倍。

  • ProductPlan为2时,无需配置PortCount。

  • ProductPlan为3时,PortCount取值范围:5~400,必须是5的整数倍。

DomainCount

Float

10

防护域名数。

不同实例类型(ProductPlan)支持的防护域名数(DomainCount)取值范围不同。具体说明如下:

  • ProductPlan为0时,DomainCount取值范围:10~200,必须是10的整数倍。

  • ProductPlan为1时,DomainCount取值范围:10~200,必须是10的整数倍。

  • ProductPlan为2时,无需配置DomainCount。

  • ProductPlan为3时,DomainCount取值范围:10~200,必须是10的整数倍。

95BurstBandwidthMode

String

1

95弹性业务带宽计费模式。取值:

  • 0:表示不启用弹性业务带宽。

  • 1:表示启用弹性业务带宽,计费模式为日95模式。

  • 2:表示启用弹性业务带宽,计费模式为月95模式。

返回数据

名称

类型

示例值

描述

Code

String

Success

HTTP状态码。

Data

Struct

返回数据。

InstanceId

String

ddoscoo-cn-zvp28101****

已创建的实例的ID。

OrderId

String

20951253014****

已生成的订单ID。

Message

String

Successful!

响应信息。

RequestId

String

B03994C3-2A94-45FA-A44D-19E7BC39DC6D

本次请求的ID。

Success

Boolean

true

本次请求是否成功。取值:

  • true:表示请求成功。

  • false:表示请求失败。

示例

  • 示例1:创建DDoS高防(中国内地)实例

    请求示例

    http(s)://[Endpoint]/?Action=CreateInstance
    &ProductCode=ddos
    &ProductType=ddoscoo
    &SubscriptionType=Subscription
    &Period=1
    &Parameter.1.Code=Edition
    &Parameter.1.Value=coop
    &Parameter.2.Code=FunctionVersion
    &Parameter.2.Value=0
    &Parameter.3.Code=NormalQps
    &Parameter.3.Value=3000
    &Parameter.4.Code=PortCount
    &Parameter.4.Value=50
    &Parameter.5.Code=DomainCount
    &Parameter.5.Value=50
    &Parameter.6.Code=ServiceBandwidth
    &Parameter.6.Value=200
    &Parameter.7.Code=BaseBandwidth
    &Parameter.7.Value=30
    &Parameter.8.Code=Bandwidth
    &Parameter.8.Value=50
    &Parameter.9.Code=ServicePartner
    &Parameter.9.Value='coop-line-001'
    &Parameter.10.Code=95BurstBandwidthMode
    &Parameter.10.Value='1'
    &Parameter.11.Code=AddressType
    &Parameter.11.Value='Ipv4'
    &<公共请求参数>

    正常返回示例

    • XML格式

      HTTP/1.1 200 OK
      Content-Type:application/xml
      
      <CreateInstanceResponse>
          <RequestId>B03994C3-2A94-45FA-A44D-19E7BC39DC6D</RequestId>
          <Message>Successful!</Message>
          <Data>
              <InstanceId>ddoscoo-cn-zvp28101****</InstanceId>
              <OrderId>20951253014****</OrderId>
          </Data>
          <Code>Success</Code>
          <Success>true</Success>
      </CreateInstanceResponse>
    • JSON格式

      HTTP/1.1 200 OK
      Content-Type:application/json
      
      {
        "RequestId": "B03994C3-2A94-45FA-A44D-19E7BC39DC6D",
        "Message": "Successful!",
        "Data": {
          "InstanceId": "ddoscoo-cn-zvp28101****",
          "OrderId": 20951253014****
        },
        "Code": "Success",
        "Success": true
      }
  • 示例2:创建DDoS高防(非中国内地)保险版实例

    请求示例

    http(s)://[Endpoint]/?Action=CreateInstance
    &ProductCode=ddos
    &ProductType=ddosDip
    &SubscriptionType=Subscription
    &Period=3
    &Parameter.1.Code=Region
    &Parameter.1.Value='ap-southeast-1'
    &Parameter.2.Code=ProductPlan
    &Parameter.2.Value=0
    &Parameter.3.Code=FunctionVersion
    &Parameter.3.Value=0
    &Parameter.4.Code=NormalQps
    &Parameter.4.Value=500
    &Parameter.5.Code=NormalBandwidth
    &Parameter.5.Value=100
    &Parameter.6.Code=PortCount
    &Parameter.6.Value=5
    &Parameter.7.Code=DomainCount
    &Parameter.7.Value=10
    &Parameter.8.Code=95BurstBandwidthMode
    &Parameter.8.Value='1'
    &<公共请求参数>

    正常返回示例

    • XML格式

      HTTP/1.1 200 OK
      Content-Type:application/xml
      
      <CreateInstanceResponse>
          <RequestId>4DA44417-7BF7-474A-A3DC-D157EF6BD7CA</RequestId>
          <Message>Successful!</Message>
          <Data>
              <InstanceId>ddosDip-cn-i7m282j****</InstanceId>
              <OrderId>20951829465****</OrderId>
          </Data>
          <Code>Success</Code>
          <Success>true</Success>
      </CreateInstanceResponse>
    • JSON格式

      HTTP/1.1 200 OK
      Content-Type:application/json
      
      {
        "RequestId": "4DA44417-7BF7-474A-A3DC-D157EF6BD7CA",
        "Message": "Successful!",
        "Data": {
          "InstanceId": "ddosDip-cn-i7m282j****",
          "OrderId": 20951829465****
        },
        "Code": "Success",
        "Success": true
      }
  • 示例3:创建DDoS高防(非中国内地)加速线路实例

    请求示例

    http(s)://[Endpoint]/?Action=CreateInstance
    &ProductCode=ddos
    &ProductType=ddosDip
    &SubscriptionType=Subscription
    &Period=3
    &Parameter.1.Code=Region
    &Parameter.1.Value='ap-southeast-1'
    &Parameter.2.Code=ProductPlan
    &Parameter.2.Value=2
    &Parameter.3.Code=NormalBandwidth
    &Parameter.3.Value=10
    &Parameter.4.Code=95BurstBandwidthMode
    &Parameter.4.Value='1'
    &<公共请求参数>

    正常返回示例

    • XML格式

      HTTP/1.1 200 OK
      Content-Type:application/xml
      
      <CreateInstanceResponse>
          <RequestId>4DA44417-7BF7-474A-A3DC-D157EF6BD7CA</RequestId>
          <Message>Successful!</Message>
          <Data>
              <InstanceId>ddosDip-cn-i7m282j****</InstanceId>
              <OrderId>20951829465****</OrderId>
          </Data>
          <Code>Success</Code>
          <Success>true</Success>
      </CreateInstanceResponse>
    • JSON格式

      HTTP/1.1 200 OK
      Content-Type:application/json
      
      {
        "RequestId": "4DA44417-7BF7-474A-A3DC-D157EF6BD7CA",
        "Message": "Successful!",
        "Data": {
          "InstanceId": "ddosDip-cn-i7m282j****",
          "OrderId": 20951829465****
        },
        "Code": "Success",
        "Success": true
      }

相关文档

  • 本页导读 (1)
文档反馈