云防火墙
视频服务与安全产品捉虫活动邀您参加！> HOT
文档中心>云防火墙>API 文档>企业安全组相关接口>查询新企业安全组规则

查询新企业安全组规则

最近更新时间：2024-11-03 18:07:51

我的收藏

本页目录：

1. 接口描述

接口请求域名： cfw.tencentcloudapi.com 。

查询新企业安全组规则

默认接口请求频率限制：20次/秒。

推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。

2. 输入参数

以下请求参数列表仅列出了接口请求参数和部分公共参数，完整公共参数列表见 公共请求参数。

参数名称 必选 类型 描述
Action 是 String 公共参数，本接口取值：DescribeEnterpriseSecurityGroupRule。
Version 是 String 公共参数，本接口取值：2019-09-04。
Region 否 String 公共参数，本接口不需要传递此参数。
PageNo 是 String 分页查询时，显示的当前页的页码。

默认值为1。
示例值：1
PageSize 是 String 分页查询时，显示的每页数据的最大条数。

可设置值最大为50。
示例值：10
SourceContent 否 String 访问源示例：
net：IP/CIDR(192.168.0.2)
template：参数模板(ipm-dyodhpby)
instance：资产实例(ins-123456)
resourcegroup：资产分组(/全部分组/分组1/子分组1)
tag：资源标签({"Key":"标签key值","Value":"标签Value值"})
region：地域(ap-gaungzhou)
支持通配
示例值：1.1.1.1
DestContent 否 String 访问目的示例：
net：IP/CIDR(192.168.0.2)
template：参数模板(ipm-dyodhpby)
instance：资产实例(ins-123456)
resourcegroup：资产分组(/全部分组/分组1/子分组1)
tag：资源标签({"Key":"标签key值","Value":"标签Value值"})
region：地域(ap-gaungzhou)
支持通配
示例值：1.1.1.1
Description 否 String 规则描述，支持通配
示例值：这是一个规则描述
RuleAction 否 String 访问控制策略中设置的流量通过云防火墙的方式。取值：
accept：放行
drop：拒绝
示例值：accept
Enable 否 String 是否启用规则，默认为启用，取值：
true为启用，false为不启用
示例值：true
Port 否 String 访问控制策略的端口。取值：
-1/-1：全部端口
80：80端口
示例值：-1/-1
Protocol 否 String 协议；TCP/UDP/ICMP/ANY
示例值：ANY
ServiceTemplateId 否 String 端口协议类型参数模板id；协议端口模板id
示例值：ppmg-jz17vpis
RuleUuid 否 Integer 规则的uuid
示例值：8888

3. 输出参数

参数名称 类型 描述
PageNo String 分页查询时，显示的当前页的页码。
示例值：1
PageSize String 分页查询时，显示的每页数据的最大条数。
示例值：10
Rules Array of SecurityGroupRule 访问控制策略列表
示例值：[{"SourceContent":"192.168.0.2","SourceType":"net","DestContent":"192.168.0.3","DestType":"net","Protocol":"TCP","Port":"80","ServiceTemplateId":"","RuleAction":"accept","Description":"放行规则","OrderIndex":"1","Id":"1","Enable":"true"}]
TotalCount String 访问控制策略的总数量。
示例值：100
RequestId String 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 查询新企业安全组规则

查询新企业安全组规则

输入示例

POST / HTTP/1.1
Host: cfw.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeEnterpriseSecurityGroupRule
<公共请求参数>

{
    "SourceContent": "192.168.0.2",
    "DestContent": "192.168.0.3",
    "Description": "放行规则",
    "RuleAction": "accept",
    "Enable": "true",
    "Port": "80",
    "Protocol": "TCP",
    "ServiceTemplateId": "ppmg-jz17vpis",
    "PageNo": "1",
    "PageSize": "10",
    "RuleUuid": 1
}

输出示例

{
    "Response": {
        "PageNo": "1",
        "PageSize": "10",
        "Rules": [
            {
                "SourceContent": "192.168.0.2",
                "SourceType": "net",
                "DestContent": "192.168.0.3",
                "DestType": "net",
                "Protocol": "TCP",
                "Port": "80",
                "ServiceTemplateId": "ppmg-jz17vpis",
                "RuleAction": "accept",
                "Description": "放行规则",
                "OrderIndex": "1",
                "Id": "1",
                "Enable": "true"
            }
        ],
        "TotalCount": "1",
        "RequestId": "8f563b4d-8151-4db0-a822-9bde279d2079"
    }
}

5. 开发者资源

腾讯云 API 平台

腾讯云 API 平台 是综合 API 文档、错误码、API Explorer 及 SDK 等资源的统一查询平台，方便您从同一入口查询及使用腾讯云提供的所有 API 服务。

API Inspector

用户可通过 API Inspector 查看控制台每一步操作关联的 API 调用情况，并自动生成各语言版本的 API 代码，也可前往 API Explorer 进行在线调试。

SDK

云 API 3.0 提供了配套的开发工具集（SDK），支持多种编程语言，能更方便的调用 API。

命令行工具

6. 错误码

以下仅列出了接口业务逻辑相关的错误码，其他错误码详见 公共错误码。

错误码 描述
AuthFailure CAM签名/鉴权错误。
DryRunOperation DryRun 操作，代表请求将会是成功的，只是多传了 DryRun 参数。
FailedOperation 操作失败。
InternalError 内部错误。
InvalidParameter 参数错误。
InvalidParameterValue 参数取值错误。
LimitExceeded 超过配额限制。
MissingParameter 缺少参数错误。
OperationDenied 操作被拒绝。
RequestLimitExceeded 请求的次数超过了频率限制。
ResourceInUse 资源被占用。
ResourceInsufficient 资源不足。
ResourceNotFound 资源不存在。
ResourceUnavailable 资源不可用。
ResourcesSoldOut 资源售罄。
UnauthorizedOperation 未授权操作。
UnknownParameter 未知参数错误。
UnsupportedOperation 操作不支持。
中国站
文档反馈
文档活动
message-icon联系我们
目录