tencentcloud-sdk-tsf 3.0.1120 → 3.0.1123

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.
@@ -19,9 +19,9 @@ module TencentCloud
19
19
  module V20180326
20
20
  # AddClusterInstances请求参数结构体
21
21
  class AddClusterInstancesRequest < TencentCloud::Common::AbstractModel
22
- # @param ClusterId: 集群ID
22
+ # @param ClusterId: 集群ID,按照【集群ID】进行过滤,可通过调用[DescribeClusters](https://cloud.tencent.com/document/product/649/85857)查询已创建的集群列表或登录控制台进行查看;也可以调用[CreateCluster](https://cloud.tencent.com/document/product/649/36049)创建新的集群。仅在集群下无部署组、命名空间、云主机时可以删除。
23
23
  # @type ClusterId: String
24
- # @param InstanceIdList: 云主机ID列表
24
+ # @param InstanceIdList: 云主机ID列表,可通过调用[DescribeInstances](https://cloud.tencent.com/document/api/213/15728)查询已创建的云主机列表或登录控制台进行查看;也可以调用[RunInstances](https://cloud.tencent.com/document/api/213/15730)创建新的云主机。
25
25
  # @type InstanceIdList: Array
26
26
  # @param OsName: 操作系统名称
27
27
  # @type OsName: String
@@ -134,9 +134,9 @@ module TencentCloud
134
134
 
135
135
  # AddInstances请求参数结构体
136
136
  class AddInstancesRequest < TencentCloud::Common::AbstractModel
137
- # @param ClusterId: 集群ID
137
+ # @param ClusterId: 集群ID,按照【集群ID】进行过滤,可通过调用[DescribeClusters](https://cloud.tencent.com/document/product/649/85857)查询已创建的集群列表或登录控制台进行查看;也可以调用[CreateCluster](https://cloud.tencent.com/document/product/649/36049)创建新的集群。仅在集群下无部署组、命名空间、云主机时可以删除。
138
138
  # @type ClusterId: String
139
- # @param InstanceIdList: 云主机ID列表
139
+ # @param InstanceIdList: 云主机ID列表,可通过调用[DescribeInstances](https://cloud.tencent.com/document/api/213/15728)查询已创建的云主机列表或登录控制台进行查看;也可以调用[RunInstances](https://cloud.tencent.com/document/api/213/15730)创建新的云主机。
140
140
  # @type InstanceIdList: Array
141
141
  # @param OsName: 操作系统名称
142
142
  # @type OsName: String
@@ -999,9 +999,11 @@ module TencentCloud
999
999
 
1000
1000
  # AssociateBusinessLogConfig请求参数结构体
1001
1001
  class AssociateBusinessLogConfigRequest < TencentCloud::Common::AbstractModel
1002
- # @param GroupId: TSF分组ID
1002
+ # @param GroupId: 部署组ID
1003
+ # 可通过调用[DescribeContainerGroups](https://cloud.tencent.com/document/product/649/36068)或[DescribeGroups](https://cloud.tencent.com/document/product/649/36065)查询已创建的部署组列表或登录[控制台](https://console.cloud.tencent.com/tsf/app-detail?rid=1&id=application-yo7kp9dv&tab=publish&subTab=group)进行查看
1003
1004
  # @type GroupId: String
1004
1005
  # @param ConfigIdList: 日志配置项ID列表
1006
+ # 可通过调用[DescribeBusinessLogConfigs](https://cloud.tencent.com/document/product/649/75777)查询已创建的日志配置项列表或登录[控制台](https://console.cloud.tencent.com/tsf/observable/log?rid=1)进行查看
1005
1007
  # @type ConfigIdList: Array
1006
1008
 
1007
1009
  attr_accessor :GroupId, :ConfigIdList
@@ -1019,7 +1021,7 @@ module TencentCloud
1019
1021
 
1020
1022
  # AssociateBusinessLogConfig返回参数结构体
1021
1023
  class AssociateBusinessLogConfigResponse < TencentCloud::Common::AbstractModel
1022
- # @param Result: 操作结果
1024
+ # @param Result: 操作结果,true:成功,false:失败
1023
1025
  # @type Result: Boolean
1024
1026
  # @param RequestId: 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
1025
1027
  # @type RequestId: String
@@ -1039,15 +1041,18 @@ module TencentCloud
1039
1041
 
1040
1042
  # AssociateConfigWithGroup请求参数结构体
1041
1043
  class AssociateConfigWithGroupRequest < TencentCloud::Common::AbstractModel
1042
- # @param ConfigId: 配置项id
1044
+ # @param ConfigId: 配置项ID
1045
+ # 可通过调用[DescribeBusinessLogConfigs](https://cloud.tencent.com/document/product/649/75777)查询已创建的日志配置项列表或登录[控制台](https://console.cloud.tencent.com/tsf/observable/log?rid=1)进行查看
1043
1046
  # @type ConfigId: String
1044
1047
  # @param Groups: 部署组信息
1045
1048
  # @type Groups: Array
1046
1049
  # @param SelectAll: 是否选择全部投递,1 表示全部,0或不填表示非全部
1047
1050
  # @type SelectAll: Integer
1048
- # @param NamespaceId: 命名空间id
1051
+ # @param NamespaceId: 命名空间ID
1052
+ # 可通过[DescribeSimpleNamespaces](https://cloud.tencent.com/document/product/649/36096)查询已经创建的命名空间,也可以通过登录[控制台](https://console.cloud.tencent.com/tsf/resource?rid=1&tab=namespace)查看
1049
1053
  # @type NamespaceId: String
1050
- # @param ClusterId: 集群id
1054
+ # @param ClusterId: 集群ID
1055
+ # 可通过[DescribeClusters](https://cloud.tencent.com/document/product/649/85857)查询已经创建的集群列表,也可以通过登录[控制台](https://console.cloud.tencent.com/tsf/resource?rid=1)查看
1051
1056
  # @type ClusterId: String
1052
1057
  # @param SearchWord: 模糊搜索关键词
1053
1058
  # @type SearchWord: String
@@ -1304,10 +1309,10 @@ module TencentCloud
1304
1309
  # @type ConfigTags: String
1305
1310
  # @param ConfigPipeline: 配置项对应的ES管道
1306
1311
  # @type ConfigPipeline: String
1307
- # @param ConfigCreateTime: 配置项创建时间
1312
+ # @param ConfigCreateTime: 配置项创建时间,格式为yyyy-MM-dd HH:mm:ss
1308
1313
  # 注意:此字段可能返回 null,表示取不到有效值。
1309
1314
  # @type ConfigCreateTime: String
1310
- # @param ConfigUpdateTime: 配置项更新时间
1315
+ # @param ConfigUpdateTime: 配置项更新时间,格式为yyyy-MM-dd HH:mm:ss
1311
1316
  # 注意:此字段可能返回 null,表示取不到有效值。
1312
1317
  # @type ConfigUpdateTime: String
1313
1318
  # @param ConfigSchema: 配置项解析规则
@@ -1321,13 +1326,21 @@ module TencentCloud
1321
1326
  # @type FilebeatConfigEnable: Boolean
1322
1327
  # @param FilebeatCloseTimeout: close_timeout参数
1323
1328
  # @type FilebeatCloseTimeout: Integer
1324
-
1325
- attr_accessor :ConfigId, :ConfigName, :ConfigPath, :ConfigDesc, :ConfigTags, :ConfigPipeline, :ConfigCreateTime, :ConfigUpdateTime, :ConfigSchema, :ConfigAssociatedGroups, :ConfigAssociatedGroupList, :FilebeatConfigEnable, :FilebeatCloseTimeout
1329
+ # @param FilebeatIgnoreOlder: filebeat ignore_older参数
1330
+ # @type FilebeatIgnoreOlder: Integer
1331
+ # @param FilebeatHarvesterLimit: filebeat harvester_limit参数
1332
+ # @type FilebeatHarvesterLimit: Integer
1333
+ # @param FilebeatCloseInactive: filebeat close_inactive参数
1334
+ # @type FilebeatCloseInactive: Integer
1335
+ # @param FilebeatCleanInactive: filebeat clean_inactive参数
1336
+ # @type FilebeatCleanInactive: Integer
1337
+
1338
+ attr_accessor :ConfigId, :ConfigName, :ConfigPath, :ConfigDesc, :ConfigTags, :ConfigPipeline, :ConfigCreateTime, :ConfigUpdateTime, :ConfigSchema, :ConfigAssociatedGroups, :ConfigAssociatedGroupList, :FilebeatConfigEnable, :FilebeatCloseTimeout, :FilebeatIgnoreOlder, :FilebeatHarvesterLimit, :FilebeatCloseInactive, :FilebeatCleanInactive
1326
1339
  extend Gem::Deprecate
1327
1340
  deprecate :ConfigAssociatedGroups, :none, 2025, 8
1328
1341
  deprecate :ConfigAssociatedGroups=, :none, 2025, 8
1329
1342
 
1330
- def initialize(configid=nil, configname=nil, configpath=nil, configdesc=nil, configtags=nil, configpipeline=nil, configcreatetime=nil, configupdatetime=nil, configschema=nil, configassociatedgroups=nil, configassociatedgrouplist=nil, filebeatconfigenable=nil, filebeatclosetimeout=nil)
1343
+ def initialize(configid=nil, configname=nil, configpath=nil, configdesc=nil, configtags=nil, configpipeline=nil, configcreatetime=nil, configupdatetime=nil, configschema=nil, configassociatedgroups=nil, configassociatedgrouplist=nil, filebeatconfigenable=nil, filebeatclosetimeout=nil, filebeatignoreolder=nil, filebeatharvesterlimit=nil, filebeatcloseinactive=nil, filebeatcleaninactive=nil)
1331
1344
  @ConfigId = configid
1332
1345
  @ConfigName = configname
1333
1346
  @ConfigPath = configpath
@@ -1341,6 +1354,10 @@ module TencentCloud
1341
1354
  @ConfigAssociatedGroupList = configassociatedgrouplist
1342
1355
  @FilebeatConfigEnable = filebeatconfigenable
1343
1356
  @FilebeatCloseTimeout = filebeatclosetimeout
1357
+ @FilebeatIgnoreOlder = filebeatignoreolder
1358
+ @FilebeatHarvesterLimit = filebeatharvesterlimit
1359
+ @FilebeatCloseInactive = filebeatcloseinactive
1360
+ @FilebeatCleanInactive = filebeatcleaninactive
1344
1361
  end
1345
1362
 
1346
1363
  def deserialize(params)
@@ -1374,6 +1391,10 @@ module TencentCloud
1374
1391
  end
1375
1392
  @FilebeatConfigEnable = params['FilebeatConfigEnable']
1376
1393
  @FilebeatCloseTimeout = params['FilebeatCloseTimeout']
1394
+ @FilebeatIgnoreOlder = params['FilebeatIgnoreOlder']
1395
+ @FilebeatHarvesterLimit = params['FilebeatHarvesterLimit']
1396
+ @FilebeatCloseInactive = params['FilebeatCloseInactive']
1397
+ @FilebeatCleanInactive = params['FilebeatCleanInactive']
1377
1398
  end
1378
1399
  end
1379
1400
 
@@ -1387,7 +1408,7 @@ module TencentCloud
1387
1408
  # @type ApplicationId: String
1388
1409
  # @param ApplicationName: 部署组所属应用名称
1389
1410
  # @type ApplicationName: String
1390
- # @param ApplicationType: 部署组所属应用类型
1411
+ # @param ApplicationType: 部署组所属应用类型,C:容器应用,V:虚拟机应用
1391
1412
  # @type ApplicationType: String
1392
1413
  # @param NamespaceId: 部署组所属命名空间ID
1393
1414
  # @type NamespaceId: String
@@ -1397,9 +1418,9 @@ module TencentCloud
1397
1418
  # @type ClusterId: String
1398
1419
  # @param ClusterName: 部署组所属集群名称
1399
1420
  # @type ClusterName: String
1400
- # @param ClusterType: 部署组所属集群类型
1421
+ # @param ClusterType: 部署组所属集群类型,C:容器集群,V:虚拟机集群
1401
1422
  # @type ClusterType: String
1402
- # @param AssociatedTime: 部署组关联日志配置时间
1423
+ # @param AssociatedTime: 部署组关联日志配置时间,格式yyyy-MM-dd HH:mm:ss
1403
1424
  # @type AssociatedTime: String
1404
1425
 
1405
1426
  attr_accessor :GroupId, :GroupName, :ApplicationId, :ApplicationName, :ApplicationType, :NamespaceId, :NamespaceName, :ClusterId, :ClusterName, :ClusterType, :AssociatedTime
@@ -1435,7 +1456,7 @@ module TencentCloud
1435
1456
 
1436
1457
  # 业务日志配置解析规则
1437
1458
  class BusinessLogConfigSchema < TencentCloud::Common::AbstractModel
1438
- # @param SchemaType: 解析规则类型
1459
+ # @param SchemaType: 解析规则类型。可选值 0(SPRING_BOOT:默认Spring Boot格式),1(NONE:无解析规则),4(NGINX_ACCESS:nginx access日志),5(CUSTOM_LOGBACK:自定义Logback),6(CUSTOM_LOG4J:自定义Log4J),7(CUSTOM_LOG4J2:自定义Log4J2),8(TEXT:单行/多行文本),9(ENVOY_MSGW_ACCESS:envoy access日志)。
1439
1460
  # @type SchemaType: Integer
1440
1461
  # @param SchemaContent: 解析规则内容
1441
1462
  # 注意:此字段可能返回 null,表示取不到有效值。
@@ -1446,7 +1467,7 @@ module TencentCloud
1446
1467
  # @param SchemaMultilinePattern: 解析规则对应的多行匹配规则
1447
1468
  # 注意:此字段可能返回 null,表示取不到有效值。
1448
1469
  # @type SchemaMultilinePattern: String
1449
- # @param SchemaCreateTime: 解析规则创建时间
1470
+ # @param SchemaCreateTime: 解析规则创建时间,格式为yyyy-MM-dd HH:mm:ss
1450
1471
  # @type SchemaCreateTime: String
1451
1472
  # @param SchemaPatternLayout: 用户填写的解析规则
1452
1473
  # 注意:此字段可能返回 null,表示取不到有效值。
@@ -1479,7 +1500,7 @@ module TencentCloud
1479
1500
  # @type InstanceId: String
1480
1501
  # @param Content: 日志内容
1481
1502
  # @type Content: String
1482
- # @param Timestamp: 日志时间戳
1503
+ # @param Timestamp: 日志时间戳,单位毫秒
1483
1504
  # @type Timestamp: Integer
1484
1505
  # @param InstanceIp: 实例IP
1485
1506
  # @type InstanceIp: String
@@ -1689,7 +1710,7 @@ module TencentCloud
1689
1710
  # @param ClusterDesc: 集群描述
1690
1711
  # 注意:此字段可能返回 null,表示取不到有效值。
1691
1712
  # @type ClusterDesc: String
1692
- # @param ClusterType: 集群类型
1713
+ # @param ClusterType: 集群类型,C表示容器集群,V表示虚拟机集群
1693
1714
  # 注意:此字段可能返回 null,表示取不到有效值。
1694
1715
  # @type ClusterType: String
1695
1716
  # @param VpcId: 集群所属私有网络ID
@@ -1725,10 +1746,10 @@ module TencentCloud
1725
1746
  # @param DeleteFlag: 删除标记:true:可以删除;false:不可删除
1726
1747
  # 注意:此字段可能返回 null,表示取不到有效值。
1727
1748
  # @type DeleteFlag: Boolean
1728
- # @param CreateTime: 创建时间
1749
+ # @param CreateTime: 创建时间,格式为​​YYYY-MM-DD HH:MM:SS
1729
1750
  # 注意:此字段可能返回 null,表示取不到有效值。
1730
1751
  # @type CreateTime: String
1731
- # @param UpdateTime: 更新时间
1752
+ # @param UpdateTime: 更新时间,格式为​​YYYY-MM-DD HH:MM:SS
1732
1753
  # 注意:此字段可能返回 null,表示取不到有效值。
1733
1754
  # @type UpdateTime: String
1734
1755
  # @param TsfRegionId: 集群所属TSF地域ID
@@ -1782,7 +1803,7 @@ module TencentCloud
1782
1803
  # @param KuberneteApiServer: api地址
1783
1804
  # 注意:此字段可能返回 null,表示取不到有效值。
1784
1805
  # @type KuberneteApiServer: String
1785
- # @param KuberneteNativeType: K : kubeconfig, S : service account
1806
+ # @param KuberneteNativeType: K 表示通过kubeconfig 导入, S 表示通过service account导入
1786
1807
  # 注意:此字段可能返回 null,表示取不到有效值。
1787
1808
  # @type KuberneteNativeType: String
1788
1809
  # @param KuberneteNativeSecret: native secret
@@ -2560,7 +2581,7 @@ module TencentCloud
2560
2581
  # @param TcrRepoInfo: TcrRepoInfo值
2561
2582
  # 注意:此字段可能返回 null,表示取不到有效值。
2562
2583
  # @type TcrRepoInfo: :class:`Tencentcloud::Tsf.v20180326.models.TcrRepoInfo`
2563
- # @param VolumeInfos: 数据卷信息,list
2584
+ # @param VolumeInfos: 数据卷信息,数组结构
2564
2585
  # 注意:此字段可能返回 null,表示取不到有效值。
2565
2586
  # @type VolumeInfos: Array
2566
2587
  # @param VolumeMountInfos: 数据卷挂载信息,list
@@ -3322,7 +3343,7 @@ module TencentCloud
3322
3343
 
3323
3344
  # ContinueRunFailedTaskBatch请求参数结构体
3324
3345
  class ContinueRunFailedTaskBatchRequest < TencentCloud::Common::AbstractModel
3325
- # @param BatchId: 批次ID。
3346
+ # @param BatchId: 任务批次ID。在[任务管理](https://console.cloud.tencent.com/tsf/tct?rid=1)页面点击任务ID进入执行记录页,第一列即为任务批次ID,在[任务执行记录](https://console.cloud.tencent.com/tsf/tct?rid=1&tab=task)页能查看所有任务批次ID
3326
3347
  # @type BatchId: String
3327
3348
 
3328
3349
  attr_accessor :BatchId
@@ -3780,9 +3801,12 @@ module TencentCloud
3780
3801
  class CreateClusterRequest < TencentCloud::Common::AbstractModel
3781
3802
  # @param ClusterName: 集群名称
3782
3803
  # @type ClusterName: String
3783
- # @param ClusterType: 集群类型
3804
+ # @param ClusterType: 指定集群类型,目前支持:
3805
+ # - `V`:虚拟机集群
3806
+ # - `C`:容器集群
3807
+ # - `S`:Serverless 集群
3784
3808
  # @type ClusterType: String
3785
- # @param VpcId: 私有网络ID
3809
+ # @param VpcId: 私有网络ID,可通过调用[DescribeVpcEx](https://cloud.tencent.com/document/api/215/1372)查询已创建的私有网络列表或登录控制台进行查看;也可以调用[CreateVpc](https://cloud.tencent.com/document/api/215/1309)创建新的私有网络。
3786
3810
  # @type VpcId: String
3787
3811
  # @param ClusterCIDR: 分配给集群容器和服务IP的CIDR
3788
3812
  # @type ClusterCIDR: String
@@ -3878,21 +3902,23 @@ module TencentCloud
3878
3902
 
3879
3903
  # CreateConfig请求参数结构体
3880
3904
  class CreateConfigRequest < TencentCloud::Common::AbstractModel
3881
- # @param ConfigName: 配置项名称
3905
+ # @param ConfigName: 配置项名称,最多支持60个字符,只能包含字母、数字及分隔符(“-”、“_”),且不能以分隔符开头或结尾。
3882
3906
  # @type ConfigName: String
3883
- # @param ConfigVersion: 配置项版本
3907
+ # @param ConfigVersion: 配置项版本,只能包含小写字母、数字及分隔符("-","."),且必须以小写字母或数字开头、以小写字母或数字结尾,中间不能有连续的"-"或"."。
3884
3908
  # @type ConfigVersion: String
3885
- # @param ConfigValue: 配置项值
3909
+ # @param ConfigValue: 配置项值。
3886
3910
  # @type ConfigValue: String
3887
- # @param ApplicationId: 应用ID
3911
+ # @param ApplicationId: 应用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)创建新的应用。
3888
3912
  # @type ApplicationId: String
3889
- # @param ConfigVersionDesc: 配置项版本描述
3913
+ # @param ConfigVersionDesc: 配置项版本描述,最多支持200个字符。
3890
3914
  # @type ConfigVersionDesc: String
3891
- # @param ConfigType: 配置项值类型
3915
+ # @param ConfigType: 配置项值类型,固定值。
3892
3916
  # @type ConfigType: String
3893
- # @param EncodeWithBase64: Base64编码的配置项
3917
+ # @param EncodeWithBase64: Base64编码的配置项。
3918
+ # - true:开启
3919
+ # - false:关闭
3894
3920
  # @type EncodeWithBase64: Boolean
3895
- # @param ProgramIdList:
3921
+ # @param ProgramIdList: 需要绑定的数据集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)创建新的数据集。
3896
3922
  # @type ProgramIdList: Array
3897
3923
 
3898
3924
  attr_accessor :ConfigName, :ConfigVersion, :ConfigValue, :ApplicationId, :ConfigVersionDesc, :ConfigType, :EncodeWithBase64, :ProgramIdList
@@ -3922,7 +3948,9 @@ module TencentCloud
3922
3948
 
3923
3949
  # CreateConfig返回参数结构体
3924
3950
  class CreateConfigResponse < TencentCloud::Common::AbstractModel
3925
- # @param Result: true:创建成功;false:创建失败
3951
+ # @param Result: 创建结果。
3952
+ # - true:创建成功
3953
+ # - false:创建失败
3926
3954
  # @type Result: Boolean
3927
3955
  # @param RequestId: 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
3928
3956
  # @type RequestId: String
@@ -3942,15 +3970,19 @@ module TencentCloud
3942
3970
 
3943
3971
  # CreateConfigTemplate请求参数结构体
3944
3972
  class CreateConfigTemplateRequest < TencentCloud::Common::AbstractModel
3945
- # @param ConfigTemplateName: 配置模板名称
3973
+ # @param ConfigTemplateName: 配置模板名称,最多支持60个字符,只能包含字母、数字及分隔符(“-”),且不能以分隔符开头或结尾。
3946
3974
  # @type ConfigTemplateName: String
3947
- # @param ConfigTemplateType: 配置模板对应的微服务框架
3975
+ # @param ConfigTemplateType: 配置模板对应的微服务框架。
3976
+ # - Ribbon:Ribbon类型配置模板
3977
+ # - Hystrix:Hystrix类型配置模板
3978
+ # - Zuul:Zuul类型配置模板
3979
+ # - customize:自定义类型配置模板
3948
3980
  # @type ConfigTemplateType: String
3949
- # @param ConfigTemplateValue: 配置模板数据
3981
+ # @param ConfigTemplateValue: 配置模板数据。
3950
3982
  # @type ConfigTemplateValue: String
3951
- # @param ConfigTemplateDesc: 配置模板描述
3983
+ # @param ConfigTemplateDesc: 配置模板描述,最多支持200个字符。
3952
3984
  # @type ConfigTemplateDesc: String
3953
- # @param ProgramIdList:
3985
+ # @param ProgramIdList: 需要绑定的数据集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)创建新的数据集。
3954
3986
  # @type ProgramIdList: Array
3955
3987
 
3956
3988
  attr_accessor :ConfigTemplateName, :ConfigTemplateType, :ConfigTemplateValue, :ConfigTemplateDesc, :ProgramIdList
@@ -3974,7 +4006,9 @@ module TencentCloud
3974
4006
 
3975
4007
  # CreateConfigTemplate返回参数结构体
3976
4008
  class CreateConfigTemplateResponse < TencentCloud::Common::AbstractModel
3977
- # @param Result: true:创建成功;false:创建失败
4009
+ # @param Result: 创建结果。
4010
+ # - true:创建成功
4011
+ # - false:创建失败
3978
4012
  # @type Result: Boolean
3979
4013
  # @param RequestId: 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
3980
4014
  # @type RequestId: String
@@ -3994,15 +4028,15 @@ module TencentCloud
3994
4028
 
3995
4029
  # CreateConfigTemplateWithDetailResp请求参数结构体
3996
4030
  class CreateConfigTemplateWithDetailRespRequest < TencentCloud::Common::AbstractModel
3997
- # @param ConfigTemplateName: 配置模板名称
4031
+ # @param ConfigTemplateName: 配置模板名称,最多支持60个字符,只能包含字母、数字及分隔符(“-”),且不能以分隔符开头或结尾。
3998
4032
  # @type ConfigTemplateName: String
3999
- # @param ConfigTemplateType: 配置模板对应的微服务框架
4033
+ # @param ConfigTemplateType: 配置模板对应的微服务框架。- Ribbon:Ribbon类型配置模板- Hystrix:Hystrix类型配置模板- Zuul:Zuul类型配置模板- customize:自定义类型配置模板。
4000
4034
  # @type ConfigTemplateType: String
4001
- # @param ConfigTemplateValue: 配置模板数据
4035
+ # @param ConfigTemplateValue: 配置模板数据。
4002
4036
  # @type ConfigTemplateValue: String
4003
- # @param ConfigTemplateDesc: 配置模板描述
4037
+ # @param ConfigTemplateDesc: 配置模板描述,最多支持200个字符。
4004
4038
  # @type ConfigTemplateDesc: String
4005
- # @param ProgramIdList:
4039
+ # @param ProgramIdList: 需要绑定的数据集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)创建新的数据集。
4006
4040
  # @type ProgramIdList: Array
4007
4041
 
4008
4042
  attr_accessor :ConfigTemplateName, :ConfigTemplateType, :ConfigTemplateValue, :ConfigTemplateDesc, :ProgramIdList
@@ -4026,7 +4060,7 @@ module TencentCloud
4026
4060
 
4027
4061
  # CreateConfigTemplateWithDetailResp返回参数结构体
4028
4062
  class CreateConfigTemplateWithDetailRespResponse < TencentCloud::Common::AbstractModel
4029
- # @param Result: 创建成功,返回 ID
4063
+ # @param Result: 创建成功,返回配置模板ID
4030
4064
  # @type Result: :class:`Tencentcloud::Tsf.v20180326.models.ConfigTemplate`
4031
4065
  # @param RequestId: 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
4032
4066
  # @type RequestId: String
@@ -4049,21 +4083,23 @@ module TencentCloud
4049
4083
 
4050
4084
  # CreateConfigWithDetailResp请求参数结构体
4051
4085
  class CreateConfigWithDetailRespRequest < TencentCloud::Common::AbstractModel
4052
- # @param ConfigName: 配置项名称
4086
+ # @param ConfigName: 配置项名称,最多支持60个字符,只能包含字母、数字及分隔符(“-”、“_”),且不能以分隔符开头或结尾。
4053
4087
  # @type ConfigName: String
4054
- # @param ConfigVersion: 配置项版本
4088
+ # @param ConfigVersion: 配置项版本,只能包含小写字母、数字及分隔符("-","."),且必须以小写字母或数字开头、以小写字母或数字结尾,中间不能有连续的"-"或"."。
4055
4089
  # @type ConfigVersion: String
4056
- # @param ConfigValue: 配置项值
4090
+ # @param ConfigValue: 配置项值。
4057
4091
  # @type ConfigValue: String
4058
- # @param ApplicationId: 应用ID
4092
+ # @param ApplicationId: 应用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)创建新的应用。
4059
4093
  # @type ApplicationId: String
4060
- # @param ConfigVersionDesc: 配置项版本描述
4094
+ # @param ConfigVersionDesc: 配置项版本描述,最多支持200个字符。
4061
4095
  # @type ConfigVersionDesc: String
4062
- # @param ConfigType: 配置项值类型
4096
+ # @param ConfigType: 配置项值类型,固定值。
4063
4097
  # @type ConfigType: String
4064
- # @param EncodeWithBase64: Base64编码的配置项
4098
+ # @param EncodeWithBase64: Base64编码的配置项。
4099
+ # - true:开启
4100
+ # - false:关闭
4065
4101
  # @type EncodeWithBase64: Boolean
4066
- # @param ProgramIdList:
4102
+ # @param ProgramIdList: 需要绑定的数据集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)创建新的数据集。
4067
4103
  # @type ProgramIdList: Array
4068
4104
 
4069
4105
  attr_accessor :ConfigName, :ConfigVersion, :ConfigValue, :ApplicationId, :ConfigVersionDesc, :ConfigType, :EncodeWithBase64, :ProgramIdList
@@ -4093,7 +4129,7 @@ module TencentCloud
4093
4129
 
4094
4130
  # CreateConfigWithDetailResp返回参数结构体
4095
4131
  class CreateConfigWithDetailRespResponse < TencentCloud::Common::AbstractModel
4096
- # @param Result: 配置项
4132
+ # @param Result: 配置项。
4097
4133
  # @type Result: :class:`Tencentcloud::Tsf.v20180326.models.Config`
4098
4134
  # @param RequestId: 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
4099
4135
  # @type RequestId: String
@@ -4253,27 +4289,29 @@ module TencentCloud
4253
4289
 
4254
4290
  # CreateFileConfig请求参数结构体
4255
4291
  class CreateFileConfigRequest < TencentCloud::Common::AbstractModel
4256
- # @param ConfigName: 配置项名称
4292
+ # @param ConfigName: 配置项名称,最多支持60个字符,只能包含字母、数字及分隔符(“-”、“_”),且不能以分隔符开头或结尾。
4257
4293
  # @type ConfigName: String
4258
- # @param ConfigVersion: 配置项版本
4294
+ # @param ConfigVersion: 配置项版本,只能包含小写字母、数字及分隔符("-","."),且必须以小写字母或数字开头、以小写字母或数字结尾,中间不能有连续的"-"或"."。
4259
4295
  # @type ConfigVersion: String
4260
- # @param ConfigFileName: 配置项文件名
4296
+ # @param ConfigFileName: 配置项文件名,最多支持60个字符,只能包含英文、数字、"-"(英文)、"_"(英文)、"."(英文)。
4261
4297
  # @type ConfigFileName: String
4262
4298
  # @param ConfigFileValue: 配置项文件内容(原始内容编码需要 utf-8 格式,如果 ConfigFileCode 为 gbk,后台会进行转换)
4263
4299
  # @type ConfigFileValue: String
4264
- # @param ApplicationId: 配置项关联应用ID
4300
+ # @param ApplicationId: 配置项关联应用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)创建新的应用。
4265
4301
  # @type ApplicationId: String
4266
- # @param ConfigFilePath: 发布路径
4302
+ # @param ConfigFilePath: 发布路径。
4267
4303
  # @type ConfigFilePath: String
4268
- # @param ConfigVersionDesc: 配置项版本描述
4304
+ # @param ConfigVersionDesc: 配置项版本描述,最多支持200个字符。
4269
4305
  # @type ConfigVersionDesc: String
4270
- # @param ConfigFileCode: 配置项文件编码,utf-8 或 gbk。注:如果选择 gbk,需要新版本 tsf-consul-template (公有云虚拟机需要使用 1.32 tsf-agent,容器需要从文档中获取最新的 tsf-consul-template-docker.tar.gz)的支持
4306
+ # @param ConfigFileCode: 配置项文件编码,utf-8 或 gbk。注:如果选择 gbk,需要新版本 tsf-consul-template (公有云虚拟机需要使用 1.32 tsf-agent,容器需要从文档中获取最新的 tsf-consul-template-docker.tar.gz)的支持。
4271
4307
  # @type ConfigFileCode: String
4272
- # @param ConfigPostCmd: 后置命令
4308
+ # @param ConfigPostCmd: 后置命令。
4273
4309
  # @type ConfigPostCmd: String
4274
- # @param EncodeWithBase64: Base64编码的配置项
4310
+ # @param EncodeWithBase64: Base64编码的配置项。
4311
+ # - true:开启
4312
+ # - false:关闭
4275
4313
  # @type EncodeWithBase64: Boolean
4276
- # @param ProgramIdList:
4314
+ # @param ProgramIdList: 需要绑定的数据集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)创建新的数据集。
4277
4315
  # @type ProgramIdList: Array
4278
4316
 
4279
4317
  attr_accessor :ConfigName, :ConfigVersion, :ConfigFileName, :ConfigFileValue, :ApplicationId, :ConfigFilePath, :ConfigVersionDesc, :ConfigFileCode, :ConfigPostCmd, :EncodeWithBase64, :ProgramIdList
@@ -4309,7 +4347,9 @@ module TencentCloud
4309
4347
 
4310
4348
  # CreateFileConfig返回参数结构体
4311
4349
  class CreateFileConfigResponse < TencentCloud::Common::AbstractModel
4312
- # @param Result: true:创建成功;false:创建失败
4350
+ # @param Result: 创建结果。
4351
+ # - true:创建成功
4352
+ # - false:创建失败
4313
4353
  # @type Result: Boolean
4314
4354
  # @param RequestId: 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
4315
4355
  # @type RequestId: String
@@ -4329,27 +4369,27 @@ module TencentCloud
4329
4369
 
4330
4370
  # CreateFileConfigWithDetailResp请求参数结构体
4331
4371
  class CreateFileConfigWithDetailRespRequest < TencentCloud::Common::AbstractModel
4332
- # @param ConfigName: 配置项名称
4372
+ # @param ConfigName: 配置名称,最多支持60个字符,只能包含字母、数字及分隔符(“-”、“_”),且不能以分隔符开头或结尾。
4333
4373
  # @type ConfigName: String
