;
}
/**
* GetAlarmLog请求参数结构体
*/
export interface GetAlarmLogRequest {
/**
* 要查询的执行详情的起始时间,Unix时间戳,单位ms。
*/
From: number;
/**
* 要查询的执行详情的结束时间,Unix时间戳,单位ms。
*/
To: number;
/**
* 查询过滤条件,例如:
按告警策略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及监控对象ID查询支持SQL语句:(alert_id:"alarm-5ce45495-0918-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 该查询语句走Lucene语法(已废弃)
* @deprecated
*/
Query?: string;
/**
* 查询过滤条件,例如:- 按告警策略ID查询:alert_id:"alarm-0745ec00-e605-xxxx-b50b-54afe61fc971" - 通过获取告警策略列表 获取告警策略ID- 按监控对象ID查询:monitored_object:"823d8bfa-76a7-xxxx-8399-8cda74d4009b" - 通过获取告警策略列表 获取监控对象ID- 按告警策略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-0918-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
该查询语句走CQL语法
*/
QueryString?: string;
/**
* 单次查询返回的执行详情条数,最大值为1000
*/
Limit?: number;
/**
* 透传上次接口返回的Context值,可获取后续更多日志,总计最多可获取1万条原始日志,过期时间1小时。 注意:
透传该参数时,请勿修改除该参数外的其它参数 仅当检索分析语句(Query)不包含SQL时有效,SQL获取后续结果参考SQL LIMIT语法
*/
Context?: string;
/**
* 原始日志是否按时间排序返回;可选值:asc(升序)、desc(降序),默认为 desc 注意:
*/
Sort?: string;
/**
* true:代表使用新的检索结果返回方式,输出参数AnalysisRecords和Columns有效; false:代表使用老的检索结果返回方式,输出AnalysisResults和ColNames有效; 两种返回方式在编码格式上有少量区别,建议使用true。
*/
UseNewAnalysis?: boolean;
}
/**
* DeleteCosRecharge返回参数结构体
*/
export interface DeleteCosRechargeResponse {
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* 自定义指标采集对象
*/
export interface CustomMetricSpec {
/**
* 端口。取值范围 [1,65535]
注意:此字段可能返回 null,表示取不到有效值。
*/
Port: string;
/**
* Metric地址。校验格式:`^/[a-zA-Z0-9-_./]*$`
注意:此字段可能返回 null,表示取不到有效值。
*/
Path: string;
/**
* 命名空间列表。
- 最大支持100个
- namespace 校验格式 `[a-z0-9]([-a-z0-9]*[a-z0-9])?` , 长度不能超过63
- namespace 不能重复
注意:此字段可能返回 null,表示取不到有效值。
*/
Namespaces?: Array;
/**
* Pod标签。
- 最大支持100个
注意:此字段可能返回 null,表示取不到有效值。
*/
PodLabel?: Array;
}
/**
* 数据湖计算服务(Data Lake Compute,简称DLC)数据分区配置
*/
export interface DlcPartitionInfo {
/**
* cls日志中的字段名
*/
ClsField: string;
/**
* dlc表的列名
*/
DlcField: string;
/**
* 请参考 DLC cloumn中的Type 定义
枚举值:
*/
DlcFieldType: string;
}
/**
* 分组触发条件
*/
export interface GroupTriggerConditionInfo {
/**
* 分组触发字段名称
*/
Key: string;
/**
* 分组触发字段值
*/
Value: string;
}
/**
* Kafka导入配置信息
*/
export interface KafkaRechargeInfo {
/**
* Kafka数据订阅配置的ID。
*/
Id?: string;
/**
* 日志主题ID
*/
TopicId?: string;
/**
* Kafka导入任务名称
*/
Name?: string;
/**
* 导入Kafka类型,0: 腾讯云CKafka,1: 用户自建Kafka
*/
KafkaType?: number;
/**
* 腾讯云CKafka实例ID,KafkaType为0时必填
*/
KafkaInstance?: string;
/**
* 服务地址
*/
ServerAddr?: string;
/**
* ServerAddr是否为加密连接
*/
IsEncryptionAddr?: boolean;
/**
* 加密访问协议,IsEncryptionAddr参数为true时必填
*/
Protocol?: KafkaProtocolInfo;
/**
* 用户需要导入的Kafka相关topic列表,多个topic之间使用半角逗号隔开
*/
UserKafkaTopics?: string;
/**
* 用户Kafka消费组名称
*/
ConsumerGroupName?: string;
/**
* 状态 ,1:运行中;2:暂停。
*/
Status?: number;
/**
* 导入数据位置,-2:最早(默认),-1:最晚
*/
Offset?: number;
/**
* 创建时间。格式YYYY-MM-DD HH:MM:SS
*/
CreateTime?: string;
/**
* 更新时间。格式YYYY-MM-DD HH:MM:SS
*/
UpdateTime?: string;
/**
* 日志导入规则
*/
LogRechargeRule?: LogRechargeRuleInfo;
/**
* 私有网络信息
*/
NetworkInfo?: NetworkInfo;
/**
* 用户kafka拓展信息
*/
UserKafkaMeta?: UserKafkaMeta;
}
/**
* 采集规则配置信息
*/
export interface ConfigInfo {
/**
* 采集规则配置ID
*/
ConfigId?: string;
/**
* 采集规则配置名称
*/
Name?: string;
/**
* 日志格式化方式
*/
LogFormat?: string;
/**
* 日志采集路径
*/
Path?: string;
/**
* 采集的日志类型。
- json_log代表:JSON-文件日志(详见[使用 JSON 提取模式采集日志](https://cloud.tencent.com/document/product/614/17419));
- delimiter_log代表:分隔符-文件日志(详见[使用分隔符提取模式采集日志](https://cloud.tencent.com/document/product/614/17420));
- minimalist_log代表:单行全文-文件日志(详见[使用单行全文提取模式采集日志](https://cloud.tencent.com/document/product/614/17421));
- fullregex_log代表:单行完全正则-文件日志(详见[使用单行-完全正则提取模式采集日志](https://cloud.tencent.com/document/product/614/52365));
- multiline_log代表:多行全文-文件日志(详见[使用多行全文提取模式采集日志](https://cloud.tencent.com/document/product/614/17422));
- multiline_fullregex_log代表:多行完全正则-文件日志(详见[使用多行-完全正则提取模式采集日志](https://cloud.tencent.com/document/product/614/52366));
- user_define_log代表:组合解析(适用于多格式嵌套的日志,详见[使用组合解析提取模式采集日志](https://cloud.tencent.com/document/product/614/61310));
- service_syslog代表:syslog 采集(详见[采集 Syslog](https://cloud.tencent.com/document/product/614/81454));
- windows_event_log代表:Windows事件日志(详见[采集 Windows 事件日志](https://cloud.tencent.com/document/product/614/96678))。
*/
LogType?: string;
/**
* 提取规则,如果设置了ExtractRule,则必须设置LogType
*/
ExtractRule?: ExtractRuleInfo;
/**
* 采集黑名单路径列表
注意:此字段可能返回 null,表示取不到有效值。
*/
ExcludePaths?: Array;
/**
* 采集配置所属日志主题ID即TopicId
*/
Output?: string;
/**
* 更新时间
- 时间格式:yyyy-MM-dd HH:mm:ss
*/
UpdateTime?: string;
/**
* 创建时间
- 时间格式:yyyy-MM-dd HH:mm:ss
*/
CreateTime?: string;
/**
* 用户自定义解析字符串,详见[使用组合解析提取模式采集日志](https://cloud.tencent.com/document/product/614/61310)。
*/
UserDefineRule?: string;
/**
* 高级采集配置。 Json字符串, Key/Value定义为如下:
- ClsAgentFileTimeout(超时属性), 取值范围: 大于等于0的整数, 0为不超时
- ClsAgentMaxDepth(最大目录深度),取值范围: 大于等于0的整数
- ClsAgentParseFailMerge(合并解析失败日志),取值范围: true或false
样例:
`{\"ClsAgentFileTimeout\":0,\"ClsAgentMaxDepth\":10,\"ClsAgentParseFailMerge\":true}`
控制台默认占位值:`{\"ClsAgentDefault\":0}`
*/
AdvancedConfig?: string;
/**
* 日志输入类型(注:windows场景必填且仅支持file和windows_event类型 )
- file: 文件类型采集
- windows_event:windows事件采集
- syslog:系统日志采集
*/
InputType?: string;
}
/**
* DeleteTopic请求参数结构体
*/
export interface DeleteTopicRequest {
/**
* 主题ID- 通过[获取日志主题列表](https://cloud.tencent.com/document/product/614/56454)获取日志主题Id。
*/
TopicId: string;
}
/**
* ModifyShipper请求参数结构体
*/
export interface ModifyShipperRequest {
/**
* 投递规则Id。
*/
ShipperId: string;
/**
* COS存储桶,详见产品支持的存储桶命名规范 。
*/
Bucket?: string;
/**
* 投递规则投递的新的目录前缀。
仅支持0-9A-Za-z-_/ 最大支持256个字符
*/
Prefix?: string;
/**
* 投递规则的开关状态。true:开启投递任务;false:关闭投递任务。
*/
Status?: boolean;
/**
* 投递规则的名字
*/
ShipperName?: string;
/**
* 投递的时间间隔,单位 秒,默认300,范围 300-900
*/
Interval?: number;
/**
* 投递的文件的最大值,单位 MB,默认256,范围 5-256
*/
MaxSize?: number;
/**
* 投递日志的过滤规则,匹配的日志进行投递,各rule之间是and关系,最多5个,数组为空则表示不过滤而全部投递
*/
FilterRules?: Array;
/**
* 投递日志的分区规则,支持strftime的时间格式表示
*/
Partition?: string;
/**
* 投递日志的压缩配置
*/
Compress?: CompressInfo;
/**
* 投递日志的内容格式配置
*/
Content?: ContentInfo;
/**
* 投递文件命名配置,0:随机数命名,1:投递时间命名。
*/
FilenameMode?: number;
/**
* 对象存储类型,默认值为 STANDARD。枚举值请参见 存储类型概述 文档。 参考值有:
STANDARD:标准存储 STANDARD_IA:低频存储 ARCHIVE:归档存储 DEEP_ARCHIVE:深度归档存储 MAZ_STANDARD:标准存储(多 AZ) MAZ_STANDARD_IA:低频存储(多 AZ) INTELLIGENT_TIERING:智能分层存储 MAZ_INTELLIGENT_TIERING:智能分层存储(多 AZ)
*/
StorageType?: string;
/**
* 角色访问描述名 创建角色
*/
RoleArn?: string;
/**
* 外部ID
*/
ExternalId?: string;
/**
* 用于生成投递到COS 的文件路径中的时间变量
入参限制:支持下面时区列表
GMT-12:00 GMT-11:00 GMT-10:00 GMT-09:30 GMT-09:00 GMT-08:00 GMT-07:00 GMT-06:00 GMT-05:00 GMT-04:00 GMT-03:30 GMT-03:00 GMT-02:00 GMT-01:00 GMT+00:00 GMT+01:00 GMT+02:00 GMT+03:30 GMT+04:00 GMT+04:30 GMT+05:00 GMT+05:30 GMT+05:45 GMT+06:00 GMT+06:30 GMT+07:00 GMT+08:00 GMT+09:00 GMT+09:30 GMT+10:00 GMT+10:30 GMT+11:00 GMT+11:30 GMT+12:00 GMT+12:45 GMT+13:00 GMT+14:00 UTC-11:00 UTC-10:00 UTC-09:00 UTC-08:00 UTC-12:00 UTC-07:00 UTC-06:00 UTC-05:00 UTC-04:30 UTC-04:00 UTC-03:30 UTC-03:00 UTC-02:00 UTC-01:00 UTC+00:00 UTC+01:00 UTC+02:00 UTC+03:00 UTC+03:30 UTC+04:00 UTC+04:30 UTC+05:00 UTC+05:45 UTC+06:00 UTC+06:30 UTC+07:00 UTC+08:00 UTC+09:00 UTC+09:30 UTC+10:00 UTC+11:00 UTC+12:00 UTC+13:00
*/
TimeZone?: string;
/**
* 预过滤处理-对写入COS原始数据进行预过滤处理
*/
DSLFilter?: string;
}
/**
* 腾讯云可观测平台通知渠道组信息
*/
export interface MonitorNoticeRule {
/**
* 腾讯云可观测平台通知模板 ID
*/
NoticeId?: string;
/**
* 腾讯云可观测平台内容模板ID,为空时使用默认内容模板
注意:此字段可能返回 null,表示取不到有效值。
*/
ContentTmplId?: string;
/**
* 告警级别,0:警告(Warn); 1:提醒(Info); 2:紧急 (Critical)
*/
AlarmLevels?: Array;
}
/**
* 多日志主题检索topic信息
*/
export interface SearchLogInfos {
/**
* 日志主题ID
*/
TopicId?: string;
/**
* 日志存储生命周期
*/
Period?: number;
/**
* 透传本次接口返回的Context值,可获取后续更多日志,过期时间1小时
*/
Context?: string;
}
/**
* DescribeKafkaConsumerPreview请求参数结构体
*/
export type DescribeKafkaConsumerPreviewRequest = null;
/**
* DescribeAgentApplications请求参数结构体
*/
export interface DescribeAgentApplicationsRequest {
/**
* 过滤项
applicationName 按照【应用名称】进行过滤。模糊匹配方式查询。 类型:String 必选:否
applicationId 按照【应用id】进行过滤。 类型:String 必选:否
accessType 按照【接入类型】进行过滤。 类型:String 支持:Langfuse 必选:否
每次请求的Filters的上限为10,Filter.Values的上限为10。
*/
Filters?: Array;
/**
* 分页的偏移量,默认值为0。
*/
Offset?: number;
/**
* 分页单页限制数目,默认值为20,最大值100。
*/
Limit?: number;
}
/**
* CreateDeliverCloudFunction返回参数结构体
*/
export interface CreateDeliverCloudFunctionResponse {
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* DescribeDashboards返回参数结构体
*/
export interface DescribeDashboardsResponse {
/**
* 仪表盘的数量
*/
TotalCount?: number;
/**
* 仪表盘详细明细
*/
DashboardInfos?: Array;
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* 投递日志的压缩配置
*/
export interface CompressInfo {
/**
* 压缩格式,支持gzip、lzop、snappy和none不压缩
*/
Format: string;
}
/**
* ModifyRemoteWriteTask返回参数结构体
*/
export interface ModifyRemoteWriteTaskResponse {
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* DescribeResourceGraphProductIngestTaskDetail请求参数结构体
*/
export interface DescribeResourceGraphProductIngestTaskDetailRequest {
/**
* 资源图谱id
*/
ResourceGraphId: string;
/**
* 接入任务id
*/
TaskId: string;
}
/**
* CreateConfig返回参数结构体
*/
export interface CreateConfigResponse {
/**
* 采集配置ID
*/
ConfigId?: string;
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* CreateCloudProductLogCollection返回参数结构体
*/
export interface CreateCloudProductLogCollectionResponse {
/**
* 日志主题ID
*/
TopicId?: string;
/**
* 日志主题名称
*/
TopicName?: string;
/**
* 日志集ID
*/
LogsetId?: string;
/**
* 日志集名称
*/
LogsetName?: string;
/**
* -1 创建中,1创建完成
*/
Status?: number;
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* SearchCosRechargeInfo返回参数结构体
*/
export interface SearchCosRechargeInfoResponse {
/**
* 匹配到的存储桶下的某个文件的前几行数据
*/
Data?: Array;
/**
* 匹配到的存储桶下的文件个数
*/
Sum?: number;
/**
* 当前预览文件路径
*/
Path?: string;
/**
* 预览获取数据失败原因
*/
Msg?: string;
/**
* 状态。
- 0:成功
- 10000:参数错误,请确认参数
- 10001:授权失败,请确认授权
- 10002:获取文件列表失败,请稍后再试。若无法解决,请咨询 [在线支持](https://cloud.tencent.com/online-service) 或 [提交工单](https://console.cloud.tencent.com/workorder/category?level1_id=83&level2_id=469&source=14&data_title=%E6%97%A5%E5%BF%97%E6%9C%8D%E5%8A%A1&step=1) 处理。
- 10003:桶内无相应前缀文件,请使用正确的桶、文件前缀和压缩方式
- 10004:文件下载失败,请稍后再试。若无法解决,请咨询 [在线支持](https://cloud.tencent.com/online-service) 或 [提交工单](https://console.cloud.tencent.com/workorder/category?level1_id=83&level2_id=469&source=14&data_title=%E6%97%A5%E5%BF%97%E6%9C%8D%E5%8A%A1&step=1) 处理。
- 10005:文件解压缩失败,请选择正确的压缩方式然后再试
- 10006:读取文件内容失败,请确认文件可读
- 10007:文件预览失败,请稍后再试。若无法解决,请咨询 [在线支持](https://cloud.tencent.com/online-service) 或 [提交工单](https://console.cloud.tencent.com/workorder/category?level1_id=83&level2_id=469&source=14&data_title=%E6%97%A5%E5%BF%97%E6%9C%8D%E5%8A%A1&step=1) 处理。
*/
Status?: number;
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* CreateEsRecharge返回参数结构体
*/
export interface CreateEsRechargeResponse {
/**
* 配置id
*/
TaskId?: string;
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* 键值或者元字段索引的字段信息
*/
export interface KeyValueInfo {
/**
* 需要配置键值或者元字段索引的字段名称,仅支持字母、数字、下划线和-./@,且不能以下划线开头
注意:
1,元字段(tag)的Key无需额外添加`__TAG__.`前缀,与上传日志时对应的字段Key一致即可,腾讯云控制台展示时将自动添加`__TAG__.`前缀
2,键值索引(KeyValue)及元字段索引(Tag)中的Key总数不能超过300
3,Key的层级不能超过10层,例如a.b.c.d.e.f.g.h.j.k
4,不允许同时包含json父子级字段,例如a及a.b
*/
Key: string;
/**
* 字段的索引描述信息
*/
Value: ValueInfo;
}
/**
* 外部表SQL信息
*/
export interface DataTransformSqlDataSource {
/**
* 数据源类型 1:MySql;2:自建mysql;3:pgsql
*/
DataSource: number;
/**
* InstanceId所属地域。例如:ap-guangzhou
*/
Region: string;
/**
* 实例Id。
- 当DataSource为1时,表示云数据库Mysql 实例id,如:cdb-zxcvbnm
*/
InstanceId: string;
/**
* mysql访问用户名
*/
User: string;
/**
* 别名。数据加工语句中使用
*/
AliasName: string;
/**
* mysql访问密码。
*/
Password?: string;
}
/**
* ModifyMachineGroup请求参数结构体
*/
export interface ModifyMachineGroupRequest {
/**
* 机器组Id
- 通过[获取机器组列表](https://cloud.tencent.com/document/product/614/56438)获取机器组Id。
*/
GroupId: string;
/**
* 机器组名称
输入限制:
- 不能为空字符串
- 不能包含字符'|'
*/
GroupName?: string;
/**
* 机器组类型。
Type:ip,Values中为ip字符串列表机器组;
Type:label,Values中为标签字符串列表机器组。
*/
MachineGroupType?: MachineGroupTypeInfo;
/**
* 标签列表
*/
Tags?: Array;
/**
* 是否开启机器组自动更新
*/
AutoUpdate?: boolean;
/**
* 升级开始时间,建议业务低峰期升级LogListener
时间格式:HH:mm:ss
*/
UpdateStartTime?: string;
/**
* 升级结束时间,建议业务低峰期升级LogListener
时间格式:HH:mm:ss
*/
UpdateEndTime?: string;
/**
* 是否开启服务日志,用于记录因Loglistener 服务自身产生的log,开启后,会创建内部日志集cls_service_logging和日志主题loglistener_status,loglistener_alarm,loglistener_business,不产生计费
*/
ServiceLogging?: boolean;
/**
* 机器组中机器定期离线清理时间。单位:天
*/
DelayCleanupTime?: number;
/**
* 机器组元数据信息列表
*/
MetaTags?: Array;
}
/**
* **JsonExpandInfo 数据结构描述**:
```
JSON嵌套展开配置
```
**各字段描述**:
| 字段 | 描述 |
|------|------|
| Switch | 是否开启JSON嵌套展开 |
| Fields | 待展开的JSON字段列表,1~3个 |
| DropOriginal | 展开后是否丢弃原始字段,默认true |
| ConflictPolicy | 字段冲突策略,keep_outer:保留外层(默认),keep_inner:保留内层 |
**LogRechargeRuleInfo 新增字段**:
| 字段 | 描述 |
|------|------|
| JsonExpand | JSON嵌套展开配置,仅RechargeType为json_log时生效 |
*/
export interface JsonExpandInfo {
/**
* 是否开启JSON嵌套展开功能。开启后将对指定JSON字段进行扁平化展开处理
默认值:无(必选参数)
*/
Switch: boolean;
/**
* 待展开的JSON字段名列表,支持1~3个字段,字段名不可为空串且不可重复
入参限制:1. 字段数量:1~3个2. 每个字段名长度不超过128个字符3. 字段名不可为空字符串4. 字段名之间不可重复
默认值:无(必选参数)
取值参考:取值:message;描述:示例字段名
示例:["message", "data", "content"]
*/
Fields: Array;
/**
* 展开后是否丢弃原始的嵌套字段。true: 丢弃原始字段只保留展开后的平铺字段; false: 保留原始字段同时增加展开后的平铺字段
枚举值:
true / false: 丢弃原字段 / 保留原字段 默认值:true
非必选,不传时默认为true
*/
DropOriginal?: boolean;
/**
* 展开后的字段与已有字段发生冲突时的处理策略
枚举值:
keep_outer / keep_inner: 保留外层(已存在)字段 / 保留内层(新展开)字段 默认值:keep_outer
非必选,不传时默认为keep_outer
*/
ConflictPolicy?: string;
}
/**
* 免鉴权信息
*/
export interface AnonymousInfo {
/**
* 操作列表,支持trackLog(JS/HTTP上传日志 )和realtimeProducer(kafka协议上传日志)
*/
Operations?: Array;
/**
* 条件列表
*/
Conditions?: Array;
}
/**
* DescribeHostMetricConfigs返回参数结构体
*/
export interface DescribeHostMetricConfigsResponse {
/**
* 总数目
*/
TotalCount?: number;
/**
* 指标订阅配置信息
*/
Infos?: Array;
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* CreateNoticeContent请求参数结构体
*/
export interface CreateNoticeContentRequest {
/**
* 模板名称。最大支持255个字节
*/
Name: string;
/**
* 模板内容语言。0:中文1:英文
*/
Type?: number;
/**
* 模板详细配置。
*/
NoticeContents?: Array;
}
/**
* CreateDashboard请求参数结构体
*/
export interface CreateDashboardRequest {
/**
* 仪表盘名称
*/
DashboardName: string;
/**
* 仪表盘配置数据
*/
Data?: string;
/**
* 标签描述列表,通过指定该参数可以同时绑定标签到相应的日志主题。最大支持10个标签键值对,同一个资源只能绑定到同一个标签键下。
*/
Tags?: Array;
}
/**
* DeleteAlarmNotice请求参数结构体
*/
export interface DeleteAlarmNoticeRequest {
/**
* 通知渠道组ID。-通过[获取通知渠道组列表](https://cloud.tencent.com/document/api/614/56462)获取通知渠道组ID
*/
AlarmNoticeId: string;
}
/**
* DeleteLogset请求参数结构体
*/
export interface DeleteLogsetRequest {
/**
* 日志集Id。通过 [获取日志集列表](https://cloud.tencent.com/document/product/614/58624)获取日志集Id。
*/
LogsetId: string;
}
/**
* DescribeConsumers请求参数结构体
*/
export interface DescribeConsumersRequest {
/**
* - consumerId
按照【投递规则ID】进行过滤。
类型:String
必选:否
- topicId
按照【日志主题】进行过滤。
类型:String
必选:否
- taskStatus
按照【任务运行状态】进行过滤。 支持`0`:停止,`1`:运行中,`2`:异常
类型:String
必选:否
每次请求的Filters的上限为10,Filter.Values的上限为10。
*/
Filters?: Array;
/**
* 分页的偏移量,默认值为0
*/
Offset?: number;
/**
* 分页单页的限制数目,默认值为20,最大值100
*/
Limit?: number;
}
/**
* ModifyRecordingRuleYamlTask返回参数结构体
*/
export interface ModifyRecordingRuleYamlTaskResponse {
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* CreateMachineGroup请求参数结构体
*/
export interface CreateMachineGroupRequest {
/**
* 机器组名字。
输入限制:
- 最大支持255个字符,不能为空字符串
- 不能包含字符'|'
*/
GroupName: string;
/**
* 创建机器组类型。取值如下:
- Type:ip,Values中为ip字符串列表创建机器组
- Type:label,Values中为标签字符串列表创建机器组
*/
MachineGroupType: MachineGroupTypeInfo;
/**
* 标签描述列表,通过指定该参数可以同时绑定标签到相应的机器组。最大支持10个标签键值对,同一个资源只能绑定到同一个标签键下。
*/
Tags?: Array;
/**
* 是否开启机器组自动更新。默认false
*/
AutoUpdate?: boolean;
/**
* 升级开始时间,建议业务低峰期升级LogListener
时间格式:HH:mm:ss
*/
UpdateStartTime?: string;
/**
* 升级结束时间,建议业务低峰期升级LogListener
时间格式:HH:mm:ss
*/
UpdateEndTime?: string;
/**
* 是否开启服务日志,用于记录因Loglistener 服务自身产生的log,开启后,会创建内部日志集cls_service_logging和日志主题loglistener_status,loglistener_alarm,loglistener_business,不产生计费。默认false
*/
ServiceLogging?: boolean;
/**
* 机器组中机器离线清理时间。单位:天
- 大于0时生效。
*/
DelayCleanupTime?: number;
/**
* 机器组元数据信息列表
*/
MetaTags?: Array;
/**
* 系统类型,取值如下:
- 0:Linux (默认值)
- 1:Windows
*/
OSType?: number;
}
/**
* DescribeExports返回参数结构体
*/
export interface DescribeExportsResponse {
/**
* 日志导出列表
*/
Exports?: Array;
/**
* 总数目
*/
TotalCount?: number;
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* 投递配置入参
*/
export interface DeliverConfig {
/**
* 地域信息。
示例:
ap-guangzhou 广州地域;
ap-nanjing 南京地域。
详细信息请查看官网[地域和访问域名](https://cloud.tencent.com/document/product/614/18940)
*/
Region: string;
/**
* 日志主题ID。-通过[获取日志主题列表](https://cloud.tencent.com/document/product/614/56454)获取日志主题ID
*/
TopicId: string;
/**
* 投递数据范围。
0: 全部日志, 包括告警策略日常周期执行的所有日志,也包括告警策略变更产生的日志,默认值
1:仅告警触发及恢复日志
*/
Scope: number;
}
/**
* csv内容描述
*/
export interface CsvInfo {
/**
* csv首行是否打印key
*/
PrintKey: boolean;
/**
* 每列key的名字
注意:此字段可能返回 null,表示取不到有效值。
*/
Keys: Array;
/**
* 各字段间的分隔符
*/
Delimiter: string;
/**
* 若字段内容中包含分隔符,则使用该转义符包裹改字段,只能填写单引号、双引号、空字符串
*/
EscapeChar: string;
/**
* 对于上面指定的不存在字段使用该内容填充
*/
NonExistingField: string;
}
/**
* DescribeCloudProductLogTasks请求参数结构体
*/
export interface DescribeCloudProductLogTasksRequest {
/**
* 分页的偏移量,默认值为0。
*/
Offset?: number;
/**
* 分页单页限制数目,默认值为20,最大值100。
*/
Limit?: number;
/**
* assumerName按照【云产品标识】进行过滤。 类型:String 必选:否 枚举:CDS、CWP、CDB、TDSQL-C、MongoDB、TDStore、DCDB、MariaDB、PostgreSQL、BH、APIS logType按照【日志类型】进行过滤。 类型:String 必选:否 枚举:CDS-AUDIT、CDS-RISK、CDB-AUDIT、TDSQL-C-AUDIT、MongoDB-AUDIT、MongoDB-SlowLog、MongoDB-ErrorLog、TDMYSQL-SLOW、DCDB-AUDIT、DCDB-SLOW、DCDB-ERROR、MariaDB-AUDIT、MariaDB-SLOW、MariaDB-ERROR、PostgreSQL-SLOW、PostgreSQL-ERROR、PostgreSQL-AUDIT、BH-FILELOG、BH-COMMANDLOG、APIS-ACCESS instanceId按照【实例ID】进行过滤。 类型:String 必选:否
*/
Filters?: Array;
/**
* 是否携带topic和logset的标签信息
*/
WithTags?: boolean;
}
/**
* CreateAlarmNotice请求参数结构体
*/
export interface CreateAlarmNoticeRequest {
/**
* 通知渠道组名称。最大支持255个字节。 不支持 '|'。
*/
Name: string;
/**
* 标签描述列表,通过指定该参数可以同时绑定标签到相应的通知渠道组。最大支持50个标签键值对,并且不能有重复的键值对。
*/
Tags?: Array;
/**
* 【简易模式】(简易模式/告警模式二选一,分别配置相应参数) 需要发送通知的告警类型。可选值:
Trigger - 告警触发 Recovery - 告警恢复 All - 告警触发和告警恢复
*/
Type?: string;
/**
* 【简易模式】(简易模式/告警模式二选一,分别配置相应参数) 通知接收对象。
*/
NoticeReceivers?: Array;
/**
* 【简易模式】(简易模式/告警模式二选一,分别配置相应参数) 接口回调信息(包括企业微信、钉钉、飞书)。
*/
WebCallbacks?: Array;
/**
* 【高级模式】(简易模式/告警模式二选一,分别配置相应参数) 通知规则。
*/
NoticeRules?: Array;
/**
* 查询数据链接。http:// 或者 https:// 开头,不能/结尾
*/
JumpDomain?: string;
/**
* 投递日志开关。可取值如下: 1:关闭(默认值); 2:开启 投递日志开关开启时, DeliverConfig参数必填。
*/
DeliverStatus?: number;
/**
* 投递日志配置参数。当DeliverStatus开启时,必填。
*/
DeliverConfig?: DeliverConfig;
/**
* 免登录操作告警开关。可取值如下:
*/
AlarmShieldStatus?: number;
/**
* 告警详情安全认证跳转开关,未传时默认"关闭"
枚举值:
*/
SecureDetailStatus?: number;
/**
* 统一设定自定义回调参数。
true: 使用通知内容模板中的自定义回调参数覆盖告警策略中单独配置的请求头及请求内容。 false:优先使用告警策略中单独配置的请求头及请求内容。
*/
CallbackPrioritize?: boolean;
}
/**
* 直方图详细信息
*/
export interface HistogramInfo {
/**
* 统计周期内的日志条数
*/
Count?: number;
/**
* 按 period 取整后的 unix timestamp: 单位毫秒
*/
BTime?: number;
}
/**
* DescribeTopicMetricConfigs请求参数结构体
*/
export interface DescribeTopicMetricConfigsRequest {
/**
* 指标日志主题id。
- 通过 [获取日志主题列表](https://cloud.tencent.com/document/product/614/56454) 获取日志主题Id。注意BizType 0:日志主题(默认值), 1:指标主题
- 通过 [创建日志主题](https://cloud.tencent.com/document/product/614/56456) 获取日志主题Id。注意BizType 0:日志主题(默认值), 1:指标主题
*/
TopicId: string;
/**
* configId按照【指标采集配置id】进行过滤。类型:String 必选:否
name按照【配置名称】进行过滤。类型:String 必选:否
每次请求的Filters的上限为10,所有Filter.Values总和上限为100。
*/
Filters?: Array;
/**
* 分页的偏移量,默认值为0。
*/
Offset?: number;
/**
* 分页单页限制数目,默认值为20,最大值100。
*/
Limit?: number;
}
/**
* ModifyLogset请求参数结构体
*/
export interface ModifyLogsetRequest {
/**
* 日志集Id。通过 [获取日志集列表](https://cloud.tencent.com/document/product/614/58624)获取日志集Id。
*/
LogsetId: string;
/**
* 日志集名字。- 最大支持255个字符。不支持`|`字符。
*/
LogsetName?: string;
/**
* 日志集的绑定的标签键值对。最大支持10个标签键值对,同一个资源只能同时绑定一个标签键。
*/
Tags?: Array;
}
/**
* SearchDashboardSubscribe返回参数结构体
*/
export interface SearchDashboardSubscribeResponse {
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* ModifyCosRecharge请求参数结构体
*/
export interface ModifyCosRechargeRequest {
/**
* COS导入配置Id。
- 通过[获取cos导入配置](https://cloud.tencent.com/document/product/614/88099)接口获取COS导入配置Id。
*/
Id: string;
/**
* 日志主题Id。
- 通过[获取日志主题列表](https://cloud.tencent.com/document/product/614/56454)获取日志主题Id。
*/
TopicId: string;
/**
* COS导入任务名称,最大支持128个字节。
*/
Name?: string;
/**
* 任务状态 0: 停用 , 1:启用
*/
Enable?: number;
/**
* COS存储桶,详见产品支持的[存储桶命名规范](https://cloud.tencent.com/document/product/436/13312)。
- 通过[GET Service(List Buckets)](https://cloud.tencent.com/document/product/436/8291)获取COS存储桶。
*/
Bucket?: string;
/**
* COS存储桶所在地域,详见产品支持的[地域列表](https://cloud.tencent.com/document/product/436/6224)。
*/
BucketRegion?: string;
/**
* COS文件所在文件夹的前缀。为空串时投递存储桶下所有的文件。
*/
Prefix?: string;
/**
* 采集的日志类型,json_log代表json格式日志,delimiter_log代表分隔符格式日志,minimalist_log代表单行全文; 默认为minimalist_log
*/
LogType?: string;
/**
* 解析格式。supported: "", "gzip", "lzop", "snappy"。空串表示不压缩。
*/
Compress?: string;
/**
* 提取规则,如果设置了ExtractRule,则必须设置LogType
*/
ExtractRuleInfo?: ExtractRuleInfo;
/**
* COS导入任务类型。1:一次性导入任务;2:持续性导入任务。
*/
TaskType?: number;
/**
* 元数据。支持 bucket,object。
*/
Metadata?: Array;
}
/**
* DescribeClusterMetricConfigs返回参数结构体
*/
export interface DescribeClusterMetricConfigsResponse {
/**
* 总数目
*/
TotalCount?: number;
/**
* 指标采集配置列表
注意:此字段可能返回 null,表示取不到有效值。
*/
Datas?: Array;
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* DescribeWebCallbacks请求参数结构体
*/
export interface DescribeWebCallbacksRequest {
/**
* - name
按照【告警渠道回调配置名称】进行过滤。
类型:String
必选:否
- webCallbackId
按照【告警渠道回调配置ID】进行过滤。
类型:String
必选:否
- type
按照【告警渠道回调配置渠道类型】进行过滤。
类型:String
必选:否
枚举值:WeCom,DingTalk,Lark,Http
每次请求的Filters的上限为10,Filter.Values的上限为100。
*/
Filters?: Array;
/**
* 分页的偏移量,默认值为0。
*/
Offset?: number;
/**
* 分页单页限制数目,默认值为20,最大值100。
*/
Limit?: number;
}
/**
* DescribeKafkaConsumerGroupList返回参数结构体
*/
export interface DescribeKafkaConsumerGroupListResponse {
/**
* 日志主题名称
*/
TopicName?: string;
/**
* 日志集id
*/
LogsetId?: string;
/**
* 总个数
*/
Total?: number;
/**
* 消费组信息列表
*/
Groups?: Array;
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* 投递任务出入参 Content
*/
export interface ConsumerContent {
/**
* 是否投递 TAG 信息。 当EnableTag为true时,表示投递TAG元信息。
*/
EnableTag: boolean;
/**
* 需要投递的元数据列表,目前仅支持:__SOURCE__,__FILENAME__,__TIMESTAMP__,__HOSTNAME__和__PKGID__
*/
MetaFields: Array;
/**
* 当EnableTag为true时,必须填写TagJsonNotTiled字段。 TagJsonNotTiled用于标识tag信息是否json平铺。
TagJsonNotTiled为true时不平铺,示例: TAG信息:{"__TAG__":{"fieldA":200,"fieldB":"text"}} 不平铺:{"__TAG__":{"fieldA":200,"fieldB":"text"}}
TagJsonNotTiled为false时平铺,示例: TAG信息:{"__TAG__":{"fieldA":200,"fieldB":"text"}} 平铺:{"__TAG__.fieldA":200,"__TAG__.fieldB":"text"}
*/
TagJsonNotTiled?: boolean;
/**
* 投递时间戳精度,可选项 [1:秒;2:毫秒] ,默认是1。
*/
TimestampAccuracy?: number;
/**
* 投递Json格式。
枚举值:
0: 转义。示例: 日志原文:{"a":"aa", "b":{"b1":"b1b1", "c1":"c1c1"}} 投递到Ckafka:{"a":"aa","b":"{\"b1\":\"b1b1\", \"c1\":\"c1c1\"}"} 1: 和原始日志一致,不转义。示例: 日志原文:{"a":"aa", "b":{"b1":"b1b1", "c1":"c1c1"}} 投递到Ckafka:{"a":"aa", "b":{"b1":"b1b1", "c1":"c1c1"}}
*/
JsonType?: number;
/**
* 数值类型自动转换开关
枚举值:
true: JSON 结构中第一层级的 value 中的数字字符串(如 "123" )会被自动转换为数值类型(int / float)。 false: JSON 结构中第一层级的 value 中的数字字符串(如 "123" )为字符串。 默认值:false
*/
AutoConvertNumber?: boolean;
}
/**
* CreateMetricSubscribe返回参数结构体
*/
export interface CreateMetricSubscribeResponse {
/**
* 配置id
*/
TaskId?: string;
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* DescribeMachines请求参数结构体
*/
export interface DescribeMachinesRequest {
/**
* 查询的机器组ID。
- 通过[获取机器组列表](https://cloud.tencent.com/document/api/614/56438)获取机器组ID。
*/
GroupId: string;
/**
* ip
- 按照ip进行过滤。
- 类型:String
- 必选:否
instance
- 按照实例id进行过滤。
- 类型:String
- 必选:否
version
- 按照LogListener版本进行过滤。
- 类型:String
- 必选:否
status
- 按照机器状态进行过滤。
- 类型:String
- 必选:否
- 可选值:0:离线,1:正常
offlineTime
- 按照机器离线时间进行过滤。
- 类型:String
- 必选:否
- -可选值:0:无离线时间,12:12小时内,24:一天内,48:两天内,99:两天前
每次请求的Filters的上限为10,Filter.Values的上限为100。
*/
Filters?: Array;
/**
* 分页的偏移量。
*/
Offset?: number;
/**
* 分页单页限制数目。最大支持100
*/
Limit?: number;
}
/**
* 需要过滤日志的key,及其对应的regex
*/
export interface KeyRegexInfo {
/**
* 需要过滤日志的key
*/
Key: string;
/**
* key对应的过滤规则regex
*/
Regex: string;
}
/**
* DeleteSplunkDeliver返回参数结构体
*/
export interface DeleteSplunkDeliverResponse {
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* DescribeResourceGraphProductIngestTaskDetail返回参数结构体
*/
export interface DescribeResourceGraphProductIngestTaskDetailResponse {
/**
* 接入任务详情
*/
ProductIngestTaskDetail?: ProductIngestTaskDetail;
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* DescribeTopicMetricConfigs返回参数结构体
*/
export interface DescribeTopicMetricConfigsResponse {
/**
* 总数目
*/
TotalCount?: number;
/**
* 指标采集配置列表
注意:此字段可能返回 null,表示取不到有效值。
*/
Datas?: Array;
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* DeleteDashboardSubscribe请求参数结构体
*/
export interface DeleteDashboardSubscribeRequest {
/**
* 仪表盘订阅记录id。通过 [获取仪表盘订阅列表](https://cloud.tencent.com/document/api/614/105779)接口获取Id。
*/
Id: number;
}
/**
* DescribeResourceGraphTkeClusterStatus请求参数结构体
*/
export interface DescribeResourceGraphTkeClusterStatusRequest {
/**
* 待检测的tke集群id
*/
ClusterIds: Array;
}
/**
* kafka协议消费内容
*/
export interface KafkaConsumerContent {
/**
* 消费数据格式。 0:原始内容;1:JSON。
*/
Format: number;
/**
* 是否投递 TAG 信息 Format为0时,此字段不需要赋值
*/
EnableTag: boolean;
/**
* 元数据信息列表, 可选值为:__SOURCE__、__FILENAME__ 、__TIMESTAMP__、__HOSTNAME__、__PKGID__ Format为0时,此字段不需要赋值
*/
MetaFields: Array;
/**
* tag数据处理方式:1:不平铺(默认值);2:平铺。
不平铺示例: TAG信息:{"__TAG__":{"fieldA":200,"fieldB":"text"}} 不平铺:{"__TAG__":{"fieldA":200,"fieldB":"text"}}
平铺示例: TAG信息:{"__TAG__":{"fieldA":200,"fieldB":"text"}} 平铺:{"__TAG__.fieldA":200,"__TAG__.fieldB":"text"}
*/
TagTransaction?: number;
/**
* 消费数据Json格式: 1:不转义(默认格式) 2:转义
投递Json格式。 JsonType为1:和原始日志一致,不转义。示例: 日志原文:{"a":"aa", "b":{"b1":"b1b1", "c1":"c1c1"}} 投递到Ckafka:{"a":"aa", "b":{"b1":"b1b1", "c1":"c1c1"}}
JsonType为2:转义。示例: 日志原文:{"a":"aa", "b":{"b1":"b1b1", "c1":"c1c1"}} 投递到Ckafka:{"a":"aa","b":"{\"b1\":\"b1b1\", \"c1\":\"c1c1\"}"}
*/
JsonType?: number;
/**
* 数值类型自动转换开关
枚举值:
true: JSON 结构中第一层级的 value 中的数字字符串(如 "123" )会被自动转换为数值类型(int / float)。 false: JSON 结构中第一层级的 value 中的数字字符串(如 "123" )为字符串。 默认值:false
*/
AutoConvertNumber?: boolean;
}
/**
* DeleteAlarmNotice返回参数结构体
*/
export interface DeleteAlarmNoticeResponse {
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* DeleteAlarmShield请求参数结构体
*/
export interface DeleteAlarmShieldRequest {
/**
* 屏蔽规则id。通过[获取告警屏蔽配置规则](https://cloud.tencent.com/document/api/614/103650)获取屏蔽规则ID
*/
TaskId: string;
/**
* 通知渠道组id。通过[获取告警屏蔽配置规则](https://cloud.tencent.com/document/api/614/103650)获取通知渠道组id
*/
AlarmNoticeId: string;
}
/**
* ModifyEsRecharge请求参数结构体
*/
export interface ModifyEsRechargeRequest {
/**
* 导入任务id。
*/
TaskId: string;
/**
* 日志主题id。
- 通过 [获取日志主题列表](https://cloud.tencent.com/document/product/614/56454) 获取日志主题Id。
- 通过 [创建日志主题](https://cloud.tencent.com/document/product/614/56456) 获取日志主题Id。
*/
TopicId: string;
/**
* 名称:长度不超过64字符。
*/
Name?: string;
/**
* 索引信息。不同索引可以通过英文逗号分隔,支持*通配符
*/
Index?: string;
/**
* es查询语句。
*/
Query?: string;
/**
* es集群配置信息。
*/
EsInfo?: EsInfo;
/**
* es导入信息。
*/
ImportInfo?: EsImportInfo;
/**
* es导入时间字段信息。
*/
TimeInfo?: EsTimeInfo;
/**
* 任务状态。1:运行, 2:暂停
*/
Status?: number;
/**
* 是否开启投递服务日志。1:关闭,2:开启。
*/
HasServicesLog?: number;
}
/**
* CreateNetworkApplication请求参数结构体
*/
export interface CreateNetworkApplicationRequest {
/**
* 网络应用名称:长度不超过64字符,名称不能重复。
只能包含以下字符: 至少包含一个字符 不能包含空格 不能包含其他特殊字符(如 @、#、$、% 等)
*/
Name: string;
/**
* 日志集ID
*/
LogsetId: string;
/**
* 主题名称。名称限制如下:
不能为空字符串 不能包含字符'|' 不能使用以下名称["cls_service_log","loglistener_status","loglistener_alarm","loglistener_business","cls_service_metric"]
*/
TopicName: string;
}
/**
* ModifyS3Recharge返回参数结构体
*/
export interface ModifyS3RechargeResponse {
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* DeleteLogset返回参数结构体
*/
export interface DeleteLogsetResponse {
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* TopicPartitionOffsetInfo
*/
export interface TopicPartitionOffsetInfo {
/**
* 日志主题id
注意:此字段可能返回 null,表示取不到有效值。
*/
TopicID: string;
/**
* 分区点位信息
注意:此字段可能返回 null,表示取不到有效值。
*/
PartitionOffsets: Array;
}
/**
* DeleteDlcDeliver返回参数结构体
*/
export interface DeleteDlcDeliverResponse {
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* Parquet内容描述
*/
export interface ParquetKeyInfo {
/**
* 键值名称
*/
KeyName: string;
/**
* 数据类型,目前支持6种类型:string、boolean、int32、int64、float、double
*/
KeyType: string;
/**
* 解析失败赋值信息
*/
KeyNonExistingField: string;
}
/**
* DescribeShipperTasks返回参数结构体
*/
export interface DescribeShipperTasksResponse {
/**
* 投递任务列表
注意:此字段可能返回 null,表示取不到有效值。
*/
Tasks?: Array;
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* DescribeAlarmShields返回参数结构体
*/
export interface DescribeAlarmShieldsResponse {
/**
* 符合条件的规则总数目
*/
TotalCount?: number;
/**
* 告警屏蔽规则详情
*/
AlarmShields?: Array;
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* ModifyConfigExtra返回参数结构体
*/
export interface ModifyConfigExtraResponse {
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* DeleteConsoleSharing请求参数结构体
*/
export interface DeleteConsoleSharingRequest {
/**
* 免密分享Id。
- 通过 [获取免密分享列表](https://cloud.tencent.com/document/product/614/109798) 获取免密分享Id。
- 通过 [创建免密分享](https://cloud.tencent.com/document/product/614/109800) 获取免密分享Id。
*/
SharingId: string;
}
/**
* UploadLog请求参数结构体
*/
export interface UploadLogRequest {
/**
* 日志主题id
- 通过[获取日志主题列表](https://cloud.tencent.com/document/product/614/56454)获取日志主题Id。
*/
TopicId: string;
/**
* 该参数已废弃,请勿使用
* @deprecated
*/
HashKey?: string;
/**
* 压缩方法,目前支持
- lz4
- zstd
*/
CompressType?: string;
}
/**
* DescribeResourceGraphEntityDependency返回参数结构体
*/
export interface DescribeResourceGraphEntityDependencyResponse {
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* ModifyConsoleSharing请求参数结构体
*/
export interface ModifyConsoleSharingRequest {
/**
* 免密分享Id。
- 通过 [获取免密分享列表](https://cloud.tencent.com/document/product/614/109798) 获取免密分享Id。
- 通过 [创建免密分享](https://cloud.tencent.com/document/product/614/109800) 获取免密分享Id。
*/
SharingId: string;
/**
* 指定分享链接有效期,单位:毫秒,最长可设定有效期为30天
*/
DurationMilliseconds: number;
}
/**
* 消耗量
*/
export interface ChatUsage {
/**
* 输入token数
*/
PromptTokens?: number;
/**
* 输出token数
*/
CompletionTokens?: number;
/**
* 总token数
*/
TotalTokens?: number;
}
/**
* 元数据Pod label标签结构体
*/
export interface AppointLabel {
/**
* 指定标签类型。
- 0:所有Pod label,Keys字段无效
- 1:指定Pod label,Keys字段不能为空
注意:此字段可能返回 null,表示取不到有效值。
*/
Type: number;
/**
* 元数据Pod标签的键。有效标签键有两个部分:可选前缀和名称,以斜杠 (/) 分隔。名称部分是必需的,并且必须不超过 63 个字符,以字母数字字符 ([a-z0-9A-Z]) 开头和结尾,中间有破折号(-)、下划线(_)、点(.) 和字母数字。前缀是可选的。如果指定,前缀必须是 DNS 子域:一系列以点 (.) 分隔的 DNS 标签,总长度不超过 253 个字符,后跟斜杠 ( /)。
- prefix 格式 `[a-z0-9]([-a-z0-9]*[a-z0-9])?(\.[a-z0-9]([-a-z0-9]*[a-z0-9])?)*`
- name 格式 `([A-Za-z0-9][-A-Za-z0-9_.]*)?[A-Za-z0-9]`
- key不能重复
注意:此字段可能返回 null,表示取不到有效值。
*/
Keys?: Array;
}
/**
* CommitConsumerOffsets请求参数结构体
*/
export interface CommitConsumerOffsetsRequest {
/**
* 消费组标识
*/
ConsumerGroup: string;
/**
* 消费机器名称
*/
Consumer: string;
/**
* 日志集id
*/
LogsetId: string;
/**
* topic分区点位信息
*/
TopicPartitionOffsetsInfo: Array;
}
/**
* ModifyConsole返回参数结构体
*/
export interface ModifyConsoleResponse {
/**
* DataSight控制台Id
*/
ConsoleId?: string;
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* 投递规则
*/
export interface ConsumerInfo {
/**
* 投递规则ID
*/
ConsumerId?: string;
/**
* 日志主题ID
*/
TopicId?: string;
/**
* 投递任务是否生效
*/
Effective?: boolean;
/**
* CKafka的描述
*/
Ckafka?: Ckafka;
/**
* 是否投递日志的元数据信息
*/
NeedContent?: boolean;
/**
* 如果需要投递元数据信息,元数据信息的描述
注意:此字段可能返回 null,表示取不到有效值。
*/
Content?: ConsumerContent;
/**
* 压缩方式[0:NONE;2:SNAPPY;3:LZ4]
注意:此字段可能返回 null,表示取不到有效值。
*/
Compression?: number;
/**
* 投递任务创建毫秒时间戳
注意:此字段可能返回 null,表示取不到有效值。
*/
CreateTime?: number;
/**
* 角色访问描述名 创建角色
注意:此字段可能返回 null,表示取不到有效值。
*/
RoleArn?: string;
/**
* 外部ID
注意:此字段可能返回 null,表示取不到有效值。
*/
ExternalId?: string;
/**
* 任务运行状态。支持0,1,2 - 0: 停止 - 1: 运行中 - 2: 异常
注意:此字段可能返回 null,表示取不到有效值。
*/
TaskStatus?: number;
/**
* 高级配置
*/
AdvancedConfig?: AdvancedConsumerConfiguration;
/**
* 日志预过滤-数据写入 ckafka 的原始数据进行预过滤处理
*/
DSLFilter?: string;
}
/**
* DescribeResourceGraphFailureDetail返回参数结构体
*/
export interface DescribeResourceGraphFailureDetailResponse {
/**
* 失败详情信息
*/
ErrorMessage?: string;
/**
* 最近一次失败时间
单位:秒
*/
LastFailedTime?: number;
/**
* 重试次数
*/
RetryCount?: number;
/**
* 首次失败时间
单位:秒
*/
FirstFailedAt?: number;
/**
* 引起失败的操作
*/
Operation?: string;
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* DescribeAlarms请求参数结构体
*/
export interface DescribeAlarmsRequest {
/**
* name
- 按照【告警策略名称】进行过滤。
- 类型:String
- 必选:否
- 示例:test-alarm
alarmId
- 按照【告警策略ID】进行过滤。
- 类型:String
- 必选:否
- 示例:alarm-b60cf034-c3d6-4b01-xxxx-4e877ebb4751
topicId
- 按照【监控对象的日志主题ID】进行过滤。
- 类型:String
- 必选:否
- 示例:6766f83d-659e-xxxx-a8f7-9104a1012743
enable
- 按照【启用状态】进行过滤。
- 类型:String
- 备注:enable参数值范围: 1, t, T, TRUE, true, True, 0, f, F, FALSE, false, False。 其它值将返回参数错误信息.
- 必选:否
- 示例:true
每次请求的Filters的上限为10,Filter.Values的上限为5。
*/
Filters?: Array;
/**
* 分页的偏移量,默认值为0。
*/
Offset?: number;
/**
* 分页单页限制数目,默认值为20,最大值100。
*/
Limit?: number;
}
/**
* DescribeShippers返回参数结构体
*/
export interface DescribeShippersResponse {
/**
* 投递规则列表
*/
Shippers?: Array;
/**
* 本次查询获取到的总数
*/
TotalCount?: number;
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* ModifyShipper返回参数结构体
*/
export interface ModifyShipperResponse {
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* kafka协议消费组区分信息
*/
export interface GroupPartitionInfo {
/**
* 分区id
*/
PartitionId?: number;
/**
* 分区最新数据时间戳,单位:s
*/
CommitTimestamp?: number;
/**
* 消费者
*/
Consumer?: string;
}
/**
* GetMetricLabelValues返回参数结构体
*/
export interface GetMetricLabelValuesResponse {
/**
* 时序metric label values
*/
Values?: Array;
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* QueryMetric返回参数结构体
*/
export interface QueryMetricResponse {
/**
* 指标查询结果类型,支持
- scalar 标量值
- string 字符串值
- vector 瞬时向量
- matrix 区间向量
*/
ResultType?: string;
/**
* 指标查询结果
*/
Result?: string;
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* DescribeScheduledSqlInfo返回参数结构体
*/
export interface DescribeScheduledSqlInfoResponse {
/**
* ScheduledSQL任务列表信息
*/
ScheduledSqlTaskInfos?: Array;
/**
* 任务总次数
*/
TotalCount?: number;
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* OpenKafkaConsumer返回参数结构体
*/
export interface OpenKafkaConsumerResponse {
/**
* KafkaConsumer 消费时使用的Topic参数
*/
TopicID?: string;
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* 告警对象
*/
export interface AlarmTargetInfo {
/**
* 日志集ID。
*/
LogsetId?: string;
/**
* 日志集名称。
*/
LogsetName?: string;
/**
* 日志主题ID。
*/
TopicId?: string;
/**
* 日志主题名称。
*/
TopicName?: string;
/**
* 查询语句。
*/
Query?: string;
/**
* 告警对象序号。
*/
Number?: number;
/**
* 查询范围起始时间相对于告警执行时间的偏移,单位为分钟,取值为非正,最大值为0,最小值为-1440。
*/
StartTimeOffset?: number;
/**
* 查询范围终止时间相对于告警执行时间的偏移,单位为分钟,取值为非正,须大于StartTimeOffset,最大值为0,最小值为-1440。
*/
EndTimeOffset?: number;
/**
* 检索语法规则,默认值为0。
0:Lucene语法,1:CQL语法。
详细说明参见检索条件语法规则
*/
SyntaxRule?: number;
/**
* 主题类型。
0: 日志主题,1: 指标主题
*/
BizType?: number;
}
/**
* CreateSplunkDeliver返回参数结构体
*/
export interface CreateSplunkDeliverResponse {
/**
* splunk投递任务id
*/
TaskId?: string;
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* 文件路径信息
*/
export interface FilePathInfo {
/**
* 文件路径
*/
Path?: string;
/**
* 文件名称
*/
File?: string;
}
/**
* ModifyScheduledSql返回参数结构体
*/
export interface ModifyScheduledSqlResponse {
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* QueryRangeMetric请求参数结构体
*/
export interface QueryRangeMetricRequest {
/**
* 指标主题ID
- 通过[获取日志主题列表](https://cloud.tencent.com/document/product/614/56454)获取日志主题Id。
*/
TopicId: string;
/**
* 查询语句,使用PromQL语法
- 参考 [语法规则](https://cloud.tencent.com/document/product/614/90334) 文档
*/
Query: string;
/**
* 查询起始时间,秒级Unix时间戳
*/
Start: number;
/**
* 查询结束时间,秒级Unix时间戳
*/
End: number;
/**
* 查询时间间隔,单位秒
*/
Step: number;
}
/**
* 元数据信息
*/
export interface MetaTagInfo {
/**
* 元数据key
*/
Key?: string;
/**
* 元数据value
*/
Value?: string;
}
/**
* DescribeMachineGroups请求参数结构体
*/
export interface DescribeMachineGroupsRequest {
/**
* 过滤条件
machineGroupName
- 按照【机器组名称】进行过滤。
- 类型:String
- 必选:否
machineGroupId
- 按照【机器组ID】进行过滤。
- 类型:String
- 必选:否
osType
- 按照【操作系统类型】进行过滤。0: Linux;1: Windows
- 类型:Int
- 必选:否
tagKey
- 按照【标签键】进行过滤。
- 类型:String
- 必选:否
tag:tagKey
- 按照【标签键值对】进行过滤。tagKey使用具体的标签键进行替换。
- 类型:String
- 必选:否
每次请求的Filters的上限为10,Filter.Values的上限为5。
*/
Filters?: Array;
/**
* 分页的偏移量,默认值为0
*/
Offset?: number;
/**
* 分页单页的限制数目,默认值为20,最大值100
*/
Limit?: number;
}
/**
* eBPF 目的端点(IP + 可选端口)
*/
export interface EBPFEndpoint {
/**
* 目标 IP,支持 IPv4/IPv6
*/
IP: string;
/**
* 目标端口(1-65535),为空表示仅按 IP 过滤
注意:此字段可能返回 null,表示取不到有效值。
*/
Port?: number;
}
/**
* DescribeConfigs返回参数结构体
*/
export interface DescribeConfigsResponse {
/**
* 采集配置列表
注意:此字段可能返回 null,表示取不到有效值。
*/
Configs?: Array;
/**
* 过滤到的总数目
*/
TotalCount?: number;
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* 日志提取规则
*/
export interface ExtractRuleInfo {
/**
* 时间字段的key名字,TimeKey和TimeFormat必须成对出现
*/
TimeKey?: string;
/**
* 时间字段的格式,参考c语言的strftime函数对于时间的格式说明输出参数
*/
TimeFormat?: string;
/**
* 分隔符类型日志的分隔符,只有LogType为delimiter_log时有效
*/
Delimiter?: string;
/**
* 整条日志匹配规则,只有LogType为fullregex_log时有效
*/
LogRegex?: string;
/**
* 行首匹配规则,只有LogType为multiline_log或fullregex_log时有效
*/
BeginRegex?: string;
/**
* 取的每个字段的key名字,为空的key代表丢弃这个字段,只有LogType为delimiter_log时有效,json_log的日志使用json本身的key。限制100个。
注意:此字段可能返回 null,表示取不到有效值。
*/
Keys?: Array;
/**
* 日志过滤规则列表(旧版),需要过滤日志的key,及其对应的regex。 注意:2.9.3及以上版本LogListener ,建议使用AdvanceFilterRules配置日志过滤规则。
*/
FilterKeyRegex?: Array;
/**
* 解析失败日志是否上传,true表示上传,false表示不上传
注意:此字段可能返回 null,表示取不到有效值。
*/
UnMatchUpLoadSwitch?: boolean;
/**
* 失败日志的key,当UnMatchUpLoadSwitch为true时必填
注意:此字段可能返回 null,表示取不到有效值。
*/
UnMatchLogKey?: string;
/**
* 增量采集模式下的回溯数据量,默认:-1(全量采集);其他非负数表示增量采集(从最新的位置,往前采集${Backtracking}字节(Byte)的日志)最大支持1073741824(1G)。 注意:
注意:此字段可能返回 null,表示取不到有效值。
*/
Backtracking?: number;
/**
* 是否为Gbk编码。 0:否;1:是。 注意
目前取0值时,表示UTF-8编码 COS导入不支持此字段。
*/
IsGBK?: number;
/**
* 是否为标准json。 0:否; 1:是。
标准json指采集器使用业界标准开源解析器进行json解析,非标json指采集器使用CLS自研json解析器进行解析,两种解析器没有本质区别,建议客户使用标准json进行解析。
注意:此字段可能返回 null,表示取不到有效值。
*/
JsonStandard?: number;
/**
* syslog传输协议,取值为tcp或者udp,只有在LogType为service_syslog时生效,其余类型无需填写。 注意:
该字段适用于:创建采集规则配置、修改采集规则配置。 COS导入不支持此字段。
*/
Protocol?: string;
/**
* syslog系统日志采集指定采集器监听的地址和端口 ,形式:[ip]:[port],只有在LogType为service_syslog时生效,其余类型无需填写。 注意:
该字段适用于:创建采集规则配置、修改采集规则配置。 COS导入不支持此字段。
*/
Address?: string;
/**
* rfc3164:指定系统日志采集使用RFC3164协议解析日志。 rfc5424:指定系统日志采集使用RFC5424协议解析日志。 auto:自动匹配rfc3164或者rfc5424其中一种协议。 只有在LogType为service_syslog时生效,其余类型无需填写。 注意:
该字段适用于:创建采集规则配置、修改采集规则配置 COS导入不支持此字段。
*/
ParseProtocol?: string;
/**
* 元数据类型。0: 不使用元数据信息;1:使用机器组元数据;2:使用用户自定义元数据;3:使用采集配置路径。 注意:
*/
MetadataType?: number;
/**
* 采集配置路径正则表达式。
请用"()"标识路径中目标字段对应的正则表达式,解析时将"()"视为捕获组,并以__TAG__.{i}:{目标字段}的形式与日志一起上报,其中i为捕获组的序号。若不希望以序号为键名,可以通过命名捕获组"(?<{键名}>{正则})"自定义键名,并以__TAG__.{键名}:{目标字段}的形式与日志一起上报。最多支持5个捕获组注意:
MetadataType为3时必填。 COS导入不支持此字段。
*/
PathRegex?: string;
/**
* 用户自定义元数据信息。 注意:
MetadataType为2时必填。 COS导入不支持此字段。
*/
MetaTags?: Array;
/**
* Windows事件日志采集规则,只有在LogType为windows_event_log时生效,其余类型无需填写。
*/
EventLogRules?: Array;
/**
* 日志过滤规则列表(新版)。 注意:
2.9.3以下版本LogListener不支持, 请使用FilterKeyRegex配置日志过滤规则。 自建k8s采集配置(CreateConfigExtra、ModifyConfigExtra)不支持此字段。
注意:此字段可能返回 null,表示取不到有效值。
*/
AdvanceFilterRules?: Array;
/**
* 原始日志的键名称(Key);所有原始日志, 均以您指定的键名称(Key),原始日志内容作为值(Value)进行上传,为空时表示不开启原始日志上传。
*/
RawLogKey?: string;
/**
* 采集范围。空数组表示采集全部Unit,非空数组表示采集指定Unit
*/
Units?: Array;
/**
* 是否采集内核日志
默认值:true
*/
IncludeKernel?: boolean;
/**
* 是否使用journal原始时间。true :用 journal 原始时间;false: 用采集时间
默认值:false
*/
UseJournalTime?: boolean;
/**
* 字段间分隔符数组(长度 = keys.length),每个元素是前一字段结尾到当前字段开头的分隔串
*/
KeysDelimiter?: Array;
/**
* 字段标志位数组(长度 = keys.length),0 = 普通字段,1 = 包含子字段需二次拆分
*/
KeysFlag?: Array;
}
/**
* 主题基本信息
*/
export interface TopicInfo {
/**
* 日志集ID
*/
LogsetId?: string;
/**
* 主题ID
*/
TopicId?: string;
/**
* 主题名称
*/
TopicName?: string;
/**
* 主题分区个数
*/
PartitionCount?: number;
/**
* 主题是否开启索引(主题类型需为日志主题)
*/
Index?: boolean;
/**
* AssumerUin非空则表示创建该日志主题的服务方Uin
*/
AssumerUin?: number;
/**
* 云产品标识,主题由其它云产品创建时,该字段会显示云产品名称,例如CDN、TKE
*/
AssumerName?: string;
/**
* 创建时间。格式:yyyy-MM-dd HH:mm:ss
*/
CreateTime?: string;
/**
* 主题是否开启采集,true:开启采集;false:关闭采集。 创建日志主题时默认开启,可通过SDK调用ModifyTopic修改此字段。 控制台目前不支持修改此参数。
*/
Status?: boolean;
/**
* 主题绑定的标签信息
*/
Tags?: Array;
/**
* RoleName非空则表示创建该日志主题的服务方使用的角色
*/
RoleName?: string;
/**
* 该主题是否开启自动分裂
*/
AutoSplit?: boolean;
/**
* 若开启自动分裂的话,该主题能够允许的最大分区数
*/
MaxSplitPartitions?: number;
/**
* 主题的存储类型
*/
StorageType?: string;
/**
* 生命周期,单位天,可取值范围1~3600。取值为3640时代表永久保存
*/
Period?: number;
/**
* 云产品二级标识,日志主题由其它云产品创建时,该字段会显示云产品名称及其日志类型的二级分类,例如TKE-Audit、TKE-Event。部分云产品仅有云产品标识(AssumerName),无该字段。
*/
SubAssumerName?: string;
/**
* 主题描述
*/
Describes?: string;
/**
* 开启日志沉降,标准存储的生命周期, hotPeriod < Period。 标准存储为 hotPeriod, 低频存储则为 Period-hotPeriod。(主题类型需为日志主题) HotPeriod=0为没有开启日志沉降。
*/
HotPeriod?: number;
/**
* kms-cls服务秘钥id
CustomKmsInfo为空时为系统默认密钥,CustomKmsInfo不为空时为用户自定义密钥
*/
KeyId?: string;
/**
* 用户自定义 KMS 密钥信息
*/
CustomKmsInfo?: CustomKmsInfo;
/**
* 主题类型。
*/
BizType?: number;
/**
* 免鉴权开关。 false:关闭; true:开启。 开启后将支持指定操作匿名访问该日志主题。详情请参见日志主题 。
*/
IsWebTracking?: boolean;
/**
* 日志主题扩展信息
*/
Extends?: TopicExtendInfo;
/**
* 异步迁移任务ID
*/
TopicAsyncTaskID?: string;
/**
* 异步迁移状态
*/
MigrationStatus?: number;
/**
* 异步迁移完成后,预计生效日期 时间格式:yyyy-MM-dd HH:mm:ss
*/
EffectiveDate?: string;
/**
* IsSourceFrom 开启记录公网来源ip和服务端接收时间
*/
IsSourceFrom?: boolean;
/**
* 当前计费模式
枚举值:
0: 按使用功能计费 1: 按原始日志量计费(目前仅面向少部分客户支持)
*/
BillingMode?: number;
/**
* 如果有异步任务,任务成功后的新计费模式
枚举值:
0: 按使用功能计费 1: 按原始日志量计费(目前仅面向少部分客户支持)
*/
NewBillingMode?: number;
}
/**
* DeleteDataTransform返回参数结构体
*/
export interface DeleteDataTransformResponse {
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* 投递任务信息
*/
export interface ShipperTaskInfo {
/**
* 投递任务ID
*/
TaskId?: string;
/**
* 投递信息ID
*/
ShipperId?: string;
/**
* 日志主题ID
*/
TopicId?: string;
/**
* 本批投递的日志的开始时间戳,毫秒
*/
RangeStart?: number;
/**
* 本批投递的日志的结束时间戳, 毫秒
*/
RangeEnd?: number;
/**
* 本次投递任务的开始时间戳, 毫秒
*/
StartTime?: number;
/**
* 本次投递任务的结束时间戳, 毫秒
*/
EndTime?: number;
/**
* 本次投递的结果。"success","running","failed"
- success:任务成功。
- running:任务处理中。
- failed:任务失败。
*/
Status?: string;
/**
* 结果的详细信息
*/
Message?: string;
}
/**
* CreateConsumer返回参数结构体
*/
export interface CreateConsumerResponse {
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* 数据加工的资源信息
*/
export interface DataTransformResouceInfo {
/**
* 日志主题ID
*/
TopicId: string;
/**
* 别名 限制:不能包含字符 |。
*/
Alias?: string;
/**
* 是否是跨账号主题,false不是跨账号主题,true是跨账号主题
默认值:false
*/
IsCrossAccount?: boolean;
/**
* 跨账号场景下,被投递账号给投递账号创建的角色ARN值,在被投递账号的角色里查找
*/
RoleARN?: string;
/**
* 外部ID值,可以在被投递账号的角色-载体里找到该值
*/
ExternalId?: string;
/**
* topic名称
*/
TopicName?: string;
/**
* 日志集的名称
*/
LogsetName?: string;
}
/**
* DataSight内网匿名登录账号信息
*/
export interface AnonymousLoginInfo {
/**
* 匿名登录账号secretId
注意:此字段可能返回 null,表示取不到有效值。
*/
SecretId: string;
/**
* 匿名登录账号secretKey
注意:此字段可能返回 null,表示取不到有效值。
*/
SecretKey?: string;
}
/**
* DeleteMachineGroup请求参数结构体
*/
export interface DeleteMachineGroupRequest {
/**
* 机器组Id
- 通过[获取机器组列表](https://cloud.tencent.com/document/product/614/56438)获取机器组Id。
*/
GroupId: string;
}
/**
* 网络应用任务详情
*/
export interface NetworkApplicationDetail {
/**
* 网络应用Id
*/
NetworkAppId?: string;
/**
* 网络应用名称
*/
Name?: string;
/**
* 地域code
*/
Region?: string;
/**
* 日志主题id
*/
TopicId?: string;
/**
* 日志集id
*/
LogsetId?: string;
/**
* 应用token
*/
Token?: string;
/**
* 主账号id
*/
Uin?: number;
/**
* 子账号id
*/
SubUin?: number;
/**
* 创建时间,秒级时间戳
*/
CreateTime?: number;
/**
* 更新时间,秒级时间戳
*/
UpdateTime?: number;
}
/**
* DescribeSplunkDelivers返回参数结构体
*/
export interface DescribeSplunkDeliversResponse {
/**
* Splunk投递任务信息列表
*/
Infos?: Array;
/**
* 符合条件的任务总数。
*/
Total?: number;
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* DeleteResourceGraph请求参数结构体
*/
export interface DeleteResourceGraphRequest {
/**
* 待删除的资源图谱id
*/
ResourceGraphId: string;
}
/**
* DescribePartitions返回参数结构体
*/
export interface DescribePartitionsResponse {
/**
* 分区列表
*/
Partitions?: Array;
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* ModifyHostMetricConfig返回参数结构体
*/
export interface ModifyHostMetricConfigResponse {
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* DescribeMetricCorrectDimension返回参数结构体
*/
export interface DescribeMetricCorrectDimensionResponse {
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* ModifyAlarmNotice请求参数结构体
*/
export interface ModifyAlarmNoticeRequest {
/**
* 通知渠道组ID。-通过获取通知渠道组列表 获取通知渠道组ID
*/
AlarmNoticeId: string;
/**
* 标签描述列表,通过指定该参数可以同时绑定标签到相应的通知渠道组。最大支持10个标签键值对,并且不能有重复的键值对。
*/
Tags?: Array;
/**
* 通知渠道组名称。
*/
Name?: string;
/**
* 通知类型。可选值:
Trigger - 告警触发 Recovery - 告警恢复 All - 告警触发和告警恢复
*/
Type?: string;
/**
* 通知接收对象。
*/
NoticeReceivers?: Array;
/**
* 接口回调信息(包括企业微信等)。
*/
WebCallbacks?: Array;
/**
* 通知规则。
注意:
Type、NoticeReceivers和WebCallbacks是一组配置,NoticeRules是另一组配置,2组配置互斥。 传其中一组数据,则另一组数据置空。
*/
NoticeRules?: Array;
/**
* 调用链接域名。http:// 或者 https:// 开头,不能/结尾
*/
JumpDomain?: string;
/**
* 投递日志开关。
参数值: 1:关闭;
2:开启
*/
DeliverStatus?: number;
/**
* 投递日志配置。
*/
DeliverConfig?: DeliverConfig;
/**
* 免登录操作告警开关。
参数值: 1:关闭 2:开启(默认开启)
*/
AlarmShieldStatus?: number;
/**
* 告警详情安全认证跳转开关,未传时默认"关闭"
枚举值:
*/
SecureDetailStatus?: number;
/**
* 统一设定自定义回调参数。
true: 使用通知内容模板中的自定义回调参数覆盖告警策略中单独配置的请求头及请求内容。 false:优先使用告警策略中单独配置的请求头及请求内容。
*/
CallbackPrioritize?: boolean;
}
/**
* 具体的Tool Call Function调用
*/
export interface ToolCallFunction {
/**
* Function名称
*/
Name?: string;
/**
* Function参数,一般为json字符串
*/
Arguments?: string;
}
/**
* ScheduledSql的资源信息
*/
export interface ScheduledSqlResouceInfo {
/**
* 通过 [获取日志主题列表](https://cloud.tencent.com/document/product/614/56454) 获取日志主题Id。
*/
TopicId: string;
/**
* 主题的地域信息,当前不支持跨地域,支持地域参考 [地域列表](https://cloud.tencent.com/document/api/614/56474#.E5.9C.B0.E5.9F.9F.E5.88.97.E8.A1.A8) 文档。
*/
Region?: string;
/**
* 主题类型:0为日志主题,1为指标主题
*/
BizType?: number;
/**
* 指标名称。当BizType为1时,MetricName需要填写
*/
MetricName?: string;
/**
* 指标名称
BizType为1时,优先使用MetricNames字段多指标只能填充到MetricNames字段,单指标建议填充到MetricName字段
*/
MetricNames?: Array;
/**
* 指标维度,不接受时间类型。
*/
MetricLabels?: Array;
/**
* 指标时间戳,默认值为SQL查询时间范围的左侧时间点,您也可以指定其他字段(类型为uinx时间、TimeStamp,精度毫秒)为指标时间戳。
*/
CustomTime?: string;
/**
* 除了MetricLabels,您还可以使用该参数,为指标补充静态的维度。
维度名以字母或下划线开头,后面可以跟字母、数字或下划线,长度小于等于1024 字节
*/
CustomMetricLabels?: Array;
}
/**
* CreateAlarm请求参数结构体
*/
export interface CreateAlarmRequest {
/**
* 告警策略名称。最大支持255个字节。 不支持 '|'。
*/
Name: string;
/**
* 监控对象列表。
*/
AlarmTargets: Array;
/**
* 监控任务运行时间点。
*/
MonitorTime: MonitorTime;
/**
* 持续周期。持续满足触发条件TriggerCount个周期后,再进行告警;最小值为1,最大值为2000。
*/
TriggerCount: number;
/**
* 告警重复的周期,单位是分钟。取值范围是0~1440。
*/
AlarmPeriod: number;
/**
* 告警发送通知的触发条件 注意:
Condition和AlarmLevel是一组配置,MultiConditions是另一组配置,2组配置互斥。
*/
Condition?: string;
/**
* 告警级别 0:警告(Warn); 1:提醒(Info); 2:紧急 (Critical)。 注意:
不填则默认为0。 Condition和AlarmLevel是一组配置,MultiConditions是另一组配置,2组配置互斥。
*/
AlarmLevel?: number;
/**
* 多触发条件 注意:
Condition和AlarmLevel是一组配置,MultiConditions是另一组配置,2组配置互斥。
*/
MultiConditions?: Array;
/**
* 是否开启告警策略。 默认值为true
*/
Status?: boolean;
/**
* 请使用Status参数控制是否开启告警策略。
* @deprecated
*/
Enable?: boolean;
/**
* 用户自定义告警内容
*/
MessageTemplate?: string;
/**
* 用户自定义回调
*/
CallBack?: CallBackInfo;
/**
* 多维分析
*/
Analysis?: Array;
/**
* 分组触发状态。 默认值false
*/
GroupTriggerStatus?: boolean;
/**
* 分组触发条件。
*/
GroupTriggerCondition?: Array;
/**
* 标签描述列表,通过指定该参数可以同时绑定标签到相应的告警策略。
最大支持10个标签键值对,并且不能有重复的键值对。
*/
Tags?: Array;
/**
* 监控对象类型。0:执行语句共用监控对象; 1:每个执行语句单独选择监控对象。 不填则默认为0。 当值为1时,AlarmTargets元素个数不能超过10个,AlarmTargets中的Number必须是从1开始的连续正整数,不能重复。
*/
MonitorObjectType?: number;
/**
* 告警附加分类信息列表。 Classifications元素个数不能超过20个。 Classifications元素的Key不能为空,不能重复,长度不能超过50个字符,符合正则 ^[a-z]([a-z0-9_]{0,49})$。 Classifications元素的Value长度不能超过200个字符。
*/
Classifications?: Array;
/**
* 关联的日志服务告警通知渠道组列表。-通过获取通知渠道组列表 获取关联的告警通知渠道组列表,和MonitorNotice互斥
*/
AlarmNoticeIds?: Array;
/**
* 关联的可观测平台通知模板,与 AlarmNoticeIds 参数互斥,不能同时使用
*/
MonitorNotice?: MonitorNotice;
}
/**
* 数据湖计算服务(Data Lake Compute,简称DLC)数据字段配置信息
*/
export interface DlcFiledInfo {
/**
* cls日志中的字段名
*/
ClsField: string;
/**
* 数据湖计算服务表的列名
*/
DlcField: string;
/**
* 数据湖计算服务字段类型
枚举值:
*/
DlcFieldType: string;
/**
* 解析失败填充字段
*/
FillField?: string;
/**
* 是否禁用
*/
Disable?: boolean;
}
/**
* DeleteScheduledSql返回参数结构体
*/
export interface DeleteScheduledSqlResponse {
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* 升级通知
*/
export interface EscalateNoticeInfo {
/**
* 告警通知模板接收者信息。
*/
NoticeReceivers: Array;
/**
* 告警通知模板回调信息。
*/
WebCallbacks: Array;
/**
* 告警升级开关。`true`:开启告警升级、`false`:关闭告警升级,默认:false
*/
Escalate?: boolean;
/**
* 告警升级间隔。单位:分钟,范围`[1,14400]`
*/
Interval?: number;
/**
* 升级条件。`1`:无人认领且未恢复、`2`:未恢复,默认为1
- 无人认领且未恢复:告警没有恢复并且没有人认领则升级
- 未恢复:当前告警持续未恢复则升级
*/
Type?: number;
/**
* 告警升级后下一个环节的通知渠道配置,最多可配置5个环节。
*/
EscalateNotice?: EscalateNoticeInfo;
}
/**
* 黑名单path信息
*/
export interface ExcludePathInfo {
/**
* 类型,选填File或Path
*/
Type: string;
/**
* Type对应的具体内容
*/
Value: string;
}
/**
* DescribeConsumers返回参数结构体
*/
export interface DescribeConsumersResponse {
/**
* 投递规则列表
注意:此字段可能返回 null,表示取不到有效值。
*/
Consumers?: Array;
/**
* 本次查询获取到的总数
*/
TotalCount?: number;
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* 投递日志的过滤规则
*/
export interface FilterRuleInfo {
/**
* 过滤规则Key
*/
Key: string;
/**
* 过滤规则
*/
Regex: string;
/**
* 过滤规则Value
*/
Value: string;
}
/**
* DescribeEsRecharges返回参数结构体
*/
export interface DescribeEsRechargesResponse {
/**
* 总数目
*/
TotalCount?: number;
/**
* es导入配置信息
*/
Infos?: Array;
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* 高级过滤规则
*/
export interface AdvanceFilterRuleInfo {
/**
* 过滤字段
*/
Key: string;
/**
* 过滤规则,0:等于,1:字段存在,2:字段不存在
*/
Rule: number;
/**
* 过滤值
*/
Value?: string;
}
/**
* 自建k8s-容器文件路径信息
*/
export interface ContainerFileInfo {
/**
* namespace可以多个,用分隔号分割,例如A,B
*/
Namespace: string;
/**
* 容器名称
*/
Container: string;
/**
* 日志文件夹
*/
LogPath: string;
/**
* 日志名称
*/
FilePattern: string;
/**
* 日志文件信息
*/
FilePaths?: Array;
/**
* pod标签信息
注意:此字段可能返回 null,表示取不到有效值。
*/
IncludeLabels?: Array;
/**
* 工作负载信息
*/
WorkLoad?: ContainerWorkLoadInfo;
/**
* 需要排除的namespace可以多个,用分隔号分割,例如A,B
*/
ExcludeNamespace?: string;
/**
* 需要排除的pod标签信息
注意:此字段可能返回 null,表示取不到有效值。
*/
ExcludeLabels?: Array;
/**
* metadata信息
注意:此字段可能返回 null,表示取不到有效值。
*/
CustomLabels?: Array;
}
/**
* CheckRechargeKafkaServer请求参数结构体
*/
export interface CheckRechargeKafkaServerRequest {
/**
* 导入Kafka类型,0: 腾讯云CKafka;1: 用户自建Kafka。
*/
KafkaType: number;
/**
* 腾讯云CKafka实例ID。 KafkaType为0时,KafkaInstance必填
*/
KafkaInstance?: string;
/**
* 服务地址。 KafkaType为1时,ServerAddr必填
*/
ServerAddr?: string;
/**
* ServerAddr是否为加密连接,默认值false。当KafkaType为1用户自建kafka时生效。
*/
IsEncryptionAddr?: boolean;
/**
* 加密访问协议。KafkaType参数为1并且IsEncryptionAddr参数为true时必填。
*/
Protocol?: KafkaProtocolInfo;
/**
* 网络信息参数
*/
NetworkInfo?: NetworkInfo;
/**
* 用户kafka拓展信息
*/
UserKafkaMeta?: UserKafkaMeta;
}
/**
* DeleteDashboardSubscribe返回参数结构体
*/
export interface DeleteDashboardSubscribeResponse {
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* DescribeLogHistogram返回参数结构体
*/
export interface DescribeLogHistogramResponse {
/**
* 统计周期: 单位ms
*/
Interval?: number;
/**
* 命中关键字的日志总条数
*/
TotalCount?: number;
/**
* 周期内统计结果详情
*/
HistogramInfos?: Array;
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* DescribeConsumerGroups请求参数结构体
*/
export interface DescribeConsumerGroupsRequest {
/**
* 日志集Id(日志主题所属的日志集)
*/
LogsetId: string;
/**
* topic列表
*/
Topics?: Array;
}
/**
* DataSight控制台用户账号信息
*/
export interface ConsoleAccount {
/**
* 用户名
注意:此字段可能返回 null,表示取不到有效值。
*/
UserName: string;
/**
* 用户密码
注意:此字段可能返回 null,表示取不到有效值。
*/
Password: string;
/**
* 腾讯云账号SecretId
注意:此字段可能返回 null,表示取不到有效值。
*/
SecretId: string;
/**
* 腾讯云账号SecretKey
注意:此字段可能返回 null,表示取不到有效值。
*/
SecretKey: string;
/**
* 电子邮箱,用于发送验证码
注意:此字段可能返回 null,表示取不到有效值。
*/
Email?: string;
}
/**
* 数据湖计算服务(Data Lake Compute,简称DLC)数据表配置信息
*/
export interface DlcTableInfo {
/**
* 数据目录
*/
DataDirectory: string;
/**
* 数据库
*/
DatabaseName: string;
/**
* 数据表
*/
TableName: string;
}
/**
* CreateWebCallback返回参数结构体
*/
export interface CreateWebCallbackResponse {
/**
* 回调配置ID。
*/
WebCallbackId?: string;
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* DeleteConsumerGroup请求参数结构体
*/
export interface DeleteConsumerGroupRequest {
/**
* 需要删除的消费者组标识
*/
ConsumerGroup: string;
/**
* 日志集id
*/
LogsetId: string;
}
/**
* OpenKafkaConsumer请求参数结构体
*/
export interface OpenKafkaConsumerRequest {
/**
* 日志主题Id。
*/
FromTopicId: string;
/**
* 压缩方式[0:NONE;2:SNAPPY;3:LZ4],默认:0
*/
Compression?: number;
/**
* kafka协议消费数据格式
*/
ConsumerContent?: KafkaConsumerContent;
/**
* 是否开启投递服务日志。1:关闭,2:开启。 默认值:2
*/
HasServicesLog?: number;
/**
* 消费范围类型,0:最新;1:历史+最新;默认值:0
*/
ScopeType?: number;
}
/**
* CreateConsumerGroup返回参数结构体
*/
export interface CreateConsumerGroupResponse {
/**
* 消费组标识
*/
ConsumerGroup?: string;
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* DescribeResourceGraphFailureDetail请求参数结构体
*/
export interface DescribeResourceGraphFailureDetailRequest {
/**
* 资源图谱id
*/
ResourceGraphId: string;
}
/**
* Splunk投递任务信息
*/
export interface SplunkDeliverInfo {
/**
* 任务id
*/
TaskId?: string;
/**
* 任务名称
*/
Name?: string;
/**
* 用户id
*/
Uin?: number;
/**
* 日志主题id
*/
TopicId?: string;
/**
* 任务状态;1.运行中;2:暂停;3:异常
*/
Status?: number;
/**
* 启用状态;0:禁用;1:启用
*/
Enable?: number;
/**
* 创建时间;单位:秒
*/
CreateTime?: number;
/**
* 更新时间;单位:秒
*/
UpdateTime?: number;
/**
* splunk投递任务-目标配置
*/
NetInfo?: NetInfo;
/**
* splunk投递任务元信息
*/
Metadata?: MetadataInfo;
/**
* 是否启用服务日志;1:关闭;2:开启
*/
HasServiceLog?: number;
/**
* 高级配置-数据来源;
*/
Source?: string;
/**
* 高级配置-数据来源类型;
*/
SourceType?: string;
/**
* 高级配置-Splunk写入的索引
*/
Index?: string;
/**
* 高级配置-是否启用索引器;1-不开启;2-开启;
*/
IndexAck?: number;
/**
* 高级配置-通道
*/
Channel?: string;
/**
* 预过滤处理-对写入 Splunk 原始数据进行预过滤处理语句
*/
DSLFilter?: string;
/**
* 高级配置-跨账户投递参数
*/
ExternalRole?: ExternalRole;
}
/**
* 通知模板内容
*/
export interface NoticeContentInfo {
/**
* 通知内容模板标题信息。
部分通知渠道类型不支持“标题”,请参照[腾讯云控制台页面](https://console.cloud.tencent.com/cls/alarm/notice-template)。
*/
Title?: string;
/**
* 通知内容模板正文信息。
*/
Content?: string;
/**
* 请求头(Request Headers):在HTTP请求中,请求头包含了客户端向服务器发送的附加信息,如用户代理、授权凭证、期望的响应格式等。
仅“自定义回调”支持该配置。
*/
Headers?: Array;
}
/**
* ModifyMetricConfig返回参数结构体
*/
export interface ModifyMetricConfigResponse {
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* DeleteSearchView请求参数结构体
*/
export interface DeleteSearchViewRequest {
/**
* 视图ID
*/
ViewId: string;
}
/**
* SearchS3RechargeInfo请求参数结构体
*/
export interface SearchS3RechargeInfoRequest {
/**
* 日志主题Id。
*/
TopicId: string;
/**
* s3导入任务名称,最大支持128个字节。
*/
Name: string;
/**
* s3存储桶
*/
Bucket: string;
/**
* 地域
*/
S3Region: string;
/**
* 访问密钥 ID(Access Key ID)
*/
AccessKeyId: string;
/**
* 访问密钥Key(Secret Access Key)
*/
SecretAccessKey: string;
/**
* 自定义端点
*/
Endpoint?: string;
/**
* s3文件所在文件夹的前缀。默认为空,投递存储桶下所有的文件。
*/
Prefix?: string;
/**
* 压缩模式。支持: "", "gzip", "lzop", "snappy"。
默认值:不压缩
*/
Compress?: string;
}
/**
* DescribeConsumer返回参数结构体
*/
export interface DescribeConsumerResponse {
/**
* 投递任务是否生效
*/
Effective?: boolean;
/**
* 是否投递日志的元数据信息
*/
NeedContent?: boolean;
/**
* 如果需要投递元数据信息,元数据信息的描述
注意:此字段可能返回 null,表示取不到有效值。
*/
Content?: ConsumerContent;
/**
* CKafka的描述
*/
Ckafka?: Ckafka;
/**
* 压缩方式[0:NONE;2:SNAPPY;3:LZ4]
*/
Compression?: number;
/**
* 任务创建时间
*/
CreateTime?: number;
/**
* 角色访问描述名 创建角色
*/
RoleArn?: string;
/**
* 外部ID
*/
ExternalId?: string;
/**
* 任务运行状态。支持0,1,2 - 0: 停止 - 1: 运行中 - 2: 异常
*/
TaskStatus?: number;
/**
* 高级配置
*/
AdvancedConfig?: AdvancedConsumerConfiguration;
/**
* 日志预过滤-数据写入 ckafka 的原始数据进行预过滤处理
*/
DSLFilter?: string;
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* EstimateRebuildIndexTask请求参数结构体
*/
export interface EstimateRebuildIndexTaskRequest {
/**
* 日志主题ID
*/
TopicId: string;
/**
* 预估任务起始时间,毫秒
*/
StartTime: number;
/**
* 预估任务结束时间,毫秒
*/
EndTime: number;
}
/**
* Es导入时间字段信息
*/
export interface EsTimeInfo {
/**
* 时间类型 1: 日志采集时间 2: 指定日志字段
*/
Type: number;
/**
* 日志时间字段。
时间类型为 2: 指定日志字段时必填
*/
TimeKey?: string;
/**
* 日志时间格式。
时间类型为 2: 指定日志字段时必填
*/
TimeFormat?: string;
/**
* 时间字段时区。
时间类型为 2: 指定日志字段时必填
*/
TimeZone?: string;
}
/**
* DescribeClusterBaseMetricConfigs返回参数结构体
*/
export interface DescribeClusterBaseMetricConfigsResponse {
/**
* 总数目
*/
TotalCount?: number;
/**
* 指标采集配置列表
注意:此字段可能返回 null,表示取不到有效值。
*/
Datas?: Array;
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* 目标主题配置
*/
export interface TargetTopicConfig {
/**
* 目标账号类型。
枚举值:
*/
AccountType: number;
/**
* 目标地域
参数格式:ap-guangzhou
*/
Region: string;
/**
* 目标日志集id
*/
LogsetId: string;
/**
* 目标日志主题id
*/
TopicId: string;
/**
* 角色ARN
AccountType=2时必填
*/
RoleArn?: string;
/**
* 外部ID
AccountType=2时必填
*/
ExternalId?: string;
}
/**
* ModifyKafkaRecharge请求参数结构体
*/
export interface ModifyKafkaRechargeRequest {
/**
* 导入配置Id。
*/
Id: string;
/**
* 导入CLS目标TopicId。
*/
TopicId: string;
/**
* Kafka导入配置名称
*/
Name?: string;
/**
* 导入Kafka类型,0:腾讯云CKafka:1:用户自建Kafka。
*/
KafkaType?: number;
/**
* 腾讯云CKafka实例ID,KafkaType为0时必填。
*/
KafkaInstance?: string;
/**
* 服务地址,KafkaType为1时必填。
*/
ServerAddr?: string;
/**
* ServerAddr是否为加密连接,KafkaType为1时必填。
*/
IsEncryptionAddr?: boolean;
/**
* 加密访问协议,KafkaType参数为1并且IsEncryptionAddr参数为true时必填。
*/
Protocol?: KafkaProtocolInfo;
/**
* 用户需要导入的Kafka相关topic列表,多个topic之间使用半角逗号隔开。
Kafka类型为腾讯云CKafka时:通过 获取主题列表 获取TopicName。
*/
UserKafkaTopics?: string;
/**
* 用户Kafka消费组名称
*/
ConsumerGroupName?: string;
/**
* 日志导入规则
*/
LogRechargeRule?: LogRechargeRuleInfo;
/**
* 导入控制,1:暂停;2:启动。
*/
StatusControl?: number;
/**
* 私有网络信息参数
*/
NetworkInfo?: NetworkInfo;
/**
* 用户kafka拓展信息
*/
UserKafkaMeta?: UserKafkaMeta;
}
/**
* DescribeS3Recharges请求参数结构体
*/
export interface DescribeS3RechargesRequest {
/**
* 日志主题Id。
*/
TopicId: string;
/**
* name 按照【主题名称】进行过滤,默认为模糊匹配,可使用 PreciseSearch 参数设置为精确匹配。类型:String。必选:否 bucket 按照【S3 存储桶名称】进行过滤。类型:String。必选:否 status 按照【任务状态】进行过滤,支持0:已创建, 1:运行中, 2:已停止, 3:已完成, 4:运行失败。 类型:String。必选:否 enable 按照【启用状态】进行过滤,支持0:暂停,1:启用。类型:String。必选:否 注意:每次请求的 Filters 的上限为10,Filter.Values 的上限为10。
*/
Filters?: Array;
/**
* 分页的偏移量,默认值为0。
*/
Offset?: number;
/**
* 分页单页限制数目,默认值为20,最大值100。
*/
Limit?: number;
}
/**
* CreateIndex返回参数结构体
*/
export interface CreateIndexResponse {
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* ModifyDashboardSubscribe返回参数结构体
*/
export interface ModifyDashboardSubscribeResponse {
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* DescribeSplunkPreview请求参数结构体
*/
export interface DescribeSplunkPreviewRequest {
/**
* 日志主题id。- 通过获取日志主题列表 获取日志主题Id。
*/
TopicId: string;
/**
* splunk投递任务-元信息
*/
MetadataInfo: MetadataInfo;
/**
* splunk投递任务-投递 splunk过滤原始日志语句
*/
DSLFilter?: string;
}
/**
* ModifyConfig请求参数结构体
*/
export interface ModifyConfigRequest {
/**
* 采集规则配置ID,通过获取采集规则配置 返回信息获取。
*/
ConfigId: string;
/**
* 采集规则配置名称
不能包含特殊字符| 长度不能超过255字符,超过会被截断
*/
Name?: string;
/**
* 日志采集路径,包含文件名
*/
Path?: string;
/**
* 采集的日志类型。支持以下类型:
*/
LogType?: string;
/**
* 提取规则,如果设置了ExtractRule,则必须设置LogType
*/
ExtractRule?: ExtractRuleInfo;
/**
* 采集黑名单路径列表
*/
ExcludePaths?: Array;
/**
* 采集配置关联的日志主题(TopicId)
*/
Output?: string;
/**
* 用户自定义解析字符串,Json格式序列化的字符串。
*/
UserDefineRule?: string;
/**
* 高级采集配置。 Json字符串, Key/Value定义为如下:
ClsAgentFileTimeout(超时属性), 取值范围: 大于等于0的整数, 0为不超时 ClsAgentMaxDepth(最大目录深度),取值范围: 大于等于0的整数 ClsAgentParseFailMerge(合并解析失败日志),取值范围: true或false 样例:{\"ClsAgentFileTimeout\":0,\"ClsAgentMaxDepth\":10,\"ClsAgentParseFailMerge\":true}
*/
AdvancedConfig?: string;
/**
* 日志输入类型(注:windows场景必填且仅支持file和windows_event类型 )
file: 文件类型采集 windows_event:windows事件采集 syslog:系统日志采集
*/
InputType?: string;
}
/**
* CreateMetricConfig返回参数结构体
*/
export interface CreateMetricConfigResponse {
/**
* 指标采集配置id列表。
*/
ConfigIds?: Array;
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* DeleteConfigFromMachineGroup返回参数结构体
*/
export interface DeleteConfigFromMachineGroupResponse {
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* PreviewKafkaRecharge返回参数结构体
*/
export interface PreviewKafkaRechargeResponse {
/**
* 日志样例,PreviewType为2时返回
*/
LogSample?: string;
/**
* 日志预览结果
*/
LogData?: string;
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* DeleteLog返回参数结构体
*/
export interface DeleteLogResponse {
/**
* 影响日志条数
*/
AffectedRows?: number;
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* 提供多个Notice信息
*/
export interface MonitorNotice {
/**
* 以数组的形式提供MonitorNoticeRule
*/
Notices?: Array;
}
/**
* DescribeAlarms返回参数结构体
*/
export interface DescribeAlarmsResponse {
/**
* 告警策略列表。
*/
Alarms?: Array;
/**
* 符合查询条件的告警策略数目。
*/
TotalCount?: number;
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* 指标采集配置
*/
export interface MetricCollectConfig {
/**
* 采集配置id
*/
ConfigId?: string;
/**
* 日志主题id。
*/
TopicIds?: Array;
/**
* 采集配置来源。支持 :`0`、`1`
- 0:自建k8s
- 1:TKE
*/
Source?: number;
/**
* 机器组id。
*/
GroupIds?: Array;
/**
* 监控类型。支持 :`0`、`1`,不支持修改
- 0:基础监控
- 1:自定义监控,
*/
Type?: number;
/**
* 采集配置方式。支持 :`0`、`1`,不支持修改
- 0:普通配置方式,Type字段只能为:`1`
- 1:YAML导入方式,Type 可以是:`0`或者`1`
*/
Flag?: number;
/**
* 名称:长度不超过253字符,校验格式 ` [a-z0-9]([-a-z0-9]*[a-z0-9])?(\.[a-z0-9]([-a-z0-9]*[a-z0-9])?)*`。
注意:此字段可能返回 null,表示取不到有效值。
*/
Name?: string;
/**
* 采集对象, Flag=0时生效
注意:此字段可能返回 null,表示取不到有效值。
*/
Spec?: MetricSpec;
/**
* 标签处理, Flag=0时生效
注意:此字段可能返回 null,表示取不到有效值。
*/
MetricRelabels?: Array;
/**
* 自定义元数据, Flag=0时生效
注意:此字段可能返回 null,表示取不到有效值。
*/
MetricLabel?: MetricConfigLabel;
/**
* 通信协议 `http`、`https`;Flag=0时生效
注意:此字段可能返回 null,表示取不到有效值。
*/
Scheme?: string;
/**
* 采集频率, Flag=0时生效
- 校验格式:`^(((\d+)y)?((\d+)w)?((\d+)d)?((\d+)h)?((\d+)m)?((\d+)s)?((\d+)ms)?|0)$`
注意:此字段可能返回 null,表示取不到有效值。
*/
ScrapeInterval?: string;
/**
* 采集超时时间。 Flag=0 && Type=1时生效
- format:`^(((\d+)y)?((\d+)w)?((\d+)d)?((\d+)h)?((\d+)m)?((\d+)s)?((\d+)ms)?|0)$`
注意:此字段可能返回 null,表示取不到有效值。
*/
ScrapeTimeout?: string;
/**
* Prometheus如何处理标签之间的冲突。当Flag=0生效,支持`true`,`false`
- `false`:配置数据中冲突的标签重命名
- `true`:忽略冲突的服务器端标签
注意:此字段可能返回 null,表示取不到有效值。
*/
HonorLabels?: boolean;
/**
* 采集配置yaml格式字符串, Flag=1时必填
注意:此字段可能返回 null,表示取不到有效值。
*/
YamlSpec?: MetricYamlSpec;
/**
* 操作状态,0:应用,1:暂停
*/
Operate?: number;
/**
* 创建时间戳 秒级
*/
CreateTime?: number;
/**
* 更新时间戳 秒级
*/
UpdateTime?: number;
}
/**
* 返回的内容
*/
export interface Delta {
/**
* 角色
枚举值:
*/
Role?: string;
/**
* 内容详情
*/
Content?: string;
/**
* 思维链内容。 用于展示模型思考过程,仅深度思考模式可用。仅作为输出参数返回,在进行多轮对话时,无需传入输入参数中。
*/
ReasoningContent?: string;
/**
* 模型生成的工具调用。仅支持输出参数返回。 对于每一次的输出值应该以Id为标识对Type、Name、Arguments字段进行合并。
*/
ToolCalls?: Array;
}
/**
* DeleteIndex返回参数结构体
*/
export interface DeleteIndexResponse {
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* 告警多维分析一些配置信息
*/
export interface AlarmAnalysisConfig {
/**
* 键。支持以下key:
SyntaxRule:语法规则,value支持 0:Lucene语法;1: CQL语法。
QueryIndex:执行语句序号。value支持 -1:自定义; 1:执行语句1; 2:执行语句2。
CustomQuery:检索语句。 QueryIndex为-1时有效且必填,value示例: "* | select count(*) as count"。
Fields:字段。value支持 __SOURCE__;__FILENAME__;__HOSTNAME__;__TIMESTAMP__;__INDEX_STATUS__;__PKG_LOGID__;__TOPIC__。
Format:显示形式。value支持 1:每条日志一行;2:每条日志每个字段一行。
Limit:最大日志条数。 value示例: 5。
*/
Key: string;
/**
* 值。
键对应值如下:
SyntaxRule:语法规则,value支持 0:Lucene语法;1: CQL语法。
QueryIndex:执行语句序号。value支持 -1:自定义; 1:执行语句1; 2:执行语句2。
CustomQuery:检索语句。 QueryIndex为-1时有效且必填,value示例: "* | select count(*) as count"。
Fields:字段。value支持 __SOURCE__;__FILENAME__;__HOSTNAME__;__TIMESTAMP__;__INDEX_STATUS__;__PKG_LOGID__;__TOPIC__。
Format:显示形式。value支持 1:每条日志一行;2:每条日志每个字段一行。
Limit:最大日志条数。 value示例: 5。
*/
Value: string;
}
/**
* CreateRemoteWriteTask请求参数结构体
*/
export interface CreateRemoteWriteTaskRequest {
/**
* 日志主题 ID
*/
TopicId: string;
/**
* 任务名称
*/
Name: string;
/**
* 目标服务名称
*/
Target: string;
/**
* 目标地址
*/
RemoteWriteURL: string;
/**
* 鉴权类型 0: 无鉴权 1: basic_auth 2: token
*/
AuthType: number;
/**
* 网络类型: 1 内网 2外网
*/
NetType: number;
/**
* 私有网络id
*/
VpcId?: string;
/**
* 鉴权信息
*/
AuthInfo?: RemoteWriteAuthInfo;
/**
* 后端服务类型 0 CVM 1025 CLB
*/
VirtualGatewayType?: number;
/**
* 云时序数据库实例ID
*/
InstanceId?: string;
/**
* 是否开启投递服务日志。1:关闭,2:开启。 默认值:2
*/
HasServicesLog?: number;
}
/**
* 多日志主题检索错误信息
*/
export interface SearchLogErrors {
/**
* 日志主题ID
*/
TopicId?: string;
/**
* 错误信息
*/
ErrorMsg?: string;
/**
* 错误码
*/
ErrorCodeStr?: string;
}
/**
* DescribeSplunkDelivers请求参数结构体
*/
export interface DescribeSplunkDeliversRequest {
/**
* 日志主题Id
*/
TopicId: string;
/**
* taskId 按照【任务id】进行过滤。 类型:String 必选:否 name 按照【任务名称】进行过滤。 类型:String 必选:否 statusFlag 按照【状态】进行过滤。 类型:String 必选:否 每次请求的Filters的上限为10,Filter.Values的上限为10。
*/
Filters?: Array;
/**
* 分页的偏移量,默认值为0。
*/
Offset?: number;
/**
* 分页单页限制数目,默认值为20,最大值100。
*/
Limit?: number;
}
/**
* DeleteScheduledSql请求参数结构体
*/
export interface DeleteScheduledSqlRequest {
/**
* 任务ID,通过[获取定时SQL分析任务列表](https://cloud.tencent.com/document/product/614/95519)获取
*/
TaskId: string;
/**
* 源日志主题ID,通过[获取定时SQL分析任务列表](https://cloud.tencent.com/document/product/614/95519)获取
*/
SrcTopicId: string;
}
/**
* ModifyKafkaConsumer请求参数结构体
*/
export interface ModifyKafkaConsumerRequest {
/**
* 日志主题Id。
*/
FromTopicId: string;
/**
* 压缩方式。0:不压缩;2:使用Snappy压缩;3:使用LZ4压缩
*/
Compression?: number;
/**
* kafka协议消费数据格式
*/
ConsumerContent?: KafkaConsumerContent;
/**
* 是否开启投递服务日志。1:关闭,2:开启。
*/
HasServicesLog?: number;
/**
* 消费范围类型,0:最新,1:历史+最新
*/
ScopeType?: number;
}
/**
* DescribeS3Recharges返回参数结构体
*/
export interface DescribeS3RechargesResponse {
/**
* S3导入任务配置列表
*/
Infos?: Array;
/**
* 任务总数
*/
Total?: number;
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* ModifyRecordingRuleYamlTask请求参数结构体
*/
export interface ModifyRecordingRuleYamlTaskRequest {
/**
* Yaml配置id
*/
YamlID: string;
/**
* 源指标主题id
*/
TopicId: string;
/**
* 目标指标主题id
*/
DstTopicId?: string;
/**
* 任务状态; 1:开启;2:关闭
*/
EnableFlag?: number;
/**
* 调度开始时间,Unix时间戳,单位ms
*/
ProcessStartTime?: number;
/**
* 调度周期(分钟),支持范围(0,1440]分钟。
*/
ProcessPeriod?: number;
/**
* 执行延迟(秒)
*/
ProcessDelay?: number;
/**
* yaml配置名称
*/
YamlConfigName?: string;
/**
* yaml配置内容
*/
YamlContent?: string;
/**
* 是否开启投递服务日志。1:关闭,2:开启。
*/
HasServicesLog?: number;
}
/**
* DescribeConsumerGroups返回参数结构体
*/
export interface DescribeConsumerGroupsResponse {
/**
* 消费组详情列表
*/
ConsumerGroupsInfo?: Array;
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* 通知内容模板详细配置
*/
export interface NoticeContent {
/**
* 渠道类型
Email:邮件;Sms:短信;WeChat:微信;Phone:电话;WeCom:企业微信;DingTalk:钉钉;Lark:飞书;Http:自定义回调;
*/
Type: string;
/**
* 告警触发通知内容模板。
*/
TriggerContent?: NoticeContentInfo;
/**
* 告警恢复通知内容模板。
*/
RecoveryContent?: NoticeContentInfo;
}
/**
* CreateDataTransform返回参数结构体
*/
export interface CreateDataTransformResponse {
/**
* 任务id
*/
TaskId?: string;
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* 源日志主题配置
*/
export interface SourceTopicConfig {
/**
* 日志主题筛选方式。
枚举值:
*/
TopicFilterType: number;
/**
* 源日志集id
*/
LogsetId: string;
/**
* 源日志主题列表
TopicFilterType=1时必填
*/
Topics?: Array;
}
/**
* DescribeKafkaConsumerTopics请求参数结构体
*/
export type DescribeKafkaConsumerTopicsRequest = null;
/**
* CreateConfigExtra请求参数结构体
*/
export interface CreateConfigExtraRequest {
/**
* 采集配置规程名称,最长63个字符,只能包含小写字符、数字及分隔符(“-”),且必须以小写字符开头,数字或小写字符结尾
*/
Name: string;
/**
* 日志主题id
- 通过[获取日志主题列表](https://cloud.tencent.com/document/product/614/56454)获取日志主题Id。
*/
TopicId: string;
/**
* 日志源类型。支持 container_stdout:容器标准输出;container_file:容器文件路径;host_file:节点文件路径。
*/
Type: string;
/**
* 采集的日志类型,默认为minimalist_log。支持以下类型:
- json_log代表:JSON-文件日志(详见[使用 JSON 提取模式采集日志](https://cloud.tencent.com/document/product/614/17419));
- delimiter_log代表:分隔符-文件日志(详见[使用分隔符提取模式采集日志](https://cloud.tencent.com/document/product/614/17420));
- minimalist_log代表:单行全文-文件日志(详见[使用单行全文提取模式采集日志](https://cloud.tencent.com/document/product/614/17421));
- fullregex_log代表:单行完全正则-文件日志(详见[使用单行-完全正则提取模式采集日志](https://cloud.tencent.com/document/product/614/52365));
- multiline_log代表:多行全文-文件日志(详见[使用多行全文提取模式采集日志](https://cloud.tencent.com/document/product/614/17422));
- multiline_fullregex_log代表:多行完全正则-文件日志(详见[使用多行-完全正则提取模式采集日志](https://cloud.tencent.com/document/product/614/52366));
- user_define_log代表:组合解析(适用于多格式嵌套的日志,详见[使用组合解析提取模式采集日志](https://cloud.tencent.com/document/product/614/61310))。
*/
LogType: string;
/**
* 采集配置标记。
- 目前只支持label_k8s,用于标记自建k8s集群使用的采集配置
*/
ConfigFlag: string;
/**
* 日志集id
- 通过[获取日志集列表](https://cloud.tencent.com/document/api/614/58624)获取日志集Id。
*/
LogsetId: string;
/**
* 日志集名称
- 通过[获取日志集列表](https://cloud.tencent.com/document/api/614/58624)获取日志集名称。
*/
LogsetName: string;
/**
* 日志主题名称
- 通过[获取日志主题列表](https://cloud.tencent.com/document/product/614/56454)获取日志主题名称。
*/
TopicName: string;
/**
* 自建k8s-节点文件配置信息,包括文件路径、名称及元数据相关信息。
- 详细参考 [HostFileInfo](https://cloud.tencent.com/document/api/614/56471#HostFileInfo) 信息。
*/
HostFile?: HostFileInfo;
/**
* 容器文件路径类型配置。
*/
ContainerFile?: ContainerFileInfo;
/**
* 自建k8s-容器标准输出信息,包括容器、命名空间等。
- 详细参考 [ContainerStdoutInfo](https://cloud.tencent.com/document/api/614/56471#ContainerStdoutInfo) 信息。
*/
ContainerStdout?: ContainerStdoutInfo;
/**
* 日志格式化方式,用于容器采集场景。
- stdout-docker-json:用于docker容器采集场景
- stdout-containerd:用于containerd容器采集场景
* @deprecated
*/
LogFormat?: string;
/**
* 提取规则,如果设置了ExtractRule,则必须设置LogType
*/
ExtractRule?: ExtractRuleInfo;
/**
* 采集黑名单路径列表
*/
ExcludePaths?: Array;
/**
* 组合解析采集规则,用于复杂场景下的日志采集。
- 取值参考:[使用组合解析提取模式采集日志
](https://cloud.tencent.com/document/product/614/61310)
*/
UserDefineRule?: string;
/**
* 绑定的机器组ID
- 通过[获取机器组列表](https://cloud.tencent.com/document/api/614/56438)获取机器组Id。
- GroupId 与 GroupIds 选择其一即可,不可同时为空。
*/
GroupId?: string;
/**
* 绑定的机器组ID列表
- 通过[获取机器组列表](https://cloud.tencent.com/document/api/614/56438)获取机器组Id信息。
- GroupId 与 GroupIds 选择其一即可,不可同时为空。
*/
GroupIds?: Array;
/**
* 采集相关配置信息。详细参考 [CollectInfo](https://cloud.tencent.com/document/api/614/56471#CollectInfo) 信息。
*/
CollectInfos?: Array;
/**
* 高级采集配置。 Json字符串, Key/Value定义为如下:
- ClsAgentFileTimeout(超时属性), 取值范围: 大于等于0的整数, 0为不超时
- ClsAgentMaxDepth(最大目录深度),取值范围: 大于等于0的整数
- ClsAgentParseFailMerge(合并解析失败日志),取值范围: true或false
- ClsAgentDefault(自定义默认值,无特殊含义,用于清空其他选项),建议取值0
*/
AdvancedConfig?: string;
}
/**
* CreateConsumer请求参数结构体
*/
export interface CreateConsumerRequest {
/**
* 投递任务绑定的日志主题Id。
*/
TopicId: string;
/**
* 是否投递日志的元数据信息,默认为 true。 当NeedContent为true时:字段Content有效。 当NeedContent为false时:字段Content无效。
*/
NeedContent?: boolean;
/**
* 如果需要投递元数据信息,元数据信息的描述
*/
Content?: ConsumerContent;
/**
* CKafka的描述
*/
Ckafka?: Ckafka;
/**
* 投递时压缩方式,取值0,2,3。[0:NONE;2:SNAPPY;3:LZ4]
*/
Compression?: number;
/**
* 角色访问描述名 创建角色
*/
RoleArn?: string;
/**
* 外部ID
*/
ExternalId?: string;
/**
* 高级配置项
*/
AdvancedConfig?: AdvancedConsumerConfiguration;
/**
* 日志预过滤-数据写入 ckafka 的原始数据进行预过滤处理
*/
DSLFilter?: string;
}
/**
* DeleteHostMetricConfig请求参数结构体
*/
export interface DeleteHostMetricConfigRequest {
/**
* 指标日志主题id。
- 通过 [获取日志主题列表](https://cloud.tencent.com/document/product/614/56454) 获取日志主题Id。注意BizType 0:日志主题(默认值), 1:指标主题
- 通过 [创建日志主题](https://cloud.tencent.com/document/product/614/56456) 获取日志主题Id。注意BizType 0:日志主题(默认值), 1:指标主题
*/
TopicId: string;
/**
* 采集配置id。
*/
ConfigId: string;
}
/**
* DeleteMetricConfig返回参数结构体
*/
export interface DeleteMetricConfigResponse {
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* DescribeRemoteWriteTasks请求参数结构体
*/
export interface DescribeRemoteWriteTasksRequest {
/**
* - taskId
按照【任务ID】进行过滤。
类型:String
必选:否
- topicId
按照【日志主题】进行过滤。
类型:String
必选:否
- taskStatus
按照【任务运行状态】进行过滤。 支持`1`:运行中,`2`:停止,`3`:异常
类型:String
必选:否
- name
按照【任务名称】进行模糊过滤。
类型:String
必选:否
每次请求的Filters的上限为10,Filter.Values的上限为10。
*/
Filters?: Array;
/**
* 分页的偏移量,默认值为0。
*/
Offset?: number;
/**
* 分页单页限制数目,默认值为20,最大值100。
*/
Limit?: number;
}
/**
* 仪表盘信息
*/
export interface DashboardInfo {
/**
* 仪表盘id
*/
DashboardId?: string;
/**
* 仪表盘名字
*/
DashboardName?: string;
/**
* 仪表盘数据
*/
Data?: string;
/**
* 创建仪表盘的时间。格式:YYYY-MM-DD HH:MM:SS
*/
CreateTime?: string;
/**
* AssumerUin非空则表示创建该日志主题的服务方Uin
*/
AssumerUin?: number;
/**
* RoleName非空则表示创建该日志主题的服务方使用的角色
*/
RoleName?: string;
/**
* AssumerName非空则表示创建该日志主题的服务方名称
*/
AssumerName?: string;
/**
* 日志主题绑定的标签信息
*/
Tags?: Array;
/**
* 仪表盘所在地域: 为了兼容老的地域。
*/
DashboardRegion?: string;
/**
* 修改仪表盘的时间。格式:YYYY-MM-DD HH:MM:SS
*/
UpdateTime?: string;
/**
* 仪表盘对应的topic相关信息
*/
DashboardTopicInfos?: Array;
}
/**
* 数据加工任务基本详情
*/
export interface DataTransformTaskInfo {
/**
* 数据加工任务名称
*/
Name?: string;
/**
* 数据加工任务id
*/
TaskId?: string;
/**
* 任务启用状态,默认为1,正常开启, 2关闭
*/
EnableFlag?: number;
/**
* 加工任务类型,1: DSL(使用自定义加工语言的加工任务), 2:SQL(使用sql的加工任务)
*/
Type?: number;
/**
* 源日志主题
*/
SrcTopicId?: string;
/**
* 当前加工任务状态(1准备中/2运行中/3停止中/4已停止)
*/
Status?: number;
/**
* 创建时间
时间格式:yyyy-MM-dd HH:mm:ss
*/
CreateTime?: string;
/**
* 最近修改时间
时间格式:yyyy-MM-dd HH:mm:ss
*/
UpdateTime?: string;
/**
* 最后启用时间,如果需要重建集群,修改该时间
时间格式:yyyy-MM-dd HH:mm:ss
*/
LastEnableTime?: string;
/**
* 日志主题名称
*/
SrcTopicName?: string;
/**
* 日志集id
*/
LogsetId?: string;
/**
* 加工任务目的topic_id以及别名
*/
DstResources?: Array;
/**
* 加工逻辑函数。
*/
EtlContent?: string;
/**
* 兜底topic_id
*/
BackupTopicID?: string;
/**
* 超限之后是否丢弃日志数据
*/
BackupGiveUpData?: boolean;
/**
* 是否开启投递服务日志。 1关闭,2开启
*/
HasServicesLog?: number;
/**
* 任务目标日志主题数量
*/
TaskDstCount?: number;
/**
* 数据加工类型。0:标准加工任务;1:前置加工任务。
*/
DataTransformType?: number;
/**
* 保留失败日志状态。 1:不保留,2:保留
*/
KeepFailureLog?: number;
/**
* 失败日志的字段名称
*/
FailureLogKey?: string;
/**
* 指定加工数据的开始时间,秒级时间戳。
- 日志主题生命周期内的任意时间范围,如果超出了生命周期,只处理生命周期内有数据的部分。
*/
ProcessFromTimestamp?: number;
/**
* 指定加工数据的结束时间,秒级时间戳。
1. 不可指定未来的时间
2. 不填则表示持续执行
*/
ProcessToTimestamp?: number;
/**
* sql数据源信息
*/
DataTransformSqlDataSources?: Array;
/**
* 环境变量
*/
EnvInfos?: Array;
}
/**
* 通知规则
*/
export interface NoticeRule {
/**
* 匹配规则 JSON串。
**rule规则树格式为嵌套结构体JSON字符串**
`{"Value":"AND","Type":"Operation","Children":[{"Value":"OR","Type":"Operation","Children":[{"Type":"Condition","Value":"Level","Children":[{"Value":"In","Type":"Compare"},{"Value":"[1,0]","Type":"Value"}]},{"Type":"Condition","Value":"Level","Children":[{"Value":"NotIn","Type":"Compare"},{"Value":"[2]","Type":"Value"}]}]}]}`
**rule规则树限制规则如下**:
- 顶层rule中Type可取值:`Condition`,`Operation`
- Type为`Operation`的子节点支持的Type可取值:`Condition`,`Operation`
- Type为`Condition`的子节点支持的Type可取值:`String`,`Compare`,`Array`,`TimeRange`,`Value`,`Key`
- 其他Type无子节点
- 当rule Type为`Operation`时,value可取值:`AND`,`OR`
- 当rule Type为`Condition`时,value不可为空,子节点个数不能小于2
- 当子节点Type为 `Compare` 时,value可取值:`>`,`<`,`>=`,`<=`,`=`,`!=`,`Between`,`NotBetween`,`=~`,`!=~`,`In`,`NotIn`
- value为`Between`,`NotBetween`时,下一个子节点value必须是长度为2的数组
- value为`=~`,`!=~`时,下一个子节点value必须是一个正则表达式
- value为`In`,`NotIn`时, 下一个子节点value必须是一个数组
**业务参数含义**:
- Type:Condition 表示是规则条件,Value:Level 表示告警等级
- 子节点Type支持`Compare`,Value支持`In`,`NotIn`
- 下一个子节点value支持的值:0(警告),1(提醒),2 (紧急)
以下示例表示:告警等级属于提醒
`{\"Value\":\"AND\",\"Type\":\"Operation\",\"Children\":[{\"Type\":\"Condition\",\"Value\":\"Level\",\"Children\":[{\"Value\":\"In\",\"Type\":\"Compare\"},{\"Value\":\"[1]\",\"Type\":\"Value\"}]}]}`
- Type:Condition 表示是规则条件,Value:NotifyType 表示通知类型
- 子节点Type支持`Compare`,Value支持`In`,`NotIn`
- 下一个子节点value支持的值:1(告警通知),2 (恢复通知)
以下示例表示:通知类型属于告警通知或通知类型不属于恢复通知
`{\"Value\":\"AND\",\"Type\":\"Operation\",\"Children\":[{\"Value\":\"OR\",\"Type\":\"Operation\",\"Children\":[{\"Type\":\"Condition\",\"Value\":\"NotifyType\",\"Children\":[{\"Value\":\"In\",\"Type\":\"Compare\"},{\"Value\":\"[1]\",\"Type\":\"Value\"}]},{\"Type\":\"Condition\",\"Value\":\"NotifyType\",\"Children\":[{\"Value\":\"NotIn\",\"Type\":\"Compare\"},{\"Value\":\"[2]\",\"Type\":\"Value\"}]}]}]}`
- Type:Condition 表示是规则条件,Value:AlarmID 表示告警策略
- 子节点Type支持`Compare`,Value支持`In`,`NotIn`
- 下一个子节点value支持的值:告警策略id数组
以下示例表示:告警策略属于alarm-53af048c-254b-4c73-bb48-xxx,alarm-6dfa8bc5-08da-4d64-b6cb-xxx或告警策略不属于alarm-1036314c-1e49-4cee-a8fb-xxx
`"{\"Value\":\"AND\",\"Type\":\"Operation\",\"Children\":[{\"Value\":\"OR\",\"Type\":\"Operation\",\"Children\":[{\"Type\":\"Condition\",\"Value\":\"AlarmID\",\"Children\":[{\"Value\":\"In\",\"Type\":\"Compare\"},{\"Value\":\"[\\\"alarm-53af048c-254b-4c73-bb48-xxx\\\",\\\"alarm-6dfa8bc5-08da-4d64-b6cb-xxx\\\"]\",\"Type\":\"Value\"}]},{\"Type\":\"Condition\",\"Value\":\"AlarmID\",\"Children\":[{\"Value\":\"NotIn\",\"Type\":\"Compare\"},{\"Value\":\"[\\\"alarm-1036314c-1e49-4cee-a8fb-xxx\\\"]\",\"Type\":\"Value\"}]}]}]}"`
- Type:Condition 表示是规则条件,Value:AlarmName 表示告警策略名称
- 子节点Type支持`Compare`,Value支持`=~`,`!=~`
- 下一个子节点value支持的值:必须是正则表达式
以下示例表示:告警策略名称正则匹配^test$或告警策略名称正则不匹配^hahaha$
`{\"Value\":\"AND\",\"Type\":\"Operation\",\"Children\":[{\"Value\":\"OR\",\"Type\":\"Operation\",\"Children\":[{\"Type\":\"Condition\",\"Value\":\"AlarmName\",\"Children\":[{\"Value\":\"=~\",\"Type\":\"Compare\"},{\"Value\":\"^test$\",\"Type\":\"Value\"}]},{\"Type\":\"Condition\",\"Value\":\"AlarmName\",\"Children\":[{\"Value\":\"!=~\",\"Type\":\"Compare\"},{\"Value\":\"^hahaha$\",\"Type\":\"Value\"}]}]}]}`
- Type:Condition 表示是规则条件,Value:Label 表示告警分类字段
- 子节点Type支持`Compare`,Value支持`In`,`NotIn`,`=~`,`!=~`
- 下一个子节点value支持的值:`In`,`NotIn` 时value是数组,`=~`,`!=~`时value是正则表达式
以下示例表示:告警分类字段key1属于v1或告警分类字段key2不属于v2或告警分类字段key3正则匹配^test$或告警分类字段key4正则不匹配^hahaha$
`{\"Value\":\"AND\",\"Type\":\"Operation\",\"Children\":[{\"Value\":\"OR\",\"Type\":\"Operation\",\"Children\":[{\"Type\":\"Condition\",\"Value\":\"Label\",\"Children\":[{\"Value\":\"key1\",\"Type\":\"Key\"},{\"Value\":\"In\",\"Type\":\"Compare\"},{\"Value\":\"[\\\"v1\\\"]\",\"Type\":\"Value\"}]},{\"Type\":\"Condition\",\"Value\":\"Label\",\"Children\":[{\"Value\":\"key2\",\"Type\":\"Key\"},{\"Value\":\"NotIn\",\"Type\":\"Compare\"},{\"Value\":\"[\\\"v2\\\"]\",\"Type\":\"Value\"}]},{\"Type\":\"Condition\",\"Value\":\"Label\",\"Children\":[{\"Value\":\"key3\",\"Type\":\"Key\"},{\"Value\":\"=~\",\"Type\":\"Compare\"},{\"Value\":\"^test$\",\"Type\":\"Value\"}]},{\"Type\":\"Condition\",\"Value\":\"Label\",\"Children\":[{\"Value\":\"key4\",\"Type\":\"Key\"},{\"Value\":\"!=~\",\"Type\":\"Compare\"},{\"Value\":\"^hahaha$\",\"Type\":\"Value\"}]}]}]}`
- Type:Condition 表示是规则条件,Value:NotifyTime 表示通知时间
- 子节点Type支持`Compare`,Value支持`Between `,`NotBetween `
- 下一个子节点value支持的值:长度为2,格式为`14:20:36`的字符串数组
以下示例表示:通知时间在指定范围内14:18:36至14:33:36或通知时间不在指定范围内14:20:36至14:30:36
`{\"Value\":\"AND\",\"Type\":\"Operation\",\"Children\":[{\"Value\":\"OR\",\"Type\":\"Operation\",\"Children\":[{\"Type\":\"Condition\",\"Value\":\"NotifyTime\",\"Children\":[{\"Value\":\"Between\",\"Type\":\"Compare\"},{\"Value\":\"[\\\"14:18:36\\\",\\\"14:33:36\\\"]\",\"Type\":\"Value\"}]},{\"Type\":\"Condition\",\"Value\":\"NotifyTime\",\"Children\":[{\"Value\":\"NotBetween\",\"Type\":\"Compare\"},{\"Value\":\"[\\\"14:20:36\\\",\\\"14:30:36\\\"]\",\"Type\":\"Value\"}]}]}]}`
- Type:Condition 表示是规则条件,Value:Duration 表示告警持续时间
- 子节点Type支持`Compare`,Value支持`>`,`<`,`>=`,`<=`
- 下一个子节点value支持的值:整型值单位分钟
以下示例表示:告警持续时间大于1分钟或告警持续时间大于等于2分钟或告警持续时间小于3分钟或告警持续时间小于等于4分钟
`{\"Value\":\"AND\",\"Type\":\"Operation\",\"Children\":[{\"Value\":\"OR\",\"Type\":\"Operation\",\"Children\":[{\"Type\":\"Condition\",\"Value\":\"Duration\",\"Children\":[{\"Value\":\">\",\"Type\":\"Compare\"},{\"Value\":1,\"Type\":\"Value\"}]},{\"Type\":\"Condition\",\"Value\":\"Duration\",\"Children\":[{\"Value\":\">=\",\"Type\":\"Compare\"},{\"Value\":2,\"Type\":\"Value\"}]},{\"Type\":\"Condition\",\"Value\":\"Duration\",\"Children\":[{\"Value\":\"<\",\"Type\":\"Compare\"},{\"Value\":3,\"Type\":\"Value\"}]},{\"Type\":\"Condition\",\"Value\":\"Duration\",\"Children\":[{\"Value\":\"<=\",\"Type\":\"Compare\"},{\"Value\":4,\"Type\":\"Value\"}]}]}]}`
*/
Rule?: string;
/**
* 告警通知接收者信息。
*/
NoticeReceivers?: Array;
/**
* 告警通知模板回调信息,包括企业微信、钉钉、飞书。
*/
WebCallbacks?: Array;
/**
* 告警升级开关。`true`:开启告警升级、`false`:关闭告警升级,默认:false
*/
Escalate?: boolean;
/**
* 告警升级条件。`1`:无人认领且未恢复、`2`:未恢复,默认为1
- 无人认领且未恢复:告警没有恢复并且没有人认领则升级
- 未恢复:当前告警持续未恢复则升级
*/
Type?: number;
/**
* 告警升级间隔。单位:分钟,范围`[1,14400]`
*/
Interval?: number;
/**
* 告警升级后下一个环节的通知渠道配置
*/
EscalateNotice?: EscalateNoticeInfo;
}
/**
* 投递日志的内容格式配置
*/
export interface ContentInfo {
/**
* 内容格式,支持json,csv,parquet
*/
Format: string;
/**
* csv格式内容描述
注意:此字段可能返回 null,表示取不到有效值。
*/
Csv?: CsvInfo;
/**
* json格式内容描述
注意:此字段可能返回 null,表示取不到有效值。
*/
Json?: JsonInfo;
/**
* parquet格式内容描述
注意:此字段可能返回 null,表示取不到有效值。
*/
Parquet?: ParquetInfo;
}
/**
* ApplyConfigToMachineGroup返回参数结构体
*/
export interface ApplyConfigToMachineGroupResponse {
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* 告警通知渠道组详情
*/
export interface AlertHistoryNotice {
/**
* 通知渠道组名称
*/
Name: string;
/**
* 通知渠道组ID
*/
AlarmNoticeId: string;
}
/**
* DeleteAlarm请求参数结构体
*/
export interface DeleteAlarmRequest {
/**
* 告警策略ID。
*/
AlarmId: string;
}
/**
* 跨账号投递任务信息
*/
export interface CLSDeliverTaskInfo {
/**
* 任务id
*/
TaskId?: string;
/**
* 任务名称
*/
TaskName?: string;
/**
* 主账号id
*/
Uin?: number;
/**
* 源主题信息
*/
SourceTopicConfig?: SourceTopicConfig;
/**
* 目标主题信息
*/
TargetTopicConfig?: TargetTopicConfig;
/**
* 投递规则
*/
DeliverRule?: DeliverRule;
/**
* 合规承诺
*/
Compliance?: number;
/**
* 任务状态。
枚举值:
*/
Status?: number;
/**
* 状态
枚举值:
*/
Enable?: number;
/**
* 任务进度百分比
*/
Progress?: number;
/**
* 是否开启投递服务日志。
枚举值:
*/
HasServicesLog?: number;
/**
* 创建时间。
单位:秒级时间戳
*/
CreateTime?: number;
/**
* 更新时间
单位:秒级时间戳
*/
UpdateTime?: number;
}
/**
* DescribeLogContext返回参数结构体
*/
export interface DescribeLogContextResponse {
/**
* 日志上下文信息集合
*/
LogContextInfos?: Array;
/**
* 上文日志是否已经返回完成(当PrevOver为false,表示有上文日志还未全部返回)。
*/
PrevOver?: boolean;
/**
* 下文日志是否已经返回完成(当NextOver为false,表示有下文日志还未全部返回)。
*/
NextOver?: boolean;
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* ModifyConsoleSharing返回参数结构体
*/
export interface ModifyConsoleSharingResponse {
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* EstimateRebuildIndexTask返回参数结构体
*/
export interface EstimateRebuildIndexTaskResponse {
/**
* 预估索引重建需要时间,单位秒
*/
RemainTime?: number;
/**
* 预估写流量大小,单位MB
*/
WriteTraffic?: number;
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* 采集日志配置信息
*/
export interface LogConfigInfo {
/**
* 日志主题ID
*/
TopicId?: string;
/**
* 日志集ID
*/
LogsetId?: string;
/**
* 采集日志路径列表
*/
Path?: string;
/**
* 日志类型
*/
LogType?: string;
/**
* 提取规则
*/
ExtractRule?: ExtractRuleInfo;
/**
* 日志格式化格式
注意:此字段可能返回 null,表示取不到有效值。
*/
LogFormat?: string;
/**
* 黑名单path列表
注意:此字段可能返回 null,表示取不到有效值。
*/
ExcludePaths?: Array;
/**
* 用户自定义解析字符串
注意:此字段可能返回 null,表示取不到有效值。
*/
UserDefineRule?: string;
/**
* 采集配置ID
注意:此字段可能返回 null,表示取不到有效值。
*/
ConfigId?: string;
/**
* 使用了元数据的机器组ID列表
注意:此字段可能返回 null,表示取不到有效值。
*/
GroupIds?: Array;
}
/**
* DeleteDashboard请求参数结构体
*/
export interface DeleteDashboardRequest {
/**
* 仪表盘id
*/
DashboardId: string;
}
/**
* CreateCosRecharge返回参数结构体
*/
export interface CreateCosRechargeResponse {
/**
* COS导入任务id
*/
Id?: string;
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* AI 分析的数据范围。DataScopeType值是CLSLogTopic。DataScopeEntry是数组结构,TopicId类型和Region类型是必填。实例: [{"Key":"TopicId",Value:"work-topic"},{"Key":"Region",Value:"ap-guangzhou"}]
*/
export interface AIAnalysisDataScope {
/**
* 告警AI诊断时查询的数据范围(查询哪些日志主题)
*/
DataScopeEntry?: Array;
/**
* 告警AI诊断的数据范围类型
枚举值:
默认值:CLSLogTopic
*/
DataScopeType?: string;
}
/**
* 告警通知接收者信息
*/
export interface NoticeReceiver {
/**
* 接受者类型。可选值:
- Uin - 用户ID
- Group - 用户组ID
暂不支持其余接收者类型。
*/
ReceiverType: string;
/**
* 接收者。
当ReceiverType为Uin时,ReceiverIds的值为用户uid。[子用户信息查询](https://cloud.tencent.com/document/api/598/53486)
当ReceiverType为Group时,ReceiverIds的值为用户组id。[CAM用户组](https://cloud.tencent.com/document/product/598/34589)
*/
ReceiverIds: Array;
/**
* 通知接收渠道。
- Email - 邮件
- Sms - 短信
- WeChat - 微信
- Phone - 电话
*/
ReceiverChannels: Array;
/**
* 通知内容模板ID,使用Default-zh引用默认模板(中文),使用Default-en引用DefaultTemplate(English)。-通过[获取通知内容模板](https://cloud.tencent.com/document/product/614/111714)获取通知内容模板ID
*/
NoticeContentId?: string;
/**
* 允许接收信息的开始时间。格式:`15:04:05`。必填
*/
StartTime?: string;
/**
* 允许接收信息的结束时间。格式:`15:04:05`。必填
*/
EndTime?: string;
/**
* 位序。
- 入参时无效。
- 出参时有效。
*/
Index?: number;
}
/**
* CKafka的描述-需要投递到的kafka信息
*/
export interface Ckafka {
/**
* Ckafka 的 InstanceId。
- 通过 [获取实例列表信息](https://cloud.tencent.com/document/product/597/40835) 获取实例id。
- 通过 [创建实例](https://cloud.tencent.com/document/product/597/53207) 获取实例id。
*/
InstanceId: string;
/**
* Ckafka 的 TopicName。
- 通过 [创建 Topic](https://cloud.tencent.com/document/product/597/73566) 获得TopicName。
- 通过 [获取主题列表](https://cloud.tencent.com/document/product/597/40847) 获得TopicName。
*/
TopicName: string;
/**
* Ckafka 的 Vip。
- 通过 [获取实例属性 ](https://cloud.tencent.com/document/product/597/40836) 获取vip信息。
- 如果是通过 角色ARN 方式创建投递任务,则Vip字段可为空。
*/
Vip?: string;
/**
* Ckafka 的 Vport。
- 通过 [获取实例属性 ](https://cloud.tencent.com/document/product/597/40836) 获取vip port信息。
- 如果是通过 角色ARN 方式创建投递任务,则Vport字段可为空。
*/
Vport?: string;
/**
* Ckafka 的 InstanceName。
- 通过 [获取实例列表信息](https://cloud.tencent.com/document/product/597/40835) 获取InstanceName。
- 通过 [创建实例](https://cloud.tencent.com/document/product/597/53207) 获取InstanceName。
- 如果是通过 角色ARN 方式创建投递任务,则InstanceName字段可为空。
*/
InstanceName?: string;
/**
* Ckafka 的 TopicId。
- 通过 [创建 Topic](https://cloud.tencent.com/document/product/597/73566) 获得TopicId。
- 通过 [获取主题列表](https://cloud.tencent.com/document/product/597/40847) 获得TopicId。
- 如果是通过 角色ARN 方式创建投递任务,则TopicId字段可为空。
*/
TopicId?: string;
}
/**
* 多触发条件。
*/
export interface MultiCondition {
/**
* 触发条件。
*/
Condition?: string;
/**
* 告警级别。0:警告(Warn); 1:提醒(Info); 2:紧急 (Critical)。
- 不填则默认为0。
*/
AlarmLevel?: number;
}
/**
* 过滤器
*/
export interface Filter {
/**
* 需要过滤的字段。
*/
Key: string;
/**
* 需要过滤的值。
*/
Values: Array;
}
/**
* 查询视图信息
*/
export interface SearchViewInfo {
/**
* 视图ID
*/
ViewId?: string;
/**
* 视图名称
*/
ViewName?: string;
/**
* 视图类型
枚举值:
*/
ViewType?: string;
/**
* 日志集id
视图所属日志集
*/
LogsetId?: string;
/**
* 日志集所属地域
参数格式:ap-guangzhou
*/
LogsetRegion?: string;
/**
* 视图日志主题信息
*/
Topics?: Array;
/**
* 视图描述
*/
Description?: string;
/**
* 创建时间
单位:秒级别时间戳
*/
CreateTime?: number;
/**
* 更新时间
单位:秒级别时间戳
*/
UpdateTime?: number;
}
/**
* RemoteWrite配置信息
*/
export interface RemoteWriteInfo {
/**
* 任务id
注意:此字段可能返回 null,表示取不到有效值。
*/
TaskId?: string;
/**
* 日志主题ID
注意:此字段可能返回 null,表示取不到有效值。
*/
TopicId?: string;
/**
* Remote Write任务名称
注意:此字段可能返回 null,表示取不到有效值。
*/
Name?: string;
/**
* 网络类型 1: 内网 2:外网
注意:此字段可能返回 null,表示取不到有效值。
*/
NetType?: number;
/**
* 私有网络id
注意:此字段可能返回 null,表示取不到有效值。
*/
VpcId?: string;
/**
* 任务运行状态 1: 运行中 2:暂停 3: 失败
注意:此字段可能返回 null,表示取不到有效值。
*/
Status?: number;
/**
* 创建时间
注意:此字段可能返回 null,表示取不到有效值。
*/
CreateTime?: string;
/**
* 更新时间
注意:此字段可能返回 null,表示取不到有效值。
*/
UpdateTime?: string;
/**
* 目标服务名称
注意:此字段可能返回 null,表示取不到有效值。
*/
Target?: string;
/**
* 目标地址
注意:此字段可能返回 null,表示取不到有效值。
*/
RemoteWriteURL?: string;
/**
* 鉴权类型 0: 无鉴权 1: basic_auth 2: token
注意:此字段可能返回 null,表示取不到有效值。
*/
AuthType?: number;
/**
* 鉴权信息
注意:此字段可能返回 null,表示取不到有效值。
*/
AuthInfo?: RemoteWriteAuthInfo;
/**
* 日志集
注意:此字段可能返回 null,表示取不到有效值。
*/
LogsetId?: string;
/**
* 任务状态
注意:此字段可能返回 null,表示取不到有效值。
*/
Enable?: number;
/**
* 后端服务类型
注意:此字段可能返回 null,表示取不到有效值。
*/
VirtualGatewayType?: number;
/**
* 云时序数据库实例ID
注意:此字段可能返回 null,表示取不到有效值。
*/
InstanceId?: string;
/**
* 是否开启投递服务日志。1:关闭,2:开启。
注意:此字段可能返回 null,表示取不到有效值。
*/
HasServicesLog?: number;
}
/**
* ModifyLogset返回参数结构体
*/
export interface ModifyLogsetResponse {
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* dlc投递失败处理信息
*/
export interface DlcFailHandle {
/**
* 是否存储到DLC
默认值:false
用于控制是否开启投递失败的日志存储至DLC表
*/
StoreToDlc?: boolean;
/**
* DLC表信息
*/
DlcFailTableInfo?: DlcFailTableInfo;
}
/**
* 采集配置信息
*/
export interface CollectConfig {
/**
* 指定采集类型的采集配置名称信息。
当CollectInfo中Type为0:表示元数据配置,name为元数据名称。
目前支持"container_id","container_name","image_name","namespace","pod_uid","pod_name","pod_ip"。
当CollectInfo中Type为1:指定pod label,name为指定pod label名称。
*/
Name: string;
}
/**
* CreateDashboard返回参数结构体
*/
export interface CreateDashboardResponse {
/**
* 仪表盘id
*/
DashboardId?: string;
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* GetMetricLabelValues请求参数结构体
*/
export interface GetMetricLabelValuesRequest {
/**
* 时序主题id
*/
TopicId: string;
/**
* 时序label名称
*/
LabelName: string;
/**
* 起始时间
*/
Start?: number;
/**
* 结束时间
*/
End?: number;
/**
* Label匹配规则
*/
Match?: Array;
}
/**
* ModifyMetricSubscribe返回参数结构体
*/
export interface ModifyMetricSubscribeResponse {
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* DescribeIndex返回参数结构体
*/
export interface DescribeIndexResponse {
/**
* 日志主题Id
*/
TopicId?: string;
/**
* 索引状态。true:开启状态,false:关闭状态 开启后可对日志进行检索分析,将产生索引流量、索引存储及相应费用。费用详情
*/
Status?: boolean;
/**
* 索引配置信息
注意:此字段可能返回 null,表示取不到有效值。
*/
Rule?: RuleInfo;
/**
* 索引修改时间,初始值为索引创建时间。格式 YYYY-MM-DD HH:MM:SS
*/
ModifyTime?: string;
/**
* 内置保留字段(__FILENAME__,__HOSTNAME__及__SOURCE__)是否包含至全文索引
*/
IncludeInternalFields?: boolean;
/**
* 元数据字段(前缀为__TAG__的字段)是否包含至全文索引
0:仅包含开启键值索引的元数据字段 1:包含所有元数据字段 2:不包含任何元数据字段
*/
MetadataFlag?: number;
/**
* 自定义日志解析异常存储字段。
*/
CoverageField?: string;
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* DescribeConsumerPreview返回参数结构体
*/
export interface DescribeConsumerPreviewResponse {
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* DeleteRecordingRuleTask返回参数结构体
*/
export interface DeleteRecordingRuleTaskResponse {
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* DeleteMachineGroupInfo返回参数结构体
*/
export interface DeleteMachineGroupInfoResponse {
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* CheckRechargeKafkaServer返回参数结构体
*/
export interface CheckRechargeKafkaServerResponse {
/**
* Kafka集群可访问状态。
0:可正常访问 -1:broker 连接失败 -2:sasl 鉴权失败 -3:ckafka 角色未授权 -4:topic 列表不存在 -5:topic 内暂无数据 -6:用户没有 ckafka 权限 -7:消费组已经存在 -8:kafka 实例不存在或已销毁 -9:Broker 列表为空 -10:Broker 地址格式不正确 -11:Broker 端口非整型
*/
Status?: number;
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* 实例配置信息
*/
export interface InstanceConfig {
/**
* 实例维度
*/
InstanceDimension: Array;
/**
* 实例值
*/
Instances: Array;
}
/**
* DeleteNetworkApplication返回参数结构体
*/
export interface DeleteNetworkApplicationResponse {
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* cos导入配置信息
*/
export interface CosRechargeInfo {
/**
* COS导入配置ID
*/
Id?: string;
/**
* 日志主题ID
*/
TopicId?: string;
/**
* 日志集ID
*/
LogsetId?: string;
/**
* COS导入任务名称
*/
Name?: string;
/**
* COS存储桶
*/
Bucket?: string;
/**
* COS存储桶所在地域。
- 通过[地域和访问域名](https://cloud.tencent.com/document/product/436/6224)获取地域信息。
*/
BucketRegion?: string;
/**
* COS文件所在文件夹的前缀
*/
Prefix?: string;
/**
* 采集的日志类型,json_log代表json格式日志,delimiter_log代表分隔符格式日志,minimalist_log代表单行全文;
默认为minimalist_log
*/
LogType?: string;
/**
* 状态 status 0: 已创建, 1: 运行中, 2: 已停止, 3: 已完成, 4: 运行失败。
*/
Status?: number;
/**
* 是否启用: 0: 未启用 , 1:启用
*/
Enable?: number;
/**
* 创建时间。时间格式:YYYY-MM-DD HH:mm:ss
*/
CreateTime?: string;
/**
* 更新时间。时间格式:YYYY-MM-DD HH:mm:ss
*/
UpdateTime?: string;
/**
* 进度条百分值
*/
Progress?: number;
/**
* 压缩方式supported: "", "gzip", "lzop", "snappy”; 默认空不压缩
*/
Compress?: string;
/**
* 见: ExtractRuleInfo 结构描述
*/
ExtractRuleInfo?: ExtractRuleInfo;
/**
* COS导入任务类型。1:一次性导入任务;2:持续性导入任务。
*/
TaskType?: number;
/**
* 元数据。支持 bucket,object。
*/
Metadata?: Array;
}
/**
* DeleteNoticeContent请求参数结构体
*/
export interface DeleteNoticeContentRequest {
/**
* 通知内容模板ID。-通过[获取通知内容模板](https://cloud.tencent.com/document/api/614/111714)获取通知内容模版ID
*/
NoticeContentId: string;
}
/**
* DescribeKafkaConsumer请求参数结构体
*/
export interface DescribeKafkaConsumerRequest {
/**
* 日志主题Id。
*/
FromTopicId: string;
}
/**
* DeleteRecordingRuleTask请求参数结构体
*/
export interface DeleteRecordingRuleTaskRequest {
/**
* 任务ID
*/
TaskId: string;
/**
* 源指标主题id
*/
TopicId: string;
}
/**
* DescribeDataTransformInfo返回参数结构体
*/
export interface DescribeDataTransformInfoResponse {
/**
* 数据加工任务列表信息
*/
DataTransformTaskInfos?: Array;
/**
* 任务总次数
*/
TotalCount?: number;
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* ModifyCosRecharge返回参数结构体
*/
export interface ModifyCosRechargeResponse {
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* 跨账户投递外部角色
*/
export interface ExternalRole {
/**
* 跨账户投递-用户角色RoleArn
*/
RoleArn: string;
/**
* 跨账户投递-用户角色名称
*/
ExternalId: string;
}
/**
* DescribeEsRechargePreview请求参数结构体
*/
export interface DescribeEsRechargePreviewRequest {
/**
* 名称:长度不超过64字符。
*/
Name: string;
/**
* 日志主题id。
- 通过 [获取日志主题列表](https://cloud.tencent.com/document/product/614/56454) 获取日志主题Id。
- 通过 [创建日志主题](https://cloud.tencent.com/document/product/614/56456) 获取日志主题Id。
*/
TopicId: string;
/**
* 索引信息。不同索引可以通过英文逗号分隔,支持*通配符
*/
Index: string;
/**
* es查询语句。
*/
Query: string;
/**
* es集群配置信息。
*/
EsInfo: EsInfo;
/**
* es导入信息。
*/
ImportInfo: EsImportInfo;
/**
* es导入时间字段信息。
*/
TimeInfo: EsTimeInfo;
}
/**
* MergePartition返回参数结构体
*/
export interface MergePartitionResponse {
/**
* 合并结果集
*/
Partitions?: Array;
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* CreateScheduledSql请求参数结构体
*/
export interface CreateScheduledSqlRequest {
/**
* 源日志主题ID- 通过获取日志主题列表 获取日志主题Id。
*/
SrcTopicId: string;
/**
* 任务名称,0~255字符
*/
Name: string;
/**
* 任务启动状态. 1开启, 2关闭
*/
EnableFlag: number;
/**
* 定时SQL分析目标日志主题
*/
DstResource: ScheduledSqlResouceInfo;
/**
* 查询语句
*/
ScheduledSqlContent: string;
/**
* 调度开始时间,Unix时间戳,单位ms
*/
ProcessStartTime: number;
/**
* 调度类型,1:持续运行 2:指定时间范围
*/
ProcessType: number;
/**
* 调度周期(分钟),1~1440分钟
*/
ProcessPeriod: number;
/**
* 单次查询的时间窗口,如果您的目标主题为指标主题,建议该参数的大小不超过30分钟,否则可能转指标失败。
*/
ProcessTimeWindow: string;
/**
* 执行延迟(秒),0~120秒,默认60秒
*/
ProcessDelay: number;
/**
* 源topicId的地域信息,支持地域见 地域列表 文档
*/
SrcTopicRegion: string;
/**
* 调度时间单位
取值范围:[1, 2]
默认值:1
默认值为1(分钟),其他值2(秒)
*/
ProcessPeriodUnit?: number;
/**
* 调度结束时间,当ProcessType=2时为必传字段, Unix时间戳,单位ms
*/
ProcessEndTime?: number;
/**
* 查询语法规则。 默认值为0。0:Lucene语法,1:CQL语法
*/
SyntaxRule?: number;
/**
* 是否开启投递服务日志。1:关闭,2:开启。
*/
HasServicesLog?: number;
/**
* 全文检索标记。1:关闭,2:打开。默认:1
*/
FullQuery?: number;
}
/**
* DescribeKafkaConsumerGroupDetail返回参数结构体
*/
export interface DescribeKafkaConsumerGroupDetailResponse {
/**
* 日志集id
*/
LogsetId?: string;
/**
* 消费组名称
*/
Group?: string;
/**
* 消费组信息列表
*/
PartitionInfos?: Array;
/**
* Empty:组内没有成员,但存在已提交的偏移量。所有消费者都离开但保留了偏移量
Dead:组内没有成员,且没有已提交的偏移量。组被删除或长时间无活动
Stable:组内成员正常消费,分区分配平衡。正常运行状态
PreparingRebalance:组正在准备重新平衡。有新成员加入或现有成员离开
CompletingRebalance:组正在准备重新平衡。有新成员加入或现有成员离开
*/
State?: string;
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* ModifyDashboard请求参数结构体
*/
export interface ModifyDashboardRequest {
/**
* 仪表盘id。通过 [获取仪表盘](https://cloud.tencent.com/document/api/614/95636)接口获取DashboardId。
*/
DashboardId: string;
/**
* 仪表盘名称
*/
DashboardName?: string;
/**
* 仪表盘配置数据
*/
Data?: string;
/**
* 标签描述列表,通过指定该参数可以同时绑定标签到相应的日志主题。最大支持10个标签键值对,同一个资源只能绑定到同一个标签键下。
*/
Tags?: Array;
}
/**
* SendConsumerHeartbeat返回参数结构体
*/
export interface SendConsumerHeartbeatResponse {
/**
* 日志主题对应的消费组标识
*/
ConsumerGroup?: string;
/**
* 分区信息
*/
TopicPartitionsInfo?: Array;
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* DeleteHostMetricConfig返回参数结构体
*/
export interface DeleteHostMetricConfigResponse {
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* es导入配置信息
*/
export interface EsRechargeInfo {
/**
* 任务id。
*/
TaskId?: string;
/**
* 主账号id。
*/
Uin?: number;
/**
* 日志主题id。
- 通过 [获取日志主题列表](https://cloud.tencent.com/document/product/614/56454) 获取日志主题Id。
- 通过 [创建日志主题](https://cloud.tencent.com/document/product/614/56456) 获取日志主题Id。
*/
TopicId?: string;
/**
* 配置名称。
*/
Name?: string;
/**
* es索引。
*/
Index?: string;
/**
* es查询语句。
*/
Query?: string;
/**
* es集群信息。
*/
EsInfo?: EsInfo;
/**
* es导入信息。
*/
ImportInfo?: EsImportInfo;
/**
* es导入时间配置信息。
*/
TimeInfo?: EsTimeInfo;
/**
* 任务状态。
1. 运行中
2. 暂停
3. 完成
4. 异常
*/
Status?: number;
/**
* 任务进度 0~100 百分比。100:表示完成。
*/
Progress?: number;
/**
* 子账号id。
*/
SubUin?: number;
/**
* 创建时间。
*/
CreateTime?: number;
/**
* 修改时间。
*/
UpdateTime?: number;
/**
* 是否开启投递服务日志。1:关闭,2:开启。
*/
HasServicesLog?: number;
}
/**
* GetClsService返回参数结构体
*/
export interface GetClsServiceResponse {
/**
* 账户服务开通状态,0:服务已开通,1:服务未开通
*/
Status?: number;
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* DescribeAgentApplications返回参数结构体
*/
export interface DescribeAgentApplicationsResponse {
/**
* 符合查询条件的大模型性能剖析任务列表
*/
Infos?: Array;
/**
* 符合查询条件的任务总数。
*/
Total?: number;
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* 返回的回复, 支持多个
*/
export interface Choice {
/**
* 结束标志位,可能为 stop、 sensitive或者tool_calls。 stop 表示输出正常结束。 sensitive 表示安全审核未通过。 tool_calls 标识函数调用。
注意: 可能会出现部分内容已输出,但中间某一段响应中的 FinishReason 值为 sensitive,此时说明安全审核未通过。如果业务场景有实时文字上屏的需求,需要自行撤回已上屏的内容,并建议自定义替换为一条提示语,如 “这个问题我不方便回答,不如我们换个话题试试”,以保障终端体验。
*/
FinishReason?: string;
/**
* 增量返回值,流式调用时使用该字段。
*/
Delta?: Delta;
/**
* 返回值,非流式调用时使用该字段。
*/
Message?: Message;
/**
* 索引值,流式调用时使用该字段。
*/
Index?: number;
}
/**
* RetryResourceGraph返回参数结构体
*/
export interface RetryResourceGraphResponse {
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* DeleteMetricConfig请求参数结构体
*/
export interface DeleteMetricConfigRequest {
/**
* 指标日志主题id。
- 通过 [获取日志主题列表](https://cloud.tencent.com/document/product/614/56454) 获取日志主题Id。注意BizType 0:日志主题(默认值), 1:指标主题
- 通过 [创建日志主题](https://cloud.tencent.com/document/product/614/56456) 获取日志主题Id。注意BizType 0:日志主题(默认值), 1:指标主题
*/
TopicId: string;
/**
* 指标采集配置id。
*/
ConfigId: string;
}
/**
* CreateEsRecharge请求参数结构体
*/
export interface CreateEsRechargeRequest {
/**
* 日志主题id。
- 通过 [获取日志主题列表](https://cloud.tencent.com/document/product/614/56454) 获取日志主题Id。
- 通过 [创建日志主题](https://cloud.tencent.com/document/product/614/56456) 获取日志主题Id。
*/
TopicId: string;
/**
* 名称:长度不超过64字符。
*/
Name: string;
/**
* 索引信息。不同索引可以通过英文逗号分隔,支持*通配符
*/
Index: string;
/**
* es查询语句。
*/
Query: string;
/**
* es集群配置信息。
*/
EsInfo: EsInfo;
/**
* es导入信息。
*/
ImportInfo: EsImportInfo;
/**
* es导入时间字段信息。
*/
TimeInfo: EsTimeInfo;
/**
* 是否开启投递服务日志。1:关闭,2:开启。默认开启。
*/
HasServicesLog?: number;
}
/**
* kafka协议消费组信息
*/
export interface ConsumerGroup {
/**
* 消费组名称
*/
Group?: string;
/**
* 状态。
- Empty:组内没有成员,但存在已提交的偏移量。所有消费者都离开但保留了偏移量
- Dead:组内没有成员,且没有已提交的偏移量。组被删除或长时间无活动
- Stable:组内成员正常消费,分区分配平衡。正常运行状态
- PreparingRebalance:组正在准备重新平衡。有新成员加入或现有成员离开
- CompletingRebalance:组正在准备重新平衡。有新成员加入或现有成员离开
*/
State?: string;
/**
* 分区分配策略均衡算法名称。
- 常见均衡算法如下:
- range:按分区范围分配
- roundrobin:轮询式分配
- sticky:粘性分配(避免不必要的重平衡)
*/
ProtocolName?: string;
}
/**
* 控制台分享配置
*/
export interface ConsoleSharingConfig {
/**
* 分享链接名称
*/
Name: string;
/**
* 仪表盘: 1; 检索页:2
*/
Type: number;
/**
* 分享链接有效期,单位:毫秒,最长支持30天
*/
DurationMilliseconds: number;
/**
* 允许访问的资源列表,目前仅支持一个Resource
*/
Resources: Array;
/**
* 分享链接域名,可选范围
- 公网匿名分享:填写clsshare.com
- datasight内网匿名分享(若开启):datasight内网域名
注意:此字段可能返回 null,表示取不到有效值。
*/
Domain?: string;
/**
* 分享链接加密访问验证码。支持0-9和a-z(不区分大小写)在内的6个字符,可为空,代表免验证码访问
注意:此字段可能返回 null,表示取不到有效值。
*/
VerifyCode?: string;
/**
* 默认查询范围的开始时间点,支持绝对时间(13位Unix时间戳)或相对时间表达式
*/
StartTime?: string;
/**
* 默认查询范围的结束时间点,支持绝对时间(13位Unix时间戳)或相对时间表达式。注意,结束时间点要大于开始时间点
*/
EndTime?: string;
/**
* 仅当StartTime/EndTime为相对时间时使用,基于NowTime计算绝对时间,默认为创建时间
注意:此字段可能返回 null,表示取不到有效值。
*/
NowTime?: number;
/**
* 默认的检索分析语句,仅当Type为2时使用
注意:此字段可能返回 null,表示取不到有效值。
*/
Params?: Array;
/**
* 是否允许访问者自行修改检索分析时间范围。默认不锁定(false)
*/
IsLockTimeRange?: boolean;
/**
* 是否允许访问者自行修改日志检索语句。在检索页分享中表示检索语句锁定状态;在仪表盘中表示过滤变量锁定状态。默认不锁定(false)
*/
IsLockQuery?: boolean;
/**
* 检索页分享是否允许访问者下载日志,默认不允许(false)
注意:此字段可能返回 null,表示取不到有效值。
*/
IsSupportLogExport?: boolean;
}
/**
* dlc失败日志存储表信息
*/
export interface DlcFailTableInfo {
/**
* DLC的表名称
*/
TableName: string;
/**
* 表中的字段名称
字段类型必须是String类型
*/
FieldName: string;
}
/**
* DescribeDashboards请求参数结构体
*/
export interface DescribeDashboardsRequest {
/**
* 分页的偏移量,默认值为0。
*/
Offset?: number;
/**
* 分页单页限制数目,默认值为20,最大值100。
*/
Limit?: number;
/**
* - dashboardId 按照【仪表盘id】进行过滤,类型:String, 必选:否。
- 示例值:dashboard-522a5609-1f41-4b11-8086-5afd1d7574f5
- dashboardName 按照【仪表盘名字】进行模糊搜索过滤,类型:String,必选:否。
- 示例值:业务大盘
- dashboardRegion 按照【仪表盘地域】进行过滤(兼容老的仪表盘),通过云API创建的仪表盘该属性,类型:String,必选:否。
- 参考 [地域和访问域名](https://cloud.tencent.com/document/product/614/18940)
- 示例:ap-guangzhou
- tagKey 按照【标签键】进行过滤,类型:String,必选:否。
- 示例值:
```
"Filters":[
{
"Key": "tagKey",
"Values": [
"tag-key-test"
]
}
]
```
- tag:tagKey 按照【标签键值对】进行过滤。tagKey使用具体的标签键进行替换,类型:String,必选:否,
- 参考 [示例1](https://cloud.tencent.com/document/api/614/95636#4.-.E7.A4.BA.E4.BE.8B) 使用。
```
"Filters": [
{
"Key": "tag:tag-key-test",
"Values": [
"12"
]
}
]
```
每次请求的Filters的上限为10,Filter.Values的上限为100。
*/
Filters?: Array;
/**
* 按照topicId和regionId过滤。
- topicId:日志主题Id。
- 通过[获取日志主题列表](https://cloud.tencent.com/document/product/614/56454)获取日志主题Id。
- 示例值:439a5304-08f9-484b-9c4d-46ff57133816
- regionId
- 1:广州
- 4:上海
- 5:中国香港
- 7:上海金融
- 8:北京
- 9:新加坡
- 11:深圳金融
- 15:硅谷
- 16:成都
- 17:法兰克福
- 18:首尔
- 19:重庆
- 22:弗吉尼亚
- 23:曼谷
- 25:东京
- 33:南京
- 36:天津
- 39:台北
- 46:北京金融
- 72:雅加达
- 74:圣保罗
- 78:上海自动驾驶云
*/
TopicIdRegionFilter?: Array;
}
/**
* DeleteNoticeContent返回参数结构体
*/
export interface DeleteNoticeContentResponse {
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* CreateAgentApplication返回参数结构体
*/
export interface CreateAgentApplicationResponse {
/**
* 应用id
*/
ApplicationId?: string;
/**
* 日志主题列表
*/
LogTopics?: Array;
/**
* 指标主题列表
*/
MetricsTopics?: Array;
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* 自建k8s-容器标准输出信息
*/
export interface ContainerStdoutInfo {
/**
* 是否所有容器
*/
AllContainers: boolean;
/**
* container为空表所有的,不为空采集指定的容器
*/
Container?: string;
/**
* namespace可以多个,用分隔号分割,例如A,B;为空或者没有这个字段,表示所有namespace
*/
Namespace?: string;
/**
* pod标签信息
注意:此字段可能返回 null,表示取不到有效值。
*/
IncludeLabels?: Array;
/**
* 工作负载信息
注意:此字段可能返回 null,表示取不到有效值。
*/
WorkLoads?: Array;
/**
* 需要排除的namespace可以多个,用分隔号分割,例如A,B
*/
ExcludeNamespace?: string;
/**
* 需要排除的pod标签信息
注意:此字段可能返回 null,表示取不到有效值。
*/
ExcludeLabels?: Array;
/**
* metadata信息
注意:此字段可能返回 null,表示取不到有效值。
*/
CustomLabels?: Array;
}
/**
* ModifyS3Recharge请求参数结构体
*/
export interface ModifyS3RechargeRequest {
/**
* 导入任务Id
*/
TaskId: string;
/**
* 日志主题Id。
*/
TopicId: string;
/**
* s3导入任务名称,最大支持128个字节。
同一个TopicId下的s3任务Name必须唯一
*/
Name?: string;
/**
* s3导入任务类型.
枚举值:
*/
TaskType?: number;
/**
* 是否启用
枚举值:
*/
Enable?: number;
/**
* s3存储桶
*/
Bucket?: string;
/**
* 地域
*/
S3Region?: string;
/**
* 访问密钥 ID(Access Key ID)
*/
AccessKeyId?: string;
/**
* 访问密钥Key(Secret Access Key)
*/
SecretAccessKey?: string;
/**
* 自定义端点
*/
Endpoint?: string;
/**
* 采集的日志类型,json_log代表json格式日志,delimiter_log代表分隔符格式日志,minimalist_log代表单行全文; 默认为minimalist_log
*/
LogType?: string;
/**
* s3文件所在文件夹的前缀。默认为空,投递存储桶下所有的文件。
*/
Prefix?: string;
/**
* 压缩模式。支持: "", "gzip", "lzop", "snappy"。
*/
Compress?: string;
/**
* 提取规则,如果设置了ExtractRule,则必须设置LogType
*/
ExtractRuleInfo?: ExtractRuleInfo;
}
/**
* 指标采集yaml格式配置
*/
export interface MetricYamlSpec {
/**
* yaml监控类型。
支持:
- PodMonitor
- ServiceMonitor
- ScrapeConfig
- ScrapeConfig-prometheus
`PodMonitor `,`ServiceMonitor `,`ScrapeConfig ` 属于prometheus-operator
`ScrapeConfig-prometheus` 属于prometheus
注意:此字段可能返回 null,表示取不到有效值。
*/
Type: string;
/**
* 配置yaml格式。
例如:Type: ServiceMonitor
```
apiVersion: monitoring.coreos.com/v1
kind: ServiceMonitor
metadata:
name: test
namespace: test
labels:
k8s-app1: test
k8s-app2: test
spec:
endpoints:
- interval: 15s
port: 8080-8080-tcp
path: /metrics
relabelings:
- action: replace
sourceLabels:
- __meta_kubernetes_pod_label_app
targetLabel: application
namespaceSelector:
matchNames:
- test
selector:
matchLabels:
app: test
```
注意:此字段可能返回 null,表示取不到有效值。
*/
Spec: string;
}
/**
* DeleteCloudProductLogCollection请求参数结构体
*/
export interface DeleteCloudProductLogCollectionRequest {
/**
* 实例ID
*/
InstanceId: string;
/**
* 云产品标识,支持枚举:CDS、CWP、CDB、TDSQL-C、MongoDB、TDStore、DCDB、MariaDB、PostgreSQL、BH、APIS
*/
AssumerName: string;
/**
* 日志类型,支持枚举:CDS-AUDIT、CDS-RISK、CDB-AUDIT、TDSQL-C-AUDIT、MongoDB-AUDIT、MongoDB-SlowLog、MongoDB-ErrorLog、TDMYSQL-SLOW、DCDB-AUDIT、DCDB-SLOW、DCDB-ERROR、MariaDB-AUDIT、MariaDB-SLOW、MariaDB-ERROR、PostgreSQL-SLOW、PostgreSQL-ERROR、PostgreSQL-AUDIT、BH-FILELOG、BH-COMMANDLOG、APIS-ACCESS
*/
LogType: string;
/**
* 云产品地域。 不同日志类型(LogType)地域入参格式存在差异, 请参考如下示例:
CDS所有日志类型:ap-guangzhou CDB-AUDIT: gz TDSQL-C-AUDIT: gz MongoDB-AUDIT: gz MongoDB-SlowLog:ap-guangzhou MongoDB-ErrorLog:ap-guangzhou TDMYSQL-SLOW:gz DCDB所有日志类型:gz MariaDB所有日志类型:gz PostgreSQL所有日志类型:gz BH所有日志类型:overseas-polaris(中国香港地区和其他)/fsi-polaris(金融区)/general-polaris(普通区)/intl-sg-prod(国际站) APIS所有日志类型:gz
*/
CloudProductRegion: string;
/**
* 是否删除关联的topic
*/
IsDeleteTopic?: boolean;
/**
* 是否删除关联的logset。如果logset下还有topic的话,不会进行删除
*/
IsDeleteLogset?: boolean;
}
/**
* DescribeKafkaConsumer返回参数结构体
*/
export interface DescribeKafkaConsumerResponse {
/**
* Kafka协议消费是否打开
*/
Status?: boolean;
/**
* KafkaConsumer 消费时使用的Topic参数
*/
TopicID?: string;
/**
* 压缩方式[0:NONE;2:SNAPPY;3:LZ4]
*/
Compression?: number;
/**
* kafka协议消费数据格式
*/
ConsumerContent?: KafkaConsumerContent;
/**
* 是否开启投递服务日志。1:关闭,2:开启。
*/
HasServicesLog?: number;
/**
* 消费范围类型,0:最新,1:历史+最新
*/
ScopeType?: number;
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* JSON类型描述
*/
export interface JsonInfo {
/**
* 启用标志
*/
EnableTag: boolean;
/**
* 元数据信息列表, 可选值为 __SOURCE__、__FILENAME__、__TIMESTAMP__、__HOSTNAME__。
- __SOURCE__:日志采集的源 IP,示例:10.0.1.2
- __FILENAME__:日志采集的文件名,示例:/data/log/nginx/access.log
- __TIMESTAMP__:日志时间戳(毫秒级别 Unix 时间戳),按时间范围检索日志时,将自动使用该时间对日志进行检索,在控制台显示为“日志时间”,示例:1640005601188
- __HOSTNAME__:日志来源机器名称,需使用2.7.4及以上版本的 Loglistener 才会采集该字段,示例:localhost
注意:此字段可能返回 null,表示取不到有效值。
*/
MetaFields: Array;
/**
* 投递Json格式,0:字符串方式投递;1:以结构化方式投递
*/
JsonType?: number;
}
/**
* DeleteKafkaRecharge返回参数结构体
*/
export interface DeleteKafkaRechargeResponse {
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* 自建k8s-工作负载信息
*/
export interface ContainerWorkLoadInfo {
/**
* 工作负载的类型,支持的取值如下:
- deployment:无状态应用部署控制器。可管理无状态应用的多副本 Pod;支持滚动更新和回滚,实现无缝发布;通过 ReplicaSet 确保指定数量的 Pod 副本持续运行。适合 Web 服务、API 服务、微服务等不需要持久化存储或唯一标识的应用。
- statefulset:用于管理有状态应用的控制器。可以为每个 Pod 提供稳定的、唯一的标识(有序的主机名和网络标识);能提供稳定的持久化存储(PVC 随 Pod 的迁移而保留);Pod 的创建、扩展、删除和更新都遵循确定的顺序。适合数据库(MySQL、MongoDB)、消息队列(Kafka、RabbitMQ)、集群应用等需要稳定网络标识和持久化存储的应用。
- daemonset:确保所有(或特定)节点上都运行一个 Pod 副本的控制器。会在每个符合条件的 Node 上自动部署并运行一个 Pod;当新节点加入集群时,会自动在新节点上创建 Pod;适合运行节点级别的后台任务或服务,例如日志收集(Fluentd、Filebeat)、节点监控(Node Exporter)、网络插件(Calico、Weave Net)等场景。
- job:用于运行一次性任务的控制器。可创建一个或多个 Pod 来执行任务,直到成功完成;当任务完成后,Pod 不会重启(除非配置了重启策略);可以指定任务的并行度和重试次数。适合数据处理、批量任务、数据库迁移、离线计算等一次性执行完成后就退出的任务。
- cronjob:基于时间调度的 Job 控制器。类似于 Linux 的 cron,按照预定的时间表周期性地创建并运行 Job。每个调度周期都会创建一个新的 Job 来执行任务。适合定期备份、发送报告、数据清理、定时同步等需要周期性执行的任务。
*/
Kind: string;
/**
* 工作负载的名称
*/
Name: string;
/**
* 容器名
*/
Container?: string;
/**
* 命名空间
*/
Namespace?: string;
}
/**
* ModifyResourceGraphProductIngestTask请求参数结构体
*/
export interface ModifyResourceGraphProductIngestTaskRequest {
/**
* 资源图谱id
*/
ResourceGraphId: string;
/**
* 待修改的任务id
*/
TaskId: string;
/**
* 实例选择方案
枚举值:
*/
SelectionMode?: number;
/**
* 实例id。当选择方式使用“指定实例”时,需要填写
*/
InstanceIds?: Array;
/**
* eBPF 采集规则(仅 EBPF 产品)
*/
EBPFCollectRule?: EBPFCollectRule;
/**
* 标签。当实例选择方案使用“按标签选择”时,需要填写
*/
Tags?: Array;
}
/**
* DeleteDlcDeliver请求参数结构体
*/
export interface DeleteDlcDeliverRequest {
/**
* 日志主题id。
- 通过[获取日志主题列表](https://cloud.tencent.com/document/product/614/56454)获取日志主题Id。
*/
TopicId: string;
/**
* 任务id。
*/
TaskId: string;
}
/**
* 回调配置
*/
export interface CallBackInfo {
/**
* 回调时的Body。
可将各类告警变量放在请求内容中,详见[帮助文档](https://cloud.tencent.com/document/product/614/74718)。
如下示例:
```
{
"TopicId": "{{ .QueryLog[0][0].topicId }}",
"key": "{{.Alarm}}",
"time": "{{ .QueryLog[0][0].time }}",
"log": "{{ .QueryLog[0][0].content.__CONTENT__ }}",
"namespace": "{{ .QueryLog[0][0].content.__TAG__.namespace }}"
}
```
*/
Body: string;
/**
* 回调时的HTTP请求头部字段。
例如:下面请求头部字段来告知服务器请求主体的内容类型为JSON。
```
"Content-Type: application/json"
```
*/
Headers?: Array;
}
/**
* ModifyNetworkApplication请求参数结构体
*/
export interface ModifyNetworkApplicationRequest {
/**
* 网络应用id
*/
NetworkAppId: string;
/**
* 网络应用名称:长度不超过64字符,名称不能重复。
只能包含以下字符: 至少包含一个字符 不能包含空格 不能包含其他特殊字符(如 @、#、$、% 等)
*/
Name?: string;
}
/**
* DescribeHostMetricConfigs请求参数结构体
*/
export interface DescribeHostMetricConfigsRequest {
/**
* 指标日志主题id。
- 通过 [获取日志主题列表](https://cloud.tencent.com/document/product/614/56454) 获取日志主题Id。注意BizType 0:日志主题(默认值), 1:指标主题
- 通过 [创建日志主题](https://cloud.tencent.com/document/product/614/56456) 获取日志主题Id。注意BizType 0:日志主题(默认值), 1:指标主题
*/
TopicId: string;
/**
* - configId按照【配置id】进行过滤。类型:String 必选:否
- name按照【配置名称】进行过滤。类型:String 必选:否
每次请求的Filters的上限为10,Filter.Values的上限为10。
*/
Filters?: Array;
/**
* 分页的偏移量,默认值为0。
*/
Offset?: number;
/**
* 分页单页限制数目,默认值为20,最大值100。
*/
Limit?: number;
}
/**
* SplitPartition返回参数结构体
*/
export interface SplitPartitionResponse {
/**
* 分裂结果集
*/
Partitions?: Array;
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* 告警分类信息
*/
export interface AlarmClassification {
/**
* 分类键
*/
Key: string;
/**
* 分类值
*/
Value: string;
}
/**
* 告警渠道回调配置信息
*/
export interface WebCallbackInfo {
/**
* 告警渠道回调配置id。
*/
WebCallbackId?: string;
/**
* 告警渠道回调配置名称。
*/
Name?: string;
/**
* 渠道类型
WeCom:企业微信;DingTalk:钉钉;Lark:飞书;Http:自定义回调;
*/
Type?: string;
/**
* 回调地址。
*/
Webhook?: string;
/**
* 请求方式。
*/
Method?: string;
/**
* 秘钥信息。
*/
Key?: string;
/**
* 主账号。
*/
Uin?: number;
/**
* 子账号。
*/
SubUin?: number;
/**
* 创建时间。秒(s)级时间戳
*/
CreateTime?: number;
/**
* 更新时间。秒(s)级时间戳
*/
UpdateTime?: number;
}
/**
* 网络打通信息
*/
export interface NetworkInfo {
/**
* 网络类型。 0:公网,1:内网
*/
NetworkType: number;
/**
* 私有网络id
*/
VpcID?: string;
/**
* 私有网络所属用户app id
*/
AppID?: number;
/**
* 网络服务类型。0:CVM,3:专线网关,11:云联网,1025:CLB
*/
VirtualGatewayType?: number;
/**
* 专线网关id或者云联网id
*/
VpcGatewayIndex?: string;
/**
* 私有域名映射地址
*/
PrivateDomainNames?: Array;
}
/**
* DescribeConsoleSharingList返回参数结构体
*/
export interface DescribeConsoleSharingListResponse {
/**
* 分页的总数目
*/
TotalCount?: number;
/**
* 控制台免密分享列表
*/
ConsoleSharingInfos?: Array;
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* CreateLogset返回参数结构体
*/
export interface CreateLogsetResponse {
/**
* 日志集ID
*/
LogsetId?: string;
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* ModifyHostMetricConfig请求参数结构体
*/
export interface ModifyHostMetricConfigRequest {
/**
* 指标日志主题id。
- 通过 [获取日志主题列表](https://cloud.tencent.com/document/product/614/56454) 获取日志主题Id。注意BizType 0:日志主题(默认值), 1:指标主题
- 通过 [创建日志主题](https://cloud.tencent.com/document/product/614/56456) 获取日志主题Id。注意BizType 0:日志主题(默认值), 1:指标主题
*/
TopicId: string;
/**
* 采集配置id
*/
ConfigId: string;
/**
* 名称。
- 长度不超过 64字符。
*/
Name?: string;
/**
* 机器组id列表。最多支持100个机器组。
*/
MachineGroupIds?: Array;
/**
* 采集频率。单位:ms。 最小支持5000ms
*/
Interval?: number;
/**
* 采集项。支持"cpu","mem","net","disk","system"。**目前仅支持:所有采集项都需配置**。
- cpu:CPU
- mem:内存
- net:网络
- disk:磁盘
- system:系统
*/
HostMetricItems?: Array;
}
/**
* 仪表盘订阅通知方式
*/
export interface DashboardNoticeMode {
/**
* 仪表盘通知方式。
- Uin:腾讯云用户
- Group:腾讯云用户组
- WeCom:企业微信回调
- Email:自定义邮件
- DingTalk:钉钉
- Lark:飞书
*/
ReceiverType: string;
/**
* 知方式对应的值。
- 当ReceiverType为:`WeCom`、`DingTalk`、`Lark` 时,Values必须为空,且Url字段必填。
- 当ReceiverType为:`Uin`、`Group`、`Email` 时,Values必填,且Url字段必须为空。
- 当ReceiverType为:`Uin ` 时,Values为用户id,通过 [拉取子用户](https://cloud.tencent.com/document/product/598/34587) 获取子用户 UID 。
- 当ReceiverType为:`Group` 时,Values为用户组id,通过 [查询用户组列表](https://cloud.tencent.com/document/product/598/34589) 获取用户组 ID 。
- 当ReceiverType为:`Email` 时,Values为用户邮箱信息。
*/
Values?: Array;
/**
* 仪表盘通知渠道。
- 支持:["Email","Sms","WeChat","Phone"]。
- 当ReceiverType为 `Email` 或 `WeCom` 时,ReceiverChannels无效。
注意:此字段可能返回 null,表示取不到有效值。
*/
ReceiverChannels?: Array;
/**
* 订阅方式 - 回调地址。
- 当ReceiverType为:`WeCom`、`DingTalk`、`Lark` 时,Url字段必填为各渠道的回调地址。
- 为:`WeCom` 时,Url为 企业微信回调地址。
- 为:`DingTalk` 时,Url为 钉钉机器人Webhook地址。
- 为:`Lark` 时,Url为 飞书机器人Webhook地址。
- 当ReceiverType为:`Uin`、`Group`、`Email` 时,Url字段必须为空。
*/
Url?: string;
}
/**
* Kafka访问协议
*/
export interface KafkaProtocolInfo {
/**
* 协议类型,支持的协议类型包括 plaintext、sasl_plaintext 或 sasl_ssl。建议使用 sasl_ssl,此协议会进行连接加密同时需要用户认证。
当IsEncryptionAddr为true时,Protocol必填。 支持的协议类型如下:plaintext:纯文本无加密协议 sasl_ssl:SASL 认证 + SSL 加密 ssl:纯 SSL/TLS 加密协议 sasl_plaintext:SASL 认证 + 非加密通道
*/
Protocol?: string;
/**
* 加密类型,支持 PLAIN、SCRAM-SHA-256 或 SCRAM-SHA-512。
当Protocol为 sasl_plaintext 或 sasl_ssl 时 Mechanism 必填。 支持加密类型如下PLAIN:明文认证 SCRAM-SHA-256:基于挑战-响应机制,使用PBKDF2-HMAC-SHA256算法 SCRAM-SHA-512:增强版SCRAM,使用PBKDF2-HMAC-SHA512算法
*/
Mechanism?: string;
/**
* 用户名。 当Protocol为sasl_plaintext或sasl_ssl时必填
*/
UserName?: string;
/**
* 用户密码。 当Protocol为sasl_plaintext或sasl_ssl时必填
*/
Password?: string;
/**
* 是否开启客户端证书验证
*/
EnableClientCertificate?: number;
/**
* 是否开启服务端证书验证
*/
EnableServerCertificate?: number;
/**
* 云托管CA证书id
*/
CACertificateId?: string;
/**
* 云托管服务端证书id
*/
SVRCertificateId?: string;
}
/**
* ModifyAlarmShield返回参数结构体
*/
export interface ModifyAlarmShieldResponse {
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* CreateCosRecharge请求参数结构体
*/
export interface CreateCosRechargeRequest {
/**
* 日志主题Id。
- 通过[获取日志主题列表](https://cloud.tencent.com/document/product/614/56454)获取日志主题Id。
*/
TopicId: string;
/**
* 日志集Id。
- 通过[获取日志集列表](https://cloud.tencent.com/document/product/614/58624)获取日志集Id。
*/
LogsetId: string;
/**
* COS导入任务名称,最大支持128个字节。
*/
Name: string;
/**
* COS存储桶,详见产品支持的[存储桶命名规范](https://cloud.tencent.com/document/product/436/13312)。
- 通过[GET Service(List Buckets)](https://cloud.tencent.com/document/product/436/8291)获取COS存储桶。
*/
Bucket: string;
/**
* COS存储桶所在地域,详见产品支持的[地域列表](https://cloud.tencent.com/document/product/436/6224)。
*/
BucketRegion: string;
/**
* 采集的日志类型,json_log代表json格式日志,delimiter_log代表分隔符格式日志,minimalist_log代表单行全文;
默认为minimalist_log
*/
LogType: string;
/**
* COS文件所在文件夹的前缀。默认为空,投递存储桶下所有的文件。
*/
Prefix?: string;
/**
* supported: "", "gzip", "lzop", "snappy"。默认空,不压缩。
*/
Compress?: string;
/**
* 提取规则,如果设置了ExtractRule,则必须设置LogType
*/
ExtractRuleInfo?: ExtractRuleInfo;
/**
* COS导入任务类型。1:一次性导入任务;2:持续性导入任务。默认为1:一次性导入任务
*/
TaskType?: number;
/**
* 元数据。
*/
Metadata?: Array;
}
/**
* ChatCompletions返回参数结构体
*/
export interface ChatCompletionsResponse {
/**
* Unix 时间戳,单位为秒。
*/
Created?: number;
/**
* Token 统计信息。
*/
Usage?: ChatUsage;
/**
* 本次请求的 Id。
*/
Id?: string;
/**
* 回复内容。
*/
Choices?: Array;
/**
* 功能名称
枚举值:
text2sql: 智能生成检索分析语句 text2sql-reasoning: 智能生成检索分析语句-深度思考
*/
Model?: string;
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。本接口为流式响应接口,当请求成功时,RequestId 会被放在 HTTP 响应的 Header "X-TC-RequestId" 中。
*/
RequestId?: string;
}
/**
* DescribeNoticeContents返回参数结构体
*/
export interface DescribeNoticeContentsResponse {
/**
* 通知内容模板列表。
*/
NoticeContents?: Array;
/**
* 符合条件的通知内容模板总数。
*/
TotalCount?: number;
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* CreateAlarmShield返回参数结构体
*/
export interface CreateAlarmShieldResponse {
/**
* 屏蔽规则ID。
*/
TaskId?: string;
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* DescribeConsumer请求参数结构体
*/
export interface DescribeConsumerRequest {
/**
* 投递任务绑定的日志主题Id。
*/
TopicId: string;
}
/**
* CreateResourceGraph返回参数结构体
*/
export interface CreateResourceGraphResponse {
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* DeleteConfigExtra返回参数结构体
*/
export interface DeleteConfigExtraResponse {
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* ModifyConsumer请求参数结构体
*/
export interface ModifyConsumerRequest {
/**
* 投递任务绑定的日志主题Id。
*/
TopicId: string;
/**
* 投递任务是否生效,默认不生效
*/
Effective?: boolean;
/**
* 是否投递日志的元数据信息,默认为 true。 当NeedContent为true时:字段Content有效。 当NeedContent为false时:字段Content无效。
*/
NeedContent?: boolean;
/**
* 如果需要投递元数据信息,元数据信息的描述
*/
Content?: ConsumerContent;
/**
* CKafka的描述
*/
Ckafka?: Ckafka;
/**
* 投递时压缩方式,取值0,2,3。[0:NONE;2:SNAPPY;3:LZ4]
*/
Compression?: number;
/**
* 角色访问描述名 创建角色
*/
RoleArn?: string;
/**
* 外部ID
*/
ExternalId?: string;
/**
* 高级配置
*/
AdvancedConfig?: AdvancedConsumerConfiguration;
/**
* 日志预过滤-数据写入 ckafka 的原始数据进行预过滤处理
*/
DSLFilter?: string;
}
/**
* ModifyMetricConfig请求参数结构体
*/
export interface ModifyMetricConfigRequest {
/**
* 指标日志主题id。
- 通过 [获取日志主题列表](https://cloud.tencent.com/document/product/614/56454) 获取日志主题Id。注意BizType 0:日志主题(默认值), 1:指标主题
- 通过 [创建日志主题](https://cloud.tencent.com/document/product/614/56456) 获取日志主题Id。注意BizType 0:日志主题(默认值), 1:指标主题
*/
TopicId: string;
/**
* 指标采集配置id
*/
ConfigId: string;
/**
* 采集配置来源。支持 :`0`、`1`
- 0:自建k8s
- 1:TKE
*/
Source?: number;
/**
* 机器组id。
*/
GroupIds?: Array;
/**
* 操作状态,0:应用,1:暂停
*/
Operate?: number;
/**
* 采集对象, Flag=0时生效
*/
Spec?: MetricSpec;
/**
* 标签处理, Flag=0时生效
*/
MetricRelabels?: Array;
/**
* 自定义元数据, Flag=0时生效
*/
MetricLabel?: MetricConfigLabel;
/**
* 通信协议 `http`、`https`;Flag=0时生效
*/
Scheme?: string;
/**
* 采集频率, Flag=0时生效
- 校验格式:`^(((\d+)y)?((\d+)w)?((\d+)d)?((\d+)h)?((\d+)m)?((\d+)s)?((\d+)ms)?|0)$`
- 默认:60s
*/
ScrapeInterval?: string;
/**
* 采集超时时间。 Flag=0时生效
- 校验格式:`^(((\d+)y)?((\d+)w)?((\d+)d)?((\d+)h)?((\d+)m)?((\d+)s)?((\d+)ms)?|0)$`
*/
ScrapeTimeout?: string;
/**
* Prometheus如何处理标签之间的冲突。当Flag=0 && Type=1时生效,支持`true`,`false`
- `false`:配置数据中冲突的标签重命名
- `true`:忽略冲突的服务器端标签
*/
HonorLabels?: boolean;
/**
* 采集配置yaml格式字符串, Flag=1时必填
*/
YamlSpec?: MetricYamlSpec;
}
/**
* ModifyDashboardSubscribe请求参数结构体
*/
export interface ModifyDashboardSubscribeRequest {
/**
* 仪表盘订阅id。通过 [获取仪表盘订阅列表](https://cloud.tencent.com/document/api/614/105779)接口获取Id。
*/
Id: number;
/**
* 仪表盘id。通过 [获取仪表盘](https://cloud.tencent.com/document/api/614/95636)接口获取DashboardId。
*/
DashboardId?: string;
/**
* 仪表盘订阅名称。最大支持128个字符,且不支持'|'字符。
*/
Name?: string;
/**
* 订阅时间cron表达式,格式为:{秒数} {分钟} {小时} {日期} {月份} {星期};(有效数据为:{分钟} {小时} {日期} {月份} {星期})。
*/
Cron?: string;
/**
* 仪表盘订阅数据。
*/
SubscribeData?: DashboardSubscribeData;
}
/**
* 索引重建任务信息
*/
export interface RebuildIndexTaskInfo {
/**
* 索引重建任务ID
*/
TaskId: string;
/**
* 索引重建任务当前状态,0:索引重建任务已创建,1:创建索引重建资源,2:索引重建资源创建完成,3:重建中,4:暂停,5:重建索引成功,6:重建成功(可检索),7:重建失败,8:撤销,9:删除元数据和索引
*/
Status: number;
/**
* 重建任务开始时间戳
*/
StartTime: number;
/**
* 重建任务结束时间戳
*/
EndTime: number;
/**
* 重投预估剩余时间,单位秒
*/
RemainTime: number;
/**
* 重建任务创建时间戳
*/
CreateTime: number;
/**
* 重投完成度,百分比
*/
Progress: number;
/**
* 重建任务更新时间
*/
UpdateTime: number;
/**
* 附加状态描述信息(目前仅描述失败时失败原因)
*/
StatusMessage: string;
}
/**
* DescribeResourceGraphEntityDetail请求参数结构体
*/
export interface DescribeResourceGraphEntityDetailRequest {
/**
* 实体 ID
*/
EntityId: string;
/**
* 资源图谱id
*/
ResourceGraphId: string;
/**
* 查询范围-开始时间
单位:毫秒
*/
FromTime?: number;
/**
* 查询范围-结束时间
单位:毫秒
*/
ToTime?: number;
}
/**
* DescribeResourceGraphDetail请求参数结构体
*/
export interface DescribeResourceGraphDetailRequest {
/**
* 资源图谱id
*/
ResourceGraphId: string;
}
/**
* CreateDashboardSubscribe请求参数结构体
*/
export interface CreateDashboardSubscribeRequest {
/**
* 仪表盘订阅名称。
输入限制:
- 不能为空
- 长度不能超过128字节
- 不能包含字符'|'
*/
Name: string;
/**
* 仪表盘Id。
- 通过[获取仪表盘](https://cloud.tencent.com/document/product/614/95636)获取仪表盘Id。
*/
DashboardId: string;
/**
* 订阅时间cron表达式,格式为:{秒数} {分钟} {小时} {日期} {月份} {星期};(有效数据为:{分钟} {小时} {日期} {月份} {星期})。
- {秒数} 取值范围: 0 ~ 59
- {分钟} 取值范围: 0 ~ 59
- {小时} 取值范围: 0 ~ 23
- {日期} 取值范围: 1 ~ 31 AND (dayOfMonth最后一天: L)
- {月份} 取值范围: 1 ~ 12
- {星期} 取值范围: 0 ~ 6 【0:星期日, 6星期六】
*/
Cron: string;
/**
* 仪表盘订阅数据。
*/
SubscribeData: DashboardSubscribeData;
}
/**
* 全文索引配置
*/
export interface FullTextInfo {
/**
* 是否大小写敏感
*/
CaseSensitive: boolean;
/**
* 全文索引的分词符,其中的每个字符代表一个分词符;
仅支持英文符号、\n\t\r及转义符\;
注意:\n\t\r本身已被转义,直接使用双引号包裹即可作为入参,无需再次转义。使用API Explorer进行调试时请使用JSON参数输入方式,以避免\n\t\r被重复转义
*/
Tokenizer: string;
/**
* 是否包含中文
*/
ContainZH?: boolean;
}
/**
* DescribeConfigMachineGroups返回参数结构体
*/
export interface DescribeConfigMachineGroupsResponse {
/**
* 采集规则配置绑定的机器组列表
注意:此字段可能返回 null,表示取不到有效值。
*/
MachineGroups?: Array;
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* ModifySplunkDeliver请求参数结构体
*/
export interface ModifySplunkDeliverRequest {
/**
* 任务id
*/
TaskId: string;
/**
* 日志主题id
*/
TopicId: string;
/**
* 投递任务名称name有以下限制:- 不能为空- 长度不大于256- 只能包含aA-zZ、下划线、-、0-9
*/
Name?: string;
/**
* 投递任务启用状态;0:禁用;1:启用
*/
Enable?: number;
/**
* splunk投递任务-目标配置
*/
NetInfo?: NetInfo;
/**
* splunk投递任务元信息
*/
MetadataInfo?: MetadataInfo;
/**
* 是否启用服务日志;1:关闭;2:开启
*/
HasServiceLog?: number;
/**
* 高级配置-是否启用索引器; 1-不开启;2-开启;默认为:1
*/
IndexAck?: number;
/**
* 高级配置-数据来源;不超过64个字符
*/
Source?: string;
/**
* 高级配置-数据来源类型;不超过64个字符
*/
SourceType?: string;
/**
* 高级配置-Splunk写入的索引;不超过64个字符
*/
Index?: string;
/**
* 高级配置-通道。 需满足限制:如果启用索引器,该值不能为空
*/
Channel?: string;
/**
* 预过滤处理-对写入 Splunk 原始数据进行预过滤处理
*/
DSLFilter?: string;
/**
* 高级配置-跨账户投递用户角色授权信息
取值参考:新建自定义角色
*/
ExternalRole?: ExternalRole;
}
/**
* 符合检索条件的关键词,一般用于高亮显示。仅支持键值检索,不支持全文检索
*/
export interface HighLightItem {
/**
* 高亮的日志字段名称
*/
Key?: string;
/**
* 高亮的关键词
*/
Values?: Array;
}
/**
* DeleteAgentApplication返回参数结构体
*/
export interface DeleteAgentApplicationResponse {
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* CreateMetricSubscribe请求参数结构体
*/
export interface CreateMetricSubscribeRequest {
/**
* 名称:长度不超过64字符,以字母开头,接受0-9,a-z,A-Z, _,-,中文字符。
*/
Name: string;
/**
* 日志主题id。
*/
TopicId: string;
/**
* 云产品命名空间。
*/
Namespace: string;
/**
* 数据库配置信息。
*/
Metrics: Array;
/**
* 实例配置配置。
*/
InstanceInfo: InstanceConfig;
}
/**
* 通知内容模板信息
*/
export interface NoticeContentTemplate {
/**
* 通知内容模板ID。
*/
NoticeContentId?: string;
/**
* 通知内容模板名称
*/
Name?: string;
/**
* 语言类型。
0: 中文
1: 英文
*/
Type?: number;
/**
* 通知内容模板信息。
*/
NoticeContents?: Array;
/**
* 通知内容模板标记。
0: 用户自定义
1: 系统内置
*/
Flag?: number;
/**
* 创建者主账号。
*/
Uin?: number;
/**
* 创建/修改者子账号。
*/
SubUin?: number;
/**
* 创建时间 秒级(s)时间戳。
*/
CreateTime?: number;
/**
* 更新时间 秒级(s)时间戳。
*/
UpdateTime?: number;
}
/**
* 日志中的KV对
*/
export interface LogItem {
/**
* 日志Key
*/
Key?: string;
/**
* 日志Value
*/
Value?: string;
}
/**
* 投递规则
*/
export interface DeliverRule {
/**
* 数据投递范围。
枚举值:
1: 历史+新增数据 2: 自定义时间范围 3: 仅新增 本次仅支持3新增数据。后续支持: 2自定义时间范围和1历史+新增数据
*/
DataScope: number;
}
/**
* DescribeConfigMachineGroups请求参数结构体
*/
export interface DescribeConfigMachineGroupsRequest {
/**
* 采集配置ID
- 通过[获取采集规则配置](https://cloud.tencent.com/document/product/614/58616)获取采集配置Id。
*/
ConfigId: string;
}
/**
* DescribeMetricSubscribePreview请求参数结构体
*/
export interface DescribeMetricSubscribePreviewRequest {
/**
* 云产品命名空间。
*/
Namespace: string;
/**
* 数据库配置信息。
*/
Metrics: Array;
/**
* 实例配置配置。
*/
InstanceInfo: InstanceConfig;
}
/**
* DeleteConsumer返回参数结构体
*/
export interface DeleteConsumerResponse {
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* DescribeTopics请求参数结构体
*/
export interface DescribeTopicsRequest {
/**
* topicName 按照【主题名称】进行过滤,默认为模糊匹配,可使用 PreciseSearch 参数设置为精确匹配。类型:String。必选:否 logsetName 按照【日志集名称】进行过滤,默认为模糊匹配,可使用 PreciseSearch 参数设置为精确匹配。类型:String。必选:否 topicId 按照【主题ID】进行过滤。类型:String。必选:否 logsetId 按照【日志集ID】进行过滤,可通过调用 DescribeLogsets 查询已创建的日志集列表或登录控制台进行查看;也可以调用CreateLogset 创建新的日志集。类型:String。必选:否 tagKey 按照【标签键】进行过滤。类型:String。必选:否 tag:tagKey 按照【标签键值对】进行过滤。tagKey 使用具体的标签键进行替换,例如 tag:exampleKey。类型:String。必选:否 storageType 按照【主题的存储类型】进行过滤。可选值 hot(标准存储),cold(低频存储)类型:String。必选:否 注意:每次请求的 Filters 的上限为10,Filter.Values 的上限为100。
*/
Filters?: Array;
/**
* 分页的偏移量,默认值为0。
*/
Offset?: number;
/**
* 分页单页限制数目,默认值为20,最大值100。
*/
Limit?: number;
/**
* 控制Filters相关字段是否为精确匹配。
0: 默认值,topicName 和 logsetName 模糊匹配 1: topicName 精确匹配 2: logsetName精确匹配 3: topicName 和logsetName 都精确匹配
*/
PreciseSearch?: number;
/**
* 主题类型
*/
BizType?: number;
}
/**
* ModifySplunkDeliver返回参数结构体
*/
export interface ModifySplunkDeliverResponse {
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* RetryShipperTask请求参数结构体
*/
export interface RetryShipperTaskRequest {
/**
* 投递规则Id。
- 通过 [获取投递任务列表](https://cloud.tencent.com/document/product/614/58745)获取ShipperId。
*/
ShipperId: string;
/**
* 投递任务Id。
- 通过 [获取投递任务列表](https://cloud.tencent.com/document/product/614/58745) 获取TaskId。
*/
TaskId: string;
}
/**
* DeleteCosRecharge请求参数结构体
*/
export interface DeleteCosRechargeRequest {
/**
* COS导入配置Id。
- 通过 [获取cos导入配置](https://cloud.tencent.com/document/product/614/88099) 获取COS导入配置Id。
*/
Id: string;
/**
* 日志主题Id。
- 通过[获取日志主题列表](https://cloud.tencent.com/document/api/614/56454)获取日志主题Id。
*/
TopicId: string;
}
/**
* CreateHostMetricConfig请求参数结构体
*/
export interface CreateHostMetricConfigRequest {
/**
* 指标日志主题id。
- 通过 [获取日志主题列表](https://cloud.tencent.com/document/product/614/56454) 获取日志主题Id。注意BizType 0:日志主题(默认值), 1:指标主题
- 通过 [创建日志主题](https://cloud.tencent.com/document/product/614/56456) 获取日志主题Id。注意BizType 0:日志主题(默认值), 1:指标主题
*/
TopicId: string;
/**
* 名称。
- 长度不超过 64字符。
*/
Name: string;
/**
* 机器组id列表。最多支持100个机器组。
*/
MachineGroupIds: Array;
/**
* 采集频率。单位:ms。 最小支持5000ms
*/
Interval: number;
/**
* 采集项。支持"cpu","mem","net","disk","system"。**目前仅支持:所有采集项都需配置**。
- cpu:CPU
- mem:内存
- net:网络
- disk:磁盘
- system:系统
*/
HostMetricItems: Array;
}
/**
* DataSight访问控制规则
*/
export interface AccessControlRule {
/**
* 网段或IP,支持IPv4或IPv6。
注意:此字段可能返回 null,表示取不到有效值。
*/
CidrBlocks: Array;
/**
* ACCEPT 或 DROP。
注意:此字段可能返回 null,表示取不到有效值。
*/
Action: string;
/**
* 访问方式:public - 公网,internal - 内网
注意:此字段可能返回 null,表示取不到有效值。
*/
AccessMode: string;
}
/**
* ModifyWebCallback返回参数结构体
*/
export interface ModifyWebCallbackResponse {
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* ModifyCloudProductLogCollection返回参数结构体
*/
export interface ModifyCloudProductLogCollectionResponse {
/**
* 额外信息。如修改topic、logset标签失败。
*/
Message?: string;
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* DeleteConsumer请求参数结构体
*/
export interface DeleteConsumerRequest {
/**
* 投递任务绑定的日志主题Id。
- 通过 [获取日志主题列表](https://cloud.tencent.com/document/product/614/56454) 获取日志主题Id。
- 通过 [创建日志主题](https://cloud.tencent.com/document/product/614/56456) 获取日志主题Id。
*/
TopicId: string;
}
/**
* 指标订阅配置信息
*/
export interface MetricSubscribeInfo {
/**
* 订阅任务id。
*/
TaskId?: string;
/**
* 日志主题id。
*/
TopicId?: string;
/**
* 订阅任务名称。
*/
Name?: string;
/**
* 云产品命名空间。
*/
Namespace?: string;
/**
* 指标配置信息。
*/
Metrics?: Array;
/**
* 实例配置信息。
*/
InstanceInfo?: InstanceConfig;
/**
* 订阅任务开关。1:暂停 2:启用
*/
Enable?: number;
/**
* 订阅任务运行状态。0:创建中 1:暂停 2:运行中 3:异常
*/
Status?: number;
/**
* 订阅任务运行异常时的错误信息。
注意:此字段可能返回 null,表示取不到有效值。
*/
ErrMsg?: string;
/**
* 创建时间(秒级时间戳)
注意:此字段可能返回 null,表示取不到有效值。
*/
CreateTime?: number;
/**
* 更新时间(秒级时间戳)
注意:此字段可能返回 null,表示取不到有效值。
*/
UpdateTime?: number;
}
/**
* CreateNetworkApplication返回参数结构体
*/
export interface CreateNetworkApplicationResponse {
/**
* 网络应用id
*/
NetworkAppId?: string;
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* DeleteIndex请求参数结构体
*/
export interface DeleteIndexRequest {
/**
* 日志主题Id。
- 通过[获取日志主题列表](https://cloud.tencent.com/document/product/614/56454)获取日志主题Id。
*/
TopicId: string;
}
/**
* DeleteAgentApplication请求参数结构体
*/
export interface DeleteAgentApplicationRequest {
/**
* 应用id
*/
ApplicationId: string;
/**
* 是否删除agent应用关联的主题
枚举值:
false: 不删除agent应用关联的主题 true: 删除agent应用关联的主题 默认值:false
*/
DeleteTopics?: boolean;
}
/**
* DescribeAlertRecordHistory请求参数结构体
*/
export interface DescribeAlertRecordHistoryRequest {
/**
* 查询时间范围启始时间,毫秒级unix时间戳(ms)
*/
From: number;
/**
* 查询时间范围结束时间,毫秒级unix时间戳(ms)
*/
To: number;
/**
* 分页的偏移量,默认值为0。
*/
Offset: number;
/**
* 分页单页限制数目,最大值100。
*/
Limit: number;
/**
* - alertId:按照告警策略ID进行过滤。类型:String 必选:否
- topicId:按照监控对象ID进行过滤。类型:String 必选:否
- status:按照告警状态进行过滤。类型:String 必选:否,0代表未恢复,1代表已恢复,2代表已失效
- alarmLevel:按照告警等级进行过滤。类型:String 必选:否,0代表警告,1代表提醒,2代表紧急
每次请求的Filters的上限为10,Filter.Values的上限为100。
*/
Filters?: Array;
}
/**
* ChatCompletions请求参数结构体
*/
export interface ChatCompletionsRequest {
/**
* 功能名称
枚举值:
text2sql: 智能生成检索分析语句 text2sql-reasoning: 智能生成检索分析语句-深度思考
*/
Model: string;
/**
* 聊天上下文信息。 说明:
长度最多为 11 (5轮历史会话 + user新提问) ,按对话时间从旧到新在数组中排列。超出此长度会丢弃旧会话数据。 Message.Role 可选值:user、assistant。 user 和 assistant 需交替出现,以 user 提问开始,user 提问结束,Content 不能为空。Role 的顺序示例:[user assistant user assistant user ...]。
*/
Messages: Array;
/**
* 流式调用开关。 说明:
未传值时默认为非流式调用(false)。 流式调用时以 SSE 协议增量返回结果(返回值取 Choices[n].Delta 中的值,需要拼接增量数据才能获得完整结果)。 非流式调用时: 调用方式与普通 HTTP 请求无异。 接口响应耗时较长,如需更低时延建议设置为 true。 只返回一次最终结果(返回值取 Choices[n].Message 中的值)。 注意:
通过 SDK 调用时,流式和非流式调用需用不同的方式获取返回值,具体参考 SDK 中的注释或示例(在各语言 SDK 代码仓库的 examples/cls/v20201016/ 目录中)。 可能会出现部分内容已输出,但中间某一段响应中的 FinishReason 值为 sensitive,此时说明安全审核未通过。如果业务场景有实时文字上屏的需求,需要自行撤回已上屏的内容,并建议自定义替换为一条提示语,如 “这个问题我不方便回答,不如我们换个话题试试”,以保障终端体验。
*/
Stream?: boolean;
/**
* 额外元数据信息。例如:[{"Key":"topic_id","Value":"xxxxxxxx-xxxx"},{"Key":"topic_region","Value":"ap-guangzhou"}]
建议按照示例传递元数据信息,否则可能造成结果不准确。例如 text2sql,不传 topic_id, topic_region,将导致无法根据日志主题索引生成准确的检索语句。
*/
Metadata?: Array;
}
/**
* DeleteNetworkApplication请求参数结构体
*/
export interface DeleteNetworkApplicationRequest {
/**
* 网络应用id。
*/
NetworkAppId: string;
}
/**
* CreateS3Recharge返回参数结构体
*/
export interface CreateS3RechargeResponse {
/**
* 导入任务Id
*/
TaskId?: string;
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* 日志集相关信息
*/
export interface LogsetInfo {
/**
* 日志集ID
*/
LogsetId?: string;
/**
* 日志集名称
*/
LogsetName?: string;
/**
* 创建时间。格式 `YYYY-MM-DD HH:MM:SS`
*/
CreateTime?: string;
/**
* 若AssumerUin非空,则表示创建该日志集的服务方Uin
*/
AssumerUin?: number;
/**
* 云产品标识,日志集由其它云产品创建时,该字段会显示云产品名称,例如CDN、TKE
*/
AssumerName?: string;
/**
* 日志集绑定的标签
*/
Tags?: Array;
/**
* 日志集下日志主题的数目
*/
TopicCount?: number;
/**
* 若AssumerName非空,则表示创建该日志集的服务方角色
*/
RoleName?: string;
/**
* 日志集下指标主题的数目
*/
MetricTopicCount?: number;
}
/**
* CreateExport请求参数结构体
*/
export interface CreateExportRequest {
/**
* 日志主题Id
*/
TopicId: string;
/**
* 日志导出数量, 最大值5000万
*/
Count: number;
/**
* 日志导出检索语句,不支持[SQL语句]
*/
Query: string;
/**
* 日志导出起始时间,毫秒时间戳
*/
From: number;
/**
* 日志导出结束时间,毫秒时间戳
*/
To: number;
/**
* 日志导出时间排序。desc,asc,默认为desc
*/
Order?: string;
/**
* 日志导出数据格式。json,csv,默认为json
*/
Format?: string;
/**
* 检索语法规则,默认值为1,推荐使用1 。
0:Lucene语法 1:CQL语法(CLS Query Language,日志服务专用检索语法) 详细说明参见检索条件语法规则 。
*/
SyntaxRule?: number;
/**
* 导出字段
*/
DerivedFields?: Array;
}
/**
* 仪表盘订阅模板变量
*/
export interface DashboardTemplateVariable {
/**
* key的值
*/
Key: string;
/**
* key对应的values取值values
*/
Values: Array;
}
/**
* CancelRebuildIndexTask请求参数结构体
*/
export interface CancelRebuildIndexTaskRequest {
/**
* 日志主题ID
取值参考:DescribeTopics
*/
TopicId: string;
/**
* 索引重建任务ID
取值参考:DescribeRebuildIndexTasks
*/
TaskId: string;
}
/**
* DescribeConsoleSharingList请求参数结构体
*/
export type DescribeConsoleSharingListRequest = null;
/**
* 预聚合任务详情
*/
export interface RecordingRuleTaskInfo {
/**
* 预聚合任务id
*/
TaskId?: string;
/**
* 源日志主题id
*/
TopicId?: string;
/**
* 预聚合任务名称
*/
Name?: string;
/**
* 任务创建时间
*/
CreateTime?: string;
/**
* 任务更新时间
*/
UpdateTime?: string;
/**
* 任务状态,1:运行 2:停止 3:异常-找不到源日志主题 4:异常-找不到目标主题
5: 访问权限问题 6:内部故障 7:其他故障
*/
Status?: number;
/**
* 任务启用状态,1开启, 2关闭
*/
EnableFlag?: number;
/**
* 调度开始时间
*/
ProcessStartTime?: number;
/**
* 调度周期(分钟)
*/
ProcessPeriod?: number;
/**
* 执行延迟(秒)
*/
ProcessDelay?: number;
/**
* 是否开启投递服务日志。1:关闭,2:开启。
*/
HasServicesLog?: number;
/**
* 预聚合检索语句
*/
RecordingRuleContent?: string;
/**
* 指标名称
*/
MetricName?: string;
/**
* 自定义指标名称
*/
CustomMetricLabels?: Array;
/**
* yaml配置文件id
*/
YamlId?: string;
/**
* yaml配置文件名称
*/
YamlConfigName?: string;
/**
* 目标日志主题id
*/
DstTopicId?: string;
}
/**
* DescribeLogsets返回参数结构体
*/
export interface DescribeLogsetsResponse {
/**
* 分页的总数目
*/
TotalCount?: number;
/**
* 日志集列表
*/
Logsets?: Array;
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* ModifyCLSDeliverTask返回参数结构体
*/
export interface ModifyCLSDeliverTaskResponse {
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* DescribeKafkaConsumerPreview返回参数结构体
*/
export interface DescribeKafkaConsumerPreviewResponse {
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* Remote Write鉴权信息
*/
export interface RemoteWriteAuthInfo {
/**
* basic auth username
注意:此字段可能返回 null,表示取不到有效值。
*/
Username?: string;
/**
* basic auth password
注意:此字段可能返回 null,表示取不到有效值。
*/
Password?: string;
/**
* basic auth token
注意:此字段可能返回 null,表示取不到有效值。
*/
Token?: string;
}
/**
* 网络应用任务信息
*/
export interface NetworkApplicationInfo {
/**
* 网络应用Id
*/
NetworkAppId?: string;
/**
* 网络应用名称
*/
Name?: string;
/**
* 地域code
*/
Region?: string;
/**
* 日志主题id
*/
TopicId?: string;
/**
* 日志集id
*/
LogsetId?: string;
/**
* 主账号id
*/
Uin?: number;
/**
* 子账号id
*/
SubUin?: number;
/**
* 创建时间,秒级时间戳
*/
CreateTime?: number;
/**
* 更新时间,秒级时间戳
*/
UpdateTime?: number;
}
/**
* CreateResourceGraphProductIngestTask请求参数结构体
*/
export interface CreateResourceGraphProductIngestTaskRequest {
/**
* 资源图谱id
*/
ResourceGraphId: string;
/**
* 接入任务名称
*/
Name: string;
/**
* 待接入的云产品;支持tke、cdb、mongodb、redis
*/
CloudProduct: string;
/**
* 实例选择方案
枚举值:
*/
SelectionMode: number;
/**
* 实例id。当选择方式使用“指定实例”时,需要填写
*/
InstanceIds?: Array;
/**
* eBPF 采集规则
*/
EBPFCollectRule?: EBPFCollectRule;
/**
* 标签。当实例选择方案使用“按标签选择”时,需要填写
*/
Tags?: Array;
}
/**
* ModifySearchView请求参数结构体
*/
export interface ModifySearchViewRequest {
/**
* 视图ID
*/
ViewId: string;
/**
* 视图名称
参数格式:^[a-z0-9][a-z0-9_-]{1,61}[a-z0-9]$
*/
ViewName?: string;
/**
* 视图类型
枚举值:
Topics字段中配置的主题信息应该与ViewType类型匹配
*/
ViewType?: string;
/**
* 查询视图中包含的主题,最大可包含10个主题
*/
Topics?: Array;
/**
* 描述信息
*/
Description?: string;
}
/**
* 回调地址
*/
export interface WebCallback {
/**
* 回调的类型。可选值:
- Http(自定义接口回调)
- WeCom(企业微信)
- DingTalk(钉钉)
- Lark(飞书)
*/
CallbackType: string;
/**
* 回调地址,最大支持1024个字节。
也可使用WebCallbackId引用集成配置中的URL,此时该字段请填写为空字符串。
*/
Url: string;
/**
* 集成配置ID。-通过[获取告警渠道回调配置列表](https://cloud.tencent.com/document/product/614/115229)获取集成配置ID
*/
WebCallbackId?: string;
/**
* 回调方法。可选值:
- POST(默认值)
- PUT
注意:
- 参数CallbackType为Http时为必选,其它回调方式无需填写。
*/
Method?: string;
/**
* 通知内容模板ID,使用Default-zh引用默认模板(中文),使用Default-en引用DefaultTemplate(English)。
*/
NoticeContentId?: string;
/**
* 提醒类型。
0:不提醒;1:指定人;2:所有人
*/
RemindType?: number;
/**
* 电话列表。
*/
Mobiles?: Array;
/**
* 用户ID列表。
*/
UserIds?: Array;
/**
* 该参数已废弃,请使用NoticeContentId。
* @deprecated
*/
Headers?: Array;
/**
* 该参数已废弃,请使用NoticeContentId。
注意:此字段可能返回 null,表示取不到有效值。
* @deprecated
*/
Body?: string;
/**
* 序号。
- 入参无效。
- 出参有效。
*/
Index?: number;
}
/**
* CreateAlarmNotice返回参数结构体
*/
export interface CreateAlarmNoticeResponse {
/**
* 告警模板ID
*/
AlarmNoticeId?: string;
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* ModifyTopic返回参数结构体
*/
export interface ModifyTopicResponse {
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* CreateConfig请求参数结构体
*/
export interface CreateConfigRequest {
/**
* 采集配置名称
名称种不得包含特殊字符| 名称最长255字符,超过截断
*/
Name: string;
/**
* 采集配置所属日志主题ID即TopicId
*/
Output: string;
/**
* 日志采集路径,包含文件名,支持多个路径,多个路径之间英文逗号分隔,文件采集情况下必填
*/
Path?: string;
/**
* 采集的日志类型,默认为minimalist_log。支持以下类型:
*/
LogType?: string;
/**
* 提取规则,如果设置了ExtractRule,则必须设置LogType
*/
ExtractRule?: ExtractRuleInfo;
/**
* 采集黑名单路径列表
*/
ExcludePaths?: Array;
/**
* 用户自定义采集规则,Json格式序列化的字符串。当LogType为user_define_log时,必填。
*/
UserDefineRule?: string;
/**
* 高级采集配置。 Json字符串, Key/Value定义为如下:
ClsAgentFileTimeout(超时属性), 取值范围: 大于等于0的整数, 0为不超时 ClsAgentMaxDepth(最大目录深度),取值范围: 大于等于0的整数 ClsAgentParseFailMerge(合并解析失败日志),取值范围: true或false 样例:{\"ClsAgentFileTimeout\":0,\"ClsAgentMaxDepth\":10,\"ClsAgentParseFailMerge\":true} 控制台默认占位值:{\"ClsAgentDefault\":0}
*/
AdvancedConfig?: string;
/**
* 日志输入类型(注:windows场景必填且仅支持file和windows_event类型 )
file: 文件类型采集 windows_event:windows事件采集 syslog:系统日志采集
*/
InputType?: string;
}
/**
* DeleteEsRecharge返回参数结构体
*/
export interface DeleteEsRechargeResponse {
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* eBPF 目的 IP/端口过滤器
*/
export interface EBPFDestEndpointFilter {
/**
* 过滤模式
枚举值:
*/
Mode: number;
/**
* 端点列表
*/
Endpoints?: Array;
}
/**
* DescribeNetworkApplications请求参数结构体
*/
export interface DescribeNetworkApplicationsRequest {
/**
* 过滤项
每次请求的Filters的上限为10,Filter.Values的上限为10。
*/
Filters?: Array;
/**
* 分页的偏移量,默认值为0。
*/
Offset?: number;
/**
* 分页单页限制数目,默认值为20,最大值100。
*/
Limit?: number;
}
/**
* DescribeKafkaRecharges返回参数结构体
*/
export interface DescribeKafkaRechargesResponse {
/**
* KafkaRechargeInfo 信息列表
*/
Infos?: Array;
/**
* Kafka导入信息总条数
*/
TotalCount?: number;
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* ModifyDlcDeliver请求参数结构体
*/
export interface ModifyDlcDeliverRequest {
/**
* 日志主题id。
*/
TopicId: string;
/**
* 任务id。
*/
TaskId: string;
/**
* 名称:长度不超过64字符,以字母开头,接受0-9,a-z,A-Z, _,-,中文字符。
*/
Name?: string;
/**
* 投递类型。0:批投递,1:实时投递
*/
DeliverType?: number;
/**
* 投递时间范围的开始时间
*/
StartTime?: number;
/**
* 投递时间范围的结束时间。 如果为空,则表示不限时
*/
EndTime?: number;
/**
* 投递文件大小,单位MB。 DeliverType=0时必填,范围 5<= MaxSize <= 256。
*/
MaxSize?: number;
/**
* 投递间隔,单位秒。 DeliverType=0时必填,范围 300<= Interval <=900。
*/
Interval?: number;
/**
* dlc配置信息
*/
DlcInfo?: DlcInfo;
/**
* 是否开启投递服务日志。1关闭,2开启。默认开启
*/
HasServicesLog?: number;
/**
* 任务状态。
枚举值:
*/
Status?: number;
/**
* 自动创建dlc字段
默认值:false
当您的日志中有新增字段时,系统自动将其投递至DLC
*/
AutoCreateField?: boolean;
/**
* 将投递失败的日志存储至DLC表
*/
DlcFailHandle?: DlcFailHandle;
/**
* 日志预过滤-数据写入 Splunk 的原始数据进行预过滤处理
*/
DSLFilter?: string;
}
/**
* CreateRecordingRuleTask请求参数结构体
*/
export interface CreateRecordingRuleTaskRequest {
/**
* 源指标主题id
取值参考:
*/
TopicId: string;
/**
* 目标指标主题id,可与 TopicId 相同
*/
DstTopicId: string;
/**
* 预聚合任务名称
入参限制:仅支持字母、数字、及下划线,不允许下划线开头,小于256个字符
*/
Name: string;
/**
* 任务状态; 1:开启;2:关闭
*/
EnableFlag: number;
/**
* 任务执行开始时间 ,Unix时间戳
单位:ms
*/
ProcessStartTime: number;
/**
* 调度周期(分钟),支持范围(0,1440]分钟。
*/
ProcessPeriod: number;
/**
* 执行延迟,建议设置为30秒,避免指标上报延迟导致预聚合任务计算结果不精确
单位:秒
*/
ProcessDelay: number;
/**
* 执行语句(PromQL)
*/
RecordingRuleContent: string;
/**
* 指标名称
*/
MetricName: string;
/**
* 指标自定义维度
*/
CustomMetricLabels?: Array;
/**
* 是否开启投递服务日志。1:关闭,2:开启。
*/
HasServicesLog?: number;
}
/**
* 控制台分享信息
*/
export interface ConsoleSharingInfo {
/**
* 分享ID
*/
SharingId: string;
/**
* 分享链接
注意:此字段可能返回 null,表示取不到有效值。
*/
SharingUrl?: string;
/**
* 匿名分享配置信息
注意:此字段可能返回 null,表示取不到有效值。
*/
SharingConfig?: ConsoleSharingConfig;
/**
* 过期时间
注意:此字段可能返回 null,表示取不到有效值。
*/
ExpiredTime?: number;
/**
* 创建时间
注意:此字段可能返回 null,表示取不到有效值。
*/
CreateTime?: number;
/**
* 修改时间
注意:此字段可能返回 null,表示取不到有效值。
*/
UpdateTime?: number;
/**
* 分享链接状态
1: 正常
-1: 因内容安全审查异常导致被封禁(存在于使用公网域名分享时)
注意:此字段可能返回 null,表示取不到有效值。
*/
Status?: number;
/**
* 10001-广告 20001-政治 20002-色情 20004-社会事件 20011-暴力 20012-低俗 20006-违法犯罪 20007-谩骂 20008-欺诈 20013-版权 20104-谣言 21000-其他, 10086-聚合, 24001-暴恐(天御独有恶意类型),20472-违法,
24005-社会
注意:此字段可能返回 null,表示取不到有效值。
*/
ContentSafetyCode?: number;
}
/**
* 模型生成的工具调用
*/
export interface ToolCall {
/**
* 工具调用id
*/
Id?: string;
/**
* 工具调用类型,当前只支持function
*/
Type?: string;
/**
* 具体的function调用
*/
Function?: ToolCallFunction;
/**
* 索引值
*/
Index?: number;
/**
* 模型返回的思考签名,执行工具后需在后续请求中原样回传
*/
ThoughtSignature?: string;
}
/**
* DeleteCloudProductLogCollection返回参数结构体
*/
export interface DeleteCloudProductLogCollectionResponse {
/**
* 枚举值,0创建中 1创建完成 2删除中 3删除完成
*/
Status?: number;
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* 日志导出信息
*/
export interface ExportInfo {
/**
* 日志主题ID
*/
TopicId?: string;
/**
* 日志导出任务ID
*/
ExportId?: string;
/**
* 日志导出查询语句
*/
Query?: string;
/**
* 日志导出文件名
*/
FileName?: string;
/**
* 日志文件大小
单位:Byte
*/
FileSize?: number;
/**
* 日志导出时间排序
*/
Order?: string;
/**
* 日志导出格式
*/
Format?: string;
/**
* 日志导出数量
*/
Count?: number;
/**
* 日志下载状态。Processing:导出正在进行中,Completed:导出完成,Failed:导出失败,Expired:日志导出已过期(三天有效期), Queuing 排队中
*/
Status?: string;
/**
* 日志导出起始时间,毫秒时间戳
*/
From?: number;
/**
* 日志导出结束时间,毫秒时间戳
*/
To?: number;
/**
* 日志导出路径,有效期一个小时,请尽快使用该路径下载。
*/
CosPath?: string;
/**
* 日志导出创建时间 时间格式:yyyy-MM-dd HH:mm:ss
*/
CreateTime?: string;
/**
* 语法规则。 默认值为0。 0:Lucene语法,1:CQL语法。
*/
SyntaxRule?: number;
/**
* 导出字段
*/
DerivedFields?: Array;
/**
* 日志导出创建时间,毫秒时间戳
单位:ms
*/
CreateTimestamp?: number;
}
/**
* 指标采集label配置信息
*/
export interface MetricConfigLabel {
/**
* 元数据。
支持
- `namespace`
- `pod_name`
- `pod_ip`
- `pod_uid`
- `container_name`
- `container_id`
- `image_name`
- `cluster_id`
- `node_id`
- `node_ip`
注意:此字段可能返回 null,表示取不到有效值。
*/
Metadata?: Array;
/**
* 元数据Pod Label信息。
注意:此字段可能返回 null,表示取不到有效值。
*/
Label?: AppointLabel;
/**
* 自定义label信息。
注意:此字段可能返回 null,表示取不到有效值。
*/
CustomLabels?: Array;
}
/**
* DeleteS3Recharge请求参数结构体
*/
export interface DeleteS3RechargeRequest {
/**
* 导入任务Id
*/
TaskId: string;
/**
* 日志主题Id。
*/
TopicId: string;
}
/**
* 仪表盘订阅信息
*/
export interface DashboardSubscribeInfo {
/**
* 仪表盘订阅id。
*/
Id?: number;
/**
* 仪表盘订阅名称。
*/
Name?: string;
/**
* 仪表盘id。
*/
DashboardId?: string;
/**
* 仪表盘订阅时间。
*/
Cron?: string;
/**
* 仪表盘订阅数据。
*/
SubscribeData?: DashboardSubscribeData;
/**
* 仪表盘订阅记录创建时间。格式:`YYYY-MM-DD HH:MM:SS`
*/
CreateTime?: string;
/**
* 仪表盘订阅记录更新时间。格式:`YYYY-MM-DD HH:MM:SS`
*/
UpdateTime?: string;
/**
* 仪表盘订阅记录最后一次发送成功时间。格式:`YYYY-MM-DD HH:MM:SS`
*/
LastTime?: string;
/**
* 腾讯云主账号Id。
*/
Uin?: number;
/**
* 腾讯云主账号下的子账号Id。
*/
SubUin?: number;
/**
* 仪表盘订阅记录最后一次发送的状态。success:全部发送成功,fail:未发送, partialSuccess:部分发送成功。
*/
LastStatus?: string;
}
/**
* DescribeWebCallbacks返回参数结构体
*/
export interface DescribeWebCallbacksResponse {
/**
* 告警渠道回调配置列表。
*/
WebCallbacks?: Array;
/**
* 符合条件的通知内容配置总数。
*/
TotalCount?: number;
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* DeleteExport请求参数结构体
*/
export interface DeleteExportRequest {
/**
* 日志导出任务Id
- 通过[获取日志下载任务列表](https://cloud.tencent.com/document/product/614/56449)获取日志导出任务Id。
*/
ExportId: string;
}
/**
* ModifyKafkaConsumerGroupOffset请求参数结构体
*/
export type ModifyKafkaConsumerGroupOffsetRequest = null;
/**
* ModifyRemoteWriteTask请求参数结构体
*/
export interface ModifyRemoteWriteTaskRequest {
/**
* 任务id
*/
TaskId: string;
/**
* 日志主题id
*/
TopicId: string;
/**
* 任务状态 0 关闭 1 开启
*/
Enable?: number;
/**
* RemoteWrite任务名称
*/
Name?: string;
/**
* 1 内网 2外网
*/
NetType?: number;
/**
* 私有网络id
*/
VpcId?: string;
/**
* 目标服务名称
*/
Target?: string;
/**
* 目标地址
*/
RemoteWriteURL?: string;
/**
* 0: 无鉴权 1: basic_auth 2: token
*/
AuthType?: number;
/**
* 鉴权信息
*/
AuthInfo?: RemoteWriteAuthInfo;
/**
* 后端服务类型 -1 没有 0 CVM 1025 CLB
*/
VirtualGatewayType?: number;
/**
* 云时序数据库实例ID
*/
InstanceId?: string;
/**
* 是否开启投递服务日志。1:关闭,2:开启。
*/
HasServicesLog?: number;
}
/**
* DescribeConsoles请求参数结构体
*/
export interface DescribeConsolesRequest {
/**
* 分页的偏移量,默认值为0。
*/
Offset?: number;
/**
* 分页单页限制数目,默认值为100,最大值100。
*/
Limit?: number;
/**
* DomainPrefix按照【域名前缀】进行过滤。类型:String必选:否 ConsoleId按照【DataSight实例ID】进行过滤。类型:String必选:否 tagKey按照【标签键】进行过滤。类型:String必选:否 tag:tagKey按照【标签键值对】进行过滤。tagKey使用具体的标签键进行替换,例如tag:exampleKey。类型:String必选:否
*/
Filters?: Array;
}
/**
* 告警屏蔽任务配置
*/
export interface AlarmShieldInfo {
/**
* 通知渠道组Id
*/
AlarmNoticeId?: string;
/**
* 屏蔽规则id
*/
TaskId?: string;
/**
* 屏蔽开始时间(秒级时间戳)。
*/
StartTime?: number;
/**
* 屏蔽结束时间(秒级时间戳)。
*/
EndTime?: number;
/**
* 屏蔽类型。1:屏蔽所有通知,2:按照Rule参数屏蔽匹配规则的通知。
*/
Type?: number;
/**
* 屏蔽规则,当Type为2时必填。规则填写方式详见[产品文档](https://cloud.tencent.com/document/product/614/103178#rule)。
*/
Rule?: string;
/**
* 屏蔽原因。
*/
Reason?: string;
/**
* 规则创建来源。
1. 控制台,2.api,3.告警通知
*/
Source?: number;
/**
* 操作者。
*/
Operator?: string;
/**
* 规则状态。
0:暂未生效,1:生效中,2:已失效
*/
Status?: number;
/**
* 规则创建时间。秒级时间戳(s)
*/
CreateTime?: number;
/**
* 规则更新时间。秒级时间戳(s)
*/
UpdateTime?: number;
}
/**
* CreateConsole返回参数结构体
*/
export interface CreateConsoleResponse {
/**
* DataSight控制台Id
*/
ConsoleId?: string;
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* ModifyConfig返回参数结构体
*/
export interface ModifyConfigResponse {
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* 指标配置信息
*/
export interface MetricConfig {
/**
* 指标名称
*/
MetricName: string;
/**
* 统计周期,单位:秒(s)
*/
Periods: Array;
/**
* 自定义指标标签
*/
MetricLabels?: Array;
}
/**
* ModifyConsole请求参数结构体
*/
export interface ModifyConsoleRequest {
/**
* DataSight控制台ConsoleId
*/
ConsoleId: string;
/**
* 访问方式:public - 公网,internal - 内网
*/
AccessMode?: Array;
/**
* 登录方式
枚举值:
0: 账号密码鉴权 1: 匿名登录 2: 第三方认证登录
*/
LoginMode?: number;
/**
* 自定义域名前缀
*/
DomainPrefix?: string;
/**
* 用户账号信息
“账号密码鉴权”登录方式必传
*/
Accounts?: Array;
/**
* 匿名登录账号信息
“匿名登录”登录方式必传
*/
AnonymousLogin?: AnonymousLoginInfo;
/**
* 内网类型,默认为0
*/
IntranetType?: number;
/**
* 内网地域
*/
IntranetRegion?: string;
/**
* 内网私有网络VpcId
*/
VpcId?: string;
/**
* 内网子网SubnetId
*/
SubnetId?: string;
/**
* Auth用户角色信息
“第三方认证登录”登录方式必传
*/
AuthRoles?: Array;
/**
*