tccli 3.0.1196.1__py2.py3-none-any.whl → 3.0.1198.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 (29) hide show
  1. tccli/__init__.py +1 -1
  2. tccli/services/apigateway/apigateway_client.py +57 -4
  3. tccli/services/apigateway/v20180808/api.json +24 -0
  4. tccli/services/apigateway/v20180808/examples.json +8 -0
  5. tccli/services/cvm/v20170312/api.json +24 -24
  6. tccli/services/emr/emr_client.py +114 -8
  7. tccli/services/emr/v20190103/api.json +296 -3
  8. tccli/services/emr/v20190103/examples.json +16 -0
  9. tccli/services/ess/v20201111/api.json +19 -1
  10. tccli/services/ess/v20201111/examples.json +1 -1
  11. tccli/services/essbasic/v20210526/api.json +18 -0
  12. tccli/services/essbasic/v20210526/examples.json +1 -1
  13. tccli/services/faceid/v20180301/api.json +9 -0
  14. tccli/services/hunyuan/v20230901/api.json +1 -1
  15. tccli/services/organization/organization_client.py +106 -0
  16. tccli/services/organization/v20210331/api.json +324 -27
  17. tccli/services/organization/v20210331/examples.json +17 -1
  18. tccli/services/postgres/postgres_client.py +106 -0
  19. tccli/services/postgres/v20170312/api.json +236 -9
  20. tccli/services/postgres/v20170312/examples.json +24 -2
  21. tccli/services/sms/v20190711/api.json +8 -8
  22. tccli/services/sms/v20210111/api.json +13 -13
  23. tccli/services/teo/v20220901/api.json +6 -6
  24. tccli/services/vod/v20180717/api.json +3 -3
  25. {tccli-3.0.1196.1.dist-info → tccli-3.0.1198.1.dist-info}/METADATA +2 -2
  26. {tccli-3.0.1196.1.dist-info → tccli-3.0.1198.1.dist-info}/RECORD +29 -29
  27. {tccli-3.0.1196.1.dist-info → tccli-3.0.1198.1.dist-info}/WHEEL +0 -0
  28. {tccli-3.0.1196.1.dist-info → tccli-3.0.1198.1.dist-info}/entry_points.txt +0 -0
  29. {tccli-3.0.1196.1.dist-info → tccli-3.0.1198.1.dist-info}/license_files/LICENSE +0 -0
@@ -112,6 +112,13 @@
112
112
  "output": "DescribeEmrOverviewMetricsResponse",
113
113
  "status": "online"
114
114
  },
115
+ "DescribeGlobalConfig": {
116
+ "document": "查询YARN资源调度的全局配置",
117
+ "input": "DescribeGlobalConfigRequest",
118
+ "name": "查询YARN资源调度的全局配置",
119
+ "output": "DescribeGlobalConfigResponse",
120
+ "status": "online"
121
+ },
115
122
  "DescribeHBaseTableOverview": {
116
123
  "document": "获取Hbase表级监控数据概览接口",
117
124
  "input": "DescribeHBaseTableOverviewRequest",
@@ -287,6 +294,13 @@
287
294
  "output": "ModifyAutoScaleStrategyResponse",
288
295
  "status": "online"
289
296
  },
297
+ "ModifyGlobalConfig": {
298
+ "document": "修改YARN资源调度的全局配置",
299
+ "input": "ModifyGlobalConfigRequest",
300
+ "name": "修改YARN资源调度的全局配置",
301
+ "output": "ModifyGlobalConfigResponse",
302
+ "status": "online"
303
+ },
290
304
  "ModifyResourcePools": {
291
305
  "document": "刷新YARN的动态资源池。已废弃,请使用`DeployYarnConf`",
292
306
  "input": "ModifyResourcePoolsRequest",
@@ -1141,6 +1155,52 @@
1141
1155
  ],
1142
1156
  "usage": "both"
1143
1157
  },
