文档首页/ 云日志服务 LTS/ 更多文档/ API参考（联盟区域）/ API/ 日志转储/ 创建日志转储（新版）

更新时间：2026-01-05 GMT+08:00

查看PDF

创建日志转储（新版）

功能介绍

该接口用于创建OBS转储。

URI

POST /v2/{project_id}/transfers

表1 路径参数
参数	是否必选	参数类型	描述
project_id	是	String	项目ID，获取方式请参见：获取项目ID，获取账号ID，日志组ID、日志流ID 最小长度：32 最大长度：32

请求参数

表2 请求Header参数
参数	是否必选	参数类型	描述
X-Auth-Token	是	String	从IAM服务获取的用户Token，获取方式请参见：获取用户Token 最小长度：1000 最大长度：2000
Content-Type	是	String	该字段填为：application/json;charset=UTF-8。最小长度：30 最大长度：30

表3 请求Body参数
参数	是否必选	参数类型	描述
log_group_id	是	String	日志组ID 最小长度：36 最大长度：36
log_streams	是	Array of LogStreams objects	日志流ID集合
log_transfer_info	是	log_transfer_info object	日志转储信息

表4 LogStreams
参数	是否必选	参数类型	描述
log_stream_id	是	String	日志流ID 最小长度：36 最大长度：36
log_stream_name	否	String	日志流名称

表5 log_transfer_info
参数	是否必选	参数类型	描述
log_transfer_type	是	String	日志转储类型。OBS指OBS日志转储。
log_transfer_mode	是	String	日志转储方式。cycle是指周期性转储，realTime是指实时转储。OBS转储只支持"cycle"。
log_storage_format	是	String	日志转储格式。只支持"RAW", "JSON"。RAW是指原始日志格式，JSON是指JSON日志格式。OBS转储支持JSON和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	日志转储详细信息

表6 log_agency_transfer
参数	是否必选	参数类型	描述
agency_domain_id	是	String	委托方账号ID
agency_domain_name	是	String	委托方账号名称
agency_name	是	String	委托方配置的委托名称
agency_project_id	是	String	委托方项目ID
be_agency_domain_id	是	String	被委托方账号ID，实际配置转储的账号ID
be_agency_project_id	是	String	被委托方项目ID，实际配置转储的账号的项目ID

表7 log_transfer_detail
参数	是否必选	参数类型	描述
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_time_zone_id。
obs_time_zone_id	否	String	OBS转储时区ID。如果选择该参数，则必须选择obs_time_zone。
obs_encrypted_enable	否	Boolean	OBS是否开启加密。
tags	否	Array of strings	若开启tag投递，该字段必须包含主机信息：hostIP、hostId、hostName、pathFile、collectTime；公共字段有：logStreamName、regionName、logGroupName、projectId，为可选填；开启转储标签：streamTag，可选填

响应参数

状态码：200

表8 响应Body参数
参数	参数类型	描述
log_group_id	String	日志组ID
log_group_name	String	日志组名称
log_streams	Array of log_streams objects	日志流集合
log_transfer_id	String	日志转储ID
log_transfer_info	log_transfer_info_RespBody object	日志转储信息
log_group_name_alias	String	日志组别名

表9 log_streams
参数	参数类型	描述
log_stream_id	String	日志流ID
log_stream_name	String	日志流名称
log_stream_name_alias	String	日志流别名

**表10** log_transfer_info_RespBody
参数	参数类型	描述
log_agency_transfer	log_agency_transfer object	委托转储信息。若转储为委托转储，则会返回该参数
log_create_time	Integer	日志转储创建时间
log_storage_format	String	日志转储格式。只支持"RAW", "JSON"。RAW是指原始日志格式，JSON是指JSON日志格式。OBS转储支持JSON和RAW。
log_transfer_detail	TransferDetail object	日志转储详细信息
log_transfer_mode	String	日志转储方式。cycle是指周期性转储，realTime是指实时转储。OBS转储只支持"cycle"，
log_transfer_status	String	日志转储状态，ENABLE是指日志转储开启状态，DISABLE是指日志转储关闭状态，EXCEPTION是指日志转储异常状态
log_transfer_type	String	日志转储类型。OBS指OBS日志转储。

**表11** log_agency_transfer
参数	参数类型	描述
agency_domain_id	String	委托方账号ID
agency_domain_name	String	委托方账号名称
agency_name	String	委托方配置的委托名称
agency_project_id	String	委托方项目ID
be_agency_domain_id	String	被委托方账号ID，实际配置转储的账号ID
be_agency_project_id	String	被委托方项目ID，实际配置转储的账号的项目ID

**表12** TransferDetail
参数	参数类型	描述
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_unit组合，即"obs_period"+"obs_period_unit"，必须是"2min", "5min", "30min", "1hour", "3hour", "6hour","12hour"。
obs_bucket_name	String	OBS日志桶名称。当创建OBS转储时，必填此参数。
obs_encrypted_id	String	OBS转储KMS密钥ID。根据OBS转储日志桶是否加密判断，若OBS转储日志桶加密则必须填写该参数，若OBS转储日志桶则不需要此参数。
obs_dir_pre_fix_name	String	OBS转储自定义转储路径。当创建OBS转储时，根据需要选填此参数。正则约束： ^(/)?([a-zA-Z0-9.-]+)(/[a-zA-Z0-9.-]+)*(/)?$
obs_prefix_name	String	OBS转储日志文件前缀。当创建OBS转储时，根据需要选填此参数。正则约束： ^[a-zA-Z0-9._-]*$
obs_time_zone	String	OBS转储时区。如果选择该参数，则必须选择obs_time_zone_id。
obs_time_zone_id	String	OBS转储时区ID。如果选择该参数，则必须选择obs_time_zone。
obs_transfer_path	String	OBS转储路径，指OBS日志桶中的路径。
obs_encrypted_enable	Boolean	OBS是否开启加密。
tags	Array of strings	若开启tag投递，该字段必须包含主机信息：hostIP、hostId、hostName、pathFile、collectTime；公共字段有：logStreamName、regionName、logGroupName、projectId，为可选填；开启转储标签：streamTag，可选填

