tencentcloud-sdk-nodejs 4.0.338 → 4.0.341

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 (109) hide show
  1. package/CHANGELOG.md +399 -0
  2. package/SERVICE_CHANGELOG.md +506 -178
  3. package/package.json +1 -1
  4. package/products.md +22 -20
  5. package/src/common/sdk_version.ts +1 -1
  6. package/src/services/antiddos/v20200309/antiddos_models.ts +5 -0
  7. package/src/services/bi/index.ts +5 -0
  8. package/src/services/bi/v20220105/bi_client.ts +57 -0
  9. package/src/services/bi/v20220105/bi_models.ts +214 -0
  10. package/src/services/bi/v20220105/index.ts +6 -0
  11. package/src/services/ccc/v20200210/ccc_client.ts +1 -1
  12. package/src/services/ccc/v20200210/ccc_models.ts +31 -30
  13. package/src/services/cdc/index.ts +5 -0
  14. package/src/services/cdc/v20201214/cdc_client.ts +286 -0
  15. package/src/services/cdc/v20201214/cdc_models.ts +1651 -0
  16. package/src/services/cdc/v20201214/index.ts +6 -0
  17. package/src/services/ckafka/v20190819/ckafka_client.ts +12 -0
  18. package/src/services/ckafka/v20190819/ckafka_models.ts +40 -0
  19. package/src/services/cvm/v20170312/cvm_models.ts +1 -1
  20. package/src/services/cwp/v20180228/cwp_models.ts +5 -0
  21. package/src/services/emr/v20190103/emr_client.ts +67 -63
  22. package/src/services/emr/v20190103/emr_models.ts +2011 -1833
  23. package/src/services/ess/v20201111/ess_models.ts +26 -8
  24. package/src/services/gaap/v20180529/gaap_client.ts +68 -28
  25. package/src/services/gaap/v20180529/gaap_models.ts +280 -68
  26. package/src/services/index.ts +2 -0
  27. package/src/services/iotexplorer/v20190423/iotexplorer_client.ts +2 -2
  28. package/src/services/lighthouse/v20200324/lighthouse_client.ts +12 -2
  29. package/src/services/monitor/v20180724/monitor_models.ts +5 -0
  30. package/src/services/ocr/v20181119/ocr_client.ts +1 -1
  31. package/src/services/ocr/v20181119/ocr_models.ts +7 -15
  32. package/src/services/redis/v20180412/redis_client.ts +13 -1
  33. package/src/services/redis/v20180412/redis_models.ts +42 -12
  34. package/src/services/ses/v20201002/ses_client.ts +2 -2
  35. package/src/services/ses/v20201002/ses_models.ts +2 -2
  36. package/src/services/tiia/v20190529/tiia_models.ts +2 -2
  37. package/src/services/tiw/v20190919/tiw_client.ts +3 -2
  38. package/src/services/tiw/v20190919/tiw_models.ts +79 -38
  39. package/src/services/trtc/v20190722/trtc_client.ts +215 -142
  40. package/src/services/trtc/v20190722/trtc_models.ts +777 -145
  41. package/src/services/tsf/v20180326/tsf_models.ts +6 -0
  42. package/src/services/vod/v20180717/vod_client.ts +33 -15
  43. package/src/services/vod/v20180717/vod_models.ts +78 -1
  44. package/tencentcloud/common/sdk_version.d.ts +1 -1
  45. package/tencentcloud/common/sdk_version.js +1 -1
  46. package/tencentcloud/services/antiddos/v20200309/antiddos_models.d.ts +4 -0
  47. package/tencentcloud/services/bi/index.d.ts +6 -0
  48. package/tencentcloud/services/bi/index.js +7 -0
  49. package/tencentcloud/services/bi/v20220105/bi_client.d.ts +18 -0
  50. package/tencentcloud/services/bi/v20220105/bi_client.js +43 -0
  51. package/tencentcloud/services/bi/v20220105/bi_models.d.ts +168 -0
  52. package/tencentcloud/services/bi/v20220105/bi_models.js +18 -0
  53. package/tencentcloud/services/bi/v20220105/index.d.ts +6 -0
  54. package/tencentcloud/services/bi/v20220105/index.js +9 -0
  55. package/tencentcloud/services/ccc/v20200210/ccc_client.d.ts +1 -1
  56. package/tencentcloud/services/ccc/v20200210/ccc_client.js +1 -1
  57. package/tencentcloud/services/ccc/v20200210/ccc_models.d.ts +29 -28
  58. package/tencentcloud/services/cdc/index.d.ts +6 -0
  59. package/tencentcloud/services/cdc/index.js +7 -0
  60. package/tencentcloud/services/cdc/v20201214/cdc_client.d.ts +90 -0
  61. package/tencentcloud/services/cdc/v20201214/cdc_client.js +151 -0
  62. package/tencentcloud/services/cdc/v20201214/cdc_models.d.ts +1370 -0
  63. package/tencentcloud/services/cdc/v20201214/cdc_models.js +18 -0
  64. package/tencentcloud/services/cdc/v20201214/index.d.ts +6 -0
  65. package/tencentcloud/services/cdc/v20201214/index.js +9 -0
  66. package/tencentcloud/services/ckafka/v20190819/ckafka_client.d.ts +5 -1
  67. package/tencentcloud/services/ckafka/v20190819/ckafka_client.js +6 -0
  68. package/tencentcloud/services/ckafka/v20190819/ckafka_models.d.ts +34 -0
  69. package/tencentcloud/services/cvm/v20170312/cvm_models.d.ts +1 -1
  70. package/tencentcloud/services/cwp/v20180228/cwp_models.d.ts +4 -0
  71. package/tencentcloud/services/emr/v20190103/emr_client.d.ts +1 -1
  72. package/tencentcloud/services/emr/v20190103/emr_models.d.ts +1757 -1607
  73. package/tencentcloud/services/ess/v20201111/ess_models.d.ts +23 -7
  74. package/tencentcloud/services/gaap/v20180529/gaap_client.d.ts +21 -9
  75. package/tencentcloud/services/gaap/v20180529/gaap_client.js +30 -12
  76. package/tencentcloud/services/gaap/v20180529/gaap_models.d.ts +245 -60
  77. package/tencentcloud/services/index.d.ts +2 -0
  78. package/tencentcloud/services/index.js +4 -0
  79. package/tencentcloud/services/iotexplorer/v20190423/iotexplorer_client.d.ts +2 -2
  80. package/tencentcloud/services/iotexplorer/v20190423/iotexplorer_client.js +2 -2
  81. package/tencentcloud/services/lighthouse/v20200324/lighthouse_client.d.ts +12 -2
  82. package/tencentcloud/services/lighthouse/v20200324/lighthouse_client.js +12 -2
  83. package/tencentcloud/services/monitor/v20180724/monitor_models.d.ts +4 -0
  84. package/tencentcloud/services/ocr/v20181119/ocr_client.d.ts +1 -1
  85. package/tencentcloud/services/ocr/v20181119/ocr_client.js +1 -1
  86. package/tencentcloud/services/ocr/v20181119/ocr_models.d.ts +7 -15
  87. package/tencentcloud/services/redis/v20180412/redis_client.d.ts +5 -1
  88. package/tencentcloud/services/redis/v20180412/redis_client.js +6 -0
  89. package/tencentcloud/services/redis/v20180412/redis_models.d.ts +37 -11
  90. package/tencentcloud/services/ses/v20201002/ses_client.d.ts +2 -2
  91. package/tencentcloud/services/ses/v20201002/ses_client.js +2 -2
  92. package/tencentcloud/services/ses/v20201002/ses_models.d.ts +2 -2
  93. package/tencentcloud/services/tiia/v20190529/tiia_models.d.ts +2 -2
  94. package/tencentcloud/services/tiw/v20190919/tiw_client.d.ts +1 -1
  95. package/tencentcloud/services/tiw/v20190919/tiw_models.d.ts +69 -33
  96. package/tencentcloud/services/trtc/v20190722/trtc_client.d.ts +95 -68
  97. package/tencentcloud/services/trtc/v20190722/trtc_client.js +121 -86
  98. package/tencentcloud/services/trtc/v20190722/trtc_models.d.ts +676 -139
  99. package/tencentcloud/services/tsf/v20180326/tsf_models.d.ts +5 -0
  100. package/tencentcloud/services/vod/v20180717/vod_client.d.ts +14 -6
  101. package/tencentcloud/services/vod/v20180717/vod_client.js +17 -7
  102. package/tencentcloud/services/vod/v20180717/vod_models.d.ts +67 -1
  103. package/test/bi.v20220105.test.js +41 -0
  104. package/test/cdc.v20201214.test.js +221 -0
  105. package/test/ckafka.v20190819.test.js +10 -0
  106. package/test/gaap.v20180529.test.js +44 -14
  107. package/test/redis.v20180412.test.js +10 -0
  108. package/test/trtc.v20190722.test.js +74 -34
  109. package/test/vod.v20180717.test.js +14 -4
