tccli 3.0.1160.1__py2.py3-none-any.whl → 3.0.1162.1__py2.py3-none-any.whl

Sign up to get free protection for your applications and to get access to all the features.
@@ -8,6 +8,22 @@
8
8
  "title": "集群创建示例"
9
9
  }
10
10
  ],
11
+ "CreateWorkloadGroup": [
12
+ {
13
+ "document": "",
14
+ "input": "POST / HTTP/1.1\nHost: cdwdoris.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: CreateWorkloadGroup\n<公共请求参数>\n\n{\n \"InstanceId\": \"cdwdoris-xxx\",\n \"WorkloadGroup\": {\n \"WorkloadGroupName\": \"test\",\n \"CpuShare\": 10,\n \"MemoryLimit\": 20,\n \"EnableMemoryOverCommit\": true\n }\n}",
15
+ "output": "{\n \"Response\": {\n \"RequestId\": \"abc\"\n }\n}",
16
+ "title": "创建资源组"
17
+ }
18
+ ],
19
+ "DeleteWorkloadGroup": [
20
+ {
21
+ "document": "",
22
+ "input": "POST / HTTP/1.1\nHost: cdwdoris.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: DeleteWorkloadGroup\n<公共请求参数>\n\n{\n \"InstanceId\": \"cdwdoris-xxx\",\n \"WorkloadGroupName\": \"test\"\n}",
23
+ "output": "{\n \"Response\": {\n \"RequestId\": \"abc\"\n }\n}",
24
+ "title": "删除资源组"
25
+ }
26
+ ],
11
27
  "DescribeClusterConfigs": [
12
28
  {
13
29
  "document": "在xml方式下修改配置文件内容时,获取集群配置文件内容",
@@ -32,6 +48,22 @@
32
48
  "title": "DescribeDatabaseAuditRecords"
33
49
  }
34
50
  ],
