ulogservice

type AnalysisField struct {

	// 字段名
	Name string

	// 字段类型
	Type string
}

type BindULogServiceGroupToCollectConfRequest struct {
	request.CommonBase

	// 采集配置id
	CollectConfId *int `required:"true"`

	// 机器组ID，是一个数组
	MachineGroupIds *int `required:"false"`

	// 日志主题ID
	TopicId *string `required:"true"`
}

type BindULogServiceGroupToCollectConfResponse struct {
	response.CommonBase

	// 错误信息
	Message string
}

type CollectConf struct {

	// 采集策略。可选值: full (全量采集存量日志), increment (从当前时间点增量采集)。默认为 full。
	CollectPolicy string

	// CreateTime
	CreateTime int

	// 当 LogType 为delimiter 或multi_line_delimiter时可选，支持多字符分隔，需要转换成Base64
	Delimiter string

	// 日志原文的编码格式。可选值: utf-8, gbk。默认为 utf-8。
	Encode string

	// 日志提取正则表达式。当 logType 为正则模式 (如 full_regex,multi_line_full_regex) 时，用于从日志中提取字段。需要转换成Base64
	ExtractRule string

	// FilePaths
	FilePaths []FilePath

	// Id
	Id int

	// 索引字段key，是一个数组
	Keys string

	// 日志解析类型，决定了如何结构化日志。可选值: json:json 格式，delimiter:分隔符，full_regex:完全正则，multi_line_full_regex:多行完全正则，multi_line_delimiter: 多行分隔符正则，minimal_list:单行全文日志,multi_line:多行全文日志
	LogType string

	// 机器组ID，是一个数组
	MachineGroups []MachineGroup

	// 行首正则表达式。当 logType 为多行模式 (如 multi_line 或 multi_line_full_regex或multi_line_delimiter) 时，用于标识一条新日志的开始。需要转换成Base64
	MatchRule string

	// 日志采集配置名称
	Name string

	// State
	State int

	// 日志主题ID
	TopicId int

	// 如果 UnMatchUpload 为 true，无法解析的日志原文将被存放在此字段指定的 Key 下。默认为 LogParseFailure。
	UnMatchKey string

	// updateTime
	UpdateTime int
}

type CreateULogServiceCollectConfParamFilePaths struct {

	// 定义采集路径的文件名，数组类型
	File *string `required:"false"`

	// 定义采集路径，数组类型
	Path *string `required:"false"`
}

type CreateULogServiceCollectConfRequest struct {
	request.CommonBase

	// 采集策略。可选值: full (全量采集存量日志), increment (从当前时间点增量采集)。默认为 full。
	CollectPolicy *string `required:"true"`

	// 当 LogType 为delimiter 或multi_line_delimiter时可选，支持多字符分隔，需要转换成Base64
	Delimiter *string `required:"false"`

	// 日志原文的编码格式。可选值: utf-8, gbk。默认为 utf-8。
	Encode *string `required:"false"`

	// 日志提取正则表达式。当 logType 为正则模式 (如 full_regex,multi_line_full_regex) 时，用于从日志中提取字段。需要转换成Base64
	ExtractRule *string `required:"false"`

	//
	FilePaths []CreateULogServiceCollectConfParamFilePaths `required:"false"`

	// 索引字段key，是一个数组
	Keys []string `required:"false"`

	// 日志解析类型，决定了如何结构化日志。可选值: json:json 格式，delimiter:分隔符，full_regex:完全正则，multi_line_full_regex:多行完全正则，multi_line_delimiter: 多行分隔符正则，minimal_list:单行全文日志,multi_line:多行全文日志
	LogType *string `required:"true"`

	// 行首正则表达式。当 logType 为多行模式 (如 multi_line 或 multi_line_full_regex或multi_line_delimiter) 时，用于标识一条新日志的开始。需要转换成Base64
	MatchRule *string `required:"false"`

	// 配置名称
	Name *string `required:"true"`

	// 日志主题ID
	TopicId *string `required:"true"`

	// 如果 UnMatchUpload 为 true，无法解析的日志原文将被存放在此字段指定的 Key 下。默认为 LogParseFailure。
	UnMatchKey *string `required:"false"`
}

