tccli 3.0.947.1__py2.py3-none-any.whl → 3.0.949.1__py2.py3-none-any.whl

tccli/examples/waf/v20180125/DescribeSession.md

@@ -0,0 +1,51 @@
+**Example 1: Waf 会话定义查询接口**
+
+
+
+Input: 
+
+```
+tccli waf DescribeSession --cli-unfold-argument  \
+    --Domain test.com \
+    --Edition clb-waf
+```
+
+Output: 
+```
+{
+    "Res": [
+        {
+            "Category": "match",
+            "EndMat": "&",
+            "EndOffset": "-1",
+            "KeyOrStartMat": "hashId",
+            "Source": "get",
+            "StartOffset": "-1",
+            "TsVersion": "1578366436093"
+        }
+    ]
+}
+```
+
+**Example 2: 没有设置Seesion的场景**
+
+
+
+Input: 
+
+```
+tccli waf DescribeSession --cli-unfold-argument  \
+    --Domain test.com \
+    --Edition clb-waf
+```
+
+Output: 
+```
+{
+    "Response": {
+        "Data": null,
+        "RequestId": "e08991ed-f8f8-4a6e-b8be-74f1a34eab5f"
+    }
+}
+```
+

tccli/examples/waf/v20180125/ModifyAntiFakeUrl.md

@@ -0,0 +1,24 @@
+**Example 1: 编辑防篡改url**
+
+
+
+Input: 
+
+```
+tccli waf ModifyAntiFakeUrl --cli-unfold-argument  \
+    --Domain www.test.com \
+    --Name test \
+    --Uri http://zanyang.qcloudwaf.com/index.html \
+    --Id 123
+```
+
+Output: 
+```
+{
+    "Response": {
+        "RequestId": "32e5e790-5999-4aa6-a3cb-34ed4c570d14",
+        "Result": "success"
+    }
+}
+```
+

tccli/examples/waf/v20180125/ModifyAntiFakeUrlStatus.md

@@ -0,0 +1,22 @@
+**Example 1: 切换防篡改开关**
+
+
+
+Input: 
+
+```
+tccli waf ModifyAntiFakeUrlStatus --cli-unfold-argument  \
+    --Domain test.com \
+    --Status 0 \
+    --Ids 123 345
+```
+
+Output: 
+```
+{
+    "Response": {
+        "RequestId": "c68bdee7-2c14-4bd3-ba41-cdf1421c0d0c"
+    }
+}
+```
+

tccli/examples/waf/v20180125/ModifyAntiInfoLeakRuleStatus.md

@@ -0,0 +1,22 @@
+**Example 1: 信息防泄漏切换规则开关**
+
+
+
+Input: 
+
+```
+tccli waf ModifyAntiInfoLeakRuleStatus --cli-unfold-argument  \
+    --Domain www.test.com \
+    --RuleId 123 \
+    --Status 1
+```
+
+Output: 
+```
+{
+    "Response": {
+        "RequestId": "800f0a0c-6f8b-409a-af67-ccd12354e8f4"
+    }
+}
+```
+

tccli/examples/waf/v20180125/ModifyAntiInfoLeakRules.md

@@ -0,0 +1,26 @@
+**Example 1: 编辑信息防泄漏规则**
+
+编辑信息防泄漏规则
+
+Input: 
+
+```
+tccli waf ModifyAntiInfoLeakRules --cli-unfold-argument  \
+    --RuleId 167 \
+    --Name test1 \
+    --Domain www.test1.com \
+    --ActionType 0 \
+    --Strategies.0.Field information \
+    --Strategies.0.CompareFunc contains \
+    --Strategies.0.Content phone
+```
+
+Output: 
+```
+{
+    "Response": {
+        "RequestId": "640e40da-d57a-4402-8e3d-39c5bed8addd"
+    }
+}
+```
+

tccli/examples/waf/v20180125/ModifyCustomWhiteRuleStatus.md

