Configures the Java virtual machine (JVM) parameters for an application or an instance group where the application is deployed.

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 headers

This operation only uses the common request header. For more information, see Common request parameters.

Request syntax

POST /pop/v5/app/app_jvm_config HTTP/1.1

Request parameters

Parameter Type Position Required Example Description
AppId String Query Yes c627c157-560d-*************

The ID of the application.

GroupId String Query No 0afc726e-077e-4357-98b2-db9f7145****

The ID of the instance group where the application is deployed. You can call the ListDeployGroup operation to query the group ID.

Note
  • To configure the JVM parameters for an instance group, set this parameter to a specific ID.
  • To configure the JVM parameters for an application, leave this parameter empty.
Options String Query No -Dproperty=value

Specifies whether to customize the JVM parameters.

Note
  • If this parameter is not specified in the group configuration, the value specified in the application configuration is used.
  • If this parameter is not specified in the application configuration, the default value is used.
MinHeapSize Integer Query No 500

The initial size of the heap memory. Unit: MB.

Note
  • If this parameter is not specified in the group configuration, the value specified in the application configuration is used.
  • If this parameter is not specified in the application configuration, the default value is used.
MaxPermSize Integer Query No 1000

The size of the permanent generation heap memory. Unit: MB.

Note
  • If this parameter is not specified in the group configuration, the value specified in the application configuration is used.
  • If this parameter is not specified in the application configuration, the default value is used.
MaxHeapSize Integer Query No 500

The maximum size of the heap memory. Unit: MB.

Note
  • If this parameter is not specified in the group configuration, the value specified in the application configuration is used.
  • If this parameter is not specified in the application configuration, the default value is used.

Response parameters

Parameter Type Example Description
Code Integer 200

The returned HTTP status code.

JvmConfiguration Struct

The returned JVM parameters.

MaxHeapSize Integer 500

The maximum size of the heap memory that was specified. Unit: MB.

MaxPermSize Integer 1000

The size of the permanent generation heap memory that was specified. Unit: MB.

MinHeapSize Integer 500

The initial size of the heap memory that was specified. Unit: MB.

Options String ""

Custom JVM parameters that was set.

Message String success

The additional information.

RequestId String D16979DC-4D42-********************

The ID of the request.

Examples

Sample requests

POST /pop/v5/app/app_jvm_config HTTP/1.1
Common request parameters
{
  "AppId": ""
}

Sample success responses

XML format

<Message>success</Message>
<JvmConfiguration>
    <MaxPermSize>1000</MaxPermSize>
    <MaxHeapSize>500</MaxHeapSize>
    <MinHeapSize>500</MinHeapSize>
    <Options/>
</JvmConfiguration>
<Code>200</Code>

JSON format

{
	"Message": "success",
	"JvmConfiguration": {
		"MaxPermSize": 1000,
		"MaxHeapSize": 500,
		"MinHeapSize": 500,
		"Options": ""
	},
	"Code": 200
}

Error codes

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