All Products
Search
Document Center

Application Real-Time Monitoring Service:GetAppJVMConfig

Last Updated:May 29, 2026

Obtain the JVM configuration information of each instance of the application

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

arms:GetAppJVMConfig

none

*All Resource

*

None None

Request parameters

Parameter

Type

Required

Description

Example

RegionId

string

Yes

The region ID.

cn-hangzhou

Pid

string

No

The IDof the application.

Log on to the ARMS console. In the left-side navigation pane, choose Application Monitoring > Applications. On the Applications page, click the name of an application. The URL in the address bar contains the process ID (PID) of the application. The PID is indicated in the pid=xxx format. The PID is usually percent encoded as xxx%40xxx. You must modify this value to remove the percent encoding. For example, if the PID in the URL is eb4zdose6v%409781be0f44d****, you must replace %40 with an at sign (@) to obtain eb4zdose6v@9781be0f44d****.

atc889zkcf@d8deedfa9bf****

StartTime

integer

No

The start of the time range to query. Unit: milliseconds.

1480521600000

EndTime

integer

No

The end of the time range to query. Unit: milliseconds.

1480607940000

Response elements

Element

Type

Description

Example

object

Schema of Response

RequestId

string

The request ID.

1A9C645C-C83F-4C9D-8CCB-29BEC9E1****

Code

integer

The response code. Valid values: 2XX: The request is successful. 3XX: A redirection message is returned. 4XX: The request is invalid. 5XX: A server error occurs.

200

Message

string

The error message returned if the request failed.

message

Success

boolean

Indicates whether the request was successful. Valid values: true and false.

true

JvmInfoList

array<object>

The list of JVM information.

object

Pid

string

The application ID.

dsv9zcel92@1455182510c5369

VmArgs

string

The VM parameters.

[-javaagent:/home/admin/.opt/ArmsAgent/arms-bootstrap-1.7.0-SNAPSHOT.jar, -Doneagent.plugin.arms-agent.enabled=true, -Darms.licenseKey=[******], -Darms.agent.env=K8s, -Darms.agent.podinfo.path=/etc/podinfo, -Darms.appName=productservice, -Doneagent.region=cn-hangzhou, -Dproject.name=Product]

HostName

string

The hostname.

host_name

Ip

string

The IP address.

47.91.59.244

AgentVersion

string

The version of the agent.

1.7.0-SNAPSHOT_3.0.3_3756244

ProcId

string

The process ID.

1

Examples

Success response

JSON format

{
  "RequestId": "1A9C645C-C83F-4C9D-8CCB-29BEC9E1****",
  "Code": 200,
  "Message": "message",
  "Success": true,
  "JvmInfoList": [
    {
      "Pid": "dsv9zcel92@1455182510c5369",
      "VmArgs": "[-javaagent:/home/admin/.opt/ArmsAgent/arms-bootstrap-1.7.0-SNAPSHOT.jar, -Doneagent.plugin.arms-agent.enabled=true, -Darms.licenseKey=[******], -Darms.agent.env=K8s, -Darms.agent.podinfo.path=/etc/podinfo, -Darms.appName=productservice, -Doneagent.region=cn-hangzhou, -Dproject.name=Product]",
      "HostName": "host_name",
      "Ip": "47.91.59.244",
      "AgentVersion": "1.7.0-SNAPSHOT_3.0.3_3756244",
      "ProcId": "1"
    }
  ]
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.