文档

PutLogMonitor - 创建或修改日志监控

更新时间:

调用PutLogMonitor接口创建或修改日志监控。

接口说明

本文将提供一个示例,创建一个日志监控cpu_total。返回结果显示,创建日志监控成功,日志监控 ID 为16****

调试

您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

授权信息

下表是API对应的授权信息,可以在RAM权限策略语句的Action元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:

  • 操作:是指具体的权限点。
  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:
    • 对于必选的资源类型,用背景高亮的方式表示。
    • 对于不支持资源级授权的操作,用全部资源表示。
  • 条件关键字:是指云产品自身定义的条件关键字。
  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作访问级别资源类型条件关键字关联操作
cms:PutLogMonitorWrite
  • 全部资源
    *

请求参数

名称类型必填描述示例值
LogIdstring

日志监控 ID。

16****
SlsRegionIdstring

日志服务中日志项目(Project)所在地域。

cn-hangzhou
SlsProjectstring

日志服务中日志项目的名称。

test-project
SlsLogstorestring

日志服务中日志库的名称。

test-logstore
MetricNamestring

监控项名称。关于云监控支持云服务的监控项,请参见云产品监控项

cpu_total
MetricExpressstring

扩展字段。 扩展字段为统计方法中的结果提供四则运算的功能。

例如:在统计方法中配置了 HTTP 状态码请求总数 TotalNumber 和 HTTP 状态码大于 499 的请求数 5xxNumber,则可以通过扩展字段计算出服务端的错误率:5xxNumber/TotalNumber*100。

JSON 格式:{"extend":{"errorPercent":"5xxNumber/TotalNumber*100"}}。字段说明如下:

  • extend:必填字段。

  • errorPercent:计算结果生成新字段的别名,您可以根据真实情况自行命名。

  • errorPercent:现有字段的计算表达式。

{"extend":{"errorPercent":"5XXNumber/TotalNumber*100"}}
GroupIdstring

应用分组 ID。

7301****
ValueFilterRelationstring

日志筛选的过滤条件。取值:

  • and:和。

  • or:或。

说明 本参数需要与ValueFilter.N.Key配合使用。
and
Tumblingwindowsstring

预计算窗口时间。单位:秒。云监控将在定义的预计算时间对数据做一次聚合计算。

60,300
Unitstring

单位。

Percent
Aggregatesobject []

聚合计算定义。

FieldNamestring

聚合计算原始的字段名称。N 的取值范围:1~10。

sourceCount
Functionstring

在计算周期内根据选定的统计方法对日志数据进行聚合处理。N 的取值范围:1~10。取值:

  • count:计数。
  • sum:求和。
  • avg:平均值。
  • max:最大值。
  • min:最小值。
  • countps:计算统计周期内指定字段求 count 后的每秒平均值。
  • sumps:计算统计周期内指定字段求 sum 后的每秒平均值。
  • distinct:去重后计算统计周期内指定字段出现的次数。
count
Aliasstring

聚合计算别名。N 的取值范围:1~10。

Count
Groupbysobject []

对数据进行空间维度聚合。相当于 SQL 中的 Group By,根据指定的维度,对监控数据进行分组。如果 Group By 不选择任何维度,则根据聚合方法对全部监控数据进行聚合。

FieldNamestring

GroupBy 字段名称。N 的取值范围:1~10。

cpu
Aliasstring

GroupBy 别名。N 的取值范围:1~10。

CPUUtilization
ValueFilterobject []

筛选的过滤规则,配合 ValueFilterRelation 使用。相当于 SQL 中的 Where 条件。如果不填写,则表示对全部数据进行处理。例如:日志中有 Level 和 Error 字段,如果需要统计每分钟 Error 出现的次数,则统计方法可以定义为对 Level 求和,并且 Level=Error。

Keystring

日志匹配的字段名名称。N 的取值范围:1~10。

lh_source
Valuestring

日志匹配的字段值。N 的取值范围:1~10。

test
Operatorstring

字段值的匹配方式。N 的取值范围:1~10。取值:

  • contain:包含。
  • notContain:不包含。
  • >:大于。
  • <:小于。
  • >=:大于等于。
  • <=:小于等于。
contain

关于公共请求参数的详情,请参见公共参数

返回参数

名称类型描述示例值
object
Codestring

状态码。

说明 200 表示成功。
200
Messagestring

返回信息。结果如下:

  • 当操作成功时,返回successful

  • 当操作失败时,返回错误信息,例如:alias of aggreate must be set value.

successful
RequestIdstring

请求 ID。

91561287-0802-5F9C-9BDE-404C50D41B06
LogIdstring

日志监控 ID。

16****
Successboolean

操作是否成功。取值:

  • true:成功。

  • false:失败。

true

示例

正常返回示例

JSON格式

{
  "Code": "200",
  "Message": "successful",
  "RequestId": "91561287-0802-5F9C-9BDE-404C50D41B06",
  "LogId": "16****",
  "Success": true
}

错误码

HTTP status code错误码错误信息描述
400ParameterInvalid%s-
400LimitorErrorLog monitor limit is not enough-
403AccessForbiddenUser not authorized to operate on the specified resource.-
404ResourceNotFoundThe specified resource is not found.未找到指定资源。
500InternalErrorThe request processing has failed due to some unknown error.-

访问错误中心查看更多错误码。

变更历史

变更时间变更内容概要操作
暂无变更历史
  • 本页导读 (1)
文档反馈