tencentcloud-sdk-tsf 3.0.1117 → 3.0.1122

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.
@@ -3322,7 +3322,7 @@ module TencentCloud
3322
3322
 
3323
3323
  # ContinueRunFailedTaskBatch请求参数结构体
3324
3324
  class ContinueRunFailedTaskBatchRequest < TencentCloud::Common::AbstractModel
3325
- # @param BatchId: 批次ID。
3325
+ # @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
3326
  # @type BatchId: String
3327
3327
 
3328
3328
  attr_accessor :BatchId
@@ -3878,21 +3878,23 @@ module TencentCloud
3878
3878
 
3879
3879
  # CreateConfig请求参数结构体
3880
3880
  class CreateConfigRequest < TencentCloud::Common::AbstractModel
3881
- # @param ConfigName: 配置项名称
3881
+ # @param ConfigName: 配置项名称,最多支持60个字符,只能包含字母、数字及分隔符(“-”、“_”),且不能以分隔符开头或结尾。
3882
3882
  # @type ConfigName: String
3883
- # @param ConfigVersion: 配置项版本
3883
+ # @param ConfigVersion: 配置项版本,只能包含小写字母、数字及分隔符("-","."),且必须以小写字母或数字开头、以小写字母或数字结尾,中间不能有连续的"-"或"."。
3884
3884
  # @type ConfigVersion: String
3885
- # @param ConfigValue: 配置项值
3885
+ # @param ConfigValue: 配置项值。
3886
3886
  # @type ConfigValue: String
3887
- # @param ApplicationId: 应用ID
3887
+ # @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
3888
  # @type ApplicationId: String
3889
- # @param ConfigVersionDesc: 配置项版本描述
3889
+ # @param ConfigVersionDesc: 配置项版本描述,最多支持200个字符。
3890
3890
  # @type ConfigVersionDesc: String
3891
- # @param ConfigType: 配置项值类型
3891
+ # @param ConfigType: 配置项值类型,固定值。
3892
3892
  # @type ConfigType: String
3893
- # @param EncodeWithBase64: Base64编码的配置项
3893
+ # @param EncodeWithBase64: Base64编码的配置项。
3894
+ # - true:开启
3895
+ # - false:关闭
3894
3896
  # @type EncodeWithBase64: Boolean
3895
- # @param ProgramIdList:
3897
+ # @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
3898
  # @type ProgramIdList: Array
3897
3899
 
3898
3900
  attr_accessor :ConfigName, :ConfigVersion, :ConfigValue, :ApplicationId, :ConfigVersionDesc, :ConfigType, :EncodeWithBase64, :ProgramIdList
@@ -3922,7 +3924,9 @@ module TencentCloud
3922
3924
 
3923
3925
  # CreateConfig返回参数结构体
3924
3926
  class CreateConfigResponse < TencentCloud::Common::AbstractModel
3925
- # @param Result: true:创建成功;false:创建失败
3927
+ # @param Result: 创建结果。
3928
+ # - true:创建成功
3929
+ # - false:创建失败
3926
3930
  # @type Result: Boolean
3927
3931
  # @param RequestId: 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
3928
3932
  # @type RequestId: String
@@ -3942,15 +3946,19 @@ module TencentCloud
3942
3946
 
3943
3947
  # CreateConfigTemplate请求参数结构体
3944
3948
  class CreateConfigTemplateRequest < TencentCloud::Common::AbstractModel
3945
- # @param ConfigTemplateName: 配置模板名称
3949
+ # @param ConfigTemplateName: 配置模板名称,最多支持60个字符,只能包含字母、数字及分隔符(“-”),且不能以分隔符开头或结尾。
3946
3950
  # @type ConfigTemplateName: String
3947
- # @param ConfigTemplateType: 配置模板对应的微服务框架
3951
+ # @param ConfigTemplateType: 配置模板对应的微服务框架。
3952
+ # - Ribbon:Ribbon类型配置模板
3953
+ # - Hystrix:Hystrix类型配置模板
3954
+ # - Zuul:Zuul类型配置模板
3955
+ # - customize:自定义类型配置模板
3948
3956
  # @type ConfigTemplateType: String
3949
- # @param ConfigTemplateValue: 配置模板数据
3957
+ # @param ConfigTemplateValue: 配置模板数据。
3950
3958
  # @type ConfigTemplateValue: String
3951
- # @param ConfigTemplateDesc: 配置模板描述
3959
+ # @param ConfigTemplateDesc: 配置模板描述,最多支持200个字符。
3952
3960
  # @type ConfigTemplateDesc: String
3953
- # @param ProgramIdList:
3961
+ # @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
3962
  # @type ProgramIdList: Array
3955
3963
 
3956
3964
  attr_accessor :ConfigTemplateName, :ConfigTemplateType, :ConfigTemplateValue, :ConfigTemplateDesc, :ProgramIdList
@@ -3974,7 +3982,9 @@ module TencentCloud
3974
3982
 
3975
3983
  # CreateConfigTemplate返回参数结构体
3976
3984
  class CreateConfigTemplateResponse < TencentCloud::Common::AbstractModel
3977
- # @param Result: true:创建成功;false:创建失败
3985
+ # @param Result: 创建结果。
3986
+ # - true:创建成功
3987
+ # - false:创建失败
3978
3988
  # @type Result: Boolean
3979
3989
  # @param RequestId: 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
3980
3990
  # @type RequestId: String
@@ -3994,15 +4004,15 @@ module TencentCloud
3994
4004
 
3995
4005
  # CreateConfigTemplateWithDetailResp请求参数结构体
3996
4006
  class CreateConfigTemplateWithDetailRespRequest < TencentCloud::Common::AbstractModel
3997
- # @param ConfigTemplateName: 配置模板名称
4007
+ # @param ConfigTemplateName: 配置模板名称,最多支持60个字符,只能包含字母、数字及分隔符(“-”),且不能以分隔符开头或结尾。
3998
4008
  # @type ConfigTemplateName: String
3999
- # @param ConfigTemplateType: 配置模板对应的微服务框架
4009
+ # @param ConfigTemplateType: 配置模板对应的微服务框架。- Ribbon:Ribbon类型配置模板- Hystrix:Hystrix类型配置模板- Zuul:Zuul类型配置模板- customize:自定义类型配置模板。
4000
4010
  # @type ConfigTemplateType: String
4001
- # @param ConfigTemplateValue: 配置模板数据
4011
+ # @param ConfigTemplateValue: 配置模板数据。
4002
4012
  # @type ConfigTemplateValue: String
4003
- # @param ConfigTemplateDesc: 配置模板描述
4013
+ # @param ConfigTemplateDesc: 配置模板描述,最多支持200个字符。
4004
4014
  # @type ConfigTemplateDesc: String
4005
- # @param ProgramIdList:
4015
+ # @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
4016
  # @type ProgramIdList: Array
4007
4017
 
4008
4018
  attr_accessor :ConfigTemplateName, :ConfigTemplateType, :ConfigTemplateValue, :ConfigTemplateDesc, :ProgramIdList
@@ -4026,7 +4036,7 @@ module TencentCloud
4026
4036
 
4027
4037
  # CreateConfigTemplateWithDetailResp返回参数结构体
4028
4038
  class CreateConfigTemplateWithDetailRespResponse < TencentCloud::Common::AbstractModel
4029
- # @param Result: 创建成功,返回 ID
4039
+ # @param Result: 创建成功,返回配置模板ID
4030
4040
  # @type Result: :class:`Tencentcloud::Tsf.v20180326.models.ConfigTemplate`
4031
4041
  # @param RequestId: 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
4032
4042
  # @type RequestId: String
@@ -4049,21 +4059,23 @@ module TencentCloud
4049
4059
 
4050
4060
  # CreateConfigWithDetailResp请求参数结构体
4051
4061
  class CreateConfigWithDetailRespRequest < TencentCloud::Common::AbstractModel
4052
- # @param ConfigName: 配置项名称
4062
+ # @param ConfigName: 配置项名称,最多支持60个字符,只能包含字母、数字及分隔符(“-”、“_”),且不能以分隔符开头或结尾。
4053
4063
  # @type ConfigName: String
4054
- # @param ConfigVersion: 配置项版本
4064
+ # @param ConfigVersion: 配置项版本,只能包含小写字母、数字及分隔符("-","."),且必须以小写字母或数字开头、以小写字母或数字结尾,中间不能有连续的"-"或"."。
4055
4065
  # @type ConfigVersion: String
4056
- # @param ConfigValue: 配置项值
4066
+ # @param ConfigValue: 配置项值。
4057
4067
  # @type ConfigValue: String
4058
- # @param ApplicationId: 应用ID
4068
+ # @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
4069
  # @type ApplicationId: String
4060
- # @param ConfigVersionDesc: 配置项版本描述
4070
+ # @param ConfigVersionDesc: 配置项版本描述,最多支持200个字符。
4061
4071
  # @type ConfigVersionDesc: String
4062
- # @param ConfigType: 配置项值类型
4072
+ # @param ConfigType: 配置项值类型,固定值。
4063
4073
  # @type ConfigType: String
4064
- # @param EncodeWithBase64: Base64编码的配置项
4074
+ # @param EncodeWithBase64: Base64编码的配置项。
4075
+ # - true:开启
4076
+ # - false:关闭
4065
4077
  # @type EncodeWithBase64: Boolean
4066
- # @param ProgramIdList:
4078
+ # @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
4079
  # @type ProgramIdList: Array
4068
4080
 
4069
4081
  attr_accessor :ConfigName, :ConfigVersion, :ConfigValue, :ApplicationId, :ConfigVersionDesc, :ConfigType, :EncodeWithBase64, :ProgramIdList
@@ -4093,7 +4105,7 @@ module TencentCloud
4093
4105
 
4094
4106
  # CreateConfigWithDetailResp返回参数结构体
4095
4107
  class CreateConfigWithDetailRespResponse < TencentCloud::Common::AbstractModel
4096
- # @param Result: 配置项
4108
+ # @param Result: 配置项。
4097
4109
  # @type Result: :class:`Tencentcloud::Tsf.v20180326.models.Config`
4098
4110
  # @param RequestId: 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
4099
4111
  # @type RequestId: String
@@ -4253,27 +4265,29 @@ module TencentCloud
4253
4265
 
4254
4266
  # CreateFileConfig请求参数结构体
4255
4267
  class CreateFileConfigRequest < TencentCloud::Common::AbstractModel
4256
- # @param ConfigName: 配置项名称
4268
+ # @param ConfigName: 配置项名称,最多支持60个字符,只能包含字母、数字及分隔符(“-”、“_”),且不能以分隔符开头或结尾。
4257
4269
  # @type ConfigName: String
4258
- # @param ConfigVersion: 配置项版本
4270
+ # @param ConfigVersion: 配置项版本,只能包含小写字母、数字及分隔符("-","."),且必须以小写字母或数字开头、以小写字母或数字结尾,中间不能有连续的"-"或"."。
4259
4271
  # @type ConfigVersion: String
4260
- # @param ConfigFileName: 配置项文件名
4272
+ # @param ConfigFileName: 配置项文件名,最多支持60个字符,只能包含英文、数字、"-"(英文)、"_"(英文)、"."(英文)。
4261
4273
  # @type ConfigFileName: String
4262
4274
  # @param ConfigFileValue: 配置项文件内容(原始内容编码需要 utf-8 格式,如果 ConfigFileCode 为 gbk,后台会进行转换)
4263
4275
  # @type ConfigFileValue: String
4264
- # @param ApplicationId: 配置项关联应用ID
4276
+ # @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
4277
  # @type ApplicationId: String
4266
- # @param ConfigFilePath: 发布路径
4278
+ # @param ConfigFilePath: 发布路径。
4267
4279
  # @type ConfigFilePath: String
4268
- # @param ConfigVersionDesc: 配置项版本描述
4280
+ # @param ConfigVersionDesc: 配置项版本描述,最多支持200个字符。
4269
4281
  # @type ConfigVersionDesc: String
4270
- # @param ConfigFileCode: 配置项文件编码,utf-8 或 gbk。注:如果选择 gbk,需要新版本 tsf-consul-template (公有云虚拟机需要使用 1.32 tsf-agent,容器需要从文档中获取最新的 tsf-consul-template-docker.tar.gz)的支持
4282
+ # @param ConfigFileCode: 配置项文件编码,utf-8 或 gbk。注:如果选择 gbk,需要新版本 tsf-consul-template (公有云虚拟机需要使用 1.32 tsf-agent,容器需要从文档中获取最新的 tsf-consul-template-docker.tar.gz)的支持。
4271
4283
  # @type ConfigFileCode: String
4272
- # @param ConfigPostCmd: 后置命令
4284
+ # @param ConfigPostCmd: 后置命令。
4273
4285
  # @type ConfigPostCmd: String
4274
- # @param EncodeWithBase64: Base64编码的配置项
4286
+ # @param EncodeWithBase64: Base64编码的配置项。
4287
+ # - true:开启
4288
+ # - false:关闭
4275
4289
  # @type EncodeWithBase64: Boolean
4276
- # @param ProgramIdList:
4290
+ # @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
4291
  # @type ProgramIdList: Array
4278
4292
 
4279
4293
  attr_accessor :ConfigName, :ConfigVersion, :ConfigFileName, :ConfigFileValue, :ApplicationId, :ConfigFilePath, :ConfigVersionDesc, :ConfigFileCode, :ConfigPostCmd, :EncodeWithBase64, :ProgramIdList
@@ -4309,7 +4323,9 @@ module TencentCloud
4309
4323
 
4310
4324
  # CreateFileConfig返回参数结构体
4311
4325
  class CreateFileConfigResponse < TencentCloud::Common::AbstractModel
4312
- # @param Result: true:创建成功;false:创建失败
4326
+ # @param Result: 创建结果。
4327
+ # - true:创建成功
4328
+ # - false:创建失败
4313
4329
  # @type Result: Boolean
4314
4330
  # @param RequestId: 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
4315
4331
  # @type RequestId: String
@@ -4329,27 +4345,27 @@ module TencentCloud
4329
4345
 
4330
4346
  # CreateFileConfigWithDetailResp请求参数结构体
4331
4347
  class CreateFileConfigWithDetailRespRequest < TencentCloud::Common::AbstractModel
4332
- # @param ConfigName: 配置项名称
4348
+ # @param ConfigName: 配置名称,最多支持60个字符,只能包含字母、数字及分隔符(“-”、“_”),且不能以分隔符开头或结尾。
4333
4349
  # @type ConfigName: String
4334
- # @param ConfigVersion: 配置项版本
4350
+ # @param ConfigVersion: 配置项版本,只能包含小写字母、数字及分隔符("-","."),且必须以小写字母或数字开头、以小写字母或数字结尾,中间不能有连续的"-"或"."。
4335
4351
  # @type ConfigVersion: String
4336
- # @param ConfigFileName: 配置项文件名
4352
+ # @param ConfigFileName: 配置项文件名,不超过60个字符,只能包含英文、数字、"-"(英文)、"_"(英文)、"."(英文)。
4337
4353
  # @type ConfigFileName: String
4338
- # @param ConfigFileValue: 配置项文件内容(原始内容编码需要 utf-8 格式,如果 ConfigFileCode 为 gbk,后台会进行转换)
4354
+ # @param ConfigFileValue: 配置项文件内容(原始内容编码需要 utf-8 格式,如果 ConfigFileCode 为 gbk,后台会进行转换)。
4339
4355
  # @type ConfigFileValue: String
4340
- # @param ApplicationId: 配置项关联应用ID
4356
+ # @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
4357
  # @type ApplicationId: String
4342
- # @param ConfigFilePath: 发布路径
4358
+ # @param ConfigFilePath: 发布路径。
4343
4359
  # @type ConfigFilePath: String
4344
- # @param ConfigVersionDesc: 配置项版本描述
4360
+ # @param ConfigVersionDesc: 配置项版本描述,最多支持200个字符。
4345
4361
  # @type ConfigVersionDesc: String
4346
- # @param ConfigFileCode: 配置项文件编码,utf-8 或 gbk。注:如果选择 gbk,需要新版本 tsf-consul-template (公有云虚拟机需要使用 1.32 tsf-agent,容器需要从文档中获取最新的 tsf-consul-template-docker.tar.gz)的支持
4362
+ # @param ConfigFileCode: 配置项文件编码,utf-8 或 gbk。注:如果选择 gbk,需要新版本 tsf-consul-template (公有云虚拟机需要使用 1.32 tsf-agent,容器需要从文档中获取最新的 tsf-consul-template-docker.tar.gz)的支持。
4347
4363
  # @type ConfigFileCode: String
4348
- # @param ConfigPostCmd: 后置命令
4364
+ # @param ConfigPostCmd: 后置命令。
4349
4365
  # @type ConfigPostCmd: String
4350
4366
  # @param EncodeWithBase64: Base64编码的配置项
4351
4367
  # @type EncodeWithBase64: Boolean
4352
- # @param ProgramIdList:
4368
+ # @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
4369
  # @type ProgramIdList: Array
4354
4370
 
