华为云用户手册

URI POST /v2/{project_id}/{domain_id}/lts/events/notification/templates/view 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 项目ID，账号ID，日志组ID、日志流ID，获取方式请参见：获取项目ID，获取账号ID，日志组ID、日志流ID 最小长度：32 最大长度：32 domain_id 是 String 项目ID，账号ID，日志组ID、日志流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参数 参数 是否必选 参数类型 描述 templates 是 String 邮件模板内容 最小长度：2 最大长度：1024 language 是 String 语言 zh-cn中文，en-us英文 枚举值： zh-cn en-us source 是 String 来源，只能填LTS 最小长度：3 最大长度：3

请求示例 预览消息模板邮件格式 POST https://{endpoint}/v2/{project_id}/{domain_id}/lts/events/notification/templates/view { "templates" : "告警级别：${event_severity};\n发生时间：${starts_at};\n告警源：$event.metadata.resource_provider;\n资源类型：$event.metadata.resource_type;\n资源标识：${resources};\n统计类型：关键词统计;\n表达式：$event.annotations.condition_expression;\n当前值: $event.annotations.current_value;\n统计周期：$event.annotations.frequency;\n查询时间：$event.annotations.results[0].time;\n查询日志：$event.annotations.results[0].raw_results;", "language" : "zh-cn", "source" : "LTS" }

请求示例 添加快速查询 /v1.0/2a473356cca5487f8373be891bffc1cf/groups/d1f4240d-5ee2-4e0b-9e2c-e25c7978c001/topics/2b899d46-218c-4f0c-8ace-a36a290a83a0/search-criterias { "name" : "创建数字", "criteria" : "content : 1234567891234567891234567891234567891234567891234567891234567894", "eps_id" : "0", "search_type" : "ORIGINAL LOG " }

响应示例 状态码： 201 添加快速查询成功 { "id" : "0eb379f5-f847-4d25-ba89-05967bf1bae3" } 状态码： 400 BadRequest 非法请求建议根据error_msg直接修改该请求 { "message" : { "code" : "LTS.0208", "details" : "The log stream does not existed" } } 状态码： 500 表明服务端能被请求访问到，但是服务内部出错 { "message" : { "code" : "LTS.0203", "details" : "Internal Server Error" } }

响应参数 状态码： 201 表4 响应Body参数 参数 参数类型 描述 id String 快速查询id 状态码： 400 表5 响应Body参数 参数 参数类型 描述 message ErrorMessagebody object 错误信息body体 表6 ErrorMessagebody 参数 参数类型 描述 code String 错误码 最小长度：8 最大长度：36 details String 错误描述 最小长度：2 最大长度：512 状态码： 500 表7 响应Body参数 参数 参数类型 描述 message ErrorMessagebody object 错误信息body体 表8 ErrorMessagebody 参数 参数类型 描述 code String 错误码 最小长度：8 最大长度：36 details String 错误描述 最小长度：2 最大长度：512

URI POST /v1.0/{project_id}/groups/{group_id}/topics/{topic_id}/search-criterias 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String '项目ID，账号ID，日志组ID、日志流ID，获取方式请参见：获取项目ID，获取账号ID，日志组ID、日志流ID' 缺省值：None 最小长度：32 最大长度：32 group_id 是 String 租户想查询的日志流所在的日志组的groupid，一般为36位字符串。 缺省值：None 最小长度：36 最大长度：36 topic_id 是 String 日志流id

请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 从IAM服务获取的用户Token，获取方式请参见：获取用户Token 最小长度：1000 最大长度：2000 Content-Type 是 String 该字段填为：application/json;charset=UTF-8。 缺省值：None 最小长度：30 最大长度：30 表3 请求Body参数 参数 是否必选 参数类型 描述 criteria 是 String 快速查询字段 eps_id 否 String 企业项目id name 是 String 创建快速查询名称 search_type 是 String 查询类型原始日志：ORIGINALLOG 可视化日志: VISUALIZATION

