Update the forwarding rule properties of the application load balancer - UpdateRuleAttribute
Overview
Update the attributes of a forwarding rule for the application type load balancer listener
Definition
Public Parameters
| Parameter Name | Type | Description Information | Required |
|---|---|---|---|
| Action | string | Corresponding API command name, the current API is UpdateRuleAttribute. | Yes |
| PublicKey | string | The user's public key can be obtained from Console (opens in a new tab) | Yes |
| Signature | string | User signature generated based on public key and API command, see Signature Algorithm | Yes |
Request Parameters
| Parameter Name | Type | Description Information | Required |
|---|---|---|---|
| Region | string | Region. See List of Regions and Availability Zones | Yes |
| ProjectId | string | Project ID. If not filled in, the default project is used, sub-accounts must be filled in. Please refer to the GetProjectList interface. | Yes |
| LoadBalancerId | string | ID of the Load Balancing Instance | Yes |
| ListenerId | string | Listener's ID | Yes |
| RuleId | string | ID of the forwarding rule | Yes |
| RuleConditions.N.Type | string | Matching condition type. Limited enumeration values: "Host"/"Path"; Must be filled in when the length of the RuleConditions array is not 0. | No |
| RuleConditions.N.HostConfig.MatchMode | string | Matching method. Limited enumeration values: 'Regular'/'Wildcard', default value: 'Regular'. | No |
| Values.N | string | Value. Currently only supports an array length of 1; the value must comply with the conditions of the relevant matching method; it is required when modifying the domain name match. | No |
| Values.N | string | Value. Temporarily only supports an array length of 1; the value must meet the relevant conditions; it is required when modifying the path match. | No |
| RuleActions.N.Type | string | Action Type. Limited enumeration value: "Forward"; Must be filled in when the length of the RuleActions array is not 0. | No |
| Targets.N.Id | string | The identifier ID of the backend service node being forwarded. It is limited to the service node pool of the listener; the array length can be 0; when the array length of the configured forwarding service node is not 0, the ID is required. | No |
| Targets.N.Weight | int | The weight of the backend service node being forwarded. Only valid when the load balancing algorithm of the listener is weighted round robin. | No |
| Pass | boolean | Whether the rule is ignored when the service node to be forwarded is empty. The default forwarding rule cannot be changed. | No |
Response Field
| Field Name | Type | Description Information | Required |
|---|---|---|---|
| RetCode | int | Return status code. If it is 0, it means successful return. If it is not 0, it means failure. | Yes |
| Action | string | Operation command name. | Yes |
| Message | string | Returns an error message, providing detailed description when RetCode is non-zero. | No |
Example
Request Example
https://api.surfercloud.com/?Action=UpdateRuleAttribute
&Region=cn-zj
&ProjectId=fMqGeCGY
&LoadBalancerId=PEmbuMhD
&ListenerId=eudxefBy
&RuleId=uOPZrous
&RuleConditions.n.Type=XPnIhJcD
&RuleConditions.n.HostConfig.MatchMode=pcWuiASR
&RuleConditions.n.HostConfig.Values.n=NbTJIuXo
&RuleConditions.n.PathConfig.Values.n=vXMMFKpU
&RuleActions.n.Type=sCUpJcAT
&RuleActions.n.ForwardConfig.Targets.n.Id=ejIILinH
&RuleActions.n.ForwardConfig.Targets.n.Weight=6
&Pass=trueResponse Example
{
"Action": "UpdateRuleAttributeResponse",
"RetCode": 0
}
