Querying Forwarding Rules
Function
This API is used to query all forwarding rules.
Constraints
This API has the following constraints:
-
Parameters marker, limit, and page_reverse are used for pagination query.
-
Parameters marker and page_reverse take effect only when they are used together with parameter limit.
Calling Method
For details, see Calling APIs.
URI
GET /v3/{project_id}/elb/l7policies/{l7policy_id}/rules
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
project_id |
Yes |
String |
Definition: Specifies the project ID. For details about how to obtain a project ID, see Obtaining a Project ID. Constraints: N/A Range: The value can contain a maximum of 32 characters, including digits and lowercase letters. Default value: N/A |
l7policy_id |
Yes |
String |
Definition: Specifies the forwarding policy ID. Constraints: N/A Range: N/A Default value: N/A |
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
limit |
No |
Integer |
Definition: Specifies the number of records returned on each page. Constraints: N/A Range: 0 to 2000 Default value: 2000 |
marker |
No |
String |
Definition: Specifies the ID of the last record on the previous page. Constraints:
Range: N/A Default value: N/A |
page_reverse |
No |
Boolean |
Definition: Specifies whether to use reverse query. Constraints:
Range:
Default value: false |
id |
No |
Array of strings |
Definition: Specifies the forwarding rule ID. Multiple IDs can be used for query in the format of id=xxx&id=xxx. Constraints: N/A Range: N/A Default value: N/A |
compare_type |
No |
Array of strings |
Definition: Specifies how requests are matched. Multiple values can be used for query in the format of compare_type=xxx&compare_type=xxx. Range:
Default value: N/A |
provisioning_status |
No |
Array of strings |
Definition: Specifies the provisioning status of the forwarding rule. Multiple provisioning statuses can be used for query in the format of provisioning_status=xxx&provisioning_status=xxx. Constraints: N/A Range: The value can only be ACTIVE, indicating that the forwarding rule is provisioned successfully. Default value: N/A |
invert |
No |
Boolean |
Definition: Specifies whether reverse matching is supported. Constraints: N/A Range: false Default value: N/A |
admin_state_up |
No |
Boolean |
Definition: Specifies the administrative status of the forwarding rule. This parameter is unsupported. Please do not use it. Constraints: N/A Range: N/A Default value: N/A |
value |
No |
Array of strings |
Definition: Specifies the value of the match content. Multiple values can be used for query in the format of value=xxx&value=xxx. Constraints: N/A Range: N/A Default value: N/A |
key |
No |
Array of strings |
Definition: Specifies the key of the match content that is used to identify the forwarding rule. Multiple keys can be used for query in the format of key=xxx&key=xxx. Constraints: N/A Range: N/A Default value: N/A |
type |
No |
Array of strings |
Definition: Specifies the match type. The value can be HOST_NAME or PATH. Multiple types can be used for query in the format of type=xxx&type=xxx. Constraints: N/A Range: N/A Default value: N/A |
enterprise_project_id |
No |
Array of strings |
Definition: Specifies the ID of the enterprise project. Multiple values can be used for query in the format of: enterprise_project_id=xxx&enterprise_project_id=xxx. Constraints:
Range: N/A Default value: N/A |
Request Parameters
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
X-Auth-Token |
Yes |
String |
Definition: Specifies the token used for IAM authentication. Constraints: N/A Range: N/A Default value: N/A |
Response Parameters
Status code: 200
Parameter |
Type |
Description |
---|---|---|
request_id |
String |
Definition: Specifies the request ID. Range: The value is automatically generated, and can contain characters including digits, lowercase letters, and hyphens (-). |
page_info |
PageInfo object |
Definition: Specifies the pagination information. |
rules |
Array of L7Rule objects |
Definition: Lists the forwarding rules. |
Parameter |
Type |
Description |
---|---|---|
previous_marker |
String |
Definition: Specifies the ID of the first record in the pagination query result. If page_reverse is set to true, this parameter is used together to query resources on the previous page. Range: N/A |
next_marker |
String |
Definition: Specifies the ID of the last record in the pagination query result. It is usually used to query resources on the next page. Range: N/A |
current_count |
Integer |
Definition: Specifies the number of records returned on the current page. Range: N/A |
Parameter |
Type |
Description |
---|---|---|
admin_state_up |
Boolean |
Definition: Specifies the administrative status of the forwarding rule. Range: The value can only be true. This parameter is unsupported. Please do not use it. |
compare_type |
String |
Definition: Specifies how requests are matched with the forwarding rule. Range: If type is set to HOST_NAME, this parameter can only be set to EQUAL_TO. If type is set to PATH, the value can be REGEX, STARTS_WITH, or EQUAL_TO. |
key |
String |
Definition: Specifies the key of the match content. Range: N/A |
project_id |
String |
Definition: Specifies the ID of the project where the forwarding rule is used. Range: N/A |
type |
String |
Definition: Specifies the forwarding rule type. Range:
|
value |
String |
Definition: Specifies the value of the match item. Range:
|
provisioning_status |
String |
Definition: Specifies the provisioning status of the forwarding rule. This parameter is invalid. The default value is ACTIVE. Range: ACTIVE, PENDING_CREATE, or ERROR. |
invert |
Boolean |
Definition: Specifies whether reverse matching is supported. Range: N/A |
id |
String |
Definition: Specifies the forwarding rule ID. Range: N/A |
conditions |
Array of RuleCondition objects |
Definition: Specifies the conditions contained in a forwarding rule. Range: N/A |
created_at |
String |
Definition: Specifies the creation time. Range: The value must be a UTC time in the yyyy-MM-dd'T'HH:mm:ss'Z' format. Note: This parameter will not be returned for resources associated with existing dedicated load balancers and for resources associated with existing and new shared load balancers. |
updated_at |
String |
Definition: Specifies the update time. Range: The value must be a UTC time in the yyyy-MM-dd'T'HH:mm:ss'Z' format. Note: This parameter will not be returned for resources associated with existing dedicated load balancers and for resources associated with existing and new shared load balancers. |
Parameter |
Type |
Description |
---|---|---|
key |
String |
Definition: Specifies the key of match item. Constraints: All keys in the conditions list in the same rule must be the same. Range:
Default value: N/A |
value |
String |
Definition: Specifies the value of the match item. Constraints: The value of each condition in a forwarding rule must be unique. Range:
Default value: N/A |
Example Requests
Querying forwarding rules
GET https://{ELB_Endpoint}/v3/{99a3fff0d03c428eac3678da6a7d0f24}/elb/l7policies/cf4360fd-8631-41ff-a6f5-b72c35da74be/rules
Example Responses
Status code: 200
Successful request.
{ "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 Sample Code
The SDK sample code is as follows.
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) } } |
For SDK sample code of more programming languages, see the Sample Code tab in API Explorer. SDK sample code can be automatically generated.
Status Codes
Status Code |
Description |
---|---|
200 |
Successful request. |
Error Codes
See Error Codes.
Feedback
Was this page helpful?
Provide feedbackThank you very much for your feedback. We will continue working to improve the documentation.See the reply and handling status in My Cloud VOC.
For any further questions, feel free to contact us through the chatbot.
Chatbot