@@ -0,0 +1,26 @@
+**Example 1: 切换精准白名单规则的开关**
+
+
+
+Input: 
+
+```
+tccli waf ModifyCustomWhiteRuleStatus --cli-unfold-argument  \
+    --RuleId 1100000001 \
+    --Domain waf.tencentcloudapi.com \
+    --Status 1
+```
+
+Output: 
+```
+{
+    "Response": {
+        "RequestId": "5d207f4f-0d41-4f5d-bce2-0320090c98d8",
+        "Success": {
+            "Message": "Success",
+            "Code": "Success"
+        }
+    }
+}
+```
+

tccli/examples/waf/v20180125/UpsertCCRule.md

@@ -0,0 +1,95 @@
+**Example 1: Waf  CC V2 Upsert接口**
+
+
+
+Input: 
+
+```
+tccli waf UpsertCCRule --cli-unfold-argument  \
+    --Status 0 \
+    --Advance 0 \
+    --Domain test.com \
+    --Name test2 \
+    --Url /test \
+    --Priority 50 \
+    --Interval 60 \
+    --MatchFunc 0 \
+    --ValidTime 600
+ \
+    --Limit 60 \
+    --ActionType 22 \
+    --OptionsArr [{"key":"get","args":["a=12"]}]
+```
+
+Output: 
+```
+{
+    "Response": {
+        "Data": null,
+        "RequestId": "5029e2b0-493c-4dcc-9e4e-d53ab98ede99"
+    }
+}
+```
+
+**Example 2: test**
+
+
+
+Input: 
+
+```
+tccli waf UpsertCCRule --cli-unfold-argument  \
+    --Status 0 \
+    --MatchFunc 0 \
+    --Domain hzh.qcloud.com \
+    --Name ddp \
+    --Advance 0 \
+    --ValidTime 61 \
+    --Interval 10 \
+    --Priority 1 \
+    --Url /test \
+    --Limit 10 \
+    --ActionType 20
+```
+
+Output: 
+```
+{
+    "Response": {
+        "RequestId": "2ca5c6bb-05b7-4183-bbf2-3c7059544317",
+        "Data": ""
+    }
+}
+```
+
+**Example 3: test1**
+
+
+
+Input: 
+
+```
+tccli waf UpsertCCRule --cli-unfold-argument  \
+    --Status 0 \
+    --MatchFunc 0 \
+    --Domain hzh.qcloud.com \
+    --Name ddp \
+    --Advance 0 \
+    --ValidTime 61 \
+    --Interval 10 \
+    --Priority 1 \
+    --Url /test \
+    --Limit 10 \
+    --ActionType 20
+```
+
+Output: 
+```
+{
+    "Response": {
+        "RequestId": "2ca5c6bb-05b7-4183-bbf2-3c7059544317",
+        "Data": ""
+    }
+}
+```
+

tccli/examples/waf/v20180125/UpsertSession.md

@@ -0,0 +1,25 @@
+**Example 1: Waf  会话定义 Upsert接口**
+
+
+
+Input: 
+
+```
+tccli waf UpsertSession --cli-unfold-argument  \
+    --Domain test.com \
+    --Category match \
+    --KeyOrStartMat hashId \
+    --EndMat 12 \
+    --Source get \
+    --StartOffset -1 \
+    --EndOffset -1 \
+    --Edition clb-waf
+```
+
+Output: 
+```
+{
+    "Data": null
+}
+```
+

tccli/services/apigateway/v20180808/api.json

