云日志服务 LTS-创建日志转储(新版):响应参数

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

响应参数

状态码: 200

表8 响应Body参数

参数

参数类型

描述

log_group_id

String

日志组ID

最小长度:36

最大长度:36

log_group_name

String

日志组名称

最小长度:1

最大长度:64

log_streams

Array of log_streams objects

日志流集合

log_transfer_id

String

日志转储ID

最小长度:36

最大长度:36

log_transfer_info

log_transfer_info_RespBody object

日志转储信息

表9 log_streams

参数

参数类型

描述

log_stream_id

String

日志流ID

最小长度:36

最大长度:36

log_stream_name

String

日志流名称

最小长度:1

最大长度:64

表10 log_transfer_info_RespBody

参数

参数类型

描述

log_agency_transfer

log_agency_transfer object

委托转储信息。若转储为委托转储,则会返回该参数

log_create_time

Integer

日志转储创建时间

最小值:0

最大值:2147483647

log_storage_format

String

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

枚举值:

  • JSON

  • RAW

log_transfer_detail

TransferDetail object

日志转储详细信息

log_transfer_mode

String

日志转储方式。cycle是指周期性转储,realTime是指实时转储。OBS转储只支持"cycle",DIS转储和DMS转储只支持"realTime"。

枚举值:

  • cycle

  • realTime

log_transfer_status

String

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

枚举值:

  • ENABLE

  • DISABLE

  • EXCEPTION

log_transfer_type

String

日志转储类型。OBS指OBS日志转储,DIS指DIS日志转储,DMS指DMS日志转储。

枚举值:

  • OBS

  • DIS

  • DMS

表11 log_agency_transfer

参数

参数类型

描述

agency_domain_id

String

委托方账号ID

最小长度:1

最大长度:128

agency_domain_name

String

委托方账号名称

最小长度:1

最大长度:128

agency_name

String

委托方配置的委托名称

最小长度:1

最大长度:128

agency_project_id

String

委托方项目ID

最小长度:32

最大长度:32

be_agency_domain_id

String

被委托方账号ID,实际配置转储的账号ID

最小长度:1

最大长度:128

be_agency_project_id

String

被委托方项目ID,实际配置转储的账号的项目ID

最小长度:32

最大长度:32

表12 TransferDetail

参数

参数类型

描述

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_unit组合,即"obs_period"+"obs_period_unit",必须是"2min", "5min", "30min", "1hour", "3hour", "6hour","12hour"。

枚举值:

  • “min”

  • “hour”

obs_bucket_name

String

OBS日志桶名称。当创建OBS转储时,必填此参数。 最小长度:3 最大长度:63

最小长度:3

最大长度:63

obs_encrypted_id

String

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

最小长度:36

最大长度:36

obs_dir_pre_fix_name

String

OBS转储自定义转储路径。当创建OBS转储时,根据需要选填此参数。 正则约束: ^(/)?([a-zA-Z0-9.-]+)(/[a-zA-Z0-9.-]+)*(/)?$ 最小长度:1 最大长度:64

最小长度:1

最大长度:64

obs_prefix_name

String

OBS转储日志文件前缀。当创建OBS转储时,根据需要选填此参数。 正则约束: ^[a-zA-Z0-9._-]*$ 最小长度:1 最大长度:64

最小长度:1

最大长度:64

obs_time_zone

String

OBS转储时区(https://support.huaweicloud.com/api-lts/lts_api_0111.html)。如果选择该参数,则必须选择obs_time_zone_id。

obs_time_zone_id

String

OBS转储时区ID(https://support.huaweicloud.com/api-lts/lts_api_0111.html)。参数选择参考OBS转储时区表。如果选择该参数,则必须选择obs_time_zone。

dis_id

String

DIS转储通道ID。当创建DIS转储时,必填此参数。 最小长度:1 最大长度:128

最小长度:1

最大长度:128

dis_name

String

DIS转储通道名称。当创建DIS转储时,必填此参数。 最小长度:1 最大长度:128

最小长度:1

最大长度:128

kafka_id

String

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

最小长度:36

最大长度:36

kafka_topic

String

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

最小长度:1

最大长度:128

obs_transfer_path

String

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

最小长度:0

最大长度:256

obs_eps_id

String

OBS企业项目ID。

最小长度:0

最大长度:128

obs_encrypted_enable

Boolean

OBS是否开启加密。

枚举值:

  • true

  • false

tags

Array of strings

若开启tag投递,该字段必须包含主机信息:hostIP、hostId、hostName、pathFile、collectTime;

公共字段有:logStreamName、regionName、logGroupName、projectId,为可选填;

开启转储标签:streamTag,可选填

状态码: 400

表13 响应Body参数

参数

参数类型

描述

error_code

String

错误码。

最小长度:8

最大长度:8

error_msg

String

调用失败响应信息描述。

状态码: 500

表14 响应Body参数

参数

参数类型

描述

error_code

String

错误码。

最小长度:8

最大长度:8

error_msg

String

调用失败响应信息描述。

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