文档

DescribeLogMonitorAttribute - 获取日志监控详情

更新时间:

调用DescribeLogMonitorAttribute接口获取日志监控详情。

调试

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

授权信息

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

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

请求参数

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

监控项的名称。支持精确匹配。

详情请参见云产品监控项

cpu_total

返回参数

名称类型描述示例值
object
Codestring

状态码。

说明 200 表示成功。
200
Messagestring

返回信息。当请求成功时,返回成功信息;当请求失败时,返回失败原因。

successful
RequestIdstring

请求 ID。

C6718537-E673-4A58-8EE1-24B8B38C7AAE
Successboolean

操作是否成功。取值:

  • true:成功。

  • false:失败。

true
LogMonitorobject

日志监控详情。

ValueFilterRelationstring

日志筛选的过滤条件。需要和 ValueFilter 配合使用。取值:

  • and:和。
  • or:或。
and
SlsLogstorestring

日志服务名称。

test-logstore
MetricNamestring

监控项名称。详情请参见云产品监控项

cpu_total
GroupIdlong

应用分组 ID。

12345
LogIdlong

日志 ID。

1234
MetricExpressstring

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

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

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

日志服务所在的地域 ID。

cn-hangzhou
GmtCreatelong

创建时间。

格式为 Unix 时间戳,即从 1970 年 1 月 1 日开始所经过的秒数。

1547431398000
SlsProjectstring

日志 Project。

test-project
Aggregatesobject []

聚合计算定义。

Maxstring

最大值。

10
Minstring

最小值。

0
Functionstring

统计方法,即在统计周期内计算日志数据的函数方法。取值:

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

字段别名。

HostName
FieldNamestring

日志中原始的字段名称。

hostName
ValueFilterobject []

筛选的过滤规则,配合 ValueFilterRelation 使用。相当于 SQL 中的 Where 条件。

如果不填写,则表示对全部数据进行处理。例如:日志中有 Level 和 Error 字段,如果需要统计每分钟 Error 出现的次数,则统计方法可以定义为对 Level 求和,并且 Level=Error。

Keystring

日志匹配的字段名。

hostName
Valuestring

日志匹配的字段值。

portal
Operatorstring

字段值的匹配方式。取值:

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

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

60
Groupbysarray
string

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

value

示例

正常返回示例

JSON格式

{
  "Code": "200",
  "Message": "successful",
  "RequestId": "C6718537-E673-4A58-8EE1-24B8B38C7AAE",
  "Success": true,
  "LogMonitor": {
    "ValueFilterRelation": "and",
    "SlsLogstore": "test-logstore",
    "MetricName": "cpu_total",
    "GroupId": 12345,
    "LogId": 1234,
    "MetricExpress": "{\"extend\":{\"errorPercent\":\"5XXNumber/TotalNumber*100\"}}",
    "SlsRegionId": "cn-hangzhou",
    "GmtCreate": 1547431398000,
    "SlsProject": "test-project",
    "Aggregates": [
      {
        "Max": "10",
        "Min": "0",
        "Function": "count",
        "Alias": "HostName",
        "FieldName": "hostName"
      }
    ],
    "ValueFilter": [
      {
        "Key": "hostName",
        "Value": "portal",
        "Operator": "contain"
      }
    ],
    "Tumblingwindows": [
      "60"
    ],
    "Groupbys": [
      "value"
    ]
  }
}

JSON格式

{
  "Code": "200",
  "Message": "successful",
  "RequestId": "C6718537-E673-4A58-8EE1-24B8B38C7AAE",
  "Success": true,
  "LogMonitor": {
    "ValueFilterRelation": "and",
    "SlsLogstore": "test-logstore",
    "MetricName": "cpu_total",
    "GroupId": 12345,
    "LogId": 1234,
    "MetricExpress": "{\"extend\":{\"errorPercent\":\"5XXNumber/TotalNumber*100\"}}",
    "SlsRegionId": "cn-hangzhou",
    "GmtCreate": 1547431398000,
    "SlsProject": "test-project",
    "Aggregates": [
      {
        "Max": "10",
        "Min": "0",
        "Function": "count",
        "Alias": "HostName",
        "FieldName": "hostName"
      }
    ],
    "ValueFilter": [
      {
        "Key": "hostName",
        "Value": "portal",
        "Operator": "contain"
      }
    ],
    "Tumblingwindows": [
      "60"
    ],
    "Groupbys": [
      "value"
    ]
  }
}

错误码

HTTP status code错误码错误信息描述
400ParameterInvalidIllegal parameters.-
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.-

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