tccli 3.0.1131.1__py2.py3-none-any.whl → 3.0.1132.1__py2.py3-none-any.whl

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (20) hide show
  1. tccli/__init__.py +1 -1
  2. tccli/services/ckafka/v20190819/api.json +3 -2
  3. tccli/services/csip/csip_client.py +106 -0
  4. tccli/services/csip/v20221121/api.json +657 -19
  5. tccli/services/csip/v20221121/examples.json +16 -0
  6. tccli/services/ess/v20201111/api.json +3 -3
  7. tccli/services/essbasic/v20210526/api.json +4 -4
  8. tccli/services/gaap/v20180529/api.json +20 -0
  9. tccli/services/ocr/v20181119/api.json +2 -2
  10. tccli/services/ocr/v20181119/examples.json +2 -2
  11. tccli/services/redis/v20180412/api.json +33 -29
  12. tccli/services/redis/v20180412/examples.json +8 -8
  13. tccli/services/wedata/v20210820/api.json +81 -1
  14. tccli/services/wedata/v20210820/examples.json +8 -0
  15. tccli/services/wedata/wedata_client.py +53 -0
  16. {tccli-3.0.1131.1.dist-info → tccli-3.0.1132.1.dist-info}/METADATA +2 -2
  17. {tccli-3.0.1131.1.dist-info → tccli-3.0.1132.1.dist-info}/RECORD +20 -20
  18. {tccli-3.0.1131.1.dist-info → tccli-3.0.1132.1.dist-info}/WHEEL +0 -0
  19. {tccli-3.0.1131.1.dist-info → tccli-3.0.1132.1.dist-info}/entry_points.txt +0 -0
  20. {tccli-3.0.1131.1.dist-info → tccli-3.0.1132.1.dist-info}/license_files/LICENSE +0 -0
tccli/services/csip/v20221121/examples.json CHANGED
@@ -272,6 +272,14 @@
272
272
  "title": "查询漏洞风险高级配置"
273
273
  }
274
274
  ],
275
+ "DescribeVULRiskDetail": [
276
+ {
277
+ "document": "示例1",
278
+ "input": "POST / HTTP/1.1\nHost: csip.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: DescribeVULRiskDetail\n<公共请求参数>\n\n{\n \"PCMGRId\": \"pcmgr-33429\"\n}",
279
+ "output": "{\n \"Response\": {\n \"QuestionId\": \"-\",\n \"RequestId\": \"46d36ab9-84d0-4ad1-bc9f-284742f231b9\",\n \"ServiceSupport\": [\n {\n \"IsSupport\": false,\n \"ServiceName\": \"cfw_waf_virtual\",\n \"SupportHandledCount\": 0,\n \"SupportTotalCount\": 0\n },\n {\n \"IsSupport\": false,\n \"ServiceName\": \"cwp_detect\",\n \"SupportHandledCount\": 0,\n \"SupportTotalCount\": 0\n },\n {\n \"IsSupport\": false,\n \"ServiceName\": \"cwp_defense\",\n \"SupportHandledCount\": 0,\n \"SupportTotalCount\": 0\n },\n {\n \"IsSupport\": false,\n \"ServiceName\": \"cwp_fix\",\n \"SupportHandledCount\": 0,\n \"SupportTotalCount\": 0\n }\n ],\n \"SessionId\": \"\",\n \"VulData\": {\n \"Describe\": \"Vim存在输入验证漏洞。由于没有正确的过滤转义字符，从7.2.010到7.x的Vim 3.0不能正确地转义字符，这使得用户辅助攻击者可以（1）通过在包含“;”的行上输入K击键来执行任意的shell命令。（分号）后接命令，或通过在（2）“ Ctrl-]”（控制小括号）或（3）“ g]”（g小括号）后输入参数来执行任意Ex命令）击键顺序，与CVE-2008-2712的问题不同。\",\n \"Fix\": \" 建议您更新当前系统或软件至最新版，完成漏洞的修复。参考链接：https://www.vim.org/download.php\",\n \"ImpactComponent\": \"(vim) vim\",\n \"References\": \"http://ftp.vim.org/pub/vim/patches/7.2/7.2.010,http://groups.google.com/group/vim_dev/attach/9290f26f9bc11b33/K-arbitrary-command-execution.patch.v3?part=2,http://groups.google.com/group/vim_dev/attach/dd32ad3a84f36bb2/K-arbitrary-command-execution.patch?part=2,http://groups.google.com/group/vim_dev/browse_thread/thread/1434d0812b5c817e/6ad2d5b50a96668e,http://groups.google.com/group/vim_dev/msg/9290f26f9bc11b33,http://lists.apple.com/archives/security-announce/2008/Oct/msg00001.html,http://lists.apple.com/archives/security-announce/2010//Mar/msg00001.html,http://secunia.com/advisories/31592,http://secunia.com/advisories/32222,http://secunia.com/advisories/32858,http://secunia.com/advisories/32864,http://secunia.com/advisories/33410,http://support.apple.com/kb/HT3216,http://support.apple.com/kb/HT4077,http://support.avaya.com/elmodocs2/security/ASA-2008-457.htm,http://support.avaya.com/elmodocs2/security/ASA-2009-001.htm,http://www.mandriva.com/security/advisories?name=MDVSA-2008:236,http://www.openwall.com/lists/oss-security/2008/09/11/3,http://www.openwall.com/lists/oss-security/2008/09/11/4,http://www.openwall.com/lists/oss-security/2008/09/16/5,http://www.openwall.com/lists/oss-security/2008/09/16/6,http://www.rdancer.org/vulnerablevim-K.html,http://www.redhat.com/support/errata/RHSA-2008-0580.html,http://www.redhat.com/support/errata/RHSA-2008-0617.html,http://www.redhat.com/support/errata/RHSA-2008-0618.html,http://www.securityfocus.com/archive/1/495662,http://www.securityfocus.com/archive/1/495703,http://www.securityfocus.com/archive/1/502322/100/0/threaded,http://www.securityfocus.com/bid/30795,http://www.securityfocus.com/bid/31681,http://www.ubuntu.com/usn/USN-712-1,http://www.vmware.com/security/advisories/VMSA-2009-0004.html,http://www.vupen.com/english/advisories/2008/2780,http://www.vupen.com/english/advisories/2009/0033,http://www.vupen.com/english/advisories/2009/0904,https://bugzilla.redhat.com/show_bug.cgi?id=461927,https://exchange.xforce.ibmcloud.com/vulnerabilities/44626,https://oval.cisecurity.org/repository/search/definition/oval%3Aorg.mitre.oval%3Adef%3A10894,https://oval.cisecurity.org/repository/search/definition/oval%3Aorg.mitre.oval%3Adef%3A5812\"\n },\n \"VulTrend\": [\n {\n \"AffectAssetCount\": 0,\n \"AffectUserCount\": 0,\n \"AttackCount\": 0,\n \"Date\": \"2023-12-05\"\n },\n {\n \"AffectAssetCount\": 0,\n \"AffectUserCount\": 0,\n \"AttackCount\": 0,\n \"Date\": \"2023-12-06\"\n },\n {\n \"AffectAssetCount\": 0,\n \"AffectUserCount\": 0,\n \"AttackCount\": 0,\n \"Date\": \"2023-12-07\"\n },\n {\n \"AffectAssetCount\": 0,\n \"AffectUserCount\": 0,\n \"AttackCount\": 0,\n \"Date\": \"2023-12-08\"\n },\n {\n \"AffectAssetCount\": 0,\n \"AffectUserCount\": 0,\n \"AttackCount\": 0,\n \"Date\": \"2023-12-09\"\n },\n {\n \"AffectAssetCount\": 0,\n \"AffectUserCount\": 0,\n \"AttackCount\": 0,\n \"Date\": \"2023-12-10\"\n },\n {\n \"AffectAssetCount\": 0,\n \"AffectUserCount\": 0,\n \"AttackCount\": 0,\n \"Date\": \"2023-12-11\"\n }\n ]\n }\n}",
280
+ "title": "示例1"
281
+ }
282
+ ],
275
283
  "DescribeVpcAssets": [
276
284
  {
277
285
  "document": "空示例",
@@ -280,6 +288,14 @@
280
288
  "title": "空示例"
281
289
  }
282
290
  ],
