tccli 3.0.1227.1__py2.py3-none-any.whl → 3.0.1229.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 (66) hide show
  1. tccli/__init__.py +1 -1
  2. tccli/services/__init__.py +3 -0
  3. tccli/services/aiart/v20221229/api.json +12 -3
  4. tccli/services/cam/v20190116/api.json +25 -25
  5. tccli/services/cam/v20190116/examples.json +8 -8
  6. tccli/services/cdb/v20170320/api.json +167 -9
  7. tccli/services/cdb/v20170320/examples.json +2 -2
  8. tccli/services/cfs/v20190719/api.json +19 -0
  9. tccli/services/ckafka/v20190819/api.json +5 -5
  10. tccli/services/ckafka/v20190819/examples.json +106 -112
  11. tccli/services/clb/v20180317/api.json +1 -1
  12. tccli/services/cloudaudit/v20190319/api.json +15 -15
  13. tccli/services/cloudaudit/v20190319/examples.json +3 -3
  14. tccli/services/config/v20220802/api.json +70 -68
  15. tccli/services/config/v20220802/examples.json +6 -6
  16. tccli/services/cynosdb/cynosdb_client.py +228 -16
  17. tccli/services/cynosdb/v20190107/api.json +251 -0
  18. tccli/services/cynosdb/v20190107/examples.json +32 -0
  19. tccli/services/emr/v20190103/api.json +28 -22
  20. tccli/services/ess/v20201111/api.json +18 -0
  21. tccli/services/essbasic/v20210526/api.json +20 -1
  22. tccli/services/facefusion/v20181201/api.json +12 -6
  23. tccli/services/faceid/v20180301/api.json +1 -1
  24. tccli/services/hai/v20230812/api.json +6 -6
  25. tccli/services/hai/v20230812/examples.json +2 -2
  26. tccli/services/lke/lke_client.py +394 -23
  27. tccli/services/lke/v20231130/api.json +737 -4
  28. tccli/services/lke/v20231130/examples.json +62 -0
  29. tccli/services/mps/v20190612/api.json +1 -1
  30. tccli/services/mqtt/mqtt_client.py +118 -12
  31. tccli/services/mqtt/v20240516/api.json +312 -33
  32. tccli/services/mqtt/v20240516/examples.json +23 -13
  33. tccli/services/ocr/v20181119/api.json +11 -2
  34. tccli/services/ocr/v20181119/examples.json +6 -6
  35. tccli/services/privatedns/v20201028/api.json +41 -13
  36. tccli/services/pts/v20210728/api.json +22 -12
  37. tccli/services/redis/v20180412/api.json +14 -14
  38. tccli/services/scf/v20180416/api.json +12 -0
  39. tccli/services/ssl/v20191205/api.json +246 -173
  40. tccli/services/ssl/v20191205/examples.json +69 -69
  41. tccli/services/sts/v20180813/api.json +17 -11
  42. tccli/services/sts/v20180813/examples.json +6 -6
  43. tccli/services/tcr/v20190924/api.json +17 -17
  44. tccli/services/tdmq/tdmq_client.py +4 -57
  45. tccli/services/tdmq/v20200217/api.json +119 -200
  46. tccli/services/tdmq/v20200217/examples.json +29 -49
  47. tccli/services/tmt/v20180321/api.json +1 -1
  48. tccli/services/tmt/v20180321/examples.json +2 -2
  49. tccli/services/trocket/v20230308/api.json +79 -79
  50. tccli/services/trocket/v20230308/examples.json +8 -8
  51. tccli/services/trtc/v20190722/api.json +1 -1
  52. tccli/services/vclm/v20240523/api.json +25 -15
  53. tccli/services/vclm/v20240523/examples.json +2 -2
  54. tccli/services/vcube/__init__.py +4 -0
  55. tccli/services/vcube/v20220410/api.json +4168 -0
  56. tccli/services/vcube/v20220410/examples.json +277 -0
  57. tccli/services/vcube/vcube_client.py +1956 -0
  58. tccli/services/vod/v20180717/api.json +38 -1
  59. tccli/services/vod/v20180717/examples.json +13 -1
  60. tccli/services/vpc/v20170312/api.json +195 -148
  61. tccli/services/vpc/v20170312/examples.json +5 -5
  62. {tccli-3.0.1227.1.dist-info → tccli-3.0.1229.1.dist-info}/METADATA +2 -2
  63. {tccli-3.0.1227.1.dist-info → tccli-3.0.1229.1.dist-info}/RECORD +66 -62
  64. {tccli-3.0.1227.1.dist-info → tccli-3.0.1229.1.dist-info}/WHEEL +0 -0
  65. {tccli-3.0.1227.1.dist-info → tccli-3.0.1229.1.dist-info}/entry_points.txt +0 -0
  66. {tccli-3.0.1227.1.dist-info → tccli-3.0.1229.1.dist-info}/license_files/LICENSE +0 -0
