tccli 3.0.1283.1__py2.py3-none-any.whl → 3.0.1285.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.
Files changed (104) hide show
  1. tccli/__init__.py +1 -1
  2. tccli/services/acp/v20220105/api.json +23 -23
  3. tccli/services/acp/v20220105/examples.json +2 -8
  4. tccli/services/advisor/v20200721/api.json +4 -2
  5. tccli/services/apm/v20210622/api.json +1 -1
  6. tccli/services/autoscaling/v20180419/api.json +88 -86
  7. tccli/services/bh/bh_client.py +53 -0
  8. tccli/services/bh/v20230418/api.json +199 -0
  9. tccli/services/bh/v20230418/examples.json +8 -0
  10. tccli/services/cdn/v20180606/api.json +4 -2
  11. tccli/services/cdwch/v20200915/api.json +19 -9
  12. tccli/services/cdwch/v20200915/examples.json +1 -1
  13. tccli/services/cdwdoris/v20211228/api.json +18 -0
  14. tccli/services/cfg/v20210820/api.json +48 -24
  15. tccli/services/cfg/v20210820/examples.json +8 -2
  16. tccli/services/clb/v20180317/api.json +21 -3
  17. tccli/services/cmq/v20190304/api.json +92 -92
  18. tccli/services/cynosdb/v20190107/api.json +389 -379
  19. tccli/services/dbbrain/v20191016/api.json +17 -17
  20. tccli/services/dbbrain/v20210527/api.json +22 -22
  21. tccli/services/dcdb/v20180411/api.json +14 -4
  22. tccli/services/dcdb/v20180411/examples.json +1 -1
  23. tccli/services/dlc/v20210125/api.json +130 -58
  24. tccli/services/dlc/v20210125/examples.json +5 -5
  25. tccli/services/domain/v20180808/api.json +160 -160
  26. tccli/services/dsgc/v20190723/api.json +2 -2
  27. tccli/services/dts/v20180330/api.json +19 -19
  28. tccli/services/dts/v20211206/api.json +829 -818
  29. tccli/services/emr/emr_client.py +53 -0
  30. tccli/services/emr/v20190103/api.json +247 -0
  31. tccli/services/emr/v20190103/examples.json +8 -0
  32. tccli/services/es/v20180416/api.json +13 -3
  33. tccli/services/es/v20180416/examples.json +2 -2
  34. tccli/services/ess/ess_client.py +53 -0
  35. tccli/services/ess/v20201111/api.json +122 -1
  36. tccli/services/ess/v20201111/examples.json +26 -0
  37. tccli/services/essbasic/essbasic_client.py +57 -4
  38. tccli/services/essbasic/v20210526/api.json +163 -0
  39. tccli/services/essbasic/v20210526/examples.json +26 -0
  40. tccli/services/fmu/fmu_client.py +8 -167
  41. tccli/services/fmu/v20191213/api.json +0 -292
  42. tccli/services/fmu/v20191213/examples.json +0 -24
  43. tccli/services/goosefs/v20220519/api.json +26 -24
  44. tccli/services/goosefs/v20220519/examples.json +2 -2
  45. tccli/services/iotcloud/v20210408/api.json +27 -27
  46. tccli/services/iotcloud/v20210408/examples.json +6 -6
  47. tccli/services/iotexplorer/iotexplorer_client.py +0 -106
  48. tccli/services/iotexplorer/v20190423/api.json +0 -274
  49. tccli/services/iotexplorer/v20190423/examples.json +0 -16
  50. tccli/services/iss/v20230517/api.json +547 -537
  51. tccli/services/iss/v20230517/examples.json +2 -2
  52. tccli/services/kms/v20190118/api.json +20 -0
  53. tccli/services/lcic/lcic_client.py +114 -8
  54. tccli/services/lcic/v20220817/api.json +108 -0
  55. tccli/services/lcic/v20220817/examples.json +16 -0
  56. tccli/services/lke/v20231130/api.json +8 -8
  57. tccli/services/lke/v20231130/examples.json +1 -1
  58. tccli/services/lowcode/v20210108/api.json +165 -165
  59. tccli/services/lowcode/v20210108/examples.json +5 -5
  60. tccli/services/mariadb/v20170312/api.json +12 -2
  61. tccli/services/mariadb/v20170312/examples.json +4 -4
  62. tccli/services/mongodb/mongodb_client.py +57 -4
  63. tccli/services/mongodb/v20190725/api.json +63 -0
  64. tccli/services/mongodb/v20190725/examples.json +14 -0
  65. tccli/services/monitor/v20180724/api.json +36 -36
  66. tccli/services/monitor/v20180724/examples.json +10 -10
  67. tccli/services/ocr/v20181119/api.json +2 -2
  68. tccli/services/ocr/v20181119/examples.json +2 -2
  69. tccli/services/organization/organization_client.py +53 -0
  70. tccli/services/organization/v20210331/api.json +61 -0
  71. tccli/services/organization/v20210331/examples.json +8 -0
  72. tccli/services/redis/v20180412/api.json +11 -2
  73. tccli/services/redis/v20180412/examples.json +1 -1
  74. tccli/services/scf/v20180416/api.json +40 -0
  75. tccli/services/svp/svp_client.py +57 -4
  76. tccli/services/svp/v20240125/api.json +319 -0
  77. tccli/services/svp/v20240125/examples.json +8 -0
  78. tccli/services/tdmq/tdmq_client.py +4 -57
  79. tccli/services/tdmq/v20200217/api.json +118 -212
  80. tccli/services/tdmq/v20200217/examples.json +0 -8
  81. tccli/services/tds/v20220801/api.json +2 -2
  82. tccli/services/tione/v20211111/api.json +41 -1
  83. tccli/services/trtc/v20190722/api.json +16 -5
  84. tccli/services/tse/v20201207/api.json +207 -104
  85. tccli/services/tsf/tsf_client.py +53 -0
  86. tccli/services/tsf/v20180326/api.json +48 -4
  87. tccli/services/tsf/v20180326/examples.json +8 -0
  88. tccli/services/vclm/v20240523/api.json +20 -2
  89. tccli/services/vdb/v20230616/api.json +62 -62
  90. tccli/services/vdb/v20230616/examples.json +2 -2
  91. tccli/services/vpc/v20170312/api.json +54 -0
  92. tccli/services/vpc/v20170312/examples.json +8 -0
  93. tccli/services/vpc/vpc_client.py +53 -0
  94. tccli/services/waf/v20180125/api.json +143 -0
  95. tccli/services/waf/v20180125/examples.json +16 -0
  96. tccli/services/waf/waf_client.py +106 -0
  97. tccli/services/wedata/v20210820/api.json +1220 -5
  98. tccli/services/wedata/v20210820/examples.json +32 -8
  99. tccli/services/wedata/wedata_client.py +159 -0
  100. {tccli-3.0.1283.1.dist-info → tccli-3.0.1285.1.dist-info}/METADATA +2 -2
  101. {tccli-3.0.1283.1.dist-info → tccli-3.0.1285.1.dist-info}/RECORD +104 -104
  102. {tccli-3.0.1283.1.dist-info → tccli-3.0.1285.1.dist-info}/WHEEL +0 -0
  103. {tccli-3.0.1283.1.dist-info → tccli-3.0.1285.1.dist-info}/entry_points.txt +0 -0
  104. {tccli-3.0.1283.1.dist-info → tccli-3.0.1285.1.dist-info}/license_files/LICENSE +0 -0
