tccli 3.0.1139.1__py2.py3-none-any.whl → 3.0.1141.1__py2.py3-none-any.whl

Sign up to get free protection for your applications and to get access to all the features.
Files changed (38) hide show
  1. tccli/__init__.py +1 -1
  2. tccli/services/cynosdb/v20190107/api.json +113 -33
  3. tccli/services/cynosdb/v20190107/examples.json +3 -3
  4. tccli/services/domain/v20180808/api.json +30 -30
  5. tccli/services/emr/v20190103/api.json +11 -2
  6. tccli/services/ess/v20201111/api.json +23 -14
  7. tccli/services/ess/v20201111/examples.json +4 -4
  8. tccli/services/essbasic/v20210526/api.json +13 -13
  9. tccli/services/essbasic/v20210526/examples.json +2 -2
  10. tccli/services/iotexplorer/v20190423/api.json +49 -0
  11. tccli/services/iss/iss_client.py +114 -8
  12. tccli/services/iss/v20230517/api.json +221 -0
  13. tccli/services/iss/v20230517/examples.json +16 -0
  14. tccli/services/mmps/v20200710/api.json +3 -3
  15. tccli/services/monitor/v20180724/api.json +1 -1
  16. tccli/services/scf/v20180416/api.json +10 -10
  17. tccli/services/ses/ses_client.py +228 -16
  18. tccli/services/ses/v20201002/api.json +266 -0
  19. tccli/services/ses/v20201002/examples.json +32 -0
  20. tccli/services/ssl/v20191205/api.json +76 -25
  21. tccli/services/ssl/v20191205/examples.json +3 -3
  22. tccli/services/tcr/v20190924/api.json +5 -1
  23. tccli/services/tcr/v20190924/examples.json +1 -1
  24. tccli/services/tdmq/v20200217/api.json +2 -2
  25. tccli/services/vpc/v20170312/api.json +2086 -217
  26. tccli/services/vpc/v20170312/examples.json +151 -1
  27. tccli/services/vpc/vpc_client.py +1180 -226
  28. tccli/services/waf/v20180125/api.json +0 -43
  29. tccli/services/waf/v20180125/examples.json +0 -8
  30. tccli/services/waf/waf_client.py +0 -53
  31. tccli/services/wedata/v20210820/api.json +360 -0
  32. tccli/services/wedata/v20210820/examples.json +28 -0
  33. tccli/services/wedata/wedata_client.py +114 -8
  34. {tccli-3.0.1139.1.dist-info → tccli-3.0.1141.1.dist-info}/METADATA +2 -2
  35. {tccli-3.0.1139.1.dist-info → tccli-3.0.1141.1.dist-info}/RECORD +38 -38
  36. {tccli-3.0.1139.1.dist-info → tccli-3.0.1141.1.dist-info}/WHEEL +0 -0
  37. {tccli-3.0.1139.1.dist-info → tccli-3.0.1141.1.dist-info}/entry_points.txt +0 -0
  38. {tccli-3.0.1139.1.dist-info → tccli-3.0.1141.1.dist-info}/license_files/LICENSE +0 -0