1158
+ "CapacityGlobalConfig": {
1159
+ "document": "资源调度-容量调度器的全局设置",
1160
+ "members": [
1161
+ {
1162
+ "disabled": false,
1163
+ "document": "是否开启了标签调度",
1164
+ "example": "无",
1165
+ "member": "bool",
1166
+ "name": "EnableLabel",
1167
+ "output_required": true,
1168
+ "type": "bool",
1169
+ "value_allowed_null": false
1170
+ },
1171
+ {
1172
+ "disabled": false,
1173
+ "document": "如果开启了标签调度,标签信息存放的路径\n注意:此字段可能返回 null,表示取不到有效值。",
1174
+ "example": "无",
1175
+ "member": "string",
1176
+ "name": "LabelDir",
1177
+ "output_required": false,
1178
+ "type": "string",
1179
+ "value_allowed_null": true
1180
+ },
1181
+ {
1182
+ "disabled": false,
1183
+ "document": "是否覆盖用户指定队列,为true表示覆盖。\n注意:此字段可能返回 null,表示取不到有效值。",
1184
+ "example": "无",
1185
+ "member": "bool",
1186
+ "name": "QueueMappingOverride",
1187
+ "output_required": false,
1188
+ "type": "bool",
1189
+ "value_allowed_null": true
1190
+ },
1191
+ {
1192
+ "disabled": false,
1193
+ "document": "高级设置\n注意:此字段可能返回 null,表示取不到有效值。",
1194
+ "example": "无",
1195
+ "member": "DefaultSetting",
1196
+ "name": "DefaultSettings",
1197
+ "output_required": false,
1198
+ "type": "list",
1199
+ "value_allowed_null": true
1200
+ }
1201
+ ],
1202
+ "usage": "out"
1203
+ },
1144
1204
  "CdbInfo": {
1145
1205
  "document": "出参",
1146
1206
  "members": [
@@ -2912,6 +2972,62 @@
2912
2972
  ],
2913
2973
  "usage": "both"
2914
2974
  },
2975
+ "DefaultSetting": {
2976
+ "document": "资源调度的默认设置",
2977
+ "members": [
2978
+ {
2979
+ "disabled": false,
2980
+ "document": "名称,作为入参的key",
2981
+ "example": "无",
2982
+ "member": "string",
2983
+ "name": "Name",
2984
+ "output_required": true,
2985
+ "type": "string",
2986
+ "value_allowed_null": false
2987
+ },
2988
+ {
2989
+ "disabled": false,
2990
+ "document": "描述",
2991
+ "example": "无",
2992
+ "member": "string",
2993
+ "name": "Desc",
2994
+ "output_required": true,
2995
+ "type": "string",
2996
+ "value_allowed_null": false
2997
+ },
2998
+ {
2999
+ "disabled": false,
3000
+ "document": "提示",
3001
+ "example": "无",
3002
+ "member": "string",
3003
+ "name": "Prompt",
3004
+ "output_required": true,
3005
+ "type": "string",
3006
+ "value_allowed_null": false
3007
+ },
3008
+ {
3009
+ "disabled": false,
3010
+ "document": "key,用于展示,该配置对应与配置文件中的配置项",
3011
+ "example": "无",
3012
+ "member": "string",
3013
+ "name": "Key",
3014
+ "output_required": true,
3015
+ "type": "string",
3016
+ "value_allowed_null": false
3017
+ },
3018
+ {
3019
+ "disabled": false,
3020
+ "document": "Name对应的值\n注意:此字段可能返回 null,表示取不到有效值。",
3021
+ "example": "无",
3022
+ "member": "string",
3023
+ "name": "Value",
3024
+ "output_required": false,
3025
+ "type": "string",
3026
+ "value_allowed_null": true
3027
+ }
3028
+ ],
3029
+ "usage": "out"
3030
+ },
2915
3031
  "DeleteAutoScaleStrategyRequest": {
2916
3032
  "document": "DeleteAutoScaleStrategy请求参数结构体",
2917
3033
  "members": [
@@ -3846,6 +3962,83 @@
3846
3962
  ],
3847
3963
  "type": "object"
3848
3964
  },
