1. 接口描述
接口请求域名: cfw.tencentcloudapi.com 。
GetNatInstance 获取租户所有NAT实例及实例卡片信息
默认接口请求频率限制:20次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数。
参数名称 | 必选 | 类型 | 描述 |
---|---|---|---|
Action | 是 | String | 公共参数,本接口取值:DescribeNatFwInstancesInfo。 |
Version | 是 | String | 公共参数,本接口取值:2019-09-04。 |
Region | 否 | String | 公共参数,本接口不需要传递此参数。 |
Filter.N | 否 | Array of NatFwFilter | 获取实例列表过滤字段 示例值:[{"FilterType":"NatinsId","FilterContent":"cfwnat-65d0d823,cfwnat-65d0d824"}] |
Offset | 否 | Integer | 第几页 示例值:0 |
Limit | 否 | Integer | 每页长度 示例值:10 |
3. 输出参数
参数名称 | 类型 | 描述 |
---|---|---|
NatinsLst | Array of NatInstanceInfo | 实例卡片信息数组 示例值:[{"BandWidth":30,"EipAddress":["1.117.4.229","121.5.27.250"],"FwMode":0,"InFlowMax":4985,"NatinsId":"cfwnat-f3250045","NatinsName":"运维","OutFlowMax":14642,"Region":"ap-shanghai","RegionZh":"上海","Subnets":["subnet-cjxihpy1","subnet-1e34182d","subnet-5sx5vrcj","subnet-he9ba55f","subnet-0yd4fk0j","subnet-kdu0qj4t"],"VpcIp":["10.255.6.36","10.255.6.37","10.255.6.21","10.255.6.18","10.255.6.19","10.255.5.28","10.255.5.18","10.255.5.19"],"RegionDetail":"西南地区","ZoneZh":"重庆一区","ZoneZhBak":"重庆一区","Status":0,"RuleMax":20000,"RuleUsed":1000}] |
Total | Integer | nat 防火墙个数 示例值:1 |
RequestId | String | 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 GetNatInstance 获取租户所有NAT实例
输入示例
POST / HTTP/1.1
Host: cfw.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeNatFwInstancesInfo
<公共请求参数>
{
"Filter": [
{
"FilterType": "NatinsId",
"FilterContent": "cfwnat-65d0d823,cfwnat-65d0d824"
},
{
"FilterType": "NatinsName",
"FilterContent": "wytest"
},
{
"FilterType": "FwMode",
"FilterContent": "1"
},
{
"FilterType": "Region",
"FilterContent": "ap-guangzhou"
},
{
"FilterType": "EipAddress",
"FilterContent": "1.13.19.217,1.13.16.20"
},
{
"FilterType": "VpcIp",
"FilterContent": "10.255.0.20,10.255.0.5"
}
],
"Offset": 0,
"Limit": 10
}
输出示例
{
"Response": {
"NatinsLst": [
{
"BandWidth": 30,
"EipAddress": [
"1.117.4.229",
"121.5.27.250"
],
"FwMode": 0,
"InFlowMax": 4985,
"NatinsId": "cfwnat-f3250045",
"NatinsName": "运维",
"OutFlowMax": 14642,
"Region": "ap-shanghai",
"RegionZh": "上海",
"Subnets": [
"subnet-cjxihpy1",
"subnet-1e34182d",
"subnet-5sx5vrcj",
"subnet-he9ba55f",
"subnet-0yd4fk0j",
"subnet-kdu0qj4t"
],
"VpcIp": [
"10.255.6.36",
"10.255.6.37",
"10.255.6.21",
"10.255.6.18",
"10.255.6.19",
"10.255.5.28",
"10.255.5.18",
"10.255.5.19"
],
"RegionDetail": "西南地区",
"ZoneZh": "重庆一区",
"ZoneZhBak": "重庆一区",
"Status": 0,
"RuleMax": 20000,
"RuleUsed": 1000,
"EngineVersion": "cfw_3.7.0.888",
"UpdateEnable": 1,
"NeedProbeEngineUpdate": 1,
"TrafficMode": "Normal",
"ReserveTime": "2021-12-09 11:56:58",
"ReserveVersion": "cfw_3.7.1.889",
"ReserveVersionState": "stable",
"ElasticSwitch": 0,
"ElasticBandwidth": 0,
"IsFirstAfterPay": 0
}
],
"Total": 1,
"RequestId": "50e39f16-3b3a-4c66-b76e-1705449ba828"
}
}
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
命令行工具
6. 错误码
以下仅列出了接口业务逻辑相关的错误码,其他错误码详见 公共错误码。
错误码 | 描述 |
---|---|
AuthFailure | CAM签名/鉴权错误。 |
DryRunOperation | DryRun 操作,代表请求将会是成功的,只是多传了 DryRun 参数。 |
FailedOperation | 操作失败。 |
InternalError | 内部错误。 |
InvalidParameter | 参数错误。 |
InvalidParameterValue | 参数取值错误。 |
LimitExceeded | 超过配额限制。 |
MissingParameter | 缺少参数错误。 |
OperationDenied | 操作被拒绝。 |
RequestLimitExceeded | 请求的次数超过了频率限制。 |
ResourceInUse | 资源被占用。 |
ResourceInsufficient | 资源不足。 |
ResourceNotFound | 资源不存在。 |
ResourceUnavailable | 资源不可用。 |
ResourcesSoldOut | 资源售罄。 |
UnauthorizedOperation | 未授权操作。 |
UnknownParameter | 未知参数错误。 |
UnsupportedOperation | 操作不支持。 |