調(diào)用UpdateForwardingRules接口更新轉(zhuǎn)發(fā)策略。
接口說明
- UpdateForwardingRules 接口屬于異步接口,即系統(tǒng)會(huì)先返回一個(gè)請(qǐng)求 ID,但轉(zhuǎn)發(fā)策略并未修改完成,系統(tǒng)后臺(tái)的修改任務(wù)仍在進(jìn)行。您可以調(diào)用 ListForwardingRules 查詢轉(zhuǎn)發(fā)策略的狀態(tài):
- 當(dāng)轉(zhuǎn)發(fā)策略處于 configuring 狀態(tài)時(shí),表示轉(zhuǎn)發(fā)策略正在修改中,在該狀態(tài)下,您只能執(zhí)行查詢操作,不能執(zhí)行其他操作。
- 當(dāng)轉(zhuǎn)發(fā)策略處于 active 狀態(tài)時(shí),表示轉(zhuǎn)發(fā)策略修改完成。
- UpdateForwardingRules 接口不支持在同一個(gè)全球加速實(shí)例內(nèi)并發(fā)修改轉(zhuǎn)發(fā)策略。
調(diào)試
您可以在OpenAPI Explorer中直接運(yùn)行該接口,免去您計(jì)算簽名的困擾。運(yùn)行成功后,OpenAPI Explorer可以自動(dòng)生成SDK代碼示例。
授權(quán)信息
下表是API對(duì)應(yīng)的授權(quán)信息,可以在RAM權(quán)限策略語句的Action
元素中使用,用來給RAM用戶或RAM角色授予調(diào)用此API的權(quán)限。具體說明如下:
- 操作:是指具體的權(quán)限點(diǎn)。
- 訪問級(jí)別:是指每個(gè)操作的訪問級(jí)別,取值為寫入(Write)、讀取(Read)或列出(List)。
- 資源類型:是指操作中支持授權(quán)的資源類型。具體說明如下:
- 對(duì)于必選的資源類型,用背景高亮的方式表示。
- 對(duì)于不支持資源級(jí)授權(quán)的操作,用
全部資源
表示。
- 條件關(guān)鍵字:是指云產(chǎn)品自身定義的條件關(guān)鍵字。
- 關(guān)聯(lián)操作:是指成功執(zhí)行操作所需要的其他權(quán)限。操作者必須同時(shí)具備關(guān)聯(lián)操作的權(quán)限,操作才能成功。
操作 | 訪問級(jí)別 | 資源類型 | 條件關(guān)鍵字 | 關(guān)聯(lián)操作 |
---|---|---|---|---|
ga:UpdateForwardingRules | update | *Listener acs:ga:{#regionId}:{#accountId}:listener/{#listenerId} |
| 無 |
請(qǐng)求參數(shù)
名稱 | 類型 | 必填 | 描述 | 示例值 |
---|---|---|---|---|
RegionId | string | 是 | 全球加速實(shí)例所屬的地域 ID,僅取值:cn-hangzhou。 | cn-hangzhou |
ClientToken | string | 否 | 客戶端 Token,用于保證請(qǐng)求的冪等性。 從您的客戶端生成一個(gè)參數(shù)值,確保不同請(qǐng)求間該參數(shù)值唯一。ClientToken 只支持 ASCII 字符。 說明
若您未指定,則系統(tǒng)自動(dòng)使用 API 請(qǐng)求的 RequestId 作為 ClientToken 標(biāo)識(shí)。每次 API 請(qǐng)求的 RequestId 不一樣。
| 02fb3da4**** |
AcceleratorId | string | 是 | 全球加速實(shí)例 ID。 | ga-bp17frjjh0udz4q**** |
ListenerId | string | 是 | 監(jiān)聽 ID。 | lsr-bp1s0vzbi5bxlx5**** |
ForwardingRules | array<object> | 是 | 轉(zhuǎn)發(fā)策略配置信息列表。 | test |
object | 是 | 轉(zhuǎn)發(fā)策略配置信息列表。 | ||
Priority | integer | 是 | 轉(zhuǎn)發(fā)策略優(yōu)先級(jí)。取值范圍:1~10000。值越小表示優(yōu)先級(jí)越高。 | 1000 |
RuleConditions | array<object> | 是 | 轉(zhuǎn)發(fā)條件列表。 | |
object | 否 | 轉(zhuǎn)發(fā)條件列表。 | ||
RuleConditionType | string | 是 | 轉(zhuǎn)發(fā)條件類型。取值:
| Host |
RuleConditionValue | string | 否 | 轉(zhuǎn)發(fā)條件類型對(duì)應(yīng)的值。 根據(jù) RuleConditionType 傳入不同的 JSON 字符串值。
| ["www.example.com", "www.aliyun.com"] |
PathConfig | object | 否 | 路徑配置信息。 說明
不推薦使用該參數(shù),建議直接使用 RuleConditionType 和 RuleConditionValue 配置轉(zhuǎn)發(fā)條件。
| |
Values | array | 否 | 路徑配置信息。 說明
不推薦使用該參數(shù),建議直接使用 RuleConditionType 和 RuleConditionValue 配置轉(zhuǎn)發(fā)條件。
| |
string | 否 | 路徑配置。 路徑長度為 1~128 個(gè)字符,必須以正斜線(/)開頭,只允許包含字母、數(shù)字、美元符號(hào)($)、短劃線(-)、下劃線(_)、半角句號(hào)(.)、加號(hào)(+)、正斜線(/)、and(&)、波浪線(~)、at(@)、半角冒號(hào)(:)、半角單引號(hào)('),支持使用星號(hào)(*)和半角問號(hào)(?)作為通配符。 說明
不推薦使用該參數(shù),建議直接使用 RuleConditionType 和 RuleConditionValue 配置轉(zhuǎn)發(fā)條件。
| /test | |
HostConfig | object | 否 | 域名配置信息。 說明
不推薦使用該參數(shù),建議直接使用 RuleConditionType 和 RuleConditionValue 配置轉(zhuǎn)發(fā)條件。
| |
Values | array | 否 | 域名配置信息。 說明
不推薦使用該參數(shù),建議直接使用 RuleConditionType 和 RuleConditionValue 配置轉(zhuǎn)發(fā)條件。
| |
string | 否 | 域名配置。 域名長度為 3~128 個(gè)字符,允許包含字母、數(shù)字、短劃線(-)和半角句號(hào)(.),支持使用星號(hào)(*)和半角問號(hào)(?)作為通配符。 | example.com | |
RuleActions | array<object> | 是 | 轉(zhuǎn)發(fā)動(dòng)作。 | |
object | 是 | 轉(zhuǎn)發(fā)動(dòng)作。 | ||
Order | integer | 是 | 轉(zhuǎn)發(fā)優(yōu)先級(jí)。 說明
當(dāng)前無實(shí)際意義,無需配置。
| 20 |
RuleActionType | string | 是 | 轉(zhuǎn)發(fā)動(dòng)作類型。取值:
| ForwardGroup |
RuleActionValue | string | 否 | 轉(zhuǎn)發(fā)動(dòng)作類型對(duì)應(yīng)的值。 根據(jù) RuleActionType 傳入不同的 JSON 字符串值。 一個(gè)轉(zhuǎn)發(fā)規(guī)則最多只能有一條 ForwardGroup、Redirect、FixResponse 類型的轉(zhuǎn)發(fā)動(dòng)作。Rewrite、AddHeader、RemoveHeader 類型的轉(zhuǎn)發(fā)動(dòng)作順序必須在 ForwardGroup 類型的轉(zhuǎn)發(fā)動(dòng)作之前。
| [{"type":"endpointgroup", "value":"epg-bp1enpdcrqhl78g6r****"}] |
ForwardGroupConfig | object | 否 | 轉(zhuǎn)發(fā)配置。 說明
不推薦使用該參數(shù),建議直接使用 RuleActionType 和 RuleActionValue 配置轉(zhuǎn)發(fā)動(dòng)作。
| |
ServerGroupTuples | array<object> | 是 | 終端節(jié)點(diǎn)組配置。 說明
不推薦使用該參數(shù),建議直接使用 RuleActionType 和 RuleActionValue 配置轉(zhuǎn)發(fā)動(dòng)作。
| |
object | 是 | 終端節(jié)點(diǎn)組配置。 說明
不推薦使用該參數(shù),建議直接使用 RuleActionType 和 RuleActionValue 配置轉(zhuǎn)發(fā)動(dòng)作。
| ||
EndpointGroupId | string | 是 | 終端節(jié)點(diǎn)組 ID。 說明
不推薦使用該參數(shù),建議直接使用 RuleActionType 和 RuleActionValue 配置轉(zhuǎn)發(fā)動(dòng)作。
| epg-bp1ieei9664r5nv**** |
ForwardingRuleId | string | 是 | 轉(zhuǎn)發(fā)策略 ID。 | frule-bp1dii16gu9qdvb34**** |
ForwardingRuleName | string | 否 | 轉(zhuǎn)發(fā)策略名稱。 名稱長度為 2~128 個(gè)英文或中文字符,必須以大小寫字母或中文開頭,可包含數(shù)字、半角句號(hào)(.)、下劃線(_)和短劃線(-)。 | test |
RuleDirection | string | 否 | 規(guī)則生效方向。無需配置。 目前默認(rèn)為 request,表示請(qǐng)求方向生效。 | request |
返回參數(shù)
示例
正常返回示例
JSON
格式
{
"ForwardingRules": [
{
"ForwardingRuleId": "frule-bp1dii16gu9qdvb34****"
}
],
"RequestId": "64ADAB1E-0B7F-4FD8-A404-3BECC0E9CCFF"
}
錯(cuò)誤碼
HTTP status code | 錯(cuò)誤碼 | 錯(cuò)誤信息 | 描述 |
---|---|---|---|
400 | NotExist.Listener | The listener does not exist. | 監(jiān)聽器不存在 |
400 | NotActive.Listener | The state of the listener is not active. | 監(jiān)聽器狀態(tài)非穩(wěn)態(tài) |
400 | NotExist.Accelerator | The accelerated instance does not exist. | 加速實(shí)例不存在。 |
400 | StateError.Accelerator | The state of the accelerated instance is invalid. | 加速實(shí)例狀態(tài)非法。 |
400 | NotExist.BasicBandwidthPackage | You must specify the basic bandwidth package. | 缺少基礎(chǔ)帶寬包 |
400 | QuotaExceeded.EndPoint | The maximum number of endpoints is exceeded. | 終端節(jié)點(diǎn)達(dá)到Quota限制 |
400 | Exist.EndpointGroup | The endpoint group already exists. | 終端節(jié)點(diǎn)組已存在 |
400 | NoPermission.VpcEndpoint | You are not authorized to perform the operation. | 用戶沒有創(chuàng)建服務(wù)關(guān)聯(lián)角色的權(quán)限,請(qǐng)聯(lián)系主賬號(hào)或權(quán)限管理員授權(quán)當(dāng)前用戶AliyunGlobalAccelerationFullAccess或者創(chuàng)建服務(wù)關(guān)聯(lián)角色的自定義權(quán)限。自定義權(quán)限策略的相關(guān)信息包含以下內(nèi)容:ServiceName為vpcendpoint.ga.aliyuncs.com,服務(wù)關(guān)聯(lián)角色名稱為AliyunServiceRoleForGaVpcEndpoint,執(zhí)行該操作所需的用戶權(quán)限為ram:CreateServiceLinkedRole。 |
400 | SystemBusy | System busy, please try again later. | 系統(tǒng)繁忙,處理超時(shí),請(qǐng)稍后重試。若重試后仍出現(xiàn),請(qǐng)?zhí)峁翁幚怼? |
400 | RepeatPathAndHost.ForwardingRule | The path and host %s are duplicated. | 路徑和域名重復(fù) |
400 | QuotaExceeded.RuleConditionConfig | The number of paths and hosts exceeds the limit. | 路徑和域名數(shù)量超過限制 |
400 | NotExist.BusinessRegion | The business region does not exist. | 業(yè)務(wù)region并不存在 |
400 | NotExist.ForwardingRule | The forwarding rule %s does not exist. | 轉(zhuǎn)發(fā)規(guī)則 %s 不存在 |
訪問錯(cuò)誤中心查看更多錯(cuò)誤碼。
變更歷史
變更時(shí)間 | 變更內(nèi)容概要 | 操作 |
---|---|---|
2023-10-18 | OpenAPI 錯(cuò)誤碼發(fā)生變更 | 查看變更詳情 |