tencentcloud-sdk-nodejs 4.0.954 → 4.0.956

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 (102) hide show
  1. package/CHANGELOG.md +439 -0
  2. package/SERVICE_CHANGELOG.md +452 -7
  3. package/package.json +1 -1
  4. package/products.md +28 -28
  5. package/src/common/sdk_version.ts +1 -1
  6. package/src/services/cbs/v20170312/cbs_models.ts +3 -3
  7. package/src/services/cdn/v20180606/cdn_models.ts +1 -1
  8. package/src/services/cdwch/v20200915/cdwch_models.ts +10 -0
  9. package/src/services/clb/v20180317/clb_models.ts +11 -6
  10. package/src/services/cls/v20201016/cls_client.ts +7 -6
  11. package/src/services/cls/v20201016/cls_models.ts +217 -188
  12. package/src/services/cynosdb/v20190107/cynosdb_client.ts +4 -2
  13. package/src/services/cynosdb/v20190107/cynosdb_models.ts +77 -30
  14. package/src/services/dlc/v20210125/dlc_client.ts +14 -1
  15. package/src/services/dlc/v20210125/dlc_models.ts +141 -8
  16. package/src/services/dsgc/v20190723/dsgc_models.ts +70 -10
  17. package/src/services/emr/v20190103/emr_models.ts +1 -1
  18. package/src/services/ess/v20201111/ess_client.ts +45 -22
  19. package/src/services/ess/v20201111/ess_models.ts +81 -27
  20. package/src/services/essbasic/v20210526/essbasic_client.ts +25 -16
  21. package/src/services/essbasic/v20210526/essbasic_models.ts +65 -13
  22. package/src/services/faceid/v20180301/faceid_models.ts +1 -1
  23. package/src/services/iotexplorer/v20190423/iotexplorer_client.ts +28 -4
  24. package/src/services/iotexplorer/v20190423/iotexplorer_models.ts +169 -66
  25. package/src/services/lke/v20231130/lke_models.ts +1 -2
  26. package/src/services/mongodb/v20190725/mongodb_models.ts +3 -4
  27. package/src/services/mps/v20190612/mps_client.ts +74 -21
  28. package/src/services/mps/v20190612/mps_models.ts +421 -35
  29. package/src/services/oceanus/v20190422/oceanus_client.ts +19 -6
  30. package/src/services/oceanus/v20190422/oceanus_models.ts +139 -91
  31. package/src/services/redis/v20180412/redis_client.ts +14 -2
  32. package/src/services/redis/v20180412/redis_models.ts +72 -37
  33. package/src/services/tcss/v20201101/tcss_client.ts +20 -10
  34. package/src/services/tke/v20180525/tke_client.ts +1 -15
  35. package/src/services/tke/v20180525/tke_models.ts +126 -162
  36. package/src/services/tms/v20201229/tms_models.ts +1 -1
  37. package/src/services/trtc/v20190722/trtc_models.ts +8 -5
  38. package/src/services/vod/v20180717/vod_client.ts +1 -0
  39. package/src/services/vpc/v20170312/vpc_client.ts +1 -1
  40. package/src/services/vpc/v20170312/vpc_models.ts +10 -6
  41. package/src/services/waf/v20180125/waf_client.ts +43 -15
  42. package/src/services/waf/v20180125/waf_models.ts +351 -22
  43. package/tencentcloud/common/sdk_version.d.ts +1 -1
  44. package/tencentcloud/common/sdk_version.js +1 -1
  45. package/tencentcloud/services/cbs/v20170312/cbs_models.d.ts +3 -3
  46. package/tencentcloud/services/cdn/v20180606/cdn_models.d.ts +1 -1
  47. package/tencentcloud/services/cdwch/v20200915/cdwch_models.d.ts +10 -0
  48. package/tencentcloud/services/clb/v20180317/clb_models.d.ts +11 -6
  49. package/tencentcloud/services/cls/v20201016/cls_client.d.ts +1 -1
  50. package/tencentcloud/services/cls/v20201016/cls_models.d.ts +215 -187
  51. package/tencentcloud/services/cynosdb/v20190107/cynosdb_client.d.ts +2 -2
  52. package/tencentcloud/services/cynosdb/v20190107/cynosdb_client.js +1 -1
  53. package/tencentcloud/services/cynosdb/v20190107/cynosdb_models.d.ts +75 -30
  54. package/tencentcloud/services/dlc/v20210125/dlc_client.d.ts +5 -1
  55. package/tencentcloud/services/dlc/v20210125/dlc_client.js +6 -0
  56. package/tencentcloud/services/dlc/v20210125/dlc_models.d.ts +138 -8
  57. package/tencentcloud/services/dsgc/v20190723/dsgc_models.d.ts +70 -10
  58. package/tencentcloud/services/emr/v20190103/emr_models.d.ts +1 -1
  59. package/tencentcloud/services/ess/v20201111/ess_client.d.ts +43 -21
  60. package/tencentcloud/services/ess/v20201111/ess_client.js +43 -21
  61. package/tencentcloud/services/ess/v20201111/ess_models.d.ts +80 -27
  62. package/tencentcloud/services/essbasic/v20210526/essbasic_client.d.ts +17 -16
  63. package/tencentcloud/services/essbasic/v20210526/essbasic_client.js +18 -15
  64. package/tencentcloud/services/essbasic/v20210526/essbasic_models.d.ts +63 -13
  65. package/tencentcloud/services/faceid/v20180301/faceid_models.d.ts +1 -1
  66. package/tencentcloud/services/iotexplorer/v20190423/iotexplorer_client.d.ts +9 -1
  67. package/tencentcloud/services/iotexplorer/v20190423/iotexplorer_client.js +12 -0
  68. package/tencentcloud/services/iotexplorer/v20190423/iotexplorer_models.d.ts +164 -65
  69. package/tencentcloud/services/lke/v20231130/lke_models.d.ts +1 -2
  70. package/tencentcloud/services/mongodb/v20190725/mongodb_models.d.ts +3 -4
  71. package/tencentcloud/services/mps/v20190612/mps_client.d.ts +24 -7
  72. package/tencentcloud/services/mps/v20190612/mps_client.js +34 -9
  73. package/tencentcloud/services/mps/v20190612/mps_models.d.ts +409 -35
  74. package/tencentcloud/services/oceanus/v20190422/oceanus_client.d.ts +5 -1
  75. package/tencentcloud/services/oceanus/v20190422/oceanus_client.js +6 -0
  76. package/tencentcloud/services/oceanus/v20190422/oceanus_models.d.ts +135 -90
  77. package/tencentcloud/services/redis/v20180412/redis_client.d.ts +6 -2
  78. package/tencentcloud/services/redis/v20180412/redis_client.js +7 -1
  79. package/tencentcloud/services/redis/v20180412/redis_models.d.ts +70 -37
  80. package/tencentcloud/services/tcss/v20201101/tcss_client.d.ts +15 -5
  81. package/tencentcloud/services/tcss/v20201101/tcss_client.js +15 -5
  82. package/tencentcloud/services/tke/v20180525/tke_client.d.ts +1 -7
  83. package/tencentcloud/services/tke/v20180525/tke_client.js +0 -8
  84. package/tencentcloud/services/tke/v20180525/tke_models.d.ts +126 -160
  85. package/tencentcloud/services/tms/v20201229/tms_models.d.ts +1 -1
  86. package/tencentcloud/services/trtc/v20190722/trtc_models.d.ts +8 -5
  87. package/tencentcloud/services/vod/v20180717/vod_client.d.ts +1 -0
  88. package/tencentcloud/services/vod/v20180717/vod_client.js +1 -0
  89. package/tencentcloud/services/vpc/v20170312/vpc_client.d.ts +1 -1
  90. package/tencentcloud/services/vpc/v20170312/vpc_client.js +1 -1
  91. package/tencentcloud/services/vpc/v20170312/vpc_models.d.ts +10 -6
  92. package/tencentcloud/services/waf/v20180125/waf_client.d.ts +13 -5
  93. package/tencentcloud/services/waf/v20180125/waf_client.js +18 -6
  94. package/tencentcloud/services/waf/v20180125/waf_models.d.ts +343 -22
  95. package/test/dlc.v20210125.test.js +10 -0
  96. package/test/essbasic.v20210526.test.js +10 -0
  97. package/test/iotexplorer.v20190423.test.js +20 -0
  98. package/test/mps.v20190612.test.js +46 -6
  99. package/test/oceanus.v20190422.test.js +10 -0
  100. package/test/redis.v20180412.test.js +10 -0
  101. package/test/tke.v20180525.test.js +0 -10
  102. package/test/waf.v20180125.test.js +24 -4
