
# 查询转发规则详情 - ShowL7Rule
#### 功能介绍
查询七层转发规则详情。
#### 调用方法
请参见[如何调用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:l7rules:show | Read | l7rule \*   | g:EnterpriseProjectId | elb:l7rules:get | -      |
     
  
 
#### URI
GET /v3/{project_id}/elb/l7policies/{l7policy_id}/rules/{l7rule_id}
表1路径参数 
| 参数          | 是否必选 | 参数类型   | 描述                                                                                                                                                                                                                                          |
|:---|:---|:---|:---|
| project_id  | 是    | String | **参数解释** ：项目ID。获取方式请参见[获取项目ID](https://support.huaweicloud.com/api-elb/elb_fl_0008.html)。 **约束限制**：不涉及 **取值范围**：长度为32个字符，由小写字母和数字组成。 **默认取值**：不涉及 |
| l7policy_id | 是    | String | **参数解释**：7层转发策略。 **约束限制**：不涉及 **取值范围**：不涉及 **默认取值**：不涉及                                                                                           |
| l7rule_id   | 是    | String | **参数解释**：7层转发规则。 **约束限制**：不涉及 **取值范围**：不涉及 **默认取值**：不涉及                                                                                           |
   
#### 请求参数
表2请求Header参数 
| 参数           | 是否必选 | 参数类型   | 描述                                                                                                                                                    |
|:---|:---|:---|:---|
| X-Auth-Token | 是    | String | **参数解释**：IAM鉴权Token。 **约束限制**：不涉及 **取值范围**：不涉及 **默认取值**：不涉及 |
   
#### 响应参数
**状态码：200**
表3响应Body参数 
| 参数         | 参数类型                                          | 描述                                                                                |
|:---|:---|:---|
| request_id | String                                        | **参数解释**：请求ID。 **取值范围**：由数字、小写字母和中划线（-）组成的字符串，自动生成。 |
| rule       | [L7Rule] object | **参数解释**：规则对象。                                                                    |
   
 表4L7Rule 
| 参数                  | 参数类型                                                                  | 描述                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              |
|:---|:---|:---|
| admin_state_up      | Boolean                                                               | **参数解释**：转发规则的管理状态。 **取值范围**：固定为true。 不支持该字段，请勿使用。                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  |
| compare_type        | String                                                                | **参数解释**：转发规则的匹配方式。 **取值范围**：type为HOST_NAME时可以为EQUAL_TO。type为PATH时可以为REGEX，STARTS_WITH，EQUAL_TO。                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  |
| key                 | String                                                                | **参数解释**：匹配内容的键值。 **取值范围**：不涉及                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    |
| project_id          | String                                                                | **参数解释**：转发规则所在的项目ID。 **取值范围**：不涉及                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                |
| type                | String                                                                | **参数解释**：转发规则类别。 **取值范围**： - HOST_NAME：匹配域名。   - PATH：匹配请求路径。   - METHOD：匹配请求方法。   - HEADER：匹配请求头。   - QUERY_STRING：匹配请求查询参数。   - SOURCE_IP：匹配请求源IP地址。   - COOKIE: 匹配cookie信息。    |
| value               | String                                                                | **参数解释**：匹配内容的值。 **取值范围**： - 当type为HOST_NAME时，字符串只能包含英文字母、数字、-.*，必须以字母、数字或* 开头。若域名中包含\*，则*只能出现在开头且必须以*.开始。当\*开头时表示通配0\~任一个字符。   - 当type为PATH时，当转发规则的compare_type为STARTS_WITH、EQUAL_TO时，字符串只能包含英文字母、数字、_\~';@\^-%#\&$.\*+?,=!:\|\\/()\[\]{}，且必须以/开头。   - 当type为METHOD、SOURCE_IP、HEADER、QUERY_STRING时，该字段无意义，使用conditions来指定key，value。                                                                                                                                                                                                                                                                                              |
| provisioning_status | String                                                                | **参数解释**：provisioning状态。该字段无效，默认为ACTIVE。 **取值范围**： - ACTIVE：已生效。   - PENDING_CREATE：创建中。   - ERROR：当前配置有误。                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        |
| invert              | Boolean                                                               | **参数解释**：是否反向匹配。 **取值范围**：不涉及                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                     |
| id                  | String                                                                | **参数解释**：规则ID。 **取值范围**：不涉及                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                       |
| conditions          | Array of [RuleCondition] objects | **参数解释**：转发规则的匹配条件。 **取值范围**：不涉及                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  |
| created_at          | String                                                                | **参数解释**：创建时间。 **取值范围**：格式：yyyy-MM-dd'T'HH:mm:ss'Z'，UTC时区。 注意：独享型实例的历史数据以及共享型实例下的资源，不返回该字段。                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                         |
| updated_at          | String                                                                | **参数解释**：更新时间。 **取值范围**：格式：yyyy-MM-dd'T'HH:mm:ss'Z'，UTC时区。 注意：独享型实例的历史数据以及共享型实例下的资源，不返回该字段。                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                         |
   
 表5RuleCondition 
| 参数    | 参数类型   | 描述                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                               |
|:---|:---|:---|
| key   | String | **参数解释**：匹配项的名称。 **取值范围**： - 当转发规则类别type为HOST_NAME、PATH、METHOD、SOURCE_IP时，该字段固定为空字符串。   - 当转发规则类别type为HEADER时，key表示请求头参数的名称，value表示请求头参数的值。key的长度限制1-40字符，只允许包含字母、数字和-_。   - 当转发规则类别type为QUERY_STRING时，key表示查询参数的名称，value表示查询参数的值。key的长度限制为1-128字符，不支持空格，中括号，大括号，尖括号，反斜杠，双引号，'#'，'\&'，'\|'，'%'，'\~'，字母区分大小写。                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                       |
| value | String | **参数解释**：匹配项的值。 **取值范围**： - 当转发规则类别type为HOST_NAME时，key固定为空字符串，value表示域名的值。value长度1-128字符，字符串只能包含英文字母、数字、-.\*，必须以字母、数字或\*开头，\*只能出现在开头且必须以\*.开始。   - 当转发规则类别type为PATH时，key固定为空字符串，value表示请求路径的值。value长度1-128字符。当转发规则的compare_type为STARTS_WITH、EQUAL_TO时，字符串只能包含英文字母、数字、_\~';@\^-%#\&$.\*+?,=!:\|\\/()\[\]{}，且必须以"/"开头。   - 当转发规则类别type为HEADER时，key表示请求头参数的名称，value表示请求头参数的值。value长度限制1-128字符，不支持空格，双引号，支持以下通配符：\*（匹配0个或更多字符）和？（正好匹配1个字符）。   - 当转发规则类别type为QUERY_STRING时，key表示查询参数的名称，value表示查询参数的值。value长度限制为1-128字符，不支持空格，中括号，大括号，尖括号，反斜杠，双引号，'#'，'\&'，'\|'，'%'，'\~'，字母区分大小写，支持通配符：\*（匹配0个或更多字符）和？（正好匹配1个字符）   - 当转发规则类别type为METHOD时，key固定为空字符串，value表示请求方式。value取值范围为：GET, PUT,POST,DELETE, PATCH, HEAD, OPTIONS。   - 当转发规则类别type为SOURCE_IP时，key固定为空字符串，value表示请求源地址。value为CIDR格式，支持ipv4，ipv6。例如192.168.0.2/32，2049::49/64。    |
   
#### 请求示例
查询指定转发规则详情
```
GET https://{ELB_Endpoint}/v3/99a3fff0d03c428eac3678da6a7d0f24/elb/l7policies/cf4360fd-8631-41ff-a6f5-b72c35da74be/rules/84f4fcae-9c15-4e19-a99f-72c0b08fd3d7
```
#### 响应示例
**状态码：200**
OK
```
{
  "rule" : {
    "compare_type" : "STARTS_WITH",
    "provisioning_status" : "ACTIVE",
    "project_id" : "99a3fff0d03c428eac3678da6a7d0f24",
    "invert" : false,
    "admin_state_up" : true,
    "value" : "/ccc.html",
    "key" : null,
    "type" : "PATH",
    "id" : "84f4fcae-9c15-4e19-a99f-72c0b08fd3d7",
    "conditions" : null,
    "created_at" : "2025-04-29T14:53:09Z",
    "updated_at" : "2025-04-29T14:53:09Z"
  },
  "request_id" : "0d799435-259e-459f-b2bc-0beee06f6a77"
}
```
#### 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 ShowL7RuleSolution {
      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("<YOUR REGION>"))
                  .build();
          ShowL7RuleRequest request = new ShowL7RuleRequest();
          request.withL7policyId("{l7policy_id}");
          request.withL7ruleId("{l7rule_id}");
          try {
              ShowL7RuleResponse response = client.showL7Rule(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("<YOUR REGION>")) \
          .build()
      try:
          request = ShowL7RuleRequest()
          request.l7policy_id = "{l7policy_id}"
          request.l7rule_id = "{l7rule_id}"
          response = client.show_l7_rule(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("<YOUR REGION>")).
           WithCredential(auth).
           SafeBuild()
      if err != nil {
          fmt.Println(err)
          return
      }
      client := elb.NewElbClient(hcClient)
      request := &model.ShowL7RuleRequest{}
  request.L7policyId = "{l7policy_id}"
  request.L7ruleId = "{l7rule_id}"
  response, err := client.ShowL7Rule(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=ShowL7Rule&version=v3)的代码示例页签，可生成自动对应的SDK代码示例。
#### 状态码
| 状态码 | 描述 |
|:---|:---|
| 200 | OK |
   
#### 错误码
请参见[错误码](https://support.huaweicloud.com/api-elb/ErrorCode.html)。
