tccli 3.0.1116.1__py2.py3-none-any.whl → 3.0.1117.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 CHANGED
@@ -1 +1 @@
1
- __version__ = '3.0.1116.1'
1
+ __version__ = '3.0.1117.1'
@@ -1380,6 +1380,22 @@
1380
1380
  ],
1381
1381
  "usage": "out"
1382
1382
  },
1383
+ "Clb": {
1384
+ "document": "负载均衡",
1385
+ "members": [
1386
+ {
1387
+ "disabled": false,
1388
+ "document": "负载均衡IP\n注意:此字段可能返回 null,表示取不到有效值。",
1389
+ "example": "无",
1390
+ "member": "string",
1391
+ "name": "ClbIp",
1392
+ "output_required": false,
1393
+ "type": "string",
1394
+ "value_allowed_null": true
1395
+ }
1396
+ ],
1397
+ "usage": "out"
1398
+ },
1383
1399
  "CmdTemplate": {
1384
1400
  "document": "高危命令模板",
1385
1401
  "members": [
@@ -4112,6 +4128,24 @@
4112
4128
  "name": "ResourceIds",
4113
4129
  "required": false,
4114
4130
  "type": "list"
4131
+ },
4132
+ {
4133
+ "disabled": false,
4134
+ "document": "每页条目数量",
4135
+ "example": "20",
4136
+ "member": "uint64",
4137
+ "name": "Limit",
4138
+ "required": false,
4139
+ "type": "int"
4140
+ },
4141
+ {
4142
+ "disabled": false,
4143
+ "document": "分页偏移位置",
4144
+ "example": "0",
4145
+ "member": "uint64",
4146
+ "name": "Offset",
4147
+ "required": false,
4148
+ "type": "int"
4115
4149
  }
4116
4150
  ],
4117
4151
  "type": "object"
@@ -4125,10 +4159,20 @@
4125
4159
  "example": "无",
4126
4160
  "member": "Resource",
4127
4161
  "name": "ResourceSet",
4128
- "required": true,
4162
+ "output_required": true,
4129
4163
  "type": "list",
4130
4164
  "value_allowed_null": false
4131
4165
  },
4166
+ {
4167
+ "disabled": false,
4168
+ "document": "堡垒机资源数量\n注意:此字段可能返回 null,表示取不到有效值。",
4169
+ "example": "无",
4170
+ "member": "uint64",
4171
+ "name": "TotalCount",
4172
+ "output_required": false,
4173
+ "type": "int",
4174
+ "value_allowed_null": true
4175
+ },
4132
4176
  {
4133
4177
  "document": "唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。",
4134
4178
  "member": "string",
@@ -6328,6 +6372,16 @@
6328
6372
  "output_required": true,
6329
6373
  "type": "string",
6330
6374
  "value_allowed_null": true
6375
+ },
6376
+ {
6377
+ "disabled": false,
6378
+ "document": "堡垒机资源LB\n注意:此字段可能返回 null,表示取不到有效值。",
6379
+ "example": "无",
6380
+ "member": "Clb",
6381
+ "name": "ClbSet",
6382
+ "output_required": false,
6383
+ "type": "list",
6384
+ "value_allowed_null": true
6331
6385
  }
6332
6386
  ],
6333
6387
  "usage": "out"
@@ -312,7 +312,7 @@
312
312
  {
313
313
  "document": "查询用户购买的资源信息,包括资源ID,授权点数,vpc,过期时间等。",
314
314
  "input": "POST / HTTP/1.1\nHost: dasb.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: DescribeResources\n<公共请求参数>\n\n{}",
315
- "output": "{\n \"Response\": {\n \"RequestId\": \"xx\",\n \"ResourceSet\": [\n {\n \"RenewFlag\": 1,\n \"Zone\": \"xx\",\n \"SubnetName\": \"xx\",\n \"Nodes\": 1,\n \"Status\": 1,\n \"VpcId\": \"xx\",\n \"SubProductCode\": \"xx\",\n \"ResourceId\": \"xx\",\n \"PackageBandwidth\": 1,\n \"VpcName\": \"xx\",\n \"ApCode\": \"xx\",\n \"SubnetId\": \"xx\",\n \"ResourceName\": \"xx\",\n \"Expired\": true,\n \"Deployed\": true,\n \"ProductCode\": \"xx\",\n \"PublicIpSet\": [\n \"xx\"\n ],\n \"ModuleSet\": [\n \"xx\"\n ],\n \"ExtendPoints\": 1,\n \"UsedNodes\": 1,\n \"PrivateIpSet\": [\n \"xx\"\n ],\n \"Pid\": 1,\n \"VpcCidrBlock\": \"xx\",\n \"PackageNode\": 1,\n \"ExpireTime\": \"2020-09-22T00:00:00+00:00\",\n \"SvArgs\": \"xx\",\n \"CidrBlock\": \"xx\",\n \"CreateTime\": \"2020-09-22T00:00:00+00:00\"\n }\n ]\n }\n}",
315
+ "output": "{\n \"Response\": {\n \"RequestId\": \"rid-test\",\n \"ResourceSet\": [\n {\n \"RenewFlag\": 1,\n \"Zone\": \"ap-guangzhou-6\",\n \"SubnetName\": \"subnet-test\",\n \"Nodes\": 1,\n \"Status\": 1,\n \"VpcId\": \"vpc-test\",\n \"SubProductCode\": \"sp_cds_dasb_bh_saas\",\n \"ResourceId\": \"bh-saas-test\",\n \"PackageBandwidth\": 1,\n \"VpcName\": \"vpc-test\",\n \"ApCode\": \"ap-guangzhou\",\n \"SubnetId\": \"subnet-test\",\n \"ResourceName\": \"T-Sec-堡垒机(SaaS型)/专业版\",\n \"Expired\": true,\n \"Deployed\": true,\n \"ProductCode\": \"p_cds_dasb\",\n \"PublicIpSet\": [\n \"1.1.1.1\"\n ],\n \"ModuleSet\": [\n \"DB\"\n ],\n \"ExtendPoints\": 1,\n \"UsedNodes\": 1,\n \"PrivateIpSet\": [\n \"1.1.1.1\"\n ],\n \"Pid\": 1,\n \"VpcCidrBlock\": \"192.168.0.0/16\",\n \"PackageNode\": 1,\n \"ExpireTime\": \"2020-09-22T00:00:00+00:00\",\n \"SvArgs\": \"sv_cds_dasb_saas_free_2node\",\n \"CidrBlock\": \"192.168.11.0/24\",\n \"CreateTime\": \"2020-09-22T00:00:00+00:00\",\n \"LogDeliveryArgs\": \"\"\n }\n ]\n }\n}",
316
316
  "title": "查询资源信息"
317
317
  }
318
318
  ],
@@ -50,7 +50,7 @@
50
50
  "status": "online"
51
51
  },
52
52
  "CreateBatchSignUrl": {
53
- "document": "通过此接口,可以创建小程序批量签署链接,个人/企业员工可通过此链接跳转至小程序进行批量签署。请确保生成链接时的身份信息与签署合同参与方的信息保持一致。\n\n注意事项:\n- 使用此接口生成链接,需要贵企业先开通 <font color=\"red\">使用手机号验证签署方身份 </font>功能。您可以在 <b>【腾讯电子签网页端】->【企业设置】->【拓展服务】</b>中找到该功能。\n- 生成批量签署链接时,<font color=\"red\">合同目标参与方的状态必须为<b>待签署</b>状态</font>。签署人人点击链接后需要输入短信验证码才能查看合同内容。\n- 企业员工批量签署链接:需要传入签署方所在企业名称,用户名字和手机号(或者身份证件信息)参数来生成签署链接。<font color=\"red\">该签署方企业必须已完成腾讯电子签企业认证</font>\n- 个人批量签署链接:需要传入签署方用户名字和手机号(或者身份证件信息)参数来生成签署链接。<font color=\"red\">签名区仅支持手写签名</font>",
53
+ "document": "通过此接口,可以创建小程序批量签署链接,个人/企业员工可通过此链接跳转至小程序进行批量签署。请确保生成链接时的身份信息与签署合同参与方的信息保持一致。\n\n注意事项:\n- 使用此接口生成链接,需要贵企业先开通 <font color=\"red\">使用手机号验证签署方身份 </font>功能。您可以在 <b>【腾讯电子签网页端】->【企业设置】->【拓展服务】</b>中找到该功能。\n- 生成批量签署链接时,<font color=\"red\">合同目标参与方的状态必须为<b>待签署</b>状态</font>。签署人点击链接后需要输入短信验证码才能查看合同内容。\n- 企业员工批量签署链接:需要传入签署方所在企业名称,用户名字和手机号(或者身份证件信息)参数来生成签署链接。<font color=\"red\">该签署方企业必须已完成腾讯电子签企业认证</font>\n- 个人批量签署链接:需要传入签署方用户名字和手机号(或者身份证件信息)参数来生成签署链接。<font color=\"red\">签名区仅支持手写签名</font>",
54
54
  "input": "CreateBatchSignUrlRequest",
55
55
  "name": "获取跳转至腾讯电子签小程序的批量签署链接",
56
56
  "output": "CreateBatchSignUrlResponse",
@@ -731,7 +731,7 @@
731
731
  },
