DescribeControlPolicyByRuleId - 根据规则 ID 查询互联网边界防火墙访问控制策略--云防火墙-火山引擎

文档中心

立即注册

导航

DescribeControlPolicyByRuleId - 根据规则 ID 查询互联网边界防火墙访问控制策略

最近更新时间：2025.05.29 17:45:46首次发布时间：2024.03.28 17:09:34

根据策略唯一标识ID查询互联网边界防火墙访问控制策略详情。

使用说明

调用此接口前请先使用DescribeControlPolicy - 查询互联网边界流量控制网关策略获取规则 ID。

请求说明

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

调试

API Explorer

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

去调试

请求参数

Query

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

Body

参数类型是否必选示例值描述

参数	类型	是否必选	示例值	描述
Direction	String	是	`in`	策略方向，用于指定访问控制策略的流量方向。 `in`：入方向； `out`：出方向。
RuleIds	Array of String	是	`f04ac7ce-**---**********`	访问控制策略唯一标识ID，获取方式可参考DescribeControlPolicy - 查询互联网边界流量控制网关策略。
InternetFirewallId	String	否	`ifw-****`	互联网边界防火墙实例ID，获取方式可参考AssetList。

Direction

String

是

in

策略方向，用于指定访问控制策略的流量方向。

in：入方向；
out：出方向。

RuleIds Array of String 是 f04ac7ce-****-****-****-************ 访问控制策略唯一标识ID，获取方式可参考DescribeControlPolicy - 查询互联网边界流量控制网关策略。

InternetFirewallId String 否 ifw-**** 互联网边界防火墙实例ID，获取方式可参考AssetList。

返回参数

参数	类型	示例值	描述
Count	Integer	`1`	返回数据的实际数量。当查询数据为空且使用 Python SDK 调用时，此项为 `None`。
Data	Array of DescribeControlPolicyDetail	`--`	规则详情。
PageNumber	Integer	`1`	返回数据的分页页码，表示当前查询结果所在的页码。
PageSize	Integer	`10`	返回数据的分页大小，表示每页包含的数据条目数量。
TotalCount	Integer	`1`	返回数据总数量。当查询数据为空且使用 Python SDK 调用时，此项为 `None`。

DescribeControlPolicyDetail

