tccli 3.0.1407.1__py2.py3-none-any.whl → 3.1.6.1__py2.py3-none-any.whl

tccli/services/cfw/v20190904/api.json

@@ -378,6 +378,13 @@
       "output": "DescribeNatFwInstancesInfoResponse",
       "status": "online"
     },
+    "DescribeNatFwSwitch": {
+      "document": "查询NAT边界防火墙开关列表",
+      "input": "DescribeNatFwSwitchRequest",
+      "name": "查询NAT防火墙开关列表",
+      "output": "DescribeNatFwSwitchResponse",
+      "status": "online"
+    },
     "DescribeNatFwVpcDnsLst": {
       "document": "展示当前natfw 实例对应的vpc dns开关",
       "input": "DescribeNatFwVpcDnsLstRequest",
@@ -787,7 +794,7 @@
   },
   "metadata": {
     "apiVersion": "2019-09-04",
-    "api_brief": "防火墙开放API接口可实现自动化创建、修改、删除访问控制规则；查询、开启或关闭互联网边界防火墙开关等",
+    "api_brief": "## 概述\n腾讯云防火墙（Cloud Firewall，CFW）是一款基于公有云环境下的 SaaS 化防火墙，目前主要为用户提供互联网边界防护，并用于解决云上访问控制的统一管理与日志审计问题，具备传统防火墙功能的同时也支持云上多租户及弹性扩容，是用户业务上云的网络安全基础设施。\n本章节介绍的腾讯云防火墙 API 接口均为 API 3.0接口。\n您可以调用 API 对腾讯云防火墙进行操作，例如切换防火墙状态、管理入侵防御、管理访问控制等。\n腾讯云防火墙支持的所有接口信息，请参见 [API 概览](https://cloud.tencent.com/document/product/1132/49080)。\n\n## 术语表\n腾讯云防火墙 API 接口的常见术语请参见下表：\n\n| 术语 | 描述 | \n|---------|---------|\n| 标签 |  标签（TagInfo）用于资源分类管理的元数据结构，包含 TagKey（标签键）和 TagValue（标签值），通过键值对实现资产精细化分类与管理。| \n| 访问控制列表 | 访问控制列表（ACL）用于定义网络流量过滤规则的安全策略集合，支持基于五元组（源/目的IP、端口、协议）的精细化流量管控。 | \n\n## 使用限制\n对于 API 接口的参数限制，请参考各接口文档中的参数说明。\n\n## API 快速入门\n您可以使用 API Explorer 工具在线调用 API。\n本文以创建访问控制规则为例，通过 API Explorer 工具调用 API 接口的步骤如下：\n1. 进入 [API Explorer](https://console.cloud.tencent.com/api/explorer) 工具页面。更多 API Explorer 工具使用信息，请参见 [使用 API Explorer](https://cloud.tencent.com/document/product/1278/46697)。\n2. 调用 [CreateAcRules](https://cloud.tencent.com/document/product/1132/49070) 接口，创建访问控制规则。\n3. 创建访问控制规则后即可在控制台页面查看到创建好的访问控制规则，可以对访问控制规则进行配置，具体操作方式请参见[文档](https://cloud.tencent.com/document/product/1132/107444)。",
     "serviceNameCN": "云防火墙",
     "serviceShortName": "cfw"
   },
@@ -2011,6 +2018,68 @@
       ],
       "usage": "in"
     },
