全部產品
Search
文件中心

Server Load Balancer:UpdateRuleAttribute - 更新轉寄規則屬性

更新時間:Oct 10, 2025

更新轉寄規則屬性,如條件、動作、名稱等。

介面說明

  • UpdateRuleAttribute 介面屬於非同步介面,即系統返回一個請求 ID,但該轉寄規則屬性尚未更新成功,系統背景更新任務仍在進行。您可以調用 ListRules 查詢轉寄規則屬性的更新狀態:

    • 當轉寄規則屬性處於 Configuring 狀態時,表示轉寄規則屬性正在更新中。

    • 當轉寄規則屬性處於 Available 狀態時,表示轉寄規則屬性更新成功。

  • 一條轉寄規則最多支援添加的條件數(RuleConditions)和動作數(RuleActions)如下:

    • 條件數:基礎版 5 條、標準版 10 條、WAF 增強版 10 條。

    • 動作數:基礎版 3 條,標準版 5 條、WAF 增強版 5 條。

調試

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

調試

授權資訊

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

  • 操作:是指具體的許可權點。

  • 存取層級:是指每個操作的存取層級,取值為寫入(Write)、讀取(Read)或列出(List)。

  • 資源類型:是指操作中支援授權的資源類型。具體說明如下:

    • 對於必選的資源類型,用前面加 * 表示。

    • 對於不支援資源級授權的操作,用全部資源表示。

  • 條件關鍵字:是指雲產品自身定義的條件關鍵字。

  • 關聯操作:是指成功執行操作所需要的其他許可權。操作者必須同時具備關聯操作的許可權,操作才能成功。

操作

存取層級

資源類型

條件關鍵字

關聯操作

alb:UpdateRuleAttribute

update

*LoadBalancer

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

*ServerGroup