3965
+ "DescribeGlobalConfigRequest": {
3966
+ "document": "DescribeGlobalConfig请求参数结构体",
3967
+ "members": [
3968
+ {
3969
+ "disabled": false,
3970
+ "document": "emr集群的英文id",
3971
+ "example": "emr-2xef56",
3972
+ "member": "string",
3973
+ "name": "InstanceId",
3974
+ "required": true,
3975
+ "type": "string"
3976
+ }
3977
+ ],
3978
+ "type": "object"
3979
+ },
3980
+ "DescribeGlobalConfigResponse": {
3981
+ "document": "DescribeGlobalConfig返回参数结构体",
3982
+ "members": [
3983
+ {
3984
+ "disabled": false,
3985
+ "document": "是否开启了资源调度功能",
3986
+ "example": "true",
3987
+ "member": "bool",
3988
+ "name": "EnableResourceSchedule",
3989
+ "output_required": true,
3990
+ "type": "bool",
3991
+ "value_allowed_null": false
3992
+ },
3993
+ {
3994
+ "disabled": false,
3995
+ "document": "当前生效的资源调度器",
3996
+ "example": "\"fair\"",
3997
+ "member": "string",
3998
+ "name": "ActiveScheduler",
3999
+ "output_required": false,
4000
+ "type": "string",
4001
+ "value_allowed_null": false
4002
+ },
4003
+ {
4004
+ "disabled": false,
4005
+ "document": "公平调度器的信息\n注意:此字段可能返回 null,表示取不到有效值。",
4006
+ "example": "无",
4007
+ "member": "CapacityGlobalConfig",
4008
+ "name": "CapacityGlobalConfig",
4009
+ "output_required": false,
4010
+ "type": "object",
4011
+ "value_allowed_null": true
4012
+ },
4013
+ {
4014
+ "disabled": false,
4015
+ "document": "容量调度器的信息\n注意:此字段可能返回 null,表示取不到有效值。",
4016
+ "example": "无",
4017
+ "member": "FairGlobalConfig",
4018
+ "name": "FairGlobalConfig",
4019
+ "output_required": false,
4020
+ "type": "object",
4021
+ "value_allowed_null": true
4022
+ },
4023
+ {
4024
+ "disabled": false,
4025
+ "document": "最新的资源调度器",
4026
+ "example": "无",
4027
+ "member": "string",
4028
+ "name": "Scheduler",
4029
+ "output_required": false,
4030
+ "type": "string",
4031
+ "value_allowed_null": false
4032
+ },
4033
+ {
4034
+ "document": "唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。",
4035
+ "member": "string",
4036
+ "name": "RequestId",
4037
+ "type": "string"
4038
+ }
4039
+ ],
4040
+ "type": "object"
4041
+ },
3849
4042
  "DescribeHBaseTableOverviewRequest": {
3850
4043
  "document": "DescribeHBaseTableOverview请求参数结构体",
3851
4044
  "members": [
@@ -5721,6 +5914,7 @@
5721
5914
  "example": "1",
5722
5915
  "member": "int64",
5723
5916
  "name": "Count",
5917
+ "output_required": true,
5724
5918
  "required": true,
5725
5919
  "type": "int",
5726
5920
  "value_allowed_null": true
@@ -5731,6 +5925,7 @@
5731
5925
  "example": "CLOUD_SSD",
5732
5926
  "member": "string",
5733
5927
  "name": "DiskType",
5928
+ "output_required": true,
5734
5929
  "required": true,
5735
5930
  "type": "string",
5736
5931
  "value_allowed_null": true
@@ -5741,9 +5936,21 @@
5741
5936
  "example": "无",
5742
5937
  "member": "int64",
5743
5938
  "name": "DiskSize",
5939
+ "output_required": true,
5744
5940
  "required": true,
5745
5941
  "type": "int",
5746
5942
  "value_allowed_null": true
5943
+ },
5944
+ {
5945
+ "disabled": false,
5946
+ "document": "额外性能\n注意:此字段可能返回 null,表示取不到有效值。",
5947
+ "example": "无",
5948
+ "member": "int64",
5949
+ "name": "ExtraPerformance",
5950
+ "output_required": false,
5951
+ "required": false,
5952
+ "type": "int",
5953
+ "value_allowed_null": true
5747
5954
  }
5748
5955
  ],
5749
5956
  "usage": "both"
@@ -6630,6 +6837,22 @@
6630
6837
  ],
6631
6838
  "usage": "in"
6632
6839
  },
6840
+ "FairGlobalConfig": {
6841
+ "document": "资源调度-公平调度器的全局配置",
6842
+ "members": [
6843
+ {
6844
+ "disabled": false,
6845
+ "document": "对应与页面的<p>程序上限</p>\n注意:此字段可能返回 null,表示取不到有效值。",
6846
+ "example": "1000",
6847
+ "member": "int64",
6848
+ "name": "UserMaxAppsDefault",
6849
+ "output_required": false,
6850
+ "type": "int",
6851
+ "value_allowed_null": true
6852
+ }
6853
+ ],
6854
+ "usage": "out"
6855
+ },
6633
6856
  "Filters": {
6634
6857
  "document": "Emr集群列表实例自定义查询过滤",
6635
6858
  "members": [
@@ -8864,6 +9087,42 @@
8864
9087
  ],
8865
9088
  "type": "object"
8866
9089
  },
