CreateConsumptionLimit - 创建用量封顶配置--内容分发网络-火山引擎

文档中心

立即注册

导航

CreateConsumptionLimit - 创建用量封顶配置

最近更新时间：2025.09.29 11:06:51首次发布时间：2025.09.16 20:21:11

创建一个 "用量封顶" 配置。

使用限制

节流限制：您每秒最多可以提交 20 个 API 请求。

请求说明

请求方式：POST
请求地址：https://cdn.volcengineapi.com/?Action=CreateConsumptionLimit&Version=2021-03-01

请求参数

Query

参数名称	数据类型	是否必选	参数说明
Action	String	是	接口名称。当前 API 的名称为 `CreateConsumptionLimit`。
Version	String	是	接口版本。当前 API 的版本为 `2021-03-01`。

Body

参数名称	数据类型	是否必选	参数说明	示例
Domain	String	是	表示一个域名，为该域名创建 "用量封顶" 配置。	`www.example.com`
Type	String	是	表示监控指标的数据统计方式。该参数有以下取值： `moment`：表示瞬间用量。 `total`：表示累计用量。	`moment`
Cycle	String	是	表示统计周期，有以下取值：当 `Type` 是 `moment` 时，`Cycle` 只能是 `5min`。当 `Type` 是 `total` 时，`Cycle` 可以是 `hour`、`day` 或 `month`。	`5min`
Metric	String	是	表示监控指标，有以下取值：当 `Type` 是 `moment` 时，`Metric` 可以是 `bandwidth` 或 `qps`，分别表示带宽和请求 QPS。当 `Type` 是 `total` 时，`Metric` 可以是 `traffic` 或 `requests`，分别表示流量和请求数。 `bandwidth` 和 `traffic` 的单位分别是 bps 和 bytes，使用的进制都是 1,000。	`bandwidth`
Threshold	Long	是	表示 `Metric` 的阈值。如果 `Metric` 是 `bandwidth`，您可以设置的阈值范围是 10,000,000~100,000,000,000,000，对应 10Mbps~100Tbps。如果 `Metric` 是 `traffic`，您可以设置的阈值范围是 100,000,000~10,000,000,000,000,000，对应 100MB~10,000TB。如果 `Metric` 是 `requests`，您可以设置的阈值范围是：10,000~10,000,000,000。如果 `Metric` 是 `qps`，您可以设置的阈值范围是 100~1,000,000。	`30000000`
LimitAction	String	是	表示当 `Metric` 达到 `Threshold` 时，CDN 对 `Domain` 执行的操作。当前，该参数值只能是 `stop_domain`，表示停用域名。	`stop_domain`
RecoverTime	String	是	表示 `LimitAction` 的生效时长，有以下取值： `hour` `12hour` `day` `3day` `forever`	`day`
EnableAlarm	Boolean	否	表示您是否希望当 `Metric` 达到您设置的告警阈值时收到通知。该参数的默认值是 `false`，表示不启用告警。	`true`
AlarmPercent	Long	否	表示告警阈值，也就是 `Threshold` 的百分比，取值范围是 10~90。当 `EnableAlarm` 是 `true` 时，该参数必填。	`80`

返回参数

参数名称	数据类型	参数说明	示例
ConfigId	String	表示创建的配置 ID。	`6887a5f6e64975fe596b02fa`

请求示例

POST https://cdn.volcengineapi.com/?Action=CreateConsumptionLimit&Version=2021-03-01
{
    "Domain": "element250911.byte-test.com",
    "Type": "moment",
    "Metric": "bandwidth",
    "Cycle": "5min",
    "Threshold": 40000000,
    "LimitAction": "stop_domain",
    "RecoverTime": "hour",
    "EnableAlarm": true,
    "AlarmPercent": 20
}

错误码

如果响应正文的 ResponseMetadata 字段中包含 Error 字段，则表示 API 请求失败。更多关于错误码的信息，参见错误码。