+    "CommonIdName": {
+      "document": "ID NAME 组合",
+      "members": [
+        {
+          "disabled": false,
+          "document": "资源ID\n注意：此字段可能返回 null，表示取不到有效值。",
+          "example": "hello",
+          "member": "string",
+          "name": "Id",
+          "output_required": false,
+          "type": "string",
+          "value_allowed_null": true
+        },
+        {
+          "disabled": false,
+          "document": "资源名字\n注意：此字段可能返回 null，表示取不到有效值。",
+          "example": "world",
+          "member": "string",
+          "name": "Name",
+          "output_required": false,
+          "type": "string",
+          "value_allowed_null": true
+        }
+      ],
+      "usage": "out"
+    },
+    "CommonIdNameStatus": {
+      "document": "ID NAME STATUS 组合结构",
+      "members": [
+        {
+          "disabled": false,
+          "document": "资源id\n注意：此字段可能返回 null，表示取不到有效值。",
+          "example": "hello",
+          "member": "string",
+          "name": "Id",
+          "output_required": false,
+          "type": "string",
+          "value_allowed_null": true
+        },
+        {
+          "disabled": false,
+          "document": "资源name\n注意：此字段可能返回 null，表示取不到有效值。",
+          "example": "world",
+          "member": "string",
+          "name": "Name",
+          "output_required": false,
+          "type": "string",
+          "value_allowed_null": true
+        },
+        {
+          "disabled": false,
+          "document": "状态\n注意：此字段可能返回 null，表示取不到有效值。",
+          "example": "1",
+          "member": "int64",
+          "name": "Status",
+          "output_required": false,
+          "type": "int",
+          "value_allowed_null": true
+        }
+      ],
+      "usage": "out"
+    },
     "CreateAcRulesRequest": {
       "document": "CreateAcRules请求参数结构体",
       "members": [
@@ -6481,7 +6550,7 @@
         },
         {
           "disabled": false,
-          "document": "每页条数，最大支持2000",
+          "document": "每页条数，最大支持1000",
           "example": "10",
           "member": "int64",
           "name": "Limit",
@@ -6995,6 +7064,149 @@
       ],
       "type": "object"
     },
+    "DescribeNatFwSwitchRequest": {
+      "document": "DescribeNatFwSwitch请求参数结构体",
+      "members": [
+        {
+          "disabled": false,
+          "document": "偏移量，分页用",
+          "example": "0",
+          "member": "int64",
+          "name": "Offset",
+          "required": true,
+          "type": "int"
+        },
+        {
+          "disabled": false,
+          "document": "条数，分页用",
+          "example": "10",
+          "member": "int64",
+          "name": "Limit",
+          "required": true,
+          "type": "int"
+        },
+        {
+          "disabled": false,
+          "document": "过滤条件组合",
+          "example": "无",
+          "member": "CommonFilter",
+          "name": "Filters",
+          "required": false,
+          "type": "list"
+        },
+        {
+          "disabled": false,
+          "document": "desc：降序；asc：升序。根据By字段的值进行排序，这里传参的话则By也必须有值",
+          "example": "desc",
+          "member": "string",
+          "name": "Order",
+          "required": false,
+          "type": "string"
+        },
+        {
+          "disabled": false,
+          "document": "排序所用到的字段",
+          "example": "id",
+          "member": "string",
+          "name": "By",
+          "required": false,
+          "type": "string"
+        }
+      ],
+      "type": "object"
+    },
+    "DescribeNatFwSwitchResponse": {
+      "document": "DescribeNatFwSwitch返回参数结构体",
+      "members": [
+        {
+          "disabled": false,
+          "document": "总数\n注意：此字段可能返回 null，表示取不到有效值。",
+          "example": "100",
+          "member": "int64",
+          "name": "Total",
+          "output_required": false,
+          "type": "int",
+          "value_allowed_null": true
+        },
+        {
+          "disabled": false,
+          "document": "NAT边界防火墙开关列表数据\n注意：此字段可能返回 null，表示取不到有效值。",
+          "example": "无",
+          "member": "NatSwitchListData",
+          "name": "Data",
+          "output_required": false,
+          "type": "list",
+          "value_allowed_null": true
+        },
+        {
+          "disabled": false,
+          "document": "开关相关VPC列表\n注意：此字段可能返回 null，表示取不到有效值。",
+          "example": "无",
+          "member": "CommonIdName",
+          "name": "VpcList",
+          "output_required": false,
+          "type": "list",
+          "value_allowed_null": true
+        },
+        {
+          "disabled": false,
+          "document": "开关相关NAT列表\n注意：此字段可能返回 null，表示取不到有效值。",
+          "example": "无",
+          "member": "CommonIdName",
+          "name": "NatList",
+          "output_required": false,
+          "type": "list",
+          "value_allowed_null": true
+        },
+        {
+          "disabled": false,
+          "document": "开关相关ROUTE列表\n注意：此字段可能返回 null，表示取不到有效值。",
+          "example": "无",
+          "member": "CommonIdName",
+          "name": "RouteList",
+          "output_required": false,
+          "type": "list",
+          "value_allowed_null": true
+        },
+        {
+          "disabled": false,
+          "document": "开启开关个数\n注意：此字段可能返回 null，表示取不到有效值。",
+          "example": "1",
+          "member": "int64",
+          "name": "OnNum",
+          "output_required": false,
+          "type": "int",
+          "value_allowed_null": true
+        },
+        {
+          "disabled": false,
+          "document": "关闭开关个数\n注意：此字段可能返回 null，表示取不到有效值。",
+          "example": "2",
+          "member": "int64",
+          "name": "OffNum",
+          "output_required": false,
+          "type": "int",
+          "value_allowed_null": true
+        },
+        {
+          "disabled": false,
+          "document": "失败开关状态\n注意：此字段可能返回 null，表示取不到有效值。",
+          "example": "无",
+          "member": "CommonIdNameStatus",
+          "name": "FailData",
+          "output_required": false,
+          "type": "list",
+          "value_allowed_null": true
+        },
+        {
+          "document": "唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。",
+          "member": "string",
+          "name": "RequestId",
+          "type": "string"
+        }
+      ],
+      "type": "object"
+    },
     "DescribeNatFwVpcDnsLstRequest": {
       "document": "DescribeNatFwVpcDnsLst请求参数结构体",
       "members": [
@@ -12038,6 +12250,212 @@
       ],
       "usage": "out"
     },