type CreateULogServiceCollectConfResponse struct {
	response.CommonBase

	// 错误信息
	Message string
}

type CreateULogServiceLogSetRequest struct {
	request.CommonBase

	// 日志集名称  长度为1~64位
	LogSetName *string `required:"true"`

	// 日志集备注  长度为0~255位
	LogSetRemark *string `required:"false"`
}

type CreateULogServiceLogSetResponse struct {
	response.CommonBase

	// 日志集资源ID
	LogSetId string
}

type CreateULogServiceMachineGroupRequest struct {
	request.CommonBase

	// 日志服务实例资源ID
	InstanceId *string `required:"true"`

	// 机器IP，如果Type是IP，那么Ips可以填写IP，是一个数组
	Ips *string `required:"false"`

	// 采集客户端识别标识，是一个数组
	Labels *string `required:"false"`

	// 机器组名称;格式校验：^[\w]{1,23}$
	Name *string `required:"true"`

	// 采集客户端识别模式;可选值 LABEL | IP;
	Type *string `required:"true"`
}

type CreateULogServiceMachineGroupResponse struct {
	response.CommonBase

	// 错误信息
	Message string
}

type CreateULogServiceTopicRequest struct {
	request.CommonBase

	// 日志集ID
	LogSetId *string `required:"true"`

	// 保存时间 1~730 天
	ReserveAge *int `required:"true"`

	// 主题名称，校验规则"^[\w]{1,64}$"
	TopicName *string `required:"true"`

	// 分区数量，固定是2
	TopicShardNum *int `required:"true"`
}

type CreateULogServiceTopicResponse struct {
	response.CommonBase

	// 主题ID
	TopicId string
}

type DeleteULogServiceCollectConfRequest struct {
	request.CommonBase

	// 日志主题采集配置ID
	CollectConfId *int `required:"true"`

	// 日志主题ID
	TopicId *string `required:"true"`
}

type DeleteULogServiceCollectConfResponse struct {
	response.CommonBase

	// 错误信息
	Message string
}

type DeleteULogServiceLogSetRequest struct {
	request.CommonBase

	// 日志集ID
	LogSetId *string `required:"true"`
}

type DeleteULogServiceLogSetResponse struct {
	response.CommonBase
}

type DeleteULogServiceMachineGroupRequest struct {
	request.CommonBase

	// 删除的机器组ID
	Id *int `required:"true"`
}

type DeleteULogServiceMachineGroupResponse struct {
	response.CommonBase

	// 错误信息
	Message string
}

type DeleteULogServiceTopicRequest struct {
	request.CommonBase

	// 主题Id
	TopicId *string `required:"true"`
}

type DeleteULogServiceTopicResponse struct {
	response.CommonBase

	// 错误信息，成功情况下为空字符串
	Message string
}

type DescribeULogServiceMachineGroupRequest struct {
	request.CommonBase

	// 机器组ID
	Id *string `required:"true"`
}

type DescribeULogServiceMachineGroupResponse struct {
	response.CommonBase

	// 机器组信息
	MachineGroup MachineInfo

	// 错误信息
	Message string
}

type FilePath struct {

	// 文件名
	File string

	// 路径
	Path string
}

type GetULogServiceTopicFieldRequest struct {
	request.CommonBase

	// 主题Id
	TopicId *string `required:"true"`
}

type GetULogServiceTopicFieldResponse struct {
	response.CommonBase

	// 索引字段数据，是一个数组
	Data []TopicField
}

type ListULogServiceCollectConfRequest struct {
	request.CommonBase

	// 采集配置ID
	CollectConfId *int `required:"false"`

	// 日志主题ID
	TopicId *int `required:"true"`
}

type ListULogServiceCollectConfResponse struct {
	response.CommonBase

	// 日志采集配置列表
	CollectConfs CollectConf

	// 错误信息
	Message string
}

type ListULogServiceLogSetRequest struct {
	request.CommonBase
}

type ListULogServiceLogSetResponse struct {
	response.CommonBase

	// 返回日志主题数据，是一个数组
	Data []LogSetInfo
}

