云日志服务 LTS-创建日志转储（新版）:请求参数
下载云日志服务 LTS用户手册完整版
请求参数
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
X-Auth-Token |
是 |
String |
从 IAM 服务获取的用户Token，获取方式请参见：获取用户Token 最小长度：1000 最大长度：2000 |
Content-Type |
是 |
String |
该字段填为：application/json;charset=UTF-8。 最小长度：30 最大长度：30 |
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
log_group_id |
是 |
String |
日志组ID 最小长度：36 最大长度：36 最小长度：36 最大长度：36 |
log_streams |
是 |
Array of LogStreams objects |
日志流ID集合 |
log_transfer_info |
是 |
log_transfer_info object |
日志转储信息 |
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
log_stream_id |
是 |
String |
日志流ID 最小长度：36 最大长度：36 |
log_stream_name |
否 |
String |
日志流名称 |
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
log_transfer_type |
是 |
String |
日志转储类型。OBS指OBS日志转储，DIS指DIS日志转储，DMS指DMS日志转储。 |
log_transfer_mode |
是 |
String |
日志转储方式。cycle是指周期性转储，realTime是指实时转储。OBS转储只支持"cycle"，DIS转储和DMS转储只支持"realTime" 枚举值：
|
log_storage_format |
是 |
String |
日志转储格式。只支持"RAW", "JSON"。RAW是指原始日志格式，JSON是指JSON日志格式。OBS转储和DIS转储支持JSON和RAW，DMS转储仅支持RAW。 枚举值：
|
log_transfer_status |
是 |
String |
日志转储状态，只支持"ENABLE","DISABLE","EXCEPTION"。ENABLE是指日志转储开启状态，DISABLE是指日志转储关闭状态，EXCEPTION是指日志转储异常状态 枚举值：
|
log_agency_transfer |
否 |
log_agency_transfer object |
委托转储信息。若配置委托转储，则需要输入该参数 |
log_transfer_detail |
是 |
log_transfer_detail object |
日志转储详细信息 |
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
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 |
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
obs_period |
是 |
Integer |
OBS转储时间。当创建OBS转储时，必填此参数。与obs_period_unit组合，即"obs_period"+"obs_period_unit"，必须是"2min", "5min", "30min", "1hour", "3hour", "6hour","12hour"。 枚举值：
|
obs_period_unit |
是 |
String |
OBS转储单位。当创建OBS转储时，必填此参数。与obs_period组合，即"obs_period"+"obs_period_unit"，必须是"2min", "5min", "30min", "1hour", "3hour", "6hour","12hour"。 枚举值：
|
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，可选填 |