@@ -421,8 +421,8 @@
421
421
  "DescribeClusterPasswordComplexity": [
422
422
  {
423
423
  "document": "",
424
- "input": "POST / HTTP/1.1\nHost: cynosdb.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: DescribeClusterPasswordComplexity\n<公共请求参数>\n\n{\n \"ClusterId\": \"cynosdbmysql-bzxxrmtq\"\n}",
425
- "output": "{\n \"Response\": {\n \"RequestId\": \"7613eed6-5eb5-4d17-ae69-dd93c44d7ad4\",\n \"ValidatePasswordDictionary\": {\n \"CurrentValue\": \"\",\n \"Default\": \"\",\n \"Description\": \"The dictionary words that validate_password uses for checking passwords.\",\n \"EnumValue\": [],\n \"IsGlobal\": 0,\n \"MatchType\": \"\",\n \"MatchValue\": \"\",\n \"Max\": \"0\",\n \"Min\": \"0\",\n \"ModifiableInfo\": {\n \"IsModifiable\": 0\n },\n \"NeedReboot\": 0,\n \"ParamName\": \"validate_password_txsql_dictionary\",\n \"ParamType\": \"string\"\n },\n \"ValidatePasswordLength\": {\n \"CurrentValue\": \"0\",\n \"Default\": \"8\",\n \"Description\": \"The minimum number of characters that validate_password requires passwords to have.\",\n \"EnumValue\": [],\n \"IsGlobal\": 0,\n \"MatchType\": \"\",\n \"MatchValue\": \"\",\n \"Max\": \"256\",\n \"Min\": \"8\",\n \"ModifiableInfo\": {\n \"IsModifiable\": 0\n },\n \"NeedReboot\": 0,\n \"ParamName\": \"validate_password_length\",\n \"ParamType\": \"integer\"\n },\n \"ValidatePasswordMixedCaseCount\": {\n \"CurrentValue\": \"0\",\n \"Default\": \"1\",\n \"Description\": \"The minimum number of lowercase and uppercase characters that validate_password requires passwords to have if the password policy is MEDIUM or stronger.\",\n \"EnumValue\": [],\n \"IsGlobal\": 0,\n \"MatchType\": \"\",\n \"MatchValue\": \"\",\n \"Max\": \"50\",\n \"Min\": \"1\",\n \"ModifiableInfo\": {\n \"IsModifiable\": 0\n },\n \"NeedReboot\": 0,\n \"ParamName\": \"validate_password_mixed_case_count\",\n \"ParamType\": \"integer\"\n },\n \"ValidatePasswordNumberCount\": {\n \"CurrentValue\": \"0\",\n \"Default\": \"1\",\n \"Description\": \"The minimum number of numeric (digit) characters that validate_password requires passwords to have if the password policy is MEDIUM or stronger. \",\n \"EnumValue\": [],\n \"IsGlobal\": 0,\n \"MatchType\": \"\",\n \"MatchValue\": \"\",\n \"Max\": \"50\",\n \"Min\": \"1\",\n \"ModifiableInfo\": {\n \"IsModifiable\": 0\n },\n \"NeedReboot\": 0,\n \"ParamName\": \"validate_password_number_count\",\n \"ParamType\": \"integer\"\n },\n \"ValidatePasswordPolicy\": {\n \"CurrentValue\": \"LOW\",\n \"Default\": \"MEDIUM\",\n \"Description\": \"The password policy enforced by validate_password.\",\n \"EnumValue\": [\n \"MEDIUM\",\n \"STRONG\"\n ],\n \"IsGlobal\": 0,\n \"MatchType\": \"\",\n \"MatchValue\": \"\",\n \"Max\": \"2\",\n \"Min\": \"0\",\n \"ModifiableInfo\": {\n \"IsModifiable\": 0\n },\n \"NeedReboot\": 0,\n \"ParamName\": \"validate_password_policy\",\n \"ParamType\": \"enum\"\n },\n \"ValidatePasswordSpecialCharCount\": {\n \"CurrentValue\": \"0\",\n \"Default\": \"1\",\n \"Description\": \"The minimum number of nonalphanumeric characters that validate_password requires passwords to have if the password policy is MEDIUM or stronger. \",\n \"EnumValue\": [],\n \"IsGlobal\": 0,\n \"MatchType\": \"\",\n \"MatchValue\": \"\",\n \"Max\": \"50\",\n \"Min\": \"1\",\n \"ModifiableInfo\": {\n \"IsModifiable\": 0\n },\n \"NeedReboot\": 0,\n \"ParamName\": \"validate_password_special_char_count\",\n \"ParamType\": \"integer\"\n }\n }\n}",
424
+ "input": "POST / HTTP/1.1\nHost: cynosdb.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: DescribeClusterPasswordComplexity\n<公共请求参数>\n\n{\n \"ClusterId\": \"abc\"\n}",
425
+ "output": "{\n \"Response\": {\n \"RequestId\": \"7651f1c0-3429-11ef-81fc-6fec1c9e2c66\",\n \"ValidatePasswordDictionary\": {\n \"CurrentValue\": \"\",\n \"Default\": \"\",\n \"Description\": \"The dictionary words that validate_password uses for checking passwords.\",\n \"EnumValue\": [],\n \"Func\": \"\",\n \"FuncPattern\": \"\",\n \"IsFunc\": false,\n \"IsGlobal\": 0,\n \"MatchType\": \"\",\n \"MatchValue\": \"\",\n \"Max\": \"0\",\n \"Min\": \"0\",\n \"ModifiableInfo\": {\n \"IsModifiable\": 0\n },\n \"NeedReboot\": 0,\n \"ParamName\": \"validate_password_txsql_dictionary\",\n \"ParamType\": \"string\"\n },\n \"ValidatePasswordLength\": {\n \"CurrentValue\": \"0\",\n \"Default\": \"8\",\n \"Description\": \"The minimum number of characters that validate_password requires passwords to have.\",\n \"EnumValue\": [],\n \"Func\": \"\",\n \"FuncPattern\": \"\",\n \"IsFunc\": false,\n \"IsGlobal\": 0,\n \"MatchType\": \"\",\n \"MatchValue\": \"\",\n \"Max\": \"256\",\n \"Min\": \"8\",\n \"ModifiableInfo\": {\n \"IsModifiable\": 0\n },\n \"NeedReboot\": 0,\n \"ParamName\": \"validate_password_length\",\n \"ParamType\": \"integer\"\n },\n \"ValidatePasswordMixedCaseCount\": {\n \"CurrentValue\": \"0\",\n \"Default\": \"1\",\n \"Description\": \"The minimum number of lowercase and uppercase characters that validate_password requires passwords to have if the password policy is MEDIUM or stronger.\",\n \"EnumValue\": [],\n \"Func\": \"\",\n \"FuncPattern\": \"\",\n \"IsFunc\": false,\n \"IsGlobal\": 0,\n \"MatchType\": \"\",\n \"MatchValue\": \"\",\n \"Max\": \"50\",\n \"Min\": \"1\",\n \"ModifiableInfo\": {\n \"IsModifiable\": 0\n },\n \"NeedReboot\": 0,\n \"ParamName\": \"validate_password_mixed_case_count\",\n \"ParamType\": \"integer\"\n },\n \"ValidatePasswordNumberCount\": {\n \"CurrentValue\": \"0\",\n \"Default\": \"1\",\n \"Description\": \"The minimum number of numeric (digit) characters that validate_password requires passwords to have if the password policy is MEDIUM or stronger. \",\n \"EnumValue\": [],\n \"Func\": \"\",\n \"FuncPattern\": \"\",\n \"IsFunc\": false,\n \"IsGlobal\": 0,\n \"MatchType\": \"\",\n \"MatchValue\": \"\",\n \"Max\": \"50\",\n \"Min\": \"1\",\n \"ModifiableInfo\": {\n \"IsModifiable\": 0\n },\n \"NeedReboot\": 0,\n \"ParamName\": \"validate_password_number_count\",\n \"ParamType\": \"integer\"\n },\n \"ValidatePasswordPolicy\": {\n \"CurrentValue\": \"LOW\",\n \"Default\": \"MEDIUM\",\n \"Description\": \"The password policy enforced by validate_password.\",\n \"EnumValue\": [\n \"MEDIUM\",\n \"STRONG\"\n ],\n \"Func\": \"\",\n \"FuncPattern\": \"\",\n \"IsFunc\": false,\n \"IsGlobal\": 0,\n \"MatchType\": \"\",\n \"MatchValue\": \"\",\n \"Max\": \"2\",\n \"Min\": \"0\",\n \"ModifiableInfo\": {\n \"IsModifiable\": 0\n },\n \"NeedReboot\": 0,\n \"ParamName\": \"validate_password_policy\",\n \"ParamType\": \"enum\"\n },\n \"ValidatePasswordSpecialCharCount\": {\n \"CurrentValue\": \"0\",\n \"Default\": \"1\",\n \"Description\": \"The minimum number of nonalphanumeric characters that validate_password requires passwords to have if the password policy is MEDIUM or stronger. \",\n \"EnumValue\": [],\n \"Func\": \"\",\n \"FuncPattern\": \"\",\n \"IsFunc\": false,\n \"IsGlobal\": 0,\n \"MatchType\": \"\",\n \"MatchValue\": \"\",\n \"Max\": \"50\",\n \"Min\": \"1\",\n \"ModifiableInfo\": {\n \"IsModifiable\": 0\n },\n \"NeedReboot\": 0,\n \"ParamName\": \"validate_password_special_char_count\",\n \"ParamType\": \"integer\"\n }\n }\n}",
426
426
  "title": "查看集群密码复杂度详情"
427
427
  }
428
428
  ],
