ListRules - 查詢轉寄規則 - Server Load Balancer

查詢指定地區的轉寄規則。

調試

您可以在OpenAPI Explorer中直接運行該介面，免去您計算簽名的困擾。運行成功後，OpenAPI Explorer可以自動產生SDK程式碼範例。

調試

授權資訊

下表是API對應的授權資訊，可以在RAM權限原則語句的Action元素中使用，用來給RAM使用者或RAM角色授予調用此API的許可權。具體說明如下：

操作：是指具體的許可權點。
存取層級：是指每個操作的存取層級，取值為寫入（Write）、讀取（Read）或列出（List）。
資源類型：是指操作中支援授權的資源類型。具體說明如下：
- 對於必選的資源類型，用前面加 * 表示。
- 對於不支援資源級授權的操作，用全部資源表示。
條件關鍵字：是指雲產品自身定義的條件關鍵字。
關聯操作：是指成功執行操作所需要的其他許可權。操作者必須同時具備關聯操作的許可權，操作才能成功。

操作

存取層級

資源類型

條件關鍵字

關聯操作

alb:ListRules

get

*LoadBalancer

acs:alb:{#regionId}:{#accountId}:loadbalancer/{#loadbalancerId}

無

請求參數

名稱	類型	必填	描述	樣本值
NextToken	string	否	是否擁有下一次查詢的令牌（Token）。取值：第一次查詢和沒有下一次查詢時，均無需填寫。如果有下一次查詢，取值為上一次 API 呼叫返回的 NextToken 值。	FFmyTO70tTpLG6I3FmYAXGKPd****
MaxResults	integer	否	本次讀取的最巨量資料記錄數。取值：1~100。預設值：20，表示使用者沒有傳入資料。說明此參數為可選。	20
RuleIds	array	否	轉寄規則列表，一次最多支援查詢 20 個轉寄規則。
	string	否	轉寄規則 ID。	rule-sada******
ListenerIds	array	否	監聽 ID 列表。一次最多支援查詢 20 個監聽。
	string	否	監聽 ID。	lsn-i35udpz3pxsmnf****
LoadBalancerIds	array	否	Server Load Balancer執行個體 ID 列表。一次最多支援查詢 20 個執行個體。
	string	否	Server Load Balancer執行個體 ID。	alb-x30o38azsuj0sx****
Direction	string	否	轉寄規則的方向。取值： Request（預設值）：請求類型，對從用戶端發送到 ALB 的報文進行條件匹配並進行相應的處理。 Response：響應類型，對從後端伺服器組返回到 ALB 的報文進行條件匹配並進行相應的處理。說明基礎版的 ALB 執行個體不支援 Response 類型.	Request
Tag	array<object>	否	標籤。
	object	否	標籤結構。
Key	string	否	標籤鍵。最多支援 128 個字元，不能以 aliyun 或 acs:開頭，不能包含 http://或 https://。	env
Value	string	否	標籤值。最多支援 128 個字元，不能以 aliyun 或 acs:開頭，不能包含 http://或 https://。	product

返回參數

名稱	類型	描述	樣本值
	object	轉寄規則。
MaxResults	integer	本次請求所返回的最大記錄條數。	50
NextToken	string	是否擁有下一次查詢的令牌（Token）。取值：如果 NextToken 為空白表示沒有下一次查詢。如果 NextToken 有傳回值，該取值表示下一次查詢開始的令牌。	FFmyTO70tTpLG6I3FmYAXGKPd****
RequestId	string	請求 ID。	CEF72CEB-54B6-4AE8-B225-F876F******
Rules	array<object>	轉寄規則列表。
	object	轉寄規則結構。
ListenerId	string	轉寄規則所屬監聽 ID。	lsn-i35udpz3pxsmnf****
LoadBalancerId	string	轉寄規則所屬Server Load Balancer執行個體 ID。	alb-x30o38azsuj0sx****
Priority	integer	規則優先順序，取值為1~10000。值越小表示優先順序越高。說明同一個監聽內規則優先順序必須唯一。	1
RuleActions	array<object>	轉寄規則動作列表。
	object	轉寄規則動作結構。
FixedResponseConfig	object	固定響應內容配置。
Content	string	返回的固定內容。最大 1 KB 位元組，只支援 ASCII 字元。	dssacav
ContentType	string	返回固定內容的格式。取值：text/plain、text/css、text/html、application/javascript或application/json。	text/plain
HttpCode	string	返回的 HTTP 響應碼，僅支援HTTP_2xx、HTTP_4xx、HTTP_5xx數字型字串，x 為任一數字。	HTTP_2xx
ForwardGroupConfig	object	轉寄組配置。
ServerGroupTuples	array<object>	轉寄到的目的伺服器組列表。
	object	轉寄到的目的伺服器組列表。
ServerGroupId	string	轉寄到的目的伺服器組 ID。	sgp-atstuj3rtoptyui****
Weight	integer	權重。取值範圍：0~100。	2
ServerGroupStickySession	object	伺服器組間會話保持配置
Enabled	boolean	當 ServerGroupTuple.N 數量大於 1 時，可選是否開啟在伺服器組間的會話保持
Timeout	integer	當 Enabled=True 時，可以配置會話保持的逾時時間	100
InsertHeaderConfig	object	寫入頭欄位配置。
Key	string	插入的頭欄位名稱，長度為 1~40 個字元，支援大小寫字母 a~z、數字、底線（_）和短劃線（-）。頭欄位名稱不能重複用於`InsertHeader`中。說明不允許使用者在頭欄位名稱中使用 Cookie 和 Host。	key
Value	string	插入的頭欄位內容。 ValueType 取值為 SystemDefined 時取值如下： ClientSrcPort：用戶端連接埠。 ClientSrcIp：用戶端 IP 位址。 Protocol：用戶端請求的協議（HTTP 或 HTTPS)。 SLBId：應用型Server Load Balancer執行個體 ID。 SLBPort：應用型Server Load Balancer執行個體監聽連接埠。 ValueType 取值為 UserDefined 時：您可自訂頭欄位內容，限制長度為 1~128 個字元，支援萬用字元星號（）、半形問號（?）和 ASCII 碼值`ch >= 32 && ch < 127`範圍內的可列印字元，開頭和結尾不可為空格。 ValueType* 取值為 ReferenceHeader 時：您可以引用要求標頭欄位中的某一個欄位，限制長度限制為 1~128 個字元，支援小寫字母 a~z、數字、短劃線（-）和底線（_）。	ClientSrcPort
ValueType	string	頭欄位內容類型。取值： UserDefined：使用者指定。 ReferenceHeader：引用使用者要求標頭中的某一個欄位。 SystemDefined：系統定義。	SystemDefined
Order	integer	轉寄規則動作執行的順序，取值為1~50000，按值從小到大執行動作。值不可為空，不能重複。	1
RedirectConfig	object	重新導向配置。
Host	string	要跳轉的主機地址。取值： ${host}（預設值）：取此值時不支援和其他字元拼接使用。其他取值，字元集和格式限制如下：主機名稱長度為 3~128 個字元，支援小寫字母 a~z、數字、短劃線（-）、半形句號（.）以及萬用字元星號（）和半形問號（?）。主機名稱至少包含一個半形句號（.），且半形句號（.）不能出現在開頭或結尾。最右側的域標籤只能包含字母和萬用字元，不能包含數字或短劃線（-）。短劃線（-）不能出現在其它域標籤的開頭或結尾。萬用字元星號（）和半形問號（?）可以出現在域標籤的任意位置。	www.example.com
HttpCode	string	跳轉方式，取值為 301、302、303、307 或 308。	301
Path	string	要跳轉的路徑。取值： ${path}（預設值）：可以引用${host}、${protocol}和${port}，由${host}、${protocol}和${port}組成，每個變數最多出現一次。上述變數可以同時使用，也可以和下面羅列的可取值範圍內的字串拼接使用。其他取值，字元集和格式限制如下：長度為 1~128 個字元。必須以正斜線（/）開頭，支援字母、數字和特殊字元`$-_.+/&~@:`，不支援`“%#;!()[]^,”` ，同時支援萬用字元星號（*）和半形問號（?）。	/test
Port	string	要跳轉的連接埠。取值： ${port}（預設值）：該取值不支援和其他字元同時使用。其他取值：1~63335。	10
Protocol	string	要跳轉的協議。取值： ${protocol}（預設值）：取該值時不支援和其他字元拼接使用。 HTTP 或 HTTPS。說明 HTTPS 監聽僅支援跳轉 HTTPS 協議。	HTTP
Query	string	要跳轉的查詢字串。長度為 1~128 個字元，支援小寫字母和可見字元，不支援 `#[]{}\\|<>&`。	quert
RemoveHeaderConfig	object	去除 HTTP 頭部配置。
Key	string	去除的頭欄位名稱，長度為 1~40 個字元，支援大小寫字母 a~z、數字、底線（_）和短劃線（-）。頭欄位名稱不能重複用於 RemoveHeader 中。請求方向（Direction 取值為 Request）：不允許將頭名稱設定為以下欄位（不區分大小寫）：`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`、`authority`。回應程式向（Direction 取值為 Response）：回應程式向不允許將頭名稱設定為以下欄位（不區分大小寫）：`connection`、`upgrade`、`content-length`、`transfer-encoding`。	key
RewriteConfig	object	重寫配置。
Host	string	要跳轉的主機地址。取值： ${host}（預設值）：取此值時不支援和其他字元拼接使用。其他取值，字元集和格式限制如下：主機名稱長度為 3~128 個字元，支援小寫字母 a~z、數字、短劃線（-）、半形句號（.）以及萬用字元星號（）和半形問號（?）。主機名稱至少包含一個半形句號（.），且半形句號（.）不能出現在開頭或結尾。最右側的域標籤只能包含字母和萬用字元，不能包含數字或短劃線（-）。短劃線（-）不能出現在其它域標籤的開頭或結尾。萬用字元星號（）和半形問號（?）可以出現在域標籤的任意位置。	www.example.com
Path	string	內部跳轉的目的路徑。長度為 1~128 個字元，以正斜線（/）開頭，支援字母、數字、星號（*）、半形問號（?）和`$-_.+/&~@:`，不支援`“%#;!()[]^,”` 。	/tsdf
Query	string	內部跳轉的查詢字串。長度為 1~128 個字元，支援小寫字母和可見字元，不支援 `#[]{}\\|<>&`。	quedsa
TrafficMirrorConfig	object	流量鏡像。
TargetType	string	流量鏡像的目的，可以是伺服器組	ForwardGroupMirror
MirrorGroupConfig	object	流量鏡像至伺服器組。
ServerGroupTuples	array<object>	流量鏡像至伺服器組。
	object
