Class: TencentCloud::Teo::V20220901::CreateRealtimeLogDeliveryTaskRequest

Inherits:
Common::AbstractModel
  • Object
show all
Defined in:
lib/v20220901/models.rb

Overview

CreateRealtimeLogDeliveryTask请求参数结构体

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(zoneid = nil, taskname = nil, tasktype = nil, entitylist = nil, logtype = nil, area = nil, fields = nil, customfields = nil, deliveryconditions = nil, sample = nil, logformat = nil, cls = nil, customendpoint = nil, s3 = nil) ⇒ CreateRealtimeLogDeliveryTaskRequest

Returns a new instance of CreateRealtimeLogDeliveryTaskRequest.



5138
5139
5140
5141
5142
5143
5144
5145
5146
5147
5148
5149
5150
5151
5152
5153
# File 'lib/v20220901/models.rb', line 5138

def initialize(zoneid=nil, taskname=nil, tasktype=nil, entitylist=nil, logtype=nil, area=nil, fields=nil, customfields=nil, deliveryconditions=nil, sample=nil, logformat=nil, cls=nil, customendpoint=nil, s3=nil)
  @ZoneId = zoneid
  @TaskName = taskname
  @TaskType = tasktype
  @EntityList = entitylist
  @LogType = logtype
  @Area = area
  @Fields = fields
  @CustomFields = customfields
  @DeliveryConditions = deliveryconditions
  @Sample = sample
  @LogFormat = logformat
  @CLS = cls
  @CustomEndpoint = customendpoint
  @S3 = s3
end

Instance Attribute Details

#AreaObject

<li>cls: 推送到腾讯云 CLS;</li> <li>custom_endpoint:推送到自定义 HTTP(S) 地址;</li> <li>s3:推送到 AWS S3 兼容存储桶地址;</li> <li>log_analysis:推送到 EdgeOne 日志分析,该任务类型仅支持“站点加速日志”这一数据投递类型。</li> <li>七层域名:domain.example.com</li> <li>四层代理实例:sid-2s69eb5wcms7</li> <li>边缘函数实例:test-zone-2mxigizoh9l9-1257626257</li> <li>domain:站点加速日志;</li> <li>application:四层代理日志;</li> <li>function:边缘函数运行日志;</li> <li>web-rateLiming:速率限制和 CC 攻击防护日志;</li> <li>web-attack:托管规则日志;</li> <li>web-rule:自定义规则日志;</li> <li>web-bot:Bot管理日志。</li> <li>mainland:中国大陆境内;</li> <li>overseas:全球(不含中国大陆)。</li> <li>(cloud.tencent.com/document/product/1552/105791)</li> <li>(cloud.tencent.com/document/product/1552/105792)</li> <li>(cloud.tencent.com/document/product/1552/115585)</li> <li>当 TaskType 取值为 custom_endpoint 时,默认格式为多个 JSON 对象组成的数组,每个 JSON 对象为一条日志;</li> <li>当 TaskType 取值为 s3 时,默认格式为 JSON Lines;</li>特别地,当 TaskType 取值为 cls 或 log_analysis 时,LogFormat.FormatType 的值只能为 json,且 LogFormat 中其他参数将被忽略,建议不传 LogFormat。

Parameters:

  • ZoneId:

    站点 ID。

  • TaskName:

    实时日志投递任务的名称,格式为数字、英文、-和_组合,最多 200 个字符。

  • TaskType:

    实时日志投递任务类型,取值有:

  • EntityList:

    实时日志投递任务对应的实体列表。取值示例如下:

  • LogType:

    数据投递类型,取值有:

  • Area:

    数据投递区域,取值有:

  • Fields:

    投递的预设字段列表。取值参考:

  • CustomFields:

    投递的自定义字段列表,支持在 HTTP 请求头、响应头、Cookie、请求正文中提取指定内容。自定义字段名称不能重复,且最多不能超过 200 个字段。单个实时日志推送任务最多添加 5 个请求正文类型的自定义字段。目前仅站点加速日志(LogType=domain)支持添加自定义字段。

  • DeliveryConditions:

    日志投递的过滤条件,不填表示投递全量日志。

  • Sample:

    采样比例,采用千分制,取值范围为1-1000,例如:填写 605 表示采样比例为 60.5%。不填表示采样比例为 100%。

  • LogFormat:

    日志投递的输出格式。不填表示为默认格式,默认格式逻辑如下:

  • CLS:

    CLS 的配置信息。当 TaskType 取值为 cls 时,该参数必填。

  • CustomEndpoint:

    自定义 HTTP 服务的配置信息。当 TaskType 取值为 custom_endpoint 时,该参数必填。

  • S3:

    AWS S3 兼容存储桶的配置信息。当 TaskType 取值为 s3 时,该参数必填。



5136
5137
5138
# File 'lib/v20220901/models.rb', line 5136

def Area
  @Area
end

#CLSObject

<li>cls: 推送到腾讯云 CLS;</li> <li>custom_endpoint:推送到自定义 HTTP(S) 地址;</li> <li>s3:推送到 AWS S3 兼容存储桶地址;</li> <li>log_analysis:推送到 EdgeOne 日志分析,该任务类型仅支持“站点加速日志”这一数据投递类型。</li> <li>七层域名:domain.example.com</li> <li>四层代理实例:sid-2s69eb5wcms7</li> <li>边缘函数实例:test-zone-2mxigizoh9l9-1257626257</li> <li>domain:站点加速日志;</li> <li>application:四层代理日志;</li> <li>function:边缘函数运行日志;</li> <li>web-rateLiming:速率限制和 CC 攻击防护日志;</li> <li>web-attack:托管规则日志;</li> <li>web-rule:自定义规则日志;</li> <li>web-bot:Bot管理日志。</li> <li>mainland:中国大陆境内;</li> <li>overseas:全球(不含中国大陆)。</li> <li>(cloud.tencent.com/document/product/1552/105791)</li> <li>(cloud.tencent.com/document/product/1552/105792)</li> <li>(cloud.tencent.com/document/product/1552/115585)</li> <li>当 TaskType 取值为 custom_endpoint 时,默认格式为多个 JSON 对象组成的数组,每个 JSON 对象为一条日志;</li> <li>当 TaskType 取值为 s3 时,默认格式为 JSON Lines;</li>特别地,当 TaskType 取值为 cls 或 log_analysis 时,LogFormat.FormatType 的值只能为 json,且 LogFormat 中其他参数将被忽略,建议不传 LogFormat。