291
+ "DescribeVulViewVulRiskList": [
292
+ {
293
+ "document": "success1",
294
+ "input": "POST / HTTP/1.1\nHost: csip.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: DescribeVulViewVulRiskList\n<公共请求参数>\n\n{}",
295
+ "output": "{\n \"Response\": {\n \"Data\": [\n {\n \"AffectAssetCount\": 1,\n \"AppId\": \"1300448058\",\n \"AppName\": \"-\",\n \"AppVersion\": \"-\",\n \"CVE\": \"CVE-2019-25032\",\n \"Component\": \"-\",\n \"EMGCVulType\": 0,\n \"FirstTime\": \"2023-10-30 15:02:23\",\n \"From\": \"主机检测\",\n \"Index\": \"04c52dbf64c927a11b15840089e8f1d3\",\n \"Level\": \"high\",\n \"Nick\": \"\",\n \"NoHandleCount\": 0,\n \"PCMGRId\": \"\",\n \"Payload\": \"\",\n \"Port\": \"-\",\n \"RecentTime\": \"2023-11-29 14:43:07\",\n \"RiskId\": \"04c52dbf64c927a11b15840089e8f1d3\",\n \"Uin\": \"\",\n \"VULName\": \"Unbound 输入验证错误漏洞 (CVE-2019-25032)\",\n \"VULType\": \"处理逻辑错误\",\n \"VULURL\": \"\"\n },\n {\n \"AffectAssetCount\": 1,\n \"AppId\": \"1300448058\",\n \"AppName\": \"-\",\n \"AppVersion\": \"-\",\n \"CVE\": \"CVE-2018-25009\",\n \"Component\": \"-\",\n \"EMGCVulType\": 0,\n \"FirstTime\": \"2023-12-07 17:22:17\",\n \"From\": \"主机检测\",\n \"Index\": \"07c7249d578bb771121cdf5b6e7c6e54\",\n \"Level\": \"high\",\n \"Nick\": \"\",\n \"NoHandleCount\": 0,\n \"PCMGRId\": \"\",\n \"Payload\": \"\",\n \"Port\": \"-\",\n \"RecentTime\": \"2023-12-07 17:22:17\",\n \"RiskId\": \"07c7249d578bb771121cdf5b6e7c6e54\",\n \"Uin\": \"\",\n \"VULName\": \"libwebp 缓冲区错误漏洞(CVE-2018-25009)\",\n \"VULType\": \"缓冲区溢出\",\n \"VULURL\": \"\"\n },\n {\n \"AffectAssetCount\": 1,\n \"AppId\": \"1300448058\",\n \"AppName\": \"-\",\n \"AppVersion\": \"-\",\n \"CVE\": \"CVE-2021-20231\",\n \"Component\": \"-\",\n \"EMGCVulType\": 0,\n \"FirstTime\": \"2023-12-07 17:22:17\",\n \"From\": \"主机检测\",\n \"Index\": \"0dddd68a2edcb52ee7c6ee7641a0fffa\",\n \"Level\": \"high\",\n \"Nick\": \"\",\n \"NoHandleCount\": 0,\n \"PCMGRId\": \"\",\n \"Payload\": \"\",\n \"Port\": \"-\",\n \"RecentTime\": \"2023-12-07 17:22:17\",\n \"RiskId\": \"0dddd68a2edcb52ee7c6ee7641a0fffa\",\n \"Uin\": \"\",\n \"VULName\": \"GnuTLS 资源管理错误漏洞(CVE-2021-20231)\",\n \"VULType\": \"其他\",\n \"VULURL\": \"\"\n },\n {\n \"AffectAssetCount\": 1,\n \"AppId\": \"1300448058\",\n \"AppName\": \"-\",\n \"AppVersion\": \"-\",\n \"CVE\": \"CVE-2020-36331\",\n \"Component\": \"-\",\n \"EMGCVulType\": 0,\n \"FirstTime\": \"2023-12-07 17:22:17\",\n \"From\": \"主机检测\",\n \"Index\": \"0f256323945289d6d94372a23c639064\",\n \"Level\": \"high\",\n \"Nick\": \"\",\n \"NoHandleCount\": 0,\n \"PCMGRId\": \"\",\n \"Payload\": \"\",\n \"Port\": \"-\",\n \"RecentTime\": \"2023-12-07 17:22:17\",\n \"RiskId\": \"0f256323945289d6d94372a23c639064\",\n \"Uin\": \"\",\n \"VULName\": \"libwebp 缓冲区错误漏洞(CVE-2020-36331)\",\n \"VULType\": \"缓冲区溢出\",\n \"VULURL\": \"\"\n },\n {\n \"AffectAssetCount\": 3,\n \"AppId\": \"1300448058\",\n \"AppName\": \"OpenSSH\",\n \"AppVersion\": \"-\",\n \"CVE\": \"CVE-2020-15778\",\n \"Component\": \"OpenSSH\",\n \"EMGCVulType\": 0,\n \"FirstTime\": \"2023-09-26 16:34:50\",\n \"From\": \"云安全中心\",\n \"Index\": \"1498f23a853529b3be8cf554629e4533\",\n \"Level\": \"high\",\n \"Nick\": \"\",\n \"NoHandleCount\": 0,\n \"PCMGRId\": \"\",\n \"Payload\": \"OpenSSH/7.4,OpenSSH/8.0\",\n \"Port\": \"22\",\n \"RecentTime\": \"2023-09-27 11:49:10\",\n \"RiskId\": \"1498f23a853529b3be8cf554629e4533\",\n \"Uin\": \"\",\n \"VULName\": \"OpenSSH 命令注入漏洞(CVE-2020-15778)\",\n \"VULType\": \"命令注入\",\n \"VULURL\": \"\"\n },\n {\n \"AffectAssetCount\": 2,\n \"AppId\": \"1300448058\",\n \"AppName\": \"-\",\n \"AppVersion\": \"-\",\n \"CVE\": \"CVE-2021-3520\",\n \"Component\": \"-\",\n \"EMGCVulType\": 0,\n \"FirstTime\": \"2023-10-27 10:28:30\",\n \"From\": \"主机检测\",\n \"Index\": \"16f4ce6bfc81bf53176ef3a6351099ed\",\n \"Level\": \"high\",\n \"Nick\": \"\",\n \"NoHandleCount\": 0,\n \"PCMGRId\": \"\",\n \"Payload\": \"\",\n \"Port\": \"-\",\n \"RecentTime\": \"2023-12-07 17:22:18\",\n \"RiskId\": \"16f4ce6bfc81bf53176ef3a6351099ed\",\n \"Uin\": \"\",\n \"VULName\": \"LZ4 安全漏洞 (CVE-2021-3520)\",\n \"VULType\": \"其他\",\n \"VULURL\": \"\"\n },\n {\n \"AffectAssetCount\": 2,\n \"AppId\": \"1300448058\",\n \"AppName\": \"-\",\n \"AppVersion\": \"-\",\n \"CVE\": \"CVE-2020-9895\",\n \"Component\": \"-\",\n \"EMGCVulType\": 0,\n \"FirstTime\": \"2023-10-27 10:28:30\",\n \"From\": \"主机检测\",\n \"Index\": \"18321f689397785f8cb79c60c6aabae8\",\n \"Level\": \"high\",\n \"Nick\": \"\",\n \"NoHandleCount\": 0,\n \"PCMGRId\": \"\",\n \"Payload\": \"\",\n \"Port\": \"-\",\n \"RecentTime\": \"2023-12-07 17:22:18\",\n \"RiskId\": \"18321f689397785f8cb79c60c6aabae8\",\n \"Uin\": \"\",\n \"VULName\": \"WebKit组件安全漏洞 (CVE-2020-9895)\",\n \"VULType\": \"其他\",\n \"VULURL\": \"\"\n },\n {\n \"AffectAssetCount\": 2,\n \"AppId\": \"1300448058\",\n \"AppName\": \"-\",\n \"AppVersion\": \"-\",\n \"CVE\": \"CVE-2019-3822\",\n \"Component\": \"-\",\n \"EMGCVulType\": 0,\n \"FirstTime\": \"2023-10-27 10:28:30\",\n \"From\": \"主机检测\",\n \"Index\": \"1de2ea2fdeba33f60237e63ba1796a7a\",\n \"Level\": \"high\",\n \"Nick\": \"\",\n \"NoHandleCount\": 0,\n \"PCMGRId\": \"\",\n \"Payload\": \"\",\n \"Port\": \"-\",\n \"RecentTime\": \"2023-12-07 17:22:18\",\n \"RiskId\": \"1de2ea2fdeba33f60237e63ba1796a7a\",\n \"Uin\": \"\",\n \"VULName\": \"Haxx libcurl 缓冲区错误漏洞 (CVE-2019-3822)\",\n \"VULType\": \"缓冲区溢出\",\n \"VULURL\": \"\"\n },\n {\n \"AffectAssetCount\": 1,\n \"AppId\": \"1300448058\",\n \"AppName\": \"-\",\n \"AppVersion\": \"-\",\n \"CVE\": \"CVE-2019-25042\",\n \"Component\": \"-\",\n \"EMGCVulType\": 0,\n \"FirstTime\": \"2023-10-30 15:02:23\",\n \"From\": \"主机检测\",\n \"Index\": \"21ecf9ac58582f15794dab5ee37bcef1\",\n \"Level\": \"high\",\n \"Nick\": \"\",\n \"NoHandleCount\": 0,\n \"PCMGRId\": \"\",\n \"Payload\": \"\",\n \"Port\": \"-\",\n \"RecentTime\": \"2023-11-29 14:43:07\",\n \"RiskId\": \"21ecf9ac58582f15794dab5ee37bcef1\",\n \"Uin\": \"\",\n \"VULName\": \"Unbound 缓冲区错误漏洞 (CVE-2019-25042)\",\n \"VULType\": \"缓冲区溢出\",\n \"VULURL\": \"\"\n },\n {\n \"AffectAssetCount\": 2,\n \"AppId\": \"1300448058\",\n \"AppName\": \"Nginx\",\n \"AppVersion\": \"-\",\n \"CVE\": \"CVE-2019-9511\",\n \"Component\": \"Nginx\",\n \"EMGCVulType\": 0,\n \"FirstTime\": \"2023-09-26 16:34:50\",\n \"From\": \"云安全中心\",\n \"Index\": \"28d5b79163e64cd046e6537131ea9e08\",\n \"Level\": \"high\",\n \"Nick\": \"\",\n \"NoHandleCount\": 0,\n \"PCMGRId\": \"\",\n \"Payload\": \"nginx/1.14.1\",\n \"Port\": \"80\",\n \"RecentTime\": \"2023-09-27 11:49:10\",\n \"RiskId\": \"28d5b79163e64cd046e6537131ea9e08\",\n \"Uin\": \"\",\n \"VULName\": \"nginx 安全漏洞(CVE-2019-9511)\",\n \"VULType\": \"其他\",\n \"VULURL\": \"\"\n }\n ],\n \"FromLists\": [\n {\n \"Text\": \"云安全中心\",\n \"Value\": \"0\"\n },\n {\n \"Text\": \"主机检测\",\n \"Value\": \"1\"\n },\n {\n \"Text\": \"容器检测\",\n \"Value\": \"5\"\n }\n ],\n \"LevelLists\": [\n {\n \"Text\": \"中危\",\n \"Value\": \"middle\"\n },\n {\n \"Text\": \"低危\",\n \"Value\": \"low\"\n },\n {\n \"Text\": \"提示\",\n \"Value\": \"info\"\n },\n {\n \"Text\": \"严重\",\n \"Value\": \"extreme\"\n },\n {\n \"Text\": \"高危\",\n \"Value\": \"high\"\n }\n ],\n \"RequestId\": \"470926c1-52bf-46fb-bc00-be5d1b8cba9f\",\n \"Tags\": [\n {\n \"Text\": \"该漏洞有poc\",\n \"Value\": \"POC\"\n },\n {\n \"Text\": \"必修\",\n \"Value\": \"IS_SUGGEST\"\n },\n {\n \"Text\": \"该漏洞有exp\",\n \"Value\": \"EXP\"\n },\n {\n \"Text\": \"该漏洞存在在野利用或在野攻击\",\n \"Value\": \"KNOWN_EXPLOITED\"\n },\n {\n \"Text\": \"该漏洞仅能本地利用\",\n \"Value\": \"LOCAL\"\n },\n {\n \"Text\": \"该漏洞可作为系统组件漏洞检出\",\n \"Value\": \"SYS\"\n },\n {\n \"Text\": \"该漏洞可作为应用组件漏洞检出\",\n \"Value\": \"APP\"\n },\n {\n \"Text\": \"应急\",\n \"Value\": \"IS_EMERGENCY\"\n },\n {\n \"Text\": \"该漏洞可以远程利用\",\n \"Value\": \"NETWORK\"\n }\n ],\n \"TotalCount\": 672,\n \"VULTypeLists\": [\n {\n \"Text\": \"处理逻辑错误\",\n \"Value\": \"处理逻辑错误\"\n }\n ]\n }\n}",
296
+ "title": "success1"
297
+ }
298
+ ],
283
299
  "ModifyOrganizationAccountStatus": [
284
300
  {
285
301
  "document": "修改集团账号状态",
tccli/services/ess/v20201111/api.json CHANGED
@@ -148,7 +148,7 @@
148
148
  "status": "online"
149
149
  },
150
150
  "CreateFlowSignUrl": {
151
- "document": "该接口用于发起合同后，生成用户的签署链接 <br/>\n\n**注意**\n1. 该签署**链接有效期为30分钟**，过期后将失效，如需签署可重新创建签署链接 。\n2. 该接口返回的签署链接适用于APP集成的场景，支持APP打开或浏览器直接打开，**不支持微信小程序嵌入**。\n跳转到小程序的实现，参考微信官方文档（分为<a href=\"https://developers.weixin.qq.com/miniprogram/dev/api/navigate/wx.navigateToMiniProgram.html\">全屏</a>、<a href=\"https://developers.weixin.qq.com/miniprogram/dev/framework/open-ability/openEmbeddedMiniProgram.html\">半屏</a>两种方式），如何配置也可以请参考: <a href=\"https://qian.tencent.com/developers/company/openwxminiprogram\">跳转电子签小程序配置</a>。\n3. 因h5涉及人脸身份认证能力基于慧眼人脸核身，对Android和iOS系统均有一定要求， 因此<font color='red'>App嵌入H5签署合同需要按照慧眼提供的<a href=\"https://cloud.tencent.com/document/product/1007/61076\">慧眼人脸核身兼容性文档</a>做兼容性适配</font>。",
151
+ "document": "该接口用于发起合同后，生成用户的签署链接 <br/>\n\n**注意**\n1. 该签署**链接有效期为30分钟**，过期后将失效，如需签署可重新创建签署链接 。\n2. 该接口返回的签署链接适用于APP集成的场景，支持APP打开或浏览器直接打开，**不支持微信小程序嵌入**。配置方式请参考：<a href=\"https://qian.tencent.com/developers/company/openqianh5/\">跳转电子签H5</a>。\n如需跳转到小程序的实现，参考微信官方文档（分为<a href=\"https://developers.weixin.qq.com/miniprogram/dev/api/navigate/wx.navigateToMiniProgram.html\">全屏</a>、<a href=\"https://developers.weixin.qq.com/miniprogram/dev/framework/open-ability/openEmbeddedMiniProgram.html\">半屏</a>两种方式），如何配置也可以请参考: <a href=\"https://qian.tencent.com/developers/company/openwxminiprogram\">跳转电子签小程序配置</a>。\n3. 因h5涉及人脸身份认证能力基于慧眼人脸核身，对Android和iOS系统均有一定要求， 因此<font color='red'>App嵌入H5签署合同需要按照慧眼提供的<a href=\"https://cloud.tencent.com/document/product/1007/61076\">慧眼人脸核身兼容性文档</a>做兼容性适配</font>。",
152
152
  "input": "CreateFlowSignUrlRequest",
153
153
  "name": "获取H5签署链接",
154
154
  "output": "CreateFlowSignUrlResponse",
@@ -3938,7 +3938,7 @@
3938
3938
  },
3939
3939
  {
3940
3940
  "disabled": false,
3941
- "document": "流程签署人列表，其中结构体的ApproverName，ApproverMobile和ApproverType必传，企业签署人则需传OrganizationName，其他可不传。\n\n注:\n`1. 签署人只能有手写签名、时间类型和印章类型的签署控件，其他类型的填写控件和签署控件暂时都未支持。`\n`2. 生成发起方预览链接时，该字段（FlowApproverInfos）传空或者不传`",
3941
+ "document": "流程签署人列表，其中结构体的ApproverName，ApproverMobile和ApproverType必传，企业签署人则需传OrganizationName，其他可不传。\n\n注:\n`1. 签署人只能有手写签名、时间类型、印章类型的签署控件和内容填写控件，其他类型的签署控件暂时未支持。`\n`2. 生成发起方预览链接时，该字段（FlowApproverInfos）传空或者不传`",
3942
3942
  "example": "无",
3943
3943
  "member": "FlowCreateApprover",
3944
3944
  "name": "FlowApproverInfos",
@@ -3956,7 +3956,7 @@
3956
3956
  },
3957
3957
  {
3958
3958
  "disabled": false,
3959
- "document": "签署完之后的H5页面的跳转链接，此链接及支持http://和https://，最大长度1000个字符。(建议https协议)",
3959
+ "document": "签署完之后的H5页面的跳转链接，最大长度1000个字符。链接类型请参考 <a href=\"https://qian.tencent.com/developers/company/openqianh5\" target=\"_blank\">跳转电子签H5</a>\n",
3960
3960
  "example": "无",
3961
3961
  "member": "string",
3962
3962
  "name": "JumpUrl",
tccli/services/essbasic/v20210526/api.json CHANGED
@@ -78,7 +78,7 @@
78
78
  "status": "online"
79
79
  },
80
80
  "ChannelCreateFlowByFiles": {
81
- "document": "接口（ChannelCreateFlowByFiles）用PDF文件创建签署流程。\n\n适用场景：适用非制式的合同文件签署，开发者有每个签署流程的PDF，可以通过该接口传入完整的PDF文件及流程信息生成待签署的合同流程。\n\n**注**: \n<ul>\n<li>此接口静默签(企业自动签)能力为白名单功能，使用前请联系对接的客户经理沟通。</li>\n<li>此接口需要依赖<a href=\"https://qian.tencent.com/developers/partnerApis/files/UploadFiles\" target=\"_blank\">文件上传接口</a>生成pdf资源编号（FileIds）进行使用。整体的逻辑如下图</li>\n</ul>\n\n![image](https://qcloudimg.tencent-cloud.cn/raw/bf86248a2c163228c4e894cf5926af69/ChannelCreateFlowByFiles.png)\n\n**可以作为发起方和签署方的角色列表**\n<table> <thead> <tr> <th>场景编号</th> <th>发起方</th> <th>签署方</th> <th>补充</th> </tr> </thead> <tbody> <tr> <td>场景一</td> <td>子企业A的员工</td> <td>子企业A的员工</td> <td>子企业是通过<a href=\"https://qian.tencent.com/developers/partnerApis/accounts/CreateConsoleLoginUrl\" target=\"_blank\">CreateConsoleLoginUrl</a>生成子客登录链接注册的企业</td> </tr> <tr> <td>场景二</td> <td>子企业A的员工</td> <td>子企业B(不指定经办人走领取逻辑)</td> <td>领取的逻辑可以参考文档<a href=\"https://qian.tencent.com/developers/partner/dynamic_signer\" target=\"_blank\">动态签署方</a> </td> </tr> <tr> <td>场景三</td> <td>子企业A的员工</td> <td>子企业B的员工</td> <td>-</td> </tr> <tr> <td>场景四</td> <td>子企业A的员工</td> <td>个人</td> <td>就是自然人，不是企业员工</td> </tr> <tr> <td>场景五</td> <td>子企业A的员工</td> <td>SaaS平台企业员工</td> <td>SaaS平台企业是通过<a href=\"https://qian.tencent.cn/console/company-register\" target=\"_blank\">https://qian.tencent.cn/console/company-register</a>链接注册的企业</td> </tr> </tbody> </table>\n\n\n**注**: \n`1. 发起合同时候, 作为发起方的第三方子企业A员工的企业和员工必须经过实名, 而作为签署方的第三方子企业A员工/个人/自然人/SaaS平台企业员工/第三方子企业B员工企业中的企业和个人/员工可以未实名`\n\n`2. 不同类型的签署方传参不同, 可以参考开发者中心的FlowApproverInfo结构体说明`\n\n`3. 合同发起后就会扣减合同的额度, 只有撤销没有参与方签署过或只有自动签署签署过的合同，才会返还合同额度。（过期，拒签，签署完成，解除完成等状态不会返还额度）`\n\n`4. 静默（自动）签署不支持合同签署方存在填写功能`",
81
+ "document": "接口（ChannelCreateFlowByFiles）用PDF文件创建签署流程。\n\n适用场景：适用非制式的合同文件签署，开发者有每个签署流程的PDF，可以通过该接口传入完整的PDF文件及流程信息生成待签署的合同流程。\n\n**注**: \n<ul>\n<li>此接口静默签(企业自动签)能力为白名单功能，使用前请联系对接的客户经理沟通。</li>\n<li>此接口需要依赖<a href=\"https://qian.tencent.com/developers/partnerApis/files/UploadFiles\" target=\"_blank\">文件上传接口</a>生成pdf资源编号（FileIds）进行使用。整体的逻辑如下图</li>\n</ul>\n\n![image](https://qcloudimg.tencent-cloud.cn/raw/bf86248a2c163228c4e894cf5926af69/ChannelCreateFlowByFiles.png)\n\n**可以作为发起方和签署方的角色列表**\n<table> <thead> <tr> <th>场景编号</th> <th>发起方</th> <th>签署方</th> <th>补充</th> </tr> </thead> <tbody> <tr> <td>场景一</td> <td>子企业A的员工</td> <td>子企业A的员工</td> <td>子企业是通过<a href=\"https://qian.tencent.com/developers/partnerApis/accounts/CreateConsoleLoginUrl\" target=\"_blank\">CreateConsoleLoginUrl</a>生成子客登录链接注册的企业</td> </tr> <tr> <td>场景二</td> <td>子企业A的员工</td> <td>子企业B(不指定经办人走领取逻辑)</td> <td>领取的逻辑可以参考文档<a href=\"https://qian.tencent.com/developers/partner/dynamic_signer\" target=\"_blank\">动态签署方</a> </td> </tr> <tr> <td>场景三</td> <td>子企业A的员工</td> <td>子企业B的员工</td> <td>-</td> </tr> <tr> <td>场景四</td> <td>子企业A的员工</td> <td>个人</td> <td>就是自然人，不是企业员工</td> </tr> <tr> <td>场景五</td> <td>子企业A的员工</td> <td>SaaS平台企业员工</td> <td>SaaS平台企业是通过<a href=\"https://qian.tencent.cn/console/company-register\" target=\"_blank\">https://qian.tencent.cn/console/company-register</a>链接注册的企业</td> </tr> </tbody> </table>\n\n\n**注**: \n`1. 发起合同时候, 作为发起方的第三方子企业A员工的企业和员工必须经过实名, 而作为签署方的第三方子企业A员工/个人/自然人/SaaS平台企业员工/第三方子企业B员工企业中的企业和个人/员工可以未实名`\n\n`2. 不同类型的签署方传参不同, 可以参考开发者中心的FlowApproverInfo结构体说明`\n\n`3. 合同发起后就会扣减合同的额度, 只有撤销没有参与方签署过或只有自动签署签署过的合同，才会返还合同额度。（过期，拒签，签署完成，解除完成等状态不会返还额度）`\n\n`4. 静默（自动）签署不支持合同签署方存在填写功能`\n\n<font color=\"red\">相关视频指引</font> <br>\n1. <a href=\"https://dyn.ess.tencent.cn/guide/apivideo/essbasic-UploadFiles.mp4\" target=\"_blank\">【上传文件代码】编写示例</a><br>\n1. <a href=\"https://dyn.ess.tencent.cn/guide/apivideo/essbasic-ChannelCreateFlowByFiles.mp4\" target=\"_blank\">【用PDF文件创建签署流程】编写示例</a><br>",
82
82
  "input": "ChannelCreateFlowByFilesRequest",
83
83
  "name": "用PDF文件创建签署流程",
84
84
  "output": "ChannelCreateFlowByFilesResponse",
@@ -113,7 +113,7 @@
113
113
  "status": "online"
114
114
  },
115
115
  "ChannelCreateFlowSignUrl": {
116
- "document": "该接口用于发起合同后，生成用户的签署链接 <br/>\n\n**注意**\n1. 该签署**链接有效期为30分钟**，过期后将失效，如需签署可重新创建签署链接 。\n2. 该接口返回的签署链接适用于APP集成的场景，支持APP打开或浏览器直接打开，**不支持微信小程序嵌入**。\n跳转到小程序的实现，参考微信官方文档（分为<a href=\"https://developers.weixin.qq.com/miniprogram/dev/api/navigate/wx.navigateToMiniProgram.html\">全屏</a>、<a href=\"https://developers.weixin.qq.com/miniprogram/dev/framework/open-ability/openEmbeddedMiniProgram.html\">半屏</a>两种方式），如何配置也可以请参考: <a href=\"https://qian.tencent.com/developers/company/openwxminiprogram\">跳转电子签小程序配置</a>。\n3. 因h5涉及人脸身份认证能力基于慧眼人脸核身，对Android和iOS系统均有一定要求， 因此<font color='red'>App嵌入H5签署合同需要按照慧眼提供的<a href=\"https://cloud.tencent.com/document/product/1007/61076\">慧眼人脸核身兼容性文档</a>做兼容性适配</font>。",
116
+ "document": "该接口用于发起合同后，生成用户的签署链接 <br/>\n\n**注意**\n1. 该签署**链接有效期为30分钟**，过期后将失效，如需签署可重新创建签署链接 。\n2. 该接口返回的签署链接适用于APP集成的场景，支持APP打开或浏览器直接打开，**不支持微信小程序嵌入**。配置方式请参考：<a href=\"https://qian.tencent.com/developers/company/openqianh5/\">跳转电子签H5</a>。\n如需跳转到小程序的实现，参考微信官方文档（分为<a href=\"https://developers.weixin.qq.com/miniprogram/dev/api/navigate/wx.navigateToMiniProgram.html\">全屏</a>、<a href=\"https://developers.weixin.qq.com/miniprogram/dev/framework/open-ability/openEmbeddedMiniProgram.html\">半屏</a>两种方式），如何配置也可以请参考: <a href=\"https://qian.tencent.com/developers/company/openwxminiprogram\">跳转电子签小程序配置</a>。\n3. 因h5涉及人脸身份认证能力基于慧眼人脸核身，对Android和iOS系统均有一定要求， 因此<font color='red'>App嵌入H5签署合同需要按照慧眼提供的<a href=\"https://cloud.tencent.com/document/product/1007/61076\">慧眼人脸核身兼容性文档</a>做兼容性适配</font>。",
117
117
  "input": "ChannelCreateFlowSignUrlRequest",
118
118
  "name": "获取用户H5签署链接",
119
119
  "output": "ChannelCreateFlowSignUrlResponse",
@@ -2635,7 +2635,7 @@
2635
2635
  },
2636
2636
  {
2637
2637
  "disabled": false,
2638
- "document": "流程签署人列表，其中结构体的Name，Mobile和ApproverType必传，企业签署人则还需传OrganizationName、OpenId、OrganizationOpenId，其他可不传。\n\n注:\n`1. 签署人只能有手写签名、时间类型和印章类型的签署控件，其他类型的填写控件和签署控件暂时都未支持。`\n`2. 生成发起方预览链接时，该字段（FlowApproverInfos）传空或者不传`",
2638
+ "document": "流程签署人列表，其中结构体的Name，Mobile和ApproverType必传，企业签署人则还需传OrganizationName、OpenId、OrganizationOpenId，其他可不传。\n\n注:\n`1. 签署人只能有手写签名、时间类型、印章类型的签署控件和内容填写控件，其他类型的签署控件暂时未支持。`\n`2. 生成发起方预览链接时，该字段（FlowApproverInfos）传空或者不传`",
2639
2639
  "example": "无",
2640
2640
  "member": "FlowApproverInfo",
2641
2641
  "name": "FlowApproverInfos",
@@ -2662,7 +2662,7 @@
2662
2662
  },
2663
2663
  {
2664
2664
  "disabled": false,
2665
- "document": "签署完之后的H5页面的跳转链接，此链接及支持http://和https://，最大长度1000个字符。(建议https协议)",
2665
+ "document": "签署完之后的H5页面的跳转链接，最大长度1000个字符。链接类型请参考 <a href=\"https://qian.tencent.com/developers/company/openqianh5\" target=\"_blank\">跳转电子签H5</a>\n",
2666
2666
  "example": "无",
2667
2667
  "member": "string",
2668
2668
  "name": "JumpUrl",
tccli/services/gaap/v20180529/api.json CHANGED
@@ -6999,6 +6999,26 @@
6999
6999
  "output_required": false,
7000
7000
  "type": "bool",
7001
7001
  "value_allowed_null": true
7002
+ },
7003
+ {
7004
+ "disabled": false,
7005
+ "document": "TLS套件包\n注意：此字段可能返回 null，表示取不到有效值。",
7006
+ "example": "GAAP_TLS_CIPHERS_WIDE",
7007
+ "member": "string",
7008
+ "name": "TLSCiphers",
7009
+ "output_required": false,
7010
+ "type": "string",
7011
+ "value_allowed_null": true
7012
+ },
7013
+ {
7014
+ "disabled": false,
7015
+ "document": "TLS版本\n注意：此字段可能返回 null，表示取不到有效值。",
7016
+ "example": "[\"TLSv1\", \"TLSv1.1\", \"TLSv1.2\", \"TLSv1.3\"]",
7017
+ "member": "string",
7018
+ "name": "TLSSupportVersion",
7019
+ "output_required": false,
7020
+ "type": "list",
7021
+ "value_allowed_null": true
7002
7022
  }
7003
7023
  ],
