Docs
api
Load Balance(ULB)
UpdateBackendAttribute

Update the backend instance properties of the traditional load balancer - UpdateBackendAttribute

Overview

Update the properties of CLB backend resource instances (service nodes)

ℹ️ The service node for message forwarding does not currently support modification of Port; BackendId corresponds to the BackendId returned by AllocateBackend or the BackendId in the ULBBackendSet structure returned by DescribeULB/DescribeVServer, which is the backend instance Id of the traditional load balancer.

Definition

Public Parameters

Parameter NameTypeDescription InformationRequired
ActionstringCorresponding API command name, the current API is UpdateBackendAttribute.Yes
PublicKeystringThe user’s public key can be obtained from ConsoleYes
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
ULBIdstringTraditional Load Balancer Resource IDYes
BackendIdstringID of the backend resource instance (CLB backend ID, not the resource’s own ID)Yes
PortintBackend resource service port, value range [1-65535]No
WeightintThe weight of the added backend RS (effective under the weighted round-robin algorithm), the value range is [1-100], the default is 1.No
EnabledintBackend Instance Status SwitchNo
IsBackupintIs it a backup?
0: Primary rs
1: Backup rs
Default is 0
No

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

Example

Request Example

https://api.dezai.com/?Action=UpdateBackendAttribute
&Region=cn-bj2
&ProjectId=project-XXXX
&ULBId=ulb-XXXX
&BackendId=backend-XXXX
&Port=8080
&Enabled=0
&Weight=2
&IsBackup=0

Response Example

{
  "Action": "UpdateBackendAttributeResponse",
  "BackendSet": [
    {
      "BackendId": "VrjEOOfp",
      "SubMessage": "fHpUyKqK",
      "SubRetCode": 1
    }
  ],
  "RetCode": 0
}