Parameters:

  • ZoneId:

    站点 ID。

  • TaskName:

    实时日志投递任务的名称,格式为数字、英文、-和_组合,最多 200 个字符。

  • TaskType:

    实时日志投递任务类型,取值有:

  • EntityList:

    实时日志投递任务对应的实体列表。取值示例如下:

  • LogType:

    数据投递类型,取值有:

  • Area:

    数据投递区域,取值有:

  • Fields:

    投递的预设字段列表。取值参考:

  • CustomFields:

    投递的自定义字段列表,支持在 HTTP 请求头、响应头、Cookie、请求正文中提取指定内容。自定义字段名称不能重复,且最多不能超过 200 个字段。单个实时日志推送任务最多添加 5 个请求正文类型的自定义字段。目前仅站点加速日志(LogType=domain)支持添加自定义字段。

  • DeliveryConditions:

    日志投递的过滤条件,不填表示投递全量日志。

  • Sample:

    采样比例,采用千分制,取值范围为1-1000,例如:填写 605 表示采样比例为 60.5%。不填表示采样比例为 100%。

  • LogFormat:

    日志投递的输出格式。不填表示为默认格式,默认格式逻辑如下:

  • CLS:

    CLS 的配置信息。当 TaskType 取值为 cls 时,该参数必填。

  • CustomEndpoint:

    自定义 HTTP 服务的配置信息。当 TaskType 取值为 custom_endpoint 时,该参数必填。

  • S3:

    AWS S3 兼容存储桶的配置信息。当 TaskType 取值为 s3 时,该参数必填。



5136
5137
5138
# File 'lib/v20220901/models.rb', line 5136

def CLS
  @CLS
end

#CustomEndpointObject

<li>cls: 推送到腾讯云 CLS;</li> <li>custom_endpoint:推送到自定义 HTTP(S) 地址;</li> <li>s3:推送到 AWS S3 兼容存储桶地址;</li> <li>log_analysis:推送到 EdgeOne 日志分析,该任务类型仅支持“站点加速日志”这一数据投递类型。</li> <li>七层域名:domain.example.com</li> <li>四层代理实例:sid-2s69eb5wcms7</li> <li>边缘函数实例:test-zone-2mxigizoh9l9-1257626257</li> <li>domain:站点加速日志;</li> <li>application:四层代理日志;</li> <li>function:边缘函数运行日志;</li> <li>web-rateLiming:速率限制和 CC 攻击防护日志;</li> <li>web-attack:托管规则日志;</li> <li>web-rule:自定义规则日志;</li> <li>web-bot:Bot管理日志。</li> <li>mainland:中国大陆境内;</li> <li>overseas:全球(不含中国大陆)。</li> <li>(cloud.tencent.com/document/product/1552/105791)</li> <li>(cloud.tencent.com/document/product/1552/105792)</li> <li>(cloud.tencent.com/document/product/1552/115585)</li> <li>当 TaskType 取值为 custom_endpoint 时,默认格式为多个 JSON 对象组成的数组,每个 JSON 对象为一条日志;</li> <li>当 TaskType 取值为 s3 时,默认格式为 JSON Lines;</li>特别地,当 TaskType 取值为 cls 或 log_analysis 时,LogFormat.FormatType 的值只能为 json,且 LogFormat 中其他参数将被忽略,建议不传 LogFormat。

Parameters:

  • ZoneId:

    站点 ID。

  • TaskName:

    实时日志投递任务的名称,格式为数字、英文、-和_组合,最多 200 个字符。

  • TaskType:

    实时日志投递任务类型,取值有:

  • EntityList:

    实时日志投递任务对应的实体列表。取值示例如下:

  • LogType:

    数据投递类型,取值有:

  • Area:

    数据投递区域,取值有:

  • Fields:

    投递的预设字段列表。取值参考:

  • CustomFields:

    投递的自定义字段列表,支持在 HTTP 请求头、响应头、Cookie、请求正文中提取指定内容。自定义字段名称不能重复,且最多不能超过 200 个字段。单个实时日志推送任务最多添加 5 个请求正文类型的自定义字段。目前仅站点加速日志(LogType=domain)支持添加自定义字段。

  • DeliveryConditions:

    日志投递的过滤条件,不填表示投递全量日志。

  • Sample:

    采样比例,采用千分制,取值范围为1-1000,例如:填写 605 表示采样比例为 60.5%。不填表示采样比例为 100%。

  • LogFormat:

    日志投递的输出格式。不填表示为默认格式,默认格式逻辑如下:

  • CLS:

    CLS 的配置信息。当 TaskType 取值为 cls 时,该参数必填。

  • CustomEndpoint:

    自定义 HTTP 服务的配置信息。当 TaskType 取值为 custom_endpoint 时,该参数必填。

  • S3:

    AWS S3 兼容存储桶的配置信息。当 TaskType 取值为 s3 时,该参数必填。



5136
5137
5138
# File 'lib/v20220901/models.rb', line 5136

def CustomEndpoint
  @CustomEndpoint
end

#CustomFieldsObject

<li>cls: 推送到腾讯云 CLS;</li> <li>custom_endpoint:推送到自定义 HTTP(S) 地址;</li> <li>s3:推送到 AWS S3 兼容存储桶地址;</li> <li>log_analysis:推送到 EdgeOne 日志分析,该任务类型仅支持“站点加速日志”这一数据投递类型。</li> <li>七层域名:domain.example.com</li> <li>四层代理实例:sid-2s69eb5wcms7</li> <li>边缘函数实例:test-zone-2mxigizoh9l9-1257626257</li> <li>domain:站点加速日志;</li> <li>application:四层代理日志;</li> <li>function:边缘函数运行日志;</li> <li>web-rateLiming:速率限制和 CC 攻击防护日志;</li> <li>web-attack:托管规则日志;</li> <li>web-rule:自定义规则日志;</li> <li>web-bot:Bot管理日志。</li> <li>mainland:中国大陆境内;</li> <li>overseas:全球(不含中国大陆)。</li> <li>(cloud.tencent.com/document/product/1552/105791)</li> <li>(cloud.tencent.com/document/product/1552/105792)</li> <li>(cloud.tencent.com/document/product/1552/115585)</li> <li>当 TaskType 取值为 custom_endpoint 时,默认格式为多个 JSON 对象组成的数组,每个 JSON 对象为一条日志;</li> <li>当 TaskType 取值为 s3 时,默认格式为 JSON Lines;</li>特别地,当 TaskType 取值为 cls 或 log_analysis 时,LogFormat.FormatType 的值只能为 json,且 LogFormat 中其他参数将被忽略,建议不传 LogFormat。

