tencentcloud-sdk-nodejs 4.1.98 → 4.1.100

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 (50) 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/vod/v20180717/vod_client.js +12 -0
  5. package/es/services/waf/v20180125/waf_client.js +28 -7
  6. package/package.json +1 -1
  7. package/tencentcloud/common/sdk_version.d.ts +1 -1
  8. package/tencentcloud/common/sdk_version.js +1 -1
  9. package/tencentcloud/services/batch/v20170312/batch_models.d.ts +2 -2
  10. package/tencentcloud/services/cfs/v20190719/cfs_models.d.ts +5 -5
  11. package/tencentcloud/services/clb/v20180317/clb_models.d.ts +122 -13
  12. package/tencentcloud/services/cls/v20201016/cls_client.d.ts +1 -1
  13. package/tencentcloud/services/cls/v20201016/cls_client.js +1 -1
  14. package/tencentcloud/services/cls/v20201016/cls_models.d.ts +225 -96
  15. package/tencentcloud/services/ess/v20201111/ess_models.d.ts +28 -0
  16. package/tencentcloud/services/essbasic/v20210526/essbasic_models.d.ts +16 -0
  17. package/tencentcloud/services/keewidb/v20220308/keewidb_models.d.ts +23 -23
  18. package/tencentcloud/services/lcic/v20220817/lcic_models.d.ts +23 -8
  19. package/tencentcloud/services/lke/v20231130/lke_client.d.ts +1 -1
  20. package/tencentcloud/services/lke/v20231130/lke_client.js +1 -1
  21. package/tencentcloud/services/lke/v20231130/lke_models.d.ts +754 -199
  22. package/tencentcloud/services/mongodb/v20190725/mongodb_models.d.ts +2 -2
  23. package/tencentcloud/services/monitor/v20180724/monitor_models.d.ts +2 -2
  24. package/tencentcloud/services/mps/v20190612/mps_models.d.ts +18 -0
  25. package/tencentcloud/services/ocr/v20181119/ocr_models.d.ts +16 -8
  26. package/tencentcloud/services/partners/v20180321/partners_models.d.ts +2 -2
  27. package/tencentcloud/services/postgres/v20170312/postgres_client.d.ts +8 -26
  28. package/tencentcloud/services/postgres/v20170312/postgres_client.js +10 -34
  29. package/tencentcloud/services/postgres/v20170312/postgres_models.d.ts +75 -424
  30. package/tencentcloud/services/sqlserver/v20180328/sqlserver_models.d.ts +9 -9
  31. package/tencentcloud/services/sts/v20180813/sts_client.d.ts +21 -7
  32. package/tencentcloud/services/sts/v20180813/sts_client.js +21 -7
  33. package/tencentcloud/services/tcbr/v20220217/tcbr_models.d.ts +37 -0
  34. package/tencentcloud/services/tcss/v20201101/tcss_models.d.ts +12 -0
  35. package/tencentcloud/services/tke/v20180525/tke_models.d.ts +5 -1
  36. package/tencentcloud/services/trabbit/v20230418/trabbit_models.d.ts +20 -0
  37. package/tencentcloud/services/trocket/v20230308/trocket_client.d.ts +11 -5
  38. package/tencentcloud/services/trocket/v20230308/trocket_client.js +14 -6
  39. package/tencentcloud/services/trocket/v20230308/trocket_models.d.ts +93 -0
  40. package/tencentcloud/services/trtc/v20190722/trtc_models.d.ts +3 -2
  41. package/tencentcloud/services/tsf/v20180326/tsf_client.d.ts +1 -1
  42. package/tencentcloud/services/tsf/v20180326/tsf_client.js +1 -1
  43. package/tencentcloud/services/tsf/v20180326/tsf_models.d.ts +422 -295
  44. package/tencentcloud/services/vod/v20180717/vod_client.d.ts +27 -1
  45. package/tencentcloud/services/vod/v20180717/vod_client.js +34 -0
  46. package/tencentcloud/services/vod/v20180717/vod_models.d.ts +236 -77
  47. package/tencentcloud/services/waf/v20180125/waf_client.d.ts +37 -9
  48. package/tencentcloud/services/waf/v20180125/waf_client.js +54 -12
  49. package/tencentcloud/services/waf/v20180125/waf_models.d.ts +349 -31
  50. 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
  /**
@@ -774,7 +773,7 @@ export interface QuantileEntity {
774
773
  */