732
732
  {
733
733
  "disabled": false,
734
- "document": "签署方经办人的证件类型,支持以下类型\n<ul><li>ID_CARD 居民身份证 (默认值)</li>\n<li>HONGKONG_AND_MACAO 港澳居民来往内地通行证</li>\n<li>HONGKONG_MACAO_AND_TAIWAN 港澳台居民居住证(格式同居民身份证)</li>\n<li>OTHER_CARD_TYPE 其他证件</li></ul>\n\n注: `其他证件类型为白名单功能,使用前请联系对接的客户经理沟通。`",
734
+ "document": "签署方经办人的证件类型,支持以下类型\n<ul><li>ID_CARD 中国大陆居民身份证 (默认值)</li>\n<li>HONGKONG_AND_MACAO 港澳居民来往内地通行证</li>\n<li>HONGKONG_MACAO_AND_TAIWAN 港澳台居民居住证(格式同居民身份证)</li>\n<li>OTHER_CARD_TYPE 其他证件</li></ul>\n\n注: `其他证件类型为白名单功能,使用前请联系对接的客户经理沟通。`",
735
735
  "example": "ID_CARD",
736
736
  "member": "string",
737
737
  "name": "ApproverIdCardType",
@@ -1731,7 +1731,7 @@
1731
1731
  },
1732
1732
  {
1733
1733
  "disabled": false,
1734
- "document": "**在绝对定位方式方式下**,指定控件所在PDF文件上的页码\n\n注:\n1. 页码编号是从<font color=\"red\">1</font>开始编号的。\n2. <font color=\"red\">页面编号不能超过PDF文件的页码总数</font>。如果指定的页码超过了PDF文件的页码总数,在填写和签署时会出现错误,导致无法正常进行操作。",
1734
+ "document": "**在绝对定位方式方式下**,指定控件所在PDF文件上的页码\n**在使用文件发起的情况下**,绝对定位方式的填写控件和签署控件支持使用负数来指定控件在PDF文件上的页码,使用负数时,页码从最后一页开始。例如:ComponentPage设置为-1,即代表在PDF文件的最后一页,以此类推。\n\n注:\n1. 页码编号是从<font color=\"red\">1</font>开始编号的。\n2. <font color=\"red\">页面编号不能超过PDF文件的页码总数</font>。如果指定的页码超过了PDF文件的页码总数,在填写和签署时会出现错误,导致无法正常进行操作。",
1735
1735
  "example": "无",
1736
1736
  "member": "int64",
1737
1737
  "name": "ComponentPage",
@@ -1852,7 +1852,7 @@
1852
1852
  },
1853
1853
  {
1854
1854
  "disabled": false,
1855
- "document": "控件填充vaule,ComponentType和传入值类型对应关系:\n<ul><li> <b>TEXT</b> : 文本内容</li>\n<li> <b>MULTI_LINE_TEXT</b> : 文本内容</li>\n<li> <b>CHECK_BOX</b> : true/false</li>\n<li> <b>FILL_IMAGE、ATTACHMENT</b> : 附件的FileId,需要通过UploadFiles接口上传获取</li>\n<li> <b>SELECTOR</b> : 选项值</li>\n<li> <b>DYNAMIC_TABLE</b> - 传入json格式的表格内容,详见说明:[数据表格](https://qian.tencent.com/developers/company/dynamic_table)</li>\n<li> <b>DATE</b> : 默认是格式化为xxxx年xx月xx日</li>\n<li> <b>SIGN_SEAL</b> : 印章ID,于控制台查询获取, [点击查看在控制台上位置](https://qcloudimg.tencent-cloud.cn/raw/f7b0f2ea4a534aada4b893dbf9671eae.png)</li>\n<li> <b>SIGN_PAGING_SEAL</b> : 可以指定印章ID,于控制台查询获取, [点击查看在控制台上位置](https://qcloudimg.tencent-cloud.cn/raw/f7b0f2ea4a534aada4b893dbf9671eae.png)</li></ul>\n\n\n<b>控件值约束说明</b>:\n<table> <thead> <tr> <th>特殊控件</th> <th>填写约束</th> </tr> </thead> <tbody> <tr> <td>企业全称控件</td> <td>企业名称中文字符中文括号</td> </tr> <tr> <td>统一社会信用代码控件</td> <td>企业注册的统一社会信用代码</td> </tr> <tr> <td>法人名称控件</td> <td>最大50个字符,2到25个汉字或者1到50个字母</td> </tr> <tr> <td>签署意见控件</td> <td>签署意见最大长度为50字符</td> </tr> <tr> <td>签署人手机号控件</td> <td>国内手机号 13,14,15,16,17,18,19号段长度11位</td> </tr> <tr> <td>签署人身份证控件</td> <td>合法的身份证号码检查</td> </tr> <tr> <td>控件名称</td> <td>控件名称最大长度为20字符,不支持表情</td> </tr> <tr> <td>单行文本控件</td> <td>只允许输入中文,英文,数字,中英文标点符号,不支持表情</td> </tr> <tr> <td>多行文本控件</td> <td>只允许输入中文,英文,数字,中英文标点符号,不支持表情</td> </tr> <tr> <td>勾选框控件</td> <td>选择填字符串true,不选填字符串false</td> </tr> <tr> <td>选择器控件</td> <td>同单行文本控件约束,填写选择值中的字符串</td> </tr> <tr> <td>数字控件</td> <td>请输入有效的数字(可带小数点)</td> </tr> <tr> <td>日期控件</td> <td>格式:yyyy年mm月dd日</td> </tr> <tr> <td>附件控件</td> <td>JPG或PNG图片,上传数量限制,1到6个,最大6个附件,填写上传的资源ID</td> </tr> <tr> <td>图片控件</td> <td>JPG或PNG图片,填写上传的图片资源ID</td> </tr> <tr> <td>邮箱控件</td> <td>有效的邮箱地址, w3c标准</td> </tr> <tr> <td>地址控件</td> <td>只允许输入中文,英文,数字,中英文标点符号,不支持表情</td> </tr> <tr> <td>省市区控件</td> <td>只允许输入中文,英文,数字,中英文标点符号,不支持表情</td> </tr> <tr> <td>性别控件</td> <td>选择值中的字符串</td> </tr> <tr> <td>学历控件</td> <td>选择值中的字符串</td> </tr> </tbody> </table>\n注: `部分特殊控件需要在控制台配置模板形式创建`",
1855
+ "document": "控件填充vaule,ComponentType和传入值类型对应关系:\n<ul><li> <b>TEXT</b> : 文本内容</li>\n<li> <b>MULTI_LINE_TEXT</b> : 文本内容,可以用 \\n 来控制换行位置 </li>\n<li> <b>CHECK_BOX</b> : true/false</li>\n<li> <b>FILL_IMAGE、ATTACHMENT</b> : 附件的FileId,需要通过UploadFiles接口上传获取</li>\n<li> <b>SELECTOR</b> : 选项值</li>\n<li> <b>DYNAMIC_TABLE</b> - 传入json格式的表格内容,详见说明:[数据表格](https://qian.tencent.com/developers/company/dynamic_table)</li>\n<li> <b>DATE</b> : 格式化为:xxxx年xx月xx日(例如2024年05年28日)</li>\n<li> <b>SIGN_SEAL</b> : 印章ID,于控制台查询获取, [点击查看在控制台上位置](https://qcloudimg.tencent-cloud.cn/raw/f7b0f2ea4a534aada4b893dbf9671eae.png)</li>\n<li> <b>SIGN_PAGING_SEAL</b> : 可以指定印章ID,于控制台查询获取, [点击查看在控制台上位置](https://qcloudimg.tencent-cloud.cn/raw/f7b0f2ea4a534aada4b893dbf9671eae.png)</li></ul>\n\n\n<b>控件值约束说明</b>:\n<table> <thead> <tr> <th>特殊控件</th> <th>填写约束</th> </tr> </thead> <tbody> <tr> <td>企业全称控件</td> <td>企业名称中文字符中文括号</td> </tr> <tr> <td>统一社会信用代码控件</td> <td>企业注册的统一社会信用代码</td> </tr> <tr> <td>法人名称控件</td> <td>最大50个字符,2到25个汉字或者1到50个字母</td> </tr> <tr> <td>签署意见控件</td> <td>签署意见最大长度为50字符</td> </tr> <tr> <td>签署人手机号控件</td> <td>国内手机号 13,14,15,16,17,18,19号段长度11位</td> </tr> <tr> <td>签署人身份证控件</td> <td>合法的身份证号码检查</td> </tr> <tr> <td>控件名称</td> <td>控件名称最大长度为20字符,不支持表情</td> </tr> <tr> <td>单行文本控件</td> <td>只允许输入中文,英文,数字,中英文标点符号,不支持表情</td> </tr> <tr> <td>多行文本控件</td> <td>只允许输入中文,英文,数字,中英文标点符号,不支持表情</td> </tr> <tr> <td>勾选框控件</td> <td>选择填字符串true,不选填字符串false</td> </tr> <tr> <td>选择器控件</td> <td>同单行文本控件约束,填写选择值中的字符串</td> </tr> <tr> <td>数字控件</td> <td>请输入有效的数字(可带小数点)</td> </tr> <tr> <td>日期控件</td> <td>格式:yyyy年mm月dd日</td> </tr> <tr> <td>附件控件</td> <td>JPG或PNG图片,上传数量限制,1到6个,最大6个附件,填写上传的资源ID</td> </tr> <tr> <td>图片控件</td> <td>JPG或PNG图片,填写上传的图片资源ID</td> </tr> <tr> <td>邮箱控件</td> <td>有效的邮箱地址, w3c标准</td> </tr> <tr> <td>地址控件</td> <td>只允许输入中文,英文,数字,中英文标点符号,不支持表情</td> </tr> <tr> <td>省市区控件</td> <td>只允许输入中文,英文,数字,中英文标点符号,不支持表情</td> </tr> <tr> <td>性别控件</td> <td>选择值中的字符串</td> </tr> <tr> <td>学历控件</td> <td>选择值中的字符串</td> </tr> </tbody> </table>\n注: `部分特殊控件需要在控制台配置模板形式创建`",
1856
1856
  "example": "无",
1857
1857
  "member": "string",
1858
1858
  "name": "ComponentValue",
@@ -2291,7 +2291,7 @@
2291
2291
  },