Parameters:

  • ZoneId:

    站点 ID。

  • TaskName:

    实时日志投递任务的名称,格式为数字、英文、-和_组合,最多 200 个字符。

  • TaskType:

    实时日志投递任务类型,取值有:

  • EntityList:

    实时日志投递任务对应的实体列表。取值示例如下:

  • LogType:

    数据投递类型,取值有:

  • Area:

    数据投递区域,取值有:

  • Fields:

    投递的预设字段列表。取值参考:

  • CustomFields:

    投递的自定义字段列表,支持在 HTTP 请求头、响应头、Cookie、请求正文中提取指定内容。自定义字段名称不能重复,且最多不能超过 200 个字段。单个实时日志推送任务最多添加 5 个请求正文类型的自定义字段。目前仅站点加速日志(LogType=domain)支持添加自定义字段。

  • DeliveryConditions:

    日志投递的过滤条件,不填表示投递全量日志。

  • Sample:

    采样比例,采用千分制,取值范围为1-1000,例如:填写 605 表示采样比例为 60.5%。不填表示采样比例为 100%。

  • LogFormat:

    日志投递的输出格式。不填表示为默认格式,默认格式逻辑如下:

  • CLS:

    CLS 的配置信息。当 TaskType 取值为 cls 时,该参数必填。

  • CustomEndpoint:

    自定义 HTTP 服务的配置信息。当 TaskType 取值为 custom_endpoint 时,该参数必填。

  • S3:

    AWS S3 兼容存储桶的配置信息。当 TaskType 取值为 s3 时,该参数必填。



5136
5137
5138
# File 'lib/v20220901/models.rb', line 5136

def CustomFields
  @CustomFields
end

#DeliveryConditionsObject

<li>cls: 推送到腾讯云 CLS;</li> <li>custom_endpoint:推送到自定义 HTTP(S) 地址;</li> <li>s3:推送到 AWS S3 兼容存储桶地址;</li> <li>log_analysis:推送到 EdgeOne 日志分析,该任务类型仅支持“站点加速日志”这一数据投递类型。</li> <li>七层域名:domain.example.com</li> <li>四层代理实例:sid-2s69eb5wcms7</li> <li>边缘函数实例:test-zone-2mxigizoh9l9-1257626257</li> <li>domain:站点加速日志;</li> <li>application:四层代理日志;</li> <li>function:边缘函数运行日志;</li> <li>web-rateLiming:速率限制和 CC 攻击防护日志;</li> <li>web-attack:托管规则日志;</li> <li>web-rule:自定义规则日志;</li> <li>web-bot:Bot管理日志。</li> <li>mainland:中国大陆境内;</li> <li>overseas:全球(不含中国大陆)。</li> <li>(cloud.tencent.com/document/product/1552/105791)</li> <li>(cloud.tencent.com/document/product/1552/105792)</li> <li>(cloud.tencent.com/document/product/1552/115585)</li> <li>当 TaskType 取值为 custom_endpoint 时,默认格式为多个 JSON 对象组成的数组,每个 JSON 对象为一条日志;</li> <li>当 TaskType 取值为 s3 时,默认格式为 JSON Lines;</li>特别地,当 TaskType 取值为 cls 或 log_analysis 时,LogFormat.FormatType 的值只能为 json,且 LogFormat 中其他参数将被忽略,建议不传 LogFormat。

Parameters:

  • ZoneId:

    站点 ID。

  • TaskName:

    实时日志投递任务的名称,格式为数字、英文、-和_组合,最多 200 个字符。

  • TaskType:

    实时日志投递任务类型,取值有:

  • EntityList:

    实时日志投递任务对应的实体列表。取值示例如下:

  • LogType:

    数据投递类型,取值有:

  • Area:

    数据投递区域,取值有:

  • Fields:

    投递的预设字段列表。取值参考:

  • CustomFields:

    投递的自定义字段列表,支持在 HTTP 请求头、响应头、Cookie、请求正文中提取指定内容。自定义字段名称不能重复,且最多不能超过 200 个字段。单个实时日志推送任务最多添加 5 个请求正文类型的自定义字段。目前仅站点加速日志(LogType=domain)支持添加自定义字段。

  • DeliveryConditions:

    日志投递的过滤条件,不填表示投递全量日志。

  • Sample:

    采样比例,采用千分制,取值范围为1-1000,例如:填写 605 表示采样比例为 60.5%。不填表示采样比例为 100%。

  • LogFormat:

    日志投递的输出格式。不填表示为默认格式,默认格式逻辑如下:

  • CLS:

    CLS 的配置信息。当 TaskType 取值为 cls 时,该参数必填。

  • CustomEndpoint:

    自定义 HTTP 服务的配置信息。当 TaskType 取值为 custom_endpoint 时,该参数必填。

  • S3:

    AWS S3 兼容存储桶的配置信息。当 TaskType 取值为 s3 时,该参数必填。



5136
5137
5138
# File 'lib/v20220901/models.rb', line 5136

def DeliveryConditions
  @DeliveryConditions
end

#EntityListObject

