查询NAT访问控制列表

最近更新时间:2024-11-04 13:32:44

我的收藏

1. 接口描述

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

查询NAT访问控制列表

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

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

2. 输入参数

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

参数名称 必选 类型 描述
Action String 公共参数,本接口取值:DescribeNatAcRule。
Version String 公共参数,本接口取值:2019-09-04。
Region String 公共参数,本接口不需要传递此参数。
Limit Integer 每页条数
示例值:20
Offset Integer 偏移值
示例值:0
Index String 需要查询的索引,特定场景使用,可不填
示例值:vpc_rule
Filters.N Array of CommonFilter 过滤条件组合,Direction 为0时表述查询出向规则,为1时表示查询入向规则
示例值:[ { "Name": "Direction", "Values": [ "0" ], "OperatorType": 1 } ]
StartTime String 检索的起始时间,可不传
示例值:2022-07-27 16:00:00
EndTime String 检索的截止时间,可不传
示例值:2022-07-27 16:00:00
Order String desc:降序;asc:升序。根据By字段的值进行排序,这里传参的话则By也必须有值,默认为asc
示例值:asc
By String 排序所用到的字段,默认为sequence
示例值:sequence

3. 输出参数

参数名称 类型 描述
Total Integer 总条数
示例值:1
Data Array of DescAcItem nat访问控制列表数据
示例值:[ { "Uuid": 238778, "InternalUuid": 1726341068438565, "OrderIndex": 19, "SourceContent": "ins-gt3h3i8f", "SourceType": "instance", "TargetContent": "mb_1300448058_1702866694255", "TargetType": "template", "Port": "-1/-1", "Protocol": "ANY", "Scope": "ap-guangzhou", "ScopeDesc": "广州地域", "Direction": 0, "RuleAction": "log", "Description": "autotest_nat_add", "Count": 0, "LastHitTime": "", "Enable": "true", "Invalid": 0, "CountryCode": 0, "CityCode": 0, "CountryName": "", "CityName": "", "IsRegion": 0, "CloudCode": "", "IsCloud": 0, "InstanceName": "", "Status": 0, "BetaList": [], "ParamTemplateId": "pp-336ad325", "ParamTemplateName": "andy", "DnsParseCnt": 0, "TargetName": "", "SourceName": "prosrc" } ]
AllTotal Integer 未过滤的总条数
示例值:10
RequestId String 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 查询NAT访问控制列表实例1

查询NAT访问控制出向规则列表,其中Filters中 Direction 为0时表示查询出向规则列表,为1时表示查询入向规则列表

输入示例

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

{
    "Filters": [
        {
            "Name": "Direction",
            "Values": [
                "0"
            ],
            "OperatorType": 1
        }
    ],
    "Limit": 20,
    "Offset": 0
}

输出示例

{
    "Response": {
        "Total": 1,
        "Data": [
            {
                "Uuid": 238778,
                "InternalUuid": 1726341068438565,
                "OrderIndex": 19,
                "SourceContent": "ins-gt3h3i8f",
                "SourceType": "instance",
                "TargetContent": "mb_1300448058_1702866694255",
                "TargetType": "template",
                "Port": "-1/-1",
                "Protocol": "ANY",
                "Scope": "ap-guangzhou",
                "ScopeDesc": "广州地域",
                "Direction": 0,
                "RuleAction": "log",
                "Description": "autotest_nat_add",
                "Count": 0,
                "LastHitTime": "2024-11-03 03:14:44",
                "Enable": "true",
                "Invalid": 0,
                "CountryCode": 0,
                "CityCode": 0,
                "CountryName": "中国",
                "CityName": "广东省",
                "IsRegion": 0,
                "CloudCode": "0",
                "IsCloud": 0,
                "InstanceName": "proIns",
                "Status": 0,
                "BetaList": [],
                "ParamTemplateId": "pp-336ad325",
                "ParamTemplateName": "andy",
                "TargetName": "prodst",
                "SourceName": "prosrc"
            }
        ],
        "AllTotal": 1,
        "RequestId": "efa6461b-9410-4cd8-9168-73f37d6ed532"
    }
}

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 未授权操作。