@@ -56,6 +56,13 @@
56
56
  "output": "CloseProxyResponse",
57
57
  "status": "online"
58
58
  },
59
+ "CloseProxyEndPoint": {
60
+ "document": "关闭数据库代理连接地址",
61
+ "input": "CloseProxyEndPointRequest",
62
+ "name": "关闭数据库代理连接地址",
63
+ "output": "CloseProxyEndPointResponse",
64
+ "status": "online"
65
+ },
59
66
  "CloseWan": {
60
67
  "document": "本接口(CloseWan)用于关闭外网。",
61
68
  "input": "CloseWanRequest",
@@ -364,6 +371,13 @@
364
371
  "output": "DescribeClusterPasswordComplexityResponse",
365
372
  "status": "online"
366
373
  },
374
+ "DescribeClusterTransparentEncryptInfo": {
375
+ "document": "查询集群透明加密信息",
376
+ "input": "DescribeClusterTransparentEncryptInfoRequest",
377
+ "name": "查询集群透明加密信息",
378
+ "output": "DescribeClusterTransparentEncryptInfoResponse",
379
+ "status": "online"
380
+ },
367
381
  "DescribeClusters": {
368
382
  "document": "本接口(DescribeClusters)用于查询集群列表。",
369
383
  "input": "DescribeClustersRequest",
@@ -434,6 +448,13 @@
434
448
  "output": "DescribeInstancesResponse",
435
449
  "status": "online"
436
450
  },
451
+ "DescribeInstancesWithinSameCluster": {
452
+ "document": "本接口(DescribeInstancesWithinSameCluster)用于查询同一集群下实例列表",
453
+ "input": "DescribeInstancesWithinSameClusterRequest",
454
+ "name": "查询同一集群下实例列表",
455
+ "output": "DescribeInstancesWithinSameClusterResponse",
456
+ "status": "online"
457
+ },
437
458
  "DescribeIsolatedInstances": {
438
459
  "document": "本接口(DescribeIsolatedInstances)用于查询回收站实例列表。",
439
460
  "input": "DescribeIsolatedInstancesRequest",
@@ -861,6 +882,13 @@
861
882
  "output": "OpenClusterReadOnlyInstanceGroupAccessResponse",
862
883
  "status": "online"
863
884
  },
885
+ "OpenClusterTransparentEncrypt": {
886
+ "document": "开通集群透明加密",
887
+ "input": "OpenClusterTransparentEncryptRequest",
888
+ "name": "开通集群透明加密",
889
+ "output": "OpenClusterTransparentEncryptResponse",
890
+ "status": "online"
891
+ },
864
892
  "OpenReadOnlyInstanceExclusiveAccess": {
865
893
  "document": "本接口(OpenReadOnlyInstanceExclusiveAccess)用于开通只读实例独有访问接入组。",
866
894
  "input": "OpenReadOnlyInstanceExclusiveAccessRequest",
@@ -3142,6 +3170,62 @@
3142
3170
  ],
3143
3171
  "type": "object"
3144
3172
  },