@@ -430,7 +430,7 @@
430
430
  {
431
431
  "document": "查询集群列表",
432
432
  "input": "POST / HTTP/1.1\nHost: cynosdb.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: DescribeClusters\n<公共请求参数>\n\n{\n \"DbType\": \"MYSQL\",\n \"Limit\": \"20\",\n \"Filters\": [\n {\n \"Values\": [\n \"cynosdbpg-ins-bzkxxrmt\"\n ],\n \"Names\": [\n \"InstanceId\"\n ],\n \"ExactMatch\": \"true\"\n }\n ],\n \"Offset\": \"0\"\n}",
433
- "output": "{\n \"Response\": {\n \"TotalCount\": 0,\n \"ClusterSet\": [\n {\n \"Status\": \"abc\",\n \"UpdateTime\": \"abc\",\n \"Zone\": \"abc\",\n \"ClusterName\": \"abc\",\n \"Region\": \"abc\",\n \"DbVersion\": \"abc\",\n \"ClusterId\": \"abc\",\n \"InstanceNum\": 0,\n \"Uin\": \"abc\",\n \"DbType\": \"abc\",\n \"AppId\": 0,\n \"StatusDesc\": \"abc\",\n \"CreateTime\": \"abc\",\n \"PayMode\": 0,\n \"PeriodEndTime\": \"abc\",\n \"Vip\": \"abc\",\n \"Vport\": 0,\n \"ProjectID\": 0,\n \"VpcId\": \"abc\",\n \"SubnetId\": \"abc\",\n \"CynosVersion\": \"abc\",\n \"StorageLimit\": 0,\n \"RenewFlag\": 0,\n \"ProcessingTask\": \"abc\",\n \"Tasks\": [\n {\n \"TaskId\": 0,\n \"TaskType\": \"abc\",\n \"TaskStatus\": \"abc\",\n \"ObjectId\": \"abc\",\n \"ObjectType\": \"abc\"\n }\n ],\n \"ResourceTags\": [\n {\n \"TagKey\": \"abc\",\n \"TagValue\": \"abc\"\n }\n ],\n \"DbMode\": \"abc\",\n \"ServerlessStatus\": \"abc\",\n \"Storage\": 0,\n \"StorageId\": \"abc\",\n \"StoragePayMode\": 0,\n \"MinStorageSize\": 0,\n \"MaxStorageSize\": 0,\n \"NetAddrs\": [\n {\n \"Vip\": \"abc\",\n \"Vport\": 0,\n \"WanDomain\": \"abc\",\n \"WanPort\": 0,\n \"NetType\": \"abc\",\n \"UniqSubnetId\": \"abc\",\n \"UniqVpcId\": \"abc\",\n \"Description\": \"abc\",\n \"WanIP\": \"abc\",\n \"WanStatus\": \"abc\",\n \"InstanceGroupId\": \"abc\"\n }\n ],\n \"PhysicalZone\": \"abc\",\n \"MasterZone\": \"abc\",\n \"HasSlaveZone\": \"abc\",\n \"SlaveZones\": [\n \"abc\"\n ],\n \"BusinessType\": \"abc\",\n \"IsFreeze\": \"abc\",\n \"OrderSource\": \"abc\",\n \"Ability\": {\n \"IsSupportSlaveZone\": \"abc\",\n \"NonsupportSlaveZoneReason\": \"abc\",\n \"IsSupportRo\": \"abc\",\n \"NonsupportRoReason\": \"abc\"\n },\n \"ResourcePackages\": [\n {\n \"PackageId\": \"abc\",\n \"PackageType\": \"abc\"\n }\n ]\n }\n ],\n \"RequestId\": \"abc\"\n }\n}",
433
+ "output": "{\n \"Response\": {\n \"ClusterSet\": [\n {\n \"Ability\": {\n \"IsSupportManualSnapshot\": \"\",\n \"IsSupportRo\": \"yes\",\n \"IsSupportSlaveZone\": \"yes\",\n \"IsSupportTransparentDataEncryption\": \"\",\n \"NoSupportTransparentDataEncryptionReason\": \"\",\n \"NonsupportRoReason\": \"\",\n \"NonsupportSlaveZoneReason\": \"\"\n },\n \"AppId\": 123,\n \"BusinessType\": \"\",\n \"ClusterId\": \"cynosdbmysql-aaa\",\n \"ClusterName\": \"resource-xxl-job-intl\",\n \"CreateTime\": \"2024-05-30 19:26:42\",\n \"CynosVersion\": \"2.1.12\",\n \"DbMode\": \"NORMAL\",\n \"DbType\": \"MYSQL\",\n \"DbVersion\": \"5.7\",\n \"HasSlaveZone\": \"yes\",\n \"InstanceNum\": 2,\n \"IsFreeze\": \"no\",\n \"MasterZone\": \"ap-singapore-3\",\n \"MaxStorageSize\": 30000,\n \"MinStorageSize\": 10,\n \"NetAddrs\": [\n {\n \"Description\": \"\",\n \"InstanceGroupId\": \"\",\n \"NetType\": \"singleRo\",\n \"UniqSubnetId\": \"subnet-xx\",\n \"UniqVpcId\": \"vpc-xx\",\n \"Vip\": \"1.1.1.1\",\n \"Vport\": 3306,\n \"WanDomain\": \"\",\n \"WanIP\": \"\",\n \"WanPort\": 0,\n \"WanStatus\": \"init\"\n },\n {\n \"Description\": \"\",\n \"InstanceGroupId\": \"\",\n \"NetType\": \"ha\",\n \"UniqSubnetId\": \"subnet-xx\",\n \"UniqVpcId\": \"vpc-xx\",\n \"Vip\": \"1.1.1.1\",\n \"Vport\": 3306,\n \"WanDomain\": \"\",\n \"WanIP\": \"\",\n \"WanPort\": 0,\n \"WanStatus\": \"init\"\n },\n {\n \"Description\": \"\",\n \"InstanceGroupId\": \"\",\n \"NetType\": \"proxy\",\n \"UniqSubnetId\": \"subnet-xx\",\n \"UniqVpcId\": \"vpc-xx\",\n \"Vip\": \"1.1.1.1\",\n \"Vport\": 3306,\n \"WanDomain\": \"\",\n \"WanIP\": \"\",\n \"WanPort\": 0,\n \"WanStatus\": \"\"\n }\n ],\n \"OrderSource\": \"\",\n \"PayMode\": 1,\n \"PeriodEndTime\": \"2024-06-30 19:32:51\",\n \"PhysicalZone\": \"ap-singapore-3\",\n \"ProcessingTask\": \"\",\n \"ProjectID\": 0,\n \"Region\": \"ap-singapore\",\n \"RenewFlag\": 1,\n \"ResourcePackages\": [],\n \"ResourceTags\": [\n {\n \"TagKey\": \"运营产品\",\n \"TagValue\": \"腾讯云计费产品其它_1649\"\n },\n {\n \"TagKey\": \"运营部门\",\n \"TagValue\": \"计费产品中心_1013\"\n },\n {\n \"TagKey\": \"一级业务\",\n \"TagValue\": \"[N][腾讯云计费产品其它]_979685\"\n },\n {\n \"TagKey\": \"二级业务\",\n \"TagValue\": \"[license管理][license数据引擎]123\"\n }\n ],\n \"ServerlessStatus\": \"\",\n \"SlaveZones\": [\n \"ap-singapore-4\"\n ],\n \"Status\": \"running\",\n \"StatusDesc\": \"运行中\",\n \"Storage\": 0,\n \"StorageId\": \"\",\n \"StorageLimit\": 30000,\n \"StoragePayMode\": 0,\n \"SubnetId\": \"subnet-xx\",\n \"Tasks\": [],\n \"Uin\": \"1234\",\n \"UpdateTime\": \"2024-05-30 19:43:06\",\n \"Vip\": \"1.1.1.1\",\n \"VpcId\": \"vpc-xx\",\n \"Vport\": 3306,\n \"Zone\": \"ap-singapore-3\"\n }\n ],\n \"RequestId\": \"51169b54-61d4-4604-a07e-e519a5527923\",\n \"TotalCount\": 31\n }\n}",
434
434
  "title": "查询集群列表"
435
435
  }
436
436
  ],
@@ -4166,80 +4166,80 @@
4166
4166
  {
4167
4167
  "disabled": false,
4168
4168
  "document": "详情ID",
4169
- "example": "",
4169
+ "example": "1",
4170
4170
  "member": "int64",
4171
4171
  "name": "Id",
4172
- "required": true,
4172
+ "output_required": true,
4173
4173
  "type": "int",
4174
4174
  "value_allowed_null": false
4175
4175
  },
4176
4176
  {
4177
4177
  "disabled": false,
4178
4178
  "document": "类型 new: 注册域名 batch_transfer_prohibition_on:开启禁止转移 batch_transfer_prohibition_off:关闭禁止转移 batch_update_prohibition_on:开启禁止更新 batch_update_prohibition_off:关闭禁止更新",
4179
- "example": "",
4179
+ "example": "batch_modify_domain_info",
4180
4180
  "member": "string",
4181
4181
  "name": "Action",
4182
- "required": true,
4182
+ "output_required": true,
4183
4183
  "type": "string",
4184
4184
  "value_allowed_null": false
4185
4185
  },
4186
4186
  {
4187
4187
  "disabled": false,
4188
4188
  "document": "域名",
4189
- "example": "",
4189
+ "example": "tencent.com",
4190
4190
  "member": "string",
4191
4191
  "name": "Domain",
4192
- "required": true,
4192
+ "output_required": true,
4193
4193
  "type": "string",
4194
4194
  "value_allowed_null": false
4195
4195
  },
4196
4196
  {
4197
4197
  "disabled": false,
4198
4198
  "document": "执行状态:\ndoing 执行中。\nfailed 操作失败。\nsuccess 操作成功。",
4199
- "example": "",
4199
+ "example": "success",
4200
4200
  "member": "string",
4201
4201
  "name": "Status",
4202
- "required": true,
4202
+ "output_required": true,
4203
4203
  "type": "string",
4204
4204
  "value_allowed_null": false
4205
4205
  },
4206
4206
  {
4207
4207
  "disabled": false,
4208
4208
  "document": "失败原因\n注意:此字段可能返回 null,表示取不到有效值。",
4209
- "example": "",
4209
+ "example": "\"\"",
4210
4210
  "member": "string",
4211
4211
  "name": "Reason",
4212
- "required": true,
4212
+ "output_required": true,
4213
4213
  "type": "string",
4214
4214
  "value_allowed_null": true
4215
4215
  },