4334
- # @param ConfigVersion: 配置项版本
4374
+ # @param ConfigVersion: 配置项版本,只能包含小写字母、数字及分隔符("-","."),且必须以小写字母或数字开头、以小写字母或数字结尾,中间不能有连续的"-"或"."。
4335
4375
  # @type ConfigVersion: String
4336
- # @param ConfigFileName: 配置项文件名
4376
+ # @param ConfigFileName: 配置项文件名,不超过60个字符,只能包含英文、数字、"-"(英文)、"_"(英文)、"."(英文)。
4337
4377
  # @type ConfigFileName: String
4338
- # @param ConfigFileValue: 配置项文件内容(原始内容编码需要 utf-8 格式,如果 ConfigFileCode 为 gbk,后台会进行转换)
4378
+ # @param ConfigFileValue: 配置项文件内容(原始内容编码需要 utf-8 格式,如果 ConfigFileCode 为 gbk,后台会进行转换)。
4339
4379
  # @type ConfigFileValue: String
4340
- # @param ApplicationId: 配置项关联应用ID
4380
+ # @param ApplicationId: 配置项关联应用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)创建新的应用。
4341
4381
  # @type ApplicationId: String
4342
- # @param ConfigFilePath: 发布路径
4382
+ # @param ConfigFilePath: 发布路径。
4343
4383
  # @type ConfigFilePath: String
4344
- # @param ConfigVersionDesc: 配置项版本描述
4384
+ # @param ConfigVersionDesc: 配置项版本描述,最多支持200个字符。
4345
4385
  # @type ConfigVersionDesc: String
4346
- # @param ConfigFileCode: 配置项文件编码,utf-8 或 gbk。注:如果选择 gbk,需要新版本 tsf-consul-template (公有云虚拟机需要使用 1.32 tsf-agent,容器需要从文档中获取最新的 tsf-consul-template-docker.tar.gz)的支持
4386
+ # @param ConfigFileCode: 配置项文件编码,utf-8 或 gbk。注:如果选择 gbk,需要新版本 tsf-consul-template (公有云虚拟机需要使用 1.32 tsf-agent,容器需要从文档中获取最新的 tsf-consul-template-docker.tar.gz)的支持。
4347
4387
  # @type ConfigFileCode: String
4348
- # @param ConfigPostCmd: 后置命令
4388
+ # @param ConfigPostCmd: 后置命令。
4349
4389
  # @type ConfigPostCmd: String
4350
4390
  # @param EncodeWithBase64: Base64编码的配置项
4351
4391
  # @type EncodeWithBase64: Boolean
4352
- # @param ProgramIdList:
4392
+ # @param ProgramIdList: 需要绑定的数据集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)创建新的数据集。
4353
4393
  # @type ProgramIdList: Array
4354
4394
 
4355
4395
  attr_accessor :ConfigName, :ConfigVersion, :ConfigFileName, :ConfigFileValue, :ApplicationId, :ConfigFilePath, :ConfigVersionDesc, :ConfigFileCode, :ConfigPostCmd, :EncodeWithBase64, :ProgramIdList
@@ -4385,7 +4425,7 @@ module TencentCloud
4385
4425
 
4386
4426
  # CreateFileConfigWithDetailResp返回参数结构体
4387
4427
  class CreateFileConfigWithDetailRespResponse < TencentCloud::Common::AbstractModel
4388
- # @param Result: 文件配置项
4428
+ # @param Result: 文件配置项。
4389
4429
  # @type Result: :class:`Tencentcloud::Tsf.v20180326.models.FileConfig`
4390
4430
  # @param RequestId: 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
4391
4431
  # @type RequestId: String
@@ -4530,13 +4570,13 @@ module TencentCloud
4530
4570
 
4531
4571
  # CreateLane请求参数结构体
4532
4572
  class CreateLaneRequest < TencentCloud::Common::AbstractModel
4533
- # @param LaneName: 泳道名称
4573
+ # @param LaneName: 泳道配置名称,最多支持60个字符,只能包含字母、数字及分隔符(“-”),且不能以分隔符开头或结尾。
4534
4574
  # @type LaneName: String
4535
- # @param Remark: 泳道备注
4575
+ # @param Remark: 泳道配置备注,最多支持200个字符。
4536
4576
  # @type Remark: String
4537
- # @param LaneGroupList: 泳道部署组信息
4577
+ # @param LaneGroupList: 泳道部署组信息。
4538
4578
  # @type LaneGroupList: Array
4539
- # @param ProgramIdList:
4579
+ # @param ProgramIdList: 需要绑定的数据集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)创建新的数据集。
4540
4580
  # @type ProgramIdList: Array
4541
4581
 
4542
4582
  attr_accessor :LaneName, :Remark, :LaneGroupList, :ProgramIdList
@@ -4565,7 +4605,7 @@ module TencentCloud
4565
4605
 
4566
4606
  # CreateLane返回参数结构体
4567
4607
  class CreateLaneResponse < TencentCloud::Common::AbstractModel
4568
- # @param Result: 泳道ID
4608
+ # @param Result: 泳道配置ID
4569
4609
  # @type Result: String
4570
4610
  # @param RequestId: 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
4571
4611
  # @type RequestId: String
@@ -4585,17 +4625,19 @@ module TencentCloud
4585
4625
 
4586
4626
  # CreateLaneRule请求参数结构体
4587
4627
  class CreateLaneRuleRequest < TencentCloud::Common::AbstractModel
4588
- # @param RuleName: 泳道规则名称
4628
+ # @param RuleName: 灰度发布规则名称,最多支持60个字符,支持中英文字符。
4589
4629
  # @type RuleName: String
4590
- # @param Remark: 泳道规则备注
4630
+ # @param Remark: 灰度发布规则备注,最多支持200个字符。
4591
4631
  # @type Remark: String
4592
- # @param RuleTagList: 泳道规则标签列表
4632
+ # @param RuleTagList: 灰度发布规则标签列表。
4593
4633
  # @type RuleTagList: Array
4594
- # @param RuleTagRelationship: 泳道规则标签关系
4634
+ # @param RuleTagRelationship: 灰度发布规则标签关系。
4635
+ # - RELEATION_AND:与
4636
+ # - RELEATION_OR:或
4595
4637
  # @type RuleTagRelationship: String
4596
- # @param LaneId: 泳道Id
4638
+ # @param LaneId: 泳道配置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)创建新的泳道配置。
4597
4639
  # @type LaneId: String
4598
- # @param ProgramIdList:
4640
+ # @param ProgramIdList: 需要绑定的数据集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)创建新的数据集。
4599
4641
  # @type ProgramIdList: Array
4600
4642
 
4601
4643
  attr_accessor :RuleName, :Remark, :RuleTagList, :RuleTagRelationship, :LaneId, :ProgramIdList
@@ -4628,7 +4670,7 @@ module TencentCloud
4628
4670
 
4629
4671
  # CreateLaneRule返回参数结构体
4630
4672
  class CreateLaneRuleResponse < TencentCloud::Common::AbstractModel
4631
- # @param Result: 泳道规则Id
4673
+ # @param Result: 灰度发布规则ID。
4632
4674
  # @type Result: String
4633
4675
  # @param RequestId: 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
4634
4676
  # @type RequestId: String
@@ -4648,11 +4690,11 @@ module TencentCloud
4648
4690
 
4649
4691
  # CreateMicroservice请求参数结构体
4650
4692
  class CreateMicroserviceRequest < TencentCloud::Common::AbstractModel
4651
- # @param NamespaceId: 命名空间ID
4693
+ # @param NamespaceId: 命名空间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)创建新的命名空间。
4652
4694
  # @type NamespaceId: String
4653
- # @param MicroserviceName: 微服务名称
4695
+ # @param MicroserviceName: 微服务名称。该参数可以通过调用 [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)创建新的微服务。
4654
4696
  # @type MicroserviceName: String
4655
- # @param MicroserviceDesc: 微服务描述信息
4697
+ # @param MicroserviceDesc: 微服务备注信息,最多支持200个字符。
4656
4698
  # @type MicroserviceDesc: String
4657
4699
 
4658
4700
  attr_accessor :NamespaceId, :MicroserviceName, :MicroserviceDesc
@@ -4672,7 +4714,7 @@ module TencentCloud
4672
4714
 
4673
4715
  # CreateMicroservice返回参数结构体
4674
4716
  class CreateMicroserviceResponse < TencentCloud::Common::AbstractModel
4675
- # @param Result: 新增微服务是否成功。
4717
+ # @param Result: 新增结果。
4676
4718
  # true:操作成功。
4677
4719
  # false:操作失败。
4678
4720
  # @type Result: Boolean
@@ -4694,11 +4736,11 @@ module TencentCloud
4694
4736
 
4695
4737
  # CreateMicroserviceWithDetailResp请求参数结构体
4696
4738
  class CreateMicroserviceWithDetailRespRequest < TencentCloud::Common::AbstractModel
4697
- # @param NamespaceId: 命名空间ID
4739
+ # @param NamespaceId: 命名空间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)创建新的命名空间。
4698
4740
  # @type NamespaceId: String
4699
- # @param MicroserviceName: 微服务名称
4741
+ # @param MicroserviceName: 微服务名称,最多支持128个字符。
4700
4742
  # @type MicroserviceName: String
4701
- # @param MicroserviceDesc: 微服务描述信息
4743
+ # @param MicroserviceDesc: 微服务描述信息,最多支持200个字符。
4702
4744
  # @type MicroserviceDesc: String
4703
4745
 
4704
4746
  attr_accessor :NamespaceId, :MicroserviceName, :MicroserviceDesc
@@ -4718,7 +4760,7 @@ module TencentCloud
4718
4760
 
4719
4761
  # CreateMicroserviceWithDetailResp返回参数结构体
4720
4762
  class CreateMicroserviceWithDetailRespResponse < TencentCloud::Common::AbstractModel
4721
- # @param Result: 微服务ID
4763
+ # @param Result: 微服务ID
4722
4764
  # @type Result: String
4723
4765
  # @param RequestId: 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
4724
4766
  # @type RequestId: String
@@ -4740,26 +4782,28 @@ module TencentCloud
4740
4782
  class CreateNamespaceRequest < TencentCloud::Common::AbstractModel
4741
4783
  # @param NamespaceName: 命名空间名称
4742
4784
  # @type NamespaceName: String
4743
- # @param ClusterId: 集群ID
4785
+ # @param ClusterId: 集群ID,按照【集群ID】进行过滤,可通过调用[DescribeClusters](https://cloud.tencent.com/document/product/649/85857)查询已创建的集群列表或登录控制台进行查看;也可以调用[CreateCluster](https://cloud.tencent.com/document/product/649/36049)创建新的集群。仅在集群下无部署组、命名空间、云主机时可以删除。
4744
4786
  # @type ClusterId: String
4745
4787
  # @param NamespaceDesc: 命名空间描述
4746
4788
  # @type NamespaceDesc: String
4747
- # @param NamespaceResourceType: 命名空间资源类型(默认值为DEF)
4789
+ # @param NamespaceResourceType: 命名空间资源类型(默认值为DEF)。DEF:默认普通命名空间。GLOBAL:全局命名空间
4748
4790
  # @type NamespaceResourceType: String
4749
4791
  # @param NamespaceType: 是否是全局命名空间(默认是DEF,表示普通命名空间;GLOBAL表示全局命名空间)
4750
4792
  # @type NamespaceType: String
4751
- # @param NamespaceId: 命名空间ID
4793
+ # @param NamespaceId: 命名空间ID,按照【命名空间ID】进行过滤,可通过调用[DescribeNamespaces](https://cloud.tencent.com/document/product/649/36096)查询已创建的命名空间列表或登录控制台进行查看;也可以调用[CreateNamespace](https://cloud.tencent.com/document/product/649/36098)创建新命名空间。
4752
4794
  # @type NamespaceId: String
4753
4795
  # @param IsHaEnable: 是否开启高可用,1 表示开启,0 表示不开启
4754
4796
  # @type IsHaEnable: String
4755
- # @param ProgramId: 需要绑定的数据集ID
4797
+ # @param ProgramId: 需要绑定的数据集ID,可通过调用[DescribePrograms](https://cloud.tencent.com/document/api/649/73477)查询已创建的数据集列表或登录控制台进行查看;也可以调用[CreateProgram](https://cloud.tencent.com/document/api/649/108544)创建新的数据集。
4756
4798
  # @type ProgramId: String
4757
- # @param ProgramIdList: 需要绑定的数据集ID
4799
+ # @param ProgramIdList: 需要绑定的数据集ID列表,可通过调用[DescribePrograms](https://cloud.tencent.com/document/api/649/73477)查询已创建的数据集列表或登录控制台进行查看;也可以调用[CreateProgram](https://cloud.tencent.com/document/api/649/108544)创建新的数据集。
4758
4800
  # @type ProgramIdList: Array
4801
+ # @param CreateK8sNamespaceFlag: 是否创建k8s命名空间标识
4802
+ # @type CreateK8sNamespaceFlag: Boolean
4759
4803
 
4760
- attr_accessor :NamespaceName, :ClusterId, :NamespaceDesc, :NamespaceResourceType, :NamespaceType, :NamespaceId, :IsHaEnable, :ProgramId, :ProgramIdList
4804
+ attr_accessor :NamespaceName, :ClusterId, :NamespaceDesc, :NamespaceResourceType, :NamespaceType, :NamespaceId, :IsHaEnable, :ProgramId, :ProgramIdList, :CreateK8sNamespaceFlag
4761
4805
 
4762
- def initialize(namespacename=nil, clusterid=nil, namespacedesc=nil, namespaceresourcetype=nil, namespacetype=nil, namespaceid=nil, ishaenable=nil, programid=nil, programidlist=nil)
4806
+ def initialize(namespacename=nil, clusterid=nil, namespacedesc=nil, namespaceresourcetype=nil, namespacetype=nil, namespaceid=nil, ishaenable=nil, programid=nil, programidlist=nil, createk8snamespaceflag=nil)
4763
4807
  @NamespaceName = namespacename
4764
4808
  @ClusterId = clusterid
4765
4809
  @NamespaceDesc = namespacedesc
@@ -4769,6 +4813,7 @@ module TencentCloud
4769
4813
  @IsHaEnable = ishaenable
4770
4814
  @ProgramId = programid
4771
4815
  @ProgramIdList = programidlist
4816
+ @CreateK8sNamespaceFlag = createk8snamespaceflag
4772
4817
  end
4773
4818
 
4774
4819
  def deserialize(params)
@@ -4781,6 +4826,7 @@ module TencentCloud
4781
4826
  @IsHaEnable = params['IsHaEnable']
4782
4827
  @ProgramId = params['ProgramId']
4783
4828
  @ProgramIdList = params['ProgramIdList']
4829
+ @CreateK8sNamespaceFlag = params['CreateK8sNamespaceFlag']
4784
4830
  end
4785
4831
  end
4786
4832
 
@@ -4939,19 +4985,21 @@ module TencentCloud
4939
4985
 
4940
4986
  # CreatePublicConfig请求参数结构体
4941
4987
  class CreatePublicConfigRequest < TencentCloud::Common::AbstractModel
4942
- # @param ConfigName: 配置项名称
4988
+ # @param ConfigName: 配置名称,最长60个字符,只能包含字母、数字及分隔符(“-”、“_”),且不能以分隔符开头或结尾。
4943
4989
  # @type ConfigName: String
4944
- # @param ConfigVersion: 配置项版本
4990
+ # @param ConfigVersion: 配置版本,只能包含小写字母、数字及分隔符("-","."),且必须以小写字母或数字开头、以小写字母或数字结尾,中间不能有连续的"-"或"."。
4945
4991
  # @type ConfigVersion: String
4946
- # @param ConfigValue: 配置项值,总是接收yaml格式的内容
4992
+ # @param ConfigValue: 配置项值,总是接收yaml格式的内容。
4947
4993
  # @type ConfigValue: String
4948
- # @param ConfigVersionDesc: 配置项版本描述
4994
+ # @param ConfigVersionDesc: 配置项版本描述,最多支持200个字符。
4949
4995
  # @type ConfigVersionDesc: String
4950
- # @param ConfigType: 配置项类型
4996
+ # @param ConfigType: 配置项类型,固定值。
4951
4997
  # @type ConfigType: String
4952
- # @param EncodeWithBase64: Base64编码的配置项
4998
+ # @param EncodeWithBase64: Base64编码的配置项。
4999
+ # - true:开启
5000
+ # - false:关闭
4953
5001
  # @type EncodeWithBase64: Boolean
4954
- # @param ProgramIdList:
5002
+ # @param ProgramIdList: 需要绑定的数据集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)创建新的数据集。
4955
5003
  # @type ProgramIdList: Array
4956
5004
 
4957
5005
  attr_accessor :ConfigName, :ConfigVersion, :ConfigValue, :ConfigVersionDesc, :ConfigType, :EncodeWithBase64, :ProgramIdList
@@ -4979,7 +5027,9 @@ module TencentCloud
4979
5027
 
4980
5028
  # CreatePublicConfig返回参数结构体
4981
5029
  class CreatePublicConfigResponse < TencentCloud::Common::AbstractModel
4982
- # @param Result: true:创建成功;false:创建失败
5030
+ # @param Result: 创建结果。
5031
+ # - true:创建成功
5032
+ # - false:创建失败
4983
5033
  # @type Result: Boolean
4984
5034
  # @param RequestId: 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
4985
5035
  # @type RequestId: String
@@ -4999,19 +5049,21 @@ module TencentCloud
4999
5049
 
5000
5050
  # CreatePublicConfigWithDetailResp请求参数结构体
5001
5051
  class CreatePublicConfigWithDetailRespRequest < TencentCloud::Common::AbstractModel
5002
- # @param ConfigName: 配置项名称
5052
+ # @param ConfigName: 配置项名称,最多支持60个字符,只能包含字母、数字及分隔符(“-”、“_”),且不能以分隔符开头或结尾。
5003
5053
  # @type ConfigName: String
5004
- # @param ConfigVersion: 配置项版本
5054
+ # @param ConfigVersion: 配置项版本,最多支持60个字符,只能包含小写字母、数字及分隔符("-","."),且必须以小写字母或数字开头、以小写字母或数字结尾,中间不能有连续的"-"或"."。
5005
5055
  # @type ConfigVersion: String
5006
- # @param ConfigValue: 配置项值,总是接收yaml格式的内容
5056
+ # @param ConfigValue: 配置项值,总是接收yaml格式的内容。
5007
5057
  # @type ConfigValue: String
5008
- # @param ConfigVersionDesc: 配置项版本描述
5058
+ # @param ConfigVersionDesc: 配置项版本描述,最多支持200个字符。
5009
5059
  # @type ConfigVersionDesc: String
5010
- # @param ConfigType: 配置项类型
5060
+ # @param ConfigType: 配置项类型,固定值。
5011
5061
  # @type ConfigType: String
5012
- # @param EncodeWithBase64: Base64编码的配置项
5062
+ # @param EncodeWithBase64: Base64编码的配置项。
5063
+ # - true:开启
5064
+ # - false:关闭
5013
5065
  # @type EncodeWithBase64: Boolean
5014
- # @param ProgramIdList:
5066
+ # @param ProgramIdList: 需要绑定的数据集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)创建新的数据集。
5015
5067
  # @type ProgramIdList: Array
5016
5068
 
5017
5069
  attr_accessor :ConfigName, :ConfigVersion, :ConfigValue, :ConfigVersionDesc, :ConfigType, :EncodeWithBase64, :ProgramIdList
@@ -5039,7 +5091,7 @@ module TencentCloud
5039
5091
 
5040
5092
  # CreatePublicConfigWithDetailResp返回参数结构体
5041
5093
  class CreatePublicConfigWithDetailRespResponse < TencentCloud::Common::AbstractModel
5042
- # @param Result: 公共配置项 ID
5094
+ # @param Result: 公共配置项ID
5043
5095
  # @type Result: :class:`Tencentcloud::Tsf.v20180326.models.Config`
5044
5096
  # @param RequestId: 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
5045
5097
  # @type RequestId: String
@@ -5066,9 +5118,9 @@ module TencentCloud
5066
5118
  # @type RepositoryName: String
5067
5119
  # @param RepositoryType: 仓库类型(默认仓库:default,私有仓库:private)
5068
5120
  # @type RepositoryType: String
5069
- # @param BucketName: 仓库所在桶名称
5121
+ # @param BucketName: 仓库所在桶名称,[存储桶概述和创建](https://cloud.tencent.com/document/product/436/13312)
5070
5122
  # @type BucketName: String
5071
- # @param BucketRegion: 仓库所在桶地域
5123
+ # @param BucketRegion: 仓库所在桶地域,[存储桶概述和创建](https://cloud.tencent.com/document/product/436/13312)
5072
5124
  # @type BucketRegion: String
5073
5125
  # @param Directory: 目录
5074
5126
  # @type Directory: String
@@ -5184,13 +5236,13 @@ module TencentCloud
5184
5236
  # @type TaskName: String
5185
5237
  # @param TaskContent: 任务内容,长度限制65536个字节
5186
5238
  # @type TaskContent: String
5187
- # @param ExecuteType: 执行类型,unicast/broadcast
5239
+ # @param ExecuteType: 任务执行方式,unicast:随机单节点执行,broadcast:广播执行,shard:分片执行
5188
5240
  # @type ExecuteType: String
5189
- # @param TaskType: 任务类型,java
5241
+ # @param TaskType: 任务类型。当前只支持一种任务类型。枚举值,java:Java类任务
5190
5242
  # @type TaskType: String
5191
- # @param TimeOut: 任务超时时间, 时间单位 ms
5243
+ # @param TimeOut: 任务超时时间,取值大于0,单位:毫秒(ms
5192
5244
  # @type TimeOut: Integer
5193
- # @param GroupId: 部署组ID
5245
+ # @param GroupId: 部署组ID。在[应用管理](https://console.cloud.tencent.com/tsf/app?rid=1),点击应用ID进入应用部署页查看部署组ID。
5194
5246
  # @type GroupId: String
5195
5247
  # @param TaskRule: 触发规则
5196
5248
  # @type TaskRule: :class:`Tencentcloud::Tsf.v20180326.models.TaskRule`
@@ -5198,7 +5250,7 @@ module TencentCloud
5198
5250
  # @type RetryCount: Integer
5199
5251
  # @param RetryInterval: 重试间隔, 0 <= RetryInterval <= 600000, 时间单位 ms
5200
5252
  # @type RetryInterval: Integer
5201
- # @param ShardCount: 分片数量
5253
+ # @param ShardCount: 分片数量,仅当任务执行方式为分片执行时需要设置该值,取值范围2~1000
5202
5254
  # @type ShardCount: Integer
5203
5255
  # @param ShardArguments: 分片参数
5204
5256
  # @type ShardArguments: Array
@@ -5210,7 +5262,7 @@ module TencentCloud
5210
5262
  # @type AdvanceSettings: :class:`Tencentcloud::Tsf.v20180326.models.AdvanceSettings`
5211
5263
  # @param TaskArgument: 任务参数,长度限制10000个字符
5212
5264
  # @type TaskArgument: String
5213
- # @param ProgramIdList:
5265
+ # @param ProgramIdList: 数据集列表
5214
5266
  # @type ProgramIdList: Array
5215
5267
 
5216
5268
  attr_accessor :TaskName, :TaskContent, :ExecuteType, :TaskType, :TimeOut, :GroupId, :TaskRule, :RetryCount, :RetryInterval, :ShardCount, :ShardArguments, :SuccessOperator, :SuccessRatio, :AdvanceSettings, :TaskArgument, :ProgramIdList
@@ -5453,7 +5505,7 @@ module TencentCloud
5453
5505
  # @type Label: String
5454
5506
  # @param Value: 当前坐标 Y轴的值
5455
5507
  # @type Value: String
5456
- # @param Timestamp: 该坐标点时间戳
5508
+ # @param Timestamp: 该坐标点时间戳,单位毫秒
5457
5509
  # @type Timestamp: String
5458
5510
 
5459
5511
  attr_accessor :Label, :Value, :Timestamp
@@ -5603,7 +5655,7 @@ module TencentCloud
5603
5655
 
5604
5656
  # DeleteApplication请求参数结构体
5605
5657
  class DeleteApplicationRequest < TencentCloud::Common::AbstractModel
5606
- # @param ApplicationId: 应用ID
5658
+ # @param ApplicationId: 应用ID,可通过调用[DescribeApplications](https://cloud.tencent.com/document/api/649/36090)查询已创建的应用列表或登录控制台进行查看;也可以调用[CreateApplication](https://cloud.tencent.com/document/api/649/36094)创建新的应用。
5607
5659
  # @type ApplicationId: String
5608
5660
  # @param SyncDeleteImageRepository: 是否删除镜像仓库
5609
5661
  # @type SyncDeleteImageRepository: Boolean
@@ -5645,7 +5697,7 @@ module TencentCloud
5645
5697
 
5646
5698
  # DeleteCluster请求参数结构体
5647
5699
  class DeleteClusterRequest < TencentCloud::Common::AbstractModel
5648
- # @param ClusterId: 集群ID
5700
+ # @param ClusterId: 集群ID,按照【集群ID】进行过滤,可通过调用DescribeClusters查询已创建的项目列表或登录控制台进行查看;也可以调用CreateCluster创建新的项目。集群ID例如:cls-6a79x94v。仅在集群下无部署组、命名空间、云主机时可以删除。
5649
5701
  # @type ClusterId: String
5650
5702
  # @param Unbind: 是否只解绑,不删除容器集群,默认不传则删除容器集群。
5651
5703
  # @type Unbind: Boolean
@@ -5687,7 +5739,7 @@ module TencentCloud
5687
5739
 
5688
5740
  # DeleteConfig请求参数结构体
5689
5741
  class DeleteConfigRequest < TencentCloud::Common::AbstractModel
5690
- # @param ConfigId: 配置项ID
5742
+ # @param ConfigId: 配置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)创建新的配置。
5691
5743
  # @type ConfigId: String
5692
5744
 
5693
5745
  attr_accessor :ConfigId
@@ -5703,7 +5755,9 @@ module TencentCloud
5703
5755
 
5704
5756
  # DeleteConfig返回参数结构体
5705
5757
  class DeleteConfigResponse < TencentCloud::Common::AbstractModel
5706
- # @param Result: true:删除成功;false:删除失败
5758
+ # @param Result: 删除结果。
5759
+ # - true:删除成功
5760
+ # - false:删除失败
5707
5761
  # @type Result: Boolean
5708
5762
  # @param RequestId: 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
5709
5763
  # @type RequestId: String
@@ -5723,7 +5777,7 @@ module TencentCloud
5723
5777
 
5724
5778
  # DeleteConfigTemplate请求参数结构体
5725
5779
  class DeleteConfigTemplateRequest < TencentCloud::Common::AbstractModel
5726
- # @param ConfigTemplateId:
5780
+ # @param ConfigTemplateId: 配置模板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)创建新的配置模板。
5727
5781
  # @type ConfigTemplateId: String
5728
5782
 
5729
5783
  attr_accessor :ConfigTemplateId
@@ -5759,7 +5813,7 @@ module TencentCloud
5759
5813
 
5760
5814
  # DeleteContainerGroup请求参数结构体
5761
5815
  class DeleteContainerGroupRequest < TencentCloud::Common::AbstractModel
5762
- # @param GroupId: 部署组ID,分组唯一标识
5816
+ # @param GroupId: 部署组ID,可通过调用[DescribeContainerGroups](https://cloud.tencent.com/document/api/649/36068)查询已创建的部署组列表或登录控制台进行查看;也可以调用[CreateContainGroup](https://cloud.tencent.com/document/api/649/36075)创建新的部署组。
5763
5817
  # @type GroupId: String
5764
5818
 
5765
5819
  attr_accessor :GroupId
@@ -5797,7 +5851,7 @@ module TencentCloud
5797
5851
 
5798
5852
  # DeleteFileConfig请求参数结构体
5799
5853
  class DeleteFileConfigRequest < TencentCloud::Common::AbstractModel
5800
- # @param ConfigId: 文件配置项ID
5854
+ # @param ConfigId: 文件配置项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)创建新的文件配置。
5801
5855
  # @type ConfigId: String
5802
5856
 
5803
5857
  attr_accessor :ConfigId
@@ -5813,7 +5867,9 @@ module TencentCloud
5813
5867
 
5814
5868
  # DeleteFileConfig返回参数结构体
5815
5869
  class DeleteFileConfigResponse < TencentCloud::Common::AbstractModel
5816
- # @param Result: 删除结果
5870
+ # @param Result: 删除结果。
5871
+ # - true:成功
5872
+ # - false:失败
5817
5873
  # @type Result: Boolean
5818
5874
  # @param RequestId: 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
5819
5875
  # @type RequestId: String
@@ -5873,7 +5929,7 @@ module TencentCloud
5873
5929
 
5874
5930
  # DeleteGroup请求参数结构体
5875
5931
  class DeleteGroupRequest < TencentCloud::Common::AbstractModel
5876
- # @param GroupId: 部署组ID
5932
+ # @param GroupId: 部署组ID,可通过调用[DescribeGroups](https://cloud.tencent.com/document/api/649/36065)查询已创建的部署组列表或登录控制台进行查看;也可以调用[CreateGroup](https://cloud.tencent.com/document/api/649/36074)创建新的部署组。
5877
5933
  # @type GroupId: String
5878
5934
 
5879
5935
  attr_accessor :GroupId
@@ -5931,7 +5987,7 @@ module TencentCloud
5931
5987
 
5932
5988
  # DeleteImageTags请求参数结构体
5933
5989
  class DeleteImageTagsRequest < TencentCloud::Common::AbstractModel
5934
- # @param ImageTags: 镜像版本数组
5990
+ # @param ImageTags: 需要删除的镜像版本列表,可通过调用[DescribeImageTags](https://cloud.tencent.com/document/api/649/36052)查询已创建的镜像版本列表或登录控制台进行查看。
5935
5991
  # @type ImageTags: Array
5936
5992
  # @param RepoType: 企业: tcr ;个人: personal或者不填
5937
5993
  # @type RepoType: String
@@ -5980,7 +6036,7 @@ module TencentCloud
5980
6036
 
5981
6037
  # DeleteLane请求参数结构体
5982
6038
  class DeleteLaneRequest < TencentCloud::Common::AbstractModel
5983
- # @param LaneId: 泳道Idl
6039
+ # @param LaneId: 泳道配置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)创建新的泳道配置。
5984
6040
  # @type LaneId: String
5985
6041
 
5986
6042
  attr_accessor :LaneId
@@ -5996,7 +6052,9 @@ module TencentCloud
5996
6052
 
5997
6053
  # DeleteLane返回参数结构体
5998
6054
  class DeleteLaneResponse < TencentCloud::Common::AbstractModel
5999
- # @param Result: 删除成功: true / 删除失败: false
6055
+ # @param Result: 删除结果。
6056
+ # - true:删除成功
6057
+ # - false:删除失败
6000
6058
  # @type Result: Boolean
6001
6059
  # @param RequestId: 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
6002
6060
  # @type RequestId: String
@@ -6016,7 +6074,7 @@ module TencentCloud
6016
6074
 
6017
6075
  # DeleteLaneRule请求参数结构体
6018
6076
  class DeleteLaneRuleRequest < TencentCloud::Common::AbstractModel
6019
- # @param RuleId: 泳道规则Id
6077
+ # @param RuleId: 灰度发布规则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)创建新的泳道规则。
6020
6078
  # @type RuleId: String
6021
6079
 
6022
6080
  attr_accessor :RuleId
@@ -6032,7 +6090,9 @@ module TencentCloud
6032
6090
 
6033
6091
  # DeleteLaneRule返回参数结构体
6034
6092
  class DeleteLaneRuleResponse < TencentCloud::Common::AbstractModel
6035
- # @param Result: 操作状态
6093
+ # @param Result: 删除结果。
6094
+ # - true:成功
6095
+ # - false:失败
6036
6096
  # @type Result: Boolean
6037
6097
  # @param RequestId: 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
6038
6098
  # @type RequestId: String
@@ -6052,7 +6112,7 @@ module TencentCloud
6052
6112
 
6053
6113
  # DeleteMicroservice请求参数结构体
6054
6114
  class DeleteMicroserviceRequest < TencentCloud::Common::AbstractModel
6055
- # @param MicroserviceId: 微服务ID
6115
+ # @param MicroserviceId: 微服务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)创建新的微服务。
6056
6116
  # @type MicroserviceId: String
6057
6117
 
6058
6118
  attr_accessor :MicroserviceId
@@ -6068,9 +6128,9 @@ module TencentCloud
6068
6128
 
6069
6129
  # DeleteMicroservice返回参数结构体
6070
6130
  class DeleteMicroserviceResponse < TencentCloud::Common::AbstractModel
6071
- # @param Result: 删除微服务是否成功。
6072
- # true:操作成功。
6073
- # false:操作失败。
6131
+ # @param Result: 删除结果。
6132
+ # - true:操作成功
6133
+ # - false:操作失败
6074
6134
  # @type Result: Boolean
6075
6135
  # @param RequestId: 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
6076
6136
  # @type RequestId: String
@@ -6090,9 +6150,9 @@ module TencentCloud
6090
6150
 
6091
6151
  # DeleteNamespace请求参数结构体
6092
6152
  class DeleteNamespaceRequest < TencentCloud::Common::AbstractModel
6093
- # @param NamespaceId: 命名空间ID
6153
+ # @param NamespaceId: 命名空间ID,按照【命名空间ID】进行过滤,可通过调用[DescribeNamespaces](https://cloud.tencent.com/document/product/649/36096)查询已创建的命名空间列表或登录控制台进行查看;也可以调用[CreateNamespace](https://cloud.tencent.com/document/product/649/36098)创建新命名空间。
6094
6154
  # @type NamespaceId: String
