ListConsumptionLimit - 获取用量封顶配置列表--内容分发网络-火山引擎

文档中心

立即注册

导航

ListConsumptionLimit - 获取用量封顶配置列表

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

获取符合过滤条件的用量封顶配置的详情。支持按域名、配置 ID 和配置状态过滤。

使用限制

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

请求说明

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

请求参数

Query

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

Body

参数名称	数据类型	是否必选	参数说明	示例
ConfigId	String	否	表示一个配置 ID，用于过滤 API 返回的配置列表。	`68c92ec6d44764b98de442c3`
Domain	String	否	表示一个域名，用于过滤 API 返回的配置列表。支持模糊匹配。	`example`
Status	String	否	表示配置的状态，用于过滤 API 返回的配置列表。该参数有以下取值： `enable` `disable`	`enable`
PageNum	Long	否	表示页码，展示该页上的用量封顶配置。该参数的取值范围是 1~100，默认值是 `1`。	`1`
PageSize	Long	否	表示分页大小，默认值是 `10`。	`10`

返回参数

参数名称	数据类型	参数说明	示例
ConfigInfo	Object[]	表示符合过滤条件的配置列表。列表中包含每个配置的详情。
PageNum	Long	表示页码。	`1`
PageSize	Long	表示分页的大小。	`10`
Total	Long	表示符合过滤条件的配置总数。	`5`

请求示例

POST https://cdn.volcengineapi.com/?Action=ListConsumptionLimit&Version=2021-03-01
{
    "Domain": "example",
    "Status": "enable",
    "PageSize": 10,
    "PageNum": 1
}

返回示例

{
    "ResponseMetadata": {
        "RequestId": "20250916183901819D108F981F85D2CE20",
        "Action": "ListConsumptionLimit",
        "Version": "2021-03-01",
        "Service": "CDN",
        "Region": "cn-north-01"
    },
    "Result": {
        "ConfigInfo": [
            {
                "AlarmPercent": 40,
                "ConfigId": "68c92f08d44764b98de442c6",
                "CreateTime": 1758015240,
                "Cycle": "hour",
                "Domain": "www.example.com",
                "EnableAlarm": true,
                "LimitAction": "stop_domain",
                "Metric": "traffic",
                "RecoverTime": "12hour",
                "Status": "enable",
                "Threshold": 800000000,
                "Type": "total",
                "UpdateTime": 1758016011
            },
            {
                "AlarmPercent": 0,
                "ConfigId": "68c92ec6d44764b98de442c3",
                "CreateTime": 1758015174,
                "Cycle": "5min",
                "Domain": "docs.example.com",
                "EnableAlarm": false,
                "LimitAction": "stop_domain",
                "Metric": "bandwidth",
                "RecoverTime": "hour",
                "Status": "enable",
                "Threshold": 30000000,
                "Type": "moment",
                "UpdateTime": 1758015174
            },
            {
                "AlarmPercent": 50,
                "ConfigId": "68c91beef47c08a220fbe9f8",
                "CreateTime": 1758010350,
                "Cycle": "hour",
                "Domain": "img.example.com",
                "EnableAlarm": true,
                "LimitAction": "stop_domain",
                "Metric": "requests",
                "RecoverTime": "hour",
                "Status": "enable",
                "Threshold": 10000,
                "Type": "total",
                "UpdateTime": 1758010350
            }
        ],
        "PageNum": 1,
        "PageSize": 10,
        "Total": 3
    }
}

错误码

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