tccli 3.0.1048.1__py2.py3-none-any.whl → 3.0.1049.1__py2.py3-none-any.whl

tccli/services/antiddos/v20200309/api.json

@@ -259,6 +259,13 @@
       "output": "DeleteWaterPrintKeyResponse",
       "status": "online"
     },
+    "DescribeBGPIPL7Rules": {
+      "document": "高防IP获取7层规则",
+      "input": "DescribeBGPIPL7RulesRequest",
+      "name": "高防IP获取7层转发规则",
+      "output": "DescribeBGPIPL7RulesResponse",
+      "status": "online"
+    },
     "DescribeBasicDeviceStatus": {
       "document": "获取基础防护攻击状态",
       "input": "DescribeBasicDeviceStatusRequest",
@@ -1316,6 +1323,309 @@
       ],
       "usage": "out"
     },
+    "BGPIPL7RuleEntry": {
+      "document": "L7规则",
+      "members": [
+        {
+          "disabled": false,
+          "document": "转发协议，取值[http, https]",
+          "example": "无",
+          "member": "string",
+          "name": "Protocol",
+          "output_required": true,
+          "required": true,
+          "type": "string",
+          "value_allowed_null": false
+        },
+        {
+          "disabled": false,
+          "document": "转发域名",
+          "example": "无",
+          "member": "string",
+          "name": "Domain",
+          "output_required": true,
+          "required": true,
+          "type": "string",
+          "value_allowed_null": false
+        },
+        {
+          "disabled": false,
+          "document": "负载均衡方式，取值[1(加权轮询)]",
+          "example": "无",
+          "member": "uint64",
+          "name": "LbType",
+          "output_required": true,
+          "required": true,
+          "type": "int",
+          "value_allowed_null": false
+        },
+        {
+          "disabled": false,
+          "document": "会话保持开关，取值[0(会话保持关闭)，1(会话保持开启)]",
+          "example": "无",
+          "member": "uint64",
+          "name": "KeepEnable",
+          "output_required": true,
+          "required": true,
+          "type": "int",
+          "value_allowed_null": false
+        },
+        {
+          "disabled": false,
+          "document": "会话保持时间，单位秒",
+          "example": "无",
+          "member": "uint64",
+          "name": "KeepTime",
+          "output_required": true,
+          "required": true,
+          "type": "int",
+          "value_allowed_null": false
+        },
+        {
+          "disabled": false,
+          "document": "回源方式，取值[1(域名回源)，2(IP回源)]",
+          "example": "无",
+          "member": "uint64",
+          "name": "SourceType",
+          "output_required": true,
+          "required": true,
+          "type": "int",
+          "value_allowed_null": false
+        },
+        {
+          "disabled": false,
+          "document": "回源列表",
+          "example": "无",
+          "member": "L4RuleSource",
+          "name": "SourceList",
+          "output_required": true,
+          "required": true,
+          "type": "list",
+          "value_allowed_null": false
+        },
+        {
+          "disabled": false,
+          "document": "区域码",
+          "example": "无",
+          "member": "uint64",
+          "name": "Region",
+          "output_required": true,
+          "required": false,
+          "type": "int",
+          "value_allowed_null": false
+        },
+        {
+          "disabled": false,
+          "document": "资源Id",
+          "example": "无",
+          "member": "string",
+          "name": "Id",
+          "output_required": true,
+          "required": false,
+          "type": "string",
+          "value_allowed_null": false
+        },
+        {
+          "disabled": false,
+          "document": "资源Ip",
+          "example": "无",
+          "member": "string",
+          "name": "Ip",
+          "output_required": true,
+          "required": false,
+          "type": "string",
+          "value_allowed_null": false
+        },
+        {
+          "disabled": false,
+          "document": "规则ID，当添加新规则时可以不用填写此字段；当修改或者删除规则时需要填写此字段；",
+          "example": "无",
+          "member": "string",
+          "name": "RuleId",
+          "output_required": true,
+          "required": false,
+          "type": "string",
+          "value_allowed_null": false
+        },
+        {
+          "disabled": false,
+          "document": "规则描述",
+          "example": "无",
+          "member": "string",
+          "name": "RuleName",
+          "output_required": true,
+          "required": false,
+          "type": "string",
+          "value_allowed_null": false
+        },
+        {
+          "disabled": false,
+          "document": "证书来源，当转发协议为https时必须填，取值[2(腾讯云托管证书)]，当转发协议为http时也可以填0",
+          "example": "无",
+          "member": "uint64",
+          "name": "CertType",
+          "output_required": true,
+          "required": false,
+          "type": "int",
+          "value_allowed_null": false
+        },
+        {
+          "disabled": false,
+          "document": "当证书来源为腾讯云托管证书时，此字段必须填写托管证书ID",
+          "example": "无",
+          "member": "string",
+          "name": "SSLId",
+          "output_required": true,
+          "required": false,
+          "type": "string",
+          "value_allowed_null": false
+        },
+        {
+          "disabled": false,
+          "document": "当证书来源为自有证书时，此字段必须填写证书内容；(因已不再支持自有证书，此字段已弃用，请不用填写此字段)",
+          "example": "无",
+          "member": "string",
+          "name": "Cert",
+          "output_required": true,
+          "required": false,
+          "type": "string",
+          "value_allowed_null": false
+        },
+        {
+          "disabled": false,
+          "document": "当证书来源为自有证书时，此字段必须填写证书密钥；(因已不再支持自有证书，此字段已弃用，请不用填写此字段)",
+          "example": "无",
+          "member": "string",
+          "name": "PrivateKey",
+          "output_required": true,
+          "required": false,
+          "type": "string",
+          "value_allowed_null": false
+        },
+        {
+          "disabled": false,
+          "document": "规则状态，取值[0(规则配置成功)，1(规则配置生效中)，2(规则配置失败)，3(规则删除生效中)，5(规则删除失败)，6(规则等待配置)，7(规则等待删除)，8(规则待配置证书)]",
+          "example": "无",
+          "member": "uint64",
+          "name": "Status",
+          "output_required": true,
+          "required": false,
+          "type": "int",
+          "value_allowed_null": false
+        },
+        {
+          "disabled": false,
+          "document": "cc防护状态，取值[0(关闭), 1(开启)]",
+          "example": "无",
+          "member": "uint64",
+          "name": "CCStatus",
+          "output_required": true,
+          "required": false,
+          "type": "int",
+          "value_allowed_null": false
+        },
+        {
+          "disabled": false,
+          "document": "HTTPS协议的CC防护状态，取值[0(关闭), 1(开启)]",
+          "example": "无",
+          "member": "uint64",
+          "name": "CCEnable",
+          "output_required": true,
+          "required": false,
+          "type": "int",
+          "value_allowed_null": false
+        },
+        {
+          "disabled": false,
+          "document": "HTTPS协议的CC防护阈值（已废弃）",
+          "example": "无",
+          "member": "int64",
+          "name": "CCThreshold",
+          "output_required": true,
+          "required": false,
+          "type": "int",
+          "value_allowed_null": false
+        },
+        {
+          "disabled": false,
+          "document": "HTTPS协议的CC防护等级",
+          "example": "无",
+          "member": "string",
+          "name": "CCLevel",
+          "output_required": true,
+          "required": false,
+          "type": "string",
+          "value_allowed_null": false
+        },
+        {
+          "disabled": false,
+          "document": "修改时间",
+          "example": "无",
+          "member": "datetime",
+          "name": "ModifyTime",
+          "output_required": true,
+          "required": false,
+          "type": "string",
+          "value_allowed_null": false
+        },
+        {
+          "disabled": false,
+          "document": "是否开启Https协议使用Http回源，取值[0(关闭), 1(开启)]，不填写默认是关闭",
+          "example": "无",
+          "member": "uint64",
+          "name": "HttpsToHttpEnable",
+          "output_required": true,
+          "required": false,
+          "type": "int",
+          "value_allowed_null": false
+        },
+        {
+          "disabled": false,
+          "document": "接入端口值\n注意：此字段可能返回 null，表示取不到有效值。",
+          "example": "无",
+          "member": "uint64",
+          "name": "VirtualPort",
+          "output_required": true,
+          "required": false,
+          "type": "int",
+          "value_allowed_null": true
+        },
+        {
+          "disabled": false,
+          "document": "http强制跳转https，1表示打开，0表示关闭",
+          "example": "无",
+          "member": "uint64",
+          "name": "RewriteHttps",
+          "output_required": true,
+          "required": false,
+          "type": "int",
+          "value_allowed_null": false
+        },
+        {
+          "disabled": false,
+          "document": "规则配置失败时的详细错误原因(仅当Status=2时有效)，1001证书不存在，1002证书获取失败，1003证书上传失败，1004证书已过期",
+          "example": "无",
+          "member": "uint64",
+          "name": "ErrCode",
+          "output_required": true,
+          "required": false,
+          "type": "int",
+          "value_allowed_null": false
+        },
+        {
+          "disabled": false,
+          "document": "版本\n注意：此字段可能返回 null，表示取不到有效值。",
+          "example": "2",
+          "member": "uint64",
+          "name": "Version",
+          "output_required": true,
+          "required": false,
+          "type": "int",
+          "value_allowed_null": true
+        }
+      ],
+      "usage": "both"
+    },
     "BGPInstance": {
       "document": "高防包资产实例信息",
       "members": [
@@ -4430,6 +4740,135 @@
       ],
       "type": "object"
     },