6095
- # @param ClusterId: 集群ID
6155
+ # @param ClusterId: 集群ID,按照【集群ID】进行过滤,可通过调用[DescribeClusters](https://cloud.tencent.com/document/product/649/85857)查询已创建的集群列表或登录控制台进行查看;也可以调用[CreateCluster](https://cloud.tencent.com/document/product/649/36049)创建新的集群。仅在集群下无部署组、命名空间、云主机时可以删除。
6096
6156
  # @type ClusterId: String
6097
6157
 
6098
6158
  attr_accessor :NamespaceId, :ClusterId
@@ -6168,13 +6228,13 @@ module TencentCloud
6168
6228
 
6169
6229
  # DeletePkgs请求参数结构体
6170
6230
  class DeletePkgsRequest < TencentCloud::Common::AbstractModel
6171
- # @param ApplicationId: 应用ID
6231
+ # @param ApplicationId: 应用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)时的返回值
6172
6232
  # @type ApplicationId: String
6173
- # @param PkgIds: 需要删除的程序包ID列表
6233
+ # @param PkgIds: 软件包ID所形成的列表,软件包ID可通过调用DescribeUploadInfo接口时[获取上传程序包信息](https://cloud.tencent.com/document/api/649/36078)返回的COS上传信息获取,登录[控制台](https://console.cloud.tencent.com/tsf/product?rid=1)进行查看
6174
6234
  # @type PkgIds: Array
6175
- # @param RepositoryType: 程序包仓库类型
6235
+ # @param RepositoryType: 程序包仓库类型(允许值:"public-demo"TSF公共demo仓库, "private"自定义仓库, "default"TSF公共仓库)
6176
6236
  # @type RepositoryType: String
6177
- # @param RepositoryId: 程序包仓库id
6237
+ # @param RepositoryId: 仓库ID,可通过调用[仓库信息查询类](https://cloud.tencent.com/document/api/649/45925)接口时出参中的RepositoryId,或登录[控制台](https://console.cloud.tencent.com/tsf/product?rid=1)进行查看
6178
6238
  # @type RepositoryId: String
6179
6239
 
6180
6240
  attr_accessor :ApplicationId, :PkgIds, :RepositoryType, :RepositoryId
@@ -6212,7 +6272,7 @@ module TencentCloud
6212
6272
 
6213
6273
  # DeletePublicConfig请求参数结构体
6214
6274
  class DeletePublicConfigRequest < TencentCloud::Common::AbstractModel
6215
- # @param ConfigId: 配置项ID
6275
+ # @param ConfigId: 配置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)创建新的配置。
6216
6276
  # @type ConfigId: String
6217
6277
 
6218
6278
  attr_accessor :ConfigId
@@ -6228,7 +6288,9 @@ module TencentCloud
6228
6288
 
6229
6289
  # DeletePublicConfig返回参数结构体
6230
6290
  class DeletePublicConfigResponse < TencentCloud::Common::AbstractModel
6231
- # @param Result: true:删除成功;false:删除失败
6291
+ # @param Result: 删除结果。
6292
+ # - true:删除成功
6293
+ # - false:删除失败
6232
6294
  # @type Result: Boolean
6233
6295
  # @param RequestId: 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
6234
6296
  # @type RequestId: String
@@ -6248,7 +6310,7 @@ module TencentCloud
6248
6310
 
6249
6311
  # DeleteRepository请求参数结构体
6250
6312
  class DeleteRepositoryRequest < TencentCloud::Common::AbstractModel
6251
- # @param RepositoryId: 仓库ID
6313
+ # @param RepositoryId: 删除对应仓库ID,可通过调用[仓库信息查询类](https://cloud.tencent.com/document/api/649/45925)接口时出参中的RepositoryId,或登录[控制台](https://console.cloud.tencent.com/tsf/product?rid=1)进行查看
6252
6314
  # @type RepositoryId: String
6253
6315
 
6254
6316
  attr_accessor :RepositoryId
@@ -6320,7 +6382,7 @@ module TencentCloud
6320
6382
 
6321
6383
  # DeleteTask请求参数结构体
6322
6384
  class DeleteTaskRequest < TencentCloud::Common::AbstractModel
6323
- # @param TaskId: 任务ID
6385
+ # @param TaskId: 任务ID。在[任务管理](https://console.cloud.tencent.com/tsf/tct?rid=1)列表页第一列和任务基本信息页查看任务ID。
6324
6386
  # @type TaskId: String
6325
6387
 
6326
6388
  attr_accessor :TaskId
@@ -6336,7 +6398,7 @@ module TencentCloud
6336
6398
 
6337
6399
  # DeleteTask返回参数结构体
6338
6400
  class DeleteTaskResponse < TencentCloud::Common::AbstractModel
6339
- # @param Result: 删除成功or失败
6401
+ # @param Result: true:删除成功,false:删除失败
6340
6402
  # @type Result: Boolean
6341
6403
  # @param RequestId: 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
6342
6404
  # @type RequestId: String
@@ -6440,15 +6502,15 @@ module TencentCloud
6440
6502
  # @type CollectPath: Array
6441
6503
  # @param Groups: 关联部署组信息
6442
6504
  # @type Groups: Array
6443
- # @param CreateTime: 创建时间
6505
+ # @param CreateTime: 创建时间,格式yyyy-MM-dd HH:mm:ss
6444
6506
  # @type CreateTime: String
6445
- # @param KafkaVIp: KafkaVIp
6507
+ # @param KafkaVIp: Kafka的vip
6446
6508
  # 注意:此字段可能返回 null,表示取不到有效值。
6447
6509
  # @type KafkaVIp: String
6448
- # @param KafkaAddress: KafkaAddress
6510
+ # @param KafkaAddress: Kafka地址
6449
6511
  # 注意:此字段可能返回 null,表示取不到有效值。
6450
6512
  # @type KafkaAddress: String
6451
- # @param KafkaVPort: KafkaVPort
6513
+ # @param KafkaVPort: Kafka端口
6452
6514
  # 注意:此字段可能返回 null,表示取不到有效值。
6453
6515
  # @type KafkaVPort: String
6454
6516
  # @param Topic: Topic
@@ -6456,18 +6518,18 @@ module TencentCloud
6456
6518
  # @param LineRule: LineRule
6457
6519
  # 注意:此字段可能返回 null,表示取不到有效值。
6458
6520
  # @type LineRule: String
6459
- # @param CustomRule: CustomRule
6521
+ # @param CustomRule: 自定义规则
6460
6522
  # 注意:此字段可能返回 null,表示取不到有效值。
6461
6523
  # @type CustomRule: String
6462
6524
  # @param EnableGlobalLineRule: EnableGlobalLineRule
6463
6525
  # 注意:此字段可能返回 null,表示取不到有效值。
6464
6526
  # @type EnableGlobalLineRule: Boolean
6465
- # @param EnableAuth: EnableAuth
6527
+ # @param EnableAuth: 是否开启认证
6466
6528
  # @type EnableAuth: Boolean
6467
- # @param Username: Username
6529
+ # @param Username: 用户名
6468
6530
  # 注意:此字段可能返回 null,表示取不到有效值。
6469
6531
  # @type Username: String
6470
- # @param Password: Password
6532
+ # @param Password: 密码
6471
6533
  # 注意:此字段可能返回 null,表示取不到有效值。
6472
6534
  # @type Password: String
6473
6535
  # @param KafkaInfos: KafkaInfos
@@ -6950,7 +7012,7 @@ module TencentCloud
6950
7012
 
6951
7013
  # DeployContainerGroup请求参数结构体
6952
7014
  class DeployContainerGroupRequest < TencentCloud::Common::AbstractModel
6953
- # @param GroupId: 部署组ID,分组唯一标识
7015
+ # @param GroupId: 部署组ID,可通过调用[DescribeContainerGroups](https://cloud.tencent.com/document/api/649/36068)查询已创建的部署组列表或登录控制台进行查看;也可以调用[CreateContainGroup](https://cloud.tencent.com/document/api/649/36075)创建新的部署组。
6954
7016
  # @type GroupId: String
6955
7017
  # @param TagName: 镜像版本名称,如v1
6956
7018
  # @type TagName: String
@@ -7316,15 +7378,22 @@ module TencentCloud
7316
7378
 
7317
7379
  # DescribeApiDetail请求参数结构体
7318
7380
  class DescribeApiDetailRequest < TencentCloud::Common::AbstractModel
7319
- # @param MicroserviceId: 微服务id
7381
+ # @param MicroserviceId: 微服务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)创建新的微服务。
7320
7382
  # @type MicroserviceId: String
7321
- # @param Path: 请求路径
7383
+ # @param Path: 请求路径。
7322
7384
  # @type Path: String
7323
- # @param Method: 请求方法
7385
+ # @param Method: 请求方法。
7386
+ # - GET
7387
+ # - POST
7388
+ # - PUT
7389
+ # - DELETE
7390
+ # - HEAD
7391
+ # - PATCH
7392
+ # - OPTIONS
7324
7393
  # @type Method: String
7325
- # @param PkgVersion: 包版本
7394
+ # @param PkgVersion: 应用包版本号。
7326
7395
  # @type PkgVersion: String
7327
- # @param ApplicationId: 应用ID
7396
+ # @param ApplicationId: 应用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)创建新的应用。
7328
7397
  # @type ApplicationId: String
7329
7398
 
7330
7399
  attr_accessor :MicroserviceId, :Path, :Method, :PkgVersion, :ApplicationId
@@ -7348,7 +7417,7 @@ module TencentCloud
7348
7417
 
7349
7418
  # DescribeApiDetail返回参数结构体
7350
7419
  class DescribeApiDetailResponse < TencentCloud::Common::AbstractModel
7351
- # @param Result: API 详情
7420
+ # @param Result: API详情。
7352
7421
  # @type Result: :class:`Tencentcloud::Tsf.v20180326.models.ApiDetailResponse`
7353
7422
  # @param RequestId: 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
7354
7423
  # @type RequestId: String
@@ -7575,11 +7644,18 @@ module TencentCloud
7575
7644
 
7576
7645
  # DescribeApiVersions请求参数结构体
7577
7646
  class DescribeApiVersionsRequest < TencentCloud::Common::AbstractModel
7578
- # @param MicroserviceId: 微服务ID
7647
+ # @param MicroserviceId: 微服务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)创建新的微服务。
7579
7648
  # @type MicroserviceId: String
7580
- # @param Path: API 请求路径
7649
+ # @param Path: API请求路径。
7581
7650
  # @type Path: String
7582
- # @param Method: 请求方法
7651
+ # @param Method: API请求方法。
7652
+ # - GET
7653
+ # - POST
7654
+ # - PUT
7655
+ # - DELETE
7656
+ # - HEAD
7657
+ # - PATCH
7658
+ # - OPTIONS
7583
7659
  # @type Method: String
7584
7660
 
7585
7661
  attr_accessor :MicroserviceId, :Path, :Method
@@ -7599,7 +7675,7 @@ module TencentCloud
7599
7675
 
7600
7676
  # DescribeApiVersions返回参数结构体
7601
7677
  class DescribeApiVersionsResponse < TencentCloud::Common::AbstractModel
7602
- # @param Result: API版本列表
7678
+ # @param Result: API版本列表。
7603
7679
  # @type Result: Array
7604
7680
  # @param RequestId: 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
7605
7681
  # @type RequestId: String
@@ -7665,7 +7741,7 @@ module TencentCloud
7665
7741
 
7666
7742
  # DescribeApplication请求参数结构体
7667
7743
  class DescribeApplicationRequest < TencentCloud::Common::AbstractModel
7668
- # @param ApplicationId: 应用ID
7744
+ # @param ApplicationId: 应用ID,可通过调用[DescribeApplications](https://cloud.tencent.com/document/api/649/36090)查询已创建的应用列表或登录控制台进行查看;也可以调用[CreateApplication](https://cloud.tencent.com/document/api/649/36094)创建新的应用。
7669
7745
  # @type ApplicationId: String
7670
7746
 
7671
7747
  attr_accessor :ApplicationId
@@ -7709,11 +7785,13 @@ module TencentCloud
7709
7785
  # @type SearchWord: String
7710
7786
  # @param OrderBy: 排序字段
7711
7787
  # @type OrderBy: String
7712
- # @param OrderType: 排序类型
7788
+ # @param OrderType: 指定排序类型,目前支持:
7789
+ # `0`:降序
7790
+ # `1`:升序
7713
7791
  # @type OrderType: Integer
7714
- # @param Offset: 偏移量
7792
+ # @param Offset: 偏移量,默认为0。关于Offset详见[API简介](https://cloud.tencent.com/document/api/213/568#.E8.BE.93.E5.85.A5.E5.8F.82.E6.95.B0.E4.B8.8E.E8.BF.94.E5.9B.9E.E5.8F.82.E6.95.B0.E9.87.8A.E4.B9.89)
7715
7793
  # @type Offset: Integer
7716
- # @param Limit: 分页个数
7794
+ # @param Limit: 数量限制,默认为20,最大值为100。关于Limit详见[API简介](https://cloud.tencent.com/document/api/213/568#.E8.BE.93.E5.85.A5.E5.8F.82.E6.95.B0.E4.B8.8E.E8.BF.94.E5.9B.9E.E5.8F.82.E6.95.B0.E9.87.8A.E4.B9.89)
7717
7795
  # @type Limit: Integer
7718
7796
  # @param ApplicationType: 应用类型
7719
7797
  # @type ApplicationType: String
@@ -7819,7 +7897,8 @@ module TencentCloud
7819
7897
 
7820
7898
  # DescribeBusinessLogConfig请求参数结构体
7821
7899
  class DescribeBusinessLogConfigRequest < TencentCloud::Common::AbstractModel
7822
- # @param ConfigId: 配置项ID
7900
+ # @param ConfigId: 日志配置项ID
7901
+ # 可通过调用[DescribeBusinessLogConfigs](https://cloud.tencent.com/document/product/649/75777)查询已创建的日志配置项列表或登录[控制台](https://console.cloud.tencent.com/tsf/observable/log?rid=1)进行查看
7823
7902
  # @type ConfigId: String
7824
7903
 
7825
7904
  attr_accessor :ConfigId
@@ -7864,9 +7943,10 @@ module TencentCloud
7864
7943
  # @type Limit: Integer
7865
7944
  # @param SearchWord: 模糊匹配关键词
7866
7945
  # @type SearchWord: String
7867
- # @param DisableProgramAuthCheck:
7946
+ # @param DisableProgramAuthCheck: 是否禁用数据集鉴权
7868
7947
  # @type DisableProgramAuthCheck: Boolean
7869
- # @param ConfigIdList:
7948
+ # @param ConfigIdList: 日志配置项ID
7949
+ # 可通过调用[DescribeBusinessLogConfigs](https://cloud.tencent.com/document/product/649/75777)查询已创建的日志配置项列表或登录[控制台](https://console.cloud.tencent.com/tsf/observable/log?rid=1)进行查看
7870
7950
  # @type ConfigIdList: Array
7871
7951
 
7872
7952
  attr_accessor :Offset, :Limit, :SearchWord, :DisableProgramAuthCheck, :ConfigIdList
@@ -7913,17 +7993,17 @@ module TencentCloud
7913
7993
 
7914
7994
  # DescribeClusterInstances请求参数结构体
7915
7995
  class DescribeClusterInstancesRequest < TencentCloud::Common::AbstractModel
7916
- # @param ClusterId: 集群ID
7996
+ # @param ClusterId: 集群 ID。调用[DescribeSimpleClusters](https://cloud.tencent.com/document/api/649/36047)查询已创建的集群或通过[CreateCluster](https://cloud.tencent.com/document/api/649/36049)接口创建新的集群。
7917
7997
  # @type ClusterId: String
7918
7998
  # @param SearchWord: 搜索字段
7919
7999
  # @type SearchWord: String
7920
8000
  # @param OrderBy: 排序字段
7921
8001
  # @type OrderBy: String
7922
- # @param OrderType: 排序类型
8002
+ # @param OrderType: 排序类型;0:升序,1:降序。
7923
8003
  # @type OrderType: Integer
7924
- # @param Offset: 偏移量
8004
+ # @param Offset: 偏移量,默认值:0。
7925
8005
  # @type Offset: Integer
7926
- # @param Limit: 分页个数
8006
+ # @param Limit: 分页个数,默认值:20。
7927
8007
  # @type Limit: Integer
7928
8008
 
7929
8009
  attr_accessor :ClusterId, :SearchWord, :OrderBy, :OrderType, :Offset, :Limit
@@ -7972,17 +8052,17 @@ module TencentCloud
7972
8052
 
7973
8053
  # DescribeClusters请求参数结构体
7974
8054
  class DescribeClustersRequest < TencentCloud::Common::AbstractModel
7975
- # @param SearchWord: 搜索词
8055
+ # @param SearchWord: 搜索词,可以搜索ID/名称/备注/标签
7976
8056
  # @type SearchWord: String
7977
- # @param OrderBy: 排序字段
8057
+ # @param OrderBy: 排序字段,例如创建时间
7978
8058
  # @type OrderBy: String
7979
- # @param OrderType: 排序方式
8059
+ # @param OrderType: 排序方式,0表示升序,1表示倒序
7980
8060
  # @type OrderType: Integer
7981
- # @param Offset: 偏移量
8061
+ # @param Offset: 偏移量,默认0
7982
8062
  # @type Offset: Integer
7983
- # @param Limit: 分页个数
8063
+ # @param Limit: 分页个数,0-50 之间,默认20
7984
8064
  # @type Limit: Integer
7985
- # @param ClusterType: 集群类型
8065
+ # @param ClusterType: 集群类型,C表示容器集群,V表示虚拟机集群
7986
8066
  # @type ClusterType: String
7987
8067
  # @param ClusterIdList: idList
7988
8068
  # @type ClusterIdList: Array
@@ -8035,17 +8115,17 @@ module TencentCloud
8035
8115
 
8036
8116
  # DescribeConfigReleaseLogs请求参数结构体
8037
8117
  class DescribeConfigReleaseLogsRequest < TencentCloud::Common::AbstractModel
8038
- # @param GroupId: 部署组ID,不传入时查询全量
8118
+ # @param GroupId: 部署组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)创建新的部署组。
8039
8119
  # @type GroupId: String
8040
- # @param Offset: 偏移量,默认为0
8120
+ # @param Offset: 偏移量,默认为0
8041
8121
  # @type Offset: Integer
8042
- # @param Limit: 每页条数,默认为20
8122
+ # @param Limit: 返回数量,默认为20,最大值为100。
8043
8123
  # @type Limit: Integer
8044
- # @param NamespaceId: 命名空间ID,不传入时查询全量
8124
+ # @param NamespaceId: 命名空间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)创建新的命名空间。
8045
8125
  # @type NamespaceId: String
8046
- # @param ClusterId: 集群ID,不传入时查询全量
8126
+ # @param ClusterId: 集群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)创建新的集群。
8047
8127
  # @type ClusterId: String
8048
- # @param ApplicationId: 应用ID,不传入时查询全量
8128
+ # @param ApplicationId: 应用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)创建新的应用。
8049
8129
  # @type ApplicationId: String
8050
8130
 
8051
8131
  attr_accessor :GroupId, :Offset, :Limit, :NamespaceId, :ClusterId, :ApplicationId
@@ -8071,7 +8151,7 @@ module TencentCloud
8071
8151
 
8072
8152
  # DescribeConfigReleaseLogs返回参数结构体
8073
8153
  class DescribeConfigReleaseLogsResponse < TencentCloud::Common::AbstractModel
8074
- # @param Result: 分页的配置项发布历史列表
8154
+ # @param Result: 分页的配置项发布历史列表。
8075
8155
  # @type Result: :class:`Tencentcloud::Tsf.v20180326.models.TsfPageConfigReleaseLog`
8076
8156
  # @param RequestId: 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
8077
8157
  # @type RequestId: String
@@ -8094,21 +8174,21 @@ module TencentCloud
8094
8174
 
8095
8175
  # DescribeConfigReleases请求参数结构体
8096
8176
  class DescribeConfigReleasesRequest < TencentCloud::Common::AbstractModel
8097
- # @param ConfigName: 配置项名称,不传入时查询全量
8177
+ # @param ConfigName: 配置项名称,不传入时查询全量。该参数可以通过调用 [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)创建新的配置。
8098
8178
  # @type ConfigName: String
8099
- # @param GroupId: 部署组ID,不传入时查询全量
8179
+ # @param GroupId: 部署组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)创建新的部署组。
8100
8180
  # @type GroupId: String
8101
- # @param NamespaceId: 命名空间ID,不传入时查询全量
8181
+ # @param NamespaceId: 命名空间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)创建新的命名空间。
8102
8182
  # @type NamespaceId: String
8103
- # @param ClusterId: 集群ID,不传入时查询全量
8183
+ # @param ClusterId: 集群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)创建新的集群。
8104
8184
  # @type ClusterId: String
8105
- # @param Limit: 每页条数
8185
+ # @param Limit: 返回数量,默认为20,最大值为100。
8106
8186
  # @type Limit: Integer
8107
- # @param Offset: 偏移量
8187
+ # @param Offset: 偏移量,默认为0。
8108
8188
  # @type Offset: Integer
8109
- # @param ConfigId: 配置ID,不传入时查询全量
8189
+ # @param ConfigId: 配置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)创建新的配置。
8110
8190
  # @type ConfigId: String
8111
- # @param ApplicationId: 应用ID,不传入时查询全量
8191
+ # @param ApplicationId: 应用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)创建新的应用。
8112
8192
  # @type ApplicationId: String
8113
8193
 
8114
8194
  attr_accessor :ConfigName, :GroupId, :NamespaceId, :ClusterId, :Limit, :Offset, :ConfigId, :ApplicationId
@@ -8138,7 +8218,7 @@ module TencentCloud
8138
8218
 
8139
8219
  # DescribeConfigReleases返回参数结构体
8140
8220
  class DescribeConfigReleasesResponse < TencentCloud::Common::AbstractModel
8141
- # @param Result: 分页的配置发布信息
8221
+ # @param Result: 分页的配置发布信息。
8142
8222
  # @type Result: :class:`Tencentcloud::Tsf.v20180326.models.TsfPageConfigRelease`
8143
8223
  # @param RequestId: 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
8144
8224
  # @type RequestId: String
@@ -8161,7 +8241,7 @@ module TencentCloud
8161
8241
 
8162
8242
  # DescribeConfig请求参数结构体
8163
8243
  class DescribeConfigRequest < TencentCloud::Common::AbstractModel
8164
- # @param ConfigId: 配置项ID
8244
+ # @param ConfigId: 配置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)创建新的配置。
8165
8245
  # @type ConfigId: String
8166
8246
 
8167
8247
  attr_accessor :ConfigId
@@ -8177,7 +8257,7 @@ module TencentCloud
8177
8257
 
8178
8258
  # DescribeConfig返回参数结构体
8179
8259
  class DescribeConfigResponse < TencentCloud::Common::AbstractModel
8180
- # @param Result: 配置项
8260
+ # @param Result: 配置信息。
8181
8261
  # 注意:此字段可能返回 null,表示取不到有效值。
8182
8262
  # @type Result: :class:`Tencentcloud::Tsf.v20180326.models.Config`
8183
8263
  # @param RequestId: 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
@@ -8201,23 +8281,27 @@ module TencentCloud
8201
8281
 
8202
8282
  # DescribeConfigSummary请求参数结构体
8203
8283
  class DescribeConfigSummaryRequest < TencentCloud::Common::AbstractModel
8204
- # @param ApplicationId: 应用ID,不传入时查询全量
8284
+ # @param ApplicationId: 应用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)创建新的应用。
8205
8285
  # @type ApplicationId: String
8206
- # @param SearchWord: 查询关键字,模糊查询:应用名称,配置项名称,不传入时查询全量
8286
+ # @param SearchWord: 查询关键字,模糊查询:应用名称,配置项名称,不传入时查询全量。
8207
8287
  # @type SearchWord: String
8208
- # @param Offset: 偏移量,默认为0
8288
+ # @param Offset: 偏移量,默认为0
8209
8289
  # @type Offset: Integer
8210
- # @param Limit: 每页条数,默认为20
8290
+ # @param Limit: 返回数量,默认为20,最大值为50。
8211
8291
  # @type Limit: Integer
8212
- # @param OrderBy: 按时间排序:creation_time;按名称排序:config_name
8292
+ # @param OrderBy: 排序字段。
8293
+ # - creation_time:按时间排序
8294
+ # - config_name:按名称排序
8213
8295
  # @type OrderBy: String
8214
- # @param OrderType: 升序传 0,降序传 1
8296
+ # @param OrderType: 排序顺序。
8297
+ # - 0:升序
8298
+ # - 1:降序
8215
8299
  # @type OrderType: Integer
8216
- # @param ConfigTagList:
8300
+ # @param ConfigTagList: TAG标签资源值。
8217
8301
  # @type ConfigTagList: Array
8218
- # @param DisableProgramAuthCheck:
8302
+ # @param DisableProgramAuthCheck: 忽略传参,业务预留字段。
8219
8303
  # @type DisableProgramAuthCheck: Boolean
8220
- # @param ConfigIdList:
8304
+ # @param ConfigIdList: 配置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)创建新的配置。
8221
8305
  # @type ConfigIdList: Array
8222
8306
 
8223
8307
  attr_accessor :ApplicationId, :SearchWord, :Offset, :Limit, :OrderBy, :OrderType, :ConfigTagList, :DisableProgramAuthCheck, :ConfigIdList
@@ -8249,7 +8333,7 @@ module TencentCloud
8249
8333
 
8250
8334
  # DescribeConfigSummary返回参数结构体
8251
8335
  class DescribeConfigSummaryResponse < TencentCloud::Common::AbstractModel
8252
- # @param Result: 配置项分页对象
8336
+ # @param Result: 配置项分页对象。
8253
8337
  # @type Result: :class:`Tencentcloud::Tsf.v20180326.models.TsfPageConfig`
8254
8338
  # @param RequestId: 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
8255
8339
  # @type RequestId: String
@@ -8272,7 +8356,7 @@ module TencentCloud
8272
8356
 
8273
8357
  # DescribeConfigTemplate请求参数结构体
8274
8358
  class DescribeConfigTemplateRequest < TencentCloud::Common::AbstractModel
8275
- # @param ConfigTemplateId: 配置模板Id
8359
+ # @param ConfigTemplateId: 配置模板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)创建新的配置模板。
8276
8360
  # @type ConfigTemplateId: String
8277
8361
 
8278
8362
  attr_accessor :ConfigTemplateId
@@ -8288,7 +8372,7 @@ module TencentCloud
8288
8372
 
8289
8373
  # DescribeConfigTemplate返回参数结构体
8290
8374
  class DescribeConfigTemplateResponse < TencentCloud::Common::AbstractModel
8291
- # @param Result: 导入结果
8375
+ # @param Result: 导入结果。
8292
8376
  # @type Result: :class:`Tencentcloud::Tsf.v20180326.models.ConfigTemplate`
8293
8377
  # @param RequestId: 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
8294
8378
  # @type RequestId: String
@@ -8311,19 +8395,19 @@ module TencentCloud
8311
8395
 
8312
8396
  # DescribeConfigs请求参数结构体
8313
8397
  class DescribeConfigsRequest < TencentCloud::Common::AbstractModel
8314
- # @param ApplicationId: 应用ID,不传入时查询全量
8398
+ # @param ApplicationId: 应用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)创建新的应用。
8315
8399
  # @type ApplicationId: String
8316
- # @param ConfigId: 配置项ID,不传入时查询全量,高优先级
8400
+ # @param ConfigId: 配置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)创建新的配置。
8317
8401
  # @type ConfigId: String
8318
- # @param Offset: 偏移量
8402
+ # @param Offset: 偏移量,默认为0。
8319
8403
  # @type Offset: Integer
8320
- # @param Limit: 每页条数
8404
+ # @param Limit: 返回数量,默认为20,最大值为100。
8321
8405
  # @type Limit: Integer
8322
- # @param ConfigIdList: 配置项ID列表,不传入时查询全量,低优先级
8406
+ # @param ConfigIdList: 配置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)创建新的配置。
8323
8407
  # @type ConfigIdList: Array
8324
- # @param ConfigName: 配置项名称,精确查询,不传入时查询全量
8408
+ # @param ConfigName: 配置项名称,精确查询,不传入时查询全量。
8325
8409
  # @type ConfigName: String
8326
- # @param ConfigVersion: 配置项版本,精确查询,不传入时查询全量
8410
+ # @param ConfigVersion: 配置项版本,精确查询,不传入时查询全量。
8327
8411
  # @type ConfigVersion: String
8328
8412
 
8329
8413
  attr_accessor :ApplicationId, :ConfigId, :Offset, :Limit, :ConfigIdList, :ConfigName, :ConfigVersion
@@ -8351,7 +8435,7 @@ module TencentCloud
8351
8435
 
8352
8436
  # DescribeConfigs返回参数结构体
8353
8437
  class DescribeConfigsResponse < TencentCloud::Common::AbstractModel
8354
- # @param Result: 分页后的配置项列表
8438
+ # @param Result: 分页后的配置项列表。
8355
8439
  # @type Result: :class:`Tencentcloud::Tsf.v20180326.models.TsfPageConfig`
8356
8440
  # @param RequestId: 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
8357
8441
  # @type RequestId: String
@@ -8374,19 +8458,19 @@ module TencentCloud
8374
8458
 
8375
8459
  # DescribeContainerEvents请求参数结构体
8376
8460
  class DescribeContainerEventsRequest < TencentCloud::Common::AbstractModel
8377
- # @param ResourceType: event 的资源类型, group 或者 instance
8461
+ # @param ResourceType: event 的资源类型, 仅支持 group
8378
8462
  # @type ResourceType: String
8379
- # @param ResourceId: event 的资源 id
8463
+ # @param ResourceId: 部署组ID,按照【部署组ID】进行过滤,可通过调用DescribeGroups查询已创建的项目列表或登录控制台进行查看;也可以调用CreateGroup创建新的项目。部署组ID例如:group-9yn2q8yd
8380
8464
  # @type ResourceId: String
8381
8465
  # @param Offset: 偏移量,取值从0开始
8382
8466
  # @type Offset: Integer
8383
8467
  # @param Limit: 分页个数,默认为20, 取值应为1~50
8384
8468
  # @type Limit: Integer
8385
- # @param GroupId: 当类型是 instance 时需要
8469
+ # @param GroupId: 部署组ID,按照【部署组ID】进行过滤,可通过调用DescribeGroups查询已创建的项目列表或登录控制台进行查看;也可以调用CreateGroup创建新的项目。部署组ID例如:group-9yn2q8yd。
8386
8470
  # @type GroupId: String
8387
- # @param Kind: event的资源kind
8471
+ # @param Kind: event的资源种类
8388
8472
  # @type Kind: String
8389
- # @param Type: event 的type
8473
+ # @param Type: event 的事件级别
8390
8474
  # @type Type: String
8391
8475
  # @param ResourceName: 资源名称
8392
8476
  # @type ResourceName: String
@@ -8484,7 +8568,7 @@ module TencentCloud
8484
8568
 
8485
8569
  # DescribeContainerGroupDeployInfo请求参数结构体
8486
8570
  class DescribeContainerGroupDeployInfoRequest < TencentCloud::Common::AbstractModel
8487
- # @param GroupId: 实例所属 groupId
8571
+ # @param GroupId: 部署组ID,按照【部署组ID】进行过滤,可通过调用DescribeGroups查询已创建的项目列表或登录控制台进行查看;也可以调用CreateGroup创建新的项目。部署组ID例如:group-ab958z6y
8488
8572
  # @type GroupId: String
8489
8573
 
8490
8574
  attr_accessor :GroupId
@@ -8629,9 +8713,9 @@ module TencentCloud
8629
8713
 
8630
8714
  # DescribeCreateGatewayApiStatus请求参数结构体
8631
8715
  class DescribeCreateGatewayApiStatusRequest < TencentCloud::Common::AbstractModel
8632
- # @param GroupId: 所属分组ID
8716
+ # @param GroupId: 网关分组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)创建新的网关分组。
8633
8717
  # @type GroupId: String
8634
- # @param MicroserviceId: 微服务ID
8718
+ # @param MicroserviceId: 微服务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)创建新的微服务。
8635
8719
  # @type MicroserviceId: String
8636
8720
 
8637
8721
  attr_accessor :GroupId, :MicroserviceId
@@ -8649,7 +8733,9 @@ module TencentCloud
8649
8733
 
8650
8734
  # DescribeCreateGatewayApiStatus返回参数结构体
8651
8735
  class DescribeCreateGatewayApiStatusResponse < TencentCloud::Common::AbstractModel
8652
- # @param Result: 是否已完成导入任务
8736
+ # @param Result: 导入任务状态执行结果。
8737
+ # - true:已完成
8738
+ # - false:未完成
8653
8739
  # @type Result: Boolean
8654
8740
  # @param RequestId: 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
8655
8741
  # @type RequestId: String
@@ -8669,7 +8755,8 @@ module TencentCloud
8669
8755
 
8670
8756
  # DescribeDeliveryConfigByGroupId请求参数结构体
8671
8757
  class DescribeDeliveryConfigByGroupIdRequest < TencentCloud::Common::AbstractModel
8672
- # @param GroupId: 部署组id
8758
+ # @param GroupId: 部署组ID
8759
+ # 可通过调用[DescribeContainerGroups](https://cloud.tencent.com/document/product/649/36068)或[DescribeGroups](https://cloud.tencent.com/document/product/649/36065)查询已创建的部署组列表或登录[控制台](https://console.cloud.tencent.com/tsf/app-detail?rid=1&id=application-yo7kp9dv&tab=publish&subTab=group)进行查看
8673
8760
  # @type GroupId: String