9090
+ "ModifyGlobalConfigRequest": {
9091
+ "document": "ModifyGlobalConfig请求参数结构体",
9092
+ "members": [
9093
+ {
9094
+ "disabled": false,
9095
+ "document": "emr集群的英文id",
9096
+ "example": "emr-2xef56",
9097
+ "member": "string",
9098
+ "name": "InstanceId",
9099
+ "required": true,
9100
+ "type": "string"
9101
+ },
9102
+ {
9103
+ "disabled": false,
9104
+ "document": "修改的配置列表。其中Key的取值与`DescribeGlobalConfig`接口的出参一一对应,不区分大小写(如果报错找不到Key,以出参为准),分别为:\n1. 开启或关闭资源调度:enableResourceSchedule;在关闭时会有一个同步的选项,Key为sync,取值为true或false。\n2. 调度器类型:scheduler。\n2. 开启或关闭标签:enableLabel,取值为true或false。\n2. 标签目录:labelDir。\n3. 是否覆盖用户指定队列:queueMappingOverride,取值为true、false。\n4. 程序上限:userMaxAppsDefault。\n5. 动态配置项:`DescribeGlobalConfig`接口返回的DefaultSettings中的Name字段。\nValue的取值都是字符串,对于**是否覆盖用户指定队列**、**程序上限**,json规范中的null表示清空该配置的值。支持修改单个配置项的值。对于**动态配置项**则需要全量传递以进行覆盖。",
9105
+ "example": "无",
9106
+ "member": "Item",
9107
+ "name": "Items",
9108
+ "required": true,
9109
+ "type": "list"
9110
+ }
9111
+ ],
9112
+ "type": "object"
9113
+ },
9114
+ "ModifyGlobalConfigResponse": {
9115
+ "document": "ModifyGlobalConfig返回参数结构体",
9116
+ "members": [
9117
+ {
9118
+ "document": "唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。",
9119
+ "member": "string",
9120
+ "name": "RequestId",
9121
+ "type": "string"
9122
+ }
9123
+ ],
9124
+ "type": "object"
9125
+ },
8867
9126
  "ModifyResourcePoolsRequest": {
8868
9127
  "document": "ModifyResourcePools请求参数结构体",
8869
9128
  "members": [
@@ -9465,9 +9724,10 @@
9465
9724
  {
9466
9725
  "disabled": false,
9467
9726
  "document": "该类型云盘个数\n注意:此字段可能返回 null,表示取不到有效值。",
9468
- "example": "",
9727
+ "example": "",
9469
9728
  "member": "int64",
9470
9729
  "name": "Count",
9730
+ "output_required": true,
9471
9731
  "required": true,
9472
9732
  "type": "int",
9473
9733
  "value_allowed_null": true
@@ -9475,19 +9735,32 @@
9475
9735
  {
9476
9736
  "disabled": false,
9477
9737
  "document": "磁盘类型\n注意:此字段可能返回 null,表示取不到有效值。",
9478
- "example": "",
9738
+ "example": "",
9479
9739
  "member": "int64",
9480
9740
  "name": "Type",
9741
+ "output_required": true,
9481
9742
  "required": false,
9482
9743
  "type": "int",
9483
9744
  "value_allowed_null": true
9484
9745
  },
9746
+ {
9747
+ "disabled": false,
9748
+ "document": "磁盘大小\n注意:此字段可能返回 null,表示取不到有效值。",
9749
+ "example": "100 GB",
9750
+ "member": "string",
9751
+ "name": "Size",
9752
+ "output_required": false,
9753
+ "required": false,
9754
+ "type": "string",
9755
+ "value_allowed_null": true
9756
+ },
9485
9757
  {
9486
9758
  "disabled": false,
9487
9759
  "document": "云盘大小\n注意:此字段可能返回 null,表示取不到有效值。",
9488
- "example": "",
9760
+ "example": "",
9489
9761
  "member": "int64",
9490
9762
  "name": "Volume",
9763
+ "output_required": true,
9491
9764
  "required": false,
9492
9765
  "type": "int",
9493
9766
  "value_allowed_null": true
@@ -10175,6 +10448,26 @@
10175
10448
  "output_required": false,
10176
10449
  "type": "string",
10177
10450
  "value_allowed_null": true
10451
+ },
10452
+ {
10453
+ "disabled": false,
10454
+ "document": "共享集群id\n注意:此字段可能返回 null,表示取不到有效值。",
10455
+ "example": "无",
10456
+ "member": "string",
10457
+ "name": "SharedClusterId",
10458
+ "output_required": false,
10459
+ "type": "string",
10460
+ "value_allowed_null": true
10461
+ },
10462
+ {
10463
+ "disabled": false,
10464
+ "document": "共享集群id描述\n注意:此字段可能返回 null,表示取不到有效值。",
10465
+ "example": "无",
10466
+ "member": "string",
10467
+ "name": "SharedClusterIdDesc",
10468
+ "output_required": false,
10469
+ "type": "string",
10470
+ "value_allowed_null": true
10178
10471
  }
10179
10472
  ],
10180
10473
  "usage": "out"
@@ -128,6 +128,14 @@
128
128
  "title": "查询监控概览页指标数据"
129
129
  }
130
130
  ],
