tccli 3.0.1284.1__py2.py3-none-any.whl → 3.0.1286.1__py2.py3-none-any.whl

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (65) hide show
  1. tccli/__init__.py +1 -1
  2. tccli/services/autoscaling/v20180419/api.json +88 -86
  3. tccli/services/bh/bh_client.py +53 -0
  4. tccli/services/bh/v20230418/api.json +199 -0
  5. tccli/services/bh/v20230418/examples.json +8 -0
  6. tccli/services/cdwch/v20200915/api.json +19 -9
  7. tccli/services/cdwch/v20200915/examples.json +1 -1
  8. tccli/services/cfg/v20210820/api.json +43 -19
  9. tccli/services/cfg/v20210820/examples.json +8 -2
  10. tccli/services/clb/v20180317/api.json +1 -1
  11. tccli/services/cmq/v20190304/api.json +92 -92
  12. tccli/services/cynosdb/v20190107/api.json +379 -379
  13. tccli/services/dlc/dlc_client.py +61 -8
  14. tccli/services/dlc/v20210125/api.json +254 -3
  15. tccli/services/dlc/v20210125/examples.json +11 -3
  16. tccli/services/domain/v20180808/api.json +157 -157
  17. tccli/services/dsgc/v20190723/api.json +2 -2
  18. tccli/services/dts/v20180330/api.json +3 -3
  19. tccli/services/dts/v20211206/api.json +336 -330
  20. tccli/services/emr/emr_client.py +53 -0
  21. tccli/services/emr/v20190103/api.json +247 -0
  22. tccli/services/emr/v20190103/examples.json +8 -0
  23. tccli/services/es/v20180416/api.json +10 -0
  24. tccli/services/es/v20180416/examples.json +1 -1
  25. tccli/services/fmu/fmu_client.py +8 -167
  26. tccli/services/fmu/v20191213/api.json +0 -292
  27. tccli/services/fmu/v20191213/examples.json +0 -24
  28. tccli/services/iotcloud/v20210408/api.json +27 -27
  29. tccli/services/iotcloud/v20210408/examples.json +6 -6
  30. tccli/services/iotexplorer/iotexplorer_client.py +0 -106
  31. tccli/services/iotexplorer/v20190423/api.json +0 -274
  32. tccli/services/iotexplorer/v20190423/examples.json +0 -16
  33. tccli/services/iss/v20230517/api.json +547 -537
  34. tccli/services/iss/v20230517/examples.json +2 -2
  35. tccli/services/kms/v20190118/api.json +20 -0
  36. tccli/services/lcic/lcic_client.py +114 -8
  37. tccli/services/lcic/v20220817/api.json +108 -0
  38. tccli/services/lcic/v20220817/examples.json +16 -0
  39. tccli/services/mongodb/mongodb_client.py +57 -4
  40. tccli/services/mongodb/v20190725/api.json +63 -0
  41. tccli/services/mongodb/v20190725/examples.json +14 -0
  42. tccli/services/monitor/v20180724/api.json +29 -29
  43. tccli/services/monitor/v20180724/examples.json +8 -8
  44. tccli/services/rum/v20210622/api.json +2 -2
  45. tccli/services/svp/svp_client.py +57 -4
  46. tccli/services/svp/v20240125/api.json +319 -0
  47. tccli/services/svp/v20240125/examples.json +8 -0
  48. tccli/services/tiw/tiw_client.py +91 -1416
  49. tccli/services/tiw/v20190919/api.json +351 -2897
  50. tccli/services/tiw/v20190919/examples.json +6 -206
  51. tccli/services/trtc/v20190722/api.json +16 -5
  52. tccli/services/tsf/tsf_client.py +53 -0
  53. tccli/services/tsf/v20180326/api.json +48 -4
  54. tccli/services/tsf/v20180326/examples.json +8 -0
  55. tccli/services/vpc/v20170312/api.json +54 -0
  56. tccli/services/vpc/v20170312/examples.json +8 -0
  57. tccli/services/vpc/vpc_client.py +53 -0
  58. tccli/services/wedata/v20210820/api.json +383 -0
  59. tccli/services/wedata/v20210820/examples.json +8 -0
  60. tccli/services/wedata/wedata_client.py +53 -0
  61. {tccli-3.0.1284.1.dist-info → tccli-3.0.1286.1.dist-info}/METADATA +2 -2
  62. {tccli-3.0.1284.1.dist-info → tccli-3.0.1286.1.dist-info}/RECORD +65 -65
  63. {tccli-3.0.1284.1.dist-info → tccli-3.0.1286.1.dist-info}/WHEEL +0 -0
  64. {tccli-3.0.1284.1.dist-info → tccli-3.0.1286.1.dist-info}/entry_points.txt +0 -0
  65. {tccli-3.0.1284.1.dist-info → tccli-3.0.1286.1.dist-info}/license_files/LICENSE +0 -0
tccli/services/tiw/v20190919/api.json CHANGED
@@ -1,19 +1,5 @@
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
3
  "CreatePPTCheckTask": {
18
4
  "document": "检测PPT文件，识别PPT中包含的动态转码任务（Transcode）不支持的元素",
19
5
  "input": "CreatePPTCheckTaskRequest",
@@ -42,41 +28,6 @@
42
28
  "output": "CreateVideoGenerationTaskResponse",
43
29
  "status": "online"
44
30
  },
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
31
  "DescribeOnlineRecord": {
81
32
  "document": "查询录制任务状态与结果",
82
33
  "input": "DescribeOnlineRecordRequest",
@@ -105,34 +56,6 @@
105
56
  "output": "DescribePPTCheckCallbackResponse",
106
57
  "status": "online"
107
58
  },
108
- "DescribePostpaidUsage": {
109
- "document": "查询用户后付费用量",
110
- "input": "DescribePostpaidUsageRequest",
111
- "name": "查询用户后付费用量",
112
- "output": "DescribePostpaidUsageResponse",
113
- "status": "online"
114
- },
115
- "DescribeQualityMetrics": {
116
- "document": "查询互动白板质量数据",
117
- "input": "DescribeQualityMetricsRequest",
118
- "name": "查询质量数据",
119
- "output": "DescribeQualityMetricsResponse",
120
- "status": "online"
121
- },
122
- "DescribeRecordSearch": {
123
- "document": "根据房间号搜索实时录制任务",
124
- "input": "DescribeRecordSearchRequest",
125
- "name": "搜索实时录制任务",
126
- "output": "DescribeRecordSearchResponse",
127
- "status": "online"
128
- },
129
- "DescribeRoomList": {
130
- "document": "查询白板房间列表",
131
- "input": "DescribeRoomListRequest",
132
- "name": "查询白板房间列表",
133
- "output": "DescribeRoomListResponse",
134
- "status": "online"
135
- },
136
59
  "DescribeRunningTasks": {
137
60
  "document": "根据指定的任务类型，获取当前正在执行中的任务列表。只能查询最近3天内创建的任务。",
138
61
  "input": "DescribeRunningTasksRequest",
@@ -147,20 +70,6 @@
147
70
  "output": "DescribeSnapshotTaskResponse",
148
71
  "status": "online"
149
72
  },
150
- "DescribeTIWDailyUsage": {
151
- "document": "查询互动白板天维度计费用量。\n1. 单次查询统计区间最多不能超过31天。\n2. 由于统计延迟等原因，暂时不支持查询当天数据，建议在次日上午7点以后再来查询前一天的用量，例如在10月27日上午7点后，再来查询到10月26日整天的用量\n",
152
- "input": "DescribeTIWDailyUsageRequest",
153
- "name": "查询天维度计费用量",
154
- "output": "DescribeTIWDailyUsageResponse",
155
- "status": "online"
156
- },
157
- "DescribeTIWRoomDailyUsage": {
158
- "document": "查询互动白板房间维度每天计费用量。\n1. 单次查询统计区间最多不能超过31天。\n2. 由于统计延迟等原因，暂时不支持查询当天数据，建议在次日上午7点以后再来查询前一天的用量，例如在10月27日上午7点后，再来查询到10月26日整天的用量\n",
159
- "input": "DescribeTIWRoomDailyUsageRequest",
160
- "name": "查询房间维度每天计费用量",
161
- "output": "DescribeTIWRoomDailyUsageResponse",
162
- "status": "online"
163
- },
164
73
  "DescribeTranscode": {
165
74
  "document": "查询文档转码任务的执行进度与转码结果",
166
75
  "input": "DescribeTranscodeRequest",
@@ -169,7 +78,7 @@
169
78
  "status": "online"
170
79
  },
171
80
  "DescribeTranscodeByUrl": {
172
- "document": "通过文档URL查询转码任务，返回最近一次的转码任务状态",
81
+ "document": "通过文档URL查询转码任务，返回最近一天内最新的转码任务状态",
173
82
  "input": "DescribeTranscodeByUrlRequest",
174
83
  "name": "通过文档URL查询转码任务状态",
175
84
  "output": "DescribeTranscodeByUrlResponse",
@@ -182,41 +91,6 @@
182
91
  "output": "DescribeTranscodeCallbackResponse",
183
92
  "status": "online"
184
93
  },
185
- "DescribeTranscodeSearch": {
186
- "document": "按文档名称搜索转码任务",
187
- "input": "DescribeTranscodeSearchRequest",
188
- "name": "搜索转码任务",
189
- "output": "DescribeTranscodeSearchResponse",
190
- "status": "online"
191
- },
192
- "DescribeUsageSummary": {
193
- "document": "查询指定时间段内子产品的用量汇总",
194
- "input": "DescribeUsageSummaryRequest",
195
- "name": "查询子产品用量统计",
196
- "output": "DescribeUsageSummaryResponse",
197
- "status": "online"
198
- },
199
- "DescribeUserList": {
200
- "document": "查询白板用户列表",
201
- "input": "DescribeUserListRequest",
202
- "name": "查询白板用户列表",
203
- "output": "DescribeUserListResponse",
204
- "status": "online"
205
- },
206
- "DescribeUserResources": {
207
- "document": "查询客户资源列表",
208
- "input": "DescribeUserResourcesRequest",
209
- "name": "查询客户资源列表",
210
- "output": "DescribeUserResourcesResponse",
211
- "status": "online"
212
- },
213
- "DescribeUserStatus": {
214
- "document": "查询互动白板用户详情，包括是否开通了互动白板，当前互动白板服务有效期等信息\n",
215
- "input": "DescribeUserStatusRequest",
216
- "name": "查询互动白板用户详情",
217
- "output": "DescribeUserStatusResponse",
218
- "status": "online"
219
- },
220
94
  "DescribeVideoGenerationTask": {
221
95
  "document": "查询录制视频生成任务状态与结果",
222
96
  "input": "DescribeVideoGenerationTaskRequest",
@@ -238,20 +112,6 @@
238
112
  "output": "DescribeWarningCallbackResponse",
239
113
  "status": "online"
240
114
  },
241
- "DescribeWhiteboardApplicationConfig": {
242
- "document": "查询白板应用任务相关的配置，包括存储桶、回调等",
243
- "input": "DescribeWhiteboardApplicationConfigRequest",
244
- "name": "查询白板应用任务相关配置",
245
- "output": "DescribeWhiteboardApplicationConfigResponse",
246
- "status": "online"
247
- },
248
- "DescribeWhiteboardBucketConfig": {
249
- "document": "查询文档转码，实时录制存储桶的配置",
250
- "input": "DescribeWhiteboardBucketConfigRequest",
251
- "name": "查询应用资源配置",
252
- "output": "DescribeWhiteboardBucketConfigResponse",
253
- "status": "online"
254
- },
255
115
  "DescribeWhiteboardPush": {
256
116
  "document": "查询推流任务状态与结果",
257
117
  "input": "DescribeWhiteboardPushRequest",
@@ -266,41 +126,6 @@
266
126
  "output": "DescribeWhiteboardPushCallbackResponse",
267
127
  "status": "online"
268
128
  },
269
- "DescribeWhiteboardPushSearch": {
270
- "document": "根据房间号搜索白板推流任务",
271
- "input": "DescribeWhiteboardPushSearchRequest",
272
- "name": "搜索白板推流任务",
273
- "output": "DescribeWhiteboardPushSearchResponse",
274
- "status": "online"
275
- },
276
- "ModifyApplication": {
277
- "document": "修改白板应用",
278
- "input": "ModifyApplicationRequest",
279
- "name": "修改白板应用",
280
- "output": "ModifyApplicationResponse",
281
- "status": "online"
282
- },
283
- "ModifyAutoRenewFlag": {
284
- "document": "设置白板月功能费自动续费",
285
- "input": "ModifyAutoRenewFlagRequest",
286
- "name": "设置自动续费",
287
- "output": "ModifyAutoRenewFlagResponse",
288
- "status": "online"
289
- },
290
- "ModifyWhiteboardApplicationConfig": {
291
- "document": "修改白板应用任务相关的配置，包括存储桶、回调等",
292
- "input": "ModifyWhiteboardApplicationConfigRequest",
293
- "name": "修改白板应用任务相关配置",
294
- "output": "ModifyWhiteboardApplicationConfigResponse",
295
- "status": "online"
296
- },
297
- "ModifyWhiteboardBucketConfig": {
298
- "document": "设置文档转码，实时录制存储桶的配置",
299
- "input": "ModifyWhiteboardBucketConfigRequest",
300
- "name": "设置应用资源存储桶配置",
301
- "output": "ModifyWhiteboardBucketConfigResponse",
302
- "status": "online"
303
- },
304
129
  "PauseOnlineRecord": {
305
130
  "document": "暂停实时录制",
306
131
  "input": "PauseOnlineRecordRequest",
@@ -428,69 +253,6 @@
428
253
  "serviceShortName": "tiw"
429
254
  },