8674
8761
 
8675
8762
  attr_accessor :GroupId
@@ -8708,7 +8795,8 @@ module TencentCloud
8708
8795
 
8709
8796
  # DescribeDeliveryConfig请求参数结构体
8710
8797
  class DescribeDeliveryConfigRequest < TencentCloud::Common::AbstractModel
8711
- # @param ConfigId: 投递配置id
8798
+ # @param ConfigId: 日志配置项ID
8799
+ # 可通过调用[DescribeBusinessLogConfigs](https://cloud.tencent.com/document/product/649/75777)查询已创建的日志配置项列表或登录[控制台](https://console.cloud.tencent.com/tsf/observable/log?rid=1)进行查看
8712
8800
  # @type ConfigId: String
8713
8801
 
8714
8802
  attr_accessor :ConfigId
@@ -8753,9 +8841,11 @@ module TencentCloud
8753
8841
  # @type Offset: Integer
8754
8842
  # @param Limit: 搜索条数
8755
8843
  # @type Limit: Integer
8756
- # @param ProgramIdList: 数据集idList
8844
+ # @param ProgramIdList: 数据集ID列表
8845
+ # 可通过调用[DescribePrograms](https://cloud.tencent.com/document/product/649/73477)查询已创建的数据集列表或登录[控制台](https://console.cloud.tencent.com/tsf/privilege?rid=1&tab=program&roleId=role-a22gwdwa)进行查看
8757
8846
  # @type ProgramIdList: Array
8758
- # @param ConfigIdList: ConfigIdList
8847
+ # @param ConfigIdList: 日志配置项ID列表
8848
+ # 可通过调用[DescribeBusinessLogConfigs](https://cloud.tencent.com/document/product/649/75777)查询已创建的日志配置项列表或登录[控制台](https://console.cloud.tencent.com/tsf/observable/log?rid=1)进行查看
8759
8849
  # @type ConfigIdList: Array
8760
8850
 
8761
8851
  attr_accessor :SearchWord, :Offset, :Limit, :ProgramIdList, :ConfigIdList
@@ -8802,13 +8892,13 @@ module TencentCloud
8802
8892
 
8803
8893
  # DescribeDownloadInfo请求参数结构体
8804
8894
  class DescribeDownloadInfoRequest < TencentCloud::Common::AbstractModel
8805
- # @param ApplicationId: 应用ID
8895
+ # @param ApplicationId: 应用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)时的返回值
8806
8896
  # @type ApplicationId: String
8807
- # @param PkgId: 程序包ID
8897
+ # @param PkgId: 软件包ID可通过调用DescribeUploadInfo接口时[获取上传程序包信息](https://cloud.tencent.com/document/api/649/36078)返回的COS上传信息获取,登录[控制台](https://console.cloud.tencent.com/tsf/product?rid=1)进行查看
8808
8898
  # @type PkgId: String
8809
- # @param RepositoryId: 程序包仓库ID
8899
+ # @param RepositoryId: 仓库ID,可通过调用[仓库信息查询类](https://cloud.tencent.com/document/api/649/45925)接口时出参中的RepositoryId,或登录[控制台](https://console.cloud.tencent.com/tsf/product?rid=1)进行查看
8810
8900
  # @type RepositoryId: String
8811
- # @param RepositoryType: 程序包仓库类型
8901
+ # @param RepositoryType: 程序包仓库类型(允许值:"public-demo"TSF公共demo仓库, "private"自定义仓库, "default"TSF公共仓库)
8812
8902
  # @type RepositoryType: String
8813
8903
 
8814
8904
  attr_accessor :ApplicationId, :PkgId, :RepositoryId, :RepositoryType
@@ -8892,21 +8982,21 @@ module TencentCloud
8892
8982
 
8893
8983
  # DescribeFileConfigReleases请求参数结构体
8894
8984
  class DescribeFileConfigReleasesRequest < TencentCloud::Common::AbstractModel
8895
- # @param ConfigId: 配置项ID
8985
+ # @param ConfigId: 配置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)创建新的配置。
8896
8986
  # @type ConfigId: String
8897
- # @param ConfigName: 配置项名称
8987
+ # @param ConfigName: 配置项名称,最多支持60个字符,只能包含字母、数字及分隔符(“-”,“_”),且不能以分隔符开头或结尾。
8898
8988
  # @type ConfigName: String
8899
- # @param GroupId: 部署组ID
8989
+ # @param GroupId: 部署组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)创建新的部署组。
8900
8990
  # @type GroupId: String
8901
- # @param NamespaceId: 命名空间ID
8991
+ # @param NamespaceId: 命名空间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)创建新的命名空间。
8902
8992
  # @type NamespaceId: String
8903
- # @param ClusterId: 集群ID
8993
+ # @param ClusterId: 集群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)创建新的集群。
8904
8994
  # @type ClusterId: String
8905
- # @param ApplicationId: 应用ID
8995
+ # @param ApplicationId: 应用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)创建新的应用。
8906
8996
  # @type ApplicationId: String
8907
- # @param Offset: 偏移量
8997
+ # @param Offset: 偏移量,默认为0。
8908
8998
  # @type Offset: Integer
8909
- # @param Limit: 每页条数
8999
+ # @param Limit: 返回数量,默认为20,最大值为100。
8910
9000
  # @type Limit: Integer
8911
9001
 
8912
9002
  attr_accessor :ConfigId, :ConfigName, :GroupId, :NamespaceId, :ClusterId, :ApplicationId, :Offset, :Limit
@@ -8936,7 +9026,7 @@ module TencentCloud
8936
9026
 
8937
9027
  # DescribeFileConfigReleases返回参数结构体
8938
9028
  class DescribeFileConfigReleasesResponse < TencentCloud::Common::AbstractModel
8939
- # @param Result: 配置项发布信息列表
9029
+ # @param Result: 配置项发布信息列表。
8940
9030
  # @type Result: :class:`Tencentcloud::Tsf.v20180326.models.TsfPageFileConfigRelease`
8941
9031
  # @param RequestId: 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
8942
9032
  # @type RequestId: String
@@ -8959,19 +9049,19 @@ module TencentCloud
8959
9049
 
8960
9050
  # DescribeFileConfigs请求参数结构体
8961
9051
  class DescribeFileConfigsRequest < TencentCloud::Common::AbstractModel
8962
- # @param ConfigId: 配置项ID
9052
+ # @param ConfigId: 配置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)创建新的配置。
8963
9053
  # @type ConfigId: String
8964
- # @param ConfigIdList: 配置项ID列表
9054
+ # @param ConfigIdList: 配置项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)创建新的配置。
8965
9055
  # @type ConfigIdList: Array
8966
- # @param ConfigName: 配置项名称
9056
+ # @param ConfigName: 配置项名称。
8967
9057
  # @type ConfigName: String
8968
- # @param ApplicationId: 应用ID
9058
+ # @param ApplicationId: 应用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)创建新的应用。
8969
9059
  # @type ApplicationId: String
8970
- # @param Offset: 偏移量
9060
+ # @param Offset: 偏移量,默认为0。
8971
9061
  # @type Offset: Integer
8972
- # @param Limit: 每页条数
9062
+ # @param Limit: 返回数量,默认为20,最大值为100。
8973
9063
  # @type Limit: Integer
8974
- # @param ConfigVersion: 配置项版本
9064
+ # @param ConfigVersion: 配置项版本。
8975
9065
  # @type ConfigVersion: String
8976
9066
 
8977
9067
  attr_accessor :ConfigId, :ConfigIdList, :ConfigName, :ApplicationId, :Offset, :Limit, :ConfigVersion
@@ -8999,7 +9089,7 @@ module TencentCloud
8999
9089
 
9000
9090
  # DescribeFileConfigs返回参数结构体
9001
9091
  class DescribeFileConfigsResponse < TencentCloud::Common::AbstractModel
9002
- # @param Result: 文件配置项列表
9092
+ # @param Result: 文件配置项列表。
9003
9093
  # @type Result: :class:`Tencentcloud::Tsf.v20180326.models.TsfPageFileConfig`
9004
9094
  # @param RequestId: 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
9005
9095
  # @type RequestId: String
@@ -9022,7 +9112,7 @@ module TencentCloud
9022
9112
 
9023
9113
  # DescribeFlowLastBatchState请求参数结构体
9024
9114
  class DescribeFlowLastBatchStateRequest < TencentCloud::Common::AbstractModel
9025
- # @param FlowId: 工作流 ID
9115
+ # @param FlowId: 工作流 ID。前往[工作流管理](https://console.cloud.tencent.com/tsf/tct?rid=1&tab=workflowManage),在工作流列表第一列和工作流详情页查看工作流ID。
9026
9116
  # @type FlowId: String
9027
9117
 
9028
9118
  attr_accessor :FlowId
@@ -9202,7 +9292,7 @@ module TencentCloud
9202
9292
 
9203
9293
  # DescribeGroupAttribute请求参数结构体
9204
9294
  class DescribeGroupAttributeRequest < TencentCloud::Common::AbstractModel
9205
- # @param GroupId: 部署组ID字段
9295
+ # @param GroupId: 部署组ID,按照【部署组ID】进行过滤,可通过调用DescribeGroups查询已创建的项目列表或登录控制台进行查看;也可以调用CreateGroup创建新的项目。部署组ID例如:group-ab958z6y
9206
9296
  # @type GroupId: String
9207
9297
 
9208
9298
  attr_accessor :GroupId
@@ -9292,7 +9382,8 @@ module TencentCloud
9292
9382
 
9293
9383
  # DescribeGroupBusinessLogConfigs请求参数结构体
9294
9384
  class DescribeGroupBusinessLogConfigsRequest < TencentCloud::Common::AbstractModel
9295
- # @param GroupId: 分组ID
9385
+ # @param GroupId: 部署组ID
9386
+ # 可通过调用[DescribeContainerGroups](https://cloud.tencent.com/document/product/649/36068)或[DescribeGroups](https://cloud.tencent.com/document/product/649/36065)查询已创建的部署组列表或登录[控制台](https://console.cloud.tencent.com/tsf/app-detail?rid=1&id=application-yo7kp9dv&tab=publish&subTab=group)进行查看
9296
9387
  # @type GroupId: String
9297
9388
 
9298
9389
  attr_accessor :GroupId
@@ -9382,17 +9473,17 @@ module TencentCloud
9382
9473
 
9383
9474
  # DescribeGroupInstances请求参数结构体
9384
9475
  class DescribeGroupInstancesRequest < TencentCloud::Common::AbstractModel
9385
- # @param GroupId: 部署组ID
9476
+ # @param GroupId: 部署组ID,可通过调用[DescribeGroups](https://cloud.tencent.com/document/api/649/36065)查询已创建的部署组列表或登录控制台进行查看;也可以调用[CreateGroup](https://cloud.tencent.com/document/api/649/36074)创建新的部署组。
9386
9477
  # @type GroupId: String
9387
9478
  # @param SearchWord: 搜索字段
9388
9479
  # @type SearchWord: String
9389
9480
  # @param OrderBy: 排序字段
9390
9481
  # @type OrderBy: String
9391
- # @param OrderType: 排序类型
9482
+ # @param OrderType: 排序类型;0:升序,1:降序
9392
9483
  # @type OrderType: Integer
9393
- # @param Offset: 偏移量
9484
+ # @param Offset: 偏移量,默认值:0
9394
9485
  # @type Offset: Integer
9395
- # @param Limit: 分页个数
9486
+ # @param Limit: 分页个数;默认值:20
9396
9487
  # @type Limit: Integer
9397
9488
 
9398
9489
  attr_accessor :GroupId, :SearchWord, :OrderBy, :OrderType, :Offset, :Limit
@@ -9441,7 +9532,7 @@ module TencentCloud
9441
9532
 
9442
9533
  # DescribeGroupRelease请求参数结构体
9443
9534
  class DescribeGroupReleaseRequest < TencentCloud::Common::AbstractModel
9444
- # @param GroupId: 部署组ID
9535
+ # @param GroupId: 部署组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)创建新的部署组。
9445
9536
  # @type GroupId: String
9446
9537
 
9447
9538
  attr_accessor :GroupId
@@ -9457,7 +9548,7 @@ module TencentCloud
9457
9548
 
9458
9549
  # DescribeGroupRelease返回参数结构体
9459
9550
  class DescribeGroupReleaseResponse < TencentCloud::Common::AbstractModel
9460
- # @param Result: 部署组发布的相关信息
9551
+ # @param Result: 部署组发布的相关信息。
9461
9552
  # @type Result: :class:`Tencentcloud::Tsf.v20180326.models.GroupRelease`
9462
9553
  # @param RequestId: 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
9463
9554
  # @type RequestId: String
@@ -9480,7 +9571,7 @@ module TencentCloud
9480
9571
 
9481
9572
  # DescribeGroup请求参数结构体
9482
9573
  class DescribeGroupRequest < TencentCloud::Common::AbstractModel
9483
- # @param GroupId: 部署组ID
9574
+ # @param GroupId: 部署组ID,可通过调用[DescribeGroups](https://cloud.tencent.com/document/api/649/36065)查询已创建的部署组列表或登录控制台进行查看;也可以调用[CreateGroup](https://cloud.tencent.com/document/api/649/36074)创建新的部署组。
9484
9575
  # @type GroupId: String
9485
9576
 
9486
9577
  attr_accessor :GroupId
@@ -9576,19 +9667,19 @@ module TencentCloud
9576
9667
  class DescribeGroupsRequest < TencentCloud::Common::AbstractModel
9577
9668
  # @param SearchWord: 搜索字段
9578
9669
  # @type SearchWord: String
9579
- # @param ApplicationId: 应用ID
9670
+ # @param ApplicationId: 应用ID。调用[DescribeApplications](https://cloud.tencent.com/document/api/649/36090)查询已创建的应用或通过[CreateApplication](https://cloud.tencent.com/document/api/649/36094)接口创建新的应用。
9580
9671
  # @type ApplicationId: String
9581
9672
  # @param OrderBy: 排序字段
9582
9673
  # @type OrderBy: String
9583
- # @param OrderType: 排序方式
9674
+ # @param OrderType: 排序方式,0:升序,1:降序
9584
9675
  # @type OrderType: Integer
9585
- # @param Offset: 偏移量
9676
+ # @param Offset: 偏移量,默认值:0
9586
9677
  # @type Offset: Integer
9587
- # @param Limit: 分页个数
9678
+ # @param Limit: 分页个数,默认值:20
9588
9679
  # @type Limit: Integer
9589
- # @param NamespaceId: 命名空间ID
9680
+ # @param NamespaceId: 命名空间ID。调用[DescribeSimpleNamespaces](https://cloud.tencent.com/document/api/649/36096)查询已创建的命名空间或通过[CreateNamespace](https://cloud.tencent.com/document/api/649/36098)接口创建新的集群。
9590
9681
  # @type NamespaceId: String
9591
- # @param ClusterId: 集群ID
9682
+ # @param ClusterId: 集群 ID。调用[DescribeSimpleClusters](https://cloud.tencent.com/document/api/649/36047)查询已创建的集群或通过[CreateCluster](https://cloud.tencent.com/document/api/649/36049)接口创建新的集群。
9592
9683
  # @type ClusterId: String
9593
9684
  # @param GroupResourceTypeList: 部署组资源类型列表
9594
9685
  # @type GroupResourceTypeList: Array
@@ -9714,13 +9805,13 @@ module TencentCloud
9714
9805
  class DescribeImageRepositoryRequest < TencentCloud::Common::AbstractModel
9715
9806
  # @param SearchWord: 仓库名,搜索关键字,不带命名空间的
9716
9807
  # @type SearchWord: String
9717
- # @param Offset: 偏移量,取值从0开始
9808
+ # @param Offset: 偏移量,默认为0。关于Offset详见[API简介](https://cloud.tencent.com/document/api/213/568#.E8.BE.93.E5.85.A5.E5.8F.82.E6.95.B0.E4.B8.8E.E8.BF.94.E5.9B.9E.E5.8F.82.E6.95.B0.E9.87.8A.E4.B9.89)
9718
9809
  # @type Offset: Integer
9719
- # @param Limit: 分页个数,默认为20, 取值应为1~100
9810
+ # @param Limit: 数量限制,默认为20,最大值为100。关于Limit详见[API简介](https://cloud.tencent.com/document/api/213/568#.E8.BE.93.E5.85.A5.E5.8F.82.E6.95.B0.E4.B8.8E.E8.BF.94.E5.9B.9E.E5.8F.82.E6.95.B0.E9.87.8A.E4.B9.89)
9720
9811
  # @type Limit: Integer
9721
9812
  # @param RepoType: 企业: tcr ;个人: personal或者不填
9722
9813
  # @type RepoType: String
9723
- # @param ApplicationId: 应用id
9814
+ # @param ApplicationId: 应用ID,可通过调用[DescribeApplications](https://cloud.tencent.com/document/api/649/36090)查询已创建的应用列表或登录控制台进行查看;也可以调用[CreateApplication](https://cloud.tencent.com/document/api/649/36094)创建新的应用。
9724
9815
  # @type ApplicationId: String
9725
9816
  # @param TcrRepoInfo: TcrRepoInfo值
9726
9817
  # @type TcrRepoInfo: :class:`Tencentcloud::Tsf.v20180326.models.TcrRepoInfo`
@@ -9778,11 +9869,11 @@ module TencentCloud
9778
9869
 
9779
9870
  # DescribeImageTags请求参数结构体
9780
9871
  class DescribeImageTagsRequest < TencentCloud::Common::AbstractModel
9781
- # @param ApplicationId: 应用Id
9872
+ # @param ApplicationId: 应用ID,可通过调用[DescribeApplications](https://cloud.tencent.com/document/api/649/36090)查询已创建的应用列表或登录控制台进行查看;也可以调用[CreateApplication](https://cloud.tencent.com/document/api/649/36094)创建新的应用。
9782
9873
  # @type ApplicationId: String
9783
- # @param Offset: 偏移量,取值从0开始
9874
+ # @param Offset: 偏移量,默认为0。关于Offset详见[API简介](https://cloud.tencent.com/document/api/213/568#.E8.BE.93.E5.85.A5.E5.8F.82.E6.95.B0.E4.B8.8E.E8.BF.94.E5.9B.9E.E5.8F.82.E6.95.B0.E9.87.8A.E4.B9.89)
9784
9875
  # @type Offset: Integer
9785
- # @param Limit: 分页个数,默认为20, 取值应为1~100
9876
+ # @param Limit: 数量限制,默认为20,最大值为100。关于Limit详见[API简介](https://cloud.tencent.com/document/api/213/568#.E8.BE.93.E5.85.A5.E5.8F.82.E6.95.B0.E4.B8.8E.E8.BF.94.E5.9B.9E.E5.8F.82.E6.95.B0.E9.87.8A.E4.B9.89)
9786
9877
  # @type Limit: Integer
9787
9878
  # @param QueryImageIdFlag: 不填和0:查询 1:不查询
9788
9879
  # @type QueryImageIdFlag: Integer
@@ -9932,7 +10023,7 @@ module TencentCloud
9932
10023
 
9933
10024
  # DescribeInstances请求参数结构体
9934
10025
  class DescribeInstancesRequest < TencentCloud::Common::AbstractModel
9935
- # @param Filters: 过滤条件
10026
+ # @param Filters: 过滤条件,name表示过滤字段,value表示过滤字段值。
9936
10027
  # @type Filters: Array
9937
10028
  # @param Offset: 偏移量,默认为0
9938
10029
  # @type Offset: Integer
@@ -9986,17 +10077,17 @@ module TencentCloud
9986
10077
 
9987
10078
  # DescribeInvocationMetricDataCurve请求参数结构体
9988
10079
  class DescribeInvocationMetricDataCurveRequest < TencentCloud::Common::AbstractModel
9989
- # @param StartTime: 查询开始时间
10080
+ # @param StartTime: 开始时间,格式yyyy-MM-dd HH:mm:ss
9990
10081
  # @type StartTime: String
9991
- # @param EndTime: 查询结束时间
10082
+ # @param EndTime: 结束时间,格式yyyy-MM-dd HH:mm:ss
9992
10083
  # @type EndTime: String
9993
- # @param Period: 查询时间粒度,单位秒可选值:60、3600、86400
10084
+ # @param Period: 查询时间粒度,单位秒。可选值:60、3600、86400
9994
10085
  # @type Period: Integer
9995
- # @param MetricDimensions: 查询指标维度,不能为空,支持 ServiceName, OperationName, PeerServiceName, PeerOperationName
10086
+ # @param MetricDimensions: 查询指标维度,不能为空
9996
10087
  # @type MetricDimensions: Array
9997
- # @param Metrics: 查询指标名,不能为空.
10088
+ # @param Metrics: 查询指标名,不能为空
9998
10089
  # @type Metrics: Array
9999
- # @param Kind: 视图视角。可选值:SERVER, CLIENT。默认为SERVER
10090
+ # @param Kind: 视图视角。可选值:SERVER:服务端,CLIENT:客户端。默认为SERVER
10000
10091
  # @type Kind: String
10001
10092
  # @param Type: 类型。组件监控使用,可选值:SQL 或者 NoSQL
10002
10093
  # @type Type: String
@@ -10067,19 +10158,19 @@ module TencentCloud
10067
10158
 
10068
10159
  # DescribeInvocationMetricDataDimension请求参数结构体
10069
10160
  class DescribeInvocationMetricDataDimensionRequest < TencentCloud::Common::AbstractModel
10070
- # @param StartTime: 开始时间
10161
+ # @param StartTime: 开始时间,格式yyyy-MM-dd HH:mm:ss
10071
10162
  # @type StartTime: String
10072
- # @param EndTime: 结束时间
10163
+ # @param EndTime: 结束时间,格式yyyy-MM-dd HH:mm:ss
10073
10164
  # @type EndTime: String
10074
10165
  # @param Offset: 开始index
10075
10166
  # @type Offset: Integer
10076
10167
  # @param Limit: 分页大小
10077
10168
  # @type Limit: Integer
10078
- # @param DimensionName: 聚合维度
10169
+ # @param DimensionName: 聚合维度。可选值 NamespaceId:命名空间ID,GroupId:部署组ID,InstanceId:实例ID,ApplicationId:应用ID,OperationMethod:执行方法,OperationName:执行名称,ServiceName:服务名,UpstreamNamespaceId:上游命名空间ID
10079
10170
  # @type DimensionName: String
10080
10171
  # @param SearchWord: 搜索关键字
10081
10172
  # @type SearchWord: String
10082
- # @param MetricDimensionValues: 维度
10173
+ # @param MetricDimensionValues: 构建维度
10083
10174
  # @type MetricDimensionValues: Array
10084
10175
 
10085
10176
  attr_accessor :StartTime, :EndTime, :Offset, :Limit, :DimensionName, :SearchWord, :MetricDimensionValues
@@ -10137,15 +10228,15 @@ module TencentCloud
10137
10228
 
10138
10229
  # DescribeInvocationMetricDataPoint请求参数结构体
10139
10230
  class DescribeInvocationMetricDataPointRequest < TencentCloud::Common::AbstractModel
10140
- # @param StartTime: 开始时间
10231
+ # @param StartTime: 开始时间,格式yyyy-MM-dd HH:mm:ss
10141
10232
  # @type StartTime: String
10142
- # @param EndTime: 结束时间
10233
+ # @param EndTime: 结束时间,格式yyyy-MM-dd HH:mm:ss
10143
10234
  # @type EndTime: String
10144
- # @param MetricDimensionValues: 维度,并且 维度 key value 不能为空
10235
+ # @param MetricDimensionValues: 查询指标维度, 不能为空
10145
10236
  # @type MetricDimensionValues: Array
10146
- # @param Metrics: 指标,并且 key, value 不能为空
10237
+ # @param Metrics: 指标,不能为空
10147
10238
  # @type Metrics: Array
10148
- # @param Kind: 调用视角。可选值:SERVER, CLIENT。默认为SERVER
10239
+ # @param Kind: 视图视角。可选值:SERVER:服务端, CLIENT:客户端。默认为SERVER
10149
10240
  # @type Kind: String
10150
10241
 
10151
10242
  attr_accessor :StartTime, :EndTime, :MetricDimensionValues, :Metrics, :Kind
@@ -10210,17 +10301,17 @@ module TencentCloud
10210
10301
 
10211
10302
  # DescribeInvocationMetricScatterPlot请求参数结构体
10212
10303
  class DescribeInvocationMetricScatterPlotRequest < TencentCloud::Common::AbstractModel
10213
- # @param StartTime: 查询开始时间
10304
+ # @param StartTime: 查询开始时间,格式yyyy-MM-dd HH:mm:ss
10214
10305
  # @type StartTime: String
10215
- # @param EndTime: 查询结束时间
10306
+ # @param EndTime: 查询结束时间,格式yyyy-MM-dd HH:mm:ss
10216
10307
  # @type EndTime: String
10217
- # @param Period: 查询时间粒度,单位秒。可选值:60、3600、86400
10308
+ # @param Period: 查询时间粒度,单位秒。可选值:60、3600、86400
10218
10309
  # @type Period: Integer
10219
- # @param MetricDimensions: 查询指标维度, 不能为空。可选 NamespaceId, GroupId, InstanceId, OperationName, ServiceName, PeerServiceName, PeerOperationName
10310
+ # @param MetricDimensions: 查询指标维度, 不能为空。Name, Valeu键值对形式。Name可选值 NamespaceId:命名空间ID,GroupId:部署组ID,InstanceId:实例ID,ApplicationId:应用ID,OperationMethod:执行方法,OperationName:执行名称,ServiceName:服务名,UpstreamNamespaceId:上游命名空间ID
10220
10311
  # @type MetricDimensions: Array
10221
- # @param Metrics: 查询指标名, 不能为空。仅支持 range_count_duratioin 为 key 下的 sum 方法
10312
+ # @param Metrics: 查询指标名, 不能为空。仅支持 range_count_duration(响应耗时分布) 为 key 下的 sum(求和) 方法
10222
10313
  # @type Metrics: Array
10223
- # @param Kind: 视图视角。可选值:SERVER, CLIENT。默认为SERVER
10314
+ # @param Kind: 视图视角。可选值:SERVER:服务端, CLIENT:客户端。默认为SERVER
10224
10315
  # @type Kind: String
10225
10316
 
10226
10317
  attr_accessor :StartTime, :EndTime, :Period, :MetricDimensions, :Metrics, :Kind
@@ -10284,9 +10375,11 @@ module TencentCloud
10284
10375
 
10285
10376
  # DescribeJvmMonitor请求参数结构体
10286
10377
  class DescribeJvmMonitorRequest < TencentCloud::Common::AbstractModel
10287
- # @param InstanceId: 查询的实例Id
10378
+ # @param InstanceId: 查询的实例ID
10379
+ # 可通过调用[DescribeClusterInstances](https://cloud.tencent.com/document/product/649/36048)查询已导入的实例列表或登录[控制台](https://console.cloud.tencent.com/tsf/resource?rid=1&tab=instance)进行查询。实例ID例如:ins-6decplwk
10288
10380
  # @type InstanceId: String
10289
- # @param ApplicationId: 实例所属应用Id
10381
+ # @param ApplicationId: 实例所属应用ID
10382
+ # 可通过调用[DescribeApplications](https://cloud.tencent.com/document/product/649/36090)查询已经存在的应用列表或登录[控制台](https://console.cloud.tencent.com/tsf/app?rid=1)查看。应用ID例如:application-v378ewna
10290
10383
  # @type ApplicationId: String
10291
10384
  # @param TimeGranularity: 时间粒度,单位:秒
10292
10385
  # @type TimeGranularity: Integer
@@ -10294,7 +10387,8 @@ module TencentCloud
10294
10387
  # @type From: String
10295
10388
  # @param To: 查询数据结束时间格式(yyyy-MM-dd HH:mm:ss)
10296
10389
  # @type To: String
10297
- # @param RequiredPictures: 查询的监控图列表,以返回值属性名作为入参
10390
+ # @param RequiredPictures: 查询的监控图列表,以返回值属性名作为入参,可选值:
10391
+ # heapMemory:堆内存监控图;nonHeapMemory:非堆内存监控图;edenSpace:伊甸区监控图;survivorSpace:幸存者区监控图;oldSpace:老年代监控图;metaSpace:元空间监控图;youngGC:youngGC增量监控图;fullGC:fullGC增量监控图;cpuUsage:cpu使用率监控图;classCount:加载类数监控图;threadPicture:线程图
10298
10392
  # @type RequiredPictures: Array
10299
10393
  # @param Tag: 扩展字段
10300
10394
  # @type Tag: String
@@ -10347,15 +10441,15 @@ module TencentCloud
10347
10441
 
10348
10442
  # DescribeLaneRules请求参数结构体
10349
10443
  class DescribeLaneRulesRequest < TencentCloud::Common::AbstractModel
10350
- # @param Limit: 每页展示的条数
10444
+ # @param Limit: 返回数量,默认为20,最大值为500。
10351
10445
  # @type Limit: Integer
10352
- # @param Offset: 翻页偏移量
10446
+ # @param Offset: 偏移量,默认为0。
10353
10447
  # @type Offset: Integer
10354
- # @param SearchWord: 搜索关键词
10448
+ # @param SearchWord: 搜索关键词。
10355
10449
  # @type SearchWord: String
10356
- # @param RuleId: 泳道规则ID(用于精确搜索)
10450
+ # @param RuleId: 灰度发布规则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)创建新的灰度发布规则。
10357
10451
  # @type RuleId: String
10358
- # @param RuleIdList:
10452
+ # @param RuleIdList: 灰度发布规则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)创建新的灰度发布规则。
10359
10453
  # @type RuleIdList: Array
10360
10454
 
10361
10455
  attr_accessor :Limit, :Offset, :SearchWord, :RuleId, :RuleIdList
@@ -10379,7 +10473,7 @@ module TencentCloud
10379
10473
 
10380
10474
  # DescribeLaneRules返回参数结构体
10381
10475
  class DescribeLaneRulesResponse < TencentCloud::Common::AbstractModel
10382
- # @param Result: 泳道规则列表
10476
+ # @param Result: 灰度发布规则列表。
10383
10477
  # @type Result: :class:`Tencentcloud::Tsf.v20180326.models.LaneRules`
10384
10478
  # @param RequestId: 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
10385
10479
  # @type RequestId: String
@@ -10402,15 +10496,15 @@ module TencentCloud
10402
10496
 
10403
10497
  # DescribeLanes请求参数结构体
10404
10498
  class DescribeLanesRequest < TencentCloud::Common::AbstractModel
10405
- # @param Limit: 每页展示的条数
10499
+ # @param Limit: 返回数量,默认为20,最大值为100。
10406
10500
  # @type Limit: Integer
10407
- # @param Offset: 翻页偏移量
10501
+ # @param Offset: 偏移量,默认为0。
10408
10502
  # @type Offset: Integer
10409
- # @param SearchWord: 搜索关键字
10503
+ # @param SearchWord: 搜索关键字。
10410
10504
  # @type SearchWord: String
10411
- # @param LaneIdList:
10505
+ # @param LaneIdList: 泳道配置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)创建新的泳道配置。
10412
10506
  # @type LaneIdList: Array
10413
- # @param DisableProgramAuthCheck:
10507
+ # @param DisableProgramAuthCheck: 忽略传参,业务预留字段。
10414
10508
  # @type DisableProgramAuthCheck: Boolean
10415
10509
 
10416
10510
  attr_accessor :Limit, :Offset, :SearchWord, :LaneIdList, :DisableProgramAuthCheck
@@ -10434,7 +10528,7 @@ module TencentCloud
10434
10528
 
10435
10529
  # DescribeLanes返回参数结构体
10436
10530
  class DescribeLanesResponse < TencentCloud::Common::AbstractModel
10437
- # @param Result: 泳道列表
10531
+ # @param Result: 泳道配置列表。
10438
10532
  # @type Result: :class:`Tencentcloud::Tsf.v20180326.models.LaneInfos`
10439
10533
  # @param RequestId: 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
10440
10534
  # @type RequestId: String
@@ -10536,15 +10630,21 @@ module TencentCloud
10536
10630
 
10537
10631
  # DescribeMicroservice请求参数结构体
10538
10632
  class DescribeMicroserviceRequest < TencentCloud::Common::AbstractModel
10539
- # @param MicroserviceId: 微服务ID
10633
+ # @param MicroserviceId: 微服务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)创建新的微服务。
10540
10634
  # @type MicroserviceId: String
10541
- # @param Offset: 偏移量
10635
+ # @param Offset: 偏移量,默认为0。
10542
10636
  # @type Offset: Integer
10543
- # @param Limit: 分页个数
10637
+ # @param Limit: 返回数量,默认为20,最大值为50。
10544
10638
  # @type Limit: Integer
10545
- # @param GroupIds: 可选,根据部署组ID进行过滤
10639
+ # @param GroupIds: 部署组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)创建新的部署组。
10546
10640
  # @type GroupIds: Array
10547
- # @param Filters: 过滤条件。多个 filter 之间是与关系,单个 filter 多个 value 之间是或关系。filter name 取值有:id(实例id)、name(实例名)、lan-ip(内网ip)、node-ip(所在节点ip)
10641
+ # @param Filters: 过滤条件。多个 filter 之间是与关系,单个 filter 多个 value 之间是或关系。
10642
+ # 参考:[{"Name":"LanIp","Values":["172.16.16.139"]}]
10643
+ # filter name 取值范围:
10644
+ # - id:实例ID
10645
+ # - name:实例名
10646
+ # - lan-ip:内网IP
10647
+ # - node-ip:所在节点IP
10548
10648
  # @type Filters: Array
10549
10649
 
