tencentcloud-sdk-nodejs 4.0.751 → 4.0.753

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 (60) hide show
  1. package/CHANGELOG.md +275 -0
  2. package/SERVICE_CHANGELOG.md +321 -34
  3. package/examples/hunyuan/v20230901/chat_std.js +40 -0
  4. package/examples/hunyuan/v20230901/chat_std.ts +42 -0
  5. package/package.json +1 -1
  6. package/products.md +18 -18
  7. package/src/common/sdk_version.ts +1 -1
  8. package/src/services/bi/v20220105/bi_models.ts +17 -0
  9. package/src/services/clb/v20180317/clb_models.ts +1 -2
  10. package/src/services/cls/v20201016/cls_models.ts +4 -3
  11. package/src/services/cynosdb/v20190107/cynosdb_models.ts +5 -0
  12. package/src/services/dc/v20180410/dc_client.ts +1 -1
  13. package/src/services/dc/v20180410/dc_models.ts +25 -32
  14. package/src/services/dlc/v20210125/dlc_models.ts +48 -38
  15. package/src/services/ess/v20201111/ess_models.ts +2 -2
  16. package/src/services/essbasic/v20210526/essbasic_models.ts +2 -115
  17. package/src/services/faceid/v20180301/faceid_client.ts +15 -3
  18. package/src/services/faceid/v20180301/faceid_models.ts +123 -73
  19. package/src/services/gme/v20180711/gme_client.ts +7 -3
  20. package/src/services/monitor/v20180724/monitor_client.ts +3 -3
  21. package/src/services/monitor/v20180724/monitor_models.ts +30 -30
  22. package/src/services/mps/v20190612/mps_client.ts +7 -2
  23. package/src/services/mps/v20190612/mps_models.ts +162 -68
  24. package/src/services/privatedns/v20201028/privatedns_models.ts +18 -0
  25. package/src/services/teo/v20220901/teo_client.ts +22 -9
  26. package/src/services/teo/v20220901/teo_models.ts +133 -52
  27. package/src/services/tmt/v20180321/tmt_models.ts +28 -28
  28. package/src/services/waf/v20180125/waf_client.ts +1 -0
  29. package/src/services/waf/v20180125/waf_models.ts +89 -18
  30. package/src/services/wedata/v20210820/wedata_models.ts +16 -0
  31. package/tencentcloud/common/sdk_version.d.ts +1 -1
  32. package/tencentcloud/common/sdk_version.js +1 -1
  33. package/tencentcloud/services/bi/v20220105/bi_models.d.ts +17 -0
  34. package/tencentcloud/services/clb/v20180317/clb_models.d.ts +1 -2
  35. package/tencentcloud/services/cls/v20201016/cls_models.d.ts +4 -3
  36. package/tencentcloud/services/cynosdb/v20190107/cynosdb_models.d.ts +5 -0
  37. package/tencentcloud/services/dc/v20180410/dc_client.d.ts +1 -1
  38. package/tencentcloud/services/dc/v20180410/dc_client.js +1 -1
  39. package/tencentcloud/services/dc/v20180410/dc_models.d.ts +25 -32
  40. package/tencentcloud/services/dlc/v20210125/dlc_models.d.ts +48 -38
  41. package/tencentcloud/services/ess/v20201111/ess_models.d.ts +2 -2
  42. package/tencentcloud/services/essbasic/v20210526/essbasic_models.d.ts +2 -115
  43. package/tencentcloud/services/faceid/v20180301/faceid_client.d.ts +5 -1
  44. package/tencentcloud/services/faceid/v20180301/faceid_client.js +6 -0
  45. package/tencentcloud/services/faceid/v20180301/faceid_models.d.ts +121 -73
  46. package/tencentcloud/services/gme/v20180711/gme_client.d.ts +6 -2
  47. package/tencentcloud/services/gme/v20180711/gme_client.js +6 -2
  48. package/tencentcloud/services/monitor/v20180724/monitor_client.d.ts +3 -3
  49. package/tencentcloud/services/monitor/v20180724/monitor_client.js +3 -3
  50. package/tencentcloud/services/monitor/v20180724/monitor_models.d.ts +30 -30
  51. package/tencentcloud/services/mps/v20190612/mps_models.d.ts +157 -68
  52. package/tencentcloud/services/privatedns/v20201028/privatedns_models.d.ts +18 -0
  53. package/tencentcloud/services/teo/v20220901/teo_client.d.ts +7 -3
  54. package/tencentcloud/services/teo/v20220901/teo_client.js +9 -3
  55. package/tencentcloud/services/teo/v20220901/teo_models.d.ts +130 -52
  56. package/tencentcloud/services/tmt/v20180321/tmt_models.d.ts +28 -28
  57. package/tencentcloud/services/waf/v20180125/waf_models.d.ts +88 -18
  58. package/tencentcloud/services/wedata/v20210820/wedata_models.d.ts +16 -0
  59. package/test/faceid.v20180301.test.js +10 -0
  60. package/test/teo.v20220901.test.js +12 -2
