This API changes the performance of a virtual server.
This API cannot be executed for a physical server.
Always specify any one of the following:
cpuPerf
numOfCpu
cpuReserve
cpuShare
memorySize
memoryReserve
memoryShare
serverType
priority
This API is executed asynchronously. After the API is successfully executed, the status of the L-Platform changes to Reconfiguring (RECONFIG_ING) during the execution of the operation, and changes back to Operating Normally (NORMAL) when the operation is completed. When the status of an L-Platform is Reconfiguring, the L-Platform cannot be operated. Use GetLPlatformStatus to check the status of the L-Platform, and execute subsequent operations after waiting for the status to change to Operating Normally.
It cannot be used in the following cases:
The target server is a server for which modification configurations or deletion cannot be performed.
For the servers for which configuration modification and deletion cannot be performed, refer to "8.3.18 L-Platform Reconfiguration" in the "User's Guide for Tenant Administrators CE".
Request parameters
Parameter name | Item | Item description |
|---|---|---|
Version | Description | The version ID of the L-Platform API. |
Type | string | |
Value | Fixed. Specify "2.0". | |
Locale | Description | The language for communicating with the L-Platform API. This parameter is specified using the language codes stipulated by ISO 639. |
Type | string | |
Value | Select one of the following: | |
Action | Description | The name of the L-Platform API to be executed. |
Type | string | |
Value | Fixed. Specify "UpdateLServerConfiguration". | |
userId | Description | The user ID of the user that executes the L-Platform API. |
Type | string | |
Value | No more than 31 characters. | |
orgId | Description | The tenant name of the user that executes the L-Platform API. |
Type | string | |
Value | No more than 32 characters. | |
lplatformId | Description | L-Platform ID |
Type | string | |
Value | No more than 32 characters. | |
lserverId | Description | Server ID |
Type | string | |
Value | No more than 32 characters. | |
[cpuPerf] | Description | CPU performance. The value must be specified in GHz, up to one decimal place. Specify a value that is no less than 0.1 and no more than the maximum value specified by the image (or no more than 99999.9 if the maximum value has not been specified). |
Type | decimal | |
Value | 0.1 to 99999.9. | |
[numOfCpu] | Description | Number of CPUs |
Type | int | |
Value | 1 or more. The maximum value is the value specified for each image (or the maximum value for the INT type if no value has been specified). | |
[cpuReserve] | Description | Reserved CPU performance. Specify a value that is no less than 0.0 and no more than the maximum value specified by either cpuPerf or the image (or no more than 99999.9 if neither of these has been specified). |
Type | decimal | |
Value | 0.0 to 99999.9. | |
[cpuShare] | Description | CPU allotment ratio. [When VM type is VMware] CPU Shares. |
Type | int | |
Value | 1 to 1000000. [When VM type is VMware] 1 to 1000000 | |
[memorySize] | Description | Amount of memory. The value must be specified in GB, up to one decimal place. Specify a value that is no less than 0.1 and no more than the maximum value specified by the image (or no more than 99999.9 if the maximum value has not been specified). |
Type | decimal | |
Value | 0.1 to 99999.9. | |
[memoryReserve] | Description | Reserved memory capacity. Specify a value that is no less than 0.0 and no more than the maximum value specified by either memorySize or the image (or no more than 99999.9 if neither of these has been specified). [When VM type is VMware] [When VM type is Hyper-V] |
Type | decimal | |
Value | to 99999.9. [When VM type is VMware] 0.0 to 99999.9 | |
[memoryShare] | Description | Memory allotment ratio. [When VM type is VMware] Memory Shares. |
Type | int | |
Value | 0 to 1000000. [When VM type is VMware] 0 to 1000000. | |
[serverType] | Description | Server type. The default performance values for the specified server type will be set. If this parameter is specified together with the CPU and memory performance parameters, the values for the CPU and memory performance will take precedence. |
Type | string | |
Value | No more than 32 characters. | |
[priority] | Description | Priority startup levels when performing batch power supply controls. |
Type | int | |
Value | 0 to 256 |
Response
<Status code>
The API returns "200 OK" if it terminates normally.
<XML>
<?xml version="1.0" encoding="UTF-8"?> <UpdateLServerConfigurationResponse xmlns="http://cfmg.systemwalker.jp.fujitsu.com"> <responseMessage>[Message] </responseMessage> <responseStatus>[Status]</responseStatus> </UpdateLServerConfigurationResponse>
<Elements>
Element name | Item | Item description |
|---|---|---|
UpdateLServerConfigurationResponse | Description | Element holding the response information. |
Type | None | |
Number of occurrences | 1 | |
responseMessage | Description | Message. This element indicates whether the request has been processed correctly. Refer to "Chapter 15 Messages Starting with PAPI" in the "Messages" for message details. |
Type | string | |
Number of occurrences | 1 | |
responseStatus | Description | Status. This element indicates whether the request has been processed normally. "SUCCESS" is returned if the request is processed normally. Otherwise, an error code is returned. |
Type | string | |
Number of occurrences | 1 |
Sample response
<?xml version="1.0" encoding="UTF-8"?> <UpdateLServerConfigurationResponse xmlns="http://cfmg.systemwalker.jp.fujitsu.com"> <responseMessage>PAPI00000 Processing was completed.</responseMessage> <responseStatus>SUCCESS</responseStatus> </UpdateLServerConfigurationResponse>