响应示例 状态码： 200 请求响应成功，成功修改日志流。 { "creation_time" : "number", "log_topic_name" : "string", "log_topic_id" : "string", "ttl_in_days" : 8 } 状态码： 400 BadRequest。非法请求。 建议根据error_msg直接修改该请求，不要重试该请求。 { "error_code" : "LTS.0009", "error_msg" : "Failed to validate the request body" } 状态码： 401 AuthFailed。鉴权失败, 请确认token后再次请求 。 { "error_code" : "LTS.0414", "error_msg" : "Invalid token" } 状态码： 403 Forbidden。 请求被拒绝访问。 返回该状态码，表明请求能够到达服务端，且服务端能够理解用户请求，但是拒绝做更多的事情，因为该请求被设置为拒绝访问，建议直接修改该请求，不要重试该请求。 { "error_code" : "LTS.0001", "error_msg" : "Invalid projectId" } 状态码： 500 InternalServerError。 表明服务端能被请求访问到，但是服务内部出错。 { "error_code" : "LTS.0204", "error_msg" : "Failed to update log stream" }

状态码 状态码 描述 200 请求响应成功，成功修改日志流。 400 BadRequest。非法请求。 建议根据error_msg直接修改该请求，不要重试该请求。 401 AuthFailed。鉴权失败, 请确认token后再次请求 。 403 Forbidden。 请求被拒绝访问。 返回该状态码，表明请求能够到达服务端，且服务端能够理解用户请求，但是拒绝做更多的事情，因为该请求被设置为拒绝访问，建议直接修改该请求，不要重试该请求。 500 InternalServerError。 表明服务端能被请求访问到，但是服务内部出错。 503 ServiceUnavailable。 被请求的服务无效，服务不可用。

响应参数 状态码： 200 表5 响应Body参数 参数 参数类型 描述 creation_time Long 创建该日志流的时间 log_topic_name String 日志流的名称。 最小长度：1 最大长度：64 log_topic_id String 日志流ID。 最小长度：36 最大长度：36 ttl_in_days Integer 日志存储时间（天）。 最小值：1 最大值：365 枚举值： 7 状态码： 400 表6 响应Body参数 参数 参数类型 描述 error_code String 错误码。 枚举值： LTS.0403 error_msg String 调用失败响应信息描述。 枚举值： Invalid projectId 状态码： 401 表7 响应Body参数 参数 参数类型 描述 error_code String 错误码。 枚举值： LTS.0403 error_msg String 调用失败响应信息描述。 枚举值： Invalid projectId 状态码： 403 表8 响应Body参数 参数 参数类型 描述 error_code String 错误码。 枚举值： LTS.0403 error_msg String 调用失败响应信息描述。 枚举值： Invalid projectId 状态码： 500 表9 响应Body参数 参数 参数类型 描述 error_code String 错误码。 枚举值： LTS.0403 error_msg String 调用失败响应信息描述。 枚举值： Invalid projectId

URI PUT /v2/{project_id}/groups/{log_group_id}/streams-ttl/{log_stream_id} 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String '项目ID，账号ID，日志组ID、日志流ID，获取方式请参见：获取项目ID，获取账号ID，日志组ID、日志流ID' 缺省值：None 最小长度：36 最大长度：36 log_group_id 是 String '项目ID，账号ID，日志组ID、日志流ID，获取方式请参见：获取项目ID，获取账号ID，日志组ID、日志流ID' 缺省值：None 最小长度：36 最大长度：36 log_stream_id 是 String '项目ID，账号ID，日志组ID、日志流ID，获取方式请参见：获取项目ID，获取账号ID，日志组ID、日志流ID' 缺省值：None 最小长度：36 最大长度：36