2292
2292
  {
2293
2293
  "disabled": false,
2294
- "document": "签署方经办人的姓名。\n经办人的姓名将用于身份认证和电子签名,请确保填写的姓名为签署方的真实姓名,而非昵称等代名。\n\n注:`请确保和合同中填入的一致`",
2294
+ "document": "签署方经办人的姓名。\n经办人的姓名将用于身份认证和电子签名,请确保填写的姓名为签署方的真实姓名,而非昵称等代名。\n\n注:`请确保和合同中填入的一致`, `除动态签署人场景外,此参数必填`",
2295
2295
  "example": "无",
2296
2296
  "member": "string",
2297
2297
  "name": "Name",
@@ -2300,7 +2300,7 @@
2300
2300
  },
2301
2301
  {
2302
2302
  "disabled": false,
2303
- "document": "手机号码, 支持国内手机号11位数字(无需加+86前缀或其他字符)。\n请确认手机号所有方为此业务通知方。\n\n注:`请确保和合同中填入的一致, 若无法保持一致,请确保在发起和生成批量签署链接时传入相同的参与方证件信息`",
2303
+ "document": "手机号码, 支持国内手机号11位数字(无需加+86前缀或其他字符)。\n请确认手机号所有方为此业务通知方。\n\n注:`请确保和合同中填入的一致, 若无法保持一致,请确保在发起和生成批量签署链接时传入相同的参与方证件信息`,`除动态签署人场景外,此参数必填`",
2304
2304
  "example": "无",
2305
2305
  "member": "string",
2306
2306
  "name": "Mobile",
@@ -2318,7 +2318,7 @@
2318
2318
  },
2319
2319
  {
2320
2320
  "disabled": false,
2321
- "document": "证件类型,支持以下类型\n<ul><li>ID_CARD : 居民身份证 (默认值)</li>\n<li>HONGKONG_AND_MACAO : 港澳居民来往内地通行证</li>\n<li>HONGKONG_MACAO_AND_TAIWAN : 港澳台居民居住证(格式同居民身份证)</li></ul>\n\n注:`请确保和合同中填入的一致`",
2321
+ "document": "证件类型,支持以下类型\n<ul><li>ID_CARD : 中国大陆居民身份证 (默认值)</li>\n<li>HONGKONG_AND_MACAO : 港澳居民来往内地通行证</li>\n<li>HONGKONG_MACAO_AND_TAIWAN : 港澳台居民居住证(格式同居民身份证)</li></ul>\n\n注:`请确保和合同中填入的一致`",
2322
2322
  "example": "无",
2323
2323
  "member": "string",
2324
2324
  "name": "IdCardType",
@@ -4605,7 +4605,7 @@
4605
4605
  },
4606
4606
  {
4607
4607
  "disabled": false,
4608
- "document": "认证人证件类型\n支持以下类型\n<ul><li>ID_CARD : 居民身份证 (默认值)</li>\n<li>HONGKONG_AND_MACAO : 港澳居民来往内地通行证</li>\n<li>HONGKONG_MACAO_AND_TAIWAN : 港澳台居民居住证(格式同居民身份证)</li></ul>\n",
4608
+ "document": "认证人证件类型\n支持以下类型\n<ul><li>ID_CARD : 中国大陆居民身份证 (默认值)</li>\n<li>HONGKONG_AND_MACAO : 港澳居民来往内地通行证</li>\n<li>HONGKONG_MACAO_AND_TAIWAN : 港澳台居民居住证(格式同居民身份证)</li></ul>\n",
4609
4609
  "example": "无",
4610
4610
  "member": "string",
4611
4611
  "name": "AdminIdCardType",
@@ -5333,7 +5333,7 @@
5333
5333
  },
5334
5334
  {
5335
5335
  "disabled": false,
5336
- "document": "证件类型,支持以下类型\n<ul><li>ID_CARD : 居民身份证 (默认值)</li>\n<li>HONGKONG_AND_MACAO : 港澳居民来往内地通行证</li>\n<li>HONGKONG_MACAO_AND_TAIWAN : 港澳台居民居住证(格式同居民身份证)</li></ul>",
5336
+ "document": "证件类型,支持以下类型\n<ul><li>ID_CARD : 中国大陆居民身份证 (默认值)</li>\n<li>HONGKONG_AND_MACAO : 港澳居民来往内地通行证</li>\n<li>HONGKONG_MACAO_AND_TAIWAN : 港澳台居民居住证(格式同居民身份证)</li></ul>",
5337
5337
  "example": "无",
5338
5338
  "member": "string",
5339
5339
  "name": "IdCardType",
@@ -9174,7 +9174,7 @@
9174
9174
  },
