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 |
Specifies the forwarding policy ID. |
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 |
Specifies the forwarding rule ID. Multiple IDs can be used for query in the format of id=xxx&id=xxx. |
compare_type |
No |
Array of strings |
Specifies how requests are matched with the domain names or URL. Value options:
Multiple values can be used for query in the format of compare_type=xxx&compare_type=xxx. |
provisioning_status |
No |
Array of strings |
Specifies the provisioning status of the forwarding rule. The value can only be ACTIVE, indicating that the forwarding rule is provisioned successfully. Multiple provisioning statuses can be used for query in the format of provisioning_status=xxx&provisioning_status=xxx. |
invert |
No |
Boolean |
Specifies whether reverse matching is supported. The value is fixed at false. This parameter can be updated but remains invalid. |
admin_state_up |
No |
Boolean |
Specifies the administrative status of the forwarding rule. This parameter is unsupported. Please do not use it. |
value |
No |
Array of strings |
Specifies the value of the match content. Multiple values can be used for query in the format of value=xxx&value=xxx. |
key |
No |
Array of strings |
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. This parameter is unsupported. Please do not use it. |
type |
No |
Array of strings |
Specifies the match type. The value can be HOST_NAME or PATH. The type of forwarding rules for the same forwarding policy cannot be the same. Multiple types can be used for query in the format of type=xxx&type=xxx. |
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. |
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. The value is fixed at 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. |
project_id |
String |
Definition: Specifies the ID of the project where the forwarding rule is used. |
type |
String |
Definition: Specifies the forwarding rule type. Constraints: If type is set to HOST_NAME, PATH, METHOD, or SOURCE_IP, only one forwarding rule can be created for each type. If type is set to HEADER and QUERY_STRING, multiple forwarding rules can be created for each type. Range:
|
value |
String |
Definition: Specifies the value of the match item. Constraints: This parameter takes effect only when conditions is left blank. 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. Constraints: The value is fixed at false. This parameter can be updated but will not take effect. |
id |
String |
Definition: Specifies the forwarding rule ID. |
conditions |
Array of RuleCondition objects |
Definition: Specifies the conditions contained in a forwarding rule. Constraints:
|
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. |
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. |
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:
|
value |
String |
Definition: Specifies the value of the match item. Constraints: The value of each condition in a forwarding rule must be unique. Range:
|
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" }
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.