+    "NatSwitchListData": {
+      "document": "NAT防火墙开关列表数据",
+      "members": [
+        {
+          "disabled": false,
+          "document": "列表ID",
+          "example": "1",
+          "member": "uint64",
+          "name": "Id",
+          "output_required": true,
+          "type": "int",
+          "value_allowed_null": false
+        },
+        {
+          "disabled": false,
+          "document": "子网ID\n注意：此字段可能返回 null，表示取不到有效值。",
+          "example": "subnet-k9t82usg",
+          "member": "string",
+          "name": "SubnetId",
+          "output_required": true,
+          "type": "string",
+          "value_allowed_null": true
+        },
+        {
+          "disabled": false,
+          "document": "子网名称\n注意：此字段可能返回 null，表示取不到有效值。",
+          "example": "add2",
+          "member": "string",
+          "name": "SubnetName",
+          "output_required": true,
+          "type": "string",
+          "value_allowed_null": true
+        },
+        {
+          "disabled": false,
+          "document": "IPv4 CIDR\n注意：此字段可能返回 null，表示取不到有效值。",
+          "example": "172.30.64.0/20",
+          "member": "string",
+          "name": "SubnetCidr",
+          "output_required": true,
+          "type": "string",
+          "value_allowed_null": true
+        },
+        {
+          "disabled": false,
+          "document": "关联路由ID\n注意：此字段可能返回 null，表示取不到有效值。",
+          "example": "rtb-rfm44194",
+          "member": "string",
+          "name": "RouteId",
+          "output_required": true,
+          "type": "string",
+          "value_allowed_null": true
+        },
+        {
+          "disabled": false,
+          "document": "关联路由名称\n注意：此字段可能返回 null，表示取不到有效值。",
+          "example": "route_ruri",
+          "member": "string",
+          "name": "RouteName",
+          "output_required": true,
+          "type": "string",
+          "value_allowed_null": true
+        },
+        {
+          "disabled": false,
+          "document": "云服务器个数\n注意：此字段可能返回 null，表示取不到有效值。",
+          "example": "1",
+          "member": "uint64",
+          "name": "CvmNum",
+          "output_required": true,
+          "type": "int",
+          "value_allowed_null": true
+        },
+        {
+          "disabled": false,
+          "document": "所属VPC ID\n注意：此字段可能返回 null，表示取不到有效值。",
+          "example": "vpc-5oofojsr",
+          "member": "string",
+          "name": "VpcId",
+          "output_required": true,
+          "type": "string",
+          "value_allowed_null": true
+        },
+        {
+          "disabled": false,
+          "document": "所属VPC名称\n注意：此字段可能返回 null，表示取不到有效值。",
+          "example": "Default-VPC",
+          "member": "string",
+          "name": "VpcName",
+          "output_required": true,
+          "type": "string",
+          "value_allowed_null": true
+        },
+        {
+          "disabled": false,
+          "document": "是否生效\n注意：此字段可能返回 null，表示取不到有效值。",
+          "example": "1",
+          "member": "uint64",
+          "name": "Enable",
+          "output_required": true,
+          "type": "int",
+          "value_allowed_null": true
+        },
+        {
+          "disabled": false,
+          "document": "开关状态\n注意：此字段可能返回 null，表示取不到有效值。",
+          "example": "0",
+          "member": "uint64",
+          "name": "Status",
+          "output_required": true,
+          "type": "int",
+          "value_allowed_null": true
+        },
+        {
+          "disabled": false,
+          "document": "NAT网关ID\n注意：此字段可能返回 null，表示取不到有效值。",
+          "example": "nat-pfkjetae",
+          "member": "string",
+          "name": "NatId",
+          "output_required": true,
+          "type": "string",
+          "value_allowed_null": true
+        },
+        {
+          "disabled": false,
+          "document": "NAT网关名称\n注意：此字段可能返回 null，表示取不到有效值。",
+          "example": "second",
+          "member": "string",
+          "name": "NatName",
+          "output_required": true,
+          "type": "string",
+          "value_allowed_null": true
+        },
+        {
+          "disabled": false,
+          "document": "NAT防火墙实例ID\n注意：此字段可能返回 null，表示取不到有效值。",
+          "example": "nat-f3kjufpn",
+          "member": "string",
+          "name": "NatInsId",
+          "output_required": false,
+          "type": "string",
+          "value_allowed_null": true
+        },
+        {
+          "disabled": false,
+          "document": "NAT防火墙实例名称\n注意：此字段可能返回 null，表示取不到有效值。",
+          "example": "NAT防火墙",
+          "member": "string",
+          "name": "NatInsName",
+          "output_required": false,
+          "type": "string",
+          "value_allowed_null": true
+        },
+        {
+          "disabled": false,
+          "document": "地域\n注意：此字段可能返回 null，表示取不到有效值。",
+          "example": "ap-guangzhou",
+          "member": "string",
+          "name": "Region",
+          "output_required": false,
+          "type": "string",
+          "value_allowed_null": true
+        },
+        {
+          "disabled": false,
+          "document": "开关是否异常,0:正常,1:异常\n注意：此字段可能返回 null，表示取不到有效值。",
+          "example": "0",
+          "member": "int64",
+          "name": "Abnormal",
+          "output_required": false,
+          "type": "int",
+          "value_allowed_null": true
+        },
+        {
+          "disabled": false,
+          "document": "nat防火墙出口路由表id\n注意：此字段可能返回 null，表示取不到有效值。",
+          "example": "rtb-bjvuftia",
+          "member": "string",
+          "name": "ORTableId",
+          "output_required": false,
+          "type": "string",
+          "value_allowed_null": true
+        },
+        {
+          "disabled": false,
+          "document": "nat防火墙出口路由表名称\n注意：此字段可能返回 null，表示取不到有效值。",
+          "example": "出口路由",
+          "member": "string",
+          "name": "ORTableName",
+          "output_required": false,
+          "type": "string",
+          "value_allowed_null": true
+        },
+        {
+          "disabled": false,
+          "document": "出口Snat Ip列表\n注意：此字段可能返回 null，表示取不到有效值。",
+          "example": "[\"1.1.1.1\"]",
+          "member": "string",
+          "name": "Ohavips",
+          "output_required": false,
+          "type": "list",
+          "value_allowed_null": true
+        }
+      ],
+      "usage": "out"
+    },
     "NetInstancesInfo": {
       "document": "网络实例信息",
       "members": [

tccli/services/cfw/v20190904/examples.json

@@ -468,6 +468,14 @@
         "title": "GetNatInstance 获取租户所有NAT实例"
       }
     ],
