tencentcloud-sdk-nodejs 4.1.97 → 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 (72) hide show
  1. package/es/common/sdk_version.js +1 -1
  2. package/es/services/lighthouse/v20200324/lighthouse_client.js +6 -0
  3. package/es/services/lke/v20231130/lke_client.js +0 -3
  4. package/es/services/postgres/v20170312/postgres_client.js +6 -15
  5. package/es/services/trocket/v20230308/trocket_client.js +7 -4
  6. package/es/services/trtc/v20190722/trtc_client.js +9 -0
  7. package/es/services/waf/v20180125/waf_client.js +28 -7
  8. package/package.json +1 -1
  9. package/tencentcloud/common/sdk_version.d.ts +1 -1
  10. package/tencentcloud/common/sdk_version.js +1 -1
  11. package/tencentcloud/services/batch/v20170312/batch_models.d.ts +25 -35
  12. package/tencentcloud/services/cfs/v20190719/cfs_models.d.ts +5 -5
  13. package/tencentcloud/services/ckafka/v20190819/ckafka_models.d.ts +12 -12
  14. package/tencentcloud/services/clb/v20180317/clb_models.d.ts +124 -15
  15. package/tencentcloud/services/cls/v20201016/cls_client.d.ts +4 -4
  16. package/tencentcloud/services/cls/v20201016/cls_client.js +4 -4
  17. package/tencentcloud/services/cls/v20201016/cls_models.d.ts +508 -166
  18. package/tencentcloud/services/dnspod/v20210323/dnspod_models.d.ts +5 -1
  19. package/tencentcloud/services/es/v20180416/es_models.d.ts +8 -0
  20. package/tencentcloud/services/ess/v20201111/ess_client.d.ts +3 -1
  21. package/tencentcloud/services/ess/v20201111/ess_client.js +3 -1
  22. package/tencentcloud/services/ess/v20201111/ess_models.d.ts +1 -1
  23. package/tencentcloud/services/essbasic/v20210526/essbasic_client.d.ts +3 -1
  24. package/tencentcloud/services/essbasic/v20210526/essbasic_client.js +3 -1
  25. package/tencentcloud/services/essbasic/v20210526/essbasic_models.d.ts +1 -1
  26. package/tencentcloud/services/iai/v20200303/iai_models.d.ts +6 -0
  27. package/tencentcloud/services/keewidb/v20220308/keewidb_models.d.ts +23 -23
  28. package/tencentcloud/services/lcic/v20220817/lcic_models.d.ts +23 -8
  29. package/tencentcloud/services/lighthouse/v20200324/lighthouse_client.d.ts +16 -1
  30. package/tencentcloud/services/lighthouse/v20200324/lighthouse_client.js +19 -0
  31. package/tencentcloud/services/lighthouse/v20200324/lighthouse_models.d.ts +197 -42
  32. package/tencentcloud/services/live/v20180801/live_models.d.ts +1 -5
  33. package/tencentcloud/services/lke/v20231130/lke_client.d.ts +1 -5
  34. package/tencentcloud/services/lke/v20231130/lke_client.js +0 -6
  35. package/tencentcloud/services/lke/v20231130/lke_models.d.ts +8 -38
  36. package/tencentcloud/services/mongodb/v20190725/mongodb_models.d.ts +2 -2
  37. package/tencentcloud/services/monitor/v20180724/monitor_models.d.ts +2 -2
  38. package/tencentcloud/services/mps/v20190612/mps_models.d.ts +18 -0
  39. package/tencentcloud/services/ocr/v20181119/ocr_models.d.ts +22 -8
  40. package/tencentcloud/services/organization/v20210331/organization_models.d.ts +19 -20
  41. package/tencentcloud/services/postgres/v20170312/postgres_client.d.ts +8 -26
  42. package/tencentcloud/services/postgres/v20170312/postgres_client.js +10 -34
  43. package/tencentcloud/services/postgres/v20170312/postgres_models.d.ts +75 -424
  44. package/tencentcloud/services/ssl/v20191205/ssl_models.d.ts +1 -1
  45. package/tencentcloud/services/sts/v20180813/sts_client.d.ts +21 -7
  46. package/tencentcloud/services/sts/v20180813/sts_client.js +21 -7
  47. package/tencentcloud/services/tcbr/v20220217/tcbr_models.d.ts +37 -0
  48. package/tencentcloud/services/tcss/v20201101/tcss_models.d.ts +12 -0
  49. package/tencentcloud/services/teo/v20220901/teo_models.d.ts +7 -7
  50. package/tencentcloud/services/tke/v20180525/tke_models.d.ts +5 -1
  51. package/tencentcloud/services/trabbit/v20230418/trabbit_models.d.ts +16 -0
  52. package/tencentcloud/services/trocket/v20230308/trocket_client.d.ts +11 -5
  53. package/tencentcloud/services/trocket/v20230308/trocket_client.js +14 -6
  54. package/tencentcloud/services/trocket/v20230308/trocket_models.d.ts +93 -0
  55. package/tencentcloud/services/trtc/v20190722/trtc_client.d.ts +13 -1
  56. package/tencentcloud/services/trtc/v20190722/trtc_client.js +18 -0
  57. package/tencentcloud/services/trtc/v20190722/trtc_models.d.ts +130 -1
  58. package/tencentcloud/services/tse/v20201207/tse_models.d.ts +8 -0
  59. package/tencentcloud/services/tsf/v20180326/tsf_client.d.ts +18 -18
  60. package/tencentcloud/services/tsf/v20180326/tsf_client.js +18 -18
  61. package/tencentcloud/services/tsf/v20180326/tsf_models.d.ts +815 -632
  62. package/tencentcloud/services/vod/v20180717/vod_client.d.ts +1 -0
  63. package/tencentcloud/services/vod/v20180717/vod_client.js +1 -0
  64. package/tencentcloud/services/vod/v20180717/vod_models.d.ts +24 -5
  65. package/tencentcloud/services/vpc/v20170312/vpc_client.d.ts +2 -2
  66. package/tencentcloud/services/vpc/v20170312/vpc_client.js +1 -1
  67. package/tencentcloud/services/vpc/v20170312/vpc_models.d.ts +6 -1
  68. package/tencentcloud/services/waf/v20180125/waf_client.d.ts +37 -9
  69. package/tencentcloud/services/waf/v20180125/waf_client.js +54 -12
  70. package/tencentcloud/services/waf/v20180125/waf_models.d.ts +349 -31
  71. package/tencentcloud/services/wedata/v20210820/wedata_models.d.ts +60 -0
  72. package/tencentcloud/services/wsa/v20250508/wsa_models.d.ts +14 -3
@@ -3,35 +3,39 @@
3
3
  */
4
4
  export interface DescribePublicConfigSummaryRequest {
5
5
  /**
6
- * 查询关键字,模糊查询:配置项名称,不传入时查询全量
6
+ * 查询关键字,模糊查询:配置项名称,不传入时查询全量。
7
7
  */
8
8
  SearchWord?: string;
9
9
  /**
10
- * 偏移量,默认为0
10
+ * 偏移量,默认为0
11
11
  */
12
12
  Offset?: number;
13
13
  /**
14
- * 每页条数,默认为20
14
+ * 返回数量,默认为20,最大值为50。
15
15
  */
16
16
  Limit?: number;
17
17
  /**
18
- * 按时间排序:creation_time;按名称排序:config_name
18
+ * 排序字段。
19
+ - creation_time:按时间排序
20
+ - config_name:按名称排序
19
21
  */
20
22
  OrderBy?: string;
21
23
  /**
22
- * 升序传 0,降序传 1
24
+ * 排序顺序。
25
+ - 0:升序
26
+ - 1:降序
23
27
  */
24
28
  OrderType?: number;
25
29
  /**
26
- *
30
+ * TAG标签资源值。
27
31
  */
28
32
  ConfigTagList?: Array<string>;
29
33
  /**
30
- *
34
+ * 忽略传参,业务预留字段。
31
35
  */
32
36
  DisableProgramAuthCheck?: boolean;
33
37
  /**
34
- *
38
+ * 配置ID。该参数可以通过调用 [DescribePublicConfigs](https://cloud.tencent.com/document/product/649/38335) 的返回值中的 ConfigId 字段来获取或通过登录[控制台](https://console.cloud.tencent.com/tse/tsf-consul?subTab=public)配置详情-配置版本页查看;也可以调用[CreatePublicConfig](https://cloud.tencent.com/document/product/649/38347)创建新的配置。
35
39
  */
36
40
  ConfigIdList?: Array<string>;
37
41
  }
