私有网络查询安全组规则-安全组相关接口-API 中心-腾讯云

1. 接口描述

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

本接口（DescribeSecurityGroupPolicies）用于查询安全组规则。

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

推荐使用 API Explorer

点击调试

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

2. 输入参数

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

参数名称	必选	类型	描述
Action	是	String	公共参数，本接口取值：DescribeSecurityGroupPolicies。
Version	是	String	公共参数，本接口取值：2017-03-12。
Region	是	String	公共参数，详见产品支持的地域列表。
SecurityGroupId	是	String	安全组实例ID，例如：sg-33ocnj9n，可通过DescribeSecurityGroups获取。示例值：sg-ohuuioma
Filters.N	否	Array of Filter	过滤条件。 security-group-id - String - 规则中的安全组ID。 ip - String - IP，支持IPV4和IPV6模糊匹配。 address-module - String - IP地址模板或IP地址组模板ID。 service-module - String - 协议端口模板或协议端口组模板ID。 protocol-type - String - 安全组策略支持的协议，可选值：`TCP`, `UDP`, `ICMP`, `ICMPV6`, `GRE`, `ALL`。 port - String - 是否必填：否 -协议端口，支持模糊匹配，值为`ALL`时，查询所有的端口。 poly - String - 协议策略，可选值：`ALL`，所有策略；`ACCEPT`，允许；`DROP`，拒绝。 direction - String - 协议规则，可选值：`ALL`，所有策略；`INBOUND`，入站规则；`OUTBOUND`，出站规则。 description - String - 协议描述，该过滤条件支持模糊匹配。

3. 输出参数

参数名称	类型	描述
SecurityGroupPolicySet	SecurityGroupPolicySet	安全组规则集合。
RequestId	String	唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 查询安全组规则

查询安全组规则

输入示例

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

{
    "SecurityGroupId": "sg-ohuuioma"
}

输出示例

{
    "Response": {
        "SecurityGroupPolicySet": {
            "Ingress": [
                {
                    "PolicyIndex": 0,
                    "ServiceTemplate": {
                        "ServiceId": "ppm-f5n1f8da",
                        "ServiceGroupId": ""
                    },
                    "AddressTemplate": {
                        "AddressGroupId": "ipmg-2uw6ujo6",
                        "AddressId": ""
                    },
                    "Action": "ACCEPT",
                    "ModifyTime": "2017-03-12 10:00:00",
                    "PolicyDescription": "ModifyPolicies"
                },
                {
                    "PolicyIndex": 1,
                    "ServiceTemplate": {
                        "ServiceId": "ppm-f5n1f8da",
                        "ServiceGroupId": ""
                    },
                    "AddressTemplate": {
                        "AddressGroupId": "ipmg-2uw6ujo6",
                        "AddressId": ""
                    },
                    "Action": "ACCEPT",
                    "ModifyTime": "2017-03-12 10:00:00",
                    "PolicyDescription": "2"
                }
            ],
            "Egress": [
                {
                    "PolicyIndex": 0,
                    "ServiceTemplate": {
                        "ServiceId": "ppm-f5n1f8da",
                        "ServiceGroupId": ""
                    },
                    "AddressTemplate": {
                        "AddressGroupId": "ipmg-2uw6ujo6",
                        "AddressId": ""
                    },
                    "Action": "ACCEPT",
                    "ModifyTime": "2017-03-12 10:00:00",
                    "PolicyDescription": "E1"
                }
            ],
            "PolicyStatistics": {
                "IngressIPv4TotalCount": 0,
                "IngressIPv6TotalCount": 0,
                "EgressIPv4TotalCount": 0,
                "EgressIPv6TotalCount": 0
            },
            "Version": "60"
        },
        "RequestId": "74883e1b-5901-46de-ae1e-d6e2cf591c5b"
    }
}

5. 开发者资源

腾讯云 API 平台

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

API Inspector

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

SDK

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

Tencent Cloud SDK 3.0 for Python: GitHub Gitee
Tencent Cloud SDK 3.0 for Java: GitHub Gitee
Tencent Cloud SDK 3.0 for PHP: GitHub Gitee
Tencent Cloud SDK 3.0 for Go: GitHub Gitee
Tencent Cloud SDK 3.0 for Node.js: GitHub Gitee
Tencent Cloud SDK 3.0 for .NET: GitHub Gitee
Tencent Cloud SDK 3.0 for C++: GitHub Gitee
Tencent Cloud SDK 3.0 for Ruby: GitHub Gitee

命令行工具

Tencent Cloud CLI 3.0

6. 错误码

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

错误码	描述
InvalidParameter.FilterInvalidKey	指定过滤条件不存在。
InvalidParameter.FilterNotDict	指定过滤条件不是键值对。
InvalidParameter.FilterValuesNotList	指定过滤选项值不是列表。
InvalidParameterValue.LimitExceeded	参数值超出限制。
InvalidParameterValue.Malformed	入参格式不合法。
InvalidParameterValue.TooLong	无效参数值。参数值太长。
ResourceNotFound	资源不存在。
UnsupportedOperation	操作不支持。