@@ -4187,7 +4187,7 @@
         },
         {
           "disabled": false,
-          "document": "vpc属性",
+          "document": "vpc属性，选择VPC后不可修改，为服务选择VPC后，可对接该VPC下的后端资源",
           "example": "vpc-quyenan",
           "member": "string",
           "name": "UniqVpcId",
@@ -4294,7 +4294,7 @@
       "members": [
         {
           "disabled": false,
-          "document": "后端协议，取值范围：HTTP, HTTPS",
+          "document": "后端协议，取值范围：HTTP, HTTPS,gRPC，gRPCs",
           "example": "HTTP",
           "member": "string",
           "name": "Scheme",
@@ -4412,6 +4412,7 @@
           "example": "upstream-0c96l2bo",
           "member": "string",
           "name": "UpstreamId",
+          "output_required": true,
           "type": "string",
           "value_allowed_null": true
         },
@@ -7725,6 +7726,16 @@
           "type": "string",
           "value_allowed_null": true
         },
+        {
+          "disabled": false,
+          "document": "vpc属性，存量可能为空字符串\n注意：此字段可能返回 null，表示取不到有效值。",
+          "example": "vpc-syandask",
+          "member": "string",
+          "name": "UniqVpcId",
+          "output_required": true,
+          "type": "string",
+          "value_allowed_null": true
+        },
         {
           "document": "唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。",
           "member": "string",
@@ -10639,6 +10650,15 @@
           "name": "NetTypes",
           "required": false,
           "type": "list"
+        },
+        {
+          "disabled": false,
+          "document": "vpc属性，选择VPC后不可修改。为服务选择VPC后，可对接该VPC下的后端资源",
+          "example": "vpc-adsada",
+          "member": "string",
+          "name": "UniqVpcId",
+          "required": false,
+          "type": "string"
         }
       ],
       "type": "object"

tccli/services/apigateway/v20180808/examples.json