7004
7024
  "usage": "out"
tccli/services/ocr/v20181119/api.json CHANGED
@@ -6351,7 +6351,7 @@
6351
6351
  },
6352
6352
  {
6353
6353
  "disabled": false,
6354
- "document": "扩展信息，不请求则不返回，具体输入参考示例3和示例4。\nIdCard，裁剪后身份证照片的base64编码，请求 Config.CropIdCard 时返回；\nPortrait，身份证头像照片的base64编码，请求 Config.CropPortrait 时返回；\n\nQuality，图片质量分数，请求 Config.Quality 时返回（取值范围：0 ~ 100，分数越低越模糊，建议阈值≥50）;\nBorderCodeValue，身份证边框不完整告警阈值分数，请求 Config.BorderCheckWarn时返回（取值范围：0 ~ 100，分数越低边框遮挡可能性越低，建议阈值≤50）;\n\nWarnInfos，告警信息，Code 告警码列表和释义：\n-9100\t身份证有效日期不合法告警，\n-9101\t身份证边框不完整告警，\n-9102\t身份证复印件告警，\n-9103\t身份证翻拍告警，\n-9105\t身份证框内遮挡告警，\n-9104\t临时身份证告警，\n-9106\t身份证疑似存在PS痕迹告警，\n-9107 身份证反光告警。",
6354
+ "document": "扩展信息，不请求则不返回，具体输入参考示例3和示例4。\nIdCard，裁剪后身份证照片的base64编码，请求 Config.CropIdCard 时返回；\nPortrait，身份证头像照片的base64编码，请求 Config.CropPortrait 时返回；\n\nQuality，图片质量分数，请求 Config.Quality 时返回（取值范围：0 ~ 100，分数越低越模糊，建议阈值≥50）;\nBorderCodeValue，身份证边框不完整告警阈值分数，请求 Config.BorderCheckWarn时返回（取值范围：0 ~ 100，分数越低边框遮挡可能性越低，建议阈值≤50）;\n\nWarnInfos，告警信息，Code 告警码列表和释义：\n-9100 身份证有效日期不合法告警，\n-9101 身份证边框不完整告警，\n\n-9102 身份证复印件告警（黑白及彩色复印件）,\n-9108 身份证复印件告警（仅黑白复印件），\n\n-9103 身份证翻拍告警，\n-9105 身份证框内遮挡告警，\n-9104 临时身份证告警，\n-9106 身份证疑似存在PS痕迹告警，\n-9107 身份证反光告警。",
6355
6355
  "example": "{}",
6356
6356
  "member": "string",
6357
6357
  "name": "AdvancedInfo",
@@ -11133,7 +11133,7 @@
11133
11133
  },
