DescribeDnsControlPolicy-查询域名黑名单访问控制策略列表--云防火墙-火山引擎

文档中心

立即注册

导航

DescribeDnsControlPolicy-查询域名黑名单访问控制策略列表

最近更新时间：2025.05.29 17:32:43首次发布时间：2024.12.25 10:23:31

查询域名黑名单访问控制策略列表。

请求说明

请求方式：POST
请求地址：https://fw_center.volcengineapi.com/?Action=DescribeDnsControlPolicy&Version=2021-09-06

调试

API Explorer

您可以通过 API Explorer 在线发起调用，无需关注签名生成过程，快速获取调用结果。

去调试

请求参数

Query

参数	类型	是否必选	示例值	描述
Action	String	是	`DescribeDnsControlPolicy`	接口名称。当前 API 的名称为 `DescribeDnsControlPolicy`。
Version	String	是	`2021-09-06`	接口版本。当前 API 的版本为 `2021-09-06`。

Body

参数	类型	是否必选	示例值	描述
Description	String	否	`Description`	查询条件，模糊查询。描述信息。
Destination	Array of String	否	`********.com`	查询条件，模糊查询。访问目的，多个值间为或条件。每个值使用模糊查询查询时会先根据查询条件关联地址簿的名字和内容再进行查询。
InternetFirewallId	String	否	`ifw-****`	互联网边界防火墙实例ID，获取方式可参考AssetList - 查询互联网边界资产列表。
PageNumber	Integer	否	`1`	分页页码，默认值为 `1`。
PageSize	Integer	否	`10`	分页大小，默认值为 `10`，最大值为 `1000`。
RuleId	Array of String	否	`f04ac7ce-**---**********`	查询条件，模糊查询。访问控制策略唯一标识ID，多个值间为或条件。
Source	Array of String	否	`vpc-********`	查询条件，模糊查询。访问源，多个值间为或条件。每个值使用模糊查询查询时会先根据查询条件关联地址簿的名字和内容再进行查询。
Status	Array of Boolean	否	`true`	查询条件，精确查询。策略状态，多个值间为或条件。

返回参数

参数	类型	示例值	描述
Count	Integer	`1`	返回数据的实际数量，当查询数据为空且使用 `Python SDK` 调用时此项为 `None`。
Data	Array of DnsControlPolicyDetail	`--`	数据详情，包含域名黑名单访问控制策略的具体信息列表。
PageNumber	Integer	`1`	返回数据的分页页码，表示当前查询结果所在的页码。
PageSize	Integer	`10`	返回数据的分页大小，表示每页显示的记录数量。
TotalCount	Integer	`100`	返回数据的总数量，当查询数据为空且使用 `Python SDK` 调用时此项为 `None`。

DnsControlPolicyDetail

参数	类型	示例值	描述
HitCnt	Integer	`10`	命中计数，表示该域名黑名单访问控制策略被触发的次数。
RuleId	String	`f04ac7ce-**---**********`	访问控制策略的唯一标识 `ID`，用于区分不同的域名黑名单策略。
Source	Array of SourceStructure	`--`	访问源信息，包含 `VPC` 列表，每个 `VPC` 包含以下属性。 `VpcId`：`VPC` 的唯一标识 `ID`； `Region`：`VPC` 所在的地域信息。
Status	Boolean	`true`	表示域名黑名单访问控制策略的开关状态。 `false`：关闭； `true`：开启。
UseCount	Integer	`10`	表示该域名黑名单访问控制策略占用的策略数量。
AccountId	String	`2100******`	用户的唯一标识 `ID`，用于区分不同的用户账号。
DomainList	Array of String	`["example.com","test.com"]`	如果目的类型为地址簿，返回域名地址簿的域名列表。
Description	String	`允许来自特定IP段的入站SSH访问`	访问控制策略的描述信息，用于记录该策略的用途、备注或其他相关信息。
Destination	String	`example.com`	访问目的，可以是域名或域名地址簿的唯一标识 `ID`。当目的类型为 `domain` 时，此处填写具体的域名；当目的类型为 `group` 时，此处填写域名地址簿的唯一标识 `ID`。
LastHitTime	Integer	`1703157199`	最近命中时间戳，表示该域名黑名单访问控制策略最后一次被触发的时间，以 Unix 时间戳格式返回。
DomainListV1	Array of AddressStructure	`--`	如果目的类型为地址簿，返回域名地址簿的域名列表，每个域名地址簿包含以下属性。 `Type`：地址类型； `Address`：具体地址信息； `Description`：描述信息。
DestinationType	String	`group`	访问目的的类型，取值如下所示。 `domain`：表示目的为单个域名； `group`：表示目的为域名地址簿。
DestinationGroupList	Array of String	`["7d54a3cf-**---**********"]`	如果目的类型为地址簿，返回域名地址簿名称列表。每个名称对应一个域名地址簿的唯一标识 `ID`。

SourceStructure

参数	类型	示例值	描述
VpcId	String	`vpc-xxxx`	VPC ID，获取方式可参考DescribeVpcs-查询VPC列表。
Region	String	`cn-beijing`	VPC 地域信息，获取方式可参考DescribeVpcs-查询VPC列表。

AddressStructure

参数类型示例值描述

参数	类型	示例值	描述
Type	String	`port`	地址类型： `ip`：IP 地址 `domain`：域名 `port`：端口
Address	String	`192.1.1.1`	当 `GroupType` 为 `ip` 时，地址列表中填写 `IPv4/CIDRv4` 地址；当 `GroupType` 为 `port` 时，地址列表中填写端口信息，支持 `22`、`100/200` 两种格式；当 `GroupType` 为 `domain` 时，地址列表中填写域名信息。
Description	String	`允许来自特定IP段的入站SSH访问`	访问控制策略的描述信息，用于记录该策略的用途、备注或其他相关信息。

Type

String

port

地址类型：

ip：IP 地址
domain：域名
port：端口

Address

String

192.1.1.1

当 GroupType 为 ip 时，地址列表中填写 IPv4/CIDRv4 地址；
当 GroupType 为 port 时，地址列表中填写端口信息，支持 22、100/200 两种格式；
当 GroupType 为 domain 时，地址列表中填写域名信息。

Description String 允许来自特定IP段的入站SSH访问 访问控制策略的描述信息，用于记录该策略的用途、备注或其他相关信息。

请求示例

POST https://fw_center.volcengineapi.com/?Action=DescribeDnsControlPolicy&Version=2021-09-06
{
    "InternetFirewallId": "ifw-ydksw011xciyipwm****",
    "PageNumber": 1,
    "PageSize": 10
}

返回示例

{
    "ResponseMetadata": {
        "RequestId": "20241218154806C9B5F2265720D3C29F8E",
        "Action": "DescribeDnsControlPolicy",
        "Version": "2021-09-06"
    },
    "Result": {
        "TotalCount": 1,
        "PageSize": 10,
        "PageNumber": 1,
        "Count": 1,
        "Data": [
            {
                "AccountId": "2100052970",
                "RuleId": "d7700d3a-7c7e-4a5c-abd1-***********",
                "Description": "测试用例",
                "Source": [
                    {
                        "Region": "cn-beijing",
                        "VpcId": "vpc-2bz8ol7si5u682dx*******"
                    }
                ],
                "DestinationType": "domain",
                "Destination": "www.example123.com",
                "UseCount": 1,
                "Status": true,
                "HitCnt": 0,
                "LastHitTime": 0,
                "DestinationGroupList": null,
                "DomainList": [
                    "example.com"
                ],
                "DomainListV1": null
            }
        ]
    }
}

错误码

您可访问公共错误码，获取更多错误码信息。