本文导读

展开导读

文档首页/ 云日志服务 LTS/ 更多文档/ API参考（阿布扎比区域）/ API说明/ 日志转储/ 创建日志转储

创建日志转储

更新时间：2022-06-17 GMT+08:00

查看PDF

功能介绍

该接口用于将指定的一个或多个日志流的日志转储到OBS服务。

URI

POST /v2/{project_id}/log-dump/obs

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

请求参数

表2 请求Header参数
参数	是否必选	参数类型	描述
X-Auth-Token	是	String	从IAM获取的用户Token。缺省值：None 最小长度：1000 最大长度：2000
Content-Type	是	String	该字段填为：application/json;charset=utf8。缺省值：None 最小长度：29 最大长度：29

表3 请求Body参数
参数	是否必选	参数类型	描述
log_group_id	是	String	日志组ID。最小长度：36 最大长度：36
log_stream_ids	是	Array of strings	日志流ID列表, 可以指定一个或多个日志流进行obs周期性转储枚举值： 7bb6b1e7-xxxx-4255-87f9-b3dc7fb2xxxx
obs_bucket_name	是	String	obs桶名称。最小长度：3 最大长度：63
type	是	String	周期性转储，必须填cycle。最小长度：5 最大长度：5
storage_format	是	String	转储格式RAW/JSON，默认为RAW。最小长度：3 最大长度：4
switch_on	否	Boolean	是否开启转储：true/false，默认为true
prefix_name	否	String	转储至OBS桶中的日志文件前缀。最小长度：0 最大长度：64
dir_prefix_name	否	String	自定义文件夹路径。最小长度：0 最大长度：64
period	是	Integer	转储周期的长度枚举值：1,2,3,5,6,12,30
period_unit	是	String	转储周期的单位：枚举值："min","hour" 最小长度：3 最大长度：4 说明： period与period_unit拼接后必须在该列表中["2min","5min","30min","1hour","3hour","6hour","12hour"]

响应参数

状态码为 201 时:

表4 响应Body参数
参数	参数类型	描述
log_dump_obs_id	String	转储ID。缺省值：None 最小长度：36 最大长度：36

状态码为 400 时:

表5 响应Body参数
参数	参数类型	描述
error_code	String	错误码。枚举值： LTS.0007
error_msg	String	调用失败响应信息描述。枚举值： The request body format must be json

状态码为 403 时:

表6 响应Body参数
参数	参数类型	描述
error_code	String	错误码。枚举值： LTS.0403
error_msg	String	调用失败响应信息描述。枚举值： Invalid projectId

状态码为 500 时:

表7 响应Body参数
参数	参数类型	描述
error_code	String	错误码。枚举值： LTS.0403
error_msg	String	调用失败响应信息描述。枚举值： Invalid projectId

请求示例

POST https://{endpoint}/v2/{project_id}/log-dump/obs 
 
/v2/{project_id}/log-dump/obs 
{ 
  "log_group_id": "d9dba9f3-xxxx-48bd-xxxx-xxxxa24a8053", 
  "log_stream_ids": ["45e7f609-xxxx-4cd3-835b-xxxx4a124718"], 
  "obs_bucket_name": "lts-test", 
  "type": "cycle", 
  "storage_format": "RAW", 
  "switch_on": "true", 
  "prefix_name": "fileprefixname", 
  "dir_prefix_name": "dirprefixname", 
  "period": 5, 
  "period_unit": "min" 
}

响应示例

状态码为 200 时:

获取日志组。

{    
  "error_code": "LTS.0201",    
  "error_msg": "The log group does not existed"
}

获取日志流。

{    
  "error_code": "LTS.0208",      
  "error_msg": "Log stream id does not exist: 632b9bdc-5afd-4666-a5de-2579f8b80314-"
}

设置转储OBS桶。

{    
  "error_code": "LTS.0416",    
  "error_msg": "obs bucket does not exist: zhuanchu"
}

日志流ID被关联。

{    
  "error_code": "LTS.0207",    
  "error_msg": "Log stream id is associated by transfer: 632b9bdc-5afd-4666-a5de-2579f8b80314"
}

设置转储类型。

{    
  "error_code": "LTS.1901",    
  "error_msg": "type is not in the list [cycle]"
}

设置转储格式。

{    
  "error_code": "LTS.1901",     
  "error_msg": "storage_format is not in the list [RAW, JSON]"
}

设置转储周期。

{    
  "error_code": "LTS.1901",    
  "error_msg": "period+period_unit is not in the list [2min, 5min, 30min, 1hour, 3hour, 6hour, 12hour]"
}

设置转储单位。

{    
  "error_code": "LTS.1901",    
  "error_msg": "period_unit is not in the list [min, hour]"
}

设置转储日志文件前缀。

{
   "error_code": "LTS.1902",
   "error_msg": "prefix_name is invalid, please verify if it's provided as required"
}

设置自定义转储路径。

{    
  "error_code": "LTS.1902",    
  "error_msg": "dir_prefix_name is invalid, please verify if it's provided as required"
}

状态码为 201 时:

{ 
  "log_dump_obs_id" : "45fdc36b-xxxx-4567-xxxx-559xxxxdf968" 
}

状态码为 400 时:

BadRequest。非法请求。建议根据error_msg直接修改该请求，不要重试该请求。
```
{ 
  "error_code" : "LTS.0009", 
  "error_msg" : "Failed to validate the request body" 
}
```
BadRequest。非法请求。建议根据error_msg直接修改该请求，不要重试该请求。
```
{    
  "error_code": "LTS.0007",    
  "error_msg": "The request body format must be json"
}
```

状态码为 403 时:

Forbidden。请求被拒绝访问。返回该状态码，表明请求能够到达服务端，且服务端能够理解用户请求，但是拒绝做更多的事情，因为该请求被设置为拒绝访问，建议直接修改该请求，不要重试该请求。

{ 
  "error_code" : "LTS.0001", 
  "error_msg" : "Invalid projectId" 
}

状态码为 500 时:

InternalServerError。表明服务端能被请求访问到，但是服务内部出错。
```
{ 
  "error_code" : "LTS.0202", 
  "error_msg" : "Failed to query lts struct log" 
}
```

InternalServerError。表明服务端能被请求访问到，但是服务内部出错。
```
{    
  "error_code": "LTS.0010",    
  "error_msg": "Internal Server Error"
}
```

状态码

状态码	描述
200	请求响应成功。
201	请求响应成功。创建OBS转储成功。
400	BadRequest。非法请求。建议根据error_msg直接修改该请求，不要重试该请求。
403	Forbidden。请求被拒绝访问。返回该状态码，表明请求能够到达服务端，且服务端能够理解用户请求，但是拒绝做更多的事情，因为该请求被设置为拒绝访问，建议直接修改该请求，不要重试该请求。
500	InternalServerError。表明服务端能被请求访问到，但是服务内部出错。
503	ServiceUnavailable。被请求的服务无效，服务不可用。

错误码

请参见错误码。

父主题： 日志转储

上一篇：日志转储

下一篇：权限和授权项

意见反馈

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

有帮助没帮助

提供反馈

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

系统繁忙，请稍后重试

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

内容与产品页面不一致

内容不易理解

缺失示例代码

步骤不可操作

搜不到想要的内容

缺少最佳实践

意见反馈（选填）

0/500

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

字符长度不能超过500

直接提交取消