tencentcloud-sdk-nodejs 4.1.98 → 4.1.99

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 (40) hide show
  1. package/es/common/sdk_version.js +1 -1
  2. package/es/services/postgres/v20170312/postgres_client.js +6 -15
  3. package/es/services/trocket/v20230308/trocket_client.js +7 -4
  4. package/es/services/waf/v20180125/waf_client.js +28 -7
  5. package/package.json +1 -1
  6. package/tencentcloud/common/sdk_version.d.ts +1 -1
  7. package/tencentcloud/common/sdk_version.js +1 -1
  8. package/tencentcloud/services/batch/v20170312/batch_models.d.ts +2 -2
  9. package/tencentcloud/services/cfs/v20190719/cfs_models.d.ts +5 -5
  10. package/tencentcloud/services/clb/v20180317/clb_models.d.ts +122 -13
  11. package/tencentcloud/services/cls/v20201016/cls_client.d.ts +1 -1
  12. package/tencentcloud/services/cls/v20201016/cls_client.js +1 -1
  13. package/tencentcloud/services/cls/v20201016/cls_models.d.ts +74 -56
  14. package/tencentcloud/services/keewidb/v20220308/keewidb_models.d.ts +23 -23
  15. package/tencentcloud/services/lcic/v20220817/lcic_models.d.ts +23 -8
  16. package/tencentcloud/services/mongodb/v20190725/mongodb_models.d.ts +2 -2
  17. package/tencentcloud/services/monitor/v20180724/monitor_models.d.ts +2 -2
  18. package/tencentcloud/services/mps/v20190612/mps_models.d.ts +18 -0
  19. package/tencentcloud/services/ocr/v20181119/ocr_models.d.ts +12 -8
  20. package/tencentcloud/services/postgres/v20170312/postgres_client.d.ts +8 -26
  21. package/tencentcloud/services/postgres/v20170312/postgres_client.js +10 -34
  22. package/tencentcloud/services/postgres/v20170312/postgres_models.d.ts +75 -424
  23. package/tencentcloud/services/sts/v20180813/sts_client.d.ts +21 -7
  24. package/tencentcloud/services/sts/v20180813/sts_client.js +21 -7
  25. package/tencentcloud/services/tcbr/v20220217/tcbr_models.d.ts +37 -0
  26. package/tencentcloud/services/tcss/v20201101/tcss_models.d.ts +12 -0
  27. package/tencentcloud/services/tke/v20180525/tke_models.d.ts +5 -1
  28. package/tencentcloud/services/trabbit/v20230418/trabbit_models.d.ts +16 -0
  29. package/tencentcloud/services/trocket/v20230308/trocket_client.d.ts +11 -5
  30. package/tencentcloud/services/trocket/v20230308/trocket_client.js +14 -6
  31. package/tencentcloud/services/trocket/v20230308/trocket_models.d.ts +93 -0
  32. package/tencentcloud/services/trtc/v20190722/trtc_models.d.ts +3 -2
  33. package/tencentcloud/services/tsf/v20180326/tsf_models.d.ts +343 -259
  34. package/tencentcloud/services/vod/v20180717/vod_client.d.ts +1 -0
  35. package/tencentcloud/services/vod/v20180717/vod_client.js +1 -0
  36. package/tencentcloud/services/vod/v20180717/vod_models.d.ts +20 -5
  37. package/tencentcloud/services/waf/v20180125/waf_client.d.ts +37 -9
  38. package/tencentcloud/services/waf/v20180125/waf_client.js +54 -12
  39. package/tencentcloud/services/waf/v20180125/waf_models.d.ts +349 -31
  40. package/tencentcloud/services/wedata/v20210820/wedata_models.d.ts +60 -0