3173
+ "CloseProxyEndPointRequest": {
3174
+ "document": "CloseProxyEndPoint请求参数结构体",
3175
+ "members": [
3176
+ {
3177
+ "disabled": false,
3178
+ "document": "集群ID",
3179
+ "example": "cynosdbmysql-xxxxxxx",
3180
+ "member": "string",
3181
+ "name": "ClusterId",
3182
+ "required": true,
3183
+ "type": "string"
3184
+ },
3185
+ {
3186
+ "disabled": false,
3187
+ "document": "数据库代理组ID",
3188
+ "example": "无",
3189
+ "member": "string",
3190
+ "name": "ProxyGroupId",
3191
+ "required": true,
3192
+ "type": "string"
3193
+ }
3194
+ ],
3195
+ "type": "object"
3196
+ },
3197
+ "CloseProxyEndPointResponse": {
3198
+ "document": "CloseProxyEndPoint返回参数结构体",
3199
+ "members": [
3200
+ {
3201
+ "disabled": false,
3202
+ "document": "异步流程ID",
3203
+ "example": "无",
3204
+ "member": "int64",
3205
+ "name": "FlowId",
3206
+ "output_required": true,
3207
+ "type": "int",
3208
+ "value_allowed_null": false
3209
+ },
3210
+ {
3211
+ "disabled": false,
3212
+ "document": "异步任务ID",
3213
+ "example": "无",
3214
+ "member": "int64",
3215
+ "name": "TaskId",
3216
+ "output_required": true,
3217
+ "type": "int",
3218
+ "value_allowed_null": false
3219
+ },
3220
+ {
3221
+ "document": "唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。",
3222
+ "member": "string",
3223
+ "name": "RequestId",
3224
+ "type": "string"
3225
+ }
3226
+ ],
3227
+ "type": "object"
3228
+ },
3145
3229
  "CloseProxyRequest": {
3146
3230
  "document": "CloseProxy请求参数结构体",
3147
3231
  "members": [
@@ -9792,6 +9876,53 @@
9792
9876
  ],
9793
9877
  "type": "object"
9794
9878
  },
9879
+ "DescribeClusterTransparentEncryptInfoRequest": {
9880
+ "document": "DescribeClusterTransparentEncryptInfo请求参数结构体",
9881
+ "members": [
9882
+ {
9883
+ "disabled": false,
9884
+ "document": "集群id",
9885
+ "example": "cynosdbmysql-6oo0qjvo",
9886
+ "member": "string",
9887
+ "name": "ClusterId",
9888
+ "required": true,
9889
+ "type": "string"
9890
+ }
9891
+ ],
9892
+ "type": "object"
9893
+ },
9894
+ "DescribeClusterTransparentEncryptInfoResponse": {
9895
+ "document": "DescribeClusterTransparentEncryptInfo返回参数结构体",
9896
+ "members": [
9897
+ {
9898
+ "disabled": false,
9899
+ "document": "加密秘钥id",
9900
+ "example": "无",
9901
+ "member": "string",
9902
+ "name": "KeyId",
9903
+ "output_required": false,
9904
+ "type": "string",
9905
+ "value_allowed_null": false
9906
+ },
9907
+ {
9908
+ "disabled": false,
9909
+ "document": "加密秘钥地域\n",
9910
+ "example": "无",
9911
+ "member": "string",
9912
+ "name": "KeyRegion",
9913
+ "output_required": false,
9914
+ "type": "string",
9915
+ "value_allowed_null": false
9916
+ },
9917
+ {
9918
+ "document": "唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。",
9919
+ "member": "string",
9920
+ "name": "RequestId",
9921
+ "type": "string"
9922
+ }
9923
+ ],
9924
+ "type": "object"
9925
+ },
9795
9926
  "DescribeClustersRequest": {
9796
9927
  "document": "DescribeClusters请求参数结构体",
9797
9928
  "members": [
@@ -10536,6 +10667,62 @@
10536
10667
  ],
10537
10668
  "type": "object"
10538
10669
  },
