tencentcloud-sdk-nodejs 4.0.339 → 4.0.342

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 (134) hide show
  1. package/CHANGELOG.md +439 -0
  2. package/SERVICE_CHANGELOG.md +470 -42
  3. package/package.json +1 -1
  4. package/products.md +27 -25
  5. package/src/common/sdk_version.ts +1 -1
  6. package/src/services/antiddos/v20200309/antiddos_models.ts +5 -0
  7. package/src/services/apm/v20210622/apm_client.ts +47 -32
  8. package/src/services/apm/v20210622/apm_models.ts +310 -195
  9. package/src/services/bi/index.ts +5 -0
  10. package/src/services/bi/v20220105/bi_client.ts +57 -0
  11. package/src/services/bi/v20220105/bi_models.ts +214 -0
  12. package/src/services/bi/v20220105/index.ts +6 -0
  13. package/src/services/ccc/v20200210/ccc_client.ts +1 -1
  14. package/src/services/ccc/v20200210/ccc_models.ts +31 -30
  15. package/src/services/cdc/index.ts +5 -0
  16. package/src/services/cdc/v20201214/cdc_client.ts +286 -0
  17. package/src/services/cdc/v20201214/cdc_models.ts +1651 -0
  18. package/src/services/cdc/v20201214/index.ts +6 -0
  19. package/src/services/cdn/v20180606/cdn_models.ts +2 -2
  20. package/src/services/ckafka/v20190819/ckafka_client.ts +12 -0
  21. package/src/services/ckafka/v20190819/ckafka_models.ts +40 -0
  22. package/src/services/cpdp/v20190820/cpdp_client.ts +1 -1
  23. package/src/services/cpdp/v20190820/cpdp_models.ts +17 -9
  24. package/src/services/cwp/v20180228/cwp_models.ts +5 -0
  25. package/src/services/ess/v20201111/ess_models.ts +26 -8
  26. package/src/services/gaap/v20180529/gaap_client.ts +68 -28
  27. package/src/services/gaap/v20180529/gaap_models.ts +280 -68
  28. package/src/services/index.ts +2 -0
  29. package/src/services/iotexplorer/v20190423/iotexplorer_client.ts +2 -2
  30. package/src/services/lighthouse/v20200324/lighthouse_client.ts +12 -2
  31. package/src/services/ocr/v20181119/ocr_client.ts +1 -1
  32. package/src/services/ocr/v20181119/ocr_models.ts +7 -15
  33. package/src/services/redis/v20180412/redis_client.ts +13 -1
  34. package/src/services/redis/v20180412/redis_models.ts +47 -12
  35. package/src/services/sts/v20180813/sts_client.ts +1 -0
  36. package/src/services/sts/v20180813/sts_models.ts +23 -3
  37. package/src/services/teo/v20220106/teo_client.ts +23 -10
  38. package/src/services/teo/v20220106/teo_models.ts +130 -9
  39. package/src/services/tiw/v20190919/tiw_client.ts +3 -2
  40. package/src/services/tiw/v20190919/tiw_models.ts +79 -38
  41. package/src/services/tke/v20180525/tke_client.ts +498 -270
  42. package/src/services/tke/v20180525/tke_models.ts +4357 -4017
  43. package/src/services/tmt/v20180321/tmt_client.ts +61 -33
  44. package/src/services/tmt/v20180321/tmt_models.ts +285 -131
  45. package/src/services/trtc/v20190722/trtc_client.ts +215 -142
  46. package/src/services/trtc/v20190722/trtc_models.ts +773 -141
  47. package/src/services/tsf/v20180326/tsf_models.ts +6 -0
  48. package/src/services/vod/v20180717/vod_client.ts +32 -15
  49. package/src/services/vod/v20180717/vod_models.ts +69 -6
  50. package/src/services/vpc/v20170312/vpc_client.ts +36 -12
  51. package/src/services/vpc/v20170312/vpc_models.ts +40 -0
  52. package/tencentcloud/common/sdk_version.d.ts +1 -1
  53. package/tencentcloud/common/sdk_version.js +1 -1
  54. package/tencentcloud/services/antiddos/v20200309/antiddos_models.d.ts +4 -0
  55. package/tencentcloud/services/apm/v20210622/apm_client.d.ts +14 -9
  56. package/tencentcloud/services/apm/v20210622/apm_client.js +19 -12
  57. package/tencentcloud/services/apm/v20210622/apm_models.d.ts +267 -169
  58. package/tencentcloud/services/bi/index.d.ts +6 -0
  59. package/tencentcloud/services/bi/index.js +7 -0
  60. package/tencentcloud/services/bi/v20220105/bi_client.d.ts +18 -0
  61. package/tencentcloud/services/bi/v20220105/bi_client.js +43 -0
  62. package/tencentcloud/services/bi/v20220105/bi_models.d.ts +168 -0
  63. package/tencentcloud/services/bi/v20220105/bi_models.js +18 -0
  64. package/tencentcloud/services/bi/v20220105/index.d.ts +6 -0
  65. package/tencentcloud/services/bi/v20220105/index.js +9 -0
  66. package/tencentcloud/services/ccc/v20200210/ccc_client.d.ts +1 -1
  67. package/tencentcloud/services/ccc/v20200210/ccc_client.js +1 -1
  68. package/tencentcloud/services/ccc/v20200210/ccc_models.d.ts +29 -28
  69. package/tencentcloud/services/cdc/index.d.ts +6 -0
  70. package/tencentcloud/services/cdc/index.js +7 -0
  71. package/tencentcloud/services/cdc/v20201214/cdc_client.d.ts +90 -0
  72. package/tencentcloud/services/cdc/v20201214/cdc_client.js +151 -0
  73. package/tencentcloud/services/cdc/v20201214/cdc_models.d.ts +1370 -0
  74. package/tencentcloud/services/cdc/v20201214/cdc_models.js +18 -0
  75. package/tencentcloud/services/cdc/v20201214/index.d.ts +6 -0
  76. package/tencentcloud/services/cdc/v20201214/index.js +9 -0
  77. package/tencentcloud/services/cdn/v20180606/cdn_models.d.ts +2 -2
  78. package/tencentcloud/services/ckafka/v20190819/ckafka_client.d.ts +5 -1
  79. package/tencentcloud/services/ckafka/v20190819/ckafka_client.js +6 -0
  80. package/tencentcloud/services/ckafka/v20190819/ckafka_models.d.ts +34 -0
  81. package/tencentcloud/services/cpdp/v20190820/cpdp_client.d.ts +1 -1
  82. package/tencentcloud/services/cpdp/v20190820/cpdp_client.js +1 -1
  83. package/tencentcloud/services/cpdp/v20190820/cpdp_models.d.ts +14 -6
  84. package/tencentcloud/services/cwp/v20180228/cwp_models.d.ts +4 -0
  85. package/tencentcloud/services/ess/v20201111/ess_models.d.ts +23 -7
  86. package/tencentcloud/services/gaap/v20180529/gaap_client.d.ts +21 -9
  87. package/tencentcloud/services/gaap/v20180529/gaap_client.js +30 -12
  88. package/tencentcloud/services/gaap/v20180529/gaap_models.d.ts +245 -60
  89. package/tencentcloud/services/index.d.ts +2 -0
  90. package/tencentcloud/services/index.js +4 -0
  91. package/tencentcloud/services/iotexplorer/v20190423/iotexplorer_client.d.ts +2 -2
  92. package/tencentcloud/services/iotexplorer/v20190423/iotexplorer_client.js +2 -2
  93. package/tencentcloud/services/lighthouse/v20200324/lighthouse_client.d.ts +12 -2
  94. package/tencentcloud/services/lighthouse/v20200324/lighthouse_client.js +12 -2
  95. package/tencentcloud/services/ocr/v20181119/ocr_client.d.ts +1 -1
  96. package/tencentcloud/services/ocr/v20181119/ocr_client.js +1 -1
  97. package/tencentcloud/services/ocr/v20181119/ocr_models.d.ts +7 -15
  98. package/tencentcloud/services/redis/v20180412/redis_client.d.ts +5 -1
  99. package/tencentcloud/services/redis/v20180412/redis_client.js +6 -0
  100. package/tencentcloud/services/redis/v20180412/redis_models.d.ts +41 -11
  101. package/tencentcloud/services/sts/v20180813/sts_models.d.ts +20 -3
  102. package/tencentcloud/services/teo/v20220106/teo_client.d.ts +9 -5
  103. package/tencentcloud/services/teo/v20220106/teo_client.js +12 -6
  104. package/tencentcloud/services/teo/v20220106/teo_models.d.ts +108 -4
  105. package/tencentcloud/services/tiw/v20190919/tiw_client.d.ts +1 -1
  106. package/tencentcloud/services/tiw/v20190919/tiw_models.d.ts +69 -33
  107. package/tencentcloud/services/tke/v20180525/tke_client.d.ts +87 -11
  108. package/tencentcloud/services/tke/v20180525/tke_client.js +129 -15
  109. package/tencentcloud/services/tke/v20180525/tke_models.d.ts +3903 -3606
  110. package/tencentcloud/services/tmt/v20180321/tmt_client.d.ts +23 -13
  111. package/tencentcloud/services/tmt/v20180321/tmt_client.js +31 -17
  112. package/tencentcloud/services/tmt/v20180321/tmt_models.d.ts +259 -123
  113. package/tencentcloud/services/trtc/v20190722/trtc_client.d.ts +95 -68
  114. package/tencentcloud/services/trtc/v20190722/trtc_client.js +121 -86
  115. package/tencentcloud/services/trtc/v20190722/trtc_models.d.ts +672 -135
  116. package/tencentcloud/services/tsf/v20180326/tsf_models.d.ts +5 -0
  117. package/tencentcloud/services/vod/v20180717/vod_client.d.ts +14 -6
  118. package/tencentcloud/services/vod/v20180717/vod_client.js +17 -7
  119. package/tencentcloud/services/vod/v20180717/vod_models.d.ts +61 -6
  120. package/tencentcloud/services/vpc/v20170312/vpc_client.d.ts +13 -5
  121. package/tencentcloud/services/vpc/v20170312/vpc_client.js +18 -6
  122. package/tencentcloud/services/vpc/v20170312/vpc_models.d.ts +36 -0
  123. package/test/apm.v20210622.test.js +18 -8
  124. package/test/bi.v20220105.test.js +41 -0
  125. package/test/cdc.v20201214.test.js +221 -0
  126. package/test/ckafka.v20190819.test.js +10 -0
  127. package/test/gaap.v20180529.test.js +44 -14
  128. package/test/redis.v20180412.test.js +10 -0
  129. package/test/teo.v20220106.test.js +14 -4
  130. package/test/tke.v20180525.test.js +200 -10
  131. package/test/tmt.v20180321.test.js +28 -8
  132. package/test/trtc.v20190722.test.js +74 -34
  133. package/test/vod.v20180717.test.js +14 -4
  134. package/test/vpc.v20170312.test.js +24 -4