10550
10650
  attr_accessor :MicroserviceId, :Offset, :Limit, :GroupIds, :Filters
@@ -10575,7 +10675,7 @@ module TencentCloud
10575
10675
 
10576
10676
  # DescribeMicroservice返回参数结构体
10577
10677
  class DescribeMicroserviceResponse < TencentCloud::Common::AbstractModel
10578
- # @param Result: 微服务详情实例列表
10678
+ # @param Result: 微服务详情实例列表。
10579
10679
  # @type Result: :class:`Tencentcloud::Tsf.v20180326.models.TsfPageMsInstance`
10580
10680
  # @param RequestId: 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
10581
10681
  # @type RequestId: String
@@ -10598,7 +10698,7 @@ module TencentCloud
10598
10698
 
10599
10699
  # DescribeMicroservicesByGroupIds请求参数结构体
10600
10700
  class DescribeMicroservicesByGroupIdsRequest < TencentCloud::Common::AbstractModel
10601
- # @param GroupIds: 部署组ID列表
10701
+ # @param GroupIds: 部署组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)创建新的部署组。
10602
10702
  # @type GroupIds: Array
10603
10703
 
10604
10704
  attr_accessor :GroupIds
@@ -10614,7 +10714,7 @@ module TencentCloud
10614
10714
 
10615
10715
  # DescribeMicroservicesByGroupIds返回参数结构体
10616
10716
  class DescribeMicroservicesByGroupIdsResponse < TencentCloud::Common::AbstractModel
10617
- # @param Result: 微服务信息分页列表
10717
+ # @param Result: 微服务信息分页列表。
10618
10718
  # @type Result: :class:`Tencentcloud::Tsf.v20180326.models.TsfPageMicroservice`
10619
10719
  # @param RequestId: 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
10620
10720
  # @type RequestId: String
@@ -10637,25 +10737,32 @@ module TencentCloud
10637
10737
 
10638
10738
  # DescribeMicroservices请求参数结构体
10639
10739
  class DescribeMicroservicesRequest < TencentCloud::Common::AbstractModel
10640
- # @param NamespaceId: 命名空间ID
10740
+ # @param NamespaceId: 命名空间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)创建新的命名空间。
10641
10741
  # @type NamespaceId: String
10642
- # @param SearchWord: 搜索字段
10742
+ # @param SearchWord: 搜索字段。
10643
10743
  # @type SearchWord: String
10644
- # @param OrderBy: 排序字段
10744
+ # @param OrderBy: 排序字段。
10745
+ # - create_time:创建时间
10746
+ # 默认为创建时间,暂不支持其他值。
10645
10747
  # @type OrderBy: String
10646
- # @param OrderType: 排序类型
10748
+ # @param OrderType: 排序类型。
10749
+ # - 1:倒序
10750
+ # 默认为倒序,暂不支持其他值。
10647
10751
  # @type OrderType: Integer
10648
- # @param Offset: 偏移量
10752
+ # @param Offset: 偏移量,默认为0。
10649
10753
  # @type Offset: Integer
10650
- # @param Limit: 分页个数
10754
+ # @param Limit: 返回数量,默认为20,最大值为50。
10651
10755
  # @type Limit: Integer
10652
- # @param Status: 状态过滤,online、offline、single_online
10756
+ # @param Status: 状态。
10757
+ # - online:在线
10758
+ # - offline:离线
10759
+ # - single_online:单点在线
10653
10760
  # @type Status: Array
10654
- # @param MicroserviceIdList: IdList
10761
+ # @param MicroserviceIdList: 微服务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)创建新的微服务。
10655
10762
  # @type MicroserviceIdList: Array
10656
- # @param MicroserviceNameList: 搜索的服务名列表
10763
+ # @param MicroserviceNameList: 微服务名称列表。该参数可以通过调用 [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)创建新的微服务。
10657
10764
  # @type MicroserviceNameList: Array
10658
- # @param ConfigCenterInstanceId: 注册中心实例id
10765
+ # @param ConfigCenterInstanceId: 注册中心实例ID。业务预留参数,忽略传参。
10659
10766
  # @type ConfigCenterInstanceId: String
10660
10767
 
10661
10768
  attr_accessor :NamespaceId, :SearchWord, :OrderBy, :OrderType, :Offset, :Limit, :Status, :MicroserviceIdList, :MicroserviceNameList, :ConfigCenterInstanceId
@@ -10689,7 +10796,7 @@ module TencentCloud
10689
10796
 
10690
10797
  # DescribeMicroservices返回参数结构体
10691
10798
  class DescribeMicroservicesResponse < TencentCloud::Common::AbstractModel
10692
- # @param Result: 微服务分页列表信息
10799
+ # @param Result: 微服务分页列表信息。
10693
10800
  # @type Result: :class:`Tencentcloud::Tsf.v20180326.models.TsfPageMicroservice`
10694
10801
  # @param RequestId: 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
10695
10802
  # @type RequestId: String
@@ -10712,13 +10819,13 @@ module TencentCloud
10712
10819
 
10713
10820
  # DescribeMsApiList请求参数结构体
10714
10821
  class DescribeMsApiListRequest < TencentCloud::Common::AbstractModel
10715
- # @param MicroserviceId: 微服务ID
10822
+ # @param MicroserviceId: 微服务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)创建新的微服务。
10716
10823
  # @type MicroserviceId: String
10717
- # @param SearchWord: 搜索关键字
10824
+ # @param SearchWord: 搜索关键字。
10718
10825
  # @type SearchWord: String
10719
- # @param Limit: 每页的数量
10826
+ # @param Limit: 返回数量,默认为20,最大值为50。
10720
10827
  # @type Limit: Integer
10721
- # @param Offset: 翻页偏移量
10828
+ # @param Offset: 偏移量,默认为0。
10722
10829
  # @type Offset: Integer
10723
10830
 
10724
10831
  attr_accessor :MicroserviceId, :SearchWord, :Limit, :Offset
@@ -10740,7 +10847,7 @@ module TencentCloud
10740
10847
 
10741
10848
  # DescribeMsApiList返回参数结构体
10742
10849
  class DescribeMsApiListResponse < TencentCloud::Common::AbstractModel
10743
- # @param Result: 相应结果
10850
+ # @param Result: 微服务API列表。
10744
10851
  # @type Result: :class:`Tencentcloud::Tsf.v20180326.models.TsfApiListResponse`
10745
10852
  # @param RequestId: 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
10746
10853
  # @type RequestId: String
@@ -10764,14 +10871,15 @@ module TencentCloud
10764
10871
  # DescribeOverviewInvocation请求参数结构体
10765
10872
  class DescribeOverviewInvocationRequest < TencentCloud::Common::AbstractModel
10766
10873
  # @param NamespaceId: 命名空间ID, 此参数必填
10874
+ # 可通过[DescribeSimpleNamespaces](https://cloud.tencent.com/document/product/649/36096)查询已经创建的命名空间,也可以通过登录[控制台](https://console.cloud.tencent.com/tsf/resource?rid=1&tab=namespace)查看
10767
10875
  # @type NamespaceId: String
10768
- # @param Type: 监控统计类型,必填,可选值:SumReqAmountAvgFailureRateAvgTimeCost,分别对应请求量、请求错误率、平均响应耗时
10876
+ # @param Type: 监控统计类型,必填,取值范围 SumReqAmount:请求量,AvgFailureRate:请求错误率,AvgTimeCost:平均响应耗时
10769
10877
  # @type Type: String
10770
10878
  # @param Period: 监控统计数据粒度,可选值:60、3600、86400,分别对应1分钟、1小时、1天
10771
10879
  # @type Period: Integer
10772
- # @param StartTime: 查询开始时间,默认为当天的 00:00:00
10880
+ # @param StartTime: 查询开始时间,格式为yyyy-MM-dd HH:mm:ss,默认为当天的 00:00:00
10773
10881
  # @type StartTime: String
10774
- # @param EndTime: 查询结束时间,默认为当前时间
10882
+ # @param EndTime: 查询结束时间,格式为yyyy-MM-dd HH:mm:ss,默认为当前时间
10775
10883
  # @type EndTime: String
10776
10884
 
10777
10885
  attr_accessor :NamespaceId, :Type, :Period, :StartTime, :EndTime
@@ -10912,21 +11020,21 @@ module TencentCloud
10912
11020
 
10913
11021
  # DescribePkgs请求参数结构体
10914
11022
  class DescribePkgsRequest < TencentCloud::Common::AbstractModel
10915
- # @param ApplicationId: 应用ID(只传入应用ID,返回该应用下所有软件包信息)
11023
+ # @param ApplicationId: 应用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)时的返回值
10916
11024
  # @type ApplicationId: String
10917
11025
  # @param SearchWord: 查询关键字(支持根据包ID,包名,包版本号搜索)
10918
11026
  # @type SearchWord: String
10919
- # @param OrderBy: 排序关键字(默认为"UploadTime":上传时间)
11027
+ # @param OrderBy: 排序关键字(默认值"UploadTime"),允许值:"UploadTime"上传时间, "name"程序包名, "size"应用大小, "id"程序包ID
10920
11028
  # @type OrderBy: String
10921
11029
  # @param OrderType: 升序:0/降序:1(默认降序)
10922
11030
  # @type OrderType: Integer
10923
- # @param Offset: 查询起始偏移
11031
+ # @param Offset: 查询起始偏移,大于等于0,默认值为0
10924
11032
  # @type Offset: Integer
10925
11033
  # @param Limit: 返回数量限制
10926
11034
  # @type Limit: Integer
10927
- # @param RepositoryType: 程序包仓库类型
11035
+ # @param RepositoryType: 程序包仓库类型,允许值:"public-demo"TSF公共demo仓库, "private"自定义仓库, "default"TSF公共仓库
10928
11036
  # @type RepositoryType: String
10929
- # @param RepositoryId: 程序包仓库id
11037
+ # @param RepositoryId: 仓库ID,可通过调用[仓库信息查询类](https://cloud.tencent.com/document/api/649/45925)接口时出参中的RepositoryId,或登录[控制台](https://console.cloud.tencent.com/tsf/product?rid=1)进行查看
10930
11038
  # @type RepositoryId: String
10931
11039
  # @param PackageTypeList: 程序包类型数组支持(fatjar jar war tar.gz zip)
10932
11040
  # @type PackageTypeList: Array
@@ -11042,17 +11150,17 @@ module TencentCloud
11042
11150
 
11043
11151
  # DescribePodInstances请求参数结构体
11044
11152
  class DescribePodInstancesRequest < TencentCloud::Common::AbstractModel
11045
- # @param GroupId: 实例所属groupId
11153
+ # @param GroupId: 实例所属部署组ID,按照【部署组ID】进行过滤,可通过调用DescribeGroups查询已创建的项目列表或登录控制台进行查看;也可以调用CreateGroup创建新的项目。部署组ID例如:group-9yn2q8yd。部署组所在集群必须是活跃状态的。
11046
11154
  # @type GroupId: String
11047
11155
  # @param Offset: 偏移量,取值从0开始
11048
11156
  # @type Offset: Integer
11049
11157
  # @param Limit: 分页个数,默认为20, 取值应为1~50
11050
11158
  # @type Limit: Integer
11051
- # @param PodNameList: 过滤字段
11159
+ # @param PodNameList: 用于通过PodName字段过滤返回结果。
11052
11160
  # @type PodNameList: Array
11053
- # @param DeployVersion: 新老版本pod批次标识
11161
+ # @param DeployVersion: 新老版本pod批次标识,old表示老版本,new表示新版本。
11054
11162
  # @type DeployVersion: String
11055
- # @param TaskId: 任务ID
11163
+ # @param TaskId: 实例所属任务ID,登录控制台进行查看。
11056
11164
  # @type TaskId: String
11057
11165
 
11058
11166
  attr_accessor :GroupId, :Offset, :Limit, :PodNameList, :DeployVersion, :TaskId
@@ -11148,11 +11256,11 @@ module TencentCloud
11148
11256
 
11149
11257
  # DescribePublicConfigReleaseLogs请求参数结构体
11150
11258
  class DescribePublicConfigReleaseLogsRequest < TencentCloud::Common::AbstractModel
11151
- # @param NamespaceId: 命名空间ID,不传入时查询全量
11259
+ # @param NamespaceId: 命名空间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)创建新的命名空间。
11152
11260
  # @type NamespaceId: String
11153
- # @param Offset: 偏移量,默认为0
11261
+ # @param Offset: 偏移量,默认为0
11154
11262
  # @type Offset: Integer
11155
- # @param Limit: 每页条数,默认为20
11263
+ # @param Limit: 返回数量,默认为20,最大值为100。
11156
11264
  # @type Limit: Integer
11157
11265
 
11158
11266
  attr_accessor :NamespaceId, :Offset, :Limit
@@ -11172,7 +11280,7 @@ module TencentCloud
11172
11280
 
11173
11281
  # DescribePublicConfigReleaseLogs返回参数结构体
11174
11282
  class DescribePublicConfigReleaseLogsResponse < TencentCloud::Common::AbstractModel
11175
- # @param Result: 分页后的公共配置项发布历史列表
11283
+ # @param Result: 分页后的公共配置项发布历史列表。
11176
11284
  # @type Result: :class:`Tencentcloud::Tsf.v20180326.models.TsfPageConfigReleaseLog`
11177
11285
  # @param RequestId: 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
11178
11286
  # @type RequestId: String
@@ -11195,15 +11303,15 @@ module TencentCloud
11195
11303
 
11196
11304
  # DescribePublicConfigReleases请求参数结构体
11197
11305
  class DescribePublicConfigReleasesRequest < TencentCloud::Common::AbstractModel
11198
- # @param ConfigName: 配置项名称,不传入时查询全量
11306
+ # @param ConfigName: 配置名称,不传入时查询全量。该参数可以通过调用 [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)创建新的配置。
11199
11307
  # @type ConfigName: String
11200
- # @param NamespaceId: 命名空间ID,不传入时查询全量
11308
+ # @param NamespaceId: 命名空间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)创建新的命名空间。
11201
11309
  # @type NamespaceId: String
11202
- # @param Limit: 每页条数
11310
+ # @param Limit: 返回数量,默认为20,最大值为100。
11203
11311
  # @type Limit: Integer
11204
- # @param Offset: 偏移量
11312
+ # @param Offset: 偏移量,默认为0。
11205
11313
  # @type Offset: Integer
11206
- # @param ConfigId: 配置项ID,不传入时查询全量
11314
+ # @param ConfigId: 配置项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)创建新的配置。
11207
11315
  # @type ConfigId: String
11208
11316
 
11209
11317
  attr_accessor :ConfigName, :NamespaceId, :Limit, :Offset, :ConfigId
@@ -11227,7 +11335,7 @@ module TencentCloud
11227
11335
 
11228
11336
  # DescribePublicConfigReleases返回参数结构体
11229
11337
  class DescribePublicConfigReleasesResponse < TencentCloud::Common::AbstractModel
11230
- # @param Result: 公共配置发布信息
11338
+ # @param Result: 公共配置发布信息。
11231
11339
  # @type Result: :class:`Tencentcloud::Tsf.v20180326.models.TsfPageConfigRelease`
11232
11340
  # @param RequestId: 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
11233
11341
  # @type RequestId: String
@@ -11250,7 +11358,7 @@ module TencentCloud
11250
11358
 
11251
11359
  # DescribePublicConfig请求参数结构体
11252
11360
  class DescribePublicConfigRequest < TencentCloud::Common::AbstractModel
11253
- # @param ConfigId: 需要查询的配置项ID
11361
+ # @param ConfigId: 需要查询的配置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)创建新的配置。
11254
11362
  # @type ConfigId: String
11255
11363
 
11256
11364
  attr_accessor :ConfigId
@@ -11266,7 +11374,7 @@ module TencentCloud
11266
11374
 
11267
11375
  # DescribePublicConfig返回参数结构体
11268
11376
  class DescribePublicConfigResponse < TencentCloud::Common::AbstractModel
11269
- # @param Result: 全局配置
11377
+ # @param Result: 全局配置。
11270
11378
  # 注意:此字段可能返回 null,表示取不到有效值。
11271
11379
  # @type Result: :class:`Tencentcloud::Tsf.v20180326.models.Config`
11272
11380
  # @param RequestId: 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
@@ -11290,21 +11398,25 @@ module TencentCloud
11290
11398
 
11291
11399
  # DescribePublicConfigSummary请求参数结构体
11292
11400
  class DescribePublicConfigSummaryRequest < TencentCloud::Common::AbstractModel
11293
- # @param SearchWord: 查询关键字,模糊查询:配置项名称,不传入时查询全量
11401
+ # @param SearchWord: 查询关键字,模糊查询:配置项名称,不传入时查询全量。
11294
11402
  # @type SearchWord: String
11295
- # @param Offset: 偏移量,默认为0
11403
+ # @param Offset: 偏移量,默认为0
11296
11404
  # @type Offset: Integer
11297
- # @param Limit: 每页条数,默认为20
11405
+ # @param Limit: 返回数量,默认为20,最大值为50。
11298
11406
  # @type Limit: Integer
11299
- # @param OrderBy: 按时间排序:creation_time;按名称排序:config_name
11407
+ # @param OrderBy: 排序字段。
11408
+ # - creation_time:按时间排序
11409
+ # - config_name:按名称排序
11300
11410
  # @type OrderBy: String
11301
- # @param OrderType: 升序传 0,降序传 1
11411
+ # @param OrderType: 排序顺序。
11412
+ # - 0:升序
11413
+ # - 1:降序
11302
11414
  # @type OrderType: Integer
11303
- # @param ConfigTagList:
11415
+ # @param ConfigTagList: TAG标签资源值。
11304
11416
  # @type ConfigTagList: Array
11305
- # @param DisableProgramAuthCheck:
11417
+ # @param DisableProgramAuthCheck: 忽略传参,业务预留字段。
11306
11418
  # @type DisableProgramAuthCheck: Boolean
11307
- # @param ConfigIdList:
11419
+ # @param ConfigIdList: 配置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)创建新的配置。
11308
11420
  # @type ConfigIdList: Array
11309
11421
 
11310
11422
  attr_accessor :SearchWord, :Offset, :Limit, :OrderBy, :OrderType, :ConfigTagList, :DisableProgramAuthCheck, :ConfigIdList
@@ -11334,7 +11446,7 @@ module TencentCloud
11334
11446
 
11335
11447
  # DescribePublicConfigSummary返回参数结构体
11336
11448
  class DescribePublicConfigSummaryResponse < TencentCloud::Common::AbstractModel
11337
- # @param Result: 分页的全局配置统计信息列表
11449
+ # @param Result: 分页的全局配置统计信息列表。
11338
11450
  # @type Result: :class:`Tencentcloud::Tsf.v20180326.models.TsfPageConfig`
11339
11451
  # @param RequestId: 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
11340
11452
  # @type RequestId: String
@@ -11357,17 +11469,17 @@ module TencentCloud
11357
11469
 
11358
11470
  # DescribePublicConfigs请求参数结构体
11359
11471
  class DescribePublicConfigsRequest < TencentCloud::Common::AbstractModel
11360
- # @param ConfigId: 配置项ID,不传入时查询全量,高优先级
11472
+ # @param ConfigId: 配置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)创建新的配置。
11361
11473
  # @type ConfigId: String
11362
- # @param Offset: 偏移量,默认为0
11474
+ # @param Offset: 偏移量,默认为0
11363
11475
  # @type Offset: Integer
11364
- # @param Limit: 每页条数,默认为20
11476
+ # @param Limit: 返回数量,默认为20,最大值为100。
11365
11477
  # @type Limit: Integer
11366
- # @param ConfigIdList: 配置项ID列表,不传入时查询全量,低优先级
11478
+ # @param ConfigIdList: 配置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)创建新的配置。
11367
11479
  # @type ConfigIdList: Array
11368
- # @param ConfigName: 配置项名称,精确查询,不传入时查询全量
11480
+ # @param ConfigName: 配置项名称,精确查询,不传入时查询全量。
11369
11481
  # @type ConfigName: String
11370
- # @param ConfigVersion: 配置项版本,精确查询,不传入时查询全量
11482
+ # @param ConfigVersion: 配置项版本,精确查询,不传入时查询全量。
11371
11483
  # @type ConfigVersion: String
11372
11484
 
11373
11485
  attr_accessor :ConfigId, :Offset, :Limit, :ConfigIdList, :ConfigName, :ConfigVersion
@@ -11393,7 +11505,7 @@ module TencentCloud
11393
11505
 
11394
11506
  # DescribePublicConfigs返回参数结构体
11395
11507
  class DescribePublicConfigsResponse < TencentCloud::Common::AbstractModel
11396
- # @param Result: 分页后的全局配置项列表
11508
+ # @param Result: 分页后的全局配置项列表。
11397
11509
  # @type Result: :class:`Tencentcloud::Tsf.v20180326.models.TsfPageConfig`
11398
11510
  # @param RequestId: 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
11399
11511
  # @type RequestId: String
@@ -11416,7 +11528,7 @@ module TencentCloud
11416
11528
 
11417
11529
  # DescribeReleasedConfig请求参数结构体
11418
11530
  class DescribeReleasedConfigRequest < TencentCloud::Common::AbstractModel
11419
- # @param GroupId: 部署组ID
11531
+ # @param GroupId: 部署组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)创建新的部署组。
11420
11532
  # @type GroupId: String
11421
11533
 
11422
11534
  attr_accessor :GroupId
@@ -11432,7 +11544,7 @@ module TencentCloud
11432
11544
 
11433
11545
  # DescribeReleasedConfig返回参数结构体
11434
11546
  class DescribeReleasedConfigResponse < TencentCloud::Common::AbstractModel
11435
- # @param Result: 已发布的配置内容
11547
+ # @param Result: 已发布的配置内容。
11436
11548
  # @type Result: String
11437
11549
  # @param RequestId: 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
11438
11550
  # @type RequestId: String
@@ -11454,11 +11566,11 @@ module TencentCloud
11454
11566
  class DescribeRepositoriesRequest < TencentCloud::Common::AbstractModel
11455
11567
  # @param SearchWord: 查询关键字(按照仓库名称搜索)
11456
11568
  # @type SearchWord: String
11457
- # @param Offset: 查询起始偏移
11569
+ # @param Offset: 查询起始偏移,大于等于0,默认值为0
11458
11570
  # @type Offset: Integer
11459
- # @param Limit: 返回数量限制
11571
+ # @param Limit: 返回数量限制,大于0,默认为不分页
11460
11572
  # @type Limit: Integer
11461
- # @param RepositoryType: 仓库类型(默认仓库:default,私有仓库:private)
11573
+ # @param RepositoryType: 仓库类型(默认仓库:default,私有仓库:private,公共仓库:public-demo
11462
11574
  # @type RepositoryType: String
11463
11575
 
11464
11576
  attr_accessor :SearchWord, :Offset, :Limit, :RepositoryType
@@ -11503,7 +11615,7 @@ module TencentCloud
11503
11615
 
11504
11616
  # DescribeRepository请求参数结构体
11505
11617
  class DescribeRepositoryRequest < TencentCloud::Common::AbstractModel
11506
- # @param RepositoryId: 仓库ID
11618
+ # @param RepositoryId: 仓库ID,可通过调用[仓库信息查询类](https://cloud.tencent.com/document/api/649/45925)接口时出参中的RepositoryId,或登录[控制台](https://console.cloud.tencent.com/tsf/product?rid=1)进行查看
11507
11619
  # @type RepositoryId: String
11508
11620
 
11509
11621
  attr_accessor :RepositoryId
@@ -11785,7 +11897,7 @@ module TencentCloud
11785
11897
 
11786
11898
  # DescribeResourceTaskStatus请求参数结构体
11787
11899
  class DescribeResourceTaskStatusRequest < TencentCloud::Common::AbstractModel
11788
- # @param TaskId: 任务ID
11900
+ # @param TaskId: 容器实例任务ID,可通过调用 ListContainerTask 查询已创建的变更记录总数或登录控制台进行查看。
11789
11901
  # @type TaskId: String
11790
11902
 
11791
11903
  attr_accessor :TaskId
@@ -11824,13 +11936,16 @@ module TencentCloud
11824
11936
 
11825
11937
  # DescribeSimpleApplications请求参数结构体
11826
11938
  class DescribeSimpleApplicationsRequest < TencentCloud::Common::AbstractModel
11827
- # @param ApplicationIdList: 应用ID列表
11939
+ # @param ApplicationIdList: 应用ID列表,可通过调用[DescribeApplications](https://cloud.tencent.com/document/api/649/36090)查询已创建的应用列表或登录控制台进行查看;也可以调用[CreateApplication](https://cloud.tencent.com/document/api/649/36094)创建新的应用。
11828
11940
  # @type ApplicationIdList: Array
11829
- # @param ApplicationType: 应用类型
11941
+ # @param ApplicationType: 指定应用类型,目前支持:
11942
+ # - `V`:普通应用/CVM应用
11943
+ # - `C`:容器应用
11944
+ # - `S`:serverless 应用
11830
11945
  # @type ApplicationType: String
11831
- # @param Limit: 每页条数
11946
+ # @param Limit: 数量限制,默认为20,最大值为100。关于Limit详见[API简介](https://cloud.tencent.com/document/api/213/568#.E8.BE.93.E5.85.A5.E5.8F.82.E6.95.B0.E4.B8.8E.E8.BF.94.E5.9B.9E.E5.8F.82.E6.95.B0.E9.87.8A.E4.B9.89)
11832
11947
  # @type Limit: Integer
11833
- # @param Offset: 起始偏移量
11948
+ # @param Offset: 偏移量,默认为0。关于Offset详见[API简介](https://cloud.tencent.com/document/api/213/568#.E8.BE.93.E5.85.A5.E5.8F.82.E6.95.B0.E4.B8.8E.E8.BF.94.E5.9B.9E.E5.8F.82.E6.95.B0.E9.87.8A.E4.B9.89)
11834
11949
  # @type Offset: Integer
11835
11950
  # @param MicroserviceType: 微服务类型
11836
11951
  # @type MicroserviceType: String
@@ -11838,7 +11953,7 @@ module TencentCloud
11838
11953
  # @type ApplicationResourceTypeList: Array
11839
11954
  # @param SearchWord: 通过id和name进行关键词过滤
11840
11955
  # @type SearchWord: String
11841
- # @param DisableProgramAuthCheck:
11956
+ # @param DisableProgramAuthCheck: 是否关闭鉴权查询
11842
11957
  # @type DisableProgramAuthCheck: Boolean
11843
11958
  # @param MicroserviceTypeList: 查询指定微服务类型的应用列表
11844
11959
  # @type MicroserviceTypeList: Array
@@ -12025,25 +12140,25 @@ module TencentCloud
12025
12140
 
12026
12141
  # DescribeSimpleNamespaces请求参数结构体
12027
12142
  class DescribeSimpleNamespacesRequest < TencentCloud::Common::AbstractModel
12028
- # @param NamespaceIdList: 命名空间ID列表,不传入时查询全量
12143
+ # @param NamespaceIdList: 命名空间ID列表,按照【命名空间ID列表】进行过滤,可通过调用[DescribeNamespaces](https://cloud.tencent.com/document/product/649/36096)查询已创建的命名空间列表或登录控制台进行查看;也可以调用[CreateNamespace](https://cloud.tencent.com/document/product/649/36098)创建新的命名空间。
12029
12144
  # @type NamespaceIdList: Array
12030
- # @param ClusterId: 集群ID,不传入时查询全量
12145
+ # @param ClusterId: 集群ID,按照【集群ID】进行过滤,可通过调用[DescribeClusters](https://cloud.tencent.com/document/product/649/85857)查询已创建的集群列表或登录控制台进行查看;也可以调用[CreateCluster](https://cloud.tencent.com/document/product/649/36049)创建新的集群。仅在集群下无部署组、命名空间、云主机时可以删除。
12031
12146
  # @type ClusterId: String
12032
- # @param Limit: 每页条数
12147
+ # @param Limit: 数量限制,默认为20,最大值为100。关于Limit详见[API简介](https://cloud.tencent.com/document/api/213/568#.E8.BE.93.E5.85.A5.E5.8F.82.E6.95.B0.E4.B8.8E.E8.BF.94.E5.9B.9E.E5.8F.82.E6.95.B0.E9.87.8A.E4.B9.89)
12033
12148
  # @type Limit: Integer
12034
- # @param Offset: 起始偏移量
12149
+ # @param Offset: 偏移量,默认为0。关于Offset详见[API简介](https://cloud.tencent.com/document/api/213/568#.E8.BE.93.E5.85.A5.E5.8F.82.E6.95.B0.E4.B8.8E.E8.BF.94.E5.9B.9E.E5.8F.82.E6.95.B0.E9.87.8A.E4.B9.89)
12035
12150
  # @type Offset: Integer
12036
- # @param NamespaceId: 命名空间ID,不传入时查询全量
12151
+ # @param NamespaceId: 命名空间ID,按照【命名空间ID】进行过滤,可通过调用[DescribeNamespaces](https://cloud.tencent.com/document/product/649/36096)查询已创建的命名空间列表或登录控制台进行查看;也可以调用[CreateNamespace](https://cloud.tencent.com/document/product/649/36098)创建新命名空间。
12037
12152
  # @type NamespaceId: String
12038
12153
  # @param NamespaceResourceTypeList: 查询资源类型列表
12039
12154
  # @type NamespaceResourceTypeList: Array
12040
12155
  # @param SearchWord: 通过id和name进行过滤
12041
12156
  # @type SearchWord: String
12042
- # @param NamespaceTypeList: 查询的命名空间类型列表
12157
+ # @param NamespaceTypeList: 查询的命名空间类型列表。DEF:默认普通命名空间。GLOBAL:全局命名空间。
12043
12158
  # @type NamespaceTypeList: Array
12044
12159
  # @param NamespaceName: 通过命名空间名精确过滤
12045
12160
  # @type NamespaceName: String
12046
- # @param IsDefault: 通过是否是默认命名空间过滤,不传表示拉取全部命名空间。0:默认命名空间。1:非默认命名空间
12161
+ # @param IsDefault: 通过是否是默认命名空间过滤,不传表示拉取全部命名空间。0:默认命名空间。1:非默认命名空间。
12047
12162
  # @type IsDefault: String
12048
12163
  # @param DisableProgramAuthCheck: 是否关闭鉴权查询
12049
12164
  # @type DisableProgramAuthCheck: Boolean
@@ -12104,15 +12219,16 @@ module TencentCloud
12104
12219
 
12105
12220
  # DescribeStatistics请求参数结构体
12106
12221
  class DescribeStatisticsRequest < TencentCloud::Common::AbstractModel
12107
- # @param Type: 类型:InterfaceServiceGroupInstanceSQLNoSQL
12222
+ # @param Type: 统计类型。可选值 Interface:接口类型、Service:服务类型、Group:部署组类型、Instance:实例类型、SQL:SQL类型、NoSQL:NoSQL类型
12108
12223
  # @type Type: String
12109
- # @param TimeStep: 步长,单位s:60、3600、86400
12224
+ # @param TimeStep: 步长,单位秒。可选值 60、3600、86400
12110
12225
  # @type TimeStep: Integer
12111
12226
  # @param Offset: 偏移量,取值范围大于等于0,默认值为0
12112
12227
  # @type Offset: Integer
12113
12228
  # @param Limit: 单页请求配置数量,取值范围[1, 50],默认值为10
12114
12229
  # @type Limit: Integer
12115
- # @param NamespaceId: 命名空间Id,此字段,和 NamespaceIdList 或者 MetricDimensionValues 字段包含 namespaceId 维度信息。三者选其一。
12230
+ # @param NamespaceId: 命名空间ID。此字段,和 NamespaceIdList 或者 MetricDimensionValues 字段包含 namespaceId 维度信息。三者选其一。
12231
+ # 可通过[DescribeSimpleNamespaces](https://cloud.tencent.com/document/product/649/36096)查询已经创建的命名空间,也可以通过登录[控制台](https://console.cloud.tencent.com/tsf/resource?rid=1&tab=namespace)查看
12116
12232
  # @type NamespaceId: String
12117
12233
  # @param OrderBy: 排序字段:AvgTimeConsuming[默认]、RequestCount、ErrorRate。实例监控还支持 CpuPercent
12118
12234
  # @type OrderBy: String
@@ -12126,15 +12242,16 @@ module TencentCloud
12126
12242
  # @type ServiceName: String
12127
12243
  # @param SearchWord: 搜索关键词
12128
12244
  # @type SearchWord: String
12129
- # @param MetricDimensionValues: 维度
12245
+ # @param MetricDimensionValues: 维度。此字段,和 NamespaceIdList 或者 MetricDimensionValues 字段包含 namespaceId 维度信息。三者选其一
12130
12246
  # @type MetricDimensionValues: Array
12131
12247
  # @param BucketKey: 聚合关键词
12132
12248
  # @type BucketKey: String
12133
- # @param DbName: 数据库
12249
+ # @param DbName: 数据库名称
12134
12250
  # @type DbName: String
12135
- # @param NamespaceIdList: 命名空间id数组
12251
+ # @param NamespaceIdList: 命名空间ID数组。此字段,和 NamespaceIdList 或者 MetricDimensionValues 字段包含 namespaceId 维度信息。三者选其一
12136
12252
  # @type NamespaceIdList: Array
12137
- # @param ConfigCenterInstanceId: 独占配置中心的ID
12253
+ # @param ConfigCenterInstanceId: 独占配置中心的ID
12254
+ # 可通过调用[DescribeClusterInstances](https://cloud.tencent.com/document/product/649/36048)查询已导入的实例列表或登录[控制台](https://console.cloud.tencent.com/tsf/resource?rid=1&tab=instance)进行查询。实例ID例如:ins-6decplwk。
12138
12255
  # @type ConfigCenterInstanceId: String