@@ -511,8 +511,8 @@
511
511
  "DescribeVideoBitRate": [
512
512
  {
513
513
  "document": "正常响应",
514
- "input": "POST / HTTP/1.1\nHost: iss.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: DescribeVideoBitRate\n<公共请求参数>\n\n{\n \"ChannelIds\": [\n \"ffefbe2f-a5a2-4659-a56f-7596a0e13900\",\n \"ffd25236-a057-4c30-a3dc-91b1aee8cbc0\"\n ]\n}",
515
- "output": "{\n \"Response\": {\n \"Data\": {\n \"BitRates\": [\n {\n \"ChannelId\": \"ffefbe2f-a5a2-4659-a56f-7596a0e13900\",\n \"Bitrate\": 15.23\n },\n {\n \"ChannelId\": \"ffd25236-a057-4c30-a3dc-91b1aee8cbc0\",\n \"Bitrate\": 3.23\n }\n ]\n },\n \"RequestId\": \"e4a15dcd-b66b-4804-a4b0-2187ac35fe1d\"\n }\n}",
514
+ "input": "POST / HTTP/1.1\nHost: iss.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: DescribeVideoBitRate\n<公共请求参数>\n\n{\n \"ChannelIds\": [\n \"ffefbe2f-****-4659-****-7596****3900\",\n \"ffd2****-a057-****-a3dc-91b1****cbc0\"\n ]\n}",
515
+ "output": "{\n \"Response\": {\n \"Data\": {\n \"BitRates\": [\n {\n \"ChannelId\": \"ffefbe2f-****-4659-****-7596****3900\",\n \"Bitrate\": 15.23\n },\n {\n \"ChannelId\": \"ffd2****-a057-****-a3dc-91b1****cbc0\",\n \"Bitrate\": 3.23\n }\n ]\n },\n \"RequestId\": \"e4a15dcd-****-4804-****-2187ac35fe1d\"\n }\n}",
516
516
  "title": "视频通道码率信息返回结果"
517
517
  }
518
518
  ],
