All Products
Search

This Product

    Server Load Balancer:UpdateLoadBalancerProtection

    Document Center

    Server Load Balancer:UpdateLoadBalancerProtection

    Last Updated:Mar 21, 2025

    Enables or disables the deletion protection feature.

    Operation description

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

    Debugging

    You can run this interface directly in OpenAPI Explorer, saving you the trouble of calculating signatures. After running successfully, OpenAPI Explorer can automatically generate SDK code samples.

    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:
      • For mandatory resource types, indicate with a prefix of * .
      • 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
    nlb:UpdateLoadBalancerProtectionupdate
    *LoadBalancer
    acs:nlb:{#regionId}:{#accountId}:loadbalancer/{#loadbalancerId}
      none
    		none

    Request parameters

    ParameterTypeRequiredDescriptionExample
    DeletionProtectionEnabledbooleanNo

    Specifies whether to enable deletion protection. Valid values:

    • true
    • false
    		false
    DeletionProtectionReasonstringNo

    The reason why deletion protection is enabled. The reason 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
    ModificationProtectionStatusstringNo

    Specifies whether to enable the configuration read-only mode. Valid values:

    • NonProtection: disables the configuration read-only mode. In this case, you cannot set the ModificationProtectionReason parameter. If you specify ModificationProtectionReason, the value is cleared.
    • ConsoleProtection: enables the configuration read-only mode. In this case, you can specify ModificationProtectionReason.
    Note If you set this parameter to ConsoleProtection, you cannot use the NLB console to modify configurations of the NLB instance. However, you can call API operations to modify the instance configurations.
    		ConsoleProtection
    ModificationProtectionReasonstringNo

    The reason why the configuration read-only mode is enabled. The reason 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
    LoadBalancerIdstringYes

    The ID of the NLB instance.

    		nlb-83ckzc8d4xlp8o****
    DryRunbooleanNo

    Specifies whether to perform a dry run, without sending the actual request. Valid values:

    • true: performs only a dry run. The system checks the request for potential issues, including 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 a request. If the request passes the dry run, a 2xx HTTP status code is returned and the operation is performed.
    		false
    ClientTokenstringNo

    The client token used to ensure the idempotence of the request.

    You can use the client to generate this value. Ensure that the value is unique among all requests. Only ASCII characters are allowed.

    Note If you do not specify this parameter, the value of RequestId is used.**** RequestId of each request is different.
    		123e4567-e89b-12d3-a456-426655440000
    RegionIdstringNo

    The region ID of the NLB instance.

    You can call the DescribeRegions operation to query the most recent region list.

    		cn-hangzhou

    Response parameters

    ParameterTypeDescriptionExample
    object

    Modifies deletion protection settings.

    RequestIdstring

    The request ID.

    		CEF72CEB-54B6-4AE8-B225-F876FF7BA984

    Examples

    Sample success responses

    JSONformat

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

    Error codes

    HTTP status codeError codeError messageDescription
    400ResourceInConfiguring.%sThe specified resource of %s is being configured, please try again later.-
    400IllegalParamThe param of %s is illegal.-
    400IdempotenceSignatureMismatchThe 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.
    400Conflict.LockThe Lock [%s] is conflict.The specific resource is conflict.
    400ResourceInConfiguring.loadbalancerThe specified resource of loadbalancer is being configured, please try again later.The specified resource of loadbalancer is being configured, please try again later.
    400DryRunOperationRequest validation has been passed with DryRun flag set.Request validation has been passed with DryRun flag set.
    400IllegalParam.deletionProtectionReasonThe 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 (-).
    400IllegalParam.modificationProtectionReasonThe param of modificationProtectionReason is illegal.The parameter modificationProtectionReason is invalid, please refer to the document to modify.
    400ResourceInCreating.loadbalancerThe specified resource of loadbalancer is creating, please try again later.The specified resource of loadbalancer is creating, please try again later.
    403Forbidden.NoPermissionAuthentication is failed for NoPermission.Authentication is failed for NoPermission.
    404ResourceNotFound.loadBalancerThe specified resource of loadbalancer is not found.The specified load balancer resource was not found. Please check the input parameters.

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