@@ -432,7 +432,7 @@
       {
         "document": "无",
         "input": "POST / HTTP/1.1\nHost: apigateway.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: DescribeService\n<公共请求参数>\n\n{\n    \"ServiceId\": \"service-rypiqi13\"\n}",
-        "output": "{\n    \"Response\": {\n        \"ServiceDesc\": \"sesrxx\",\n        \"CreatedTime\": \"2020-09-22T00:00:00+00:00\",\n        \"SetId\": 1,\n        \"InnerHttpsPort\": 0,\n        \"InnerHttpPort\": 0,\n        \"Tags\": [\n            {\n                \"Value\": \"test\",\n                \"Key\": \"test\"\n            }\n        ],\n        \"NetTypes\": [\n            \"OUTER\"\n        ],\n        \"IpVersion\": \"\",\n        \"UserType\": \"\",\n        \"UsagePlanList\": [\n            {\n                \"MaxRequestNumPreSec\": 0,\n                \"UsagePlanId\": \"\",\n                \"ModifiedTime\": \"2020-09-22T00:00:00+00:00\",\n                \"UsagePlanDesc\": \"test\",\n                \"Environment\": \"test\",\n                \"CreatedTime\": \"2020-09-22T00:00:00+00:00\",\n                \"UsagePlanName\": \"sdfafxx\"\n            }\n        ],\n        \"OuterSubDomain\": \"domain.com\",\n        \"UsagePlanTotalCount\": 0,\n        \"SetType\": \"\",\n        \"ApiIdStatusSet\": [\n            {\n                \"AuthType\": \"\",\n                \"Protocol\": \"\",\n                \"UniqVpcId\": \"\",\n                \"ModifiedTime\": \"2020-09-22T00:00:00+00:00\",\n                \"OauthConfig\": {\n                    \"PublicKey\": \"\",\n                    \"LoginRedirectUrl\": \"\",\n                    \"TokenLocation\": \"\"\n                },\n                \"ApiId\": \"\",\n                \"AuthRelationApiId\": \"\",\n                \"ApiDesc\": \"\",\n                \"ApiType\": \"\",\n                \"ApiBusinessType\": \"\",\n                \"ServiceId\": \"\",\n                \"ApiName\": \"\",\n                \"Path\": \"\",\n                \"CreatedTime\": \"2020-09-22T00:00:00+00:00\",\n                \"RelationBuniessApiIds\": [\n                    \"\"\n                ],\n                \"IsDebugAfterCharge\": false,\n                \"Method\": \"\",\n                \"TokenLocation\": \"\"\n            }\n        ],\n        \"ServiceName\": \"\",\n        \"RequestId\": \"\",\n        \"InstanceName\": \"\",\n        \"Protocol\": \"\",\n        \"ApiTotalCount\": 1,\n        \"ModifiedTime\": \"2020-09-22T00:00:00+00:00\",\n        \"DeploymentType\": \"DEFAULT\",\n        \"SpecialUse\": \"DEFAULT\",\n        \"InstanceId\": \"\",\n        \"AvailableEnvironments\": [\n            \"release\"\n        ],\n        \"ServiceId\": \"\",\n        \"InternalSubDomain\": \"\"\n    }\n}",
+        "output": "{\n    \"Response\": {\n        \"ServiceDesc\": \"sesrxx\",\n        \"CreatedTime\": \"2020-09-22T00:00:00+00:00\",\n        \"SetId\": 1,\n        \"InnerHttpsPort\": 0,\n        \"InnerHttpPort\": 0,\n        \"UniqVpcId\": \"vpc-abc\",\n        \"Tags\": [\n            {\n                \"Value\": \"test\",\n                \"Key\": \"test\"\n            }\n        ],\n        \"NetTypes\": [\n            \"OUTER\"\n        ],\n        \"IpVersion\": \"\",\n        \"UserType\": \"\",\n        \"UsagePlanList\": [\n            {\n                \"MaxRequestNumPreSec\": 0,\n                \"UsagePlanId\": \"\",\n                \"ModifiedTime\": \"2020-09-22T00:00:00+00:00\",\n                \"UsagePlanDesc\": \"test\",\n                \"Environment\": \"test\",\n                \"CreatedTime\": \"2020-09-22T00:00:00+00:00\",\n                \"UsagePlanName\": \"sdfafxx\"\n            }\n        ],\n        \"OuterSubDomain\": \"domain.com\",\n        \"UsagePlanTotalCount\": 0,\n        \"SetType\": \"\",\n        \"ApiIdStatusSet\": [\n            {\n                \"AuthType\": \"\",\n                \"Protocol\": \"\",\n                \"UniqVpcId\": \"\",\n                \"ModifiedTime\": \"2020-09-22T00:00:00+00:00\",\n                \"OauthConfig\": {\n                    \"PublicKey\": \"\",\n                    \"LoginRedirectUrl\": \"\",\n                    \"TokenLocation\": \"\"\n                },\n                \"ApiId\": \"\",\n                \"AuthRelationApiId\": \"\",\n                \"ApiDesc\": \"\",\n                \"ApiType\": \"\",\n                \"ApiBusinessType\": \"\",\n                \"ServiceId\": \"\",\n                \"ApiName\": \"\",\n                \"Path\": \"\",\n                \"CreatedTime\": \"2020-09-22T00:00:00+00:00\",\n                \"RelationBuniessApiIds\": [\n                    \"\"\n                ],\n                \"IsDebugAfterCharge\": false,\n                \"Method\": \"\",\n                \"TokenLocation\": \"\"\n            }\n        ],\n        \"ServiceName\": \"\",\n        \"RequestId\": \"\",\n        \"InstanceName\": \"\",\n        \"Protocol\": \"\",\n        \"ApiTotalCount\": 1,\n        \"ModifiedTime\": \"2020-09-22T00:00:00+00:00\",\n        \"DeploymentType\": \"DEFAULT\",\n        \"SpecialUse\": \"DEFAULT\",\n        \"InstanceId\": \"\",\n        \"AvailableEnvironments\": [\n            \"release\"\n        ],\n        \"ServiceId\": \"\",\n        \"InternalSubDomain\": \"\"\n    }\n}",
         "title": "用于查询服务详情"
       }
     ],

