tccli 3.0.1330.1__py2.py3-none-any.whl → 3.0.1331.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 (36) hide show
  1. tccli/__init__.py +1 -1
  2. tccli/services/ccc/ccc_client.py +53 -0
  3. tccli/services/ccc/v20200210/api.json +71 -2
  4. tccli/services/ccc/v20200210/examples.json +8 -0
  5. tccli/services/cdn/v20180606/api.json +3 -3
  6. tccli/services/cdn/v20180606/examples.json +3 -3
  7. tccli/services/clb/v20180317/api.json +18 -0
  8. tccli/services/dbbrain/v20210527/api.json +1 -0
  9. tccli/services/dnspod/dnspod_client.py +106 -0
  10. tccli/services/dnspod/v20210323/api.json +509 -2
  11. tccli/services/dnspod/v20210323/examples.json +17 -1
  12. tccli/services/ess/v20201111/api.json +2 -2
  13. tccli/services/essbasic/v20210526/api.json +3 -3
  14. tccli/services/faceid/v20180301/api.json +4 -4
  15. tccli/services/ioa/ioa_client.py +53 -0
  16. tccli/services/ioa/v20220601/api.json +166 -1
  17. tccli/services/ioa/v20220601/examples.json +14 -0
  18. tccli/services/iotexplorer/v20190423/api.json +7 -7
  19. tccli/services/iotexplorer/v20190423/examples.json +1 -1
  20. tccli/services/lke/lke_client.py +383 -12
  21. tccli/services/lke/v20231130/api.json +615 -0
  22. tccli/services/lke/v20231130/examples.json +56 -0
  23. tccli/services/lowcode/v20210108/api.json +41 -1
  24. tccli/services/lowcode/v20210108/examples.json +2 -2
  25. tccli/services/ocr/ocr_client.py +532 -320
  26. tccli/services/ocr/v20181119/api.json +541 -4
  27. tccli/services/ocr/v20181119/examples.json +32 -0
  28. tccli/services/sms/v20190711/api.json +4 -4
  29. tccli/services/sms/v20210111/api.json +4 -4
  30. tccli/services/teo/v20220901/api.json +1 -1
  31. tccli/services/trtc/v20190722/api.json +2 -2
  32. {tccli-3.0.1330.1.dist-info → tccli-3.0.1331.1.dist-info}/METADATA +2 -2
  33. {tccli-3.0.1330.1.dist-info → tccli-3.0.1331.1.dist-info}/RECORD +36 -36
  34. {tccli-3.0.1330.1.dist-info → tccli-3.0.1331.1.dist-info}/WHEEL +0 -0
  35. {tccli-3.0.1330.1.dist-info → tccli-3.0.1331.1.dist-info}/entry_points.txt +0 -0
  36. {tccli-3.0.1330.1.dist-info → tccli-3.0.1331.1.dist-info}/license_files/LICENSE +0 -0
@@ -2155,7 +2155,7 @@
2155
2155
  },
