Adding a Forwarding Rule¶
Function¶
This API is used to add a forwarding rule.
URI¶
POST /v3/{project_id}/elb/l7policies/{l7policy_id}/rules
Parameter | Mandatory | Type | Description |
---|---|---|---|
l7policy_id | Yes | String | Specifies the forwarding policy ID. |
project_id | Yes | String | Specifies the project ID. |
Request Parameters¶
Parameter | Mandatory | Type | Description |
---|---|---|---|
X-Auth-Token | Yes | String | Specifies the token used for IAM authentication. |
Parameter | Mandatory | Type | Description |
---|---|---|---|
rule | Yes | CreateL7RuleOption object | Specifies the forwarding rule. |
Parameter | Mandatory | Type | Description |
---|---|---|---|
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. Default: true |
compare_type | Yes | String | Specifies how requests are matched and forwarded.
|
key | No | String | Specifies the key of the match item. For example, if an HTTP header is used for matching, key is the name of the HTTP header parameter. This parameter is unsupported. Please do not use it. Minimum: 1 Maximum: 255 |
value | Yes | String | Specifies the value of the match item. For example, if a domain name is used for matching, value is the domain name.
Minimum: 1 Maximum: 128 |
project_id | No | String | Specifies the project ID. |
type | Yes | String | Specifies the match content. The value can be one of the following:
If type is set to HOST_NAME, PATH, METHOD, or SOURCE_IP, only one forwarding rule can be created for each type. |
invert | No | Boolean | Specifies whether reverse matching is supported. The value can be true or false, and the default value is false. This parameter is unsupported. Please do not use it. Default: false |
conditions | No | Array of CreateRuleCondition objects | Specifies the matching conditions of the forwarding rule. This parameter will take effect when enhance_l7policy_enable is set to true. If conditions is specified, key and value will not take effect, and the value of this parameter will contain all conditions configured for the forwarding rule. The keys in the list must be the same, whereas each value must be unique. This parameter is unsupported. Please do not use it. |
Parameter | Mandatory | Type | Description |
---|---|---|---|
key | No | String | Specifies the key of match item. This parameter is left blank. Minimum: 1 Maximum: 128 |
value | Yes | String | Specifies the value of the match item.
|
Response Parameters¶
Status code: 201
Parameter | Type | Description |
---|---|---|
request_id | String | Specifies the request ID. The value is automatically generated. |
rule | L7Rule object | Specifies the forwarding rule. |
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 when type is set to HOST_NAME or PATH. It can be updated but will not take effect. This parameter is unsupported. Please do not use it. Minimum: 1 Maximum: 255 |
project_id | String | Specifies the project ID. |
type | String | Specifies the match content. The value can be one of the following:
If type is set to HOST_NAME, PATH, METHOD, or SOURCE_IP, only one forwarding rule 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.
Minimum: 1 Maximum: 128 |
provisioning_status | String | Specifies the provisioning status of the forwarding rule. |
invert | Boolean | Specifies whether reverse matching is supported. The value is fixed at false. This parameter can be updated but remains invalid. Default: false |
id | String | Specifies the forwarding policy ID. |
conditions | Array of RuleCondition objects | Specifies the matching conditions of the forwarding rule.
This parameter is unsupported. Please do not use it. |
Parameter | Type | Description |
---|---|---|
key | String | Specifies the key of match item. This parameter is left blank. Minimum: 1 Maximum: 128 |
value | String | Specifies the value of the match item.
Minimum: 1 Maximum: 128 |
Example Requests¶
POST
https://{elb_endpoint}/v3/99a3fff0d03c428eac3678da6a7d0f24/elb/l7policies/cf4360fd-8631-41ff-a6f5-b72c35da74be/rules
{
"rule" : {
"compare_type" : "EQUAL_TO",
"type" : "PATH",
"value" : "/bbb.html"
}
}
Example Responses¶
Status code: 201
Successful request.
{
"rule" : {
"compare_type" : "EQUAL_TO",
"provisioning_status" : "ACTIVE",
"project_id" : "99a3fff0d03c428eac3678da6a7d0f24",
"invert" : false,
"admin_state_up" : true,
"value" : "/bbb.html",
"key" : null,
"type" : "PATH",
"id" : "84f4fcae-9c15-4e19-a99f-72c0b08fd3d7"
},
"request_id" : "3639f1b7-f04b-496e-9218-ec5a9e493f69"
}
Status Codes¶
Status Code | Description |
---|---|
201 | Successful request. |
Error Codes¶
See Error Codes.