131
+ "DescribeGlobalConfig": [
132
+ {
133
+ "document": "",
134
+ "input": "POST / HTTP/1.1\nHost: emr.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: DescribeGlobalConfig\n<公共请求参数>\n\n{\n \"InstanceId\": \"emr-xxx\"\n}",
135
+ "output": "{\n \"Response\": {\n \"EnableResourceSchedule\": true,\n \"ActiveScheduler\": \"abc\",\n \"CapacityGlobalConfig\": {\n \"EnableLabel\": true,\n \"LabelDir\": \"abc\",\n \"QueueMappingOverride\": true,\n \"DefaultSettings\": [\n {\n \"Name\": \"abc\",\n \"Desc\": \"abc\",\n \"Prompt\": \"abc\",\n \"Key\": \"abc\",\n \"Value\": \"abc\"\n }\n ]\n },\n \"FairGlobalConfig\": {\n \"UserMaxAppsDefault\": 0\n },\n \"Scheduler\": \"abc\",\n \"RequestId\": \"abc\"\n }\n}",
136
+ "title": "查询YARN资源调度的全局配置"
137
+ }
138
+ ],
131
139
  "DescribeHBaseTableOverview": [
132
140
  {
133
141
  "document": "",
@@ -340,6 +348,14 @@
340
348
  "title": "修改扩缩容规则成功示例"
341
349
  }
342
350
  ],
