QueryMonitor - Query MSE instance monitoring metrics - Microservices Engine

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

mse:QueryMonitor

get

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
RequestPars	string	No	Extended request parameters in JSON format.	{}
MonitorType	string	Yes	The metric type. Valid values: [Basic system metrics] cpuUsage memoryUsage diskUsage gcCount gcTime [Nacos registry] serviceCount writeCostTime readCostTime TPS regCenterTps QPS regCenterQps [Nacos configuration center] publish getConfig [zookeeper] TPS zk_TpsCount QPS zk_QpsCount zookeeper_AvgRequestLatency	regCenterQps
StartTime	integer	Yes	The start timestamp of the monitoring period.	1666678376
EndTime	integer	Yes	The end timestamp of the monitoring period.	1666678376
Step	integer	No	The interval between data points. Unit: seconds.	7
InstanceId	string	No	The instance ID.	mse-cn-****
AcceptLanguage	string	No	The language of the response. Valid values: zh: Chinese en: English	zh

Response elements

Element	Type	Description	Example
	object	The response body.
Message	string	The response message.	The request was successfully processed.
RequestId	string	The request ID.	ADDD8AB7-8D1C-4697-A83E-410D2607****
Data	array<object>	The monitoring data.	6
	array<object>	A monitoring data entry.
podName	string	The pod name.	mse-xxxxxx-xxxxxx-reg-center-0-0
clusterNamePrefix	string	The cluster name prefix.	mse-xxxx-xxxxxx
values	array<object>	The details of the data.
	object	A data point entry.
ErrorCode	string	The error code returned on failure.	mse-100-000
Success	boolean	Whether the request succeeded. Valid values: `true`: The request was successful. `false`: The request failed.	true

Examples

Success response

JSON format

{
  "Message": "The request was successfully processed.\n",
  "RequestId": "ADDD8AB7-8D1C-4697-A83E-410D2607****",
  "Data": [
    {
      "podName": "mse-xxxxxx-xxxxxx-reg-center-0-0",
      "clusterNamePrefix": "mse-xxxx-xxxxxx",
      "values": [
        {
          "test": "test",
          "test2": 1
        }
      ]
    }
  ],
  "ErrorCode": "mse-100-000",
  "Success": true
}

Error codes

HTTP status code	Error code	Error message	Description
400	IllegalRequest	Invalid request:%s	Invalid request: %s
400	InvalidParameter	Parameter error:%s	Request parameter error: %s
500	InternalError	Console error. Try again later:%s	Console error. Try again later: %s
403	NoPermission	You are not authorized to perform this operation:%s	You do not have the permission to use this interface:%s
404	NotFound	Not found:%s	The resource does not exist:%s

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.