tencentcloud-sdk-nodejs 4.1.310 → 4.1.312

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 (67) hide show
  1. package/es/common/sdk_version.js +1 -1
  2. package/es/services/cfw/v20190904/cfw_client.js +15 -9
  3. package/es/services/cngw/v20230418/cngw_client.js +72 -12
  4. package/es/services/databuddy/index.js +4 -0
  5. package/es/services/databuddy/v20260715/databuddy_client.js +57 -0
  6. package/es/services/databuddy/v20260715/databuddy_models.js +1 -0
  7. package/es/services/databuddy/v20260715/index.js +6 -0
  8. package/es/services/index.js +1 -0
  9. package/es/services/iotexplorer/v20190423/iotexplorer_client.js +12 -6
  10. package/es/services/tcb/v20180608/tcb_client.js +32 -11
  11. package/es/services/trtc/v20190722/trtc_client.js +163 -160
  12. package/es/services/tsf/v20180326/tsf_client.js +2 -5
  13. package/package.json +1 -1
  14. package/tencentcloud/common/sdk_version.d.ts +1 -1
  15. package/tencentcloud/common/sdk_version.js +1 -1
  16. package/tencentcloud/services/adp/v20260520/adp_client.d.ts +1 -1
  17. package/tencentcloud/services/adp/v20260520/adp_client.js +1 -1
  18. package/tencentcloud/services/adp/v20260520/adp_models.d.ts +110 -28
  19. package/tencentcloud/services/ags/v20250920/ags_models.d.ts +23 -7
  20. package/tencentcloud/services/cbs/v20170312/cbs_models.d.ts +11 -7
  21. package/tencentcloud/services/cfw/v20190904/cfw_client.d.ts +19 -11
  22. package/tencentcloud/services/cfw/v20190904/cfw_client.js +27 -15
  23. package/tencentcloud/services/cfw/v20190904/cfw_models.d.ts +406 -40
  24. package/tencentcloud/services/cloudstudio/v20230508/cloudstudio_models.d.ts +12 -12
  25. package/tencentcloud/services/cngw/v20230418/cngw_client.d.ts +93 -13
  26. package/tencentcloud/services/cngw/v20230418/cngw_client.js +138 -18
  27. package/tencentcloud/services/cngw/v20230418/cngw_models.d.ts +1348 -152
  28. package/tencentcloud/services/databuddy/index.d.ts +6 -0
  29. package/tencentcloud/services/databuddy/index.js +7 -0
  30. package/tencentcloud/services/databuddy/v20260715/databuddy_client.d.ts +139 -0
  31. package/tencentcloud/services/databuddy/v20260715/databuddy_client.js +194 -0
  32. package/tencentcloud/services/databuddy/v20260715/databuddy_models.d.ts +3061 -0
  33. package/tencentcloud/services/databuddy/v20260715/databuddy_models.js +18 -0
  34. package/tencentcloud/services/databuddy/v20260715/index.d.ts +6 -0
  35. package/tencentcloud/services/databuddy/v20260715/index.js +10 -0
  36. package/tencentcloud/services/ess/v20201111/ess_models.d.ts +176 -434
  37. package/tencentcloud/services/essbasic/v20210526/essbasic_client.d.ts +13 -13
  38. package/tencentcloud/services/essbasic/v20210526/essbasic_client.js +13 -13
  39. package/tencentcloud/services/essbasic/v20210526/essbasic_models.d.ts +15 -16
  40. package/tencentcloud/services/index.d.ts +1 -0
  41. package/tencentcloud/services/index.js +7 -5
  42. package/tencentcloud/services/iotexplorer/v20190423/iotexplorer_client.d.ts +15 -7
  43. package/tencentcloud/services/iotexplorer/v20190423/iotexplorer_client.js +21 -9
  44. package/tencentcloud/services/iotexplorer/v20190423/iotexplorer_models.d.ts +173 -4
  45. package/tencentcloud/services/keewidb/v20220308/keewidb_models.d.ts +28 -16
  46. package/tencentcloud/services/mps/v20190612/mps_client.d.ts +1 -1
  47. package/tencentcloud/services/mps/v20190612/mps_models.d.ts +444 -139
  48. package/tencentcloud/services/oceanus/v20190422/oceanus_models.d.ts +12 -0
  49. package/tencentcloud/services/ocr/v20181119/ocr_models.d.ts +23 -30
  50. package/tencentcloud/services/tcb/v20180608/tcb_client.d.ts +50 -20
  51. package/tencentcloud/services/tcb/v20180608/tcb_client.js +69 -25
  52. package/tencentcloud/services/tcb/v20180608/tcb_models.d.ts +4770 -3942
  53. package/tencentcloud/services/teo/v20220901/teo_client.d.ts +4 -2
  54. package/tencentcloud/services/teo/v20220901/teo_client.js +4 -2
  55. package/tencentcloud/services/teo/v20220901/teo_models.d.ts +107 -43
  56. package/tencentcloud/services/tke/v20220501/tke_models.d.ts +13 -0
  57. package/tencentcloud/services/tokenhub/v20260322/tokenhub_client.d.ts +3 -1
  58. package/tencentcloud/services/tokenhub/v20260322/tokenhub_client.js +3 -1
  59. package/tencentcloud/services/tokenhub/v20260322/tokenhub_models.d.ts +43 -15
  60. package/tencentcloud/services/trtc/v20190722/trtc_client.d.ts +333 -329
  61. package/tencentcloud/services/trtc/v20190722/trtc_client.js +425 -419
  62. package/tencentcloud/services/trtc/v20190722/trtc_models.d.ts +196 -27
  63. package/tencentcloud/services/tsf/v20180326/tsf_client.d.ts +3 -9
  64. package/tencentcloud/services/tsf/v20180326/tsf_client.js +3 -11
  65. package/tencentcloud/services/tsf/v20180326/tsf_models.d.ts +0 -30
  66. package/tencentcloud/services/vod/v20180717/vod_client.d.ts +1 -1
  67. package/tencentcloud/services/vod/v20180717/vod_models.d.ts +65 -6
