使用CreateWaitingRoom API為網站建立等候室-邊緣安全加速-阿里雲

建立網站等候室。

調試

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

調試

授權資訊

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

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

操作

存取層級

資源類型

條件關鍵字

關聯操作

esa:CreateWaitingRoom

create

*Site

acs:esa:{#regionId}:{#accountId}:site/{#SiteId}

無

請求參數

名稱	類型	必填	描述	樣本值
SiteId	integer	是	網站 ID，可通過調用 ListSites 介面擷取。	1234567890123
Enable	string	是	等候室開關。取值： on：開啟。 off：關閉。	on
Name	string	是	等候室名稱。	waitingroom_example
QueueAllEnable	string	否	全部排隊。取值： on：開啟。 off：關閉。	on
HostNameAndPath	array<object>	是	主機名稱和路徑。
	object	是	主機名稱和路徑詳情。
Subdomain	string	是	子網域名稱。	test.
Domain	string	是	網域名稱。	example.com
Path	string	是	路徑。	/test
CookieName	string	是	自訂 Cookie 名稱。	__aliwaitingroom_example
TotalActiveUsers	string	是	活躍使用者總數。	300
NewUsersPerMinute	string	是	每分鐘新使用者數。	200
SessionDuration	string	是	會話期間，單位是分鐘。	5
DisableSessionRenewalEnable	string	否	禁用會話續訂。取值： on：開啟。 off：關閉。	on
QueuingMethod	string	是	排隊方式。取值： random：隨機。 fifo：先進先出。 passthrough：直通。 reject-all：拒絕全部。	fifo
QueuingStatusCode	string	是	等候室狀態代碼。取值： 200 202 429	200
JsonResponseEnable	string	否	JSON 響應。開啟後 accept 要求標頭包含"application/json"會返回 JSON 資料。取值： on：開啟。 off：關閉。	on
Description	string	否	等候室描述。	測試
WaitingRoomType	string	是	等候室類型。支援以下類型： default：預設類型。 custom：自訂類型。	default
CustomPageHtml	string	否	使用者自訂等候室頁面內容，當等候室類型為自訂類型時，需要傳入。傳入的內容需要經過 base64 編碼。	SGVsbG8gd29ybGQ=
Language	string	否	等候室頁面的語言，當等候室類型為預設類型時，需要傳入。支援以下類型： enus：英文。 zhcn：中文簡體。 zhhk：中文繁體。	enus

返回參數

名稱	類型	描述	樣本值
	object
RequestId	string	請求 ID。	85H66C7B-671A-4297-9187-2C4477247A74
WaitingRoomId	string

樣本

正常返回樣本

JSON格式

{
  "RequestId": "85H66C7B-671A-4297-9187-2C4477247A74",
  "WaitingRoomId": ""
}

錯誤碼

HTTP status code	錯誤碼	錯誤資訊	描述
400	InternalException	Failed to call the service. Try again later or contact technical support.	調用服務失敗，請稍後重試或聯絡客服諮詢詳情。
400	InvalidParameter.ArgName	Invalid ArgName. Check your website configuration parameters and make sure that they match the supported features and parameter names listed in the official documentation.	傳入的ArgName無效，請檢查您提供的網站配置參數，確保它們與官方文檔中列出的支援功能及參數名稱相匹配。
400	InvalidParameter.ArgValue	Invalid parameter value. Check whether the value format and length meet the requirements.	參數值無效，請檢查輸入是否符合規定格式及長度限制。
400	MissingParameter	The specified ArgName is required for this function.	配置特定功能時，缺少必傳參數。
400	CompileRuleError	Rule compilation failed, please check the rule information passed in to ensure that the rule is written according to the syntax described in the document.	規則編譯失敗，請檢查傳入的規則配置，請參考介面文檔中描述的規則配置格式。
400	SiteConfigLengthExceedLimit	The overall configuration size of the site exceeds the limit, and the total size of all functional configurations of the site cannot exceed 512K.	網站功能配置大小超出限制，總大小不能超過512K。
400	ConfigConflicts	Configuration conflicts, usually when multiple configurations are configured under the same function of the same site, such as duplicate rule names between multiple configurations.	參數唯一性校正失敗，請檢查重複的參數值。
400	FunctionConflict	The feature configuration conflicts. Sites with version management enabled cannot configure this feature.	當前配置的功能與其它功能存在衝突，如需要配置請先刪除衝突的功能配置。
400	RuleRegexQuotaCheckFailed	When configuring rules, rules with regular expressions are not allowed in this plan. Please check the relevant documentation of the plan or upgrade the plan.	當前套餐不支援配置帶有正則的規則引擎，請查看套餐描述，並升級您的套餐。
400	NestedRuleQuotaCheckFailed	The nesting level of rules allowed by the plan failed to be verified. Please modify the nesting level of rules or upgrade the plan.	規則內嵌子條件數量超過套餐上限，請查看套餐描述，並升級您的套餐。
400	ArgQuotaCheckFailed	The passed-in parameter value failed to verify the validity of the plan. Please check the plan document to obtain the range of parameters that can be configured for the site plan.	當前套餐不支援配置受限參數，請檢查輸入的參數。
400	FunctionQuotaCheckFailed	The quota verification for this function fails. It may be that the configuration of this function exceeds the limit of the site plan. Please check the plan introduction document corresponding to this site.	當前套餐不支援配置受限功能，請檢查套餐相關的功能描述。
400	ConfExceedLimit	The number of function configurations exceeds the limit. Please check the interface document to see the number of configurations that can be supported by a single function.	當前功能的配置項數量已經超過系統設定的上限。
400	ServiceInvokeFailed	The call to the internal service failed. The engineer is resolving the problem. Please wait a moment before trying, or contact customer service for details.	調用服務失敗，請稍後重試或聯絡客服諮詢詳情。
400	Instance.NotOnline	Your plan is unavailable due to an overdue payment. Complete the payment first.	您的套餐執行個體因欠費當前處於非上線狀態，請先完成續約操作以繼續使用。
400	InstanceNotExist	The instance does not exist. Check whether the specified instance ID is correct or whether the instance belongs to your account.	執行個體不存在，請檢查提供的執行個體ID是否正確或該執行個體是否屬於您的賬戶。
400	LockFailed	The system is handling requests you previously submitted. Try again later.	您有其他請求正在處理中，請稍後再進行重試。
404	SiteNotFound	The website does not exist or does not belong to you.	網站不存在，或者不屬於你。

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

變更歷史

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