+    "DescribeNatFwSwitch": [
+      {
+        "document": "查询NAT开关列表",
+        "input": "POST / HTTP/1.1\nHost: cfw.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: DescribeNatFwSwitch\n<公共请求参数>\n\n{\n    \"Offset\": 0,\n    \"Limit\": 10\n}",
+        "output": "{\n    \"Response\": {\n        \"Data\": [\n            {\n                \"Abnormal\": 0,\n                \"CvmNum\": 1,\n                \"Enable\": 1,\n                \"Id\": 33781,\n                \"NatId\": \"\",\n                \"NatInsId\": \"cfwnat-84d3440f\",\n                \"NatInsName\": \"[autotest][勿删]自动化测试\",\n                \"NatName\": \"\",\n                \"Region\": \"ap-shanghai\",\n                \"RouteId\": \"rtb-f5wqfibn\",\n                \"RouteName\": \"default_copy_for_cfw\",\n                \"Status\": 0,\n                \"SubnetCidr\": \"10.8.2.0/24\",\n                \"SubnetId\": \"subnet-j9cyo89p\",\n                \"SubnetName\": \"[autotest][勿删]自动化测试C2\",\n                \"VpcId\": \"vpc-d0t6wgo2\",\n                \"VpcName\": \"[autotest][勿删]自动化测试C\"\n            },\n            {\n                \"Abnormal\": 0,\n                \"CvmNum\": 0,\n                \"Enable\": 1,\n                \"Id\": 34636,\n                \"NatId\": \"\",\n                \"NatInsId\": \"cfwnat-84d3440f\",\n                \"NatInsName\": \"[autotest][勿删]自动化测试\",\n                \"NatName\": \"\",\n                \"Region\": \"ap-shanghai\",\n                \"RouteId\": \"rtb-l28qa73d\",\n                \"RouteName\": \"default\",\n                \"Status\": 0,\n                \"SubnetCidr\": \"10.8.0.32/29\",\n                \"SubnetId\": \"subnet-rsun76k7\",\n                \"SubnetName\": \"防火墙专用子网_请勿删改\",\n                \"VpcId\": \"vpc-d0t6wgo2\",\n                \"VpcName\": \"[autotest][勿删]自动化测试C\"\n            },\n            {\n                \"Abnormal\": 0,\n                \"CvmNum\": 0,\n                \"Enable\": 1,\n                \"Id\": 33779,\n                \"NatId\": \"\",\n                \"NatInsId\": \"cfwnat-84d3440f\",\n                \"NatInsName\": \"[autotest][勿删]自动化测试\",\n                \"NatName\": \"\",\n                \"Region\": \"ap-shanghai\",\n                \"RouteId\": \"rtb-l28qa73d\",\n                \"RouteName\": \"default\",\n                \"Status\": 0,\n                \"SubnetCidr\": \"10.8.3.0/24\",\n                \"SubnetId\": \"subnet-nem8hqnp\",\n                \"SubnetName\": \"MYSQL\",\n                \"VpcId\": \"vpc-d0t6wgo2\",\n                \"VpcName\": \"[autotest][勿删]自动化测试C\"\n            },\n            {\n                \"Abnormal\": 0,\n                \"CvmNum\": 1,\n                \"Enable\": 1,\n                \"Id\": 33780,\n                \"NatId\": \"\",\n                \"NatInsId\": \"cfwnat-84d3440f\",\n                \"NatInsName\": \"[autotest][勿删]自动化测试\",\n                \"NatName\": \"\",\n                \"Region\": \"ap-shanghai\",\n                \"RouteId\": \"rtb-l28qa73d\",\n                \"RouteName\": \"default\",\n                \"Status\": 0,\n                \"SubnetCidr\": \"10.8.1.0/24\",\n                \"SubnetId\": \"subnet-jy2eionr\",\n                \"SubnetName\": \"[autotest][勿删]自动化测试C1\",\n                \"VpcId\": \"vpc-d0t6wgo2\",\n                \"VpcName\": \"[autotest][勿删]自动化测试C\"\n            },\n            {\n                \"Abnormal\": 0,\n                \"CvmNum\": 0,\n                \"Enable\": 0,\n                \"Id\": 34637,\n                \"NatId\": \"\",\n                \"NatInsId\": \"cfwnat-7e170f6b\",\n                \"NatInsName\": \"test\",\n                \"NatName\": \"\",\n                \"Region\": \"ap-beijing\",\n                \"RouteId\": \"rtb-o18lgl2l\",\n                \"RouteName\": \"default\",\n                \"Status\": 0,\n                \"SubnetCidr\": \"10.0.0.0/24\",\n                \"SubnetId\": \"subnet-s1c8r185\",\n                \"SubnetName\": \"nat防火墙临时测试\",\n                \"VpcId\": \"vpc-0iz7ii4s\",\n                \"VpcName\": \"nat防火墙临时测试\"\n            },\n            {\n                \"Abnormal\": 0,\n                \"CvmNum\": 0,\n                \"Enable\": 1,\n                \"Id\": 34629,\n                \"NatId\": \"nat-de74cic7\",\n                \"NatInsId\": \"cfwnat-01debc37\",\n                \"NatInsName\": \"111\",\n                \"NatName\": \"test1\",\n                \"Region\": \"ap-shanghai\",\n                \"RouteId\": \"rtb-pslbu0gx\",\n                \"RouteName\": \"default\",\n                \"Status\": 0,\n                \"SubnetCidr\": \"172.20.0.0/24\",\n                \"SubnetId\": \"subnet-8jm78x87\",\n                \"SubnetName\": \"subnet1\",\n                \"VpcId\": \"vpc-fmprtmz2\",\n                \"VpcName\": \"dora1\"\n            },\n            {\n                \"Abnormal\": 0,\n                \"CvmNum\": 0,\n                \"Enable\": 0,\n                \"Id\": 34633,\n                \"NatId\": \"nat-56jjs6mo\",\n                \"NatInsId\": \"cfwnat-49f38b8b\",\n                \"NatInsName\": \"测试接入\",\n                \"NatName\": \"gltest\",\n                \"Region\": \"ap-guangzhou\",\n                \"RouteId\": \"rtb-pwcv5gaw\",\n                \"RouteName\": \"default\",\n                \"Status\": 0,\n                \"SubnetCidr\": \"10.10.0.0/24\",\n                \"SubnetId\": \"subnet-7z6dhany\",\n                \"SubnetName\": \"fengqqiansub\",\n                \"VpcId\": \"vpc-0nduhuff\",\n                \"VpcName\": \"fengqqian-串行\"\n            }\n        ],\n        \"FailData\": [],\n        \"NatList\": [\n            {\n                \"Id\": \"nat-56jjs6mo\",\n                \"Name\": \"gltest\"\n            },\n            {\n                \"Id\": \"nat-de74cic7\",\n                \"Name\": \"test1\"\n            }\n        ],\n        \"OffNum\": 2,\n        \"OnNum\": 5,\n        \"RequestId\": \"2c74b129-10ea-434a-8e02-b125b9c3236b\",\n        \"RouteList\": [\n            {\n                \"Id\": \"rtb-f5wqfibn\",\n                \"Name\": \"default_copy_for_cfw\"\n            },\n            {\n                \"Id\": \"rtb-l28qa73d\",\n                \"Name\": \"default\"\n            },\n            {\n                \"Id\": \"rtb-o18lgl2l\",\n                \"Name\": \"default\"\n            },\n            {\n                \"Id\": \"rtb-pslbu0gx\",\n                \"Name\": \"default\"\n            },\n            {\n                \"Id\": \"rtb-pwcv5gaw\",\n                \"Name\": \"default\"\n            }\n        ],\n        \"Total\": 7,\n        \"VpcList\": [\n            {\n                \"Id\": \"vpc-0iz7ii4s\",\n                \"Name\": \"nat防火墙临时测试\"\n            },\n            {\n                \"Id\": \"vpc-0nduhuff\",\n                \"Name\": \"fengqqian-串行\"\n            },\n            {\n                \"Id\": \"vpc-d0t6wgo2\",\n                \"Name\": \"[autotest][勿删]自动化测试C\"\n            },\n            {\n                \"Id\": \"vpc-fmprtmz2\",\n                \"Name\": \"dora1\"\n            }\n        ]\n    }\n}",
+        "title": "查询NAT开关列表"
+      }
+    ],
     "DescribeNatFwVpcDnsLst": [
       {
         "document": "",