4216
4216
  {
4217
4217
  "disabled": false,
4218
4218
  "document": "创建时间",
4219
- "example": "",
4219
+ "example": "2006-01-02 15:04:05",
4220
4220
  "member": "string",
4221
4221
  "name": "CreatedOn",
4222
- "required": true,
4222
+ "output_required": true,
4223
4223
  "type": "string",
4224
4224
  "value_allowed_null": false
4225
4225
  },
4226
4226
  {
4227
4227
  "disabled": false,
4228
4228
  "document": "更新时间",
4229
- "example": "",
4229
+ "example": "2006-01-02 15:04:05",
4230
4230
  "member": "string",
4231
4231
  "name": "UpdatedOn",
4232
- "required": true,
4232
+ "output_required": true,
4233
4233
  "type": "string",
4234
4234
  "value_allowed_null": false
4235
4235
  },
4236
4236
  {
4237
4237
  "disabled": false,
4238
4238
  "document": "订单号\n注意:此字段可能返回 null,表示取不到有效值。",
4239
- "example": "",
4239
+ "example": "1",
4240
4240
  "member": "string",
4241
4241
  "name": "BigDealId",
4242
- "required": false,
4242
+ "output_required": true,
4243
4243
  "type": "string",
4244
4244
  "value_allowed_null": true
4245
4245
  }
@@ -4252,70 +4252,70 @@
4252
4252
  {
4253
4253
  "disabled": false,
4254
4254
  "document": "日志ID",
4255
- "example": "",
4255
+ "example": "1",
4256
4256
  "member": "int64",
4257
4257
  "name": "LogId",
4258
- "required": true,
4258
+ "output_required": true,
4259
4259
  "type": "int",
4260
4260
  "value_allowed_null": false
4261
4261
  },
4262
4262
  {
4263
4263
  "disabled": false,
4264
4264
  "document": "数量",
4265
- "example": "",
4265
+ "example": "1",
4266
4266
  "member": "int64",
4267
4267
  "name": "Number",
4268
- "required": true,
4268
+ "output_required": true,
4269
4269
  "type": "int",
4270
4270
  "value_allowed_null": false
4271
4271
  },
4272
4272
  {
4273
4273
  "disabled": false,
4274
4274
  "document": "执行状态:\ndoing 执行中。\ndone 执行完成。",
4275
- "example": "",
4275
+ "example": "done",
4276
4276
  "member": "string",
4277
4277
  "name": "Status",
4278
- "required": true,
4278
+ "output_required": true,
4279
4279
  "type": "string",
4280
4280
  "value_allowed_null": false
4281
4281
  },
4282
4282
  {
4283
4283
  "disabled": false,
4284
4284
  "document": "提交时间",
4285
- "example": "",
4285
+ "example": "2006-01-02 15:04:05",
4286
4286
  "member": "string",
4287
4287
  "name": "CreatedOn",
4288
- "required": true,
4288
+ "output_required": true,
4289
4289
  "type": "string",
4290
4290
  "value_allowed_null": false
4291
4291
  },
4292
4292
  {
4293
4293
  "disabled": false,
4294
4294
  "document": "批量操作成功个数",
4295
- "example": "",
4295
+ "example": "1",
4296
4296
  "member": "int64",
4297
4297
  "name": "Success",
4298
- "required": false,
4298
+ "output_required": true,
4299
4299
  "type": "int",
4300
4300
  "value_allowed_null": false
4301
4301
  },
4302
4302
  {
4303
4303
  "disabled": false,
4304
4304
  "document": "批量操作处理中个数",
4305
- "example": "",
4305
+ "example": "0",
4306
4306
  "member": "int64",
4307
4307
  "name": "Doing",
4308
- "required": false,
4308
+ "output_required": true,
4309
4309
  "type": "int",
4310
4310
  "value_allowed_null": false
4311
4311
  },
4312
4312
  {
4313
4313
  "disabled": false,
4314
4314
  "document": "批量操作失败个数",
4315
- "example": "",
4315
+ "example": "0",
4316
4316
  "member": "int64",
4317
4317
  "name": "Failed",
4318
- "required": false,
4318
+ "output_required": true,
4319
4319
  "type": "int",
4320
4320
  "value_allowed_null": false
4321
4321
  }
@@ -6090,7 +6090,7 @@
6090
6090
  },
6091
6091
  {
6092
6092
  "disabled": false,
6093
- "document": "部署的组件列表。不同的EMR产品ID(ProductId:具体含义参考入参ProductId字段)需要选择不同的必选组件:\n<li>ProductId为1的时候,必选组件包括:hadoop-2.7.3knox-1.2.0zookeeper-3.4.9</li>\n<li>ProductId为2的时候,必选组件包括:hadoop-2.7.3knox-1.2.0zookeeper-3.4.9</li>\n<li>ProductId为4的时候,必选组件包括:hadoop-2.8.4knox-1.2.0zookeeper-3.4.9</li>\n<li>ProductId为7的时候,必选组件包括:hadoop-3.1.2knox-1.2.0zookeeper-3.4.9</li>",
6093
+ "document": "部署的组件列表。不同的EMR产品ID(ProductId:具体含义参考入参ProductId字段)需要选择不同的必选组件:<li>ProductId为2(EMR-V2.0.1)的时候,必选组件包括:hdfs-2.7.3,yarn-2.7.3,zookeeper-3.4.9,knox-1.2.0</li><li>ProductId为16(EMR-V2.3.0)的时候,必选组件包括:hdfs-2.8.5,yarn-2.8.5,zookeeper-3.5.5,knox-1.2.0</li><li>ProductId为20(EMR-V2.5.0)的时候,必选组件包括:hdfs-2.8.5,yarn-2.8.5,zookeeper-3.6.1,knox-1.2.0</li><li>ProductId为30(EMR-V2.6.0)的时候,必选组件包括:hdfs-2.8.5,yarn-2.8.5,zookeeper-3.6.1,openldap-2.4.44,knox-1.2.0</li><li>ProductId为38(EMR-V2.7.0)的时候,必选组件包括:hdfs-2.8.5,yarn-2.8.5,zookeeper-3.6.3,openldap-2.4.44,knox-1.6.1</li><li>ProductId为57(EMR-V2.8.0)的时候,必选组件包括:hdfs-2.8.5,yarn-2.8.5,zookeeper-3.6.3,openldap-2.4.44,knox-1.6.1</li><li>ProductId为7(EMR-V3.0.0)的时候,必选组件包括:hdfs-3.1.2,yarn-3.1.2,zookeeper-3.4.9,knox-1.2.0</li><li>ProductId为25(EMR-V3.1.0)的时候,必选组件包括:hdfs-3.1.2,yarn-3.1.2,zookeeper-3.6.1,knox-1.2.0</li><li>ProductId为31(EMR-V3.1.1)的时候,必选组件包括:hdfs-3.1.2,yarn-3.1.2,zookeeper-3.6.1,knox-1.2.0</li><li>ProductId为28(EMR-V3.2.0)的时候,必选组件包括:hdfs-3.2.2,yarn-3.2.2,zookeeper-3.6.1,knox-1.2.0</li><li>ProductId为33(EMR-V3.2.1)的时候,必选组件包括:hdfs-3.2.2,yarn-3.2.2,zookeeper-3.6.1,openldap-2.4.44,knox-1.2.0</li><li>ProductId为34(EMR-V3.3.0)的时候,必选组件包括:hdfs-3.2.2,yarn-3.2.2,zookeeper-3.6.1,openldap-2.4.44,knox-1.2.0</li><li>ProductId为37(EMR-V3.4.0)的时候,必选组件包括:hdfs-3.2.2,yarn-3.2.2,zookeeper-3.6.3,openldap-2.4.44,knox-1.6.1</li><li>ProductId为44(EMR-V3.5.0)的时候,必选组件包括:hdfs-3.2.2,yarn-3.2.2,zookeeper-3.6.3,openldap-2.4.44,knox-1.6.1</li><li>ProductId为53(EMR-V3.6.0)的时候,必选组件包括:hdfs-3.2.2,yarn-3.2.2,zookeeper-3.6.3,openldap-2.4.44,knox-1.6.1</li><li>ProductId为58(EMR-V3.6.1)的时候,必选组件包括:hdfs-3.2.2,yarn-3.2.2,zookeeper-3.6.3,openldap-2.4.46,knox-1.6.1</li><li>ProductId为47(EMR-V4.0.0)的时候,必选组件包括:hdfs-3.2.2,yarn-3.2.2,zookeeper-3.6.3,openldap-2.4.44,knox-1.6.1</li>",
6094
6094
  "example": "无",
6095
6095
  "member": "string",
6096
6096
  "name": "Software",
@@ -6153,7 +6153,7 @@
6153
6153
  },