9175
9175
  {
9176
9176
  "disabled": false,
9177
- "document": "签署方经办人的证件类型,支持以下类型\n<ul><li>ID_CARD 居民身份证</li>\n<li>HONGKONG_AND_MACAO 港澳居民来往内地通行证</li>\n<li>HONGKONG_MACAO_AND_TAIWAN 港澳台居民居住证(格式同居民身份证)</li>\n<li>OTHER_CARD_TYPE 其他证件</li></ul>\n\n注: `1.其他证件类型为白名单功能,使用前请联系对接的客户经理沟通。`\n`2.补充个人签署方时,若该用户已在电子签完成实名则可通过指定姓名和证件类型、证件号码完成补充。`",
9177
+ "document": "签署方经办人的证件类型,支持以下类型\n<ul><li>ID_CARD 中国大陆居民身份证</li>\n<li>HONGKONG_AND_MACAO 港澳居民来往内地通行证</li>\n<li>HONGKONG_MACAO_AND_TAIWAN 港澳台居民居住证(格式同居民身份证)</li>\n<li>OTHER_CARD_TYPE 其他证件</li></ul>\n\n注: `1.其他证件类型为白名单功能,使用前请联系对接的客户经理沟通。`\n`2.补充个人签署方时,若该用户已在电子签完成实名则可通过指定姓名和证件类型、证件号码完成补充。`",
9178
9178
  "example": "ID_CARD",
9179
9179
  "member": "string",
9180
9180
  "name": "ApproverIdCardType",
@@ -10257,7 +10257,7 @@
10257
10257
  "members": [
10258
10258
  {
10259
10259
  "disabled": false,
10260
- "document": "控件填充vaule,ComponentType和传入值类型对应关系:\nTEXT 文本内容\nMULTI_LINE_TEXT :文本内容\nCHECK_BOX true/false\nFILL_IMAGE、ATTACHMENT 附件的FileId,需要通过UploadFiles接口上传获取\nSELECTOR 选项值\nDYNAMIC_TABLE :传入json格式的表格内容,具体见数据结构[点击查看](https://qian.tencent.com/developers/company/dynamic_table)",
10260
+ "document": "控件填充vaule,ComponentType和传入值类型对应关系:\n<ul><li> <b>TEXT</b> : 文本内容</li>\n<li> <b>MULTI_LINE_TEXT</b> : 文本内容, 可以用 \\n 来控制换行位置</li>\n<li> <b>CHECK_BOX</b> : true/false</li>\n<li> <b>FILL_IMAGE、ATTACHMENT</b> : 附件的FileId,需要通过UploadFiles接口上传获取</li>\n<li> <b>SELECTOR</b> : 选项值</li>\n<li> <b>DYNAMIC_TABLE</b> - 传入json格式的表格内容,详见说明:[数据表格](https://qian.tencent.com/developers/company/dynamic_table)</li>\n<li> <b>DATE</b> : 格式化:xxxx年xx月xx日(例如:2024年05月28日)</li>\n</ul>\n\n\n<b>控件值约束说明</b>:\n<table> <thead> <tr> <th>特殊控件</th> <th>填写约束</th> </tr> </thead> <tbody> <tr> <td>企业全称控件</td> <td>企业名称中文字符中文括号</td> </tr> <tr> <td>统一社会信用代码控件</td> <td>企业注册的统一社会信用代码</td> </tr> <tr> <td>法人名称控件</td> <td>最大50个字符,2到25个汉字或者1到50个字母</td> </tr> <tr> <td>签署意见控件</td> <td>签署意见最大长度为50字符</td> </tr> <tr> <td>签署人手机号控件</td> <td>国内手机号 13,14,15,16,17,18,19号段长度11位</td> </tr> <tr> <td>签署人身份证控件</td> <td>合法的身份证号码检查</td> </tr> <tr> <td>控件名称</td> <td>控件名称最大长度为20字符,不支持表情</td> </tr> <tr> <td>单行文本控件</td> <td>只允许输入中文,英文,数字,中英文标点符号,不支持表情</td> </tr> <tr> <td>多行文本控件</td> <td>只允许输入中文,英文,数字,中英文标点符号,不支持表情</td> </tr> <tr> <td>勾选框控件</td> <td>选择填字符串true,不选填字符串false</td> </tr> <tr> <td>选择器控件</td> <td>同单行文本控件约束,填写选择值中的字符串</td> </tr> <tr> <td>数字控件</td> <td>请输入有效的数字(可带小数点)</td> </tr> <tr> <td>日期控件</td> <td>格式:yyyy年mm月dd日</td> </tr> <tr> <td>附件控件</td> <td>JPG或PNG图片,上传数量限制,1到6个,最大6个附件,填写上传的资源ID</td> </tr> <tr> <td>图片控件</td> <td>JPG或PNG图片,填写上传的图片资源ID</td> </tr> <tr> <td>邮箱控件</td> <td>有效的邮箱地址, w3c标准</td> </tr> <tr> <td>地址控件</td> <td>只允许输入中文,英文,数字,中英文标点符号,不支持表情</td> </tr> <tr> <td>省市区控件</td> <td>只允许输入中文,英文,数字,中英文标点符号,不支持表情</td> </tr> <tr> <td>性别控件</td> <td>选择值中的字符串</td> </tr> <tr> <td>学历控件</td> <td>选择值中的字符串</td> </tr> </tbody> </table>\n",
10261
10261
  "example": "ComponentValue",
10262
10262
  "member": "string",
10263
10263
  "name": "ComponentValue",
@@ -11289,7 +11289,7 @@
11289
11289
  },
11290
11290
  {
11291
11291
  "disabled": false,
11292
- "document": "签署方经办人的证件类型,支持以下类型\n<ul><li>ID_CARD 居民身份证 (默认值)</li>\n<li>HONGKONG_AND_MACAO 港澳居民来往内地通行证</li>\n<li>HONGKONG_MACAO_AND_TAIWAN 港澳台居民居住证(格式同居民身份证)</li>\n<li>OTHER_CARD_TYPE 其他证件</li></ul>\n\n注: `其他证件类型为白名单功能,使用前请联系对接的客户经理沟通。`",
11292
+ "document": "签署方经办人的证件类型,支持以下类型\n<ul><li>ID_CARD 中国大陆居民身份证 (默认值)</li>\n<li>HONGKONG_AND_MACAO 港澳居民来往内地通行证</li>\n<li>HONGKONG_MACAO_AND_TAIWAN 港澳台居民居住证(格式同居民身份证)</li>\n<li>OTHER_CARD_TYPE 其他证件</li></ul>\n\n注: `其他证件类型为白名单功能,使用前请联系对接的客户经理沟通。`",
11293
11293
  "example": "ID_CARD",
11294
11294
  "member": "string",
11295
11295
  "name": "ApproverIdCardType",
@@ -13725,7 +13725,7 @@
13725
13725
  },
13726
13726
  {
13727
13727
  "disabled": false,
13728
- "document": "证件类型,支持以下类型\n<ul><li>ID_CARD : 居民身份证 (默认值)</li>\n<li>HONGKONG_AND_MACAO : 港澳居民来往内地通行证</li>\n<li>HONGKONG_MACAO_AND_TAIWAN : 港澳台居民居住证(格式同居民身份证)</li></ul>",
13728
+ "document": "证件类型,支持以下类型\n<ul><li>ID_CARD : 中国大陆居民身份证 (默认值)</li>\n<li>HONGKONG_AND_MACAO : 港澳居民来往内地通行证</li>\n<li>HONGKONG_MACAO_AND_TAIWAN : 港澳台居民居住证(格式同居民身份证)</li></ul>",
13729
13729
  "example": "ID_CARD",
13730
13730
  "member": "string",
13731
13731
  "name": "IdCardType",
@@ -43,7 +43,7 @@
43
43
  "status": "online"
44
44
  },
45
45
  "ChannelCreateBatchSignUrl": {
46
- "document": "通过此接口,创建小程序批量签署链接,个人/企业员工点击此链接即可跳转小程序进行批量签署。\n请确保生成链接时候的身份信息和签署合同参与方的信息保持一致。\n\n注:\n- 使用此接口生成链接,需要提前开通 `使用手机号验证签署方身份` 功能,在 `腾讯电子签网页端-企业设置-拓展服务` 中可以找到。\n- 参与人点击链接后需短信验证码才能查看合同内容。\n- 企业用户批量签署,需要传OrganizationName(参与方所在企业名称)参数生成签署链接,`请确保此企业已完成腾讯电子签企业认证`。暂时仅支持给`自建应用集成企业` 生成员工批签链接,不支持子客企业。\n- 个人批量签署,签名区`仅支持手写签名`。",
46
+ "document": "通过此接口,创建小程序批量签署链接,个人/企业员工点击此链接即可跳转小程序进行批量签署。\n请确保生成链接时候的身份信息和签署合同参与方的信息保持一致。\n\n注:\n- 使用此接口生成链接,需要提前开通 `使用手机号验证签署方身份` 功能,在 `腾讯电子签网页端-企业设置-拓展服务` 中可以找到。\n- 参与人点击链接后需短信验证码才能查看合同内容。\n- 企业用户批量签署,需要传OrganizationName(参与方所在企业名称)参数生成签署链接,`请确保此企业已完成腾讯电子签企业认证`。暂时仅支持给`自建应用集成企业` 生成员工批签链接,不支持子客企业。\n- 生成批量签署链接时,合同目标参与方状态需为`待签署`状态。\n- 个人批量签署,签名区`仅支持手写签名`。",
47
47
  "input": "ChannelCreateBatchSignUrlRequest",
48
48
  "name": "获取跳转至腾讯电子签小程序的批量签署链接",
49
49
  "output": "ChannelCreateBatchSignUrlResponse",
@@ -1665,7 +1665,7 @@
1665
1665
  },
1666
1666
  {
1667
1667
  "disabled": false,
1668
- "document": "签署方经办人的姓名。\n经办人的姓名将用于身份认证和电子签名,请确保填写的姓名为签署方的真实姓名,而非昵称等代名。\n\n注:`请确保和合同中填入的一致`",
1668
+ "document": "签署方经办人的姓名。\n经办人的姓名将用于身份认证和电子签名,请确保填写的姓名为签署方的真实姓名,而非昵称等代名。\n\n注:`请确保和合同中填入的一致`,`除动态签署人场景外,此参数必填`",
1669
1669
  "example": "无",
1670
1670
  "member": "string",
1671
1671
  "name": "Name",
@@ -1674,7 +1674,7 @@
1674
1674
  },
1675
1675
  {
1676
1676
  "disabled": false,
1677
- "document": "手机号码, 支持国内手机号11位数字(无需加+86前缀或其他字符)。\n请确认手机号所有方为此业务通知方。\n\n注:`请确保和合同中填入的一致, 若无法保持一致,请确保在发起和生成批量签署链接时传入相同的参与方证件信息`",
1677
+ "document": "手机号码, 支持国内手机号11位数字(无需加+86前缀或其他字符)。\n请确认手机号所有方为此业务通知方。\n\n注:`请确保和合同中填入的一致, 若无法保持一致,请确保在发起和生成批量签署链接时传入相同的参与方证件信息`,`除动态签署人场景外,此参数必填`",
1678
1678
  "example": "无",
1679
1679
  "member": "string",
1680
1680
  "name": "Mobile",
@@ -1692,7 +1692,7 @@
1692
1692
  },
1693
1693
  {
1694
1694
  "disabled": false,
1695
- "document": "证件类型,支持以下类型\n<ul><li>**ID_CARD** : 居民身份证 (默认值)</li>\n<li>**HONGKONG_AND_MACAO** : 港澳居民来往内地通行证</li>\n<li>**HONGKONG_MACAO_AND_TAIWAN** : 港澳台居民居住证(格式同居民身份证)</li></ul>\n\n注:`请确保和合同中填入的一致`",
1695
+ "document": "证件类型,支持以下类型\n<ul><li>**ID_CARD** : 中国大陆居民身份证 (默认值)</li>\n<li>**HONGKONG_AND_MACAO** : 港澳居民来往内地通行证</li>\n<li>**HONGKONG_MACAO_AND_TAIWAN** : 港澳台居民居住证(格式同居民身份证)</li></ul>\n\n注:`请确保和合同中填入的一致`",
1696
1696
  "example": "无",
1697
1697
  "member": "string",
1698
1698
  "name": "IdCardType",
@@ -3158,7 +3158,7 @@
3158
3158
  },
3159
3159
  {
3160
3160
  "disabled": false,
3161
- "document": "证件类型,支持以下类型\n<ul><li>ID_CARD : 居民身份证 (默认值)</li>\n<li>HONGKONG_AND_MACAO : 港澳居民来往内地通行证</li>\n<li>HONGKONG_MACAO_AND_TAIWAN : 港澳台居民居住证(格式同居民身份证)</li>\n<li>OTHER_CARD_TYPE : 其他</li></ul>\n\n注: `其他证件类型为白名单功能,使用前请联系对接的客户经理沟通。`",
3161
+ "document": "证件类型,支持以下类型\n<ul><li>ID_CARD : 中国大陆居民身份证 (默认值)</li>\n<li>HONGKONG_AND_MACAO : 港澳居民来往内地通行证</li>\n<li>HONGKONG_MACAO_AND_TAIWAN : 港澳台居民居住证(格式同居民身份证)</li>\n<li>OTHER_CARD_TYPE : 其他</li></ul>\n\n注: `其他证件类型为白名单功能,使用前请联系对接的客户经理沟通。`",
3162
3162
  "example": "无",
3163
3163
  "member": "string",
3164
3164
  "name": "IdCardType",
@@ -5561,8 +5561,8 @@
5561
5561
  },
5562
5562
  {
5563
5563
  "disabled": false,
5564
- "document": "**在绝对定位方式方式下**,指定控件所在PDF文件上的页码\n\n注:\n1. 页码编号是从<font color=\"red\">1</font>开始编号的。\n2. <font color=\"red\">页面编号不能超过PDF文件的页码总数</font>。如果指定的页码超过了PDF文件的页码总数,在填写和签署时会出现错误,导致无法正常进行操作。",
5565
- "example": "0",
5564
+ "document": "**在绝对定位方式方式下**,指定控件所在PDF文件上的页码\n**在使用文件发起的情况下**,绝对定位方式的填写控件和签署控件支持使用负数来指定控件在PDF文件上的页码,使用负数时,页码从最后一页开始。例如:ComponentPage设置为-1,即代表在PDF文件的最后一页,以此类推。\n\n注:\n1. 页码编号是从<font color=\"red\">1</font>开始编号的。\n2. <font color=\"red\">页面编号不能超过PDF文件的页码总数</font>。如果指定的页码超过了PDF文件的页码总数,在填写和签署时会出现错误,导致无法正常进行操作。",
5565
+ "example": "1",
5566
5566
  "member": "int64",
5567
5567
  "name": "ComponentPage",
5568
5568
  "output_required": true,
@@ -5605,7 +5605,7 @@
5605
5605
  },
5606
5606
  {
5607
5607
  "disabled": false,
5608
- "document": "控件填充vaule,ComponentType和传入值类型对应关系:\n<ul><li> <b>TEXT</b> : 文本内容</li>\n<li> <b>MULTI_LINE_TEXT</b> : 文本内容</li>\n<li> <b>CHECK_BOX</b> : true/false</li>\n<li> <b>FILL_IMAGE、ATTACHMENT</b> : 附件的FileId,需要通过UploadFiles接口上传获取</li>\n<li> <b>SELECTOR</b> : 选项值</li>\n<li> <b>DYNAMIC_TABLE</b> - 传入json格式的表格内容,详见说明:[数据表格](https://qian.tencent.com/developers/company/dynamic_table)</li>\n<li> <b>DATE</b> : 默认是格式化为xxxx年xx月xx日</li>\n<li> <b>SIGN_SEAL</b> : 印章ID,于控制台查询获取,[点击查看在控制上的位置](https://qcloudimg.tencent-cloud.cn/raw/cd403a5b949fce197fd9e88bb6db1517.png)</li>\n<li> <b>SIGN_PAGING_SEAL</b> : 可以指定印章ID,于控制台查询获取,[点击查看在控制上的位置](https://qcloudimg.tencent-cloud.cn/raw/cd403a5b949fce197fd9e88bb6db1517.png)</li></ul>\n\n\n<b>控件值约束说明</b>:\n<table> <thead> <tr> <th>特殊控件</th> <th>填写约束</th> </tr> </thead> <tbody> <tr> <td>企业全称控件</td> <td>企业名称中文字符中文括号</td> </tr> <tr> <td>统一社会信用代码控件</td> <td>企业注册的统一社会信用代码</td> </tr> <tr> <td>法人名称控件</td> <td>最大50个字符,2到25个汉字或者1到50个字母</td> </tr> <tr> <td>签署意见控件</td> <td>签署意见最大长度为50字符</td> </tr> <tr> <td>签署人手机号控件</td> <td>国内手机号 13,14,15,16,17,18,19号段长度11位</td> </tr> <tr> <td>签署人身份证控件</td> <td>合法的身份证号码检查</td> </tr> <tr> <td>控件名称</td> <td>控件名称最大长度为20字符,不支持表情</td> </tr> <tr> <td>单行文本控件</td> <td>只允许输入中文,英文,数字,中英文标点符号,不支持表情</td> </tr> <tr> <td>多行文本控件</td> <td>只允许输入中文,英文,数字,中英文标点符号,不支持表情</td> </tr> <tr> <td>勾选框控件</td> <td>选择填字符串true,不选填字符串false</td> </tr> <tr> <td>选择器控件</td> <td>同单行文本控件约束,填写选择值中的字符串</td> </tr> <tr> <td>数字控件</td> <td>请输入有效的数字(可带小数点)</td> </tr> <tr> <td>日期控件</td> <td>格式:yyyy年mm月dd日</td> </tr> <tr> <td>附件控件</td> <td>JPG或PNG图片,上传数量限制,1到6个,最大6个附件,填写上传的资源ID</td> </tr> <tr> <td>图片控件</td> <td>JPG或PNG图片,填写上传的图片资源ID</td> </tr> <tr> <td>邮箱控件</td> <td>有效的邮箱地址, w3c标准</td> </tr> <tr> <td>地址控件</td> <td>只允许输入中文,英文,数字,中英文标点符号,不支持表情</td> </tr> <tr> <td>省市区控件</td> <td>只允许输入中文,英文,数字,中英文标点符号,不支持表情</td> </tr> <tr> <td>性别控件</td> <td>选择值中的字符串</td> </tr> <tr> <td>学历控件</td> <td>选择值中的字符串</td> </tr> </tbody> </table>\n注: `部分特殊控件需要在控制台配置模板形式创建`",
5608
+ "document": "控件填充vaule,ComponentType和传入值类型对应关系:\n<ul><li> <b>TEXT</b> : 文本内容</li>\n<li> <b>MULTI_LINE_TEXT</b> : 文本内容, 可以用 \\n 来控制换行位置</li>\n<li> <b>CHECK_BOX</b> : true/false</li>\n<li> <b>FILL_IMAGE、ATTACHMENT</b> : 附件的FileId,需要通过UploadFiles接口上传获取</li>\n<li> <b>SELECTOR</b> : 选项值</li>\n<li> <b>DYNAMIC_TABLE</b> - 传入json格式的表格内容,详见说明:[数据表格](https://qian.tencent.com/developers/company/dynamic_table)</li>\n<li> <b>DATE</b> : 格式化:xxxx年xx月xx日(例如:2024年05月28日)</li>\n<li> <b>SIGN_SEAL</b> : 印章ID,于控制台查询获取,[点击查看在控制上的位置](https://qcloudimg.tencent-cloud.cn/raw/cd403a5b949fce197fd9e88bb6db1517.png)</li>\n<li> <b>SIGN_PAGING_SEAL</b> : 可以指定印章ID,于控制台查询获取,[点击查看在控制上的位置](https://qcloudimg.tencent-cloud.cn/raw/cd403a5b949fce197fd9e88bb6db1517.png)</li></ul>\n\n\n<b>控件值约束说明</b>:\n<table> <thead> <tr> <th>特殊控件</th> <th>填写约束</th> </tr> </thead> <tbody> <tr> <td>企业全称控件</td> <td>企业名称中文字符中文括号</td> </tr> <tr> <td>统一社会信用代码控件</td> <td>企业注册的统一社会信用代码</td> </tr> <tr> <td>法人名称控件</td> <td>最大50个字符,2到25个汉字或者1到50个字母</td> </tr> <tr> <td>签署意见控件</td> <td>签署意见最大长度为50字符</td> </tr> <tr> <td>签署人手机号控件</td> <td>国内手机号 13,14,15,16,17,18,19号段长度11位</td> </tr> <tr> <td>签署人身份证控件</td> <td>合法的身份证号码检查</td> </tr> <tr> <td>控件名称</td> <td>控件名称最大长度为20字符,不支持表情</td> </tr> <tr> <td>单行文本控件</td> <td>只允许输入中文,英文,数字,中英文标点符号,不支持表情</td> </tr> <tr> <td>多行文本控件</td> <td>只允许输入中文,英文,数字,中英文标点符号,不支持表情</td> </tr> <tr> <td>勾选框控件</td> <td>选择填字符串true,不选填字符串false</td> </tr> <tr> <td>选择器控件</td> <td>同单行文本控件约束,填写选择值中的字符串</td> </tr> <tr> <td>数字控件</td> <td>请输入有效的数字(可带小数点)</td> </tr> <tr> <td>日期控件</td> <td>格式:yyyy年mm月dd日</td> </tr> <tr> <td>附件控件</td> <td>JPG或PNG图片,上传数量限制,1到6个,最大6个附件,填写上传的资源ID</td> </tr> <tr> <td>图片控件</td> <td>JPG或PNG图片,填写上传的图片资源ID</td> </tr> <tr> <td>邮箱控件</td> <td>有效的邮箱地址, w3c标准</td> </tr> <tr> <td>地址控件</td> <td>只允许输入中文,英文,数字,中英文标点符号,不支持表情</td> </tr> <tr> <td>省市区控件</td> <td>只允许输入中文,英文,数字,中英文标点符号,不支持表情</td> </tr> <tr> <td>性别控件</td> <td>选择值中的字符串</td> </tr> <tr> <td>学历控件</td> <td>选择值中的字符串</td> </tr> </tbody> </table>\n注: `部分特殊控件需要在控制台配置模板形式创建`",
5609
5609
  "example": "ComponentValue",
5610
5610
  "member": "string",
5611
5611
  "name": "ComponentValue",
@@ -7966,7 +7966,7 @@
7966
7966
  },
7967
7967
  {
7968
7968
  "disabled": false,
7969
- "document": "签署方经办人的证件类型,支持以下类型\n<ul><li>ID_CARD 居民身份证</li>\n<li>HONGKONG_AND_MACAO 港澳居民来往内地通行证</li>\n<li>HONGKONG_MACAO_AND_TAIWAN 港澳台居民居住证(格式同居民身份证)</li>\n<li>OTHER_CARD_TYPE 其他证件</li></ul>\n\n注: `1.其他证件类型为白名单功能,使用前请联系对接的客户经理沟通。`\n`2.补充个人签署方时,若该用户已在电子签完成实名则可通过指定姓名和证件类型、证件号码完成补充。`",
7969
+ "document": "签署方经办人的证件类型,支持以下类型\n<ul><li>ID_CARD 中国大陆居民身份证</li>\n<li>HONGKONG_AND_MACAO 港澳居民来往内地通行证</li>\n<li>HONGKONG_MACAO_AND_TAIWAN 港澳台居民居住证(格式同居民身份证)</li>\n<li>OTHER_CARD_TYPE 其他证件</li></ul>\n\n注: `1.其他证件类型为白名单功能,使用前请联系对接的客户经理沟通。`\n`2.补充个人签署方时,若该用户已在电子签完成实名则可通过指定姓名和证件类型、证件号码完成补充。`",
7970
7970
  "example": "ID_CARD",
7971
7971
  "member": "string",
7972
7972
  "name": "ApproverIdCardType",
@@ -8242,7 +8242,7 @@
8242
8242
  },
8243
8243
  {
8244
8244
  "disabled": false,
8245
- "document": "签署方经办人的证件类型,支持以下类型\n<ul><li>ID_CARD : 居民身份证 (默认值)</li>\n<li>HONGKONG_AND_MACAO : 港澳居民来往内地通行证</li>\n<li>HONGKONG_MACAO_AND_TAIWAN : 港澳台居民居住证(格式同居民身份证)</li>\n<li>OTHER_CARD_TYPE : 其他证件</li></ul>\n\n注: `其他证件类型为白名单功能,使用前请联系对接的客户经理沟通。`",
8245
+ "document": "签署方经办人的证件类型,支持以下类型\n<ul><li>ID_CARD : 中国大陆居民身份证 (默认值)</li>\n<li>HONGKONG_AND_MACAO : 港澳居民来往内地通行证</li>\n<li>HONGKONG_MACAO_AND_TAIWAN : 港澳台居民居住证(格式同居民身份证)</li>\n<li>OTHER_CARD_TYPE : 其他证件</li></ul>\n\n注: `其他证件类型为白名单功能,使用前请联系对接的客户经理沟通。`",
8246
8246
  "example": "ID_CARD",
8247
8247
  "member": "string",
8248
8248
  "name": "IdCardType",
@@ -9080,7 +9080,7 @@
9080
9080
  "members": [
9081
9081
  {
9082
9082
  "disabled": false,
9083
- "document": "控件填充值,ComponentType和传入值格式对应关系如下:\n<ul>\n<li>TEXT - 普通文本控件,需输入文本字符串;</li>\n<li>MULTI_LINE_TEXT - 多行文本控件,需输入文本字符串;</li>\n<li>CHECK_BOX - 勾选框控件,若选中需填写ComponentValue,填写 true或者 false 字符串;</li>\n<li>FILL_IMAGE - 图片控件,需填写ComponentValue为图片的资源 ID;</li>\n<li>DYNAMIC_TABLE - 动态表格控件;</li>\n<li>ATTACHMENT - 附件控件,需填写ComponentValue为附件图片的资源 ID列表,以逗号分割;</li>\n<li>DATE - 日期控件;格式为 <b>xxxx年xx月xx日</b> 字符串;</li>\n<li>DISTRICT - 省市区行政区控件,需填写ComponentValue为省市区行政区字符串内容;</li>\n</ul>\n",
9083
+ "document": "控件填充值,ComponentType和传入值格式对应关系如下:\n<ul><li> <b>TEXT</b> : 文本内容</li>\n<li> <b>MULTI_LINE_TEXT</b> : 文本内容, 可以用 \\n 来控制换行位置</li>\n<li> <b>CHECK_BOX</b> : true/false</li>\n<li> <b>FILL_IMAGE、ATTACHMENT</b> : 附件的FileId,需要通过UploadFiles接口上传获取</li>\n<li> <b>SELECTOR</b> : 选项值</li>\n<li> <b>DYNAMIC_TABLE</b> - 传入json格式的表格内容,详见说明:[数据表格](https://qian.tencent.com/developers/partner/dynamic_table)</li>\n<li> <b>DATE</b> : 格式化:xxxx年xx月xx日(例如:2024年05月28日)</li>\n<li> <b>DISTRICT </b> : 省市区行政区控件,需填写ComponentValue为省市区行政区字符串内容</li>\n</ul>\n\n\n<b>控件值约束说明</b>:\n<table> <thead> <tr> <th>特殊控件</th> <th>填写约束</th> </tr> </thead> <tbody> <tr> <td>企业全称控件</td> <td>企业名称中文字符中文括号</td> </tr> <tr> <td>统一社会信用代码控件</td> <td>企业注册的统一社会信用代码</td> </tr> <tr> <td>法人名称控件</td> <td>最大50个字符,2到25个汉字或者1到50个字母</td> </tr> <tr> <td>签署意见控件</td> <td>签署意见最大长度为50字符</td> </tr> <tr> <td>签署人手机号控件</td> <td>国内手机号 13,14,15,16,17,18,19号段长度11位</td> </tr> <tr> <td>签署人身份证控件</td> <td>合法的身份证号码检查</td> </tr> <tr> <td>控件名称</td> <td>控件名称最大长度为20字符,不支持表情</td> </tr> <tr> <td>单行文本控件</td> <td>只允许输入中文,英文,数字,中英文标点符号,不支持表情</td> </tr> <tr> <td>多行文本控件</td> <td>只允许输入中文,英文,数字,中英文标点符号,不支持表情</td> </tr> <tr> <td>勾选框控件</td> <td>选择填字符串true,不选填字符串false</td> </tr> <tr> <td>选择器控件</td> <td>同单行文本控件约束,填写选择值中的字符串</td> </tr> <tr> <td>数字控件</td> <td>请输入有效的数字(可带小数点)</td> </tr> <tr> <td>日期控件</td> <td>格式:yyyy年mm月dd日</td> </tr> <tr> <td>附件控件</td> <td>JPG或PNG图片,上传数量限制,1到6个,最大6个附件,填写上传的资源ID</td> </tr> <tr> <td>图片控件</td> <td>JPG或PNG图片,填写上传的图片资源ID</td> </tr> <tr> <td>邮箱控件</td> <td>有效的邮箱地址, w3c标准</td> </tr> <tr> <td>地址控件</td> <td>只允许输入中文,英文,数字,中英文标点符号,不支持表情</td> </tr> <tr> <td>省市区控件</td> <td>只允许输入中文,英文,数字,中英文标点符号,不支持表情</td> </tr> <tr> <td>性别控件</td> <td>选择值中的字符串</td> </tr> <tr> <td>学历控件</td> <td>选择值中的字符串</td> </tr> </tbody> </table>\n",
9084
9084
  "example": "Name",
9085
9085
  "member": "string",
9086
9086
  "name": "ComponentValue",
@@ -9548,7 +9548,7 @@
9548
9548
  },
9549
9549
  {
9550
9550
  "disabled": false,
9551
- "document": "签署方经办人的证件类型,支持以下类型\n<ul><li>ID_CARD 居民身份证 (默认值)</li>\n<li>HONGKONG_AND_MACAO 港澳居民来往内地通行证</li>\n<li>HONGKONG_MACAO_AND_TAIWAN 港澳台居民居住证(格式同居民身份证)</li>\n<li>OTHER_CARD_TYPE 其他证件</li></ul>\n\n注: `其他证件类型为白名单功能,使用前请联系对接的客户经理沟通。`",
9551
+ "document": "签署方经办人的证件类型,支持以下类型\n<ul><li>ID_CARD 中国大陆居民身份证 (默认值)</li>\n<li>HONGKONG_AND_MACAO 港澳居民来往内地通行证</li>\n<li>HONGKONG_MACAO_AND_TAIWAN 港澳台居民居住证(格式同居民身份证)</li>\n<li>OTHER_CARD_TYPE 其他证件</li></ul>\n\n注: `其他证件类型为白名单功能,使用前请联系对接的客户经理沟通。`",
9552
9552
  "example": "ID_CARD",
9553
9553
  "member": "string",
9554
9554
  "name": "ApproverIdCardType",
@@ -10325,7 +10325,7 @@
10325
10325
  },
10326
10326
  {
10327
10327
  "disabled": false,
10328
- "document": "签署方经办人的证件类型,支持以下类型\n<ul><li>ID_CARD : 居民身份证 (默认值)</li>\n<li>HONGKONG_AND_MACAO : 港澳居民来往内地通行证</li>\n<li>HONGKONG_MACAO_AND_TAIWAN : 港澳台居民居住证(格式同居民身份证)</li></ul>\n",
10328
+ "document": "签署方经办人的证件类型,支持以下类型\n<ul><li>ID_CARD : 中国大陆居民身份证 (默认值)</li>\n<li>HONGKONG_AND_MACAO : 港澳居民来往内地通行证</li>\n<li>HONGKONG_MACAO_AND_TAIWAN : 港澳台居民居住证(格式同居民身份证)</li></ul>\n",
10329
10329
  "example": "ID_CARD ",
10330
10330
  "member": "string",
10331
10331
  "name": "IdCardType",
@@ -11428,7 +11428,7 @@
11428
11428
  },
11429
11429
  {
11430
11430
  "disabled": false,
11431
- "document": "第三方平台子客企业法定代表人的证件类型,支持以下类型\n<ul><li>ID_CARD : 居民身份证 (默认值)</li></ul>\n注: `现在仅支持ID_CARD居民身份证类型`",
11431
+ "document": "第三方平台子客企业法定代表人的证件类型,支持以下类型\n<ul><li>ID_CARD : 中国大陆居民身份证 (默认值)</li></ul>\n注: `现在仅支持ID_CARD居民身份证类型`",
11432
11432
  "example": "无",
11433
11433
  "member": "string",
11434
11434
  "name": "ProxyLegalIdCardType",
@@ -11911,7 +11911,7 @@
11911
11911
  },
11912
11912
  {
11913
11913
  "disabled": false,
11914
- "document": "证件类型,支持以下类型\n<ul><li>ID_CARD : 居民身份证 (默认值)</li>\n<li>HONGKONG_AND_MACAO : 港澳居民来往内地通行证</li>\n<li>HONGKONG_MACAO_AND_TAIWAN : 港澳台居民居住证(格式同居民身份证)</li></ul>",
11914
+ "document": "证件类型,支持以下类型\n<ul><li>ID_CARD : 中国大陆居民身份证 (默认值)</li>\n<li>HONGKONG_AND_MACAO : 港澳居民来往内地通行证</li>\n<li>HONGKONG_MACAO_AND_TAIWAN : 港澳台居民居住证(格式同居民身份证)</li></ul>",
11915
11915
  "example": "ID_CARD",
11916
11916
  "member": "string",
11917
11917
  "name": "IdCardType",
@@ -43,7 +43,7 @@
43
43
  "DescribeServiceLoginSettings": [
44
44
  {
45
45
  "document": "查询实例hai-xxxxxxxx包含的服务登录配置",
46
- "input": "POST / HTTP/1.1\nHost: cvm.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: DescribeServiceLoginSettings\n<公共请求参数>\n\n{\n \"InstanceId\": \"hai-xxxxxxxx\",\n \"ServiceName\": \"jupyter\"\n}",
46
+ "input": "POST / HTTP/1.1\nHost: hai.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: DescribeServiceLoginSettings\n<公共请求参数>\n\n{\n \"InstanceId\": \"hai-xxxxxxxx\",\n \"ServiceName\": \"jupyter\"\n}",
47
47
  "output": "{\n \"Response\": {\n \"RequestId\": \"73956f5a-0f0e-4e60-ba7d-d555bcefe27b\",\n \"LoginSettings\": [\n {\n \"ServiceName\": \"jupyter\",\n \"Url\": \"http://1.14.52.185:80?40a0153b6c8ff839b2b83f9a3918daa55facad3c3e7a9b4a0e2377bd08f4aaa2\"\n }\n ]\n }\n}",
48
48
  "title": "查询实例hai-xxxxxxxx包含的服务登录配置"
49
49
  }
@@ -258,7 +258,7 @@
258
258
  },
259
259
  {
260
260
  "disabled": false,
261
- "document": "**GIF/长图检测专用**,用于表示GIF截帧频率(每隔多少张图片抽取一帧进行检测),长图则按照长边:短边取整计算要切割的总图数;默认值为0,此时只会检测GIF的第一帧或对长图不进行切分处理。<br>备注:Interval与MaxFrames参数需要组合使用。例如,Interval=3, MaxFrames=400,则代表在检测GIF/长图时,将每间隔2帧检测一次且最多检测400帧。",
261
+ "document": "**GIF检测专用**,用于表示GIF截帧频率(每隔多少张图片抽取一帧进行检测);默认值为0,此时只会检测GIF的第一帧或不进行切分处理。<br>备注:Interval与MaxFrames参数需要组合使用。例如,Interval=3, MaxFrames=400,则代表在检测GIF时,将每间隔2帧检测一次且最多检测400帧。",
262
262
  "example": "1",
263
263
  "member": "int64",
264
264
  "name": "Interval",
@@ -267,7 +267,7 @@
267
267
  },
268
268
  {
269
269
  "disabled": false,
270
- "document": "**GIF/长图检测专用**,用于标识最大截帧数量;默认值为1,此时只会检测输入GIF的第一帧或对长图不进行切分处理(可能会造成处理超时)。<br>备注:Interval与MaxFrames参数需要组合使用。例如,Interval=3, MaxFrames=400,则代表在检测GIF/长图时,将每间隔2帧检测一次且最多检测400帧。",
270
+ "document": "**GIF检测专用**,用于标识最大截帧数量;默认值为1,此时只会检测输入GIF的第一帧不进行切分处理(可能会造成处理超时)。<br>备注:Interval与MaxFrames参数需要组合使用。例如,Interval=3, MaxFrames=400,则代表在检测GIF时,将每间隔2帧检测一次且最多检测400帧。",
271
271
  "example": "1",
272
272
  "member": "int64",
273
273
  "name": "MaxFrames",
@@ -894,8 +894,8 @@
894
894
  "members": [
895
895
  {
896
896
  "disabled": false,
897
- "document": "密钥对 ID 列表。每次请求批量密钥对的上限为 100",
898
- "example": "[\"lhkp-f7rjie1q\\n\"]",
897
+ "document": "密钥对 ID 列表,每次请求批量密钥对的上限为 100。可通过[DescribeKeyPairs](https://cloud.tencent.com/document/api/1207/55540)接口返回值中的KeyId获取。",
898
+ "example": "[\"lhkp-f7rjie1q\"]",
899
899
  "member": "string",
900
900
  "name": "KeyIds",
901
901
  "required": true,
@@ -904,7 +904,7 @@
904
904
  {
905
905
  "disabled": false,
906
906
  "document": "实例 ID 列表。每次请求批量实例的上限为 100。可通过[DescribeInstances](https://cloud.tencent.com/document/api/1207/47573)接口返回值中的InstanceId获取。",
907
- "example": "[\"lhins-ruy9d2tw\\n\"]",
907
+ "example": "[\"lhins-ruy9d2tw\"]",
908
908
  "member": "string",
909
909
  "name": "InstanceIds",
910
910
  "required": true,
@@ -930,7 +930,7 @@
930
930
  "members": [
931
931
  {
932
932
  "disabled": false,
933
- "document": "云联网实例ID",
933
+ "document": "云联网实例ID。可通过[DescribeCcnAttachedInstances](https://cloud.tencent.com/document/product/1207/58797)接口返回值中的CcnId获取。",
934
934
  "example": "ccn-f49l6u0z",
935
935
  "member": "string",
936
936
  "name": "CcnId",
@@ -2507,8 +2507,8 @@
2507
2507
  "members": [
2508
2508
  {
2509
2509
  "disabled": false,
2510
- "document": "密钥对 ID 列表,每次请求批量密钥对的上限为 10",
2511
- "example": "[\"lhkp-1234abcd\\r\\n\"]",
2510
+ "document": "密钥对 ID 列表,每次请求批量密钥对的上限为 10。可通过[DescribeKeyPairs](https://cloud.tencent.com/document/api/1207/55540)接口返回值中的KeyId获取。",
2511
+ "example": "[\"lhkp-1234abcd\"]",
2512
2512
  "member": "string",
2513
2513
  "name": "KeyIds",
2514
2514
  "required": true,
@@ -4194,7 +4194,7 @@
4194
4194
  "members": [
4195
4195
  {
4196
4196
  "disabled": false,
4197
- "document": "实例 ID 列表。每次请求批量实例的上限为 100",
4197
+ "document": "实例 ID 列表。每次请求批量实例的上限为 100。可通过[DescribeInstances](https://cloud.tencent.com/document/api/1207/47573)接口返回值中的InstanceId获取。",
4198
4198
  "example": "[\"lhins-4r4pvtbg\"]",
4199
4199
  "member": "string",
4200
4200
  "name": "InstanceIds",
@@ -4398,8 +4398,8 @@
4398
4398
  "members": [
4399
4399
  {
4400
4400
  "disabled": false,
4401
- "document": "密钥对 ID 列表。",
4402
- "example": "[\"lhkp-omd12oc1\\r\\n\"]",
4401
+ "document": "密钥对 ID 列表,每次请求批量密钥对的上限为 100。",
4402
+ "example": "[\"lhkp-omd12oc1\"]",
4403
4403
  "member": "string",
4404
4404
  "name": "KeyIds",
4405
4405
  "required": false,
@@ -4444,7 +4444,7 @@
4444
4444
  "example": "1",
4445
4445
  "member": "int64",
4446
4446
  "name": "TotalCount",
4447
- "required": true,
4447
+ "output_required": true,
4448
4448
  "type": "int",
4449
4449
  "value_allowed_null": false
4450
4450
  },
@@ -4454,7 +4454,7 @@
4454
4454
  "example": "无",
4455
4455
  "member": "KeyPair",
4456
4456
  "name": "KeyPairSet",
4457
- "required": true,
4457
+ "output_required": true,
4458
4458
  "type": "list",
4459
4459
  "value_allowed_null": false
4460
4460
  },
@@ -4999,8 +4999,8 @@
4999
4999
  "members": [
5000
5000
  {
5001
5001
  "disabled": false,
5002
- "document": "密钥对 ID 列表。每次请求批量密钥对的上限为 100",
5003
- "example": "[\"lhkp-f7rjie1q\\n\"]",
5002
+ "document": "密钥对 ID 列表,每次请求批量密钥对的上限为 100。可通过[DescribeKeyPairs](https://cloud.tencent.com/document/api/1207/55540)接口返回值中的KeyId获取。",
5003
+ "example": "[\"lhkp-f7rjie1q\"]",
5004
5004
  "member": "string",
5005
5005
  "name": "KeyIds",
5006
5006
  "required": true,
@@ -5009,7 +5009,7 @@
5009
5009
  {
5010
5010
  "disabled": false,
5011
5011
  "document": "实例 ID 列表。每次请求批量实例的上限为 100。可通过[DescribeInstances](https://cloud.tencent.com/document/api/1207/47573)接口返回值中的InstanceId获取。",
5012
- "example": "[\"lhins-ruy9d2tw\\n\"]",
5012
+ "example": "[\"lhins-ruy9d2tw\"]",
5013
5013
  "member": "string",
5014
5014
  "name": "InstanceIds",
5015
5015
  "required": true,
@@ -7982,7 +7982,7 @@
7982
7982
  {
7983
7983
  "disabled": false,
7984
7984
  "document": "实例 ID 列表。每次请求批量实例的上限为 100。可通过[DescribeInstances](https://cloud.tencent.com/document/api/1207/47573)接口返回值中的InstanceId获取。",
7985
- "example": "[\"lhins-ruy9d2tw\\n\",\"lhins-rusdke45\\n\"]",
7985
+ "example": "[\"lhins-ruy9d2tw\",\"lhins-rusdke45\"]",
7986
7986
  "member": "string",
7987
7987
  "name": "InstanceIds",
7988
7988
  "required": true,
@@ -8099,7 +8099,7 @@
8099
8099
  {
8100
8100
  "disabled": false,
8101
8101
  "document": "实例 ID 列表。每次请求批量实例的上限为 100。可通过[DescribeInstances](https://cloud.tencent.com/document/api/1207/47573)接口返回值中的InstanceId获取。",
8102
- "example": "[\"lhins-ruy9d2tw\\n\"]",
8102
+ "example": "[\"lhins-ruy9d2tw\"]",
8103
8103
  "member": "string",
8104
8104
  "name": "InstanceIds",
8105
8105
  "required": true,
@@ -8557,7 +8557,7 @@
8557
8557
  "members": [
8558
8558
  {
8559
8559
  "disabled": false,
8560
- "document": "防火墙模板ID",
8560
+ "document": "防火墙模板ID。可通过 [DescribeFirewallTemplates](https://cloud.tencent.com/document/product/1207/96874) 的返回值 TemplateSet 获取。",
8561
8561
  "example": "lhft-xxxxxxxx",
8562
8562
  "member": "string",
8563
8563
  "name": "TemplateId",
@@ -8566,7 +8566,7 @@
8566
8566
  },
8567
8567
  {
8568
8568
  "disabled": false,
8569
- "document": "防火墙模板规则ID",
8569
+ "document": "防火墙模板规则ID。可通过 [DescribeFirewallTemplateRules](https://cloud.tencent.com/document/product/1207/96875) 的返回值 TemplateRuleSet 获取。",
8570
8570
  "example": "lhftr-xxxxxxxxxx",
8571
8571
  "member": "string",
8572
8572
  "name": "TemplateRuleId",
@@ -9382,7 +9382,7 @@
9382
9382
  {
9383
9383
  "disabled": false,
9384
9384
  "document": "实例 ID 列表。每次请求批量实例的上限为 100。可通过[DescribeInstances](https://cloud.tencent.com/document/api/1207/47573)接口返回值中的InstanceId获取。",
9385
- "example": "[\"lhins-ruy9d2tw\\n\",\"lhins-rusdke45\\n\"]",
9385
+ "example": "[\"lhins-ruy9d2tw\",\"lhins-rusdke45\"]",
9386
9386
  "member": "string",
9387
9387
  "name": "InstanceIds",
9388
9388
  "required": true,
@@ -9455,7 +9455,7 @@
9455
9455
  {
9456
9456
  "disabled": false,
9457
9457
  "document": "实例 ID 列表。每次请求批量实例的上限为 100。可通过[DescribeInstances](https://cloud.tencent.com/document/api/1207/47573)接口返回值中的InstanceId获取。",
9458
- "example": "[\"lhins-ruy9d2tw\\n\",\"lhins-rusdke45\\n\"]",
9458
+ "example": "[\"lhins-ruy9d2tw\",\"lhins-rusdke45\"]",
9459
9459
  "member": "string",
9460
9460
  "name": "InstanceIds",
9461
9461
  "required": true,