@@ -324,6 +324,11 @@ TypeId为标准架构时,MemSize是实例总内存容量;TypeId为集群架
324
324
  * 创建实例需要应用的参数模板ID,不传则应用默认的参数模板
325
325
  */
326
326
  TemplateId?: string
327
+
328
+ /**
329
+ * false :默认值,发送正常请求,通过检查后直接创建实例 true:发送检查请求,不会创建实例。
330
+ */
331
+ DryRun?: boolean
327
332
  }
328
333
 
329
334
  /**
@@ -346,6 +351,21 @@ export interface CreateReplicationGroupRequest {
346
351
  Remark?: string
347
352
  }
348
353
 
354
+ /**
355
+ * ModifyInstanceReadOnly返回参数结构体
356
+ */
357
+ export interface ModifyInstanceReadOnlyResponse {
358
+ /**
359
+ * 任务ID
360
+ */
361
+ TaskId: number
362
+
363
+ /**
364
+ * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
365
+ */
366
+ RequestId?: string
367
+ }
368
+
349
369
  /**
350
370
  * DescribeInstanceZoneInfo请求参数结构体
351
371
  */
@@ -922,6 +942,26 @@ export interface ClearInstanceRequest {
922
942
  Password?: string
923
943
  }
924
944
 
945
+ /**
946
+ * UpgradeInstanceVersion请求参数结构体
947
+ */
948
+ export interface UpgradeInstanceVersionRequest {
949
+ /**
950
+ * 目标实例类型,同 [CreateInstances](https://cloud.tencent.com/document/api/239/20026) 的Type,即实例要变更的目标类型
951
+ */
952
+ TargetInstanceType: string
953
+
954
+ /**
955
+ * 切换模式:1-维护时间窗切换,2-立即切换
956
+ */
957
+ SwitchOption: number
958
+
959
+ /**
960
+ * 实例ID
961
+ */
962
+ InstanceId: string
963
+ }
964
+
925
965
  /**
926
966
  * 地域信息
927
967
  */