+    "DescribeBGPIPL7RulesRequest": {
+      "document": "DescribeBGPIPL7Rules请求参数结构体",
+      "members": [
+        {
+          "disabled": false,
+          "document": "DDoS防护子产品代号（bgpip表示高防IP）",
+          "example": "bgpip",
+          "member": "string",
+          "name": "Business",
+          "required": true,
+          "type": "string"
+        },
+        {
+          "disabled": false,
+          "document": "状态搜索，选填，取值[0(规则配置成功)，1(规则配置生效中)，2(规则配置失败)，3(规则删除生效中)，5(规则删除失败)，6(规则等待配置)，7(规则等待删除)，8(规则待配置证书)]",
+          "example": "无",
+          "member": "uint64",
+          "name": "StatusList",
+          "required": false,
+          "type": "list"
+        },
+        {
+          "disabled": false,
+          "document": "域名搜索，选填，当需要搜索域名请填写",
+          "example": "无",
+          "member": "string",
+          "name": "Domain",
+          "required": false,
+          "type": "string"
+        },
+        {
+          "disabled": false,
+          "document": "IP搜索，选填，当需要搜索IP请填写",
+          "example": "1.1.1.1",
+          "member": "string",
+          "name": "Ip",
+          "required": false,
+          "type": "string"
+        },
+        {
+          "disabled": false,
+          "document": "一页条数，默认值100，最大值100，超过100最大返回100条",
+          "example": "无",
+          "member": "uint64",
+          "name": "Limit",
+          "required": false,
+          "type": "int"
+        },
+        {
+          "disabled": false,
+          "document": "规则偏移量，取值为(页码-1)*一页条数",
+          "example": "无",
+          "member": "uint64",
+          "name": "Offset",
+          "required": false,
+          "type": "int"
+        },
+        {
+          "disabled": false,
+          "document": "转发协议搜索，选填，取值[http, https, http/https]",
+          "example": "无",
+          "member": "string",
+          "name": "ProtocolList",
+          "required": false,
+          "type": "list"
+        },
+        {
+          "disabled": false,
+          "document": "高防IP实例的Cname",
+          "example": "abcdefg",
+          "member": "string",
+          "name": "Cname",
+          "required": false,
+          "type": "string"
+        },
+        {
+          "disabled": false,
+          "document": "默认为false，当为true时，将不对各个规则做策略检查，直接导出所有规则",
+          "example": "无",
+          "member": "bool",
+          "name": "Export",
+          "required": false,
+          "type": "bool"
+        }
+      ],
+      "type": "object"
+    },
+    "DescribeBGPIPL7RulesResponse": {
+      "document": "DescribeBGPIPL7Rules返回参数结构体",
+      "members": [
+        {
+          "disabled": false,
+          "document": "转发规则列表",
+          "example": "无",
+          "member": "BGPIPL7RuleEntry",
+          "name": "Rules",
+          "output_required": true,
+          "type": "list",
+          "value_allowed_null": false
+        },
+        {
+          "disabled": false,
+          "document": "健康检查配置列表",
+          "example": "无",
+          "member": "L7RuleHealth",
+          "name": "Healths",
+          "output_required": true,
+          "type": "list",
+          "value_allowed_null": false
+        },
+        {
+          "disabled": false,
+          "document": "总规则数",
+          "example": "1",
+          "member": "uint64",
+          "name": "Total",
+          "output_required": true,
+          "type": "int",
+          "value_allowed_null": false
+        },
+        {
+          "document": "唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。",
+          "member": "string",
+          "name": "RequestId",
+          "type": "string"
+        }
+      ],
+      "type": "object"
+    },
     "DescribeBasicDeviceStatusRequest": {
       "document": "DescribeBasicDeviceStatus请求参数结构体",
       "members": [

tccli/services/antiddos/v20200309/examples.json

@@ -296,6 +296,14 @@
         "title": "删除DDoS防护的水印防护密钥"
       }
     ],