tccli/services/asr/v20190614/api.json

@@ -8,7 +8,7 @@
       "status": "online"
     },
     "CreateAsrVocab": {
-      "document": "用户通过本接口进行热词表的创建。\n<br>•   默认最多可创建30个热词表。\n<br>•   每个热词表最多可添加128个词，每个词最长10个汉字或30个英文字符，不能超出限制。\n<br>•   热词表可以通过数组或者本地文件形式上传。\n<br>•   本地文件必须为UTF-8编码格式，每行仅添加一个热词且不能包含标点和特殊字符。\n<br>•   热词权重取值范围为[1,10]之间的整数，权重越大代表该词被识别出来的概率越大。",
+      "document": "用户通过本接口进行热词表的创建。\n<br>•   默认最多可创建30个热词表。\n<br>•   每个热词表最多可添加1000个词，每个词最长10个汉字或30个英文字符，不能超出限制。\n<br>•   热词表可以通过数组或者本地文件形式上传。\n<br>•   本地文件必须为UTF-8编码格式，每行仅添加一个热词且不能包含标点和特殊字符。\n<br>•   热词权重取值范围为[1,10]之间的整数，权重越大代表该词被识别出来的概率越大。",
       "input": "CreateAsrVocabRequest",
       "name": "创建热词表",
       "output": "CreateAsrVocabResponse",
@@ -275,7 +275,7 @@
         },
         {
           "disabled": false,
-          "document": "词权重数组，包含全部的热词和对应的权重。每个热词的长度不大于10个汉字或30个英文字符，权重为[1,10]之间整数，数组长度不大于128",
+          "document": "词权重数组，包含全部的热词和对应的权重。每个热词的长度不大于10个汉字或30个英文字符，权重为[1,10]之间整数，数组长度不大于1000",
           "example": "1",
           "member": "HotWord",
           "name": "WordWeights",
@@ -1981,7 +1981,7 @@
         },
         {
           "disabled": false,
-          "document": "词权重数组，包含全部的热词和对应的权重。每个热词的长度不大于10，权重为[1,10]之间整数，数组长度不大于128",
+          "document": "词权重数组，包含全部的热词和对应的权重。每个热词的长度不大于10个汉字或30个英文字符，权重为[1,10]之间整数，数组长度不大于1000",
           "example": "无",
           "member": "HotWord",
           "name": "WordWeights",

tccli/services/bma/v20221115/api.json

@@ -620,6 +620,15 @@
           "name": "WhiteLists",
           "required": true,
           "type": "list"
+        },
+        {
+          "disabled": false,
+          "document": "白名单备注",
+          "example": "无",
+          "member": "string",
+          "name": "Remark",
+          "required": false,
+          "type": "string"
         }
       ],
       "type": "object"
@@ -868,6 +877,7 @@
           "example": "无",
           "member": "WhiteListData",
           "name": "WhiteLists",
+          "output_required": true,
           "type": "list",
           "value_allowed_null": false
         },
@@ -877,6 +887,7 @@
           "example": "无",
           "member": "int64",
           "name": "TotalCount",
+          "output_required": true,
           "type": "int",
           "value_allowed_null": false
         },
@@ -1508,7 +1519,7 @@
           "example": "无",
           "member": "int64",
           "name": "WhiteListId",
-          "required": false,
+          "output_required": true,
           "type": "int",
           "value_allowed_null": true
         },
@@ -1518,7 +1529,7 @@
           "example": "无",
           "member": "int64",
           "name": "CompanyId",
-          "required": false,
+          "output_required": true,
           "type": "int",
           "value_allowed_null": true
         },
@@ -1528,7 +1539,7 @@
           "example": "无",
           "member": "string",
           "name": "BrandName",
-          "required": false,
+          "output_required": true,
           "type": "string",
           "value_allowed_null": true
         },
