云日志服务 LTS-更新日志转储:请求参数

时间:2023-12-15 10:07:02

请求参数

表2 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

String

IAM 服务获取的用户Token,获取方式请参见:获取用户Token

最小长度:1000

最大长度:2000

Content-Type

String

该字段填为:application/json;charset=UTF-8。

最小长度:30

最大长度:30

表3 请求Body参数

参数

是否必选

参数类型

描述

log_transfer_id

String

日志转储ID

最小长度:36

最大长度:36

log_transfer_info

update_log_transfer_info object

日志转储信息

表4 update_log_transfer_info

参数

是否必选

参数类型

描述

log_storage_format

String

日志转储格式。只支持"RAW", "JSON"。RAW是指原始日志格式,JSON是指JSON日志格式。OBS转储和DIS转储支持JSON和RAW,DMS转储仅支持RAW

枚举值:

  • JSON

  • RAW

log_transfer_status

String

日志转储状态,ENABLE是指日志转储开启状态,DISABLE是指日志转储关闭状态,EXCEPTION是指日志转储异常状态

枚举值:

  • ENABLE

  • DISABLE

  • EXCEPTION

log_transfer_detail

log_transfer_detail object

日志转储详细信息

表5 log_transfer_detail

参数

是否必选

参数类型

描述

obs_period

Integer

OBS转储时间。当创建OBS转储时,必填此参数。与obs_period_unit组合,即"obs_period"+"obs_period_unit",必须是"2min", "5min", "30min", "1hour", "3hour", "6hour","12hour"。

枚举值:

  • 1

  • 2

  • 3

  • 5

  • 6

  • 12

  • 30

obs_period_unit

String

OBS转储单位。当创建OBS转储时,必填此参数。与obs_period组合,即"obs_period"+"obs_period_unit",必须是"2min", "5min", "30min", "1hour", "3hour", "6hour","12hour"。

枚举值:

  • min

  • hour

obs_bucket_name

String

OBS转储日志桶名称。当创建OBS转储时,必填此参数。

最小长度:3

最大长度:63

obs_encrypted_id

String

OBS转储KMS秘钥ID。根据OBS转储日志桶是否加密判断,若OBS转储日志加密桶则必须填写该参数,若OBS转储日志桶则不需要此参数

最小长度:36

最大长度:36

obs_dir_pre_fix_name

String

OBS转储自定义转储路径。当创建OBS转储时,根据需要选填此参数。

最小长度:1

最大长度:64

obs_prefix_name

String

OBS转储日志文件前缀。当创建OBS转储时,根据需要选填此参数。

最小长度:1

最大长度:64

obs_time_zone

String

OBS转储时区。参数选择参考OBS转储时区表。如果选择该参数,则必须选择obs_time_zone_id。

obs_time_zone_id

String

OBS转储时区ID。参数选择参考OBS转储时区表。如果选择该参数,则必须选择obs_time_zone。

dis_id

String

DIS转储通道ID。当创建DIS转储时,必填此参数。

最小长度:1

最大长度:128

dis_name

String

DIS转储通道名称。当创建DIS转储时,必填此参数。

最小长度:1

最大长度:64

kafka_id

String

DMS转储kafka ID。当创建DMS转储时,必填此参数。创建DMS转储前,需要使用kafka ID以及kafka Topic进行实例注册。详情见接口注册DMSkafka实例

kafka_topic

String

DMS转储kafka topic。当创建DMS转储时,必填此参数。创建DMS转储前,需要使用kafka ID以及kafka Topic进行实例注册。详情见接口注册DMSkafka实例

obs_transfer_path

String

OBS转储路径,指OBS日志桶中的路径。

obs_eps_id

String

OBS企业项目ID。

obs_encrypted_enable

Boolean

OBS是否开启加密。

tags

Array of strings

若开启tag投递,该字段必须包含主机信息:hostIP、hostId、hostName、pathFile、collectTime; 公共字段有:logStreamName、regionName、logGroupName、projectId,为可选填;开启转储标签:streamTag,可选填

support.huaweicloud.com/api-lts/UpdateTransfer.html