ServerGroupId	string	伺服器組 ID。	sgp-00mkgijak0w4qgz9****
Weight	integer	權重。取值範圍：0~100。	2
TrafficLimitConfig	object	流量限速。
QPS	integer	每秒請求次數。取值範圍：1~100000。	4
PerIpQps	integer	單 IP 每秒請求次數。取值範圍：1 ~ 100000。說明如果同時配置 QPS 參數，PerIpQps 參數的取值必須小於 QPS 參數的取值。	80
Type	string	動作類型。取值： ForwardGroup：轉寄至多個虛擬伺服器組。 Redirect：重新導向。 FixedResponse：返回固定內容。 Rewrite：重寫。 InsertHeader：寫入頭欄位。 RemoveHeaderConfig：刪除頭欄位。 TrafficLimitConfig：流量限速。 TrafficMirrorConfig：流量鏡像。 CorsConfig：跨域。	ForwardGroup
CorsConfig	object	跨域。
AllowOrigin	array	允許的訪問來源。
	string	允許訪問的來源。支援配置為``或配置為一個或多個 value 值。value 的值不能為``。單個 value 值必須以`http://`或者`https://`開頭，後面加一個正確的網域名稱或者一級的泛網域名稱（例如，`.test.abc.example.com`）。單個 value 值可以不加連接埠，也可以指定連接埠，連接埠範圍：1~65535*。	http://test.com
