首页 负载均衡 网络型负载均衡NLB 开发参考 NLB API参考 API目录 实例 UpdateLoadBalancerProtection - 修改删除保护

UpdateLoadBalancerProtection - 修改删除保护

更新时间: 2023-09-26 16:02:19

开启或关闭删除保护功能,及更新修改保护功能。

接口说明

说明 您可以通过GetLoadBalancerAttribute接口查询删除保护和修改保护详细信息。

调试

您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

调试

授权信息

下表是API对应的授权信息,可以在RAM权限策略语句的Action元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:

  • 操作:是指具体的权限点。
  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:
    • 对于必选的资源类型,用背景高亮的方式表示。
    • 对于不支持资源级授权的操作,用全部资源表示。
  • 条件关键字:是指云产品自身定义的条件关键字。
  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作访问级别资源类型条件关键字关联操作
nlb:UpdateLoadBalancerProtectionWrite
  • LoadBalancer
    acs:nlb:{#regionId}:{#accountId}:loadbalancer/{#loadbalancerId}

请求参数

名称类型必填描述示例值
DeletionProtectionEnabledboolean

是否开启删除保护。取值:

  • true:开启。
  • false:关闭。
false
DeletionProtectionReasonstring

输入开启删除保护的原因。长度为2~128个英文或中文字符,必须以字母或中文开头,可包含数字、半角句号(.)、下划线(_)和短划线(-)。

说明 仅在DeletionProtectionEnabledtrue时该参数有效且合法。
实例使用中
ModificationProtectionStatusstring

网络型负载均衡修改保护状态。取值:

  • NonProtection:不保护,表示不允许传入ModificationProtectionReason。如果配置了保护配置的ModificationProtectionReason,则清空其配置信息。
  • ConsoleProtection:控制台修改保护,此时允许传入ModificationProtectionReason
说明 当取值为ConsoleProtection,即开启修改保护后,用户不能通过负载均衡控制台修改实例配置,但可以通过调用API修改实例配置。
ConsoleProtection
ModificationProtectionReasonstring

输入开启修改保护的原因。长度为2~128个英文或中文字符,必须以字母或中文开头,可包含数字、半角句号(.)、下划线(_)和短划线(-)。

说明 仅在StatusConsoleProtection时该参数有效且合法。
托管实例
LoadBalancerIdstring

网络型负载均衡实例ID。

nlb-83ckzc8d4xlp8o****
DryRunboolean

是否只预检此次请求。取值:

  • true:发送检查请求,不会更新修改保护和删除保护。检查项包括是否填写了必需参数、请求格式、业务限制。如果检查不通过,则返回对应错误。如果检查通过,则返回错误码DryRunOperation
  • false(默认值):发送正常请求,通过检查后返回HTTP 2xx状态码并直接进行操作。
false
ClientTokenstring

客户端Token,用于保证请求的幂等性。

从您的客户端生成一个参数值,确保不同请求间该参数值唯一。ClientToken只支持ASCII字符。

说明 若您未指定,则系统自动使用API请求的RequestId作为ClientToken标识。每次API请求的RequestId不一样。
123e4567-e89b-12d3-a456-426655440000
RegionIdstring

网络型负载均衡实例所在的地域ID。

您可以通过调用DescribeRegions接口获取地域ID。

cn-hangzhou

返回参数

名称类型描述示例值
object

更新修改删除保护。

RequestIdstring

请求ID。

CEF72CEB-54B6-4AE8-B225-F876FF7BA984

示例

正常返回示例

JSON格式

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

错误码

HTTP status code错误码错误信息描述
400ResourceInConfiguring.%sThe specified resource of %s is being configured, please try again later.指定的资源%s正在配置,请稍后重试
403Forbidden.NoPermissionAuthentication is failed for NoPermission.因为账号没有权限,所以鉴权失败。
404ResourceNotFound.loadBalancerThe specified resource of loadbalancer is not found.找不到指定的负载均衡器资源,请检查输入参数。

访问错误中心查看更多错误码。

阿里云首页 负载均衡 相关技术圈