All Products
Search
Document Center

Server Load Balancer:SetLoadBalancerStatus

Last Updated:Mar 14, 2024

Sets the status of a Classic Load Balancer (CLB) instance.

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer.

Authorization information

The following table shows the authorization information corresponding to the API. The authorization information can be used in the Action policy element to grant a RAM user or RAM role the permissions to call this API operation. Description:

  • Operation: the value that you can use in the Action element to specify the operation on a resource.
  • Access level: the access level of each operation. The levels are read, write, and list.
  • Resource type: the type of the resource on which you can authorize the RAM user or the RAM role to perform the operation. Take note of the following items:
    • The required resource types are displayed in bold characters.
    • If the permissions cannot be granted at the resource level, All Resources is used in the Resource type column of the operation.
  • Condition Key: the condition key that is defined by the cloud service.
  • Associated operation: other operations that the RAM user or the RAM role must have permissions to perform to complete the operation. To complete the operation, the RAM user or the RAM role must have the permissions to perform the associated operations.
OperationAccess levelResource typeCondition keyAssociated operation
slb:SetLoadBalancerStatusWRITE
  • loadbalancer
    acs:slb:{#regionId}:{#accountId}:loadbalancer/{#loadbalancerId}
  • slb:tag
none

Request parameters

ParameterTypeRequiredDescriptionExample
RegionIdstringNo

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
LoadBalancerIdstringYes

The ID of the CLB instance.

lb-bp1b6c719dfa08e******
LoadBalancerStatusstringYes

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 parameters

ParameterTypeDescriptionExample
object
RequestIdstring

The ID of the request.

CEF72CEB-54B6-4AE8-B225-F876FF7BA984

Examples

Sample success responses

JSONformat

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

Error codes

HTTP status codeError codeError message
400OperationUnsupported.SetLoadBalancerStatusThe zone of the loadBalancer does not support this operation.

For a list of error codes, visit the Service error codes.

Change history

Change timeSummary of changesOperation
No change history