tccli 3.0.1315.1__py2.py3-none-any.whl → 3.0.1316.1__py2.py3-none-any.whl
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- tccli/__init__.py +1 -1
- tccli/services/bh/v20230418/api.json +2 -2
- tccli/services/cbs/v20170312/api.json +51 -40
- tccli/services/cbs/v20170312/examples.json +7 -7
- tccli/services/cdb/v20170320/api.json +32 -19
- tccli/services/cdwdoris/v20211228/api.json +20 -0
- tccli/services/cfs/v20190719/api.json +39 -39
- tccli/services/cfs/v20190719/examples.json +10 -10
- tccli/services/cfw/v20190904/api.json +4 -4
- tccli/services/cvm/v20170312/api.json +9 -9
- tccli/services/cynosdb/v20190107/api.json +139 -2
- tccli/services/dnspod/v20210323/api.json +17 -17
- tccli/services/emr/v20190103/api.json +10 -0
- tccli/services/ess/v20201111/api.json +29 -11
- tccli/services/ess/v20201111/examples.json +1 -1
- tccli/services/essbasic/v20210526/api.json +23 -5
- tccli/services/essbasic/v20210526/examples.json +1 -1
- tccli/services/gs/v20191118/api.json +22 -0
- tccli/services/hai/v20230812/api.json +58 -58
- tccli/services/hai/v20230812/examples.json +6 -6
- tccli/services/lke/v20231130/api.json +401 -7
- tccli/services/postgres/postgres_client.py +16 -122
- tccli/services/postgres/v20170312/api.json +0 -86
- tccli/services/postgres/v20170312/examples.json +0 -22
- tccli/services/privatedns/v20201028/api.json +4 -4
- tccli/services/privatedns/v20201028/examples.json +2 -2
- tccli/services/pts/v20210728/api.json +10 -0
- tccli/services/ssl/v20191205/api.json +4 -4
- tccli/services/teo/v20220901/api.json +5 -5
- tccli/services/tke/tke_client.py +8 -61
- tccli/services/tke/v20180525/api.json +10 -108
- tccli/services/tke/v20180525/examples.json +0 -8
- tccli/services/tms/v20201229/api.json +27 -8
- tccli/services/tms/v20201229/examples.json +2 -2
- tccli/services/vpc/v20170312/api.json +11 -11
- tccli/services/vpc/v20170312/examples.json +2 -2
- {tccli-3.0.1315.1.dist-info → tccli-3.0.1316.1.dist-info}/METADATA +2 -2
- {tccli-3.0.1315.1.dist-info → tccli-3.0.1316.1.dist-info}/RECORD +41 -41
- {tccli-3.0.1315.1.dist-info → tccli-3.0.1316.1.dist-info}/WHEEL +0 -0
- {tccli-3.0.1315.1.dist-info → tccli-3.0.1316.1.dist-info}/entry_points.txt +0 -0
- {tccli-3.0.1315.1.dist-info → tccli-3.0.1316.1.dist-info}/license_files/LICENSE +0 -0
@@ -6216,7 +6216,7 @@
|
|
6216
6216
|
"members": [
|
6217
6217
|
{
|
6218
6218
|
"disabled": false,
|
6219
|
-
"document": "
|
6219
|
+
"document": "导入镜像的操作系统架构。\n取值范围包括:`x86_64` 、`i386`、`arm_64`",
|
6220
6220
|
"example": "x86_64",
|
6221
6221
|
"member": "string",
|
6222
6222
|
"name": "Architecture",
|
@@ -6225,7 +6225,7 @@
|
|
6225
6225
|
},
|
6226
6226
|
{
|
6227
6227
|
"disabled": false,
|
6228
|
-
"document": "
|
6228
|
+
"document": "导入镜像的操作系统类型 。\n可通过 [DescribeImportImageOs](https://cloud.tencent.com/document/api/213/15718) 接口返回值中的`ImportImageOsListSupported`获取。",
|
6229
6229
|
"example": "CentOS",
|
6230
6230
|
"member": "string",
|
6231
6231
|
"name": "OsType",
|
@@ -6234,7 +6234,7 @@
|
|
6234
6234
|
},
|
6235
6235
|
{
|
6236
6236
|
"disabled": false,
|
6237
|
-
"document": "
|
6237
|
+
"document": "导入镜像的操作系统版本。\n可通过 [DescribeImportImageOs](https://cloud.tencent.com/document/api/213/15718) 接口返回值中的`ImportImageOsVersionSet`获取。",
|
6238
6238
|
"example": "6",
|
6239
6239
|
"member": "string",
|
6240
6240
|
"name": "OsVersion",
|
@@ -6252,7 +6252,7 @@
|
|
6252
6252
|
},
|
6253
6253
|
{
|
6254
6254
|
"disabled": false,
|
6255
|
-
"document": "
|
6255
|
+
"document": "镜像名称。\n最多支持 60 个字符。",
|
6256
6256
|
"example": "sample",
|
6257
6257
|
"member": "string",
|
6258
6258
|
"name": "ImageName",
|
@@ -6261,7 +6261,7 @@
|
|
6261
6261
|
},
|
6262
6262
|
{
|
6263
6263
|
"disabled": false,
|
6264
|
-
"document": "
|
6264
|
+
"document": "镜像描述。\n最多支持 256 个字符。",
|
6265
6265
|
"example": "sampleimage",
|
6266
6266
|
"member": "string",
|
6267
6267
|
"name": "ImageDescription",
|
@@ -6270,7 +6270,7 @@
|
|
6270
6270
|
},
|
6271
6271
|
{
|
6272
6272
|
"disabled": false,
|
6273
|
-
"document": "
|
6273
|
+
"document": "只检查参数,不执行任务。\n默认值:false",
|
6274
6274
|
"example": "false",
|
6275
6275
|
"member": "bool",
|
6276
6276
|
"name": "DryRun",
|
@@ -6279,7 +6279,7 @@
|
|
6279
6279
|
},
|
6280
6280
|
{
|
6281
6281
|
"disabled": false,
|
6282
|
-
"document": "是否强制导入,参考[强制导入镜像](https://cloud.tencent.com/document/product/213/12849)",
|
6282
|
+
"document": "是否强制导入,参考[强制导入镜像](https://cloud.tencent.com/document/product/213/12849)\n默认值:false",
|
6283
6283
|
"example": "false",
|
6284
6284
|
"member": "bool",
|
6285
6285
|
"name": "Force",
|
@@ -6297,7 +6297,7 @@
|
|
6297
6297
|
},
|
6298
6298
|
{
|
6299
6299
|
"disabled": false,
|
6300
|
-
"document": "导入镜像后,激活操作系统采用的许可证类型。\n
|
6300
|
+
"document": "导入镜像后,激活操作系统采用的许可证类型。\n默认值:TencentCloud\n取值范围:\nTencentCloud: 腾讯云官方许可\nBYOL: 自带许可(Bring Your Own License)",
|
6301
6301
|
"example": "TencentCloud",
|
6302
6302
|
"member": "string",
|
6303
6303
|
"name": "LicenseType",
|
@@ -6306,7 +6306,7 @@
|
|
6306
6306
|
},
|
6307
6307
|
{
|
6308
6308
|
"disabled": false,
|
6309
|
-
"document": "
|
6309
|
+
"document": "启动模式。\n取值范围:`Legacy BIOS`、`UEFI`\n默认值:Legacy BIOS",
|
6310
6310
|
"example": "Legacy BIOS",
|
6311
6311
|
"member": "string",
|
6312
6312
|
"name": "BootMode",
|
@@ -3920,7 +3920,7 @@
|
|
3920
3920
|
"type": "string"
|
3921
3921
|
},
|
3922
3922
|
{
|
3923
|
-
"disabled":
|
3923
|
+
"disabled": true,
|
3924
3924
|
"document": "已废弃。",
|
3925
3925
|
"example": "已废弃",
|
3926
3926
|
"member": "AuditLogFilter",
|
@@ -4660,6 +4660,24 @@
|
|
4660
4660
|
"name": "InstanceInitInfos",
|
4661
4661
|
"required": false,
|
4662
4662
|
"type": "list"
|
4663
|
+
},
|
4664
|
+
{
|
4665
|
+
"disabled": false,
|
4666
|
+
"document": "全球数据库唯一标识",
|
4667
|
+
"example": "cynosmysql-gdn-dbsgxagb",
|
4668
|
+
"member": "string",
|
4669
|
+
"name": "GdnId",
|
4670
|
+
"required": false,
|
4671
|
+
"type": "string"
|
4672
|
+
},
|
4673
|
+
{
|
4674
|
+
"disabled": false,
|
4675
|
+
"document": "数据库代理配置",
|
4676
|
+
"example": "无",
|
4677
|
+
"member": "ProxyConfig",
|
4678
|
+
"name": "ProxyConfig",
|
4679
|
+
"required": false,
|
4680
|
+
"type": "object"
|
4663
4681
|
}
|
4664
4682
|
],
|
4665
4683
|
"type": "object"
|
@@ -5795,6 +5813,17 @@
|
|
5795
5813
|
"required": false,
|
5796
5814
|
"type": "list",
|
5797
5815
|
"value_allowed_null": false
|
5816
|
+
},
|
5817
|
+
{
|
5818
|
+
"disabled": false,
|
5819
|
+
"document": "全球数据库唯一标识",
|
5820
|
+
"example": "cynosdbmysql-gdn-dbssdfa1",
|
5821
|
+
"member": "string",
|
5822
|
+
"name": "GdnId",
|
5823
|
+
"output_required": false,
|
5824
|
+
"required": false,
|
5825
|
+
"type": "string",
|
5826
|
+
"value_allowed_null": false
|
5798
5827
|
}
|
5799
5828
|
],
|
5800
5829
|
"usage": "both"
|
@@ -6311,6 +6340,26 @@
|
|
6311
6340
|
"output_required": false,
|
6312
6341
|
"type": "string",
|
6313
6342
|
"value_allowed_null": false
|
6343
|
+
},
|
6344
|
+
{
|
6345
|
+
"disabled": false,
|
6346
|
+
"document": "全球数据库网络唯一标识",
|
6347
|
+
"example": "cynosdbmysql-gdn-xdgsdbsa",
|
6348
|
+
"member": "string",
|
6349
|
+
"name": "GdnId",
|
6350
|
+
"output_required": false,
|
6351
|
+
"type": "string",
|
6352
|
+
"value_allowed_null": false
|
6353
|
+
},
|
6354
|
+
{
|
6355
|
+
"disabled": false,
|
6356
|
+
"document": "集群在全球数据网络中的角色。\n主集群- primary\n从集群 - standby\n如为空,该字段无效",
|
6357
|
+
"example": "primary",
|
6358
|
+
"member": "string",
|
6359
|
+
"name": "GdnRole",
|
6360
|
+
"output_required": false,
|
6361
|
+
"type": "string",
|
6362
|
+
"value_allowed_null": false
|
6314
6363
|
}
|
6315
6364
|
],
|
6316
6365
|
"usage": "out"
|
@@ -6933,6 +6982,16 @@
|
|
6933
6982
|
"output_required": false,
|
6934
6983
|
"type": "list",
|
6935
6984
|
"value_allowed_null": false
|
6985
|
+
},
|
6986
|
+
{
|
6987
|
+
"disabled": false,
|
6988
|
+
"document": "全球数据库唯一标识",
|
6989
|
+
"example": "cynosdbmysql-gdn-cgsxflsb",
|
6990
|
+
"member": "string",
|
6991
|
+
"name": "GdnId",
|
6992
|
+
"output_required": false,
|
6993
|
+
"type": "string",
|
6994
|
+
"value_allowed_null": false
|
6936
6995
|
}
|
6937
6996
|
],
|
6938
6997
|
"usage": "out"
|
@@ -8715,7 +8774,7 @@
|
|
8715
8774
|
"type": "string"
|
8716
8775
|
},
|
8717
8776
|
{
|
8718
|
-
"disabled":
|
8777
|
+
"disabled": true,
|
8719
8778
|
"document": "已废弃。",
|
8720
8779
|
"example": "无",
|
8721
8780
|
"member": "AuditLogFilter",
|
@@ -18395,6 +18454,84 @@
|
|
18395
18454
|
],
|
18396
18455
|
"usage": "out"
|
18397
18456
|
},
|
18457
|
+
"ProxyConfig": {
|
18458
|
+
"document": "访问代理配置",
|
18459
|
+
"members": [
|
18460
|
+
{
|
18461
|
+
"disabled": false,
|
18462
|
+
"document": "数据库代理组节点个数(该参数不再建议使用,建议使用ProxyZones)",
|
18463
|
+
"example": "cynosdbmysql-xxxxxxx",
|
18464
|
+
"member": "int64",
|
18465
|
+
"name": "ProxyCount",
|
18466
|
+
"required": false,
|
18467
|
+
"type": "int"
|
18468
|
+
},
|
18469
|
+
{
|
18470
|
+
"disabled": false,
|
18471
|
+
"document": "cpu核数",
|
18472
|
+
"example": "2",
|
18473
|
+
"member": "int64",
|
18474
|
+
"name": "Cpu",
|
18475
|
+
"required": false,
|
18476
|
+
"type": "int"
|
18477
|
+
},
|
18478
|
+
{
|
18479
|
+
"disabled": false,
|
18480
|
+
"document": "内存",
|
18481
|
+
"example": "4000",
|
18482
|
+
"member": "int64",
|
18483
|
+
"name": "Mem",
|
18484
|
+
"required": false,
|
18485
|
+
"type": "int"
|
18486
|
+
},
|
18487
|
+
{
|
18488
|
+
"disabled": false,
|
18489
|
+
"document": "连接池类型:SessionConnectionPool(会话级别连接池 )",
|
18490
|
+
"example": "SessionConnectionPool",
|
18491
|
+
"member": "string",
|
18492
|
+
"name": "ConnectionPoolType",
|
18493
|
+
"required": false,
|
18494
|
+
"type": "string"
|
18495
|
+
},
|
18496
|
+
{
|
18497
|
+
"disabled": false,
|
18498
|
+
"document": "是否开启连接池,yes-开启,no-不开启",
|
18499
|
+
"example": "yes",
|
18500
|
+
"member": "string",
|
18501
|
+
"name": "OpenConnectionPool",
|
18502
|
+
"required": false,
|
18503
|
+
"type": "string"
|
18504
|
+
},
|
18505
|
+
{
|
18506
|
+
"disabled": false,
|
18507
|
+
"document": "连接池阈值:单位(秒)",
|
18508
|
+
"example": "0",
|
18509
|
+
"member": "int64",
|
18510
|
+
"name": "ConnectionPoolTimeOut",
|
18511
|
+
"required": false,
|
18512
|
+
"type": "int"
|
18513
|
+
},
|
18514
|
+
{
|
18515
|
+
"disabled": false,
|
18516
|
+
"document": "描述说明",
|
18517
|
+
"example": "无",
|
18518
|
+
"member": "string",
|
18519
|
+
"name": "Description",
|
18520
|
+
"required": false,
|
18521
|
+
"type": "string"
|
18522
|
+
},
|
18523
|
+
{
|
18524
|
+
"disabled": false,
|
18525
|
+
"document": "数据库节点信息(该参数与ProxyCount需要任选一个输入)",
|
18526
|
+
"example": "无",
|
18527
|
+
"member": "ProxyZone",
|
18528
|
+
"name": "ProxyZones",
|
18529
|
+
"required": false,
|
18530
|
+
"type": "list"
|
18531
|
+
}
|
18532
|
+
],
|
18533
|
+
"usage": "in"
|
18534
|
+
},
|
18398
18535
|
"ProxyConnectionPoolInfo": {
|
18399
18536
|
"document": "数据库代理连接池信息",
|
18400
18537
|
"members": [
|
@@ -921,7 +921,7 @@
|
|
921
921
|
"example": "15689601",
|
922
922
|
"member": "uint64",
|
923
923
|
"name": "RecordId",
|
924
|
-
"
|
924
|
+
"output_required": true,
|
925
925
|
"type": "int",
|
926
926
|
"value_allowed_null": false
|
927
927
|
},
|
@@ -931,19 +931,19 @@
|
|
931
931
|
"example": "默认",
|
932
932
|
"member": "string",
|
933
933
|
"name": "Area",
|
934
|
-
"
|
934
|
+
"output_required": true,
|
935
935
|
"type": "string",
|
936
936
|
"value_allowed_null": false
|
937
937
|
},
|
938
938
|
{
|
939
939
|
"disabled": false,
|
940
|
-
"document": "
|
940
|
+
"document": "记录备注",
|
941
941
|
"example": "首页",
|
942
942
|
"member": "string",
|
943
943
|
"name": "Remark",
|
944
|
-
"
|
944
|
+
"output_required": true,
|
945
945
|
"type": "string",
|
946
|
-
"value_allowed_null":
|
946
|
+
"value_allowed_null": false
|
947
947
|
},
|
948
948
|
{
|
949
949
|
"disabled": false,
|
@@ -951,7 +951,7 @@
|
|
951
951
|
"example": "600",
|
952
952
|
"member": "uint64",
|
953
953
|
"name": "TTL",
|
954
|
-
"
|
954
|
+
"output_required": true,
|
955
955
|
"type": "int",
|
956
956
|
"value_allowed_null": false
|
957
957
|
},
|
@@ -961,7 +961,7 @@
|
|
961
961
|
"example": "A",
|
962
962
|
"member": "string",
|
963
963
|
"name": "RecordType",
|
964
|
-
"
|
964
|
+
"output_required": true,
|
965
965
|
"type": "string",
|
966
966
|
"value_allowed_null": false
|
967
967
|
},
|
@@ -971,7 +971,7 @@
|
|
971
971
|
"example": "1",
|
972
972
|
"member": "uint64",
|
973
973
|
"name": "Enabled",
|
974
|
-
"
|
974
|
+
"output_required": true,
|
975
975
|
"type": "int",
|
976
976
|
"value_allowed_null": false
|
977
977
|
},
|
@@ -981,7 +981,7 @@
|
|
981
981
|
"example": "20",
|
982
982
|
"member": "uint64",
|
983
983
|
"name": "Weight",
|
984
|
-
"
|
984
|
+
"output_required": true,
|
985
985
|
"type": "int",
|
986
986
|
"value_allowed_null": true
|
987
987
|
},
|
@@ -991,17 +991,17 @@
|
|
991
991
|
"example": "0",
|
992
992
|
"member": "uint64",
|
993
993
|
"name": "GroupId",
|
994
|
-
"
|
994
|
+
"output_required": true,
|
995
995
|
"type": "int",
|
996
996
|
"value_allowed_null": false
|
997
997
|
},
|
998
998
|
{
|
999
999
|
"disabled": false,
|
1000
1000
|
"document": "子域名",
|
1001
|
-
"example": "
|
1001
|
+
"example": "www",
|
1002
1002
|
"member": "string",
|
1003
1003
|
"name": "SubDomain",
|
1004
|
-
"
|
1004
|
+
"output_required": true,
|
1005
1005
|
"type": "string",
|
1006
1006
|
"value_allowed_null": false
|
1007
1007
|
},
|
@@ -1011,7 +1011,7 @@
|
|
1011
1011
|
"example": "0.0.0.0",
|
1012
1012
|
"member": "string",
|
1013
1013
|
"name": "Value",
|
1014
|
-
"
|
1014
|
+
"output_required": true,
|
1015
1015
|
"type": "string",
|
1016
1016
|
"value_allowed_null": false
|
1017
1017
|
},
|
@@ -1021,7 +1021,7 @@
|
|
1021
1021
|
"example": "0",
|
1022
1022
|
"member": "uint64",
|
1023
1023
|
"name": "MX",
|
1024
|
-
"
|
1024
|
+
"output_required": true,
|
1025
1025
|
"type": "int",
|
1026
1026
|
"value_allowed_null": true
|
1027
1027
|
}
|
@@ -3666,7 +3666,7 @@
|
|
3666
3666
|
{
|
3667
3667
|
"disabled": false,
|
3668
3668
|
"document": "要搜索的域名列表。",
|
3669
|
-
"example": "
|
3669
|
+
"example": "[\"dnspod.cn\",\"dnspod.com\"]",
|
3670
3670
|
"member": "string",
|
3671
3671
|
"name": "DomainList",
|
3672
3672
|
"required": false,
|
@@ -3675,7 +3675,7 @@
|
|
3675
3675
|
{
|
3676
3676
|
"disabled": false,
|
3677
3677
|
"document": "要搜索的域名 ID 列表。",
|
3678
|
-
"example": "
|
3678
|
+
"example": "[72203,72204]",
|
3679
3679
|
"member": "uint64",
|
3680
3680
|
"name": "DomainIdList",
|
3681
3681
|
"required": false,
|
@@ -3684,7 +3684,7 @@
|
|
3684
3684
|
{
|
3685
3685
|
"disabled": false,
|
3686
3686
|
"document": "要搜索的域名分组 ID 列表。",
|
3687
|
-
"example": "
|
3687
|
+
"example": "[9,10]",
|
3688
3688
|
"member": "uint64",
|
3689
3689
|
"name": "GroupIdList",
|
3690
3690
|
"required": false,
|
@@ -4517,6 +4517,16 @@
|
|
4517
4517
|
"type": "list",
|
4518
4518
|
"value_allowed_null": true
|
4519
4519
|
},
|
4520
|
+
{
|
4521
|
+
"disabled": false,
|
4522
|
+
"document": "流程描述",
|
4523
|
+
"example": "等待计费处理资源申请中",
|
4524
|
+
"member": "string",
|
4525
|
+
"name": "FlowInfo",
|
4526
|
+
"output_required": false,
|
4527
|
+
"type": "string",
|
4528
|
+
"value_allowed_null": false
|
4529
|
+
},
|
4520
4530
|
{
|
4521
4531
|
"document": "唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。",
|
4522
4532
|
"member": "string",
|
@@ -923,7 +923,7 @@
|
|
923
923
|
},
|
924
924
|
{
|
925
925
|
"disabled": false,
|
926
|
-
"document": "<font
|
926
|
+
"document": "<font color=\"red\">【已不再使用】</font>签署意愿确认渠道,默认为WEIXINAPP:人脸识别\n\n注: 该字段已不再使用, 请用ApproverSignTypes签署人签署合同时的认证方式代替, 新客户可请用ApproverSignTypes来设置",
|
927
927
|
"example": "[\"WEIXINAPP\"]",
|
928
928
|
"member": "string",
|
929
929
|
"name": "VerifyChannel",
|
@@ -3191,8 +3191,8 @@
|
|
3191
3191
|
},
|
3192
3192
|
{
|
3193
3193
|
"disabled": false,
|
3194
|
-
"document": "
|
3195
|
-
"example": "
|
3194
|
+
"document": "该字段已不再使用",
|
3195
|
+
"example": "该字段已不再使用",
|
3196
3196
|
"member": "string",
|
3197
3197
|
"name": "ClientToken",
|
3198
3198
|
"required": false,
|
@@ -4685,6 +4685,15 @@
|
|
4685
4685
|
"name": "SignComponentConfig",
|
4686
4686
|
"required": false,
|
4687
4687
|
"type": "object"
|
4688
|
+
},
|
4689
|
+
{
|
4690
|
+
"disabled": false,
|
4691
|
+
"document": "是否禁止编辑(展示)水印控件属性\n<ul><li>(默认) false -否</li> <li> true - 禁止编辑</li></ul>",
|
4692
|
+
"example": "true",
|
4693
|
+
"member": "bool",
|
4694
|
+
"name": "ForbidEditWatermark",
|
4695
|
+
"required": false,
|
4696
|
+
"type": "bool"
|
4688
4697
|
}
|
4689
4698
|
],
|
4690
4699
|
"usage": "in"
|
@@ -4794,8 +4803,8 @@
|
|
4794
4803
|
},
|
4795
4804
|
{
|
4796
4805
|
"disabled": false,
|
4797
|
-
"document": "
|
4798
|
-
"example": "
|
4806
|
+
"document": "该字段已不再使用",
|
4807
|
+
"example": "该字段已不再使用",
|
4799
4808
|
"member": "string",
|
4800
4809
|
"name": "ClientToken",
|
4801
4810
|
"required": false,
|
@@ -6643,7 +6652,7 @@
|
|
6643
6652
|
},
|
6644
6653
|
{
|
6645
6654
|
"disabled": false,
|
6646
|
-
"document": "
|
6655
|
+
"document": "该字段已不再使用,请使用InitiatorComponents",
|
6647
6656
|
"example": "无",
|
6648
6657
|
"member": "Component",
|
6649
6658
|
"name": "Components",
|
@@ -6733,7 +6742,7 @@
|
|
6733
6742
|
},
|
6734
6743
|
{
|
6735
6744
|
"disabled": true,
|
6736
|
-
"document": "<font color=\"red\"
|
6745
|
+
"document": "<font color=\"red\">此字段已不再使用,请使用 CreateFlowOption 里面的 SignComponentConfig</font>\n签署控件的配置信息,用在嵌入式发起的页面配置,\n包括 \n\n- 签署控件 是否默认展示日期.",
|
6737
6746
|
"example": "无",
|
6738
6747
|
"member": "SignComponentConfig",
|
6739
6748
|
"name": "SignComponentConfig",
|
@@ -6825,8 +6834,8 @@
|
|
6825
6834
|
},
|
6826
6835
|
{
|
6827
6836
|
"disabled": true,
|
6828
|
-
"document": "
|
6829
|
-
"example": "
|
6837
|
+
"document": "该字段已不再使用",
|
6838
|
+
"example": "该字段已不再使用",
|
6830
6839
|
"member": "string",
|
6831
6840
|
"name": "SealImage",
|
6832
6841
|
"required": false,
|
@@ -6852,7 +6861,7 @@
|
|
6852
6861
|
},
|
6853
6862
|
{
|
6854
6863
|
"disabled": false,
|
6855
|
-
"document": "
|
6864
|
+
"document": "该字段已不再使用",
|
6856
6865
|
"example": "false",
|
6857
6866
|
"member": "bool",
|
6858
6867
|
"name": "EnableAutoSign",
|
@@ -10882,6 +10891,15 @@
|
|
10882
10891
|
"name": "SkipUploadFile",
|
10883
10892
|
"required": false,
|
10884
10893
|
"type": "bool"
|
10894
|
+
},
|
10895
|
+
{
|
10896
|
+
"disabled": false,
|
10897
|
+
"document": "是否禁止编辑(展示)水印控件属性\n<ul><li>(默认) false -否</li> <li> true - 禁止编辑</li></ul>\n",
|
10898
|
+
"example": "true",
|
10899
|
+
"member": "bool",
|
10900
|
+
"name": "ForbidEditWatermark",
|
10901
|
+
"required": false,
|
10902
|
+
"type": "bool"
|
10885
10903
|
}
|
10886
10904
|
],
|
10887
10905
|
"usage": "in"
|
@@ -16136,7 +16154,7 @@
|
|
16136
16154
|
},
|
16137
16155
|
{
|
16138
16156
|
"disabled": false,
|
16139
|
-
"document": "
|
16157
|
+
"document": "该字段已不再使用",
|
16140
16158
|
"example": "9b337a42",
|
16141
16159
|
"member": "string",
|
16142
16160
|
"name": "CustomIds",
|
@@ -1037,7 +1037,7 @@
|
|
1037
1037
|
"CreatePrepareFlowGroup": [
|
1038
1038
|
{
|
1039
1039
|
"document": "",
|
1040
|
-
"input": "POST / HTTP/1.1\nHost: ess.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: CreatePrepareFlowGroup\n<公共请求参数>\n\n{\n \"Operator\": {\n \"UserId\": \"yDwf3UUckps8dvypUEfH3DjwIpMfa0uw\"\n },\n \"FlowGroupInfos\": [\n {\n \"FileIds\": [\n \"yDCWiUUckpv6iggyUyuqIrwyppQVS7TR\"\n ],\n \"FlowName\": \"预发起合同\",\n \"FlowType\": \"嵌入式文件发起合同\",\n \"FlowDescription\": \"
|
1040
|
+
"input": "POST / HTTP/1.1\nHost: ess.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: CreatePrepareFlowGroup\n<公共请求参数>\n\n{\n \"Operator\": {\n \"UserId\": \"yDwf3UUckps8dvypUEfH3DjwIpMfa0uw\"\n },\n \"FlowGroupInfos\": [\n {\n \"FileIds\": [\n \"yDCWiUUckpv6iggyUyuqIrwyppQVS7TR\"\n ],\n \"FlowName\": \"预发起合同\",\n \"FlowType\": \"嵌入式文件发起合同\",\n \"FlowDescription\": \"这是2025年购买食物的合同\",\n \"Deadline\": 1757034793,\n \"Unordered\": false,\n \"NeedSignReview\": false,\n \"UserData\": \"\",\n \"Approvers\": [\n {\n \"ApproverType\": 1,\n \"OrganizationName\": \"\",\n \"ApproverName\": \"典子签\",\n \"ApproverOption\": {\n \"CanEditApprover\": true\n },\n \"ApproverMobile\": \"18700000000\",\n \"SignComponents\": [\n {\n \"ChannelComponentId\": \"\",\n \"ChannelComponentSource\": 0,\n \"ComponentDateFontSize\": 0,\n \"ComponentExtra\": \"\",\n \"ComponentHeight\": 100,\n \"ComponentId\": \"\",\n \"ComponentName\": \"\",\n \"ComponentPage\": 3,\n \"ComponentPosX\": 160,\n \"ComponentPosY\": 360,\n \"ComponentRecipientId\": \"\",\n \"ComponentRequired\": false,\n \"ComponentType\": \"SIGN_SIGNATURE\",\n \"ComponentValue\": \"\",\n \"ComponentWidth\": 100,\n \"FileIndex\": 0,\n \"ForbidMoveAndDelete\": true,\n \"GenerateMode\": \"\",\n \"IsFormType\": false,\n \"KeywordIndexes\": [],\n \"KeywordOrder\": \"\",\n \"KeywordPage\": 0,\n \"LockComponentValue\": false,\n \"OffsetX\": 0,\n \"OffsetY\": 0,\n \"RelativeLocation\": \"\"\n }\n ]\n }\n ]\n }\n ],\n \"FlowGroupName\": \"group\",\n \"ResourceType\": 2\n}",
|
1041
1041
|
"output": "{\n \"Response\": {\n \"FlowGroupId\": \"yDttAUUckpxbcziqUySqdD5Eugn0LPHo\",\n \"RequestId\": \"s1747034803503801327\",\n \"PrepareUrl\": \"https://embed.test.qian.tencent.cn/contract-create?embed=1&expiredOn=1747035103&code=yDttAUUckpxbcHI&businessId=yDttAUUckpxbcziqUySqdD5o&channel=TENCENTCLOUD&operateSource=byFileGroup&themeId=saas_web_theme_yDhk9nE0qLixm\"\n }\n}",
|
1042
1042
|
"title": "文件发起嵌入式合同组"
|
1043
1043
|
}
|
@@ -610,7 +610,7 @@
|
|
610
610
|
"status": "online"
|
611
611
|
},
|
612
612
|
"PrepareFlows": {
|
613
|
-
"document": "该接口 (PrepareFlows) 用于创建待发起文件\n用户通过该接口进入签署流程发起的确认页面,进行发起信息二次确认, 如果确认则进行正常发起。\n目前该接口只支持B2C,<font color='red'>
|
613
|
+
"document": "该接口 (PrepareFlows) 用于创建待发起文件\n用户通过该接口进入签署流程发起的确认页面,进行发起信息二次确认, 如果确认则进行正常发起。\n目前该接口只支持B2C,<font color='red'> **不建议使用**</font>。",
|
614
614
|
"input": "PrepareFlowsRequest",
|
615
615
|
"name": "准备待发起文件",
|
616
616
|
"output": "PrepareFlowsResponse",
|
@@ -1798,7 +1798,7 @@
|
|
1798
1798
|
"members": [
|
1799
1799
|
{
|
1800
1800
|
"disabled": false,
|
1801
|
-
"document": "批量签署的流程签署人,其中姓名(ApproverName)、参与人类型(ApproverType)必传,手机号(ApproverMobile)和证件信息(ApproverIdCardType、ApproverIdCardNumber)可任选一种或全部传入。\n<ul>\n<li>若为个人参与方:ApproverType:\"PERSON\"</li>\n<li>若为企业参与方:ApproverType:\"ORGANIZATION\"。同时若签署方为saas企业员工, OrganizationName
|
1801
|
+
"document": "批量签署的流程签署人,其中姓名(ApproverName)、参与人类型(ApproverType)必传,手机号(ApproverMobile)和证件信息(ApproverIdCardType、ApproverIdCardNumber)可任选一种或全部传入。\n<ul>\n<li>若为个人参与方:ApproverType:\"PERSON\"</li>\n<li>若为企业参与方:ApproverType:\"ORGANIZATION\"。同时若签署方为saas企业员工, OrganizationName 参数需传入参与方企业名称。若签署方为渠道子客企业员工,除了 OrganizationName 还需要传 OpenId、OrganizationOpenId。(如果OrganizationOpenId对应子客企业已经认证激活,则可以省略OrganizationName参数)</li>\n</ul>\n\n注:\n`1. 暂不支持签署人拖动签署控件功能,以及签批控件。`\n`2. 当需要通过短信验证码签署时,手机号ApproverMobile需要与发起合同时填写的用户手机号一致。`",
|
1802
1802
|
"example": "无",
|
1803
1803
|
"member": "FlowApproverInfo",
|
1804
1804
|
"name": "FlowApproverInfo",
|
@@ -3068,7 +3068,7 @@
|
|
3068
3068
|
},
|
3069
3069
|
{
|
3070
3070
|
"disabled": false,
|
3071
|
-
"document": "流程签署人列表,其中结构体的ApproverType必传。\n若为个人签署方或saas企业签署方,则Name,Mobile必传。OrganizationName 传对应企业名称。\n若为子客企业签署方则需传OpenId、OrganizationOpenId,
|
3071
|
+
"document": "流程签署人列表,其中结构体的ApproverType必传。\n若为个人签署方或saas企业签署方,则Name,Mobile必传。OrganizationName 传对应企业名称。\n若为子客企业签署方则需传OpenId、OrganizationOpenId、OrganizationName, 其他可不传。(如果对应OrganizationOpenId 子客已经认证激活了,则可以省去OrganizationName)\n\n此结构体和发起接口参与方结构体复用,除了上述参数外,可传递的参数有:\n1. RecipientId: 发起合同会返回,可以直接用于指定需要生成链接的签署方。\n2. ApproverSignTypes: 指定签署方签署时候的认证方式,仅此链接生效。\n3. SignTypeSelector: 可以指定签署方签署合同的认证校验方式的选择模式。\n4. Intention: 指定H5签署视频核身的意图配置,仅视频签署需要使用。\n\n注:\n`1. 签署人只能有手写签名、时间类型、印章类型、签批类型的签署控件和内容填写控件,其他类型的签署控件暂时未支持。`\n`2. 生成发起方预览链接时,该字段(FlowApproverInfos)传空或者不传`",
|
3072
3072
|
"example": "无",
|
3073
3073
|
"member": "FlowApproverInfo",
|
3074
3074
|
"name": "FlowApproverInfos",
|
@@ -3737,8 +3737,8 @@
|
|
3737
3737
|
},
|
3738
3738
|
{
|
3739
3739
|
"disabled": false,
|
3740
|
-
"document": "
|
3741
|
-
"example": "
|
3740
|
+
"document": "该字段已不再使用",
|
3741
|
+
"example": "该字段已不再使用",
|
3742
3742
|
"member": "bool",
|
3743
3743
|
"name": "EnableAutoSign",
|
3744
3744
|
"required": false,
|
@@ -7656,6 +7656,15 @@
|
|
7656
7656
|
"name": "SignComponentConfig",
|
7657
7657
|
"required": false,
|
7658
7658
|
"type": "object"
|
7659
|
+
},
|
7660
|
+
{
|
7661
|
+
"disabled": false,
|
7662
|
+
"document": "是否禁止编辑(展示)水印控件属性\n<ul><li>(默认) false -否</li> <li> true - 禁止编辑</li></ul>",
|
7663
|
+
"example": "true",
|
7664
|
+
"member": "bool",
|
7665
|
+
"name": "ForbidEditWatermark",
|
7666
|
+
"required": false,
|
7667
|
+
"type": "bool"
|
7659
7668
|
}
|
7660
7669
|
],
|
7661
7670
|
"usage": "in"
|
@@ -9712,6 +9721,15 @@
|
|
9712
9721
|
"name": "SkipUploadFile",
|
9713
9722
|
"required": false,
|
9714
9723
|
"type": "string"
|
9724
|
+
},
|
9725
|
+
{
|
9726
|
+
"disabled": false,
|
9727
|
+
"document": "是否禁止编辑(展示)水印控件属性\n<ul><li>(默认) false -否</li> <li> true - 禁止编辑</li></ul>",
|
9728
|
+
"example": "true",
|
9729
|
+
"member": "bool",
|
9730
|
+
"name": "ForbidEditWatermark",
|
9731
|
+
"required": false,
|
9732
|
+
"type": "bool"
|
9715
9733
|
}
|
9716
9734
|
],
|
9717
9735
|
"usage": "in"
|
@@ -481,7 +481,7 @@
|
|
481
481
|
"ChannelCreatePrepareFlowGroup": [
|
482
482
|
{
|
483
483
|
"document": "",
|
484
|
-
"input": "POST / HTTP/1.1\nHost: essbasic.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: ChannelCreatePrepareFlowGroup\n<公共请求参数>\n\n{\n \"Agent\": {\n \"AppId\": \"yDwFoUUckpsomwx1UyhWGhIR2RkhOjw2\",\n \"ProxyOrganizationOpenId\": \"kevinlcheng_open_organization_1\",\n \"ProxyOperator\": {\n \"OpenId\": \"kevinlcheng_1\"\n }\n },\n \"FlowGroupName\": \"group\",\n \"ResourceType\": 2,\n \"BaseFlowInfos\": [\n {\n \"FlowName\": \"第三方预发起合同\",\n \"FlowType\": \"第三方嵌入式文件发起合同\",\n \"FileIds\": [\n \"yDCWiUUckpv6iggyUyuqIrwyppQVS7TR\"\n ],\n \"FlowDescription\": \"
|
484
|
+
"input": "POST / HTTP/1.1\nHost: essbasic.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: ChannelCreatePrepareFlowGroup\n<公共请求参数>\n\n{\n \"Agent\": {\n \"AppId\": \"yDwFoUUckpsomwx1UyhWGhIR2RkhOjw2\",\n \"ProxyOrganizationOpenId\": \"kevinlcheng_open_organization_1\",\n \"ProxyOperator\": {\n \"OpenId\": \"kevinlcheng_1\"\n }\n },\n \"FlowGroupName\": \"group\",\n \"ResourceType\": 2,\n \"BaseFlowInfos\": [\n {\n \"FlowName\": \"第三方预发起合同\",\n \"FlowType\": \"第三方嵌入式文件发起合同\",\n \"FileIds\": [\n \"yDCWiUUckpv6iggyUyuqIrwyppQVS7TR\"\n ],\n \"FlowDescription\": \"这是2025年购买食物的合同\",\n \"Deadline\": 1757034793,\n \"Unordered\": false,\n \"IntelligentStatus\": \"CLOSE\",\n \"FormFields\": [],\n \"NeedCreateReview\": false,\n \"NeedSignReview\": false,\n \"UserData\": \"\",\n \"CcInfos\": [],\n \"Approvers\": [\n {\n \"ApproverType\": 1,\n \"OrganizationName\": \"\",\n \"NotChannelOrganization\": false,\n \"ApproverName\": \"典子签\",\n \"ApproverOption\": {\n \"CanEditApprover\": true\n },\n \"IsFullText\": true,\n \"ApproverMobile\": \"18700000000\",\n \"SignComponents\": [\n {\n \"ChannelComponentId\": \"\",\n \"ComponentDateFontSize\": 0,\n \"ComponentDescription\": \"\",\n \"ComponentExtra\": \"\",\n \"ComponentHeight\": 100,\n \"ComponentId\": \"\",\n \"ComponentName\": \"\",\n \"ComponentPage\": 3,\n \"ComponentPosX\": 160,\n \"ComponentPosY\": 360,\n \"ComponentRecipientId\": \"\",\n \"ComponentRequired\": false,\n \"ComponentType\": \"SIGN_SIGNATURE\",\n \"ComponentValue\": \"\",\n \"ComponentWidth\": 100,\n \"DocumentId\": \"\",\n \"FileIndex\": 0,\n \"ForbidMoveAndDelete\": true,\n \"GenerateMode\": \"\",\n \"KeywordIndexes\": [],\n \"KeywordOrder\": \"\",\n \"KeywordPage\": 0,\n \"LockComponentValue\": false,\n \"OffsetX\": 0,\n \"OffsetY\": 0,\n \"Placeholder\": \"\",\n \"RelativeLocation\": \"\"\n }\n ]\n }\n ]\n }\n ]\n}",
|
485
485
|
"output": "{\n \"Response\": {\n \"FlowGroupId\": \"yDttAUUckpxbcz9uUySqdD58t8bwneLp\",\n \"PrepareUrl\": \"https://embed.test.qian.tencent.cn/contract-create?embed=1&expiredOn=1747036582&code=yDttAUUckpxbcz9vUySqdD5u3jnsKVT6&businessId=yDttAUUckpxbcz9uUySqdD58t8bwneLp&channel=PROXYCHANNEL&operateSource=byFileGroup&themeId=channel_web_theme_yDSLbUUckpo3e14eUEK7ajSyPX7g3kIc\",\n \"RequestId\": \"s1747036282702037847\"\n }\n}",
|
486
486
|
"title": "嵌入式文件发起合同组"
|
487
487
|
}
|