type ListULogServiceMachineGroupRequest struct {
	request.CommonBase
}

type ListULogServiceMachineGroupResponse struct {
	response.CommonBase

	// 机器组信息列表
	MachineGroups []MachineGroup

	// 错误信息
	Message string
}

type ListULogServiceTopicRequest struct {
	request.CommonBase

	// 分页限制数,默认为30
	Limit *int `required:"false"`

	// 日志集ID
	LogSetId *string `required:"true"`

	// 分页起始条目数, 默认为0
	Offset *int `required:"false"`
}

type ListULogServiceTopicResponse struct {
	response.CommonBase

	// 主题列表
	Data []TopicInfo

	// 主题总数
	TotalCount int
}

type LogAgent struct {

	// LogAgent版本
	AgentVersion string

	// 主机IP
	HostIp string

	// logagent id
	InstanceId string

	// 主机标签
	Label string

	// 离线时间，单位是ms
	OffLineTime string

	// logagent状态，NORMAL：正常，OFFLINE： 离线
	Status string
}

type LogContent struct {

	// 日志文件路径
	FileName string

	// 日志来源主机
	HostName string

	// 日志标识ID
	LogId string

	// JSON格式的日志内容
	LogJson string

	// 日志时间
	Timestamp int
}

type LogQueryResult struct {

	// 当使用SQL语句查询时，数据通过该字段返回
	AnalysisRecords []string

	// 当使用SQL语句查询时，数据通过AnalysisRecords字段返回，Columns字段返回的是字段名和类型
	Columns []AnalysisField

	// 日志内容
	Contents LogContent

	// 检索结果是否到底
	IsOver bool

	// 滚动检索,当前页最后一条数据ID
	LastId string

	// 滚动检索,当前页最后一条数据Timestamp
	LastTimestamp string

	// 滚动检索Id Deprecated
	ScrollId string

	// 所属日志ID
	TopicId string

	// 所属日志名称
	TopicName string
}

type LogSetInfo struct {

	// 创建时间
	CreateTime int

	// 日志集名称
	LogSetName string

	// 日志集备注
	LogSetRemark string

	// 日志集下主题数量
	TopicCount int

	// 更新时间
	UpdateTime int
}

type MachineGroup struct {

	// 创建时间
	CreateTime int

	// 机器组ID
	Id string

	// 机器组名称
	Name string

	// 采集器识别类型：LABEL：机器标识，IP：IP类型
	Type string

	// 修改时间
	UpdateTime int
}

type MachineInfo struct {

	// 机器组ID
	Id int

	// 机器组Ip，数组类型
	Ips string

	// 机器组标签，数组类型
	Labels []string

	// LogAgent信息，数组类型
	LogAgents LogAgent

	// 机器组名称
	Name string

	// 机器组类型，取值有：LABEL和IP
	Type string
}

type QueryULogServiceLogRequest struct {
	request.CommonBase

	// 终止日志时间，秒级时间戳
	EndTime *int `required:"false"`

	// 滚动加载参数,上一页最后一条数据的ID
	LastId *string `required:"false"`

	// 滚动加载参数,上一页最后一条数据的timestamp
	LastTimestamp *string `required:"false"`

	// 查询条件，使用Base64编码。目前只支持查询索引，多个索引查询使用AND。比如:index1:http AND index2:http2
	QueryCriteria *string `required:"true"`

	// Deprecated. 滚动加载参数ScrollId
	ScrollId *string `required:"false"`

	// 一次返回条数，默认20。仅当检索分析语句不包含SQL时有效。SQL结果条数方式可以在SQL里使用limit语法。
	Size *int `required:"false"`

	// 日志时间排序;可选值ASC|DESC
	SortOrder *string `required:"true"`

	// 起始日志时间，秒级时间戳
	StartTime *int `required:"false"`

	// 主题ID
	TopicId *string `required:"true"`
}

type QueryULogServiceLogResponse struct {
	response.CommonBase

	// 请求结果
	Data LogQueryResult
}