10670
+ "DescribeInstancesWithinSameClusterRequest": {
10671
+ "document": "DescribeInstancesWithinSameCluster请求参数结构体",
10672
+ "members": [
10673
+ {
10674
+ "disabled": false,
10675
+ "document": "vpcId",
10676
+ "example": "xx",
10677
+ "member": "string",
10678
+ "name": "UniqVpcId",
10679
+ "required": true,
10680
+ "type": "string"
10681
+ },
10682
+ {
10683
+ "disabled": false,
10684
+ "document": "vip",
10685
+ "example": "xx",
10686
+ "member": "string",
10687
+ "name": "Vip",
10688
+ "required": true,
10689
+ "type": "string"
10690
+ }
10691
+ ],
10692
+ "type": "object"
10693
+ },
10694
+ "DescribeInstancesWithinSameClusterResponse": {
10695
+ "document": "DescribeInstancesWithinSameCluster返回参数结构体",
10696
+ "members": [
10697
+ {
10698
+ "disabled": false,
10699
+ "document": "实例个数",
10700
+ "example": "26",
10701
+ "member": "int64",
10702
+ "name": "TotalCount",
10703
+ "output_required": true,
10704
+ "type": "int",
10705
+ "value_allowed_null": false
10706
+ },
10707
+ {
10708
+ "disabled": false,
10709
+ "document": "实例ID列表",
10710
+ "example": "无",
10711
+ "member": "string",
10712
+ "name": "InstanceIds",
10713
+ "output_required": true,
10714
+ "type": "list",
10715
+ "value_allowed_null": false
10716
+ },
10717
+ {
10718
+ "document": "唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。",
10719
+ "member": "string",
10720
+ "name": "RequestId",
10721
+ "type": "string"
10722
+ }
10723
+ ],
10724
+ "type": "object"
10725
+ },
10539
10726
  "DescribeIsolatedInstancesRequest": {
10540
10727
  "document": "DescribeIsolatedInstances请求参数结构体",
10541
10728
  "members": [
@@ -16489,6 +16676,70 @@
16489
16676
  ],
16490
16677
  "type": "object"
16491
16678
  },
16679
+ "OpenClusterTransparentEncryptRequest": {
16680
+ "document": "OpenClusterTransparentEncrypt请求参数结构体",
16681
+ "members": [
16682
+ {
16683
+ "disabled": false,
16684
+ "document": "集群id",
16685
+ "example": "cynosdbmysql-6oo0qjvo",
16686
+ "member": "string",
16687
+ "name": "ClusterId",
16688
+ "required": true,
16689
+ "type": "string"
16690
+ },
16691
+ {
16692
+ "disabled": false,
16693
+ "document": "秘钥类型(cloud,custom)",
16694
+ "example": "cloud",
16695
+ "member": "string",
16696
+ "name": "KeyType",
16697
+ "required": true,
16698
+ "type": "string"
16699
+ },
16700
+ {
16701
+ "disabled": false,
16702
+ "document": "秘钥Id",
16703
+ "example": "9d112608-76f7-11ee-a86f-525400368ae8",
16704
+ "member": "string",
16705
+ "name": "KeyId",
16706
+ "required": false,
16707
+ "type": "string"
16708
+ },
16709
+ {
16710
+ "disabled": false,
16711
+ "document": "秘钥地域",
16712
+ "example": "ap-guangzhou",
16713
+ "member": "string",
16714
+ "name": "KeyRegion",
16715
+ "required": false,
16716
+ "type": "string"
16717
+ }
16718
+ ],
16719
+ "type": "object"
16720
+ },
16721
+ "OpenClusterTransparentEncryptResponse": {
16722
+ "document": "OpenClusterTransparentEncrypt返回参数结构体",
16723
+ "members": [
16724
+ {
16725
+ "disabled": false,
16726
+ "document": "异步任务id\n",
16727
+ "example": "12345",
16728
+ "member": "int64",
16729
+ "name": "TaskId",
16730
+ "output_required": false,
16731
+ "type": "int",
16732
+ "value_allowed_null": false
16733
+ },
16734
+ {
16735
+ "document": "唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。",
16736
+ "member": "string",
16737
+ "name": "RequestId",
16738
+ "type": "string"
16739
+ }
16740
+ ],
16741
+ "type": "object"
16742
+ },
16492
16743
  "OpenReadOnlyInstanceExclusiveAccessRequest": {
16493
16744
  "document": "OpenReadOnlyInstanceExclusiveAccess请求参数结构体",
16494
16745
  "members": [
@@ -64,6 +64,14 @@
64
64
  "title": "关闭数据库代理"
65
65
  }
66
66
  ],
