文档

DescribeLogMonitorList - 获取日志监控列表

更新时间:

调用DescribeLogMonitorList接口获取日志监控列表。

调试

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

授权信息

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

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

请求参数

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

页码。

1
PageSizeinteger

每页显示记录条数。默认:10。

10
SearchValuestring

监控项搜索。支持模糊搜索。

test
GroupIdlong

应用分组 ID。

123456

返回参数

名称类型描述示例值
object
RequestIdstring

请求 ID。

01E90080-4300-4FAA-B9AE-161956BC350D
Successboolean

操作是否成功。取值:

  • true:成功。

  • false:失败。

true
Codestring

状态码。

说明 200 表示成功。
200
Messagestring

返回信息。

successful
PageSizeinteger

分页大小。

10
PageNumberinteger

当前页码。

1
Totallong

总记录条数。

15
LogMonitorListobject []

日志监控列表。

ValueFilterRelationstring

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

  • and:表示和的关系。
  • or :表示或的关系。
and
SlsLogstorestring

日志服务名称。

testSlS****
MetricNamestring

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

cpu_total
GroupIdlong

应用分组 ID。

12345
LogIdlong

日志监控 ID。

12345
SlsRegionIdstring

日志服务所在的地域 ID。

cn-hangzhou
GmtCreatelong

创建时间。

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

1577766395000
SlsProjectstring

日志 Project。

sls-project-test****
ValueFilterobject []

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

Keystring

日志匹配的字段名称。

hostName
Valuestring

日志匹配的字段值。

portal
Operatorstring

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

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

示例

正常返回示例

JSON格式

{
  "RequestId": "01E90080-4300-4FAA-B9AE-161956BC350D",
  "Success": true,
  "Code": "200",
  "Message": "successful",
  "PageSize": 10,
  "PageNumber": 1,
  "Total": 15,
  "LogMonitorList": [
    {
      "ValueFilterRelation": "and",
      "SlsLogstore": "testSlS****",
      "MetricName": "cpu_total",
      "GroupId": 12345,
      "LogId": 12345,
      "SlsRegionId": "cn-hangzhou",
      "GmtCreate": 1577766395000,
      "SlsProject": "sls-project-test****",
      "ValueFilter": [
        {
          "Key": "hostName",
          "Value": "portal",
          "Operator": "contain"
        }
      ]
    }
  ]
}

JSON格式

{
  "RequestId": "01E90080-4300-4FAA-B9AE-161956BC350D",
  "Success": true,
  "Code": "200",
  "Message": "successful",
  "PageSize": 10,
  "PageNumber": 1,
  "Total": 15,
  "LogMonitorList": [
    {
      "ValueFilterRelation": "and",
      "SlsLogstore": "testSlS****",
      "MetricName": "cpu_total",
      "GroupId": 12345,
      "LogId": 12345,
      "SlsRegionId": "cn-hangzhou",
      "GmtCreate": 1577766395000,
      "SlsProject": "sls-project-test****",
      "ValueFilter": [
        {
          "Key": "hostName",
          "Value": "portal",
          "Operator": "contain"
        }
      ]
    }
  ]
}

错误码

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.-

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