Queries the processes of a specified resource.

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. OpenAPI Explorer dynamically generates the sample code of the operation for different SDKs.

Request parameters

Parameter Type Required Example Description
Action String Yes DescribeMonitoringAgentProcesses

The operation that you want to perform. Set the value to DescribeMonitoringAgentProcesses.

InstanceId String Yes i-hp3hl3cx1pbahzy8****

The ID of the instance.

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

Response parameters

Parameter Type Example Description
Code String 200

The HTTP status code.

Note The value 200 indicates that the call was successful.
Message String The specified resource is not found.

The returned message.

NodeProcesses Array of NodeProcess

The information about the processes.

NodeProcess
Command String number

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.
GroupId String 3619****

The ID of the application group.

InstanceId String i-hp3hl3cx1pbahzy8****

The ID of the instance.

ProcessId Long 234567

The ID of the process.

ProcessName String Nginx

The name of the process.

ProcessUser String alice

The user who launched the process.

RequestId String C11C0E85-6862-4F25-8D66-D6A5E0882984

The ID of the request.

Success Boolean true

Indicates whether the call was successful. Valid values:

  • true: The call was successful.
  • false: The call failed.

Examples

Sample requests

http(s)://[Endpoint]/?Action=DescribeMonitoringAgentProcesses
&InstanceId=i-hp3hl3cx1pbahzy8****
&<Common request parameters>

Sample success responses

XML format

<DescribeMonitoringAgentProcessesResponse>
	  <RequestId>C11C0E85-6862-4F25-8D66-D6A5E0882984</RequestId>
	  <NodeProcesses>
		    <NodeProcess>
			      <ProcessName>HTTP</ProcessName>
			      <InstanceId>i-hp3hl3cx1pbahzy8****</InstanceId>
			      <Command>number</Command>
			      <ProcessId>123456</ProcessId>
		    </NodeProcess>
		    <NodeProcess>
			      <ProcessName>Nginx</ProcessName>
			      <ProcessUser>alice</ProcessUser>
			      <GroupId>3619****</GroupId>
			      <InstanceId>i-hp3hl3cx1pbahzy8****</InstanceId>
			      <Command>number</Command>
			      <ProcessId>234567</ProcessId>
		    </NodeProcess>
	  </NodeProcesses>
	  <Code>200</Code>
	  <Success>true</Success>
</DescribeMonitoringAgentProcessesResponse>

JSON format

{
    "RequestId": "C11C0E85-6862-4F25-8D66-D6A5E0882984",
    "NodeProcesses": {
        "NodeProcess": [
            {
                "ProcessName": "HTTP",
                "InstanceId": "i-hp3hl3cx1pbahzy8****",
                "Command": "number",
                "ProcessId": 123456
            },
            {
                "ProcessName": "Nginx",
                "ProcessUser": "alice",
                "GroupId": "3619****",
                "InstanceId": "i-hp3hl3cx1pbahzy8****",
                "Command": "number",
                "ProcessId": 234567
            }
        ]
    },
    "Code": 200,
    "Success": true
}

Error codes

HTTP status code Error code Error message Description
404 ResourceNotFound The specified resource is not found. The error message returned because the specified resource is not found.

For a list of error codes, visit the API Error Center.