@@ -3744,7 +3784,7 @@ export interface ModfiyInstancePasswordResponse {
3744
3784
  /**
3745
3785
  * 任务ID
3746
3786
  */
3747
- TaskId?: number
3787
+ TaskId: number
3748
3788
 
3749
3789
  /**
3750
3790
  * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
@@ -4485,23 +4525,18 @@ export interface DescribeProxySlowLogResponse {
4485
4525
  }
4486
4526
 
4487
4527
  /**
4488
- * UpgradeInstanceVersion请求参数结构体
4528
+ * ModifyInstanceReadOnly请求参数结构体
4489
4529
  */
4490
- export interface UpgradeInstanceVersionRequest {
4491
- /**
4492
- * 目标实例类型,同 [CreateInstances](https://cloud.tencent.com/document/api/239/20026) 的Type,即实例要变更的目标类型
4493
- */
4494
- TargetInstanceType: string
4495
-
4530
+ export interface ModifyInstanceReadOnlyRequest {
4496
4531
  /**
4497
- * 切换模式:1-维护时间窗切换,2-立即切换
4532
+ * 实例ID
4498
4533
  */
4499
- SwitchOption: number
4534
+ InstanceId: string
4500
4535
 
4501
4536
  /**
4502
- * 实例ID
4537
+ * 实例输入模式,0:读写 1:只读
4503
4538
  */
4504
- InstanceId: string
4539
+ InputMode: string
4505
4540
  }
4506
4541
 
4507
4542
  /**
@@ -27,6 +27,7 @@ import {
27
27
  AssumeRoleResponse,
28
28
  QueryApiKeyRequest,
29
29
  GetFederationTokenRequest,
30
+ Tag,
30
31
  GetCallerIdentityResponse,
31
32
  Credentials,
32
33
  AssumeRoleRequest,
@@ -163,17 +163,17 @@ export interface AssumeRoleResponse {
163
163
  /**
164
164
  * 临时安全证书
165
165
  */
166
- Credentials?: Credentials
166
+ Credentials: Credentials
167
167
 
168
168
  /**
169
169
  * 证书无效的时间,返回 Unix 时间戳,精确到秒
170
170
  */
171
- ExpiredTime?: number
171
+ ExpiredTime: number
172
172
 
173
173
  /**
174
174
  * 证书无效的时间,以 iso8601 格式的 UTC 时间表示
175
175
  */
176
- Expiration?: string
176
+ Expiration: string
177
177
 
178
178
  /**
179
179
  * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
@@ -215,6 +215,21 @@ export interface GetFederationTokenRequest {
215
215
  DurationSeconds?: number
216
216
  }
217
217
 
218
+ /**
219
+ * 标签
220
+ */
221
+ export interface Tag {
222
+ /**
223
+ * 标签键,最长128个字符,区分大小写。
224
+ */
225
+ Key: string
226
+
227
+ /**
228
+ * 标签值,最长256个字符,区分大小写。
229
+ */
230
+ Value: string
231
+ }
232
+
218
233
  /**
219
234
  * GetCallerIdentity返回参数结构体
220
235
  */
@@ -313,6 +328,11 @@ qcs::cam::uin/12345678:role/tencentcloudServiceRole/4611686018427397920、qcs::c
313
328
  长度在2到128之间,可包含大小写字符,数字以及特殊字符:=,.@:/-。 正则为:[\w+=,.@:\/-]*
314
329
  */
315
330
  ExternalId?: string
331
+
332
+ /**
333
+ * 会话标签列表。最多可以传递 50 个会话标签,不支持包含相同标签键。
334
+ */
335
+ Tags?: Array<Tag>
316
336
  }
317
337
 
318
338
  /**
@@ -19,10 +19,12 @@ import { AbstractClient } from "../../../common/abstract_client"
19
19
  import { ClientConfig } from "../../../common/interface"
20
20
  import {
21
21
  CreatePurgeTaskResponse,
22
+ DownloadL7LogsRequest,
22
23
  CreatePurgeTaskRequest,
23
24
  DescribePurgeTasksRequest,
24
25
  CreatePrefetchTaskResponse,
25
26
  Zone,
27
+ DownloadL7LogsResponse,
26
28
  DescribePrefetchTasksResponse,
27
29
  DescribeZonesRequest,
28
30
  DescribeZonesResponse,
@@ -33,6 +35,7 @@ import {
33
35
  DescribePurgeTasksResponse,
34
36
  DescribePrefetchTasksRequest,
35
37
  ZoneFilter,
38
+ L7OfflineLog,
36
39
  } from "./teo_models"
37
40
 
38
41
  /**
@@ -44,6 +47,16 @@ export class Client extends AbstractClient {
44
47
  super("teo.tencentcloudapi.com", "2022-01-06", clientConfig)
45
48
  }
46
49
 
50
+ /**
51
+ * 查询七层离线日志
52
+ */
53
+ async DownloadL7Logs(
54
+ req: DownloadL7LogsRequest,
55
+ cb?: (error: string, rep: DownloadL7LogsResponse) => void
56
+ ): Promise<DownloadL7LogsResponse> {
57
+ return this.request("DownloadL7Logs", req, cb)
58
+ }
59
+
47
60
  /**
48
61
  * 创建清除缓存任务
49
62
  */
@@ -64,16 +77,6 @@ export class Client extends AbstractClient {
64
77
  return this.request("DescribePurgeTasks", req, cb)
65
78
  }
66
79
 
67
- /**
68
- * 创建预热任务
69
- */
70
- async CreatePrefetchTask(
71
- req: CreatePrefetchTaskRequest,
72
- cb?: (error: string, rep: CreatePrefetchTaskResponse) => void
73
- ): Promise<CreatePrefetchTaskResponse> {
74
- return this.request("CreatePrefetchTask", req, cb)
75
- }
76
-
77
80
  /**
78
81
  * 查询预热任务状态
79
82
  */
@@ -84,6 +87,16 @@ export class Client extends AbstractClient {
84
87
  return this.request("DescribePrefetchTasks", req, cb)
85
88
  }
86
89
 
90
+ /**
91
+ * 创建预热任务
92
+ */
93
+ async CreatePrefetchTask(
94
+ req: CreatePrefetchTaskRequest,
95
+ cb?: (error: string, rep: CreatePrefetchTaskResponse) => void
96
+ ): Promise<CreatePrefetchTaskResponse> {
97
+ return this.request("CreatePrefetchTask", req, cb)
98
+ }
99
+
87
100
  /**
88
101
  * 用户查询用户站点信息列表,支持分页
89
102
  */
@@ -36,6 +36,41 @@ export interface CreatePurgeTaskResponse {
36
36
  RequestId?: string
37
37
  }
38
38
 
39
+ /**
40
+ * DownloadL7Logs请求参数结构体
41
+ */
42
+ export interface DownloadL7LogsRequest {
43
+ /**
44
+ * 起始时间(需严格按照RFC3339标准传参)
45
+ */
46
+ StartTime: string
47
+
48
+ /**
49
+ * 结束时间(需严格按照RFC3339标准传参)
50
+ */
51
+ EndTime: string
52
+
53
+ /**
54
+ * 每页展示条数
55
+ */
56
+ PageSize: number
57
+
58
+ /**
59
+ * 当前页
60
+ */
61
+ PageNo: number
62
+
63
+ /**
64
+ * 站点集合
65
+ */
66
+ Zones?: Array<string>
67
+
68
+ /**
69
+ * 域名集合
70
+ */
71
+ Domains?: Array<string>
72
+ }
73
+
39
74
  /**
40
75
  * CreatePurgeTask请求参数结构体
41
76
  */
@@ -55,13 +90,21 @@ export interface CreatePurgeTaskRequest {
55
90
  Type: string
56
91
 
57
92
  /**
58
- * 内容,一行一个
59
- */
93
+ * 要刷新的资源列表,每个元素格式依据Type而定
94
+ 1) Type = purge_host 时
95
+ 形如:www.example.com 或 foo.bar.example.com
96
+ 2) Type = purge_prefix 时
97
+ 形如:http://www.example.com/example
98
+ 3) Type = purge_url 时
99
+ 形如:https://www.example.com/example.jpg
100
+ 4)Type = purge_all 时
101
+ Targets可为空,不需要填写
102
+ */
60
103
  Targets?: Array<string>