@@ -2222,6 +2222,26 @@
2222
2222
  "type": "string",
2223
2223
  "value_allowed_null": false
2224
2224
  },
2225
+ {
2226
+ "disabled": false,
2227
+ "document": "返回KMS用户密钥使用数量",
2228
+ "example": "10",
2229
+ "member": "uint64",
2230
+ "name": "CmkUserCount",
2231
+ "output_required": false,
2232
+ "type": "int",
2233
+ "value_allowed_null": false
2234
+ },
2235
+ {
2236
+ "disabled": false,
2237
+ "document": "返回KMS用户密钥规格数量",
2238
+ "example": "200",
2239
+ "member": "uint64",
2240
+ "name": "CmkLimit",
2241
+ "output_required": false,
2242
+ "type": "int",
2243
+ "value_allowed_null": false
2244
+ },
2225
2245
  {
2226
2246
  "document": "唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。",
2227
2247
  "member": "string",
@@ -433,6 +433,58 @@ def doDeleteAppCustomContent(args, parsed_globals):
433
433
  FormatOutput.output("action", json_obj, g_param[OptionsDefine.Output], g_param[OptionsDefine.Filter])
434
434
 
435
435
 
436
+ def doDeleteWhiteBoardSnapshot(args, parsed_globals):
437
+ g_param = parse_global_arg(parsed_globals)
438
+
439
+ if g_param[OptionsDefine.UseCVMRole.replace('-', '_')]:
440
+ cred = credential.CVMRoleCredential()
441
+ elif g_param[OptionsDefine.RoleArn.replace('-', '_')] and g_param[OptionsDefine.RoleSessionName.replace('-', '_')]:
442
+ cred = credential.STSAssumeRoleCredential(
443
+ g_param[OptionsDefine.SecretId], g_param[OptionsDefine.SecretKey], g_param[OptionsDefine.RoleArn.replace('-', '_')],
444
+ g_param[OptionsDefine.RoleSessionName.replace('-', '_')], endpoint=g_param["sts_cred_endpoint"]
445
+ )
446
+ elif os.getenv(OptionsDefine.ENV_TKE_REGION) and os.getenv(OptionsDefine.ENV_TKE_PROVIDER_ID) and os.getenv(OptionsDefine.ENV_TKE_WEB_IDENTITY_TOKEN_FILE) and os.getenv(OptionsDefine.ENV_TKE_ROLE_ARN):
447
+ cred = credential.DefaultTkeOIDCRoleArnProvider().get_credentials()
448
+ else:
449
+ cred = credential.Credential(
450
+ g_param[OptionsDefine.SecretId], g_param[OptionsDefine.SecretKey], g_param[OptionsDefine.Token]
451
+ )
452
+ http_profile = HttpProfile(
453
+ reqTimeout=60 if g_param[OptionsDefine.Timeout] is None else int(g_param[OptionsDefine.Timeout]),
454
+ reqMethod="POST",
455
+ endpoint=g_param[OptionsDefine.Endpoint],
456
+ proxy=g_param[OptionsDefine.HttpsProxy.replace('-', '_')]
457
+ )
458
+ profile = ClientProfile(httpProfile=http_profile, signMethod="HmacSHA256")
459
+ if g_param[OptionsDefine.Language]:
460
+ profile.language = g_param[OptionsDefine.Language]
461
+ mod = CLIENT_MAP[g_param[OptionsDefine.Version]]
462
+ client = mod.LcicClient(cred, g_param[OptionsDefine.Region], profile)
463
+ client._sdkVersion += ("_CLI_" + __version__)
464
+ models = MODELS_MAP[g_param[OptionsDefine.Version]]
465
+ model = models.DeleteWhiteBoardSnapshotRequest()
466
+ model.from_json_string(json.dumps(args))
467
+ start_time = time.time()
468
+ while True:
469
+ rsp = client.DeleteWhiteBoardSnapshot(model)
470
+ result = rsp.to_json_string()
471
+ try:
472
+ json_obj = json.loads(result)
473
+ except TypeError as e:
474
+ json_obj = json.loads(result.decode('utf-8')) # python3.3
475
+ if not g_param[OptionsDefine.Waiter] or search(g_param['OptionsDefine.WaiterInfo']['expr'], json_obj) == g_param['OptionsDefine.WaiterInfo']['to']:
476
+ break
477
+ cur_time = time.time()
478
+ if cur_time - start_time >= g_param['OptionsDefine.WaiterInfo']['timeout']:
479
+ raise ClientError('Request timeout, wait `%s` to `%s` timeout, last request is %s' %
480
+ (g_param['OptionsDefine.WaiterInfo']['expr'], g_param['OptionsDefine.WaiterInfo']['to'],
481
+ search(g_param['OptionsDefine.WaiterInfo']['expr'], json_obj)))
482
+ else:
483
+ print('Inquiry result is %s.' % search(g_param['OptionsDefine.WaiterInfo']['expr'], json_obj))
484
+ time.sleep(g_param['OptionsDefine.WaiterInfo']['interval'])
485
+ FormatOutput.output("action", json_obj, g_param[OptionsDefine.Output], g_param[OptionsDefine.Filter])
486
+
487
+
436
488
  def doKickUserFromRoom(args, parsed_globals):
437
489
  g_param = parse_global_arg(parsed_globals)
438
490
 
@@ -589,6 +641,58 @@ def doCreateRoom(args, parsed_globals):
589
641
  FormatOutput.output("action", json_obj, g_param[OptionsDefine.Output], g_param[OptionsDefine.Filter])
590
642
 
591
643
 
644
+ def doDescribeWhiteBoardSnapshot(args, parsed_globals):
645
+ g_param = parse_global_arg(parsed_globals)
646
+
647
+ if g_param[OptionsDefine.UseCVMRole.replace('-', '_')]:
648
+ cred = credential.CVMRoleCredential()
649
+ elif g_param[OptionsDefine.RoleArn.replace('-', '_')] and g_param[OptionsDefine.RoleSessionName.replace('-', '_')]:
650
+ cred = credential.STSAssumeRoleCredential(
651
+ g_param[OptionsDefine.SecretId], g_param[OptionsDefine.SecretKey], g_param[OptionsDefine.RoleArn.replace('-', '_')],
652
+ g_param[OptionsDefine.RoleSessionName.replace('-', '_')], endpoint=g_param["sts_cred_endpoint"]
653
+ )
654
+ elif os.getenv(OptionsDefine.ENV_TKE_REGION) and os.getenv(OptionsDefine.ENV_TKE_PROVIDER_ID) and os.getenv(OptionsDefine.ENV_TKE_WEB_IDENTITY_TOKEN_FILE) and os.getenv(OptionsDefine.ENV_TKE_ROLE_ARN):
655
+ cred = credential.DefaultTkeOIDCRoleArnProvider().get_credentials()
656
+ else:
657
+ cred = credential.Credential(
658
+ g_param[OptionsDefine.SecretId], g_param[OptionsDefine.SecretKey], g_param[OptionsDefine.Token]
659
+ )
660
+ http_profile = HttpProfile(
661
+ reqTimeout=60 if g_param[OptionsDefine.Timeout] is None else int(g_param[OptionsDefine.Timeout]),
662
+ reqMethod="POST",
663
+ endpoint=g_param[OptionsDefine.Endpoint],
664
+ proxy=g_param[OptionsDefine.HttpsProxy.replace('-', '_')]
665
+ )
666
+ profile = ClientProfile(httpProfile=http_profile, signMethod="HmacSHA256")
667
+ if g_param[OptionsDefine.Language]:
668
+ profile.language = g_param[OptionsDefine.Language]
669
+ mod = CLIENT_MAP[g_param[OptionsDefine.Version]]
670
+ client = mod.LcicClient(cred, g_param[OptionsDefine.Region], profile)
671
+ client._sdkVersion += ("_CLI_" + __version__)
672
+ models = MODELS_MAP[g_param[OptionsDefine.Version]]
673
+ model = models.DescribeWhiteBoardSnapshotRequest()
674
+ model.from_json_string(json.dumps(args))
675
+ start_time = time.time()
676
+ while True:
677
+ rsp = client.DescribeWhiteBoardSnapshot(model)
678
+ result = rsp.to_json_string()
679
+ try:
680
+ json_obj = json.loads(result)
681
+ except TypeError as e:
682
+ json_obj = json.loads(result.decode('utf-8')) # python3.3
683
+ if not g_param[OptionsDefine.Waiter] or search(g_param['OptionsDefine.WaiterInfo']['expr'], json_obj) == g_param['OptionsDefine.WaiterInfo']['to']:
684
+ break
685
+ cur_time = time.time()
686
+ if cur_time - start_time >= g_param['OptionsDefine.WaiterInfo']['timeout']:
687
+ raise ClientError('Request timeout, wait `%s` to `%s` timeout, last request is %s' %
688
+ (g_param['OptionsDefine.WaiterInfo']['expr'], g_param['OptionsDefine.WaiterInfo']['to'],
689
+ search(g_param['OptionsDefine.WaiterInfo']['expr'], json_obj)))
690
+ else:
691
+ print('Inquiry result is %s.' % search(g_param['OptionsDefine.WaiterInfo']['expr'], json_obj))
692
+ time.sleep(g_param['OptionsDefine.WaiterInfo']['interval'])
693
+ FormatOutput.output("action", json_obj, g_param[OptionsDefine.Output], g_param[OptionsDefine.Filter])
694
+
695
+
592
696
  def doBatchCreateRoom(args, parsed_globals):
593
697
  g_param = parse_global_arg(parsed_globals)
594
698
 
@@ -745,7 +849,7 @@ def doModifyApp(args, parsed_globals):
745
849
  FormatOutput.output("action", json_obj, g_param[OptionsDefine.Output], g_param[OptionsDefine.Filter])
746
850
 
747
851
 
748
- def doDescribeDocument(args, parsed_globals):
852
+ def doUnbindDocumentFromRoom(args, parsed_globals):
749
853
  g_param = parse_global_arg(parsed_globals)
750
854
 
751
855
  if g_param[OptionsDefine.UseCVMRole.replace('-', '_')]:
@@ -774,11 +878,11 @@ def doDescribeDocument(args, parsed_globals):
774
878
  client = mod.LcicClient(cred, g_param[OptionsDefine.Region], profile)
775
879
  client._sdkVersion += ("_CLI_" + __version__)
776
880
  models = MODELS_MAP[g_param[OptionsDefine.Version]]
777
- model = models.DescribeDocumentRequest()
881
+ model = models.UnbindDocumentFromRoomRequest()
778
882
  model.from_json_string(json.dumps(args))
779
883
  start_time = time.time()
780
884
  while True:
781
- rsp = client.DescribeDocument(model)
885
+ rsp = client.UnbindDocumentFromRoom(model)
782
886
  result = rsp.to_json_string()
783
887
  try:
784
888
  json_obj = json.loads(result)
@@ -3189,7 +3293,7 @@ def doDeleteRoom(args, parsed_globals):
3189
3293
  FormatOutput.output("action", json_obj, g_param[OptionsDefine.Output], g_param[OptionsDefine.Filter])
3190
3294
 
3191
3295
 
3192
- def doUnbindDocumentFromRoom(args, parsed_globals):
3296
+ def doDescribeDocument(args, parsed_globals):
3193
3297
  g_param = parse_global_arg(parsed_globals)
3194
3298
 
3195
3299
  if g_param[OptionsDefine.UseCVMRole.replace('-', '_')]:
@@ -3218,11 +3322,11 @@ def doUnbindDocumentFromRoom(args, parsed_globals):
3218
3322
  client = mod.LcicClient(cred, g_param[OptionsDefine.Region], profile)
3219
3323
  client._sdkVersion += ("_CLI_" + __version__)
3220
3324
  models = MODELS_MAP[g_param[OptionsDefine.Version]]
3221
- model = models.UnbindDocumentFromRoomRequest()
3325
+ model = models.DescribeDocumentRequest()
3222
3326
  model.from_json_string(json.dumps(args))
3223
3327
  start_time = time.time()
3224
3328
  while True:
3225
- rsp = client.UnbindDocumentFromRoom(model)
3329
+ rsp = client.DescribeDocument(model)
3226
3330
  result = rsp.to_json_string()
3227
3331
  try:
3228
3332
  json_obj = json.loads(result)
@@ -3572,13 +3676,15 @@ ACTION_MAP = {
3572
3676
  "DescribeDocumentsByRoom": doDescribeDocumentsByRoom,
3573
3677
  "DeleteGroup": doDeleteGroup,
3574
3678
  "DeleteAppCustomContent": doDeleteAppCustomContent,
3679
+ "DeleteWhiteBoardSnapshot": doDeleteWhiteBoardSnapshot,
3575
3680
  "KickUserFromRoom": doKickUserFromRoom,
3576
3681
  "GetWatermark": doGetWatermark,
3577
3682
  "CreateRoom": doCreateRoom,
3683
+ "DescribeWhiteBoardSnapshot": doDescribeWhiteBoardSnapshot,
3578
3684
  "BatchCreateRoom": doBatchCreateRoom,
3579
3685
  "DescribeGroup": doDescribeGroup,
3580
3686
  "ModifyApp": doModifyApp,
3581
- "DescribeDocument": doDescribeDocument,
3687
+ "UnbindDocumentFromRoom": doUnbindDocumentFromRoom,
3582
3688
  "DescribeSdkAppIdUsers": doDescribeSdkAppIdUsers,
3583
3689
  "StartRoom": doStartRoom,
3584
3690
  "DeleteGroupMember": doDeleteGroupMember,
@@ -3625,7 +3731,7 @@ ACTION_MAP = {
3625
3731
  "SetMarquee": doSetMarquee,
3626
3732
  "SendRoomNotificationMessage": doSendRoomNotificationMessage,
3627
3733
  "DeleteRoom": doDeleteRoom,
3628
- "UnbindDocumentFromRoom": doUnbindDocumentFromRoom,
3734
+ "DescribeDocument": doDescribeDocument,
3629
3735
  "StartRecord": doStartRecord,
3630
3736
  "UnblockKickedUser": doUnblockKickedUser,
3631
3737
  "DescribeMarquee": doDescribeMarquee,
@@ -154,6 +154,13 @@
154
154
  "output": "DeleteUserResponse",
155
155
  "status": "online"
156
156
  },
157
+ "DeleteWhiteBoardSnapshot": {
158
+ "document": "删除白板板书截图",
159
+ "input": "DeleteWhiteBoardSnapshotRequest",
160
+ "name": "删除板书截图",
161
+ "output": "DeleteWhiteBoardSnapshotResponse",
162
+ "status": "online"
163
+ },
157
164
  "DescribeAnswerList": {
158
165
  "document": "获取房间答题详情",
159
166
  "input": "DescribeAnswerListRequest",
@@ -308,6 +315,13 @@
308
315
  "output": "DescribeUserResponse",
309
316
  "status": "online"
310
317
  },
318
+ "DescribeWhiteBoardSnapshot": {
319
+ "document": "查询白板板书截图",
320
+ "input": "DescribeWhiteBoardSnapshotRequest",
321
+ "name": "获取板书截图",
322
+ "output": "DescribeWhiteBoardSnapshotResponse",
323
+ "status": "online"
324
+ },
311
325
  "EndRoom": {
312
326
  "document": "结束房间的直播",
313
327
  "input": "EndRoomRequest",
@@ -2300,6 +2314,33 @@
2300
2314
  ],
2301
2315
  "type": "object"
2302
2316
  },
2317
+ "DeleteWhiteBoardSnapshotRequest": {
2318
+ "document": "DeleteWhiteBoardSnapshot请求参数结构体",
2319
+ "members": [
2320
+ {
2321
+ "disabled": false,
2322
+ "document": "房间ID",
2323
+ "example": "301234567",
2324
+ "member": "uint64",
2325
+ "name": "RoomId",
2326
+ "required": false,
2327
+ "type": "int"
2328
+ }
2329
+ ],
2330
+ "type": "object"
2331
+ },
2332
+ "DeleteWhiteBoardSnapshotResponse": {
2333
+ "document": "DeleteWhiteBoardSnapshot返回参数结构体",
2334
+ "members": [
2335
+ {
2336
+ "document": "唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。",
2337
+ "member": "string",
2338
+ "name": "RequestId",
2339
+ "type": "string"
2340
+ }
2341
+ ],
2342
+ "type": "object"
2343
+ },
2303
2344
  "DescribeAnswerListRequest": {
2304
2345
  "document": "DescribeAnswerList请求参数结构体",
2305
2346
  "members": [
@@ -4409,6 +4450,73 @@
4409
4450
  ],
4410
4451
  "type": "object"
4411
4452
  },
4453
+ "DescribeWhiteBoardSnapshotRequest": {
4454
+ "document": "DescribeWhiteBoardSnapshot请求参数结构体",
4455
+ "members": [
4456
+ {
4457
+ "disabled": false,
4458
+ "document": "房间ID",
4459
+ "example": "301234567",
4460
+ "member": "uint64",
4461
+ "name": "RoomId",
4462
+ "required": false,
4463
+ "type": "int"
4464
+ }
4465
+ ],
4466
+ "type": "object"
4467
+ },
4468
+ "DescribeWhiteBoardSnapshotResponse": {
4469
+ "document": "DescribeWhiteBoardSnapshot返回参数结构体",
4470
+ "members": [
4471
+ {
4472
+ "disabled": false,
4473
+ "document": "板书截图生成类型。0 不生成板书;1 全量模式;2 单页去重模式",
4474
+ "example": "1",
4475
+ "member": "uint64",
4476
+ "name": "WhiteBoardSnapshotMode",
4477
+ "output_required": false,
4478
+ "type": "int",
4479
+ "value_allowed_null": false
4480
+ },
4481
+ {
4482
+ "disabled": false,
4483
+ "document": "板书任务状态,0:未开始,1:进行中,2:失败,3:成功,4:已删除",
4484
+ "example": "2",
4485
+ "member": "uint64",
4486
+ "name": "Status",
4487
+ "output_required": false,
4488
+ "type": "int",
4489
+ "value_allowed_null": false
4490
+ },
4491
+ {
4492
+ "disabled": false,
4493
+ "document": "板书截图链接",
4494
+ "example": "无",
4495
+ "member": "string",
4496
+ "name": "Result",
4497
+ "output_required": false,
4498
+ "type": "list",
4499
+ "value_allowed_null": false
4500
+ },
4501
+ {
4502
+ "disabled": false,
4503
+ "document": "总数",
4504
+ "example": "3",
4505
+ "member": "uint64",
4506
+ "name": "Total",
4507
+ "output_required": false,
4508
+ "type": "int",
4509
+ "value_allowed_null": false
4510
+ },
4511
+ {
4512
+ "document": "唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。",
4513
+ "member": "string",
4514
+ "name": "RequestId",
4515
+ "type": "string"
4516
+ }
4517
+ ],
4518
+ "type": "object"
4519
+ },
4412
4520
  "DocumentInfo": {
4413
4521
  "document": "文档信息",
4414
4522
  "members": [
@@ -176,6 +176,14 @@
176
176
  "title": "示例1"
177
177
  }
178
178
  ],
179
+ "DeleteWhiteBoardSnapshot": [
180
+ {
181
+ "document": "",
182
+ "input": "POST / HTTP/1.1\nHost: lcic.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: DeleteWhiteBoardSnapshot\n<公共请求参数>\n\n{\n \"RoomId\": 353530000\n}",
183
+ "output": "{\n \"Response\": {\n \"RequestId\": \"611a885e-8299-4cc5-b1d1-1ea75f50c6b7\"\n }\n}",
184
+ "title": "删除板书截图"
185
+ }
186
+ ],
179
187
  "DescribeAnswerList": [
180
188
  {
181
189
  "document": "示例",
@@ -376,6 +384,14 @@
376
384
  "title": "获取用户信息"
377
385
  }
378
386
  ],
387
+ "DescribeWhiteBoardSnapshot": [
388
+ {
389
+ "document": "",
390
+ "input": "POST / HTTP/1.1\nHost: lcic.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: DescribeWhiteBoardSnapshot\n<公共请求参数>\n\n{\n \"RoomId\": 345740000\n}",
391
+ "output": "{\n \"Response\": {\n \"RequestId\": \"2fbab292-694c-437c-9182-5f9af464ebb0\",\n \"Result\": [\n \"https://example.cos.ap-shanghai.myqcloud.com/snapshot1.png\",\n \"https://example.cos.ap-shanghai.myqcloud.com/snapshot2.png\",\n \"https://example.cos.ap-shanghai.myqcloud.com/snapshot3.png\",\n \"https://example.cos.ap-shanghai.myqcloud.com/snapshot4.png\",\n \"https://example.cos.ap-shanghai.myqcloud.com/snapshot5.png\"\n ],\n \"Status\": 3,\n \"Total\": 5,\n \"WhiteBoardSnapshotMode\": 1\n }\n}",
392
+ "title": "查询白板板书截图"
393
+ }
394
+ ],
379
395
  "EndRoom": [
380
396
  {
381
397
  "document": "房间ID存在示例",
@@ -666,9 +666,9 @@
666
666
  "status": "online"
667
667
  },
668
668
  "SaveDoc": {
669
- "document": "保存文档",
669
+ "document": "知识库文档问答保存。\n将文件存储到应用的知识库内需要三步:\n1.获取临时密钥,参考[接口文档](https://cloud.tencent.com/document/product/1759/105050)。\n2.调用腾讯云提供的 cos 存储接口,将文件存储到知识引擎 cos 中:参考[PUT Objectufeff](https://cloud.tencent.com/document/product/436/7749)\n3.调用本接口,将文件的基础信息存储到知识引擎中。\n以上步骤可参考[文档](https://cloud.tencent.com/document/product/1759/108903),文档最后有[代码demo](https://cloud.tencent.com/document/product/1759/108903#demo),可作为参考。",
670
670
  "input": "SaveDocRequest",
671
- "name": "保存文档",
671
+ "name": "知识库文档问答保存",
672
672
  "output": "SaveDocResponse",
673
673
  "status": "online"
674
674
  },
@@ -13637,7 +13637,7 @@
13637
13637
  },
13638
13638
  {
13639
13639
  "disabled": false,
13640
- "document": "ETag 全称为 Entity Tag,是对象被创建时标识对象内容的信息标签,可用于检查对象的内容是否发生变化",
13640
+ "document": "ETag 全称为 Entity Tag,是对象被创建时标识对象内容的信息标签,可用于检查对象的内容是否发生变化 成功上传cos后,从返回头中获取",
13641
13641
  "example": "\\\"58e88ad7665f11c4f66eba0eada383a5\\\"",
13642
13642
  "member": "string",
13643
13643
  "name": "ETag",
@@ -13646,7 +13646,7 @@
13646
13646
  },
13647
13647
  {
13648
13648
  "disabled": false,
13649
- "document": "cos_hash x-cos-hash-crc64ecma 头部中的 CRC64编码进行校验上传到云端的文件和本地文件的一致性",
13649
+ "document": "cos_hash x-cos-hash-crc64ecma 头部中的 CRC64编码进行校验上传到云端的文件和本地文件的一致性 <br> 成功上传cos后,从返回头中获取",
13650
13650
  "example": "xxxxxxxxx",
13651
13651
  "member": "string",
13652
13652
  "name": "CosHash",
@@ -13664,11 +13664,11 @@
13664
13664
  },
13665
13665
  {
13666
13666
  "disabled": false,
13667
- "document": "标签适用范围 1:全部,2:按条件范围",
13668
- "example": "1:全部,2:按条件范围",
13667
+ "document": "标签适用范围,默认填0即可",
13668
+ "example": "0",
13669
13669
  "member": "uint64",
13670
13670
  "name": "AttrRange",
13671
- "required": true,
13671
+ "required": false,
13672
13672
  "type": "int"
13673
13673
  },
13674
13674
  {
@@ -13736,7 +13736,7 @@
13736
13736
  },
13737
13737
  {
13738
13738
  "disabled": false,
13739
- "document": "文档操作类型:1:批量导入(批量导入问答对);2:文档导入(正常导入单个文档)",
13739
+ "document": "文档操作类型:1:批量导入(批量导入问答对);2:文档导入(正常导入单个文档) 默认为1 <br> 请注意,opt=1的时候请从知识引擎页面下载excel模板",
13740
13740
  "example": "无",
13741
13741
  "member": "uint64",
13742
13742
  "name": "Opt",
@@ -777,7 +777,7 @@
777
777
  "document": "",
778
778
  "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}",
779
779
  "output": "{\n \"Response\": {\n \"DocBizId\": \"1694921462777761792\",\n \"ErrorMsg\": \"\",\n \"ErrorLink\": \"\",\n \"ErrorLinkText\": \"\",\n \"RequestId\": \"e3338103-3165-49c0-b218-245be865cca5\"\n }\n}",
780
- "title": "保存文档"
780
+ "title": "知识库文档问答保存"
781
781
  }
782
782
  ],
783
783
  "StopDocParse": [