12139
12256
 
12140
12257
  attr_accessor :Type, :TimeStep, :Offset, :Limit, :NamespaceId, :OrderBy, :OrderType, :EndTime, :StartTime, :ServiceName, :SearchWord, :MetricDimensionValues, :BucketKey, :DbName, :NamespaceIdList, :ConfigCenterInstanceId
@@ -12210,9 +12327,9 @@ module TencentCloud
12210
12327
 
12211
12328
  # DescribeTaskDetail请求参数结构体
12212
12329
  class DescribeTaskDetailRequest < TencentCloud::Common::AbstractModel
12213
- # @param TaskId: 任务ID
12330
+ # @param TaskId: 任务ID。在[任务管理](https://console.cloud.tencent.com/tsf/tct?rid=1)列表页第一列和任务基本信息页查看任务ID。
12214
12331
  # @type TaskId: String
12215
- # @param TaskLogId: 任务历史ID
12332
+ # @param TaskLogId: 任务历史ID。查询任务列表 [DescribeTaskRecords](https://cloud.tencent.com/document/api/649/56136) 返回值字段 TaskLogId
12216
12333
  # @type TaskLogId: String
12217
12334
 
12218
12335
  attr_accessor :TaskId, :TaskLogId
@@ -12253,7 +12370,7 @@ module TencentCloud
12253
12370
 
12254
12371
  # DescribeTaskLastStatus请求参数结构体
12255
12372
  class DescribeTaskLastStatusRequest < TencentCloud::Common::AbstractModel
12256
- # @param TaskId: 任务ID
12373
+ # @param TaskId: 任务ID。在[任务管理](https://console.cloud.tencent.com/tsf/tct?rid=1)列表页第一列和任务基本信息页查看任务ID。
12257
12374
  # @type TaskId: String
12258
12375
 
12259
12376
  attr_accessor :TaskId
@@ -12292,21 +12409,21 @@ module TencentCloud
12292
12409
 
12293
12410
  # DescribeTaskRecords请求参数结构体
12294
12411
  class DescribeTaskRecordsRequest < TencentCloud::Common::AbstractModel
12295
- # @param Offset: 翻页偏移量。
12412
+ # @param Offset: 翻页偏移量。默认值为0
12296
12413
  # @type Offset: Integer
12297
- # @param Limit: 翻页查询单页数量。
12414
+ # @param Limit: 翻页查询单页数量。默认值为 20,最大值为 1000
12298
12415
  # @type Limit: Integer
12299
12416
  # @param SearchWord: 模糊查询关键字,支持任务ID和任务名称。
12300
12417
  # @type SearchWord: String
12301
- # @param TaskState: 任务启用状态。enabled/disabled
12418
+ # @param TaskState: 任务启用状态。一共2种状态可选,ENABLED:启用,DISABLED:停用
12302
12419
  # @type TaskState: String
12303
- # @param GroupId: 分组ID。
12420
+ # @param GroupId: 部署组ID。前往[应用管理](https://console.cloud.tencent.com/tsf/app?rid=1)点击应用ID进入应用部署列表页面获取部署组ID
12304
12421
  # @type GroupId: String
12305
- # @param TaskType: 任务类型。
12422
+ # @param TaskType: 任务类型。当前只支持一种任务类型。枚举值,java:Java类任务
12306
12423
  # @type TaskType: String
12307
- # @param ExecuteType: 任务触发类型,UNICAST、BROADCAST。
12424
+ # @param ExecuteType: 任务执行方式,unicast:随机单节点执行,broadcast:广播执行,shard:分片执行
12308
12425
  # @type ExecuteType: String
12309
- # @param Ids:
12426
+ # @param Ids: 任务ID列表。在[任务管理](https://console.cloud.tencent.com/tsf/tct?rid=1)列表页第一列查看任务ID。
12310
12427
  # @type Ids: Array
12311
12428
 
12312
12429
  attr_accessor :Offset, :Limit, :SearchWord, :TaskState, :GroupId, :TaskType, :ExecuteType, :Ids
@@ -12634,7 +12751,7 @@ module TencentCloud
12634
12751
 
12635
12752
  # DescribeUploadInfo请求参数结构体
12636
12753
  class DescribeUploadInfoRequest < TencentCloud::Common::AbstractModel
12637
- # @param ApplicationId: 应用ID
12754
+ # @param ApplicationId: 应用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)时的返回值
12638
12755
  # @type ApplicationId: String
12639
12756
  # @param PkgName: 程序包名
12640
12757
  # @type PkgName: String
@@ -12644,9 +12761,9 @@ module TencentCloud
12644
12761
  # @type PkgType: String
12645
12762
  # @param PkgDesc: 程序包介绍
12646
12763
  # @type PkgDesc: String
12647
- # @param RepositoryType: 程序包仓库类型
12764
+ # @param RepositoryType: 仓库类型(默认仓库:default,私有仓库:private,公共仓库:public-demo)
12648
12765
  # @type RepositoryType: String
12649
- # @param RepositoryId: 程序包仓库id
12766
+ # @param RepositoryId: 仓库ID,可通过调用[仓库信息查询类](https://cloud.tencent.com/document/api/649/45925)接口时出参中的RepositoryId,或登录[控制台](https://console.cloud.tencent.com/tsf/product?rid=1)进行查看
12650
12767
  # @type RepositoryId: String
12651
12768
 
12652
12769
  attr_accessor :ApplicationId, :PkgName, :PkgVersion, :PkgType, :PkgDesc, :RepositoryType, :RepositoryId
@@ -12744,7 +12861,7 @@ module TencentCloud
12744
12861
 
12745
12862
  # DisableLaneRule请求参数结构体
12746
12863
  class DisableLaneRuleRequest < TencentCloud::Common::AbstractModel
12747
- # @param RuleId: 泳道规则ID
12864
+ # @param RuleId: 灰度发布规则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)创建新的灰度发布规则。
12748
12865
  # @type RuleId: String
12749
12866
 
12750
12867
  attr_accessor :RuleId
@@ -12760,7 +12877,9 @@ module TencentCloud
12760
12877
 
12761
12878
  # DisableLaneRule返回参数结构体
12762
12879
  class DisableLaneRuleResponse < TencentCloud::Common::AbstractModel
12763
- # @param Result: 操作状态。成功:true,失败:false
12880
+ # @param Result: 操作状态。
12881
+ # - true:成功
12882
+ # - false:失败
12764
12883
  # @type Result: Boolean
12765
12884
  # @param RequestId: 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
12766
12885
  # @type RequestId: String
@@ -12780,7 +12899,7 @@ module TencentCloud
12780
12899
 
12781
12900
  # DisableTaskFlow请求参数结构体
12782
12901
  class DisableTaskFlowRequest < TencentCloud::Common::AbstractModel
12783
- # @param FlowId: 工作流 ID
12902
+ # @param FlowId: 工作流 ID。[工作流管理](https://console.cloud.tencent.com/tsf/tct?rid=1&tab=workflowManage)列表页查看工作流ID。
12784
12903
  # @type FlowId: String
12785
12904
 
12786
12905
  attr_accessor :FlowId
@@ -12816,7 +12935,7 @@ module TencentCloud
12816
12935
 
12817
12936
  # DisableTask请求参数结构体
12818
12937
  class DisableTaskRequest < TencentCloud::Common::AbstractModel
12819
- # @param TaskId: 任务ID
12938
+ # @param TaskId: 任务ID。[任务管理](https://console.cloud.tencent.com/tsf/tct?rid=1)列表页查看任务ID。
12820
12939
  # @type TaskId: String
12821
12940
 
12822
12941
  attr_accessor :TaskId
@@ -12832,7 +12951,7 @@ module TencentCloud
12832
12951
 
12833
12952
  # DisableTask返回参数结构体
12834
12953
  class DisableTaskResponse < TencentCloud::Common::AbstractModel
12835
- # @param Result: 操作成功 or 失败
12954
+ # @param Result: true:操作成功,false:操作失败
12836
12955
  # @type Result: Boolean
12837
12956
  # @param RequestId: 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
12838
12957
  # @type RequestId: String
@@ -12925,8 +13044,10 @@ module TencentCloud
12925
13044
  # DisassociateBusinessLogConfig请求参数结构体
12926
13045
  class DisassociateBusinessLogConfigRequest < TencentCloud::Common::AbstractModel
12927
13046
  # @param ConfigIdList: 业务日志配置项ID列表
13047
+ # 可通过调用[DescribeBusinessLogConfigs](https://cloud.tencent.com/document/product/649/75777)查询已创建的日志配置项列表或登录[控制台](https://console.cloud.tencent.com/tsf/observable/log?rid=1)进行查看
12928
13048
  # @type ConfigIdList: Array
12929
- # @param GroupId: TSF分组ID
13049
+ # @param GroupId: 部署组ID
13050
+ # 可通过调用[DescribeContainerGroups](https://cloud.tencent.com/document/product/649/36068)或[DescribeGroups](https://cloud.tencent.com/document/product/649/36065)查询已创建的部署组列表或登录[控制台](https://console.cloud.tencent.com/tsf/app-detail?rid=1&id=application-yo7kp9dv&tab=publish&subTab=group)进行查看
12930
13051
  # @type GroupId: String
12931
13052
 
12932
13053
  attr_accessor :ConfigIdList, :GroupId
@@ -12944,7 +13065,7 @@ module TencentCloud
12944
13065
 
12945
13066
  # DisassociateBusinessLogConfig返回参数结构体
12946
13067
  class DisassociateBusinessLogConfigResponse < TencentCloud::Common::AbstractModel
12947
- # @param Result: 操作结果
13068
+ # @param Result: 操作结果,true:成功,false:失败。
12948
13069
  # @type Result: Boolean
12949
13070
  # @param RequestId: 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
12950
13071
  # @type RequestId: String
@@ -12964,9 +13085,11 @@ module TencentCloud
12964
13085
 
12965
13086
  # DisassociateKafkaConfig请求参数结构体
12966
13087
  class DisassociateKafkaConfigRequest < TencentCloud::Common::AbstractModel
12967
- # @param ConfigId: 配置项id
13088
+ # @param ConfigId: 日志配置项ID
13089
+ # 可通过调用[DescribeBusinessLogConfigs](https://cloud.tencent.com/document/product/649/75777)查询已创建的日志配置项列表或登录[控制台](https://console.cloud.tencent.com/tsf/observable/log?rid=1)进行查看
12968
13090
  # @type ConfigId: String
12969
- # @param GroupIds: 部署组id
13091
+ # @param GroupIds: 部署组ID列表
13092
+ # 可通过调用[DescribeContainerGroups](https://cloud.tencent.com/document/product/649/36068)或[DescribeGroups](https://cloud.tencent.com/document/product/649/36065)查询已创建的部署组列表或登录[控制台](https://console.cloud.tencent.com/tsf/app-detail?rid=1&id=application-yo7kp9dv&tab=publish&subTab=group)进行查看
12970
13093
  # @type GroupIds: Array
12971
13094
 
12972
13095
  attr_accessor :ConfigId, :GroupIds
@@ -12984,7 +13107,7 @@ module TencentCloud
12984
13107
 
12985
13108
  # DisassociateKafkaConfig返回参数结构体
12986
13109
  class DisassociateKafkaConfigResponse < TencentCloud::Common::AbstractModel
12987
- # @param Result: 解除绑定是否成功
13110
+ # @param Result: 解除绑定是否成功,true:成功,false:失败。
12988
13111
  # @type Result: Boolean
12989
13112
  # @param RequestId: 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
12990
13113
  # @type RequestId: String
@@ -13068,7 +13191,7 @@ module TencentCloud
13068
13191
 
13069
13192
  # EnableLaneRule请求参数结构体
13070
13193
  class EnableLaneRuleRequest < TencentCloud::Common::AbstractModel
13071
- # @param RuleId: 泳道规则ID
13194
+ # @param RuleId: 灰度发布规则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)创建新的灰度发布规则。
13072
13195
  # @type RuleId: String
13073
13196
 
13074
13197
  attr_accessor :RuleId
@@ -13084,7 +13207,9 @@ module TencentCloud
13084
13207
 
13085
13208
  # EnableLaneRule返回参数结构体
13086
13209
  class EnableLaneRuleResponse < TencentCloud::Common::AbstractModel
13087
- # @param Result: 操作状态。成功:true,失败:false
13210
+ # @param Result: 操作状态。
13211
+ # - true:成功
13212
+ # - false:失败
13088
13213
  # @type Result: Boolean
13089
13214
  # @param RequestId: 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
13090
13215
  # @type RequestId: String
@@ -13104,7 +13229,7 @@ module TencentCloud
13104
13229
 
13105
13230
  # EnableTaskFlow请求参数结构体
13106
13231
  class EnableTaskFlowRequest < TencentCloud::Common::AbstractModel
13107
- # @param FlowId: 工作流 ID
13232
+ # @param FlowId: 工作流 ID。[工作流管理](https://console.cloud.tencent.com/tsf/tct?rid=1&tab=workflowManage)列表页查看工作流ID。
13108
13233
  # @type FlowId: String
13109
13234
 
13110
13235
  attr_accessor :FlowId
@@ -13140,7 +13265,7 @@ module TencentCloud
13140
13265
 
13141
13266
  # EnableTask请求参数结构体
13142
13267
  class EnableTaskRequest < TencentCloud::Common::AbstractModel
13143
- # @param TaskId: 启用任务
13268
+ # @param TaskId: 任务ID。[任务管理](https://console.cloud.tencent.com/tsf/tct?rid=1)列表页查看任务ID。
13144
13269
  # @type TaskId: String
13145
13270
 
13146
13271
  attr_accessor :TaskId
@@ -13156,7 +13281,7 @@ module TencentCloud
13156
13281
 
13157
13282
  # EnableTask返回参数结构体
13158
13283
  class EnableTaskResponse < TencentCloud::Common::AbstractModel
13159
- # @param Result: 操作成功or失败
13284
+ # @param Result: true:操作成功,false:操作失败
13160
13285
  # @type Result: Boolean
13161
13286
  # @param RequestId: 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
13162
13287
  # @type RequestId: String
@@ -13276,17 +13401,17 @@ module TencentCloud
13276
13401
 
13277
13402
  # 独占实例
13278
13403
  class ExclusiveInstance < TencentCloud::Common::AbstractModel
13279
- # @param CenterType: 配置中心类型[RegistrationConfiguration]
13404
+ # @param CenterType: 配置中心类型[注册中心Registration、配置中心Configuration]
13280
13405
  # @type CenterType: String
13281
- # @param InstanceId: 实例id
13406
+ # @param InstanceId: 实例id,通过北极星控制台获取
13282
13407
  # @type InstanceId: String
13283
- # @param InstanceType: 实例类型[Polaris]
13408
+ # @param InstanceType: 实例类型,例如北极星Polaris
13284
13409
  # @type InstanceType: String
13285
13410
  # @param InstanceName: 实例名称
13286
13411
  # @type InstanceName: String
13287
- # @param RegionId: 实例地域id
13412
+ # @param RegionId: 实例地域id,通过北极星控制台获取
13288
13413
  # @type RegionId: String
13289
- # @param InstanceNamespaceId: 实例命名空间ID
13414
+ # @param InstanceNamespaceId: 实例命名空间ID,通过北极星控制台获取
13290
13415
  # @type InstanceNamespaceId: String
13291
13416
 
13292
13417
  attr_accessor :CenterType, :InstanceId, :InstanceType, :InstanceName, :RegionId, :InstanceNamespaceId
@@ -13312,7 +13437,7 @@ module TencentCloud
13312
13437
 
13313
13438
  # ExecuteTaskFlow请求参数结构体
13314
13439
  class ExecuteTaskFlowRequest < TencentCloud::Common::AbstractModel
13315
- # @param FlowId: 工作流 ID
13440
+ # @param FlowId: 工作流 ID。[工作流管理](https://console.cloud.tencent.com/tsf/tct?rid=1&tab=workflowManage)列表页查看工作流ID。
13316
13441
  # @type FlowId: String
13317
13442
 
13318
13443
  attr_accessor :FlowId
@@ -13328,7 +13453,7 @@ module TencentCloud
13328
13453
 
13329
13454
  # ExecuteTaskFlow返回参数结构体
13330
13455
  class ExecuteTaskFlowResponse < TencentCloud::Common::AbstractModel
13331
- # @param Result: 工作流批次ID
13456
+ # @param Result: 操作成功返回工作流批次ID,操作失败返回空字符串。
13332
13457
  # @type Result: String
13333
13458
  # @param RequestId: 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
13334
13459
  # @type RequestId: String
@@ -13348,7 +13473,7 @@ module TencentCloud
13348
13473
 
13349
13474
  # ExecuteTask请求参数结构体
13350
13475
  class ExecuteTaskRequest < TencentCloud::Common::AbstractModel
13351
- # @param TaskId: 任务 ID
13476
+ # @param TaskId: 任务ID。在[任务管理](https://console.cloud.tencent.com/tsf/tct?rid=1)列表页查看任务ID。
13352
13477
  # @type TaskId: String
13353
13478
 
13354
13479
  attr_accessor :TaskId
@@ -13364,7 +13489,7 @@ module TencentCloud
13364
13489
 
13365
13490
  # ExecuteTask返回参数结构体
13366
13491
  class ExecuteTaskResponse < TencentCloud::Common::AbstractModel
13367
- # @param Result: 成功/失败
13492
+ # @param Result: 操作成功返回任务批次ID,操作失败返回空字符串。
13368
13493
  # @type Result: String
13369
13494
  # @param RequestId: 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
13370
13495
  # @type RequestId: String
@@ -13384,9 +13509,9 @@ module TencentCloud
13384
13509
 
13385
13510
  # ExpandGroup请求参数结构体
13386
13511
  class ExpandGroupRequest < TencentCloud::Common::AbstractModel
13387
- # @param GroupId: 部署组ID
13512
+ # @param GroupId: 部署组ID,可通过调用[DescribeGroups](https://cloud.tencent.com/document/api/649/36065)查询已创建的部署组列表或登录控制台进行查看;也可以调用[CreateGroup](https://cloud.tencent.com/document/api/649/36074)创建新的部署组。
13388
13513
  # @type GroupId: String
13389
- # @param InstanceIdList: 扩容的机器实例ID列表
13514
+ # @param InstanceIdList: 扩容的机器实例ID列表,调用[DescribeClusters](https://console.cloud.tencent.com/tsf/resource?rid=1)接口,选定一个虚拟机集群,选择部署组,选择应用扩容可获取实例列表
13390
13515
  # @type InstanceIdList: Array
13391
13516
 
13392
13517
  attr_accessor :GroupId, :InstanceIdList
@@ -13550,7 +13675,7 @@ module TencentCloud
13550
13675
  # @param ReleaseDesc: 发布描述
13551
13676
  # 注意:此字段可能返回 null,表示取不到有效值。
13552
13677
  # @type ReleaseDesc: String
13553
- # @param ReleaseTime: 发布时间
13678
+ # @param ReleaseTime: 发布时间。格式为 YYYY-MM-DD hh:mm:ss。
13554
13679
  # 注意:此字段可能返回 null,表示取不到有效值。
13555
13680
  # @type ReleaseTime: String
13556
13681
  # @param GroupId: 部署组ID
@@ -14136,19 +14261,21 @@ module TencentCloud
14136
14261
 
14137
14262
  # 日志投递kafka用,描述部署组信息
14138
14263
  class GroupInfo < TencentCloud::Common::AbstractModel
14139
- # @param GroupId: 部署组id
14264
+ # @param GroupId: 部署组ID
14265
+ # 可通过调用[DescribeContainerGroups](https://cloud.tencent.com/document/product/649/36068)或[DescribeGroups](https://cloud.tencent.com/document/product/649/36065)查询已创建的部署组列表或登录[控制台](https://console.cloud.tencent.com/tsf/app-detail?rid=1&id=application-yo7kp9dv&tab=publish&subTab=group)进行查看。
14140
14266
  # @type GroupId: String
14141
14267
  # @param GroupName: 部署组名称
14142
14268
  # @type GroupName: String
14143
- # @param ClusterType: 集群类型
14269
+ # @param ClusterType: 集群类型,C:容器集群,V:虚拟机集群
14144
14270
  # @type ClusterType: String
14145
- # @param ClusterId: 集群id
14271
+ # @param ClusterId: 集群ID
14272
+ # 可通过[DescribeClusters](https://cloud.tencent.com/document/product/649/85857)查询已经创建的集群列表,也可以通过登录[控制台](https://console.cloud.tencent.com/tsf/resource?rid=1)查看。
14146
14273
  # @type ClusterId: String
14147
14274
  # @param ClusterName: 集群名称
14148
14275
  # @type ClusterName: String
14149
14276
  # @param NamespaceName: 命名空间名称
14150
14277
  # @type NamespaceName: String
14151
- # @param AssociateTime: 绑定时间
14278
+ # @param AssociateTime: 绑定时间,格式yyyy-MM-dd HH:mm:ss
14152
14279
  # @type AssociateTime: String
14153
14280
 
14154
14281
  attr_accessor :GroupId, :GroupName, :ClusterType, :ClusterId, :ClusterName, :NamespaceName, :AssociateTime
@@ -14192,13 +14319,13 @@ module TencentCloud
14192
14319
  # @type RestartCount: Integer
14193
14320
  # @param ReadyCount: 实例中已就绪容器的个数
14194
14321
  # @type ReadyCount: Integer
14195
- # @param Runtime: 运行时长
14322
+ # @param Runtime: 运行时长,单位秒
14196
14323
  # @type Runtime: String
14197
- # @param CreatedAt: 实例启动时间
14324
+ # @param CreatedAt: 实例启动时的时间戳
14198
14325
  # @type CreatedAt: String
14199
- # @param ServiceInstanceStatus: 服务实例状态
14326
+ # @param ServiceInstanceStatus: 服务实例状态,枚举值为Starting/Running/Stopping/Stopped/StopFailed/Abnormal/Unknown
14200
14327
  # @type ServiceInstanceStatus: String
14201
- # @param InstanceAvailableStatus: 机器实例可使用状态
14328
+ # @param InstanceAvailableStatus: 机器实例可使用状态,枚举值为Starting/Running/Stopping/Stopped/StopFailed/Abnormal/Unknown
14202
14329
  # @type InstanceAvailableStatus: String
14203
14330
  # @param InstanceStatus: 机器实例状态
14204
14331
  # @type InstanceStatus: String
@@ -14510,13 +14637,13 @@ module TencentCloud
14510
14637
  # @param ActionType: 健康检查方法。HTTP:通过 HTTP 接口检查;CMD:通过执行命令检查;TCP:通过建立 TCP 连接检查。
14511
14638
  # 注意:此字段可能返回 null,表示取不到有效值。
14512
14639
  # @type ActionType: String
14513
- # @param InitialDelaySeconds: 容器延时启动健康检查的时间。
14640
+ # @param InitialDelaySeconds: 容器延时启动健康检查的时间,单位秒。
14514
14641
  # 注意:此字段可能返回 null,表示取不到有效值。
14515
14642
  # @type InitialDelaySeconds: Integer
14516
- # @param TimeoutSeconds: 每次健康检查响应的最大超时时间。
14643
+ # @param TimeoutSeconds: 每次健康检查响应的最大超时时间,单位秒。
14517
14644
  # 注意:此字段可能返回 null,表示取不到有效值。
14518
14645
  # @type TimeoutSeconds: Integer
14519
- # @param PeriodSeconds: 进行健康检查的时间间隔。
14646
+ # @param PeriodSeconds: 进行健康检查的时间间隔,单位秒。
14520
14647
  # 注意:此字段可能返回 null,表示取不到有效值。
14521
14648
  # @type PeriodSeconds: Integer
14522
14649
  # @param SuccessThreshold: 表示后端容器从失败到成功的连续健康检查成功次数。
@@ -15145,13 +15272,13 @@ module TencentCloud
15145
15272
  # @type ApplicationId: String
15146
15273
  # @param ApplicationName: 应用名称
15147
15274
  # @type ApplicationName: String
15148
- # @param ApplicationType: 应用类型
15275
+ # @param ApplicationType: 应用类型,C表示容器应用,V表示虚拟机应用
15149
15276
  # @type ApplicationType: String
15150
15277
  # @param ClusterId: 集群ID
15151
15278
  # @type ClusterId: String
15152
15279
  # @param ClusterName: 集群名称
15153
15280
  # @type ClusterName: String
15154
- # @param ClusterType: 集群类型
15281
+ # @param ClusterType: 集群类型,C表示容器集群,V表示虚拟机集群
15155
15282
  # @type ClusterType: String
15156
15283
  # @param NamespaceId: 命名空间ID
15157
15284
  # @type NamespaceId: String
@@ -15992,7 +16119,7 @@ module TencentCloud
15992
16119
  class Metric < TencentCloud::Common::AbstractModel
15993
16120
  # @param Name: 指标名称
15994
16121
  # @type Name: String
15995
- # @param Function: 指标计算方式
16122
+ # @param Function: 指标计算方式,可选值: none:无,sum:求和,exclusive:独占值,avg:平均值,max:最大值,min:最小值,percentage_50:50分位数,percentage_75:75分位数,percentage_95:95分位数,percentage_99:99分位数,bucket_5:分桶统计。
15996
16123
  # @type Function: String
15997
16124
 
15998
16125
  attr_accessor :Name, :Function
@@ -16156,7 +16283,7 @@ module TencentCloud
16156
16283
  end
16157
16284
  end
16158
16285
 
16159
- # 指标维度多值匹配
16286
+ # 指标维度多值匹配。可选值 NamespaceId:命名空间ID,GroupId:部署组ID,InstanceId:实例ID,ApplicationId:应用ID,OperationMethod:执行方法,OperationName:执行名称,ServiceName:服务名,UpstreamNamespaceId:上游命名空间ID
16160
16287
  class MetricDimensionValue < TencentCloud::Common::AbstractModel
16161
16288
  # @param Name: 维度名
16162
16289
  # @type Name: String
@@ -16240,11 +16367,11 @@ module TencentCloud
16240
16367
  # @type ApplicationRemarkName: String
16241
16368
  # @param ServiceConfigList: 服务配置信息列表
16242
16369
  # @type ServiceConfigList: Array
16243
- # @param MicroserviceType: 应用的微服务类型
16370
+ # @param MicroserviceType: 应用的微服务类型,N表示普通应用,M表示Mesh应用,G表示网关应用,NATIVE表示原生应用,RAW表示裸应用
16244
16371
  # @type MicroserviceType: String
16245
16372
  # @param ServiceGovernanceConfig: 注册配置治理信息
16246
16373
  # @type ServiceGovernanceConfig: :class:`Tencentcloud::Tsf.v20180326.models.ServiceGovernanceConfig`
16247
- # @param FrameworkType: 应用开发框架
16374
+ # @param FrameworkType: 应用开发框架,SpringCloud表示SpringCloud应用,Dubbo表示Dubbo应用,Go-GRPC表示Go-GRPC应用,Other表示其他应用
16248
16375
  # @type FrameworkType: String
16249
16376
 
16250
16377
  attr_accessor :ApplicationId, :ApplicationName, :ApplicationDesc, :ApplicationRemarkName, :ServiceConfigList, :MicroserviceType, :ServiceGovernanceConfig, :FrameworkType
@@ -16284,8 +16411,7 @@ module TencentCloud
16284
16411
 
16285
16412
  # ModifyApplication返回参数结构体
16286
16413
  class ModifyApplicationResponse < TencentCloud::Common::AbstractModel
16287
- # @param Result: true:操作成功
16288
- # false:操作失败
16414
+ # @param Result: true表示修改成功,false表示修改失败
16289
16415
  # @type Result: Boolean
16290
16416
  # @param RequestId: 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
16291
16417
  # @type RequestId: String
@@ -16305,7 +16431,7 @@ module TencentCloud
16305
16431
 
16306
16432
  # ModifyCluster请求参数结构体
16307
16433
  class ModifyClusterRequest < TencentCloud::Common::AbstractModel
16308
- # @param ClusterId: 集群ID
16434
+ # @param ClusterId: 集群ID,按照【集群ID】进行过滤,可通过调用DescribeClusters查询已创建的项目列表或登录控制台进行查看;也可以调用CreateCluster创建新的项目。集群ID例如:cls-6a79x94v。
16309
16435
  # @type ClusterId: String
16310
16436
  # @param ClusterName: 集群名称
16311
16437
  # @type ClusterName: String
@@ -16313,9 +16439,9 @@ module TencentCloud
16313
16439
  # @type ClusterDesc: String
16314
16440
  # @param ClusterRemarkName: 备注名
16315
16441
  # @type ClusterRemarkName: String
16316
- # @param EnableLogCollection: 是否开启cls日志功能
16442
+ # @param EnableLogCollection: 是否开启cls日志功能,true表示开启,false表示关闭
16317
16443
  # @type EnableLogCollection: Boolean
16318
- # @param RepairLog: 是否修复cls日志功能
16444
+ # @param RepairLog: 是否修复cls日志功能,true表示修复,false表示不修复
16319
16445
  # @type RepairLog: Boolean
16320
16446
 
16321
16447
  attr_accessor :ClusterId, :ClusterName, :ClusterDesc, :ClusterRemarkName, :EnableLogCollection, :RepairLog
@@ -16363,7 +16489,7 @@ module TencentCloud
16363
16489
 
16364
16490
  # ModifyContainerGroup请求参数结构体
16365
16491
  class ModifyContainerGroupRequest < TencentCloud::Common::AbstractModel
16366
- # @param GroupId: 部署组ID,可通过调用[DescribeContainerGroups](https://cloud.tencent.com/document/api/649/36068)查询已创建的项目列表或登录控制台进行查看;也可以调用[CreateContainGroup](https://cloud.tencent.com/document/api/649/36075)创建新的项目。
16492
+ # @param GroupId: 部署组ID,可通过调用[DescribeContainerGroups](https://cloud.tencent.com/document/api/649/36068)查询已创建的部署组列表或登录控制台进行查看;也可以调用[CreateContainGroup](https://cloud.tencent.com/document/api/649/36075)创建新的部署组。
16367
16493
  # @type GroupId: String
16368
16494
  # @param AccessType: 0:公网 1:集群内访问 2:NodePort
16369
16495
  # @type AccessType: Integer
@@ -16373,7 +16499,7 @@ module TencentCloud
16373
16499
  # @type UpdateType: Integer
16374
16500
  # @param UpdateIvl: 更新间隔,单位秒
16375
16501
  # @type UpdateIvl: Integer
16376
- # @param SubnetId: 子网ID,可通过调用[DescribeSubnets](https://cloud.tencent.com/document/product/215/15784)查询已创建的项目列表或登录控制台进行查看;也可以调用[CreateSubnet](https://cloud.tencent.com/document/product/1108/43594)创建新的项目。
16502
+ # @param SubnetId: 子网ID,可通过调用[DescribeSubnets](https://cloud.tencent.com/document/product/215/15784)查询已创建的子网列表或登录控制台进行查看;也可以调用[CreateSubnet](https://cloud.tencent.com/document/product/1108/43594)创建新的子网。
16377
16503
  # @type SubnetId: String
16378
16504
  # @param Alias: 部署组备注
16379
16505
  # @type Alias: String
@@ -16432,7 +16558,7 @@ module TencentCloud
16432
16558
 
16433
16559
  # ModifyContainerReplicas请求参数结构体
16434
16560
  class ModifyContainerReplicasRequest < TencentCloud::Common::AbstractModel
16435
- # @param GroupId: 部署组ID,部署组唯一标识
16561
+ # @param GroupId: 部署组ID,部署组唯一标识,调用[DescribeClusters](https://console.cloud.tencent.com/tsf/resource?rid=1&tab=docker)接口,选定一个容器集群,选择部署组,查看DescribeSingleContainerGroups接口返回的GroupId
16436
16562
  # @type GroupId: String
16437
16563
  # @param InstanceNum: 实例数量
16438
16564
  # @type InstanceNum: Integer
@@ -16472,7 +16598,7 @@ module TencentCloud
16472
16598
 
16473
16599
  # ModifyGroup请求参数结构体
16474
16600
  class ModifyGroupRequest < TencentCloud::Common::AbstractModel
16475
- # @param GroupId: 部署组ID
16601
+ # @param GroupId: 部署组ID,按照【部署组ID】进行过滤,可通过调用DescribeGroups查询已创建的项目列表或登录控制台进行查看;也可以调用CreateGroup创建新的项目。部署组ID例如:group-9yn2q8yd。
16476
16602
  # @type GroupId: String
16477
16603
  # @param GroupName: 部署组名称
16478
16604
  # @type GroupName: String
@@ -16522,11 +16648,11 @@ module TencentCloud
16522
16648
 
16523
16649
  # ModifyLane请求参数结构体
16524
16650
  class ModifyLaneRequest < TencentCloud::Common::AbstractModel
16525
- # @param LaneId: 泳道ID
16651
+ # @param LaneId: 泳道配置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)创建新的泳道配置。
16526
16652
  # @type LaneId: String
16527
- # @param LaneName: 泳道名称
16653
+ # @param LaneName: 泳道配置名称,最多支持60个字符,只能包含字母、数字及分隔符(“-”),且不能以分隔符开头或结尾。
16528
16654
  # @type LaneName: String
16529
- # @param Remark: 备注
16655
+ # @param Remark: 备注,最多支持200个字符。
16530
16656
  # @type Remark: String
16531
16657
 
16532
16658
  attr_accessor :LaneId, :LaneName, :Remark
@@ -16546,7 +16672,9 @@ module TencentCloud
16546
16672
 
16547
16673
  # ModifyLane返回参数结构体
16548
16674
  class ModifyLaneResponse < TencentCloud::Common::AbstractModel