61
104
 
62
105
  /**
63
106
  * 若有编码转换,仅清除编码转换后匹配的资源
64
- 若内容含有非 ASCII 字符集的字符,请打开 URL Encode 开关,编码转换(编码规则遵循 RFC3986)
107
+ 若内容含有非 ASCII 字符集的字符,请开启此开关,编码转换(编码规则遵循 RFC3986)
65
108
  */
66
109
  EncodeUrl?: boolean
67
110
  }
@@ -199,6 +242,46 @@ export interface Zone {
199
242
  ModifiedOn: string
200
243
  }
201
244
 
245
+ /**
246
+ * DownloadL7Logs返回参数结构体
247
+ */
248
+ export interface DownloadL7LogsResponse {
249
+ /**
250
+ * 七层离线日志data
251
+ 注意:此字段可能返回 null,表示取不到有效值。
252
+ */
253
+ Data: Array<L7OfflineLog>
254
+
255
+ /**
256
+ * 页面大小
257
+ 注意:此字段可能返回 null,表示取不到有效值。
258
+ */
259
+ PageSize: number
260
+
261
+ /**
262
+ * 页号
263
+ 注意:此字段可能返回 null,表示取不到有效值。
264
+ */
265
+ PageNo: number
266
+
267
+ /**
268
+ * 总页数
269
+ 注意:此字段可能返回 null,表示取不到有效值。
270
+ */
271
+ Pages: number
272
+
273
+ /**
274
+ * 总条数
275
+ 注意:此字段可能返回 null,表示取不到有效值。
276
+ */
277
+ TotalSize: number
278
+
279
+ /**
280
+ * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
281
+ */
282
+ RequestId?: string
283
+ }
284
+
202
285
  /**
203
286
  * DescribePrefetchTasks返回参数结构体
204
287
  */
