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

文档中心

立即注册

导航

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

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

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

请求说明

请求方式：POST
请求地址：?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
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 DnsControlPolicy	`--`	数据详情
PageNumber	Integer	`1`	返回数据的分页页码
PageSize	Integer	`1`	返回数据的分页大小
TotalCount	Integer	`1`	返回数据总数量当查询数据为空时，且使用python SDK调用时此项为None

DnsControlPolicy

参数	类型	示例值	描述
HitCnt	Integer	`10`	命中计数
RuleId	String	`f04ac7ce-**---**********`	访问控制策略唯一标识ID
Source	Array of SourceStructure	`--`	访问源：VPC列表
Status	Boolean	`true`	开关状态： false：关闭 true：开启
UseCount	Integer	`10`	占用策略数
AccountId	String	`2100******`	用户ID
DomainList	Array of String	`********.com`	如果目的类型为地址簿，返回域名地址簿的域名列表
Description	String	`Description`	描述信息
Destination	String	`********.com`	访问目的：域名或域名地址簿唯一标识ID
LastHitTime	Integer	`1703157199`	最近命中时间戳
DomainListV1	Array of AddressStructure	`--`	如果目的类型为地址簿，返回域名地址簿的域名列表
DestinationType	String	`group`	目的类型： domain：域名 group：地址簿
DestinationGroupList	Array of String	`7d54a3cf-**---**********`	如果目的类型为地址簿，返回域名地址簿名称列表

SourceStructure

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

AddressStructure

参数	类型	示例值	描述
Address	String	`192.1..`	当GroupType为ip时，地址列表中填写ipv4/cidrv4地址当GroupType为port时，地址列表中填写端口信息，支持22、100/200两种格式当GroupType为domain时，地址列表中填写域名信息
Description	String	`Description`	描述信息

请求示例

POST ?Action=DescribeDnsControlPolicy&Version=2021-09-06
Host: https://open.volcengineapi.com
Content-Type: application/json; charset=UTF-8
X-Date: 20240711T081413Z
X-Content-Sha256: 287e874e******d653b44d21e
Authorization: HMAC-SHA256 Credential=Adfks******wekfwe/20240711/cn-beijing/fw_center/request, SignedHeaders=host;x-content-sha256;x-date, Signature=47a7d934ff7b37c03938******cd7b8278a40a1057690c401e92246a0e41085f
{
    "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
            }
        ]
    }
}

错误码

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