tccli 3.0.1288.1__py2.py3-none-any.whl → 3.0.1290.1__py2.py3-none-any.whl

tccli/services/tdmq/v20200217/examples.json

@@ -812,7 +812,7 @@
       {
         "document": "",
         "input": "POST / HTTP/1.1\nHost: tdmq.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: DescribeRocketMQTopUsages\n<公共请求参数>\n\n{\n    \"ClusterId\": \"rocketmq-abc\",\n    \"MetricName\": \"consumeLag\",\n    \"Limit\": 1\n}",
-        "output": "{\n    \"Response\": {\n        \"Dimensions\": [\n            {\n                \"Dimensions\": [\n                    {},\n                    {},\n                    {}\n                ]\n            },\n            {\n                \"Dimensions\": [\n                    {},\n                    {},\n                    {}\n                ]\n            }\n        ],\n        \"RequestId\": \"f0288e86-ee7d-4a73-a788-81ca6680b06c\",\n        \"Values\": [\n            309,\n            0\n        ]\n    }\n}",
+        "output": "{\n    \"Response\": {\n        \"Dimensions\": [\n            {\n                \"Dimensions\": [\n                    {\n                        \"Name\": \"tenant\",\n                        \"Value\": \"rocketmq-vvqb9emabapx\"\n                    },\n                    {\n                        \"Name\": \"namespace\",\n                        \"Value\": \"test_ns\"\n                    },\n                    {\n                        \"Name\": \"topic\",\n                        \"Value\": \"test_topic\"\n                    }\n                ]\n            },\n            {\n                \"Dimensions\": [\n                    {\n                        \"Name\": \"tenant\",\n                        \"Value\": \"rocketmq-vvqb9emabapx\"\n                    },\n                    {\n                        \"Name\": \"namespace\",\n                        \"Value\": \"test_ns\"\n                    },\n                    {\n                        \"Name\": \"topic\",\n                        \"Value\": \"test_topic2\"\n                    }\n                ]\n            }\n        ],\n        \"RequestId\": \"f0288e86-ee7d-4a73-a788-81ca6680b06c\",\n        \"Values\": [\n            309,\n            0\n        ]\n    }\n}",
         "title": "获取 Group 堆积数量排序"
       }
     ],

tccli/services/teo/v20220901/api.json

@@ -2625,6 +2625,23 @@
       ],
       "type": "object"
     },
+    "BlockIPActionParameters": {
+      "document": "Web安全IP封禁的附加参数",
+      "members": [
+        {
+          "disabled": false,
+          "document": "封禁 IP 的惩罚时长。支持的单位有：<li>s：秒，取值范围1～120；</li><li>m：分，取值范围1～120；</li><li>h：小时，取值范围1～48。</li>",
+          "example": "80s",
+          "member": "string",
+          "name": "Duration",
+          "output_required": true,
+          "required": true,
+          "type": "string",
+          "value_allowed_null": false
+        }
+      ],
+      "usage": "both"
+    },
     "BotConfig": {
       "document": "安全Bot配置",
       "members": [
@@ -6292,6 +6309,106 @@
       ],
       "usage": "both"
     },