@@ -275,7 +275,7 @@ export interface ClusterV2 {
275
275
  */
276
276
  ClusterDesc?: string;
277
277
  /**
278
- * 集群类型
278
+ * 集群类型,C表示容器集群,V表示虚拟机集群
279
279
  注意:此字段可能返回 null,表示取不到有效值。
280
280
  */
281
281
  ClusterType?: string;
@@ -335,12 +335,12 @@ export interface ClusterV2 {
335
335
  */
336
336
  DeleteFlag?: boolean;
337
337
  /**
338
- * 创建时间
338
+ * 创建时间,格式为​​YYYY-MM-DD HH:MM:SS
339
339
  注意:此字段可能返回 null,表示取不到有效值。
340
340
  */
341
341
  CreateTime?: string;
342
342
  /**
343
- * 更新时间
343
+ * 更新时间,格式为​​YYYY-MM-DD HH:MM:SS
344
344
  注意:此字段可能返回 null,表示取不到有效值。
345
345
  */
346
346
  UpdateTime?: string;
@@ -430,7 +430,7 @@ export interface ClusterV2 {
430
430
  */
431
431
  KuberneteApiServer?: string;
432
432
  /**
433
- * K : kubeconfig, S : service account
433
+ * K 表示通过kubeconfig 导入, S 表示通过service account导入
434
434
  注意:此字段可能返回 null,表示取不到有效值。
435
435
  */
436
436
  KuberneteNativeType?: string;
@@ -453,8 +453,7 @@ export interface ClusterV2 {
453
453
  */
454
454
  export interface ModifyApplicationResponse {
455
455
  /**
456
- * true:操作成功
457
- false:操作失败
456
+ * true表示修改成功,false表示修改失败
458
457
  */
459
458
  Result?: boolean;
460
459
  /**
@@ -825,7 +824,7 @@ export interface DescribeConfigsResponse {
825
824
  */
826
825
  export interface ModifyContainerReplicasRequest {
827
826
  /**
828
- * 部署组ID,部署组唯一标识
827
+ * 部署组ID,部署组唯一标识,调用[DescribeClusters](https://console.cloud.tencent.com/tsf/resource?rid=1&tab=docker)接口,选定一个容器集群,选择部署组,查看DescribeSingleContainerGroups接口返回的GroupId
829
828
  */
830
829
  GroupId: string;
831
830
  /**
@@ -920,27 +919,27 @@ export interface DescribeFileConfigsResponse {
920
919
  */
921
920
  export interface DescribeClustersRequest {
922
921
  /**
923
- * 搜索词
922
+ * 搜索词,可以搜索ID/名称/备注/标签
924
923
  */
925
924
  SearchWord?: string;
926
925
  /**
927
- * 排序字段
926
+ * 排序字段,例如创建时间
928
927
  */
929
928
  OrderBy?: string;
930
929
  /**
931
- * 排序方式
930
+ * 排序方式,0表示升序,1表示倒序
932
931
  */
933
932
  OrderType?: number;
934
933
  /**
935
- * 偏移量
934
+ * 偏移量,默认0
936
935
  */
937
936
  Offset?: number;
938
937
  /**
939
- * 分页个数
938
+ * 分页个数,0-50 之间,默认20
940
939
  */
941
940
  Limit?: number;
942
941
  /**
943
- * 集群类型
942
+ * 集群类型,C表示容器集群,V表示虚拟机集群
944
943
  */
945
944
  ClusterType?: string;
946
945
  /**
@@ -1003,11 +1002,13 @@ export interface DescribeGroupBindedGatewaysResponse {
1003
1002
  */
1004
1003
  export interface DescribeJvmMonitorRequest {
1005
1004
  /**
1006
- * 查询的实例Id
1005
+ * 查询的实例ID
1006
+ 可通过调用[DescribeClusterInstances](https://cloud.tencent.com/document/product/649/36048)查询已导入的实例列表或登录[控制台](https://console.cloud.tencent.com/tsf/resource?rid=1&tab=instance)进行查询。实例ID例如:ins-6decplwk
1007
1007
  */
1008
1008
  InstanceId: string;
1009
1009
  /**
1010
- * 实例所属应用Id
1010
+ * 实例所属应用ID
1011
+ 可通过调用[DescribeApplications](https://cloud.tencent.com/document/product/649/36090)查询已经存在的应用列表或登录[控制台](https://console.cloud.tencent.com/tsf/app?rid=1)查看。应用ID例如:application-v378ewna
1011
1012
  */
1012
1013
  ApplicationId: string;
1013
1014
  /**
@@ -1023,7 +1024,8 @@ export interface DescribeJvmMonitorRequest {
1023
1024
  */
1024
1025
  To: string;
1025
1026
  /**
1026
- * 查询的监控图列表,以返回值属性名作为入参
1027
+ * 查询的监控图列表,以返回值属性名作为入参,可选值:
1028
+ heapMemory:堆内存监控图;nonHeapMemory:非堆内存监控图;edenSpace:伊甸区监控图;survivorSpace:幸存者区监控图;oldSpace:老年代监控图;metaSpace:元空间监控图;youngGC:youngGC增量监控图;fullGC:fullGC增量监控图;cpuUsage:cpu使用率监控图;classCount:加载类数监控图;threadPicture:线程图
1027
1029
  */
1028
1030
  RequiredPictures: Array<string>;
1029
1031
  /**
@@ -1170,11 +1172,11 @@ export interface CreateNamespaceResponse {
1170
1172
  */
1171
1173
  export interface RedoTaskBatchRequest {
1172
1174
  /**
1173
- * 任务ID。在任务管理列表页面可以查看任务ID。
1175
+ * 任务ID。在[任务管理](https://console.cloud.tencent.com/tsf/tct?rid=1)列表页查看任务ID。
1174
1176
  */
1175
1177
  TaskId: string;
1176
1178
  /**
1177
- * 任务批次ID。在任务管理页面点击任务ID进入任务详情,进入执行记录列表页,第一列即为任务批次ID。
1179
+ * 任务批次ID。在[任务管理](https://console.cloud.tencent.com/tsf/tct?rid=1)页面点击任务ID进入任务详情,进入执行记录列表页,第一列即为任务批次ID。
1178
1180
  */
1179
1181
  BatchId: string;
1180
1182
  }
@@ -1291,11 +1293,13 @@ export interface TaskRecordPage {
1291
1293
  */
1292
1294
  export interface AssociateBusinessLogConfigRequest {
1293
1295
  /**
1294
- * TSF分组ID
1296
+ * 部署组ID
1297
+ 可通过调用[DescribeContainerGroups](https://cloud.tencent.com/document/product/649/36068)或[DescribeGroups](https://cloud.tencent.com/document/product/649/36065)查询已创建的部署组列表或登录[控制台](https://console.cloud.tencent.com/tsf/app-detail?rid=1&id=application-yo7kp9dv&tab=publish&subTab=group)进行查看
1295
1298
  */
1296
1299
  GroupId: string;
1297
1300
  /**
1298
1301
  * 日志配置项ID列表
1302
+ 可通过调用[DescribeBusinessLogConfigs](https://cloud.tencent.com/document/product/649/75777)查询已创建的日志配置项列表或登录[控制台](https://console.cloud.tencent.com/tsf/observable/log?rid=1)进行查看
1299
1303
  */
1300
1304
  ConfigIdList?: Array<string>;
1301
1305
  }
@@ -1317,7 +1321,8 @@ export interface DescribeJvmMonitorResponse {
1317
1321
  */
1318
1322
  export interface DescribeDeliveryConfigRequest {
1319
1323
  /**
1320
- * 投递配置id
1324
+ * 日志配置项ID
1325
+ 可通过调用[DescribeBusinessLogConfigs](https://cloud.tencent.com/document/product/649/75777)查询已创建的日志配置项列表或登录[控制台](https://console.cloud.tencent.com/tsf/observable/log?rid=1)进行查看
1321
1326
  */
1322
1327
  ConfigId: string;
1323
1328
  }
@@ -1452,7 +1457,7 @@ export interface DescribeUnitRuleResponse {
1452
1457
  */
1453
1458
  export interface DeleteImageTagsRequest {
1454
1459
  /**
1455
- * 镜像版本数组
1460
+ * 需要删除的镜像版本列表,可通过调用[DescribeImageTags](https://cloud.tencent.com/document/api/649/36052)查询已创建的镜像版本列表或登录控制台进行查看。
1456
1461
  */
1457
1462
  ImageTags: Array<DeleteImageTag>;
1458
1463
  /**
@@ -1520,7 +1525,7 @@ export interface RollbackConfigRequest {
1520
1525
  */
1521
1526
  export interface DisassociateBusinessLogConfigResponse {
1522
1527
  /**
1523
- * 操作结果
1528
+ * 操作结果,true:成功,false:失败。
1524
1529
  */
1525
1530
  Result?: boolean;
1526
1531
  /**
@@ -1957,7 +1962,7 @@ export interface DescribeResourceConfigResponse {
1957
1962
  */
1958
1963
  export interface StartContainerGroupRequest {
1959
1964
  /**
1960
- * 部署组ID
1965
+ * 部署组ID,可通过调用[DescribeContainerGroups](https://cloud.tencent.com/document/api/649/36068)查询已创建的部署组列表或登录控制台进行查看;也可以调用[CreateContainGroup](https://cloud.tencent.com/document/api/649/36075)创建新的部署组。
1961
1966
  */
1962
1967
  GroupId: string;
1963
1968
  }
@@ -2192,7 +2197,7 @@ export interface Instance {
2192
2197
  */
2193
2198
  export interface UpdateHealthCheckSettingsRequest {
2194
2199
  /**
2195
- * 部署组ID
2200
+ * 部署组ID,可通过调用[DescribeContainerGroups](https://cloud.tencent.com/document/api/649/36068)查询已创建的部署组列表或登录控制台进行查看;也可以调用[CreateContainGroup](https://cloud.tencent.com/document/api/649/36075)创建新的部署组。
2196
2201
  */
2197
2202
  GroupId: string;
2198
2203
  /**
@@ -2440,7 +2445,7 @@ export interface CreateNamespaceRequest {
2440
2445
  */
2441
2446
  NamespaceName: string;
2442
2447
  /**
2443
- * 集群ID
2448
+ * 集群ID,按照【集群ID】进行过滤,可通过调用[DescribeClusters](https://cloud.tencent.com/document/product/649/85857)查询已创建的集群列表或登录控制台进行查看;也可以调用[CreateCluster](https://cloud.tencent.com/document/product/649/36049)创建新的集群。仅在集群下无部署组、命名空间、云主机时可以删除。
2444
2449
  */
2445
2450
  ClusterId?: string;
2446
2451
  /**
@@ -2448,7 +2453,7 @@ export interface CreateNamespaceRequest {
2448
2453
  */
2449
2454
  NamespaceDesc?: string;
2450
2455
  /**
2451
- * 命名空间资源类型(默认值为DEF)
2456
+ * 命名空间资源类型(默认值为DEF)。DEF:默认普通命名空间。GLOBAL:全局命名空间
2452
2457
  */
2453
2458
  NamespaceResourceType?: string;
2454
2459
  /**
@@ -2456,7 +2461,7 @@ export interface CreateNamespaceRequest {
2456
2461
  */
2457
2462
  NamespaceType?: string;
2458
2463
  /**
2459
- * 命名空间ID
2464
+ * 命名空间ID,按照【命名空间ID】进行过滤,可通过调用[DescribeNamespaces](https://cloud.tencent.com/document/product/649/36096)查询已创建的命名空间列表或登录控制台进行查看;也可以调用[CreateNamespace](https://cloud.tencent.com/document/product/649/36098)创建新命名空间。
2460
2465
  */
2461
2466
  NamespaceId?: string;
2462
2467
  /**
@@ -2464,13 +2469,17 @@ export interface CreateNamespaceRequest {
2464
2469
  */
2465
2470
  IsHaEnable?: string;
2466
2471
  /**
2467
- * 需要绑定的数据集ID
2472
+ * 需要绑定的数据集ID,可通过调用[DescribePrograms](https://cloud.tencent.com/document/api/649/73477)查询已创建的数据集列表或登录控制台进行查看;也可以调用[CreateProgram](https://cloud.tencent.com/document/api/649/108544)创建新的数据集。
2468
2473
  */
2469
2474
  ProgramId?: string;
2470
2475
  /**
2471
- * 需要绑定的数据集ID
2476
+ * 需要绑定的数据集ID列表,可通过调用[DescribePrograms](https://cloud.tencent.com/document/api/649/73477)查询已创建的数据集列表或登录控制台进行查看;也可以调用[CreateProgram](https://cloud.tencent.com/document/api/649/108544)创建新的数据集。
2472
2477
  */
2473
2478
  ProgramIdList?: Array<string>;
2479
+ /**
2480
+ * 是否创建k8s命名空间标识
2481
+ */
2482
+ CreateK8sNamespaceFlag?: boolean;
2474
2483
  }
2475
2484
  /**
2476
2485
  * DescribeDownloadInfo请求参数结构体
@@ -2513,7 +2522,7 @@ export interface ContainerGroupObservabilityConfig {
2513
2522
  */
2514
2523
  export interface DescribeClusterInstancesRequest {
2515
2524
  /**
2516
- * 集群ID
2525
+ * 集群 ID。调用[DescribeSimpleClusters](https://cloud.tencent.com/document/api/649/36047)查询已创建的集群或通过[CreateCluster](https://cloud.tencent.com/document/api/649/36049)接口创建新的集群。
2517
2526
  */
2518
2527
  ClusterId: string;
2519
2528
  /**
@@ -2525,15 +2534,15 @@ export interface DescribeClusterInstancesRequest {
2525
2534
  */
2526
2535
  OrderBy?: string;
2527
2536
  /**
2528
- * 排序类型
2537
+ * 排序类型;0:升序,1:降序。
2529
2538
  */
2530
2539
  OrderType?: number;
2531
2540
  /**
2532
- * 偏移量
2541
+ * 偏移量,默认值:0。
2533
2542
  */
2534
2543
  Offset?: number;
2535
2544
  /**
2536
- * 分页个数
2545
+ * 分页个数,默认值:20。
2537
2546
  */
2538
2547
  Limit?: number;
2539
2548
  }
@@ -2620,7 +2629,7 @@ export interface DescribeResourceTaskStatusResponse {
2620
2629
  */
2621
2630
  export interface RedoTaskRequest {
2622
2631
  /**
2623
- * 任务ID。在任务管理列表页面第一列查看任务ID。
2632
+ * 任务ID。在[任务管理](https://console.cloud.tencent.com/tsf/tct?rid=1)列表页查看任务ID。
2624
2633
  */
2625
2634
  TaskId: string;
2626
2635
  }
@@ -2891,10 +2900,11 @@ export interface DescribeContainerGroupDeployInfoResponse {
2891
2900
  export interface DescribeOverviewInvocationRequest {
2892
2901
  /**
2893
2902
  * 命名空间ID, 此参数必填
2903
+ 可通过[DescribeSimpleNamespaces](https://cloud.tencent.com/document/product/649/36096)查询已经创建的命名空间,也可以通过登录[控制台](https://console.cloud.tencent.com/tsf/resource?rid=1&tab=namespace)查看
2894
2904
  */
2895
2905
  NamespaceId?: string;
2896
2906
  /**
2897
- * 监控统计类型,必填,可选值:SumReqAmountAvgFailureRateAvgTimeCost,分别对应请求量、请求错误率、平均响应耗时
2907
+ * 监控统计类型,必填,取值范围 SumReqAmount:请求量,AvgFailureRate:请求错误率,AvgTimeCost:平均响应耗时
2898
2908
  */
2899
2909
  Type?: string;
2900
2910
  /**
@@ -2902,11 +2912,11 @@ export interface DescribeOverviewInvocationRequest {
2902
2912
  */
2903
2913
  Period?: number;
2904
2914
  /**
2905
- * 查询开始时间,默认为当天的 00:00:00
2915
+ * 查询开始时间,格式为yyyy-MM-dd HH:mm:ss,默认为当天的 00:00:00
2906
2916
  */
2907
2917
  StartTime?: string;
2908
2918
  /**
2909
- * 查询结束时间,默认为当前时间
2919
+ * 查询结束时间,格式为yyyy-MM-dd HH:mm:ss,默认为当前时间
2910
2920
  */
2911
2921
  EndTime?: string;
2912
2922
  }
@@ -3260,11 +3270,13 @@ export interface UpdateRepositoryResponse {
3260
3270
  */
3261
3271
  export interface DisassociateKafkaConfigRequest {
3262
3272
  /**
3263
- * 配置项id
3273
+ * 日志配置项ID
3274
+ 可通过调用[DescribeBusinessLogConfigs](https://cloud.tencent.com/document/product/649/75777)查询已创建的日志配置项列表或登录[控制台](https://console.cloud.tencent.com/tsf/observable/log?rid=1)进行查看
3264
3275
  */
3265
3276
  ConfigId: string;
3266
3277
  /**
3267
- * 部署组id
3278
+ * 部署组ID列表
3279
+ 可通过调用[DescribeContainerGroups](https://cloud.tencent.com/document/product/649/36068)或[DescribeGroups](https://cloud.tencent.com/document/product/649/36065)查询已创建的部署组列表或登录[控制台](https://console.cloud.tencent.com/tsf/app-detail?rid=1&id=application-yo7kp9dv&tab=publish&subTab=group)进行查看
3268
3280
  */
3269
3281
  GroupIds?: Array<string>;
3270
3282
  }
@@ -3354,7 +3366,7 @@ export interface StartContainerGroupResponse {
3354
3366
  */
3355
3367
  export interface ModifyTaskRequest {
3356
3368
  /**
3357
- * 任务ID。在任务管理列表页面第一列查看任务ID。
3369
+ * 任务ID。在[任务管理](https://console.cloud.tencent.com/tsf/tct?rid=1)列表页查看任务ID。
3358
3370
  */
3359
3371
  TaskId: string;
3360
3372
  /**
@@ -3488,7 +3500,7 @@ export interface CreateAllGatewayApiAsyncResponse {
3488
3500
  */
3489
3501
  export interface RemoveInstancesRequest {
3490
3502
  /**
3491
- * 集群 ID
3503
+ * 集群 ID。调用[DescribeSimpleClusters](https://cloud.tencent.com/document/api/649/36047)查询已创建的集群或通过[CreateCluster](https://cloud.tencent.com/document/api/649/36049)接口创建新的集群。
3492
3504
  */
3493
3505
  ClusterId: string;
3494
3506
  /**
@@ -3544,7 +3556,7 @@ export interface DeleteGroupResponse {
3544
3556
  */
3545
3557
  export interface DeployContainerGroupRequest {
3546
3558
  /**
3547
- * 部署组ID,分组唯一标识
3559
+ * 部署组ID,可通过调用[DescribeContainerGroups](https://cloud.tencent.com/document/api/649/36068)查询已创建的部署组列表或登录控制台进行查看;也可以调用[CreateContainGroup](https://cloud.tencent.com/document/api/649/36075)创建新的部署组。
3548
3560
  */
3549
3561
  GroupId: string;
3550
3562
  /**
@@ -3751,19 +3763,22 @@ export interface DescribeContainerGroupAttributeRequest {
3751
3763
  */
3752
3764
  export interface DescribeSimpleApplicationsRequest {
3753
3765
  /**
3754
- * 应用ID列表
3766
+ * 应用ID列表,可通过调用[DescribeApplications](https://cloud.tencent.com/document/api/649/36090)查询已创建的应用列表或登录控制台进行查看;也可以调用[CreateApplication](https://cloud.tencent.com/document/api/649/36094)创建新的应用。
3755
3767
  */
3756
3768
  ApplicationIdList?: Array<string>;
3757
3769
  /**
3758
- * 应用类型
3770
+ * 指定应用类型,目前支持:
3771
+ - `V`:普通应用/CVM应用
3772
+ - `C`:容器应用
3773
+ - `S`:serverless 应用
3759
3774
  */
3760
3775
  ApplicationType?: string;
3761
3776
  /**
3762
- * 每页条数
3777
+ * 数量限制,默认为20,最大值为100。关于Limit详见[API简介](https://cloud.tencent.com/document/api/213/568#.E8.BE.93.E5.85.A5.E5.8F.82.E6.95.B0.E4.B8.8E.E8.BF.94.E5.9B.9E.E5.8F.82.E6.95.B0.E9.87.8A.E4.B9.89)
3763
3778
  */
3764
3779
  Limit?: number;
3765
3780
  /**
3766
- * 起始偏移量
3781
+ * 偏移量,默认为0。关于Offset详见[API简介](https://cloud.tencent.com/document/api/213/568#.E8.BE.93.E5.85.A5.E5.8F.82.E6.95.B0.E4.B8.8E.E8.BF.94.E5.9B.9E.E5.8F.82.E6.95.B0.E9.87.8A.E4.B9.89)
3767
3782
  */
3768
3783
  Offset?: number;
3769
3784
  /**
@@ -3779,7 +3794,7 @@ export interface DescribeSimpleApplicationsRequest {
3779
3794
  */
3780
3795
  SearchWord?: string;
3781
3796
  /**
3782
- *
3797
+ * 是否关闭鉴权查询
3783
3798
  */
3784
3799
  DisableProgramAuthCheck?: boolean;
3785
3800
  /**
@@ -3805,7 +3820,7 @@ export interface DescribeDeliveryConfigByGroupIdResponse {
3805
3820
  */
3806
3821
  export interface ModifyContainerGroupRequest {
3807
3822
  /**
3808
- * 部署组ID,可通过调用[DescribeContainerGroups](https://cloud.tencent.com/document/api/649/36068)查询已创建的项目列表或登录控制台进行查看;也可以调用[CreateContainGroup](https://cloud.tencent.com/document/api/649/36075)创建新的项目。
3823
+ * 部署组ID,可通过调用[DescribeContainerGroups](https://cloud.tencent.com/document/api/649/36068)查询已创建的部署组列表或登录控制台进行查看;也可以调用[CreateContainGroup](https://cloud.tencent.com/document/api/649/36075)创建新的部署组。
3809
3824
  */
3810
3825
  GroupId: string;
3811
3826
  /**
@@ -3825,7 +3840,7 @@ export interface ModifyContainerGroupRequest {
3825
3840
  */
3826
3841
  UpdateIvl?: number;
3827
3842
  /**
3828
- * 子网ID,可通过调用[DescribeSubnets](https://cloud.tencent.com/document/product/215/15784)查询已创建的项目列表或登录控制台进行查看;也可以调用[CreateSubnet](https://cloud.tencent.com/document/product/1108/43594)创建新的项目。
3843
+ * 子网ID,可通过调用[DescribeSubnets](https://cloud.tencent.com/document/product/215/15784)查询已创建的子网列表或登录控制台进行查看;也可以调用[CreateSubnet](https://cloud.tencent.com/document/product/1108/43594)创建新的子网。
3829
3844
  */
3830
3845
  SubnetId?: string;
3831
3846
  /**
@@ -4042,7 +4057,7 @@ export interface UpdateApiRateLimitRulesRequest {
4042
4057
  */
4043
4058
  export interface DescribeGroupInstancesRequest {
4044
4059
  /**
4045
- * 部署组ID
4060
+ * 部署组ID,可通过调用[DescribeGroups](https://cloud.tencent.com/document/api/649/36065)查询已创建的部署组列表或登录控制台进行查看;也可以调用[CreateGroup](https://cloud.tencent.com/document/api/649/36074)创建新的部署组。
4046
4061
  */
4047
4062
  GroupId: string;
4048
4063
  /**
@@ -4054,15 +4069,15 @@ export interface DescribeGroupInstancesRequest {
4054
4069
  */
4055
4070
  OrderBy?: string;
4056
4071
  /**
4057
- * 排序类型
4072
+ * 排序类型;0:升序,1:降序
4058
4073
  */
4059
4074
  OrderType?: number;
4060
4075
  /**
4061
- * 偏移量
4076
+ * 偏移量,默认值:0
4062
4077
  */
4063
4078
  Offset?: number;
4064
4079
  /**
4065
- * 分页个数
4080
+ * 分页个数;默认值:20
4066
4081
  */
4067
4082
  Limit?: number;
4068
4083
  }
@@ -4158,7 +4173,7 @@ export interface DescribeMsApiListResponse {
4158
4173
  */
4159
4174
  export interface EnableTaskRequest {
4160
4175
  /**
4161
- * 任务ID。在任务管理列表页面和任务基本信息页可以查看任务ID。
4176
+ * 任务ID。[任务管理](https://console.cloud.tencent.com/tsf/tct?rid=1)列表页查看任务ID。
4162
4177
  */
4163
4178
  TaskId: string;
4164
4179
  }
@@ -4175,7 +4190,7 @@ export interface BusinessLogV2 {
4175
4190
  */
4176
4191
  Content?: string;
4177
4192
  /**
4178
- * 日志时间戳
4193
+ * 日志时间戳,单位毫秒
4179
4194
  */
4180
4195
  Timestamp?: number;
4181
4196
  /**
@@ -4362,23 +4377,23 @@ export interface FileConfigRelease {
4362
4377
  */
4363
4378
  export interface DescribeInvocationMetricDataPointRequest {
4364
4379
  /**
4365
- * 开始时间
4380
+ * 开始时间,格式yyyy-MM-dd HH:mm:ss
4366
4381
  */
4367
4382
  StartTime: string;
4368
4383
  /**
4369
- * 结束时间
4384
+ * 结束时间,格式yyyy-MM-dd HH:mm:ss
4370
4385
  */
4371
4386
  EndTime: string;
4372
4387
  /**
4373
- * 维度,并且 维度 key value 不能为空
4388
+ * 查询指标维度, 不能为空
4374
4389
  */
4375
4390
  MetricDimensionValues: Array<MetricDimensionValue>;
4376
4391
  /**
4377
- * 指标,并且 key, value 不能为空
4392
+ * 指标,不能为空
4378
4393
  */
4379
4394
  Metrics: Array<Metric>;
4380
4395
  /**
4381
- * 调用视角。可选值:SERVER, CLIENT。默认为SERVER
4396
+ * 视图视角。可选值:SERVER:服务端, CLIENT:客户端。默认为SERVER
4382
4397
  */
4383
4398
  Kind?: string;
4384
4399
  }
@@ -4487,7 +4502,7 @@ export interface ContainerAdditionalResourceRequirement {
4487
4502
  */
4488
4503
  export interface DeleteClusterRequest {
4489
4504
  /**
4490
- * 集群ID
4505
+ * 集群ID,按照【集群ID】进行过滤,可通过调用DescribeClusters查询已创建的项目列表或登录控制台进行查看;也可以调用CreateCluster创建新的项目。集群ID例如:cls-6a79x94v。仅在集群下无部署组、命名空间、云主机时可以删除。
4491
4506
  */
4492
4507
  ClusterId: string;
4493
4508
  /**
@@ -4500,7 +4515,7 @@ export interface DeleteClusterRequest {
4500
4515
  */
4501
4516
  export interface StopTaskBatchResponse {
4502
4517
  /**
4503
- * 操作成功 or 失败
4518
+ * 返回 true 或 false。true:操作成功,false:操作失败
4504
4519
  */
4505
4520
  Result?: boolean;
4506
4521
  /**
@@ -4521,7 +4536,7 @@ export interface ServiceStatisticsResult {
4521
4536
  */
4522
4537
  Method?: string;
4523
4538
  /**
4524
- * 微服务Id
4539
+ * 微服务ID
4525
4540
  */
4526
4541
  MicroserviceId?: string;
4527
4542
  /**
@@ -4553,7 +4568,7 @@ export interface ServiceStatisticsResult {
4553
4568
  */
4554
4569
  InstanceName?: string;
4555
4570
  /**
4556
- * 部署组id
4571
+ * 部署组ID
4557
4572
  */
4558
4573
  GroupId?: string;
4559
4574
  /**
@@ -4561,7 +4576,7 @@ export interface ServiceStatisticsResult {
4561
4576
  */
4562
4577
  GroupName?: string;
4563
4578
  /**
4564
- * 部署组类型
4579
+ * 集群类型,C:容器集群,V:虚拟机集群
4565
4580
  */
4566
4581
  ClusterType?: string;
4567
4582
  /**
@@ -4573,11 +4588,11 @@ export interface ServiceStatisticsResult {
4573
4588
  */
4574
4589
  InstanceExist?: number;
4575
4590
  /**
4576
- * 应用id
4591
+ * 应用ID
4577
4592
  */
4578
4593
  ApplicationId?: string;
4579
4594
  /**
4580
- * 微服务类型
4595
+ * 微服务类型。RAW:裸应用,M:mesh应用,N:普通应用,G:网关应用
4581
4596
  */
4582
4597
  MicroserviceType?: string;
4583
4598
  /**
@@ -4617,19 +4632,19 @@ export interface ServiceStatisticsResult {
4617
4632
  */
4618
4633
  InstanceTotalCount?: number;
4619
4634
  /**
4620
- * normal/error
4635
+ * 状态。normal:正常,warn:警告,error:错误
4621
4636
  */
4622
4637
  Status?: string;
4623
4638
  /**
4624
- * normal/warn/error
4639
+ * 请求错误率等级。normal:正常,warn:警告,error:错误
4625
4640
  */
4626
4641
  ErrorRateLevel?: string;
4627
4642
  /**
4628
- * normal/warn/error
4643
+ * 请求平均耗时等级。normal:正常,warn:警告,error:错误
4629
4644
  */
4630
4645
  AvgTimeConsumingLevel?: string;
4631
4646
  /**
4632
- * normal/warn/error
4647
+ * 应用程序性能指数等级。normal:正常,warn:警告,error:错误
4633
4648
  */
4634
4649
  ApdexLevel?: string;
4635
4650
  }
@@ -4664,7 +4679,7 @@ export interface DescribeContainerGroupDetailResponse {
4664
4679
  */
4665
4680
  export interface DisableTaskRequest {
4666
4681
  /**
4667
- * 任务ID。在[任务管理](https://console.cloud.tencent.com/tsf/tct?rid=1)列表页第一列或是任务基本信息页查看任务ID。
4682
+ * 任务ID[任务管理](https://console.cloud.tencent.com/tsf/tct?rid=1)列表页查看任务ID。
4668
4683
  */
4669
4684
  TaskId: string;
4670
4685
  }
@@ -4690,7 +4705,7 @@ export interface Ports {
4690
4705
  */
4691
4706
  TargetPort: number;
4692
4707
  /**
4693
- * 端口协议
4708
+ * 端口协议,TCP或者UDP
4694
4709
  */
4695
4710
  Protocol: string;
4696
4711
  }
@@ -4870,11 +4885,11 @@ export interface RemoveInstancesResponse {
4870
4885
  */
4871
4886
  export interface DescribeContainerEventsRequest {
4872
4887
  /**
4873
- * event 的资源类型, group 或者 instance
4888
+ * event 的资源类型, 仅支持 group
4874
4889
  */
4875
4890
  ResourceType: string;
4876
4891
  /**
4877
- * event 的资源 id
4892
+ * 部署组ID,按照【部署组ID】进行过滤,可通过调用DescribeGroups查询已创建的项目列表或登录控制台进行查看;也可以调用CreateGroup创建新的项目。部署组ID例如:group-9yn2q8yd
4878
4893
  */
4879
4894
  ResourceId: string;
4880
4895
  /**
@@ -4886,15 +4901,15 @@ export interface DescribeContainerEventsRequest {
4886
4901
  */
4887
4902
  Limit?: number;
4888
4903
  /**
4889
- * 当类型是 instance 时需要
4904
+ * 部署组ID,按照【部署组ID】进行过滤,可通过调用DescribeGroups查询已创建的项目列表或登录控制台进行查看;也可以调用CreateGroup创建新的项目。部署组ID例如:group-9yn2q8yd。
4890
4905
  */
4891
4906
  GroupId?: string;
4892
4907
  /**
4893
- * event的资源kind
4908
+ * event的资源种类
4894
4909
  */
4895
4910
  Kind?: string;
4896
4911
  /**
4897
- * event 的type
4912
+ * event 的事件级别
4898
4913
  */
4899
4914
  Type?: string;
4900
4915
  /**
@@ -5016,7 +5031,7 @@ export interface Env {
5016
5031
  */
5017
5032
  export interface ModifyClusterRequest {
5018
5033
  /**
5019
- * 集群ID
5034
+ * 集群ID,按照【集群ID】进行过滤,可通过调用DescribeClusters查询已创建的项目列表或登录控制台进行查看;也可以调用CreateCluster创建新的项目。集群ID例如:cls-6a79x94v。
5020
5035
  */
5021
5036
  ClusterId: string;
5022
5037
  /**
@@ -5032,11 +5047,11 @@ export interface ModifyClusterRequest {
5032
5047
  */
5033
5048
  ClusterRemarkName?: string;
5034
5049
  /**
5035
- * 是否开启cls日志功能
5050
+ * 是否开启cls日志功能,true表示开启,false表示关闭
5036
5051
  */
5037
5052
  EnableLogCollection?: boolean;
5038
5053
  /**
5039
- * 是否修复cls日志功能
5054
+ * 是否修复cls日志功能,true表示修复,false表示不修复
5040
5055
  */
5041
5056
  RepairLog?: boolean;
5042
5057
  }
@@ -5045,11 +5060,11 @@ export interface ModifyClusterRequest {
5045
5060
  */
5046
5061
  export interface Resource {
5047
5062
  /**
5048
- * 资源ID
5063
+ * 资源ID,调用[DescribeResource](https://console.cloud.tencent.com/tsf/privilege-program-create?rid=1)查询接口获取
5049
5064
  */
5050
5065
  ResourceId?: string;
5051
5066
  /**
5052
- * 资源编码
5067
+ * 资源编码,枚举值描述【cluster、namespace、config】
5053
5068
  */
5054
5069
  ResourceCode?: string;
5055
5070
  /**
@@ -5057,15 +5072,15 @@ export interface Resource {
5057
5072
  */
5058
5073
  ResourceName?: string;
5059
5074
  /**
5060
- * 资源所属产品编码
5075
+ * 资源所属产品编码,枚举值描述【tsf】
5061
5076
  */
5062
5077
  ServiceCode?: string;
5063
5078
  /**
5064
- * 选取资源使用的Action
5079
+ * 选取资源使用的Action,枚举值描述【DescribeSimpleCluster、DescribeLanes、DescribeTaskRecords】
5065
5080
  */
5066
5081
  ResourceAction?: string;
5067
5082
  /**
5068
- * 资源数据查询的ID字段名
5083
+ * 资源数据查询的ID字段名,调用[DescribeResource](https://console.cloud.tencent.com/tsf/privilege-program-create?rid=1)查询接口获取
5069
5084
  */
5070
5085
  IdField?: string;
5071
5086
  /**
@@ -5077,11 +5092,11 @@ export interface Resource {
5077
5092
  */
5078
5093
  SelectIdsField?: string;
5079
5094
  /**
5080
- * 创建时间
5095
+ * 创建时间,时间戳格式【Long】
5081
5096
  */
5082
5097
  CreationTime?: number;
5083
5098
  /**
5084
- * 最后更新时间
5099
+ * 最后更新时间,时间戳格式【Long】
5085
5100
  */
5086
5101
  LastUpdateTime?: number;
5087
5102
  /**
@@ -5101,7 +5116,7 @@ export interface Resource {
5101
5116
  */
5102
5117
  SearchWordField?: string;
5103
5118
  /**
5104
- * 排序
5119
+ * 排序,枚举值描述【10、20、77】
5105
5120
  */
5106
5121
  Index?: number;
5107
5122
  }
@@ -5243,7 +5258,7 @@ export interface DisableUnitRouteResponse {
5243
5258
  */
5244
5259
  export interface ExecuteTaskRequest {
5245
5260
  /**
5246
- * 任务ID。在任务管理列表页面第一列或是任务基本信息页查看任务ID。
5261
+ * 任务ID。在[任务管理](https://console.cloud.tencent.com/tsf/tct?rid=1)列表页查看任务ID。
5247
5262
  */
5248
5263
  TaskId: string;
5249
5264
  }
@@ -5252,7 +5267,8 @@ export interface ExecuteTaskRequest {
5252
5267
  */
5253
5268
  export interface DescribeGroupBusinessLogConfigsRequest {
5254
5269
  /**
5255
- * 分组ID
5270
+ * 部署组ID
5271
+ 可通过调用[DescribeContainerGroups](https://cloud.tencent.com/document/product/649/36068)或[DescribeGroups](https://cloud.tencent.com/document/product/649/36065)查询已创建的部署组列表或登录[控制台](https://console.cloud.tencent.com/tsf/app-detail?rid=1&id=application-yo7kp9dv&tab=publish&subTab=group)进行查看
5256
5272
  */
5257
5273
  GroupId: string;
5258
5274
  }
@@ -5388,7 +5404,8 @@ export interface DescribeSimpleNamespacesResponse {
5388
5404
  */
5389
5405
  export interface GroupInfo {
5390
5406
  /**
5391
- * 部署组id
5407
+ * 部署组ID
5408
+ 可通过调用[DescribeContainerGroups](https://cloud.tencent.com/document/product/649/36068)或[DescribeGroups](https://cloud.tencent.com/document/product/649/36065)查询已创建的部署组列表或登录[控制台](https://console.cloud.tencent.com/tsf/app-detail?rid=1&id=application-yo7kp9dv&tab=publish&subTab=group)进行查看。
5392
5409
  */
5393
5410
  GroupId: string;
5394
5411
  /**
@@ -5396,11 +5413,12 @@ export interface GroupInfo {
5396
5413
  */
5397
5414
  GroupName: string;
5398
5415
  /**
5399
- * 集群类型
5416
+ * 集群类型,C:容器集群,V:虚拟机集群
5400
5417
  */
5401
5418
  ClusterType: string;
5402
5419
  /**
5403
- * 集群id
5420
+ * 集群ID
5421
+ 可通过[DescribeClusters](https://cloud.tencent.com/document/product/649/85857)查询已经创建的集群列表,也可以通过登录[控制台](https://console.cloud.tencent.com/tsf/resource?rid=1)查看。
5404
5422
  */
5405
5423
  ClusterId?: string;
5406
5424
  /**
@@ -5412,7 +5430,7 @@ export interface GroupInfo {
5412
5430
  */
5413
5431
  NamespaceName?: string;
5414
5432
  /**
5415
- * 绑定时间
5433
+ * 绑定时间,格式yyyy-MM-dd HH:mm:ss
5416
5434
  */
5417
5435
  AssociateTime?: string;
5418
5436
  }
@@ -5434,7 +5452,7 @@ export interface TerminateTaskFlowBatchResponse {
5434
5452
  */
5435
5453
  export interface DisassociateKafkaConfigResponse {
5436
5454
  /**
5437
- * 解除绑定是否成功
5455
+ * 解除绑定是否成功,true:成功,false:失败。
5438
5456
  */
5439
5457
  Result?: boolean;
5440
5458
  /**
@@ -5581,11 +5599,11 @@ export interface ContainerGroupOther {
5581
5599
  */
5582
5600
  export interface AddClusterInstancesRequest {
5583
5601
  /**
5584
- * 集群ID
5602
+ * 集群ID,按照【集群ID】进行过滤,可通过调用[DescribeClusters](https://cloud.tencent.com/document/product/649/85857)查询已创建的集群列表或登录控制台进行查看;也可以调用[CreateCluster](https://cloud.tencent.com/document/product/649/36049)创建新的集群。仅在集群下无部署组、命名空间、云主机时可以删除。
5585
5603
  */
5586
5604
  ClusterId: string;
5587
5605
  /**
5588
- * 云主机ID列表
5606
+ * 云主机ID列表,可通过调用[DescribeInstances](https://cloud.tencent.com/document/api/213/15728)查询已创建的云主机列表或登录控制台进行查看;也可以调用[RunInstances](https://cloud.tencent.com/document/api/213/15730)创建新的云主机。
5589
5607
  */
5590
5608
  InstanceIdList: Array<string>;
5591
5609
  /**
@@ -5799,7 +5817,7 @@ export interface ContainerGroupDeploy {
5799
5817
  */
5800
5818
  TcrRepoInfo?: TcrRepoInfo;
5801
5819
  /**
5802
- * 数据卷信息,list
5820
+ * 数据卷信息,数组结构
5803
5821
  注意:此字段可能返回 null,表示取不到有效值。
5804
5822
  */
5805
5823
  VolumeInfos?: Array<VolumeInfo>;
@@ -5880,6 +5898,10 @@ export interface VolumeInfo {
5880
5898
  * -
5881
5899
  */
5882
5900
  EmptyDirOption?: EmptyDirOption;
5901
+ /**
5902
+ * 数据卷PVC声明模板
5903
+ */
5904
+ VolumeClaimTemplateOption?: VolumeClaimTemplatesOption;
5883
5905
  }
5884
5906
  /**
5885
5907
  * UpdateApiTimeouts请求参数结构体
@@ -5907,7 +5929,7 @@ export interface Metric {
5907
5929
  */
5908
5930
  Name?: string;
5909
5931
  /**
5910
- * 指标计算方式
5932
+ * 指标计算方式,可选值: none:无,sum:求和,exclusive:独占值,avg:平均值,max:最大值,min:最小值,percentage_50:50分位数,percentage_75:75分位数,percentage_95:95分位数,percentage_99:99分位数,bucket_5:分桶统计。
5911
5933
  */
5912
5934
  Function?: string;
5913
5935
  }
@@ -5942,23 +5964,23 @@ export interface ShrinkInstancesRequest {
5942
5964
  */
5943
5965
  export interface DescribeSimpleNamespacesRequest {
5944
5966
  /**
5945
- * 命名空间ID列表,不传入时查询全量
5967
+ * 命名空间ID列表,按照【命名空间ID列表】进行过滤,可通过调用[DescribeNamespaces](https://cloud.tencent.com/document/product/649/36096)查询已创建的命名空间列表或登录控制台进行查看;也可以调用[CreateNamespace](https://cloud.tencent.com/document/product/649/36098)创建新的命名空间。
5946
5968
  */
5947
5969
  NamespaceIdList?: Array<string>;
5948
5970
  /**
5949
- * 集群ID,不传入时查询全量
5971
+ * 集群ID,按照【集群ID】进行过滤,可通过调用[DescribeClusters](https://cloud.tencent.com/document/product/649/85857)查询已创建的集群列表或登录控制台进行查看;也可以调用[CreateCluster](https://cloud.tencent.com/document/product/649/36049)创建新的集群。仅在集群下无部署组、命名空间、云主机时可以删除。
5950
5972
  */
5951
5973
  ClusterId?: string;
5952
5974
  /**
5953
- * 每页条数
5975
+ * 数量限制,默认为20,最大值为100。关于Limit详见[API简介](https://cloud.tencent.com/document/api/213/568#.E8.BE.93.E5.85.A5.E5.8F.82.E6.95.B0.E4.B8.8E.E8.BF.94.E5.9B.9E.E5.8F.82.E6.95.B0.E9.87.8A.E4.B9.89)
5954
5976
  */
5955
5977
  Limit?: number;
5956
5978
  /**
5957
- * 起始偏移量
5979
+ * 偏移量,默认为0。关于Offset详见[API简介](https://cloud.tencent.com/document/api/213/568#.E8.BE.93.E5.85.A5.E5.8F.82.E6.95.B0.E4.B8.8E.E8.BF.94.E5.9B.9E.E5.8F.82.E6.95.B0.E9.87.8A.E4.B9.89)
5958
5980
  */
5959
5981
  Offset?: number;
5960
5982
  /**
5961
- * 命名空间ID,不传入时查询全量
5983
+ * 命名空间ID,按照【命名空间ID】进行过滤,可通过调用[DescribeNamespaces](https://cloud.tencent.com/document/product/649/36096)查询已创建的命名空间列表或登录控制台进行查看;也可以调用[CreateNamespace](https://cloud.tencent.com/document/product/649/36098)创建新命名空间。
5962
5984
  */
5963
5985
  NamespaceId?: string;
5964
5986
  /**
@@ -5970,7 +5992,7 @@ export interface DescribeSimpleNamespacesRequest {
5970
5992
  */
5971
5993
  SearchWord?: string;
5972
5994
  /**
5973
- * 查询的命名空间类型列表
5995
+ * 查询的命名空间类型列表。DEF:默认普通命名空间。GLOBAL:全局命名空间。
5974
5996
  */
5975
5997
  NamespaceTypeList?: Array<string>;
5976
5998
  /**
@@ -5978,7 +6000,7 @@ export interface DescribeSimpleNamespacesRequest {
5978
6000
  */
5979
6001
  NamespaceName?: string;
5980
6002
  /**
5981
- * 通过是否是默认命名空间过滤,不传表示拉取全部命名空间。0:默认命名空间。1:非默认命名空间
6003
+ * 通过是否是默认命名空间过滤,不传表示拉取全部命名空间。0:默认命名空间。1:非默认命名空间。
5982
6004
  */
5983
6005
  IsDefault?: string;
5984
6006
  /**
@@ -6018,6 +6040,7 @@ export interface DescribeClustersResponse {
6018
6040
  export interface SearchBusinessLogRequest {
6019
6041
  /**
6020
6042
  * 日志配置项ID
6043
+ 可通过调用[DescribeBusinessLogConfigs](https://cloud.tencent.com/document/product/649/75777)查询已创建的日志配置项列表或登录[控制台](https://console.cloud.tencent.com/tsf/observable/log?rid=1)进行查看
6021
6044
  */
6022
6045
  ConfigId: string;
6023
6046
  /**
@@ -6025,11 +6048,11 @@ export interface SearchBusinessLogRequest {
6025
6048
  */
6026
6049
  InstanceIds?: Array<string>;
6027
6050
  /**
6028
- * 开始时间
6051
+ * 开始时间,格式yyyy-MM-dd HH:mm:ss
6029
6052
  */
6030
6053
  StartTime?: string;
6031
6054
  /**
6032
- * 结束时间
6055
+ * 结束时间,格式yyyy-MM-dd HH:mm:ss
6033
6056
  */
6034
6057
  EndTime?: string;
6035
6058
  /**
@@ -6054,14 +6077,15 @@ export interface SearchBusinessLogRequest {
6054
6077
  SearchWords?: Array<string>;
6055
6078
  /**
6056
6079
  * 部署组ID列表,不传表示全部部署组
6080
+ 可通过调用[DescribeContainerGroups](https://cloud.tencent.com/document/product/649/36068)或[DescribeGroups](https://cloud.tencent.com/document/product/649/36065)查询已创建的部署组列表或登录[控制台](https://console.cloud.tencent.com/tsf/app-detail?rid=1&id=application-yo7kp9dv&tab=publish&subTab=group)进行查看
6057
6081
  */
6058
6082
  GroupIds?: Array<string>;
6059
6083
  /**
6060
- * 检索类型,取值"LUCENE", "REGEXP", "NORMAL"
6084
+ * 检索类型,取值 LUCENE:Lucene检索,REGEXP:正则检索,NORMAL:普通检索
6061
6085
  */
6062
6086
  SearchWordType?: string;
6063
6087
  /**
6064
- * 批量请求类型,取值"page"或"scroll"
6088
+ * 批量请求类型,取值 PAGE:分页查询,SCROLL:滚动查询,SEARCHAFTER:游标查询,默认值PAGE
6065
6089
  */
6066
6090
  BatchType?: string;
6067
6091
  /**
@@ -6290,11 +6314,11 @@ export interface DescribeImageRepositoryRequest {
6290
6314
  */
6291
6315
  SearchWord?: string;
6292
6316
  /**
6293
- * 偏移量,取值从0开始
6317
+ * 偏移量,默认为0。关于Offset详见[API简介](https://cloud.tencent.com/document/api/213/568#.E8.BE.93.E5.85.A5.E5.8F.82.E6.95.B0.E4.B8.8E.E8.BF.94.E5.9B.9E.E5.8F.82.E6.95.B0.E9.87.8A.E4.B9.89)
6294
6318
  */
6295
6319
  Offset?: number;
6296
6320
  /**
6297
- * 分页个数,默认为20, 取值应为1~100
6321
+ * 数量限制,默认为20,最大值为100。关于Limit详见[API简介](https://cloud.tencent.com/document/api/213/568#.E8.BE.93.E5.85.A5.E5.8F.82.E6.95.B0.E4.B8.8E.E8.BF.94.E5.9B.9E.E5.8F.82.E6.95.B0.E9.87.8A.E4.B9.89)
6298
6322
  */
6299
6323
  Limit?: number;
6300
6324
  /**
@@ -6302,7 +6326,7 @@ export interface DescribeImageRepositoryRequest {
6302
6326
  */
6303
6327
  RepoType?: string;
6304
6328
  /**
6305
- * 应用id
6329
+ * 应用ID,可通过调用[DescribeApplications](https://cloud.tencent.com/document/api/649/36090)查询已创建的应用列表或登录控制台进行查看;也可以调用[CreateApplication](https://cloud.tencent.com/document/api/649/36094)创建新的应用。
6306
6330
  */
6307
6331
  ApplicationId?: string;
6308
6332
  /**
@@ -6349,11 +6373,13 @@ export interface TsfPageUnitRule {
6349
6373
  */
6350
6374
  export interface OperateApplicationTcrBindingRequest {
6351
6375
  /**
6352
- * bind 或 unbind
6376
+ * 指定操作类型,目前支持:
6377
+ - `bind`:绑定(默认)
6378
+ - `unbind`:解除绑定
6353
6379
  */
6354
6380
  Command?: string;
6355
6381
  /**
6356
- * 应用id
6382
+ * 应用ID,可通过调用[DescribeApplications](https://cloud.tencent.com/document/api/649/36090)查询已创建的应用列表或登录控制台进行查看;也可以调用[CreateApplication](https://cloud.tencent.com/document/api/649/36094)创建新的应用。
6357
6383
  */
6358
6384
  ApplicationId?: string;
6359
6385
  /**
@@ -6375,7 +6401,7 @@ export interface DescribeApiGroupRequest {
6375
6401
  */
6376
6402
  export interface AssociateBusinessLogConfigResponse {
6377
6403
  /**
6378
- * 操作结果
6404
+ * 操作结果,true:成功,false:失败
6379
6405
  */
6380
6406
  Result?: boolean;
6381
6407
  /**
@@ -6417,7 +6443,8 @@ export interface DescribeGatewayApisRequest {
6417
6443
  */
6418
6444
  export interface AssociateConfigWithGroupRequest {
6419
6445
  /**
6420
- * 配置项id
6446
+ * 配置项ID
6447
+ 可通过调用[DescribeBusinessLogConfigs](https://cloud.tencent.com/document/product/649/75777)查询已创建的日志配置项列表或登录[控制台](https://console.cloud.tencent.com/tsf/observable/log?rid=1)进行查看
6421
6448
  */
6422
6449
  ConfigId: string;
6423
6450
  /**
@@ -6429,11 +6456,13 @@ export interface AssociateConfigWithGroupRequest {
6429
6456
  */
6430
6457
  SelectAll?: number;
6431
6458
  /**
6432
- * 命名空间id
6459
+ * 命名空间ID
6460
+ 可通过[DescribeSimpleNamespaces](https://cloud.tencent.com/document/product/649/36096)查询已经创建的命名空间,也可以通过登录[控制台](https://console.cloud.tencent.com/tsf/resource?rid=1&tab=namespace)查看
6433
6461
  */
6434
6462
  NamespaceId?: string;
6435
6463
  /**
6436
- * 集群id
6464
+ * 集群ID
6465
+ 可通过[DescribeClusters](https://cloud.tencent.com/document/product/649/85857)查询已经创建的集群列表,也可以通过登录[控制台](https://console.cloud.tencent.com/tsf/resource?rid=1)查看
6437
6466
  */
6438
6467
  ClusterId?: string;
6439
6468
  /**
@@ -6629,10 +6658,27 @@ export interface DeleteUnitNamespacesRequest {
6629
6658
  */
6630
6659
  export interface DescribeGroupRequest {
6631
6660
  /**
6632
- * 部署组ID
6661
+ * 部署组ID,可通过调用[DescribeGroups](https://cloud.tencent.com/document/api/649/36065)查询已创建的部署组列表或登录控制台进行查看;也可以调用[CreateGroup](https://cloud.tencent.com/document/api/649/36074)创建新的部署组。
6633
6662
  */
6634
6663
  GroupId: string;
6635
6664
  }
6665
+ /**
6666
+ * VolumeClaim模板项
6667
+ */
6668
+ export interface VolumeClaimTemplatesOption {
6669
+ /**
6670
+ * StorageClass名称
6671
+ */
6672
+ StorageClass?: string;
6673
+ /**
6674
+ * 访问模式
6675
+ */
6676
+ AccessModes?: Array<string>;
6677
+ /**
6678
+ * 卷空间的预占声明
6679
+ */
6680
+ StorageRequest?: number;
6681
+ }
6636
6682
  /**
6637
6683
  * 微服务网关单元化规则项
6638
6684
  */
@@ -6741,17 +6787,17 @@ export interface HealthCheckSetting {
6741
6787
  */
6742
6788
  ActionType: string;
6743
6789
  /**
6744
- * 容器延时启动健康检查的时间。
6790
+ * 容器延时启动健康检查的时间,单位秒。
6745
6791
  注意:此字段可能返回 null,表示取不到有效值。
6746
6792
  */
6747
6793
  InitialDelaySeconds?: number;
6748
6794
  /**
6749
- * 每次健康检查响应的最大超时时间。
6795
+ * 每次健康检查响应的最大超时时间,单位秒。
6750
6796
  注意:此字段可能返回 null,表示取不到有效值。
6751
6797
  */
6752
6798
  TimeoutSeconds?: number;
6753
6799
  /**
6754
- * 进行健康检查的时间间隔。
6800
+ * 进行健康检查的时间间隔,单位秒。
6755
6801
  注意:此字段可能返回 null,表示取不到有效值。
6756
6802
  */
6757
6803
  PeriodSeconds?: number;
@@ -7245,7 +7291,7 @@ export interface DescribePathRewritesRequest {
7245
7291
  */
7246
7292
  export interface ShrinkGroupRequest {
7247
7293
  /**
7248
- * 部署组ID
7294
+ * 部署组ID,可通过调用[DescribeGroups](https://cloud.tencent.com/document/api/649/36065)查询已创建的部署组列表或登录控制台进行查看;也可以调用[CreateGroup](https://cloud.tencent.com/document/api/649/36074)创建新的部署组。
7249
7295
  */
7250
7296
  GroupId: string;
7251
7297
  }
@@ -7267,12 +7313,12 @@ export interface TsfPageStdoutLogV2 {
7267
7313
  */
7268
7314
  ScrollId?: string;
7269
7315
  /**
7270
- * 查询状态
7316
+ * 查询状态,SUCCESS:查询成功完成,ERROR_RANGE_EXCEED:查询范围过大异常,ERROR_COMPLEX_CONDITION:查询条件复杂异常,ERROR_OTHER_CAUSE:其他异常
7271
7317
  注意:此字段可能返回 null,表示取不到有效值。
7272
7318
  */
7273
7319
  Status?: string;
7274
7320
  /**
7275
- * 游标ID
7321
+ * 查询es使用searchAfter时,游标
7276
7322
  */
7277
7323
  SearchAfter?: Array<string>;
7278
7324
  }
@@ -7372,11 +7418,11 @@ export interface DescribeGroupsWithPluginResponse {
7372
7418
  */
7373
7419
  export interface AddInstancesRequest {
7374
7420
  /**
7375
- * 集群ID
7421
+ * 集群ID,按照【集群ID】进行过滤,可通过调用[DescribeClusters](https://cloud.tencent.com/document/product/649/85857)查询已创建的集群列表或登录控制台进行查看;也可以调用[CreateCluster](https://cloud.tencent.com/document/product/649/36049)创建新的集群。仅在集群下无部署组、命名空间、云主机时可以删除。
7376
7422
  */
7377
7423
  ClusterId: string;
7378
7424
  /**
7379
- * 云主机ID列表
7425
+ * 云主机ID列表,可通过调用[DescribeInstances](https://cloud.tencent.com/document/api/213/15728)查询已创建的云主机列表或登录控制台进行查看;也可以调用[RunInstances](https://cloud.tencent.com/document/api/213/15730)创建新的云主机。
7380
7426
  */
7381
7427
  InstanceIdList: Array<string>;
7382
7428
  /**
@@ -7834,11 +7880,11 @@ export interface GatewayGroupIds {
7834
7880
  */
7835
7881
  export interface DescribeInvocationMetricDataDimensionRequest {
7836
7882
  /**
7837
- * 开始时间
7883
+ * 开始时间,格式yyyy-MM-dd HH:mm:ss
7838
7884
  */
7839
7885
  StartTime: string;
7840
7886
  /**
7841
- * 结束时间
7887
+ * 结束时间,格式yyyy-MM-dd HH:mm:ss
7842
7888
  */
7843
7889
  EndTime: string;
7844
7890
  /**
@@ -7850,7 +7896,7 @@ export interface DescribeInvocationMetricDataDimensionRequest {
7850
7896
  */
7851
7897
  Limit: number;
7852
7898
  /**
7853
- * 聚合维度
7899
+ * 聚合维度。可选值 NamespaceId:命名空间ID,GroupId:部署组ID,InstanceId:实例ID,ApplicationId:应用ID,OperationMethod:执行方法,OperationName:执行名称,ServiceName:服务名,UpstreamNamespaceId:上游命名空间ID
7854
7900
  */
7855
7901
  DimensionName: string;
7856
7902
  /**
@@ -7858,7 +7904,7 @@ export interface DescribeInvocationMetricDataDimensionRequest {
7858
7904
  */
7859
7905
  SearchWord?: string;
7860
7906
  /**
7861
- * 维度
7907
+ * 构建维度
7862
7908
  */
7863
7909
  MetricDimensionValues?: Array<MetricDimensionValue>;
7864
7910
  }
@@ -8082,7 +8128,8 @@ export interface GroupUseStatisticsEntity {
8082
8128
  */
8083
8129
  export interface DescribeBusinessLogConfigRequest {
8084
8130
  /**
8085
- * 配置项ID
8131
+ * 日志配置项ID
8132
+ 可通过调用[DescribeBusinessLogConfigs](https://cloud.tencent.com/document/product/649/75777)查询已创建的日志配置项列表或登录[控制台](https://console.cloud.tencent.com/tsf/observable/log?rid=1)进行查看
8086
8133
  */
8087
8134
  ConfigId: string;
8088
8135
  }
@@ -8165,7 +8212,7 @@ export interface ImageTag {
8165
8212
  */
8166
8213
  export interface ExecuteTaskFlowRequest {
8167
8214
  /**
8168
- * 工作流 ID。前往工作流管理,在工作流列表第一列和工作流详情页查看工作流ID。
8215
+ * 工作流 ID。[工作流管理](https://console.cloud.tencent.com/tsf/tct?rid=1&tab=workflowManage)列表页查看工作流ID。
8169
8216
  */
8170
8217
  FlowId?: string;
8171
8218
  }
@@ -8493,7 +8540,7 @@ export interface ServiceSetting {
8493
8540
  */
8494
8541
  LoadBalancerProvisioner?: string;
8495
8542
  /**
8496
- * 负载均衡类型
8543
+ * 负载均衡类型,Intranet表示内网,Internet表示外网
8497
8544
  */
8498
8545
  LoadBalancingType?: string;
8499
8546
  /**
@@ -8664,7 +8711,10 @@ export interface DeleteFileConfigResponse {
8664
8711
  */
8665
8712
  export interface ResourceTaskStatusResult {
8666
8713
  /**
8667
- * 任务的执行状态
8714
+ * 变更状态:
8715
+ - `0`:成功
8716
+ - `1`:失败
8717
+ - `2`:执行中
8668
8718
  */
8669
8719
  TaskStatus?: number;
8670
8720
  }
@@ -8772,7 +8822,7 @@ export interface ShardArgument {
8772
8822
  ShardValue?: string;
8773
8823
  }
8774
8824
  /**
8775
- * 指标维度多值匹配
8825
+ * 指标维度多值匹配。可选值 NamespaceId:命名空间ID,GroupId:部署组ID,InstanceId:实例ID,ApplicationId:应用ID,OperationMethod:执行方法,OperationName:执行名称,ServiceName:服务名,UpstreamNamespaceId:上游命名空间ID
8776
8826
  */
8777
8827
  export interface MetricDimensionValue {
8778
8828
  /**
@@ -9262,7 +9312,7 @@ export interface BindPluginResponse {
9262
9312
  */
9263
9313
  export interface RedoTaskFlowBatchRequest {
9264
9314
  /**
9265
- * 工作流批次 ID。在工作流管理页面,点击第一列的工作流ID进入工作流执行记录列表页面,第一列的内容即为工作流批次ID。
9315
+ * 工作流批次 ID。在[工作流管理](https://console.cloud.tencent.com/tsf/tct?rid=1&tab=workflowManage)页面,点击第一列的工作流ID进入工作流执行记录列表页面,第一列的内容即为工作流批次ID。
9266
9316
  */
9267
9317
  FlowBatchId: string;
9268
9318
  }
@@ -9301,7 +9351,7 @@ export interface CreateMicroserviceWithDetailRespRequest {
9301
9351
  */
9302
9352
  export interface BusinessLogConfigSchema {
9303
9353
  /**
9304
- * 解析规则类型
9354
+ * 解析规则类型。可选值 0(SPRING_BOOT:默认Spring Boot格式),1(NONE:无解析规则),4(NGINX_ACCESS:nginx access日志),5(CUSTOM_LOGBACK:自定义Logback),6(CUSTOM_LOG4J:自定义Log4J),7(CUSTOM_LOG4J2:自定义Log4J2),8(TEXT:单行/多行文本),9(ENVOY_MSGW_ACCESS:envoy access日志)。
9305
9355
  */
9306
9356
  SchemaType: number;
9307
9357
  /**
@@ -9320,7 +9370,7 @@ export interface BusinessLogConfigSchema {
9320
9370
  */
9321
9371
  SchemaMultilinePattern?: string;
9322
9372
  /**
9323
- * 解析规则创建时间
9373
+ * 解析规则创建时间,格式为yyyy-MM-dd HH:mm:ss
9324
9374
  */
9325
9375
  SchemaCreateTime?: string;
9326
9376
  /**
@@ -9355,15 +9405,15 @@ export interface MetricDataSingleValue {
9355
9405
  */
9356
9406
  export interface StopTaskExecuteRequest {
9357
9407
  /**
9358
- * 任务执行ID
9408
+ * 任务执行ID。在[任务管理](https://console.cloud.tencent.com/tsf/tct?rid=1)页面点击任务ID进入任务详情,进入执行记录页,点击批次ID进入执行详情列表页,第一列即为任务执行ID。
9359
9409
  */
9360
9410
  ExecuteId: string;
9361
9411
  /**
9362
- * 任务批次ID
9412
+ * 任务批次ID。在[任务管理](https://console.cloud.tencent.com/tsf/tct?rid=1)页面点击任务ID进入任务详情,进入执行记录列表页,第一列即为任务批次ID。
9363
9413
  */
9364
9414
  BatchId?: string;
9365
9415
  /**
9366
- * 任务ID
9416
+ * 任务ID。在[任务管理](https://console.cloud.tencent.com/tsf/tct?rid=1)列表页面可以查看任务ID。
9367
9417
  */
9368
9418
  TaskId?: string;
9369
9419
  }
@@ -9782,7 +9832,7 @@ export interface DescribeTaskRecordsRequest {
9782
9832
  */
9783
9833
  TaskState?: string;
9784
9834
  /**
9785
- * 部署组ID。前往应用管理 - 应用部署,部署组列表页面获取部署组ID。
9835
+ * 部署组ID。前往[应用管理](https://console.cloud.tencent.com/tsf/app?rid=1)点击应用ID进入应用部署列表页面获取部署组ID
9786
9836
  */
9787
9837
  GroupId?: string;
9788
9838
  /**
@@ -9794,7 +9844,7 @@ export interface DescribeTaskRecordsRequest {
9794
9844
  */
9795
9845
  ExecuteType?: string;
9796
9846
  /**
9797
- * 任务ID列表。
9847
+ * 任务ID列表。在[任务管理](https://console.cloud.tencent.com/tsf/tct?rid=1)列表页第一列查看任务ID。
9798
9848
  */
9799
9849
  Ids?: Array<string>;
9800
9850
  }
@@ -9853,15 +9903,15 @@ export interface ModifyContainerGroupResponse {
9853
9903
  */
9854
9904
  export interface ExclusiveInstance {
9855
9905
  /**
9856
- * 配置中心类型[RegistrationConfiguration]
9906
+ * 配置中心类型[注册中心Registration、配置中心Configuration]
9857
9907
  */
9858
9908
  CenterType?: string;
9859
9909
  /**
9860
- * 实例id
9910
+ * 实例id,通过北极星控制台获取
9861
9911
  */
9862
9912
  InstanceId?: string;
9863
9913
  /**
9864
- * 实例类型[Polaris]
9914
+ * 实例类型,例如北极星Polaris
9865
9915
  */
9866
9916
  InstanceType?: string;
9867
9917
  /**
@@ -9869,11 +9919,11 @@ export interface ExclusiveInstance {
9869
9919
  */
9870
9920
  InstanceName?: string;
9871
9921
  /**
9872
- * 实例地域id
9922
+ * 实例地域id,通过北极星控制台获取
9873
9923
  */
9874
9924
  RegionId?: string;
9875
9925
  /**
9876
- * 实例命名空间ID
9926
+ * 实例命名空间ID,通过北极星控制台获取
9877
9927
  */
9878
9928
  InstanceNamespaceId?: string;
9879
9929
  }
@@ -9882,7 +9932,7 @@ export interface ExclusiveInstance {
9882
9932
  */
9883
9933
  export interface DeleteApplicationRequest {
9884
9934
  /**
9885
- * 应用ID
9935
+ * 应用ID,可通过调用[DescribeApplications](https://cloud.tencent.com/document/api/649/36090)查询已创建的应用列表或登录控制台进行查看;也可以调用[CreateApplication](https://cloud.tencent.com/document/api/649/36094)创建新的应用。
9886
9936
  */
9887
9937
  ApplicationId: string;
9888
9938
  /**
@@ -10046,11 +10096,12 @@ export interface DescribeBusinessLogConfigsRequest {
10046
10096
  */
10047
10097
  SearchWord?: string;
10048
10098
  /**
10049
- *
10099
+ * 是否禁用数据集鉴权
10050
10100
  */
10051
10101
  DisableProgramAuthCheck?: boolean;
10052
10102
  /**
10053
- *
10103
+ * 日志配置项ID
10104
+ 可通过调用[DescribeBusinessLogConfigs](https://cloud.tencent.com/document/product/649/75777)查询已创建的日志配置项列表或登录[控制台](https://console.cloud.tencent.com/tsf/observable/log?rid=1)进行查看
10054
10105
  */
10055
10106
  ConfigIdList?: Array<string>;
10056
10107
  }
@@ -10430,7 +10481,7 @@ export interface UpdateGatewayApiRequest {
10430
10481
  */
10431
10482
  export interface DescribeInstancesRequest {
10432
10483
  /**
10433
- * 过滤条件
10484
+ * 过滤条件,name表示过滤字段,value表示过滤字段值。
10434
10485
  */
10435
10486
  Filters?: Array<Filter>;
10436
10487
  /**
@@ -10788,27 +10839,27 @@ export interface ApplicationForPage {
10788
10839
  */
10789
10840
  export interface DescribeInvocationMetricScatterPlotRequest {
10790
10841
  /**
10791
- * 查询开始时间
10842
+ * 查询开始时间,格式yyyy-MM-dd HH:mm:ss
10792
10843
  */
10793
10844
  StartTime?: string;
10794
10845
  /**
10795
- * 查询结束时间
10846
+ * 查询结束时间,格式yyyy-MM-dd HH:mm:ss
10796
10847
  */
10797
10848
  EndTime?: string;
10798
10849
  /**
10799
- * 查询时间粒度,单位秒。可选值:60、3600、86400
10850
+ * 查询时间粒度,单位秒。可选值:60、3600、86400
10800
10851
  */
10801
10852
  Period?: number;
10802
10853
  /**
10803
- * 查询指标维度, 不能为空。可选 NamespaceId, GroupId, InstanceId, OperationName, ServiceName, PeerServiceName, PeerOperationName
10854
+ * 查询指标维度, 不能为空。Name, Valeu键值对形式。Name可选值 NamespaceId:命名空间ID,GroupId:部署组ID,InstanceId:实例ID,ApplicationId:应用ID,OperationMethod:执行方法,OperationName:执行名称,ServiceName:服务名,UpstreamNamespaceId:上游命名空间ID
10804
10855
  */
10805
10856
  MetricDimensions?: Array<MetricDimension>;
10806
10857
  /**
10807
- * 查询指标名, 不能为空。仅支持 range_count_duratioin 为 key 下的 sum 方法
10858
+ * 查询指标名, 不能为空。仅支持 range_count_duration(响应耗时分布) 为 key 下的 sum(求和) 方法
10808
10859
  */
10809
10860
  Metrics?: Array<Metric>;
10810
10861
  /**
10811
- * 视图视角。可选值:SERVER, CLIENT。默认为SERVER
10862
+ * 视图视角。可选值:SERVER:服务端, CLIENT:客户端。默认为SERVER
10812
10863
  */
10813
10864
  Kind?: string;
10814
10865
  }
@@ -10895,27 +10946,27 @@ export interface AddClusterInstancesResponse {
10895
10946
  */
10896
10947
  export interface DescribeInvocationMetricDataCurveRequest {
10897
10948
  /**
10898
- * 查询开始时间
10949
+ * 开始时间,格式yyyy-MM-dd HH:mm:ss
10899
10950
  */
10900
10951
  StartTime?: string;
10901
10952
  /**
10902
- * 查询结束时间
10953
+ * 结束时间,格式yyyy-MM-dd HH:mm:ss
10903
10954
  */
10904
10955
  EndTime?: string;
10905
10956
  /**
10906
- * 查询时间粒度,单位秒可选值:60、3600、86400
10957
+ * 查询时间粒度,单位秒。可选值:60、3600、86400
10907
10958
  */
10908
10959
  Period?: number;
10909
10960
  /**
10910
- * 查询指标维度,不能为空,支持 ServiceName, OperationName, PeerServiceName, PeerOperationName
10961
+ * 查询指标维度,不能为空
10911
10962
  */
10912
10963
  MetricDimensions?: Array<MetricDimension>;
10913
10964
  /**
10914
- * 查询指标名,不能为空.
10965
+ * 查询指标名,不能为空
10915
10966
  */
10916
10967
  Metrics?: Array<Metric>;
10917
10968
  /**
10918
- * 视图视角。可选值:SERVER, CLIENT。默认为SERVER
10969
+ * 视图视角。可选值:SERVER:服务端,CLIENT:客户端。默认为SERVER
10919
10970
  */
10920
10971
  Kind?: string;
10921
10972
  /**
@@ -10959,7 +11010,7 @@ export interface VmGroupOther {
10959
11010
  */
10960
11011
  OffInstanceCount?: number;
10961
11012
  /**
10962
- * 部署组状态
11013
+ * 部署组状态,Running运行中,Waiting等待中,Paused暂停中,Updating更新中,RollingBack回滚中,Abnormal异常,Unknown未知
10963
11014
  */
10964
11015
  GroupStatus?: string;
10965
11016
  /**
@@ -11062,7 +11113,7 @@ export interface BusinessLogConfigAssociatedGroup {
11062
11113
  */
11063
11114
  ApplicationName: string;
11064
11115
  /**
11065
- * 部署组所属应用类型
11116
+ * 部署组所属应用类型,C:容器应用,V:虚拟机应用
11066
11117
  */
11067
11118
  ApplicationType: string;
11068
11119
  /**
@@ -11082,11 +11133,11 @@ export interface BusinessLogConfigAssociatedGroup {
11082
11133
  */
11083
11134
  ClusterName: string;
11084
11135
  /**
11085
- * 部署组所属集群类型
11136
+ * 部署组所属集群类型,C:容器集群,V:虚拟机集群
11086
11137
  */
11087
11138
  ClusterType: string;
11088
11139
  /**
11089
- * 部署组关联日志配置时间
11140
+ * 部署组关联日志配置时间,格式yyyy-MM-dd HH:mm:ss
11090
11141
  */
11091
11142
  AssociatedTime: string;
11092
11143
  }
@@ -11103,15 +11154,17 @@ export interface DescribeApplicationsRequest {
11103
11154
  */
11104
11155
  OrderBy?: string;
11105
11156
  /**
11106
- * 排序类型
11157
+ * 指定排序类型,目前支持:
11158
+ `0`:降序
11159
+ `1`:升序
11107
11160
  */
11108
11161
  OrderType?: number;
11109
11162
  /**
11110
- * 偏移量
11163
+ * 偏移量,默认为0。关于Offset详见[API简介](https://cloud.tencent.com/document/api/213/568#.E8.BE.93.E5.85.A5.E5.8F.82.E6.95.B0.E4.B8.8E.E8.BF.94.E5.9B.9E.E5.8F.82.E6.95.B0.E9.87.8A.E4.B9.89)
11111
11164
  */
11112
11165
  Offset?: number;
11113
11166
  /**
11114
- * 分页个数
11167
+ * 数量限制,默认为20,最大值为100。关于Limit详见[API简介](https://cloud.tencent.com/document/api/213/568#.E8.BE.93.E5.85.A5.E5.8F.82.E6.95.B0.E4.B8.8E.E8.BF.94.E5.9B.9E.E5.8F.82.E6.95.B0.E9.87.8A.E4.B9.89)
11115
11168
  */
11116
11169
  Limit?: number;
11117
11170
  /**
@@ -11334,7 +11387,7 @@ export interface CurvePoint {
11334
11387
  */
11335
11388
  Value?: string;
11336
11389
  /**
11337
- * 该坐标点时间戳
11390
+ * 该坐标点时间戳,单位毫秒
11338
11391
  */
11339
11392
  Timestamp?: string;
11340
11393
  }
@@ -11554,7 +11607,7 @@ export interface DescribeGroupInstancesResponse {
11554
11607
  */
11555
11608
  export interface DescribeContainerGroupDeployInfoRequest {
11556
11609
  /**
11557
- * 实例所属 groupId
11610
+ * 部署组ID,按照【部署组ID】进行过滤,可通过调用DescribeGroups查询已创建的项目列表或登录控制台进行查看;也可以调用CreateGroup创建新的项目。部署组ID例如:group-ab958z6y
11558
11611
  */
11559
11612
  GroupId: string;
11560
11613
  }
@@ -11575,11 +11628,13 @@ export interface DescribeDeliveryConfigsRequest {
11575
11628
  */
11576
11629
  Limit?: number;
11577
11630
  /**
11578
- * 数据集idList
11631
+ * 数据集ID列表
11632
+ 可通过调用[DescribePrograms](https://cloud.tencent.com/document/product/649/73477)查询已创建的数据集列表或登录[控制台](https://console.cloud.tencent.com/tsf/privilege?rid=1&tab=program&roleId=role-a22gwdwa)进行查看
11579
11633
  */
11580
11634
  ProgramIdList?: Array<string>;
11581
11635
  /**
11582
- * ConfigIdList
11636
+ * 日志配置项ID列表
11637
+ 可通过调用[DescribeBusinessLogConfigs](https://cloud.tencent.com/document/product/649/75777)查询已创建的日志配置项列表或登录[控制台](https://console.cloud.tencent.com/tsf/observable/log?rid=1)进行查看
11583
11638
  */
11584
11639
  ConfigIdList?: Array<string>;
11585
11640
  }
@@ -11589,10 +11644,12 @@ export interface DescribeDeliveryConfigsRequest {
11589
11644
  export interface DisassociateBusinessLogConfigRequest {
11590
11645
  /**
11591
11646
  * 业务日志配置项ID列表
11647
+ 可通过调用[DescribeBusinessLogConfigs](https://cloud.tencent.com/document/product/649/75777)查询已创建的日志配置项列表或登录[控制台](https://console.cloud.tencent.com/tsf/observable/log?rid=1)进行查看
11592
11648
  */
11593
11649
  ConfigIdList: Array<string>;
11594
11650
  /**
11595
- * TSF分组ID
11651
+ * 部署组ID
11652
+ 可通过调用[DescribeContainerGroups](https://cloud.tencent.com/document/product/649/36068)或[DescribeGroups](https://cloud.tencent.com/document/product/649/36065)查询已创建的部署组列表或登录[控制台](https://console.cloud.tencent.com/tsf/app-detail?rid=1&id=application-yo7kp9dv&tab=publish&subTab=group)进行查看
11596
11653
  */
11597
11654
  GroupId: string;
11598
11655
  }
@@ -11716,11 +11773,11 @@ export interface EmptyDirOption {
11716
11773
  */
11717
11774
  export interface ExpandGroupRequest {
11718
11775
  /**
11719
- * 部署组ID
11776
+ * 部署组ID,可通过调用[DescribeGroups](https://cloud.tencent.com/document/api/649/36065)查询已创建的部署组列表或登录控制台进行查看;也可以调用[CreateGroup](https://cloud.tencent.com/document/api/649/36074)创建新的部署组。
11720
11777
  */
11721
11778
  GroupId: string;
11722
11779
  /**
11723
- * 扩容的机器实例ID列表
11780
+ * 扩容的机器实例ID列表,调用[DescribeClusters](https://console.cloud.tencent.com/tsf/resource?rid=1)接口,选定一个虚拟机集群,选择部署组,选择应用扩容可获取实例列表
11724
11781
  */
11725
11782
  InstanceIdList: Array<string>;
11726
11783
  }
@@ -11779,7 +11836,7 @@ export interface DescribeMicroservicesByGroupIdsResponse {
11779
11836
  */
11780
11837
  export interface DescribeGroupAttributeRequest {
11781
11838
  /**
11782
- * 部署组ID字段
11839
+ * 部署组ID,按照【部署组ID】进行过滤,可通过调用DescribeGroups查询已创建的项目列表或登录控制台进行查看;也可以调用CreateGroup创建新的项目。部署组ID例如:group-ab958z6y
11783
11840
  */
11784
11841
  GroupId: string;
11785
11842
  }
@@ -11886,19 +11943,19 @@ export interface GroupPod {
11886
11943
  */
11887
11944
  ReadyCount?: number;
11888
11945
  /**
11889
- * 运行时长
11946
+ * 运行时长,单位秒
11890
11947
  */
11891
11948
  Runtime?: string;
11892
11949
  /**
11893
- * 实例启动时间
11950
+ * 实例启动时的时间戳
11894
11951
  */
11895
11952
  CreatedAt?: string;
11896
11953
  /**
11897
- * 服务实例状态
11954
+ * 服务实例状态,枚举值为Starting/Running/Stopping/Stopped/StopFailed/Abnormal/Unknown
11898
11955
  */
11899
11956
  ServiceInstanceStatus?: string;
11900
11957
  /**
11901
- * 机器实例可使用状态
11958
+ * 机器实例可使用状态,枚举值为Starting/Running/Stopping/Stopped/StopFailed/Abnormal/Unknown
11902
11959
  */
11903
11960
  InstanceAvailableStatus?: string;
11904
11961
  /**
@@ -11919,7 +11976,7 @@ export interface GroupPod {
11919
11976
  */
11920
11977
  export interface EnableTaskFlowRequest {
11921
11978
  /**
11922
- * 工作流 ID。前往工作流管理,在工作流列表第一列和工作流详情页查看工作流ID。
11979
+ * 工作流 ID。[工作流管理](https://console.cloud.tencent.com/tsf/tct?rid=1&tab=workflowManage)列表页查看工作流ID。
11923
11980
  */
11924
11981
  FlowId: string;
11925
11982
  }
@@ -12078,7 +12135,7 @@ export interface StdoutLogV2 {
12078
12135
  */
12079
12136
  Content?: string;
12080
12137
  /**
12081
- * 日志时间戳
12138
+ * 日志时间戳,单位毫秒
12082
12139
  */
12083
12140
  Timestamp?: number;
12084
12141
  /**
@@ -12253,15 +12310,15 @@ export interface ServiceConfig {
12253
12310
  */
12254
12311
  export interface RedoTaskExecuteRequest {
12255
12312
  /**
12256
- * 任务批次ID。在任务管理页面第一列点击任务ID进入任务详情,进入执行记录列表页,第一列内容即为任务批次ID。
12313
+ * 任务批次ID。在[任务管理](https://console.cloud.tencent.com/tsf/tct?rid=1)页面第一列点击任务ID进入任务详情,进入执行记录列表页,第一列内容即为任务批次ID。
12257
12314
  */
12258
12315
  BatchId: string;
12259
12316
  /**
12260
- * 任务执行ID。在任务管理页面第一列点击任务ID进入任务详情,进入执行记录页,点击批次ID进入执行详情列表页,第一列即为任务执行ID。
12317
+ * 任务执行ID。在[任务管理](https://console.cloud.tencent.com/tsf/tct?rid=1)页面第一列点击任务ID进入任务详情,进入执行记录页,点击批次ID进入执行详情列表页,第一列即为任务执行ID。
12261
12318
  */
12262
12319
  ExecuteId: string;
12263
12320
  /**
12264
- * 任务ID。在任务管理列表页面可以查看任务ID。
12321
+ * 任务ID。在[任务管理](https://console.cloud.tencent.com/tsf/tct?rid=1)列表页查看任务ID。
12265
12322
  */
12266
12323
  TaskId: string;
12267
12324
  }
@@ -12323,11 +12380,11 @@ export interface InvocationIndicator {
12323
12380
  */
12324
12381
  export interface DescribeStatisticsRequest {
12325
12382
  /**
12326
- * 类型:InterfaceServiceGroupInstanceSQLNoSQL
12383
+ * 统计类型。可选值 Interface:接口类型、Service:服务类型、Group:部署组类型、Instance:实例类型、SQL:SQL类型、NoSQL:NoSQL类型
12327
12384
  */
12328
12385
  Type: string;
12329
12386
  /**
12330
- * 步长,单位s:60、3600、86400
12387
+ * 步长,单位秒。可选值 60、3600、86400
12331
12388
  */
12332
12389
  TimeStep: number;
12333
12390
  /**
@@ -12339,7 +12396,9 @@ export interface DescribeStatisticsRequest {
12339
12396
  */
12340
12397
  Limit: number;
12341
12398
  /**
12342
- * 命名空间Id,此字段,和 NamespaceIdList 或者 MetricDimensionValues 字段包含 namespaceId 维度信息。三者选其一。
12399
+ * 命名空间ID。此字段,和 NamespaceIdList 或者 MetricDimensionValues 字段包含 namespaceId 维度信息。三者选其一。
12400
+ 可通过[DescribeSimpleNamespaces](https://cloud.tencent.com/document/product/649/36096)查询已经创建的命名空间,也可以通过登录[控制台](https://console.cloud.tencent.com/tsf/resource?rid=1&tab=namespace)查看
12401
+
12343
12402
  */
12344
12403
  NamespaceId?: string;
12345
12404
  /**
@@ -12367,7 +12426,7 @@ export interface DescribeStatisticsRequest {
12367
12426
  */
12368
12427
  SearchWord?: string;
12369
12428
  /**
12370
- * 维度
12429
+ * 维度。此字段,和 NamespaceIdList 或者 MetricDimensionValues 字段包含 namespaceId 维度信息。三者选其一
12371
12430
  */
12372
12431
  MetricDimensionValues?: Array<MetricDimensionValue>;
12373
12432
  /**
@@ -12375,15 +12434,16 @@ export interface DescribeStatisticsRequest {
12375
12434
  */
12376
12435
  BucketKey?: string;
12377
12436
  /**
12378
- * 数据库
12437
+ * 数据库名称
12379
12438
  */
12380
12439
  DbName?: string;
12381
12440
  /**
12382
- * 命名空间id数组
12441
+ * 命名空间ID数组。此字段,和 NamespaceIdList 或者 MetricDimensionValues 字段包含 namespaceId 维度信息。三者选其一
12383
12442
  */
12384
12443
  NamespaceIdList?: Array<string>;
12385
12444
  /**
12386
- * 独占配置中心的ID
12445
+ * 独占配置中心的ID
12446
+ 可通过调用[DescribeClusterInstances](https://cloud.tencent.com/document/product/649/36048)查询已导入的实例列表或登录[控制台](https://console.cloud.tencent.com/tsf/resource?rid=1&tab=instance)进行查询。实例ID例如:ins-6decplwk。
12387
12447
  */
12388
12448
  ConfigCenterInstanceId?: string;
12389
12449
  }
@@ -12507,7 +12567,7 @@ export interface DescribeGatewayAllGroupApisRequest {
12507
12567
  */
12508
12568
  export interface DeleteGroupRequest {
12509
12569
  /**
12510
- * 部署组ID
12570
+ * 部署组ID,可通过调用[DescribeGroups](https://cloud.tencent.com/document/api/649/36065)查询已创建的部署组列表或登录控制台进行查看;也可以调用[CreateGroup](https://cloud.tencent.com/document/api/649/36074)创建新的部署组。
12511
12571
  */
12512
12572
  GroupId: string;
12513
12573
  }
@@ -12713,11 +12773,11 @@ export interface BindApiGroupRequest {
12713
12773
  */
12714
12774
  export interface StopTaskBatchRequest {
12715
12775
  /**
12716
- * 批次ID
12776
+ * 任务批次ID。在[任务管理](https://console.cloud.tencent.com/tsf/tct?rid=1)页面点击任务ID进入任务详情,进入执行记录列表页,第一列即为任务批次ID。
12717
12777
  */
12718
12778
  BatchId: string;
12719
12779
  /**
12720
- * 参数ID
12780
+ * 任务ID。在[任务管理](https://console.cloud.tencent.com/tsf/tct?rid=1)列表页面可以查看任务ID。
12721
12781
  */
12722
12782
  TaskId?: string;
12723
12783
  }
@@ -12906,7 +12966,8 @@ export interface DescribeProgramsResponse {
12906
12966
  */
12907
12967
  export interface ProgramItem {
12908
12968
  /**
12909
- * 数据项ID
12969
+ * 数据项ID,调用[DescribePrograms](https://console.cloud.tencent.com/tsf/privilege?rid=1&tab=program)接口查询已创建的数据集或登陆控制台进行查看;也可以通过调用[CreateProgram](https://cloud.tencent.com/document/api/649/108544)创建新的数据集。
12970
+
12910
12971
  */
12911
12972
  ProgramItemId?: string;
12912
12973
  /**
@@ -12922,11 +12983,11 @@ export interface ProgramItem {
12922
12983
  */
12923
12984
  IsAll?: boolean;
12924
12985
  /**
12925
- * 创建时间
12986
+ * 创建时间,时间戳格式【Long】
12926
12987
  */
12927
12988
  CreationTime?: number;
12928
12989
  /**
12929
- * 最后更新时间
12990
+ * 最后更新时间,时间戳格式【Long】,单位毫秒
12930
12991
  */
12931
12992
  LastUpdateTime?: number;
12932
12993
  /**
@@ -12934,7 +12995,7 @@ export interface ProgramItem {
12934
12995
  */
12935
12996
  DeleteFlag?: boolean;
12936
12997
  /**
12937
- * 数据集ID
12998
+ * 数据集ID,调用[DescribePrograms](https://console.cloud.tencent.com/tsf/privilege?rid=1&tab=program)查询接口获取
12938
12999
  */
12939
13000
  ProgramId?: string;
12940
13001
  }
@@ -12943,7 +13004,7 @@ export interface ProgramItem {
12943
13004
  */
12944
13005
  export interface DisableTaskFlowRequest {
12945
13006
  /**
12946
- * 工作流 ID。前往工作流管理,在工作流列表第一列和工作流详情页查看工作流ID。
13007
+ * 工作流 ID。[工作流管理](https://console.cloud.tencent.com/tsf/tct?rid=1&tab=workflowManage)列表页查看工作流ID。
12947
13008
  */
12948
13009
  FlowId: string;
12949
13010
  }
@@ -12969,7 +13030,7 @@ export interface DescribeLogCapacityResponse {
12969
13030
  */
12970
13031
  export interface DescribePodInstancesRequest {
12971
13032
  /**
12972
- * 实例所属groupId
13033
+ * 实例所属部署组ID,按照【部署组ID】进行过滤,可通过调用DescribeGroups查询已创建的项目列表或登录控制台进行查看;也可以调用CreateGroup创建新的项目。部署组ID例如:group-9yn2q8yd。部署组所在集群必须是活跃状态的。
12973
13034
  */
12974
13035
  GroupId: string;
12975
13036
  /**
@@ -12981,15 +13042,15 @@ export interface DescribePodInstancesRequest {
12981
13042
  */
12982
13043
  Limit?: number;
12983
13044
  /**
12984
- * 过滤字段
13045
+ * 用于通过PodName字段过滤返回结果。
12985
13046
  */
12986
13047
  PodNameList?: Array<string>;
12987
13048
  /**
12988
- * 新老版本pod批次标识
13049
+ * 新老版本pod批次标识,old表示老版本,new表示新版本。
12989
13050
  */
12990
13051
  DeployVersion?: string;
12991
13052
  /**
12992
- * 任务ID
13053
+ * 实例所属任务ID,登录控制台进行查看。
12993
13054
  */
12994
13055
  TaskId?: string;
12995
13056
  }
@@ -13027,21 +13088,21 @@ export interface DeliveryConfigBindGroup {
13027
13088
  */
13028
13089
  Groups: Array<GroupInfo>;
13029
13090
  /**
13030
- * 创建时间
13091
+ * 创建时间,格式yyyy-MM-dd HH:mm:ss
13031
13092
  */
13032
13093
  CreateTime: string;
13033
13094
  /**
13034
- * KafkaVIp
13095
+ * Kafka的vip
13035
13096
  注意:此字段可能返回 null,表示取不到有效值。
13036
13097
  */
13037
13098
  KafkaVIp?: string;
13038
13099
  /**
13039
- * KafkaAddress
13100
+ * Kafka地址
13040
13101
  注意:此字段可能返回 null,表示取不到有效值。
13041
13102
  */
13042
13103
  KafkaAddress?: string;
13043
13104
  /**
13044
- * KafkaVPort
13105
+ * Kafka端口
13045
13106
  注意:此字段可能返回 null,表示取不到有效值。
13046
13107
  */
13047
13108
  KafkaVPort?: string;
@@ -13055,7 +13116,7 @@ export interface DeliveryConfigBindGroup {
13055
13116
  */
13056
13117
  LineRule?: string;
13057
13118
  /**
13058
- * CustomRule
13119
+ * 自定义规则
13059
13120
  注意:此字段可能返回 null,表示取不到有效值。
13060
13121
  */
13061
13122
  CustomRule?: string;
@@ -13065,16 +13126,16 @@ export interface DeliveryConfigBindGroup {
13065
13126
  */
13066
13127
  EnableGlobalLineRule?: boolean;
13067
13128
  /**
13068
- * EnableAuth
13129
+ * 是否开启认证
13069
13130
  */
13070
13131
  EnableAuth?: boolean;
13071
13132
  /**
13072
- * Username
13133
+ * 用户名
13073
13134
  注意:此字段可能返回 null,表示取不到有效值。
13074
13135
  */
13075
13136
  Username?: string;
13076
13137
  /**
13077
- * Password
13138
+ * 密码
13078
13139
  注意:此字段可能返回 null,表示取不到有效值。
13079
13140
  */
13080
13141
  Password?: string;
@@ -13139,7 +13200,7 @@ export interface WarmupSetting {
13139
13200
  */
13140
13201
  Enabled?: boolean;
13141
13202
  /**
13142
- * 预热时间
13203
+ * 预热时间,单位秒
13143
13204
  */
13144
13205
  WarmupTime?: number;
13145
13206
  /**
@@ -13227,7 +13288,7 @@ export interface InstanceEnrichedInfo {
13227
13288
  */
13228
13289
  ApplicationName?: string;
13229
13290
  /**
13230
- * 应用类型
13291
+ * 应用类型,C表示容器应用,V表示虚拟机应用
13231
13292
  */
13232
13293
  ApplicationType?: string;
13233
13294
  /**
@@ -13239,7 +13300,7 @@ export interface InstanceEnrichedInfo {
13239
13300
  */
13240
13301
  ClusterName?: string;
13241
13302
  /**
13242
- * 集群类型
13303
+ * 集群类型,C表示容器集群,V表示虚拟机集群
13243
13304
  */
13244
13305
  ClusterType?: string;
13245
13306
  /**
@@ -13264,7 +13325,7 @@ export interface InstanceEnrichedInfo {
13264
13325
  */
13265
13326
  export interface DescribeResourceTaskStatusRequest {
13266
13327
  /**
13267
- * 任务ID
13328
+ * 容器实例任务ID,可通过调用 ListContainerTask 查询已创建的变更记录总数或登录控制台进行查看。
13268
13329
  */
13269
13330
  TaskId: string;
13270
13331
  }
@@ -13519,7 +13580,7 @@ export interface TsfPageBusinessLogV2 {
13519
13580
  */
13520
13581
  ScrollId?: string;
13521
13582
  /**
13522
- * 查询状态
13583
+ * 查询状态,SUCCESS:查询成功完成,ERROR_RANGE_EXCEED:查询范围过大异常,ERROR_COMPLEX_CONDITION:查询条件复杂异常,ERROR_OTHER_CAUSE:其他异常
13523
13584
  注意:此字段可能返回 null,表示取不到有效值。
13524
13585
  */
13525
13586
  Status?: string;
@@ -13546,11 +13607,14 @@ export interface CreateClusterRequest {
13546
13607
  */
13547
13608
  ClusterName: string;
13548
13609
  /**
13549
- * 集群类型
13610
+ * 指定集群类型,目前支持:
13611
+ - `V`:虚拟机集群
13612
+ - `C`:容器集群
13613
+ - `S`:Serverless 集群
13550
13614
  */
13551
13615
  ClusterType: string;
13552
13616
  /**
13553
- * 私有网络ID
13617
+ * 私有网络ID,可通过调用[DescribeVpcEx](https://cloud.tencent.com/document/api/215/1372)查询已创建的私有网络列表或登录控制台进行查看;也可以调用[CreateVpc](https://cloud.tencent.com/document/api/215/1309)创建新的私有网络。
13554
13618
  */
13555
13619
  VpcId: string;
13556
13620
  /**
@@ -13615,7 +13679,8 @@ export interface CreateClusterRequest {
13615
13679
  */
13616
13680
  export interface DescribeDeliveryConfigByGroupIdRequest {
13617
13681
  /**
13618
- * 部署组id
13682
+ * 部署组ID
13683
+ 可通过调用[DescribeContainerGroups](https://cloud.tencent.com/document/product/649/36068)或[DescribeGroups](https://cloud.tencent.com/document/product/649/36065)查询已创建的部署组列表或登录[控制台](https://console.cloud.tencent.com/tsf/app-detail?rid=1&id=application-yo7kp9dv&tab=publish&subTab=group)进行查看
13619
13684
  */
13620
13685
  GroupId: string;
13621
13686
  }
@@ -13721,7 +13786,7 @@ export interface ConfigRelease {
13721
13786
  */
13722
13787
  export interface DeleteContainerGroupRequest {
13723
13788
  /**
13724
- * 部署组ID,分组唯一标识
13789
+ * 部署组ID,可通过调用[DescribeContainerGroups](https://cloud.tencent.com/document/api/649/36068)查询已创建的部署组列表或登录控制台进行查看;也可以调用[CreateContainGroup](https://cloud.tencent.com/document/api/649/36075)创建新的部署组。
13725
13790
  */
13726
13791
  GroupId: string;
13727
13792
  }
@@ -13818,12 +13883,12 @@ export interface BusinessLogConfig {
13818
13883
  */
13819
13884
  ConfigPipeline?: string;
13820
13885
  /**
13821
- * 配置项创建时间
13886
+ * 配置项创建时间,格式为yyyy-MM-dd HH:mm:ss
13822
13887
  注意:此字段可能返回 null,表示取不到有效值。
13823
13888
  */
13824
13889
  ConfigCreateTime?: string;
13825
13890
  /**
13826
- * 配置项更新时间
13891
+ * 配置项更新时间,格式为yyyy-MM-dd HH:mm:ss
13827
13892
  注意:此字段可能返回 null,表示取不到有效值。
13828
13893
  */
13829
13894
  ConfigUpdateTime?: string;
@@ -13849,6 +13914,22 @@ export interface BusinessLogConfig {
13849
13914
  * close_timeout参数
13850
13915
  */
13851
13916
  FilebeatCloseTimeout?: number;
13917
+ /**
13918
+ * filebeat ignore_older参数
13919
+ */
13920
+ FilebeatIgnoreOlder?: number;
13921
+ /**
13922
+ * filebeat harvester_limit参数
13923
+ */
13924
+ FilebeatHarvesterLimit?: number;
13925
+ /**
13926
+ * filebeat close_inactive参数
13927
+ */
13928
+ FilebeatCloseInactive?: number;
13929
+ /**
13930
+ * filebeat clean_inactive参数
13931
+ */
13932
+ FilebeatCleanInactive?: number;
13852
13933
  }
13853
13934
  /**
13854
13935
  * DescribeApiDetail请求参数结构体
@@ -13887,7 +13968,7 @@ export interface DescribeApiDetailRequest {
13887
13968
  */
13888
13969
  export interface StopContainerGroupRequest {
13889
13970
  /**
13890
- * 部署组ID
13971
+ * 部署组ID,可通过调用[DescribeContainerGroups](https://cloud.tencent.com/document/api/649/36068)查询已创建的部署组列表或登录控制台进行查看;也可以调用[CreateContainGroup](https://cloud.tencent.com/document/api/649/36075)创建新的部署组。
13891
13972
  */
13892
13973
  GroupId: string;
13893
13974
  }
@@ -14244,7 +14325,7 @@ export interface ServiceGovernanceConfig {
14244
14325
  */
14245
14326
  EnableGovernance?: boolean;
14246
14327
  /**
14247
- * 服务治理类型(枚举:SHAREEXCLUSIVE
14328
+ * 服务治理类型(枚举:SHARE表示共享型、EXCLUSIVE表示独占型)
14248
14329
  */
14249
14330
  GovernanceType?: string;
14250
14331
  /**
@@ -14291,7 +14372,7 @@ export interface ModifyApplicationRequest {
14291
14372
  */
14292
14373
  ServiceConfigList?: Array<ServiceConfig>;
14293
14374
  /**
14294
- * 应用的微服务类型
14375
+ * 应用的微服务类型,N表示普通应用,M表示Mesh应用,G表示网关应用,NATIVE表示原生应用,RAW表示裸应用
14295
14376
  */
14296
14377
  MicroserviceType?: string;
14297
14378
  /**
@@ -14299,7 +14380,7 @@ export interface ModifyApplicationRequest {
14299
14380
  */
14300
14381
  ServiceGovernanceConfig?: ServiceGovernanceConfig;
14301
14382
  /**
14302
- * 应用开发框架
14383
+ * 应用开发框架,SpringCloud表示SpringCloud应用,Dubbo表示Dubbo应用,Go-GRPC表示Go-GRPC应用,Other表示其他应用
14303
14384
  */
14304
14385
  FrameworkType?: string;
14305
14386
  }
@@ -14386,7 +14467,7 @@ export interface DescribeFlowLastBatchStateResponse {
14386
14467
  */
14387
14468
  export interface StopTaskExecuteResponse {
14388
14469
  /**
14389
- * 操作成功 or 失败
14470
+ * 返回 true 或 false。true:操作成功,false:操作失败
14390
14471
  */
14391
14472
  Result?: boolean;
14392
14473
  /**
@@ -14703,7 +14784,7 @@ export interface GroupPodResult {
14703
14784
  */
14704
14785
  export interface DescribeApplicationRequest {
14705
14786
  /**
14706
- * 应用ID
14787
+ * 应用ID,可通过调用[DescribeApplications](https://cloud.tencent.com/document/api/649/36090)查询已创建的应用列表或登录控制台进行查看;也可以调用[CreateApplication](https://cloud.tencent.com/document/api/649/36094)创建新的应用。
14707
14788
  */
14708
14789
  ApplicationId: string;
14709
14790
  }
@@ -14970,7 +15051,7 @@ export interface DescribeGroupsRequest {
14970
15051
  */
14971
15052
  SearchWord?: string;
14972
15053
  /**
14973
- * 应用ID
15054
+ * 应用ID。调用[DescribeApplications](https://cloud.tencent.com/document/api/649/36090)查询已创建的应用或通过[CreateApplication](https://cloud.tencent.com/document/api/649/36094)接口创建新的应用。
14974
15055
  */
14975
15056
  ApplicationId?: string;
14976
15057
  /**
@@ -14978,23 +15059,23 @@ export interface DescribeGroupsRequest {
14978
15059
  */
14979
15060
  OrderBy?: string;
14980
15061
  /**
14981
- * 排序方式
15062
+ * 排序方式,0:升序,1:降序
14982
15063
  */
14983
15064
  OrderType?: number;
14984
15065
  /**
14985
- * 偏移量
15066
+ * 偏移量,默认值:0
14986
15067
  */
14987
15068
  Offset?: number;
14988
15069
  /**
14989
- * 分页个数
15070
+ * 分页个数,默认值:20
14990
15071
  */
14991
15072
  Limit?: number;
14992
15073
  /**
14993
- * 命名空间ID
15074
+ * 命名空间ID。调用[DescribeSimpleNamespaces](https://cloud.tencent.com/document/api/649/36096)查询已创建的命名空间或通过[CreateNamespace](https://cloud.tencent.com/document/api/649/36098)接口创建新的集群。
14994
15075
  */
14995
15076
  NamespaceId?: string;
14996
15077
  /**
14997
- * 集群ID
15078
+ * 集群 ID。调用[DescribeSimpleClusters](https://cloud.tencent.com/document/api/649/36047)查询已创建的集群或通过[CreateCluster](https://cloud.tencent.com/document/api/649/36049)接口创建新的集群。
14998
15079
  */
14999
15080
  ClusterId?: string;
15000
15081
  /**
@@ -15055,7 +15136,7 @@ export interface LaneRuleTag {
15055
15136
  */
15056
15137
  export interface ModifyNamespaceRequest {
15057
15138
  /**
15058
- * 命名空间ID
15139
+ * 命名空间ID,按照【命名空间ID】进行过滤,可通过调用DescribeNamespaces查询已创建的项目列表或登录控制台进行查看;也可以调用CreateNamespace创建新的项目。命名空间ID例如:namespace-6a79x94v。
15059
15140
  */
15060
15141
  NamespaceId: string;
15061
15142
  /**
@@ -15067,7 +15148,7 @@ export interface ModifyNamespaceRequest {
15067
15148
  */
15068
15149
  NamespaceDesc?: string;
15069
15150
  /**
15070
- * 是否开启高可用
15151
+ * 是否开启高可用,0表示不开启,1表示开启
15071
15152
  */
15072
15153
  IsHaEnable?: string;
15073
15154
  }
@@ -15122,11 +15203,11 @@ export interface CreateRepositoryRequest {
15122
15203
  */
15123
15204
  export interface DeleteNamespaceRequest {
15124
15205
  /**
15125
- * 命名空间ID
15206
+ * 命名空间ID,按照【命名空间ID】进行过滤,可通过调用[DescribeNamespaces](https://cloud.tencent.com/document/product/649/36096)查询已创建的命名空间列表或登录控制台进行查看;也可以调用[CreateNamespace](https://cloud.tencent.com/document/product/649/36098)创建新命名空间。
15126
15207
  */
15127
15208
  NamespaceId: string;
15128
15209
  /**
15129
- * 集群ID
15210
+ * 集群ID,按照【集群ID】进行过滤,可通过调用[DescribeClusters](https://cloud.tencent.com/document/product/649/85857)查询已创建的集群列表或登录控制台进行查看;也可以调用[CreateCluster](https://cloud.tencent.com/document/product/649/36049)创建新的集群。仅在集群下无部署组、命名空间、云主机时可以删除。
15130
15211
  */
15131
15212
  ClusterId?: string;
15132
15213
  }
@@ -15275,7 +15356,11 @@ export interface ContainerInfo {
15275
15356
  */
15276
15357
  export interface SearchStdoutLogRequest {
15277
15358
  /**
15278
- * 机器实例ID, 和 实例 ID 二者必选其一,不能同时为空
15359
+ * 机器实例ID, 和 部署组 ID 二者必选其一,不能同时为空
15360
+ 可通过调用[DescribeClusterInstances](https://cloud.tencent.com/document/product/649/36048)查询已导入的实例列表或登录[控制台](https://console.cloud.tencent.com/tsf/resource?rid=1&tab=instance)进行查询。实例ID例如:ins-6decplwk
15361
+
15362
+
15363
+
15279
15364
  */
15280
15365
  InstanceId?: string;
15281
15366
  /**
@@ -15287,15 +15372,16 @@ export interface SearchStdoutLogRequest {
15287
15372
  */
15288
15373
  SearchWords?: Array<string>;
15289
15374
  /**
15290
- * 查询起始时间
15375
+ * 查询起始时间,格式yyyy-MM-dd HH:mm:ss
15291
15376
  */
15292
15377
  StartTime?: string;
15293
15378
  /**
15294
15379
  * 部署组ID,和 InstanceId 二者必选其一,不能同时为空
15380
+ 可通过调用[DescribeContainerGroups](https://cloud.tencent.com/document/product/649/36068)或[DescribeGroups](https://cloud.tencent.com/document/product/649/36065)查询已创建的部署组列表或登录[控制台](https://console.cloud.tencent.com/tsf/app-detail?rid=1&id=application-yo7kp9dv&tab=publish&subTab=group)进行查看
15295
15381
  */
15296
15382
  GroupId?: string;
15297
15383
  /**
15298
- * 查询结束时间
15384
+ * 查询结束时间,格式yyyy-MM-dd HH:mm:ss
15299
15385
  */
15300
15386
  EndTime?: string;
15301
15387
  /**
@@ -15304,22 +15390,20 @@ export interface SearchStdoutLogRequest {
15304
15390
  */
15305
15391
  Offset?: number;
15306
15392
  /**
15307
- * 排序规则,默认值"time"
15393
+ * 排序规则,time:按时间排序,score:按检索值排序,默认值"time"
15308
15394
  */
15309
15395
  OrderBy?: string;
15310
15396
  /**
15311
- * 排序方式,取值"asc""desc",默认
15312
- 值"desc"
15397
+ * 排序方式,取值 asc:升序 desc:降序,默认值desc
15313
15398
  */
15314
15399
  OrderType?: string;
15315
15400
  /**
15316
- * 检索类型,取值"LUCENE", "REGEXP",
15317
- "NORMAL"
15401
+ * 检索类型,取值 LUCENE:Lucene检索,REGEXP:正则检索,NORMAL:普通检索
15318
15402
  */
15319
15403
  SearchWordType?: string;
15320
15404
  /**
15321
- * 批量请求类型,取值"page"或"scroll",默认
15322
- 值"page"
15405
+ * 批量请求类型,取值 PAGE:分页查询,SCROLL:滚动查询,SEARCHAFTER:游标查询,默认值PAGE
15406
+
15323
15407
  */
15324
15408
  BatchType?: string;
15325
15409
  /**
@@ -15384,7 +15468,7 @@ export interface DescribeResourceConfigResultV2 {
15384
15468
  */
15385
15469
  export interface ModifyGroupRequest {
15386
15470
  /**
15387
- * 部署组ID
15471
+ * 部署组ID,按照【部署组ID】进行过滤,可通过调用DescribeGroups查询已创建的项目列表或登录控制台进行查看;也可以调用CreateGroup创建新的项目。部署组ID例如:group-9yn2q8yd。
15388
15472
  */
15389
15473
  GroupId: string;
15390
15474
  /**
@@ -15440,15 +15524,15 @@ export interface TaskId {
15440
15524
  */
15441
15525
  export interface DescribeImageTagsRequest {
15442
15526
  /**
15443
- * 应用Id
15527
+ * 应用ID,可通过调用[DescribeApplications](https://cloud.tencent.com/document/api/649/36090)查询已创建的应用列表或登录控制台进行查看;也可以调用[CreateApplication](https://cloud.tencent.com/document/api/649/36094)创建新的应用。
15444
15528
  */
15445
15529
  ApplicationId?: string;
15446
15530
  /**
15447
- * 偏移量,取值从0开始
15531
+ * 偏移量,默认为0。关于Offset详见[API简介](https://cloud.tencent.com/document/api/213/568#.E8.BE.93.E5.85.A5.E5.8F.82.E6.95.B0.E4.B8.8E.E8.BF.94.E5.9B.9E.E5.8F.82.E6.95.B0.E9.87.8A.E4.B9.89)
15448
15532
  */
15449
15533
  Offset?: number;
15450
15534
  /**
15451
- * 分页个数,默认为20, 取值应为1~100
15535
+ * 数量限制,默认为20,最大值为100。关于Limit详见[API简介](https://cloud.tencent.com/document/api/213/568#.E8.BE.93.E5.85.A5.E5.8F.82.E6.95.B0.E4.B8.8E.E8.BF.94.E5.9B.9E.E5.8F.82.E6.95.B0.E9.87.8A.E4.B9.89)
15452
15536
  */
15453
15537
  Limit?: number;
15454
15538
  /**