67
+ "CloseProxyEndPoint": [
68
+ {
69
+ "document": "",
70
+ "input": "POST / HTTP/1.1\nHost: cynosdb.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: CloseProxyEndPoint\n<公共请求参数>\n\n{\n \"ClusterId\": \"abc\",\n \"ProxyGroupId\": \"abc\"\n}",
71
+ "output": "{\n \"Response\": {\n \"FlowId\": 0,\n \"TaskId\": 0,\n \"RequestId\": \"abc\"\n }\n}",
72
+ "title": "关闭数据库代理连接地址"
73
+ }
74
+ ],
67
75
  "CloseWan": [
68
76
  {
69
77
  "document": "",
@@ -434,6 +442,14 @@
434
442
  "title": "查看集群密码复杂度详情"
435
443
  }
436
444
  ],
445
+ "DescribeClusterTransparentEncryptInfo": [
446
+ {
447
+ "document": "",
448
+ "input": "POST / HTTP/1.1\nHost: cynosdb.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: DescribeClusterTransparentEncryptInfo\n<公共请求参数>\n\n{\n \"ClusterId\": \"cynosdbmysql-3pd4zrvn\"\n}",
449
+ "output": "{\n \"Response\": {\n \"KeyId\": \"9d112608-76f7-11ee-a86f-525400368ae8\",\n \"KeyRegion\": \"ap-guangzhou\",\n \"RequestId\": \"c66ada1a-0098-4787-8db8-42be0cee52cd\"\n }\n}",
450
+ "title": "查询集群加密信息"
451
+ }
452
+ ],
437
453
  "DescribeClusters": [
438
454
  {
439
455
  "document": "查询集群列表",
@@ -514,6 +530,14 @@
514
530
  "title": "查询实例列表"
515
531
  }
516
532
  ],
533
+ "DescribeInstancesWithinSameCluster": [
534
+ {
535
+ "document": "查询统一集群下实例ID列表",
536
+ "input": "POST / HTTP/1.1\nHost: cynosdb.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: DescribeInstancesWithinSameCluster\n<公共请求参数>\n\n{\n \"UniqVpcId\": \"abc\",\n \"Vip\": \"abc\"\n}",
537
+ "output": "{\n \"Response\": {\n \"TotalCount\": 0,\n \"InstanceIds\": [\n \"abc\"\n ],\n \"RequestId\": \"abc\"\n }\n}",
538
+ "title": "查询统一集群下实例ID列表"
539
+ }
540
+ ],
517
541
  "DescribeIsolatedInstances": [
518
542
  {
519
543
  "document": "",
@@ -1008,6 +1032,14 @@
1008
1032
  "title": "ex:"
1009
1033
  }
1010
1034
  ],