430
255
  "objects": {
431
- "ApplicationItem": {
432
- "document": "白板应用",
433
- "members": [
434
- {
435
- "disabled": false,
436
- "document": "应用SdkAppId",
437
- "example": "",
438
- "member": "int64",
439
- "name": "SdkAppId",
440
- "required": true,
441
- "type": "int",
442
- "value_allowed_null": false
443
- },
444
- {
445
- "disabled": false,
446
- "document": "应用名",
447
- "example": "",
448
- "member": "string",
449
- "name": "AppName",
450
- "required": true,
451
- "type": "string",
452
- "value_allowed_null": false
453
- },
454
- {
455
- "disabled": false,
456
- "document": "创建时间",
457
- "example": "",
458
- "member": "datetime",
459
- "name": "CreateTime",
460
- "required": true,
461
- "type": "string",
462
- "value_allowed_null": false
463
- },
464
- {
465
- "disabled": false,
466
- "document": "标签列表",
467
- "example": "",
468
- "member": "Tag",
469
- "name": "TagList",
470
- "required": true,
471
- "type": "list",
472
- "value_allowed_null": false
473
- }
474
- ],
475
- "usage": "out"
476
- },
477
- "ApplyTiwTrialRequest": {
478
- "document": "ApplyTiwTrial请求参数结构体",
479
- "members": [],
480
- "type": "object"
481
- },
482
- "ApplyTiwTrialResponse": {
483
- "document": "ApplyTiwTrial返回参数结构体",
484
- "members": [
485
- {
486
- "document": "唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。",
487
- "member": "string",
488
- "name": "RequestId",
489
- "type": "string"
490
- }
491
- ],
492
- "type": "object"
493
- },
494
256
  "AuthParam": {
495
257
  "document": "鉴权参数",
496
258
  "members": [
@@ -579,99 +341,6 @@
579
341
  ],
580
342
  "usage": "in"
581
343
  },
582
- "CreateApplicationRequest": {
583
- "document": "CreateApplication请求参数结构体",
584
- "members": [
585
- {
586
- "disabled": false,
587
- "document": "应用SdkAppId",
588
- "example": "1400000001",
589
- "member": "int64",
590
- "name": "SdkAppId",
591
- "required": true,
592
- "type": "int"
593
- },
594
- {
595
- "disabled": false,
596
- "document": "App名字",
597
- "example": "ForTest",
598
- "member": "string",
599
- "name": "AppName",
600
- "required": false,
601
- "type": "string"
602
- },
603
- {
604
- "disabled": false,
605
- "document": "创建IM应用需要的SKey",
606
- "example": "Azu23oixeru90kic11cMw",
607
- "member": "string",
608
- "name": "SKey",
609
- "required": false,
610
- "type": "string"
611
- },
612
- {
613
- "disabled": false,
614
- "document": "创建IM应用需要的TinyId",
615
- "example": "1401234005243",
616
- "member": "string",
617
- "name": "TinyId",
618
- "required": false,
619
- "type": "string"
620
- },
621
- {
622
- "disabled": false,
623
- "document": "需要绑定的标签列表",
624
- "example": "无",
625
- "member": "Tag",
626
- "name": "TagList",
627
- "required": false,
628
- "type": "list"
629
- }
630
- ],
631
- "type": "object"
632
- },
633
- "CreateApplicationResponse": {
634
- "document": "CreateApplication返回参数结构体",
635
- "members": [
636
- {
637
- "disabled": false,
638
- "document": "客户的AppId",
639
- "example": "1200000001",
640
- "member": "int64",
641
- "name": "AppId",
642
- "output_required": true,
643
- "type": "int",
644
- "value_allowed_null": false
645
- },
646
- {
647
- "disabled": false,
648
- "document": "App名字",
649
- "example": "ForTest",
650
- "member": "string",
651
- "name": "AppName",
652
- "output_required": true,
653
- "type": "string",
654
- "value_allowed_null": false
655
- },
656
- {
657
- "disabled": false,
658
- "document": "应用SdkAppId",
659
- "example": "1400000001",
660
- "member": "int64",
661
- "name": "SdkAppId",
662
- "output_required": true,
663
- "type": "int",
664
- "value_allowed_null": false
665
- },
666
- {
667
- "document": "唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。",
668
- "member": "string",
669
- "name": "RequestId",
670
- "type": "string"
671
- }
672
- ],
673
- "type": "object"
674
- },
675
344
  "CreatePPTCheckTaskRequest": {
676
345
  "document": "CreatePPTCheckTask请求参数结构体",
677
346
  "members": [
@@ -704,7 +373,7 @@
704
373
  },
705
374
  {
706
375
  "disabled": false,
707
- "document": "此参数仅在`AutoHandleUnsupportedElement`参数为`true`的情况下有效。\n\n指定需要自动处理的不兼容元素类型，默认对所有不兼容的元素进行自动处理。\n\n目前支持检测的不兼容元素类型及对应的自动处理方式如下：\n0: 不支持的墨迹类型\n-- 自动处理方式：移除墨迹\n\n1: 自动翻页\n-- 自动处理方式：移除自动翻页设置，并修改为单击切换\n\n2: 已损坏音视频\n-- 自动处理方式：移除对损坏音视频的引用\n\n3: 不可访问资源\n-- 自动处理方式：移除对不可访问的资源的引用\n\n4: 只读文件\n-- 自动处理方式：移除只读设置\n\n5: 不支持的元素编辑锁定状态\n-- 自动处理方式：移除锁定状态\n\n6: 可能有兼容问题的字体\n-- 自动处理方式： 不支持处理\n\n7: 设置了柔化边缘的GIF图片\n-- 自动处理方式：移除柔化边缘设置\n\n8: 存在不兼容的空格下划线\n-- 自动处理方式：通过调整空格下划线前后文本的字体语言体系，保证空格下划线表现正常\n\n9: 存在设置了分段动画的数学公式和文本混合内容\n-- 自动处理方式： 不支持处理\n\n10: 存在设置了分段动画的渐变色文本\n-- 自动处理方式： 不支持处理\n\n11: 存在不兼容的分散对齐方式\n-- 自动处理方式： 不支持处理\n\n12: 存在不兼容的多倍行距设置\n-- 自动处理方式： 不支持处理",
376
+ "document": "此参数仅在`AutoHandleUnsupportedElement`参数为`true`的情况下有效。\n\n指定需要自动处理的不兼容元素类型，默认对所有不兼容的元素进行自动处理。\n\n目前支持检测的不兼容元素类型及对应的自动处理方式如下：\n0: 不支持的墨迹类型\n-- 自动处理方式：移除墨迹\n\n1: 自动翻页\n-- 自动处理方式：移除自动翻页设置，并修改为单击切换\n\n2: 已损坏音视频\n-- 自动处理方式：移除对损坏音视频的引用\n\n3: 不可访问资源\n-- 自动处理方式：移除对不可访问的资源的引用\n\n4: 只读文件\n-- 自动处理方式：移除只读设置\n\n5: 不支持的元素编辑锁定状态\n-- 自动处理方式：移除锁定状态\n\n6: 可能有兼容问题的字体\n-- 自动处理方式： 不支持处理\n\n7: 设置了柔化边缘的GIF图片\n-- 自动处理方式：移除柔化边缘设置\n\n8: 存在不兼容的空格下划线\n-- 自动处理方式：通过调整空格下划线前后文本的字体语言体系，保证空格下划线表现正常\n\n9: 存在设置了分段动画的数学公式和文本混合内容\n-- 自动处理方式： 不支持处理\n\n10: 存在设置了分段动画的渐变色文本\n-- 自动处理方式： 不支持处理\n\n11: 存在不兼容的分散对齐方式\n-- 自动处理方式： 不支持处理\n\n12: 存在不兼容的多倍行距设置\n-- 自动处理方式： 不支持处理\n\n13: 存在带有特殊符号内容的datetime类型的a:fld标签元素\n-- 自动处理方式： a:fld标签替换为普通文本",
708
377
  "example": "[0, 1, 2]",
709
378
  "member": "int64",
710
379
  "name": "AutoHandleUnsupportedElementTypes",
@@ -959,8 +628,8 @@
959
628
  "members": [
960
629
  {
961
630
  "disabled": false,
962
- "document": "录制任务的TaskId",
963
- "example": "",
631
+ "document": "实时录制任务的TaskId",
632
+ "example": "bj0mt2l23osdj300hl30",
964
633
  "member": "string",
965
634
  "name": "OnlineRecordTaskId",
966
635
  "required": true,
@@ -969,7 +638,7 @@
969
638
  {
970
639
  "disabled": false,
971
640
  "document": "客户的SdkAppId",
972
- "example": "",
641
+ "example": "1400000001",
973
642
  "member": "int64",
974
643
  "name": "SdkAppId",
975
644
  "required": true,
@@ -978,7 +647,7 @@
978
647
  {
979
648
  "disabled": false,
980
649
  "document": "视频生成的白板参数，例如白板宽高等。\n\n此参数与开始录制接口提供的Whiteboard参数互斥，在本接口与开始录制接口都提供了Whiteboard参数时，优先使用本接口指定的Whiteboard参数进行视频生成，否则使用开始录制接口提供的Whiteboard参数进行视频生成。",
981
- "example": "",
650
+ "example": "1280*960",
982
651
  "member": "Whiteboard",
983
652
  "name": "Whiteboard",
984
653
  "required": false,
@@ -987,7 +656,7 @@
987
656
  {
988
657
  "disabled": false,
989
658
  "document": "视频拼接参数\n\n此参数与开始录制接口提供的Concat参数互斥，在本接口与开始录制接口都提供了Concat参数时，优先使用本接口指定的Concat参数进行视频拼接，否则使用开始录制接口提供的Concat参数进行视频拼接。",
990
- "example": "",
659
+ "example": "否",
991
660
  "member": "Concat",
992
661
  "name": "Concat",
993
662
  "required": false,
@@ -996,7 +665,7 @@
996
665
  {
997
666
  "disabled": false,
998
667
  "document": "视频生成混流参数\n\n此参数与开始录制接口提供的MixStream参数互斥，在本接口与开始录制接口都提供了MixStream参数时，优先使用本接口指定的MixStream参数进行视频混流，否则使用开始录制接口提供的MixStream参数进行视频拼混流。",
999
- "example": "",
668
+ "example": "否",
1000
669
  "member": "MixStream",
1001
670
  "name": "MixStream",
1002
671
  "required": false,
@@ -1005,7 +674,7 @@
1005
674
  {
1006
675
  "disabled": false,
1007
676
  "document": "视频生成控制参数，用于更精细地指定需要生成哪些流，某一路流是否禁用音频，是否只录制小画面等\n\n此参数与开始录制接口提供的RecordControl参数互斥，在本接口与开始录制接口都提供了RecordControl参数时，优先使用本接口指定的RecordControl参数进行视频生成控制，否则使用开始录制接口提供的RecordControl参数进行视频拼生成控制。",
1008
- "example": "",
677
+ "example": "否",
1009
678
  "member": "RecordControl",
1010
679
  "name": "RecordControl",
1011
680
  "required": false,
@@ -1014,7 +683,7 @@
1014
683
  {
1015
684
  "disabled": false,
1016
685
  "document": "内部参数",
1017
- "example": "",
686
+ "example": "'''",
1018
687
  "member": "string",
1019
688
  "name": "ExtraData",
1020
689
  "required": false,
@@ -1029,9 +698,10 @@
1029
698
  {
1030
699
  "disabled": false,
1031
700
  "document": "视频生成的任务Id",
1032
- "example": "",
701
+ "example": "bj0mt2l23osdj300hl30",
1033
702
  "member": "string",
1034
703
  "name": "TaskId",
704
+ "output_required": true,
1035
705
  "type": "string",
1036
706
  "value_allowed_null": false
1037
707
  },
@@ -1070,434 +740,87 @@
1070
740
  ],
1071
741
  "usage": "in"
1072
742
  },
1073
- "DataItem": {
1074
- "document": "画图数据，Time/Value/Details",
743
+ "DescribeOnlineRecordCallbackRequest": {
744
+ "document": "DescribeOnlineRecordCallback请求参数结构体",
1075
745
  "members": [
1076
746
  {
1077
747
  "disabled": false,
1078
- "document": "时间\n按月格式yyyy-mm\n按天格式yyyy-mm-dd\n按分钟格式 yyyy-mm-dd HH:MM:SS",
1079
- "example": "",
748
+ "document": "应用的SdkAppId",
749
+ "example": "1400000001",
750
+ "member": "int64",
751
+ "name": "SdkAppId",
752
+ "required": true,
753
+ "type": "int"
754
+ }
755
+ ],
756
+ "type": "object"
757
+ },
758
+ "DescribeOnlineRecordCallbackResponse": {
759
+ "document": "DescribeOnlineRecordCallback返回参数结构体",
760
+ "members": [
761
+ {
762
+ "disabled": false,
763
+ "document": "实时录制事件回调地址，如果未设置回调地址，该字段为空字符串",
764
+ "example": "https://example.com/online/callback",
1080
765
  "member": "string",
1081
- "name": "Time",
766
+ "name": "Callback",
1082
767
  "required": true,
1083
768
  "type": "string",
1084
769
  "value_allowed_null": false
1085
770
  },
1086
771
  {
1087
772
  "disabled": false,
1088
- "document": "画图所需要的值",
1089
- "example": "",
1090
- "member": "int64",
1091
- "name": "Value",
773
+ "document": "实时录制回调鉴权密钥",
774
+ "example": "6vg9G7Fd",
775
+ "member": "string",
776
+ "name": "CallbackKey",
1092
777
  "required": true,
1093
- "type": "int",
778
+ "type": "string",
1094
779
  "value_allowed_null": false
1095
780
  },
1096
781
  {
1097
- "disabled": false,
1098
- "document": "各个具体指标的详情",
1099
- "example": "",
1100
- "member": "Detail",
1101
- "name": "Details",
1102
- "required": true,
1103
- "type": "list",
1104
- "value_allowed_null": false
782
+ "document": "唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。",
783
+ "member": "string",
784
+ "name": "RequestId",
785
+ "type": "string"
1105
786
  }
1106
787
  ],
1107
- "usage": "out"
788
+ "type": "object"
1108
789
  },
1109
- "DescribeAPIServiceRequest": {
1110
- "document": "DescribeAPIService请求参数结构体",
790
+ "DescribeOnlineRecordRequest": {
791
+ "document": "DescribeOnlineRecord请求参数结构体",
1111
792
  "members": [
1112
793
  {
1113
794
  "disabled": false,
1114
- "document": "目前支持的Service为cos:GetService，cdn:DescribeDomainsConfig",
1115
- "example": "",
1116
- "member": "string",
1117
- "name": "Service",
795
+ "document": "客户的SdkAppId",
796
+ "example": "1400000001",
797
+ "member": "int64",
798
+ "name": "SdkAppId",
1118
799
  "required": true,
1119
- "type": "string"
800
+ "type": "int"
1120
801
  },
1121
802
  {
1122
803
  "disabled": false,
1123
- "document": "JSON格式的请求参数",
1124
- "example": "",
804
+ "document": "实时录制任务Id",
805
+ "example": "ghucnligqtgtvk2624mb",
1125
806
  "member": "string",
1126
- "name": "Data",
1127
- "required": false,
807
+ "name": "TaskId",
808
+ "required": true,
1128
809
  "type": "string"
1129
810
  }
1130
811
  ],
1131
812
  "type": "object"
1132
813
  },
1133
- "DescribeAPIServiceResponse": {
1134
- "document": "DescribeAPIService返回参数结构体",
814
+ "DescribeOnlineRecordResponse": {
815
+ "document": "DescribeOnlineRecord返回参数结构体",
1135
816
  "members": [
1136
817
  {
1137
818
  "disabled": false,
1138
- "document": "Json格式的响应数据",
1139
- "example": "",
819
+ "document": "录制结束原因，\n- AUTO: 房间内长时间没有音视频上行及白板操作导致自动停止录制\n- USER_CALL: 主动调用了停止录制接口\n- EXCEPTION: 录制异常结束\n- FORCE_STOP: 强制停止录制，一般是因为暂停超过90分钟或者录制总时长超过24小时。",
820
+ "example": "USER_CALL",
1140
821
  "member": "string",
1141
- "name": "ResponseData",
1142
- "type": "string",
1143
- "value_allowed_null": false
1144
- },
1145
- {
1146
- "document": "唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。",
1147
- "member": "string",
1148
- "name": "RequestId",
1149
- "type": "string"
1150
- }
1151
- ],
1152
- "type": "object"
1153
- },
1154
- "DescribeApplicationInfosRequest": {
1155
- "document": "DescribeApplicationInfos请求参数结构体",
1156
- "members": [],
1157
- "type": "object"
1158
- },
1159
- "DescribeApplicationInfosResponse": {
1160
- "document": "DescribeApplicationInfos返回参数结构体",
1161
- "members": [
1162
- {
1163
- "disabled": false,
1164
- "document": "应用列表",
1165
- "example": "无",
1166
- "member": "ApplicationItem",
1167
- "name": "ApplicationInfos",
1168
- "required": true,
1169
- "type": "list",
1170
- "value_allowed_null": false
1171
- },
1172
- {
1173
- "disabled": false,
1174
- "document": "是否包含所有的应用，0-不包含，1-包含",
1175
- "example": "1",
1176
- "member": "int64",
1177
- "name": "AllOption",
1178
- "required": true,
1179
- "type": "int",
1180
- "value_allowed_null": false
1181
- },
1182
- {
1183
- "document": "唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。",
1184
- "member": "string",
1185
- "name": "RequestId",
1186
- "type": "string"
1187
- }
1188
- ],
1189
- "type": "object"
1190
- },
1191
- "DescribeApplicationUsageRequest": {
1192
- "document": "DescribeApplicationUsage请求参数结构体",
1193
- "members": [
1194
- {
1195
- "disabled": false,
1196
- "document": "用量开始时间（包括该时间点）",
1197
- "example": "2019-10-01 00:00:00",
1198
- "member": "datetime",
1199
- "name": "BeginTime",
1200
- "required": true,
1201
- "type": "string"
1202
- },
1203
- {
1204
- "disabled": false,
1205
- "document": "用量结束时间（不包括该时间点）",
1206
- "example": "2019-12-31 00:00:00",
1207
- "member": "datetime",
1208
- "name": "EndTime",
1209
- "required": true,
1210
- "type": "string"
1211
- },
1212
- {
1213
- "disabled": false,
1214
- "document": "白板子产品名",
1215
- "example": "sp_tiw_ric",
1216
- "member": "string",
1217
- "name": "SubProduct",
1218
- "required": true,
1219
- "type": "string"
1220
- },
1221
- {
1222
- "disabled": false,
1223
- "document": "时间跨度单位\n- MONTHLY：月\n- DAILY：天\n- MINUTELY：分钟",
1224
- "example": "DAILY",
1225
- "member": "string",
1226
- "name": "TimeLevel",
1227
- "required": true,
1228
- "type": "string"
1229
- },
1230
- {
1231
- "disabled": false,
1232
- "document": "白板应用的SdkAppId",
1233
- "example": "1400000001",
1234
- "member": "int64",
1235
- "name": "SdkAppId",
1236
- "required": false,
1237
- "type": "int"
1238
- },
1239
- {
1240
- "disabled": false,
1241
- "document": "true: 返回加权求和后的用量数据\nfalse: 返回原始用量数据",
1242
- "example": "1",
1243
- "member": "bool",
1244
- "name": "IsWeighted",
1245
- "required": false,
1246
- "type": "bool"
1247
- }
1248
- ],
1249
- "type": "object"
1250
- },
1251
- "DescribeApplicationUsageResponse": {
1252
- "document": "DescribeApplicationUsage返回参数结构体",
1253
- "members": [
1254
- {
1255
- "disabled": false,
1256
- "document": "画图所需的用量数据",
1257
- "example": "无",
1258
- "member": "DataItem",
1259
- "name": "Data",
1260
- "required": true,
1261
- "type": "list",
1262
- "value_allowed_null": false
1263
- },
1264
- {
1265
- "document": "唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。",
1266
- "member": "string",
1267
- "name": "RequestId",
1268
- "type": "string"
1269
- }
1270
- ],
1271
- "type": "object"
1272
- },
1273
- "DescribeBoardSDKLogRequest": {
1274
- "document": "DescribeBoardSDKLog请求参数结构体",
1275
- "members": [
1276
- {
1277
- "disabled": false,
1278
- "document": "白板应用的SdkAppId",
1279
- "example": "1400000001",
1280
- "member": "int64",
1281
- "name": "SdkAppId",
1282
- "required": true,
1283
- "type": "int"
1284
- },
1285
- {
1286
- "disabled": false,
1287
- "document": "需要查询日志的白板房间号",
1288
- "example": "10000",
1289
- "member": "string",
1290
- "name": "RoomId",
1291
- "required": true,
1292
- "type": "string"
1293
- },
1294
- {
1295
- "disabled": false,
1296
- "document": "需要查询日志的用户ID",
1297
- "example": "tic_web",
1298
- "member": "string",
1299
- "name": "UserId",
1300
- "required": true,
1301
- "type": "string"
1302
- },
1303
- {
1304
- "disabled": false,
1305
- "document": "查询时间段，Unix时间戳，单位毫秒，第一个值为开始时间戳，第二个值为结束时间",
1306
- "example": "[1614519034000,1614691834999]",
1307
- "member": "int64",
1308
- "name": "TimeRange",
1309
- "required": true,
1310
- "type": "list"
1311
- },
1312
- {
1313
- "disabled": false,
1314
- "document": "聚合日志条数查询的桶的时间范围，如5m, 1h, 4h等",
1315
- "example": "5m",
1316
- "member": "string",
1317
- "name": "AggregationInterval",
1318
- "required": true,
1319
- "type": "string"
1320
- },
1321
- {
1322
- "disabled": false,
1323
- "document": "额外的查询条件",
1324
- "example": "action: addData",
1325
- "member": "string",
1326
- "name": "Query",
1327
- "required": false,
1328
- "type": "string"
1329
- },
1330
- {
1331
- "disabled": false,
1332
- "document": "是否按时间升序排列",
1333
- "example": "false",
1334
- "member": "bool",
1335
- "name": "Ascending",
1336
- "required": false,
1337
- "type": "bool"
1338
- },
1339
- {
1340
- "disabled": false,
1341
- "document": "用于递归拉取的上下文Key，在上一次请求中返回",
1342
- "example": "空",
1343
- "member": "string",
1344
- "name": "Context",
1345
- "required": false,
1346
- "type": "string"
1347
- }
1348
- ],
1349
- "type": "object"
1350
- },
1351
- "DescribeBoardSDKLogResponse": {
1352
- "document": "DescribeBoardSDKLog返回参数结构体",
1353
- "members": [
1354
- {
1355
- "disabled": false,
1356
- "document": "总共能查到日志条数",
1357
- "example": "65",
1358
- "member": "int64",
1359
- "name": "Total",
1360
- "required": true,
1361
- "type": "int",
1362
- "value_allowed_null": false
1363
- },
1364
- {
1365
- "disabled": false,
1366
- "document": "日志详细内容",
1367
- "example": "[]",
1368
- "member": "string",
1369
- "name": "Sources",
1370
- "required": true,
1371
- "type": "list",
1372
- "value_allowed_null": false
1373
- },
1374
- {
1375
- "disabled": false,
1376
- "document": "按时间段聚合后每个时间段的日志条数",
1377
- "example": "[]",
1378
- "member": "string",
1379
- "name": "Buckets",
1380
- "required": true,
1381
- "type": "list",
1382
- "value_allowed_null": false
1383
- },
1384
- {
1385
- "disabled": false,
1386
- "document": "用于递归拉取的上下文Key，下一次请求的时候带上",
1387
- "example": "空",
1388
- "member": "string",
1389
- "name": "Context",
1390
- "required": true,
1391
- "type": "string",
1392
- "value_allowed_null": false
1393
- },
1394
- {
1395
- "document": "唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。",
1396
- "member": "string",
1397
- "name": "RequestId",
1398
- "type": "string"
1399
- }
1400
- ],
1401
- "type": "object"
1402
- },
1403
- "DescribeIMApplicationsRequest": {
1404
- "document": "DescribeIMApplications请求参数结构体",
1405
- "members": [],
1406
- "type": "object"
1407
- },
1408
- "DescribeIMApplicationsResponse": {
1409
- "document": "DescribeIMApplications返回参数结构体",
1410
- "members": [
1411
- {
1412
- "document": "唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。",
1413
- "member": "string",
1414
- "name": "RequestId",
1415
- "type": "string"
1416
- }
1417
- ],
1418
- "type": "object"
1419
- },
1420
- "DescribeOnlineRecordCallbackRequest": {
1421
- "document": "DescribeOnlineRecordCallback请求参数结构体",
1422
- "members": [
1423
- {
1424
- "disabled": false,
1425
- "document": "应用的SdkAppId",
1426
- "example": "1400000001",
1427
- "member": "int64",
1428
- "name": "SdkAppId",
1429
- "required": true,
1430
- "type": "int"
1431
- }
1432
- ],
1433
- "type": "object"
1434
- },
1435
- "DescribeOnlineRecordCallbackResponse": {
1436
- "document": "DescribeOnlineRecordCallback返回参数结构体",
1437
- "members": [
1438
- {
1439
- "disabled": false,
1440
- "document": "实时录制事件回调地址，如果未设置回调地址，该字段为空字符串",
1441
- "example": "https://example.com/online/callback",
1442
- "member": "string",
1443
- "name": "Callback",
1444
- "required": true,
1445
- "type": "string",
1446
- "value_allowed_null": false
1447
- },
1448
- {
1449
- "disabled": false,
1450
- "document": "实时录制回调鉴权密钥",
1451
- "example": "6vg9G7Fd",
1452
- "member": "string",
1453
- "name": "CallbackKey",
1454
- "required": true,
1455
- "type": "string",
1456
- "value_allowed_null": false
1457
- },
1458
- {
1459
- "document": "唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。",
1460
- "member": "string",
1461
- "name": "RequestId",
1462
- "type": "string"
1463
- }
1464
- ],
1465
- "type": "object"
1466
- },
1467
- "DescribeOnlineRecordRequest": {
1468
- "document": "DescribeOnlineRecord请求参数结构体",
1469
- "members": [
1470
- {
1471
- "disabled": false,
1472
- "document": "客户的SdkAppId",
1473
- "example": "1400000001",
1474
- "member": "int64",
1475
- "name": "SdkAppId",
1476
- "required": true,
1477
- "type": "int"
1478
- },
1479
- {
1480
- "disabled": false,
1481
- "document": "实时录制任务Id",
1482
- "example": "ghucnligqtgtvk2624mb",
1483
- "member": "string",
1484
- "name": "TaskId",
1485
- "required": true,
1486
- "type": "string"
1487
- }
1488
- ],
1489
- "type": "object"
1490
- },
1491
- "DescribeOnlineRecordResponse": {
1492
- "document": "DescribeOnlineRecord返回参数结构体",
1493
- "members": [
1494
- {
1495
- "disabled": false,
1496
- "document": "录制结束原因，\n- AUTO: 房间内长时间没有音视频上行及白板操作导致自动停止录制\n- USER_CALL: 主动调用了停止录制接口\n- EXCEPTION: 录制异常结束\n- FORCE_STOP: 强制停止录制，一般是因为暂停超过90分钟或者录制总时长超过24小时。",
1497
- "example": "USER_CALL",
1498
- "member": "string",
1499
- "name": "FinishReason",
1500
- "required": true,
822
+ "name": "FinishReason",
823
+ "required": true,
1501
824
  "type": "string",
1502
825
  "value_allowed_null": false
1503
826
  },
@@ -1609,297 +932,27 @@
1609
932
  "name": "VideoInfos",
1610
933
  "required": true,
1611
934
  "type": "list",
1612
- "value_allowed_null": false
1613
- },
1614
- {
1615
- "disabled": false,
1616
- "document": "回放URL，需配合信令播放器使用。此字段仅适用于`视频生成模式`\n注意：此字段可能返回 null，表示取不到有效值。",
1617
- "example": "http://replayurl",
1618
- "member": "string",
1619
- "name": "ReplayUrl",
1620
- "required": true,
1621
- "type": "string",
1622
- "value_allowed_null": true
1623
- },
1624
- {
1625
- "disabled": false,
1626
- "document": "视频流在录制过程中断流次数\n注意：此字段可能返回 null，表示取不到有效值。",
1627
- "example": "无",
1628
- "member": "Interrupt",
1629
- "name": "Interrupts",
1630
- "required": true,
1631
- "type": "list",
1632
- "value_allowed_null": true
1633
- },
1634
- {
1635
- "document": "唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。",
1636
- "member": "string",
1637
- "name": "RequestId",
1638
- "type": "string"
1639
- }
1640
- ],
1641
- "type": "object"
1642
- },
1643
- "DescribePPTCheckCallbackRequest": {
1644
- "document": "DescribePPTCheckCallback请求参数结构体",
1645
- "members": [
1646
- {
1647
- "disabled": false,
1648
- "document": "应用的SdkAppId",
1649
- "example": "1400000001",
1650
- "member": "int64",
1651
- "name": "SdkAppId",
1652
- "required": true,
1653
- "type": "int"
1654
- }
1655
- ],
1656
- "type": "object"
1657
- },
1658
- "DescribePPTCheckCallbackResponse": {
1659
- "document": "DescribePPTCheckCallback返回参数结构体",
1660
- "members": [
1661
- {
1662
- "disabled": false,
1663
- "document": "回调地址",
1664
- "example": "https://example.com/transcode/callback",
1665
- "member": "string",
1666
- "name": "Callback",
1667
- "type": "string",
1668
- "value_allowed_null": false
1669
- },
1670
- {
1671
- "disabled": false,
1672
- "document": "回调鉴权密钥",
1673
- "example": "6vg9G7Fd",
1674
- "member": "string",
1675
- "name": "CallbackKey",
1676
- "type": "string",
1677
- "value_allowed_null": false
1678
- },
1679
- {
1680
- "document": "唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。",
1681
- "member": "string",
1682
- "name": "RequestId",
1683
- "type": "string"
1684
- }
1685
- ],
1686
- "type": "object"
1687
- },
1688
- "DescribePPTCheckRequest": {
1689
- "document": "DescribePPTCheck请求参数结构体",
1690
- "members": [
1691
- {
1692
- "disabled": false,
1693
- "document": "客户的SdkAppId",
1694
- "example": "1400000001",
1695
- "member": "int64",
1696
- "name": "SdkAppId",
1697
- "required": true,
1698
- "type": "int"
1699
- },
1700
- {
1701
- "disabled": false,
1702
- "document": "任务的唯一标识Id",
1703
- "example": "g0jb42ps49vtebjshilb",
1704
- "member": "string",
1705
- "name": "TaskId",
1706
- "required": true,
1707
- "type": "string"
1708
- }
1709
- ],
1710
- "type": "object"
1711
- },
1712
- "DescribePPTCheckResponse": {
1713
- "document": "DescribePPTCheck返回参数结构体",
1714
- "members": [
1715
- {
1716
- "disabled": false,
1717
- "document": "任务的唯一标识Id",
1718
- "example": "0agdnligqtgtvkm65emb",
1719
- "member": "string",
1720
- "name": "TaskId",
1721
- "output_required": true,
1722
- "type": "string",
1723
- "value_allowed_null": false
1724
- },
1725
- {
1726
- "disabled": false,
1727
- "document": "PPT文件是否正常",
1728
- "example": "false",
1729
- "member": "bool",
1730
- "name": "IsOK",
1731
- "output_required": true,
1732
- "type": "bool",
1733
- "value_allowed_null": false
1734
- },
1735
- {
1736
- "disabled": false,
1737
- "document": "修复后的PPT URL，只有创建任务时参数AutoHandleUnsupportedElement=true，才返回此参数\n注意：此字段可能返回 null，表示取不到有效值。",
1738
- "example": "https://xxx/xxx/测试_fixed.ppt",
1739
- "member": "string",
1740
- "name": "ResultUrl",
1741
- "output_required": true,
1742
- "type": "string",
1743
- "value_allowed_null": true
1744
- },
1745
- {
1746
- "disabled": false,
1747
- "document": "错误PPT页面列表\n注意：此字段可能返回 null，表示取不到有效值。",
1748
- "example": "无",
1749
- "member": "PPTErrSlide",
1750
- "name": "Slides",
1751
- "output_required": true,
1752
- "type": "list",
1753
- "value_allowed_null": true
1754
- },
1755
- {
1756
- "disabled": false,
1757
- "document": "任务的当前状态 - QUEUED: 正在排队等待 - PROCESSING: 执行中 - FINISHED: 执行完成\t",
1758
- "example": "FINISHED",
1759
- "member": "string",
1760
- "name": "Status",
1761
- "output_required": true,
1762
- "type": "string",
1763
- "value_allowed_null": false
1764
- },
1765
- {
1766
- "disabled": false,
1767
- "document": "当前进度,取值范围为0~100",
1768
- "example": "100",
1769
- "member": "int64",
1770
- "name": "Progress",
1771
- "output_required": true,
1772
- "type": "int",
1773
- "value_allowed_null": false
1774
- },
1775
- {
1776
- "disabled": false,
1777
- "document": "错误列表\n注意：此字段可能返回 null，表示取不到有效值。",
1778
- "example": "无",
1779
- "member": "PPTErr",
1780
- "name": "Errs",
1781
- "output_required": true,
1782
- "type": "list",
1783
- "value_allowed_null": true
1784
- },
1785
- {
1786
- "document": "唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。",
1787
- "member": "string",
1788
- "name": "RequestId",
1789
- "type": "string"
1790
- }
1791
- ],
1792
- "type": "object"
1793
- },
1794
- "DescribePostpaidUsageRequest": {
1795
- "document": "DescribePostpaidUsage请求参数结构体",
1796
- "members": [
1797
- {
1798
- "disabled": false,
1799
- "document": "开始时间",
1800
- "example": "",
1801
- "member": "datetime",
1802
- "name": "BeginTime",
1803
- "required": true,
1804
- "type": "string"
1805
- },
1806
- {
1807
- "disabled": false,
1808
- "document": "结束时间",
1809
- "example": "",
1810
- "member": "datetime",
1811
- "name": "EndTime",
1812
- "required": true,
1813
- "type": "string"
1814
- }
1815
- ],
1816
- "type": "object"
1817
- },
1818
- "DescribePostpaidUsageResponse": {
1819
- "document": "DescribePostpaidUsage返回参数结构体",
1820
- "members": [
1821
- {
1822
- "document": "唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。",
1823
- "member": "string",
1824
- "name": "RequestId",
1825
- "type": "string"
1826
- }
1827
- ],
1828
- "type": "object"
1829
- },
1830
- "DescribeQualityMetricsRequest": {
1831
- "document": "DescribeQualityMetrics请求参数结构体",
1832
- "members": [
1833
- {
1834
- "disabled": false,
1835
- "document": "白板应用的SdkAppId",
1836
- "example": "1400000001",
1837
- "member": "int64",
1838
- "name": "SdkAppId",
1839
- "required": true,
1840
- "type": "int"
1841
- },
1842
- {
1843
- "disabled": false,
1844
- "document": "开始时间，Unix时间戳，单位秒，时间跨度不能超过7天",
1845
- "example": "1614691834",
1846
- "member": "int64",
1847
- "name": "StartTime",
1848
- "required": true,
1849
- "type": "int"
1850
- },
1851
- {
1852
- "disabled": false,
1853
- "document": "结束时间，Unix时间戳，单位秒，时间跨度不能超过7天",
1854
- "example": "1614691834",
1855
- "member": "int64",
1856
- "name": "EndTime",
1857
- "required": true,
1858
- "type": "int"
1859
- },
1860
- {
1861
- "disabled": false,
1862
- "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: 白板鉴权耗时平均时间（单位，毫秒）",
1863
- "example": "image_load_success_rate",
1864
- "member": "string",
1865
- "name": "Metric",
1866
- "required": true,
1867
- "type": "string"
1868
- },
1869
- {
1870
- "disabled": false,
1871
- "document": "聚合的时间维度，目前只支持1小时，输入值为\"1h\"",
1872
- "example": "1h",
1873
- "member": "string",
1874
- "name": "Interval",
1875
- "required": false,
1876
- "type": "string"
1877
- }
1878
- ],
1879
- "type": "object"
1880
- },
1881
- "DescribeQualityMetricsResponse": {
1882
- "document": "DescribeQualityMetrics返回参数结构体",
1883
- "members": [
935
+ "value_allowed_null": false
936
+ },
1884
937
  {
1885
938
  "disabled": false,
1886
- "document": "输入的查询指标",
1887
- "example": "image_load_success_rate",
939
+ "document": "回放URL，需配合信令播放器使用。此字段仅适用于`视频生成模式`\n注意：此字段可能返回 null，表示取不到有效值。",
940
+ "example": "http://replayurl",
1888
941
  "member": "string",
1889
- "name": "Metric",
942
+ "name": "ReplayUrl",
1890
943
  "required": true,
1891
944
  "type": "string",
1892
- "value_allowed_null": false
945
+ "value_allowed_null": true
1893
946
  },
1894
947
  {
1895
948
  "disabled": false,
1896
- "document": "时间序列",
949
+ "document": "视频流在录制过程中断流次数\n注意：此字段可能返回 null，表示取不到有效值。",
1897
950
  "example": "无",
1898
- "member": "TimeValue",
1899
- "name": "Content",
951
+ "member": "Interrupt",
952
+ "name": "Interrupts",
1900
953
  "required": true,
1901
954
  "type": "list",
1902
- "value_allowed_null": false
955
+ "value_allowed_null": true
1903
956
  },
1904
957
  {
1905
958
  "document": "唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。",
@@ -1910,32 +963,40 @@
1910
963
  ],
1911
964
  "type": "object"
1912
965
  },
1913
- "DescribeRecordSearchRequest": {
1914
- "document": "DescribeRecordSearch请求参数结构体",
1915
- "members": [],
966
+ "DescribePPTCheckCallbackRequest": {
967
+ "document": "DescribePPTCheckCallback请求参数结构体",
968
+ "members": [
969
+ {
970
+ "disabled": false,
971
+ "document": "应用的SdkAppId",
972
+ "example": "1400000001",
973
+ "member": "int64",
974
+ "name": "SdkAppId",
975
+ "required": true,
976
+ "type": "int"
977
+ }
978
+ ],
1916
979
  "type": "object"
1917
980
  },
1918
- "DescribeRecordSearchResponse": {
1919
- "document": "DescribeRecordSearch返回参数结构体",
981
+ "DescribePPTCheckCallbackResponse": {
982
+ "document": "DescribePPTCheckCallback返回参数结构体",
1920
983
  "members": [
1921
984
  {
1922
985
  "disabled": false,
1923
- "document": "录制任务搜索结果集合",
1924
- "example": "无",
1925
- "member": "RecordTaskSearchResult",
1926
- "name": "RecordTaskSet",
1927
- "required": true,
1928
- "type": "list",
986
+ "document": "回调地址",
987
+ "example": "https://example.com/transcode/callback",
988
+ "member": "string",
989
+ "name": "Callback",
990
+ "type": "string",
1929
991
  "value_allowed_null": false
1930
992
  },
1931
993
  {
1932
994
  "disabled": false,
1933
- "document": "录制总任务数",
1934
- "example": "151",
1935
- "member": "int64",
1936
- "name": "TotalCount",
1937
- "required": true,
1938
- "type": "int",
995
+ "document": "回调鉴权密钥",
996
+ "example": "6vg9G7Fd",
997
+ "member": "string",
998
+ "name": "CallbackKey",
999
+ "type": "string",
1939
1000
  "value_allowed_null": false
1940
1001
  },
1941
1002
  {
@@ -1947,12 +1008,12 @@
1947
1008
  ],
1948
1009
  "type": "object"
1949
1010
  },
1950
- "DescribeRoomListRequest": {
1951
- "document": "DescribeRoomList请求参数结构体",
1011
+ "DescribePPTCheckRequest": {
1012
+ "document": "DescribePPTCheck请求参数结构体",
1952
1013
  "members": [
1953
1014
  {
1954
1015
  "disabled": false,
1955
- "document": "白板应用的SdkAppId",
1016
+ "document": "客户的SdkAppId",
1956
1017
  "example": "1400000001",
1957
1018
  "member": "int64",
1958
1019
  "name": "SdkAppId",
@@ -1961,46 +1022,88 @@
1961
1022
  },
1962
1023
  {
1963
1024
  "disabled": false,
1964
- "document": "查询时间段，Unix时间戳，单位毫秒，第一个值为开始时间戳，第二个值为结束时间",
1965
- "example": "[1614519034000,1614691834999]",
1966
- "member": "int64",
1967
- "name": "TimeRange",
1025
+ "document": "任务的唯一标识Id",
1026
+ "example": "g0jb42ps49vtebjshilb",
1027
+ "member": "string",
1028
+ "name": "TaskId",
1968
1029
  "required": true,
1969
- "type": "list"
1030
+ "type": "string"
1031
+ }
1032
+ ],
1033
+ "type": "object"
1034
+ },
1035
+ "DescribePPTCheckResponse": {
1036
+ "document": "DescribePPTCheck返回参数结构体",
1037
+ "members": [
1038
+ {
1039
+ "disabled": false,
1040
+ "document": "任务的唯一标识Id",
1041
+ "example": "0agdnligqtgtvkm65emb",
1042
+ "member": "string",
1043
+ "name": "TaskId",
1044
+ "output_required": true,
1045
+ "type": "string",
1046
+ "value_allowed_null": false
1047
+ },
1048
+ {
1049
+ "disabled": false,
1050
+ "document": "PPT文件是否正常",
1051
+ "example": "false",
1052
+ "member": "bool",
1053
+ "name": "IsOK",
1054
+ "output_required": true,
1055
+ "type": "bool",
1056
+ "value_allowed_null": false
1970
1057
  },
1971
1058
  {
1972
1059
  "disabled": false,
1973
- "document": "额外的查询条件",
1974
- "example": "action: addData",
1060
+ "document": "修复后的PPT URL，只有创建任务时参数AutoHandleUnsupportedElement=true，才返回此参数\n注意：此字段可能返回 null，表示取不到有效值。",
1061
+ "example": "https://xxx/xxx/测试_fixed.ppt",
1975
1062
  "member": "string",
1976
- "name": "Query",
1977
- "required": false,
1978
- "type": "string"
1063
+ "name": "ResultUrl",
1064
+ "output_required": true,
1065
+ "type": "string",
1066
+ "value_allowed_null": true
1067
+ },
1068
+ {
1069
+ "disabled": false,
1070
+ "document": "错误PPT页面列表\n注意：此字段可能返回 null，表示取不到有效值。",
1071
+ "example": "无",
1072
+ "member": "PPTErrSlide",
1073
+ "name": "Slides",
1074
+ "output_required": true,
1075
+ "type": "list",
1076
+ "value_allowed_null": true
1077
+ },
1078
+ {
1079
+ "disabled": false,
1080
+ "document": "任务的当前状态 - QUEUED: 正在排队等待 - PROCESSING: 执行中 - FINISHED: 执行完成\t",
1081
+ "example": "FINISHED",
1082
+ "member": "string",
1083
+ "name": "Status",
1084
+ "output_required": true,
1085
+ "type": "string",
1086
+ "value_allowed_null": false
1979
1087
  },
1980
1088
  {
1981
1089
  "disabled": false,
1982
- "document": "返回最大的数据条数，默认1000",
1983
- "example": "1000",
1090
+ "document": "当前进度,取值范围为0~100",
1091
+ "example": "100",
1984
1092
  "member": "int64",
1985
- "name": "MaxSize",
1986
- "required": false,
1987
- "type": "int"
1988
- }
1989
- ],
1990
- "type": "object"
1991
- },
1992
- "DescribeRoomListResponse": {
1993
- "document": "DescribeRoomList返回参数结构体",
1994
- "members": [
1093
+ "name": "Progress",
1094
+ "output_required": true,
1095
+ "type": "int",
1096
+ "value_allowed_null": false
1097
+ },
1995
1098
  {
1996
1099
  "disabled": false,
1997
- "document": "白板房间列表",
1998
- "example": "[]",
1999
- "member": "RoomListItem",
2000
- "name": "RoomList",
2001
- "required": true,
1100
+ "document": "错误列表\n注意：此字段可能返回 null，表示取不到有效值。",
1101
+ "example": "无",
1102
+ "member": "PPTErr",
1103
+ "name": "Errs",
1104
+ "output_required": true,
2002
1105
  "type": "list",
2003
- "value_allowed_null": false
1106
+ "value_allowed_null": true
2004
1107
  },
2005
1108
  {
2006
1109
  "document": "唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。",
@@ -2126,204 +1229,39 @@
2126
1229
  "example": "Finished",
2127
1230
  "member": "string",
2128
1231
  "name": "Status",
2129
- "required": true,
2130
- "type": "string",
2131
- "value_allowed_null": true
2132
- },
2133
- {
2134
- "disabled": false,
2135
- "document": "任务创建时间，单位s\n注意：此字段可能返回 null，表示取不到有效值。",
2136
- "example": "1620982173",
2137
- "member": "uint64",
2138
- "name": "CreateTime",
2139
- "required": true,
2140
- "type": "int",
2141
- "value_allowed_null": true
2142
- },
2143
- {
2144
- "disabled": false,
2145
- "document": "任务完成时间，单位s\n注意：此字段可能返回 null，表示取不到有效值。",
2146
- "example": "1621082195",
2147
- "member": "uint64",
2148
- "name": "FinishTime",
2149
- "required": true,
2150
- "type": "int",
2151
- "value_allowed_null": true
2152
- },
2153
- {
2154
- "disabled": false,
2155
- "document": "任务结果信息\n注意：此字段可能返回 null，表示取不到有效值。",
2156
- "example": "无",
2157
- "member": "SnapshotResult",
2158
- "name": "Result",
2159
- "required": true,
2160
- "type": "object",
2161
- "value_allowed_null": true
2162
- },
2163
- {
2164
- "document": "唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。",
2165
- "member": "string",
2166
- "name": "RequestId",
2167
- "type": "string"
2168
- }
2169
- ],
2170
- "type": "object"
2171
- },
2172
- "DescribeTIWDailyUsageRequest": {
2173
- "document": "DescribeTIWDailyUsage请求参数结构体",
2174
- "members": [
2175
- {
2176
- "disabled": false,
2177
- "document": "互动白板应用SdkAppId",
2178
- "example": "1400000001",
2179
- "member": "int64",
2180
- "name": "SdkAppId",
2181
- "required": true,
2182
- "type": "int"
2183
- },
2184
- {
2185
- "disabled": false,
2186
- "document": "需要查询的子产品用量，支持传入以下值\n- sp_tiw_board: 互动白板时长，单位为分钟\n- sp_tiw_dt: 动态转码页数，单位页\n- sp_tiw_st: 静态转码页数，单位页\n- sp_tiw_ric: 实时录制时长，单位分钟\n\n注意：动态转码以1:8的比例计算文档转码页数，静态转码以1:1的比例计算文档转码页数",
2187
- "example": "sp_tiw_board",
2188
- "member": "string",
2189
- "name": "SubProduct",
2190
- "required": true,
2191
- "type": "string"
2192
- },
2193
- {
2194
- "disabled": false,
2195
- "document": "开始时间，格式YYYY-MM-DD，查询结果里包括该天数据",
2196
- "example": "2021-10-01",
2197
- "member": "date",
2198
- "name": "StartTime",
2199
- "required": true,
2200
- "type": "string"
2201
- },
2202
- {
2203
- "disabled": false,
2204
- "document": "结束时间，格式YYYY-MM-DD，查询结果里包括该天数据，单次查询统计区间最多不能超过31天。",
2205
- "example": "2021-10-31",
2206
- "member": "date",
2207
- "name": "EndTime",
2208
- "required": true,
2209
- "type": "string"
2210
- }
2211
- ],
2212
- "type": "object"
2213
- },
2214
- "DescribeTIWDailyUsageResponse": {
2215
- "document": "DescribeTIWDailyUsage返回参数结构体",
2216
- "members": [
2217
- {
2218
- "disabled": false,
2219
- "document": "指定区间指定产品的用量汇总",
2220
- "example": "无",
2221
- "member": "UsageDataItem",
2222
- "name": "Usages",
2223
- "required": true,
2224
- "type": "list",
2225
- "value_allowed_null": false
2226
- },
2227
- {
2228
- "document": "唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。",
2229
- "member": "string",
2230
- "name": "RequestId",
2231
- "type": "string"
2232
- }
2233
- ],
2234
- "type": "object"
2235
- },
2236
- "DescribeTIWRoomDailyUsageRequest": {
2237
- "document": "DescribeTIWRoomDailyUsage请求参数结构体",
2238
- "members": [
2239
- {
2240
- "disabled": false,
2241
- "document": "互动白板应用SdkAppId",
2242
- "example": "1400000001",
2243
- "member": "int64",
2244
- "name": "SdkAppId",
2245
- "required": true,
2246
- "type": "int"
2247
- },
2248
- {
2249
- "disabled": false,
2250
- "document": "需要查询的子产品用量，支持传入以下值\n- sp_tiw_board: 互动白板时长，单位为分钟\n- sp_tiw_ric: 实时录制时长，单位分钟",
2251
- "example": "sp_tiw_board",
2252
- "member": "string",
2253
- "name": "SubProduct",
2254
- "required": true,
2255
- "type": "string"
2256
- },
2257
- {
2258
- "disabled": false,
2259
- "document": "开始时间，格式YYYY-MM-DD，查询结果里包括该天数据",
2260
- "example": "2021-10-01",
2261
- "member": "date",
2262
- "name": "StartTime",
2263
- "required": true,
2264
- "type": "string"
2265
- },
2266
- {
2267
- "disabled": false,
2268
- "document": "结束时间，格式YYYY-MM-DD，查询结果里包括该天数据，单次查询统计区间最多不能超过31天。",
2269
- "example": "2021-10-31",
2270
- "member": "date",
2271
- "name": "EndTime",
2272
- "required": true,
2273
- "type": "string"
2274
- },
2275
- {
2276
- "disabled": false,
2277
- "document": "需要查询的房间ID列表，不填默认查询全部房间",
2278
- "example": "无",
2279
- "member": "uint64",
2280
- "name": "RoomIDs",
2281
- "required": false,
2282
- "type": "list"
2283
- },
2284
- {
2285
- "disabled": false,
2286
- "document": "查询偏移量，默认为0",
2287
- "example": "0",
2288
- "member": "uint64",
2289
- "name": "Offset",
2290
- "required": false,
2291
- "type": "int"
1232
+ "required": true,
1233
+ "type": "string",
1234
+ "value_allowed_null": true
2292
1235
  },
2293
1236
  {
2294
1237
  "disabled": false,
2295
- "document": "每次查询返回条目限制，默认为20",
2296
- "example": "20",
1238
+ "document": "任务创建时间，单位s\n注意：此字段可能返回 null，表示取不到有效值。",
1239
+ "example": "1620982173",
2297
1240
  "member": "uint64",
2298
- "name": "Limit",
2299
- "required": false,
2300
- "type": "int"
2301
- }
2302
- ],
2303
- "type": "object"
2304
- },
2305
- "DescribeTIWRoomDailyUsageResponse": {
2306
- "document": "DescribeTIWRoomDailyUsage返回参数结构体",
2307
- "members": [
2308
- {
2309
- "disabled": false,
2310
- "document": "指定区间指定产品的房间用量列表",
2311
- "example": "无",
2312
- "member": "RoomUsageDataItem",
2313
- "name": "Usages",
1241
+ "name": "CreateTime",
2314
1242
  "required": true,
2315
- "type": "list",
2316
- "value_allowed_null": false
1243
+ "type": "int",
1244
+ "value_allowed_null": true
2317
1245
  },
2318
1246
  {
2319
1247
  "disabled": false,
2320
- "document": "用量列表总数",
2321
- "example": "10",
1248
+ "document": "任务完成时间，单位s\n注意：此字段可能返回 null，表示取不到有效值。",
1249
+ "example": "1621082195",
2322
1250
  "member": "uint64",
2323
- "name": "Total",
1251
+ "name": "FinishTime",
2324
1252
  "required": true,
2325
1253
  "type": "int",
2326
- "value_allowed_null": false
1254
+ "value_allowed_null": true
1255
+ },
1256
+ {
1257
+ "disabled": false,
1258
+ "document": "任务结果信息\n注意：此字段可能返回 null，表示取不到有效值。",
1259
+ "example": "无",
1260
+ "member": "SnapshotResult",
1261
+ "name": "Result",
1262
+ "required": true,
1263
+ "type": "object",
1264
+ "value_allowed_null": true
2327
1265
  },
2328
1266
  {
2329
1267
  "document": "唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。",
@@ -2481,391 +1419,148 @@
2481
1419
  "member": "int64",
2482
1420
  "name": "Pages",
2483
1421
  "output_required": true,
2484
- "type": "int",
2485
- "value_allowed_null": false
2486
- },
2487
- {
2488
- "disabled": false,
2489
- "document": "转码的当前进度,取值范围为0~100",
2490
- "example": "100",
2491
- "member": "int64",
2492
- "name": "Progress",
2493
- "output_required": true,
2494
- "type": "int",
2495
- "value_allowed_null": false
2496
- },
2497
- {
2498
- "disabled": false,
2499
- "document": "文档的分辨率",
2500
- "example": "793x1122",
2501
- "member": "string",
2502
- "name": "Resolution",
2503
- "output_required": true,
2504
- "type": "string",
2505
- "value_allowed_null": false
2506
- },
2507
- {
2508
- "disabled": false,
2509
- "document": "转码完成后结果的URL\n动态转码：PPT转动态H5的链接\n静态转码：文档每一页的图片URL前缀，比如，该URL前缀为`http://example.com/g0jb42ps49vtebjshilb/`，那么文档第1页的图片URL为\n`http://example.com/g0jb42ps49vtebjshilb/1.jpg`，其它页以此类推",
2510
- "example": "https://transcode-result/0agdnligqtgtvkm65emb/index.html",
2511
- "member": "string",
2512
- "name": "ResultUrl",
2513
- "output_required": true,
2514
- "type": "string",
2515
- "value_allowed_null": false
2516
- },
2517
- {
2518
- "disabled": false,
2519
- "document": "任务的当前状态\n- QUEUED: 正在排队等待转换\n- PROCESSING: 转换中\n- FINISHED: 转换完成",
2520
- "example": "FINISHED",
2521
- "member": "string",
2522
- "name": "Status",
2523
- "output_required": true,
2524
- "type": "string",
2525
- "value_allowed_null": false
2526
- },
2527
- {
2528
- "disabled": false,
2529
- "document": "转码任务的唯一标识Id",
2530
- "example": "0agdnligqtgtvkm65emb",
2531
- "member": "string",
2532
- "name": "TaskId",
2533
- "output_required": true,
2534
- "type": "string",
2535
- "value_allowed_null": false
2536
- },
2537
- {
2538
- "disabled": false,
2539
- "document": "文档的文件名",
2540
- "example": "59378.docx",
2541
- "member": "string",
2542
- "name": "Title",
2543
- "output_required": true,
2544
- "type": "string",
2545
- "value_allowed_null": false
2546
- },
2547
- {
2548
- "disabled": false,
2549
- "document": "缩略图URL前缀，比如，该URL前缀为`http://example.com/g0jb42ps49vtebjshilb/ `，那么动态PPT第1页的缩略图URL为\n`http://example.com/g0jb42ps49vtebjshilb/1.jpg`，其它页以此类推\n\n如果发起文档转码请求参数中带了ThumbnailResolution参数，并且转码类型为动态转码，该参数不为空，其余情况该参数为空字符串",
2550
- "example": "https://transcode-thumbnal/0agdnligqtgtvkm65emb/",
2551
- "member": "string",
2552
- "name": "ThumbnailUrl",
2553
- "output_required": true,
2554
- "type": "string",
2555
- "value_allowed_null": false
2556
- },
2557
- {
2558
- "disabled": false,
2559
- "document": "动态转码缩略图生成分辨率",
2560
- "example": "793x1122",
2561
- "member": "string",
2562
- "name": "ThumbnailResolution",
2563
- "output_required": true,
2564
- "type": "string",
2565
- "value_allowed_null": false
2566
- },
2567
- {
2568
- "disabled": false,
2569
- "document": "转码压缩文件下载的URL，如果发起文档转码请求参数中`CompressFileType`为空或者不是支持的压缩格式，该参数为空字符串",
2570
- "example": "无",
2571
- "member": "string",
2572
- "name": "CompressFileUrl",
2573
- "output_required": true,
2574
- "type": "string",
2575
- "value_allowed_null": false
2576
- },
2577
- {
2578
- "disabled": false,
2579
- "document": "资源清单文件下载URL(内测体验)\n注意：此字段可能返回 null，表示取不到有效值。",
2580
- "example": "无",
2581
- "member": "string",
2582
- "name": "ResourceListUrl",
2583
- "output_required": true,
2584
- "type": "string",
2585
- "value_allowed_null": true
2586
- },
2587
- {
2588
- "disabled": false,
2589
- "document": "文档制作方式(内测体验)\n注意：此字段可能返回 null，表示取不到有效值。",
2590
- "example": "office",
2591
- "member": "string",
2592
- "name": "Ext",
2593
- "output_required": true,
2594
- "type": "string",
2595
- "value_allowed_null": true
2596
- },
2597
- {
2598
- "disabled": false,
2599
- "document": "文档转码任务创建时间，单位s\n注意：此字段可能返回 null，表示取不到有效值。",
2600
- "example": "1688974545",
2601
- "member": "uint64",
2602
- "name": "CreateTime",
2603
- "output_required": false,
2604
- "type": "int",
2605
- "value_allowed_null": true
2606
- },
2607
- {
2608
- "disabled": false,
2609
- "document": "文档转码任务分配时间，单位s\n注意：此字段可能返回 null，表示取不到有效值。",
2610
- "example": "1688974545",
2611
- "member": "uint64",
2612
- "name": "AssignTime",
2613
- "output_required": false,
2614
- "type": "int",
2615
- "value_allowed_null": true
2616
- },
2617
- {
2618
- "disabled": false,
2619
- "document": "文档转码任务完成时间，单位s\n注意：此字段可能返回 null，表示取不到有效值。",
2620
- "example": "1688974545",
2621
- "member": "uint64",
2622
- "name": "FinishedTime",
2623
- "output_required": false,
2624
- "type": "int",
2625
- "value_allowed_null": true
2626
- },
2627
- {
2628
- "document": "唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。",
2629
- "member": "string",
2630
- "name": "RequestId",
2631
- "type": "string"
2632
- }
2633
- ],
2634
- "type": "object"
2635
- },
2636
- "DescribeTranscodeSearchRequest": {
2637
- "document": "DescribeTranscodeSearch请求参数结构体",
2638
- "members": [],
2639
- "type": "object"
2640
- },
2641
- "DescribeTranscodeSearchResponse": {
2642
- "document": "DescribeTranscodeSearch返回参数结构体",
2643
- "members": [
2644
- {
2645
- "disabled": false,
2646
- "document": "转码任务搜索结果集合",
2647
- "example": "无",
2648
- "member": "TranscodeTaskSearchResult",
2649
- "name": "TranscodeTaskSet",
2650
- "required": true,
2651
- "type": "list",
2652
- "value_allowed_null": false
2653
- },
2654
- {
2655
- "disabled": false,
2656
- "document": "转码总任务数",
2657
- "example": "1340",
2658
- "member": "int64",
2659
- "name": "TotalCount",
2660
- "required": true,
2661
- "type": "int",
2662
- "value_allowed_null": false
2663
- },
2664
- {
2665
- "document": "唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。",
2666
- "member": "string",
2667
- "name": "RequestId",
2668
- "type": "string"
2669
- }
2670
- ],
2671
- "type": "object"
2672
- },
2673
- "DescribeUsageSummaryRequest": {
2674
- "document": "DescribeUsageSummary请求参数结构体",
2675
- "members": [
2676
- {
2677
- "disabled": false,
2678
- "document": "统计时间段的开始时间",
2679
- "example": "",
2680
- "member": "datetime",
2681
- "name": "BeginTime",
2682
- "required": true,
2683
- "type": "string"
2684
- },
2685
- {
2686
- "disabled": false,
2687
- "document": "统计时间段的结束时间",
2688
- "example": "",
2689
- "member": "datetime",
2690
- "name": "EndTime",
2691
- "required": true,
2692
- "type": "string"
2693
- },
2694
- {
2695
- "disabled": false,
2696
- "document": "需要获取用量的子产品列表",
2697
- "example": "",
2698
- "member": "string",
2699
- "name": "SubProducts",
2700
- "required": true,
2701
- "type": "list"
2702
- },
2703
- {
2704
- "disabled": false,
2705
- "document": "true: 返回加权后的数据\nfalse: 返回原始数据",
2706
- "example": "",
2707
- "member": "bool",
2708
- "name": "IsWeighted",
2709
- "required": false,
2710
- "type": "bool"
2711
- }
2712
- ],
2713
- "type": "object"
2714
- },
2715
- "DescribeUsageSummaryResponse": {
2716
- "document": "DescribeUsageSummary返回参数结构体",
2717
- "members": [
2718
- {
2719
- "document": "唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。",
2720
- "member": "string",
2721
- "name": "RequestId",
2722
- "type": "string"
2723
- }
2724
- ],
2725
- "type": "object"
2726
- },
2727
- "DescribeUserListRequest": {
2728
- "document": "DescribeUserList请求参数结构体",
2729
- "members": [
1422
+ "type": "int",
1423
+ "value_allowed_null": false
1424
+ },
2730
1425
  {
2731
1426
  "disabled": false,
2732
- "document": "白板应用的SdkAppId",
2733
- "example": "1400000001",
1427
+ "document": "转码的当前进度,取值范围为0~100",
1428
+ "example": "100",
2734
1429
  "member": "int64",
2735
- "name": "SdkAppId",
2736
- "required": true,
2737
- "type": "int"
1430
+ "name": "Progress",
1431
+ "output_required": true,
1432
+ "type": "int",
1433
+ "value_allowed_null": false
2738
1434
  },
2739
1435
  {
2740
1436
  "disabled": false,
2741
- "document": "需要查询用户列表的白板房间号",
2742
- "example": "10000",
1437
+ "document": "文档的分辨率",
1438
+ "example": "793x1122",
2743
1439
  "member": "string",
2744
- "name": "RoomId",
2745
- "required": true,
2746
- "type": "string"
1440
+ "name": "Resolution",
1441
+ "output_required": true,
1442
+ "type": "string",
1443
+ "value_allowed_null": false
2747
1444
  },
2748
1445
  {
2749
1446
  "disabled": false,
2750
- "document": "查询时间段，Unix时间戳，单位毫秒，第一个值为开始时间戳，第二个值为结束时间",
2751
- "example": "[1614519034000,1614691834999]",
2752
- "member": "int64",
2753
- "name": "TimeRange",
2754
- "required": true,
2755
- "type": "list"
1447
+ "document": "转码完成后结果的URL\n动态转码：PPT转动态H5的链接\n静态转码：文档每一页的图片URL前缀，比如，该URL前缀为`http://example.com/g0jb42ps49vtebjshilb/`，那么文档第1页的图片URL为\n`http://example.com/g0jb42ps49vtebjshilb/1.jpg`，其它页以此类推",
1448
+ "example": "https://transcode-result/0agdnligqtgtvkm65emb/index.html",
1449
+ "member": "string",
1450
+ "name": "ResultUrl",
1451
+ "output_required": true,
1452
+ "type": "string",
1453
+ "value_allowed_null": false
2756
1454
  },
2757
1455
  {
2758
1456
  "disabled": false,
2759
- "document": "额外的查询条件",
2760
- "example": "action: addData",
1457
+ "document": "任务的当前状态\n- QUEUED: 正在排队等待转换\n- PROCESSING: 转换中\n- FINISHED: 转换完成",
1458
+ "example": "FINISHED",
2761
1459
  "member": "string",
2762
- "name": "Query",
2763
- "required": false,
2764
- "type": "string"
1460
+ "name": "Status",
1461
+ "output_required": true,
1462
+ "type": "string",
1463
+ "value_allowed_null": false
2765
1464
  },
2766
1465
  {
2767
1466
  "disabled": false,
2768
- "document": "返回最大的数据条数，默认1000",
2769
- "example": "1000",
2770
- "member": "int64",
2771
- "name": "MaxSize",
2772
- "required": false,
2773
- "type": "int"
2774
- }
2775
- ],
2776
- "type": "object"
2777
- },
2778
- "DescribeUserListResponse": {
2779
- "document": "DescribeUserList返回参数结构体",
2780
- "members": [
1467
+ "document": "转码任务的唯一标识Id",
1468
+ "example": "0agdnligqtgtvkm65emb",
1469
+ "member": "string",
1470
+ "name": "TaskId",
1471
+ "output_required": true,
1472
+ "type": "string",
1473
+ "value_allowed_null": false
1474
+ },
2781
1475
  {
2782
1476
  "disabled": false,
2783
- "document": "房间内的用户列表",
2784
- "example": "[]",
2785
- "member": "UserListItem",
2786
- "name": "UserList",
2787
- "required": true,
2788
- "type": "list",
1477
+ "document": "文档的文件名",
1478
+ "example": "59378.docx",
1479
+ "member": "string",
1480
+ "name": "Title",
1481
+ "output_required": true,
1482
+ "type": "string",
2789
1483
  "value_allowed_null": false
2790
1484
  },
2791
1485
  {
2792
- "document": "唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。",
1486
+ "disabled": false,
1487
+ "document": "缩略图URL前缀，比如，该URL前缀为`http://example.com/g0jb42ps49vtebjshilb/ `，那么动态PPT第1页的缩略图URL为\n`http://example.com/g0jb42ps49vtebjshilb/1.jpg`，其它页以此类推\n\n如果发起文档转码请求参数中带了ThumbnailResolution参数，并且转码类型为动态转码，该参数不为空，其余情况该参数为空字符串",
1488
+ "example": "https://transcode-thumbnal/0agdnligqtgtvkm65emb/",
2793
1489
  "member": "string",
2794
- "name": "RequestId",
2795
- "type": "string"
2796
- }
2797
- ],
2798
- "type": "object"
2799
- },
2800
- "DescribeUserResourcesRequest": {
2801
- "document": "DescribeUserResources请求参数结构体",
2802
- "members": [],
2803
- "type": "object"
2804
- },
2805
- "DescribeUserResourcesResponse": {
2806
- "document": "DescribeUserResources返回参数结构体",
2807
- "members": [
1490
+ "name": "ThumbnailUrl",
1491
+ "output_required": true,
1492
+ "type": "string",
1493
+ "value_allowed_null": false
1494
+ },
2808
1495
  {
2809
- "document": "唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。",
1496
+ "disabled": false,
1497
+ "document": "动态转码缩略图生成分辨率",
1498
+ "example": "793x1122",
2810
1499
  "member": "string",
2811
- "name": "RequestId",
2812
- "type": "string"
2813
- }
2814
- ],
2815
- "type": "object"
2816
- },
2817
- "DescribeUserStatusRequest": {
2818
- "document": "DescribeUserStatus请求参数结构体",
2819
- "members": [],
2820
- "type": "object"
2821
- },
2822
- "DescribeUserStatusResponse": {
2823
- "document": "DescribeUserStatus返回参数结构体",
2824
- "members": [
1500
+ "name": "ThumbnailResolution",
1501
+ "output_required": true,
1502
+ "type": "string",
1503
+ "value_allowed_null": false
1504
+ },
2825
1505
  {
2826
1506
  "disabled": false,
2827
- "document": "客户的AppId",
2828
- "example": "",
2829
- "member": "int64",
2830
- "name": "AppId",
2831
- "type": "int",
1507
+ "document": "转码压缩文件下载的URL，如果发起文档转码请求参数中`CompressFileType`为空或者不是支持的压缩格式，该参数为空字符串",
1508
+ "example": "无",
1509
+ "member": "string",
1510
+ "name": "CompressFileUrl",
1511
+ "output_required": true,
1512
+ "type": "string",
2832
1513
  "value_allowed_null": false
2833
1514
  },
2834
1515
  {
2835
1516
  "disabled": false,
2836
- "document": "是否开通过白板（试用或正式）\n\n0: 从未开通过白板服务\n1: 已经开通过白板服务",
2837
- "example": "",
2838
- "member": "int64",
2839
- "name": "IsTiwUser",
2840
- "type": "int",
2841
- "value_allowed_null": false
1517
+ "document": "资源清单文件下载URL(内测体验)\n注意：此字段可能返回 null，表示取不到有效值。",
1518
+ "example": "无",
1519
+ "member": "string",
1520
+ "name": "ResourceListUrl",
1521
+ "output_required": true,
1522
+ "type": "string",
1523
+ "value_allowed_null": true
2842
1524
  },
2843
1525
  {
2844
1526
  "disabled": false,
2845
- "document": "是否开通过互动课堂（试用或正式）",
2846
- "example": "",
2847
- "member": "int64",
2848
- "name": "IsSaaSUser",
1527
+ "document": "文档制作方式(内测体验)\n注意：此字段可能返回 null，表示取不到有效值。",
1528
+ "example": "office",
1529
+ "member": "string",
1530
+ "name": "Ext",
1531
+ "output_required": true,
1532
+ "type": "string",
1533
+ "value_allowed_null": true
1534
+ },
1535
+ {
1536
+ "disabled": false,
1537
+ "document": "文档转码任务创建时间，单位s\n注意：此字段可能返回 null，表示取不到有效值。",
1538
+ "example": "1688974545",
1539
+ "member": "uint64",
1540
+ "name": "CreateTime",
1541
+ "output_required": false,
2849
1542
  "type": "int",
2850
- "value_allowed_null": false
1543
+ "value_allowed_null": true
2851
1544
  },
2852
1545
  {
2853
1546
  "disabled": false,
2854
- "document": "是否使用白板的课后录制",
2855
- "example": "",
2856
- "member": "int64",
2857
- "name": "IsTiwOfflineRecordUser",
1547
+ "document": "文档转码任务分配时间，单位s\n注意：此字段可能返回 null，表示取不到有效值。",
1548
+ "example": "1688974545",
1549
+ "member": "uint64",
1550
+ "name": "AssignTime",
1551
+ "output_required": false,
2858
1552
  "type": "int",
2859
- "value_allowed_null": false
1553
+ "value_allowed_null": true
2860
1554
  },
2861
1555
  {
2862
1556
  "disabled": false,
2863
- "document": "用户是否实名认证",
2864
- "example": "",
2865
- "member": "int64",
2866
- "name": "IsAuthenticated",
1557
+ "document": "文档转码任务完成时间，单位s\n注意：此字段可能返回 null，表示取不到有效值。",
1558
+ "example": "1688974545",
1559
+ "member": "uint64",
1560
+ "name": "FinishedTime",
1561
+ "output_required": false,
2867
1562
  "type": "int",
2868
- "value_allowed_null": false
1563
+ "value_allowed_null": true
2869
1564
  },
2870
1565
  {
2871
1566
  "document": "唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。",
@@ -3008,125 +1703,15 @@
3008
1703
  "example": "",
3009
1704
  "member": "VideoInfo",
3010
1705
  "name": "VideoInfos",
3011
- "type": "object",
3012
- "value_allowed_null": false
3013
- },
3014
- {
3015
- "disabled": false,
3016
- "document": "录制视频生成视频列表",
3017
- "example": "",
3018
- "member": "VideoInfo",
3019
- "name": "VideoInfoList",
3020
- "type": "list",
3021
- "value_allowed_null": false
3022
- },
3023
- {
3024
- "document": "唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。",
3025
- "member": "string",
3026
- "name": "RequestId",
3027
- "type": "string"
3028
- }
3029
- ],
3030
- "type": "object"
3031
- },
3032
- "DescribeWarningCallbackRequest": {
3033
- "document": "DescribeWarningCallback请求参数结构体",
3034
- "members": [
3035
- {
3036
- "disabled": false,
3037
- "document": "应用的SdkAppId",
3038
- "example": "1400000001",
3039
- "member": "int64",
3040
- "name": "SdkAppId",
3041
- "required": true,
3042
- "type": "int"
3043
- }
3044
- ],
3045
- "type": "object"
3046
- },
3047
- "DescribeWarningCallbackResponse": {
3048
- "document": "DescribeWarningCallback返回参数结构体",
3049
- "members": [
3050
- {
3051
- "disabled": false,
3052
- "document": "告警事件回调地址，如果未设置回调地址，该字段为空字符串",
3053
- "example": "https://example.com/online/callback",
3054
- "member": "string",
3055
- "name": "Callback",
3056
- "type": "string",
3057
- "value_allowed_null": false
3058
- },
3059
- {
3060
- "disabled": false,
3061
- "document": "告警回调鉴权密钥",
3062
- "example": "6vg9G7Fd",
3063
- "member": "string",
3064
- "name": "CallbackKey",
3065
- "type": "string",
3066
- "value_allowed_null": false
3067
- },
3068
- {
3069
- "document": "唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。",
3070
- "member": "string",
3071
- "name": "RequestId",
3072
- "type": "string"
3073
- }
3074
- ],
3075
- "type": "object"
3076
- },
3077
- "DescribeWhiteboardApplicationConfigRequest": {
3078
- "document": "DescribeWhiteboardApplicationConfig请求参数结构体",
3079
- "members": [
3080
- {
3081
- "disabled": false,
3082
- "document": "客户的SdkAppId",
3083
- "example": "1400000001",
3084
- "member": "int64",
3085
- "name": "SdkAppId",
3086
- "required": true,
3087
- "type": "int"
3088
- },
3089
- {
3090
- "disabled": false,
3091
- "document": "需要查询的任务类型\nrecording: 实时录制\ntranscode: 文档转码",
3092
- "example": "[\"transcode\",\"recording\"]",
3093
- "member": "string",
3094
- "name": "TaskTypes",
3095
- "required": true,
3096
- "type": "list"
3097
- },
3098
- {
3099
- "disabled": false,
3100
- "document": "需要查询配置的SdkAppId列表",
3101
- "example": "[0]",
3102
- "member": "int64",
3103
- "name": "SdkAppIds",
3104
- "required": false,
3105
- "type": "list"
3106
- }
3107
- ],
3108
- "type": "object"
3109
- },
3110
- "DescribeWhiteboardApplicationConfigResponse": {
3111
- "document": "DescribeWhiteboardApplicationConfig返回参数结构体",
3112
- "members": [
3113
- {
3114
- "disabled": false,
3115
- "document": "客户的SdkAppId",
3116
- "example": "1400127140",
3117
- "member": "int64",
3118
- "name": "SdkAppId",
3119
- "required": true,
3120
- "type": "int",
1706
+ "type": "object",
3121
1707
  "value_allowed_null": false
3122
1708
  },
3123
1709
  {
3124
1710
  "disabled": false,
3125
- "document": "白板应用任务相关配置",
3126
- "example": "无",
3127
- "member": "WhiteboardApplicationConfig",
3128
- "name": "Configs",
3129
- "required": true,
1711
+ "document": "录制视频生成视频列表",
1712
+ "example": "",
1713
+ "member": "VideoInfo",
1714
+ "name": "VideoInfoList",
3130
1715
  "type": "list",
3131
1716
  "value_allowed_null": false
3132
1717
  },
@@ -3139,33 +1724,42 @@
3139
1724
  ],
3140
1725
  "type": "object"
3141
1726
  },
3142
- "DescribeWhiteboardBucketConfigRequest": {
3143
- "document": "DescribeWhiteboardBucketConfig请求参数结构体",
1727
+ "DescribeWarningCallbackRequest": {
1728
+ "document": "DescribeWarningCallback请求参数结构体",
3144
1729
  "members": [
3145
1730
  {
3146
1731
  "disabled": false,
3147
- "document": "客户的SdkAppId",
3148
- "example": "",
1732
+ "document": "应用的SdkAppId",
1733
+ "example": "1400000001",
3149
1734
  "member": "int64",
3150
1735
  "name": "SdkAppId",
3151
1736
  "required": true,
3152
1737
  "type": "int"
3153
- },
3154
- {
3155
- "disabled": false,
3156
- "document": "需要查询的任务类型\nrecording: 实时录制\ntranscode: 文档转码",
3157
- "example": "",
3158
- "member": "string",
3159
- "name": "TaskType",
3160
- "required": true,
3161
- "type": "string"
3162
1738
  }
3163
1739
  ],
3164
1740
  "type": "object"
3165
1741
  },
3166
- "DescribeWhiteboardBucketConfigResponse": {
3167
- "document": "DescribeWhiteboardBucketConfig返回参数结构体",
1742
+ "DescribeWarningCallbackResponse": {
1743
+ "document": "DescribeWarningCallback返回参数结构体",
3168
1744
  "members": [
1745
+ {
1746
+ "disabled": false,
1747
+ "document": "告警事件回调地址，如果未设置回调地址，该字段为空字符串",
1748
+ "example": "https://example.com/online/callback",
1749
+ "member": "string",
1750
+ "name": "Callback",
1751
+ "type": "string",
1752
+ "value_allowed_null": false
1753
+ },
1754
+ {
1755
+ "disabled": false,
1756
+ "document": "告警回调鉴权密钥",
1757
+ "example": "6vg9G7Fd",
1758
+ "member": "string",
1759
+ "name": "CallbackKey",
1760
+ "type": "string",
1761
+ "value_allowed_null": false
1762
+ },
3169
1763
  {
3170
1764
  "document": "唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。",
3171
1765
  "member": "string",
@@ -3357,79 +1951,6 @@
3357
1951
  ],
3358
1952
  "type": "object"
3359
1953
  },
3360
- "DescribeWhiteboardPushSearchRequest": {
3361
- "document": "DescribeWhiteboardPushSearch请求参数结构体",
3362
- "members": [],
3363
- "type": "object"
3364
- },
3365
- "DescribeWhiteboardPushSearchResponse": {
3366
- "document": "DescribeWhiteboardPushSearch返回参数结构体",
3367
- "members": [
3368
- {
3369
- "disabled": false,
3370
- "document": "推流任务搜索结果集合",
3371
- "example": "无",
3372
- "member": "WhiteboardPushTaskSearchResult",
3373
- "name": "WhiteboardPushTaskSet",
3374
- "required": true,
3375
- "type": "list",
3376
- "value_allowed_null": false
3377
- },
3378
- {
3379
- "disabled": false,
3380
- "document": "推流总任务数",
3381
- "example": "1",
3382
- "member": "int64",
3383
- "name": "TotalCount",
3384
- "required": true,
3385
- "type": "int",
3386
- "value_allowed_null": false
3387
- },
3388
- {
3389
- "document": "唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。",
3390
- "member": "string",
3391
- "name": "RequestId",
3392
- "type": "string"
3393
- }
3394
- ],
3395
- "type": "object"
3396
- },
3397
- "Detail": {
3398
- "document": "计费用量数据里，带不同指标Tag的详情",
3399
- "members": [
3400
- {
3401
- "disabled": false,
3402
- "document": "用量指标",
3403
- "example": "",
3404
- "member": "string",
3405
- "name": "TagName",
3406
- "required": true,
3407
- "type": "string",
3408
- "value_allowed_null": false
3409
- },
3410
- {
3411
- "disabled": false,
3412
- "document": "用量权重",
3413
- "example": "",
3414
- "member": "float",
3415
- "name": "Weight",
3416
- "required": true,
3417
- "type": "float",
3418
- "value_allowed_null": false
3419
- },
3420
- {
3421
- "disabled": false,
3422
- "document": "用量的值",
3423
- "example": "",
3424
- "member": "float",
3425
- "name": "Value",
3426
- "required": true,
3427
- "type": "float",
3428
- "value_allowed_null": false
3429
- }
3430
- ],
3431
- "usage": "out"
3432
- },
3433
1954
  "ExcelParam": {
3434
1955
  "document": "Excel转码相关参数",
3435
1956
  "members": [
@@ -3577,209 +2098,20 @@
3577
2098
  "name": "TeacherId",
3578
2099
  "required": false,
3579
2100
  "type": "string",
3580
- "value_allowed_null": false
3581
- },
3582
- {
3583
- "disabled": false,
3584
- "document": "自定义混流布局参数\n当此字段存在时，ModelId 及 TeacherId 字段将被忽略",
3585
- "example": "",
3586
- "member": "CustomLayout",
3587
- "name": "Custom",
3588
- "required": false,
3589
- "type": "object",
3590
- "value_allowed_null": false
3591
- }
3592
- ],
3593
- "usage": "in"
3594
- },
3595
- "ModifyApplicationRequest": {
3596
- "document": "ModifyApplication请求参数结构体",
3597
- "members": [
3598
- {
3599
- "disabled": false,
3600
- "document": "应用SdkAppId",
3601
- "example": "",
3602
- "member": "int64",
3603
- "name": "SdkAppId",
3604
- "required": true,
3605
- "type": "int"
3606
- },
3607
- {
3608
- "disabled": false,
3609
- "document": "App名字",
3610
- "example": "",
3611
- "member": "string",
3612
- "name": "AppName",
3613
- "required": true,
3614
- "type": "string"
3615
- }
3616
- ],
3617
- "type": "object"
3618
- },
3619
- "ModifyApplicationResponse": {
3620
- "document": "ModifyApplication返回参数结构体",
3621
- "members": [
3622
- {
3623
- "document": "唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。",
3624
- "member": "string",
3625
- "name": "RequestId",
3626
- "type": "string"
3627
- }
3628
- ],
3629
- "type": "object"
3630
- },
3631
- "ModifyAutoRenewFlagRequest": {
3632
- "document": "ModifyAutoRenewFlag请求参数结构体",
3633
- "members": [
3634
- {
3635
- "disabled": false,
3636
- "document": "资源Id，从DescribeUserResources接口中获取Level=1的正式月功能费的SubProduct，一般为sp_tiw_package",
3637
- "example": "",
3638
- "member": "string",
3639
- "name": "SubProduct",
3640
- "required": true,
3641
- "type": "string"
3642
- },
3643
- {
3644
- "disabled": false,
3645
- "document": "资源Id，从DescribeUserResources接口中获取Level=1的正式月功能费资源Id",
3646
- "example": "",
3647
- "member": "string",
3648
- "name": "ResourceId",
3649
- "required": true,
3650
- "type": "string"
3651
- },
3652
- {
3653
- "disabled": false,
3654
- "document": "自动续费标记，0表示默认状态(用户未设置，即初始状态)， 1表示自动续费，2表示明确不自动续费(用户设置)，若业务无续费概念或无需自动续 费，需要设置为0",
3655
- "example": "",
3656
- "member": "int64",
3657
- "name": "AutoRenewFlag",
3658
- "required": true,
3659
- "type": "int"
3660
- }
3661
- ],
3662
- "type": "object"
3663
- },
3664
- "ModifyAutoRenewFlagResponse": {
3665
- "document": "ModifyAutoRenewFlag返回参数结构体",
3666
- "members": [
3667
- {
3668
- "document": "唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。",
3669
- "member": "string",
3670
- "name": "RequestId",
3671
- "type": "string"
3672
- }
3673
- ],
3674
- "type": "object"
3675
- },
3676
- "ModifyWhiteboardApplicationConfigRequest": {
3677
- "document": "ModifyWhiteboardApplicationConfig请求参数结构体",
3678
- "members": [
3679
- {
3680
- "disabled": false,
3681
- "document": "客户的SdkAppId",
3682
- "example": "1400000001",
3683
- "member": "int64",
3684
- "name": "SdkAppId",
3685
- "required": true,
3686
- "type": "int"
3687
- },
3688
- {
3689
- "disabled": false,
3690
- "document": "白板应用任务相关配置",
3691
- "example": "无",
3692
- "member": "WhiteboardApplicationConfig",
3693
- "name": "Configs",
3694
- "required": true,
3695
- "type": "list"
3696
- }
3697
- ],
3698
- "type": "object"
3699
- },
3700
- "ModifyWhiteboardApplicationConfigResponse": {
3701
- "document": "ModifyWhiteboardApplicationConfig返回参数结构体",
3702
- "members": [
3703
- {
3704
- "document": "唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。",
3705
- "member": "string",
3706
- "name": "RequestId",
3707
- "type": "string"
3708
- }
3709
- ],
3710
- "type": "object"
3711
- },
3712
- "ModifyWhiteboardBucketConfigRequest": {
3713
- "document": "ModifyWhiteboardBucketConfig请求参数结构体",
3714
- "members": [
3715
- {
3716
- "disabled": false,
3717
- "document": "客户的SdkAppId",
3718
- "example": "",
3719
- "member": "int64",
3720
- "name": "SdkAppId",
3721
- "required": true,
3722
- "type": "int"
3723
- },
3724
- {
3725
- "disabled": false,
3726
- "document": "需要查询的任务类型\nrecording: 实时录制\ntranscode: 文档转码",
3727
- "example": "",
3728
- "member": "string",
3729
- "name": "TaskType",
3730
- "required": true,
3731
- "type": "string"
3732
- },
3733
- {
3734
- "disabled": false,
3735
- "document": "COS存储桶名字",
3736
- "example": "",
3737
- "member": "string",
3738
- "name": "BucketName",
3739
- "required": true,
3740
- "type": "string"
3741
- },
3742
- {
3743
- "disabled": false,
3744
- "document": "COS存储桶地域",
3745
- "example": "",
3746
- "member": "string",
3747
- "name": "BucketLocation",
3748
- "required": true,
3749
- "type": "string"
3750
- },
3751
- {
3752
- "disabled": false,
3753
- "document": "存储桶里资源前缀",
3754
- "example": "",
3755
- "member": "string",
3756
- "name": "BucketPrefix",
3757
- "required": true,
3758
- "type": "string"
3759
- },
3760
- {
3761
- "disabled": false,
3762
- "document": "返回Url域名",
3763
- "example": "",
3764
- "member": "string",
3765
- "name": "ResultDomain",
3766
- "required": true,
3767
- "type": "string"
3768
- }
3769
- ],
3770
- "type": "object"
3771
- },
3772
- "ModifyWhiteboardBucketConfigResponse": {
3773
- "document": "ModifyWhiteboardBucketConfig返回参数结构体",
3774
- "members": [
3775
- {
3776
- "document": "唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。",
3777
- "member": "string",
3778
- "name": "RequestId",
3779
- "type": "string"
2101
+ "value_allowed_null": false
2102
+ },
2103
+ {
2104
+ "disabled": false,
2105
+ "document": "自定义混流布局参数\n当此字段存在时，ModelId 及 TeacherId 字段将被忽略",
2106
+ "example": "",
2107
+ "member": "CustomLayout",
2108
+ "name": "Custom",
2109
+ "required": false,
2110
+ "type": "object",
2111
+ "value_allowed_null": false
3780
2112
  }
3781
2113
  ],
3782
- "type": "object"
2114
+ "usage": "in"
3783
2115
  },
3784
2116
  "OmittedDuration": {
3785
2117
  "document": "拼接视频中被忽略的时间段",
@@ -3971,198 +2303,6 @@
3971
2303
  ],
3972
2304
  "usage": "in"
3973
2305
  },
3974
- "RecordTaskResult": {
3975
- "document": "实时录制结果",
3976
- "members": [
3977
- {
3978
- "disabled": false,
3979
- "document": "AUTO - 自动停止录制， USER_CALL - 用户主动调用停止录制",
3980
- "example": "",
3981
- "member": "string",
3982
- "name": "FinishReason",
3983
- "required": true,
3984
- "type": "string",
3985
- "value_allowed_null": false
3986
- },
3987
- {
3988
- "disabled": false,
3989
- "document": "异常数",
3990
- "example": "",
3991
- "member": "int64",
3992
- "name": "ExceptionCnt",
3993
- "required": true,
3994
- "type": "int",
3995
- "value_allowed_null": false
3996
- },
3997
- {
3998
- "disabled": false,
3999
- "document": "房间号",
4000
- "example": "",
4001
- "member": "int64",
4002
- "name": "RoomId",
4003
- "required": true,
4004
- "type": "int",
4005
- "value_allowed_null": false
4006
- },
4007
- {
4008
- "disabled": false,
4009
- "document": "分组",
4010
- "example": "",
4011
- "member": "string",
4012
- "name": "GroupId",
4013
- "required": true,
4014
- "type": "string",
4015
- "value_allowed_null": false
4016
- },
4017
- {
4018
- "disabled": false,
4019
- "document": "录制真实开始时间",
4020
- "example": "",
4021
- "member": "int64",
4022
- "name": "RecordStartTime",
4023
- "required": true,
4024
- "type": "int",
4025
- "value_allowed_null": false
4026
- },
4027
- {
4028
- "disabled": false,
4029
- "document": "录制结束时间",
4030
- "example": "",
4031
- "member": "int64",
4032
- "name": "RecordStopTime",
4033
- "required": true,
4034
- "type": "int",
4035
- "value_allowed_null": false
4036
- },
4037
- {
4038
- "disabled": false,
4039
- "document": "录制总时长",
4040
- "example": "",
4041
- "member": "int64",
4042
- "name": "TotalTime",
4043
- "required": true,
4044
- "type": "int",
4045
- "value_allowed_null": false
4046
- },
4047
- {
4048
- "disabled": false,
4049
- "document": "视频信息列表",
4050
- "example": "",
4051
- "member": "VideoInfo",
4052
- "name": "VideoInfos",
4053
- "required": true,
4054
- "type": "list",
4055
- "value_allowed_null": false
4056
- },
4057
- {
4058
- "disabled": false,
4059
- "document": "被忽略的视频时间段",
4060
- "example": "",
4061
- "member": "OmittedDuration",
4062
- "name": "OmittedDurations",
4063
- "required": true,
4064
- "type": "list",
4065
- "value_allowed_null": false
4066
- },
4067
- {
4068
- "disabled": false,
4069
- "document": "详情",
4070
- "example": "",
4071
- "member": "string",
4072
- "name": "Details",
4073
- "required": true,
4074
- "type": "string",
4075
- "value_allowed_null": false
4076
- },
4077
- {
4078
- "disabled": false,
4079
- "document": "任务失败错误码",
4080
- "example": "",
4081
- "member": "int64",
4082
- "name": "ErrorCode",
4083
- "required": true,
4084
- "type": "int",
4085
- "value_allowed_null": false
4086
- },
4087
- {
4088
- "disabled": false,
4089
- "document": "错误信息",
4090
- "example": "",
4091
- "member": "string",
4092
- "name": "ErrorMsg",
4093
- "required": true,
4094
- "type": "string",
4095
- "value_allowed_null": false
4096
- }
4097
- ],
4098
- "usage": "out"
4099
- },
4100
- "RecordTaskSearchResult": {
4101
- "document": "实时录制任务搜索结果",
4102
- "members": [
4103
- {
4104
- "disabled": false,
4105
- "document": "任务唯一ID",
4106
- "example": "",
4107
- "member": "string",
4108
- "name": "TaskId",
4109
- "required": true,
4110
- "type": "string",
4111
- "value_allowed_null": false
4112
- },
4113
- {
4114
- "disabled": false,
4115
- "document": "实时录制任务状态\n- PAUSED: 录制已暂停\n- PREPARED: 录制在准备阶段\n- RECORDING: 正在录制\n- STOPPED：录制已停止\n- FINISHED: 录制已结束",
4116
- "example": "",
4117
- "member": "string",
4118
- "name": "Status",
4119
- "required": true,
4120
- "type": "string",
4121
- "value_allowed_null": false
4122
- },
4123
- {
4124
- "disabled": false,
4125
- "document": "实时录制房间号",
4126
- "example": "",
4127
- "member": "int64",
4128
- "name": "RoomId",
4129
- "required": true,
4130
- "type": "int",
4131
- "value_allowed_null": false
4132
- },
4133
- {
4134
- "disabled": false,
4135
- "document": "任务创建时间",
4136
- "example": "",
4137
- "member": "datetime_iso",
4138
- "name": "CreateTime",
4139
- "required": true,
4140
- "type": "string",
4141
- "value_allowed_null": false
4142
- },
4143
- {
4144
- "disabled": false,
4145
- "document": "用户应用SdkAppId",
4146
- "example": "",
4147
- "member": "int64",
4148
- "name": "SdkAppId",
4149
- "required": true,
4150
- "type": "int",
4151
- "value_allowed_null": false
4152
- },
4153
- {
4154
- "disabled": false,
4155
- "document": "实时录制结果",
4156
- "example": "",
4157
- "member": "RecordTaskResult",
4158
- "name": "Result",
4159
- "required": true,
4160
- "type": "object",
4161
- "value_allowed_null": false
4162
- }
4163
- ],
4164
- "usage": "out"
4165
- },
4166
2306
  "ResumeOnlineRecordRequest": {
4167
2307
  "document": "ResumeOnlineRecord请求参数结构体",
4168
2308
  "members": [
@@ -4199,108 +2339,6 @@
4199
2339
  ],
4200
2340
  "type": "object"
4201
2341
  },
4202
- "RoomListItem": {
4203
- "document": "日志查询里返回的白板房间数据",
4204
- "members": [
4205
- {
4206
- "disabled": false,
4207
- "document": "房间ID",
4208
- "example": "100000",
4209
- "member": "string",
4210
- "name": "RoomId",
4211
- "required": true,
4212
- "type": "string",
4213
- "value_allowed_null": false
4214
- },
4215
- {
4216
- "disabled": false,
4217
- "document": "房间在查询时间段内最早出现的时间，Unix时间戳，单位毫秒",
4218
- "example": "1614519034000",
4219
- "member": "int64",
4220
- "name": "StartTime",
4221
- "required": true,
4222
- "type": "int",
4223
- "value_allowed_null": false
4224
- },
4225
- {
4226
- "disabled": false,
4227
- "document": "房间在查询时间段内最晚出现的时间，Unix时间戳，单位毫秒",
4228
- "example": "1614519034000",
4229
- "member": "int64",
4230
- "name": "EndTime",
4231
- "required": true,
4232
- "type": "int",
4233
- "value_allowed_null": false
4234
- },
4235
- {
4236
- "disabled": false,
4237
- "document": "房间里成员数",
4238
- "example": "100",
4239
- "member": "int64",
4240
- "name": "UserNumber",
4241
- "required": true,
4242
- "type": "int",
4243
- "value_allowed_null": false
4244
- }
4245
- ],
4246
- "usage": "both"
4247
- },
4248
- "RoomUsageDataItem": {
4249
- "document": "互动白板房间用量信息",
4250
- "members": [
4251
- {
4252
- "disabled": false,
4253
- "document": "日期，格式为YYYY-MM-DD",
4254
- "example": "2021-10-01",
4255
- "member": "string",
4256
- "name": "Time",
4257
- "required": true,
4258
- "type": "string",
4259
- "value_allowed_null": false
4260
- },
4261
- {
4262
- "disabled": false,
4263
- "document": "白板应用SDKAppID",
4264
- "example": "1400000001",
4265
- "member": "int64",
4266
- "name": "SdkAppId",
4267
- "required": true,
4268
- "type": "int",
4269
- "value_allowed_null": false
4270
- },
4271
- {
4272
- "disabled": false,
4273
- "document": "互动白板子产品，请求参数传入的一致\n- sp_tiw_board: 互动白板时长\n- sp_tiw_ric: 实时录制时长",
4274
- "example": "sp_tiw_board",
4275
- "member": "string",
4276
- "name": "SubProduct",
4277
- "required": true,
4278
- "type": "string",
4279
- "value_allowed_null": false
4280
- },
4281
- {
4282
- "disabled": false,
4283
- "document": "用量值\n- 白板时长、实时录制时长单位为分钟",
4284
- "example": "100000",
4285
- "member": "float",
4286
- "name": "Value",
4287
- "required": true,
4288
- "type": "float",
4289
- "value_allowed_null": false
4290
- },
4291
- {
4292
- "disabled": false,
4293
- "document": "互动白板房间号",
4294
- "example": "12345",
4295
- "member": "uint64",
4296
- "name": "RoomID",
4297
- "required": true,
4298
- "type": "int",
4299
- "value_allowed_null": false
4300
- }
4301
- ],
4302
- "usage": "out"
4303
- },
4304
2342
  "RunningTaskItem": {
4305
2343
  "document": "正在运行的任务列表项",
4306
2344
  "members": [
@@ -4949,8 +2987,8 @@
4949
2987
  },
4950
2988
  {
4951
2989
  "disabled": false,
4952
- "document": "需要录制的白板房间号，取值范围: (1, 4294967295)。\n\n1. 在没有指定`GroupId`的情况下，实时录制默认以`RoomId`的字符串表达形式作为同步白板信令的IM群组ID（比如`RoomId`为1234，则IM群组ID为\"1234\"），并加群进行信令同步，请在开始录制前确保相应IM群组已创建完成，否则会导致录制失败。\n2. 在没有指定`TRTCRoomId`和`TRTCRoomIdStr`的情况下，默认会以`RoomId`作为TRTC房间号进房拉流进行录制。",
4953
- "example": "12345",
2990
+ "document": "需要录制的白板房间号，取值范围: (1, 4294967295)。\n\n1. 在没有指定`GroupId`的情况下，实时录制默认以`RoomId`的字符串表达形式作为同步白板信令的IM群组ID（比如`RoomId`为12358，则IM群组ID为\"12358\"），并加群进行信令同步，请在开始录制前确保相应IM群组已创建完成，否则会导致录制失败。\n2. 在没有指定`TRTCRoomId`和`TRTCRoomIdStr`的情况下，默认会以`RoomId`作为TRTC房间号进房拉流进行录制。",
2991
+ "example": "12358",
4954
2992
  "member": "int64",
4955
2993
  "name": "RoomId",
4956
2994
  "required": true,
@@ -4959,7 +2997,7 @@
4959
2997
  {
4960
2998
  "disabled": false,
4961
2999
  "document": "用于录制服务进房的用户ID，最大长度不能大于60个字节，格式为`tic_record_user_${RoomId}_${Random}`，其中 `${RoomId} `与录制房间号对应，`${Random}`为一个随机字符串。\n该ID必须是一个单独的未在SDK中使用的ID，录制服务使用这个用户ID进入房间进行音视频与白板录制，若该ID和SDK中使用的ID重复，会导致SDK和录制服务互踢，影响正常录制。",
4962
- "example": "tic_record_user_880528_1258",
3000
+ "example": "tic_record_user_12358_1258",
4963
3001
  "member": "string",
4964
3002
  "name": "RecordUserId",
4965
3003
  "required": true,
@@ -4977,7 +3015,7 @@
4977
3015
  {
4978
3016
  "disabled": false,
4979
3017
  "document": "白板进行信令同步的 IM 群组 ID。\n在没有指定`GroupId`的情况下，实时录制服务将使用 `RoomId` 的字符串形式作为同步白板信令的IM群组ID。\n在指定了`GroupId`的情况下，实时录制将优先使用`GroupId`作为同步白板信令的群组ID。请在开始录制前确保相应的IM群组已创建完成，否则会导致录制失败。",
4980
- "example": "12345",
3018
+ "example": "12358",
4981
3019
  "member": "string",
4982
3020
  "name": "GroupId",
4983
3021
  "required": false,
@@ -5049,7 +3087,7 @@
5049
3087
  {
5050
3088
  "disabled": false,
5051
3089
  "document": "聊天群组ID，此字段仅适用于`视频生成模式`\n\n在`视频生成模式`下，默认会记录白板群组内的非白板信令消息，如果指定了`ChatGroupId`，则会记录指定群ID的聊天消息。",
5052
- "example": "12345",
3090
+ "example": "12358",
5053
3091
  "member": "string",
5054
3092
  "name": "ChatGroupId",
5055
3093
  "required": false,
@@ -5076,7 +3114,7 @@
5076
3114
  {
5077
3115
  "disabled": false,
5078
3116
  "document": "TRTC数字类型房间号，取值范围: (1, 4294967295)。\n\n在同时指定了`RoomId`与`TRTCRoomId`的情况下，优先使用`TRTCRoomId`作为实时录制拉TRTC流的TRTC房间号。\n\n当指定了`TRTCRoomIdStr`的情况下，此字段将被忽略。",
5079
- "example": "12345",
3117
+ "example": "12358",
5080
3118
  "member": "int64",
5081
3119
  "name": "TRTCRoomId",
5082
3120
  "required": false,
@@ -5131,7 +3169,7 @@
5131
3169
  {
5132
3170
  "disabled": false,
5133
3171
  "document": "需要推流的白板房间号，取值范围: (1, 4294967295)。\n\n1. 在没有指定`GroupId`的情况下，白板推流默认以`RoomId`的字符串表达形式作为IM群组ID（比如RoomId为1234，则IM群组ID为\"1234\"），并加群进行信令同步，请在开始推流前确保相应IM群组已创建完成，否则会导致推流失败。\n2. 在没有指定`TRTCRoomId`和`TRTCRoomIdStr`的情况下，默认会以`RoomId`作为白板流进行推流的TRTC房间号。",
5134
- "example": "12345",
3172
+ "example": "1268",
5135
3173
  "member": "int64",
5136
3174
  "name": "RoomId",
5137
3175
  "required": true,
@@ -5139,8 +3177,8 @@
5139
3177
  },
5140
3178
  {
5141
3179
  "disabled": false,
5142
- "document": "用于白板推流服务进入白板房间的用户ID。在没有额外指定`IMAuthParam`和`TRTCAuthParam`的情况下，这个用户ID同时会用于IM登录、IM加群、TRTC进房推流等操作。\n用户ID最大长度不能大于60个字节，该用户ID必须是一个单独的未同时在其他地方使用的用户ID，白板推流服务使用这个用户ID进入房间进行白板音视频推流，若该用户ID和其他地方同时在使用的用户ID重复，会导致白板推流服务与其他使用场景帐号互踢，影响正常推流。",
5143
- "example": "tic_push_12345_xxx",
3180
+ "document": "用于白板推流服务进入白板房间的用户ID。在没有额外指定`IMAuthParam`和`TRTCAuthParam`的情况下，这个用户ID同时会用于IM登录、IM加群、TRTC进房推流等操作。\n用户ID最大长度不能大于60个字节，该用户ID必须是一个单独的未同时在其他地方使用的用户ID，白板推流服务使用这个用户ID进入房间进行白板音视频推流，若该用户ID和其他地方同时在使用的用户ID重复，会导致白板推流服务与其他使用场景账号互踢，影响正常推流。",
3181
+ "example": "tic_push_1268_xxx",
5144
3182
  "member": "string",
5145
3183
  "name": "PushUserId",
5146
3184
  "required": true,
@@ -5266,7 +3304,7 @@
5266
3304
  {
5267
3305
  "disabled": false,
5268
3306
  "document": "TRTC数字类型房间号，取值范围: (1, 4294967295)。\n\n在同时指定了`RoomId`与`TRTCRoomId`的情况下，优先使用`TRTCRoomId`作为白板流进行推流的TRTC房间号。\n\n当指定了`TRTCRoomIdStr`的情况下，此字段将被忽略。",
5269
- "example": "12345",
3307
+ "example": "1368",
5270
3308
  "member": "int64",
5271
3309
  "name": "TRTCRoomId",
5272
3310
  "required": false,
@@ -5311,7 +3349,7 @@
5311
3349
  {
5312
3350
  "disabled": false,
5313
3351
  "document": "白板进行信令同步的 IM 群组 ID。\n在没有指定`GroupId`的情况下，白板推流服务将使用 `RoomId` 的字符串形式作为同步白板信令的IM群组ID。\n在指定了`GroupId`的情况下，白板推流将优先`GroupId`作为同步白板信令的群组ID。请在开始推流前确保指定的IM群组已创建完成，否则会导致推流失败。",
5314
- "example": "12345",
3352
+ "example": "1368",
5315
3353
  "member": "string",
5316
3354
  "name": "GroupId",
5317
3355
  "required": false,
@@ -5504,332 +3542,26 @@
5504
3542
  },
5505
3543
  {
5506
3544
  "disabled": false,
5507
- "document": "背景颜色，默认为黑色，格式为RGB格式，如红色为\"#FF0000\"",
5508
- "example": "",
5509
- "member": "string",
5510
- "name": "BackgroundColor",
5511
- "required": false,
5512
- "type": "string",
5513
- "value_allowed_null": false
5514
- },
5515
- {
5516
- "disabled": false,
5517
- "document": "视频画面填充模式。\n\n0 - 自适应模式，对视频画面进行等比例缩放，在指定区域内显示完整的画面。此模式可能存在黑边。\n1 - 全屏模式，对视频画面进行等比例缩放，让画面填充满整个指定区域。此模式不会存在黑边，但会将超出区域的那一部分画面裁剪掉。",
5518
- "example": "",
5519
- "member": "int64",
5520
- "name": "FillMode",
5521
- "required": false,
5522
- "type": "int",
5523
- "value_allowed_null": false
5524
- }
5525
- ],
5526
- "usage": "in"
5527
- },
5528
- "Tag": {
5529
- "document": "标签",
5530
- "members": [
5531
- {
5532
- "disabled": false,
5533
- "document": "标签键",
5534
- "example": "",
5535
- "member": "string",
5536
- "name": "TagKey",
5537
- "required": true,
5538
- "type": "string",
5539
- "value_allowed_null": false
5540
- },
5541
- {
5542
- "disabled": false,
5543
- "document": "标签值",
5544
- "example": "",
5545
- "member": "string",
5546
- "name": "TagValue",
5547
- "required": true,
5548
- "type": "string",
5549
- "value_allowed_null": false
5550
- }
5551
- ],
5552
- "usage": "both"
5553
- },
5554
- "TimeValue": {
5555
- "document": "查询指标返回的时间序列",
5556
- "members": [
5557
- {
5558
- "disabled": false,
5559
- "document": "Unix时间戳，单位秒",
5560
- "example": "1617883200",
5561
- "member": "uint64",
5562
- "name": "Time",
5563
- "required": true,
5564
- "type": "int",
5565
- "value_allowed_null": false
5566
- },
5567
- {
5568
- "disabled": false,
5569
- "document": "查询指标对应当前时间的值",
5570
- "example": "100",
5571
- "member": "float",
5572
- "name": "Value",
5573
- "required": true,
5574
- "type": "float",
5575
- "value_allowed_null": false
5576
- }
5577
- ],
5578
- "usage": "out"
5579
- },
5580
- "TranscodeTaskResult": {
5581
- "document": "转码任务结果",
5582
- "members": [
5583
- {
5584
- "disabled": false,
5585
- "document": "转码结果地址",
5586
- "example": "",
5587
- "member": "string",
5588
- "name": "ResultUrl",
5589
- "required": true,
5590
- "type": "string",
5591
- "value_allowed_null": false
5592
- },
5593
- {
5594
- "disabled": false,
5595
- "document": "分辨率",
5596
- "example": "",
5597
- "member": "string",
5598
- "name": "Resolution",
5599
- "required": true,
5600
- "type": "string",
5601
- "value_allowed_null": false
5602
- },
5603
- {
5604
- "disabled": false,
5605
- "document": "标题（一般为文件名）",
5606
- "example": "",
5607
- "member": "string",
5608
- "name": "Title",
5609
- "required": true,
5610
- "type": "string",
5611
- "value_allowed_null": false
5612
- },
5613
- {
5614
- "disabled": false,
5615
- "document": "转码页数",
5616
- "example": "",
5617
- "member": "int64",
5618
- "name": "Pages",
5619
- "required": true,
5620
- "type": "int",
5621
- "value_allowed_null": false
5622
- },
5623
- {
5624
- "disabled": false,
5625
- "document": "缩略图URL前缀，比如，该URL前缀为http://example.com/g0jb42ps49vtebjshilb/，那么动态PPT第1页的缩略图URL为\nhttp://example.com/g0jb42ps49vtebjshilb/1.jpg，其它页以此类推\n\n如果发起文档转码请求参数中带了ThumbnailResolution参数，并且转码类型为动态转码，该参数不为空，其余情况该参数为空字符串",
5626
- "example": "",
5627
- "member": "string",
5628
- "name": "ThumbnailUrl",
5629
- "required": true,
5630
- "type": "string",
5631
- "value_allowed_null": false
5632
- },
5633
- {
5634
- "disabled": false,
5635
- "document": "动态转码缩略图生成分辨率",
5636
- "example": "",
5637
- "member": "string",
5638
- "name": "ThumbnailResolution",
5639
- "required": true,
5640
- "type": "string",
5641
- "value_allowed_null": false
5642
- },
5643
- {
5644
- "disabled": false,
5645
- "document": "转码压缩文件下载的URL，如果发起文档转码请求参数中CompressFileType为空或者不是支持的压缩格式，该参数为空字符串",
5646
- "example": "",
5647
- "member": "string",
5648
- "name": "CompressFileUrl",
5649
- "required": true,
5650
- "type": "string",
5651
- "value_allowed_null": false
5652
- },
5653
- {
5654
- "disabled": false,
5655
- "document": "任务失败错误码",
5656
- "example": "",
5657
- "member": "int64",
5658
- "name": "ErrorCode",
5659
- "required": true,
5660
- "type": "int",
5661
- "value_allowed_null": false
5662
- },
5663
- {
5664
- "disabled": false,
5665
- "document": "任务失败错误信息",
5666
- "example": "",
5667
- "member": "string",
5668
- "name": "ErrorMsg",
5669
- "required": true,
5670
- "type": "string",
5671
- "value_allowed_null": false
5672
- }
5673
- ],
5674
- "usage": "out"
5675
- },
5676
- "TranscodeTaskSearchResult": {
5677
- "document": "转码任务搜索结果",
5678
- "members": [
5679
- {
5680
- "disabled": false,
5681
- "document": "任务创建时间",
5682
- "example": "",
5683
- "member": "datetime_iso",
5684
- "name": "CreateTime",
5685
- "required": true,
5686
- "type": "string",
5687
- "value_allowed_null": false
5688
- },
5689
- {
5690
- "disabled": false,
5691
- "document": "任务唯一ID",
5692
- "example": "",
5693
- "member": "string",
5694
- "name": "TaskId",
5695
- "required": true,
5696
- "type": "string",
5697
- "value_allowed_null": false
5698
- },
5699
- {
5700
- "disabled": false,
5701
- "document": "任务的当前状态\n- QUEUED: 正在排队等待转换\n- PROCESSING: 转换中\n- FINISHED: 转换完成",
5702
- "example": "",
5703
- "member": "string",
5704
- "name": "Status",
5705
- "required": true,
5706
- "type": "string",
5707
- "value_allowed_null": false
5708
- },
5709
- {
5710
- "disabled": false,
5711
- "document": "转码文件原始名称",
5712
- "example": "",
5713
- "member": "string",
5714
- "name": "OriginalFilename",
5715
- "required": true,
5716
- "type": "string",
5717
- "value_allowed_null": false
5718
- },
5719
- {
5720
- "disabled": false,
5721
- "document": "用户应用SdkAppId",
5722
- "example": "",
5723
- "member": "int64",
5724
- "name": "SdkAppId",
5725
- "required": true,
5726
- "type": "int",
5727
- "value_allowed_null": false
5728
- },
5729
- {
5730
- "disabled": false,
5731
- "document": "转码任务结果",
5732
- "example": "",
5733
- "member": "TranscodeTaskResult",
5734
- "name": "Result",
5735
- "required": true,
5736
- "type": "object",
5737
- "value_allowed_null": false
5738
- },
5739
- {
5740
- "disabled": false,
5741
- "document": "是否静态转码",
5742
- "example": "",
5743
- "member": "bool",
5744
- "name": "IsStatic",
5745
- "required": true,
5746
- "type": "bool",
5747
- "value_allowed_null": false
5748
- }
5749
- ],
5750
- "usage": "out"
5751
- },
5752
- "UsageDataItem": {
5753
- "document": "互动白板用量信息",
5754
- "members": [
5755
- {
5756
- "disabled": false,
5757
- "document": "日期，格式为YYYY-MM-DD",
5758
- "example": "2021-10-01",
5759
- "member": "string",
5760
- "name": "Time",
5761
- "required": true,
5762
- "type": "string",
5763
- "value_allowed_null": false
5764
- },
5765
- {
5766
- "disabled": false,
5767
- "document": "白板应用SDKAppID",
5768
- "example": "1400000001",
5769
- "member": "int64",
5770
- "name": "SdkAppId",
5771
- "required": true,
5772
- "type": "int",
5773
- "value_allowed_null": false
5774
- },
5775
- {
5776
- "disabled": false,
5777
- "document": "互动白板子产品，请求参数传入的一致\n- sp_tiw_board: 互动白板时长\n- sp_tiw_dt: 动态转码页数\n- sp_tiw_st: 静态转码页数\n- sp_tiw_ric: 实时录制时长",
5778
- "example": "sp_tiw_board",
5779
- "member": "string",
5780
- "name": "SubProduct",
5781
- "required": true,
5782
- "type": "string",
5783
- "value_allowed_null": false
5784
- },
5785
- {
5786
- "disabled": false,
5787
- "document": "用量值\n- 静态转码、动态转码单位为页\n- 白板时长、实时录制时长单位为分钟",
5788
- "example": "100000",
5789
- "member": "float",
5790
- "name": "Value",
5791
- "required": true,
5792
- "type": "float",
5793
- "value_allowed_null": false
5794
- }
5795
- ],
5796
- "usage": "out"
5797
- },
5798
- "UserListItem": {
5799
- "document": "日志查询里返回的白板用户数据",
5800
- "members": [
5801
- {
5802
- "disabled": false,
5803
- "document": "房间内的用户ID",
5804
- "example": "100000",
5805
- "member": "string",
5806
- "name": "UserId",
5807
- "required": true,
5808
- "type": "string",
5809
- "value_allowed_null": false
5810
- },
5811
- {
5812
- "disabled": false,
5813
- "document": "用户在查询时间段内最早出现的时间，Unix时间戳，单位毫秒",
5814
- "example": "1614519034000",
5815
- "member": "int64",
5816
- "name": "StartTime",
5817
- "required": true,
5818
- "type": "int",
3545
+ "document": "背景颜色，默认为黑色，格式为RGB格式，如红色为\"#FF0000\"",
3546
+ "example": "",
3547
+ "member": "string",
3548
+ "name": "BackgroundColor",
3549
+ "required": false,
3550
+ "type": "string",
5819
3551
  "value_allowed_null": false
5820
3552
  },
5821
3553
  {
5822
3554
  "disabled": false,
5823
- "document": "用户在查询时间段内最晚出现的时间，Unix时间戳，单位毫秒",
5824
- "example": "1614519034000",
3555
+ "document": "视频画面填充模式。\n\n0 - 自适应模式，对视频画面进行等比例缩放，在指定区域内显示完整的画面。此模式可能存在黑边。\n1 - 全屏模式，对视频画面进行等比例缩放，让画面填充满整个指定区域。此模式不会存在黑边，但会将超出区域的那一部分画面裁剪掉。",
3556
+ "example": "",
5825
3557
  "member": "int64",
5826
- "name": "EndTime",
5827
- "required": true,
3558
+ "name": "FillMode",
3559
+ "required": false,
5828
3560
  "type": "int",
5829
3561
  "value_allowed_null": false
5830
3562
  }
5831
3563
  ],
5832
- "usage": "both"
3564
+ "usage": "in"
5833
3565
  },
5834
3566
  "VideoInfo": {
5835
3567
  "document": "视频信息",
@@ -5973,112 +3705,6 @@
5973
3705
  ],
5974
3706
  "usage": "in"
5975
3707
  },
5976
- "WhiteboardApplicationConfig": {
5977
- "document": "白板应用配置，包括资源存储桶，域名，回调地址，回调密钥等",
5978
- "members": [
5979
- {
5980
- "disabled": false,
5981
- "document": "任务类型\n\nrecording: 实时录制\ntranscode: 文档转码",
5982
- "example": "",
5983
- "member": "string",
5984
- "name": "TaskType",
5985
- "required": true,
5986
- "type": "string",
5987
- "value_allowed_null": false
5988
- },
5989
- {
5990
- "disabled": false,
5991
- "document": "存储桶名字",
5992
- "example": "",
5993
- "member": "string",
5994
- "name": "BucketName",
5995
- "required": true,
5996
- "type": "string",
5997
- "value_allowed_null": false
5998
- },
5999
- {
6000
- "disabled": false,
6001
- "document": "存储桶地域",
6002
- "example": "",
6003
- "member": "string",
6004
- "name": "BucketLocation",
6005
- "required": true,
6006
- "type": "string",
6007
- "value_allowed_null": false
6008
- },
6009
- {
6010
- "disabled": false,
6011
- "document": "资源在存储桶中的前缀",
6012
- "example": "",
6013
- "member": "string",
6014
- "name": "BucketPrefix",
6015
- "required": true,
6016
- "type": "string",
6017
- "value_allowed_null": false
6018
- },
6019
- {
6020
- "disabled": false,
6021
- "document": "目标CDN域名",
6022
- "example": "",
6023
- "member": "string",
6024
- "name": "ResultDomain",
6025
- "required": true,
6026
- "type": "string",
6027
- "value_allowed_null": false
6028
- },
6029
- {
6030
- "disabled": false,
6031
- "document": "回调地址",
6032
- "example": "",
6033
- "member": "string",
6034
- "name": "Callback",
6035
- "required": true,
6036
- "type": "string",
6037
- "value_allowed_null": false
6038
- },
6039
- {
6040
- "disabled": false,
6041
- "document": "回调鉴权密钥",
6042
- "example": "",
6043
- "member": "string",
6044
- "name": "CallbackKey",
6045
- "required": true,
6046
- "type": "string",
6047
- "value_allowed_null": false
6048
- },
6049
- {
6050
- "disabled": false,
6051
- "document": "配置的应用SdkAppId",
6052
- "example": "",
6053
- "member": "int64",
6054
- "name": "SdkAppId",
6055
- "required": false,
6056
- "type": "int",
6057
- "value_allowed_null": false
6058
- },
6059
- {
6060
- "disabled": false,
6061
- "document": "IM管理员UserId",
6062
- "example": "",
6063
- "member": "string",
6064
- "name": "AdminUserId",
6065
- "required": false,
6066
- "type": "string",
6067
- "value_allowed_null": false
6068
- },
6069
- {
6070
- "disabled": false,
6071
- "document": "IM管理员UserSig",
6072
- "example": "",
6073
- "member": "string",
6074
- "name": "AdminUserSig",
6075
- "required": false,
6076
- "type": "string",
6077
- "value_allowed_null": false
6078
- }
6079
- ],
6080
- "usage": "both"
6081
- },
6082
3708
  "WhiteboardPushBackupParam": {
6083
3709
  "document": "白板推流备份相关请求参数",
6084
3710
  "members": [
@@ -6104,178 +3730,6 @@
6104
3730
  }
6105
3731
  ],
6106
3732
  "usage": "in"
6107
- },
6108
- "WhiteboardPushResult": {
6109
- "document": "白板推流任务结果",
6110
- "members": [
6111
- {
6112
- "disabled": false,
6113
- "document": "AUTO - 自动停止推流， USER_CALL - 用户主动调用停止推流",
6114
- "example": "",
6115
- "member": "string",
6116
- "name": "FinishReason",
6117
- "required": true,
6118
- "type": "string",
6119
- "value_allowed_null": false
6120
- },
6121
- {
6122
- "disabled": false,
6123
- "document": "异常数",
6124
- "example": "",
6125
- "member": "int64",
6126
- "name": "ExceptionCnt",
6127
- "required": true,
6128
- "type": "int",
6129
- "value_allowed_null": false
6130
- },
6131
- {
6132
- "disabled": false,
6133
- "document": "房间号",
6134
- "example": "",
6135
- "member": "int64",
6136
- "name": "RoomId",
6137
- "required": true,
6138
- "type": "int",
6139
- "value_allowed_null": false
6140
- },
6141
- {
6142
- "disabled": false,
6143
- "document": "IM群组ID",
6144
- "example": "",
6145
- "member": "string",
6146
- "name": "GroupId",
6147
- "required": true,
6148
- "type": "string",
6149
- "value_allowed_null": false
6150
- },
6151
- {
6152
- "disabled": false,
6153
- "document": "推流真实开始时间",
6154
- "example": "",
6155
- "member": "int64",
6156
- "name": "PushStartTime",
6157
- "required": true,
6158
- "type": "int",
6159
- "value_allowed_null": false
6160
- },
6161
- {
6162
- "disabled": false,
6163
- "document": "推流结束时间",
6164
- "example": "",
6165
- "member": "int64",
6166
- "name": "PushStopTime",
6167
- "required": true,
6168
- "type": "int",
6169
- "value_allowed_null": false
6170
- },
6171
- {
6172
- "disabled": false,
6173
- "document": "白板推流首帧对应的IM时间戳，可用于录制回放时IM聊天消息与白板推流视频进行同步对时。",
6174
- "example": "",
6175
- "member": "int64",
6176
- "name": "IMSyncTime",
6177
- "required": true,
6178
- "type": "int",
6179
- "value_allowed_null": false
6180
- },
6181
- {
6182
- "disabled": false,
6183
- "document": "任务失败错误码",
6184
- "example": "",
6185
- "member": "int64",
6186
- "name": "ErrorCode",
6187
- "required": true,
6188
- "type": "int",
6189
- "value_allowed_null": false
6190
- },
6191
- {
6192
- "disabled": false,
6193
- "document": "错误信息",
6194
- "example": "",
6195
- "member": "string",
6196
- "name": "ErrorMsg",
6197
- "required": true,
6198
- "type": "string",
6199
- "value_allowed_null": false
6200
- }
6201
- ],
6202
- "usage": "out"
6203
- },
6204
- "WhiteboardPushTaskSearchResult": {
6205
- "document": "实时录制任务搜索结果",
6206
- "members": [
6207
- {
6208
- "disabled": false,
6209
- "document": "任务唯一ID",
6210
- "example": "",
6211
- "member": "string",
6212
- "name": "TaskId",
6213
- "required": true,
6214
- "type": "string",
6215
- "value_allowed_null": false
6216
- },
6217
- {
6218
- "disabled": false,
6219
- "document": "白板推流任务状态\n- PREPARED: 推流在准备阶段\n- PUSHING: 正在推流\n- STOPPED：推流已停止",
6220
- "example": "",
6221
- "member": "string",
6222
- "name": "Status",
6223
- "required": true,
6224
- "type": "string",
6225
- "value_allowed_null": false
6226
- },
6227
- {
6228
- "disabled": false,
6229
- "document": "白板推流房间号",
6230
- "example": "",
6231
- "member": "int64",
6232
- "name": "RoomId",
6233
- "required": true,
6234
- "type": "int",
6235
- "value_allowed_null": false
6236
- },
6237
- {
6238
- "disabled": false,
6239
- "document": "任务创建时间",
6240
- "example": "",
6241
- "member": "datetime_iso",
6242
- "name": "CreateTime",
6243
- "required": true,
6244
- "type": "string",
6245
- "value_allowed_null": false
6246
- },
6247
- {
6248
- "disabled": false,
6249
- "document": "用户应用SdkAppId",
6250
- "example": "",
6251
- "member": "int64",
6252
- "name": "SdkAppId",
6253
- "required": true,
6254
- "type": "int",
6255
- "value_allowed_null": false
6256
- },
6257
- {
6258
- "disabled": false,
6259
- "document": "白板推流结果",
6260
- "example": "",
6261
- "member": "WhiteboardPushResult",
6262
- "name": "Result",
6263
- "required": true,
6264
- "type": "object",
6265
- "value_allowed_null": false
6266
- },
6267
- {
6268
- "disabled": false,
6269
- "document": "白板推流用户ID",
6270
- "example": "",
6271
- "member": "string",
6272
- "name": "PushUserId",
6273
- "required": true,
6274
- "type": "string",
6275
- "value_allowed_null": false
6276
- }
6277
- ],
6278
- "usage": "out"
6279
3733
  }
6280
3734
  },
6281
3735
  "version": "1.0"