4355
4371
  attr_accessor :ConfigName, :ConfigVersion, :ConfigFileName, :ConfigFileValue, :ApplicationId, :ConfigFilePath, :ConfigVersionDesc, :ConfigFileCode, :ConfigPostCmd, :EncodeWithBase64, :ProgramIdList
@@ -4385,7 +4401,7 @@ module TencentCloud
4385
4401
 
4386
4402
  # CreateFileConfigWithDetailResp返回参数结构体
4387
4403
  class CreateFileConfigWithDetailRespResponse < TencentCloud::Common::AbstractModel
4388
- # @param Result: 文件配置项
4404
+ # @param Result: 文件配置项。
4389
4405
  # @type Result: :class:`Tencentcloud::Tsf.v20180326.models.FileConfig`
4390
4406
  # @param RequestId: 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
4391
4407
  # @type RequestId: String
@@ -4530,13 +4546,13 @@ module TencentCloud
4530
4546
 
4531
4547
  # CreateLane请求参数结构体
4532
4548
  class CreateLaneRequest < TencentCloud::Common::AbstractModel
4533
- # @param LaneName: 泳道名称
4549
+ # @param LaneName: 泳道配置名称,最多支持60个字符,只能包含字母、数字及分隔符(“-”),且不能以分隔符开头或结尾。
4534
4550
  # @type LaneName: String
4535
- # @param Remark: 泳道备注
4551
+ # @param Remark: 泳道配置备注,最多支持200个字符。
4536
4552
  # @type Remark: String
4537
- # @param LaneGroupList: 泳道部署组信息
4553
+ # @param LaneGroupList: 泳道部署组信息。
4538
4554
  # @type LaneGroupList: Array
4539
- # @param ProgramIdList:
4555
+ # @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
4556
  # @type ProgramIdList: Array
4541
4557
 
4542
4558
  attr_accessor :LaneName, :Remark, :LaneGroupList, :ProgramIdList
@@ -4565,7 +4581,7 @@ module TencentCloud
4565
4581
 
4566
4582
  # CreateLane返回参数结构体
4567
4583
  class CreateLaneResponse < TencentCloud::Common::AbstractModel
4568
- # @param Result: 泳道ID
4584
+ # @param Result: 泳道配置ID
4569
4585
  # @type Result: String
4570
4586
  # @param RequestId: 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
4571
4587
  # @type RequestId: String
@@ -4585,17 +4601,19 @@ module TencentCloud
4585
4601
 
4586
4602
  # CreateLaneRule请求参数结构体
4587
4603
  class CreateLaneRuleRequest < TencentCloud::Common::AbstractModel
4588
- # @param RuleName: 泳道规则名称
4604
+ # @param RuleName: 灰度发布规则名称,最多支持60个字符,支持中英文字符。
4589
4605
  # @type RuleName: String
4590
- # @param Remark: 泳道规则备注
4606
+ # @param Remark: 灰度发布规则备注,最多支持200个字符。
4591
4607
  # @type Remark: String
4592
- # @param RuleTagList: 泳道规则标签列表
4608
+ # @param RuleTagList: 灰度发布规则标签列表。
4593
4609
  # @type RuleTagList: Array
4594
- # @param RuleTagRelationship: 泳道规则标签关系
4610
+ # @param RuleTagRelationship: 灰度发布规则标签关系。
4611
+ # - RELEATION_AND:与
4612
+ # - RELEATION_OR:或
4595
4613
  # @type RuleTagRelationship: String
4596
- # @param LaneId: 泳道Id
4614
+ # @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
4615
  # @type LaneId: String
4598
- # @param ProgramIdList:
4616
+ # @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
4617
  # @type ProgramIdList: Array
4600
4618
 
4601
4619
  attr_accessor :RuleName, :Remark, :RuleTagList, :RuleTagRelationship, :LaneId, :ProgramIdList
@@ -4628,7 +4646,7 @@ module TencentCloud
4628
4646
 
4629
4647
  # CreateLaneRule返回参数结构体
4630
4648
  class CreateLaneRuleResponse < TencentCloud::Common::AbstractModel
4631
- # @param Result: 泳道规则Id
4649
+ # @param Result: 灰度发布规则ID。
4632
4650
  # @type Result: String
4633
4651
  # @param RequestId: 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
4634
4652
  # @type RequestId: String
@@ -4648,11 +4666,11 @@ module TencentCloud
4648
4666
 
4649
4667
  # CreateMicroservice请求参数结构体
4650
4668
  class CreateMicroserviceRequest < TencentCloud::Common::AbstractModel
4651
- # @param NamespaceId: 命名空间ID
4669
+ # @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
4670
  # @type NamespaceId: String
4653
- # @param MicroserviceName: 微服务名称
4671
+ # @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
4672
  # @type MicroserviceName: String
4655
- # @param MicroserviceDesc: 微服务描述信息
4673
+ # @param MicroserviceDesc: 微服务备注信息,最多支持200个字符。
4656
4674
  # @type MicroserviceDesc: String
4657
4675
 
4658
4676
  attr_accessor :NamespaceId, :MicroserviceName, :MicroserviceDesc
@@ -4672,7 +4690,7 @@ module TencentCloud
4672
4690
 
4673
4691
  # CreateMicroservice返回参数结构体
4674
4692
  class CreateMicroserviceResponse < TencentCloud::Common::AbstractModel
4675
- # @param Result: 新增微服务是否成功。
4693
+ # @param Result: 新增结果。
4676
4694
  # true:操作成功。
4677
4695
  # false:操作失败。
4678
4696
  # @type Result: Boolean
@@ -4694,11 +4712,11 @@ module TencentCloud
4694
4712
 
4695
4713
  # CreateMicroserviceWithDetailResp请求参数结构体
4696
4714
  class CreateMicroserviceWithDetailRespRequest < TencentCloud::Common::AbstractModel
4697
- # @param NamespaceId: 命名空间ID
4715
+ # @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
4716
  # @type NamespaceId: String
4699
- # @param MicroserviceName: 微服务名称
4717
+ # @param MicroserviceName: 微服务名称,最多支持128个字符。
4700
4718
  # @type MicroserviceName: String
4701
- # @param MicroserviceDesc: 微服务描述信息
4719
+ # @param MicroserviceDesc: 微服务描述信息,最多支持200个字符。
4702
4720
  # @type MicroserviceDesc: String
4703
4721
 
4704
4722
  attr_accessor :NamespaceId, :MicroserviceName, :MicroserviceDesc
@@ -4718,7 +4736,7 @@ module TencentCloud
4718
4736
 
4719
4737
  # CreateMicroserviceWithDetailResp返回参数结构体
4720
4738
  class CreateMicroserviceWithDetailRespResponse < TencentCloud::Common::AbstractModel
4721
- # @param Result: 微服务ID
4739
+ # @param Result: 微服务ID
4722
4740
  # @type Result: String
4723
4741
  # @param RequestId: 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
4724
4742
  # @type RequestId: String
@@ -4939,19 +4957,21 @@ module TencentCloud
4939
4957
 
4940
4958
  # CreatePublicConfig请求参数结构体
4941
4959
  class CreatePublicConfigRequest < TencentCloud::Common::AbstractModel
4942
- # @param ConfigName: 配置项名称
4960
+ # @param ConfigName: 配置名称,最长60个字符,只能包含字母、数字及分隔符(“-”、“_”),且不能以分隔符开头或结尾。
4943
4961
  # @type ConfigName: String
4944
- # @param ConfigVersion: 配置项版本
4962
+ # @param ConfigVersion: 配置版本,只能包含小写字母、数字及分隔符("-","."),且必须以小写字母或数字开头、以小写字母或数字结尾,中间不能有连续的"-"或"."。
4945
4963
  # @type ConfigVersion: String
4946
- # @param ConfigValue: 配置项值,总是接收yaml格式的内容
4964
+ # @param ConfigValue: 配置项值,总是接收yaml格式的内容。
4947
4965
  # @type ConfigValue: String
4948
- # @param ConfigVersionDesc: 配置项版本描述
4966
+ # @param ConfigVersionDesc: 配置项版本描述,最多支持200个字符。
4949
4967
  # @type ConfigVersionDesc: String
4950
- # @param ConfigType: 配置项类型
4968
+ # @param ConfigType: 配置项类型,固定值。
4951
4969
  # @type ConfigType: String
4952
- # @param EncodeWithBase64: Base64编码的配置项
4970
+ # @param EncodeWithBase64: Base64编码的配置项。
4971
+ # - true:开启
4972
+ # - false:关闭
4953
4973
  # @type EncodeWithBase64: Boolean
4954
- # @param ProgramIdList:
4974
+ # @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
4975
  # @type ProgramIdList: Array
4956
4976
 
4957
4977
  attr_accessor :ConfigName, :ConfigVersion, :ConfigValue, :ConfigVersionDesc, :ConfigType, :EncodeWithBase64, :ProgramIdList
@@ -4979,7 +4999,9 @@ module TencentCloud
4979
4999
 
4980
5000
  # CreatePublicConfig返回参数结构体
4981
5001
  class CreatePublicConfigResponse < TencentCloud::Common::AbstractModel
4982
- # @param Result: true:创建成功;false:创建失败
5002
+ # @param Result: 创建结果。
5003
+ # - true:创建成功
5004
+ # - false:创建失败
4983
5005
  # @type Result: Boolean
4984
5006
  # @param RequestId: 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
4985
5007
  # @type RequestId: String
@@ -4999,19 +5021,21 @@ module TencentCloud
4999
5021
 
5000
5022
  # CreatePublicConfigWithDetailResp请求参数结构体
5001
5023
  class CreatePublicConfigWithDetailRespRequest < TencentCloud::Common::AbstractModel
5002
- # @param ConfigName: 配置项名称
5024
+ # @param ConfigName: 配置项名称,最多支持60个字符,只能包含字母、数字及分隔符(“-”、“_”),且不能以分隔符开头或结尾。
5003
5025
  # @type ConfigName: String
5004
- # @param ConfigVersion: 配置项版本
5026
+ # @param ConfigVersion: 配置项版本,最多支持60个字符,只能包含小写字母、数字及分隔符("-","."),且必须以小写字母或数字开头、以小写字母或数字结尾,中间不能有连续的"-"或"."。
5005
5027
  # @type ConfigVersion: String
5006
- # @param ConfigValue: 配置项值,总是接收yaml格式的内容
5028
+ # @param ConfigValue: 配置项值,总是接收yaml格式的内容。
5007
5029
  # @type ConfigValue: String
5008
- # @param ConfigVersionDesc: 配置项版本描述
5030
+ # @param ConfigVersionDesc: 配置项版本描述,最多支持200个字符。
5009
5031
  # @type ConfigVersionDesc: String
5010
- # @param ConfigType: 配置项类型
5032
+ # @param ConfigType: 配置项类型,固定值。
5011
5033
  # @type ConfigType: String
5012
- # @param EncodeWithBase64: Base64编码的配置项
5034
+ # @param EncodeWithBase64: Base64编码的配置项。
5035
+ # - true:开启
5036
+ # - false:关闭
5013
5037
  # @type EncodeWithBase64: Boolean
5014
- # @param ProgramIdList:
5038
+ # @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
5039
  # @type ProgramIdList: Array
5016
5040
 
5017
5041
  attr_accessor :ConfigName, :ConfigVersion, :ConfigValue, :ConfigVersionDesc, :ConfigType, :EncodeWithBase64, :ProgramIdList
@@ -5039,7 +5063,7 @@ module TencentCloud
5039
5063
 
5040
5064
  # CreatePublicConfigWithDetailResp返回参数结构体
5041
5065
  class CreatePublicConfigWithDetailRespResponse < TencentCloud::Common::AbstractModel
5042
- # @param Result: 公共配置项 ID
5066
+ # @param Result: 公共配置项ID
5043
5067
  # @type Result: :class:`Tencentcloud::Tsf.v20180326.models.Config`
5044
5068
  # @param RequestId: 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
5045
5069
  # @type RequestId: String
@@ -5066,9 +5090,9 @@ module TencentCloud
5066
5090
  # @type RepositoryName: String
5067
5091
  # @param RepositoryType: 仓库类型(默认仓库:default,私有仓库:private)
5068
5092
  # @type RepositoryType: String
5069
- # @param BucketName: 仓库所在桶名称
5093
+ # @param BucketName: 仓库所在桶名称,[存储桶概述和创建](https://cloud.tencent.com/document/product/436/13312)
5070
5094
  # @type BucketName: String
5071
- # @param BucketRegion: 仓库所在桶地域
5095
+ # @param BucketRegion: 仓库所在桶地域,[存储桶概述和创建](https://cloud.tencent.com/document/product/436/13312)
5072
5096
  # @type BucketRegion: String
5073
5097
  # @param Directory: 目录
5074
5098
  # @type Directory: String
@@ -5184,13 +5208,13 @@ module TencentCloud
5184
5208
  # @type TaskName: String
5185
5209
  # @param TaskContent: 任务内容,长度限制65536个字节
5186
5210
  # @type TaskContent: String
5187
- # @param ExecuteType: 执行类型,unicast/broadcast
5211
+ # @param ExecuteType: 任务执行方式,unicast:随机单节点执行,broadcast:广播执行,shard:分片执行
5188
5212
  # @type ExecuteType: String
5189
- # @param TaskType: 任务类型,java
5213
+ # @param TaskType: 任务类型。当前只支持一种任务类型。枚举值,java:Java类任务
5190
5214
  # @type TaskType: String
5191
- # @param TimeOut: 任务超时时间, 时间单位 ms
5215
+ # @param TimeOut: 任务超时时间,取值大于0,单位:毫秒(ms
5192
5216
  # @type TimeOut: Integer
5193
- # @param GroupId: 部署组ID
5217
+ # @param GroupId: 部署组ID。在[应用管理](https://console.cloud.tencent.com/tsf/app?rid=1),点击应用ID进入应用部署页查看部署组ID。
5194
5218
  # @type GroupId: String
5195
5219
  # @param TaskRule: 触发规则
5196
5220
  # @type TaskRule: :class:`Tencentcloud::Tsf.v20180326.models.TaskRule`
@@ -5198,7 +5222,7 @@ module TencentCloud
5198
5222
  # @type RetryCount: Integer
5199
5223
  # @param RetryInterval: 重试间隔, 0 <= RetryInterval <= 600000, 时间单位 ms
5200
5224
  # @type RetryInterval: Integer
5201
- # @param ShardCount: 分片数量
5225
+ # @param ShardCount: 分片数量,仅当任务执行方式为分片执行时需要设置该值,取值范围2~1000
5202
5226
  # @type ShardCount: Integer
5203
5227
  # @param ShardArguments: 分片参数
5204
5228
  # @type ShardArguments: Array
@@ -5210,7 +5234,7 @@ module TencentCloud
5210
5234
  # @type AdvanceSettings: :class:`Tencentcloud::Tsf.v20180326.models.AdvanceSettings`
5211
5235
  # @param TaskArgument: 任务参数,长度限制10000个字符
5212
5236
  # @type TaskArgument: String
5213
- # @param ProgramIdList:
5237
+ # @param ProgramIdList: 数据集列表
5214
5238
  # @type ProgramIdList: Array
5215
5239
 
5216
5240
  attr_accessor :TaskName, :TaskContent, :ExecuteType, :TaskType, :TimeOut, :GroupId, :TaskRule, :RetryCount, :RetryInterval, :ShardCount, :ShardArguments, :SuccessOperator, :SuccessRatio, :AdvanceSettings, :TaskArgument, :ProgramIdList
@@ -5687,7 +5711,7 @@ module TencentCloud
5687
5711
 
5688
5712
  # DeleteConfig请求参数结构体
5689
5713
  class DeleteConfigRequest < TencentCloud::Common::AbstractModel
5690
- # @param ConfigId: 配置项ID
5714
+ # @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
5715
  # @type ConfigId: String
5692
5716
 
5693
5717
  attr_accessor :ConfigId
@@ -5703,7 +5727,9 @@ module TencentCloud
5703
5727
 
5704
5728
  # DeleteConfig返回参数结构体
5705
5729
  class DeleteConfigResponse < TencentCloud::Common::AbstractModel
5706
- # @param Result: true:删除成功;false:删除失败
5730
+ # @param Result: 删除结果。
5731
+ # - true:删除成功
5732
+ # - false:删除失败
5707
5733
  # @type Result: Boolean
5708
5734
  # @param RequestId: 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
5709
5735
  # @type RequestId: String
@@ -5723,7 +5749,7 @@ module TencentCloud
5723
5749
 
5724
5750
  # DeleteConfigTemplate请求参数结构体
5725
5751
  class DeleteConfigTemplateRequest < TencentCloud::Common::AbstractModel
5726
- # @param ConfigTemplateId:
5752
+ # @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
5753
  # @type ConfigTemplateId: String
5728
5754
 
5729
5755
  attr_accessor :ConfigTemplateId
@@ -5797,7 +5823,7 @@ module TencentCloud
5797
5823
 
5798
5824
  # DeleteFileConfig请求参数结构体
5799
5825
  class DeleteFileConfigRequest < TencentCloud::Common::AbstractModel