11134
11134
  {
11135
11135
  "disabled": false,
11136
- "document": "扩展信息，不请求则不返回，具体输入参考示例3和示例4。\nIdCard，裁剪后身份证照片的base64编码，请求 Config.CropIdCard 时返回；\nPortrait，身份证头像照片的base64编码，请求 Config.CropPortrait 时返回；\n\nQuality，图片质量分数，请求 Config.Quality 时返回（取值范围：0 ~ 100，分数越低越模糊，建议阈值≥50）;\nBorderCodeValue，身份证边框不完整告警阈值分数，请求 Config.BorderCheckWarn时返回（取值范围：0 ~ 100，分数越低边框遮挡可能性越低，建议阈值≤50）;\n\nWarnInfos，告警信息，Code 告警码列表和释义：\n-9100\t身份证有效日期不合法告警，\n-9101\t身份证边框不完整告警，\n-9102\t身份证复印件告警，\n-9103\t身份证翻拍告警，\n-9105\t身份证框内遮挡告警，\n-9104\t临时身份证告警，\n-9106\t身份证疑似存在PS痕迹告警，\n-9107 身份证反光告警。",
11136
+ "document": "扩展信息，不请求则不返回，具体输入参考示例3和示例4。\nIdCard，裁剪后身份证照片的base64编码，请求 Config.CropIdCard 时返回；\nPortrait，身份证头像照片的base64编码，请求 Config.CropPortrait 时返回；\n\nQuality，图片质量分数，请求 Config.Quality 时返回（取值范围：0 ~ 100，分数越低越模糊，建议阈值≥50）;\nBorderCodeValue，身份证边框不完整告警阈值分数，请求 Config.BorderCheckWarn时返回（取值范围：0 ~ 100，分数越低边框遮挡可能性越低，建议阈值≤50）;\n\nWarnInfos，告警信息，Code 告警码列表和释义：\n-9100 身份证有效日期不合法告警，\n-9101 身份证边框不完整告警，\n\n-9102 身份证复印件告警（黑白及彩色复印件）,\n-9108 身份证复印件告警（仅黑白复印件），\n\n-9103 身份证翻拍告警，\n-9105 身份证框内遮挡告警，\n-9104 临时身份证告警，\n-9106 身份证疑似存在PS痕迹告警，\n-9107 身份证反光告警。",
11137
11137
  "example": "{}",
11138
11138
  "member": "string",
11139
11139
  "name": "AdvancedInfo",
tccli/services/ocr/v20181119/examples.json CHANGED
@@ -235,8 +235,8 @@
235
235
  "HKIDCardOCR": [
236
236
  {
237
237
  "document": "",
238
- "input": "POST / HTTP/1.1\nHost: ocr.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: HKIDCardOCR\n<公共请求参数>\n\n{\n \"DetectFake\": \"true\",\n \"ReturnHeadImage\": \"false\",\n \"ImageUrl\": \"https://xx/a.jpg\"\n}",
239
- "output": "{\n \"Response\": {\n \"CnName\": \"申能\",\n \"EnName\": \"SAN, Nan\",\n \"TelexCode\": \"300000000000\",\n \"Sex\": \"女F\",\n \"Birthday\": \"01-01-2001\",\n \"Permanent\": 1,\n \"IdNum\": \"C000000(E)\",\n \"Symbol\": \"***AZ\",\n \"FirstIssueDate\": \"(09-99)\",\n \"CurrentIssueDate\": \"23-09-10\",\n \"FakeDetectResult\": 1,\n \"WarningCode\": [\n -9102,\n -9103\n ],\n \"HeadImage\": \"\",\n \"RequestId\": \"fba1c9ad-aeb3-4418-9ecf-80ab1b5fc875\"\n }\n}",
238
+ "input": "POST / HTTP/1.1\nHost: ocr.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: HKIDCardOCR\n<公共请求参数>\n\n{\n \"ReturnHeadImage\": \"false\",\n \"ImageUrl\": \"https://xx/a.jpg\"\n}",
239
+ "output": "{\n \"Response\": {\n \"CnName\": \"申能\",\n \"EnName\": \"SAN, Nan\",\n \"TelexCode\": \"300000000000\",\n \"Sex\": \"女F\",\n \"Birthday\": \"01-01-2001\",\n \"Permanent\": 1,\n \"IdNum\": \"C000000(E)\",\n \"Symbol\": \"***AZ\",\n \"FirstIssueDate\": \"(09-99)\",\n \"CurrentIssueDate\": \"23-09-10\",\n \"HeadImage\": \"\",\n \"WarnCardInfos\": [\n -9104\n ],\n \"RequestId\": \"fba1c9ad-aeb3-4418-9ecf-80ab1b5fc875\"\n }\n}",
240
240
  "title": "中国香港身份证识别示例代码"
241
241
  }
242
242
  ],
tccli/services/redis/v20180412/api.json CHANGED
@@ -337,7 +337,7 @@
337
337
  "status": "online"
338
338
  },
