tccli 3.0.845.1__py2.py3-none-any.whl → 3.0.847.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 (59) hide show
  1. tccli/__init__.py +1 -1
  2. tccli/services/billing/v20180709/api.json +18 -62
  3. tccli/services/billing/v20180709/examples.json +8 -8
  4. tccli/services/cat/v20180409/api.json +0 -28
  5. tccli/services/cat/v20180409/examples.json +7 -7
  6. tccli/services/ccc/v20200210/api.json +16 -7
  7. tccli/services/ccc/v20200210/examples.json +2 -2
  8. tccli/services/cdb/v20170320/api.json +71 -50
  9. tccli/services/cdb/v20170320/examples.json +4 -4
  10. tccli/services/cdn/v20180606/api.json +1 -11
  11. tccli/services/cdn/v20180606/examples.json +1 -1
  12. tccli/services/ckafka/v20190819/api.json +8 -5
  13. tccli/services/ckafka/v20190819/examples.json +3 -3
  14. tccli/services/cls/v20201016/api.json +44 -33
  15. tccli/services/cls/v20201016/examples.json +3 -3
  16. tccli/services/cvm/v20170312/api.json +2 -4
  17. tccli/services/dbbrain/v20210527/api.json +36 -30
  18. tccli/services/dcdb/dcdb_client.py +53 -0
  19. tccli/services/dcdb/v20180411/api.json +812 -157
  20. tccli/services/dcdb/v20180411/examples.json +8 -0
  21. tccli/services/dlc/v20210125/api.json +9 -0
  22. tccli/services/emr/v20190103/api.json +9 -29
  23. tccli/services/ess/ess_client.py +273 -8
  24. tccli/services/ess/v20201111/api.json +639 -89
  25. tccli/services/ess/v20201111/examples.json +58 -6
  26. tccli/services/essbasic/essbasic_client.py +159 -0
  27. tccli/services/essbasic/v20210526/api.json +287 -3
  28. tccli/services/essbasic/v20210526/examples.json +24 -0
  29. tccli/services/iotexplorer/v20190423/api.json +25 -33
  30. tccli/services/iotexplorer/v20190423/examples.json +9 -9
  31. tccli/services/mariadb/mariadb_client.py +53 -0
  32. tccli/services/mariadb/v20170312/api.json +520 -0
  33. tccli/services/mariadb/v20170312/examples.json +8 -0
  34. tccli/services/monitor/v20180724/api.json +10 -11
  35. tccli/services/monitor/v20180724/examples.json +5 -5
  36. tccli/services/mps/v20190612/api.json +2 -7
  37. tccli/services/ocr/v20181119/api.json +73 -89
  38. tccli/services/ocr/v20181119/examples.json +23 -23
  39. tccli/services/redis/redis_client.py +53 -0
  40. tccli/services/redis/v20180412/api.json +214 -0
  41. tccli/services/redis/v20180412/examples.json +8 -0
  42. tccli/services/tcss/v20201101/api.json +40 -7
  43. tccli/services/tcss/v20201101/examples.json +3 -3
  44. tccli/services/tdid/v20210519/api.json +68 -68
  45. tccli/services/tiw/tiw_client.py +1403 -78
  46. tccli/services/tiw/v20190919/api.json +2439 -461
  47. tccli/services/tiw/v20190919/examples.json +200 -0
  48. tccli/services/trtc/v20190722/api.json +41 -29
  49. tccli/services/trtc/v20190722/examples.json +10 -10
  50. tccli/services/vpc/v20170312/api.json +15 -27
  51. tccli/services/vpc/v20170312/examples.json +6 -6
  52. tccli/services/waf/v20180125/api.json +50 -6
  53. tccli/services/waf/v20180125/examples.json +2 -2
  54. {tccli-3.0.845.1.dist-info → tccli-3.0.847.1.dist-info}/METADATA +2 -2
  55. {tccli-3.0.845.1.dist-info → tccli-3.0.847.1.dist-info}/RECORD +59 -59
  56. {tccli-3.0.845.1.dist-info → tccli-3.0.847.1.dist-info}/LICENSE +0 -0
  57. {tccli-3.0.845.1.dist-info → tccli-3.0.847.1.dist-info}/WHEEL +0 -0
  58. {tccli-3.0.845.1.dist-info → tccli-3.0.847.1.dist-info}/entry_points.txt +0 -0
  59. {tccli-3.0.845.1.dist-info → tccli-3.0.847.1.dist-info}/top_level.txt +0 -0
