You need to enable JavaScript to run this app.
导航

PurchaseInstanceInOneStep-购买原生防护实例

最近更新时间2024.01.26 20:49:21

首次发布时间2024.01.26 20:49:21

按指定规格购买 DDoS 原生防护实例。

注意事项

  • 请确保您的帐户余额充足,否则会购买失败。
  • 接口调用成功后,系统会自动扣除相关购买费用。
  • DDoS 原生防护企业版和高级版的请求参数存在差异,请注意区分。

请求说明

  • 请求方式:POST
  • 请求地址:https://open.volcengineapi.com/?Action=PurchaseInstanceInOneStep&Version=2022-01-01

请求参数

以下为该接口的 Query 参数和 Body 参数,其他公共参数请参见公共参数

Query

参数

类型

是否必填

示例值

描述

Action

String

PurchaseInstanceInOneStep

接口名称。与实际业务的接口名称一致。

Version

String

2022-01-01

接口的版本。DDoS 原生防护提供的 OpenAPI 版本为2022-01-01

Body

参数

类型

是否必填

示例值

描述

DefBand

Integer

300

  • 防护带宽,默认为 300 且不支持变更。单位 Gbps。
  • 高级版不涉及。

IpNum

Integer

10

需要防护的 IP 数量。

  • 企业版:可设置为 10/20/50/80/100/150/200,其余取值不生效。
  • 高级版:最小值为 50,最大值为 200,可任意取整。如需购买更多 IP 可联系技术支持。

BizBand

Integer

100

  • 业务规模,输入值需要为 50 的整数倍,最大值为 15000。单位 Mbps。
  • 企业版购买不同规则的 IP 数量,对应的业务规模有最低要求,否则会购买失败。IP 个数与业务规模的对应关系如下:
    • 10 个 IP:业务规模需要大于等于 50 Mbps。
    • 20 个 IP:业务规模需要大于等于 100 Mbps。
    • 50 个 IP:业务规模需要大于等于 300 Mbps。
    • 80 个 IP:业务规模需要大于等于 400 Mbps。
    • 100 个 IP:业务规模需要大于等于 500 Mbps。
    • 150 个 IP:业务规模需要大于等于 750 Mbps。
    • 200 个 IP:业务规模需要大于等于 1000 Mbps。
  • 高级版满足最少为 50 Mbps 即可。

ElaBand

Integer

500

弹性防护带宽,单位 Gbps。

  • 企业版:可设置为 400/500/600/700/800/900/1000。
  • 高级版不涉及。

PurchaseNum

Integer

1

需要购买的实例数量。

MonthNum

Integer

12

购买月数,支持按年购买,因此该值需要为 12 的整数倍。

AutoRenew

String

on

是否开启自动续费。

  • on:开启
  • off:关闭

AccessMode

Integer

2

接入模式,默认为 2 且不支持变更,指透明接入。

BandwidthType

Integer

1

带宽类型,默认为 1 且不支持变更,指 BGP 带宽。

Region

String

cn-beijing

实例所在地域。

  • cn-beijing
  • cn-shanghai
  • cn-guangzhou
  • ap-southeast-1

Spec

String

Enterprise

配置规格。

  • Deluxe:高级版
  • Enterprise:企业版

返回参数

无。

请求示例

企业版请求示例

创建企业版实例时,所有请求参数都需要赋值,且满足限制条件。

POST https://open.volcengineapi.com/?Action=PurchaseInstanceInOneStep&Version=2022-01-01
X-Date: 20230711T035055Z
Authorization: HMAC-SHA256 Credential=AKLTNGU0OGEyMT***/20230711/cn-beijing/origin_defence/request, SignedHeaders=content-type;x-content-sha256;x-date, Signature=da4fac562d00f41ad8***
{
    "DefBand": 300,
    "IpNum": 10,
    "BizBand": 100,
    "ElaBand": 500,
    "PurchaseNum": 1,
    "MonthNum": 12,
    "AutoRenew": "on",
    "AccessMode": 2,
    "BandwidthType": 1,
    "Region": "cn-beijing",
    "Spec": "Enterprise",
}

高级版请求示例

创建高级版实例时,除了DefBandElaBand参数外,其他所有请求参数都需要赋值,且满足限制条件。

POST https://open.volcengineapi.com/?Action=PurchaseInstanceInOneStep&Version=2022-01-01
X-Date: 20230711T035055Z
Authorization: HMAC-SHA256 Credential=AKLTNGU0OGEyMT***/20230711/cn-beijing/origin_defence/request, SignedHeaders=content-type;x-content-sha256;x-date, Signature=da4fac562d00f41ad8***
{
    "IpNum": 50,
    "BizBand": 50,
    "PurchaseNum": 1,
    "MonthNum": 12,
    "AutoRenew": "on",
    "AccessMode": 2,
    "BandwidthType": 1,
    "Region": "cn-beijing",
    "Spec": "Deluxe"
}

返回示例

购买成功示例

购买成功后,平台会自动扣取您账号内的费用,并返回ResponseMetadata信息。

{
    "ResponseMetadata": {
        "RequestId": "202311162124068D795C2273F41FA0****",
        "Action": "PurchaseInstanceInOneStep",
        "Version": "2022-01-01",
        "Service": "origin_defence",
        "Region": "cn-beijing"
    }
}

购买失败示例

当请求参数不满足限制条件时,则会返回错误信息。例如以下示例中,创建企业版防护实例时,防护带宽参数DefBand设置为200,则会返回参数校验失败信息。您需要将DefBand设置为300后重新发起请求。

{
    "ResponseMetadata": {
        "RequestId": "20240125215746FC6A6F66C17C7D9E****",
        "Action": "PurchaseInstanceInOneStep",
        "Version": "2022-01-01",
        "Service": "origin_defence",
        "Region": "cn-beijing",
        "Error": {
            "Code": "ValidFail",
            "Message": "【参数校验失败】: DefBand[200] not in valid options"
        }
    }
}