lib/v20210728/models.rb in tencentcloud-sdk-pts-3.0.724 vs lib/v20210728/models.rb in tencentcloud-sdk-pts-3.0.725
- old
+ new
@@ -53,11 +53,11 @@
end
end
# AbortJob请求参数结构体
class AbortJobRequest < TencentCloud::Common::AbstractModel
- # @param JobId: 任务ID
+ # @param JobId: 待停止的压测任务的 ID（所有的压测任务 ID 可以从 DescribeJobs 接口获取）
# @type JobId: String
# @param ProjectId: 项目ID
# @type ProjectId: String
# @param ScenarioId: 场景ID
# @type ScenarioId: String
@@ -99,11 +99,11 @@
# AdjustJobSpeed请求参数结构体
class AdjustJobSpeedRequest < TencentCloud::Common::AbstractModel
# @param JobId: 任务ID
# @type JobId: String
- # @param TargetRequestsPerSecond: 目标RPS
+ # @param TargetRequestsPerSecond: 目标 RPS。其取值应大于起始 RPS，并且小于最大 RPS
# @type TargetRequestsPerSecond: Integer
attr_accessor :JobId, :TargetRequestsPerSecond
def initialize(jobid=nil, targetrequestspersecond=nil)
@@ -496,15 +496,15 @@
end
end
# CreateAlertChannel请求参数结构体
class CreateAlertChannelRequest < TencentCloud::Common::AbstractModel
- # @param NoticeId: Notice ID
+ # @param NoticeId: monitor 服务的告警通知模板的 NoticeId，可从 monitor 服务的云 API 的 DescribeAlarmNotices 接口响应里的 Id 字段获取。（CreateAlertChannel 接口的入参里用于标识一个告警通知模板的 AMPConsumerId 与 NoticeId 二选一即可）
# @type NoticeId: String
# @param ProjectId: 项目 ID
# @type ProjectId: String
- # @param AMPConsumerId: AMP Consumer ID
+ # @param AMPConsumerId: monitor 服务的告警通知模板的 AMPConsumerId，可从 monitor 服务的云 API 的 DescribeAlarmNotices 接口响应里的 AMPConsumerId 字段获取。（CreateAlertChannel 接口的入参里用于标识一个告警通知模板的 AMPConsumerId 与 NoticeId 二选一即可）
# @type AMPConsumerId: String
attr_accessor :NoticeId, :ProjectId, :AMPConsumerId
def initialize(noticeid=nil, projectid=nil, ampconsumerid=nil)
@@ -608,11 +608,11 @@
end
end
# CreateFile请求参数结构体
class CreateFileRequest < TencentCloud::Common::AbstractModel
- # @param FileId: 文件 ID
+ # @param FileId: 文件 ID。其值应为前序步骤上传该文件到 cos 桶后，文件在 cos 桶中的相应目录
# @type FileId: String
# @param ProjectId: 项目 ID
# @type ProjectId: String
# @param Kind: 文件种类，参数文件-1，协议文件-2，请求文件-3
# @type Kind: Integer
@@ -1122,11 +1122,11 @@
# DeleteAlertChannel请求参数结构体
class DeleteAlertChannelRequest < TencentCloud::Common::AbstractModel
# @param ProjectId: 项目 ID
# @type ProjectId: String
- # @param NoticeId: Notice ID
+ # @param NoticeId: 待删除的通知渠道的 Notice ID（所有通知渠道的 Notice ID 可以从 DescribeAlertChannels 接口获取）
# @type NoticeId: String
attr_accessor :ProjectId, :NoticeId
def initialize(projectid=nil, noticeid=nil)
@@ -1194,11 +1194,11 @@
# DeleteFiles请求参数结构体
class DeleteFilesRequest < TencentCloud::Common::AbstractModel
# @param ProjectId: 项目 ID
# @type ProjectId: String
- # @param FileIds: 文件 ID 数组
+ # @param FileIds: 待删除的文件的 ID（所有文件 ID 可从接口 DescribeFiles 获取）
# @type FileIds: Array
attr_accessor :ProjectId, :FileIds
def initialize(projectid=nil, fileids=nil)
@@ -1228,11 +1228,11 @@
end
end
# DeleteJobs请求参数结构体
class DeleteJobsRequest < TencentCloud::Common::AbstractModel
- # @param JobIds: 任务ID数组
+ # @param JobIds: 待删除的任务的 ID（所有任务的 ID 可以从 DescribeJobs 获取）
# @type JobIds: Array
# @param ProjectId: 项目ID
# @type ProjectId: String
# @param ScenarioIds: 场景ID数组
# @type ScenarioIds: Array
@@ -1885,13 +1885,13 @@
class DescribeLabelValuesRequest < TencentCloud::Common::AbstractModel
# @param JobId: 任务ID
# @type JobId: String
# @param ScenarioId: 场景ID
# @type ScenarioId: String
- # @param Metric: 指标名称
+ # @param Metric: 指标名。取值范围参见 DescribeMetricLabelWithValues 接口返回的所有指标名
# @type Metric: String
- # @param LabelName: 查询标签名称
+ # @param LabelName: 标签名。取值范围参见 DescribeMetricLabelWithValues 接口返回的指标及其支持的标签名
# @type LabelName: String
# @param ProjectId: 项目ID
# @type ProjectId: String
attr_accessor :JobId, :ScenarioId, :Metric, :LabelName, :ProjectId
@@ -2245,17 +2245,17 @@
end
end
# DescribeSampleBatchQuery请求参数结构体
class DescribeSampleBatchQueryRequest < TencentCloud::Common::AbstractModel
- # @param JobId: job id
+ # @param JobId: 压测任务的 ID
# @type JobId: String
- # @param ScenarioId: 场景id
+ # @param ScenarioId: 场景的 ID
# @type ScenarioId: String
# @param Queries: 查询指标数组
# @type Queries: Array
- # @param ProjectId: 项目ID
+ # @param ProjectId: 项目的 ID
# @type ProjectId: String
attr_accessor :JobId, :ScenarioId, :Queries, :ProjectId
def initialize(jobid=nil, scenarioid=nil, queries=nil, projectid=nil)
@@ -2493,15 +2493,15 @@
# @type JobId: String
# @param ProjectId: 项目ID
# @type ProjectId: String
# @param ScenarioId: 场景ID
# @type ScenarioId: String
- # @param Metric: 指标名字
+ # @param Metric: 指标名。取值范围参见 DescribeMetricLabelWithValues 接口返回的所有指标名
# @type Metric: String
- # @param Aggregation: 聚合函数
+ # @param Aggregation: 聚合函数。取值范围：Rate,Count,Avg,P90,P95,P99,Gauge
# @type Aggregation: String
- # @param Filters: 指标过滤
+ # @param Filters: 用标签过滤规则来过滤指标，规则中包含标签名 LabelName、标签值 LabelValue、操作符 Operator（0代表相等，1代表不等）
# @type Filters: Array
# @param GroupBy: 分组
# @type GroupBy: Array
attr_accessor :JobId, :ProjectId, :ScenarioId, :Metric, :Aggregation, :Filters, :GroupBy
@@ -2562,17 +2562,17 @@
class DescribeSampleQueryRequest < TencentCloud::Common::AbstractModel
# @param JobId: job id
# @type JobId: String
# @param ScenarioId: 场景Id
# @type ScenarioId: String
- # @param Metric: 指标名
+ # @param Metric: 指标名。取值范围参见 DescribeMetricLabelWithValues 接口返回的所有指标名
# @type Metric: String
- # @param Aggregation: 聚合条件
+ # @param Aggregation: 聚合函数。取值范围：Rate,Count,Avg,P90,P95,P99,Gauge
# @type Aggregation: String
# @param ProjectId: 项目ID
# @type ProjectId: String
- # @param Labels: 过滤条件
+ # @param Labels: 标签过滤条件。各指标支持的标签参见 DescribeMetricLabelWithValues 接口返回的所有指标及其支持的标签
# @type Labels: Array
attr_accessor :JobId, :ScenarioId, :Metric, :Aggregation, :ProjectId, :Labels
def initialize(jobid=nil, scenarioid=nil, metric=nil, aggregation=nil, projectid=nil, labels=nil)
@@ -3170,15 +3170,15 @@
# 查询结构封装
class InternalMetricQuery < TencentCloud::Common::AbstractModel
# @param Metric: 指标名
# @type Metric: String
- # @param Aggregation: 聚合函数
+ # @param Aggregation: 聚合函数。取值范围：Rate,Count,Avg,P90,P95,P99,Gauge
# @type Aggregation: String
# @param Labels: deprecated, 请使用Filters
# @type Labels: Array
- # @param Filters: 指标过滤
+ # @param Filters: 用标签过滤规则来过滤指标，规则中包含标签名 LabelName、标签值 LabelValue、操作符 Operator（0代表相等，1代表不等）
# @type Filters: Array
# @param GroupBy: 指标分组
# @type GroupBy: Array
attr_accessor :Metric, :Aggregation, :Labels, :Filters, :GroupBy
@@ -3501,13 +3501,13 @@
end
end
# 包含labelName 和labelValue
class Label < TencentCloud::Common::AbstractModel
- # @param LabelName: label名字
+ # @param LabelName: 标签名
# @type LabelName: String
- # @param LabelValue: label值
+ # @param LabelValue: 标签值
# @type LabelValue: String
attr_accessor :LabelName, :LabelValue
def initialize(labelname=nil, labelvalue=nil)
@@ -4856,11 +4856,11 @@
end
end
# UpdateFileScenarioRelation请求参数结构体
class UpdateFileScenarioRelationRequest < TencentCloud::Common::AbstractModel
- # @param FileId: 文件 ID
+ # @param FileId: 文件 ID。其值应为前序步骤上传该文件到 cos 桶后，文件在 cos 桶中的相应目录
# @type FileId: String
# @param ProjectId: 项目 ID
# @type ProjectId: String
# @param ScenarioIds: 场景 ID 数组
# @type ScenarioIds: Array
@@ -5001,10 +5001,10 @@
# @type ScenarioId: String
# @param Name: 场景名
# @type Name: String
# @param Description: 场景描述
# @type Description: String
- # @param Type: 压测引擎类型
+ # @param Type: 压测场景的模式类型。取值范围：pts-http 代表简单模式，pts-js 代表脚本模式，pts-jmeter 代表 JMeter 模式。
# @type Type: String
# @param Load: 施压配置
# @type Load: :class:`Tencentcloud::Pts.v20210728.models.Load`
# @param EncodedScripts: deprecated
# @type EncodedScripts: String