lib/v20201016/models.rb in tencentcloud-sdk-cls-3.0.730 vs lib/v20201016/models.rb in tencentcloud-sdk-cls-3.0.731

- old
+ new

@@ -105,11 +105,11 @@ # @type Name: String # @param AlarmTargets: 监控对象列表。 # @type AlarmTargets: Array # @param MonitorTime: 监控任务运行时间点。 # @type MonitorTime: :class:`Tencentcloud::Cls.v20201016.models.MonitorTime` - # @param Condition: 触发条件。 + # @param Condition: 单触发条件。与MultiConditions参数互斥。 # @type Condition: String # @param TriggerCount: 持续周期。持续满足触发条件TriggerCount个周期后,再进行告警;最小值为1,最大值为10。 # @type TriggerCount: Integer # @param AlarmPeriod: 告警重复的周期。单位是min。取值范围是0~1440。 # @type AlarmPeriod: Integer @@ -142,12 +142,12 @@ # 注意:此字段可能返回 null,表示取不到有效值。 # @type MonitorObjectType: Integer # @param AlarmLevel: 告警级别。0:警告(Warn);1:提醒(Info);2:紧急 (Critical)。 # 注意:此字段可能返回 null,表示取不到有效值。 # @type AlarmLevel: Integer - # @param MultiConditions: 多触发条件。 - + # @param MultiConditions: 多触发条件。与 + # Condition互斥。 # 注意:此字段可能返回 null,表示取不到有效值。 # @type MultiConditions: Array attr_accessor :Name, :AlarmTargets, :MonitorTime, :Condition, :TriggerCount, :AlarmPeriod, :AlarmNoticeIds, :Status, :AlarmId, :CreateTime, :UpdateTime, :MessageTemplate, :CallBack, :Analysis, :GroupTriggerStatus, :GroupTriggerCondition, :MonitorObjectType, :AlarmLevel, :MultiConditions @@ -513,11 +513,53 @@ # 注意:此字段可能返回 null,表示取不到有效值。 # @type Type: String # @param Content: 分析内容 # 注意:此字段可能返回 null,表示取不到有效值。 # @type Content: String - # @param ConfigInfo: 配置 + # @param ConfigInfo: 多维分析配置。 + + # 当Analysis的Type字段为query(自定义)时,支持 + # { + # "Key": "SyntaxRule", // 语法规则 + # "Value": "1" //0:Lucene语法 ,1: CQL语法 + # } + + + + # 当Analysis的Type字段为field(top5)时, 支持 + # { + # "Key": "QueryIndex", + # "Value": "-1" // -1:自定义, 1:执行语句1, 2:执行语句2 + # },{ + # "Key": "CustomQuery", //检索语句。 QueryIndex为-1时有效且必填 + # "Value": "* | select count(*) as count" + # },{ + # "Key": "SyntaxRule", // 查不到这个字段也是老语法(Lucene) + # "Value": "0"//0:Lucene, 1:CQL + # } + + # 当Analysis的Type字段为original(原始日志)时, 支持 + # { + # "Key": "Fields", + # "Value": "__SOURCE__,__HOSTNAME__,__TIMESTAMP__,__PKG_LOGID__,__TAG__.pod_ip" + # }, { + # "Key": "QueryIndex", + # "Value": "-1" // -1:自定义, 1:执行语句1, 2:执行语句2 + # },{ + # "Key": "CustomQuery", // //检索语句。 QueryIndex为-1时有效且必填 + # "Value": "* | select count(*) as count" + # },{ + # "Key": "Format", //显示形式。1:每条日志一行,2:每条日志每个字段一行 + # "Value": "2" + # }, + # { + # "Key": "Limit", //最大日志条数 + # "Value": "5" + # },{ + # "Key": "SyntaxRule", // 查不到这个字段也是老语法 + # "Value": "0"//0:Lucene, 1:CQL + # } # 注意:此字段可能返回 null,表示取不到有效值。 # @type ConfigInfo: Array attr_accessor :Name, :Type, :Content, :ConfigInfo @@ -657,17 +699,19 @@ # CheckRechargeKafkaServer请求参数结构体 class CheckRechargeKafkaServerRequest < TencentCloud::Common::AbstractModel # @param KafkaType: 导入Kafka类型,0: 腾讯云CKafka,1: 用户自建Kafka # @type KafkaType: Integer - # @param KafkaInstance: 腾讯云CKafka实例ID,KafkaType为0时必填 + # @param KafkaInstance: 腾讯云CKafka实例ID。 + # KafkaType为0时,KafkaInstance必填 # @type KafkaInstance: String - # @param ServerAddr: 服务地址 + # @param ServerAddr: 服务地址。 + # KafkaType为1时,ServerAddr必填 # @type ServerAddr: String # @param IsEncryptionAddr: ServerAddr是否为加密连接 # @type IsEncryptionAddr: Boolean - # @param Protocol: 加密访问协议,IsEncryptionAddr参数为true时必填 + # @param Protocol: 加密访问协议。IsEncryptionAddr参数为true时必填 # @type Protocol: :class:`Tencentcloud::Cls.v20201016.models.KafkaProtocolInfo` attr_accessor :KafkaType, :KafkaInstance, :ServerAddr, :IsEncryptionAddr, :Protocol def initialize(kafkatype=nil, kafkainstance=nil, serveraddr=nil, isencryptionaddr=nil, protocol=nil) @@ -1858,13 +1902,14 @@ # @type TopicId: String # @param LogsetId: 日志集ID # @type LogsetId: String # @param Name: 投递任务名称 # @type Name: String - # @param Bucket: COS存储桶 + # @param Bucket: COS存储桶。 + # 存储桶命名规范:https://cloud.tencent.com/document/product/436/13312 # @type Bucket: String - # @param BucketRegion: COS存储桶所在地域 + # @param BucketRegion: COS存储桶所在地域。地域和访问域名:https://cloud.tencent.com/document/product/436/6224 # @type BucketRegion: String # @param Prefix: COS文件所在文件夹的前缀 # @type Prefix: String # @param LogType: 采集的日志类型,json_log代表json格式日志,delimiter_log代表分隔符格式日志,minimalist_log代表单行全文; # 默认为minimalist_log @@ -2192,15 +2237,17 @@ # @type KafkaInstance: String # @param ServerAddr: 服务地址,KafkaType为1时必填 # @type ServerAddr: String # @param IsEncryptionAddr: ServerAddr是否为加密连接,KafkaType为1时必填 # @type IsEncryptionAddr: Boolean - # @param Protocol: 加密访问协议,IsEncryptionAddr参数为true时必填 + # @param Protocol: 加密访问协议。 + # KafkaType为1并且IsEncryptionAddr为true时Protocol必填 # @type Protocol: :class:`Tencentcloud::Cls.v20201016.models.KafkaProtocolInfo` # @param ConsumerGroupName: 用户Kafka消费组名称 # @type ConsumerGroupName: String - # @param LogRechargeRule: 日志导入规则 + # @param LogRechargeRule: 日志导入规则。 + # 必填字段。 # @type LogRechargeRule: :class:`Tencentcloud::Cls.v20201016.models.LogRechargeRuleInfo` attr_accessor :TopicId, :Name, :KafkaType, :UserKafkaTopics, :Offset, :KafkaInstance, :ServerAddr, :IsEncryptionAddr, :Protocol, :ConsumerGroupName, :LogRechargeRule def initialize(topicid=nil, name=nil, kafkatype=nil, userkafkatopics=nil, offset=nil, kafkainstance=nil, serveraddr=nil, isencryptionaddr=nil, protocol=nil, consumergroupname=nil, logrechargerule=nil) @@ -4886,22 +4933,22 @@ class DescribeScheduledSqlInfoRequest < TencentCloud::Common::AbstractModel # @param Offset: 分页的偏移量,默认值为0。 # @type Offset: Integer # @param Limit: 分页单页限制数目,默认值为20,最大值100。 # @type Limit: Integer - # @param Name: 任务名称 + # @param Name: 任务名称。 # @type Name: String - # @param TaskId: 任务id + # @param TaskId: 任务id。 # @type TaskId: String - # @param Filters: <li>srcTopicName按照【源日志主题名称】进行过滤,模糊匹配,类型:String必选:否</li> - # <li>dstTopicName按照【目标日志主题名称】进行过滤,模糊匹配,类型:String必选:否</li> - # <li>srcTopicId按照【源日志主题ID】进行过滤。类型:String必选:否</li> - # <li>dstTopicId按照【目标日志主题ID】进行过滤。类型:String必选:否</li> - # <li>bizType按照【主题类型】进行过滤,0日志主题1指标主题,。类型:String必选:否</li> - # <li>status按照【任务状态】进行过滤。类型:String必选:否</li> - # <li>taskName按照【任务名称】进行过滤,模糊匹配,。类型:String必选:否</li> - # <li>taskId按照【任务ID】进行过滤,模糊匹配,。类型:String必选:否</li> + # @param Filters: <li>srcTopicName按照【源日志主题名称】进行过滤,模糊匹配。类型:String。必选:否</li> + # <li>dstTopicName按照【目标日志主题名称】进行过滤,模糊匹配。类型:String。必选:否</li> + # <li>srcTopicId按照【源日志主题ID】进行过滤。类型:String。必选:否</li> + # <li>dstTopicId按照【目标日志主题ID】进行过滤。类型:String。必选:否</li> + # <li>bizType按照【主题类型】进行过滤,0日志主题 1指标主题。类型:String。必选:否</li> + # <li>status按照【任务状态】进行过滤,1:运行 2:停止。类型:String。必选:否</li> + # <li>taskName按照【任务名称】进行过滤,模糊匹配。类型:String。必选:否</li> + # <li>taskId按照【任务ID】进行过滤,模糊匹配。类型:String。必选:否</li> # @type Filters: Array attr_accessor :Offset, :Limit, :Name, :TaskId, :Filters def initialize(offset=nil, limit=nil, name=nil, taskid=nil, filters=nil) @@ -5515,12 +5562,13 @@ # @type From: Integer # @param To: 要查询的执行详情的结束时间,Unix时间戳,单位ms # @type To: Integer # @param Query: 查询过滤条件,例如: # - 按告警策略ID查询:`alert_id:"alarm-0745ec00-e605-xxxx-b50b-54afe61fc971"` - # - 按监控对象ID查询:`monitored_object:"823d8bfa-76a7-xxxx-8399-8cda74d4009b") ` - # - 按告警策略ID及监控对象ID查询:`alert_id:"alarm-0745ec00-e605-xxxx-b50b-54afe61fc971" AND monitored_object:"823d8bfa-76a7-xxxx-8399-8cda74d4009b")` + # - 按监控对象ID查询:`monitored_object:"823d8bfa-76a7-xxxx-8399-8cda74d4009b" ` + # - 按告警策略ID及监控对象ID查询:`alert_id:"alarm-0745ec00-e605-xxxx-b50b-54afe61fc971" AND monitored_object:"823d8bfa-76a7-xxxx-8399-8cda74d4009b"` + # - 按告警策略ID及监控对象ID查询支持SQL语句:`(alert_id:"alarm-5ce45495-09e8-4d58-xxxx-768134bf330c") AND (monitored_object:"3c514e84-6f1f-46ec-xxxx-05de6163f7fe") AND NOT condition_evaluate_result: "Skip" AND condition_evaluate_result:[* TO *] | SELECT count(*) as top50StatisticsTotalCount, count_if(condition_evaluate_result='ProcessError') as top50StatisticsFailureCount, count_if(notification_send_result!='NotSend') as top50NoticeTotalCount, count_if(notification_send_result='SendPartFail' or notification_send_result='SendFail') as top50NoticeFailureCount, alert_id, alert_name, monitored_object, topic_type, happen_threshold, alert_threshold, notify_template group by alert_id, alert_name, monitored_object,topic_type, happen_threshold, alert_threshold, notify_template order by top50StatisticsTotalCount desc limit 1` # @type Query: String # @param Limit: 单次查询返回的执行详情条数,最大值为1000 # @type Limit: Integer # @param Context: 加载更多详情时使用,透传上次返回的Context值,获取后续的执行详情 # @type Context: String @@ -5558,17 +5606,22 @@ # @type Context: String # @param ListOver: 指定时间范围内的告警执行详情是否完整返回 # @type ListOver: Boolean # @param Analysis: 返回的结果是否为SQL分析结果 # @type Analysis: Boolean - # @param ColNames: 如果Analysis为True,则返回分析结果的列名,否则为空 + # @param ColNames: 分析结果的列名,如果Query语句有SQL查询,则返回查询字段的列名; + # 否则为空。 # 注意:此字段可能返回 null,表示取不到有效值。 # @type ColNames: Array - # @param Results: 执行详情查询结果;当Analysis为True时,可能返回为null + # @param Results: 执行详情查询结果。 + + # 当Query字段无SQL语句时,返回查询结果。 + # 当Query字段有SQL语句时,可能返回null。 # 注意:此字段可能返回 null,表示取不到有效值。 # @type Results: Array - # @param AnalysisResults: 执行详情统计分析结果;当Analysis为False时,可能返回为null + # @param AnalysisResults: 执行详情统计分析结果。当Query字段有SQL语句时,返回sql统计结果,否则可能返回null。 + # 注意:此字段可能返回 null,表示取不到有效值。 # @type AnalysisResults: Array # @param AnalysisRecords: 执行详情统计分析结果; UseNewAnalysis为true有效 # 注意:此字段可能返回 null,表示取不到有效值。 # @type AnalysisRecords: Array @@ -5757,20 +5810,24 @@ end end # Kafka访问协议 class KafkaProtocolInfo < TencentCloud::Common::AbstractModel - # @param Protocol: 协议类型,支持的协议类型包括 plaintext、sasl_plaintext 或 sasl_ssl。建议使用 sasl_ssl,此协议会进行连接加密同时需要用户认证 + # @param Protocol: 协议类型,支持的协议类型包括 plaintext、sasl_plaintext 或 sasl_ssl。建议使用 sasl_ssl,此协议会进行连接加密同时需要用户认证。 + # 入参必填 # 注意:此字段可能返回 null,表示取不到有效值。 # @type Protocol: String - # @param Mechanism: 加密类型,支持 PLAIN、SCRAM-SHA-256 或 SCRAM-SHA-512 + # @param Mechanism: 加密类型,支持 PLAIN、SCRAM-SHA-256 或 SCRAM-SHA-512。 + # 当Protocol为sasl_plaintext或sasl_ssl时必填 # 注意:此字段可能返回 null,表示取不到有效值。 # @type Mechanism: String - # @param UserName: 用户名 + # @param UserName: 用户名。 + # 当Protocol为sasl_plaintext或sasl_ssl时必填 # 注意:此字段可能返回 null,表示取不到有效值。 # @type UserName: String - # @param Password: 用户密码 + # @param Password: 用户密码。 + # 当Protocol为sasl_plaintext或sasl_ssl时必填 # 注意:此字段可能返回 null,表示取不到有效值。 # @type Password: String attr_accessor :Protocol, :Mechanism, :UserName, :Password @@ -7888,21 +7945,25 @@ class PreviewKafkaRechargeRequest < TencentCloud::Common::AbstractModel # @param PreviewType: 预览类型,1:源数据预览,2:导出结果预览 # @type PreviewType: Integer # @param KafkaType: 导入Kafka类型,0: 腾讯云CKafka,1: 用户自建Kafka # @type KafkaType: Integer - # @param UserKafkaTopics: 用户需要导入的Kafka相关topic列表,多个topic之间使用半角逗号隔开 + # @param UserKafkaTopics: 用户需要导入的Kafka相关topic列表,多个topic之间使用半角逗号隔开。最多支持100个。 # @type UserKafkaTopics: String # @param Offset: 导入数据位置,-2:最早(默认),-1:最晚 # @type Offset: Integer - # @param KafkaInstance: 腾讯云CKafka实例ID,KafkaType为0时必填 + # @param KafkaInstance: 腾讯云CKafka实例ID。 + # KafkaType为0时KafkaInstance必填 # @type KafkaInstance: String - # @param ServerAddr: 服务地址 + # @param ServerAddr: 服务地址。 + # KafkaType为1时ServerAddr必填 # @type ServerAddr: String - # @param IsEncryptionAddr: ServerAddr是否为加密连接 + # @param IsEncryptionAddr: ServerAddr是否为加密连接。。 + # KafkaType为1时有效。 # @type IsEncryptionAddr: Boolean - # @param Protocol: 加密访问协议,IsEncryptionAddr参数为true时必填 + # @param Protocol: 加密访问协议。 + # KafkaType为1并且IsEncryptionAddr为true时Protocol必填 # @type Protocol: :class:`Tencentcloud::Cls.v20201016.models.KafkaProtocolInfo` # @param ConsumerGroupName: 用户Kafka消费组 # @type ConsumerGroupName: String # @param LogRechargeRule: 日志导入规则 # @type LogRechargeRule: :class:`Tencentcloud::Cls.v20201016.models.LogRechargeRuleInfo` @@ -8249,11 +8310,11 @@ # @type TopicId: String # @param Region: 主题的地域信息 # @type Region: String # @param BizType: 主题类型:0为日志主题,1为指标主题 # @type BizType: Integer - # @param MetricName: 指标名称 + # @param MetricName: 指标名称。当BizType为1时,MetricName需要填写 # @type MetricName: String # @param MetricNames: 指标名称 # BizType为1时,优先使用MetricNames字段多指标只能填充到MetricNames字段,单指标建议填充到MetricName字段 # @type MetricNames: Array # @param MetricLabels: 指标维度,不接受时间类型。 @@ -8392,12 +8453,14 @@ # @type TopicId: String # @param LogsetId: 日志集ID # @type LogsetId: String # @param Name: 投递任务名称 # @type Name: String - # @param Bucket: 存储桶 + # @param Bucket: 存储桶。 + # 存储桶命名规范:https://cloud.tencent.com/document/product/436/13312 # @type Bucket: String - # @param BucketRegion: 存储桶所在地域 + # @param BucketRegion: 存储桶所在地域。 + # 地域和访问域名:https://cloud.tencent.com/document/product/436/6224 # @type BucketRegion: String # @param Prefix: cos文件所在文件夹的前缀 # @type Prefix: String # @param Compress: 压缩模式: "", "gzip", "lzop", "snappy”; 默认"" # @type Compress: String