UpdateIngress - 更新ingress執行個體配置 - Serverless App Engine

更新Ingress執行個體配置。

調試

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

調試

授權資訊

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

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

操作

存取層級

資源類型

條件關鍵字

關聯操作

sae:UpdateIngress

update

*全部資源

*

無

請求文法

PUT /pop/v1/sam/ingress/Ingress HTTP/1.1

請求參數

名稱	類型	必填	描述	樣本值
IngressId	integer	是	路由規則 ID。	87
CertId	string	否	CLB 認證 ID。取值說明如下： LoadBalanceType 為 clb 時，使用該欄位來配置 HTTPS 監聽認證。 CLB 使用 SSL 憑證 ID 的更多資訊，請參見管理憑證（CLB）。	188077086902**_176993d_181437_108724**
CertIds	string	否	ALB 多認證 ID。取值說明如下： LoadBalanceType 為 alb 時，使用該欄位來配置 HTTPS 監聽多認證，多個認證 ID 之間使用逗號分割。 ALB 使用的 SSL 憑證 ID 需要從數位憑證產品擷取。例如配置`756*-cn-hangzhou`，`756*`為產品頁擷取的認證 ID, `-cn-hangzhou`為固定尾碼。更多資訊，請參見管理憑證（ALB）。	87*35-cn-hangzhou,812*3-cn-hangzhou
Description	string	否	路由規則名稱。	ingress-sae-test
ListenerPort	string	否	SLB 監聽連接埠，該連接埠不能被佔用。	443
DefaultRule	string	否	預設轉寄規則。按照 IP 位址，通過指定連接埠轉寄流量到指定應用。參數說明如下： appId：應用 ID。 containerPort：應用執行個體連接埠。說明所有未匹配或不滿足 Rules 轉寄規則的請求都會轉到該指定應用。	{"appId":"395b60e4-0550-458d-9c54-a265d036****","containerPort":8080}
Rules	string	否	轉寄規則。按照網域名稱和請求路徑，通過指定連接埠轉寄流量到指定應用。參數說明如下： appId：應用 ID。 containerPort：應用執行個體連接埠。 domain：網域名稱。 path：請求路徑。	[{"appId":"395b60e4-0550-458d-9c54-a265d036**","containerPort":8080,"domain":"www.sae.site","path":"/path1"},{"appId":"666403ce-d25b-47cf-87fe-497565d2**","containerPort":8080,"domain":"sae.site","path":"/path2"}]
LoadBalanceType	string	否	廢棄參數，已不支援更新。	clb
ListenerProtocol	string	否	請求轉寄協議。取值說明如下： HTTP：適用於需要對資料內容進行識別的應用。 HTTPS：適用於需要加密傳輸的應用。	HTTP
RequestTimeout	integer	否	請求逾時事件，單位秒（s）。	60
SecurityPolicyId	string	否	安全性原則執行個體 ID。	tls_cipher_policy_1_2_strict_with_1_3
IdleTimeout	integer	否	空閑連線逾時時間，單位秒（s）。說明取值為 0，表示使用預設的空閑逾時值。	15
EnableXForwardedFor	boolean	否	是否開啟通過 X-Forwarded-For 頭欄位擷取來訪者用戶端 IP。	true
EnableXForwardedForClientSrcPort	boolean	否	是否通過 X-Forwarded-Port 頭欄位擷取Server Load Balancer執行個體的監聽連接埠。	true
EnableXForwardedForProto	boolean	否	是否通過 X-Forwarded-Proto 頭欄位擷取Server Load Balancer執行個體的監聽協議。	true
EnableXForwardedForSlbId	boolean	否	是否通過 SLB-ID 頭欄位擷取Server Load Balancer執行個體 ID。	true
EnableXForwardedForSlbPort	boolean	否	是否通過 X-Forwarded-Port 頭欄位擷取Server Load Balancer執行個體的監聽連接埠。	true
CorsConfig	string	否	跨網域設定	{\"Enable\":\"true\"}
EnableGzip	boolean	否	是否開啟資料壓縮	true

返回參數

名稱	類型	描述	樣本值
	object	返回資料。
RequestId	string	請求 ID。	91F93257-7A4A-4BD3-9A7E-2F6EAE6D****
Message	string	附加資訊。取值說明如下：請求正常，返回 success。請求異常，返回具體異常錯誤碼。	success
TraceId	string	調用鏈 ID。	0a98a02315955564772843261e****
Data	object	返回結果。
IngressId	integer	路由規則 ID。	87
ErrorCode	string	錯誤碼。取值說明如下：請求成功：不返回 ErrorCode 欄位。請求失敗：返回 ErrorCode 欄位。具體資訊，請參見本文的錯誤碼列表。
Code	string	介面狀態或 POP 錯誤碼。取值說明如下： 2xx：成功。 3xx：重新導向。 4xx：請求錯誤。 5xx：伺服器錯誤。	200
Success	boolean	更新 Ingress 執行個體配置是否成功。取值說明如下： true：更新成功。 false：更新失敗。	true

樣本

正常返回樣本

JSON格式

{
  "RequestId": "91F93257-7A4A-4BD3-9A7E-2F6EAE6D****",
  "Message": "success",
  "TraceId": "0a98a02315955564772843261e****",
  "Data": {
    "IngressId": 87
  },
  "ErrorCode": "",
  "Code": "200",
  "Success": true
}

錯誤碼

HTTP status code	錯誤碼	錯誤資訊	描述
400	InvalidParameter.NotEmpty	You must specify the parameter %s.	不合法的參數：%s不可為空。
400	InvalidParameter.Obviously	The specified parameter is invalid {%s}.	不合法的參數{%s}。
400	InvalidParameter.WithMessage	The parameter is invalid {%s}: %s	不合法的參數{%s}：%s。
400	Exceed.IngressRule	The number of Ingress related rules must be less than or equal to 40.	Ingress配置對應規則不可超過40條。
400	SlbListenerPort.NotAvailable	The SLB listening port is unavailable: slbId [%s], port [%s]	SLB監聽連接埠被佔用：slbId[%s], port[%s]。
400	SSLCert.NotFound	The specified SSL certificate cannot be found.	找不到對應的SSL認證。

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

變更歷史

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