ListRules - Server Load Balancer - Alibaba Cloud Documentation Center

Queries the forwarding rules in a region.

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer.

Debug

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 Resources is 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:ListRules	Read	LoadBalancer acs:alb:{#regionId}:{#accountId}:loadbalancer/{#loadbalancerId}	none	none

Request parameters

Parameter	Type	Required	Description	Example
NextToken	string	No	The starting point of the current query. If you do not specify this parameter, the query starts from the beginning.	FFmyTO70tTpLG6I3FmYAXGKPd****
MaxResults	integer	No	The maximum number of entries to return. Valid values: 1 to 100. Default value: 20. If you do not specify this parameter, the default value is used. Note This parameter is optional.	20
RuleIds	array	No	The forwarding rules.
	string	No	The forwarding rule ID. You can specify up to 20 IDs in each request.	rule-sada
ListenerIds	array	No	The listener IDs.
	string	No	The listener ID. You can specify up to 20 IDs in each request.	lsn-i35udpz3pxsmnf****
LoadBalancerIds	array	No	The Application Load Balancer (ALB) instance IDs.
	string	No	The ALB instance ID. You can specify up to 20 IDs in each request.	alb-x30o38azsuj0sx****
Direction	string	No	The direction to which the forwarding rule is applied. Valid values: Request (default): The forwarding rule is applied to the client requests received by ALB. Response: The forwarding rule is applied to the responses returned by backend servers. Note You cannot set this parameter to Response if you use basic ALB instances.	Request

Response parameters

Parameter	Type	Description	Example
	object	The forwarding rules.
MaxResults	integer	The maximum number of entries returned.	50
NextToken	string	A pagination token. It can be used in the next request to retrieve a new page of results. Valid values: If NextToken is empty, no next page exists. If a value is returned for NextToken, the value is the token that determines the start point of the next query.	FFmyTO70tTpLG6I3FmYAXGKPd****
RequestId	string	The request ID.	CEF72CEB-54B6-4AE8-B225-F876FF7BA984
Rules	object []	The forwarding rules.
ListenerId	string	The ID of the listener to which the forwarding rule belongs.	lsn-i35udpz3pxsmnf****
LoadBalancerId	string	The ID of the ALB instance to which the forwarding rule belongs.	alb-x30o38azsuj0sx****
Priority	integer	The priority of the forwarding rule. Valid values: 1 to 10000. A smaller value indicates a higher priority. Note The priority of each forwarding rule added to a listener must be unique.	1
RuleActions	object []	The action of the forwarding rule.
FixedResponseConfig	object	The configuration of the custom response.
Content	string	The content of the custom response. The content is up to 1 KB in size, and can contain only ASCII characters.	dssacav
ContentType	string	The content type. Valid values: text/plain, text/css, text/html, application/javascript, and application/json.	text/plain
HttpCode	string	The HTTP status code in the response. Valid values: HTTP_2xx, HTTP_4xx, and HTTP_5xx. x must be a digit.	HTTP_2xx
ForwardGroupConfig	object	The configurations of the server groups.
ServerGroupTuples	object []	The server groups to which requests are forwarded.
ServerGroupId	string	The server group to which requests are forwarded.	sg-atstuj3rtoptyui****
Weight	integer	The weight. Valid values: 0 to 100.	2
InsertHeaderConfig	object	The configuration of the header to be inserted.
Key	string	The key of the header. The key must be 1 to 40 characters in length, and can contain letters, digits, underscores (_), and hyphens (-). The key specified in `InsertHeader` must be unique. Note Cookie and Host are not supported.	key
Value	string	The value of the header. If ValueType is set to SystemDefined, one of the following values is supported: ClientSrcPort: the client port. ClientSrcIp: the client IP address. Protocol: the request protocol (HTTP or HTTPS). SLBId: the ID of the ALB instance. SLBPort: the listener port. If ValueType is set to UserDefined, a custom header value is supported. The header value must be 1 to 128 characters in length, and can contain printable characters whose ASCII values are `greater than or equal to 32 and lower than 127`. You can use asterisks () and question marks (?) as wildcard characters. The header value cannot start or end with a space character. If ValueType* is set to ReferenceHeader, one of the request headers is referenced. The header value must be 1 to 128 characters in length, and can contain lowercase letters, digits, underscores (_), and hyphens (-).	ClientSrcPort
ValueType	string	The type of the header. Valid values: UserDefined: a user-defined header. ReferenceHeader: a header that is referenced from a request header. SystemDefined: a system-defined header.	SystemDefined
Order	integer	The priority of the action. Valid values: 1 to 50000. A smaller value indicates a higher priority. The actions of a forwarding rule are applied in descending order of priority. This parameter is not empty. The priority of each action within a forwarding rule is unique.	1
RedirectConfig	object	The configuration of the redirect action.
Host	string	The hostname to which requests are redirected. Valid values: ${host} (default): If ${host} is returned, no other character is appended. Limits on a custom value: The hostname is 3 to 128 characters in length, and can contain lowercase letters, digits, hyphens (-), and periods (.). Asterisks () and question marks (?) can be used as wildcard characters. The hostname contains at least one period (.) but does not start or end with a period (.). The rightmost domain label contains only letters and wildcard characters. It does not contain digits or hyphens (-). The domain labels do not start or end with hyphens (-). You can use asterisks () and question marks (?) anywhere in a domain label as wildcard characters.	www.example.com
HttpCode	string	The redirect type. Valid values: 301, 302, 303, 307, and 308.	301
Path	string	The path to which requests are redirected. Valid values: ${path} (default): You can reference ${host}, ${protocol}, and${port}. The path can consist of ${host},${protocol}, and ${port}. Each variable can be used only once. The preceding variables can be used at the same time or combined with a custom value. Limits on a custom value: The value is 1 to 128 characters in length. It starts with a forward slash (/) and contains letters, digits, and the following special characters: `$ - _ .+ / & ~ @ :`. It does not contain the following special characters: `" % # ; ! ( ) [ ] ^ , "`. You can use asterisks (*) and question marks (?) as wildcard characters.	/test
Port	string	The port to which requests are redirected. Valid values: ${port} (default): If ${port} is returned, no other character is appended. Other valid values: 1 to 63335.	10
Protocol	string	The redirect protocol. Valid values: ${protocol} (default): If ${protocol} is returned, no other character is appended. HTTP or HTTPS. Note HTTPS listeners support only HTTP to HTTPS redirection.	HTTP
Query	string	The query string to which requests are redirected. The query string must be 1 to 128 characters in length, and can contain printable characters, excluding uppercase letters and the following special characters: `# [ ] { } \ \| < > &`.	quert
RemoveHeaderConfig	object	The configuration of the header to be removed.
Key	string	The key of the header to be removed. The key must be 1 to 40 characters in length and can contain letters, digits, underscores, and hyphens (-). The header key must be unique. You cannot specify the following header keys for an inbound forwarding rule: `slb-id`, `slb-ip`, `x-forwarded-for`, `x-forwarded-proto`, `x-forwarded-eip`, `x-forwarded-port`, `x-forwarded-client-srcport`, `connection`, `upgrade`, `content-length`, `transfer-encoding`, `keep-alive`, `te`, `host`, `cookie`, `remoteip`, and `authority`. The preceding keys are case-insensitive. You cannot specify the following header keys for an outbound forwarding rule: `connection`, `upgrade`, `content-length`, and `transfer-encoding`. The preceding keys are case-insensitive.
RewriteConfig	object	The configuration of the rewrite action.
Host	string	The hostname to which requests are forwarded. Valid values: ${host} (default): If ${host} is returned, no other character is appended. Limits on a custom value: The hostname is 3 to 128 characters in length, and can contain lowercase letters, digits, hyphens (-), and periods (.). Asterisks () and question marks (?) can be used as wildcard characters. The hostname contains at least one period (.) but does not start or end with a period (.). The rightmost domain label contains only letters and wildcard characters. It does not contain digits or hyphens (-). The domain labels do not start or end with hyphens (-). You can use asterisks () and question marks (?) anywhere in a domain label as wildcard characters.	www.example.com
Path	string	The path to which requests are forwarded. The path is 1 to 128 characters in length and starts with a forward slash (/). The path can contain letters, digits, asterisks (*), question marks (?), and the following special characters: `$ - _ . + / & ~ @ :`. The path does not contain the following special characters: `" % # ; ! ( ) [ ] ^ , "`.	/tsdf
Query	string	The query string of the URL to which requests are forwarded. The query string is 1 to 128 characters in length, and can contain printable characters, excluding uppercase letters and the following special characters: `# [ ] { } \ \| < > &`.	quedsa
TrafficMirrorConfig	object	The configuration of the action to mirror traffic.
MirrorGroupConfig	object	The configuration of the server group to which traffic is mirrored.
ServerGroupTuples	object []	The server group to which traffic is mirrored.
ServerGroupId	string	The server group ID.	srg-00mkgijak0w4qgz9****
Weight	integer	The weight. Valid values: 0 to 100.	2
TrafficLimitConfig	object	The configuration of the action to throttle traffic.
QPS	integer	The number of queries per second (QPS). Valid values: 1 to 100000.	4
PerIpQps	integer	The QPS of each IP address. Valid values: 1 to 100000. Note If you specify this parameter and QPS, the value of PerIpQps must be smaller than the value of QPS.	80
Type	string	The action. Valid values: ForwardGroup: distributes requests to multiple vServer groups. Redirect: redirects a request. FixedResponse: returns a custom response. Rewrite: rewrites a request. InsertHeader: inserts a header. RemoveHeaderConfig: deletes a header. TrafficLimitConfig: throttles network traffic. TrafficMirrorConfig: mirrors traffic. CorsConfig: forwards requests based on CORS. The preceding actions can be classified into two broad types: FinalType: the last action to be performed in a forwarding rule. Each forwarding rule can contain only one FinalType action. You can specify a ForwardGroup, Redirect, or FixedResponse action as the FinalType action. ExtType: one or more actions to be performed before the FinalType action. A forwarding rule can contain one or more ExtType actions. To specify an ExtType action, you must specify a FinalType action. You can specify multiple InsertHeader actions or one Rewrite action.	ForwardGroup
CorsConfig	object	The CORS configuration.
AllowOrigin	array	The allowed origins of CORS requests.
	string	The allowed origin of CORS requests. You can specify an asterisk (``) or one or more values. A value cannot be ``. Each value must start with `http://` or `https://`, followed by a valid domain name or a first-level wildcard domain name, such as `.test.abc.example.com`. You can specify a port in a value. Port range: 1 to 65535*.	http://test.com
AllowMethods	array	The allowed HTTP methods for CORS requests.
	string	The allowed HTTP method for CORS requests. Valid values: GET POST PUT DELETE HEAD OPTIONS PATCH	GET
AllowHeaders	array	The allowed headers for CORS requests.
	string	The allowed header for CORS requests. You can specify an asterisk (`*`) or one or more values. Separate multiple values with commas (,). A value can contain only letters and digits. It cannot start or end with underscores (_) or hyphens (-). It can be up to 32 characters in length.	test_123
ExposeHeaders	array	The headers that can be exposed.
	string	The header that can be exposed. You can specify an asterisk (`*`) or one or more values. Separate multiple values with commas (,). A value can contain only letters and digits. It cannot start or end with underscores (_) or hyphens (-). It can be up to 32 characters in length.	test_123
AllowCredentials	string	Indicates whether credentials can be carried in CORS requests. Valid values: on off	on
MaxAge	long	The maximum cache time of dry run requests in the browser. Unit: seconds. Valid values: -1 to 172800.	1000
RuleConditions	object []	The conditions of the forwarding rule.
CookieConfig	object	The configuration of the cookie.
Values	object []	The key-value pair of the cookie.
Key	string	The key of the cookie. The key is 1 to 100 characters in length, and can contain printable characters such as lowercase letters, asterisks (*), and question marks (?). The key cannot contain uppercase letters, space characters, or the following special characters: `# [ ] { } \ \| < > &`.	test
Value	string	The value of the cookie. The value is 1 to 128 characters in length, and can contain printable characters such as lowercase letters, asterisks (*), and question marks (?). Uppercase letters, space characters, and the following special characters are not supported: `# [ ] { } \ \| < > &`.	test
HeaderConfig	object	The configuration of the header.
Key	string	The key of the header. The key must be 1 to 40 characters in length, and can contain lowercase letters, digits, hyphens (-), and underscores (_). Cookie and Host are not supported.	Port
Values	array	The values of the header.
	string	The value of the header. The value must be 1 to 128 characters in length, and can contain printable characters whose ASCII values are `greater than or equal to 32 and smaller than 127`, including lowercase letters, asterisks (*), and question marks (?). The value cannot start or end with a space character.	5006
HostConfig	object	The configurations of the hosts.
Values	array	The hostnames.
	string	The hostname. Limits on the value: The hostname is 3 to 128 characters in length, and can contain lowercase letters, digits, hyphens (-), periods (.), asterisks (), and question marks (?). The hostname contains at least one period (.) but does not start or end with a period (.). The rightmost domain label can contain only letters, asterisks (), and question marks (?), and does not contain digits or hyphens (-). The domain labels cannot start or end with a hyphen (-). You can specify asterisks (∗) and question marks (?) anywhere in a domain label.	www.example.com
MethodConfig	object	The configurations of the request methods.
Values	array	The request methods.
	string	The request method. Valid values: HEAD, GET, POST, OPTIONS, PUT, PATCH, and DELETE.	PUT
PathConfig	object	The configurations of the paths.
Values	array	The paths.
	string	The path. The path is 1 to 128 characters in length and starts with a forward slash (/). The path can contain letters, digits, asterisks (*), question marks (?), and the following special characters: `$ - _ . + / & ~ @ :`. The path does not contain the following special characters: `" % # ; ! ( ) [ ] ^ , "`.	/test
QueryStringConfig	object	The configurations of the query strings.
Values	object []	The query string.
Key	string	They key of the query string. The key must be 1 to 100 characters in length, and can contain printable characters such as lowercase letters, asterisks (*), and question marks (?). The key cannot contain uppercase letters, space characters, or the following special characters: `# [ ] { } \ \| < > &`.	test
Value	string	The value of the query string. The value must be 1 to 128 characters in length, and can contain printable characters such as lowercase letters, asterisks (*), and question marks (?). However, uppercase letters, space characters, and the following special characters are not supported: `# [ ] { } \ \| < > &`.	test
SourceIpConfig	object	The configuration of the source IP addresses based on which user traffic is matched.
Values	array	The source IP addresses.
	string	The IP address or CIDR block based on which user traffic is matched. You can specify multiple IP addresses or CIDR blocks. You can specify up to five source IP addresses in a forwarding rule.	192.168.XX.XX/32
ResponseStatusCodeConfig	object	The configurations of the response status codes.
Values	array	The response status codes.
	string	The response status code.
ResponseHeaderConfig	object	The configuration of the HTTP response header.
Key	string	The header key. The key must be 1 to 40 characters in length, and can contain lowercase letters, digits, hyphens (-), and underscores (_). Cookie and Host are not supported.
Values	array	The header values.
	string	The header value. The value must be 1 to 128 characters in length,
Type	string	The type of forwarding rule. Valid values: Host: Requests are forwarded based on hosts. Path: Requests are forwarded based on paths. Header: Requests are forwarded based on HTTP headers. QueryString: Requests are forwarded based on query strings. Method: Requests are forwarded based on request methods. Cookie: Requests are forwarded based on cookies. SourceIp: Requests are distributed based on source IP addresses.	Host
RuleId	string	The forwarding rule ID.	rule-bpn0kn908w4nbw****
RuleName	string	The name of the forwarding rule. The name must be 2 to 128 characters in length, and can contain letters, digits, periods (.), underscores (_), and hyphens (-). The name must start with a letter.	rule-instance-test
RuleStatus	string	The status of the forwarding rule. Valid values: Provisioning Configuring Available	Available
Direction	string	The direction to which the forwarding rule is applied. Valid values: Request (default): The rule applies to client requests. Response: The rule applies to responses from backend servers. Note Response is not supported by basic ALB instances.
TotalCount	integer	The total number of entries returned.	1000

Examples

Sample success responses

JSONformat

{
  "MaxResults": 50,
  "NextToken": "FFmyTO70tTpLG6I3FmYAXGKPd****",
  "RequestId": "CEF72CEB-54B6-4AE8-B225-F876FF7BA984",
  "Rules": [
    {
      "ListenerId": "lsn-i35udpz3pxsmnf****",
      "LoadBalancerId": "alb-x30o38azsuj0sx****",
      "Priority": 1,
      "RuleActions": [
        {
          "FixedResponseConfig": {
            "Content": "dssacav",
            "ContentType": "text/plain",
            "HttpCode": "HTTP_2xx"
          },
          "ForwardGroupConfig": {
            "ServerGroupTuples": [
              {
                "ServerGroupId": "sg-atstuj3rtoptyui****",
                "Weight": 2
              }
            ]
          },
          "InsertHeaderConfig": {
            "Key": "key",
            "Value": "ClientSrcPort",
            "ValueType": "SystemDefined"
          },
          "Order": 1,
          "RedirectConfig": {
            "Host": "www.example.com",
            "HttpCode": "301",
            "Path": "/test",
            "Port": "10",
            "Protocol": "HTTP",
            "Query": "quert"
          },
          "RemoveHeaderConfig": {
            "Key": ""
          },
          "RewriteConfig": {
            "Host": "www.example.com",
            "Path": "/tsdf",
            "Query": "quedsa"
          },
          "TrafficMirrorConfig": {
            "MirrorGroupConfig": {
              "ServerGroupTuples": [
                {
                  "ServerGroupId": "srg-00mkgijak0w4qgz9****",
                  "Weight": 2
                }
              ]
            }
          },
          "TrafficLimitConfig": {
            "QPS": 4,
            "PerIpQps": 80
          },
          "Type": "ForwardGroup",
          "CorsConfig": {
            "AllowOrigin": [
              "http://test.com"
            ],
            "AllowMethods": [
              "GET"
            ],
            "AllowHeaders": [
              "test_123"
            ],
            "ExposeHeaders": [
              "test_123"
            ],
            "AllowCredentials": "on",
            "MaxAge": 1000
          }
        }
      ],
      "RuleConditions": [
        {
          "CookieConfig": {
            "Values": [
              {
                "Key": "test",
                "Value": "test"
              }
            ]
          },
          "HeaderConfig": {
            "Key": "Port",
            "Values": [
              "5006"
            ]
          },
          "HostConfig": {
            "Values": [
              "www.example.com"
            ]
          },
          "MethodConfig": {
            "Values": [
              "PUT"
            ]
          },
          "PathConfig": {
            "Values": [
              "/test"
            ]
          },
          "QueryStringConfig": {
            "Values": [
              {
                "Key": "test",
                "Value": "test"
              }
            ]
          },
          "SourceIpConfig": {
            "Values": [
              "192.168.XX.XX/32"
            ]
          },
          "ResponseStatusCodeConfig": {
            "Values": [
              ""
            ]
          },
          "ResponseHeaderConfig": {
            "Key": "",
            "Values": [
              ""
            ]
          },
          "Type": "Host"
        }
      ],
      "RuleId": "rule-bpn0kn908w4nbw****",
      "RuleName": "rule-instance-test",
      "RuleStatus": "Available",
      "Direction": ""
    }
  ],
  "TotalCount": 1000
}

Error codes

For a list of error codes, visit the Service error codes.

Change history

Change time

Summary of changes

Operation

2024-01-29

The Error code has changed

see changesets

Change item	Change content
Error Codes	The Error code has changed.
	Added Error Codes: 403

2024-01-23

The internal configuration of the API is changed, but the call is not affected

see changesets

Change item	Change content
	The internal configuration of the API is changed, but the call is not affected.

2023-06-01

The response structure of the API has changed

see changesets

Change item	Change content
Output Parameters	The response structure of the API has changed.

2023-06-01

The response structure of the API has changed

see changesets

Change item	Change content
Output Parameters	The response structure of the API has changed.