状态码：400

**表13** 响应Body参数
参数	参数类型	描述
error_code	String	错误码。
error_msg	String	调用失败响应信息描述。

状态码：500

**表14** 响应Body参数
参数	参数类型	描述
error_code	String	错误码。
error_msg	String	调用失败响应信息描述。

请求示例

创建OBS转储

POST https://{endpoint}/v2/{project_id}/transfers

{
  "log_group_id" : "8ba9e43f-be60-4d8c-9015-xxxxxxxxxxxx",
  "log_streams" : [ {
    "log_stream_id" : "c776e1a7-8548-430a-afe5-xxxxxxxxxxxx"
  } ],
  "log_transfer_info" : {
    "log_transfer_type" : "OBS",
    "log_transfer_mode" : "cycle",
    "log_storage_format" : "JSON",
    "log_transfer_status" : "ENABLE",
    "log_agency_transfer" : {
      "agency_domain_id" : "1d26cc8c86a840e28a4f8d0d078xxxxx",
      "agency_domain_name" : "paas_apm_z004xxxxx_xx",
      "agency_name" : "test20210325",
      "agency_project_id" : "2a473356cca5487f8373be891bfxxxxx",
      "be_agency_domain_id" : "1d26cc8c86a840e28a4f8d0d078xxxxx",
      "be_agency_project_id" : "2a473356cca5487f8373be891bfxxxxx"
    },
    "log_transfer_detail" : {
      "obs_period" : 2,
      "obs_period_unit" : "min",
      "obs_bucket_name" : "test0002",
      "obs_encrypted_id" : "1bd90032-1424-481f-8558-ba49854xxxxx",
      "obs_dir_pre_fix_name" : "xx",
      "obs_prefix_name" : "xxxxx",
      "obs_time_zone" : "UTC+01:00",
      "obs_time_zone_id" : "Africa/Lagos"
    }
  }
}

响应示例

状态码：200

创建转储请求响应成功。

当创建OBS转储时，会返回如下参数

{
  "log_group_id" : "9a7e2183-2d6d-4732-9a9b-e897fd4e49e0",
  "log_group_name" : "lts-group-OBS",
  "log_streams" : [ {
    "log_stream_id" : "839dac89-35af-4db2-ab4a-a7dda0d0d3f8",
    "log_stream_name" : "lts-topic-OBS"
  } ],
  "log_transfer_id" : "ddced522-233a-4181-a5fc-7b458c819afc",
  "log_transfer_info" : {
    "log_create_time" : 1634802241847,
    "log_storage_format" : "JSON",
    "log_agency_transfer" : {
      "agency_domain_id" : "1d26cc8c86a840e28a4f8d0d078xxxxx",
      "agency_domain_name" : "paas_apm_z004xxxxx_xx",
      "agency_name" : "test20210325",
      "agency_project_id" : "2a473356cca5487f8373be891bfxxxxx",
      "be_agency_domain_id" : "1d26cc8c86a840e28a4f8d0d078xxxxx",
      "be_agency_project_id" : "2a473356cca5487f8373be891bfxxxxx"
    },
    "log_transfer_detail" : {
      "obs_period" : 2,
      "obs_prefix_name" : "",
      "obs_period_unit" : "min",
      "obs_transfer_path" : "/0002/LogTanks/xxxx-7/",
      "obs_bucket_name" : "0002",
      "obs_encrypted_enable" : false,
      "obs_dir_pre_fix_name" : "",
      "obs_time_zone" : "UTC+01:00",
      "obs_time_zone_id" : "Africa/Lagos",
      "tags" : [ ]
    },
    "log_transfer_mode" : "cycle",
    "log_transfer_status" : "ENABLE",
    "log_transfer_type" : "OBS"
  }
}

状态码：400

BadRequest 非法请求建议根据error_msg直接修改该请求。

{
  "error_code" : "LTS.0207",
  "error_msg" : "The log stream is associated by transfer"
}

状态码：500

InternalServerError。表明服务端能被请求访问到，但是服务内部出错。

{
  "error_code" : "LTS.0207",
  "error_msg" : "The log stream is associated by transfer"
}

状态码

状态码	描述
200	创建转储请求响应成功。
400	BadRequest 非法请求建议根据error_msg直接修改该请求。
500	InternalServerError。表明服务端能被请求访问到，但是服务内部出错。

错误码

请参见错误码。

父主题： 日志转储

上一篇：创建日志转储（旧版）

下一篇：删除日志转储

意见反馈

文档内容是否对您有帮助？

有帮助没帮助

提供反馈

提交成功！非常感谢您的反馈，我们会继续努力做到更好！

系统繁忙，请稍后重试

在使用文档中是否遇到以下问题

内容与产品页面不一致

内容不易理解

缺失示例代码

步骤不可操作

搜不到想要的内容

缺少最佳实践

意见反馈（选填）

0/500

请至少选择一项反馈信息并填写问题反馈

字符长度不能超过500

直接提交取消