请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 从IAM服务获取的用户Token，获取方式请参见：获取用户Token 最小长度：1000 最大长度：2000 Content-Type 是 String 该字段填为：application/json;charset=UTF-8。 缺省值：None 最小长度：30 最大长度：30 表3 请求Body参数 参数 是否必选 参数类型 描述 ttl_in_days 是 Integer 日志存储时间（天）。 该参数仅对华东-上海一、华北-北京四、华南-广州用户开放。 最小值：1 最大值：365 枚举值： 7 tags 否 Array of tagsBody objects 标签字段信息 表4 tagsBody 参数 是否必选 参数类型 描述 key 否 String 标签键 value 否 String 标签值

状态码 状态码 描述 200 请求响应成功, 成功获取所有接入配置。 400 BadRequest。非法请求。 建议根据error_msg直接修改该请求，不要重试该请求。 401 AuthFailed。鉴权失败, 请确认token后再次请求 。 403 Forbidden。请求被拒绝访问。返回该状态码，表明请求能够到达服务端，且服务端能够理解用户请求，但是拒绝做更多的事情，因为该请求被设置为拒绝访问，建议直接修改该请求，不要重试该请求。 500 InternalServerError。 表明服务端能被请求访问到，但是服务内部出错。 503 ServiceUnavailable。 被请求的服务无效, 服务不可用。

响应参数 状态码： 200 表4 响应Body参数 参数 参数类型 描述 [数组元素] Array of CreateAomMappingRuleResp objects 请求响应成功, 成功获取所有接入配置。 表5 CreateAomMappingRuleResp 参数 参数类型 描述 project_id String 项目id rule_name String 接入规则名称 rule_id String 接入规则id rule_info AomMappingRuleInfoRespBody object 接入规则详情 表6 AomMappingRuleInfoRespBody 参数 参数类型 描述 cluster_id String 集群id cluster_name String 集群名称 deployments_prefix String 日志流前缀 deployments Array of strings 工作负载 namespace String 命名空间 container_name String 容器名称 files Array of AomMappingfilesInfos objects 接入规则详情 表7 AomMappingfilesInfos 参数 参数类型 描述 file_name String 路径名 log_stream_info AomMappingLogStreamInfos object 接入规则详情。 表8 AomMappingLogStreamInfos 参数 参数类型 描述 target_log_group_id String 日志组id target_log_group_name String 目标日志组名称 target_log_stream_id String 日志流id target_log_stream_name String 目标日志流名称 状态码： 400 表9 响应Body参数 参数 参数类型 描述 code String 错误码。 枚举值： LTS.0014 details String 调用失败响应信息描述。 枚举值： Operation DB failed 状态码： 401 表10 响应Body参数 参数 参数类型 描述 massage Massage401 object 接口调用信息。 表11 Massage401 参数 参数类型 描述 code String 错误码。 枚举值： LTS.0001 details String 调用失败响应信息描述。 枚举值： project verify error 状态码： 403 表12 响应Body参数 参数 参数类型 描述 error_code String 错误码。 枚举值： LTS.0403 error_msg String 调用失败响应信息描述。 枚举值： Invalid projectId 状态码： 500 表13 响应Body参数 参数 参数类型 描述 error_code String 错误码。 枚举值： LTS.0403 error_msg String 调用失败响应信息描述。

响应示例 状态码： 200 请求响应成功, 成功获取所有接入配置。 [ { "project_id" : "", "rule_id" : "", "rule_info" : { "cluster_id" : "", "cluster_name" : "", "container_name" : "", "deployments" : [ "" ], "files" : [ { "file_name" : "", "log_stream_info" : { "target_log_group_id" : "", "target_log_group_name" : "", "target_log_stream_id" : "", "target_log_stream_name" : "" } } ], "namespace" : "" }, "rule_name" : "" }, { "project_id" : "", "rule_id" : "", "rule_info" : { "cluster_id" : "", "cluster_name" : "", "container_name" : "", "deployments" : [ "" ], "files" : [ { "file_name" : "", "log_stream_info" : { "target_log_group_id" : "", "target_log_group_name" : "", "target_log_stream_id" : "", "target_log_stream_name" : "" } } ], "namespace" : "" }, "rule_name" : "" } ] 状态码： 400 BadRequest。非法请求。 建议根据error_msg直接修改该请求，不要重试该请求。 { "errorCode" : "LTS.0014", "errorMessage" : "Operation DB failed" } 状态码： 401 AuthFailed。鉴权失败, 请确认token后再次请求 。 { "error_code" : "LTS.0414", "error_msg" : "Invalid token" } 状态码： 403 Forbidden。请求被拒绝访问。返回该状态码，表明请求能够到达服务端，且服务端能够理解用户请求，但是拒绝做更多的事情，因为该请求被设置为拒绝访问，建议直接修改该请求，不要重试该请求。 { "error_code" : "LTS.0003", "error_msg" : "parse_token_failed" } 状态码： 500 InternalServerError。 表明服务端能被请求访问到，但是服务内部出错。 { "error_code" : "LTS.0102", "error_msg" : "ServiceUnavailable." }