@@ -49,7 +49,8 @@ export declare class Client extends AbstractClient {
49
49
  */
50
50
  DescribeMultiPathGatewayRegions(req: DescribeMultiPathGatewayRegionsRequest, cb?: (error: string, rep: DescribeMultiPathGatewayRegionsResponse) => void): Promise<DescribeMultiPathGatewayRegionsResponse>;
51
51
  /**
52
- * 本接口(DownloadL4Logs)用于下载四层离线日志。
52
+ * 本接口(DownloadL4Logs)用于获取四层代理业务的离线日志下载链接。
53
+ **注意:**仅当离线日志功能开启期间,EO 才会存储相关离线日志并提供下载服务。具体功能介绍请见[文档](https://cloud.tencent.com/document/product/1552/73660)。
53
54
  */
54
55
  DownloadL4Logs(req: DownloadL4LogsRequest, cb?: (error: string, rep: DownloadL4LogsResponse) => void): Promise<DownloadL4LogsResponse>;
55
56
  /**
@@ -151,7 +152,8 @@ export declare class Client extends AbstractClient {
151
152
  */
152
153
  ModifyL4ProxyStatus(req: ModifyL4ProxyStatusRequest, cb?: (error: string, rep: ModifyL4ProxyStatusResponse) => void): Promise<ModifyL4ProxyStatusResponse>;
153
154
  /**
154
- * 本接口(DownloadL7Logs)下载七层离线日志。
155
+ * 本接口(DownloadL7Logs)用于获取七层域名业务的离线日志下载链接。
156
+ **注意:**仅当离线日志功能开启期间,EO 才会存储相关离线日志并提供下载服务。具体功能介绍请见[文档](https://cloud.tencent.com/document/product/1552/73660)。
155
157
  */
156
158
  DownloadL7Logs(req: DownloadL7LogsRequest, cb?: (error: string, rep: DownloadL7LogsResponse) => void): Promise<DownloadL7LogsResponse>;
157
159
  /**
@@ -85,7 +85,8 @@ class Client extends abstract_client_1.AbstractClient {
85
85
  return this.request("DescribeMultiPathGatewayRegions", req, cb);
86
86
  }
87
87
  /**
88
- * 本接口(DownloadL4Logs)用于下载四层离线日志。
88
+ * 本接口(DownloadL4Logs)用于获取四层代理业务的离线日志下载链接。
89
+ **注意:**仅当离线日志功能开启期间,EO 才会存储相关离线日志并提供下载服务。具体功能介绍请见[文档](https://cloud.tencent.com/document/product/1552/73660)。
89
90
  */
90
91
  async DownloadL4Logs(req, cb) {
91
92
  return this.request("DownloadL4Logs", req, cb);
@@ -237,7 +238,8 @@ class Client extends abstract_client_1.AbstractClient {
237
238
  return this.request("ModifyL4ProxyStatus", req, cb);
238
239
  }
239
240
  /**
240
- * 本接口(DownloadL7Logs)下载七层离线日志。
241
+ * 本接口(DownloadL7Logs)用于获取七层域名业务的离线日志下载链接。
242
+ **注意:**仅当离线日志功能开启期间,EO 才会存储相关离线日志并提供下载服务。具体功能介绍请见[文档](https://cloud.tencent.com/document/product/1552/73660)。
241
243
  */
242
244
  async DownloadL7Logs(req, cb) {
243
245
  return this.request("DownloadL7Logs", req, cb);
@@ -524,29 +524,42 @@ export interface OriginDetail {
524
524
  */
525
525
  export interface InferenceHardwareSpecification {
526
526
  /**
527
- * 规格标识。
527
+ * <p>规格标识。已废弃,参考使用字段 <code>HardwareSpecId</code>。</p>
528
+ * @deprecated
528
529
  */
529
530
  Spec?: string;
530
531
  /**
531
- * 规格名称。
532
+ * <p>规格唯一标识 ID。</p>
533
+ */
534
+ HardwareSpecId?: string;
535
+ /**
536
+ * <p>规格名称。</p>
532
537
  */
533
538
  Name?: string;
534
539
  /**
535
- * CPU 核数。
540
+ * <p>规格默认分配的 GPU 卡数。</p>
541
+ */
542
+ GPUNum?: number;
543
+ /**
544
+ * <p>规格默认分配的 CPU 核数。</p>
536
545
  */
537
546
  CPUNum?: number;
538
547
  /**
539
- * 内存大小。单位为 MB
548
+ * <p>规格默认分配的内存大小。</p><p>单位:MB</p>
540
549
  */
541
550
  MemSize?: number;
542
551
  /**
543
- * GPU 卡数。
552
+ * <p>规格默认分配的显存大小。</p><p>单位:MB</p>
544
553
  */
545
- GPUNum?: number;
554
+ GPUMemSize?: number;
546
555
  /**
547
- * 显存大小。单位为 MB
556
+ * <p>规格默认分配的磁盘大小。</p><p>单位:MB</p>
548
557
  */
549
- GPUMemSize?: number;
558
+ DiskSize?: number;
559
+ /**
560
+ * <p>规格当前支持的 GPU 卡数列表。</p><p>若不填充或填充空数组,则仅支持规格默认分配的 GPU 卡数。</p>
561
+ */
562
+ AllowedGPUNums?: Array<number>;
550
563
  }
551
564
  /**
552
565
  * DescribeSecurityClientAttester返回参数结构体
@@ -3204,7 +3217,7 @@ export interface DownloadL4LogsRequest {
3204
3217
  /**
3205
3218
  * 站点 ID 集合,此参数将于2024年05月30日后由可选改为必填,详见公告:[【腾讯云 EdgeOne】云 API 变更通知](https://cloud.tencent.com/document/product/1552/104902)。
3206
3219
  */
3207
- ZoneIds?: Array<string>;
3220
+ ZoneIds: Array<string>;
3208
3221
  /**
3209
3222
  * 四层实例 ID 集合。
3210
3223
  */
@@ -5125,25 +5138,34 @@ export interface DescribePrefetchTasksResponse {
5125
5138
  */
5126
5139
  export interface InferenceResourceConfig {
5127
5140
  /**
5128
- * 扩容缩容的方式。取值有:<li>Auto:根据请求量自动调整实例数量;</li><li>Manual:人工设置固定的实例数量。</li>
5141
+ * <p>扩容缩容的方式。取值有:<li>Auto:根据请求量自动调整实例数量;</li><li>Manual:人工设置固定的实例数量。</li></p>
5129
5142
  */
5130
5143
  ScalingMode: string;
5131
5144
  /**
5132
- * 硬件规格。
5145
+ * <p>硬件规格标识。已废弃,请参考使用 <code>HardwareSpecId</code>。</p>
5146
+ * @deprecated
5147
+ */
5148
+ HardwareSpec?: string;
5149
+ /**
5150
+ * <p>硬件规格唯一标识 ID,可通过 <code>DescribeInferenceHardwareSpecifications</code> 接口获取当前站点支持的硬件规格。</p><p>系统默认按照所选 <code>HardwareSpecId</code> 对应的硬件规格配置推理服务所需资源;如需调整,可通过 <code>HardwareConfig</code> 自定义硬件资源配置。</p>
5151
+ */
5152
+ HardwareSpecId?: string;
5153
+ /**
5154
+ * <p>推理服务硬件配置。</p><p>作为入参时,若未填充则按照所选 <code>HardwareSpecId</code> 规格的默认值配置硬件资源;若填充则优先按照填写值进行配置。</p>
5133
5155
  */
5134
- HardwareSpec: string;
5156
+ HardwareConfig?: InferenceHardwareConfig;
5135
5157
  /**
5136
- * 推理服务自动伸缩配置。当 ScalingMode 为 Auto 时必填。
5158
+ * <p>推理服务自动伸缩配置。当 ScalingMode 为 Auto 时必填。</p>
5137
5159
  注意:此字段可能返回 null,表示取不到有效值。
5138
5160
  */
5139
5161
  AutoScalingConfig?: InferenceAutoScalingConfig;
5140
5162
  /**
5141
- * 推理服务人工设置实例配置。当 ScalingMode 为 Manual 时必填。
5163
+ * <p>推理服务人工设置实例配置。当 ScalingMode 为 Manual 时必填。</p>
5142
5164
  注意:此字段可能返回 null,表示取不到有效值。
5143
5165
  */
5144
5166
  ManualInstanceConfig?: InferenceManualInstanceConfig;
5145
5167
  /**
5146
- * 单实例的并发数。默认值为 1
5168
+ * <p>单实例的并发数。默认值为 1。</p>
5147
5169
  */
5148
5170
  Concurrency?: number;
5149
5171
  }
@@ -7355,7 +7377,7 @@ export interface DownloadL7LogsRequest {
7355
7377
  /**
7356
7378
  * 站点ID集合,此参数将于2024年05月30日后由可选改为必填,详见公告:[【腾讯云 EdgeOne】云 API 变更通知](https://cloud.tencent.com/document/product/1552/104902)。
7357
7379
  */
7358
- ZoneIds?: Array<string>;
7380
+ ZoneIds: Array<string>;
7359
7381
  /**
7360
7382
  * 子域名集合,不填默认选择全部子域名。
7361
7383
  */
@@ -8915,6 +8937,28 @@ export interface AclConfig {
8915
8937
  */
8916
8938
  Customizes?: Array<AclUserRule>;
8917
8939
  }
8940
+ /**
8941
+ * Bot智能分析规则详情
8942
+ */
8943
+ export interface IntelligenceRuleItem {
8944
+ /**
8945
+ * 智能分析标签,取值有:
8946
+ <li>evil_bot:恶意bot;</li>
8947
+ <li>suspect_bot:疑似bot;</li>
8948
+ <li>good_bot:良好bot;</li>
8949
+ <li>normal:正常请求。</li>
8950
+ */
8951
+ Label: string;
8952
+ /**
8953
+ * 触发智能分析标签对应的处置方式,取值有:
8954
+ <li>drop:拦截;</li>
8955
+ <li>trans:放行;</li>
8956
+ <li>alg:Javascript挑战;</li>
8957
+ <li>captcha:数字验证码;</li>
8958
+ <li>monitor:观察。</li>
8959
+ */
8960
+ Action: string;
8961
+ }
8918
8962
  /**
8919
8963
  * 视频即时处理配置
8920
8964
  */
@@ -10208,6 +10252,23 @@ export interface ModifyL7AccSettingResponse {
10208
10252
  */
10209
10253
  RequestId?: string;
10210
10254
  }
10255
+ /**
10256
+ * 边缘推理定时伸缩有效期范围配置。
10257
+ */
10258
+ export interface InferenceScheduledScalingEffectiveRange {
10259
+ /**
10260
+ * <p>有效期类型。取值有:<li>LongTerm:长期有效;</li><li>Custom:自定义起止日期。</li></p>
10261
+ */
10262
+ EffectiveType: string;
10263
+ /**
10264
+ * <p>有效期起始日期。当 EffectiveType 为 Custom 时必填;当 EffectiveType 为 LongTerm 时不传该字段。</p>
10265
+ */
10266
+ StartDate?: string;
10267
+ /**
10268
+ * <p>有效期终止日期。当 EffectiveType 为 Custom 时必填,且不得早于 StartDate;当 EffectiveType 为 LongTerm 时不传该字段。</p>
10269
+ */
10270
+ EndDate?: string;
10271
+ }
10211
10272
  /**
10212
10273
  * DeleteSecurityJSInjectionRule返回参数结构体
10213
10274
  */
@@ -11860,21 +11921,25 @@ export interface LogItem {
11860
11921
  */
11861
11922
  export interface InferenceResourceConfigForModify {
11862
11923
  /**
11863
- * 扩容缩容的方式。取值有:<li>Auto:根据请求量自动调整实例数量;</li><li>Manual:人工设置固定的实例数量。</li>
11924
+ * <p>扩容缩容的方式。取值有:<li>Auto:根据请求量自动调整实例数量;</li><li>Manual:人工设置固定的实例数量。</li></p>
11864
11925
  */
11865
11926
  ScalingMode?: string;
11866
11927
  /**
11867
- * 推理服务自动伸缩配置。当 ScalingMode 为 Auto 时必填。
11928
+ * <p>推理服务自动伸缩配置。当 ScalingMode 为 Auto 时必填。</p>
11868
11929
  */
11869
11930
  AutoScalingConfig?: InferenceAutoScalingConfig;
11870
11931
  /**
11871
- * 推理服务人工设置实例配置。当 ScalingMode 为 Manual 时必填。
11932
+ * <p>推理服务人工设置实例配置。当 ScalingMode 为 Manual 时必填。</p>
11872
11933
  */
11873
11934
  ManualInstanceConfig?: InferenceManualInstanceConfig;
11874
11935
  /**
11875
- * 单实例的并发数。默认值为 1
11936
+ * <p>单实例的并发数。默认值为 1。</p>
11876
11937
  */
11877
11938
  Concurrency?: number;
11939
+ /**
11940
+ * <p>推理服务的硬件资源配置。</p>
11941
+ */
11942
+ HardwareConfig?: InferenceHardwareConfigForModify;
11878
11943
  }
11879
11944
  /**
11880
11945
  * Hsts配置
@@ -14307,21 +14372,25 @@ export interface DescribeTopL7CacheDataRequest {
14307
14372
  Area?: string;
14308
14373
  }
14309
14374
  /**
14310
- * 边缘推理定时伸缩有效期范围配置。
14375
+ * 推理服务硬件配置。
14311
14376
  */
14312
- export interface InferenceScheduledScalingEffectiveRange {
14377
+ export interface InferenceHardwareConfig {
14313
14378
  /**
14314
- * <p>有效期类型。取值有:<li>LongTerm:长期有效;</li><li>Custom:自定义起止日期。</li></p>
14379
+ * <p>推理服务单个实例分配的 GPU 卡数,当前仅支持整数值,且必须为 <code>HardwareSpecId</code> 对应规格的 <code>AllowedGPUNums</code> 中的可选值。</p><p>若不填充,则使用所选 <code>HardwareSpecId</code> 规格对应的默认 <code>GPUNum</code> 值。</p>
14315
14380
  */
14316
- EffectiveType: string;
14381
+ GPUNum?: number;
14317
14382
  /**
14318
- * <p>有效期起始日期。当 EffectiveType Custom 时必填;当 EffectiveType 为 LongTerm 时不传该字段。</p>
14383
+ * <p>推理服务单个实例分配的 CPU 核数,当前仅支持整数值。</p><p>若不填充,则使用所选 <code>HardwareSpecId</code> 规格对应的默认 <code>CPUNum</code> 值。</p>
14319
14384
  */
14320
- StartDate?: string;
14385
+ CPUNum?: number;
14321
14386
  /**
14322
- * <p>有效期终止日期。当 EffectiveType Custom 时必填,且不得早于 StartDate;当 EffectiveType 为 LongTerm 时不传该字段。</p>
14387
+ * <p>推理服务单实例分配的内存大小。</p><p>单位:MB</p><p>若不填充,则使用所选 <code>HardwareSpecId</code> 对应规格的默认 <code>MemSize</code> 值;若填充,则必须为 <code>1024</code> 的整数倍。</p>
14323
14388
  */
14324
- EndDate?: string;
14389
+ MemSize?: number;
14390
+ /**
14391
+ * <p>推理服务单实例分配的临时磁盘大小。</p><p>单位:MB</p><p>若不填充,则使用所选 <code>HardwareSpecId</code> 对应规格的默认 <code>DiskSize</code> 值;若填充,则必须为 <code>1024</code> 的整数倍。</p>
14392
+ */
14393
+ DiskSize?: number;
14325
14394
  }
14326
14395
  /**
14327
14396
  * 会话速率和周期特征校验配置。
@@ -17036,26 +17105,21 @@ export interface RuleEngineSubRule {
17036
17105
  Description?: Array<string>;
17037
17106
  }
17038
17107
  /**
17039
- * Bot智能分析规则详情
17108
+ * 推理服务资源硬件配置的修改参数。
17040
17109
  */
17041
- export interface IntelligenceRuleItem {
17110
+ export interface InferenceHardwareConfigForModify {
17042
17111
  /**
17043
- * 智能分析标签,取值有:
17044
- <li>evil_bot:恶意bot;</li>
17045
- <li>suspect_bot:疑似bot;</li>
17046
- <li>good_bot:良好bot;</li>
17047
- <li>normal:正常请求。</li>
17112
+ * <p>推理服务单实例分配的 CPU 核数,当前仅支持整数值。</p><p>若不填充,则不修改。</p>
17048
17113
  */
17049
- Label: string;
17114
+ CPUNum?: number;
17050
17115
  /**
17051
- * 触发智能分析标签对应的处置方式,取值有:
17052
- <li>drop:拦截;</li>
17053
- <li>trans:放行;</li>
17054
- <li>alg:Javascript挑战;</li>
17055
- <li>captcha:数字验证码;</li>
17056
- <li>monitor:观察。</li>
17116
+ * <p>推理服务单实例分配的内存大小。</p><p>单位:MB</p><p>若不填充,则不修改;若填写,则必须为 <code>1024</code> 的整数倍。</p>
17057
17117
  */
17058
- Action: string;
17118
+ MemSize?: number;
17119
+ /**
17120
+ * <p>推理服务单实例分配的临时磁盘大小。</p><p>单位:MB</p><p>若不填充,则不修改;若填充,则必须为 <code>1024</code> 的整数倍。</p>
17121
+ */
17122
+ DiskSize?: number;
17059
17123
  }
17060
17124
  /**
17061
17125
  * ExportZoneConfig返回参数结构体
@@ -102,6 +102,10 @@ export interface CreateNativeNodePoolParam {
102
102
  * <p>原生节点池密码</p>
103
103
  */
104
104
  Password?: string;
105
+ /**
106
+ * <p>自定义镜像 ID</p>
107
+ */
108
+ CustomImage?: string;
105
109
  }
106
110
  /**
107
111
  * DescribeClusterInstances返回参数结构体
@@ -1198,6 +1202,11 @@ export interface NativeNodePoolInfo {
1198
1202
  * <p>原生节点机型 Native, NativeCVM</p>
1199
1203
  */
1200
1204
  MachineType?: string;
1205
+ /**
1206
+ * <p>自定义镜像 ID</p>
1207
+ 注意:此字段可能返回 null,表示取不到有效值。
1208
+ */
1209
+ CustomImage?: string;
1201
1210
  }
1202
1211
  /**
1203
1212
  * 节点系统盘和数据盘配置
@@ -2344,6 +2353,10 @@ export interface UpdateNativeNodePoolParam {
2344
2353
  * <p>原生节点池密码</p>
2345
2354
  */
2346
2355
  Password?: string;
2356
+ /**
2357
+ * <p>自定义镜像 ID</p>
2358
+ */
2359
+ CustomImage?: string;
2347
2360
  }
2348
2361
  /**
2349
2362
  * 健康检测规则
@@ -96,8 +96,10 @@ export declare class Client extends AbstractClient {
96
96
  指标族(MetricType)
97
97
  - `tokens`(默认):Token 用量统计。支持 Dimension = apikey / endpoint / model。
98
98
  返回指标:TotalToken(总)/ InputTotalToken(输入)/ OutputTotalToken(输出)/ CacheTotalToken(读缓存)。
99
- - `search`:【待上线】联网搜索用量统计。支持 Dimension = apikey / endpoint / model。
99
+ - `search`:联网搜索用量统计。支持 Dimension = apikey / endpoint / model。
100
100
  返回指标:SearchRequestCount(搜索请求数)/ SearchCount(搜索引擎调用次数)。
101
+ - `apikey_usage`:APIKey 锚定用量统计(某 APIKey 下按模型或接入点展开)。支持 Dimension = endpoint / model。
102
+ 返回指标:TotalToken(总 Token)/ InputTotalToken(输入 Token)/ OutputTotalToken(输出 Token)/ CacheTotalToken(读缓存)/ RequestCount(请求次数)/ SuccessCount(成功次数)。
101
103
 
102
104
  响应内容
103
105
  - MetricType 字段用于切换指标族,响应回显 MetricType 与 MetricKeys。
@@ -144,8 +144,10 @@ class Client extends abstract_client_1.AbstractClient {
144
144
  指标族(MetricType)
145
145
  - `tokens`(默认):Token 用量统计。支持 Dimension = apikey / endpoint / model。
146
146
  返回指标:TotalToken(总)/ InputTotalToken(输入)/ OutputTotalToken(输出)/ CacheTotalToken(读缓存)。
147
- - `search`:【待上线】联网搜索用量统计。支持 Dimension = apikey / endpoint / model。
147
+ - `search`:联网搜索用量统计。支持 Dimension = apikey / endpoint / model。
148
148
  返回指标:SearchRequestCount(搜索请求数)/ SearchCount(搜索引擎调用次数)。
149
+ - `apikey_usage`:APIKey 锚定用量统计(某 APIKey 下按模型或接入点展开)。支持 Dimension = endpoint / model。
150
+ 返回指标:TotalToken(总 Token)/ InputTotalToken(输入 Token)/ OutputTotalToken(输出 Token)/ CacheTotalToken(读缓存)/ RequestCount(请求次数)/ SuccessCount(成功次数)。
149
151
 
150
152
  响应内容
151
153
  - MetricType 字段用于切换指标族,响应回显 MetricType 与 MetricKeys。
@@ -176,19 +176,19 @@ export interface ModelImage {
176
176
  */
177
177
  export interface UsageSeries {
178
178
  /**
179
- * <p>[tokens 族]总 token 数用量时间周期内的 JSON 字符串形式,如 <code>&quot;[12,null,15]&quot;</code>。</p>
179
+ * <p>[tokens / apikey_usage 族]总 token 数用量时间周期内的 JSON 字符串形式,如 <code>&quot;[12,null,15]&quot;</code>。</p>
180
180
  */
181
181
  TotalToken?: string;
182
182
  /**
183
- * <p>[tokens 族]输入 token 数用量时间周期内的 JSON 字符串形式,如 <code>&quot;[7,null,9]&quot;</code>。</p>
183
+ * <p>[tokens / apikey_usage 族]输入 token 数用量时间周期内的 JSON 字符串形式,如 <code>&quot;[7,null,9]&quot;</code>。</p>
184
184
  */
185
185
  InputTotalToken?: string;
186
186
  /**
187
- * <p>[tokens 族]输出 token 数用量时间周期内的 JSON 字符串形式,如 <code>&quot;[5,null,6]&quot;</code>。</p>
187
+ * <p>[tokens / apikey_usage 族]输出 token 数用量时间周期内的 JSON 字符串形式,如 <code>&quot;[5,null,6]&quot;</code>。</p>
188
188
  */
189
189
  OutputTotalToken?: string;
190
190
  /**
191
- * <p>[tokens 族]读缓存 token 数用量时间周期内的 JSON 字符串形式,如<code>&quot;[5,null,6]&quot;</code>。</p>
191
+ * <p>[tokens / apikey_usage 族]读缓存 token 数用量时间周期内的 JSON 字符串形式,如<code>&quot;[5,null,6]&quot;</code>。</p>
192
192
  */
193
193
  CacheTotalToken?: string;
194
194
  /**
@@ -199,6 +199,14 @@ export interface UsageSeries {
199
199
  * <p>[search 族] 搜索引擎调用次数用量时间周期内的 JSON 字符串形式,如<code>&quot;[5,null,6]&quot;</code>。</p>
200
200
  */
201
201
  SearchCount?: string;
202
+ /**
203
+ * <p>[apikey_usage 族] 请求次数在时间周期内的 JSON 字符串形式,如 <code>&quot;[12,null,15]&quot;</code>。</p>
204
+ */
205
+ RequestCount?: string;
206
+ /**
207
+ * <p>[apikey_usage 族] 请求失败次数在时间周期内的 JSON 字符串形式,如 &quot;[12,null,15]&quot;。</p>
208
+ */
209
+ RequestFailCount?: string;
202
210
  }
203
211
  /**
204
212
  * DescribeTokenPlanList返回参数结构体
@@ -1190,33 +1198,41 @@ export interface TokenPlanPackageInfo {
1190
1198
  RemainCycles?: number;
1191
1199
  }
1192
1200
  /**
1193
- * 时间周期内的统计聚合值(按 metric key 索引)。声明 tokens / search 两族字段都在本 schema 中,按 MetricKeys 实际返回取值,参见响应顶层 `MetricKeys` 字段。
1201
+ * 时间周期内的统计聚合值,按 MetricKeys 实际返回取值,参见响应顶层 `MetricKeys` 字段。
1194
1202
  */
1195
1203
  export interface UsageStats {
1196
1204
  /**
1197
- * <p>[tokens 族] 时间周期内的累计总 token 数。</p>
1205
+ * <p>[tokens / apikey_usage 族] 时间周期内的累计总 token 数。</p>
1198
1206
  */
1199
1207
  TotalToken?: number;
1200
1208
  /**
1201
- * <p>[tokens 族] 时间周期内的累计输入 token 数。</p>
1209
+ * <p>[tokens / apikey_usage 族] 时间周期内的累计输入 token 数。</p>
1202
1210
  */
1203
1211
  InputTotalToken?: number;
1204
1212
  /**
1205
- * <p>[tokens 族] 时间周期内的累计输出 token 数。</p>
1213
+ * <p>[tokens / apikey_usage 族] 时间周期内的累计输出 token 数。</p>
1206
1214
  */
1207
1215
  OutputTotalToken?: number;
1208
1216
  /**
1209
- * <p>[tokens 族] 时间周期内的累计读缓存 token 数(命中缓存部分)</p>
1217
+ * <p>[tokens / apikey_usage 族] 时间周期内的累计读缓存 token 数(命中缓存部分)注意:CacheTotalToken 是 InputTotalToken 的子集(已包含在内)。</p>
1210
1218
  */
1211
1219
  CacheTotalToken?: number;
1212
1220
  /**
1213
- * <p>[search 族] 整段累计联网搜索请求数</p>
1221
+ * <p>[search 族] 时间周期内的累计联网搜索请求数</p>
1214
1222
  */
1215
1223
  SearchRequestCount?: number;
1216
1224
  /**
1217
- * <p>[search 族] 整段累计搜索引擎调用次数</p>
1225
+ * <p>[search 族] 时间周期内的累计搜索引擎调用次数</p>
1218
1226
  */
1219
1227
  SearchCount?: number;
1228
+ /**
1229
+ * <p>[apikey_usage 族] 时间周期内的累计请求次数</p>
1230
+ */
1231
+ RequestCount?: number;
1232
+ /**
1233
+ * <p>[apikey_usage 族] 时间周期内的累计请求失败次数</p>
1234
+ */
1235
+ RequestFailCount?: number;
1220
1236
  }
1221
1237
  /**
1222
1238
  * DescribeUsageRankList返回参数结构体
@@ -1227,11 +1243,11 @@ export interface DescribeUsageRankListResponse {
1227
1243
  */
1228
1244
  Dimension?: string;
1229
1245
  /**
1230
- * <p>回填请求的指标族:tokens / search 。</p>
1246
+ * <p>回填请求的指标族:取值同入参 MetricType(tokens / search / apikey_usage)</p><p>枚举值:</p><ul><li>tokens: tokens</li></ul>
1231
1247
  */
1232
1248
  MetricType?: string;
1233
1249
  /**
1234
- * <p>本次响应中 Stats / Series / PageStats / TotalStats 实际包含的 metric key 列表,按MetricType 区分:tokens=[Total,Input,Output,Cache]search=[SearchRequestCount,SearchCount]</p>
1250
+ * <p>本次响应中 Stats / Series / PageStats / TotalStats 实际包含的 metric key 列表,按MetricType 区分:<br>tokens=[TotalToken, InputTotalToken, OutputTotalToken, CacheTotalToken]<br>search=[SearchRequestCount,SearchCount]<br>apikey_usage=[TotalToken, InputTotalToken, OutputTotalToken, CacheTotalToken, RequestCount, RequestFailCount]</p>
1235
1251
  */
1236
1252
  MetricKeys?: Array<string>;
1237
1253
  /**
@@ -1267,7 +1283,7 @@ export interface DescribeUsageRankListResponse {
1267
1283
  */
1268
1284
  Timestamps?: Array<number | bigint>;
1269
1285
  /**
1270
- * <p>对象排行列表,按<code>MetricKeys[0]</code>降序排序。ShowAll=false 时为当前页 10 个对象(含 Series);ShowAll=true 时为全量对象(不含 Series,用于 CSV 导出)。</p>
1286
+ * <p>对象排行列表,按 SortKey 降序排序。ShowAll=false 时为当前页 10 个对象(含 Series);ShowAll=true 时为全量对象(不含 Series,用于 CSV 导出)。</p>
1271
1287
  */
1272
1288
  TopList?: Array<UsageRankItem>;
1273
1289
  /**
@@ -1278,6 +1294,10 @@ export interface DescribeUsageRankListResponse {
1278
1294
  * <p>总统计结果</p>
1279
1295
  */
1280
1296
  TotalStats?: UsageStats;
1297
+ /**
1298
+ * <p>排序指标键</p>
1299
+ */
1300
+ SortKey?: string;
1281
1301
  /**
1282
1302
  * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
1283
1303
  */
@@ -1802,9 +1822,13 @@ export interface DescribeUsageRankListRequest {
1802
1822
  */
1803
1823
  EndTime: string;
1804
1824
  /**
1805
- * <p>指标族切换字段。</p><ul><li>tokens(默认):Token 消耗图(statistics=sum),支持 Dimension = apikey/endpoint/model</li><li>search【待上线】:联网搜索调用次数(statistics=sum),仅支持 Dimension = model</li><li>其他值返回 InvalidParameter。</li></ul><p>枚举值:</p><ul><li>tokens: tokens</li></ul>
1825
+ * <p>指标族切换字段。</p><ul><li>tokens(默认):Token 用量消耗(statistics=sum),支持 Dimension = apikey/endpoint/model</li><li>search:联网搜索调用次数(statistics=sum),仅支持 Dimension = model</li><li>apikey_usage: APIKey 锚定用量统计(某 APIKey 下按模型或接入点展开)(statistics=sum),支持 Dimension = endpoint/model</li><li>其他值返回 InvalidParameter。</li></ul>
1806
1826
  */
1807
1827
  MetricType?: string;
1828
+ /**
1829
+ * <p>锚定对象,用于缩小统计范围「在哪个具体对象之内」,MetricType 为 apikey_usage 时必填。<br>各 MetricType 是否支持/如何使用 Anchor,见 MetricType 字段说明。</p>
1830
+ */
1831
+ Anchor?: string;
1808
1832
  /**
1809
1833
  * <p>维度过滤值。空字符串表示查询全部对象,非空时仅查询指定单个对象(如指定 APIKey ID)。最大 256 字符。</p>
1810
1834
  */
@@ -1821,6 +1845,10 @@ export interface DescribeUsageRankListRequest {
1821
1845
  * <p>是否返回全量结果。</p><ul><li>false(默认):按 Offset 分页返回 TopList(每页 10 条),每个对象包含<br>Series 时序点用于绘制曲线。</li><li>true:忽略 Offset,返回全量对象列表,不返回 Series(CSV 导出场景)。</li></ul>
1822
1846
  */
1823
1847
  ShowAll?: boolean;
1848
+ /**
1849
+ * <p>排序指标键(可选),具体值见响应 MetricKeys。为空时按 <code>MetricKeys[0]</code> 降序排序(tokens/apikey_usage 族为 TotalToken,search 族为 SearchRequestCount)。非法值返回 InvalidParameter。</p>
1850
+ */
1851
+ SortKey?: string;
1824
1852
  }
1825
1853
  /**
1826
1854
  * CreateGlossaryEntries请求参数结构体