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
@@ -20,14 +20,16 @@
20
20
  */
21
21
  export interface Compression {
22
22
  /**
23
- * 智能压缩配置开关
24
- on:开启
25
- off:关闭
23
+ * 智能压缩配置开关,取值有:
24
+ <li>on:开启;</li>
25
+ <li>off:关闭。</li>
26
26
  */
27
27
  Switch: string
28
28
 
29
29
  /**
30
- * 支持的压缩算法列表
30
+ * 支持的压缩算法列表,取值有:
31
+ <li>brotli:brotli算法;</li>
32
+ <li>gzip:gzip算法。</li>
31
33
  注意:此字段可能返回 null,表示取不到有效值。
32
34
  */
33
35
  Algorithms?: Array<string>
@@ -38,33 +40,29 @@ off:关闭
38
40
  */
39
41
  export interface WebLogData {
40
42
  /**
41
- * 数据
43
+ * 分组数据。
42
44
  注意:此字段可能返回 null,表示取不到有效值。
43
45
  */
44
46
  List: Array<WebLogs>
45
47
 
46
48
  /**
47
- * 当前页
48
- 注意:此字段可能返回 null,表示取不到有效值。
49
- */
49
+ * 分页拉取的起始页号。最小值:1。
50
+ */
50
51
  PageNo: number
51
52
 
52
53
  /**
53
- * 每页展示条数
54
- 注意:此字段可能返回 null,表示取不到有效值。
55
- */
54
+ * 分页拉取的最大返回结果数。最大值:1000。
55
+ */
56
56
  PageSize: number
57
57
 
58
58
  /**
59
- * 总页数
60
- 注意:此字段可能返回 null,表示取不到有效值。
61
- */
59
+ * 总页数。
60
+ */
62
61
  Pages: number
63
62
 
64
63
  /**
65
- * 总条数
66
- 注意:此字段可能返回 null,表示取不到有效值。
67
- */
64
+ * 总条数。
65
+ */
68
66
  TotalSize: number
69
67
  }
70
68
 
@@ -191,17 +189,19 @@ disabled:禁用证书
191
189
  */
192
190
  export interface DescribeWebManagedRulesTopDataResponse {
193
191
  /**
194
- * topn数据
192
+ * top数据内容。
195
193
  */
196
194
  Data: Array<TopNEntry>
197
195
 
198
196
  /**
199
- * 状态,1:失败,0:成功
200
- */
197
+ * 请求响应状态,取值有:
198
+ <li>1 :失败 ;</li>
199
+ <li>0 :成功 。</li>
200
+ */
201
201
  Status: number
202
202
 
203
203
  /**
204
- * 返回消息
204
+ * 请求响应消息。
205
205
  */
206
206
  Msg: string
207
207
 
@@ -316,24 +316,27 @@ export interface DeleteApplicationProxyResponse {
316
316
  */
317
317
  export interface Https {
318
318
  /**
319
- * http2 配置开关
320
- on:开启
321
- off:关闭
319
+ * http2 配置开关,取值有:
320
+ <li>on:开启;</li>
321
+ <li>off:关闭。</li>
322
322
  注意:此字段可能返回 null,表示取不到有效值。
323
323
  */
324
324
  Http2?: string
325
325
 
326
326
  /**
327
- * OCSP 配置开关
328
- on:开启
329
- off:关闭
330
- 默认为关闭状态
327
+ * OCSP 配置开关,取值有:
328
+ <li>on:开启;</li>
329
+ <li>off:关闭。</li>
331
330
  注意:此字段可能返回 null,表示取不到有效值。
332
331
  */
333
332
  OcspStapling?: string
334
333
 
335
334
  /**
336
- * Tls版本设置,支持设置 TLSv1, TLSV1.1, TLSV1.2, TLSv1.3,修改时必须开启连续的版本
335
+ * Tls版本设置,取值有:
336
+ <li>TLSv1:TLSv1版本;</li>
337
+ <li>TLSV1.1:TLSv1.1版本;</li>
338
+ <li>TLSV1.2:TLSv1.2版本;</li>
339
+ <li>TLSv1.3:TLSv1.3版本。</li>修改时必须开启连续的版本。
337
340
  注意:此字段可能返回 null,表示取不到有效值。
338
341
  */
339
342
  TlsVersion?: Array<string>
@@ -390,31 +393,31 @@ export interface OriginFilter {
390
393
  */
391
394
  export interface BotLogData {
392
395
  /**
393
- * Bot攻击日志数据集合
396
+ * Bot攻击日志数据集合。
394
397
  注意:此字段可能返回 null,表示取不到有效值。
395
398
  */
396
399
  List: Array<BotLog>
397
400
 
398
401
  /**
399
- * 当前页
402
+ * 分页拉取的起始页号。最小值:1。
400
403
  注意:此字段可能返回 null,表示取不到有效值。
401
404
  */
402
405
  PageNo: number
403
406
 
404
407
  /**
405
- * 每页展示条数
408
+ * 分页拉取的最大返回结果数。最大值:1000。
406
409
  注意:此字段可能返回 null,表示取不到有效值。
407
410
  */
408
411
  PageSize: number
409
412
 
410
413
  /**
411
- * 总页数
414
+ * 总页数。
412
415
  注意:此字段可能返回 null,表示取不到有效值。
413
416
  */
414
417
  Pages: number
415
418
 
416
419
  /**
417
- * 总条数
420
+ * 总条数。
418
421
  注意:此字段可能返回 null,表示取不到有效值。
419
422
  */
420
423
  TotalSize: number
@@ -606,17 +609,19 @@ export interface DescribePrefetchTasksResponse {
606
609
  */
607
610
  export interface DescribeDDosAttackEventResponse {
608
611
  /**
609
- * DDos攻击事件数据
612
+ * DDos攻击事件数据。
610
613
  */
611
614
  Data: DDosAttackEventData
612
615
 
613
616
  /**
614
- * 状态,1:失败,0:成功
615
- */
617
+ * 请求响应状态,取值有:
618
+ <li>1 :失败 ;</li>
619
+ <li>0 :成功 。</li>
620
+ */
616
621
  Status: number
617
622
 
618
623
  /**
619
- * 返回信息
624
+ * 请求响应信息。
620
625
  */
621
626
  Msg: string
622
627
 
@@ -676,7 +681,7 @@ export interface ReclaimZoneResponse {
676
681
  */
677
682
  export interface DescribeZoneSettingRequest {
678
683
  /**
679
- * 站点ID
684
+ * 站点ID
680
685
  */
681
686
  ZoneId: string
682
687
  }
@@ -903,84 +908,105 @@ export interface ModifyDnssecRequest {
903
908
  */
904
909
  export interface ModifyZoneSettingRequest {
905
910
  /**
906
- * 待变更的站点ID
911
+ * 待变更的站点ID
907
912
  */
908
913
  ZoneId: string
909
914
 
910
915
  /**
911
- * 缓存过期时间配置
912
- */
916
+ * 缓存过期时间配置。
917
+ 不填写表示保持原有配置。
918
+ */
913
919
  Cache?: CacheConfig
914
920
 
915
921
  /**
916
- * 节点缓存键配置
917
- */
922
+ * 节点缓存键配置。
923
+ 不填写表示保持原有配置。
924
+ */
918
925
  CacheKey?: CacheKey
919
926
 
920
927
  /**
921
- * 浏览器缓存配置
922
- */
928
+ * 浏览器缓存配置。
929
+ 不填写表示保持原有配置。
930
+ */
923
931
  MaxAge?: MaxAge
924
932
 
925
933
  /**
926
- * 离线缓存
927
- */
934
+ * 离线缓存配置。
935
+ 不填写表示保持原有配置。
936
+ */
928
937
  OfflineCache?: OfflineCache
929
938
 
930
939
  /**
931
- * Quic访问
932
- */
940
+ * Quic访问配置。
941
+ 不填写表示保持原有配置。
942
+ */
933
943
  Quic?: Quic
934
944
 
935
945
  /**
936
- * POST请求传输配置
937
- */
946
+ * Post请求传输配置。
947
+ 不填写表示保持原有配置。
948
+ */
938
949
  PostMaxSize?: PostMaxSize
939
950
 
940
951
  /**
941
- * 智能压缩配置
942
- */
952
+ * 智能压缩配置。
953
+ 不填写表示保持原有配置。
954
+ */
943
955
  Compression?: Compression
944
956
 
945
957
  /**
946
- * http2回源配置
947
- */
958
+ * Http2回源配置。
959
+ 不填写表示保持原有配置。
960
+ */
948
961
  UpstreamHttp2?: UpstreamHttp2
949
962
 
950
963
  /**
951
- * 访问协议强制https跳转配置
952
- */
964
+ * 访问协议强制Https跳转配置。
965
+ 不填写表示保持原有配置。
966
+ */
953
967
  ForceRedirect?: ForceRedirect
954
968
 
955
969
  /**
956
- * Https 加速配置
957
- */
970
+ * Https加速配置。
971
+ 不填写表示保持原有配置。
972
+ */
958
973
  Https?: Https
959
974
 
960
975
  /**
961
- * 源站配置
962
- */
976
+ * 源站配置。
977
+ 不填写表示保持原有配置。
978
+ */
963
979
  Origin?: Origin
964
980
 
965
981
  /**
966
- * 智能加速配置
967
- */
982
+ * 智能加速配置。
983
+ 不填写表示保持原有配置。
984
+ */
968
985
  SmartRouting?: SmartRouting
969
986
 
970
987
  /**
971
- * WebSocket配置
972
- */
988
+ * WebSocket配置。
989
+ 不填写表示保持原有配置。
990
+ */
973
991
  WebSocket?: WebSocket
974
992
 
975
993
  /**
976
- * 客户端IP回源请求头配置
977
- */
994
+ * 客户端IP回源请求头配置。
995
+ 不填写表示保持原有配置。
996
+ */
978
997
  ClientIpHeader?: ClientIp
979
998
 
980
999
  /**
981
- * 缓存预刷新配置
982
- */
1000
+ * 缓存预刷新配置。
1001
+ 不填写表示保持原有配置。
1002
+ */
983
1003
  CachePrefresh?: CachePrefresh
1004
+
1005
+ /**
1006
+ * Ipv6访问配置。
1007
+ 不填写表示保持原有配置。
1008
+ */
1009
+ Ipv6?: Ipv6Access
984
1010
  }
985
1011
 
986
1012
  /**
@@ -1003,7 +1029,7 @@ export interface DdosPacketFilter {
1003
1029
  */
1004
1030
  export interface CreateApplicationProxyResponse {
1005
1031
  /**
1006
- * 新增的四层代理应用ID
1032
+ * 新增的四层代理应用ID
1007
1033
  */
1008
1034
  ProxyId: string
1009
1035
 
@@ -1033,9 +1059,9 @@ export interface ImportDnsRecordsRequest {
1033
1059
  */
1034
1060
  export interface CacheConfigNoCache {
1035
1061
  /**
1036
- * 不缓存配置开关
1037
- on:开启
1038
- off:关闭
1062
+ * 不缓存配置开关,取值有:
1063
+ <li>on:开启;</li>
1064
+ <li>off:关闭。</li>
1039
1065
  注意:此字段可能返回 null,表示取不到有效值。
1040
1066
  */
1041
1067
  Switch: string
@@ -1163,106 +1189,109 @@ export interface DescribeZoneDetailsResponse {
1163
1189
  */
1164
1190
  export interface BotLog {
1165
1191
  /**
1166
- * 攻击时间
1167
- 注意:此字段可能返回 null,表示取不到有效值。
1168
- */
1192
+ * 攻击时间,采用unix秒级时间戳。
1193
+ */
1169
1194
  AttackTime: number
1170
1195
 
1171
1196
  /**
1172
- * 攻击ip
1173
- 注意:此字段可能返回 null,表示取不到有效值。
1174
- */
1197
+ * 攻击源(客户端)ip
1198
+ */
1175
1199
  AttackIp: string
1176
1200
 
1177
1201
  /**
1178
- * 域名
1179
- 注意:此字段可能返回 null,表示取不到有效值。
1180
- */
1202
+ * 受攻击域名。
1203
+ */
1181
1204
  Domain: string
1182
1205
 
1183
1206
  /**
1184
- * 请求uri
1185
- 注意:此字段可能返回 null,表示取不到有效值。
1186
- */
1207
+ * URI。
1208
+ */
1187
1209
  RequestUri: string
1188
1210
 
1189
1211
  /**
1190
- * 攻击类型
1212
+ * 当前该字段无效。
1191
1213
  注意:此字段可能返回 null,表示取不到有效值。
1192
1214
  */
1193
1215
  AttackType: string
1194
1216
 
1195
1217
  /**
1196
- * 请求方法
1197
- 注意:此字段可能返回 null,表示取不到有效值。
1198
- */
1218
+ * 请求方法。
1219
+ */
1199
1220
  RequestMethod: string
1200
1221
 
1201
1222
  /**
1202
- * 攻击内容
1203
- 注意:此字段可能返回 null,表示取不到有效值。
1204
- */
1223
+ * 攻击内容。
1224
+ */
1205
1225
  AttackContent: string
1206
1226
 
1207
1227
  /**
1208
- * 风险等级
1228
+ * 当前该字段无效 。
1209
1229
  注意:此字段可能返回 null,表示取不到有效值。
1210
1230
  */
1211
1231
  RiskLevel: string
1212
1232
 
1213
1233
  /**
1214
- * 规则编号
1234
+ * 当前该字段无效 。
1215
1235
  注意:此字段可能返回 null,表示取不到有效值。
1216
1236
  */
1217
1237
  RuleId: number
1218
1238
 
1219
1239
  /**
1220
- * IP所在国家
1221
- 注意:此字段可能返回 null,表示取不到有效值。
1222
- */
1240
+ * IP所在国家iso-3166中alpha-2编码,编码信息请参考[ISO-3166](https://git.woa.com/edgeone/iso-3166/blob/master/all/all.json)。
1241
+ */
1223
1242
  SipCountryCode: string
1224
1243
 
1225
1244
  /**
1226
- * 事件id
1227
- 注意:此字段可能返回 null,表示取不到有效值。
1228
- */
1245
+ * 请求(事件)ID。
1246
+ */
1229
1247
  EventId: string
1230
1248
 
1231
1249
  /**
1232
- * 处置方式
1250
+ * 该字段当前无效。
1233
1251
  注意:此字段可能返回 null,表示取不到有效值。
1234
1252
  */
1235
1253
  DisposalMethod: string
1236
1254
 
1237
1255
  /**
1238
- * http_log
1256
+ * 该字段当前无效。
1239
1257
  注意:此字段可能返回 null,表示取不到有效值。
1240
1258
  */
1241
1259
  HttpLog: string
1242
1260
 
1243
1261
  /**
1244
- * user agent
1245
- 注意:此字段可能返回 null,表示取不到有效值。
1246
- */
1262
+ * user agent
1263
+ */
1247
1264
  Ua: string
1248
1265
 
1249
1266
  /**
1250
- * 检出方法
1267
+ * 该字段当前无效。
1251
1268
  注意:此字段可能返回 null,表示取不到有效值。
1252
1269
  */
1253
1270
  DetectionMethod: string
1254
1271
 
1255
1272
  /**
1256
- * 置信度
1273
+ * 该字段当前无效。
1257
1274
  注意:此字段可能返回 null,表示取不到有效值。
1258
1275
  */
1259
1276
  Confidence: string
1260
1277
 
1261
1278
  /**
1262
- * 恶意度
1279
+ * 该字段当前无效。
1263
1280
  注意:此字段可能返回 null,表示取不到有效值。
1264
1281
  */
1265
1282
  Maliciousness: string
1283
+
1284
+ /**
1285
+ * 规则相关信息列表。
1286
+ 注意:此字段可能返回 null,表示取不到有效值。
1287
+ */
1288
+ RuleDetailList: Array<SecRuleRelatedInfo>
1289
+
1290
+ /**
1291
+ * Bot标签。
1292
+ 注意:此字段可能返回 null,表示取不到有效值。
1293
+ */
1294
+ Label: string
1266
1295
  }
1267
1296
 
1268
1297
  /**
@@ -1270,13 +1299,31 @@ export interface BotLog {
1270
1299
  */
1271
1300
  export interface Origin {
1272
1301
  /**
1273
- * 回源协议配置
1274
- http:强制 http 回源
1275
- follow:协议跟随回源
1276
- https:强制 https 回源,https 回源时仅支持源站 443 端口
1302
+ * 主源站列表。
1303
+ 注意:此字段可能返回 null,表示取不到有效值。
1304
+ */
1305
+ Origins?: Array<string>
1306
+
1307
+ /**
1308
+ * 备源站列表。
1309
+ 注意:此字段可能返回 null,表示取不到有效值。
1310
+ */
1311
+ BackupOrigins?: Array<string>
1312
+
1313
+ /**
1314
+ * 回源协议配置,取值有:
1315
+ <li>http:强制 http 回源;</li>
1316
+ <li>follow:协议跟随回源;</li>
1317
+ <li>https:强制 https 回源,https 回源时仅支持源站 443 端口。</li>
1277
1318
  注意:此字段可能返回 null,表示取不到有效值。
1278
1319
  */
1279
1320
  OriginPullProtocol?: string
1321
+
1322
+ /**
1323
+ * OriginType 为对象存储(COS)时,可以指定是否允许访问私有 bucket。
1324
+ 注意:此字段可能返回 null,表示取不到有效值。
1325
+ */
1326
+ CosPrivateAccess?: string
1280
1327
  }
1281
1328
 
1282
1329
  /**
@@ -1517,38 +1564,41 @@ export interface ModifyZoneResponse {
1517
1564
  */
1518
1565
  export interface DescribeDDosAttackSourceEventRequest {
1519
1566
  /**
1520
- * 开始时间
1567
+ * 开始时间。
1521
1568
  */
1522
1569
  StartTime: string
1523
1570
 
1524
1571
  /**
1525
- * 结束时间
1572
+ * 结束时间。
1526
1573
  */
1527
1574
  EndTime: string
1528
1575
 
1529
1576
  /**
1530
- * 条数
1577
+ * 分页拉取的最大返回结果数。最大值:1000。
1531
1578
  */
1532
1579
  PageSize: number
1533
1580
 
1534
1581
  /**
1535
- * 当前页
1582
+ * 分页拉取的起始页号。最小值:1。
1536
1583
  */
1537
1584
  PageNo: number
1538
1585
 
1539
1586
  /**
1540
- * ddos策略组id 集合
1587
+ * ddos策略组id 集合,不填默认选择全部策略id。
1541
1588
  */
1542
1589
  PolicyIds?: Array<number>
1543
1590
 
1544
1591
  /**
1545
- * 站点集合
1592
+ * 站点集合,不填默认选择全部站点。
1546
1593
  */
1547
1594
  ZoneIds?: Array<string>
1548
1595
 
1549
1596
  /**
1550
- * 协议类型,{tcp,udp,all}
1551
- */
1597
+ * 协议类型,取值有:
1598
+ <li>tcp ;</li>
1599
+ <li>udp ;</li>
1600
+ <li>all 。</li>
1601
+ */
1552
1602
  ProtocolType?: string
1553
1603
  }
1554
1604
 
@@ -1594,31 +1644,31 @@ export interface DeleteZoneResponse {
1594
1644
  */
1595
1645
  export interface DDosAttackEventData {
1596
1646
  /**
1597
- * 攻击事件数据集合
1647
+ * 攻击事件数据集合。
1598
1648
  注意:此字段可能返回 null,表示取不到有效值。
1599
1649
  */
1600
1650
  List: Array<DDosAttackEvent>
1601
1651
 
1602
1652
  /**
1603
- * 当前页
1653
+ * 分页拉取的起始页号。最小值:1。
1604
1654
  注意:此字段可能返回 null,表示取不到有效值。
1605
1655
  */
1606
1656
  PageNo: number
1607
1657
 
1608
1658
  /**
1609
- * 每页展示条数
1659
+ * 分页拉取的最大返回结果数。最大值:1000。
1610
1660
  注意:此字段可能返回 null,表示取不到有效值。
1611
1661
  */
1612
1662
  PageSize: number
1613
1663
 
1614
1664
  /**
1615
- * 总页数
1665
+ * 总页数。
1616
1666
  注意:此字段可能返回 null,表示取不到有效值。
1617
1667
  */
1618
1668
  Pages: number
1619
1669
 
1620
1670
  /**
1621
- * 总条数
1671
+ * 总条数。
1622
1672
  注意:此字段可能返回 null,表示取不到有效值。
1623
1673
  */
1624
1674
  TotalSize: number
@@ -1629,24 +1679,30 @@ export interface DDosAttackEventData {
1629
1679
  */
1630
1680
  export interface Hsts {
1631
1681
  /**
1632
- * 是否开启,on或off。
1633
- */
1682
+ * 是否开启,取值有:
1683
+ <li>on:开启;</li>
1684
+ <li>off:关闭。</li>
1685
+ */
1634
1686
  Switch: string
1635
1687
 
1636
1688
  /**
1637
- * MaxAge数值。
1689
+ * MaxAge数值。单位为秒,最大值为1天。
1638
1690
  注意:此字段可能返回 null,表示取不到有效值。
1639
1691
  */
1640
1692
  MaxAge?: number
1641
1693
 
1642
1694
  /**
1643
- * 是否包含子域名,on或off。
1695
+ * 是否包含子域名,取值有:
1696
+ <li>on:开启;</li>
1697
+ <li>off:关闭。</li>
1644
1698
  注意:此字段可能返回 null,表示取不到有效值。
1645
1699
  */
1646
1700
  IncludeSubDomains?: string
1647
1701
 
1648
1702
  /**
1649
- * 是否预加载,on或off。
1703
+ * 是否开启预加载,取值有:
1704
+ <li>on:开启;</li>
1705
+ <li>off:关闭。</li>
1650
1706
  注意:此字段可能返回 null,表示取不到有效值。
1651
1707
  */
1652
1708
  Preload?: string
@@ -1693,25 +1749,25 @@ export interface DeleteApplicationProxyRuleResponse {
1693
1749
  */
1694
1750
  export interface DDosAttackSourceEvent {
1695
1751
  /**
1696
- * 攻击源ip
1752
+ * 攻击源ip
1697
1753
  注意:此字段可能返回 null,表示取不到有效值。
1698
1754
  */
1699
1755
  AttackSourceIp: string
1700
1756
 
1701
1757
  /**
1702
- * 地区(国家)
1758
+ * 地区(国家)。
1703
1759
  注意:此字段可能返回 null,表示取不到有效值。
1704
1760
  */
1705
1761
  AttackRegion: string
1706
1762
 
1707
1763
  /**
1708
- * 累计攻击流量
1764
+ * 累计攻击流量。
1709
1765
  注意:此字段可能返回 null,表示取不到有效值。
1710
1766
  */
1711
1767
  AttackFlow: number
1712
1768
 
1713
1769
  /**
1714
- * 累计攻击包量
1770
+ * 累计攻击包量。
1715
1771
  注意:此字段可能返回 null,表示取不到有效值。
1716
1772
  */
1717
1773
  AttackPacketNum: number
@@ -1925,21 +1981,24 @@ export interface ModifyHostsCertificateRequest {
1925
1981
  */
1926
1982
  export interface ApplicationProxyRule {
1927
1983
  /**
1928
- * 协议,取值为TCP或者UDP
1929
- */
1984
+ * 协议,取值有:
1985
+ <li>TCP:TCP协议;</li>
1986
+ <li>UDP:UDP协议。</li>
1987
+ */
1930
1988
  Proto: string
1931
1989
 
1932
1990
  /**
1933
1991
  * 端口,支持格式:
1934
- 80:80端口
1935
- 81-90:81至90端口
1992
+ 单个端口,如:80
1993
+ 端口段,如:81-82。表示81,82两个端口。
1994
+ 注意:一条规则最多可填写20个端口。
1936
1995
  */
1937
1996
  Port: Array<string>
1938
1997
 
1939
1998
  /**
1940
- * 源站类型,取值:
1941
- custom:手动添加
1942
- origins:源站组
1999
+ * 源站类型,取值有:
2000
+ <li>custom:手动添加;</li>
2001
+ <li>origins:源站组。</li>
1943
2002
  */
1944
2003
  OriginType: string
1945
2004
 
@@ -1947,44 +2006,42 @@ origins:源站组
1947
2006
  * 源站信息:
1948
2007
  当OriginType=custom时,表示一个或多个源站,如:
1949
2008
  OriginValue=["8.8.8.8:80","9.9.9.9:80"]
1950
- OriginValue=["test.com:80"]
1951
-
1952
- 当OriginType=origins时,包含一个元素,表示源站组ID,如:
1953
- OriginValue=["origin-xxx"]
2009
+ OriginValue=["test.com:80"]
2010
+ 当OriginType=origins时,要求有且仅有一个元素,表示源站组ID,如:
2011
+ OriginValue=["origin-537f5b41-162a-11ed-abaa-525400c5da15"]。
1954
2012
  */
1955
2013
  OriginValue: Array<string>
1956
2014
 
1957
2015
  /**
1958
- * 规则ID
2016
+ * 规则ID
1959
2017
  注意:此字段可能返回 null,表示取不到有效值。
1960
2018
  */
1961
2019
  RuleId?: string
1962
2020
 
1963
2021
  /**
1964
- * 状态:
1965
- online:启用
1966
- offline:停用
1967
- progress:部署中
1968
- stopping:停用中
1969
- fail:部署失败/停用失败
2022
+ * 状态,取值有:
2023
+ <li>online:启用;</li>
2024
+ <li>offline:停用;</li>
2025
+ <li>progress:部署中;</li>
2026
+ <li>stopping:停用中;</li>
2027
+ <li>fail:部署失败/停用失败。</li>
1970
2028
  */
1971
2029
  Status?: string
1972
2030
 
1973
2031
  /**
1974
- * 传递客户端IP,当Proto=TCP时,取值:
1975
- TOA:TOA
1976
- PPV1: Proxy Protocol传递,协议版本V1
1977
- PPV2: Proxy Protocol传递,协议版本V2
1978
- OFF:不传递
1979
- 当Proto=UDP时,取值:
1980
- PPV2: Proxy Protocol传递,协议版本V2
1981
- OFF:不传递
2032
+ * 传递客户端IP,取值有:
2033
+ <li>TOA:TOA(仅Proto=TCP时可选);</li>
2034
+ <li>PPV1Proxy Protocol传递,协议版本V1(仅Proto=TCP时可选);</li>
2035
+ <li>PPV2Proxy Protocol传递,协议版本V2;</li>
2036
+ <li>OFF:不传递。</li>
1982
2037
  */
1983
2038
  ForwardClientIp?: string
1984
2039
 
1985
2040
  /**
1986
- * 是否开启会话保持
1987
- */
2041
+ * 是否开启会话保持,取值有:
2042
+ <li>true:开启;</li>
2043
+ <li>false:关闭。</li>
2044
+ */
1988
2045
  SessionPersist?: boolean
1989
2046
  }
1990
2047
 
@@ -1993,9 +2050,9 @@ OFF:不传递
1993
2050
  */
1994
2051
  export interface SmartRouting {
1995
2052
  /**
1996
- * 智能加速配置开关
1997
- on:开启
1998
- off:关闭
2053
+ * 智能加速配置开关,取值有:
2054
+ <li>on:开启;</li>
2055
+ <li>off:关闭。</li>
1999
2056
  */
2000
2057
  Switch: string
2001
2058
  }
@@ -2167,24 +2224,24 @@ online: 启用
2167
2224
  */
2168
2225
  export interface CacheConfigCache {
2169
2226
  /**
2170
- * 缓存配置开关
2171
- on:开启
2172
- off:关闭
2227
+ * 缓存配置开关,取值有:
2228
+ <li>on:开启;</li>
2229
+ <li>off:关闭。</li>
2173
2230
  注意:此字段可能返回 null,表示取不到有效值。
2174
2231
  */
2175
2232
  Switch: string
2176
2233
 
2177
2234
  /**
2178
- * 缓存过期时间设置
2179
- 单位为秒,最大可设置为 365
2235
+ * 缓存过期时间设置。
2236
+ 单位为秒,最大可设置为 365 天。
2180
2237
  注意:此字段可能返回 null,表示取不到有效值。
2181
2238
  */
2182
2239
  CacheTime?: number
2183
2240
 
2184
2241
  /**
2185
- * 是否开启强制缓存
2186
- 开启:on
2187
- 关闭:off
2242
+ * 是否开启强制缓存,取值有:
2243
+ <li>on:开启;</li>
2244
+ <li>off:关闭。</li>
2188
2245
  注意:此字段可能返回 null,表示取不到有效值。
2189
2246
  */
2190
2247
  IgnoreCacheControl?: string
@@ -2252,17 +2309,19 @@ offline: 停用
2252
2309
  */
2253
2310
  export interface DescribeDDosAttackTopDataResponse {
2254
2311
  /**
2255
- * topn数据
2312
+ * top数据内容
2256
2313
  */
2257
2314
  Data: Array<TopNEntry>
2258
2315
 
2259
2316
  /**
2260
- * 状态,1:失败,0:成功
2261
- */
2317
+ * 请求响应状态,取值有:
2318
+ <li>1 :失败 ;</li>
2319
+ <li>0 :成功 。</li>
2320
+ */
2262
2321
  Status: number
2263
2322
 
2264
2323
  /**
2265
- * 返回消息
2324
+ * 请求响应消息。
2266
2325
  */
2267
2326
  Msg: string
2268
2327
 
@@ -2379,7 +2438,7 @@ export interface AclConfig {
2379
2438
  */
2380
2439
  export interface ModifyZoneSettingResponse {
2381
2440
  /**
2382
- * 站点ID
2441
+ * 站点ID
2383
2442
  */
2384
2443
  ZoneId: string
2385
2444
 
@@ -2547,74 +2606,85 @@ pending: 不生效
2547
2606
  }
2548
2607
 
2549
2608
  /**
2550
- * 限速拦截日志
2609
+ * CC日志
2551
2610
  */
2552
2611
  export interface CCLog {
2553
2612
  /**
2554
- * 攻击时间
2555
- 注意:此字段可能返回 null,表示取不到有效值。
2556
- */
2613
+ * 攻击请求时间,采用unix秒级时间戳。
2614
+ */
2557
2615
  AttackTime: number
2558
2616
 
2559
2617
  /**
2560
- * 攻击源ip
2561
- 注意:此字段可能返回 null,表示取不到有效值。
2562
- */
2618
+ * 客户端ip
2619
+ */
2563
2620
  AttackSip: string
2564
2621
 
2565
2622
  /**
2566
- * 攻击域名
2567
- 注意:此字段可能返回 null,表示取不到有效值。
2568
- */
2623
+ * 受攻击域名。
2624
+ */
2569
2625
  AttackDomain: string
2570
2626
 
2571
2627
  /**
2572
- * 请求uri
2573
- 注意:此字段可能返回 null,表示取不到有效值。
2574
- */
2628
+ * URI。
2629
+ */
2575
2630
  RequestUri: string
2576
2631
 
2577
2632
  /**
2578
- * 命中次数
2579
- 注意:此字段可能返回 null,表示取不到有效值。
2580
- */
2633
+ * 命中次数。
2634
+ */
2581
2635
  HitCount: number
2582
2636
 
2583
2637
  /**
2584
- * IP所在国家
2585
- 注意:此字段可能返回 null,表示取不到有效值。
2586
- */
2638
+ * IP所在国家iso-3166中alpha-2编码,编码信息请参考[ISO-3166](https://git.woa.com/edgeone/iso-3166/blob/master/all/all.json)。
2639
+ */
2587
2640
  SipCountryCode: string
2588
2641
 
2589
2642
  /**
2590
- * 事件id
2591
- 注意:此字段可能返回 null,表示取不到有效值。
2592
- */
2643
+ * 请求(事件)ID。
2644
+ */
2593
2645
  EventId: string
2594
2646
 
2595
2647
  /**
2596
- * 处置方式
2648
+ * 当前该字段已废弃。
2597
2649
  注意:此字段可能返回 null,表示取不到有效值。
2598
2650
  */
2599
2651
  DisposalMethod: string
2600
2652
 
2601
2653
  /**
2602
- * http_log
2654
+ * 当前该字段已废弃。
2603
2655
  注意:此字段可能返回 null,表示取不到有效值。
2604
2656
  */
2605
2657
  HttpLog: string
2606
2658
 
2607
2659
  /**
2608
- * 规则编号
2660
+ * 当前该字段已废弃。
2609
2661
  注意:此字段可能返回 null,表示取不到有效值。
2610
2662
  */
2611
2663
  RuleId: number
2612
2664
 
2613
2665
  /**
2614
- * 风险等级
2666
+ * 当前该字段已废弃。
2615
2667
  注意:此字段可能返回 null,表示取不到有效值。
2616
2668
  */
2617
2669
  RiskLevel: string
2670
+
2671
+ /**
2672
+ * User Agent,仅自定义规则日志中存在。
2673
+ 注意:此字段可能返回 null,表示取不到有效值。
2674
+ */
2675
+ Ua: string
2676
+
2677
+ /**
2678
+ * 请求方法,仅自定义规则日志中存在。
2679
+ 注意:此字段可能返回 null,表示取不到有效值。
2680
+ */
2681
+ RequestMethod: string
2682
+
2683
+ /**
2684
+ * 规则信息列表。
2685
+ 注意:此字段可能返回 null,表示取不到有效值。
2686
+ */
2687
+ RuleDetailList: Array<SecRuleRelatedInfo>
2618
2688
  }
2619
2689
 
2620
2690
  /**
@@ -2678,24 +2748,30 @@ export interface DDoSConfig {
2678
2748
  */
2679
2749
  export interface DescribeWebManagedRulesDataResponse {
2680
2750
  /**
2681
- * Web攻击日志实体
2751
+ * Web攻击日志实体。
2682
2752
  注意:此字段可能返回 null,表示取不到有效值。
2683
2753
  */
2684
2754
  Data: Array<SecEntry>
2685
2755
 
2686
2756
  /**
2687
- * 状态,1:失败,0:成功
2688
- */
2757
+ * 请求响应状态,取值有:
2758
+ <li>1 :失败 ;</li>
2759
+ <li>0 :成功 。</li>
2760
+ */
2689
2761
  Status: number
2690
2762
 
2691
2763
  /**
2692
- * 返回消息
2764
+ * 请求响应消息。
2693
2765
  */
2694
2766
  Msg: string
2695
2767
 
2696
2768
  /**
2697
- * 查询时间粒度,可选{min,5min,hour,day}
2698
- */
2769
+ * 查询时间粒度,取值有:
2770
+ <li>min :1分钟 ;</li>
2771
+ <li>5min :5分钟 ;</li>
2772
+ <li>hour :1小时 ;</li>
2773
+ <li>day :1天 。</li>
2774
+ */
2699
2775
  Interval: string
2700
2776
 
2701
2777
  /**
@@ -2709,17 +2785,19 @@ export interface DescribeWebManagedRulesDataResponse {
2709
2785
  */
2710
2786
  export interface DescribeWebManagedRulesLogResponse {
2711
2787
  /**
2712
- * web攻击日志data
2788
+ * web攻击日志数据内容。
2713
2789
  */
2714
2790
  Data: WebLogData
2715
2791
 
2716
2792
  /**
2717
- * 状态,1:失败,0:失败
2718
- */
2793
+ * 请求响应状态,取值有:
2794
+ <li>1 :失败 ;</li>
2795
+ <li>0 :成功 。</li>
2796
+ */
2719
2797
  Status: number
2720
2798
 
2721
2799
  /**
2722
- * 返回信息
2800
+ * 请求响应信息。
2723
2801
  */
2724
2802
  Msg: string
2725
2803
 
@@ -2790,94 +2868,93 @@ export interface OriginRecord {
2790
2868
  */
2791
2869
  export interface WebLogs {
2792
2870
  /**
2793
- * 攻击内容
2871
+ * 该字段已废弃。
2794
2872
  注意:此字段可能返回 null,表示取不到有效值。
2795
2873
  */
2796
2874
  AttackContent: string
2797
2875
 
2798
2876
  /**
2799
- * 攻击IP
2800
- 注意:此字段可能返回 null,表示取不到有效值。
2801
- */
2877
+ * 攻击源(客户端)Ip。
2878
+ */
2802
2879
  AttackIp: string
2803
2880
 
2804
2881
  /**
2805
- * 攻击类型
2882
+ * 该字段已废弃。
2806
2883
  注意:此字段可能返回 null,表示取不到有效值。
2807
2884
  */
2808
2885
  AttackType: string
2809
2886
 
2810
2887
  /**
2811
- * 域名
2812
- 注意:此字段可能返回 null,表示取不到有效值。
2813
- */
2888
+ * 受攻击子域名。
2889
+ */
2814
2890
  Domain: string
2815
2891
 
2816
2892
  /**
2817
- * uuid
2893
+ * 该字段已废弃。
2818
2894
  注意:此字段可能返回 null,表示取不到有效值。
2819
2895
  */
2820
2896
  Msuuid: string
2821
2897
 
2822
2898
  /**
2823
- * 请求方法
2899
+ * 该字段已废弃。
2824
2900
  注意:此字段可能返回 null,表示取不到有效值。
2825
2901
  */
2826
2902
  RequestMethod: string
2827
2903
 
2828
2904
  /**
2829
- * 请求URI
2830
- 注意:此字段可能返回 null,表示取不到有效值。
2831
- */
2905
+ * URI
2906
+ */
2832
2907
  RequestUri: string
2833
2908
 
2834
2909
  /**
2835
- * 风险等级
2910
+ * 该字段已废弃。
2836
2911
  注意:此字段可能返回 null,表示取不到有效值。
2837
2912
  */
2838
2913
  RiskLevel: string
2839
2914
 
2840
2915
  /**
2841
- * 规则ID
2916
+ * 该字段已废弃。
2842
2917
  注意:此字段可能返回 null,表示取不到有效值。
2843
2918
  */
2844
2919
  RuleId: number
2845
2920
 
2846
2921
  /**
2847
- * IP所在国家
2848
- 注意:此字段可能返回 null,表示取不到有效值。
2849
- */
2922
+ * IP所在国家iso-3166中alpha-2编码,编码信息请参考[ISO-3166](https://git.woa.com/edgeone/iso-3166/blob/master/all/all.json)
2923
+ */
2850
2924
  SipCountryCode: string
2851
2925
 
2852
2926
  /**
2853
- * 事件id
2854
- 注意:此字段可能返回 null,表示取不到有效值。
2855
- */
2927
+ * 请求(事件)ID。
2928
+ */
2856
2929
  EventId: string
2857
2930
 
2858
2931
  /**
2859
- * 处置方式
2932
+ * 该字段已废弃。
2860
2933
  注意:此字段可能返回 null,表示取不到有效值。
2861
2934
  */
2862
2935
  DisposalMethod: string
2863
2936
 
2864
2937
  /**
2865
- * http_log
2866
- 注意:此字段可能返回 null,表示取不到有效值。
2867
- */
2938
+ * http log。
2939
+ */
2868
2940
  HttpLog: string
2869
2941
 
2870
2942
  /**
2871
- * user agent
2943
+ * 该字段已废弃。
2872
2944
  注意:此字段可能返回 null,表示取不到有效值。
2873
2945
  */
2874
2946
  Ua: string
2875
2947
 
2876
2948
  /**
2877
- * 攻击时间,为保持统一,原参数time更名为AttackTime
2949
+ * 攻击时间,采用unix秒级时间戳。
2950
+ */
2951
+ AttackTime: number
2952
+
2953
+ /**
2954
+ * 规则相关信息列表。
2878
2955
  注意:此字段可能返回 null,表示取不到有效值。
2879
2956
  */
2880
- AttackTime: number
2957
+ RuleDetailList: Array<SecRuleRelatedInfo>
2881
2958
  }
2882
2959
 
2883
2960
  /**
@@ -2947,9 +3024,9 @@ export interface DeleteApplicationProxyRuleRequest {
2947
3024
  */
2948
3025
  export interface CacheConfigFollowOrigin {
2949
3026
  /**
2950
- * 遵循源站配置开关
2951
- on:开启
2952
- off:关闭
3027
+ * 遵循源站配置开关,取值有:
3028
+ <li>on:开启;</li>
3029
+ <li>off:关闭。</li>
2953
3030
  注意:此字段可能返回 null,表示取不到有效值。
2954
3031
  */
2955
3032
  Switch: string
@@ -3025,12 +3102,12 @@ export interface DescribeTopL7AnalysisDataRequest {
3025
3102
  */
3026
3103
  export interface TopNEntry {
3027
3104
  /**
3028
- * Entry key
3105
+ * top查询维度值。
3029
3106
  */
3030
3107
  Key: string
3031
3108
 
3032
3109
  /**
3033
- * TopN数据
3110
+ * 查询具体数据。
3034
3111
  */
3035
3112
  Value: Array<TopNEntryValue>
3036
3113
  }
@@ -3040,33 +3117,28 @@ export interface TopNEntry {
3040
3117
  */
3041
3118
  export interface DescribeApplicationProxyResponse {
3042
3119
  /**
3043
- * 数据列表
3044
- 注意:此字段可能返回 null,表示取不到有效值。
3045
- */
3120
+ * 应用代理列表。
3121
+ */
3046
3122
  Data: Array<ApplicationProxy>
3047
3123
 
3048
3124
  /**
3049
- * 记录总数
3050
- 注意:此字段可能返回 null,表示取不到有效值。
3051
- */
3125
+ * 记录总数。
3126
+ */
3052
3127
  TotalCount: number
3053
3128
 
3054
3129
  /**
3055
- * 字段已废弃
3056
- 注意:此字段可能返回 null,表示取不到有效值。
3057
- */
3130
+ * 字段已废弃。
3131
+ */
3058
3132
  Quota: number
3059
3133
 
3060
3134
  /**
3061
- * 表示套餐内PlatType为ip的Anycast IP实例数量
3062
- 注意:此字段可能返回 null,表示取不到有效值。
3063
- */
3135
+ * 当ProxyId为空时,表示套餐内PlatType为ip的Anycast IP的实例数量。
3136
+ */
3064
3137
  IpCount: number
3065
3138
 
3066
3139
  /**
3067
- * 表示套餐内PlatType为domain的CNAME实例数量
3068
- 注意:此字段可能返回 null,表示取不到有效值。
3069
- */
3140
+ * 当ProxyId为空时,表示套餐内PlatType为domain的CNAME的实例数量。
3141
+ */
3070
3142
  DomainCount: number
3071
3143
 
3072
3144
  /**
@@ -3204,12 +3276,14 @@ export interface IdentifyZoneResponse {
3204
3276
  */
3205
3277
  export interface WebSocket {
3206
3278
  /**
3207
- * WebSocket 超时配置开关, 开关为off时,平台仍支持WebSocket连接,此时超时时间默认为15秒,若需要调整超时时间,将开关置为on.
3208
- */
3279
+ * WebSocket 超时时间配置开关,取值有:
3280
+ <li>on:使用Timeout作为WebSocket超时时间;</li>
3281
+ <li>off:平台仍支持WebSocket连接,此时使用系统默认的15秒为超时时间。</li>
3282
+ */
3209
3283
  Switch: string
3210
3284
 
3211
3285
  /**
3212
- * 设置超时时间,单位为秒,最大超时时间120秒。
3286
+ * 超时时间,单位为秒,最大超时时间120秒。
3213
3287
  */
3214
3288
  Timeout?: number
3215
3289
  }
@@ -3309,17 +3383,19 @@ export interface DescribeDnssecRequest {
3309
3383
  */
3310
3384
  export interface DescribeWebProtectionLogResponse {
3311
3385
  /**
3312
- * 限速拦截Data
3386
+ * 限速拦截数据内容。
3313
3387
  */
3314
3388
  Data: CCLogData
3315
3389
 
3316
3390
  /**
3317
- * 状态,1:失败,0:成功
3318
- */
3391
+ * 请求响应状态,取值有:
3392
+ <li>1 :失败 ;</li>
3393
+ <li>0 :成功 。</li>
3394
+ */
3319
3395
  Status: number
3320
3396
 
3321
3397
  /**
3322
- * 返回信息
3398
+ * 请求响应信息。
3323
3399
  */
3324
3400
  Msg: string
3325
3401
 
@@ -3479,31 +3555,31 @@ export interface SecurityConfig {
3479
3555
  */
3480
3556
  export interface DDosMajorAttackEventData {
3481
3557
  /**
3482
- * DDosMajorAttackEvent ddos 攻击事件
3558
+ * DDosMajorAttackEvent ddos 攻击事件。
3483
3559
  注意:此字段可能返回 null,表示取不到有效值。
3484
3560
  */
3485
3561
  List: Array<DDosMajorAttackEvent>
3486
3562
 
3487
3563
  /**
3488
- * 当前页
3564
+ * 分页拉取的起始页号。最小值:1。
3489
3565
  注意:此字段可能返回 null,表示取不到有效值。
3490
3566
  */
3491
3567
  PageNo: number
3492
3568
 
3493
3569
  /**
3494
- * 每页展示条数
3570
+ * 分页拉取的最大返回结果数。最大值:1000。
3495
3571
  注意:此字段可能返回 null,表示取不到有效值。
3496
3572
  */
3497
3573
  PageSize: number
3498
3574
 
3499
3575
  /**
3500
- * 总页数
3576
+ * 总页数。
3501
3577
  注意:此字段可能返回 null,表示取不到有效值。
3502
3578
  */
3503
3579
  Pages: number
3504
3580
 
3505
3581
  /**
3506
- * 总条数
3582
+ * 总条数。
3507
3583
  注意:此字段可能返回 null,表示取不到有效值。
3508
3584
  */
3509
3585
  TotalSize: number
@@ -3638,6 +3714,18 @@ export interface TopDataRecord {
3638
3714
  DetailData: Array<TopDetailData>
3639
3715
  }
3640
3716
 
3717
+ /**
3718
+ * Ipv6访问配置
3719
+ */
3720
+ export interface Ipv6Access {
3721
+ /**
3722
+ * Ipv6访问功能配置,取值有:
3723
+ <li>on:开启Ipv6访问功能;</li>
3724
+ <li>off:关闭Ipv6访问功能。</li>
3725
+ */
3726
+ Switch: string
3727
+ }
3728
+
3641
3729
  /**
3642
3730
  * DDoS协议防护+连接防护
3643
3731
  */
@@ -3719,58 +3807,55 @@ export interface DDoSAntiPly {
3719
3807
  */
3720
3808
  export interface DescribeWebManagedRulesDataRequest {
3721
3809
  /**
3722
- * 开始时间
3810
+ * 开始时间,RFC3339格式。
3723
3811
  */
3724
3812
  StartTime: string
3725
3813
 
3726
3814
  /**
3727
- * 结束时间
3815
+ * 结束时间,RFC3339格式。
3728
3816
  */
3729
3817
  EndTime: string
3730
3818
 
3731
3819
  /**
3732
- * 统计指标列表
3733
- */
3820
+ * 统计指标列表,取值有:
3821
+ <li>waf_interceptNum :waf拦截次数 。</li>
3822
+ */
3734
3823
  MetricNames: Array<string>
3735
3824
 
3736
3825
  /**
3737
- * 站点id列表
3826
+ * 站点id列表,不填默认选择全部站点。
3738
3827
  */
3739
3828
  ZoneIds?: Array<string>
3740
3829
 
3741
3830
  /**
3742
- * 子域名列表
3831
+ * 子域名列表,不填默认选择子域名。
3743
3832
  */
3744
3833
  Domains?: Array<string>
3745
3834
 
3746
3835
  /**
3747
- * 协议类型
3836
+ * 该字段已废弃,请勿传。
3748
3837
  */
3749
3838
  ProtocolType?: string
3750
3839
 
3751
3840
  /**
3752
- * "webshell" : Webshell检测防护
3753
- "oa" : 常见OA漏洞防护
3754
- "xss" : XSS跨站脚本攻击防护
3755
- "xxe" : XXE攻击防护
3756
- "webscan" : 扫描器攻击漏洞防护
3757
- "cms" : 常见CMS漏洞防护
3758
- "upload" : 恶意文件上传攻击防护
3759
- "sql" : SQL注入攻击防护
3760
- "cmd_inject": 命令/代码注入攻击防护
3761
- "osc" : 开源组件漏洞防护
3762
- "file_read" : 任意文件读取
3763
- "ldap" : LDAP注入攻击防护
3764
- "other" : 其它漏洞防护
3765
-
3766
- "all":"所有"
3767
- */
3841
+ * 该字段已废弃,请勿传。
3842
+ */
3768
3843
  AttackType?: string
3769
3844
 
3770
3845
  /**
3771
- * 查询时间粒度,可选{min,5min,hour,day}
3772
- */
3846
+ * 查询时间粒度,取值有:
3847
+ <li>min :1分钟 ;</li>
3848
+ <li>5min :5分钟 ;</li>
3849
+ <li>hour :1小时 ;</li>
3850
+ <li>day :1天 。</li>
3851
+ */
3773
3852
  Interval?: string
3853
+
3854
+ /**
3855
+ * 筛选条件,取值有:
3856
+ <li>action :执行动作 。</li>
3857
+ */
3858
+ QueryCondition?: Array<QueryCondition>
3774
3859
  }
3775
3860
 
3776
3861
  /**
@@ -3778,31 +3863,31 @@ export interface DescribeWebManagedRulesDataRequest {
3778
3863
  */
3779
3864
  export interface DDosAttackSourceEventData {
3780
3865
  /**
3781
- * DDos攻击源数据集合
3866
+ * DDos攻击源数据集合。
3782
3867
  注意:此字段可能返回 null,表示取不到有效值。
3783
3868
  */
3784
3869
  List: Array<DDosAttackSourceEvent>
3785
3870
 
3786
3871
  /**
3787
- * 当前页
3872
+ * 分页拉取的起始页号。最小值:1。
3788
3873
  注意:此字段可能返回 null,表示取不到有效值。
3789
3874
  */
3790
3875
  PageNo: number
3791
3876
 
3792
3877
  /**
3793
- * 每页展示条数
3878
+ * 分页拉取的最大返回结果数。最大值:1000。
3794
3879
  注意:此字段可能返回 null,表示取不到有效值。
3795
3880
  */
3796
3881
  PageSize: number
3797
3882
 
3798
3883
  /**
3799
- * 总页数
3884
+ * 总页数。
3800
3885
  注意:此字段可能返回 null,表示取不到有效值。
3801
3886
  */
3802
3887
  Pages: number
3803
3888
 
3804
3889
  /**
3805
- * 总条数
3890
+ * 总条数。
3806
3891
  注意:此字段可能返回 null,表示取不到有效值。
3807
3892
  */
3808
3893
  TotalSize: number
@@ -4293,58 +4378,56 @@ export interface DeleteLoadBalancingResponse {
4293
4378
  */
4294
4379
  export interface DescribeWebProtectionDataRequest {
4295
4380
  /**
4296
- * 开始时间
4381
+ * 开始时间,RFC3339格式。
4297
4382
  */
4298
4383
  StartTime: string
4299
4384
 
4300
4385
  /**
4301
- * 结束时间
4386
+ * 结束时间,RFC3339格式。
4302
4387
  */
4303
4388
  EndTime: string
4304
4389
 
4305
4390
  /**
4306
- * 统计指标列表
4307
- */
4391
+ * 统计指标列表,取值有:
4392
+ <li>ccRate_interceptNum :速率限制规则限制次数 ;</li>
4393
+ <li>ccAcl_interceptNum :自定义规则拦截次数 。</li>
4394
+ */
4308
4395
  MetricNames: Array<string>
4309
4396
 
4310
4397
  /**
4311
- * 站点id列表
4398
+ * 站点id列表,不填默认选择全部站点。
4312
4399
  */
4313
4400
  ZoneIds?: Array<string>
4314
4401
 
4315
4402
  /**
4316
- * 子域名列表
4403
+ * 子域名列表,不填默认选择全部子域名。
4317
4404
  */
4318
4405
  Domains?: Array<string>
4319
4406
 
4320
4407
  /**
4321
- * 协议类型
4408
+ * 该字段已废弃,请勿传。
4322
4409
  */
4323
4410
  ProtocolType?: string
4324
4411
 
4325
4412
  /**
4326
- * "webshell" : Webshell检测防护
4327
- "oa" : 常见OA漏洞防护
4328
- "xss" : XSS跨站脚本攻击防护
4329
- "xxe" : XXE攻击防护
4330
- "webscan" : 扫描器攻击漏洞防护
4331
- "cms" : 常见CMS漏洞防护
4332
- "upload" : 恶意文件上传攻击防护
4333
- "sql" : SQL注入攻击防护
4334
- "cmd_inject": 命令/代码注入攻击防护
4335
- "osc" : 开源组件漏洞防护
4336
- "file_read" : 任意文件读取
4337
- "ldap" : LDAP注入攻击防护
4338
- "other" : 其它漏洞防护
4339
-
4340
- "all":"所有"
4341
- */
4413
+ * 该字段已废弃,请勿传。
4414
+ */
4342
4415
  AttackType?: string
4343
4416
 
4344
4417
  /**
4345
- * 查询时间粒度,可选{min,5min,hour,day}
4346
- */
4418
+ * 查询时间粒度,取值有:
4419
+ <li>min :1分钟 ;</li>
4420
+ <li>5min :5分钟 ;</li>
4421
+ <li>hour :1小时 ;</li>
4422
+ <li>day :1天 。</li>
4423
+ */
4347
4424
  Interval?: string
4425
+
4426
+ /**
4427
+ * 筛选条件,取值有:
4428
+ <li>action :执行动作 。</li>
4429
+ */
4430
+ QueryCondition?: Array<QueryCondition>
4348
4431
  }
4349
4432
 
4350
4433
  /**
@@ -4477,16 +4560,16 @@ export interface BotManagedRuleDetail {
4477
4560
  */
4478
4561
  export interface ForceRedirect {
4479
4562
  /**
4480
- * 访问强制跳转配置开关
4481
- on:开启
4482
- off:关闭
4563
+ * 访问强制跳转配置开关,取值有:
4564
+ <li>on:开启;</li>
4565
+ <li>off:关闭。</li>
4483
4566
  */
4484
4567
  Switch: string
4485
4568
 
4486
4569
  /**
4487
- * 重定向状态码
4488
- 301
4489
- 302
4570
+ * 重定向状态码,取值有:
4571
+ <li>301:301跳转;</li>
4572
+ <li>302:302跳转。</li>
4490
4573
  注意:此字段可能返回 null,表示取不到有效值。
4491
4574
  */
4492
4575
  RedirectStatusCode?: number
@@ -4497,43 +4580,47 @@ off:关闭
4497
4580
  */
4498
4581
  export interface ModifyApplicationProxyRequest {
4499
4582
  /**
4500
- * 站点ID
4583
+ * 站点ID
4501
4584
  */
4502
4585
  ZoneId: string
4503
4586
 
4504
4587
  /**
4505
- * 代理ID
4588
+ * 代理ID
4506
4589
  */
4507
4590
  ProxyId: string
4508
4591
 
4509
4592
  /**
4510
- * 代理名称
4511
- 当ProxyType=hostname时,表示域名或者子域名
4512
- 当ProxyType=instance时,表示实例名称
4593
+ * 当ProxyType=hostname时,表示域名或子域名;
4594
+ 当ProxyType=instance时,表示代理名称。
4513
4595
  */
4514
4596
  ProxyName: string
4515
4597
 
4516
4598
  /**
4517
- * 参数已经废弃
4599
+ * 参数已经废弃。
4518
4600
  */
4519
4601
  ForwardClientIp: string
4520
4602
 
4521
4603
  /**
4522
- * 参数已经废弃
4604
+ * 参数已经废弃。
4523
4605
  */
4524
4606
  SessionPersist: boolean
4525
4607
 
4526
4608
  /**
4527
- * 会话保持时间,取值范围:30-3600,单位:秒
4609
+ * 会话保持时间,不填写保持原有配置。取值范围:30-3600,单位:秒。
4528
4610
  */
4529
4611
  SessionPersistTime?: number
4530
4612
 
4531
4613
  /**
4532
- * 服务类型
4533
- hostname:子域名模式
4534
- instance:实例模式
4614
+ * 四层代理模式,取值有:
4615
+ <li>hostname:表示子域名模式;</li>
4616
+ <li>instance:表示实例模式。</li>不填写保持原有配置。
4535
4617
  */
4536
4618
  ProxyType?: string
4619
+
4620
+ /**
4621
+ * Ipv6访问配置,不填写保持原有配置。
4622
+ */
4623
+ Ipv6?: Ipv6Access
4537
4624
  }
4538
4625
 
4539
4626
  /**
@@ -4703,12 +4790,14 @@ export interface DescribeDefaultCertificatesResponse {
4703
4790
  */
4704
4791
  export interface CachePrefresh {
4705
4792
  /**
4706
- * 缓存预刷新配置开关
4707
- */
4793
+ * 缓存预刷新配置开关,取值有:
4794
+ <li>on:开启;</li>
4795
+ <li>off:关闭。</li>
4796
+ */
4708
4797
  Switch: string
4709
4798
 
4710
4799
  /**
4711
- * 缓存预刷新百分比:1-99
4800
+ * 缓存预刷新百分比,取值范围:1-99
4712
4801
  注意:此字段可能返回 null,表示取不到有效值。
4713
4802
  */
4714
4803
  Percent?: number
@@ -5012,19 +5101,25 @@ both:同时被仅DNS和代理加速类型负载均衡使用
5012
5101
  */
5013
5102
  export interface DescribeApplicationProxyRequest {
5014
5103
  /**
5015
- * 站点ID
5104
+ * 站点ID
5016
5105
  */
5017
5106
  ZoneId?: string
5018
5107
 
5019
5108
  /**
5020
- * 分页参数Offset
5109
+ * 分页查询偏移量,默认为0。
5021
5110
  */
5022
5111
  Offset?: number
5023
5112
 
5024
5113
  /**
5025
- * 分页参数Limit
5114
+ * 分页查询限制数目,默认为10,最大可设置为1000。
5026
5115
  */
5027
5116
  Limit?: number
5117
+
5118
+ /**
5119
+ * 代理ID。
5120
+ 当ProxyId为空时,表示查询站点下所有应用代理的列表。
5121
+ */
5122
+ ProxyId?: string
5028
5123
  }
5029
5124
 
5030
5125
  /**
@@ -5032,12 +5127,12 @@ export interface DescribeApplicationProxyRequest {
5032
5127
  */
5033
5128
  export interface TopNEntryValue {
5034
5129
  /**
5035
- * Entry的name
5130
+ * 排序实体名。
5036
5131
  */
5037
5132
  Name: string
5038
5133
 
5039
5134
  /**
5040
- * 数量
5135
+ * 排序实体数量。
5041
5136
  */
5042
5137
  Count: number
5043
5138
  }
@@ -5127,48 +5222,60 @@ export interface WebAttackEvent {
5127
5222
  */
5128
5223
  export interface DescribeDDosAttackTopDataRequest {
5129
5224
  /**
5130
- * 开始时间
5225
+ * 开始时间。
5131
5226
  */
5132
5227
  StartTime: string
5133
5228
 
5134
5229
  /**
5135
- * 结束时间
5230
+ * 结束时间。
5136
5231
  */
5137
5232
  EndTime: string
5138
5233
 
5139
5234
  /**
5140
- * 过滤指标
5141
- */
5235
+ * 统计指标列表,取值有:
5236
+ <li>ddos_attackFlux_protocol :攻击总流量协议类型分布排行 ;</li>
5237
+ <li>ddos_attackPackageNum_protocol :攻击总包量协议类型分布排行 ;</li>
5238
+ <li>ddos_attackNum_attackType :攻击总次数攻击类型分布排行 ;</li>
5239
+ <li>ddos_attackNum_sregion :攻击总次数攻击源地区分布排行 ;</li>
5240
+ <li>ddos_attackFlux_sip :攻击总流量攻击源ip分布排行 ;</li>
5241
+ <li>ddos_attackFlux_sregion :攻击总流量攻击源地区分布排行 。</li>
5242
+ */
5142
5243
  MetricName: string
5143
5244
 
5144
5245
  /**
5145
- * 查询前多少名,传值为0 全量
5246
+ * 查询前多少个,传值为0返回全量。
5146
5247
  */
5147
5248
  Limit: number
5148
5249
 
5149
5250
  /**
5150
- * 站点集合
5251
+ * 站点id集合,不填默认选择全部站点。
5151
5252
  */
5152
5253
  ZoneIds?: Array<string>
5153
5254
 
5154
5255
  /**
5155
- * ddos策略组id 集合
5256
+ * ddos策略组id 集合,不填默认选择全部策略id。
5156
5257
  */
5157
5258
  PolicyIds?: Array<number>
5158
5259
 
5159
5260
  /**
5160
- * 端口号
5261
+ * 端口号。
5161
5262
  */
5162
5263
  Port?: number
5163
5264
 
5164
5265
  /**
5165
- * 协议类型,tcp,udp,all
5166
- */
5266
+ * 协议类型,取值有:
5267
+ <li>tcp ;</li>
5268
+ <li>udp ;</li>
5269
+ <li>all 。</li>
5270
+ */
5167
5271
  ProtocolType?: string
5168
5272
 
5169
5273
  /**
5170
- * 攻击类型,flood,icmpFlood......,all
5171
- */
5274
+ * 攻击类型,取值有:
5275
+ <li>flood ;</li>
5276
+ <li>icmpFlood ;</li>
5277
+ <li>all 。</li>
5278
+ */
5172
5279
  AttackType?: string
5173
5280
  }
5174
5281
 
@@ -5192,48 +5299,62 @@ export interface CreateApplicationProxyRuleResponse {
5192
5299
  */
5193
5300
  export interface DescribeDDosAttackDataRequest {
5194
5301
  /**
5195
- * 开始时间
5302
+ * 开始时间。
5196
5303
  */
5197
5304
  StartTime: string
5198
5305
 
5199
5306
  /**
5200
- * 结束时间
5307
+ * 结束时间。
5201
5308
  */
5202
5309
  EndTime: string
5203
5310
 
5204
5311
  /**
5205
- * 统计指标列表
5206
- */
5312
+ * 统计指标列表,取值有:
5313
+ <li>ddos_attackMaxBandwidth :攻击带宽峰值 ;</li>
5314
+ <li>ddos_attackMaxPackageRate:攻击包速率峰值 ;</li>
5315
+ <li>ddos_attackBandwidth :攻击带宽曲线 ;</li>
5316
+ <li>ddos_attackPackageRate :攻击包速率曲线 。</li>
5317
+ */
5207
5318
  MetricNames: Array<string>
5208
5319
 
5209
5320
  /**
5210
- * 站点id列表
5321
+ * 站点id列表,不填默认选择全部站点。
5211
5322
  */
5212
5323
  ZoneIds?: Array<string>
5213
5324
 
5214
5325
  /**
5215
- * ddos策略组id列表
5326
+ * ddos策略组id列表,不填默认选择全部策略id。
5216
5327
  */
5217
5328
  PolicyIds?: Array<number>
5218
5329
 
5219
5330
  /**
5220
- * 端口号
5331
+ * 端口号。
5221
5332
  */
5222
5333
  Port?: number
5223
5334
 
5224
5335
  /**
5225
- * 协议类型,tcp,udp,all
5226
- */
5336
+ * 协议类型,取值有:
5337
+ <li>tcp ;</li>
5338
+ <li>udp ;</li>
5339
+ <li>all 。</li>
5340
+ */
5227
5341
  ProtocolType?: string
5228
5342
 
5229
5343
  /**
5230
- * 攻击类型,flood,icmpFlood......,all
5231
- */
5344
+ * 攻击类型,取值有:
5345
+ <li>flood ;</li>
5346
+ <li>icmpFlood ;</li>
5347
+ <li>all 。</li>
5348
+ */
5232
5349
  AttackType?: string
5233
5350
 
5234
5351
  /**
5235
- * 查询时间粒度,可选{min,5min,hour,day}
5236
- */
5352
+ * 查询时间粒度,取值有:
5353
+ <li>min :1分钟 ;</li>
5354
+ <li>5min :5分钟 ;</li>
5355
+ <li>hour :1小时 ;</li>
5356
+ <li>day :1天 。</li>
5357
+ */
5237
5358
  Interval?: string
5238
5359
  }
5239
5360
 
@@ -5364,13 +5485,13 @@ export interface RateLimitTemplateDetail {
5364
5485
  */
5365
5486
  export interface TimingDataItem {
5366
5487
  /**
5367
- * 秒级时间戳
5488
+ * 返回数据对应时间点,采用unix秒级时间戳
5368
5489
  注意:此字段可能返回 null,表示取不到有效值。
5369
5490
  */
5370
5491
  Timestamp: number
5371
5492
 
5372
5493
  /**
5373
- * 数值
5494
+ * 具体数值
5374
5495
  注意:此字段可能返回 null,表示取不到有效值。
5375
5496
  */
5376
5497
  Value: number
@@ -5381,65 +5502,75 @@ export interface TimingDataItem {
5381
5502
  */
5382
5503
  export interface CreateApplicationProxyRequest {
5383
5504
  /**
5384
- * 站点ID
5505
+ * 站点ID
5385
5506
  */
5386
5507
  ZoneId: string
5387
5508
 
5388
5509
  /**
5389
- * 站点名称
5510
+ * 站点名称。
5390
5511
  */
5391
5512
  ZoneName: string
5392
5513
 
5393
5514
  /**
5394
- * 代理名称
5395
- 当ProxyType=hostname时,表示域名或者子域名
5396
- 当ProxyType=instance时,表示实例名称
5515
+ * 规则详细信息。
5516
+ */
5517
+ Rule: Array<ApplicationProxyRule>
5518
+
5519
+ /**
5520
+ * 当ProxyType=hostname时,表示域名或子域名;
5521
+ 当ProxyType=instance时,表示代理名称。
5397
5522
  */
5398
5523
  ProxyName: string
5399
5524
 
5400
5525
  /**
5401
- * 调度模式:
5402
- ip表示Anycast IP
5403
- domain表示CNAME
5526
+ * 调度模式,取值有:
5527
+ <li>ip:表示Anycast IP调度;</li>
5528
+ <li>domain:表示CNAME调度。</li>
5404
5529
  */
5405
5530
  PlatType: string
5406
5531
 
5407
5532
  /**
5408
- * 0关闭安全,1开启安全
5409
- */
5533
+ * 是否开启安全,取值有:
5534
+ <li>0:关闭安全;</li>
5535
+ <li>1:开启安全。</li>
5536
+ */
5410
5537
  SecurityType: number
5411
5538
 
5412
5539
  /**
5413
- * 0关闭加速,1开启加速
5414
- */
5540
+ * 是否开启加速,取值有:
5541
+ <li>0:关闭加速;</li>
5542
+ <li>1:开启加速。</li>
5543
+ */
5415
5544
  AccelerateType: number
5416
5545
 
5417
5546
  /**
5418
- * 字段已经移至Rule.ForwardClientIp
5547
+ * 字段已经废弃。
5419
5548
  */
5420
- ForwardClientIp: string
5549
+ SessionPersist: boolean
5421
5550
 
5422
5551
  /**
5423
- * 字段已经移至Rule.SessionPersist
5552
+ * 字段已经废弃。
5424
5553
  */
5425
- SessionPersist: boolean
5554
+ ForwardClientIp: string
5426
5555
 
5427
5556
  /**
5428
- * 规则详细信息
5429
- */
5430
- Rule: Array<ApplicationProxyRule>
5557
+ * 四层代理模式,取值有:
5558
+ <li>hostname:表示子域名模式;</li>
5559
+ <li>instance:表示实例模式。</li>不填写使用默认值instance。
5560
+ */
5561
+ ProxyType?: string
5431
5562
 
5432
5563
  /**
5433
- * 会话保持时间,取值范围:30-3600,单位:秒
5434
- */
5564
+ * 会话保持时间,取值范围:30-3600,单位:秒。
5565
+ 不填写使用默认值600。
5566
+ */
5435
5567
  SessionPersistTime?: number
5436
5568
 
5437
5569
  /**
5438
- * 服务类型
5439
- hostname:子域名模式
5440
- instance:实例模式
5570
+ * Ipv6访问配置。
5571
+ 不填写表示关闭Ipv6访问。
5441
5572
  */
5442
- ProxyType?: string
5573
+ Ipv6?: Ipv6Access
5443
5574
  }
5444
5575
 
5445
5576
  /**
@@ -5507,14 +5638,14 @@ export interface IntelligenceRule {
5507
5638
  */
5508
5639
  export interface PostMaxSize {
5509
5640
  /**
5510
- * 是调整POST请求限制,平台默认为32MB
5511
- 关闭:off,
5512
- 开启:on。
5641
+ * 是否开启POST请求上传文件限制,平台默认为限制为32MB,取值有:
5642
+ <li>on:开启限制;</li>
5643
+ <li>off:关闭限制。</li>
5513
5644
  */
5514
5645
  Switch: string
5515
5646
 
5516
5647
  /**
5517
- * 最大限制,取值在1MB和500MB之间。单位字节
5648
+ * 最大限制,取值在1MB和500MB之间。单位字节。
5518
5649
  注意:此字段可能返回 null,表示取不到有效值。
5519
5650
  */
5520
5651
  MaxSize?: number
@@ -5952,106 +6083,104 @@ export interface WebEventData {
5952
6083
  */
5953
6084
  export interface ApplicationProxy {
5954
6085
  /**
5955
- * 代理ID
5956
- 注意:此字段可能返回 null,表示取不到有效值。
5957
- */
6086
+ * 代理ID
6087
+ */
5958
6088
  ProxyId?: string
5959
6089
 
5960
6090
  /**
5961
- * 代理名称
5962
- 当ProxyType=hostname时,表示域名或者子域名
5963
- 当ProxyType=instance时,表示实例名称
6091
+ * 当ProxyType=hostname时,表示域名或子域名;
6092
+ 当ProxyType=instance时,表示代理名称。
5964
6093
  */
5965
6094
  ProxyName: string
5966
6095
 
5967
6096
  /**
5968
- * 调度模式:
5969
- ip表示Anycast IP
5970
- domain表示CNAME
6097
+ * 调度模式,取值有:
6098
+ <li>ip:表示Anycast IP调度;</li>
6099
+ <li>domain:表示CNAME调度。</li>
5971
6100
  */
5972
6101
  PlatType: string
5973
6102
 
5974
6103
  /**
5975
- * 0关闭安全,1开启安全
5976
- */
6104
+ * 是否开启安全,取值有:
6105
+ <li>0:关闭安全;</li>
6106
+ <li>1:开启安全。</li>
6107
+ */
5977
6108
  SecurityType: number
5978
6109
 
5979
6110
  /**
5980
- * 0关闭加速,1开启加速
5981
- */
6111
+ * 是否开启加速,取值有:
6112
+ <li>0:关闭加速;</li>
6113
+ <li>1:开启加速。</li>
6114
+ */
5982
6115
  AccelerateType: number
5983
6116
 
5984
6117
  /**
5985
- * 字段已经移至Rule.ForwardClientIp
6118
+ * 字段已经废弃。
5986
6119
  */
5987
6120
  ForwardClientIp: string
5988
6121
 
5989
6122
  /**
5990
- * 字段已经移至Rule.SessionPersist
6123
+ * 字段已经废弃。
5991
6124
  */
5992
6125
  SessionPersist: boolean
5993
6126
 
5994
6127
  /**
5995
- * 规则列表
6128
+ * 规则列表。
5996
6129
  */
5997
6130
  Rule: Array<ApplicationProxyRule>
5998
6131
 
5999
6132
  /**
6000
- * 状态:
6001
- online:启用
6002
- offline:停用
6003
- progress:部署中
6004
- stopping:停用中
6005
- fail:部署失败/停用失败
6006
- 注意:此字段可能返回 null,表示取不到有效值。
6133
+ * 状态,取值有:
6134
+ <li>online:启用;</li>
6135
+ <li>offline:停用;</li>
6136
+ <li>progress:部署中;</li>
6137
+ <li>stopping:停用中;</li>
6138
+ <li>fail:部署失败/停用失败。</li>
6007
6139
  */
6008
6140
  Status: string
6009
6141
 
6010
6142
  /**
6011
- * 调度信息
6012
- 注意:此字段可能返回 null,表示取不到有效值。
6013
- */
6143
+ * 调度信息。
6144
+ */
6014
6145
  ScheduleValue: Array<string>
6015
6146
 
6016
6147
  /**
6017
- * 更新时间
6018
- 注意:此字段可能返回 null,表示取不到有效值。
6019
- */
6148
+ * 更新时间。
6149
+ */
6020
6150
  UpdateTime: string
6021
6151
 
6022
6152
  /**
6023
- * 站点ID
6024
- 注意:此字段可能返回 null,表示取不到有效值。
6025
- */
6153
+ * 站点ID
6154
+ */
6026
6155
  ZoneId: string
6027
6156
 
6028
6157
  /**
6029
- * 站点名称
6030
- 注意:此字段可能返回 null,表示取不到有效值。
6031
- */
6158
+ * 站点名称。
6159
+ */
6032
6160
  ZoneName: string
6033
6161
 
6034
6162
  /**
6035
- * 会话保持时间
6036
- 注意:此字段可能返回 null,表示取不到有效值。
6037
- */
6163
+ * 会话保持时间。
6164
+ */
6038
6165
  SessionPersistTime: number
6039
6166
 
6040
6167
  /**
6041
- * 服务类型
6042
- hostname:子域名模式
6043
- instance:实例模式
6044
- 注意:此字段可能返回 null,表示取不到有效值。
6168
+ * 四层代理模式,取值有:
6169
+ <li>hostname:表示子域名模式;</li>
6170
+ <li>instance:表示实例模式。</li>
6045
6171
  */
6046
6172
  ProxyType: string
6047
6173
 
6048
6174
  /**
6049
6175
  * 当ProxyType=hostname时:
6050
- ProxyName为域名,如:test.123.com
6051
- HostId表示该域名,即test.123.com对应的代理加速唯一标识
6052
- 注意:此字段可能返回 null,表示取不到有效值。
6176
+ 表示代理加速唯一标识。
6053
6177
  */
6054
6178
  HostId: string
6179
+
6180
+ /**
6181
+ * Ipv6访问配置。
6182
+ */
6183
+ Ipv6: Ipv6Access
6055
6184
  }
6056
6185
 
6057
6186
  /**
@@ -6059,7 +6188,7 @@ HostId表示该域名,即test.123.com对应的代理加速唯一标识
6059
6188
  */
6060
6189
  export interface ModifyApplicationProxyResponse {
6061
6190
  /**
6062
- * 代理ID
6191
+ * 代理ID
6063
6192
  */
6064
6193
  ProxyId: string
6065
6194
 
@@ -6084,21 +6213,23 @@ export interface DescribeDDoSPolicyResponse {
6084
6213
  */
6085
6214
  export interface CacheKey {
6086
6215
  /**
6087
- * 是否开启全路径缓存
6088
- on:开启全路径缓存(即关闭参数忽略)
6089
- off:关闭全路径缓存(即开启参数忽略)
6216
+ * 是否开启全路径缓存,取值有:
6217
+ <li>on:开启全路径缓存(即关闭参数忽略);</li>
6218
+ <li>off:关闭全路径缓存(即开启参数忽略)。</li>
6090
6219
  注意:此字段可能返回 null,表示取不到有效值。
6091
6220
  */
6092
6221
  FullUrlCache?: string
6093
6222
 
6094
6223
  /**
6095
- * 是否忽略大小写缓存
6224
+ * 是否忽略大小写缓存,取值有:
6225
+ <li>on:忽略;</li>
6226
+ <li>off:不忽略。</li>
6096
6227
  注意:此字段可能返回 null,表示取不到有效值。
6097
6228
  */
6098
6229
  IgnoreCase?: string
6099
6230
 
6100
6231
  /**
6101
- * CacheKey中包含请求参数
6232
+ * CacheKey中包含请求参数。
6102
6233
  注意:此字段可能返回 null,表示取不到有效值。
6103
6234
  */
6104
6235
  QueryString?: QueryString
@@ -6201,12 +6332,12 @@ export interface DescribeTimingL7CacheDataResponse {
6201
6332
  */
6202
6333
  export interface DescribeApplicationProxyDetailRequest {
6203
6334
  /**
6204
- * 站点ID
6335
+ * 站点ID
6205
6336
  */
6206
6337
  ZoneId: string
6207
6338
 
6208
6339
  /**
6209
- * 实例ID
6340
+ * 实例ID
6210
6341
  */
6211
6342
  ProxyId: string
6212
6343
  }
@@ -6295,17 +6426,19 @@ export interface VanityNameServersIps {
6295
6426
  */
6296
6427
  export interface DescribeDDosAttackSourceEventResponse {
6297
6428
  /**
6298
- * DDos攻击源数据
6429
+ * DDos攻击源数据。
6299
6430
  */
6300
6431
  Data: DDosAttackSourceEventData
6301
6432
 
6302
6433
  /**
6303
- * 状态,1:失败,0:成功
6304
- */
6434
+ * 请求响应状态,取值有:
6435
+ <li>1 :失败 ;</li>
6436
+ <li>0 :成功 。</li>
6437
+ */
6305
6438
  Status: number
6306
6439
 
6307
6440
  /**
6308
- * 返回信息
6441
+ * 请求响应信息。
6309
6442
  */
6310
6443
  Msg: string
6311
6444
 
@@ -6345,13 +6478,13 @@ export interface DescribeDDoSPolicyRequest {
6345
6478
  */
6346
6479
  export interface SecEntry {
6347
6480
  /**
6348
- * Entry的Key
6481
+ * 查询维度值。
6349
6482
  注意:此字段可能返回 null,表示取不到有效值。
6350
6483
  */
6351
6484
  Key: string
6352
6485
 
6353
6486
  /**
6354
- * Entry的Value
6487
+ * 查询维度下详细数据。
6355
6488
  注意:此字段可能返回 null,表示取不到有效值。
6356
6489
  */
6357
6490
  Value: Array<SecEntryValue>
@@ -6362,37 +6495,40 @@ export interface SecEntry {
6362
6495
  */
6363
6496
  export interface DescribeDDosMajorAttackEventRequest {
6364
6497
  /**
6365
- * 开始时间
6498
+ * 开始时间。
6366
6499
  */
6367
6500
  StartTime: string
6368
6501
 
6369
6502
  /**
6370
- * 结束时间
6503
+ * 结束时间。
6371
6504
  */
6372
6505
  EndTime: string
6373
6506
 
6374
6507
  /**
6375
- * 条数
6508
+ * 分页拉取的最大返回结果数。最大值:1000。
6376
6509
  */
6377
6510
  PageSize: number
6378
6511
 
6379
6512
  /**
6380
- * 当前页
6513
+ * 分页拉取的起始页号。最小值:1。
6381
6514
  */
6382
6515
  PageNo: number
6383
6516
 
6384
6517
  /**
6385
- * ddos 策略组id集合
6518
+ * ddos 策略组id集合,不填默认选择全部策略id。
6386
6519
  */
6387
6520
  PolicyIds?: Array<number>
6388
6521
 
6389
6522
  /**
6390
- * 协议类型,{tcp,udp,all}
6391
- */
6523
+ * 协议类型,取值有:
6524
+ <li>tcp ;</li>
6525
+ <li>udp ;</li>
6526
+ <li>all 。</li>
6527
+ */
6392
6528
  ProtocolType?: string
6393
6529
 
6394
6530
  /**
6395
- * 站点集合
6531
+ * 站点id列表,不填默认选择全部站点。
6396
6532
  */
6397
6533
  ZoneIds?: Array<string>
6398
6534
  }
@@ -6402,8 +6538,10 @@ export interface DescribeDDosMajorAttackEventRequest {
6402
6538
  */
6403
6539
  export interface Quic {
6404
6540
  /**
6405
- * 是否启动Quic配置
6406
- */
6541
+ * 是否开启Quic配置,取值有:
6542
+ <li>on:开启;</li>
6543
+ <li>off:关闭。</li>
6544
+ */
6407
6545
  Switch: string
6408
6546
  }
6409
6547
 
@@ -6458,20 +6596,23 @@ export interface DescribeSecurityPolicyResponse {
6458
6596
  */
6459
6597
  export interface QueryString {
6460
6598
  /**
6461
- * on | off CacheKey是否由QueryString组成
6599
+ * CacheKey是否由QueryString组成,取值有:
6600
+ <li>on:是;</li>
6601
+ <li>off:否。</li>
6462
6602
  注意:此字段可能返回 null,表示取不到有效值。
6463
6603
  */
6464
6604
  Switch: string
6465
6605
 
6466
6606
  /**
6467
- * includeCustom:使用部分url参数
6468
- excludeCustom:排除部分url参数
6607
+ * CacheKey使用QueryString的方式,取值有:
6608
+ <li>includeCustom:使用部分url参数;</li>
6609
+ <li>excludeCustom:排除部分url参数。</li>
6469
6610
  注意:此字段可能返回 null,表示取不到有效值。
6470
6611
  */
6471
6612
  Action?: string
6472
6613
 
6473
6614
  /**
6474
- * 使用/排除的url参数数组
6615
+ * 使用/排除的url参数数组。
6475
6616
  注意:此字段可能返回 null,表示取不到有效值。
6476
6617
  */
6477
6618
  Value?: Array<string>
@@ -6487,31 +6628,31 @@ export type DescribeSecurityPolicyRegionsRequest = null
6487
6628
  */
6488
6629
  export interface SecEntryValue {
6489
6630
  /**
6490
- * 指标名称
6631
+ * 指标名称。
6491
6632
  注意:此字段可能返回 null,表示取不到有效值。
6492
6633
  */
6493
6634
  Metric: string
6494
6635
 
6495
6636
  /**
6496
- * 指标数据明细
6637
+ * 时序数据详情。
6497
6638
  注意:此字段可能返回 null,表示取不到有效值。
6498
6639
  */
6499
6640
  Detail: Array<TimingDataItem>
6500
6641
 
6501
6642
  /**
6502
- * 最大值
6643
+ * 最大值。
6503
6644
  注意:此字段可能返回 null,表示取不到有效值。
6504
6645
  */
6505
6646
  Max: number
6506
6647
 
6507
6648
  /**
6508
- * 平均值
6649
+ * 平均值。
6509
6650
  注意:此字段可能返回 null,表示取不到有效值。
6510
6651
  */
6511
6652
  Avg: number
6512
6653
 
6513
6654
  /**
6514
- * 数据总和
6655
+ * 数据总和。
6515
6656
  注意:此字段可能返回 null,表示取不到有效值。
6516
6657
  */
6517
6658
  Sum: number
@@ -6639,58 +6780,66 @@ export interface ModifyDefaultCertificateResponse {
6639
6780
  */
6640
6781
  export interface DescribeDDosAttackEventRequest {
6641
6782
  /**
6642
- * 开始时间
6783
+ * 开始时间。
6643
6784
  */
6644
6785
  StartTime: string
6645
6786
 
6646
6787
  /**
6647
- * 结束时间
6788
+ * 结束时间。
6648
6789
  */
6649
6790
  EndTime: string
6650
6791
 
6651
6792
  /**
6652
- * 条数
6793
+ * 分页拉取的最大返回结果数。最大值:1000。
6653
6794
  */
6654
6795
  PageSize: number
6655
6796
 
6656
6797
  /**
6657
- * 当前页
6798
+ * 分页拉取的起始页号。最小值:1。
6658
6799
  */
6659
6800
  PageNo: number
6660
6801
 
6661
6802
  /**
6662
- * ddos策略组id 集合
6803
+ * ddos策略组id列表,不填默认选择全部策略Id。
6663
6804
  */
6664
6805
  PolicyIds?: Array<number>
6665
6806
 
6666
6807
  /**
6667
- * 站点集合
6808
+ * 站点id列表,不填默认选择全部站点。
6668
6809
  */
6669
6810
  ZoneIds?: Array<string>
6670
6811
 
6671
6812
  /**
6672
- * 协议类型,{tcp,udp,all}
6673
- */
6813
+ * 协议类型,取值有:
6814
+ <li>tcp ;</li>
6815
+ <li>udp ;</li>
6816
+ <li>all 。</li>
6817
+ */
6674
6818
  ProtocolType?: string
6675
6819
 
6676
6820
  /**
6677
- * 选填{Y、N},默认为Y;Y:展示,N:不展示
6678
- */
6821
+ * 是否展示详情,取值有:
6822
+ <li>Y :展示 ;</li>
6823
+ <li>N :不展示 。</li>默认为Y。
6824
+ */
6679
6825
  IsShowDetail?: string
6680
6826
  }
6681
6827
 
6682
6828
  /**
6683
- * 客户端IP头部
6829
+ * 存储客户端请求IP的头部信息配置
6684
6830
  */
6685
6831
  export interface ClientIp {
6686
6832
  /**
6687
- * 客户端IP头部配置开关
6833
+ * 配置开关,取值有:
6834
+ <li>on:开启;</li>
6835
+ <li>off:关闭。</li>
6688
6836
  注意:此字段可能返回 null,表示取不到有效值。
6689
6837
  */
6690
6838
  Switch: string
6691
6839
 
6692
6840
  /**
6693
- * 回源客户端IP请求头名称
6841
+ * 回源时,存放客户端IP的请求头名称。
6842
+ 为空则使用默认值:X-Forwarded-IP。
6694
6843
  注意:此字段可能返回 null,表示取不到有效值。
6695
6844
  */
6696
6845
  HeaderName?: string
@@ -6744,105 +6893,111 @@ export interface DescribeHostsCertificateResponse {
6744
6893
  */
6745
6894
  export interface DescribeZoneSettingResponse {
6746
6895
  /**
6747
- * 缓存过期时间配置
6748
- 注意:此字段可能返回 null,表示取不到有效值。
6749
- */
6750
- Cache: CacheConfig
6896
+ * 站点ID。
6897
+ */
6898
+ ZoneId: string
6751
6899
 
6752
6900
  /**
6753
- * 节点缓存键配置
6754
- 注意:此字段可能返回 null,表示取不到有效值。
6755
- */
6756
- CacheKey: CacheKey
6901
+ * 站点名称。
6902
+ */
6903
+ Zone: string
6757
6904
 
6758
6905
  /**
6759
- * 浏览器缓存配置
6906
+ * 缓存过期时间配置。
6760
6907
  注意:此字段可能返回 null,表示取不到有效值。
6761
6908
  */
6762
- MaxAge: MaxAge
6909
+ Cache: CacheConfig
6763
6910
 
6764
6911
  /**
6765
- * 离线缓存
6912
+ * 节点缓存键配置。
6766
6913
  注意:此字段可能返回 null,表示取不到有效值。
6767
6914
  */
6768
- OfflineCache: OfflineCache
6915
+ CacheKey: CacheKey
6769
6916
 
6770
6917
  /**
6771
- * Quic访问
6918
+ * Quic访问配置。
6772
6919
  注意:此字段可能返回 null,表示取不到有效值。
6773
6920
  */
6774
6921
  Quic: Quic
6775
6922
 
6776
6923
  /**
6777
- * POST请求传输配置
6924
+ * POST请求传输配置。
6778
6925
  注意:此字段可能返回 null,表示取不到有效值。
6779
6926
  */
6780
6927
  PostMaxSize: PostMaxSize
6781
6928
 
6782
6929
  /**
6783
- * 智能压缩配置
6930
+ * 智能压缩配置。
6784
6931
  注意:此字段可能返回 null,表示取不到有效值。
6785
6932
  */
6786
6933
  Compression: Compression
6787
6934
 
6788
6935
  /**
6789
- * http2回源配置
6936
+ * Http2回源配置。
6790
6937
  注意:此字段可能返回 null,表示取不到有效值。
6791
6938
  */
6792
6939
  UpstreamHttp2: UpstreamHttp2
6793
6940
 
6794
6941
  /**
6795
- * 访问协议强制https跳转配置
6942
+ * 访问协议强制Https跳转配置。
6796
6943
  注意:此字段可能返回 null,表示取不到有效值。
6797
6944
  */
6798
6945
  ForceRedirect: ForceRedirect
6799
6946
 
6800
6947
  /**
6801
- * Https 加速配置
6948
+ * Https 加速配置。
6802
6949
  注意:此字段可能返回 null,表示取不到有效值。
6803
6950
  */
6804
6951
  Https: Https
6805
6952
 
6806
6953
  /**
6807
- * 源站配置
6954
+ * 源站配置。
6808
6955
  注意:此字段可能返回 null,表示取不到有效值。
6809
6956
  */
6810
6957
  Origin: Origin
6811
6958
 
6812
6959
  /**
6813
- * 动态加速配置
6960
+ * 智能加速配置。
6814
6961
  注意:此字段可能返回 null,表示取不到有效值。
6815
6962
  */
6816
6963
  SmartRouting: SmartRouting
6817
6964
 
6818
6965
  /**
6819
- * 站点ID
6820
- */
6821
- ZoneId: string
6966
+ * 浏览器缓存配置。
6967
+ 注意:此字段可能返回 null,表示取不到有效值。
6968
+ */
6969
+ MaxAge: MaxAge
6822
6970
 
6823
6971
  /**
6824
- * 站点域名
6825
- */
6826
- Zone: string
6972
+ * 离线缓存配置。
6973
+ 注意:此字段可能返回 null,表示取不到有效值。
6974
+ */
6975
+ OfflineCache: OfflineCache
6827
6976
 
6828
6977
  /**
6829
- * WebSocket配置
6978
+ * WebSocket配置。
6830
6979
  注意:此字段可能返回 null,表示取不到有效值。
6831
6980
  */
6832
6981
  WebSocket: WebSocket
6833
6982
 
6834
6983
  /**
6835
- * 客户端IP回源请求头配置
6984
+ * 客户端IP回源请求头配置。
6836
6985
  注意:此字段可能返回 null,表示取不到有效值。
6837
6986
  */
6838
6987
  ClientIpHeader: ClientIp
6839
6988
 
6840
6989
  /**
6841
- * 缓存预刷新配置
6990
+ * 缓存预刷新配置。
6842
6991
  注意:此字段可能返回 null,表示取不到有效值。
6843
6992
  */
6844
6993
  CachePrefresh: CachePrefresh
6845
6994
 
6995
+ /**
6996
+ * Ipv6访问配置。
6997
+ 注意:此字段可能返回 null,表示取不到有效值。
6998
+ */
6999
+ Ipv6: Ipv6Access
7000
+
6846
7001
  /**
6847
7002
  * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
6848
7003
  */
@@ -6866,17 +7021,17 @@ smart_status_observe-观察处置
6866
7021
  */
6867
7022
  export interface MaxAge {
6868
7023
  /**
6869
- * MaxAge 时间设置,单位秒,最大365天
6870
- 注意:时间为0,即不缓存。
6871
- 注意:此字段可能返回 null,表示取不到有效值。
7024
+ * 是否遵循源站,取值有:
7025
+ <li>on:遵循源站,忽略MaxAge 时间设置;</li>
7026
+ <li>off:不遵循源站,使用MaxAge 时间设置。</li>
6872
7027
  */
6873
- MaxAgeTime?: number
7028
+ FollowOrigin?: string
6874
7029
 
6875
7030
  /**
6876
- * 是否遵循源站,on或off,开启时忽略时间设置。
6877
- 注意:此字段可能返回 null,表示取不到有效值。
7031
+ * MaxAge 时间设置,单位秒,最大365天。
7032
+ 注意:时间为0,即不缓存。
6878
7033
  */
6879
- FollowOrigin?: string
7034
+ MaxAgeTime?: number
6880
7035
  }
6881
7036
 
6882
7037
  /**
@@ -6990,19 +7145,19 @@ day:天粒度
6990
7145
  */
6991
7146
  export interface CacheConfig {
6992
7147
  /**
6993
- * 缓存配置
7148
+ * 缓存配置。
6994
7149
  注意:此字段可能返回 null,表示取不到有效值。
6995
7150
  */
6996
7151
  Cache?: CacheConfigCache
6997
7152
 
6998
7153
  /**
6999
- * 不缓存配置
7154
+ * 不缓存配置。
7000
7155
  注意:此字段可能返回 null,表示取不到有效值。
7001
7156
  */
7002
7157
  NoCache?: CacheConfigNoCache
7003
7158
 
7004
7159
  /**
7005
- * 遵循源站配置
7160
+ * 遵循源站配置。
7006
7161
  注意:此字段可能返回 null,表示取不到有效值。
7007
7162
  */
7008
7163
  FollowOrigin?: CacheConfigFollowOrigin
@@ -7013,17 +7168,19 @@ export interface CacheConfig {
7013
7168
  */
7014
7169
  export interface DescribeDDosAttackEventDetailResponse {
7015
7170
  /**
7016
- * DDos攻击事件详情
7171
+ * DDos攻击事件详情。
7017
7172
  */
7018
7173
  Data: DDosAttackEventDetailData
7019
7174
 
7020
7175
  /**
7021
- * 状态,1:失败,0:成功
7022
- */
7176
+ * 请求响应状态,取值有:
7177
+ <li>1 :失败 ;</li>
7178
+ <li>0 :成功 。</li>
7179
+ */
7023
7180
  Status: number
7024
7181
 
7025
7182
  /**
7026
- * 返回信息
7183
+ * 请求响应信息。
7027
7184
  */
7028
7185
  Msg: string
7029
7186
 
@@ -7157,39 +7314,60 @@ export interface ModifyZoneCnameSpeedUpResponse {
7157
7314
  */
7158
7315
  export interface DescribeWebProtectionLogRequest {
7159
7316
  /**
7160
- * 起始时间
7317
+ * 起始时间。
7161
7318
  */
7162
7319
  StartTime: string
7163
7320
 
7164
7321
  /**
7165
- * 结束时间
7322
+ * 结束时间。
7166
7323
  */
7167
7324
  EndTime: string
7168
7325
 
7169
7326
  /**
7170
- * 每页条数
7327
+ * 分页拉取的最大返回结果数。最大值:1000。
7171
7328
  */
7172
7329
  PageSize: number
7173
7330
 
7174
7331
  /**
7175
- * 当前页
7332
+ * 分页拉取的起始页号。最小值:1。
7176
7333
  */
7177
7334
  PageNo: number
7178
7335
 
7179
7336
  /**
7180
- * 站点集合
7337
+ * 站点集合,不填默认查询所有站点。
7181
7338
  */
7182
7339
  ZoneIds?: Array<string>
7183
7340
 
7184
7341
  /**
7185
- * 域名集合
7342
+ * 域名集合,不填默认查询所有域名。
7186
7343
  */
7187
7344
  Domains?: Array<string>
7188
7345
 
7189
7346
  /**
7190
- * 查询条件
7191
- */
7347
+ * 筛选条件。
7348
+ 限速规则日志中取值有:
7349
+ <li>action :执行动作(处置方式);</li>
7350
+ <li>ruleId :规则id ;</li>
7351
+ <li>oriDomain :被攻击的子域名 ;</li>
7352
+ <li>attackIp :攻击ip 。</li>
7353
+ 自定义规则日志中取值有:
7354
+ <li>action :执行动作(处置方式);</li>
7355
+ <li>ruleId :规则id ;</li>
7356
+ <li>oriDomain :被攻击的子域名 ;</li>
7357
+ <li>attackIp :攻击ip ;</li>
7358
+ <li>eventId :事件id ;</li>
7359
+ <li>ua :用户代理 ;</li>
7360
+ <li>requestMethod :请求方法 ;</li>
7361
+ <li>uri :统一资源标识符 。</li>
7362
+ */
7192
7363
  QueryCondition?: Array<QueryCondition>
7364
+
7365
+ /**
7366
+ * 日志类型,取值有:
7367
+ <li>rate :限速日志 ;</li>
7368
+ <li>acl :自定义规则日志 。</li>不填默认为rate。
7369
+ */
7370
+ EntityType?: string
7193
7371
  }
7194
7372
 
7195
7373
  /**
@@ -7197,33 +7375,29 @@ export interface DescribeWebProtectionLogRequest {
7197
7375
  */
7198
7376
  export interface CCLogData {
7199
7377
  /**
7200
- * CC拦截日志数据集合
7378
+ * CC拦截日志数据集合。
7201
7379
  注意:此字段可能返回 null,表示取不到有效值。
7202
7380
  */
7203
7381
  List: Array<CCLog>
7204
7382
 
7205
7383
  /**
7206
- * 当前页
7207
- 注意:此字段可能返回 null,表示取不到有效值。
7208
- */
7384
+ * 分页拉取的起始页号。最小值:1。
7385
+ */
7209
7386
  PageNo: number
7210
7387
 
7211
7388
  /**
7212
- * 每页展示条数
7213
- 注意:此字段可能返回 null,表示取不到有效值。
7214
- */
7389
+ * 分页拉取的最大返回结果数。最大值:1000。
7390
+ */
7215
7391
  PageSize: number
7216
7392
 
7217
7393
  /**
7218
- * 总页数
7219
- 注意:此字段可能返回 null,表示取不到有效值。
7220
- */
7394
+ * 总页数。
7395
+ */
7221
7396
  Pages: number
7222
7397
 
7223
7398
  /**
7224
- * 总条数
7225
- 注意:此字段可能返回 null,表示取不到有效值。
7226
- */
7399
+ * 总条数。
7400
+ */
7227
7401
  TotalSize: number
7228
7402
  }
7229
7403
 
@@ -7415,17 +7589,19 @@ export interface CnameStatus {
7415
7589
  */
7416
7590
  export interface DescribeDDosMajorAttackEventResponse {
7417
7591
  /**
7418
- * DDos查询主攻击事件
7592
+ * DDos查询主攻击事件。
7419
7593
  */
7420
7594
  Data: DDosMajorAttackEventData
7421
7595
 
7422
7596
  /**
7423
- * 状态,1:失败,0:成功
7424
- */
7597
+ * 请求响应状态,取值有:
7598
+ <li>1 :失败 ;</li>
7599
+ <li>0 :成功 。</li>
7600
+ */
7425
7601
  Status: number
7426
7602
 
7427
7603
  /**
7428
- * 返回消息
7604
+ * 请求响应消息。
7429
7605
  */
7430
7606
  Msg: string
7431
7607
 
@@ -7683,38 +7859,46 @@ export interface DeleteDnsRecordsResponse {
7683
7859
  */
7684
7860
  export interface DescribeBotLogRequest {
7685
7861
  /**
7686
- * 起始时间
7862
+ * 起始时间。
7687
7863
  */
7688
7864
  StartTime: string
7689
7865
 
7690
7866
  /**
7691
- * 结束时间
7867
+ * 结束时间。
7692
7868
  */
7693
7869
  EndTime: string
7694
7870
 
7695
7871
  /**
7696
- * 每页条数
7872
+ * 分页拉取的最大返回结果数。最大值:1000。
7697
7873
  */
7698
7874
  PageSize: number
7699
7875
 
7700
7876
  /**
7701
- * 当前页
7877
+ * 分页拉取的起始页号。最小值:1。
7702
7878
  */
7703
7879
  PageNo: number
7704
7880
 
7705
7881
  /**
7706
- * 站点集合
7882
+ * 站点集合,不填默认查询所有站点。
7707
7883
  */
7708
7884
  ZoneIds?: Array<string>
7709
7885
 
7710
7886
  /**
7711
- * 域名集合
7887
+ * 域名集合,不填默认查询所有子域名。
7712
7888
  */
7713
7889
  Domains?: Array<string>
7714
7890
 
7715
7891
  /**
7716
- * 查询条件
7717
- */
7892
+ * 筛选条件,取值有:
7893
+ <li>action :执行动作(处置方式);</li>
7894
+ <li>sipCountryCode :ip所在国家 ;</li>
7895
+ <li>attackIp :攻击ip ;</li>
7896
+ <li>ruleId :规则id ;</li>
7897
+ <li>eventId :事件id ;</li>
7898
+ <li>ua :用户代理 ;</li>
7899
+ <li>requestMethod :请求方法 ;</li>
7900
+ <li>uri :统一资源标识符 。</li>
7901
+ */
7718
7902
  QueryCondition?: Array<QueryCondition>
7719
7903
  }
7720
7904
 
@@ -7763,42 +7947,45 @@ export interface DownloadL7LogsResponse {
7763
7947
  */
7764
7948
  export interface DDosAttackEventDetailData {
7765
7949
  /**
7766
- * 攻击状态
7767
- */
7950
+ * 攻击状态,取值有:
7951
+ <li>1 :观察中 ;</li>
7952
+ <li>2 :攻击开始 ;</li>
7953
+ <li>3 :攻击结束 。</li>
7954
+ */
7768
7955
  AttackStatus: number
7769
7956
 
7770
7957
  /**
7771
- * 攻击类型
7958
+ * 攻击类型。
7772
7959
  */
7773
7960
  AttackType: string
7774
7961
 
7775
7962
  /**
7776
- * 结束时间
7963
+ * 结束时间。
7777
7964
  */
7778
7965
  EndTime: number
7779
7966
 
7780
7967
  /**
7781
- * 开始时间
7968
+ * 开始时间。
7782
7969
  */
7783
7970
  StartTime: number
7784
7971
 
7785
7972
  /**
7786
- * 最大带宽
7973
+ * 最大带宽。
7787
7974
  */
7788
7975
  MaxBandWidth: number
7789
7976
 
7790
7977
  /**
7791
- * 最大包速率
7978
+ * 最大包速率。
7792
7979
  */
7793
7980
  PacketMaxRate: number
7794
7981
 
7795
7982
  /**
7796
- * 事件Id
7983
+ * 事件Id
7797
7984
  */
7798
7985
  EventId: string
7799
7986
 
7800
7987
  /**
7801
- * ddos 策略组id
7988
+ * ddos 策略组id
7802
7989
  */
7803
7990
  PolicyId: number
7804
7991
  }
@@ -7938,24 +8125,30 @@ export interface DescribeZoneDDoSPolicyRequest {
7938
8125
  */
7939
8126
  export interface DescribeDDosAttackDataResponse {
7940
8127
  /**
7941
- * DDos攻击数据
8128
+ * DDos攻击数据内容。
7942
8129
  注意:此字段可能返回 null,表示取不到有效值。
7943
8130
  */
7944
8131
  Data: Array<SecEntry>
7945
8132
 
7946
8133
  /**
7947
- * 状态,1:失败,0:成功
7948
- */
8134
+ * 请求响应状态,取值有:
8135
+ <li>1 :失败 ;</li>
8136
+ <li>0 :成功 。</li>
8137
+ */
7949
8138
  Status: number
7950
8139
 
7951
8140
  /**
7952
- * 返回数据
8141
+ * 请求响应信息。
7953
8142
  */
7954
8143
  Msg: string
7955
8144
 
7956
8145
  /**
7957
- * 查询时间粒度,可选{min,5min,hour,day}
7958
- */
8146
+ * 查询时间粒度,取值有:
8147
+ <li>min :1分钟 ;</li>
8148
+ <li>5min :5分钟 ;</li>
8149
+ <li>hour :1小时 ;</li>
8150
+ <li>day :1天 。</li>
8151
+ */
7959
8152
  Interval: string
7960
8153
 
7961
8154
  /**
@@ -7969,38 +8162,49 @@ export interface DescribeDDosAttackDataResponse {
7969
8162
  */
7970
8163
  export interface DescribeWebManagedRulesLogRequest {
7971
8164
  /**
7972
- * 起始时间
8165
+ * 起始时间。
7973
8166
  */
7974
8167
  StartTime: string
7975
8168
 
7976
8169
  /**
7977
- * 结束时间
8170
+ * 结束时间。
7978
8171
  */
7979
8172
  EndTime: string
7980
8173
 
7981
8174
  /**
7982
- * 每页条数
8175
+ * 分页拉取的最大返回结果数。最大值:1000。
7983
8176
  */
7984
8177
  PageSize: number
7985
8178
 
7986
8179
  /**
7987
- * 当前页
8180
+ * 分页拉取的起始页号。最小值:1。
7988
8181
  */
7989
8182
  PageNo: number
7990
8183
 
7991
8184
  /**
7992
- * 站点集合
8185
+ * 站点集合,不填默认选择全部站点。
7993
8186
  */
7994
8187
  ZoneIds?: Array<string>
7995
8188
 
7996
8189
  /**
7997
- * 域名集合
8190
+ * 域名集合,不填默认选择全部子域名。
7998
8191
  */
7999
8192
  Domains?: Array<string>
8000
8193
 
8001
8194
  /**
8002
- * 查询条件
8003
- */
8195
+ * 筛选条件,取值有:
8196
+ <li>attackType :攻击类型 ;</li>
8197
+ <li>riskLevel :风险等级 ;</li>
8198
+ <li>action :执行动作(处置方式) ;</li>
8199
+ <li>ruleId :规则id ;</li>
8200
+ <li>sipCountryCode :ip所在国家 ;</li>
8201
+ <li>attackIp :攻击ip ;</li>
8202
+ <li>oriDomain :被攻击的子域名 ;</li>
8203
+ <li>eventId :事件id ;</li>
8204
+ <li>ua :用户代理 ;</li>
8205
+ <li>requestMethod :请求方法 ;</li>
8206
+ <li>uri :统一资源标识符 。</li>
8207
+ */
8004
8208
  QueryCondition?: Array<QueryCondition>
8005
8209
  }
8006
8210
 
@@ -8024,54 +8228,72 @@ export interface CreateApplicationProxyRulesResponse {
8024
8228
  */
8025
8229
  export interface DescribeWebManagedRulesTopDataRequest {
8026
8230
  /**
8027
- * 开始时间
8231
+ * 开始时间。
8028
8232
  */
8029
8233
  StartTime: string
8030
8234
 
8031
8235
  /**
8032
- * 结束时间
8236
+ * 结束时间。
8033
8237
  */
8034
8238
  EndTime: string
8035
8239
 
8036
8240
  /**
8037
- * 过滤指标
8038
- */
8241
+ * 统计指标列表,取值有:
8242
+ <li>waf_requestNum_url :url请求数排行 ;</li>
8243
+ <li>waf_requestNum_cip:客户端ip请求数排行 ;</li>
8244
+ <li>waf_cipRequestNum_region :客户端区域请求数排行 。</li>
8245
+ */
8039
8246
  MetricName: string
8040
8247
 
8041
8248
  /**
8042
- * 查询前多少名,传值为0 全量
8249
+ * 查询前多少个,传值为0返回全量。
8043
8250
  */
8044
8251
  Limit: number
8045
8252
 
8046
8253
  /**
8047
- * 站点集合
8254
+ * 站点id列表,不填默认选择全部站点。
8048
8255
  */
8049
8256
  ZoneIds?: Array<string>
8050
8257
 
8051
8258
  /**
8052
- * ddos策略组id 集合
8259
+ * 该字段已废弃,请勿传。
8053
8260
  */
8054
8261
  PolicyIds?: Array<number>
8055
8262
 
8056
8263
  /**
8057
- * 端口号
8264
+ * 该字段已废弃,请勿传。
8058
8265
  */
8059
8266
  Port?: number
8060
8267
 
8061
8268
  /**
8062
- * 协议类型,tcp,udp,all
8269
+ * 该字段已废弃,请勿传。
8063
8270
  */
8064
8271
  ProtocolType?: string
8065
8272
 
8066
8273
  /**
8067
- * 攻击类型,flood,icmpFlood......,all
8274
+ * 该字段已废弃,请勿传。
8068
8275
  */
8069
8276
  AttackType?: string
8070
8277
 
8071
8278
  /**
8072
- * 域名集合
8279
+ * 域名列表,不填默认选择全部子域名。
8073
8280
  */
8074
8281
  Domains?: Array<string>
8282
+
8283
+ /**
8284
+ * 查询时间粒度,取值有:
8285
+ <li>min :1分钟 ;</li>
8286
+ <li>5min :5分钟 ;</li>
8287
+ <li>hour :1小时 ;</li>
8288
+ <li>day :1天 。</li>
8289
+ */
8290
+ Interval?: string
8291
+
8292
+ /**
8293
+ * 筛选条件,取值有:
8294
+ <li>action :执行动作 。</li>
8295
+ */
8296
+ QueryCondition?: Array<QueryCondition>
8075
8297
  }
8076
8298
 
8077
8299
  /**
@@ -8122,17 +8344,17 @@ export interface DescribeIdentificationResponse {
8122
8344
  */
8123
8345
  export interface DDosMajorAttackEvent {
8124
8346
  /**
8125
- * ddos 策略组id
8347
+ * ddos 策略组id
8126
8348
  */
8127
8349
  PolicyId: number
8128
8350
 
8129
8351
  /**
8130
- * 攻击最大带宽
8352
+ * 攻击最大带宽。
8131
8353
  */
8132
8354
  AttackMaxBandWidth: number
8133
8355
 
8134
8356
  /**
8135
- * 攻击时间 单位为s
8357
+ * 攻击请求时间,采用unix秒级时间戳。
8136
8358
  */
8137
8359
  AttackTime: number
8138
8360
  }
@@ -8159,96 +8381,103 @@ export interface ModifyZoneCnameSpeedUpRequest {
8159
8381
  */
8160
8382
  export interface DescribeApplicationProxyDetailResponse {
8161
8383
  /**
8162
- * 实例ID
8384
+ * 实例ID
8163
8385
  */
8164
8386
  ProxyId: string
8165
8387
 
8166
8388
  /**
8167
- * 代理名称
8168
- 当ProxyType=hostname时,表示域名或者子域名
8169
- 当ProxyType=instance时,表示实例名称
8389
+ * 当ProxyType=hostname时,表示域名或子域名;
8390
+ 当ProxyType=instance时,表示代理名称。
8170
8391
  */
8171
8392
  ProxyName: string
8172
8393
 
8173
8394
  /**
8174
- * 调度模式:
8175
- ip表示Anycast IP
8176
- domain表示CNAME
8395
+ * 调度模式,取值有:
8396
+ <li>ip:表示Anycast IP调度;</li>
8397
+ <li>domain:表示CNAME调度。</li>
8177
8398
  */
8178
8399
  PlatType: string
8179
8400
 
8180
8401
  /**
8181
- * 0关闭安全,1开启安全
8182
- */
8402
+ * 是否开启安全,取值有:
8403
+ <li>0:关闭安全;</li>
8404
+ <li>1:开启安全。</li>
8405
+ */
8183
8406
  SecurityType: number
8184
8407
 
8185
8408
  /**
8186
- * 0关闭加速,1开启加速
8187
- */
8409
+ * 是否开启加速,取值有:
8410
+ <li>0:关闭加速;</li>
8411
+ <li>1:开启加速。</li>
8412
+ */
8188
8413
  AccelerateType: number
8189
8414
 
8190
8415
  /**
8191
- * 字段已经移至Rule.ForwardClientIp
8416
+ * 字段已经废弃。
8192
8417
  */
8193
8418
  ForwardClientIp: string
8194
8419
 
8195
8420
  /**
8196
- * 字段已经移至Rule.SessionPersist
8421
+ * 字段已经废弃。
8197
8422
  */
8198
8423
  SessionPersist: boolean
8199
8424
 
8200
8425
  /**
8201
- * 规则列表
8426
+ * 规则列表。
8202
8427
  */
8203
8428
  Rule: Array<ApplicationProxyRule>
8204
8429
 
8205
8430
  /**
8206
- * 状态:
8207
- online:启用
8208
- offline:停用
8209
- progress:部署中
8431
+ * 状态,取值有:
8432
+ <li>online:启用;</li>
8433
+ <li>offline:停用;</li>
8434
+ <li>progress:部署中。</li>
8210
8435
  */
8211
8436
  Status: string
8212
8437
 
8213
8438
  /**
8214
- * 调度信息
8439
+ * 调度信息。
8215
8440
  */
8216
8441
  ScheduleValue: Array<string>
8217
8442
 
8218
8443
  /**
8219
- * 更新时间
8444
+ * 更新时间。
8220
8445
  */
8221
8446
  UpdateTime: string
8222
8447
 
8223
8448
  /**
8224
- * 站点ID
8449
+ * 站点ID
8225
8450
  */
8226
8451
  ZoneId: string
8227
8452
 
8228
8453
  /**
8229
- * 站点名称
8454
+ * 站点名称。
8230
8455
  */
8231
8456
  ZoneName: string
8232
8457
 
8233
8458
  /**
8234
- * 会话保持时间
8459
+ * 会话保持时间。
8235
8460
  */
8236
8461
  SessionPersistTime: number
8237
8462
 
8238
8463
  /**
8239
- * 服务类型
8240
- hostname:子域名模式
8241
- instance:实例模式
8464
+ * 四层代理模式,取值有:
8465
+ <li>hostname:表示子域名模式;</li>
8466
+ <li>instance:表示实例模式。</li>
8242
8467
  */
8243
8468
  ProxyType: string
8244
8469
 
8245
8470
  /**
8246
8471
  * 当ProxyType=hostname时:
8247
- ProxyName为域名,如:test.123.com
8248
- HostId表示该域名,即test.123.com对应的代理加速唯一标识
8472
+ 表示代理加速唯一标识。
8249
8473
  */
8250
8474
  HostId: string
8251
8475
 
8476
+ /**
8477
+ * IPv6访问配置。
8478
+ */
8479
+ Ipv6: Ipv6Access
8480
+
8252
8481
  /**
8253
8482
  * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
8254
8483
  */
@@ -8301,17 +8530,19 @@ export interface DDoSUserAllowBlockIP {
8301
8530
  */
8302
8531
  export interface DescribeBotLogResponse {
8303
8532
  /**
8304
- * Bot攻击Data
8533
+ * Bot攻击数据内容。
8305
8534
  */
8306
8535
  Data: BotLogData
8307
8536
 
8308
8537
  /**
8309
- * 状态,1:失败,0:成功
8310
- */
8538
+ * 请求响应状态,取值有:
8539
+ <li>1 :失败 ;</li>
8540
+ <li>0 :成功 。</li>
8541
+ */
8311
8542
  Status: number
8312
8543
 
8313
8544
  /**
8314
- * 返回信息
8545
+ * 请求响应信息。
8315
8546
  */
8316
8547
  Msg: string
8317
8548
 
@@ -8346,24 +8577,30 @@ export interface DescribeLoadBalancingResponse {
8346
8577
  */
8347
8578
  export interface DescribeWebProtectionDataResponse {
8348
8579
  /**
8349
- * 数据详情
8580
+ * 数据详情。
8350
8581
  注意:此字段可能返回 null,表示取不到有效值。
8351
8582
  */
8352
8583
  Data: Array<SecEntry>
8353
8584
 
8354
8585
  /**
8355
- * 状态,1:失败,0:成功
8356
- */
8586
+ * 请求响应状态,取值有:
8587
+ <li>1 :失败 ;</li>
8588
+ <li>0 :成功 。</li>
8589
+ */
8357
8590
  Status: number
8358
8591
 
8359
8592
  /**
8360
- * 消息
8593
+ * 请求响应消息。
8361
8594
  */
8362
8595
  Msg: string
8363
8596
 
8364
8597
  /**
8365
- * 查询时间粒度,可选{min,5min,hour,day}
8366
- */
8598
+ * 查询时间粒度,取值有:
8599
+ <li>min :1分钟 ;</li>
8600
+ <li>5min :5分钟 ;</li>
8601
+ <li>hour :1小时 ;</li>
8602
+ <li>day :1天 。</li>
8603
+ */
8367
8604
  Interval: string
8368
8605
 
8369
8606
  /**
@@ -8690,9 +8927,9 @@ both:同时被仅DNS和代理加速类型负载均衡使用
8690
8927
  */
8691
8928
  export interface UpstreamHttp2 {
8692
8929
  /**
8693
- * http2回源配置开关
8694
- on:开启
8695
- off:关闭
8930
+ * http2回源配置开关,取值有:
8931
+ <li>on:开启;</li>
8932
+ <li>off:关闭。</li>
8696
8933
  */
8697
8934
  Switch: string
8698
8935
  }
@@ -8702,7 +8939,9 @@ off:关闭
8702
8939
  */
8703
8940
  export interface OfflineCache {
8704
8941
  /**
8705
- * on | off, 离线缓存是否开启
8942
+ * 离线缓存是否开启,取值有:
8943
+ <li>on:开启;</li>
8944
+ <li>off:关闭。</li>
8706
8945
  注意:此字段可能返回 null,表示取不到有效值。
8707
8946
  */
8708
8947
  Switch: string
@@ -8728,11 +8967,58 @@ export interface DescribeOriginGroupDetailRequest {
8728
8967
  */
8729
8968
  export interface DescribeDDosAttackEventDetailRequest {
8730
8969
  /**
8731
- * 事件id
8970
+ * 事件id
8732
8971
  */
8733
8972
  EventId: string
8734
8973
  }
8735
8974
 
8975
+ /**
8976
+ * 安全规则(cc/waf/bot)相关信息
8977
+ */
8978
+ export interface SecRuleRelatedInfo {
8979
+ /**
8980
+ * 规则ID列表(99999为无效id)。
8981
+ */
8982
+ RuleId: number
8983
+
8984
+ /**
8985
+ * 执行动作(处置方式),取值有:
8986
+ <li>trans :通过 ;</li>
8987
+ <li>alg :算法挑战 ;</li>
8988
+ <li>drop :丢弃 ;</li>
8989
+ <li>ban :封禁源ip ;</li>
8990
+ <li>redirect :重定向 ;</li>
8991
+ <li>page :返回指定页面 ;</li>
8992
+ <li>monitor :观察 。</li>
8993
+ */
8994
+ Action: string
8995
+
8996
+ /**
8997
+ * 风险等级(waf日志中独有),取值有:
8998
+ <li>high risk :高危 ;</li>
8999
+ <li>middle risk :中危 ;</li>
9000
+ <li>low risk :低危 ;</li>
9001
+ <li>unkonw :未知 。</li>
9002
+ */
9003
+ RiskLevel: string
9004
+
9005
+ /**
9006
+ * 规则等级,取值有:
9007
+ <li>normal :正常 。</li>
9008
+ */
9009
+ RuleLevel: string
9010
+
9011
+ /**
9012
+ * 规则描述。
9013
+ */
9014
+ Description: string
9015
+
9016
+ /**
9017
+ * 规则类型名称。
9018
+ */
9019
+ RuleTypeName: string
9020
+ }
9021
+
8736
9022
  /**
8737
9023
  * DescribeTimingL4Data返回参数结构体
8738
9024
  */