16549
- # @param Result: 更新成功: true / 更新失败: false
16675
+ # @param Result: 更新结果。
16676
+ # - true:更新成功
16677
+ # - false:更新失败
16550
16678
  # @type Result: Boolean
16551
16679
  # @param RequestId: 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
16552
16680
  # @type RequestId: String
@@ -16566,19 +16694,21 @@ module TencentCloud
16566
16694
 
16567
16695
  # ModifyLaneRule请求参数结构体
16568
16696
  class ModifyLaneRuleRequest < TencentCloud::Common::AbstractModel
16569
- # @param RuleId: 泳道规则ID
16697
+ # @param RuleId: 灰度发布规则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)创建新的灰度发布规则。
16570
16698
  # @type RuleId: String
16571
- # @param RuleName: 泳道规则名称
16699
+ # @param RuleName: 灰度发布规则名称,最多支持60个字符,支持中英文字符。
16572
16700
  # @type RuleName: String
16573
- # @param Remark: 泳道规则备注
16701
+ # @param Remark: 灰度发布规则备注,最多支持200个字符。
16574
16702
  # @type Remark: String
16575
- # @param RuleTagList: 泳道规则标签列表
16703
+ # @param RuleTagList: 灰度发布规则标签列表。
16576
16704
  # @type RuleTagList: Array
16577
- # @param RuleTagRelationship: 泳道规则标签关系
16705
+ # @param RuleTagRelationship: 灰度发布规则标签关系。- RELEATION_AND:与- RELEATION_OR:或
16578
16706
  # @type RuleTagRelationship: String
16579
- # @param LaneId: 泳道ID
16707
+ # @param LaneId: 泳道配置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)创建新的泳道配置。
16580
16708
  # @type LaneId: String
16581
- # @param Enable: 开启状态
16709
+ # @param Enable: 开启状态。
16710
+ # - true:开启
16711
+ # - false:关闭
16582
16712
  # @type Enable: Boolean
16583
16713
 
16584
16714
  attr_accessor :RuleId, :RuleName, :Remark, :RuleTagList, :RuleTagRelationship, :LaneId, :Enable
@@ -16613,7 +16743,9 @@ module TencentCloud
16613
16743
 
16614
16744
  # ModifyLaneRule返回参数结构体
16615
16745
  class ModifyLaneRuleResponse < TencentCloud::Common::AbstractModel
16616
- # @param Result: 操作状态。成功:true,失败:false
16746
+ # @param Result: 修改结果。
16747
+ # - true:成功
16748
+ # - false:失败
16617
16749
  # @type Result: Boolean
16618
16750
  # @param RequestId: 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
16619
16751
  # @type RequestId: String
@@ -16633,9 +16765,9 @@ module TencentCloud
16633
16765
 
16634
16766
  # ModifyMicroservice请求参数结构体
16635
16767
  class ModifyMicroserviceRequest < TencentCloud::Common::AbstractModel
16636
- # @param MicroserviceId: 微服务 ID
16768
+ # @param MicroserviceId: 微服务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)创建新的微服务。
16637
16769
  # @type MicroserviceId: String
16638
- # @param MicroserviceDesc: 微服务备注信息
16770
+ # @param MicroserviceDesc: 微服务备注信息,最多支持200个字符。
16639
16771
  # @type MicroserviceDesc: String
16640
16772
 
16641
16773
  attr_accessor :MicroserviceId, :MicroserviceDesc
@@ -16653,9 +16785,9 @@ module TencentCloud
16653
16785
 
16654
16786
  # ModifyMicroservice返回参数结构体
16655
16787
  class ModifyMicroserviceResponse < TencentCloud::Common::AbstractModel
16656
- # @param Result: 修改微服务详情是否成功。
16657
- # true:操作成功。
16658
- # false:操作失败。
16788
+ # @param Result: 修改结果。
16789
+ # - true:修改成功
16790
+ # - false:修改失败
16659
16791
  # @type Result: Boolean
16660
16792
  # @param RequestId: 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
16661
16793
  # @type RequestId: String
@@ -16675,13 +16807,13 @@ module TencentCloud
16675
16807
 
16676
16808
  # ModifyNamespace请求参数结构体
16677
16809
  class ModifyNamespaceRequest < TencentCloud::Common::AbstractModel
16678
- # @param NamespaceId: 命名空间ID
16810
+ # @param NamespaceId: 命名空间ID,按照【命名空间ID】进行过滤,可通过调用DescribeNamespaces查询已创建的项目列表或登录控制台进行查看;也可以调用CreateNamespace创建新的项目。命名空间ID例如:namespace-6a79x94v。
16679
16811
  # @type NamespaceId: String
16680
16812
  # @param NamespaceName: 命名空间名称
16681
16813
  # @type NamespaceName: String
16682
16814
  # @param NamespaceDesc: 命名空间备注
16683
16815
  # @type NamespaceDesc: String
16684
- # @param IsHaEnable: 是否开启高可用
16816
+ # @param IsHaEnable: 是否开启高可用,0表示不开启,1表示开启
16685
16817
  # @type IsHaEnable: String
16686
16818
 
16687
16819
  attr_accessor :NamespaceId, :NamespaceName, :NamespaceDesc, :IsHaEnable
@@ -16834,23 +16966,23 @@ module TencentCloud
16834
16966
 
16835
16967
  # ModifyTask请求参数结构体
16836
16968
  class ModifyTaskRequest < TencentCloud::Common::AbstractModel
16837
- # @param TaskId: 任务ID
16969
+ # @param TaskId: 任务ID。在[任务管理](https://console.cloud.tencent.com/tsf/tct?rid=1)列表页查看任务ID。
16838
16970
  # @type TaskId: String
16839
- # @param TaskName: 任务名称
16971
+ # @param TaskName: 任务名称,长度限制为64字符。在任务管理列表页面第一列或是任务基本信息页查看任务名称。
16840
16972
  # @type TaskName: String
16841
- # @param TaskType: 任务类型
16973
+ # @param TaskType: 任务类型。当前只支持一种任务类型。枚举值,java:Java类任务
16842
16974
  # @type TaskType: String
16843
- # @param TaskContent: 任务内容
16975
+ # @param TaskContent: 任务内容,长度限制为 65536 字节
16844
16976
  # @type TaskContent: String
16845
- # @param ExecuteType: 任务执行类型
16977
+ # @param ExecuteType: 任务执行方式,枚举值。unicast:随机单节点执行,broadcast:广播执行,shard:分片执行
16846
16978
  # @type ExecuteType: String
16847
16979
  # @param TaskRule: 触发规则
16848
16980
  # @type TaskRule: :class:`Tencentcloud::Tsf.v20180326.models.TaskRule`
16849
- # @param TimeOut: 超时时间,单位 ms
16981
+ # @param TimeOut: 超时时间,取值大于0,单位:毫秒(ms
16850
16982
  # @type TimeOut: Integer
16851
- # @param GroupId: 分组ID
16983
+ # @param GroupId: 部署组ID。在[应用管理](https://console.cloud.tencent.com/tsf/app?rid=1),点击应用ID进入应用部署页查看部署组ID。
16852
16984
  # @type GroupId: String
16853
- # @param ShardCount: 分片数量
16985
+ # @param ShardCount: 分片数量,取值范围2~1000
16854
16986
  # @type ShardCount: Integer
16855
16987
  # @param ShardArguments: 分片参数
16856
16988
  # @type ShardArguments: Array
@@ -16858,15 +16990,15 @@ module TencentCloud
16858
16990
  # @type AdvanceSettings: :class:`Tencentcloud::Tsf.v20180326.models.AdvanceSettings`
16859
16991
  # @param SuccessOperator: 判断任务成功的操作符 GT/GTE
16860
16992
  # @type SuccessOperator: String
16861
- # @param SuccessRatio: 判断任务成功率的阈值
16993
+ # @param SuccessRatio: 判断任务成功率的阈值,取值范围:1-100,单位:百分比(%)
16862
16994
  # @type SuccessRatio: Integer
16863
- # @param RetryCount: 重试次数
16995
+ # @param RetryCount: 重试次数,取值范围 0 - 10,单位:次
16864
16996
  # @type RetryCount: Integer
16865
- # @param RetryInterval: 重试间隔
16997
+ # @param RetryInterval: 重试间隔,取值范围 0-600,单位:秒(s)
16866
16998
  # @type RetryInterval: Integer
16867
16999
  # @param TaskArgument: 任务参数,长度限制10000个字符
16868
17000
  # @type TaskArgument: String
16869
- # @param ProgramIdList:
17001
+ # @param ProgramIdList: 数据集列表。
16870
17002
  # @type ProgramIdList: Array
16871
17003
 
16872
17004
  attr_accessor :TaskId, :TaskName, :TaskType, :TaskContent, :ExecuteType, :TaskRule, :TimeOut, :GroupId, :ShardCount, :ShardArguments, :AdvanceSettings, :SuccessOperator, :SuccessRatio, :RetryCount, :RetryInterval, :TaskArgument, :ProgramIdList
@@ -16927,7 +17059,7 @@ module TencentCloud
16927
17059
 
16928
17060
  # ModifyTask返回参数结构体
16929
17061
  class ModifyTaskResponse < TencentCloud::Common::AbstractModel
16930
- # @param Result: 更新是否成功
17062
+ # @param Result: 更新是否成功。true:操作成功、false:操作失败
16931
17063
  # @type Result: Boolean
16932
17064
  # @param RequestId: 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
16933
17065
  # @type RequestId: String
@@ -16947,9 +17079,9 @@ module TencentCloud
16947
17079
 
16948
17080
  # ModifyUploadInfo请求参数结构体
16949
17081
  class ModifyUploadInfoRequest < TencentCloud::Common::AbstractModel
16950
- # @param ApplicationId: 应用ID
17082
+ # @param ApplicationId: 应用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)时的返回值
16951
17083
  # @type ApplicationId: String
16952
- # @param PkgId: 调用DescribeUploadInfo接口时返回的软件包ID
17084
+ # @param PkgId: 软件包ID可通过调用DescribeUploadInfo接口时[获取上传程序包信息](https://cloud.tencent.com/document/api/649/36078)返回的COS上传信息获取,登录[控制台](https://console.cloud.tencent.com/tsf/product?rid=1)进行查看
16953
17085
  # @type PkgId: String
16954
17086
  # @param Result: COS返回上传结果(默认为0:成功,其他值表示失败)
16955
17087
  # @type Result: Integer
@@ -16959,7 +17091,7 @@ module TencentCloud
16959
17091
  # @type Size: Integer
16960
17092
  # @param RepositoryType: 程序包仓库类型
16961
17093
  # @type RepositoryType: String
16962
- # @param RepositoryId: 程序包仓库id
17094
+ # @param RepositoryId: 仓库ID,可通过调用[仓库信息查询类](https://cloud.tencent.com/document/api/649/45925)接口时出参中的RepositoryId,或登录[控制台](https://console.cloud.tencent.com/tsf/product?rid=1)进行查看
16963
17095
  # @type RepositoryId: String
16964
17096
 
16965
17097
  attr_accessor :ApplicationId, :PkgId, :Result, :Md5, :Size, :RepositoryType, :RepositoryId
@@ -17343,9 +17475,11 @@ module TencentCloud
17343
17475
 
17344
17476
  # OperateApplicationTcrBinding请求参数结构体
17345
17477
  class OperateApplicationTcrBindingRequest < TencentCloud::Common::AbstractModel
17346
- # @param Command: bind 或 unbind
17478
+ # @param Command: 指定操作类型,目前支持:
17479
+ # - `bind`:绑定(默认)
17480
+ # - `unbind`:解除绑定
17347
17481
  # @type Command: String
17348
- # @param ApplicationId: 应用id
17482
+ # @param ApplicationId: 应用ID,可通过调用[DescribeApplications](https://cloud.tencent.com/document/api/649/36090)查询已创建的应用列表或登录控制台进行查看;也可以调用[CreateApplication](https://cloud.tencent.com/document/api/649/36094)创建新的应用。
17349
17483
  # @type ApplicationId: String
17350
17484
  # @param TcrRepoInfo: TcrRepoInfo值
17351
17485
  # @type TcrRepoInfo: :class:`Tencentcloud::Tsf.v20180326.models.TcrRepoInfo`
@@ -17734,7 +17868,7 @@ module TencentCloud
17734
17868
  class Ports < TencentCloud::Common::AbstractModel
17735
17869
  # @param TargetPort: 服务端口
17736
17870
  # @type TargetPort: Integer
17737
- # @param Protocol: 端口协议
17871
+ # @param Protocol: 端口协议,TCP或者UDP
17738
17872
  # @type Protocol: String
17739
17873
 
17740
17874
  attr_accessor :TargetPort, :Protocol
@@ -17801,7 +17935,7 @@ module TencentCloud
17801
17935
 
17802
17936
  # tsf-privilege模块,数据项
17803
17937
  class ProgramItem < TencentCloud::Common::AbstractModel
17804
- # @param ProgramItemId: 数据项ID
17938
+ # @param ProgramItemId: 数据项ID,调用[DescribePrograms](https://console.cloud.tencent.com/tsf/privilege?rid=1&tab=program)接口查询已创建的数据集或登陆控制台进行查看;也可以通过调用[CreateProgram](https://cloud.tencent.com/document/api/649/108544)创建新的数据集。
17805
17939
  # @type ProgramItemId: String
17806
17940
  # @param Resource: 资源
17807
17941
  # @type Resource: :class:`Tencentcloud::Tsf.v20180326.models.Resource`
@@ -17809,13 +17943,13 @@ module TencentCloud
17809
17943
  # @type ValueList: Array
17810
17944
  # @param IsAll: 全选标识,true: 全选;false: 非全选
17811
17945
  # @type IsAll: Boolean
17812
- # @param CreationTime: 创建时间
17946
+ # @param CreationTime: 创建时间,时间戳格式【Long】
17813
17947
  # @type CreationTime: Integer
17814
- # @param LastUpdateTime: 最后更新时间
17948
+ # @param LastUpdateTime: 最后更新时间,时间戳格式【Long】,单位毫秒
17815
17949
  # @type LastUpdateTime: Integer
17816
17950
  # @param DeleteFlag: 删除标识,true: 可删除;false: 不可删除
17817
17951
  # @type DeleteFlag: Boolean
17818
- # @param ProgramId: 数据集ID
17952
+ # @param ProgramId: 数据集ID,调用[DescribePrograms](https://console.cloud.tencent.com/tsf/privilege?rid=1&tab=program)查询接口获取
17819
17953
  # @type ProgramId: String
17820
17954
 
17821
17955
  attr_accessor :ProgramItemId, :Resource, :ValueList, :IsAll, :CreationTime, :LastUpdateTime, :DeleteFlag, :ProgramId
@@ -17981,9 +18115,9 @@ module TencentCloud
17981
18115
 
17982
18116
  # RedoTaskBatch请求参数结构体
17983
18117
  class RedoTaskBatchRequest < TencentCloud::Common::AbstractModel
17984
- # @param TaskId: 任务ID
18118
+ # @param TaskId: 任务ID。在[任务管理](https://console.cloud.tencent.com/tsf/tct?rid=1)列表页查看任务ID。
17985
18119
  # @type TaskId: String
17986
- # @param BatchId: 批次ID
18120
+ # @param BatchId: 任务批次ID。在[任务管理](https://console.cloud.tencent.com/tsf/tct?rid=1)页面点击任务ID进入任务详情,进入执行记录列表页,第一列即为任务批次ID。
17987
18121
  # @type BatchId: String
17988
18122
 
17989
18123
  attr_accessor :TaskId, :BatchId
@@ -18001,7 +18135,7 @@ module TencentCloud
18001
18135
 
18002
18136
  # RedoTaskBatch返回参数结构体
18003
18137
  class RedoTaskBatchResponse < TencentCloud::Common::AbstractModel
18004
- # @param Result: 批次ID
18138
+ # @param Result: 批次流水ID
18005
18139
  # @type Result: String
18006
18140
  # @param RequestId: 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
18007
18141
  # @type RequestId: String
@@ -18021,11 +18155,11 @@ module TencentCloud
18021
18155
 
18022
18156
  # RedoTaskExecute请求参数结构体
18023
18157
  class RedoTaskExecuteRequest < TencentCloud::Common::AbstractModel
18024
- # @param BatchId: 任务批次ID
18158
+ # @param BatchId: 任务批次ID。在[任务管理](https://console.cloud.tencent.com/tsf/tct?rid=1)页面第一列点击任务ID进入任务详情,进入执行记录列表页,第一列内容即为任务批次ID。
18025
18159
  # @type BatchId: String
18026
- # @param ExecuteId: 任务执行ID
18160
+ # @param ExecuteId: 任务执行ID。在[任务管理](https://console.cloud.tencent.com/tsf/tct?rid=1)页面第一列点击任务ID进入任务详情,进入执行记录页,点击批次ID进入执行详情列表页,第一列即为任务执行ID。
18027
18161
  # @type ExecuteId: String
18028
- # @param TaskId: 任务ID
18162
+ # @param TaskId: 任务ID。在[任务管理](https://console.cloud.tencent.com/tsf/tct?rid=1)列表页查看任务ID。
18029
18163
  # @type TaskId: String
18030
18164
 
18031
18165
  attr_accessor :BatchId, :ExecuteId, :TaskId
@@ -18045,7 +18179,7 @@ module TencentCloud
18045
18179
 
18046
18180
  # RedoTaskExecute返回参数结构体
18047
18181
  class RedoTaskExecuteResponse < TencentCloud::Common::AbstractModel
18048
- # @param Result: 成功失败
18182
+ # @param Result: 成功返回执行批次流水ID。失败返回空字符串。
18049
18183
  # @type Result: String
18050
18184
  # @param RequestId: 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
18051
18185
  # @type RequestId: String
@@ -18065,7 +18199,7 @@ module TencentCloud
18065
18199
 
18066
18200
  # RedoTaskFlowBatch请求参数结构体
18067
18201
  class RedoTaskFlowBatchRequest < TencentCloud::Common::AbstractModel
18068
- # @param FlowBatchId: 工作流批次 ID
18202
+ # @param FlowBatchId: 工作流批次 ID。在[工作流管理](https://console.cloud.tencent.com/tsf/tct?rid=1&tab=workflowManage)页面,点击第一列的工作流ID进入工作流执行记录列表页面,第一列的内容即为工作流批次ID。
18069
18203
  # @type FlowBatchId: String
18070
18204
 
18071
18205
  attr_accessor :FlowBatchId
@@ -18081,7 +18215,7 @@ module TencentCloud
18081
18215
 
18082
18216
  # RedoTaskFlowBatch返回参数结构体
18083
18217
  class RedoTaskFlowBatchResponse < TencentCloud::Common::AbstractModel
18084
- # @param Result: 工作流批次历史 ID
18218
+ # @param Result: 工作流批次历史 ID。操作失败时不返回该字段,返回错误码。
18085
18219
  # @type Result: String
18086
18220
  # @param RequestId: 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
18087
18221
  # @type RequestId: String
@@ -18101,7 +18235,7 @@ module TencentCloud
18101
18235
 
18102
18236
  # RedoTask请求参数结构体
18103
18237
  class RedoTaskRequest < TencentCloud::Common::AbstractModel
18104
- # @param TaskId: 任务ID
18238
+ # @param TaskId: 任务ID。在[任务管理](https://console.cloud.tencent.com/tsf/tct?rid=1)列表页查看任务ID。
18105
18239
  # @type TaskId: String
18106
18240
 
18107
18241
  attr_accessor :TaskId
@@ -18117,7 +18251,7 @@ module TencentCloud
18117
18251
 
18118
18252
  # RedoTask返回参数结构体
18119
18253
  class RedoTaskResponse < TencentCloud::Common::AbstractModel
18120
- # @param Result: 操作成功or失败
18254
+ # @param Result: 操作成功任务批次ID。操作失败返回空字符串。
18121
18255
  # @type Result: String
18122
18256
  # @param RequestId: 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
18123
18257
  # @type RequestId: String
@@ -18173,11 +18307,11 @@ module TencentCloud
18173
18307
 
18174
18308
  # ReleaseConfig请求参数结构体
18175
18309
  class ReleaseConfigRequest < TencentCloud::Common::AbstractModel
18176
- # @param ConfigId: 配置ID
18310
+ # @param ConfigId: 配置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)创建新的配置。
18177
18311
  # @type ConfigId: String
18178
- # @param GroupId: 部署组ID
18312
+ # @param GroupId: 部署组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)创建新的部署组。
18179
18313
  # @type GroupId: String
18180
- # @param ReleaseDesc: 发布描述
18314
+ # @param ReleaseDesc: 发布描述,最多支持200个字符。
18181
18315
  # @type ReleaseDesc: String
18182
18316
 
18183
18317
  attr_accessor :ConfigId, :GroupId, :ReleaseDesc
@@ -18197,7 +18331,9 @@ module TencentCloud
18197
18331
 
18198
18332
  # ReleaseConfig返回参数结构体
18199
18333
  class ReleaseConfigResponse < TencentCloud::Common::AbstractModel
18200
- # @param Result: true:发布成功;false:发布失败
18334
+ # @param Result: 发布结果。
18335
+ # - true:发布成功
18336
+ # - false:发布失败
18201
18337
  # @type Result: Boolean
18202
18338
  # @param RequestId: 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
18203
18339
  # @type RequestId: String
@@ -18217,11 +18353,11 @@ module TencentCloud
18217
18353
 
18218
18354
  # ReleaseConfigWithDetailResp请求参数结构体
18219
18355
  class ReleaseConfigWithDetailRespRequest < TencentCloud::Common::AbstractModel
18220
- # @param ConfigId: 配置ID
18356
+ # @param ConfigId: 配置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)创建新的配置。
18221
18357
  # @type ConfigId: String
18222
- # @param GroupId: 部署组ID
18358
+ # @param GroupId: 部署组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)创建新的部署组。
18223
18359
  # @type GroupId: String
18224
- # @param ReleaseDesc: 发布描述
18360
+ # @param ReleaseDesc: 发布描述,最多支持200个字符。
18225
18361
  # @type ReleaseDesc: String
18226
18362
 
18227
18363
  attr_accessor :ConfigId, :GroupId, :ReleaseDesc
@@ -18241,7 +18377,7 @@ module TencentCloud
18241
18377
 
18242
18378
  # ReleaseConfigWithDetailResp返回参数结构体
18243
18379
  class ReleaseConfigWithDetailRespResponse < TencentCloud::Common::AbstractModel
18244
- # @param Result: 配置项发布 ID
18380
+ # @param Result: 配置项发布ID
18245
18381
  # @type Result: :class:`Tencentcloud::Tsf.v20180326.models.ConfigRelease`
18246
18382
  # @param RequestId: 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
18247
18383
  # @type RequestId: String
@@ -18264,11 +18400,11 @@ module TencentCloud
18264
18400
 
18265
18401
  # ReleaseFileConfig请求参数结构体
18266
18402
  class ReleaseFileConfigRequest < TencentCloud::Common::AbstractModel
18267
- # @param ConfigId: 配置ID
18403
+ # @param ConfigId: 配置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)创建新的配置。
18268
18404
  # @type ConfigId: String
18269
- # @param GroupId: 部署组ID
18405
+ # @param GroupId: 部署组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)创建新的部署组。
18270
18406
  # @type GroupId: String
18271
- # @param ReleaseDesc: 发布描述
18407
+ # @param ReleaseDesc: 发布描述,最多支持200个字符。
18272
18408
  # @type ReleaseDesc: String
18273
18409
 
18274
18410
  attr_accessor :ConfigId, :GroupId, :ReleaseDesc
@@ -18288,7 +18424,9 @@ module TencentCloud
18288
18424
 
18289
18425
  # ReleaseFileConfig返回参数结构体
18290
18426
  class ReleaseFileConfigResponse < TencentCloud::Common::AbstractModel
18291
- # @param Result: 发布结果,成功:true,失败:false。
18427
+ # @param Result: 发布结果。
18428
+ # - true:成功
18429
+ # - false:失败
18292
18430
  # @type Result: Boolean
18293
18431
  # @param RequestId: 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
18294
18432
  # @type RequestId: String
@@ -18308,11 +18446,11 @@ module TencentCloud
18308
18446
 
18309
18447
  # ReleasePublicConfig请求参数结构体
18310
18448
  class ReleasePublicConfigRequest < TencentCloud::Common::AbstractModel
18311
- # @param ConfigId: 配置ID
18449
+ # @param ConfigId: 配置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)创建新的配置。
18312
18450
  # @type ConfigId: String
18313
- # @param NamespaceId: 命名空间ID
18451
+ # @param NamespaceId: 命名空间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)创建新的命名空间。
18314
18452
  # @type NamespaceId: String
18315
- # @param ReleaseDesc: 发布描述
18453
+ # @param ReleaseDesc: 发布描述,最多支持200个字符。
18316
18454
  # @type ReleaseDesc: String
18317
18455
 
18318
18456
  attr_accessor :ConfigId, :NamespaceId, :ReleaseDesc
@@ -18332,7 +18470,9 @@ module TencentCloud
18332
18470
 
18333
18471
  # ReleasePublicConfig返回参数结构体
18334
18472
  class ReleasePublicConfigResponse < TencentCloud::Common::AbstractModel
18335
- # @param Result: true:发布成功;false:发布失败
18473
+ # @param Result: 发布结果。
18474
+ # - true:发布成功
18475
+ # - false:发布失败
18336
18476
  # @type Result: Boolean
18337
18477
  # @param RequestId: 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
18338
18478
  # @type RequestId: String
@@ -18352,7 +18492,7 @@ module TencentCloud
18352
18492
 
18353
18493
  # RemoveInstances请求参数结构体
18354
18494
  class RemoveInstancesRequest < TencentCloud::Common::AbstractModel
18355
- # @param ClusterId: 集群 ID
18495
+ # @param ClusterId: 集群 ID。调用[DescribeSimpleClusters](https://cloud.tencent.com/document/api/649/36047)查询已创建的集群或通过[CreateCluster](https://cloud.tencent.com/document/api/649/36049)接口创建新的集群。
18356
18496
  # @type ClusterId: String
18357
18497
  # @param InstanceIdList: 云主机 ID 列表
18358
18498
  # @type InstanceIdList: Array
@@ -18467,25 +18607,25 @@ module TencentCloud
18467
18607
 
18468
18608
  # tsf-privilege 模块,资源
18469
18609
  class Resource < TencentCloud::Common::AbstractModel
18470
- # @param ResourceId: 资源ID
18610
+ # @param ResourceId: 资源ID,调用[DescribeResource](https://console.cloud.tencent.com/tsf/privilege-program-create?rid=1)查询接口获取
18471
18611
  # @type ResourceId: String
18472
- # @param ResourceCode: 资源编码
18612
+ # @param ResourceCode: 资源编码,枚举值描述【cluster、namespace、config】
18473
18613
  # @type ResourceCode: String
18474
18614
  # @param ResourceName: 资源名称
18475
18615
  # @type ResourceName: String
18476
- # @param ServiceCode: 资源所属产品编码
18616
+ # @param ServiceCode: 资源所属产品编码,枚举值描述【tsf】
18477
18617
  # @type ServiceCode: String
18478
- # @param ResourceAction: 选取资源使用的Action
18618
+ # @param ResourceAction: 选取资源使用的Action,枚举值描述【DescribeSimpleCluster、DescribeLanes、DescribeTaskRecords】
18479
18619
  # @type ResourceAction: String
18480
- # @param IdField: 资源数据查询的ID字段名
18620
+ # @param IdField: 资源数据查询的ID字段名,调用[DescribeResource](https://console.cloud.tencent.com/tsf/privilege-program-create?rid=1)查询接口获取
18481
18621
  # @type IdField: String
18482
18622
  # @param NameField: 资源数据查询的名称字段名
18483
18623
  # @type NameField: String
18484
18624
  # @param SelectIdsField: 资源数据查询的ID过滤字段名
18485
18625
  # @type SelectIdsField: String
18486
- # @param CreationTime: 创建时间
18626
+ # @param CreationTime: 创建时间,时间戳格式【Long】
18487
18627
  # @type CreationTime: Integer
18488
- # @param LastUpdateTime: 最后更新时间
18628
+ # @param LastUpdateTime: 最后更新时间,时间戳格式【Long】
18489
18629
  # @type LastUpdateTime: Integer
18490
18630
  # @param DeleteFlag: 删除标识
18491
18631
  # @type DeleteFlag: Boolean
@@ -18495,7 +18635,7 @@ module TencentCloud
18495
18635
  # @type CanSelectAll: Boolean
18496
18636
  # @param SearchWordField: 资源数据查询的模糊查询字段名
18497
18637
  # @type SearchWordField: String
18498
- # @param Index: 排序
18638
+ # @param Index: 排序,枚举值描述【10、20、77】
18499
18639
  # @type Index: Integer
18500
18640
 
18501
18641
  attr_accessor :ResourceId, :ResourceCode, :ResourceName, :ServiceCode, :ResourceAction, :IdField, :NameField, :SelectIdsField, :CreationTime, :LastUpdateTime, :DeleteFlag, :ResourceDesc, :CanSelectAll, :SearchWordField, :Index
@@ -18555,7 +18695,10 @@ module TencentCloud
18555
18695
 
18556
18696
  # 资源任务转态结果
18557
18697
  class ResourceTaskStatusResult < TencentCloud::Common::AbstractModel
18558
- # @param TaskStatus: 任务的执行状态
18698
+ # @param TaskStatus: 变更状态:
18699
+ # - `0`:成功
18700
+ # - `1`:失败
18701
+ # - `2`:执行中
18559
18702
  # @type TaskStatus: Integer
18560
18703
 
18561
18704
  attr_accessor :TaskStatus
@@ -18571,7 +18714,7 @@ module TencentCloud
18571
18714
 
18572
18715
  # RevocationConfig请求参数结构体
18573
18716
  class RevocationConfigRequest < TencentCloud::Common::AbstractModel
18574
- # @param ConfigReleaseId: 配置项发布ID
18717
+ # @param ConfigReleaseId: 配置项发布ID。该参数可以通过调用 [DescribeConfigReleases](https://cloud.tencent.com/document/product/649/38342) 的返回值中的 ConfigReleaseId 字段来获取或通过登录[控制台](https://console.cloud.tencent.com/tse/tsf-consul?subTab=app)配置详情-发布情况页查看。
18575
18718
  # @type ConfigReleaseId: String
18576
18719
 
18577
18720
  attr_accessor :ConfigReleaseId
@@ -18587,7 +18730,9 @@ module TencentCloud
18587
18730
 
18588
18731
  # RevocationConfig返回参数结构体
18589
18732
  class RevocationConfigResponse < TencentCloud::Common::AbstractModel
18590
- # @param Result: true:回滚成功;false:回滚失败
18733
+ # @param Result: 撤回结果。
18734
+ # - true:成功
18735
+ # - false:失败
18591
18736
  # @type Result: Boolean
18592
18737
  # @param RequestId: 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
18593
18738
  # @type RequestId: String
@@ -18643,7 +18788,7 @@ module TencentCloud
18643
18788
 
18644
18789
  # RevokeFileConfig请求参数结构体
18645
18790
  class RevokeFileConfigRequest < TencentCloud::Common::AbstractModel
18646
- # @param ConfigReleaseId: 配置项发布ID
18791
+ # @param ConfigReleaseId: 按照【配置项发布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)发布文件配置。
18647
18792
  # @type ConfigReleaseId: String
18648
18793
 
18649
18794
  attr_accessor :ConfigReleaseId
@@ -18679,9 +18824,9 @@ module TencentCloud
18679
18824
 
18680
18825
  # RollbackConfig请求参数结构体
18681
18826
  class RollbackConfigRequest < TencentCloud::Common::AbstractModel
18682
- # @param ConfigReleaseLogId: 配置项发布历史ID
18827
+ # @param ConfigReleaseLogId: 配置项发布历史ID。该参数可以通过调用 [DescribeConfigReleaseLogs](https://cloud.tencent.com/document/product/649/38343) 的返回值中的 ConfigReleaseLogId 字段来获取或通过登录[控制台](https://console.cloud.tencent.com/tse/tsf-consul?subTab=app)配置详情-发布情况页查看。
18683
18828
  # @type ConfigReleaseLogId: String
18684
- # @param ReleaseDesc: 回滚描述
18829
+ # @param ReleaseDesc: 回滚描述,最多支持200个字符。
18685
18830
  # @type ReleaseDesc: String
18686
18831
 
18687
18832
  attr_accessor :ConfigReleaseLogId, :ReleaseDesc
@@ -18699,7 +18844,9 @@ module TencentCloud
18699
18844
 
18700
18845
  # RollbackConfig返回参数结构体
18701
18846
  class RollbackConfigResponse < TencentCloud::Common::AbstractModel
18702
- # @param Result: true:回滚成功;false:回滚失败
18847
+ # @param Result: 回滚结果。
18848
+ # - true:回滚成功
18849
+ # - false:回滚失败
18703
18850
  # @type Result: Boolean
18704
18851
  # @param RequestId: 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
18705
18852
  # @type RequestId: String
@@ -18866,12 +19013,13 @@ module TencentCloud
18866
19013
  # SearchBusinessLog请求参数结构体
18867
19014
  class SearchBusinessLogRequest < TencentCloud::Common::AbstractModel
18868
19015
  # @param ConfigId: 日志配置项ID
19016
+ # 可通过调用[DescribeBusinessLogConfigs](https://cloud.tencent.com/document/product/649/75777)查询已创建的日志配置项列表或登录[控制台](https://console.cloud.tencent.com/tsf/observable/log?rid=1)进行查看
18869
19017
  # @type ConfigId: String
18870
19018
  # @param InstanceIds: 机器实例ID,不传表示全部实例