<li>cls: 推送到腾讯云 CLS;</li> <li>custom_endpoint:推送到自定义 HTTP(S) 地址;</li> <li>s3:推送到 AWS S3 兼容存储桶地址;</li> <li>log_analysis:推送到 EdgeOne 日志分析,该任务类型仅支持“站点加速日志”这一数据投递类型。</li> <li>七层域名:domain.example.com</li> <li>四层代理实例:sid-2s69eb5wcms7</li> <li>边缘函数实例:test-zone-2mxigizoh9l9-1257626257</li> <li>domain:站点加速日志;</li> <li>application:四层代理日志;</li> <li>function:边缘函数运行日志;</li> <li>web-rateLiming:速率限制和 CC 攻击防护日志;</li> <li>web-attack:托管规则日志;</li> <li>web-rule:自定义规则日志;</li> <li>web-bot:Bot管理日志。</li> <li>mainland:中国大陆境内;</li> <li>overseas:全球(不含中国大陆)。</li> <li>(cloud.tencent.com/document/product/1552/105791)</li> <li>(cloud.tencent.com/document/product/1552/105792)</li> <li>(cloud.tencent.com/document/product/1552/115585)</li> <li>当 TaskType 取值为 custom_endpoint 时,默认格式为多个 JSON 对象组成的数组,每个 JSON 对象为一条日志;</li> <li>当 TaskType 取值为 s3 时,默认格式为 JSON Lines;</li>特别地,当 TaskType 取值为 cls 或 log_analysis 时,LogFormat.FormatType 的值只能为 json,且 LogFormat 中其他参数将被忽略,建议不传 LogFormat。

Parameters:

  • ZoneId:

    站点 ID。

  • TaskName:

    实时日志投递任务的名称,格式为数字、英文、-和_组合,最多 200 个字符。

  • TaskType:

    实时日志投递任务类型,取值有:

  • EntityList:

    实时日志投递任务对应的实体列表。取值示例如下:

  • LogType:

    数据投递类型,取值有:

  • Area:

    数据投递区域,取值有:

  • Fields:

    投递的预设字段列表。取值参考:

  • CustomFields:

    投递的自定义字段列表,支持在 HTTP 请求头、响应头、Cookie、请求正文中提取指定内容。自定义字段名称不能重复,且最多不能超过 200 个字段。单个实时日志推送任务最多添加 5 个请求正文类型的自定义字段。目前仅站点加速日志(LogType=domain)支持添加自定义字段。

  • DeliveryConditions:

    日志投递的过滤条件,不填表示投递全量日志。

  • Sample:

    采样比例,采用千分制,取值范围为1-1000,例如:填写 605 表示采样比例为 60.5%。不填表示采样比例为 100%。

  • LogFormat:

    日志投递的输出格式。不填表示为默认格式,默认格式逻辑如下:

  • CLS:

    CLS 的配置信息。当 TaskType 取值为 cls 时,该参数必填。

  • CustomEndpoint:

    自定义 HTTP 服务的配置信息。当 TaskType 取值为 custom_endpoint 时,该参数必填。

  • S3:

    AWS S3 兼容存储桶的配置信息。当 TaskType 取值为 s3 时,该参数必填。



5136
5137
5138
# File 'lib/v20220901/models.rb', line 5136

def EntityList
  @EntityList
end

#FieldsObject

<li>cls: 推送到腾讯云 CLS;</li> <li>custom_endpoint:推送到自定义 HTTP(S) 地址;</li> <li>s3:推送到 AWS S3 兼容存储桶地址;</li> <li>log_analysis:推送到 EdgeOne 日志分析,该任务类型仅支持“站点加速日志”这一数据投递类型。</li> <li>七层域名:domain.example.com</li> <li>四层代理实例:sid-2s69eb5wcms7</li> <li>边缘函数实例:test-zone-2mxigizoh9l9-1257626257</li> <li>domain:站点加速日志;</li> <li>application:四层代理日志;</li> <li>function:边缘函数运行日志;</li> <li>web-rateLiming:速率限制和 CC 攻击防护日志;</li> <li>web-attack:托管规则日志;</li> <li>web-rule:自定义规则日志;</li> <li>web-bot:Bot管理日志。</li> <li>mainland:中国大陆境内;</li> <li>overseas:全球(不含中国大陆)。</li> <li>(cloud.tencent.com/document/product/1552/105791)</li> <li>(cloud.tencent.com/document/product/1552/105792)</li> <li>(cloud.tencent.com/document/product/1552/115585)</li> <li>当 TaskType 取值为 custom_endpoint 时,默认格式为多个 JSON 对象组成的数组,每个 JSON 对象为一条日志;</li> <li>当 TaskType 取值为 s3 时,默认格式为 JSON Lines;</li>特别地,当 TaskType 取值为 cls 或 log_analysis 时,LogFormat.FormatType 的值只能为 json,且 LogFormat 中其他参数将被忽略,建议不传 LogFormat。

Parameters:

  • ZoneId:

    站点 ID。

  • TaskName:

    实时日志投递任务的名称,格式为数字、英文、-和_组合,最多 200 个字符。

  • TaskType:

    实时日志投递任务类型,取值有:

  • EntityList:

    实时日志投递任务对应的实体列表。取值示例如下:

  • LogType:

    数据投递类型,取值有:

  • Area:

    数据投递区域,取值有:

  • Fields:

    投递的预设字段列表。取值参考:

  • CustomFields:

    投递的自定义字段列表,支持在 HTTP 请求头、响应头、Cookie、请求正文中提取指定内容。自定义字段名称不能重复,且最多不能超过 200 个字段。单个实时日志推送任务最多添加 5 个请求正文类型的自定义字段。目前仅站点加速日志(LogType=domain)支持添加自定义字段。

  • DeliveryConditions:

    日志投递的过滤条件,不填表示投递全量日志。

  • Sample:

    采样比例,采用千分制,取值范围为1-1000,例如:填写 605 表示采样比例为 60.5%。不填表示采样比例为 100%。

  • LogFormat:

    日志投递的输出格式。不填表示为默认格式,默认格式逻辑如下:

  • CLS:

    CLS 的配置信息。当 TaskType 取值为 cls 时,该参数必填。

  • CustomEndpoint:

    自定义 HTTP 服务的配置信息。当 TaskType 取值为 custom_endpoint 时,该参数必填。

  • S3:

    AWS S3 兼容存储桶的配置信息。当 TaskType 取值为 s3 时,该参数必填。



5136
5137
5138
# File 'lib/v20220901/models.rb', line 5136

def Fields
  @Fields
end

#LogFormatObject

