@alicloud/esa20240910 2.5.4 → 2.5.5

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/dist/client.d.ts CHANGED
@@ -3285,6 +3285,8 @@ export declare class CreateWafRuleResponse extends $tea.Model {
3285
3285
  export declare class CreateWaitingRoomRequest extends $tea.Model {
3286
3286
  /**
3287
3287
  * @remarks
3288
+ * The name of the custom cookie.
3289
+ *
3288
3290
  * This parameter is required.
3289
3291
  *
3290
3292
  * @example
@@ -3292,18 +3294,36 @@ export declare class CreateWaitingRoomRequest extends $tea.Model {
3292
3294
  */
3293
3295
  cookieName?: string;
3294
3296
  /**
3297
+ * @remarks
3298
+ * The content of the custom waiting room page. You must specify this parameter if you set WaitingRoomType to custom. The content must be Base64-encoded.
3299
+ *
3295
3300
  * @example
3296
3301
  * Hello%20world!
3297
3302
  */
3298
3303
  customPageHtml?: string;
3304
+ /**
3305
+ * @remarks
3306
+ * The description of the waiting room.
3307
+ */
3299
3308
  description?: string;
3300
3309
  /**
3310
+ * @remarks
3311
+ * Specifies whether to disable session renewal. Valid values:
3312
+ *
3313
+ * * on
3314
+ * * off
3315
+ *
3301
3316
  * @example
3302
3317
  * on
3303
3318
  */
3304
3319
  disableSessionRenewalEnable?: string;
3305
3320
  /**
3306
3321
  * @remarks
3322
+ * Specifies whether to enable the waiting room. Valid values:
3323
+ *
3324
+ * * on
3325
+ * * off
3326
+ *
3307
3327
  * This parameter is required.
3308
3328
  *
3309
3329
  * @example
@@ -3312,21 +3332,38 @@ export declare class CreateWaitingRoomRequest extends $tea.Model {
3312
3332
  enable?: string;
3313
3333
  /**
3314
3334
  * @remarks
3335
+ * The hostname and path.
3336
+ *
3315
3337
  * This parameter is required.
3316
3338
  */
3317
3339
  hostNameAndPath?: CreateWaitingRoomRequestHostNameAndPath[];
3318
3340
  /**
3341
+ * @remarks
3342
+ * Specifies whether to enable JSON response. If you set this parameter to on, a JSON body is returned for requests to the waiting room with the header Accept: application/json. Valid values:
3343
+ *
3344
+ * * on
3345
+ * * off
3346
+ *
3319
3347
  * @example
3320
3348
  * on
3321
3349
  */
3322
3350
  jsonResponseEnable?: string;
3323
3351
  /**
3352
+ * @remarks
3353
+ * The language of the waiting room page. You must specify this parameter if you set WaitingRoomType to default. Valid values:
3354
+ *
3355
+ * * enus: English.
3356
+ * * zhcn: Simplified Chinese.
3357
+ * * zhhk: Traditional Chinese.
3358
+ *
3324
3359
  * @example
3325
3360
  * enus
3326
3361
  */
3327
3362
  language?: string;
3328
3363
  /**
3329
3364
  * @remarks
3365
+ * The name of the waiting room.
3366
+ *
3330
3367
  * This parameter is required.
3331
3368
  *
3332
3369
  * @example
@@ -3335,6 +3372,8 @@ export declare class CreateWaitingRoomRequest extends $tea.Model {
3335
3372
  name?: string;
3336
3373
  /**
3337
3374
  * @remarks
3375
+ * The maximum number of new users per minute.
3376
+ *
3338
3377
  * This parameter is required.
3339
3378
  *
3340
3379
  * @example
@@ -3342,12 +3381,25 @@ export declare class CreateWaitingRoomRequest extends $tea.Model {
3342
3381
  */
3343
3382
  newUsersPerMinute?: string;
3344
3383
  /**
3384
+ * @remarks
3385
+ * Specifies whether to queue all requests. Valid values:
3386
+ *
3387
+ * * on
3388
+ * * off
3389
+ *
3345
3390
  * @example
3346
3391
  * on
3347
3392
  */
3348
3393
  queueAllEnable?: string;
3349
3394
  /**
3350
3395
  * @remarks
3396
+ * The queuing method. Valid values:
3397
+ *
3398
+ * * random: Users gain access to the origin randomly, regardless of the arrival time.
3399
+ * * fifo: Users gain access to the origin in order of arrival.
3400
+ * * passthrough: Users pass through the waiting room and go straight to the origin.
3401
+ * * reject-all: Users are blocked from reaching the origin.
3402
+ *
3351
3403
  * This parameter is required.
3352
3404
  *
3353
3405
  * @example
@@ -3356,6 +3408,12 @@ export declare class CreateWaitingRoomRequest extends $tea.Model {
3356
3408
  queuingMethod?: string;
3357
3409
  /**
3358
3410
  * @remarks
3411
+ * The HTTP status code to return while a user is in the queue. Valid values:
3412
+ *
3413
+ * * 200
3414
+ * * 202
3415
+ * * 429
3416
+ *
3359
3417
  * This parameter is required.
3360
3418
  *
3361
3419
  * @example
@@ -3364,6 +3422,8 @@ export declare class CreateWaitingRoomRequest extends $tea.Model {
3364
3422
  queuingStatusCode?: string;
3365
3423
  /**
3366
3424
  * @remarks
3425
+ * The maximum duration for which a session remains valid after a user leaves the origin. Unit: minutes.
3426
+ *
3367
3427
  * This parameter is required.
3368
3428
  *
3369
3429
  * @example
@@ -3372,6 +3432,8 @@ export declare class CreateWaitingRoomRequest extends $tea.Model {
3372
3432
  sessionDuration?: string;
3373
3433
  /**
3374
3434
  * @remarks
3435
+ * The website ID, which can be obtained by calling the [ListSites](https://help.aliyun.com/document_detail/2850189.html) operation.
3436
+ *
3375
3437
  * This parameter is required.
3376
3438
  *
3377
3439
  * @example
@@ -3380,6 +3442,8 @@ export declare class CreateWaitingRoomRequest extends $tea.Model {
3380
3442
  siteId?: number;
3381
3443
  /**
3382
3444
  * @remarks
3445
+ * The maximum number of active users.
3446
+ *
3383
3447
  * This parameter is required.
3384
3448
  *
3385
3449
  * @example
@@ -3388,6 +3452,11 @@ export declare class CreateWaitingRoomRequest extends $tea.Model {
3388
3452
  totalActiveUsers?: string;
3389
3453
  /**
3390
3454
  * @remarks
3455
+ * The type of the waiting room. Valid values:
3456
+ *
3457
+ * * default
3458
+ * * custom
3459
+ *
3391
3460
  * This parameter is required.
3392
3461
  *
3393
3462
  * @example
@@ -3407,6 +3476,8 @@ export declare class CreateWaitingRoomRequest extends $tea.Model {
3407
3476
  export declare class CreateWaitingRoomShrinkRequest extends $tea.Model {
3408
3477
  /**
3409
3478
  * @remarks
3479
+ * The name of the custom cookie.
3480
+ *
3410
3481
  * This parameter is required.
3411
3482
  *
3412
3483
  * @example
@@ -3414,18 +3485,36 @@ export declare class CreateWaitingRoomShrinkRequest extends $tea.Model {
3414
3485
  */
3415
3486
  cookieName?: string;
3416
3487
  /**
3488
+ * @remarks
3489
+ * The content of the custom waiting room page. You must specify this parameter if you set WaitingRoomType to custom. The content must be Base64-encoded.
3490
+ *
3417
3491
  * @example
3418
3492
  * Hello%20world!
3419
3493
  */
3420
3494
  customPageHtml?: string;
3495
+ /**
3496
+ * @remarks
3497
+ * The description of the waiting room.
3498
+ */
3421
3499
  description?: string;
3422
3500
  /**
3501
+ * @remarks
3502
+ * Specifies whether to disable session renewal. Valid values:
3503
+ *
3504
+ * * on
3505
+ * * off
3506
+ *
3423
3507
  * @example
3424
3508
  * on
3425
3509
  */
3426
3510
  disableSessionRenewalEnable?: string;
3427
3511
  /**
3428
3512
  * @remarks
3513
+ * Specifies whether to enable the waiting room. Valid values:
3514
+ *
3515
+ * * on
3516
+ * * off
3517
+ *
3429
3518
  * This parameter is required.
3430
3519
  *
3431
3520
  * @example
@@ -3434,21 +3523,38 @@ export declare class CreateWaitingRoomShrinkRequest extends $tea.Model {
3434
3523
  enable?: string;
3435
3524
  /**
3436
3525
  * @remarks
3526
+ * The hostname and path.
3527
+ *
3437
3528
  * This parameter is required.
3438
3529
  */
3439
3530
  hostNameAndPathShrink?: string;
3440
3531
  /**
3532
+ * @remarks
3533
+ * Specifies whether to enable JSON response. If you set this parameter to on, a JSON body is returned for requests to the waiting room with the header Accept: application/json. Valid values:
3534
+ *
3535
+ * * on
3536
+ * * off
3537
+ *
3441
3538
  * @example
3442
3539
  * on
3443
3540
  */
3444
3541
  jsonResponseEnable?: string;
3445
3542
  /**
3543
+ * @remarks
3544
+ * The language of the waiting room page. You must specify this parameter if you set WaitingRoomType to default. Valid values:
3545
+ *
3546
+ * * enus: English.
3547
+ * * zhcn: Simplified Chinese.
3548
+ * * zhhk: Traditional Chinese.
3549
+ *
3446
3550
  * @example
3447
3551
  * enus
3448
3552
  */
3449
3553
  language?: string;
3450
3554
  /**
3451
3555
  * @remarks
3556
+ * The name of the waiting room.
3557
+ *
3452
3558
  * This parameter is required.
3453
3559
  *
3454
3560
  * @example
@@ -3457,6 +3563,8 @@ export declare class CreateWaitingRoomShrinkRequest extends $tea.Model {
3457
3563
  name?: string;
3458
3564
  /**
3459
3565
  * @remarks
3566
+ * The maximum number of new users per minute.
3567
+ *
3460
3568
  * This parameter is required.
3461
3569
  *
3462
3570
  * @example
@@ -3464,12 +3572,25 @@ export declare class CreateWaitingRoomShrinkRequest extends $tea.Model {
3464
3572
  */
3465
3573
  newUsersPerMinute?: string;
3466
3574
  /**
3575
+ * @remarks
3576
+ * Specifies whether to queue all requests. Valid values:
3577
+ *
3578
+ * * on
3579
+ * * off
3580
+ *
3467
3581
  * @example
3468
3582
  * on
3469
3583
  */
3470
3584
  queueAllEnable?: string;
3471
3585
  /**
3472
3586
  * @remarks
3587
+ * The queuing method. Valid values:
3588
+ *
3589
+ * * random: Users gain access to the origin randomly, regardless of the arrival time.
3590
+ * * fifo: Users gain access to the origin in order of arrival.
3591
+ * * passthrough: Users pass through the waiting room and go straight to the origin.
3592
+ * * reject-all: Users are blocked from reaching the origin.
3593
+ *
3473
3594
  * This parameter is required.
3474
3595
  *
3475
3596
  * @example
@@ -3478,6 +3599,12 @@ export declare class CreateWaitingRoomShrinkRequest extends $tea.Model {
3478
3599
  queuingMethod?: string;
3479
3600
  /**
3480
3601
  * @remarks
3602
+ * The HTTP status code to return while a user is in the queue. Valid values:
3603
+ *
3604
+ * * 200
3605
+ * * 202
3606
+ * * 429
3607
+ *
3481
3608
  * This parameter is required.
3482
3609
  *
3483
3610
  * @example
@@ -3486,6 +3613,8 @@ export declare class CreateWaitingRoomShrinkRequest extends $tea.Model {
3486
3613
  queuingStatusCode?: string;
3487
3614
  /**
3488
3615
  * @remarks
3616
+ * The maximum duration for which a session remains valid after a user leaves the origin. Unit: minutes.
3617
+ *
3489
3618
  * This parameter is required.
3490
3619
  *
3491
3620
  * @example
@@ -3494,6 +3623,8 @@ export declare class CreateWaitingRoomShrinkRequest extends $tea.Model {
3494
3623
  sessionDuration?: string;
3495
3624
  /**
3496
3625
  * @remarks
3626
+ * The website ID, which can be obtained by calling the [ListSites](https://help.aliyun.com/document_detail/2850189.html) operation.
3627
+ *
3497
3628
  * This parameter is required.
3498
3629
  *
3499
3630
  * @example
@@ -3502,6 +3633,8 @@ export declare class CreateWaitingRoomShrinkRequest extends $tea.Model {
3502
3633
  siteId?: number;
3503
3634
  /**
3504
3635
  * @remarks
3636
+ * The maximum number of active users.
3637
+ *
3505
3638
  * This parameter is required.
3506
3639
  *
3507
3640
  * @example
@@ -3510,6 +3643,11 @@ export declare class CreateWaitingRoomShrinkRequest extends $tea.Model {
3510
3643
  totalActiveUsers?: string;
3511
3644
  /**
3512
3645
  * @remarks
3646
+ * The type of the waiting room. Valid values:
3647
+ *
3648
+ * * default
3649
+ * * custom
3650
+ *
3513
3651
  * This parameter is required.
3514
3652
  *
3515
3653
  * @example
@@ -3528,6 +3666,9 @@ export declare class CreateWaitingRoomShrinkRequest extends $tea.Model {
3528
3666
  }
3529
3667
  export declare class CreateWaitingRoomResponseBody extends $tea.Model {
3530
3668
  /**
3669
+ * @remarks
3670
+ * The request ID.
3671
+ *
3531
3672
  * @example
3532
3673
  * 85H66C7B-671A-4297-9187-2C4477247A74
3533
3674
  */
@@ -16016,6 +16157,8 @@ export declare class CreateUserDeliveryTaskRequestSlsDelivery extends $tea.Model
16016
16157
  export declare class CreateWaitingRoomRequestHostNameAndPath extends $tea.Model {
16017
16158
  /**
16018
16159
  * @remarks
16160
+ * The domain name.
16161
+ *
16019
16162
  * This parameter is required.
16020
16163
  *
16021
16164
  * @example
@@ -16024,6 +16167,8 @@ export declare class CreateWaitingRoomRequestHostNameAndPath extends $tea.Model
16024
16167
  domain?: string;
16025
16168
  /**
16026
16169
  * @remarks
16170
+ * The path.
16171
+ *
16027
16172
  * This parameter is required.
16028
16173
  *
16029
16174
  * @example
@@ -16032,6 +16177,8 @@ export declare class CreateWaitingRoomRequestHostNameAndPath extends $tea.Model
16032
16177
  path?: string;
16033
16178
  /**
16034
16179
  * @remarks
16180
+ * The subdomain.
16181
+ *
16035
16182
  * This parameter is required.
16036
16183
  *
16037
16184
  * @example
@@ -16096,6 +16243,7 @@ export declare class DescribeDDoSAllEventListResponseBodyDataList extends $tea.M
16096
16243
  * 800
16097
16244
  */
16098
16245
  bps?: number;
16246
+ coverage?: string;
16099
16247
  /**
16100
16248
  * @example
16101
16249
  * 50
@@ -16111,6 +16259,7 @@ export declare class DescribeDDoSAllEventListResponseBodyDataList extends $tea.M
16111
16259
  * web-cc_1
16112
16260
  */
16113
16261
  eventId?: string;
16262
+ eventResult?: string;
16114
16263
  /**
16115
16264
  * @example
16116
16265
  * web-cc
@@ -20145,7 +20294,7 @@ export default class Client extends OpenApi {
20145
20294
  */
20146
20295
  createWafRule(request: CreateWafRuleRequest): Promise<CreateWafRuleResponse>;
20147
20296
  /**
20148
- * 创建等候室
20297
+ * Creates a waiting room for a website.
20149
20298
  *
20150
20299
  * @param tmpReq - CreateWaitingRoomRequest
20151
20300
  * @param runtime - runtime options for this request RuntimeOptions
@@ -20153,7 +20302,7 @@ export default class Client extends OpenApi {
20153
20302
  */
20154
20303
  createWaitingRoomWithOptions(tmpReq: CreateWaitingRoomRequest, runtime: $Util.RuntimeOptions): Promise<CreateWaitingRoomResponse>;
20155
20304
  /**
20156
- * 创建等候室
20305
+ * Creates a waiting room for a website.
20157
20306
  *
20158
20307
  * @param request - CreateWaitingRoomRequest
20159
20308
  * @returns CreateWaitingRoomResponse
package/dist/client.js CHANGED
@@ -13583,9 +13583,11 @@ class DescribeDDoSAllEventListResponseBodyDataList extends $tea.Model {
13583
13583
  static names() {
13584
13584
  return {
13585
13585
  bps: 'Bps',
13586
+ coverage: 'Coverage',
13586
13587
  cps: 'Cps',
13587
13588
  endTime: 'EndTime',
13588
13589
  eventId: 'EventId',
13590
+ eventResult: 'EventResult',
13589
13591
  eventType: 'EventType',
13590
13592
  pps: 'Pps',
13591
13593
  qps: 'Qps',
@@ -13597,9 +13599,11 @@ class DescribeDDoSAllEventListResponseBodyDataList extends $tea.Model {
13597
13599
  static types() {
13598
13600
  return {
13599
13601
  bps: 'number',
13602
+ coverage: 'string',
13600
13603
  cps: 'number',
13601
13604
  endTime: 'string',
13602
13605
  eventId: 'string',
13606
+ eventResult: 'string',
13603
13607
  eventType: 'string',
13604
13608
  pps: 'number',
13605
13609
  qps: 'number',
@@ -17967,7 +17971,7 @@ class Client extends openapi_client_1.default {
17967
17971
  return await this.createWafRuleWithOptions(request, runtime);
17968
17972
  }
17969
17973
  /**
17970
- * 创建等候室
17974
+ * Creates a waiting room for a website.
17971
17975
  *
17972
17976
  * @param tmpReq - CreateWaitingRoomRequest
17973
17977
  * @param runtime - runtime options for this request RuntimeOptions
@@ -18049,7 +18053,7 @@ class Client extends openapi_client_1.default {
18049
18053
  return $tea.cast(await this.callApi(params, req, runtime), new CreateWaitingRoomResponse({}));
18050
18054
  }
18051
18055
  /**
18052
- * 创建等候室
18056
+ * Creates a waiting room for a website.
18053
18057
  *
18054
18058
  * @param request - CreateWaitingRoomRequest
18055
18059
  * @returns CreateWaitingRoomResponse