All Products
Search
Document Center

Server Load Balancer:SetLoadBalancerModificationProtection

Last Updated:Sep 20, 2024

Modifies the configuration of the configuration read-only mode for 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:SetLoadBalancerModificationProtectionupdate
  • loadbalancer
    acs:slb:{#regionId}:{#accountId}:loadbalancer/{#loadbalancerId}
  • slb:tag
none

Request parameters

ParameterTypeRequiredDescriptionExample
RegionIdstringYes

The region ID of the CLB instance.

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

cn-hangzhou
LoadBalancerIdstringYes

The ID of the CLB instance.

lb-bp1b6c719dfa08e*****
ModificationProtectionStatusstringYes

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
ModificationProtectionReasonstringNo

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 parameters

ParameterTypeDescriptionExample
object
RequestIdstring

The ID of the request.

791D8B68-AE0F-4174-AF54-088C8B3C5D54

Examples

Sample success responses

JSONformat

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

Error codes

HTTP status codeError codeError message
400OperationUnsupported.SetLoadBalancerStatusThe zone of the loadBalancer does not support this operation.
400InvalidParam.ModificationProtectionStatusThe param ModificationProtectionStatus is invalid.
400InvalidParam.ModificationProtectionReasonThe param ModificationProtectionReason is invalid.
400InvalidParam.ModificationProtectionReason%s.

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