tencentcloud-sdk-nodejs 4.0.414 → 4.0.417

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.
Files changed (140) hide show
  1. package/CHANGELOG.md +881 -0
  2. package/SERVICE_CHANGELOG.md +1035 -17
  3. package/package.json +1 -1
  4. package/products.md +36 -36
  5. package/src/common/sdk_version.ts +1 -1
  6. package/src/services/ams/v20201229/ams_client.ts +13 -11
  7. package/src/services/ams/v20201229/ams_models.ts +69 -15
  8. package/src/services/as/v20180419/as_models.ts +18 -0
  9. package/src/services/billing/v20180709/billing_models.ts +49 -0
  10. package/src/services/cat/v20180409/cat_models.ts +4 -4
  11. package/src/services/cbs/v20170312/cbs_models.ts +5 -5
  12. package/src/services/ccc/v20200210/ccc_client.ts +0 -14
  13. package/src/services/ccc/v20200210/ccc_models.ts +25 -40
  14. package/src/services/ckafka/v20190819/ckafka_models.ts +10 -0
  15. package/src/services/cls/v20201016/cls_models.ts +17 -1
  16. package/src/services/cpdp/v20190820/cpdp_client.ts +1 -0
  17. package/src/services/cpdp/v20190820/cpdp_models.ts +20 -0
  18. package/src/services/ess/v20201111/ess_client.ts +32 -16
  19. package/src/services/ess/v20201111/ess_models.ts +67 -8
  20. package/src/services/essbasic/v20210526/essbasic_client.ts +31 -16
  21. package/src/services/essbasic/v20210526/essbasic_models.ts +83 -32
  22. package/src/services/faceid/v20180301/faceid_models.ts +1 -1
  23. package/src/services/gme/v20180711/gme_client.ts +179 -118
  24. package/src/services/gme/v20180711/gme_models.ts +264 -78
  25. package/src/services/irp/index.ts +2 -0
  26. package/src/services/irp/v20220805/index.ts +6 -0
  27. package/src/services/irp/v20220805/irp_client.ts +85 -0
  28. package/src/services/irp/v20220805/irp_models.ts +549 -0
  29. package/src/services/lighthouse/v20200324/lighthouse_models.ts +26 -4
  30. package/src/services/live/v20180801/live_models.ts +6 -0
  31. package/src/services/mongodb/v20190725/mongodb_client.ts +12 -15
  32. package/src/services/mongodb/v20190725/mongodb_models.ts +14 -49
  33. package/src/services/ocr/v20181119/ocr_client.ts +1 -1
  34. package/src/services/ocr/v20181119/ocr_models.ts +5 -0
  35. package/src/services/postgres/v20170312/postgres_client.ts +1 -1
  36. package/src/services/privatedns/v20201028/privatedns_models.ts +16 -1
  37. package/src/services/pts/v20210728/pts_models.ts +5 -0
  38. package/src/services/redis/v20180412/redis_client.ts +12 -0
  39. package/src/services/redis/v20180412/redis_models.ts +25 -0
  40. package/src/services/sqlserver/v20180328/sqlserver_models.ts +40 -0
  41. package/src/services/taf/v20200210/taf_client.ts +20 -37
  42. package/src/services/taf/v20200210/taf_models.ts +154 -224
  43. package/src/services/tbaas/v20180416/tbaas_client.ts +77 -175
  44. package/src/services/tbaas/v20180416/tbaas_models.ts +978 -1343
  45. package/src/services/tcbr/v20220217/tcbr_models.ts +5 -0
  46. package/src/services/tcr/v20190924/tcr_client.ts +1 -0
  47. package/src/services/tcr/v20190924/tcr_models.ts +44 -1
  48. package/src/services/tcss/v20201101/tcss_models.ts +64 -0
  49. package/src/services/tem/v20210701/tem_client.ts +41 -4
  50. package/src/services/tem/v20210701/tem_models.ts +409 -225
  51. package/src/services/teo/v20220106/teo_client.ts +9 -7
  52. package/src/services/teo/v20220106/teo_models.ts +944 -658
  53. package/src/services/trtc/v20190722/trtc_models.ts +1 -1
  54. package/src/services/tts/v20190823/tts_client.ts +1 -0
  55. package/src/services/tts/v20190823/tts_models.ts +40 -0
  56. package/src/services/vod/v20180717/vod_client.ts +45 -29
  57. package/src/services/vod/v20180717/vod_models.ts +52 -8
  58. package/src/services/wedata/v20210820/wedata_client.ts +105 -68
  59. package/tencentcloud/common/sdk_version.d.ts +1 -1
  60. package/tencentcloud/common/sdk_version.js +1 -1
  61. package/tencentcloud/services/ams/v20201229/ams_client.d.ts +11 -10
  62. package/tencentcloud/services/ams/v20201229/ams_client.js +11 -10
  63. package/tencentcloud/services/ams/v20201229/ams_models.d.ts +58 -12
  64. package/tencentcloud/services/as/v20180419/as_models.d.ts +15 -0
  65. package/tencentcloud/services/billing/v20180709/billing_models.d.ts +40 -0
  66. package/tencentcloud/services/cat/v20180409/cat_models.d.ts +4 -4
  67. package/tencentcloud/services/cbs/v20170312/cbs_models.d.ts +4 -4
  68. package/tencentcloud/services/ccc/v20200210/ccc_client.d.ts +1 -7
  69. package/tencentcloud/services/ccc/v20200210/ccc_client.js +0 -8
  70. package/tencentcloud/services/ccc/v20200210/ccc_models.d.ts +20 -34
  71. package/tencentcloud/services/ckafka/v20190819/ckafka_models.d.ts +8 -0
  72. package/tencentcloud/services/cls/v20201016/cls_models.d.ts +14 -1
  73. package/tencentcloud/services/cpdp/v20190820/cpdp_models.d.ts +17 -0
  74. package/tencentcloud/services/ess/v20201111/ess_client.d.ts +16 -8
  75. package/tencentcloud/services/ess/v20201111/ess_client.js +19 -9
  76. package/tencentcloud/services/ess/v20201111/ess_models.d.ts +59 -8
  77. package/tencentcloud/services/essbasic/v20210526/essbasic_client.d.ts +14 -7
  78. package/tencentcloud/services/essbasic/v20210526/essbasic_client.js +17 -8
  79. package/tencentcloud/services/essbasic/v20210526/essbasic_models.d.ts +74 -30
  80. package/tencentcloud/services/faceid/v20180301/faceid_models.d.ts +1 -1
  81. package/tencentcloud/services/gme/v20180711/gme_client.d.ts +66 -46
  82. package/tencentcloud/services/gme/v20180711/gme_client.js +91 -61
  83. package/tencentcloud/services/gme/v20180711/gme_models.d.ts +232 -72
  84. package/tencentcloud/services/irp/index.d.ts +4 -0
  85. package/tencentcloud/services/irp/index.js +2 -0
  86. package/tencentcloud/services/irp/v20220805/index.d.ts +6 -0
  87. package/tencentcloud/services/irp/v20220805/index.js +9 -0
  88. package/tencentcloud/services/irp/v20220805/irp_client.d.ts +26 -0
  89. package/tencentcloud/services/irp/v20220805/irp_client.js +55 -0
  90. package/tencentcloud/services/irp/v20220805/irp_models.d.ts +442 -0
  91. package/tencentcloud/services/irp/v20220805/irp_models.js +18 -0
  92. package/tencentcloud/services/lighthouse/v20200324/lighthouse_models.d.ts +23 -3
  93. package/tencentcloud/services/live/v20180801/live_models.d.ts +5 -0
  94. package/tencentcloud/services/mongodb/v20190725/mongodb_client.d.ts +5 -7
  95. package/tencentcloud/services/mongodb/v20190725/mongodb_client.js +6 -8
  96. package/tencentcloud/services/mongodb/v20190725/mongodb_models.d.ts +13 -42
  97. package/tencentcloud/services/ocr/v20181119/ocr_client.d.ts +1 -1
  98. package/tencentcloud/services/ocr/v20181119/ocr_client.js +1 -1
  99. package/tencentcloud/services/ocr/v20181119/ocr_models.d.ts +4 -0
  100. package/tencentcloud/services/postgres/v20170312/postgres_client.d.ts +1 -1
  101. package/tencentcloud/services/postgres/v20170312/postgres_client.js +1 -1
  102. package/tencentcloud/services/privatedns/v20201028/privatedns_models.d.ts +13 -1
  103. package/tencentcloud/services/pts/v20210728/pts_models.d.ts +4 -0
  104. package/tencentcloud/services/redis/v20180412/redis_client.d.ts +5 -1
  105. package/tencentcloud/services/redis/v20180412/redis_client.js +6 -0
  106. package/tencentcloud/services/redis/v20180412/redis_models.d.ts +22 -0
  107. package/tencentcloud/services/sqlserver/v20180328/sqlserver_models.d.ts +32 -0
  108. package/tencentcloud/services/taf/v20200210/taf_client.d.ts +5 -11
  109. package/tencentcloud/services/taf/v20200210/taf_client.js +6 -14
  110. package/tencentcloud/services/taf/v20200210/taf_models.d.ts +136 -197
  111. package/tencentcloud/services/tbaas/v20180416/tbaas_client.d.ts +7 -49
  112. package/tencentcloud/services/tbaas/v20180416/tbaas_client.js +9 -65
  113. package/tencentcloud/services/tbaas/v20180416/tbaas_models.d.ts +905 -1211
  114. package/tencentcloud/services/tcbr/v20220217/tcbr_models.d.ts +4 -0
  115. package/tencentcloud/services/tcr/v20190924/tcr_models.d.ts +37 -1
  116. package/tencentcloud/services/tcss/v20201101/tcss_models.d.ts +55 -0
  117. package/tencentcloud/services/tem/v20210701/tem_client.d.ts +13 -1
  118. package/tencentcloud/services/tem/v20210701/tem_client.js +18 -0
  119. package/tencentcloud/services/tem/v20210701/tem_models.d.ts +316 -160
  120. package/tencentcloud/services/teo/v20220106/teo_client.d.ts +7 -7
  121. package/tencentcloud/services/teo/v20220106/teo_client.js +7 -7
  122. package/tencentcloud/services/teo/v20220106/teo_models.d.ts +805 -547
  123. package/tencentcloud/services/trtc/v20190722/trtc_models.d.ts +1 -1
  124. package/tencentcloud/services/tts/v20190823/tts_models.d.ts +33 -0
  125. package/tencentcloud/services/vod/v20180717/vod_client.d.ts +19 -11
  126. package/tencentcloud/services/vod/v20180717/vod_client.js +24 -14
  127. package/tencentcloud/services/vod/v20180717/vod_models.d.ts +45 -7
  128. package/tencentcloud/services/wedata/v20210820/wedata_client.d.ts +72 -35
  129. package/tencentcloud/services/wedata/v20210820/wedata_client.js +72 -35
  130. package/test/ccc.v20200210.test.js +0 -10
  131. package/test/ess.v20201111.test.js +14 -4
  132. package/test/essbasic.v20210526.test.js +14 -4
  133. package/test/gme.v20180711.test.js +82 -32
  134. package/test/irp.v20220805.test.js +61 -0
  135. package/test/mongodb.v20190725.test.js +10 -10
  136. package/test/redis.v20180412.test.js +10 -0
  137. package/test/taf.v20200210.test.js +8 -18
  138. package/test/tbaas.v20180416.test.js +6 -76
  139. package/test/tem.v20210701.test.js +30 -0
  140. package/test/vod.v20180717.test.js +18 -8
@@ -3,13 +3,15 @@
3
3
  */