1035
+ "OpenClusterTransparentEncrypt": [
1036
+ {
1037
+ "document": "",
1038
+ "input": "POST / HTTP/1.1\nHost: cynosdb.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: OpenClusterTransparentEncrypt\n<公共请求参数>\n\n{\n \"ClusterId\": \"cynosdbmysql-3pd4zrvn\",\n \"KeyType\": \"cloud\"\n}",
1039
+ "output": "{\n \"Response\": {\n \"RequestId\": \"c66ada1a-0098-4787-8db8-42be0cee52cd\",\n \"TaskId\": 283\n }\n}",
1040
+ "title": "使用云产品开启透明加密"
1041
+ }
1042
+ ],
1011
1043
  "OpenReadOnlyInstanceExclusiveAccess": [
1012
1044
  {
1013
1045
  "document": "任何场景",
@@ -1673,7 +1673,7 @@
1673
1673
  {
1674
1674
  "disabled": false,
1675
1675
  "document": "集群错误状态告警信息\n注意:此字段可能返回 null,表示取不到有效值。",
1676
- "example": "",
1676
+ "example": "--",
1677
1677
  "member": "string",
1678
1678
  "name": "AlarmInfo",
1679
1679
  "output_required": true,
@@ -1693,7 +1693,7 @@
1693
1693
  {
1694
1694
  "disabled": false,
1695
1695
  "document": "元数据库信息\n注意:此字段可能返回 null,表示取不到有效值。",
1696
- "example": "",
1696
+ "example": "cdb-lvz9h3us",
1697
1697
  "member": "string",
1698
1698
  "name": "MetaDb",
1699
1699
  "output_required": true,
@@ -1713,7 +1713,7 @@
1713
1713
  {
1714
1714
  "disabled": false,
1715
1715
  "document": "Hive元数据信息\n注意:此字段可能返回 null,表示取不到有效值。",
1716
- "example": "",
1716
+ "example": "cdb-8mq5jdt1",
1717
1717
  "member": "string",
1718
1718
  "name": "HiveMetaDb",
1719
1719
  "output_required": true,
@@ -1733,7 +1733,7 @@
1733
1733
  {
1734
1734
  "disabled": false,
1735
1735
  "document": "集群所有节点的别名序列化\n注意:此字段可能返回 null,表示取不到有效值。",
1736
- "example": "",
1736
+ "example": "\"eyJjNrIn0=\"",
1737
1737
  "member": "string",
1738
1738
  "name": "AliasInfo",
1739
1739
  "output_required": true,
@@ -1833,7 +1833,7 @@
1833
1833
  {
1834
1834
  "disabled": false,
1835
1835
  "document": "集群vpcid 字符串类型\n注意:此字段可能返回 null,表示取不到有效值。",
1836
- "example": "",
1836
+ "example": "vpc-34o0gwhj",
1837
1837
  "member": "string",
1838
1838
  "name": "UniqVpcId",
1839
1839
  "output_required": true,
@@ -1843,7 +1843,7 @@
1843
1843
  {
1844
1844
  "disabled": false,
1845
1845
  "document": "子网id 字符串类型\n注意:此字段可能返回 null,表示取不到有效值。",
1846
- "example": "",
1846
+ "example": "subnet-1laxlsao",
1847
1847
  "member": "string",
1848
1848
  "name": "UniqSubnetId",
1849
1849
  "output_required": true,
@@ -1899,6 +1899,16 @@
1899
1899
  "output_required": false,
1900
1900
  "type": "object",
1901
1901
  "value_allowed_null": true
1902
+ },
1903
+ {
1904
+ "disabled": false,
1905
+ "document": "集群绑定的文件系统数\n注意:此字段可能返回 null,表示取不到有效值。",
1906
+ "example": "1",
1907
+ "member": "int64",
1908
+ "name": "BindFileSystemNum",
1909
+ "output_required": false,
1910
+ "type": "int",
1911
+ "value_allowed_null": true
1902
1912
  }
1903
1913
  ],
1904
1914
  "usage": "out"
@@ -7307,18 +7317,7 @@
7307
7317
  "member": "string",
7308
7318
  "name": "ShareType",
7309
7319
  "required": true,
7310
- "type": "string",
7311
- "value_allowed_null": false
7312
- },
7313
- {
7314
- "disabled": false,
7315
- "document": "自定义参数集合",
7316
- "example": "无",
7317
- "member": "CustomServiceDefine",
7318
- "name": "CustomServiceDefineList",
7319
- "required": true,
7320
- "type": "list",
7321
- "value_allowed_null": false
7320
+ "type": "string"
7322
7321
  },
7323
7322
  {
7324
7323
  "disabled": false,
@@ -7327,8 +7326,7 @@
7327
7326
  "member": "string",
7328
7327
  "name": "Service",
7329
7328
  "required": true,
7330
- "type": "string",
7331
- "value_allowed_null": false
7329
+ "type": "string"
7332
7330
  },
7333
7331
  {
7334
7332
  "disabled": false,
@@ -7337,8 +7335,16 @@
7337
7335
  "member": "string",
7338
7336
  "name": "InstanceId",
7339
7337
  "required": true,
7340
- "type": "string",
7341
- "value_allowed_null": false
7338
+ "type": "string"
7339
+ },
7340
+ {
7341
+ "disabled": false,
7342
+ "document": "自定义参数集合",
7343
+ "example": "无",
7344
+ "member": "CustomServiceDefine",
7345
+ "name": "CustomServiceDefineList",
7346
+ "required": true,
7347
+ "type": "list"
7342
7348
  }
7343
7349
  ],
7344
7350
  "usage": "in"
@@ -967,6 +967,15 @@
967
967
  "name": "Components",
968
968
  "required": false,
969
969
  "type": "list"
970
+ },
971
+ {
972
+ "disabled": false,
973
+ "document": "进入签署流程的限制,目前支持以下选项:\n<ul><li> <b>空值(默认)</b> :无限制,可在任何场景进入签署流程。</li><li> <b>link</b> :选择此选项后,将无法通过控制台或电子签小程序列表进入填写或签署操作,仅可预览合同。填写或签署流程只能通过短信或发起方提供的专用链接进行。</li></ul>",
974
+ "example": "[\"link\"]",
975
+ "member": "string",
976
+ "name": "SignEndpoints",
977
+ "required": false,
978
+ "type": "list"
970
979
  }
971
980
  ],
972
981
  "usage": "in"
@@ -11286,6 +11295,15 @@
11286
11295
  "name": "Intention",
11287
11296
  "required": false,
11288
11297
  "type": "object"
11298
+ },
11299
+ {
11300
+ "disabled": false,
11301
+ "document": "进入签署流程的限制,目前支持以下选项:\n<ul><li> <b>空值(默认)</b> :无限制,可在任何场景进入签署流程。</li><li> <b>link</b> :选择此选项后,将无法通过控制台或电子签小程序列表进入填写或签署操作,仅可预览合同。填写或签署流程只能通过短信或发起方提供的专用链接进行。</li></ul>",
11302
+ "example": "[\"link\"]",
11303
+ "member": "string",
11304
+ "name": "SignEndpoints",
11305
+ "required": false,
11306
+ "type": "list"
11289
11307
  }
11290
11308
  ],