URI GET /v2/{project_id}/lts/aom-mapping 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 项目ID，账号ID，日志组ID、日志流ID，获取方式请参见：获取项目ID，获取账号ID，日志组ID、日志流ID 缺省值：None 最小长度：32 最大长度：32 表2 Query参数 参数 是否必选 参数类型 描述 log_group_name 否 String 日志组名称 最小长度：1 最大长度：64 log_stream_name 否 String 日志流名称 最小长度：1 最大长度：64

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

请求参数 表3 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 从IAM服务获取的用户Token，获取方式请参见：获取用户Token 最小长度：1000 最大长度：2000 Content-Type 是 String 该字段填为：application/json;charset=UTF-8。 缺省值：None 最小长度：30 最大长度：30 表4 请求Body参数 参数 是否必选 参数类型 描述 start_time 是 Long 开始时间时间戳，毫秒时间，最多支持30天范围内的查询 end_time 是 Long 结束时间时间戳，毫秒时间 period 是 Integer 查询时间间隔，单位为小时，范围为1-24 resource_type 是 String 资源类型，log_group / log_stream / tenant search_type 是 String 查询流量类型值为：write，index，storage，basicTransfer，seniorTransfer，coldStorage resource_id 否 String 资源ID。 当资源类型为log_group时 ，resource_id是日志组id； 当资源类型为log_stream时，resource_id是日志流id。

响应参数 状态码： 200 表5 响应Body参数 参数 参数类型 描述 results Array of Resulits objects 响应结果 表6 Resulits 参数 参数类型 描述 timestamp Long 时间戳，毫秒时间 value Double 流量，byte 状态码： 400 表7 响应Body参数 参数 参数类型 描述 errorCode String 错误码 最小长度：8 最大长度：36 errorMessage String 错误描述 最小长度：2 最大长度：512 状态码： 500 表8 响应Body参数 参数 参数类型 描述 errorCode String 错误码 最小长度：8 最大长度：36 errorMessage String 错误描述 最小长度：2 最大长度：512

响应示例 状态码： 200 查询资源成功 { "results" : [ { "timestamp" : 1669046400000, "value" : 8.24859442E7 }, { "timestamp" : 1669071600000, "value" : 0 }, { "timestamp" : 1669161600000, "value" : 9.06895742E7 }, { "timestamp" : 1669215600000, "value" : 8.81524816E7 } ] } 状态码： 400 BadRequest 非法请求建议根据error_msg直接修改该请求 { "errorCode" : "LTS.0009", "errorMessage" : "resource_id must not be empty" } 状态码： 500 表明服务端能被请求访问到，但是服务内部出错 { "errorCode" : "LTS.0203", "errorMessage" : "Internal Server Error" }

请求示例 按时间段统计查询资源 v2/2a473356cca5487f8373be891bffc1cf/lts/timeline-traffic-statistics?timezone=Asia/Shanghai { "start_time" : 1668614400000, "end_time" : 1668787200000, "search_type" : "write", "period" : 1, "resource_type" : "tenant" }

