- 最新动态
- 功能总览
- 产品介绍
- 计费说明
- 快速入门
-
用户指南
- 授权IAM用户使用云日志服务LTS
- 购买LTS资源包
- 日志管理
-
日志接入
- 日志接入概述
- 使用ICAgent插件采集日志
-
使用云服务接入LTS
- 云服务接入LTS概述
- 应用运维管理AOM接入LTS
- API网关APIG接入LTS
- Astro轻应用接入LTS
- 云堡垒机CBH接入LTS
- 内容分发网络CDN接入LTS
- 云防火墙CFW接入LTS
- 云审计服务CTS接入LTS
- 分布式缓存服务DCS接入LTS
- 文档数据库服务DDS接入LTS
- DDoS防护 AAD接入LTS
- 分布式消息服务Kafka版接入LTS
- 数据复制服务DRS接入LTS
- 数据仓库服务GaussDB(DWS)接入LTS
- 弹性负载均衡 ELB接入LTS
- 企业路由器ER接入LTS
- 函数工作流FunctionGraph接入LTS
- 云数据库GaussDB接入LTS
- 图引擎服务GES接入LTS
- 云数据库 TaurusDB接入LTS
- 云数据库GeminiDB接入LTS
- 云数据库GeminiDB Mongo接入LTS
- 云数据库GeminiDB Cassandra接入LTS
- 华为HiLens接入LTS
- 设备接入IoTDA接入LTS
- AI开发平台ModelArts接入LTS
- MapReduce服务MRS接入LTS
- 云数据库RDS for MySQL接入LTS
- 云数据库RDS for PostgreSQL接入LTS
- 云数据库RDS for SQLServer接入LTS
- 应用与数据集成平台ROMA Connect接入LTS
- 视频直播Live接入LTS
- 消息通知服务SMN接入LTS
- 安全云脑SecMaster接入LTS
- 对象存储服务OBS接入LTS(邀测)
- 虚拟私有云VPC接入LTS
- Web应用防火墙WAF接入LTS
- 使用API接入LTS
- 使用SDK接入LTS
- 跨IAM账号接入LTS
- 使用KAFKA协议上报日志到LTS
- 使用Flume采集器上报日志到LTS
- 使用匿名写入采集日志
- 自建中间件
- 日志搜索与分析(默认推荐)
- 日志搜索与分析(管道符方式-邀测)
- 日志可视化
- 日志告警
- 日志转储
- 日志消费与加工
- LTS配置中心管理
- 查看LTS审计事件
- 最佳实践
- 开发指南
- API参考
- SDK参考
- 场景代码示例
- 常见问题
- 视频帮助
- 文档下载
- 通用参考
链接复制成功!
创建日志转储(旧版)
功能介绍
该接口用于将指定的一个或多个日志流的日志转储到OBS服务。
调用方法
请参见如何调用API。
URI
POST /v2/{project_id}/log-dump/obs
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
project_id |
是 |
String |
项目ID,获取方式请参见:获取项目ID,获取账号ID,日志组ID、日志流ID 最小长度:32 最大长度:32 |
请求参数
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
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 |
log_stream_ids |
是 |
Array of strings |
日志流id列表, 可以指定一个或多个日志流进行obs周期性转储 |
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 |
转储周期的长度 枚举值:
|
period_unit |
是 |
String |
转储周期的单位。> period与period_unit拼接后必须在该列表中["2min","5min","30min","1hour","3hour","6hour","12hour"] 最小长度:3 最大长度:4 枚举值:
|
响应参数
状态码:201
参数 |
参数类型 |
描述 |
---|---|---|
log_dump_obs_id |
String |
转储id。 缺省值:None 最小长度:36 最大长度:36 |
状态码:400
参数 |
参数类型 |
描述 |
---|---|---|
error_code |
String |
错误码。 枚举值:
|
error_msg |
String |
调用失败响应信息描述。 枚举值:
|
状态码:403
参数 |
参数类型 |
描述 |
---|---|---|
error_code |
String |
错误码。 枚举值:
|
error_msg |
String |
调用失败响应信息描述。 枚举值:
|
状态码:500
参数 |
参数类型 |
描述 |
---|---|---|
error_code |
String |
错误码。 枚举值:
|
error_msg |
String |
调用失败响应信息描述。 枚举值:
|
请求示例
创建日志转储
POST https://{endpoint}/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直接修改该请求,不要重试该请求。
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。
表明服务端能被请求访问到,但是服务内部出错。
InternalServerError。表明服务端能被请求访问到,但是服务内部出错。 { "error_code": "LTS.0010", "error_msg": "Internal Server Error"}
状态码
状态码 |
描述 |
---|---|
200 |
请求响应成功。 |
201 |
请求响应成功。 |
400 |
BadRequest。非法请求。 建议根据error_msg直接修改该请求,不要重试该请求。 |
403 |
Forbidden。请求被拒绝访问。返回该状态码,表明请求能够到达服务端,且服务端能够理解用户请求,但是拒绝做更多的事情,因为该请求被设置为拒绝访问,建议直接修改该请求,不要重试该请求。 |
500 |
InternalServerError。 表明服务端能被请求访问到,但是服务内部出错。 |
错误码
请参见错误码。