查询转发规则列表
功能介绍
查询转发规则列表。
接口约束
-
分页查询使用的参数为marker、limit、page_reverse。
-
marker和page_reverse只有和limit一起使用时才会生效,单独使用无效。
调用方法
请参见如何调用API。
URI
GET /v3/{project_id}/elb/l7policies/{l7policy_id}/rules
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
project_id |
是 |
String |
参数解释:项目ID。 |
l7policy_id |
是 |
String |
策略ID。 |
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
limit |
否 |
Integer |
参数解释:每页返回的个数。 取值范围:0-2000 默认取值:2000 |
marker |
否 |
String |
上一页最后一条记录的ID。 使用说明:
|
page_reverse |
否 |
Boolean |
是否反向查询。 取值:
使用说明:
|
id |
否 |
Array of strings |
转发规则ID。 支持多值查询,查询条件格式:id=xxx&id=xxx。 |
compare_type |
否 |
Array of strings |
转发匹配方式。 取值:
支持多值查询,查询条件格式:compare_type=xxx&compare_type=xxx。 |
provisioning_status |
否 |
Array of strings |
转发规则的配置状态。 取值:ACTIVE 表示正常。 支持多值查询,查询条件格式:provisioning_status=xxx&provisioning_status=xxx。 |
invert |
否 |
Boolean |
是否反向匹配。使用说明:固定为false。该字段能更新但不会生效。 |
admin_state_up |
否 |
Boolean |
转发规则的管理状态。 不支持该字段,请勿使用。 |
value |
否 |
Array of strings |
匹配内容的值。 支持多值查询,查询条件格式:value=xxx&value=xxx。 |
key |
否 |
Array of strings |
匹配内容的键值,用于标识规则。 支持多值查询,查询条件格式:key=xxx&key=xxx。 不支持该字段,请勿使用。 |
type |
否 |
Array of strings |
匹配类别,可以为HOST_NAME,PATH。 一个l7policy下创建的l7rule的type不能重复。 支持多值查询,查询条件格式:type=xxx&type=xxx。 |
enterprise_project_id |
否 |
Array of strings |
参数解释:所属的企业项目ID。 如果enterprise_project_id不传值,默认查询所有企业项目下的资源,鉴权按照细粒度权限鉴权,必须在用户组下分配elb:*list权限。 如果enterprise_project_id传值,鉴权按照企业项目权限鉴权,分为传入具体eps_id和all_granted_eps两种场景,前者查询指定eps_id的eps下的资源,后者查询的是所有有list权限的eps下的资源。 支持多值查询,查询条件格式: enterprise_project_id=xxx&enterprise_project_id=xxx。 |
请求参数
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
X-Auth-Token |
是 |
String |
参数解释:IAM鉴权Token |
响应参数
状态码: 200
参数 |
参数类型 |
描述 |
---|---|---|
request_id |
String |
参数解释:请求ID。 注:自动生成 。 |
page_info |
PageInfo object |
参数解释:分页信息。 |
rules |
Array of L7Rule objects |
参数解释:规则对象列表。 |
参数 |
参数类型 |
描述 |
---|---|---|
previous_marker |
String |
参数解释:分页查询结果中第一条记录的ID。通常用于配合page_reverse=true查询上一页。 |
next_marker |
String |
参数解释:分页查询结果中最后一条记录的ID。通常用于查询下一页。 |
current_count |
Integer |
参数解释:当前的记录数。 |
参数 |
参数类型 |
描述 |
---|---|---|
admin_state_up |
Boolean |
参数解释:转发规则的管理状,固定为true。 不支持该字段,请勿使用。 |
compare_type |
String |
参数解释:转发规则的匹配方式。 取值范围:type为HOST_NAME时可以为EQUAL_TO。type为PATH时可以为REGEX,STARTS_WITH,EQUAL_TO。 |
key |
String |
参数解释:匹配内容的键值。 约束限制:type为HOST_NAME和PATH时,该字段不生效。 |
project_id |
String |
参数解释:转发规则所在的项目ID。 |
type |
String |
参数解释:转发规则类别。 约束限制:
取值范围:
|
value |
String |
参数解释:匹配内容的值。 约束限制:仅当conditions空时该字段生效。 取值范围:
|
provisioning_status |
String |
参数解释:provisioning状态。该字段无效,默认为ACTIVE。 取值范围:ACTIVE、PENDING_CREATE 或者ERROR。 |
invert |
Boolean |
参数解释:是否反向匹配。 约束限制:固定为false。该字段能更新但不会生效。 |
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时区。 注意:独享型实例的历史数据以及共享型实例下的资源,不返回该字段。 |
参数 |
参数类型 |
描述 |
---|---|---|
key |
String |
参数解释:匹配项的名称。 约束限制:同一个rule内的conditions列表中所有key必须相同。 取值范围:
|
value |
String |
参数解释:匹配项的值。 约束限制: 同一个rule内的conditions列表中所有value不允许重复。 取值范围:
|
请求示例
查询转发规则列表
GET https://{ELB_Endpoint}/v3/{99a3fff0d03c428eac3678da6a7d0f24}/elb/l7policies/cf4360fd-8631-41ff-a6f5-b72c35da74be/rules
响应示例
状态码: 200
操作正常返回。
{ "rules" : [ { "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" } ], "page_info" : { "previous_marker" : "84f4fcae-9c15-4e19-a99f-72c0b08fd3d7", "current_count" : 1 }, "request_id" : "ae4dbd7d-9271-4040-98b6-3bfe45bb15ee" }
SDK代码示例
SDK代码示例如下。
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 |
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 ListL7RulesSolution { 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(); ListL7RulesRequest request = new ListL7RulesRequest(); request.withL7policyId("{l7policy_id}"); try { ListL7RulesResponse response = client.listL7Rules(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()); } } } |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 |
# 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 = ListL7RulesRequest() request.l7policy_id = "{l7policy_id}" response = client.list_l7_rules(request) print(response) except exceptions.ClientRequestException as e: print(e.status_code) print(e.request_id) print(e.error_code) print(e.error_msg) |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 |
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 := basic.NewCredentialsBuilder(). WithAk(ak). WithSk(sk). WithProjectId(projectId). Build() client := elb.NewElbClient( elb.ElbClientBuilder(). WithRegion(region.ValueOf("<YOUR REGION>")). WithCredential(auth). Build()) request := &model.ListL7RulesRequest{} request.L7policyId = "{l7policy_id}" response, err := client.ListL7Rules(request) if err == nil { fmt.Printf("%+v\n", response) } else { fmt.Println(err) } } |
更多编程语言的SDK代码示例,请参见API Explorer的代码示例页签,可生成自动对应的SDK代码示例。
状态码
状态码 |
描述 |
---|---|
200 |
操作正常返回。 |
错误码
请参见错误码。