查询安全组规则列表

最近更新时间:2024-11-04 20:02:56

我的收藏

1. 接口描述

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

查询安全组规则列表

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

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

2. 输入参数

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

参数名称 必选 类型 描述
Action String 公共参数,本接口取值:DescribeSecurityGroupList。
Version String 公共参数,本接口取值:2019-09-04。
Region String 公共参数,本接口不需要传递此参数。
Direction Integer 0: 出站规则,1:入站规则
示例值:1
Area String 地域代码(例: ap-guangzhou),支持腾讯云全部地域
示例值:ap-guangzhou
SearchValue String 搜索值
示例值:TCP模版
Limit Integer 每页条数,默认为10
示例值:10
Offset Integer 偏移值,默认为0
示例值:0
Status String 状态,'': 全部,'0':筛选停用规则,'1':筛选启用规则
示例值:0
Filter Integer 0: 不过滤,1:过滤掉正常规则,保留下发异常规则
示例值:0

3. 输出参数

参数名称 类型 描述
Total Integer 列表当前规则总条数
示例值:0
Data Array of SecurityGroupListData 安全组规则列表数据
示例值:[{"OrderIndex":1,"SourceId":"ipm-dyodhpby","SourceType":7,"TargetId":"subnet-fmo10koi","TargetType":2,"Protocol":"ANY","Port":"-1/-1","Strategy":2,"Detail":"andy的规则","BothWay":0,"Id":1,"Status":1,"IsNew":1,"VpcId":"vpc-8xuf8kf5","SubnetId":"subnet-fmo10koi","InstanceName":"InstanceName","PublicIp":"1.1.1.1","PrivateIp":"9.0.0.1","Cidr":"9.0.0.1/32","ServiceTemplateId":"ppmg-jz17vpis","Direction":0,"ProtocolPortType":1,"Uuid":"cfw_sg_appid_0.0.0.0/0_17295140975391","Region":"ap-guangzhou","AssetGroupNameIn":"/全部资产/","AssetGroupNameOut":"/全部资产/","ParameterName":"自动化勿删IP组模板","ProtocolPortName":"端口协议类型参数模板名称","BothWayInfo":[{"OrderIndex":1,"SourceId":"1.1.1.1","SourceType":7,"TargetId":"1.1.1.1","TargetType":2,"Protocol":"ANY","Port":"-1/-1","Strategy":2,"Detail":"andy的规则","Status":1,"IsNew":1,"BothWay":0,"VpcId":"vpc-iedpwx01d","SubnetId":"subnet-ed2witec","InstanceName":"andy的cvm","PublicIp":"1.1.1.1","PrivateIp":"1.1.1.1","Cidr":"10.72.1.0/24","ServiceTemplateId":"pp-peodxd0e","Direction":1,"Region":"ap-guangzhou","ProtocolPortType":1}]}]
AllTotal Integer 不算筛选条数的总条数
示例值:0
Enable Integer 访问控制规则全部启用/全部停用
示例值:1
RequestId String 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 查询安全组规则列表

输入示例

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

{
    "SearchValue": "{\"common\":\"模糊检索\"}",
    "Direction": 1,
    "Limit": 20,
    "Offset": 0,
    "Filter": 0,
    "Status": "0",
    "Area": "ap-guangzhou"
}

输出示例

{
    "Response": {
        "Total": 0,
        "AllTotal": 0,
        "Enable": 1,
        "Data": [
            {
                "OrderIndex": 1,
                "SourceId": "ipm-dyodhpby",
                "SourceType": 7,
                "TargetId": "subnet-fmo10koi",
                "TargetType": 2,
                "Protocol": "ANY",
                "Port": "-1/-1",
                "Strategy": 2,
                "Detail": "andy的规则",
                "BothWay": 0,
                "Id": 1,
                "Status": 1,
                "IsNew": 1,
                "VpcId": "vpc-8xuf8kf5",
                "SubnetId": "subnet-fmo10koi",
                "InstanceName": "InstanceName",
                "PublicIp": "1.1.1.1",
                "PrivateIp": "9.0.0.1",
                "Cidr": "9.0.0.1/32",
                "ServiceTemplateId": "ppmg-jz17vpis",
                "Direction": 0,
                "ProtocolPortType": 1,
                "Uuid": "cfw_sg_appid_0.0.0.0/0_17295140975391",
                "Region": "ap-guangzhou",
                "AssetGroupNameIn": "/全部资产/",
                "AssetGroupNameOut": "/全部资产/",
                "ParameterName": "自动化勿删IP组模板",
                "ProtocolPortName": "端口协议类型参数模板名称",
                "BothWayInfo": [
                    {
                        "OrderIndex": 1,
                        "SourceId": "1.1.1.1",
                        "SourceType": 7,
                        "TargetId": "1.1.1.1",
                        "TargetType": 2,
                        "Protocol": "ANY",
                        "Port": "-1/-1",
                        "Strategy": 2,
                        "Detail": "andy的规则",
                        "Status": 1,
                        "IsNew": 1,
                        "BothWay": 0,
                        "VpcId": "vpc-iedpwx01d",
                        "SubnetId": "subnet-ed2witec",
                        "InstanceName": "andy的cvm",
                        "PublicIp": "1.1.1.1",
                        "PrivateIp": "1.1.1.1",
                        "Cidr": "10.72.1.0/24",
                        "ServiceTemplateId": "pp-peodxd0e",
                        "Direction": 1,
                        "Region": "ap-guangzhou",
                        "ProtocolPortType": 1
                    }
                ]
            }
        ],
        "RequestId": "3c140219-cfe9-470e-b241-907877d6fb03"
    }
}

5. 开发者资源

腾讯云 API 平台

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

API Inspector

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

SDK

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

命令行工具

6. 错误码

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

错误码 描述
FailedOperation 操作失败。
InvalidParameter 参数错误。
LimitExceeded 超过配额限制。
UnauthorizedOperation 未授权操作。