tencentcloud-sdk-nodejs 4.1.96 → 4.1.98

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 (48) 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/trtc/v20190722/trtc_client.js +9 -0
  5. package/package.json +1 -1
  6. package/tencentcloud/common/sdk_version.d.ts +1 -1
  7. package/tencentcloud/common/sdk_version.js +1 -1
  8. package/tencentcloud/services/batch/v20170312/batch_models.d.ts +23 -33
  9. package/tencentcloud/services/ckafka/v20190819/ckafka_models.d.ts +12 -12
  10. package/tencentcloud/services/clb/v20180317/clb_models.d.ts +2 -2
  11. package/tencentcloud/services/cls/v20201016/cls_client.d.ts +3 -3
  12. package/tencentcloud/services/cls/v20201016/cls_client.js +3 -3
  13. package/tencentcloud/services/cls/v20201016/cls_models.d.ts +495 -127
  14. package/tencentcloud/services/dlc/v20210125/dlc_models.d.ts +3 -3
  15. package/tencentcloud/services/dnspod/v20210323/dnspod_models.d.ts +5 -1
  16. package/tencentcloud/services/es/v20180416/es_models.d.ts +8 -0
  17. package/tencentcloud/services/ess/v20201111/ess_client.d.ts +3 -1
  18. package/tencentcloud/services/ess/v20201111/ess_client.js +3 -1
  19. package/tencentcloud/services/ess/v20201111/ess_models.d.ts +19 -2
  20. package/tencentcloud/services/essbasic/v20210526/essbasic_client.d.ts +3 -1
  21. package/tencentcloud/services/essbasic/v20210526/essbasic_client.js +3 -1
  22. package/tencentcloud/services/essbasic/v20210526/essbasic_models.d.ts +18 -1
  23. package/tencentcloud/services/faceid/v20180301/faceid_models.d.ts +34 -2
  24. package/tencentcloud/services/iai/v20200303/iai_models.d.ts +6 -0
  25. package/tencentcloud/services/lighthouse/v20200324/lighthouse_client.d.ts +16 -1
  26. package/tencentcloud/services/lighthouse/v20200324/lighthouse_client.js +19 -0
  27. package/tencentcloud/services/lighthouse/v20200324/lighthouse_models.d.ts +197 -42
  28. package/tencentcloud/services/live/v20180801/live_models.d.ts +1 -5
  29. package/tencentcloud/services/lke/v20231130/lke_client.d.ts +1 -5
  30. package/tencentcloud/services/lke/v20231130/lke_client.js +0 -6
  31. package/tencentcloud/services/lke/v20231130/lke_models.d.ts +8 -38
  32. package/tencentcloud/services/mariadb/v20170312/mariadb_models.d.ts +1 -1
  33. package/tencentcloud/services/ocr/v20181119/ocr_models.d.ts +10 -0
  34. package/tencentcloud/services/organization/v20210331/organization_models.d.ts +19 -20
  35. package/tencentcloud/services/ssl/v20191205/ssl_models.d.ts +1 -1
  36. package/tencentcloud/services/teo/v20220901/teo_models.d.ts +7 -7
  37. package/tencentcloud/services/trtc/v20190722/trtc_client.d.ts +13 -1
  38. package/tencentcloud/services/trtc/v20190722/trtc_client.js +18 -0
  39. package/tencentcloud/services/trtc/v20190722/trtc_models.d.ts +128 -0
  40. package/tencentcloud/services/tse/v20201207/tse_models.d.ts +8 -0
  41. package/tencentcloud/services/tsf/v20180326/tsf_client.d.ts +18 -18
  42. package/tencentcloud/services/tsf/v20180326/tsf_client.js +18 -18
  43. package/tencentcloud/services/tsf/v20180326/tsf_models.d.ts +488 -389
  44. package/tencentcloud/services/vod/v20180717/vod_models.d.ts +4 -0
  45. package/tencentcloud/services/vpc/v20170312/vpc_client.d.ts +2 -2
  46. package/tencentcloud/services/vpc/v20170312/vpc_client.js +1 -1
  47. package/tencentcloud/services/vpc/v20170312/vpc_models.d.ts +6 -1
  48. 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
  }
