Modifies the attributes of forwarding rules.
Operation description
UpdateRulesAttribute is an asynchronous operation. After a request is sent, the system returns a request ID and runs the task in the background. You can call the ListRules operation to query the status of the task.
-
If a forwarding rule is in the Configuring state, the forwarding rule is being updated.
-
If a forwarding rule is in the Available state, the forwarding rule is updated.
-
You can set RuleConditions and RuleActions to add conditions and actions to a forwarding rule. Take note of the following limits on the maximum number of conditions and the maximum number of actions in each forwarding rule:
- Limits on conditions: 5 for a basic Application Load Balancer (ALB) instance, 10 for a standard ALB instance, and 10 for a WAF-enabled ALB instance.
- Limits on actions: 3 for a basic ALB instance, 5 for a standard ALB instance, and 5 for a WAF-enabled ALB instance.
Debugging
Authorization information
The following table shows the authorization information corresponding to the API. The authorization information can be used in the Action policy element to grant a RAM user or RAM role the permissions to call this API operation. Description:
- Operation: the value that you can use in the Action element to specify the operation on a resource.
- Access level: the access level of each operation. The levels are read, write, and list.
- Resource type: the type of the resource on which you can authorize the RAM user or the RAM role to perform the operation. Take note of the following items:
- The required resource types are displayed in bold characters.
- If the permissions cannot be granted at the resource level,
All Resourcesis used in the Resource type column of the operation.
- Condition Key: the condition key that is defined by the cloud service.
- Associated operation: other operations that the RAM user or the RAM role must have permissions to perform to complete the operation. To complete the operation, the RAM user or the RAM role must have the permissions to perform the associated operations.
| Operation | Access level | Resource type | Condition key | Associated operation |
|---|---|---|---|---|
| alb:UpdateRulesAttribute | update | *LoadBalancer acs:alb:{#regionId}:{#accountId}:loadbalancer/{#LoadBalancerId} |
| none |
Request parameters
| Parameter | Type | Required | Description | Example |
|---|---|---|---|---|
| ClientToken | string | No | The client token that is used to ensure the idempotence of the request. You can use the client to generate the token, but you must make sure that the token is unique among different requests. The client token can contain only ASCII characters. Note
If you do not specify this parameter, the system automatically uses the request ID as the client token. The request ID may be different for each request.
| 123e4567-e89b-12d3-a456-426655440000 |
| Rules | array<object> | Yes | The forwarding rules. | |
| object | Yes | |||
| Priority | integer | No | The priority of the forwarding rule. | 10 |
| RuleName | string | No | The name of the forwarding rule. | rule-instance-test |
| RuleActions | array<object> | No | The action of the forwarding rule. | |
| object | Yes | |||
| FixedResponseConfig | object | No | The configuration of the action to return a custom response. | |
| Content | string | No | The content of the response. | dssacav |
| ContentType | string | No | The content format of the response. | text/plain |
| HttpCode | string | No | The HTTP status code in responses. | 200 |
| ForwardGroupConfig | object | No | The configuration of the action to forward requests to server groups. | |
| ServerGroupTuples | array<object> | No | The server groups to which requests are forwarded. | |
| object | No | |||
| ServerGroupId | string | No | The server group to which requests are forwarded. | sg-atstuj3rtoptyui**** |
| Weight | integer | No | The weight of the server group. | 30 |
| ServerGroupStickySession | object | No | The configuration of session persistence for server groups. | |
| Enabled | boolean | No | Specifies whether to enable session persistence. | false |
| Timeout | integer | No | The timeout period of sessions. | 2 |
| InsertHeaderConfig | object | No | The configuration of the action to insert a header. | |
| CoverEnabled | boolean | No | Specifies whether to overwrite the header in the request. | false |
| Key | string | No | The key of the header. | test |
| Value | string | No | The value of the header. | UserDefined |
| ValueType | string | No | The type of header. | UserDefined |
| Order | integer | Yes | The priority of the action. | 1 |
| RedirectConfig | object | No | The configuration of the redirect action. | |
| Host | string | No | The hostname to which requests are redirected. | www.example.com |
| HttpCode | string | No | The HTTP status code that indicates the redirect type. | 301 |
| Path | string | No | The path of the destination to which requests are forwarded. | /test |
| Port | string | No | The port to which requests are forwarded. | 10 |
| Protocol | string | No | The protocol of the destination to which requests are forwarded. | HTTP |
| Query | string | No | The query string to which requests are redirected. | quert |
| RewriteConfig | object | No | The configuration of the rewrite action. | |
| Host | string | No | The hostname of the destination to which requests are forwarded. | www.example.com |
| Path | string | No | The path to which requests are forwarded. | /tsdf |
| Query | string | No | The query string of the URL to which requests are forwarded. | quedsa |
| Type | string | Yes | The type of action. | Host |
| TrafficLimitConfig | object | No | The configuration of traffic throttling. | |
| QPS | integer | No | The number of queries per second (QPS). Valid values: 1 to 1000000. | 2 |
| PerIpQps | integer | No | The number of requests per IP address. Valid values: 1 to 1000000. Note
If both the QPS and PerIpQps properties are specified, make sure that the value of the QPS property is smaller than the value of the PerIpQps property.
| 80 |
| TrafficMirrorConfig | object | No | The configuration of traffic mirroring. | |
| TargetType | string | No | The type of target to which network traffic is mirrored. | ForwardGroupMirror |
| MirrorGroupConfig | object | No | The configuration of the server group to which traffic is mirrored. | |
| ServerGroupTuples | array<object> | No | The server group to which traffic is mirrored. | |
| object | No | The server group to which traffic is mirrored. | ||
| ServerGroupId | string | No | The server group ID. | srg-00mkgijak0w4qgz9**** |
| RemoveHeaderConfig | object | No | The configuration of the HTTP header to be removed. | |
| Key | string | No | The key of the response header. | Port |
| CorsConfig | object | No | The CORS configuration. | |
| AllowOrigin | array | No | The trusted origins. | |
| string | No | http://example.com | ||
| AllowMethods | array | No | The trusted HTTP methods of CORS requests. | |
| string | No | GET | ||
| AllowHeaders | array | No | The trusted headers of CORS requests. | |
| string | No | test_123 | ||
| ExposeHeaders | array | No | The headers that can be exposed. | |
| string | No | test_123 | ||
| AllowCredentials | string | No | Specifies whether to allow credentials to be carried in CORS requests. | on |
| MaxAge | long | No | The maximum cache time of dry runs in the browser. | 1000 |
| RuleConditions | array<object> | No | The match conditions of the forwarding rule. | |
| object | Yes | |||
| CookieConfig | object | No | The configuration of the cookie. | |
| Values | array<object> | No | The key-value pairs of cookies. | |
| object | No | |||
| Key | string | No | The cookie key. | test |
| Value | string | No | The cookie value. | test |
| HeaderConfig | object | No | The configuration of the HTTP header. | |
| Key | string | No | The key of the header. | Port |
| Values | array | No | The HTTP header values. | |
| string | No | 5006 | ||
| HostConfig | object | No | The match conditions for hostnames. | |
| Values | array | No | The hostnames. | |
| string | No | www.example.com | ||
| MethodConfig | object | No | The configuration of the HTTP request method. | |
| Values | array | No | The HTTP request methods. | |
| string | No | PUT | ||
| PathConfig | object | No | The match conditions for query strings. | |
| Values | array | No | The paths to which requests are forwarded. | |
| string | No | /test | ||
| QueryStringConfig | object | No | The match conditions for query strings. | |
| Values | array<object> | No | The key-value pairs of query strings. | |
| object | No | |||
| Key | string | No | The key of the query string. | test |
| Value | string | No | The value of the query string. | test |
| ResponseHeaderConfig | object | No | The HTTP response headers. | |
| Key | string | No | The key of the response header. | test |
| Values | array | No | The value of the response header. | |
| string | No | 5006 | ||
| ResponseStatusCodeConfig | object | No | The match conditions for response status codes. | |
| Values | array | No | The match conditions. | |
| string | No | 301 | ||
| Type | string | No | The condition type of the forwarding rule. | ForwardGroup |
| SourceIpConfig | object | No | Traffic matching based on source IP addresses. | |
| Values | array | No | Traffic matching based on source IP addresses. | |
| string | No | You can specify one or more IP addresses, including CIDR blocks. Each forwarding rule supports at most five source IP addresses, including CIDR blocks. | 192.168.0.1/32 | |
| RuleId | string | Yes | The IDs of the forwarding rules. | rule-cxjh7vazn2jpnl**** |
| DryRun | boolean | No | Specifies whether to perform only a dry run, without performing the actual request. Valid values:
| false |
Response parameters
Examples
Sample success responses
JSONformat
{
"RequestId": "365F4154-92F6-4AE4-92F8-7FF34B540710",
"JobId": "72dcd26b-f12d-4c27-b3af-18f6aed5****"
}Error codes
| HTTP status code | Error code | Error message | Description |
|---|---|---|---|
| 400 | OperationDenied.IpGroupCanNotUsedForMirrorAction | The operation is not allowed because of %s. | The operation is not allowed because of %s. |
| 400 | IncorrectStatus.Rule | The status of %s [%s] is incorrect. | - |
| 400 | OperationDenied.SameGroupForForwardAndMirrorAction | The operation is not allowed because of %s. | The operation is not allowed because of %s. |
| 400 | OperationDenied.GRPCServerGroup | The operation is not allowed because of %s. | - |
| 400 | Conflict.Priority | There is already %s having the same configuration with %s. | - |
| 400 | ResourceQuotaExceeded.ServerGroupAttachedNum | The quota of %s is exceeded for resource %s, usage %s/%s. | - |
| 400 | ResourceQuotaExceeded.LoadBalancerServersNum | The quota of %s is exceeded for resource %s, usage %s/%s. | - |
| 400 | ResourceQuotaExceeded.ServerAddedNum | The quota of %s is exceeded for resource %s, usage %s/%s. | - |
| 400 | QuotaExceeded.RuleWildcardsNum | The quota of %s is exceeded, usage %s/%s. | The quota of %s is exceeded, usage %s/%s. |
| 400 | QuotaExceeded.RuleMatchEvaluationsNum | The quota of %s is exceeded, usage %s/%s. | - |
| 400 | QuotaExceeded.RuleActionsNum | The quota of %s is exceeded, usage %s/%s. | The quota of %s is exceeded. Usage: %s/%s. |
| 400 | Mismatch.Protocol | The %s is mismatched for %s and %s. | The %s is mismatched for %s and %s. |
| 400 | Mismatch.VpcId | The %s is mismatched for %s and %s. | The %s is mismatched for %s and %s. |
| 400 | OperationDenied.ServiceManagedResource | The operation is not allowed because the current resource of %s is managed resource. | - |
| 400 | OperationDenied.ListenerIdInconsistent | The operation is not allowed because of ListenerIdInconsistent. | - |
| 400 | IllegalParam.Priority | The param of Priority is illegal. | - |
| 400 | OperationDenied.MirrorActionSupportHttpGroupOnly | The operation is not allowed because of MirrorActionSupportHttpGroupOnly. | - |
| 400 | OperationDenied.ProtocolMustSameForForwardGroupAction | The operation is not allowed because of ProtocolMustSameForForwardGroupAction. | - |
| 404 | ResourceNotFound.Rule | The specified resource %s is not found. | The specified resource %s is not found. |
| 404 | ResourceNotFound.ServerGroup | The specified resource %s is not found. | - |
For a list of error codes, visit the Service error codes.
Change history
| Change time | Summary of changes | Operation |
|---|---|---|
| 2024-12-11 | The Error code has changed | View Change Details |
| 2024-11-28 | The Error code has changed | View Change Details |
| 2024-01-18 | The Error code has changed | View Change Details |