AllowMethods	array	選擇跨域訪問時允許的 HTTP 方法。
	string	選擇跨域訪問時允許的 HTTP 方法。取值： GET。 POST。 PUT。 DELETE。 HEAD。 OPTIONS。 PATCH。	GET
AllowHeaders	array	允許跨域的 Header 列表。
	string	允許跨域的 Header 列表。支援配置為`*`或配置一個或多個 value 值，多個 value 值用半形逗號（,）隔開。單個 value 值只允許包含大小寫字母、數字，以及不在首尾的底線（_）和短劃線（-），最大長度限制為 32 個字元。	test_123
ExposeHeaders	array	允許暴露的 Header 列表。
	string	允許跨域的 Header 列表。支援配置為`*`或配置一個或多個 value 值，多個 value 值用半形逗號（,）隔開。單個 value 值只允許包含大小寫字母、數字，以及不在首尾的底線（_）和短劃線（-），最大長度限制為 32 個字元。	test_123
AllowCredentials	string	是否允許攜帶憑證資訊。取值： on：是。 off：否。	on
MaxAge	integer	預檢請求在瀏覽器的最大緩衝時間，單位：秒。取值範圍：-1~172800。	1000
RuleConditions	array<object>	轉寄規則條件列表。
	object	轉寄規則條件結構。