<li>cls: 推送到腾讯云 CLS;</li> <li>custom_endpoint:推送到自定义 HTTP(S) 地址;</li> <li>s3:推送到 AWS S3 兼容存储桶地址;</li> <li>log_analysis:推送到 EdgeOne 日志分析,该任务类型仅支持“站点加速日志”这一数据投递类型。</li> <li>七层域名:domain.example.com</li> <li>四层代理实例:sid-2s69eb5wcms7</li> <li>边缘函数实例:test-zone-2mxigizoh9l9-1257626257</li> <li>domain:站点加速日志;</li> <li>application:四层代理日志;</li> <li>function:边缘函数运行日志;</li> <li>web-rateLiming:速率限制和 CC 攻击防护日志;</li> <li>web-attack:托管规则日志;</li> <li>web-rule:自定义规则日志;</li> <li>web-bot:Bot管理日志。</li> <li>mainland:中国大陆境内;</li> <li>overseas:全球(不含中国大陆)。</li> <li>(cloud.tencent.com/document/product/1552/105791)</li> <li>(cloud.tencent.com/document/product/1552/105792)</li> <li>(cloud.tencent.com/document/product/1552/115585)</li> <li>当 TaskType 取值为 custom_endpoint 时,默认格式为多个 JSON 对象组成的数组,每个 JSON 对象为一条日志;</li> <li>当 TaskType 取值为 s3 时,默认格式为 JSON Lines;</li>特别地,当 TaskType 取值为 cls 或 log_analysis 时,LogFormat.FormatType 的值只能为 json,且 LogFormat 中其他参数将被忽略,建议不传 LogFormat。

Parameters:

  • ZoneId:

    站点 ID。

  • TaskName:

    实时日志投递任务的名称,格式为数字、英文、-和_组合,最多 200 个字符。

  • TaskType:

    实时日志投递任务类型,取值有:

  • EntityList:

    实时日志投递任务对应的实体列表。取值示例如下:

  • LogType:

    数据投递类型,取值有:

  • Area:

    数据投递区域,取值有:

  • Fields:

    投递的预设字段列表。取值参考:

  • CustomFields:

    投递的自定义字段列表,支持在 HTTP 请求头、响应头、Cookie、请求正文中提取指定内容。自定义字段名称不能重复,且最多不能超过 200 个字段。单个实时日志推送任务最多添加 5 个请求正文类型的自定义字段。目前仅站点加速日志(LogType=domain)支持添加自定义字段。

  • DeliveryConditions:

    日志投递的过滤条件,不填表示投递全量日志。

  • Sample:

    采样比例,采用千分制,取值范围为1-1000,例如:填写 605 表示采样比例为 60.5%。不填表示采样比例为 100%。

  • LogFormat:

    日志投递的输出格式。不填表示为默认格式,默认格式逻辑如下:

  • CLS:

    CLS 的配置信息。当 TaskType 取值为 cls 时,该参数必填。

  • CustomEndpoint:

    自定义 HTTP 服务的配置信息。当 TaskType 取值为 custom_endpoint 时,该参数必填。

  • S3:

    AWS S3 兼容存储桶的配置信息。当 TaskType 取值为 s3 时,该参数必填。



5136
5137
5138
# File 'lib/v20220901/models.rb', line 5136

def LogFormat
  @LogFormat
end

#LogTypeObject

<li>cls: 推送到腾讯云 CLS;</li> <li>custom_endpoint:推送到自定义 HTTP(S) 地址;</li> <li>s3:推送到 AWS S3 兼容存储桶地址;</li> <li>log_analysis:推送到 EdgeOne 日志分析,该任务类型仅支持“站点加速日志”这一数据投递类型。</li> <li>七层域名:domain.example.com</li> <li>四层代理实例:sid-2s69eb5wcms7</li> <li>边缘函数实例:test-zone-2mxigizoh9l9-1257626257</li> <li>domain:站点加速日志;</li> <li>application:四层代理日志;</li> <li>function:边缘函数运行日志;</li> <li>web-rateLiming:速率限制和 CC 攻击防护日志;</li> <li>web-attack:托管规则日志;</li> <li>web-rule:自定义规则日志;</li> <li>web-bot:Bot管理日志。</li> <li>mainland:中国大陆境内;</li> <li>overseas:全球(不含中国大陆)。</li> <li>(cloud.tencent.com/document/product/1552/105791)</li> <li>(cloud.tencent.com/document/product/1552/105792)</li> <li>(cloud.tencent.com/document/product/1552/115585)</li> <li>当 TaskType 取值为 custom_endpoint 时,默认格式为多个 JSON 对象组成的数组,每个 JSON 对象为一条日志;</li> <li>当 TaskType 取值为 s3 时,默认格式为 JSON Lines;</li>特别地,当 TaskType 取值为 cls 或 log_analysis 时,LogFormat.FormatType 的值只能为 json,且 LogFormat 中其他参数将被忽略,建议不传 LogFormat。

Parameters:

  • ZoneId:

    站点 ID。

  • TaskName:

    实时日志投递任务的名称,格式为数字、英文、-和_组合,最多 200 个字符。

  • TaskType:

    实时日志投递任务类型,取值有:

  • EntityList:

    实时日志投递任务对应的实体列表。取值示例如下:

  • LogType:

    数据投递类型,取值有:

  • Area:

    数据投递区域,取值有:

  • Fields:

    投递的预设字段列表。取值参考:

  • CustomFields:

    投递的自定义字段列表,支持在 HTTP 请求头、响应头、Cookie、请求正文中提取指定内容。自定义字段名称不能重复,且最多不能超过 200 个字段。单个实时日志推送任务最多添加 5 个请求正文类型的自定义字段。目前仅站点加速日志(LogType=domain)支持添加自定义字段。

  • DeliveryConditions:

    日志投递的过滤条件,不填表示投递全量日志。

  • Sample:

    采样比例,采用千分制,取值范围为1-1000,例如:填写 605 表示采样比例为 60.5%。不填表示采样比例为 100%。

  • LogFormat:

    日志投递的输出格式。不填表示为默认格式,默认格式逻辑如下:

  • CLS:

    CLS 的配置信息。当 TaskType 取值为 cls 时,该参数必填。

  • CustomEndpoint:

    自定义 HTTP 服务的配置信息。当 TaskType 取值为 custom_endpoint 时,该参数必填。

  • S3:

    AWS S3 兼容存储桶的配置信息。当 TaskType 取值为 s3 时,该参数必填。



