云防火墙查询Nat防火墙Dnat规则-API 文档-文档中心-腾讯云

1. 接口描述

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

查询Nat防火墙Dnat规则

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

推荐使用 API Explorer

点击调试

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

2. 输入参数

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

参数名称	必选	类型	描述
Action	是	String	公共参数，本接口取值：DescribeNatFwDnatRule。
Version	是	String	公共参数，本接口取值：2019-09-04。
Region	否	String	公共参数，本接口不需要传递此参数。
Index	否	String	需要查询的索引，特定场景使用，可不填示例值：nat_rule
Filters.N	否	Array of CommonFilter	过滤条件组合示例值：[ { "Name": "FwInsId", "Values": [ "cfwnat-ef74fdaf" ], "OperatorType": 1 } ]
Limit	否	Integer	每页条数示例值：20
Offset	否	Integer	偏移值示例值：0
StartTime	否	String	检索的起始时间，可不传示例值：2024-11-01 11:24:31
EndTime	否	String	检索的截止时间，可不传示例值：2024-11-01 11:30:31
Order	否	String	desc：降序；asc：升序。根据By字段的值进行排序，这里传参的话则By也必须有值，可不传示例值：asc
By	否	String	排序所用到的字段，可不传示例值：update_time

3. 输出参数

参数名称	类型	描述
Data	Array of DescNatDnatRule	Dnat规则列表示例值：[ { "Description": "自动化勿删", "FwInsId": "cfwnat-ef74fdaf", "Id": 6176, "IpProtocol": "TCP", "IsReferenced": 0, "NatGwId": "", "PrivateIpAddress": "10.8.1.12", "PrivatePort": 8080, "PublicIpAddress": "124.223.94.81", "PublicPort": 8080 }]
Total	Integer	列表总数示例值：1
RequestId	String	唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 查询Nat防火墙Dnat规则示例

查询Nat防火墙Dnat规则示例

输入示例

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

{
    "Limit": 3,
    "Offset": 0
}

输出示例

{
    "Response": {
        "Data": [
            {
                "Description": "自动化勿删",
                "FwInsId": "cfwnat-ef74fdaf",
                "Id": 6176,
                "IpProtocol": "TCP",
                "IsReferenced": 0,
                "NatGwId": "nat-4eb013",
                "PrivateIpAddress": "10.8.1.12",
                "PrivatePort": 8080,
                "PublicIpAddress": "124.223.94.81",
                "PublicPort": 8080
            },
            {
                "Description": "自动化勿删",
                "FwInsId": "cfwnat-ef74fdaf",
                "Id": 6175,
                "IpProtocol": "TCP",
                "IsReferenced": 0,
                "NatGwId": "nat-4eb013",
                "PrivateIpAddress": "10.8.2.4",
                "PrivatePort": 80,
                "PublicIpAddress": "124.223.94.81",
                "PublicPort": 80
            },
            {
                "Description": "自定义描述",
                "FwInsId": "cfwnat-dce8698e",
                "Id": 6126,
                "IpProtocol": "UDP",
                "IsReferenced": 0,
                "NatGwId": "nat-4eb013",
                "PrivateIpAddress": "172.16.0.17",
                "PrivatePort": 65530,
                "PublicIpAddress": "43.138.154.20",
                "PublicPort": 65530
            }
        ],
        "RequestId": "d6ab3ac9-0902-48f3-8753-c0a48adcfc3f",
        "Total": 5
    }
}

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. 错误码

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

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