51
+ "DescribeFederationToken": [
52
+ {
53
+ "document": "",
54
+ "input": "POST / HTTP/1.1\nHost: cdwdoris.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: DescribeFederationToken\n<公共请求参数>\n\n{}",
55
+ "output": "{\n \"Response\": {\n \"RequestId\": \"abc\"\n }\n}",
56
+ "title": "获取联合临时密钥"
57
+ }
58
+ ],
59
+ "DescribeGoodsDetail": [
60
+ {
61
+ "document": "生成计费相关接口的GoodsDetail结构",
62
+ "input": "https://cdwdoris.tencentcloudapi.com/\n?Action=DescribeGoodsDetail\n&Zone=ap-chongqing-1\n&HaFlag=true\n&UserVPCId=vpc-xxx\n&UserSubnetId=subnet-xxxx\n&ProductVersion=20.7.2.30\n&Case=CREATE\n&ChargeProperties.ChargeType=\"PREPAID\"\n&ChargeProperties.RenewFlag=1\n&ChargeProperties.TimeSpan=1\n&ChargeProperties.TimeUnit=m\n&<公共请求参数>",
63
+ "output": "{\n \"Response\": {\n \"Type\": \"sp_cdwch_standard\",\n \"GoodsCategoryId\": 1,\n \"GoodsDetail\": \"{\\\"context\\\":{\\\"AppID\\\":1258469122,\\\"AutoRenewFlag\\\":0,\\\"Case\\\":\\\"CREATE\\\",\\\"Channel\\\":0,\\\"ChargeProperties\\\":{\\\"ChargeType\\\":\\\"PREPAID\\\",\\\"RenewFlag\\\":1,\\\"TimeSpan\\\":1,\\\"TimeUnit\\\":\\\"m\\\"},\\\"Components\\\":[\\\"clickhouse-20.7.2.30\\\",\\\"zookeeper-3.4.9\\\"],\\\"DealName\\\":\\\"\\\",\\\"EMRInstanceID\\\":\\\"\\\",\\\"EMRInstanceNo\\\":0,\\\"ExpiredTime\\\":\\\"\\\",\\\"HAInstance\\\":true,\\\"ImageID\\\":\\\"\\\",\\\"InstanceName\\\":\\\"\\\",\\\"InstanceType\\\":\\\"\\\",\\\"ModifyConfigItems\\\":null,\\\"OperateUin\\\":\\\"\\\",\\\"Password\\\":\\\"\\\",\\\"ProductID\\\":0,\\\"Region\\\":\\\"ap-guangzhou\\\",\\\"RenewPeriod\\\":0,\\\"ResourceAppID\\\":0,\\\"ResourceOperateUin\\\":\\\"\\\",\\\"ResourceUin\\\":\\\"\\\",\\\"Resources\\\":[{\\\"Count\\\":2,\\\"DiskSpec\\\":{\\\"DiskCount\\\":0,\\\"DiskSize\\\":0,\\\"DiskType\\\":\\\"\\\"},\\\"SpecName\\\":\\\"CVM.S2\\\",\\\"Type\\\":\\\"DATA\\\"},{\\\"Count\\\":1,\\\"DiskSpec\\\":{\\\"DiskCount\\\":0,\\\"DiskSize\\\":0,\\\"DiskType\\\":\\\"\\\"},\\\"SpecName\\\":\\\"CVM.S2\\\",\\\"Type\\\":\\\"COMMON\\\"}],\\\"SecurityGroupID\\\":\\\"\\\",\\\"ServiceName\\\":\\\"ClickHouse\\\",\\\"StackID\\\":\\\"\\\",\\\"Tags\\\":{\\\"ResourceType\\\":\\\"\\\",\\\"Tags\\\":null},\\\"TimeSpan\\\":1,\\\"TimeUnit\\\":\\\"m\\\",\\\"Topology\\\":\\\"\\\",\\\"TraceID\\\":\\\"trace-vudbhcyqe15awen3\\\",\\\"Uin\\\":\\\"100010640219\\\",\\\"UserSubnetID\\\":\\\"subnet-xx111\\\",\\\"UserVPCID\\\":\\\"vpc-xxx\\\",\\\"VIPType\\\":0,\\\"Version\\\":\\\"20.7.2.30\\\",\\\"Zone\\\":\\\"ap-guangzhou-4\\\",\\\"instanceId\\\":\\\"cdwch-bbi1k4he\\\",\\\"modifySpec\\\":null},\\\"curDeadline\\\":\\\"\\\",\\\"goodsNum\\\":1,\\\"pid\\\":123,\\\"productCode\\\":\\\"p_cdwch\\\",\\\"productInfo\\\":{\\\"可用区\\\":\\\"ap-guangzhou-4\\\",\\\"地域\\\":\\\"ap-guangzhou\\\",\\\"集群\\\":\\\"cdwch-bbi1k4he\\\"},\\\"sa2_cpu2_mem4\\\":\\\"3\\\",\\\"subProductCode\\\":\\\"p_sub_iaas\\\",\\\"timeSpan\\\":1,\\\"timeUnit\\\":\\\"m\\\"}\",\n \"GoodsNum\": 1,\n \"PayMode\": 1,\n \"RegionId\": 1,\n \"ZoneId\": 100004,\n \"ResourceId\": \"cdwch-bbi1k4he\",\n \"RequestId\": \"xxx-xxx-xxx-xxx\"\n }\n}",
64
+ "title": "生成GoodsDetail"
65
+ }
66
+ ],
35
67
  "DescribeInstance": [
36
68
  {
37
69
  "document": "根据集群ID查询某个集群的具体信息",
@@ -70,6 +102,14 @@
70
102
  "title": "获取集群状态"
71
103
  }
72
104
  ],
105
+ "DescribeInstanceUsedSubnets": [
106
+ {
107
+ "document": "",
108
+ "input": "POST / HTTP/1.1\nHost: cdwdoris.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: DescribeInstanceUsedSubnets\n<公共请求参数>\n\n{\n \"InstanceId\": \"abc\"\n}",
109
+ "output": "{\n \"Response\": {\n \"VpcId\": \"abc\",\n \"UsedSubnets\": [\n \"abc\"\n ],\n \"RequestId\": \"abc\"\n }\n}",
110
+ "title": "获取集群已使用子网信息"
111
+ }
112
+ ],
73
113
  "DescribeInstances": [
74
114
  {
75
115
  "document": "获取某个用户下所有的集群列表信息",
@@ -78,6 +118,30 @@
78
118
  "title": "获取实例列表"
79
119
  }
80
120
  ],
