# 查询转发策略详情 - ShowL7Policy #### 功能介绍 查询七层转发策略详情。 #### 调用方法 请参见[如何调用API](https://support.huaweicloud.com/api-elb/elb_dy_0000.html)。 #### 授权信息 账号具备所有API的调用权限，如果使用账号下的IAM用户调用当前API，该IAM用户需具备调用API所需的权限。 - 如果使用角色与策略授权，具体权限要求请参见[权限和授权项](https://support.huaweicloud.com/api-elb/elb_sq_0001.html)。 - 如果使用身份策略授权，需具备如下身份策略权限。 | 授权项 | 访问级别 | 资源类型（\*为必须） | 条件键 | 别名 | 依赖的授权项 | |:---|:---|:---|:---|:---|:---| | elb:l7policies:show | Read | l7policy \* | g:EnterpriseProjectId | elb:l7policies:get | - | #### URI GET /v3/{project_id}/elb/l7policies/{l7policy_id} 表1路径参数 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | project_id | 是 | String | **参数解释** ：项目ID。获取方式请参见[获取项目ID](https://support.huaweicloud.com/api-elb/elb_fl_0008.html)。 **约束限制**：不涉及 **取值范围**：长度为32个字符，由小写字母和数字组成。 **默认取值**：不涉及 | | l7policy_id | 是 | String | **参数解释**：转发策略ID。 **约束限制**：不涉及 **取值范围**：不涉及 **默认取值**：不涉及 | #### 请求参数 表2请求Header参数 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | X-Auth-Token | 是 | String | **参数解释**：IAM鉴权Token。 **约束限制**：不涉及 **取值范围**：不涉及 **默认取值**：不涉及 | #### 响应参数 **状态码：200** 表3响应Body参数 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | request_id | String | **参数解释**：请求ID。 **取值范围**：由数字、小写字母和中划线（-）组成的字符串，自动生成。 | | l7policy | [L7Policy] object | **参数解释**：l7policy对象。 | 表4L7Policy | 参数 | 参数类型 | 描述 | |:---|:---|:---| | action | String | **参数解释**：转发策略的转发动作。 **取值范围**： - REDIRECT_TO_POOL：转发到后端服务器组； - REDIRECT_TO_LISTENER：重定向到监听器； - REDIRECT_TO_URL：重定向到URL； - FIXED_RESPONSE：返回固定响应体。 | | admin_state_up | Boolean | **参数解释**：转发策略的管理状态。 **取值范围**：只支持设置为true。 | | description | String | **参数解释**：转发策略描述信息。 **取值范围**：不涉及 | | id | String | **参数解释**：转发策略ID。 **取值范围**：不涉及 | | listener_id | String | **参数解释**：转发策略所属的监听器ID。 **取值范围**：不涉及 | | name | String | **参数解释**：转发策略名称 **取值范围**：不涉及 | | position | Integer | **参数解释**：转发策略的优先级，不支持更新。 不支持该字段，请勿使用。 | | priority | Integer | **参数解释**：转发策略的优先级。数字越小表示优先级越高。 **取值范围**： - 当action为REDIRECT_TO_LISTENER时，支持指定为0-10000。 - 其它action取值，支持指定为1-10000。 | | project_id | String | **参数解释**：转发策略所在的项目ID。 **取值范围**：不涉及 | | provisioning_status | String | **参数解释**：转发策略的配置状态。 **取值范围**： - ACTIVE: 默认值，表示正常。 - ERROR: 表示当前策略与同一监听器下的其他策略存在相同的规则配置。 | | redirect_pool_id | String | **参数解释**：转发到pool的ID。 **取值范围**：不涉及 | | redirect_listener_id | String | **参数解释**：转发到的listener的ID。 **取值范围**：不涉及 | | redirect_url | String | **参数解释**：转发到的url。 **取值范围**：必须满足格式: protocol://host:port/path?query。 不支持该字段，请勿使用。 | | rules | Array of [RuleRef] objects | **参数解释**：转发策略关联的转发规则列表。 | | redirect_url_config | [RedirectUrlConfig] object | **参数解释**：转发到的url配置。 | | redirect_pools_config | Array of [RedirectPoolsConfig] objects | **参数解释**：转发策略服务器组的权重配置。当监听器的高级转发策略功能（enhance_l7policy_enable）开启后才会生效，未开启传入该字段会报错。 | | redirect_pools_sticky_session_config | [RedirectPoolsStickySessionConfig] object | **参数解释**：配置转发策略关联的服务器组之间会话保持。负载均衡器会根据客户端第一个请求生成一个cookie，后续所有包含这个cookie值的请求都会由同一个pool处理。 | | redirect_pools_extend_config | [RedirectPoolsExtendConfig] object | **参数解释**：转发到的后端服务器组的配置。 | | fixed_response_config | [FixtedResponseConfig] object | **参数解释**：固定返回页面的配置。 | | created_at | String | **参数解释**：创建时间。 **取值范围**：格式：yyyy-MM-dd'T'HH:mm:ss'Z'，UTC时区。 注意：独享型实例的历史数据以及共享型实例下的资源，不返回该字段。 | | updated_at | String | **参数解释**：更新时间。 **取值范围**：格式：yyyy-MM-dd'T'HH:mm:ss'Z'，UTC时区。 注意：独享型实例的历史数据以及共享型实例下的资源，不返回该字段。 | | enterprise_project_id | String | **参数解释**：企业项目ID。 **取值范围**：不涉及 | 表5RuleRef | 参数 | 参数类型 | 描述 | |:---|:---|:---| | id | String | **参数解释**：规则ID。 **取值范围**：不涉及 | 表6RedirectUrlConfig | 参数 | 参数类型 | 描述 | |:---|:---|:---| | protocol | String | **参数解释**：重定向的协议。 **取值范围**： - HTTP - HTTPS - ${protocol}，表示继承原值（即与被转发请求保持一致）。 | | host | String | **参数解释**：重定向的主机名。 **取值范围**：只能包含英文字母、数字、"-"、"."。且必须以字母、数字开头。 | | port | String | **参数解释**：重定向到的端口。 **取值范围**：不涉及 | | path | String | **参数解释**：重定向的路径。 **取值范围**：支持英文字母、数字、_\~';@\^-%#\&$.\*+?,=!:\|\\/()\[\]{}，且必须以"/"开头。 | | query | String | **参数解释**：重定向的查询字符串。举例如下： 将query设置为：${query}\&name=my_name，则在转发符合条件的URL（如https://www.example.com:8080/elb?type=loadbalancer）时，将会重定向到https://www.example.com:8080/elb?type=loadbalancer\&name=my_name。在例子中${query}表示type=loadbalancer。 **取值范围**：只能包含英文字母、数字和特殊字符：!$\&'()\*+,-./:;=?@\^_\`。字母区分大小写。其中$1，$2会匹配请求url通配符星号（\*） | | status_code | String | **参数解释**：重定向后的返回码。 **取值范围**： - 301 - 302 - 303 - 307 - 308 | | insert_headers_config | [InsertHeadersConfig] object | **参数解释**：要添加的请求头参数列表。 | | remove_headers_config | [RemoveHeadersConfig] object | **参数解释**：要移除的请求头参数列表。 | 表7RedirectPoolsConfig | 参数 | 参数类型 | 描述 | |:---|:---|:---| | pool_id | String | **参数解释**：所在后端服务器组ID。 **取值范围**：不涉及 | | weight | Integer | **参数解释**：转发策略服务器组的权重。请求将根据该权重进行负载分发到不同的服务器组。权重值越大，分发的请求越多。权重为0的后端不再接受新的请求。 **取值范围**：0-100 | 表8RedirectPoolsStickySessionConfig | 参数 | 参数类型 | 描述 | |:---|:---|:---| | enable | Boolean | **参数解释**：转发策略服务器组会话保持开启的开关。 | | timeout | Integer | **参数解释**：会话保持的时间。 **取值范围**：1-1440（分钟） | 表9RedirectPoolsExtendConfig | 参数 | 参数类型 | 描述 | |:---|:---|:---| | rewrite_url_enable | Boolean | **参数解释**：是否开启url重定向。 **取值范围**：true 开启，false 未开启。 | | rewrite_url_config | [RewriteUrlConfig] object | **参数解释**：URL重定向配置。 | | insert_headers_config | [InsertHeadersConfig] object | **参数解释**：要添加的请求头参数列表。 | | remove_headers_config | [RemoveHeadersConfig] object | **参数解释**：要移除的请求头参数列表。 | | traffic_limit_config | [TrafficLimitConfig] object | **参数解释**：转发策略限速的配置。 | | cors_config | [CorsConfig] object | **参数解释**：转发策略跨域的配置。 | | traffic_mirror_config | [TrafficMirrorConfig] object | **参数解释**：流量镜像的配置 | 表10RewriteUrlConfig | 参数 | 参数类型 | 描述 | |:---|:---|:---| | host | String | **参数解释**：重定向的域名。 **取值范围**：英文字母、数字、"-"、"."，必须以字母、数字开头。 | | path | String | **参数解释**：重定向的请求路径。其中$1-$9会匹配请求url通配符星号(\*)，当正则匹配分组小于指定数字，则$指定数字结果为空。$后面跟字母，匹配结果均为空，直到下一个特殊字符出现，例如$abc#123，则匹配结果为#123；$后面跟特殊字符则直接输出特殊字符，例如$#匹配结果为$#。 **取值范围**：英文字母、数字、_\~';@\^-%#\&$.+?,=!:\|/()，且必须以"/"开头。 | | query | String | **参数解释**：重定向的查询字符串。其中$1-$9会匹配请求url通配符星号（\*），当正则匹配分组小于指定数字，则$指定数字结果为空。$后面跟字母，匹配结果均为空，直到下一个特殊字符出现，例如$abc#123，则匹配结果为#123；$后面跟特殊字符则直接输出特殊字符，例如$#匹配结果为$#。 **取值范围**：英文字母、数字和特殊字符：!$\&'()+,-./:;=?@\^_\`。字母区分大小写。 | 表11CorsConfig | 参数 | 参数类型 | 描述 | |:---|:---|:---| | allow_origin | Array of strings | **参数解释**：允许的访问来源列表。 **取值范围**：单个列表项的取值 - 通配符（\*），表示匹配所有来源。 - 除通配符外，其他值只能是以http://或者https://开头（小写），后面加域名。可以是具体域名或一级泛域名，可以包含端口或不包含端口。例：http://\*.test.abc.example.com:80 | | allow_methods | Array of strings | **参数解释**：选择跨域访问时允许的 HTTP 方法。 **取值范围**：不涉及 | | allow_headers | Array of strings | **参数解释**：允许跨域的 Header 列表。 **取值范围**：不涉及 | | expose_headers | Array of strings | **参数解释**：允许暴露的Header列表。 **取值范围**：不涉及 | | allow_credentials | Boolean | **参数解释**：是否允许携带凭证信息。 **取值范围**： - true：是。 - false：否。 | | max_age | Long | **参数解释**：预检请求在浏览器的最大缓存时间，单位：秒。 **取值范围**：-1\~172800 | 表12TrafficMirrorConfig | 参数 | 参数类型 | 描述 | |:---|:---|:---| | target_ids | Array of strings | **参数解释**：流量镜像的目的后端服务器组ID。 **取值范围**：不涉及 | | mirror_request_body_enable | Boolean | **参数解释**：镜像请求是否携带请求体，默认true。 **取值范围**：不涉及 | 表13FixtedResponseConfig | 参数 | 参数类型 | 描述 | |:---|:---|:---| | status_code | String | **参数解释**：返回码。 **取值范围**：200\~299、400\~499和500\~599。 | | content_type | String | **参数解释**：返回body的格式。 **取值范围**： - text/plain - text/css - text/html - application/javascript - application/json | | message_body | String | **参数解释**：返回消息内容。 **取值范围**：不涉及 | | insert_headers_config | [InsertHeadersConfig] object | **参数解释**：要添加的请求头参数列表。 | | remove_headers_config | [RemoveHeadersConfig] object | **参数解释**：要移除的请求头参数列表。 | | traffic_limit_config | [TrafficLimitConfig] object | **参数解释**：转发策略限速的配置。 | 表14InsertHeadersConfig | 参数 | 参数类型 | 描述 | |:---|:---|:---| | configs | Array of [InsertHeaderConfig] objects | **参数解释**：要添加请求头参数列表。 | 表15InsertHeaderConfig | 参数 | 参数类型 | 描述 | |:---|:---|:---| | key | String | **参数解释**：请求头参数名。 **取值范围**：1-40个字符，字母a-z（不区分大小写）、数字，短划线-和下划线_。 | | value_type | String | **参数解释**：请求头参数类别。 **取值范围**： - USER_DEFINED：用户自定义请求头。 - REFERENCE_HEADER：引用请求头字段中的某一个字段。 - SYSTEM_DEFINED：表示请求头参数只能使用系统定义的一系列固定值，取值列表见value字段描述。 | | value | String | **参数解释**：请求头参数的值。 **取值范围**：1-128个字符，支持ascii码值32\<=ch\<=127范围内可打印字符，\*和英文问号?。不能以空格开头或结尾，不允许设置值为：connection、upgrade、content-length、transfer-encoding、keep-alive、te、host、cookie、remoteip、authority、transparent、x-forwarded-host、x-forwarded-for、x-forwarded-for-port、x-forwarded-tls-certificate-id、 x-forwarded-tls-protocol、x-forwarded-tls-cipher、x-forwarded-port、x-real-ip、x-forwarded-proto、x-forwarded-elb-ip、 x-forwarded-elb-id、x-forwarded-elb-vip、x-nuwa-trace-ne-in、x-nuwa-trace-ne-out。 | 表16RemoveHeadersConfig | 参数 | 参数类型 | 描述 | |:---|:---|:---| | configs | Array of [RemoveHeaderConfig] objects | **参数解释**：要移除的请求头参数列表。 | 表17RemoveHeaderConfig | 参数 | 参数类型 | 描述 | |:---|:---|:---| | key | String | **参数解释**：被移除的请求头的参数名。 **取值范围**：1-40个字符，字母a-z（不区分大小写）、数字，短划线-和下划线_。 | 表18TrafficLimitConfig | 参数 | 参数类型 | 描述 | |:---|:---|:---| | qps | Integer | **参数解释**：转发策略qps限速。 **取值范围**：0-100000，单位：个/秒。0表示不限速。 | | per_source_ip_qps | Integer | **参数解释**：对转发策略单源(单个客户端IP)进行限速。 **取值范围**：0-100000，单位：个/秒。0表示不限速。 | | burst | Integer | **参数解释**：设置当单源qps超限时，允许的局部突增请求数量。超出该限制的请求将返回503。 **取值范围**：0-100000，单位：个/秒。 | #### 请求示例 查询指定转发策略详情 ``` GET https://{ELB_Endpoint}/v3/99a3fff0d03c428eac3678da6a7d0f24/elb/l7policies/cf4360fd-8631-41ff-a6f5-b72c35da74be ``` #### 响应示例 **状态码：200** 操作正常返回。 ``` { "l7policy" : { "name" : "my policy", "redirect_pool_id" : null, "description" : "", "admin_state_up" : true, "rules" : [ { "id" : "a8310d08-6d4c-413a-aa45-7e43f8183193" } ], "project_id" : "0c1503d710984bad92306faea3654dfd", "listener_id" : "8b9d7d2c-49dc-43ba-99f5-3bc476bdf10b", "redirect_url" : null, "redirect_url_config" : null, "redirect_pools_config" : [ { "weight" : 100, "pool_id" : "599fdd99-d908-4dff-9db3-15eec274dfed" } ], "redirect_pools_sticky_session_config" : { "enable" : false, "timeout" : 1000 }, "fixed_response_config" : null, "redirect_listener_id" : null, "action" : "REDIRECT_TO_POOL", "position" : 100, "priority" : 1, "provisioning_status" : "ACTIVE", "id" : "10ebd807-54b1-4f73-a21e-4e7af939d13b", "enterprise_project_id" : "0", "created_at" : "2025-04-15T08:36:43Z", "updated_at" : "2025-04-15T11:49:56Z", "redirect_pools_extend_config" : { "rewrite_url_enable" : false, "rewrite_url_config" : null, "insert_headers_config" : { "configs" : [ { "key" : "test", "value" : "xxx", "value_type" : "USER_DEFINED" } ] }, "remove_headers_config" : { "configs" : [ { "key" : "req-trace-id" } ] }, "traffic_limit_config" : null, "cors_config" : null, "traffic_mirror_config" : null } }, "request_id" : "54961722be349499068aa73a5f91745a" } ``` #### SDK代码示例 SDK代码示例如下。 - [Java] ``` package com.huaweicloud.sdk.test; import com.huaweicloud.sdk.core.auth.ICredential; import com.huaweicloud.sdk.core.auth.BasicCredentials; import com.huaweicloud.sdk.core.exception.ConnectionException; import com.huaweicloud.sdk.core.exception.RequestTimeoutException; import com.huaweicloud.sdk.core.exception.ServiceResponseException; import com.huaweicloud.sdk.elb.v3.region.ElbRegion; import com.huaweicloud.sdk.elb.v3.*; import com.huaweicloud.sdk.elb.v3.model.*; public class ShowL7PolicySolution { public static void main(String[] args) { // The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security. // In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment String ak = System.getenv("CLOUD_SDK_AK"); String sk = System.getenv("CLOUD_SDK_SK"); String projectId = "{project_id}"; ICredential auth = new BasicCredentials() .withProjectId(projectId) .withAk(ak) .withSk(sk); ElbClient client = ElbClient.newBuilder() .withCredential(auth) .withRegion(ElbRegion.valueOf("")) .build(); ShowL7PolicyRequest request = new ShowL7PolicyRequest(); request.withL7policyId("{l7policy_id}"); try { ShowL7PolicyResponse response = client.showL7Policy(request); System.out.println(response.toString()); } catch (ConnectionException e) { e.printStackTrace(); } catch (RequestTimeoutException e) { e.printStackTrace(); } catch (ServiceResponseException e) { e.printStackTrace(); System.out.println(e.getHttpStatusCode()); System.out.println(e.getRequestId()); System.out.println(e.getErrorCode()); System.out.println(e.getErrorMsg()); } } } ``` - [Python] ``` # coding: utf-8 import os from huaweicloudsdkcore.auth.credentials import BasicCredentials from huaweicloudsdkelb.v3.region.elb_region import ElbRegion from huaweicloudsdkcore.exceptions import exceptions from huaweicloudsdkelb.v3 import * if __name__ == "__main__": # The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security. # In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment ak = os.environ["CLOUD_SDK_AK"] sk = os.environ["CLOUD_SDK_SK"] projectId = "{project_id}" credentials = BasicCredentials(ak, sk, projectId) client = ElbClient.new_builder() \ .with_credentials(credentials) \ .with_region(ElbRegion.value_of("")) \ .build() try: request = ShowL7PolicyRequest() request.l7policy_id = "{l7policy_id}" response = client.show_l7_policy(request) print(response) except exceptions.ClientRequestException as e: print(e.status_code) print(e.request_id) print(e.error_code) print(e.error_msg) ``` - [Go] ``` package main import ( "fmt" "github.com/huaweicloud/huaweicloud-sdk-go-v3/core/auth/basic" elb "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/elb/v3" "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/elb/v3/model" region "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/elb/v3/region" ) func main() { // The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security. // In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment ak := os.Getenv("CLOUD_SDK_AK") sk := os.Getenv("CLOUD_SDK_SK") projectId := "{project_id}" auth, err := basic.NewCredentialsBuilder(). WithAk(ak). WithSk(sk). WithProjectId(projectId). SafeBuild() if err != nil { fmt.Println(err) return } hcClient, err := elb.ElbClientBuilder(). WithRegion(region.ValueOf("")). WithCredential(auth). SafeBuild() if err != nil { fmt.Println(err) return } client := elb.NewElbClient(hcClient) request := &model.ShowL7PolicyRequest{} request.L7policyId = "{l7policy_id}" response, err := client.ShowL7Policy(request) if err == nil { fmt.Printf("%+v\n", response) } else { fmt.Println(err) } } ``` - [更多] 更多编程语言的SDK代码示例，请参见[API Explorer](https://console.huaweicloud.com/apiexplorer/#/openapi/ELB/sdk?api=ShowL7Policy&version=v3)的代码示例页签，可生成自动对应的SDK代码示例。 #### 状态码 | 状态码 | 描述 | |:---|:---| | 200 | 操作正常返回。 | #### 错误码 请参见[错误码](https://support.huaweicloud.com/api-elb/ErrorCode.html)。