Membuat ruang tunggu untuk sebuah situs web.
Coba sekarang
Test
RAM authorization
Parameter permintaan
|
Parameter |
Type |
Required |
Description |
Example |
| SiteId |
integer |
Yes |
ID situs, yang dapat diperoleh dengan memanggil operasi ListSites. |
1234567890123 |
| Enable |
string |
Yes |
Apakah akan mengaktifkan ruang tunggu. Nilai valid:
Valid values:
|
on |
| Name |
string |
Yes |
Nama ruang tunggu. |
waitingroom_example |
| QueueAllEnable |
string |
No |
Apakah akan menempatkan semua pengunjung dalam Antrian. Nilai valid:
Valid values:
|
on |
| HostNameAndPath |
array<object> |
Yes |
Konfigurasi hostname dan path. |
|
|
object |
Yes |
Detail hostname dan path. |
||
| Subdomain |
string |
Yes |
Subdomain. |
test. |
| Domain |
string |
Yes |
Nama domain. |
example.com |
| Path |
string |
Yes |
Path. |
/test |
| CookieName |
string |
Yes |
Nama cookie kustom. |
__aliwaitingroom_example |
| TotalActiveUsers |
string |
Yes |
Jumlah total pengguna aktif. |
300 |
| NewUsersPerMinute |
string |
Yes |
Jumlah pengguna baru per menit. |
200 |
| SessionDuration |
string |
Yes |
Durasi sesi, dalam menit. |
5 |
| DisableSessionRenewalEnable |
string |
No |
Apakah akan menonaktifkan pembaruan sesi. Nilai valid:
Valid values:
|
on |
| QueuingMethod |
string |
Yes |
Metode antrian. Nilai valid:
Valid values:
|
fifo |
| QueuingStatusCode |
string |
Yes |
Kode status ruang tunggu. Nilai valid:
|
200 |
| JsonResponseEnable |
string |
No |
Apakah akan mengaktifkan tanggapan JSON. Saat diaktifkan, permintaan dengan Header Accept yang berisi "aplikasi/json" akan mengembalikan data JSON. Nilai valid:
Valid values:
|
on |
| Description |
string |
No |
Deskripsi ruang tunggu. |
test |
| WaitingRoomType |
string |
Yes |
Tipe ruang tunggu. Nilai valid:
Valid values:
|
default |
| CustomPageHtml |
string |
No |
Konten halaman ruang tunggu kustom. Parameter ini wajib diisi ketika tipe ruang tunggu diatur ke custom. Konten harus dienkode Base64. |
SGVsbG8gd29ybGQ= |
| Language |
string |
No |
Bahasa halaman ruang tunggu. Parameter ini wajib diisi ketika tipe ruang tunggu diatur ke default. Nilai valid:
Valid values:
|
enus |
Elemen respons
|
Element |
Type |
Description |
Example |
|
object |
|||
| RequestId |
string |
ID permintaan. |
85H66C7B-671A-4297-9187-2C4477247A74 |
| WaitingRoomId |
string |
ID ruang tunggu. |
8527e8405ac25bfb7fb7ca0d12b0ed83 |
Contoh
Respons sukses
JSONformat
{
"RequestId": "85H66C7B-671A-4297-9187-2C4477247A74",
"WaitingRoomId": "8527e8405ac25bfb7fb7ca0d12b0ed83"
}Kode kesalahan
|
HTTP status code |
Error code |
Error message |
Description |
|---|---|---|---|
| 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. | The ArgName parameter is invalid. 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. | The parameter value is invalid. Check whether the value format and length meet the requirements. |
| 400 | MissingParameter | The specified ArgName is required for this function. | A required parameter is missing when configuring a specific 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. | Rule compilation failed. Check the rule configuration and make sure that the rule follows 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. | The overall configuration size of the site exceeds the limit. The total size of all functional configurations of the site cannot exceed 512 KB. |
| 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. | Parameter uniqueness verification failed. Check for duplicate parameter values. |
| 400 | FunctionConflict | The feature configuration conflicts. Sites with version management enabled cannot configure this feature. | The feature configuration conflicts with other features. Delete the conflicting feature configuration before configuring 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. | The current plan does not support configuring rules with regular expressions. 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 nesting level of rules exceeds the limit allowed by the plan. Modify the nesting level of rules or upgrade your 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. | The current plan does not support configuring restricted parameters. Check the input parameters. |
| 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 configuring restricted features. Check the feature description of the plan. |
| 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. | The number of function configurations exceeds the system limit. Check the API documentation for the number of configurations 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. | Failed to call the service. Try again later or contact technical support. |
| 400 | Instance.NotOnline | Your plan is unavailable due to an overdue payment. Complete the payment first. | Your plan instance is unavailable due to an overdue payment. Complete the payment first to continue using the service. |
| 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. |
| 404 | SiteNotFound | The website does not exist or does not belong to you. | The website does not exist or does not belong to you. |
Lihat Error Codes untuk daftar lengkap.
Catatan rilis
Lihat Release Notes untuk daftar lengkap.