CookieConfig	object	Cookie 配置。
Values	array<object>	Cookie 值。
	object	Cookie 值。
Key	string	Cookie 鍵。長度為 1~100 個字元，支援小寫字母、可見字元、星號（*）和半形問號（?），不支援空格和`#[]{}\\|<>&`。	test
Value	string	Cookie 值。長度為 1~128 個字元，支援小寫字母、可見字元、星號（*）和半形問號（?），不支援空格和`#[]{}\\|<>&`。	test
HeaderConfig	object	頭欄位配置。
Key	string	頭欄位鍵。長度為 1~40 個字元。支援字母 a~z、數字、短劃線（-）和底線（_）。不支援 Cookie 和 Host。	Port
Values	array	頭欄位值。
	string	頭欄位值。長度為 1~128 個字元。支援 ASCII 碼值`ch >= 32 && ch < 127`範圍內可列印字元、小寫字母、星號（*）和半形問號（?）。開頭和結尾不可為空格。	5006
HostConfig	object	主機配置。
Values	array	主機名稱。
	string	主機名稱。命名規則：網域名稱長度為 3~128 個字元，支援小寫字母 a~z、數字、短劃線（-）、半形句號（.）、星號（）和半形問號（?）。網域名稱至少包含一個半形句號（.），且半形句號（.）不能出現在開頭或結尾。最右側的域標籤只能包含字母、星號（）和半形問號（?），不能包含數字或短劃線（-）。短劃線（-）不能出現在其它域標籤的開頭或結尾。星號（*）和半形問號（?）可以出現在域標籤的任意位置。	www.example.com
MethodConfig	object	要求方法配置。
Values	array	要求方法。
	string	要求方法。取值：HEAD、GET、POST、OPTIONS、PUT、PATCH 或 DELETE。	PUT
PathConfig	object	轉寄路徑配置。
Values	array	轉寄路徑。
	string	轉寄路徑。長度為 1~128 個字元，以正斜線（/）開頭，支援字母、數字、星號（*）、半形問號（?）和`$-_.+/&~@:`，不支援`“%#;!()[]^,”` 。	/test
QueryStringConfig	object	查詢字串配置。
Values	array<object>	查詢字串。
	object	查詢字串。
Key	string	查詢字串鍵。長度為 1~100 個字元，支援小寫字母、可見字元、星號（*）和半形問號（?），不支援空格和`#[]{}\\|<>&`。	test
Value	string	查詢字串值。長度為 1~128 個字元，支援小寫字母、可見字元、星號（*）和半形問號（?），不支援空格和`#[]{}\\|<>&`。	test
SourceIpConfig	object	基於源 IP 業務流量匹配。
Values	array	需要匹配的源 IP 列表。
	string	添加一個或多個 IP 位址或者 IP 位址段。一條轉寄規則中最多支援添加 5 條源 IP。	192.168.XX.XX/32
