You need to enable JavaScript to run this app.
导航
查询 IP 黑白名单
最近更新时间:2023.10.12 17:39:59首次发布时间:2022.11.02 11:44:09

调用接口查询 IP 黑白名单配置。

说明

该接口属于历史版本 API,我们计划于 2023 年 12 月 25 日停止对其进行维护,并于 2024 年 3 月 25 日下线文档,建议您使用新版查询 IP 黑白名单接口。

注意事项

请求频率:单用户请求频率限制为 10 次/秒

请求说明

  • 请求方式:POST
  • 请求地址:https://live.volcengineapi.com?Action=DescribeDenyConfig&Version=2020-08-01

请求参数

下表仅列出该接口特有的请求参数和部分公共参数。更多信息请见公共参数

Query

参数类型是否必选示例值描述
ActionStringDescribeDenyConfig接口名称。当前 API 的名称为 DescribeDenyConfig
VersionString2020-08-01接口版本。当前 API 的版本为 2020-08-01

Body

参数类型是否必选示例值描述
VhostStringpush.example.com域名空间名称
DomainStringpush.example.com推拉流域名。

返回参数

下表仅列出本接口特有的返回参数。更多信息请见返回结构

参数类型示例值描述
DenyListArray of DenyList-配置列表

DenyList

参数类型示例值描述
VhostStringpush.example.com域名空间名称
DomainStringpush.example.com推拉流域名
DenyConfigArray of DenyConfig-配置详情列表

DenyConfig

参数类型示例值描述
DenyListArray of String["1.1.1.1"]黑名单
AllowListArray 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"
      }
    ]
  }
}

错误码

访问公共错误码获取详细信息。