更新时间:2022-01-25 GMT+08:00

更新转发策略

功能介绍

更新转发策略。

URI

PUT /v2/{project_id}/elb/l7policies/{l7policy_id}

表1 参数说明

参数

是否必选

参数类型

描述

project_id

String

操作用户的项目ID。

l7policy_id

String

转发策略ID。

请求消息

表2 请求参数

参数

是否必选

参数类型

描述

l7policy

Object

转发策略对象。表3

表3 l7policy字段说明

参数

是否必选

参数类型

描述

name

String

转发策略名称。

支持的最大字符长度:255

description

String

转发策略的描述信息。

支持的最大字符长度:255

redirect_pool_id

String

流量匹配后转发到后端云服务器组的ID。默认值:null;

当action为REDIRECT_TO_POOL时为必选字段。

当action为REDIRECT_TO_LISTENER时,不可指定该字段。

指定的后端云服务器组需满足以下条件:

  • 不能是监听器的default_pool;
  • 不能是除该转发策略所在的监听器以外的其他监听器的转发策略使用的后端云服务器组。

redirect_listener_id

String

流量匹配后转发到的监听器的ID。默认值:null;

当action为REDIRECT_TO_LISTENER时为必选字段。

当action为REDIRECT_TO_POOL时不可指定。

  • 只支持指定为protocol为TERMINATED_HTTPS的listener。
  • 只支持指定为当前转发策略所在的负载均衡器下的监听器。

admin_state_up

Boolean

转发策略的管理状态;

取值范围: true/false。

该字段为预留字段,暂未启用。默认为true。

响应消息

表4 响应参数

参数

参数类型

描述

l7policy

Object

转发策略对象。详见表5

表5 l7policy字段说明

参数

参数类型

描述

id

String

转发策略ID。

tenant_id

String

转发策略所在的项目ID。

name

String

转发策略名称。

admin_state_up

Boolean

转发策略的管理状态;

取值范围: true/false。

该字段为预留字段,暂未启用。默认为true。

description

String

转发策略的描述信息。

listener_id

String

转发策略所在的监听器ID。

action

String

转发策略的匹配动作。

取值范围:

  • REDIRECT_TO_POOL:将匹配的流量转发到redirect_pool_id指定的后端云服务器组上;
  • REDIRECT_TO_LISTENER:将listener_id指定的HTTP监听器的流量重定向到redirect_listener_id指定的TERMINATED_HTTPS监听器上。

redirect_pool_id

String

流量匹配后转发到后端云服务器组的ID。

redirect_listener_id

String

流量匹配后转发到的监听器的ID。

redirect_url

String

转发策略重定向到的url。

该字段为预留字段,暂未启用。

rules

Array

转发策略关联的转发规则的ID列表。

position

Integer

转发优先级,从1递增,最高100。默认值:100;

该字段为预留字段,暂未启用。

provisioning_status

String

转发策略的配置状态,可以为ACTIVE、PENDING_CREATE 或者ERROR。

默认值:ACTIVE;

该字段为预留字段,暂未启用。

表6 rules字段说明

参数

参数类型

描述

id

String

关联的转发规则id

请求示例

  • 请求样例 更新转发策略
    PUT https://{Endpoint}/v2/a31d2bdcf7604c0faaddb058e1e08819/elb/l7policies/5ae0e1e7-5f0f-47a1-b39f-5d4c428a1586
    
    {
        "l7policy": {
            "name": "test"
        }
    }

响应示例

  • 响应样例
    {
        "l7policy": {
            "redirect_pool_id": "431a03eb-81bb-408e-ae37-7ce19023692b", 
            "redirect_listener_id": null,
            "description": "", 
            "admin_state_up": true, 
            "rules": [
                {
                    "id": "67d8a8fa-b0dd-4bd4-a85b-671db19b2ef3"
                }, 
                {
                    "id": "f02b3bca-69d2-4335-a3fa-a8054e996213"
                }
            ], 
    
            "tenant_id": "a31d2bdcf7604c0faaddb058e1e08819",
      
            "listener_id": "26058b64-6185-4e06-874e-4bd68b7633d0", 
            "redirect_url": null, 
            "action": "REDIRECT_TO_POOL", 
            "position": 2, 
            "provisioning_status": "ACTIVE",
            "id": "5ae0e1e7-5f0f-47a1-b39f-5d4c428a1586", 
            "name": "test"
        }
    }

返回码

请参见负载均衡返回码说明