@@ -17,6 +17,7 @@ export { asw } from "./asw";
17
17
  export { ba } from "./ba";
18
18
  export { batch } from "./batch";
19
19
  export { bda } from "./bda";
20
+ export { bi } from "./bi";
20
21
  export { billing } from "./billing";
21
22
  export { bizlive } from "./bizlive";
22
23
  export { bm } from "./bm";
@@ -34,6 +35,7 @@ export { cat } from "./cat";
34
35
  export { cbs } from "./cbs";
35
36
  export { ccc } from "./ccc";
36
37
  export { cdb } from "./cdb";
38
+ export { cdc } from "./cdc";
37
39
  export { cdn } from "./cdn";
38
40
  export { cds } from "./cds";
39
41
  export { cfg } from "./cfg";
@@ -38,6 +38,8 @@ var batch_1 = require("./batch");
38
38
  Object.defineProperty(exports, "batch", { enumerable: true, get: function () { return batch_1.batch; } });
39
39
  var bda_1 = require("./bda");
40
40
  Object.defineProperty(exports, "bda", { enumerable: true, get: function () { return bda_1.bda; } });
41
+ var bi_1 = require("./bi");
42
+ Object.defineProperty(exports, "bi", { enumerable: true, get: function () { return bi_1.bi; } });
41
43
  var billing_1 = require("./billing");
42
44
  Object.defineProperty(exports, "billing", { enumerable: true, get: function () { return billing_1.billing; } });
43
45
  var bizlive_1 = require("./bizlive");
@@ -72,6 +74,8 @@ var ccc_1 = require("./ccc");
72
74
  Object.defineProperty(exports, "ccc", { enumerable: true, get: function () { return ccc_1.ccc; } });
73
75
  var cdb_1 = require("./cdb");
74
76
  Object.defineProperty(exports, "cdb", { enumerable: true, get: function () { return cdb_1.cdb; } });
77
+ var cdc_1 = require("./cdc");
78
+ Object.defineProperty(exports, "cdc", { enumerable: true, get: function () { return cdc_1.cdc; } });
75
79
  var cdn_1 = require("./cdn");
76
80
  Object.defineProperty(exports, "cdn", { enumerable: true, get: function () { return cdn_1.cdn; } });
77
81
  var cds_1 = require("./cds");