5800
- # @param ConfigId: 文件配置项ID
5826
+ # @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
5827
  # @type ConfigId: String
5802
5828
 
5803
5829
  attr_accessor :ConfigId
@@ -5813,7 +5839,9 @@ module TencentCloud
5813
5839
 
5814
5840
  # DeleteFileConfig返回参数结构体
5815
5841
  class DeleteFileConfigResponse < TencentCloud::Common::AbstractModel
5816
- # @param Result: 删除结果
5842
+ # @param Result: 删除结果。
5843
+ # - true:成功
5844
+ # - false:失败
5817
5845
  # @type Result: Boolean
5818
5846
  # @param RequestId: 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
5819
5847
  # @type RequestId: String
@@ -5980,7 +6008,7 @@ module TencentCloud
5980
6008
 
5981
6009
  # DeleteLane请求参数结构体
5982
6010
  class DeleteLaneRequest < TencentCloud::Common::AbstractModel
5983
- # @param LaneId: 泳道Idl
6011
+ # @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
6012
  # @type LaneId: String
5985
6013
 
5986
6014
  attr_accessor :LaneId
@@ -5996,7 +6024,9 @@ module TencentCloud
5996
6024
 
5997
6025
  # DeleteLane返回参数结构体
5998
6026
  class DeleteLaneResponse < TencentCloud::Common::AbstractModel
5999
- # @param Result: 删除成功: true / 删除失败: false
6027
+ # @param Result: 删除结果。
6028
+ # - true:删除成功
6029
+ # - false:删除失败
6000
6030
  # @type Result: Boolean
6001
6031
  # @param RequestId: 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
6002
6032
  # @type RequestId: String
@@ -6016,7 +6046,7 @@ module TencentCloud
6016
6046
 
6017
6047
  # DeleteLaneRule请求参数结构体
6018
6048
  class DeleteLaneRuleRequest < TencentCloud::Common::AbstractModel
6019
- # @param RuleId: 泳道规则Id
6049
+ # @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
6050
  # @type RuleId: String
6021
6051
 
6022
6052
  attr_accessor :RuleId
@@ -6032,7 +6062,9 @@ module TencentCloud
6032
6062
 
6033
6063
  # DeleteLaneRule返回参数结构体
6034
6064
  class DeleteLaneRuleResponse < TencentCloud::Common::AbstractModel
6035
- # @param Result: 操作状态
6065
+ # @param Result: 删除结果。
6066
+ # - true:成功
6067
+ # - false:失败
6036
6068
  # @type Result: Boolean
6037
6069
  # @param RequestId: 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
6038
6070
  # @type RequestId: String
@@ -6052,7 +6084,7 @@ module TencentCloud
6052
6084
 
6053
6085
  # DeleteMicroservice请求参数结构体
6054
6086
  class DeleteMicroserviceRequest < TencentCloud::Common::AbstractModel
6055
- # @param MicroserviceId: 微服务ID
6087
+ # @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
6088
  # @type MicroserviceId: String
6057
6089
 
6058
6090
  attr_accessor :MicroserviceId
@@ -6068,9 +6100,9 @@ module TencentCloud
6068
6100
 
6069
6101
  # DeleteMicroservice返回参数结构体
6070
6102
  class DeleteMicroserviceResponse < TencentCloud::Common::AbstractModel
6071
- # @param Result: 删除微服务是否成功。
6072
- # true:操作成功。
6073
- # false:操作失败。
6103
+ # @param Result: 删除结果。
6104
+ # - true:操作成功
6105
+ # - false:操作失败
6074
6106
  # @type Result: Boolean
6075
6107
  # @param RequestId: 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
6076
6108
  # @type RequestId: String
@@ -6168,13 +6200,13 @@ module TencentCloud
6168
6200
 
6169
6201
  # DeletePkgs请求参数结构体
6170
6202
  class DeletePkgsRequest < TencentCloud::Common::AbstractModel
6171
- # @param ApplicationId: 应用ID
6203
+ # @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
6204
  # @type ApplicationId: String
6173
- # @param PkgIds: 需要删除的程序包ID列表
6205
+ # @param PkgIds: 软件包ID所形成的列表,软件包ID可通过调用DescribeUploadInfo接口时[获取上传程序包信息](https://cloud.tencent.com/document/api/649/36078)返回的COS上传信息获取,登录[控制台](https://console.cloud.tencent.com/tsf/product?rid=1)进行查看
6174
6206
  # @type PkgIds: Array
6175
- # @param RepositoryType: 程序包仓库类型
6207
+ # @param RepositoryType: 程序包仓库类型(允许值:"public-demo"TSF公共demo仓库, "private"自定义仓库, "default"TSF公共仓库)
6176
6208
  # @type RepositoryType: String
6177
- # @param RepositoryId: 程序包仓库id
6209
+ # @param RepositoryId: 仓库ID,可通过调用[仓库信息查询类](https://cloud.tencent.com/document/api/649/45925)接口时出参中的RepositoryId,或登录[控制台](https://console.cloud.tencent.com/tsf/product?rid=1)进行查看
6178
6210
  # @type RepositoryId: String
6179
6211
 
6180
6212
  attr_accessor :ApplicationId, :PkgIds, :RepositoryType, :RepositoryId
@@ -6212,7 +6244,7 @@ module TencentCloud
6212
6244
 
6213
6245
  # DeletePublicConfig请求参数结构体
6214
6246
  class DeletePublicConfigRequest < TencentCloud::Common::AbstractModel
6215
- # @param ConfigId: 配置项ID
6247
+ # @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
6248
  # @type ConfigId: String
6217
6249
 
6218
6250
  attr_accessor :ConfigId
@@ -6228,7 +6260,9 @@ module TencentCloud
6228
6260
 
6229
6261
  # DeletePublicConfig返回参数结构体
6230
6262
  class DeletePublicConfigResponse < TencentCloud::Common::AbstractModel
6231
- # @param Result: true:删除成功;false:删除失败
6263
+ # @param Result: 删除结果。
6264
+ # - true:删除成功
6265
+ # - false:删除失败
6232
6266
  # @type Result: Boolean
6233
6267
  # @param RequestId: 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
6234
6268
  # @type RequestId: String
@@ -6248,7 +6282,7 @@ module TencentCloud
6248
6282
 
6249
6283
  # DeleteRepository请求参数结构体
6250
6284
  class DeleteRepositoryRequest < TencentCloud::Common::AbstractModel
6251
- # @param RepositoryId: 仓库ID
6285
+ # @param RepositoryId: 删除对应仓库ID,可通过调用[仓库信息查询类](https://cloud.tencent.com/document/api/649/45925)接口时出参中的RepositoryId,或登录[控制台](https://console.cloud.tencent.com/tsf/product?rid=1)进行查看
6252
6286
  # @type RepositoryId: String
6253
6287
 
6254
6288
  attr_accessor :RepositoryId
@@ -6320,7 +6354,7 @@ module TencentCloud
6320
6354
 
6321
6355
  # DeleteTask请求参数结构体
6322
6356
  class DeleteTaskRequest < TencentCloud::Common::AbstractModel
6323
- # @param TaskId: 任务ID
6357
+ # @param TaskId: 任务ID。在[任务管理](https://console.cloud.tencent.com/tsf/tct?rid=1)列表页第一列和任务基本信息页查看任务ID。
6324
6358
  # @type TaskId: String
6325
6359
 
6326
6360
  attr_accessor :TaskId
@@ -6336,7 +6370,7 @@ module TencentCloud
6336
6370
 
6337
6371
  # DeleteTask返回参数结构体
6338
6372
  class DeleteTaskResponse < TencentCloud::Common::AbstractModel
6339
- # @param Result: 删除成功or失败
6373
+ # @param Result: true:删除成功,false:删除失败
6340
6374
  # @type Result: Boolean
6341
6375
  # @param RequestId: 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
6342
6376
  # @type RequestId: String
@@ -7316,15 +7350,22 @@ module TencentCloud
7316
7350
 
7317
7351
  # DescribeApiDetail请求参数结构体
7318
7352
  class DescribeApiDetailRequest < TencentCloud::Common::AbstractModel
7319
- # @param MicroserviceId: 微服务id
7353
+ # @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
7354
  # @type MicroserviceId: String
7321
- # @param Path: 请求路径
7355
+ # @param Path: 请求路径。
7322
7356
  # @type Path: String
7323
- # @param Method: 请求方法
7357
+ # @param Method: 请求方法。
7358
+ # - GET
7359
+ # - POST
7360
+ # - PUT
7361
+ # - DELETE
7362
+ # - HEAD
7363
+ # - PATCH
7364
+ # - OPTIONS
7324
7365
  # @type Method: String
7325
- # @param PkgVersion: 包版本
7366
+ # @param PkgVersion: 应用包版本号。
7326
7367
  # @type PkgVersion: String
7327
- # @param ApplicationId: 应用ID
7368
+ # @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
7369
  # @type ApplicationId: String
7329
7370
 
7330
7371
  attr_accessor :MicroserviceId, :Path, :Method, :PkgVersion, :ApplicationId
@@ -7348,7 +7389,7 @@ module TencentCloud
7348
7389
 
7349
7390
  # DescribeApiDetail返回参数结构体
7350
7391
  class DescribeApiDetailResponse < TencentCloud::Common::AbstractModel
7351
- # @param Result: API 详情
7392
+ # @param Result: API详情。
7352
7393
  # @type Result: :class:`Tencentcloud::Tsf.v20180326.models.ApiDetailResponse`
7353
7394
  # @param RequestId: 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
7354
7395
  # @type RequestId: String
@@ -7575,11 +7616,18 @@ module TencentCloud
7575
7616
 
7576
7617
  # DescribeApiVersions请求参数结构体
7577
7618
  class DescribeApiVersionsRequest < TencentCloud::Common::AbstractModel
7578
- # @param MicroserviceId: 微服务ID
7619
+ # @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
7620
  # @type MicroserviceId: String
7580
- # @param Path: API 请求路径
7621
+ # @param Path: API请求路径。
7581
7622
  # @type Path: String
7582
- # @param Method: 请求方法
7623
+ # @param Method: API请求方法。
7624
+ # - GET
7625
+ # - POST
7626
+ # - PUT
7627
+ # - DELETE
7628
+ # - HEAD
7629
+ # - PATCH
7630
+ # - OPTIONS
7583
7631
  # @type Method: String
7584
7632
 
7585
7633
  attr_accessor :MicroserviceId, :Path, :Method
@@ -7599,7 +7647,7 @@ module TencentCloud
7599
7647
 
7600
7648
  # DescribeApiVersions返回参数结构体
7601
7649
  class DescribeApiVersionsResponse < TencentCloud::Common::AbstractModel
7602
- # @param Result: API版本列表
7650
+ # @param Result: API版本列表。
7603
7651
  # @type Result: Array
7604
7652
  # @param RequestId: 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
7605
7653
  # @type RequestId: String
@@ -8035,17 +8083,17 @@ module TencentCloud
8035
8083
 
8036
8084
  # DescribeConfigReleaseLogs请求参数结构体
8037
8085
  class DescribeConfigReleaseLogsRequest < TencentCloud::Common::AbstractModel
8038
- # @param GroupId: 部署组ID,不传入时查询全量
8086
+ # @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
8087
  # @type GroupId: String
8040
- # @param Offset: 偏移量,默认为0
8088
+ # @param Offset: 偏移量,默认为0
8041
8089
  # @type Offset: Integer
8042
- # @param Limit: 每页条数,默认为20
8090
+ # @param Limit: 返回数量,默认为20,最大值为100。
8043
8091
  # @type Limit: Integer
8044
- # @param NamespaceId: 命名空间ID,不传入时查询全量
8092
+ # @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
8093
  # @type NamespaceId: String
8046
- # @param ClusterId: 集群ID,不传入时查询全量
8094
+ # @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
8095
  # @type ClusterId: String
8048
- # @param ApplicationId: 应用ID,不传入时查询全量
8096
+ # @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
8097
  # @type ApplicationId: String
8050
8098
 
8051
8099
  attr_accessor :GroupId, :Offset, :Limit, :NamespaceId, :ClusterId, :ApplicationId
@@ -8071,7 +8119,7 @@ module TencentCloud
8071
8119
 
8072
8120
  # DescribeConfigReleaseLogs返回参数结构体
8073
8121
  class DescribeConfigReleaseLogsResponse < TencentCloud::Common::AbstractModel
8074
- # @param Result: 分页的配置项发布历史列表
8122
+ # @param Result: 分页的配置项发布历史列表。
8075
8123
  # @type Result: :class:`Tencentcloud::Tsf.v20180326.models.TsfPageConfigReleaseLog`
8076
8124
  # @param RequestId: 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
8077
8125
  # @type RequestId: String
@@ -8094,21 +8142,21 @@ module TencentCloud
8094
8142
 
8095
8143
  # DescribeConfigReleases请求参数结构体
8096
8144
  class DescribeConfigReleasesRequest < TencentCloud::Common::AbstractModel
8097
- # @param ConfigName: 配置项名称,不传入时查询全量
8145
+ # @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
8146
  # @type ConfigName: String
8099
- # @param GroupId: 部署组ID,不传入时查询全量
8147
+ # @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
8148
  # @type GroupId: String
8101
- # @param NamespaceId: 命名空间ID,不传入时查询全量
8149
+ # @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
8150
  # @type NamespaceId: String
8103
- # @param ClusterId: 集群ID,不传入时查询全量
8151
+ # @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
8152
  # @type ClusterId: String
8105
- # @param Limit: 每页条数
8153
+ # @param Limit: 返回数量,默认为20,最大值为100。
8106
8154
  # @type Limit: Integer
8107
- # @param Offset: 偏移量
8155
+ # @param Offset: 偏移量,默认为0。
8108
8156
  # @type Offset: Integer
8109
- # @param ConfigId: 配置ID,不传入时查询全量
8157
+ # @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
8158
  # @type ConfigId: String
8111
- # @param ApplicationId: 应用ID,不传入时查询全量
8159
+ # @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
8160
  # @type ApplicationId: String
8113
8161
 
8114
8162
  attr_accessor :ConfigName, :GroupId, :NamespaceId, :ClusterId, :Limit, :Offset, :ConfigId, :ApplicationId
@@ -8138,7 +8186,7 @@ module TencentCloud
8138
8186
 
8139
8187
  # DescribeConfigReleases返回参数结构体
8140
8188
  class DescribeConfigReleasesResponse < TencentCloud::Common::AbstractModel
8141
- # @param Result: 分页的配置发布信息
8189
+ # @param Result: 分页的配置发布信息。
8142
8190
  # @type Result: :class:`Tencentcloud::Tsf.v20180326.models.TsfPageConfigRelease`
8143
8191
  # @param RequestId: 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
8144
8192
  # @type RequestId: String
@@ -8161,7 +8209,7 @@ module TencentCloud
8161
8209
 
8162
8210
  # DescribeConfig请求参数结构体
8163
8211
  class DescribeConfigRequest < TencentCloud::Common::AbstractModel
8164
- # @param ConfigId: 配置项ID
8212
+ # @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
8213
  # @type ConfigId: String
8166
8214
 
8167
8215
  attr_accessor :ConfigId
@@ -8177,7 +8225,7 @@ module TencentCloud
8177
8225
 
8178
8226
  # DescribeConfig返回参数结构体
8179
8227
  class DescribeConfigResponse < TencentCloud::Common::AbstractModel
8180
- # @param Result: 配置项
8228
+ # @param Result: 配置信息。
8181
8229
  # 注意:此字段可能返回 null,表示取不到有效值。
8182
8230
  # @type Result: :class:`Tencentcloud::Tsf.v20180326.models.Config`
8183
8231
  # @param RequestId: 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
@@ -8201,23 +8249,27 @@ module TencentCloud
8201
8249
 
8202
8250
  # DescribeConfigSummary请求参数结构体
8203
8251
  class DescribeConfigSummaryRequest < TencentCloud::Common::AbstractModel
8204
- # @param ApplicationId: 应用ID,不传入时查询全量
8252
+ # @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
8253
  # @type ApplicationId: String
8206
- # @param SearchWord: 查询关键字,模糊查询:应用名称,配置项名称,不传入时查询全量
8254
+ # @param SearchWord: 查询关键字,模糊查询:应用名称,配置项名称,不传入时查询全量。
8207
8255
  # @type SearchWord: String
8208
- # @param Offset: 偏移量,默认为0
8256
+ # @param Offset: 偏移量,默认为0
8209
8257
  # @type Offset: Integer
8210
- # @param Limit: 每页条数,默认为20
8258
+ # @param Limit: 返回数量,默认为20,最大值为50。
8211
8259
  # @type Limit: Integer
8212
- # @param OrderBy: 按时间排序:creation_time;按名称排序:config_name
8260
+ # @param OrderBy: 排序字段。
8261
+ # - creation_time:按时间排序
8262
+ # - config_name:按名称排序
8213
8263
  # @type OrderBy: String
8214
- # @param OrderType: 升序传 0,降序传 1
8264
+ # @param OrderType: 排序顺序。
8265
+ # - 0:升序
8266
+ # - 1:降序
8215
8267
  # @type OrderType: Integer
