Use UpdateLoadBalancerProtection to manage deletion protection and configuration read-only mode - Server Load Balancer - Alibaba Cloud - Server Load Balancer

Operation description

Note

You can call the GetLoadBalancerAttribute operation to query deletion protection and configuration read-only mode details.

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

nlb:UpdateLoadBalancerProtection

update

*LoadBalancer

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

None

Request parameters

Parameter	Type	Required	Description	Example
DeletionProtectionEnabled	boolean	No	Specifies whether to enable deletion protection. Valid values: true false	false
DeletionProtectionReason	string	No	The reason for enabling deletion protection. The value must be 2 to 128 characters in length, can contain letters, digits, periods (.), underscores (_), and hyphens (-), and must start with a letter. Note This parameter takes effect only when DeletionProtectionEnabled is set to true.	Instance_Is_Bound_By_Acceleration_Instance
ModificationProtectionStatus	string	No	Specifies whether to enable the configuration read-only mode. Valid values: NonProtection: disables the configuration read-only mode. You cannot set the ModificationProtectionReason parameter. If you specify ModificationProtectionReason, the value is cleared. ConsoleProtection: enables the configuration read-only mode. You can specify ModificationProtectionReason. Note When set to ConsoleProtection, you cannot modify NLB instance configurations in the NLB console, but you can call API operations to modify them.	ConsoleProtection
ModificationProtectionReason	string	No	The reason for enabling the configuration read-only mode. The value must be 2 to 128 characters in length, can contain letters, digits, periods (.), underscores (_), and hyphens (-), and must start with a letter. Note This parameter takes effect only when Status is set to ConsoleProtection.	ConsoleProtection
LoadBalancerId	string	Yes	The ID of the NLB instance.	nlb-83ckzc8d4xlp8o****
DryRun	boolean	No	Specifies whether to perform a dry run without sending the actual request. Valid values: true: performs a dry run. The system checks for missing parameter values, incorrect request syntax, and service limits. If the request fails the dry run, an error message is returned. If the request passes the dry run, the `DryRunOperation` error code is returned. false (default): sends the request. If the request passes the dry run, a 2xx HTTP status code is returned and the operation is performed.	false
ClientToken	string	No	The client token that is used to ensure the idempotence of the request. You can use the client to generate the token. Ensure that it is unique among all requests. Only ASCII characters are allowed. Note If you do not specify this parameter, the system uses the RequestId as the client token. The RequestId may differ for each request.	123e4567-e89b-12d3-a456-426655440000
RegionId	string	No	The region ID of the NLB instance. Call the DescribeRegions operation to query available regions.	cn-hangzhou

Response elements

Element	Type	Description	Example
	object	The response body for updating load balancer protection settings.
RequestId	string	The request ID.	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	ResourceInConfiguring.%s	The specified resource of %s is being configured, please try again later.
400	IllegalParam	The param of %s is illegal.
400	IdempotenceSignatureMismatch	The idempotence token of request is same with the prev one, but the signature is different.	The requested idempotent token is the same as the previous one, but the signature is different.
400	Conflict.Lock	The Lock [%s] is conflict.	The specific resource is conflict.
400	ResourceInConfiguring.loadbalancer	The specified resource of loadbalancer is being configured, please try again later.	The specified resource of loadbalancer is being configured, please try again later.
400	DryRunOperation	Request validation has been passed with DryRun flag set.	Request validation has been passed with DryRun flag set.
400	IllegalParam.deletionProtectionReason	The param of deletionProtectionReason is illegal.	The parameter deletionProtectionReason is invalid. Check whether the parameter must be 2-128 English or Chinese characters in length. It must start with an uppercase or lowercase letter or a Chinese character and can contain digits, periods (.), underscores (_), and hyphens (-).
400	IllegalParam.modificationProtectionReason	The param of modificationProtectionReason is illegal.	The parameter modificationProtectionReason is invalid, please refer to the document to modify.
400	ResourceInCreating.loadbalancer	The specified resource of loadbalancer is creating, please try again later.	The specified resource of loadbalancer is creating, please try again later.
403	Forbidden.NoPermission	Authentication is failed for NoPermission.	Authentication is failed for NoPermission.
404	ResourceNotFound.loadBalancer	The specified resource of loadbalancer is not found.	The specified load balancer resource was not found. Please check the input parameters.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.