DescribeMonitoringAgentProcesses - CloudMonitor - Alibaba Cloud Documentation Center

Operation description

Note Before you call this operation, call the CreateMonitoringAgentProcess operation to create processes. For more information, see CreateMonitoringAgentProcess .

This topic provides an example of how to query the processes of the i-hp3hl3cx1pbahzy8**** instance. The response indicates the details of the NGINX and HTTP processes.

Debugging

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

Debug

Authorization information

The following table shows the authorization information corresponding to the API. The authorization information can be used in the Action policy element to grant a RAM user or RAM role the permissions to call this API operation. Description:

Operation: the value that you can use in the Action element to specify the operation on a resource.
Access level: the access level of each operation. The levels are read, write, and list.
Resource type: the type of the resource on which you can authorize the RAM user or the RAM role to perform the operation. Take note of the following items:
- The required resource types are displayed in bold characters.
- If the permissions cannot be granted at the resource level, All Resources is used in the Resource type column of the operation.
Condition Key: the condition key that is defined by the cloud service.
Associated operation: other operations that the RAM user or the RAM role must have permissions to perform to complete the operation. To complete the operation, the RAM user or the RAM role must have the permissions to perform the associated operations.

Operation	Access level	Resource type	Condition key	Associated operation
cms:DescribeMonitoringAgentProcesses	get	All Resources *	none	none

Request parameters

Parameter	Type	Required	Description	Example
InstanceId	string	Yes	The ID of the instance.	i-hp3hl3cx1pbahzy8****

For more information about common request parameters, see Common parameters.

Response parameters

Parameter	Type	Description	Example
	object
Code	string	The HTTP status code. Note The value 200 indicates that the call was successful.	200
Message	string	The returned message.	The specified resource is not found.
RequestId	string	The request ID.	C11C0E85-6862-4F25-8D66-D6A5E0882984
Success	boolean	Indicates whether the call was successful. Valid values: true: The call was successful. false: The call failed.	true
NodeProcesses	array<object>	The information about the processes.
	object
ProcessName	string	The name of the process.	Nginx
ProcessId	long	The ID of the process.	234567
GroupId	string	The ID of the application group.	3619****
Command	string	The command used to obtain the number of processes. Valid value: `number`. Note The `number` command obtains the number of processes that match the condition.	number
ProcessUser	string	The user who launched the process.	alice
InstanceId	string	The ID of the instance.	i-hp3hl3cx1pbahzy8****

Examples

Sample success responses

JSONformat

{
  "Code": "200",
  "Message": "The specified resource is not found.",
  "RequestId": "C11C0E85-6862-4F25-8D66-D6A5E0882984",
  "Success": true,
  "NodeProcesses": {
    "NodeProcess": [
      {
        "ProcessName": "Nginx",
        "ProcessId": 234567,
        "GroupId": "3619****",
        "Command": "number",
        "ProcessUser": "alice",
        "InstanceId": "i-hp3hl3cx1pbahzy8****"
      }
    ]
  }
}

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.

Change history

Change time	Summary of changes	Operation

No change history