8216
- # @param ConfigTagList:
8268
+ # @param ConfigTagList: TAG标签资源值。
8217
8269
  # @type ConfigTagList: Array
8218
- # @param DisableProgramAuthCheck:
8270
+ # @param DisableProgramAuthCheck: 忽略传参,业务预留字段。
8219
8271
  # @type DisableProgramAuthCheck: Boolean
8220
- # @param ConfigIdList:
8272
+ # @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
8273
  # @type ConfigIdList: Array
8222
8274
 
8223
8275
  attr_accessor :ApplicationId, :SearchWord, :Offset, :Limit, :OrderBy, :OrderType, :ConfigTagList, :DisableProgramAuthCheck, :ConfigIdList
@@ -8249,7 +8301,7 @@ module TencentCloud
8249
8301
 
8250
8302
  # DescribeConfigSummary返回参数结构体
8251
8303
  class DescribeConfigSummaryResponse < TencentCloud::Common::AbstractModel
8252
- # @param Result: 配置项分页对象
8304
+ # @param Result: 配置项分页对象。
8253
8305
  # @type Result: :class:`Tencentcloud::Tsf.v20180326.models.TsfPageConfig`
8254
8306
  # @param RequestId: 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
8255
8307
  # @type RequestId: String
@@ -8272,7 +8324,7 @@ module TencentCloud
8272
8324
 
8273
8325
  # DescribeConfigTemplate请求参数结构体
8274
8326
  class DescribeConfigTemplateRequest < TencentCloud::Common::AbstractModel
8275
- # @param ConfigTemplateId: 配置模板Id
8327
+ # @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
8328
  # @type ConfigTemplateId: String
8277
8329
 
8278
8330
  attr_accessor :ConfigTemplateId
@@ -8288,7 +8340,7 @@ module TencentCloud
8288
8340
 
8289
8341
  # DescribeConfigTemplate返回参数结构体
8290
8342
  class DescribeConfigTemplateResponse < TencentCloud::Common::AbstractModel
8291
- # @param Result: 导入结果
8343
+ # @param Result: 导入结果。
8292
8344
  # @type Result: :class:`Tencentcloud::Tsf.v20180326.models.ConfigTemplate`
8293
8345
  # @param RequestId: 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
8294
8346
  # @type RequestId: String
@@ -8311,19 +8363,19 @@ module TencentCloud
8311
8363
 
8312
8364
  # DescribeConfigs请求参数结构体
8313
8365
  class DescribeConfigsRequest < TencentCloud::Common::AbstractModel
8314
- # @param ApplicationId: 应用ID,不传入时查询全量
8366
+ # @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
8367
  # @type ApplicationId: String
8316
- # @param ConfigId: 配置项ID,不传入时查询全量,高优先级
8368
+ # @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
8369
  # @type ConfigId: String
8318
- # @param Offset: 偏移量
8370
+ # @param Offset: 偏移量,默认为0。
8319
8371
  # @type Offset: Integer
8320
- # @param Limit: 每页条数
8372
+ # @param Limit: 返回数量,默认为20,最大值为100。
8321
8373
  # @type Limit: Integer
8322
- # @param ConfigIdList: 配置项ID列表,不传入时查询全量,低优先级
8374
+ # @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
8375
  # @type ConfigIdList: Array
8324
- # @param ConfigName: 配置项名称,精确查询,不传入时查询全量
8376
+ # @param ConfigName: 配置项名称,精确查询,不传入时查询全量。
8325
8377
  # @type ConfigName: String
8326
- # @param ConfigVersion: 配置项版本,精确查询,不传入时查询全量
8378
+ # @param ConfigVersion: 配置项版本,精确查询,不传入时查询全量。
8327
8379
  # @type ConfigVersion: String
8328
8380
 
8329
8381
  attr_accessor :ApplicationId, :ConfigId, :Offset, :Limit, :ConfigIdList, :ConfigName, :ConfigVersion
@@ -8351,7 +8403,7 @@ module TencentCloud
8351
8403
 
8352
8404
  # DescribeConfigs返回参数结构体
8353
8405
  class DescribeConfigsResponse < TencentCloud::Common::AbstractModel
8354
- # @param Result: 分页后的配置项列表
8406
+ # @param Result: 分页后的配置项列表。
8355
8407
  # @type Result: :class:`Tencentcloud::Tsf.v20180326.models.TsfPageConfig`
8356
8408
  # @param RequestId: 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
8357
8409
  # @type RequestId: String
@@ -8629,9 +8681,9 @@ module TencentCloud
8629
8681
 
8630
8682
  # DescribeCreateGatewayApiStatus请求参数结构体
8631
8683
  class DescribeCreateGatewayApiStatusRequest < TencentCloud::Common::AbstractModel
8632
- # @param GroupId: 所属分组ID
8684
+ # @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
8685
  # @type GroupId: String
8634
- # @param MicroserviceId: 微服务ID
8686
+ # @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
8687
  # @type MicroserviceId: String
8636
8688
 
8637
8689
  attr_accessor :GroupId, :MicroserviceId
@@ -8649,7 +8701,9 @@ module TencentCloud
8649
8701
 
8650
8702
  # DescribeCreateGatewayApiStatus返回参数结构体
8651
8703
  class DescribeCreateGatewayApiStatusResponse < TencentCloud::Common::AbstractModel
8652
- # @param Result: 是否已完成导入任务
8704
+ # @param Result: 导入任务状态执行结果。
8705
+ # - true:已完成
8706
+ # - false:未完成
8653
8707
  # @type Result: Boolean
8654
8708
  # @param RequestId: 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
8655
8709
  # @type RequestId: String
@@ -8802,13 +8856,13 @@ module TencentCloud
8802
8856
 
8803
8857
  # DescribeDownloadInfo请求参数结构体
8804
8858
  class DescribeDownloadInfoRequest < TencentCloud::Common::AbstractModel
8805
- # @param ApplicationId: 应用ID
8859
+ # @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
8860
  # @type ApplicationId: String
8807
- # @param PkgId: 程序包ID
8861
+ # @param PkgId: 软件包ID可通过调用DescribeUploadInfo接口时[获取上传程序包信息](https://cloud.tencent.com/document/api/649/36078)返回的COS上传信息获取,登录[控制台](https://console.cloud.tencent.com/tsf/product?rid=1)进行查看
8808
8862
  # @type PkgId: String
8809
- # @param RepositoryId: 程序包仓库ID
8863
+ # @param RepositoryId: 仓库ID,可通过调用[仓库信息查询类](https://cloud.tencent.com/document/api/649/45925)接口时出参中的RepositoryId,或登录[控制台](https://console.cloud.tencent.com/tsf/product?rid=1)进行查看
8810
8864
  # @type RepositoryId: String
8811
- # @param RepositoryType: 程序包仓库类型
8865
+ # @param RepositoryType: 程序包仓库类型(允许值:"public-demo"TSF公共demo仓库, "private"自定义仓库, "default"TSF公共仓库)
8812
8866
  # @type RepositoryType: String
8813
8867
 
8814
8868
  attr_accessor :ApplicationId, :PkgId, :RepositoryId, :RepositoryType
@@ -8892,21 +8946,21 @@ module TencentCloud
8892
8946
 
8893
8947
  # DescribeFileConfigReleases请求参数结构体
8894
8948
  class DescribeFileConfigReleasesRequest < TencentCloud::Common::AbstractModel
8895
- # @param ConfigId: 配置项ID
8949
+ # @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
8950
  # @type ConfigId: String
8897
- # @param ConfigName: 配置项名称
8951
+ # @param ConfigName: 配置项名称,最多支持60个字符,只能包含字母、数字及分隔符(“-”,“_”),且不能以分隔符开头或结尾。
8898
8952
  # @type ConfigName: String
8899
- # @param GroupId: 部署组ID
8953
+ # @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
8954
  # @type GroupId: String
8901
- # @param NamespaceId: 命名空间ID
8955
+ # @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
8956
  # @type NamespaceId: String
8903
- # @param ClusterId: 集群ID
8957
+ # @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
8958
  # @type ClusterId: String
8905
- # @param ApplicationId: 应用ID
8959
+ # @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
8960
  # @type ApplicationId: String
8907
- # @param Offset: 偏移量
8961
+ # @param Offset: 偏移量,默认为0。
8908
8962
  # @type Offset: Integer
8909
- # @param Limit: 每页条数
8963
+ # @param Limit: 返回数量,默认为20,最大值为100。
8910
8964
  # @type Limit: Integer
8911
8965
 
8912
8966
  attr_accessor :ConfigId, :ConfigName, :GroupId, :NamespaceId, :ClusterId, :ApplicationId, :Offset, :Limit
@@ -8936,7 +8990,7 @@ module TencentCloud
8936
8990
 
8937
8991
  # DescribeFileConfigReleases返回参数结构体
8938
8992
  class DescribeFileConfigReleasesResponse < TencentCloud::Common::AbstractModel
8939
- # @param Result: 配置项发布信息列表
8993
+ # @param Result: 配置项发布信息列表。
8940
8994
  # @type Result: :class:`Tencentcloud::Tsf.v20180326.models.TsfPageFileConfigRelease`
8941
8995
  # @param RequestId: 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
8942
8996
  # @type RequestId: String
@@ -8959,19 +9013,19 @@ module TencentCloud
8959
9013
 
8960
9014
  # DescribeFileConfigs请求参数结构体
8961
9015
  class DescribeFileConfigsRequest < TencentCloud::Common::AbstractModel
8962
- # @param ConfigId: 配置项ID
9016
+ # @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
9017
  # @type ConfigId: String
8964
- # @param ConfigIdList: 配置项ID列表
9018
+ # @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
9019
  # @type ConfigIdList: Array
8966
- # @param ConfigName: 配置项名称
9020
+ # @param ConfigName: 配置项名称。
8967
9021
  # @type ConfigName: String
8968
- # @param ApplicationId: 应用ID
9022
+ # @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
9023
  # @type ApplicationId: String
8970
- # @param Offset: 偏移量
9024
+ # @param Offset: 偏移量,默认为0。
8971
9025
  # @type Offset: Integer
8972
- # @param Limit: 每页条数
9026
+ # @param Limit: 返回数量,默认为20,最大值为100。
8973
9027
  # @type Limit: Integer
8974
- # @param ConfigVersion: 配置项版本
9028
+ # @param ConfigVersion: 配置项版本。
8975
9029
  # @type ConfigVersion: String
8976
9030
 
8977
9031
  attr_accessor :ConfigId, :ConfigIdList, :ConfigName, :ApplicationId, :Offset, :Limit, :ConfigVersion
@@ -8999,7 +9053,7 @@ module TencentCloud
8999
9053
 
9000
9054
  # DescribeFileConfigs返回参数结构体
9001
9055
  class DescribeFileConfigsResponse < TencentCloud::Common::AbstractModel
9002
- # @param Result: 文件配置项列表
9056
+ # @param Result: 文件配置项列表。
9003
9057
  # @type Result: :class:`Tencentcloud::Tsf.v20180326.models.TsfPageFileConfig`
9004
9058
  # @param RequestId: 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
9005
9059
  # @type RequestId: String
@@ -9022,7 +9076,7 @@ module TencentCloud
9022
9076
 
9023
9077
  # DescribeFlowLastBatchState请求参数结构体
9024
9078
  class DescribeFlowLastBatchStateRequest < TencentCloud::Common::AbstractModel
9025
- # @param FlowId: 工作流 ID
9079
+ # @param FlowId: 工作流 ID。前往[工作流管理](https://console.cloud.tencent.com/tsf/tct?rid=1&tab=workflowManage),在工作流列表第一列和工作流详情页查看工作流ID。
9026
9080
  # @type FlowId: String
9027
9081
 
9028
9082
  attr_accessor :FlowId
@@ -9441,7 +9495,7 @@ module TencentCloud
9441
9495
 
9442
9496
  # DescribeGroupRelease请求参数结构体
9443
9497
  class DescribeGroupReleaseRequest < TencentCloud::Common::AbstractModel
9444
- # @param GroupId: 部署组ID
9498
+ # @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
9499
  # @type GroupId: String
9446
9500
 
9447
9501
  attr_accessor :GroupId
@@ -9457,7 +9511,7 @@ module TencentCloud
9457
9511
 
9458
9512
  # DescribeGroupRelease返回参数结构体
9459
9513
  class DescribeGroupReleaseResponse < TencentCloud::Common::AbstractModel
9460
- # @param Result: 部署组发布的相关信息
9514
+ # @param Result: 部署组发布的相关信息。
9461
9515
  # @type Result: :class:`Tencentcloud::Tsf.v20180326.models.GroupRelease`
9462
9516
  # @param RequestId: 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
9463
9517
  # @type RequestId: String
@@ -10347,15 +10401,15 @@ module TencentCloud
10347
10401
 
10348
10402
  # DescribeLaneRules请求参数结构体
10349
10403
  class DescribeLaneRulesRequest < TencentCloud::Common::AbstractModel
10350
- # @param Limit: 每页展示的条数
10404
+ # @param Limit: 返回数量,默认为20,最大值为500。
10351
10405
  # @type Limit: Integer
10352
- # @param Offset: 翻页偏移量
10406
+ # @param Offset: 偏移量,默认为0。
10353
10407
  # @type Offset: Integer
10354
- # @param SearchWord: 搜索关键词
10408
+ # @param SearchWord: 搜索关键词。
10355
10409
  # @type SearchWord: String
10356
- # @param RuleId: 泳道规则ID(用于精确搜索)
10410
+ # @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
10411
  # @type RuleId: String
10358
- # @param RuleIdList:
10412
+ # @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
10413
  # @type RuleIdList: Array
10360
10414
 
10361
10415
  attr_accessor :Limit, :Offset, :SearchWord, :RuleId, :RuleIdList
@@ -10379,7 +10433,7 @@ module TencentCloud
10379
10433
 
10380
10434
  # DescribeLaneRules返回参数结构体
10381
10435
  class DescribeLaneRulesResponse < TencentCloud::Common::AbstractModel
10382
- # @param Result: 泳道规则列表
10436
+ # @param Result: 灰度发布规则列表。
10383
10437
  # @type Result: :class:`Tencentcloud::Tsf.v20180326.models.LaneRules`
10384
10438
  # @param RequestId: 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
10385
10439
  # @type RequestId: String
@@ -10402,15 +10456,15 @@ module TencentCloud
10402
10456
 
10403
10457
  # DescribeLanes请求参数结构体
10404
10458
  class DescribeLanesRequest < TencentCloud::Common::AbstractModel
10405
- # @param Limit: 每页展示的条数
10459
+ # @param Limit: 返回数量,默认为20,最大值为100。
10406
10460
  # @type Limit: Integer
10407
- # @param Offset: 翻页偏移量
10461
+ # @param Offset: 偏移量,默认为0。
10408
10462
  # @type Offset: Integer
10409
- # @param SearchWord: 搜索关键字
10463
+ # @param SearchWord: 搜索关键字。
10410
10464
  # @type SearchWord: String
10411
- # @param LaneIdList:
10465
+ # @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
10466
  # @type LaneIdList: Array
10413
- # @param DisableProgramAuthCheck:
10467
+ # @param DisableProgramAuthCheck: 忽略传参,业务预留字段。
10414
10468
  # @type DisableProgramAuthCheck: Boolean
10415
10469
 
10416
10470
  attr_accessor :Limit, :Offset, :SearchWord, :LaneIdList, :DisableProgramAuthCheck
@@ -10434,7 +10488,7 @@ module TencentCloud
10434
10488
 
10435
10489
  # DescribeLanes返回参数结构体
10436
10490
  class DescribeLanesResponse < TencentCloud::Common::AbstractModel
10437
- # @param Result: 泳道列表
10491
+ # @param Result: 泳道配置列表。
10438
10492
  # @type Result: :class:`Tencentcloud::Tsf.v20180326.models.LaneInfos`
10439
10493
  # @param RequestId: 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
10440
10494
  # @type RequestId: String
@@ -10536,15 +10590,21 @@ module TencentCloud
10536
10590
 
10537
10591
  # DescribeMicroservice请求参数结构体
10538
10592
  class DescribeMicroserviceRequest < TencentCloud::Common::AbstractModel
10539
- # @param MicroserviceId: 微服务ID
10593
+ # @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
10594
  # @type MicroserviceId: String
10541
- # @param Offset: 偏移量
10595
+ # @param Offset: 偏移量,默认为0。
10542
10596
  # @type Offset: Integer
10543
- # @param Limit: 分页个数
10597
+ # @param Limit: 返回数量,默认为20,最大值为50。
10544
10598
  # @type Limit: Integer
10545
- # @param GroupIds: 可选,根据部署组ID进行过滤
10599
+ # @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
10600
  # @type GroupIds: Array