+    "CustomRule": {
+      "document": "Web安全的自定义规则",
+      "members": [
+        {
+          "disabled": false,
+          "document": "自定义规则的名称。",
+          "example": "SampleBasicACLRule",
+          "member": "string",
+          "name": "Name",
+          "output_required": true,
+          "required": true,
+          "type": "string",
+          "value_allowed_null": false
+        },
+        {
+          "disabled": false,
+          "document": "自定义规则的具体内容，需符合表达式语法，详细规范参见产品文档。",
+          "example": "${http.request.ip} in ['1.1.1.1', '10.10.10.0/24', ${security.ip_group['123'@'zone-2xsnpvkhdjes']} ]",
+          "member": "string",
+          "name": "Condition",
+          "output_required": true,
+          "required": true,
+          "type": "string",
+          "value_allowed_null": false
+        },
+        {
+          "disabled": false,
+          "document": "自定义规则的执行动作。\tSecurityAction 的 Name 取值支持：<li>Deny：拦截；</li><li>Monitor：观察；</li><li>ReturnCustomPage：使用指定页面拦截；</li><li>Redirect：重定向至 URL；</li><li>BlockIP：IP 封禁；</li><li>JSChallenge：JavaScript 挑战；</li><li>ManagedChallenge：托管挑战；</li><li>Allow：放行。</li>",
+          "example": "参考SecurityAction结构",
+          "member": "SecurityAction",
+          "name": "Action",
+          "output_required": true,
+          "required": true,
+          "type": "object",
+          "value_allowed_null": false
+        },
+        {
+          "disabled": false,
+          "document": "自定义规则是否开启。取值有：<li>on：开启</li><li>off：关闭</li>",
+          "example": "on",
+          "member": "string",
+          "name": "Enabled",
+          "output_required": true,
+          "required": true,
+          "type": "string",
+          "value_allowed_null": false
+        },
+        {
+          "disabled": false,
+          "document": "自定义规则的 ID。<br>通过规则 ID 可支持不同的规则配置操作：<br> - 增加新规则：ID 为空或不指定 ID 参数；<br> - 修改已有规则：指定需要更新/修改的规则 ID；<br> - 删除已有规则：CustomRules 参数中，Rules 列表中未包含的已有规则将被删除。",
+          "example": "1492837231",
+          "member": "string",
+          "name": "Id",
+          "output_required": true,
+          "required": false,
+          "type": "string",
+          "value_allowed_null": false
+        },
+        {
+          "disabled": false,
+          "document": "自定义规则的类型。取值有：<li>BasicAccessRule：基础访问管控；</li><li>PreciseMatchRule：精准匹配规则，默认；</li><li>ManagedAccessRule：专家定制规则，仅出参。</li><br/>默认为PreciseMatchRule。",
+          "example": "PreciseMatchRule",
+          "member": "string",
+          "name": "RuleType",
+          "output_required": true,
+          "required": false,
+          "type": "string",
+          "value_allowed_null": false
+        },
+        {
+          "disabled": false,
+          "document": "自定义规则的优先级，范围是 0 ~ 100，默认为 0，仅支持精准匹配规则（PreciseMatchRule）。",
+          "example": "10",
+          "member": "int64",
+          "name": "Priority",
+          "output_required": true,
+          "required": false,
+          "type": "int",
+          "value_allowed_null": false
+        }
+      ],
+      "usage": "both"
+    },
+    "CustomRules": {
+      "document": "Web安全的自定义规则结构",
+      "members": [
+        {
+          "disabled": false,
+          "document": "自定义规则的定义列表。<br>使用 ModifySecurityPolicy 修改 Web 防护配置时: <br> -  若未指定 Rules 参数，或 Rules 参数长度为零：清空所有自定义规则配置。<br> - 若 SecurityPolicy 参数中，未指定 CustomRules 参数值：保持已有自定义规则配置，不做修改。",
+          "example": "参考 CustomRule 结构",
+          "member": "CustomRule",
+          "name": "Rules",
+          "output_required": false,
+          "required": false,
+          "type": "list",
+          "value_allowed_null": false
+        }
+      ],
+      "usage": "both"
+    },
     "CustomTime": {
       "document": "节点缓存 TTL 自定义缓存时间参数配置。",
       "members": [
@@ -14693,6 +14810,284 @@
       ],
       "usage": "both"
     },
