Updates the configuration of a specified waiting room.
Try it now
Test
RAM authorization
Request parameters
|
Parameter |
Type |
Required |
Description |
Example |
| SiteId |
integer |
Yes |
The site ID, which can be obtained by calling the ListSites operation. |
7096621098**** |
| WaitingRoomId |
string |
Yes |
The waiting room ID, which can be obtained by calling the ListWaitingRooms operation. |
6a51d5bc6460887abd129**** |
| Enable |
string |
No |
The status of the waiting room. Valid values:
|
on |
| Name |
string |
No |
The name of the waiting room. |
holiday-promotion-waiting-room |
| QueueAllEnable |
string |
No |
Specifies whether to queue all visitors. Valid values:
|
on |
| HostNameAndPath |
array<object> |
No |
The hostname and path configurations. |
|
|
object |
No |
The hostname and path details. |
||
| Subdomain |
string |
No |
The subdomain. |
test. |
| Domain |
string |
No |
The domain name. |
example.com |
| Path |
string |
No |
The path. |
/test |
| CookieName |
string |
No |
The custom cookie name. |
__aliwaitingroom_example |
| TotalActiveUsers |
string |
No |
The total number of active users. |
300 |
| NewUsersPerMinute |
string |
No |
The number of new users per minute. |
200 |
| SessionDuration |
string |
No |
The session duration in minutes. |
5 |
| DisableSessionRenewalEnable |
string |
No |
Specifies whether to disable session renewal. Valid values:
|
on |
| QueuingMethod |
string |
No |
The queuing method. Valid values:
|
random |
| QueuingStatusCode |
string |
No |
The status code returned by the waiting room. Valid values:
|
200 |
| JsonResponseEnable |
string |
No |
Specifies whether to enable JSON response. If enabled, requests with an Accept header containing "application/json" return JSON data. Valid values:
|
on |
| Description |
string |
No |
The description of the waiting room. |
Special event queue page |
| WaitingRoomType |
string |
No |
The type of the waiting room. Valid values:
|
default |
| CustomPageHtml |
string |
No |
The custom waiting room page content. This parameter is required when the waiting room type is set to custom. The content must be in Base64 encoding. |
SGVsbG8gd29ybGQ= |
| Language |
string |
No |
The language of the waiting room page. This parameter is required when the waiting room type is set to default. Valid values:
|
zhcn |
Response elements
|
Element |
Type |
Description |
Example |
|
object |
|||
| RequestId |
string |
The request ID. |
0195619f-eab3-4a66-ac00-ed53d913e72e |
Examples
Success response
JSON format
{
"RequestId": "0195619f-eab3-4a66-ac00-ed53d913e72e"
}Error codes
|
HTTP status code |
Error code |
Error message |
Description |
|---|---|---|---|
| 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. | Rule compilation failed. Check the incoming rule configuration. For details, see the rule configuration format described in the interface 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. | The size of the site configuration exceeds the limit, and the total size cannot exceed 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. | The parameter uniqueness check failed. Check for duplicate parameter values. |
| 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. | The current plan does not support the configuration of a rule engine with a regular expression. Please check the plan description and upgrade your 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. | The number of embedded sub-conditions in the rule exceeds the plan limit. Please check the plan description and upgrade your plan. |
| 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. | Failed to call the service. Please try again later or contact customer service for details. |
| 400 | FunctionConflict | The feature configuration conflicts. Sites with version management enabled cannot configure this feature. | The currently configured function conflicts with other functions. If you need to configure, delete the conflicting function configurations first. |
| 400 | InternalException | Failed to call the service. Try again later or contact technical support. | 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. | Invalid ArgName. Check your website configuration parameters and make sure that they match the supported features and parameter names listed in the official documentation. |
| 400 | InvalidParameter.ArgValue | Invalid parameter value. Check whether the value format and length meet the requirements. | Invalid parameter value. Check whether the value format and length meet the requirements. |
| 400 | InstanceNotExist | The instance does not exist. Check whether the specified instance ID is correct or whether the instance belongs to your account. | The instance does not exist. Check whether the specified instance ID is correct or whether the instance belongs to your account. |
| 400 | LockFailed | The system is handling requests you previously submitted. Try again later. | The system is handling requests you previously submitted. Try again later. |
| 400 | WaitingRoomNotExist | The waiting room that you want to modify does not exist or does not belong to you. Confirm and try again. | The waiting room that you want to modify does not exist or does not belong to you. Confirm and try again. |
| 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. | The current plan does not support the configuration of restricted functions, please check the plan related function description. |
| 400 | QuotaCheckFailed.FunctionArg | The specified feature parameter is not allowed in your plan, or the feature parameter configurations have reached the upper limit in your plan. | The specified feature parameter is not allowed in your plan, or the feature parameter configurations have reached the upper limit in your plan. |
| 404 | SiteNotFound | The website does not exist or does not belong to you. | The website does not exist or does not belong to you. |
See Error Codes for a complete list.
Release notes
See Release Notes for a complete list.