You need to enable JavaScript to run this app.
导航
云防火墙
  • 文档首页
    • /云防火墙/API参考/互联网边界防火墙/DescribeControlPolicyByRuleId - 根据规则 ID 查询互联网边界防火墙访问控制策略
DescribeControlPolicyByRuleId - 根据规则 ID 查询互联网边界防火墙访问控制策略
最近更新时间：2024.11.25 17:03:53首次发布时间：2024.03.28 17:09:34
我的收藏

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

使用说明

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

请求说明

  • 请求方式：POST
  • 请求地址：?Action=DescribeControlPolicyByRuleId&Version=2021-09-06

调试

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

请求参数

Query

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

Body

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

Direction

String

是

in

策略方向：

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

返回参数

参数类型示例值描述
CountInteger1返回数据的实际数量 当查询数据为空时，且使用python SDK调用时此项为None
DataArray of DescribeControlPolicyStructure--规则详情。
PageNumberInteger1返回数据的分页页码
PageSizeInteger1返回数据的分页大小
TotalCountInteger1返回数据总数量 当查询数据为空时，且使用python SDK调用时此项为None

DescribeControlPolicyStructure

参数类型示例值描述
PrioInteger1优先级

Proto

String

ICMP

协议类型：

  • ICMP
  • TCP
  • UDP
  • ANY(任意协议)

Action

String

accept

访问控制策略的动作：

  • accept：放行
  • deny：阻断
  • monitor：观察
HitCntInteger100规则命中次数
RuleIdStringf04ac7ce-****-****-****-************访问控制策略唯一标识 ID。

Source

String

180.*.*.1/32

源地址。

  • 当SourceType为net时，Source为源CIDR地址。例如：180.. .1/32
  • 当SourceType为group时，Source为源地址簿的uuid。例如：f04ac7ce----********
  • 当SourceType为区域时，Source为区域代码。例如：BJ11

Status

Boolean

false

策略启用状态。

  • true：开启
  • false：关闭
EndTimeInteger1727247865策略生效截止日期，Unix 时间戳，精确到设定日期的 23:59:00。

DestPort

String

22/22

目的端口。

  • 当协议类型为ICMP/ALL时，取值为空
  • 当DestPortType为group时，取值为端口地址簿的uuid列表，多个地址簿通过英文逗号分隔
  • 当DestPortType为port时，取值为端口范围。
UseCountInteger100策略占用数。
AccountIdString2100******账户 ID。

Direction

String

in

策略方向。取值：

  • in - 入方向
  • out - 出方向
StartTimeInteger1727247865策略生效开始日期，精确到设定日期的 00:00:00。

IsEffected

Boolean

true

是否生效。

  • true：生效
  • false：不生效
RepeatDaysArray of Integer1重复生效周期。

RepeatType

String

Once

重复类型。

  • Permanent：始终生效
  • Once：单次生效
  • Daily：每日重复
  • Weekly：每周重复
  • Monthly：每月重复

SourceType

String

net

地址类型。

  • net：网段(CIDR)
  • group：地址簿
  • location：区域
UpdateTimeInteger1714298363更新时间。
DescriptionString用于控制特定 IP 地址访问。描述信息。

Destination

String

180.*.*.1/32

目的地址:

  • 当DestinationType为net时，Destination为目的CIDR地址。例如：192.168.0.2/32
  • 当DestinationType为group时，Destination为目的址簿的uuid。例如：f04ac7ce----********
  • 当DestinationType为Domain时，Destination为目的域名。例如：********.com
  • 当DestinationType为区域时，Destination为区域代码。例如：BJ11
DestPortListArray of String22/22目的端口组列表。

DestPortType

String

port

目的端口类型。

  • port：端口
  • group：端口地址簿

EffectStatus

Integer

1

生效状态。

  • 1：未生效
  • 2：下发中
  • 3：已生效
RepeatEndTimeString2024-09-10 12:00重复生效截止时间。
SourceCidrListArray of String180.*.*.*源地址组列表。

DestinationType

String

net

目的地址类型。

  • net：目的网段(CIDR)
  • group：目的地址簿
  • location：目的区域
  • domain：目的域名
RepeatStartTimeString2024-09-10 11:00重复生效起始时间。

SourceGroupType

String

ip

源地址组类型。

  • ip：引用地址簿
  • 为空：未引用地址簿

DestPortGroupType

String

port

目的端口组类型。

  • port：引用端口地址簿
  • 为空：未引用端口地址簿
DestinationCidrListArray of String180.*.*.*目的地址组详情。

DestinationGroupType

String

ip

目的地址组类型。

  • ip：引用地址簿
  • 为空：未引用地址簿

请求示例

POST ?Action=DescribeControlPolicyByRuleId&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
{
    "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": 1,
        "TotalCount": 1
    }
}