Viewing the Details of a Forwarding Rule
Function
This API is used to view the details of a forwarding rule.
Calling Method
For details, see Calling APIs.
URI
GET /v3/{project_id}/elb/l7policies/{l7policy_id}/rules/{l7rule_id}
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. |
l7rule_id |
Yes |
String |
Specifies the forwarding rule. |
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 (-). |
rule |
L7Rule object |
Definition: Specifies the forwarding rule. |
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 the details of a given forwarding rule
GET https://{ELB_Endpoint}/v3/{99a3fff0d03c428eac3678da6a7d0f24}/elb/l7policies/cf4360fd-8631-41ff-a6f5-b72c35da74be/rules/84f4fcae-9c15-4e19-a99f-72c0b08fd3d7
Example Responses
Status code: 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" }, "request_id" : "0d799435-259e-459f-b2bc-0beee06f6a77" }
Status Codes
Status Code |
Description |
---|---|
200 |
OK |
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.