+    "ManagedRuleAction": {
+      "document": "托管规则的项配置",
+      "members": [
+        {
+          "disabled": false,
+          "document": "托管规则组下的具体项，用于改写此单条规则项配置的内容，具体参考产品文档。\t",
+          "example": "4312344811",
+          "member": "string",
+          "name": "RuleId",
+          "output_required": true,
+          "required": true,
+          "type": "string",
+          "value_allowed_null": false
+        },
+        {
+          "disabled": false,
+          "document": "RuleId 中指定托管规则项的处置动作。 SecurityAction 的 Name 取值支持：<li>Deny：拦截，响应拦截页面；</li><li>Monitor：观察，不处理请求记录安全事件到日志中；</li><li>Disabled：未启用，不扫描请求跳过该规则。</li>",
+          "example": "参考 SecurityAction 结构",
+          "member": "SecurityAction",
+          "name": "Action",
+          "output_required": true,
+          "required": true,
+          "type": "object",
+          "value_allowed_null": false
+        }
+      ],
+      "usage": "both"
+    },
+    "ManagedRuleAutoUpdate": {
+      "document": "托管规则自动更新选项",
+      "members": [
+        {
+          "disabled": false,
+          "document": "是否开启自动更新至最新版本。取值有：<li>on：开启</li><li>off：关闭</li>",
+          "example": "on",
+          "member": "string",
+          "name": "AutoUpdateToLatestVersion",
+          "output_required": true,
+          "required": true,
+          "type": "string",
+          "value_allowed_null": false
+        },
+        {
+          "disabled": false,
+          "document": "当前使用的版本，格式符合ISO 8601标准，如2023-12-21T12:00:32Z，默认为空，仅出参。",
+          "example": "2023-12-21T12:00:32Z",
+          "member": "string",
+          "name": "RulesetVersion",
+          "output_required": false,
+          "required": false,
+          "type": "string",
+          "value_allowed_null": false
+        }
+      ],
+      "usage": "both"
+    },
+    "ManagedRuleDetail": {
+      "document": "托管规则详情",
+      "members": [
+        {
+          "disabled": false,
+          "document": "托管规则Id。",
+          "example": "4401213776",
+          "member": "string",
+          "name": "RuleId",
+          "output_required": true,
+          "required": false,
+          "type": "string",
+          "value_allowed_null": false
+        },
+        {
+          "disabled": false,
+          "document": "托管规则的防护级别。取值有：<li>low：低风险，此规则风险较低，适用于非常严格控制环境下的访问场景，该等级规则可能造成较多的误报；</li><li>medium：中风险，表示此条规则风险正常，适用较为严格的防护场景；</li><li>high：高风险，表示此条规则风险较高，大多数场景不会产生误报；</li><li>extreme：超高风险，表示此条规则风险极高，基本不会产生误报；</li>",
+          "example": "extreme",
+          "member": "string",
+          "name": "RiskLevel",
+          "output_required": true,
+          "required": false,
+          "type": "string",
+          "value_allowed_null": false
+        },
+        {
+          "disabled": false,
+          "document": "规则描述。",
+          "example": "针对嵌入式数据库中，使用 create_alias 进行代码执行的操作",
+          "member": "string",
+          "name": "Description",
+          "output_required": true,
+          "required": false,
+          "type": "string",
+          "value_allowed_null": false
+        },
+        {
+          "disabled": false,
+          "document": "规则标签。部分类型的规则不存在标签。",
+          "example": "[\"OWASP\"]",
+          "member": "string",
+          "name": "Tags",
+          "output_required": true,
+          "required": false,
+          "type": "list",
+          "value_allowed_null": false
+        },
+        {
+          "disabled": false,
+          "document": "规则所属版本。",
+          "example": "2023-12-21T12:00:32Z",
+          "member": "string",
+          "name": "RuleVersion",
+          "output_required": true,
+          "required": false,
+          "type": "string",
+          "value_allowed_null": false
+        }
+      ],
+      "usage": "both"
+    },
+    "ManagedRuleGroup": {
+      "document": "托管规则组配置。",
+      "members": [
+        {
+          "disabled": false,
+          "document": "托管规则的组名称，未指定配置的规则分组将按照默认配置处理，GroupId 的具体取值参考产品文档。",
+          "example": "wafmanagedrulegroup-file-upload-attacks",
+          "member": "string",
+          "name": "GroupId",
+          "output_required": true,
+          "required": true,
+          "type": "string",
+          "value_allowed_null": false
+        },
+        {
+          "disabled": false,
+          "document": "托管规则组的防护级别。取值有：<li>loose：宽松，只包含超高风险规则，此时需配置Action，且RuleActions配置无效；</li><li>normal：正常，包含超高风险和高风险规则，此时需配置Action，且RuleActions配置无效；</li><li>strict：严格，包含超高风险、高风险和中风险规则，此时需配置Action，且RuleActions配置无效；</li><li>extreme：超严格，包含超高风险、高风险、中风险和低风险规则，此时需配置Action，且RuleActions配置无效；</li><li>custom：自定义，精细化策略，按单条规则配置处置方式，此时Action字段无效，使用RuleActions配置单条规则的精细化策略。</li>\t",
+          "example": "loose",
+          "member": "string",
+          "name": "SensitivityLevel",
+          "output_required": true,
+          "required": true,
+          "type": "string",
+          "value_allowed_null": false
+        },
+        {
+          "disabled": false,
+          "document": "托管规则组的处置动作。SecurityAction 的 Name 取值支持：<li>Deny：拦截，响应拦截页面；</li><li>Monitor：观察，不处理请求记录安全事件到日志中；</li><li>Disabled：未启用，不扫描请求跳过该规则。</li>",
+          "example": "参考 SecurityAction 结构。",
+          "member": "SecurityAction",
+          "name": "Action",
+          "output_required": true,
+          "required": true,
+          "type": "object",
+          "value_allowed_null": false
+        },
+        {
+          "disabled": false,
+          "document": "托管规则组下规则项的具体配置，仅在 SensitivityLevel 为 custom 时配置生效。",
+          "example": "参考 ManagedRuleAction 结构。",
+          "member": "ManagedRuleAction",
+          "name": "RuleActions",
+          "output_required": false,
+          "required": false,
+          "type": "list",
+          "value_allowed_null": false
+        },
+        {
+          "disabled": false,
+          "document": "托管规则组信息，仅出参。\t",
+          "example": "参考 ManagedRuleGroupMeta 结构。",
+          "member": "ManagedRuleGroupMeta",
+          "name": "MetaData",
+          "output_required": true,
+          "required": false,
+          "type": "object",
+          "value_allowed_null": false
+        }
+      ],
+      "usage": "both"
+    },
+    "ManagedRuleGroupMeta": {
+      "document": "托管规则组信息",
+      "members": [
+        {
+          "disabled": false,
+          "document": "托管规则组描述，仅出参。",
+          "example": "SQL 注入攻击防护",
+          "member": "string",
+          "name": "GroupDetail",
+          "output_required": true,
+          "required": false,
+          "type": "string",
+          "value_allowed_null": false
+        },
+        {
+          "disabled": false,
+          "document": "托管规则组名称，仅出参。",
+          "example": "SQL 注入攻击防护",
+          "member": "string",
+          "name": "GroupName",
+          "output_required": true,
+          "required": false,
+          "type": "string",
+          "value_allowed_null": false
+        },
+        {
+          "disabled": false,
+          "document": "当前托管规则组下的所有子规则信息，仅出参。",
+          "example": "参考 ManagedRulesMeta 结构。",
+          "member": "ManagedRuleDetail",
+          "name": "RuleDetails",
+          "output_required": true,
+          "required": false,
+          "type": "list",
+          "value_allowed_null": false
+        }
+      ],
+      "usage": "both"
+    },
+    "ManagedRules": {
+      "document": "Web安全的托管规则",
+      "members": [
+        {
+          "disabled": false,
+          "document": "托管规则是否开启。取值有：<li>on：开启，所有托管规则按配置生效；</li><li>off：关闭，所有托管规则不生效。</li>",
+          "example": "on",
+          "member": "string",
+          "name": "Enabled",
+          "output_required": true,
+          "required": true,
+          "type": "string",
+          "value_allowed_null": false
+        },
+        {
+          "disabled": false,
+          "document": "评估模式是否开启，仅在 Enabled 参数为 on 时有效。取值有：<li>on：开启，表示所有托管规则以观察模式生效；</li><li>off：关闭，表示所有托管规则以实际配置生效。</li>",
+          "example": "on",
+          "member": "string",
+          "name": "DetectionOnly",
+          "output_required": true,
+          "required": true,
+          "type": "string",
+          "value_allowed_null": false
+        },
+        {
+          "disabled": false,
+          "document": "托管规则语义分析选项是否开启，仅在 Enabled 参数为 on 时有效。取值有：<li>on：开启，对请求进行语义分析后进行处理；</li><li>off：关闭，对请求不进行语义分析，直接进行处理。</li> <br/>默认为 off。",
+          "example": "on",
+          "member": "string",
+          "name": "SemanticAnalysis",
+          "output_required": true,
+          "required": false,
+          "type": "string",
+          "value_allowed_null": false
+        },
+        {
+          "disabled": false,
+          "document": "托管规则自动更新选项。",
+          "example": "参考 ManagedRulesAutoUpdate 结构",
+          "member": "ManagedRuleAutoUpdate",
+          "name": "AutoUpdate",
+          "output_required": true,
+          "required": false,
+          "type": "object",
+          "value_allowed_null": false
+        },
+        {
+          "disabled": false,
+          "document": "托管规则组的配置。如果此结构传空数组或 GroupId 未包含在列表内将按照默认方式处理。",
+          "example": "参考 ManagedRuleGroup 结构",
+          "member": "ManagedRuleGroup",
+          "name": "ManagedRuleGroups",
+          "output_required": true,
+          "required": false,
+          "type": "list",
+          "value_allowed_null": false
+        }
+      ],
+      "usage": "both"
+    },
     "MaxAge": {
       "document": "浏览器缓存规则配置，用于设置 MaxAge 默认值，默认为关闭状态",
       "members": [
@@ -16544,7 +16939,7 @@
       "members": [
         {
           "disabled": false,
-          "document": "站点Id。",
+          "document": "站点 ID。",
           "example": "zone-225qgrnvbi9w",
           "member": "string",
           "name": "ZoneId",
@@ -16553,7 +16948,7 @@
         },
         {
           "disabled": false,
-          "document": "安全配置。",
+          "document": "安全策略配置。<li>当 SecurityPolicy 参数中的 CustomRule 被设置时，SecurityConfig 参数中的 AclConfg、 IpTableConfg 将被忽略；</li><li>当 SecurityPolicy 参数中的 ManagedRule 被设置时，SecurityConfig 参数中的 WafConfig 将被忽略。</li><li>对于自定义规则以及托管规则策略配置建议使用 SecurityPolicy 参数进行设置。</li>",
           "example": "无",
           "member": "SecurityConfig",
           "name": "SecurityConfig",
@@ -16562,8 +16957,17 @@
         },
         {
           "disabled": false,
-          "document": "子域名/应用名。\n\n注意：当同时指定本参数和 TemplateId 参数时，本参数不生效。请勿同时指定本参数和 TemplateId 参数。",
-          "example": "a.test.com",
+          "document": "安全策略配置。对 Web 防护自定义策略和托管规则配置建议使用，支持表达式语法对安全策略进行配置。",
+          "example": "参考\tSecurityPolicy 结构",
+          "member": "SecurityPolicy",
+          "name": "SecurityPolicy",
+          "required": false,
+          "type": "object"
+        },
+        {
+          "disabled": false,
+          "document": "安全策略类型，可使用以下参数值： <li>ZoneDefaultPolicy：用于指定站点级策略；</li><li>Template：用于指定策略模板，需要同时指定 TemplateId 参数；</li><li>Host：用于指定域名级策略（注意：当使用域名来指定域名服务策略时，仅支持已经应用了域名级策略的域名服务或者策略模板）。</li>",
+          "example": "Host",
           "member": "string",
           "name": "Entity",
           "required": false,
@@ -16571,7 +16975,16 @@
         },
         {
           "disabled": false,
-          "document": "指定模板策略 ID，或指定站点全局策略。\n- 如需配置策略模板，请指定策略模板 ID。\n- 如需配置站点全局策略，请使用 @ZoneLevel@Domain 参数值\n\n注意：当使用本参数时，Entity 参数不生效。请勿同时使用本参数和 Entity 参数。",
+          "document": "指定域名。当 Entity 参数值为 Host 时，使用本参数指定的域名级策略，例如：使用 www.example.com ，配置该域名的域名级策略。",
+          "example": "www.example.com",
+          "member": "string",
+          "name": "Host",
+          "required": false,
+          "type": "string"
+        },
+        {
+          "disabled": false,
+          "document": "指定策略模板 ID。当 Entity 参数值为 Template 时，使用本参数指定策略模板的 ID。",
           "example": "temp-wj86oi2",
           "member": "string",
           "name": "TemplateId",
@@ -18798,6 +19211,23 @@
       ],
       "usage": "out"
     },
+    "RedirectActionParameters": {
+      "document": "Web安全重定向的附加参数",
+      "members": [
+        {
+          "disabled": false,
+          "document": "重定向的URL。",
+          "example": "https://www.tencent.com",
+          "member": "string",
+          "name": "URL",
+          "output_required": true,
+          "required": true,
+          "type": "string",
+          "value_allowed_null": false
+        }
+      ],
+      "usage": "both"
+    },
     "RenewFlag": {
       "document": "预付费套餐自动续费配置项。",
       "members": [
@@ -19043,6 +19473,34 @@
       ],
       "usage": "both"
     },
+    "ReturnCustomPageActionParameters": {
+      "document": "Web安全自定义页面的附加参数",
+      "members": [
+        {
+          "disabled": false,
+          "document": "响应状态码。",
+          "example": "404",
+          "member": "string",
+          "name": "ResponseCode",
+          "output_required": true,
+          "required": true,
+          "type": "string",
+          "value_allowed_null": false
+        },
+        {
+          "disabled": false,
+          "document": "响应的自定义页面ID。",
+          "example": "p-2yr7ncnju1yk",
+          "member": "string",
+          "name": "ErrorPageId",
+          "output_required": true,
+          "required": true,
+          "type": "string",
+          "value_allowed_null": false
+        }
+      ],
+      "usage": "both"
+    },
     "RewriteAction": {
       "document": "规则引擎HTTP请求头/响应头类型的动作",
       "members": [
@@ -20298,6 +20756,56 @@
       ],
       "usage": "out"
     },
+    "SecurityAction": {
+      "document": "安全的执行动作",
+      "members": [
+        {
+          "disabled": false,
+          "document": "安全执行的具体动作。取值有：\n<li>Deny：拦截；</li><li>Monitor：观察；</li><li>ReturnCustomPage：使用指定页面拦截；</li><li>Redirect：重定向至 URL；</li><li>BlockIP：IP 封禁；</li><li>JSChallenge：JavaScript 挑战；</li><li>ManagedChallenge：托管挑战；</li><li>Disabled：未启用；</li><li>Allow：放行。</li>",
+          "example": "Deny",
+          "member": "string",
+          "name": "Name",
+          "output_required": true,
+          "required": true,
+          "type": "string",
+          "value_allowed_null": false
+        },
+        {
+          "disabled": false,
+          "document": "当 Name 为 BlockIP 时的附加参数。",
+          "example": "参考 BlockIPActionParameters 结构",
+          "member": "BlockIPActionParameters",
+          "name": "BlockIPActionParameters",
+          "output_required": false,
+          "required": false,
+          "type": "object",
+          "value_allowed_null": false
+        },
+        {
+          "disabled": false,
+          "document": "当 Name 为 ReturnCustomPage 时的附加参数。",
+          "example": "参考 ReturnCustomPageActionParameters 结构",
+          "member": "ReturnCustomPageActionParameters",
+          "name": "ReturnCustomPageActionParameters",
+          "output_required": false,
+          "required": false,
+          "type": "object",
+          "value_allowed_null": false
+        },
+        {
+          "disabled": false,
+          "document": "当 Name 为 Redirect 时的附加参数。",
+          "example": "参考 RedirectActionParameters 结构",
+          "member": "RedirectActionParameters",
+          "name": "RedirectActionParameters",
+          "output_required": false,
+          "required": false,
+          "type": "object",
+          "value_allowed_null": false
+        }
+      ],
+      "usage": "both"
+    },
     "SecurityConfig": {
       "document": "Web安全配置",
       "members": [
@@ -20425,6 +20933,34 @@
       ],
       "usage": "both"
     },
+    "SecurityPolicy": {
+      "document": "安全策略配置",
+      "members": [
+        {
+          "disabled": false,
+          "document": "自定义规则配置。",
+          "example": "参考 CustomRules 示例",
+          "member": "CustomRules",
+          "name": "CustomRules",
+          "output_required": false,
+          "required": false,
+          "type": "object",
+          "value_allowed_null": false
+        },
+        {
+          "disabled": false,
+          "document": "托管规则配置。",
+          "example": "参考 ManagedRules 示例",
+          "member": "ManagedRules",
+          "name": "ManagedRules",
+          "output_required": false,
+          "required": false,
+          "type": "object",
+          "value_allowed_null": false
+        }
+      ],
+      "usage": "both"
+    },
     "SecurityTemplateBinding": {
       "document": "安全策略模板的绑定关系。",
       "members": [