1. 接口描述
接口请求域名: lighthouse.tencentcloudapi.com 。
本接口(DescribeFirewallRules)用于查询实例的防火墙规则。
默认接口请求频率限制:10次/秒。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数。
参数名称 | 必选 | 类型 | 描述 |
---|---|---|---|
Action | 是 | String | 公共参数,本接口取值:DescribeFirewallRules。 |
Version | 是 | String | 公共参数,本接口取值:2020-03-24。 |
Region | 是 | String | 公共参数,详见产品支持的 地域列表。 |
InstanceId | 是 | String | 实例 ID。 |
Offset | 否 | Integer | 偏移量,默认为 0。 |
Limit | 否 | Integer | 返回数量,默认为 20,最大值为 100。 |
3. 输出参数
参数名称 | 类型 | 描述 |
---|---|---|
TotalCount | Integer | 符合条件的防火墙规则数量。 |
FirewallRuleSet | Array of FirewallRuleInfo | 防火墙规则详细信息列表。 |
FirewallVersion | Integer | 防火墙版本号。 |
RequestId | String | 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 查询实例的所有防火墙规则
输入示例
https://lighthouse.tencentcloudapi.com/?Action=DescribeFirewallRules
&InstanceId=lhins-aglzynfg
&<公共请求参数>
输出示例
{
"Response": {
"FirewallRuleSet": [
{
"Action": "DROP",
"AppType": "自定义",
"CidrBlock": "0.0.0.0/0",
"FirewallRuleDescription": "",
"Port": "22,88",
"Protocol": "TCP"
},
{
"Action": "ACCEPT",
"AppType": "自定义",
"CidrBlock": "0.0.0.0/0",
"FirewallRuleDescription": "test",
"Port": "88",
"Protocol": "TCP"
},
{
"Action": "ACCEPT",
"AppType": "HTTP(80)",
"CidrBlock": "0.0.0.0/0",
"FirewallRuleDescription": "test",
"Port": "80",
"Protocol": "TCP"
},
{
"Action": "ACCEPT",
"AppType": "HTTPS(443)",
"CidrBlock": "0.0.0.0/0",
"FirewallRuleDescription": "放通Web服务HTTPS(443),如 Apache、Nginx",
"Port": "443",
"Protocol": "TCP"
}
],
"FirewallVersion": 1,
"RequestId": "afa0c876-336a-4ed6-ad01-89b3b2632207",
"TotalCount": 4
}
}
示例2 查询实例的部分防火墙规则
输入示例
https://lighthouse.tencentcloudapi.com/?Action=DescribeFirewallRules
&InstanceId=lhins-aglzynfg
&Offset=0
&Limit=1
&<公共请求参数>
输出示例
{
"Response": {
"FirewallRuleSet": [
{
"Action": "DROP",
"AppType": "自定义",
"CidrBlock": "0.0.0.0/0",
"FirewallRuleDescription": "",
"Port": "22,88",
"Protocol": "TCP"
}
],
"FirewallVersion": 1,
"RequestId": "31522fb9-fef8-4190-9080-deba504c36ae",
"TotalCount": 4
}
}
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
- Tencent Cloud SDK 3.0 for Java
- Tencent Cloud SDK 3.0 for PHP
- Tencent Cloud SDK 3.0 for Go
- Tencent Cloud SDK 3.0 for NodeJS
- Tencent Cloud SDK 3.0 for .NET
- Tencent Cloud SDK 3.0 for C++
- Tencent Cloud SDK 3.0 for Ruby
命令行工具
- Tencent Cloud CLI 3.0
6. 错误码
以下仅列出了接口业务逻辑相关的错误码,其他错误码详见 公共错误码。
错误码 | 描述 |
---|---|
InvalidParameterValue.InstanceIdMalformed | 参数值非法,实例 ID 格式非法。 |
InvalidParameterValue.Negative | 参数值非法,不能为负值。 |
InvalidParameterValue.OutOfRange | 参数值非法,不在合法范围内。 |
ResourceNotFound.FirewallNotFound | 防火墙不存在。 |
ResourceNotFound.InstanceIdNotFound | 实例 ID 不存在。 |