339
339
  "DescribeMaintenanceWindow": {
340
- "document": "查询实例维护时间窗，在实例需要进行版本升级或者架构升级的时候，会在维护时间窗时间内进行切换",
340
+ "document": "本接口（DescribeMaintenanceWindow）用于查询实例维护时间窗。在实例需要进行版本升级或者架构升级的时候，会在维护时间窗时间内进行切换",
341
341
  "input": "DescribeMaintenanceWindowRequest",
342
342
  "name": "查询实例维护时间窗",
343
343
  "output": "DescribeMaintenanceWindowResponse",
@@ -477,7 +477,7 @@
477
477
  "status": "online"
478
478
  },
479
479
  "InquiryPriceRenewInstance": {
480
- "document": "查询实例续费价格（包年包月）",
480
+ "document": "本接口（InquiryPriceRenewInstance）用于查询包年包月计费实例的续费价格。",
481
481
  "input": "InquiryPriceRenewInstanceRequest",
482
482
  "name": "查询实例续费价格（包年包月）",
483
483
  "output": "InquiryPriceRenewInstanceResponse",
@@ -840,7 +840,7 @@
840
840
  "example": "486489",
841
841
  "member": "int64",
842
842
  "name": "TaskId",
843
- "required": true,
843
+ "output_required": true,
844
844
  "type": "int",
845
845
  "value_allowed_null": false
846
846
  },