11291
11309
  "usage": "in"
@@ -7516,7 +7516,7 @@
7516
7516
  },
7517
7517
  {
7518
7518
  "disabled": false,
7519
- "document": "签署链接类型,可以设置的参数如下\n<ul><li> **WEIXINAPP** :(默认)跳转电子签小程序的http_url, 短信通知或者H5跳转适合此类型 ,此时返回短链</li>\n<li> **CHANNEL** :带有H5引导页的跳转电子签小程序的链接</li>\n<li> **APP** :第三方App或小程序跳转电子签小程序的path, App或者小程序跳转适合此类型</li>\n<li> **LONGURL2WEIXINAPP** :跳转电子签小程序的链接, H5跳转适合此类型,此时返回长链</li></ul>\n\n**注:**动态签署人场景,如果签署链接类型设置为`APP`,则仅支持跳转到封面页。\n\n详细使用场景可以参考接口描述说明中的 **主要使用场景EndPoint分类**\n",
7519
+ "document": "签署链接类型,可以设置的参数如下\n<ul><li> **WEIXINAPP** :(默认)跳转电子签小程序的http_url, 短信通知或者H5跳转适合此类型 ,此时返回短链</li>\n<li> **CHANNEL** :带有H5引导页的跳转电子签小程序的链接(<b>GenerateType非ALL时候不能设置成CHANNEL</b>)</li>\n<li> **APP** :第三方App或小程序跳转电子签小程序的path, App或者小程序跳转适合此类型</li>\n<li> **LONGURL2WEIXINAPP** :跳转电子签小程序的链接, H5跳转适合此类型,此时返回长链</li></ul>\n\n**注:**动态签署人场景,如果签署链接类型设置为`APP`,则仅支持跳转到封面页。\n\n详细使用场景可以参考接口描述说明中的 **主要使用场景EndPoint分类**\n",
7520
7520
  "example": "”WEIXINAPP“",
7521
7521
  "member": "string",
7522
7522
  "name": "Endpoint",
@@ -9205,6 +9205,16 @@
9205
9205
  "output_required": false,
9206
9206
  "type": "string",
9207
9207
  "value_allowed_null": true
9208
+ },
9209
+ {
9210
+ "disabled": false,
9211
+ "document": "签署参与人在本流程中的编号ID(每个流程不同),可用此ID来定位签署参与人在本流程的签署节点。\n注意:此字段可能返回 null,表示取不到有效值。",
9212
+ "example": "yDRS4UUg********sCOsHS",
9213
+ "member": "string",
9214
+ "name": "SignId",
9215
+ "output_required": false,
9216
+ "type": "string",
9217
+ "value_allowed_null": true
9208
9218
  }
