2.2.12 OperateSLB (Operate Server Load Balancer)

This API executes server load balancer operations.
If there are operation logs that have not been acquired, operations cannot be performed.
It is necessary to specify all parameters defined in the ruleset.
This API supports only the POST method.

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.

Request body

<XML>

<Request>
  <param name="Version">[Version ID]</param>
  <param name="Locale">[Locale ID]</param>
  <param name="Action">[Action ID]</param>
  <param name="userId">[User ID]</param>
  <param name="orgId">[Tenant ID]</param>
  <param name="lplatformId">[L-Platform ID]</param>
  <Body>
    <slb>
      <name>[Server load balancer name]</name>
      <ruleset>
        <name>[Ruleset name]</name>
        <parameters>
          <parameter>
            <name>[Parameter name]</name>
            <value>[Parameter value]</value>
          </parameter>
          ...
        </parameters>
      </ruleset>
    </slb>
  </Body>
</Request>

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: - en: English - zh: Chinese
Action	Description	The user ID of the user that executes the L-Platform API.
	Type	string
	Value	Fixed. Specify "UpdateSLBConfiguration".
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.
L-Platform ID	Description	L-Platform ID.
	Type	string
	Value	No more than 32 characters.
Server load balancer name	Description	Server load balancer name.
	Type	string
	Value	No more than 32 characters.
Ruleset name	Description	Ruleset name.
	Type	string
	Value	No more than 32 characters.
Parameter name	Description	Name of the parameter of the server load balancer executing the operation. Specify the name of the parameter in the target ruleset that was obtained by GetRulesetConfiguration. The name may differ to the one displayed in the window.
	Type	string
	Value	The characters <, >, &, ', ", and linefeeds cannot be specified.
Parameter value	Description	Value of the parameter executing the operation.
	Type	string
	Value	The characters <, >, &, ', ", and linefeeds cannot be specified.

Response

The API returns "200 OK" if it terminates normally.

<XML>

<?xml version="1.0" encoding="UTF-8"?>
<OperateSLBResponse xmlns="http://cfmg.systemwalker.jp.fujitsu.com">
  <operationId>[Operation ID]</operationId>
  <responseMessage>[Massage]</responseMessage>
  <responseStatus>[Status]</responseStatus>
</OperateSLBResponse>

Element name	Item	Item description
OperateSLBResponse	Description	Element holding the response information.
	Type	None
	Number of occurrences	1
operationId	Description	Operation ID. Specify when executing GetOperationResult.
	Type	None.
	Number of occurrences	1
responseMessage	Description	Message. This element indicates whether the request has been processed correctly. Refer to "Chaper 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. Refer to "Appendix A List of Response Status Error Codes(L-Platform APIs)" for information on error codes.
	Type	string
	Number of occurrences	1

Sample response

<?xml version="1.0" encoding="UTF-8"?>
<OperateSLBResponse xmlns="http://cfmg.systemwalker.jp.fujitsu.com">
  <operationId>ROR_001</operationId>
  <responseMessage>PAPI00000 Processing was completed.</responseMessage>
  <responseStatus>SUCCESS</responseStatus>
</OperateSLBResponse>