121
+ "DescribeRegionZone": [
122
+ {
123
+ "document": "购买页获取地域及可用区列表、内核版本、网络规则等",
124
+ "input": "POST / HTTP/1.1\nHost: cdwdoris.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: DescribeRegionZone\n<公共请求参数>\n\n{}",
125
+ "output": "{\n \"Response\": {\n \"Items\": [\n {\n \"Name\": \"abc\",\n \"Desc\": \"abc\",\n \"Regions\": [\n {\n \"Name\": \"abc\",\n \"Desc\": \"abc\",\n \"RegionId\": 0,\n \"Zones\": [\n {\n \"Name\": \"abc\",\n \"Desc\": \"abc\",\n \"ZoneId\": 0,\n \"Encrypt\": 0\n }\n ],\n \"Count\": 0,\n \"IsInternationalSite\": 1,\n \"Bucket\": \"abc\"\n }\n ]\n }\n ],\n \"Versions\": [\n \"abc\"\n ],\n \"VpcRule\": \"abc\",\n \"RequestId\": \"abc\"\n }\n}",
126
+ "title": "购买页获取地域及可用区列表"
127
+ }
128
+ ],
129
+ "DescribeReplicaVersion": [
130
+ {
131
+ "document": "",
132
+ "input": "POST / HTTP/1.1\nHost: cdwdoris.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: DescribeReplicaVersion\n<公共请求参数>\n\n{\n \"InstanceId\": \"xx\"\n}",
133
+ "output": "{\n \"Response\": {\n \"ReplicaFlagItem\": {\n \"ReplicaFlag\": 0,\n \"ErrorMsg\": \"xx\"\n },\n \"RequestId\": \"xx\"\n }\n}",
134
+ "title": "DescribeReplicaVersion"
135
+ }
136
+ ],
137
+ "DescribeRestoreTaskDetail": [
138
+ {
139
+ "document": "",
140
+ "input": "POST / HTTP/1.1\nHost: cdwdoris.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: DescribeRestoreTaskDetail\n<公共请求参数>\n\n{\n \"InstanceId\": \"xx\",\n \"BackUpJobId\": 0\n}",
141
+ "output": "{\n \"Response\": {\n \"RestoreStatus\": [\n {\n \"Status\": \"xx\",\n \"FinishedTime\": \"xx\",\n \"MetaPreparedTime\": \"xx\",\n \"RestoreObjects\": \"xx\",\n \"Timestamp\": \"xx\",\n \"ReplicaAllocation\": \"xx\",\n \"TaskErrMsg\": \"xx\",\n \"JobId\": 0,\n \"CreateTime\": \"xx\",\n \"State\": \"xx\",\n \"SnapshotFinishedTime\": \"xx\",\n \"Timeout\": 0,\n \"DownloadFinishedTime\": \"xx\",\n \"UnfinishedTasks\": \"xx\",\n \"Progress\": \"xx\",\n \"Label\": \"xx\",\n \"ReplicationNum\": \"xx\",\n \"DbName\": \"xx\",\n \"AllowLoad\": true\n }\n ],\n \"RequestId\": \"xx\",\n \"ErrorMsg\": \"xx\"\n }\n}",
142
+ "title": "示例"
143
+ }
144
+ ],
81
145
  "DescribeSlowQueryRecords": [
82
146
  {
83
147
  "document": "慢查询",
@@ -94,6 +158,30 @@
94
158
  "title": "DescribeSlowQueryRecordsDownload"
95
159
  }
96
160
  ],