@@ -478,7 +482,7 @@ export interface TsfPageLicenseTag {
478
482
  */
479
483
  export interface DescribeApiVersionsResponse {
480
484
  /**
481
- * API版本列表
485
+ * API版本列表。
482
486
  */
483
487
  Result?: Array<ApiVersionArray>;
484
488
  /**
@@ -527,7 +531,7 @@ export interface StopContainerGroupResponse {
527
531
  */
528
532
  export interface CreateConfigTemplateWithDetailRespResponse {
529
533
  /**
530
- * 创建成功,返回 ID
534
+ * 创建成功,返回配置模板ID
531
535
  */
532
536
  Result?: ConfigTemplate;
533
537
  /**
@@ -549,7 +553,9 @@ export interface DeletePathRewritesRequest {
549
553
  */
550
554
  export interface DeleteLaneResponse {
551
555
  /**
552
- * 删除成功: true / 删除失败: false
556
+ * 删除结果。
557
+ - true:删除成功
558
+ - false:删除失败
553
559
  */
554
560
  Result?: boolean;
555
561
  /**
@@ -562,7 +568,7 @@ export interface DeleteLaneResponse {
562
568
  */
563
569
  export interface DescribeGroupReleaseRequest {
564
570
  /**
565
- * 部署组ID
571
+ * 部署组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
572
  */
567
573
  GroupId: string;
568
574
  }
@@ -571,7 +577,7 @@ export interface DescribeGroupReleaseRequest {
571
577
  */
572
578
  export interface DescribeConfigTemplateResponse {
573
579
  /**
574
- * 导入结果
580
+ * 导入结果。
575
581
  */
576
582
  Result?: ConfigTemplate;
577
583
  /**
@@ -693,7 +699,7 @@ export interface SimpleApplication {
693
699
  */
694
700
  export interface ContinueRunFailedTaskBatchRequest {
695
701
  /**
696
- * 批次ID。
702
+ * 任务批次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
703
  */
698
704
  BatchId: string;
699
705
  }
@@ -806,7 +812,7 @@ export interface DescribeSimpleGroupsResponse {
806
812
  */
807
813
  export interface DescribeConfigsResponse {
808
814
  /**
809
- * 分页后的配置项列表
815
+ * 分页后的配置项列表。
810
816
  */
811
817
  Result?: TsfPageConfig;
812
818
  /**
@@ -832,15 +838,15 @@ export interface ModifyContainerReplicasRequest {
832
838
  */
833
839
  export interface ReleaseFileConfigRequest {
834
840
  /**
835
- * 配置ID
841
+ * 配置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
842
  */
837
843
  ConfigId: string;
838
844
  /**
839
- * 部署组ID
845
+ * 部署组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
846
  */
841
847
  GroupId: string;
842
848
  /**
843
- * 发布描述
849
+ * 发布描述,最多支持200个字符。
844
850
  */
845
851
  ReleaseDesc?: string;
846
852
  }
@@ -901,7 +907,7 @@ export interface CreateGatewayApiResponse {
901
907
  */
902
908
  export interface DescribeFileConfigsResponse {
903
909
  /**
904
- * 文件配置项列表
910
+ * 文件配置项列表。
905
911
  */
906
912
  Result?: TsfPageFileConfig;
907
913
  /**
@@ -947,15 +953,22 @@ export interface DescribeClustersRequest {
947
953
  */
948
954
  export interface DescribeApiVersionsRequest {
949
955
  /**
950
- * 微服务ID
956
+ * 微服务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
957
  */
952
958
  MicroserviceId: string;
953
959
  /**
954
- * API 请求路径
960
+ * API请求路径。
955
961
  */
956
962
  Path?: string;
957
963
  /**
958
- * 请求方法
964
+ * API请求方法。
965
+ - GET
966
+ - POST
967
+ - PUT
968
+ - DELETE
969
+ - HEAD
970
+ - PATCH
971
+ - OPTIONS
959
972
  */
960
973
  Method?: string;
961
974
  }
@@ -1023,7 +1036,7 @@ export interface DescribeJvmMonitorRequest {
1023
1036
  */
1024
1037
  export interface EnableLaneRuleRequest {
1025
1038
  /**
1026
- * 泳道规则ID
1039
+ * 灰度发布规则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
1040
  */
1028
1041
  RuleId: string;
1029
1042
  }
@@ -1032,7 +1045,7 @@ export interface EnableLaneRuleRequest {
1032
1045
  */
1033
1046
  export interface TaskRule {
1034
1047
  /**
1035
- * 触发规则类型, Cron/Repeat
1048
+ * 触发规则类型,枚举值。一共3个值,Cron:定时触发,Repeat:周期触发,WorkFlow:工作流触发
1036
1049
  */
1037
1050
  RuleType: string;
1038
1051
  /**
@@ -1067,7 +1080,7 @@ export interface TaskRecord {
1067
1080
  */
1068
1081
  TaskType?: string;
1069
1082
  /**
1070
- * 执行类型
1083
+ * 任务执行方式,unicast:随机单节点执行,broadcast:广播执行,shard:分片执行
1071
1084
  */
1072
1085
  ExecuteType?: string;
1073
1086
  /**
@@ -1079,7 +1092,7 @@ export interface TaskRecord {
1079
1092
  */
1080
1093
  GroupId?: string;
1081
1094
  /**
1082
- * 超时时间
1095
+ * 超时时间,单位:毫秒。
1083
1096
  */
1084
1097
  TimeOut?: number;
1085
1098
  /**
@@ -1087,7 +1100,7 @@ export interface TaskRecord {
1087
1100
  */
1088
1101
  RetryCount?: number;
1089
1102
  /**
1090
- * 重试间隔
1103
+ * 重试间隔,单位:毫秒。
1091
1104
  */
1092
1105
  RetryInterval?: number;
1093
1106
  /**
@@ -1095,7 +1108,7 @@ export interface TaskRecord {
1095
1108
  */
1096
1109
  TaskRule?: TaskRule;
1097
1110
  /**
1098
- * 是否启用任务,ENABLED/DISABLED
1111
+ * 任务启用状态。一共2种状态可选,ENABLED:启用,DISABLED:停用
1099
1112
  */
1100
1113
  TaskState?: string;
1101
1114
  /**
@@ -1131,7 +1144,7 @@ export interface TaskRecord {
1131
1144
  */
1132
1145
  TaskLogId?: string;
1133
1146
  /**
1134
- * 触发类型
1147
+ * 触发类型,一共3种类型,WorkFlow:工作流触发,Cron:定时触发,FixRate:周期触发
1135
1148
  */
1136
1149
  TriggerType?: string;
1137
1150
  /**
@@ -1157,11 +1170,11 @@ export interface CreateNamespaceResponse {
1157
1170
  */
1158
1171
  export interface RedoTaskBatchRequest {
1159
1172
  /**
1160
- * 任务ID
1173
+ * 任务ID。在任务管理列表页面可以查看任务ID。
1161
1174
  */
1162
1175
  TaskId: string;
1163
1176
  /**
1164
- * 批次ID
1177
+ * 任务批次ID。在任务管理页面点击任务ID进入任务详情,进入执行记录列表页,第一列即为任务批次ID。
1165
1178
  */
1166
1179
  BatchId: string;
1167
1180
  }
@@ -1170,7 +1183,7 @@ export interface RedoTaskBatchRequest {
1170
1183
  */
1171
1184
  export interface DescribeTaskLastStatusRequest {
1172
1185
  /**
1173
- * 任务ID
1186
+ * 任务ID。在[任务管理](https://console.cloud.tencent.com/tsf/tct?rid=1)列表页第一列和任务基本信息页查看任务ID。
1174
1187
  */
1175
1188
  TaskId: string;
1176
1189
  }
@@ -1188,7 +1201,9 @@ export interface ModifyUploadInfoResponse {
1188
1201
  */
1189
1202
  export interface EnableLaneRuleResponse {
1190
1203
  /**
1191
- * 操作状态。成功:true,失败:false
1204
+ * 操作状态。
1205
+ - true:成功
1206
+ - false:失败
1192
1207
  */
1193
1208
  Result?: boolean;
1194
1209
  /**
@@ -1248,7 +1263,9 @@ export interface CreateApiRateLimitRuleRequest {
1248
1263
  */
1249
1264
  export interface DisableLaneRuleResponse {
1250
1265
  /**
1251
- * 操作状态。成功:true,失败:false
1266
+ * 操作状态。
1267
+ - true:成功
1268
+ - false:失败
1252
1269
  */
1253
1270
  Result?: boolean;
1254
1271
  /**
@@ -1331,7 +1348,7 @@ export interface ChangeApiUsableStatusRequest {
1331
1348
  */
1332
1349
  export interface DescribeMicroservicesResponse {
1333
1350
  /**
1334
- * 微服务分页列表信息
1351
+ * 微服务分页列表信息。
1335
1352
  */
1336
1353
  Result?: TsfPageMicroservice;
1337
1354
  /**
@@ -1366,7 +1383,7 @@ export interface DescribeApiGroupsResponse {
1366
1383
  */
1367
1384
  export interface DeletePublicConfigRequest {
1368
1385
  /**
1369
- * 配置项ID
1386
+ * 配置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
1387
  */
1371
1388
  ConfigId: string;
1372
1389
  }
@@ -1390,15 +1407,15 @@ export interface DeleteNamespaceResponse {
1390
1407
  */
1391
1408
  export interface CreateMicroserviceRequest {
1392
1409
  /**
1393
- * 命名空间ID
1410
+ * 命名空间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
1411
  */
1395
1412
  NamespaceId: string;
1396
1413
  /**
1397
- * 微服务名称
1414
+ * 微服务名称。该参数可以通过调用 [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
1415
  */
1399
1416
  MicroserviceName: string;
1400
1417
  /**
1401
- * 微服务描述信息
1418
+ * 微服务备注信息,最多支持200个字符。
1402
1419
  */
1403
1420
  MicroserviceDesc?: string;
1404
1421
  }
@@ -1407,7 +1424,9 @@ export interface CreateMicroserviceRequest {
1407
1424
  */
1408
1425
  export interface ReleaseConfigResponse {
1409
1426
  /**
1410
- * true:发布成功;false:发布失败
1427
+ * 发布结果。
1428
+ - true:发布成功
1429
+ - false:发布失败
1411
1430
  */
1412
1431
  Result?: boolean;
1413
1432
  /**
@@ -1450,15 +1469,15 @@ export interface DescribeRepositoriesRequest {
1450
1469
  */
1451
1470
  SearchWord?: string;
1452
1471
  /**
1453
- * 查询起始偏移
1472
+ * 查询起始偏移,大于等于0,默认值为0
1454
1473
  */
1455
1474
  Offset?: number;
1456
1475
  /**
1457
- * 返回数量限制
1476
+ * 返回数量限制,大于0,默认为不分页
1458
1477
  */
1459
1478
  Limit?: number;
1460
1479
  /**
1461
- * 仓库类型(默认仓库:default,私有仓库:private)
1480
+ * 仓库类型(默认仓库:default,私有仓库:private,公共仓库:public-demo
1462
1481
  */
1463
1482
  RepositoryType?: string;
1464
1483
  }
@@ -1488,11 +1507,11 @@ export interface InvocationMetricScatterPlot {
1488
1507
  */
1489
1508
  export interface RollbackConfigRequest {
1490
1509
  /**
1491
- * 配置项发布历史ID
1510
+ * 配置项发布历史ID。该参数可以通过调用 [DescribeConfigReleaseLogs](https://cloud.tencent.com/document/product/649/38343) 的返回值中的 ConfigReleaseLogId 字段来获取或通过登录[控制台](https://console.cloud.tencent.com/tse/tsf-consul?subTab=app)配置详情-发布情况页查看。
1492
1511
  */
1493
1512
  ConfigReleaseLogId: string;
1494
1513
  /**
1495
- * 回滚描述
1514
+ * 回滚描述,最多支持200个字符。
1496
1515
  */
1497
1516
  ReleaseDesc?: string;
1498
1517
  }
@@ -1531,7 +1550,9 @@ export interface CreateGatewayApiRequest {
1531
1550
  */
1532
1551
  export interface DescribeCreateGatewayApiStatusResponse {
1533
1552
  /**
1534
- * 是否已完成导入任务
1553
+ * 导入任务状态执行结果。
1554
+ - true:已完成
1555
+ - false:未完成
1535
1556
  */
1536
1557
  Result?: boolean;
1537
1558
  /**
@@ -1544,7 +1565,9 @@ export interface DescribeCreateGatewayApiStatusResponse {
1544
1565
  */
1545
1566
  export interface DeleteConfigResponse {
1546
1567
  /**
1547
- * true:删除成功;false:删除失败
1568
+ * 删除结果。
1569
+ - true:删除成功
1570
+ - false:删除失败
1548
1571
  */
1549
1572
  Result?: boolean;
1550
1573
  /**
@@ -1873,31 +1896,33 @@ export interface ModifyNamespaceResponse {
1873
1896
  */
1874
1897
  export interface ModifyLaneRuleRequest {
1875
1898
  /**
1876
- * 泳道规则ID
1899
+ * 灰度发布规则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
1900
  */
1878
1901
  RuleId: string;
1879
1902
  /**
1880
- * 泳道规则名称
1903
+ * 灰度发布规则名称,最多支持60个字符,支持中英文字符。
1881
1904
  */
1882
1905
  RuleName: string;
1883
1906
  /**
1884
- * 泳道规则备注
1907
+ * 灰度发布规则备注,最多支持200个字符。
1885
1908
  */
1886
1909
  Remark: string;
1887
1910
  /**
1888
- * 泳道规则标签列表
1911
+ * 灰度发布规则标签列表。
1889
1912
  */
1890
1913
  RuleTagList: Array<LaneRuleTag>;
1891
1914
  /**
1892
- * 泳道规则标签关系
1915
+ * 灰度发布规则标签关系。- RELEATION_AND:与- RELEATION_OR:或
1893
1916
  */
1894
1917
  RuleTagRelationship: string;
1895
1918
  /**
1896
- * 泳道ID
1919
+ * 泳道配置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
1920
  */
1898
1921
  LaneId: string;
1899
1922
  /**
1900
- * 开启状态
1923
+ * 开启状态。
1924
+ - true:开启
1925
+ - false:关闭
1901
1926
  */
1902
1927
  Enable: boolean;
1903
1928
  }
@@ -1954,7 +1979,7 @@ export interface DescribeRepositoryResponse {
1954
1979
  */
1955
1980
  export interface ReleaseConfigWithDetailRespResponse {
1956
1981
  /**
1957
- * 配置项发布 ID
1982
+ * 配置项发布ID
1958
1983
  */
1959
1984
  Result?: ConfigRelease;
1960
1985
  /**
@@ -2251,7 +2276,7 @@ export declare type DescribeResourceConfigRequest = null;
2251
2276
  */
2252
2277
  export interface CreateMicroserviceResponse {
2253
2278
  /**
2254
- * 新增微服务是否成功。
2279
+ * 新增结果。
2255
2280
  true:操作成功。
2256
2281
  false:操作失败。
2257
2282
  */
@@ -2266,39 +2291,39 @@ export interface CreateMicroserviceResponse {
2266
2291
  */
2267
2292
  export interface CreateFileConfigWithDetailRespRequest {
2268
2293
  /**
2269
- * 配置项名称
2294
+ * 配置名称,最多支持60个字符,只能包含字母、数字及分隔符(“-”、“_”),且不能以分隔符开头或结尾。
2270
2295
  */
2271
2296
  ConfigName: string;
2272
2297
  /**
2273
- * 配置项版本
2298
+ * 配置项版本,只能包含小写字母、数字及分隔符("-","."),且必须以小写字母或数字开头、以小写字母或数字结尾,中间不能有连续的"-"或"."。
2274
2299
  */
2275
2300
  ConfigVersion: string;
2276
2301
  /**
2277
- * 配置项文件名
2302
+ * 配置项文件名,不超过60个字符,只能包含英文、数字、"-"(英文)、"_"(英文)、"."(英文)。
2278
2303
  */
2279
2304
  ConfigFileName: string;
2280
2305
  /**
2281
- * 配置项文件内容(原始内容编码需要 utf-8 格式,如果 ConfigFileCode 为 gbk,后台会进行转换)
2306
+ * 配置项文件内容(原始内容编码需要 utf-8 格式,如果 ConfigFileCode 为 gbk,后台会进行转换)。
2282
2307
  */
2283
2308
  ConfigFileValue: string;
2284
2309
  /**
2285
- * 配置项关联应用ID
2310
+ * 配置项关联应用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
2311
  */
2287
2312
  ApplicationId: string;
2288
2313
  /**
2289
- * 发布路径
2314
+ * 发布路径。
2290
2315
  */
2291
2316
  ConfigFilePath: string;
2292
2317
  /**
2293
- * 配置项版本描述
2318
+ * 配置项版本描述,最多支持200个字符。
2294
2319
  */
2295
2320
  ConfigVersionDesc?: string;
2296
2321
  /**
2297
- * 配置项文件编码,utf-8 或 gbk。注:如果选择 gbk,需要新版本 tsf-consul-template (公有云虚拟机需要使用 1.32 tsf-agent,容器需要从文档中获取最新的 tsf-consul-template-docker.tar.gz)的支持
2322
+ * 配置项文件编码,utf-8 或 gbk。注:如果选择 gbk,需要新版本 tsf-consul-template (公有云虚拟机需要使用 1.32 tsf-agent,容器需要从文档中获取最新的 tsf-consul-template-docker.tar.gz)的支持。
2298
2323
  */
2299
2324
  ConfigFileCode?: string;
2300
2325
  /**
2301
- * 后置命令
2326
+ * 后置命令。
2302
2327
  */
2303
2328
  ConfigPostCmd?: string;
2304
2329
  /**
@@ -2306,7 +2331,7 @@ export interface CreateFileConfigWithDetailRespRequest {
2306
2331
  */
2307
2332
  EncodeWithBase64?: boolean;
2308
2333
  /**
2309
- *
2334
+ * 需要绑定的数据集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
2335
  */
2311
2336
  ProgramIdList?: Array<string>;
2312
2337
  }
@@ -2389,7 +2414,7 @@ export interface CosUploadInfo {
2389
2414
  */
2390
2415
  export interface DescribeLanesResponse {
2391
2416
  /**
2392
- * 泳道列表
2417
+ * 泳道配置列表。
2393
2418
  */
2394
2419
  Result?: LaneInfos;
2395
2420
  /**
@@ -2452,19 +2477,19 @@ export interface CreateNamespaceRequest {
2452
2477
  */
2453
2478
  export interface DescribeDownloadInfoRequest {
2454
2479
  /**
2455
- * 应用ID
2480
+ * 应用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
2481
  */
2457
2482
  ApplicationId: string;
2458
2483
  /**
2459
- * 程序包ID
2484
+ * 软件包ID可通过调用DescribeUploadInfo接口时[获取上传程序包信息](https://cloud.tencent.com/document/api/649/36078)返回的COS上传信息获取,登录[控制台](https://console.cloud.tencent.com/tsf/product?rid=1)进行查看
2460
2485
  */
2461
2486
  PkgId: string;
2462
2487
  /**
2463
- * 程序包仓库ID
2488
+ * 仓库ID,可通过调用[仓库信息查询类](https://cloud.tencent.com/document/api/649/45925)接口时出参中的RepositoryId,或登录[控制台](https://console.cloud.tencent.com/tsf/product?rid=1)进行查看
2464
2489
  */
2465
2490
  RepositoryId?: string;
2466
2491
  /**
2467
- * 程序包仓库类型
2492
+ * 程序包仓库类型(允许值:"public-demo"TSF公共demo仓库, "private"自定义仓库, "default"TSF公共仓库)
2468
2493
  */
2469
2494
  RepositoryType?: string;
2470
2495
  }
@@ -2538,7 +2563,7 @@ export interface DescribeGroupBindedGatewaysRequest {
2538
2563
  */
2539
2564
  export interface DescribeRepositoryRequest {
2540
2565
  /**
2541
- * 仓库ID
2566
+ * 仓库ID,可通过调用[仓库信息查询类](https://cloud.tencent.com/document/api/649/45925)接口时出参中的RepositoryId,或登录[控制台](https://console.cloud.tencent.com/tsf/product?rid=1)进行查看
2542
2567
  */
2543
2568
  RepositoryId: string;
2544
2569
  }
@@ -2547,31 +2572,33 @@ export interface DescribeRepositoryRequest {
2547
2572
  */
2548
2573
  export interface CreatePublicConfigWithDetailRespRequest {
2549
2574
  /**
2550
- * 配置项名称
2575
+ * 配置项名称,最多支持60个字符,只能包含字母、数字及分隔符(“-”、“_”),且不能以分隔符开头或结尾。
2551
2576
  */
2552
2577
  ConfigName: string;
2553
2578
  /**
2554
- * 配置项版本
2579
+ * 配置项版本,最多支持60个字符,只能包含小写字母、数字及分隔符("-","."),且必须以小写字母或数字开头、以小写字母或数字结尾,中间不能有连续的"-"或"."。
2555
2580
  */
2556
2581
  ConfigVersion: string;
2557
2582
  /**
2558
- * 配置项值,总是接收yaml格式的内容
2583
+ * 配置项值,总是接收yaml格式的内容。
2559
2584
  */
2560
2585
  ConfigValue: string;
2561
2586
  /**
2562
- * 配置项版本描述
2587
+ * 配置项版本描述,最多支持200个字符。
2563
2588
  */
2564
2589
  ConfigVersionDesc?: string;
2565
2590
  /**
2566
- * 配置项类型
2591
+ * 配置项类型,固定值。
2567
2592
  */
2568
2593
  ConfigType?: string;
2569
2594
  /**
2570
- * Base64编码的配置项
2595
+ * Base64编码的配置项。
2596
+ - true:开启
2597
+ - false:关闭
2571
2598
  */
2572
2599
  EncodeWithBase64?: boolean;
2573
2600
  /**
2574
- *
2601
+ * 需要绑定的数据集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
2602
  */
2576
2603
  ProgramIdList?: Array<string>;
2577
2604
  }
@@ -2593,7 +2620,7 @@ export interface DescribeResourceTaskStatusResponse {
2593
2620
  */
2594
2621
  export interface RedoTaskRequest {
2595
2622
  /**
2596
- * 任务ID
2623
+ * 任务ID。在任务管理列表页面第一列查看任务ID。
2597
2624
  */
2598
2625
  TaskId: string;
2599
2626
  }
@@ -2686,7 +2713,7 @@ export interface DraftApiGroupRequest {
2686
2713
  */
2687
2714
  export interface CreateLaneResponse {
2688
2715
  /**
2689
- * 泳道ID
2716
+ * 泳道配置ID
2690
2717
  */
2691
2718
  Result?: string;
2692
2719
  /**
@@ -2922,7 +2949,7 @@ export interface DescribeProgramsRequest {
2922
2949
  */
2923
2950
  export interface DescribePublicConfigRequest {
2924
2951
  /**
2925
- * 需要查询的配置项ID
2952
+ * 需要查询的配置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
2953
  */
2927
2954
  ConfigId: string;
2928
2955
  }
@@ -3087,7 +3114,9 @@ export interface CommonOption {
3087
3114
  */
3088
3115
  export interface CreatePublicConfigResponse {
3089
3116
  /**
3090
- * true:创建成功;false:创建失败
3117
+ * 创建结果。
3118
+ - true:创建成功
3119
+ - false:创建失败
3091
3120
  */
3092
3121
  Result?: boolean;
3093
3122
  /**
@@ -3126,7 +3155,9 @@ export interface TsfPageVmGroup {
3126
3155
  */
3127
3156
  export interface CreateConfigResponse {
3128
3157
  /**
3129
- * true:创建成功;false:创建失败
3158
+ * 创建结果。
3159
+ - true:创建成功
3160
+ - false:创建失败
3130
3161
  */
3131
3162
  Result?: boolean;
3132
3163
  /**
@@ -3139,7 +3170,7 @@ export interface CreateConfigResponse {
3139
3170
  */
3140
3171
  export interface RevokeFileConfigRequest {
3141
3172
  /**
3142
- * 配置项发布ID
3173
+ * 按照【配置项发布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
3174
  */
3144
3175
  ConfigReleaseId: string;
3145
3176
  }
@@ -3148,11 +3179,11 @@ export interface RevokeFileConfigRequest {
3148
3179
  */
3149
3180
  export interface DescribeCreateGatewayApiStatusRequest {
3150
3181
  /**
3151
- * 所属分组ID
3182
+ * 网关分组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
3183
  */
3153
3184
  GroupId?: string;
3154
3185
  /**
3155
- * 微服务ID
3186
+ * 微服务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
3187
  */
3157
3188
  MicroserviceId?: string;
3158
3189
  }
@@ -3174,27 +3205,27 @@ export interface RevocationPublicConfigResponse {
3174
3205
  */
3175
3206
  export interface DescribeConfigReleaseLogsRequest {
3176
3207
  /**
3177
- * 部署组ID,不传入时查询全量
3208
+ * 部署组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
3209
  */
3179
3210
  GroupId?: string;
3180
3211
  /**
3181
- * 偏移量,默认为0
3212
+ * 偏移量,默认为0
3182
3213
  */
3183
3214
  Offset?: number;
3184
3215
  /**
3185
- * 每页条数,默认为20
3216
+ * 返回数量,默认为20,最大值为100。
3186
3217
  */
3187
3218
  Limit?: number;
3188
3219
  /**
3189
- * 命名空间ID,不传入时查询全量
3220
+ * 命名空间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
3221
  */
3191
3222
  NamespaceId?: string;
3192
3223
  /**
3193
- * 集群ID,不传入时查询全量
3224
+ * 集群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
3225
  */
3195
3226
  ClusterId?: string;
3196
3227
  /**
3197
- * 应用ID,不传入时查询全量
3228
+ * 应用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
3229
  */
3199
3230
  ApplicationId?: string;
3200
3231
  }
@@ -3242,7 +3273,9 @@ export interface DisassociateKafkaConfigRequest {
3242
3273
  */
3243
3274
  export interface TsfConfigCenter {
3244
3275
  /**
3245
- * 配置中心类型
3276
+ * 配置中心类型。
3277
+ - SHARE:共享型
3278
+ - EXCLUSIVE:独占型
3246
3279
  注意:此字段可能返回 null,表示取不到有效值。
3247
3280
  */
3248
3281
  ConfigType?: string;
@@ -3282,7 +3315,9 @@ export interface TsfConfigCenter {
3282
3315
  */
3283
3316
  export interface RollbackConfigResponse {
3284
3317
  /**
3285
- * true:回滚成功;false:回滚失败
3318
+ * 回滚结果。
3319
+ - true:回滚成功
3320
+ - false:回滚失败
3286
3321
  */
3287
3322
  Result?: boolean;
3288
3323
  /**
@@ -3295,7 +3330,7 @@ export interface RollbackConfigResponse {
3295
3330
  */
3296
3331
  export interface RevocationConfigRequest {
3297
3332
  /**
3298
- * 配置项发布ID
3333
+ * 配置项发布ID。该参数可以通过调用 [DescribeConfigReleases](https://cloud.tencent.com/document/product/649/38342) 的返回值中的 ConfigReleaseId 字段来获取或通过登录[控制台](https://console.cloud.tencent.com/tse/tsf-consul?subTab=app)配置详情-发布情况页查看。
3299
3334
  */
3300
3335
  ConfigReleaseId: string;
3301
3336
  }
@@ -3319,23 +3354,23 @@ export interface StartContainerGroupResponse {
3319
3354
  */
3320
3355
  export interface ModifyTaskRequest {
3321
3356
  /**
3322
- * 任务ID
3357
+ * 任务ID。在任务管理列表页面第一列查看任务ID。
3323
3358
  */
3324
3359
  TaskId: string;
3325
3360
  /**
3326
- * 任务名称
3361
+ * 任务名称,长度限制为64字符。在任务管理列表页面第一列或是任务基本信息页查看任务名称。
3327
3362
  */
3328
3363
  TaskName?: string;
3329
3364
  /**
3330
- * 任务类型
3365
+ * 任务类型。当前只支持一种任务类型。枚举值,java:Java类任务
3331
3366
  */
3332
3367
  TaskType?: string;
3333
3368
  /**
3334
- * 任务内容
3369
+ * 任务内容,长度限制为 65536 字节
3335
3370
  */
3336
3371
  TaskContent?: string;
3337
3372
  /**
3338
- * 任务执行类型
3373
+ * 任务执行方式,枚举值。unicast:随机单节点执行,broadcast:广播执行,shard:分片执行
3339
3374
  */
3340
3375
  ExecuteType?: string;
3341
3376
  /**
@@ -3343,15 +3378,15 @@ export interface ModifyTaskRequest {
3343
3378
  */
3344
3379
  TaskRule?: TaskRule;
3345
3380
  /**
3346
- * 超时时间,单位 ms
3381
+ * 超时时间,取值大于0,单位:毫秒(ms
3347
3382
  */
3348
3383
  TimeOut?: number;
3349
3384
  /**
3350
- * 分组ID
3385
+ * 部署组ID。在[应用管理](https://console.cloud.tencent.com/tsf/app?rid=1),点击应用ID进入应用部署页查看部署组ID。
3351
3386
  */
3352
3387
  GroupId?: string;
3353
3388
  /**
3354
- * 分片数量
3389
+ * 分片数量,取值范围2~1000
3355
3390
  */
3356
3391
  ShardCount?: number;
3357
3392
  /**
@@ -3367,15 +3402,15 @@ export interface ModifyTaskRequest {
3367
3402
  */
3368
3403
  SuccessOperator?: string;
3369
3404
  /**
3370
- * 判断任务成功率的阈值
3405
+ * 判断任务成功率的阈值,取值范围:1-100,单位:百分比(%)
3371
3406
  */
3372
3407
  SuccessRatio?: number;
3373
3408
  /**
3374
- * 重试次数
3409
+ * 重试次数,取值范围 0 - 10,单位:次
3375
3410
  */
3376
3411
  RetryCount?: number;
3377
3412
  /**
3378
- * 重试间隔
3413
+ * 重试间隔,取值范围 0-600,单位:秒(s)
3379
3414
  */
3380
3415
  RetryInterval?: number;
3381
3416
  /**
@@ -3383,7 +3418,7 @@ export interface ModifyTaskRequest {
3383
3418
  */
3384
3419
  TaskArgument?: string;
3385
3420
  /**
3386
- *
3421
+ * 数据集列表。
3387
3422
  */
3388
3423
  ProgramIdList?: Array<string>;
3389
3424
  }
@@ -3405,7 +3440,7 @@ export interface DeleteUnitNamespacesResponse {
3405
3440
  */
3406
3441
  export interface DescribeMicroservicesByGroupIdsRequest {
3407
3442
  /**
3408
- * 部署组ID列表
3443
+ * 部署组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
3444
  */
3410
3445
  GroupIds: Array<string>;
3411
3446
  }
@@ -3479,7 +3514,9 @@ export interface TsfPageInstance {
3479
3514
  */
3480
3515
  export interface ModifyLaneResponse {
3481
3516
  /**
3482
- * 更新成功: true / 更新失败: false
3517
+ * 更新结果。
3518
+ - true:更新成功
3519
+ - false:更新失败
3483
3520
  */
3484
3521
  Result?: boolean;
3485
3522
  /**
@@ -3884,7 +3921,7 @@ export interface ContainGroup {
3884
3921
  */
3885
3922
  export interface CreateConfigWithDetailRespResponse {
3886
3923
  /**
3887
- * 配置项
3924
+ * 配置项。
3888
3925
  */
3889
3926
  Result?: Config;
3890
3927
  /**
@@ -3944,7 +3981,9 @@ export interface UpdateUnitRuleRequest {
3944
3981
  */
3945
3982
  export interface ReleasePublicConfigResponse {
3946
3983
  /**
3947
- * true:发布成功;false:发布失败
3984
+ * 发布结果。
3985
+ - true:发布成功
3986
+ - false:发布失败
3948
3987
  */
3949
3988
  Result?: boolean;
3950
3989
  /**
@@ -4032,19 +4071,19 @@ export interface DescribeGroupInstancesRequest {
4032
4071
  */
4033
4072
  export interface DescribeMsApiListRequest {
4034
4073
  /**
4035
- * 微服务ID
4074
+ * 微服务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
4075
  */
4037
4076
  MicroserviceId: string;
4038
4077
  /**
4039
- * 搜索关键字
4078
+ * 搜索关键字。
4040
4079
  */
4041
4080
  SearchWord?: string;
4042
4081
  /**
4043
- * 每页的数量
4082
+ * 返回数量,默认为20,最大值为50。
4044
4083
  */
4045
4084
  Limit?: number;
4046
4085
  /**
4047
- * 翻页偏移量
4086
+ * 偏移量,默认为0。
4048
4087
  */
4049
4088
  Offset?: number;
4050
4089
  }
@@ -4106,7 +4145,7 @@ export interface LifeCycleHook {
4106
4145
  */
4107
4146
  export interface DescribeMsApiListResponse {
4108
4147
  /**
4109
- * 相应结果
4148
+ * 微服务API列表。
4110
4149
  */
4111
4150
  Result?: TsfApiListResponse;
4112
4151
  /**
@@ -4119,7 +4158,7 @@ export interface DescribeMsApiListResponse {
4119
4158
  */
4120
4159
  export interface EnableTaskRequest {
4121
4160
  /**
4122
- * 启用任务
4161
+ * 任务ID。在任务管理列表页面和任务基本信息页可以查看任务ID。
4123
4162
  */
4124
4163
  TaskId: string;
4125
4164
  }
@@ -4157,7 +4196,7 @@ export interface BusinessLogV2 {
4157
4196
  */
4158
4197
  export interface DisableTaskResponse {
4159
4198
  /**
4160
- * 操作成功 or 失败
4199
+ * true:操作成功,false:操作失败
4161
4200
  */
4162
4201
  Result?: boolean;
4163
4202
  /**
@@ -4170,23 +4209,29 @@ export interface DisableTaskResponse {
4170
4209
  */
4171
4210
  export interface DescribeMicroserviceRequest {
4172
4211
  /**
4173
- * 微服务ID
4212
+ * 微服务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
4213
  */
4175
4214
  MicroserviceId: string;
4176
4215
  /**
4177
- * 偏移量
4216
+ * 偏移量,默认为0。
4178
4217
  */
4179
4218
  Offset?: number;
4180
4219
  /**
4181
- * 分页个数
4220
+ * 返回数量,默认为20,最大值为50。
4182
4221
  */
4183
4222
  Limit?: number;
4184
4223
  /**
4185
- * 可选,根据部署组ID进行过滤
4224
+ * 部署组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
4225
  */
4187
4226
  GroupIds?: Array<string>;
4188
4227
  /**
4189
- * 过滤条件。多个 filter 之间是与关系,单个 filter 多个 value 之间是或关系。filter name 取值有:id(实例id)、name(实例名)、lan-ip(内网ip)、node-ip(所在节点ip)
4228
+ * 过滤条件。多个 filter 之间是与关系,单个 filter 多个 value 之间是或关系。
4229
+ 参考:[{"Name":"LanIp","Values":["172.16.16.139"]}]
4230
+ filter name 取值范围:
4231
+ - id:实例ID
4232
+ - name:实例名
4233
+ - lan-ip:内网IP
4234
+ - node-ip:所在节点IP
4190
4235
  */
4191
4236
  Filters?: Array<Filter>;
4192
4237
  }
@@ -4272,7 +4317,7 @@ export interface FileConfigRelease {
4272
4317
  */
4273
4318
  ReleaseDesc?: string;
4274
4319
  /**
4275
- * 发布时间
4320
+ * 发布时间。格式为 YYYY-MM-DD hh:mm:ss。
4276
4321
  注意:此字段可能返回 null,表示取不到有效值。
4277
4322
  */
4278
4323
  ReleaseTime?: string;
@@ -4619,7 +4664,7 @@ export interface DescribeContainerGroupDetailResponse {
4619
4664
  */
4620
4665
  export interface DisableTaskRequest {
4621
4666
  /**
4622
- * 任务ID
4667
+ * 任务ID。在[任务管理](https://console.cloud.tencent.com/tsf/tct?rid=1)列表页第一列或是任务基本信息页查看任务ID。
4623
4668
  */
4624
4669
  TaskId: string;
4625
4670
  }
@@ -4654,7 +4699,7 @@ export interface Ports {
4654
4699
  */
4655
4700
  export interface UpdateRepositoryRequest {
4656
4701
  /**
4657
- * 仓库ID
4702
+ * 仓库ID,可通过调用[仓库信息查询类](https://cloud.tencent.com/document/api/649/45925)接口时出参中的RepositoryId,或登录[控制台](https://console.cloud.tencent.com/tsf/product?rid=1)进行查看
4658
4703
  */
4659
4704
  RepositoryId: string;
4660
4705
  /**
@@ -4695,7 +4740,9 @@ export interface SimpleKafkaDeliveryConfig {
4695
4740
  */
4696
4741
  export interface RevocationConfigResponse {
4697
4742
  /**
4698
- * true:回滚成功;false:回滚失败
4743
+ * 撤回结果。
4744
+ - true:成功
4745
+ - false:失败
4699
4746
  */
4700
4747
  Result?: boolean;
4701
4748
  /**
@@ -4721,7 +4768,7 @@ export interface PkgBind {
4721
4768
  */
4722
4769
  export interface DeleteTaskResponse {
4723
4770
  /**
4724
- * 删除成功or失败
4771
+ * true:删除成功,false:删除失败
4725
4772
  */
4726
4773
  Result?: boolean;
4727
4774
  /**
@@ -4749,7 +4796,7 @@ export interface TsfPageMsInstance {
4749
4796
  */
4750
4797
  export interface DeleteMicroserviceRequest {
4751
4798
  /**
4752
- * 微服务ID
4799
+ * 微服务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
4800
  */
4754
4801
  MicroserviceId: string;
4755
4802
  }
@@ -4758,7 +4805,7 @@ export interface DeleteMicroserviceRequest {
4758
4805
  */
4759
4806
  export interface CreatePublicConfigWithDetailRespResponse {
4760
4807
  /**
4761
- * 公共配置项 ID
4808
+ * 公共配置项ID
4762
4809
  */
4763
4810
  Result?: Config;
4764
4811
  /**
@@ -4771,35 +4818,37 @@ export interface CreatePublicConfigWithDetailRespResponse {
4771
4818
  */
4772
4819
  export interface CreateConfigWithDetailRespRequest {
4773
4820
  /**
4774
- * 配置项名称
4821
+ * 配置项名称,最多支持60个字符,只能包含字母、数字及分隔符(“-”、“_”),且不能以分隔符开头或结尾。
4775
4822
  */
4776
4823
  ConfigName: string;
4777
4824
  /**
4778
- * 配置项版本
4825
+ * 配置项版本,只能包含小写字母、数字及分隔符("-","."),且必须以小写字母或数字开头、以小写字母或数字结尾,中间不能有连续的"-"或"."。
4779
4826
  */
4780
4827
  ConfigVersion: string;
4781
4828
  /**
4782
- * 配置项值
4829
+ * 配置项值。
4783
4830
  */
4784
4831
  ConfigValue: string;
4785
4832
  /**
4786
- * 应用ID
4833
+ * 应用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
4834
  */
4788
4835
  ApplicationId: string;
4789
4836
  /**
4790
- * 配置项版本描述
4837
+ * 配置项版本描述,最多支持200个字符。
4791
4838
  */
4792
4839
  ConfigVersionDesc?: string;
4793
4840
  /**
4794
- * 配置项值类型
4841
+ * 配置项值类型,固定值。
4795
4842
  */
4796
4843
  ConfigType?: string;
4797
4844
  /**
4798
- * Base64编码的配置项
4845
+ * Base64编码的配置项。
4846
+ - true:开启
4847
+ - false:关闭
4799
4848
  */
4800
4849
  EncodeWithBase64?: boolean;
4801
4850
  /**
4802
- *
4851
+ * 需要绑定的数据集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
4852
  */
4804
4853
  ProgramIdList?: Array<string>;
4805
4854
  }
@@ -5168,7 +5217,7 @@ export interface GroupUnitApiDailyUseStatistics {
5168
5217
  */
5169
5218
  export interface DescribeFileConfigReleasesResponse {
5170
5219
  /**
5171
- * 配置项发布信息列表
5220
+ * 配置项发布信息列表。
5172
5221
  */
5173
5222
  Result?: TsfPageFileConfigRelease;
5174
5223
  /**
@@ -5194,7 +5243,7 @@ export interface DisableUnitRouteResponse {
5194
5243
  */
5195
5244
  export interface ExecuteTaskRequest {
5196
5245
  /**
5197
- * 任务 ID
5246
+ * 任务ID。在任务管理列表页面第一列或是任务基本信息页查看任务ID。
5198
5247
  */
5199
5248
  TaskId: string;
5200
5249
  }
@@ -5276,7 +5325,7 @@ export interface LaneInfo {
5276
5325
  */
5277
5326
  export interface DescribeConfigReleaseLogsResponse {
5278
5327
  /**
5279
- * 分页的配置项发布历史列表
5328
+ * 分页的配置项发布历史列表。
5280
5329
  */
5281
5330
  Result?: TsfPageConfigReleaseLog;
5282
5331
  /**
@@ -5289,7 +5338,9 @@ export interface DescribeConfigReleaseLogsResponse {
5289
5338
  */
5290
5339
  export interface DeletePublicConfigResponse {
5291
5340
  /**
5292
- * true:删除成功;false:删除失败
5341
+ * 删除结果。
5342
+ - true:删除成功
5343
+ - false:删除失败
5293
5344
  */
5294
5345
  Result?: boolean;
5295
5346
  /**
@@ -5315,7 +5366,7 @@ export interface DescribePathRewriteResponse {
5315
5366
  */
5316
5367
  export interface DescribeFlowLastBatchStateRequest {
5317
5368
  /**
5318
- * 工作流 ID
5369
+ * 工作流 ID。前往[工作流管理](https://console.cloud.tencent.com/tsf/tct?rid=1&tab=workflowManage),在工作流列表第一列和工作流详情页查看工作流ID。
5319
5370
  */
5320
5371
  FlowId: string;
5321
5372
  }
@@ -5370,7 +5421,7 @@ export interface GroupInfo {
5370
5421
  */
5371
5422
  export interface TerminateTaskFlowBatchResponse {
5372
5423
  /**
5373
- * 是否停止成功
5424
+ * 是否停止成功,true:停止成功,false:停止失败
5374
5425
  */
5375
5426
  Result?: boolean;
5376
5427
  /**
@@ -5431,7 +5482,9 @@ export interface ShrinkInstancesResponse {
5431
5482
  */
5432
5483
  export interface DeleteLaneRuleResponse {
5433
5484
  /**
5434
- * 操作状态
5485
+ * 删除结果。
5486
+ - true:成功
5487
+ - false:失败
5435
5488
  */
5436
5489
  Result?: boolean;
5437
5490
  /**
@@ -5876,11 +5929,11 @@ export interface DescribeOverviewInvocationResponse {
5876
5929
  */
5877
5930
  export interface ShrinkInstancesRequest {
5878
5931
  /**
5879
- * 部署组ID
5932
+ * 部署组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
5933
  */
5881
5934
  GroupId: string;
5882
5935
  /**
5883
- * 下线机器实例ID列表
5936
+ * 实例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
5937
  */
5885
5938
  InstanceIdList: Array<string>;
5886
5939
  }
@@ -5938,7 +5991,7 @@ export interface DescribeSimpleNamespacesRequest {
5938
5991
  */
5939
5992
  export interface ExecuteTaskFlowResponse {
5940
5993
  /**
5941
- * 工作流批次ID
5994
+ * 操作成功返回工作流批次ID,操作失败返回空字符串。
5942
5995
  */
5943
5996
  Result?: string;
5944
5997
  /**
@@ -6038,7 +6091,7 @@ export interface ExpandGroupResponse {
6038
6091
  */
6039
6092
  export interface DescribePublicConfigsResponse {
6040
6093
  /**
6041
- * 分页后的全局配置项列表
6094
+ * 分页后的全局配置项列表。
6042
6095
  */
6043
6096
  Result?: TsfPageConfig;
6044
6097
  /**
@@ -6220,7 +6273,7 @@ export interface ApiDefinitionDescr {
6220
6273
  */
6221
6274
  export interface DescribeLaneRulesResponse {
6222
6275
  /**
6223
- * 泳道规则列表
6276
+ * 灰度发布规则列表。
6224
6277
  */
6225
6278
  Result?: LaneRules;
6226
6279
  /**
@@ -6524,7 +6577,7 @@ export interface ImageRepositoryResult {
6524
6577
  */
6525
6578
  export interface ModifyTaskResponse {
6526
6579
  /**
6527
- * 更新是否成功
6580
+ * 更新是否成功。true:操作成功、false:操作失败
6528
6581
  */
6529
6582
  Result?: boolean;
6530
6583
  /**
@@ -6646,7 +6699,9 @@ export interface UnitRuleItem {
6646
6699
  */
6647
6700
  export interface UpdateConfigTemplateResponse {
6648
6701
  /**
6649
- * 更新成功: true / 更新失败: false
6702
+ * 更新结果。
6703
+ - true:成功
6704
+ - false:失败
6650
6705
  */
6651
6706
  Result?: boolean;
6652
6707
  /**
@@ -6741,7 +6796,7 @@ export interface HealthCheckSetting {
6741
6796
  */
6742
6797
  export interface DeleteLaneRuleRequest {
6743
6798
  /**
6744
- * 泳道规则Id
6799
+ * 灰度发布规则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
6800
  */
6746
6801
  RuleId: string;
6747
6802
  }
@@ -7239,7 +7294,7 @@ export interface RepositoryList {
7239
7294
  */
7240
7295
  export interface CreateLaneRuleResponse {
7241
7296
  /**
7242
- * 泳道规则Id
7297
+ * 灰度发布规则ID。
7243
7298
  */
7244
7299
  Result?: string;
7245
7300
  /**
@@ -7650,7 +7705,7 @@ export interface CreateTaskFlowRequest {
7650
7705
  */
7651
7706
  export interface CreateFileConfigWithDetailRespResponse {
7652
7707
  /**
7653
- * 文件配置项
7708
+ * 文件配置项。
7654
7709
  */
7655
7710
  Result?: FileConfig;
7656
7711
  /**
@@ -7663,23 +7718,23 @@ export interface CreateFileConfigWithDetailRespResponse {
7663
7718
  */
7664
7719
  export interface CreateConfigTemplateWithDetailRespRequest {
7665
7720
  /**
7666
- * 配置模板名称
7721
+ * 配置模板名称,最多支持60个字符,只能包含字母、数字及分隔符(“-”),且不能以分隔符开头或结尾。
7667
7722
  */
7668
7723
  ConfigTemplateName: string;
7669
7724
  /**
7670
- * 配置模板对应的微服务框架
7725
+ * 配置模板对应的微服务框架。- Ribbon:Ribbon类型配置模板- Hystrix:Hystrix类型配置模板- Zuul:Zuul类型配置模板- customize:自定义类型配置模板。
7671
7726
  */
7672
7727
  ConfigTemplateType: string;
7673
7728
  /**
7674
- * 配置模板数据
7729
+ * 配置模板数据。
7675
7730
  */
7676
7731
  ConfigTemplateValue: string;
7677
7732
  /**
7678
- * 配置模板描述
7733
+ * 配置模板描述,最多支持200个字符。
7679
7734
  */
7680
7735
  ConfigTemplateDesc?: string;
7681
7736
  /**
7682
- *
7737
+ * 需要绑定的数据集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
7738
  */
7684
7739
  ProgramIdList?: Array<string>;
7685
7740
  }
@@ -7731,7 +7786,7 @@ export interface UnbindApiGroupResponse {
7731
7786
  */
7732
7787
  export interface DescribeGroupReleaseResponse {
7733
7788
  /**
7734
- * 部署组发布的相关信息
7789
+ * 部署组发布的相关信息。
7735
7790
  */
7736
7791
  Result?: GroupRelease;
7737
7792
  /**
@@ -8110,7 +8165,7 @@ export interface ImageTag {
8110
8165
  */
8111
8166
  export interface ExecuteTaskFlowRequest {
8112
8167
  /**
8113
- * 工作流 ID
8168
+ * 工作流 ID。前往工作流管理,在工作流列表第一列和工作流详情页查看工作流ID。
8114
8169
  */
8115
8170
  FlowId?: string;
8116
8171
  }
@@ -8132,7 +8187,7 @@ export interface DescribeBusinessLogConfigResponse {
8132
8187
  */
8133
8188
  export interface TerminateTaskFlowBatchRequest {
8134
8189
  /**
8135
- * 工作流批次 ID
8190
+ * 工作流批次 ID,在[工作流执行记录](https://console.cloud.tencent.com/tsf/tct?rid=1&tab=taskflow)列表页第一列获取。
8136
8191
  */
8137
8192
  FlowBatchId: string;
8138
8193
  }
@@ -8483,11 +8538,11 @@ export interface ServiceSetting {
8483
8538
  */
8484
8539
  export interface ModifyUploadInfoRequest {
8485
8540
  /**
8486
- * 应用ID
8541
+ * 应用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
8542
  */
8488
8543
  ApplicationId: string;
8489
8544
  /**
8490
- * 调用DescribeUploadInfo接口时返回的软件包ID
8545
+ * 软件包ID可通过调用DescribeUploadInfo接口时[获取上传程序包信息](https://cloud.tencent.com/document/api/649/36078)返回的COS上传信息获取,登录[控制台](https://console.cloud.tencent.com/tsf/product?rid=1)进行查看
8491
8546
  */
8492
8547
  PkgId: string;
8493
8548
  /**
@@ -8507,7 +8562,7 @@ export interface ModifyUploadInfoRequest {
8507
8562
  */
8508
8563
  RepositoryType?: string;
8509
8564
  /**
8510
- * 程序包仓库id
8565
+ * 仓库ID,可通过调用[仓库信息查询类](https://cloud.tencent.com/document/api/649/45925)接口时出参中的RepositoryId,或登录[控制台](https://console.cloud.tencent.com/tsf/product?rid=1)进行查看
8511
8566
  */
8512
8567
  RepositoryId?: string;
8513
8568
  }
@@ -8594,7 +8649,9 @@ export interface CreatePathRewritesWithDetailRespRequest {
8594
8649
  */
8595
8650
  export interface DeleteFileConfigResponse {
8596
8651
  /**
8597
- * 删除结果
8652
+ * 删除结果。
8653
+ - true:成功
8654
+ - false:失败
8598
8655
  */
8599
8656
  Result?: boolean;
8600
8657
  /**
@@ -8666,7 +8723,7 @@ export interface DeleteApiRateLimitRuleResponse {
8666
8723
  */
8667
8724
  export interface DeleteFileConfigRequest {
8668
8725
  /**
8669
- * 文件配置项ID
8726
+ * 文件配置项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
8727
  */
8671
8728
  ConfigId: string;
8672
8729
  }
@@ -8675,7 +8732,7 @@ export interface DeleteFileConfigRequest {
8675
8732
  */
8676
8733
  export interface DescribePublicConfigSummaryResponse {
8677
8734
  /**
8678
- * 分页的全局配置统计信息列表
8735
+ * 分页的全局配置统计信息列表。
8679
8736
  */
8680
8737
  Result?: TsfPageConfig;
8681
8738
  /**
@@ -8688,15 +8745,15 @@ export interface DescribePublicConfigSummaryResponse {
8688
8745
  */
8689
8746
  export interface DescribePublicConfigReleaseLogsRequest {
8690
8747
  /**
8691
- * 命名空间ID,不传入时查询全量
8748
+ * 命名空间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
8749
  */
8693
8750
  NamespaceId?: string;
8694
8751
  /**
8695
- * 偏移量,默认为0
8752
+ * 偏移量,默认为0
8696
8753
  */
8697
8754
  Offset?: number;
8698
8755
  /**
8699
- * 每页条数,默认为20
8756
+ * 返回数量,默认为20,最大值为100。
8700
8757
  */
8701
8758
  Limit?: number;
8702
8759
  }
@@ -8762,15 +8819,15 @@ export interface DescribeApplicationAttributeResponse {
8762
8819
  */
8763
8820
  export interface ModifyLaneRequest {
8764
8821
  /**
8765
- * 泳道ID
8822
+ * 泳道配置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
8823
  */
8767
8824
  LaneId: string;
8768
8825
  /**
8769
- * 泳道名称
8826
+ * 泳道配置名称,最多支持60个字符,只能包含字母、数字及分隔符(“-”),且不能以分隔符开头或结尾。
8770
8827
  */
8771
8828
  LaneName: string;
8772
8829
  /**
8773
- * 备注
8830
+ * 备注,最多支持200个字符。
8774
8831
  */
8775
8832
  Remark: string;
8776
8833
  }
@@ -8779,23 +8836,23 @@ export interface ModifyLaneRequest {
8779
8836
  */
8780
8837
  export interface DescribeLanesRequest {
8781
8838
  /**
8782
- * 每页展示的条数
8839
+ * 返回数量,默认为20,最大值为100。
8783
8840
  */
8784
8841
  Limit?: number;
8785
8842
  /**
8786
- * 翻页偏移量
8843
+ * 偏移量,默认为0。
8787
8844
  */
8788
8845
  Offset?: number;
8789
8846
  /**
8790
- * 搜索关键字
8847
+ * 搜索关键字。
8791
8848
  */
8792
8849
  SearchWord?: string;
8793
8850
  /**
8794
- *
8851
+ * 泳道配置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
8852
  */
8796
8853
  LaneIdList?: Array<string>;
8797
8854
  /**
8798
- *
8855
+ * 忽略传参,业务预留字段。
8799
8856
  */
8800
8857
  DisableProgramAuthCheck?: boolean;
8801
8858
  }
@@ -8877,31 +8934,33 @@ export interface BusinesLogConfigAssociatedGroup {
8877
8934
  */
8878
8935
  export interface CreatePublicConfigRequest {
8879
8936
  /**
8880
- * 配置项名称
8937
+ * 配置名称,最长60个字符,只能包含字母、数字及分隔符(“-”、“_”),且不能以分隔符开头或结尾。
8881
8938
  */
8882
8939
  ConfigName: string;
8883
8940
  /**
8884
- * 配置项版本
8941
+ * 配置版本,只能包含小写字母、数字及分隔符("-","."),且必须以小写字母或数字开头、以小写字母或数字结尾,中间不能有连续的"-"或"."。
8885
8942
  */
8886
8943
  ConfigVersion: string;
8887
8944
  /**
8888
- * 配置项值,总是接收yaml格式的内容
8945
+ * 配置项值,总是接收yaml格式的内容。
8889
8946
  */
8890
8947
  ConfigValue: string;
8891
8948
  /**
8892
- * 配置项版本描述
8949
+ * 配置项版本描述,最多支持200个字符。
8893
8950
  */
8894
8951
  ConfigVersionDesc?: string;
8895
8952
  /**
8896
- * 配置项类型
8953
+ * 配置项类型,固定值。
8897
8954
  */
8898
8955
  ConfigType?: string;
8899
8956
  /**
8900
- * Base64编码的配置项
8957
+ * Base64编码的配置项。
8958
+ - true:开启
8959
+ - false:关闭
8901
8960
  */
8902
8961
  EncodeWithBase64?: boolean;
8903
8962
  /**
8904
- *
8963
+ * 需要绑定的数据集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
8964
  */
8906
8965
  ProgramIdList?: Array<string>;
8907
8966
  }
@@ -9203,7 +9262,7 @@ export interface BindPluginResponse {
9203
9262
  */
9204
9263
  export interface RedoTaskFlowBatchRequest {
9205
9264
  /**
9206
- * 工作流批次 ID
9265
+ * 工作流批次 ID。在工作流管理页面,点击第一列的工作流ID进入工作流执行记录列表页面,第一列的内容即为工作流批次ID。
9207
9266
  */
9208
9267
  FlowBatchId: string;
9209
9268
  }
@@ -9225,15 +9284,15 @@ export interface TsfPageUnitNamespace {
9225
9284
  */
9226
9285
  export interface CreateMicroserviceWithDetailRespRequest {
9227
9286
  /**
9228
- * 命名空间ID
9287
+ * 命名空间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
9288
  */
9230
9289
  NamespaceId: string;
9231
9290
  /**
9232
- * 微服务名称
9291
+ * 微服务名称,最多支持128个字符。
9233
9292
  */
9234
9293
  MicroserviceName: string;
9235
9294
  /**
9236
- * 微服务描述信息
9295
+ * 微服务描述信息,最多支持200个字符。
9237
9296
  */
9238
9297
  MicroserviceDesc?: string;
9239
9298
  }
@@ -9322,7 +9381,7 @@ export interface DeleteApiRateLimitRuleRequest {
9322
9381
  */
9323
9382
  export interface DescribePkgsRequest {
9324
9383
  /**
9325
- * 应用ID(只传入应用ID,返回该应用下所有软件包信息)
9384
+ * 应用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
9385
  */
9327
9386
  ApplicationId: string;
9328
9387
  /**
@@ -9330,7 +9389,7 @@ export interface DescribePkgsRequest {
9330
9389
  */
9331
9390
  SearchWord?: string;
9332
9391
  /**
9333
- * 排序关键字(默认为"UploadTime":上传时间)
9392
+ * 排序关键字(默认值"UploadTime"),允许值:"UploadTime"上传时间, "name"程序包名, "size"应用大小, "id"程序包ID
9334
9393
  */
9335
9394
  OrderBy?: string;
9336
9395
  /**
@@ -9338,7 +9397,7 @@ export interface DescribePkgsRequest {
9338
9397
  */
9339
9398
  OrderType?: number;
9340
9399
  /**
9341
- * 查询起始偏移
9400
+ * 查询起始偏移,大于等于0,默认值为0
9342
9401
  */
9343
9402
  Offset?: number;
9344
9403
  /**
@@ -9346,11 +9405,11 @@ export interface DescribePkgsRequest {
9346
9405
  */
9347
9406
  Limit?: number;
9348
9407
  /**
9349
- * 程序包仓库类型
9408
+ * 程序包仓库类型,允许值:"public-demo"TSF公共demo仓库, "private"自定义仓库, "default"TSF公共仓库
9350
9409
  */
9351
9410
  RepositoryType?: string;
9352
9411
  /**
9353
- * 程序包仓库id
9412
+ * 仓库ID,可通过调用[仓库信息查询类](https://cloud.tencent.com/document/api/649/45925)接口时出参中的RepositoryId,或登录[控制台](https://console.cloud.tencent.com/tsf/product?rid=1)进行查看
9354
9413
  */
9355
9414
  RepositoryId?: string;
9356
9415
  /**
@@ -9435,15 +9494,15 @@ export interface DescribeApplicationAttributeRequest {
9435
9494
  */
9436
9495
  export interface ReleaseConfigWithDetailRespRequest {
9437
9496
  /**
9438
- * 配置ID
9497
+ * 配置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
9498
  */
9440
9499
  ConfigId: string;
9441
9500
  /**
9442
- * 部署组ID
9501
+ * 部署组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
9502
  */
9444
9503
  GroupId: string;
9445
9504
  /**
9446
- * 发布描述
9505
+ * 发布描述,最多支持200个字符。
9447
9506
  */
9448
9507
  ReleaseDesc?: string;
9449
9508
  }
@@ -9460,19 +9519,19 @@ export interface CreateTaskRequest {
9460
9519
  */
9461
9520
  TaskContent: string;
9462
9521
  /**
9463
- * 执行类型,unicast/broadcast
9522
+ * 任务执行方式,unicast:随机单节点执行,broadcast:广播执行,shard:分片执行
9464
9523
  */
9465
9524
  ExecuteType: string;
9466
9525
  /**
9467
- * 任务类型,java
9526
+ * 任务类型。当前只支持一种任务类型。枚举值,java:Java类任务
9468
9527
  */
9469
9528
  TaskType: string;
9470
9529
  /**
9471
- * 任务超时时间, 时间单位 ms
9530
+ * 任务超时时间,取值大于0,单位:毫秒(ms
9472
9531
  */
9473
9532
  TimeOut: number;
9474
9533
  /**
9475
- * 部署组ID
9534
+ * 部署组ID。在[应用管理](https://console.cloud.tencent.com/tsf/app?rid=1),点击应用ID进入应用部署页查看部署组ID。
9476
9535
  */
9477
9536
  GroupId: string;
9478
9537
  /**
@@ -9488,7 +9547,7 @@ export interface CreateTaskRequest {
9488
9547
  */
9489
9548
  RetryInterval?: number;
9490
9549
  /**
9491
- * 分片数量
9550
+ * 分片数量,仅当任务执行方式为分片执行时需要设置该值,取值范围2~1000
9492
9551
  */
9493
9552
  ShardCount?: number;
9494
9553
  /**
@@ -9512,7 +9571,7 @@ export interface CreateTaskRequest {
9512
9571
  */
9513
9572
  TaskArgument?: string;
9514
9573
  /**
9515
- *
9574
+ * 数据集列表
9516
9575
  */
9517
9576
  ProgramIdList?: Array<string>;
9518
9577
  }
@@ -9559,7 +9618,7 @@ export interface OperationInfo {
9559
9618
  */
9560
9619
  export interface DescribePublicConfigResponse {
9561
9620
  /**
9562
- * 全局配置
9621
+ * 全局配置。
9563
9622
  注意:此字段可能返回 null,表示取不到有效值。
9564
9623
  */
9565
9624
  Result?: Config;
@@ -9586,7 +9645,9 @@ export interface DescribeUsableUnitNamespacesResponse {
9586
9645
  */
9587
9646
  export interface ReleaseFileConfigResponse {
9588
9647
  /**
9589
- * 发布结果,成功:true,失败:false。
9648
+ * 发布结果。
9649
+ - true:成功
9650
+ - false:失败
9590
9651
  */
9591
9652
  Result?: boolean;
9592
9653
  /**
@@ -9621,7 +9682,7 @@ export interface ThreadPicture {
9621
9682
  */
9622
9683
  export interface DescribeConfigResponse {
9623
9684
  /**
9624
- * 配置项
9685
+ * 配置信息。
9625
9686
  注意:此字段可能返回 null,表示取不到有效值。
9626
9687
  */
9627
9688
  Result?: Config;
@@ -9705,11 +9766,11 @@ export interface CreateApiRateLimitRuleWithDetailRespResponse {
9705
9766
  */
9706
9767
  export interface DescribeTaskRecordsRequest {
9707
9768
  /**
9708
- * 翻页偏移量。
9769
+ * 翻页偏移量。默认值为0
9709
9770
  */
9710
9771
  Offset?: number;
9711
9772
  /**
9712
- * 翻页查询单页数量。
9773
+ * 翻页查询单页数量。默认值为 20,最大值为 1000
9713
9774
  */
9714
9775
  Limit?: number;
9715
9776
  /**
@@ -9717,23 +9778,23 @@ export interface DescribeTaskRecordsRequest {
9717
9778
  */
9718
9779
  SearchWord?: string;
9719
9780
  /**
9720
- * 任务启用状态。enabled/disabled
9781
+ * 任务启用状态。一共2种状态可选,ENABLED:启用,DISABLED:停用
9721
9782
  */
9722
9783
  TaskState?: string;
9723
9784
  /**
9724
- * 分组ID。
9785
+ * 部署组ID。前往应用管理 - 应用部署,部署组列表页面获取部署组ID
9725
9786
  */
9726
9787
  GroupId?: string;
9727
9788
  /**
9728
- * 任务类型。
9789
+ * 任务类型。当前只支持一种任务类型。枚举值,java:Java类任务
9729
9790
  */
9730
9791
  TaskType?: string;
9731
9792
  /**
9732
- * 任务触发类型,UNICAST、BROADCAST。
9793
+ * 任务执行方式,unicast:随机单节点执行,broadcast:广播执行,shard:分片执行
9733
9794
  */
9734
9795
  ExecuteType?: string;
9735
9796
  /**
9736
- *
9797
+ * 任务ID列表。
9737
9798
  */
9738
9799
  Ids?: Array<string>;
9739
9800
  }
@@ -9855,7 +9916,7 @@ export interface DescribeUnitNamespacesRequest {
9855
9916
  */
9856
9917
  export interface DeleteTaskRequest {
9857
9918
  /**
9858
- * 任务ID
9919
+ * 任务ID。在[任务管理](https://console.cloud.tencent.com/tsf/tct?rid=1)列表页第一列和任务基本信息页查看任务ID。
9859
9920
  */
9860
9921
  TaskId: string;
9861
9922
  }
@@ -9998,7 +10059,7 @@ export interface DescribeBusinessLogConfigsRequest {
9998
10059
  */
9999
10060
  export interface DeleteConfigTemplateRequest {
10000
10061
  /**
10001
- *
10062
+ * 配置模板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
10063
  */
10003
10064
  ConfigTemplateId: string;
10004
10065
  }
@@ -10237,35 +10298,37 @@ export interface ConfigReleaseLog {
10237
10298
  */
10238
10299
  export interface CreateConfigRequest {
10239
10300
  /**
10240
- * 配置项名称
10301
+ * 配置项名称,最多支持60个字符,只能包含字母、数字及分隔符(“-”、“_”),且不能以分隔符开头或结尾。
10241
10302
  */
10242
10303
  ConfigName: string;
10243
10304
  /**
10244
- * 配置项版本
10305
+ * 配置项版本,只能包含小写字母、数字及分隔符("-","."),且必须以小写字母或数字开头、以小写字母或数字结尾,中间不能有连续的"-"或"."。
10245
10306
  */
10246
10307
  ConfigVersion: string;
10247
10308
  /**
10248
- * 配置项值
10309
+ * 配置项值。
10249
10310
  */
10250
10311
  ConfigValue: string;
10251
10312
  /**
10252
- * 应用ID
10313
+ * 应用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
10314
  */
10254
10315
  ApplicationId: string;
10255
10316
  /**
10256
- * 配置项版本描述
10317
+ * 配置项版本描述,最多支持200个字符。
10257
10318
  */
10258
10319
  ConfigVersionDesc?: string;
10259
10320
  /**
10260
- * 配置项值类型
10321
+ * 配置项值类型,固定值。
10261
10322
  */
10262
10323
  ConfigType?: string;
10263
10324
  /**
10264
- * Base64编码的配置项
10325
+ * Base64编码的配置项。
10326
+ - true:开启
10327
+ - false:关闭
10265
10328
  */
10266
10329
  EncodeWithBase64?: boolean;
10267
10330
  /**
10268
- *
10331
+ * 需要绑定的数据集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
10332
  */
10270
10333
  ProgramIdList?: Array<string>;
10271
10334
  }
@@ -10767,43 +10830,50 @@ export interface CreateTaskFlowResponse {
10767
10830
  */
10768
10831
  export interface DescribeMicroservicesRequest {
10769
10832
  /**
10770
- * 命名空间ID
10833
+ * 命名空间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
10834
  */
10772
10835
  NamespaceId: string;
10773
10836
  /**
10774
- * 搜索字段
10837
+ * 搜索字段。
10775
10838
  */
10776
10839
  SearchWord?: string;
10777
10840
  /**
10778
- * 排序字段
10841
+ * 排序字段。
10842
+ - create_time:创建时间
10843
+ 默认为创建时间,暂不支持其他值。
10779
10844
  */
10780
10845
  OrderBy?: string;
10781
10846
  /**
10782
- * 排序类型
10847
+ * 排序类型。
10848
+ - 1:倒序
10849
+ 默认为倒序,暂不支持其他值。
10783
10850
  */
10784
10851
  OrderType?: number;
10785
10852
  /**
10786
- * 偏移量
10853
+ * 偏移量,默认为0。
10787
10854
  */
10788
10855
  Offset?: number;
10789
10856
  /**
10790
- * 分页个数
10857
+ * 返回数量,默认为20,最大值为50。
10791
10858
  */
10792
10859
  Limit?: number;
10793
10860
  /**
10794
- * 状态过滤,online、offline、single_online
10861
+ * 状态。
10862
+ - online:在线
10863
+ - offline:离线
10864
+ - single_online:单点在线
10795
10865
  */
10796
10866
  Status?: Array<string>;
10797
10867
  /**
10798
- * IdList
10868
+ * 微服务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
10869
  */
10800
10870
  MicroserviceIdList?: Array<string>;
10801
10871
  /**
10802
- * 搜索的服务名列表
10872
+ * 微服务名称列表。该参数可以通过调用 [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
10873
  */
10804
10874
  MicroserviceNameList?: Array<string>;
10805
10875
  /**
10806
- * 注册中心实例id
10876
+ * 注册中心实例ID。业务预留参数,忽略传参。
10807
10877
  */
10808
10878
  ConfigCenterInstanceId?: string;
10809
10879
  }
@@ -10920,27 +10990,27 @@ export interface DescribeTaskLastStatusResponse {
10920
10990
  */
10921
10991
  export interface DescribePublicConfigsRequest {
10922
10992
  /**
10923
- * 配置项ID,不传入时查询全量,高优先级
10993
+ * 配置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
10994
  */
10925
10995
  ConfigId?: string;
10926
10996
  /**
10927
- * 偏移量,默认为0
10997
+ * 偏移量,默认为0
10928
10998
  */
10929
10999
  Offset?: number;
10930
11000
  /**
10931
- * 每页条数,默认为20
11001
+ * 返回数量,默认为20,最大值为100。
10932
11002
  */
10933
11003
  Limit?: number;
10934
11004
  /**
10935
- * 配置项ID列表,不传入时查询全量,低优先级
11005
+ * 配置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
11006
  */
10937
11007
  ConfigIdList?: Array<string>;
10938
11008
  /**
10939
- * 配置项名称,精确查询,不传入时查询全量
11009
+ * 配置项名称,精确查询,不传入时查询全量。
10940
11010
  */
10941
11011
  ConfigName?: string;
10942
11012
  /**
10943
- * 配置项版本,精确查询,不传入时查询全量
11013
+ * 配置项版本,精确查询,不传入时查询全量。
10944
11014
  */
10945
11015
  ConfigVersion?: string;
10946
11016
  }
@@ -11070,11 +11140,11 @@ export interface DescribeApplicationsRequest {
11070
11140
  */
11071
11141
  export interface DescribeTaskDetailRequest {
11072
11142
  /**
11073
- * 任务ID
11143
+ * 任务ID。在[任务管理](https://console.cloud.tencent.com/tsf/tct?rid=1)列表页第一列和任务基本信息页查看任务ID。
11074
11144
  */
11075
11145
  TaskId: string;
11076
11146
  /**
11077
- * 任务历史ID
11147
+ * 任务历史ID。查询任务列表 [DescribeTaskRecords](https://cloud.tencent.com/document/api/649/56136) 返回值字段 TaskLogId
11078
11148
  */
11079
11149
  TaskLogId?: string;
11080
11150
  }
@@ -11092,23 +11162,23 @@ export interface MultiValue {
11092
11162
  */
11093
11163
  export interface DescribePublicConfigReleasesRequest {
11094
11164
  /**
11095
- * 配置项名称,不传入时查询全量
11165
+ * 配置名称,不传入时查询全量。该参数可以通过调用 [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
11166
  */
11097
11167
  ConfigName?: string;
11098
11168
  /**
11099
- * 命名空间ID,不传入时查询全量
11169
+ * 命名空间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
11170
  */
11101
11171
  NamespaceId?: string;
11102
11172
  /**
11103
- * 每页条数
11173
+ * 返回数量,默认为20,最大值为100。
11104
11174
  */
11105
11175
  Limit?: number;
11106
11176
  /**
11107
- * 偏移量
11177
+ * 偏移量,默认为0。
11108
11178
  */
11109
11179
  Offset?: number;
11110
11180
  /**
11111
- * 配置项ID,不传入时查询全量
11181
+ * 配置项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
11182
  */
11113
11183
  ConfigId?: string;
11114
11184
  }
@@ -11130,23 +11200,23 @@ export interface TsfPageFileConfigRelease {
11130
11200
  */
11131
11201
  export interface DescribeLaneRulesRequest {
11132
11202
  /**
11133
- * 每页展示的条数
11203
+ * 返回数量,默认为20,最大值为500。
11134
11204
  */
11135
11205
  Limit?: number;
11136
11206
  /**
11137
- * 翻页偏移量
11207
+ * 偏移量,默认为0。
11138
11208
  */
11139
11209
  Offset?: number;
11140
11210
  /**
11141
- * 搜索关键词
11211
+ * 搜索关键词。
11142
11212
  */
11143
11213
  SearchWord?: string;
11144
11214
  /**
11145
- * 泳道规则ID(用于精确搜索)
11215
+ * 灰度发布规则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
11216
  */
11147
11217
  RuleId?: string;
11148
11218
  /**
11149
- *
11219
+ * 灰度发布规则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
11220
  */
11151
11221
  RuleIdList?: Array<string>;
11152
11222
  }
@@ -11225,27 +11295,29 @@ export interface CreateRepositoryResponse {
11225
11295
  */
11226
11296
  export interface CreateLaneRuleRequest {
11227
11297
  /**
11228
- * 泳道规则名称
11298
+ * 灰度发布规则名称,最多支持60个字符,支持中英文字符。
11229
11299
  */
11230
11300
  RuleName: string;
11231
11301
  /**
11232
- * 泳道规则备注
11302
+ * 灰度发布规则备注,最多支持200个字符。
11233
11303
  */
11234
11304
  Remark: string;
11235
11305
  /**
11236
- * 泳道规则标签列表
11306
+ * 灰度发布规则标签列表。
11237
11307
  */
11238
11308
  RuleTagList: Array<LaneRuleTag>;
11239
11309
  /**
11240
- * 泳道规则标签关系
11310
+ * 灰度发布规则标签关系。
11311
+ - RELEATION_AND:与
11312
+ - RELEATION_OR:或
11241
11313
  */
11242
11314
  RuleTagRelationship: string;
11243
11315
  /**
11244
- * 泳道Id
11316
+ * 泳道配置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
11317
  */
11246
11318
  LaneId: string;
11247
11319
  /**
11248
- *
11320
+ * 需要绑定的数据集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
11321
  */
11250
11322
  ProgramIdList?: Array<string>;
11251
11323
  }
@@ -11292,19 +11364,19 @@ export interface CosDownloadInfo {
11292
11364
  */
11293
11365
  export interface DeletePkgsRequest {
11294
11366
  /**
11295
- * 应用ID
11367
+ * 应用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
11368
  */
11297
11369
  ApplicationId: string;
11298
11370
  /**
11299
- * 需要删除的程序包ID列表
11371
+ * 软件包ID所形成的列表,软件包ID可通过调用DescribeUploadInfo接口时[获取上传程序包信息](https://cloud.tencent.com/document/api/649/36078)返回的COS上传信息获取,登录[控制台](https://console.cloud.tencent.com/tsf/product?rid=1)进行查看
11300
11372
  */
11301
11373
  PkgIds: Array<string>;
11302
11374
  /**
11303
- * 程序包仓库类型
11375
+ * 程序包仓库类型(允许值:"public-demo"TSF公共demo仓库, "private"自定义仓库, "default"TSF公共仓库)
11304
11376
  */
11305
11377
  RepositoryType?: string;
11306
11378
  /**
11307
- * 程序包仓库id
11379
+ * 仓库ID,可通过调用[仓库信息查询类](https://cloud.tencent.com/document/api/649/45925)接口时出参中的RepositoryId,或登录[控制台](https://console.cloud.tencent.com/tsf/product?rid=1)进行查看
11308
11380
  */
11309
11381
  RepositoryId?: string;
11310
11382
  }
@@ -11313,15 +11385,15 @@ export interface DeletePkgsRequest {
11313
11385
  */
11314
11386
  export interface CreateFileConfigRequest {
11315
11387
  /**
11316
- * 配置项名称
11388
+ * 配置项名称,最多支持60个字符,只能包含字母、数字及分隔符(“-”、“_”),且不能以分隔符开头或结尾。
11317
11389
  */
11318
11390
  ConfigName: string;
11319
11391
  /**
11320
- * 配置项版本
11392
+ * 配置项版本,只能包含小写字母、数字及分隔符("-","."),且必须以小写字母或数字开头、以小写字母或数字结尾,中间不能有连续的"-"或"."。
11321
11393
  */
11322
11394
  ConfigVersion: string;
11323
11395
  /**
11324
- * 配置项文件名
11396
+ * 配置项文件名,最多支持60个字符,只能包含英文、数字、"-"(英文)、"_"(英文)、"."(英文)。
11325
11397
  */
11326
11398
  ConfigFileName: string;
11327
11399
  /**
@@ -11329,31 +11401,33 @@ export interface CreateFileConfigRequest {
11329
11401
  */
11330
11402
  ConfigFileValue: string;
11331
11403
  /**
11332
- * 配置项关联应用ID
11404
+ * 配置项关联应用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
11405
  */
11334
11406
  ApplicationId: string;
11335
11407
  /**
11336
- * 发布路径
11408
+ * 发布路径。
11337
11409
  */
11338
11410
  ConfigFilePath: string;
11339
11411
  /**
11340
- * 配置项版本描述
11412
+ * 配置项版本描述,最多支持200个字符。
11341
11413
  */
11342
11414
  ConfigVersionDesc?: string;
11343
11415
  /**
11344
- * 配置项文件编码,utf-8 或 gbk。注:如果选择 gbk,需要新版本 tsf-consul-template (公有云虚拟机需要使用 1.32 tsf-agent,容器需要从文档中获取最新的 tsf-consul-template-docker.tar.gz)的支持
11416
+ * 配置项文件编码,utf-8 或 gbk。注:如果选择 gbk,需要新版本 tsf-consul-template (公有云虚拟机需要使用 1.32 tsf-agent,容器需要从文档中获取最新的 tsf-consul-template-docker.tar.gz)的支持。
11345
11417
  */
11346
11418
  ConfigFileCode?: string;
11347
11419
  /**
11348
- * 后置命令
11420
+ * 后置命令。
11349
11421
  */
11350
11422
  ConfigPostCmd?: string;
11351
11423
  /**
11352
- * Base64编码的配置项
11424
+ * Base64编码的配置项。
11425
+ - true:开启
11426
+ - false:关闭
11353
11427
  */
11354
11428
  EncodeWithBase64?: boolean;
11355
11429
  /**
11356
- *
11430
+ * 需要绑定的数据集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
11431
  */
11358
11432
  ProgramIdList?: Array<string>;
11359
11433
  }
@@ -11405,7 +11479,9 @@ export interface DescribeContainerGroupAttributeResponse {
11405
11479
  */
11406
11480
  export interface CreateFileConfigResponse {
11407
11481
  /**
11408
- * true:创建成功;false:创建失败
11482
+ * 创建结果。
11483
+ - true:创建成功
11484
+ - false:创建失败
11409
11485
  */
11410
11486
  Result?: boolean;
11411
11487
  /**
@@ -11525,7 +11601,7 @@ export interface DisassociateBusinessLogConfigRequest {
11525
11601
  */
11526
11602
  export interface DescribePublicConfigReleaseLogsResponse {
11527
11603
  /**
11528
- * 分页后的公共配置项发布历史列表
11604
+ * 分页后的公共配置项发布历史列表。
11529
11605
  */
11530
11606
  Result?: TsfPageConfigReleaseLog;
11531
11607
  /**
@@ -11556,35 +11632,35 @@ export interface ReleaseApiGroupRequest {
11556
11632
  */
11557
11633
  export interface DescribeFileConfigReleasesRequest {
11558
11634
  /**
11559
- * 配置项ID
11635
+ * 配置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
11636
  */
11561
11637
  ConfigId?: string;
11562
11638
  /**
11563
- * 配置项名称
11639
+ * 配置项名称,最多支持60个字符,只能包含字母、数字及分隔符(“-”,“_”),且不能以分隔符开头或结尾。
11564
11640
  */
11565
11641
  ConfigName?: string;
11566
11642
  /**
11567
- * 部署组ID
11643
+ * 部署组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
11644
  */
11569
11645
  GroupId?: string;
11570
11646
  /**
11571
- * 命名空间ID
11647
+ * 命名空间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
11648
  */
11573
11649
  NamespaceId?: string;
11574
11650
  /**
11575
- * 集群ID
11651
+ * 集群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
11652
  */
11577
11653
  ClusterId?: string;
11578
11654
  /**
11579
- * 应用ID
11655
+ * 应用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
11656
  */
11581
11657
  ApplicationId?: string;
11582
11658
  /**
11583
- * 偏移量
11659
+ * 偏移量,默认为0。
11584
11660
  */
11585
11661
  Offset?: number;
11586
11662
  /**
11587
- * 每页条数
11663
+ * 返回数量,默认为20,最大值为100。
11588
11664
  */
11589
11665
  Limit?: number;
11590
11666
  }
@@ -11662,7 +11738,9 @@ export interface RevocationPublicConfigRequest {
11662
11738
  */
11663
11739
  export interface ModifyLaneRuleResponse {
11664
11740
  /**
11665
- * 操作状态。成功:true,失败:false
11741
+ * 修改结果。
11742
+ - true:成功
11743
+ - false:失败
11666
11744
  */
11667
11745
  Result?: boolean;
11668
11746
  /**
@@ -11688,7 +11766,7 @@ export interface TsfPageSimpleGroup {
11688
11766
  */
11689
11767
  export interface DescribeMicroservicesByGroupIdsResponse {
11690
11768
  /**
11691
- * 微服务信息分页列表
11769
+ * 微服务信息分页列表。
11692
11770
  */
11693
11771
  Result?: TsfPageMicroservice;
11694
11772
  /**
@@ -11841,7 +11919,7 @@ export interface GroupPod {
11841
11919
  */
11842
11920
  export interface EnableTaskFlowRequest {
11843
11921
  /**
11844
- * 工作流 ID
11922
+ * 工作流 ID。前往工作流管理,在工作流列表第一列和工作流详情页查看工作流ID。
11845
11923
  */
11846
11924
  FlowId: string;
11847
11925
  }
@@ -11865,7 +11943,7 @@ export interface InstanceResourceConfig {
11865
11943
  */
11866
11944
  export interface DescribeReleasedConfigRequest {
11867
11945
  /**
11868
- * 部署组ID
11946
+ * 部署组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
11947
  */
11870
11948
  GroupId: string;
11871
11949
  }
@@ -11929,11 +12007,11 @@ export interface CreatePathRewritesRequest {
11929
12007
  */
11930
12008
  export interface ModifyMicroserviceRequest {
11931
12009
  /**
11932
- * 微服务 ID
12010
+ * 微服务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
12011
  */
11934
12012
  MicroserviceId: string;
11935
12013
  /**
11936
- * 微服务备注信息
12014
+ * 微服务备注信息,最多支持200个字符。
11937
12015
  */
11938
12016
  MicroserviceDesc: string;
11939
12017
  }
@@ -11942,35 +12020,35 @@ export interface ModifyMicroserviceRequest {
11942
12020
  */
11943
12021
  export interface DescribeConfigReleasesRequest {
11944
12022
  /**
11945
- * 配置项名称,不传入时查询全量
12023
+ * 配置项名称,不传入时查询全量。该参数可以通过调用 [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
12024
  */
11947
12025
  ConfigName?: string;
11948
12026
  /**
11949
- * 部署组ID,不传入时查询全量
12027
+ * 部署组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
12028
  */
11951
12029
  GroupId?: string;
11952
12030
  /**
11953
- * 命名空间ID,不传入时查询全量
12031
+ * 命名空间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
12032
  */
11955
12033
  NamespaceId?: string;
11956
12034
  /**
11957
- * 集群ID,不传入时查询全量
12035
+ * 集群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
12036
  */
11959
12037
  ClusterId?: string;
11960
12038
  /**
11961
- * 每页条数
12039
+ * 返回数量,默认为20,最大值为100。
11962
12040
  */
11963
12041
  Limit?: number;
11964
12042
  /**
11965
- * 偏移量
12043
+ * 偏移量,默认为0。
11966
12044
  */
11967
12045
  Offset?: number;
11968
12046
  /**
11969
- * 配置ID,不传入时查询全量
12047
+ * 配置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
12048
  */
11971
12049
  ConfigId?: string;
11972
12050
  /**
11973
- * 应用ID,不传入时查询全量
12051
+ * 应用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
12052
  */
11975
12053
  ApplicationId?: string;
11976
12054
  }
@@ -12039,23 +12117,27 @@ export interface DescribeEnabledUnitRuleRequest {
12039
12117
  */
12040
12118
  export interface CreateConfigTemplateRequest {
12041
12119
  /**
12042
- * 配置模板名称
12120
+ * 配置模板名称,最多支持60个字符,只能包含字母、数字及分隔符(“-”),且不能以分隔符开头或结尾。
12043
12121
  */
12044
12122
  ConfigTemplateName: string;
12045
12123
  /**
12046
- * 配置模板对应的微服务框架
12124
+ * 配置模板对应的微服务框架。
12125
+ - Ribbon:Ribbon类型配置模板
12126
+ - Hystrix:Hystrix类型配置模板
12127
+ - Zuul:Zuul类型配置模板
12128
+ - customize:自定义类型配置模板
12047
12129
  */
12048
12130
  ConfigTemplateType: string;
12049
12131
  /**
12050
- * 配置模板数据
12132
+ * 配置模板数据。
12051
12133
  */
12052
12134
  ConfigTemplateValue: string;
12053
12135
  /**
12054
- * 配置模板描述
12136
+ * 配置模板描述,最多支持200个字符。
12055
12137
  */
12056
12138
  ConfigTemplateDesc?: string;
12057
12139
  /**
12058
- *
12140
+ * 需要绑定的数据集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
12141
  */
12060
12142
  ProgramIdList?: Array<string>;
12061
12143
  }
@@ -12077,7 +12159,7 @@ export interface DescribeApiGroupResponse {
12077
12159
  */
12078
12160
  export interface RedoTaskExecuteResponse {
12079
12161
  /**
12080
- * 成功失败
12162
+ * 成功返回执行批次流水ID。失败返回空字符串。
12081
12163
  */
12082
12164
  Result?: string;
12083
12165
  /**
@@ -12090,19 +12172,19 @@ export interface RedoTaskExecuteResponse {
12090
12172
  */
12091
12173
  export interface CreateLaneRequest {
12092
12174
  /**
12093
- * 泳道名称
12175
+ * 泳道配置名称,最多支持60个字符,只能包含字母、数字及分隔符(“-”),且不能以分隔符开头或结尾。
12094
12176
  */
12095
12177
  LaneName: string;
12096
12178
  /**
12097
- * 泳道备注
12179
+ * 泳道配置备注,最多支持200个字符。
12098
12180
  */
12099
12181
  Remark: string;
12100
12182
  /**
12101
- * 泳道部署组信息
12183
+ * 泳道部署组信息。
12102
12184
  */
12103
12185
  LaneGroupList: Array<LaneGroup>;
12104
12186
  /**
12105
- *
12187
+ * 需要绑定的数据集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
12188
  */
12107
12189
  ProgramIdList?: Array<string>;
12108
12190
  }
@@ -12171,15 +12253,15 @@ export interface ServiceConfig {
12171
12253
  */
12172
12254
  export interface RedoTaskExecuteRequest {
12173
12255
  /**
12174
- * 任务批次ID
12256
+ * 任务批次ID。在任务管理页面第一列点击任务ID进入任务详情,进入执行记录列表页,第一列内容即为任务批次ID。
12175
12257
  */
12176
12258
  BatchId: string;
12177
12259
  /**
12178
- * 任务执行ID
12260
+ * 任务执行ID。在任务管理页面第一列点击任务ID进入任务详情,进入执行记录页,点击批次ID进入执行详情列表页,第一列即为任务执行ID。
12179
12261
  */
12180
12262
  ExecuteId: string;
12181
12263
  /**
12182
- * 任务ID
12264
+ * 任务ID。在任务管理列表页面可以查看任务ID。
12183
12265
  */
12184
12266
  TaskId: string;
12185
12267
  }
@@ -12310,7 +12392,7 @@ export interface DescribeStatisticsRequest {
12310
12392
  */
12311
12393
  export interface DescribeConfigRequest {
12312
12394
  /**
12313
- * 配置项ID
12395
+ * 配置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
12396
  */
12315
12397
  ConfigId: string;
12316
12398
  }
@@ -12383,23 +12465,27 @@ export interface MetricDataCurve {
12383
12465
  */
12384
12466
  export interface UpdateConfigTemplateRequest {
12385
12467
  /**
12386
- * 配置模板id
12468
+ * 配置模板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
12469
  */
12388
12470
  ConfigTemplateId: string;
12389
12471
  /**
12390
- * 配置模板名称
12472
+ * 配置模板名称,最多支持60个字符,只能包含字母、数字及分隔符(“-”),且不能以分隔符开头或结尾。
12391
12473
  */
12392
12474
  ConfigTemplateName: string;
12393
12475
  /**
12394
- * 配置模板对应的微服务框架
12476
+ * 配置模板对应的微服务框架。
12477
+ - Ribbon:Ribbon类型配置模板
12478
+ - Hystrix:Hystrix类型配置模板
12479
+ - Zuul:Zuul类型配置模板
12480
+ - customize:自定义类型配置模板
12395
12481
  */
12396
12482
  ConfigTemplateType: string;
12397
12483
  /**
12398
- * 配置模板数据
12484
+ * 配置模板数据。
12399
12485
  */
12400
12486
  ConfigTemplateValue: string;
12401
12487
  /**
12402
- * 配置模板描述
12488
+ * 配置模板描述,最多支持200个字符。
12403
12489
  */
12404
12490
  ConfigTemplateDesc?: string;
12405
12491
  }
@@ -12640,7 +12726,7 @@ export interface StopTaskBatchRequest {
12640
12726
  */
12641
12727
  export interface DescribeUploadInfoRequest {
12642
12728
  /**
12643
- * 应用ID
12729
+ * 应用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
12730
  */
12645
12731
  ApplicationId: string;
12646
12732
  /**
@@ -12660,11 +12746,11 @@ export interface DescribeUploadInfoRequest {
12660
12746
  */
12661
12747
  PkgDesc?: string;
12662
12748
  /**
12663
- * 程序包仓库类型
12749
+ * 仓库类型(默认仓库:default,私有仓库:private,公共仓库:public-demo)
12664
12750
  */
12665
12751
  RepositoryType?: string;
12666
12752
  /**
12667
- * 程序包仓库id
12753
+ * 仓库ID,可通过调用[仓库信息查询类](https://cloud.tencent.com/document/api/649/45925)接口时出参中的RepositoryId,或登录[控制台](https://console.cloud.tencent.com/tsf/product?rid=1)进行查看
12668
12754
  */
12669
12755
  RepositoryId?: string;
12670
12756
  }
@@ -12857,7 +12943,7 @@ export interface ProgramItem {
12857
12943
  */
12858
12944
  export interface DisableTaskFlowRequest {
12859
12945
  /**
12860
- * 工作流 ID
12946
+ * 工作流 ID。前往工作流管理,在工作流列表第一列和工作流详情页查看工作流ID。
12861
12947
  */
12862
12948
  FlowId: string;
12863
12949
  }
@@ -12912,7 +12998,7 @@ export interface DescribePodInstancesRequest {
12912
12998
  */
12913
12999
  export interface RedoTaskResponse {
12914
13000
  /**
12915
- * 操作成功or失败
13001
+ * 操作成功任务批次ID。操作失败返回空字符串。
12916
13002
  */
12917
13003
  Result?: string;
12918
13004
  /**
@@ -13016,31 +13102,31 @@ export interface CustomPodSchedule {
13016
13102
  */
13017
13103
  export interface DescribeConfigsRequest {
13018
13104
  /**
13019
- * 应用ID,不传入时查询全量
13105
+ * 应用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
13106
  */
13021
13107
  ApplicationId?: string;
13022
13108
  /**
13023
- * 配置项ID,不传入时查询全量,高优先级
13109
+ * 配置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
13110
  */
13025
13111
  ConfigId?: string;
13026
13112
  /**
13027
- * 偏移量
13113
+ * 偏移量,默认为0。
13028
13114
  */
13029
13115
  Offset?: number;
13030
13116
  /**
13031
- * 每页条数
13117
+ * 返回数量,默认为20,最大值为100。
13032
13118
  */
13033
13119
  Limit?: number;
13034
13120
  /**
13035
- * 配置项ID列表,不传入时查询全量,低优先级
13121
+ * 配置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
13122
  */
13037
13123
  ConfigIdList?: Array<string>;
13038
13124
  /**
13039
- * 配置项名称,精确查询,不传入时查询全量
13125
+ * 配置项名称,精确查询,不传入时查询全量。
13040
13126
  */
13041
13127
  ConfigName?: string;
13042
13128
  /**
13043
- * 配置项版本,精确查询,不传入时查询全量
13129
+ * 配置项版本,精确查询,不传入时查询全量。
13044
13130
  */
13045
13131
  ConfigVersion?: string;
13046
13132
  }
@@ -13096,7 +13182,7 @@ export interface TsfPageApplication {
13096
13182
  */
13097
13183
  export interface DisableLaneRuleRequest {
13098
13184
  /**
13099
- * 泳道规则ID
13185
+ * 灰度发布规则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
13186
  */
13101
13187
  RuleId: string;
13102
13188
  }
@@ -13200,7 +13286,7 @@ export interface DescribeInvocationMetricDataCurveResponse {
13200
13286
  */
13201
13287
  export interface DeleteConfigRequest {
13202
13288
  /**
13203
- * 配置项ID
13289
+ * 配置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
13290
  */
13205
13291
  ConfigId: string;
13206
13292
  }
@@ -13209,31 +13295,31 @@ export interface DeleteConfigRequest {
13209
13295
  */
13210
13296
  export interface DescribeFileConfigsRequest {
13211
13297
  /**
13212
- * 配置项ID
13298
+ * 配置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
13299
  */
13214
13300
  ConfigId?: string;
13215
13301
  /**
13216
- * 配置项ID列表
13302
+ * 配置项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
13303
  */
13218
13304
  ConfigIdList?: Array<string>;
13219
13305
  /**
13220
- * 配置项名称
13306
+ * 配置项名称。
13221
13307
  */
13222
13308
  ConfigName?: string;
13223
13309
  /**
13224
- * 应用ID
13310
+ * 应用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
13311
  */
13226
13312
  ApplicationId?: string;
13227
13313
  /**
13228
- * 偏移量
13314
+ * 偏移量,默认为0。
13229
13315
  */
13230
13316
  Offset?: number;
13231
13317
  /**
13232
- * 每页条数
13318
+ * 返回数量,默认为20,最大值为100。
13233
13319
  */
13234
13320
  Limit?: number;
13235
13321
  /**
13236
- * 配置项版本
13322
+ * 配置项版本。
13237
13323
  */
13238
13324
  ConfigVersion?: string;
13239
13325
  }
@@ -13242,7 +13328,9 @@ export interface DescribeFileConfigsRequest {
13242
13328
  */
13243
13329
  export interface CreateConfigTemplateResponse {
13244
13330
  /**
13245
- * true:创建成功;false:创建失败
13331
+ * 创建结果。
13332
+ - true:创建成功
13333
+ - false:创建失败
13246
13334
  */
13247
13335
  Result?: boolean;
13248
13336
  /**
@@ -13255,7 +13343,7 @@ export interface CreateConfigTemplateResponse {
13255
13343
  */
13256
13344
  export interface ExecuteTaskResponse {
13257
13345
  /**
13258
- * 成功/失败
13346
+ * 操作成功返回任务批次ID,操作失败返回空字符串。
13259
13347
  */
13260
13348
  Result?: string;
13261
13349
  /**
@@ -13405,7 +13493,7 @@ export interface DescribeApiUseDetailRequest {
13405
13493
  */
13406
13494
  export interface CreateMicroserviceWithDetailRespResponse {
13407
13495
  /**
13408
- * 微服务ID
13496
+ * 微服务ID
13409
13497
  */
13410
13498
  Result?: string;
13411
13499
  /**
@@ -13651,7 +13739,7 @@ export interface AdvanceSettings {
13651
13739
  */
13652
13740
  export interface EnableTaskResponse {
13653
13741
  /**
13654
- * 操作成功or失败
13742
+ * true:操作成功,false:操作失败
13655
13743
  */
13656
13744
  Result?: boolean;
13657
13745
  /**
@@ -13664,15 +13752,15 @@ export interface EnableTaskResponse {
13664
13752
  */
13665
13753
  export interface ReleaseConfigRequest {
13666
13754
  /**
13667
- * 配置ID
13755
+ * 配置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
13756
  */
13669
13757
  ConfigId: string;
13670
13758
  /**
13671
- * 部署组ID
13759
+ * 部署组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
13760
  */
13673
13761
  GroupId: string;
13674
13762
  /**
13675
- * 发布描述
13763
+ * 发布描述,最多支持200个字符。
13676
13764
  */
13677
13765
  ReleaseDesc?: string;
13678
13766
  }
@@ -13767,23 +13855,30 @@ export interface BusinessLogConfig {
13767
13855
  */
13768
13856
  export interface DescribeApiDetailRequest {
13769
13857
  /**
13770
- * 微服务id
13858
+ * 微服务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
13859
  */
13772
13860
  MicroserviceId: string;
13773
13861
  /**
13774
- * 请求路径
13862
+ * 请求路径。
13775
13863
  */
13776
13864
  Path: string;
13777
13865
  /**
13778
- * 请求方法
13866
+ * 请求方法。
13867
+ - GET
13868
+ - POST
13869
+ - PUT
13870
+ - DELETE
13871
+ - HEAD
13872
+ - PATCH
13873
+ - OPTIONS
13779
13874
  */
13780
13875
  Method: string;
13781
13876
  /**
13782
- * 包版本
13877
+ * 应用包版本号。
13783
13878
  */
13784
13879
  PkgVersion: string;
13785
13880
  /**
13786
- * 应用ID
13881
+ * 应用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
13882
  */
13788
13883
  ApplicationId: string;
13789
13884
  }
@@ -14330,7 +14425,7 @@ export interface UpdateApiRateLimitRulesResponse {
14330
14425
  */
14331
14426
  export interface DeleteRepositoryRequest {
14332
14427
  /**
14333
- * 仓库ID
14428
+ * 删除对应仓库ID,可通过调用[仓库信息查询类](https://cloud.tencent.com/document/api/649/45925)接口时出参中的RepositoryId,或登录[控制台](https://console.cloud.tencent.com/tsf/product?rid=1)进行查看
14334
14429
  */
14335
14430
  RepositoryId: string;
14336
14431
  }
@@ -14380,7 +14475,7 @@ export interface DescribeSimpleGroupsRequest {
14380
14475
  */
14381
14476
  export interface DescribeConfigReleasesResponse {
14382
14477
  /**
14383
- * 分页的配置发布信息
14478
+ * 分页的配置发布信息。
14384
14479
  */
14385
14480
  Result?: TsfPageConfigRelease;
14386
14481
  /**
@@ -14522,9 +14617,9 @@ export interface UnitNamespace {
14522
14617
  */
14523
14618
  export interface ModifyMicroserviceResponse {
14524
14619
  /**
14525
- * 修改微服务详情是否成功。
14526
- true:操作成功。
14527
- false:操作失败。
14620
+ * 修改结果。
14621
+ - true:修改成功
14622
+ - false:修改失败
14528
14623
  */
14529
14624
  Result?: boolean;
14530
14625
  /**
@@ -14739,9 +14834,9 @@ export interface DescribeBasicResourceUsageRequest {
14739
14834
  */
14740
14835
  export interface DeleteMicroserviceResponse {
14741
14836
  /**
14742
- * 删除微服务是否成功。
14743
- true:操作成功。
14744
- false:操作失败。
14837
+ * 删除结果。
14838
+ - true:操作成功
14839
+ - false:操作失败
14745
14840
  */
14746
14841
  Result?: boolean;
14747
14842
  /**
@@ -14763,7 +14858,7 @@ export interface ResourceFieldRef {
14763
14858
  */
14764
14859
  export interface DescribeReleasedConfigResponse {
14765
14860
  /**
14766
- * 已发布的配置内容
14861
+ * 已发布的配置内容。
14767
14862
  */
14768
14863
  Result?: string;
14769
14864
  /**
@@ -14858,7 +14953,7 @@ export interface PropertyField {
14858
14953
  */
14859
14954
  export interface DescribeApiDetailResponse {
14860
14955
  /**
14861
- * API 详情
14956
+ * API详情。
14862
14957
  */
14863
14958
  Result?: ApiDetailResponse;
14864
14959
  /**
@@ -15006,11 +15101,11 @@ export interface CreateRepositoryRequest {
15006
15101
  */
15007
15102
  RepositoryType: string;
15008
15103
  /**
15009
- * 仓库所在桶名称
15104
+ * 仓库所在桶名称,[存储桶概述和创建](https://cloud.tencent.com/document/product/436/13312)
15010
15105
  */
15011
15106
  BucketName: string;
15012
15107
  /**
15013
- * 仓库所在桶地域
15108
+ * 仓库所在桶地域,[存储桶概述和创建](https://cloud.tencent.com/document/product/436/13312)
15014
15109
  */
15015
15110
  BucketRegion: string;
15016
15111
  /**
@@ -15241,7 +15336,7 @@ export interface SearchStdoutLogRequest {
15241
15336
  */
15242
15337
  export interface RedoTaskBatchResponse {
15243
15338
  /**
15244
- * 批次ID
15339
+ * 批次流水ID
15245
15340
  */
15246
15341
  Result?: string;
15247
15342
  /**
@@ -15310,7 +15405,7 @@ export interface ModifyGroupRequest {
15310
15405
  */
15311
15406
  export interface DescribeMicroserviceResponse {
15312
15407
  /**
15313
- * 微服务详情实例列表
15408
+ * 微服务详情实例列表。
15314
15409
  */
15315
15410
  Result?: TsfPageMsInstance;
15316
15411
  /**
@@ -15399,7 +15494,7 @@ export interface MemoryPicture {
15399
15494
  */
15400
15495
  export interface DescribeConfigSummaryResponse {
15401
15496
  /**
15402
- * 配置项分页对象
15497
+ * 配置项分页对象。
15403
15498
  */
15404
15499
  Result?: TsfPageConfig;
15405
15500
  /**
@@ -15515,7 +15610,7 @@ export interface CreateContainGroupRequest {
15515
15610
  */
15516
15611
  export interface DescribePublicConfigReleasesResponse {
15517
15612
  /**
15518
- * 公共配置发布信息
15613
+ * 公共配置发布信息。
15519
15614
  */
15520
15615
  Result?: TsfPageConfigRelease;
15521
15616
  /**
@@ -15541,7 +15636,7 @@ export interface CreatePathRewritesResponse {
15541
15636
  */
15542
15637
  export interface DescribeConfigTemplateRequest {
15543
15638
  /**
15544
- * 配置模板Id
15639
+ * 配置模板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
15640
  */
15546
15641
  ConfigTemplateId: string;
15547
15642
  }
@@ -15563,39 +15658,43 @@ export interface DraftApiGroupResponse {
15563
15658
  */
15564
15659
  export interface DescribeConfigSummaryRequest {
15565
15660
  /**
15566
- * 应用ID,不传入时查询全量
15661
+ * 应用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
15662
  */
15568
15663
  ApplicationId?: string;
15569
15664
  /**
15570
- * 查询关键字,模糊查询:应用名称,配置项名称,不传入时查询全量
15665
+ * 查询关键字,模糊查询:应用名称,配置项名称,不传入时查询全量。
15571
15666
  */
15572
15667
  SearchWord?: string;
15573
15668
  /**
15574
- * 偏移量,默认为0
15669
+ * 偏移量,默认为0
15575
15670
  */
15576
15671
  Offset?: number;
15577
15672
  /**
15578
- * 每页条数,默认为20
15673
+ * 返回数量,默认为20,最大值为50。
15579
15674
  */
15580
15675
  Limit?: number;
15581
15676
  /**
15582
- * 按时间排序:creation_time;按名称排序:config_name
15677
+ * 排序字段。
15678
+ - creation_time:按时间排序
15679
+ - config_name:按名称排序
15583
15680
  */
15584
15681
  OrderBy?: string;
15585
15682
  /**
15586
- * 升序传 0,降序传 1
15683
+ * 排序顺序。
15684
+ - 0:升序
15685
+ - 1:降序
15587
15686
  */
15588
15687
  OrderType?: number;
15589
15688
  /**
15590
- *
15689
+ * TAG标签资源值。
15591
15690
  */
15592
15691
  ConfigTagList?: Array<string>;
15593
15692
  /**
15594
- *
15693
+ * 忽略传参,业务预留字段。
15595
15694
  */
15596
15695
  DisableProgramAuthCheck?: boolean;
15597
15696
  /**
15598
- *
15697
+ * 配置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
15698
  */
15600
15699
  ConfigIdList?: Array<string>;
15601
15700
  }
@@ -15604,7 +15703,7 @@ export interface DescribeConfigSummaryRequest {
15604
15703
  */
15605
15704
  export interface DeleteLaneRequest {
15606
15705
  /**
15607
- * 泳道Idl
15706
+ * 泳道配置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
15707
  */
15609
15708
  LaneId: string;
15610
15709
  }
@@ -15651,15 +15750,15 @@ export interface TsfPageApiGroupInfo {
15651
15750
  */
15652
15751
  export interface ReleasePublicConfigRequest {
15653
15752
  /**
15654
- * 配置ID
15753
+ * 配置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
15754
  */
15656
15755
  ConfigId: string;
15657
15756
  /**
15658
- * 命名空间ID
15757
+ * 命名空间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
15758
  */
15660
15759
  NamespaceId: string;
15661
15760
  /**
15662
- * 发布描述
15761
+ * 发布描述,最多支持200个字符。
15663
15762
  */
15664
15763
  ReleaseDesc?: string;
15665
15764
  }
@@ -15668,11 +15767,11 @@ export interface ReleasePublicConfigRequest {
15668
15767
  */
15669
15768
  export interface TaskFlowEdge {
15670
15769
  /**
15671
- * 节点 ID
15770
+ * 节点 ID,节点类型为任务时为任务ID,节点类型为逻辑节点"且"时为 AND,为逻辑节点"或"时为 OR,节点类型为头节点时为字符串"head"
15672
15771
  */
15673
15772
  NodeId?: string;
15674
15773
  /**
15675
- * 子节点 ID
15774
+ * 子节点 ID,节点类型为任务时为任务ID,节点类型为逻辑节点"且"时为 AND,为逻辑节点"或"时为 OR
15676
15775
  */
15677
15776
  ChildNodeId?: string;
15678
15777
  /**
@@ -15680,11 +15779,11 @@ export interface TaskFlowEdge {
15680
15779
  */
15681
15780
  CoreNode?: string;
15682
15781
  /**
15683
- * 边类型
15782
+ * 边类型,上下游任务依赖触发关系。一共2个值,Y:成功触发,N:失败触发
15684
15783
  */
15685
15784
  EdgeType?: string;
15686
15785
  /**
15687
- * 任务节点类型
15786
+ * 任务节点类型,一共有4种类型,AND:逻辑节点且,OR:逻辑节点或,TASK:任务节点,START:头节点
15688
15787
  */
15689
15788
  NodeType?: string;
15690
15789
  /**
@@ -15696,11 +15795,11 @@ export interface TaskFlowEdge {
15696
15795
  */
15697
15796
  PositionY?: string;
15698
15797
  /**
15699
- * 图 ID
15798
+ * 图 ID,新建工作流时自动生成,不需要填写,查看工作流图时后端返回
15700
15799
  */
15701
15800
  GraphId?: string;
15702
15801
  /**
15703
- * 工作流 ID
15802
+ * 工作流 ID,新建工作流时自动生成,不需要填写,查看工作流图时后端返回
15704
15803
  */
15705
15804
  FlowId?: string;
15706
15805
  /**
@@ -15708,11 +15807,11 @@ export interface TaskFlowEdge {
15708
15807
  */
15709
15808
  NodeName?: string;
15710
15809
  /**
15711
- * 任务ID
15810
+ * 任务ID,新建工作流时不需要填写,查看工作流图时后端返回
15712
15811
  */
15713
15812
  TaskId?: string;
15714
15813
  /**
15715
- * 任务历史ID
15814
+ * 任务历史ID,新建工作流时不需要填写,查看工作流图时后端返回
15716
15815
  */
15717
15816
  TaskLogId?: string;
15718
15817
  }
@@ -15721,7 +15820,7 @@ export interface TaskFlowEdge {
15721
15820
  */
15722
15821
  export interface RedoTaskFlowBatchResponse {
15723
15822
  /**
15724
- * 工作流批次历史 ID
15823
+ * 工作流批次历史 ID。操作失败时不返回该字段,返回错误码。
15725
15824
  */
15726
15825
  Result?: string;
15727
15826
  /**