@@ -191,7 +191,7 @@ import {
191
191
  AlterDMSPartitionResponse,
192
192
  DescribeTableResponse,
193
193
  DetachUserPolicyResponse,
194
- SparkSessionBatchLogOperate,
194
+ AnalysisTaskResults,
195
195
  UnbindWorkGroupsFromUserResponse,
196
196
  AlterDMSDatabaseResponse,
197
197
  CancelNotebookSessionStatementResponse,
@@ -216,6 +216,7 @@ import {
216
216
  DeleteDataEngineResponse,
217
217
  CosPermission,
218
218
  IpPortPair,
219
+ DescribeTasksAnalysisResponse,
219
220
  RestartDataEngineResponse,
220
221
  SwitchDataEngineImageResponse,
221
222
  DescribeSparkAppTasksResponse,
@@ -266,6 +267,7 @@ import {
266
267
  CreateImportTaskResponse,
267
268
  SmartOptimizerIndexPolicy,
268
269
  RenewDataEngineRequest,
270
+ DescribeTasksAnalysisRequest,
269
271
  DescribeScriptsResponse,
270
272
  UnbindWorkGroupsFromUserRequest,
271
273
  ViewResponseInfo,
@@ -349,6 +351,7 @@ import {
349
351
  UnlockMetaDataRequest,
350
352
  CreateSparkAppTaskResponse,
351
353
  ListTaskJobLogDetailRequest,
354
+ SparkSessionBatchLogOperate,
352
355
  RevokeDLCCatalogAccessResponse,
353
356
  DeleteCHDFSBindingProductRequest,
354
357
  RenewDataEngineResponse,
@@ -1616,6 +1619,16 @@ export class Client extends AbstractClient {
1616
1619
  return this.request("RegisterThirdPartyAccessUser", req, cb)
1617
1620
  }
1618
1621
 
1622
+ /**
1623
+ * 该接口用于洞察分析列表
1624
+ */
1625
+ async DescribeTasksAnalysis(
1626
+ req: DescribeTasksAnalysisRequest,
1627
+ cb?: (error: string, rep: DescribeTasksAnalysisResponse) => void
1628
+ ): Promise<DescribeTasksAnalysisResponse> {
1629
+ return this.request("DescribeTasksAnalysis", req, cb)
1630
+ }
1631
+
1619
1632
  /**
1620
1633
  * 从工作组中删除用户
1621
1634
  */
@@ -4118,24 +4118,80 @@ export interface DetachUserPolicyResponse {
4118
4118
  }
4119
4119
 
4120
4120
  /**
4121
- * SparkSQL批任务日志操作信息。
4121
+ * 洞察分析结果返回体
4122
4122
  */
4123
- export interface SparkSessionBatchLogOperate {
4123
+ export interface AnalysisTaskResults {
4124
4124
  /**
4125
- * 操作提示
4125
+ * 任务Id
4126
+ */
4127
+ Id?: string
4128
+ /**
4129
+ * 任务创建时间,毫秒时间戳
4130
+ */
4131
+ InstanceStartTime?: number
4132
+ /**
4133
+ * 任务结束时间,毫秒时间戳
4126
4134
  注意:此字段可能返回 null,表示取不到有效值。
4127
4135
  */
4128
- Text?: string
4136
+ InstanceCompleteTime?: number
4129
4137
  /**
4130
- * 操作类型:COPY、LOG、UI、RESULT、List、TAB
4138
+ * 任务状态:0 初始化, 1 执行中, 2 执行成功,3 数据写入中,4 排队中。-1 执行失败,-3 已取消。
4139
+ */
4140
+ State?: number
4141
+ /**
4142
+ * 任务SQL语句
4143
+ */
4144
+ SQL?: string
4145
+ /**
4146
+ * 计算资源名字
4131
4147
  注意:此字段可能返回 null,表示取不到有效值。
4132
4148
  */
4133
- Operate?: string
4149
+ DataEngineName?: string
4134
4150
  /**
4135
- * 补充信息:如:taskid、sessionid、sparkui等
4151
+ * 单位毫秒,引擎内执行耗时
4136
4152
  注意:此字段可能返回 null,表示取不到有效值。
4137
4153
  */
4138
- Supplement?: Array<KVPair>
4154
+ JobTimeSum?: number
4155
+ /**
4156
+ * 单位秒,CU资源消耗
4157
+ 注意:此字段可能返回 null,表示取不到有效值。
4158
+ */
4159
+ TaskTimeSum?: number
4160
+ /**
4161
+ * 数据扫描总行数
4162
+ 注意:此字段可能返回 null,表示取不到有效值。
4163
+ */
4164
+ InputRecordsSum?: number
4165
+ /**
4166
+ * 数据扫描总 bytes
4167
+ 注意:此字段可能返回 null,表示取不到有效值。
4168
+ */
4169
+ InputBytesSum?: number
4170
+ /**
4171
+ * 输出总行数
4172
+ 注意:此字段可能返回 null,表示取不到有效值。
4173
+ */
4174
+ OutputRecordsSum?: number
4175
+ /**
4176
+ * 输出总 bytes
4177
+ 注意:此字段可能返回 null,表示取不到有效值。
4178
+ */
4179
+ OutputBytesSum?: number
4180
+ /**
4181
+ * shuffle read 总 bytes
4182
+ 注意:此字段可能返回 null,表示取不到有效值。
4183
+ */
4184
+ ShuffleReadBytesSum?: number
4185
+ /**
4186
+ * shuffle read 总行数
4187
+ 注意:此字段可能返回 null,表示取不到有效值。
4188
+ */
4189
+ ShuffleReadRecordsSum?: number
4190
+ /**
4191
+ * 洞察结果类型分类,一个 json 数组,有如下几种类型:SPARK-StageScheduleDelay(资源抢占), SPARK-ShuffleFailure(Shuffle异常), SPARK-SlowTask(慢task), SPARK-DataSkew(数据倾斜), SPARK-InsufficientResource(磁盘或内存不足)
4192
+ 注意:此字段可能返回 null,表示取不到有效值。
4193
+ */
4194
+ AnalysisStatus?: string
4139
4195
  }
4140
4196
 
4141
4197
  /**
@@ -4851,6 +4907,24 @@ export interface IpPortPair {
4851
4907
  Port?: number
4852
4908
  }
4853
4909
 
4910
+ /**
4911
+ * DescribeTasksAnalysis返回参数结构体
4912
+ */
4913
+ export interface DescribeTasksAnalysisResponse {
4914
+ /**
4915
+ * 洞察结果分页列表
4916
+ */
4917
+ TaskList?: Array<AnalysisTaskResults>
4918
+ /**
4919
+ * 洞察结果总数
4920
+ */
4921
+ TotalCount?: number
4922
+ /**
4923
+ * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
4924
+ */
4925
+ RequestId?: string
4926
+ }
4927
+
4854
4928
  /**
4855
4929
  * RestartDataEngine返回参数结构体
4856
4930
  */
@@ -6135,6 +6209,44 @@ export interface RenewDataEngineRequest {
6135
6209
  RenewFlag?: number
6136
6210
  }
6137
6211
 
6212
+ /**
6213
+ * DescribeTasksAnalysis请求参数结构体
6214
+ */
6215
+ export interface DescribeTasksAnalysisRequest {
6216
+ /**
6217
+ * 数据引擎名称,用于筛选
6218
+ */
6219
+ DataEngineName?: string
6220
+ /**
6221
+ * 返回数量,默认为10,最大值为100。
6222
+ */
6223
+ Limit?: number
6224
+ /**
6225
+ * 偏移量,默认为0。
6226
+ */
6227
+ Offset?: number
6228
+ /**
6229
+ * 过滤条件,如下支持的过滤类型,传参Name应为以下其中一个: task-id - String - (任务ID准确过滤)task-id 取值形如:e386471f-139a-4e59-877f-50ece8135b99。task-state - String - (任务状态过滤)取值范围 0(初始化), 1(运行中), 2(成功), -1(失败),rule-id - String - (洞察类型)取值范围 SPARK-StageScheduleDelay(资源抢占), SPARK-ShuffleFailure(Shuffle异常), SPARK-SlowTask(慢task), SPARK-DataSkew(数据倾斜), SPARK-InsufficientResource(磁盘或内存不足)
6230
+ */
6231
+ Filters?: Array<Filter>
6232
+ /**
6233
+ * 排序字段,支持如下字段类型,instance-start-time (任务开始时间), instance-complete-time (任务结束时间),job-time-sum (单位毫秒,引擎内执行耗时),task-time-sum (CU资源消耗,单位秒),input-bytes-sum(数据扫描总大小,单位bytes),shuffle-read-bytes-sum(数据shuffle总大小,单位bytes)
6234
+ */
6235
+ SortBy?: string
6236
+ /**
6237
+ * 排序方式,desc表示正序,asc表示反序, 默认为asc。
6238
+ */
6239
+ Sorting?: string
6240
+ /**
6241
+ * 起始时间点,格式为yyyy-mm-dd HH:MM:SS
6242
+ */
6243
+ StartTime?: string
6244
+ /**
6245
+ * 结束时间点,格式为yyyy-mm-dd HH:MM:SS时间跨度在(0,30天],支持最近45天数据查询。默认为当前时刻
6246
+ */
6247
+ EndTime?: string
6248
+ }
6249
+
6138
6250
  /**
6139
6251
  * DescribeScripts返回参数结构体
6140
6252
  */
@@ -8232,6 +8344,27 @@ export interface ListTaskJobLogDetailRequest {
8232
8344
  BatchId?: string
8233
8345
  }
8234
8346
 
8347
+ /**
8348
+ * SparkSQL批任务日志操作信息。
8349
+ */
8350
+ export interface SparkSessionBatchLogOperate {
8351
+ /**
8352
+ * 操作提示
8353
+ 注意:此字段可能返回 null,表示取不到有效值。
8354
+ */
8355
+ Text?: string
8356
+ /**
8357
+ * 操作类型:COPY、LOG、UI、RESULT、List、TAB
8358
+ 注意:此字段可能返回 null,表示取不到有效值。
8359
+ */
8360
+ Operate?: string
8361
+ /**
8362
+ * 补充信息:如:taskid、sessionid、sparkui等
8363
+ 注意:此字段可能返回 null,表示取不到有效值。
8364
+ */
8365
+ Supplement?: Array<KVPair>
8366
+ }
8367
+
8235
8368
  /**
8236
8369
  * RevokeDLCCatalogAccess返回参数结构体
8237
8370
  */
@@ -522,6 +522,10 @@ export interface DSPACosMetaDataInfo {
522
522
  * COS桶存储量
523
523
  */
524
524
  Storage?: number
525
+ /**
526
+ * 治理授权状态,0:关闭 1:开启
527
+ */
528
+ GovernAuthStatus?: number
525
529
  }
526
530
 
527
531
  /**
@@ -837,6 +841,11 @@ export interface ReportInfo {
837
841
  注意:此字段可能返回 null,表示取不到有效值。
838
842
  */
839
843
  ProgressPercent?: number
844
+ /**
845
+ * 报告模版名称
846
+ 注意:此字段可能返回 null,表示取不到有效值。
847
+ */
848
+ ReportTemplateName?: string
840
849
  }
841
850
 
842
851
  /**
@@ -1920,14 +1929,6 @@ postgre_like_proto -- Postgre协议类关系型数据库。
1920
1929
  * 自建云资源ID。
1921
1930
  */
1922
1931
  ResourceId: string
1923
- /**
1924
- * 可用于访问自建云资源的IP。
1925
- */
1926
- ResourceVip: string
1927
- /**
1928
- * 可用于访问自建云资源的端口。
1929
- */
1930
- ResourceVPort: number
1931
1932
  /**
1932
1933
  * 自建云资源的VPC ID。
1933
1934
  */
@@ -1943,11 +1944,21 @@ clb - 通过LB的方式进行访问。
1943
1944
  */
1944
1945
  ResourceAccessType: string
1945
1946
  /**
1946
- * 账户名。
1947
+ * 可用于访问自建云资源的IP。
1948
+ emr的连接不需要使用该字段
1949
+ */
1950
+ ResourceVip: string
1951
+ /**
1952
+ * 可用于访问自建云资源的端口。
1953
+ emr的连接不需要使用该字段
1954
+ */
1955
+ ResourceVPort: number
1956
+ /**
1957
+ * 账户名。如果emr_hive的连接方式为“LDAP”,则复用该字段
1947
1958
  */
1948
1959
  UserName: string
1949
1960
  /**
1950
- * 账户密码。
1961
+ * 账户密码。如果emr_hive的连接方式为“LDAP”,则复用该字段
1951
1962
  */
1952
1963
  Password: string
1953
1964
  /**
@@ -1965,6 +1976,10 @@ serviceName
1965
1976
  * 实例值
1966
1977
  */
1967
1978
  InstanceValue?: string
1979
+ /**
1980
+ * 授权范围(all:授权整个数据源 manual:手动指定数据库)
1981
+ */
1982
+ AuthRange?: string
1968
1983
  }
1969
1984
 
1970
1985
  /**
@@ -3118,6 +3133,8 @@ BuildType - cloud(云原生资源)、build(用户自建资源),不支
3118
3133
  MetaType - cdb(云数据Mysql)、dcdb(TDSQL MySQL版)、mariadb(云数据库 MariaDB)、postgres(云数据库 PostgreSQL)、cynosdbmysql(TDSQL-C MySQL版)、cos(对象存储)、mysql_like_proto(自建型Mysql协议类关系型数据库)、postgre_like_proto(自建型Postgre协议类关系型数据库)。
3119
3134
 
3120
3135
  ResourceId - 资源ID,支持模糊搜索。
3136
+
3137
+ CvmID - 自建资源对应CvmId,如:ins-xxxxxxxx。该字段用于casb调用dsgc接口时,根据cvmId和vport确定具体的自建实例
3121
3138
  */
3122
3139
  Filters?: Array<DspaDataSourceMngFilter>
3123
3140
  /**
@@ -5490,6 +5507,14 @@ export interface AuthorizeDSPAMetaResourcesRequest {
5490
5507
  * 用户授权的账户信息,如果是一键自动授权模式,则不需要填写账户名与密码。
5491
5508
  */
5492
5509
  ResourcesAccount: Array<DspaResourceAccount>
5510
+ /**
5511
+ * 创建默认主模板扫描任务
5512
+ */
5513
+ CreateDefaultTask?: boolean
5514
+ /**
5515
+ * 授权范围(all:授权整个数据源 manual:手动指定数据库)
5516
+ */
5517
+ AuthRange?: string
5493
5518
  }
5494
5519
 
5495
5520
  /**
@@ -5673,6 +5698,18 @@ export interface GetUserQuotaInfoResponse {
5673
5698
  * cos月解绑次数
5674
5699
  */
5675
5700
  COSUnbindNum?: number
5701
+ /**
5702
+ * 用户购买的实例配额。
5703
+ */
5704
+ InsTotalQuota?: number
5705
+ /**
5706
+ * 用户可用的实例配额。
5707
+ */
5708
+ InsRemainQuota?: number
5709
+ /**
5710
+ * 用户购买的版本
5711
+ */
5712
+ Version?: string
5676
5713
  /**
5677
5714
  * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
5678
5715
  */
@@ -5994,6 +6031,15 @@ export interface DspaUserResourceMeta {
5994
6031
  注意:此字段可能返回 null,表示取不到有效值。
5995
6032
  */
5996
6033
  InstanceValue?: string
6034
+ /**
6035
+ * //治理授权状态(0:关闭 1:开启)
6036
+ */
6037
+ GovernAuthStatus?: number
6038
+ /**
6039
+ * 授权范围:all - 授权整个数据源 manual:手动指定数据源
6040
+ 注意:此字段可能返回 null,表示取不到有效值。
6041
+ */
6042
+ AuthRange?: string
5997
6043
  }
5998
6044
 
5999
6045
  /**
@@ -6874,6 +6920,16 @@ export interface DspaInstance {
6874
6920
  注意:此字段可能返回 null,表示取不到有效值。
6875
6921
  */
6876
6922
  Channel?: string
6923
+ /**
6924
+ * 已授权的实例数量
6925
+ 注意:此字段可能返回 null,表示取不到有效值。
6926
+ */
6927
+ InsAuthCount?: number
6928
+ /**
6929
+ * 已购买的实例数量
6930
+ 注意:此字段可能返回 null,表示取不到有效值。
6931
+ */
6932
+ InsTotalQuota?: number
6877
6933
  }
6878
6934
 
6879
6935
  /**
@@ -7355,6 +7411,10 @@ UserName和Password必须同时填写或同时为空。
7355
7411
  UserName和Password必须同时填写或同时为空。
7356
7412
  */
7357
7413
  Password: string
7414
+ /**
7415
+ * 授权范围:all 授权全部 manual:手动指定
7416
+ */
7417
+ AuthRange?: string
7358
7418
  }