@@ -972,7 +972,7 @@ export interface CreateFlowOption {
972
972
  **true**:跳过
973
973
  **false**:(默认)不跳过,需要传ResourceId
974
974
  */
975
- SkipUploadFile?: string
975
+ SkipUploadFile?: boolean
976
976
  }
977
977
 
978
978
  /**
@@ -3785,119 +3785,6 @@ export interface DescribeChannelSealPolicyWorkflowUrlRequest {
3785
3785
 
3786
3786
  /**
3787
3787
  * 此结构体 (FlowInfo) 用于描述签署流程信息。
3788
-
3789
- 【数据表格传参说明】
3790
- 当模板的 ComponentType='DYNAMIC_TABLE'时( 第三方应用集成或集成版),FormField.ComponentValue需要传递json格式的字符串参数,用于确定表头&填充数据表格(支持内容的单元格合并)
3791
- 输入示例1:
3792
-
3793
- ```
3794
- {
3795
- "headers":[
3796
- {
3797
- "content":"head1"
3798
- },
3799
- {
3800
- "content":"head2"
3801
- },
3802
- {
3803
- "content":"head3"
3804
- }
3805
- ],
3806
- "rowCount":3,
3807
- "body":{
3808
- "cells":[
3809
- {
3810
- "rowStart":1,
3811
- "rowEnd":1,
3812
- "columnStart":1,
3813
- "columnEnd":1,
3814
- "content":"123"
3815
- },
3816
- {
3817
- "rowStart":2,
3818
- "rowEnd":3,
3819
- "columnStart":1,
3820
- "columnEnd":2,
3821
- "content":"456"
3822
- },
3823
- {
3824
- "rowStart":3,
3825
- "rowEnd":3,
3826
- "columnStart":3,
3827
- "columnEnd":3,
3828
- "content":"789"
3829
- }
3830
- ]
3831
- }
3832
- }
3833
-
3834
- ```
3835
-
3836
- 输入示例2(表格表头宽度比例配置):
3837
-
3838
- ```
3839
- {
3840
- "headers":[
3841
- {
3842
- "content":"head1",
3843
- "widthPercent": 30
3844
- },
3845
- {
3846
- "content":"head2",
3847
- "widthPercent": 30
3848
- },
3849
- {
3850
- "content":"head3",
3851
- "widthPercent": 40
3852
- }
3853
- ],
3854
- "rowCount":3,
3855
- "body":{
3856
- "cells":[
3857
- {
3858
- "rowStart":1,
3859
- "rowEnd":1,
3860
- "columnStart":1,
3861
- "columnEnd":1,
3862
- "content":"123"
3863
- },
3864
- {
3865
- "rowStart":2,
3866
- "rowEnd":3,
3867
- "columnStart":1,
3868
- "columnEnd":2,
3869
- "content":"456"
3870
- },
3871
- {
3872
- "rowStart":3,
3873
- "rowEnd":3,
3874
- "columnStart":3,
3875
- "columnEnd":3,
3876
- "content":"789"
3877
- }
3878
- ]
3879
- }
3880
- }
3881
-
3882
- ```
3883
- 表格参数说明
3884
-
3885
- | 名称 | 类型 | 描述 |
3886
- | ------------------- | ------- | ------------------------------------------------- |
3887
- | headers | Array | 表头:不超过10列,不支持单元格合并,字数不超过100 |
3888
- | rowCount | Integer | 表格内容最大行数 |
3889
- | cells.N.rowStart | Integer | 单元格坐标:行起始index |
3890
- | cells.N.rowEnd | Integer | 单元格坐标:行结束index |
3891
- | cells.N.columnStart | Integer | 单元格坐标:列起始index |
3892
- | cells.N.columnEnd | Integer | 单元格坐标:列结束index |
3893
- | cells.N.content | String | 单元格内容,字数不超过100 |
3894
-
3895
- 表格参数headers说明
3896
-
3897
- | 名称 | 类型 | 描述 |
3898
- | ------------------- | ------- | ------------------------------------------------- |
3899
- | widthPercent | Integer | 表头单元格列占总表头的比例,例如1:30表示 此列占表头的30%,不填写时列宽度平均拆分;例如2:总2列,某一列填写40,剩余列可以为空,按照60计算。;例如3:总3列,某一列填写30,剩余2列可以为空,分别为(100-30)/2=35 |
3900
- | content | String | 表头单元格内容,字数不超过100 |
3901
3788
  */