@@ -271,7 +275,7 @@ export interface ClusterV2 {
271
275
  */
272
276
  ClusterDesc?: string;
273
277
  /**
274
- * 集群类型
278
+ * 集群类型,C表示容器集群,V表示虚拟机集群
275
279
  注意:此字段可能返回 null,表示取不到有效值。
276
280
  */
277
281
  ClusterType?: string;
@@ -331,12 +335,12 @@ export interface ClusterV2 {
331
335
  */
332
336
  DeleteFlag?: boolean;
333
337
  /**
334
- * 创建时间
338
+ * 创建时间,格式为​​YYYY-MM-DD HH:MM:SS
335
339
  注意:此字段可能返回 null,表示取不到有效值。
336
340
  */
337
341
  CreateTime?: string;
338
342
  /**
339
- * 更新时间
343
+ * 更新时间,格式为​​YYYY-MM-DD HH:MM:SS
340
344
  注意:此字段可能返回 null,表示取不到有效值。
341
345
  */
342
346
  UpdateTime?: string;
@@ -426,7 +430,7 @@ export interface ClusterV2 {
426
430
  */
427
431
  KuberneteApiServer?: string;
428
432
  /**
429
- * K : kubeconfig, S : service account
433
+ * K 表示通过kubeconfig 导入, S 表示通过service account导入
430
434
  注意:此字段可能返回 null,表示取不到有效值。
431
435
  */
432
436
  KuberneteNativeType?: string;
@@ -449,8 +453,7 @@ export interface ClusterV2 {
449
453
  */
450
454
  export interface ModifyApplicationResponse {
451
455
  /**
452
- * true:操作成功
453
- false:操作失败
456
+ * true表示修改成功,false表示修改失败
454
457
  */
455
458
  Result?: boolean;
456
459
  /**
@@ -478,7 +481,7 @@ export interface TsfPageLicenseTag {
478
481
  */
479
482
  export interface DescribeApiVersionsResponse {
480
483
  /**
481
- * API版本列表
484
+ * API版本列表。
482
485
  */
483
486
  Result?: Array<ApiVersionArray>;
484
487
  /**
@@ -527,7 +530,7 @@ export interface StopContainerGroupResponse {
527
530
  */
528
531
  export interface CreateConfigTemplateWithDetailRespResponse {
529
532
  /**
530
- * 创建成功,返回 ID
533
+ * 创建成功,返回配置模板ID
531
534
  */
532
535
  Result?: ConfigTemplate;
533
536
  /**
@@ -549,7 +552,9 @@ export interface DeletePathRewritesRequest {
549
552
  */
550
553
  export interface DeleteLaneResponse {
551
554
  /**
552
- * 删除成功: true / 删除失败: false
555
+ * 删除结果。
556
+ - true:删除成功
557
+ - false:删除失败
553
558
  */
554
559
  Result?: boolean;
555
560
  /**
@@ -562,7 +567,7 @@ export interface DeleteLaneResponse {
562
567
  */
563
568
  export interface DescribeGroupReleaseRequest {
564
569
  /**
565
- * 部署组ID
570
+ * 部署组ID。该参数可以通过调用 [DescribeSimpleGroups](https://cloud.tencent.com/document/product/649/36064) 的返回值中的 GroupId 字段来获取或通过登录[控制台](https://console.cloud.tencent.com/tsf/resource)-查看部署组页查看;也可以调用[CreateGroup](https://cloud.tencent.com/document/product/649/36074)创建新的部署组。
566
571
  */
567
572
  GroupId: string;
568
573
  }
@@ -571,7 +576,7 @@ export interface DescribeGroupReleaseRequest {
571
576
  */
572
577
  export interface DescribeConfigTemplateResponse {
573
578
  /**
574
- * 导入结果
579
+ * 导入结果。
575
580
  */
576
581
  Result?: ConfigTemplate;
577
582
  /**
@@ -693,7 +698,7 @@ export interface SimpleApplication {
693
698
  */
694
699
  export interface ContinueRunFailedTaskBatchRequest {
695
700
  /**
696
- * 批次ID。
701
+ * 任务批次ID。在[任务管理](https://console.cloud.tencent.com/tsf/tct?rid=1)页面点击任务ID进入执行记录页,第一列即为任务批次ID,在[任务执行记录](https://console.cloud.tencent.com/tsf/tct?rid=1&tab=task)页能查看所有任务批次ID
697
702
  */
698
703
  BatchId: string;
699
704
  }
@@ -806,7 +811,7 @@ export interface DescribeSimpleGroupsResponse {
806
811
  */
807
812
  export interface DescribeConfigsResponse {
808
813
  /**
809
- * 分页后的配置项列表
814
+ * 分页后的配置项列表。
810
815
  */
811
816
  Result?: TsfPageConfig;
812
817
  /**
@@ -819,7 +824,7 @@ export interface DescribeConfigsResponse {
819
824
  */
820
825
  export interface ModifyContainerReplicasRequest {
821
826
  /**
822
- * 部署组ID,部署组唯一标识
827
+ * 部署组ID,部署组唯一标识,调用[DescribeClusters](https://console.cloud.tencent.com/tsf/resource?rid=1&tab=docker)接口,选定一个容器集群,选择部署组,查看DescribeSingleContainerGroups接口返回的GroupId
823
828
  */
824
829
  GroupId: string;
825
830
  /**
@@ -832,15 +837,15 @@ export interface ModifyContainerReplicasRequest {
832
837
  */
833
838
  export interface ReleaseFileConfigRequest {
834
839
  /**
835
- * 配置ID
840
+ * 配置ID。该参数可以通过调用 [DescribeFileConfigs](https://cloud.tencent.com/document/product/649/58593) 的返回值中的 ConfigId 字段来获取或通过登录[控制台](https://console.cloud.tencent.com/tse/tsf-consul?rid=1&subTab=file)配置详情-配置版本页查看;也可以调用[CreateFileConfig](https://cloud.tencent.com/document/product/649/58594)创建新的配置。
836
841
  */
837
842
  ConfigId: string;
838
843
  /**
839
- * 部署组ID
844
+ * 部署组ID。该参数可以通过调用 [DescribeSimpleGroups](https://cloud.tencent.com/document/product/649/36064) 的返回值中的 GroupId 字段来获取或通过登录[控制台](https://console.cloud.tencent.com/tsf/resource)-查看部署组页查看;也可以调用[CreateGroup](https://cloud.tencent.com/document/product/649/36074)创建新的部署组。
840
845
  */
841
846
  GroupId: string;
842
847
  /**
843
- * 发布描述
848
+ * 发布描述,最多支持200个字符。
844
849
  */
845
850
  ReleaseDesc?: string;
846
851
  }
@@ -901,7 +906,7 @@ export interface CreateGatewayApiResponse {
901
906
  */
902
907
  export interface DescribeFileConfigsResponse {
903
908
  /**
904
- * 文件配置项列表
909
+ * 文件配置项列表。
905
910
  */
906
911
  Result?: TsfPageFileConfig;
907
912
  /**
@@ -914,27 +919,27 @@ export interface DescribeFileConfigsResponse {
914
919
  */
915
920
  export interface DescribeClustersRequest {
916
921
  /**
917
- * 搜索词
922
+ * 搜索词,可以搜索ID/名称/备注/标签
918
923
  */
919
924
  SearchWord?: string;
920
925
  /**
921
- * 排序字段
926
+ * 排序字段,例如创建时间
922
927
  */
923
928
  OrderBy?: string;
924
929
  /**
925
- * 排序方式
930
+ * 排序方式,0表示升序,1表示倒序
926
931
  */
927
932
  OrderType?: number;
928
933
  /**
929
- * 偏移量
934
+ * 偏移量,默认0
930
935
  */
931
936
  Offset?: number;
932
937
  /**
933
- * 分页个数
938
+ * 分页个数,0-50 之间,默认20
934
939
  */
935
940
  Limit?: number;
936
941
  /**
937
- * 集群类型
942
+ * 集群类型,C表示容器集群,V表示虚拟机集群
938
943
  */
939
944
  ClusterType?: string;
940
945
  /**
@@ -947,15 +952,22 @@ export interface DescribeClustersRequest {
947
952
  */
948
953
  export interface DescribeApiVersionsRequest {
949
954
  /**
950
- * 微服务ID
955
+ * 微服务ID。该参数可以通过调用 [DescribeMicroservices](https://cloud.tencent.com/document/product/649/36084) 的返回值中的 MicroserviceId 字段来获取或通过登录[控制台](https://console.cloud.tencent.com/tse/tsf-consul?tab=service)查看;也可以调用[CreateMicroserviceWithDetailResp](https://cloud.tencent.com/document/product/649/85860)创建新的微服务。
951
956
  */
952
957
  MicroserviceId: string;
953
958
  /**
954
- * API 请求路径
959
+ * API请求路径。
955
960
  */
956
961
  Path?: string;
957
962
  /**
958
- * 请求方法
963
+ * API请求方法。
964
+ - GET
965
+ - POST
966
+ - PUT
967
+ - DELETE
968
+ - HEAD
969
+ - PATCH
970
+ - OPTIONS
959
971
  */
960
972
  Method?: string;
961
973
  }
@@ -990,11 +1002,13 @@ export interface DescribeGroupBindedGatewaysResponse {
990
1002
  */
991
1003
  export interface DescribeJvmMonitorRequest {
992
1004
  /**
993
- * 查询的实例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
994
1007
  */
995
1008
  InstanceId: string;
996
1009
  /**
997
- * 实例所属应用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
998
1012
  */
999
1013
  ApplicationId: string;
1000
1014
  /**
@@ -1010,7 +1024,8 @@ export interface DescribeJvmMonitorRequest {
1010
1024
  */
1011
1025
  To: string;
1012
1026
  /**
1013
- * 查询的监控图列表,以返回值属性名作为入参
1027
+ * 查询的监控图列表,以返回值属性名作为入参,可选值:
1028
+ heapMemory:堆内存监控图;nonHeapMemory:非堆内存监控图;edenSpace:伊甸区监控图;survivorSpace:幸存者区监控图;oldSpace:老年代监控图;metaSpace:元空间监控图;youngGC:youngGC增量监控图;fullGC:fullGC增量监控图;cpuUsage:cpu使用率监控图;classCount:加载类数监控图;threadPicture:线程图
1014
1029
  */
1015
1030
  RequiredPictures: Array<string>;
1016
1031
  /**
@@ -1023,7 +1038,7 @@ export interface DescribeJvmMonitorRequest {
1023
1038
  */
1024
1039
  export interface EnableLaneRuleRequest {
1025
1040
  /**
1026
- * 泳道规则ID
1041
+ * 灰度发布规则ID。该参数可以通过调用 [DescribeLaneRules](https://cloud.tencent.com/document/product/649/44505) 的返回值中的 RuleId 字段来获取或通过登录[控制台](https://console.cloud.tencent.com/tse/tsf-consul?tab=grayscale&subTab=lanerule)查看;也可以调用[CreateLaneRule](https://cloud.tencent.com/document/product/649/44507)创建新的灰度发布规则。
1027
1042
  */
1028
1043
  RuleId: string;
1029
1044
  }
@@ -1032,7 +1047,7 @@ export interface EnableLaneRuleRequest {
1032
1047
  */
1033
1048
  export interface TaskRule {
1034
1049
  /**
1035
- * 触发规则类型, Cron/Repeat
1050
+ * 触发规则类型,枚举值。一共3个值,Cron:定时触发,Repeat:周期触发,WorkFlow:工作流触发
1036
1051
  */
1037
1052
  RuleType: string;
1038
1053
  /**
@@ -1067,7 +1082,7 @@ export interface TaskRecord {
1067
1082
  */
1068
1083
  TaskType?: string;
1069
1084
  /**
1070
- * 执行类型
1085
+ * 任务执行方式,unicast:随机单节点执行,broadcast:广播执行,shard:分片执行
1071
1086
  */
1072
1087
  ExecuteType?: string;
1073
1088
  /**
@@ -1079,7 +1094,7 @@ export interface TaskRecord {
1079
1094
  */
1080
1095
  GroupId?: string;
1081
1096
  /**
1082
- * 超时时间
1097
+ * 超时时间,单位:毫秒。
1083
1098
  */
1084
1099
  TimeOut?: number;
1085
1100
  /**
@@ -1087,7 +1102,7 @@ export interface TaskRecord {
1087
1102
  */
1088
1103
  RetryCount?: number;
1089
1104
  /**
1090
- * 重试间隔
1105
+ * 重试间隔,单位:毫秒。
1091
1106
  */
1092
1107
  RetryInterval?: number;
1093
1108
  /**
@@ -1095,7 +1110,7 @@ export interface TaskRecord {
1095
1110
  */
1096
1111
  TaskRule?: TaskRule;
1097
1112
  /**
1098
- * 是否启用任务,ENABLED/DISABLED
1113
+ * 任务启用状态。一共2种状态可选,ENABLED:启用,DISABLED:停用
1099
1114
  */
1100
1115
  TaskState?: string;
1101
1116
  /**
@@ -1131,7 +1146,7 @@ export interface TaskRecord {
1131
1146
  */
1132
1147
  TaskLogId?: string;
1133
1148
  /**
1134
- * 触发类型
1149
+ * 触发类型,一共3种类型,WorkFlow:工作流触发,Cron:定时触发,FixRate:周期触发
1135
1150
  */
1136
1151
  TriggerType?: string;
1137
1152
  /**
@@ -1157,11 +1172,11 @@ export interface CreateNamespaceResponse {
1157
1172
  */
1158
1173
  export interface RedoTaskBatchRequest {
1159
1174
  /**
1160
- * 任务ID
1175
+ * 任务ID。在[任务管理](https://console.cloud.tencent.com/tsf/tct?rid=1)列表页查看任务ID。
1161
1176
  */
1162
1177
  TaskId: string;
1163
1178
  /**
1164
- * 批次ID
1179
+ * 任务批次ID。在[任务管理](https://console.cloud.tencent.com/tsf/tct?rid=1)页面点击任务ID进入任务详情,进入执行记录列表页,第一列即为任务批次ID。
1165
1180
  */
1166
1181
  BatchId: string;
1167
1182
  }
@@ -1170,7 +1185,7 @@ export interface RedoTaskBatchRequest {
1170
1185
  */
1171
1186
  export interface DescribeTaskLastStatusRequest {
1172
1187
  /**
1173
- * 任务ID
1188
+ * 任务ID。在[任务管理](https://console.cloud.tencent.com/tsf/tct?rid=1)列表页第一列和任务基本信息页查看任务ID。
1174
1189
  */
1175
1190
  TaskId: string;
1176
1191
  }
@@ -1188,7 +1203,9 @@ export interface ModifyUploadInfoResponse {
1188
1203
  */
1189
1204
  export interface EnableLaneRuleResponse {
1190
1205
  /**
1191
- * 操作状态。成功:true,失败:false
1206
+ * 操作状态。
1207
+ - true:成功
1208
+ - false:失败
1192
1209
  */
1193
1210
  Result?: boolean;
1194
1211
  /**
@@ -1248,7 +1265,9 @@ export interface CreateApiRateLimitRuleRequest {
1248
1265
  */
1249
1266
  export interface DisableLaneRuleResponse {
1250
1267
  /**
1251
- * 操作状态。成功:true,失败:false
1268
+ * 操作状态。
1269
+ - true:成功
1270
+ - false:失败
1252
1271
  */
1253
1272
  Result?: boolean;
1254
1273
  /**
@@ -1274,11 +1293,13 @@ export interface TaskRecordPage {
1274
1293
  */
1275
1294
  export interface AssociateBusinessLogConfigRequest {
1276
1295
  /**
1277
- * 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)进行查看
1278
1298
  */
1279
1299
  GroupId: string;
1280
1300
  /**
1281
1301
  * 日志配置项ID列表
1302
+ 可通过调用[DescribeBusinessLogConfigs](https://cloud.tencent.com/document/product/649/75777)查询已创建的日志配置项列表或登录[控制台](https://console.cloud.tencent.com/tsf/observable/log?rid=1)进行查看
1282
1303
  */
1283
1304
  ConfigIdList?: Array<string>;
1284
1305
  }
@@ -1300,7 +1321,8 @@ export interface DescribeJvmMonitorResponse {
1300
1321
  */
1301
1322
  export interface DescribeDeliveryConfigRequest {
1302
1323
  /**
1303
- * 投递配置id
1324
+ * 日志配置项ID
1325
+ 可通过调用[DescribeBusinessLogConfigs](https://cloud.tencent.com/document/product/649/75777)查询已创建的日志配置项列表或登录[控制台](https://console.cloud.tencent.com/tsf/observable/log?rid=1)进行查看
1304
1326
  */
1305
1327
  ConfigId: string;
1306
1328
  }
@@ -1331,7 +1353,7 @@ export interface ChangeApiUsableStatusRequest {
1331
1353
  */
1332
1354
  export interface DescribeMicroservicesResponse {
1333
1355
  /**
1334
- * 微服务分页列表信息
1356
+ * 微服务分页列表信息。
1335
1357
  */
1336
1358
  Result?: TsfPageMicroservice;
1337
1359
  /**
@@ -1366,7 +1388,7 @@ export interface DescribeApiGroupsResponse {
1366
1388
  */
1367
1389
  export interface DeletePublicConfigRequest {
1368
1390
  /**
1369
- * 配置项ID
1391
+ * 配置ID。该参数可以通过调用 [DescribePublicConfigs](https://cloud.tencent.com/document/product/649/38335) 的返回值中的 ConfigId 字段来获取或通过登录[控制台](https://console.cloud.tencent.com/tse/tsf-consul?subTab=public)配置详情-配置版本页查看;也可以调用[CreatePublicConfig](https://cloud.tencent.com/document/product/649/38347)创建新的配置。
1370
1392
  */
1371
1393
  ConfigId: string;
1372
1394
  }
@@ -1390,15 +1412,15 @@ export interface DeleteNamespaceResponse {
1390
1412
  */
1391
1413
  export interface CreateMicroserviceRequest {
1392
1414
  /**
1393
- * 命名空间ID
1415
+ * 命名空间ID。该参数可以通过调用 [DescribeSimpleNamespaces](https://cloud.tencent.com/document/api/649/36096) 的返回值中的 NamespaceId 字段来获取或通过登录[控制台](https://console.cloud.tencent.com/tsf/resource?tab=namespace)查看;也可以调用[CreateNamespace](https://cloud.tencent.com/document/product/649/36098)创建新的命名空间。
1394
1416
  */
1395
1417
  NamespaceId: string;
1396
1418
  /**
1397
- * 微服务名称
1419
+ * 微服务名称。该参数可以通过调用 [DescribeMicroservices](https://cloud.tencent.com/document/product/649/36084) 的返回值中的 MicroserviceName 字段来获取或通过登录[控制台](https://console.cloud.tencent.com/tse/tsf-consul?tab=service)查看;也可以调用[CreateMicroserviceWithDetailResp](https://cloud.tencent.com/document/product/649/85860)创建新的微服务。
1398
1420
  */
1399
1421
  MicroserviceName: string;
1400
1422
  /**
1401
- * 微服务描述信息
1423
+ * 微服务备注信息,最多支持200个字符。
1402
1424
  */
1403
1425
  MicroserviceDesc?: string;
1404
1426
  }
@@ -1407,7 +1429,9 @@ export interface CreateMicroserviceRequest {
1407
1429
  */
1408
1430
  export interface ReleaseConfigResponse {
1409
1431
  /**
1410
- * true:发布成功;false:发布失败
1432
+ * 发布结果。
1433
+ - true:发布成功
1434
+ - false:发布失败
1411
1435
  */
1412
1436
  Result?: boolean;
1413
1437
  /**
@@ -1433,7 +1457,7 @@ export interface DescribeUnitRuleResponse {
1433
1457
  */
1434
1458
  export interface DeleteImageTagsRequest {
1435
1459
  /**
1436
- * 镜像版本数组
1460
+ * 需要删除的镜像版本列表,可通过调用[DescribeImageTags](https://cloud.tencent.com/document/api/649/36052)查询已创建的镜像版本列表或登录控制台进行查看。
1437
1461
  */
1438
1462
  ImageTags: Array<DeleteImageTag>;
1439
1463
  /**
@@ -1450,15 +1474,15 @@ export interface DescribeRepositoriesRequest {
1450
1474
  */
1451
1475
  SearchWord?: string;
1452
1476
  /**
1453
- * 查询起始偏移
1477
+ * 查询起始偏移,大于等于0,默认值为0
1454
1478
  */
1455
1479
  Offset?: number;
1456
1480
  /**
1457
- * 返回数量限制
1481
+ * 返回数量限制,大于0,默认为不分页
1458
1482
  */
1459
1483
  Limit?: number;
1460
1484
  /**
1461
- * 仓库类型(默认仓库:default,私有仓库:private)
1485
+ * 仓库类型(默认仓库:default,私有仓库:private,公共仓库:public-demo
1462
1486
  */
1463
1487
  RepositoryType?: string;
1464
1488
  }
@@ -1488,11 +1512,11 @@ export interface InvocationMetricScatterPlot {
1488
1512
  */
1489
1513
  export interface RollbackConfigRequest {
1490
1514
  /**
1491
- * 配置项发布历史ID
1515
+ * 配置项发布历史ID。该参数可以通过调用 [DescribeConfigReleaseLogs](https://cloud.tencent.com/document/product/649/38343) 的返回值中的 ConfigReleaseLogId 字段来获取或通过登录[控制台](https://console.cloud.tencent.com/tse/tsf-consul?subTab=app)配置详情-发布情况页查看。
1492
1516
  */
1493
1517
  ConfigReleaseLogId: string;
1494
1518
  /**
1495
- * 回滚描述
1519
+ * 回滚描述,最多支持200个字符。
1496
1520
  */
1497
1521
  ReleaseDesc?: string;
1498
1522
  }
@@ -1501,7 +1525,7 @@ export interface RollbackConfigRequest {
1501
1525
  */
1502
1526
  export interface DisassociateBusinessLogConfigResponse {
1503
1527
  /**
1504
- * 操作结果
1528
+ * 操作结果,true:成功,false:失败。
1505
1529
  */
1506
1530
  Result?: boolean;
1507
1531
  /**
@@ -1531,7 +1555,9 @@ export interface CreateGatewayApiRequest {
1531
1555
  */
1532
1556
  export interface DescribeCreateGatewayApiStatusResponse {
1533
1557
  /**
1534
- * 是否已完成导入任务
1558
+ * 导入任务状态执行结果。
1559
+ - true:已完成
1560
+ - false:未完成
1535
1561
  */
1536
1562
  Result?: boolean;
1537
1563
  /**
@@ -1544,7 +1570,9 @@ export interface DescribeCreateGatewayApiStatusResponse {
1544
1570
  */
1545
1571
  export interface DeleteConfigResponse {
1546
1572
  /**
1547
- * true:删除成功;false:删除失败
1573
+ * 删除结果。
1574
+ - true:删除成功
1575
+ - false:删除失败
1548
1576
  */
1549
1577
  Result?: boolean;
1550
1578
  /**
@@ -1873,31 +1901,33 @@ export interface ModifyNamespaceResponse {
1873
1901
  */
1874
1902
  export interface ModifyLaneRuleRequest {
1875
1903
  /**
1876
- * 泳道规则ID
1904
+ * 灰度发布规则ID。该参数可以通过调用 [DescribeLaneRules](https://cloud.tencent.com/document/product/649/44505) 的返回值中的 RuleId 字段来获取或通过登录[控制台](https://console.cloud.tencent.com/tse/tsf-consul?tab=grayscale&subTab=lanerule)查看;也可以调用[CreateLaneRule](https://cloud.tencent.com/document/product/649/44507)创建新的灰度发布规则。
1877
1905
  */
1878
1906
  RuleId: string;
1879
1907
  /**
1880
- * 泳道规则名称
1908
+ * 灰度发布规则名称,最多支持60个字符,支持中英文字符。
1881
1909
  */
1882
1910
  RuleName: string;
1883
1911
  /**
1884
- * 泳道规则备注
1912
+ * 灰度发布规则备注,最多支持200个字符。
1885
1913
  */
1886
1914
  Remark: string;
1887
1915
  /**
1888
- * 泳道规则标签列表
1916
+ * 灰度发布规则标签列表。
1889
1917
  */
1890
1918
  RuleTagList: Array<LaneRuleTag>;
1891
1919
  /**
1892
- * 泳道规则标签关系
1920
+ * 灰度发布规则标签关系。- RELEATION_AND:与- RELEATION_OR:或
1893
1921
  */
1894
1922
  RuleTagRelationship: string;
1895
1923
  /**
1896
- * 泳道ID
1924
+ * 泳道配置ID。该参数可以通过调用 [DescribeLanes](https://cloud.tencent.com/document/product/649/44504) 的返回值中的 LaneId 字段来获取或通过登录[控制台](https://console.cloud.tencent.com/tse/tsf-consul?tab=grayscale&subTab=lane)查看;也可以调用[CreateLane](https://cloud.tencent.com/document/product/649/44508)创建新的泳道配置。
1897
1925
  */
1898
1926
  LaneId: string;
1899
1927
  /**
1900
- * 开启状态
1928
+ * 开启状态。
1929
+ - true:开启
1930
+ - false:关闭
1901
1931
  */
1902
1932
  Enable: boolean;
1903
1933
  }
@@ -1932,7 +1962,7 @@ export interface DescribeResourceConfigResponse {
1932
1962
  */
1933
1963
  export interface StartContainerGroupRequest {
1934
1964
  /**
1935
- * 部署组ID
1965
+ * 部署组ID,可通过调用[DescribeContainerGroups](https://cloud.tencent.com/document/api/649/36068)查询已创建的部署组列表或登录控制台进行查看;也可以调用[CreateContainGroup](https://cloud.tencent.com/document/api/649/36075)创建新的部署组。
1936
1966
  */
1937
1967
  GroupId: string;
1938
1968
  }
@@ -1954,7 +1984,7 @@ export interface DescribeRepositoryResponse {
1954
1984
  */
1955
1985
  export interface ReleaseConfigWithDetailRespResponse {
1956
1986
  /**
1957
- * 配置项发布 ID
1987
+ * 配置项发布ID
1958
1988
  */
1959
1989
  Result?: ConfigRelease;
1960
1990
  /**
@@ -2167,7 +2197,7 @@ export interface Instance {
2167
2197
  */
2168
2198
  export interface UpdateHealthCheckSettingsRequest {
2169
2199
  /**
2170
- * 部署组ID
2200
+ * 部署组ID,可通过调用[DescribeContainerGroups](https://cloud.tencent.com/document/api/649/36068)查询已创建的部署组列表或登录控制台进行查看;也可以调用[CreateContainGroup](https://cloud.tencent.com/document/api/649/36075)创建新的部署组。
2171
2201
  */
2172
2202
  GroupId: string;
2173
2203
  /**
@@ -2251,7 +2281,7 @@ export declare type DescribeResourceConfigRequest = null;
2251
2281
  */
2252
2282
  export interface CreateMicroserviceResponse {
2253
2283
  /**
2254
- * 新增微服务是否成功。
2284
+ * 新增结果。
2255
2285
  true:操作成功。
2256
2286
  false:操作失败。
2257
2287
  */
@@ -2266,39 +2296,39 @@ export interface CreateMicroserviceResponse {
2266
2296
  */
2267
2297
  export interface CreateFileConfigWithDetailRespRequest {
2268
2298
  /**
2269
- * 配置项名称
2299
+ * 配置名称,最多支持60个字符,只能包含字母、数字及分隔符(“-”、“_”),且不能以分隔符开头或结尾。
2270
2300
  */
2271
2301
  ConfigName: string;
2272
2302
  /**
2273
- * 配置项版本
2303
+ * 配置项版本,只能包含小写字母、数字及分隔符("-","."),且必须以小写字母或数字开头、以小写字母或数字结尾,中间不能有连续的"-"或"."。
2274
2304
  */
2275
2305
  ConfigVersion: string;
2276
2306
  /**
2277
- * 配置项文件名
2307
+ * 配置项文件名,不超过60个字符,只能包含英文、数字、"-"(英文)、"_"(英文)、"."(英文)。
2278
2308
  */
2279
2309
  ConfigFileName: string;
2280
2310
  /**
2281
- * 配置项文件内容(原始内容编码需要 utf-8 格式,如果 ConfigFileCode 为 gbk,后台会进行转换)
2311
+ * 配置项文件内容(原始内容编码需要 utf-8 格式,如果 ConfigFileCode 为 gbk,后台会进行转换)。
2282
2312
  */
2283
2313
  ConfigFileValue: string;
2284
2314
  /**
2285
- * 配置项关联应用ID
2315
+ * 配置项关联应用ID。该参数可以通过调用 [DescribeApplications](https://cloud.tencent.com/document/product/649/36090) 的返回值中的 ApplicationId 字段来获取或通过登录[控制台](https://console.cloud.tencent.com/tsf/app)查看;也可以调用[CreateApplication](https://cloud.tencent.com/document/product/649/36094)创建新的应用。
2286
2316
  */
2287
2317
  ApplicationId: string;
2288
2318
  /**
2289
- * 发布路径
2319
+ * 发布路径。
2290
2320
  */
2291
2321
  ConfigFilePath: string;
2292
2322
  /**
2293
- * 配置项版本描述
2323
+ * 配置项版本描述,最多支持200个字符。
2294
2324
  */
2295
2325
  ConfigVersionDesc?: string;
2296
2326
  /**
2297
- * 配置项文件编码,utf-8 或 gbk。注:如果选择 gbk,需要新版本 tsf-consul-template (公有云虚拟机需要使用 1.32 tsf-agent,容器需要从文档中获取最新的 tsf-consul-template-docker.tar.gz)的支持
2327
+ * 配置项文件编码,utf-8 或 gbk。注:如果选择 gbk,需要新版本 tsf-consul-template (公有云虚拟机需要使用 1.32 tsf-agent,容器需要从文档中获取最新的 tsf-consul-template-docker.tar.gz)的支持。
2298
2328
  */
2299
2329
  ConfigFileCode?: string;
2300
2330
  /**
2301
- * 后置命令
2331
+ * 后置命令。
2302
2332
  */
2303
2333
  ConfigPostCmd?: string;
2304
2334
  /**
@@ -2306,7 +2336,7 @@ export interface CreateFileConfigWithDetailRespRequest {
2306
2336
  */
2307
2337
  EncodeWithBase64?: boolean;
2308
2338
  /**
2309
- *
2339
+ * 需要绑定的数据集ID。该参数可以通过调用 [DescribePrograms](https://cloud.tencent.com/document/product/649/73477) 的返回值中的 ProgramId 字段来获取或通过登录[控制台](https://console.cloud.tencent.com/tsf/privilege?tab=program&roleId=role-yrle4doy)查看;也可以调用[CreateProgram](https://cloud.tencent.com/document/product/649/108544)创建新的数据集。
2310
2340
  */
2311
2341
  ProgramIdList?: Array<string>;
2312
2342
  }
@@ -2389,7 +2419,7 @@ export interface CosUploadInfo {
2389
2419
  */
2390
2420
  export interface DescribeLanesResponse {
2391
2421
  /**
2392
- * 泳道列表
2422
+ * 泳道配置列表。
2393
2423
  */
2394
2424
  Result?: LaneInfos;
2395
2425
  /**
@@ -2415,7 +2445,7 @@ export interface CreateNamespaceRequest {
2415
2445
  */
2416
2446
  NamespaceName: string;
2417
2447
  /**
2418
- * 集群ID
2448
+ * 集群ID,按照【集群ID】进行过滤,可通过调用[DescribeClusters](https://cloud.tencent.com/document/product/649/85857)查询已创建的集群列表或登录控制台进行查看;也可以调用[CreateCluster](https://cloud.tencent.com/document/product/649/36049)创建新的集群。仅在集群下无部署组、命名空间、云主机时可以删除。
2419
2449
  */
2420
2450
  ClusterId?: string;
2421
2451
  /**
@@ -2423,7 +2453,7 @@ export interface CreateNamespaceRequest {
2423
2453
  */
2424
2454
  NamespaceDesc?: string;
2425
2455
  /**
2426
- * 命名空间资源类型(默认值为DEF)
2456
+ * 命名空间资源类型(默认值为DEF)。DEF:默认普通命名空间。GLOBAL:全局命名空间
2427
2457
  */
2428
2458
  NamespaceResourceType?: string;
2429
2459
  /**
@@ -2431,7 +2461,7 @@ export interface CreateNamespaceRequest {
2431
2461
  */
2432
2462
  NamespaceType?: string;
2433
2463
  /**
2434
- * 命名空间ID
2464
+ * 命名空间ID,按照【命名空间ID】进行过滤,可通过调用[DescribeNamespaces](https://cloud.tencent.com/document/product/649/36096)查询已创建的命名空间列表或登录控制台进行查看;也可以调用[CreateNamespace](https://cloud.tencent.com/document/product/649/36098)创建新命名空间。
2435
2465
  */
2436
2466
  NamespaceId?: string;
2437
2467
  /**
@@ -2439,32 +2469,36 @@ export interface CreateNamespaceRequest {
2439
2469
  */
2440
2470
  IsHaEnable?: string;
2441
2471
  /**
2442
- * 需要绑定的数据集ID
2472
+ * 需要绑定的数据集ID,可通过调用[DescribePrograms](https://cloud.tencent.com/document/api/649/73477)查询已创建的数据集列表或登录控制台进行查看;也可以调用[CreateProgram](https://cloud.tencent.com/document/api/649/108544)创建新的数据集。
2443
2473
  */
2444
2474
  ProgramId?: string;
2445
2475
  /**
2446
- * 需要绑定的数据集ID
2476
+ * 需要绑定的数据集ID列表,可通过调用[DescribePrograms](https://cloud.tencent.com/document/api/649/73477)查询已创建的数据集列表或登录控制台进行查看;也可以调用[CreateProgram](https://cloud.tencent.com/document/api/649/108544)创建新的数据集。
2447
2477
  */
2448
2478
  ProgramIdList?: Array<string>;
2479
+ /**
2480
+ * 是否创建k8s命名空间标识
2481
+ */
2482
+ CreateK8sNamespaceFlag?: boolean;
2449
2483
  }
2450
2484
  /**
2451
2485
  * DescribeDownloadInfo请求参数结构体
2452
2486
  */
2453
2487
  export interface DescribeDownloadInfoRequest {
2454
2488
  /**
2455
- * 应用ID
2489
+ * 应用ID,通过调用DescribeApplications接口[获取应用列表](https://cloud.tencent.com/document/api/649/36090)从而获取应用ID,或登录[控制台](https://console.cloud.tencent.com/tsf/app?rid=1)进行查看,调用CreateApplication接口[创建应用](https://cloud.tencent.com/document/product/649/36094)时的返回值
2456
2490
  */
2457
2491
  ApplicationId: string;
2458
2492
  /**
2459
- * 程序包ID
2493
+ * 软件包ID可通过调用DescribeUploadInfo接口时[获取上传程序包信息](https://cloud.tencent.com/document/api/649/36078)返回的COS上传信息获取,登录[控制台](https://console.cloud.tencent.com/tsf/product?rid=1)进行查看
2460
2494
  */
2461
2495
  PkgId: string;
2462
2496
  /**
2463
- * 程序包仓库ID
2497
+ * 仓库ID,可通过调用[仓库信息查询类](https://cloud.tencent.com/document/api/649/45925)接口时出参中的RepositoryId,或登录[控制台](https://console.cloud.tencent.com/tsf/product?rid=1)进行查看
2464
2498
  */
2465
2499
  RepositoryId?: string;
2466
2500
  /**
2467
- * 程序包仓库类型
2501
+ * 程序包仓库类型(允许值:"public-demo"TSF公共demo仓库, "private"自定义仓库, "default"TSF公共仓库)
2468
2502
  */
2469
2503
  RepositoryType?: string;
2470
2504
  }
@@ -2488,7 +2522,7 @@ export interface ContainerGroupObservabilityConfig {
2488
2522
  */
2489
2523
  export interface DescribeClusterInstancesRequest {
2490
2524
  /**
2491
- * 集群ID
2525
+ * 集群 ID。调用[DescribeSimpleClusters](https://cloud.tencent.com/document/api/649/36047)查询已创建的集群或通过[CreateCluster](https://cloud.tencent.com/document/api/649/36049)接口创建新的集群。
2492
2526
  */
2493
2527
  ClusterId: string;
2494
2528
  /**
@@ -2500,15 +2534,15 @@ export interface DescribeClusterInstancesRequest {
2500
2534
  */
2501
2535
  OrderBy?: string;
2502
2536
  /**
2503
- * 排序类型
2537
+ * 排序类型;0:升序,1:降序。
2504
2538
  */
2505
2539
  OrderType?: number;
2506
2540
  /**
2507
- * 偏移量
2541
+ * 偏移量,默认值:0。
2508
2542
  */
2509
2543
  Offset?: number;
2510
2544
  /**
2511
- * 分页个数
2545
+ * 分页个数,默认值:20。
2512
2546
  */
2513
2547
  Limit?: number;
2514
2548
  }
@@ -2538,7 +2572,7 @@ export interface DescribeGroupBindedGatewaysRequest {
2538
2572
  */
2539
2573
  export interface DescribeRepositoryRequest {
2540
2574
  /**
2541
- * 仓库ID
2575
+ * 仓库ID,可通过调用[仓库信息查询类](https://cloud.tencent.com/document/api/649/45925)接口时出参中的RepositoryId,或登录[控制台](https://console.cloud.tencent.com/tsf/product?rid=1)进行查看
2542
2576
  */
2543
2577
  RepositoryId: string;
2544
2578
  }
@@ -2547,31 +2581,33 @@ export interface DescribeRepositoryRequest {
2547
2581
  */
2548
2582
  export interface CreatePublicConfigWithDetailRespRequest {
2549
2583
  /**
2550
- * 配置项名称
2584
+ * 配置项名称,最多支持60个字符,只能包含字母、数字及分隔符(“-”、“_”),且不能以分隔符开头或结尾。
2551
2585
  */
2552
2586
  ConfigName: string;
2553
2587
  /**
2554
- * 配置项版本
2588
+ * 配置项版本,最多支持60个字符,只能包含小写字母、数字及分隔符("-","."),且必须以小写字母或数字开头、以小写字母或数字结尾,中间不能有连续的"-"或"."。
2555
2589
  */
2556
2590
  ConfigVersion: string;
2557
2591
  /**
2558
- * 配置项值,总是接收yaml格式的内容
2592
+ * 配置项值,总是接收yaml格式的内容。
2559
2593
  */
2560
2594
  ConfigValue: string;
2561
2595
  /**
2562
- * 配置项版本描述
2596
+ * 配置项版本描述,最多支持200个字符。
2563
2597
  */
2564
2598
  ConfigVersionDesc?: string;
2565
2599
  /**
2566
- * 配置项类型
2600
+ * 配置项类型,固定值。
2567
2601
  */
2568
2602
  ConfigType?: string;
2569
2603
  /**
2570
- * Base64编码的配置项
2604
+ * Base64编码的配置项。
2605
+ - true:开启
2606
+ - false:关闭
2571
2607
  */
2572
2608
  EncodeWithBase64?: boolean;
2573
2609
  /**
2574
- *
2610
+ * 需要绑定的数据集ID。该参数可以通过调用 [DescribePrograms](https://cloud.tencent.com/document/product/649/73477) 的返回值中的 ProgramId 字段来获取或通过登录[控制台](https://console.cloud.tencent.com/tsf/privilege?tab=program&roleId=role-yrle4doy)查看;也可以调用[CreateProgram](https://cloud.tencent.com/document/product/649/108544)创建新的数据集。
2575
2611
  */
2576
2612
  ProgramIdList?: Array<string>;
2577
2613
  }
@@ -2593,7 +2629,7 @@ export interface DescribeResourceTaskStatusResponse {
2593
2629
  */
2594
2630
  export interface RedoTaskRequest {
2595
2631
  /**
2596
- * 任务ID
2632
+ * 任务ID。在[任务管理](https://console.cloud.tencent.com/tsf/tct?rid=1)列表页查看任务ID。
2597
2633
  */
2598
2634
  TaskId: string;
2599
2635
  }
@@ -2686,7 +2722,7 @@ export interface DraftApiGroupRequest {
2686
2722
  */
2687
2723
  export interface CreateLaneResponse {
2688
2724
  /**
2689
- * 泳道ID
2725
+ * 泳道配置ID
2690
2726
  */
2691
2727
  Result?: string;
2692
2728
  /**
@@ -2864,10 +2900,11 @@ export interface DescribeContainerGroupDeployInfoResponse {
2864
2900
  export interface DescribeOverviewInvocationRequest {
2865
2901
  /**
2866
2902
  * 命名空间ID, 此参数必填
2903
+ 可通过[DescribeSimpleNamespaces](https://cloud.tencent.com/document/product/649/36096)查询已经创建的命名空间,也可以通过登录[控制台](https://console.cloud.tencent.com/tsf/resource?rid=1&tab=namespace)查看
2867
2904
  */
2868
2905
  NamespaceId?: string;
2869
2906
  /**
2870
- * 监控统计类型,必填,可选值:SumReqAmountAvgFailureRateAvgTimeCost,分别对应请求量、请求错误率、平均响应耗时
2907
+ * 监控统计类型,必填,取值范围 SumReqAmount:请求量,AvgFailureRate:请求错误率,AvgTimeCost:平均响应耗时
2871
2908
  */
2872
2909
  Type?: string;
2873
2910
  /**
@@ -2875,11 +2912,11 @@ export interface DescribeOverviewInvocationRequest {
2875
2912
  */
2876
2913
  Period?: number;
2877
2914
  /**
2878
- * 查询开始时间,默认为当天的 00:00:00
2915
+ * 查询开始时间,格式为yyyy-MM-dd HH:mm:ss,默认为当天的 00:00:00
2879
2916
  */
2880
2917
  StartTime?: string;
2881
2918
  /**
2882
- * 查询结束时间,默认为当前时间
2919
+ * 查询结束时间,格式为yyyy-MM-dd HH:mm:ss,默认为当前时间
2883
2920
  */
2884
2921
  EndTime?: string;
2885
2922
  }
@@ -2922,7 +2959,7 @@ export interface DescribeProgramsRequest {
2922
2959
  */
2923
2960
  export interface DescribePublicConfigRequest {
2924
2961
  /**
2925
- * 需要查询的配置项ID
2962
+ * 需要查询的配置ID。该参数可以通过调用 [DescribePublicConfigs](https://cloud.tencent.com/document/product/649/38335) 的返回值中的 ConfigId 字段来获取或通过登录[控制台](https://console.cloud.tencent.com/tse/tsf-consul?subTab=public)配置详情-配置版本页查看;也可以调用[CreatePublicConfig](https://cloud.tencent.com/document/product/649/38347)创建新的配置。
2926
2963
  */
2927
2964
  ConfigId: string;
2928
2965
  }
@@ -3087,7 +3124,9 @@ export interface CommonOption {
3087
3124
  */
3088
3125
  export interface CreatePublicConfigResponse {
3089
3126
  /**
3090
- * true:创建成功;false:创建失败
3127
+ * 创建结果。
3128
+ - true:创建成功
3129
+ - false:创建失败
3091
3130
  */
3092
3131
  Result?: boolean;
3093
3132
  /**
@@ -3126,7 +3165,9 @@ export interface TsfPageVmGroup {
3126
3165
  */
3127
3166
  export interface CreateConfigResponse {
3128
3167
  /**
3129
- * true:创建成功;false:创建失败
3168
+ * 创建结果。
3169
+ - true:创建成功
3170
+ - false:创建失败
3130
3171
  */
3131
3172
  Result?: boolean;
3132
3173
  /**
@@ -3139,7 +3180,7 @@ export interface CreateConfigResponse {
3139
3180
  */
3140
3181
  export interface RevokeFileConfigRequest {
3141
3182
  /**
3142
- * 配置项发布ID
3183
+ * 按照【配置项发布ID】进行撤回。可通过调用[DescribeFileConfigReleases](https://cloud.tencent.com/document/product/649/85855)查询已发布的文件配置列表或登录[控制台](https://console.cloud.tencent.com/tse/tsf-consul?subTab=file)-查看发布信息-发布情况进行查看;也可以调用[ReleaseFileConfig](https://cloud.tencent.com/document/product/649/58592)发布文件配置。
3143
3184
  */
3144
3185
  ConfigReleaseId: string;
3145
3186
  }
@@ -3148,11 +3189,11 @@ export interface RevokeFileConfigRequest {
3148
3189
  */
3149
3190
  export interface DescribeCreateGatewayApiStatusRequest {
3150
3191
  /**
3151
- * 所属分组ID
3192
+ * 网关分组ID。该参数可以通过调用 [DescribeApiGroups](https://cloud.tencent.com/document/product/649/50636) 的返回值中的 GroupId 字段来获取或通过登录[控制台](https://console.cloud.tencent.com/tsf/app?tab=middleware&subTab=app)-网关应用详情-Java网关实例-实例详情-分组管理页查看;也可以调用[CreateApiGroup](https://cloud.tencent.com/document/product/649/50641)创建新的网关分组。
3152
3193
  */
3153
3194
  GroupId?: string;
3154
3195
  /**
3155
- * 微服务ID
3196
+ * 微服务ID。该参数可以通过调用 [DescribeMicroservices](https://cloud.tencent.com/document/product/649/36084) 的返回值中的 MicroserviceId 字段来获取或通过登录[控制台](https://console.cloud.tencent.com/tse/tsf-consul?tab=service)查看;也可以调用[CreateMicroserviceWithDetailResp](https://cloud.tencent.com/document/product/649/85860)创建新的微服务。
3156
3197
  */
3157
3198
  MicroserviceId?: string;
3158
3199
  }
@@ -3174,27 +3215,27 @@ export interface RevocationPublicConfigResponse {
3174
3215
  */
3175
3216
  export interface DescribeConfigReleaseLogsRequest {
3176
3217
  /**
3177
- * 部署组ID,不传入时查询全量
3218
+ * 部署组ID,不传入时查询全量。该参数可以通过调用 [DescribeSimpleGroups](https://cloud.tencent.com/document/product/649/36064) 的返回值中的 GroupId 字段来获取或通过登录[控制台](https://console.cloud.tencent.com/tsf/resource)-查看部署组页查看;也可以调用[CreateGroup](https://cloud.tencent.com/document/product/649/36074)创建新的部署组。
3178
3219
  */
3179
3220
  GroupId?: string;
3180
3221
  /**
3181
- * 偏移量,默认为0
3222
+ * 偏移量,默认为0
3182
3223
  */
3183
3224
  Offset?: number;
3184
3225
  /**
3185
- * 每页条数,默认为20
3226
+ * 返回数量,默认为20,最大值为100。
3186
3227
  */
3187
3228
  Limit?: number;
3188
3229
  /**
3189
- * 命名空间ID,不传入时查询全量
3230
+ * 命名空间ID,不传入时查询全量。该参数可以通过调用 [DescribeSimpleNamespaces](https://cloud.tencent.com/document/api/649/36096) 的返回值中的 NamespaceId 字段来获取或通过登录[控制台](https://console.cloud.tencent.com/tsf/resource?tab=namespace)查看;也可以调用[CreateNamespace](https://cloud.tencent.com/document/product/649/36098)创建新的命名空间。
3190
3231
  */
3191
3232
  NamespaceId?: string;
3192
3233
  /**
3193
- * 集群ID,不传入时查询全量
3234
+ * 集群ID,不传入时查询全量。该参数可以通过调用 [DescribeClusters](https://cloud.tencent.com/document/product/649/85857) 的返回值中的 ClusterId 字段来获取或通过登录[控制台](https://console.cloud.tencent.com/tsf/resource?tab=namespace)查看;也可以调用[CreateCluster](https://cloud.tencent.com/document/product/649/36049)创建新的集群。
3194
3235
  */
3195
3236
  ClusterId?: string;
3196
3237
  /**
3197
- * 应用ID,不传入时查询全量
3238
+ * 应用ID,不传入时查询全量。该参数可以通过调用 [DescribeApplications](https://cloud.tencent.com/document/product/649/36090) 的返回值中的 ApplicationId 字段来获取或通过登录[控制台](https://console.cloud.tencent.com/tsf/app)查看;也可以调用[CreateApplication](https://cloud.tencent.com/document/product/649/36094)创建新的应用。
3198
3239
  */
3199
3240
  ApplicationId?: string;
3200
3241
  }
@@ -3229,11 +3270,13 @@ export interface UpdateRepositoryResponse {
3229
3270
  */
3230
3271
  export interface DisassociateKafkaConfigRequest {
3231
3272
  /**
3232
- * 配置项id
3273
+ * 日志配置项ID
3274
+ 可通过调用[DescribeBusinessLogConfigs](https://cloud.tencent.com/document/product/649/75777)查询已创建的日志配置项列表或登录[控制台](https://console.cloud.tencent.com/tsf/observable/log?rid=1)进行查看
3233
3275
  */
3234
3276
  ConfigId: string;
3235
3277
  /**
3236
- * 部署组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)进行查看
3237
3280
  */
3238
3281
  GroupIds?: Array<string>;
3239
3282
  }
@@ -3242,7 +3285,9 @@ export interface DisassociateKafkaConfigRequest {
3242
3285
  */
3243
3286
  export interface TsfConfigCenter {
3244
3287
  /**
3245
- * 配置中心类型
3288
+ * 配置中心类型。
3289
+ - SHARE:共享型
3290
+ - EXCLUSIVE:独占型
3246
3291
  注意:此字段可能返回 null,表示取不到有效值。
3247
3292
  */
3248
3293
  ConfigType?: string;
@@ -3282,7 +3327,9 @@ export interface TsfConfigCenter {
3282
3327
  */
3283
3328
  export interface RollbackConfigResponse {
3284
3329
  /**
3285
- * true:回滚成功;false:回滚失败
3330
+ * 回滚结果。
3331
+ - true:回滚成功
3332
+ - false:回滚失败
3286
3333
  */
3287
3334
  Result?: boolean;
3288
3335
  /**
@@ -3295,7 +3342,7 @@ export interface RollbackConfigResponse {
3295
3342
  */
3296
3343
  export interface RevocationConfigRequest {
3297
3344
  /**
3298
- * 配置项发布ID
3345
+ * 配置项发布ID。该参数可以通过调用 [DescribeConfigReleases](https://cloud.tencent.com/document/product/649/38342) 的返回值中的 ConfigReleaseId 字段来获取或通过登录[控制台](https://console.cloud.tencent.com/tse/tsf-consul?subTab=app)配置详情-发布情况页查看。
3299
3346
  */
3300
3347
  ConfigReleaseId: string;
3301
3348
  }
@@ -3319,23 +3366,23 @@ export interface StartContainerGroupResponse {
3319
3366
  */
3320
3367
  export interface ModifyTaskRequest {
3321
3368
  /**
3322
- * 任务ID
3369
+ * 任务ID。在[任务管理](https://console.cloud.tencent.com/tsf/tct?rid=1)列表页查看任务ID。
3323
3370
  */
3324
3371
  TaskId: string;
3325
3372
  /**
3326
- * 任务名称
3373
+ * 任务名称,长度限制为64字符。在任务管理列表页面第一列或是任务基本信息页查看任务名称。
3327
3374
  */
3328
3375
  TaskName?: string;
3329
3376
  /**
3330
- * 任务类型
3377
+ * 任务类型。当前只支持一种任务类型。枚举值,java:Java类任务
3331
3378
  */
3332
3379
  TaskType?: string;
3333
3380
  /**
3334
- * 任务内容
3381
+ * 任务内容,长度限制为 65536 字节
3335
3382
  */
3336
3383
  TaskContent?: string;
3337
3384
  /**
3338
- * 任务执行类型
3385
+ * 任务执行方式,枚举值。unicast:随机单节点执行,broadcast:广播执行,shard:分片执行
3339
3386
  */
3340
3387
  ExecuteType?: string;
3341
3388
  /**
@@ -3343,15 +3390,15 @@ export interface ModifyTaskRequest {
3343
3390
  */
3344
3391
  TaskRule?: TaskRule;
3345
3392
  /**
3346
- * 超时时间,单位 ms
3393
+ * 超时时间,取值大于0,单位:毫秒(ms
3347
3394
  */
3348
3395
  TimeOut?: number;
3349
3396
  /**
3350
- * 分组ID
3397
+ * 部署组ID。在[应用管理](https://console.cloud.tencent.com/tsf/app?rid=1),点击应用ID进入应用部署页查看部署组ID。
3351
3398
  */
3352
3399
  GroupId?: string;
3353
3400
  /**
3354
- * 分片数量
3401
+ * 分片数量,取值范围2~1000
3355
3402
  */
3356
3403
  ShardCount?: number;
3357
3404
  /**
@@ -3367,15 +3414,15 @@ export interface ModifyTaskRequest {
3367
3414
  */
3368
3415
  SuccessOperator?: string;
3369
3416
  /**
3370
- * 判断任务成功率的阈值
3417
+ * 判断任务成功率的阈值,取值范围:1-100,单位:百分比(%)
3371
3418
  */
3372
3419
  SuccessRatio?: number;
3373
3420
  /**
3374
- * 重试次数
3421
+ * 重试次数,取值范围 0 - 10,单位:次
3375
3422
  */
3376
3423
  RetryCount?: number;
3377
3424
  /**
3378
- * 重试间隔
3425
+ * 重试间隔,取值范围 0-600,单位:秒(s)
3379
3426
  */
3380
3427
  RetryInterval?: number;
3381
3428
  /**
@@ -3383,7 +3430,7 @@ export interface ModifyTaskRequest {
3383
3430
  */
3384
3431
  TaskArgument?: string;
3385
3432
  /**
3386
- *
3433
+ * 数据集列表。
3387
3434
  */
3388
3435
  ProgramIdList?: Array<string>;
3389
3436
  }
@@ -3405,7 +3452,7 @@ export interface DeleteUnitNamespacesResponse {
3405
3452
  */
3406
3453
  export interface DescribeMicroservicesByGroupIdsRequest {
3407
3454
  /**
3408
- * 部署组ID列表
3455
+ * 部署组ID列表。该参数可以通过调用 [DescribeSimpleGroups](https://cloud.tencent.com/document/product/649/36064) 的返回值中的 GroupId 字段来获取或通过登录[控制台](https://console.cloud.tencent.com/tsf/resource)-查看部署组页查看;也可以调用[CreateGroup](https://cloud.tencent.com/document/product/649/36074)创建新的部署组。
3409
3456
  */
3410
3457
  GroupIds: Array<string>;
3411
3458
  }
@@ -3453,7 +3500,7 @@ export interface CreateAllGatewayApiAsyncResponse {
3453
3500
  */
3454
3501
  export interface RemoveInstancesRequest {
3455
3502
  /**
3456
- * 集群 ID
3503
+ * 集群 ID。调用[DescribeSimpleClusters](https://cloud.tencent.com/document/api/649/36047)查询已创建的集群或通过[CreateCluster](https://cloud.tencent.com/document/api/649/36049)接口创建新的集群。
3457
3504
  */
3458
3505
  ClusterId: string;
3459
3506
  /**
@@ -3479,7 +3526,9 @@ export interface TsfPageInstance {
3479
3526
  */
3480
3527
  export interface ModifyLaneResponse {
3481
3528
  /**
3482
- * 更新成功: true / 更新失败: false
3529
+ * 更新结果。
3530
+ - true:更新成功
3531
+ - false:更新失败
3483
3532
  */
3484
3533
  Result?: boolean;
3485
3534
  /**
@@ -3507,7 +3556,7 @@ export interface DeleteGroupResponse {
3507
3556
  */
3508
3557
  export interface DeployContainerGroupRequest {
3509
3558
  /**
3510
- * 部署组ID,分组唯一标识
3559
+ * 部署组ID,可通过调用[DescribeContainerGroups](https://cloud.tencent.com/document/api/649/36068)查询已创建的部署组列表或登录控制台进行查看;也可以调用[CreateContainGroup](https://cloud.tencent.com/document/api/649/36075)创建新的部署组。
3511
3560
  */
3512
3561
  GroupId: string;
3513
3562
  /**
@@ -3714,19 +3763,22 @@ export interface DescribeContainerGroupAttributeRequest {
3714
3763
  */
3715
3764
  export interface DescribeSimpleApplicationsRequest {
3716
3765
  /**
3717
- * 应用ID列表
3766
+ * 应用ID列表,可通过调用[DescribeApplications](https://cloud.tencent.com/document/api/649/36090)查询已创建的应用列表或登录控制台进行查看;也可以调用[CreateApplication](https://cloud.tencent.com/document/api/649/36094)创建新的应用。
3718
3767
  */
3719
3768
  ApplicationIdList?: Array<string>;
3720
3769
  /**
3721
- * 应用类型
3770
+ * 指定应用类型,目前支持:
3771
+ - `V`:普通应用/CVM应用
3772
+ - `C`:容器应用
3773
+ - `S`:serverless 应用
3722
3774
  */
3723
3775
  ApplicationType?: string;
3724
3776
  /**
3725
- * 每页条数
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)
3726
3778
  */
3727
3779
  Limit?: number;
3728
3780
  /**
3729
- * 起始偏移量
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)
3730
3782
  */
3731
3783
  Offset?: number;
3732
3784
  /**
@@ -3742,7 +3794,7 @@ export interface DescribeSimpleApplicationsRequest {
3742
3794
  */
3743
3795
  SearchWord?: string;
3744
3796
  /**
3745
- *
3797
+ * 是否关闭鉴权查询
3746
3798
  */
3747
3799
  DisableProgramAuthCheck?: boolean;
3748
3800
  /**
@@ -3768,7 +3820,7 @@ export interface DescribeDeliveryConfigByGroupIdResponse {
3768
3820
  */
3769
3821
  export interface ModifyContainerGroupRequest {
3770
3822
  /**
3771
- * 部署组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)创建新的部署组。
3772
3824
  */
3773
3825
  GroupId: string;
3774
3826
  /**
@@ -3788,7 +3840,7 @@ export interface ModifyContainerGroupRequest {
3788
3840
  */
3789
3841
  UpdateIvl?: number;
3790
3842
  /**
3791
- * 子网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)创建新的子网。
3792
3844
  */
3793
3845
  SubnetId?: string;
3794
3846
  /**
@@ -3884,7 +3936,7 @@ export interface ContainGroup {
3884
3936
  */
3885
3937
  export interface CreateConfigWithDetailRespResponse {
3886
3938
  /**
3887
- * 配置项
3939
+ * 配置项。
3888
3940
  */
3889
3941
  Result?: Config;
3890
3942
  /**
@@ -3944,7 +3996,9 @@ export interface UpdateUnitRuleRequest {
3944
3996
  */
3945
3997
  export interface ReleasePublicConfigResponse {
3946
3998
  /**
3947
- * true:发布成功;false:发布失败
3999
+ * 发布结果。
4000
+ - true:发布成功
4001
+ - false:发布失败
3948
4002
  */
3949
4003
  Result?: boolean;
3950
4004
  /**
@@ -4003,7 +4057,7 @@ export interface UpdateApiRateLimitRulesRequest {
4003
4057
  */
4004
4058
  export interface DescribeGroupInstancesRequest {
4005
4059
  /**
4006
- * 部署组ID
4060
+ * 部署组ID,可通过调用[DescribeGroups](https://cloud.tencent.com/document/api/649/36065)查询已创建的部署组列表或登录控制台进行查看;也可以调用[CreateGroup](https://cloud.tencent.com/document/api/649/36074)创建新的部署组。
4007
4061
  */
4008
4062
  GroupId: string;
4009
4063
  /**
@@ -4015,15 +4069,15 @@ export interface DescribeGroupInstancesRequest {
4015
4069
  */
4016
4070
  OrderBy?: string;
4017
4071
  /**
4018
- * 排序类型
4072
+ * 排序类型;0:升序,1:降序
4019
4073
  */
4020
4074
  OrderType?: number;
4021
4075
  /**
4022
- * 偏移量
4076
+ * 偏移量,默认值:0
4023
4077
  */
4024
4078
  Offset?: number;
4025
4079
  /**
4026
- * 分页个数
4080
+ * 分页个数;默认值:20
4027
4081
  */
4028
4082
  Limit?: number;
4029
4083
  }
@@ -4032,19 +4086,19 @@ export interface DescribeGroupInstancesRequest {
4032
4086
  */
4033
4087
  export interface DescribeMsApiListRequest {
4034
4088
  /**
4035
- * 微服务ID
4089
+ * 微服务ID。该参数可以通过调用 [DescribeMicroservices](https://cloud.tencent.com/document/product/649/36084) 的返回值中的 MicroserviceId 字段来获取或通过登录[控制台](https://console.cloud.tencent.com/tse/tsf-consul?tab=service)查看;也可以调用[CreateMicroserviceWithDetailResp](https://cloud.tencent.com/document/product/649/85860)创建新的微服务。
4036
4090
  */
4037
4091
  MicroserviceId: string;
4038
4092
  /**
4039
- * 搜索关键字
4093
+ * 搜索关键字。
4040
4094
  */
4041
4095
  SearchWord?: string;
4042
4096
  /**
4043
- * 每页的数量
4097
+ * 返回数量,默认为20,最大值为50。
4044
4098
  */
4045
4099
  Limit?: number;
4046
4100
  /**
4047
- * 翻页偏移量
4101
+ * 偏移量,默认为0。
4048
4102
  */
4049
4103
  Offset?: number;
4050
4104
  }
@@ -4106,7 +4160,7 @@ export interface LifeCycleHook {
4106
4160
  */
4107
4161
  export interface DescribeMsApiListResponse {
4108
4162
  /**
4109
- * 相应结果
4163
+ * 微服务API列表。
4110
4164
  */
4111
4165
  Result?: TsfApiListResponse;
4112
4166
  /**
@@ -4119,7 +4173,7 @@ export interface DescribeMsApiListResponse {
4119
4173
  */
4120
4174
  export interface EnableTaskRequest {
4121
4175
  /**
4122
- * 启用任务
4176
+ * 任务ID。[任务管理](https://console.cloud.tencent.com/tsf/tct?rid=1)列表页查看任务ID。
4123
4177
  */
4124
4178
  TaskId: string;
4125
4179
  }
@@ -4136,7 +4190,7 @@ export interface BusinessLogV2 {
4136
4190
  */
4137
4191
  Content?: string;
4138
4192
  /**
4139
- * 日志时间戳
4193
+ * 日志时间戳,单位毫秒
4140
4194
  */
4141
4195
  Timestamp?: number;
4142
4196
  /**
@@ -4157,7 +4211,7 @@ export interface BusinessLogV2 {
4157
4211
  */
4158
4212
  export interface DisableTaskResponse {
4159
4213
  /**
4160
- * 操作成功 or 失败
4214
+ * true:操作成功,false:操作失败
4161
4215
  */
4162
4216
  Result?: boolean;
4163
4217
  /**
@@ -4170,23 +4224,29 @@ export interface DisableTaskResponse {
4170
4224
  */
4171
4225
  export interface DescribeMicroserviceRequest {
4172
4226
  /**
4173
- * 微服务ID
4227
+ * 微服务ID。该参数可以通过调用 [DescribeMicroservices](https://cloud.tencent.com/document/product/649/36084) 的返回值中的 MicroserviceId 字段来获取或通过登录[控制台](https://console.cloud.tencent.com/tse/tsf-consul?tab=service)查看;也可以调用[CreateMicroserviceWithDetailResp](https://cloud.tencent.com/document/product/649/85860)创建新的微服务。
4174
4228
  */
4175
4229
  MicroserviceId: string;
4176
4230
  /**
4177
- * 偏移量
4231
+ * 偏移量,默认为0。
4178
4232
  */
4179
4233
  Offset?: number;
4180
4234
  /**
4181
- * 分页个数
4235
+ * 返回数量,默认为20,最大值为50。
4182
4236
  */
4183
4237
  Limit?: number;
4184
4238
  /**
4185
- * 可选,根据部署组ID进行过滤
4239
+ * 部署组ID。该参数可以通过调用 [DescribeSimpleGroups](https://cloud.tencent.com/document/product/649/36064) 的返回值中的 GroupId 字段来获取或通过登录[控制台](https://console.cloud.tencent.com/tsf/resource)-查看部署组页查看;也可以调用[CreateGroup](https://cloud.tencent.com/document/product/649/36074)创建新的部署组。
4186
4240
  */
4187
4241
  GroupIds?: Array<string>;
4188
4242
  /**
4189
- * 过滤条件。多个 filter 之间是与关系,单个 filter 多个 value 之间是或关系。filter name 取值有:id(实例id)、name(实例名)、lan-ip(内网ip)、node-ip(所在节点ip)
4243
+ * 过滤条件。多个 filter 之间是与关系,单个 filter 多个 value 之间是或关系。
4244
+ 参考:[{"Name":"LanIp","Values":["172.16.16.139"]}]
4245
+ filter name 取值范围:
4246
+ - id:实例ID
4247
+ - name:实例名
4248
+ - lan-ip:内网IP
4249
+ - node-ip:所在节点IP
4190
4250
  */
4191
4251
  Filters?: Array<Filter>;
4192
4252
  }
@@ -4272,7 +4332,7 @@ export interface FileConfigRelease {
4272
4332
  */
4273
4333
  ReleaseDesc?: string;
4274
4334
  /**
4275
- * 发布时间
4335
+ * 发布时间。格式为 YYYY-MM-DD hh:mm:ss。
4276
4336
  注意:此字段可能返回 null,表示取不到有效值。
4277
4337
  */
4278
4338
  ReleaseTime?: string;
@@ -4317,23 +4377,23 @@ export interface FileConfigRelease {
4317
4377
  */
4318
4378
  export interface DescribeInvocationMetricDataPointRequest {
4319
4379
  /**
4320
- * 开始时间
4380
+ * 开始时间,格式yyyy-MM-dd HH:mm:ss
4321
4381
  */
4322
4382
  StartTime: string;
4323
4383
  /**
4324
- * 结束时间
4384
+ * 结束时间,格式yyyy-MM-dd HH:mm:ss
4325
4385
  */
4326
4386
  EndTime: string;
4327
4387
  /**
4328
- * 维度,并且 维度 key value 不能为空
4388
+ * 查询指标维度, 不能为空
4329
4389
  */
4330
4390
  MetricDimensionValues: Array<MetricDimensionValue>;
4331
4391
  /**
4332
- * 指标,并且 key, value 不能为空
4392
+ * 指标,不能为空
4333
4393
  */
4334
4394
  Metrics: Array<Metric>;
4335
4395
  /**
4336
- * 调用视角。可选值:SERVER, CLIENT。默认为SERVER
4396
+ * 视图视角。可选值:SERVER:服务端, CLIENT:客户端。默认为SERVER
4337
4397
  */
4338
4398
  Kind?: string;
4339
4399
  }
@@ -4442,7 +4502,7 @@ export interface ContainerAdditionalResourceRequirement {
4442
4502
  */
4443
4503
  export interface DeleteClusterRequest {
4444
4504
  /**
4445
- * 集群ID
4505
+ * 集群ID,按照【集群ID】进行过滤,可通过调用DescribeClusters查询已创建的项目列表或登录控制台进行查看;也可以调用CreateCluster创建新的项目。集群ID例如:cls-6a79x94v。仅在集群下无部署组、命名空间、云主机时可以删除。
4446
4506
  */
4447
4507
  ClusterId: string;
4448
4508
  /**
@@ -4455,7 +4515,7 @@ export interface DeleteClusterRequest {
4455
4515
  */
4456
4516
  export interface StopTaskBatchResponse {
4457
4517
  /**
4458
- * 操作成功 or 失败
4518
+ * 返回 true 或 false。true:操作成功,false:操作失败
4459
4519
  */
4460
4520
  Result?: boolean;
4461
4521
  /**
@@ -4476,7 +4536,7 @@ export interface ServiceStatisticsResult {
4476
4536
  */
4477
4537
  Method?: string;
4478
4538
  /**
4479
- * 微服务Id
4539
+ * 微服务ID
4480
4540
  */
4481
4541
  MicroserviceId?: string;
4482
4542
  /**
@@ -4508,7 +4568,7 @@ export interface ServiceStatisticsResult {
4508
4568
  */
4509
4569
  InstanceName?: string;
4510
4570
  /**
4511
- * 部署组id
4571
+ * 部署组ID
4512
4572
  */
4513
4573
  GroupId?: string;
4514
4574
  /**
@@ -4516,7 +4576,7 @@ export interface ServiceStatisticsResult {
4516
4576
  */
4517
4577
  GroupName?: string;
4518
4578
  /**
4519
- * 部署组类型
4579
+ * 集群类型,C:容器集群,V:虚拟机集群
4520
4580
  */
4521
4581
  ClusterType?: string;
4522
4582
  /**
@@ -4528,11 +4588,11 @@ export interface ServiceStatisticsResult {
4528
4588
  */
4529
4589
  InstanceExist?: number;
4530
4590
  /**
4531
- * 应用id
4591
+ * 应用ID
4532
4592
  */
4533
4593
  ApplicationId?: string;
4534
4594
  /**
4535
- * 微服务类型
4595
+ * 微服务类型。RAW:裸应用,M:mesh应用,N:普通应用,G:网关应用
4536
4596
  */
4537
4597
  MicroserviceType?: string;
4538
4598
  /**
@@ -4572,19 +4632,19 @@ export interface ServiceStatisticsResult {
4572
4632
  */
4573
4633
  InstanceTotalCount?: number;
4574
4634
  /**
4575
- * normal/error
4635
+ * 状态。normal:正常,warn:警告,error:错误
4576
4636
  */
4577
4637
  Status?: string;
4578
4638
  /**
4579
- * normal/warn/error
4639
+ * 请求错误率等级。normal:正常,warn:警告,error:错误
4580
4640
  */
4581
4641
  ErrorRateLevel?: string;
4582
4642
  /**
4583
- * normal/warn/error
4643
+ * 请求平均耗时等级。normal:正常,warn:警告,error:错误
4584
4644
  */
4585
4645
  AvgTimeConsumingLevel?: string;
4586
4646
  /**
4587
- * normal/warn/error
4647
+ * 应用程序性能指数等级。normal:正常,warn:警告,error:错误
4588
4648
  */
4589
4649
  ApdexLevel?: string;
4590
4650
  }
@@ -4619,7 +4679,7 @@ export interface DescribeContainerGroupDetailResponse {
4619
4679
  */
4620
4680
  export interface DisableTaskRequest {
4621
4681
  /**
4622
- * 任务ID
4682
+ * 任务ID。[任务管理](https://console.cloud.tencent.com/tsf/tct?rid=1)列表页查看任务ID。
4623
4683
  */
4624
4684
  TaskId: string;
4625
4685
  }
@@ -4645,7 +4705,7 @@ export interface Ports {
4645
4705
  */
4646
4706
  TargetPort: number;
4647
4707
  /**
4648
- * 端口协议
4708
+ * 端口协议,TCP或者UDP
4649
4709
  */
4650
4710
  Protocol: string;
4651
4711
  }
@@ -4654,7 +4714,7 @@ export interface Ports {
4654
4714
  */
4655
4715
  export interface UpdateRepositoryRequest {
4656
4716
  /**
4657
- * 仓库ID
4717
+ * 仓库ID,可通过调用[仓库信息查询类](https://cloud.tencent.com/document/api/649/45925)接口时出参中的RepositoryId,或登录[控制台](https://console.cloud.tencent.com/tsf/product?rid=1)进行查看
4658
4718
  */
4659
4719
  RepositoryId: string;
4660
4720
  /**
@@ -4695,7 +4755,9 @@ export interface SimpleKafkaDeliveryConfig {
4695
4755
  */
4696
4756
  export interface RevocationConfigResponse {
4697
4757
  /**
4698
- * true:回滚成功;false:回滚失败
4758
+ * 撤回结果。
4759
+ - true:成功
4760
+ - false:失败
4699
4761
  */
4700
4762
  Result?: boolean;
4701
4763
  /**
@@ -4721,7 +4783,7 @@ export interface PkgBind {
4721
4783
  */
4722
4784
  export interface DeleteTaskResponse {
4723
4785
  /**
4724
- * 删除成功or失败
4786
+ * true:删除成功,false:删除失败
4725
4787
  */
4726
4788
  Result?: boolean;
4727
4789
  /**
@@ -4749,7 +4811,7 @@ export interface TsfPageMsInstance {
4749
4811
  */
4750
4812
  export interface DeleteMicroserviceRequest {
4751
4813
  /**
4752
- * 微服务ID
4814
+ * 微服务ID。该参数可以通过调用 [DescribeMicroservices](https://cloud.tencent.com/document/product/649/36084) 的返回值中的 MicroserviceId 字段来获取或通过登录[控制台](https://console.cloud.tencent.com/tse/tsf-consul?tab=service)查看;也可以调用[CreateMicroserviceWithDetailResp](https://cloud.tencent.com/document/product/649/85860)创建新的微服务。
4753
4815
  */
4754
4816
  MicroserviceId: string;
4755
4817
  }
@@ -4758,7 +4820,7 @@ export interface DeleteMicroserviceRequest {
4758
4820
  */
4759
4821
  export interface CreatePublicConfigWithDetailRespResponse {
4760
4822
  /**
4761
- * 公共配置项 ID
4823
+ * 公共配置项ID
4762
4824
  */
4763
4825
  Result?: Config;
4764
4826
  /**
@@ -4771,35 +4833,37 @@ export interface CreatePublicConfigWithDetailRespResponse {
4771
4833
  */
4772
4834
  export interface CreateConfigWithDetailRespRequest {
4773
4835
  /**
4774
- * 配置项名称
4836
+ * 配置项名称,最多支持60个字符,只能包含字母、数字及分隔符(“-”、“_”),且不能以分隔符开头或结尾。
4775
4837
  */
4776
4838
  ConfigName: string;
4777
4839
  /**
4778
- * 配置项版本
4840
+ * 配置项版本,只能包含小写字母、数字及分隔符("-","."),且必须以小写字母或数字开头、以小写字母或数字结尾,中间不能有连续的"-"或"."。
4779
4841
  */
4780
4842
  ConfigVersion: string;
4781
4843
  /**
4782
- * 配置项值
4844
+ * 配置项值。
4783
4845
  */
4784
4846
  ConfigValue: string;
4785
4847
  /**
4786
- * 应用ID
4848
+ * 应用ID。该参数可以通过调用 [DescribeApplications](https://cloud.tencent.com/document/product/649/36090) 的返回值中的 ApplicationId 字段来获取或通过登录[控制台](https://console.cloud.tencent.com/tsf/app)查看;也可以调用[CreateApplication](https://cloud.tencent.com/document/product/649/36094)创建新的应用。
4787
4849
  */
4788
4850
  ApplicationId: string;
4789
4851
  /**
4790
- * 配置项版本描述
4852
+ * 配置项版本描述,最多支持200个字符。
4791
4853
  */
4792
4854
  ConfigVersionDesc?: string;
4793
4855
  /**
4794
- * 配置项值类型
4856
+ * 配置项值类型,固定值。
4795
4857
  */
4796
4858
  ConfigType?: string;
4797
4859
  /**
4798
- * Base64编码的配置项
4860
+ * Base64编码的配置项。
4861
+ - true:开启
4862
+ - false:关闭
4799
4863
  */
4800
4864
  EncodeWithBase64?: boolean;
4801
4865
  /**
4802
- *
4866
+ * 需要绑定的数据集ID。该参数可以通过调用 [DescribePrograms](https://cloud.tencent.com/document/product/649/73477) 的返回值中的 ProgramId 字段来获取或通过登录[控制台](https://console.cloud.tencent.com/tsf/privilege?tab=program&roleId=role-yrle4doy)查看;也可以调用[CreateProgram](https://cloud.tencent.com/document/product/649/108544)创建新的数据集。
4803
4867
  */
4804
4868
  ProgramIdList?: Array<string>;
4805
4869
  }
@@ -4821,11 +4885,11 @@ export interface RemoveInstancesResponse {
4821
4885
  */
4822
4886
  export interface DescribeContainerEventsRequest {
4823
4887
  /**
4824
- * event 的资源类型, group 或者 instance
4888
+ * event 的资源类型, 仅支持 group
4825
4889
  */
4826
4890
  ResourceType: string;
4827
4891
  /**
4828
- * event 的资源 id
4892
+ * 部署组ID,按照【部署组ID】进行过滤,可通过调用DescribeGroups查询已创建的项目列表或登录控制台进行查看;也可以调用CreateGroup创建新的项目。部署组ID例如:group-9yn2q8yd
4829
4893
  */
4830
4894
  ResourceId: string;
4831
4895
  /**
@@ -4837,15 +4901,15 @@ export interface DescribeContainerEventsRequest {
4837
4901
  */
4838
4902
  Limit?: number;
4839
4903
  /**
4840
- * 当类型是 instance 时需要
4904
+ * 部署组ID,按照【部署组ID】进行过滤,可通过调用DescribeGroups查询已创建的项目列表或登录控制台进行查看;也可以调用CreateGroup创建新的项目。部署组ID例如:group-9yn2q8yd。
4841
4905
  */
4842
4906
  GroupId?: string;
4843
4907
  /**
4844
- * event的资源kind
4908
+ * event的资源种类
4845
4909
  */
4846
4910
  Kind?: string;
4847
4911
  /**
4848
- * event 的type
4912
+ * event 的事件级别
4849
4913
  */
4850
4914
  Type?: string;
4851
4915
  /**
@@ -4967,7 +5031,7 @@ export interface Env {
4967
5031
  */
4968
5032
  export interface ModifyClusterRequest {
4969
5033
  /**
4970
- * 集群ID
5034
+ * 集群ID,按照【集群ID】进行过滤,可通过调用DescribeClusters查询已创建的项目列表或登录控制台进行查看;也可以调用CreateCluster创建新的项目。集群ID例如:cls-6a79x94v。
4971
5035
  */
4972
5036
  ClusterId: string;
4973
5037
  /**
@@ -4983,11 +5047,11 @@ export interface ModifyClusterRequest {
4983
5047
  */
4984
5048
  ClusterRemarkName?: string;
4985
5049
  /**
4986
- * 是否开启cls日志功能
5050
+ * 是否开启cls日志功能,true表示开启,false表示关闭
4987
5051
  */
4988
5052
  EnableLogCollection?: boolean;
4989
5053
  /**
4990
- * 是否修复cls日志功能
5054
+ * 是否修复cls日志功能,true表示修复,false表示不修复
4991
5055
  */
4992
5056
  RepairLog?: boolean;
4993
5057
  }
@@ -4996,11 +5060,11 @@ export interface ModifyClusterRequest {
4996
5060
  */
4997
5061
  export interface Resource {
4998
5062
  /**
4999
- * 资源ID
5063
+ * 资源ID,调用[DescribeResource](https://console.cloud.tencent.com/tsf/privilege-program-create?rid=1)查询接口获取
5000
5064
  */
5001
5065
  ResourceId?: string;
5002
5066
  /**
5003
- * 资源编码
5067
+ * 资源编码,枚举值描述【cluster、namespace、config】
5004
5068
  */
5005
5069
  ResourceCode?: string;
5006
5070
  /**
@@ -5008,15 +5072,15 @@ export interface Resource {
5008
5072
  */
5009
5073
  ResourceName?: string;
5010
5074
  /**
5011
- * 资源所属产品编码
5075
+ * 资源所属产品编码,枚举值描述【tsf】
5012
5076
  */
5013
5077
  ServiceCode?: string;
5014
5078
  /**
5015
- * 选取资源使用的Action
5079
+ * 选取资源使用的Action,枚举值描述【DescribeSimpleCluster、DescribeLanes、DescribeTaskRecords】
5016
5080
  */
5017
5081
  ResourceAction?: string;
5018
5082
  /**
5019
- * 资源数据查询的ID字段名
5083
+ * 资源数据查询的ID字段名,调用[DescribeResource](https://console.cloud.tencent.com/tsf/privilege-program-create?rid=1)查询接口获取
5020
5084
  */
5021
5085
  IdField?: string;
5022
5086
  /**
@@ -5028,11 +5092,11 @@ export interface Resource {
5028
5092
  */
5029
5093
  SelectIdsField?: string;
5030
5094
  /**
5031
- * 创建时间
5095
+ * 创建时间,时间戳格式【Long】
5032
5096
  */
5033
5097
  CreationTime?: number;
5034
5098
  /**
5035
- * 最后更新时间
5099
+ * 最后更新时间,时间戳格式【Long】
5036
5100
  */
5037
5101
  LastUpdateTime?: number;
5038
5102
  /**
@@ -5052,7 +5116,7 @@ export interface Resource {
5052
5116
  */
5053
5117
  SearchWordField?: string;
5054
5118
  /**
5055
- * 排序
5119
+ * 排序,枚举值描述【10、20、77】
5056
5120
  */
5057
5121
  Index?: number;
5058
5122
  }
@@ -5168,7 +5232,7 @@ export interface GroupUnitApiDailyUseStatistics {
5168
5232
  */
5169
5233
  export interface DescribeFileConfigReleasesResponse {
5170
5234
  /**
5171
- * 配置项发布信息列表
5235
+ * 配置项发布信息列表。
5172
5236
  */
5173
5237
  Result?: TsfPageFileConfigRelease;
5174
5238
  /**
@@ -5194,7 +5258,7 @@ export interface DisableUnitRouteResponse {
5194
5258
  */
5195
5259
  export interface ExecuteTaskRequest {
5196
5260
  /**
5197
- * 任务 ID
5261
+ * 任务ID。在[任务管理](https://console.cloud.tencent.com/tsf/tct?rid=1)列表页查看任务ID。
5198
5262
  */
5199
5263
  TaskId: string;
5200
5264
  }
@@ -5203,7 +5267,8 @@ export interface ExecuteTaskRequest {
5203
5267
  */
5204
5268
  export interface DescribeGroupBusinessLogConfigsRequest {
5205
5269
  /**
5206
- * 分组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)进行查看
5207
5272
  */
5208
5273
  GroupId: string;
5209
5274
  }
@@ -5276,7 +5341,7 @@ export interface LaneInfo {
5276
5341
  */
5277
5342
  export interface DescribeConfigReleaseLogsResponse {
5278
5343
  /**
5279
- * 分页的配置项发布历史列表
5344
+ * 分页的配置项发布历史列表。
5280
5345
  */
5281
5346
  Result?: TsfPageConfigReleaseLog;
5282
5347
  /**
@@ -5289,7 +5354,9 @@ export interface DescribeConfigReleaseLogsResponse {
5289
5354
  */
5290
5355
  export interface DeletePublicConfigResponse {
5291
5356
  /**
5292
- * true:删除成功;false:删除失败
5357
+ * 删除结果。
5358
+ - true:删除成功
5359
+ - false:删除失败
5293
5360
  */
5294
5361
  Result?: boolean;
5295
5362
  /**
@@ -5315,7 +5382,7 @@ export interface DescribePathRewriteResponse {
5315
5382
  */
5316
5383
  export interface DescribeFlowLastBatchStateRequest {
5317
5384
  /**
5318
- * 工作流 ID
5385
+ * 工作流 ID。前往[工作流管理](https://console.cloud.tencent.com/tsf/tct?rid=1&tab=workflowManage),在工作流列表第一列和工作流详情页查看工作流ID。
5319
5386
  */
5320
5387
  FlowId: string;
5321
5388
  }
@@ -5337,7 +5404,8 @@ export interface DescribeSimpleNamespacesResponse {
5337
5404
  */
5338
5405
  export interface GroupInfo {
5339
5406
  /**
5340
- * 部署组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)进行查看。
5341
5409
  */
5342
5410
  GroupId: string;
5343
5411
  /**
@@ -5345,11 +5413,12 @@ export interface GroupInfo {
5345
5413
  */
5346
5414
  GroupName: string;
5347
5415
  /**
5348
- * 集群类型
5416
+ * 集群类型,C:容器集群,V:虚拟机集群
5349
5417
  */
5350
5418
  ClusterType: string;
5351
5419
  /**
5352
- * 集群id
5420
+ * 集群ID
5421
+ 可通过[DescribeClusters](https://cloud.tencent.com/document/product/649/85857)查询已经创建的集群列表,也可以通过登录[控制台](https://console.cloud.tencent.com/tsf/resource?rid=1)查看。
5353
5422
  */
5354
5423
  ClusterId?: string;
5355
5424
  /**
@@ -5361,7 +5430,7 @@ export interface GroupInfo {
5361
5430
  */
5362
5431
  NamespaceName?: string;
5363
5432
  /**
5364
- * 绑定时间
5433
+ * 绑定时间,格式yyyy-MM-dd HH:mm:ss
5365
5434
  */
5366
5435
  AssociateTime?: string;
5367
5436
  }
@@ -5370,7 +5439,7 @@ export interface GroupInfo {
5370
5439
  */
5371
5440
  export interface TerminateTaskFlowBatchResponse {
5372
5441
  /**
5373
- * 是否停止成功
5442
+ * 是否停止成功,true:停止成功,false:停止失败
5374
5443
  */
5375
5444
  Result?: boolean;
5376
5445
  /**
@@ -5383,7 +5452,7 @@ export interface TerminateTaskFlowBatchResponse {
5383
5452
  */
5384
5453
  export interface DisassociateKafkaConfigResponse {
5385
5454
  /**
5386
- * 解除绑定是否成功
5455
+ * 解除绑定是否成功,true:成功,false:失败。
5387
5456
  */
5388
5457
  Result?: boolean;
5389
5458
  /**
@@ -5431,7 +5500,9 @@ export interface ShrinkInstancesResponse {
5431
5500
  */
5432
5501
  export interface DeleteLaneRuleResponse {
5433
5502
  /**
5434
- * 操作状态
5503
+ * 删除结果。
5504
+ - true:成功
5505
+ - false:失败
5435
5506
  */
5436
5507
  Result?: boolean;
5437
5508
  /**
@@ -5528,11 +5599,11 @@ export interface ContainerGroupOther {
5528
5599
  */
5529
5600
  export interface AddClusterInstancesRequest {
5530
5601
  /**
5531
- * 集群ID
5602
+ * 集群ID,按照【集群ID】进行过滤,可通过调用[DescribeClusters](https://cloud.tencent.com/document/product/649/85857)查询已创建的集群列表或登录控制台进行查看;也可以调用[CreateCluster](https://cloud.tencent.com/document/product/649/36049)创建新的集群。仅在集群下无部署组、命名空间、云主机时可以删除。
5532
5603
  */
5533
5604
  ClusterId: string;
5534
5605
  /**
5535
- * 云主机ID列表
5606
+ * 云主机ID列表,可通过调用[DescribeInstances](https://cloud.tencent.com/document/api/213/15728)查询已创建的云主机列表或登录控制台进行查看;也可以调用[RunInstances](https://cloud.tencent.com/document/api/213/15730)创建新的云主机。
5536
5607
  */
5537
5608
  InstanceIdList: Array<string>;
5538
5609
  /**
@@ -5746,7 +5817,7 @@ export interface ContainerGroupDeploy {
5746
5817
  */
5747
5818
  TcrRepoInfo?: TcrRepoInfo;
5748
5819
  /**
5749
- * 数据卷信息,list
5820
+ * 数据卷信息,数组结构
5750
5821
  注意:此字段可能返回 null,表示取不到有效值。
5751
5822
  */
5752
5823
  VolumeInfos?: Array<VolumeInfo>;
@@ -5827,6 +5898,10 @@ export interface VolumeInfo {
5827
5898
  * -
5828
5899
  */
5829
5900
  EmptyDirOption?: EmptyDirOption;
5901
+ /**
5902
+ * 数据卷PVC声明模板
5903
+ */
5904
+ VolumeClaimTemplateOption?: VolumeClaimTemplatesOption;
5830
5905
  }
5831
5906
  /**
5832
5907
  * UpdateApiTimeouts请求参数结构体
@@ -5854,7 +5929,7 @@ export interface Metric {
5854
5929
  */
5855
5930
  Name?: string;
5856
5931
  /**
5857
- * 指标计算方式
5932
+ * 指标计算方式,可选值: none:无,sum:求和,exclusive:独占值,avg:平均值,max:最大值,min:最小值,percentage_50:50分位数,percentage_75:75分位数,percentage_95:95分位数,percentage_99:99分位数,bucket_5:分桶统计。
5858
5933
  */
5859
5934
  Function?: string;
5860
5935
  }
@@ -5876,11 +5951,11 @@ export interface DescribeOverviewInvocationResponse {
5876
5951
  */
5877
5952
  export interface ShrinkInstancesRequest {
5878
5953
  /**
5879
- * 部署组ID
5954
+ * 部署组ID,可通过调用[获取虚拟机部署组列表](https://cloud.tencent.com/document/api/649/36065)接口时出参中的Result.Content.GroupId,或登录[控制台](https://console.cloud.tencent.com/tsf/app-detail?rid=1&id=application-aaaaaaaa&tab=publish&subTab=group)选择对应应用进入应用部署页面查看,同时也是调用[创建部署组](https://cloud.tencent.com/document/api/649/36074)接口返回的Result值
5880
5955
  */
5881
5956
  GroupId: string;
5882
5957
  /**
5883
- * 下线机器实例ID列表
5958
+ * 实例ID列表,实例ID可通过调用[查询虚拟机部署组云主机列表](https://cloud.tencent.com/document/product/649/36066)接口时出参中的Result.Content.InstanceId,或登录[控制台](https://console.cloud.tencent.com/tsf/resource-detail?rid=1&id=cluster-aaaaaaaa)选择对应的虚拟机集群查看云主机信息,同时也是[集群添加云主机](https://cloud.tencent.com/document/product/649/41225?ls=doc-search!current)接口的的返回值Result中的节点列表
5884
5959
  */
5885
5960
  InstanceIdList: Array<string>;
5886
5961
  }
@@ -5889,23 +5964,23 @@ export interface ShrinkInstancesRequest {
5889
5964
  */
5890
5965
  export interface DescribeSimpleNamespacesRequest {
5891
5966
  /**
5892
- * 命名空间ID列表,不传入时查询全量
5967
+ * 命名空间ID列表,按照【命名空间ID列表】进行过滤,可通过调用[DescribeNamespaces](https://cloud.tencent.com/document/product/649/36096)查询已创建的命名空间列表或登录控制台进行查看;也可以调用[CreateNamespace](https://cloud.tencent.com/document/product/649/36098)创建新的命名空间。
5893
5968
  */
5894
5969
  NamespaceIdList?: Array<string>;
5895
5970
  /**
5896
- * 集群ID,不传入时查询全量
5971
+ * 集群ID,按照【集群ID】进行过滤,可通过调用[DescribeClusters](https://cloud.tencent.com/document/product/649/85857)查询已创建的集群列表或登录控制台进行查看;也可以调用[CreateCluster](https://cloud.tencent.com/document/product/649/36049)创建新的集群。仅在集群下无部署组、命名空间、云主机时可以删除。
5897
5972
  */
5898
5973
  ClusterId?: string;
5899
5974
  /**
5900
- * 每页条数
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)
5901
5976
  */
5902
5977
  Limit?: number;
5903
5978
  /**
5904
- * 起始偏移量
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)
5905
5980
  */
5906
5981
  Offset?: number;
5907
5982
  /**
5908
- * 命名空间ID,不传入时查询全量
5983
+ * 命名空间ID,按照【命名空间ID】进行过滤,可通过调用[DescribeNamespaces](https://cloud.tencent.com/document/product/649/36096)查询已创建的命名空间列表或登录控制台进行查看;也可以调用[CreateNamespace](https://cloud.tencent.com/document/product/649/36098)创建新命名空间。
5909
5984
  */
5910
5985
  NamespaceId?: string;
5911
5986
  /**
@@ -5917,7 +5992,7 @@ export interface DescribeSimpleNamespacesRequest {
5917
5992
  */
5918
5993
  SearchWord?: string;
5919
5994
  /**
5920
- * 查询的命名空间类型列表
5995
+ * 查询的命名空间类型列表。DEF:默认普通命名空间。GLOBAL:全局命名空间。
5921
5996
  */
5922
5997
  NamespaceTypeList?: Array<string>;
5923
5998
  /**
@@ -5925,7 +6000,7 @@ export interface DescribeSimpleNamespacesRequest {
5925
6000
  */
5926
6001
  NamespaceName?: string;
5927
6002
  /**
5928
- * 通过是否是默认命名空间过滤,不传表示拉取全部命名空间。0:默认命名空间。1:非默认命名空间
6003
+ * 通过是否是默认命名空间过滤,不传表示拉取全部命名空间。0:默认命名空间。1:非默认命名空间。
5929
6004
  */
5930
6005
  IsDefault?: string;
5931
6006
  /**
@@ -5938,7 +6013,7 @@ export interface DescribeSimpleNamespacesRequest {
5938
6013
  */
5939
6014
  export interface ExecuteTaskFlowResponse {
5940
6015
  /**
5941
- * 工作流批次ID
6016
+ * 操作成功返回工作流批次ID,操作失败返回空字符串。
5942
6017
  */
5943
6018
  Result?: string;
5944
6019
  /**
@@ -5965,6 +6040,7 @@ export interface DescribeClustersResponse {
5965
6040
  export interface SearchBusinessLogRequest {
5966
6041
  /**
5967
6042
  * 日志配置项ID
6043
+ 可通过调用[DescribeBusinessLogConfigs](https://cloud.tencent.com/document/product/649/75777)查询已创建的日志配置项列表或登录[控制台](https://console.cloud.tencent.com/tsf/observable/log?rid=1)进行查看
5968
6044
  */
5969
6045
  ConfigId: string;
5970
6046
  /**
@@ -5972,11 +6048,11 @@ export interface SearchBusinessLogRequest {
5972
6048
  */
5973
6049
  InstanceIds?: Array<string>;
5974
6050
  /**
5975
- * 开始时间
6051
+ * 开始时间,格式yyyy-MM-dd HH:mm:ss
5976
6052
  */
5977
6053
  StartTime?: string;
5978
6054
  /**
5979
- * 结束时间
6055
+ * 结束时间,格式yyyy-MM-dd HH:mm:ss
5980
6056
  */
5981
6057
  EndTime?: string;
5982
6058
  /**
@@ -6001,14 +6077,15 @@ export interface SearchBusinessLogRequest {
6001
6077
  SearchWords?: Array<string>;
6002
6078
  /**
6003
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)进行查看
6004
6081
  */
6005
6082
  GroupIds?: Array<string>;
6006
6083
  /**
6007
- * 检索类型,取值"LUCENE", "REGEXP", "NORMAL"
6084
+ * 检索类型,取值 LUCENE:Lucene检索,REGEXP:正则检索,NORMAL:普通检索
6008
6085
  */
6009
6086
  SearchWordType?: string;
6010
6087
  /**
6011
- * 批量请求类型,取值"page"或"scroll"
6088
+ * 批量请求类型,取值 PAGE:分页查询,SCROLL:滚动查询,SEARCHAFTER:游标查询,默认值PAGE
6012
6089
  */
6013
6090
  BatchType?: string;
6014
6091
  /**
@@ -6038,7 +6115,7 @@ export interface ExpandGroupResponse {
6038
6115
  */
6039
6116
  export interface DescribePublicConfigsResponse {
6040
6117
  /**
6041
- * 分页后的全局配置项列表
6118
+ * 分页后的全局配置项列表。
6042
6119
  */
6043
6120
  Result?: TsfPageConfig;
6044
6121
  /**
@@ -6220,7 +6297,7 @@ export interface ApiDefinitionDescr {
6220
6297
  */
6221
6298
  export interface DescribeLaneRulesResponse {
6222
6299
  /**
6223
- * 泳道规则列表
6300
+ * 灰度发布规则列表。
6224
6301
  */
6225
6302
  Result?: LaneRules;
6226
6303
  /**
@@ -6237,11 +6314,11 @@ export interface DescribeImageRepositoryRequest {
6237
6314
  */
6238
6315
  SearchWord?: string;
6239
6316
  /**
6240
- * 偏移量,取值从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)
6241
6318
  */
6242
6319
  Offset?: number;
6243
6320
  /**
6244
- * 分页个数,默认为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)
6245
6322
  */
6246
6323
  Limit?: number;
6247
6324
  /**
@@ -6249,7 +6326,7 @@ export interface DescribeImageRepositoryRequest {
6249
6326
  */
6250
6327
  RepoType?: string;
6251
6328
  /**
6252
- * 应用id
6329
+ * 应用ID,可通过调用[DescribeApplications](https://cloud.tencent.com/document/api/649/36090)查询已创建的应用列表或登录控制台进行查看;也可以调用[CreateApplication](https://cloud.tencent.com/document/api/649/36094)创建新的应用。
6253
6330
  */
6254
6331
  ApplicationId?: string;
6255
6332
  /**
@@ -6296,11 +6373,13 @@ export interface TsfPageUnitRule {
6296
6373
  */
6297
6374
  export interface OperateApplicationTcrBindingRequest {
6298
6375
  /**
6299
- * bind 或 unbind
6376
+ * 指定操作类型,目前支持:
6377
+ - `bind`:绑定(默认)
6378
+ - `unbind`:解除绑定
6300
6379
  */
6301
6380
  Command?: string;
6302
6381
  /**
6303
- * 应用id
6382
+ * 应用ID,可通过调用[DescribeApplications](https://cloud.tencent.com/document/api/649/36090)查询已创建的应用列表或登录控制台进行查看;也可以调用[CreateApplication](https://cloud.tencent.com/document/api/649/36094)创建新的应用。
6304
6383
  */
6305
6384
  ApplicationId?: string;
6306
6385
  /**
@@ -6322,7 +6401,7 @@ export interface DescribeApiGroupRequest {
6322
6401
  */
6323
6402
  export interface AssociateBusinessLogConfigResponse {
6324
6403
  /**
6325
- * 操作结果
6404
+ * 操作结果,true:成功,false:失败
6326
6405
  */
6327
6406
  Result?: boolean;
6328
6407
  /**
@@ -6364,7 +6443,8 @@ export interface DescribeGatewayApisRequest {
6364
6443
  */
6365
6444
  export interface AssociateConfigWithGroupRequest {
6366
6445
  /**
6367
- * 配置项id
6446
+ * 配置项ID
6447
+ 可通过调用[DescribeBusinessLogConfigs](https://cloud.tencent.com/document/product/649/75777)查询已创建的日志配置项列表或登录[控制台](https://console.cloud.tencent.com/tsf/observable/log?rid=1)进行查看
6368
6448
  */
6369
6449
  ConfigId: string;
6370
6450
  /**
@@ -6376,11 +6456,13 @@ export interface AssociateConfigWithGroupRequest {
6376
6456
  */
6377
6457
  SelectAll?: number;
6378
6458
  /**
6379
- * 命名空间id
6459
+ * 命名空间ID
6460
+ 可通过[DescribeSimpleNamespaces](https://cloud.tencent.com/document/product/649/36096)查询已经创建的命名空间,也可以通过登录[控制台](https://console.cloud.tencent.com/tsf/resource?rid=1&tab=namespace)查看
6380
6461
  */
6381
6462
  NamespaceId?: string;
6382
6463
  /**
6383
- * 集群id
6464
+ * 集群ID
6465
+ 可通过[DescribeClusters](https://cloud.tencent.com/document/product/649/85857)查询已经创建的集群列表,也可以通过登录[控制台](https://console.cloud.tencent.com/tsf/resource?rid=1)查看
6384
6466
  */
6385
6467
  ClusterId?: string;
6386
6468
  /**
@@ -6524,7 +6606,7 @@ export interface ImageRepositoryResult {
6524
6606
  */
6525
6607
  export interface ModifyTaskResponse {
6526
6608
  /**
6527
- * 更新是否成功
6609
+ * 更新是否成功。true:操作成功、false:操作失败
6528
6610
  */
6529
6611
  Result?: boolean;
6530
6612
  /**
@@ -6576,10 +6658,27 @@ export interface DeleteUnitNamespacesRequest {
6576
6658
  */
6577
6659
  export interface DescribeGroupRequest {
6578
6660
  /**
6579
- * 部署组ID
6661
+ * 部署组ID,可通过调用[DescribeGroups](https://cloud.tencent.com/document/api/649/36065)查询已创建的部署组列表或登录控制台进行查看;也可以调用[CreateGroup](https://cloud.tencent.com/document/api/649/36074)创建新的部署组。
6580
6662
  */
6581
6663
  GroupId: string;
6582
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
+ }
6583
6682
  /**
6584
6683
  * 微服务网关单元化规则项
6585
6684
  */
@@ -6646,7 +6745,9 @@ export interface UnitRuleItem {
6646
6745
  */
6647
6746
  export interface UpdateConfigTemplateResponse {
6648
6747
  /**
6649
- * 更新成功: true / 更新失败: false
6748
+ * 更新结果。
6749
+ - true:成功
6750
+ - false:失败
6650
6751
  */
6651
6752
  Result?: boolean;
6652
6753
  /**
@@ -6686,17 +6787,17 @@ export interface HealthCheckSetting {
6686
6787
  */
6687
6788
  ActionType: string;
6688
6789
  /**
6689
- * 容器延时启动健康检查的时间。
6790
+ * 容器延时启动健康检查的时间,单位秒。
6690
6791
  注意:此字段可能返回 null,表示取不到有效值。
6691
6792
  */
6692
6793
  InitialDelaySeconds?: number;
6693
6794
  /**
6694
- * 每次健康检查响应的最大超时时间。
6795
+ * 每次健康检查响应的最大超时时间,单位秒。
6695
6796
  注意:此字段可能返回 null,表示取不到有效值。
6696
6797
  */
6697
6798
  TimeoutSeconds?: number;
6698
6799
  /**
6699
- * 进行健康检查的时间间隔。
6800
+ * 进行健康检查的时间间隔,单位秒。
6700
6801
  注意:此字段可能返回 null,表示取不到有效值。
6701
6802
  */
6702
6803
  PeriodSeconds?: number;
@@ -6741,7 +6842,7 @@ export interface HealthCheckSetting {
6741
6842
  */
6742
6843
  export interface DeleteLaneRuleRequest {
6743
6844
  /**
6744
- * 泳道规则Id
6845
+ * 灰度发布规则ID。该参数可以通过调用 [DescribeLaneRules](https://cloud.tencent.com/document/product/649/44505) 的返回值中的 RuleId 字段来获取或通过登录[控制台](https://console.cloud.tencent.com/tse/tsf-consul?tab=grayscale&subTab=lanerule)查看;也可以调用[CreateLaneRule](https://cloud.tencent.com/document/product/649/44507)创建新的泳道规则。
6745
6846
  */
6746
6847
  RuleId: string;
6747
6848
  }
@@ -7190,7 +7291,7 @@ export interface DescribePathRewritesRequest {
7190
7291
  */
7191
7292
  export interface ShrinkGroupRequest {
7192
7293
  /**
7193
- * 部署组ID
7294
+ * 部署组ID,可通过调用[DescribeGroups](https://cloud.tencent.com/document/api/649/36065)查询已创建的部署组列表或登录控制台进行查看;也可以调用[CreateGroup](https://cloud.tencent.com/document/api/649/36074)创建新的部署组。
7194
7295
  */
7195
7296
  GroupId: string;
7196
7297
  }
@@ -7212,12 +7313,12 @@ export interface TsfPageStdoutLogV2 {
7212
7313
  */
7213
7314
  ScrollId?: string;
7214
7315
  /**
7215
- * 查询状态
7316
+ * 查询状态,SUCCESS:查询成功完成,ERROR_RANGE_EXCEED:查询范围过大异常,ERROR_COMPLEX_CONDITION:查询条件复杂异常,ERROR_OTHER_CAUSE:其他异常
7216
7317
  注意:此字段可能返回 null,表示取不到有效值。
7217
7318
  */
7218
7319
  Status?: string;
7219
7320
  /**
7220
- * 游标ID
7321
+ * 查询es使用searchAfter时,游标
7221
7322
  */
7222
7323
  SearchAfter?: Array<string>;
7223
7324
  }
@@ -7239,7 +7340,7 @@ export interface RepositoryList {
7239
7340
  */
7240
7341
  export interface CreateLaneRuleResponse {
7241
7342
  /**
7242
- * 泳道规则Id
7343
+ * 灰度发布规则ID。
7243
7344
  */
7244
7345
  Result?: string;
7245
7346
  /**
@@ -7317,11 +7418,11 @@ export interface DescribeGroupsWithPluginResponse {
7317
7418
  */
7318
7419
  export interface AddInstancesRequest {
7319
7420
  /**
7320
- * 集群ID
7421
+ * 集群ID,按照【集群ID】进行过滤,可通过调用[DescribeClusters](https://cloud.tencent.com/document/product/649/85857)查询已创建的集群列表或登录控制台进行查看;也可以调用[CreateCluster](https://cloud.tencent.com/document/product/649/36049)创建新的集群。仅在集群下无部署组、命名空间、云主机时可以删除。
7321
7422
  */
7322
7423
  ClusterId: string;
7323
7424
  /**
7324
- * 云主机ID列表
7425
+ * 云主机ID列表,可通过调用[DescribeInstances](https://cloud.tencent.com/document/api/213/15728)查询已创建的云主机列表或登录控制台进行查看;也可以调用[RunInstances](https://cloud.tencent.com/document/api/213/15730)创建新的云主机。
7325
7426
  */
7326
7427
  InstanceIdList: Array<string>;
7327
7428
  /**
@@ -7650,7 +7751,7 @@ export interface CreateTaskFlowRequest {
7650
7751
  */
7651
7752
  export interface CreateFileConfigWithDetailRespResponse {
7652
7753
  /**
7653
- * 文件配置项
7754
+ * 文件配置项。
7654
7755
  */
7655
7756
  Result?: FileConfig;
7656
7757
  /**
@@ -7663,23 +7764,23 @@ export interface CreateFileConfigWithDetailRespResponse {
7663
7764
  */
7664
7765
  export interface CreateConfigTemplateWithDetailRespRequest {
7665
7766
  /**
7666
- * 配置模板名称
7767
+ * 配置模板名称,最多支持60个字符,只能包含字母、数字及分隔符(“-”),且不能以分隔符开头或结尾。
7667
7768
  */
7668
7769
  ConfigTemplateName: string;
7669
7770
  /**
7670
- * 配置模板对应的微服务框架
7771
+ * 配置模板对应的微服务框架。- Ribbon:Ribbon类型配置模板- Hystrix:Hystrix类型配置模板- Zuul:Zuul类型配置模板- customize:自定义类型配置模板。
7671
7772
  */
7672
7773
  ConfigTemplateType: string;
7673
7774
  /**
7674
- * 配置模板数据
7775
+ * 配置模板数据。
7675
7776
  */
7676
7777
  ConfigTemplateValue: string;
7677
7778
  /**
7678
- * 配置模板描述
7779
+ * 配置模板描述,最多支持200个字符。
7679
7780
  */
7680
7781
  ConfigTemplateDesc?: string;
7681
7782
  /**
7682
- *
7783
+ * 需要绑定的数据集ID。该参数可以通过调用 [DescribePrograms](https://cloud.tencent.com/document/product/649/73477) 的返回值中的 ProgramId 字段来获取或通过登录[控制台](https://console.cloud.tencent.com/tsf/privilege?tab=program&roleId=role-yrle4doy)查看;也可以调用[CreateProgram](https://cloud.tencent.com/document/product/649/108544)创建新的数据集。
7683
7784
  */
7684
7785
  ProgramIdList?: Array<string>;
7685
7786
  }
@@ -7731,7 +7832,7 @@ export interface UnbindApiGroupResponse {
7731
7832
  */
7732
7833
  export interface DescribeGroupReleaseResponse {
7733
7834
  /**
7734
- * 部署组发布的相关信息
7835
+ * 部署组发布的相关信息。
7735
7836
  */
7736
7837
  Result?: GroupRelease;
7737
7838
  /**
@@ -7779,11 +7880,11 @@ export interface GatewayGroupIds {
7779
7880
  */
7780
7881
  export interface DescribeInvocationMetricDataDimensionRequest {
7781
7882
  /**
7782
- * 开始时间
7883
+ * 开始时间,格式yyyy-MM-dd HH:mm:ss
7783
7884
  */
7784
7885
  StartTime: string;
7785
7886
  /**
7786
- * 结束时间
7887
+ * 结束时间,格式yyyy-MM-dd HH:mm:ss
7787
7888
  */
7788
7889
  EndTime: string;
7789
7890
  /**
@@ -7795,7 +7896,7 @@ export interface DescribeInvocationMetricDataDimensionRequest {
7795
7896
  */
7796
7897
  Limit: number;
7797
7898
  /**
7798
- * 聚合维度
7899
+ * 聚合维度。可选值 NamespaceId:命名空间ID,GroupId:部署组ID,InstanceId:实例ID,ApplicationId:应用ID,OperationMethod:执行方法,OperationName:执行名称,ServiceName:服务名,UpstreamNamespaceId:上游命名空间ID
7799
7900
  */
7800
7901
  DimensionName: string;
7801
7902
  /**
@@ -7803,7 +7904,7 @@ export interface DescribeInvocationMetricDataDimensionRequest {
7803
7904
  */
7804
7905
  SearchWord?: string;
7805
7906
  /**
7806
- * 维度
7907
+ * 构建维度
7807
7908
  */
7808
7909
  MetricDimensionValues?: Array<MetricDimensionValue>;
7809
7910
  }
@@ -8027,7 +8128,8 @@ export interface GroupUseStatisticsEntity {
8027
8128
  */
8028
8129
  export interface DescribeBusinessLogConfigRequest {
8029
8130
  /**
8030
- * 配置项ID
8131
+ * 日志配置项ID
8132
+ 可通过调用[DescribeBusinessLogConfigs](https://cloud.tencent.com/document/product/649/75777)查询已创建的日志配置项列表或登录[控制台](https://console.cloud.tencent.com/tsf/observable/log?rid=1)进行查看
8031
8133
  */
8032
8134
  ConfigId: string;
8033
8135
  }
@@ -8110,7 +8212,7 @@ export interface ImageTag {
8110
8212
  */
8111
8213
  export interface ExecuteTaskFlowRequest {
8112
8214
  /**
8113
- * 工作流 ID
8215
+ * 工作流 ID。[工作流管理](https://console.cloud.tencent.com/tsf/tct?rid=1&tab=workflowManage)列表页查看工作流ID。
8114
8216
  */
8115
8217
  FlowId?: string;
8116
8218
  }
@@ -8132,7 +8234,7 @@ export interface DescribeBusinessLogConfigResponse {
8132
8234
  */
8133
8235
  export interface TerminateTaskFlowBatchRequest {
8134
8236
  /**
8135
- * 工作流批次 ID
8237
+ * 工作流批次 ID,在[工作流执行记录](https://console.cloud.tencent.com/tsf/tct?rid=1&tab=taskflow)列表页第一列获取。
8136
8238
  */
8137
8239
  FlowBatchId: string;
8138
8240
  }
@@ -8438,7 +8540,7 @@ export interface ServiceSetting {
8438
8540
  */
8439
8541
  LoadBalancerProvisioner?: string;
8440
8542
  /**
8441
- * 负载均衡类型
8543
+ * 负载均衡类型,Intranet表示内网,Internet表示外网
8442
8544
  */
8443
8545
  LoadBalancingType?: string;
8444
8546
  /**
@@ -8483,11 +8585,11 @@ export interface ServiceSetting {
8483
8585
  */
8484
8586
  export interface ModifyUploadInfoRequest {
8485
8587
  /**
8486
- * 应用ID
8588
+ * 应用ID,通过调用DescribeApplications接口[获取应用列表](https://cloud.tencent.com/document/api/649/36090)从而获取应用ID,或登录[控制台](https://console.cloud.tencent.com/tsf/app?rid=1)进行查看,调用CreateApplication接口[创建应用](https://cloud.tencent.com/document/product/649/36094)时的返回值
8487
8589
  */
8488
8590
  ApplicationId: string;
8489
8591
  /**
8490
- * 调用DescribeUploadInfo接口时返回的软件包ID
8592
+ * 软件包ID可通过调用DescribeUploadInfo接口时[获取上传程序包信息](https://cloud.tencent.com/document/api/649/36078)返回的COS上传信息获取,登录[控制台](https://console.cloud.tencent.com/tsf/product?rid=1)进行查看
8491
8593
  */
8492
8594
  PkgId: string;
8493
8595
  /**
@@ -8507,7 +8609,7 @@ export interface ModifyUploadInfoRequest {
8507
8609
  */
8508
8610
  RepositoryType?: string;
8509
8611
  /**
8510
- * 程序包仓库id
8612
+ * 仓库ID,可通过调用[仓库信息查询类](https://cloud.tencent.com/document/api/649/45925)接口时出参中的RepositoryId,或登录[控制台](https://console.cloud.tencent.com/tsf/product?rid=1)进行查看
8511
8613
  */
8512
8614
  RepositoryId?: string;
8513
8615
  }
@@ -8594,7 +8696,9 @@ export interface CreatePathRewritesWithDetailRespRequest {
8594
8696
  */
8595
8697
  export interface DeleteFileConfigResponse {
8596
8698
  /**
8597
- * 删除结果
8699
+ * 删除结果。
8700
+ - true:成功
8701
+ - false:失败
8598
8702
  */
8599
8703
  Result?: boolean;
8600
8704
  /**
@@ -8607,7 +8711,10 @@ export interface DeleteFileConfigResponse {
8607
8711
  */
8608
8712
  export interface ResourceTaskStatusResult {
8609
8713
  /**
8610
- * 任务的执行状态
8714
+ * 变更状态:
8715
+ - `0`:成功
8716
+ - `1`:失败
8717
+ - `2`:执行中
8611
8718
  */
8612
8719
  TaskStatus?: number;
8613
8720
  }
@@ -8666,7 +8773,7 @@ export interface DeleteApiRateLimitRuleResponse {
8666
8773
  */
8667
8774
  export interface DeleteFileConfigRequest {
8668
8775
  /**
8669
- * 文件配置项ID
8776
+ * 文件配置项ID。该参数可以通过调用 [DescribeFileConfigs](https://cloud.tencent.com/document/product/649/58593) 的返回值中的 ConfigId 字段来获取或通过登录[控制台](https://console.cloud.tencent.com/tse/tsf-consul?subTab=file)-详情页查看;也可以调用[CreateFileConfig](https://cloud.tencent.com/document/product/649/58594)创建新的文件配置。
8670
8777
  */
8671
8778
  ConfigId: string;
8672
8779
  }
@@ -8675,7 +8782,7 @@ export interface DeleteFileConfigRequest {
8675
8782
  */
8676
8783
  export interface DescribePublicConfigSummaryResponse {
8677
8784
  /**
8678
- * 分页的全局配置统计信息列表
8785
+ * 分页的全局配置统计信息列表。
8679
8786
  */
8680
8787
  Result?: TsfPageConfig;
8681
8788
  /**
@@ -8688,15 +8795,15 @@ export interface DescribePublicConfigSummaryResponse {
8688
8795
  */
8689
8796
  export interface DescribePublicConfigReleaseLogsRequest {
8690
8797
  /**
8691
- * 命名空间ID,不传入时查询全量
8798
+ * 命名空间ID,不传入时查询全量。该参数可以通过调用 [DescribeSimpleNamespaces](https://cloud.tencent.com/document/api/649/36096) 的返回值中的 NamespaceId 字段来获取或通过登录[控制台](https://console.cloud.tencent.com/tsf/resource?tab=namespace)查看;也可以调用[CreateNamespace](https://cloud.tencent.com/document/product/649/36098)创建新的命名空间。
8692
8799
  */
8693
8800
  NamespaceId?: string;
8694
8801
  /**
8695
- * 偏移量,默认为0
8802
+ * 偏移量,默认为0
8696
8803
  */
8697
8804
  Offset?: number;
8698
8805
  /**
8699
- * 每页条数,默认为20
8806
+ * 返回数量,默认为20,最大值为100。
8700
8807
  */
8701
8808
  Limit?: number;
8702
8809
  }
@@ -8715,7 +8822,7 @@ export interface ShardArgument {
8715
8822
  ShardValue?: string;
8716
8823
  }
8717
8824
  /**
8718
- * 指标维度多值匹配
8825
+ * 指标维度多值匹配。可选值 NamespaceId:命名空间ID,GroupId:部署组ID,InstanceId:实例ID,ApplicationId:应用ID,OperationMethod:执行方法,OperationName:执行名称,ServiceName:服务名,UpstreamNamespaceId:上游命名空间ID
8719
8826
  */
8720
8827
  export interface MetricDimensionValue {
8721
8828
  /**
@@ -8762,15 +8869,15 @@ export interface DescribeApplicationAttributeResponse {
8762
8869
  */
8763
8870
  export interface ModifyLaneRequest {
8764
8871
  /**
8765
- * 泳道ID
8872
+ * 泳道配置ID。该参数可以通过调用 [DescribeLanes](https://cloud.tencent.com/document/product/649/44504) 的返回值中的 LaneId 字段来获取或通过登录[控制台](https://console.cloud.tencent.com/tse/tsf-consul?tab=grayscale&subTab=lane)查看;也可以调用[CreateLane](https://cloud.tencent.com/document/product/649/44508)创建新的泳道配置。
8766
8873
  */
8767
8874
  LaneId: string;
8768
8875
  /**
8769
- * 泳道名称
8876
+ * 泳道配置名称,最多支持60个字符,只能包含字母、数字及分隔符(“-”),且不能以分隔符开头或结尾。
8770
8877
  */
8771
8878
  LaneName: string;
8772
8879
  /**
8773
- * 备注
8880
+ * 备注,最多支持200个字符。
8774
8881
  */
8775
8882
  Remark: string;
8776
8883
  }
@@ -8779,23 +8886,23 @@ export interface ModifyLaneRequest {
8779
8886
  */
8780
8887
  export interface DescribeLanesRequest {
8781
8888
  /**
8782
- * 每页展示的条数
8889
+ * 返回数量,默认为20,最大值为100。
8783
8890
  */
8784
8891
  Limit?: number;
8785
8892
  /**
8786
- * 翻页偏移量
8893
+ * 偏移量,默认为0。
8787
8894
  */
8788
8895
  Offset?: number;
8789
8896
  /**
8790
- * 搜索关键字
8897
+ * 搜索关键字。
8791
8898
  */
8792
8899
  SearchWord?: string;
8793
8900
  /**
8794
- *
8901
+ * 泳道配置ID。该参数可以通过调用 [DescribeLanes](https://cloud.tencent.com/document/product/649/44504) 的返回值中的 LaneId 字段来获取或通过登录[控制台](https://console.cloud.tencent.com/tse/tsf-consul?tab=grayscale&subTab=lane)查看;也可以调用[CreateLane](https://cloud.tencent.com/document/product/649/44508)创建新的泳道配置。
8795
8902
  */
8796
8903
  LaneIdList?: Array<string>;
8797
8904
  /**
8798
- *
8905
+ * 忽略传参,业务预留字段。
8799
8906
  */
8800
8907
  DisableProgramAuthCheck?: boolean;
8801
8908
  }
@@ -8877,31 +8984,33 @@ export interface BusinesLogConfigAssociatedGroup {
8877
8984
  */
8878
8985
  export interface CreatePublicConfigRequest {
8879
8986
  /**
8880
- * 配置项名称
8987
+ * 配置名称,最长60个字符,只能包含字母、数字及分隔符(“-”、“_”),且不能以分隔符开头或结尾。
8881
8988
  */
8882
8989
  ConfigName: string;
8883
8990
  /**
8884
- * 配置项版本
8991
+ * 配置版本,只能包含小写字母、数字及分隔符("-","."),且必须以小写字母或数字开头、以小写字母或数字结尾,中间不能有连续的"-"或"."。
8885
8992
  */
8886
8993
  ConfigVersion: string;
8887
8994
  /**
8888
- * 配置项值,总是接收yaml格式的内容
8995
+ * 配置项值,总是接收yaml格式的内容。
8889
8996
  */
8890
8997
  ConfigValue: string;
8891
8998
  /**
8892
- * 配置项版本描述
8999
+ * 配置项版本描述,最多支持200个字符。
8893
9000
  */
8894
9001
  ConfigVersionDesc?: string;
8895
9002
  /**
8896
- * 配置项类型
9003
+ * 配置项类型,固定值。
8897
9004
  */
8898
9005
  ConfigType?: string;
8899
9006
  /**
8900
- * Base64编码的配置项
9007
+ * Base64编码的配置项。
9008
+ - true:开启
9009
+ - false:关闭
8901
9010
  */
8902
9011
  EncodeWithBase64?: boolean;
8903
9012
  /**
8904
- *
9013
+ * 需要绑定的数据集ID。该参数可以通过调用 [DescribePrograms](https://cloud.tencent.com/document/product/649/73477) 的返回值中的 ProgramId 字段来获取或通过登录[控制台](https://console.cloud.tencent.com/tsf/privilege?tab=program&roleId=role-yrle4doy)查看;也可以调用[CreateProgram](https://cloud.tencent.com/document/product/649/108544)创建新的数据集。
8905
9014
  */
8906
9015
  ProgramIdList?: Array<string>;
8907
9016
  }
@@ -9203,7 +9312,7 @@ export interface BindPluginResponse {
9203
9312
  */
9204
9313
  export interface RedoTaskFlowBatchRequest {
9205
9314
  /**
9206
- * 工作流批次 ID
9315
+ * 工作流批次 ID。在[工作流管理](https://console.cloud.tencent.com/tsf/tct?rid=1&tab=workflowManage)页面,点击第一列的工作流ID进入工作流执行记录列表页面,第一列的内容即为工作流批次ID。
9207
9316
  */
9208
9317
  FlowBatchId: string;
9209
9318
  }
@@ -9225,15 +9334,15 @@ export interface TsfPageUnitNamespace {
9225
9334
  */
9226
9335
  export interface CreateMicroserviceWithDetailRespRequest {
9227
9336
  /**
9228
- * 命名空间ID
9337
+ * 命名空间ID。该参数可以通过调用 [DescribeSimpleNamespaces](https://cloud.tencent.com/document/api/649/36096) 的返回值中的 NamespaceId 字段来获取或通过登录[控制台](https://console.cloud.tencent.com/tsf/resource?tab=namespace)查看;也可以调用[CreateNamespace](https://cloud.tencent.com/document/product/649/36098)创建新的命名空间。
9229
9338
  */
9230
9339
  NamespaceId: string;
9231
9340
  /**
9232
- * 微服务名称
9341
+ * 微服务名称,最多支持128个字符。
9233
9342
  */
9234
9343
  MicroserviceName: string;
9235
9344
  /**
9236
- * 微服务描述信息
9345
+ * 微服务描述信息,最多支持200个字符。
9237
9346
  */
9238
9347
  MicroserviceDesc?: string;
9239
9348
  }
@@ -9242,7 +9351,7 @@ export interface CreateMicroserviceWithDetailRespRequest {
9242
9351
  */
9243
9352
  export interface BusinessLogConfigSchema {
9244
9353
  /**
9245
- * 解析规则类型
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日志)。
9246
9355
  */
9247
9356
  SchemaType: number;
9248
9357
  /**
@@ -9261,7 +9370,7 @@ export interface BusinessLogConfigSchema {
9261
9370
  */
9262
9371
  SchemaMultilinePattern?: string;
9263
9372
  /**
9264
- * 解析规则创建时间
9373
+ * 解析规则创建时间,格式为yyyy-MM-dd HH:mm:ss
9265
9374
  */
9266
9375
  SchemaCreateTime?: string;
9267
9376
  /**
@@ -9296,15 +9405,15 @@ export interface MetricDataSingleValue {
9296
9405
  */
9297
9406
  export interface StopTaskExecuteRequest {
9298
9407
  /**
9299
- * 任务执行ID
9408
+ * 任务执行ID。在[任务管理](https://console.cloud.tencent.com/tsf/tct?rid=1)页面点击任务ID进入任务详情,进入执行记录页,点击批次ID进入执行详情列表页,第一列即为任务执行ID。
9300
9409
  */
9301
9410
  ExecuteId: string;
9302
9411
  /**
9303
- * 任务批次ID
9412
+ * 任务批次ID。在[任务管理](https://console.cloud.tencent.com/tsf/tct?rid=1)页面点击任务ID进入任务详情,进入执行记录列表页,第一列即为任务批次ID。
9304
9413
  */
9305
9414
  BatchId?: string;
9306
9415
  /**
9307
- * 任务ID
9416
+ * 任务ID。在[任务管理](https://console.cloud.tencent.com/tsf/tct?rid=1)列表页面可以查看任务ID。
9308
9417
  */
9309
9418
  TaskId?: string;
9310
9419
  }
@@ -9322,7 +9431,7 @@ export interface DeleteApiRateLimitRuleRequest {
9322
9431
  */
9323
9432
  export interface DescribePkgsRequest {
9324
9433
  /**
9325
- * 应用ID(只传入应用ID,返回该应用下所有软件包信息)
9434
+ * 应用ID,通过调用DescribeApplications接口[获取应用列表](https://cloud.tencent.com/document/api/649/36090)从而获取应用ID,或登录[控制台](https://console.cloud.tencent.com/tsf/app?rid=1)进行查看,调用CreateApplication接口[创建应用](https://cloud.tencent.com/document/product/649/36094)时的返回值
9326
9435
  */
9327
9436
  ApplicationId: string;
9328
9437
  /**
@@ -9330,7 +9439,7 @@ export interface DescribePkgsRequest {
9330
9439
  */
9331
9440
  SearchWord?: string;
9332
9441
  /**
9333
- * 排序关键字(默认为"UploadTime":上传时间)
9442
+ * 排序关键字(默认值"UploadTime"),允许值:"UploadTime"上传时间, "name"程序包名, "size"应用大小, "id"程序包ID
9334
9443
  */
9335
9444
  OrderBy?: string;
9336
9445
  /**
@@ -9338,7 +9447,7 @@ export interface DescribePkgsRequest {
9338
9447
  */
9339
9448
  OrderType?: number;
9340
9449
  /**
9341
- * 查询起始偏移
9450
+ * 查询起始偏移,大于等于0,默认值为0
9342
9451
  */
9343
9452
  Offset?: number;
9344
9453
  /**
@@ -9346,11 +9455,11 @@ export interface DescribePkgsRequest {
9346
9455
  */
9347
9456
  Limit?: number;
9348
9457
  /**
9349
- * 程序包仓库类型
9458
+ * 程序包仓库类型,允许值:"public-demo"TSF公共demo仓库, "private"自定义仓库, "default"TSF公共仓库
9350
9459
  */
9351
9460
  RepositoryType?: string;
9352
9461
  /**
9353
- * 程序包仓库id
9462
+ * 仓库ID,可通过调用[仓库信息查询类](https://cloud.tencent.com/document/api/649/45925)接口时出参中的RepositoryId,或登录[控制台](https://console.cloud.tencent.com/tsf/product?rid=1)进行查看
9354
9463
  */
9355
9464
  RepositoryId?: string;
9356
9465
  /**
@@ -9435,15 +9544,15 @@ export interface DescribeApplicationAttributeRequest {
9435
9544
  */
9436
9545
  export interface ReleaseConfigWithDetailRespRequest {
9437
9546
  /**
9438
- * 配置ID
9547
+ * 配置ID。该参数可以通过调用 [DescribeConfigs](https://cloud.tencent.com/document/product/649/38340) 的返回值中的 ConfigId 字段来获取或通过登录[控制台](https://console.cloud.tencent.com/tse/tsf-consul?subTab=app)配置详情-配置版本页查看;也可以调用[CreateConfig](https://cloud.tencent.com/document/product/649/38348)创建新的配置。
9439
9548
  */
9440
9549
  ConfigId: string;
9441
9550
  /**
9442
- * 部署组ID
9551
+ * 部署组ID。该参数可以通过调用 [DescribeSimpleGroups](https://cloud.tencent.com/document/product/649/36064) 的返回值中的 GroupId 字段来获取或通过登录[控制台](https://console.cloud.tencent.com/tsf/resource)-查看部署组页查看;也可以调用[CreateGroup](https://cloud.tencent.com/document/product/649/36074)创建新的部署组。
9443
9552
  */
9444
9553
  GroupId: string;
9445
9554
  /**
9446
- * 发布描述
9555
+ * 发布描述,最多支持200个字符。
9447
9556
  */
9448
9557
  ReleaseDesc?: string;
9449
9558
  }
@@ -9460,19 +9569,19 @@ export interface CreateTaskRequest {
9460
9569
  */
9461
9570
  TaskContent: string;
9462
9571
  /**
9463
- * 执行类型,unicast/broadcast
9572
+ * 任务执行方式,unicast:随机单节点执行,broadcast:广播执行,shard:分片执行
9464
9573
  */
9465
9574
  ExecuteType: string;
9466
9575
  /**
9467
- * 任务类型,java
9576
+ * 任务类型。当前只支持一种任务类型。枚举值,java:Java类任务
9468
9577
  */
9469
9578
  TaskType: string;
9470
9579
  /**
9471
- * 任务超时时间, 时间单位 ms
9580
+ * 任务超时时间,取值大于0,单位:毫秒(ms
9472
9581
  */
9473
9582
  TimeOut: number;
9474
9583
  /**
9475
- * 部署组ID
9584
+ * 部署组ID。在[应用管理](https://console.cloud.tencent.com/tsf/app?rid=1),点击应用ID进入应用部署页查看部署组ID。
9476
9585
  */
9477
9586
  GroupId: string;
9478
9587
  /**
@@ -9488,7 +9597,7 @@ export interface CreateTaskRequest {
9488
9597
  */
9489
9598
  RetryInterval?: number;
9490
9599
  /**
9491
- * 分片数量
9600
+ * 分片数量,仅当任务执行方式为分片执行时需要设置该值,取值范围2~1000
9492
9601
  */
9493
9602
  ShardCount?: number;
9494
9603
  /**
@@ -9512,7 +9621,7 @@ export interface CreateTaskRequest {
9512
9621
  */
9513
9622
  TaskArgument?: string;
9514
9623
  /**
9515
- *
9624
+ * 数据集列表
9516
9625
  */
9517
9626
  ProgramIdList?: Array<string>;
9518
9627
  }
@@ -9559,7 +9668,7 @@ export interface OperationInfo {
9559
9668
  */
9560
9669
  export interface DescribePublicConfigResponse {
9561
9670
  /**
9562
- * 全局配置
9671
+ * 全局配置。
9563
9672
  注意:此字段可能返回 null,表示取不到有效值。
9564
9673
  */
9565
9674
  Result?: Config;
@@ -9586,7 +9695,9 @@ export interface DescribeUsableUnitNamespacesResponse {
9586
9695
  */
9587
9696
  export interface ReleaseFileConfigResponse {
9588
9697
  /**
9589
- * 发布结果,成功:true,失败:false。
9698
+ * 发布结果。
9699
+ - true:成功
9700
+ - false:失败
9590
9701
  */
9591
9702
  Result?: boolean;
9592
9703
  /**
@@ -9621,7 +9732,7 @@ export interface ThreadPicture {
9621
9732
  */
9622
9733
  export interface DescribeConfigResponse {
9623
9734
  /**
9624
- * 配置项
9735
+ * 配置信息。
9625
9736
  注意:此字段可能返回 null,表示取不到有效值。
9626
9737
  */
9627
9738
  Result?: Config;
@@ -9705,11 +9816,11 @@ export interface CreateApiRateLimitRuleWithDetailRespResponse {
9705
9816
  */
9706
9817
  export interface DescribeTaskRecordsRequest {
9707
9818
  /**
9708
- * 翻页偏移量。
9819
+ * 翻页偏移量。默认值为0
9709
9820
  */
9710
9821
  Offset?: number;
9711
9822
  /**
9712
- * 翻页查询单页数量。
9823
+ * 翻页查询单页数量。默认值为 20,最大值为 1000
9713
9824
  */
9714
9825
  Limit?: number;
9715
9826
  /**
@@ -9717,23 +9828,23 @@ export interface DescribeTaskRecordsRequest {
9717
9828
  */
9718
9829
  SearchWord?: string;
9719
9830
  /**
9720
- * 任务启用状态。enabled/disabled
9831
+ * 任务启用状态。一共2种状态可选,ENABLED:启用,DISABLED:停用
9721
9832
  */
9722
9833
  TaskState?: string;
9723
9834
  /**
9724
- * 分组ID。
9835
+ * 部署组ID。前往[应用管理](https://console.cloud.tencent.com/tsf/app?rid=1)点击应用ID进入应用部署列表页面获取部署组ID
9725
9836
  */
9726
9837
  GroupId?: string;
9727
9838
  /**
9728
- * 任务类型。
9839
+ * 任务类型。当前只支持一种任务类型。枚举值,java:Java类任务
9729
9840
  */
9730
9841
  TaskType?: string;
9731
9842
  /**
9732
- * 任务触发类型,UNICAST、BROADCAST。
9843
+ * 任务执行方式,unicast:随机单节点执行,broadcast:广播执行,shard:分片执行
9733
9844
  */
9734
9845
  ExecuteType?: string;
9735
9846
  /**
9736
- *
9847
+ * 任务ID列表。在[任务管理](https://console.cloud.tencent.com/tsf/tct?rid=1)列表页第一列查看任务ID。
9737
9848
  */
9738
9849
  Ids?: Array<string>;
9739
9850
  }
@@ -9792,15 +9903,15 @@ export interface ModifyContainerGroupResponse {
9792
9903
  */
9793
9904
  export interface ExclusiveInstance {
9794
9905
  /**
9795
- * 配置中心类型[RegistrationConfiguration]
9906
+ * 配置中心类型[注册中心Registration、配置中心Configuration]
9796
9907
  */
9797
9908
  CenterType?: string;
9798
9909
  /**
9799
- * 实例id
9910
+ * 实例id,通过北极星控制台获取
9800
9911
  */
9801
9912
  InstanceId?: string;
9802
9913
  /**
9803
- * 实例类型[Polaris]
9914
+ * 实例类型,例如北极星Polaris
9804
9915
  */
9805
9916
  InstanceType?: string;
9806
9917
  /**
@@ -9808,11 +9919,11 @@ export interface ExclusiveInstance {
9808
9919
  */
9809
9920
  InstanceName?: string;
9810
9921
  /**
9811
- * 实例地域id
9922
+ * 实例地域id,通过北极星控制台获取
9812
9923
  */
9813
9924
  RegionId?: string;
9814
9925
  /**
9815
- * 实例命名空间ID
9926
+ * 实例命名空间ID,通过北极星控制台获取
9816
9927
  */
9817
9928
  InstanceNamespaceId?: string;
9818
9929
  }
@@ -9821,7 +9932,7 @@ export interface ExclusiveInstance {
9821
9932
  */
9822
9933
  export interface DeleteApplicationRequest {
9823
9934
  /**
9824
- * 应用ID
9935
+ * 应用ID,可通过调用[DescribeApplications](https://cloud.tencent.com/document/api/649/36090)查询已创建的应用列表或登录控制台进行查看;也可以调用[CreateApplication](https://cloud.tencent.com/document/api/649/36094)创建新的应用。
9825
9936
  */
9826
9937
  ApplicationId: string;
9827
9938
  /**
@@ -9855,7 +9966,7 @@ export interface DescribeUnitNamespacesRequest {
9855
9966
  */
9856
9967
  export interface DeleteTaskRequest {
9857
9968
  /**
9858
- * 任务ID
9969
+ * 任务ID。在[任务管理](https://console.cloud.tencent.com/tsf/tct?rid=1)列表页第一列和任务基本信息页查看任务ID。
9859
9970
  */
9860
9971
  TaskId: string;
9861
9972
  }
@@ -9985,11 +10096,12 @@ export interface DescribeBusinessLogConfigsRequest {
9985
10096
  */
9986
10097
  SearchWord?: string;
9987
10098
  /**
9988
- *
10099
+ * 是否禁用数据集鉴权
9989
10100
  */
9990
10101
  DisableProgramAuthCheck?: boolean;
9991
10102
  /**
9992
- *
10103
+ * 日志配置项ID
10104
+ 可通过调用[DescribeBusinessLogConfigs](https://cloud.tencent.com/document/product/649/75777)查询已创建的日志配置项列表或登录[控制台](https://console.cloud.tencent.com/tsf/observable/log?rid=1)进行查看
9993
10105
  */
9994
10106
  ConfigIdList?: Array<string>;
9995
10107
  }
@@ -9998,7 +10110,7 @@ export interface DescribeBusinessLogConfigsRequest {
9998
10110
  */
9999
10111
  export interface DeleteConfigTemplateRequest {
10000
10112
  /**
10001
- *
10113
+ * 配置模板ID。该参数可以通过调用 [DescribeConfigTemplate](https://cloud.tencent.com/document/product/649/85856) 的返回值中的 ConfigTemplateId 字段来获取或通过登录[控制台](https://console.cloud.tencent.com/tse/tsf-consul?subTab=template)查看;也可以调用[CreateConfigTemplate](https://cloud.tencent.com/document/product/649/85861)创建新的配置模板。
10002
10114
  */
10003
10115
  ConfigTemplateId: string;
10004
10116
  }
@@ -10237,35 +10349,37 @@ export interface ConfigReleaseLog {
10237
10349
  */
10238
10350
  export interface CreateConfigRequest {
10239
10351
  /**
10240
- * 配置项名称
10352
+ * 配置项名称,最多支持60个字符,只能包含字母、数字及分隔符(“-”、“_”),且不能以分隔符开头或结尾。
10241
10353
  */
10242
10354
  ConfigName: string;
10243
10355
  /**
10244
- * 配置项版本
10356
+ * 配置项版本,只能包含小写字母、数字及分隔符("-","."),且必须以小写字母或数字开头、以小写字母或数字结尾,中间不能有连续的"-"或"."。
10245
10357
  */
10246
10358
  ConfigVersion: string;
10247
10359
  /**
10248
- * 配置项值
10360
+ * 配置项值。
10249
10361
  */
10250
10362
  ConfigValue: string;
10251
10363
  /**
10252
- * 应用ID
10364
+ * 应用ID。该参数可以通过调用 [DescribeApplications](https://cloud.tencent.com/document/product/649/36090) 的返回值中的 ApplicationId 字段来获取或通过登录[控制台](https://console.cloud.tencent.com/tsf/app)查看;也可以调用[CreateApplication](https://cloud.tencent.com/document/product/649/36094)创建新的应用。
10253
10365
  */
10254
10366
  ApplicationId: string;
10255
10367
  /**
10256
- * 配置项版本描述
10368
+ * 配置项版本描述,最多支持200个字符。
10257
10369
  */
10258
10370
  ConfigVersionDesc?: string;
10259
10371
  /**
10260
- * 配置项值类型
10372
+ * 配置项值类型,固定值。
10261
10373
  */
10262
10374
  ConfigType?: string;
10263
10375
  /**
10264
- * Base64编码的配置项
10376
+ * Base64编码的配置项。
10377
+ - true:开启
10378
+ - false:关闭
10265
10379
  */
10266
10380
  EncodeWithBase64?: boolean;
10267
10381
  /**
10268
- *
10382
+ * 需要绑定的数据集ID。该参数可以通过调用 [DescribePrograms](https://cloud.tencent.com/document/product/649/73477) 的返回值中的 ProgramId 字段来获取或通过登录[控制台](https://console.cloud.tencent.com/tsf/privilege?tab=program&roleId=role-yrle4doy)查看;也可以调用[CreateProgram](https://cloud.tencent.com/document/product/649/108544)创建新的数据集。
10269
10383
  */
10270
10384
  ProgramIdList?: Array<string>;
10271
10385
  }
@@ -10367,7 +10481,7 @@ export interface UpdateGatewayApiRequest {
10367
10481
  */
10368
10482
  export interface DescribeInstancesRequest {
10369
10483
  /**
10370
- * 过滤条件
10484
+ * 过滤条件,name表示过滤字段,value表示过滤字段值。
10371
10485
  */
10372
10486
  Filters?: Array<Filter>;
10373
10487
  /**
@@ -10725,27 +10839,27 @@ export interface ApplicationForPage {
10725
10839
  */
10726
10840
  export interface DescribeInvocationMetricScatterPlotRequest {
10727
10841
  /**
10728
- * 查询开始时间
10842
+ * 查询开始时间,格式yyyy-MM-dd HH:mm:ss
10729
10843
  */
10730
10844
  StartTime?: string;
10731
10845
  /**
10732
- * 查询结束时间
10846
+ * 查询结束时间,格式yyyy-MM-dd HH:mm:ss
10733
10847
  */
10734
10848
  EndTime?: string;
10735
10849
  /**
10736
- * 查询时间粒度,单位秒。可选值:60、3600、86400
10850
+ * 查询时间粒度,单位秒。可选值:60、3600、86400
10737
10851
  */
10738
10852
  Period?: number;
10739
10853
  /**
10740
- * 查询指标维度, 不能为空。可选 NamespaceId, GroupId, InstanceId, OperationName, ServiceName, PeerServiceName, PeerOperationName
10854
+ * 查询指标维度, 不能为空。Name, Valeu键值对形式。Name可选值 NamespaceId:命名空间ID,GroupId:部署组ID,InstanceId:实例ID,ApplicationId:应用ID,OperationMethod:执行方法,OperationName:执行名称,ServiceName:服务名,UpstreamNamespaceId:上游命名空间ID
10741
10855
  */
10742
10856
  MetricDimensions?: Array<MetricDimension>;
10743
10857
  /**
10744
- * 查询指标名, 不能为空。仅支持 range_count_duratioin 为 key 下的 sum 方法
10858
+ * 查询指标名, 不能为空。仅支持 range_count_duration(响应耗时分布) 为 key 下的 sum(求和) 方法
10745
10859
  */
10746
10860
  Metrics?: Array<Metric>;
10747
10861
  /**
10748
- * 视图视角。可选值:SERVER, CLIENT。默认为SERVER
10862
+ * 视图视角。可选值:SERVER:服务端, CLIENT:客户端。默认为SERVER
10749
10863
  */
10750
10864
  Kind?: string;
10751
10865
  }
@@ -10767,43 +10881,50 @@ export interface CreateTaskFlowResponse {
10767
10881
  */
10768
10882
  export interface DescribeMicroservicesRequest {
10769
10883
  /**
10770
- * 命名空间ID
10884
+ * 命名空间ID。该参数可以通过调用 [DescribeSimpleNamespaces](https://cloud.tencent.com/document/api/649/36096) 的返回值中的 NamespaceId 字段来获取或通过登录[控制台](https://console.cloud.tencent.com/tsf/resource?tab=namespace)查看;也可以调用[CreateNamespace](https://cloud.tencent.com/document/product/649/36098)创建新的命名空间。
10771
10885
  */
10772
10886
  NamespaceId: string;
10773
10887
  /**
10774
- * 搜索字段
10888
+ * 搜索字段。
10775
10889
  */
10776
10890
  SearchWord?: string;
10777
10891
  /**
10778
- * 排序字段
10892
+ * 排序字段。
10893
+ - create_time:创建时间
10894
+ 默认为创建时间,暂不支持其他值。
10779
10895
  */
10780
10896
  OrderBy?: string;
10781
10897
  /**
10782
- * 排序类型
10898
+ * 排序类型。
10899
+ - 1:倒序
10900
+ 默认为倒序,暂不支持其他值。
10783
10901
  */
10784
10902
  OrderType?: number;
10785
10903
  /**
10786
- * 偏移量
10904
+ * 偏移量,默认为0。
10787
10905
  */
10788
10906
  Offset?: number;
10789
10907
  /**
10790
- * 分页个数
10908
+ * 返回数量,默认为20,最大值为50。
10791
10909
  */
10792
10910
  Limit?: number;
10793
10911
  /**
10794
- * 状态过滤,online、offline、single_online
10912
+ * 状态。
10913
+ - online:在线
10914
+ - offline:离线
10915
+ - single_online:单点在线
10795
10916
  */
10796
10917
  Status?: Array<string>;
10797
10918
  /**
10798
- * IdList
10919
+ * 微服务ID列表。该参数可以通过调用 [DescribeMicroservices](https://cloud.tencent.com/document/product/649/36084) 的返回值中的 MicroserviceId 字段来获取或通过登录[控制台](https://console.cloud.tencent.com/tse/tsf-consul?tab=service)查看;也可以调用[CreateMicroserviceWithDetailResp](https://cloud.tencent.com/document/product/649/85860)创建新的微服务。
10799
10920
  */
10800
10921
  MicroserviceIdList?: Array<string>;
10801
10922
  /**
10802
- * 搜索的服务名列表
10923
+ * 微服务名称列表。该参数可以通过调用 [DescribeMicroservices](https://cloud.tencent.com/document/product/649/36084) 的返回值中的 MicroserviceName 字段来获取或通过登录[控制台](https://console.cloud.tencent.com/tse/tsf-consul?tab=service)查看;也可以调用[CreateMicroserviceWithDetailResp](https://cloud.tencent.com/document/product/649/85860)创建新的微服务。
10803
10924
  */
10804
10925
  MicroserviceNameList?: Array<string>;
10805
10926
  /**
10806
- * 注册中心实例id
10927
+ * 注册中心实例ID。业务预留参数,忽略传参。
10807
10928
  */
10808
10929
  ConfigCenterInstanceId?: string;
10809
10930
  }
@@ -10825,27 +10946,27 @@ export interface AddClusterInstancesResponse {
10825
10946
  */
10826
10947
  export interface DescribeInvocationMetricDataCurveRequest {
10827
10948
  /**
10828
- * 查询开始时间
10949
+ * 开始时间,格式yyyy-MM-dd HH:mm:ss
10829
10950
  */
10830
10951
  StartTime?: string;
10831
10952
  /**
10832
- * 查询结束时间
10953
+ * 结束时间,格式yyyy-MM-dd HH:mm:ss
10833
10954
  */
10834
10955
  EndTime?: string;
10835
10956
  /**
10836
- * 查询时间粒度,单位秒可选值:60、3600、86400
10957
+ * 查询时间粒度,单位秒。可选值:60、3600、86400
10837
10958
  */
10838
10959
  Period?: number;
10839
10960
  /**
10840
- * 查询指标维度,不能为空,支持 ServiceName, OperationName, PeerServiceName, PeerOperationName
10961
+ * 查询指标维度,不能为空
10841
10962
  */
10842
10963
  MetricDimensions?: Array<MetricDimension>;
10843
10964
  /**
10844
- * 查询指标名,不能为空.
10965
+ * 查询指标名,不能为空
10845
10966
  */
10846
10967
  Metrics?: Array<Metric>;
10847
10968
  /**
10848
- * 视图视角。可选值:SERVER, CLIENT。默认为SERVER
10969
+ * 视图视角。可选值:SERVER:服务端,CLIENT:客户端。默认为SERVER
10849
10970
  */
10850
10971
  Kind?: string;
10851
10972
  /**
@@ -10889,7 +11010,7 @@ export interface VmGroupOther {
10889
11010
  */
10890
11011
  OffInstanceCount?: number;
10891
11012
  /**
10892
- * 部署组状态
11013
+ * 部署组状态,Running运行中,Waiting等待中,Paused暂停中,Updating更新中,RollingBack回滚中,Abnormal异常,Unknown未知
10893
11014
  */
10894
11015
  GroupStatus?: string;
10895
11016
  /**
@@ -10920,27 +11041,27 @@ export interface DescribeTaskLastStatusResponse {
10920
11041
  */
10921
11042
  export interface DescribePublicConfigsRequest {
10922
11043
  /**
10923
- * 配置项ID,不传入时查询全量,高优先级
11044
+ * 配置ID。不传入时查询全量,高优先级。该参数可以通过调用 [DescribePublicConfigs](https://cloud.tencent.com/document/product/649/38335) 的返回值中的 ConfigId 字段来获取或通过登录[控制台](https://console.cloud.tencent.com/tse/tsf-consul?subTab=public)配置详情-配置版本页查看;也可以调用[CreatePublicConfig](https://cloud.tencent.com/document/product/649/38347)创建新的配置。
10924
11045
  */
10925
11046
  ConfigId?: string;
10926
11047
  /**
10927
- * 偏移量,默认为0
11048
+ * 偏移量,默认为0
10928
11049
  */
10929
11050
  Offset?: number;
10930
11051
  /**
10931
- * 每页条数,默认为20
11052
+ * 返回数量,默认为20,最大值为100。
10932
11053
  */
10933
11054
  Limit?: number;
10934
11055
  /**
10935
- * 配置项ID列表,不传入时查询全量,低优先级
11056
+ * 配置ID列表,不传入时查询全量,低优先级。该参数可以通过调用 [DescribePublicConfigs](https://cloud.tencent.com/document/product/649/38335) 的返回值中的 ConfigId 字段来获取或通过登录[控制台](https://console.cloud.tencent.com/tse/tsf-consul?subTab=public)配置详情-配置版本页查看;也可以调用[CreatePublicConfig](https://cloud.tencent.com/document/product/649/38347)创建新的配置。
10936
11057
  */
10937
11058
  ConfigIdList?: Array<string>;
10938
11059
  /**
10939
- * 配置项名称,精确查询,不传入时查询全量
11060
+ * 配置项名称,精确查询,不传入时查询全量。
10940
11061
  */
10941
11062
  ConfigName?: string;
10942
11063
  /**
10943
- * 配置项版本,精确查询,不传入时查询全量
11064
+ * 配置项版本,精确查询,不传入时查询全量。
10944
11065
  */
10945
11066
  ConfigVersion?: string;
10946
11067
  }
@@ -10992,7 +11113,7 @@ export interface BusinessLogConfigAssociatedGroup {
10992
11113
  */
10993
11114
  ApplicationName: string;
10994
11115
  /**
10995
- * 部署组所属应用类型
11116
+ * 部署组所属应用类型,C:容器应用,V:虚拟机应用
10996
11117
  */
10997
11118
  ApplicationType: string;
10998
11119
  /**
@@ -11012,11 +11133,11 @@ export interface BusinessLogConfigAssociatedGroup {
11012
11133
  */
11013
11134
  ClusterName: string;
11014
11135
  /**
11015
- * 部署组所属集群类型
11136
+ * 部署组所属集群类型,C:容器集群,V:虚拟机集群
11016
11137
  */
11017
11138
  ClusterType: string;
11018
11139
  /**
11019
- * 部署组关联日志配置时间
11140
+ * 部署组关联日志配置时间,格式yyyy-MM-dd HH:mm:ss
11020
11141
  */
11021
11142
  AssociatedTime: string;
11022
11143
  }
@@ -11033,15 +11154,17 @@ export interface DescribeApplicationsRequest {
11033
11154
  */
11034
11155
  OrderBy?: string;
11035
11156
  /**
11036
- * 排序类型
11157
+ * 指定排序类型,目前支持:
11158
+ `0`:降序
11159
+ `1`:升序
11037
11160
  */
11038
11161
  OrderType?: number;
11039
11162
  /**
11040
- * 偏移量
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)
11041
11164
  */
11042
11165
  Offset?: number;
11043
11166
  /**
11044
- * 分页个数
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)
11045
11168
  */
11046
11169
  Limit?: number;
11047
11170
  /**
@@ -11070,11 +11193,11 @@ export interface DescribeApplicationsRequest {
11070
11193
  */
11071
11194
  export interface DescribeTaskDetailRequest {
11072
11195
  /**
11073
- * 任务ID
11196
+ * 任务ID。在[任务管理](https://console.cloud.tencent.com/tsf/tct?rid=1)列表页第一列和任务基本信息页查看任务ID。
11074
11197
  */
11075
11198
  TaskId: string;
11076
11199
  /**
11077
- * 任务历史ID
11200
+ * 任务历史ID。查询任务列表 [DescribeTaskRecords](https://cloud.tencent.com/document/api/649/56136) 返回值字段 TaskLogId
11078
11201
  */
11079
11202
  TaskLogId?: string;
11080
11203
  }
@@ -11092,23 +11215,23 @@ export interface MultiValue {
11092
11215
  */
11093
11216
  export interface DescribePublicConfigReleasesRequest {
11094
11217
  /**
11095
- * 配置项名称,不传入时查询全量
11218
+ * 配置名称,不传入时查询全量。该参数可以通过调用 [DescribePublicConfigs](https://cloud.tencent.com/document/product/649/38335) 的返回值中的 ConfigName 字段来获取或通过登录[控制台](https://console.cloud.tencent.com/tse/tsf-consul?subTab=public)配置详情-配置版本页查看;也可以调用[CreatePublicConfig](https://cloud.tencent.com/document/product/649/38347)创建新的配置。
11096
11219
  */
11097
11220
  ConfigName?: string;
11098
11221
  /**
11099
- * 命名空间ID,不传入时查询全量
11222
+ * 命名空间ID,不传入时查询全量。该参数可以通过调用 [DescribeSimpleNamespaces](https://cloud.tencent.com/document/api/649/36096) 的返回值中的 NamespaceId 字段来获取或通过登录[控制台](https://console.cloud.tencent.com/tsf/resource?tab=namespace)查看;也可以调用[CreateNamespace](https://cloud.tencent.com/document/product/649/36098)创建新的命名空间。
11100
11223
  */
11101
11224
  NamespaceId?: string;
11102
11225
  /**
11103
- * 每页条数
11226
+ * 返回数量,默认为20,最大值为100。
11104
11227
  */
11105
11228
  Limit?: number;
11106
11229
  /**
11107
- * 偏移量
11230
+ * 偏移量,默认为0。
11108
11231
  */
11109
11232
  Offset?: number;
11110
11233
  /**
11111
- * 配置项ID,不传入时查询全量
11234
+ * 配置项ID,不传入时查询全量。该参数可以通过调用 [DescribePublicConfigs](https://cloud.tencent.com/document/product/649/38335) 的返回值中的 ConfigId 字段来获取或通过登录[控制台](https://console.cloud.tencent.com/tse/tsf-consul?subTab=public)配置详情-配置版本页查看;也可以调用[CreatePublicConfig](https://cloud.tencent.com/document/product/649/38347)创建新的配置。
11112
11235
  */
11113
11236
  ConfigId?: string;
11114
11237
  }
@@ -11130,23 +11253,23 @@ export interface TsfPageFileConfigRelease {
11130
11253
  */
11131
11254
  export interface DescribeLaneRulesRequest {
11132
11255
  /**
11133
- * 每页展示的条数
11256
+ * 返回数量,默认为20,最大值为500。
11134
11257
  */
11135
11258
  Limit?: number;
11136
11259
  /**
11137
- * 翻页偏移量
11260
+ * 偏移量,默认为0。
11138
11261
  */
11139
11262
  Offset?: number;
11140
11263
  /**
11141
- * 搜索关键词
11264
+ * 搜索关键词。
11142
11265
  */
11143
11266
  SearchWord?: string;
11144
11267
  /**
11145
- * 泳道规则ID(用于精确搜索)
11268
+ * 灰度发布规则ID。该参数可以通过调用 [DescribeLaneRules](https://cloud.tencent.com/document/product/649/44505) 的返回值中的 RuleId 字段来获取或通过登录[控制台](https://console.cloud.tencent.com/tse/tsf-consul?tab=grayscale&subTab=lanerule)查看;也可以调用[CreateLaneRule](https://cloud.tencent.com/document/product/649/44507)创建新的灰度发布规则。
11146
11269
  */
11147
11270
  RuleId?: string;
11148
11271
  /**
11149
- *
11272
+ * 灰度发布规则ID。该参数可以通过调用 [DescribeLaneRules](https://cloud.tencent.com/document/product/649/44505) 的返回值中的 RuleId 字段来获取或通过登录[控制台](https://console.cloud.tencent.com/tse/tsf-consul?tab=grayscale&subTab=lanerule)查看;也可以调用[CreateLaneRule](https://cloud.tencent.com/document/product/649/44507)创建新的灰度发布规则。
11150
11273
  */
11151
11274
  RuleIdList?: Array<string>;
11152
11275
  }
@@ -11225,27 +11348,29 @@ export interface CreateRepositoryResponse {
11225
11348
  */
11226
11349
  export interface CreateLaneRuleRequest {
11227
11350
  /**
11228
- * 泳道规则名称
11351
+ * 灰度发布规则名称,最多支持60个字符,支持中英文字符。
11229
11352
  */
11230
11353
  RuleName: string;
11231
11354
  /**
11232
- * 泳道规则备注
11355
+ * 灰度发布规则备注,最多支持200个字符。
11233
11356
  */
11234
11357
  Remark: string;
11235
11358
  /**
11236
- * 泳道规则标签列表
11359
+ * 灰度发布规则标签列表。
11237
11360
  */
11238
11361
  RuleTagList: Array<LaneRuleTag>;
11239
11362
  /**
11240
- * 泳道规则标签关系
11363
+ * 灰度发布规则标签关系。
11364
+ - RELEATION_AND:与
11365
+ - RELEATION_OR:或
11241
11366
  */
11242
11367
  RuleTagRelationship: string;
11243
11368
  /**
11244
- * 泳道Id
11369
+ * 泳道配置ID。该参数可以通过调用 [DescribeLanes](https://cloud.tencent.com/document/product/649/44504) 的返回值中的 LaneId 字段来获取或通过登录[控制台](https://console.cloud.tencent.com/tse/tsf-consul?tab=grayscale&subTab=lane)查看;也可以调用[CreateLane](https://cloud.tencent.com/document/product/649/44508)创建新的泳道配置。
11245
11370
  */
11246
11371
  LaneId: string;
11247
11372
  /**
11248
- *
11373
+ * 需要绑定的数据集ID。该参数可以通过调用 [DescribePrograms](https://cloud.tencent.com/document/product/649/73477) 的返回值中的 ProgramId 字段来获取或通过登录[控制台](https://console.cloud.tencent.com/tsf/privilege?tab=program&roleId=role-yrle4doy)查看;也可以调用[CreateProgram](https://cloud.tencent.com/document/product/649/108544)创建新的数据集。
11249
11374
  */
11250
11375
  ProgramIdList?: Array<string>;
11251
11376
  }
@@ -11262,7 +11387,7 @@ export interface CurvePoint {
11262
11387
  */
11263
11388
  Value?: string;
11264
11389
  /**
11265
- * 该坐标点时间戳
11390
+ * 该坐标点时间戳,单位毫秒
11266
11391
  */
11267
11392
  Timestamp?: string;
11268
11393
  }
@@ -11292,19 +11417,19 @@ export interface CosDownloadInfo {
11292
11417
  */
11293
11418
  export interface DeletePkgsRequest {
11294
11419
  /**
11295
- * 应用ID
11420
+ * 应用ID,通过调用DescribeApplications接口[获取应用列表](https://cloud.tencent.com/document/api/649/36090)从而获取应用ID,或登录[控制台](https://console.cloud.tencent.com/tsf/app?rid=1)进行查看,调用CreateApplication接口[创建应用](https://cloud.tencent.com/document/product/649/36094)时的返回值
11296
11421
  */
11297
11422
  ApplicationId: string;
11298
11423
  /**
11299
- * 需要删除的程序包ID列表
11424
+ * 软件包ID所形成的列表,软件包ID可通过调用DescribeUploadInfo接口时[获取上传程序包信息](https://cloud.tencent.com/document/api/649/36078)返回的COS上传信息获取,登录[控制台](https://console.cloud.tencent.com/tsf/product?rid=1)进行查看
11300
11425
  */
11301
11426
  PkgIds: Array<string>;
11302
11427
  /**
11303
- * 程序包仓库类型
11428
+ * 程序包仓库类型(允许值:"public-demo"TSF公共demo仓库, "private"自定义仓库, "default"TSF公共仓库)
11304
11429
  */
11305
11430
  RepositoryType?: string;
11306
11431
  /**
11307
- * 程序包仓库id
11432
+ * 仓库ID,可通过调用[仓库信息查询类](https://cloud.tencent.com/document/api/649/45925)接口时出参中的RepositoryId,或登录[控制台](https://console.cloud.tencent.com/tsf/product?rid=1)进行查看
11308
11433
  */
11309
11434
  RepositoryId?: string;
11310
11435
  }
@@ -11313,15 +11438,15 @@ export interface DeletePkgsRequest {
11313
11438
  */
11314
11439
  export interface CreateFileConfigRequest {
11315
11440
  /**
11316
- * 配置项名称
11441
+ * 配置项名称,最多支持60个字符,只能包含字母、数字及分隔符(“-”、“_”),且不能以分隔符开头或结尾。
11317
11442
  */
11318
11443
  ConfigName: string;
11319
11444
  /**
11320
- * 配置项版本
11445
+ * 配置项版本,只能包含小写字母、数字及分隔符("-","."),且必须以小写字母或数字开头、以小写字母或数字结尾,中间不能有连续的"-"或"."。
11321
11446
  */
11322
11447
  ConfigVersion: string;
11323
11448
  /**
11324
- * 配置项文件名
11449
+ * 配置项文件名,最多支持60个字符,只能包含英文、数字、"-"(英文)、"_"(英文)、"."(英文)。
11325
11450
  */
11326
11451
  ConfigFileName: string;
11327
11452
  /**
@@ -11329,31 +11454,33 @@ export interface CreateFileConfigRequest {
11329
11454
  */
11330
11455
  ConfigFileValue: string;
11331
11456
  /**
11332
- * 配置项关联应用ID
11457
+ * 配置项关联应用ID,该参数可以通过调用 [DescribeApplications](https://cloud.tencent.com/document/product/649/36090) 的返回值中的 ApplicationId 字段来获取或通过登录[控制台](https://console.cloud.tencent.com/tsf/app)查看;也可以调用[CreateApplication](https://cloud.tencent.com/document/product/649/36094)创建新的应用。
11333
11458
  */
11334
11459
  ApplicationId: string;
11335
11460
  /**
11336
- * 发布路径
11461
+ * 发布路径。
11337
11462
  */
11338
11463
  ConfigFilePath: string;
11339
11464
  /**
11340
- * 配置项版本描述
11465
+ * 配置项版本描述,最多支持200个字符。
11341
11466
  */
11342
11467
  ConfigVersionDesc?: string;
11343
11468
  /**
11344
- * 配置项文件编码,utf-8 或 gbk。注:如果选择 gbk,需要新版本 tsf-consul-template (公有云虚拟机需要使用 1.32 tsf-agent,容器需要从文档中获取最新的 tsf-consul-template-docker.tar.gz)的支持
11469
+ * 配置项文件编码,utf-8 或 gbk。注:如果选择 gbk,需要新版本 tsf-consul-template (公有云虚拟机需要使用 1.32 tsf-agent,容器需要从文档中获取最新的 tsf-consul-template-docker.tar.gz)的支持。
11345
11470
  */
11346
11471
  ConfigFileCode?: string;
11347
11472
  /**
11348
- * 后置命令
11473
+ * 后置命令。
11349
11474
  */
11350
11475
  ConfigPostCmd?: string;
11351
11476
  /**
11352
- * Base64编码的配置项
11477
+ * Base64编码的配置项。
11478
+ - true:开启
11479
+ - false:关闭
11353
11480
  */
11354
11481
  EncodeWithBase64?: boolean;
11355
11482
  /**
11356
- *
11483
+ * 需要绑定的数据集ID。该参数可以通过调用 [DescribePrograms](https://cloud.tencent.com/document/product/649/73477) 的返回值中的 ProgramId 字段来获取或通过登录[控制台](https://console.cloud.tencent.com/tsf/privilege?tab=program&roleId=role-yrle4doy)查看;也可以调用[CreateProgram](https://cloud.tencent.com/document/product/649/108544)创建新的数据集。
11357
11484
  */
11358
11485
  ProgramIdList?: Array<string>;
11359
11486
  }
@@ -11405,7 +11532,9 @@ export interface DescribeContainerGroupAttributeResponse {
11405
11532
  */
11406
11533
  export interface CreateFileConfigResponse {
11407
11534
  /**
11408
- * true:创建成功;false:创建失败
11535
+ * 创建结果。
11536
+ - true:创建成功
11537
+ - false:创建失败
11409
11538
  */
11410
11539
  Result?: boolean;
11411
11540
  /**
@@ -11478,7 +11607,7 @@ export interface DescribeGroupInstancesResponse {
11478
11607
  */
11479
11608
  export interface DescribeContainerGroupDeployInfoRequest {
11480
11609
  /**
11481
- * 实例所属 groupId
11610
+ * 部署组ID,按照【部署组ID】进行过滤,可通过调用DescribeGroups查询已创建的项目列表或登录控制台进行查看;也可以调用CreateGroup创建新的项目。部署组ID例如:group-ab958z6y
11482
11611
  */
11483
11612
  GroupId: string;
11484
11613
  }
@@ -11499,11 +11628,13 @@ export interface DescribeDeliveryConfigsRequest {
11499
11628
  */
11500
11629
  Limit?: number;
11501
11630
  /**
11502
- * 数据集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)进行查看
11503
11633
  */
11504
11634
  ProgramIdList?: Array<string>;
11505
11635
  /**
11506
- * ConfigIdList
11636
+ * 日志配置项ID列表
11637
+ 可通过调用[DescribeBusinessLogConfigs](https://cloud.tencent.com/document/product/649/75777)查询已创建的日志配置项列表或登录[控制台](https://console.cloud.tencent.com/tsf/observable/log?rid=1)进行查看
11507
11638
  */
11508
11639
  ConfigIdList?: Array<string>;
11509
11640
  }
@@ -11513,10 +11644,12 @@ export interface DescribeDeliveryConfigsRequest {
11513
11644
  export interface DisassociateBusinessLogConfigRequest {
11514
11645
  /**
11515
11646
  * 业务日志配置项ID列表
11647
+ 可通过调用[DescribeBusinessLogConfigs](https://cloud.tencent.com/document/product/649/75777)查询已创建的日志配置项列表或登录[控制台](https://console.cloud.tencent.com/tsf/observable/log?rid=1)进行查看
11516
11648
  */
11517
11649
  ConfigIdList: Array<string>;
11518
11650
  /**
11519
- * 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)进行查看
11520
11653
  */
11521
11654
  GroupId: string;
11522
11655
  }
@@ -11525,7 +11658,7 @@ export interface DisassociateBusinessLogConfigRequest {
11525
11658
  */
11526
11659
  export interface DescribePublicConfigReleaseLogsResponse {
11527
11660
  /**
11528
- * 分页后的公共配置项发布历史列表
11661
+ * 分页后的公共配置项发布历史列表。
11529
11662
  */
11530
11663
  Result?: TsfPageConfigReleaseLog;
11531
11664
  /**
@@ -11556,35 +11689,35 @@ export interface ReleaseApiGroupRequest {
11556
11689
  */
11557
11690
  export interface DescribeFileConfigReleasesRequest {
11558
11691
  /**
11559
- * 配置项ID
11692
+ * 配置ID。该参数可以通过调用 [DescribeFileConfigs](https://cloud.tencent.com/document/product/649/58593) 的返回值中的 ConfigId 字段来获取或通过登录[控制台](https://console.cloud.tencent.com/tse/tsf-consul?rid=1&subTab=file)配置详情-配置版本页查看;也可以调用[CreateFileConfig](https://cloud.tencent.com/document/product/649/58594)创建新的配置。
11560
11693
  */
11561
11694
  ConfigId?: string;
11562
11695
  /**
11563
- * 配置项名称
11696
+ * 配置项名称,最多支持60个字符,只能包含字母、数字及分隔符(“-”,“_”),且不能以分隔符开头或结尾。
11564
11697
  */
11565
11698
  ConfigName?: string;
11566
11699
  /**
11567
- * 部署组ID
11700
+ * 部署组ID。该参数可以通过调用 [DescribeSimpleGroups](https://cloud.tencent.com/document/product/649/36064) 的返回值中的 GroupId 字段来获取或通过登录[控制台](https://console.cloud.tencent.com/tsf/resource)-查看部署组页查看;也可以调用[CreateGroup](https://cloud.tencent.com/document/product/649/36074)创建新的部署组。
11568
11701
  */
11569
11702
  GroupId?: string;
11570
11703
  /**
11571
- * 命名空间ID
11704
+ * 命名空间ID。该参数可以通过调用 [DescribeSimpleNamespaces](https://cloud.tencent.com/document/api/649/36096) 的返回值中的 NamespaceId 字段来获取或通过登录[控制台](https://console.cloud.tencent.com/tsf/resource?tab=namespace)查看;也可以调用[CreateNamespace](https://cloud.tencent.com/document/product/649/36098)创建新的命名空间。
11572
11705
  */
11573
11706
  NamespaceId?: string;
11574
11707
  /**
11575
- * 集群ID
11708
+ * 集群ID。该参数可以通过调用 [DescribeClusters](https://cloud.tencent.com/document/product/649/85857) 的返回值中的 ClusterId 字段来获取或通过登录[控制台](https://console.cloud.tencent.com/tsf/resource?tab=namespace)查看;也可以调用[CreateCluster](https://cloud.tencent.com/document/product/649/36049)创建新的集群。
11576
11709
  */
11577
11710
  ClusterId?: string;
11578
11711
  /**
11579
- * 应用ID
11712
+ * 应用ID。该参数可以通过调用 [DescribeApplications](https://cloud.tencent.com/document/product/649/36090) 的返回值中的 ApplicationId 字段来获取或通过登录[控制台](https://console.cloud.tencent.com/tsf/app)查看;也可以调用[CreateApplication](https://cloud.tencent.com/document/product/649/36094)创建新的应用。
11580
11713
  */
11581
11714
  ApplicationId?: string;
11582
11715
  /**
11583
- * 偏移量
11716
+ * 偏移量,默认为0。
11584
11717
  */
11585
11718
  Offset?: number;
11586
11719
  /**
11587
- * 每页条数
11720
+ * 返回数量,默认为20,最大值为100。
11588
11721
  */
11589
11722
  Limit?: number;
11590
11723
  }
@@ -11640,11 +11773,11 @@ export interface EmptyDirOption {
11640
11773
  */
11641
11774
  export interface ExpandGroupRequest {
11642
11775
  /**
11643
- * 部署组ID
11776
+ * 部署组ID,可通过调用[DescribeGroups](https://cloud.tencent.com/document/api/649/36065)查询已创建的部署组列表或登录控制台进行查看;也可以调用[CreateGroup](https://cloud.tencent.com/document/api/649/36074)创建新的部署组。
11644
11777
  */
11645
11778
  GroupId: string;
11646
11779
  /**
11647
- * 扩容的机器实例ID列表
11780
+ * 扩容的机器实例ID列表,调用[DescribeClusters](https://console.cloud.tencent.com/tsf/resource?rid=1)接口,选定一个虚拟机集群,选择部署组,选择应用扩容可获取实例列表
11648
11781
  */
11649
11782
  InstanceIdList: Array<string>;
11650
11783
  }
@@ -11662,7 +11795,9 @@ export interface RevocationPublicConfigRequest {
11662
11795
  */
11663
11796
  export interface ModifyLaneRuleResponse {
11664
11797
  /**
11665
- * 操作状态。成功:true,失败:false
11798
+ * 修改结果。
11799
+ - true:成功
11800
+ - false:失败
11666
11801
  */
11667
11802
  Result?: boolean;
11668
11803
  /**
@@ -11688,7 +11823,7 @@ export interface TsfPageSimpleGroup {
11688
11823
  */
11689
11824
  export interface DescribeMicroservicesByGroupIdsResponse {
11690
11825
  /**
11691
- * 微服务信息分页列表
11826
+ * 微服务信息分页列表。
11692
11827
  */
11693
11828
  Result?: TsfPageMicroservice;
11694
11829
  /**
@@ -11701,7 +11836,7 @@ export interface DescribeMicroservicesByGroupIdsResponse {
11701
11836
  */
11702
11837
  export interface DescribeGroupAttributeRequest {
11703
11838
  /**
11704
- * 部署组ID字段
11839
+ * 部署组ID,按照【部署组ID】进行过滤,可通过调用DescribeGroups查询已创建的项目列表或登录控制台进行查看;也可以调用CreateGroup创建新的项目。部署组ID例如:group-ab958z6y
11705
11840
  */
11706
11841
  GroupId: string;
11707
11842
  }
@@ -11808,19 +11943,19 @@ export interface GroupPod {
11808
11943
  */
11809
11944
  ReadyCount?: number;
11810
11945
  /**
11811
- * 运行时长
11946
+ * 运行时长,单位秒
11812
11947
  */
11813
11948
  Runtime?: string;
11814
11949
  /**
11815
- * 实例启动时间
11950
+ * 实例启动时的时间戳
11816
11951
  */
11817
11952
  CreatedAt?: string;
11818
11953
  /**
11819
- * 服务实例状态
11954
+ * 服务实例状态,枚举值为Starting/Running/Stopping/Stopped/StopFailed/Abnormal/Unknown
11820
11955
  */
11821
11956
  ServiceInstanceStatus?: string;
11822
11957
  /**
11823
- * 机器实例可使用状态
11958
+ * 机器实例可使用状态,枚举值为Starting/Running/Stopping/Stopped/StopFailed/Abnormal/Unknown
11824
11959
  */
11825
11960
  InstanceAvailableStatus?: string;
11826
11961
  /**
@@ -11841,7 +11976,7 @@ export interface GroupPod {
11841
11976
  */
11842
11977
  export interface EnableTaskFlowRequest {
11843
11978
  /**
11844
- * 工作流 ID
11979
+ * 工作流 ID。[工作流管理](https://console.cloud.tencent.com/tsf/tct?rid=1&tab=workflowManage)列表页查看工作流ID。
11845
11980
  */
11846
11981
  FlowId: string;
11847
11982
  }
@@ -11865,7 +12000,7 @@ export interface InstanceResourceConfig {
11865
12000
  */
11866
12001
  export interface DescribeReleasedConfigRequest {
11867
12002
  /**
11868
- * 部署组ID
12003
+ * 部署组ID。该参数可以通过调用 [DescribeSimpleGroups](https://cloud.tencent.com/document/product/649/36064) 的返回值中的 GroupId 字段来获取或通过登录[控制台](https://console.cloud.tencent.com/tsf/resource)-查看部署组页查看;也可以调用[CreateGroup](https://cloud.tencent.com/document/product/649/36074)创建新的部署组。
11869
12004
  */
11870
12005
  GroupId: string;
11871
12006
  }
@@ -11929,11 +12064,11 @@ export interface CreatePathRewritesRequest {
11929
12064
  */
11930
12065
  export interface ModifyMicroserviceRequest {
11931
12066
  /**
11932
- * 微服务 ID
12067
+ * 微服务ID。该参数可以通过调用 [DescribeMicroservices](https://cloud.tencent.com/document/product/649/36084) 的返回值中的 MicroserviceId 字段来获取或通过登录[控制台](https://console.cloud.tencent.com/tse/tsf-consul?tab=service)查看;也可以调用[CreateMicroserviceWithDetailResp](https://cloud.tencent.com/document/product/649/85860)创建新的微服务。
11933
12068
  */
11934
12069
  MicroserviceId: string;
11935
12070
  /**
11936
- * 微服务备注信息
12071
+ * 微服务备注信息,最多支持200个字符。
11937
12072
  */
11938
12073
  MicroserviceDesc: string;
11939
12074
  }
@@ -11942,35 +12077,35 @@ export interface ModifyMicroserviceRequest {
11942
12077
  */
11943
12078
  export interface DescribeConfigReleasesRequest {
11944
12079
  /**
11945
- * 配置项名称,不传入时查询全量
12080
+ * 配置项名称,不传入时查询全量。该参数可以通过调用 [DescribeConfigs](https://cloud.tencent.com/document/product/649/38340) 的返回值中的 ConfigName 字段来获取或通过登录[控制台](https://console.cloud.tencent.com/tse/tsf-consul?subTab=app)配置详情-配置版本页查看;也可以调用[CreateConfig](https://cloud.tencent.com/document/product/649/38348)创建新的配置。
11946
12081
  */
11947
12082
  ConfigName?: string;
11948
12083
  /**
11949
- * 部署组ID,不传入时查询全量
12084
+ * 部署组ID,不传入时查询全量。该参数可以通过调用 [DescribeSimpleGroups](https://cloud.tencent.com/document/product/649/36064) 的返回值中的 GroupId 字段来获取或通过登录[控制台](https://console.cloud.tencent.com/tsf/resource)-查看部署组页查看;也可以调用[CreateGroup](https://cloud.tencent.com/document/product/649/36074)创建新的部署组。
11950
12085
  */
11951
12086
  GroupId?: string;
11952
12087
  /**
11953
- * 命名空间ID,不传入时查询全量
12088
+ * 命名空间ID,不传入时查询全量。该参数可以通过调用 [DescribeSimpleNamespaces](https://cloud.tencent.com/document/api/649/36096) 的返回值中的 NamespaceId 字段来获取或通过登录[控制台](https://console.cloud.tencent.com/tsf/resource?tab=namespace)查看;也可以调用[CreateNamespace](https://cloud.tencent.com/document/product/649/36098)创建新的命名空间。
11954
12089
  */
11955
12090
  NamespaceId?: string;
11956
12091
  /**
11957
- * 集群ID,不传入时查询全量
12092
+ * 集群ID,不传入时查询全量。该参数可以通过调用 [DescribeClusters](https://cloud.tencent.com/document/product/649/85857) 的返回值中的 ClusterId 字段来获取或通过登录[控制台](https://console.cloud.tencent.com/tsf/resource?tab=namespace)查看;也可以调用[CreateCluster](https://cloud.tencent.com/document/product/649/36049)创建新的集群。
11958
12093
  */
11959
12094
  ClusterId?: string;
11960
12095
  /**
11961
- * 每页条数
12096
+ * 返回数量,默认为20,最大值为100。
11962
12097
  */
11963
12098
  Limit?: number;
11964
12099
  /**
11965
- * 偏移量
12100
+ * 偏移量,默认为0。
11966
12101
  */
11967
12102
  Offset?: number;
11968
12103
  /**
11969
- * 配置ID,不传入时查询全量
12104
+ * 配置ID,不传入时查询全量。该参数可以通过调用 [DescribeConfigs](https://cloud.tencent.com/document/product/649/38340) 的返回值中的 ConfigId 字段来获取或通过登录[控制台](https://console.cloud.tencent.com/tse/tsf-consul?subTab=app)配置详情-配置版本页查看;也可以调用[CreateConfig](https://cloud.tencent.com/document/product/649/38348)创建新的配置。
11970
12105
  */
11971
12106
  ConfigId?: string;
11972
12107
  /**
11973
- * 应用ID,不传入时查询全量
12108
+ * 应用ID,不传入时查询全量。该参数可以通过调用 [DescribeApplications](https://cloud.tencent.com/document/product/649/36090) 的返回值中的 ApplicationId 字段来获取或通过登录[控制台](https://console.cloud.tencent.com/tsf/app)查看;也可以调用[CreateApplication](https://cloud.tencent.com/document/product/649/36094)创建新的应用。
11974
12109
  */
11975
12110
  ApplicationId?: string;
11976
12111
  }
@@ -12000,7 +12135,7 @@ export interface StdoutLogV2 {
12000
12135
  */
12001
12136
  Content?: string;
12002
12137
  /**
12003
- * 日志时间戳
12138
+ * 日志时间戳,单位毫秒
12004
12139
  */
12005
12140
  Timestamp?: number;
12006
12141
  /**
@@ -12039,23 +12174,27 @@ export interface DescribeEnabledUnitRuleRequest {
12039
12174
  */
12040
12175
  export interface CreateConfigTemplateRequest {
12041
12176
  /**
12042
- * 配置模板名称
12177
+ * 配置模板名称,最多支持60个字符,只能包含字母、数字及分隔符(“-”),且不能以分隔符开头或结尾。
12043
12178
  */
12044
12179
  ConfigTemplateName: string;
12045
12180
  /**
12046
- * 配置模板对应的微服务框架
12181
+ * 配置模板对应的微服务框架。
12182
+ - Ribbon:Ribbon类型配置模板
12183
+ - Hystrix:Hystrix类型配置模板
12184
+ - Zuul:Zuul类型配置模板
12185
+ - customize:自定义类型配置模板
12047
12186
  */
12048
12187
  ConfigTemplateType: string;
12049
12188
  /**
12050
- * 配置模板数据
12189
+ * 配置模板数据。
12051
12190
  */
12052
12191
  ConfigTemplateValue: string;
12053
12192
  /**
12054
- * 配置模板描述
12193
+ * 配置模板描述,最多支持200个字符。
12055
12194
  */
12056
12195
  ConfigTemplateDesc?: string;
12057
12196
  /**
12058
- *
12197
+ * 需要绑定的数据集ID。该参数可以通过调用 [DescribePrograms](https://cloud.tencent.com/document/product/649/73477) 的返回值中的 ProgramId 字段来获取或通过登录[控制台](https://console.cloud.tencent.com/tsf/privilege?tab=program&roleId=role-yrle4doy)查看;也可以调用[CreateProgram](https://cloud.tencent.com/document/product/649/108544)创建新的数据集。
12059
12198
  */
12060
12199
  ProgramIdList?: Array<string>;
12061
12200
  }
@@ -12077,7 +12216,7 @@ export interface DescribeApiGroupResponse {
12077
12216
  */
12078
12217
  export interface RedoTaskExecuteResponse {
12079
12218
  /**
12080
- * 成功失败
12219
+ * 成功返回执行批次流水ID。失败返回空字符串。
12081
12220
  */
12082
12221
  Result?: string;
12083
12222
  /**
@@ -12090,19 +12229,19 @@ export interface RedoTaskExecuteResponse {
12090
12229
  */
12091
12230
  export interface CreateLaneRequest {
12092
12231
  /**
12093
- * 泳道名称
12232
+ * 泳道配置名称,最多支持60个字符,只能包含字母、数字及分隔符(“-”),且不能以分隔符开头或结尾。
12094
12233
  */
12095
12234
  LaneName: string;
12096
12235
  /**
12097
- * 泳道备注
12236
+ * 泳道配置备注,最多支持200个字符。
12098
12237
  */
12099
12238
  Remark: string;
12100
12239
  /**
12101
- * 泳道部署组信息
12240
+ * 泳道部署组信息。
12102
12241
  */
12103
12242
  LaneGroupList: Array<LaneGroup>;
12104
12243
  /**
12105
- *
12244
+ * 需要绑定的数据集ID。该参数可以通过调用 [DescribePrograms](https://cloud.tencent.com/document/product/649/73477) 的返回值中的 ProgramId 字段来获取或通过登录[控制台](https://console.cloud.tencent.com/tsf/privilege?tab=program&roleId=role-yrle4doy)查看;也可以调用[CreateProgram](https://cloud.tencent.com/document/product/649/108544)创建新的数据集。
12106
12245
  */
12107
12246
  ProgramIdList?: Array<string>;
12108
12247
  }
@@ -12171,15 +12310,15 @@ export interface ServiceConfig {
12171
12310
  */
12172
12311
  export interface RedoTaskExecuteRequest {
12173
12312
  /**
12174
- * 任务批次ID
12313
+ * 任务批次ID。在[任务管理](https://console.cloud.tencent.com/tsf/tct?rid=1)页面第一列点击任务ID进入任务详情,进入执行记录列表页,第一列内容即为任务批次ID。
12175
12314
  */
12176
12315
  BatchId: string;
12177
12316
  /**
12178
- * 任务执行ID
12317
+ * 任务执行ID。在[任务管理](https://console.cloud.tencent.com/tsf/tct?rid=1)页面第一列点击任务ID进入任务详情,进入执行记录页,点击批次ID进入执行详情列表页,第一列即为任务执行ID。
12179
12318
  */
12180
12319
  ExecuteId: string;
12181
12320
  /**
12182
- * 任务ID
12321
+ * 任务ID。在[任务管理](https://console.cloud.tencent.com/tsf/tct?rid=1)列表页查看任务ID。
12183
12322
  */
12184
12323
  TaskId: string;
12185
12324
  }
@@ -12241,11 +12380,11 @@ export interface InvocationIndicator {
12241
12380
  */
12242
12381
  export interface DescribeStatisticsRequest {
12243
12382
  /**
12244
- * 类型:InterfaceServiceGroupInstanceSQLNoSQL
12383
+ * 统计类型。可选值 Interface:接口类型、Service:服务类型、Group:部署组类型、Instance:实例类型、SQL:SQL类型、NoSQL:NoSQL类型
12245
12384
  */
12246
12385
  Type: string;
12247
12386
  /**
12248
- * 步长,单位s:60、3600、86400
12387
+ * 步长,单位秒。可选值 60、3600、86400
12249
12388
  */
12250
12389
  TimeStep: number;
12251
12390
  /**
@@ -12257,7 +12396,9 @@ export interface DescribeStatisticsRequest {
12257
12396
  */
12258
12397
  Limit: number;
12259
12398
  /**
12260
- * 命名空间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
+
12261
12402
  */
12262
12403
  NamespaceId?: string;
12263
12404
  /**
@@ -12285,7 +12426,7 @@ export interface DescribeStatisticsRequest {
12285
12426
  */
12286
12427
  SearchWord?: string;
12287
12428
  /**
12288
- * 维度
12429
+ * 维度。此字段,和 NamespaceIdList 或者 MetricDimensionValues 字段包含 namespaceId 维度信息。三者选其一
12289
12430
  */
12290
12431
  MetricDimensionValues?: Array<MetricDimensionValue>;
12291
12432
  /**
@@ -12293,15 +12434,16 @@ export interface DescribeStatisticsRequest {
12293
12434
  */
12294
12435
  BucketKey?: string;
12295
12436
  /**
12296
- * 数据库
12437
+ * 数据库名称
12297
12438
  */
12298
12439
  DbName?: string;
12299
12440
  /**
12300
- * 命名空间id数组
12441
+ * 命名空间ID数组。此字段,和 NamespaceIdList 或者 MetricDimensionValues 字段包含 namespaceId 维度信息。三者选其一
12301
12442
  */
12302
12443
  NamespaceIdList?: Array<string>;
12303
12444
  /**
12304
- * 独占配置中心的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。
12305
12447
  */
12306
12448
  ConfigCenterInstanceId?: string;
12307
12449
  }
@@ -12310,7 +12452,7 @@ export interface DescribeStatisticsRequest {
12310
12452
  */
12311
12453
  export interface DescribeConfigRequest {
12312
12454
  /**
12313
- * 配置项ID
12455
+ * 配置ID。该参数可以通过调用 [DescribeConfigs](https://cloud.tencent.com/document/product/649/38340) 的返回值中的 ConfigId 字段来获取或通过登录[控制台](https://console.cloud.tencent.com/tse/tsf-consul?subTab=app)配置详情-配置版本页查看;也可以调用[CreateConfig](https://cloud.tencent.com/document/product/649/38348)创建新的配置。
12314
12456
  */
12315
12457
  ConfigId: string;
12316
12458
  }
@@ -12383,23 +12525,27 @@ export interface MetricDataCurve {
12383
12525
  */
12384
12526
  export interface UpdateConfigTemplateRequest {
12385
12527
  /**
12386
- * 配置模板id
12528
+ * 配置模板ID。该参数可以通过调用 [DescribeConfigTemplate](https://cloud.tencent.com/document/product/649/85856) 的返回值中的 ConfigTemplateId 字段来获取或通过登录[控制台](https://console.cloud.tencent.com/tse/tsf-consul?subTab=template)查看;也可以调用[CreateConfigTemplate](https://cloud.tencent.com/document/product/649/85861)创建新的配置模板。
12387
12529
  */
12388
12530
  ConfigTemplateId: string;
12389
12531
  /**
12390
- * 配置模板名称
12532
+ * 配置模板名称,最多支持60个字符,只能包含字母、数字及分隔符(“-”),且不能以分隔符开头或结尾。
12391
12533
  */
12392
12534
  ConfigTemplateName: string;
12393
12535
  /**
12394
- * 配置模板对应的微服务框架
12536
+ * 配置模板对应的微服务框架。
12537
+ - Ribbon:Ribbon类型配置模板
12538
+ - Hystrix:Hystrix类型配置模板
12539
+ - Zuul:Zuul类型配置模板
12540
+ - customize:自定义类型配置模板
12395
12541
  */
12396
12542
  ConfigTemplateType: string;
12397
12543
  /**
12398
- * 配置模板数据
12544
+ * 配置模板数据。
12399
12545
  */
12400
12546
  ConfigTemplateValue: string;
12401
12547
  /**
12402
- * 配置模板描述
12548
+ * 配置模板描述,最多支持200个字符。
12403
12549
  */
12404
12550
  ConfigTemplateDesc?: string;
12405
12551
  }
@@ -12421,7 +12567,7 @@ export interface DescribeGatewayAllGroupApisRequest {
12421
12567
  */
12422
12568
  export interface DeleteGroupRequest {
12423
12569
  /**
12424
- * 部署组ID
12570
+ * 部署组ID,可通过调用[DescribeGroups](https://cloud.tencent.com/document/api/649/36065)查询已创建的部署组列表或登录控制台进行查看;也可以调用[CreateGroup](https://cloud.tencent.com/document/api/649/36074)创建新的部署组。
12425
12571
  */
12426
12572
  GroupId: string;
12427
12573
  }
@@ -12627,11 +12773,11 @@ export interface BindApiGroupRequest {
12627
12773
  */
12628
12774
  export interface StopTaskBatchRequest {
12629
12775
  /**
12630
- * 批次ID
12776
+ * 任务批次ID。在[任务管理](https://console.cloud.tencent.com/tsf/tct?rid=1)页面点击任务ID进入任务详情,进入执行记录列表页,第一列即为任务批次ID。
12631
12777
  */
12632
12778
  BatchId: string;
12633
12779
  /**
12634
- * 参数ID
12780
+ * 任务ID。在[任务管理](https://console.cloud.tencent.com/tsf/tct?rid=1)列表页面可以查看任务ID。
12635
12781
  */
12636
12782
  TaskId?: string;
12637
12783
  }
@@ -12640,7 +12786,7 @@ export interface StopTaskBatchRequest {
12640
12786
  */
12641
12787
  export interface DescribeUploadInfoRequest {
12642
12788
  /**
12643
- * 应用ID
12789
+ * 应用ID,通过调用DescribeApplications接口[获取应用列表](https://cloud.tencent.com/document/api/649/36090)从而获取应用ID,或登录[控制台](https://console.cloud.tencent.com/tsf/app?rid=1)进行查看,调用CreateApplication接口[创建应用](https://cloud.tencent.com/document/product/649/36094)时的返回值
12644
12790
  */
12645
12791
  ApplicationId: string;
12646
12792
  /**
@@ -12660,11 +12806,11 @@ export interface DescribeUploadInfoRequest {
12660
12806
  */
12661
12807
  PkgDesc?: string;
12662
12808
  /**
12663
- * 程序包仓库类型
12809
+ * 仓库类型(默认仓库:default,私有仓库:private,公共仓库:public-demo)
12664
12810
  */
12665
12811
  RepositoryType?: string;
12666
12812
  /**
12667
- * 程序包仓库id
12813
+ * 仓库ID,可通过调用[仓库信息查询类](https://cloud.tencent.com/document/api/649/45925)接口时出参中的RepositoryId,或登录[控制台](https://console.cloud.tencent.com/tsf/product?rid=1)进行查看
12668
12814
  */
12669
12815
  RepositoryId?: string;
12670
12816
  }
@@ -12820,7 +12966,8 @@ export interface DescribeProgramsResponse {
12820
12966
  */
12821
12967
  export interface ProgramItem {
12822
12968
  /**
12823
- * 数据项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
+
12824
12971
  */
12825
12972
  ProgramItemId?: string;
12826
12973
  /**
@@ -12836,11 +12983,11 @@ export interface ProgramItem {
12836
12983
  */
12837
12984
  IsAll?: boolean;
12838
12985
  /**
12839
- * 创建时间
12986
+ * 创建时间,时间戳格式【Long】
12840
12987
  */
12841
12988
  CreationTime?: number;
12842
12989
  /**
12843
- * 最后更新时间
12990
+ * 最后更新时间,时间戳格式【Long】,单位毫秒
12844
12991
  */
12845
12992
  LastUpdateTime?: number;
12846
12993
  /**
@@ -12848,7 +12995,7 @@ export interface ProgramItem {
12848
12995
  */
12849
12996
  DeleteFlag?: boolean;
12850
12997
  /**
12851
- * 数据集ID
12998
+ * 数据集ID,调用[DescribePrograms](https://console.cloud.tencent.com/tsf/privilege?rid=1&tab=program)查询接口获取
12852
12999
  */
12853
13000
  ProgramId?: string;
12854
13001
  }
@@ -12857,7 +13004,7 @@ export interface ProgramItem {
12857
13004
  */
12858
13005
  export interface DisableTaskFlowRequest {
12859
13006
  /**
12860
- * 工作流 ID
13007
+ * 工作流 ID。[工作流管理](https://console.cloud.tencent.com/tsf/tct?rid=1&tab=workflowManage)列表页查看工作流ID。
12861
13008
  */
12862
13009
  FlowId: string;
12863
13010
  }
@@ -12883,7 +13030,7 @@ export interface DescribeLogCapacityResponse {
12883
13030
  */
12884
13031
  export interface DescribePodInstancesRequest {
12885
13032
  /**
12886
- * 实例所属groupId
13033
+ * 实例所属部署组ID,按照【部署组ID】进行过滤,可通过调用DescribeGroups查询已创建的项目列表或登录控制台进行查看;也可以调用CreateGroup创建新的项目。部署组ID例如:group-9yn2q8yd。部署组所在集群必须是活跃状态的。
12887
13034
  */
12888
13035
  GroupId: string;
12889
13036
  /**
@@ -12895,15 +13042,15 @@ export interface DescribePodInstancesRequest {
12895
13042
  */
12896
13043
  Limit?: number;
12897
13044
  /**
12898
- * 过滤字段
13045
+ * 用于通过PodName字段过滤返回结果。
12899
13046
  */
12900
13047
  PodNameList?: Array<string>;
12901
13048
  /**
12902
- * 新老版本pod批次标识
13049
+ * 新老版本pod批次标识,old表示老版本,new表示新版本。
12903
13050
  */
12904
13051
  DeployVersion?: string;
12905
13052
  /**
12906
- * 任务ID
13053
+ * 实例所属任务ID,登录控制台进行查看。
12907
13054
  */
12908
13055
  TaskId?: string;
12909
13056
  }
@@ -12912,7 +13059,7 @@ export interface DescribePodInstancesRequest {
12912
13059
  */
12913
13060
  export interface RedoTaskResponse {
12914
13061
  /**
12915
- * 操作成功or失败
13062
+ * 操作成功任务批次ID。操作失败返回空字符串。
12916
13063
  */
12917
13064
  Result?: string;
12918
13065
  /**
@@ -12941,21 +13088,21 @@ export interface DeliveryConfigBindGroup {
12941
13088
  */
12942
13089
  Groups: Array<GroupInfo>;
12943
13090
  /**
12944
- * 创建时间
13091
+ * 创建时间,格式yyyy-MM-dd HH:mm:ss
12945
13092
  */
12946
13093
  CreateTime: string;
12947
13094
  /**
12948
- * KafkaVIp
13095
+ * Kafka的vip
12949
13096
  注意:此字段可能返回 null,表示取不到有效值。
12950
13097
  */
12951
13098
  KafkaVIp?: string;
12952
13099
  /**
12953
- * KafkaAddress
13100
+ * Kafka地址
12954
13101
  注意:此字段可能返回 null,表示取不到有效值。
12955
13102
  */
12956
13103
  KafkaAddress?: string;
12957
13104
  /**
12958
- * KafkaVPort
13105
+ * Kafka端口
12959
13106
  注意:此字段可能返回 null,表示取不到有效值。
12960
13107
  */
12961
13108
  KafkaVPort?: string;
@@ -12969,7 +13116,7 @@ export interface DeliveryConfigBindGroup {
12969
13116
  */
12970
13117
  LineRule?: string;
12971
13118
  /**
12972
- * CustomRule
13119
+ * 自定义规则
12973
13120
  注意:此字段可能返回 null,表示取不到有效值。
12974
13121
  */
12975
13122
  CustomRule?: string;
@@ -12979,16 +13126,16 @@ export interface DeliveryConfigBindGroup {
12979
13126
  */
12980
13127
  EnableGlobalLineRule?: boolean;
12981
13128
  /**
12982
- * EnableAuth
13129
+ * 是否开启认证
12983
13130
  */
12984
13131
  EnableAuth?: boolean;
12985
13132
  /**
12986
- * Username
13133
+ * 用户名
12987
13134
  注意:此字段可能返回 null,表示取不到有效值。
12988
13135
  */
12989
13136
  Username?: string;
12990
13137
  /**
12991
- * Password
13138
+ * 密码
12992
13139
  注意:此字段可能返回 null,表示取不到有效值。
12993
13140
  */
12994
13141
  Password?: string;
@@ -13016,31 +13163,31 @@ export interface CustomPodSchedule {
13016
13163
  */
13017
13164
  export interface DescribeConfigsRequest {
13018
13165
  /**
13019
- * 应用ID,不传入时查询全量
13166
+ * 应用ID,不传入时查询全量。该参数可以通过调用 [DescribeApplications](https://cloud.tencent.com/document/product/649/36090) 的返回值中的 ApplicationId 字段来获取或通过登录[控制台](https://console.cloud.tencent.com/tsf/app)查看;也可以调用[CreateApplication](https://cloud.tencent.com/document/product/649/36094)创建新的应用。
13020
13167
  */
13021
13168
  ApplicationId?: string;
13022
13169
  /**
13023
- * 配置项ID,不传入时查询全量,高优先级
13170
+ * 配置ID,不传入时查询全量,高优先级。该参数可以通过调用 [DescribeConfigs](https://cloud.tencent.com/document/product/649/38340) 的返回值中的 ConfigId 字段来获取或通过登录[控制台](https://console.cloud.tencent.com/tse/tsf-consul?subTab=app)配置详情-配置版本页查看;也可以调用[CreateConfig](https://cloud.tencent.com/document/product/649/38348)创建新的配置。
13024
13171
  */
13025
13172
  ConfigId?: string;
13026
13173
  /**
13027
- * 偏移量
13174
+ * 偏移量,默认为0。
13028
13175
  */
13029
13176
  Offset?: number;
13030
13177
  /**
13031
- * 每页条数
13178
+ * 返回数量,默认为20,最大值为100。
13032
13179
  */
13033
13180
  Limit?: number;
13034
13181
  /**
13035
- * 配置项ID列表,不传入时查询全量,低优先级
13182
+ * 配置ID列表,不传入时查询全量,低优先级。该参数可以通过调用 [DescribeConfigs](https://cloud.tencent.com/document/product/649/38340) 的返回值中的 ConfigId 字段来获取或通过登录[控制台](https://console.cloud.tencent.com/tse/tsf-consul?subTab=app)配置详情-配置版本页查看;也可以调用[CreateConfig](https://cloud.tencent.com/document/product/649/38348)创建新的配置。
13036
13183
  */
13037
13184
  ConfigIdList?: Array<string>;
13038
13185
  /**
13039
- * 配置项名称,精确查询,不传入时查询全量
13186
+ * 配置项名称,精确查询,不传入时查询全量。
13040
13187
  */
13041
13188
  ConfigName?: string;
13042
13189
  /**
13043
- * 配置项版本,精确查询,不传入时查询全量
13190
+ * 配置项版本,精确查询,不传入时查询全量。
13044
13191
  */
13045
13192
  ConfigVersion?: string;
13046
13193
  }
@@ -13053,7 +13200,7 @@ export interface WarmupSetting {
13053
13200
  */
13054
13201
  Enabled?: boolean;
13055
13202
  /**
13056
- * 预热时间
13203
+ * 预热时间,单位秒
13057
13204
  */
13058
13205
  WarmupTime?: number;
13059
13206
  /**
@@ -13096,7 +13243,7 @@ export interface TsfPageApplication {
13096
13243
  */
13097
13244
  export interface DisableLaneRuleRequest {
13098
13245
  /**
13099
- * 泳道规则ID
13246
+ * 灰度发布规则ID。该参数可以通过调用 [DescribeLaneRules](https://cloud.tencent.com/document/product/649/44505) 的返回值中的 RuleId 字段来获取或通过登录[控制台](https://console.cloud.tencent.com/tse/tsf-consul?tab=grayscale&subTab=lanerule)查看;也可以调用[CreateLaneRule](https://cloud.tencent.com/document/product/649/44507)创建新的灰度发布规则。
13100
13247
  */
13101
13248
  RuleId: string;
13102
13249
  }
@@ -13141,7 +13288,7 @@ export interface InstanceEnrichedInfo {
13141
13288
  */
13142
13289
  ApplicationName?: string;
13143
13290
  /**
13144
- * 应用类型
13291
+ * 应用类型,C表示容器应用,V表示虚拟机应用
13145
13292
  */
13146
13293
  ApplicationType?: string;
13147
13294
  /**
@@ -13153,7 +13300,7 @@ export interface InstanceEnrichedInfo {
13153
13300
  */
13154
13301
  ClusterName?: string;
13155
13302
  /**
13156
- * 集群类型
13303
+ * 集群类型,C表示容器集群,V表示虚拟机集群
13157
13304
  */
13158
13305
  ClusterType?: string;
13159
13306
  /**
@@ -13178,7 +13325,7 @@ export interface InstanceEnrichedInfo {
13178
13325
  */
13179
13326
  export interface DescribeResourceTaskStatusRequest {
13180
13327
  /**
13181
- * 任务ID
13328
+ * 容器实例任务ID,可通过调用 ListContainerTask 查询已创建的变更记录总数或登录控制台进行查看。
13182
13329
  */
13183
13330
  TaskId: string;
13184
13331
  }
@@ -13200,7 +13347,7 @@ export interface DescribeInvocationMetricDataCurveResponse {
13200
13347
  */
13201
13348
  export interface DeleteConfigRequest {
13202
13349
  /**
13203
- * 配置项ID
13350
+ * 配置ID。该参数可以通过调用 [DescribeConfigs](https://cloud.tencent.com/document/product/649/38340) 的返回值中的 ConfigId 字段来获取或通过登录[控制台](https://console.cloud.tencent.com/tse/tsf-consul?subTab=app)配置详情-配置版本页查看;也可以调用[CreateConfig](https://cloud.tencent.com/document/product/649/38348)创建新的配置。
13204
13351
  */
13205
13352
  ConfigId: string;
13206
13353
  }
@@ -13209,31 +13356,31 @@ export interface DeleteConfigRequest {
13209
13356
  */
13210
13357
  export interface DescribeFileConfigsRequest {
13211
13358
  /**
13212
- * 配置项ID
13359
+ * 配置ID。该参数可以通过调用 [DescribeFileConfigs](https://cloud.tencent.com/document/product/649/58593) 的返回值中的 ConfigId 字段来获取或通过登录[控制台](https://console.cloud.tencent.com/tse/tsf-consul?rid=1&subTab=file)配置详情-配置版本页查看;也可以调用[CreateFileConfig](https://cloud.tencent.com/document/product/649/58594)创建新的配置。
13213
13360
  */
13214
13361
  ConfigId?: string;
13215
13362
  /**
13216
- * 配置项ID列表
13363
+ * 配置项ID列表。该参数可以通过调用 [DescribeFileConfigs](https://cloud.tencent.com/document/product/649/58593) 的返回值中的 ConfigId 字段来获取或通过登录[控制台](https://console.cloud.tencent.com/tse/tsf-consul?rid=1&subTab=file)配置详情-配置版本页查看;也可以调用[CreateFileConfig](https://cloud.tencent.com/document/product/649/58594)创建新的配置。
13217
13364
  */
13218
13365
  ConfigIdList?: Array<string>;
13219
13366
  /**
13220
- * 配置项名称
13367
+ * 配置项名称。
13221
13368
  */
13222
13369
  ConfigName?: string;
13223
13370
  /**
13224
- * 应用ID
13371
+ * 应用ID。该参数可以通过调用 [DescribeApplications](https://cloud.tencent.com/document/product/649/36090) 的返回值中的 ApplicationId 字段来获取或通过登录[控制台](https://console.cloud.tencent.com/tsf/app)查看;也可以调用[CreateApplication](https://cloud.tencent.com/document/product/649/36094)创建新的应用。
13225
13372
  */
13226
13373
  ApplicationId?: string;
13227
13374
  /**
13228
- * 偏移量
13375
+ * 偏移量,默认为0。
13229
13376
  */
13230
13377
  Offset?: number;
13231
13378
  /**
13232
- * 每页条数
13379
+ * 返回数量,默认为20,最大值为100。
13233
13380
  */
13234
13381
  Limit?: number;
13235
13382
  /**
13236
- * 配置项版本
13383
+ * 配置项版本。
13237
13384
  */
13238
13385
  ConfigVersion?: string;
13239
13386
  }
@@ -13242,7 +13389,9 @@ export interface DescribeFileConfigsRequest {
13242
13389
  */
13243
13390
  export interface CreateConfigTemplateResponse {
13244
13391
  /**
13245
- * true:创建成功;false:创建失败
13392
+ * 创建结果。
13393
+ - true:创建成功
13394
+ - false:创建失败
13246
13395
  */
13247
13396
  Result?: boolean;
13248
13397
  /**
@@ -13255,7 +13404,7 @@ export interface CreateConfigTemplateResponse {
13255
13404
  */
13256
13405
  export interface ExecuteTaskResponse {
13257
13406
  /**
13258
- * 成功/失败
13407
+ * 操作成功返回任务批次ID,操作失败返回空字符串。
13259
13408
  */
13260
13409
  Result?: string;
13261
13410
  /**
@@ -13405,7 +13554,7 @@ export interface DescribeApiUseDetailRequest {
13405
13554
  */
13406
13555
  export interface CreateMicroserviceWithDetailRespResponse {
13407
13556
  /**
13408
- * 微服务ID
13557
+ * 微服务ID
13409
13558
  */
13410
13559
  Result?: string;
13411
13560
  /**
@@ -13431,7 +13580,7 @@ export interface TsfPageBusinessLogV2 {
13431
13580
  */
13432
13581
  ScrollId?: string;
13433
13582
  /**
13434
- * 查询状态
13583
+ * 查询状态,SUCCESS:查询成功完成,ERROR_RANGE_EXCEED:查询范围过大异常,ERROR_COMPLEX_CONDITION:查询条件复杂异常,ERROR_OTHER_CAUSE:其他异常
13435
13584
  注意:此字段可能返回 null,表示取不到有效值。
13436
13585
  */
13437
13586
  Status?: string;
@@ -13458,11 +13607,14 @@ export interface CreateClusterRequest {
13458
13607
  */
13459
13608
  ClusterName: string;
13460
13609
  /**
13461
- * 集群类型
13610
+ * 指定集群类型,目前支持:
13611
+ - `V`:虚拟机集群
13612
+ - `C`:容器集群
13613
+ - `S`:Serverless 集群
13462
13614
  */
13463
13615
  ClusterType: string;
13464
13616
  /**
13465
- * 私有网络ID
13617
+ * 私有网络ID,可通过调用[DescribeVpcEx](https://cloud.tencent.com/document/api/215/1372)查询已创建的私有网络列表或登录控制台进行查看;也可以调用[CreateVpc](https://cloud.tencent.com/document/api/215/1309)创建新的私有网络。
13466
13618
  */
13467
13619
  VpcId: string;
13468
13620
  /**
@@ -13527,7 +13679,8 @@ export interface CreateClusterRequest {
13527
13679
  */
13528
13680
  export interface DescribeDeliveryConfigByGroupIdRequest {
13529
13681
  /**
13530
- * 部署组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)进行查看
13531
13684
  */
13532
13685
  GroupId: string;
13533
13686
  }
@@ -13633,7 +13786,7 @@ export interface ConfigRelease {
13633
13786
  */
13634
13787
  export interface DeleteContainerGroupRequest {
13635
13788
  /**
13636
- * 部署组ID,分组唯一标识
13789
+ * 部署组ID,可通过调用[DescribeContainerGroups](https://cloud.tencent.com/document/api/649/36068)查询已创建的部署组列表或登录控制台进行查看;也可以调用[CreateContainGroup](https://cloud.tencent.com/document/api/649/36075)创建新的部署组。
13637
13790
  */
13638
13791
  GroupId: string;
13639
13792
  }
@@ -13651,7 +13804,7 @@ export interface AdvanceSettings {
13651
13804
  */
13652
13805
  export interface EnableTaskResponse {
13653
13806
  /**
13654
- * 操作成功or失败
13807
+ * true:操作成功,false:操作失败
13655
13808
  */
13656
13809
  Result?: boolean;
13657
13810
  /**
@@ -13664,15 +13817,15 @@ export interface EnableTaskResponse {
13664
13817
  */
13665
13818
  export interface ReleaseConfigRequest {
13666
13819
  /**
13667
- * 配置ID
13820
+ * 配置ID。该参数可以通过调用 [DescribeConfigs](https://cloud.tencent.com/document/product/649/38340) 的返回值中的 ConfigId 字段来获取或通过登录[控制台](https://console.cloud.tencent.com/tse/tsf-consul?subTab=app)配置详情-配置版本页查看;也可以调用[CreateConfig](https://cloud.tencent.com/document/product/649/38348)创建新的配置。
13668
13821
  */
13669
13822
  ConfigId: string;
13670
13823
  /**
13671
- * 部署组ID
13824
+ * 部署组ID。该参数可以通过调用 [DescribeSimpleGroups](https://cloud.tencent.com/document/product/649/36064) 的返回值中的 GroupId 字段来获取或通过登录[控制台](https://console.cloud.tencent.com/tsf/resource)-查看部署组页查看;也可以调用[CreateGroup](https://cloud.tencent.com/document/product/649/36074)创建新的部署组。
13672
13825
  */
13673
13826
  GroupId: string;
13674
13827
  /**
13675
- * 发布描述
13828
+ * 发布描述,最多支持200个字符。
13676
13829
  */
13677
13830
  ReleaseDesc?: string;
13678
13831
  }
@@ -13730,12 +13883,12 @@ export interface BusinessLogConfig {
13730
13883
  */
13731
13884
  ConfigPipeline?: string;
13732
13885
  /**
13733
- * 配置项创建时间
13886
+ * 配置项创建时间,格式为yyyy-MM-dd HH:mm:ss
13734
13887
  注意:此字段可能返回 null,表示取不到有效值。
13735
13888
  */
13736
13889
  ConfigCreateTime?: string;
13737
13890
  /**
13738
- * 配置项更新时间
13891
+ * 配置项更新时间,格式为yyyy-MM-dd HH:mm:ss
13739
13892
  注意:此字段可能返回 null,表示取不到有效值。
13740
13893
  */
13741
13894
  ConfigUpdateTime?: string;
@@ -13761,29 +13914,52 @@ export interface BusinessLogConfig {
13761
13914
  * close_timeout参数
13762
13915
  */
13763
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;
13764
13933
  }
13765
13934
  /**
13766
13935
  * DescribeApiDetail请求参数结构体
13767
13936
  */
13768
13937
  export interface DescribeApiDetailRequest {
13769
13938
  /**
13770
- * 微服务id
13939
+ * 微服务ID。该参数可以通过调用 [DescribeMicroservices](https://cloud.tencent.com/document/product/649/36084) 的返回值中的 MicroserviceId 字段来获取或通过登录[控制台](https://console.cloud.tencent.com/tse/tsf-consul?tab=service)查看;也可以调用[CreateMicroserviceWithDetailResp](https://cloud.tencent.com/document/product/649/85860)创建新的微服务。
13771
13940
  */
13772
13941
  MicroserviceId: string;
13773
13942
  /**
13774
- * 请求路径
13943
+ * 请求路径。
13775
13944
  */
13776
13945
  Path: string;
13777
13946
  /**
13778
- * 请求方法
13947
+ * 请求方法。
13948
+ - GET
13949
+ - POST
13950
+ - PUT
13951
+ - DELETE
13952
+ - HEAD
13953
+ - PATCH
13954
+ - OPTIONS
13779
13955
  */
13780
13956
  Method: string;
13781
13957
  /**
13782
- * 包版本
13958
+ * 应用包版本号。
13783
13959
  */
13784
13960
  PkgVersion: string;
13785
13961
  /**
13786
- * 应用ID
13962
+ * 应用ID。该参数可以通过调用 [DescribeApplications](https://cloud.tencent.com/document/product/649/36090) 的返回值中的 ApplicationId 字段来获取或通过登录[控制台](https://console.cloud.tencent.com/tsf/app)查看;也可以调用[CreateApplication](https://cloud.tencent.com/document/product/649/36094)创建新的应用。
13787
13963
  */
13788
13964
  ApplicationId: string;
13789
13965
  }
@@ -13792,7 +13968,7 @@ export interface DescribeApiDetailRequest {
13792
13968
  */
13793
13969
  export interface StopContainerGroupRequest {
13794
13970
  /**
13795
- * 部署组ID
13971
+ * 部署组ID,可通过调用[DescribeContainerGroups](https://cloud.tencent.com/document/api/649/36068)查询已创建的部署组列表或登录控制台进行查看;也可以调用[CreateContainGroup](https://cloud.tencent.com/document/api/649/36075)创建新的部署组。
13796
13972
  */
13797
13973
  GroupId: string;
13798
13974
  }
@@ -14149,7 +14325,7 @@ export interface ServiceGovernanceConfig {
14149
14325
  */
14150
14326
  EnableGovernance?: boolean;
14151
14327
  /**
14152
- * 服务治理类型(枚举:SHAREEXCLUSIVE
14328
+ * 服务治理类型(枚举:SHARE表示共享型、EXCLUSIVE表示独占型)
14153
14329
  */
14154
14330
  GovernanceType?: string;
14155
14331
  /**
@@ -14196,7 +14372,7 @@ export interface ModifyApplicationRequest {
14196
14372
  */
14197
14373
  ServiceConfigList?: Array<ServiceConfig>;
14198
14374
  /**
14199
- * 应用的微服务类型
14375
+ * 应用的微服务类型,N表示普通应用,M表示Mesh应用,G表示网关应用,NATIVE表示原生应用,RAW表示裸应用
14200
14376
  */
14201
14377
  MicroserviceType?: string;
14202
14378
  /**
@@ -14204,7 +14380,7 @@ export interface ModifyApplicationRequest {
14204
14380
  */
14205
14381
  ServiceGovernanceConfig?: ServiceGovernanceConfig;
14206
14382
  /**
14207
- * 应用开发框架
14383
+ * 应用开发框架,SpringCloud表示SpringCloud应用,Dubbo表示Dubbo应用,Go-GRPC表示Go-GRPC应用,Other表示其他应用
14208
14384
  */
14209
14385
  FrameworkType?: string;
14210
14386
  }
@@ -14291,7 +14467,7 @@ export interface DescribeFlowLastBatchStateResponse {
14291
14467
  */
14292
14468
  export interface StopTaskExecuteResponse {
14293
14469
  /**
14294
- * 操作成功 or 失败
14470
+ * 返回 true 或 false。true:操作成功,false:操作失败
14295
14471
  */
14296
14472
  Result?: boolean;
14297
14473
  /**
@@ -14330,7 +14506,7 @@ export interface UpdateApiRateLimitRulesResponse {
14330
14506
  */
14331
14507
  export interface DeleteRepositoryRequest {
14332
14508
  /**
14333
- * 仓库ID
14509
+ * 删除对应仓库ID,可通过调用[仓库信息查询类](https://cloud.tencent.com/document/api/649/45925)接口时出参中的RepositoryId,或登录[控制台](https://console.cloud.tencent.com/tsf/product?rid=1)进行查看
14334
14510
  */
14335
14511
  RepositoryId: string;
14336
14512
  }
@@ -14380,7 +14556,7 @@ export interface DescribeSimpleGroupsRequest {
14380
14556
  */
14381
14557
  export interface DescribeConfigReleasesResponse {
14382
14558
  /**
14383
- * 分页的配置发布信息
14559
+ * 分页的配置发布信息。
14384
14560
  */
14385
14561
  Result?: TsfPageConfigRelease;
14386
14562
  /**
@@ -14522,9 +14698,9 @@ export interface UnitNamespace {
14522
14698
  */
14523
14699
  export interface ModifyMicroserviceResponse {
14524
14700
  /**
14525
- * 修改微服务详情是否成功。
14526
- true:操作成功。
14527
- false:操作失败。
14701
+ * 修改结果。
14702
+ - true:修改成功
14703
+ - false:修改失败
14528
14704
  */
14529
14705
  Result?: boolean;
14530
14706
  /**
@@ -14608,7 +14784,7 @@ export interface GroupPodResult {
14608
14784
  */
14609
14785
  export interface DescribeApplicationRequest {
14610
14786
  /**
14611
- * 应用ID
14787
+ * 应用ID,可通过调用[DescribeApplications](https://cloud.tencent.com/document/api/649/36090)查询已创建的应用列表或登录控制台进行查看;也可以调用[CreateApplication](https://cloud.tencent.com/document/api/649/36094)创建新的应用。
14612
14788
  */
14613
14789
  ApplicationId: string;
14614
14790
  }
@@ -14739,9 +14915,9 @@ export interface DescribeBasicResourceUsageRequest {
14739
14915
  */
14740
14916
  export interface DeleteMicroserviceResponse {
14741
14917
  /**
14742
- * 删除微服务是否成功。
14743
- true:操作成功。
14744
- false:操作失败。
14918
+ * 删除结果。
14919
+ - true:操作成功
14920
+ - false:操作失败
14745
14921
  */
14746
14922
  Result?: boolean;
14747
14923
  /**
@@ -14763,7 +14939,7 @@ export interface ResourceFieldRef {
14763
14939
  */
14764
14940
  export interface DescribeReleasedConfigResponse {
14765
14941
  /**
14766
- * 已发布的配置内容
14942
+ * 已发布的配置内容。
14767
14943
  */
14768
14944
  Result?: string;
14769
14945
  /**
@@ -14858,7 +15034,7 @@ export interface PropertyField {
14858
15034
  */
14859
15035
  export interface DescribeApiDetailResponse {
14860
15036
  /**
14861
- * API 详情
15037
+ * API详情。
14862
15038
  */
14863
15039
  Result?: ApiDetailResponse;
14864
15040
  /**
@@ -14875,7 +15051,7 @@ export interface DescribeGroupsRequest {
14875
15051
  */
14876
15052
  SearchWord?: string;
14877
15053
  /**
14878
- * 应用ID
15054
+ * 应用ID。调用[DescribeApplications](https://cloud.tencent.com/document/api/649/36090)查询已创建的应用或通过[CreateApplication](https://cloud.tencent.com/document/api/649/36094)接口创建新的应用。
14879
15055
  */
14880
15056
  ApplicationId?: string;
14881
15057
  /**
@@ -14883,23 +15059,23 @@ export interface DescribeGroupsRequest {
14883
15059
  */
14884
15060
  OrderBy?: string;
14885
15061
  /**
14886
- * 排序方式
15062
+ * 排序方式,0:升序,1:降序
14887
15063
  */
14888
15064
  OrderType?: number;
14889
15065
  /**
14890
- * 偏移量
15066
+ * 偏移量,默认值:0
14891
15067
  */
14892
15068
  Offset?: number;
14893
15069
  /**
14894
- * 分页个数
15070
+ * 分页个数,默认值:20
14895
15071
  */
14896
15072
  Limit?: number;
14897
15073
  /**
14898
- * 命名空间ID
15074
+ * 命名空间ID。调用[DescribeSimpleNamespaces](https://cloud.tencent.com/document/api/649/36096)查询已创建的命名空间或通过[CreateNamespace](https://cloud.tencent.com/document/api/649/36098)接口创建新的集群。
14899
15075
  */
14900
15076
  NamespaceId?: string;
14901
15077
  /**
14902
- * 集群ID
15078
+ * 集群 ID。调用[DescribeSimpleClusters](https://cloud.tencent.com/document/api/649/36047)查询已创建的集群或通过[CreateCluster](https://cloud.tencent.com/document/api/649/36049)接口创建新的集群。
14903
15079
  */
14904
15080
  ClusterId?: string;
14905
15081
  /**
@@ -14960,7 +15136,7 @@ export interface LaneRuleTag {
14960
15136
  */
14961
15137
  export interface ModifyNamespaceRequest {
14962
15138
  /**
14963
- * 命名空间ID
15139
+ * 命名空间ID,按照【命名空间ID】进行过滤,可通过调用DescribeNamespaces查询已创建的项目列表或登录控制台进行查看;也可以调用CreateNamespace创建新的项目。命名空间ID例如:namespace-6a79x94v。
14964
15140
  */
14965
15141
  NamespaceId: string;
14966
15142
  /**
@@ -14972,7 +15148,7 @@ export interface ModifyNamespaceRequest {
14972
15148
  */
14973
15149
  NamespaceDesc?: string;
14974
15150
  /**
14975
- * 是否开启高可用
15151
+ * 是否开启高可用,0表示不开启,1表示开启
14976
15152
  */
14977
15153
  IsHaEnable?: string;
14978
15154
  }
@@ -15006,11 +15182,11 @@ export interface CreateRepositoryRequest {
15006
15182
  */
15007
15183
  RepositoryType: string;
15008
15184
  /**
15009
- * 仓库所在桶名称
15185
+ * 仓库所在桶名称,[存储桶概述和创建](https://cloud.tencent.com/document/product/436/13312)
15010
15186
  */
15011
15187
  BucketName: string;
15012
15188
  /**
15013
- * 仓库所在桶地域
15189
+ * 仓库所在桶地域,[存储桶概述和创建](https://cloud.tencent.com/document/product/436/13312)
15014
15190
  */
15015
15191
  BucketRegion: string;
15016
15192
  /**
@@ -15027,11 +15203,11 @@ export interface CreateRepositoryRequest {
15027
15203
  */
15028
15204
  export interface DeleteNamespaceRequest {
15029
15205
  /**
15030
- * 命名空间ID
15206
+ * 命名空间ID,按照【命名空间ID】进行过滤,可通过调用[DescribeNamespaces](https://cloud.tencent.com/document/product/649/36096)查询已创建的命名空间列表或登录控制台进行查看;也可以调用[CreateNamespace](https://cloud.tencent.com/document/product/649/36098)创建新命名空间。
15031
15207
  */
15032
15208
  NamespaceId: string;
15033
15209
  /**
15034
- * 集群ID
15210
+ * 集群ID,按照【集群ID】进行过滤,可通过调用[DescribeClusters](https://cloud.tencent.com/document/product/649/85857)查询已创建的集群列表或登录控制台进行查看;也可以调用[CreateCluster](https://cloud.tencent.com/document/product/649/36049)创建新的集群。仅在集群下无部署组、命名空间、云主机时可以删除。
15035
15211
  */
15036
15212
  ClusterId?: string;
15037
15213
  }
@@ -15180,7 +15356,11 @@ export interface ContainerInfo {
15180
15356
  */
15181
15357
  export interface SearchStdoutLogRequest {
15182
15358
  /**
15183
- * 机器实例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
+
15184
15364
  */
15185
15365
  InstanceId?: string;
15186
15366
  /**
@@ -15192,15 +15372,16 @@ export interface SearchStdoutLogRequest {
15192
15372
  */
15193
15373
  SearchWords?: Array<string>;
15194
15374
  /**
15195
- * 查询起始时间
15375
+ * 查询起始时间,格式yyyy-MM-dd HH:mm:ss
15196
15376
  */
15197
15377
  StartTime?: string;
15198
15378
  /**
15199
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)进行查看
15200
15381
  */
15201
15382
  GroupId?: string;
15202
15383
  /**
15203
- * 查询结束时间
15384
+ * 查询结束时间,格式yyyy-MM-dd HH:mm:ss
15204
15385
  */
15205
15386
  EndTime?: string;
15206
15387
  /**
@@ -15209,22 +15390,20 @@ export interface SearchStdoutLogRequest {
15209
15390
  */
15210
15391
  Offset?: number;
15211
15392
  /**
15212
- * 排序规则,默认值"time"
15393
+ * 排序规则,time:按时间排序,score:按检索值排序,默认值"time"
15213
15394
  */
15214
15395
  OrderBy?: string;
15215
15396
  /**
15216
- * 排序方式,取值"asc""desc",默认
15217
- 值"desc"
15397
+ * 排序方式,取值 asc:升序 desc:降序,默认值desc
15218
15398
  */
15219
15399
  OrderType?: string;
15220
15400
  /**
15221
- * 检索类型,取值"LUCENE", "REGEXP",
15222
- "NORMAL"
15401
+ * 检索类型,取值 LUCENE:Lucene检索,REGEXP:正则检索,NORMAL:普通检索
15223
15402
  */
15224
15403
  SearchWordType?: string;
15225
15404
  /**
15226
- * 批量请求类型,取值"page"或"scroll",默认
15227
- 值"page"
15405
+ * 批量请求类型,取值 PAGE:分页查询,SCROLL:滚动查询,SEARCHAFTER:游标查询,默认值PAGE
15406
+
15228
15407
  */
15229
15408
  BatchType?: string;
15230
15409
  /**
@@ -15241,7 +15420,7 @@ export interface SearchStdoutLogRequest {
15241
15420
  */
15242
15421
  export interface RedoTaskBatchResponse {
15243
15422
  /**
15244
- * 批次ID
15423
+ * 批次流水ID
15245
15424
  */
15246
15425
  Result?: string;
15247
15426
  /**
@@ -15289,7 +15468,7 @@ export interface DescribeResourceConfigResultV2 {
15289
15468
  */
15290
15469
  export interface ModifyGroupRequest {
15291
15470
  /**
15292
- * 部署组ID
15471
+ * 部署组ID,按照【部署组ID】进行过滤,可通过调用DescribeGroups查询已创建的项目列表或登录控制台进行查看;也可以调用CreateGroup创建新的项目。部署组ID例如:group-9yn2q8yd。
15293
15472
  */
15294
15473
  GroupId: string;
15295
15474
  /**
@@ -15310,7 +15489,7 @@ export interface ModifyGroupRequest {
15310
15489
  */
15311
15490
  export interface DescribeMicroserviceResponse {
15312
15491
  /**
15313
- * 微服务详情实例列表
15492
+ * 微服务详情实例列表。
15314
15493
  */
15315
15494
  Result?: TsfPageMsInstance;
15316
15495
  /**
@@ -15345,15 +15524,15 @@ export interface TaskId {
15345
15524
  */
15346
15525
  export interface DescribeImageTagsRequest {
15347
15526
  /**
15348
- * 应用Id
15527
+ * 应用ID,可通过调用[DescribeApplications](https://cloud.tencent.com/document/api/649/36090)查询已创建的应用列表或登录控制台进行查看;也可以调用[CreateApplication](https://cloud.tencent.com/document/api/649/36094)创建新的应用。
15349
15528
  */
15350
15529
  ApplicationId?: string;
15351
15530
  /**
15352
- * 偏移量,取值从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)
15353
15532
  */
15354
15533
  Offset?: number;
15355
15534
  /**
15356
- * 分页个数,默认为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)
15357
15536
  */
15358
15537
  Limit?: number;
15359
15538
  /**
@@ -15399,7 +15578,7 @@ export interface MemoryPicture {
15399
15578
  */
15400
15579
  export interface DescribeConfigSummaryResponse {
15401
15580
  /**
15402
- * 配置项分页对象
15581
+ * 配置项分页对象。
15403
15582
  */
15404
15583
  Result?: TsfPageConfig;
15405
15584
  /**
@@ -15515,7 +15694,7 @@ export interface CreateContainGroupRequest {
15515
15694
  */
15516
15695
  export interface DescribePublicConfigReleasesResponse {
15517
15696
  /**
15518
- * 公共配置发布信息
15697
+ * 公共配置发布信息。
15519
15698
  */
15520
15699
  Result?: TsfPageConfigRelease;
15521
15700
  /**
@@ -15541,7 +15720,7 @@ export interface CreatePathRewritesResponse {
15541
15720
  */
15542
15721
  export interface DescribeConfigTemplateRequest {
15543
15722
  /**
15544
- * 配置模板Id
15723
+ * 配置模板ID。该参数可以通过调用 [DescribeConfigTemplate](https://cloud.tencent.com/document/product/649/85856) 的返回值中的 ConfigTemplateId 字段来获取或通过登录[控制台](https://console.cloud.tencent.com/tse/tsf-consul?subTab=template)查看;也可以调用[CreateConfigTemplate](https://cloud.tencent.com/document/product/649/85861)创建新的配置模板。
15545
15724
  */
15546
15725
  ConfigTemplateId: string;
15547
15726
  }
@@ -15563,39 +15742,43 @@ export interface DraftApiGroupResponse {
15563
15742
  */
15564
15743
  export interface DescribeConfigSummaryRequest {
15565
15744
  /**
15566
- * 应用ID,不传入时查询全量
15745
+ * 应用ID,不传入时查询全量。该参数可以通过调用 [DescribeApplications](https://cloud.tencent.com/document/product/649/36090) 的返回值中的 ApplicationId 字段来获取或通过登录[控制台](https://console.cloud.tencent.com/tsf/app)查看;也可以调用[CreateApplication](https://cloud.tencent.com/document/product/649/36094)创建新的应用。
15567
15746
  */
15568
15747
  ApplicationId?: string;
15569
15748
  /**
15570
- * 查询关键字,模糊查询:应用名称,配置项名称,不传入时查询全量
15749
+ * 查询关键字,模糊查询:应用名称,配置项名称,不传入时查询全量。
15571
15750
  */
15572
15751
  SearchWord?: string;
15573
15752
  /**
15574
- * 偏移量,默认为0
15753
+ * 偏移量,默认为0
15575
15754
  */
15576
15755
  Offset?: number;
15577
15756
  /**
15578
- * 每页条数,默认为20
15757
+ * 返回数量,默认为20,最大值为50。
15579
15758
  */
15580
15759
  Limit?: number;
15581
15760
  /**
15582
- * 按时间排序:creation_time;按名称排序:config_name
15761
+ * 排序字段。
15762
+ - creation_time:按时间排序
15763
+ - config_name:按名称排序
15583
15764
  */
15584
15765
  OrderBy?: string;
15585
15766
  /**
15586
- * 升序传 0,降序传 1
15767
+ * 排序顺序。
15768
+ - 0:升序
15769
+ - 1:降序
15587
15770
  */
15588
15771
  OrderType?: number;
15589
15772
  /**
15590
- *
15773
+ * TAG标签资源值。
15591
15774
  */
15592
15775
  ConfigTagList?: Array<string>;
15593
15776
  /**
15594
- *
15777
+ * 忽略传参,业务预留字段。
15595
15778
  */
15596
15779
  DisableProgramAuthCheck?: boolean;
15597
15780
  /**
15598
- *
15781
+ * 配置ID列表。该参数可以通过调用 [DescribeConfigs](https://cloud.tencent.com/document/product/649/38340) 的返回值中的 ConfigId 字段来获取或通过登录[控制台](https://console.cloud.tencent.com/tse/tsf-consul?subTab=app)配置详情-配置版本页查看;也可以调用[CreateConfig](https://cloud.tencent.com/document/product/649/38348)创建新的配置。
15599
15782
  */
15600
15783
  ConfigIdList?: Array<string>;
15601
15784
  }
@@ -15604,7 +15787,7 @@ export interface DescribeConfigSummaryRequest {
15604
15787
  */
15605
15788
  export interface DeleteLaneRequest {
15606
15789
  /**
15607
- * 泳道Idl
15790
+ * 泳道配置ID。该参数可以通过调用 [DescribeLanes](https://cloud.tencent.com/document/product/649/44504) 的返回值中的 LaneId 字段来获取或通过登录[控制台](https://console.cloud.tencent.com/tse/tsf-consul?tab=grayscale&subTab=lane)查看;也可以调用[CreateLane](https://cloud.tencent.com/document/product/649/44508)创建新的泳道配置。
15608
15791
  */
15609
15792
  LaneId: string;
15610
15793
  }
@@ -15651,15 +15834,15 @@ export interface TsfPageApiGroupInfo {
15651
15834
  */
15652
15835
  export interface ReleasePublicConfigRequest {
15653
15836
  /**
15654
- * 配置ID
15837
+ * 配置ID。该参数可以通过调用 [DescribePublicConfigs](https://cloud.tencent.com/document/product/649/38335) 的返回值中的 ConfigId 字段来获取或通过登录[控制台](https://console.cloud.tencent.com/tse/tsf-consul?subTab=public)配置详情-配置版本页查看;也可以调用[CreatePublicConfig](https://cloud.tencent.com/document/product/649/38347)创建新的配置。
15655
15838
  */
15656
15839
  ConfigId: string;
15657
15840
  /**
15658
- * 命名空间ID
15841
+ * 命名空间ID。该参数可以通过调用 [DescribeSimpleNamespaces](https://cloud.tencent.com/document/api/649/36096) 的返回值中的 NamespaceId 字段来获取或通过登录[控制台](https://console.cloud.tencent.com/tsf/resource?tab=namespace)查看;也可以调用[CreateNamespace](https://cloud.tencent.com/document/product/649/36098)创建新的命名空间。
15659
15842
  */
15660
15843
  NamespaceId: string;
15661
15844
  /**
15662
- * 发布描述
15845
+ * 发布描述,最多支持200个字符。
15663
15846
  */
15664
15847
  ReleaseDesc?: string;
15665
15848
  }
@@ -15668,11 +15851,11 @@ export interface ReleasePublicConfigRequest {
15668
15851
  */
15669
15852
  export interface TaskFlowEdge {
15670
15853
  /**
15671
- * 节点 ID
15854
+ * 节点 ID,节点类型为任务时为任务ID,节点类型为逻辑节点"且"时为 AND,为逻辑节点"或"时为 OR,节点类型为头节点时为字符串"head"
15672
15855
  */
15673
15856
  NodeId?: string;
15674
15857
  /**
15675
- * 子节点 ID
15858
+ * 子节点 ID,节点类型为任务时为任务ID,节点类型为逻辑节点"且"时为 AND,为逻辑节点"或"时为 OR
15676
15859
  */
15677
15860
  ChildNodeId?: string;
15678
15861
  /**
@@ -15680,11 +15863,11 @@ export interface TaskFlowEdge {
15680
15863
  */
15681
15864
  CoreNode?: string;
15682
15865
  /**
15683
- * 边类型
15866
+ * 边类型,上下游任务依赖触发关系。一共2个值,Y:成功触发,N:失败触发
15684
15867
  */
15685
15868
  EdgeType?: string;
15686
15869
  /**
15687
- * 任务节点类型
15870
+ * 任务节点类型,一共有4种类型,AND:逻辑节点且,OR:逻辑节点或,TASK:任务节点,START:头节点
15688
15871
  */
15689
15872
  NodeType?: string;
15690
15873
  /**
@@ -15696,11 +15879,11 @@ export interface TaskFlowEdge {
15696
15879
  */
15697
15880
  PositionY?: string;
15698
15881
  /**
15699
- * 图 ID
15882
+ * 图 ID,新建工作流时自动生成,不需要填写,查看工作流图时后端返回
15700
15883
  */
15701
15884
  GraphId?: string;
15702
15885
  /**
15703
- * 工作流 ID
15886
+ * 工作流 ID,新建工作流时自动生成,不需要填写,查看工作流图时后端返回
15704
15887
  */
15705
15888
  FlowId?: string;
15706
15889
  /**
@@ -15708,11 +15891,11 @@ export interface TaskFlowEdge {
15708
15891
  */
15709
15892
  NodeName?: string;
15710
15893
  /**
15711
- * 任务ID
15894
+ * 任务ID,新建工作流时不需要填写,查看工作流图时后端返回
15712
15895
  */
15713
15896
  TaskId?: string;
15714
15897
  /**
15715
- * 任务历史ID
15898
+ * 任务历史ID,新建工作流时不需要填写,查看工作流图时后端返回
15716
15899
  */
15717
15900
  TaskLogId?: string;
15718
15901
  }
@@ -15721,7 +15904,7 @@ export interface TaskFlowEdge {
15721
15904
  */
15722
15905
  export interface RedoTaskFlowBatchResponse {
15723
15906
  /**
15724
- * 工作流批次历史 ID
15907
+ * 工作流批次历史 ID。操作失败时不返回该字段,返回错误码。
15725
15908
  */
15726
15909
  Result?: string;
15727
15910
  /**