775
774
  export interface ModifyProgramRequest {
776
775
  /**
777
- * 数据集ID
776
+ * 数据集ID,调用[DescribePrograms](https://console.cloud.tencent.com/tsf/privilege?rid=1&tab=program)查询接口会返回数据集信息,包括programId
778
777
  */
779
778
  ProgramId: string;
780
779
  /**
@@ -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
  /**
@@ -2366,7 +2371,7 @@ export interface ModifyContainerReplicasResponse {
2366
2371
  */
2367
2372
  export interface StopGroupRequest {
2368
2373
  /**
2369
- * 部署组ID
2374
+ * 按照【部署组ID】进行部署组删除,可通过调用[DescribeContainerGroups](https://cloud.tencent.com/document/product/649/36068)查询已创建的部署组列表或登录[控制台](https://console.cloud.tencent.com/tsf/app-detail?rid=1&id=application-zvw6zp9a&tab=publish&subTab=group)进行查看;也可以调用[CreateGroup](https://cloud.tencent.com/document/product/649/36074)创建新的部署组。
2370
2375
  */
2371
2376
  GroupId: string;
2372
2377
  }
@@ -2427,7 +2432,7 @@ export interface DescribeLanesResponse {
2427
2432
  */
2428
2433
  export interface StartGroupRequest {
2429
2434
  /**
2430
- * 部署组ID
2435
+ * 按照【部署组ID】进行部署组启动,可通过调用[DescribeContainerGroups](https://cloud.tencent.com/document/product/649/36068)查询已创建的部署组列表或登录[控制台](https://console.cloud.tencent.com/tsf/app-detail?rid=1&id=application-zvw6zp9a&tab=publish&subTab=group)进行查看;也可以调用[CreateGroup](https://cloud.tencent.com/document/product/649/36074)创建新的部署组。
2431
2436
  */
2432
2437
  GroupId: string;
2433
2438
  }
@@ -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,15 +2453,15 @@ export interface CreateNamespaceRequest {
2448
2453
  */
2449
2454
  NamespaceDesc?: string;
2450
2455
  /**
2451
- * 命名空间资源类型(默认值为DEF)
2456
+ * 命名空间资源类型;DEF:表示默认资源类型;GW:表示网关资源类型
2452
2457
  */
2453
2458
  NamespaceResourceType?: string;
2454
2459
  /**
2455
- * 是否是全局命名空间(默认是DEF,表示普通命名空间;GLOBAL表示全局命名空间)
2460
+ * 命名空间类型;DEF 表示默认普通命名空间;GLOBAL 表示全局命名空间
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
  }
@@ -2936,11 +2946,11 @@ export interface DescribeProgramsRequest {
2936
2946
  */
2937
2947
  SearchWord?: string;
2938
2948
  /**
2939
- * 每页数量
2949
+ * 每页数量,默认值20
2940
2950
  */
2941
2951
  Limit?: number;
2942
2952
  /**
2943
- * 起始偏移量
2953
+ * 起始偏移量,默认值0
2944
2954
  */
2945
2955
  Offset?: number;
2946
2956
  }
@@ -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
  /**
@@ -3742,7 +3754,7 @@ export interface CreateUnitRuleWithDetailRespRequest {
3742
3754
  */
3743
3755
  export interface DescribeContainerGroupAttributeRequest {
3744
3756
  /**
3745
- * 部署组ID
3757
+ * 部署组ID,按照【部署组ID】进行过滤,可通过调用DescribeGroups查询已创建的项目列表或登录控制台进行查看;也可以调用CreateGroup创建新的项目。部署组ID例如:group-ab958z6y
3746
3758
  */
3747
3759
  GroupId: string;
3748
3760
  }
@@ -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
  /**
@@ -3771,7 +3786,7 @@ export interface DescribeSimpleApplicationsRequest {
3771
3786
  */
3772
3787
  MicroserviceType?: string;
3773
3788
  /**
3774
- * 资源类型数组
3789
+ * 应用资源类型列表;DEF 表示默认资源类型;GW 表示网关资源类型
3775
3790
  */
3776
3791
  ApplicationResourceTypeList?: Array<string>;
3777
3792
  /**
@@ -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
  }
@@ -4435,11 +4450,11 @@ export interface MonitorOverview {
4435
4450
  */
4436
4451
  export interface CreateGroupRequest {
4437
4452
  /**
4438
- * 部署组所属的应用ID
4453
+ * 部署组所属的【应用ID】,可通过调用[DescribeApplications](https://cloud.tencent.com/document/product/649/36090)查询已创建的应用列表或登录[控制台](https://console.cloud.tencent.com/tsf/app?rid=1)进行查看;也可以调用[CreateApplication](https://cloud.tencent.com/document/product/649/36094)创建新的应用。
4439
4454
  */
4440
4455
  ApplicationId: string;
4441
4456
  /**
4442
- * 部署组所属命名空间ID
4457
+ * 部署组所属【命名空间ID】,可通过调用[DescribeSimpleNamespaces](https://cloud.tencent.com/document/product/649/36096)查询已创建的命名空间列表或登录[控制台](https://console.cloud.tencent.com/tsf/resource?rid=1&tab=namespace)进行查看;也可以调用[CreateNamespace](https://cloud.tencent.com/document/product/649/36098)创建新的命名空间。
4443
4458
  */
4444
4459
  NamespaceId: string;
4445
4460
  /**
@@ -4447,7 +4462,7 @@ export interface CreateGroupRequest {
4447
4462
  */
4448
4463
  GroupName: string;
4449
4464
  /**
4450
- * 集群ID
4465
+ * 部署组所属的【集群ID】,可通过调用[DescribeClusters](https://cloud.tencent.com/document/product/649/85857)查询已创建的集群列表或登录[控制台](https://console.cloud.tencent.com/tsf/resource?rid=1&tab=docker)进行查看;也可以调用[CreateCluster](https://cloud.tencent.com/document/product/649/36049)创建新的集群。
4451
4466
  */
4452
4467
  ClusterId: string;
4453
4468
  /**
@@ -4455,7 +4470,7 @@ export interface CreateGroupRequest {
4455
4470
  */
4456
4471
  GroupDesc?: string;
4457
4472
  /**
4458
- * 部署组资源类型;DEF 表示默认资源类型;GW 表示网关资源类型
4473
+ * 部署组资源类型;DEF 表示默认资源类型
4459
4474
  */
4460
4475
  GroupResourceType?: string;
4461
4476
  /**
@@ -4466,6 +4481,10 @@ export interface CreateGroupRequest {
4466
4481
  * 标签列表
4467
4482
  */
4468
4483
  Tags?: Array<Tag>;
4484
+ /**
4485
+ * k8s命名空间名称
4486
+ */
4487
+ K8sNamespaceName?: string;
4469
4488
  }
4470
4489
  /**
4471
4490
  * 应用使用容器部署时需要的额外资源
@@ -4487,7 +4506,7 @@ export interface ContainerAdditionalResourceRequirement {
4487
4506
  */
4488
4507
  export interface DeleteClusterRequest {
4489
4508
  /**
4490
- * 集群ID
4509
+ * 集群ID,按照【集群ID】进行过滤,可通过调用DescribeClusters查询已创建的项目列表或登录控制台进行查看;也可以调用CreateCluster创建新的项目。集群ID例如:cls-6a79x94v。仅在集群下无部署组、命名空间、云主机时可以删除。
4491
4510
  */
4492
4511
  ClusterId: string;
4493
4512
  /**
@@ -4500,7 +4519,7 @@ export interface DeleteClusterRequest {
4500
4519
  */
4501
4520
  export interface StopTaskBatchResponse {
4502
4521
  /**
4503
- * 操作成功 or 失败
4522
+ * 返回 true 或 false。true:操作成功,false:操作失败
4504
4523
  */
4505
4524
  Result?: boolean;
4506
4525
  /**
@@ -4521,7 +4540,7 @@ export interface ServiceStatisticsResult {
4521
4540
  */
4522
4541
  Method?: string;
4523
4542
  /**
4524
- * 微服务Id
4543
+ * 微服务ID
4525
4544
  */
4526
4545
  MicroserviceId?: string;
4527
4546
  /**
@@ -4553,7 +4572,7 @@ export interface ServiceStatisticsResult {
4553
4572
  */
4554
4573
  InstanceName?: string;
4555
4574
  /**
4556
- * 部署组id
4575
+ * 部署组ID
4557
4576
  */
4558
4577
  GroupId?: string;
4559
4578
  /**
@@ -4561,7 +4580,7 @@ export interface ServiceStatisticsResult {
4561
4580
  */
4562
4581
  GroupName?: string;
4563
4582
  /**
4564
- * 部署组类型
4583
+ * 集群类型,C:容器集群,V:虚拟机集群
4565
4584
  */
4566
4585
  ClusterType?: string;
4567
4586
  /**
@@ -4573,11 +4592,11 @@ export interface ServiceStatisticsResult {
4573
4592
  */
4574
4593
  InstanceExist?: number;
4575
4594
  /**
4576
- * 应用id
4595
+ * 应用ID
4577
4596
  */
4578
4597
  ApplicationId?: string;
4579
4598
  /**
4580
- * 微服务类型
4599
+ * 微服务类型。RAW:裸应用,M:mesh应用,N:普通应用,G:网关应用
4581
4600
  */
4582
4601
  MicroserviceType?: string;
4583
4602
  /**
@@ -4617,19 +4636,19 @@ export interface ServiceStatisticsResult {
4617
4636
  */
4618
4637
  InstanceTotalCount?: number;
4619
4638
  /**
4620
- * normal/error
4639
+ * 状态。normal:正常,warn:警告,error:错误
4621
4640
  */
4622
4641
  Status?: string;
4623
4642
  /**
4624
- * normal/warn/error
4643
+ * 请求错误率等级。normal:正常,warn:警告,error:错误
4625
4644
  */
4626
4645
  ErrorRateLevel?: string;
4627
4646
  /**
4628
- * normal/warn/error
4647
+ * 请求平均耗时等级。normal:正常,warn:警告,error:错误
4629
4648
  */
4630
4649
  AvgTimeConsumingLevel?: string;
4631
4650
  /**
4632
- * normal/warn/error
4651
+ * 应用程序性能指数等级。normal:正常,warn:警告,error:错误
4633
4652
  */
4634
4653
  ApdexLevel?: string;
4635
4654
  }
@@ -4664,7 +4683,7 @@ export interface DescribeContainerGroupDetailResponse {
4664
4683
  */
4665
4684
  export interface DisableTaskRequest {
4666
4685
  /**
4667
- * 任务ID。在[任务管理](https://console.cloud.tencent.com/tsf/tct?rid=1)列表页第一列或是任务基本信息页查看任务ID。
4686
+ * 任务ID[任务管理](https://console.cloud.tencent.com/tsf/tct?rid=1)列表页查看任务ID。
4668
4687
  */
4669
4688
  TaskId: string;
4670
4689
  }
@@ -4690,7 +4709,7 @@ export interface Ports {
4690
4709
  */
4691
4710
  TargetPort: number;
4692
4711
  /**
4693
- * 端口协议
4712
+ * 端口协议,TCP或者UDP
4694
4713
  */
4695
4714
  Protocol: string;
4696
4715
  }
@@ -4870,11 +4889,11 @@ export interface RemoveInstancesResponse {
4870
4889
  */
4871
4890
  export interface DescribeContainerEventsRequest {
4872
4891
  /**
4873
- * event 的资源类型, group 或者 instance
4892
+ * event 的资源类型, 仅支持 group
4874
4893
  */
4875
4894
  ResourceType: string;
4876
4895
  /**
4877
- * event 的资源 id
4896
+ * 部署组ID,按照【部署组ID】进行过滤,可通过调用DescribeGroups查询已创建的项目列表或登录控制台进行查看;也可以调用CreateGroup创建新的项目。部署组ID例如:group-9yn2q8yd
4878
4897
  */
4879
4898
  ResourceId: string;
4880
4899
  /**
@@ -4886,15 +4905,15 @@ export interface DescribeContainerEventsRequest {
4886
4905
  */
4887
4906
  Limit?: number;
4888
4907
  /**
4889
- * 当类型是 instance 时需要
4908
+ * 部署组ID,按照【部署组ID】进行过滤,可通过调用DescribeGroups查询已创建的项目列表或登录控制台进行查看;也可以调用CreateGroup创建新的项目。部署组ID例如:group-9yn2q8yd。
4890
4909
  */
4891
4910
  GroupId?: string;
4892
4911
  /**
4893
- * event的资源kind
4912
+ * event的资源种类
4894
4913
  */
4895
4914
  Kind?: string;
4896
4915
  /**
4897
- * event 的type
4916
+ * event 的事件级别
4898
4917
  */
4899
4918
  Type?: string;
4900
4919
  /**
@@ -5016,7 +5035,7 @@ export interface Env {
5016
5035
  */
5017
5036
  export interface ModifyClusterRequest {
5018
5037
  /**
5019
- * 集群ID
5038
+ * 集群ID,按照【集群ID】进行过滤,可通过调用DescribeClusters查询已创建的项目列表或登录控制台进行查看;也可以调用CreateCluster创建新的项目。集群ID例如:cls-6a79x94v。
5020
5039
  */
5021
5040
  ClusterId: string;
5022
5041
  /**
@@ -5032,11 +5051,11 @@ export interface ModifyClusterRequest {
5032
5051
  */
5033
5052
  ClusterRemarkName?: string;
5034
5053
  /**
5035
- * 是否开启cls日志功能
5054
+ * 是否开启cls日志功能,true表示开启,false表示关闭
5036
5055
  */
5037
5056
  EnableLogCollection?: boolean;
5038
5057
  /**
5039
- * 是否修复cls日志功能
5058
+ * 是否修复cls日志功能,true表示修复,false表示不修复
5040
5059
  */
5041
5060
  RepairLog?: boolean;
5042
5061
  }
@@ -5045,11 +5064,11 @@ export interface ModifyClusterRequest {
5045
5064
  */
5046
5065
  export interface Resource {
5047
5066
  /**
5048
- * 资源ID
5067
+ * 资源ID,调用[DescribeResource](https://console.cloud.tencent.com/tsf/privilege-program-create?rid=1)查询接口获取
5049
5068
  */
5050
5069
  ResourceId?: string;
5051
5070
  /**
5052
- * 资源编码
5071
+ * 资源编码,枚举值描述【cluster、namespace、config】
5053
5072
  */
5054
5073
  ResourceCode?: string;
5055
5074
  /**
@@ -5057,15 +5076,15 @@ export interface Resource {
5057
5076
  */
5058
5077
  ResourceName?: string;
5059
5078
  /**
5060
- * 资源所属产品编码
5079
+ * 资源所属产品编码,枚举值描述【tsf】
5061
5080
  */
5062
5081
  ServiceCode?: string;
5063
5082
  /**
5064
- * 选取资源使用的Action
5083
+ * 选取资源使用的Action,枚举值描述【DescribeSimpleCluster、DescribeLanes、DescribeTaskRecords】
5065
5084
  */
5066
5085
  ResourceAction?: string;
5067
5086
  /**
5068
- * 资源数据查询的ID字段名
5087
+ * 资源数据查询的ID字段名,调用[DescribeResource](https://console.cloud.tencent.com/tsf/privilege-program-create?rid=1)查询接口获取
5069
5088
  */
5070
5089
  IdField?: string;
5071
5090
  /**
@@ -5077,11 +5096,11 @@ export interface Resource {
5077
5096
  */
5078
5097
  SelectIdsField?: string;
5079
5098
  /**
5080
- * 创建时间
5099
+ * 创建时间,时间戳格式【Long】
5081
5100
  */
5082
5101
  CreationTime?: number;
5083
5102
  /**
5084
- * 最后更新时间
5103
+ * 最后更新时间,时间戳格式【Long】
5085
5104
  */
5086
5105
  LastUpdateTime?: number;
5087
5106
  /**
@@ -5101,7 +5120,7 @@ export interface Resource {
5101
5120
  */
5102
5121
  SearchWordField?: string;
5103
5122
  /**
5104
- * 排序
5123
+ * 排序,枚举值描述【10、20、77】
5105
5124
  */
5106
5125
  Index?: number;
5107
5126
  }
@@ -5243,7 +5262,7 @@ export interface DisableUnitRouteResponse {
5243
5262
  */
5244
5263
  export interface ExecuteTaskRequest {
5245
5264
  /**
5246
- * 任务ID。在任务管理列表页面第一列或是任务基本信息页查看任务ID。
5265
+ * 任务ID。在[任务管理](https://console.cloud.tencent.com/tsf/tct?rid=1)列表页查看任务ID。
5247
5266
  */
5248
5267
  TaskId: string;
5249
5268
  }
@@ -5252,7 +5271,8 @@ export interface ExecuteTaskRequest {
5252
5271
  */
5253
5272
  export interface DescribeGroupBusinessLogConfigsRequest {
5254
5273
  /**
5255
- * 分组ID
5274
+ * 部署组ID
5275
+ 可通过调用[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
5276
  */
5257
5277
  GroupId: string;
5258
5278
  }
@@ -5319,6 +5339,16 @@ export interface LaneInfo {
5319
5339
  注意:此字段可能返回 null,表示取不到有效值。
5320
5340
  */
5321
5341
  LaneGroupId?: string;
5342
+ /**
5343
+ * 是否禁用删除。
5344
+ true:禁用
5345
+ false:取消禁用
5346
+ */
5347
+ DeleteDisabled?: boolean;
5348
+ /**
5349
+ * 禁用原因
5350
+ */
5351
+ DeleteDisabledReason?: string;
5322
5352
  }
5323
5353
  /**
5324
5354
  * DescribeConfigReleaseLogs返回参数结构体
@@ -5388,7 +5418,8 @@ export interface DescribeSimpleNamespacesResponse {
5388
5418
  */
5389
5419
  export interface GroupInfo {
5390
5420
  /**
5391
- * 部署组id
5421
+ * 部署组ID
5422
+ 可通过调用[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
5423
  */
5393
5424
  GroupId: string;
5394
5425
  /**
@@ -5396,11 +5427,12 @@ export interface GroupInfo {
5396
5427
  */
5397
5428
  GroupName: string;
5398
5429
  /**
5399
- * 集群类型
5430
+ * 集群类型,C:容器集群,V:虚拟机集群
5400
5431
  */
5401
5432
  ClusterType: string;
5402
5433
  /**
5403
- * 集群id
5434
+ * 集群ID
5435
+ 可通过[DescribeClusters](https://cloud.tencent.com/document/product/649/85857)查询已经创建的集群列表,也可以通过登录[控制台](https://console.cloud.tencent.com/tsf/resource?rid=1)查看。
5404
5436
  */
5405
5437
  ClusterId?: string;
5406
5438
  /**
@@ -5412,7 +5444,7 @@ export interface GroupInfo {
5412
5444
  */
5413
5445
  NamespaceName?: string;
5414
5446
  /**
5415
- * 绑定时间
5447
+ * 绑定时间,格式yyyy-MM-dd HH:mm:ss
5416
5448
  */
5417
5449
  AssociateTime?: string;
5418
5450
  }
@@ -5434,7 +5466,7 @@ export interface TerminateTaskFlowBatchResponse {
5434
5466
  */
5435
5467
  export interface DisassociateKafkaConfigResponse {
5436
5468
  /**
5437
- * 解除绑定是否成功
5469
+ * 解除绑定是否成功,true:成功,false:失败。
5438
5470
  */
5439
5471
  Result?: boolean;
5440
5472
  /**
@@ -5581,11 +5613,11 @@ export interface ContainerGroupOther {
5581
5613
  */
5582
5614
  export interface AddClusterInstancesRequest {
5583
5615
  /**
5584
- * 集群ID
5616
+ * 集群ID,按照【集群ID】进行过滤,可通过调用[DescribeClusters](https://cloud.tencent.com/document/product/649/85857)查询已创建的集群列表或登录控制台进行查看;也可以调用[CreateCluster](https://cloud.tencent.com/document/product/649/36049)创建新的集群。仅在集群下无部署组、命名空间、云主机时可以删除。
5585
5617
  */
5586
5618
  ClusterId: string;
5587
5619
  /**
5588
- * 云主机ID列表
5620
+ * 云主机ID列表,可通过调用[DescribeInstances](https://cloud.tencent.com/document/api/213/15728)查询已创建的云主机列表或登录控制台进行查看;也可以调用[RunInstances](https://cloud.tencent.com/document/api/213/15730)创建新的云主机。
5589
5621
  */
5590
5622
  InstanceIdList: Array<string>;
5591
5623
  /**
@@ -5799,7 +5831,7 @@ export interface ContainerGroupDeploy {
5799
5831
  */
5800
5832
  TcrRepoInfo?: TcrRepoInfo;
5801
5833
  /**
5802
- * 数据卷信息,list
5834
+ * 数据卷信息,数组结构
5803
5835
  注意:此字段可能返回 null,表示取不到有效值。
5804
5836
  */
5805
5837
  VolumeInfos?: Array<VolumeInfo>;
@@ -5880,6 +5912,10 @@ export interface VolumeInfo {
5880
5912
  * -
5881
5913
  */
5882
5914
  EmptyDirOption?: EmptyDirOption;
5915
+ /**
5916
+ * 数据卷PVC声明模板
5917
+ */
5918
+ VolumeClaimTemplateOption?: VolumeClaimTemplatesOption;
5883
5919
  }
5884
5920
  /**
5885
5921
  * UpdateApiTimeouts请求参数结构体
@@ -5907,7 +5943,7 @@ export interface Metric {
5907
5943
  */
5908
5944
  Name?: string;
5909
5945
  /**
5910
- * 指标计算方式
5946
+ * 指标计算方式,可选值: none:无,sum:求和,exclusive:独占值,avg:平均值,max:最大值,min:最小值,percentage_50:50分位数,percentage_75:75分位数,percentage_95:95分位数,percentage_99:99分位数,bucket_5:分桶统计。
5911
5947
  */
5912
5948
  Function?: string;
5913
5949
  }
@@ -5942,27 +5978,27 @@ export interface ShrinkInstancesRequest {
5942
5978
  */
5943
5979
  export interface DescribeSimpleNamespacesRequest {
5944
5980
  /**
5945
- * 命名空间ID列表,不传入时查询全量
5981
+ * 命名空间ID列表,按照【命名空间ID列表】进行过滤,可通过调用[DescribeNamespaces](https://cloud.tencent.com/document/product/649/36096)查询已创建的命名空间列表或登录控制台进行查看;也可以调用[CreateNamespace](https://cloud.tencent.com/document/product/649/36098)创建新的命名空间。
5946
5982
  */
5947
5983
  NamespaceIdList?: Array<string>;
5948
5984
  /**
5949
- * 集群ID,不传入时查询全量
5985
+ * 集群ID,按照【集群ID】进行过滤,可通过调用[DescribeClusters](https://cloud.tencent.com/document/product/649/85857)查询已创建的集群列表或登录控制台进行查看;也可以调用[CreateCluster](https://cloud.tencent.com/document/product/649/36049)创建新的集群。仅在集群下无部署组、命名空间、云主机时可以删除。
5950
5986
  */
5951
5987
  ClusterId?: string;
5952
5988
  /**
5953
- * 每页条数
5989
+ * 数量限制,默认为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
5990
  */
5955
5991
  Limit?: number;
5956
5992
  /**
5957
- * 起始偏移量
5993
+ * 偏移量,默认为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
5994
  */
5959
5995
  Offset?: number;
5960
5996
  /**
5961
- * 命名空间ID,不传入时查询全量
5997
+ * 命名空间ID,按照【命名空间ID】进行过滤,可通过调用[DescribeNamespaces](https://cloud.tencent.com/document/product/649/36096)查询已创建的命名空间列表或登录控制台进行查看;也可以调用[CreateNamespace](https://cloud.tencent.com/document/product/649/36098)创建新命名空间。
5962
5998
  */
5963
5999
  NamespaceId?: string;
5964
6000
  /**
5965
- * 查询资源类型列表
6001
+ * 查询资源类型列表;DEF 表示默认资源类型;GW 表示网关资源类型
5966
6002
  */
5967
6003
  NamespaceResourceTypeList?: Array<string>;
5968
6004
  /**
@@ -5970,7 +6006,7 @@ export interface DescribeSimpleNamespacesRequest {
5970
6006
  */
5971
6007
  SearchWord?: string;
5972
6008
  /**
5973
- * 查询的命名空间类型列表
6009
+ * 查询的命名空间类型列表。DEF:默认普通命名空间。GLOBAL:全局命名空间。
5974
6010
  */
5975
6011
  NamespaceTypeList?: Array<string>;
5976
6012
  /**
@@ -5978,7 +6014,7 @@ export interface DescribeSimpleNamespacesRequest {
5978
6014
  */
5979
6015
  NamespaceName?: string;
5980
6016
  /**
5981
- * 通过是否是默认命名空间过滤,不传表示拉取全部命名空间。0:默认命名空间。1:非默认命名空间
6017
+ * 通过是否是默认命名空间过滤,不传表示拉取全部命名空间。0:默认命名空间。1:非默认命名空间。
5982
6018
  */
5983
6019
  IsDefault?: string;
5984
6020
  /**
@@ -6018,6 +6054,7 @@ export interface DescribeClustersResponse {
6018
6054
  export interface SearchBusinessLogRequest {
6019
6055
  /**
6020
6056
  * 日志配置项ID
6057
+ 可通过调用[DescribeBusinessLogConfigs](https://cloud.tencent.com/document/product/649/75777)查询已创建的日志配置项列表或登录[控制台](https://console.cloud.tencent.com/tsf/observable/log?rid=1)进行查看
6021
6058
  */
6022
6059
  ConfigId: string;
6023
6060
  /**
@@ -6025,11 +6062,11 @@ export interface SearchBusinessLogRequest {
6025
6062
  */
6026
6063
  InstanceIds?: Array<string>;
6027
6064
  /**
6028
- * 开始时间
6065
+ * 开始时间,格式yyyy-MM-dd HH:mm:ss
6029
6066
  */
6030
6067
  StartTime?: string;
6031
6068
  /**
6032
- * 结束时间
6069
+ * 结束时间,格式yyyy-MM-dd HH:mm:ss
6033
6070
  */
6034
6071
  EndTime?: string;
6035
6072
  /**
@@ -6054,14 +6091,15 @@ export interface SearchBusinessLogRequest {
6054
6091
  SearchWords?: Array<string>;
6055
6092
  /**
6056
6093
  * 部署组ID列表,不传表示全部部署组
6094
+ 可通过调用[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
6095
  */
6058
6096
  GroupIds?: Array<string>;
6059
6097
  /**
6060
- * 检索类型,取值"LUCENE", "REGEXP", "NORMAL"
6098
+ * 检索类型,取值 LUCENE:Lucene检索,REGEXP:正则检索,NORMAL:普通检索
6061
6099
  */
6062
6100
  SearchWordType?: string;
6063
6101
  /**
6064
- * 批量请求类型,取值"page"或"scroll"
6102
+ * 批量请求类型,取值 PAGE:分页查询,SCROLL:滚动查询,SEARCHAFTER:游标查询,默认值PAGE
6065
6103
  */
6066
6104
  BatchType?: string;
6067
6105
  /**
@@ -6290,11 +6328,11 @@ export interface DescribeImageRepositoryRequest {
6290
6328
  */
6291
6329
  SearchWord?: string;
6292
6330
  /**
6293
- * 偏移量,取值从0开始
6331
+ * 偏移量,默认为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
6332
  */
6295
6333
  Offset?: number;
6296
6334
  /**
6297
- * 分页个数,默认为20, 取值应为1~100
6335
+ * 数量限制,默认为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
6336
  */
6299
6337
  Limit?: number;
6300
6338
  /**
@@ -6302,7 +6340,7 @@ export interface DescribeImageRepositoryRequest {
6302
6340
  */
6303
6341
  RepoType?: string;
6304
6342
  /**
6305
- * 应用id
6343
+ * 应用ID,可通过调用[DescribeApplications](https://cloud.tencent.com/document/api/649/36090)查询已创建的应用列表或登录控制台进行查看;也可以调用[CreateApplication](https://cloud.tencent.com/document/api/649/36094)创建新的应用。
6306
6344
  */
6307
6345
  ApplicationId?: string;
6308
6346
  /**
@@ -6349,11 +6387,13 @@ export interface TsfPageUnitRule {
6349
6387
  */
6350
6388
  export interface OperateApplicationTcrBindingRequest {
6351
6389
  /**
6352
- * bind 或 unbind
6390
+ * 指定操作类型,目前支持:
6391
+ - `bind`:绑定(默认)
6392
+ - `unbind`:解除绑定
6353
6393
  */
6354
6394
  Command?: string;
6355
6395
  /**
6356
- * 应用id
6396
+ * 应用ID,可通过调用[DescribeApplications](https://cloud.tencent.com/document/api/649/36090)查询已创建的应用列表或登录控制台进行查看;也可以调用[CreateApplication](https://cloud.tencent.com/document/api/649/36094)创建新的应用。
6357
6397
  */
6358
6398
  ApplicationId?: string;
6359
6399
  /**
@@ -6375,7 +6415,7 @@ export interface DescribeApiGroupRequest {
6375
6415
  */
6376
6416
  export interface AssociateBusinessLogConfigResponse {
6377
6417
  /**
6378
- * 操作结果
6418
+ * 操作结果,true:成功,false:失败
6379
6419
  */
6380
6420
  Result?: boolean;
6381
6421
  /**
@@ -6417,7 +6457,8 @@ export interface DescribeGatewayApisRequest {
6417
6457
  */
6418
6458
  export interface AssociateConfigWithGroupRequest {
6419
6459
  /**
6420
- * 配置项id
6460
+ * 配置项ID
6461
+ 可通过调用[DescribeBusinessLogConfigs](https://cloud.tencent.com/document/product/649/75777)查询已创建的日志配置项列表或登录[控制台](https://console.cloud.tencent.com/tsf/observable/log?rid=1)进行查看
6421
6462
  */
6422
6463
  ConfigId: string;
6423
6464
  /**
@@ -6429,11 +6470,13 @@ export interface AssociateConfigWithGroupRequest {
6429
6470
  */
6430
6471
  SelectAll?: number;
6431
6472
  /**
6432
- * 命名空间id
6473
+ * 命名空间ID
6474
+ 可通过[DescribeSimpleNamespaces](https://cloud.tencent.com/document/product/649/36096)查询已经创建的命名空间,也可以通过登录[控制台](https://console.cloud.tencent.com/tsf/resource?rid=1&tab=namespace)查看
6433
6475
  */
6434
6476
  NamespaceId?: string;
6435
6477
  /**
6436
- * 集群id
6478
+ * 集群ID
6479
+ 可通过[DescribeClusters](https://cloud.tencent.com/document/product/649/85857)查询已经创建的集群列表,也可以通过登录[控制台](https://console.cloud.tencent.com/tsf/resource?rid=1)查看
6437
6480
  */
6438
6481
  ClusterId?: string;
6439
6482
  /**
@@ -6629,10 +6672,27 @@ export interface DeleteUnitNamespacesRequest {
6629
6672
  */
6630
6673
  export interface DescribeGroupRequest {
6631
6674
  /**
6632
- * 部署组ID
6675
+ * 部署组ID,可通过调用[DescribeGroups](https://cloud.tencent.com/document/api/649/36065)查询已创建的部署组列表或登录控制台进行查看;也可以调用[CreateGroup](https://cloud.tencent.com/document/api/649/36074)创建新的部署组。
6633
6676
  */
6634
6677
  GroupId: string;
6635
6678
  }
6679
+ /**
6680
+ * VolumeClaim模板项
6681
+ */
6682
+ export interface VolumeClaimTemplatesOption {
6683
+ /**
6684
+ * StorageClass名称
6685
+ */
6686
+ StorageClass?: string;
6687
+ /**
6688
+ * 访问模式
6689
+ */
6690
+ AccessModes?: Array<string>;
6691
+ /**
6692
+ * 卷空间的预占声明
6693
+ */
6694
+ StorageRequest?: number;
6695
+ }
6636
6696
  /**
6637
6697
  * 微服务网关单元化规则项
6638
6698
  */
@@ -6741,17 +6801,17 @@ export interface HealthCheckSetting {
6741
6801
  */
6742
6802
  ActionType: string;
6743
6803
  /**
6744
- * 容器延时启动健康检查的时间。
6804
+ * 容器延时启动健康检查的时间,单位秒。
6745
6805
  注意:此字段可能返回 null,表示取不到有效值。
6746
6806
  */
6747
6807
  InitialDelaySeconds?: number;
6748
6808
  /**
6749
- * 每次健康检查响应的最大超时时间。
6809
+ * 每次健康检查响应的最大超时时间,单位秒。
6750
6810
  注意:此字段可能返回 null,表示取不到有效值。
6751
6811
  */
6752
6812
  TimeoutSeconds?: number;
6753
6813
  /**
6754
- * 进行健康检查的时间间隔。
6814
+ * 进行健康检查的时间间隔,单位秒。
6755
6815
  注意:此字段可能返回 null,表示取不到有效值。
6756
6816
  */
6757
6817
  PeriodSeconds?: number;
@@ -7245,7 +7305,7 @@ export interface DescribePathRewritesRequest {
7245
7305
  */
7246
7306
  export interface ShrinkGroupRequest {
7247
7307
  /**
7248
- * 部署组ID
7308
+ * 部署组ID,可通过调用[DescribeGroups](https://cloud.tencent.com/document/api/649/36065)查询已创建的部署组列表或登录控制台进行查看;也可以调用[CreateGroup](https://cloud.tencent.com/document/api/649/36074)创建新的部署组。
7249
7309
  */
7250
7310
  GroupId: string;
7251
7311
  }
@@ -7267,12 +7327,12 @@ export interface TsfPageStdoutLogV2 {
7267
7327
  */
7268
7328
  ScrollId?: string;
7269
7329
  /**
7270
- * 查询状态
7330
+ * 查询状态,SUCCESS:查询成功完成,ERROR_RANGE_EXCEED:查询范围过大异常,ERROR_COMPLEX_CONDITION:查询条件复杂异常,ERROR_OTHER_CAUSE:其他异常
7271
7331
  注意:此字段可能返回 null,表示取不到有效值。
7272
7332
  */
7273
7333
  Status?: string;
7274
7334
  /**
7275
- * 游标ID
7335
+ * 查询es使用searchAfter时,游标
7276
7336
  */
7277
7337
  SearchAfter?: Array<string>;
7278
7338
  }
@@ -7372,11 +7432,11 @@ export interface DescribeGroupsWithPluginResponse {
7372
7432
  */
7373
7433
  export interface AddInstancesRequest {
7374
7434
  /**
7375
- * 集群ID
7435
+ * 集群ID,按照【集群ID】进行过滤,可通过调用[DescribeClusters](https://cloud.tencent.com/document/product/649/85857)查询已创建的集群列表或登录控制台进行查看;也可以调用[CreateCluster](https://cloud.tencent.com/document/product/649/36049)创建新的集群。仅在集群下无部署组、命名空间、云主机时可以删除。
7376
7436
  */
7377
7437
  ClusterId: string;
7378
7438
  /**
7379
- * 云主机ID列表
7439
+ * 云主机ID列表,可通过调用[DescribeInstances](https://cloud.tencent.com/document/api/213/15728)查询已创建的云主机列表或登录控制台进行查看;也可以调用[RunInstances](https://cloud.tencent.com/document/api/213/15730)创建新的云主机。
7380
7440
  */
7381
7441
  InstanceIdList: Array<string>;
7382
7442
  /**
@@ -7447,6 +7507,14 @@ export interface GatewayPlugin {
7447
7507
  注意:此字段可能返回 null,表示取不到有效值。
7448
7508
  */
7449
7509
  Status?: string;
7510
+ /**
7511
+ * 是否禁用删除
7512
+ */
7513
+ DeleteDisabled?: boolean;
7514
+ /**
7515
+ * 禁用原因
7516
+ */
7517
+ DeleteDisabledReason?: string;
7450
7518
  }
7451
7519
  /**
7452
7520
  * 网关分组简单信息
@@ -7482,7 +7550,7 @@ export interface GatewayApiGroupVo {
7482
7550
  */
7483
7551
  export interface CreateApplicationRequest {
7484
7552
  /**
7485
- * 应用名称
7553
+ * 应用名称,最长60字符
7486
7554
  */
7487
7555
  ApplicationName: string;
7488
7556
  /**
@@ -7512,7 +7580,7 @@ export interface CreateApplicationRequest {
7512
7580
  */
7513
7581
  ApplicationRuntimeType?: string;
7514
7582
  /**
7515
- * 需要绑定的数据集ID
7583
+ * 【数据集ID】。可通过调用[DescribePrograms](https://cloud.tencent.com/document/product/649/73477)查询已创建的数据集列表或登录[控制台](https://console.cloud.tencent.com/tsf/privilege?rid=1&tab=program&roleId=role-a26486wy)进行查看;也可以调用[CreateProgram](https://cloud.tencent.com/document/product/649/108544)创建新的数据集。
7516
7584
  */
7517
7585
  ProgramId?: string;
7518
7586
  /**
@@ -7566,11 +7634,11 @@ export interface ServiceStatisticsResults {
7566
7634
  */
7567
7635
  export interface DeployGroupRequest {
7568
7636
  /**
7569
- * 部署组ID
7637
+ * 部署组ID,可通过调用[DescribeContainerGroups](https://cloud.tencent.com/document/api/649/36068)查询已创建的部署组列表或登录控制台进行查看;也可以调用[CreateContainGroup](https://cloud.tencent.com/document/api/649/36075)创建新的部署组。
7570
7638
  */
7571
7639
  GroupId: string;
7572
7640
  /**
7573
- * 程序包ID
7641
+ * 软件包ID,可通过调用DescribeUploadInfo接口时[获取上传程序包信息](https://cloud.tencent.com/document/api/649/36078)返回的COS上传信息获取,登录[控制台](https://console.cloud.tencent.com/tsf/product?rid=1)进行查看
7574
7642
  */
7575
7643
  PkgId: string;
7576
7644
  /**
@@ -7610,7 +7678,7 @@ export interface DeployGroupRequest {
7610
7678
  */
7611
7679
  DeployExeMode?: string;
7612
7680
  /**
7613
- * 滚动发布每个批次的时间间隔
7681
+ * 滚动发布每个批次的时间间隔,单位min。默认值是0,不等待。
7614
7682
  */
7615
7683
  DeployWaitTime?: number;
7616
7684
  /**
@@ -7834,11 +7902,11 @@ export interface GatewayGroupIds {
7834
7902
  */
7835
7903
  export interface DescribeInvocationMetricDataDimensionRequest {
7836
7904
  /**
7837
- * 开始时间
7905
+ * 开始时间,格式yyyy-MM-dd HH:mm:ss
7838
7906
  */
7839
7907
  StartTime: string;
7840
7908
  /**
7841
- * 结束时间
7909
+ * 结束时间,格式yyyy-MM-dd HH:mm:ss
7842
7910
  */
7843
7911
  EndTime: string;
7844
7912
  /**
@@ -7850,7 +7918,7 @@ export interface DescribeInvocationMetricDataDimensionRequest {
7850
7918
  */
7851
7919
  Limit: number;
7852
7920
  /**
7853
- * 聚合维度
7921
+ * 聚合维度。可选值 NamespaceId:命名空间ID,GroupId:部署组ID,InstanceId:实例ID,ApplicationId:应用ID,OperationMethod:执行方法,OperationName:执行名称,ServiceName:服务名,UpstreamNamespaceId:上游命名空间ID
7854
7922
  */
7855
7923
  DimensionName: string;
7856
7924
  /**
@@ -7858,7 +7926,7 @@ export interface DescribeInvocationMetricDataDimensionRequest {
7858
7926
  */
7859
7927
  SearchWord?: string;
7860
7928
  /**
7861
- * 维度
7929
+ * 构建维度
7862
7930
  */
7863
7931
  MetricDimensionValues?: Array<MetricDimensionValue>;
7864
7932
  }
@@ -8082,7 +8150,8 @@ export interface GroupUseStatisticsEntity {
8082
8150
  */
8083
8151
  export interface DescribeBusinessLogConfigRequest {
8084
8152
  /**
8085
- * 配置项ID
8153
+ * 日志配置项ID
8154
+ 可通过调用[DescribeBusinessLogConfigs](https://cloud.tencent.com/document/product/649/75777)查询已创建的日志配置项列表或登录[控制台](https://console.cloud.tencent.com/tsf/observable/log?rid=1)进行查看
8086
8155
  */
8087
8156
  ConfigId: string;
8088
8157
  }
@@ -8165,7 +8234,7 @@ export interface ImageTag {
8165
8234
  */
8166
8235
  export interface ExecuteTaskFlowRequest {
8167
8236
  /**
8168
- * 工作流 ID。前往工作流管理,在工作流列表第一列和工作流详情页查看工作流ID。
8237
+ * 工作流 ID。[工作流管理](https://console.cloud.tencent.com/tsf/tct?rid=1&tab=workflowManage)列表页查看工作流ID。
8169
8238
  */
8170
8239
  FlowId?: string;
8171
8240
  }
@@ -8493,7 +8562,7 @@ export interface ServiceSetting {
8493
8562
  */
8494
8563
  LoadBalancerProvisioner?: string;
8495
8564
  /**
8496
- * 负载均衡类型
8565
+ * 负载均衡类型,Intranet表示内网,Internet表示外网
8497
8566
  */
8498
8567
  LoadBalancingType?: string;
8499
8568
  /**
@@ -8664,7 +8733,10 @@ export interface DeleteFileConfigResponse {
8664
8733
  */
8665
8734
  export interface ResourceTaskStatusResult {
8666
8735
  /**
8667
- * 任务的执行状态
8736
+ * 变更状态:
8737
+ - `0`:成功
8738
+ - `1`:失败
8739
+ - `2`:执行中
8668
8740
  */
8669
8741
  TaskStatus?: number;
8670
8742
  }
@@ -8772,7 +8844,7 @@ export interface ShardArgument {
8772
8844
  ShardValue?: string;
8773
8845
  }
8774
8846
  /**
8775
- * 指标维度多值匹配
8847
+ * 指标维度多值匹配。可选值 NamespaceId:命名空间ID,GroupId:部署组ID,InstanceId:实例ID,ApplicationId:应用ID,OperationMethod:执行方法,OperationName:执行名称,ServiceName:服务名,UpstreamNamespaceId:上游命名空间ID
8776
8848
  */
8777
8849
  export interface MetricDimensionValue {
8778
8850
  /**
@@ -9262,7 +9334,7 @@ export interface BindPluginResponse {
9262
9334
  */
9263
9335
  export interface RedoTaskFlowBatchRequest {
9264
9336
  /**
9265
- * 工作流批次 ID。在工作流管理页面,点击第一列的工作流ID进入工作流执行记录列表页面,第一列的内容即为工作流批次ID。
9337
+ * 工作流批次 ID。在[工作流管理](https://console.cloud.tencent.com/tsf/tct?rid=1&tab=workflowManage)页面,点击第一列的工作流ID进入工作流执行记录列表页面,第一列的内容即为工作流批次ID。
9266
9338
  */
9267
9339
  FlowBatchId: string;
9268
9340
  }
@@ -9301,7 +9373,7 @@ export interface CreateMicroserviceWithDetailRespRequest {
9301
9373
  */
9302
9374
  export interface BusinessLogConfigSchema {
9303
9375
  /**
9304
- * 解析规则类型
9376
+ * 解析规则类型。可选值 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
9377
  */
9306
9378
  SchemaType: number;
9307
9379
  /**
@@ -9320,7 +9392,7 @@ export interface BusinessLogConfigSchema {
9320
9392
  */
9321
9393
  SchemaMultilinePattern?: string;
9322
9394
  /**
9323
- * 解析规则创建时间
9395
+ * 解析规则创建时间,格式为yyyy-MM-dd HH:mm:ss
9324
9396
  */
9325
9397
  SchemaCreateTime?: string;
9326
9398
  /**
@@ -9355,15 +9427,15 @@ export interface MetricDataSingleValue {
9355
9427
  */
9356
9428
  export interface StopTaskExecuteRequest {
9357
9429
  /**
9358
- * 任务执行ID
9430
+ * 任务执行ID。在[任务管理](https://console.cloud.tencent.com/tsf/tct?rid=1)页面点击任务ID进入任务详情,进入执行记录页,点击批次ID进入执行详情列表页,第一列即为任务执行ID。
9359
9431
  */
9360
9432
  ExecuteId: string;
9361
9433
  /**
9362
- * 任务批次ID
9434
+ * 任务批次ID。在[任务管理](https://console.cloud.tencent.com/tsf/tct?rid=1)页面点击任务ID进入任务详情,进入执行记录列表页,第一列即为任务批次ID。
9363
9435
  */
9364
9436
  BatchId?: string;
9365
9437
  /**
9366
- * 任务ID
9438
+ * 任务ID。在[任务管理](https://console.cloud.tencent.com/tsf/tct?rid=1)列表页面可以查看任务ID。
9367
9439
  */
9368
9440
  TaskId?: string;
9369
9441
  }
@@ -9485,7 +9557,7 @@ export interface DescribeResourceConfigSts {
9485
9557
  */
9486
9558
  export interface DescribeApplicationAttributeRequest {
9487
9559
  /**
9488
- * 应用ID
9560
+ * 【应用ID】,可通过调用[DescribeApplications](https://cloud.tencent.com/document/product/649/36090)查询已创建的应用列表或登录[控制台](https://console.cloud.tencent.com/tsf/app?rid=1)进行查看;也可以调用[CreateApplication](https://cloud.tencent.com/document/product/649/36094)创建新的应用。
9489
9561
  */
9490
9562
  ApplicationId: string;
9491
9563
  }
@@ -9747,6 +9819,10 @@ export interface SimpleGroup {
9747
9819
  * 应用微服务类型
9748
9820
  */
9749
9821
  AppMicroServiceType?: string;
9822
+ /**
9823
+ * k8s 命名空间名称
9824
+ */
9825
+ K8sNamespaceName?: string;
9750
9826
  }
9751
9827
  /**
9752
9828
  * CreateApiRateLimitRuleWithDetailResp返回参数结构体
@@ -9782,7 +9858,7 @@ export interface DescribeTaskRecordsRequest {
9782
9858
  */
9783
9859
  TaskState?: string;
9784
9860
  /**
9785
- * 部署组ID。前往应用管理 - 应用部署,部署组列表页面获取部署组ID。
9861
+ * 部署组ID。前往[应用管理](https://console.cloud.tencent.com/tsf/app?rid=1)点击应用ID进入应用部署列表页面获取部署组ID
9786
9862
  */
9787
9863
  GroupId?: string;
9788
9864
  /**
@@ -9794,7 +9870,7 @@ export interface DescribeTaskRecordsRequest {
9794
9870
  */
9795
9871
  ExecuteType?: string;
9796
9872
  /**
9797
- * 任务ID列表。
9873
+ * 任务ID列表。在[任务管理](https://console.cloud.tencent.com/tsf/tct?rid=1)列表页第一列查看任务ID。
9798
9874
  */
9799
9875
  Ids?: Array<string>;
9800
9876
  }
@@ -9853,15 +9929,15 @@ export interface ModifyContainerGroupResponse {
9853
9929
  */
9854
9930
  export interface ExclusiveInstance {
9855
9931
  /**
9856
- * 配置中心类型[RegistrationConfiguration]
9932
+ * 配置中心类型[注册中心Registration、配置中心Configuration]
9857
9933
  */
9858
9934
  CenterType?: string;
9859
9935
  /**
9860
- * 实例id
9936
+ * 实例id,通过北极星控制台获取
9861
9937
  */
9862
9938
  InstanceId?: string;
9863
9939
  /**
9864
- * 实例类型[Polaris]
9940
+ * 实例类型,例如北极星Polaris
9865
9941
  */
9866
9942
  InstanceType?: string;
9867
9943
  /**
@@ -9869,11 +9945,11 @@ export interface ExclusiveInstance {
9869
9945
  */
9870
9946
  InstanceName?: string;
9871
9947
  /**
9872
- * 实例地域id
9948
+ * 实例地域id,通过北极星控制台获取
9873
9949
  */
9874
9950
  RegionId?: string;
9875
9951
  /**
9876
- * 实例命名空间ID
9952
+ * 实例命名空间ID,通过北极星控制台获取
9877
9953
  */
9878
9954
  InstanceNamespaceId?: string;
9879
9955
  }
@@ -9882,7 +9958,7 @@ export interface ExclusiveInstance {
9882
9958
  */
9883
9959
  export interface DeleteApplicationRequest {
9884
9960
  /**
9885
- * 应用ID
9961
+ * 应用ID,可通过调用[DescribeApplications](https://cloud.tencent.com/document/api/649/36090)查询已创建的应用列表或登录控制台进行查看;也可以调用[CreateApplication](https://cloud.tencent.com/document/api/649/36094)创建新的应用。
9886
9962
  */
9887
9963
  ApplicationId: string;
9888
9964
  /**
@@ -10046,11 +10122,12 @@ export interface DescribeBusinessLogConfigsRequest {
10046
10122
  */
10047
10123
  SearchWord?: string;
10048
10124
  /**
10049
- *
10125
+ * 是否禁用数据集鉴权
10050
10126
  */
10051
10127
  DisableProgramAuthCheck?: boolean;
10052
10128
  /**
10053
- *
10129
+ * 日志配置项ID
10130
+ 可通过调用[DescribeBusinessLogConfigs](https://cloud.tencent.com/document/product/649/75777)查询已创建的日志配置项列表或登录[控制台](https://console.cloud.tencent.com/tsf/observable/log?rid=1)进行查看
10054
10131
  */
10055
10132
  ConfigIdList?: Array<string>;
10056
10133
  }
@@ -10430,7 +10507,7 @@ export interface UpdateGatewayApiRequest {
10430
10507
  */
10431
10508
  export interface DescribeInstancesRequest {
10432
10509
  /**
10433
- * 过滤条件
10510
+ * 过滤条件,name表示过滤字段,value表示过滤字段值。
10434
10511
  */
10435
10512
  Filters?: Array<Filter>;
10436
10513
  /**
@@ -10788,27 +10865,27 @@ export interface ApplicationForPage {
10788
10865
  */
10789
10866
  export interface DescribeInvocationMetricScatterPlotRequest {
10790
10867
  /**
10791
- * 查询开始时间
10868
+ * 查询开始时间,格式yyyy-MM-dd HH:mm:ss
10792
10869
  */
10793
10870
  StartTime?: string;
10794
10871
  /**
10795
- * 查询结束时间
10872
+ * 查询结束时间,格式yyyy-MM-dd HH:mm:ss
10796
10873
  */
10797
10874
  EndTime?: string;
10798
10875
  /**
10799
- * 查询时间粒度,单位秒。可选值:60、3600、86400
10876
+ * 查询时间粒度,单位秒。可选值:60、3600、86400
10800
10877
  */
10801
10878
  Period?: number;
10802
10879
  /**
10803
- * 查询指标维度, 不能为空。可选 NamespaceId, GroupId, InstanceId, OperationName, ServiceName, PeerServiceName, PeerOperationName
10880
+ * 查询指标维度, 不能为空。Name, Valeu键值对形式。Name可选值 NamespaceId:命名空间ID,GroupId:部署组ID,InstanceId:实例ID,ApplicationId:应用ID,OperationMethod:执行方法,OperationName:执行名称,ServiceName:服务名,UpstreamNamespaceId:上游命名空间ID
10804
10881
  */
10805
10882
  MetricDimensions?: Array<MetricDimension>;
10806
10883
  /**
10807
- * 查询指标名, 不能为空。仅支持 range_count_duratioin 为 key 下的 sum 方法
10884
+ * 查询指标名, 不能为空。仅支持 range_count_duration(响应耗时分布) 为 key 下的 sum(求和) 方法
10808
10885
  */
10809
10886
  Metrics?: Array<Metric>;
10810
10887
  /**
10811
- * 视图视角。可选值:SERVER, CLIENT。默认为SERVER
10888
+ * 视图视角。可选值:SERVER:服务端, CLIENT:客户端。默认为SERVER
10812
10889
  */
10813
10890
  Kind?: string;
10814
10891
  }
@@ -10895,27 +10972,27 @@ export interface AddClusterInstancesResponse {
10895
10972
  */
10896
10973
  export interface DescribeInvocationMetricDataCurveRequest {
10897
10974
  /**
10898
- * 查询开始时间
10975
+ * 开始时间,格式yyyy-MM-dd HH:mm:ss
10899
10976
  */
10900
10977
  StartTime?: string;
10901
10978
  /**
10902
- * 查询结束时间
10979
+ * 结束时间,格式yyyy-MM-dd HH:mm:ss
10903
10980
  */
10904
10981
  EndTime?: string;
10905
10982
  /**
10906
- * 查询时间粒度,单位秒可选值:60、3600、86400
10983
+ * 查询时间粒度,单位秒。可选值:60、3600、86400
10907
10984
  */
10908
10985
  Period?: number;
10909
10986
  /**
10910
- * 查询指标维度,不能为空,支持 ServiceName, OperationName, PeerServiceName, PeerOperationName
10987
+ * 查询指标维度,不能为空
10911
10988
  */
10912
10989
  MetricDimensions?: Array<MetricDimension>;
10913
10990
  /**
10914
- * 查询指标名,不能为空.
10991
+ * 查询指标名,不能为空
10915
10992
  */
10916
10993
  Metrics?: Array<Metric>;
10917
10994
  /**
10918
- * 视图视角。可选值:SERVER, CLIENT。默认为SERVER
10995
+ * 视图视角。可选值:SERVER:服务端,CLIENT:客户端。默认为SERVER
10919
10996
  */
10920
10997
  Kind?: string;
10921
10998
  /**
@@ -10959,7 +11036,7 @@ export interface VmGroupOther {
10959
11036
  */
10960
11037
  OffInstanceCount?: number;
10961
11038
  /**
10962
- * 部署组状态
11039
+ * 部署组状态,Running运行中,Waiting等待中,Paused暂停中,Updating更新中,RollingBack回滚中,Abnormal异常,Unknown未知
10963
11040
  */
10964
11041
  GroupStatus?: string;
10965
11042
  /**
@@ -11062,7 +11139,7 @@ export interface BusinessLogConfigAssociatedGroup {
11062
11139
  */
11063
11140
  ApplicationName: string;
11064
11141
  /**
11065
- * 部署组所属应用类型
11142
+ * 部署组所属应用类型,C:容器应用,V:虚拟机应用
11066
11143
  */
11067
11144
  ApplicationType: string;
11068
11145
  /**
@@ -11082,11 +11159,11 @@ export interface BusinessLogConfigAssociatedGroup {
11082
11159
  */
11083
11160
  ClusterName: string;
11084
11161
  /**
11085
- * 部署组所属集群类型
11162
+ * 部署组所属集群类型,C:容器集群,V:虚拟机集群
11086
11163
  */
11087
11164
  ClusterType: string;
11088
11165
  /**
11089
- * 部署组关联日志配置时间
11166
+ * 部署组关联日志配置时间,格式yyyy-MM-dd HH:mm:ss
11090
11167
  */
11091
11168
  AssociatedTime: string;
11092
11169
  }
@@ -11103,19 +11180,24 @@ export interface DescribeApplicationsRequest {
11103
11180
  */
11104
11181
  OrderBy?: string;
11105
11182
  /**
11106
- * 排序类型
11183
+ * 指定排序类型,目前支持:
11184
+ `0`:降序
11185
+ `1`:升序
11107
11186
  */
11108
11187
  OrderType?: number;
11109
11188
  /**
11110
- * 偏移量
11189
+ * 偏移量,默认为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
11190
  */
11112
11191
  Offset?: number;
11113
11192
  /**
11114
- * 分页个数
11193
+ * 数量限制,默认为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
11194
  */
11116
11195
  Limit?: number;
11117
11196
  /**
11118
- * 应用类型
11197
+ * 指定应用类型,目前支持:
11198
+ - `V`:普通应用/CVM应用
11199
+ - `C`:容器应用
11200
+ - `S`:serverless 应用
11119
11201
  */
11120
11202
  ApplicationType?: string;
11121
11203
  /**
@@ -11123,7 +11205,7 @@ export interface DescribeApplicationsRequest {
11123
11205
  */
11124
11206
  MicroserviceType?: string;
11125
11207
  /**
11126
- * 应用资源类型数组
11208
+ * 应用资源类型列表;DEF 表示默认资源类型;GW 表示网关资源类型
11127
11209
  */
11128
11210
  ApplicationResourceTypeList?: Array<string>;
11129
11211
  /**
@@ -11334,7 +11416,7 @@ export interface CurvePoint {
11334
11416
  */
11335
11417
  Value?: string;
11336
11418
  /**
11337
- * 该坐标点时间戳
11419
+ * 该坐标点时间戳,单位毫秒
11338
11420
  */
11339
11421
  Timestamp?: string;
11340
11422
  }
@@ -11554,7 +11636,7 @@ export interface DescribeGroupInstancesResponse {
11554
11636
  */
11555
11637
  export interface DescribeContainerGroupDeployInfoRequest {
11556
11638
  /**
11557
- * 实例所属 groupId
11639
+ * 部署组ID,按照【部署组ID】进行过滤,可通过调用DescribeGroups查询已创建的项目列表或登录控制台进行查看;也可以调用CreateGroup创建新的项目。部署组ID例如:group-ab958z6y
11558
11640
  */
11559
11641
  GroupId: string;
11560
11642
  }
@@ -11575,11 +11657,13 @@ export interface DescribeDeliveryConfigsRequest {
11575
11657
  */
11576
11658
  Limit?: number;
11577
11659
  /**
11578
- * 数据集idList
11660
+ * 数据集ID列表
11661
+ 可通过调用[DescribePrograms](https://cloud.tencent.com/document/product/649/73477)查询已创建的数据集列表或登录[控制台](https://console.cloud.tencent.com/tsf/privilege?rid=1&tab=program&roleId=role-a22gwdwa)进行查看
11579
11662
  */
11580
11663
  ProgramIdList?: Array<string>;
11581
11664
  /**
11582
- * ConfigIdList
11665
+ * 日志配置项ID列表
11666
+ 可通过调用[DescribeBusinessLogConfigs](https://cloud.tencent.com/document/product/649/75777)查询已创建的日志配置项列表或登录[控制台](https://console.cloud.tencent.com/tsf/observable/log?rid=1)进行查看
11583
11667
  */
11584
11668
  ConfigIdList?: Array<string>;
11585
11669
  }
@@ -11589,10 +11673,12 @@ export interface DescribeDeliveryConfigsRequest {
11589
11673
  export interface DisassociateBusinessLogConfigRequest {
11590
11674
  /**
11591
11675
  * 业务日志配置项ID列表
11676
+ 可通过调用[DescribeBusinessLogConfigs](https://cloud.tencent.com/document/product/649/75777)查询已创建的日志配置项列表或登录[控制台](https://console.cloud.tencent.com/tsf/observable/log?rid=1)进行查看
11592
11677
  */
11593
11678
  ConfigIdList: Array<string>;
11594
11679
  /**
11595
- * TSF分组ID
11680
+ * 部署组ID
11681
+ 可通过调用[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
11682
  */
11597
11683
  GroupId: string;
11598
11684
  }
@@ -11716,11 +11802,11 @@ export interface EmptyDirOption {
11716
11802
  */
11717
11803
  export interface ExpandGroupRequest {
11718
11804
  /**
11719
- * 部署组ID
11805
+ * 部署组ID,可通过调用[DescribeGroups](https://cloud.tencent.com/document/api/649/36065)查询已创建的部署组列表或登录控制台进行查看;也可以调用[CreateGroup](https://cloud.tencent.com/document/api/649/36074)创建新的部署组。
11720
11806
  */
11721
11807
  GroupId: string;
11722
11808
  /**
11723
- * 扩容的机器实例ID列表
11809
+ * 扩容的机器实例ID列表,调用[DescribeClusters](https://console.cloud.tencent.com/tsf/resource?rid=1)接口,选定一个虚拟机集群,选择部署组,选择应用扩容可获取实例列表
11724
11810
  */
11725
11811
  InstanceIdList: Array<string>;
11726
11812
  }
@@ -11779,7 +11865,7 @@ export interface DescribeMicroservicesByGroupIdsResponse {
11779
11865
  */
11780
11866
  export interface DescribeGroupAttributeRequest {
11781
11867
  /**
11782
- * 部署组ID字段
11868
+ * 部署组ID,按照【部署组ID】进行过滤,可通过调用DescribeGroups查询已创建的项目列表或登录控制台进行查看;也可以调用CreateGroup创建新的项目。部署组ID例如:group-ab958z6y
11783
11869
  */
11784
11870
  GroupId: string;
11785
11871
  }
@@ -11886,19 +11972,19 @@ export interface GroupPod {
11886
11972
  */
11887
11973
  ReadyCount?: number;
11888
11974
  /**
11889
- * 运行时长
11975
+ * 运行时长,单位秒
11890
11976
  */
11891
11977
  Runtime?: string;
11892
11978
  /**
11893
- * 实例启动时间
11979
+ * 实例启动时的时间戳
11894
11980
  */
11895
11981
  CreatedAt?: string;
11896
11982
  /**
11897
- * 服务实例状态
11983
+ * 服务实例状态,枚举值为Starting/Running/Stopping/Stopped/StopFailed/Abnormal/Unknown
11898
11984
  */
11899
11985
  ServiceInstanceStatus?: string;
11900
11986
  /**
11901
- * 机器实例可使用状态
11987
+ * 机器实例可使用状态,枚举值为Starting/Running/Stopping/Stopped/StopFailed/Abnormal/Unknown
11902
11988
  */
11903
11989
  InstanceAvailableStatus?: string;
11904
11990
  /**
@@ -11919,7 +12005,7 @@ export interface GroupPod {
11919
12005
  */
11920
12006
  export interface EnableTaskFlowRequest {
11921
12007
  /**
11922
- * 工作流 ID。前往工作流管理,在工作流列表第一列和工作流详情页查看工作流ID。
12008
+ * 工作流 ID。[工作流管理](https://console.cloud.tencent.com/tsf/tct?rid=1&tab=workflowManage)列表页查看工作流ID。
11923
12009
  */
11924
12010
  FlowId: string;
11925
12011
  }
@@ -12078,7 +12164,7 @@ export interface StdoutLogV2 {
12078
12164
  */
12079
12165
  Content?: string;
12080
12166
  /**
12081
- * 日志时间戳
12167
+ * 日志时间戳,单位毫秒
12082
12168
  */
12083
12169
  Timestamp?: number;
12084
12170
  /**
@@ -12253,15 +12339,15 @@ export interface ServiceConfig {
12253
12339
  */
12254
12340
  export interface RedoTaskExecuteRequest {
12255
12341
  /**
12256
- * 任务批次ID。在任务管理页面第一列点击任务ID进入任务详情,进入执行记录列表页,第一列内容即为任务批次ID。
12342
+ * 任务批次ID。在[任务管理](https://console.cloud.tencent.com/tsf/tct?rid=1)页面第一列点击任务ID进入任务详情,进入执行记录列表页,第一列内容即为任务批次ID。
12257
12343
  */
12258
12344
  BatchId: string;
12259
12345
  /**
12260
- * 任务执行ID。在任务管理页面第一列点击任务ID进入任务详情,进入执行记录页,点击批次ID进入执行详情列表页,第一列即为任务执行ID。
12346
+ * 任务执行ID。在[任务管理](https://console.cloud.tencent.com/tsf/tct?rid=1)页面第一列点击任务ID进入任务详情,进入执行记录页,点击批次ID进入执行详情列表页,第一列即为任务执行ID。
12261
12347
  */
12262
12348
  ExecuteId: string;
12263
12349
  /**
12264
- * 任务ID。在任务管理列表页面可以查看任务ID。
12350
+ * 任务ID。在[任务管理](https://console.cloud.tencent.com/tsf/tct?rid=1)列表页查看任务ID。
12265
12351
  */
12266
12352
  TaskId: string;
12267
12353
  }
@@ -12323,11 +12409,11 @@ export interface InvocationIndicator {
12323
12409
  */
12324
12410
  export interface DescribeStatisticsRequest {
12325
12411
  /**
12326
- * 类型:InterfaceServiceGroupInstanceSQLNoSQL
12412
+ * 统计类型。可选值 Interface:接口类型、Service:服务类型、Group:部署组类型、Instance:实例类型、SQL:SQL类型、NoSQL:NoSQL类型
12327
12413
  */
12328
12414
  Type: string;
12329
12415
  /**
12330
- * 步长,单位s:60、3600、86400
12416
+ * 步长,单位秒。可选值 60、3600、86400
12331
12417
  */
12332
12418
  TimeStep: number;
12333
12419
  /**
@@ -12339,7 +12425,9 @@ export interface DescribeStatisticsRequest {
12339
12425
  */
12340
12426
  Limit: number;
12341
12427
  /**
12342
- * 命名空间Id,此字段,和 NamespaceIdList 或者 MetricDimensionValues 字段包含 namespaceId 维度信息。三者选其一。
12428
+ * 命名空间ID。此字段,和 NamespaceIdList 或者 MetricDimensionValues 字段包含 namespaceId 维度信息。三者选其一。
12429
+ 可通过[DescribeSimpleNamespaces](https://cloud.tencent.com/document/product/649/36096)查询已经创建的命名空间,也可以通过登录[控制台](https://console.cloud.tencent.com/tsf/resource?rid=1&tab=namespace)查看
12430
+
12343
12431
  */
12344
12432
  NamespaceId?: string;
12345
12433
  /**
@@ -12367,7 +12455,7 @@ export interface DescribeStatisticsRequest {
12367
12455
  */
12368
12456
  SearchWord?: string;
12369
12457
  /**
12370
- * 维度
12458
+ * 维度。此字段,和 NamespaceIdList 或者 MetricDimensionValues 字段包含 namespaceId 维度信息。三者选其一
12371
12459
  */
12372
12460
  MetricDimensionValues?: Array<MetricDimensionValue>;
12373
12461
  /**
@@ -12375,15 +12463,16 @@ export interface DescribeStatisticsRequest {
12375
12463
  */
12376
12464
  BucketKey?: string;
12377
12465
  /**
12378
- * 数据库
12466
+ * 数据库名称
12379
12467
  */
12380
12468
  DbName?: string;
12381
12469
  /**
12382
- * 命名空间id数组
12470
+ * 命名空间ID数组。此字段,和 NamespaceIdList 或者 MetricDimensionValues 字段包含 namespaceId 维度信息。三者选其一
12383
12471
  */
12384
12472
  NamespaceIdList?: Array<string>;
12385
12473
  /**
12386
- * 独占配置中心的ID
12474
+ * 独占配置中心的ID
12475
+ 可通过调用[DescribeClusterInstances](https://cloud.tencent.com/document/product/649/36048)查询已导入的实例列表或登录[控制台](https://console.cloud.tencent.com/tsf/resource?rid=1&tab=instance)进行查询。实例ID例如:ins-6decplwk。
12387
12476
  */
12388
12477
  ConfigCenterInstanceId?: string;
12389
12478
  }
@@ -12507,7 +12596,7 @@ export interface DescribeGatewayAllGroupApisRequest {
12507
12596
  */
12508
12597
  export interface DeleteGroupRequest {
12509
12598
  /**
12510
- * 部署组ID
12599
+ * 部署组ID,可通过调用[DescribeGroups](https://cloud.tencent.com/document/api/649/36065)查询已创建的部署组列表或登录控制台进行查看;也可以调用[CreateGroup](https://cloud.tencent.com/document/api/649/36074)创建新的部署组。
12511
12600
  */
12512
12601
  GroupId: string;
12513
12602
  }
@@ -12713,11 +12802,11 @@ export interface BindApiGroupRequest {
12713
12802
  */
12714
12803
  export interface StopTaskBatchRequest {
12715
12804
  /**
12716
- * 批次ID
12805
+ * 任务批次ID。在[任务管理](https://console.cloud.tencent.com/tsf/tct?rid=1)页面点击任务ID进入任务详情,进入执行记录列表页,第一列即为任务批次ID。
12717
12806
  */
12718
12807
  BatchId: string;
12719
12808
  /**
12720
- * 参数ID
12809
+ * 任务ID。在[任务管理](https://console.cloud.tencent.com/tsf/tct?rid=1)列表页面可以查看任务ID。
12721
12810
  */
12722
12811
  TaskId?: string;
12723
12812
  }
@@ -12843,7 +12932,7 @@ export interface DescribeUsableUnitNamespacesRequest {
12843
12932
  */
12844
12933
  export interface DescribeContainerGroupsRequest {
12845
12934
  /**
12846
- * 分组所属应用ID
12935
+ * 分组所属【应用ID】,可通过调用[DescribeApplications](https://cloud.tencent.com/document/product/649/36090)查询已创建的应用列表或登录[控制台](https://console.cloud.tencent.com/tsf/app?rid=1)进行查看;也可以调用[CreateApplication](https://cloud.tencent.com/document/product/649/36094)创建新的应用。
12847
12936
  */
12848
12937
  ApplicationId: string;
12849
12938
  /**
@@ -12867,11 +12956,11 @@ export interface DescribeContainerGroupsRequest {
12867
12956
  */
12868
12957
  Limit?: number;
12869
12958
  /**
12870
- * 集群ID
12959
+ * 分组所属【集群ID】,可通过调用[DescribeClusters](https://cloud.tencent.com/document/product/649/85857)查询已创建的集群列表或登录[控制台](https://console.cloud.tencent.com/tsf/resource?rid=1&tab=docker)进行查看;也可以调用[CreateCluster](https://cloud.tencent.com/document/product/649/36049)创建新的集群。
12871
12960
  */
12872
12961
  ClusterId?: string;
12873
12962
  /**
12874
- * 命名空间 ID
12963
+ * 分组所属【命名空间 ID】,可通过调用[DescribeSimpleNamespaces](https://cloud.tencent.com/document/product/649/36096)查询已创建的命名空间列表或登录[控制台](https://console.cloud.tencent.com/tsf/resource?rid=1&tab=namespace)进行查看;也可以调用[CreateNamespace](https://cloud.tencent.com/document/product/649/36098)创建新的命名空间。
12875
12964
  */
12876
12965
  NamespaceId?: string;
12877
12966
  }
@@ -12906,7 +12995,8 @@ export interface DescribeProgramsResponse {
12906
12995
  */
12907
12996
  export interface ProgramItem {
12908
12997
  /**
12909
- * 数据项ID
12998
+ * 数据项ID,调用[DescribePrograms](https://console.cloud.tencent.com/tsf/privilege?rid=1&tab=program)接口查询已创建的数据集或登陆控制台进行查看;也可以通过调用[CreateProgram](https://cloud.tencent.com/document/api/649/108544)创建新的数据集。
12999
+
12910
13000
  */
12911
13001
  ProgramItemId?: string;
12912
13002
  /**
@@ -12922,11 +13012,11 @@ export interface ProgramItem {
12922
13012
  */
12923
13013
  IsAll?: boolean;
12924
13014
  /**
12925
- * 创建时间
13015
+ * 创建时间,时间戳格式【Long】
12926
13016
  */
12927
13017
  CreationTime?: number;
12928
13018
  /**
12929
- * 最后更新时间
13019
+ * 最后更新时间,时间戳格式【Long】,单位毫秒
12930
13020
  */
12931
13021
  LastUpdateTime?: number;
12932
13022
  /**
@@ -12934,7 +13024,7 @@ export interface ProgramItem {
12934
13024
  */
12935
13025
  DeleteFlag?: boolean;
12936
13026
  /**
12937
- * 数据集ID
13027
+ * 数据集ID,调用[DescribePrograms](https://console.cloud.tencent.com/tsf/privilege?rid=1&tab=program)查询接口获取
12938
13028
  */
12939
13029
  ProgramId?: string;
12940
13030
  }
@@ -12943,7 +13033,7 @@ export interface ProgramItem {
12943
13033
  */
12944
13034
  export interface DisableTaskFlowRequest {
12945
13035
  /**
12946
- * 工作流 ID。前往工作流管理,在工作流列表第一列和工作流详情页查看工作流ID。
13036
+ * 工作流 ID。[工作流管理](https://console.cloud.tencent.com/tsf/tct?rid=1&tab=workflowManage)列表页查看工作流ID。
12947
13037
  */
12948
13038
  FlowId: string;
12949
13039
  }
@@ -12969,7 +13059,7 @@ export interface DescribeLogCapacityResponse {
12969
13059
  */
12970
13060
  export interface DescribePodInstancesRequest {
12971
13061
  /**
12972
- * 实例所属groupId
13062
+ * 实例所属部署组ID,按照【部署组ID】进行过滤,可通过调用DescribeGroups查询已创建的项目列表或登录控制台进行查看;也可以调用CreateGroup创建新的项目。部署组ID例如:group-9yn2q8yd。部署组所在集群必须是活跃状态的。
12973
13063
  */
12974
13064
  GroupId: string;
12975
13065
  /**
@@ -12981,15 +13071,15 @@ export interface DescribePodInstancesRequest {
12981
13071
  */
12982
13072
  Limit?: number;
12983
13073
  /**
12984
- * 过滤字段
13074
+ * 用于通过PodName字段过滤返回结果。
12985
13075
  */
12986
13076
  PodNameList?: Array<string>;
12987
13077
  /**
12988
- * 新老版本pod批次标识
13078
+ * 新老版本pod批次标识,old表示老版本,new表示新版本。
12989
13079
  */
12990
13080
  DeployVersion?: string;
12991
13081
  /**
12992
- * 任务ID
13082
+ * 实例所属任务ID,登录控制台进行查看。
12993
13083
  */
12994
13084
  TaskId?: string;
12995
13085
  }
@@ -13027,21 +13117,21 @@ export interface DeliveryConfigBindGroup {
13027
13117
  */
13028
13118
  Groups: Array<GroupInfo>;
13029
13119
  /**
13030
- * 创建时间
13120
+ * 创建时间,格式yyyy-MM-dd HH:mm:ss
13031
13121
  */
13032
13122
  CreateTime: string;
13033
13123
  /**
13034
- * KafkaVIp
13124
+ * Kafka的vip
13035
13125
  注意:此字段可能返回 null,表示取不到有效值。
13036
13126
  */
13037
13127
  KafkaVIp?: string;
13038
13128
  /**
13039
- * KafkaAddress
13129
+ * Kafka地址
13040
13130
  注意:此字段可能返回 null,表示取不到有效值。
13041
13131
  */
13042
13132
  KafkaAddress?: string;
13043
13133
  /**
13044
- * KafkaVPort
13134
+ * Kafka端口
13045
13135
  注意:此字段可能返回 null,表示取不到有效值。
13046
13136
  */
13047
13137
  KafkaVPort?: string;
@@ -13055,7 +13145,7 @@ export interface DeliveryConfigBindGroup {
13055
13145
  */
13056
13146
  LineRule?: string;
13057
13147
  /**
13058
- * CustomRule
13148
+ * 自定义规则
13059
13149
  注意:此字段可能返回 null,表示取不到有效值。
13060
13150
  */
13061
13151
  CustomRule?: string;
@@ -13065,16 +13155,16 @@ export interface DeliveryConfigBindGroup {
13065
13155
  */
13066
13156
  EnableGlobalLineRule?: boolean;
13067
13157
  /**
13068
- * EnableAuth
13158
+ * 是否开启认证
13069
13159
  */
13070
13160
  EnableAuth?: boolean;
13071
13161
  /**
13072
- * Username
13162
+ * 用户名
13073
13163
  注意:此字段可能返回 null,表示取不到有效值。
13074
13164
  */
13075
13165
  Username?: string;
13076
13166
  /**
13077
- * Password
13167
+ * 密码
13078
13168
  注意:此字段可能返回 null,表示取不到有效值。
13079
13169
  */
13080
13170
  Password?: string;
@@ -13139,7 +13229,7 @@ export interface WarmupSetting {
13139
13229
  */
13140
13230
  Enabled?: boolean;
13141
13231
  /**
13142
- * 预热时间
13232
+ * 预热时间,单位秒
13143
13233
  */
13144
13234
  WarmupTime?: number;
13145
13235
  /**
@@ -13227,7 +13317,7 @@ export interface InstanceEnrichedInfo {
13227
13317
  */
13228
13318
  ApplicationName?: string;
13229
13319
  /**
13230
- * 应用类型
13320
+ * 应用类型,C表示容器应用,V表示虚拟机应用
13231
13321
  */
13232
13322
  ApplicationType?: string;
13233
13323
  /**
@@ -13239,7 +13329,7 @@ export interface InstanceEnrichedInfo {
13239
13329
  */
13240
13330
  ClusterName?: string;
13241
13331
  /**
13242
- * 集群类型
13332
+ * 集群类型,C表示容器集群,V表示虚拟机集群
13243
13333
  */
13244
13334
  ClusterType?: string;
13245
13335
  /**
@@ -13264,7 +13354,7 @@ export interface InstanceEnrichedInfo {
13264
13354
  */
13265
13355
  export interface DescribeResourceTaskStatusRequest {
13266
13356
  /**
13267
- * 任务ID
13357
+ * 容器实例任务ID,可通过调用 ListContainerTask 查询已创建的变更记录总数或登录控制台进行查看。
13268
13358
  */
13269
13359
  TaskId: string;
13270
13360
  }
@@ -13519,7 +13609,7 @@ export interface TsfPageBusinessLogV2 {
13519
13609
  */
13520
13610
  ScrollId?: string;
13521
13611
  /**
13522
- * 查询状态
13612
+ * 查询状态,SUCCESS:查询成功完成,ERROR_RANGE_EXCEED:查询范围过大异常,ERROR_COMPLEX_CONDITION:查询条件复杂异常,ERROR_OTHER_CAUSE:其他异常
13523
13613
  注意:此字段可能返回 null,表示取不到有效值。
13524
13614
  */
13525
13615
  Status?: string;
@@ -13546,11 +13636,14 @@ export interface CreateClusterRequest {
13546
13636
  */
13547
13637
  ClusterName: string;
13548
13638
  /**
13549
- * 集群类型
13639
+ * 指定集群类型,目前支持:
13640
+ - `V`:虚拟机集群
13641
+ - `C`:容器集群
13642
+ - `S`:Serverless 集群
13550
13643
  */
13551
13644
  ClusterType: string;
13552
13645
  /**
13553
- * 私有网络ID
13646
+ * 私有网络ID,可通过调用[DescribeVpcEx](https://cloud.tencent.com/document/api/215/1372)查询已创建的私有网络列表或登录控制台进行查看;也可以调用[CreateVpc](https://cloud.tencent.com/document/api/215/1309)创建新的私有网络。
13554
13647
  */
13555
13648
  VpcId: string;
13556
13649
  /**
@@ -13615,7 +13708,8 @@ export interface CreateClusterRequest {
13615
13708
  */
13616
13709
  export interface DescribeDeliveryConfigByGroupIdRequest {
13617
13710
  /**
13618
- * 部署组id
13711
+ * 部署组ID
13712
+ 可通过调用[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
13713
  */
13620
13714
  GroupId: string;
13621
13715
  }
@@ -13721,7 +13815,7 @@ export interface ConfigRelease {
13721
13815
  */
13722
13816
  export interface DeleteContainerGroupRequest {
13723
13817
  /**
13724
- * 部署组ID,分组唯一标识
13818
+ * 部署组ID,可通过调用[DescribeContainerGroups](https://cloud.tencent.com/document/api/649/36068)查询已创建的部署组列表或登录控制台进行查看;也可以调用[CreateContainGroup](https://cloud.tencent.com/document/api/649/36075)创建新的部署组。
13725
13819
  */
13726
13820
  GroupId: string;
13727
13821
  }
@@ -13818,12 +13912,12 @@ export interface BusinessLogConfig {
13818
13912
  */
13819
13913
  ConfigPipeline?: string;
13820
13914
  /**
13821
- * 配置项创建时间
13915
+ * 配置项创建时间,格式为yyyy-MM-dd HH:mm:ss
13822
13916
  注意:此字段可能返回 null,表示取不到有效值。
13823
13917
  */
13824
13918
  ConfigCreateTime?: string;
13825
13919
  /**
13826
- * 配置项更新时间
13920
+ * 配置项更新时间,格式为yyyy-MM-dd HH:mm:ss
13827
13921
  注意:此字段可能返回 null,表示取不到有效值。
13828
13922
  */
13829
13923
  ConfigUpdateTime?: string;
@@ -13849,6 +13943,22 @@ export interface BusinessLogConfig {
13849
13943
  * close_timeout参数
13850
13944
  */
13851
13945
  FilebeatCloseTimeout?: number;
13946
+ /**
13947
+ * filebeat ignore_older参数
13948
+ */
13949
+ FilebeatIgnoreOlder?: number;
13950
+ /**
13951
+ * filebeat harvester_limit参数
13952
+ */
13953
+ FilebeatHarvesterLimit?: number;
13954
+ /**
13955
+ * filebeat close_inactive参数
13956
+ */
13957
+ FilebeatCloseInactive?: number;
13958
+ /**
13959
+ * filebeat clean_inactive参数
13960
+ */
13961
+ FilebeatCleanInactive?: number;
13852
13962
  }
13853
13963
  /**
13854
13964
  * DescribeApiDetail请求参数结构体
@@ -13887,7 +13997,7 @@ export interface DescribeApiDetailRequest {
13887
13997
  */
13888
13998
  export interface StopContainerGroupRequest {
13889
13999
  /**
13890
- * 部署组ID
14000
+ * 部署组ID,可通过调用[DescribeContainerGroups](https://cloud.tencent.com/document/api/649/36068)查询已创建的部署组列表或登录控制台进行查看;也可以调用[CreateContainGroup](https://cloud.tencent.com/document/api/649/36075)创建新的部署组。
13891
14001
  */
13892
14002
  GroupId: string;
13893
14003
  }
@@ -14208,6 +14318,22 @@ export interface DeployContainerApplicationRequest {
14208
14318
  * 本次部署的描述信息
14209
14319
  */
14210
14320
  DeployDesc?: string;
14321
+ /**
14322
+ * k8s命名空间名称
14323
+ */
14324
+ K8sNamespaceName?: string;
14325
+ /**
14326
+ * 是否启用静态IP
14327
+ */
14328
+ StaticIpEnabled?: boolean;
14329
+ /**
14330
+ * 启动策略[OrderedReady/Parallel]
14331
+ */
14332
+ PodManagementPolicyType?: string;
14333
+ /**
14334
+ * 滚动更新分区序号
14335
+ */
14336
+ Partition?: number;
14211
14337
  }
14212
14338
  /**
14213
14339
  * 用于请求参数中的条件过滤字段
@@ -14244,7 +14370,7 @@ export interface ServiceGovernanceConfig {
14244
14370
  */
14245
14371
  EnableGovernance?: boolean;
14246
14372
  /**
14247
- * 服务治理类型(枚举:SHAREEXCLUSIVE
14373
+ * 服务治理类型(枚举:SHARE表示共享型、EXCLUSIVE表示独占型)
14248
14374
  */
14249
14375
  GovernanceType?: string;
14250
14376
  /**
@@ -14291,7 +14417,7 @@ export interface ModifyApplicationRequest {
14291
14417
  */
14292
14418
  ServiceConfigList?: Array<ServiceConfig>;
14293
14419
  /**
14294
- * 应用的微服务类型
14420
+ * 应用的微服务类型,N表示普通应用,M表示Mesh应用,G表示网关应用,NATIVE表示原生应用,RAW表示裸应用
14295
14421
  */
14296
14422
  MicroserviceType?: string;
14297
14423
  /**
@@ -14299,7 +14425,7 @@ export interface ModifyApplicationRequest {
14299
14425
  */
14300
14426
  ServiceGovernanceConfig?: ServiceGovernanceConfig;
14301
14427
  /**
14302
- * 应用开发框架
14428
+ * 应用开发框架,SpringCloud表示SpringCloud应用,Dubbo表示Dubbo应用,Go-GRPC表示Go-GRPC应用,Other表示其他应用
14303
14429
  */
14304
14430
  FrameworkType?: string;
14305
14431
  }
@@ -14386,7 +14512,7 @@ export interface DescribeFlowLastBatchStateResponse {
14386
14512
  */
14387
14513
  export interface StopTaskExecuteResponse {
14388
14514
  /**
14389
- * 操作成功 or 失败
14515
+ * 返回 true 或 false。true:操作成功,false:操作失败
14390
14516
  */
14391
14517
  Result?: boolean;
14392
14518
  /**
@@ -14434,27 +14560,27 @@ export interface DeleteRepositoryRequest {
14434
14560
  */
14435
14561
  export interface DescribeSimpleGroupsRequest {
14436
14562
  /**
14437
- * 部署组ID列表,不填写时查询全量
14563
+ * 按照【部署组ID】进行过滤,不填写时查询全量。可通过调用[DescribeContainerGroups](https://cloud.tencent.com/document/product/649/36068)查询已创建的部署组列表或登录[控制台](https://console.cloud.tencent.com/tsf/app-detail?rid=1&id=application-zvw6zp9a&tab=publish&subTab=group)进行查看;也可以调用[CreateGroup](https://cloud.tencent.com/document/product/649/36074)创建新的部署组。
14438
14564
  */
14439
14565
  GroupIdList?: Array<string>;
14440
14566
  /**
14441
- * 应用ID,不填写时查询全量
14567
+ * 按照【应用ID】进行过滤,不填写时查询全量。可通过调用[DescribeApplications](https://cloud.tencent.com/document/product/649/36090)查询已创建的应用列表或登录[控制台](https://console.cloud.tencent.com/tsf/app?rid=1)进行查看;也可以调用[CreateApplication](https://cloud.tencent.com/document/product/649/36094)创建新的应用。
14442
14568
  */
14443
14569
  ApplicationId?: string;
14444
14570
  /**
14445
- * 集群ID,不填写时查询全量
14571
+ * 按照【集群ID】进行过滤,不填写时查询全量。可通过调用[DescribeClusters](https://cloud.tencent.com/document/product/649/85857)查询已创建的集群列表或登录[控制台](https://console.cloud.tencent.com/tsf/resource?rid=1&tab=docker)进行查看;也可以调用[CreateCluster](https://cloud.tencent.com/document/product/649/36049)创建新的集群。
14446
14572
  */
14447
14573
  ClusterId?: string;
14448
14574
  /**
14449
- * 命名空间ID,不填写时查询全量
14575
+ * 按照【命名空间ID】进行过滤,不填写时查询全量。可通过调用[DescribeSimpleNamespaces](https://cloud.tencent.com/document/product/649/36096)查询已创建的命名空间列表或登录[控制台](https://console.cloud.tencent.com/tsf/resource?rid=1&tab=namespace)进行查看;也可以调用[CreateNamespace](https://cloud.tencent.com/document/product/649/36098)创建新的命名空间。
14450
14576
  */
14451
14577
  NamespaceId?: string;
14452
14578
  /**
14453
- * 每页条数
14579
+ * 每页条数,默认值20,无上限
14454
14580
  */
14455
14581
  Limit?: number;
14456
14582
  /**
14457
- * 起始偏移量
14583
+ * 起始偏移量,默认值0
14458
14584
  */
14459
14585
  Offset?: number;
14460
14586
  /**
@@ -14703,7 +14829,7 @@ export interface GroupPodResult {
14703
14829
  */
14704
14830
  export interface DescribeApplicationRequest {
14705
14831
  /**
14706
- * 应用ID
14832
+ * 应用ID,可通过调用[DescribeApplications](https://cloud.tencent.com/document/api/649/36090)查询已创建的应用列表或登录控制台进行查看;也可以调用[CreateApplication](https://cloud.tencent.com/document/api/649/36094)创建新的应用。
14707
14833
  */
14708
14834
  ApplicationId: string;
14709
14835
  }
@@ -14970,7 +15096,7 @@ export interface DescribeGroupsRequest {
14970
15096
  */
14971
15097
  SearchWord?: string;
14972
15098
  /**
14973
- * 应用ID
15099
+ * 应用ID。调用[DescribeApplications](https://cloud.tencent.com/document/api/649/36090)查询已创建的应用或通过[CreateApplication](https://cloud.tencent.com/document/api/649/36094)接口创建新的应用。
14974
15100
  */
14975
15101
  ApplicationId?: string;
14976
15102
  /**
@@ -14978,23 +15104,23 @@ export interface DescribeGroupsRequest {
14978
15104
  */
14979
15105
  OrderBy?: string;
14980
15106
  /**
14981
- * 排序方式
15107
+ * 排序方式,0:升序,1:降序
14982
15108
  */
14983
15109
  OrderType?: number;
14984
15110
  /**
14985
- * 偏移量
15111
+ * 偏移量,默认值:0
14986
15112
  */
14987
15113
  Offset?: number;
14988
15114
  /**
14989
- * 分页个数
15115
+ * 分页个数,默认值:20
14990
15116
  */
14991
15117
  Limit?: number;
14992
15118
  /**
14993
- * 命名空间ID
15119
+ * 命名空间ID。调用[DescribeSimpleNamespaces](https://cloud.tencent.com/document/api/649/36096)查询已创建的命名空间或通过[CreateNamespace](https://cloud.tencent.com/document/api/649/36098)接口创建新的集群。
14994
15120
  */
14995
15121
  NamespaceId?: string;
14996
15122
  /**
14997
- * 集群ID
15123
+ * 集群 ID。调用[DescribeSimpleClusters](https://cloud.tencent.com/document/api/649/36047)查询已创建的集群或通过[CreateCluster](https://cloud.tencent.com/document/api/649/36049)接口创建新的集群。
14998
15124
  */
14999
15125
  ClusterId?: string;
15000
15126
  /**
@@ -15055,7 +15181,7 @@ export interface LaneRuleTag {
15055
15181
  */
15056
15182
  export interface ModifyNamespaceRequest {
15057
15183
  /**
15058
- * 命名空间ID
15184
+ * 命名空间ID,按照【命名空间ID】进行过滤,可通过调用DescribeNamespaces查询已创建的项目列表或登录控制台进行查看;也可以调用CreateNamespace创建新的项目。命名空间ID例如:namespace-6a79x94v。
15059
15185
  */
15060
15186
  NamespaceId: string;
15061
15187
  /**
@@ -15067,7 +15193,7 @@ export interface ModifyNamespaceRequest {
15067
15193
  */
15068
15194
  NamespaceDesc?: string;
15069
15195
  /**
15070
- * 是否开启高可用
15196
+ * 是否开启高可用,0表示不开启,1表示开启
15071
15197
  */
15072
15198
  IsHaEnable?: string;
15073
15199
  }
@@ -15122,11 +15248,11 @@ export interface CreateRepositoryRequest {
15122
15248
  */
15123
15249
  export interface DeleteNamespaceRequest {
15124
15250
  /**
15125
- * 命名空间ID
15251
+ * 命名空间ID,按照【命名空间ID】进行过滤,可通过调用[DescribeNamespaces](https://cloud.tencent.com/document/product/649/36096)查询已创建的命名空间列表或登录控制台进行查看;也可以调用[CreateNamespace](https://cloud.tencent.com/document/product/649/36098)创建新命名空间。
15126
15252
  */
15127
15253
  NamespaceId: string;
15128
15254
  /**
15129
- * 集群ID
15255
+ * 集群ID,按照【集群ID】进行过滤,可通过调用[DescribeClusters](https://cloud.tencent.com/document/product/649/85857)查询已创建的集群列表或登录控制台进行查看;也可以调用[CreateCluster](https://cloud.tencent.com/document/product/649/36049)创建新的集群。仅在集群下无部署组、命名空间、云主机时可以删除。
15130
15256
  */
15131
15257
  ClusterId?: string;
15132
15258
  }
@@ -15275,7 +15401,11 @@ export interface ContainerInfo {
15275
15401
  */
15276
15402
  export interface SearchStdoutLogRequest {
15277
15403
  /**
15278
- * 机器实例ID, 和 实例 ID 二者必选其一,不能同时为空
15404
+ * 机器实例ID, 和 部署组 ID 二者必选其一,不能同时为空
15405
+ 可通过调用[DescribeClusterInstances](https://cloud.tencent.com/document/product/649/36048)查询已导入的实例列表或登录[控制台](https://console.cloud.tencent.com/tsf/resource?rid=1&tab=instance)进行查询。实例ID例如:ins-6decplwk
15406
+
15407
+
15408
+
15279
15409
  */
15280
15410
  InstanceId?: string;
15281
15411
  /**
@@ -15287,15 +15417,16 @@ export interface SearchStdoutLogRequest {
15287
15417
  */
15288
15418
  SearchWords?: Array<string>;
15289
15419
  /**
15290
- * 查询起始时间
15420
+ * 查询起始时间,格式yyyy-MM-dd HH:mm:ss
15291
15421
  */
15292
15422
  StartTime?: string;
15293
15423
  /**
15294
15424
  * 部署组ID,和 InstanceId 二者必选其一,不能同时为空
15425
+ 可通过调用[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
15426
  */
15296
15427
  GroupId?: string;
15297
15428
  /**
15298
- * 查询结束时间
15429
+ * 查询结束时间,格式yyyy-MM-dd HH:mm:ss
15299
15430
  */
15300
15431
  EndTime?: string;
15301
15432
  /**
@@ -15304,22 +15435,20 @@ export interface SearchStdoutLogRequest {
15304
15435
  */
15305
15436
  Offset?: number;
15306
15437
  /**
15307
- * 排序规则,默认值"time"
15438
+ * 排序规则,time:按时间排序,score:按检索值排序,默认值"time"
15308
15439
  */
15309
15440
  OrderBy?: string;
15310
15441
  /**
15311
- * 排序方式,取值"asc""desc",默认
15312
- 值"desc"
15442
+ * 排序方式,取值 asc:升序 desc:降序,默认值desc
15313
15443
  */
15314
15444
  OrderType?: string;
15315
15445
  /**
15316
- * 检索类型,取值"LUCENE", "REGEXP",
15317
- "NORMAL"
15446
+ * 检索类型,取值 LUCENE:Lucene检索,REGEXP:正则检索,NORMAL:普通检索
15318
15447
  */
15319
15448
  SearchWordType?: string;
15320
15449
  /**
15321
- * 批量请求类型,取值"page"或"scroll",默认
15322
- 值"page"
15450
+ * 批量请求类型,取值 PAGE:分页查询,SCROLL:滚动查询,SEARCHAFTER:游标查询,默认值PAGE
15451
+
15323
15452
  */
15324
15453
  BatchType?: string;
15325
15454
  /**
@@ -15384,7 +15513,7 @@ export interface DescribeResourceConfigResultV2 {
15384
15513
  */
15385
15514
  export interface ModifyGroupRequest {
15386
15515
  /**
15387
- * 部署组ID
15516
+ * 部署组ID,按照【部署组ID】进行过滤,可通过调用DescribeGroups查询已创建的项目列表或登录控制台进行查看;也可以调用CreateGroup创建新的项目。部署组ID例如:group-9yn2q8yd。
15388
15517
  */
15389
15518
  GroupId: string;
15390
15519
  /**
@@ -15440,15 +15569,15 @@ export interface TaskId {
15440
15569
  */
15441
15570
  export interface DescribeImageTagsRequest {
15442
15571
  /**
15443
- * 应用Id
15572
+ * 应用ID,可通过调用[DescribeApplications](https://cloud.tencent.com/document/api/649/36090)查询已创建的应用列表或登录控制台进行查看;也可以调用[CreateApplication](https://cloud.tencent.com/document/api/649/36094)创建新的应用。
15444
15573
  */
15445
15574
  ApplicationId?: string;
15446
15575
  /**
15447
- * 偏移量,取值从0开始
15576
+ * 偏移量,默认为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
15577
  */
15449
15578
  Offset?: number;
15450
15579
  /**
15451
- * 分页个数,默认为20, 取值应为1~100
15580
+ * 数量限制,默认为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
15581
  */
15453
15582
  Limit?: number;
15454
15583
  /**
@@ -15507,11 +15636,11 @@ export interface DescribeConfigSummaryResponse {
15507
15636
  */
15508
15637
  export interface CreateContainGroupRequest {
15509
15638
  /**
15510
- * 分组所属应用ID
15639
+ * 分组所属【应用ID】,可通过调用[DescribeApplications](https://cloud.tencent.com/document/product/649/36090)查询已创建的应用列表或登录[控制台](https://console.cloud.tencent.com/tsf/app?rid=1)进行查看;也可以调用[CreateApplication](https://cloud.tencent.com/document/product/649/36094)创建新的应用。
15511
15640
  */
15512
15641
  ApplicationId: string;
15513
15642
  /**
15514
- * 分组所属命名空间ID
15643
+ * 分组所属【命名空间ID】,可通过调用[DescribeSimpleNamespaces](https://cloud.tencent.com/document/product/649/36096)查询已创建的命名空间列表或登录[控制台](https://console.cloud.tencent.com/tsf/resource?rid=1&tab=namespace)进行查看;也可以调用[CreateNamespace](https://cloud.tencent.com/document/product/649/36098)创建新的命名空间。
15515
15644
  */
15516
15645
  NamespaceId: string;
15517
15646
  /**
@@ -15563,13 +15692,11 @@ export interface CreateContainGroupRequest {
15563
15692
  */
15564
15693
  MemRequest?: string;
15565
15694
  /**
15566
- * 部署组资源类型;
15567
- DEF — 默认资源类型;
15568
- GW — 网关资源类型;
15695
+ * 部署组资源类型;DEF 表示默认资源类型
15569
15696
  */
15570
15697
  GroupResourceType?: string;
15571
15698
  /**
15572
- * 子网ID
15699
+ * 分组所属【子网ID】,可前往TKE侧集群[控制台](https://console.cloud.tencent.com/tke2/cluster/sub/list/basic/info/base?rid=1&clusterId=cls-2nhp3g1i)进行获取
15573
15700
  */
15574
15701
  SubnetId?: string;
15575
15702
  /**