华为云用户手册

响应示例 状态码： 200 请求响应成功。 { "sql_alarm_rules" : [ { "sql_alarm_rule_name" : "string", "is_css_sql" : false, "sql_alarm_rule_id" : "string", "sql_alarm_rule_description" : "string", "sql_requests" : [ { "log_stream_id" : "string", "log_stream_name" : "string", "log_group_id" : "string", "log_group_name" : "string", "sql" : "string", "sql_request_title" : "string", "search_time_range" : 0, "search_time_range_unit" : "minute" } ], "frequency" : { "type" : "CRON", "cron_expr" : "string", "hour_of_day" : 0, "day_of_week" : 0, "fixed_rate" : 0, "fixed_rate_unit" : "minute" }, "condition_expression" : "string", "topics" : [ { "name" : "string", "topic_urn" : "string", "display_name" : "string", "push_policy" : 0 } ], "sql_alarm_level" : "Info", "sql_alarm_send" : true, "domain_id" : "string", "create_time" : 0, "update_time" : 0, "template_name" : "消息模板名称", "status" : "RUNNING", "trigger_condition_count" : "1", "trigger_condition_frequency" : "1", "whether_recovery_policy" : false, "recovery_policy" : "3", "notification_frequency" : 5, "alarm_action_rule_name" : "" } ] } 状态码： 500 表明服务端能被请求访问到，但是服务内部出错。 { "error_code" : "LTS.2008", "error_msg" : "Find Alarm rule failed." }

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

响应示例 状态码： 200 删除转储请求响应成功。 { "log_group_id" : "9a7e2183-2d6d-4732-9a9b-e897fd4e49e0", "log_group_name" : "lts-group-kafka", "log_streams" : [ { "log_stream_id" : "839dac89-35af-4db2-ab4a-a7dda0d0d3f8", "log_stream_name" : "lts-topic-kafka" } ], "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/xxx/", "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", "dis_id" : "xxxxx", "dis_name" : "xxxxxx", "kafka_id" : "xxxxxx", "kafka_topic" : "xxxxx" }, "log_transfer_mode" : "cycle", "log_transfer_status" : "ENABLE", "log_transfer_type" : "OBS" } } 状态码： 400 BadRequest 非法请求 建议根据error_msg直接修改该请求。 { "error_code" : "LTS.0405", "error_msg" : "The log transfer does not existed" } 状态码： 500 表明服务端能被请求访问到，但是服务内部出错。 { "error_code" : "LTS.0010", "error_msg" : "The system encountered an internal error" }

URI DELETE /v2/{project_id}/transfers 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 项目ID，账号ID，日志组ID、日志流ID，获取方式请参见：获取项目ID，获取账号ID，日志组ID、日志流ID 最小长度：32 最大长度：32 表2 Query参数 参数 是否必选 参数类型 描述 log_transfer_id 是 String 日志转储ID。获取ID有3种方式： 1. 调用查询日志转储接口，返回值有日志转储ID 2. 调用新增日志转储接口，返回值有日志转储ID 最小长度：36 最大长度：36