@@ -2343,7 +2343,7 @@
2343
2343
  "example": "486489",
2344
2344
  "member": "float",
2345
2345
  "name": "TaskId",
2346
- "required": true,
2346
+ "output_required": true,
2347
2347
  "type": "float",
2348
2348
  "value_allowed_null": false
2349
2349
  },
@@ -4668,8 +4668,8 @@
4668
4668
  "members": [
4669
4669
  {
4670
4670
  "disabled": false,
4671
- "document": "实例ID",
4672
- "example": "",
4671
+ "document": "指定实例 ID。例如：crs-xjhsdj****。请登录[Redis控制台](https://console.cloud.tencent.com/redis)在实例列表复制实例 ID。",
4672
+ "example": "crs-5a4py64p",
4673
4673
  "member": "string",
4674
4674
  "name": "InstanceId",
4675
4675
  "required": true,
@@ -4683,19 +4683,21 @@
4683
4683
  "members": [
4684
4684
  {
4685
4685
  "disabled": false,
4686
- "document": "维护时间窗起始时间，如：17:00",
4687
- "example": "",
4686
+ "document": "维护时间窗开始时间。取值范围为\"00:00-23:00\"的任意时间点，如03:24。",
4687
+ "example": "03:00",
4688
4688
  "member": "string",
4689
4689
  "name": "StartTime",
4690
+ "output_required": true,
4690
4691
  "type": "string",
4691
4692
  "value_allowed_null": false
4692
4693
  },
4693
4694
  {
4694
4695
  "disabled": false,
4695
- "document": "维护时间窗结束时间，如：19:00",
4696
- "example": "",
4696
+ "document": "维护时间窗结束时间。\n- 取值范围为\"00:00-23:00\"的任意时间点，如：04:24。\n- 维护时间持续时长最小为30分钟，最大为3小时。\n- 结束时间务必是基于开始时间向后的时间。",
4697
+ "example": "06:00",
4697
4698
  "member": "string",
4698
4699
  "name": "EndTime",
4700
+ "output_required": true,
4699
4701
  "type": "string",
4700
4702
  "value_allowed_null": false
4701
4703
  },
@@ -4868,7 +4870,7 @@
4868
4870
  "example": "无",
4869
4871
  "member": "RegionConf",
4870
4872
  "name": "RegionSet",
4871
- "required": true,
4873
+ "output_required": true,
4872
4874
  "type": "list",
4873
4875
  "value_allowed_null": false
4874
4876
  },
@@ -6169,7 +6171,7 @@
6169
6171
  "members": [
6170
6172
  {
6171
6173
  "disabled": false,
6172
- "document": "实例类型：2 – Redis2.8内存版(标准架构)，3 – CKV 3.2内存版(标准架构)，4 – CKV 3.2内存版(集群架构)，6 – Redis4.0内存版(标准架构)，7 – Redis4.0内存版(集群架构)，8 – Redis5.0内存版(标准架构)，9 – Redis5.0内存版(集群架构)。",
6174
+ "document": "实例类型。\n- 2：Redis 2.8 内存版（标准架构）。\n- 6：Redis 4.0 内存版（标准架构）。\n- 7：Redis 4.0 内存版（集群架构）。\n- 8：Redis 5.0 内存版（标准架构）。\n- 9：Redis 5.0 内存版（集群架构）。\n- 15：Redis 6.2 内存版（标准架构）。\n- 16：Redis 6.2 内存版（集群架构）。\n- 17：Redis 7.0 内存版（标准架构）。\n- 18：Redis 7.0 内存版（集群架构）。",
6173
6175
  "example": "6",
6174
6176
  "member": "uint64",
6175
6177
  "name": "TypeId",
@@ -6205,7 +6207,7 @@
6205
6207
  },
6206
6208
  {
6207
6209
  "disabled": false,
6208
- "document": "付费方式:0-按量计费，1-包年包月。",
6210
+ "document": "付费方式。\n- 0：按量计费。\n- 1：包年包月。",
6209
6211
  "example": "1",
6210
6212
  "member": "int64",
6211
6213
  "name": "BillingMode",
@@ -6223,7 +6225,7 @@
6223
6225
  },
6224
6226
  {
6225
6227
  "disabled": false,
6226
- "document": "实例分片数量，Redis2.8标准架构、CKV标准架构和Redis2.8单机版、Redis4.0标准架构不需要填写。",
6228
+ "document": "实例分片数量。\nRedis2.8标准架构、CKV标准架构、Redis4.0标准架构无需填写。",
6227
6229
  "example": "1",
6228
6230
  "member": "int64",
6229
6231
  "name": "RedisShardNum",
@@ -6232,7 +6234,7 @@
6232
6234
  },
6233
6235
  {
6234
6236
  "disabled": false,
6235
- "document": "实例副本数量，Redis2.8标准架构、CKV标准架构和Redis2.8单机版不需要填写。",
6237
+ "document": "实例副本数量。\nRedis2.8标准架构、CKV标准架构无需填写。",
6236
6238
  "example": "1",
6237
6239
  "member": "int64",
6238
6240
  "name": "RedisReplicasNum",
@@ -6241,7 +6243,7 @@
6241
6243
  },
6242
6244
  {
6243
6245
  "disabled": false,
6244
- "document": "是否支持副本只读，Redis2.8标准架构、CKV标准架构和Redis2.8单机版不需要填写。",
6246
+ "document": "是否支持副本只读。Redis2.8标准架构、CKV标准架构无需填写。\n- true：无需支持副本只读。\n- false：需支持。",
6245
6247
  "example": "false",
6246
6248
  "member": "bool",
6247
6249
  "name": "ReplicasReadonly",
@@ -6259,7 +6261,7 @@
6259
6261
  },
6260
6262
  {
6261
6263
  "disabled": false,
6262
- "document": "\"local\"本地盘版，\"cloud\"云盘版，\"cdc\"独享集群版，如果不传默认询价为本地盘版本",
6264
+ "document": "部署方式。\n- local：本地盘版，默认为 local。\n- cloud：云盘版。\n- cdc：独享集群版。",
6263
6265
  "example": "cloud",
6264
6266
  "member": "string",
6265
6267
  "name": "ProductVersion",
@@ -6278,7 +6280,7 @@
6278
6280
  "example": "30400",
6279
6281
  "member": "float",
6280
6282
  "name": "Price",
6281
- "required": true,
6283
+ "output_required": true,
6282
6284
  "type": "float",
6283
6285
  "value_allowed_null": true
6284
6286
  },
@@ -6296,8 +6298,8 @@
6296
6298
  "members": [
6297
6299
  {
6298
6300
  "disabled": false,
6299
- "document": "购买时长，单位：月",
6300
- "example": "",
6301
+ "document": "包年包月实例的购买时长，单位：月。",
6302
+ "example": "1",
6301
6303
  "member": "uint64",
6302
6304
  "name": "Period",
6303
6305
  "required": true,
@@ -6305,8 +6307,8 @@
6305
6307
  },
6306
6308
  {
6307
6309
  "disabled": false,
6308
- "document": "实例ID",
6309
- "example": "",
6310
+ "document": "指定实例 ID。例如：crs-xjhsdj****。请登录[Redis控制台](https://console.cloud.tencent.com/redis)在实例列表复制实例 ID。",
6311
+ "example": "crs-rhlppeye",
6310
6312
  "member": "string",
6311
6313
  "name": "InstanceId",
6312
6314
  "required": true,
@@ -6320,10 +6322,11 @@
6320
6322
  "members": [
6321
6323
  {
6322
6324
  "disabled": false,
6323
- "document": "价格，单位：分\n注意：此字段可能返回 null，表示取不到有效值。",
6324
- "example": "",
6325
+ "document": "价格，单位：分。\n注意：此字段可能返回 null，表示取不到有效值。",
6326
+ "example": "100800",
6325
6327
  "member": "float",
6326
6328
  "name": "Price",
6329
+ "output_required": true,
6327
6330
  "type": "float",
6328
6331
  "value_allowed_null": true
6329
6332
  },
@@ -6342,7 +6345,7 @@
6342
6345
  {
6343
6346
  "disabled": false,
6344
6347
  "document": "实例Id",
6345
- "example": "",
6348
+ "example": "crs-xjhsdjcxjd",
6346
6349
  "member": "string",
6347
6350
  "name": "InstanceId",
6348
6351
  "required": true,
@@ -6351,7 +6354,7 @@
6351
6354
  {
6352
6355
  "disabled": false,
6353
6356
  "document": "分片大小 单位 MB",
6354
- "example": "",
6357
+ "example": "4096",
6355
6358
  "member": "uint64",
6356
6359
  "name": "MemSize",
6357
6360
  "required": true,
@@ -6360,7 +6363,7 @@
6360
6363
  {
6361
6364
  "disabled": false,
6362
6365
  "document": "分片数量，Redis2.8主从版、CKV主从版和Redis2.8单机版不需要填写",
6363
- "example": "",
6366
+ "example": "3",
6364
6367
  "member": "uint64",
6365
6368
  "name": "RedisShardNum",
6366
6369
  "required": false,
@@ -6369,7 +6372,7 @@
6369
6372
  {
6370
6373
  "disabled": false,
6371
6374
  "document": "副本数量，Redis2.8主从版、CKV主从版和Redis2.8单机版不需要填写",
6372
- "example": "",
6375
+ "example": "1",
6373
6376
  "member": "uint64",
6374
6377
  "name": "RedisReplicasNum",
6375
6378
  "required": false,
@@ -6384,9 +6387,10 @@
6384
6387
  {
6385
6388
  "disabled": false,
6386
6389
  "document": "价格，单位：分\n注意：此字段可能返回 null，表示取不到有效值。",
6387
- "example": "",
6390
+ "example": "30400",
6388
6391
  "member": "float",
6389
6392
  "name": "Price",
6393
+ "output_required": true,
6390
6394
  "type": "float",
6391
6395
  "value_allowed_null": true
6392
6396
  },
tccli/services/redis/v20180412/examples.json CHANGED
@@ -392,10 +392,10 @@
392
392
  ],
393
393
  "DescribeMaintenanceWindow": [
394
394
  {
395
- "document": "",
396
- "input": "https://redis.tencentcloudapi.com/?Action=DescribeMaintenanceWindow\r\n&InstanceId=crs-5a4py64p\r\n&<公共请求参数>",
395
+ "document": "修改实例的维护时间窗为03:00-06:00",
396
+ "input": "https://redis.tencentcloudapi.com/?Action=DescribeMaintenanceWindow\n&InstanceId=crs-5a4p****\n&<公共请求参数>",
397
397
  "output": "{\n \"Response\": {\n \"StartTime\": \"03:00\",\n \"EndTime\": \"06:00\",\n \"RequestId\": \"0e728fa9-c2e5-4bf8-8d6b-c1c4fab7b6db\"\n }\n}",
398
- "title": "示例"
398
+ "title": "配置实例访问时间窗"
399
399
  }
400
400
  ],
401
401
  "DescribeParamTemplateInfo": [
@@ -416,7 +416,7 @@
416
416
  ],
417
417
  "DescribeProductInfo": [
418
418
  {
419
- "document": "",
419
+ "document": "查询示例",
420
420
  "input": "POST / HTTP/1.1\nHost: redis.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: DescribeProductInfo\n<公共请求参数>\n\n{}",
421
421
  "output": "{\n \"Response\": {\n \"RegionSet\": [\n {\n \"RegionId\": \"ap-guangzhou\",\n \"RegionName\": \"广州\",\n \"RegionShortName\": \"GZ\",\n \"Area\": \"华南地区\",\n \"ZoneSet\": [\n {\n \"ZoneId\": \"ap-guangzhou-2\",\n \"ZoneName\": \"广州二区\",\n \"IsSaleout\": false,\n \"IsDefault\": false,\n \"OldZoneId\": 0,\n \"NetWorkType\": [\n \"basenet\",\n \"vpcnet\"\n ],\n \"ProductSet\": [\n {\n \"Type\": 7,\n \"TypeName\": \"Redis 集群版\",\n \"MinBuyNum\": 1,\n \"MaxBuyNum\": 10,\n \"Saleout\": false,\n \"Engine\": \"社区版Redis\",\n \"Version\": \"Redis 4.0\",\n \"TotalSize\": [\n \"12\",\n \"20\",\n \"32\",\n \"64\",\n \"96\",\n \"128\",\n \"256\",\n \"384\",\n \"512\",\n \"768\",\n \"1024\",\n \"2048\",\n \"3072\",\n \"4096\"\n ],\n \"ShardSize\": [\n \"4\",\n \"8\",\n \"12\",\n \"16\",\n \"20\",\n \"24\",\n \"32\"\n ],\n \"ReplicaNum\": [\n \"1\",\n \"2\",\n \"3\",\n \"4\",\n \"5\"\n ],\n \"ShardNum\": [\n \"3\",\n \"5\",\n \"8\",\n \"12\",\n \"16\",\n \"24\",\n \"32\",\n \"40\",\n \"48\",\n \"64\",\n \"80\",\n \"96\",\n \"128\"\n ],\n \"PayMode\": \"1\",\n \"EnableRepicaReadOnly\": true\n },\n {\n \"Type\": 4,\n \"TypeName\": \"CKV集群版\",\n \"MinBuyNum\": 1,\n \"MaxBuyNum\": 10,\n \"Saleout\": false,\n \"Engine\": \"腾讯云CKV\",\n \"Version\": \"Redis 3.2\",\n \"TotalSize\": [\n \"12\",\n \"20\",\n \"32\",\n \"64\",\n \"96\",\n \"128\",\n \"256\",\n \"384\",\n \"512\",\n \"768\",\n \"1024\",\n \"2048\",\n \"3072\",\n \"4096\"\n ],\n \"ShardSize\": [\n \"4\",\n \"8\",\n \"16\",\n \"24\",\n \"32\",\n \"48\",\n \"64\",\n \"80\",\n \"96\",\n \"128\",\n \"160\",\n \"192\",\n \"256\",\n \"320\",\n \"384\"\n ],\n \"ReplicaNum\": [\n \"1\",\n \"2\",\n \"3\",\n \"4\",\n \"5\"\n ],\n \"ShardNum\": [\n \"3\",\n \"5\",\n \"8\",\n \"12\",\n \"16\",\n \"24\",\n \"32\",\n \"40\",\n \"48\",\n \"64\",\n \"80\",\n \"96\",\n \"128\"\n ],\n \"PayMode\": \"1\",\n \"EnableRepicaReadOnly\": false\n },\n {\n \"Type\": 2,\n \"TypeName\": \"Redis 主从版\",\n \"MinBuyNum\": 1,\n \"MaxBuyNum\": 10,\n \"Saleout\": false,\n \"Engine\": \"社区版Redis\",\n \"Version\": \"Redis 2.8\",\n \"TotalSize\": [\n \"1\",\n \"2\",\n \"4\",\n \"8\",\n \"12\",\n \"16\",\n \"20\",\n \"24\",\n \"32\",\n \"40\",\n \"48\",\n \"60\",\n \"0.25\"\n ],\n \"ShardSize\": [\n \"1\",\n \"2\",\n \"4\",\n \"8\",\n \"12\",\n \"16\",\n \"20\",\n \"24\",\n \"32\",\n \"40\",\n \"48\",\n \"60\",\n \"0.25\"\n ],\n \"ReplicaNum\": [\n \"1\"\n ],\n \"ShardNum\": [\n \"1\"\n ],\n \"PayMode\": \"1\",\n \"EnableRepicaReadOnly\": false\n },\n {\n \"Type\": 5,\n \"TypeName\": \"Redis 单机版\",\n \"MinBuyNum\": 1,\n \"MaxBuyNum\": 10,\n \"Saleout\": false,\n \"Engine\": \"社区版Redis\",\n \"Version\": \"Redis 2.8\",\n \"TotalSize\": [\n \"1\",\n \"2\",\n \"4\",\n \"8\",\n \"12\",\n \"16\",\n \"20\",\n \"24\",\n \"32\",\n \"40\",\n \"48\",\n \"60\"\n ],\n \"ShardSize\": [\n \"1\",\n \"2\",\n \"4\",\n \"8\",\n \"12\",\n \"16\",\n \"20\",\n \"24\",\n \"32\",\n \"40\",\n \"48\",\n \"60\"\n ],\n \"ReplicaNum\": [\n \"0\"\n ],\n \"ShardNum\": [\n \"1\"\n ],\n \"PayMode\": \"1\",\n \"EnableRepicaReadOnly\": false\n },\n {\n \"Type\": 2,\n \"TypeName\": \"Redis 主从版\",\n \"MinBuyNum\": 1,\n \"MaxBuyNum\": 10,\n \"Saleout\": false,\n \"Engine\": \"社区版Redis\",\n \"Version\": \"Redis 2.8\",\n \"TotalSize\": [\n \"1\",\n \"2\",\n \"4\",\n \"8\",\n \"12\",\n \"16\",\n \"20\",\n \"24\",\n \"32\",\n \"40\",\n \"48\",\n \"60\"\n ],\n \"ShardSize\": [\n \"1\",\n \"2\",\n \"4\",\n \"8\",\n \"12\",\n \"16\",\n \"20\",\n \"24\",\n \"32\",\n \"40\",\n \"48\",\n \"60\"\n ],\n \"ReplicaNum\": [\n \"1\"\n ],\n \"ShardNum\": [\n \"1\"\n ],\n \"PayMode\": \"0\",\n \"EnableRepicaReadOnly\": false\n },\n {\n \"Type\": 3,\n \"TypeName\": \"CKV单机版\",\n \"MinBuyNum\": 1,\n \"MaxBuyNum\": 10,\n \"Saleout\": false,\n \"Engine\": \"腾讯云CKV\",\n \"Version\": \"Redis 3.2\",\n \"TotalSize\": [\n \"4\",\n \"8\",\n \"16\",\n \"24\",\n \"32\",\n \"48\",\n \"64\",\n \"80\",\n \"96\",\n \"128\",\n \"160\",\n \"192\",\n \"256\",\n \"320\",\n \"384\"\n ],\n \"ShardSize\": [\n \"4\",\n \"8\",\n \"16\",\n \"24\",\n \"32\",\n \"48\",\n \"64\",\n \"80\",\n \"96\",\n \"128\",\n \"160\",\n \"192\",\n \"256\",\n \"320\",\n \"384\"\n ],\n \"ReplicaNum\": [\n \"0\"\n ],\n \"ShardNum\": [\n \"1\"\n ],\n \"PayMode\": \"1\",\n \"EnableRepicaReadOnly\": false\n }\n ]\n }\n ]\n }\n ],\n \"RequestId\": \"3c5730c6-02f2-46fd-8bf1-725b8b608fb9\"\n }\n}",
422
422
  "title": "请求示例"
@@ -552,16 +552,16 @@
552
552
  ],
553
553
  "InquiryPriceRenewInstance": [
554
554
  {
555
- "document": "",
556
- "input": "https://redis.tencentcloudapi.com/?Action=InquiryPriceRenewInstance\r\n&<公共请求参数>\r\n&Period=1\r\n&InstanceId=crs-qkdjynur",
555
+ "document": "查询续费价格",
556
+ "input": "https://redis.tencentcloudapi.com/?Action=InquiryPriceRenewInstance\n&Period=1\n&InstanceId=crs-qkdj****\n&<公共请求参数>",
557
557
  "output": "{\n \"Response\": {\n \"Price\": 100800,\n \"RequestId\": \"4bd77cc7-ece7-4660-bbdd-6892d96f35a1\"\n }\n}",
558
- "title": "示例"
558
+ "title": "查询示例"
559
559
  }
560
560
  ],
561
561
  "InquiryPriceUpgradeInstance": [
562
562
  {
563
563
  "document": "",
564
- "input": "https://redis.tencentcloudapi.com/?Action=InquiryPriceUpgradeInstance\r\n&<公共请求参数>\r\n&InstanceId=crs-xjhsdjcxjd\r\n&MemSize=4096",
564
+ "input": "https://redis.tencentcloudapi.com/?Action=InquiryPriceUpgradeInstance\n&InstanceId=crs-xjhsdjcxjd\n&MemSize=4096\n&<公共请求参数>",
565
565
  "output": "{\n \"Response\": {\n \"Price\": 30400,\n \"RequestId\": \"0115d979-2c38-4ad2-b282-bec09d5b4c01\"\n }\n}",
566
566
  "title": "示例"
567
567
  }