4
4
  export interface Compression {
5
5
  /**
6
- * 智能压缩配置开关
7
- on:开启
8
- off:关闭
6
+ * 智能压缩配置开关,取值有:
7
+ <li>on:开启;</li>
8
+ <li>off:关闭。</li>
9
9
  */
10
10
  Switch: string;
11
11
  /**
12
- * 支持的压缩算法列表
12
+ * 支持的压缩算法列表,取值有:
13
+ <li>brotli:brotli算法;</li>
14
+ <li>gzip:gzip算法。</li>
13
15
  注意:此字段可能返回 null,表示取不到有效值。
14
16
  */
15
17
  Algorithms?: Array<string>;
@@ -19,28 +21,24 @@ off:关闭
19
21
  */
20
22
  export interface WebLogData {
21
23
  /**
22
- * 数据
24
+ * 分组数据。
23
25
  注意:此字段可能返回 null,表示取不到有效值。
24
26
  */
25
27
  List: Array<WebLogs>;
26
28
  /**
27
- * 当前页
28
- 注意:此字段可能返回 null,表示取不到有效值。
29
+ * 分页拉取的起始页号。最小值:1。
29
30
  */
30
31
  PageNo: number;
31
32
  /**
32
- * 每页展示条数
33
- 注意:此字段可能返回 null,表示取不到有效值。
33
+ * 分页拉取的最大返回结果数。最大值:1000。
34
34
  */
35
35
  PageSize: number;
36
36
  /**
37
- * 总页数
38
- 注意:此字段可能返回 null,表示取不到有效值。
37
+ * 总页数。
39
38
  */
40
39
  Pages: number;
41
40
  /**
42
- * 总条数
43
- 注意:此字段可能返回 null,表示取不到有效值。
41
+ * 总条数。
44
42
  */
45
43
  TotalSize: number;
46
44
  }
@@ -149,15 +147,17 @@ disabled:禁用证书
149
147
  */
150
148
  export interface DescribeWebManagedRulesTopDataResponse {
151
149
  /**
152
- * topn数据
150
+ * top数据内容。
153
151
  */
154
152
  Data: Array<TopNEntry>;
155
153
  /**
156
- * 状态,1:失败,0:成功
154
+ * 请求响应状态,取值有:
155
+ <li>1 :失败 ;</li>
156
+ <li>0 :成功 。</li>
157
157
  */
158
158
  Status: number;
159
159
  /**
160
- * 返回消息
160
+ * 请求响应消息。
161
161
  */
162
162
  Msg: string;
163
163
  /**
@@ -254,22 +254,25 @@ export interface DeleteApplicationProxyResponse {
254
254
  */
255
255
  export interface Https {
256
256
  /**
257
- * http2 配置开关
258
- on:开启
259
- off:关闭
257
+ * http2 配置开关,取值有:
258
+ <li>on:开启;</li>
259
+ <li>off:关闭。</li>
260
260
  注意:此字段可能返回 null,表示取不到有效值。
261
261
  */
262
262
  Http2?: string;
263
263
  /**
264
- * OCSP 配置开关
265
- on:开启
266
- off:关闭
267
- 默认为关闭状态
264
+ * OCSP 配置开关,取值有:
265
+ <li>on:开启;</li>
266
+ <li>off:关闭。</li>
268
267
  注意:此字段可能返回 null,表示取不到有效值。
269
268
  */
270
269
  OcspStapling?: string;
271
270
  /**
272
- * Tls版本设置,支持设置 TLSv1, TLSV1.1, TLSV1.2, TLSv1.3,修改时必须开启连续的版本
271
+ * Tls版本设置,取值有:
272
+ <li>TLSv1:TLSv1版本;</li>
273
+ <li>TLSV1.1:TLSv1.1版本;</li>
274
+ <li>TLSV1.2:TLSv1.2版本;</li>
275
+ <li>TLSv1.3:TLSv1.3版本。</li>修改时必须开启连续的版本。
273
276
  注意:此字段可能返回 null,表示取不到有效值。
274
277
  */
275
278
  TlsVersion?: Array<string>;
@@ -318,27 +321,27 @@ export interface OriginFilter {
318
321
  */
319
322
  export interface BotLogData {
320
323
  /**
321
- * Bot攻击日志数据集合
324
+ * Bot攻击日志数据集合。
322
325
  注意:此字段可能返回 null,表示取不到有效值。
323
326
  */
324
327
  List: Array<BotLog>;
325
328
  /**
326
- * 当前页
329
+ * 分页拉取的起始页号。最小值:1。
327
330
  注意:此字段可能返回 null,表示取不到有效值。
328
331
  */
329
332
  PageNo: number;
330
333
  /**
331
- * 每页展示条数
334
+ * 分页拉取的最大返回结果数。最大值:1000。
332
335
  注意:此字段可能返回 null,表示取不到有效值。
333
336
  */
334
337
  PageSize: number;
335
338
  /**
336
- * 总页数
339
+ * 总页数。
337
340
  注意:此字段可能返回 null,表示取不到有效值。
338
341
  */
339
342
  Pages: number;
340
343
  /**
341
- * 总条数
344
+ * 总条数。
342
345
  注意:此字段可能返回 null,表示取不到有效值。
343
346
  */
344
347
  TotalSize: number;
@@ -502,15 +505,17 @@ export interface DescribePrefetchTasksResponse {
502
505
  */
503
506
  export interface DescribeDDosAttackEventResponse {
504
507
  /**
505
- * DDos攻击事件数据
508
+ * DDos攻击事件数据。
506
509
  */
507
510
  Data: DDosAttackEventData;
508
511
  /**
509
- * 状态,1:失败,0:成功
512
+ * 请求响应状态,取值有:
513
+ <li>1 :失败 ;</li>
514
+ <li>0 :成功 。</li>
510
515
  */
511
516
  Status: number;
512
517
  /**
513
- * 返回信息
518
+ * 请求响应信息。
514
519
  */
515
520
  Msg: string;
516
521
  /**
@@ -562,7 +567,7 @@ export interface ReclaimZoneResponse {
562
567
  */
563
568
  export interface DescribeZoneSettingRequest {
564
569
  /**
565
- * 站点ID
570
+ * 站点ID
566
571
  */
567
572
  ZoneId: string;
568
573
  }
@@ -753,69 +758,89 @@ export interface ModifyDnssecRequest {
753
758
  */
754
759
  export interface ModifyZoneSettingRequest {
755
760
  /**
756
- * 待变更的站点ID
761
+ * 待变更的站点ID
757
762
  */
758
763
  ZoneId: string;
759
764
  /**
760
- * 缓存过期时间配置
765
+ * 缓存过期时间配置。
766
+ 不填写表示保持原有配置。
761
767
  */
762
768
  Cache?: CacheConfig;
763
769
  /**
764
- * 节点缓存键配置
770
+ * 节点缓存键配置。
771
+ 不填写表示保持原有配置。
765
772
  */
766
773
  CacheKey?: CacheKey;
767
774
  /**
768
- * 浏览器缓存配置
775
+ * 浏览器缓存配置。
776
+ 不填写表示保持原有配置。
769
777
  */
770
778
  MaxAge?: MaxAge;
771
779
  /**
772
- * 离线缓存
780
+ * 离线缓存配置。
781
+ 不填写表示保持原有配置。
773
782
  */
774
783
  OfflineCache?: OfflineCache;
775
784
  /**
776
- * Quic访问
785
+ * Quic访问配置。
786
+ 不填写表示保持原有配置。
777
787
  */
778
788
  Quic?: Quic;
779
789
  /**
780
- * POST请求传输配置
790
+ * Post请求传输配置。
791
+ 不填写表示保持原有配置。
781
792
  */
782
793
  PostMaxSize?: PostMaxSize;
783
794
  /**
784
- * 智能压缩配置
795
+ * 智能压缩配置。
796
+ 不填写表示保持原有配置。
785
797
  */
786
798
  Compression?: Compression;
787
799
  /**
788
- * http2回源配置
800
+ * Http2回源配置。
801
+ 不填写表示保持原有配置。
789
802
  */
790
803
  UpstreamHttp2?: UpstreamHttp2;
791
804
  /**
792
- * 访问协议强制https跳转配置
805
+ * 访问协议强制Https跳转配置。
806
+ 不填写表示保持原有配置。
793
807
  */
794
808
  ForceRedirect?: ForceRedirect;
795
809
  /**
796
- * Https 加速配置
810
+ * Https加速配置。
811
+ 不填写表示保持原有配置。
797
812
  */
798
813
  Https?: Https;
799
814
  /**
800
- * 源站配置
815
+ * 源站配置。
816
+ 不填写表示保持原有配置。
801
817
  */
802
818
  Origin?: Origin;
803
819
  /**
804
- * 智能加速配置
820
+ * 智能加速配置。
821
+ 不填写表示保持原有配置。
805
822
  */
806
823
  SmartRouting?: SmartRouting;
807
824
  /**
808
- * WebSocket配置
825
+ * WebSocket配置。
826
+ 不填写表示保持原有配置。
809
827
  */
810
828
  WebSocket?: WebSocket;
811
829
  /**
812
- * 客户端IP回源请求头配置
830
+ * 客户端IP回源请求头配置。
831
+ 不填写表示保持原有配置。
813
832
  */
814
833
  ClientIpHeader?: ClientIp;
815
834
  /**
816
- * 缓存预刷新配置
835
+ * 缓存预刷新配置。
836
+ 不填写表示保持原有配置。
817
837
  */
818
838
  CachePrefresh?: CachePrefresh;
839
+ /**
840
+ * Ipv6访问配置。
841
+ 不填写表示保持原有配置。
842
+ */
843
+ Ipv6?: Ipv6Access;
819
844
  }
820
845
  /**
821
846
  * ddos特征过滤
@@ -835,7 +860,7 @@ export interface DdosPacketFilter {
835
860
  */
836
861
  export interface CreateApplicationProxyResponse {
837
862
  /**
838
- * 新增的四层代理应用ID
863
+ * 新增的四层代理应用ID
839
864
  */
840
865
  ProxyId: string;
841
866
  /**
@@ -861,9 +886,9 @@ export interface ImportDnsRecordsRequest {
861
886
  */
862
887
  export interface CacheConfigNoCache {
863
888
  /**
864
- * 不缓存配置开关
865
- on:开启
866
- off:关闭
889
+ * 不缓存配置开关,取值有:
890
+ <li>on:开启;</li>
891
+ <li>off:关闭。</li>
867
892
  注意:此字段可能返回 null,表示取不到有效值。
868
893
  */
869
894
  Switch: string;
@@ -972,103 +997,119 @@ export interface DescribeZoneDetailsResponse {
972
997
  */
973
998
  export interface BotLog {
974
999
  /**
975
- * 攻击时间
976
- 注意:此字段可能返回 null,表示取不到有效值。
1000
+ * 攻击时间,采用unix秒级时间戳。
977
1001
  */
978
1002
  AttackTime: number;
979
1003
  /**
980
- * 攻击ip
981
- 注意:此字段可能返回 null,表示取不到有效值。
1004
+ * 攻击源(客户端)ip
982
1005
  */
983
1006
  AttackIp: string;
984
1007
  /**
985
- * 域名
986
- 注意:此字段可能返回 null,表示取不到有效值。
1008
+ * 受攻击域名。
987
1009
  */
988
1010
  Domain: string;
989
1011
  /**
990
- * 请求uri
991
- 注意:此字段可能返回 null,表示取不到有效值。
1012
+ * URI。
992
1013
  */
993
1014
  RequestUri: string;
994
1015
  /**
995
- * 攻击类型
1016
+ * 当前该字段无效。
996
1017
  注意:此字段可能返回 null,表示取不到有效值。
997
1018
  */
998
1019
  AttackType: string;
999
1020
  /**
1000
- * 请求方法
1001
- 注意:此字段可能返回 null,表示取不到有效值。
1021
+ * 请求方法。
1002
1022
  */
1003
1023
  RequestMethod: string;
1004
1024
  /**
1005
- * 攻击内容
1006
- 注意:此字段可能返回 null,表示取不到有效值。
1025
+ * 攻击内容。
1007
1026
  */
1008
1027
  AttackContent: string;
1009
1028
  /**
1010
- * 风险等级
1029
+ * 当前该字段无效 。
1011
1030
  注意:此字段可能返回 null,表示取不到有效值。
1012
1031
  */
1013
1032
  RiskLevel: string;
1014
1033
  /**
1015
- * 规则编号
1034
+ * 当前该字段无效 。
1016
1035
  注意:此字段可能返回 null,表示取不到有效值。
1017
1036
  */
1018
1037
  RuleId: number;
1019
1038
  /**
1020
- * IP所在国家
1021
- 注意:此字段可能返回 null,表示取不到有效值。
1039
+ * IP所在国家iso-3166中alpha-2编码,编码信息请参考[ISO-3166](https://git.woa.com/edgeone/iso-3166/blob/master/all/all.json)。
1022
1040
  */
1023
1041
  SipCountryCode: string;
1024
1042
  /**
1025
- * 事件id
1026
- 注意:此字段可能返回 null,表示取不到有效值。
1043
+ * 请求(事件)ID。
1027
1044
  */
1028
1045
  EventId: string;
1029
1046
  /**
1030
- * 处置方式
1047
+ * 该字段当前无效。
1031
1048
  注意:此字段可能返回 null,表示取不到有效值。
1032
1049
  */
1033
1050
  DisposalMethod: string;
1034
1051
  /**
1035
- * http_log
1052
+ * 该字段当前无效。
1036
1053
  注意:此字段可能返回 null,表示取不到有效值。
1037
1054
  */
1038
1055
  HttpLog: string;
1039
1056
  /**
1040
- * user agent
1041
- 注意:此字段可能返回 null,表示取不到有效值。
1057
+ * user agent
1042
1058
  */
1043
1059
  Ua: string;
1044
1060
  /**
1045
- * 检出方法
1061
+ * 该字段当前无效。
1046
1062
  注意:此字段可能返回 null,表示取不到有效值。
1047
1063
  */
1048
1064
  DetectionMethod: string;
1049
1065
  /**
1050
- * 置信度
1066
+ * 该字段当前无效。
1051
1067
  注意:此字段可能返回 null,表示取不到有效值。
1052
1068
  */
1053
1069
  Confidence: string;
1054
1070
  /**
1055
- * 恶意度
1071
+ * 该字段当前无效。
1056
1072
  注意:此字段可能返回 null,表示取不到有效值。
1057
1073
  */
1058
1074
  Maliciousness: string;
1075
+ /**
1076
+ * 规则相关信息列表。
1077
+ 注意:此字段可能返回 null,表示取不到有效值。
1078
+ */
1079
+ RuleDetailList: Array<SecRuleRelatedInfo>;
1080
+ /**
1081
+ * Bot标签。
1082
+ 注意:此字段可能返回 null,表示取不到有效值。
1083
+ */
1084
+ Label: string;
1059
1085
  }
1060
1086
  /**
1061
1087
  * 源站配置。
1062
1088
  */
1063
1089
  export interface Origin {
1064
1090
  /**
1065
- * 回源协议配置
1066
- http:强制 http 回源
1067
- follow:协议跟随回源
1068
- https:强制 https 回源,https 回源时仅支持源站 443 端口
1091
+ * 主源站列表。
1092
+ 注意:此字段可能返回 null,表示取不到有效值。
1093
+ */
1094
+ Origins?: Array<string>;
1095
+ /**
1096
+ * 备源站列表。
1097
+ 注意:此字段可能返回 null,表示取不到有效值。
1098
+ */
1099
+ BackupOrigins?: Array<string>;
1100
+ /**
1101
+ * 回源协议配置,取值有:
1102
+ <li>http:强制 http 回源;</li>
1103
+ <li>follow:协议跟随回源;</li>
1104
+ <li>https:强制 https 回源,https 回源时仅支持源站 443 端口。</li>
1069
1105
  注意:此字段可能返回 null,表示取不到有效值。
1070
1106
  */
1071
1107
  OriginPullProtocol?: string;
1108
+ /**
1109
+ * OriginType 为对象存储(COS)时,可以指定是否允许访问私有 bucket。
1110
+ 注意:此字段可能返回 null,表示取不到有效值。
1111
+ */
1112
+ CosPrivateAccess?: string;
1072
1113
  }
1073
1114
  /**
1074
1115
  * ModifyZoneStatus返回参数结构体
@@ -1273,31 +1314,34 @@ export interface ModifyZoneResponse {
1273
1314
  */
1274
1315
  export interface DescribeDDosAttackSourceEventRequest {
1275
1316
  /**
1276
- * 开始时间
1317
+ * 开始时间。
1277
1318
  */
1278
1319
  StartTime: string;
1279
1320
  /**
1280
- * 结束时间
1321
+ * 结束时间。
1281
1322
  */
1282
1323
  EndTime: string;
1283
1324
  /**
1284
- * 条数
1325
+ * 分页拉取的最大返回结果数。最大值:1000。
1285
1326
  */
1286
1327
  PageSize: number;
1287
1328
  /**
1288
- * 当前页
1329
+ * 分页拉取的起始页号。最小值:1。
1289
1330
  */
1290
1331
  PageNo: number;
1291
1332
  /**
1292
- * ddos策略组id 集合
1333
+ * ddos策略组id 集合,不填默认选择全部策略id。
1293
1334
  */
1294
1335
  PolicyIds?: Array<number>;
1295
1336
  /**
1296
- * 站点集合
1337
+ * 站点集合,不填默认选择全部站点。
1297
1338
  */
1298
1339
  ZoneIds?: Array<string>;
1299
1340
  /**
1300
- * 协议类型,{tcp,udp,all}
1341
+ * 协议类型,取值有:
1342
+ <li>tcp ;</li>
1343
+ <li>udp ;</li>
1344
+ <li>all 。</li>
1301
1345
  */
1302
1346
  ProtocolType?: string;
1303
1347
  }
@@ -1338,27 +1382,27 @@ export interface DeleteZoneResponse {
1338
1382
  */
1339
1383
  export interface DDosAttackEventData {
1340
1384
  /**
1341
- * 攻击事件数据集合
1385
+ * 攻击事件数据集合。
1342
1386
  注意:此字段可能返回 null,表示取不到有效值。
1343
1387
  */
1344
1388
  List: Array<DDosAttackEvent>;
1345
1389
  /**
1346
- * 当前页
1390
+ * 分页拉取的起始页号。最小值:1。
1347
1391
  注意:此字段可能返回 null,表示取不到有效值。
1348
1392
  */
1349
1393
  PageNo: number;
1350
1394
  /**
1351
- * 每页展示条数
1395
+ * 分页拉取的最大返回结果数。最大值:1000。
1352
1396
  注意:此字段可能返回 null,表示取不到有效值。
1353
1397
  */
1354
1398
  PageSize: number;
1355
1399
  /**
1356
- * 总页数
1400
+ * 总页数。
1357
1401
  注意:此字段可能返回 null,表示取不到有效值。
1358
1402
  */
1359
1403
  Pages: number;
1360
1404
  /**
1361
- * 总条数
1405
+ * 总条数。
1362
1406
  注意:此字段可能返回 null,表示取不到有效值。
1363
1407
  */
1364
1408
  TotalSize: number;
@@ -1368,21 +1412,27 @@ export interface DDosAttackEventData {
1368
1412
  */
1369
1413
  export interface Hsts {
1370
1414
  /**
1371
- * 是否开启,on或off。
1415
+ * 是否开启,取值有:
1416
+ <li>on:开启;</li>
1417
+ <li>off:关闭。</li>
1372
1418
  */
1373
1419
  Switch: string;
1374
1420
  /**
1375
- * MaxAge数值。
1421
+ * MaxAge数值。单位为秒,最大值为1天。
1376
1422
  注意:此字段可能返回 null,表示取不到有效值。
1377
1423
  */
1378
1424
  MaxAge?: number;
1379
1425
  /**
1380
- * 是否包含子域名,on或off。
1426
+ * 是否包含子域名,取值有:
1427
+ <li>on:开启;</li>
1428
+ <li>off:关闭。</li>
1381
1429
  注意:此字段可能返回 null,表示取不到有效值。
1382
1430
  */
1383
1431
  IncludeSubDomains?: string;
1384
1432
  /**
1385
- * 是否预加载,on或off。
1433
+ * 是否开启预加载,取值有:
1434
+ <li>on:开启;</li>
1435
+ <li>off:关闭。</li>
1386
1436
  注意:此字段可能返回 null,表示取不到有效值。
1387
1437
  */
1388
1438
  Preload?: string;
@@ -1423,22 +1473,22 @@ export interface DeleteApplicationProxyRuleResponse {
1423
1473
  */
1424
1474
  export interface DDosAttackSourceEvent {
1425
1475
  /**
1426
- * 攻击源ip
1476
+ * 攻击源ip
1427
1477
  注意:此字段可能返回 null,表示取不到有效值。
1428
1478
  */
1429
1479
  AttackSourceIp: string;
1430
1480
  /**
1431
- * 地区(国家)
1481
+ * 地区(国家)。
1432
1482
  注意:此字段可能返回 null,表示取不到有效值。
1433
1483
  */
1434
1484
  AttackRegion: string;
1435
1485
  /**
1436
- * 累计攻击流量
1486
+ * 累计攻击流量。
1437
1487
  注意:此字段可能返回 null,表示取不到有效值。
1438
1488
  */
1439
1489
  AttackFlow: number;
1440
1490
  /**
1441
- * 累计攻击包量
1491
+ * 累计攻击包量。
1442
1492
  注意:此字段可能返回 null,表示取不到有效值。
1443
1493
  */
1444
1494
  AttackPacketNum: number;
@@ -1622,58 +1672,59 @@ export interface ModifyHostsCertificateRequest {
1622
1672
  */
1623
1673
  export interface ApplicationProxyRule {
1624
1674
  /**
1625
- * 协议,取值为TCP或者UDP
1675
+ * 协议,取值有:
1676
+ <li>TCP:TCP协议;</li>
1677
+ <li>UDP:UDP协议。</li>
1626
1678
  */
1627
1679
  Proto: string;
1628
1680
  /**
1629
1681
  * 端口,支持格式:
1630
- 80:80端口
1631
- 81-90:81至90端口
1682
+ 单个端口,如:80
1683
+ 端口段,如:81-82。表示81,82两个端口。
1684
+ 注意:一条规则最多可填写20个端口。
1632
1685
  */
1633
1686
  Port: Array<string>;
1634
1687
  /**
1635
- * 源站类型,取值:
1636
- custom:手动添加
1637
- origins:源站组
1688
+ * 源站类型,取值有:
1689
+ <li>custom:手动添加;</li>
1690
+ <li>origins:源站组。</li>
1638
1691
  */
1639
1692
  OriginType: string;
1640
1693
  /**
1641
1694
  * 源站信息:
1642
1695
  当OriginType=custom时,表示一个或多个源站,如:
1643
1696
  OriginValue=["8.8.8.8:80","9.9.9.9:80"]
1644
- OriginValue=["test.com:80"]
1645
-
1646
- 当OriginType=origins时,包含一个元素,表示源站组ID,如:
1647
- OriginValue=["origin-xxx"]
1697
+ OriginValue=["test.com:80"]
1698
+ 当OriginType=origins时,要求有且仅有一个元素,表示源站组ID,如:
1699
+ OriginValue=["origin-537f5b41-162a-11ed-abaa-525400c5da15"]。
1648
1700
  */
1649
1701
  OriginValue: Array<string>;
1650
1702
  /**
1651
- * 规则ID
1703
+ * 规则ID
1652
1704
  注意:此字段可能返回 null,表示取不到有效值。
1653
1705
  */
1654
1706
  RuleId?: string;
1655
1707
  /**
1656
- * 状态:
1657
- online:启用
1658
- offline:停用
1659
- progress:部署中
1660
- stopping:停用中
1661
- fail:部署失败/停用失败
1708
+ * 状态,取值有:
1709
+ <li>online:启用;</li>
1710
+ <li>offline:停用;</li>
1711
+ <li>progress:部署中;</li>
1712
+ <li>stopping:停用中;</li>
1713
+ <li>fail:部署失败/停用失败。</li>
1662
1714
  */
1663
1715
  Status?: string;
1664
1716
  /**
1665
- * 传递客户端IP,当Proto=TCP时,取值:
1666
- TOA:TOA
1667
- PPV1: Proxy Protocol传递,协议版本V1
1668
- PPV2: Proxy Protocol传递,协议版本V2
1669
- OFF:不传递
1670
- 当Proto=UDP时,取值:
1671
- PPV2: Proxy Protocol传递,协议版本V2
1672
- OFF:不传递
1717
+ * 传递客户端IP,取值有:
1718
+ <li>TOA:TOA(仅Proto=TCP时可选);</li>
1719
+ <li>PPV1Proxy Protocol传递,协议版本V1(仅Proto=TCP时可选);</li>
1720
+ <li>PPV2Proxy Protocol传递,协议版本V2;</li>
1721
+ <li>OFF:不传递。</li>
1673
1722
  */
1674
1723
  ForwardClientIp?: string;
1675
1724
  /**
1676
- * 是否开启会话保持
1725
+ * 是否开启会话保持,取值有:
1726
+ <li>true:开启;</li>
1727
+ <li>false:关闭。</li>
1677
1728
  */
1678
1729
  SessionPersist?: boolean;
1679
1730
  }
@@ -1682,9 +1733,9 @@ OFF:不传递
1682
1733
  */
1683
1734
  export interface SmartRouting {
1684
1735
  /**
1685
- * 智能加速配置开关
1686
- on:开启
1687
- off:关闭
1736
+ * 智能加速配置开关,取值有:
1737
+ <li>on:开启;</li>
1738
+ <li>off:关闭。</li>
1688
1739
  */
1689
1740
  Switch: string;
1690
1741
  }
@@ -1832,22 +1883,22 @@ online: 启用
1832
1883
  */
1833
1884
  export interface CacheConfigCache {
1834
1885
  /**
1835
- * 缓存配置开关
1836
- on:开启
1837
- off:关闭
1886
+ * 缓存配置开关,取值有:
1887
+ <li>on:开启;</li>
1888
+ <li>off:关闭。</li>
1838
1889
  注意:此字段可能返回 null,表示取不到有效值。
1839
1890
  */
1840
1891
  Switch: string;
1841
1892
  /**
1842
- * 缓存过期时间设置
1843
- 单位为秒,最大可设置为 365
1893
+ * 缓存过期时间设置。
1894
+ 单位为秒,最大可设置为 365 天。
1844
1895
  注意:此字段可能返回 null,表示取不到有效值。
1845
1896
  */
1846
1897
  CacheTime?: number;
1847
1898
  /**
1848
- * 是否开启强制缓存
1849
- 开启:on
1850
- 关闭:off
1899
+ * 是否开启强制缓存,取值有:
1900
+ <li>on:开启;</li>
1901
+ <li>off:关闭。</li>
1851
1902
  注意:此字段可能返回 null,表示取不到有效值。
1852
1903
  */
1853
1904
  IgnoreCacheControl?: string;
@@ -1907,15 +1958,17 @@ offline: 停用
1907
1958
  */
1908
1959
  export interface DescribeDDosAttackTopDataResponse {
1909
1960
  /**
1910
- * topn数据
1961
+ * top数据内容
1911
1962
  */
1912
1963
  Data: Array<TopNEntry>;
1913
1964
  /**
1914
- * 状态,1:失败,0:成功
1965
+ * 请求响应状态,取值有:
1966
+ <li>1 :失败 ;</li>
1967
+ <li>0 :成功 。</li>
1915
1968
  */
1916
1969
  Status: number;
1917
1970
  /**
1918
- * 返回消息
1971
+ * 请求响应消息。
1919
1972
  */
1920
1973
  Msg: string;
1921
1974
  /**
@@ -2015,7 +2068,7 @@ export interface AclConfig {
2015
2068
  */
2016
2069
  export interface ModifyZoneSettingResponse {
2017
2070
  /**
2018
- * 站点ID
2071
+ * 站点ID
2019
2072
  */
2020
2073
  ZoneId: string;
2021
2074
  /**
@@ -2155,64 +2208,72 @@ pending: 不生效
2155
2208
  RequestId?: string;
2156
2209
  }
2157
2210
  /**
2158
- * 限速拦截日志
2211
+ * CC日志
2159
2212
  */
2160
2213
  export interface CCLog {
2161
2214
  /**
2162
- * 攻击时间
2163
- 注意:此字段可能返回 null,表示取不到有效值。
2215
+ * 攻击请求时间,采用unix秒级时间戳。
2164
2216
  */
2165
2217
  AttackTime: number;
2166
2218
  /**
2167
- * 攻击源ip
2168
- 注意:此字段可能返回 null,表示取不到有效值。
2219
+ * 客户端ip
2169
2220
  */
2170
2221
  AttackSip: string;
2171
2222
  /**
2172
- * 攻击域名
2173
- 注意:此字段可能返回 null,表示取不到有效值。
2223
+ * 受攻击域名。
2174
2224
  */
2175
2225
  AttackDomain: string;
2176
2226
  /**
2177
- * 请求uri
2178
- 注意:此字段可能返回 null,表示取不到有效值。
2227
+ * URI。
2179
2228
  */
2180
2229
  RequestUri: string;
2181
2230
  /**
2182
- * 命中次数
2183
- 注意:此字段可能返回 null,表示取不到有效值。
2231
+ * 命中次数。
2184
2232
  */
2185
2233
  HitCount: number;
2186
2234
  /**
2187
- * IP所在国家
2188
- 注意:此字段可能返回 null,表示取不到有效值。
2235
+ * IP所在国家iso-3166中alpha-2编码,编码信息请参考[ISO-3166](https://git.woa.com/edgeone/iso-3166/blob/master/all/all.json)。
2189
2236
  */
2190
2237
  SipCountryCode: string;
2191
2238
  /**
2192
- * 事件id
2193
- 注意:此字段可能返回 null,表示取不到有效值。
2239
+ * 请求(事件)ID。
2194
2240
  */
2195
2241
  EventId: string;
2196
2242
  /**
2197
- * 处置方式
2243
+ * 当前该字段已废弃。
2198
2244
  注意:此字段可能返回 null,表示取不到有效值。
2199
2245
  */
2200
2246
  DisposalMethod: string;
2201
2247
  /**
2202
- * http_log
2248
+ * 当前该字段已废弃。
2203
2249
  注意:此字段可能返回 null,表示取不到有效值。
2204
2250
  */
2205
2251
  HttpLog: string;
2206
2252
  /**
2207
- * 规则编号
2253
+ * 当前该字段已废弃。
2208
2254
  注意:此字段可能返回 null,表示取不到有效值。
2209
2255
  */
2210
2256
  RuleId: number;
2211
2257
  /**
2212
- * 风险等级
2258
+ * 当前该字段已废弃。
2213
2259
  注意:此字段可能返回 null,表示取不到有效值。
2214
2260
  */
2215
2261
  RiskLevel: string;
2262
+ /**
2263
+ * User Agent,仅自定义规则日志中存在。
2264
+ 注意:此字段可能返回 null,表示取不到有效值。
2265
+ */
2266
+ Ua: string;
2267
+ /**
2268
+ * 请求方法,仅自定义规则日志中存在。
2269
+ 注意:此字段可能返回 null,表示取不到有效值。
2270
+ */
2271
+ RequestMethod: string;
2272
+ /**
2273
+ * 规则信息列表。
2274
+ 注意:此字段可能返回 null,表示取不到有效值。
2275
+ */
2276
+ RuleDetailList: Array<SecRuleRelatedInfo>;
2216
2277
  }
2217
2278
  /**
2218
2279
  * https 服务端证书配置
@@ -2268,20 +2329,26 @@ export interface DDoSConfig {
2268
2329
  */
2269
2330
  export interface DescribeWebManagedRulesDataResponse {
2270
2331
  /**
2271
- * Web攻击日志实体
2332
+ * Web攻击日志实体。
2272
2333
  注意:此字段可能返回 null,表示取不到有效值。
2273
2334
  */
2274
2335
  Data: Array<SecEntry>;
2275
2336
  /**
2276
- * 状态,1:失败,0:成功
2337
+ * 请求响应状态,取值有:
2338
+ <li>1 :失败 ;</li>
2339
+ <li>0 :成功 。</li>
2277
2340
  */
2278
2341
  Status: number;
2279
2342
  /**
2280
- * 返回消息
2343
+ * 请求响应消息。
2281
2344
  */
2282
2345
  Msg: string;
2283
2346
  /**
2284
- * 查询时间粒度,可选{min,5min,hour,day}
2347
+ * 查询时间粒度,取值有:
2348
+ <li>min :1分钟 ;</li>
2349
+ <li>5min :5分钟 ;</li>
2350
+ <li>hour :1小时 ;</li>
2351
+ <li>day :1天 。</li>
2285
2352
  */
2286
2353
  Interval: string;
2287
2354
  /**
@@ -2294,15 +2361,17 @@ export interface DescribeWebManagedRulesDataResponse {
2294
2361
  */
2295
2362
  export interface DescribeWebManagedRulesLogResponse {
2296
2363
  /**
2297
- * web攻击日志data
2364
+ * web攻击日志数据内容。
2298
2365
  */
2299
2366
  Data: WebLogData;
2300
2367
  /**
2301
- * 状态,1:失败,0:失败
2368
+ * 请求响应状态,取值有:
2369
+ <li>1 :失败 ;</li>
2370
+ <li>0 :成功 。</li>
2302
2371
  */
2303
2372
  Status: number;
2304
2373
  /**
2305
- * 返回信息
2374
+ * 请求响应信息。
2306
2375
  */
2307
2376
  Msg: string;
2308
2377
  /**
@@ -2363,80 +2432,78 @@ export interface OriginRecord {
2363
2432
  */
2364
2433
  export interface WebLogs {
2365
2434
  /**
2366
- * 攻击内容
2435
+ * 该字段已废弃。
2367
2436
  注意:此字段可能返回 null,表示取不到有效值。
2368
2437
  */
2369
2438
  AttackContent: string;
2370
2439
  /**
2371
- * 攻击IP
2372
- 注意:此字段可能返回 null,表示取不到有效值。
2440
+ * 攻击源(客户端)Ip。
2373
2441
  */
2374
2442
  AttackIp: string;
2375
2443
  /**
2376
- * 攻击类型
2444
+ * 该字段已废弃。
2377
2445
  注意:此字段可能返回 null,表示取不到有效值。
2378
2446
  */
2379
2447
  AttackType: string;
2380
2448
  /**
2381
- * 域名
2382
- 注意:此字段可能返回 null,表示取不到有效值。
2449
+ * 受攻击子域名。
2383
2450
  */
2384
2451
  Domain: string;
2385
2452
  /**
2386
- * uuid
2453
+ * 该字段已废弃。
2387
2454
  注意:此字段可能返回 null,表示取不到有效值。
2388
2455
  */
2389
2456
  Msuuid: string;
2390
2457
  /**
2391
- * 请求方法
2458
+ * 该字段已废弃。
2392
2459
  注意:此字段可能返回 null,表示取不到有效值。
2393
2460
  */
2394
2461
  RequestMethod: string;
2395
2462
  /**
2396
- * 请求URI
2397
- 注意:此字段可能返回 null,表示取不到有效值。
2463
+ * URI
2398
2464
  */
2399
2465
  RequestUri: string;
2400
2466
  /**
2401
- * 风险等级
2467
+ * 该字段已废弃。
2402
2468
  注意:此字段可能返回 null,表示取不到有效值。
2403
2469
  */
2404
2470
  RiskLevel: string;
2405
2471
  /**
2406
- * 规则ID
2472
+ * 该字段已废弃。
2407
2473
  注意:此字段可能返回 null,表示取不到有效值。
2408
2474
  */
2409
2475
  RuleId: number;
2410
2476
  /**
2411
- * IP所在国家
2412
- 注意:此字段可能返回 null,表示取不到有效值。
2477
+ * IP所在国家iso-3166中alpha-2编码,编码信息请参考[ISO-3166](https://git.woa.com/edgeone/iso-3166/blob/master/all/all.json)
2413
2478
  */
2414
2479
  SipCountryCode: string;
2415
2480
  /**
2416
- * 事件id
2417
- 注意:此字段可能返回 null,表示取不到有效值。
2481
+ * 请求(事件)ID。
2418
2482
  */
2419
2483
  EventId: string;
2420
2484
  /**
2421
- * 处置方式
2485
+ * 该字段已废弃。
2422
2486
  注意:此字段可能返回 null,表示取不到有效值。
2423
2487
  */
2424
2488
  DisposalMethod: string;
2425
2489
  /**
2426
- * http_log
2427
- 注意:此字段可能返回 null,表示取不到有效值。
2490
+ * http log。
2428
2491
  */
2429
2492
  HttpLog: string;
2430
2493
  /**
2431
- * user agent
2494
+ * 该字段已废弃。
2432
2495
  注意:此字段可能返回 null,表示取不到有效值。
2433
2496
  */
2434
2497
  Ua: string;
2435
2498
  /**
2436
- * 攻击时间,为保持统一,原参数time更名为AttackTime
2437
- 注意:此字段可能返回 null,表示取不到有效值。
2499
+ * 攻击时间,采用unix秒级时间戳。
2438
2500
  */
2439
2501
  AttackTime: number;
2502
+ /**
2503
+ * 规则相关信息列表。
2504
+ 注意:此字段可能返回 null,表示取不到有效值。
2505
+ */
2506
+ RuleDetailList: Array<SecRuleRelatedInfo>;
2440
2507
  }
2441
2508
  /**
2442
2509
  * 用于对top数据排序的结构体
@@ -2496,9 +2563,9 @@ export interface DeleteApplicationProxyRuleRequest {
2496
2563
  */
2497
2564
  export interface CacheConfigFollowOrigin {
2498
2565
  /**
2499
- * 遵循源站配置开关
2500
- on:开启
2501
- off:关闭
2566
+ * 遵循源站配置开关,取值有:
2567
+ <li>on:开启;</li>
2568
+ <li>off:关闭。</li>
2502
2569
  注意:此字段可能返回 null,表示取不到有效值。
2503
2570
  */
2504
2571
  Switch: string;
@@ -2562,11 +2629,11 @@ export interface DescribeTopL7AnalysisDataRequest {
2562
2629
  */
2563
2630
  export interface TopNEntry {
2564
2631
  /**
2565
- * Entry key
2632
+ * top查询维度值。
2566
2633
  */
2567
2634
  Key: string;
2568
2635
  /**
2569
- * TopN数据
2636
+ * 查询具体数据。
2570
2637
  */
2571
2638
  Value: Array<TopNEntryValue>;
2572
2639
  }
@@ -2575,28 +2642,23 @@ export interface TopNEntry {
2575
2642
  */
2576
2643
  export interface DescribeApplicationProxyResponse {
2577
2644
  /**
2578
- * 数据列表
2579
- 注意:此字段可能返回 null,表示取不到有效值。
2645
+ * 应用代理列表。
2580
2646
  */
2581
2647
  Data: Array<ApplicationProxy>;
2582
2648
  /**
2583
- * 记录总数
2584
- 注意:此字段可能返回 null,表示取不到有效值。
2649
+ * 记录总数。
2585
2650
  */
2586
2651
  TotalCount: number;
2587
2652
  /**
2588
- * 字段已废弃
2589
- 注意:此字段可能返回 null,表示取不到有效值。
2653
+ * 字段已废弃。
2590
2654
  */
2591
2655
  Quota: number;
2592
2656
  /**
2593
- * 表示套餐内PlatType为ip的Anycast IP实例数量
2594
- 注意:此字段可能返回 null,表示取不到有效值。
2657
+ * 当ProxyId为空时,表示套餐内PlatType为ip的Anycast IP的实例数量。
2595
2658
  */
2596
2659
  IpCount: number;
2597
2660
  /**
2598
- * 表示套餐内PlatType为domain的CNAME实例数量
2599
- 注意:此字段可能返回 null,表示取不到有效值。
2661
+ * 当ProxyId为空时,表示套餐内PlatType为domain的CNAME的实例数量。
2600
2662
  */
2601
2663
  DomainCount: number;
2602
2664
  /**
@@ -2714,11 +2776,13 @@ export interface IdentifyZoneResponse {
2714
2776
  */
2715
2777
  export interface WebSocket {
2716
2778
  /**
2717
- * WebSocket 超时配置开关, 开关为off时,平台仍支持WebSocket连接,此时超时时间默认为15秒,若需要调整超时时间,将开关置为on.
2779
+ * WebSocket 超时时间配置开关,取值有:
2780
+ <li>on:使用Timeout作为WebSocket超时时间;</li>
2781
+ <li>off:平台仍支持WebSocket连接,此时使用系统默认的15秒为超时时间。</li>
2718
2782
  */
2719
2783
  Switch: string;
2720
2784
  /**
2721
- * 设置超时时间,单位为秒,最大超时时间120秒。
2785
+ * 超时时间,单位为秒,最大超时时间120秒。
2722
2786
  */
2723
2787
  Timeout?: number;
2724
2788
  }
@@ -2804,15 +2868,17 @@ export interface DescribeDnssecRequest {
2804
2868
  */
2805
2869
  export interface DescribeWebProtectionLogResponse {
2806
2870
  /**
2807
- * 限速拦截Data
2871
+ * 限速拦截数据内容。
2808
2872
  */
2809
2873
  Data: CCLogData;
2810
2874
  /**
2811
- * 状态,1:失败,0:成功
2875
+ * 请求响应状态,取值有:
2876
+ <li>1 :失败 ;</li>
2877
+ <li>0 :成功 。</li>
2812
2878
  */
2813
2879
  Status: number;
2814
2880
  /**
2815
- * 返回信息
2881
+ * 请求响应信息。
2816
2882
  */
2817
2883
  Msg: string;
2818
2884
  /**
@@ -2947,27 +3013,27 @@ export interface SecurityConfig {
2947
3013
  */
2948
3014
  export interface DDosMajorAttackEventData {
2949
3015
  /**
2950
- * DDosMajorAttackEvent ddos 攻击事件
3016
+ * DDosMajorAttackEvent ddos 攻击事件。
2951
3017
  注意:此字段可能返回 null,表示取不到有效值。
2952
3018
  */
2953
3019
  List: Array<DDosMajorAttackEvent>;
2954
3020
  /**
2955
- * 当前页
3021
+ * 分页拉取的起始页号。最小值:1。
2956
3022
  注意:此字段可能返回 null,表示取不到有效值。
2957
3023
  */
2958
3024
  PageNo: number;
2959
3025
  /**
2960
- * 每页展示条数
3026
+ * 分页拉取的最大返回结果数。最大值:1000。
2961
3027
  注意:此字段可能返回 null,表示取不到有效值。
2962
3028
  */
2963
3029
  PageSize: number;
2964
3030
  /**
2965
- * 总页数
3031
+ * 总页数。
2966
3032
  注意:此字段可能返回 null,表示取不到有效值。
2967
3033
  */
2968
3034
  Pages: number;
2969
3035
  /**
2970
- * 总条数
3036
+ * 总条数。
2971
3037
  注意:此字段可能返回 null,表示取不到有效值。
2972
3038
  */
2973
3039
  TotalSize: number;
@@ -3080,6 +3146,17 @@ export interface TopDataRecord {
3080
3146
  */
3081
3147
  DetailData: Array<TopDetailData>;
3082
3148
  }
3149
+ /**
3150
+ * Ipv6访问配置
3151
+ */
3152
+ export interface Ipv6Access {
3153
+ /**
3154
+ * Ipv6访问功能配置,取值有:
3155
+ <li>on:开启Ipv6访问功能;</li>
3156
+ <li>off:关闭Ipv6访问功能。</li>
3157
+ */
3158
+ Switch: string;
3159
+ }
3083
3160
  /**
3084
3161
  * DDoS协议防护+连接防护
3085
3162
  */
@@ -3147,78 +3224,74 @@ export interface DDoSAntiPly {
3147
3224
  */
3148
3225
  export interface DescribeWebManagedRulesDataRequest {
3149
3226
  /**
3150
- * 开始时间
3227
+ * 开始时间,RFC3339格式。
3151
3228
  */
3152
3229
  StartTime: string;
3153
3230
  /**
3154
- * 结束时间
3231
+ * 结束时间,RFC3339格式。
3155
3232
  */
3156
3233
  EndTime: string;
3157
3234
  /**
3158
- * 统计指标列表
3235
+ * 统计指标列表,取值有:
3236
+ <li>waf_interceptNum :waf拦截次数 。</li>
3159
3237
  */
3160
3238
  MetricNames: Array<string>;
3161
3239
  /**
3162
- * 站点id列表
3240
+ * 站点id列表,不填默认选择全部站点。
3163
3241
  */
3164
3242
  ZoneIds?: Array<string>;
3165
3243
  /**
3166
- * 子域名列表
3244
+ * 子域名列表,不填默认选择子域名。
3167
3245
  */
3168
3246
  Domains?: Array<string>;
3169
3247
  /**
3170
- * 协议类型
3248
+ * 该字段已废弃,请勿传。
3171
3249
  */
3172
3250
  ProtocolType?: string;
3173
3251
  /**
3174
- * "webshell" : Webshell检测防护
3175
- "oa" : 常见OA漏洞防护
3176
- "xss" : XSS跨站脚本攻击防护
3177
- "xxe" : XXE攻击防护
3178
- "webscan" : 扫描器攻击漏洞防护
3179
- "cms" : 常见CMS漏洞防护
3180
- "upload" : 恶意文件上传攻击防护
3181
- "sql" : SQL注入攻击防护
3182
- "cmd_inject": 命令/代码注入攻击防护
3183
- "osc" : 开源组件漏洞防护
3184
- "file_read" : 任意文件读取
3185
- "ldap" : LDAP注入攻击防护
3186
- "other" : 其它漏洞防护
3187
-
3188
- "all":"所有"
3252
+ * 该字段已废弃,请勿传。
3189
3253
  */
3190
3254
  AttackType?: string;
3191
3255
  /**
3192
- * 查询时间粒度,可选{min,5min,hour,day}
3256
+ * 查询时间粒度,取值有:
3257
+ <li>min :1分钟 ;</li>
3258
+ <li>5min :5分钟 ;</li>
3259
+ <li>hour :1小时 ;</li>
3260
+ <li>day :1天 。</li>
3193
3261
  */
3194
3262
  Interval?: string;
3263
+ /**
3264
+ * 筛选条件,取值有:
3265
+ <li>action :执行动作 。</li>
3266
+ */
3267
+ QueryCondition?: Array<QueryCondition>;
3195
3268
  }
3196
3269
  /**
3197
3270
  * DDos攻击源数据
3198
3271
  */
3199
3272
  export interface DDosAttackSourceEventData {
3200
3273
  /**
3201
- * DDos攻击源数据集合
3274
+ * DDos攻击源数据集合。
3202
3275
  注意:此字段可能返回 null,表示取不到有效值。
3203
3276
  */
3204
3277
  List: Array<DDosAttackSourceEvent>;
3205
3278
  /**
3206
- * 当前页
3279
+ * 分页拉取的起始页号。最小值:1。
3207
3280
  注意:此字段可能返回 null,表示取不到有效值。
3208
3281
  */
3209
3282
  PageNo: number;
3210
3283
  /**
3211
- * 每页展示条数
3284
+ * 分页拉取的最大返回结果数。最大值:1000。
3212
3285
  注意:此字段可能返回 null,表示取不到有效值。
3213
3286
  */
3214
3287
  PageSize: number;
3215
3288
  /**
3216
- * 总页数
3289
+ * 总页数。
3217
3290
  注意:此字段可能返回 null,表示取不到有效值。
3218
3291
  */
3219
3292
  Pages: number;
3220
3293
  /**
3221
- * 总条数
3294
+ * 总条数。
3222
3295
  注意:此字段可能返回 null,表示取不到有效值。
3223
3296
  */
3224
3297
  TotalSize: number;
@@ -3638,51 +3711,48 @@ export interface DeleteLoadBalancingResponse {
3638
3711
  */
3639
3712
  export interface DescribeWebProtectionDataRequest {
3640
3713
  /**
3641
- * 开始时间
3714
+ * 开始时间,RFC3339格式。
3642
3715
  */
3643
3716
  StartTime: string;
3644
3717
  /**
3645
- * 结束时间
3718
+ * 结束时间,RFC3339格式。
3646
3719
  */
3647
3720
  EndTime: string;
3648
3721
  /**
3649
- * 统计指标列表
3722
+ * 统计指标列表,取值有:
3723
+ <li>ccRate_interceptNum :速率限制规则限制次数 ;</li>
3724
+ <li>ccAcl_interceptNum :自定义规则拦截次数 。</li>
3650
3725
  */
3651
3726
  MetricNames: Array<string>;
3652
3727
  /**
3653
- * 站点id列表
3728
+ * 站点id列表,不填默认选择全部站点。
3654
3729
  */
3655
3730
  ZoneIds?: Array<string>;
3656
3731
  /**
3657
- * 子域名列表
3732
+ * 子域名列表,不填默认选择全部子域名。
3658
3733
  */
3659
3734
  Domains?: Array<string>;
3660
3735
  /**
3661
- * 协议类型
3736
+ * 该字段已废弃,请勿传。
3662
3737
  */
3663
3738
  ProtocolType?: string;
3664
3739
  /**
3665
- * "webshell" : Webshell检测防护
3666
- "oa" : 常见OA漏洞防护
3667
- "xss" : XSS跨站脚本攻击防护
3668
- "xxe" : XXE攻击防护
3669
- "webscan" : 扫描器攻击漏洞防护
3670
- "cms" : 常见CMS漏洞防护
3671
- "upload" : 恶意文件上传攻击防护
3672
- "sql" : SQL注入攻击防护
3673
- "cmd_inject": 命令/代码注入攻击防护
3674
- "osc" : 开源组件漏洞防护
3675
- "file_read" : 任意文件读取
3676
- "ldap" : LDAP注入攻击防护
3677
- "other" : 其它漏洞防护
3678
-
3679
- "all":"所有"
3740
+ * 该字段已废弃,请勿传。
3680
3741
  */
3681
3742
  AttackType?: string;
3682
3743
  /**
3683
- * 查询时间粒度,可选{min,5min,hour,day}
3744
+ * 查询时间粒度,取值有:
3745
+ <li>min :1分钟 ;</li>
3746
+ <li>5min :5分钟 ;</li>
3747
+ <li>hour :1小时 ;</li>
3748
+ <li>day :1天 。</li>
3684
3749
  */
3685
3750
  Interval?: string;
3751
+ /**
3752
+ * 筛选条件,取值有:
3753
+ <li>action :执行动作 。</li>
3754
+ */
3755
+ QueryCondition?: Array<QueryCondition>;
3686
3756
  }
3687
3757
  /**
3688
3758
  * CheckCertificate请求参数结构体
@@ -3796,15 +3866,15 @@ export interface BotManagedRuleDetail {
3796
3866
  */
3797
3867
  export interface ForceRedirect {
3798
3868
  /**
3799
- * 访问强制跳转配置开关
3800
- on:开启
3801
- off:关闭
3869
+ * 访问强制跳转配置开关,取值有:
3870
+ <li>on:开启;</li>
3871
+ <li>off:关闭。</li>
3802
3872
  */
3803
3873
  Switch: string;
3804
3874
  /**
3805
- * 重定向状态码
3806
- 301
3807
- 302
3875
+ * 重定向状态码,取值有:
3876
+ <li>301:301跳转;</li>
3877
+ <li>302:302跳转。</li>
3808
3878
  注意:此字段可能返回 null,表示取不到有效值。
3809
3879
  */
3810
3880
  RedirectStatusCode?: number;
@@ -3814,37 +3884,40 @@ off:关闭
3814
3884
  */
3815
3885
  export interface ModifyApplicationProxyRequest {
3816
3886
  /**
3817
- * 站点ID
3887
+ * 站点ID
3818
3888
  */
3819
3889
  ZoneId: string;
3820
3890
  /**
3821
- * 代理ID
3891
+ * 代理ID
3822
3892
  */
3823
3893
  ProxyId: string;
3824
3894
  /**
3825
- * 代理名称
3826
- 当ProxyType=hostname时,表示域名或者子域名
3827
- 当ProxyType=instance时,表示实例名称
3895
+ * 当ProxyType=hostname时,表示域名或子域名;
3896
+ 当ProxyType=instance时,表示代理名称。
3828
3897
  */
3829
3898
  ProxyName: string;
3830
3899
  /**
3831
- * 参数已经废弃
3900
+ * 参数已经废弃。
3832
3901
  */
3833
3902
  ForwardClientIp: string;
3834
3903
  /**
3835
- * 参数已经废弃
3904
+ * 参数已经废弃。
3836
3905
  */
3837
3906
  SessionPersist: boolean;
3838
3907
  /**
3839
- * 会话保持时间,取值范围:30-3600,单位:秒
3908
+ * 会话保持时间,不填写保持原有配置。取值范围:30-3600,单位:秒。
3840
3909
  */
3841
3910
  SessionPersistTime?: number;
3842
3911
  /**
3843
- * 服务类型
3844
- hostname:子域名模式
3845
- instance:实例模式
3912
+ * 四层代理模式,取值有:
3913
+ <li>hostname:表示子域名模式;</li>
3914
+ <li>instance:表示实例模式。</li>不填写保持原有配置。
3846
3915
  */
3847
3916
  ProxyType?: string;
3917
+ /**
3918
+ * Ipv6访问配置,不填写保持原有配置。
3919
+ */
3920
+ Ipv6?: Ipv6Access;
3848
3921
  }
3849
3922
  /**
3850
3923
  * ModifyApplicationProxyStatus返回参数结构体
@@ -3988,11 +4061,13 @@ export interface DescribeDefaultCertificatesResponse {
3988
4061
  */
3989
4062
  export interface CachePrefresh {
3990
4063
  /**
3991
- * 缓存预刷新配置开关
4064
+ * 缓存预刷新配置开关,取值有:
4065
+ <li>on:开启;</li>
4066
+ <li>off:关闭。</li>
3992
4067
  */
3993
4068
  Switch: string;
3994
4069
  /**
3995
- * 缓存预刷新百分比:1-99
4070
+ * 缓存预刷新百分比,取值范围:1-99
3996
4071
  注意:此字段可能返回 null,表示取不到有效值。
3997
4072
  */
3998
4073
  Percent?: number;
@@ -4249,28 +4324,33 @@ both:同时被仅DNS和代理加速类型负载均衡使用
4249
4324
  */
4250
4325
  export interface DescribeApplicationProxyRequest {
4251
4326
  /**
4252
- * 站点ID
4327
+ * 站点ID
4253
4328
  */
4254
4329
  ZoneId?: string;
4255
4330
  /**
4256
- * 分页参数Offset
4331
+ * 分页查询偏移量,默认为0。
4257
4332
  */
4258
4333
  Offset?: number;
4259
4334
  /**
4260
- * 分页参数Limit
4335
+ * 分页查询限制数目,默认为10,最大可设置为1000。
4261
4336
  */
4262
4337
  Limit?: number;
4338
+ /**
4339
+ * 代理ID。
4340
+ 当ProxyId为空时,表示查询站点下所有应用代理的列表。
4341
+ */
4342
+ ProxyId?: string;
4263
4343
  }
4264
4344
  /**
4265
4345
  * TopN数据Entry
4266
4346
  */
4267
4347
  export interface TopNEntryValue {
4268
4348
  /**
4269
- * Entry的name
4349
+ * 排序实体名。
4270
4350
  */
4271
4351
  Name: string;
4272
4352
  /**
4273
- * 数量
4353
+ * 排序实体数量。
4274
4354
  */
4275
4355
  Count: number;
4276
4356
  }
@@ -4348,39 +4428,51 @@ export interface WebAttackEvent {
4348
4428
  */
4349
4429
  export interface DescribeDDosAttackTopDataRequest {
4350
4430
  /**
4351
- * 开始时间
4431
+ * 开始时间。
4352
4432
  */
4353
4433
  StartTime: string;
4354
4434
  /**
4355
- * 结束时间
4435
+ * 结束时间。
4356
4436
  */
4357
4437
  EndTime: string;
4358
4438
  /**
4359
- * 过滤指标
4439
+ * 统计指标列表,取值有:
4440
+ <li>ddos_attackFlux_protocol :攻击总流量协议类型分布排行 ;</li>
4441
+ <li>ddos_attackPackageNum_protocol :攻击总包量协议类型分布排行 ;</li>
4442
+ <li>ddos_attackNum_attackType :攻击总次数攻击类型分布排行 ;</li>
4443
+ <li>ddos_attackNum_sregion :攻击总次数攻击源地区分布排行 ;</li>
4444
+ <li>ddos_attackFlux_sip :攻击总流量攻击源ip分布排行 ;</li>
4445
+ <li>ddos_attackFlux_sregion :攻击总流量攻击源地区分布排行 。</li>
4360
4446
  */
4361
4447
  MetricName: string;
4362
4448
  /**
4363
- * 查询前多少名,传值为0 全量
4449
+ * 查询前多少个,传值为0返回全量。
4364
4450
  */
4365
4451
  Limit: number;
4366
4452
  /**
4367
- * 站点集合
4453
+ * 站点id集合,不填默认选择全部站点。
4368
4454
  */
4369
4455
  ZoneIds?: Array<string>;
4370
4456
  /**
4371
- * ddos策略组id 集合
4457
+ * ddos策略组id 集合,不填默认选择全部策略id。
4372
4458
  */
4373
4459
  PolicyIds?: Array<number>;
4374
4460
  /**
4375
- * 端口号
4461
+ * 端口号。
4376
4462
  */
4377
4463
  Port?: number;
4378
4464
  /**
4379
- * 协议类型,tcp,udp,all
4465
+ * 协议类型,取值有:
4466
+ <li>tcp ;</li>
4467
+ <li>udp ;</li>
4468
+ <li>all 。</li>
4380
4469
  */
4381
4470
  ProtocolType?: string;
4382
4471
  /**
4383
- * 攻击类型,flood,icmpFlood......,all
4472
+ * 攻击类型,取值有:
4473
+ <li>flood ;</li>
4474
+ <li>icmpFlood ;</li>
4475
+ <li>all 。</li>
4384
4476
  */
4385
4477
  AttackType?: string;
4386
4478
  }
@@ -4402,39 +4494,53 @@ export interface CreateApplicationProxyRuleResponse {
4402
4494
  */
4403
4495
  export interface DescribeDDosAttackDataRequest {
4404
4496
  /**
4405
- * 开始时间
4497
+ * 开始时间。
4406
4498
  */
4407
4499
  StartTime: string;
4408
4500
  /**
4409
- * 结束时间
4501
+ * 结束时间。
4410
4502
  */
4411
4503
  EndTime: string;
4412
4504
  /**
4413
- * 统计指标列表
4505
+ * 统计指标列表,取值有:
4506
+ <li>ddos_attackMaxBandwidth :攻击带宽峰值 ;</li>
4507
+ <li>ddos_attackMaxPackageRate:攻击包速率峰值 ;</li>
4508
+ <li>ddos_attackBandwidth :攻击带宽曲线 ;</li>
4509
+ <li>ddos_attackPackageRate :攻击包速率曲线 。</li>
4414
4510
  */
4415
4511
  MetricNames: Array<string>;
4416
4512
  /**
4417
- * 站点id列表
4513
+ * 站点id列表,不填默认选择全部站点。
4418
4514
  */
4419
4515
  ZoneIds?: Array<string>;
4420
4516
  /**
4421
- * ddos策略组id列表
4517
+ * ddos策略组id列表,不填默认选择全部策略id。
4422
4518
  */
4423
4519
  PolicyIds?: Array<number>;
4424
4520
  /**
4425
- * 端口号
4521
+ * 端口号。
4426
4522
  */
4427
4523
  Port?: number;
4428
4524
  /**
4429
- * 协议类型,tcp,udp,all
4525
+ * 协议类型,取值有:
4526
+ <li>tcp ;</li>
4527
+ <li>udp ;</li>
4528
+ <li>all 。</li>
4430
4529
  */
4431
4530
  ProtocolType?: string;
4432
4531
  /**
4433
- * 攻击类型,flood,icmpFlood......,all
4532
+ * 攻击类型,取值有:
4533
+ <li>flood ;</li>
4534
+ <li>icmpFlood ;</li>
4535
+ <li>all 。</li>
4434
4536
  */
4435
4537
  AttackType?: string;
4436
4538
  /**
4437
- * 查询时间粒度,可选{min,5min,hour,day}
4539
+ * 查询时间粒度,取值有:
4540
+ <li>min :1分钟 ;</li>
4541
+ <li>5min :5分钟 ;</li>
4542
+ <li>hour :1小时 ;</li>
4543
+ <li>day :1天 。</li>
4438
4544
  */
4439
4545
  Interval?: string;
4440
4546
  }
@@ -4544,12 +4650,12 @@ export interface RateLimitTemplateDetail {
4544
4650
  */
4545
4651
  export interface TimingDataItem {
4546
4652
  /**
4547
- * 秒级时间戳
4653
+ * 返回数据对应时间点,采用unix秒级时间戳
4548
4654
  注意:此字段可能返回 null,表示取不到有效值。
4549
4655
  */
4550
4656
  Timestamp: number;
4551
4657
  /**
4552
- * 数值
4658
+ * 具体数值
4553
4659
  注意:此字段可能返回 null,表示取不到有效值。
4554
4660
  */
4555
4661
  Value: number;
@@ -4559,55 +4665,64 @@ export interface TimingDataItem {
4559
4665
  */
4560
4666
  export interface CreateApplicationProxyRequest {
4561
4667
  /**
4562
- * 站点ID
4668
+ * 站点ID
4563
4669
  */
4564
4670
  ZoneId: string;
4565
4671
  /**
4566
- * 站点名称
4672
+ * 站点名称。
4567
4673
  */
4568
4674
  ZoneName: string;
4569
4675
  /**
4570
- * 代理名称
4571
- 当ProxyType=hostname时,表示域名或者子域名
4572
- 当ProxyType=instance时,表示实例名称
4676
+ * 规则详细信息。
4677
+ */
4678
+ Rule: Array<ApplicationProxyRule>;
4679
+ /**
4680
+ * 当ProxyType=hostname时,表示域名或子域名;
4681
+ 当ProxyType=instance时,表示代理名称。
4573
4682
  */
4574
4683
  ProxyName: string;
4575
4684
  /**
4576
- * 调度模式:
4577
- ip表示Anycast IP
4578
- domain表示CNAME
4685
+ * 调度模式,取值有:
4686
+ <li>ip:表示Anycast IP调度;</li>
4687
+ <li>domain:表示CNAME调度。</li>
4579
4688
  */
4580
4689
  PlatType: string;
4581
4690
  /**
4582
- * 0关闭安全,1开启安全
4691
+ * 是否开启安全,取值有:
4692
+ <li>0:关闭安全;</li>
4693
+ <li>1:开启安全。</li>
4583
4694
  */
4584
4695
  SecurityType: number;
4585
4696
  /**
4586
- * 0关闭加速,1开启加速
4697
+ * 是否开启加速,取值有:
4698
+ <li>0:关闭加速;</li>
4699
+ <li>1:开启加速。</li>
4587
4700
  */
4588
4701
  AccelerateType: number;
4589
4702
  /**
4590
- * 字段已经移至Rule.ForwardClientIp
4703
+ * 字段已经废弃。
4591
4704
  */
4592
- ForwardClientIp: string;
4705
+ SessionPersist: boolean;
4593
4706
  /**
4594
- * 字段已经移至Rule.SessionPersist
4707
+ * 字段已经废弃。
4595
4708
  */
4596
- SessionPersist: boolean;
4709
+ ForwardClientIp: string;
4597
4710
  /**
4598
- * 规则详细信息
4711
+ * 四层代理模式,取值有:
4712
+ <li>hostname:表示子域名模式;</li>
4713
+ <li>instance:表示实例模式。</li>不填写使用默认值instance。
4599
4714
  */
4600
- Rule: Array<ApplicationProxyRule>;
4715
+ ProxyType?: string;
4601
4716
  /**
4602
- * 会话保持时间,取值范围:30-3600,单位:秒
4717
+ * 会话保持时间,取值范围:30-3600,单位:秒。
4718
+ 不填写使用默认值600。
4603
4719
  */
4604
4720
  SessionPersistTime?: number;
4605
4721
  /**
4606
- * 服务类型
4607
- hostname:子域名模式
4608
- instance:实例模式
4722
+ * Ipv6访问配置。
4723
+ 不填写表示关闭Ipv6访问。
4609
4724
  */
4610
- ProxyType?: string;
4725
+ Ipv6?: Ipv6Access;
4611
4726
  }
4612
4727
  /**
4613
4728
  * DescribeTopL7AnalysisData返回参数结构体
@@ -4666,13 +4781,13 @@ export interface IntelligenceRule {
4666
4781
  */
4667
4782
  export interface PostMaxSize {
4668
4783
  /**
4669
- * 是调整POST请求限制,平台默认为32MB
4670
- 关闭:off,
4671
- 开启:on。
4784
+ * 是否开启POST请求上传文件限制,平台默认为限制为32MB,取值有:
4785
+ <li>on:开启限制;</li>
4786
+ <li>off:关闭限制。</li>
4672
4787
  */
4673
4788
  Switch: string;
4674
4789
  /**
4675
- * 最大限制,取值在1MB和500MB之间。单位字节
4790
+ * 最大限制,取值在1MB和500MB之间。单位字节。
4676
4791
  注意:此字段可能返回 null,表示取不到有效值。
4677
4792
  */
4678
4793
  MaxSize?: number;
@@ -5046,98 +5161,95 @@ export interface WebEventData {
5046
5161
  */
5047
5162
  export interface ApplicationProxy {
5048
5163
  /**
5049
- * 代理ID
5050
- 注意:此字段可能返回 null,表示取不到有效值。
5164
+ * 代理ID
5051
5165
  */
5052
5166
  ProxyId?: string;
5053
5167
  /**
5054
- * 代理名称
5055
- 当ProxyType=hostname时,表示域名或者子域名
5056
- 当ProxyType=instance时,表示实例名称
5168
+ * 当ProxyType=hostname时,表示域名或子域名;
5169
+ 当ProxyType=instance时,表示代理名称。
5057
5170
  */
5058
5171
  ProxyName: string;
5059
5172
  /**
5060
- * 调度模式:
5061
- ip表示Anycast IP
5062
- domain表示CNAME
5173
+ * 调度模式,取值有:
5174
+ <li>ip:表示Anycast IP调度;</li>
5175
+ <li>domain:表示CNAME调度。</li>
5063
5176
  */
5064
5177
  PlatType: string;
5065
5178
  /**
5066
- * 0关闭安全,1开启安全
5179
+ * 是否开启安全,取值有:
5180
+ <li>0:关闭安全;</li>
5181
+ <li>1:开启安全。</li>
5067
5182
  */
5068
5183
  SecurityType: number;
5069
5184
  /**
5070
- * 0关闭加速,1开启加速
5185
+ * 是否开启加速,取值有:
5186
+ <li>0:关闭加速;</li>
5187
+ <li>1:开启加速。</li>
5071
5188
  */
5072
5189
  AccelerateType: number;
5073
5190
  /**
5074
- * 字段已经移至Rule.ForwardClientIp
5191
+ * 字段已经废弃。
5075
5192
  */
5076
5193
  ForwardClientIp: string;
5077
5194
  /**
5078
- * 字段已经移至Rule.SessionPersist
5195
+ * 字段已经废弃。
5079
5196
  */
5080
5197
  SessionPersist: boolean;
5081
5198
  /**
5082
- * 规则列表
5199
+ * 规则列表。
5083
5200
  */
5084
5201
  Rule: Array<ApplicationProxyRule>;
5085
5202
  /**
5086
- * 状态:
5087
- online:启用
5088
- offline:停用
5089
- progress:部署中
5090
- stopping:停用中
5091
- fail:部署失败/停用失败
5092
- 注意:此字段可能返回 null,表示取不到有效值。
5203
+ * 状态,取值有:
5204
+ <li>online:启用;</li>
5205
+ <li>offline:停用;</li>
5206
+ <li>progress:部署中;</li>
5207
+ <li>stopping:停用中;</li>
5208
+ <li>fail:部署失败/停用失败。</li>
5093
5209
  */
5094
5210
  Status: string;
5095
5211
  /**
5096
- * 调度信息
5097
- 注意:此字段可能返回 null,表示取不到有效值。
5212
+ * 调度信息。
5098
5213
  */
5099
5214
  ScheduleValue: Array<string>;
5100
5215
  /**
5101
- * 更新时间
5102
- 注意:此字段可能返回 null,表示取不到有效值。
5216
+ * 更新时间。
5103
5217
  */
5104
5218
  UpdateTime: string;
5105
5219
  /**
5106
- * 站点ID
5107
- 注意:此字段可能返回 null,表示取不到有效值。
5220
+ * 站点ID
5108
5221
  */
5109
5222
  ZoneId: string;
5110
5223
  /**
5111
- * 站点名称
5112
- 注意:此字段可能返回 null,表示取不到有效值。
5224
+ * 站点名称。
5113
5225
  */
5114
5226
  ZoneName: string;
5115
5227
  /**
5116
- * 会话保持时间
5117
- 注意:此字段可能返回 null,表示取不到有效值。
5228
+ * 会话保持时间。
5118
5229
  */
5119
5230
  SessionPersistTime: number;
5120
5231
  /**
5121
- * 服务类型
5122
- hostname:子域名模式
5123
- instance:实例模式
5124
- 注意:此字段可能返回 null,表示取不到有效值。
5232
+ * 四层代理模式,取值有:
5233
+ <li>hostname:表示子域名模式;</li>
5234
+ <li>instance:表示实例模式。</li>
5125
5235
  */
5126
5236
  ProxyType: string;
5127
5237
  /**
5128
5238
  * 当ProxyType=hostname时:
5129
- ProxyName为域名,如:test.123.com
5130
- HostId表示该域名,即test.123.com对应的代理加速唯一标识
5131
- 注意:此字段可能返回 null,表示取不到有效值。
5239
+ 表示代理加速唯一标识。
5132
5240
  */
5133
5241
  HostId: string;
5242
+ /**
5243
+ * Ipv6访问配置。
5244
+ */
5245
+ Ipv6: Ipv6Access;
5134
5246
  }
5135
5247
  /**
5136
5248
  * ModifyApplicationProxy返回参数结构体
5137
5249
  */
5138
5250
  export interface ModifyApplicationProxyResponse {
5139
5251
  /**
5140
- * 代理ID
5252
+ * 代理ID
5141
5253
  */
5142
5254
  ProxyId: string;
5143
5255
  /**
@@ -5159,19 +5271,21 @@ export interface DescribeDDoSPolicyResponse {
5159
5271
  */
5160
5272
  export interface CacheKey {
5161
5273
  /**
5162
- * 是否开启全路径缓存
5163
- on:开启全路径缓存(即关闭参数忽略)
5164
- off:关闭全路径缓存(即开启参数忽略)
5274
+ * 是否开启全路径缓存,取值有:
5275
+ <li>on:开启全路径缓存(即关闭参数忽略);</li>
5276
+ <li>off:关闭全路径缓存(即开启参数忽略)。</li>
5165
5277
  注意:此字段可能返回 null,表示取不到有效值。
5166
5278
  */
5167
5279
  FullUrlCache?: string;
5168
5280
  /**
5169
- * 是否忽略大小写缓存
5281
+ * 是否忽略大小写缓存,取值有:
5282
+ <li>on:忽略;</li>
5283
+ <li>off:不忽略。</li>
5170
5284
  注意:此字段可能返回 null,表示取不到有效值。
5171
5285
  */
5172
5286
  IgnoreCase?: string;
5173
5287
  /**
5174
- * CacheKey中包含请求参数
5288
+ * CacheKey中包含请求参数。
5175
5289
  注意:此字段可能返回 null,表示取不到有效值。
5176
5290
  */
5177
5291
  QueryString?: QueryString;
@@ -5260,11 +5374,11 @@ export interface DescribeTimingL7CacheDataResponse {
5260
5374
  */
5261
5375
  export interface DescribeApplicationProxyDetailRequest {
5262
5376
  /**
5263
- * 站点ID
5377
+ * 站点ID
5264
5378
  */
5265
5379
  ZoneId: string;
5266
5380
  /**
5267
- * 实例ID
5381
+ * 实例ID
5268
5382
  */
5269
5383
  ProxyId: string;
5270
5384
  }
@@ -5342,15 +5456,17 @@ export interface VanityNameServersIps {
5342
5456
  */
5343
5457
  export interface DescribeDDosAttackSourceEventResponse {
5344
5458
  /**
5345
- * DDos攻击源数据
5459
+ * DDos攻击源数据。
5346
5460
  */
5347
5461
  Data: DDosAttackSourceEventData;
5348
5462
  /**
5349
- * 状态,1:失败,0:成功
5463
+ * 请求响应状态,取值有:
5464
+ <li>1 :失败 ;</li>
5465
+ <li>0 :成功 。</li>
5350
5466
  */
5351
5467
  Status: number;
5352
5468
  /**
5353
- * 返回信息
5469
+ * 请求响应信息。
5354
5470
  */
5355
5471
  Msg: string;
5356
5472
  /**
@@ -5385,12 +5501,12 @@ export interface DescribeDDoSPolicyRequest {
5385
5501
  */
5386
5502
  export interface SecEntry {
5387
5503
  /**
5388
- * Entry的Key
5504
+ * 查询维度值。
5389
5505
  注意:此字段可能返回 null,表示取不到有效值。
5390
5506
  */
5391
5507
  Key: string;
5392
5508
  /**
5393
- * Entry的Value
5509
+ * 查询维度下详细数据。
5394
5510
  注意:此字段可能返回 null,表示取不到有效值。
5395
5511
  */
5396
5512
  Value: Array<SecEntryValue>;
@@ -5400,31 +5516,34 @@ export interface SecEntry {
5400
5516
  */
5401
5517
  export interface DescribeDDosMajorAttackEventRequest {
5402
5518
  /**
5403
- * 开始时间
5519
+ * 开始时间。
5404
5520
  */
5405
5521
  StartTime: string;
5406
5522
  /**
5407
- * 结束时间
5523
+ * 结束时间。
5408
5524
  */
5409
5525
  EndTime: string;
5410
5526
  /**
5411
- * 条数
5527
+ * 分页拉取的最大返回结果数。最大值:1000。
5412
5528
  */
5413
5529
  PageSize: number;
5414
5530
  /**
5415
- * 当前页
5531
+ * 分页拉取的起始页号。最小值:1。
5416
5532
  */
5417
5533
  PageNo: number;
5418
5534
  /**
5419
- * ddos 策略组id集合
5535
+ * ddos 策略组id集合,不填默认选择全部策略id。
5420
5536
  */
5421
5537
  PolicyIds?: Array<number>;
5422
5538
  /**
5423
- * 协议类型,{tcp,udp,all}
5539
+ * 协议类型,取值有:
5540
+ <li>tcp ;</li>
5541
+ <li>udp ;</li>
5542
+ <li>all 。</li>
5424
5543
  */
5425
5544
  ProtocolType?: string;
5426
5545
  /**
5427
- * 站点集合
5546
+ * 站点id列表,不填默认选择全部站点。
5428
5547
  */
5429
5548
  ZoneIds?: Array<string>;
5430
5549
  }
@@ -5433,7 +5552,9 @@ export interface DescribeDDosMajorAttackEventRequest {
5433
5552
  */
5434
5553
  export interface Quic {
5435
5554
  /**
5436
- * 是否启动Quic配置
5555
+ * 是否开启Quic配置,取值有:
5556
+ <li>on:开启;</li>
5557
+ <li>off:关闭。</li>
5437
5558
  */
5438
5559
  Switch: string;
5439
5560
  }
@@ -5481,18 +5602,21 @@ export interface DescribeSecurityPolicyResponse {
5481
5602
  */
5482
5603
  export interface QueryString {
5483
5604
  /**
5484
- * on | off CacheKey是否由QueryString组成
5605
+ * CacheKey是否由QueryString组成,取值有:
5606
+ <li>on:是;</li>
5607
+ <li>off:否。</li>
5485
5608
  注意:此字段可能返回 null,表示取不到有效值。
5486
5609
  */
5487
5610
  Switch: string;
5488
5611
  /**
5489
- * includeCustom:使用部分url参数
5490
- excludeCustom:排除部分url参数
5612
+ * CacheKey使用QueryString的方式,取值有:
5613
+ <li>includeCustom:使用部分url参数;</li>
5614
+ <li>excludeCustom:排除部分url参数。</li>
5491
5615
  注意:此字段可能返回 null,表示取不到有效值。
5492
5616
  */
5493
5617
  Action?: string;
5494
5618
  /**
5495
- * 使用/排除的url参数数组
5619
+ * 使用/排除的url参数数组。
5496
5620
  注意:此字段可能返回 null,表示取不到有效值。
5497
5621
  */
5498
5622
  Value?: Array<string>;
@@ -5506,27 +5630,27 @@ export declare type DescribeSecurityPolicyRegionsRequest = null;
5506
5630
  */
5507
5631
  export interface SecEntryValue {
5508
5632
  /**
5509
- * 指标名称
5633
+ * 指标名称。
5510
5634
  注意:此字段可能返回 null,表示取不到有效值。
5511
5635
  */
5512
5636
  Metric: string;
5513
5637
  /**
5514
- * 指标数据明细
5638
+ * 时序数据详情。
5515
5639
  注意:此字段可能返回 null,表示取不到有效值。
5516
5640
  */
5517
5641
  Detail: Array<TimingDataItem>;
5518
5642
  /**
5519
- * 最大值
5643
+ * 最大值。
5520
5644
  注意:此字段可能返回 null,表示取不到有效值。
5521
5645
  */
5522
5646
  Max: number;
5523
5647
  /**
5524
- * 平均值
5648
+ * 平均值。
5525
5649
  注意:此字段可能返回 null,表示取不到有效值。
5526
5650
  */
5527
5651
  Avg: number;
5528
5652
  /**
5529
- * 数据总和
5653
+ * 数据总和。
5530
5654
  注意:此字段可能返回 null,表示取不到有效值。
5531
5655
  */
5532
5656
  Sum: number;
@@ -5636,49 +5760,57 @@ export interface ModifyDefaultCertificateResponse {
5636
5760
  */
5637
5761
  export interface DescribeDDosAttackEventRequest {
5638
5762
  /**
5639
- * 开始时间
5763
+ * 开始时间。
5640
5764
  */
5641
5765
  StartTime: string;
5642
5766
  /**
5643
- * 结束时间
5767
+ * 结束时间。
5644
5768
  */
5645
5769
  EndTime: string;
5646
5770
  /**
5647
- * 条数
5771
+ * 分页拉取的最大返回结果数。最大值:1000。
5648
5772
  */
5649
5773
  PageSize: number;
5650
5774
  /**
5651
- * 当前页
5775
+ * 分页拉取的起始页号。最小值:1。
5652
5776
  */
5653
5777
  PageNo: number;
5654
5778
  /**
5655
- * ddos策略组id 集合
5779
+ * ddos策略组id列表,不填默认选择全部策略Id。
5656
5780
  */
5657
5781
  PolicyIds?: Array<number>;
5658
5782
  /**
5659
- * 站点集合
5783
+ * 站点id列表,不填默认选择全部站点。
5660
5784
  */
5661
5785
  ZoneIds?: Array<string>;
5662
5786
  /**
5663
- * 协议类型,{tcp,udp,all}
5787
+ * 协议类型,取值有:
5788
+ <li>tcp ;</li>
5789
+ <li>udp ;</li>
5790
+ <li>all 。</li>
5664
5791
  */
5665
5792
  ProtocolType?: string;
5666
5793
  /**
5667
- * 选填{Y、N},默认为Y;Y:展示,N:不展示
5794
+ * 是否展示详情,取值有:
5795
+ <li>Y :展示 ;</li>
5796
+ <li>N :不展示 。</li>默认为Y。
5668
5797
  */
5669
5798
  IsShowDetail?: string;
5670
5799
  }
5671
5800
  /**
5672
- * 客户端IP头部
5801
+ * 存储客户端请求IP的头部信息配置
5673
5802
  */
5674
5803
  export interface ClientIp {
5675
5804
  /**
5676
- * 客户端IP头部配置开关
5805
+ * 配置开关,取值有:
5806
+ <li>on:开启;</li>
5807
+ <li>off:关闭。</li>
5677
5808
  注意:此字段可能返回 null,表示取不到有效值。
5678
5809
  */
5679
5810
  Switch: string;
5680
5811
  /**
5681
- * 回源客户端IP请求头名称
5812
+ * 回源时,存放客户端IP的请求头名称。
5813
+ 为空则使用默认值:X-Forwarded-IP。
5682
5814
  注意:此字段可能返回 null,表示取不到有效值。
5683
5815
  */
5684
5816
  HeaderName?: string;
@@ -5725,88 +5857,93 @@ export interface DescribeHostsCertificateResponse {
5725
5857
  */
5726
5858
  export interface DescribeZoneSettingResponse {
5727
5859
  /**
5728
- * 缓存过期时间配置
5729
- 注意:此字段可能返回 null,表示取不到有效值。
5860
+ * 站点ID。
5730
5861
  */
5731
- Cache: CacheConfig;
5862
+ ZoneId: string;
5732
5863
  /**
5733
- * 节点缓存键配置
5734
- 注意:此字段可能返回 null,表示取不到有效值。
5864
+ * 站点名称。
5735
5865
  */
5736
- CacheKey: CacheKey;
5866
+ Zone: string;
5737
5867
  /**
5738
- * 浏览器缓存配置
5868
+ * 缓存过期时间配置。
5739
5869
  注意:此字段可能返回 null,表示取不到有效值。
5740
5870
  */
5741
- MaxAge: MaxAge;
5871
+ Cache: CacheConfig;
5742
5872
  /**
5743
- * 离线缓存
5873
+ * 节点缓存键配置。
5744
5874
  注意:此字段可能返回 null,表示取不到有效值。
5745
5875
  */
5746
- OfflineCache: OfflineCache;
5876
+ CacheKey: CacheKey;
5747
5877
  /**
5748
- * Quic访问
5878
+ * Quic访问配置。
5749
5879
  注意:此字段可能返回 null,表示取不到有效值。
5750
5880
  */
5751
5881
  Quic: Quic;
5752
5882
  /**
5753
- * POST请求传输配置
5883
+ * POST请求传输配置。
5754
5884
  注意:此字段可能返回 null,表示取不到有效值。
5755
5885
  */
5756
5886
  PostMaxSize: PostMaxSize;
5757
5887
  /**
5758
- * 智能压缩配置
5888
+ * 智能压缩配置。
5759
5889
  注意:此字段可能返回 null,表示取不到有效值。
5760
5890
  */
5761
5891
  Compression: Compression;
5762
5892
  /**
5763
- * http2回源配置
5893
+ * Http2回源配置。
5764
5894
  注意:此字段可能返回 null,表示取不到有效值。
5765
5895
  */
5766
5896
  UpstreamHttp2: UpstreamHttp2;
5767
5897
  /**
5768
- * 访问协议强制https跳转配置
5898
+ * 访问协议强制Https跳转配置。
5769
5899
  注意:此字段可能返回 null,表示取不到有效值。
5770
5900
  */
5771
5901
  ForceRedirect: ForceRedirect;
5772
5902
  /**
5773
- * Https 加速配置
5903
+ * Https 加速配置。
5774
5904
  注意:此字段可能返回 null,表示取不到有效值。
5775
5905
  */
5776
5906
  Https: Https;
5777
5907
  /**
5778
- * 源站配置
5908
+ * 源站配置。
5779
5909
  注意:此字段可能返回 null,表示取不到有效值。
5780
5910
  */
5781
5911
  Origin: Origin;
5782
5912
  /**
5783
- * 动态加速配置
5913
+ * 智能加速配置。
5784
5914
  注意:此字段可能返回 null,表示取不到有效值。
5785
5915
  */
5786
5916
  SmartRouting: SmartRouting;
5787
5917
  /**
5788
- * 站点ID
5918
+ * 浏览器缓存配置。
5919
+ 注意:此字段可能返回 null,表示取不到有效值。
5789
5920
  */
5790
- ZoneId: string;
5921
+ MaxAge: MaxAge;
5791
5922
  /**
5792
- * 站点域名
5923
+ * 离线缓存配置。
5924
+ 注意:此字段可能返回 null,表示取不到有效值。
5793
5925
  */
5794
- Zone: string;
5926
+ OfflineCache: OfflineCache;
5795
5927
  /**
5796
- * WebSocket配置
5928
+ * WebSocket配置。
5797
5929
  注意:此字段可能返回 null,表示取不到有效值。
5798
5930
  */
5799
5931
  WebSocket: WebSocket;
5800
5932
  /**
5801
- * 客户端IP回源请求头配置
5933
+ * 客户端IP回源请求头配置。
5802
5934
  注意:此字段可能返回 null,表示取不到有效值。
5803
5935
  */
5804
5936
  ClientIpHeader: ClientIp;
5805
5937
  /**
5806
- * 缓存预刷新配置
5938
+ * 缓存预刷新配置。
5807
5939
  注意:此字段可能返回 null,表示取不到有效值。
5808
5940
  */
5809
5941
  CachePrefresh: CachePrefresh;
5942
+ /**
5943
+ * Ipv6访问配置。
5944
+ 注意:此字段可能返回 null,表示取不到有效值。
5945
+ */
5946
+ Ipv6: Ipv6Access;
5810
5947
  /**
5811
5948
  * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
5812
5949
  */
@@ -5828,16 +5965,16 @@ smart_status_observe-观察处置
5828
5965
  */
5829
5966
  export interface MaxAge {
5830
5967
  /**
5831
- * MaxAge 时间设置,单位秒,最大365天
5832
- 注意:时间为0,即不缓存。
5833
- 注意:此字段可能返回 null,表示取不到有效值。
5968
+ * 是否遵循源站,取值有:
5969
+ <li>on:遵循源站,忽略MaxAge 时间设置;</li>
5970
+ <li>off:不遵循源站,使用MaxAge 时间设置。</li>
5834
5971
  */
5835
- MaxAgeTime?: number;
5972
+ FollowOrigin?: string;
5836
5973
  /**
5837
- * 是否遵循源站,on或off,开启时忽略时间设置。
5838
- 注意:此字段可能返回 null,表示取不到有效值。
5974
+ * MaxAge 时间设置,单位秒,最大365天。
5975
+ 注意:时间为0,即不缓存。
5839
5976
  */
5840
- FollowOrigin?: string;
5977
+ MaxAgeTime?: number;
5841
5978
  }
5842
5979
  /**
5843
5980
  * DescribePurgeTasks请求参数结构体
@@ -5933,17 +6070,17 @@ day:天粒度
5933
6070
  */
5934
6071
  export interface CacheConfig {
5935
6072
  /**
5936
- * 缓存配置
6073
+ * 缓存配置。
5937
6074
  注意:此字段可能返回 null,表示取不到有效值。
5938
6075
  */
5939
6076
  Cache?: CacheConfigCache;
5940
6077
  /**
5941
- * 不缓存配置
6078
+ * 不缓存配置。
5942
6079
  注意:此字段可能返回 null,表示取不到有效值。
5943
6080
  */
5944
6081
  NoCache?: CacheConfigNoCache;
5945
6082
  /**
5946
- * 遵循源站配置
6083
+ * 遵循源站配置。
5947
6084
  注意:此字段可能返回 null,表示取不到有效值。
5948
6085
  */
5949
6086
  FollowOrigin?: CacheConfigFollowOrigin;
@@ -5953,15 +6090,17 @@ export interface CacheConfig {
5953
6090
  */
5954
6091
  export interface DescribeDDosAttackEventDetailResponse {
5955
6092
  /**
5956
- * DDos攻击事件详情
6093
+ * DDos攻击事件详情。
5957
6094
  */
5958
6095
  Data: DDosAttackEventDetailData;
5959
6096
  /**
5960
- * 状态,1:失败,0:成功
6097
+ * 请求响应状态,取值有:
6098
+ <li>1 :失败 ;</li>
6099
+ <li>0 :成功 。</li>
5961
6100
  */
5962
6101
  Status: number;
5963
6102
  /**
5964
- * 返回信息
6103
+ * 请求响应信息。
5965
6104
  */
5966
6105
  Msg: string;
5967
6106
  /**
@@ -6076,61 +6215,77 @@ export interface ModifyZoneCnameSpeedUpResponse {
6076
6215
  */
6077
6216
  export interface DescribeWebProtectionLogRequest {
6078
6217
  /**
6079
- * 起始时间
6218
+ * 起始时间。
6080
6219
  */
6081
6220
  StartTime: string;
6082
6221
  /**
6083
- * 结束时间
6222
+ * 结束时间。
6084
6223
  */
6085
6224
  EndTime: string;
6086
6225
  /**
6087
- * 每页条数
6226
+ * 分页拉取的最大返回结果数。最大值:1000。
6088
6227
  */
6089
6228
  PageSize: number;
6090
6229
  /**
6091
- * 当前页
6230
+ * 分页拉取的起始页号。最小值:1。
6092
6231
  */
6093
6232
  PageNo: number;
6094
6233
  /**
6095
- * 站点集合
6234
+ * 站点集合,不填默认查询所有站点。
6096
6235
  */
6097
6236
  ZoneIds?: Array<string>;
6098
6237
  /**
6099
- * 域名集合
6238
+ * 域名集合,不填默认查询所有域名。
6100
6239
  */
6101
6240
  Domains?: Array<string>;
6102
6241
  /**
6103
- * 查询条件
6242
+ * 筛选条件。
6243
+ 限速规则日志中取值有:
6244
+ <li>action :执行动作(处置方式);</li>
6245
+ <li>ruleId :规则id ;</li>
6246
+ <li>oriDomain :被攻击的子域名 ;</li>
6247
+ <li>attackIp :攻击ip 。</li>
6248
+ 自定义规则日志中取值有:
6249
+ <li>action :执行动作(处置方式);</li>
6250
+ <li>ruleId :规则id ;</li>
6251
+ <li>oriDomain :被攻击的子域名 ;</li>
6252
+ <li>attackIp :攻击ip ;</li>
6253
+ <li>eventId :事件id ;</li>
6254
+ <li>ua :用户代理 ;</li>
6255
+ <li>requestMethod :请求方法 ;</li>
6256
+ <li>uri :统一资源标识符 。</li>
6104
6257
  */
6105
6258
  QueryCondition?: Array<QueryCondition>;
6259
+ /**
6260
+ * 日志类型,取值有:
6261
+ <li>rate :限速日志 ;</li>
6262
+ <li>acl :自定义规则日志 。</li>不填默认为rate。
6263
+ */
6264
+ EntityType?: string;
6106
6265
  }
6107
6266
  /**
6108
6267
  * 限速拦截日志
6109
6268
  */
6110
6269
  export interface CCLogData {
6111
6270
  /**
6112
- * CC拦截日志数据集合
6271
+ * CC拦截日志数据集合。
6113
6272
  注意:此字段可能返回 null,表示取不到有效值。
6114
6273
  */
6115
6274
  List: Array<CCLog>;
6116
6275
  /**
6117
- * 当前页
6118
- 注意:此字段可能返回 null,表示取不到有效值。
6276
+ * 分页拉取的起始页号。最小值:1。
6119
6277
  */
6120
6278
  PageNo: number;
6121
6279
  /**
6122
- * 每页展示条数
6123
- 注意:此字段可能返回 null,表示取不到有效值。
6280
+ * 分页拉取的最大返回结果数。最大值:1000。
6124
6281
  */
6125
6282
  PageSize: number;
6126
6283
  /**
6127
- * 总页数
6128
- 注意:此字段可能返回 null,表示取不到有效值。
6284
+ * 总页数。
6129
6285
  */
6130
6286
  Pages: number;
6131
6287
  /**
6132
- * 总条数
6133
- 注意:此字段可能返回 null,表示取不到有效值。
6288
+ * 总条数。
6134
6289
  */
6135
6290
  TotalSize: number;
6136
6291
  }
@@ -6294,15 +6449,17 @@ export interface CnameStatus {
6294
6449
  */
6295
6450
  export interface DescribeDDosMajorAttackEventResponse {
6296
6451
  /**
6297
- * DDos查询主攻击事件
6452
+ * DDos查询主攻击事件。
6298
6453
  */
6299
6454
  Data: DDosMajorAttackEventData;
6300
6455
  /**
6301
- * 状态,1:失败,0:成功
6456
+ * 请求响应状态,取值有:
6457
+ <li>1 :失败 ;</li>
6458
+ <li>0 :成功 。</li>
6302
6459
  */
6303
6460
  Status: number;
6304
6461
  /**
6305
- * 返回消息
6462
+ * 请求响应消息。
6306
6463
  */
6307
6464
  Msg: string;
6308
6465
  /**
@@ -6518,31 +6675,39 @@ export interface DeleteDnsRecordsResponse {
6518
6675
  */
6519
6676
  export interface DescribeBotLogRequest {
6520
6677
  /**
6521
- * 起始时间
6678
+ * 起始时间。
6522
6679
  */
6523
6680
  StartTime: string;
6524
6681
  /**
6525
- * 结束时间
6682
+ * 结束时间。
6526
6683
  */
6527
6684
  EndTime: string;
6528
6685
  /**
6529
- * 每页条数
6686
+ * 分页拉取的最大返回结果数。最大值:1000。
6530
6687
  */
6531
6688
  PageSize: number;
6532
6689
  /**
6533
- * 当前页
6690
+ * 分页拉取的起始页号。最小值:1。
6534
6691
  */
6535
6692
  PageNo: number;
6536
6693
  /**
6537
- * 站点集合
6694
+ * 站点集合,不填默认查询所有站点。
6538
6695
  */
6539
6696
  ZoneIds?: Array<string>;
6540
6697
  /**
6541
- * 域名集合
6698
+ * 域名集合,不填默认查询所有子域名。
6542
6699
  */
6543
6700
  Domains?: Array<string>;
6544
6701
  /**
6545
- * 查询条件
6702
+ * 筛选条件,取值有:
6703
+ <li>action :执行动作(处置方式);</li>
6704
+ <li>sipCountryCode :ip所在国家 ;</li>
6705
+ <li>attackIp :攻击ip ;</li>
6706
+ <li>ruleId :规则id ;</li>
6707
+ <li>eventId :事件id ;</li>
6708
+ <li>ua :用户代理 ;</li>
6709
+ <li>requestMethod :请求方法 ;</li>
6710
+ <li>uri :统一资源标识符 。</li>
6546
6711
  */
6547
6712
  QueryCondition?: Array<QueryCondition>;
6548
6713
  }
@@ -6585,35 +6750,38 @@ export interface DownloadL7LogsResponse {
6585
6750
  */
6586
6751
  export interface DDosAttackEventDetailData {
6587
6752
  /**
6588
- * 攻击状态
6753
+ * 攻击状态,取值有:
6754
+ <li>1 :观察中 ;</li>
6755
+ <li>2 :攻击开始 ;</li>
6756
+ <li>3 :攻击结束 。</li>
6589
6757
  */
6590
6758
  AttackStatus: number;
6591
6759
  /**
6592
- * 攻击类型
6760
+ * 攻击类型。
6593
6761
  */
6594
6762
  AttackType: string;
6595
6763
  /**
6596
- * 结束时间
6764
+ * 结束时间。
6597
6765
  */
6598
6766
  EndTime: number;
6599
6767
  /**
6600
- * 开始时间
6768
+ * 开始时间。
6601
6769
  */
6602
6770
  StartTime: number;
6603
6771
  /**
6604
- * 最大带宽
6772
+ * 最大带宽。
6605
6773
  */
6606
6774
  MaxBandWidth: number;
6607
6775
  /**
6608
- * 最大包速率
6776
+ * 最大包速率。
6609
6777
  */
6610
6778
  PacketMaxRate: number;
6611
6779
  /**
6612
- * 事件Id
6780
+ * 事件Id
6613
6781
  */
6614
6782
  EventId: string;
6615
6783
  /**
6616
- * ddos 策略组id
6784
+ * ddos 策略组id
6617
6785
  */
6618
6786
  PolicyId: number;
6619
6787
  }
@@ -6732,20 +6900,26 @@ export interface DescribeZoneDDoSPolicyRequest {
6732
6900
  */
6733
6901
  export interface DescribeDDosAttackDataResponse {
6734
6902
  /**
6735
- * DDos攻击数据
6903
+ * DDos攻击数据内容。
6736
6904
  注意:此字段可能返回 null,表示取不到有效值。
6737
6905
  */
6738
6906
  Data: Array<SecEntry>;
6739
6907
  /**
6740
- * 状态,1:失败,0:成功
6908
+ * 请求响应状态,取值有:
6909
+ <li>1 :失败 ;</li>
6910
+ <li>0 :成功 。</li>
6741
6911
  */
6742
6912
  Status: number;
6743
6913
  /**
6744
- * 返回数据
6914
+ * 请求响应信息。
6745
6915
  */
6746
6916
  Msg: string;
6747
6917
  /**
6748
- * 查询时间粒度,可选{min,5min,hour,day}
6918
+ * 查询时间粒度,取值有:
6919
+ <li>min :1分钟 ;</li>
6920
+ <li>5min :5分钟 ;</li>
6921
+ <li>hour :1小时 ;</li>
6922
+ <li>day :1天 。</li>
6749
6923
  */
6750
6924
  Interval: string;
6751
6925
  /**
@@ -6758,31 +6932,42 @@ export interface DescribeDDosAttackDataResponse {
6758
6932
  */
6759
6933
  export interface DescribeWebManagedRulesLogRequest {
6760
6934
  /**
6761
- * 起始时间
6935
+ * 起始时间。
6762
6936
  */
6763
6937
  StartTime: string;
6764
6938
  /**
6765
- * 结束时间
6939
+ * 结束时间。
6766
6940
  */
6767
6941
  EndTime: string;
6768
6942
  /**
6769
- * 每页条数
6943
+ * 分页拉取的最大返回结果数。最大值:1000。
6770
6944
  */
6771
6945
  PageSize: number;
6772
6946
  /**
6773
- * 当前页
6947
+ * 分页拉取的起始页号。最小值:1。
6774
6948
  */
6775
6949
  PageNo: number;
6776
6950
  /**
6777
- * 站点集合
6951
+ * 站点集合,不填默认选择全部站点。
6778
6952
  */
6779
6953
  ZoneIds?: Array<string>;
6780
6954
  /**
6781
- * 域名集合
6955
+ * 域名集合,不填默认选择全部子域名。
6782
6956
  */
6783
6957
  Domains?: Array<string>;
6784
6958
  /**
6785
- * 查询条件
6959
+ * 筛选条件,取值有:
6960
+ <li>attackType :攻击类型 ;</li>
6961
+ <li>riskLevel :风险等级 ;</li>
6962
+ <li>action :执行动作(处置方式) ;</li>
6963
+ <li>ruleId :规则id ;</li>
6964
+ <li>sipCountryCode :ip所在国家 ;</li>
6965
+ <li>attackIp :攻击ip ;</li>
6966
+ <li>oriDomain :被攻击的子域名 ;</li>
6967
+ <li>eventId :事件id ;</li>
6968
+ <li>ua :用户代理 ;</li>
6969
+ <li>requestMethod :请求方法 ;</li>
6970
+ <li>uri :统一资源标识符 。</li>
6786
6971
  */
6787
6972
  QueryCondition?: Array<QueryCondition>;
6788
6973
  }
@@ -6804,45 +6989,61 @@ export interface CreateApplicationProxyRulesResponse {
6804
6989
  */
6805
6990
  export interface DescribeWebManagedRulesTopDataRequest {
6806
6991
  /**
6807
- * 开始时间
6992
+ * 开始时间。
6808
6993
  */
6809
6994
  StartTime: string;
6810
6995
  /**
6811
- * 结束时间
6996
+ * 结束时间。
6812
6997
  */
6813
6998
  EndTime: string;
6814
6999
  /**
6815
- * 过滤指标
7000
+ * 统计指标列表,取值有:
7001
+ <li>waf_requestNum_url :url请求数排行 ;</li>
7002
+ <li>waf_requestNum_cip:客户端ip请求数排行 ;</li>
7003
+ <li>waf_cipRequestNum_region :客户端区域请求数排行 。</li>
6816
7004
  */
6817
7005
  MetricName: string;
6818
7006
  /**
6819
- * 查询前多少名,传值为0 全量
7007
+ * 查询前多少个,传值为0返回全量。
6820
7008
  */
6821
7009
  Limit: number;
6822
7010
  /**
6823
- * 站点集合
7011
+ * 站点id列表,不填默认选择全部站点。
6824
7012
  */
6825
7013
  ZoneIds?: Array<string>;
6826
7014
  /**
6827
- * ddos策略组id 集合
7015
+ * 该字段已废弃,请勿传。
6828
7016
  */
6829
7017
  PolicyIds?: Array<number>;
6830
7018
  /**
6831
- * 端口号
7019
+ * 该字段已废弃,请勿传。
6832
7020
  */
6833
7021
  Port?: number;
6834
7022
  /**
6835
- * 协议类型,tcp,udp,all
7023
+ * 该字段已废弃,请勿传。
6836
7024
  */
6837
7025
  ProtocolType?: string;
6838
7026
  /**
6839
- * 攻击类型,flood,icmpFlood......,all
7027
+ * 该字段已废弃,请勿传。
6840
7028
  */
6841
7029
  AttackType?: string;
6842
7030
  /**
6843
- * 域名集合
7031
+ * 域名列表,不填默认选择全部子域名。
6844
7032
  */
6845
7033
  Domains?: Array<string>;
7034
+ /**
7035
+ * 查询时间粒度,取值有:
7036
+ <li>min :1分钟 ;</li>
7037
+ <li>5min :5分钟 ;</li>
7038
+ <li>hour :1小时 ;</li>
7039
+ <li>day :1天 。</li>
7040
+ */
7041
+ Interval?: string;
7042
+ /**
7043
+ * 筛选条件,取值有:
7044
+ <li>action :执行动作 。</li>
7045
+ */
7046
+ QueryCondition?: Array<QueryCondition>;
6846
7047
  }
6847
7048
  /**
6848
7049
  * DescribeIdentification返回参数结构体
@@ -6885,15 +7086,15 @@ export interface DescribeIdentificationResponse {
6885
7086
  */
6886
7087
  export interface DDosMajorAttackEvent {
6887
7088
  /**
6888
- * ddos 策略组id
7089
+ * ddos 策略组id
6889
7090
  */
6890
7091
  PolicyId: number;
6891
7092
  /**
6892
- * 攻击最大带宽
7093
+ * 攻击最大带宽。
6893
7094
  */
6894
7095
  AttackMaxBandWidth: number;
6895
7096
  /**
6896
- * 攻击时间 单位为s
7097
+ * 攻击请求时间,采用unix秒级时间戳。
6897
7098
  */
6898
7099
  AttackTime: number;
6899
7100
  }
@@ -6917,80 +7118,86 @@ export interface ModifyZoneCnameSpeedUpRequest {
6917
7118
  */
6918
7119
  export interface DescribeApplicationProxyDetailResponse {
6919
7120
  /**
6920
- * 实例ID
7121
+ * 实例ID
6921
7122
  */
6922
7123
  ProxyId: string;
6923
7124
  /**
6924
- * 代理名称
6925
- 当ProxyType=hostname时,表示域名或者子域名
6926
- 当ProxyType=instance时,表示实例名称
7125
+ * 当ProxyType=hostname时,表示域名或子域名;
7126
+ 当ProxyType=instance时,表示代理名称。
6927
7127
  */
6928
7128
  ProxyName: string;
6929
7129
  /**
6930
- * 调度模式:
6931
- ip表示Anycast IP
6932
- domain表示CNAME
7130
+ * 调度模式,取值有:
7131
+ <li>ip:表示Anycast IP调度;</li>
7132
+ <li>domain:表示CNAME调度。</li>
6933
7133
  */
6934
7134
  PlatType: string;
6935
7135
  /**
6936
- * 0关闭安全,1开启安全
7136
+ * 是否开启安全,取值有:
7137
+ <li>0:关闭安全;</li>
7138
+ <li>1:开启安全。</li>
6937
7139
  */
6938
7140
  SecurityType: number;
6939
7141
  /**
6940
- * 0关闭加速,1开启加速
7142
+ * 是否开启加速,取值有:
7143
+ <li>0:关闭加速;</li>
7144
+ <li>1:开启加速。</li>
6941
7145
  */
6942
7146
  AccelerateType: number;
6943
7147
  /**
6944
- * 字段已经移至Rule.ForwardClientIp
7148
+ * 字段已经废弃。
6945
7149
  */
6946
7150
  ForwardClientIp: string;
6947
7151
  /**
6948
- * 字段已经移至Rule.SessionPersist
7152
+ * 字段已经废弃。
6949
7153
  */
6950
7154
  SessionPersist: boolean;
6951
7155
  /**
6952
- * 规则列表
7156
+ * 规则列表。
6953
7157
  */
6954
7158
  Rule: Array<ApplicationProxyRule>;
6955
7159
  /**
6956
- * 状态:
6957
- online:启用
6958
- offline:停用
6959
- progress:部署中
7160
+ * 状态,取值有:
7161
+ <li>online:启用;</li>
7162
+ <li>offline:停用;</li>
7163
+ <li>progress:部署中。</li>
6960
7164
  */
6961
7165
  Status: string;
6962
7166
  /**
6963
- * 调度信息
7167
+ * 调度信息。
6964
7168
  */
6965
7169
  ScheduleValue: Array<string>;
6966
7170
  /**
6967
- * 更新时间
7171
+ * 更新时间。
6968
7172
  */
6969
7173
  UpdateTime: string;
6970
7174
  /**
6971
- * 站点ID
7175
+ * 站点ID
6972
7176
  */
6973
7177
  ZoneId: string;
6974
7178
  /**
6975
- * 站点名称
7179
+ * 站点名称。
6976
7180
  */
6977
7181
  ZoneName: string;
6978
7182
  /**
6979
- * 会话保持时间
7183
+ * 会话保持时间。
6980
7184
  */
6981
7185
  SessionPersistTime: number;
6982
7186
  /**
6983
- * 服务类型
6984
- hostname:子域名模式
6985
- instance:实例模式
7187
+ * 四层代理模式,取值有:
7188
+ <li>hostname:表示子域名模式;</li>
7189
+ <li>instance:表示实例模式。</li>
6986
7190
  */
6987
7191
  ProxyType: string;
6988
7192
  /**
6989
7193
  * 当ProxyType=hostname时:
6990
- ProxyName为域名,如:test.123.com
6991
- HostId表示该域名,即test.123.com对应的代理加速唯一标识
7194
+ 表示代理加速唯一标识。
6992
7195
  */
6993
7196
  HostId: string;
7197
+ /**
7198
+ * IPv6访问配置。
7199
+ */
7200
+ Ipv6: Ipv6Access;
6994
7201
  /**
6995
7202
  * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
6996
7203
  */
@@ -7036,15 +7243,17 @@ export interface DDoSUserAllowBlockIP {
7036
7243
  */
7037
7244
  export interface DescribeBotLogResponse {
7038
7245
  /**
7039
- * Bot攻击Data
7246
+ * Bot攻击数据内容。
7040
7247
  */
7041
7248
  Data: BotLogData;
7042
7249
  /**
7043
- * 状态,1:失败,0:成功
7250
+ * 请求响应状态,取值有:
7251
+ <li>1 :失败 ;</li>
7252
+ <li>0 :成功 。</li>
7044
7253
  */
7045
7254
  Status: number;
7046
7255
  /**
7047
- * 返回信息
7256
+ * 请求响应信息。
7048
7257
  */
7049
7258
  Msg: string;
7050
7259
  /**
@@ -7074,20 +7283,26 @@ export interface DescribeLoadBalancingResponse {
7074
7283
  */
7075
7284
  export interface DescribeWebProtectionDataResponse {
7076
7285
  /**
7077
- * 数据详情
7286
+ * 数据详情。
7078
7287
  注意:此字段可能返回 null,表示取不到有效值。
7079
7288
  */
7080
7289
  Data: Array<SecEntry>;
7081
7290
  /**
7082
- * 状态,1:失败,0:成功
7291
+ * 请求响应状态,取值有:
7292
+ <li>1 :失败 ;</li>
7293
+ <li>0 :成功 。</li>
7083
7294
  */
7084
7295
  Status: number;
7085
7296
  /**
7086
- * 消息
7297
+ * 请求响应消息。
7087
7298
  */
7088
7299
  Msg: string;
7089
7300
  /**
7090
- * 查询时间粒度,可选{min,5min,hour,day}
7301
+ * 查询时间粒度,取值有:
7302
+ <li>min :1分钟 ;</li>
7303
+ <li>5min :5分钟 ;</li>
7304
+ <li>hour :1小时 ;</li>
7305
+ <li>day :1天 。</li>
7091
7306
  */
7092
7307
  Interval: string;
7093
7308
  /**
@@ -7366,9 +7581,9 @@ both:同时被仅DNS和代理加速类型负载均衡使用
7366
7581
  */
7367
7582
  export interface UpstreamHttp2 {
7368
7583
  /**
7369
- * http2回源配置开关
7370
- on:开启
7371
- off:关闭
7584
+ * http2回源配置开关,取值有:
7585
+ <li>on:开启;</li>
7586
+ <li>off:关闭。</li>
7372
7587
  */
7373
7588
  Switch: string;
7374
7589
  }
@@ -7377,7 +7592,9 @@ off:关闭
7377
7592
  */
7378
7593
  export interface OfflineCache {
7379
7594
  /**
7380
- * on | off, 离线缓存是否开启
7595
+ * 离线缓存是否开启,取值有:
7596
+ <li>on:开启;</li>
7597
+ <li>off:关闭。</li>
7381
7598
  注意:此字段可能返回 null,表示取不到有效值。
7382
7599
  */
7383
7600
  Switch: string;
@@ -7400,10 +7617,51 @@ export interface DescribeOriginGroupDetailRequest {
7400
7617
  */
7401
7618
  export interface DescribeDDosAttackEventDetailRequest {
7402
7619
  /**
7403
- * 事件id
7620
+ * 事件id
7404
7621
  */
7405
7622
  EventId: string;
7406
7623
  }
7624
+ /**
7625
+ * 安全规则(cc/waf/bot)相关信息
7626
+ */
7627
+ export interface SecRuleRelatedInfo {
7628
+ /**
7629
+ * 规则ID列表(99999为无效id)。
7630
+ */
7631
+ RuleId: number;
7632
+ /**
7633
+ * 执行动作(处置方式),取值有:
7634
+ <li>trans :通过 ;</li>
7635
+ <li>alg :算法挑战 ;</li>
7636
+ <li>drop :丢弃 ;</li>
7637
+ <li>ban :封禁源ip ;</li>
7638
+ <li>redirect :重定向 ;</li>
7639
+ <li>page :返回指定页面 ;</li>
7640
+ <li>monitor :观察 。</li>
7641
+ */
7642
+ Action: string;
7643
+ /**
7644
+ * 风险等级(waf日志中独有),取值有:
7645
+ <li>high risk :高危 ;</li>
7646
+ <li>middle risk :中危 ;</li>
7647
+ <li>low risk :低危 ;</li>
7648
+ <li>unkonw :未知 。</li>
7649
+ */
7650
+ RiskLevel: string;
7651
+ /**
7652
+ * 规则等级,取值有:
7653
+ <li>normal :正常 。</li>
7654
+ */
7655
+ RuleLevel: string;
7656
+ /**
7657
+ * 规则描述。
7658
+ */
7659
+ Description: string;
7660
+ /**
7661
+ * 规则类型名称。
7662
+ */
7663
+ RuleTypeName: string;
7664
+ }
7407
7665
  /**
7408
7666
  * DescribeTimingL4Data返回参数结构体
7409
7667
  */