ResponseStatusCodeConfig	object	響應狀態代碼配置。
Values	array	響應狀態代碼列表。
	string	響應狀態代碼。	200
ResponseHeaderConfig	object	響應 HTTP 頭部配置。
Key	string	響應 HTTP 頭部鍵。長度為 1~40 個字元。支援字母 a~z、數字、短劃線（-）和底線（_）。不支援 Cookie 和 Host。	key
Values	array	響應 HTTP 頭部值列表。
	string	響應 HTTP 頭部值。長度為 1~128 個字元。	value
Type	string	轉寄規則類型。取值： Host：主機。 Path：路徑。 Header：HTTP 頭欄位。 QueryString：查詢字串。 Method：要求方法。 Cookie：Cookie。 SourceIp：源 IP。	Host
RuleId	string	轉寄規則 ID。	rule-bpn0kn908w4nbw****
RuleName	string	轉寄規則名稱。長度為 2~128 個英文或中文字元，必須以大小字母或中文開頭，可包含數字，半形句號（.），底線（_）和短劃線（-）。	rule-instance-test
RuleStatus	string	轉寄規則狀態。取值： Provisioning：建立中。 Configuring：變更配置中。 Available：運行中。	Available
Direction	string	轉寄規則的方向。取值： Request（預設值）：請求類型，對從用戶端發送到 ALB 的報文進行條件匹配並進行相應的處理。 Response：響應類型，對從後端伺服器組返回到 ALB 的報文進行條件匹配並進行相應的處理。說明基礎版的 ALB 執行個體不支援 Response 類型。	Request
Tags	array<object>	標籤。
	object	標籤結構。
Key	string	標籤鍵。最多支援 128 個字元，不能以 aliyun 或 acs:開頭，不能包含 http://或 https://。	env
Value	string	標籤值。最多支援 128 個字元，不能以 aliyun 或 acs:開頭，不能包含 http://或 https://。	product
TotalCount	integer	本次請求條件下返回的總資料記錄數。	1000

樣本

正常返回樣本

JSON格式

{
  "MaxResults": 50,
  "NextToken": "FFmyTO70tTpLG6I3FmYAXGKPd****",
  "RequestId": "CEF72CEB-54B6-4AE8-B225-F876F******",
  "Rules": [
    {
      "ListenerId": "lsn-i35udpz3pxsmnf****",
      "LoadBalancerId": "alb-x30o38azsuj0sx****",
      "Priority": 1,
      "RuleActions": [
        {
          "FixedResponseConfig": {
            "Content": "dssacav",
            "ContentType": "text/plain",
            "HttpCode": "HTTP_2xx"
          },
          "ForwardGroupConfig": {
            "ServerGroupTuples": [
              {
                "ServerGroupId": "sgp-atstuj3rtoptyui****",
                "Weight": 2
              }
            ],
            "ServerGroupStickySession": {
              "Enabled": true,
              "Timeout": 100
            }
          },
          "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": "key"
          },
          "RewriteConfig": {
            "Host": "www.example.com",
            "Path": "/tsdf",
            "Query": "quedsa"
          },
          "TrafficMirrorConfig": {
            "TargetType": "ForwardGroupMirror",
            "MirrorGroupConfig": {
              "ServerGroupTuples": [
                {
                  "ServerGroupId": "sgp-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": [
              "200"
            ]
          },
          "ResponseHeaderConfig": {
            "Key": "key",
            "Values": [
              "value"
            ]
          },
          "Type": "Host"
        }
      ],
      "RuleId": "rule-bpn0kn908w4nbw****",
      "RuleName": "rule-instance-test",
      "RuleStatus": "Available",
      "Direction": "Request",
      "Tags": [
        {
          "Key": "env",
          "Value": "product"
        }
      ]
    }
  ],
  "TotalCount": 1000
}

錯誤碼

HTTP status code	錯誤碼	錯誤資訊	描述
403	Forbidden.LoadBalancer	Authentication is failed for %s.	負載平衡操作鑒權失敗。

訪問錯誤中心查看更多錯誤碼。

變更歷史

更多資訊，參考變更詳情。