@@ -285,8 +368,9 @@ export interface FailReason {
285
368
  Reason: string
286
369
 
287
370
  /**
288
- * 失败列表
289
- */
371
+ * 处理失败的资源列表。
372
+ 该列表元素来源于输入参数中的Targets,因此格式和入参中的Targets保持一致
373
+ */
290
374
  Targets: Array<string>
291
375
  }
292
376
 
@@ -335,13 +419,15 @@ export interface CreatePrefetchTaskRequest {
335
419
  ZoneId: string
336
420
 
337
421
  /**
338
- * 预热的资源列表
339
- */
422
+ * 要预热的资源列表,每个元素格式类似如下:
423
+ http://www.example.com/example.txt
424
+ */
340
425
  Targets?: Array<string>
341
426
 
342
427
  /**
343
- * 是否对url进行encode
344
- */
428
+ * 是否对url进行encode
429
+ 若内容含有非 ASCII 字符集的字符,请开启此开关,编码转换(编码规则遵循 RFC3986)
430
+ */
345
431
  EncodeUrl?: boolean
346
432
 
347
433
  /**
@@ -442,3 +528,38 @@ export interface ZoneFilter {
442
528
  */
443
529
  Fuzzy?: boolean
444
530
  }
531
+
532
+ /**
533
+ * 离线日志详细信息
534
+ */
535
+ export interface L7OfflineLog {
536
+ /**
537
+ * 日志打包开始时间
538
+ 注意:此字段可能返回 null,表示取不到有效值。
539
+ */
540
+ LogTime: number
541
+
542
+ /**
543
+ * 站点名称
544
+ 注意:此字段可能返回 null,表示取不到有效值。
545
+ */
546
+ Domain: string
547
+
548
+ /**
549
+ * 原始大小 单位byte
550
+ 注意:此字段可能返回 null,表示取不到有效值。
551
+ */
552
+ Size: number
553
+
554
+ /**
555
+ * 下载地址
556
+ 注意:此字段可能返回 null,表示取不到有效值。
557
+ */
558
+ Url: string
559
+
560
+ /**
561
+ * 日志数据包名
562
+ 注意:此字段可能返回 null,表示取不到有效值。
563
+ */
564
+ LogPacketName: string
565
+ }
@@ -25,6 +25,7 @@ import {
25
25
  SetVideoGenerationTaskCallbackRequest,
26
26
  StreamControl,
27
27
  StopOnlineRecordResponse,
28
+ AuthParam,
28
29
  SetVideoGenerationTaskCallbackKeyRequest,
29
30
  StartWhiteboardPushRequest,
30
31
  OmittedDuration,
@@ -71,14 +72,14 @@ import {
71
72
  DescribeWhiteboardPushCallbackRequest,
72
73
  DescribeOnlineRecordResponse,
73
74
  SetTranscodeCallbackKeyRequest,
74
- DescribeTranscodeRequest,
75
+ CreateSnapshotTaskRequest,
75
76
  DescribeTranscodeResponse,
76
77
  StreamLayout,
77
78
  DescribeQualityMetricsRequest,
78
79
  SetOnlineRecordCallbackKeyRequest,
79
80
  CreateVideoGenerationTaskRequest,
80
81
  DescribeTranscodeCallbackRequest,
81
- CreateSnapshotTaskRequest,
82
+ DescribeTranscodeRequest,
82
83
  DescribeTranscodeCallbackResponse,
83
84
  SetTranscodeCallbackRequest,
84
85
  SetWhiteboardPushCallbackRequest,
@@ -162,6 +162,26 @@ export interface StopOnlineRecordResponse {
162
162
  RequestId?: string
163
163
  }
164
164
 
165
+ /**
166
+ * 鉴权参数
167
+ */
168
+ export interface AuthParam {
169
+ /**
170
+ * 应用SdkAppId
171
+ */
172
+ SdkAppId: number
173
+
174
+ /**
175
+ * 用户ID
176
+ */
177
+ UserId: string
178
+
179
+ /**
180
+ * 用户ID对应的签名
181
+ */
182
+ UserSig: string
183
+ }
184
+
165
185
  /**
166
186
  * SetVideoGenerationTaskCallbackKey请求参数结构体
167
187
  */
@@ -194,8 +214,9 @@ export interface StartWhiteboardPushRequest {
194
214
  RoomId: number
195
215
 
196
216
  /**
197
- * 用于白板推流服务进房进行推流的用户ID,最大长度不能大于60个字节,该ID必须是一个单独的未在SDK中使用的ID,白板推流服务使用这个用户ID进入房间进行白板音视频推流,若该ID和SDK中使用的ID重复,会导致SDK和白板推流服务互踢,影响正常推流。
198
- */
217
+ * 用于白板推流服务进入白板房间的用户ID。在没有进行额外指定的情况下,这个用户ID同时会用于IM登录、IM加群、TRTC进房推流等操作。
218
+ 用户ID最大长度不能大于60个字节,该ID必须是一个单独的未在SDK中使用的ID,白板推流服务使用这个用户ID进入房间进行白板音视频推流,若该ID和SDK中使用的ID重复,会导致SDK和白板推流服务互踢,影响正常推流。
219
+ */
199
220
  PushUserId: string
200
221
 
201
222
  /**
@@ -314,6 +335,26 @@ SdkAppID = 12345678,RoomID = 12345,PushUserID = push_user_1
314
335
  在指定了TRTCRoomIdStr的情况下,会优先使用TRTCRoomIdStr作为白板流进行推流的TRTC房间号。
315
336
  */
316
337
  TRTCRoomIdStr?: string
338
+
339
+ /**
340
+ * 内测参数,需开通白名单进行体验。
341
+
342
+ IM鉴权信息参数,用于IM鉴权。
343
+ 当白板信令所使用的IM应用与白板应用的SdkAppId不一致时,可以通过此参数提供对应IM应用鉴权信息。
344
+
345
+ 如果提供了此参数,白板推流服务会优先使用此参数指定的SdkAppId作为白板信令的传输通道,否则使用公共参数中的SdkAppId作为白板信令的传输通道。
346
+ */
347
+ IMAuthParam?: AuthParam
348
+
349
+ /**
350
+ * 内测参数,需开通白名单进行体验。
351
+
352
+ TRTC鉴权信息参数,用于TRTC进房推流鉴权。
353
+ 当需要推流到的TRTC房间所对应的TRTC应用与白板应用的SdkAppId不一致时,可以通过此参数提供对应的TRTC应用鉴权信息。
354
+
355
+ 如果提供了此参数,白板推流服务会优先使用此参数指定的SdkAppId作为白板推流的目标TRTC应用,否则使用公共参数中的SdkAppId作为白板推流的目标TRTC应用。
356
+ */
357
+ TRTCAuthParam?: AuthParam
317
358
  }
318
359
 
319
360
  /**
@@ -1383,18 +1424,44 @@ export interface SetTranscodeCallbackKeyRequest {
1383
1424
  }
1384
1425
 
1385
1426
  /**
1386
- * DescribeTranscode请求参数结构体
1427
+ * CreateSnapshotTask请求参数结构体
1387
1428
  */
1388
- export interface DescribeTranscodeRequest {
1429
+ export interface CreateSnapshotTaskRequest {
1389
1430
  /**
1390
- * 客户的SdkAppId
1431
+ * 白板相关参数
1432
+ */
1433
+ Whiteboard: SnapshotWhiteboard
1434
+
1435
+ /**
1436
+ * 白板房间 `SdkAppId`
1391
1437
  */
1392
1438
  SdkAppId: number
1393
1439
 
1394
1440
  /**
1395
- * 文档转码任务的唯一标识Id
1441
+ * 白板房间号
1396
1442
  */
1397
- TaskId: string
1443
+ RoomId: number
1444
+
1445
+ /**
1446
+ * 白板板书生成结果通知回调地址
1447
+ */
1448
+ CallbackURL?: string
1449
+
1450
+ /**
1451
+ * 白板板书文件 `COS` 存储参数, 不填默认存储在公共存储桶,公共存储桶的数据仅保存3天
1452
+ */
1453
+ COS?: SnapshotCOS
1454
+
1455
+ /**
1456
+ * 白板板书生成模式,默认为 `AllMarks`。取值说明如下:
1457
+
1458
+ `AllMarks` - 全量模式,即对于客户端每一次调用 `addSnapshotMark` 接口打上的白板板书生成标志全部都会生成对应的白板板书图片。
1459
+
1460
+ `LatestMarksOnly` - 单页去重模式,即对于客户端在同一页白板上多次调用 `addSnapshotMark` 打上的白板板书生成标志仅保留最新一次标志来生成对应白板页的白板板书图片。
1461
+
1462
+ (**注意:`LatestMarksOnly` 模式只有客户端使用v2.6.8及以上版本的白板SDK调用 `addSnapshotMark` 时才生效,否则即使在调用本API是指定了 `LatestMarksOnly` 模式,服务后台会使用默认的 `AllMarks` 模式生成白板板书**)
1463
+ */
1464
+ SnapshotMode?: string
1398
1465
  }
1399
1466
 
1400
1467
  /**
@@ -1614,44 +1681,18 @@ export interface DescribeTranscodeCallbackRequest {
1614
1681
  }
1615
1682
 
1616
1683
  /**
1617
- * CreateSnapshotTask请求参数结构体
1684
+ * DescribeTranscode请求参数结构体
1618
1685
  */
1619
- export interface CreateSnapshotTaskRequest {
1620
- /**
1621
- * 白板相关参数
1622
- */
1623
- Whiteboard: SnapshotWhiteboard
1624
-
1686
+ export interface DescribeTranscodeRequest {
1625
1687
  /**
1626
- * 白板房间 `SdkAppId`
1688
+ * 客户的SdkAppId
1627
1689
  */
1628
1690
  SdkAppId: number
1629
1691
 
1630
1692
  /**
1631
- * 白板房间号
1632
- */
1633
- RoomId: number
1634
-
1635
- /**
1636
- * 白板板书生成结果通知回调地址
1637
- */
1638
- CallbackURL?: string
1639
-
1640
- /**
1641
- * 白板板书文件 `COS` 存储参数, 不填默认存储在公共存储桶,公共存储桶的数据仅保存3天
1693
+ * 文档转码任务的唯一标识Id
1642
1694
  */
1643
- COS?: SnapshotCOS
1644
-
1645
- /**
1646
- * 白板板书生成模式,默认为 `AllMarks`。取值说明如下:
1647
-
1648
- `AllMarks` - 全量模式,即对于客户端每一次调用 `addSnapshotMark` 接口打上的白板板书生成标志全部都会生成对应的白板板书图片。
1649
-
1650
- `LatestMarksOnly` - 单页去重模式,即对于客户端在同一页白板上多次调用 `addSnapshotMark` 打上的白板板书生成标志仅保留最新一次标志来生成对应白板页的白板板书图片。
1651
-
1652
- (**注意:`LatestMarksOnly` 模式只有客户端使用v2.6.8及以上版本的白板SDK调用 `addSnapshotMark` 时才生效,否则即使在调用本API是指定了 `LatestMarksOnly` 模式,服务后台会使用默认的 `AllMarks` 模式生成白板板书**)
1653
- */
1654
- SnapshotMode?: string
1695
+ TaskId: string
1655
1696
  }
1656
1697
 
1657
1698
  /**