tencentcloud-sdk-nodejs 4.0.716 → 4.0.718

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 (77) hide show
  1. package/CHANGELOG.md +421 -0
  2. package/SERVICE_CHANGELOG.md +740 -478
  3. package/package.json +1 -1
  4. package/products.md +27 -27
  5. package/src/common/sdk_version.ts +1 -1
  6. package/src/services/asr/v20190614/asr_client.ts +2 -1
  7. package/src/services/asr/v20190614/asr_models.ts +11 -8
  8. package/src/services/cbs/v20170312/cbs_models.ts +4 -0
  9. package/src/services/clb/v20180317/clb_models.ts +8 -0
  10. package/src/services/csip/v20221121/csip_models.ts +4 -0
  11. package/src/services/ecm/v20190719/ecm_models.ts +6 -6
  12. package/src/services/ess/v20201111/ess_models.ts +2 -1
  13. package/src/services/essbasic/v20210526/essbasic_client.ts +34 -23
  14. package/src/services/essbasic/v20210526/essbasic_models.ts +100 -47
  15. package/src/services/iotvideo/v20211125/iotvideo_models.ts +5 -1
  16. package/src/services/mrs/v20200910/mrs_client.ts +43 -19
  17. package/src/services/mrs/v20200910/mrs_models.ts +68 -0
  18. package/src/services/ocr/v20181119/ocr_client.ts +3 -2
  19. package/src/services/ocr/v20181119/ocr_models.ts +73 -47
  20. package/src/services/rce/v20201103/rce_models.ts +5 -0
  21. package/src/services/tag/v20180813/tag_models.ts +1 -1
  22. package/src/services/tcss/v20201101/tcss_models.ts +25 -1
  23. package/src/services/tdmq/v20200217/tdmq_client.ts +13 -1
  24. package/src/services/tdmq/v20200217/tdmq_models.ts +61 -6
  25. package/src/services/teo/v20220901/teo_models.ts +0 -1
  26. package/src/services/tione/v20211111/tione_client.ts +16 -3
  27. package/src/services/tione/v20211111/tione_models.ts +78 -23
  28. package/src/services/tiw/v20190919/tiw_client.ts +1 -1
  29. package/src/services/tiw/v20190919/tiw_models.ts +42 -12
  30. package/src/services/vpc/v20170312/vpc_client.ts +7 -4
  31. package/src/services/vpc/v20170312/vpc_models.ts +172 -66
  32. package/src/services/waf/v20180125/waf_client.ts +4 -2
  33. package/src/services/wedata/v20210820/wedata_client.ts +28 -15
  34. package/src/services/wedata/v20210820/wedata_models.ts +164 -30
  35. package/tencentcloud/common/sdk_version.d.ts +1 -1
  36. package/tencentcloud/common/sdk_version.js +1 -1
  37. package/tencentcloud/services/asr/v20190614/asr_client.d.ts +2 -1
  38. package/tencentcloud/services/asr/v20190614/asr_client.js +2 -1
  39. package/tencentcloud/services/asr/v20190614/asr_models.d.ts +11 -8
  40. package/tencentcloud/services/cbs/v20170312/cbs_models.d.ts +4 -0
  41. package/tencentcloud/services/clb/v20180317/clb_models.d.ts +8 -0
  42. package/tencentcloud/services/csip/v20221121/csip_models.d.ts +4 -0
  43. package/tencentcloud/services/ecm/v20190719/ecm_models.d.ts +6 -6
  44. package/tencentcloud/services/ess/v20201111/ess_models.d.ts +2 -1
  45. package/tencentcloud/services/essbasic/v20210526/essbasic_client.d.ts +32 -21
  46. package/tencentcloud/services/essbasic/v20210526/essbasic_client.js +32 -21
  47. package/tencentcloud/services/essbasic/v20210526/essbasic_models.d.ts +100 -47
  48. package/tencentcloud/services/iotvideo/v20211125/iotvideo_models.d.ts +5 -1
  49. package/tencentcloud/services/mrs/v20200910/mrs_client.d.ts +18 -10
  50. package/tencentcloud/services/mrs/v20200910/mrs_client.js +24 -12
  51. package/tencentcloud/services/mrs/v20200910/mrs_models.d.ts +64 -0
  52. package/tencentcloud/services/ocr/v20181119/ocr_client.d.ts +1 -1
  53. package/tencentcloud/services/ocr/v20181119/ocr_models.d.ts +72 -47
  54. package/tencentcloud/services/rce/v20201103/rce_models.d.ts +5 -0
  55. package/tencentcloud/services/tag/v20180813/tag_models.d.ts +1 -1
  56. package/tencentcloud/services/tcss/v20201101/tcss_models.d.ts +25 -1
  57. package/tencentcloud/services/tdmq/v20200217/tdmq_client.d.ts +5 -1
  58. package/tencentcloud/services/tdmq/v20200217/tdmq_client.js +6 -0
  59. package/tencentcloud/services/tdmq/v20200217/tdmq_models.d.ts +59 -6
  60. package/tencentcloud/services/teo/v20220901/teo_models.d.ts +0 -1
  61. package/tencentcloud/services/tione/v20211111/tione_client.d.ts +5 -1
  62. package/tencentcloud/services/tione/v20211111/tione_client.js +6 -0
  63. package/tencentcloud/services/tione/v20211111/tione_models.d.ts +75 -23
  64. package/tencentcloud/services/tiw/v20190919/tiw_client.d.ts +1 -1
  65. package/tencentcloud/services/tiw/v20190919/tiw_client.js +1 -1
  66. package/tencentcloud/services/tiw/v20190919/tiw_models.d.ts +42 -12
  67. package/tencentcloud/services/vpc/v20170312/vpc_client.d.ts +1 -1
  68. package/tencentcloud/services/vpc/v20170312/vpc_models.d.ts +169 -66
  69. package/tencentcloud/services/waf/v20180125/waf_client.d.ts +3 -1
  70. package/tencentcloud/services/waf/v20180125/waf_client.js +3 -1
  71. package/tencentcloud/services/wedata/v20210820/wedata_client.d.ts +9 -5
  72. package/tencentcloud/services/wedata/v20210820/wedata_client.js +12 -6
  73. package/tencentcloud/services/wedata/v20210820/wedata_models.d.ts +161 -30
  74. package/test/mrs.v20200910.test.js +26 -6
  75. package/test/tdmq.v20200217.test.js +10 -0
  76. package/test/tione.v20211111.test.js +10 -0
  77. package/test/wedata.v20210820.test.js +14 -4