351
+ "ModifyGlobalConfig": [
352
+ {
353
+ "document": "",
354
+ "input": "POST / HTTP/1.1\nHost: emr.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: ModifyGlobalConfig\n<公共请求参数>\n\n{\n \"InstanceId\": \"abc\",\n \"Items\": [\n {\n \"Key\": \"abc\",\n \"Value\": \"abc\"\n }\n ]\n}",
355
+ "output": "{\n \"Response\": {\n \"RequestId\": \"abc\"\n }\n}",
356
+ "title": "修改YARN资源调度的全局配置"
357
+ }
358
+ ],
343
359
  "ModifyResourcePools": [
344
360
  {
345
361
  "document": "",
@@ -57,7 +57,7 @@
57
57
  "status": "online"
58
58
  },
59
59
  "CreateBatchQuickSignUrl": {
60
- "document": "该接口用于发起合同后,生成个人用户的批量签署链接, 暂时不支持企业端签署。\n**注意:**\n1. 该接口目前仅支持签署人类型是**个人签署方的批量签署场景**(ApproverType=1)。\n2. 该接口可生成批量签署链接的C端签署人**必须仅有手写签名(控件类型为SIGN_SIGNATURE)和时间类型的签署控件**,**不支持填写控件** 。\n3. 请确保C端签署人在批量签署合同中**为待签署状态**,如需顺序签署请待前一位参与人签署完成后,再创建该C端用户的签署链接。\n4. 该签署链接**有效期为30分钟**,过期后将失效,如需签署可重新创建批量签署链接 。\n5. 该接口返回的签署链接适用于APP集成的场景,支持APP打开或浏览器直接打开,**不支持微信小程序嵌入**。\n跳转到小程序的实现,参考微信官方文档(分为<a href=\"https://developers.weixin.qq.com/miniprogram/dev/api/navigate/wx.navigateToMiniProgram.html\">全屏</a>、<a href=\"https://developers.weixin.qq.com/miniprogram/dev/framework/open-ability/openEmbeddedMiniProgram.html\">半屏</a>两种方式),如何配置也可以请参考: <a href=\"https://qian.tencent.com/developers/company/openwxminiprogram\">跳转电子签小程序配置</a>。\n6. 因h5涉及人脸身份认证能力基于慧眼人脸核身,对Android和iOS系统均有一定要求, 因此<font color='red'>App嵌入H5签署合同需要按照慧眼提供的<a href=\"https://cloud.tencent.com/document/product/1007/61076\">慧眼人脸核身兼容性文档</a>做兼容性适配</font>。",
60
+ "document": "该接口用于发起合同后,生成个人用户的批量待办链接, 暂时不支持企业端签署。\n**注意:**\n1. 该接口目前仅支持签署人类型是**个人签署方的批量签署场景**(ApproverType=1)。\n2. 该接口可生成批量签署链接的C端签署人**必须仅有手写签名(控件类型为SIGN_SIGNATURE)和时间类型的签署控件**,**不支持填写控件** 。\n3. 请确保C端签署人在批量签署合同中**为待签署状态**,如需顺序签署请待前一位参与人签署完成后,再创建该C端用户的签署链接。\n4. 该签署链接**有效期为30分钟**,过期后将失效,如需签署可重新创建批量签署链接 。\n5. 该接口返回的签署链接适用于APP集成的场景,支持APP打开或浏览器直接打开,**不支持微信小程序嵌入**。\n跳转到小程序的实现,参考微信官方文档(分为<a href=\"https://developers.weixin.qq.com/miniprogram/dev/api/navigate/wx.navigateToMiniProgram.html\">全屏</a>、<a href=\"https://developers.weixin.qq.com/miniprogram/dev/framework/open-ability/openEmbeddedMiniProgram.html\">半屏</a>两种方式),如何配置也可以请参考: <a href=\"https://qian.tencent.com/developers/company/openwxminiprogram\">跳转电子签小程序配置</a>。\n6. 因h5涉及人脸身份认证能力基于慧眼人脸核身,对Android和iOS系统均有一定要求, 因此<font color='red'>App嵌入H5签署合同需要按照慧眼提供的<a href=\"https://cloud.tencent.com/document/product/1007/61076\">慧眼人脸核身兼容性文档</a>做兼容性适配</font>。",
61
61
  "input": "CreateBatchQuickSignUrlRequest",
62
62
  "name": "获取H5批量签署链接",
63
63
  "output": "CreateBatchQuickSignUrlResponse",
@@ -2567,6 +2567,15 @@
2567
2567
  "name": "SignTypeSelector",
2568
2568
  "required": false,
2569
2569
  "type": "int"
2570
+ },
2571
+ {
2572
+ "disabled": false,
2573
+ "document": "批量签署合同相关信息,指定合同和签署方的信息,用于补充动态签署人。\t",
2574
+ "example": "无",
2575
+ "member": "FlowBatchUrlInfo",
2576
+ "name": "FlowBatchUrlInfo",
2577
+ "required": false,
2578
+ "type": "object"
2570
2579
  }
2571
2580
  ],
2572
2581
  "type": "object"
@@ -5886,6 +5895,15 @@
5886
5895
  "name": "InitiatorComponents",
5887
5896
  "required": false,
5888
5897
  "type": "list"
5898
+ },
5899
+ {
5900
+ "disabled": false,
5901
+ "document": "在短信通知、填写、签署流程中,若标题、按钮、合同详情等地方存在“合同”字样时,可根据此配置指定文案,可选文案如下: <ul><li> <b>0</b> :合同(默认值)</li> <li> <b>1</b> :文件</li> <li> <b>2</b> :协议</li></ul>效果如下:![FlowDisplayType](https://qcloudimg.tencent-cloud.cn/raw/e4a2c4d638717cc901d3dbd5137c9bbc.png)",
5902
+ "example": "1",
5903
+ "member": "int64",
5904
+ "name": "FlowDisplayType",
5905
+ "required": false,
5906
+ "type": "int"
5889
5907
  }
5890
5908
  ],
5891
5909
  "type": "object"
@@ -175,7 +175,7 @@
175
175
  },