6154
6154
  {
6155
6155
  "disabled": false,
6156
- "document": "产品ID,不同产品ID表示不同的EMR产品版本。取值范围:\n<li>1:表示EMR-V1.3.1。</li>\n<li>2:表示EMR-V2.0.1。</li>\n<li>4:表示EMR-V2.1.0。</li>\n<li>7:表示EMR-V3.0.0。</li>",
6156
+ "document": "产品ID,不同产品ID表示不同的EMR产品版本。取值范围:<li>2:表示EMR-V2.0.1</li><li>16:表示EMR-V2.3.0</li><li>20:表示EMR-V2.5.0</li><li>30:表示EMR-V2.6.0</li><li>38:表示EMR-V2.7.0</li><li>57:表示EMR-V2.8.0</li><li>7:表示EMR-V3.0.0</li><li>25:表示EMR-V3.1.0</li><li>31:表示EMR-V3.1.1</li><li>28:表示EMR-V3.2.0</li><li>33:表示EMR-V3.2.1</li><li>34:表示EMR-V3.3.0</li><li>37:表示EMR-V3.4.0</li><li>44:表示EMR-V3.5.0</li><li>53:表示EMR-V3.6.0</li><li>58:表示EMR-V3.6.1</li><li>47:表示EMR-V4.0.0</li>",
6157
6157
  "example": "无",
6158
6158
  "member": "uint64",
6159
6159
  "name": "ProductId",
@@ -11541,6 +11541,15 @@
11541
11541
  "name": "StopParams",
11542
11542
  "required": false,
11543
11543
  "type": "object"
11544
+ },
11545
+ {
11546
+ "disabled": false,
11547
+ "document": "当OpType为<li>StopMonitor</li>才有用,true表示进入维护模式但是仍然监控进程但是不拉起进程",
11548
+ "example": "无",
11549
+ "member": "bool",
11550
+ "name": "KeepMonitorButNotRecoverProcess",
11551
+ "required": false,
11552
+ "type": "bool"
11544
11553
  }
11545
11554
  ],
11546
11555
  "type": "object"
@@ -197,9 +197,9 @@
197
197
  "status": "online"
198
198
  },
199
199
  "CreateLegalSealQrCode": {
200
- "document": "该接口用于获取创建法人章的二维码<br/>\n\n**注意**\n1. 该二维码**有效期为7天**,过期后将失效,可重新创建 ",
200
+ "document": "该接口用于获取创建法人章的二维码,需要通过微信扫描。扫描后将跳转到腾讯电子签署,进入到创建法人章的流程。\n\n**注意**\n1. 该二维码**有效期为7天**,过期后将失效,可重新创建 。\n2. 每个公司**只能有1个法人章**,无法重复创建或者创建多个\n\n法人章的样式可以参考下图索引(也可以自己上传法人印章图片):\n\n![image](https://qcloudimg.tencent-cloud.cn/raw/36a0a090750c45bb5cac5047ac461b2c.png)",
201
201
  "input": "CreateLegalSealQrCodeRequest",
202
- "name": "获取创建法人章二维码",
202
+ "name": "获取到电子签小程序创建法人章二维码",
203
203
  "output": "CreateLegalSealQrCodeResponse",
204
204
  "status": "online"
205
205
  },
@@ -470,7 +470,7 @@
470
470
  "status": "online"
471
471
  },
472
472
  "DescribeOrganizationSeals": {
473
- "document": "查询企业印章的列表,需要操作者具有查询印章权限\n客户指定需要获取的印章数量和偏移量,数量最多100,超过100按100处理;入参InfoType控制印章是否携带授权人信息,为1则携带,为0则返回的授权人信息为空数组。接口调用成功返回印章的信息列表还有企业印章的总数。",
473
+ "document": "查询企业印章列表。\n\n注:\n1. 此操作要求操作者具备<b>印章查询权限</b>(若调用者尚无此权限,请联系超级管理员前往Web控制台【组织管理】->【角色管理】添加相应权限)。",
474
474
  "input": "DescribeOrganizationSealsRequest",
475
475
  "name": "查询企业电子印章",
476
476
  "output": "DescribeOrganizationSealsResponse",
@@ -1715,7 +1715,7 @@
1715
1715
  "usage": "in"
1716
1716
  },