+    "DescribeBGPIPL7Rules": [
+      {
+        "document": "",
+        "input": "POST / HTTP/1.1\nHost: antiddos.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: DescribeBGPIPL7Rules\n<公共请求参数>\n\n{\n    \"StatusList\": [\n        1\n    ],\n    \"Domain\": \"abc\",\n    \"Business\": \"abc\",\n    \"Ip\": \"abc\",\n    \"Limit\": 1,\n    \"Offset\": 1,\n    \"ProtocolList\": [\n        \"abc\"\n    ],\n    \"Cname\": \"abc\",\n    \"Export\": true\n}",
+        "output": "{\n    \"Response\": {\n        \"Rules\": [\n            {\n                \"Region\": 1,\n                \"Id\": \"abc\",\n                \"Ip\": \"abc\",\n                \"RuleId\": \"abc\",\n                \"RuleName\": \"abc\",\n                \"Protocol\": \"abc\",\n                \"Domain\": \"abc\",\n                \"LbType\": 1,\n                \"KeepEnable\": 1,\n                \"KeepTime\": 1,\n                \"SourceType\": 1,\n                \"CertType\": 1,\n                \"SSLId\": \"abc\",\n                \"Cert\": \"abc\",\n                \"PrivateKey\": \"abc\",\n                \"SourceList\": [\n                    {\n                        \"Source\": \"abc\",\n                        \"Weight\": 1,\n                        \"Port\": 1,\n                        \"Backup\": 1\n                    }\n                ],\n                \"Status\": 1,\n                \"CCStatus\": 1,\n                \"CCEnable\": 1,\n                \"CCThreshold\": 1,\n                \"CCLevel\": \"abc\",\n                \"ModifyTime\": \"2020-09-22 00:00:00\",\n                \"HttpsToHttpEnable\": 1,\n                \"VirtualPort\": 1,\n                \"RewriteHttps\": 1,\n                \"ErrCode\": 1,\n                \"Version\": 1\n            }\n        ],\n        \"Healths\": [\n            {\n                \"Status\": 1,\n                \"Enable\": 1,\n                \"RuleId\": \"abc\",\n                \"Url\": \"abc\",\n                \"Interval\": 1,\n                \"AliveNum\": 1,\n                \"KickNum\": 1,\n                \"Method\": \"abc\",\n                \"StatusCode\": 1,\n                \"ProtocolFlag\": 1,\n                \"PassiveEnable\": 1,\n                \"BlockInter\": 1,\n                \"FailedCountInter\": 1,\n                \"FailedThreshold\": 1,\n                \"PassiveStatusCode\": 1,\n                \"PassiveStatus\": 1\n            }\n        ],\n        \"Total\": 1,\n        \"RequestId\": \"abc\"\n    }\n}",
+        "title": "请求示例"
+      }
+    ],
     "DescribeBasicDeviceStatus": [
       {
         "document": "无",

tccli/services/cfg/v20210820/api.json

@@ -1854,6 +1854,7 @@
           "example": "1",
           "member": "int64",
           "name": "TaskGroupInstanceId",
+          "output_required": true,
           "required": true,
           "type": "int",
           "value_allowed_null": false
@@ -1864,6 +1865,7 @@
           "example": "ins_d1fr3",
           "member": "string",
           "name": "TaskGroupInstanceObjectId",
+          "output_required": true,
           "required": true,
           "type": "string",
           "value_allowed_null": true
@@ -1874,26 +1876,18 @@
           "example": "1",
           "member": "int64",
           "name": "TaskGroupInstanceStatus",
+          "output_required": true,
           "required": true,
           "type": "int",
           "value_allowed_null": false
         },
-        {
-          "disabled": false,
-          "document": "实例动作执行日志\n注意：此字段可能返回 null，表示取不到有效值。",
-          "example": "{}",
-          "member": "string",
-          "name": "TaskGroupInstanceExecuteLog",
-          "required": true,
-          "type": "string",
-          "value_allowed_null": true
-        },
         {
           "disabled": false,
           "document": "实例创建时间",
           "example": "\"2021-08-17 20:05:04\"",
           "member": "string",
           "name": "TaskGroupInstanceCreateTime",
+          "output_required": true,
           "required": true,
           "type": "string",
           "value_allowed_null": false
@@ -1904,6 +1898,7 @@
           "example": "\"2021-08-17 20:05:04\"",
           "member": "string",
           "name": "TaskGroupInstanceUpdateTime",
+          "output_required": true,
           "required": true,
           "type": "string",
           "value_allowed_null": false
@@ -1914,6 +1909,7 @@
           "example": "1",
           "member": "int64",
           "name": "TaskGroupInstanceStatusType",
+          "output_required": true,
           "required": true,
           "type": "int",
           "value_allowed_null": false
@@ -1924,6 +1920,7 @@
           "example": "\"2021-08-17 20:05:04\"",
           "member": "string",
           "name": "TaskGroupInstanceStartTime",
+          "output_required": true,
           "required": true,
           "type": "string",
           "value_allowed_null": true
@@ -1934,16 +1931,29 @@
           "example": "\"2021-08-17 20:05:04\"",
           "member": "string",
           "name": "TaskGroupInstanceEndTime",
+          "output_required": true,
           "required": true,
           "type": "string",
           "value_allowed_null": true
         },
+        {
+          "disabled": true,
+          "document": "实例动作执行日志\n注意：此字段可能返回 null，表示取不到有效值。",
+          "example": "{}",
+          "member": "string",
+          "name": "TaskGroupInstanceExecuteLog",
+          "output_required": true,
+          "required": false,
+          "type": "string",
+          "value_allowed_null": true
+        },
         {
           "disabled": false,
           "document": "实例是否可重试\n注意：此字段可能返回 null，表示取不到有效值。",
           "example": "true",
           "member": "bool",
           "name": "TaskGroupInstanceIsRedo",
+          "output_required": true,
           "required": false,
           "type": "bool",
           "value_allowed_null": true
@@ -1954,6 +1964,7 @@
           "example": "10",
           "member": "int64",
           "name": "TaskGroupInstanceExecuteTime",
+          "output_required": true,
           "required": false,
           "type": "int",
           "value_allowed_null": true

tccli/services/ckafka/v20190819/api.json

@@ -7535,7 +7535,7 @@
         {
           "disabled": false,
           "document": "实例ID",
-          "example": "",
+          "example": "ckafka-i18j8cn1",
           "member": "string",
           "name": "InstanceId",
           "required": true,
@@ -7544,7 +7544,7 @@
         {
           "disabled": false,
           "document": "搜索关键字",
-          "example": "",
+          "example": "group",
           "member": "string",
           "name": "SearchWord",
           "required": false,
@@ -7553,7 +7553,7 @@
         {
           "disabled": false,
           "document": "偏移量",
-          "example": "",
+          "example": "0",
           "member": "int64",
           "name": "Offset",
           "required": false,
@@ -7562,7 +7562,7 @@
         {
           "disabled": false,
           "document": "最大返回数量",
-          "example": "",
+          "example": "20",
           "member": "int64",
           "name": "Limit",
           "required": false,
@@ -7577,9 +7577,10 @@
         {
           "disabled": false,
           "document": "返回结果集列表",
-          "example": "",
+          "example": "无",
           "member": "GroupResponse",
           "name": "Result",
+          "output_required": true,
           "type": "object",
           "value_allowed_null": false
         },

tccli/services/ckafka/v20190819/examples.json

@@ -422,7 +422,7 @@
       {
         "document": "",
         "input": "https://ckafka.tencentcloudapi.com/?Action=DescribeGroup\r\n&InstanceId=xxxx\r\n&<公共请求参数>",
-        "output": "{\n    \"Response\": {\n        \"Result\": {\n            \"TotalCount\": 1,\n            \"GroupList\": [\n                {\n                    \"Group\": \"qcloud_tocos\",\n                    \"Protocol\": \"consumer\"\n                }\n            ]\n        },\n        \"RequestId\": \"c931f394-7d72-4ad4-8d70-5a225708c762\"\n    }\n}",
+        "output": "{\n    \"Response\": {\n        \"Result\": {\n            \"TotalCount\": 0,\n            \"GroupList\": [\n                {\n                    \"Group\": \"abc\",\n                    \"Protocol\": \"abc\"\n                }\n            ],\n            \"GroupCountQuota\": 1\n        },\n        \"RequestId\": \"abc\"\n    }\n}",
         "title": "枚举消费分组"
       }
     ],