176
176
  {
177
177
  "document": "1. 创建批量签署链接的合同签署方,必须都是动态签署人且未补充。\n2. 批量签署的合同数量不少于1份,不超过100份\n3. 上述合同签署方类型必须一致,均为待C端签署人签署状态\n4. 企业已经购买了专业版或以上版本套餐",
178
- "input": "POST / HTTP/1.1\nHost: ess.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: CreateBatchQuickSignUrl\n<公共请求参数>\n\n{\n \"ApproverSignTypes\": [\n 1,\n 3\n ],\n \"FlowApproverInfo\": {\n \"ApproverType\": 1\n },\n \"FlowIds\": [\n \"yDwFmUUckpstqfvzUE1h3jo1f3cqjkGm\",\n \"yDwFmUUckpst10i3UubBSat8PWOt2iQF\"\n ],\n \"JumpUrl\": \"https://abc.com\",\n \"SignatureTypes\": [\n 0,\n 1\n ]\n}",
178
+ "input": "POST / HTTP/1.1\nHost: ess.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: CreateBatchQuickSignUrl\n<公共请求参数>\n\n{\n \"ApproverSignTypes\": [\n 1,\n 3\n ],\n \"FlowApproverInfo\": {\n \"ApproverType\": 1\n },\n \"FlowIds\": [\n \"yDwFmUUckpstqfvzUE1h3jo1f3cqjkGm\",\n \"yDwFmUUckpst10i3UubBSat8PWOt2iQF\"\n ],\n \"JumpUrl\": \"https://abc.com\",\n \"SignatureTypes\": [\n 0,\n 1\n ],\n \"FlowBatchUrlInfo\": {\n \"FlowBatchApproverInfos\": [\n {\n \"FlowId\": \"yDwFmUUckpstqfvzUE1h3jo1f3cqjkGm\",\n \"RecipientId\": \"yDCmvUUckpup6xhwUxKRs1rIRejg254i\"\n },\n {\n \"FlowId\": \"yDwFmUUckpst10i3UubBSat8PWOt2iQF\",\n \"RecipientId\": \"yDCmvUUckpup6xh1UxKRs1rwHjT5QyHH\"\n }\n ]\n }\n}",
179
179
  "output": "{\n \"Response\": {\n \"FlowApproverUrlInfo\": {\n \"ApproverMobile\": \"\",\n \"ApproverName\": \"\",\n \"ApproverType\": 1,\n \"LongUrl\": \"https://quick.qian.tencent.cn/guide?Code=yDwiB**FOE&CodeType=QUICK&shortKey=yDwiB**1e5&token=Rg0**Q\",\n \"SignUrl\": \"https://essurl.cn/Rg0**Q\"\n },\n \"RequestId\": \"s1698**9686\"\n }\n}",
180
180
  "title": "发起合同后,获取C端签署人的H5批量领取链接"
181
181
  }
@@ -1064,6 +1064,15 @@
1064
1064
  "name": "Components",
1065
1065
  "required": false,
1066
1066
  "type": "list"
1067
+ },
1068
+ {
1069
+ "disabled": false,
1070
+ "document": "在短信通知、填写、签署流程中,若标题、按钮、合同详情等地方存在“合同”字样时,可根据此配置指定文案,可选文案如下: <ul><li> <b>0</b> :合同(默认值)</li> <li> <b>1</b> :文件</li> <li> <b>2</b> :协议</li></ul>效果如下:![FlowDisplayType](https://qcloudimg.tencent-cloud.cn/raw/e4a2c4d638717cc901d3dbd5137c9bbc.png)\n",
1071
+ "example": "1",
1072
+ "member": "int64",
1073
+ "name": "FlowDisplayType",
1074
+ "required": false,
1075
+ "type": "int"
1067
1076
  }
1068
1077
  ],
1069
1078
  "usage": "in"
@@ -1660,6 +1669,15 @@
1660
1669
  "name": "SignTypeSelector",
1661
1670
  "required": false,
1662
1671
  "type": "int"
1672
+ },
1673
+ {
1674
+ "disabled": false,
1675
+ "document": "批量签署合同相关信息,指定合同和签署方的信息,用于补充动态签署人。\t",
1676
+ "example": "无",
1677
+ "member": "FlowBatchUrlInfo",
1678
+ "name": "FlowBatchUrlInfo",
1679
+ "required": false,
1680
+ "type": "object"
1663
1681
  }
1664
1682
  ],
1665
1683
  "type": "object"
@@ -115,7 +115,7 @@
115
115
  },