@@ -1538,7 +1549,7 @@
           "example": "无",
           "member": "int64",
           "name": "AssetsType",
-          "required": false,
+          "output_required": true,
           "type": "int",
           "value_allowed_null": true
         },
@@ -1548,7 +1559,17 @@
           "example": "无",
           "member": "string",
           "name": "WhiteList",
-          "required": false,
+          "output_required": true,
+          "type": "string",
+          "value_allowed_null": true
+        },
+        {
+          "disabled": false,
+          "document": "白名单备注\n注意：此字段可能返回 null，表示取不到有效值。",
+          "example": "无",
+          "member": "string",
+          "name": "Remark",
+          "output_required": false,
           "type": "string",
           "value_allowed_null": true
         },
@@ -1558,7 +1579,7 @@
           "example": "无",
           "member": "string",
           "name": "InsertTime",
-          "required": false,
+          "output_required": true,
           "type": "string",
           "value_allowed_null": true
         }

tccli/services/bma/v20221115/examples.json

@@ -43,7 +43,7 @@
     "CreateBPWhiteList": [
       {
         "document": "添加白名单",
-        "input": "{\n  \"CompanyId\": 123,\n  \"WhiteListType\": 0,\n  \"WhiteLists\": [\n    \"xxx\"\n  ]\n}",
+        "input": "POST / HTTP/1.1\nHost: bma.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: CreateBPWhiteList\n<公共请求参数>\n\n{\n    \"CompanyId\": 123,\n    \"WhiteListType\": 0,\n    \"WhiteLists\": [\n        \"xxx\"\n    ]\n}",
         "output": "{\n    \"Response\": {\n        \"RequestId\": \"xxx\"\n    }\n}",
         "title": "添加白名单"
       }
@@ -83,7 +83,7 @@
     "DescribeBPWhiteLists": [
       {
         "document": "查询白名单列表",
-        "input": "{\n  \"Filters\": [\n    {\n      \"Name\": \"CompanyId\",\n      \"Value\": \"123\"\n    },\n    {\n      \"Name\": \"AssetsType\",\n      \"Value\": \"0\"\n    },\n    {\n      \"Name\": \"WhiteList\",\n      \"Value\": \"白名单名称\"\n    },\n    {\n      \"Name\": \"StartTime\",\n      \"Value\": \"2022-10-01 00:00:00\"\n    },\n    {\n      \"Name\": \"EndTime\",\n      \"Value\": \"2022-10-01 23:59:59\"\n    }\n  ],\n  \"PageSize\": 10,\n  \"PageNumber\": 1\n}",
+        "input": "POST / HTTP/1.1\nHost: bma.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: DescribeBPWhiteLists\n<公共请求参数>\n\n{\n    \"Filters\": [\n        {\n            \"Name\": \"CompanyId\",\n            \"Value\": \"123\"\n        },\n        {\n            \"Name\": \"AssetsType\",\n            \"Value\": \"0\"\n        },\n        {\n            \"Name\": \"WhiteList\",\n            \"Value\": \"白名单名称\"\n        },\n        {\n            \"Name\": \"StartTime\",\n            \"Value\": \"2022-10-01 00:00:00\"\n        },\n        {\n            \"Name\": \"EndTime\",\n            \"Value\": \"2022-10-01 23:59:59\"\n        }\n    ],\n    \"PageSize\": 10,\n    \"PageNumber\": 1\n}",
         "output": "{\n    \"Response\": {\n        \"WhiteLists\": [\n            {\n                \"WhiteListId\": 123,\n                \"CompanyId\": 123,\n                \"BrandName\": \"品牌名称\",\n                \"AssetsType\": 0,\n                \"WhiteList\": \"白名单名称\",\n                \"InsertTime\": \"2022-10-01 00:00:00\"\n            }\n        ],\n        \"TotalCount\": 10,\n        \"RequestId\": \"xxx\"\n    }\n}",
         "title": "查询白名单列表"
       }