10547
- # @param Filters: 过滤条件。多个 filter 之间是与关系,单个 filter 多个 value 之间是或关系。filter name 取值有:id(实例id)、name(实例名)、lan-ip(内网ip)、node-ip(所在节点ip)
10601
+ # @param Filters: 过滤条件。多个 filter 之间是与关系,单个 filter 多个 value 之间是或关系。
10602
+ # 参考:[{"Name":"LanIp","Values":["172.16.16.139"]}]
10603
+ # filter name 取值范围:
10604
+ # - id:实例ID
10605
+ # - name:实例名
10606
+ # - lan-ip:内网IP
10607
+ # - node-ip:所在节点IP
10548
10608
  # @type Filters: Array
10549
10609
 
10550
10610
  attr_accessor :MicroserviceId, :Offset, :Limit, :GroupIds, :Filters
@@ -10575,7 +10635,7 @@ module TencentCloud
10575
10635
 
10576
10636
  # DescribeMicroservice返回参数结构体
10577
10637
  class DescribeMicroserviceResponse < TencentCloud::Common::AbstractModel
10578
- # @param Result: 微服务详情实例列表
10638
+ # @param Result: 微服务详情实例列表。
10579
10639
  # @type Result: :class:`Tencentcloud::Tsf.v20180326.models.TsfPageMsInstance`
10580
10640
  # @param RequestId: 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
10581
10641
  # @type RequestId: String
@@ -10598,7 +10658,7 @@ module TencentCloud
10598
10658
 
10599
10659
  # DescribeMicroservicesByGroupIds请求参数结构体
10600
10660
  class DescribeMicroservicesByGroupIdsRequest < TencentCloud::Common::AbstractModel
10601
- # @param GroupIds: 部署组ID列表
10661
+ # @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
10662
  # @type GroupIds: Array
10603
10663
 
10604
10664
  attr_accessor :GroupIds
@@ -10614,7 +10674,7 @@ module TencentCloud
10614
10674
 
10615
10675
  # DescribeMicroservicesByGroupIds返回参数结构体
10616
10676
  class DescribeMicroservicesByGroupIdsResponse < TencentCloud::Common::AbstractModel
10617
- # @param Result: 微服务信息分页列表
10677
+ # @param Result: 微服务信息分页列表。
10618
10678
  # @type Result: :class:`Tencentcloud::Tsf.v20180326.models.TsfPageMicroservice`
10619
10679
  # @param RequestId: 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
10620
10680
  # @type RequestId: String
@@ -10637,25 +10697,32 @@ module TencentCloud
10637
10697
 
10638
10698
  # DescribeMicroservices请求参数结构体
10639
10699
  class DescribeMicroservicesRequest < TencentCloud::Common::AbstractModel
10640
- # @param NamespaceId: 命名空间ID
10700
+ # @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
10701
  # @type NamespaceId: String
10642
- # @param SearchWord: 搜索字段
10702
+ # @param SearchWord: 搜索字段。
10643
10703
  # @type SearchWord: String
10644
- # @param OrderBy: 排序字段
10704
+ # @param OrderBy: 排序字段。
10705
+ # - create_time:创建时间
10706
+ # 默认为创建时间,暂不支持其他值。
10645
10707
  # @type OrderBy: String
10646
- # @param OrderType: 排序类型
10708
+ # @param OrderType: 排序类型。
10709
+ # - 1:倒序
10710
+ # 默认为倒序,暂不支持其他值。
10647
10711
  # @type OrderType: Integer
10648
- # @param Offset: 偏移量
10712
+ # @param Offset: 偏移量,默认为0。
10649
10713
  # @type Offset: Integer
10650
- # @param Limit: 分页个数
10714
+ # @param Limit: 返回数量,默认为20,最大值为50。
10651
10715
  # @type Limit: Integer
10652
- # @param Status: 状态过滤,online、offline、single_online
10716
+ # @param Status: 状态。
10717
+ # - online:在线
10718
+ # - offline:离线
10719
+ # - single_online:单点在线
10653
10720
  # @type Status: Array
10654
- # @param MicroserviceIdList: IdList
10721
+ # @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
10722
  # @type MicroserviceIdList: Array
10656
- # @param MicroserviceNameList: 搜索的服务名列表
10723
+ # @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
10724
  # @type MicroserviceNameList: Array
10658
- # @param ConfigCenterInstanceId: 注册中心实例id
10725
+ # @param ConfigCenterInstanceId: 注册中心实例ID。业务预留参数,忽略传参。
10659
10726
  # @type ConfigCenterInstanceId: String
10660
10727
 
10661
10728
  attr_accessor :NamespaceId, :SearchWord, :OrderBy, :OrderType, :Offset, :Limit, :Status, :MicroserviceIdList, :MicroserviceNameList, :ConfigCenterInstanceId
@@ -10689,7 +10756,7 @@ module TencentCloud
10689
10756
 
10690
10757
  # DescribeMicroservices返回参数结构体
10691
10758
  class DescribeMicroservicesResponse < TencentCloud::Common::AbstractModel
10692
- # @param Result: 微服务分页列表信息
10759
+ # @param Result: 微服务分页列表信息。
10693
10760
  # @type Result: :class:`Tencentcloud::Tsf.v20180326.models.TsfPageMicroservice`
10694
10761
  # @param RequestId: 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
10695
10762
  # @type RequestId: String
@@ -10712,13 +10779,13 @@ module TencentCloud
10712
10779
 
10713
10780
  # DescribeMsApiList请求参数结构体
10714
10781
  class DescribeMsApiListRequest < TencentCloud::Common::AbstractModel
10715
- # @param MicroserviceId: 微服务ID
10782
+ # @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
10783
  # @type MicroserviceId: String
10717
- # @param SearchWord: 搜索关键字
10784
+ # @param SearchWord: 搜索关键字。
10718
10785
  # @type SearchWord: String
10719
- # @param Limit: 每页的数量
10786
+ # @param Limit: 返回数量,默认为20,最大值为50。
10720
10787
  # @type Limit: Integer
10721
- # @param Offset: 翻页偏移量
10788
+ # @param Offset: 偏移量,默认为0。
10722
10789
  # @type Offset: Integer
10723
10790
 
10724
10791
  attr_accessor :MicroserviceId, :SearchWord, :Limit, :Offset
@@ -10740,7 +10807,7 @@ module TencentCloud
10740
10807
 
10741
10808
  # DescribeMsApiList返回参数结构体
10742
10809
  class DescribeMsApiListResponse < TencentCloud::Common::AbstractModel
10743
- # @param Result: 相应结果
10810
+ # @param Result: 微服务API列表。
10744
10811
  # @type Result: :class:`Tencentcloud::Tsf.v20180326.models.TsfApiListResponse`
10745
10812
  # @param RequestId: 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
10746
10813
  # @type RequestId: String
@@ -10912,21 +10979,21 @@ module TencentCloud
10912
10979
 
10913
10980
  # DescribePkgs请求参数结构体
10914
10981
  class DescribePkgsRequest < TencentCloud::Common::AbstractModel
10915
- # @param ApplicationId: 应用ID(只传入应用ID,返回该应用下所有软件包信息)
10982
+ # @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
10983
  # @type ApplicationId: String
10917
10984
  # @param SearchWord: 查询关键字(支持根据包ID,包名,包版本号搜索)
10918
10985
  # @type SearchWord: String
10919
- # @param OrderBy: 排序关键字(默认为"UploadTime":上传时间)
10986
+ # @param OrderBy: 排序关键字(默认值"UploadTime"),允许值:"UploadTime"上传时间, "name"程序包名, "size"应用大小, "id"程序包ID
10920
10987
  # @type OrderBy: String
10921
10988
  # @param OrderType: 升序:0/降序:1(默认降序)
10922
10989
  # @type OrderType: Integer
10923
- # @param Offset: 查询起始偏移
10990
+ # @param Offset: 查询起始偏移,大于等于0,默认值为0
10924
10991
  # @type Offset: Integer
10925
10992
  # @param Limit: 返回数量限制
10926
10993
  # @type Limit: Integer
10927
- # @param RepositoryType: 程序包仓库类型
10994
+ # @param RepositoryType: 程序包仓库类型,允许值:"public-demo"TSF公共demo仓库, "private"自定义仓库, "default"TSF公共仓库
10928
10995
  # @type RepositoryType: String
10929
- # @param RepositoryId: 程序包仓库id
10996
+ # @param RepositoryId: 仓库ID,可通过调用[仓库信息查询类](https://cloud.tencent.com/document/api/649/45925)接口时出参中的RepositoryId,或登录[控制台](https://console.cloud.tencent.com/tsf/product?rid=1)进行查看
10930
10997
  # @type RepositoryId: String
10931
10998
  # @param PackageTypeList: 程序包类型数组支持(fatjar jar war tar.gz zip)
10932
10999
  # @type PackageTypeList: Array
@@ -11148,11 +11215,11 @@ module TencentCloud
11148
11215
 
11149
11216
  # DescribePublicConfigReleaseLogs请求参数结构体
11150
11217
  class DescribePublicConfigReleaseLogsRequest < TencentCloud::Common::AbstractModel
11151
- # @param NamespaceId: 命名空间ID,不传入时查询全量
11218
+ # @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
11219
  # @type NamespaceId: String
11153
- # @param Offset: 偏移量,默认为0
11220
+ # @param Offset: 偏移量,默认为0
11154
11221
  # @type Offset: Integer
11155
- # @param Limit: 每页条数,默认为20
11222
+ # @param Limit: 返回数量,默认为20,最大值为100。
11156
11223
  # @type Limit: Integer
11157
11224
 
11158
11225
  attr_accessor :NamespaceId, :Offset, :Limit
@@ -11172,7 +11239,7 @@ module TencentCloud
11172
11239
 
11173
11240
  # DescribePublicConfigReleaseLogs返回参数结构体
11174
11241
  class DescribePublicConfigReleaseLogsResponse < TencentCloud::Common::AbstractModel
11175
- # @param Result: 分页后的公共配置项发布历史列表
11242
+ # @param Result: 分页后的公共配置项发布历史列表。
11176
11243
  # @type Result: :class:`Tencentcloud::Tsf.v20180326.models.TsfPageConfigReleaseLog`
11177
11244
  # @param RequestId: 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
11178
11245
  # @type RequestId: String
@@ -11195,15 +11262,15 @@ module TencentCloud
11195
11262
 
11196
11263
  # DescribePublicConfigReleases请求参数结构体
11197
11264
  class DescribePublicConfigReleasesRequest < TencentCloud::Common::AbstractModel
11198
- # @param ConfigName: 配置项名称,不传入时查询全量
11265
+ # @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
11266
  # @type ConfigName: String
11200
- # @param NamespaceId: 命名空间ID,不传入时查询全量
11267
+ # @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
11268
  # @type NamespaceId: String
11202
- # @param Limit: 每页条数
11269
+ # @param Limit: 返回数量,默认为20,最大值为100。
11203
11270
  # @type Limit: Integer
11204
- # @param Offset: 偏移量
11271
+ # @param Offset: 偏移量,默认为0。
11205
11272
  # @type Offset: Integer
11206
- # @param ConfigId: 配置项ID,不传入时查询全量
11273
+ # @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
11274
  # @type ConfigId: String
11208
11275
 
11209
11276
  attr_accessor :ConfigName, :NamespaceId, :Limit, :Offset, :ConfigId
@@ -11227,7 +11294,7 @@ module TencentCloud
11227
11294
 
11228
11295
  # DescribePublicConfigReleases返回参数结构体
11229
11296
  class DescribePublicConfigReleasesResponse < TencentCloud::Common::AbstractModel
11230
- # @param Result: 公共配置发布信息
11297
+ # @param Result: 公共配置发布信息。
11231
11298
  # @type Result: :class:`Tencentcloud::Tsf.v20180326.models.TsfPageConfigRelease`
11232
11299
  # @param RequestId: 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
11233
11300
  # @type RequestId: String
@@ -11250,7 +11317,7 @@ module TencentCloud
11250
11317
 
11251
11318
  # DescribePublicConfig请求参数结构体
11252
11319
  class DescribePublicConfigRequest < TencentCloud::Common::AbstractModel
11253
- # @param ConfigId: 需要查询的配置项ID
11320
+ # @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
11321
  # @type ConfigId: String
11255
11322
 
11256
11323
  attr_accessor :ConfigId
@@ -11266,7 +11333,7 @@ module TencentCloud
11266
11333
 
11267
11334
  # DescribePublicConfig返回参数结构体
11268
11335
  class DescribePublicConfigResponse < TencentCloud::Common::AbstractModel
11269
- # @param Result: 全局配置
11336
+ # @param Result: 全局配置。
11270
11337
  # 注意:此字段可能返回 null,表示取不到有效值。
11271
11338
  # @type Result: :class:`Tencentcloud::Tsf.v20180326.models.Config`
11272
11339
  # @param RequestId: 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
@@ -11290,21 +11357,25 @@ module TencentCloud
11290
11357
 
11291
11358
  # DescribePublicConfigSummary请求参数结构体
11292
11359
  class DescribePublicConfigSummaryRequest < TencentCloud::Common::AbstractModel
11293
- # @param SearchWord: 查询关键字,模糊查询:配置项名称,不传入时查询全量
11360
+ # @param SearchWord: 查询关键字,模糊查询:配置项名称,不传入时查询全量。
11294
11361
  # @type SearchWord: String
11295
- # @param Offset: 偏移量,默认为0
11362
+ # @param Offset: 偏移量,默认为0
11296
11363
  # @type Offset: Integer
11297
- # @param Limit: 每页条数,默认为20
11364
+ # @param Limit: 返回数量,默认为20,最大值为50。
11298
11365
  # @type Limit: Integer
11299
- # @param OrderBy: 按时间排序:creation_time;按名称排序:config_name
11366
+ # @param OrderBy: 排序字段。
11367
+ # - creation_time:按时间排序
11368
+ # - config_name:按名称排序
11300
11369
  # @type OrderBy: String
11301
- # @param OrderType: 升序传 0,降序传 1
11370
+ # @param OrderType: 排序顺序。
11371
+ # - 0:升序
11372
+ # - 1:降序
11302
11373
  # @type OrderType: Integer
11303
- # @param ConfigTagList:
11374
+ # @param ConfigTagList: TAG标签资源值。
11304
11375
  # @type ConfigTagList: Array
11305
- # @param DisableProgramAuthCheck:
11376
+ # @param DisableProgramAuthCheck: 忽略传参,业务预留字段。
11306
11377
  # @type DisableProgramAuthCheck: Boolean
11307
- # @param ConfigIdList:
11378
+ # @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
11379
  # @type ConfigIdList: Array
11309
11380
 
11310
11381
  attr_accessor :SearchWord, :Offset, :Limit, :OrderBy, :OrderType, :ConfigTagList, :DisableProgramAuthCheck, :ConfigIdList
@@ -11334,7 +11405,7 @@ module TencentCloud
11334
11405
 
11335
11406
  # DescribePublicConfigSummary返回参数结构体
11336
11407
  class DescribePublicConfigSummaryResponse < TencentCloud::Common::AbstractModel
11337
- # @param Result: 分页的全局配置统计信息列表
11408
+ # @param Result: 分页的全局配置统计信息列表。
11338
11409
  # @type Result: :class:`Tencentcloud::Tsf.v20180326.models.TsfPageConfig`
11339
11410
  # @param RequestId: 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
11340
11411
  # @type RequestId: String
@@ -11357,17 +11428,17 @@ module TencentCloud
11357
11428
 
11358
11429
  # DescribePublicConfigs请求参数结构体
11359
11430
  class DescribePublicConfigsRequest < TencentCloud::Common::AbstractModel
11360
- # @param ConfigId: 配置项ID,不传入时查询全量,高优先级
11431
+ # @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
11432
  # @type ConfigId: String
11362
- # @param Offset: 偏移量,默认为0
11433
+ # @param Offset: 偏移量,默认为0
11363
11434
  # @type Offset: Integer
11364
- # @param Limit: 每页条数,默认为20
11435
+ # @param Limit: 返回数量,默认为20,最大值为100。
11365
11436
  # @type Limit: Integer
11366
- # @param ConfigIdList: 配置项ID列表,不传入时查询全量,低优先级
11437
+ # @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
11438
  # @type ConfigIdList: Array
11368
- # @param ConfigName: 配置项名称,精确查询,不传入时查询全量
11439
+ # @param ConfigName: 配置项名称,精确查询,不传入时查询全量。
11369
11440
  # @type ConfigName: String
11370
- # @param ConfigVersion: 配置项版本,精确查询,不传入时查询全量
11441
+ # @param ConfigVersion: 配置项版本,精确查询,不传入时查询全量。
11371
11442
  # @type ConfigVersion: String
11372
11443
 
11373
11444
  attr_accessor :ConfigId, :Offset, :Limit, :ConfigIdList, :ConfigName, :ConfigVersion
@@ -11393,7 +11464,7 @@ module TencentCloud
11393
11464
 
11394
11465
  # DescribePublicConfigs返回参数结构体
11395
11466
  class DescribePublicConfigsResponse < TencentCloud::Common::AbstractModel
11396
- # @param Result: 分页后的全局配置项列表
11467
+ # @param Result: 分页后的全局配置项列表。
11397
11468
  # @type Result: :class:`Tencentcloud::Tsf.v20180326.models.TsfPageConfig`
11398
11469
  # @param RequestId: 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