URI POST /v2/{project_id}/lts/timeline-traffic-statistics 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String '项目ID，账号ID，日志组ID、日志流ID，获取方式请参见：获取项目ID，获取账号ID，日志组ID、日志流ID' 缺省值：None 最小长度：32 最大长度：32 表2 Query参数 参数 是否必选 参数类型 描述 timezone 是 String 时区

响应示例 状态码： 200 查询日志流信息请求响应成功。 { "log_streams" : [ { "creation_time" : 1633600371062, "log_stream_name" : "lts-topic-test2", "tag" : { "_sys_enterprise_project_id" : "0", "W" : "J" }, "filter_count" : 0, "log_stream_id" : "c4de0538-53e6-41fd-b951-a8669fce58d7" } ] } 状态码： 400 BadRequest 非法请求 建议根据error_msg直接修改该请求。 { "error_code" : "LTS.0205", "error_msg" : "The log stream name has been existed" } 状态码： 500 表明服务端能被请求访问到，但是服务内部出错。 { "error_code" : "LTS.0010", "error_msg" : "The system encountered an internal error" }

请求示例 若不传参数则查询所有日流信息。若根据log_group_name，log_stream_name这2种不同的参数，则查询对应的日志流信息。 GET https://{endpoint}/v2/{project_id}/log-streams /v2/{project_id}/log-streams /v2/{project_id}/log-streams?log_group_name=lts-group-txxxx /v2/{project_id}/log-streams?log_stream_name=lts-xunjian-topic-xxxx /v2/{project_id}/log-streams?log_stream_name=lts-xunjian-topic-xxxx&log_group_name=lts-group-xxx

URI GET /v2/{project_id}/log-streams 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 项目ID，账号ID，日志组ID、日志流ID，获取方式请参见：获取项目ID，获取账号ID，日志组ID、日志流ID 最小长度：32 最大长度：32 表2 Query参数 参数 是否必选 参数类型 描述 log_group_name 否 String 日志组名称 最小长度：1 最大长度：64 log_stream_name 否 String 日志流名称 最小长度：1 最大长度：64 offset 否 Integer 查询游标，初始传入0，后续从上一次的返回值中获取 最小值：0 最大值：1024 limit 否 Integer 每页数据量，最大值为100 最小值：0 最大值：100

URI DELETE /v1.0/{project_id}/groups/{group_id}/topics/{topic_id}/search-criterias 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String '项目ID，账号ID，日志组ID、日志流ID，获取方式请参见：获取项目ID，获取账号ID，日志组ID、日志流ID' 缺省值：None 最小长度：32 最大长度：32 group_id 是 String 租户想查询的日志流所在的日志组的groupid，一般为36位字符串。 缺省值：None 最小长度：36 最大长度：36 topic_id 是 String 日志流id

响应参数 状态码： 400 表4 响应Body参数 参数 参数类型 描述 message ErrorMessagebody object 错误信息body体 表5 ErrorMessagebody 参数 参数类型 描述 code String 错误码 最小长度：8 最大长度：36 details String 错误描述 最小长度：2 最大长度：512 状态码： 500 表6 响应Body参数 参数 参数类型 描述 message ErrorMessagebody object 错误信息body体 表7 ErrorMessagebody 参数 参数类型 描述 code String 错误码 最小长度：8 最大长度：36 details String 错误描述 最小长度：2 最大长度：512

请求示例 查询快速查询 /v1.0/2a473356cca5487f8373be891bffc1cf/groups/d1f4240d-5ee2-4e0b-9e2c-e25c7978c001/topics/2b899d46-218c-4f0c-8ace-a36a290a83a0/search-criterias { "id" : "345d2276-1ae8-4495-a6ee-bf77c2e5ffb9", "epsId" : "0" }

响应示例 状态码： 204 删除快速查询成功 状态码： 400 BadRequest 非法请求建议根据error_msg直接修改该请求 { "message" : { "code" : "LTS.0208", "details" : "The log stream does not existed" } } 状态码： 500 表明服务端能被请求访问到，但是服务内部出错 { "message" : { "code" : "LTS.0203", "details" : "Internal Server Error" } }