161
+ "DescribeSqlApis": [
162
+ {
163
+ "document": "查询ck集群信息",
164
+ "input": "POST / HTTP/1.1\nHost: cdwdoris.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: DescribeSqlApis\n<公共请求参数>\n\n{}",
165
+ "output": "{\n \"Response\": {\n \"RequestId\": \"abc\"\n }\n}",
166
+ "title": "查询ck集群信息"
167
+ }
168
+ ],
169
+ "DescribeUserBindWorkloadGroup": [
170
+ {
171
+ "document": "",
172
+ "input": "POST / HTTP/1.1\nHost: cdwdoris.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: DescribeUserBindWorkloadGroup\n<公共请求参数>\n\n{\n \"InstanceId\": \"cdwdoris-xxx\"\n}",
173
+ "output": "{\n \"Response\": {\n \"RequestId\": \"abc\",\n \"UserBindInfos\": [\n {\n \"UserName\": \"test\",\n \"WorkloadGroupName\": \"g1\"\n },\n {\n \"UserName\": \"admin\",\n \"WorkloadGroupName\": \"normal\"\n }\n ]\n }\n}",
174
+ "title": "获取当前集群各用户绑定的资源信息"
175
+ }
176
+ ],
177
+ "DescribeWorkloadGroup": [
178
+ {
179
+ "document": "",
180
+ "input": "POST / HTTP/1.1\nHost: cdwdoris.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: DescribeWorkloadGroup\n<公共请求参数>\n\n{\n \"InstanceId\": \"abc\"\n}",
181
+ "output": "{\n \"Response\": {\n \"WorkloadGroups\": [\n {\n \"WorkloadGroupName\": \"abc\",\n \"CpuShare\": 10,\n \"MemoryLimit\": 10,\n \"EnableMemoryOverCommit\": true\n }\n ],\n \"Status\": \"abc\",\n \"ErrorMsg\": \"abc\",\n \"RequestId\": \"abc\"\n }\n}",
182
+ "title": "获取资源组信息"
183
+ }
184
+ ],
97
185
  "DestroyInstance": [
98
186
  {
99
187
  "document": "",
@@ -102,6 +190,14 @@
102
190
  "title": "集群销毁示例"
103
191
  }
104
192
  ],
193
+ "FitClsLog": [
194
+ {
195
+ "document": "在集群配置页面修改集群接口",
196
+ "input": "https://cdwdoris.tencentcloudapi.com/\n?Action=FitClsLog\n&InstanceId=cdwch-xxxx\n&ClsLogSetId=xxxx\n&<公共请求参数>",
197
+ "output": "{\n \"Response\": {\n \"RequestId\": \"xxx-xxx\",\n \"FlowId\": 0,\n \"ErrorMsg\": \"\"\n }\n}",
198
+ "title": "修改集群配置接口"
199
+ }
200
+ ],
105
201
  "ModifyInstance": [
106
202
  {
107
203
  "document": "用户修改实例名称",
@@ -110,6 +206,62 @@
110
206
  "title": "修改实例信息"
111
207
  }
112
208
  ],