7359
7419
 
7360
7420
  /**
@@ -3791,7 +3791,7 @@ export interface DescribeInsightListRequest {
3791
3791
  */
3792
3792
  Page: number
3793
3793
  /**
3794
- * 查询类型,支持HIVE,SPARK,MAPREDUCE,TRINO等类型,默认查询全部
3794
+ * 查询类型,支持HIVE,SPARK,DLC_SPARK,SPARK_SQL,SCHEDULE,MAPREDUCE,TRINO等类型,默认查询全部
3795
3795
  */
3796
3796
  Type?: string
3797
3797
  }
@@ -200,6 +200,7 @@ import {
200
200
  DescribeFlowEvidenceReportRequest,
201
201
  FailedCreateRoleData,
202
202
  DescribeBillUsageRequest,
203
+ ExtendScene,
203
204
  DescribeBillUsageResponse,
204
205
  ApproverInfo,
205
206
  CreateFlowSignReviewResponse,
@@ -1249,26 +1250,19 @@ export class Client extends AbstractClient {
1249
1250
  }
1250
1251
 
1251
1252
  /**
1252
- * 管理企业扩展服务 ,企业经办人需要是企业超管或者法人。
1253
+ * 管理企业扩展服务
1253
1254
 
1254
- 跳转小程序的几种方式:主要是设置不同的EndPoint
1255
- 1. 通过链接Url直接跳转到小程序,不需要返回
1256
- 设置EndPoint为WEIXINAPP,得到链接打开即可。
1255
+ - **直接开通的情形:** 若在操作过程中接口没有返回跳转链接,这表明无需进行任何跳转操作。此时,相应的企业拓展服务将会直接被开通或关闭。
1257
1256
 
1258
- 2. 客户App直接跳转到小程序-->腾讯电子签小程序操作完成-->返回App
1259
- 跳转到小程序的实现,参考官方文档<a href="https://developers.weixin.qq.com/miniprogram/dev/framework/open-ability/launchApp.html">打开 App</a>
1260
- 设置EndPoint为APP,得到path。
1257
+ - **需要法人或者超管签署开通协议的情形:** 当需要开通以下企业拓展服务时, 系统将返回一个操作链接。贵方需要主动联系并通知企业的超级管理员(超管)或法人。由他们点击该链接,完成服务的开通操作。
1258
+ - **OPEN_SERVER_SIGN(企业自动签)**
1259
+ - **OVERSEA_SIGN(企业与港澳台居民签署合同)**
1261
1260
 
1262
- 3. 客户小程序直接跳到电子签小程序-->腾讯电子签小程序操作完成--->回到客户小程序
1263
- 跳转到小程序的实现,参考官方文档(分为<a href="https://developers.weixin.qq.com/miniprogram/dev/api/navigate/wx.navigateToMiniProgram.html">全屏</a>、<a href="https://developers.weixin.qq.com/miniprogram/dev/framework/open-ability/openEmbeddedMiniProgram.html">半屏</a>两种方式),如何配置也可以请参考: <a href="https://qian.tencent.com/developers/company/openwxminiprogram">跳转电子签小程序配置</a>
1264
- 设置EndPoint为APP,得到path。
1261
+ 注意: `在调用此接口以管理企业扩展服务时,操作者(入参中的Operator)必须是企业的超级管理员(超管)或法人`
1265
1262
 
1266
- 4.其中小程序的原始Id如下,或者查看小程序信息自助获取。
1267
1263
 
1268
- | 小程序 | AppID | 原始ID |
1269
- | ------------ | ------------ | ------------ |
1270
- | 腾讯电子签(正式版) | wxa023b292fd19d41d | gh_da88f6188665 |
1271
- | 腾讯电子签Demo | wx371151823f6f3edf | gh_39a5d3de69fa |
1264
+ 对应的扩展服务能力可以在控制台的【扩展服务】中找到
1265
+ ![image](https://qcloudimg.tencent-cloud.cn/raw/7eb35d2473d6c29784f3b35617bca9a9.png)
1272
1266
  */
1273
1267
  async ModifyExtendedService(
1274
1268
  req: ModifyExtendedServiceRequest,
@@ -1353,8 +1347,15 @@ export class Client extends AbstractClient {
1353
1347
  }
1354
1348
 
1355
1349
  /**
1356
- * 用于客户企业在调用生成[C端用户实名链接(CreateUserVerifyUrl)](https://qian.tencent.com/developers/companyApis/users/CreateUserVerifyUrl)接口之前判断C端用户是否实名,如果已经实名,就不需要再次调用生成C端链接接口去实名
1357
- 注意:此接口仅会返回当前员工是否通过[C端用户实名链接(CreateUserVerifyUrl)](https://qian.tencent.com/developers/companyApis/users/CreateUserVerifyUrl)所实名的员工是否实名,并不会返回个人用户自己在电子签进行实名的状况
1350
+ * 检测个人用户是否已经实名。
1351
+
1352
+ 在调用生成C端用户实名链接([CreateUserVerifyUrl](https://qian.tencent.com/developers/companyApis/users/CreateUserVerifyUrl))接口之前,客户企业应首先调用本接口判断C端用户是否已经完成实名认证。如果用户已经实名,那么无需再次调用([CreateUserVerifyUrl](https://qian.tencent.com/developers/companyApis/users/CreateUserVerifyUrl))生成链接并走实名认证流程。
1353
+
1354
+ 注意:
1355
+
1356
+ - 此接口<font color="red">仅用于确认通过本公司生成[C端用户实名链接(CreateUserVerifyUrl)](https://qian.tencent.com/developers/companyApis/users/CreateUserVerifyUrl)接口注册认证的用户,不包括其他途径(如主动注册认证、在签署合同中注册认证等)在电子签平台上进行的实名认证</font>。
1357
+
1358
+ - 调用此接口需要购买单独的实名套餐包。<font color="red">使用前请联系对接的客户经理沟通</font>。
1358
1359
  */
1359
1360
  async DescribeUserVerifyStatus(
1360
1361
  req: DescribeUserVerifyStatusRequest,
@@ -1589,8 +1590,20 @@ httpProfile.setEndpoint("file.test.ess.tencent.cn");
1589
1590
  }
1590
1591
 
1591
1592
  /**
1592
- * 此接口(CreateDynamicFlowApprover)用来补充动态合同的签署人信息。<br/>
1593
- 适用场景:使用CreateFlowByFiles指定:OpenDynamicSignFlow=true发起的合同,可以使用该接口补充后续签署人。<br/>
1593
+ * 此接口(CreateDynamicFlowApprover)接口主要用于补充动态签署方2.0合同的签署方信息,包括但不限于名字、手机号和签署区域等信息。
1594
+
1595
+
1596
+ **功能开通**
1597
+ 动态签署方2.0功能的使用需要先<font color="red">联系产品经理开通模块化计费功能</font>,然后到控制台中打开此功能。详细的使用说明请参考<a href="https://qian.tencent.com/developers/company/dynamic_signer_v2" target="_blank">动态签署方2.0</a>文档。
1598
+
1599
+ **使用条件**
1600
+ - 在发起合同时,必须将OpenDynamicSignFlow参数设置为true,以确保合同以动态签署方2.0的方式处理,否则默认处理为普通合同。
1601
+ - 此接口只能在合同处于非终态时调用。一旦合同进入终态(例如:过期、拒签或撤销),将无法通过此接口添加新的签署方。
1602
+
1603
+
1604
+ 动态签署方2.0合同<font color="red">不会自动结束(整个合同变为签署完成)</font>,需要通过调用<a href="https://qian.tencent.com/developers/companyApis/operateFlows/ArchiveDynamicFlow/" target="_blank">结束动态签署合同</a>来手动结束签署流程。整体的流程如下图
1605
+
1606
+ ![image](https://qcloudimg.tencent-cloud.cn/raw/75d323c66e44b05bbc8e949c18664455.png)
1594
1607
  */
1595
1608
  async CreateDynamicFlowApprover(
1596
1609
  req: CreateDynamicFlowApproverRequest,
@@ -1760,7 +1773,7 @@ httpProfile.setEndpoint("file.test.ess.tencent.cn");
1760
1773
 
1761
1774
  ![image](https://qcloudimg.tencent-cloud.cn/raw/b2715f0236faee807cfc0521f93cf01b.png)
1762
1775
 
1763
- <b><font color="red">2. 动态签署人合同</font>: 若未指定具体签署人的信息,则合同变成动态签署人合同</b>。需调用此接口补充或添加签署人。可以参考文档 [动态签署人合同](https://qian.tencent.com/developers/company/dynamic_signer/) 。动态签署人在控制台上的展示样式如下:
1776
+ <b><font color="red">2. 动态签署人合同</font>: 若未指定具体签署人的信息,则合同变成动态签署人合同</b>。需调用此接口补充或添加签署人。可以参考文档 <a href="https://qian.tencent.com/developers/company/dynamic_signer/" target="_blank">动态签署人合同</a> 。动态签署人在控制台上的展示样式如下:
1764
1777
 
1765
1778
  ![image](https://qcloudimg.tencent-cloud.cn/raw/2729477978e020c3bbb4d2e767bb78eb.png)
1766
1779
 
@@ -1891,8 +1904,18 @@ httpProfile.setEndpoint("file.test.ess.tencent.cn");
1891
1904
  }
1892
1905
 
1893
1906
  /**
1894
- * 该接口用于结束动态签署流程,若当前合同还存在签署方未签署,无法结束。
1895
- */
1907
+ * 该接口用于结束动态签署方2.0的合同流程。
1908
+
1909
+
1910
+ **功能开通**
1911
+ - 动态签署方2.0功能的使用需要先<font color="red">联系产品经理开通模块化计费功能</font>,然后到控制台中打开此功能。详细的使用说明请参考<a href="https://qian.tencent.com/developers/company/dynamic_signer_v2" target="_blank">动态签署方2.0</a>文档。
1912
+
1913
+ **使用条件**
1914
+ - 此接口只能在<font color="red">合同处于非终态且<b>所有的签署方都已经完成签署</b></font>。一旦合同进入终态(例如:过期、拒签、撤销或者调用过此接口成功过),将无法通过此接口结束合同流程。
1915
+
1916
+ **整体流程**
1917
+ ![image](https://qcloudimg.tencent-cloud.cn/raw/75d323c66e44b05bbc8e949c18664455.png)
1918
+ */
1896
1919
  async ArchiveDynamicFlow(
1897
1920
  req: ArchiveDynamicFlowRequest,
1898
1921
  cb?: (error: string, rep: ArchiveDynamicFlowResponse) => void