5136
5137
5138
# File 'lib/v20220901/models.rb', line 5136

def LogType
  @LogType
end

#S3Object

<li>cls: 推送到腾讯云 CLS;</li> <li>custom_endpoint:推送到自定义 HTTP(S) 地址;</li> <li>s3:推送到 AWS S3 兼容存储桶地址;</li> <li>log_analysis:推送到 EdgeOne 日志分析,该任务类型仅支持“站点加速日志”这一数据投递类型。</li> <li>七层域名:domain.example.com</li> <li>四层代理实例:sid-2s69eb5wcms7</li> <li>边缘函数实例:test-zone-2mxigizoh9l9-1257626257</li> <li>domain:站点加速日志;</li> <li>application:四层代理日志;</li> <li>function:边缘函数运行日志;</li> <li>web-rateLiming:速率限制和 CC 攻击防护日志;</li> <li>web-attack:托管规则日志;</li> <li>web-rule:自定义规则日志;</li> <li>web-bot:Bot管理日志。</li> <li>mainland:中国大陆境内;</li> <li>overseas:全球(不含中国大陆)。</li> <li>(cloud.tencent.com/document/product/1552/105791)</li> <li>(cloud.tencent.com/document/product/1552/105792)</li> <li>(cloud.tencent.com/document/product/1552/115585)</li> <li>当 TaskType 取值为 custom_endpoint 时,默认格式为多个 JSON 对象组成的数组,每个 JSON 对象为一条日志;</li> <li>当 TaskType 取值为 s3 时,默认格式为 JSON Lines;</li>特别地,当 TaskType 取值为 cls 或 log_analysis 时,LogFormat.FormatType 的值只能为 json,且 LogFormat 中其他参数将被忽略,建议不传 LogFormat。

Parameters:

  • ZoneId:

    站点 ID。

  • TaskName:

    实时日志投递任务的名称,格式为数字、英文、-和_组合,最多 200 个字符。

  • TaskType:

    实时日志投递任务类型,取值有:

  • EntityList:

    实时日志投递任务对应的实体列表。取值示例如下:

  • LogType:

    数据投递类型,取值有:

  • Area:

    数据投递区域,取值有:

  • Fields:

    投递的预设字段列表。取值参考:

  • CustomFields:

    投递的自定义字段列表,支持在 HTTP 请求头、响应头、Cookie、请求正文中提取指定内容。自定义字段名称不能重复,且最多不能超过 200 个字段。单个实时日志推送任务最多添加 5 个请求正文类型的自定义字段。目前仅站点加速日志(LogType=domain)支持添加自定义字段。

  • DeliveryConditions:

    日志投递的过滤条件,不填表示投递全量日志。

  • Sample:

    采样比例,采用千分制,取值范围为1-1000,例如:填写 605 表示采样比例为 60.5%。不填表示采样比例为 100%。

  • LogFormat:

    日志投递的输出格式。不填表示为默认格式,默认格式逻辑如下:

  • CLS:

    CLS 的配置信息。当 TaskType 取值为 cls 时,该参数必填。

  • CustomEndpoint:

    自定义 HTTP 服务的配置信息。当 TaskType 取值为 custom_endpoint 时,该参数必填。

  • S3:

    AWS S3 兼容存储桶的配置信息。当 TaskType 取值为 s3 时,该参数必填。



5136
5137
5138
# File 'lib/v20220901/models.rb', line 5136

def S3
  @S3
end

#SampleObject

<li>cls: 推送到腾讯云 CLS;</li> <li>custom_endpoint:推送到自定义 HTTP(S) 地址;</li> <li>s3:推送到 AWS S3 兼容存储桶地址;</li> <li>log_analysis:推送到 EdgeOne 日志分析,该任务类型仅支持“站点加速日志”这一数据投递类型。</li> <li>七层域名:domain.example.com</li> <li>四层代理实例:sid-2s69eb5wcms7</li> <li>边缘函数实例:test-zone-2mxigizoh9l9-1257626257</li> <li>domain:站点加速日志;</li> <li>application:四层代理日志;</li> <li>function:边缘函数运行日志;</li> <li>web-rateLiming:速率限制和 CC 攻击防护日志;</li> <li>web-attack:托管规则日志;</li> <li>web-rule:自定义规则日志;</li> <li>web-bot:Bot管理日志。</li> <li>mainland:中国大陆境内;</li> <li>overseas:全球(不含中国大陆)。</li> <li>(cloud.tencent.com/document/product/1552/105791)</li> <li>(cloud.tencent.com/document/product/1552/105792)</li> <li>(cloud.tencent.com/document/product/1552/115585)</li> <li>当 TaskType 取值为 custom_endpoint 时,默认格式为多个 JSON 对象组成的数组,每个 JSON 对象为一条日志;</li> <li>当 TaskType 取值为 s3 时,默认格式为 JSON Lines;</li>特别地,当 TaskType 取值为 cls 或 log_analysis 时,LogFormat.FormatType 的值只能为 json,且 LogFormat 中其他参数将被忽略,建议不传 LogFormat。

Parameters:

  • ZoneId:

    站点 ID。

  • TaskName:

    实时日志投递任务的名称,格式为数字、英文、-和_组合,最多 200 个字符。

  • TaskType:

    实时日志投递任务类型,取值有:

  • EntityList:

    实时日志投递任务对应的实体列表。取值示例如下:

  • LogType:

    数据投递类型,取值有:

  • Area:

    数据投递区域,取值有:

  • Fields:

    投递的预设字段列表。取值参考:

  • CustomFields:

    投递的自定义字段列表,支持在 HTTP 请求头、响应头、Cookie、请求正文中提取指定内容。自定义字段名称不能重复,且最多不能超过 200 个字段。单个实时日志推送任务最多添加 5 个请求正文类型的自定义字段。目前仅站点加速日志(LogType=domain)支持添加自定义字段。

  • DeliveryConditions:

    日志投递的过滤条件,不填表示投递全量日志。

  • Sample:

    采样比例,采用千分制,取值范围为1-1000,例如:填写 605 表示采样比例为 60.5%。不填表示采样比例为 100%。

  • LogFormat:

    日志投递的输出格式。不填表示为默认格式,默认格式逻辑如下:

  • CLS:

    CLS 的配置信息。当 TaskType 取值为 cls 时,该参数必填。

  • CustomEndpoint:

    自定义 HTTP 服务的配置信息。当 TaskType 取值为 custom_endpoint 时,该参数必填。

  • S3:

    AWS S3 兼容存储桶的配置信息。当 TaskType 取值为 s3 时,该参数必填。