type TopicField struct {

	// 索引名称
	FieldName string

	// 索引类型，可取的值有: long, double, text
	FieldType string

	// 是否保留字段，true表示保留字段，false表示非保留字段
	IsReserved bool
}

type TopicInfo struct {

	// 是否保留：0 - NORMAL, 1 - RESERVED
	IsReserved int

	// 保存时间 1~730 天
	ReserveAge int

	// 主题描述
	TopicDesc string

	// 主题ID
	TopicId string

	// 主题名称
	TopicName string

	// 分区数量，固定是2
	TopicShardNum int
}

type ULogServiceClient struct {
	*ucloud.Client
}

type UpdateULogServiceCollectConfParamFilePaths struct {

	// 定义采集路径的文件名，数组类型
	File *string `required:"false"`

	// 定义采集路径，数组类型
	Path *string `required:"false"`
}

type UpdateULogServiceCollectConfRequest struct {
	request.CommonBase

	// 日志主题采集配置ID
	CollectConfId *int `required:"true"`

	// 采集策略。可选值: full (全量采集存量日志), increment (从当前时间点增量采集)。默认为 full。
	CollectPolicy *string `required:"true"`

	// 当 LogType 为delimiter 或multi_line_delimiter时可选，支持多字符分隔，需要转换成Base64
	Delimiter *string `required:"false"`

	// 日志原文的编码格式。可选值: utf-8, gbk。默认为 utf-8。
	Encode *string `required:"false"`

	// 日志提取正则表达式。当 logType 为正则模式 (如 full_regex,multi_line_full_regex) 时，用于从日志中提取字段。需要转换成Base64
	ExtractRule *string `required:"false"`

	//
	FilePaths []UpdateULogServiceCollectConfParamFilePaths `required:"false"`

	// 索引字段key，是一个数组
	Keys []string `required:"false"`

	// 日志解析类型，决定了如何结构化日志。可选值: json:json 格式，delimiter:分隔符，full_regex:完全正则，multi_line_full_regex:多行完全正则，multi_line_delimiter: 多行分隔符正则，minimal_list:单行全文日志,multi_line:多行全文日志
	LogType *string `required:"true"`

	// 行首正则表达式。当 logType 为多行模式 (如 multi_line 或 multi_line_full_regex或multi_line_delimiter) 时，用于标识一条新日志的开始。需要转换成Base64
	MatchRule *string `required:"false"`

	// 日志主题ID
	TopicId *string `required:"true"`

	// 如果 UnMatchUpload 为 true，无法解析的日志原文将被存放在此字段指定的 Key 下。默认为 LogParseFailure。
	UnMatchKey *string `required:"false"`
}

type UpdateULogServiceCollectConfResponse struct {
	response.CommonBase

	// 错误信息
	Message string
}

type UpdateULogServiceMachineGroupRequest struct {
	request.CommonBase

	// 机器组ID
	Id *int `required:"true"`

	// 机器IP，如果Type是IP，那么Ips可以填写IP，是一个数组
	Ips *string `required:"false"`

	// 采集客户端识别标识，数组类型
	Labels *string `required:"false"`

	// 机器组名称; 格式校验：^[\w]{1,255}$
	Name *string `required:"true"`

	// 采集客户端识别模式;可选值 LABEL | IP;
	Type *string `required:"true"`
}

type UpdateULogServiceMachineGroupResponse struct {
	response.CommonBase

	// 错误信息
	Message string
}

type UpdateULogServiceTopicFieldParamFieldInfos struct {

	// 字段名称支持字母、横线(-)、斜杠(/)、特殊符号（@）、数字、下划线（_）和点（.），且不能以下划线开头，长度不超过255个字符
	FieldName *string `required:"false"`

	// 主题字段类型（text、long、double）
	FieldType *string `required:"false"`
}

type UpdateULogServiceTopicFieldRequest struct {
	request.CommonBase

	//
	FieldInfos []UpdateULogServiceTopicFieldParamFieldInfos `required:"false"`

	// 主题Id
	TopicId *string `required:"true"`
}

type UpdateULogServiceTopicFieldResponse struct {
	response.CommonBase
}