11399
11470
  # @type RequestId: String
@@ -11416,7 +11487,7 @@ module TencentCloud
11416
11487
 
11417
11488
  # DescribeReleasedConfig请求参数结构体
11418
11489
  class DescribeReleasedConfigRequest < TencentCloud::Common::AbstractModel
11419
- # @param GroupId: 部署组ID
11490
+ # @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
11491
  # @type GroupId: String
11421
11492
 
11422
11493
  attr_accessor :GroupId
@@ -11432,7 +11503,7 @@ module TencentCloud
11432
11503
 
11433
11504
  # DescribeReleasedConfig返回参数结构体
11434
11505
  class DescribeReleasedConfigResponse < TencentCloud::Common::AbstractModel
11435
- # @param Result: 已发布的配置内容
11506
+ # @param Result: 已发布的配置内容。
11436
11507
  # @type Result: String
11437
11508
  # @param RequestId: 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
11438
11509
  # @type RequestId: String
@@ -11454,11 +11525,11 @@ module TencentCloud
11454
11525
  class DescribeRepositoriesRequest < TencentCloud::Common::AbstractModel
11455
11526
  # @param SearchWord: 查询关键字(按照仓库名称搜索)
11456
11527
  # @type SearchWord: String
11457
- # @param Offset: 查询起始偏移
11528
+ # @param Offset: 查询起始偏移,大于等于0,默认值为0
11458
11529
  # @type Offset: Integer
11459
- # @param Limit: 返回数量限制
11530
+ # @param Limit: 返回数量限制,大于0,默认为不分页
11460
11531
  # @type Limit: Integer
11461
- # @param RepositoryType: 仓库类型(默认仓库:default,私有仓库:private)
11532
+ # @param RepositoryType: 仓库类型(默认仓库:default,私有仓库:private,公共仓库:public-demo
11462
11533
  # @type RepositoryType: String
11463
11534
 
11464
11535
  attr_accessor :SearchWord, :Offset, :Limit, :RepositoryType
@@ -11503,7 +11574,7 @@ module TencentCloud
11503
11574
 
11504
11575
  # DescribeRepository请求参数结构体
11505
11576
  class DescribeRepositoryRequest < TencentCloud::Common::AbstractModel
11506
- # @param RepositoryId: 仓库ID
11577
+ # @param RepositoryId: 仓库ID,可通过调用[仓库信息查询类](https://cloud.tencent.com/document/api/649/45925)接口时出参中的RepositoryId,或登录[控制台](https://console.cloud.tencent.com/tsf/product?rid=1)进行查看
11507
11578
  # @type RepositoryId: String
11508
11579
 
11509
11580
  attr_accessor :RepositoryId
@@ -12210,9 +12281,9 @@ module TencentCloud
12210
12281
 
12211
12282
  # DescribeTaskDetail请求参数结构体
12212
12283
  class DescribeTaskDetailRequest < TencentCloud::Common::AbstractModel
12213
- # @param TaskId: 任务ID
12284
+ # @param TaskId: 任务ID。在[任务管理](https://console.cloud.tencent.com/tsf/tct?rid=1)列表页第一列和任务基本信息页查看任务ID。
12214
12285
  # @type TaskId: String
12215
- # @param TaskLogId: 任务历史ID
12286
+ # @param TaskLogId: 任务历史ID。查询任务列表 [DescribeTaskRecords](https://cloud.tencent.com/document/api/649/56136) 返回值字段 TaskLogId
12216
12287
  # @type TaskLogId: String
12217
12288
 
12218
12289
  attr_accessor :TaskId, :TaskLogId
@@ -12253,7 +12324,7 @@ module TencentCloud
12253
12324
 
12254
12325
  # DescribeTaskLastStatus请求参数结构体
12255
12326
  class DescribeTaskLastStatusRequest < TencentCloud::Common::AbstractModel
12256
- # @param TaskId: 任务ID
12327
+ # @param TaskId: 任务ID。在[任务管理](https://console.cloud.tencent.com/tsf/tct?rid=1)列表页第一列和任务基本信息页查看任务ID。
12257
12328
  # @type TaskId: String
12258
12329
 
12259
12330
  attr_accessor :TaskId
@@ -12292,21 +12363,21 @@ module TencentCloud
12292
12363
 
12293
12364
  # DescribeTaskRecords请求参数结构体
12294
12365
  class DescribeTaskRecordsRequest < TencentCloud::Common::AbstractModel
12295
- # @param Offset: 翻页偏移量。
12366
+ # @param Offset: 翻页偏移量。默认值为0
12296
12367
  # @type Offset: Integer
12297
- # @param Limit: 翻页查询单页数量。
12368
+ # @param Limit: 翻页查询单页数量。默认值为 20,最大值为 1000
12298
12369
  # @type Limit: Integer
12299
12370
  # @param SearchWord: 模糊查询关键字,支持任务ID和任务名称。
12300
12371
  # @type SearchWord: String
12301
- # @param TaskState: 任务启用状态。enabled/disabled
12372
+ # @param TaskState: 任务启用状态。一共2种状态可选,ENABLED:启用,DISABLED:停用
12302
12373
  # @type TaskState: String
12303
- # @param GroupId: 分组ID。
12374
+ # @param GroupId: 部署组ID。前往应用管理 - 应用部署,部署组列表页面获取部署组ID
12304
12375
  # @type GroupId: String
12305
- # @param TaskType: 任务类型。
12376
+ # @param TaskType: 任务类型。当前只支持一种任务类型。枚举值,java:Java类任务
12306
12377
  # @type TaskType: String
12307
- # @param ExecuteType: 任务触发类型,UNICAST、BROADCAST。
12378
+ # @param ExecuteType: 任务执行方式,unicast:随机单节点执行,broadcast:广播执行,shard:分片执行
12308
12379
  # @type ExecuteType: String
12309
- # @param Ids:
12380
+ # @param Ids: 任务ID列表。
12310
12381
  # @type Ids: Array
12311
12382
 
12312
12383
  attr_accessor :Offset, :Limit, :SearchWord, :TaskState, :GroupId, :TaskType, :ExecuteType, :Ids
@@ -12634,7 +12705,7 @@ module TencentCloud
12634
12705
 
12635
12706
  # DescribeUploadInfo请求参数结构体
12636
12707
  class DescribeUploadInfoRequest < TencentCloud::Common::AbstractModel
12637
- # @param ApplicationId: 应用ID
12708
+ # @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
12709
  # @type ApplicationId: String
12639
12710
  # @param PkgName: 程序包名
12640
12711
  # @type PkgName: String
@@ -12644,9 +12715,9 @@ module TencentCloud
12644
12715
  # @type PkgType: String
12645
12716
  # @param PkgDesc: 程序包介绍
12646
12717
  # @type PkgDesc: String
12647
- # @param RepositoryType: 程序包仓库类型
12718
+ # @param RepositoryType: 仓库类型(默认仓库:default,私有仓库:private,公共仓库:public-demo)
12648
12719
  # @type RepositoryType: String
12649
- # @param RepositoryId: 程序包仓库id
12720
+ # @param RepositoryId: 仓库ID,可通过调用[仓库信息查询类](https://cloud.tencent.com/document/api/649/45925)接口时出参中的RepositoryId,或登录[控制台](https://console.cloud.tencent.com/tsf/product?rid=1)进行查看
12650
12721
  # @type RepositoryId: String
12651
12722
 
12652
12723
  attr_accessor :ApplicationId, :PkgName, :PkgVersion, :PkgType, :PkgDesc, :RepositoryType, :RepositoryId
@@ -12744,7 +12815,7 @@ module TencentCloud
12744
12815
 
12745
12816
  # DisableLaneRule请求参数结构体
12746
12817
  class DisableLaneRuleRequest < TencentCloud::Common::AbstractModel
12747
- # @param RuleId: 泳道规则ID
12818
+ # @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
12819
  # @type RuleId: String
12749
12820
 
12750
12821
  attr_accessor :RuleId
@@ -12760,7 +12831,9 @@ module TencentCloud
12760
12831
 
12761
12832
  # DisableLaneRule返回参数结构体
12762
12833
  class DisableLaneRuleResponse < TencentCloud::Common::AbstractModel
12763
- # @param Result: 操作状态。成功:true,失败:false
12834
+ # @param Result: 操作状态。
12835
+ # - true:成功
12836
+ # - false:失败
12764
12837
  # @type Result: Boolean
12765
12838
  # @param RequestId: 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
12766
12839
  # @type RequestId: String
@@ -12780,7 +12853,7 @@ module TencentCloud
12780
12853
 
12781
12854
  # DisableTaskFlow请求参数结构体
12782
12855
  class DisableTaskFlowRequest < TencentCloud::Common::AbstractModel
12783
- # @param FlowId: 工作流 ID
12856
+ # @param FlowId: 工作流 ID。前往工作流管理,在工作流列表第一列和工作流详情页查看工作流ID。
12784
12857
  # @type FlowId: String
12785
12858
 
12786
12859
  attr_accessor :FlowId
@@ -12816,7 +12889,7 @@ module TencentCloud
12816
12889
 
12817
12890
  # DisableTask请求参数结构体
12818
12891
  class DisableTaskRequest < TencentCloud::Common::AbstractModel
12819
- # @param TaskId: 任务ID
12892
+ # @param TaskId: 任务ID。在[任务管理](https://console.cloud.tencent.com/tsf/tct?rid=1)列表页第一列或是任务基本信息页查看任务ID。
12820
12893
  # @type TaskId: String
12821
12894
 
12822
12895
  attr_accessor :TaskId
@@ -12832,7 +12905,7 @@ module TencentCloud
12832
12905
 
12833
12906
  # DisableTask返回参数结构体
12834
12907
  class DisableTaskResponse < TencentCloud::Common::AbstractModel
12835
- # @param Result: 操作成功 or 失败
12908
+ # @param Result: true:操作成功,false:操作失败
12836
12909
  # @type Result: Boolean
12837
12910
  # @param RequestId: 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
12838
12911
  # @type RequestId: String
@@ -13068,7 +13141,7 @@ module TencentCloud
13068
13141
 
13069
13142
  # EnableLaneRule请求参数结构体
13070
13143
  class EnableLaneRuleRequest < TencentCloud::Common::AbstractModel
13071
- # @param RuleId: 泳道规则ID
13144
+ # @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
13145
  # @type RuleId: String
13073
13146
 
13074
13147
  attr_accessor :RuleId
@@ -13084,7 +13157,9 @@ module TencentCloud
13084
13157
 
13085
13158
  # EnableLaneRule返回参数结构体
13086
13159
  class EnableLaneRuleResponse < TencentCloud::Common::AbstractModel
13087
- # @param Result: 操作状态。成功:true,失败:false
13160
+ # @param Result: 操作状态。
13161
+ # - true:成功
13162
+ # - false:失败
13088
13163
  # @type Result: Boolean
13089
13164
  # @param RequestId: 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
13090
13165
  # @type RequestId: String
@@ -13104,7 +13179,7 @@ module TencentCloud
13104
13179
 
13105
13180
  # EnableTaskFlow请求参数结构体
13106
13181
  class EnableTaskFlowRequest < TencentCloud::Common::AbstractModel
13107
- # @param FlowId: 工作流 ID
13182
+ # @param FlowId: 工作流 ID。前往工作流管理,在工作流列表第一列和工作流详情页查看工作流ID。
13108
13183
  # @type FlowId: String
13109
13184
 
13110
13185
  attr_accessor :FlowId
@@ -13140,7 +13215,7 @@ module TencentCloud
13140
13215
 
13141
13216
  # EnableTask请求参数结构体
13142
13217
  class EnableTaskRequest < TencentCloud::Common::AbstractModel
13143
- # @param TaskId: 启用任务
13218
+ # @param TaskId: 任务ID。在任务管理列表页面和任务基本信息页可以查看任务ID。
13144
13219
  # @type TaskId: String
13145
13220
 
13146
13221
  attr_accessor :TaskId
@@ -13156,7 +13231,7 @@ module TencentCloud
13156
13231
 
13157
13232
  # EnableTask返回参数结构体
13158
13233
  class EnableTaskResponse < TencentCloud::Common::AbstractModel
13159
- # @param Result: 操作成功or失败
13234
+ # @param Result: true:操作成功,false:操作失败
13160
13235
  # @type Result: Boolean
13161
13236
  # @param RequestId: 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
13162
13237
  # @type RequestId: String
@@ -13312,7 +13387,7 @@ module TencentCloud
13312
13387
 
13313
13388
  # ExecuteTaskFlow请求参数结构体
13314
13389
  class ExecuteTaskFlowRequest < TencentCloud::Common::AbstractModel
13315
- # @param FlowId: 工作流 ID
13390
+ # @param FlowId: 工作流 ID。前往工作流管理,在工作流列表第一列和工作流详情页查看工作流ID。
13316
13391
  # @type FlowId: String
13317
13392
 
13318
13393
  attr_accessor :FlowId
@@ -13328,7 +13403,7 @@ module TencentCloud
13328
13403
 
13329
13404
  # ExecuteTaskFlow返回参数结构体
13330
13405
  class ExecuteTaskFlowResponse < TencentCloud::Common::AbstractModel
13331
- # @param Result: 工作流批次ID
13406
+ # @param Result: 操作成功返回工作流批次ID,操作失败返回空字符串。
13332
13407
  # @type Result: String
13333
13408
  # @param RequestId: 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
13334
13409
  # @type RequestId: String
@@ -13348,7 +13423,7 @@ module TencentCloud
13348
13423
 
13349
13424
  # ExecuteTask请求参数结构体
13350
13425
  class ExecuteTaskRequest < TencentCloud::Common::AbstractModel
13351
- # @param TaskId: 任务 ID
13426
+ # @param TaskId: 任务ID。在任务管理列表页面第一列或是任务基本信息页查看任务ID。
13352
13427
  # @type TaskId: String
13353
13428
 
13354
13429
  attr_accessor :TaskId
@@ -13364,7 +13439,7 @@ module TencentCloud
13364
13439
 
13365
13440
  # ExecuteTask返回参数结构体
13366
13441
  class ExecuteTaskResponse < TencentCloud::Common::AbstractModel
13367
- # @param Result: 成功/失败
13442
+ # @param Result: 操作成功返回任务批次ID,操作失败返回空字符串。
13368
13443
  # @type Result: String
13369
13444
  # @param RequestId: 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
13370
13445
  # @type RequestId: String
@@ -13550,7 +13625,7 @@ module TencentCloud
13550
13625
  # @param ReleaseDesc: 发布描述
13551
13626
  # 注意:此字段可能返回 null,表示取不到有效值。
13552
13627
  # @type ReleaseDesc: String
13553
- # @param ReleaseTime: 发布时间
13628
+ # @param ReleaseTime: 发布时间。格式为 YYYY-MM-DD hh:mm:ss。
13554
13629
  # 注意:此字段可能返回 null,表示取不到有效值。
13555
13630
  # @type ReleaseTime: String
13556
13631
  # @param GroupId: 部署组ID
@@ -16363,7 +16438,7 @@ module TencentCloud
16363
16438
 
16364
16439
  # ModifyContainerGroup请求参数结构体
16365
16440
  class ModifyContainerGroupRequest < TencentCloud::Common::AbstractModel
16366
- # @param GroupId: 部署组ID 必填项
16441
+ # @param GroupId: 部署组ID,可通过调用[DescribeContainerGroups](https://cloud.tencent.com/document/api/649/36068)查询已创建的项目列表或登录控制台进行查看;也可以调用[CreateContainGroup](https://cloud.tencent.com/document/api/649/36075)创建新的项目。
16367
16442
  # @type GroupId: String
16368
16443
  # @param AccessType: 0:公网 1:集群内访问 2:NodePort
16369
16444
  # @type AccessType: Integer
@@ -16373,7 +16448,7 @@ module TencentCloud
16373
16448
  # @type UpdateType: Integer
16374
16449
  # @param UpdateIvl: 更新间隔,单位秒
16375
16450
  # @type UpdateIvl: Integer
16376
- # @param SubnetId: 子网ID
16451
+ # @param SubnetId: 子网ID,可通过调用[DescribeSubnets](https://cloud.tencent.com/document/product/215/15784)查询已创建的项目列表或登录控制台进行查看;也可以调用[CreateSubnet](https://cloud.tencent.com/document/product/1108/43594)创建新的项目。
16377
16452
  # @type SubnetId: String
16378
16453
  # @param Alias: 部署组备注
16379
16454
  # @type Alias: String
@@ -16522,11 +16597,11 @@ module TencentCloud
16522
16597
 
16523
16598
  # ModifyLane请求参数结构体
16524
16599
  class ModifyLaneRequest < TencentCloud::Common::AbstractModel
16525
- # @param LaneId: 泳道ID
16600
+ # @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
16601
  # @type LaneId: String
16527
- # @param LaneName: 泳道名称
16602
+ # @param LaneName: 泳道配置名称,最多支持60个字符,只能包含字母、数字及分隔符(“-”),且不能以分隔符开头或结尾。
16528
16603
  # @type LaneName: String