2156
2156
  {
2157
2157
  "disabled": false,
2158
- "document": "\n**在所有的定位方式下**,控件的扩展参数,为<font color=\"red\">JSON格式</font>,不同类型的控件会有部分非通用参数。\n\n<font color=\"red\">ComponentType为TEXT、MULTI_LINE_TEXT时</font>,支持以下参数:\n<ul><li> <b>Font</b>:目前只支持黑体、宋体、仿宋</li>\n<li> <b>FontSize</b>: 范围6 :72</li>\n<li> <b>FontAlign</b>: Left/Right/Center,左对齐/居中/右对齐</li>\n<li> <b>FontColor</b>:字符串类型,格式为RGB颜色数字</li></ul>\n<b>参数样例</b>:`{\"FontColor\":\"255,0,0\",\"FontSize\":12}`\n\n<font color=\"red\">ComponentType为DATE时</font>,支持以下参数:\n<ul><li> <b>Font</b>:目前只支持黑体、宋体、仿宋</li>\n<li> <b>FontSize</b>: 范围6 :72</li></ul>\n<b>参数样例</b>:`{\"FontColor\":\"255,0,0\",\"FontSize\":12}`\n\n<font color=\"red\">ComponentType为WATERMARK时</font>,支持以下参数:\n<ul><li> <b>Font</b>:目前只支持黑体、宋体、仿宋</li>\n<li> <b>FontSize</b>: 范围6 :24</li>\n<li> <b>Opacity</b>: 透明度,范围0 :1</li>\n<li> <b>Density</b>: 水印样式,1-宽松,2-标准(默认值),3-密集,</li>\n<li> <b>SubType</b>: 水印类型:CUSTOM_WATERMARK-自定义内容,PERSON_INFO_WATERMARK-访问者信息</li></ul>\n<b>参数样例</b>:`\"{\\\"Font\\\":\\\"黑体\\\",\\\"FontSize\\\":20,\\\"Opacity\\\":0.1,\\\"Density\\\":2,\\\"SubType\\\":\\\"PERSON_INFO_WATERMARK\\\"}\"`\n\n<font color=\"red\">ComponentType为FILL_IMAGE时</font>,支持以下参数:\n<ul><li> <b>NotMakeImageCenter</b>:bool。是否设置图片居中。false:居中(默认)。 true : 不居中</li>\n<li> <b>FillMethod</b> : int. 填充方式。0-铺满(默认);1-等比例缩放</li></ul>\n\n<font color=\"red\">ComponentType为SIGN_SIGNATURE、SIGN_PAGING_SIGNATURE类型时</font>,可以通过**ComponentTypeLimit**参数控制签名方式\n<ul><li> <b>HANDWRITE</b> : 需要实时手写的手写签名</li>\n<li> <b>HANDWRITTEN_ESIGN</b> : 长效手写签名, 是使用保存到个人中心的印章列表的手写签名(并且包含HANDWRITE)</li>\n<li> <b>OCR_ESIGN</b> : AI智能识别手写签名</li>\n<li> <b>ESIGN</b> : 个人印章类型</li>\n<li> <b>SYSTEM_ESIGN</b> : 系统签名(该类型可以在用户签署时根据用户姓名一键生成一个签名来进行签署)</li>\n<li> <b>IMG_ESIGN</b> : 图片印章(该类型支持用户在签署将上传的PNG格式的图片作为签名)</li></ul>\n<b>参考样例</b>:`{\"ComponentTypeLimit\": [\"SYSTEM_ESIGN\"]}`\n印章的对应关系参考下图\n![image](https://qcloudimg.tencent-cloud.cn/raw/ee0498856c060c065628a0c5ba780d6b.jpg)<br><br>\n\n<font color=\"red\">ComponentType为SIGN_SEAL 或者 SIGN_PAGING_SEAL类型时</font>,可以通过**ComponentTypeLimit**参数控制签署方签署时要使用的印章类型,支持指定以下印章类型\n<ul><li> <b>OFFICIAL</b> : 企业公章</li>\n<li> <b>CONTRACT</b> : 合同专用章</li>\n<li> <b>FINANCE</b> : 财务专用章</li>\n<li> <b>PERSONNEL</b> : 人事专用章</li>\n<li> <b>OTHER</b> : 其他</li>\n</ul>\n<b>参考样例</b>:`{\\\"ComponentTypeLimit\\\":[\\\"PERSONNEL\\\",\\\"FINANCE\\\"]}` 表示改印章签署区,客户需使用人事专用章或财务专用章盖章签署。<br><br>\n\n<font color=\"red\">ComponentType为SIGN_DATE时</font>,支持以下参数:\n<ul><li> <b>Font</b> :字符串类型目前只支持\"黑体\"、\"宋体\"、\"仿宋\",如果不填默认为\"黑体\"</li>\n<li> <b>FontSize</b> : 数字类型,范围6-72,默认值为12</li>\n<li> <b>FontAlign</b> : 字符串类型,可取Left/Right/Center,对应左对齐/居中/右对齐</li>\n<li> <b>Format</b> : 字符串类型,日期格式,必须是以下五种之一 “yyyy m d”,”yyyy年m月d日”,”yyyy/m/d”,”yyyy-m-d”,”yyyy.m.d”。</li>\n<li> <b>Gaps</b> : 字符串类型,仅在Format为“yyyy m d”时起作用,格式为用逗号分开的两个整数,例如”2,2”,两个数字分别是日期格式的前后两个空隙中的空格个数</li></ul>\n如果extra参数为空,默认为”yyyy年m月d日”格式的居中日期\n特别地,如果extra中Format字段为空或无法被识别,则extra参数会被当作默认值处理(Font,FontSize,Gaps和FontAlign都不会起效)\n<b>参数样例</b>: ` \"{\"Format\":\"yyyy m d\",\"FontSize\":12,\"Gaps\":\"2,2\", \"FontAlign\":\"Right\"}\"`\n\n<font color=\"red\">ComponentType为SIGN_SEAL、SIGN_SIGNATURE类型时</font>,支持以下参数:\n<ul><li> <b>PageRanges</b> :PageRange的数组,通过PageRanges属性设置该印章在PDF所有页面上盖章(适用于标书在所有页面盖章的情况)</li></ul>\n<b>参数样例</b>:` \"{\"PageRanges\":[{\"BeginPage\":1,\"EndPage\":-1}]}\"`\n\n<font color=\"red\">签署印章透明度功能设置,</font>当ComponentType为SIGN_SIGNATURE、SIGN_SEAL、SIGN_PAGING_SEAL、SIGN_LEGAL_PERSON_SEAL时,可以通过以下参数设置签署印章的透明度:\n<ul><li> <b>Opacity</b>:印章透明度,支持范围:0.6-1,0.7表示70%的透明度,1表示无透明度</li></ul>\n<b>参数样例</b>:`{\"Opacity\":0.7}`\n\n<font color=\"red\">签署印章大小功能设置,</font>当ComponentType为SIGN_SEAL、SIGN_PAGING_SEAL、SIGN_LEGAL_PERSON_SEAL时,可以通过以下参数设置签署时按照实际印章的大小进行签署,如果印章没有设置大小,那么默认会是4.2cm的印章大小:\n<ul><li> <b>UseSealSize</b>:使用印章设置的大小盖章,true表示使用印章设置的大小盖章,false表示使用签署控件的大小进行盖章;不传则为false</li></ul>\n<b>参数样例</b>:`{\"UseSealSize\":true}`\n\n<font color=\"red\">关键字模式下支持关键字找不到的情况下不进行报错的设置</font>\n<ul><li> <b>IgnoreKeywordError</b> :1-关键字查找不到时不进行报错</li></ul>\n场景说明:如果使用关键字进行定位,但是指定的PDF文件中又没有设置的关键字时,发起合同会进行关键字是否存在的校验,如果关键字不存在,会进行报错返回。如果不希望进行报错,可以设置\"IgnoreKeywordError\"来忽略错误。请注意,如果关键字签署控件对应的签署方在整个PDF文件中一个签署控件都没有,还是会触发报错逻辑。\n<b>参数样例</b>:` \"{\"IgnoreKeywordError\":1}\"`\n\n<font color=\"red\">ComponentType为SIGN_VIRTUAL_COMBINATION时</font>,支持以下参数:\n<ul>\n<li><b>Children:</b> 绝对定位模式下,用来指定此签批控件的组合子控件 </li>\n<b>参数样例</b>:<br>`{\"Children\":[\"ComponentId_29\",\"ComponentId_27\",\"ComponentId_28\",\"ComponentId_30\"]}`\n<li><b>ChildrenComponents:</b> 关键字定位模式下,用来指定此签批控件的组合子控件 </li>\nChildrenComponent结构体定义:\n<table border=\"1\"> <thead> <tr> <th>字段名称</th> <th>类型</th> <th>描述</th> </tr> </thead> <tbody> <tr> <td>ComponentType</td> <td>string</td> <td>子控件类型-可选值:SIGN_SIGNATURE,SIGN_DATE,SIGN_SELECTOR,SIGN_MULTI_LINE_TEXT</td> </tr> <tr> <td>ComponentName</td> <td>string</td> <td>子控件名称</td> </tr> <tr> <td>Placeholder</td> <td>string</td> <td>子控件提示语</td> </tr> <tr> <td>ComponentOffsetX</td> <td>float</td> <td>控件偏移位置X(相对于父控件(签批控件的ComponentX))</td> </tr> <tr> <td>ComponentOffsetY</td> <td>float</td> <td>控件偏移位置Y 相对于父控件(签批控件的ComponentY))</td> </tr> <tr> <td>ComponentWidth</td> <td>float</td> <td>控件宽</td> </tr> <tr> <td>ComponentHeight</td> <td>float</td> <td>控件高</td> </tr> <tr> <td>ComponentExtra</td> <td>string</td> <td>控件的附属信息,根据ComponentType设置</td> </tr> </tbody> </table>\n<b>参数样例</b>:\n \n输入:\n<pre>\n{\n ChildrenComponents: [\n {\n ComponentType: SIGN_SIGNATURE,\n ComponentName: 个人签名,\n Placeholder: 请签名,\n ComponentOffsetX: 10,\n ComponentOffsetY: 30,\n ComponentWidth: 119,\n ComponentHeight: 43,\n ComponentExtra: {\\ComponentTypeLimit\\:[\\SYSTEM_ESIGN\\]}\n },\n {\n ComponentType: SIGN_SELECTOR,\n ComponentName: 是否同意此协议,\n Placeholder: ,\n ComponentOffsetX: 50,\n ComponentOffsetY: 130,\n ComponentWidth: 120,\n ComponentHeight: 43,\n ComponentExtra: {\\Values\\:[\\同意\\,\\不同意\\,\\再想想\\],\\FontSize\\:12,\\FontAlign\\:\\Left\\,\\Font\\:\\黑体\\,\\MultiSelect\\:false}\n },\n {\n ComponentType: SIGN_MULTI_LINE_TEXT,\n ComponentName: 批注附言,\n Placeholder: ,\n ComponentOffsetX: 150,\n ComponentOffsetY: 300,\n ComponentWidth: 200,\n ComponentHeight: 86,\n ComponentExtra: \n }\n ]\n}\n</pre>\n</ul>\n\n",
2158
+ "document": "\n**在所有的定位方式下**,控件的扩展参数,为<font color=\"red\">JSON格式</font>,不同类型的控件会有部分非通用参数。\n\n<font color=\"red\">ComponentType为TEXT、MULTI_LINE_TEXT时</font>,支持以下参数:\n<ul><li> <b>Font</b>:目前只支持黑体、宋体、仿宋</li>\n<li> <b>FontSize</b>: 范围6 :72</li>\n<li> <b>FontAlign</b>: Left/Right/Center,左对齐/居中/右对齐</li>\n<li> <b>FontColor</b>:字符串类型,格式为RGB颜色数字</li></ul>\n<b>参数样例</b>:`{\"FontColor\":\"255,0,0\",\"FontSize\":12}`\n\n<font color=\"red\">ComponentType为DATE时</font>,支持以下参数:\n<ul><li> <b>Font</b>:目前只支持黑体、宋体、仿宋</li>\n<li> <b>FontSize</b>: 范围6 :72</li></ul>\n<b>参数样例</b>:`{\"FontColor\":\"255,0,0\",\"FontSize\":12}`\n\n<font color=\"red\">ComponentType为WATERMARK时</font>,支持以下参数:\n<ul><li> <b>Font</b>:目前只支持黑体、宋体、仿宋</li>\n<li> <b>FontSize</b>: 范围6 :24</li>\n<li> <b>Opacity</b>: 透明度,范围0 :1</li>\n<li> <b>Density</b>: 水印样式,1-宽松,2-标准(默认值),3-密集,</li>\n<li> <b>SubType</b>: 水印类型:CUSTOM_WATERMARK-自定义内容,PERSON_INFO_WATERMARK-访问者信息</li></ul>\n<b>参数样例</b>:`\"{\\\"Font\\\":\\\"黑体\\\",\\\"FontSize\\\":20,\\\"Opacity\\\":0.1,\\\"Density\\\":2,\\\"SubType\\\":\\\"PERSON_INFO_WATERMARK\\\"}\"`\n\n<font color=\"red\">ComponentType为FILL_IMAGE时</font>,支持以下参数:\n<ul><li> <b>NotMakeImageCenter</b>:bool。是否设置图片居中。false:居中(默认)。 true : 不居中</li>\n<li> <b>FillMethod</b> : int. 填充方式。0-铺满(默认);1-等比例缩放</li></ul>\n\n<font color=\"red\">ComponentType为SELECTOR时</font>,支持以下参数:\n<ul><li> <b>WordWrap</b>:bool。是否支持选择控件内容自动折行合成。false:不支持(默认)。 true : 支持自动折行合成</li>\n</ul>\n\n<font color=\"red\">ComponentType为SIGN_SIGNATURE、SIGN_PAGING_SIGNATURE类型时</font>,可以通过**ComponentTypeLimit**参数控制签名方式\n<ul><li> <b>HANDWRITE</b> : 需要实时手写的手写签名</li>\n<li> <b>HANDWRITTEN_ESIGN</b> : 长效手写签名, 是使用保存到个人中心的印章列表的手写签名(并且包含HANDWRITE)</li>\n<li> <b>OCR_ESIGN</b> : AI智能识别手写签名</li>\n<li> <b>ESIGN</b> : 个人印章类型</li>\n<li> <b>SYSTEM_ESIGN</b> : 系统签名(该类型可以在用户签署时根据用户姓名一键生成一个签名来进行签署)</li>\n<li> <b>IMG_ESIGN</b> : 图片印章(该类型支持用户在签署将上传的PNG格式的图片作为签名)</li></ul>\n<b>参考样例</b>:`{\"ComponentTypeLimit\": [\"SYSTEM_ESIGN\"]}`\n印章的对应关系参考下图\n![image](https://qcloudimg.tencent-cloud.cn/raw/ee0498856c060c065628a0c5ba780d6b.jpg)<br><br>\n\n<font color=\"red\">ComponentType为SIGN_SEAL 或者 SIGN_PAGING_SEAL类型时</font>,可以通过**ComponentTypeLimit**参数控制签署方签署时要使用的印章类型,支持指定以下印章类型\n<ul><li> <b>OFFICIAL</b> : 企业公章</li>\n<li> <b>CONTRACT</b> : 合同专用章</li>\n<li> <b>FINANCE</b> : 财务专用章</li>\n<li> <b>PERSONNEL</b> : 人事专用章</li>\n<li> <b>OTHER</b> : 其他</li>\n</ul>\n<b>参考样例</b>:`{\\\"ComponentTypeLimit\\\":[\\\"PERSONNEL\\\",\\\"FINANCE\\\"]}` 表示改印章签署区,客户需使用人事专用章或财务专用章盖章签署。<br><br>\n\n<font color=\"red\">ComponentType为SIGN_DATE时</font>,支持以下参数:\n<ul><li> <b>Font</b> :字符串类型目前只支持\"黑体\"、\"宋体\"、\"仿宋\",如果不填默认为\"黑体\"</li>\n<li> <b>FontSize</b> : 数字类型,范围6-72,默认值为12</li>\n<li> <b>FontAlign</b> : 字符串类型,可取Left/Right/Center,对应左对齐/居中/右对齐</li>\n<li> <b>Format</b> : 字符串类型,日期格式,必须是以下五种之一 “yyyy m d”,”yyyy年m月d日”,”yyyy/m/d”,”yyyy-m-d”,”yyyy.m.d”。</li>\n<li> <b>Gaps</b> : 字符串类型,仅在Format为“yyyy m d”时起作用,格式为用逗号分开的两个整数,例如”2,2”,两个数字分别是日期格式的前后两个空隙中的空格个数</li></ul>\n如果extra参数为空,默认为”yyyy年m月d日”格式的居中日期\n特别地,如果extra中Format字段为空或无法被识别,则extra参数会被当作默认值处理(Font,FontSize,Gaps和FontAlign都不会起效)\n<b>参数样例</b>: ` \"{\"Format\":\"yyyy m d\",\"FontSize\":12,\"Gaps\":\"2,2\", \"FontAlign\":\"Right\"}\"`\n\n<font color=\"red\">ComponentType为SIGN_SEAL、SIGN_SIGNATURE类型时</font>,支持以下参数:\n<ul><li> <b>PageRanges</b> :PageRange的数组,通过PageRanges属性设置该印章在PDF所有页面上盖章(适用于标书在所有页面盖章的情况)</li></ul>\n<b>参数样例</b>:` \"{\"PageRanges\":[{\"BeginPage\":1,\"EndPage\":-1}]}\"`\n\n<font color=\"red\">签署印章透明度功能设置,</font>当ComponentType为SIGN_SIGNATURE、SIGN_SEAL、SIGN_PAGING_SEAL、SIGN_LEGAL_PERSON_SEAL时,可以通过以下参数设置签署印章的透明度:\n<ul><li> <b>Opacity</b>:印章透明度,支持范围:0.6-1,0.7表示70%的透明度,1表示无透明度</li></ul>\n<b>参数样例</b>:`{\"Opacity\":0.7}`\n\n<font color=\"red\">签署印章大小功能设置,</font>当ComponentType为SIGN_SEAL、SIGN_PAGING_SEAL、SIGN_LEGAL_PERSON_SEAL时,可以通过以下参数设置签署时按照实际印章的大小进行签署,如果印章没有设置大小,那么默认会是4.2cm的印章大小:\n<ul><li> <b>UseSealSize</b>:使用印章设置的大小盖章,true表示使用印章设置的大小盖章,false表示使用签署控件的大小进行盖章;不传则为false</li></ul>\n<b>参数样例</b>:`{\"UseSealSize\":true}`\n\n<font color=\"red\">关键字模式下支持关键字找不到的情况下不进行报错的设置</font>\n<ul><li> <b>IgnoreKeywordError</b> :1-关键字查找不到时不进行报错</li></ul>\n场景说明:如果使用关键字进行定位,但是指定的PDF文件中又没有设置的关键字时,发起合同会进行关键字是否存在的校验,如果关键字不存在,会进行报错返回。如果不希望进行报错,可以设置\"IgnoreKeywordError\"来忽略错误。请注意,如果关键字签署控件对应的签署方在整个PDF文件中一个签署控件都没有,还是会触发报错逻辑。\n<b>参数样例</b>:` \"{\"IgnoreKeywordError\":1}\"`\n\n<font color=\"red\">ComponentType为SIGN_VIRTUAL_COMBINATION时</font>,支持以下参数:\n<ul>\n<li><b>Children:</b> 绝对定位模式下,用来指定此签批控件的组合子控件 </li>\n<b>参数样例</b>:<br>`{\"Children\":[\"ComponentId_29\",\"ComponentId_27\",\"ComponentId_28\",\"ComponentId_30\"]}`\n<li><b>ChildrenComponents:</b> 关键字定位模式下,用来指定此签批控件的组合子控件 </li>\nChildrenComponent结构体定义:\n<table border=\"1\"> <thead> <tr> <th>字段名称</th> <th>类型</th> <th>描述</th> </tr> </thead> <tbody> <tr> <td>ComponentType</td> <td>string</td> <td>子控件类型-可选值:SIGN_SIGNATURE,SIGN_DATE,SIGN_SELECTOR,SIGN_MULTI_LINE_TEXT</td> </tr> <tr> <td>ComponentName</td> <td>string</td> <td>子控件名称</td> </tr> <tr> <td>Placeholder</td> <td>string</td> <td>子控件提示语</td> </tr> <tr> <td>ComponentOffsetX</td> <td>float</td> <td>控件偏移位置X(相对于父控件(签批控件的ComponentX))</td> </tr> <tr> <td>ComponentOffsetY</td> <td>float</td> <td>控件偏移位置Y 相对于父控件(签批控件的ComponentY))</td> </tr> <tr> <td>ComponentWidth</td> <td>float</td> <td>控件宽</td> </tr> <tr> <td>ComponentHeight</td> <td>float</td> <td>控件高</td> </tr> <tr> <td>ComponentExtra</td> <td>string</td> <td>控件的附属信息,根据ComponentType设置</td> </tr> </tbody> </table>\n<b>参数样例</b>:\n \n输入:\n<pre>\n{\n ChildrenComponents: [\n {\n ComponentType: SIGN_SIGNATURE,\n ComponentName: 个人签名,\n Placeholder: 请签名,\n ComponentOffsetX: 10,\n ComponentOffsetY: 30,\n ComponentWidth: 119,\n ComponentHeight: 43,\n ComponentExtra: {\\ComponentTypeLimit\\:[\\SYSTEM_ESIGN\\]}\n },\n {\n ComponentType: SIGN_SELECTOR,\n ComponentName: 是否同意此协议,\n Placeholder: ,\n ComponentOffsetX: 50,\n ComponentOffsetY: 130,\n ComponentWidth: 120,\n ComponentHeight: 43,\n ComponentExtra: {\\Values\\:[\\同意\\,\\不同意\\,\\再想想\\],\\FontSize\\:12,\\FontAlign\\:\\Left\\,\\Font\\:\\黑体\\,\\MultiSelect\\:false}\n },\n {\n ComponentType: SIGN_MULTI_LINE_TEXT,\n ComponentName: 批注附言,\n Placeholder: ,\n ComponentOffsetX: 150,\n ComponentOffsetY: 300,\n ComponentWidth: 200,\n ComponentHeight: 86,\n ComponentExtra: \n }\n ]\n}\n</pre>\n</ul>\n",
2159
2159
  "example": "{\"FontColor\":\"255,0,0\",\"FontSize\":12}",
2160
2160
  "member": "string",
2161
2161
  "name": "ComponentExtra",
@@ -3010,7 +3010,7 @@
3010
3010
  },
