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 |
Specifies the project ID. |
l7policy_id |
Yes |
String |
Specifies the forwarding policy ID. |
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
limit |
No |
Integer |
Specifies the number of records on each page. Minimum: 0 Maximum: 2000 Default: 2000 |
marker |
No |
String |
Specifies the ID of the last record on the previous page. Note:
|
page_reverse |
No |
Boolean |
Specifies whether to use reverse query. Values:
Note:
|
id |
No |
Array |
Specifies the forwarding rule ID. Multiple IDs can be queried in the format of id=xxx&id=xxx. |
compare_type |
No |
Array |
Specifies how requests are matched with the domain names or URL. Values:
Multiple values can be queried in the format of compare_type=xxx&compare_type=xxx. |
provisioning_status |
No |
Array |
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 queried 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. The default value is true. This parameter is unsupported. Please do not use it. |
value |
No |
Array |
Specifies the value of the match content. Multiple values can be queried in the format of value=xxx&value=xxx. |
key |
No |
Array |
Specifies the key of the match content that is used to identify the forwarding rule. Multiple keys can be queried in the format of key=xxx&key=xxx. This parameter is unsupported. Please do not use it. |
type |
No |
Array |
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 queried in the format of type=xxx&type=xxx. |
enterprise_project_id |
No |
Array |
Specifies the enterprise project ID.
Multiple IDs can be queried in the format of enterprise_project_id=xxx&enterprise_project_id=xxx. |
Request Parameters
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
X-Auth-Token |
Yes |
String |
Specifies the token used for IAM authentication. |
Response Parameters
Status code: 200
Parameter |
Type |
Description |
---|---|---|
request_id |
String |
Specifies the request ID. The value is automatically generated. |
page_info |
PageInfo object |
Shows pagination information. |
rules |
Array of L7Rule objects |
Lists the forwarding rules. |
Parameter |
Type |
Description |
---|---|---|
previous_marker |
String |
Specifies the ID of the first record in the pagination query result. |
next_marker |
String |
Specifies the ID of the last record in the pagination query result. |
current_count |
Integer |
Specifies the number of records. |
Parameter |
Type |
Description |
---|---|---|
admin_state_up |
Boolean |
Specifies the administrative status of the forwarding rule. The default value is true. This parameter is unsupported. Please do not use it. |
compare_type |
String |
Specifies how requests are matched with the domain name or URL.
|
key |
String |
Specifies the key of the match content. This parameter will not take effect if type is set to HOST_NAME or PATH. Minimum: 1 Maximum: 255 |
project_id |
String |
Specifies the project ID. |
type |
String |
Specifies the type of the forwarding rule. The value can be one of the following:
Note: 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 or QUERY_STRING, multiple forwarding rules can be created for each type. |
value |
String |
Specifies the value of the match item. For example, if a domain name is used for matching, value is the domain name. This parameter will take effect only when conditions is left blank.
Minimum: 1 Maximum: 128 |
provisioning_status |
String |
Specifies the provisioning status of the forwarding rule. The value can only be ACTIVE (default), PENDING_CREATE, or ERROR. This parameter is unsupported. Please do not use it. |
invert |
Boolean |
Specifies whether reverse matching is supported. The value is fixed at false. This parameter can be updated but will not take effect. |
id |
String |
Specifies the forwarding policy ID. |
conditions |
Array of RuleCondition objects |
Specifies the matching conditions of the forwarding rule. This parameter is available only when enhance_l7policy_enable is set to true. If conditions is specified, parameters key and value will not take effect, and the conditions value will contain all conditions configured for the forwarding rule. The keys in the list must be the same, whereas each value must be unique. |
created_at |
String |
Specifies the time when the forwarding rule was added. The format is yyyy-MM-dd'T'HH:mm:ss'Z' (UTC time). This is a new field in this version, and it 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 |
Specifies the time when the forwarding rule was updated. The format is yyyy-MM-dd'T'HH:mm:ss'Z' (UTC time). This is a new field in this version, and it 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 |
Specifies the key of match item.
All keys in the conditions list in the same rule must be the same. Minimum: 1 Maximum: 128 |
value |
String |
Specifies the value of the match item.
All values of the condition list in a fowwarding rule must be unique. Minimum: 1 Maximum: 128 |
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.See the reply and handling status in My Cloud VOC.
For any further questions, feel free to contact us through the chatbot.
Chatbot