16529
- # @param Remark: 备注
16604
+ # @param Remark: 备注,最多支持200个字符。
16530
16605
  # @type Remark: String
16531
16606
 
16532
16607
  attr_accessor :LaneId, :LaneName, :Remark
@@ -16546,7 +16621,9 @@ module TencentCloud
16546
16621
 
16547
16622
  # ModifyLane返回参数结构体
16548
16623
  class ModifyLaneResponse < TencentCloud::Common::AbstractModel
16549
- # @param Result: 更新成功: true / 更新失败: false
16624
+ # @param Result: 更新结果。
16625
+ # - true:更新成功
16626
+ # - false:更新失败
16550
16627
  # @type Result: Boolean
16551
16628
  # @param RequestId: 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
16552
16629
  # @type RequestId: String
@@ -16566,19 +16643,21 @@ module TencentCloud
16566
16643
 
16567
16644
  # ModifyLaneRule请求参数结构体
16568
16645
  class ModifyLaneRuleRequest < TencentCloud::Common::AbstractModel
16569
- # @param RuleId: 泳道规则ID
16646
+ # @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
16647
  # @type RuleId: String
16571
- # @param RuleName: 泳道规则名称
16648
+ # @param RuleName: 灰度发布规则名称,最多支持60个字符,支持中英文字符。
16572
16649
  # @type RuleName: String
16573
- # @param Remark: 泳道规则备注
16650
+ # @param Remark: 灰度发布规则备注,最多支持200个字符。
16574
16651
  # @type Remark: String
16575
- # @param RuleTagList: 泳道规则标签列表
16652
+ # @param RuleTagList: 灰度发布规则标签列表。
16576
16653
  # @type RuleTagList: Array
16577
- # @param RuleTagRelationship: 泳道规则标签关系
16654
+ # @param RuleTagRelationship: 灰度发布规则标签关系。- RELEATION_AND:与- RELEATION_OR:或
16578
16655
  # @type RuleTagRelationship: String
16579
- # @param LaneId: 泳道ID
16656
+ # @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
16657
  # @type LaneId: String
16581
- # @param Enable: 开启状态
16658
+ # @param Enable: 开启状态。
16659
+ # - true:开启
16660
+ # - false:关闭
16582
16661
  # @type Enable: Boolean
16583
16662
 
16584
16663
  attr_accessor :RuleId, :RuleName, :Remark, :RuleTagList, :RuleTagRelationship, :LaneId, :Enable
@@ -16613,7 +16692,9 @@ module TencentCloud
16613
16692
 
16614
16693
  # ModifyLaneRule返回参数结构体
16615
16694
  class ModifyLaneRuleResponse < TencentCloud::Common::AbstractModel
16616
- # @param Result: 操作状态。成功:true,失败:false
16695
+ # @param Result: 修改结果。
16696
+ # - true:成功
16697
+ # - false:失败
16617
16698
  # @type Result: Boolean
16618
16699
  # @param RequestId: 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
16619
16700
  # @type RequestId: String
@@ -16633,9 +16714,9 @@ module TencentCloud
16633
16714
 
16634
16715
  # ModifyMicroservice请求参数结构体
16635
16716
  class ModifyMicroserviceRequest < TencentCloud::Common::AbstractModel
16636
- # @param MicroserviceId: 微服务 ID
16717
+ # @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
16718
  # @type MicroserviceId: String
16638
- # @param MicroserviceDesc: 微服务备注信息
16719
+ # @param MicroserviceDesc: 微服务备注信息,最多支持200个字符。
16639
16720
  # @type MicroserviceDesc: String
16640
16721
 
16641
16722
  attr_accessor :MicroserviceId, :MicroserviceDesc
@@ -16653,9 +16734,9 @@ module TencentCloud
16653
16734
 
16654
16735
  # ModifyMicroservice返回参数结构体
16655
16736
  class ModifyMicroserviceResponse < TencentCloud::Common::AbstractModel
16656
- # @param Result: 修改微服务详情是否成功。
16657
- # true:操作成功。
16658
- # false:操作失败。
16737
+ # @param Result: 修改结果。
16738
+ # - true:修改成功
16739
+ # - false:修改失败
16659
16740
  # @type Result: Boolean
16660
16741
  # @param RequestId: 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
16661
16742
  # @type RequestId: String
@@ -16834,23 +16915,23 @@ module TencentCloud
16834
16915
 
16835
16916
  # ModifyTask请求参数结构体
16836
16917
  class ModifyTaskRequest < TencentCloud::Common::AbstractModel
16837
- # @param TaskId: 任务ID
16918
+ # @param TaskId: 任务ID。在任务管理列表页面第一列查看任务ID。
16838
16919
  # @type TaskId: String
16839
- # @param TaskName: 任务名称
16920
+ # @param TaskName: 任务名称,长度限制为64字符。在任务管理列表页面第一列或是任务基本信息页查看任务名称。
16840
16921
  # @type TaskName: String
16841
- # @param TaskType: 任务类型
16922
+ # @param TaskType: 任务类型。当前只支持一种任务类型。枚举值,java:Java类任务
16842
16923
  # @type TaskType: String
16843
- # @param TaskContent: 任务内容
16924
+ # @param TaskContent: 任务内容,长度限制为 65536 字节
16844
16925
  # @type TaskContent: String
16845
- # @param ExecuteType: 任务执行类型
16926
+ # @param ExecuteType: 任务执行方式,枚举值。unicast:随机单节点执行,broadcast:广播执行,shard:分片执行
16846
16927
  # @type ExecuteType: String
16847
16928
  # @param TaskRule: 触发规则
16848
16929
  # @type TaskRule: :class:`Tencentcloud::Tsf.v20180326.models.TaskRule`
16849
- # @param TimeOut: 超时时间,单位 ms
16930
+ # @param TimeOut: 超时时间,取值大于0,单位:毫秒(ms
16850
16931
  # @type TimeOut: Integer
16851
- # @param GroupId: 分组ID
16932
+ # @param GroupId: 部署组ID。在[应用管理](https://console.cloud.tencent.com/tsf/app?rid=1),点击应用ID进入应用部署页查看部署组ID。
16852
16933
  # @type GroupId: String
16853
- # @param ShardCount: 分片数量
16934
+ # @param ShardCount: 分片数量,取值范围2~1000
16854
16935
  # @type ShardCount: Integer
16855
16936
  # @param ShardArguments: 分片参数
16856
16937
  # @type ShardArguments: Array
@@ -16858,15 +16939,15 @@ module TencentCloud
16858
16939
  # @type AdvanceSettings: :class:`Tencentcloud::Tsf.v20180326.models.AdvanceSettings`
16859
16940
  # @param SuccessOperator: 判断任务成功的操作符 GT/GTE
16860
16941
  # @type SuccessOperator: String
16861
- # @param SuccessRatio: 判断任务成功率的阈值
16942
+ # @param SuccessRatio: 判断任务成功率的阈值,取值范围:1-100,单位:百分比(%)
16862
16943
  # @type SuccessRatio: Integer
16863
- # @param RetryCount: 重试次数
16944
+ # @param RetryCount: 重试次数,取值范围 0 - 10,单位:次
16864
16945
  # @type RetryCount: Integer
16865
- # @param RetryInterval: 重试间隔
16946
+ # @param RetryInterval: 重试间隔,取值范围 0-600,单位:秒(s)
16866
16947
  # @type RetryInterval: Integer
16867
16948
  # @param TaskArgument: 任务参数,长度限制10000个字符
16868
16949
  # @type TaskArgument: String
16869
- # @param ProgramIdList:
16950
+ # @param ProgramIdList: 数据集列表。
16870
16951
  # @type ProgramIdList: Array
16871
16952
 
16872
16953
  attr_accessor :TaskId, :TaskName, :TaskType, :TaskContent, :ExecuteType, :TaskRule, :TimeOut, :GroupId, :ShardCount, :ShardArguments, :AdvanceSettings, :SuccessOperator, :SuccessRatio, :RetryCount, :RetryInterval, :TaskArgument, :ProgramIdList
@@ -16927,7 +17008,7 @@ module TencentCloud
16927
17008
 
16928
17009
  # ModifyTask返回参数结构体
16929
17010
  class ModifyTaskResponse < TencentCloud::Common::AbstractModel
16930
- # @param Result: 更新是否成功
17011
+ # @param Result: 更新是否成功。true:操作成功、false:操作失败
16931
17012
  # @type Result: Boolean
16932
17013
  # @param RequestId: 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
16933
17014
  # @type RequestId: String
@@ -16947,9 +17028,9 @@ module TencentCloud
16947
17028
 
16948
17029
  # ModifyUploadInfo请求参数结构体
16949
17030
  class ModifyUploadInfoRequest < TencentCloud::Common::AbstractModel
16950
- # @param ApplicationId: 应用ID
17031
+ # @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
17032
  # @type ApplicationId: String
16952
- # @param PkgId: 调用DescribeUploadInfo接口时返回的软件包ID
17033
+ # @param PkgId: 软件包ID可通过调用DescribeUploadInfo接口时[获取上传程序包信息](https://cloud.tencent.com/document/api/649/36078)返回的COS上传信息获取,登录[控制台](https://console.cloud.tencent.com/tsf/product?rid=1)进行查看
16953
17034
  # @type PkgId: String
16954
17035
  # @param Result: COS返回上传结果(默认为0:成功,其他值表示失败)
16955
17036
  # @type Result: Integer
@@ -16959,7 +17040,7 @@ module TencentCloud
16959
17040
  # @type Size: Integer
16960
17041
  # @param RepositoryType: 程序包仓库类型
16961
17042
  # @type RepositoryType: String
16962
- # @param RepositoryId: 程序包仓库id
17043
+ # @param RepositoryId: 仓库ID,可通过调用[仓库信息查询类](https://cloud.tencent.com/document/api/649/45925)接口时出参中的RepositoryId,或登录[控制台](https://console.cloud.tencent.com/tsf/product?rid=1)进行查看
16963
17044
  # @type RepositoryId: String
16964
17045
 
16965
17046
  attr_accessor :ApplicationId, :PkgId, :Result, :Md5, :Size, :RepositoryType, :RepositoryId
@@ -17981,9 +18062,9 @@ module TencentCloud
17981
18062
 
17982
18063
  # RedoTaskBatch请求参数结构体
17983
18064
  class RedoTaskBatchRequest < TencentCloud::Common::AbstractModel
17984
- # @param TaskId: 任务ID
18065
+ # @param TaskId: 任务ID。在任务管理列表页面可以查看任务ID。
17985
18066
  # @type TaskId: String
17986
- # @param BatchId: 批次ID
18067
+ # @param BatchId: 任务批次ID。在任务管理页面点击任务ID进入任务详情,进入执行记录列表页,第一列即为任务批次ID。
17987
18068
  # @type BatchId: String
17988
18069
 
17989
18070
  attr_accessor :TaskId, :BatchId
@@ -18001,7 +18082,7 @@ module TencentCloud
18001
18082
 
18002
18083
  # RedoTaskBatch返回参数结构体
18003
18084
  class RedoTaskBatchResponse < TencentCloud::Common::AbstractModel
18004
- # @param Result: 批次ID
18085
+ # @param Result: 批次流水ID
18005
18086
  # @type Result: String
18006
18087
  # @param RequestId: 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
18007
18088
  # @type RequestId: String
@@ -18021,11 +18102,11 @@ module TencentCloud
18021
18102
 
18022
18103
  # RedoTaskExecute请求参数结构体
18023
18104
  class RedoTaskExecuteRequest < TencentCloud::Common::AbstractModel
18024
- # @param BatchId: 任务批次ID
18105
+ # @param BatchId: 任务批次ID。在任务管理页面第一列点击任务ID进入任务详情,进入执行记录列表页,第一列内容即为任务批次ID。
18025
18106
  # @type BatchId: String
18026
- # @param ExecuteId: 任务执行ID
18107
+ # @param ExecuteId: 任务执行ID。在任务管理页面第一列点击任务ID进入任务详情,进入执行记录页,点击批次ID进入执行详情列表页,第一列即为任务执行ID。
18027
18108
  # @type ExecuteId: String
18028
- # @param TaskId: 任务ID
18109
+ # @param TaskId: 任务ID。在任务管理列表页面可以查看任务ID。
18029
18110
  # @type TaskId: String
18030
18111
 
18031
18112
  attr_accessor :BatchId, :ExecuteId, :TaskId
@@ -18045,7 +18126,7 @@ module TencentCloud
18045
18126
 
18046
18127
  # RedoTaskExecute返回参数结构体
18047
18128
  class RedoTaskExecuteResponse < TencentCloud::Common::AbstractModel
18048
- # @param Result: 成功失败
18129
+ # @param Result: 成功返回执行批次流水ID。失败返回空字符串。
18049
18130
  # @type Result: String
18050
18131
  # @param RequestId: 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
18051
18132
  # @type RequestId: String
@@ -18065,7 +18146,7 @@ module TencentCloud
18065
18146
 
18066
18147
  # RedoTaskFlowBatch请求参数结构体
18067
18148
  class RedoTaskFlowBatchRequest < TencentCloud::Common::AbstractModel
18068
- # @param FlowBatchId: 工作流批次 ID
18149
+ # @param FlowBatchId: 工作流批次 ID。在工作流管理页面,点击第一列的工作流ID进入工作流执行记录列表页面,第一列的内容即为工作流批次ID。
18069
18150
  # @type FlowBatchId: String
18070
18151
 
18071
18152
  attr_accessor :FlowBatchId
@@ -18081,7 +18162,7 @@ module TencentCloud
18081
18162
 
18082
18163
  # RedoTaskFlowBatch返回参数结构体
18083
18164
  class RedoTaskFlowBatchResponse < TencentCloud::Common::AbstractModel
18084
- # @param Result: 工作流批次历史 ID
18165
+ # @param Result: 工作流批次历史 ID。操作失败时不返回该字段,返回错误码。
18085
18166
  # @type Result: String
18086
18167
  # @param RequestId: 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
18087
18168
  # @type RequestId: String
@@ -18101,7 +18182,7 @@ module TencentCloud
18101
18182
 
18102
18183
  # RedoTask请求参数结构体
18103
18184
  class RedoTaskRequest < TencentCloud::Common::AbstractModel
18104
- # @param TaskId: 任务ID
18185
+ # @param TaskId: 任务ID。在任务管理列表页面第一列查看任务ID。
18105
18186
  # @type TaskId: String
18106
18187
 
18107
18188
  attr_accessor :TaskId
@@ -18117,7 +18198,7 @@ module TencentCloud
18117
18198
 
18118
18199
  # RedoTask返回参数结构体
18119
18200
  class RedoTaskResponse < TencentCloud::Common::AbstractModel
18120
- # @param Result: 操作成功or失败
18201
+ # @param Result: 操作成功任务批次ID。操作失败返回空字符串。
18121
18202
  # @type Result: String
18122
18203
  # @param RequestId: 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
18123
18204
  # @type RequestId: String
@@ -18173,11 +18254,11 @@ module TencentCloud
18173
18254
 
18174
18255
  # ReleaseConfig请求参数结构体
18175
18256
  class ReleaseConfigRequest < TencentCloud::Common::AbstractModel
18176
- # @param ConfigId: 配置ID
18257
+ # @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
18258
  # @type ConfigId: String
18178
- # @param GroupId: 部署组ID
18259
+ # @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
18260
  # @type GroupId: String
18180
- # @param ReleaseDesc: 发布描述
18261
+ # @param ReleaseDesc: 发布描述,最多支持200个字符。
18181
18262
  # @type ReleaseDesc: String
18182
18263
 
18183
18264
  attr_accessor :ConfigId, :GroupId, :ReleaseDesc
@@ -18197,7 +18278,9 @@ module TencentCloud
18197
18278
 
18198
18279
  # ReleaseConfig返回参数结构体
18199
18280
  class ReleaseConfigResponse < TencentCloud::Common::AbstractModel
18200
- # @param Result: true:发布成功;false:发布失败
18281
+ # @param Result: 发布结果。
18282
+ # - true:发布成功
18283
+ # - false:发布失败
18201
18284
  # @type Result: Boolean
18202
18285
  # @param RequestId: 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
18203
18286
  # @type RequestId: String
@@ -18217,11 +18300,11 @@ module TencentCloud
18217
18300
 
18218
18301
  # ReleaseConfigWithDetailResp请求参数结构体
18219
18302
  class ReleaseConfigWithDetailRespRequest < TencentCloud::Common::AbstractModel
18220
- # @param ConfigId: 配置ID
18303
+ # @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
18304
  # @type ConfigId: String
18222
- # @param GroupId: 部署组ID
18305
+ # @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
18306
  # @type GroupId: String
18224
- # @param ReleaseDesc: 发布描述
18307
+ # @param ReleaseDesc: 发布描述,最多支持200个字符。
18225
18308
  # @type ReleaseDesc: String
18226
18309
 
18227
18310
  attr_accessor :ConfigId, :GroupId, :ReleaseDesc
@@ -18241,7 +18324,7 @@ module TencentCloud
18241
18324
 
18242
18325
  # ReleaseConfigWithDetailResp返回参数结构体
