DescribeLogMonitorList - Cloud Monitor - Alibaba Cloud Documentation Center

Queries log monitoring metrics.

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.
API: The API that you can call to perform the action.
Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.
Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.
- For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.
- For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.
Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.
Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

Action

Access level

Resource type

Condition key

Dependent action

cms:DescribeLogMonitorList

get

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
PageNumber	integer	No	The page number.	1
PageSize	integer	No	The number of entries per 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	integer	No	The ID of the application group.	123456

Response elements

Element	Type	Description	Example
	object
RequestId	string	The request ID.	01E90080-4300-4FAA-B9AE-161956BC350D
Success	boolean	Indicates whether the request was successful. Valid values: true false	true
Code	string	The status code. Note The status code 200 indicates that the request was successful.	200
Message	string	The returned message.	successful
PageSize	integer	The number of entries per page.	10
PageNumber	integer	The page number.	1
Total	integer	The total number of entries returned.	15
LogMonitorList	array<object>	The log monitoring metrics.
	array<object>
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 Simple Log Service (SLS) Logstore.	testSlS****
MetricName	string	The metric name. For more information, see Appendix 1: Metrics.	cpu_total
GroupId	integer	The ID of the application group.	12345
LogId	integer	The ID of the log monitoring metric.	12345
SlsRegionId	string	The ID of the region where the SLS Logstore resides.	cn-hangzhou
GmtCreate	integer	The time when the log monitoring metric was created. This value is a UNIX timestamp representing the number of milliseconds that have elapsed since January 1, 1970, 00:00:00 UTC.	1577766395000
SlsProject	string	The name of the SLS project.	sls-project-test****
ValueFilter	array<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. For example, logs contain the Level and Error fields. 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.
	object
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: contains notContain: does not contain `>`: greater than `<`: less than `>=`: greater than or equal to `<=`: less than or equal to	contain

Examples

Success response

JSON format

{
  "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.
500	InternalError	The request processing has failed due to some unknown error.
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.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.