tccli 3.0.1241.1__py2.py3-none-any.whl → 3.0.1243.1__py2.py3-none-any.whl
Sign up to get free protection for your applications and to get access to all the features.
- tccli/__init__.py +1 -1
- tccli/services/apm/v20210622/api.json +216 -216
- tccli/services/apm/v20210622/examples.json +5 -5
- tccli/services/bh/v20230418/api.json +9 -0
- tccli/services/bh/v20230418/examples.json +2 -2
- tccli/services/cfs/v20190719/api.json +20 -20
- tccli/services/cfs/v20190719/examples.json +7 -7
- tccli/services/ckafka/v20190819/api.json +38 -0
- tccli/services/clb/v20180317/api.json +107 -82
- tccli/services/clb/v20180317/examples.json +14 -14
- tccli/services/cls/cls_client.py +220 -8
- tccli/services/cls/v20201016/api.json +417 -39
- tccli/services/cls/v20201016/examples.json +89 -45
- tccli/services/cwp/v20180228/api.json +3 -3
- tccli/services/cwp/v20180228/examples.json +2 -2
- tccli/services/cynosdb/v20190107/api.json +18 -18
- tccli/services/dbbrain/v20210527/api.json +1 -1
- tccli/services/dnspod/v20210323/api.json +173 -119
- tccli/services/dnspod/v20210323/examples.json +18 -18
- tccli/services/ecm/v20190719/api.json +11 -11
- tccli/services/ecm/v20190719/examples.json +1 -1
- tccli/services/emr/v20190103/api.json +896 -841
- tccli/services/ess/v20201111/api.json +18 -9
- tccli/services/ess/v20201111/examples.json +6 -0
- tccli/services/essbasic/v20210526/api.json +80 -2
- tccli/services/gaap/v20180529/api.json +16 -18
- tccli/services/goosefs/v20220519/api.json +17 -17
- tccli/services/goosefs/v20220519/examples.json +4 -4
- tccli/services/gwlb/v20240906/api.json +14 -14
- tccli/services/hunyuan/v20230901/api.json +1 -1
- tccli/services/iotexplorer/v20190423/api.json +1 -1
- tccli/services/iotvideoindustry/v20201201/api.json +244 -192
- tccli/services/iotvideoindustry/v20201201/examples.json +32 -32
- tccli/services/live/v20180801/api.json +1 -1
- tccli/services/mna/v20210119/api.json +110 -109
- tccli/services/mna/v20210119/examples.json +63 -63
- tccli/services/mps/v20190612/api.json +9 -0
- tccli/services/ocr/ocr_client.py +110 -4
- tccli/services/ocr/v20181119/api.json +370 -7
- tccli/services/ocr/v20181119/examples.json +20 -4
- tccli/services/pts/v20210728/api.json +37 -34
- tccli/services/pts/v20210728/examples.json +13 -13
- tccli/services/sqlserver/v20180328/api.json +68 -6
- tccli/services/ssl/v20191205/api.json +52 -50
- tccli/services/ssl/v20191205/examples.json +7 -7
- tccli/services/tbaas/v20180416/api.json +9 -6
- tccli/services/tbaas/v20180416/examples.json +2 -2
- tccli/services/tcb/v20180608/api.json +270 -221
- tccli/services/tcb/v20180608/examples.json +22 -22
- tccli/services/tcm/v20210413/api.json +2 -2
- tccli/services/tcm/v20210413/examples.json +2 -2
- tccli/services/tcr/v20190924/api.json +8 -8
- tccli/services/tcr/v20190924/examples.json +4 -4
- tccli/services/tdmq/tdmq_client.py +167 -8
- tccli/services/tdmq/v20200217/api.json +307 -0
- tccli/services/tdmq/v20200217/examples.json +24 -0
- tccli/services/tem/v20210701/api.json +1 -1
- tccli/services/tem/v20210701/examples.json +2 -2
- tccli/services/teo/v20220901/api.json +2 -2
- tccli/services/teo/v20220901/examples.json +3 -3
- tccli/services/thpc/v20211109/api.json +74 -100
- tccli/services/thpc/v20211109/examples.json +2 -2
- tccli/services/thpc/v20220401/api.json +196 -223
- tccli/services/thpc/v20220401/examples.json +1 -1
- tccli/services/thpc/v20230321/api.json +150 -153
- tccli/services/thpc/v20230321/examples.json +3 -3
- tccli/services/tke/v20180525/api.json +1 -1
- tccli/services/tke/v20180525/examples.json +2 -2
- tccli/services/tke/v20220501/api.json +161 -112
- tccli/services/tke/v20220501/examples.json +15 -21
- tccli/services/trocket/trocket_client.py +53 -0
- tccli/services/trocket/v20230308/api.json +219 -0
- tccli/services/trocket/v20230308/examples.json +8 -0
- tccli/services/trtc/v20190722/api.json +31 -20
- tccli/services/trtc/v20190722/examples.json +11 -11
- tccli/services/tse/v20201207/api.json +141 -113
- tccli/services/tse/v20201207/examples.json +5 -5
- tccli/services/tsf/v20180326/examples.json +1 -1
- tccli/services/vpc/v20170312/api.json +320 -270
- tccli/services/vpc/v20170312/examples.json +40 -40
- tccli/services/waf/v20180125/api.json +2 -2
- {tccli-3.0.1241.1.dist-info → tccli-3.0.1243.1.dist-info}/METADATA +2 -2
- {tccli-3.0.1241.1.dist-info → tccli-3.0.1243.1.dist-info}/RECORD +86 -86
- {tccli-3.0.1241.1.dist-info → tccli-3.0.1243.1.dist-info}/WHEEL +0 -0
- {tccli-3.0.1241.1.dist-info → tccli-3.0.1243.1.dist-info}/entry_points.txt +0 -0
- {tccli-3.0.1241.1.dist-info → tccli-3.0.1243.1.dist-info}/license_files/LICENSE +0 -0
@@ -2078,7 +2078,7 @@
|
|
2078
2078
|
},
|
2079
2079
|
{
|
2080
2080
|
"disabled": false,
|
2081
|
-
"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>: 范围12 :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>: 范围12 :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类型时</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></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类型时</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>\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\">\n <thead>\n <tr>\n <th>字段名称</th>\n <th>类型</th>\n <th>描述</th>\n </tr>\n </thead>\n <tbody>\n <tr>\n <td>ComponentType</td>\n <td>string</td>\n <td>子控件类型-可选值:SIGN_SIGNATURE,SIGN_DATE,SIGN_SELECTOR,SIGN_MULTI_LINE_TEXT</td>\n </tr>\n <tr>\n <td>ComponentName</td>\n <td>string</td>\n <td>子控件名称</td>\n </tr>\n <tr>\n <td>Placeholder</td>\n <td>string</td>\n <td>子控件提示语</td>\n </tr>\n <tr>\n <td>ComponentOffsetX</td>\n <td>float</td>\n <td>控件偏移位置X(相对于父控件(签批控件的ComponentX))</td>\n </tr>\n <tr>\n <td>ComponentOffsetY</td>\n <td>float</td>\n <td>控件偏移位置Y 相对于父控件(签批控件的ComponentY))</td>\n </tr>\n <tr>\n <td>ComponentWidth</td>\n <td>float</td>\n <td>控件宽</td>\n </tr>\n <tr>\n <td>ComponentHeight</td>\n <td>float</td>\n <td>控件高</td>\n </tr>\n <tr>\n <td>ComponentExtra</td>\n <td>string</td>\n <td>控件的附属信息,根据ComponentType设置</td>\n </tr>\n </tbody>\n</table>\n<b>参数样例</b>:\n```json\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```\n</ul>\n\n",
|
2081
|
+
"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>: 范围12 :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>: 范围12 :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类型时</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></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类型时</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\">\n <thead>\n <tr>\n <th>字段名称</th>\n <th>类型</th>\n <th>描述</th>\n </tr>\n </thead>\n <tbody>\n <tr>\n <td>ComponentType</td>\n <td>string</td>\n <td>子控件类型-可选值:SIGN_SIGNATURE,SIGN_DATE,SIGN_SELECTOR,SIGN_MULTI_LINE_TEXT</td>\n </tr>\n <tr>\n <td>ComponentName</td>\n <td>string</td>\n <td>子控件名称</td>\n </tr>\n <tr>\n <td>Placeholder</td>\n <td>string</td>\n <td>子控件提示语</td>\n </tr>\n <tr>\n <td>ComponentOffsetX</td>\n <td>float</td>\n <td>控件偏移位置X(相对于父控件(签批控件的ComponentX))</td>\n </tr>\n <tr>\n <td>ComponentOffsetY</td>\n <td>float</td>\n <td>控件偏移位置Y 相对于父控件(签批控件的ComponentY))</td>\n </tr>\n <tr>\n <td>ComponentWidth</td>\n <td>float</td>\n <td>控件宽</td>\n </tr>\n <tr>\n <td>ComponentHeight</td>\n <td>float</td>\n <td>控件高</td>\n </tr>\n <tr>\n <td>ComponentExtra</td>\n <td>string</td>\n <td>控件的附属信息,根据ComponentType设置</td>\n </tr>\n </tbody>\n</table>\n<b>参数样例</b>:\n \n```json\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```\n</ul>\n\n",
|
2082
2082
|
"example": "无",
|
2083
2083
|
"member": "string",
|
2084
2084
|
"name": "ComponentExtra",
|
@@ -5525,7 +5525,7 @@
|
|
5525
5525
|
},
|
5526
5526
|
{
|
5527
5527
|
"disabled": false,
|
5528
|
-
"document": "对方打开链接认证时,法人姓名是否要与接口传递上来的保持一致。<ul><li><b>false(默认值)</b>:关闭状态,实际认证时允许与接口传递的信息存在不一致。</li><li><b>true</b>:启用状态,实际认证时必须与接口传递的信息完全相符。</li></ul
|
5528
|
+
"document": "对方打开链接认证时,法人姓名是否要与接口传递上来的保持一致。<ul><li><b>false(默认值)</b>:关闭状态,实际认证时允许与接口传递的信息存在不一致。</li><li><b>true</b>:启用状态,实际认证时必须与接口传递的信息完全相符。</li></ul>\n\np.s. 仅在法人姓名不为空时有效",
|
5529
5529
|
"example": "无",
|
5530
5530
|
"member": "bool",
|
5531
5531
|
"name": "LegalNameSame",
|
@@ -5534,7 +5534,7 @@
|
|
5534
5534
|
},
|
5535
5535
|
{
|
5536
5536
|
"disabled": false,
|
5537
|
-
"document": "对方打开链接认证时,认证人姓名是否要与接口传递上来的保持一致。<ul><li><b>false(默认值)</b>:关闭状态,实际认证时允许与接口传递的信息存在不一致。</li><li><b>true</b>:启用状态,实际认证时必须与接口传递的信息完全相符。</li></ul
|
5537
|
+
"document": "对方打开链接认证时,认证人姓名是否要与接口传递上来的保持一致。<ul><li><b>false(默认值)</b>:关闭状态,实际认证时允许与接口传递的信息存在不一致。</li><li><b>true</b>:启用状态,实际认证时必须与接口传递的信息完全相符。</li></ul>\n\np.s. 仅在认证人姓名不为空时有效",
|
5538
5538
|
"example": "无",
|
5539
5539
|
"member": "bool",
|
5540
5540
|
"name": "AdminNameSame",
|
@@ -5543,7 +5543,7 @@
|
|
5543
5543
|
},
|
5544
5544
|
{
|
5545
5545
|
"disabled": false,
|
5546
|
-
"document": "对方打开链接认证时,认证人居民身份证件号是否要与接口传递上来的保持一致。<ul><li><b>false(默认值)</b>:关闭状态,实际认证时允许与接口传递的信息存在不一致。</li><li><b>true</b>:启用状态,实际认证时必须与接口传递的信息完全相符。</li></ul
|
5546
|
+
"document": "对方打开链接认证时,认证人居民身份证件号是否要与接口传递上来的保持一致。<ul><li><b>false(默认值)</b>:关闭状态,实际认证时允许与接口传递的信息存在不一致。</li><li><b>true</b>:启用状态,实际认证时必须与接口传递的信息完全相符。</li></ul>\n\np.s. 仅在认证人身份证号不为空时有效\n",
|
5547
5547
|
"example": "无",
|
5548
5548
|
"member": "bool",
|
5549
5549
|
"name": "AdminIdCardNumberSame",
|
@@ -5552,7 +5552,7 @@
|
|
5552
5552
|
},
|
5553
5553
|
{
|
5554
5554
|
"disabled": false,
|
5555
|
-
"document": "对方打开链接认证时,认证人手机号是否要与接口传递上来的保持一致。<ul>\n<li><b>false(默认值)</b>:关闭状态,实际认证时允许与接口传递的信息存在不一致。</li>\n<li><b>true</b>:启用状态,实际认证时必须与接口传递的信息完全相符。</li>\n</ul
|
5555
|
+
"document": "对方打开链接认证时,认证人手机号是否要与接口传递上来的保持一致。<ul>\n<li><b>false(默认值)</b>:关闭状态,实际认证时允许与接口传递的信息存在不一致。</li>\n<li><b>true</b>:启用状态,实际认证时必须与接口传递的信息完全相符。</li>\n</ul>\n\np.s. 仅在认证人手机号不为空时有效",
|
5556
5556
|
"example": "无",
|
5557
5557
|
"member": "bool",
|
5558
5558
|
"name": "AdminMobileSame",
|
@@ -5561,7 +5561,7 @@
|
|
5561
5561
|
},
|
5562
5562
|
{
|
5563
5563
|
"disabled": false,
|
5564
|
-
"document": "对方打开链接认证时,企业名称是否要与接口传递上来的保持一致。<ul><li><b>false(默认值)</b>:关闭状态,实际认证时允许与接口传递的信息存在不一致。</li><li><b>true</b>:启用状态,实际认证时必须与接口传递的信息完全相符。</li></ul
|
5564
|
+
"document": "对方打开链接认证时,企业名称是否要与接口传递上来的保持一致。<ul><li><b>false(默认值)</b>:关闭状态,实际认证时允许与接口传递的信息存在不一致。</li><li><b>true</b>:启用状态,实际认证时必须与接口传递的信息完全相符。</li></ul>\n\n\np.s. 仅在企业名称不为空时有效",
|
5565
5565
|
"example": "无",
|
5566
5566
|
"member": "bool",
|
5567
5567
|
"name": "OrganizationNameSame",
|
@@ -5594,6 +5594,15 @@
|
|
5594
5594
|
"name": "Initialization",
|
5595
5595
|
"required": false,
|
5596
5596
|
"type": "list"
|
5597
|
+
},
|
5598
|
+
{
|
5599
|
+
"disabled": false,
|
5600
|
+
"document": "授权书(PNG或JPG或PDF) base64格式, 大小不超过8M 。 \n授权书可以通过接口[生成企业授权书](https://qian.tencent.com/developers/companyApis/organizations/CreateOrganizationAuthFile) 来获得。\np.s. 如果上传授权书 ,需遵循以下条件 \n1. 超管的信息(超管姓名,超管手机号)必须为必填参数。\n2. 认证方式AuthorizationTypes必须只能是上传授权书方式 ",
|
5601
|
+
"example": "无",
|
5602
|
+
"member": "string",
|
5603
|
+
"name": "PowerOfAttorneys",
|
5604
|
+
"required": false,
|
5605
|
+
"type": "list"
|
5597
5606
|
}
|
5598
5607
|
],
|
5599
5608
|
"type": "object"
|
@@ -7014,7 +7023,7 @@
|
|
7014
7023
|
},
|
7015
7024
|
{
|
7016
7025
|
"disabled": false,
|
7017
|
-
"document": "印章尺寸取值描述, 可以选择的尺寸如下:
|
7026
|
+
"document": "印章尺寸取值描述, 可以选择的尺寸如下: <ul><li> **38_38**: 圆形企业公章直径38mm, 当SealStyle是圆形的时候才有效</li> <li> **40_40**: 圆形企业公章直径40mm, 当SealStyle是圆形的时候才有效</li> <li> **42_42**(默认): 圆形企业公章直径42mm, 当SealStyle是圆形的时候才有效</li> <li> **45_45**: 圆形企业印章直径45mm, 当SealStyle是圆形的时候才有效</li> <li> **50_50**: 圆形企业印章直径45mm, 当SealStyle是圆形的时候才有效</li> <li> **58_58**: 圆形企业印章直径45mm, 当SealStyle是圆形的时候才有效</li> <li> **40_30**: 椭圆形印章40mm x 30mm, 当SealStyle是椭圆的时候才有效</li> <li> **45_30**: 椭圆形印章45mm x 30mm, 当SealStyle是椭圆的时候才有效</li> </ul>",
|
7018
7027
|
"example": "42_42",
|
7019
7028
|
"member": "string",
|
7020
7029
|
"name": "SealSize",
|
@@ -13948,8 +13957,8 @@
|
|
13948
13957
|
},
|
13949
13958
|
{
|
13950
13959
|
"disabled": false,
|
13951
|
-
"document": "授权书(PNG或JPG或PDF) base64格式, 大小不超过8M 。\np.s. 如果上传授权书 ,需遵循以下条件\n1.
|
13952
|
-
"example": "
|
13960
|
+
"document": "授权书(PNG或JPG或PDF) base64格式, 大小不超过8M 。\np.s. 如果上传授权书 ,需遵循以下条件\n1. 超管的信息(超管姓名,超管手机号)必须为必填参数。\n2. 超管的个人身份必须在电子签已经实名。\n2. 认证方式AuthorizationTypes必须只能是上传授权书方式 \n",
|
13961
|
+
"example": "无",
|
13953
13962
|
"member": "string",
|
13954
13963
|
"name": "PowerOfAttorneys",
|
13955
13964
|
"required": false,
|
@@ -870,6 +870,12 @@
|
|
870
870
|
"input": "POST / HTTP/1.1\nHost: ess.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: CreateOrganizationAuthUrl\n<公共请求参数>\n\n{\n \"Operator\": {\n \"UserId\": \"yDwfsUUckpsqt647UE6uSrk1ZWhYH56z\"\n },\n \"Endpoint\": \"SHORT_URL\",\n \"AuthorizationTypes\": [\n 1,\n 2,\n 3\n ],\n \"UniformSocialCreditCode\": \"9144030071526726XG\",\n \"OrganizationName\": \"典子谦示例企业\",\n \"UniformSocialCreditCodeSame\": true,\n \"OrganizationNameSame\": true,\n \"Initialization\": [\n 1\n ]\n}",
|
871
871
|
"output": "{\n \"Response\": {\n \"AuthUrl\": \"https://essurl.cn/24VopUGBZyF\",\n \"ExpiredTime\": 1733388643,\n \"RequestId\": \"a34b6e8e-4a3e-444d-8853-b34f90096254\"\n }\n}",
|
872
872
|
"title": "创建企业认证链接"
|
873
|
+
},
|
874
|
+
{
|
875
|
+
"document": "场景:创建企业认证链接, 通过超管授权书上传, 这个场景一般是法人不方便操作的时候使用\n授权书的文件生成 可以通过接口[生成企业授权书](https://qian.tencent.com/developers/companyApis/organizations/CreateOrganizationAuthFile) 然后转成 base64 格式。\n但是必须得保证超管和创建企业认证是同一个人。\n\n1. AuthorizationTypes 必须且只能传递 1- 授权书认证。\n2. PowerOfAttorneys base64 格式的文件流 数组。 单个大小不能超过 8M。\n\n",
|
876
|
+
"input": "POST / HTTP/1.1\nHost: ess.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: CreateOrganizationAuthUrl\n<公共请求参数>\n\n{\n \"Operator\": {\n \"UserId\": \"yDwfsUUckpsqt647UE6uSrk1ZWhYH56z\",\n \"ClientIp\": \"8.8.8.8\"\n },\n \"Endpoint\": \"PC\",\n \"AuthorizationTypes\": [\n 1\n ],\n \"AdminName\": \"典子谦\",\n \"AdminMobile\": \"13200000000\",\n \"BusinessLicense\": \"base64格式的营业执照文件流\",\n \"PowerOfAttorneys\": [\n \"base64格式的授权书文件流\"\n ]\n}",
|
877
|
+
"output": "{\n \"Response\": {\n \"AuthUrl\": \"https://test.qian.tencent.cn/console/register-callback?token=yDCYOUUckp7aat8yUxJf7vsvwREPT0Th\",\n \"ExpiredTime\": 1743070967,\n \"RequestId\": \"s1735294966632123121\"\n }\n}",
|
878
|
+
"title": "创建企业认证链接-通过授权书上传"
|
873
879
|
}
|
874
880
|
],
|
875
881
|
"CreateOrganizationBatchSignUrl": [
|
@@ -6076,7 +6076,7 @@
|
|
6076
6076
|
},
|
6077
6077
|
{
|
6078
6078
|
"disabled": false,
|
6079
|
-
"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>: 范围12 :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>: 范围12 :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类型时</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></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类型时</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>\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\">\n <thead>\n <tr>\n <th>字段名称</th>\n <th>类型</th>\n <th>描述</th>\n </tr>\n </thead>\n <tbody>\n <tr>\n <td>ComponentType</td>\n <td>string</td>\n <td>子控件类型-可选值:SIGN_SIGNATURE,SIGN_DATE,SIGN_SELECTOR,SIGN_MULTI_LINE_TEXT</td>\n </tr>\n <tr>\n <td>ComponentName</td>\n <td>string</td>\n <td>子控件名称</td>\n </tr>\n <tr>\n <td>Placeholder</td>\n <td>string</td>\n <td>子控件提示语</td>\n </tr>\n <tr>\n <td>ComponentOffsetX</td>\n <td>float</td>\n <td>控件偏移位置X(相对于父控件(签批控件的ComponentX))</td>\n </tr>\n <tr>\n <td>ComponentOffsetY</td>\n <td>float</td>\n <td>控件偏移位置Y 相对于父控件(签批控件的ComponentY))</td>\n </tr>\n <tr>\n <td>ComponentWidth</td>\n <td>float</td>\n <td>控件宽</td>\n </tr>\n <tr>\n <td>ComponentHeight</td>\n <td>float</td>\n <td>控件高</td>\n </tr>\n <tr>\n <td>ComponentExtra</td>\n <td>string</td>\n <td>控件的附属信息,根据ComponentType设置</td>\n </tr>\n </tbody>\n</table>\n<b>参数样例</b>:\n```json\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```\n</ul>\n\n\n\n",
|
6079
|
+
"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>: 范围12 :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>: 范围12 :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类型时</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></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类型时</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\">\n <thead>\n <tr>\n <th>字段名称</th>\n <th>类型</th>\n <th>描述</th>\n </tr>\n </thead>\n <tbody>\n <tr>\n <td>ComponentType</td>\n <td>string</td>\n <td>子控件类型-可选值:SIGN_SIGNATURE,SIGN_DATE,SIGN_SELECTOR,SIGN_MULTI_LINE_TEXT</td>\n </tr>\n <tr>\n <td>ComponentName</td>\n <td>string</td>\n <td>子控件名称</td>\n </tr>\n <tr>\n <td>Placeholder</td>\n <td>string</td>\n <td>子控件提示语</td>\n </tr>\n <tr>\n <td>ComponentOffsetX</td>\n <td>float</td>\n <td>控件偏移位置X(相对于父控件(签批控件的ComponentX))</td>\n </tr>\n <tr>\n <td>ComponentOffsetY</td>\n <td>float</td>\n <td>控件偏移位置Y 相对于父控件(签批控件的ComponentY))</td>\n </tr>\n <tr>\n <td>ComponentWidth</td>\n <td>float</td>\n <td>控件宽</td>\n </tr>\n <tr>\n <td>ComponentHeight</td>\n <td>float</td>\n <td>控件高</td>\n </tr>\n <tr>\n <td>ComponentExtra</td>\n <td>string</td>\n <td>控件的附属信息,根据ComponentType设置</td>\n </tr>\n </tbody>\n</table>\n<b>参数样例</b>:\n\n```json\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```\n</ul>\n\n\n\n",
|
6080
6080
|
"example": "ComponentExtra",
|
6081
6081
|
"member": "string",
|
6082
6082
|
"name": "ComponentExtra",
|
@@ -6861,6 +6861,51 @@
|
|
6861
6861
|
"name": "AutoActive",
|
6862
6862
|
"required": false,
|
6863
6863
|
"type": "bool"
|
6864
|
+
},
|
6865
|
+
{
|
6866
|
+
"disabled": false,
|
6867
|
+
"document": "营业执照正面照(支持PNG或JPG格式)需以base64格式提供,且文件大小不得超过5MB。",
|
6868
|
+
"example": "无",
|
6869
|
+
"member": "string",
|
6870
|
+
"name": "BusinessLicense",
|
6871
|
+
"required": false,
|
6872
|
+
"type": "string"
|
6873
|
+
},
|
6874
|
+
{
|
6875
|
+
"disabled": false,
|
6876
|
+
"document": "组织机构企业注册地址。 请确认该企业注册地址与企业营业执照中注册的地址一致。\t",
|
6877
|
+
"example": "深圳市南山区高新区科技中一路腾讯大厦",
|
6878
|
+
"member": "string",
|
6879
|
+
"name": "ProxyAddress",
|
6880
|
+
"required": false,
|
6881
|
+
"type": "string"
|
6882
|
+
},
|
6883
|
+
{
|
6884
|
+
"disabled": false,
|
6885
|
+
"document": "组织机构法人的姓名。 请确认该企业统一社会信用代码与企业营业执照中注册的法人姓名一致。\t",
|
6886
|
+
"example": "典子谦",
|
6887
|
+
"member": "string",
|
6888
|
+
"name": "ProxyLegalName",
|
6889
|
+
"required": false,
|
6890
|
+
"type": "string"
|
6891
|
+
},
|
6892
|
+
{
|
6893
|
+
"disabled": false,
|
6894
|
+
"document": "授权书(PNG或JPG或PDF) base64格式, 大小不超过8M 。\n p.s. 如果上传授权书 ,需遵循以下条件 \n1. 超管的信息(超管姓名,超管手机号)必须为必填参数。 \n2. 认证方式AuthorizationTypes必须只能是上传授权书方式\t",
|
6895
|
+
"example": "无",
|
6896
|
+
"member": "string",
|
6897
|
+
"name": "PowerOfAttorneys",
|
6898
|
+
"required": false,
|
6899
|
+
"type": "list"
|
6900
|
+
},
|
6901
|
+
{
|
6902
|
+
"disabled": false,
|
6903
|
+
"document": "企业认证时个性化能力信息",
|
6904
|
+
"example": "无",
|
6905
|
+
"member": "OrganizationAuthorizationOptions",
|
6906
|
+
"name": "OrganizationAuthorizationOptions",
|
6907
|
+
"required": false,
|
6908
|
+
"type": "object"
|
6864
6909
|
}
|
6865
6910
|
],
|
6866
6911
|
"type": "object"
|
@@ -7694,7 +7739,7 @@
|
|
7694
7739
|
},
|
7695
7740
|
{
|
7696
7741
|
"disabled": false,
|
7697
|
-
"document": "印章尺寸取值描述, 可以选择的尺寸如下:
|
7742
|
+
"document": "印章尺寸取值描述, 可以选择的尺寸如下: <ul><li> **38_38**: 圆形企业公章直径38mm, 当SealStyle是圆形的时候才有效</li> <li> **40_40**: 圆形企业公章直径40mm, 当SealStyle是圆形的时候才有效</li> <li> **42_42**(默认): 圆形企业公章直径42mm, 当SealStyle是圆形的时候才有效</li> <li> **45_45**: 圆形企业印章直径45mm, 当SealStyle是圆形的时候才有效</li> <li> **50_50**: 圆形企业印章直径45mm, 当SealStyle是圆形的时候才有效</li> <li> **58_58**: 圆形企业印章直径45mm, 当SealStyle是圆形的时候才有效</li> <li> **40_30**: 椭圆形印章40mm x 30mm, 当SealStyle是椭圆的时候才有效</li> <li> **45_30**: 椭圆形印章45mm x 30mm, 当SealStyle是椭圆的时候才有效</li> </ul>",
|
7698
7743
|
"example": "42_42",
|
7699
7744
|
"member": "string",
|
7700
7745
|
"name": "SealSize",
|
@@ -11251,6 +11296,39 @@
|
|
11251
11296
|
],
|
11252
11297
|
"usage": "out"
|
11253
11298
|
},
|
11299
|
+
"OrganizationAuthorizationOptions": {
|
11300
|
+
"document": "企业认证可选项,其中包括 社会信用代码是否一致,企业名称是否一致,法人是否一致等信息。\n代表生成链接的时候指定的这些信息不能被用户修改。\n\np.s. 注意这些选项一旦传递,相关的信息也不会被上传的营业执照里面包含的信息所覆盖。",
|
11301
|
+
"members": [
|
11302
|
+
{
|
11303
|
+
"disabled": false,
|
11304
|
+
"document": "对方打开链接认证时,对方填写的营业执照的社会信用代码是否与接口上传上来的要保持一致。<ul><li><b>false(默认值)</b>:关闭状态,实际认证时允许与接口传递的信息存在不一致。</li><li><b>true</b>:启用状态,实际认证时必须与接口传递的信息完全相符。</li></ul>",
|
11305
|
+
"example": "false",
|
11306
|
+
"member": "bool",
|
11307
|
+
"name": "UniformSocialCreditCodeSame",
|
11308
|
+
"required": false,
|
11309
|
+
"type": "bool"
|
11310
|
+
},
|
11311
|
+
{
|
11312
|
+
"disabled": false,
|
11313
|
+
"document": "对方打开链接认证时,企业名称是否要与接口传递上来的保持一致。<ul><li><b>false(默认值)</b>:关闭状态,实际认证时允许与接口传递的信息存在不一致。</li><li><b>true</b>:启用状态,实际认证时必须与接口传递的信息完全相符。</li></ul>p.s. 仅在企业名称不为空时有效",
|
11314
|
+
"example": "false",
|
11315
|
+
"member": "bool",
|
11316
|
+
"name": "OrganizationNameSame",
|
11317
|
+
"required": false,
|
11318
|
+
"type": "bool"
|
11319
|
+
},
|
11320
|
+
{
|
11321
|
+
"disabled": false,
|
11322
|
+
"document": "对方打开链接认证时,法人姓名是否要与接口传递上来的保持一致。<ul><li><b>false(默认值)</b>:关闭状态,实际认证时允许与接口传递的信息存在不一致。</li><li><b>true</b>:启用状态,实际认证时必须与接口传递的信息完全相符。</li></ul>p.s. 仅在法人姓名不为空时有效",
|
11323
|
+
"example": "false",
|
11324
|
+
"member": "bool",
|
11325
|
+
"name": "LegalNameSame",
|
11326
|
+
"required": false,
|
11327
|
+
"type": "bool"
|
11328
|
+
}
|
11329
|
+
],
|
11330
|
+
"usage": "in"
|
11331
|
+
},
|
11254
11332
|
"OrganizationCommonInfo": {
|
11255
11333
|
"document": "企业认证信息参数, 需要保证这些参数跟营业执照中的信息一致。",
|
11256
11334
|
"members": [
|
@@ -1226,12 +1226,11 @@
|
|
1226
1226
|
{
|
1227
1227
|
"disabled": false,
|
1228
1228
|
"document": "电信鉴权的Token",
|
1229
|
-
"example": "
|
1229
|
+
"example": "auth-token",
|
1230
1230
|
"member": "string",
|
1231
1231
|
"name": "CTCCToken",
|
1232
1232
|
"required": false,
|
1233
|
-
"type": "string"
|
1234
|
-
"value_allowed_null": false
|
1233
|
+
"type": "string"
|
1235
1234
|
},
|
1236
1235
|
{
|
1237
1236
|
"disabled": false,
|
@@ -1240,8 +1239,7 @@
|
|
1240
1239
|
"member": "string",
|
1241
1240
|
"name": "Province",
|
1242
1241
|
"required": false,
|
1243
|
-
"type": "string"
|
1244
|
-
"value_allowed_null": false
|
1242
|
+
"type": "string"
|
1245
1243
|
}
|
1246
1244
|
],
|
1247
1245
|
"usage": "in"
|
@@ -1394,7 +1392,7 @@
|
|
1394
1392
|
{
|
1395
1393
|
"disabled": false,
|
1396
1394
|
"document": "证书名字。\n注意:此字段可能返回 null,表示取不到有效值。",
|
1397
|
-
"example": "
|
1395
|
+
"example": "cert-alias",
|
1398
1396
|
"member": "string",
|
1399
1397
|
"name": "CertificateAlias",
|
1400
1398
|
"output_required": true,
|
@@ -1404,7 +1402,7 @@
|
|
1404
1402
|
{
|
1405
1403
|
"disabled": false,
|
1406
1404
|
"document": "证书内容。",
|
1407
|
-
"example": "
|
1405
|
+
"example": "Cert-Content",
|
1408
1406
|
"member": "string",
|
1409
1407
|
"name": "CertificateContent",
|
1410
1408
|
"output_required": true,
|
@@ -1414,7 +1412,7 @@
|
|
1414
1412
|
{
|
1415
1413
|
"disabled": false,
|
1416
1414
|
"document": "密钥内容。仅当证书类型为SSL证书时,返回该字段。\n注意:此字段可能返回 null,表示取不到有效值。",
|
1417
|
-
"example": "
|
1415
|
+
"example": "Cert-Key",
|
1418
1416
|
"member": "string",
|
1419
1417
|
"name": "CertificateKey",
|
1420
1418
|
"output_required": true,
|
@@ -1454,7 +1452,7 @@
|
|
1454
1452
|
{
|
1455
1453
|
"disabled": false,
|
1456
1454
|
"document": "证书签发者通用名称。\n注意:此字段可能返回 null,表示取不到有效值。",
|
1457
|
-
"example": "
|
1455
|
+
"example": "cn-name",
|
1458
1456
|
"member": "string",
|
1459
1457
|
"name": "IssuerCN",
|
1460
1458
|
"output_required": true,
|
@@ -9192,7 +9190,7 @@
|
|
9192
9190
|
{
|
9193
9191
|
"disabled": false,
|
9194
9192
|
"document": "需开启安全策略的通道ID",
|
9195
|
-
"example": "link-
|
9193
|
+
"example": "link-4324dqse",
|
9196
9194
|
"member": "string",
|
9197
9195
|
"name": "ProxyId",
|
9198
9196
|
"required": false,
|
@@ -9201,7 +9199,7 @@
|
|
9201
9199
|
{
|
9202
9200
|
"disabled": false,
|
9203
9201
|
"document": "安全策略ID",
|
9204
|
-
"example": "
|
9202
|
+
"example": "policy-adddasd",
|
9205
9203
|
"member": "string",
|
9206
9204
|
"name": "PolicyId",
|
9207
9205
|
"required": false,
|
@@ -9219,7 +9217,7 @@
|
|
9219
9217
|
"example": "1234.2",
|
9220
9218
|
"member": "string",
|
9221
9219
|
"name": "TaskId",
|
9222
|
-
"
|
9220
|
+
"output_required": true,
|
9223
9221
|
"type": "string",
|
9224
9222
|
"value_allowed_null": false
|
9225
9223
|
},
|
@@ -10104,7 +10102,7 @@
|
|
10104
10102
|
"example": "1.1.1.1",
|
10105
10103
|
"member": "string",
|
10106
10104
|
"name": "RealServerIP",
|
10107
|
-
"
|
10105
|
+
"output_required": true,
|
10108
10106
|
"type": "string",
|
10109
10107
|
"value_allowed_null": false
|
10110
10108
|
},
|
@@ -10114,17 +10112,17 @@
|
|
10114
10112
|
"example": "rs-0d7gb1dr",
|
10115
10113
|
"member": "string",
|
10116
10114
|
"name": "RealServerId",
|
10117
|
-
"
|
10115
|
+
"output_required": true,
|
10118
10116
|
"type": "string",
|
10119
10117
|
"value_allowed_null": false
|
10120
10118
|
},
|
10121
10119
|
{
|
10122
10120
|
"disabled": false,
|
10123
10121
|
"document": "源站名称",
|
10124
|
-
"example": "
|
10122
|
+
"example": "server-name",
|
10125
10123
|
"member": "string",
|
10126
10124
|
"name": "RealServerName",
|
10127
|
-
"
|
10125
|
+
"output_required": true,
|
10128
10126
|
"type": "string",
|
10129
10127
|
"value_allowed_null": false
|
10130
10128
|
},
|
@@ -10134,7 +10132,7 @@
|
|
10134
10132
|
"example": "0",
|
10135
10133
|
"member": "uint64",
|
10136
10134
|
"name": "ProjectId",
|
10137
|
-
"
|
10135
|
+
"output_required": true,
|
10138
10136
|
"type": "int",
|
10139
10137
|
"value_allowed_null": false
|
10140
10138
|
},
|
@@ -10144,7 +10142,7 @@
|
|
10144
10142
|
"example": "0",
|
10145
10143
|
"member": "int64",
|
10146
10144
|
"name": "InBanBlacklist",
|
10147
|
-
"
|
10145
|
+
"output_required": true,
|
10148
10146
|
"type": "int",
|
10149
10147
|
"value_allowed_null": false
|
10150
10148
|
}
|
@@ -524,40 +524,40 @@
|
|
524
524
|
{
|
525
525
|
"disabled": false,
|
526
526
|
"document": "集群ID",
|
527
|
-
"example": "
|
527
|
+
"example": "g_cvm_1w778cgf",
|
528
528
|
"member": "string",
|
529
529
|
"name": "ClusterId",
|
530
|
-
"
|
530
|
+
"output_required": true,
|
531
531
|
"type": "string",
|
532
532
|
"value_allowed_null": false
|
533
533
|
},
|
534
534
|
{
|
535
535
|
"disabled": false,
|
536
536
|
"document": "角色名",
|
537
|
-
"example": "
|
537
|
+
"example": "test",
|
538
538
|
"member": "string",
|
539
539
|
"name": "RoleName",
|
540
|
-
"
|
540
|
+
"output_required": true,
|
541
541
|
"type": "string",
|
542
542
|
"value_allowed_null": false
|
543
543
|
},
|
544
544
|
{
|
545
545
|
"disabled": false,
|
546
546
|
"document": "描述",
|
547
|
-
"example": "
|
547
|
+
"example": "test",
|
548
548
|
"member": "string",
|
549
549
|
"name": "Description",
|
550
|
-
"
|
550
|
+
"output_required": true,
|
551
551
|
"type": "string",
|
552
552
|
"value_allowed_null": false
|
553
553
|
},
|
554
554
|
{
|
555
555
|
"disabled": false,
|
556
556
|
"document": "目录列表",
|
557
|
-
"example": "
|
557
|
+
"example": "[\"/data/goosefs\",\"/data/goosefs_data\"]",
|
558
558
|
"member": "string",
|
559
559
|
"name": "DirectoryList",
|
560
|
-
"
|
560
|
+
"output_required": true,
|
561
561
|
"type": "list",
|
562
562
|
"value_allowed_null": false
|
563
563
|
}
|
@@ -869,7 +869,7 @@
|
|
869
869
|
{
|
870
870
|
"disabled": false,
|
871
871
|
"document": "集群ID",
|
872
|
-
"example": "
|
872
|
+
"example": "g_cvm_h8kz3o02",
|
873
873
|
"member": "string",
|
874
874
|
"name": "ClusterId",
|
875
875
|
"required": true,
|
@@ -906,7 +906,7 @@
|
|
906
906
|
{
|
907
907
|
"disabled": false,
|
908
908
|
"document": "集群ID",
|
909
|
-
"example": "
|
909
|
+
"example": "g_cvm_x419f8qc",
|
910
910
|
"member": "string",
|
911
911
|
"name": "ClusterId",
|
912
912
|
"required": true,
|
@@ -915,7 +915,7 @@
|
|
915
915
|
{
|
916
916
|
"disabled": false,
|
917
917
|
"document": "角色名",
|
918
|
-
"example": "
|
918
|
+
"example": "test",
|
919
919
|
"member": "string",
|
920
920
|
"name": "RoleName",
|
921
921
|
"required": true,
|
@@ -952,7 +952,7 @@
|
|
952
952
|
{
|
953
953
|
"disabled": false,
|
954
954
|
"document": "集群ID",
|
955
|
-
"example": "
|
955
|
+
"example": "g_cvm_x419f8qc",
|
956
956
|
"member": "string",
|
957
957
|
"name": "ClusterId",
|
958
958
|
"required": true,
|
@@ -961,7 +961,7 @@
|
|
961
961
|
{
|
962
962
|
"disabled": false,
|
963
963
|
"document": "角色名",
|
964
|
-
"example": "
|
964
|
+
"example": "GooseFS_QCSLinkedRoleInManageCloudService",
|
965
965
|
"member": "string",
|
966
966
|
"name": "RoleName",
|
967
967
|
"required": false,
|
@@ -1744,20 +1744,20 @@
|
|
1744
1744
|
{
|
1745
1745
|
"disabled": false,
|
1746
1746
|
"document": "角色名",
|
1747
|
-
"example": "
|
1747
|
+
"example": "test",
|
1748
1748
|
"member": "string",
|
1749
1749
|
"name": "RoleName",
|
1750
|
-
"
|
1750
|
+
"output_required": true,
|
1751
1751
|
"type": "string",
|
1752
1752
|
"value_allowed_null": false
|
1753
1753
|
},
|
1754
1754
|
{
|
1755
1755
|
"disabled": false,
|
1756
1756
|
"document": "用于goosefs client/sdk等\n注意:此字段可能返回 null,表示取不到有效值。",
|
1757
|
-
"example": "
|
1757
|
+
"example": "MTY4ODQ2NTA1NF84MzM2X2E3ZWFmMDVmLWI0MzMtNGE2Yi1iOWU2LTZiZDY5OTYwXXXXXX==",
|
1758
1758
|
"member": "string",
|
1759
1759
|
"name": "Token",
|
1760
|
-
"
|
1760
|
+
"output_required": true,
|
1761
1761
|
"type": "string",
|
1762
1762
|
"value_allowed_null": true
|
1763
1763
|
}
|