@@ -1718,6 +1718,20 @@ export interface EventPage {
1718
1718
  TotalCount?: number
1719
1719
  }
1720
1720
 
1721
+ /**
1722
+ * ModifyDimensionWeight返回参数结构体
1723
+ */
1724
+ export interface ModifyDimensionWeightResponse {
1725
+ /**
1726
+ * 更新权重是否成功
1727
+ */
1728
+ Data: boolean
1729
+ /**
1730
+ * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
1731
+ */
1732
+ RequestId?: string
1733
+ }
1734
+
1721
1735
  /**
1722
1736
  * BatchResumeIntegrationTasks返回参数结构体
1723
1737
  */
@@ -6237,37 +6251,104 @@ export interface CollectionFolderOpsDto {
6237
6251
  }
6238
6252
 
6239
6253
  /**
6240
- * RerunInstances请求参数结构体
6254
+ * 数据源元数据
6241
6255
  */
6242
- export interface RerunInstancesRequest {
6256
+ export interface DatabaseMeta {
6243
6257
  /**
6244
6258
  * 项目Id
6259
+ 注意:此字段可能返回 null,表示取不到有效值。
6245
6260
  */
6246
6261
  ProjectId: string
6247
6262
  /**
6248
- * 实例嵌套集合
6263
+ * 技术类型
6264
+ 注意:此字段可能返回 null,表示取不到有效值。
6249
6265
  */
6250
- Instances: Array<InstanceInfo>
6266
+ MetastoreType: string
6251
6267
  /**
6252
- * 检查父任务类型, true: 检查父任务; false: 不检查父任务
6268
+ * 数据源名称
6269
+ 注意:此字段可能返回 null,表示取不到有效值。
6253
6270
  */
6254
- CheckFather: boolean
6271
+ DatasourceName: string
6255
6272
  /**
6256
- * 重跑类型, 1: 自身; 3: 孩子; 2: 自身以及孩子
6273
+ * 数据源Id
6274
+ 注意:此字段可能返回 null,表示取不到有效值。
6257
6275
  */
6258
- RerunType: string
6276
+ DatasourceId: number
6259
6277
  /**
6260
- * 实例依赖方式, 1: 自依赖; 2: 任务依赖; 3: 自依赖及父子依赖
6278
+ * 项目英文名
6279
+ 注意:此字段可能返回 null,表示取不到有效值。
6261
6280
  */
6262
- DependentWay: string
6281
+ ProjectName: string
6263
6282
  /**
6264
- * 重跑忽略事件监听与否
6283
+ * 数据源类别:绑定引擎、绑定数据库,可用值:DB,ENGINE
6284
+ 注意:此字段可能返回 null,表示取不到有效值。
6265
6285
  */
6266
- SkipEventListening: boolean
6286
+ Category: string
6267
6287
  /**
6268
- * 下游实例范围 1: 所在工作流 2: 所在项目 3: 所有跨工作流依赖的项目
6288
+ * 数据源描述信息
6289
+ 注意:此字段可能返回 null,表示取不到有效值。
6269
6290
  */
6270
- SonInstanceType: string
6291
+ Description: string
6292
+ /**
6293
+ * 数据源引擎的实例ID,如CDB实例ID
6294
+ 注意:此字段可能返回 null,表示取不到有效值。
6295
+ */
6296
+ Instance: string
6297
+ /**
6298
+ * 数据源引擎所属区域
6299
+ 注意:此字段可能返回 null,表示取不到有效值。
6300
+ */
6301
+ Region: string
6302
+ /**
6303
+ * 数据源数据源的可见性,1为可见、0为不可见。默认为1
6304
+ 注意:此字段可能返回 null,表示取不到有效值。
6305
+ */
6306
+ Status: number
6307
+ /**
6308
+ * db名称
6309
+ 注意:此字段可能返回 null,表示取不到有效值。
6310
+ */
6311
+ DatabaseName: string
6312
+ /**
6313
+ * 项目中文名
6314
+ 注意:此字段可能返回 null,表示取不到有效值。
6315
+ */
6316
+ ProjectDisplayName: string
6317
+ /**
6318
+ * 责任人名称
6319
+ 注意:此字段可能返回 null,表示取不到有效值。
6320
+ */
6321
+ OwnerAccountName: string
6322
+ /**
6323
+ * 数据来源展示名称
6324
+ 注意:此字段可能返回 null,表示取不到有效值。
6325
+ */
6326
+ DisplayName: string
6327
+ /**
6328
+ * 数据库ID
6329
+ 注意:此字段可能返回 null,表示取不到有效值。
6330
+ */
6331
+ DatabaseId: string
6332
+ /**
6333
+ * 数据来源类型:hive/mysql/hbase等
6334
+ 注意:此字段可能返回 null,表示取不到有效值。
6335
+ */
6336
+ Catalog: string
6337
+ /**
6338
+ * 存储量大小,单位为 byte
6339
+ 注意:此字段可能返回 null,表示取不到有效值。
6340
+ */
6341
+ StorageSize: number
6342
+ /**
6343
+ * 格式化后的存储量大小,带单位,如 12B
6344
+ 注意:此字段可能返回 null,表示取不到有效值。
6345
+ */
6346
+ StorageSizeWithUnit: string
6347
+ /**
6348
+ * 创建时间
6349
+ 注意:此字段可能返回 null,表示取不到有效值。
6350
+ */
6351
+ CreateTime: string
6271
6352
  }
6272
6353
 
6273
6354
  /**
@@ -9141,11 +9222,11 @@ export interface SubmitSqlTaskResponse {
9141
9222
  /**
9142
9223
  * 任务提交记录
9143
9224
  */
9144
- Record: AdhocRecord
9225
+ Record?: AdhocRecord
9145
9226
  /**
9146
9227
  * 子任务记录列表
9147
9228
  */
9148
- Details: Array<AdhocDetail>
9229
+ Details?: Array<AdhocDetail>
9149
9230
  /**
9150
9231
  * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
9151
9232
  */
@@ -13168,6 +13249,40 @@ export interface DeleteResourceFilesResponse {
13168
13249
  RequestId?: string
13169
13250
  }
13170
13251
 
13252
+ /**
13253
+ * RerunInstances请求参数结构体
13254
+ */
13255
+ export interface RerunInstancesRequest {
13256
+ /**
13257
+ * 项目Id
13258
+ */
13259
+ ProjectId: string
13260
+ /**
13261
+ * 实例嵌套集合
13262
+ */
13263
+ Instances: Array<InstanceInfo>
13264
+ /**
13265
+ * 检查父任务类型, true: 检查父任务; false: 不检查父任务
13266
+ */
13267
+ CheckFather: boolean
13268
+ /**
13269
+ * 重跑类型, 1: 自身; 3: 孩子; 2: 自身以及孩子
13270
+ */
13271
+ RerunType: string
13272
+ /**
13273
+ * 实例依赖方式, 1: 自依赖; 2: 任务依赖; 3: 自依赖及父子依赖
13274
+ */
13275
+ DependentWay: string
13276
+ /**
13277
+ * 重跑忽略事件监听与否
13278
+ */
13279
+ SkipEventListening: boolean
13280
+ /**
13281
+ * 下游实例范围 1: 所在工作流 2: 所在项目 3: 所有跨工作流依赖的项目
13282
+ */
13283
+ SonInstanceType: string
13284
+ }
13285
+
13171
13286
  /**
13172
13287
  * DescribeEventIsAlarmTypes请求参数结构体
13173
13288
  */
@@ -13588,13 +13703,14 @@ export interface RuleDimStat {
13588
13703
  }
13589
13704
 
13590
13705
  /**
13591
- * ModifyDimensionWeight返回参数结构体
13706
+ * DescribeDatabaseMetas返回参数结构体
13592
13707
  */
13593
- export interface ModifyDimensionWeightResponse {
13708
+ export interface DescribeDatabaseMetasResponse {
13594
13709
  /**
13595
- * 更新权重是否成功
13710
+ *
13711
+ 注意:此字段可能返回 null,表示取不到有效值。
13596
13712
  */
13597
- Data: boolean
13713
+ DatabaseMeta: Array<DatabaseMeta>
13598
13714
  /**
13599
13715
  * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
13600
13716
  */
@@ -14693,21 +14809,17 @@ export interface CreateTaskRequest {
14693
14809
  }
14694
14810
 
14695
14811
  /**
14696
- * ModifyDimensionWeight请求参数结构体
14812
+ * DescribeDatabaseMetas请求参数结构体
14697
14813
  */
14698
- export interface ModifyDimensionWeightRequest {
14699
- /**
14700
- * 权重信息列表
14701
- */
14702
- WeightInfoList: Array<WeightInfo>
14814
+ export interface DescribeDatabaseMetasRequest {
14703
14815
  /**
14704
- * 项目id
14816
+ * 过滤字段,projectIds/msTypes/createTime/modifiedTime
14705
14817
  */
14706
- ProjectId: string
14818
+ Filters?: Array<Filter>
14707
14819
  /**
14708
- * 是否重刷历史数据
14820
+ * 排序字段,如name
14709
14821
  */
14710
- Refresh: boolean
14822
+ OrderFields?: Array<OrderField>
14711
14823
  }
14712
14824
 
14713
14825
  /**
@@ -14936,6 +15048,24 @@ export interface DescribeMonitorsByPageRequest {
14936
15048
  PageNumber?: number
14937
15049
  }
14938
15050
 
15051
+ /**
15052
+ * ModifyDimensionWeight请求参数结构体
15053
+ */
15054
+ export interface ModifyDimensionWeightRequest {
15055
+ /**
15056
+ * 权重信息列表
15057
+ */
15058
+ WeightInfoList: Array<WeightInfo>
15059
+ /**
15060
+ * 项目id
15061
+ */
15062
+ ProjectId: string
15063
+ /**
15064
+ * 是否重刷历史数据
15065
+ */
15066
+ Refresh: boolean
15067
+ }
15068
+
14939
15069
  /**
14940
15070
  * 补录计划日期范围
14941
15071
  */
@@ -15163,6 +15293,10 @@ export interface SubmitSqlTaskRequest {
15163
15293
  * 高级设置
15164
15294
  */
15165
15295
  ConfParams?: string
15296
+ /**
15297
+ * 脚本内容是否base64加密
15298
+ */
15299
+ ScriptEncryption?: boolean
15166
15300
  }
15167
15301
 
15168
15302
  /**
@@ -1 +1 @@
1
- export declare const sdkVersion = "4.0.716";
1
+ export declare const sdkVersion = "4.0.718";
@@ -1,4 +1,4 @@
1
1
  "use strict";
2
2
  Object.defineProperty(exports, "__esModule", { value: true });
3
3
  exports.sdkVersion = void 0;
4
- exports.sdkVersion = "4.0.716";
4
+ exports.sdkVersion = "4.0.718";
@@ -129,7 +129,8 @@ export declare class Client extends AbstractClient {
129
129
  <br>• 每个热词表最多可添加1000个词,每个词最长10个汉字或30个英文字符,不能超出限制。
130
130
  <br>• 热词表可以通过数组或者本地文件形式上传。
131
131
  <br>• 本地文件必须为UTF-8编码格式,每行仅添加一个热词且不能包含标点和特殊字符。
132
- <br>• 热词权重取值范围为[1,10]之间的整数,权重越大代表该词被识别出来的概率越大。
132
+ <br>• 热词权重取值范围为[1,11]之间的整数,权重越大代表该词被识别出来的概率越大。
133
+ <br>• 注意: 热词权重设置为11时,当前热词将升级为超级热词,建议仅将重要且必须生效的热词设置到11,设置过多权重为11的热词将影响整体字准率。
133
134
  */
134
135
  CreateAsrVocab(req: CreateAsrVocabRequest, cb?: (error: string, rep: CreateAsrVocabResponse) => void): Promise<CreateAsrVocabResponse>;
135
136
  /**
@@ -193,7 +193,8 @@ class Client extends abstract_client_1.AbstractClient {
193
193
  <br>• 每个热词表最多可添加1000个词,每个词最长10个汉字或30个英文字符,不能超出限制。
194
194
  <br>• 热词表可以通过数组或者本地文件形式上传。
195
195
  <br>• 本地文件必须为UTF-8编码格式,每行仅添加一个热词且不能包含标点和特殊字符。
196
- <br>• 热词权重取值范围为[1,10]之间的整数,权重越大代表该词被识别出来的概率越大。
196
+ <br>• 热词权重取值范围为[1,11]之间的整数,权重越大代表该词被识别出来的概率越大。
197
+ <br>• 注意: 热词权重设置为11时,当前热词将升级为超级热词,建议仅将重要且必须生效的热词设置到11,设置过多权重为11的热词将影响整体字准率。
197
198
  */
198
199
  async CreateAsrVocab(req, cb) {
199
200
  return this.request("CreateAsrVocab", req, cb);
@@ -321,13 +321,15 @@ export interface SentenceRecognitionRequest {
321
321
  */
322
322
  ReinforceHotword?: number;
323
323
  /**
324
- * 临时热词表,该参数用于提升热词识别准确率。
325
- 单个热词规则:"热词|权重",不超过30个字符(最多10个汉字),权重1-10;
326
- 临时热词表限制:多个热词用英文逗号分割,最多128个热词,参数示例:"腾讯云|10,语音识别|5,ASR|10";
327
- 参数 hotword_list 与 hotword_id 区别:
328
- hotword_id:需要先在控制台或接口创建热词表,获得对应hotword_id传入参数来使用热词功能;
329
- hotword_list:每次请求时直接传入临时热词表来使用热词功能,云端不保留临时热词表;
330
- 注意:如果同时传入了 hotword_id 和 hotword_list,会优先使用 hotword_list。
324
+ * 临时热词表:该参数用于提升识别准确率。
325
+ 单个热词限制:"热词|权重",单个热词不超过30个字符(最多10个汉字),权重1-11,如:“腾讯云|5” 或 “ASR|11”;
326
+ 临时热词表限制:多个热词用英文逗号分割,最多支持128个热词,如:“腾讯云|10,语音识别|5,ASR|11”;
327
+ 参数 hotword_list(热词表) 与 hotword_id(临时热词表) 区别:
328
+ hotword_id:热词表。需要先在控制台或接口创建热词表,获得对应hotword_id传入参数来使用热词功能;
329
+ hotword_list:临时热词表。每次请求时直接传入临时热词表来使用热词功能,云端不保留临时热词表。适用于有极大量热词需求的用户;
330
+ 注意:
331
+ • 如果同时传入了 hotword_id 和 hotword_list,会优先使用 hotword_list;
332
+ • 热词权重设置为11时,当前热词将升级为超级热词,建议仅将重要且必须生效的热词设置到11,设置过多权重为11的热词将影响整体字准率。
331
333
  */
332
334
  HotwordList?: string;
333
335
  /**
@@ -1099,7 +1101,8 @@ export interface CreateAsrVocabRequest {
1099
1101
  */
1100
1102
  Description?: string;
1101
1103
  /**
1102
- * 词权重数组,包含全部的热词和对应的权重。每个热词的长度不大于10个汉字或30个英文字符,权重为[1,10]之间整数,数组长度不大于1000
1104
+ * 词权重数组,包含全部的热词和对应的权重。每个热词的长度不大于10个汉字或30个英文字符,权重为[1,11]之间整数,数组长度不大于1000
1105
+ 注意: 热词权重设置为11时,当前热词将升级为超级热词,建议仅将重要且必须生效的热词设置到11,设置过多权重为11的热词将影响整体字准率。
1103
1106
  */
1104
1107
  WordWeights?: Array<HotWord>;
1105
1108
  /**
@@ -1852,6 +1852,10 @@ export interface DescribeDiskConfigQuotaRequest {
1852
1852
  * 实例CPU核数。
1853
1853
  */
1854
1854
  CPU?: number;
1855
+ /**
1856
+ * 专用集群ID。
1857
+ */
1858
+ DedicatedClusterId?: string;
1855
1859
  }
1856
1860
  /**
1857
1861
  * DescribeDiskAssociatedAutoSnapshotPolicy返回参数结构体
@@ -223,6 +223,10 @@ export interface CreateLoadBalancerRequest {
223
223
  <ul><li>若需要创建性能容量型实例,则此参数必填,取值范围:<ul><li> SLA:超强型1规格。当您开通了超大型规格的性能容量型时,SLA对应超强型4规格 </li><li> clb.c2.medium:标准型规格 </li><li> clb.c3.small:高阶型1规格 </li><li> clb.c3.medium:高阶型2规格 </li><li> clb.c4.small:超强型1规格 </li><li> clb.c4.medium:超强型2规格 </li><li> clb.c4.large:超强型3规格 </li><li> clb.c4.xlarge:超强型4规格 </li>如需超大型规格(超强型2及以上),请提交[工单申请](https://console.cloud.tencent.com/workorder/category)。</ul></li><li>若需要创建共享型实例,则无需填写此参数。</li></ul>如需了解规格详情,请参见[实例规格对比](https://cloud.tencent.com/document/product/214/84689)。
224
224
  */
225
225
  SlaType?: string;
226
+ /**
227
+ * 集群ID,集群标识,在需要配置公有云独占集群或本地专有集群时使用。公有云独占集群申请请[提交工单](https://console.cloud.tencent.com/workorder/category),本地专有集群请参考[本地专有集群](https://cloud.tencent.com/document/product/1346)描述。
228
+ */
229
+ ClusterIds?: Array<string>;
226
230
  /**
227
231
  * 用于保证请求幂等性的字符串。该字符串由客户生成,需保证不同请求之间唯一,最大值不超过64个ASCII字符。若不指定该参数,则无法保证请求的幂等性。
228
232
  */
@@ -4700,6 +4704,10 @@ export interface ModifyLoadBalancerSlaRequest {
4700
4704
  * 负载均衡实例信息。
4701
4705
  */
4702
4706
  LoadBalancerSla: Array<SlaUpdateParam>;
4707
+ /**
4708
+ * 是否强制升级,默认否。
4709
+ */
4710
+ Force?: boolean;
4703
4711
  }
4704
4712
  /**
4705
4713
  * DescribeBlockIPTask请求参数结构体
@@ -728,6 +728,10 @@ export interface Vpc {
728
728
  * 漏洞风险高级配置列表
729
729
  */
730
730
  export interface VULRiskAdvanceCFGList {
731
+ /**
732
+ * 风险ID
733
+ */
734
+ RiskId?: string;
731
735
  /**
732
736
  * 漏洞名称
733
737
  */
@@ -2152,7 +2152,7 @@ export interface CreateModuleResponse {
2152
2152
  /**
2153
2153
  * 模块ID,创建模块成功后分配给该模块的ID。
2154
2154
  */
2155
- ModuleId: string;
2155
+ ModuleId?: string;
2156
2156
  /**
2157
2157
  * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
2158
2158
  */
@@ -3449,11 +3449,11 @@ export interface CreateModuleRequest {
3449
3449
  */
3450
3450
  ModuleName: string;
3451
3451
  /**
3452
- * 默认带宽,单位:M。范围不得超过带宽上下限,详看DescribeConfig。
3452
+ * 默认带宽,单位:Mbps。范围不得超过带宽上下限,详看[DescribeConfig](https://cloud.tencent.com/document/product/1108/42572)
3453
3453
  */
3454
3454
  DefaultBandWidth: number;
3455
3455
  /**
3456
- * 默认镜像,如img-qsdf3ff2。
3456
+ * 默认镜像。
3457
3457
  */
3458
3458
  DefaultImageId: string;
3459
3459
  /**
@@ -3461,11 +3461,11 @@ export interface CreateModuleRequest {
3461
3461
  */
3462
3462
  InstanceType: string;
3463
3463
  /**
3464
- * 默认系统盘大小,单位:G,默认大小为50G。范围不得超过系统盘上下限制,详看DescribeConfig。
3464
+ * 默认系统盘大小,单位:GB,默认大小为50GB。范围不得超过系统盘上下限制,详看[DescribeConfig](https://cloud.tencent.com/document/product/1108/42572)
3465
3465
  */
3466
3466
  DefaultSystemDiskSize: number;
3467
3467
  /**
3468
- * 默认数据盘大小,单位:G。范围不得超过数据盘范围大小,详看DescribeConfig。
3468
+ * 默认数据盘大小,单位:GB。范围不得超过数据盘范围大小,详看[DescribeConfig](https://cloud.tencent.com/document/product/1108/42572)
3469
3469
  */
3470
3470
  DefaultDataDiskSize: number;
3471
3471
  /**
@@ -3483,7 +3483,7 @@ export interface CreateModuleRequest {
3483
3483
  */
3484
3484
  SecurityGroups?: Array<string>;
3485
3485
  /**
3486
- * 默认入带宽,单位:M。范围不得超过带宽上下限,详看DescribeConfig。
3486
+ * 默认入带宽,单位:Mbps。范围不得超过带宽上下限,详看[DescribeConfig](https://cloud.tencent.com/document/product/1108/42572)
3487
3487
  */
3488
3488
  DefaultBandWidthIn?: number;
3489
3489
  /**
@@ -4135,7 +4135,8 @@ export interface CreateReleaseFlowRequest {
4135
4135
  */
4136
4136
  ReliveInfo: RelieveInfo;
4137
4137
  /**
4138
- * 关于渠道应用的相关信息,包括子客企业及应用编、号等详细内容,您可以参阅开发者中心所提供的 Agent 结构体以获取详细定义。
4138
+ * 代理企业和员工的信息。
4139
+ 在集团企业代理子企业操作的场景中,需设置此参数。在此情境下,ProxyOrganizationId(子企业的组织ID)为必填项。
4139
4140
  */
4140
4141
  Agent?: Agent;
4141
4142
  /**
@@ -262,7 +262,13 @@ https://developers.weixin.qq.com/miniprogram/dev/framework/open-ability/launchAp
262
262
  */
263
263
  CreateFlowsByTemplates(req: CreateFlowsByTemplatesRequest, cb?: (error: string, rep: CreateFlowsByTemplatesResponse) => void): Promise<CreateFlowsByTemplatesResponse>;
264
264
  /**
265
- * 企业方可以通过此接口关闭个人的自动签功能
265
+ * 通过此接口可以关闭个人用户自动签功能。
266
+ 无需对应的用户刷脸等方式同意即可关闭。
267
+
268
+ 注意:
269
+
270
+ <ul><li>处方单等特殊场景专用,此接口为白名单功能,使用前请联系对接的客户经理沟通。</li>
271
+ <li>如果此用户在开通时候绑定过个人自动签账号许可, 关闭此用户的自动签不会归还个人自动签账号许可的额度。</li></ul>
266
272
  */
267
273
  ChannelDisableUserAutoSign(req: ChannelDisableUserAutoSignRequest, cb?: (error: string, rep: ChannelDisableUserAutoSignResponse) => void): Promise<ChannelDisableUserAutoSignResponse>;
268
274
  /**
@@ -291,7 +297,7 @@ https://developers.weixin.qq.com/miniprogram/dev/framework/open-ability/launchAp
291
297
  /**
292
298
  * 创建跳转小程序查看或签署的链接
293
299
 
294
- **腾讯电子签小程序的的AppID 和 原始Id如下:**
300
+ **腾讯电子签小程序的AppID 和 原始Id如下:**
295
301
 
296
302
  | 小程序 | AppID | 原始ID |
297
303
  | ------------ | ------------ | ------------ |
@@ -302,10 +308,10 @@ https://developers.weixin.qq.com/miniprogram/dev/framework/open-ability/launchAp
302
308
 
303
309
  |EndPoint| 场景| 说明和示例|
304
310
  | ---- | ---- | --- |
305
- | WEIXINAPP | 短链跳转腾讯电子签签署场景 | 点击链接打开电子签小程序(与腾讯电子签官方短信提醒用户签署形式一样)<br> 示例: https://essurl.cn/x9nvWU8fTg|
306
- | LONGURL2WEIXINAPP | 长链跳转腾讯电子签签署场景 | 点击链接打开电子签小程序, 是WEIXINAPP生成短链代表的那个长链|
311
+ | WEIXINAPP | 短链跳转腾讯电子签小程序签署场景 | 点击链接打开电子签小程序(与腾讯电子签官方短信提醒用户签署形式一样)<br> 示例: https://essurl.cn/x9nvWU8fTg|
312
+ | LONGURL2WEIXINAPP | 长链跳转腾讯电子签小程序签署场景 | 点击链接打开电子签小程序, 是WEIXINAPP生成短链代表的那个长链|
307
313
  | CHANNEL | 带有H5引导页的跳转腾讯电子签小程序签署场景 | 点击链接打开一个H5引导页面, 页面中有个"前往小程序"的按钮, 点击后会跳转到腾讯电子签小程序签署场景; 签署完成会回到H5引导页面, 然后跳转到指定创建链接指定的JumpUrl<br>示例: https://res.ess.tencent.cn/cdn/h5-activity-beta/jump-mp.html?use=channel-guide&type=warning&token=uIFKIU8fTd |
308
- |APP| 贵方APP跳转腾讯电子签小程序签署场景| 贵方App直接跳转到小程序后, 在腾讯电子签小程序签署完成后返回贵方App的场景<br>跳转到腾讯电子签小程序的实现可以参考微信的官方文档:<a href="https://developers.weixin.qq.com/miniprogram/dev/framework/open-ability/launchApp.html" target="_blank">开放能力/打开 App</a> <br> 示例: pages/guide?from=default&where=mini& to=CONTRACT_DETAIL& id=yDwiBUUc*duRvquCSX8wd& shortKey=yDwivUA**W1yRsTre3 |
314
+ |APP| 贵方App跳转腾讯电子签小程序签署场景| 贵方App直接跳转到小程序后, 在腾讯电子签小程序签署完成后返回贵方App的场景<br>跳转到腾讯电子签小程序的实现可以参考微信的官方文档:<a href="https://developers.weixin.qq.com/miniprogram/dev/framework/open-ability/launchApp.html" target="_blank">开放能力/打开 App</a> <br> 示例: pages/guide?from=default&where=mini& to=CONTRACT_DETAIL& id=yDwiBUUc*duRvquCSX8wd& shortKey=yDwivUA**W1yRsTre3 |
309
315
  |APP| 贵方小程序跳转腾讯电子签小程序签署场景| 贵方App直接跳转到小程序后, 在腾讯电子签小程序签署完成后返回贵方小程序的场景<br>跳转到腾讯电子签小程序的实现可以参考微信官方文档<a href="https://developers.weixin.qq.com/miniprogram/dev/api/navigate/wx.navigateToMiniProgram.html" target="_blank">全屏方式</a>和<a href="https://developers.weixin.qq.com/miniprogram/dev/framework/open-ability/openEmbeddedMiniProgram.html " target="_blank">半屏方式</a><br>此时返回的SignUrl就是官方文档中的path<br> 示例:pages/guide?from=default&where=mini& to=CONTRACT_DETAIL& id=yDwiBUUc*duRvquCSX8wd& shortKey=yDwivUA**W1yRsTre3 |
310
316
  */
311
317
  CreateSignUrls(req: CreateSignUrlsRequest, cb?: (error: string, rep: CreateSignUrlsResponse) => void): Promise<CreateSignUrlsResponse>;
@@ -422,7 +428,9 @@ Web链接访问后,会根据子客企业(**Agent中ProxyOrganizationOpenId表
422
428
  */
423
429
  ChannelCreateUserAutoSignSealUrl(req: ChannelCreateUserAutoSignSealUrlRequest, cb?: (error: string, rep: ChannelCreateUserAutoSignSealUrlResponse) => void): Promise<ChannelCreateUserAutoSignSealUrlResponse>;
424
430
  /**
425
- * 企业方可以通过此接口查询个人用户自动签开启状态
431
+ * 通过此接口获取个人用户自动签的开通状态。
432
+
433
+ 注意: `处方单等特殊场景专用,此接口为白名单功能,使用前请联系对接的客户经理沟通。`
426
434
  */
427
435
  ChannelDescribeUserAutoSignStatus(req: ChannelDescribeUserAutoSignStatusRequest, cb?: (error: string, rep: ChannelDescribeUserAutoSignStatusResponse) => void): Promise<ChannelDescribeUserAutoSignStatusResponse>;
428
436
  /**
@@ -449,22 +457,26 @@ Web链接访问后,会根据子客企业(**Agent中ProxyOrganizationOpenId表
449
457
  */
450
458
  ChannelCreateReleaseFlow(req: ChannelCreateReleaseFlowRequest, cb?: (error: string, rep: ChannelCreateReleaseFlowResponse) => void): Promise<ChannelCreateReleaseFlowResponse>;
451
459
  /**
452
- * 查询企业员工列表
460
+ * 用于分页查询企业员工信息列表,支持设置过滤条件以筛选员工查询结果。
453
461
  */
454
462
  ChannelDescribeEmployees(req: ChannelDescribeEmployeesRequest, cb?: (error: string, rep: ChannelDescribeEmployeesResponse) => void): Promise<ChannelDescribeEmployeesResponse>;
455
463
  /**
456
- * 指定需要批量撤销的签署流程Id,批量撤销合同
457
- 客户指定需要撤销的签署流程Id,最多100个,超过100不处理;
458
-
459
- 可以撤回:未全部签署完成
460
- 不可以撤回:已全部签署完成、已拒签、已过期、已撤回、拒绝填写、已解除等合同状态。
461
-
462
- **满足撤销条件的合同会发起异步撤销流程,不满足撤销条件的合同返回失败原因。**
463
-
464
- **合同撤销成功后,会通过合同状态为 CANCEL 的回调消息通知调用方 [具体可参考回调消息](https://qian.tencent.com/developers/scenes/partner/callback_data_types#-%E5%90%88%E5%90%8C%E7%8A%B6%E6%80%81%E9%80%9A%E7%9F%A5---flowstatuschange)**
465
-
466
- **注意:
467
- 能撤回合同的只能是合同的发起人或者发起企业的超管、法人**
464
+ * 用于批量撤销合同流程<br/>
465
+ 适用场景:
466
+ 如果某些合同流程当前至少还有一方没有签署,则可通过该接口取消该合同流程。常用于合同发错、内容填错,需要及时撤销的场景。<br/>
467
+ 通过签署流程编号批量撤销合同,单次最多支持撤销100份合同。只有合同的发起人或者发起方企业的超管/法人才能进行合同撤销。需要注意的是,若合同处于以下已终止状态,则不可撤销:<br/>
468
+ - 已全部签署完成
469
+ - 已拒签
470
+ - 已过期
471
+ - 已撤回
472
+ - 拒绝填写
473
+ - 已解除
474
+
475
+ <br/>
476
+ 满足撤销条件的合同会发起异步撤销流程,而不满足撤销条件的合同将返回失败原因。合同撤销成功后,会通过合同状态为 CANCEL 的回调消息通知调用方。具体的回调消息内容可参考 <a href="https://qian.tencent.com/developers/partner/callback_types_contracts_sign" target="_blank">合同状态变更回调消息</a>。
477
+ <br/><br/>
478
+ 注:
479
+ `如果合同流程中的参与方均已签署完毕,则无法通过该接口撤销合同,`签署完毕的合同需要双方走解除流程将合同作废,可以参考<a href="https://qian.tencent.com/developers/partnerApis/startFlows/ChannelCreateReleaseFlow" target="_blank">发起解除合同流程</a>接口。
468
480
  */
469
481
  ChannelBatchCancelFlows(req: ChannelBatchCancelFlowsRequest, cb?: (error: string, rep: ChannelBatchCancelFlowsResponse) => void): Promise<ChannelBatchCancelFlowsResponse>;
470
482
  /**
@@ -538,8 +550,7 @@ httpProfile.setEndpoint("file.test.ess.tencent.cn");
538
550
  */
539
551
  UploadFiles(req: UploadFilesRequest, cb?: (error: string, rep: UploadFilesResponse) => void): Promise<UploadFilesResponse>;
540
552
  /**
541
- * 创建个人签署H5签署链接,请联系客户经理申请使用<br/>
542
- 该接口用于发起合同后,生成C端签署人的签署链接<br/>
553
+ * 该接口用于发起合同后,生成C端签署人的签署链接<br/>
543
554
  注意:该接口目前签署人类型仅支持个人签署方(PERSON)<br/>
544
555
  注意:该接口可生成签署链接的C端签署人必须仅有手写签名和时间类型的签署控件<br/>
545
556
  注意:该接口返回的签署链接是用于APP集成的场景,支持APP打开或浏览器直接打开,不支持微信小程序嵌入。微信小程序请使用小程序跳转或半屏弹窗的方式<br/>