CreateWaitingRoomEvent_边缘安全加速_API文档

插件下载了解更多
VS Code 插件
安装插件之前,确保已安装 VS Code安装插件之前,确保已安装 VS Code
Alibaba Cloud Developer Toolkit is a collection of extensions that can help access Alibaba Cloud services in Visual Studio Code.
JetBrains 插件
安装插件之前,确保已安装 JetBrains IDE安装插件之前,确保已安装 JetBrains IDE
The Alibaba Cloud Developer Toolkit for JetBrains makes it easier to access Alibaba Cloud services.

流控信息

请求速率为30/1(s)。

授权信息

如下是此API对应的授权信息,用于RAM权限策略语句的Action元素中,为RAM用户或RAM角色授予调用此API的权限。请通过 RAM 访问控制设置,使用方法可参考访问控制帮助文档

具体说明如下:展开详情

操作访问级别资源类型条件关键字关联操作
esa:CreateWaitingRoomEvent
Create
Site
acs:esa:{#regionId}:{#accountId}:site/{#SiteId}

请求参数

字段名称字段详情
SiteIdinteger<int64>

站点 ID,可通过调用 ListSites 接口获取。

注意 该字段类型为 Long,在序列化/反序列化的过程中可能导致精度丢失,请注意数值不得大于 9007199254740991。
示例值:123456****参考取值来源:
    ListSites
    CreateSite
WaitingRoomIdstring

等候室 ID,可通过调用 ListWaitingRooms 接口获取。

示例值:6a51d5bc6460887abd1291dc7d4db28b参考取值来源:
    ListWaitingRooms
    CreateWaitingRoom
Enablestring

等候室开关。取值:展开详情

示例值:on枚举值:onoff
Namestring

等候室事件名称。

示例值:waitingroom_example
TotalActiveUsersstring

活跃用户总数。

示例值:100
NewUsersPerMinutestring

每分钟新用户数。

示例值:10
SessionDurationstring

会话持续时间,单位是分钟。

示例值:5
DisableSessionRenewalEnablestring

禁用会话续订。取值:展开详情

示例值:on枚举值:onoff
QueuingMethodstring

排队方式。取值:展开详情

示例值:random枚举值:fiforandompassthroughreject-all
QueuingStatusCodestring

等候室状态码。取值:展开详情

示例值:202枚举值:200202429
JsonResponseEnablestring

JSON 响应。开启后 accept 请求头包含"application/json"会返回 JSON 数据。取值:展开详情

示例值:on枚举值:onoff
Descriptionstring

等候室描述。

示例值:测试等候室
WaitingRoomTypestring

等候室类型。支持以下类型:展开详情

示例值:default枚举值:defaultcustom参考取值来源:
    CreateWaitingRoom
    ListWaitingRooms
CustomPageHtmlstring

用户自定义等候室页面内容,当等候室类型为自定义类型时,需要传入。传入的内容需要经过 base64 编码。

示例值:SGVsbG8gd29ybGQ=
StartTimestring

事件开始时间戳。

示例值:1719763200
EndTimestring

事件结束时间戳。

示例值:1719849600
PreQueueEnablestring

预排队开关。展开详情

示例值:on枚举值:onoff
PreQueueStartTimestring

预排队开始时间。

示例值:1719763200
RandomPreQueueEnablestring

随机排队开关。展开详情

示例值:on枚举值:onoff
Languagestring

等候室页面的语言,当等候室类型为默认类型时,需要传入。支持以下类型:展开详情

示例值:zhcn枚举值:enuszhcnzhhk

返回参数

字段名称字段详情
RequestIdstring

请求 ID。

示例值:15C66C7B-671A-4297-9187-2C4477247A123425345
WaitingRoomEventIdinteger<int64>
注意 请注意,该值为 Long 类型,在某些语言中可能存在精度丢失的风险,请小心使用。

返回示例

错误码

全局错误码
HTTP 状态码错误码错误信息操作
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.诊断
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
MissingParameter
The specified ArgName is required for this function.诊断
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.诊断
400
InvalidParameter.ArgValue
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.诊断
400
LockFailed
The system is handling requests you previously submitted. Try again later.诊断
400
Instance.NotOnline
Your plan is unavailable due to an overdue payment. Complete the payment first.诊断
404
SiteNotFound
The website does not exist or does not belong to you.诊断

变更历史

变更时间变更内容概要操作
2025-02-12
变更返回参数

相关示例