华为云用户手册

  • 请求参数 表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参数 参数 是否必选 参数类型 描述 sql_alarm_rule_name 是 String SQL告警名称 最小长度:1 最大长度:64 is_css_sql 否 Boolean 是否管道符sql查询 缺省值:false sql_alarm_rule_description 否 String SQL告警信息描述 最小长度:0 最大长度:64 sql_requests 是 Array of SqlRequest objects SQL详细信息 frequency 是 CreateSqlAlarmRuleFrequency object 告警统计周期 condition_expression 是 String 条件表达式 最小长度:1 最大长度:1024 sql_alarm_level 是 String 告警级别 枚举值: Info Minor Major Critical sql_alarm_send 是 Boolean 是否发送 domain_id 是 String domainId 最小长度:32 最大长度:32 notification_save_rule 否 SqlNotificationSaveRule object 通知主题 trigger_condition_count 否 Integer 触发条件:触发次数;默认为1 trigger_condition_frequency 否 Integer 触发条件:触发周期;默认为1 whether_recovery_policy 否 Boolean 是否打开恢复通知;默认false recovery_policy 否 Integer 恢复策略周期;默认为3 notification_frequency 是 Integer 通知频率,单位(分钟) 枚举值: 0 5 10 15 30 60 180 360 alarm_action_rule_name 否 String 告警行动规则名称 说明: alarm_action_rule_name和notification_save_rule可以选填一个,如果都填,优先选择alarm_action_rule_name 表4 SqlRequest 参数 是否必选 参数类型 描述 is_time_range_relative 否 Boolean 是时间范围相对 log_stream_id 是 String 日志流id 最小长度:36 最大长度:36 log_stream_name 否 String 日志流名称 最小长度:1 最大长度:64 log_group_id 是 String 日志组id 最小长度:36 最大长度:36 log_group_name 否 String 日志组名称 最小长度:1 最大长度:64 sql 是 String sql语句 最小长度:1 最大长度:1024 sql_request_title 是 String 图表名称 最小长度:1 最大长度:64 search_time_range 是 Integer 查询执行任务时最近数据的时间范围(当search_time_range_unit为minute,则最大值为60;当search_time_range_unit为hour,则最大值为24) 最小值:1 最大值:60 search_time_range_unit 是 String 查询时间单位 枚举值: minute hour 表5 CreateSqlAlarmRuleFrequency 参数 是否必选 参数类型 描述 type 是 String 时间类型。 枚举值: CRON HOURLY DAILY WEEKLY FIXED_RATE cron_expr 否 String 当字段type为"CRON"时取该字段。 最小长度:1 最大长度:1024 hour_of_day 否 Integer 当字段type为"DAILY"或者"WEEKLY"时取该字段。 DAILY:最小值:0,最大值:23 WEEKLY:最小值:0,最大值:23 day_of_week 否 Integer 当字段type为"WEEKLY"时取该字段(周日~周六)。 fixed_rate 否 Integer 当字段type为"FIXED_RATE"时取该字段(当fixed_rate_unit单位为minute,最大值60;当fixed_rate_unit单位为hour,最大值24)。 最小值:1 最大值:60 fixed_rate_unit 否 String 时间单位。 枚举值: minute hour 表6 SqlNotificationSaveRule 参数 是否必选 参数类型 描述 language 是 String 首选项对应的语言 最小长度:0 最大长度:10 枚举值: zh-cn en-us timezone 否 String 首选项对应的时区信息 最小长度:0 最大长度:1024 user_name 是 String 用户名 最小长度:1 最大长度:1024 topics 是 Array of Topics objects 主题信息 template_name 是 String 消息模板名称 表7 Topics 参数 是否必选 参数类型 描述 name 是 String 主题名称。 最小长度:1 最大长度:1024 topic_urn 是 String Topic的唯一的资源标识。 最小长度:1 最大长度:1024 display_name 否 String Topic的显示名,推送邮件消息时,作为邮件发件人显示。 最小长度:1 最大长度:1024 push_policy 否 Integer 消息推送的策略。 最小值:1 最大值:1024
  • 请求示例 删除消息模板 POST https://{endpoint}/v2/{project_id}/{domain_id}/lts/events/notification/templates /v2/{project_id}/{domain_id}/lts/events/notification/templates {"template_names":["template1","template2"]}
  • 响应示例 状态码: 400 BadRequest 非法请求 建议根据error_msg直接修改该请求。 { "error_code" : "LTS.2015", "error_msg" : "delete template name is empty or projectId is null" } 状态码: 500 表明服务端能被请求访问到,但是服务内部出错。 { "error_code" : "LTS.2015", "error_msg" : "Failed to delete notification template." }
  • URI DELETE /v2/{project_id}/{domain_id}/lts/events/notification/templates 表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参数 参数 是否必选 参数类型 描述 template_names 是 Array of strings 待删除模板名称数组
  • 响应参数 状态码: 400 表4 响应Body参数 参数 参数类型 描述 error_code String 错误码。 最小长度:8 最大长度:8 error_msg String 调用失败响应信息描述。 状态码: 500 表5 响应Body参数 参数 参数类型 描述 error_code String 错误码。 最小长度:8 最大长度:8 error_msg String 调用失败响应信息描述。
  • 响应示例 状态码: 400 BadRequest 非法请求 建议根据error_msg直接修改该请求。 { "error_code" : "LTS.2016", "error_msg" : "desc is invalid!" } 状态码: 500 表明服务端能被请求访问到,但是服务内部出错。 { "error_code" : "LTS.2016", "error_msg" : "Failed to update notification template" }
  • 响应参数 状态码: 201 表5 响应Body参数 参数 参数类型 描述 name String 通知规则名称,必填,只含有汉字、数字、字母、下划线、中划线,不能以下划线等特殊符号开头和结尾,长度为 1 - 100,创建后不可修改 最小长度:1 最大长度:100 type Array of strings 保留字段,非必填 desc String 模板描述,必填,只含有汉字、数字、字母、下划线不能以下划线开头和结尾,长度为0--1024 最小长度:0 最大长度:1024 source String 模板来源,目前必填为LTS,否则会筛选不出来 最小长度:3 最大长度:3 locale String 语言,必填,目前可填zh-cn和en-us 枚举值: zh-cn en-us templates Array of SubTemplateResBody objects 模板正文,为一个数组 表6 SubTemplateResBody 参数 参数类型 描述 sub_type String 模板子类型,只支持以下6种类型:sms,dingding,wechat,webhook,email 枚举值: 枚举值: sms dingding wechat webhook email voice content String 子模版正文,$符号后所跟变量仅支持以下变量,根据不同告警类型(关键词告警和sql告警),所支持的变量亦不相同。目前两种告警类型有共同变量如下: 告警级别:${event_severity}; 发生时间:${starts_at}; 告警源:$event.metadata.resource_provider; 资源类型:$event.metadata.resource_type; 资源标识:${resources}; 统计类型:关键词统计; 表达式:$event.annotations.condition_expression; 当前值: $event.annotations.current_value; 统计周期:$event.annotations.frequency; 关键词告警特有变量: 查询时间:$event.annotations.results[0].time; 查询日志:$event.annotations.results[0].raw_results; sql告警特有变量: 日志组/流名称:$event.annotations.results[0].resource_id; 查询语句:$event.annotations.results[0].sql; 查询时间:$event.annotations.results[0].time; 查询URL:$event.annotations.results[0].url; 查询日志:$event.annotations.results[0].raw_results; 说明: 变量后面的分号";"为英文符号,必须添加,否则模板会出现替换失败的情况。 状态码: 400 表7 响应Body参数 参数 参数类型 描述 error_code String 错误码。 最小长度:8 最大长度:8 error_msg String 调用失败响应信息描述。 状态码: 500 表8 响应Body参数 参数 参数类型 描述 error_code String 错误码。 最小长度:8 最大长度:8 error_msg String 调用失败响应信息描述。
  • 请求示例 修改消息模板 PUT https://{endpoint}/v2/{project_id}/{domain_id}/lts/events/notification/templates { "name" : "xxx", "desc" : "xxxxxx", "type" : [ ], "source" : "LTS", "locale" : "zh-cn", "templates" : [ { "sub_type" : "sms", "content" : "告警级别:${event_severity};\n发生时间:${starts_at};\n资源标识:${resources};\n统计类型:关键词统计;\n表达式:$event.annotations.condition_expression;\n当前值: $event.annotations.current_value;\n统计周期:$event.annotations.frequency;" }, { "sub_type" : "dingding", "content" : "告警级别:${event_severity};\n发生时间:${starts_at};\n资源标识:${resources};\n统计类型:关键词统计;\n表达式:$event.annotations.condition_expression;\n当前值: $event.annotations.current_value;\n统计周期:$event.annotations.frequency;" }, { "sub_type" : "wechat", "content" : "告警级别:${event_severity};\n发生时间:${starts_at};\n资源标识:${resources};\n统计类型:关键词统计;\n表达式:$event.annotations.condition_expression;\n当前值: $event.annotations.current_value;\n统计周期:$event.annotations.frequency;" }, { "sub_type" : "webhook", "content" : "告警级别:${event_severity};\n发生时间:${starts_at};\n资源标识:${resources};\n统计类型:关键词统计;\n表达式:$event.annotations.condition_expression;\n当前值: $event.annotations.current_value;\n统计周期:$event.annotations.frequency;" }, { "sub_type" : "email", "content" : "告警级别:${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;" }, { "sub_type" : "voice", "content" : "告警级别:${event_severity}; \n发生时间:${starts_at}; \n资源标识:${resources}; \n统计类型:关键词统计; \n表达式:$event.annotations.condition_expression; \n当前值: $event.annotations.current_value; \n统计周期:$event.annotations.frequency;" } ] }
  • 请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 从IAM服务获取的用户Token,获取方式请参见:获取用户Token 最小长度:1000 最大长度:2000 Content-Type 是 String 该字段填为:application/json;charset=UTF-8。 最小长度:30 最大长度:30 表3 请求Body参数 参数 是否必选 参数类型 描述 name 是 String 通知规则名称,必填,只含有汉字、数字、字母、下划线、中划线,不能以下划线等特殊符号开头和结尾,长度为 1 - 100,创建后不可修改 最小长度:1 最大长度:100 type 否 Array of strings 保留字段,非必填 desc 是 String 模板描述,必填,只含有汉字、数字、字母、下划线不能以下划线开头和结尾,长度为0--1024 最小长度:0 最大长度:1024 source 是 String 模板来源,目前必填为LTS,否则会筛选不出来 最小长度:3 最大长度:3 locale 是 String 语言,必填,目前可填zh-cn和en-us 枚举值: zh-cn en-us templates 是 Array of UpdateSubTemplate objects 模板正文,为一个数组 表4 UpdateSubTemplate 参数 是否必选 参数类型 描述 sub_type 是 String 模板子类型,只支持以下6种类型:sms,dingding,wechat,webhook,email,voice 枚举值: sms dingding wechat webhook email voice content 是 String 子模版正文,$符号后所跟变量仅支持以下变量,根据不同告警类型(关键词告警和sql告警),所支持的变量亦不相同。目前两种告警类型有共同变量如下: 告警级别:${event_severity}; 发生时间:${starts_at}; 告警源:$event.metadata.resource_provider; 资源类型:$event.metadata.resource_type; 资源标识:${resources}; 统计类型:关键词统计; 表达式:$event.annotations.condition_expression; 当前值: $event.annotations.current_value; 统计周期:$event.annotations.frequency; 关键词告警特有变量: 查询时间:$event.annotations.results[0].time; 查询日志:$event.annotations.results[0].raw_results; sql告警特有变量: 日志组/流名称:$event.annotations.results[0].resource_id; 查询语句:$event.annotations.results[0].sql; 查询时间:$event.annotations.results[0].time; 查询URL:$event.annotations.results[0].url; 查询日志:$event.annotations.results[0].raw_results; 说明: 变量后面的分号";"为英文符号,必须添加,否则模板会出现替换失败的情况。
  • URI PUT /v2/{project_id}/{domain_id}/lts/events/notification/templates 表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
  • 响应参数 状态码: 200 表5 响应Body参数 参数 参数类型 描述 creation_time Long 创建该日志组的时间, 毫秒级。 log_group_name String 日志组的名称。 最小长度:1 最大长度:64 log_group_id String 日志组ID。 最小长度:36 最大长度:36 ttl_in_days Integer 日志存储时间(固定值为7天)。 取值范围为 [1, 365] 最小值: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
  • 状态码 状态码 描述 200 请求响应成功, 成功修改日志组。 400 BadRequest。非法请求。 建议根据error_msg直接修改该请求,不要重试该请求。 401 AuthFailed。鉴权失败, 请确认token后再次请求 。 403 Forbidden。请求被拒绝访问。返回该状态码,表明请求能够到达服务端,且服务端能够理解用户请求,但是拒绝做更多的事情,因为该请求被设置为拒绝访问,建议直接修改该请求,不要重试该请求。 500 InternalServerError。 表明服务端能被请求访问到,但是服务内部出错。
  • 响应示例 状态码: 200 请求响应成功, 成功修改日志组。 { "creation_time" : 156541515155541, "log_group_name" : "string", "log_group_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.0102", "error_msg" : "Failed to update log group" }
  • URI POST /v2/{project_id}/groups/{log_group_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。 缺省值: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参数 参数 是否必选 参数类型 描述 ttl_in_days 是 Integer 日志存储时间 (天)。 最小值:1 最大值:365 tags 否 Array of tagsBody objects 标签字段信息 表4 tagsBody 参数 是否必选 参数类型 描述 key 否 String 标签键 value 否 String 标签值
  • AK/SK认证 AK/SK签名认证方式仅支持消息体大小12MB以内,12MB以上的请求请使用Token认证。 AK/SK认证就是使用AK/SK对请求进行签名,在请求时将签名信息添加到消息头,从而通过身份认证。 AK(Access Key ID):访问密钥ID。与私有访问密钥关联的唯一标识符;访问密钥ID和私有访问密钥一起使用,对请求进行加密签名。 SK(Secret Access Key):与访问密钥ID结合使用的密钥,对请求进行加密签名,可标识发送方,并防止请求被修改。 使用AK/SK认证时,您可以基于签名算法使用AK/SK对请求进行签名,也可以使用专门的签名SDK对请求进行签名。 签名SDK只提供签名功能,与服务提供的SDK不同,使用时请注意。 AK/SK认证的详细操作方式,请参考《AK/SK签名认证操作指导》中签名SDK与demo章节里Java小节的操作。
  • Token认证 Token的有效期为24小时,需要使用一个Token鉴权时,可以先缓存起来,避免频繁调用。 Token在计算机系统中代表令牌(临时)的意思,拥有Token就代表拥有某种权限。Token认证就是在调用API的时候将Token加到请求消息头,从而通过身份认证,获得操作API的权限。 Token可通过调用获取用户Token接口获取,调用本服务API需要project级别的Token,即调用获取用户Token接口时,请求body中auth.scope的取值需要选择project,如下所示。 { "auth": { "identity": { "methods": [ "password" ], "password": { "user": { "name": "username", "password": "********", "domain": { "name": "domainname" } } } }, "scope": { "project": { "name": "xxxxxxxx" } } } } 获取Token 后,再调用其他接口时,您需要在请求消息头中添加“X-Auth-Token”,其值即为Token。例如Token值为“ABCDEFJ....”,则调用接口时将“X-Auth-Token: ABCDEFJ....”加到请求消息头即可,如下所示。 POST https://iam.cn-north-1.myhuaweicloud.com/v3/auth/projects Content-Type: application/json X-Auth-Token: ABCDEFJ....
  • 响应参数 状态码: 200 表5 响应Body参数 参数 参数类型 描述 result Array of GetHostListInfo objects 主机列表 total Long 主机信息总数量 最小值:0 最大值:10000 表6 GetHostListInfo 参数 参数类型 描述 host_id String 主机ID 最小长度:36 最大长度:36 host_ip String 主机IP 最小长度:1 最大长度:16 host_name String 主机名称 最小长度:1 最大长度:128 host_status String 主机状态。 uninstall:未安装 running:运行 offline:离线 error:异常 plugin error:插件错误 installing:安装中 install-fail:安装失败 upgrading:升级中 upgrading-transient:升级中 upgrade failed:升级失败 upgrade-fail:升级失败 uninstalling:卸载中 uninstalling-transient:卸载中 authentication error:鉴权失败 枚举值: uninstall running offline error plugin error installing install-fail upgrading upgrading-transient upgrade failed upgrade-fail uninstalling uninstalling-transient authentication error host_type String 主机类型。linux:linux类型,windows:windows类型 枚举值: linux windows host_version String 主机版本 最小长度:1 最大长度:16 update_time Long 更新时间 最小值:13 最大值:13 状态码: 400 表7 响应Body参数 参数 参数类型 描述 error_code String 错误码 最小长度:8 最大长度:8 error_msg String 错误描述 最小长度:1 最大长度:1000 状态码: 500 表8 响应Body参数 参数 参数类型 描述 error_code String 错误码 最小长度:8 最大长度:8 error_msg String 错误描述 最小长度:1 最大长度:1000
  • 请求示例 查询主机信息,根据传入的Body体进行过滤。若是body体中无过滤参数,则查询全量数据。 POST https://{endpoint}/v3/{project_id}/lts/host-list { "host_id_list" : [ "713a9f81-574b-45aa-92df-24c4caxxxxxx", "c7085aa9-2142-4ada-9f78-bf81ffxxxxxx" ], "filter" : { "host_name_list" : [ "ecs-xxxx", "10.66.16xxx" ], "host_ip_list" : [ "192.168xxxx" ], "host_status" : "ruxxxx", "host_version" : "5.13.xxxx" } }
  • 响应示例 状态码: 200 查询主机信息请求响应成功 { "result" : [ { "host_id" : "dc1dab7e-b045-4e77-bda4-914xxxxxx", "host_ip" : "172.16.xxxx", "host_name" : "ecs-apmtexxxxxx", "host_status" : "xxxxxx", "host_type" : "xxxxx", "host_version" : "5.13.xx.x", "update_time" : 1637223314526 } ], "total" : 1 } 状态码: 400 BadRequest 非法请求 建议根据error_msg直接修改该请求。 { "error_code" : "LTS.1807", "error_msg" : "Invalid host id" } 状态码: 500 表明服务端能被请求访问到,但是服务内部出错 { "error_code" : "LTS.0010", "error_msg" : "Internal Server Error" }
  • 请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 从IAM服务获取的用户Token,获取方式请参见:获取用户Token 最小长度:1 最大长度:10000 Content-Type 是 String 该字段填为:application/json;charset=utf8。 最小长度:30 最大长度:30 表3 请求Body参数 参数 是否必选 参数类型 描述 host_id_list 否 Array of strings 主机ID列表。可以根据主机ID列表进行批量过滤 最小长度:36 最大长度:36 filter 是 GetHostListFilter object 查询主机信息过滤参数 表4 GetHostListFilter 参数 是否必选 参数类型 描述 host_name_list 否 Array of strings 主机名称列表。可以根据主机名称列表,进行批量过滤 最小长度:1 最大长度:128 host_ip_list 否 Array of strings 主机IP列表。可以根据主机IP列表,进行批量过滤。 最小长度:1 最大长度:16 host_status 否 String 主机状态。可以根据主机状态进行过滤。 uninstall:未安装 running:运行 offline:离线 error:异常 plugin error:插件错误 installing:安装中 install-fail:安装失败 upgrading:升级中 upgrading-transient:升级中 upgrade failed:升级失败 upgrade-fail:升级失败 uninstalling:卸载中 uninstalling-transient:卸载中 authentication error:鉴权失败 枚举值: uninstall running offline error plugin error installing install-fail upgrading upgrading-transient upgrade failed upgrade-fail uninstalling uninstalling-transient authentication error host_version 否 String 主机版本。可以根据主机版本进行过滤。 最小长度:1 最大长度:16
  • 查询日志流 接口相关信息 URI格式:GET /v2/{project_id}/groups/{log_group_id}/streams 请求示例 GET https://{endpoint}/v2/{project_id}/groups/{log_group_id}/streams {endpoint}信息请从终端节点获取。 响应示例 { "log_streams" : [ { "creation_time" : number, "log_stream_name" : "string", "log_stream_id" : "string", "filter_count" : number } ] }
  • 响应参数 状态码: 403 表3 响应Body参数 参数 参数类型 描述 error_code String 错误码。 枚举值: LTS.0403 error_msg String 调用失败响应信息描述。 枚举值: Invalid projectId 状态码: 500 表4 响应Body参数 参数 参数类型 描述 error_code String 错误码。 枚举值: LTS.0403 error_msg String 调用失败响应信息描述。 枚举值: Invalid projectId
  • 响应示例 状态码: 403 Forbidden。请求被拒绝访问。返回该状态码,表明请求能够到达服务端,且服务端能够理解用户请求,但是拒绝做更多的事情,因为该请求被设置为拒绝访问,建议直接修改该请求,不要重试该请求。 { "error_code" : "LTS.0001", "error_msg" : "Invalid projectId" } 状态码: 500 更新超额采集开关状态失败。 { "error_code" : "LTS.0210", "error_msg" : "Update continue Collection Status error." }
  • 创建日志流 接口相关信息 URI格式:POST /v2/{project_id}/groups/{log_group_id}/streams 请求示例 POST https://{endpoint}/v2/{project_id}/groups/{log_group_id}/streams {endpoint}信息请从终端节点获取。 Body: { "log_stream_name": "lts-stream-02kh" } 响应示例 { "log_stream_id" : "string" }
  • 请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 从IAM服务获取的用户Token,获取方式请参见:获取用户Token 缺省值:None 最小长度:1000 最大长度:2000 Content-Type 是 String 该字段填为:application/json;charset=UTF-8。 缺省值:None 最小长度:30 最大长度:30
  • URI DELETE /v2/{project_id}/lts/alarms/keywords-alarm-rule/{keywords_alarm_rule_id} 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 项目ID,账号ID,日志组ID、日志流ID,获取方式请参见:获取项目ID,获取账号ID,日志组ID、日志流ID 缺省值:None 最小长度:32 最大长度:32 keywords_alarm_rule_id 是 String 关键词告警规则id。 缺省值:None 最小长度:36 最大长度:36
  • 响应示例 状态码: 201 创建仪表盘成功 { "charts" : [ ], "filters" : [ ], "group_name" : "", "id" : "2bf23310-83c2-4962-898f-79ebd057a256", "last_update_time" : 1669637866189, "project_id" : "2a473356cca5487f8373be891bffc1cf", "title" : "test", "useSystemTemplate" : false } 状态码: 400 BadRequest 非法请求建议根据error_msg直接修改该请求 { "message" : { "code" : "LTS.0736", "details" : "The number of log dashboards exceeds the maximum" } } 状态码: 500 表明服务端能被请求访问到,但是服务内部出错 { "message" : { "code" : "LTS.0203", "details" : "Internal Server Error" } }
  • 请求参数 表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 仪表盘分组名称 title 是 String 仪表盘名称
共100000条