acs:alb:{#regionId}:{#accountId}:servergroup/{#ServerGroupId}

請求參數

名稱

類型

必填

描述

樣本值

RuleId

string

轉寄規則 ID。

rule-4dp5i6ea****

ClientToken

string

用戶端 Token,用於保證請求的等冪性。

從您的用戶端產生一個參數值,確保不同請求間該參數值唯一。ClientToken 只支援 ASCII 字元。

說明

若您未指定,則系統自動使用 API 請求的 RequestId 作為 ClientToken 標識。每次 API 請求的 RequestId 不一樣。

5A2CFF0E-5718-45B5-9D4D-70B3FF3898

DryRun

boolean

是否只預檢此次請求,取值:

  • true:發送檢查請求,不會更新轉寄規則屬性。檢查項包括是否填寫了必需參數、請求格式、業務限制。如果檢查不通過,則返回對應錯誤。如果檢查通過,則返回錯誤碼DryRunOperation

  • false(預設值):發送正常請求,通過檢查後返回HTTP 2xx狀態代碼並直接進行操作。

false

RuleConditions

array<object>

轉寄規則條件。

array<object>

轉寄規則條件。

CookieConfig

object

Cookie 配置。

Values

array

Cookie 配置。

object

Cookie 配置。

Key

string

Cookie 鍵。長度為 1~100 個字元,支援小寫字母、可見字元、星號(*)和半形問號(?),不支援空格和#[]{}\|<>&";

test

Value

string

Cookie 值。長度為 1~128 個字元,支援小寫英文字母、可見字元、星號(*)和半形問號(?),不支援空格和#[]{}\|<>&

test

HeaderConfig

object

頭欄位配置。

Key

string

頭欄位鍵。長度為 1~40 個字元,支援字母、數字、短劃線(-)和底線(_),不支援 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

要求方法。

取值:HEADGETPOSTOPTIONSPUTPATCHDELETE

PUT

PathConfig

object

轉寄的路徑配置。

Values

array

轉寄路徑列表。

string

轉寄路徑。命名規則:

  • 長度為 1~128 個字元。

  • 必須以正斜線(/)開頭,支援字母、數字和特殊字元$-_.+/&~@:,不支援“%#;!()[]^,”\",支援星號(*)和半形問號(?)作為萬用字元使用。

/test

QueryStringConfig

object

查詢字串配置。

Values

array

查詢字串列表。最多支援添加 20 個查詢字串。

object

查詢字串結構。

Key

string

查詢字串鍵。長度為 1~100 個字元,支援小寫字母、可見字元、星號(*)和半形問號(?),不支援空格和#[]{}\|<>&"

test

Value

string

查詢字串值。長度為 1~128 個字元,支援小寫字母、可見字元、星號(*)和半形問號(?),不支援空格和#[]{}\|<>&"

test

Type

string

轉寄規則類型。最多支援添加 7 個轉寄規則類型。取值:

  • Host:主機。

  • Path:路徑。

  • Header:HTTP 頭欄位。

  • QueryString:查詢字串。

  • Method:要求方法。

  • Cookie:Cookie。

  • SourceIp:源 IP。

  • ResponseHeader:響應 HTTP 頭欄位。

  • ResponseStatusCode: 響應狀態代碼。

Host

ResponseStatusCodeConfig

object

響應狀態代碼配置。

Values

array

響應狀態代碼列表。

string

響應狀態代碼。

301

ResponseHeaderConfig

object

標題條件配置。

Key

string

頭欄位鍵。

  • 長度為 1~40 個字元。

  • 支援字母 a~z、數字、短劃線(-)和底線(_)。

  • 不支援 Cookie 和 Host。

test

Values

array

頭欄位值。

string

頭欄位值。

  • 長度為 1~128 個字元。

  • 支援 ASCII 碼值ch >= 32 && ch < 127範圍內可列印字元、小寫字母以及萬用字元星號(*)和半形問號(?)。不支援"

  • 開頭和結尾不可為空格。結尾不能為\

50006

SourceIpConfig

object

基於源 IP 業務流量匹配。最多支援添加 5 個基於源 IP 業務流量匹配。

Values

array

添加一個或多個 IP 位址或者 IP 位址段。

string

添加一個或多個 IP 位址或者 IP 位址段。

192.168.0.0/32

RuleActions

array<object>

轉寄規則動作列表。

array<object>

轉寄規則動作列表。

FixedResponseConfig

object

固定響應內容配置。

Content

string

返回的固定內容。最大 1 KB,只支援 ASCII 字元。

dssacav

ContentType

string

返回固定內容的格式。

取值:text/plaintext/csstext/htmlapplication/javascriptapplication/json

text/plain

HttpCode

string

返回的 HTTP 響應碼,僅支援 2xx4xx5xx 數字型字串,x 為任一數字。

200

ForwardGroupConfig

object

轉寄組配置。

ServerGroupTuples

array

轉寄到的目標伺服器組列表。

object

轉寄到的目的伺服器組結構。

ServerGroupId

string

轉寄到的目的伺服器組 ID。

sg--atstuj3rtoptyui****

Weight

integer

權重。取值越大,權重越大,表示轉寄的訪問請求更多。取值範圍:0~100

  • 目的伺服器組數為 1 時,未指定權重時預設值為 100

  • 目的伺服器組數大於 1 時,需要使用者指定權重值。

30

ServerGroupStickySession

object

伺服器組之間會話保持。

Enabled

boolean

是否開啟會話保持。取值:

  • true:開啟。

  • false(預設值):不開啟。

false

Timeout

integer

逾時時間。單位:秒。取值範圍:1~86400。

2

InsertHeaderConfig

object

寫入頭欄位配置。

CoverEnabled

boolean

是否覆蓋請求中的值。取值:

  • true:是。

  • false(預設值):否。

false

Key

string

插入的頭欄位名稱,長度為 1~40 個字元,支援大小寫字母 a~z、數字、底線(_)和短劃線(-)。InsertHeaderConfig 中的頭欄位名稱不能重複。

說明

不允許將頭名稱設定為以下欄位(不區分大小寫):slb-idslb-ipx-forwarded-forx-forwarded-protox-forwarded-eipx-forwarded-portx-forwarded-client-srcportx-forwarded-hostconnectionupgradecontent-lengthtransfer-encodingkeep-alivetehostcookieremoteipauthority

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、數字、短劃線(-)和底線(_)。

UserDefined

ValueType

string

頭欄位內容類型。取值:

  • UserDefined:您自訂頭欄位內容。

  • ReferenceHeader:引用要求標頭中的某一個頭欄位內容。

  • SystemDefined:系統定義頭欄位內容。

UserDefined

Order

integer

轉寄規則動作執行的順序,取值範圍:1~50000,按值從小到大執行動作。值不可為空,不能重複。最多支援添加 20 個轉寄規則動作執行的順序。

1

RedirectConfig

object

重新導向配置。最多支援添加 20 個重新導向。

Host

string

要跳轉的主機地址。取值:

  • ${host}(預設值):取此值時不支援和其他字元拼接使用。

  • 其他取值,字元集和格式限制如下:
    • 主機名稱長度為 3~128 個字元,支援小寫字母 a~z、數字、短劃線(-)、半形句號(.)以及萬用字元星號(*)和半形問號(?)。

    • 主機名稱至少包含一個半形句號(.),且半形句號(.)不能出現在開頭或結尾。

    • 最右側的域標籤只能包含字母和萬用字元,不能包含數字或短劃線(-)。

    • 短劃線(-)不能出現在其它域標籤的開頭或結尾。

    • 萬用字元星號(*)和半形問號(?)可以出現在域標籤的任意位置。

www.example.com

HttpCode

string

跳轉方式,取值為 301302303307308

301

Path

string

要跳轉的路徑。取值:

  • ${path}(預設值):可以引用**${host}${protocol}${port}**,每個變數最多出現一次。上述變數可以同時使用,也可以和下面羅列的可取值範圍內的字串拼接使用。

  • 其他取值,字元集和格式限制如下:
    • 長度為 1~128 個字元。

    • 必須以正斜線(/)開頭,支援字母、數字和特殊字元$-_.+/&~@:,不支援“%#;!()[]^,”\",同時支援萬用字元星號(*)和半形問號(?)。

/test

Port

string

要跳轉的連接埠。取值:

  • ${port}(預設值):該取值僅允許單獨使用,不支援和其他字元拼接使用。

  • 其他取值:1~63335

10

Protocol

string

要跳轉的協議。取值:

  • ${protocol}(預設值):取該值時不支援和其他字元拼接使用。

  • HTTPHTTPS

說明

HTTPS 監聽僅支援跳轉 HTTPS 協議。

HTTP

Query

string

要跳轉的查詢字串。取值:

  • ${query}(預設值):可以引用**${host}${protocol}${port}**,每個變數最多出現一次。上述變數可以同時使用,也可以和下面羅列的可取值範圍內的字串拼接使用。

  • 其他取值,字元集和格式限制如下:
    • 長度為 1~128 個字元。

    • 支援可見字元,不支援空格和 #[]{}\|<>"。如果是字母則必須是小寫字母。

quert

RewriteConfig

object

重寫配置。

Host

string

內部跳轉的目的主機地址。取值:

  • ${host}(預設值):該取值不支援和其他字元拼接。

  • 其他取值,字元格式設定限制如下:

    • 主機名稱長度為 3~128 個字元,支援小寫字母 a~z、數字、短劃線(-)、半形句號(.)以及萬用字元星號(*)和半形問號(?)。

    • 主機名稱至少包含一個半形句號(.),且半形句號(.)不能出現在開頭或結尾。

    • 最右側的域標籤只能包含字母和萬用字元,不能包含數字或短劃線(-)。

    • 短劃線(-)不能出現在其它域標籤的開頭或結尾。萬用字元星號(*)和半形問號(?)可以出現在域標籤的任意位置。

www.example.com

Path

string

要跳轉的路徑。取值:

  • ${path}(預設值):可以引用**${host}${protocol}${port}**,每個變數最多出現一次。上述變數可以同時使用,也可以和下面羅列的可取值範圍內的字串拼接使用。

  • 其他取值,字元集和格式限制如下:
    • 長度為 1~128 個字元。

    • 必須以正斜線(/)開頭,支援字母、數字和特殊字元$-_.+/&~@:,不支援“%#;!()[]^,”\",同時支援萬用字元星號(*)和半形問號(?)。

/tsdf

Query

string

內部跳轉的查詢字串。取值:

  • ${query}(預設值):可以引用**${host}${protocol}${port}**,每個變數最多出現一次。上述變數可以同時使用,也可以和下面羅列的可取值範圍內的字串拼接使用。

  • 其他取值,字元集和格式限制如下:
    • 長度為 1~128 個字元。

    • 支援可見字元,不支援空格和 #[]{}\|<>"。如果是字母則必須是小寫字母。

quedsa

Type

string

動作類型。最多支援添加 11 個動作類型。取值:

  • ForwardGroup:轉寄至多個虛擬伺服器組。

  • Redirect:重新導向。

  • FixedResponse:返回固定內容。

  • Rewrite:重寫。

  • InsertHeader:寫入頭欄位。

  • RemoveHeader:刪除頭欄位。

  • TrafficLimit:流量限速。

  • TrafficMirror:流量鏡像。

  • Cors:跨域。

說明

一個轉寄規則必須包含有一條 ForwardGroup(轉寄至)、Redirect(重新導向)或 FixedResponse(返回固定響應)轉寄動作,與其他類型轉寄動作並存時,必須放在最後執行。

ForwardGroup

TrafficLimitConfig

object

流量限速。

QPS

integer

每秒請求次數。取值範圍:1~1000000

100

PerIpQps

integer

單 IP 每秒請求次數。 取值範圍:1 ~ 1000000

說明

如果同時配置 QPS 參數,PerIpQps 參數的取值必須小於 QPS 參數的取值。

80

TrafficMirrorConfig

object

流量鏡像。

TargetType

string

鏡像的目標類型。取值:

  • ForwardGroupMirror:表示鏡像至伺服器組。

ForwardGroupMirror

MirrorGroupConfig

object

流量鏡像至伺服器組。

ServerGroupTuples

array

流量鏡像至伺服器組。

object

流量鏡像至伺服器組。

ServerGroupId

string

伺服器組 ID。

srg-00mkgijak0w4qgz9****

RemoveHeaderConfig

object

去除 HTTP 頭部配置。

Key

string

去除的頭欄位名稱,長度為 1~40 個字元,支援大小寫字母 a~z、數字、底線(_)和短劃線(-)。頭欄位名稱不能重複用於 RemoveHeader 中。

  • 請求方向(Direction 取值為 Request):不允許將頭名稱設定為以下欄位(不區分大小寫):slb-idslb-ipx-forwarded-forx-forwarded-protox-forwarded-eipx-forwarded-portx-forwarded-client-srcportx-forwarded-hostconnectionupgradecontent-lengthtransfer-encodingkeep-alivetehostcookieremoteipauthority

  • 回應程式向(Direction 取值為 Response):回應程式向不允許將頭名稱設定為以下欄位(不區分大小寫):connectionupgradecontent-lengthtransfer-encoding

test

CorsConfig

object

跨域。

AllowOrigin

array

允許的訪問來源列表。支援只配置一個元素*,或配置一個或多個值。

  • 單個值必須以http://或者https://開頭,後邊加一個正確的網域名稱或一級泛網域名稱。(例:http://*.test.abc.example.com

  • 單個值可以不加連接埠,也可以指定連接埠,連接埠範圍:1~65535

string

允許的訪問來源。

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

RuleName

string

轉寄規則名稱。 長度為 2~128 個英文或中文字元,必須以大小字母或中文開頭,可包含數字,半形句號(.),底線(_)和短劃線(-)。

rule-instance-test

Priority

integer

規則優先順序,取值範圍:1~10000。值越小表示優先順序越高。

說明

同一個監聽內規則優先順序必須唯一。

10

返回參數

名稱

類型

描述

樣本值

object

更新轉寄規則屬性。

JobId

string

非同步任務 ID。

72dcd26b-f12d-4c27-b3af-18f6aed5****

RequestId

string

請求 ID。

365F5378-41F6-4AE4-92F8-7FF34B540710

樣本

正常返回樣本

JSON格式

{
  "JobId": "72dcd26b-f12d-4c27-b3af-18f6aed5****",
  "RequestId": "365F5378-41F6-4AE4-92F8-7FF34B540710"
}

錯誤碼

HTTP status code

錯誤碼

錯誤資訊

描述

400 IncorrectStatus.Rule The status of %s [%s] is incorrect. 轉寄規則的目前狀態不支援本次操作。
400 OperationDenied.IpGroupCanNotUsedForMirrorAction The operation is not allowed because of %s. 操作被拒絕,原因是%s。
400 OperationDenied.SameGroupForForwardAndMirrorAction The operation is not allowed because of %s. 操作被拒絕,原因是%s。
400 OperationDenied.GRPCServerGroup The operation is not allowed because of %s. 操作被拒絕,原因是存在綁定本GRPC伺服器組的監聽沒有啟用HTTP2.0。
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. 配額%s已超額度限制,目前已使用%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. 配額%s已超額度限制,目前已使用%s,配額為%s。
400 Mismatch.Protocol The %s is mismatched for %s and %s. %s在%s和%s中不匹配。
400 Mismatch.VpcId The %s is mismatched for %s and %s. %s在%s和%s中不匹配。
400 OperationDenied.RewriteMissingForwardGroup The operation is not allowed because of RewriteMissingForwardGroup. 操作被拒絕,原因是RewriteMissingForwardGroup。
400 ResourceInConfiguring.Listener The specified listener is being configured, please try again later. 資源正在變更配置中,請稍後重試。
400 OperationDenied.ProtocolMustSameForForwardGroupAction The operation is not allowed because of ProtocolMustSameForForwardGroupAction. 操作被禁止,原因:必須是相同的協議
403 Forbidden.ServerGroup Authentication has failed for ServerGroup. 對ServerGroup鑒權失敗
403 Forbidden.LoadBalancer Authentication is failed for %s. 負載平衡操作鑒權失敗。
404 ResourceNotFound.Rule The specified resource %s is not found. 資源%s不存在。
404 ResourceNotFound.ServerGroup The specified resource %s is not found. 後端伺服器組不存在。

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

變更歷史

更多資訊,參考變更詳情