Use SetLoadBalancerModificationProtection to enable or disable configuration read-only mode for Classic Load Balancer - Server Load Balancer

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:SetLoadBalancerModificationProtection

update

*loadbalancer

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

slb:tag

None

Request parameters

Parameter	Type	Required	Description	Example
RegionId	string	Yes	The region ID of the CLB instance. You can call the DescribeRegions operation to query the most recent region list.	cn-hangzhou
LoadBalancerId	string	Yes	The ID of the CLB instance.	lb-bp1b6c719dfa08e*****
ModificationProtectionStatus	string	Yes	Specifies whether to enable the configuration read-only mode. Valid values: NonProtection: disables the configuration read-only mode. After you disable the configuration read-only mode, the value of ModificationProtectionReason is cleared. ConsoleProtection: enables the configuration read-only mode. Note If you set this parameter to ConsoleProtection, you cannot use the CLB console to modify instance configurations. However, you can call API operations to modify instance configurations.	ConsoleProtection
ModificationProtectionReason	string	No	The reason why the configuration read-only mode is enabled. The value must be 1 to 80 characters in length. It must start with a letter and can contain letters, digits, periods (.), underscores (_), and hyphens (-). Note This parameter is valid only if the ModificationProtectionStatus parameter is set to ConsoleProtection.	Configuration change

Response elements

Element	Type	Description	Example
	object
RequestId	string	The ID of the request.	791D8B68-AE0F-4174-AF54-088C8B3C5D54

Examples

Success response

JSON format

{
  "RequestId": "791D8B68-AE0F-4174-AF54-088C8B3C5D54"
}

Error codes

HTTP status code	Error code	Error message
400	OperationUnsupported.SetLoadBalancerStatus	The zone of the loadBalancer does not support this operation.
400	InvalidParam.ModificationProtectionStatus	The param ModificationProtectionStatus is invalid.
400	InvalidParam.ModificationProtectionReason	The param ModificationProtectionReason is invalid.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.