@@ -8,7 +8,7 @@ import { UpdateDevicesEnableStateResponse, DeleteProjectRequest, DeleteFenceBind
8
8
  export declare class Client extends AbstractClient {
9
9
  constructor(clientConfig: ClientConfig);
10
10
  /**
11
- * 本接口(GetCOSURL)用于获取固件存储在COSURL
11
+ * 本接口(GetCOSURL)用于获取固件COS存储的上传请求URL地址
12
12
  */
13
13
  GetCOSURL(req: GetCOSURLRequest, cb?: (error: string, rep: GetCOSURLResponse) => void): Promise<GetCOSURLResponse>;
14
14
  /**
@@ -212,7 +212,7 @@ export declare class Client extends AbstractClient {
212
212
  */
213
213
  CreateTopicPolicy(req: CreateTopicPolicyRequest, cb?: (error: string, rep: CreateTopicPolicyResponse) => void): Promise<CreateTopicPolicyResponse>;
214
214
  /**
215
- * 本接口(UploadFirmware)用于上传设备固件至平台
215
+ * 本接口(UploadFirmware)用于创建设备固件版本信息,在平台用于固件版本升级、固件资源下发等。
216
216
  */
217
217
  UploadFirmware(req: UploadFirmwareRequest, cb?: (error: string, rep: UploadFirmwareResponse) => void): Promise<UploadFirmwareResponse>;
218
218
  /**
@@ -28,7 +28,7 @@ class Client extends abstract_client_1.AbstractClient {
28
28
  super("iotexplorer.tencentcloudapi.com", "2019-04-23", clientConfig);
29
29
  }
30
30
  /**
31
- * 本接口(GetCOSURL)用于获取固件存储在COSURL
31
+ * 本接口(GetCOSURL)用于获取固件COS存储的上传请求URL地址
32
32
  */
33
33
  async GetCOSURL(req, cb) {
34
34
  return this.request("GetCOSURL", req, cb);
@@ -334,7 +334,7 @@ class Client extends abstract_client_1.AbstractClient {
334
334
  return this.request("CreateTopicPolicy", req, cb);
335
335
  }
336
336
  /**
337
- * 本接口(UploadFirmware)用于上传设备固件至平台
337
+ * 本接口(UploadFirmware)用于创建设备固件版本信息,在平台用于固件版本升级、固件资源下发等。
338
338
  */
339
339
  async UploadFirmware(req, cb) {
340
340
  return this.request("UploadFirmware", req, cb);
@@ -315,12 +315,22 @@ export declare class Client extends AbstractClient {
315
315
  */
316
316
  RenewInstances(req: RenewInstancesRequest, cb?: (error: string, rep: RenewInstancesResponse) => void): Promise<RenewInstancesResponse>;
317
317
  /**
318
- * 本接口(DescribeInstanceVncUrl)用于查询实例管理终端地址,获取的地址可用于实例的 VNC 登录。
318
+ * 本接口 ( DescribeInstanceVncUrl ) 用于查询实例管理终端地址,获取的地址可用于实例的 VNC 登录。
319
319
 
320
- * 处于 RUNNING 状态的机器可使用此功能。
320
+ * 处于 `STOPPED` 状态的机器无法使用此功能。
321
321
  * 管理终端地址的有效期为 15 秒,调用接口成功后如果 15 秒内不使用该链接进行访问,管理终端地址自动失效,您需要重新查询。
322
322
  * 管理终端地址一旦被访问,将自动失效,您需要重新查询。
323
323
  * 如果连接断开,每分钟内重新连接的次数不能超过 30 次。
324
+ 获取到 `InstanceVncUrl` 后,您需要在链接 `https://img.qcloud.com/qcloud/app/active_vnc/index.html?` 末尾加上参数 `InstanceVncUrl=xxxx`。
325
+
326
+ - 参数 `InstanceVncUrl` :调用接口成功后会返回的 `InstanceVncUrl` 的值。
327
+
328
+ 最后组成的 URL 格式如下:
329
+
330
+ ```
331
+ https://img.qcloud.com/qcloud/app/active_vnc/index.html?InstanceVncUrl=wss%3A%2F%2Fbjvnc.qcloud.com%3A26789%2Fvnc%3Fs%3DaHpjWnRVMFNhYmxKdDM5MjRHNlVTSVQwajNUSW0wb2tBbmFtREFCTmFrcy8vUUNPMG0wSHZNOUUxRm5PMmUzWmFDcWlOdDJIbUJxSTZDL0RXcHZxYnZZMmRkWWZWcEZia2lyb09XMzdKNmM9
332
+ ```
333
+
324
334
  */
325
335
  DescribeInstanceVncUrl(req: DescribeInstanceVncUrlRequest, cb?: (error: string, rep: DescribeInstanceVncUrlResponse) => void): Promise<DescribeInstanceVncUrlResponse>;
326
336
  /**
@@ -441,12 +441,22 @@ class Client extends abstract_client_1.AbstractClient {
441
441
  return this.request("RenewInstances", req, cb);
442
442
  }
443
443
  /**
444
- * 本接口(DescribeInstanceVncUrl)用于查询实例管理终端地址,获取的地址可用于实例的 VNC 登录。
444
+ * 本接口 ( DescribeInstanceVncUrl ) 用于查询实例管理终端地址,获取的地址可用于实例的 VNC 登录。
445
445
 
446
- * 处于 RUNNING 状态的机器可使用此功能。
446
+ * 处于 `STOPPED` 状态的机器无法使用此功能。
447
447
  * 管理终端地址的有效期为 15 秒,调用接口成功后如果 15 秒内不使用该链接进行访问,管理终端地址自动失效,您需要重新查询。
448
448
  * 管理终端地址一旦被访问,将自动失效,您需要重新查询。
449
449
  * 如果连接断开,每分钟内重新连接的次数不能超过 30 次。
450
+ 获取到 `InstanceVncUrl` 后,您需要在链接 `https://img.qcloud.com/qcloud/app/active_vnc/index.html?` 末尾加上参数 `InstanceVncUrl=xxxx`。
451
+
452
+ - 参数 `InstanceVncUrl` :调用接口成功后会返回的 `InstanceVncUrl` 的值。
453
+
454
+ 最后组成的 URL 格式如下:
455
+
456
+ ```
457
+ https://img.qcloud.com/qcloud/app/active_vnc/index.html?InstanceVncUrl=wss%3A%2F%2Fbjvnc.qcloud.com%3A26789%2Fvnc%3Fs%3DaHpjWnRVMFNhYmxKdDM5MjRHNlVTSVQwajNUSW0wb2tBbmFtREFCTmFrcy8vUUNPMG0wSHZNOUUxRm5PMmUzWmFDcWlOdDJIbUJxSTZDL0RXcHZxYnZZMmRkWWZWcEZia2lyb09XMzdKNmM9
458
+ ```
459
+
450
460
  */
451
461
  async DescribeInstanceVncUrl(req, cb) {
452
462
  return this.request("DescribeInstanceVncUrl", req, cb);
@@ -3581,6 +3581,10 @@ export interface DescribeAlarmPoliciesRequest {
3581
3581
  * 按照触发任务(例如弹性伸缩)过滤策略。最多10个
3582
3582
  */
3583
3583
  TriggerTasks?: Array<AlarmPolicyTriggerTask>;
3584
+ /**
3585
+ * 根据一键告警策略筛选 不传展示全部策略 ONECLICK=展示一键告警策略 NOT_ONECLICK=展示非一键告警策略
3586
+ */
3587
+ OneClickPolicyType?: Array<string>;
3584
3588
  }
3585
3589
  /**
3586
3590
  * DescribeConditionsTemplateList返回参数结构体
@@ -550,7 +550,7 @@ export declare class Client extends AbstractClient {
550
550
  */
551
551
  MixedInvoiceOCR(req: MixedInvoiceOCRRequest, cb?: (error: string, rep: MixedInvoiceOCRResponse) => void): Promise<MixedInvoiceOCRResponse>;
552
552
  /**
553
- * 本接口支持深圳粤康码、广州穗康码、上海随申码、北京健康宝的识别,包括持码人姓名、持码人身份证号、健康码更新时间、健康码颜色、核酸检测结果、核酸检测间隔时长、核酸检测时间,七个字段的识别结果输出。不同省市健康码显示的字段信息有所不同,上述字段的识别结果可能为空,以图片上具体展示的信息为准。
553
+ * 本接口支持北京、上海、广东、江苏、吉林、黑龙江省市健康码的识别,包括持码人姓名、持码人身份证号、健康码更新时间、健康码颜色、核酸检测结果、核酸检测间隔时长、核酸检测时间,七个字段的识别结果输出。不同省市健康码显示的字段信息有所不同,上述字段的识别结果可能为空,以图片上具体展示的信息为准。
554
554
  */
555
555
  RecognizeHealthCodeOCR(req: RecognizeHealthCodeOCRRequest, cb?: (error: string, rep: RecognizeHealthCodeOCRResponse) => void): Promise<RecognizeHealthCodeOCRResponse>;
556
556
  /**
@@ -704,7 +704,7 @@ class Client extends abstract_client_1.AbstractClient {
704
704
  return this.request("MixedInvoiceOCR", req, cb);
705
705
  }
706
706
  /**
707
- * 本接口支持深圳粤康码、广州穗康码、上海随申码、北京健康宝的识别,包括持码人姓名、持码人身份证号、健康码更新时间、健康码颜色、核酸检测结果、核酸检测间隔时长、核酸检测时间,七个字段的识别结果输出。不同省市健康码显示的字段信息有所不同,上述字段的识别结果可能为空,以图片上具体展示的信息为准。
707
+ * 本接口支持北京、上海、广东、江苏、吉林、黑龙江省市健康码的识别,包括持码人姓名、持码人身份证号、健康码更新时间、健康码颜色、核酸检测结果、核酸检测间隔时长、核酸检测时间,七个字段的识别结果输出。不同省市健康码显示的字段信息有所不同,上述字段的识别结果可能为空,以图片上具体展示的信息为准。
708
708
  */
709
709
  async RecognizeHealthCodeOCR(req, cb) {
710
710
  return this.request("RecognizeHealthCodeOCR", req, cb);
@@ -3876,14 +3876,6 @@ export interface RecognizeHealthCodeOCRRequest {
3876
3876
  /**
3877
3877
  * 需要识别的健康码类型列表,为空或不填表示默认为自动识别。
3878
3878
  0:自动识别
3879
-
3880
- 1:粤康码
3881
-
3882
- 2:随申码
3883
-
3884
- 3:健康宝
3885
-
3886
- 4.穗康码
3887
3879
  */
3888
3880
  Type?: number;
3889
3881
  }
@@ -4069,31 +4061,31 @@ export interface DutyPaidProofOCRRequest {
4069
4061
  */
4070
4062
  export interface RecognizeHealthCodeOCRResponse {
4071
4063
  /**
4072
- * 持码人姓名,如:王*
4064
+ * 持码人姓名,如:王*(允许返回空值)
4073
4065
  */
4074
4066
  Name: string;
4075
4067
  /**
4076
- * 持码人身份证号,如:11**************01
4068
+ * 持码人身份证号,如:11**************01(允许返回空值)
4077
4069
  */
4078
4070
  IDNumber: string;
4079
4071
  /**
4080
- * 健康码更新时间
4072
+ * 健康码更新时间(允许返回空值)
4081
4073
  */
4082
4074
  Time: string;
4083
4075
  /**
4084
- * 健康码颜色:绿色、黄色、红色
4076
+ * 健康码颜色:绿色、黄色、红色(允许返回空值)
4085
4077
  */
4086
4078
  Color: string;
4087
4079
  /**
4088
- * 核酸检测间隔时长:24小时、48小时、72小时、暂无核酸检测记录
4080
+ * 核酸检测间隔时长(允许返回空值)
4089
4081
  */
4090
4082
  TestingInterval: string;
4091
4083
  /**
4092
- * 核酸检测结果:阴性、阳性、暂无核酸检测记录
4084
+ * 核酸检测结果:阴性、阳性、暂无核酸检测记录(允许返回空值)
4093
4085
  */
4094
4086
  TestingResult: string;
4095
4087
  /**
4096
- * 核酸检测时间
4088
+ * 核酸检测时间(允许返回空值)
4097
4089
  */
4098
4090
  TestingTime: string;
4099
4091
  /**
@@ -1,6 +1,6 @@
1
1
  import { AbstractClient } from "../../../common/abstract_client";
2
2
  import { ClientConfig } from "../../../common/interface";
3
- import { ModifyInstanceParamsResponse, EnableReplicaReadonlyRequest, DescribeInstanceMonitorTopNCmdResponse, ModifyAutoBackupConfigResponse, RestoreInstanceRequest, AllocateWanAddressRequest, ApplyParamsTemplateRequest, UpgradeInstanceVersionResponse, CreateInstancesRequest, CreateReplicationGroupRequest, DescribeInstanceZoneInfoRequest, ModifyNetworkConfigResponse, DescribeInstanceMonitorBigKeyResponse, AssociateSecurityGroupsRequest, DescribeTaskListResponse, ModifyInstanceRequest, KillMasterGroupResponse, RenewInstanceResponse, DescribeSlowLogResponse, DescribeCommonDBInstancesRequest, DescribeDBSecurityGroupsResponse, RestoreInstanceResponse, DescribeBackupUrlRequest, DeleteParamTemplateResponse, DescribeInstancesResponse, DescribeInstanceZoneInfoResponse, ResetPasswordResponse, ClearInstanceRequest, DescribeParamTemplatesRequest, RenewInstanceRequest, UpgradeVersionToMultiAvailabilityZonesResponse, DescribeInstanceParamRecordsResponse, ModifyAutoBackupConfigRequest, DescribeInstanceDealDetailRequest, DescribeProjectSecurityGroupRequest, DescribeInstanceShardsResponse, DestroyPrepaidInstanceRequest, ManualBackupInstanceResponse, DisableReplicaReadonlyResponse, CreateParamTemplateResponse, DescribeInstanceDTSInfoResponse, AddReplicationInstanceResponse, DestroyPostpaidInstanceResponse, SwitchInstanceVipRequest, ChangeReplicaToMasterRequest, ModifyInstanceResponse, ModifyDBInstanceSecurityGroupsResponse, DescribeInstanceMonitorHotKeyRequest, DescribeInstanceDTSInfoRequest, CreateParamTemplateRequest, DescribeTendisSlowLogResponse, DescribeProductInfoResponse, ModifyInstanceAccountRequest, ModifyMaintenanceWindowRequest, DescribeParamTemplateInfoRequest, DescribeBackupUrlResponse, InquiryPriceRenewInstanceResponse, DescribeDBSecurityGroupsRequest, InquiryPriceCreateInstanceResponse, ResetPasswordRequest, ModifyInstanceAccountResponse, DescribeProjectSecurityGroupsResponse, DescribeInstanceMonitorTookDistResponse, DescribeInstanceBackupsResponse, UpgradeVersionToMultiAvailabilityZonesRequest, AllocateWanAddressResponse, DescribeInstanceMonitorTookDistRequest, DeleteReplicationInstanceRequest, KillMasterGroupRequest, DescribeInstanceMonitorTopNCmdTookResponse, DescribeInstanceMonitorBigKeySizeDistRequest, DescribeInstanceAccountRequest, DescribeInstanceParamRecordsRequest, DescribeTaskListRequest, ChangeReplicaToMasterResponse, CreateInstancesResponse, DescribeTaskInfoRequest, ApplyParamsTemplateResponse, DescribeReplicationGroupRequest, DescribeInstanceMonitorTopNCmdRequest, ModifyNetworkConfigRequest, DescribeInstanceSecurityGroupRequest, DescribeInstanceParamsRequest, CleanUpInstanceResponse, ModifyDBInstanceSecurityGroupsRequest, DescribeParamTemplatesResponse, DescribeInstanceShardsRequest, DescribeAutoBackupConfigResponse, InquiryPriceUpgradeInstanceRequest, ModifyParamTemplateResponse, DescribeProjectSecurityGroupsRequest, DescribeInstanceMonitorBigKeySizeDistResponse, CreateInstanceAccountRequest, EnableReplicaReadonlyResponse, DescribeMaintenanceWindowResponse, DescribeInstanceSecurityGroupResponse, ReleaseWanAddressResponse, ModifyConnectionConfigRequest, StartupInstanceResponse, AssociateSecurityGroupsResponse, DescribeTaskInfoResponse, DescribeInstanceMonitorBigKeyTypeDistResponse, DeleteReplicationInstanceResponse, CleanUpInstanceRequest, DescribeInstanceDealDetailResponse, DescribeInstancesRequest, ModfiyInstancePasswordRequest, DescribeSlowLogRequest, DeleteParamTemplateRequest, DescribeAutoBackupConfigRequest, DescribeInstanceMonitorSIPResponse, DestroyPostpaidInstanceRequest, DeleteInstanceAccountRequest, UpgradeInstanceResponse, ManualBackupInstanceRequest, DescribeReplicationGroupResponse, ModifyParamTemplateRequest, ModfiyInstancePasswordResponse, ReleaseWanAddressRequest, InquiryPriceRenewInstanceRequest, ModifyConnectionConfigResponse, ModifyMaintenanceWindowResponse, CreateReplicationGroupResponse, DescribeInstanceMonitorBigKeyTypeDistRequest, DescribeInstanceMonitorTopNCmdTookRequest, DestroyPrepaidInstanceResponse, DescribeCommonDBInstancesResponse, InquiryPriceCreateInstanceRequest, ModifyInstanceParamsRequest, DescribeInstanceNodeInfoRequest, DescribeMaintenanceWindowRequest, AddReplicationInstanceRequest, DescribeTendisSlowLogRequest, DescribeProxySlowLogRequest, DescribeProxySlowLogResponse, UpgradeInstanceVersionRequest, DescribeInstanceAccountResponse, DescribeInstanceMonitorBigKeyRequest, DisableReplicaReadonlyRequest, DescribeParamTemplateInfoResponse, DescribeProductInfoRequest, SwitchInstanceVipResponse, DescribeInstanceParamsResponse, DisassociateSecurityGroupsRequest, StartupInstanceRequest, CreateInstanceAccountResponse, DescribeInstanceBackupsRequest, InquiryPriceUpgradeInstanceResponse, DeleteInstanceAccountResponse, DescribeInstanceMonitorSIPRequest, UpgradeInstanceRequest, DescribeInstanceNodeInfoResponse, DescribeProjectSecurityGroupResponse, DescribeInstanceMonitorHotKeyResponse, DisassociateSecurityGroupsResponse, ClearInstanceResponse } from "./redis_models";
3
+ import { ModifyInstanceParamsResponse, EnableReplicaReadonlyRequest, DescribeInstanceMonitorTopNCmdResponse, ModifyAutoBackupConfigResponse, RestoreInstanceRequest, AllocateWanAddressRequest, ApplyParamsTemplateRequest, UpgradeInstanceVersionResponse, CreateInstancesRequest, CreateReplicationGroupRequest, ModifyInstanceReadOnlyResponse, DescribeInstanceZoneInfoRequest, ModifyNetworkConfigResponse, DescribeInstanceMonitorBigKeyResponse, AssociateSecurityGroupsRequest, DescribeTaskListResponse, ModifyInstanceRequest, KillMasterGroupResponse, RenewInstanceResponse, DescribeSlowLogResponse, DescribeCommonDBInstancesRequest, DescribeDBSecurityGroupsResponse, RestoreInstanceResponse, DescribeBackupUrlRequest, DeleteParamTemplateResponse, DescribeInstancesResponse, DescribeInstanceZoneInfoResponse, ResetPasswordResponse, ClearInstanceRequest, UpgradeInstanceVersionRequest, DescribeParamTemplatesRequest, RenewInstanceRequest, UpgradeVersionToMultiAvailabilityZonesResponse, DescribeInstanceParamRecordsResponse, ModifyAutoBackupConfigRequest, DescribeInstanceDealDetailRequest, DescribeProjectSecurityGroupRequest, DescribeInstanceShardsResponse, DestroyPrepaidInstanceRequest, ManualBackupInstanceResponse, DisableReplicaReadonlyResponse, CreateParamTemplateResponse, DescribeInstanceDTSInfoResponse, AddReplicationInstanceResponse, DestroyPostpaidInstanceResponse, SwitchInstanceVipRequest, ChangeReplicaToMasterRequest, ModifyInstanceResponse, ModifyDBInstanceSecurityGroupsResponse, DescribeInstanceMonitorHotKeyRequest, DescribeInstanceDTSInfoRequest, CreateParamTemplateRequest, DescribeTendisSlowLogResponse, DescribeProductInfoResponse, ModifyInstanceAccountRequest, ModifyMaintenanceWindowRequest, DescribeParamTemplateInfoRequest, DescribeBackupUrlResponse, InquiryPriceRenewInstanceResponse, DescribeDBSecurityGroupsRequest, InquiryPriceCreateInstanceResponse, ResetPasswordRequest, ModifyInstanceAccountResponse, DescribeProjectSecurityGroupsResponse, DescribeInstanceMonitorTookDistResponse, DescribeInstanceBackupsResponse, UpgradeVersionToMultiAvailabilityZonesRequest, AllocateWanAddressResponse, DescribeInstanceMonitorTookDistRequest, DeleteReplicationInstanceRequest, KillMasterGroupRequest, DescribeInstanceMonitorTopNCmdTookResponse, DescribeInstanceMonitorBigKeySizeDistRequest, DescribeInstanceAccountRequest, DescribeInstanceParamRecordsRequest, DescribeTaskListRequest, ChangeReplicaToMasterResponse, CreateInstancesResponse, DescribeTaskInfoRequest, ApplyParamsTemplateResponse, DescribeReplicationGroupRequest, DescribeInstanceMonitorTopNCmdRequest, ModifyNetworkConfigRequest, DescribeInstanceSecurityGroupRequest, DescribeInstanceParamsRequest, CleanUpInstanceResponse, ModifyDBInstanceSecurityGroupsRequest, DescribeParamTemplatesResponse, DescribeInstanceShardsRequest, DescribeAutoBackupConfigResponse, InquiryPriceUpgradeInstanceRequest, ModifyParamTemplateResponse, DescribeProjectSecurityGroupsRequest, DescribeInstanceMonitorBigKeySizeDistResponse, CreateInstanceAccountRequest, EnableReplicaReadonlyResponse, DescribeMaintenanceWindowResponse, DescribeInstanceSecurityGroupResponse, ReleaseWanAddressResponse, ModifyConnectionConfigRequest, StartupInstanceResponse, AssociateSecurityGroupsResponse, DescribeTaskInfoResponse, DescribeInstanceMonitorBigKeyTypeDistResponse, DeleteReplicationInstanceResponse, CleanUpInstanceRequest, DescribeInstanceDealDetailResponse, DescribeInstancesRequest, ModfiyInstancePasswordRequest, DescribeSlowLogRequest, DeleteParamTemplateRequest, DescribeAutoBackupConfigRequest, DescribeInstanceMonitorSIPResponse, DestroyPostpaidInstanceRequest, DeleteInstanceAccountRequest, UpgradeInstanceResponse, ManualBackupInstanceRequest, DescribeReplicationGroupResponse, ModifyParamTemplateRequest, ModfiyInstancePasswordResponse, ReleaseWanAddressRequest, InquiryPriceRenewInstanceRequest, ModifyConnectionConfigResponse, ModifyMaintenanceWindowResponse, CreateReplicationGroupResponse, DescribeInstanceMonitorBigKeyTypeDistRequest, DescribeInstanceMonitorTopNCmdTookRequest, DestroyPrepaidInstanceResponse, DescribeCommonDBInstancesResponse, InquiryPriceCreateInstanceRequest, ModifyInstanceParamsRequest, DescribeInstanceNodeInfoRequest, DescribeMaintenanceWindowRequest, AddReplicationInstanceRequest, DescribeTendisSlowLogRequest, DescribeProxySlowLogRequest, DescribeProxySlowLogResponse, ModifyInstanceReadOnlyRequest, DescribeInstanceAccountResponse, DescribeInstanceMonitorBigKeyRequest, DisableReplicaReadonlyRequest, DescribeParamTemplateInfoResponse, DescribeProductInfoRequest, SwitchInstanceVipResponse, DescribeInstanceParamsResponse, DisassociateSecurityGroupsRequest, StartupInstanceRequest, CreateInstanceAccountResponse, DescribeInstanceBackupsRequest, InquiryPriceUpgradeInstanceResponse, DeleteInstanceAccountResponse, DescribeInstanceMonitorSIPRequest, UpgradeInstanceRequest, DescribeInstanceNodeInfoResponse, DescribeProjectSecurityGroupResponse, DescribeInstanceMonitorHotKeyResponse, DisassociateSecurityGroupsResponse, ClearInstanceResponse } from "./redis_models";
4
4
  /**
5
5
  * redis client
6
6
  * @class
@@ -19,6 +19,10 @@ export declare class Client extends AbstractClient {
19
19
  * 查询实例节点信息
20
20
  */
21
21
  DescribeInstanceNodeInfo(req: DescribeInstanceNodeInfoRequest, cb?: (error: string, rep: DescribeInstanceNodeInfoResponse) => void): Promise<DescribeInstanceNodeInfoResponse>;
22
+ /**
23
+ * 设置实例输入模式
24
+ */
25
+ ModifyInstanceReadOnly(req: ModifyInstanceReadOnlyRequest, cb?: (error: string, rep: ModifyInstanceReadOnlyResponse) => void): Promise<ModifyInstanceReadOnlyResponse>;
22
26
  /**
23
27
  * 查询实例大Key大小分布
24
28
  */
@@ -45,6 +45,12 @@ class Client extends abstract_client_1.AbstractClient {
45
45
  async DescribeInstanceNodeInfo(req, cb) {
46
46
  return this.request("DescribeInstanceNodeInfo", req, cb);
47
47
  }
48
+ /**
49
+ * 设置实例输入模式
50
+ */
51
+ async ModifyInstanceReadOnly(req, cb) {
52
+ return this.request("ModifyInstanceReadOnly", req, cb);
53
+ }
48
54
  /**
49
55
  * 查询实例大Key大小分布
50
56
  */
@@ -275,6 +275,19 @@ export interface CreateReplicationGroupRequest {
275
275
  */
276
276
  Remark?: string;
277
277
  }
278
+ /**
279
+ * ModifyInstanceReadOnly返回参数结构体
280
+ */
281
+ export interface ModifyInstanceReadOnlyResponse {
282
+ /**
283
+ * 任务ID
284
+ */
285
+ TaskId: number;
286
+ /**
287
+ * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
288
+ */
289
+ RequestId?: string;
290
+ }
278
291
  /**
279
292
  * DescribeInstanceZoneInfo请求参数结构体
280
293
  */
@@ -761,6 +774,23 @@ export interface ClearInstanceRequest {
761
774
  */
762
775
  Password?: string;
763
776
  }
777
+ /**
778
+ * UpgradeInstanceVersion请求参数结构体
779
+ */
780
+ export interface UpgradeInstanceVersionRequest {
781
+ /**
782
+ * 目标实例类型,同 [CreateInstances](https://cloud.tencent.com/document/api/239/20026) 的Type,即实例要变更的目标类型
783
+ */
784
+ TargetInstanceType: string;
785
+ /**
786
+ * 切换模式:1-维护时间窗切换,2-立即切换
787
+ */
788
+ SwitchOption: number;
789
+ /**
790
+ * 实例ID
791
+ */
792
+ InstanceId: string;
793
+ }
764
794
  /**
765
795
  * 地域信息
766
796
  */
@@ -3149,7 +3179,7 @@ export interface ModfiyInstancePasswordResponse {
3149
3179
  /**
3150
3180
  * 任务ID
3151
3181
  */
3152
- TaskId?: number;
3182
+ TaskId: number;
3153
3183
  /**
3154
3184
  * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
3155
3185
  */
@@ -3766,21 +3796,17 @@ export interface DescribeProxySlowLogResponse {
3766
3796
  RequestId?: string;
3767
3797
  }
3768
3798
  /**
3769
- * UpgradeInstanceVersion请求参数结构体
3799
+ * ModifyInstanceReadOnly请求参数结构体
3770
3800
  */
3771
- export interface UpgradeInstanceVersionRequest {
3772
- /**
3773
- * 目标实例类型,同 [CreateInstances](https://cloud.tencent.com/document/api/239/20026) 的Type,即实例要变更的目标类型
3774
- */
3775
- TargetInstanceType: string;
3776
- /**
3777
- * 切换模式:1-维护时间窗切换,2-立即切换
3778
- */
3779
- SwitchOption: number;
3801
+ export interface ModifyInstanceReadOnlyRequest {
3780
3802
  /**
3781
3803
  * 实例ID
3782
3804
  */
3783
3805
  InstanceId: string;
3806
+ /**
3807
+ * 实例输入模式,0:读写 1:只读
3808
+ */
3809
+ InputMode: string;
3784
3810
  }
3785
3811
  /**
3786
3812
  * DescribeInstanceAccount返回参数结构体
@@ -66,7 +66,7 @@ export declare class Client extends AbstractClient {
66
66
  */
67
67
  CreateEmailTemplate(req: CreateEmailTemplateRequest, cb?: (error: string, rep: CreateEmailTemplateResponse) => void): Promise<CreateEmailTemplateResponse>;
68
68
  /**
69
- * 您可以通过此API批量发送TEXT或者HTML邮件,适用于营销类、通知类邮件。默认仅支持使用模板发送邮件,如需发送自定义内容,请单独联系商务开通此功能。批量发送之前,需先创建收件人列表,和收件人地址,并通过收件人列表id来进行发送。批量发送任务支持定时发送和周期重复发送,定时发送需传TimedParam,周期重复发送需传CycleParam
69
+ * 您可以通过此API批量发送TEXT或者HTML邮件,适用于营销类、通知类邮件。默认仅支持使用模板发送邮件。批量发送之前,需先创建收件人列表,和收件人地址,并通过收件人列表id来进行发送。批量发送任务支持定时发送和周期重复发送,定时发送需传TimedParam,周期重复发送需传CycleParam
70
70
  */
71
71
  BatchSendEmail(req: BatchSendEmailRequest, cb?: (error: string, rep: BatchSendEmailResponse) => void): Promise<BatchSendEmailResponse>;
72
72
  /**
@@ -90,7 +90,7 @@ export declare class Client extends AbstractClient {
90
90
  */
91
91
  DeleteBlackList(req: DeleteBlackListRequest, cb?: (error: string, rep: DeleteBlackListResponse) => void): Promise<DeleteBlackListResponse>;
92
92
  /**
93
- * 您可以通过此API发送TEXT或者HTML邮件,适用于触发类邮件(验证码、交易类)。默认仅支持使用模板发送邮件,如需发送自定义内容,请单独联系商务开通此功能。
93
+ * 您可以通过此API发送TEXT或者HTML邮件,适用于触发类邮件(验证码、交易类)。默认仅支持使用模板发送邮件。
94
94
  */
95
95
  SendEmail(req: SendEmailRequest, cb?: (error: string, rep: SendEmailResponse) => void): Promise<SendEmailResponse>;
96
96
  /**
@@ -114,7 +114,7 @@ class Client extends abstract_client_1.AbstractClient {
114
114
  return this.request("CreateEmailTemplate", req, cb);
115
115
  }
116
116
  /**
117
- * 您可以通过此API批量发送TEXT或者HTML邮件,适用于营销类、通知类邮件。默认仅支持使用模板发送邮件,如需发送自定义内容,请单独联系商务开通此功能。批量发送之前,需先创建收件人列表,和收件人地址,并通过收件人列表id来进行发送。批量发送任务支持定时发送和周期重复发送,定时发送需传TimedParam,周期重复发送需传CycleParam
117
+ * 您可以通过此API批量发送TEXT或者HTML邮件,适用于营销类、通知类邮件。默认仅支持使用模板发送邮件。批量发送之前,需先创建收件人列表,和收件人地址,并通过收件人列表id来进行发送。批量发送任务支持定时发送和周期重复发送,定时发送需传TimedParam,周期重复发送需传CycleParam
118
118
  */
119
119
  async BatchSendEmail(req, cb) {
120
120
  return this.request("BatchSendEmail", req, cb);
@@ -150,7 +150,7 @@ class Client extends abstract_client_1.AbstractClient {
150
150
  return this.request("DeleteBlackList", req, cb);
151
151
  }
152
152
  /**
153
- * 您可以通过此API发送TEXT或者HTML邮件,适用于触发类邮件(验证码、交易类)。默认仅支持使用模板发送邮件,如需发送自定义内容,请单独联系商务开通此功能。
153
+ * 您可以通过此API发送TEXT或者HTML邮件,适用于触发类邮件(验证码、交易类)。默认仅支持使用模板发送邮件。
154
154
  */
155
155
  async SendEmail(req, cb) {
156
156
  return this.request("SendEmail", req, cb);
@@ -29,7 +29,7 @@ export interface BatchSendEmailRequest {
29
29
  */
30
30
  Template?: Template;
31
31
  /**
32
- * 使用API直接发送内容时,填写的邮件内容(暂未支持)
32
+ * 已废弃
33
33
  */
34
34
  Simple?: Simple;
35
35
  /**
@@ -287,7 +287,7 @@ export interface SendEmailRequest {
287
287
  */
288
288
  Template?: Template;
289
289
  /**
290
- * 使用API直接发送内容时,填写的邮件内容
290
+ * 已废弃
291
291
  */
292
292
  Simple?: Simple;
293
293
  /**
@@ -510,7 +510,7 @@ export interface CreateGroupRequest {
510
510
  */
511
511
  GroupName: string;
512
512
  /**
513
- * 该库的容量限制。
513
+ * 图库可容纳的最大图片数量。
514
514
  */
515
515
  MaxCapacity: number;
516
516
  /**
@@ -518,7 +518,7 @@ export interface CreateGroupRequest {
518
518
  */
519
519
  Brief?: string;
520
520
  /**
521
- * 该库的访问限频 ,默认10。
521
+ * 访问限制默认为10qps,如需扩容请联系[在线客服](https://cloud.tencent.com/online-service)申请。
522
522
  */
523
523
  MaxQps?: number;
524
524
  /**
@@ -1,6 +1,6 @@
1
1
  import { AbstractClient } from "../../../common/abstract_client";
2
2
  import { ClientConfig } from "../../../common/interface";
3
- import { SetWhiteboardPushCallbackKeyRequest, SetVideoGenerationTaskCallbackRequest, StopOnlineRecordResponse, SetVideoGenerationTaskCallbackKeyRequest, StartWhiteboardPushRequest, DescribeWhiteboardPushRequest, DescribeQualityMetricsResponse, ResumeOnlineRecordResponse, SetVideoGenerationTaskCallbackResponse, SetWhiteboardPushCallbackKeyResponse, DescribeSnapshotTaskRequest, StartOnlineRecordRequest, DescribeVideoGenerationTaskCallbackResponse, DescribeSnapshotTaskResponse, StartWhiteboardPushResponse, ResumeOnlineRecordRequest, DescribeOnlineRecordCallbackRequest, DescribeOnlineRecordCallbackResponse, StopWhiteboardPushRequest, SetTranscodeCallbackResponse, StopOnlineRecordRequest, SetVideoGenerationTaskCallbackKeyResponse, CreateTranscodeResponse, CreateSnapshotTaskResponse, DescribeVideoGenerationTaskResponse, DescribeWhiteboardPushCallbackResponse, SetTranscodeCallbackKeyResponse, DescribeTIWDailyUsageResponse, DescribeOnlineRecordRequest, DescribeWhiteboardPushResponse, StartOnlineRecordResponse, SetOnlineRecordCallbackKeyResponse, DescribeVideoGenerationTaskRequest, CreateVideoGenerationTaskResponse, PauseOnlineRecordResponse, CreateTranscodeRequest, DescribeWhiteboardPushCallbackRequest, DescribeOnlineRecordResponse, SetTranscodeCallbackKeyRequest, DescribeTranscodeRequest, DescribeTranscodeResponse, DescribeQualityMetricsRequest, SetOnlineRecordCallbackKeyRequest, CreateVideoGenerationTaskRequest, DescribeTranscodeCallbackRequest, CreateSnapshotTaskRequest, DescribeTranscodeCallbackResponse, SetTranscodeCallbackRequest, SetWhiteboardPushCallbackRequest, SetWhiteboardPushCallbackResponse, DescribeTIWDailyUsageRequest, DescribeVideoGenerationTaskCallbackRequest, SetOnlineRecordCallbackRequest, PauseOnlineRecordRequest, StopWhiteboardPushResponse, SetOnlineRecordCallbackResponse } from "./tiw_models";
3
+ import { SetWhiteboardPushCallbackKeyRequest, SetVideoGenerationTaskCallbackRequest, StopOnlineRecordResponse, SetVideoGenerationTaskCallbackKeyRequest, StartWhiteboardPushRequest, DescribeWhiteboardPushRequest, DescribeQualityMetricsResponse, ResumeOnlineRecordResponse, SetVideoGenerationTaskCallbackResponse, SetWhiteboardPushCallbackKeyResponse, DescribeSnapshotTaskRequest, StartOnlineRecordRequest, DescribeVideoGenerationTaskCallbackResponse, DescribeSnapshotTaskResponse, StartWhiteboardPushResponse, ResumeOnlineRecordRequest, DescribeOnlineRecordCallbackRequest, DescribeOnlineRecordCallbackResponse, StopWhiteboardPushRequest, SetTranscodeCallbackResponse, StopOnlineRecordRequest, SetVideoGenerationTaskCallbackKeyResponse, CreateTranscodeResponse, CreateSnapshotTaskResponse, DescribeVideoGenerationTaskResponse, DescribeWhiteboardPushCallbackResponse, SetTranscodeCallbackKeyResponse, DescribeTIWDailyUsageResponse, DescribeOnlineRecordRequest, DescribeWhiteboardPushResponse, StartOnlineRecordResponse, SetOnlineRecordCallbackKeyResponse, DescribeVideoGenerationTaskRequest, CreateVideoGenerationTaskResponse, PauseOnlineRecordResponse, CreateTranscodeRequest, DescribeWhiteboardPushCallbackRequest, DescribeOnlineRecordResponse, SetTranscodeCallbackKeyRequest, CreateSnapshotTaskRequest, DescribeTranscodeResponse, DescribeQualityMetricsRequest, SetOnlineRecordCallbackKeyRequest, CreateVideoGenerationTaskRequest, DescribeTranscodeCallbackRequest, DescribeTranscodeRequest, DescribeTranscodeCallbackResponse, SetTranscodeCallbackRequest, SetWhiteboardPushCallbackRequest, SetWhiteboardPushCallbackResponse, DescribeTIWDailyUsageRequest, DescribeVideoGenerationTaskCallbackRequest, SetOnlineRecordCallbackRequest, PauseOnlineRecordRequest, StopWhiteboardPushResponse, SetOnlineRecordCallbackResponse } from "./tiw_models";
4
4
  /**
5
5
  * tiw client
6
6
  * @class
@@ -127,6 +127,23 @@ export interface StopOnlineRecordResponse {
127
127
  */
128
128
  RequestId?: string;
129
129
  }
130
+ /**
131
+ * 鉴权参数
132
+ */
133
+ export interface AuthParam {
134
+ /**
135
+ * 应用SdkAppId
136
+ */
137
+ SdkAppId: number;
138
+ /**
139
+ * 用户ID
140
+ */
141
+ UserId: string;
142
+ /**
143
+ * 用户ID对应的签名
144
+ */
145
+ UserSig: string;
146
+ }
130
147
  /**
131
148
  * SetVideoGenerationTaskCallbackKey请求参数结构体
132
149
  */
@@ -155,7 +172,8 @@ export interface StartWhiteboardPushRequest {
155
172
  */
156
173
  RoomId: number;
157
174
  /**
158
- * 用于白板推流服务进房进行推流的用户ID,最大长度不能大于60个字节,该ID必须是一个单独的未在SDK中使用的ID,白板推流服务使用这个用户ID进入房间进行白板音视频推流,若该ID和SDK中使用的ID重复,会导致SDK和白板推流服务互踢,影响正常推流。
175
+ * 用于白板推流服务进入白板房间的用户ID。在没有进行额外指定的情况下,这个用户ID同时会用于IM登录、IM加群、TRTC进房推流等操作。
176
+ 用户ID最大长度不能大于60个字节,该ID必须是一个单独的未在SDK中使用的ID,白板推流服务使用这个用户ID进入房间进行白板音视频推流,若该ID和SDK中使用的ID重复,会导致SDK和白板推流服务互踢,影响正常推流。
159
177
  */
160
178
  PushUserId: string;
161
179
  /**
@@ -260,6 +278,24 @@ SdkAppID = 12345678,RoomID = 12345,PushUserID = push_user_1
260
278
  在指定了TRTCRoomIdStr的情况下,会优先使用TRTCRoomIdStr作为白板流进行推流的TRTC房间号。
261
279
  */
262
280
  TRTCRoomIdStr?: string;
281
+ /**
282
+ * 内测参数,需开通白名单进行体验。
283
+
284
+ IM鉴权信息参数,用于IM鉴权。
285
+ 当白板信令所使用的IM应用与白板应用的SdkAppId不一致时,可以通过此参数提供对应IM应用鉴权信息。
286
+
287
+ 如果提供了此参数,白板推流服务会优先使用此参数指定的SdkAppId作为白板信令的传输通道,否则使用公共参数中的SdkAppId作为白板信令的传输通道。
288
+ */
289
+ IMAuthParam?: AuthParam;
290
+ /**
291
+ * 内测参数,需开通白名单进行体验。
292
+
293
+ TRTC鉴权信息参数,用于TRTC进房推流鉴权。
294
+ 当需要推流到的TRTC房间所对应的TRTC应用与白板应用的SdkAppId不一致时,可以通过此参数提供对应的TRTC应用鉴权信息。
295
+
296
+ 如果提供了此参数,白板推流服务会优先使用此参数指定的SdkAppId作为白板推流的目标TRTC应用,否则使用公共参数中的SdkAppId作为白板推流的目标TRTC应用。
297
+ */
298
+ TRTCAuthParam?: AuthParam;
263
299
  }
264
300
  /**
265
301
  * 拼接视频中被忽略的时间段
@@ -1174,17 +1210,39 @@ export interface SetTranscodeCallbackKeyRequest {
1174
1210
  CallbackKey: string;
1175
1211
  }
1176
1212
  /**
1177
- * DescribeTranscode请求参数结构体
1213
+ * CreateSnapshotTask请求参数结构体
1178
1214
  */
1179
- export interface DescribeTranscodeRequest {
1215
+ export interface CreateSnapshotTaskRequest {
1180
1216
  /**
1181
- * 客户的SdkAppId
1217
+ * 白板相关参数
1218
+ */
1219
+ Whiteboard: SnapshotWhiteboard;
1220
+ /**
1221
+ * 白板房间 `SdkAppId`
1182
1222
  */
1183
1223
  SdkAppId: number;
1184
1224
  /**
1185
- * 文档转码任务的唯一标识Id
1225
+ * 白板房间号
1186
1226
  */
1187
- TaskId: string;
1227
+ RoomId: number;
1228
+ /**
1229
+ * 白板板书生成结果通知回调地址
1230
+ */
1231
+ CallbackURL?: string;
1232
+ /**
1233
+ * 白板板书文件 `COS` 存储参数, 不填默认存储在公共存储桶,公共存储桶的数据仅保存3天
1234
+ */
1235
+ COS?: SnapshotCOS;
1236
+ /**
1237
+ * 白板板书生成模式,默认为 `AllMarks`。取值说明如下:
1238
+
1239
+ `AllMarks` - 全量模式,即对于客户端每一次调用 `addSnapshotMark` 接口打上的白板板书生成标志全部都会生成对应的白板板书图片。
1240
+
1241
+ `LatestMarksOnly` - 单页去重模式,即对于客户端在同一页白板上多次调用 `addSnapshotMark` 打上的白板板书生成标志仅保留最新一次标志来生成对应白板页的白板板书图片。
1242
+
1243
+ (**注意:`LatestMarksOnly` 模式只有客户端使用v2.6.8及以上版本的白板SDK调用 `addSnapshotMark` 时才生效,否则即使在调用本API是指定了 `LatestMarksOnly` 模式,服务后台会使用默认的 `AllMarks` 模式生成白板板书**)
1244
+ */
1245
+ SnapshotMode?: string;
1188
1246
  }
1189
1247
  /**
1190
1248
  * DescribeTranscode返回参数结构体
@@ -1373,39 +1431,17 @@ export interface DescribeTranscodeCallbackRequest {
1373
1431
  SdkAppId: number;
1374
1432
  }
1375
1433
  /**
1376
- * CreateSnapshotTask请求参数结构体
1434
+ * DescribeTranscode请求参数结构体
1377
1435
  */
1378
- export interface CreateSnapshotTaskRequest {
1379
- /**
1380
- * 白板相关参数
1381
- */
1382
- Whiteboard: SnapshotWhiteboard;
1436
+ export interface DescribeTranscodeRequest {
1383
1437
  /**
1384
- * 白板房间 `SdkAppId`
1438
+ * 客户的SdkAppId
1385
1439
  */
1386
1440
  SdkAppId: number;
1387
1441
  /**
1388
- * 白板房间号
1389
- */
1390
- RoomId: number;
1391
- /**
1392
- * 白板板书生成结果通知回调地址
1393
- */
1394
- CallbackURL?: string;
1395
- /**
1396
- * 白板板书文件 `COS` 存储参数, 不填默认存储在公共存储桶,公共存储桶的数据仅保存3天
1397
- */
1398
- COS?: SnapshotCOS;
1399
- /**
1400
- * 白板板书生成模式,默认为 `AllMarks`。取值说明如下:
1401
-
1402
- `AllMarks` - 全量模式,即对于客户端每一次调用 `addSnapshotMark` 接口打上的白板板书生成标志全部都会生成对应的白板板书图片。
1403
-
1404
- `LatestMarksOnly` - 单页去重模式,即对于客户端在同一页白板上多次调用 `addSnapshotMark` 打上的白板板书生成标志仅保留最新一次标志来生成对应白板页的白板板书图片。
1405
-
1406
- (**注意:`LatestMarksOnly` 模式只有客户端使用v2.6.8及以上版本的白板SDK调用 `addSnapshotMark` 时才生效,否则即使在调用本API是指定了 `LatestMarksOnly` 模式,服务后台会使用默认的 `AllMarks` 模式生成白板板书**)
1442
+ * 文档转码任务的唯一标识Id
1407
1443
  */
1408
- SnapshotMode?: string;
1444
+ TaskId: string;
1409
1445
  }
1410
1446
  /**
1411
1447
  * DescribeTranscodeCallback返回参数结构体