Load Balance(ULB)

Batch Update Backend Instance Properties - UpdateBackendBatch


Batch update ULB backend resource instance (service node) attributes


Public Parameters

Parameter NameTypeDescription InformationRequired
ActionstringCorresponding API command name, the current API is UpdateBackendBatch.Yes
PublicKeystringThe user's public key can be obtained from Console (opens in a new tab)Yes
SignaturestringUser signature generated based on public key and API command, see Signature AlgorithmYes

Request Parameters

Parameter NameTypeDescription InformationRequired
RegionstringRegion. See List of Regions and Availability ZonesYes
ProjectIdstringProject ID. If not filled in, the default project is used, sub-accounts must be filled in. Please refer to the GetProjectList interface.Yes
ULBIdstringULB Resource IDYes
Attributes.N.BackendIdstringID of the backend resource instance (ULB backend ID, not the resource's own ID)Yes
Attributes.N.PortintBackend resource service port, value range [1-65535]No
Attributes.N.WeightintThe weight of the added backend RS (effective under the weighted round-robin algorithm), the value range is [0-100], the default is 1.No
Attributes.N.EnabledintBackend Instance Status SwitchNo
Attributes.N.IsBackupintIs it a backup 0: primary rs 1: backup rs, default is 0No

Response Field

Field NameTypeDescription InformationRequired
RetCodeintReturn status code. If it is 0, it means successful return. If it is not 0, it means failure.Yes
ActionstringOperation command name.Yes
MessagestringReturns an error message, providing detailed description when RetCode is non-zero.No
BackendSetarray[BackendMsg]Return whether the modification to each RS by ULB is successfulNo

Data Model


Field NameTypeDescription InformationRequired
BackendIdstringResource ID of rsYes
SubMessagestringModify the message returned by rsYes
SubRetCodeintModify the return value of rsYes


Request Example

Response Example

  "Action": "UpdateBackendBatchResponse",
  "BackendSet": [
      "BackendId": "UkRjpQeW",
      "ResourceId": "zApWjpps"
  "RetCode": 0
  • Company
  • ContactUs
  • Blog
Copyright © 2024 SurferCloud All Rights Reserved
  • Contact our sales to help your business.
  • Contact our sales to help your business.