116
116
  {
117
117
  "document": "1. 创建批量签署链接的合同签署方,必须都是动态签署人且未补充。\n2. 批量签署的合同数量不少于1份,不超过100份\n3. 上述合同签署方类型必须一致,均为待C端签署人签署状态\n4. 企业已经购买了专业版或以上版本套餐\n5. 获取领取链接通过指定RecipientId定位签署方,可以从发起合同的返回结果中获取",
118
- "input": "POST / HTTP/1.1\nHost: essbasic.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: ChannelCreateBatchQuickSignUrl\n<公共请求参数>\n\n{\n \"Agent\": {\n \"ProxyOrganizationOpenId\": \"org_dianziqian\",\n \"AppId\": \"yDRSRUUgygj6rq7wUuO4zjECxndqQApl\"\n },\n \"ApproverSignTypes\": [\n 1,\n 3\n ],\n \"FlowApproverInfo\": {\n \"ApproverType\": \"PERSON\"\n },\n \"FlowIds\": [\n \"yDwFkUUckpstin4sUuZjBEY5Ia2XB7sz\",\n \"yDwFkUUckpstzjhfUugNAWf1KibXqS26\"\n ],\n \"JumpUrl\": \"https://abc.com\",\n \"SignatureTypes\": [\n 0,\n 1\n ]\n}",
118
+ "input": "POST / HTTP/1.1\nHost: essbasic.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: ChannelCreateBatchQuickSignUrl\n<公共请求参数>\n\n{\n \"Agent\": {\n \"ProxyOrganizationOpenId\": \"org_dianziqian\",\n \"AppId\": \"yDRSRUUgygj6rq7wUuO4zjECxndqQApl\"\n },\n \"ApproverSignTypes\": [\n 1,\n 3\n ],\n \"FlowApproverInfo\": {\n \"ApproverType\": \"PERSON\"\n },\n \"FlowIds\": [\n \"yDwFkUUckpstin4sUuZjBEY5Ia2XB7sz\",\n \"yDwFkUUckpstzjhfUugNAWf1KibXqS26\"\n ],\n \"JumpUrl\": \"https://abc.com\",\n \"SignatureTypes\": [\n 0,\n 1\n ],\n \"FlowBatchUrlInfo\": {\n \"FlowBatchApproverInfos\": [\n {\n \"FlowId\": \"yDwFkUUckpstin4sUuZjBEY5Ia2XB7sz\",\n \"RecipientId\": \"yDCmvUUckpup6xhwUxKRs1rIRejg254i\"\n },\n {\n \"FlowId\": \"yDwFkUUckpstzjhfUugNAWf1KibXqS26\",\n \"RecipientId\": \"yDCmvUUckpup6xh1UxKRs1rwHjT5QyHH\"\n }\n ]\n }\n}",
119
119
  "output": "{\n \"Response\": {\n \"FlowApproverUrlInfo\": {\n \"ApproverType\": \"PERSON\",\n \"LongUrl\": \"https://quick.qian.tencent.cn/guide?Code=yDwi0**BWW4MYlpI&CodeType=QUICK&shortKey=yDwi**KF45&token=C**E\",\n \"Mobile\": \"\",\n \"Name\": \"\",\n \"SignUrl\": \"https://test.essurl.cn/C**E\"\n },\n \"RequestId\": \"s16986**08\"\n }\n}",
120
120
  "title": "发起合同后,获取C端签署人的H5批量领取链接"
121
121
  }
@@ -5103,6 +5103,15 @@
5103
5103
  "name": "MouthOpenRecognition",
5104
5104
  "required": false,
5105
5105
  "type": "bool"
5106
+ },
5107
+ {
5108
+ "disabled": false,
5109
+ "document": "意愿核身语音播报速度,配置后问答模式和点头模式的语音播报环节都会生效,默认值为0:\n0:智能语速(根据播报文案的长度自动调整语音播报速度)\n1:固定1倍速\n2:固定1.2倍速\n3:固定1.5倍速",
5110
+ "example": "0",
5111
+ "member": "uint64",
5112
+ "name": "Speed",
5113
+ "required": false,
5114
+ "type": "int"
5106
5115
  }
5107
5116
  ],
5108
5117
  "usage": "in"
@@ -227,7 +227,7 @@
227
227
  },
228
228
  {
229
229
  "disabled": false,
230
- "document": "图文并茂开关。\n说明:\n1. 该参数仅在功能增强(如搜索)开关开启(EnableEnhancement=true)时生效。\n2. hunyuan-lite 无图文并茂能力,该参数对 hunyuan-lite 版本不生效。\n3. 未传值时默认关闭。\n4. 开启并搜索到对应的多媒体信息时,会输出对应的多媒体地址,可以定制个性化的图文消息。",
230
+ "document": "图文并茂开关。\n详细介绍请阅读 [图文并茂](https://cloud.tencent.com/document/product/1729/111178) 中的说明。\n说明:\n1. 该参数仅在功能增强(如搜索)开关开启(EnableEnhancement=true)时生效。\n2. hunyuan-lite 无图文并茂能力,该参数对 hunyuan-lite 版本不生效。\n3. 未传值时默认关闭。\n4. 开启并搜索到对应的多媒体信息时,会输出对应的多媒体地址,可以定制个性化的图文消息。",
231
231
  "example": "false",
232
232
  "member": "bool",
233
233
  "name": "EnableMultimedia",