全部產品
Search
文件中心

Anti-DDoS:調用API建立DDoS高防執行個體

更新時間:Jun 30, 2024

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
      }

相關文檔