SetLoadBalancerStatus

Updated at:

Modifies the state of a Classic Load Balancer (CLB) instance.

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

  • Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.

  • API: The API that you can call to perform the action.

  • Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.

  • Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.

    • For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.

    • For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.

  • Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.

  • Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

Action

Access level

Resource type

Condition key

Dependent action

slb:SetLoadBalancerStatus

update

*loadbalancer

acs:slb:{#regionId}:{#accountId}:loadbalancer/{#loadbalancerId}

  • slb:tag
  • slb:tag
  • slb:tag
None

Request parameters

Parameter

Type

Required

Description

Example

RegionId

string

No

The ID of the region where the CLB instance is deployed.

You can query region IDs from the Regions and zones list or by calling the DescribeRegions operation.

cn-hangzhou

LoadBalancerId

string

Yes

The ID of the CLB instance.

lb-bp1b6c719dfa08e******

LoadBalancerStatus

string

Yes

The state of the CLB instance. Valid values: active and inactive.

  • active (default)

    If a CLB instance is in the active state, listeners of the CLB instance can forward traffic based on forwarding rules.

    By default, newly created CLB instances are in the active state.

  • inactive

    If a CLB instance is in the inactive state, listeners of the CLB instance do not forward traffic.

Note

If all listeners of a CLB instance are deleted, the CLB instance automatically switches to the inactive state.

active

Response elements

Element

Type

Description

Example

object

RequestId

string

The ID of the request.

CEF72CEB-54B6-4AE8-B225-F876FF7BA984

Examples

Success response

JSON format

{
  "RequestId": "CEF72CEB-54B6-4AE8-B225-F876FF7BA984"
}

Error codes

HTTP status code

Error code

Error message

Description

400 OperationUnsupported.SetLoadBalancerStatus The zone of the loadBalancer does not support this operation.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.