文档首页/ 云日志服务 LTS/ 用户指南/ 日志接入/ 使用API接入LTS/ 上报高精度日志接口参考
更新时间：2024-11-28 GMT+08:00
查看PDF
分享

上报高精度日志接口参考

功能介绍

该接口用于主机上报租户日志给LTS。

接入点IP可在LTS控制台安装ICAgent的安装命令中获取，端口为8102，调用时使用该参数请参见请求示例。

每次上报的时候， 每条日志都必须带一个纳秒级的时间戳。在LTS界面查看日志的时候， 会按照时间戳排序展示在页面上。关于上报日志的约束与限制请参考日志读写限制。

URI

POST /v2/{project_id}/lts/groups/{log_group_id}/streams/{log_stream_id}/tenant/contents/high-accuracy

表1 路径参数

参数

是否必选

参数类型

描述

project_id

是

String

项目ID，获取方式请参见：获取账号ID、项目ID、日志组ID、日志流ID。

缺省值：None

最小长度：32

最大长度：32

log_group_id

是

String

日志组ID，获取方式请参见：获取账号ID、项目ID、日志组ID、日志流ID。

缺省值：None

最小长度：36

最大长度：36

log_stream_id

是

String

日志流ID，获取方式请参见：获取账号ID、项目ID、日志组ID、日志流ID。

缺省值：None

最小长度：36

最大长度：36

说明：

每个logstream写入速率最大不能超过100MB/S，超过此规格可能会导致日志丢失。

请求参数

表2 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

是

String

从IAM获取的用户Token，获取方式请参见：获取用户Token。

缺省值：None

最小长度：1000

最大长度：2000

Content-Type

是

String

该字段填为：application/json;charset=UTF-8。

缺省值：None

最小长度：30

最大长度：30

Content-Encoding

否

String

日志压缩格式

枚举值：

  • GZIP
  • SNAPPY
  • gzip
  • snappy
表3 请求Body参数

参数

是否必选

参数类型

描述

contents

是

Array of LogContents

包含上报时间戳的日志内容列表。

labels

是

Object

用户自定义label。

说明：

请不要将字段名称设置为内置保留字段，否则可能会造成字段名称重复、查询不精确等问题。

tenant_project_id

否

String

租户项目ID，获取方式请参见：获取账号ID、项目ID、日志组ID、日志流ID。
表4 LogContents

参数

是否必选

参数类型

描述

log_time_ns

是

Long

日志数据上报时间，UTC时间（纳秒）。

说明：

通过接口上报日志到LTS的时间相距当前时间不超过2天，否则上报日志会被LTS删除。

log

是

String

日志内容。

响应参数

状态码为 200 时:

表5 响应Body参数

参数

参数类型

描述

errorCode

String

错误码。

枚举值：

  • SVCSTG.ALS.200.200

errorMessage

String

调用失败响应信息描述。

枚举值：

  • Report success.

result

String

响应结果。

状态码为 400 时:

表6 响应Body参数

参数

参数类型

描述

errorCode

String

错误码。

枚举值：

  • SVCSTG.ALS.200.201
  • SVCSTG.ALS.200.210

errorMessage

String

调用失败响应信息描述。

枚举值：

  • Request conditions must be json format.
  • projectid xxx log's quota has full.

result

String

响应结果。

状态码为 401 时:

表7 响应Body参数

参数

参数类型

描述

errorCode

String

错误码。

枚举值：

  • SVCSTG.ALS.403.105

errorMessage

String

调用失败响应信息描述。

枚举值：

  • Project id is invalid.

result

String

响应结果。

状态码为 500 时:

表8 响应Body参数

参数

参数类型

描述

errorCode

String

错误码。

枚举值：

  • LTS.200500

errorMessage

String

调用失败响应信息描述。

枚举值：

  • Internal error

result

String

响应结果。

状态码为 503 时:

表9 响应Body参数

参数

参数类型

描述

result

String

ServiceUnavailable。 被请求的服务无效，服务不可用。

请求示例

POST https://{接入点IP:8102}/v2/{project_id}/lts/groups/{log_group_id}/streams/{log_stream_id}/tenant/contents/high-accuracy

{
	"contents": [
		{
			"log_time_ns": 1586850540000000000,
			"log": "Fri Feb  15 15:48:04 UTC 2019"
		},
		{
			"log_time_ns": 1586850540000000001,
			"log": "Sat Apri 18 16:04:04 UTC 2019"
		}
	],
	"labels": {
		"user_tag": "string"
	}
}

响应示例

状态码： 200

日志上报成功。

{
  "errorCode": "SVCSTG.ALS.200.200",
  "errorMessage": "Report success.",
  "result": null
}

状态码： 401

在客户端提供认证信息后，返回该状态码，表明服务端指出客户端所提供的认证信息不正确或非法。

{
  "errorCode" : "SVCSTG.ALS.403.105",
  "errorMessage" : "Project id is invalid.",
  "result": null
}

状态码

状态码

描述

200

请求响应成功。

400

BadRequest。非法请求。建议根据error_msg直接修改该请求，不要重试该请求。

401

在客户端提供认证信息后，返回该状态码，表明服务端指出客户端所提供的认证信息不正确或非法。

500

系统内部错误。

503

ServiceUnavailable。被请求的服务无效，服务不可用。
父主题： 使用API接入LTS

相关文档