209
+ "ModifyInstanceKeyValConfigs": [
210
+ {
211
+ "document": "",
212
+ "input": "POST / HTTP/1.1\nHost: cdwdoris.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: ModifyInstanceKeyValConfigs\n<公共请求参数>\n\n{\n \"InstanceId\": \"123\",\n \"DelItems\": [\n {\n \"ConfKey\": \"123\",\n \"ConfValue\": \"123\"\n }\n ],\n \"FileName\": \"123\",\n \"UpdateItems\": [\n {\n \"ConfKey\": \"123\",\n \"ConfValue\": \"123\"\n }\n ],\n \"Message\": \"123\",\n \"AddItems\": [\n {\n \"ConfKey\": \"123\",\n \"ConfValue\": \"123\"\n }\n ]\n}",
213
+ "output": "{\n \"Response\": {\n \"ErrorMsg\": \"123\",\n \"RequestId\": \"123\",\n \"FlowId\": 0\n }\n}",
214
+ "title": "示例"
215
+ }
216
+ ],
217
+ "ModifySecurityGroups": [
218
+ {
219
+ "document": "",
220
+ "input": "POST / HTTP/1.1\nHost: cdwdoris.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: ModifySecurityGroups\n<公共请求参数>\n\n{\n \"InstanceId\": \"abc\",\n \"OldSecurityGroupIds\": [\n \"abc\"\n ],\n \"ModifySecurityGroupIds\": [\n \"abc\"\n ]\n}",
221
+ "output": "{\n \"Response\": {\n \"ErrorMsg\": \"abc\",\n \"RequestId\": \"abc\"\n }\n}",
222
+ "title": "更改安全组"
223
+ }
224
+ ],
225
+ "ModifyUserBindWorkloadGroup": [
226
+ {
227
+ "document": "",
228
+ "input": "POST / HTTP/1.1\nHost: cdwdoris.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: ModifyUserBindWorkloadGroup\n<公共请求参数>\n\n{\n \"InstanceId\": \"abc\",\n \"BindUsers\": [\n {\n \"UserName\": \"test\",\n \"Host\": \"%\"\n },\n {\n \"UserName\": \"test\",\n \"Host\": \"127.0.0.1\"\n }\n ],\n \"OldWorkloadGroupName\": \"abc\",\n \"NewWorkloadGroupName\": \"abc1\"\n}",
229
+ "output": "{\n \"Response\": {\n \"ErrorMsg\": \"abc\",\n \"RequestId\": \"abc\"\n }\n}",
230
+ "title": "修改用户绑定的资源组"
231
+ }
232
+ ],
233
+ "ModifyUserPrivilegesV3": [
234
+ {
235
+ "document": "",
236
+ "input": "POST / HTTP/1.1\nHost: cdwdoris.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: ModifyUserPrivilegesV3\n<公共请求参数>\n\n{\n \"InstanceId\": \"cdwdoris-xx\",\n \"UserName\": \"test\",\n \"UserPrivileges\": {\n \"IsSetGlobalCatalog\": true\n }\n}",
237
+ "output": "{\n \"Response\": {\n \"ErrorMsg\": \"abc\",\n \"InstanceId\": \"abc\",\n \"RequestId\": \"abc\"\n }\n}",
238
+ "title": "设置全局catalog权限"
239
+ }
240
+ ],
241
+ "ModifyWorkloadGroup": [
242
+ {
243
+ "document": "",
244
+ "input": "POST / HTTP/1.1\nHost: cdwdoris.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: ModifyWorkloadGroup\n<公共请求参数>\n\n{\n \"InstanceId\": \"abc\",\n \"WorkloadGroup\": {\n \"WorkloadGroupName\": \"abc\",\n \"CpuShare\": 10,\n \"MemoryLimit\": 10,\n \"EnableMemoryOverCommit\": true\n }\n}",
245
+ "output": "{\n \"Response\": {\n \"ErrorMsg\": \"abc\",\n \"RequestId\": \"abc\"\n }\n}",
246
+ "title": "修改资源组信息"
247
+ }
248
+ ],
249
+ "ModifyWorkloadGroupStatus": [
250
+ {
251
+ "document": "",
252
+ "input": "POST / HTTP/1.1\nHost: cdwdoris.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: ModifyWorkloadGroupStatus\n<公共请求参数>\n\n{\n \"InstanceId\": \"abc\",\n \"OperationType\": \"open\"\n}",
253
+ "output": "{\n \"Response\": {\n \"ErrorMsg\": \"abc\",\n \"RequestId\": \"abc\"\n }\n}",
254
+ "title": "开启或关闭资源组"
255
+ }
256
+ ],
257
+ "ReduceInstance": [
258
+ {
259
+ "document": "",
260
+ "input": "POST / HTTP/1.1\nHost: cdwdoris.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: ReduceInstance\n<公共请求参数>\n\n{\n \"InstanceId\": \"cdwdoris-xqewrqx\",\n \"Type\": \"MASTER\",\n \"DelHosts\": [\n \"10.0.1.12\"\n ],\n \"HaType\": 1\n}",
261
+ "output": "{\n \"Response\": {\n \"FlowId\": \"1231\",\n \"InstanceId\": \"cdwdoris-xqewrqx\",\n \"ErrorMsg\": \"\",\n \"RequestId\": \"xasdfkqe2-a12q29-axdfas\"\n }\n}",
262
+ "title": "缩容API"
263
+ }
264
+ ],
113
265
  "ResizeDisk": [
114
266
  {
115
267
  "document": "",
@@ -5374,7 +5374,7 @@
5374
5374
  {
5375
5375
  "disabled": false,
5376
5376
  "document": "过滤内容",
5377
- "example": "",
5377
+ "example": "{}",
5378
5378
  "member": "Filter",
5379
5379
  "name": "Filter",
5380
5380
  "required": false,
@@ -5383,7 +5383,7 @@
5383
5383
  {
5384
5384
  "disabled": false,
5385
5385
  "document": "资产标签",
5386
- "example": "",
5386
+ "example": "[]",
5387
5387
  "member": "AssetTag",
5388
5388
  "name": "Tags",
5389
5389
  "required": false,
@@ -631,7 +631,7 @@
631
631
  "status": "online"
632
632
  },
633
633
  "DescribeTaskResult": {
634
- "document": "查询任务结果",
634
+ "document": "查询任务结果,仅支持30天以内的任务查询结果,且返回数据大小超过近50M会进行截断。",
635
635
  "input": "DescribeTaskResultRequest",
636
636
  "name": "查询任务结果(用于: SparkSQL、PrestoSQL、Spark作业任务)",
637
637
  "output": "DescribeTaskResultResponse",
@@ -9289,6 +9289,15 @@
9289
9289
  "name": "Offset",
9290
9290
  "required": false,
9291
9291
  "type": "int"
9292
+ },
9293
+ {
9294
+ "disabled": false,
9295
+ "document": "过滤类型,支持如下的过滤类型,传参Name应为以下其中一个, engine-generation - String(引擎时代: supersql:supersql引擎,native:标准引擎):notebook-keyword - String(数据引擎名称或sessionid或sessionname的模糊搜索)",
9296
+ "example": "无",
9297
+ "member": "Filter",
9298
+ "name": "Filters",
9299
+ "required": false,
9300
+ "type": "list"
9292
9301
  }
9293
9302
  ],
9294
9303
  "type": "object"
@@ -10515,7 +10524,7 @@
10515
10524
  "members": [
10516
10525
  {
10517
10526
  "disabled": false,
10518
- "document": "任务唯一ID",
10527
+ "document": "任务唯一ID,仅支持30天内的任务",
10519
10528
  "example": "fdd9c5fa21ca11eca6fb5254006c64af",
10520
10529
  "member": "string",
10521
10530
  "name": "TaskId",
@@ -10897,6 +10906,24 @@
10897
10906
  "name": "DataEngineConfigCommand",
10898
10907
  "required": true,
10899
10908
  "type": "string"
10909
+ },
10910
+ {
10911
+ "disabled": false,
10912
+ "document": "是否使用托管存储作为结果存储",
10913
+ "example": "false",
10914
+ "member": "bool",
10915
+ "name": "UseLakeFs",
10916
+ "required": false,
10917
+ "type": "bool"
10918
+ },
10919
+ {
10920
+ "disabled": false,
10921
+ "document": "用户自定义结果存储路径",
10922
+ "example": "cosn://test-bucket/dir",
10923
+ "member": "string",
10924
+ "name": "CustomResultPath",
10925
+ "required": false,
10926
+ "type": "string"
10900
10927
  }
10901
10928
  ],
10902
10929
  "type": "object"
@@ -10910,6 +10937,7 @@
10910
10937
  "example": "[xxx]",
10911
10938
  "member": "DataEngineBasicInfo",
10912
10939
  "name": "DataEngineBasicInfos",
10940
+ "output_required": true,
10913
10941
  "type": "list",
10914
10942
  "value_allowed_null": false
10915
10943
  },
@@ -10919,6 +10947,7 @@
10919
10947
  "example": "1",
10920
10948
  "member": "int64",
10921
10949
  "name": "TotalCount",
10950
+ "output_required": true,
10922
10951
  "type": "int",
10923
10952
  "value_allowed_null": false
10924
10953
  },
