@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/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@alicloud/esa20240910",
3
- "version": "2.5.4",
3
+ "version": "2.5.5",
4
4
  "description": "",
5
5
  "main": "dist/client.js",
6
6
  "scripts": {
package/src/client.ts CHANGED
@@ -4848,6 +4848,8 @@ export class CreateWafRuleResponse extends $tea.Model {
4848
4848
  export class CreateWaitingRoomRequest extends $tea.Model {
4849
4849
  /**
4850
4850
  * @remarks
4851
+ * The name of the custom cookie.
4852
+ *
4851
4853
  * This parameter is required.
4852
4854
  *
4853
4855
  * @example
@@ -4855,18 +4857,36 @@ export class CreateWaitingRoomRequest extends $tea.Model {
4855
4857
  */
4856
4858
  cookieName?: string;
4857
4859
  /**
4860
+ * @remarks
4861
+ * 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.
4862
+ *
4858
4863
  * @example
4859
4864
  * Hello%20world!
4860
4865
  */
4861
4866
  customPageHtml?: string;
4867
+ /**
4868
+ * @remarks
4869
+ * The description of the waiting room.
4870
+ */
4862
4871
  description?: string;
4863
4872
  /**
4873
+ * @remarks
4874
+ * Specifies whether to disable session renewal. Valid values:
4875
+ *
4876
+ * * on
4877
+ * * off
4878
+ *
4864
4879
  * @example
4865
4880
  * on
4866
4881
  */
4867
4882
  disableSessionRenewalEnable?: string;
4868
4883
  /**
4869
4884
  * @remarks
4885
+ * Specifies whether to enable the waiting room. Valid values:
4886
+ *
4887
+ * * on
4888
+ * * off
4889
+ *
4870
4890
  * This parameter is required.
4871
4891
  *
4872
4892
  * @example
@@ -4875,21 +4895,38 @@ export class CreateWaitingRoomRequest extends $tea.Model {
4875
4895
  enable?: string;
4876
4896
  /**
4877
4897
  * @remarks
4898
+ * The hostname and path.
4899
+ *
4878
4900
  * This parameter is required.
4879
4901
  */
4880
4902
  hostNameAndPath?: CreateWaitingRoomRequestHostNameAndPath[];
4881
4903
  /**
4904
+ * @remarks
4905
+ * 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:
4906
+ *
4907
+ * * on
4908
+ * * off
4909
+ *
4882
4910
  * @example
4883
4911
  * on
4884
4912
  */
4885
4913
  jsonResponseEnable?: string;
4886
4914
  /**
4915
+ * @remarks
4916
+ * The language of the waiting room page. You must specify this parameter if you set WaitingRoomType to default. Valid values:
4917
+ *
4918
+ * * enus: English.
4919
+ * * zhcn: Simplified Chinese.
4920
+ * * zhhk: Traditional Chinese.
4921
+ *
4887
4922
  * @example
4888
4923
  * enus
4889
4924
  */
4890
4925
  language?: string;
4891
4926
  /**
4892
4927
  * @remarks
4928
+ * The name of the waiting room.
4929
+ *
4893
4930
  * This parameter is required.
4894
4931
  *
4895
4932
  * @example
@@ -4898,6 +4935,8 @@ export class CreateWaitingRoomRequest extends $tea.Model {
4898
4935
  name?: string;
4899
4936
  /**
4900
4937
  * @remarks
4938
+ * The maximum number of new users per minute.
4939
+ *
4901
4940
  * This parameter is required.
4902
4941
  *
4903
4942
  * @example
@@ -4905,12 +4944,25 @@ export class CreateWaitingRoomRequest extends $tea.Model {
4905
4944
  */
4906
4945
  newUsersPerMinute?: string;
4907
4946
  /**
4947
+ * @remarks
4948
+ * Specifies whether to queue all requests. Valid values:
4949
+ *
4950
+ * * on
4951
+ * * off
4952
+ *
4908
4953
  * @example
4909
4954
  * on
4910
4955
  */
4911
4956
  queueAllEnable?: string;
4912
4957
  /**
4913
4958
  * @remarks
4959
+ * The queuing method. Valid values:
4960
+ *
4961
+ * * random: Users gain access to the origin randomly, regardless of the arrival time.
4962
+ * * fifo: Users gain access to the origin in order of arrival.
4963
+ * * passthrough: Users pass through the waiting room and go straight to the origin.
4964
+ * * reject-all: Users are blocked from reaching the origin.
4965
+ *
4914
4966
  * This parameter is required.
4915
4967
  *
4916
4968
  * @example
@@ -4919,6 +4971,12 @@ export class CreateWaitingRoomRequest extends $tea.Model {
4919
4971
  queuingMethod?: string;
4920
4972
  /**
4921
4973
  * @remarks
4974
+ * The HTTP status code to return while a user is in the queue. Valid values:
4975
+ *
4976
+ * * 200
4977
+ * * 202
4978
+ * * 429
4979
+ *
4922
4980
  * This parameter is required.
4923
4981
  *
4924
4982
  * @example
@@ -4927,6 +4985,8 @@ export class CreateWaitingRoomRequest extends $tea.Model {
4927
4985
  queuingStatusCode?: string;
4928
4986
  /**
4929
4987
  * @remarks
4988
+ * The maximum duration for which a session remains valid after a user leaves the origin. Unit: minutes.
4989
+ *
4930
4990
  * This parameter is required.
4931
4991
  *
4932
4992
  * @example
@@ -4935,6 +4995,8 @@ export class CreateWaitingRoomRequest extends $tea.Model {
4935
4995
  sessionDuration?: string;
4936
4996
  /**
4937
4997
  * @remarks
4998
+ * The website ID, which can be obtained by calling the [ListSites](https://help.aliyun.com/document_detail/2850189.html) operation.
4999
+ *
4938
5000
  * This parameter is required.
4939
5001
  *
4940
5002
  * @example
@@ -4943,6 +5005,8 @@ export class CreateWaitingRoomRequest extends $tea.Model {
4943
5005
  siteId?: number;
4944
5006
  /**
4945
5007
  * @remarks
5008
+ * The maximum number of active users.
5009
+ *
4946
5010
  * This parameter is required.
4947
5011
  *
4948
5012
  * @example
@@ -4951,6 +5015,11 @@ export class CreateWaitingRoomRequest extends $tea.Model {
4951
5015
  totalActiveUsers?: string;
4952
5016
  /**
4953
5017
  * @remarks
5018
+ * The type of the waiting room. Valid values:
5019
+ *
5020
+ * * default
5021
+ * * custom
5022
+ *
4954
5023
  * This parameter is required.
4955
5024
  *
4956
5025
  * @example
@@ -5009,6 +5078,8 @@ export class CreateWaitingRoomRequest extends $tea.Model {
5009
5078
  export class CreateWaitingRoomShrinkRequest extends $tea.Model {
5010
5079
  /**
5011
5080
  * @remarks
5081
+ * The name of the custom cookie.
5082
+ *
5012
5083
  * This parameter is required.
5013
5084
  *
5014
5085
  * @example
@@ -5016,18 +5087,36 @@ export class CreateWaitingRoomShrinkRequest extends $tea.Model {
5016
5087
  */
5017
5088
  cookieName?: string;
5018
5089
  /**
5090
+ * @remarks
5091
+ * 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.
5092
+ *
5019
5093
  * @example
5020
5094
  * Hello%20world!
5021
5095
  */
5022
5096
  customPageHtml?: string;
5097
+ /**
5098
+ * @remarks
5099
+ * The description of the waiting room.
5100
+ */
5023
5101
  description?: string;
5024
5102
  /**
5103
+ * @remarks
5104
+ * Specifies whether to disable session renewal. Valid values:
5105
+ *
5106
+ * * on
5107
+ * * off
5108
+ *
5025
5109
  * @example
5026
5110
  * on
5027
5111
  */
5028
5112
  disableSessionRenewalEnable?: string;
5029
5113
  /**
5030
5114
  * @remarks
5115
+ * Specifies whether to enable the waiting room. Valid values:
5116
+ *
5117
+ * * on
5118
+ * * off
5119
+ *
5031
5120
  * This parameter is required.
5032
5121
  *
5033
5122
  * @example
@@ -5036,21 +5125,38 @@ export class CreateWaitingRoomShrinkRequest extends $tea.Model {
5036
5125
  enable?: string;
5037
5126
  /**
5038
5127
  * @remarks
5128
+ * The hostname and path.
5129
+ *
5039
5130
  * This parameter is required.
5040
5131
  */
5041
5132
  hostNameAndPathShrink?: string;
5042
5133
  /**
5134
+ * @remarks
5135
+ * 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:
5136
+ *
5137
+ * * on
5138
+ * * off
5139
+ *
5043
5140
  * @example
5044
5141
  * on
5045
5142
  */
5046
5143
  jsonResponseEnable?: string;
5047
5144
  /**
5145
+ * @remarks
5146
+ * The language of the waiting room page. You must specify this parameter if you set WaitingRoomType to default. Valid values:
5147
+ *
5148
+ * * enus: English.
5149
+ * * zhcn: Simplified Chinese.
5150
+ * * zhhk: Traditional Chinese.
5151
+ *
5048
5152
  * @example
5049
5153
  * enus
5050
5154
  */
5051
5155
  language?: string;
5052
5156
  /**
5053
5157
  * @remarks
5158
+ * The name of the waiting room.
5159
+ *
5054
5160
  * This parameter is required.
5055
5161
  *
5056
5162
  * @example
@@ -5059,6 +5165,8 @@ export class CreateWaitingRoomShrinkRequest extends $tea.Model {
5059
5165
  name?: string;
5060
5166
  /**
5061
5167
  * @remarks
5168
+ * The maximum number of new users per minute.
5169
+ *
5062
5170
  * This parameter is required.
5063
5171
  *
5064
5172
  * @example
@@ -5066,12 +5174,25 @@ export class CreateWaitingRoomShrinkRequest extends $tea.Model {
5066
5174
  */
5067
5175
  newUsersPerMinute?: string;
5068
5176
  /**
5177
+ * @remarks
5178
+ * Specifies whether to queue all requests. Valid values:
5179
+ *
5180
+ * * on
5181
+ * * off
5182
+ *
5069
5183
  * @example
5070
5184
  * on
5071
5185
  */
5072
5186
  queueAllEnable?: string;
5073
5187
  /**
5074
5188
  * @remarks
5189
+ * The queuing method. Valid values:
5190
+ *
5191
+ * * random: Users gain access to the origin randomly, regardless of the arrival time.
5192
+ * * fifo: Users gain access to the origin in order of arrival.
5193
+ * * passthrough: Users pass through the waiting room and go straight to the origin.
5194
+ * * reject-all: Users are blocked from reaching the origin.
5195
+ *
5075
5196
  * This parameter is required.
5076
5197
  *
5077
5198
  * @example
@@ -5080,6 +5201,12 @@ export class CreateWaitingRoomShrinkRequest extends $tea.Model {
5080
5201
  queuingMethod?: string;
5081
5202
  /**
5082
5203
  * @remarks
5204
+ * The HTTP status code to return while a user is in the queue. Valid values:
5205
+ *
5206
+ * * 200
5207
+ * * 202
5208
+ * * 429
5209
+ *
5083
5210
  * This parameter is required.
5084
5211
  *
5085
5212
  * @example
@@ -5088,6 +5215,8 @@ export class CreateWaitingRoomShrinkRequest extends $tea.Model {
5088
5215
  queuingStatusCode?: string;
5089
5216
  /**
5090
5217
  * @remarks
5218
+ * The maximum duration for which a session remains valid after a user leaves the origin. Unit: minutes.
5219
+ *
5091
5220
  * This parameter is required.
5092
5221
  *
5093
5222
  * @example
@@ -5096,6 +5225,8 @@ export class CreateWaitingRoomShrinkRequest extends $tea.Model {
5096
5225
  sessionDuration?: string;
5097
5226
  /**
5098
5227
  * @remarks
5228
+ * The website ID, which can be obtained by calling the [ListSites](https://help.aliyun.com/document_detail/2850189.html) operation.
5229
+ *
5099
5230
  * This parameter is required.
5100
5231
  *
5101
5232
  * @example
@@ -5104,6 +5235,8 @@ export class CreateWaitingRoomShrinkRequest extends $tea.Model {
5104
5235
  siteId?: number;
5105
5236
  /**
5106
5237
  * @remarks
5238
+ * The maximum number of active users.
5239
+ *
5107
5240
  * This parameter is required.
5108
5241
  *
5109
5242
  * @example
@@ -5112,6 +5245,11 @@ export class CreateWaitingRoomShrinkRequest extends $tea.Model {
5112
5245
  totalActiveUsers?: string;
5113
5246
  /**
5114
5247
  * @remarks
5248
+ * The type of the waiting room. Valid values:
5249
+ *
5250
+ * * default
5251
+ * * custom
5252
+ *
5115
5253
  * This parameter is required.
5116
5254
  *
5117
5255
  * @example
@@ -5169,6 +5307,9 @@ export class CreateWaitingRoomShrinkRequest extends $tea.Model {
5169
5307
 
5170
5308
  export class CreateWaitingRoomResponseBody extends $tea.Model {
5171
5309
  /**
5310
+ * @remarks
5311
+ * The request ID.
5312
+ *
5172
5313
  * @example
5173
5314
  * 85H66C7B-671A-4297-9187-2C4477247A74
5174
5315
  */
@@ -23491,6 +23632,8 @@ export class CreateUserDeliveryTaskRequestSlsDelivery extends $tea.Model {
23491
23632
  export class CreateWaitingRoomRequestHostNameAndPath extends $tea.Model {
23492
23633
  /**
23493
23634
  * @remarks
23635
+ * The domain name.
23636
+ *
23494
23637
  * This parameter is required.
23495
23638
  *
23496
23639
  * @example
@@ -23499,6 +23642,8 @@ export class CreateWaitingRoomRequestHostNameAndPath extends $tea.Model {
23499
23642
  domain?: string;
23500
23643
  /**
23501
23644
  * @remarks
23645
+ * The path.
23646
+ *
23502
23647
  * This parameter is required.
23503
23648
  *
23504
23649
  * @example
@@ -23507,6 +23652,8 @@ export class CreateWaitingRoomRequestHostNameAndPath extends $tea.Model {
23507
23652
  path?: string;
23508
23653
  /**
23509
23654
  * @remarks
23655
+ * The subdomain.
23656
+ *
23510
23657
  * This parameter is required.
23511
23658
  *
23512
23659
  * @example
@@ -23601,6 +23748,7 @@ export class DescribeDDoSAllEventListResponseBodyDataList extends $tea.Model {
23601
23748
  * 800
23602
23749
  */
23603
23750
  bps?: number;
23751
+ coverage?: string;
23604
23752
  /**
23605
23753
  * @example
23606
23754
  * 50
@@ -23616,6 +23764,7 @@ export class DescribeDDoSAllEventListResponseBodyDataList extends $tea.Model {
23616
23764
  * web-cc_1
23617
23765
  */
23618
23766
  eventId?: string;
23767
+ eventResult?: string;
23619
23768
  /**
23620
23769
  * @example
23621
23770
  * web-cc
@@ -23649,9 +23798,11 @@ export class DescribeDDoSAllEventListResponseBodyDataList extends $tea.Model {
23649
23798
  static names(): { [key: string]: string } {
23650
23799
  return {
23651
23800
  bps: 'Bps',
23801
+ coverage: 'Coverage',
23652
23802
  cps: 'Cps',
23653
23803
  endTime: 'EndTime',
23654
23804
  eventId: 'EventId',
23805
+ eventResult: 'EventResult',
23655
23806
  eventType: 'EventType',
23656
23807
  pps: 'Pps',
23657
23808
  qps: 'Qps',
@@ -23664,9 +23815,11 @@ export class DescribeDDoSAllEventListResponseBodyDataList extends $tea.Model {
23664
23815
  static types(): { [key: string]: any } {
23665
23816
  return {
23666
23817
  bps: 'number',
23818
+ coverage: 'string',
23667
23819
  cps: 'number',
23668
23820
  endTime: 'string',
23669
23821
  eventId: 'string',
23822
+ eventResult: 'string',
23670
23823
  eventType: 'string',
23671
23824
  pps: 'number',
23672
23825
  qps: 'number',
@@ -30968,7 +31121,7 @@ export default class Client extends OpenApi {
30968
31121
  }
30969
31122
 
30970
31123
  /**
30971
- * 创建等候室
31124
+ * Creates a waiting room for a website.
30972
31125
  *
30973
31126
  * @param tmpReq - CreateWaitingRoomRequest
30974
31127
  * @param runtime - runtime options for this request RuntimeOptions
@@ -31069,7 +31222,7 @@ export default class Client extends OpenApi {
31069
31222
  }
31070
31223
 
31071
31224
  /**
31072
- * 创建等候室
31225
+ * Creates a waiting room for a website.
31073
31226
  *
31074
31227
  * @param request - CreateWaitingRoomRequest
31075
31228
  * @returns CreateWaitingRoomResponse