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

调试

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

请求参数

名称 类型 是否必选 示例值 描述
Action String DescribeLogMonitorAttribute

要执行的操作,取值:DescribeLogMonitorAttribute。

MetricName String cpu_total

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

详情请参见云产品监控项

返回数据

名称 类型 示例值 描述
Code String 200

状态码。

说明 200表示成功。
LogMonitor Struct

日志监控详情。

Aggregates Array

聚合计算定义。

Alias String HostName

字段别名。

FieldName String hostName

日志中原始的字段名称。

Function String count

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

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

最大值。

Min String 0

最小值。

GmtCreate Long 1547431398000

创建时间。

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

GroupId Long 12345

应用分组ID。

Groupbys List value

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

LogId Long 1234

日志ID。

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

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

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

MetricName String cpu_total

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

SlsLogstore String test-logstore

日志服务名称。

SlsProject String test-project

日志Project。

SlsRegionId String cn-hangzhou

日志服务所在的地域。

Tumblingwindows List 60

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

ValueFilter Array

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

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

Key String hostName

日志匹配的字段名。

Operator String contain

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

  • contain 包含
  • notContain:不包含
  • >:大于
  • <:小于
  • >=:大于等于
  • <=小于等于
Value String portal

日志匹配的字段值。

ValueFilterRelation String and

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

  • and:和
  • or:或
Message String metric not exist

错误信息。

RequestId String C6718537-E673-4A58-8EE1-24B8B38C7AAE

请求ID。

Success Boolean true

操作是否成功。true表示成功,false表示失败。

示例

请求示例

http(s)://[Endpoint]/?Action=DescribeLogMonitorAttribute
&MetricName=cpu_total
&<公共请求参数>

正常返回示例

XML 格式

<DescribeLogMonitorAttribute>
		  <Message>successful</Message>
		  <RequestId>BBD7B294-1325-46D1-BD08-848D6A6B9AC6</RequestId>
		  <LogMonitor>
			    <SlsProject>slsProject</SlsProject>
			    <Tumblingwindows>60</Tumblingwindows>
			    <SlsLogstore>slsLogstore</SlsLogstore>
			    <MetricExpress>{"extend":{}}</MetricExpress>
			    <GroupId>27739</GroupId>
			    <MetricName>cpu_total</MetricName>
			    <GmtCreate>1577766395000</GmtCreate>
			    <Aggregates>
				      <Function>count</Function>
				      <Min></Min>
				      <Max></Max>
				      <Alias>lh_source_count</Alias>
				      <FieldName>lh_source</FieldName>
			    </Aggregates>
			    <ValueFilterRelation>and</ValueFilterRelation>
			    <ValueFilter>
				      <Operator>contais</Operator>
				      <Value>test</Value>
				      <Key>hostName</Key>
			    </ValueFilter>
			    <LogId>12345</LogId>
			    <SlsRegionId>cn-hangzhou</SlsRegionId>
		  </LogMonitor>
		  <Code>200</Code>
		  <Success>true</Success>
</DescribeLogMonitorAttribute>

JSON 格式

{
  "Message": "successful",
  "RequestId": "BBD7B294-1325-46D1-BD08-848D6A6B9AC6",
  "LogMonitor": {
    "SlsProject": "slsProject",
    "Tumblingwindows": [
      60
    ],
    "SlsLogstore": "slsLogstore",
    "MetricExpress": "{\"extend\":{}}",
    "GroupId": 27739,
    "MetricName": "cpu_total",
    "GmtCreate": 1577766395000,
    "Aggregates": [
      {
        "Function": "count",
        "Min": "",
        "Max": "",
        "Alias": "lh_source_count",
        "FieldName": "lh_source"
      }
    ],
    "Groupbys": [],
    "ValueFilterRelation": "and",
    "ValueFilter": [
      {
        "Operator": "contais",
        "Value": "test",
        "Key": "hostName"
      }
    ],
    "LogId": 12345,
    "SlsRegionId": "cn-hangzhou"
  },
  "Code": 200,
  "Success": true
}

错误码

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