18871
19019
  # @type InstanceIds: Array
18872
- # @param StartTime: 开始时间
19020
+ # @param StartTime: 开始时间,格式yyyy-MM-dd HH:mm:ss
18873
19021
  # @type StartTime: String
18874
- # @param EndTime: 结束时间
19022
+ # @param EndTime: 结束时间,格式yyyy-MM-dd HH:mm:ss
18875
19023
  # @type EndTime: String
18876
19024
  # @param Offset: 请求偏移量,取值范围大于等于0,默认值为0
18877
19025
  # @type Offset: Integer
@@ -18884,10 +19032,11 @@ module TencentCloud
18884
19032
  # @param SearchWords: 检索关键词
18885
19033
  # @type SearchWords: Array
18886
19034
  # @param GroupIds: 部署组ID列表,不传表示全部部署组
19035
+ # 可通过调用[DescribeContainerGroups](https://cloud.tencent.com/document/product/649/36068)或[DescribeGroups](https://cloud.tencent.com/document/product/649/36065)查询已创建的部署组列表或登录[控制台](https://console.cloud.tencent.com/tsf/app-detail?rid=1&id=application-yo7kp9dv&tab=publish&subTab=group)进行查看
18887
19036
  # @type GroupIds: Array
18888
- # @param SearchWordType: 检索类型,取值"LUCENE", "REGEXP", "NORMAL"
19037
+ # @param SearchWordType: 检索类型,取值 LUCENE:Lucene检索,REGEXP:正则检索,NORMAL:普通检索
18889
19038
  # @type SearchWordType: String
18890
- # @param BatchType: 批量请求类型,取值"page"或"scroll"
19039
+ # @param BatchType: 批量请求类型,取值 PAGE:分页查询,SCROLL:滚动查询,SEARCHAFTER:游标查询,默认值PAGE
18891
19040
  # @type BatchType: String
18892
19041
  # @param ScrollId: 游标ID
18893
19042
  # @type ScrollId: String
@@ -18956,31 +19105,32 @@ module TencentCloud
18956
19105
 
18957
19106
  # SearchStdoutLog请求参数结构体
18958
19107
  class SearchStdoutLogRequest < TencentCloud::Common::AbstractModel
18959
- # @param InstanceId: 机器实例ID, 和 实例 ID 二者必选其一,不能同时为空
19108
+ # @param InstanceId: 机器实例ID, 和 部署组 ID 二者必选其一,不能同时为空
19109
+ # 可通过调用[DescribeClusterInstances](https://cloud.tencent.com/document/product/649/36048)查询已导入的实例列表或登录[控制台](https://console.cloud.tencent.com/tsf/resource?rid=1&tab=instance)进行查询。实例ID例如:ins-6decplwk
19110
+
19111
+
18960
19112
  # @type InstanceId: String
18961
19113
  # @param Limit: 单页请求配置数量,取值范围[1, 500],默认值为100
18962
19114
  # @type Limit: Integer
18963
19115
  # @param SearchWords: 检索关键词
18964
19116
  # @type SearchWords: Array
18965
- # @param StartTime: 查询起始时间
19117
+ # @param StartTime: 查询起始时间,格式yyyy-MM-dd HH:mm:ss
18966
19118
  # @type StartTime: String
18967
19119
  # @param GroupId: 部署组ID,和 InstanceId 二者必选其一,不能同时为空
19120
+ # 可通过调用[DescribeContainerGroups](https://cloud.tencent.com/document/product/649/36068)或[DescribeGroups](https://cloud.tencent.com/document/product/649/36065)查询已创建的部署组列表或登录[控制台](https://console.cloud.tencent.com/tsf/app-detail?rid=1&id=application-yo7kp9dv&tab=publish&subTab=group)进行查看
18968
19121
  # @type GroupId: String
18969
- # @param EndTime: 查询结束时间
19122
+ # @param EndTime: 查询结束时间,格式yyyy-MM-dd HH:mm:ss
18970
19123
  # @type EndTime: String
18971
19124
  # @param Offset: 请求偏移量,取值范围大于等于0,默认值为
18972
19125
  # 0
18973
19126
  # @type Offset: Integer
18974
- # @param OrderBy: 排序规则,默认值"time"
19127
+ # @param OrderBy: 排序规则,time:按时间排序,score:按检索值排序,默认值"time"
18975
19128
  # @type OrderBy: String
18976
- # @param OrderType: 排序方式,取值"asc""desc",默认
18977
- # 值"desc"
19129
+ # @param OrderType: 排序方式,取值 asc:升序 desc:降序,默认值desc
18978
19130
  # @type OrderType: String
18979
- # @param SearchWordType: 检索类型,取值"LUCENE", "REGEXP",
18980
- # "NORMAL"
19131
+ # @param SearchWordType: 检索类型,取值 LUCENE:Lucene检索,REGEXP:正则检索,NORMAL:普通检索
18981
19132
  # @type SearchWordType: String
18982
- # @param BatchType: 批量请求类型,取值"page"或"scroll",默认
18983
- # 值"page"
19133
+ # @param BatchType: 批量请求类型,取值 PAGE:分页查询,SCROLL:滚动查询,SEARCHAFTER:游标查询,默认值PAGE
18984
19134
  # @type BatchType: String
18985
19135
  # @param ScrollId: 游标ID
18986
19136
  # @type ScrollId: String
@@ -19083,7 +19233,7 @@ module TencentCloud
19083
19233
  class ServiceGovernanceConfig < TencentCloud::Common::AbstractModel
19084
19234
  # @param EnableGovernance: 是否开启服务注册治理
19085
19235
  # @type EnableGovernance: Boolean
19086
- # @param GovernanceType: 服务治理类型(枚举:SHAREEXCLUSIVE
19236
+ # @param GovernanceType: 服务治理类型(枚举:SHARE表示共享型、EXCLUSIVE表示独占型)
19087
19237
  # @type GovernanceType: String
19088
19238
  # @param ExclusiveInstances: 独享实例列表
19089
19239
  # 注意:此字段可能返回 null,表示取不到有效值。
@@ -19137,7 +19287,7 @@ module TencentCloud
19137
19287
  # @type ExternalTrafficPolicy: String
19138
19288
  # @param LoadBalancerProvisioner: 负载均衡提供者
19139
19289
  # @type LoadBalancerProvisioner: String
19140
- # @param LoadBalancingType: 负载均衡类型
19290
+ # @param LoadBalancingType: 负载均衡类型,Intranet表示内网,Internet表示外网
19141
19291
  # @type LoadBalancingType: String
19142
19292
  # @param ClusterIp: k8s负载均衡内网vip
19143
19293
  # @type ClusterIp: String
@@ -19224,7 +19374,7 @@ module TencentCloud
19224
19374
  # @type Path: String
19225
19375
  # @param Method: 请求方法:type为接口时返回,服务时不返回
19226
19376
  # @type Method: String
19227
- # @param MicroserviceId: 微服务Id
19377
+ # @param MicroserviceId: 微服务ID
19228
19378
  # @type MicroserviceId: String
19229
19379
  # @param MicroserviceName: 微服务名称
19230
19380
  # @type MicroserviceName: String
@@ -19240,19 +19390,19 @@ module TencentCloud
19240
19390
  # @type InstanceId: String
19241
19391
  # @param InstanceName: 实例name
19242
19392
  # @type InstanceName: String
19243
- # @param GroupId: 部署组id
19393
+ # @param GroupId: 部署组ID
19244
19394
  # @type GroupId: String
19245
19395
  # @param GroupName: 部署组name
19246
19396
  # @type GroupName: String
19247
- # @param ClusterType: 部署组类型
19397
+ # @param ClusterType: 集群类型,C:容器集群,V:虚拟机集群
19248
19398
  # @type ClusterType: String
19249
19399
  # @param GroupExist: 部署组是否存在
19250
19400
  # @type GroupExist: Integer
19251
19401
  # @param InstanceExist: 实例是否存在,仅限cvm
19252
19402
  # @type InstanceExist: Integer
19253
- # @param ApplicationId: 应用id
19403
+ # @param ApplicationId: 应用ID
19254
19404
  # @type ApplicationId: String
19255
- # @param MicroserviceType: 微服务类型
19405
+ # @param MicroserviceType: 微服务类型。RAW:裸应用,M:mesh应用,N:普通应用,G:网关应用
19256
19406
  # @type MicroserviceType: String
19257
19407
  # @param CpuPercent: cpu使用率
19258
19408
  # @type CpuPercent: Integer
@@ -19272,13 +19422,13 @@ module TencentCloud
19272
19422
  # @type InstanceOnlineCount: Integer
19273
19423
  # @param InstanceTotalCount: 实例总数
19274
19424
  # @type InstanceTotalCount: Integer
19275
- # @param Status: normal/error
19425
+ # @param Status: 状态。normal:正常,warn:警告,error:错误
19276
19426
  # @type Status: String
19277
- # @param ErrorRateLevel: normal/warn/error
19427
+ # @param ErrorRateLevel: 请求错误率等级。normal:正常,warn:警告,error:错误
19278
19428
  # @type ErrorRateLevel: String
19279
- # @param AvgTimeConsumingLevel: normal/warn/error
19429
+ # @param AvgTimeConsumingLevel: 请求平均耗时等级。normal:正常,warn:警告,error:错误
19280
19430
  # @type AvgTimeConsumingLevel: String
19281
- # @param ApdexLevel: normal/warn/error
19431
+ # @param ApdexLevel: 应用程序性能指数等级。normal:正常,warn:警告,error:错误
19282
19432
  # @type ApdexLevel: String
19283
19433
 
19284
19434
  attr_accessor :Path, :Method, :MicroserviceId, :MicroserviceName, :RequestCount, :ErrorRate, :AvgTimeConsuming, :MetricDataCurves, :InstanceId, :InstanceName, :GroupId, :GroupName, :ClusterType, :GroupExist, :InstanceExist, :ApplicationId, :MicroserviceType, :CpuPercent, :HeapUsed, :DbName, :Script, :DbType, :Apdex, :Qps, :InstanceOnlineCount, :InstanceTotalCount, :Status, :ErrorRateLevel, :AvgTimeConsumingLevel, :ApdexLevel
@@ -19407,7 +19557,7 @@ module TencentCloud
19407
19557
 
19408
19558
  # ShrinkGroup请求参数结构体
19409
19559
  class ShrinkGroupRequest < TencentCloud::Common::AbstractModel
19410
- # @param GroupId: 部署组ID
19560
+ # @param GroupId: 部署组ID,可通过调用[DescribeGroups](https://cloud.tencent.com/document/api/649/36065)查询已创建的部署组列表或登录控制台进行查看;也可以调用[CreateGroup](https://cloud.tencent.com/document/api/649/36074)创建新的部署组。
19411
19561
  # @type GroupId: String
19412
19562
 
19413
19563
  attr_accessor :GroupId
@@ -19446,9 +19596,9 @@ module TencentCloud
19446
19596
 
19447
19597
  # ShrinkInstances请求参数结构体
19448
19598
  class ShrinkInstancesRequest < TencentCloud::Common::AbstractModel
19449
- # @param GroupId: 部署组ID
19599
+ # @param GroupId: 部署组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值
19450
19600
  # @type GroupId: String
19451
- # @param InstanceIdList: 下线机器实例ID列表
19601
+ # @param InstanceIdList: 实例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中的节点列表
19452
19602
  # @type InstanceIdList: Array
19453
19603
 
19454
19604
  attr_accessor :GroupId, :InstanceIdList
@@ -19639,7 +19789,7 @@ module TencentCloud
19639
19789
 
19640
19790
  # StartContainerGroup请求参数结构体
19641
19791
  class StartContainerGroupRequest < TencentCloud::Common::AbstractModel
19642
- # @param GroupId: 部署组ID
19792
+ # @param GroupId: 部署组ID,可通过调用[DescribeContainerGroups](https://cloud.tencent.com/document/api/649/36068)查询已创建的部署组列表或登录控制台进行查看;也可以调用[CreateContainGroup](https://cloud.tencent.com/document/api/649/36075)创建新的部署组。
19643
19793
  # @type GroupId: String
19644
19794
 
19645
19795
  attr_accessor :GroupId
@@ -19720,7 +19870,7 @@ module TencentCloud
19720
19870
  # @type InstanceId: String
19721
19871
  # @param Content: 日志内容
19722
19872
  # @type Content: String
19723
- # @param Timestamp: 日志时间戳
19873
+ # @param Timestamp: 日志时间戳,单位毫秒
19724
19874
  # @type Timestamp: Integer
19725
19875
  # @param InstanceIp: 实例IP
19726
19876
  # @type InstanceIp: String
@@ -19744,7 +19894,7 @@ module TencentCloud
19744
19894
 
19745
19895
  # StopContainerGroup请求参数结构体
19746
19896
  class StopContainerGroupRequest < TencentCloud::Common::AbstractModel
19747
- # @param GroupId: 部署组ID
19897
+ # @param GroupId: 部署组ID,可通过调用[DescribeContainerGroups](https://cloud.tencent.com/document/api/649/36068)查询已创建的部署组列表或登录控制台进行查看;也可以调用[CreateContainGroup](https://cloud.tencent.com/document/api/649/36075)创建新的部署组。
19748
19898
  # @type GroupId: String
19749
19899
 
19750
19900
  attr_accessor :GroupId
@@ -19821,9 +19971,9 @@ module TencentCloud
19821
19971
 
19822
19972
  # StopTaskBatch请求参数结构体
19823
19973
  class StopTaskBatchRequest < TencentCloud::Common::AbstractModel
19824
- # @param BatchId: 批次ID
19974
+ # @param BatchId: 任务批次ID。在[任务管理](https://console.cloud.tencent.com/tsf/tct?rid=1)页面点击任务ID进入任务详情,进入执行记录列表页,第一列即为任务批次ID。
19825
19975
  # @type BatchId: String
19826
- # @param TaskId: 参数ID
19976
+ # @param TaskId: 任务ID。在[任务管理](https://console.cloud.tencent.com/tsf/tct?rid=1)列表页面可以查看任务ID。
19827
19977
  # @type TaskId: String
19828
19978
 
19829
19979
  attr_accessor :BatchId, :TaskId
@@ -19841,7 +19991,7 @@ module TencentCloud
19841
19991
 
19842
19992
  # StopTaskBatch返回参数结构体
19843
19993
  class StopTaskBatchResponse < TencentCloud::Common::AbstractModel
19844
- # @param Result: 操作成功 or 失败
19994
+ # @param Result: 返回 true 或 false。true:操作成功,false:操作失败
19845
19995
  # @type Result: Boolean
19846
19996
  # @param RequestId: 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
19847
19997
  # @type RequestId: String
@@ -19861,11 +20011,11 @@ module TencentCloud
19861
20011
 
19862
20012
  # StopTaskExecute请求参数结构体
19863
20013
  class StopTaskExecuteRequest < TencentCloud::Common::AbstractModel
19864
- # @param ExecuteId: 任务执行ID
20014
+ # @param ExecuteId: 任务执行ID。在[任务管理](https://console.cloud.tencent.com/tsf/tct?rid=1)页面点击任务ID进入任务详情,进入执行记录页,点击批次ID进入执行详情列表页,第一列即为任务执行ID。
19865
20015
  # @type ExecuteId: String
19866
- # @param BatchId: 任务批次ID
20016
+ # @param BatchId: 任务批次ID。在[任务管理](https://console.cloud.tencent.com/tsf/tct?rid=1)页面点击任务ID进入任务详情,进入执行记录列表页,第一列即为任务批次ID。
19867
20017
  # @type BatchId: String
19868
- # @param TaskId: 任务ID
20018
+ # @param TaskId: 任务ID。在[任务管理](https://console.cloud.tencent.com/tsf/tct?rid=1)列表页面可以查看任务ID。
19869
20019
  # @type TaskId: String
19870
20020
 
19871
20021
  attr_accessor :ExecuteId, :BatchId, :TaskId
@@ -19885,7 +20035,7 @@ module TencentCloud
19885
20035
 
19886
20036
  # StopTaskExecute返回参数结构体
19887
20037
  class StopTaskExecuteResponse < TencentCloud::Common::AbstractModel
19888
- # @param Result: 操作成功 or 失败
20038
+ # @param Result: 返回 true 或 false。true:操作成功,false:操作失败
19889
20039
  # @type Result: Boolean
19890
20040
  # @param RequestId: 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
19891
20041
  # @type RequestId: String
@@ -19925,29 +20075,29 @@ module TencentCloud
19925
20075
 
19926
20076
  # 工作流图中的边
19927
20077
  class TaskFlowEdge < TencentCloud::Common::AbstractModel
19928
- # @param NodeId: 节点 ID
20078
+ # @param NodeId: 节点 ID,节点类型为任务时为任务ID,节点类型为逻辑节点"且"时为 AND,为逻辑节点"或"时为 OR,节点类型为头节点时为字符串"head"
19929
20079
  # @type NodeId: String
19930
- # @param ChildNodeId: 子节点 ID
20080
+ # @param ChildNodeId: 子节点 ID,节点类型为任务时为任务ID,节点类型为逻辑节点"且"时为 AND,为逻辑节点"或"时为 OR
19931
20081
  # @type ChildNodeId: String
19932
20082
  # @param CoreNode: 是否核心任务,Y/N
19933
20083
  # @type CoreNode: String
19934
- # @param EdgeType: 边类型
20084
+ # @param EdgeType: 边类型,上下游任务依赖触发关系。一共2个值,Y:成功触发,N:失败触发
19935
20085
  # @type EdgeType: String
19936
- # @param NodeType: 任务节点类型
20086
+ # @param NodeType: 任务节点类型,一共有4种类型,AND:逻辑节点且,OR:逻辑节点或,TASK:任务节点,START:头节点
19937
20087
  # @type NodeType: String
19938
20088
  # @param PositionX: X轴坐标位置
19939
20089
  # @type PositionX: String
19940
20090
  # @param PositionY: Y轴坐标位置
19941
20091
  # @type PositionY: String
19942
- # @param GraphId: 图 ID
20092
+ # @param GraphId: 图 ID,新建工作流时自动生成,不需要填写,查看工作流图时后端返回
19943
20093
  # @type GraphId: String
19944
- # @param FlowId: 工作流 ID
20094
+ # @param FlowId: 工作流 ID,新建工作流时自动生成,不需要填写,查看工作流图时后端返回
19945
20095
  # @type FlowId: String
19946
20096
  # @param NodeName: 节点名称
19947
20097
  # @type NodeName: String
19948
- # @param TaskId: 任务ID
20098
+ # @param TaskId: 任务ID,新建工作流时不需要填写,查看工作流图时后端返回
19949
20099
  # @type TaskId: String
19950
- # @param TaskLogId: 任务历史ID
20100
+ # @param TaskLogId: 任务历史ID,新建工作流时不需要填写,查看工作流图时后端返回
19951
20101
  # @type TaskLogId: String
19952
20102
 
19953
20103
  attr_accessor :NodeId, :ChildNodeId, :CoreNode, :EdgeType, :NodeType, :PositionX, :PositionY, :GraphId, :FlowId, :NodeName, :TaskId, :TaskLogId
@@ -20053,21 +20203,21 @@ module TencentCloud
20053
20203
  # @type TaskName: String
20054
20204
  # @param TaskType: 任务类型
20055
20205
  # @type TaskType: String
20056
- # @param ExecuteType: 执行类型
20206
+ # @param ExecuteType: 任务执行方式,unicast:随机单节点执行,broadcast:广播执行,shard:分片执行
20057
20207
  # @type ExecuteType: String
20058
20208
  # @param TaskContent: 任务内容,长度限制65535字节
20059
20209
  # @type TaskContent: String
20060
20210
  # @param GroupId: 分组ID
20061
20211
  # @type GroupId: String
20062
- # @param TimeOut: 超时时间
20212
+ # @param TimeOut: 超时时间,单位:毫秒。
20063
20213
  # @type TimeOut: Integer
20064
20214
  # @param RetryCount: 重试次数
20065
20215
  # @type RetryCount: Integer
20066
- # @param RetryInterval: 重试间隔
20216
+ # @param RetryInterval: 重试间隔,单位:毫秒。
20067
20217
  # @type RetryInterval: Integer
20068
20218
  # @param TaskRule: 触发规则
20069
20219
  # @type TaskRule: :class:`Tencentcloud::Tsf.v20180326.models.TaskRule`
20070
- # @param TaskState: 是否启用任务,ENABLED/DISABLED
20220
+ # @param TaskState: 任务启用状态。一共2种状态可选,ENABLED:启用,DISABLED:停用
20071
20221
  # @type TaskState: String
20072
20222
  # @param TaskId: 任务ID
20073
20223
  # @type TaskId: String
@@ -20085,7 +20235,7 @@ module TencentCloud
20085
20235
  # @type BelongFlowIds: Array
20086
20236
  # @param TaskLogId: 任务历史ID
20087
20237
  # @type TaskLogId: String
20088
- # @param TriggerType: 触发类型
20238
+ # @param TriggerType: 触发类型,一共3种类型,WorkFlow:工作流触发,Cron:定时触发,FixRate:周期触发
20089
20239
  # @type TriggerType: String
20090
20240
  # @param TaskArgument: 任务参数,长度限制10000个字符
20091
20241
  # @type TaskArgument: String
@@ -20181,7 +20331,7 @@ module TencentCloud
20181
20331
 
20182
20332
  # 任务规则
20183
20333
  class TaskRule < TencentCloud::Common::AbstractModel
20184
- # @param RuleType: 触发规则类型, Cron/Repeat
20334
+ # @param RuleType: 触发规则类型,枚举值。一共3个值,Cron:定时触发,Repeat:周期触发,WorkFlow:工作流触发
20185
20335
  # @type RuleType: String
20186
20336
  # @param Expression: Cron类型规则,cron表达式。
20187
20337
  # @type Expression: String
@@ -20238,7 +20388,7 @@ module TencentCloud
20238
20388
 
20239
20389
  # TerminateTaskFlowBatch请求参数结构体
20240
20390
  class TerminateTaskFlowBatchRequest < TencentCloud::Common::AbstractModel
20241
- # @param FlowBatchId: 工作流批次 ID
20391
+ # @param FlowBatchId: 工作流批次 ID,在[工作流执行记录](https://console.cloud.tencent.com/tsf/tct?rid=1&tab=taskflow)列表页第一列获取。
20242
20392
  # @type FlowBatchId: String
20243
20393
 
20244
20394
  attr_accessor :FlowBatchId
@@ -20254,7 +20404,7 @@ module TencentCloud
20254
20404
 
20255
20405
  # TerminateTaskFlowBatch返回参数结构体
20256
20406
  class TerminateTaskFlowBatchResponse < TencentCloud::Common::AbstractModel
20257
- # @param Result: 是否停止成功
20407
+ # @param Result: 是否停止成功,true:停止成功,false:停止失败
20258
20408
  # @type Result: Boolean
20259
20409
  # @param RequestId: 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
20260
20410
  # @type RequestId: String
@@ -20396,7 +20546,9 @@ module TencentCloud
20396
20546
 
20397
20547
  # 配置中心
20398
20548
  class TsfConfigCenter < TencentCloud::Common::AbstractModel
20399
- # @param ConfigType: 配置中心类型
20549
+ # @param ConfigType: 配置中心类型。
20550
+ # - SHARE:共享型
20551
+ # - EXCLUSIVE:独占型
20400
20552
  # 注意:此字段可能返回 null,表示取不到有效值。
20401
20553
  # @type ConfigType: String
20402
20554
  # @param ConfigCenterInstanceId: 配置中心实例id
@@ -20562,7 +20714,7 @@ module TencentCloud
20562
20714
  # @param ScrollId: 游标ID
20563
20715
  # 注意:此字段可能返回 null,表示取不到有效值。
20564
20716
  # @type ScrollId: String
20565
- # @param Status: 查询状态
20717
+ # @param Status: 查询状态,SUCCESS:查询成功完成,ERROR_RANGE_EXCEED:查询范围过大异常,ERROR_COMPLEX_CONDITION:查询条件复杂异常,ERROR_OTHER_CAUSE:其他异常
20566
20718
  # 注意:此字段可能返回 null,表示取不到有效值。
20567
20719
  # @type Status: String
20568
20720
  # @param SearchAfter: 查询es时,使用searchAfter返回的游标
@@ -21094,10 +21246,10 @@ module TencentCloud
21094
21246
  # @param ScrollId: 游标ID
21095
21247
  # 注意:此字段可能返回 null,表示取不到有效值。
21096
21248
  # @type ScrollId: String
21097
- # @param Status: 查询状态
21249
+ # @param Status: 查询状态,SUCCESS:查询成功完成,ERROR_RANGE_EXCEED:查询范围过大异常,ERROR_COMPLEX_CONDITION:查询条件复杂异常,ERROR_OTHER_CAUSE:其他异常
21098
21250
  # 注意:此字段可能返回 null,表示取不到有效值。
21099
21251
  # @type Status: String
21100
- # @param SearchAfter: 游标ID
21252
+ # @param SearchAfter: 查询es使用searchAfter时,游标
21101
21253
  # @type SearchAfter: Array
21102
21254
 
21103
21255
  attr_accessor :TotalCount, :Content, :ScrollId, :Status, :SearchAfter
@@ -21686,15 +21838,19 @@ module TencentCloud
21686
21838
 
21687
21839
  # UpdateConfigTemplate请求参数结构体
21688
21840
  class UpdateConfigTemplateRequest < TencentCloud::Common::AbstractModel
21689
- # @param ConfigTemplateId: 配置模板id
21841
+ # @param ConfigTemplateId: 配置模板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)创建新的配置模板。
21690
21842
  # @type ConfigTemplateId: String
21691
- # @param ConfigTemplateName: 配置模板名称
21843
+ # @param ConfigTemplateName: 配置模板名称,最多支持60个字符,只能包含字母、数字及分隔符(“-”),且不能以分隔符开头或结尾。
21692
21844
  # @type ConfigTemplateName: String
21693
- # @param ConfigTemplateType: 配置模板对应的微服务框架
21845
+ # @param ConfigTemplateType: 配置模板对应的微服务框架。
21846
+ # - Ribbon:Ribbon类型配置模板
21847
+ # - Hystrix:Hystrix类型配置模板
21848
+ # - Zuul:Zuul类型配置模板
21849
+ # - customize:自定义类型配置模板
21694
21850
  # @type ConfigTemplateType: String
21695
- # @param ConfigTemplateValue: 配置模板数据
21851
+ # @param ConfigTemplateValue: 配置模板数据。
21696
21852
  # @type ConfigTemplateValue: String
21697
- # @param ConfigTemplateDesc: 配置模板描述
21853
+ # @param ConfigTemplateDesc: 配置模板描述,最多支持200个字符。
21698
21854
  # @type ConfigTemplateDesc: String
21699
21855
 
21700
21856
  attr_accessor :ConfigTemplateId, :ConfigTemplateName, :ConfigTemplateType, :ConfigTemplateValue, :ConfigTemplateDesc
@@ -21718,7 +21874,9 @@ module TencentCloud
21718
21874
 
21719
21875
  # UpdateConfigTemplate返回参数结构体
21720
21876
  class UpdateConfigTemplateResponse < TencentCloud::Common::AbstractModel
21721
- # @param Result: 更新成功: true / 更新失败: false
21877
+ # @param Result: 更新结果。
21878
+ # - true:成功
21879
+ # - false:失败
21722
21880
  # @type Result: Boolean
21723
21881
  # @param RequestId: 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
21724
21882
  # @type RequestId: String
@@ -21794,7 +21952,7 @@ module TencentCloud
21794
21952
 
21795
21953
  # UpdateHealthCheckSettings请求参数结构体
21796
21954
  class UpdateHealthCheckSettingsRequest < TencentCloud::Common::AbstractModel
21797
- # @param GroupId: 部署组ID
21955
+ # @param GroupId: 部署组ID,可通过调用[DescribeContainerGroups](https://cloud.tencent.com/document/api/649/36068)查询已创建的部署组列表或登录控制台进行查看;也可以调用[CreateContainGroup](https://cloud.tencent.com/document/api/649/36075)创建新的部署组。
21798
21956
  # @type GroupId: String
21799
21957
  # @param EnableHealthCheck: 是否开启健康检查
21800
21958
  # @type EnableHealthCheck: Boolean
@@ -21843,7 +22001,7 @@ module TencentCloud
21843
22001
 
21844
22002
  # UpdateRepository请求参数结构体
21845
22003
  class UpdateRepositoryRequest < TencentCloud::Common::AbstractModel
21846
- # @param RepositoryId: 仓库ID
22004
+ # @param RepositoryId: 仓库ID,可通过调用[仓库信息查询类](https://cloud.tencent.com/document/api/649/45925)接口时出参中的RepositoryId,或登录[控制台](https://console.cloud.tencent.com/tsf/product?rid=1)进行查看
21847
22005
  # @type RepositoryId: String
21848
22006
  # @param RepositoryDesc: 仓库描述
21849
22007
  # @type RepositoryDesc: String
@@ -22216,7 +22374,7 @@ module TencentCloud
22216
22374
  # @type RunInstanceCount: Integer
22217
22375
  # @param OffInstanceCount: 部署组中停止实例数
22218
22376
  # @type OffInstanceCount: Integer
22219
- # @param GroupStatus: 部署组状态
22377
+ # @param GroupStatus: 部署组状态,Running运行中,Waiting等待中,Paused暂停中,Updating更新中,RollingBack回滚中,Abnormal异常,Unknown未知
22220
22378
  # @type GroupStatus: String
22221
22379
  # @param IsNotEqualServiceConfig: 服务配置信息是否匹配
22222
22380
  # @type IsNotEqualServiceConfig: Boolean
@@ -22357,6 +22515,30 @@ module TencentCloud
22357
22515
  end
22358
22516
  end
22359
22517
 
22518
+ # VolumeClaim模板项
22519
+ class VolumeClaimTemplatesOption < TencentCloud::Common::AbstractModel
22520
+ # @param StorageClass: StorageClass名称
22521
+ # @type StorageClass: String
22522
+ # @param AccessModes: 访问模式
22523
+ # @type AccessModes: Array
22524
+ # @param StorageRequest: 卷空间的预占声明
22525
+ # @type StorageRequest: Integer
22526
+
22527
+ attr_accessor :StorageClass, :AccessModes, :StorageRequest
22528
+
22529
+ def initialize(storageclass=nil, accessmodes=nil, storagerequest=nil)
22530
+ @StorageClass = storageclass
22531
+ @AccessModes = accessmodes
22532
+ @StorageRequest = storagerequest
22533
+ end
22534
+
22535
+ def deserialize(params)
22536
+ @StorageClass = params['StorageClass']
22537
+ @AccessModes = params['AccessModes']
22538
+ @StorageRequest = params['StorageRequest']
22539
+ end
22540
+ end
22541
+
22360
22542
  # 容器卷挂载信息
22361
22543
  class VolumeInfo < TencentCloud::Common::AbstractModel
22362
22544
  # @param VolumeType: 数据卷类型
@@ -22369,15 +22551,18 @@ module TencentCloud
22369
22551
  # @type ConfigMapOptions: Array
22370
22552
  # @param EmptyDirOption: -
22371
22553
  # @type EmptyDirOption: :class:`Tencentcloud::Tsf.v20180326.models.EmptyDirOption`
22554
+ # @param VolumeClaimTemplateOption: 数据卷PVC声明模板
22555
+ # @type VolumeClaimTemplateOption: :class:`Tencentcloud::Tsf.v20180326.models.VolumeClaimTemplatesOption`
22372
22556
 
22373
- attr_accessor :VolumeType, :VolumeName, :VolumeConfig, :ConfigMapOptions, :EmptyDirOption
22557
+ attr_accessor :VolumeType, :VolumeName, :VolumeConfig, :ConfigMapOptions, :EmptyDirOption, :VolumeClaimTemplateOption
22374
22558
 
22375
- def initialize(volumetype=nil, volumename=nil, volumeconfig=nil, configmapoptions=nil, emptydiroption=nil)
22559
+ def initialize(volumetype=nil, volumename=nil, volumeconfig=nil, configmapoptions=nil, emptydiroption=nil, volumeclaimtemplateoption=nil)
22376
22560
  @VolumeType = volumetype
22377
22561
  @VolumeName = volumename
22378
22562
  @VolumeConfig = volumeconfig
22379
22563
  @ConfigMapOptions = configmapoptions
22380
22564
  @EmptyDirOption = emptydiroption
22565
+ @VolumeClaimTemplateOption = volumeclaimtemplateoption
22381
22566
  end
22382
22567
 
22383
22568
  def deserialize(params)
@@ -22396,6 +22581,10 @@ module TencentCloud
22396
22581
  @EmptyDirOption = EmptyDirOption.new
22397
22582
  @EmptyDirOption.deserialize(params['EmptyDirOption'])
22398
22583
  end
22584
+ unless params['VolumeClaimTemplateOption'].nil?
22585
+ @VolumeClaimTemplateOption = VolumeClaimTemplatesOption.new
22586
+ @VolumeClaimTemplateOption.deserialize(params['VolumeClaimTemplateOption'])
22587
+ end
22399
22588
  end
22400
22589
  end
22401
22590
 
@@ -22431,7 +22620,7 @@ module TencentCloud
22431
22620
  class WarmupSetting < TencentCloud::Common::AbstractModel
22432
22621
  # @param Enabled: 是否开启预热
22433
22622
  # @type Enabled: Boolean
22434
- # @param WarmupTime: 预热时间
22623
+ # @param WarmupTime: 预热时间,单位秒
22435
22624
  # @type WarmupTime: Integer
22436
22625
  # @param Curvature: 预热曲率,取值 1~5
22437
22626
  # @type Curvature: Integer