9209
9219
  ],
9210
9220
  "usage": "out"
@@ -9454,6 +9464,15 @@
9454
9464
  "name": "Intention",
9455
9465
  "required": false,
9456
9466
  "type": "object"
9467
+ },
9468
+ {
9469
+ "disabled": false,
9470
+ "document": "进入签署流程的限制,目前支持以下选项:\n<ul><li> <b>空值(默认)</b> :无限制,可在任何场景进入签署流程。</li><li> <b>link</b> :选择此选项后,将无法通过控制台或电子签小程序列表进入填写或签署操作,仅可预览合同。填写或签署流程只能通过短信或发起方提供的专用链接进行。</li></ul>",
9471
+ "example": "[\"link\"]",
9472
+ "member": "string",
9473
+ "name": "SignEndpoints",
9474
+ "required": false,
9475
+ "type": "list"
9457
9476
  }
9458
9477
  ],
9459
9478
  "usage": "in"
@@ -223,6 +223,7 @@
223
223
  "member": "int64",
224
224
  "name": "X",
225
225
  "output_required": true,
226
+ "required": false,
226
227
  "type": "int",
227
228
  "value_allowed_null": false
228
229
  },
@@ -233,6 +234,7 @@
233
234
  "member": "int64",
234
235
  "name": "Y",
235
236
  "output_required": true,
237
+ "required": false,
236
238
  "type": "int",
237
239
  "value_allowed_null": false
238
240
  },
@@ -243,6 +245,7 @@
243
245
  "member": "int64",
244
246
  "name": "Width",
245
247
  "output_required": true,
248
+ "required": false,
246
249
  "type": "int",
247
250
  "value_allowed_null": false
248
251
  },
@@ -253,11 +256,12 @@
253
256
  "member": "int64",
254
257
  "name": "Height",
255
258
  "output_required": true,
259
+ "required": false,
256
260
  "type": "int",
257
261
  "value_allowed_null": false
258
262
  }
259
263
  ],
260
- "usage": "out"
264
+ "usage": "both"
261
265
  },
262
266
  "FaceRect": {
263
267
  "document": "人脸框信息",
@@ -559,25 +563,27 @@
559
563
  {
560
564
  "disabled": false,
561
565
  "document": "人脸序号",
562
- "example": "",
566
+ "example": "",
563
567
  "member": "string",
564
568
  "name": "FaceId",
565
- "required": true,
569
+ "output_required": true,
570
+ "required": false,
566
571
  "type": "string",
567
572
  "value_allowed_null": false
568
573
  },
569
574
  {
570
575
  "disabled": false,
571
576
  "document": "人脸框信息",
572
- "example": "",
577
+ "example": "",
573
578
  "member": "FaceInfo",
574
579
  "name": "FaceInfo",
575
- "required": true,
580
+ "output_required": true,
581
+ "required": false,
576
582
  "type": "object",
577
583
  "value_allowed_null": false
578
584
  }
579
585
  ],
580
- "usage": "out"
586
+ "usage": "both"
581
587
  },
582
588
  "MergeInfo": {
583
589
  "document": "人脸图片和待被融合的素材模板图的人脸位置信息。",
@@ -1117,7 +1117,7 @@
1117
1117
  {
1118
1118
  "disabled": false,
1119
1119
  "document": "传入的类型。\n- 取值范围:\n1:传入的是图片类型。\n2:传入的是视频类型。\n其他:返回错误码InvalidParameter。",
1120
- "example": "true",
1120
+ "example": "1",
1121
1121
  "member": "int64",
1122
1122
  "name": "FaceInputType",
1123
1123
  "required": false,