参数	类型	示例值	描述
Prio	Integer	`1`	访问控制策略的优先级，数值越小优先级越高。
Proto	String	`TCP`	访问控制策略的协议类型，取值如下所示。 `ICMP`：互联网控制报文协议； `TCP`：传输控制协议； `UDP`：用户数据报协议； `ANY`：任意协议。
Action	String	`accept`	策略动作： `accept`：放行 `deny`：阻断 `monitor`：观察
HitCnt	Integer	`100`	访问控制策略的命中次数，表示该策略被匹配并执行的次数。
IpType	String	`v4`	访问控制策略的 IP 版本，取值如下所示。 `v4`：IPv4； `v6`：IPv6。
RuleId	String	`f04ac7ce-**---**********`	访问控制策略的唯一标识 ID，用于唯一标识一条访问控制策略。
Source	String	`180...1/32`	访问源地址，其格式取决于 `SourceType` 的取值：当 `SourceType` 为 `net` 时，访问源为 CIDR 格式的 IP 地址段，例如 `180...1/24`；当 `SourceType` 为 `group` 时，访问源地址为源地址簿的 UUID 列表，例如 `f04ac7ce-**---**********`；当 `SourceType` 为 `location` 时，访问源地址为区域，例如 `BJ11`、`ZB`。
Status	Boolean	`false`	访问控制策略的开关状态，取值如下所示。 `false`：关闭； `true`：开启。
EndTime	Integer	`1727247865`	访问控制策略的结束生效时间，表示该策略停止生效的时间戳。
DestPort	String	`22/22`	目的端口，其格式取决于 `DestPortType` 的取值：当 `DestPortType` 为 `group` 时，取值为端口地址簿的 UUID 列表；当 `DestPortType` 为 `port` 时，取值为端口范围。
UseCount	Integer	`100`	策略占用数，表示该访问控制策略被引用的次数。
AccountId	String	`2100******`	用户的唯一标识 ID，用于区分不同用户。
Direction	String	`in`	访问控制策略的方向，表示流量的传输方向，取值如下所示。 `in`：入方向； `out`：出方向。
StartTime	Integer	`1727247865`	访问控制策略的开始生效时间，表示该策略开始生效的时间戳。
IsEffected	Boolean	`true`	表示访问控制策略是否生效。 `true`：已生效； `false`：未生效。
RepeatDays	Array of Integer	`[1,3,5]`	访问控制策略的重复生效日期，表示策略在哪些日期重复生效。日期使用数字表示，例如 `1` 表示星期一，`7` 表示星期日。
RepeatType	String	`Once`	访问控制策略的重复类型，表示策略的生效时间模式，取值如下所示。 `Permanent`：永久生效； `Once`：单次生效； `Daily`：每天生效； `Weekly`：每周生效； `Monthly`：每月生效。
SourceType	String	`net`	源地址类型，取值如下所示。 `net`：网段（CIDR）； `group`：地址簿； `location`：区域。
UpdateTime	Integer	`1714298363`	访问控制策略的更新时间，表示该策略最后一次被修改的时间戳。
Description	String	`允许来自特定IP段的入站SSH访问`	访问控制策略的描述信息，用于记录该策略的用途、备注或其他相关信息。
Destination	String	`180...1/32`	访问控制策略的目的地址，其格式取决于 `DestinationType` 的取值：当 `DestinationType` 为 `net` 时，目的地址为 CIDR 格式的 IP 地址段，例如 `180...1/32`；当 `DestinationType` 为 `group` 时，目的地址为目的地址簿的 UUID 列表，例如 `f04ac7ce-**---********`；当 `DestinationType` 为 `location` 时，目的地址为区域，例如 `BJ11`、`ZB`；当 `DestinationType` 为 `Domain` 时，目的地址为目的域名，例如 `***.com`。
DestPortList	Array of String	`["22/22","80","443"]`	访问控制策略的目的端口列表，包含一个或多个端口范围或端口地址簿中的条目。每个条目可以是单个端口（如 `22`）或端口范围（如 `100/200`）。
DestPortType	String	`port`	目的端口类型，取值如下所示。 `port`：端口； `group`：端口地址簿。
EffectStatus	Integer	`3`	访问控制策略的生效状态，取值如下所示。 `1`：未生效； `2`：下发中； `3`：已生效。
RepeatEndTime	String	`2024-09-10 12:00`	访问控制策略的重复生效结束时间，表示该策略在重复生效模式下的结束时间。格式为 `YYYY-MM-DD HH:MM`，例如 `2024-09-10 12:00`。
SourceCidrList	Array of String	`["180...*","192.168.1.0/24"]`	访问控制策略的源地址列表，包含一个或多个 CIDR 格式的 IP 地址段。每个条目表示一个允许或拒绝访问的源 IP 范围。
DestinationType	String	`net`	目的地址的类型，取值如下所示。 `net`：网段（CIDR）； `group`：地址簿； `location`：区域； `domain`：域名。
RepeatStartTime	String	`2024-09-10 11:00`	访问控制策略的重复生效开始时间，表示该策略在重复生效模式下的开始时间。格式为 `YYYY-MM-DD HH:MM`，例如 `2024-09-10 11:00`。
SourceGroupType	String	`ip`	源地址簿的类型，表示访问控制策略中源地址簿的分类方式。
DestPortGroupType	String	`port`	目的端口簿的类型，表示访问控制策略中目的端口簿的分类方式。
DestinationCidrList	Array of String	`["180...*"]`	访问控制策略的目的地址列表，包含一个或多个 CIDR 格式的 IP 地址段。每个条目表示一个允许或拒绝访问的目的 IP 范围。
DestinationGroupType	String	`ip`	目的地址簿的类型，表示访问控制策略中目的地址簿的分类方式。

请求示例

POST https://fw_center.volcengineapi.com/?Action=DescribeControlPolicyByRuleId&Version=2021-09-06
{
    "Direction": "in",
    "RuleIds": [
        "f04ac7ce-****-****-****-************"
    ]
}

返回示例

{
    "ResponseMetadata": {
        "Action": "DescribeControlPolicyByRuleId",
        "Region": "cn-beijing",
        "Service": "fw_center",
        "Version": "2021-09-06",
        "RequestId": "20230604110420****100232280022D31"
    },
    "Result": {
        "Count": 1,
        "Data": [
            {
                "Prio": 1,
                "Proto": "ICMP",
                "Action": "accept",
                "HitCnt": 100,
                "RuleId": "f04ac7ce-****-****-****-************",
                "Source": "180.*.*.1/32",
                "Status": false,
                "EndTime": 1727247865,
                "DestPort": "22/22",
                "UseCount": 100,
                "AccountId": "2100******",
                "Direction": "in",
                "StartTime": 1727247865,
                "IsEffected": true,
                "RepeatDays": [
                    1
                ],
                "RepeatType": "Once",
                "SourceType": "net",
                "UpdateTime": 1714298363,
                "Description": "用于控制特定 IP 地址访问。",
                "Destination": "180.*.*.1/32",
                "DestPortList": [
                    "22/22"
                ],
                "DestPortType": "port",
                "EffectStatus": 1,
                "RepeatEndTime": "2024-09-10 12:00",
                "SourceCidrList": [
                    "180.*.*.*"
                ],
                "DestinationType": "net",
                "RepeatStartTime": "2024-09-10 11:00",
                "SourceGroupType": "ip",
                "DestPortGroupType": "port",
                "DestinationCidrList": [
                    "180.*.*.*"
                ],
                "DestinationGroupType": "ip"
            }
        ],
        "PageNumber": 1,
        "PageSize": 10,
        "TotalCount": 1
    }
}

错误码

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