tccli 3.0.1119.1__py2.py3-none-any.whl → 3.0.1121.1__py2.py3-none-any.whl
Sign up to get free protection for your applications and to get access to all the features.
- tccli/__init__.py +1 -1
- tccli/services/bi/v20220105/api.json +32 -0
- tccli/services/cdb/v20170320/api.json +5 -5
- tccli/services/cdb/v20170320/examples.json +1 -1
- tccli/services/cfw/v20190904/api.json +7 -7
- tccli/services/cfw/v20190904/examples.json +3 -3
- tccli/services/dasb/v20191018/api.json +68 -2
- tccli/services/dasb/v20191018/examples.json +3 -3
- tccli/services/dlc/v20210125/api.json +56 -0
- tccli/services/dlc/v20210125/examples.json +1 -1
- tccli/services/ess/v20201111/api.json +2 -2
- tccli/services/essbasic/v20210526/api.json +2 -2
- tccli/services/facefusion/v20220927/api.json +3 -6
- tccli/services/iotexplorer/v20190423/api.json +2 -2
- tccli/services/lke/v20231130/api.json +11 -11
- tccli/services/lke/v20231130/examples.json +1 -1
- tccli/services/monitor/v20180724/api.json +4 -3
- tccli/services/monitor/v20180724/examples.json +1 -1
- tccli/services/oceanus/v20190422/api.json +120 -19
- tccli/services/redis/v20180412/api.json +25 -25
- tccli/services/tcss/v20201101/api.json +38 -0
- tccli/services/trocket/trocket_client.py +53 -0
- tccli/services/trocket/v20230308/api.json +393 -0
- tccli/services/trocket/v20230308/examples.json +8 -0
- tccli/services/trtc/v20190722/api.json +74 -18
- tccli/services/waf/v20180125/api.json +706 -73
- tccli/services/waf/v20180125/examples.json +5 -5
- {tccli-3.0.1119.1.dist-info → tccli-3.0.1121.1.dist-info}/METADATA +2 -2
- {tccli-3.0.1119.1.dist-info → tccli-3.0.1121.1.dist-info}/RECORD +32 -32
- {tccli-3.0.1119.1.dist-info → tccli-3.0.1121.1.dist-info}/WHEEL +0 -0
- {tccli-3.0.1119.1.dist-info → tccli-3.0.1121.1.dist-info}/entry_points.txt +0 -0
- {tccli-3.0.1119.1.dist-info → tccli-3.0.1121.1.dist-info}/license_files/LICENSE +0 -0
tccli/__init__.py
CHANGED
@@ -1 +1 @@
|
|
1
|
-
__version__ = '3.0.
|
1
|
+
__version__ = '3.0.1121.1'
|
@@ -4518,6 +4518,28 @@
|
|
4518
4518
|
"required": false,
|
4519
4519
|
"type": "string",
|
4520
4520
|
"value_allowed_null": true
|
4521
|
+
},
|
4522
|
+
{
|
4523
|
+
"disabled": false,
|
4524
|
+
"document": "企微账号id\n注意:此字段可能返回 null,表示取不到有效值。",
|
4525
|
+
"example": "无",
|
4526
|
+
"member": "string",
|
4527
|
+
"name": "AppUserId",
|
4528
|
+
"output_required": false,
|
4529
|
+
"required": false,
|
4530
|
+
"type": "string",
|
4531
|
+
"value_allowed_null": true
|
4532
|
+
},
|
4533
|
+
{
|
4534
|
+
"disabled": false,
|
4535
|
+
"document": "企微账号名称\n注意:此字段可能返回 null,表示取不到有效值。",
|
4536
|
+
"example": "无",
|
4537
|
+
"member": "string",
|
4538
|
+
"name": "AppUserName",
|
4539
|
+
"output_required": false,
|
4540
|
+
"required": false,
|
4541
|
+
"type": "string",
|
4542
|
+
"value_allowed_null": true
|
4521
4543
|
}
|
4522
4544
|
],
|
4523
4545
|
"usage": "both"
|
@@ -4836,6 +4858,16 @@
|
|
4836
4858
|
"output_required": false,
|
4837
4859
|
"type": "bool",
|
4838
4860
|
"value_allowed_null": true
|
4861
|
+
},
|
4862
|
+
{
|
4863
|
+
"disabled": false,
|
4864
|
+
"document": "用户openid\n注意:此字段可能返回 null,表示取不到有效值。",
|
4865
|
+
"example": "无",
|
4866
|
+
"member": "string",
|
4867
|
+
"name": "AppOpenUserId",
|
4868
|
+
"output_required": false,
|
4869
|
+
"type": "string",
|
4870
|
+
"value_allowed_null": true
|
4839
4871
|
}
|
4840
4872
|
],
|
4841
4873
|
"usage": "out"
|
@@ -1162,7 +1162,7 @@
|
|
1162
1162
|
{
|
1163
1163
|
"disabled": false,
|
1164
1164
|
"document": "新账户的名称",
|
1165
|
-
"example": "",
|
1165
|
+
"example": "无",
|
1166
1166
|
"member": "string",
|
1167
1167
|
"name": "User",
|
1168
1168
|
"required": true,
|
@@ -1171,7 +1171,7 @@
|
|
1171
1171
|
{
|
1172
1172
|
"disabled": false,
|
1173
1173
|
"document": "新账户的域名",
|
1174
|
-
"example": "",
|
1174
|
+
"example": "无",
|
1175
1175
|
"member": "string",
|
1176
1176
|
"name": "Host",
|
1177
1177
|
"required": true,
|
@@ -4413,7 +4413,7 @@
|
|
4413
4413
|
"example": "256117ed-efa08b54-61784d44-91781bbd",
|
4414
4414
|
"member": "string",
|
4415
4415
|
"name": "AsyncRequestId",
|
4416
|
-
"
|
4416
|
+
"output_required": true,
|
4417
4417
|
"type": "string",
|
4418
4418
|
"value_allowed_null": false
|
4419
4419
|
},
|
@@ -5375,7 +5375,7 @@
|
|
5375
5375
|
"example": "be9f64a6-fa652dc6-f5c878b6-a6a50746",
|
5376
5376
|
"member": "string",
|
5377
5377
|
"name": "AsyncRequestId",
|
5378
|
-
"
|
5378
|
+
"output_required": true,
|
5379
5379
|
"type": "string",
|
5380
5380
|
"value_allowed_null": false
|
5381
5381
|
},
|
@@ -14355,7 +14355,7 @@
|
|
14355
14355
|
"example": "256117ed-efa08b54-61784d44-91781bbd",
|
14356
14356
|
"member": "string",
|
14357
14357
|
"name": "AsyncRequestId",
|
14358
|
-
"
|
14358
|
+
"output_required": true,
|
14359
14359
|
"type": "string",
|
14360
14360
|
"value_allowed_null": false
|
14361
14361
|
},
|
@@ -933,7 +933,7 @@
|
|
933
933
|
"ModifyAccountPassword": [
|
934
934
|
{
|
935
935
|
"document": "",
|
936
|
-
"input": "POST / HTTP/1.1\nHost: cdb.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: ModifyAccountPassword\n<公共请求参数>\n\n{\n \"InstanceId\": \"
|
936
|
+
"input": "POST / HTTP/1.1\nHost: cdb.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: ModifyAccountPassword\n<公共请求参数>\n\n{\n \"InstanceId\": \"cdb-xxxx\",\n \"NewPassword\": \"your_new_password\",\n \"Accounts\": [\n {\n \"Host\": \"%\",\n \"User\": \"user1\"\n }\n ]\n}",
|
937
937
|
"output": "{\n \"Response\": {\n \"RequestId\": \"6EF60BEC-0242-43AF-BB20-270359FB54A7\",\n \"AsyncRequestId\": \"256117ed-efa08b54-61784d44-91781bbd\"\n }\n}",
|
938
938
|
"title": "修改云数据库实例账号的密码"
|
939
939
|
}
|
@@ -5309,7 +5309,7 @@
|
|
5309
5309
|
"example": "1",
|
5310
5310
|
"member": "int64",
|
5311
5311
|
"name": "BasicRuleSwitch",
|
5312
|
-
"
|
5312
|
+
"output_required": true,
|
5313
5313
|
"type": "int",
|
5314
5314
|
"value_allowed_null": false
|
5315
5315
|
},
|
@@ -5319,7 +5319,7 @@
|
|
5319
5319
|
"example": "1",
|
5320
5320
|
"member": "int64",
|
5321
5321
|
"name": "BaselineAllSwitch",
|
5322
|
-
"
|
5322
|
+
"output_required": true,
|
5323
5323
|
"type": "int",
|
5324
5324
|
"value_allowed_null": false
|
5325
5325
|
},
|
@@ -5329,7 +5329,7 @@
|
|
5329
5329
|
"example": "1",
|
5330
5330
|
"member": "int64",
|
5331
5331
|
"name": "TiSwitch",
|
5332
|
-
"
|
5332
|
+
"output_required": true,
|
5333
5333
|
"type": "int",
|
5334
5334
|
"value_allowed_null": false
|
5335
5335
|
},
|
@@ -5339,7 +5339,7 @@
|
|
5339
5339
|
"example": "1",
|
5340
5340
|
"member": "int64",
|
5341
5341
|
"name": "VirtualPatchSwitch",
|
5342
|
-
"
|
5342
|
+
"output_required": true,
|
5343
5343
|
"type": "int",
|
5344
5344
|
"value_allowed_null": false
|
5345
5345
|
},
|
@@ -5349,7 +5349,7 @@
|
|
5349
5349
|
"example": "1",
|
5350
5350
|
"member": "int64",
|
5351
5351
|
"name": "HistoryOpen",
|
5352
|
-
"
|
5352
|
+
"output_required": true,
|
5353
5353
|
"type": "int",
|
5354
5354
|
"value_allowed_null": false
|
5355
5355
|
},
|
@@ -5359,7 +5359,7 @@
|
|
5359
5359
|
"example": "success",
|
5360
5360
|
"member": "int64",
|
5361
5361
|
"name": "ReturnCode",
|
5362
|
-
"
|
5362
|
+
"output_required": true,
|
5363
5363
|
"type": "int",
|
5364
5364
|
"value_allowed_null": false
|
5365
5365
|
},
|
@@ -5369,7 +5369,7 @@
|
|
5369
5369
|
"example": "success",
|
5370
5370
|
"member": "string",
|
5371
5371
|
"name": "ReturnMsg",
|
5372
|
-
"
|
5372
|
+
"output_required": true,
|
5373
5373
|
"type": "string",
|
5374
5374
|
"value_allowed_null": false
|
5375
5375
|
},
|
@@ -332,10 +332,10 @@
|
|
332
332
|
],
|
333
333
|
"DescribeDefenseSwitch": [
|
334
334
|
{
|
335
|
-
"document": "",
|
335
|
+
"document": "接口返回常见入侵防御开关接口",
|
336
336
|
"input": "POST / HTTP/1.1\nHost: cfw.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: DescribeDefenseSwitch\n<公共请求参数>\n\n{}",
|
337
|
-
"output": "{\n \"Response\": {\n \"
|
338
|
-
"title": "
|
337
|
+
"output": "{\n \"Response\": {\n \"BasicRuleSwitch\": 0,\n \"BaselineAllSwitch\": 0,\n \"TiSwitch\": 0,\n \"VirtualPatchSwitch\": 0,\n \"HistoryOpen\": 0,\n \"ReturnCode\": 0,\n \"ReturnMsg\": \"abc\",\n \"RequestId\": \"abc\"\n }\n}",
|
338
|
+
"title": "入侵防御开关相关"
|
339
339
|
}
|
340
340
|
],
|
341
341
|
"DescribeEnterpriseSGRuleProgress": [
|
@@ -1112,6 +1112,15 @@
|
|
1112
1112
|
"name": "ResourceId",
|
1113
1113
|
"required": true,
|
1114
1114
|
"type": "string"
|
1115
|
+
},
|
1116
|
+
{
|
1117
|
+
"disabled": false,
|
1118
|
+
"document": "网络域ID",
|
1119
|
+
"example": "net-xxxxxxxx",
|
1120
|
+
"member": "string",
|
1121
|
+
"name": "DomainId",
|
1122
|
+
"required": false,
|
1123
|
+
"type": "string"
|
1115
1124
|
}
|
1116
1125
|
],
|
1117
1126
|
"type": "object"
|
@@ -2829,6 +2838,7 @@
|
|
2829
2838
|
"member": "string",
|
2830
2839
|
"name": "Id",
|
2831
2840
|
"output_required": true,
|
2841
|
+
"required": false,
|
2832
2842
|
"type": "string",
|
2833
2843
|
"value_allowed_null": false
|
2834
2844
|
},
|
@@ -2839,6 +2849,7 @@
|
|
2839
2849
|
"member": "string",
|
2840
2850
|
"name": "Name",
|
2841
2851
|
"output_required": true,
|
2852
|
+
"required": false,
|
2842
2853
|
"type": "string",
|
2843
2854
|
"value_allowed_null": false
|
2844
2855
|
},
|
@@ -2849,6 +2860,7 @@
|
|
2849
2860
|
"member": "string",
|
2850
2861
|
"name": "Managers",
|
2851
2862
|
"output_required": true,
|
2863
|
+
"required": false,
|
2852
2864
|
"type": "list",
|
2853
2865
|
"value_allowed_null": true
|
2854
2866
|
},
|
@@ -2859,11 +2871,12 @@
|
|
2859
2871
|
"member": "DepartmentManagerUser",
|
2860
2872
|
"name": "ManagerUsers",
|
2861
2873
|
"output_required": false,
|
2874
|
+
"required": false,
|
2862
2875
|
"type": "list",
|
2863
2876
|
"value_allowed_null": true
|
2864
2877
|
}
|
2865
2878
|
],
|
2866
|
-
"usage": "
|
2879
|
+
"usage": "both"
|
2867
2880
|
},
|
2868
2881
|
"DepartmentManagerUser": {
|
2869
2882
|
"document": "部门管理员信息",
|
@@ -4656,6 +4669,26 @@
|
|
4656
4669
|
"output_required": false,
|
4657
4670
|
"type": "list",
|
4658
4671
|
"value_allowed_null": true
|
4672
|
+
},
|
4673
|
+
{
|
4674
|
+
"disabled": false,
|
4675
|
+
"document": "网络域Id\n注意:此字段可能返回 null,表示取不到有效值。",
|
4676
|
+
"example": "net-xxx",
|
4677
|
+
"member": "string",
|
4678
|
+
"name": "DomainId",
|
4679
|
+
"output_required": false,
|
4680
|
+
"type": "string",
|
4681
|
+
"value_allowed_null": true
|
4682
|
+
},
|
4683
|
+
{
|
4684
|
+
"disabled": false,
|
4685
|
+
"document": "网络域名称\n注意:此字段可能返回 null,表示取不到有效值。",
|
4686
|
+
"example": "网络 1",
|
4687
|
+
"member": "string",
|
4688
|
+
"name": "DomainName",
|
4689
|
+
"output_required": false,
|
4690
|
+
"type": "string",
|
4691
|
+
"value_allowed_null": true
|
4659
4692
|
}
|
4660
4693
|
],
|
4661
4694
|
"usage": "out"
|
@@ -4812,6 +4845,7 @@
|
|
4812
4845
|
"member": "uint64",
|
4813
4846
|
"name": "Id",
|
4814
4847
|
"output_required": true,
|
4848
|
+
"required": false,
|
4815
4849
|
"type": "int",
|
4816
4850
|
"value_allowed_null": false
|
4817
4851
|
},
|
@@ -4822,6 +4856,7 @@
|
|
4822
4856
|
"member": "string",
|
4823
4857
|
"name": "Name",
|
4824
4858
|
"output_required": true,
|
4859
|
+
"required": false,
|
4825
4860
|
"type": "string",
|
4826
4861
|
"value_allowed_null": false
|
4827
4862
|
},
|
@@ -4832,6 +4867,7 @@
|
|
4832
4867
|
"member": "Department",
|
4833
4868
|
"name": "Department",
|
4834
4869
|
"output_required": true,
|
4870
|
+
"required": false,
|
4835
4871
|
"type": "object",
|
4836
4872
|
"value_allowed_null": true
|
4837
4873
|
},
|
@@ -4842,11 +4878,12 @@
|
|
4842
4878
|
"member": "uint64",
|
4843
4879
|
"name": "Count",
|
4844
4880
|
"output_required": true,
|
4881
|
+
"required": false,
|
4845
4882
|
"type": "int",
|
4846
4883
|
"value_allowed_null": true
|
4847
4884
|
}
|
4848
4885
|
],
|
4849
|
-
"usage": "
|
4886
|
+
"usage": "both"
|
4850
4887
|
},
|
4851
4888
|
"ImportExternalDeviceRequest": {
|
4852
4889
|
"document": "ImportExternalDevice请求参数结构体",
|
@@ -5565,6 +5602,15 @@
|
|
5565
5602
|
"name": "DepartmentId",
|
5566
5603
|
"required": false,
|
5567
5604
|
"type": "string"
|
5605
|
+
},
|
5606
|
+
{
|
5607
|
+
"disabled": false,
|
5608
|
+
"document": "网络域Id",
|
5609
|
+
"example": "net-xxxxxxxx",
|
5610
|
+
"member": "string",
|
5611
|
+
"name": "DomainId",
|
5612
|
+
"required": false,
|
5613
|
+
"type": "string"
|
5568
5614
|
}
|
5569
5615
|
],
|
5570
5616
|
"type": "object"
|
@@ -6382,6 +6428,26 @@
|
|
6382
6428
|
"output_required": false,
|
6383
6429
|
"type": "list",
|
6384
6430
|
"value_allowed_null": true
|
6431
|
+
},
|
6432
|
+
{
|
6433
|
+
"disabled": false,
|
6434
|
+
"document": "网络域个数\n注意:此字段可能返回 null,表示取不到有效值。",
|
6435
|
+
"example": "0",
|
6436
|
+
"member": "int64",
|
6437
|
+
"name": "DomainCount",
|
6438
|
+
"output_required": false,
|
6439
|
+
"type": "int",
|
6440
|
+
"value_allowed_null": true
|
6441
|
+
},
|
6442
|
+
{
|
6443
|
+
"disabled": false,
|
6444
|
+
"document": "已使用网络域个数\n注意:此字段可能返回 null,表示取不到有效值。",
|
6445
|
+
"example": "1",
|
6446
|
+
"member": "uint64",
|
6447
|
+
"name": "UsedDomainCount",
|
6448
|
+
"output_required": false,
|
6449
|
+
"type": "int",
|
6450
|
+
"value_allowed_null": true
|
6385
6451
|
}
|
6386
6452
|
],
|
6387
6453
|
"usage": "out"
|
@@ -35,8 +35,8 @@
|
|
35
35
|
"BindDeviceResource": [
|
36
36
|
{
|
37
37
|
"document": "修改资产绑定的堡垒机服务",
|
38
|
-
"input": "POST / HTTP/1.1\nHost: dasb.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: BindDeviceResource\n<公共请求参数>\n\n{\n \"ResourceId\": \"
|
39
|
-
"output": "{\n \"Response\": {\n \"RequestId\": \"
|
38
|
+
"input": "POST / HTTP/1.1\nHost: dasb.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: BindDeviceResource\n<公共请求参数>\n\n{\n \"ResourceId\": \"bh-saas-fphjn2p3\",\n \"DeviceIdSet\": [\n 5186\n ],\n \"DomainId\": \"net-4sovwr11w7\"\n}",
|
39
|
+
"output": "{\n \"Response\": {\n \"RequestId\": \"sdfsadf-sdfasd-sdfsad-sdf2222\"\n }\n}",
|
40
40
|
"title": "修改资产绑定的堡垒机服务"
|
41
41
|
}
|
42
42
|
],
|
@@ -382,7 +382,7 @@
|
|
382
382
|
{
|
383
383
|
"document": "修改资产信息",
|
384
384
|
"input": "POST / HTTP/1.1\nHost: dasb.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: ModifyDevice\n<公共请求参数>\n\n{\n \"GroupIdSet\": [\n 1\n ],\n \"Id\": 1,\n \"Port\": 1\n}",
|
385
|
-
"output": "{\n \"Response\": {\n \"RequestId\": \"
|
385
|
+
"output": "{\n \"Response\": {\n \"RequestId\": \"2ba7270b-0596-4700-870a-2602aa0014f9\"\n }\n}",
|
386
386
|
"title": "修改资产信息"
|
387
387
|
}
|
388
388
|
],
|
@@ -8158,6 +8158,16 @@
|
|
8158
8158
|
"DescribeLakeFsInfoResponse": {
|
8159
8159
|
"document": "DescribeLakeFsInfo返回参数结构体",
|
8160
8160
|
"members": [
|
8161
|
+
{
|
8162
|
+
"disabled": false,
|
8163
|
+
"document": "托管存储信息\n注意:此字段可能返回 null,表示取不到有效值。",
|
8164
|
+
"example": "无",
|
8165
|
+
"member": "LakeFsInfo",
|
8166
|
+
"name": "LakeFsInfos",
|
8167
|
+
"output_required": true,
|
8168
|
+
"type": "list",
|
8169
|
+
"value_allowed_null": true
|
8170
|
+
},
|
8161
8171
|
{
|
8162
8172
|
"document": "唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。",
|
8163
8173
|
"member": "string",
|
@@ -11655,6 +11665,52 @@
|
|
11655
11665
|
],
|
11656
11666
|
"usage": "out"
|
11657
11667
|
},
|
11668
|
+
"LakeFsInfo": {
|
11669
|
+
"document": "描述DLC托管存储基本信息",
|
11670
|
+
"members": [
|
11671
|
+
{
|
11672
|
+
"disabled": false,
|
11673
|
+
"document": "托管存储名称",
|
11674
|
+
"example": "dlc_bkt",
|
11675
|
+
"member": "string",
|
11676
|
+
"name": "Name",
|
11677
|
+
"output_required": true,
|
11678
|
+
"type": "string",
|
11679
|
+
"value_allowed_null": false
|
11680
|
+
},
|
11681
|
+
{
|
11682
|
+
"disabled": false,
|
11683
|
+
"document": "托管存储类型",
|
11684
|
+
"example": "user_chdfs",
|
11685
|
+
"member": "string",
|
11686
|
+
"name": "Type",
|
11687
|
+
"output_required": true,
|
11688
|
+
"type": "string",
|
11689
|
+
"value_allowed_null": false
|
11690
|
+
},
|
11691
|
+
{
|
11692
|
+
"disabled": false,
|
11693
|
+
"document": "容量",
|
11694
|
+
"example": "1.0",
|
11695
|
+
"member": "float",
|
11696
|
+
"name": "SpaceUsedSize",
|
11697
|
+
"output_required": true,
|
11698
|
+
"type": "float",
|
11699
|
+
"value_allowed_null": false
|
11700
|
+
},
|
11701
|
+
{
|
11702
|
+
"disabled": false,
|
11703
|
+
"document": "创建时候的时间戳",
|
11704
|
+
"example": "1",
|
11705
|
+
"member": "int64",
|
11706
|
+
"name": "CreateTimeStamp",
|
11707
|
+
"output_required": true,
|
11708
|
+
"type": "int",
|
11709
|
+
"value_allowed_null": false
|
11710
|
+
}
|
11711
|
+
],
|
11712
|
+
"usage": "out"
|
11713
|
+
},
|
11658
11714
|
"ListTaskJobLogDetailRequest": {
|
11659
11715
|
"document": "ListTaskJobLogDetail请求参数结构体",
|
11660
11716
|
"members": [
|
@@ -500,7 +500,7 @@
|
|
500
500
|
{
|
501
501
|
"document": "",
|
502
502
|
"input": "POST / HTTP/1.1\nHost: dlc.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: DescribeLakeFsInfo\n<公共请求参数>\n\n{}",
|
503
|
-
"output": "{\n \"Response\": {\n \"RequestId\": \"
|
503
|
+
"output": "{\n \"Response\": {\n \"RequestId\": \"123-456\",\n \"LakeFsInfos\": [\n {\n \"Name\": \"my-bkt\",\n \"Type\": \"chdfs\",\n \"SpaceUsedSize\": \"1024\",\n \"CreateTimeStamp\": \"1\"\n }\n ]\n }\n}",
|
504
504
|
"title": "示例一"
|
505
505
|
}
|
506
506
|
],
|
@@ -99,7 +99,7 @@
|
|
99
99
|
"status": "online"
|
100
100
|
},
|
101
101
|
"CreateFlowByFiles": {
|
102
|
-
"document": "此接口(CreateFlowByFiles)用来通过上传后的pdf资源编号来创建待签署的合同流程。<br/>\n适用场景:适用非制式的合同文件签署。一般开发者自己有完整的签署文件,可以通过该接口传入完整的PDF文件及流程信息生成待签署的合同流程。<br/>\n\n<table>\n\t<thead>\n\t\t<tr>\n\t\t\t<th>签署人类别</th>\n\t\t\t<th>需要提前准备的信息</th>\n\t\t</tr>\n\t</thead>\n\t<tbody>\n\t\t<tr>\n\t\t\t<td>自己企业的员工签署(未认证加入或已认证加入)</td>\n\t\t\t<td>签署企业的名字、员工的真实名字、员工的触达手机号、员工的证件号(证件号非必传)</td>\n\t\t</tr>\n\t\t<tr>\n\t\t\t<td>自己企业的员工签署(已认证加入)</td>\n\t\t\t<td>签署企业的名字、员工在电子签平台的ID(UserId)</td>\n\t\t</tr>\n\t\t<tr>\n\t\t\t<td>其他企业的员工签署</td>\n\t\t\t<td>签署企业的名字、员工的真实名字、员工的触达手机号、员工的证件号(证件号非必传)</td>\n\t\t</tr>\n\t\t<tr>\n\t\t\t<td>个人(自然人)签署</td>\n\t\t\t<td>个人的真实名字、个人的触达手机号、个人的身份证(证件号非必传)</td>\n\t\t</tr>\n\t</tbody>\n</table>\n\n\n\n该接口需要依赖[上传文件](https://qian.tencent.com/developers/companyApis/templatesAndFiles/UploadFiles)接口生成pdf资源编号(FileIds)进行使用。(如果非pdf文件需要调用[创建文件转换任务](https://qian.tencent.com/developers/companyApis/templatesAndFiles/CreateConvertTaskApi)接口转换成pdf资源)<br/>\n\n\n![image](https://qcloudimg.tencent-cloud.cn/raw/f097a74b289e3e1acd740936bdfe9843.png)\n\n注:\n- 合同**发起后就会扣减合同的额度**, 只有撤销没有参与方签署过或只有自动签署签署过的合同,才会返还合同额度。(**过期,拒签,签署完成,解除完成等状态不会返还额度**)\n-
|
102
|
+
"document": "此接口(CreateFlowByFiles)用来通过上传后的pdf资源编号来创建待签署的合同流程。<br/>\n适用场景:适用非制式的合同文件签署。一般开发者自己有完整的签署文件,可以通过该接口传入完整的PDF文件及流程信息生成待签署的合同流程。<br/>\n\n<table>\n\t<thead>\n\t\t<tr>\n\t\t\t<th>签署人类别</th>\n\t\t\t<th>需要提前准备的信息</th>\n\t\t</tr>\n\t</thead>\n\t<tbody>\n\t\t<tr>\n\t\t\t<td>自己企业的员工签署(未认证加入或已认证加入)</td>\n\t\t\t<td>签署企业的名字、员工的真实名字、员工的触达手机号、员工的证件号(证件号非必传)</td>\n\t\t</tr>\n\t\t<tr>\n\t\t\t<td>自己企业的员工签署(已认证加入)</td>\n\t\t\t<td>签署企业的名字、员工在电子签平台的ID(UserId)</td>\n\t\t</tr>\n\t\t<tr>\n\t\t\t<td>其他企业的员工签署</td>\n\t\t\t<td>签署企业的名字、员工的真实名字、员工的触达手机号、员工的证件号(证件号非必传)</td>\n\t\t</tr>\n\t\t<tr>\n\t\t\t<td>个人(自然人)签署</td>\n\t\t\t<td>个人的真实名字、个人的触达手机号、个人的身份证(证件号非必传)</td>\n\t\t</tr>\n\t</tbody>\n</table>\n\n\n\n该接口需要依赖[上传文件](https://qian.tencent.com/developers/companyApis/templatesAndFiles/UploadFiles)接口生成pdf资源编号(FileIds)进行使用。(如果非pdf文件需要调用[创建文件转换任务](https://qian.tencent.com/developers/companyApis/templatesAndFiles/CreateConvertTaskApi)接口转换成pdf资源)<br/>\n\n\n![image](https://qcloudimg.tencent-cloud.cn/raw/f097a74b289e3e1acd740936bdfe9843.png)\n\n注:\n- 合同**发起后就会扣减合同的额度**, 只有撤销没有参与方签署过或只有自动签署签署过的合同,才会返还合同额度。(**过期,拒签,签署完成,解除完成等状态不会返还额度**)\n- **静默(自动)签署不支持合同签署方存在填写**功能\n\n\n<font color=\"red\">相关视频指引</font> <br>\n1. <a href=\"https://dyn.ess.tencent.cn/guide/apivideo/ess_uploadfiles.mp4\" target=\"_blank\">上传用于合同发起的PDF文件代码编写示例</a><br>\n2. <a href=\"https://dyn.ess.tencent.cn/guide/apivideo/ess-CreateFlowByFiles.mp4\" target=\"_blank\">用PDF文件创建签署流程编写示例</a><br>",
|
103
103
|
"input": "CreateFlowByFilesRequest",
|
104
104
|
"name": "用PDF文件创建签署流程",
|
105
105
|
"output": "CreateFlowByFilesResponse",
|
@@ -568,7 +568,7 @@
|
|
568
568
|
"status": "online"
|
569
569
|
},
|
570
570
|
"UploadFiles": {
|
571
|
-
"document": "此接口(UploadFiles)文件上传。<br/>\n\n适用场景:用于合同,印章的文件上传。文件上传以后,\n如果是PDF格式文件可配合<a href=\"https://qian.tencent.com/developers/companyApis/startFlows/CreateFlowByFiles\" target=\"_blank\">用PDF文件创建签署流程</a>接口进行合同流程的发起\n如果是其他类型可以配合<a href=\"https://qian.tencent.com/developers/companyApis/templatesAndFiles/CreateConvertTaskApi\" target=\"_blank\">创建文件转换任务</a>接口转换成PDF文件\n\n注: \n1. 图片类型(png/jpg/jpeg)限制大小为5M以下, PDF/word/excel等其他格式限制大小为60M以下\n2. 调用此接口时需要设置单独的Domain请求域名,<font color=\"red\">联调开发环境为: file.test.ess.tencent.cn,正式环境需要设置为:file.ess.tencent.cn</font>,代码示例\n```\nHttpProfile httpProfile = new HttpProfile();\nhttpProfile.setEndpoint(\"file.test.ess.tencent.cn\");\n
|
571
|
+
"document": "此接口(UploadFiles)文件上传。<br/>\n\n适用场景:用于合同,印章的文件上传。文件上传以后,\n如果是PDF格式文件可配合<a href=\"https://qian.tencent.com/developers/companyApis/startFlows/CreateFlowByFiles\" target=\"_blank\">用PDF文件创建签署流程</a>接口进行合同流程的发起\n如果是其他类型可以配合<a href=\"https://qian.tencent.com/developers/companyApis/templatesAndFiles/CreateConvertTaskApi\" target=\"_blank\">创建文件转换任务</a>接口转换成PDF文件\n\n注: \n1. 图片类型(png/jpg/jpeg)限制大小为5M以下, PDF/word/excel等其他格式限制大小为60M以下\n2. 调用此接口时需要设置单独的Domain请求域名,<font color=\"red\">联调开发环境为: file.test.ess.tencent.cn,正式环境需要设置为:file.ess.tencent.cn</font>,代码示例\n```\nHttpProfile httpProfile = new HttpProfile();\nhttpProfile.setEndpoint(\"file.test.ess.tencent.cn\");\n```\n\n<font color=\"red\">相关视频指引</font> <br>\n1. <a href=\"https://dyn.ess.tencent.cn/guide/apivideo/ess_uploadfiles.mp4\" target=\"_blank\">上传用于合同发起的PDF文件代码编写示例</a><br>",
|
572
572
|
"input": "UploadFilesRequest",
|
573
573
|
"name": "上传文件",
|
574
574
|
"output": "UploadFilesResponse",
|
@@ -6012,8 +6012,8 @@
|
|
6012
6012
|
},
|
6013
6013
|
{
|
6014
6014
|
"disabled": false,
|
6015
|
-
"document": "
|
6016
|
-
"example": "
|
6015
|
+
"document": "第三方平台子客的企业名称,请确认该企业名称与企业营业执照中注册的名称完全一致。\n在测试环境联调的过程中,企业名称请统一加上“测试”二字,如:典子谦示例企业测试,否则将无法审核通过。\n\n注:\n `1. 如果名称中包含英文括号(),请使用中文括号()代替。`\n `2、该名称需要与Agent.ProxyOrganizationOpenId相匹配, 企业激活后Agent.ProxyOrganizationOpenId会跟此企业名称一一绑定; 如果您的企业已经在认证授权中或者激活完成,这里修改子客企业名字将不会生效。 `",
|
6016
|
+
"example": "典子谦示例企业测试",
|
6017
6017
|
"member": "string",
|
6018
6018
|
"name": "ProxyOrganizationName",
|
6019
6019
|
"required": true,
|
@@ -335,8 +335,7 @@
|
|
335
335
|
"member": "FaceRect",
|
336
336
|
"name": "LogoRect",
|
337
337
|
"required": true,
|
338
|
-
"type": "object"
|
339
|
-
"value_allowed_null": false
|
338
|
+
"type": "object"
|
340
339
|
},
|
341
340
|
{
|
342
341
|
"disabled": false,
|
@@ -345,8 +344,7 @@
|
|
345
344
|
"member": "string",
|
346
345
|
"name": "LogoUrl",
|
347
346
|
"required": false,
|
348
|
-
"type": "string"
|
349
|
-
"value_allowed_null": false
|
347
|
+
"type": "string"
|
350
348
|
},
|
351
349
|
{
|
352
350
|
"disabled": false,
|
@@ -355,8 +353,7 @@
|
|
355
353
|
"member": "string",
|
356
354
|
"name": "LogoImage",
|
357
355
|
"required": false,
|
358
|
-
"type": "string"
|
359
|
-
"value_allowed_null": false
|
356
|
+
"type": "string"
|
360
357
|
}
|
361
358
|
],
|
362
359
|
"usage": "in"
|
@@ -965,7 +965,7 @@
|
|
965
965
|
"members": [
|
966
966
|
{
|
967
967
|
"disabled": false,
|
968
|
-
"document": "
|
968
|
+
"document": "TWecall类型: 1-家庭安防场景; 2-穿戴类场景; 3-生活娱乐场景; 4-对讲及其它场景",
|
969
969
|
"example": "1",
|
970
970
|
"member": "int64",
|
971
971
|
"name": "PkgType",
|
@@ -12257,7 +12257,7 @@
|
|
12257
12257
|
},
|
12258
12258
|
{
|
12259
12259
|
"disabled": false,
|
12260
|
-
"document": "Sn
|
12260
|
+
"document": "Sn信息,SN格式:产品ID_设备名\n注意:此字段可能返回 null,表示取不到有效值。",
|
12261
12261
|
"example": "无",
|
12262
12262
|
"member": "string",
|
12263
12263
|
"name": "Sn",
|
@@ -15,7 +15,7 @@
|
|
15
15
|
"status": "online"
|
16
16
|
},
|
17
17
|
"CreateApp": {
|
18
|
-
"document": "
|
18
|
+
"document": "创建知识引擎应用。",
|
19
19
|
"input": "CreateAppRequest",
|
20
20
|
"name": "创建应用",
|
21
21
|
"output": "CreateAppResponse",
|
@@ -981,7 +981,7 @@
|
|
981
981
|
},
|
982
982
|
{
|
983
983
|
"disabled": false,
|
984
|
-
"document": "
|
984
|
+
"document": "应用头像",
|
985
985
|
"example": "无",
|
986
986
|
"member": "string",
|
987
987
|
"name": "Avatar",
|
@@ -992,7 +992,7 @@
|
|
992
992
|
},
|
993
993
|
{
|
994
994
|
"disabled": false,
|
995
|
-
"document": "
|
995
|
+
"document": "应用描述",
|
996
996
|
"example": "无",
|
997
997
|
"member": "string",
|
998
998
|
"name": "Desc",
|
@@ -8748,8 +8748,8 @@
|
|
8748
8748
|
"members": [
|
8749
8749
|
{
|
8750
8750
|
"disabled": false,
|
8751
|
-
"document": "
|
8752
|
-
"example": "
|
8751
|
+
"document": "应用ID",
|
8752
|
+
"example": "1727231073371148288",
|
8753
8753
|
"member": "string",
|
8754
8754
|
"name": "BotBizId",
|
8755
8755
|
"required": true,
|
@@ -8758,7 +8758,7 @@
|
|
8758
8758
|
{
|
8759
8759
|
"disabled": false,
|
8760
8760
|
"document": "文件名",
|
8761
|
-
"example": "
|
8761
|
+
"example": "测试.docx",
|
8762
8762
|
"member": "string",
|
8763
8763
|
"name": "FileName",
|
8764
8764
|
"required": true,
|
@@ -8775,8 +8775,8 @@
|
|
8775
8775
|
},
|
8776
8776
|
{
|
8777
8777
|
"disabled": false,
|
8778
|
-
"document": "cos
|
8779
|
-
"example": "
|
8778
|
+
"document": "平台cos路径,与DescribeStorageCredential接口查询UploadPath参数保持一致",
|
8779
|
+
"example": "/corp/23432432/233432/doc/zeSOHIBjwcWoEmlMMXOp-1796022574489010176.docx",
|
8780
8780
|
"member": "string",
|
8781
8781
|
"name": "CosUrl",
|
8782
8782
|
"required": true,
|
@@ -8785,7 +8785,7 @@
|
|
8785
8785
|
{
|
8786
8786
|
"disabled": false,
|
8787
8787
|
"document": "ETag 全称为 Entity Tag,是对象被创建时标识对象内容的信息标签,可用于检查对象的内容是否发生变化",
|
8788
|
-
"example": "
|
8788
|
+
"example": "\\\"58e88ad7665f11c4f66eba0eada383a5\\\"",
|
8789
8789
|
"member": "string",
|
8790
8790
|
"name": "ETag",
|
8791
8791
|
"required": true,
|
@@ -8794,7 +8794,7 @@
|
|
8794
8794
|
{
|
8795
8795
|
"disabled": false,
|
8796
8796
|
"document": "cos_hash x-cos-hash-crc64ecma 头部中的 CRC64编码进行校验上传到云端的文件和本地文件的一致性",
|
8797
|
-
"example": "
|
8797
|
+
"example": "xxxxxxxxx",
|
8798
8798
|
"member": "string",
|
8799
8799
|
"name": "CosHash",
|
8800
8800
|
"required": true,
|
@@ -8803,7 +8803,7 @@
|
|
8803
8803
|
{
|
8804
8804
|
"disabled": false,
|
8805
8805
|
"document": "文件大小",
|
8806
|
-
"example": "
|
8806
|
+
"example": "643000",
|
8807
8807
|
"member": "string",
|
8808
8808
|
"name": "Size",
|
8809
8809
|
"required": true,
|
@@ -583,7 +583,7 @@
|
|
583
583
|
"SaveDoc": [
|
584
584
|
{
|
585
585
|
"document": "",
|
586
|
-
"input": "POST / HTTP/1.1\nHost: lke.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: SaveDoc\n<公共请求参数>\n\n{\n \"BotBizId\": \"1727231073371148288\",\n \"FileName\": \"
|
586
|
+
"input": "POST / HTTP/1.1\nHost: lke.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: SaveDoc\n<公共请求参数>\n\n{\n \"BotBizId\": \"1727231073371148288\",\n \"FileName\": \"测试.docx\",\n \"FileType\": \"docx\",\n \"CosUrl\": \"/corp/23432432/233432/doc/zeSOHIBjwcWoEmlMMXOp-1796022574489010176.docx\",\n \"ETag\": \"\\\"58e88ad7665f11c4f66eba0eada383a5\\\"\",\n \"CosHash\": \"xxxxxxxxx\",\n \"Size\": \"643000\",\n \"Source\": 1,\n \"WebUrl\": \"\",\n \"AttrRange\": 1,\n \"AttrLabels\": [],\n \"ReferUrlType\": 0\n}",
|
587
587
|
"output": "{\n \"Response\": {\n \"DocBizId\": \"1694921462777761792\",\n \"ErrorMsg\": \"\",\n \"ErrorLink\": \"\",\n \"ErrorLinkText\": \"\",\n \"RequestId\": \"e3338103-3165-49c0-b218-245be865cca5\"\n }\n}",
|
588
588
|
"title": "保存文档"
|
589
589
|
}
|