5136
5137
5138
# File 'lib/v20220901/models.rb', line 5136

def Sample
  @Sample
end

#TaskNameObject

<li>cls: 推送到腾讯云 CLS;</li> <li>custom_endpoint:推送到自定义 HTTP(S) 地址;</li> <li>s3:推送到 AWS S3 兼容存储桶地址;</li> <li>log_analysis:推送到 EdgeOne 日志分析,该任务类型仅支持“站点加速日志”这一数据投递类型。</li> <li>七层域名:domain.example.com</li> <li>四层代理实例:sid-2s69eb5wcms7</li> <li>边缘函数实例:test-zone-2mxigizoh9l9-1257626257</li> <li>domain:站点加速日志;</li> <li>application:四层代理日志;</li> <li>function:边缘函数运行日志;</li> <li>web-rateLiming:速率限制和 CC 攻击防护日志;</li> <li>web-attack:托管规则日志;</li> <li>web-rule:自定义规则日志;</li> <li>web-bot:Bot管理日志。</li> <li>mainland:中国大陆境内;</li> <li>overseas:全球(不含中国大陆)。</li> <li>(cloud.tencent.com/document/product/1552/105791)</li> <li>(cloud.tencent.com/document/product/1552/105792)</li> <li>(cloud.tencent.com/document/product/1552/115585)</li> <li>当 TaskType 取值为 custom_endpoint 时,默认格式为多个 JSON 对象组成的数组,每个 JSON 对象为一条日志;</li> <li>当 TaskType 取值为 s3 时,默认格式为 JSON Lines;</li>特别地,当 TaskType 取值为 cls 或 log_analysis 时,LogFormat.FormatType 的值只能为 json,且 LogFormat 中其他参数将被忽略,建议不传 LogFormat。

Parameters:

  • ZoneId:

    站点 ID。

  • TaskName:

    实时日志投递任务的名称,格式为数字、英文、-和_组合,最多 200 个字符。

  • TaskType:

    实时日志投递任务类型,取值有:

  • EntityList:

    实时日志投递任务对应的实体列表。取值示例如下:

  • LogType:

    数据投递类型,取值有:

  • Area:

    数据投递区域,取值有:

  • Fields:

    投递的预设字段列表。取值参考:

  • CustomFields:

    投递的自定义字段列表,支持在 HTTP 请求头、响应头、Cookie、请求正文中提取指定内容。自定义字段名称不能重复,且最多不能超过 200 个字段。单个实时日志推送任务最多添加 5 个请求正文类型的自定义字段。目前仅站点加速日志(LogType=domain)支持添加自定义字段。

  • DeliveryConditions:

    日志投递的过滤条件,不填表示投递全量日志。

  • Sample:

    采样比例,采用千分制,取值范围为1-1000,例如:填写 605 表示采样比例为 60.5%。不填表示采样比例为 100%。

  • LogFormat:

    日志投递的输出格式。不填表示为默认格式,默认格式逻辑如下:

  • CLS:

    CLS 的配置信息。当 TaskType 取值为 cls 时,该参数必填。

  • CustomEndpoint:

    自定义 HTTP 服务的配置信息。当 TaskType 取值为 custom_endpoint 时,该参数必填。

  • S3:

    AWS S3 兼容存储桶的配置信息。当 TaskType 取值为 s3 时,该参数必填。



5136
5137
5138
# File 'lib/v20220901/models.rb', line 5136

def TaskName
  @TaskName
end

#TaskTypeObject

<li>cls: 推送到腾讯云 CLS;</li> <li>custom_endpoint:推送到自定义 HTTP(S) 地址;</li> <li>s3:推送到 AWS S3 兼容存储桶地址;</li> <li>log_analysis:推送到 EdgeOne 日志分析,该任务类型仅支持“站点加速日志”这一数据投递类型。</li> <li>七层域名:domain.example.com</li> <li>四层代理实例:sid-2s69eb5wcms7</li> <li>边缘函数实例:test-zone-2mxigizoh9l9-1257626257</li> <li>domain:站点加速日志;</li> <li>application:四层代理日志;</li> <li>function:边缘函数运行日志;</li> <li>web-rateLiming:速率限制和 CC 攻击防护日志;</li> <li>web-attack:托管规则日志;</li> <li>web-rule:自定义规则日志;</li> <li>web-bot:Bot管理日志。</li> <li>mainland:中国大陆境内;</li> <li>overseas:全球(不含中国大陆)。</li> <li>(cloud.tencent.com/document/product/1552/105791)</li> <li>(cloud.tencent.com/document/product/1552/105792)</li> <li>(cloud.tencent.com/document/product/1552/115585)</li> <li>当 TaskType 取值为 custom_endpoint 时,默认格式为多个 JSON 对象组成的数组,每个 JSON 对象为一条日志;</li> <li>当 TaskType 取值为 s3 时,默认格式为 JSON Lines;</li>特别地,当 TaskType 取值为 cls 或 log_analysis 时,LogFormat.FormatType 的值只能为 json,且 LogFormat 中其他参数将被忽略,建议不传 LogFormat。