3011
3011
  {
3012
3012
  "disabled": false,
3013
- "document": "是否允许此链接中签署方批量确认已读文件。 <ul><li>false (默认): 批量确认已读文件。</li> <li>true : 允许批量确认已读文件。</li></ul>注:`1. 此功能为白名单功能,使用前请联系对应客户经理进行开通。2. 使用此功能时,FlowIds参数必传。3. 对于企业签署方,如果有签名控件,则会使用用户首次选择的签名类型签署所有含有签名控件的合同。`",
3013
+ "document": "是否允许此链接中签署方批量确认已读文件。 <ul><li>false (默认): 不允许批量确认已读文件。</li> <li>true : 允许批量确认已读文件。</li></ul>注:`1. 此功能为白名单功能,使用前请联系对应客户经理进行开通。2. 使用此功能时,FlowIds参数必传。3. 对于企业签署方,如果有签名控件,则会使用用户首次选择的签名类型签署所有含有签名控件的合同。`",
3014
3014
  "example": "false",
3015
3015
  "member": "bool",
3016
3016
  "name": "CanSkipReadFlow",
@@ -2096,7 +2096,7 @@
2096
2096
  },
2097
2097
  {
2098
2098
  "disabled": false,
2099
- "document": "是否允许此链接中签署方批量确认已读文件。 <ul><li>false (默认): 批量确认已读文件。</li> <li>true : 允许批量确认已读文件。</li></ul>注:`1. 此功能为白名单功能,使用前请联系对应客户经理进行开通。2. 使用此功能时,FlowIds参数必传。3. 对于企业签署方,如果有签名控件,则会使用用户首次选择的签名类型签署所有含有签名控件的合同。`",
2099
+ "document": "是否允许此链接中签署方批量确认已读文件。 <ul><li>false (默认): 不允许批量确认已读文件。</li> <li>true : 允许批量确认已读文件。</li></ul>注:`1. 此功能为白名单功能,使用前请联系对应客户经理进行开通。2. 使用此功能时,FlowIds参数必传。3. 对于企业签署方,如果有签名控件,则会使用用户首次选择的签名类型签署所有含有签名控件的合同。`",
2100
2100
  "example": "false",
2101
2101
  "member": "bool",
2102
2102
  "name": "CanSkipReadFlow",
@@ -3472,7 +3472,7 @@
3472
3472
  {
3473
3473
  "disabled": false,
3474
3474
  "document": "资源类型,取值有: <ul><li> **1**:模板</li> <li> **2**:文件</li></ul>",
3475
- "example": "1",
3475
+ "example": "2",
3476
3476
  "member": "int64",
3477
3477
  "name": "ResourceType",
3478
3478
  "required": true,
@@ -6281,7 +6281,7 @@
6281
6281
  },
6282
6282
  {
6283
6283
  "disabled": false,
6284
- "document": "**在所有的定位方式下**,控件的扩展参数,为<font color=\"red\">JSON格式</font>,不同类型的控件会有部分非通用参数。\n\n<font color=\"red\">ComponentType为TEXT、MULTI_LINE_TEXT时</font>,支持以下参数:\n<ul><li> <b>Font</b>:目前只支持黑体、宋体、仿宋</li>\n<li> <b>FontSize</b>: 范围6 :72</li>\n<li> <b>FontAlign</b>: Left/Right/Center,左对齐/居中/右对齐</li>\n<li> <b>FontColor</b>:字符串类型,格式为RGB颜色数字</li></ul>\n<b>参数样例</b>:`{\"FontColor\":\"255,0,0\",\"FontSize\":12}`\n\n<font color=\"red\">ComponentType为DATE时</font>,支持以下参数:\n<ul><li> <b>Font</b>:目前只支持黑体、宋体、仿宋</li>\n<li> <b>FontSize</b>: 范围6 :72</li></ul>\n<b>参数样例</b>:`{\"FontColor\":\"255,0,0\",\"FontSize\":12}`\n\n<font color=\"red\">ComponentType为FILL_IMAGE时</font>,支持以下参数:\n<ul><li> <b>NotMakeImageCenter</b>:bool。是否设置图片居中。false:居中(默认)。 true : 不居中</li>\n<li> <b>FillMethod</b> : int. 填充方式。0-铺满(默认);1-等比例缩放</li></ul>\n\n<font color=\"red\">ComponentType为SIGN_SIGNATURE、SIGN_PAGING_SIGNATURE类型时</font>,可以**ComponentTypeLimit**参数控制签署方式\n<ul><li> <b>HANDWRITE</b> : 需要实时手写的手写签名</li>\n<li> <b>HANDWRITTEN_ESIGN</b> : 长效手写签名, 是使用保存到个人中心的印章列表的手写签名(并且包含HANDWRITE)</li>\n<li> <b>OCR_ESIGN</b> : AI智能识别手写签名</li>\n<li> <b>ESIGN</b> : 个人印章类型</li>\n<li> <b>SYSTEM_ESIGN</b> : 系统签名(该类型可以在用户签署时根据用户姓名一键生成一个签名来进行签署)</li>\n<li> <b>IMG_ESIGN</b> : 图片印章(该类型支持用户在签署将上传的PNG格式的图片作为签名)</li></ul>\n<b>参考样例</b>:`{\"ComponentTypeLimit\": [\"SYSTEM_ESIGN\"]}`\n印章的对应关系参考下图\n![image](https://qcloudimg.tencent-cloud.cn/raw/ee0498856c060c065628a0c5ba780d6b.jpg)<br><br>\n<font color=\"red\">ComponentType为SIGN_SEAL 或者 SIGN_PAGING_SEAL类型时</font>,可以通过**ComponentTypeLimit**参数控制签署方签署时要使用的印章类型,支持指定以下印章类型\n<ul><li> <b>OFFICIAL</b> : 企业公章</li>\n<li> <b>CONTRACT</b> : 合同专用章</li>\n<li> <b>FINANCE</b> : 财务专用章</li>\n<li> <b>PERSONNEL</b> : 人事专用章</li>\n<li> <b>OTHER</b> : 其他</li>\n</ul>\n<b>参考样例</b>:`{\\\"ComponentTypeLimit\\\":[\\\"PERSONNEL\\\",\\\"FINANCE\\\"]}` 表示改印章签署区,客户需使用人事专用章或财务专用章盖章签署。<br><br>\n\n<font color=\"red\">ComponentType为SIGN_DATE时</font>,支持以下参数:\n<ul><li> <b>Font</b> :字符串类型目前只支持\"黑体\"、\"宋体\"、仿宋,如果不填默认为\"黑体\"</li>\n<li> <b>FontSize</b> : 数字类型,范围6-72,默认值为12</li>\n<li> <b>FontAlign</b> : 字符串类型,可取Left/Right/Center,对应左对齐/居中/右对齐</li>\n<li> <b>Format</b> : 字符串类型,日期格式,必须是以下五种之一 “yyyy m d”,”yyyy年m月d日”,”yyyy/m/d”,”yyyy-m-d”,”yyyy.m.d”。</li>\n<li> <b>Gaps</b> : 字符串类型,仅在Format为“yyyy m d”时起作用,格式为用逗号分开的两个整数,例如”2,2”,两个数字分别是日期格式的前后两个空隙中的空格个数</li></ul>\n如果extra参数为空,默认为”yyyy年m月d日”格式的居中日期\n特别地,如果extra中Format字段为空或无法被识别,则extra参数会被当作默认值处理(Font,FontSize,Gaps和FontAlign都不会起效)\n<b>参数样例</b>: ` \"{\"Format\":\"yyyy m d\",\"FontSize\":12,\"Gaps\":\"2,2\", \"FontAlign\":\"Right\"}\"`\n\n<font color=\"red\">ComponentType为SIGN_SEAL、SIGN_SIGNATURE类型时</font>,支持以下参数:\n<ul><li> <b>PageRanges</b> :PageRange的数组,通过PageRanges属性设置该印章在PDF所有页面上盖章(适用于标书在所有页面盖章的情况)</li></ul>\n<b>参数样例</b>:` \"{\"PageRanges\":[{\"BeginPage\":1,\"EndPage\":-1}]}\"`\n\n<font color=\"red\">签署印章旋转功能,当ComponentType为SIGN_SIGNATURE、SIGN_DATE、SIGN_SEAL时</font>,可以通过以下参数设置签署图片的旋转角度:\n<ul><li> <b>Rotate</b>:旋转角度,支持范围:-360:360,为正整数时,为顺时针旋转;为负整数时,为逆时针旋转。</li>\n<li> <b>RotateRelation</b>:旋转关联控件,用于指定关联旋转的控件。例如:让印章控件和签署日期控件按照印章控件为中心旋转(此时,设置印章控件的RotateRelation为日期控件的ComponentId,设置日期签署控件的RotateRelation为印章控件的ComponentId)。</li></ul>\n<b>参数样例</b>:`{\"Rotate\":-30,\"RotateRelation\":\"Component_Id1\"}`\n\n<font color=\"red\">签署印章透明度功能设置,</font>当ComponentType为SIGN_SIGNATURE、SIGN_SEAL、SIGN_PAGING_SEAL、SIGN_LEGAL_PERSON_SEAL时,可以通过以下参数设置签署印章的透明度:\n<ul><li> <b>Opacity</b>:印章透明度,支持范围:0-1,0.7表示70%的透明度,1表示无透明度</li></ul>\n<b>参数样例</b>:`{\"Opacity\":0.7}`\n\n<font color=\"red\">签署印章大小功能设置,</font>当ComponentType为SIGN_SEAL、SIGN_PAGING_SEAL、SIGN_LEGAL_PERSON_SEAL时,可以通过以下参数设置签署时按照实际印章的大小进行签署,如果印章没有设置大小,那么默认会是4.2cm的印章大小:\n<ul><li> <b>UseSealSize</b>:使用印章设置的大小盖章,true表示使用印章设置的大小盖章,false表示使用签署控件的大小进行盖章;不传则为false</li></ul>\n<b>参数样例</b>:`{\"UseSealSize\":true}`\n\n<font color=\"red\">关键字模式下支持关键字找不到的情况下不进行报错的设置</font>\n<ul><li> <b>IgnoreKeywordError</b> :1-关键字查找不到时不进行报错</li></ul>\n场景说明:如果使用关键字进行定位,但是指定的PDF文件中又没有设置的关键字时,发起合同会进行关键字是否存在的校验,如果关键字不存在,会进行报错返回。如果不希望进行报错,可以设置\"IgnoreKeywordError\"来忽略错误。请注意,如果关键字签署控件对应的签署方在整个PDF文件中一个签署控件都没有,还是会触发报错逻辑。\n<b>参数样例</b>:` \"{\"IgnoreKeywordError\":1}\"`\n\n\n<font color=\"red\">ComponentType为SIGN_VIRTUAL_COMBINATION时</font>,支持以下参数:\n<ul>\n<li><b>Children:</b> 绝对定位模式下,用来指定此签批控件的组合子控件 </li>\n<b>参数样例</b>:<br>`{\"Children\":[\"ComponentId_29\",\"ComponentId_27\",\"ComponentId_28\",\"ComponentId_30\"]}`\n<li><b>ChildrenComponents:</b> 关键字定位模式下,用来指定此签批控件的组合子控件 </li>\nChildrenComponent结构体定义:\n<table border=\"1\"> <thead> <tr> <th>字段名称</th> <th>类型</th> <th>描述</th> </tr> </thead> <tbody> <tr> <td>ComponentType</td> <td>string</td> <td>子控件类型-可选值:SIGN_SIGNATURE,SIGN_DATE,SIGN_SELECTOR,SIGN_MULTI_LINE_TEXT</td> </tr> <tr> <td>ComponentName</td> <td>string</td> <td>子控件名称</td> </tr> <tr> <td>Placeholder</td> <td>string</td> <td>子控件提示语</td> </tr> <tr> <td>ComponentOffsetX</td> <td>float</td> <td>控件偏移位置X(相对于父控件(签批控件的ComponentX))</td> </tr> <tr> <td>ComponentOffsetY</td> <td>float</td> <td>控件偏移位置Y 相对于父控件(签批控件的ComponentY))</td> </tr> <tr> <td>ComponentWidth</td> <td>float</td> <td>控件宽</td> </tr> <tr> <td>ComponentHeight</td> <td>float</td> <td>控件高</td> </tr> <tr> <td>ComponentExtra</td> <td>string</td> <td>控件的附属信息,根据ComponentType设置</td> </tr> </tbody> </table>\n<b>参数样例</b>:\n\n<pre>\n{\n \"ChildrenComponents\": [\n {\n \"ComponentType\": \"SIGN_SIGNATURE\",\n \"ComponentName\": \"个人签名\",\n \"Placeholder\": \"请签名\",\n \"ComponentOffsetX\": 10,\n \"ComponentOffsetY\": 30,\n \"ComponentWidth\": 119,\n \"ComponentHeight\": 43,\n \"ComponentExtra\": \"{\\\"ComponentTypeLimit\\\":[\\\"SYSTEM_ESIGN\\\"]}\"\n },\n {\n \"ComponentType\": \"SIGN_SELECTOR\",\n \"ComponentName\": \"是否同意此协议\",\n \"Placeholder\": \"\",\n \"ComponentOffsetX\": 50,\n \"ComponentOffsetY\": 130,\n \"ComponentWidth\": 120,\n \"ComponentHeight\": 43,\n \"ComponentExtra\": \"{\\\"Values\\\":[\\\"同意\\\",\\\"不同意\\\",\\\"再想想\\\"],\\\"FontSize\\\":12,\\\"FontAlign\\\":\\\"Left\\\",\\\"Font\\\":\\\"黑体\\\",\\\"MultiSelect\\\":false}\"\n },\n {\n \"ComponentType\": \"SIGN_MULTI_LINE_TEXT\",\n \"ComponentName\": \"批注附言\",\n \"Placeholder\": \"\",\n \"ComponentOffsetX\": 150,\n \"ComponentOffsetY\": 300,\n \"ComponentWidth\": 200,\n \"ComponentHeight\": 86,\n \"ComponentExtra\": \"\"\n }\n ]\n}</pre>\n</ul>\n\n\n\n",
6284
+ "document": "**在所有的定位方式下**,控件的扩展参数,为<font color=\"red\">JSON格式</font>,不同类型的控件会有部分非通用参数。\n\n<font color=\"red\">ComponentType为TEXT、MULTI_LINE_TEXT时</font>,支持以下参数:\n<ul><li> <b>Font</b>:目前只支持黑体、宋体、仿宋</li>\n<li> <b>FontSize</b>: 范围6 :72</li>\n<li> <b>FontAlign</b>: Left/Right/Center,左对齐/居中/右对齐</li>\n<li> <b>FontColor</b>:字符串类型,格式为RGB颜色数字</li></ul>\n<b>参数样例</b>:`{\"FontColor\":\"255,0,0\",\"FontSize\":12}`\n\n<font color=\"red\">ComponentType为DATE时</font>,支持以下参数:\n<ul><li> <b>Font</b>:目前只支持黑体、宋体、仿宋</li>\n<li> <b>FontSize</b>: 范围6 :72</li></ul>\n<b>参数样例</b>:`{\"FontColor\":\"255,0,0\",\"FontSize\":12}`\n\n<font color=\"red\">ComponentType为FILL_IMAGE时</font>,支持以下参数:\n<ul><li> <b>NotMakeImageCenter</b>:bool。是否设置图片居中。false:居中(默认)。 true : 不居中</li>\n<li> <b>FillMethod</b> : int. 填充方式。0-铺满(默认);1-等比例缩放</li></ul>\n\n<font color=\"red\">ComponentType为SELECTOR时</font>,支持以下参数:\n<ul><li> <b>WordWrap</b>:bool。是否支持选择控件内容自动折行合成。false:不支持(默认)。 true : 支持自动折行合成</li>\n</ul>\n\n<font color=\"red\">ComponentType为SIGN_SIGNATURE、SIGN_PAGING_SIGNATURE类型时</font>,可以**ComponentTypeLimit**参数控制签署方式\n<ul><li> <b>HANDWRITE</b> : 需要实时手写的手写签名</li>\n<li> <b>HANDWRITTEN_ESIGN</b> : 长效手写签名, 是使用保存到个人中心的印章列表的手写签名(并且包含HANDWRITE)</li>\n<li> <b>OCR_ESIGN</b> : AI智能识别手写签名</li>\n<li> <b>ESIGN</b> : 个人印章类型</li>\n<li> <b>SYSTEM_ESIGN</b> : 系统签名(该类型可以在用户签署时根据用户姓名一键生成一个签名来进行签署)</li>\n<li> <b>IMG_ESIGN</b> : 图片印章(该类型支持用户在签署将上传的PNG格式的图片作为签名)</li></ul>\n<b>参考样例</b>:`{\"ComponentTypeLimit\": [\"SYSTEM_ESIGN\"]}`\n印章的对应关系参考下图\n![image](https://qcloudimg.tencent-cloud.cn/raw/ee0498856c060c065628a0c5ba780d6b.jpg)<br><br>\n<font color=\"red\">ComponentType为SIGN_SEAL 或者 SIGN_PAGING_SEAL类型时</font>,可以通过**ComponentTypeLimit**参数控制签署方签署时要使用的印章类型,支持指定以下印章类型\n<ul><li> <b>OFFICIAL</b> : 企业公章</li>\n<li> <b>CONTRACT</b> : 合同专用章</li>\n<li> <b>FINANCE</b> : 财务专用章</li>\n<li> <b>PERSONNEL</b> : 人事专用章</li>\n<li> <b>OTHER</b> : 其他</li>\n</ul>\n<b>参考样例</b>:`{\\\"ComponentTypeLimit\\\":[\\\"PERSONNEL\\\",\\\"FINANCE\\\"]}` 表示改印章签署区,客户需使用人事专用章或财务专用章盖章签署。<br><br>\n\n<font color=\"red\">ComponentType为SIGN_DATE时</font>,支持以下参数:\n<ul><li> <b>Font</b> :字符串类型目前只支持\"黑体\"、\"宋体\"、仿宋,如果不填默认为\"黑体\"</li>\n<li> <b>FontSize</b> : 数字类型,范围6-72,默认值为12</li>\n<li> <b>FontAlign</b> : 字符串类型,可取Left/Right/Center,对应左对齐/居中/右对齐</li>\n<li> <b>Format</b> : 字符串类型,日期格式,必须是以下五种之一 “yyyy m d”,”yyyy年m月d日”,”yyyy/m/d”,”yyyy-m-d”,”yyyy.m.d”。</li>\n<li> <b>Gaps</b> : 字符串类型,仅在Format为“yyyy m d”时起作用,格式为用逗号分开的两个整数,例如”2,2”,两个数字分别是日期格式的前后两个空隙中的空格个数</li></ul>\n如果extra参数为空,默认为”yyyy年m月d日”格式的居中日期\n特别地,如果extra中Format字段为空或无法被识别,则extra参数会被当作默认值处理(Font,FontSize,Gaps和FontAlign都不会起效)\n<b>参数样例</b>: ` \"{\"Format\":\"yyyy m d\",\"FontSize\":12,\"Gaps\":\"2,2\", \"FontAlign\":\"Right\"}\"`\n\n<font color=\"red\">ComponentType为SIGN_SEAL、SIGN_SIGNATURE类型时</font>,支持以下参数:\n<ul><li> <b>PageRanges</b> :PageRange的数组,通过PageRanges属性设置该印章在PDF所有页面上盖章(适用于标书在所有页面盖章的情况)</li></ul>\n<b>参数样例</b>:` \"{\"PageRanges\":[{\"BeginPage\":1,\"EndPage\":-1}]}\"`\n\n<font color=\"red\">签署印章旋转功能,当ComponentType为SIGN_SIGNATURE、SIGN_DATE、SIGN_SEAL时</font>,可以通过以下参数设置签署图片的旋转角度:\n<ul><li> <b>Rotate</b>:旋转角度,支持范围:-360:360,为正整数时,为顺时针旋转;为负整数时,为逆时针旋转。</li>\n<li> <b>RotateRelation</b>:旋转关联控件,用于指定关联旋转的控件。例如:让印章控件和签署日期控件按照印章控件为中心旋转(此时,设置印章控件的RotateRelation为日期控件的ComponentId,设置日期签署控件的RotateRelation为印章控件的ComponentId)。</li></ul>\n<b>参数样例</b>:`{\"Rotate\":-30,\"RotateRelation\":\"Component_Id1\"}`\n\n<font color=\"red\">签署印章透明度功能设置,</font>当ComponentType为SIGN_SIGNATURE、SIGN_SEAL、SIGN_PAGING_SEAL、SIGN_LEGAL_PERSON_SEAL时,可以通过以下参数设置签署印章的透明度:\n<ul><li> <b>Opacity</b>:印章透明度,支持范围:0-1,0.7表示70%的透明度,1表示无透明度</li></ul>\n<b>参数样例</b>:`{\"Opacity\":0.7}`\n\n<font color=\"red\">签署印章大小功能设置,</font>当ComponentType为SIGN_SEAL、SIGN_PAGING_SEAL、SIGN_LEGAL_PERSON_SEAL时,可以通过以下参数设置签署时按照实际印章的大小进行签署,如果印章没有设置大小,那么默认会是4.2cm的印章大小:\n<ul><li> <b>UseSealSize</b>:使用印章设置的大小盖章,true表示使用印章设置的大小盖章,false表示使用签署控件的大小进行盖章;不传则为false</li></ul>\n<b>参数样例</b>:`{\"UseSealSize\":true}`\n\n<font color=\"red\">关键字模式下支持关键字找不到的情况下不进行报错的设置</font>\n<ul><li> <b>IgnoreKeywordError</b> :1-关键字查找不到时不进行报错</li></ul>\n场景说明:如果使用关键字进行定位,但是指定的PDF文件中又没有设置的关键字时,发起合同会进行关键字是否存在的校验,如果关键字不存在,会进行报错返回。如果不希望进行报错,可以设置\"IgnoreKeywordError\"来忽略错误。请注意,如果关键字签署控件对应的签署方在整个PDF文件中一个签署控件都没有,还是会触发报错逻辑。\n<b>参数样例</b>:` \"{\"IgnoreKeywordError\":1}\"`\n\n\n<font color=\"red\">ComponentType为SIGN_VIRTUAL_COMBINATION时</font>,支持以下参数:\n<ul>\n<li><b>Children:</b> 绝对定位模式下,用来指定此签批控件的组合子控件 </li>\n<b>参数样例</b>:<br>`{\"Children\":[\"ComponentId_29\",\"ComponentId_27\",\"ComponentId_28\",\"ComponentId_30\"]}`\n<li><b>ChildrenComponents:</b> 关键字定位模式下,用来指定此签批控件的组合子控件 </li>\nChildrenComponent结构体定义:\n<table border=\"1\"> <thead> <tr> <th>字段名称</th> <th>类型</th> <th>描述</th> </tr> </thead> <tbody> <tr> <td>ComponentType</td> <td>string</td> <td>子控件类型-可选值:SIGN_SIGNATURE,SIGN_DATE,SIGN_SELECTOR,SIGN_MULTI_LINE_TEXT</td> </tr> <tr> <td>ComponentName</td> <td>string</td> <td>子控件名称</td> </tr> <tr> <td>Placeholder</td> <td>string</td> <td>子控件提示语</td> </tr> <tr> <td>ComponentOffsetX</td> <td>float</td> <td>控件偏移位置X(相对于父控件(签批控件的ComponentX))</td> </tr> <tr> <td>ComponentOffsetY</td> <td>float</td> <td>控件偏移位置Y 相对于父控件(签批控件的ComponentY))</td> </tr> <tr> <td>ComponentWidth</td> <td>float</td> <td>控件宽</td> </tr> <tr> <td>ComponentHeight</td> <td>float</td> <td>控件高</td> </tr> <tr> <td>ComponentExtra</td> <td>string</td> <td>控件的附属信息,根据ComponentType设置</td> </tr> </tbody> </table>\n<b>参数样例</b>:\n\n<pre>\n{\n \"ChildrenComponents\": [\n {\n \"ComponentType\": \"SIGN_SIGNATURE\",\n \"ComponentName\": \"个人签名\",\n \"Placeholder\": \"请签名\",\n \"ComponentOffsetX\": 10,\n \"ComponentOffsetY\": 30,\n \"ComponentWidth\": 119,\n \"ComponentHeight\": 43,\n \"ComponentExtra\": \"{\\\"ComponentTypeLimit\\\":[\\\"SYSTEM_ESIGN\\\"]}\"\n },\n {\n \"ComponentType\": \"SIGN_SELECTOR\",\n \"ComponentName\": \"是否同意此协议\",\n \"Placeholder\": \"\",\n \"ComponentOffsetX\": 50,\n \"ComponentOffsetY\": 130,\n \"ComponentWidth\": 120,\n \"ComponentHeight\": 43,\n \"ComponentExtra\": \"{\\\"Values\\\":[\\\"同意\\\",\\\"不同意\\\",\\\"再想想\\\"],\\\"FontSize\\\":12,\\\"FontAlign\\\":\\\"Left\\\",\\\"Font\\\":\\\"黑体\\\",\\\"MultiSelect\\\":false}\"\n },\n {\n \"ComponentType\": \"SIGN_MULTI_LINE_TEXT\",\n \"ComponentName\": \"批注附言\",\n \"Placeholder\": \"\",\n \"ComponentOffsetX\": 150,\n \"ComponentOffsetY\": 300,\n \"ComponentWidth\": 200,\n \"ComponentHeight\": 86,\n \"ComponentExtra\": \"\"\n }\n ]\n}</pre>\n</ul>\n\n",
6285
6285
  "example": "ComponentExtra",
6286
6286
  "member": "string",
6287
6287
  "name": "ComponentExtra",
@@ -321,7 +321,7 @@
321
321
  "members": [
322
322
  {
323
323
  "disabled": false,
324
- "document": "认证结果码。\n- 计费结果码:\n '0': '认证通过'。\n '-1': '认证未通过'。\n '-4': '持卡人信息有误'。\n '-5': '未开通无卡支付'。\n '-6': '此卡被没收'。\n '-7': '无效卡号'。\n '-8': '此卡无对应发卡行'。\n '-9': '该卡未初始化或睡眠卡'。\n '-10': '作弊卡、吞卡'。\n '-11': '此卡已挂失'。\n '-12': '该卡已过期'。\n '-13': '受限制的卡'。\n '-14': '密码错误次数超限'。\n '-15': '发卡行不支持此交易'。\n\n- 不计费结果码:\n '-2': '姓名校验不通过'。\n '-3': '银行卡号码有误'。\n '-16': '验证中心服务繁忙'。\n '-17': '验证次数超限,请次日重试'。\n",
324
+ "document": "认证结果码。\n- 计费结果码:\n '0': '认证通过'。\n '-1': '认证未通过'。\n '-4': '持卡人信息有误'。\n '-5': '未开通无卡支付'。\n '-6': '此卡被没收'。\n '-7': '无效卡号'。\n '-8': '此卡无对应发卡行'。\n '-9': '该卡未初始化或睡眠卡'。\n '-10': '作弊卡、吞卡'。\n '-11': '此卡已挂失'。\n '-12': '该卡已过期'。\n '-13': '受限制的卡'。\n '-14': '密码错误次数超限'。\n '-15': '发卡行不支持此交易'。\n '-18': '卡状态异常或卡号错误'。\n\n- 不计费结果码:\n '-2': '姓名校验不通过'。\n '-3': '银行卡号格式有误'。\n '-16': '验证中心服务繁忙'。\n '-17': '验证次数超限,请次日重试'。\n",
325
325
  "example": "0",
326
326
  "member": "string",
327
327
  "name": "Result",
@@ -413,7 +413,7 @@
413
413
  "members": [
414
414
  {
415
415
  "disabled": false,
416
- "document": "认证结果码。\n- 收费结果码:\n'0': '认证通过'。\n'-1': '认证未通过'。\n'-6': '持卡人信息有误'。\n'-7': '未开通无卡支付'。\n'-8': '此卡被没收'。\n'-9': '无效卡号'。\n'-10': '此卡无对应发卡行'。\n'-11': '该卡未初始化或睡眠卡'。\n'-12': '作弊卡、吞卡'。\n'-13': '此卡已挂失'。\n'-14': '该卡已过期'。\n'-15': '受限制的卡'。\n'-16': '密码错误次数超限'。\n'-17': '发卡行不支持此交易'。\n\n- 不收费结果码:\n'-2': '姓名校验不通过'。\n'-3': '身份证号码有误'。\n'-4': '银行卡号码有误'。\n'-5': '手机号码不合法'。\n'-18': '验证中心服务繁忙'。\n'-19': '验证次数超限,请次日重试'。\n'-20': '该证件号暂不支持核验,当前仅支持二代身份证'。",
416
+ "document": "认证结果码。\n- 收费结果码:\n'0': '认证通过'。\n'-1': '认证未通过'。\n'-6': '持卡人信息有误'。\n'-7': '未开通无卡支付'。\n'-8': '此卡被没收'。\n'-9': '无效卡号'。\n'-10': '此卡无对应发卡行'。\n'-11': '该卡未初始化或睡眠卡'。\n'-12': '作弊卡、吞卡'。\n'-13': '此卡已挂失'。\n'-14': '该卡已过期'。\n'-15': '受限制的卡'。\n'-16': '密码错误次数超限'。\n'-17': '发卡行不支持此交易'。\n'-21': '卡状态异常或卡号错误'。\n\n- 不收费结果码:\n'-2': '姓名校验不通过'。\n'-3': '身份证号码有误'。\n'-4': '银行卡号格式有误'。\n'-5': '手机号码不合法'。\n'-18': '验证中心服务繁忙'。\n'-19': '验证次数超限,请次日重试'。\n'-20': '该证件号暂不支持核验,当前仅支持二代身份证'。",
417
417
  "example": "0",
418
418
  "member": "string",
419
419
  "name": "Result",
@@ -496,7 +496,7 @@
496
496
  "members": [
497
497
  {
498
498
  "disabled": false,
499
- "document": "认证结果码。\n- 收费结果码:\n'0': '认证通过'。\n'-1': '认证未通过'。\n'-5': '持卡人信息有误'。\n'-6': '未开通无卡支付'。\n'-7': '此卡被没收'。\n'-8': '无效卡号'。\n'-9': '此卡无对应发卡行'。\n'-10': '该卡未初始化或睡眠卡'。\n'-11': '作弊卡、吞卡'。\n'-12': '此卡已挂失'。\n'-13': '该卡已过期'。\n'-14': '受限制的卡'。\n'-15': '密码错误次数超限'。\n'-16': '发卡行不支持此交易'。\n\n- 不收费结果码:\n'-2': '姓名校验不通过'。\n'-3': '身份证号码有误'。\n'-4': '银行卡号码有误'。\n'-17': '验证中心服务繁忙'。\n'-18': '验证次数超限,请次日重试'。\n'-19': '该证件号暂不支持核验,当前仅支持二代身份证'。\t",
499
+ "document": "认证结果码。\n- 收费结果码:\n'0': '认证通过'。\n'-1': '认证未通过'。\n'-5': '持卡人信息有误'。\n'-6': '未开通无卡支付'。\n'-7': '此卡被没收'。\n'-8': '无效卡号'。\n'-9': '此卡无对应发卡行'。\n'-10': '该卡未初始化或睡眠卡'。\n'-11': '作弊卡、吞卡'。\n'-12': '此卡已挂失'。\n'-13': '该卡已过期'。\n'-14': '受限制的卡'。\n'-15': '密码错误次数超限'。\n'-16': '发卡行不支持此交易'。\n'-20': '卡状态异常或卡号错误'。\n\n- 不收费结果码:\n'-2': '姓名校验不通过'。\n'-3': '身份证号码有误'。\n'-4': '银行卡号格式有误'。\n'-17': '验证中心服务繁忙'。\n'-18': '验证次数超限,请次日重试'。\n'-19': '该证件号暂不支持核验,当前仅支持二代身份证'。\t",
500
500
  "example": "0",
501
501
  "member": "string",
502
502
  "name": "Result",
@@ -658,7 +658,7 @@
658
658
  "members": [
659
659
  {
660
660
  "disabled": false,
661
- "document": "认证结果码,收费情况如下。\n- 收费结果码:\n0: 查询成功\n-1: 未查到信息\n\n- 不收费结果码:\n-2:验证中心服务繁忙\n-3:银行卡不存在\n-4:认证次数超过当日限制,请次日重试\n",
661
+ "document": "认证结果码,收费情况如下。\n- 收费结果码:\n0: 查询成功\n-1: 未查到信息\n-5: 卡号无效\n\n- 不收费结果码:\n-2:验证中心服务繁忙\n-3:银行卡不存在\n-4:认证次数超过当日限制,请次日重试\n-6: 暂不支持该银行卡种\n",
662
662
  "example": "0",
663
663
  "member": "string",
664
664
  "name": "Result",
@@ -329,6 +329,58 @@ def doDescribeSoftCensusListByDevice(args, parsed_globals):
329
329
  FormatOutput.output("action", json_obj, g_param[OptionsDefine.Output], g_param[OptionsDefine.Filter])
330
330
 
331
331
 
332
+ def doDescribeSoftwareInformation(args, parsed_globals):
333
+ g_param = parse_global_arg(parsed_globals)
334
+
335
+ if g_param[OptionsDefine.UseCVMRole.replace('-', '_')]:
336
+ cred = credential.CVMRoleCredential()
337
+ elif g_param[OptionsDefine.RoleArn.replace('-', '_')] and g_param[OptionsDefine.RoleSessionName.replace('-', '_')]:
338
+ cred = credential.STSAssumeRoleCredential(
339
+ g_param[OptionsDefine.SecretId], g_param[OptionsDefine.SecretKey], g_param[OptionsDefine.RoleArn.replace('-', '_')],
340
+ g_param[OptionsDefine.RoleSessionName.replace('-', '_')], endpoint=g_param["sts_cred_endpoint"]
341
+ )
342
+ elif os.getenv(OptionsDefine.ENV_TKE_REGION) and os.getenv(OptionsDefine.ENV_TKE_PROVIDER_ID) and os.getenv(OptionsDefine.ENV_TKE_WEB_IDENTITY_TOKEN_FILE) and os.getenv(OptionsDefine.ENV_TKE_ROLE_ARN):
343
+ cred = credential.DefaultTkeOIDCRoleArnProvider().get_credentials()
344
+ else:
345
+ cred = credential.Credential(
346
+ g_param[OptionsDefine.SecretId], g_param[OptionsDefine.SecretKey], g_param[OptionsDefine.Token]
347
+ )
348
+ http_profile = HttpProfile(
349
+ reqTimeout=60 if g_param[OptionsDefine.Timeout] is None else int(g_param[OptionsDefine.Timeout]),
350
+ reqMethod="POST",
351
+ endpoint=g_param[OptionsDefine.Endpoint],
352
+ proxy=g_param[OptionsDefine.HttpsProxy.replace('-', '_')]
353
+ )
354
+ profile = ClientProfile(httpProfile=http_profile, signMethod="HmacSHA256")
355
+ if g_param[OptionsDefine.Language]:
356
+ profile.language = g_param[OptionsDefine.Language]
357
+ mod = CLIENT_MAP[g_param[OptionsDefine.Version]]
358
+ client = mod.IoaClient(cred, g_param[OptionsDefine.Region], profile)
359
+ client._sdkVersion += ("_CLI_" + __version__)
360
+ models = MODELS_MAP[g_param[OptionsDefine.Version]]
361
+ model = models.DescribeSoftwareInformationRequest()
362
+ model.from_json_string(json.dumps(args))
363
+ start_time = time.time()
364
+ while True:
365
+ rsp = client.DescribeSoftwareInformation(model)
366
+ result = rsp.to_json_string()
367
+ try:
368
+ json_obj = json.loads(result)
369
+ except TypeError as e:
370
+ json_obj = json.loads(result.decode('utf-8')) # python3.3
371
+ if not g_param[OptionsDefine.Waiter] or search(g_param['OptionsDefine.WaiterInfo']['expr'], json_obj) == g_param['OptionsDefine.WaiterInfo']['to']:
372
+ break
373
+ cur_time = time.time()
374
+ if cur_time - start_time >= g_param['OptionsDefine.WaiterInfo']['timeout']:
375
+ raise ClientError('Request timeout, wait `%s` to `%s` timeout, last request is %s' %
376
+ (g_param['OptionsDefine.WaiterInfo']['expr'], g_param['OptionsDefine.WaiterInfo']['to'],
377
+ search(g_param['OptionsDefine.WaiterInfo']['expr'], json_obj)))
378
+ else:
379
+ print('Inquiry result is %s.' % search(g_param['OptionsDefine.WaiterInfo']['expr'], json_obj))
380
+ time.sleep(g_param['OptionsDefine.WaiterInfo']['interval'])
381
+ FormatOutput.output("action", json_obj, g_param[OptionsDefine.Output], g_param[OptionsDefine.Filter])
382
+
383
+
332
384
  def doDescribeDeviceHardwareInfoList(args, parsed_globals):
333
385
  g_param = parse_global_arg(parsed_globals)
334
386
 
@@ -554,6 +606,7 @@ ACTION_MAP = {
554
606
  "DescribeDevices": doDescribeDevices,
555
607
  "CreateDLPFileDetectionTask": doCreateDLPFileDetectionTask,
556
608
  "DescribeSoftCensusListByDevice": doDescribeSoftCensusListByDevice,
609
+ "DescribeSoftwareInformation": doDescribeSoftwareInformation,
557
610
  "DescribeDeviceHardwareInfoList": doDescribeDeviceHardwareInfoList,
558
611
  "DescribeRootAccountGroup": doDescribeRootAccountGroup,
559
612
  "DescribeDLPFileDetectResult": doDescribeDLPFileDetectResult,
@@ -69,6 +69,13 @@
69
69
  "name": "按终端查看软件统计信息",
70
70
  "output": "DescribeSoftCensusListByDeviceResponse",
71
71
  "status": "online"
72
+ },
73
+ "DescribeSoftwareInformation": {
74
+ "document": "查看指定终端的软件详情列表,私有化调用path为:capi/Software/DescribeSoftwareInformation",
75
+ "input": "DescribeSoftwareInformationRequest",
76
+ "name": "查看软件详情列表",
77
+ "output": "DescribeSoftwareInformationResponse",
78
+ "status": "online"
72
79
  }
73
80
  },
74
81
  "metadata": {
@@ -1015,7 +1022,7 @@
1015
1022
  },
1016
1023
  {
1017
1024
  "disabled": false,
1018
- "document": "过滤条件参数(字段含义请参考接口返回值) - Name, 类型String,支持操作:【eq,like,ilike】,支持排序 - UserName, 类型String,支持操作:【eq,like,ilike】,支持排序 - IoaUserName,类型String,支持操作:【eq,like,ilike】,支持排序 - MacAddr, 类型String,支持操作:【eq,like,ilike】,支持排序 - Ip, 类型String,支持操作:【eq,like,ilike】,支持排序 ,支持排序分页参数- PageNum 从1开始,小于等于0时使用默认参数- PageSize 最大值5000,最好不超过100",
1025
+ "document": "过滤条件参数(字段含义请参考接口返回值) - Name, 类型String,支持操作:【eq,like,ilike】,支持排序 - UserName, 类型String,支持操作:【eq,like,ilike】,支持排序 - IoaUserName,类型String,支持操作:【eq,like,ilike】,支持排序 - MacAddr, 类型String,支持操作:【eq,like,ilike】,支持排序 - Ip, 类型String,支持操作:【eq,like,ilike】,支持排序 - Mid, 类型String,支持操作:【eq,like,ilike】,支持排序 ,支持排序分页参数 - PageNum 从1开始,小于等于0时使用默认参数 - PageSize 最大值5000,最好不超过100",
1019
1026
  "example": "\"Condition\":{\"Filters\":[],\"Sort\":{\"Field\":\"Id\",\"Order\":\"desc\"},\"PageSize\":10,\"PageNum\":1}",
1020
1027
  "member": "Condition",
1021
1028
  "name": "Condition",
@@ -1779,6 +1786,78 @@
1779
1786
  ],
1780
1787
  "type": "object"
1781
1788
  },
1789
+ "DescribeSoftwareInformationPageData": {
1790
+ "document": "业务响应数据",
1791
+ "members": [
1792
+ {
1793
+ "disabled": false,
1794
+ "document": "软件详情响应对象集合",
1795
+ "example": "[{\"CorpName\":\"\",\"Id\":19396,\"InstallDate\":\"2025/04/03\",\"Mid\":\"B454307F6CA03B56E0CFEC44EABF93BB67E56D6F\",\"Name\":\"微信\",\"PiracyRisk\":0,\"SoftwareId\":19396,\"Version\":\"3.9.12.51\"}]",
1796
+ "member": "SoftwareInformationData",
1797
+ "name": "Items",
1798
+ "output_required": false,
1799
+ "type": "list",
1800
+ "value_allowed_null": false
1801
+ },
1802
+ {
1803
+ "disabled": false,
1804
+ "document": "分页公共对象",
1805
+ "example": "{\"PageCount\":1,\"PageNum\":1,\"PageSize\":1000,\"Total\":1}",
1806
+ "member": "Paging",
1807
+ "name": "Page",
1808
+ "output_required": false,
1809
+ "type": "object",
1810
+ "value_allowed_null": false
1811
+ }
1812
+ ],
1813
+ "usage": "out"
1814
+ },
1815
+ "DescribeSoftwareInformationRequest": {
1816
+ "document": "DescribeSoftwareInformation请求参数结构体",
1817
+ "members": [
1818
+ {
1819
+ "disabled": false,
1820
+ "document": "终端唯一标识Mid",
1821
+ "example": "B454307F6CA03B56E0CFEC44EABF93BB67E56D6F",
1822
+ "member": "string",
1823
+ "name": "Mid",
1824
+ "required": false,
1825
+ "type": "string"
1826
+ },
1827
+ {
1828
+ "disabled": false,
1829
+ "document": "过滤条件、分页参数\n<li>Name - String - 过滤支持:是 - 操作符:eq,like - 排序支持:是 。</li>",
1830
+ "example": "{\"PageSize\":100,\"PageNum\":1}",
1831
+ "member": "Condition",
1832
+ "name": "Condition",
1833
+ "required": false,
1834
+ "type": "object"
1835
+ }
1836
+ ],
1837
+ "type": "object"
1838
+ },
1839
+ "DescribeSoftwareInformationResponse": {
1840
+ "document": "DescribeSoftwareInformation返回参数结构体",
1841
+ "members": [
1842
+ {
1843
+ "disabled": false,
1844
+ "document": "业务响应数据",
1845
+ "example": "{\"Items\":[{\"CorpName\":\"\",\"Id\":19396,\"InstallDate\":\"2025/04/03\",\"Mid\":\"B454307F6CA03B56E0CFEC44EABF93BB67E56D6F\",\"Name\":\"微信\",\"PiracyRisk\":0,\"SoftwareId\":19396,\"Version\":\"3.9.12.51\"}],\"Page\":{\"PageCount\":1,\"PageNum\":1,\"PageSize\":100,\"Total\":1}}",
1846
+ "member": "DescribeSoftwareInformationPageData",
1847
+ "name": "Data",
1848
+ "output_required": true,
1849
+ "type": "object",
1850
+ "value_allowed_null": false
1851
+ },
1852
+ {
1853
+ "document": "唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。",
1854
+ "member": "string",
1855
+ "name": "RequestId",
1856
+ "type": "string"
1857
+ }
1858
+ ],
1859
+ "type": "object"
1860
+ },
1782
1861
  "DeviceDetail": {
1783
1862
  "document": "业务响应数据",
1784
1863
  "members": [
@@ -2674,6 +2753,92 @@
2674
2753
  ],
2675
2754
  "usage": "both"
2676
2755
  },
2756
+ "SoftwareInformationData": {
2757
+ "document": "软件详情响应对象集合",
2758
+ "members": [
2759
+ {
2760
+ "disabled": false,
2761
+ "document": "软件名称",
2762
+ "example": "Google Chrome",
2763
+ "member": "string",
2764
+ "name": "Name",
2765
+ "output_required": true,
2766
+ "type": "string",
2767
+ "value_allowed_null": false
2768
+ },
2769
+ {
2770
+ "disabled": false,
2771
+ "document": "安装时间",
2772
+ "example": "2025/04/16",
2773
+ "member": "string",
2774
+ "name": "InstallDate",
2775
+ "output_required": false,
2776
+ "type": "string",
2777
+ "value_allowed_null": false
2778
+ },
2779
+ {
2780
+ "disabled": false,
2781
+ "document": "软件列表id(只支持32位)",
2782
+ "example": "23532",
2783
+ "member": "int64",
2784
+ "name": "SoftwareId",
2785
+ "output_required": true,
2786
+ "type": "int",
2787
+ "value_allowed_null": false
2788
+ },
2789
+ {
2790
+ "disabled": false,
2791
+ "document": "唯一标识Mid",
2792
+ "example": "B454307F6CA03B56E0CFEC44EABF93BB67E56D6F",
2793
+ "member": "string",
2794
+ "name": "Mid",
2795
+ "output_required": true,
2796
+ "type": "string",
2797
+ "value_allowed_null": false
2798
+ },
2799
+ {
2800
+ "disabled": false,
2801
+ "document": "软件版本",
2802
+ "example": "135.0.7049.95",
2803
+ "member": "string",
2804
+ "name": "Version",
2805
+ "output_required": false,
2806
+ "type": "string",
2807
+ "value_allowed_null": false
2808
+ },
2809
+ {
2810
+ "disabled": false,
2811
+ "document": "公司名",
2812
+ "example": "\"\" //废弃",
2813
+ "member": "string",
2814
+ "name": "CorpName",
2815
+ "output_required": false,
2816
+ "type": "string",
2817
+ "value_allowed_null": false
2818
+ },
2819
+ {
2820
+ "disabled": false,
2821
+ "document": "列表Id(只支持32位)",
2822
+ "example": "23532",
2823
+ "member": "int64",
2824
+ "name": "Id",
2825
+ "output_required": true,
2826
+ "type": "int",
2827
+ "value_allowed_null": false
2828
+ },
2829
+ {
2830
+ "disabled": false,
2831
+ "document": "盗版风险(0:未支持,1:风险,2:未发现,3:未开启)",
2832
+ "example": "0",
2833
+ "member": "int64",
2834
+ "name": "PiracyRisk",
2835
+ "output_required": false,
2836
+ "type": "int",
2837
+ "value_allowed_null": false
2838
+ }
2839
+ ],
2840
+ "usage": "out"
2841
+ },
2677
2842
  "Sort": {
2678
2843
  "document": "Sort 排序字段",
2679
2844
  "members": [
@@ -97,6 +97,20 @@
97
97
  "output": "{\n \"Response\": {\n \"Data\": {\n \"Items\": [\n {\n \"GroupId\": 11668634,\n \"SoftNum\": 0,\n \"IoaUserName\": \"\",\n \"MacAddr\": \"\",\n \"PiracyRisk\": 2,\n \"Mid\": \"1EBWA5184BEC838B96B29CE8105EC66167F8CFBD\",\n \"GroupName\": \"dddd\",\n \"Name\": \"lucal_win-PC\",\n \"Ip\": \"119.147.10.202\",\n \"Id\": 288661,\n \"GroupNamePath\": \"全网终端.dddd\",\n \"UserName\": \"lucal_win\"\n },\n {\n \"GroupId\": 11668615,\n \"SoftNum\": 161,\n \"IoaUserName\": \"\",\n \"MacAddr\": \"B0:DC:EF:E7:37:EA\",\n \"PiracyRisk\": 2,\n \"Mid\": \"8314BF3FD3FD738410C4FBB0DDDA48786800AB00\",\n \"GroupName\": \"未分组终端\",\n \"Name\": \"STEVENSSHE-NBIR\",\n \"Ip\": \"119.147.10.192\",\n \"Id\": 288663,\n \"GroupNamePath\": \"全网终端.未分组终端\",\n \"UserName\": \"Administrator\"\n },\n {\n \"GroupId\": 11668615,\n \"SoftNum\": 0,\n \"IoaUserName\": \"\",\n \"MacAddr\": \"B0:DC:EF:E7:37:EE\",\n \"PiracyRisk\": 2,\n \"Mid\": \"489C698CAECC13B1B7C44E59443F5CBB676B7F33\",\n \"GroupName\": \"未分组终端\",\n \"Name\": \"cs-207addad83ae\",\n \"Ip\": \"113.108.77.70\",\n \"Id\": 288664,\n \"GroupNamePath\": \"全网终端.未分组终端\",\n \"UserName\": \"Administrator\"\n }\n ],\n \"Page\": {\n \"PageSize\": 10,\n \"PageNum\": 1,\n \"PageCount\": 1,\n \"Total\": 3\n }\n },\n \"RequestId\": \"8104e997-1a80-4697-afeb-cb2154bb0235\"\n }\n}",
98
98
  "title": "按终端查看软件统计"
99
99
  }
100
+ ],
101
+ "DescribeSoftwareInformation": [
102
+ {
103
+ "document": "",
104
+ "input": "POST / HTTP/1.1\nHost: ioa.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: DescribeSoftwareInformation\n<公共请求参数>\n\n{\n \"Mid\": \"123\"\n}",
105
+ "output": "{\n \"Response\": {\n \"RequestId\": \"ada4c0d5-2e2d-4264-93b9-c067a4ddb62e\",\n \"Data\": {\n \"Items\": [],\n \"Page\": {\n \"Total\": 0,\n \"PageCount\": 0,\n \"PageSize\": 1000,\n \"PageNum\": 1\n }\n }\n }\n}",
106
+ "title": "查看软件详情列表"
107
+ },
108
+ {
109
+ "document": "获取设备安装的软件数据",
110
+ "input": "POST / HTTP/1.1\nHost: ioa.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: DescribeSoftwareInformation\n<公共请求参数>\n\n{\n \"Mid\": \"B454307F6CA03B56E0CFEC44EABF93BB67E56D6F\"\n}",
111
+ "output": "{\n \"Response\": {\n \"Data\": {\n \"Items\": [\n {\n \"CorpName\": \"\",\n \"Id\": 19396,\n \"InstallDate\": \"2025/04/03\",\n \"Mid\": \"B454307F6CA03B56E0CFEC44EABF93BB67E56D6F\",\n \"Name\": \"微信\",\n \"PiracyRisk\": 0,\n \"SoftwareId\": 19396,\n \"Version\": \"3.9.12.51\"\n },\n {\n \"CorpName\": \"\",\n \"Id\": 23532,\n \"InstallDate\": \"2025/04/16\",\n \"Mid\": \"B454307F6CA03B56E0CFEC44EABF93BB67E56D6F\",\n \"Name\": \"Google Chrome\",\n \"PiracyRisk\": 0,\n \"SoftwareId\": 23532,\n \"Version\": \"135.0.7049.95\"\n },\n {\n \"CorpName\": \"\",\n \"Id\": 23452,\n \"InstallDate\": \"2025/04/16\",\n \"Mid\": \"B454307F6CA03B56E0CFEC44EABF93BB67E56D6F\",\n \"Name\": \"Mozilla Firefox (x64 zh-CN)\",\n \"PiracyRisk\": 0,\n \"SoftwareId\": 23452,\n \"Version\": \"137.0.2\"\n },\n {\n \"CorpName\": \"\",\n \"Id\": 19198,\n \"InstallDate\": \"2025/03/31\",\n \"Mid\": \"B454307F6CA03B56E0CFEC44EABF93BB67E56D6F\",\n \"Name\": \"Adobe Acrobat Reader DC MUI\",\n \"PiracyRisk\": 2,\n \"SoftwareId\": 19198,\n \"Version\": \"15.007.20033\"\n },\n {\n \"CorpName\": \"\",\n \"Id\": 19639,\n \"InstallDate\": \"2025/04/01\",\n \"Mid\": \"B454307F6CA03B56E0CFEC44EABF93BB67E56D6F\",\n \"Name\": \"企业微信\",\n \"PiracyRisk\": 0,\n \"SoftwareId\": 19639,\n \"Version\": \"4.1.36.6004\"\n },\n {\n \"CorpName\": \"\",\n \"Id\": 19197,\n \"InstallDate\": \"2025/03/31\",\n \"Mid\": \"B454307F6CA03B56E0CFEC44EABF93BB67E56D6F\",\n \"Name\": \"Java 8 Update 441\",\n \"PiracyRisk\": 0,\n \"SoftwareId\": 19197,\n \"Version\": \"8.0.4410.7\"\n },\n {\n \"CorpName\": \"\",\n \"Id\": 19059,\n \"InstallDate\": \"2024/12/13\",\n \"Mid\": \"B454307F6CA03B56E0CFEC44EABF93BB67E56D6F\",\n \"Name\": \"运维审计系统 单点登录组件 2.0\",\n \"PiracyRisk\": 0,\n \"SoftwareId\": 19059,\n \"Version\": \"2.0\"\n },\n {\n \"CorpName\": \"\",\n \"Id\": 18422,\n \"InstallDate\": \"2024/04/10\",\n \"Mid\": \"B454307F6CA03B56E0CFEC44EABF93BB67E56D6F\",\n \"Name\": \"软件管理\",\n \"PiracyRisk\": 0,\n \"SoftwareId\": 18422,\n \"Version\": \"3.1.1442.301\"\n },\n {\n \"CorpName\": \"\",\n \"Id\": 18595,\n \"InstallDate\": \"2025/03/27\",\n \"Mid\": \"B454307F6CA03B56E0CFEC44EABF93BB67E56D6F\",\n \"Name\": \"腾讯 iOA\",\n \"PiracyRisk\": 0,\n \"SoftwareId\": 18595,\n \"Version\": \"210.3.25981.62001\"\n },\n {\n \"CorpName\": \"\",\n \"Id\": 21450,\n \"InstallDate\": \"2025/04/11\",\n \"Mid\": \"B454307F6CA03B56E0CFEC44EABF93BB67E56D6F\",\n \"Name\": \"向日葵远程控制\",\n \"PiracyRisk\": 0,\n \"SoftwareId\": 21450,\n \"Version\": \"15.8.3.19819\"\n },\n {\n \"CorpName\": \"\",\n \"Id\": 18725,\n \"InstallDate\": \"2024/04/10\",\n \"Mid\": \"B454307F6CA03B56E0CFEC44EABF93BB67E56D6F\",\n \"Name\": \"企业版软件管家\",\n \"PiracyRisk\": 0,\n \"SoftwareId\": 18725,\n \"Version\": \"101.1.169.1\"\n },\n {\n \"CorpName\": \"\",\n \"Id\": 19057,\n \"InstallDate\": \"2024/03/19\",\n \"Mid\": \"B454307F6CA03B56E0CFEC44EABF93BB67E56D6F\",\n \"Name\": \"Wireshark 3.4.6 64-bit\",\n \"PiracyRisk\": 0,\n \"SoftwareId\": 19057,\n \"Version\": \"3.4.6\"\n },\n {\n \"CorpName\": \"\",\n \"Id\": 19195,\n \"InstallDate\": \"2025/03/28\",\n \"Mid\": \"B454307F6CA03B56E0CFEC44EABF93BB67E56D6F\",\n \"Name\": \"ToDesk\",\n \"PiracyRisk\": 0,\n \"SoftwareId\": 19195,\n \"Version\": \"4.7.6.3\"\n },\n {\n \"CorpName\": \"\",\n \"Id\": 19055,\n \"InstallDate\": \"2025/04/11\",\n \"Mid\": \"B454307F6CA03B56E0CFEC44EABF93BB67E56D6F\",\n \"Name\": \"TeamViewer\",\n \"PiracyRisk\": 0,\n \"SoftwareId\": 19055,\n \"Version\": \"15.46.5\"\n },\n {\n \"CorpName\": \"\",\n \"Id\": 19054,\n \"InstallDate\": \"2024/12/13\",\n \"Mid\": \"B454307F6CA03B56E0CFEC44EABF93BB67E56D6F\",\n \"Name\": \"SangforVNC\",\n \"PiracyRisk\": 0,\n \"SoftwareId\": 19054,\n \"Version\": \"7,1,0,2\"\n },\n {\n \"CorpName\": \"\",\n \"Id\": 19053,\n \"InstallDate\": \"2024/08/27\",\n \"Mid\": \"B454307F6CA03B56E0CFEC44EABF93BB67E56D6F\",\n \"Name\": \"RayLink 8.1.0.9\",\n \"PiracyRisk\": 0,\n \"SoftwareId\": 19053,\n \"Version\": \"8.1.0.9\"\n },\n {\n \"CorpName\": \"\",\n \"Id\": 19052,\n \"InstallDate\": \"2024/12/17\",\n \"Mid\": \"B454307F6CA03B56E0CFEC44EABF93BB67E56D6F\",\n \"Name\": \"Python Launcher\",\n \"PiracyRisk\": 0,\n \"SoftwareId\": 19052,\n \"Version\": \"3.13.1150.0\"\n },\n {\n \"CorpName\": \"\",\n \"Id\": 19051,\n \"InstallDate\": \"2024/12/13\",\n \"Mid\": \"B454307F6CA03B56E0CFEC44EABF93BB67E56D6F\",\n \"Name\": \"Python 3.13.1 (64-bit)\",\n \"PiracyRisk\": 0,\n \"SoftwareId\": 19051,\n \"Version\": \"3.13.1150.0\"\n },\n {\n \"CorpName\": \"\",\n \"Id\": 19050,\n \"InstallDate\": \"2024/06/06\",\n \"Mid\": \"B454307F6CA03B56E0CFEC44EABF93BB67E56D6F\",\n \"Name\": \"Npcap 0.9982\",\n \"PiracyRisk\": 0,\n \"SoftwareId\": 19050,\n \"Version\": \"0.9982\"\n },\n {\n \"CorpName\": \"\",\n \"Id\": 19049,\n \"InstallDate\": \"2024/01/24\",\n \"Mid\": \"B454307F6CA03B56E0CFEC44EABF93BB67E56D6F\",\n \"Name\": \"Notepad++ (32-bit x86)\",\n \"PiracyRisk\": 0,\n \"SoftwareId\": 19049,\n \"Version\": \"8.1.9\"\n },\n {\n \"CorpName\": \"\",\n \"Id\": 18414,\n \"InstallDate\": \"2025/03/27\",\n \"Mid\": \"B454307F6CA03B56E0CFEC44EABF93BB67E56D6F\",\n \"Name\": \"NGNClient-TAP 1.1\",\n \"PiracyRisk\": 0,\n \"SoftwareId\": 18414,\n \"Version\": \"1.1\"\n },\n {\n \"CorpName\": \"\",\n \"Id\": 18411,\n \"InstallDate\": \"2025/03/28\",\n \"Mid\": \"B454307F6CA03B56E0CFEC44EABF93BB67E56D6F\",\n \"Name\": \"Mozilla Maintenance Service\",\n \"PiracyRisk\": 0,\n \"SoftwareId\": 18411,\n \"Version\": \"136.0.1\"\n },\n {\n \"CorpName\": \"\",\n \"Id\": 19048,\n \"InstallDate\": \"2024/03/14\",\n \"Mid\": \"B454307F6CA03B56E0CFEC44EABF93BB67E56D6F\",\n \"Name\": \"Microsoft Visual C++ 2015-2019 Redistributable (x64) - 14.28.29910\",\n \"PiracyRisk\": 0,\n \"SoftwareId\": 19048,\n \"Version\": \"14.28.29910.0\"\n },\n {\n \"CorpName\": \"\",\n \"Id\": 18949,\n \"InstallDate\": \"2024/06/06\",\n \"Mid\": \"B454307F6CA03B56E0CFEC44EABF93BB67E56D6F\",\n \"Name\": \"Microsoft Visual C++ 2013 Redistributable (x86) - 12.0.21005\",\n \"PiracyRisk\": 0,\n \"SoftwareId\": 18949,\n \"Version\": \"12.0.21005.1\"\n },\n {\n \"CorpName\": \"\",\n \"Id\": 22978,\n \"InstallDate\": \"2025/04/12\",\n \"Mid\": \"B454307F6CA03B56E0CFEC44EABF93BB67E56D6F\",\n \"Name\": \"Microsoft Edge WebView2 Runtime\",\n \"PiracyRisk\": 0,\n \"SoftwareId\": 22978,\n \"Version\": \"135.0.3179.73\"\n },\n {\n \"CorpName\": \"\",\n \"Id\": 19046,\n \"InstallDate\": \"2024/12/13\",\n \"Mid\": \"B454307F6CA03B56E0CFEC44EABF93BB67E56D6F\",\n \"Name\": \"EasyConnect\",\n \"PiracyRisk\": 0,\n \"SoftwareId\": 19046,\n \"Version\": \"7,6,7,201\"\n },\n {\n \"CorpName\": \"\",\n \"Id\": 19045,\n \"InstallDate\": \"2025/03/28\",\n \"Mid\": \"B454307F6CA03B56E0CFEC44EABF93BB67E56D6F\",\n \"Name\": \"DACS版本2023H1(43989)S\",\n \"PiracyRisk\": 0,\n \"SoftwareId\": 19045,\n \"Version\": \"2023H1(43989)S\"\n },\n {\n \"CorpName\": \"\",\n \"Id\": 18806,\n \"InstallDate\": \"2025/03/31\",\n \"Mid\": \"B454307F6CA03B56E0CFEC44EABF93BB67E56D6F\",\n \"Name\": \"Cloudbase-Init 1.1.2\",\n \"PiracyRisk\": 0,\n \"SoftwareId\": 18806,\n \"Version\": \"1.1.2.0\"\n },\n {\n \"CorpName\": \"\",\n \"Id\": 6786,\n \"InstallDate\": \"2024/01/30\",\n \"Mid\": \"B454307F6CA03B56E0CFEC44EABF93BB67E56D6F\",\n \"Name\": \"7-Zip 23.01 (x64)\",\n \"PiracyRisk\": 0,\n \"SoftwareId\": 6786,\n \"Version\": \"23.01\"\n }\n ],\n \"Page\": {\n \"PageCount\": 1,\n \"PageNum\": 1,\n \"PageSize\": 1000,\n \"Total\": 29\n }\n },\n \"RequestId\": \"fc18a581-36b5-4904-90c0-a206583251d9\"\n }\n}",
112
+ "title": "获取设备安装软件信息"
113
+ }
100
114
  ]
101
115
  },
102
116
  "version": "1.0"
@@ -22,7 +22,7 @@
22
22
  "status": "online"
23
23
  },
24
24
  "BindProducts": {
25
- "document": "批量绑定子产品",
25
+ "document": "批量绑定子产品。",
26
26
  "input": "BindProductsRequest",
27
27
  "name": "批量绑定子产品",
28
28
  "output": "BindProductsResponse",
@@ -561,7 +561,7 @@
561
561
  "status": "online"
562
562
  },
563
563
  "DescribeGatewaySubProducts": {
564
- "document": "用于获取网关可绑定或解绑的子产品",
564
+ "document": "用于获取网关可绑定或解绑的子产品。",
565
565
  "input": "DescribeGatewaySubProductsRequest",
566
566
  "name": "获取网关可操作的子产品",
567
567
  "output": "DescribeGatewaySubProductsResponse",
@@ -1128,7 +1128,7 @@
1128
1128
  "status": "online"
1129
1129
  },
1130
1130
  "UnbindProducts": {
1131
- "document": "批量解绑子产品",
1131
+ "document": "批量解绑子产品。",
1132
1132
  "input": "UnbindProductsRequest",
1133
1133
  "name": "批量解绑子产品",
1134
1134
  "output": "UnbindProductsResponse",
@@ -15456,7 +15456,7 @@
15456
15456
  {
15457
15457
  "disabled": false,
15458
15458
  "document": "产品ID",
15459
- "example": "BJQM4UXMKN",
15459
+ "example": "BJQM4UXKN",
15460
15460
  "member": "string",
15461
15461
  "name": "ProductId",
15462
15462
  "required": true,
@@ -16617,7 +16617,7 @@
16617
16617
  {
16618
16618
  "disabled": false,
16619
16619
  "document": "网关产品ID",
16620
- "example": "12345ABCDE",
16620
+ "example": "5GH6PKLE",
16621
16621
  "member": "string",
16622
16622
  "name": "GatewayProductId",
16623
16623
  "required": true,
@@ -16626,7 +16626,7 @@
16626
16626
  {
16627
16627
  "disabled": false,
16628
16628
  "document": "待解绑的子产品ID数组",
16629
- "example": "[\"12345ABCDE\\r\\n\"]",
16629
+ "example": "[\"12OPF89HFE\"]",
16630
16630
  "member": "string",
16631
16631
  "name": "ProductIds",
16632
16632
  "required": true,
@@ -16644,7 +16644,7 @@
16644
16644
  "example": "[\"gateway_test1\"]",
16645
16645
  "member": "string",
16646
16646
  "name": "GatewayDeviceNames",
16647
- "required": true,
16647
+ "output_required": true,
16648
16648
  "type": "list",
16649
16649
  "value_allowed_null": false
16650
16650
  },
@@ -1417,7 +1417,7 @@
1417
1417
  "UnbindProducts": [
1418
1418
  {
1419
1419
  "document": "",
1420
- "input": "https://iotexplorer.tencentcloudapi.com/?Action=UnbindProducts\n&GatewayProductId=12345ABCDE\n&ProductIds.0=12345ABCDE\n&<公共请求参数>",
1420
+ "input": "https://iotexplorer.tencentcloudapi.com/?Action=UnbindProducts\n&GatewayProductId=89FEGTES8\n&ProductIds.0=UJ8HE90G\n&<公共请求参数>",
1421
1421
  "output": "{\n \"Response\": {\n \"GatewayDeviceNames\": [\n \"gateway_test1\"\n ],\n \"RequestId\": \"32150866-743e-4a1b-ade5-c690ac2cc0b5\"\n }\n}",
1422
1422
  "title": "批量解绑子产品"
1423
1423
  }