1717
1717
  "Component": {
1718
- "document": "此结构体 (Component) 用于描述控件属性。\n\n在通过文件发起合同时,对应的component有三种定位方式\n1. 绝对定位方式 (可以通过 [PDF坐标计算助手](https://qian.tencent.com/developers/tools/template-editor)计算控件的坐标)\n2. 表单域(FIELD)定位方式\n3. 关键字(KEYWORD)定位方式,使用关键字定位时,请确保PDF原始文件内是关键字以文字形式保存在PDF文件中,不支持对图片内文字进行关键字查找\n可以参考官网说明\nhttps://cloud.tencent.com/document/product/1323/78346#component-.E4.B8.89.E7.A7.8D.E5.AE.9A.E4.BD.8D.E6.96.B9.E5.BC.8F.E8.AF.B4.E6.98.8E",
1718
+ "document": "此结构体 (Component) 用于描述控件属性。\n\n在通过文件发起合同时,对应的component有三种定位方式\n1. 绝对定位方式 (可以通过 [PDF坐标计算助手](https://qian.tencent.com/developers/tools/template-editor)计算控件的坐标)\n2. 表单域(FIELD)定位方式\n3. 关键字(KEYWORD)定位方式,使用关键字定位时,请确保PDF原始文件内是关键字以文字形式保存在PDF文件中,不支持对图片内文字进行关键字查找",
1719
1719
  "members": [
1720
1720
  {
1721
1721
  "disabled": false,
@@ -4498,8 +4498,8 @@
4498
4498
  "members": [
4499
4499
  {
4500
4500
  "disabled": false,
4501
- "document": "二维码图片base64",
4502
- "example": "”xxxx“",
4501
+ "document": "二维码图片base64值,二维码有效期7天(604800秒)\n\n二维码图片的样式如下图:\n![image](https://qcloudimg.tencent-cloud.cn/raw/7ec2478761158a35a9c623882839a5df.png)",
4502
+ "example": "C61r2kWfiCz0jXdD1S60a4vI9Rt9O1nSr6a2S21Gzlm/V/8A4MY/+........(图片base64编码)",
4503
4503
  "member": "string",
4504
4504
  "name": "QrcodeBase64",
4505
4505
  "output_required": true,
@@ -6642,7 +6642,16 @@
6642
6642
  },
6643
6643
  {
6644
6644
  "disabled": false,
6645
- "document": "要跳转的链接类型\n\n- HTTP:\n跳转电子签小程序的http_url,短信通知或者H5跳转适合此类型 ,此时返回长链 (默认类型)\n\n- HTTP_SHORT_URL:\n跳转电子签小程序的http_url,短信通知或者H5跳转适合此类型,此时返回短链\n\n- APP:\n第三方APP或小程序跳转电子签小程序的path, APP或者小程序跳转适合此类型\n\n如果不传递,默认值是 APP",
6645
+ "document": "实名完之后的跳转链接,最大长度1000个字符。\n链接类型请参考 <a href=\"https://qian.tencent.com/developers/company/openqianh5\" target=\"_blank\">跳转电子签H5</a>。\n\n注:此参数仅支持 Endpoint 为 <font color=\"red\">H5 H5_SHORT_URL </font>的时候传递\n",
6646
+ "example": "无",
6647
+ "member": "string",
6648
+ "name": "JumpUrl",
6649
+ "required": false,
6650
+ "type": "string"
6651
+ },
6652
+ {
6653
+ "disabled": false,
6654
+ "document": "要跳转的链接类型\n\n- HTTP:\n跳转电子签小程序的http_url,短信通知或者H5跳转适合此类型 ,此时返回长链 (默认类型)\n\n- HTTP_SHORT_URL:\n跳转电子签小程序的http_url,短信通知或者H5跳转适合此类型,此时返回短链\n\n- APP:\n第三方APP或小程序跳转电子签小程序的path, APP或者小程序跳转适合此类型\n\n- H5:\n跳转电子签H5实名页面的长链\n\n- H5_SHORT_URL:\n跳转电子签H5实名页面的短链\n\n注:如果不传递,默认值是 <font color=\"red\"> APP </font>",
6646
6655
  "example": "APP",
6647
6656
  "member": "string",
6648
6657
  "name": "Endpoint",
@@ -6651,7 +6660,7 @@
6651
6660
  },
6652
6661
  {
6653
6662
  "disabled": false,
6654
- "document": "签署完成后是否自动回跳\n<ul><li>false:否, 实名完成不会自动跳转回来(默认)</li><li>true:是, 实名完成会自动跳转回来</li></ul>\n\n注: \n1. 该参数<font color=\"red\">只针对APP类型(电子签小程序跳转贵方小程序)场景</font> 的实名链接有效\n2. <font color=\"red\">手机应用APP 或 微信小程序需要监控界面的返回走后序逻辑</font>, 微信小程序的文档可以参考[这个](https://developers.weixin.qq.com/miniprogram/dev/reference/api/App.html#onShow-Object-object)\n3. <font color=\"red\">电子签小程序跳转贵方APP,不支持自动跳转,必需用户手动点击完成按钮(微信的限制)</font> ",
6663
+ "document": "签署完成后是否自动回跳\n<ul><li>false:否, 实名完成不会自动跳转回来(默认)</li><li>true:是, 实名完成会自动跳转回来</li></ul>\n\n注: \n1. 该参数<font color=\"red\">只针对APP类型(第三方APP或小程序跳转电子签小程序)场景</font> 的实名链接有效\n2. <font color=\"red\">手机应用APP 或 微信小程序需要监控界面的返回走后序逻辑</font>, 微信小程序的文档可以参考[这个](https://developers.weixin.qq.com/miniprogram/dev/reference/api/App.html#onShow-Object-object)\n3. <font color=\"red\">电子签小程序跳转贵方APP,不支持自动跳转,必需用户手动点击完成按钮(微信的限制)</font> ",
6655
6664
  "example": "无",
6656
6665
  "member": "bool",
6657
6666
  "name": "AutoJumpBack",
@@ -6675,7 +6684,7 @@
6675
6684
  "members": [
6676
6685
  {
6677
6686
  "disabled": false,
6678
- "document": "腾讯电子签小程序的实名认证链接。\n如果没有传递,默认值是 HTTP。 链接的有效期均是 7 天。\n\n- 如果EndPoint是APP,\n得到的链接类似于pages/guide/index?to=MP_PERSONAL_VERIFY&shortKey=yDCZHUyOcExAlcOvNod0, 用法可以参考描述中的\"跳转到小程序的实现\"\n\n- 如果EndPoint是HTTP,\n得到的链接类似于https://res.ess.tencent.cn/cdn/h5-activity/jump-mp.html?to=TAG_VERIFY&shortKey=yDCZHUyOcChrfpaswT0d,点击后会跳转到腾讯电子签小程序进行签署\n\n- 如果EndPoint是HTTP_SHORT_URL,\n得到的链接类似于https://essurl.cn/2n**42Nd,点击后会跳转到腾讯电子签小程序进行签署\n\n\n注: 生成的链路后面不能再增加参数\n示例值:https://essurl.cn/2n**42Nd",
6687
+ "document": "腾讯电子签小程序的实名认证链接。\n如果没有传递,默认值是 HTTP。 链接的有效期均是 7 天。\n\n- 如果EndPoint是APP,\n得到的链接类似于pages/guide/index?to=MP_PERSONAL_VERIFY&shortKey=yDCZHUyOcExAlcOvNod0, 用法可以参考描述中的\"跳转到小程序的实现\"\n\n- 如果EndPoint是HTTP,\n得到的链接类似于https://res.ess.tencent.cn/cdn/h5-activity/jump-mp.html?to=TAG_VERIFY&shortKey=yDCZHUyOcChrfpaswT0d,点击后会跳转到腾讯电子签小程序进行签署\n\n- 如果EndPoint是HTTP_SHORT_URL,\n得到的链接类似于https://essurl.cn/2n**42Nd,点击后会跳转到腾讯电子签小程序进行签署\n\n- 如果EndPoint是H5,\n得到的链接类似于 https://quick.test.qian.tencent.cn/guide?Code=yDU****VJhsS5q&CodeType=xxx&shortKey=yD*****frcb,点击后会跳转到腾讯电子签H5页面进行签署\n\n- 如果EndPoint是H5_SHORT_URL,\n得到的链接类似于https://essurl.cn/2n**42Nd,点击后会跳转到腾讯电子签H5页面进行签署\n\n\n`注:` <font color=\"red\">生成的链路后面不能再增加参数</font>\n示例值:https://essurl.cn/2n**42Nd",
6679
6688
  "example": "无",
6680
6689
  "member": "string",
6681
6690
  "name": "UserVerifyUrl",
@@ -8538,7 +8547,7 @@
8538
8547
  },
8539
8548
  {
8540
8549
  "disabled": false,
8541
- "document": "查询信息类型,取值如下:\n<ul>\n<li>0不返回授权用户</li>\n<li>1返回授权用户信息</li>\n</ul>",
8550
+ "document": "查询授权用户信息类型,取值如下:\n\n<ul> <li><b>0</b>:(默认)不返回授权用户信息</li> <li><b>1</b>:返回授权用户的信息</li> </ul>",
8542
8551
  "example": "1",
8543
8552
  "member": "int64",
8544
8553
  "name": "InfoType",
@@ -8547,7 +8556,7 @@
8547
8556
  },
8548
8557
  {
8549
8558
  "disabled": false,
8550
- "document": "印章id(没有输入返回所有)",
8559
+ "document": "印章id,是否查询特定的印章(没有输入返回所有)",
8551
8560
  "example": "无",
8552
8561
  "member": "string",
8553
8562
  "name": "SealId",
@@ -8556,7 +8565,7 @@
8556
8565
  },
8557
8566
  {
8558
8567
  "disabled": false,
8559
- "document": "印章类型列表(都是组织机构印章)。\n为空时查询所有类型的印章。\n目前支持以下类型:\n<ul>\n<li>OFFICIAL:企业公章;</li>\n<li>CONTRACT:合同专用章;</li>\n<li>ORGANIZATION_SEAL:企业印章(图片上传创建);</li>\n<li>LEGAL_PERSON_SEAL:法定代表人章</li>\n</ul>",
8568
+ "document": "印章种类列表(均为组织机构印章)。 若无特定需求,将展示所有类型的印章。 \n\n目前支持以下几种:\n\n<ul> <li><strong>OFFICIAL</strong>:企业公章;</li> <li><strong>CONTRACT</strong>:合同专用章;</li> <li><strong>ORGANIZATION_SEAL</strong>:企业印章(通过图片上传创建);</li> <li><strong>LEGAL_PERSON_SEAL</strong>:法定代表人章。</li> </ul>",
8560
8569
  "example": "无",
8561
8570
  "member": "string",
8562
8571
  "name": "SealTypes",
@@ -8574,7 +8583,7 @@
8574
8583
  },
8575
8584
  {
8576
8585
  "disabled": false,
8577
- "document": "查询的印章状态列表。\n<ul>\n<li>空,只查询启用状态的印章;</li>\n<li>ALL,查询所有状态的印章;</li>\n<li>CHECKING,查询待审核的印章;</li>\n<li>SUCCESS,查询启用状态的印章;</li>\n<li>FAIL,查询印章审核拒绝的印章;</li>\n<li>DISABLE,查询已停用的印章;</li>\n<li>STOPPED,查询已终止的印章;</li>\n<li>VOID,查询已作废的印章;</li>\n<li>INVALID,查询已失效的印章;</li>\n</ul>",
8586
+ "document": "需查询的印章状态列表。\n<ul>\n<li>空:(默认)仅查询启用状态的印章;</li>\n<li><strong>ALL</strong>:查询所有状态的印章;</li>\n<li><strong>CHECKING</strong>:查询待审核的印章;</li>\n<li><strong>SUCCESS</strong>:查询启用状态的印章;</li>\n<li><strong>FAIL</strong>:查询印章审核拒绝的印章;</li>\n<li><strong>DISABLE</strong>:查询已停用的印章;</li>\n<li><strong>STOPPED</strong>:查询已终止的印章;</li>\n<li><strong>VOID</strong>:查询已作废的印章;</li>\n<li><strong>INVALID</strong>:查询已失效的印章。</li>\n</ul>",
8578
8587
  "example": "无",
8579
8588
  "member": "string",
8580
8589
  "name": "SealStatuses",
@@ -8589,7 +8598,7 @@
8589
8598
  "members": [
8590
8599
  {
8591
8600
  "disabled": false,
8592
- "document": "在设置了SealId时返回0或1,没有设置时返回公司的总印章数量,可能比返回的印章数组数量多",
8601
+ "document": "在设定了SealId时,返回值为0或1;若未设定SealId,则返回公司的总印章数量",
8593
8602
  "example": "10",
8594
8603
  "member": "int64",
8595
8604
  "name": "TotalCount",
@@ -708,8 +708,8 @@
708
708
  {
709
709
  "document": "获取创建法人章二维码",
710
710
  "input": "POST / HTTP/1.1\nHost: ess.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: CreateLegalSealQrCode\n<公共请求参数>\n\n{\n \"Operator\": {\n \"UserId\": \"yDwfsUUckpsqt647UE6uSrk1ZWhYH56z\"\n }\n}",
711
- "output": "{\n \"Response\": {\n \"QrcodeBase64\": \"xxxxxxxxx\",\n \"RequestId\": \"3c140219-cfe9-470e-b241-907877d6fb03\"\n }\n}",
712
- "title": "获取创建法人章二维码"
711
+ "output": "{\n \"Response\": {\n \"QrcodeBase64\": \"5X8Af8AwfOf84uv+72f/fR6APgD/gyp/wCUpvx8/wCzAPin/wCtFfsq1/oOf8FNvCfirx7/AME2/wDgoN4F8C+GfEHjTxt40/Yg/av8J+DvB3hPRtR8R+KvFnirxH8BvH2j+HvDPhnw9o9teavr3iDXd(其他图片BASE64编码省略)\",\n \"RequestId\": \"3c140219-cfe9-470e-b241-907877d6fb03\"\n }\n}",
712
+ "title": "获取创建法人章二维码成功"
713
713
  }
714
714
  ],
715
715
  "CreateMultiFlowSignQRCode": [
@@ -1046,8 +1046,8 @@
1046
1046
  {
1047
1047
  "document": "获取c端用户实名链接",
1048
1048
  "input": "POST / HTTP/1.1\nHost: ess.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: CreateUserVerifyUrl\n<公共请求参数>\n\n{\n \"Operator\": {\n \"UserId\": \"19561039c99fe825a934a132520fde6a\",\n \"ClientIp\": \"8.8.8.8\"\n },\n \"Name\": \"典子谦\",\n \"Endpoint\": \"HTTP_SHORT_URL\",\n \"IdCardType\": \"ID_CARD\",\n \"IdCardNumber\": \"420101XXXXXXXX4059\",\n \"Mobile\": \"13200000015\"\n}",
1049
- "output": "{\n \"Response\": {\n \"ExpireTime\": 1713080196,\n \"MiniAppId\": \"wxa023b292fd19d41d\",\n \"RequestId\": \"s1712475396892401448\",\n \"UserVerifyUrl\": \"https://test.essurl.cn/RTo2UBE6X6\"\n }\n}",
1050
- "title": "获取c端用户实名链接"
1049
+ "output": "{\n \"Response\": {\n \"ExpireTime\": 1713080196,\n \"MiniAppId\": \"\",\n \"RequestId\": \"s1712475396892401448\",\n \"UserVerifyUrl\": \"https://test.essurl.cn/RTo****6X6\"\n }\n}",
1050
+ "title": "获取c端用户实名跳转链接"
1051
1051
  }
1052
1052
  ],
1053
1053
  "CreateWebThemeConfig": [
@@ -246,9 +246,9 @@
246
246
  "status": "online"
247
247
  },
248
248
  "ChannelDescribeOrganizationSeals": {
249
- "document": "此接口(ChannelDescribeOrganizationSeals)查询子客企业电子印章。<br />\n注: \n1. `查询子客企业电子印章,需要操作者具有管理印章权限`\n2. `客户指定需要获取的印章数量和偏移量,数量最多100,超过100按100处理`\n3. `此接口只能查询启用的印章`",
249
+ "document": "此接口查询子企业电子印章。<br />\n\n注:\n1. 此操作要求操作者具备<b>印章查询权限</b>(若调用者尚无此权限,请联系超级管理员前往Web控制台【组织管理】->【角色管理】添加相应权限)。",
250
250
  "input": "ChannelDescribeOrganizationSealsRequest",
251
- "name": "查询子客企业电子印章",
251
+ "name": "查询子企业电子印章",
252
252
  "output": "ChannelDescribeOrganizationSealsResponse",
253
253
  "status": "online"
254
254
  },
@@ -365,9 +365,9 @@
365
365
  "status": "online"
366
366
  },
367
367
  "CreateLegalSealQrCode": {
368
- "document": "此接口用于获取创建法人章二维码图片base64",
368
+ "document": "该接口用于获取创建法人章的二维码,需要通过微信扫描。扫描后将跳转到腾讯电子签署,进入到创建法人章的流程。\n\n**注意**\n1. 该二维码**有效期为7天**,过期后将失效,可重新创建 。\n2. 每个公司**只能有1个法人章**,无法重复创建或者创建多个\n\n法人章的样式可以参考下图索引(也可以自己上传法人印章图片):\n\n![image](https://qcloudimg.tencent-cloud.cn/raw/36a0a090750c45bb5cac5047ac461b2c.png)",
369
369
  "input": "CreateLegalSealQrCodeRequest",
370
- "name": "获取创建法人章二维码",
370
+ "name": "获取到电子签小程序创建法人章二维码",
371
371
  "output": "CreateLegalSealQrCodeResponse",
372
372
  "status": "online"
373
373
  },
@@ -4321,7 +4321,7 @@
4321
4321
  },
4322
4322
  {
4323
4323
  "disabled": false,
4324
- "document": "返回最大数量,最大为100",
4324
+ "document": "指定分页每页返回的数据条数,单页最大支持 100",
4325
4325
  "example": "10",
4326
4326
  "member": "int64",
4327
4327
  "name": "Limit",
@@ -4339,7 +4339,7 @@
4339
4339
  },
4340
4340
  {
4341
4341
  "disabled": false,
4342
- "document": "查询信息类型\n支持的值如下:\n<ul><li>0-默认,不返回授权用户信息</li>\n<li>1-返回授权用户信息</li>\n</ul>",
4342
+ "document": "查询授权用户信息类型,取值如下:\n\n<ul> <li><b>0</b>:(默认)不返回授权用户信息</li> <li><b>1</b>:返回授权用户的信息</li> </ul>",
4343
4343
  "example": "1",
4344
4344
  "member": "int64",
4345
4345
  "name": "InfoType",
@@ -4348,7 +4348,7 @@
4348
4348
  },
4349
4349
  {
4350
4350
  "disabled": false,
4351
- "document": "印章id(没有输入返回所有)\n\n注: `没有输入返回所有记录,最大返回100条。`",
4351
+ "document": "印章id,是否查询特定的印章(没有输入返回所有)\n\n注: `没有输入返回所有记录,最大返回100条。`",
4352
4352
  "example": "无",
4353
4353
  "member": "string",
4354
4354
  "name": "SealId",
@@ -4357,7 +4357,7 @@
4357
4357
  },
4358
4358
  {
4359
4359
  "disabled": false,
4360
- "document": "电子印章类型 , 可选类型如下: \n<ul><li>**OFFICIAL**: (默认)公章</li>\n<li>**CONTRACT**: 合同专用章;</li>\n<li>**FINANCE**: 财务专用章;</li>\n<li>**PERSONNEL**: 人事专用章</li>\n<li>**INVOICE**: 发票专用章</li>\n</ul>\n\n注: `为空时查询所有类型的印章。`",
4360
+ "document": "电子印章类型 , 可选类型如下: \n<ul><li>**OFFICIAL**: 公章</li>\n<li>**CONTRACT**: 合同专用章;</li>\n<li>**FINANCE**: 财务专用章;</li>\n<li>**PERSONNEL**: 人事专用章</li>\n<li>**INVOICE**: 发票专用章</li>\n</ul>\n\n注: `为空时查询所有类型的印章。`",
4361
4361
  "example": "无",
4362
4362
  "member": "string",
4363
4363
  "name": "SealTypes",
@@ -4366,7 +4366,7 @@
4366
4366
  },
4367
4367
  {
4368
4368
  "disabled": false,
4369
- "document": "查询的印章状态列表。 <ul> <li>空,只查询启用状态的印章;</li> <li>ALL,查询所有状态的印章;</li> <li>CHECKING,查询待审核的印章;</li> <li>SUCCESS,查询启用状态的印章;</li> <li>FAIL,查询印章审核拒绝的印章;</li> <li>DISABLE,查询已停用的印章;</li> <li>STOPPED,查询已终止的印章;</li> <li>VOID,查询已作废的印章;</li> <li>INVALID,查询已失效的印章;</li> </ul>",
4369
+ "document": "\n需查询的印章状态列表。\n\n<ul> <li>空,()仅查询启用状态的印章;</li> <li><strong>ALL</strong>,查询所有状态的印章;</li> <li><strong>CHECKING</strong>,查询待审核的印章;</li> <li><strong>SUCCESS</strong>,查询启用状态的印章;</li> <li><strong>FAIL</strong>,查询印章审核拒绝的印章;</li> <li><strong>DISABLE</strong>,查询已停用的印章;</li> <li><strong>STOPPED</strong>,查询已终止的印章;</li> <li><strong>VOID</strong>,查询已作废的印章;</li> <li><strong>INVALID</strong>,查询已失效的印章。</li> </ul>",
4370
4370
  "example": "无",
4371
4371
  "member": "string",
4372
4372
  "name": "SealStatuses",
@@ -4381,7 +4381,7 @@
4381
4381
  "members": [
4382
4382
  {
4383
4383
  "disabled": false,
4384
- "document": "在设置了SealId时返回0或1,没有设置时返回公司的总印章数量,可能比返回的印章数组数量多",
4384
+ "document": "在设定了SealId时,返回值为0或1;若未设定SealId,则返回公司的总印章数量",
4385
4385
  "example": "10",
4386
4386
  "member": "int64",
4387
4387
  "name": "TotalCount",
@@ -5490,7 +5490,7 @@
5490
5490
  "usage": "in"
5491
5491
  },
5492
5492
  "Component": {
5493
- "document": "此结构体 (Component) 用于描述控件属性。\n\n在通过文件发起合同时,对应的component有三种定位方式\n1. 绝对定位方式 (可以通过 [PDF坐标计算助手](https://qian.tencent.com/developers/tools/template-editor)计算控件的坐标)\n2. 表单域(FIELD)定位方式\n3. 关键字(KEYWORD)定位方式,使用关键字定位时,请确保PDF原始文件内是关键字以文字形式保存在PDF文件中,不支持对图片内文字进行关键字查找\n可以参考官网说明\nhttps://cloud.tencent.com/document/product/1323/78346#component-.E4.B8.89.E7.A7.8D.E5.AE.9A.E4.BD.8D.E6.96.B9.E5.BC.8F.E8.AF.B4.E6.98.8E",
5493
+ "document": "此结构体 (Component) 用于描述控件属性。\n\n在通过文件发起合同时,对应的component有三种定位方式\n1. 绝对定位方式 (可以通过 [PDF坐标计算助手](https://qian.tencent.com/developers/tools/template-editor)计算控件的坐标)\n2. 表单域(FIELD)定位方式\n3. 关键字(KEYWORD)定位方式,使用关键字定位时,请确保PDF原始文件内是关键字以文字形式保存在PDF文件中,不支持对图片内文字进行关键字查找",
5494
5494
  "members": [
5495
5495
  {
5496
5496
  "disabled": false,
@@ -6581,8 +6581,8 @@
6581
6581
  "members": [
6582
6582
  {
6583
6583
  "disabled": false,
6584
- "document": "二维码图片base64",
6585
- "example": "",
6584
+ "document": "二维码图片base64值,二维码有效期7天(604800秒)\n\n二维码图片的样式如下图:\n![image](https://qcloudimg.tencent-cloud.cn/raw/7ec2478761158a35a9c623882839a5df.png)",
6585
+ "example": "C61r2kWfiCz0jXdD1S60a4vI9Rt9O1nSr6a2S21Gzlm/V/8A4MY/+........(图片base64编码)",
6586
6586
  "member": "string",
6587
6587
  "name": "QrcodeBase64",
6588
6588
  "output_required": true,
@@ -798,8 +798,8 @@
798
798
  {
799
799
  "document": "获取创建法人章二维码",
800
800
  "input": "POST / HTTP/1.1\nHost: essbasic.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: CreateLegalSealQrCode\n<公共请求参数>\n\n{\n \"Agent\": {\n \"ProxyOrganizationOpenId\": \"org_dianziqian\",\n \"ProxyOperator\": {\n \"OpenId\": \"n9527\"\n },\n \"AppId\": \"yDwfwUUgygormhg1UuS2eARxjMT0mxAw\"\n }\n}",
801
- "output": "{\n \"Response\": {\n \"QrcodeBase64\": \"xxxxxxxxx\",\n \"RequestId\": \"3c140219-cfe9-470e-b241-907877d6fb03\"\n }\n}",
802
- "title": "获取创建法人章二维码"
801
+ "output": "{\n \"Response\": {\n \"QrcodeBase64\": \"5X8Af8AwfOf84uv+72f/fR6APgD/gyp/wCUpvx8/wCzAPin/wCtFfsq1/oOf8FNvCfirx7/AME2/wDgoN4F8C+GfEHjTxt40/Yg/av8J+DvB3hPRtR8R+KvFnirxH8BvH2j+HvDPhnw9o9teavr3iDXd(其他图片BASE64编码省略)\",\n \"RequestId\": \"3c140219-cfe9-470e-b241-907877d6fb03\"\n }\n}",
802
+ "title": "获取创建法人章二维码成功"
803
803
  }
804
804
  ],
805
805
  "CreatePartnerAutoSignAuthUrl": [