18243
18326
  class ReleaseConfigWithDetailRespResponse < TencentCloud::Common::AbstractModel
18244
- # @param Result: 配置项发布 ID
18327
+ # @param Result: 配置项发布ID
18245
18328
  # @type Result: :class:`Tencentcloud::Tsf.v20180326.models.ConfigRelease`
18246
18329
  # @param RequestId: 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
18247
18330
  # @type RequestId: String
@@ -18264,11 +18347,11 @@ module TencentCloud
18264
18347
 
18265
18348
  # ReleaseFileConfig请求参数结构体
18266
18349
  class ReleaseFileConfigRequest < TencentCloud::Common::AbstractModel
18267
- # @param ConfigId: 配置ID
18350
+ # @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
18351
  # @type ConfigId: String
18269
- # @param GroupId: 部署组ID
18352
+ # @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
18353
  # @type GroupId: String
18271
- # @param ReleaseDesc: 发布描述
18354
+ # @param ReleaseDesc: 发布描述,最多支持200个字符。
18272
18355
  # @type ReleaseDesc: String
18273
18356
 
18274
18357
  attr_accessor :ConfigId, :GroupId, :ReleaseDesc
@@ -18288,7 +18371,9 @@ module TencentCloud
18288
18371
 
18289
18372
  # ReleaseFileConfig返回参数结构体
18290
18373
  class ReleaseFileConfigResponse < TencentCloud::Common::AbstractModel
18291
- # @param Result: 发布结果,成功:true,失败:false。
18374
+ # @param Result: 发布结果。
18375
+ # - true:成功
18376
+ # - false:失败
18292
18377
  # @type Result: Boolean
18293
18378
  # @param RequestId: 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
18294
18379
  # @type RequestId: String
@@ -18308,11 +18393,11 @@ module TencentCloud
18308
18393
 
18309
18394
  # ReleasePublicConfig请求参数结构体
18310
18395
  class ReleasePublicConfigRequest < TencentCloud::Common::AbstractModel
18311
- # @param ConfigId: 配置ID
18396
+ # @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
18397
  # @type ConfigId: String
18313
- # @param NamespaceId: 命名空间ID
18398
+ # @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
18399
  # @type NamespaceId: String
18315
- # @param ReleaseDesc: 发布描述
18400
+ # @param ReleaseDesc: 发布描述,最多支持200个字符。
18316
18401
  # @type ReleaseDesc: String
18317
18402
 
18318
18403
  attr_accessor :ConfigId, :NamespaceId, :ReleaseDesc
@@ -18332,7 +18417,9 @@ module TencentCloud
18332
18417
 
18333
18418
  # ReleasePublicConfig返回参数结构体
18334
18419
  class ReleasePublicConfigResponse < TencentCloud::Common::AbstractModel
18335
- # @param Result: true:发布成功;false:发布失败
18420
+ # @param Result: 发布结果。
18421
+ # - true:发布成功
18422
+ # - false:发布失败
18336
18423
  # @type Result: Boolean
18337
18424
  # @param RequestId: 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
18338
18425
  # @type RequestId: String
@@ -18571,7 +18658,7 @@ module TencentCloud
18571
18658
 
18572
18659
  # RevocationConfig请求参数结构体
18573
18660
  class RevocationConfigRequest < TencentCloud::Common::AbstractModel
18574
- # @param ConfigReleaseId: 配置项发布ID
18661
+ # @param ConfigReleaseId: 配置项发布ID。该参数可以通过调用 [DescribeConfigReleases](https://cloud.tencent.com/document/product/649/38342) 的返回值中的 ConfigReleaseId 字段来获取或通过登录[控制台](https://console.cloud.tencent.com/tse/tsf-consul?subTab=app)配置详情-发布情况页查看。
18575
18662
  # @type ConfigReleaseId: String
18576
18663
 
18577
18664
  attr_accessor :ConfigReleaseId
@@ -18587,7 +18674,9 @@ module TencentCloud
18587
18674
 
18588
18675
  # RevocationConfig返回参数结构体
18589
18676
  class RevocationConfigResponse < TencentCloud::Common::AbstractModel
18590
- # @param Result: true:回滚成功;false:回滚失败
18677
+ # @param Result: 撤回结果。
18678
+ # - true:成功
18679
+ # - false:失败
18591
18680
  # @type Result: Boolean
18592
18681
  # @param RequestId: 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
18593
18682
  # @type RequestId: String
@@ -18643,7 +18732,7 @@ module TencentCloud
18643
18732
 
18644
18733
  # RevokeFileConfig请求参数结构体
18645
18734
  class RevokeFileConfigRequest < TencentCloud::Common::AbstractModel
18646
- # @param ConfigReleaseId: 配置项发布ID
18735
+ # @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
18736
  # @type ConfigReleaseId: String
18648
18737
 
18649
18738
  attr_accessor :ConfigReleaseId
@@ -18679,9 +18768,9 @@ module TencentCloud
18679
18768
 
18680
18769
  # RollbackConfig请求参数结构体
18681
18770
  class RollbackConfigRequest < TencentCloud::Common::AbstractModel
18682
- # @param ConfigReleaseLogId: 配置项发布历史ID
18771
+ # @param ConfigReleaseLogId: 配置项发布历史ID。该参数可以通过调用 [DescribeConfigReleaseLogs](https://cloud.tencent.com/document/product/649/38343) 的返回值中的 ConfigReleaseLogId 字段来获取或通过登录[控制台](https://console.cloud.tencent.com/tse/tsf-consul?subTab=app)配置详情-发布情况页查看。
18683
18772
  # @type ConfigReleaseLogId: String
18684
- # @param ReleaseDesc: 回滚描述
18773
+ # @param ReleaseDesc: 回滚描述,最多支持200个字符。
18685
18774
  # @type ReleaseDesc: String
18686
18775
 
18687
18776
  attr_accessor :ConfigReleaseLogId, :ReleaseDesc
@@ -18699,7 +18788,9 @@ module TencentCloud
18699
18788
 
18700
18789
  # RollbackConfig返回参数结构体
18701
18790
  class RollbackConfigResponse < TencentCloud::Common::AbstractModel
18702
- # @param Result: true:回滚成功;false:回滚失败
18791
+ # @param Result: 回滚结果。
18792
+ # - true:回滚成功
18793
+ # - false:回滚失败
18703
18794
  # @type Result: Boolean
18704
18795
  # @param RequestId: 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
18705
18796
  # @type RequestId: String
@@ -19446,9 +19537,9 @@ module TencentCloud
19446
19537
 
19447
19538
  # ShrinkInstances请求参数结构体
19448
19539
  class ShrinkInstancesRequest < TencentCloud::Common::AbstractModel
19449
- # @param GroupId: 部署组ID
19540
+ # @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
19541
  # @type GroupId: String
19451
- # @param InstanceIdList: 下线机器实例ID列表
19542
+ # @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
19543
  # @type InstanceIdList: Array
19453
19544
 
19454
19545
  attr_accessor :GroupId, :InstanceIdList
@@ -19925,29 +20016,29 @@ module TencentCloud
19925
20016
 
19926
20017
  # 工作流图中的边
19927
20018
  class TaskFlowEdge < TencentCloud::Common::AbstractModel
19928
- # @param NodeId: 节点 ID
20019
+ # @param NodeId: 节点 ID,节点类型为任务时为任务ID,节点类型为逻辑节点"且"时为 AND,为逻辑节点"或"时为 OR,节点类型为头节点时为字符串"head"
19929
20020
  # @type NodeId: String
19930
- # @param ChildNodeId: 子节点 ID
20021
+ # @param ChildNodeId: 子节点 ID,节点类型为任务时为任务ID,节点类型为逻辑节点"且"时为 AND,为逻辑节点"或"时为 OR
19931
20022
  # @type ChildNodeId: String
19932
20023
  # @param CoreNode: 是否核心任务,Y/N
19933
20024
  # @type CoreNode: String
19934
- # @param EdgeType: 边类型
20025
+ # @param EdgeType: 边类型,上下游任务依赖触发关系。一共2个值,Y:成功触发,N:失败触发
19935
20026
  # @type EdgeType: String
19936
- # @param NodeType: 任务节点类型
20027
+ # @param NodeType: 任务节点类型,一共有4种类型,AND:逻辑节点且,OR:逻辑节点或,TASK:任务节点,START:头节点
19937
20028
  # @type NodeType: String
19938
20029
  # @param PositionX: X轴坐标位置
19939
20030
  # @type PositionX: String
19940
20031
  # @param PositionY: Y轴坐标位置
19941
20032
  # @type PositionY: String
19942
- # @param GraphId: 图 ID
20033
+ # @param GraphId: 图 ID,新建工作流时自动生成,不需要填写,查看工作流图时后端返回
19943
20034
  # @type GraphId: String
19944
- # @param FlowId: 工作流 ID
20035
+ # @param FlowId: 工作流 ID,新建工作流时自动生成,不需要填写,查看工作流图时后端返回
19945
20036
  # @type FlowId: String
19946
20037
  # @param NodeName: 节点名称
19947
20038
  # @type NodeName: String
19948
- # @param TaskId: 任务ID
20039
+ # @param TaskId: 任务ID,新建工作流时不需要填写,查看工作流图时后端返回
19949
20040
  # @type TaskId: String
19950
- # @param TaskLogId: 任务历史ID
20041
+ # @param TaskLogId: 任务历史ID,新建工作流时不需要填写,查看工作流图时后端返回
19951
20042
  # @type TaskLogId: String
19952
20043
 
19953
20044
  attr_accessor :NodeId, :ChildNodeId, :CoreNode, :EdgeType, :NodeType, :PositionX, :PositionY, :GraphId, :FlowId, :NodeName, :TaskId, :TaskLogId
@@ -20053,21 +20144,21 @@ module TencentCloud
20053
20144
  # @type TaskName: String
20054
20145
  # @param TaskType: 任务类型
20055
20146
  # @type TaskType: String
20056
- # @param ExecuteType: 执行类型
20147
+ # @param ExecuteType: 任务执行方式,unicast:随机单节点执行,broadcast:广播执行,shard:分片执行
20057
20148
  # @type ExecuteType: String
20058
20149
  # @param TaskContent: 任务内容,长度限制65535字节
20059
20150
  # @type TaskContent: String
20060
20151
  # @param GroupId: 分组ID
20061
20152
  # @type GroupId: String
20062
- # @param TimeOut: 超时时间
20153
+ # @param TimeOut: 超时时间,单位:毫秒。
20063
20154
  # @type TimeOut: Integer
20064
20155
  # @param RetryCount: 重试次数
20065
20156
  # @type RetryCount: Integer
20066
- # @param RetryInterval: 重试间隔
20157
+ # @param RetryInterval: 重试间隔,单位:毫秒。
20067
20158
  # @type RetryInterval: Integer
20068
20159
  # @param TaskRule: 触发规则
20069
20160
  # @type TaskRule: :class:`Tencentcloud::Tsf.v20180326.models.TaskRule`
20070
- # @param TaskState: 是否启用任务,ENABLED/DISABLED
20161
+ # @param TaskState: 任务启用状态。一共2种状态可选,ENABLED:启用,DISABLED:停用
20071
20162
  # @type TaskState: String
20072
20163
  # @param TaskId: 任务ID
20073
20164
  # @type TaskId: String
@@ -20085,7 +20176,7 @@ module TencentCloud
20085
20176
  # @type BelongFlowIds: Array
20086
20177
  # @param TaskLogId: 任务历史ID
20087
20178
  # @type TaskLogId: String
20088
- # @param TriggerType: 触发类型
20179
+ # @param TriggerType: 触发类型,一共3种类型,WorkFlow:工作流触发,Cron:定时触发,FixRate:周期触发
20089
20180
  # @type TriggerType: String
20090
20181
  # @param TaskArgument: 任务参数,长度限制10000个字符
20091
20182
  # @type TaskArgument: String
@@ -20181,7 +20272,7 @@ module TencentCloud
20181
20272
 
20182
20273
  # 任务规则
20183
20274
  class TaskRule < TencentCloud::Common::AbstractModel
20184
- # @param RuleType: 触发规则类型, Cron/Repeat
20275
+ # @param RuleType: 触发规则类型,枚举值。一共3个值,Cron:定时触发,Repeat:周期触发,WorkFlow:工作流触发
20185
20276
  # @type RuleType: String
20186
20277
  # @param Expression: Cron类型规则,cron表达式。
20187
20278
  # @type Expression: String
@@ -20238,7 +20329,7 @@ module TencentCloud
20238
20329
 
20239
20330
  # TerminateTaskFlowBatch请求参数结构体
20240
20331
  class TerminateTaskFlowBatchRequest < TencentCloud::Common::AbstractModel
20241
- # @param FlowBatchId: 工作流批次 ID
20332
+ # @param FlowBatchId: 工作流批次 ID,在[工作流执行记录](https://console.cloud.tencent.com/tsf/tct?rid=1&tab=taskflow)列表页第一列获取。
20242
20333
  # @type FlowBatchId: String
20243
20334
 
20244
20335
  attr_accessor :FlowBatchId
@@ -20254,7 +20345,7 @@ module TencentCloud
20254
20345
 
20255
20346
  # TerminateTaskFlowBatch返回参数结构体
20256
20347
  class TerminateTaskFlowBatchResponse < TencentCloud::Common::AbstractModel
20257
- # @param Result: 是否停止成功
20348
+ # @param Result: 是否停止成功,true:停止成功,false:停止失败
20258
20349
  # @type Result: Boolean
20259
20350
  # @param RequestId: 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
20260
20351
  # @type RequestId: String
@@ -20396,7 +20487,9 @@ module TencentCloud
20396
20487
 
20397
20488
  # 配置中心
20398
20489
  class TsfConfigCenter < TencentCloud::Common::AbstractModel
20399
- # @param ConfigType: 配置中心类型
20490
+ # @param ConfigType: 配置中心类型。
20491
+ # - SHARE:共享型
20492
+ # - EXCLUSIVE:独占型
20400
20493
  # 注意:此字段可能返回 null,表示取不到有效值。
20401
20494
  # @type ConfigType: String
20402
20495
  # @param ConfigCenterInstanceId: 配置中心实例id
@@ -21686,15 +21779,19 @@ module TencentCloud
21686
21779
 
21687
21780
  # UpdateConfigTemplate请求参数结构体
21688
21781
  class UpdateConfigTemplateRequest < TencentCloud::Common::AbstractModel
21689
- # @param ConfigTemplateId: 配置模板id
21782
+ # @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
21783
  # @type ConfigTemplateId: String
21691
- # @param ConfigTemplateName: 配置模板名称
21784
+ # @param ConfigTemplateName: 配置模板名称,最多支持60个字符,只能包含字母、数字及分隔符(“-”),且不能以分隔符开头或结尾。
21692
21785
  # @type ConfigTemplateName: String
21693
- # @param ConfigTemplateType: 配置模板对应的微服务框架
21786
+ # @param ConfigTemplateType: 配置模板对应的微服务框架。
21787
+ # - Ribbon:Ribbon类型配置模板
21788
+ # - Hystrix:Hystrix类型配置模板
21789
+ # - Zuul:Zuul类型配置模板
21790
+ # - customize:自定义类型配置模板
21694
21791
  # @type ConfigTemplateType: String
21695
- # @param ConfigTemplateValue: 配置模板数据
21792
+ # @param ConfigTemplateValue: 配置模板数据。
21696
21793
  # @type ConfigTemplateValue: String
21697
- # @param ConfigTemplateDesc: 配置模板描述
21794
+ # @param ConfigTemplateDesc: 配置模板描述,最多支持200个字符。
21698
21795
  # @type ConfigTemplateDesc: String
21699
21796
 
21700
21797
  attr_accessor :ConfigTemplateId, :ConfigTemplateName, :ConfigTemplateType, :ConfigTemplateValue, :ConfigTemplateDesc
@@ -21718,7 +21815,9 @@ module TencentCloud
21718
21815
 
21719
21816
  # UpdateConfigTemplate返回参数结构体
21720
21817
  class UpdateConfigTemplateResponse < TencentCloud::Common::AbstractModel
21721
- # @param Result: 更新成功: true / 更新失败: false
21818
+ # @param Result: 更新结果。
21819
+ # - true:成功
21820
+ # - false:失败
21722
21821
  # @type Result: Boolean
21723
21822
  # @param RequestId: 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
21724
21823
  # @type RequestId: String
@@ -21843,7 +21942,7 @@ module TencentCloud
21843
21942
 
21844
21943
  # UpdateRepository请求参数结构体
21845
21944
  class UpdateRepositoryRequest < TencentCloud::Common::AbstractModel
21846
- # @param RepositoryId: 仓库ID
21945
+ # @param RepositoryId: 仓库ID,可通过调用[仓库信息查询类](https://cloud.tencent.com/document/api/649/45925)接口时出参中的RepositoryId,或登录[控制台](https://console.cloud.tencent.com/tsf/product?rid=1)进行查看
21847
21946
  # @type RepositoryId: String
21848
21947
  # @param RepositoryDesc: 仓库描述
21849
21948
  # @type RepositoryDesc: String