@@ -1856,7 +1856,7 @@
1856
1856
  "members": [
1857
1857
  {
1858
1858
  "disabled": false,
1859
- "document": "业务ID",
1859
+ "document": "业务ID,通过接口DescribeBiddingList返回结果中获取",
1860
1860
  "example": "P0011702977661022561",
1861
1861
  "member": "string",
1862
1862
  "name": "BusinessId",
@@ -99,7 +99,7 @@
99
99
  "status": "online"
100
100
  },
101
101
  "CreateFlowApprovers": {
102
- "document": "适用场景: 当通过模板或文件发起合同时,若未指定企业签署人信息,则可调用此接口补充或添加签署人。同一签署人可补充多个员工作为或签署人,最终实际签署人取决于谁先领取合同完成签署。\n\n限制条件:\n\n1.本企业(发起方企业)企业微信签署人仅支持通过企业微信UserId或姓名+手机号进行补充。\n2.本企业(发起方企业)非企业微信签署人仅支持通过姓名+手机号进行补充。\n3.他方企业仅支持通过姓名+手机号进行补充。\n4.个人签署人支持通过姓名+手机号进行补充,补充动态签署人时:若个人用户已完成实名,则可通过姓名+证件号码进行补充。",
102
+ "document": "**适用场景 :**\n\n当通过模板或文件发起合同时, 签署人不制定, 等合同发起后再指定 可以用下面2种方案\n\n<b><font color=\"red\">1. 或签合同</font>: 若未指定企业签署人信息(只指定企业的名字),合同变成或签合同(个人签署方不支持或签合同)</b>。需调用此接口补充或添加签署人。或签签署人在控制台上的展示样式如下(会带有<b>或签</b>标识):\n![image](https://qcloudimg.tencent-cloud.cn/raw/b2715f0236faee807cfc0521f93cf01b.png)\n<b><font color=\"red\">2. 动态签署人合同</font>: 若未指定具体签署人的信息,则合同变成动态签署人合同</b>。需调用此接口补充或添加签署人。可以参考文档 [动态签署人合同](https://qian.tencent.com/developers/company/dynamic_signer/) 。动态签署人在控制台上的展示样式如下:\n![image](https://qcloudimg.tencent-cloud.cn/raw/2729477978e020c3bbb4d2e767bb78eb.png)\n\n实际签署人需要通过[获取跳转至腾讯电子签小程序的签署链接](https://qian.tencent.com/developers/companyApis/startFlows/CreateSchemeUrl/)生成的链接进入小程序,领取合同并签署。同一签署环节可补充多个员工作为或签署人,最终实际签署人取决于谁先领取合同完成签署。\n\n\n**限制条件**:\n\n1.本企业(发起方企业)企业微信签署人仅支持通过企业微信UserId或姓名+手机号进行补充。\n\n2.本企业(发起方企业)非企业微信签署人仅支持通过姓名+手机号进行补充。\n\n3.他方企业仅支持通过姓名+手机号进行补充。\n\n4.个人签署人支持通过姓名+手机号进行补充(若<b>个人用户已完成实名</b>,动态签署人合同也可以可通过姓名+证件号码进行补充)\n\n\n**整体流程如下图:**\n\n![image](https://qcloudimg.tencent-cloud.cn/raw/29a0fba0ceebf9227849459947384862.png)",
103
103
  "input": "CreateFlowApproversRequest",
104
104
  "name": "补充签署流程签署人信息",
105
105
  "output": "CreateFlowApproversResponse",
@@ -2884,7 +2884,7 @@
2884
2884
  },
2885
2885
  {
2886
2886
  "disabled": false,
2887
- "document": "补充企业签署人信息。\n\n- 如果发起方指定的补充签署人是企业微信签署人(ApproverSource=WEWORKAPP),则需要提供企业微信UserId进行补充;\n\n- 如果不指定,则使用姓名和手机号进行补充。",
2887
+ "document": "补充签署环节签署候选人信息。\n\n注:` 如果发起方指定的补充签署人是企业微信签署人(ApproverSource=WEWORKAPP),则需要提供企业微信UserId进行补充; 如果不指定,则使用姓名和手机号进行补充。`",
2888
2888
  "example": "无",
2889
2889
  "member": "FillApproverInfo",
2890
2890
  "name": "Approvers",
@@ -2902,7 +2902,7 @@
2902
2902
  },
2903
2903
  {
2904
2904
  "disabled": false,
2905
- "document": "签署人信息补充方式\n\n<ul><li>**0**: 添加或签人候选人,或签支持一个节点传多个签署人,不传值默认或签。\n注: `或签只支持企业签署方`</li>\n<li>**1**: 表示往未指定签署人的节点,添加一个明确的签署人,支持企业或个人签署方。</li></ul>",
2905
+ "document": "签署人信息补充方式\n\n<ul><li>**0**: <font color=\"red\">或签合同</font>添加签署候选人,或签支持一个节点传多个签署人,不传值默认或签。\n注: `或签只支持企业签署方`</li>\n<li>**1**: <font color=\"red\">动态签署人合同</font>的添加签署候选人,支持企业或个人签署方。</li></ul>",
2906
2906
  "example": "无",
2907
2907
  "member": "int64",
2908
2908
  "name": "FillApproverType",
@@ -952,13 +952,22 @@
952
952
  "required": true,
953
953
  "type": "string"
954
954
  },
955
+ {
956
+ "disabled": false,
957
+ "document": "合同流程的签署截止时间,格式为Unix标准时间戳(秒),如果在签署截止时间前未完成签署,则合同状态会变为已过期,导致合同作废。",
958
+ "example": "1604912664",
959
+ "member": "int64",
960
+ "name": "Deadline",
961
+ "required": true,
962
+ "type": "int"
963
+ },
955
964
  {
956
965
  "disabled": false,
957
966
  "document": "合同流程的类别分类(可自定义名称,如销售合同/入职合同等),最大长度为200个字符,仅限中文、字母、数字和下划线组成。",
958
967
  "example": "销售合同",
959
968
  "member": "string",
960
969
  "name": "FlowType",
961
- "required": true,
970
+ "required": false,
962
971
  "type": "string"
963
972
  },
964
973
  {
@@ -967,18 +976,9 @@
967
976
  "example": "张三2023年的入职公司财务部的合同",
968
977
  "member": "string",
969
978
  "name": "FlowDescription",
970
- "required": true,
979
+ "required": false,
971
980
  "type": "string"
972
981
  },
973
- {
974
- "disabled": false,
975
- "document": "合同流程的签署截止时间,格式为Unix标准时间戳(秒),如果在签署截止时间前未完成签署,则合同状态会变为已过期,导致合同作废。",
976
- "example": "1604912664",
977
- "member": "int64",
978
- "name": "Deadline",
979
- "required": true,
980
- "type": "int"
981
- },
982
982
  {
983
983
  "disabled": false,
984
984
  "document": "合同流程的签署顺序类型:\n**false**:(默认)有序签署, 本合同多个参与人需要依次签署\n**true**:无序签署, 本合同多个参与人没有先后签署限制",
@@ -1988,7 +1988,7 @@
1988
1988
  },
1989
1989
  {
1990
1990
  "disabled": false,
1991
- "document": "有加密需求的用户,接入传入kms的CiphertextBlob,关于数据加密可查阅<a href=\"https://cloud.tencent.com/document/product/1007/47180\">数据加密</a> 文档。\n注意:此字段可能返回 null,表示取不到有效值。",
1991
+ "document": "加密后的对称密钥,关于密钥的生成和使用请查阅<a href=\"https://cloud.tencent.com/document/product/1007/47180\">数据加密</a> 文档。\n注意:此字段可能返回 null,表示取不到有效值。",
1992
1992
  "example": "null",
1993
1993
  "member": "string",
1994
1994
  "name": "CiphertextBlob",