最近更新时间:2023.10.12 17:39:59
首次发布时间:2022.11.02 11:44:09
调用接口查询 IP 黑白名单配置。
说明
该接口属于历史版本 API,我们计划于 2023 年 12 月 25 日停止对其进行维护,并于 2024 年 3 月 25 日下线文档,建议您使用新版查询 IP 黑白名单接口。
请求频率:单用户请求频率限制为 10 次/秒。
下表仅列出该接口特有的请求参数和部分公共参数。更多信息请见公共参数。
参数 | 类型 | 是否必选 | 示例值 | 描述 |
---|---|---|---|---|
Action | String | 是 | DescribeDenyConfig | 接口名称。当前 API 的名称为 DescribeDenyConfig 。 |
Version | String | 是 | 2020-08-01 | 接口版本。当前 API 的版本为 2020-08-01 。 |
参数 | 类型 | 是否必选 | 示例值 | 描述 |
---|---|---|---|---|
Vhost | String | 否 | push.example.com | 域名空间名称 |
Domain | String | 否 | push.example.com | 推拉流域名。 |
下表仅列出本接口特有的返回参数。更多信息请见返回结构。
参数 | 类型 | 示例值 | 描述 |
---|---|---|---|
DenyList | Array of DenyList | - | 配置列表 |
参数 | 类型 | 示例值 | 描述 |
---|---|---|---|
Vhost | String | push.example.com | 域名空间名称 |
Domain | String | push.example.com | 推拉流域名 |
DenyConfig | Array of DenyConfig | - | 配置详情列表 |
参数 | 类型 | 示例值 | 描述 |
---|---|---|---|
DenyList | Array of String | ["1.1.1.1"] | 黑名单 |
AllowList | Array of String | ["1.1.1.2"] | 白名单 |
POST https://live.volcengineapi.com?Action=DescribeDenyConfig&Version=2020-08-01 { "Vhost": "push.example.com", "Domain": "push.example.com" }
{ "ResponseMetadata": { "Action": "DescribeDenyConfig", "Region": "cn-north-1", "RequestId": "202306041104200100100232280022D31", "Version": "2023-01-01", "Service": "live" }, "Result": { "DenyList": [ { "DenyConfig": [ { "DenyList": [ "1.1.1.1" ], } ], "Vhost": "push.example.com", "Domain": "push.example.com" } ] } }
访问公共错误码获取详细信息。