Parameters:

  • ZoneId:

    站点 ID。

  • TaskName:

    实时日志投递任务的名称,格式为数字、英文、-和_组合,最多 200 个字符。

  • TaskType:

    实时日志投递任务类型,取值有:

  • EntityList:

    实时日志投递任务对应的实体列表。取值示例如下:

  • LogType:

    数据投递类型,取值有:

  • Area:

    数据投递区域,取值有:

  • Fields:

    投递的预设字段列表。取值参考:

  • CustomFields:

    投递的自定义字段列表,支持在 HTTP 请求头、响应头、Cookie、请求正文中提取指定内容。自定义字段名称不能重复,且最多不能超过 200 个字段。单个实时日志推送任务最多添加 5 个请求正文类型的自定义字段。目前仅站点加速日志(LogType=domain)支持添加自定义字段。

  • DeliveryConditions:

    日志投递的过滤条件,不填表示投递全量日志。

  • Sample:

    采样比例,采用千分制,取值范围为1-1000,例如:填写 605 表示采样比例为 60.5%。不填表示采样比例为 100%。

  • LogFormat:

    日志投递的输出格式。不填表示为默认格式,默认格式逻辑如下:

  • CLS:

    CLS 的配置信息。当 TaskType 取值为 cls 时,该参数必填。

  • CustomEndpoint:

    自定义 HTTP 服务的配置信息。当 TaskType 取值为 custom_endpoint 时,该参数必填。

  • S3:

    AWS S3 兼容存储桶的配置信息。当 TaskType 取值为 s3 时,该参数必填。



5136
5137
5138
# File 'lib/v20220901/models.rb', line 5136

def TaskType
  @TaskType
end

#ZoneIdObject

<li>cls: 推送到腾讯云 CLS;</li> <li>custom_endpoint:推送到自定义 HTTP(S) 地址;</li> <li>s3:推送到 AWS S3 兼容存储桶地址;</li> <li>log_analysis:推送到 EdgeOne 日志分析,该任务类型仅支持“站点加速日志”这一数据投递类型。</li> <li>七层域名:domain.example.com</li> <li>四层代理实例:sid-2s69eb5wcms7</li> <li>边缘函数实例:test-zone-2mxigizoh9l9-1257626257</li> <li>domain:站点加速日志;</li> <li>application:四层代理日志;</li> <li>function:边缘函数运行日志;</li> <li>web-rateLiming:速率限制和 CC 攻击防护日志;</li> <li>web-attack:托管规则日志;</li> <li>web-rule:自定义规则日志;</li> <li>web-bot:Bot管理日志。</li> <li>mainland:中国大陆境内;</li> <li>overseas:全球(不含中国大陆)。</li> <li>(cloud.tencent.com/document/product/1552/105791)</li> <li>(cloud.tencent.com/document/product/1552/105792)</li> <li>(cloud.tencent.com/document/product/1552/115585)</li> <li>当 TaskType 取值为 custom_endpoint 时,默认格式为多个 JSON 对象组成的数组,每个 JSON 对象为一条日志;</li> <li>当 TaskType 取值为 s3 时,默认格式为 JSON Lines;</li>特别地,当 TaskType 取值为 cls 或 log_analysis 时,LogFormat.FormatType 的值只能为 json,且 LogFormat 中其他参数将被忽略,建议不传 LogFormat。

Parameters:

  • ZoneId:

    站点 ID。

  • TaskName:

    实时日志投递任务的名称,格式为数字、英文、-和_组合,最多 200 个字符。

  • TaskType:

    实时日志投递任务类型,取值有:

  • EntityList:

    实时日志投递任务对应的实体列表。取值示例如下:

  • LogType:

    数据投递类型,取值有:

  • Area:

    数据投递区域,取值有:

  • Fields:

    投递的预设字段列表。取值参考:

  • CustomFields:

    投递的自定义字段列表,支持在 HTTP 请求头、响应头、Cookie、请求正文中提取指定内容。自定义字段名称不能重复,且最多不能超过 200 个字段。单个实时日志推送任务最多添加 5 个请求正文类型的自定义字段。目前仅站点加速日志(LogType=domain)支持添加自定义字段。

  • DeliveryConditions:

    日志投递的过滤条件,不填表示投递全量日志。

  • Sample:

    采样比例,采用千分制,取值范围为1-1000,例如:填写 605 表示采样比例为 60.5%。不填表示采样比例为 100%。

  • LogFormat:

    日志投递的输出格式。不填表示为默认格式,默认格式逻辑如下:

  • CLS:

    CLS 的配置信息。当 TaskType 取值为 cls 时,该参数必填。

  • CustomEndpoint:

    自定义 HTTP 服务的配置信息。当 TaskType 取值为 custom_endpoint 时,该参数必填。

  • S3:

    AWS S3 兼容存储桶的配置信息。当 TaskType 取值为 s3 时,该参数必填。



5136
5137
5138
# File 'lib/v20220901/models.rb', line 5136

def ZoneId
  @ZoneId
end

Instance Method Details

#deserialize(params) ⇒ Object



5155
5156
5157
5158
5159
5160
5161
5162
5163
5164
5165
5166
5167
5168
5169
5170
5171
5172
5173
5174
5175
5176
5177
5178
5179
5180
5181
5182
5183
5184
5185
5186
5187
5188
5189
5190
5191
5192
5193
5194
5195
5196
# File 'lib/v20220901/models.rb', line 5155

def deserialize(params)
  @ZoneId = params['ZoneId']
  @TaskName = params['TaskName']
  @TaskType = params['TaskType']
  @EntityList = params['EntityList']
  @LogType = params['LogType']
  @Area = params['Area']
  @Fields = params['Fields']
  unless params['CustomFields'].nil?
    @CustomFields = []
    params['CustomFields'].each do |i|
      customfield_tmp = CustomField.new
      customfield_tmp.deserialize(i)
      @CustomFields << customfield_tmp
    end
  end
  unless params['DeliveryConditions'].nil?
    @DeliveryConditions = []
    params['DeliveryConditions'].each do |i|
      deliverycondition_tmp = DeliveryCondition.new
      deliverycondition_tmp.deserialize(i)
      @DeliveryConditions << deliverycondition_tmp
    end
  end
  @Sample = params['Sample']
  unless params['LogFormat'].nil?
    @LogFormat = LogFormat.new
    @LogFormat.deserialize(params['LogFormat'])
  end
  unless params['CLS'].nil?
    @CLS = CLSTopic.new
    @CLS.deserialize(params['CLS'])
  end
  unless params['CustomEndpoint'].nil?
    @CustomEndpoint = CustomEndpoint.new
    @CustomEndpoint.deserialize(params['CustomEndpoint'])
  end
  unless params['S3'].nil?
    @S3 = S3.new
    @S3.deserialize(params['S3'])
  end
end