DescribeLogMonitorList - CloudMonitor - Alibaba Cloud Documentation Center

Queries log monitoring metrics.

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer.

Debug

Authorization information

There is currently no authorization information disclosed in the API.

Request parameters

Parameter	Type	Required	Description	Example
PageNumber	integer	No	The number of the page to return.	1
PageSize	integer	No	The number of entries to return on each page. Default value: 10	10
SearchValue	string	No	The keyword that is used to search for log monitoring metrics. Fuzzy match is supported.	test
GroupId	long	No	The ID of the application group.	123456

Response parameters

Parameter	Type	Description	Example
	object
RequestId	string	The ID of the request.	01E90080-4300-4FAA-B9AE-161956BC350D
Success	boolean	Indicates whether the call was successful. Valid values: true: The call was successful. false: The call failed.	true
Code	string	The HTTP status code. Note The status code 200 indicates that the call was successful.	200
Message	string	The returned message.	successful
PageSize	integer	The number of entries returned on each page.	10
PageNumber	integer	The number of the returned page.	1
Total	long	The total number of the returned entries.	15
LogMonitorList	object []	The log monitoring metrics.
ValueFilterRelation	string	The logical operator that is used between log filter conditions. The ValueFilter and ValueFilterRelation parameters are used in pair. Valid values: and or	and
SlsLogstore	string	The name of the Log Service Logstore.	testSlS****
MetricName	string	The name of the log monitoring metric. For more information, see Appendix 1: Metrics.	cpu_total
GroupId	long	The ID of the application group.	12345
LogId	long	The ID returned by Log Service.	12345
SlsRegionId	string	The ID of the region where the Log Service Logstore resides.	cn-hangzhou
GmtCreate	long	The time when the log monitoring metric was created. This value is a UNIX timestamp representing the number of milliseconds that have elapsed since the epoch time January 1, 1970, 00:00:00 UTC.	1577766395000
SlsProject	string	The name of the Log Service project.	sls-project-test****
ValueFilter	object []	The condition that is used to filter logs. The ValueFilter and ValueFilterRelation parameters are used in pair. The filter condition is equivalent to the WHERE clause in SQL statements. If no filter condition is specified, all logs are processed. Assume that logs contain the Level field, which may be set to Error. If you need to calculate the number of times that logs of the Error level appear every minute, you can set the filter condition to Level=Error and count the number of logs that meet this condition.
Key	string	The name of the log field used for matching in the filter condition.	hostName
Value	string	The field value to be matched in the filter condition.	portal
Operator	string	The method that is used to match the field value. Valid values: contain notContain `>`: greater than `<`: less than `>=`: greater than or equal to `<=`: less than or equal to	contain

Examples

Sample success responses

JSONformat

{
  "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"
        }
      ]
    }
  ]
}

Error codes

HTTP status code	Error code	Error message	Description
400	ParameterInvalid	Illegal parameters.	-
403	AccessForbidden	User not authorized to operate on the specified resource.	-
404	ResourceNotFound	The specified resource is not found.	The specified resource is not found.
500	InternalError	The request processing has failed due to some unknown error.	-

For a list of error codes, visit the Service error codes.