响应参数 状态码： 200 表4 响应Body参数 参数 参数类型 描述 log_group_id String 日志组ID 最小长度：36 最大长度：36 log_group_name String 日志组名称 最小长度：1 最大长度：64 log_streams Array of log_streams objects 日志流集合 log_transfer_id String 日志转储ID 最小长度：36 最大长度：36 log_transfer_info log_transfer_info_RespBody object 日志转储信息 表5 log_streams 参数 参数类型 描述 log_stream_id String 日志流ID 最小长度：36 最大长度：36 log_stream_name String 日志流名称 最小长度：1 最大长度：64 表6 log_transfer_info_RespBody 参数 参数类型 描述 log_agency_transfer log_agency_transfer object 委托转储信息。若转储为委托转储，则会返回该参数 log_create_time Integer 日志转储创建时间 最小值：0 最大值：2147483647 log_storage_format String 日志转储格式。只支持"RAW", "JSON"。RAW是指原始日志格式，JSON是指JSON日志格式。OBS转储和DIS转储支持JSON和RAW，DMS转储仅支持RAW 枚举值： JSON RAW log_transfer_detail TransferDetail object 日志转储详细信息 log_transfer_mode String 日志转储方式。cycle是指周期性转储，realTime是指实时转储。OBS转储只支持"cycle"，DIS转储和DMS转储只支持"realTime"。 枚举值： cycle realTime log_transfer_status String 日志转储状态，ENABLE是指日志转储开启状态，DISABLE是指日志转储关闭状态，EXCEPTION是指日志转储异常状态 枚举值： ENABLE DISABLE EXCEPTION log_transfer_type String 日志转储类型。OBS指OBS日志转储，DIS指DIS日志转储，DMS指DMS日志转储。 枚举值： OBS DIS DMS 表7 log_agency_transfer 参数 参数类型 描述 agency_domain_id String 委托方账号ID 最小长度：1 最大长度：128 agency_domain_name String 委托方账号名称 最小长度：1 最大长度：128 agency_name String 委托方配置的委托名称 最小长度：1 最大长度：128 agency_project_id String 委托方项目ID 最小长度：32 最大长度：32 be_agency_domain_id String 被委托方账号ID，实际配置转储的账号ID 最小长度：1 最大长度：128 be_agency_project_id String 被委托方项目ID，实际配置转储的账号的项目ID 最小长度：32 最大长度：32 表8 TransferDetail 参数 参数类型 描述 obs_period Integer OBS转储时间。当创建OBS转储时，必填此参数。与obs_period_unit组合，即"obs_period"+"obs_period_unit"，必须是"2min", "5min", "30min", "1hour", "3hour", "6hour","12hour"。 枚举值： 1 2 3 5 6 12 30 obs_period_unit String OBS转储单位。当创建OBS转储时，必填此参数。与obs_period_unit组合，即"obs_period"+"obs_period_unit"，必须是"2min", "5min", "30min", "1hour", "3hour", "6hour","12hour"。 枚举值： “min” “hour” obs_bucket_name String OBS日志桶名称。当创建OBS转储时，必填此参数。 最小长度：3 最大长度：63 最小长度：3 最大长度：63 obs_encrypted_id String OBS转储KMS秘钥ID。根据OBS转储日志桶是否加密判断，若OBS转储日志桶加密则必须填写该参数，若OBS转储日志桶则不需要此参数。 最小长度：36 最大长度：36 最小长度：36 最大长度：36 obs_dir_pre_fix_name String OBS转储自定义转储路径。当创建OBS转储时，根据需要选填此参数。 正则约束： ^(/)?([a-zA-Z0-9.-]+)(/[a-zA-Z0-9.-]+)*(/)?$ 最小长度：1 最大长度：64 最小长度：1 最大长度：64 obs_prefix_name String OBS转储日志文件前缀。当创建OBS转储时，根据需要选填此参数。 正则约束： ^[a-zA-Z0-9._-]*$ 最小长度：1 最大长度：64 最小长度：1 最大长度：64 obs_time_zone String OBS转储时区(https://support.huaweicloud.com/api-lts/lts_api_0111.html)。如果选择该参数，则必须选择obs_time_zone_id。 obs_time_zone_id String OBS转储时区ID(https://support.huaweicloud.com/api-lts/lts_api_0111.html)。参数选择参考OBS转储时区表。如果选择该参数，则必须选择obs_time_zone。 dis_id String DIS转储通道ID。当创建DIS转储时，必填此参数。 最小长度：1 最大长度：128 最小长度：1 最大长度：128 dis_name String DIS转储通道名称。当创建DIS转储时，必填此参数。 最小长度：1 最大长度：128 最小长度：1 最大长度：128 kafka_id String DMS转储kafka ID。当创建DMS转储时，必填此参数。 创建DMS转储前，需要使用kafka ID以及kafka Topic进行实例注册。详情见接口注册DMSkafka实例 最小长度：36 最大长度：36 kafka_topic String DMS转储kafka topic。 创建DMS转储前，需要使用kafka ID以及kafka Topic进行实例注册。详情见接口注册DMSkafka实例 最小长度：1 最大长度：128 obs_transfer_path String OBS转储路径，指OBS日志桶中的路径。 最小长度：0 最大长度：256 obs_eps_id String OBS企业项目ID。 最小长度：0 最大长度：128 obs_encrypted_enable Boolean OBS是否开启加密。 枚举值： true false tags Array of strings 若开启tag投递，该字段必须包含主机信息：hostIP、hostId、hostName、pathFile、collectTime； 公共字段有：logStreamName、regionName、logGroupName、projectId，为可选填； 开启转储标签：streamTag，可选填 状态码： 400 表9 响应Body参数 参数 参数类型 描述 error_code String 错误码。 最小长度：8 最大长度：8 error_msg String 调用失败响应信息描述。 状态码： 500 表10 响应Body参数 参数 参数类型 描述 error_code String 错误码。 最小长度：8 最大长度：8 error_msg String 调用失败响应信息描述。

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

响应参数 状态码： 201 表4 响应Body参数 参数 参数类型 描述 result String 响应结果 状态码： 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

响应示例 状态码： 201 创建仪表盘分组成功 { "result" : "success" } 状态码： 400 BadRequest 非法请求建议根据error_msg直接修改该请求 { "message" : { "code" : "LTS.2111", "details" : "Log dashboard group name is already exist" } } 状态码： 500 表明服务端能被请求访问到，但是服务内部出错 { "message" : { "code" : "LTS.0203", "details" : "Internal Server Error" } }

响应示例 状态码： 201 请求响应成功, 成功创建日志流。 { "log_stream_id" : "c54dbc58-0fd8-48ed-b007-6d54981427a7" } 状态码： 400 BadRequest。非法请求。 建议根据error_msg直接修改该请求，不要重试该请求。 { "error_code" : "LTS.0009", "error_msg" : "Failed to validate the request body" } 状态码： 401 AuthFailed。鉴权失败, 请确认token后再次请求 。 { "error_code" : "LTS.0003", "error_msg" : "Invalid token" } 状态码： 403 Forbidden。请求被拒绝访问。返回该状态码，表明请求能够到达服务端，且服务端能够理解用户请求，但是拒绝做更多的事情，因为该请求被设置为拒绝访问，建议直接修改该请求，不要重试该请求。 { "error_code" : "LTS.0001", "error_msg" : "Invalid projectId" } 状态码： 500 InternalServerError。 表明服务端能被请求访问到，但是服务内部出错。 { "error_code" : "LTS.0202", "error_msg" : "Failed to create Log stream" }

响应参数 状态码： 201 表5 响应Body参数 参数 参数类型 描述 log_stream_id String 创建的日志流的Id。 最小长度：36 最大长度：36 状态码： 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

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

URI POST /v2/{project_id}/groups/{log_group_id}/streams 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 项目ID，账号ID，日志组ID、日志流ID，获取方式请参见：获取项目ID，获取账号ID，日志组ID、日志流ID 缺省值：None 最小长度：32 最大长度：32 log_group_id 是 String 租户想创建的日志流所在的日志组的groupid，一般为36位字符串。 缺省值：None 最小长度：36 最大长度：36

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

请求示例 获取快速查询 /v1.0/2a473356cca5487f8373be891bffc1cf/groups/d1f4240d-5ee2-4e0b-9e2c-e25c7978c001/topics/2b899d46-218c-4f0c-8ace-a36a290a83a0/search-criterias?search_type=ORIGINALLOG search_type: ORIGINALLOG

URI GET /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 Query参数 参数 是否必选 参数类型 描述 search_type 否 String 原始日志：ORIGINALLOG 可视化日志: VISUALIZATION

响应参数 状态码： 200 表4 响应Body参数 参数 参数类型 描述 search_criterias Array of GetQuerySearchCriteriasBody objects 响应Body体。 表5 GetQuerySearchCriteriasBody 参数 参数类型 描述 criteria String 快速查询字段 name String 快速查询名称 id String 快速查询id search_type String 快速查询类型。 原始日志：ORIGINALLOG 可视化日志: VISUALIZATION 状态码： 400 表6 响应Body参数 参数 参数类型 描述 message ErrorMessagebody object 错误信息body体 表7 ErrorMessagebody 参数 参数类型 描述 code String 错误码 最小长度：8 最大长度：36 details String 错误描述 最小长度：2 最大长度：512 状态码： 500 表8 响应Body参数 参数 参数类型 描述 message ErrorMessagebody object 错误信息body体 表9 ErrorMessagebody 参数 参数类型 描述 code String 错误码 最小长度：8 最大长度：36 details String 错误描述 最小长度：2 最大长度：512

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

响应示例 状态码： 200 请求响应成功。 { "log_streams" : [ { "creation_time" : 1630549842955, "log_stream_name" : "lts-stream-02kh", "log_stream_id" : "c54dbc58-0fd8-48ed-b007-6d54981427a7", "filter_count" : 0 } ] } 状态码： 401 AuthFailed。鉴权失败, 请确认token后再次请求 。 { "error_code" : "LTS.0003", "error_msg" : "Invalid token" } 状态码： 403 Forbidden。请求被拒绝访问。返回该状态码，表明请求能够到达服务端，且服务端能够理解用户请求，但是拒绝做更多的事情，因为该请求被设置为拒绝访问，建议直接修改该请求，不要重试该请求。 { "error_code" : "LTS.0001", "error_msg" : "Invalid projectId" } 状态码： 500 InternalServerError。 表明服务端能被请求访问到，但是服务内部出错。 { "error_code" : "LTS.0010", "error_msg" : "The system encountered an internal error" }

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

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

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

响应参数 状态码： 200 表4 响应Body参数 参数 参数类型 描述 results Array of ResultsTopnBody objects 响应结果 表5 ResultsTopnBody 参数 参数类型 描述 index_traffic Double 索引流量，byte, 查询数据类型中包含index时返回 storage Double 存储量，byte, 查询数据类型中包含storage时返回 write_traffic Double 写入流量，byte, 查询数据类型中包含write时返回 log_group_id String 日志组id，资源类型为日志组时返回 log_group_name String 日志组名称，资源类型为日志组时返回 log_stream_id String 日志流id，资源类型为日志流时返回 log_stream_name String 日志流名称，资源类型为日志流时返回 basic_transfer Double 基础转储流量，byte, 查询数据类型中包含basicTransfer时返回 senior_transfer Double 基础转储流量，byte, 查询数据类型中包含seniorTransfer时返回 is_agency_transfer Boolean 不是委托转储，true，是委托转储，则前端资源统计展示的流不能跳 缺省值：false cold_storage Double 冷存储量 状态码： 400 表6 响应Body参数 参数 参数类型 描述 errorCode String 错误码 最小长度：8 最大长度：36 errorMessage String 错误描述 最小长度：2 最大长度：512 状态码： 500 表7 响应Body参数 参数 参数类型 描述 errorCode String 错误码 最小长度：8 最大长度：36 errorMessage String 错误描述 最小长度：2 最大长度：512

请求示例 统计top n的日志组或日志流流量 /v2/2a473356cca5487f8373be891bffc1cf/lts/topn-traffic-statistics { "sort_by" : "storage", "is_desc" : true, "resource_type" : "log_stream", "filter" : { }, "start_time" : 1668668183969, "end_time" : 1669272983969, "search_list" : [ "index", "write", "storage" ], "topn" : 100 }

响应示例 状态码： 200 查询资源成功 { "results" : [ { "index_traffic" : 0, "log_stream_id" : "6fd93d47-7630-4284-a622-311d0082f6bb", "log_stream_name" : "cmdb-cce-cluster", "storage" : 59810657587, "write_traffic" : 0 }, { "index_traffic" : 0, "log_stream_id" : "504ec3dd-ac28-4783-babb-22a49f36afe3", "log_stream_name" : "CMSkaifatest", "storage" : 20033606015, "write_traffic" : 0 }, { "index_traffic" : 6825703991, "log_stream_id" : "a14dacb0-5a13-43a8-89a3-ea5424d95133", "log_stream_name" : "ELB", "storage" : 15659303771, "write_traffic" : 1.3651407982E9 }, { "index_traffic" : 302172889, "log_stream_id" : "25fe7494-7395-438e-8340-647613673ffa", "log_stream_name" : "LTStest-916-statefulset", "storage" : 316552589, "write_traffic" : 6.04345778E7 }, { "index_traffic" : 0, "log_stream_id" : "956586fc-b828-44be-8672-0a323962a8fa", "log_stream_name" : "mongodb_slow", "storage" : 0, "write_traffic" : 0 } ] } 状态码： 400 BadRequest 非法请求建议根据error_msg直接修改该请求 { "errorCode" : "LTS.0208", "errorMessage" : "The log stream does not existed" } 状态码： 500 表明服务端能被请求访问到，但是服务内部出错 { "errorCode" : "LTS.0203", "errorMessage" : "Internal Server Error" }

响应示例 状态码： 200 查询日志接入列表请求响应成功 { "result" : [ { "access_config_detail" : { "containerNameRegex" : "my", "excludeEnvs" : { "h" : "8" }, "excludeK8sLabels" : { "e" : "5" }, "excludeLabels" : { "b" : "2" }, "format" : { "single" : { "mode" : "system", "value" : "1678969382000" } }, "includeEnvs" : { "g" : "7" }, "includeK8sLabels" : { "d30" : "4" }, "includeLabels" : { "a" : "1" }, "logEnvs" : { "i" : "9" }, "logK8s" : { "f" : "6" }, "logLabels" : { "c" : "3" }, "namespaceRegex" : "default", "pathType" : "container_stdout", "paths" : [ ], "podNameRegex" : "abc", "stderr" : false, "stdout" : true }, "access_config_id" : "c3152f88-8b06-4f7f-bbbe-129512f49f87", "access_config_name" : "myapinew322", "access_config_tag" : [ { "key" : "my01", "value" : "001" }, { "key" : "my02", "value" : "002" } ], "access_config_type" : "K8S_CCE", "binary_collect" : false, "create_time" : 1684467787996, "host_group_info" : { "host_group_id_list" : [ "12b0bbd1-4eda-456b-a641-647aa66bdeab" ] }, "log_info" : { "log_group_id" : "9575cb24-290c-478e-a5db-88d6d1dc513b", "log_group_name" : "my-group", "log_stream_id" : "3581bee9-8698-476e-a0ba-b0f310ed99cf", "log_stream_name" : "lts-topic-api" }, "log_split" : false }, { "access_config_detail" : { "containerNameRegex" : "my", "excludeEnvs" : { "h" : "8" }, "excludeK8sLabels" : { "e" : "5" }, "excludeLabels" : { "b" : "2" }, "format" : { "single" : { "mode" : "system", "value" : "1678969382000" } }, "includeEnvs" : { "g" : "7" }, "includeK8sLabels" : { "d10" : "4", "d" : "4", "d12" : "4", "d11" : "4", "d14" : "4", "d13" : "4", "d16" : "4", "d15" : "4", "d18" : "4", "d17" : "4", "d1" : "4", "d2" : "4", "d3" : "4", "d4" : "4", "d5" : "4", "d6" : "4", "d7" : "4", "d8" : "4", "d9" : "4" }, "includeLabels" : { "a" : "1" }, "logEnvs" : { "i" : "9" }, "logK8s" : { "f" : "6" }, "logLabels" : { "c" : "3" }, "namespaceRegex" : "default", "pathType" : "container_stdout", "paths" : [ ], "podNameRegex" : "abc", "stderr" : false, "stdout" : true }, "access_config_id" : "550cd738-7b16-4724-9c59-aba61bf16528", "access_config_name" : "myapinew32", "access_config_tag" : [ { "key" : "my01", "value" : "001" }, { "key" : "my02", "value" : "002" } ], "access_config_type" : "K8S_CCE", "binary_collect" : false, "create_time" : 1684463134956, "host_group_info" : { "host_group_id_list" : [ "12b0bbd1-4eda-456b-a641-647aa66bdeab" ] }, "log_info" : { "log_group_id" : "9575cb24-290c-478e-a5db-88d6d1dc513b", "log_group_name" : "my-group", "log_stream_id" : "3581bee9-8698-476e-a0ba-b0f310ed99cf", "log_stream_name" : "lts-topic-api" }, "log_split" : false } ], "total" : 2 } 状态码： 400 非法请求 建议根据error_msg直接修改该请求。 { "error_code" : "LTS.1807", "error_msg" : "Invalid access config name" } 状态码： 500 表明服务端能被请求访问到，但是服务内部出错。 { "error_code" : "LTS.0010", "error_msg" : "The system encountered an internal error" }

请求示例 查询日志接入信息，根据传入的Body体进行过滤。 POST https://{endpoint}/v3/{project_id}/lts/access-config-list { "access_config_name_list" : [ "采xx2", "22x", "2x", "采集Wjxxxx" ], "host_group_name_list" : [ "wwxx" ], "log_group_name_list" : [ "lts-grxx", "lts-xx", "lts-gxx" ], "log_stream_name_list" : [ "lts-topixx", "lts-txx" ], "access_config_tag_list" : [ { "key" : "xxx", "value" : "xxx" }, { "key" : "xxx1", "value" : "xxx1" } ] }

请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 从IAM服务获取的用户Token，获取方式请参见：获取用户Token 最小长度：1 最大长度：10000 缺省值：None 最小长度：1000 最大长度：2000 Content-Type 是 String 该字段填为：application/json;charset=UTF-8。 最小长度：30 最大长度：30 缺省值：None 最小长度：30 最大长度：30 表3 请求Body参数 参数 是否必选 参数类型 描述 access_config_name_list 是 Array of strings 接入配置名称列表 最小长度：1 最大长度：64 host_group_name_list 是 Array of strings 主机组名称列表 最小长度：1 最大长度：64 log_group_name_list 是 Array of strings 日志组名称列表 最小长度：1 最大长度：64 log_stream_name_list 是 Array of strings 日志流名称列表 最小长度：1 最大长度：64 access_config_tag_list 否 Array of accessConfigTag objects 接入配置标签，KEY不能重复,最多20个标签 表4 accessConfigTag 参数 是否必选 参数类型 描述 key 否 String 标签Key 最小长度：1 最大长度：128 value 否 String 标签Value 最小长度：0 最大长度：255

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

响应示例 状态码： 200 请求响应成功, 成功创建结构化配置。 { "2a473356cca5487f8373be891bffc1cf_8a75b77d-7d72-4d7e-8c50-a24562cf8b0b_fd5e1a7c-7412-475d-a013-8891d539574e" } 状态码： 400 BadRequest。非法请求。 建议根据error_msg直接修改该请求，不要重试该请求。 { "errorCode" : "LTS.0612", "errorMessage" : "timee fieldType is error" } 状态码： 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.0102", "error_msg" : "addOrUpdateTableTemplate exception" }

响应参数 状态码： 400 表7 响应Body参数 参数 参数类型 描述 error_code String 错误码。 枚举值： SVCSTG.ALS.200201 SVCSTG.ALS.200340 SVCSTG.ALS.200332 SVCSTG.ALS.200209 SVCSTG.ALS.200.339 error_msg String 调用失败响应信息描述。 枚举值： parseType is invalid/ smart extra failed./ The number of demo_fields and rules is not equal {字段名/别名} is repeated with internal fields userDefinedName repeat./ field name repeat check logContent type error nginx log_format is error 状态码： 401 表8 响应Body参数 参数 参数类型 描述 error_code String 错误码。 枚举值： LTS.0403 error_msg String 调用失败响应信息描述。 枚举值： Invalid projectId 状态码： 403 表9 响应Body参数 参数 参数类型 描述 error_code String 错误码。 枚举值： LTS.0403 error_msg String 调用失败响应信息描述。 枚举值： Invalid projectId 状态码： 500 表10 响应Body参数 参数 参数类型 描述 error_code String 错误码。 枚举值： LTS.0500 error_msg String 调用失败响应信息描述。 枚举值： Failed to query lts struct log