3902
3789
  export interface FlowInfo {
3903
3790
  /**
@@ -7078,7 +6965,7 @@ export interface ChannelCreateEmbedWebUrlRequest {
7078
6965
  * 用户自定义参数
7079
6966
  <ul>
7080
6967
  <li>目前仅支持EmbedType=CREATE_TEMPLATE时传入</li>
7081
- <li>指定后,创建,编辑,删除模版时,回调都会携带该userData</li>
6968
+ <li>指定后,创建,编辑,删除模板时,回调都会携带该userData</li>
7082
6969
  <li>支持的格式:json字符串的BASE64编码字符串</li>
7083
6970
  <li>示例:<ul>
7084
6971
  <li>json字符串:{"ComeFrom":"xxx"},BASE64编码:eyJDb21lRnJvbSI6Inh4eCJ9</li>
@@ -21,6 +21,7 @@ import {
21
21
  AttackRiskDetail,
22
22
  CheckIdNameDateResponse,
23
23
  IdCardVerificationRequest,
24
+ ImageRecognitionV2Response,
24
25
  GetDetectInfoEnhancedResponse,
25
26
  IntentionQuestionResult,
26
27
  RuleIdConfig,
@@ -66,7 +67,7 @@ import {
66
67
  Encryption,
67
68
  MobileNetworkTimeVerificationRequest,
68
69
  PhoneVerificationCMCCResponse,
69
- LivenessRecognitionResponse,
70
+ MobileNetworkTimeVerificationResponse,
70
71
  PhoneVerificationCUCCResponse,
71
72
  CheckIdCardInformationRequest,
72
73
  GetEidTokenConfig,
@@ -78,9 +79,10 @@ import {
78
79
  DetectInfoText,
79
80
  ImageRecognitionResponse,
80
81
  GetDetectInfoResponse,
82
+ IdCardOCRVerificationResponse,
81
83
  IdCardVerificationResponse,
82
84
  GetDetectInfoEnhancedRequest,
83
- MobileNetworkTimeVerificationResponse,
85
+ LivenessRecognitionResponse,
84
86
  GetLiveCodeRequest,
85
87
  GetEidResultResponse,
86
88
  WeChatBillDetail,
@@ -90,7 +92,7 @@ import {
90
92
  GetFaceIdTokenRequest,
91
93
  IntentionActionResult,
92
94
  BankCard2EVerificationRequest,
93
- IdCardOCRVerificationResponse,
95
+ ImageRecognitionV2Request,
94
96
  PhoneVerificationCTCCResponse,
95
97
  ChargeDetail,
96
98
  ParseNfcDataRequest,
@@ -226,6 +228,16 @@ export class Client extends AbstractClient {
226
228
  return this.request("BankCardVerification", req, cb)
227
229
  }
228
230
 
231
+ /**
232
+ * 传入照片和身份信息,判断该照片与权威库的证件照是否属于同一个人。
233
+ */
234
+ async ImageRecognitionV2(
235
+ req: ImageRecognitionV2Request,
236
+ cb?: (error: string, rep: ImageRecognitionV2Response) => void
237
+ ): Promise<ImageRecognitionV2Response> {
238
+ return this.request("ImageRecognitionV2", req, cb)
239
+ }
240
+
229
241
  /**
230
242
  * 传入视频和照片,先判断视频中是否为真人,判断为真人后,再判断该视频中的人与上传照片是否属于同一个人。
231
243
  */
@@ -79,6 +79,28 @@ export interface IdCardVerificationRequest {
79
79
  Encryption?: Encryption
80
80
  }
81
81
 
82
+ /**
83
+ * ImageRecognitionV2返回参数结构体
84
+ */
85
+ export interface ImageRecognitionV2Response {
86
+ /**
87
+ * 相似度,取值范围 [0.00, 100.00]。推荐相似度大于等于70时可判断为同一人,可根据具体场景自行调整阈值(阈值70的误通过率为千分之一,阈值80的误通过率是万分之一)
88
+ */
89
+ Sim?: number
90
+ /**
91
+ * 业务错误码,成功情况返回Success, 错误情况请参考下方错误码 列表中FailedOperation部分
92
+ */
93
+ Result?: string
94
+ /**
95
+ * 业务结果描述。
96
+ */
97
+ Description?: string
98
+ /**
99
+ * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
100
+ */
101
+ RequestId?: string
102
+ }
103
+
82
104
  /**
83
105
  * GetDetectInfoEnhanced返回参数结构体
84
106
  */
@@ -1567,31 +1589,29 @@ export interface PhoneVerificationCMCCResponse {
1567
1589
  }
1568
1590
 
1569
1591
  /**
1570
- * LivenessRecognition返回参数结构体
1592
+ * MobileNetworkTimeVerification返回参数结构体
1571
1593
  */
1572
- export interface LivenessRecognitionResponse {
1573
- /**
1574
- * 验证通过后的视频最佳截图照片,照片为BASE64编码后的值,jpg格式。
1575
- 注意:此字段可能返回 null,表示取不到有效值。
1576
- */
1577
- BestFrameBase64?: string
1578
- /**
1579
- * 相似度,取值范围 [0.00, 100.00]。推荐相似度大于等于70时可判断为同一人,可根据具体场景自行调整阈值(阈值70的误通过率为千分之一,阈值80的误通过率是万分之一)
1580
- */
1581
- Sim?: number
1594
+ export interface MobileNetworkTimeVerificationResponse {
1582
1595
  /**
1583
- * 业务错误码,成功情况返回Success, 错误情况请参考下方错误码 列表中FailedOperation部分
1596
+ * 认证结果码,收费情况如下。
1597
+ 收费结果码:
1598
+ 0: 成功
1599
+ -2: 手机号不存在
1600
+ -3: 手机号存在,但无法查询到在网时长
1601
+ 不收费结果码:
1602
+ -1: 手机号格式不正确
1603
+ -4: 验证中心服务繁忙
1584
1604
  */
1585
- Result?: string
1605
+ Result: string
1586
1606
  /**
1587
1607
  * 业务结果描述。
1588
1608
  */
1589
- Description?: string
1609
+ Description: string
1590
1610
  /**
1591
- * 最佳截图列表,仅在配置了返回多张最佳截图时返回。
1592
- 注意:此字段可能返回 null,表示取不到有效值。
1611
+ * 在网时长区间。
1612
+ 格式为(a,b],表示在网时长在a个月以上,b个月以下。若b为+时表示没有上限。
1593
1613
  */
1594
- BestFrameList?: Array<string>
1614
+ Range: string
1595
1615
  /**
1596
1616
  * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
1597
1617
  */
@@ -2103,6 +2123,62 @@ export interface GetDetectInfoResponse {
2103
2123
  RequestId?: string
2104
2124
  }
2105
2125
 
2126
+ /**
2127
+ * IdCardOCRVerification返回参数结构体
2128
+ */
2129
+ export interface IdCardOCRVerificationResponse {
2130
+ /**
2131
+ * 认证结果码,收费情况如下。
2132
+ 收费结果码:
2133
+ 0: 姓名和身份证号一致
2134
+ -1: 姓名和身份证号不一致
2135
+ 不收费结果码:
2136
+ -2: 非法身份证号(长度、校验位等不正确)
2137
+ -3: 非法姓名(长度、格式等不正确)
2138
+ -4: 证件库服务异常
2139
+ -5: 证件库中无此身份证记录
2140
+ -6: 权威比对系统升级中,请稍后再试
2141
+ -7: 认证次数超过当日限制
2142
+ */
2143
+ Result: string
2144
+ /**
2145
+ * 业务结果描述。
2146
+ */
2147
+ Description: string
2148
+ /**
2149
+ * 用于验证的姓名
2150
+ */
2151
+ Name: string
2152
+ /**
2153
+ * 用于验证的身份证号
2154
+ */
2155
+ IdCard: string
2156
+ /**
2157
+ * OCR得到的性别
2158
+ 注意:此字段可能返回 null,表示取不到有效值。
2159
+ */
2160
+ Sex: string
2161
+ /**
2162
+ * OCR得到的民族
2163
+ 注意:此字段可能返回 null,表示取不到有效值。
2164
+ */
2165
+ Nation: string
2166
+ /**
2167
+ * OCR得到的生日
2168
+ 注意:此字段可能返回 null,表示取不到有效值。
2169
+ */
2170
+ Birth: string
2171
+ /**
2172
+ * OCR得到的地址
2173
+ 注意:此字段可能返回 null,表示取不到有效值。
2174
+ */
2175
+ Address: string
2176
+ /**
2177
+ * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
2178
+ */
2179
+ RequestId?: string
2180
+ }
2181
+
2106
2182
  /**
2107
2183
  * IdCardVerification返回参数结构体
2108
2184
  */
@@ -2176,29 +2252,31 @@ export interface GetDetectInfoEnhancedRequest {
2176
2252
  }
2177
2253
 
2178
2254
  /**
2179
- * MobileNetworkTimeVerification返回参数结构体
2255
+ * LivenessRecognition返回参数结构体
2180
2256
  */
2181
- export interface MobileNetworkTimeVerificationResponse {
2257
+ export interface LivenessRecognitionResponse {
2182
2258
  /**
2183
- * 认证结果码,收费情况如下。
2184
- 收费结果码:
2185
- 0: 成功
2186
- -2: 手机号不存在
2187
- -3: 手机号存在,但无法查询到在网时长
2188
- 不收费结果码:
2189
- -1: 手机号格式不正确
2190
- -4: 验证中心服务繁忙
2259
+ * 验证通过后的视频最佳截图照片,照片为BASE64编码后的值,jpg格式。
2260
+ 注意:此字段可能返回 null,表示取不到有效值。
2191
2261
  */
2192
- Result: string
2262
+ BestFrameBase64?: string
2263
+ /**
2264
+ * 相似度,取值范围 [0.00, 100.00]。推荐相似度大于等于70时可判断为同一人,可根据具体场景自行调整阈值(阈值70的误通过率为千分之一,阈值80的误通过率是万分之一)
2265
+ */
2266
+ Sim?: number
2267
+ /**
2268
+ * 业务错误码,成功情况返回Success, 错误情况请参考下方错误码 列表中FailedOperation部分
2269
+ */
2270
+ Result?: string
2193
2271
  /**
2194
2272
  * 业务结果描述。
2195
2273
  */
2196
- Description: string
2274
+ Description?: string
2197
2275
  /**
2198
- * 在网时长区间。
2199
- 格式为(a,b],表示在网时长在a个月以上,b个月以下。若b为+时表示没有上限。
2276
+ * 最佳截图列表,仅在配置了返回多张最佳截图时返回。
2277
+ 注意:此字段可能返回 null,表示取不到有效值。
2200
2278
  */
2201
- Range: string
2279
+ BestFrameList?: Array<string>
2202
2280
  /**
2203
2281
  * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
2204
2282
  */
@@ -2449,59 +2527,31 @@ export interface BankCard2EVerificationRequest {
2449
2527
  }
2450
2528
 
2451
2529
  /**
2452
- * IdCardOCRVerification返回参数结构体
2530
+ * ImageRecognitionV2请求参数结构体
2453
2531
  */
2454
- export interface IdCardOCRVerificationResponse {
2455
- /**
2456
- * 认证结果码,收费情况如下。
2457
- 收费结果码:
2458
- 0: 姓名和身份证号一致
2459
- -1: 姓名和身份证号不一致
2460
- 不收费结果码:
2461
- -2: 非法身份证号(长度、校验位等不正确)
2462
- -3: 非法姓名(长度、格式等不正确)
2463
- -4: 证件库服务异常
2464
- -5: 证件库中无此身份证记录
2465
- -6: 权威比对系统升级中,请稍后再试
2466
- -7: 认证次数超过当日限制
2467
- */
2468
- Result: string
2532
+ export interface ImageRecognitionV2Request {
2469
2533
  /**
2470
- * 业务结果描述。
2471
- */
2472
- Description: string
2473
- /**
2474
- * 用于验证的姓名
2475
- */
2476
- Name: string
2477
- /**
2478
- * 用于验证的身份证号
2534
+ * 身份证号
2479
2535
  */
2480
2536
  IdCard: string
2481
2537
  /**
2482
- * OCR得到的性别
2483
- 注意:此字段可能返回 null,表示取不到有效值。
2484
- */
2485
- Sex: string
2486
- /**
2487
- * OCR得到的民族
2488
- 注意:此字段可能返回 null,表示取不到有效值。
2538
+ * 姓名。中文请使用UTF-8编码。
2489
2539
  */
2490
- Nation: string
2540
+ Name: string
2491
2541
  /**
2492
- * OCR得到的生日
2493
- 注意:此字段可能返回 null,表示取不到有效值。
2542
+ * 用于人脸比对的照片,图片的Base64值;
2543
+ Base64编码后的图片数据大小不超过3M,仅支持jpg、png格式。
2544
+ 请使用标准的Base64编码方式(带=补位),编码规范参考RFC4648。
2494
2545
  */
2495
- Birth: string
2546
+ ImageBase64: string
2496
2547
  /**
2497
- * OCR得到的地址
2498
- 注意:此字段可能返回 null,表示取不到有效值。
2548
+ * 本接口不需要传递此参数。
2499
2549
  */
2500
- Address: string
2550
+ Optional?: string
2501
2551
  /**
2502
- * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
2552
+ * 敏感数据加密信息。对传入信息(姓名、身份证号)有加密需求的用户可使用此参数,详情请点击左侧链接。
2503
2553
  */
2504
- RequestId?: string
2554
+ Encryption?: Encryption
2505
2555
  }
2506
2556
 
2507
2557
  /**
@@ -215,7 +215,9 @@ export class Client extends AbstractClient {
215
215
  }
216
216
 
217
217
  /**
218
- * 用于创建年龄语音识别任务的接口,请求频率10次/秒。该接口目前通过白名单开放试用,如有需求,请提交工单申请。
218
+ * 目前该功能底层能力已不具备,不对外提供,目前需要下线,走预下线流程。
219
+
220
+ 用于创建年龄语音识别任务的接口,请求频率10次/秒。该接口目前通过白名单开放试用,如有需求,请提交工单申请。
219
221
  </br>
220
222
  <h4><b>接口功能说明:</b></h4>
221
223
  <li>支持对语音文件进行检测,判断是否为未成年人。</li>
@@ -543,8 +545,10 @@ export class Client extends AbstractClient {
543
545
  }
544
546
 
545
547
  /**
546
- * 查询年龄语音识别任务结果,请求频率10次/秒。该接口目前通过白名单开放试用,如有需求,请提交工单申请。
547
- */
548
+ * 目前该功能底层能力已不具备,不对外提供,目前需要下线,走预下线流程。
549
+
550
+ 查询年龄语音识别任务结果,请求频率10次/秒。该接口目前通过白名单开放试用,如有需求,请提交工单申请。
551
+ */
548
552
  async DescribeAgeDetectTask(
549
553
  req: DescribeAgeDetectTaskRequest,
550
554
  cb?: (error: string, rep: DescribeAgeDetectTaskResponse) => void
@@ -496,7 +496,7 @@ export class Client extends AbstractClient {
496
496
  }
497
497
 
498
498
  /**
499
- * 更新 Prometheus 的报警规则。
499
+ * 更新 Prometheus 的告警规则。
500
500
 
501
501
  请注意,**告警对象和告警消息是 Prometheus Rule Annotations 的特殊字段,需要通过 annotations 来传递,对应的 Key 分别为summary/description**,,请参考 [Prometheus Rule更多配置请参考](https://prometheus.io/docs/prometheus/latest/configuration/alerting_rules/)。
502
502
  */
@@ -900,7 +900,7 @@ export class Client extends AbstractClient {
900
900
  }
901
901
 
902
902
  /**
903
- * 更新 Prometheus 抓取任务
903
+ * 更新 Prometheus Agent 抓取任务
904
904
  */
905
905
  async UpdatePrometheusScrapeJob(
906
906
  req: UpdatePrometheusScrapeJobRequest,
@@ -1325,7 +1325,7 @@ export class Client extends AbstractClient {
1325
1325
  }
1326
1326
 
1327
1327
  /**
1328
- * 查询 exporter 集成列表
1328
+ * 查询集成中心 exporter 集成列表
1329
1329
  */
1330
1330
  async DescribeExporterIntegrations(
1331
1331
  req: DescribeExporterIntegrationsRequest,
@@ -1882,7 +1882,7 @@ export interface UpdateAlertRuleResponse {
1882
1882
  /**
1883
1883
  * 规则 ID
1884
1884
  */
1885
- RuleId: string
1885
+ RuleId?: string
1886
1886
  /**
1887
1887
  * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
1888
1888
  */
@@ -2856,11 +2856,11 @@ export interface UpdateRecordingRuleRequest {
2856
2856
  */
2857
2857
  Group: string
2858
2858
  /**
2859
- * Prometheus 实例 ID
2859
+ * Prometheus 实例 ID(可通过 DescribePrometheusInstances 接口获取)
2860
2860
  */
2861
2861
  InstanceId: string
2862
2862
  /**
2863
- * Prometheus 聚合规则 ID
2863
+ * Prometheus 聚合规则 ID(可通过 DescribeRecordingRules 接口获取)
2864
2864
  */
2865
2865
  RuleId: string
2866
2866
  /**
@@ -3852,18 +3852,18 @@ export interface DescribeExporterIntegrationsRequest {
3852
3852
  */
3853
3853
  InstanceId: string
3854
3854
  /**
3855
- * Kubernetes 集群类型,取值如下:
3855
+ * Kubernetes 集群类型,可不填。取值如下:
3856
3856
  <li> 1= 容器集群(TKE) </li>
3857
- <li> 2=弹性集群<EKS> </li>
3858
- <li> 3= Prometheus管理的弹性集群<MEKS> </li>
3857
+ <li> 2=弹性集群(EKS) </li>
3858
+ <li> 3= Prometheus管理的弹性集群(MEKS) </li>
3859
3859
  */
3860
3860
  KubeType?: number
3861
3861
  /**
3862
- * 集群 ID
3862
+ * 集群 ID,可不填
3863
3863
  */
3864
3864
  ClusterId?: string
3865
3865
  /**
3866
- * 类型
3866
+ * 类型(不填返回全部集成。可通过 DescribePrometheusIntegrations 接口获取,取每一项中的 ExporterType 字段)
3867
3867
  */
3868
3868
  Kind?: string
3869
3869
  /**
@@ -4073,19 +4073,19 @@ export interface DescribePrometheusClusterAgentsResponse {
4073
4073
  */
4074
4074
  export interface UpdatePrometheusScrapeJobRequest {
4075
4075
  /**
4076
- * Prometheus 实例 ID,例如:prom-abcd1234
4076
+ * Prometheus 实例 ID(可通过 DescribePrometheusInstances 接口获取)
4077
4077
  */
4078
4078
  InstanceId: string
4079
4079
  /**
4080
- * Agent ID,例如:agent-abcd1234,可在控制台 Agent 管理中获取
4080
+ * Agent ID(可通过DescribePrometheusAgents 接口获取)
4081
4081
  */
4082
4082
  AgentId: string
4083
4083
  /**
4084
- * 抓取任务 ID,例如:job-abcd1234,可在控制台 Agent 管理-抓取任务配置中获取
4084
+ * 抓取任务 ID(可通过 DescribePrometheusScrapeJobs 接口获取)
4085
4085
  */
4086
4086
  JobId: string
4087
4087
  /**
4088
- * 抓取任务配置,格式:job_name:xx
4088
+ * 抓取任务配置
4089
4089
  */
4090
4090
  Config: string
4091
4091
  }
@@ -4095,15 +4095,15 @@ export interface UpdatePrometheusScrapeJobRequest {
4095
4095
  */
4096
4096
  export interface PrometheusAgentInfo {
4097
4097
  /**
4098
- * 集群类型
4098
+ * 集群类型。可填入tke、eks、tkeedge、tdcc,分别代表标准集群、弹性集群、边缘集群、注册集群
4099
4099
  */
4100
4100
  ClusterType: string
4101
4101
  /**
4102
- * 集群id
4102
+ * 集成容器服务中关联的集群ID
4103
4103
  */
4104
4104
  ClusterId: string
4105
4105
  /**
4106
- * 备注
4106
+ * 该参数未使用,不需要填写
4107
4107
  */
4108
4108
  Describe?: string
4109
4109
  }
@@ -4240,7 +4240,7 @@ export interface UpdateRecordingRuleResponse {
4240
4240
  * 规则 ID
4241
4241
  注意:此字段可能返回 null,表示取不到有效值。
4242
4242
  */
4243
- RuleId: string
4243
+ RuleId?: string
4244
4244
  /**
4245
4245
  * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
4246
4246
  */
@@ -4369,7 +4369,7 @@ export interface CreateGrafanaInstanceResponse {
4369
4369
  */
4370
4370
  export interface UpdateAlertRuleRequest {
4371
4371
  /**
4372
- * Prometheus 报警规则 ID
4372
+ * Prometheus 高警规则 ID
4373
4373
  */
4374
4374
  RuleId: string
4375
4375
  /**
@@ -4385,19 +4385,19 @@ export interface UpdateAlertRuleRequest {
4385
4385
  */
4386
4386
  RuleState: number
4387
4387
  /**
4388
- * 报警规则名称
4388
+ * 告警规则名称
4389
4389
  */
4390
4390
  RuleName: string
4391
4391
  /**
4392
- * 报警规则表达式
4392
+ * 告警规则表达式
4393
4393
  */
4394
4394
  Expr: string
4395
4395
  /**
4396
- * 报警规则持续时间
4396
+ * 告警规则持续时间
4397
4397
  */
4398
4398
  Duration: string
4399
4399
  /**
4400
- * 报警规则接收组列表
4400
+ * 告警规则接收组列表(当前规则绑定的接收组列表可通过 DescribeAlertRules 接口获取;用户已有的接收组列表可通过 DescribeAlarmNotices 接口获取)
4401
4401
  */
4402
4402
  Receivers: Array<string>
4403
4403
  /**
@@ -4411,7 +4411,7 @@ export interface UpdateAlertRuleRequest {
4411
4411
  */
4412
4412
  Annotations?: Array<PrometheusRuleKV>
4413
4413
  /**
4414
- * 报警策略模板分类
4414
+ * 报警策略模板分类(自定义,可不填)
4415
4415
  */
4416
4416
  Type?: string
4417
4417
  }
@@ -4572,7 +4572,7 @@ export interface DescribeDNSConfigResponse {
4572
4572
  */
4573
4573
  export interface DeleteRecordingRulesRequest {
4574
4574
  /**
4575
- * 规则 ID 列表
4575
+ * 规则 ID 列表(规则 ID 可通过 DescribeRecordingRules 接口获取)
4576
4576
  */
4577
4577
  RuleIds: Array<string>
4578
4578
  /**
@@ -7793,26 +7793,26 @@ export interface RunPrometheusInstanceResponse {
7793
7793
  */
7794
7794
  export interface UpdateExporterIntegrationRequest {
7795
7795
  /**
7796
- * 实例 ID
7796
+ * Prometheus 实例 ID
7797
7797
  */
7798
7798
  InstanceId: string
7799
7799
  /**
7800
- * 类型
7800
+ * 类型(可通过 DescribeExporterIntegrations 获取对应集成的 Kind)
7801
7801
  */
7802
7802
  Kind: string
7803
7803
  /**
7804
- * 配置内容
7804
+ * 配置内容(可通过 DescribeExporterIntegrations 接口获取对应集成的 Content,并在此基础上做修改)
7805
7805
  */
7806
7806
  Content: string
7807
7807
  /**
7808
- * Kubernetes 集群类型,取值如下:
7808
+ * Kubernetes 集群类型,可不填。取值如下:
7809
7809
  <li> 1= 容器集群(TKE) </li>
7810
- <li> 2=弹性集群<EKS> </li>
7811
- <li> 3= Prometheus管理的弹性集群<MEKS> </li>
7810
+ <li> 2=弹性集群(EKS) </li>
7811
+ <li> 3= Prometheus管理的弹性集群(MEKS) </li>
7812
7812
  */
7813
7813
  KubeType?: number
7814
7814
  /**
7815
- * 集群 ID
7815
+ * 集群 ID,可不填
7816
7816
  */
7817
7817
  ClusterId?: string
7818
7818
  }