tccli/services/tiw/v20190919/api.json CHANGED
@@ -1,5 +1,26 @@
1
1
  {
2
2
  "actions": {
3
+ "ApplyTiwTrial": {
4
+ "document": "申请互动白板试用，默认15天",
5
+ "input": "ApplyTiwTrialRequest",
6
+ "name": "申请互动白板试用",
7
+ "output": "ApplyTiwTrialResponse",
8
+ "status": "online"
9
+ },
10
+ "CreateApplication": {
11
+ "document": "创建白板应用",
12
+ "input": "CreateApplicationRequest",
13
+ "name": "创建白板应用",
14
+ "output": "CreateApplicationResponse",
15
+ "status": "online"
16
+ },
17
+ "CreateOfflineRecord": {
18
+ "document": "创建课后录制任务",
19
+ "input": "CreateOfflineRecordRequest",
20
+ "name": "创建课后录制任务",
21
+ "output": "CreateOfflineRecordResponse",
22
+ "status": "online"
23
+ },
3
24
  "CreateSnapshotTask": {
4
25
  "document": "创建白板板书生成任务, 在任务结束后，如果提供了回调地址，将通过回调地址通知板书生成结果",
5
26
  "input": "CreateSnapshotTaskRequest",
@@ -21,6 +42,55 @@
21
42
  "output": "CreateVideoGenerationTaskResponse",
22
43
  "status": "online"
23
44
  },
45
+ "DescribeAPIService": {
46
+ "document": "通过服务角色调用其他云产品API接口获取信息",
47
+ "input": "DescribeAPIServiceRequest",
48
+ "name": "获取其他云产品信息",
49
+ "output": "DescribeAPIServiceResponse",
50
+ "status": "online"
51
+ },
52
+ "DescribeApplicationInfos": {
53
+ "document": "查询白板应用详情",
54
+ "input": "DescribeApplicationInfosRequest",
55
+ "name": "查询白板应用详情",
56
+ "output": "DescribeApplicationInfosResponse",
57
+ "status": "online"
58
+ },
59
+ "DescribeApplicationUsage": {
60
+ "document": "查询互动白板各个子产品用量",
61
+ "input": "DescribeApplicationUsageRequest",
62
+ "name": "查询互动白板各个子产品用量",
63
+ "output": "DescribeApplicationUsageResponse",
64
+ "status": "online"
65
+ },
66
+ "DescribeBoardSDKLog": {
67
+ "document": "查询客户端白板日志",
68
+ "input": "DescribeBoardSDKLogRequest",
69
+ "name": "查询白板日志",
70
+ "output": "DescribeBoardSDKLogResponse",
71
+ "status": "online"
72
+ },
73
+ "DescribeIMApplications": {
74
+ "document": "查询可用于创建白板应用的IM应用列表",
75
+ "input": "DescribeIMApplicationsRequest",
76
+ "name": "查询可用的IM应用列表",
77
+ "output": "DescribeIMApplicationsResponse",
78
+ "status": "online"
79
+ },
80
+ "DescribeOfflineRecord": {
81
+ "document": "查询课后录制任务的进度与录制结果等相关信息",
82
+ "input": "DescribeOfflineRecordRequest",
83
+ "name": "查询课后录制任务",
84
+ "output": "DescribeOfflineRecordResponse",
85
+ "status": "online"
86
+ },
87
+ "DescribeOfflineRecordCallback": {
88
+ "document": "查询课后录制回调地址",
89
+ "input": "DescribeOfflineRecordCallbackRequest",
90
+ "name": "查询回调地址",
91
+ "output": "DescribeOfflineRecordCallbackResponse",
92
+ "status": "online"
93
+ },
24
94
  "DescribeOnlineRecord": {
25
95
  "document": "查询录制任务状态与结果",
26
96
  "input": "DescribeOnlineRecordRequest",
@@ -35,6 +105,13 @@
35
105
  "output": "DescribeOnlineRecordCallbackResponse",
36
106
  "status": "online"
37
107
  },
108
+ "DescribePostpaidUsage": {
109
+ "document": "查询用户后付费用量",
110
+ "input": "DescribePostpaidUsageRequest",
111
+ "name": "查询用户后付费用量",
112
+ "output": "DescribePostpaidUsageResponse",
113
+ "status": "online"
114
+ },
38
115
  "DescribeQualityMetrics": {
39
116
  "document": "查询互动白板质量数据",
40
117
  "input": "DescribeQualityMetricsRequest",
@@ -42,6 +119,13 @@
42
119
  "output": "DescribeQualityMetricsResponse",
43
120
  "status": "online"
44
121
  },
122
+ "DescribeRoomList": {
123
+ "document": "查询白板房间列表",
124
+ "input": "DescribeRoomListRequest",
125
+ "name": "查询白板房间列表",
126
+ "output": "DescribeRoomListResponse",
127
+ "status": "online"
128
+ },
45
129
  "DescribeSnapshotTask": {
46
130
  "document": "获取指定白板板书生成任务信息",
47
131
  "input": "DescribeSnapshotTaskRequest",
@@ -77,6 +161,41 @@
77
161
  "output": "DescribeTranscodeCallbackResponse",
78
162
  "status": "online"
79
163
  },
164
+ "DescribeTranscodeSearch": {
165
+ "document": "按文档名称搜索转码任务",
166
+ "input": "DescribeTranscodeSearchRequest",
167
+ "name": "搜索转码任务",
168
+ "output": "DescribeTranscodeSearchResponse",
169
+ "status": "online"
170
+ },
171
+ "DescribeUsageSummary": {
172
+ "document": "查询指定时间段内子产品的用量汇总",
173
+ "input": "DescribeUsageSummaryRequest",
174
+ "name": "查询子产品用量统计",
175
+ "output": "DescribeUsageSummaryResponse",
176
+ "status": "online"
177
+ },
178
+ "DescribeUserList": {
179
+ "document": "查询白板用户列表",
180
+ "input": "DescribeUserListRequest",
181
+ "name": "查询白板用户列表",
182
+ "output": "DescribeUserListResponse",
183
+ "status": "online"
184
+ },
185
+ "DescribeUserResources": {
186
+ "document": "查询客户资源列表",
187
+ "input": "DescribeUserResourcesRequest",
188
+ "name": "查询客户资源列表",
189
+ "output": "DescribeUserResourcesResponse",
190
+ "status": "online"
191
+ },
192
+ "DescribeUserStatus": {
193
+ "document": "查询互动白板用户详情，包括是否开通了互动白板，当前互动白板服务有效期等信息\n",
194
+ "input": "DescribeUserStatusRequest",
195
+ "name": "查询互动白板用户详情",
196
+ "output": "DescribeUserStatusResponse",
197
+ "status": "online"
198
+ },
80
199
  "DescribeVideoGenerationTask": {
81
200
  "document": "查询录制视频生成任务状态与结果",
82
201
  "input": "DescribeVideoGenerationTaskRequest",
@@ -91,6 +210,20 @@
91
210
  "output": "DescribeVideoGenerationTaskCallbackResponse",
92
211
  "status": "online"
93
212
  },
213
+ "DescribeWhiteboardApplicationConfig": {
214
+ "document": "查询白板应用任务相关的配置，包括存储桶、回调等",
215
+ "input": "DescribeWhiteboardApplicationConfigRequest",
216
+ "name": "查询白板应用任务相关配置",
217
+ "output": "DescribeWhiteboardApplicationConfigResponse",
218
+ "status": "online"
219
+ },
220
+ "DescribeWhiteboardBucketConfig": {
221
+ "document": "查询文档转码，实时录制存储桶的配置",
222
+ "input": "DescribeWhiteboardBucketConfigRequest",
223
+ "name": "查询应用资源配置",
224
+ "output": "DescribeWhiteboardBucketConfigResponse",
225
+ "status": "online"
226
+ },
94
227
  "DescribeWhiteboardPush": {
95
228
  "document": "查询推流任务状态与结果",
96
229
  "input": "DescribeWhiteboardPushRequest",
@@ -105,6 +238,41 @@
105
238
  "output": "DescribeWhiteboardPushCallbackResponse",
106
239
  "status": "online"
107
240
  },
241
+ "DescribeWhiteboardPushSearch": {
242
+ "document": "根据房间号搜索白板推流任务",
243
+ "input": "DescribeWhiteboardPushSearchRequest",
244
+ "name": "搜索白板推流任务",
245
+ "output": "DescribeWhiteboardPushSearchResponse",
246
+ "status": "online"
247
+ },
248
+ "ModifyApplication": {
249
+ "document": "修改白板应用",
250
+ "input": "ModifyApplicationRequest",
251
+ "name": "修改白板应用",
252
+ "output": "ModifyApplicationResponse",
253
+ "status": "online"
254
+ },
255
+ "ModifyAutoRenewFlag": {
256
+ "document": "设置白板月功能费自动续费",
257
+ "input": "ModifyAutoRenewFlagRequest",
258
+ "name": "设置自动续费",
259
+ "output": "ModifyAutoRenewFlagResponse",
260
+ "status": "online"
261
+ },
262
+ "ModifyWhiteboardApplicationConfig": {
263
+ "document": "修改白板应用任务相关的配置，包括存储桶、回调等",
264
+ "input": "ModifyWhiteboardApplicationConfigRequest",
265
+ "name": "修改白板应用任务相关配置",
266
+ "output": "ModifyWhiteboardApplicationConfigResponse",
267
+ "status": "online"
268
+ },
269
+ "ModifyWhiteboardBucketConfig": {
270
+ "document": "设置文档转码，实时录制存储桶的配置",
271
+ "input": "ModifyWhiteboardBucketConfigRequest",
272
+ "name": "设置应用资源存储桶配置",
273
+ "output": "ModifyWhiteboardBucketConfigResponse",
274
+ "status": "online"
275
+ },
108
276
  "PauseOnlineRecord": {
109
277
  "document": "暂停实时录制",
110
278
  "input": "PauseOnlineRecordRequest",
@@ -119,6 +287,13 @@
119
287
  "output": "ResumeOnlineRecordResponse",
120
288
  "status": "online"
121
289
  },
290
+ "SetOfflineRecordCallback": {
291
+ "document": "设置课后录制回调地址",
292
+ "input": "SetOfflineRecordCallbackRequest",
293
+ "name": "设置回调地址",
294
+ "output": "SetOfflineRecordCallbackResponse",
295
+ "status": "online"
296
+ },
122
297
  "SetOnlineRecordCallback": {
123
298
  "document": "设置实时录制回调地址，回调数据格式请参考文档：https://cloud.tencent.com/document/product/1137/40258",
124
299
  "input": "SetOnlineRecordCallbackRequest",
@@ -211,6 +386,65 @@
211
386
  "serviceShortName": "tiw"
212
387
  },
213
388
  "objects": {
389
+ "ApplicationItem": {
390
+ "document": "白板应用",
391
+ "members": [
392
+ {
393
+ "default": "",
394
+ "document": "应用SdkAppId",
395
+ "member": "int64",
396
+ "name": "SdkAppId",
397
+ "required": true,
398
+ "type": "int",
399
+ "value_allowed_null": false
400
+ },
401
+ {
402
+ "default": "",
403
+ "document": "应用名",
404
+ "member": "string",
405
+ "name": "AppName",
406
+ "required": true,
407
+ "type": "string",
408
+ "value_allowed_null": false
409
+ },
410
+ {
411
+ "default": "",
412
+ "document": "创建时间",
413
+ "member": "datetime",
414
+ "name": "CreateTime",
415
+ "required": true,
416
+ "type": "string",
417
+ "value_allowed_null": false
418
+ },
419
+ {
420
+ "default": "",
421
+ "document": "标签列表",
422
+ "member": "Tag",
423
+ "name": "TagList",
424
+ "required": true,
425
+ "type": "list",
426
+ "value_allowed_null": false
427
+ }
428
+ ],
429
+ "usage": "out"
430
+ },
431
+ "ApplyTiwTrialRequest": {
432
+ "document": "ApplyTiwTrial请求参数结构体",
433
+ "members": [],
434
+ "type": "object"
435
+ },
436
+ "ApplyTiwTrialResponse": {
437
+ "document": "ApplyTiwTrial返回参数结构体",
438
+ "members": [
439
+ {
440
+ "document": "唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。",
441
+ "member": "string",
442
+ "name": "RequestId",
443
+ "type": "string"
444
+ }
445
+ ],
446
+ "type": "object"
447
+ },
214
448
  "AuthParam": {
215
449
  "document": "鉴权参数",
216
450
  "members": [
@@ -295,6 +529,143 @@
295
529
  ],
296
530
  "usage": "in"
297
531
  },
532
+ "CreateApplicationRequest": {
533
+ "document": "CreateApplication请求参数结构体",
534
+ "members": [
535
+ {
536
+ "default": "",
537
+ "document": "应用SdkAppId",
538
+ "member": "int64",
539
+ "name": "SdkAppId",
540
+ "required": true,
541
+ "type": "int"
542
+ },
543
+ {
544
+ "default": "",
545
+ "document": "App名字",
546
+ "member": "string",
547
+ "name": "AppName",
548
+ "required": false,
549
+ "type": "string"
550
+ },
551
+ {
552
+ "default": "",
553
+ "document": "创建IM应用需要的SKey",
554
+ "member": "string",
555
+ "name": "SKey",
556
+ "required": false,
557
+ "type": "string"
558
+ },
559
+ {
560
+ "default": "",
561
+ "document": "创建IM应用需要的TinyId",
562
+ "member": "string",
563
+ "name": "TinyId",
564
+ "required": false,
565
+ "type": "string"
566
+ },
567
+ {
568
+ "default": "",
569
+ "document": "需要绑定的标签列表",
570
+ "member": "Tag",
571
+ "name": "TagList",
572
+ "required": false,
573
+ "type": "list"
574
+ }
575
+ ],
576
+ "type": "object"
577
+ },
578
+ "CreateApplicationResponse": {
579
+ "document": "CreateApplication返回参数结构体",
580
+ "members": [
581
+ {
582
+ "document": "客户的AppId",
583
+ "member": "int64",
584
+ "name": "AppId",
585
+ "type": "int",
586
+ "value_allowed_null": false
587
+ },
588
+ {
589
+ "document": "App名字",
590
+ "member": "string",
591
+ "name": "AppName",
592
+ "type": "string",
593
+ "value_allowed_null": false
594
+ },
595
+ {
596
+ "document": "应用SdkAppId",
597
+ "member": "int64",
598
+ "name": "SdkAppId",
599
+ "type": "int",
600
+ "value_allowed_null": false
601
+ },
602
+ {
603
+ "document": "唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。",
604
+ "member": "string",
605
+ "name": "RequestId",
606
+ "type": "string"
607
+ }
608
+ ],
609
+ "type": "object"
610
+ },
611
+ "CreateOfflineRecordRequest": {
612
+ "document": "CreateOfflineRecord请求参数结构体",
613
+ "members": [
614
+ {
615
+ "default": "",
616
+ "document": "客户的SdkAppId",
617
+ "member": "int64",
618
+ "name": "SdkAppId",
619
+ "required": true,
620
+ "type": "int"
621
+ },
622
+ {
623
+ "default": "",
624
+ "document": "录制任务对应的房间号",
625
+ "member": "int64",
626
+ "name": "RoomId",
627
+ "required": true,
628
+ "type": "int"
629
+ },
630
+ {
631
+ "default": "",
632
+ "document": "录制任务对应的群组Id",
633
+ "member": "string",
634
+ "name": "GroupId",
635
+ "required": false,
636
+ "type": "string"
637
+ },
638
+ {
639
+ "default": "",
640
+ "document": "混流参数配置\n目前课后录制暂未支持自定义混流布局Custom参数",
641
+ "member": "MixStream",
642
+ "name": "MixStream",
643
+ "required": false,
644
+ "type": "object"
645
+ },
646
+ {
647
+ "default": "",
648
+ "document": "白板参数配置",
649
+ "member": "Whiteboard",
650
+ "name": "Whiteboard",
651
+ "required": false,
652
+ "type": "object"
653
+ }
654
+ ],
655
+ "type": "object"
656
+ },
657
+ "CreateOfflineRecordResponse": {
658
+ "document": "CreateOfflineRecord返回参数结构体",
659
+ "members": [
660
+ {
661
+ "document": "唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。",
662
+ "member": "string",
663
+ "name": "RequestId",
664
+ "type": "string"
665
+ }
666
+ ],
667
+ "type": "object"
668
+ },
298
669
  "CreateSnapshotTaskRequest": {
299
670
  "document": "CreateSnapshotTask请求参数结构体",
300
671
  "members": [
@@ -598,39 +969,68 @@
598
969
  ],
599
970
  "usage": "in"
600
971
  },
601
- "DescribeOnlineRecordCallbackRequest": {
602
- "document": "DescribeOnlineRecordCallback请求参数结构体",
972
+ "DataItem": {
973
+ "document": "画图数据，Time/Value/Details",
603
974
  "members": [
604
975
  {
605
976
  "default": "",
606
- "document": "应用的SdkAppId",
607
- "example": "1400000001",
977
+ "document": "时间\n按月格式yyyy-mm\n按天格式yyyy-mm-dd\n按分钟格式 yyyy-mm-dd HH:MM:SS",
978
+ "member": "string",
979
+ "name": "Time",
980
+ "required": true,
981
+ "type": "string",
982
+ "value_allowed_null": false
983
+ },
984
+ {
985
+ "default": "",
986
+ "document": "画图所需要的值",
608
987
  "member": "int64",
609
- "name": "SdkAppId",
988
+ "name": "Value",
610
989
  "required": true,
611
- "type": "int"
990
+ "type": "int",
991
+ "value_allowed_null": false
992
+ },
993
+ {
994
+ "default": "",
995
+ "document": "各个具体指标的详情",
996
+ "member": "Detail",
997
+ "name": "Details",
998
+ "required": true,
999
+ "type": "list",
1000
+ "value_allowed_null": false
612
1001
  }
613
1002
  ],
614
- "type": "object"
1003
+ "usage": "out"
615
1004
  },
616
- "DescribeOnlineRecordCallbackResponse": {
617
- "document": "DescribeOnlineRecordCallback返回参数结构体",
1005
+ "DescribeAPIServiceRequest": {
1006
+ "document": "DescribeAPIService请求参数结构体",
618
1007
  "members": [
619
1008
  {
620
- "document": "实时录制事件回调地址，如果未设置回调地址，该字段为空字符串",
621
- "example": "https://example.com/online/callback",
1009
+ "default": "",
1010
+ "document": "目前支持的Service为cos:GetService，cdn:DescribeDomainsConfig",
622
1011
  "member": "string",
623
- "name": "Callback",
1012
+ "name": "Service",
624
1013
  "required": true,
625
- "type": "string",
626
- "value_allowed_null": false
1014
+ "type": "string"
627
1015
  },
628
1016
  {
629
- "document": "实时录制回调鉴权密钥",
630
- "example": "6vg9G7Fd",
1017
+ "default": "",
1018
+ "document": "JSON格式的请求参数",
631
1019
  "member": "string",
632
- "name": "CallbackKey",
633
- "required": true,
1020
+ "name": "Data",
1021
+ "required": false,
1022
+ "type": "string"
1023
+ }
1024
+ ],
1025
+ "type": "object"
1026
+ },
1027
+ "DescribeAPIServiceResponse": {
1028
+ "document": "DescribeAPIService返回参数结构体",
1029
+ "members": [
1030
+ {
1031
+ "document": "Json格式的响应数据",
1032
+ "member": "string",
1033
+ "name": "ResponseData",
634
1034
  "type": "string",
635
1035
  "value_allowed_null": false
636
1036
  },
@@ -643,159 +1043,113 @@
643
1043
  ],
644
1044
  "type": "object"
645
1045
  },
646
- "DescribeOnlineRecordRequest": {
647
- "document": "DescribeOnlineRecord请求参数结构体",
648
- "members": [
649
- {
650
- "default": "",
651
- "document": "客户的SdkAppId",
652
- "example": "1400000001",
653
- "member": "int64",
654
- "name": "SdkAppId",
655
- "required": true,
656
- "type": "int"
657
- },
658
- {
659
- "default": "",
660
- "document": "实时录制任务Id",
661
- "example": "ghucnligqtgtvk2624mb",
662
- "member": "string",
663
- "name": "TaskId",
664
- "required": true,
665
- "type": "string"
666
- }
667
- ],
1046
+ "DescribeApplicationInfosRequest": {
1047
+ "document": "DescribeApplicationInfos请求参数结构体",
1048
+ "members": [],
668
1049
  "type": "object"
669
1050
  },
670
- "DescribeOnlineRecordResponse": {
671
- "document": "DescribeOnlineRecord返回参数结构体",
1051
+ "DescribeApplicationInfosResponse": {
1052
+ "document": "DescribeApplicationInfos返回参数结构体",
672
1053
  "members": [
673
1054
  {
674
- "document": "录制结束原因，\n- AUTO: 房间内长时间没有音视频上行及白板操作导致自动停止录制\n- USER_CALL: 主动调用了停止录制接口\n- EXCEPTION: 录制异常结束\n- FORCE_STOP: 强制停止录制，一般是因为暂停超过90分钟或者录制总时长超过24小时。",
675
- "example": "USER_CALL",
676
- "member": "string",
677
- "name": "FinishReason",
678
- "required": true,
679
- "type": "string",
680
- "value_allowed_null": false
681
- },
682
- {
683
- "document": "需要查询结果的录制任务Id",
684
- "example": "ghucnligqtgtvk2624mb",
685
- "member": "string",
686
- "name": "TaskId",
687
- "required": true,
688
- "type": "string",
689
- "value_allowed_null": false
690
- },
691
- {
692
- "document": "录制任务状态\n- PREPARED: 表示录制正在准备中（进房/启动录制服务等操作）\n- RECORDING: 表示录制已开始\n- PAUSED: 表示录制已暂停\n- STOPPED: 表示录制已停止，正在处理并上传视频\n- FINISHED: 表示视频处理并上传完成，成功生成录制结果",
693
- "example": "FINISHED",
694
- "member": "string",
695
- "name": "Status",
1055
+ "document": "应用列表",
1056
+ "example": "无",
1057
+ "member": "ApplicationItem",
1058
+ "name": "ApplicationInfos",
696
1059
  "required": true,
697
- "type": "string",
1060
+ "type": "list",
698
1061
  "value_allowed_null": false
699
1062
  },
700
1063
  {
701
- "document": "房间号",
702
- "example": "880528",
1064
+ "document": "是否包含所有的应用，0-不包含，1-包含",
1065
+ "example": "1",
703
1066
  "member": "int64",
704
- "name": "RoomId",
1067
+ "name": "AllOption",
705
1068
  "required": true,
706
1069
  "type": "int",
707
1070
  "value_allowed_null": false
708
1071
  },
709
1072
  {
710
- "document": "白板的群组 Id",
711
- "example": "880528",
1073
+ "document": "唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。",
712
1074
  "member": "string",
713
- "name": "GroupId",
714
- "required": true,
715
- "type": "string",
716
- "value_allowed_null": false
717
- },
1075
+ "name": "RequestId",
1076
+ "type": "string"
1077
+ }
1078
+ ],
1079
+ "type": "object"
1080
+ },
1081
+ "DescribeApplicationUsageRequest": {
1082
+ "document": "DescribeApplicationUsage请求参数结构体",
1083
+ "members": [
718
1084
  {
719
- "document": "录制用户Id",
720
- "example": "tic_record_user_880528_test-01",
721
- "member": "string",
722
- "name": "RecordUserId",
1085
+ "default": "",
1086
+ "document": "用量开始时间（包括该时间点）",
1087
+ "example": "2019-10-01 00:00:00",
1088
+ "member": "datetime",
1089
+ "name": "BeginTime",
723
1090
  "required": true,
724
- "type": "string",
725
- "value_allowed_null": false
1091
+ "type": "string"
726
1092
  },
727
1093
  {
728
- "document": "实际开始录制时间，Unix 时间戳，单位秒",
729
- "example": "1568949369",
730
- "member": "int64",
731
- "name": "RecordStartTime",
1094
+ "default": "",
1095
+ "document": "用量结束时间（不包括该时间点）",
1096
+ "example": "2019-12-31 00:00:00",
1097
+ "member": "datetime",
1098
+ "name": "EndTime",
732
1099
  "required": true,
733
- "type": "int",
734
- "value_allowed_null": false
1100
+ "type": "string"
735
1101
  },
736
1102
  {
737
- "document": "实际停止录制时间，Unix 时间戳，单位秒",
738
- "example": "1568949392",
739
- "member": "int64",
740
- "name": "RecordStopTime",
1103
+ "default": "",
1104
+ "document": "白板子产品名",
1105
+ "example": "sp_tiw_ric",
1106
+ "member": "string",
1107
+ "name": "SubProduct",
741
1108
  "required": true,
742
- "type": "int",
743
- "value_allowed_null": false
1109
+ "type": "string"
744
1110
  },
745
1111
  {
746
- "document": "回放视频总时长（单位：毫秒）",
747
- "example": "18317",
748
- "member": "int64",
749
- "name": "TotalTime",
1112
+ "default": "",
1113
+ "document": "时间跨度单位\n- MONTHLY：月\n- DAILY：天\n- MINUTELY：分钟",
1114
+ "example": "DAILY",
1115
+ "member": "string",
1116
+ "name": "TimeLevel",
750
1117
  "required": true,
751
- "type": "int",
752
- "value_allowed_null": false
1118
+ "type": "string"
753
1119
  },
754
1120
  {
755
- "document": "录制过程中出现异常的次数",
756
- "example": "0",
1121
+ "default": "",
1122
+ "document": "白板应用的SdkAppId",
1123
+ "example": "1400000001",
757
1124
  "member": "int64",
758
- "name": "ExceptionCnt",
759
- "required": true,
760
- "type": "int",
761
- "value_allowed_null": false
1125
+ "name": "SdkAppId",
1126
+ "required": false,
1127
+ "type": "int"
762
1128
  },
763
1129
  {
764
- "document": "拼接视频中被忽略的时间段，只有开启视频拼接功能的时候，这个参数才是有效的",
765
- "example": "无",
766
- "member": "OmittedDuration",
767
- "name": "OmittedDurations",
768
- "required": true,
769
- "type": "list",
770
- "value_allowed_null": false
771
- },
1130
+ "default": "",
1131
+ "document": "true: 返回加权求和后的用量数据\nfalse: 返回原始用量数据",
1132
+ "example": "1",
1133
+ "member": "bool",
1134
+ "name": "IsWeighted",
1135
+ "required": false,
1136
+ "type": "bool"
1137
+ }
1138
+ ],
1139
+ "type": "object"
1140
+ },
1141
+ "DescribeApplicationUsageResponse": {
1142
+ "document": "DescribeApplicationUsage返回参数结构体",
1143
+ "members": [
772
1144
  {
773
- "document": "录制视频列表",
1145
+ "document": "画图所需的用量数据",
774
1146
  "example": "无",
775
- "member": "VideoInfo",
776
- "name": "VideoInfos",
1147
+ "member": "DataItem",
1148
+ "name": "Data",
777
1149
  "required": true,
778
1150
  "type": "list",
779
1151
  "value_allowed_null": false
780
1152
  },
781
- {
782
- "document": "回放URL，需配合信令播放器使用。此字段仅适用于`视频生成模式`\n注意：此字段可能返回 null，表示取不到有效值。",
783
- "example": "http://replayurl",
784
- "member": "string",
785
- "name": "ReplayUrl",
786
- "required": true,
787
- "type": "string",
788
- "value_allowed_null": true
789
- },
790
- {
791
- "document": "视频流在录制过程中断流次数\n注意：此字段可能返回 null，表示取不到有效值。",
792
- "example": "无",
793
- "member": "Interrupt",
794
- "name": "Interrupts",
795
- "required": true,
796
- "type": "list",
797
- "value_allowed_null": true
798
- },
799
1153
  {
800
1154
  "document": "唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。",
801
1155
  "member": "string",
@@ -805,8 +1159,8 @@
805
1159
  ],
806
1160
  "type": "object"
807
1161
  },
808
- "DescribeQualityMetricsRequest": {
809
- "document": "DescribeQualityMetrics请求参数结构体",
1162
+ "DescribeBoardSDKLogRequest": {
1163
+ "document": "DescribeBoardSDKLog请求参数结构体",
810
1164
  "members": [
811
1165
  {
812
1166
  "default": "",
@@ -819,64 +1173,109 @@
819
1173
  },
820
1174
  {
821
1175
  "default": "",
822
- "document": "开始时间，Unix时间戳，单位秒，时间跨度不能超过7天",
823
- "example": "1614691834",
824
- "member": "int64",
825
- "name": "StartTime",
1176
+ "document": "需要查询日志的白板房间号",
1177
+ "example": "10000",
1178
+ "member": "string",
1179
+ "name": "RoomId",
826
1180
  "required": true,
827
- "type": "int"
1181
+ "type": "string"
828
1182
  },
829
1183
  {
830
1184
  "default": "",
831
- "document": "结束时间，Unix时间戳，单位秒，时间跨度不能超过7天",
832
- "example": "1614691834",
1185
+ "document": "需要查询日志的用户ID",
1186
+ "example": "tic_web",
1187
+ "member": "string",
1188
+ "name": "UserId",
1189
+ "required": true,
1190
+ "type": "string"
1191
+ },
1192
+ {
1193
+ "default": "",
1194
+ "document": "查询时间段，Unix时间戳，单位毫秒，第一个值为开始时间戳，第二个值为结束时间",
1195
+ "example": "[1614519034000,1614691834999]",
833
1196
  "member": "int64",
834
- "name": "EndTime",
1197
+ "name": "TimeRange",
835
1198
  "required": true,
836
- "type": "int"
1199
+ "type": "list"
837
1200
  },
838
1201
  {
839
1202
  "default": "",
840
- "document": "查询的指标，目前支持以下值\n - image_load_total_count: 图片加载总数（单位，次）\n - image_load_fail_count: 图片加载失败数量（单位，次）\n - image_load_success_rate: 图片加载成功率（百分比）\n - ppt_load_total_count: PPT加载总数（单位，次）\n - ppt_load_fail_count: PPT加载失败总数（单位，次）\n - ppt_load_success_rate: PPT加载成功率（单位，百分比）\n - verify_sdk_total_count: 白板鉴权总次数（单位，次）\n - verify_sdk_fail_count: 白板鉴权失败次数（单位，次）\n - verify_sdk_success_rate: 白板鉴权成功率（单位，百分比）\n - verify_sdk_in_one_second_rate: 白板鉴权秒开率（单位，百分比）\n - verify_sdk_cost_avg: 白板鉴权耗时平均时间（单位，毫秒）",
841
- "example": "image_load_success_rate",
1203
+ "document": "聚合日志条数查询的桶的时间范围，如5m, 1h, 4h等",
1204
+ "example": "5m",
842
1205
  "member": "string",
843
- "name": "Metric",
1206
+ "name": "AggregationInterval",
844
1207
  "required": true,
845
1208
  "type": "string"
846
1209
  },
847
1210
  {
848
1211
  "default": "",
849
- "document": "聚合的时间维度，目前只支持1小时，输入值为\"1h\"",
850
- "example": "1h",
1212
+ "document": "额外的查询条件",
1213
+ "example": "action: addData",
851
1214
  "member": "string",
852
- "name": "Interval",
1215
+ "name": "Query",
1216
+ "required": false,
1217
+ "type": "string"
1218
+ },
1219
+ {
1220
+ "default": "",
1221
+ "document": "是否按时间升序排列",
1222
+ "example": "false",
1223
+ "member": "bool",
1224
+ "name": "Ascending",
1225
+ "required": false,
1226
+ "type": "bool"
1227
+ },
1228
+ {
1229
+ "default": "",
1230
+ "document": "用于递归拉取的上下文Key，在上一次请求中返回",
1231
+ "example": "空",
1232
+ "member": "string",
1233
+ "name": "Context",
853
1234
  "required": false,
854
1235
  "type": "string"
855
1236
  }
856
1237
  ],
857
1238
  "type": "object"
858
1239
  },
859
- "DescribeQualityMetricsResponse": {
860
- "document": "DescribeQualityMetrics返回参数结构体",
1240
+ "DescribeBoardSDKLogResponse": {
1241
+ "document": "DescribeBoardSDKLog返回参数结构体",
861
1242
  "members": [
862
1243
  {
863
- "document": "输入的查询指标",
864
- "example": "image_load_success_rate",
1244
+ "document": "总共能查到日志条数",
1245
+ "example": "65",
1246
+ "member": "int64",
1247
+ "name": "Total",
1248
+ "required": true,
1249
+ "type": "int",
1250
+ "value_allowed_null": false
1251
+ },
1252
+ {
1253
+ "document": "日志详细内容",
1254
+ "example": "[]",
865
1255
  "member": "string",
866
- "name": "Metric",
1256
+ "name": "Sources",
867
1257
  "required": true,
868
- "type": "string",
1258
+ "type": "list",
869
1259
  "value_allowed_null": false
870
1260
  },
871
1261
  {
872
- "document": "时间序列",
873
- "example": "无",
874
- "member": "TimeValue",
875
- "name": "Content",
1262
+ "document": "按时间段聚合后每个时间段的日志条数",
1263
+ "example": "[]",
1264
+ "member": "string",
1265
+ "name": "Buckets",
876
1266
  "required": true,
877
1267
  "type": "list",
878
1268
  "value_allowed_null": false
879
1269
  },
1270
+ {
1271
+ "document": "用于递归拉取的上下文Key，下一次请求的时候带上",
1272
+ "example": "空",
1273
+ "member": "string",
1274
+ "name": "Context",
1275
+ "required": true,
1276
+ "type": "string",
1277
+ "value_allowed_null": false
1278
+ },
880
1279
  {
881
1280
  "document": "唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。",
882
1281
  "member": "string",
@@ -886,23 +1285,30 @@
886
1285
  ],
887
1286
  "type": "object"
888
1287
  },
889
- "DescribeSnapshotTaskRequest": {
890
- "document": "DescribeSnapshotTask请求参数结构体",
1288
+ "DescribeIMApplicationsRequest": {
1289
+ "document": "DescribeIMApplications请求参数结构体",
1290
+ "members": [],
1291
+ "type": "object"
1292
+ },
1293
+ "DescribeIMApplicationsResponse": {
1294
+ "document": "DescribeIMApplications返回参数结构体",
891
1295
  "members": [
892
1296
  {
893
- "default": "",
894
- "document": "查询任务ID",
895
- "example": "f2e1728c-6e87-4481-abe1-cde8542a5a10",
1297
+ "document": "唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。",
896
1298
  "member": "string",
897
- "name": "TaskID",
898
- "required": true,
1299
+ "name": "RequestId",
899
1300
  "type": "string"
900
- },
1301
+ }
1302
+ ],
1303
+ "type": "object"
1304
+ },
1305
+ "DescribeOfflineRecordCallbackRequest": {
1306
+ "document": "DescribeOfflineRecordCallback请求参数结构体",
1307
+ "members": [
901
1308
  {
902
1309
  "default": "",
903
- "document": "任务SdkAppId",
904
- "example": "1400124720",
905
- "member": "uint64",
1310
+ "document": "应用的SdkAppId",
1311
+ "member": "int64",
906
1312
  "name": "SdkAppId",
907
1313
  "required": true,
908
1314
  "type": "int"
@@ -910,53 +1316,715 @@
910
1316
  ],
911
1317
  "type": "object"
912
1318
  },
913
- "DescribeSnapshotTaskResponse": {
914
- "document": "DescribeSnapshotTask返回参数结构体",
1319
+ "DescribeOfflineRecordCallbackResponse": {
1320
+ "document": "DescribeOfflineRecordCallback返回参数结构体",
915
1321
  "members": [
916
1322
  {
917
- "document": "任务ID\n注意：此字段可能返回 null，表示取不到有效值。",
918
- "example": "f2e1728c-6e87-4481-abe1-cde8542a5a10",
1323
+ "document": "唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。",
919
1324
  "member": "string",
920
- "name": "TaskID",
921
- "required": true,
922
- "type": "string",
923
- "value_allowed_null": true
924
- },
925
- {
926
- "document": "任务状态\nRunning - 任务执行中\nFinished - 任务已结束\n注意：此字段可能返回 null，表示取不到有效值。",
1325
+ "name": "RequestId",
1326
+ "type": "string"
1327
+ }
1328
+ ],
1329
+ "type": "object"
1330
+ },
1331
+ "DescribeOfflineRecordRequest": {
1332
+ "document": "DescribeOfflineRecord请求参数结构体",
1333
+ "members": [
1334
+ {
1335
+ "default": "",
1336
+ "document": "客户的SdkAppId",
1337
+ "member": "int64",
1338
+ "name": "SdkAppId",
1339
+ "required": true,
1340
+ "type": "int"
1341
+ },
1342
+ {
1343
+ "default": "",
1344
+ "document": "课后录制任务的Id",
1345
+ "member": "string",
1346
+ "name": "TaskId",
1347
+ "required": true,
1348
+ "type": "string"
1349
+ }
1350
+ ],
1351
+ "type": "object"
1352
+ },
1353
+ "DescribeOfflineRecordResponse": {
1354
+ "document": "DescribeOfflineRecord返回参数结构体",
1355
+ "members": [
1356
+ {
1357
+ "document": "唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。",
1358
+ "member": "string",
1359
+ "name": "RequestId",
1360
+ "type": "string"
1361
+ }
1362
+ ],
1363
+ "type": "object"
1364
+ },
1365
+ "DescribeOnlineRecordCallbackRequest": {
1366
+ "document": "DescribeOnlineRecordCallback请求参数结构体",
1367
+ "members": [
1368
+ {
1369
+ "default": "",
1370
+ "document": "应用的SdkAppId",
1371
+ "example": "1400000001",
1372
+ "member": "int64",
1373
+ "name": "SdkAppId",
1374
+ "required": true,
1375
+ "type": "int"
1376
+ }
1377
+ ],
1378
+ "type": "object"
1379
+ },
1380
+ "DescribeOnlineRecordCallbackResponse": {
1381
+ "document": "DescribeOnlineRecordCallback返回参数结构体",
1382
+ "members": [
1383
+ {
1384
+ "document": "实时录制事件回调地址，如果未设置回调地址，该字段为空字符串",
1385
+ "example": "https://example.com/online/callback",
1386
+ "member": "string",
1387
+ "name": "Callback",
1388
+ "required": true,
1389
+ "type": "string",
1390
+ "value_allowed_null": false
1391
+ },
1392
+ {
1393
+ "document": "实时录制回调鉴权密钥",
1394
+ "example": "6vg9G7Fd",
1395
+ "member": "string",
1396
+ "name": "CallbackKey",
1397
+ "required": true,
1398
+ "type": "string",
1399
+ "value_allowed_null": false
1400
+ },
1401
+ {
1402
+ "document": "唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。",
1403
+ "member": "string",
1404
+ "name": "RequestId",
1405
+ "type": "string"
1406
+ }
1407
+ ],
1408
+ "type": "object"
1409
+ },
1410
+ "DescribeOnlineRecordRequest": {
1411
+ "document": "DescribeOnlineRecord请求参数结构体",
1412
+ "members": [
1413
+ {
1414
+ "default": "",
1415
+ "document": "客户的SdkAppId",
1416
+ "example": "1400000001",
1417
+ "member": "int64",
1418
+ "name": "SdkAppId",
1419
+ "required": true,
1420
+ "type": "int"
1421
+ },
1422
+ {
1423
+ "default": "",
1424
+ "document": "实时录制任务Id",
1425
+ "example": "ghucnligqtgtvk2624mb",
1426
+ "member": "string",
1427
+ "name": "TaskId",
1428
+ "required": true,
1429
+ "type": "string"
1430
+ }
1431
+ ],
1432
+ "type": "object"
1433
+ },
1434
+ "DescribeOnlineRecordResponse": {
1435
+ "document": "DescribeOnlineRecord返回参数结构体",
1436
+ "members": [
1437
+ {
1438
+ "document": "录制结束原因，\n- AUTO: 房间内长时间没有音视频上行及白板操作导致自动停止录制\n- USER_CALL: 主动调用了停止录制接口\n- EXCEPTION: 录制异常结束\n- FORCE_STOP: 强制停止录制，一般是因为暂停超过90分钟或者录制总时长超过24小时。",
1439
+ "example": "USER_CALL",
1440
+ "member": "string",
1441
+ "name": "FinishReason",
1442
+ "required": true,
1443
+ "type": "string",
1444
+ "value_allowed_null": false
1445
+ },
1446
+ {
1447
+ "document": "需要查询结果的录制任务Id",
1448
+ "example": "ghucnligqtgtvk2624mb",
1449
+ "member": "string",
1450
+ "name": "TaskId",
1451
+ "required": true,
1452
+ "type": "string",
1453
+ "value_allowed_null": false
1454
+ },
1455
+ {
1456
+ "document": "录制任务状态\n- PREPARED: 表示录制正在准备中（进房/启动录制服务等操作）\n- RECORDING: 表示录制已开始\n- PAUSED: 表示录制已暂停\n- STOPPED: 表示录制已停止，正在处理并上传视频\n- FINISHED: 表示视频处理并上传完成，成功生成录制结果",
1457
+ "example": "FINISHED",
1458
+ "member": "string",
1459
+ "name": "Status",
1460
+ "required": true,
1461
+ "type": "string",
1462
+ "value_allowed_null": false
1463
+ },
1464
+ {
1465
+ "document": "房间号",
1466
+ "example": "880528",
1467
+ "member": "int64",
1468
+ "name": "RoomId",
1469
+ "required": true,
1470
+ "type": "int",
1471
+ "value_allowed_null": false
1472
+ },
1473
+ {
1474
+ "document": "白板的群组 Id",
1475
+ "example": "880528",
1476
+ "member": "string",
1477
+ "name": "GroupId",
1478
+ "required": true,
1479
+ "type": "string",
1480
+ "value_allowed_null": false
1481
+ },
1482
+ {
1483
+ "document": "录制用户Id",
1484
+ "example": "tic_record_user_880528_test-01",
1485
+ "member": "string",
1486
+ "name": "RecordUserId",
1487
+ "required": true,
1488
+ "type": "string",
1489
+ "value_allowed_null": false
1490
+ },
1491
+ {
1492
+ "document": "实际开始录制时间，Unix 时间戳，单位秒",
1493
+ "example": "1568949369",
1494
+ "member": "int64",
1495
+ "name": "RecordStartTime",
1496
+ "required": true,
1497
+ "type": "int",
1498
+ "value_allowed_null": false
1499
+ },
1500
+ {
1501
+ "document": "实际停止录制时间，Unix 时间戳，单位秒",
1502
+ "example": "1568949392",
1503
+ "member": "int64",
1504
+ "name": "RecordStopTime",
1505
+ "required": true,
1506
+ "type": "int",
1507
+ "value_allowed_null": false
1508
+ },
1509
+ {
1510
+ "document": "回放视频总时长（单位：毫秒）",
1511
+ "example": "18317",
1512
+ "member": "int64",
1513
+ "name": "TotalTime",
1514
+ "required": true,
1515
+ "type": "int",
1516
+ "value_allowed_null": false
1517
+ },
1518
+ {
1519
+ "document": "录制过程中出现异常的次数",
1520
+ "example": "0",
1521
+ "member": "int64",
1522
+ "name": "ExceptionCnt",
1523
+ "required": true,
1524
+ "type": "int",
1525
+ "value_allowed_null": false
1526
+ },
1527
+ {
1528
+ "document": "拼接视频中被忽略的时间段，只有开启视频拼接功能的时候，这个参数才是有效的",
1529
+ "example": "无",
1530
+ "member": "OmittedDuration",
1531
+ "name": "OmittedDurations",
1532
+ "required": true,
1533
+ "type": "list",
1534
+ "value_allowed_null": false
1535
+ },
1536
+ {
1537
+ "document": "录制视频列表",
1538
+ "example": "无",
1539
+ "member": "VideoInfo",
1540
+ "name": "VideoInfos",
1541
+ "required": true,
1542
+ "type": "list",
1543
+ "value_allowed_null": false
1544
+ },
1545
+ {
1546
+ "document": "回放URL，需配合信令播放器使用。此字段仅适用于`视频生成模式`\n注意：此字段可能返回 null，表示取不到有效值。",
1547
+ "example": "http://replayurl",
1548
+ "member": "string",
1549
+ "name": "ReplayUrl",
1550
+ "required": true,
1551
+ "type": "string",
1552
+ "value_allowed_null": true
1553
+ },
1554
+ {
1555
+ "document": "视频流在录制过程中断流次数\n注意：此字段可能返回 null，表示取不到有效值。",
1556
+ "example": "无",
1557
+ "member": "Interrupt",
1558
+ "name": "Interrupts",
1559
+ "required": true,
1560
+ "type": "list",
1561
+ "value_allowed_null": true
1562
+ },
1563
+ {
1564
+ "document": "唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。",
1565
+ "member": "string",
1566
+ "name": "RequestId",
1567
+ "type": "string"
1568
+ }
1569
+ ],
1570
+ "type": "object"
1571
+ },
1572
+ "DescribePostpaidUsageRequest": {
1573
+ "document": "DescribePostpaidUsage请求参数结构体",
1574
+ "members": [
1575
+ {
1576
+ "default": "",
1577
+ "document": "开始时间",
1578
+ "member": "datetime",
1579
+ "name": "BeginTime",
1580
+ "required": true,
1581
+ "type": "string"
1582
+ },
1583
+ {
1584
+ "default": "",
1585
+ "document": "结束时间",
1586
+ "member": "datetime",
1587
+ "name": "EndTime",
1588
+ "required": true,
1589
+ "type": "string"
1590
+ }
1591
+ ],
1592
+ "type": "object"
1593
+ },
1594
+ "DescribePostpaidUsageResponse": {
1595
+ "document": "DescribePostpaidUsage返回参数结构体",
1596
+ "members": [
1597
+ {
1598
+ "document": "唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。",
1599
+ "member": "string",
1600
+ "name": "RequestId",
1601
+ "type": "string"
1602
+ }
1603
+ ],
1604
+ "type": "object"
1605
+ },
1606
+ "DescribeQualityMetricsRequest": {
1607
+ "document": "DescribeQualityMetrics请求参数结构体",
1608
+ "members": [
1609
+ {
1610
+ "default": "",
1611
+ "document": "白板应用的SdkAppId",
1612
+ "example": "1400000001",
1613
+ "member": "int64",
1614
+ "name": "SdkAppId",
1615
+ "required": true,
1616
+ "type": "int"
1617
+ },
1618
+ {
1619
+ "default": "",
1620
+ "document": "开始时间，Unix时间戳，单位秒，时间跨度不能超过7天",
1621
+ "example": "1614691834",
1622
+ "member": "int64",
1623
+ "name": "StartTime",
1624
+ "required": true,
1625
+ "type": "int"
1626
+ },
1627
+ {
1628
+ "default": "",
1629
+ "document": "结束时间，Unix时间戳，单位秒，时间跨度不能超过7天",
1630
+ "example": "1614691834",
1631
+ "member": "int64",
1632
+ "name": "EndTime",
1633
+ "required": true,
1634
+ "type": "int"
1635
+ },
1636
+ {
1637
+ "default": "",
1638
+ "document": "查询的指标，目前支持以下值\n - image_load_total_count: 图片加载总数（单位，次）\n - image_load_fail_count: 图片加载失败数量（单位，次）\n - image_load_success_rate: 图片加载成功率（百分比）\n - ppt_load_total_count: PPT加载总数（单位，次）\n - ppt_load_fail_count: PPT加载失败总数（单位，次）\n - ppt_load_success_rate: PPT加载成功率（单位，百分比）\n - verify_sdk_total_count: 白板鉴权总次数（单位，次）\n - verify_sdk_fail_count: 白板鉴权失败次数（单位，次）\n - verify_sdk_success_rate: 白板鉴权成功率（单位，百分比）\n - verify_sdk_in_one_second_rate: 白板鉴权秒开率（单位，百分比）\n - verify_sdk_cost_avg: 白板鉴权耗时平均时间（单位，毫秒）",
1639
+ "example": "image_load_success_rate",
1640
+ "member": "string",
1641
+ "name": "Metric",
1642
+ "required": true,
1643
+ "type": "string"
1644
+ },
1645
+ {
1646
+ "default": "",
1647
+ "document": "聚合的时间维度，目前只支持1小时，输入值为\"1h\"",
1648
+ "example": "1h",
1649
+ "member": "string",
1650
+ "name": "Interval",
1651
+ "required": false,
1652
+ "type": "string"
1653
+ }
1654
+ ],
1655
+ "type": "object"
1656
+ },
1657
+ "DescribeQualityMetricsResponse": {
1658
+ "document": "DescribeQualityMetrics返回参数结构体",
1659
+ "members": [
1660
+ {
1661
+ "document": "输入的查询指标",
1662
+ "example": "image_load_success_rate",
1663
+ "member": "string",
1664
+ "name": "Metric",
1665
+ "required": true,
1666
+ "type": "string",
1667
+ "value_allowed_null": false
1668
+ },
1669
+ {
1670
+ "document": "时间序列",
1671
+ "example": "无",
1672
+ "member": "TimeValue",
1673
+ "name": "Content",
1674
+ "required": true,
1675
+ "type": "list",
1676
+ "value_allowed_null": false
1677
+ },
1678
+ {
1679
+ "document": "唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。",
1680
+ "member": "string",
1681
+ "name": "RequestId",
1682
+ "type": "string"
1683
+ }
1684
+ ],
1685
+ "type": "object"
1686
+ },
1687
+ "DescribeRoomListRequest": {
1688
+ "document": "DescribeRoomList请求参数结构体",
1689
+ "members": [
1690
+ {
1691
+ "default": "",
1692
+ "document": "白板应用的SdkAppId",
1693
+ "example": "1400000001",
1694
+ "member": "int64",
1695
+ "name": "SdkAppId",
1696
+ "required": true,
1697
+ "type": "int"
1698
+ },
1699
+ {
1700
+ "default": "",
1701
+ "document": "查询时间段，Unix时间戳，单位毫秒，第一个值为开始时间戳，第二个值为结束时间",
1702
+ "example": "[1614519034000,1614691834999]",
1703
+ "member": "int64",
1704
+ "name": "TimeRange",
1705
+ "required": true,
1706
+ "type": "list"
1707
+ },
1708
+ {
1709
+ "default": "",
1710
+ "document": "额外的查询条件",
1711
+ "example": "action: addData",
1712
+ "member": "string",
1713
+ "name": "Query",
1714
+ "required": false,
1715
+ "type": "string"
1716
+ },
1717
+ {
1718
+ "default": "",
1719
+ "document": "返回最大的数据条数，默认1000",
1720
+ "example": "1000",
1721
+ "member": "int64",
1722
+ "name": "MaxSize",
1723
+ "required": false,
1724
+ "type": "int"
1725
+ }
1726
+ ],
1727
+ "type": "object"
1728
+ },
1729
+ "DescribeRoomListResponse": {
1730
+ "document": "DescribeRoomList返回参数结构体",
1731
+ "members": [
1732
+ {
1733
+ "document": "白板房间列表",
1734
+ "example": "[]",
1735
+ "member": "RoomListItem",
1736
+ "name": "RoomList",
1737
+ "required": true,
1738
+ "type": "list",
1739
+ "value_allowed_null": false
1740
+ },
1741
+ {
1742
+ "document": "唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。",
1743
+ "member": "string",
1744
+ "name": "RequestId",
1745
+ "type": "string"
1746
+ }
1747
+ ],
1748
+ "type": "object"
1749
+ },
1750
+ "DescribeSnapshotTaskRequest": {
1751
+ "document": "DescribeSnapshotTask请求参数结构体",
1752
+ "members": [
1753
+ {
1754
+ "default": "",
1755
+ "document": "查询任务ID",
1756
+ "example": "f2e1728c-6e87-4481-abe1-cde8542a5a10",
1757
+ "member": "string",
1758
+ "name": "TaskID",
1759
+ "required": true,
1760
+ "type": "string"
1761
+ },
1762
+ {
1763
+ "default": "",
1764
+ "document": "任务SdkAppId",
1765
+ "example": "1400124720",
1766
+ "member": "uint64",
1767
+ "name": "SdkAppId",
1768
+ "required": true,
1769
+ "type": "int"
1770
+ }
1771
+ ],
1772
+ "type": "object"
1773
+ },
1774
+ "DescribeSnapshotTaskResponse": {
1775
+ "document": "DescribeSnapshotTask返回参数结构体",
1776
+ "members": [
1777
+ {
1778
+ "document": "任务ID\n注意：此字段可能返回 null，表示取不到有效值。",
1779
+ "example": "f2e1728c-6e87-4481-abe1-cde8542a5a10",
1780
+ "member": "string",
1781
+ "name": "TaskID",
1782
+ "required": true,
1783
+ "type": "string",
1784
+ "value_allowed_null": true
1785
+ },
1786
+ {
1787
+ "document": "任务状态\nRunning - 任务执行中\nFinished - 任务已结束\n注意：此字段可能返回 null，表示取不到有效值。",
927
1788
  "example": "Finished",
928
1789
  "member": "string",
929
1790
  "name": "Status",
930
1791
  "required": true,
931
- "type": "string",
932
- "value_allowed_null": true
1792
+ "type": "string",
1793
+ "value_allowed_null": true
1794
+ },
1795
+ {
1796
+ "document": "任务创建时间，单位s\n注意：此字段可能返回 null，表示取不到有效值。",
1797
+ "example": "1620982173",
1798
+ "member": "uint64",
1799
+ "name": "CreateTime",
1800
+ "required": true,
1801
+ "type": "int",
1802
+ "value_allowed_null": true
1803
+ },
1804
+ {
1805
+ "document": "任务完成时间，单位s\n注意：此字段可能返回 null，表示取不到有效值。",
1806
+ "example": "1621082195",
1807
+ "member": "uint64",
1808
+ "name": "FinishTime",
1809
+ "required": true,
1810
+ "type": "int",
1811
+ "value_allowed_null": true
1812
+ },
1813
+ {
1814
+ "document": "任务结果信息\n注意：此字段可能返回 null，表示取不到有效值。",
1815
+ "example": "无",
1816
+ "member": "SnapshotResult",
1817
+ "name": "Result",
1818
+ "required": true,
1819
+ "type": "object",
1820
+ "value_allowed_null": true
1821
+ },
1822
+ {
1823
+ "document": "唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。",
1824
+ "member": "string",
1825
+ "name": "RequestId",
1826
+ "type": "string"
1827
+ }
1828
+ ],
1829
+ "type": "object"
1830
+ },
1831
+ "DescribeTIWDailyUsageRequest": {
1832
+ "document": "DescribeTIWDailyUsage请求参数结构体",
1833
+ "members": [
1834
+ {
1835
+ "default": "",
1836
+ "document": "互动白板应用SdkAppId",
1837
+ "example": "1400000001",
1838
+ "member": "int64",
1839
+ "name": "SdkAppId",
1840
+ "required": true,
1841
+ "type": "int"
1842
+ },
1843
+ {
1844
+ "default": "",
1845
+ "document": "需要查询的子产品用量，支持传入以下值\n- sp_tiw_board: 互动白板时长，单位为分钟\n- sp_tiw_dt: 动态转码页数，单位页\n- sp_tiw_st: 静态转码页数，单位页\n- sp_tiw_ric: 实时录制时长，单位分钟\n\n注意：动态转码以1:8的比例计算文档转码页数，静态转码以1:1的比例计算文档转码页数",
1846
+ "example": "sp_tiw_board",
1847
+ "member": "string",
1848
+ "name": "SubProduct",
1849
+ "required": true,
1850
+ "type": "string"
1851
+ },
1852
+ {
1853
+ "default": "",
1854
+ "document": "开始时间，格式YYYY-MM-DD，查询结果里包括该天数据",
1855
+ "example": "2021-10-01",
1856
+ "member": "date",
1857
+ "name": "StartTime",
1858
+ "required": true,
1859
+ "type": "string"
1860
+ },
1861
+ {
1862
+ "default": "",
1863
+ "document": "结束时间，格式YYYY-MM-DD，查询结果里包括该天数据，单次查询统计区间最多不能超过31天。",
1864
+ "example": "2021-10-31",
1865
+ "member": "date",
1866
+ "name": "EndTime",
1867
+ "required": true,
1868
+ "type": "string"
1869
+ }
1870
+ ],
1871
+ "type": "object"
1872
+ },
1873
+ "DescribeTIWDailyUsageResponse": {
1874
+ "document": "DescribeTIWDailyUsage返回参数结构体",
1875
+ "members": [
1876
+ {
1877
+ "document": "指定区间指定产品的用量汇总",
1878
+ "example": "无",
1879
+ "member": "UsageDataItem",
1880
+ "name": "Usages",
1881
+ "required": true,
1882
+ "type": "list",
1883
+ "value_allowed_null": false
1884
+ },
1885
+ {
1886
+ "document": "唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。",
1887
+ "member": "string",
1888
+ "name": "RequestId",
1889
+ "type": "string"
1890
+ }
1891
+ ],
1892
+ "type": "object"
1893
+ },
1894
+ "DescribeTIWRoomDailyUsageRequest": {
1895
+ "document": "DescribeTIWRoomDailyUsage请求参数结构体",
1896
+ "members": [
1897
+ {
1898
+ "default": "",
1899
+ "document": "互动白板应用SdkAppId",
1900
+ "example": "1400000001",
1901
+ "member": "int64",
1902
+ "name": "SdkAppId",
1903
+ "required": true,
1904
+ "type": "int"
1905
+ },
1906
+ {
1907
+ "default": "",
1908
+ "document": "需要查询的子产品用量，支持传入以下值\n- sp_tiw_board: 互动白板时长，单位为分钟\n- sp_tiw_ric: 实时录制时长，单位分钟",
1909
+ "example": "sp_tiw_board",
1910
+ "member": "string",
1911
+ "name": "SubProduct",
1912
+ "required": true,
1913
+ "type": "string"
1914
+ },
1915
+ {
1916
+ "default": "",
1917
+ "document": "开始时间，格式YYYY-MM-DD，查询结果里包括该天数据",
1918
+ "example": "2021-10-01",
1919
+ "member": "date",
1920
+ "name": "StartTime",
1921
+ "required": true,
1922
+ "type": "string"
1923
+ },
1924
+ {
1925
+ "default": "",
1926
+ "document": "结束时间，格式YYYY-MM-DD，查询结果里包括该天数据，单次查询统计区间最多不能超过31天。",
1927
+ "example": "2021-10-31",
1928
+ "member": "date",
1929
+ "name": "EndTime",
1930
+ "required": true,
1931
+ "type": "string"
1932
+ },
1933
+ {
1934
+ "default": "",
1935
+ "document": "需要查询的房间ID列表，不填默认查询全部房间",
1936
+ "example": "无",
1937
+ "member": "uint64",
1938
+ "name": "RoomIDs",
1939
+ "required": false,
1940
+ "type": "list"
1941
+ },
1942
+ {
1943
+ "default": "",
1944
+ "document": "查询偏移量，默认为0",
1945
+ "example": "0",
1946
+ "member": "uint64",
1947
+ "name": "Offset",
1948
+ "required": false,
1949
+ "type": "int"
1950
+ },
1951
+ {
1952
+ "default": "",
1953
+ "document": "每次查询返回条目限制，默认为20",
1954
+ "example": "20",
1955
+ "member": "uint64",
1956
+ "name": "Limit",
1957
+ "required": false,
1958
+ "type": "int"
1959
+ }
1960
+ ],
1961
+ "type": "object"
1962
+ },
1963
+ "DescribeTIWRoomDailyUsageResponse": {
1964
+ "document": "DescribeTIWRoomDailyUsage返回参数结构体",
1965
+ "members": [
1966
+ {
1967
+ "document": "指定区间指定产品的房间用量列表",
1968
+ "example": "无",
1969
+ "member": "RoomUsageDataItem",
1970
+ "name": "Usages",
1971
+ "required": true,
1972
+ "type": "list",
1973
+ "value_allowed_null": false
933
1974
  },
934
1975
  {
935
- "document": "任务创建时间，单位s\n注意：此字段可能返回 null，表示取不到有效值。",
936
- "example": "1620982173",
1976
+ "document": "用量列表总数",
1977
+ "example": "10",
937
1978
  "member": "uint64",
938
- "name": "CreateTime",
1979
+ "name": "Total",
939
1980
  "required": true,
940
1981
  "type": "int",
941
- "value_allowed_null": true
1982
+ "value_allowed_null": false
942
1983
  },
943
1984
  {
944
- "document": "任务完成时间，单位s\n注意：此字段可能返回 null，表示取不到有效值。",
945
- "example": "1621082195",
946
- "member": "uint64",
947
- "name": "FinishTime",
1985
+ "document": "唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。",
1986
+ "member": "string",
1987
+ "name": "RequestId",
1988
+ "type": "string"
1989
+ }
1990
+ ],
1991
+ "type": "object"
1992
+ },
1993
+ "DescribeTranscodeCallbackRequest": {
1994
+ "document": "DescribeTranscodeCallback请求参数结构体",
1995
+ "members": [
1996
+ {
1997
+ "default": "",
1998
+ "document": "应用的SdkAppId",
1999
+ "example": "1400000001",
2000
+ "member": "int64",
2001
+ "name": "SdkAppId",
948
2002
  "required": true,
949
- "type": "int",
950
- "value_allowed_null": true
2003
+ "type": "int"
2004
+ }
2005
+ ],
2006
+ "type": "object"
2007
+ },
2008
+ "DescribeTranscodeCallbackResponse": {
2009
+ "document": "DescribeTranscodeCallback返回参数结构体",
2010
+ "members": [
2011
+ {
2012
+ "document": "文档转码回调地址",
2013
+ "example": "https://example.com/transcode/callback",
2014
+ "member": "string",
2015
+ "name": "Callback",
2016
+ "required": true,
2017
+ "type": "string",
2018
+ "value_allowed_null": false
951
2019
  },
952
2020
  {
953
- "document": "任务结果信息\n注意：此字段可能返回 null，表示取不到有效值。",
954
- "example": "无",
955
- "member": "SnapshotResult",
956
- "name": "Result",
2021
+ "document": "文档转码回调鉴权密钥",
2022
+ "example": "6vg9G7Fd",
2023
+ "member": "string",
2024
+ "name": "CallbackKey",
957
2025
  "required": true,
958
- "type": "object",
959
- "value_allowed_null": true
2026
+ "type": "string",
2027
+ "value_allowed_null": false
960
2028
  },
961
2029
  {
962
2030
  "document": "唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。",
@@ -967,12 +2035,11 @@
967
2035
  ],
968
2036
  "type": "object"
969
2037
  },
970
- "DescribeTIWDailyUsageRequest": {
971
- "document": "DescribeTIWDailyUsage请求参数结构体",
2038
+ "DescribeTranscodeRequest": {
2039
+ "document": "DescribeTranscode请求参数结构体",
972
2040
  "members": [
973
2041
  {
974
- "default": "",
975
- "document": "互动白板应用SdkAppId",
2042
+ "document": "客户的SdkAppId",
976
2043
  "example": "1400000001",
977
2044
  "member": "int64",
978
2045
  "name": "SdkAppId",
@@ -980,47 +2047,200 @@
980
2047
  "type": "int"
981
2048
  },
982
2049
  {
983
- "default": "",
984
- "document": "需要查询的子产品用量，支持传入以下值\n- sp_tiw_board: 互动白板时长，单位为分钟\n- sp_tiw_dt: 动态转码页数，单位页\n- sp_tiw_st: 静态转码页数，单位页\n- sp_tiw_ric: 实时录制时长，单位分钟\n\n注意：动态转码以1:8的比例计算文档转码页数，静态转码以1:1的比例计算文档转码页数",
985
- "example": "sp_tiw_board",
2050
+ "document": "文档转码任务的唯一标识Id",
2051
+ "example": "g0jb42ps49vtebjshilb",
986
2052
  "member": "string",
987
- "name": "SubProduct",
2053
+ "name": "TaskId",
988
2054
  "required": true,
989
2055
  "type": "string"
2056
+ }
2057
+ ],
2058
+ "type": "object"
2059
+ },
2060
+ "DescribeTranscodeResponse": {
2061
+ "document": "DescribeTranscode返回参数结构体",
2062
+ "members": [
2063
+ {
2064
+ "document": "文档的总页数",
2065
+ "example": "1",
2066
+ "member": "int64",
2067
+ "name": "Pages",
2068
+ "type": "int",
2069
+ "value_allowed_null": false
990
2070
  },
991
2071
  {
992
- "default": "",
993
- "document": "开始时间，格式YYYY-MM-DD，查询结果里包括该天数据",
994
- "example": "2021-10-01",
995
- "member": "date",
996
- "name": "StartTime",
997
- "required": true,
998
- "type": "string"
2072
+ "document": "转码的当前进度,取值范围为0~100",
2073
+ "example": "100",
2074
+ "member": "int64",
2075
+ "name": "Progress",
2076
+ "type": "int",
2077
+ "value_allowed_null": false
999
2078
  },
1000
2079
  {
1001
- "default": "",
1002
- "document": "结束时间，格式YYYY-MM-DD，查询结果里包括该天数据，单次查询统计区间最多不能超过31天。",
1003
- "example": "2021-10-31",
1004
- "member": "date",
1005
- "name": "EndTime",
1006
- "required": true,
2080
+ "document": "文档的分辨率",
2081
+ "example": "793x1122",
2082
+ "member": "string",
2083
+ "name": "Resolution",
2084
+ "type": "string",
2085
+ "value_allowed_null": false
2086
+ },
2087
+ {
2088
+ "document": "转码完成后结果的URL\n动态转码：PPT转动态H5的链接\n静态转码：文档每一页的图片URL前缀，比如，该URL前缀为`http://example.com/g0jb42ps49vtebjshilb/`，那么文档第1页的图片URL为\n`http://example.com/g0jb42ps49vtebjshilb/1.jpg`，其它页以此类推",
2089
+ "example": "https://transcode-result/0agdnligqtgtvkm65emb/index.html",
2090
+ "member": "string",
2091
+ "name": "ResultUrl",
2092
+ "type": "string",
2093
+ "value_allowed_null": false
2094
+ },
2095
+ {
2096
+ "document": "任务的当前状态\n- QUEUED: 正在排队等待转换\n- PROCESSING: 转换中\n- FINISHED: 转换完成",
2097
+ "example": "FINISHED",
2098
+ "member": "string",
2099
+ "name": "Status",
2100
+ "type": "string",
2101
+ "value_allowed_null": false
2102
+ },
2103
+ {
2104
+ "document": "转码任务的唯一标识Id",
2105
+ "example": "0agdnligqtgtvkm65emb",
2106
+ "member": "string",
2107
+ "name": "TaskId",
2108
+ "type": "string",
2109
+ "value_allowed_null": false
2110
+ },
2111
+ {
2112
+ "document": "文档的文件名",
2113
+ "example": "59378.docx",
2114
+ "member": "string",
2115
+ "name": "Title",
2116
+ "type": "string",
2117
+ "value_allowed_null": false
2118
+ },
2119
+ {
2120
+ "document": "缩略图URL前缀，比如，该URL前缀为`http://example.com/g0jb42ps49vtebjshilb/ `，那么动态PPT第1页的缩略图URL为\n`http://example.com/g0jb42ps49vtebjshilb/1.jpg`，其它页以此类推\n\n如果发起文档转码请求参数中带了ThumbnailResolution参数，并且转码类型为动态转码，该参数不为空，其余情况该参数为空字符串",
2121
+ "example": "https://transcode-thumbnal/0agdnligqtgtvkm65emb/",
2122
+ "member": "string",
2123
+ "name": "ThumbnailUrl",
2124
+ "type": "string",
2125
+ "value_allowed_null": false
2126
+ },
2127
+ {
2128
+ "document": "动态转码缩略图生成分辨率",
2129
+ "example": "793x1122",
2130
+ "member": "string",
2131
+ "name": "ThumbnailResolution",
2132
+ "type": "string",
2133
+ "value_allowed_null": false
2134
+ },
2135
+ {
2136
+ "document": "转码压缩文件下载的URL，如果发起文档转码请求参数中`CompressFileType`为空或者不是支持的压缩格式，该参数为空字符串",
2137
+ "example": "无",
2138
+ "member": "string",
2139
+ "name": "CompressFileUrl",
2140
+ "type": "string",
2141
+ "value_allowed_null": false
2142
+ },
2143
+ {
2144
+ "document": "资源清单文件下载URL(内测体验)\n注意：此字段可能返回 null，表示取不到有效值。",
2145
+ "example": "无",
2146
+ "member": "string",
2147
+ "name": "ResourceListUrl",
2148
+ "type": "string",
2149
+ "value_allowed_null": true
2150
+ },
2151
+ {
2152
+ "document": "文档制作方式(内测体验)\n注意：此字段可能返回 null，表示取不到有效值。",
2153
+ "example": "office",
2154
+ "member": "string",
2155
+ "name": "Ext",
2156
+ "type": "string",
2157
+ "value_allowed_null": true
2158
+ },
2159
+ {
2160
+ "document": "唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。",
2161
+ "member": "string",
2162
+ "name": "RequestId",
1007
2163
  "type": "string"
1008
2164
  }
1009
2165
  ],
1010
2166
  "type": "object"
1011
2167
  },
1012
- "DescribeTIWDailyUsageResponse": {
1013
- "document": "DescribeTIWDailyUsage返回参数结构体",
2168
+ "DescribeTranscodeSearchRequest": {
2169
+ "document": "DescribeTranscodeSearch请求参数结构体",
2170
+ "members": [],
2171
+ "type": "object"
2172
+ },
2173
+ "DescribeTranscodeSearchResponse": {
2174
+ "document": "DescribeTranscodeSearch返回参数结构体",
1014
2175
  "members": [
1015
2176
  {
1016
- "document": "指定区间指定产品的用量汇总",
2177
+ "document": "转码任务搜索结果集合",
1017
2178
  "example": "无",
1018
- "member": "UsageDataItem",
1019
- "name": "Usages",
2179
+ "member": "TranscodeTaskSearchResult",
2180
+ "name": "TranscodeTaskSet",
1020
2181
  "required": true,
1021
2182
  "type": "list",
1022
2183
  "value_allowed_null": false
1023
2184
  },
2185
+ {
2186
+ "document": "转码总任务数",
2187
+ "example": "1340",
2188
+ "member": "int64",
2189
+ "name": "TotalCount",
2190
+ "required": true,
2191
+ "type": "int",
2192
+ "value_allowed_null": false
2193
+ },
2194
+ {
2195
+ "document": "唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。",
2196
+ "member": "string",
2197
+ "name": "RequestId",
2198
+ "type": "string"
2199
+ }
2200
+ ],
2201
+ "type": "object"
2202
+ },
2203
+ "DescribeUsageSummaryRequest": {
2204
+ "document": "DescribeUsageSummary请求参数结构体",
2205
+ "members": [
2206
+ {
2207
+ "default": "",
2208
+ "document": "统计时间段的开始时间",
2209
+ "member": "datetime",
2210
+ "name": "BeginTime",
2211
+ "required": true,
2212
+ "type": "string"
2213
+ },
2214
+ {
2215
+ "default": "",
2216
+ "document": "统计时间段的结束时间",
2217
+ "member": "datetime",
2218
+ "name": "EndTime",
2219
+ "required": true,
2220
+ "type": "string"
2221
+ },
2222
+ {
2223
+ "default": "",
2224
+ "document": "需要获取用量的子产品列表",
2225
+ "member": "string",
2226
+ "name": "SubProducts",
2227
+ "required": true,
2228
+ "type": "list"
2229
+ },
2230
+ {
2231
+ "default": "",
2232
+ "document": "true: 返回加权后的数据\nfalse: 返回原始数据",
2233
+ "member": "bool",
2234
+ "name": "IsWeighted",
2235
+ "required": false,
2236
+ "type": "bool"
2237
+ }
2238
+ ],
2239
+ "type": "object"
2240
+ },
2241
+ "DescribeUsageSummaryResponse": {
2242
+ "document": "DescribeUsageSummary返回参数结构体",
2243
+ "members": [
1024
2244
  {
1025
2245
  "document": "唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。",
1026
2246
  "member": "string",
@@ -1030,12 +2250,12 @@
1030
2250
  ],
1031
2251
  "type": "object"
1032
2252
  },
1033
- "DescribeTIWRoomDailyUsageRequest": {
1034
- "document": "DescribeTIWRoomDailyUsage请求参数结构体",
2253
+ "DescribeUserListRequest": {
2254
+ "document": "DescribeUserList请求参数结构体",
1035
2255
  "members": [
1036
2256
  {
1037
2257
  "default": "",
1038
- "document": "互动白板应用SdkAppId",
2258
+ "document": "白板应用的SdkAppId",
1039
2259
  "example": "1400000001",
1040
2260
  "member": "int64",
1041
2261
  "name": "SdkAppId",
@@ -1044,79 +2264,121 @@
1044
2264
  },
1045
2265
  {
1046
2266
  "default": "",
1047
- "document": "需要查询的子产品用量，支持传入以下值\n- sp_tiw_board: 互动白板时长，单位为分钟\n- sp_tiw_ric: 实时录制时长，单位分钟",
1048
- "example": "sp_tiw_board",
2267
+ "document": "需要查询用户列表的白板房间号",
2268
+ "example": "10000",
1049
2269
  "member": "string",
1050
- "name": "SubProduct",
1051
- "required": true,
1052
- "type": "string"
1053
- },
1054
- {
1055
- "default": "",
1056
- "document": "开始时间，格式YYYY-MM-DD，查询结果里包括该天数据",
1057
- "example": "2021-10-01",
1058
- "member": "date",
1059
- "name": "StartTime",
2270
+ "name": "RoomId",
1060
2271
  "required": true,
1061
2272
  "type": "string"
1062
2273
  },
1063
2274
  {
1064
2275
  "default": "",
1065
- "document": "结束时间，格式YYYY-MM-DD，查询结果里包括该天数据，单次查询统计区间最多不能超过31天。",
1066
- "example": "2021-10-31",
1067
- "member": "date",
1068
- "name": "EndTime",
2276
+ "document": "查询时间段，Unix时间戳，单位毫秒，第一个值为开始时间戳，第二个值为结束时间",
2277
+ "example": "[1614519034000,1614691834999]",
2278
+ "member": "int64",
2279
+ "name": "TimeRange",
1069
2280
  "required": true,
1070
- "type": "string"
1071
- },
1072
- {
1073
- "default": "",
1074
- "document": "需要查询的房间ID列表，不填默认查询全部房间",
1075
- "example": "无",
1076
- "member": "uint64",
1077
- "name": "RoomIDs",
1078
- "required": false,
1079
2281
  "type": "list"
1080
2282
  },
1081
2283
  {
1082
2284
  "default": "",
1083
- "document": "查询偏移量，默认为0",
1084
- "example": "0",
1085
- "member": "uint64",
1086
- "name": "Offset",
2285
+ "document": "额外的查询条件",
2286
+ "example": "action: addData",
2287
+ "member": "string",
2288
+ "name": "Query",
1087
2289
  "required": false,
1088
- "type": "int"
2290
+ "type": "string"
1089
2291
  },
1090
2292
  {
1091
2293
  "default": "",
1092
- "document": "每次查询返回条目限制，默认为20",
1093
- "example": "20",
1094
- "member": "uint64",
1095
- "name": "Limit",
2294
+ "document": "返回最大的数据条数，默认1000",
2295
+ "example": "1000",
2296
+ "member": "int64",
2297
+ "name": "MaxSize",
1096
2298
  "required": false,
1097
2299
  "type": "int"
1098
2300
  }
1099
2301
  ],
1100
2302
  "type": "object"
1101
2303
  },
1102
- "DescribeTIWRoomDailyUsageResponse": {
1103
- "document": "DescribeTIWRoomDailyUsage返回参数结构体",
2304
+ "DescribeUserListResponse": {
2305
+ "document": "DescribeUserList返回参数结构体",
1104
2306
  "members": [
1105
2307
  {
1106
- "document": "指定区间指定产品的房间用量列表",
1107
- "example": "无",
1108
- "member": "RoomUsageDataItem",
1109
- "name": "Usages",
2308
+ "document": "房间内的用户列表",
2309
+ "example": "[]",
2310
+ "member": "UserListItem",
2311
+ "name": "UserList",
1110
2312
  "required": true,
1111
2313
  "type": "list",
1112
2314
  "value_allowed_null": false
1113
2315
  },
1114
2316
  {
1115
- "document": "用量列表总数",
1116
- "example": "10",
1117
- "member": "uint64",
1118
- "name": "Total",
1119
- "required": true,
2317
+ "document": "唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。",
2318
+ "member": "string",
2319
+ "name": "RequestId",
2320
+ "type": "string"
2321
+ }
2322
+ ],
2323
+ "type": "object"
2324
+ },
2325
+ "DescribeUserResourcesRequest": {
2326
+ "document": "DescribeUserResources请求参数结构体",
2327
+ "members": [],
2328
+ "type": "object"
2329
+ },
2330
+ "DescribeUserResourcesResponse": {
2331
+ "document": "DescribeUserResources返回参数结构体",
2332
+ "members": [
2333
+ {
2334
+ "document": "唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。",
2335
+ "member": "string",
2336
+ "name": "RequestId",
2337
+ "type": "string"
2338
+ }
2339
+ ],
2340
+ "type": "object"
2341
+ },
2342
+ "DescribeUserStatusRequest": {
2343
+ "document": "DescribeUserStatus请求参数结构体",
2344
+ "members": [],
2345
+ "type": "object"
2346
+ },
2347
+ "DescribeUserStatusResponse": {
2348
+ "document": "DescribeUserStatus返回参数结构体",
2349
+ "members": [
2350
+ {
2351
+ "document": "客户的AppId",
2352
+ "member": "int64",
2353
+ "name": "AppId",
2354
+ "type": "int",
2355
+ "value_allowed_null": false
2356
+ },
2357
+ {
2358
+ "document": "是否开通过白板（试用或正式）\n\n0: 从未开通过白板服务\n1: 已经开通过白板服务",
2359
+ "member": "int64",
2360
+ "name": "IsTiwUser",
2361
+ "type": "int",
2362
+ "value_allowed_null": false
2363
+ },
2364
+ {
2365
+ "document": "是否开通过互动课堂（试用或正式）",
2366
+ "member": "int64",
2367
+ "name": "IsSaaSUser",
2368
+ "type": "int",
2369
+ "value_allowed_null": false
2370
+ },
2371
+ {
2372
+ "document": "是否使用白板的课后录制",
2373
+ "member": "int64",
2374
+ "name": "IsTiwOfflineRecordUser",
2375
+ "type": "int",
2376
+ "value_allowed_null": false
2377
+ },
2378
+ {
2379
+ "document": "用户是否实名认证",
2380
+ "member": "int64",
2381
+ "name": "IsAuthenticated",
1120
2382
  "type": "int",
1121
2383
  "value_allowed_null": false
1122
2384
  },
@@ -1129,13 +2391,12 @@
1129
2391
  ],
1130
2392
  "type": "object"
1131
2393
  },
1132
- "DescribeTranscodeCallbackRequest": {
1133
- "document": "DescribeTranscodeCallback请求参数结构体",
2394
+ "DescribeVideoGenerationTaskCallbackRequest": {
2395
+ "document": "DescribeVideoGenerationTaskCallback请求参数结构体",
1134
2396
  "members": [
1135
2397
  {
1136
2398
  "default": "",
1137
2399
  "document": "应用的SdkAppId",
1138
- "example": "1400000001",
1139
2400
  "member": "int64",
1140
2401
  "name": "SdkAppId",
1141
2402
  "required": true,
@@ -1144,24 +2405,20 @@
1144
2405
  ],
1145
2406
  "type": "object"
1146
2407
  },
1147
- "DescribeTranscodeCallbackResponse": {
1148
- "document": "DescribeTranscodeCallback返回参数结构体",
2408
+ "DescribeVideoGenerationTaskCallbackResponse": {
2409
+ "document": "DescribeVideoGenerationTaskCallback返回参数结构体",
1149
2410
  "members": [
1150
2411
  {
1151
- "document": "文档转码回调地址",
1152
- "example": "https://example.com/transcode/callback",
2412
+ "document": "录制视频生成回调地址",
1153
2413
  "member": "string",
1154
2414
  "name": "Callback",
1155
- "required": true,
1156
2415
  "type": "string",
1157
2416
  "value_allowed_null": false
1158
2417
  },
1159
2418
  {
1160
- "document": "文档转码回调鉴权密钥",
1161
- "example": "6vg9G7Fd",
2419
+ "document": "录制视频生成回调鉴权密钥",
1162
2420
  "member": "string",
1163
2421
  "name": "CallbackKey",
1164
- "required": true,
1165
2422
  "type": "string",
1166
2423
  "value_allowed_null": false
1167
2424
  },
@@ -1174,20 +2431,20 @@
1174
2431
  ],
1175
2432
  "type": "object"
1176
2433
  },
1177
- "DescribeTranscodeRequest": {
1178
- "document": "DescribeTranscode请求参数结构体",
2434
+ "DescribeVideoGenerationTaskRequest": {
2435
+ "document": "DescribeVideoGenerationTask请求参数结构体",
1179
2436
  "members": [
1180
2437
  {
2438
+ "default": "",
1181
2439
  "document": "客户的SdkAppId",
1182
- "example": "1400000001",
1183
2440
  "member": "int64",
1184
2441
  "name": "SdkAppId",
1185
2442
  "required": true,
1186
2443
  "type": "int"
1187
2444
  },
1188
2445
  {
1189
- "document": "文档转码任务的唯一标识Id",
1190
- "example": "g0jb42ps49vtebjshilb",
2446
+ "default": "",
2447
+ "document": "录制视频生成的任务Id",
1191
2448
  "member": "string",
1192
2449
  "name": "TaskId",
1193
2450
  "required": true,
@@ -1196,105 +2453,65 @@
1196
2453
  ],
1197
2454
  "type": "object"
1198
2455
  },
1199
- "DescribeTranscodeResponse": {
1200
- "document": "DescribeTranscode返回参数结构体",
2456
+ "DescribeVideoGenerationTaskResponse": {
2457
+ "document": "DescribeVideoGenerationTask返回参数结构体",
1201
2458
  "members": [
1202
2459
  {
1203
- "document": "文档的总页数",
1204
- "example": "1",
1205
- "member": "int64",
1206
- "name": "Pages",
1207
- "type": "int",
2460
+ "document": "任务对应的群组Id",
2461
+ "member": "string",
2462
+ "name": "GroupId",
2463
+ "type": "string",
1208
2464
  "value_allowed_null": false
1209
2465
  },
1210
2466
  {
1211
- "document": "转码的当前进度,取值范围为0~100",
1212
- "example": "100",
2467
+ "document": "任务对应的房间号",
1213
2468
  "member": "int64",
1214
- "name": "Progress",
2469
+ "name": "RoomId",
1215
2470
  "type": "int",
1216
2471
  "value_allowed_null": false
1217
2472
  },
1218
2473
  {
1219
- "document": "文档的分辨率",
1220
- "example": "793x1122",
2474
+ "document": "任务的Id",
1221
2475
  "member": "string",
1222
- "name": "Resolution",
2476
+ "name": "TaskId",
1223
2477
  "type": "string",
1224
2478
  "value_allowed_null": false
1225
2479
  },
1226
2480
  {
1227
- "document": "转码完成后结果的URL\n动态转码：PPT转动态H5的链接\n静态转码：文档每一页的图片URL前缀，比如，该URL前缀为`http://example.com/g0jb42ps49vtebjshilb/`，那么文档第1页的图片URL为\n`http://example.com/g0jb42ps49vtebjshilb/1.jpg`，其它页以此类推",
1228
- "example": "https://transcode-result/0agdnligqtgtvkm65emb/index.html",
1229
- "member": "string",
1230
- "name": "ResultUrl",
1231
- "type": "string",
2481
+ "document": "已废弃",
2482
+ "member": "int64",
2483
+ "name": "Progress",
2484
+ "type": "int",
1232
2485
  "value_allowed_null": false
1233
2486
  },
1234
2487
  {
1235
- "document": "任务的当前状态\n- QUEUED: 正在排队等待转换\n- PROCESSING: 转换中\n- FINISHED: 转换完成",
1236
- "example": "FINISHED",
2488
+ "document": "录制视频生成任务状态\n- QUEUED: 正在排队\n- PROCESSING: 正在生成视频\n- FINISHED: 生成视频结束（成功完成或失败结束，可以通过错误码和错误信息进一步判断）",
1237
2489
  "member": "string",
1238
2490
  "name": "Status",
1239
2491
  "type": "string",
1240
2492
  "value_allowed_null": false
1241
2493
  },
1242
2494
  {
1243
- "document": "转码任务的唯一标识Id",
1244
- "example": "0agdnligqtgtvkm65emb",
1245
- "member": "string",
1246
- "name": "TaskId",
1247
- "type": "string",
1248
- "value_allowed_null": false
1249
- },
1250
- {
1251
- "document": "文档的文件名",
1252
- "example": "59378.docx",
1253
- "member": "string",
1254
- "name": "Title",
1255
- "type": "string",
1256
- "value_allowed_null": false
1257
- },
1258
- {
1259
- "document": "缩略图URL前缀，比如，该URL前缀为`http://example.com/g0jb42ps49vtebjshilb/ `，那么动态PPT第1页的缩略图URL为\n`http://example.com/g0jb42ps49vtebjshilb/1.jpg`，其它页以此类推\n\n如果发起文档转码请求参数中带了ThumbnailResolution参数，并且转码类型为动态转码，该参数不为空，其余情况该参数为空字符串",
1260
- "example": "https://transcode-thumbnal/0agdnligqtgtvkm65emb/",
1261
- "member": "string",
1262
- "name": "ThumbnailUrl",
1263
- "type": "string",
2495
+ "document": "回放视频总时长,单位：毫秒",
2496
+ "member": "int64",
2497
+ "name": "TotalTime",
2498
+ "type": "int",
1264
2499
  "value_allowed_null": false
1265
2500
  },
1266
2501
  {
1267
- "document": "动态转码缩略图生成分辨率",
1268
- "example": "793x1122",
1269
- "member": "string",
1270
- "name": "ThumbnailResolution",
1271
- "type": "string",
2502
+ "document": "已废弃，请使用`VideoInfoList`参数",
2503
+ "member": "VideoInfo",
2504
+ "name": "VideoInfos",
2505
+ "type": "object",
1272
2506
  "value_allowed_null": false
1273
2507
  },
1274
2508
  {
1275
- "document": "转码压缩文件下载的URL，如果发起文档转码请求参数中`CompressFileType`为空或者不是支持的压缩格式，该参数为空字符串",
1276
- "example": "无",
1277
- "member": "string",
1278
- "name": "CompressFileUrl",
1279
- "type": "string",
2509
+ "document": "录制视频生成视频列表",
2510
+ "member": "VideoInfo",
2511
+ "name": "VideoInfoList",
2512
+ "type": "list",
1280
2513
  "value_allowed_null": false
1281
2514
  },
1282
- {
1283
- "document": "资源清单文件下载URL(内测体验)\n注意：此字段可能返回 null，表示取不到有效值。",
1284
- "example": "无",
1285
- "member": "string",
1286
- "name": "ResourceListUrl",
1287
- "type": "string",
1288
- "value_allowed_null": true
1289
- },
1290
- {
1291
- "document": "文档制作方式(内测体验)\n注意：此字段可能返回 null，表示取不到有效值。",
1292
- "example": "office",
1293
- "member": "string",
1294
- "name": "Ext",
1295
- "type": "string",
1296
- "value_allowed_null": true
1297
- },
1298
2515
  {
1299
2516
  "document": "唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。",
1300
2517
  "member": "string",
@@ -1304,35 +2521,58 @@
1304
2521
  ],
1305
2522
  "type": "object"
1306
2523
  },
1307
- "DescribeVideoGenerationTaskCallbackRequest": {
1308
- "document": "DescribeVideoGenerationTaskCallback请求参数结构体",
2524
+ "DescribeWhiteboardApplicationConfigRequest": {
2525
+ "document": "DescribeWhiteboardApplicationConfig请求参数结构体",
1309
2526
  "members": [
1310
2527
  {
1311
2528
  "default": "",
1312
- "document": "应用的SdkAppId",
2529
+ "document": "客户的SdkAppId",
2530
+ "example": "1400000001",
1313
2531
  "member": "int64",
1314
2532
  "name": "SdkAppId",
1315
2533
  "required": true,
1316
2534
  "type": "int"
2535
+ },
2536
+ {
2537
+ "default": "",
2538
+ "document": "需要查询的任务类型\nrecording: 实时录制\ntranscode: 文档转码",
2539
+ "example": "[\"transcode\",\"recording\"]",
2540
+ "member": "string",
2541
+ "name": "TaskTypes",
2542
+ "required": true,
2543
+ "type": "list"
2544
+ },
2545
+ {
2546
+ "default": "",
2547
+ "document": "需要查询配置的SdkAppId列表",
2548
+ "example": "[0]",
2549
+ "member": "int64",
2550
+ "name": "SdkAppIds",
2551
+ "required": false,
2552
+ "type": "list"
1317
2553
  }
1318
2554
  ],
1319
2555
  "type": "object"
1320
2556
  },
1321
- "DescribeVideoGenerationTaskCallbackResponse": {
1322
- "document": "DescribeVideoGenerationTaskCallback返回参数结构体",
2557
+ "DescribeWhiteboardApplicationConfigResponse": {
2558
+ "document": "DescribeWhiteboardApplicationConfig返回参数结构体",
1323
2559
  "members": [
1324
2560
  {
1325
- "document": "录制视频生成回调地址",
1326
- "member": "string",
1327
- "name": "Callback",
1328
- "type": "string",
2561
+ "document": "客户的SdkAppId",
2562
+ "example": "1400127140",
2563
+ "member": "int64",
2564
+ "name": "SdkAppId",
2565
+ "required": true,
2566
+ "type": "int",
1329
2567
  "value_allowed_null": false
1330
2568
  },
1331
2569
  {
1332
- "document": "录制视频生成回调鉴权密钥",
1333
- "member": "string",
1334
- "name": "CallbackKey",
1335
- "type": "string",
2570
+ "document": "白板应用任务相关配置",
2571
+ "example": "无",
2572
+ "member": "WhiteboardApplicationConfig",
2573
+ "name": "Configs",
2574
+ "required": true,
2575
+ "type": "list",
1336
2576
  "value_allowed_null": false
1337
2577
  },
1338
2578
  {
@@ -1344,8 +2584,8 @@
1344
2584
  ],
1345
2585
  "type": "object"
1346
2586
  },
1347
- "DescribeVideoGenerationTaskRequest": {
1348
- "document": "DescribeVideoGenerationTask请求参数结构体",
2587
+ "DescribeWhiteboardBucketConfigRequest": {
2588
+ "document": "DescribeWhiteboardBucketConfig请求参数结构体",
1349
2589
  "members": [
1350
2590
  {
1351
2591
  "default": "",
@@ -1357,74 +2597,18 @@
1357
2597
  },
1358
2598
  {
1359
2599
  "default": "",
1360
- "document": "录制视频生成的任务Id",
2600
+ "document": "需要查询的任务类型\nrecording: 实时录制\ntranscode: 文档转码",
1361
2601
  "member": "string",
1362
- "name": "TaskId",
2602
+ "name": "TaskType",
1363
2603
  "required": true,
1364
2604
  "type": "string"
1365
2605
  }
1366
2606
  ],
1367
2607
  "type": "object"
1368
2608
  },
1369
- "DescribeVideoGenerationTaskResponse": {
1370
- "document": "DescribeVideoGenerationTask返回参数结构体",
2609
+ "DescribeWhiteboardBucketConfigResponse": {
2610
+ "document": "DescribeWhiteboardBucketConfig返回参数结构体",
1371
2611
  "members": [
1372
- {
1373
- "document": "任务对应的群组Id",
1374
- "member": "string",
1375
- "name": "GroupId",
1376
- "type": "string",
1377
- "value_allowed_null": false
1378
- },
1379
- {
1380
- "document": "任务对应的房间号",
1381
- "member": "int64",
1382
- "name": "RoomId",
1383
- "type": "int",
1384
- "value_allowed_null": false
1385
- },
1386
- {
1387
- "document": "任务的Id",
1388
- "member": "string",
1389
- "name": "TaskId",
1390
- "type": "string",
1391
- "value_allowed_null": false
1392
- },
1393
- {
1394
- "document": "已废弃",
1395
- "member": "int64",
1396
- "name": "Progress",
1397
- "type": "int",
1398
- "value_allowed_null": false
1399
- },
1400
- {
1401
- "document": "录制视频生成任务状态\n- QUEUED: 正在排队\n- PROCESSING: 正在生成视频\n- FINISHED: 生成视频结束（成功完成或失败结束，可以通过错误码和错误信息进一步判断）",
1402
- "member": "string",
1403
- "name": "Status",
1404
- "type": "string",
1405
- "value_allowed_null": false
1406
- },
1407
- {
1408
- "document": "回放视频总时长,单位：毫秒",
1409
- "member": "int64",
1410
- "name": "TotalTime",
1411
- "type": "int",
1412
- "value_allowed_null": false
1413
- },
1414
- {
1415
- "document": "已废弃，请使用`VideoInfoList`参数",
1416
- "member": "VideoInfo",
1417
- "name": "VideoInfos",
1418
- "type": "object",
1419
- "value_allowed_null": false
1420
- },
1421
- {
1422
- "document": "录制视频生成视频列表",
1423
- "member": "VideoInfo",
1424
- "name": "VideoInfoList",
1425
- "type": "list",
1426
- "value_allowed_null": false
1427
- },
1428
2612
  {
1429
2613
  "document": "唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。",
1430
2614
  "member": "string",
@@ -1603,6 +2787,74 @@
1603
2787
  ],
1604
2788
  "type": "object"
1605
2789
  },
2790
+ "DescribeWhiteboardPushSearchRequest": {
2791
+ "document": "DescribeWhiteboardPushSearch请求参数结构体",
2792
+ "members": [],
2793
+ "type": "object"
2794
+ },
2795
+ "DescribeWhiteboardPushSearchResponse": {
2796
+ "document": "DescribeWhiteboardPushSearch返回参数结构体",
2797
+ "members": [
2798
+ {
2799
+ "document": "推流任务搜索结果集合",
2800
+ "example": "无",
2801
+ "member": "WhiteboardPushTaskSearchResult",
2802
+ "name": "WhiteboardPushTaskSet",
2803
+ "required": true,
2804
+ "type": "list",
2805
+ "value_allowed_null": false
2806
+ },
2807
+ {
2808
+ "document": "推流总任务数",
2809
+ "example": "1",
2810
+ "member": "int64",
2811
+ "name": "TotalCount",
2812
+ "required": true,
2813
+ "type": "int",
2814
+ "value_allowed_null": false
2815
+ },
2816
+ {
2817
+ "document": "唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。",
2818
+ "member": "string",
2819
+ "name": "RequestId",
2820
+ "type": "string"
2821
+ }
2822
+ ],
2823
+ "type": "object"
2824
+ },
2825
+ "Detail": {
2826
+ "document": "计费用量数据里，带不同指标Tag的详情",
2827
+ "members": [
2828
+ {
2829
+ "default": "",
2830
+ "document": "用量指标",
2831
+ "member": "string",
2832
+ "name": "TagName",
2833
+ "required": true,
2834
+ "type": "string",
2835
+ "value_allowed_null": false
2836
+ },
2837
+ {
2838
+ "default": "",
2839
+ "document": "用量权重",
2840
+ "member": "float",
2841
+ "name": "Weight",
2842
+ "required": true,
2843
+ "type": "float",
2844
+ "value_allowed_null": false
2845
+ },
2846
+ {
2847
+ "default": "",
2848
+ "document": "用量的值",
2849
+ "member": "float",
2850
+ "name": "Value",
2851
+ "required": true,
2852
+ "type": "float",
2853
+ "value_allowed_null": false
2854
+ }
2855
+ ],
2856
+ "usage": "out"
2857
+ },
1606
2858
  "Interrupt": {
1607
2859
  "document": "实时录制中出现的用户视频流断流次数统计",
1608
2860
  "members": [
@@ -1703,33 +2955,211 @@
1703
2955
  },
1704
2956
  {
1705
2957
  "default": "",
1706
- "document": "内置混流布局模板ID, 取值 [1, 2], 区别见内置混流布局模板样式示例说明\n在没有填Custom字段时候，ModelId是必填的",
1707
- "member": "int64",
1708
- "name": "ModelId",
1709
- "required": false,
1710
- "type": "int",
1711
- "value_allowed_null": false
2958
+ "document": "内置混流布局模板ID, 取值 [1, 2], 区别见内置混流布局模板样式示例说明\n在没有填Custom字段时候，ModelId是必填的",
2959
+ "member": "int64",
2960
+ "name": "ModelId",
2961
+ "required": false,
2962
+ "type": "int",
2963
+ "value_allowed_null": false
2964
+ },
2965
+ {
2966
+ "default": "",
2967
+ "document": "老师用户ID\n此字段只有在ModelId填了的情况下生效\n填写TeacherId的效果是把指定为TeacherId的用户视频流显示在内置模板的第一个小画面中",
2968
+ "member": "string",
2969
+ "name": "TeacherId",
2970
+ "required": false,
2971
+ "type": "string",
2972
+ "value_allowed_null": false
2973
+ },
2974
+ {
2975
+ "default": "",
2976
+ "document": "自定义混流布局参数\n当此字段存在时，ModelId 及 TeacherId 字段将被忽略",
2977
+ "member": "CustomLayout",
2978
+ "name": "Custom",
2979
+ "required": false,
2980
+ "type": "object",
2981
+ "value_allowed_null": false
2982
+ }
2983
+ ],
2984
+ "usage": "in"
2985
+ },
2986
+ "ModifyApplicationRequest": {
2987
+ "document": "ModifyApplication请求参数结构体",
2988
+ "members": [
2989
+ {
2990
+ "default": "",
2991
+ "document": "应用SdkAppId",
2992
+ "member": "int64",
2993
+ "name": "SdkAppId",
2994
+ "required": true,
2995
+ "type": "int"
2996
+ },
2997
+ {
2998
+ "default": "",
2999
+ "document": "App名字",
3000
+ "member": "string",
3001
+ "name": "AppName",
3002
+ "required": true,
3003
+ "type": "string"
3004
+ }
3005
+ ],
3006
+ "type": "object"
3007
+ },
3008
+ "ModifyApplicationResponse": {
3009
+ "document": "ModifyApplication返回参数结构体",
3010
+ "members": [
3011
+ {
3012
+ "document": "唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。",
3013
+ "member": "string",
3014
+ "name": "RequestId",
3015
+ "type": "string"
3016
+ }
3017
+ ],
3018
+ "type": "object"
3019
+ },
3020
+ "ModifyAutoRenewFlagRequest": {
3021
+ "document": "ModifyAutoRenewFlag请求参数结构体",
3022
+ "members": [
3023
+ {
3024
+ "default": "",
3025
+ "document": "资源Id，从DescribeUserResources接口中获取Level=1的正式月功能费的SubProduct，一般为sp_tiw_package",
3026
+ "member": "string",
3027
+ "name": "SubProduct",
3028
+ "required": true,
3029
+ "type": "string"
3030
+ },
3031
+ {
3032
+ "default": "",
3033
+ "document": "资源Id，从DescribeUserResources接口中获取Level=1的正式月功能费资源Id",
3034
+ "member": "string",
3035
+ "name": "ResourceId",
3036
+ "required": true,
3037
+ "type": "string"
3038
+ },
3039
+ {
3040
+ "default": "",
3041
+ "document": "自动续费标记，0表示默认状态(用户未设置，即初始状态)， 1表示自动续费，2表示明确不自动续费(用户设置)，若业务无续费概念或无需自动续 费，需要设置为0",
3042
+ "member": "int64",
3043
+ "name": "AutoRenewFlag",
3044
+ "required": true,
3045
+ "type": "int"
3046
+ }
3047
+ ],
3048
+ "type": "object"
3049
+ },
3050
+ "ModifyAutoRenewFlagResponse": {
3051
+ "document": "ModifyAutoRenewFlag返回参数结构体",
3052
+ "members": [
3053
+ {
3054
+ "document": "唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。",
3055
+ "member": "string",
3056
+ "name": "RequestId",
3057
+ "type": "string"
3058
+ }
3059
+ ],
3060
+ "type": "object"
3061
+ },
3062
+ "ModifyWhiteboardApplicationConfigRequest": {
3063
+ "document": "ModifyWhiteboardApplicationConfig请求参数结构体",
3064
+ "members": [
3065
+ {
3066
+ "default": "",
3067
+ "document": "客户的SdkAppId",
3068
+ "example": "1400000001",
3069
+ "member": "int64",
3070
+ "name": "SdkAppId",
3071
+ "required": true,
3072
+ "type": "int"
3073
+ },
3074
+ {
3075
+ "default": "",
3076
+ "document": "白板应用任务相关配置",
3077
+ "example": "无",
3078
+ "member": "WhiteboardApplicationConfig",
3079
+ "name": "Configs",
3080
+ "required": true,
3081
+ "type": "list"
3082
+ }
3083
+ ],
3084
+ "type": "object"
3085
+ },
3086
+ "ModifyWhiteboardApplicationConfigResponse": {
3087
+ "document": "ModifyWhiteboardApplicationConfig返回参数结构体",
3088
+ "members": [
3089
+ {
3090
+ "document": "唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。",
3091
+ "member": "string",
3092
+ "name": "RequestId",
3093
+ "type": "string"
3094
+ }
3095
+ ],
3096
+ "type": "object"
3097
+ },
3098
+ "ModifyWhiteboardBucketConfigRequest": {
3099
+ "document": "ModifyWhiteboardBucketConfig请求参数结构体",
3100
+ "members": [
3101
+ {
3102
+ "default": "",
3103
+ "document": "客户的SdkAppId",
3104
+ "member": "int64",
3105
+ "name": "SdkAppId",
3106
+ "required": true,
3107
+ "type": "int"
3108
+ },
3109
+ {
3110
+ "default": "",
3111
+ "document": "需要查询的任务类型\nrecording: 实时录制\ntranscode: 文档转码",
3112
+ "member": "string",
3113
+ "name": "TaskType",
3114
+ "required": true,
3115
+ "type": "string"
3116
+ },
3117
+ {
3118
+ "default": "",
3119
+ "document": "COS存储桶名字",
3120
+ "member": "string",
3121
+ "name": "BucketName",
3122
+ "required": true,
3123
+ "type": "string"
3124
+ },
3125
+ {
3126
+ "default": "",
3127
+ "document": "COS存储桶地域",
3128
+ "member": "string",
3129
+ "name": "BucketLocation",
3130
+ "required": true,
3131
+ "type": "string"
1712
3132
  },
1713
3133
  {
1714
3134
  "default": "",
1715
- "document": "老师用户ID\n此字段只有在ModelId填了的情况下生效\n填写TeacherId的效果是把指定为TeacherId的用户视频流显示在内置模板的第一个小画面中",
3135
+ "document": "存储桶里资源前缀",
1716
3136
  "member": "string",
1717
- "name": "TeacherId",
1718
- "required": false,
1719
- "type": "string",
1720
- "value_allowed_null": false
3137
+ "name": "BucketPrefix",
3138
+ "required": true,
3139
+ "type": "string"
1721
3140
  },
1722
3141
  {
1723
3142
  "default": "",
1724
- "document": "自定义混流布局参数\n当此字段存在时，ModelId 及 TeacherId 字段将被忽略",
1725
- "member": "CustomLayout",
1726
- "name": "Custom",
1727
- "required": false,
1728
- "type": "object",
1729
- "value_allowed_null": false
3143
+ "document": "返回Url域名",
3144
+ "member": "string",
3145
+ "name": "ResultDomain",
3146
+ "required": true,
3147
+ "type": "string"
1730
3148
  }
1731
3149
  ],
1732
- "usage": "in"
3150
+ "type": "object"
3151
+ },
3152
+ "ModifyWhiteboardBucketConfigResponse": {
3153
+ "document": "ModifyWhiteboardBucketConfig返回参数结构体",
3154
+ "members": [
3155
+ {
3156
+ "document": "唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。",
3157
+ "member": "string",
3158
+ "name": "RequestId",
3159
+ "type": "string"
3160
+ }
3161
+ ],
3162
+ "type": "object"
1733
3163
  },
1734
3164
  "OmittedDuration": {
1735
3165
  "document": "拼接视频中被忽略的时间段",
@@ -1883,6 +3313,52 @@
1883
3313
  ],
1884
3314
  "type": "object"
1885
3315
  },
3316
+ "RoomListItem": {
3317
+ "document": "日志查询里返回的白板房间数据",
3318
+ "members": [
3319
+ {
3320
+ "default": "",
3321
+ "document": "房间ID",
3322
+ "example": "100000",
3323
+ "member": "string",
3324
+ "name": "RoomId",
3325
+ "required": true,
3326
+ "type": "string",
3327
+ "value_allowed_null": false
3328
+ },
3329
+ {
3330
+ "default": "",
3331
+ "document": "房间在查询时间段内最早出现的时间，Unix时间戳，单位毫秒",
3332
+ "example": "1614519034000",
3333
+ "member": "int64",
3334
+ "name": "StartTime",
3335
+ "required": true,
3336
+ "type": "int",
3337
+ "value_allowed_null": false
3338
+ },
3339
+ {
3340
+ "default": "",
3341
+ "document": "房间在查询时间段内最晚出现的时间，Unix时间戳，单位毫秒",
3342
+ "example": "1614519034000",
3343
+ "member": "int64",
3344
+ "name": "EndTime",
3345
+ "required": true,
3346
+ "type": "int",
3347
+ "value_allowed_null": false
3348
+ },
3349
+ {
3350
+ "default": "",
3351
+ "document": "房间里成员数",
3352
+ "example": "100",
3353
+ "member": "int64",
3354
+ "name": "UserNumber",
3355
+ "required": true,
3356
+ "type": "int",
3357
+ "value_allowed_null": false
3358
+ }
3359
+ ],
3360
+ "usage": "both"
3361
+ },
1886
3362
  "RoomUsageDataItem": {
1887
3363
  "document": "互动白板房间用量信息",
1888
3364
  "members": [
@@ -1939,6 +3415,40 @@
1939
3415
  ],
1940
3416
  "usage": "out"
1941
3417
  },
3418
+ "SetOfflineRecordCallbackRequest": {
3419
+ "document": "SetOfflineRecordCallback请求参数结构体",
3420
+ "members": [
3421
+ {
3422
+ "default": "",
3423
+ "document": "客户的SdkAppId",
3424
+ "member": "int64",
3425
+ "name": "SdkAppId",
3426
+ "required": true,
3427
+ "type": "int"
3428
+ },
3429
+ {
3430
+ "default": "",
3431
+ "document": "课后录制任务结果回调地址，如果传空字符串会删除原来的回调地址配置，回调地址仅支持 http或https协议，即回调地址以http://或https://开头",
3432
+ "member": "string",
3433
+ "name": "Callback",
3434
+ "required": true,
3435
+ "type": "string"
3436
+ }
3437
+ ],
3438
+ "type": "object"
3439
+ },
3440
+ "SetOfflineRecordCallbackResponse": {
3441
+ "document": "SetOfflineRecordCallback返回参数结构体",
3442
+ "members": [
3443
+ {
3444
+ "document": "唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。",
3445
+ "member": "string",
3446
+ "name": "RequestId",
3447
+ "type": "string"
3448
+ }
3449
+ ],
3450
+ "type": "object"
3451
+ },
1942
3452
  "SetOnlineRecordCallbackKeyRequest": {
1943
3453
  "document": "SetOnlineRecordCallbackKey请求参数结构体",
1944
3454
  "members": [
@@ -2878,27 +4388,207 @@
2878
4388
  ],
2879
4389
  "usage": "in"
2880
4390
  },
4391
+ "Tag": {
4392
+ "document": "标签",
4393
+ "members": [
4394
+ {
4395
+ "default": "",
4396
+ "document": "标签键",
4397
+ "member": "string",
4398
+ "name": "TagKey",
4399
+ "required": true,
4400
+ "type": "string",
4401
+ "value_allowed_null": false
4402
+ },
4403
+ {
4404
+ "default": "",
4405
+ "document": "标签值",
4406
+ "member": "string",
4407
+ "name": "TagValue",
4408
+ "required": true,
4409
+ "type": "string",
4410
+ "value_allowed_null": false
4411
+ }
4412
+ ],
4413
+ "usage": "both"
4414
+ },
2881
4415
  "TimeValue": {
2882
4416
  "document": "查询指标返回的时间序列",
2883
4417
  "members": [
2884
4418
  {
2885
4419
  "default": "",
2886
- "document": "Unix时间戳，单位秒",
2887
- "example": "1617883200",
2888
- "member": "uint64",
2889
- "name": "Time",
4420
+ "document": "Unix时间戳，单位秒",
4421
+ "example": "1617883200",
4422
+ "member": "uint64",
4423
+ "name": "Time",
4424
+ "required": true,
4425
+ "type": "int",
4426
+ "value_allowed_null": false
4427
+ },
4428
+ {
4429
+ "default": "",
4430
+ "document": "查询指标对应当前时间的值",
4431
+ "example": "100",
4432
+ "member": "float",
4433
+ "name": "Value",
4434
+ "required": true,
4435
+ "type": "float",
4436
+ "value_allowed_null": false
4437
+ }
4438
+ ],
4439
+ "usage": "out"
4440
+ },
4441
+ "TranscodeTaskResult": {
4442
+ "document": "转码任务结果",
4443
+ "members": [
4444
+ {
4445
+ "default": "",
4446
+ "document": "转码结果地址",
4447
+ "member": "string",
4448
+ "name": "ResultUrl",
4449
+ "required": true,
4450
+ "type": "string",
4451
+ "value_allowed_null": false
4452
+ },
4453
+ {
4454
+ "default": "",
4455
+ "document": "分辨率",
4456
+ "member": "string",
4457
+ "name": "Resolution",
4458
+ "required": true,
4459
+ "type": "string",
4460
+ "value_allowed_null": false
4461
+ },
4462
+ {
4463
+ "default": "",
4464
+ "document": "标题（一般为文件名）",
4465
+ "member": "string",
4466
+ "name": "Title",
4467
+ "required": true,
4468
+ "type": "string",
4469
+ "value_allowed_null": false
4470
+ },
4471
+ {
4472
+ "default": "",
4473
+ "document": "转码页数",
4474
+ "member": "int64",
4475
+ "name": "Pages",
4476
+ "required": true,
4477
+ "type": "int",
4478
+ "value_allowed_null": false
4479
+ },
4480
+ {
4481
+ "default": "",
4482
+ "document": "缩略图URL前缀，比如，该URL前缀为http://example.com/g0jb42ps49vtebjshilb/，那么动态PPT第1页的缩略图URL为\nhttp://example.com/g0jb42ps49vtebjshilb/1.jpg，其它页以此类推\n\n如果发起文档转码请求参数中带了ThumbnailResolution参数，并且转码类型为动态转码，该参数不为空，其余情况该参数为空字符串",
4483
+ "member": "string",
4484
+ "name": "ThumbnailUrl",
4485
+ "required": true,
4486
+ "type": "string",
4487
+ "value_allowed_null": false
4488
+ },
4489
+ {
4490
+ "default": "",
4491
+ "document": "动态转码缩略图生成分辨率",
4492
+ "member": "string",
4493
+ "name": "ThumbnailResolution",
4494
+ "required": true,
4495
+ "type": "string",
4496
+ "value_allowed_null": false
4497
+ },
4498
+ {
4499
+ "default": "",
4500
+ "document": "转码压缩文件下载的URL，如果发起文档转码请求参数中CompressFileType为空或者不是支持的压缩格式，该参数为空字符串",
4501
+ "member": "string",
4502
+ "name": "CompressFileUrl",
4503
+ "required": true,
4504
+ "type": "string",
4505
+ "value_allowed_null": false
4506
+ },
4507
+ {
4508
+ "default": "",
4509
+ "document": "任务失败错误码",
4510
+ "member": "int64",
4511
+ "name": "ErrorCode",
4512
+ "required": true,
4513
+ "type": "int",
4514
+ "value_allowed_null": false
4515
+ },
4516
+ {
4517
+ "default": "",
4518
+ "document": "任务失败错误信息",
4519
+ "member": "string",
4520
+ "name": "ErrorMsg",
4521
+ "required": true,
4522
+ "type": "string",
4523
+ "value_allowed_null": false
4524
+ }
4525
+ ],
4526
+ "usage": "out"
4527
+ },
4528
+ "TranscodeTaskSearchResult": {
4529
+ "document": "转码任务搜索结果",
4530
+ "members": [
4531
+ {
4532
+ "default": "",
4533
+ "document": "任务创建时间",
4534
+ "member": "datetime_iso",
4535
+ "name": "CreateTime",
4536
+ "required": true,
4537
+ "type": "string",
4538
+ "value_allowed_null": false
4539
+ },
4540
+ {
4541
+ "default": "",
4542
+ "document": "任务唯一ID",
4543
+ "member": "string",
4544
+ "name": "TaskId",
4545
+ "required": true,
4546
+ "type": "string",
4547
+ "value_allowed_null": false
4548
+ },
4549
+ {
4550
+ "default": "",
4551
+ "document": "任务的当前状态\n- QUEUED: 正在排队等待转换\n- PROCESSING: 转换中\n- FINISHED: 转换完成",
4552
+ "member": "string",
4553
+ "name": "Status",
4554
+ "required": true,
4555
+ "type": "string",
4556
+ "value_allowed_null": false
4557
+ },
4558
+ {
4559
+ "default": "",
4560
+ "document": "转码文件原始名称",
4561
+ "member": "string",
4562
+ "name": "OriginalFilename",
4563
+ "required": true,
4564
+ "type": "string",
4565
+ "value_allowed_null": false
4566
+ },
4567
+ {
4568
+ "default": "",
4569
+ "document": "用户应用SdkAppId",
4570
+ "member": "int64",
4571
+ "name": "SdkAppId",
4572
+ "required": true,
4573
+ "type": "int",
4574
+ "value_allowed_null": false
4575
+ },
4576
+ {
4577
+ "default": "",
4578
+ "document": "转码任务结果",
4579
+ "member": "TranscodeTaskResult",
4580
+ "name": "Result",
2890
4581
  "required": true,
2891
- "type": "int",
4582
+ "type": "object",
2892
4583
  "value_allowed_null": false
2893
4584
  },
2894
4585
  {
2895
4586
  "default": "",
2896
- "document": "查询指标对应当前时间的值",
2897
- "example": "100",
2898
- "member": "float",
2899
- "name": "Value",
4587
+ "document": "是否静态转码",
4588
+ "member": "bool",
4589
+ "name": "IsStatic",
2900
4590
  "required": true,
2901
- "type": "float",
4591
+ "type": "bool",
2902
4592
  "value_allowed_null": false
2903
4593
  }
2904
4594
  ],
@@ -2950,6 +4640,42 @@
2950
4640
  ],
2951
4641
  "usage": "out"
2952
4642
  },
4643
+ "UserListItem": {
4644
+ "document": "日志查询里返回的白板用户数据",
4645
+ "members": [
4646
+ {
4647
+ "default": "",
4648
+ "document": "房间内的用户ID",
4649
+ "example": "100000",
4650
+ "member": "string",
4651
+ "name": "UserId",
4652
+ "required": true,
4653
+ "type": "string",
4654
+ "value_allowed_null": false
4655
+ },
4656
+ {
4657
+ "default": "",
4658
+ "document": "用户在查询时间段内最早出现的时间，Unix时间戳，单位毫秒",
4659
+ "example": "1614519034000",
4660
+ "member": "int64",
4661
+ "name": "StartTime",
4662
+ "required": true,
4663
+ "type": "int",
4664
+ "value_allowed_null": false
4665
+ },
4666
+ {
4667
+ "default": "",
4668
+ "document": "用户在查询时间段内最晚出现的时间，Unix时间戳，单位毫秒",
4669
+ "example": "1614519034000",
4670
+ "member": "int64",
4671
+ "name": "EndTime",
4672
+ "required": true,
4673
+ "type": "int",
4674
+ "value_allowed_null": false
4675
+ }
4676
+ ],
4677
+ "usage": "both"
4678
+ },
2953
4679
  "VideoInfo": {
2954
4680
  "document": "视频信息",
2955
4681
  "members": [
@@ -3082,6 +4808,102 @@
3082
4808
  ],
3083
4809
  "usage": "in"
3084
4810
  },
4811
+ "WhiteboardApplicationConfig": {
4812
+ "document": "白板应用配置，包括资源存储桶，域名，回调地址，回调密钥等",
4813
+ "members": [
4814
+ {
4815
+ "default": "",
4816
+ "document": "任务类型\n\nrecording: 实时录制\ntranscode: 文档转码",
4817
+ "member": "string",
4818
+ "name": "TaskType",
4819
+ "required": true,
4820
+ "type": "string",
4821
+ "value_allowed_null": false
4822
+ },
4823
+ {
4824
+ "default": "",
4825
+ "document": "存储桶名字",
4826
+ "member": "string",
4827
+ "name": "BucketName",
4828
+ "required": true,
4829
+ "type": "string",
4830
+ "value_allowed_null": false
4831
+ },
4832
+ {
4833
+ "default": "",
4834
+ "document": "存储桶地域",
4835
+ "member": "string",
4836
+ "name": "BucketLocation",
4837
+ "required": true,
4838
+ "type": "string",
4839
+ "value_allowed_null": false
4840
+ },
4841
+ {
4842
+ "default": "",
4843
+ "document": "资源在存储桶中的前缀",
4844
+ "member": "string",
4845
+ "name": "BucketPrefix",
4846
+ "required": true,
4847
+ "type": "string",
4848
+ "value_allowed_null": false
4849
+ },
4850
+ {
4851
+ "default": "",
4852
+ "document": "目标CDN域名",
4853
+ "member": "string",
4854
+ "name": "ResultDomain",
4855
+ "required": true,
4856
+ "type": "string",
4857
+ "value_allowed_null": false
4858
+ },
4859
+ {
4860
+ "default": "",
4861
+ "document": "回调地址",
4862
+ "member": "string",
4863
+ "name": "Callback",
4864
+ "required": true,
4865
+ "type": "string",
4866
+ "value_allowed_null": false
4867
+ },
4868
+ {
4869
+ "default": "",
4870
+ "document": "回调鉴权密钥",
4871
+ "member": "string",
4872
+ "name": "CallbackKey",
4873
+ "required": true,
4874
+ "type": "string",
4875
+ "value_allowed_null": false
4876
+ },
4877
+ {
4878
+ "default": "",
4879
+ "document": "配置的应用SdkAppId",
4880
+ "member": "int64",
4881
+ "name": "SdkAppId",
4882
+ "required": false,
4883
+ "type": "int",
4884
+ "value_allowed_null": false
4885
+ },
4886
+ {
4887
+ "default": "",
4888
+ "document": "IM管理员UserId",
4889
+ "member": "string",
4890
+ "name": "AdminUserId",
4891
+ "required": false,
4892
+ "type": "string",
4893
+ "value_allowed_null": false
4894
+ },
4895
+ {
4896
+ "default": "",
4897
+ "document": "IM管理员UserSig",
4898
+ "member": "string",
4899
+ "name": "AdminUserSig",
4900
+ "required": false,
4901
+ "type": "string",
4902
+ "value_allowed_null": false
4903
+ }
4904
+ ],
4905
+ "usage": "both"
4906
+ },
3085
4907
  "WhiteboardPushBackupParam": {
3086
4908
  "document": "白板推流备份相关请求参数",
3087
4909
  "members": [
@@ -3105,6 +4927,162 @@
3105
4927
  }
3106
4928
  ],
3107
4929
  "usage": "in"
4930
+ },
4931
+ "WhiteboardPushResult": {
4932
+ "document": "白板推流任务结果",
4933
+ "members": [
4934
+ {
4935
+ "default": "",
4936
+ "document": "AUTO - 自动停止推流， USER_CALL - 用户主动调用停止推流",
4937
+ "member": "string",
4938
+ "name": "FinishReason",
4939
+ "required": true,
4940
+ "type": "string",
4941
+ "value_allowed_null": false
4942
+ },
4943
+ {
4944
+ "default": "",
4945
+ "document": "异常数",
4946
+ "member": "int64",
4947
+ "name": "ExceptionCnt",
4948
+ "required": true,
4949
+ "type": "int",
4950
+ "value_allowed_null": false
4951
+ },
4952
+ {
4953
+ "default": "",
4954
+ "document": "房间号",
4955
+ "member": "int64",
4956
+ "name": "RoomId",
4957
+ "required": true,
4958
+ "type": "int",
4959
+ "value_allowed_null": false
4960
+ },
4961
+ {
4962
+ "default": "",
4963
+ "document": "IM群组ID",
4964
+ "member": "string",
4965
+ "name": "GroupId",
4966
+ "required": true,
4967
+ "type": "string",
4968
+ "value_allowed_null": false
4969
+ },
4970
+ {
4971
+ "default": "",
4972
+ "document": "推流真实开始时间",
4973
+ "member": "int64",
4974
+ "name": "PushStartTime",
4975
+ "required": true,
4976
+ "type": "int",
4977
+ "value_allowed_null": false
4978
+ },
4979
+ {
4980
+ "default": "",
4981
+ "document": "推流结束时间",
4982
+ "member": "int64",
4983
+ "name": "PushStopTime",
4984
+ "required": true,
4985
+ "type": "int",
4986
+ "value_allowed_null": false
4987
+ },
4988
+ {
4989
+ "default": "",
4990
+ "document": "白板推流首帧对应的IM时间戳，可用于录制回放时IM聊天消息与白板推流视频进行同步对时。",
4991
+ "member": "int64",
4992
+ "name": "IMSyncTime",
4993
+ "required": true,
4994
+ "type": "int",
4995
+ "value_allowed_null": false
4996
+ },
4997
+ {
4998
+ "default": "",
4999
+ "document": "任务失败错误码",
5000
+ "member": "int64",
5001
+ "name": "ErrorCode",
5002
+ "required": true,
5003
+ "type": "int",
5004
+ "value_allowed_null": false
5005
+ },
5006
+ {
5007
+ "default": "",
5008
+ "document": "错误信息",
5009
+ "member": "string",
5010
+ "name": "ErrorMsg",
5011
+ "required": true,
5012
+ "type": "string",
5013
+ "value_allowed_null": false
5014
+ }
5015
+ ],
5016
+ "usage": "out"
5017
+ },
5018
+ "WhiteboardPushTaskSearchResult": {
5019
+ "document": "实时录制任务搜索结果",
5020
+ "members": [
5021
+ {
5022
+ "default": "",
5023
+ "document": "任务唯一ID",
5024
+ "member": "string",
5025
+ "name": "TaskId",
5026
+ "required": true,
5027
+ "type": "string",
5028
+ "value_allowed_null": false
5029
+ },
5030
+ {
5031
+ "default": "",
5032
+ "document": "白板推流任务状态\n- PREPARED: 推流在准备阶段\n- PUSHING: 正在推流\n- STOPPED：推流已停止",
5033
+ "member": "string",
5034
+ "name": "Status",
5035
+ "required": true,
5036
+ "type": "string",
5037
+ "value_allowed_null": false
5038
+ },
5039
+ {
5040
+ "default": "",
5041
+ "document": "白板推流房间号",
5042
+ "member": "int64",
5043
+ "name": "RoomId",
5044
+ "required": true,
5045
+ "type": "int",
5046
+ "value_allowed_null": false
5047
+ },
5048
+ {
5049
+ "default": "",
5050
+ "document": "任务创建时间",
5051
+ "member": "datetime_iso",
5052
+ "name": "CreateTime",
5053
+ "required": true,
5054
+ "type": "string",
5055
+ "value_allowed_null": false
5056
+ },
5057
+ {
5058
+ "default": "",
5059
+ "document": "用户应用SdkAppId",
5060
+ "member": "int64",
5061
+ "name": "SdkAppId",
5062
+ "required": true,
5063
+ "type": "int",
5064
+ "value_allowed_null": false
5065
+ },
5066
+ {
5067
+ "default": "",
5068
+ "document": "白板推流结果",
5069
+ "member": "WhiteboardPushResult",
5070
+ "name": "Result",
5071
+ "required": true,
5072
+ "type": "object",
5073
+ "value_allowed_null": false
5074
+ },
5075
+ {
5076
+ "default": "",
5077
+ "document": "白板推流用户ID",
5078
+ "member": "string",
5079
+ "name": "PushUserId",
5080
+ "required": true,
5081
+ "type": "string",
5082
+ "value_allowed_null": false
5083
+ }
5084
+ ],
5085
+ "usage": "out"
3108
5086
  }
3109
5087
  },
3110
5088
  "version": "1.0"