@alicloud/cloud-siem20220616 6.0.2 → 6.2.0

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 (538) hide show
  1. package/dist/client.d.ts +210 -168
  2. package/dist/client.js +302 -169
  3. package/dist/client.js.map +1 -1
  4. package/dist/models/AddDataSourceLogRequest.d.ts +14 -11
  5. package/dist/models/AddDataSourceLogRequest.js.map +1 -1
  6. package/dist/models/AddDataSourceLogResponseBody.d.ts +2 -2
  7. package/dist/models/AddDataSourceRequest.d.ts +14 -17
  8. package/dist/models/AddDataSourceRequest.js.map +1 -1
  9. package/dist/models/AddDataSourceResponseBody.d.ts +3 -3
  10. package/dist/models/AddUserSourceLogConfigRequest.d.ts +13 -11
  11. package/dist/models/AddUserSourceLogConfigRequest.js.map +1 -1
  12. package/dist/models/AddUserSourceLogConfigResponseBody.d.ts +10 -10
  13. package/dist/models/BindAccountRequest.d.ts +26 -9
  14. package/dist/models/BindAccountRequest.js.map +1 -1
  15. package/dist/models/BindAccountResponseBody.d.ts +2 -2
  16. package/dist/models/CloseDeliveryRequest.d.ts +56 -31
  17. package/dist/models/CloseDeliveryRequest.js.map +1 -1
  18. package/dist/models/CloseDeliveryResponseBody.d.ts +4 -3
  19. package/dist/models/CloseDeliveryResponseBody.js.map +1 -1
  20. package/dist/models/DeleteAutomateResponseConfigRequest.d.ts +11 -8
  21. package/dist/models/DeleteAutomateResponseConfigRequest.js.map +1 -1
  22. package/dist/models/DeleteAutomateResponseConfigResponseBody.d.ts +6 -5
  23. package/dist/models/DeleteAutomateResponseConfigResponseBody.js.map +1 -1
  24. package/dist/models/DeleteBindAccountRequest.d.ts +29 -8
  25. package/dist/models/DeleteBindAccountRequest.js.map +1 -1
  26. package/dist/models/DeleteBindAccountResponseBody.d.ts +1 -1
  27. package/dist/models/DeleteCustomizeRuleRequest.d.ts +8 -6
  28. package/dist/models/DeleteCustomizeRuleRequest.js.map +1 -1
  29. package/dist/models/DeleteCustomizeRuleResponseBody.d.ts +5 -4
  30. package/dist/models/DeleteCustomizeRuleResponseBody.js.map +1 -1
  31. package/dist/models/DeleteDataSourceRequest.d.ts +12 -9
  32. package/dist/models/DeleteDataSourceRequest.js.map +1 -1
  33. package/dist/models/DeleteDataSourceResponseBody.d.ts +3 -3
  34. package/dist/models/DeleteWhiteRuleListRequest.d.ts +10 -7
  35. package/dist/models/DeleteWhiteRuleListRequest.js.map +1 -1
  36. package/dist/models/DeleteWhiteRuleListResponseBody.d.ts +4 -3
  37. package/dist/models/DeleteWhiteRuleListResponseBody.js.map +1 -1
  38. package/dist/models/DescribeAggregateFunctionRequest.d.ts +9 -6
  39. package/dist/models/DescribeAggregateFunctionRequest.js.map +1 -1
  40. package/dist/models/DescribeAggregateFunctionResponseBody.d.ts +6 -5
  41. package/dist/models/DescribeAggregateFunctionResponseBody.js.map +1 -1
  42. package/dist/models/DescribeAlertSceneByEventRequest.d.ts +11 -8
  43. package/dist/models/DescribeAlertSceneByEventRequest.js.map +1 -1
  44. package/dist/models/DescribeAlertSceneByEventResponseBody.d.ts +16 -15
  45. package/dist/models/DescribeAlertSceneByEventResponseBody.js.map +1 -1
  46. package/dist/models/DescribeAlertSceneRequest.d.ts +10 -7
  47. package/dist/models/DescribeAlertSceneRequest.js.map +1 -1
  48. package/dist/models/DescribeAlertSceneResponseBody.d.ts +12 -11
  49. package/dist/models/DescribeAlertSceneResponseBody.js.map +1 -1
  50. package/dist/models/DescribeAlertSourceRequest.d.ts +18 -13
  51. package/dist/models/DescribeAlertSourceRequest.js.map +1 -1
  52. package/dist/models/DescribeAlertSourceResponseBody.d.ts +12 -7
  53. package/dist/models/DescribeAlertSourceResponseBody.js.map +1 -1
  54. package/dist/models/DescribeAlertSourceWithEventRequest.d.ts +11 -8
  55. package/dist/models/DescribeAlertSourceWithEventRequest.js.map +1 -1
  56. package/dist/models/DescribeAlertSourceWithEventResponseBody.d.ts +5 -4
  57. package/dist/models/DescribeAlertSourceWithEventResponseBody.js.map +1 -1
  58. package/dist/models/DescribeAlertTypeRequest.d.ts +15 -10
  59. package/dist/models/DescribeAlertTypeRequest.js.map +1 -1
  60. package/dist/models/DescribeAlertTypeResponseBody.d.ts +6 -5
  61. package/dist/models/DescribeAlertTypeResponseBody.js.map +1 -1
  62. package/dist/models/DescribeAlertsCountRequest.d.ts +15 -9
  63. package/dist/models/DescribeAlertsCountRequest.js.map +1 -1
  64. package/dist/models/DescribeAlertsCountResponseBody.d.ts +10 -5
  65. package/dist/models/DescribeAlertsCountResponseBody.js.map +1 -1
  66. package/dist/models/DescribeAlertsRequest.d.ts +87 -20
  67. package/dist/models/DescribeAlertsRequest.js.map +1 -1
  68. package/dist/models/DescribeAlertsResponseBody.d.ts +97 -41
  69. package/dist/models/DescribeAlertsResponseBody.js.map +1 -1
  70. package/dist/models/DescribeAlertsWithEntityRequest.d.ts +22 -10
  71. package/dist/models/DescribeAlertsWithEntityRequest.js.map +1 -1
  72. package/dist/models/DescribeAlertsWithEntityResponseBody.d.ts +83 -40
  73. package/dist/models/DescribeAlertsWithEntityResponseBody.js.map +1 -1
  74. package/dist/models/DescribeAlertsWithEventRequest.d.ts +68 -15
  75. package/dist/models/DescribeAlertsWithEventRequest.js.map +1 -1
  76. package/dist/models/DescribeAlertsWithEventResponseBody.d.ts +93 -43
  77. package/dist/models/DescribeAlertsWithEventResponseBody.js.map +1 -1
  78. package/dist/models/DescribeAuthRequest.d.ts +4 -3
  79. package/dist/models/DescribeAuthRequest.js.map +1 -1
  80. package/dist/models/DescribeAuthResponseBody.d.ts +4 -3
  81. package/dist/models/DescribeAuthResponseBody.js.map +1 -1
  82. package/dist/models/DescribeAutomateResponseConfigCounterRequest.d.ts +10 -7
  83. package/dist/models/DescribeAutomateResponseConfigCounterRequest.js.map +1 -1
  84. package/dist/models/DescribeAutomateResponseConfigCounterResponseBody.d.ts +5 -4
  85. package/dist/models/DescribeAutomateResponseConfigCounterResponseBody.js.map +1 -1
  86. package/dist/models/DescribeAutomateResponseConfigFeatureRequest.d.ts +14 -10
  87. package/dist/models/DescribeAutomateResponseConfigFeatureRequest.js.map +1 -1
  88. package/dist/models/DescribeAutomateResponseConfigFeatureResponseBody.d.ts +20 -18
  89. package/dist/models/DescribeAutomateResponseConfigFeatureResponseBody.js.map +1 -1
  90. package/dist/models/DescribeCloudSiemAssetsCounterRequest.d.ts +10 -7
  91. package/dist/models/DescribeCloudSiemAssetsCounterRequest.js.map +1 -1
  92. package/dist/models/DescribeCloudSiemAssetsCounterResponseBody.d.ts +18 -12
  93. package/dist/models/DescribeCloudSiemAssetsCounterResponseBody.js.map +1 -1
  94. package/dist/models/DescribeCloudSiemAssetsRequest.d.ts +30 -16
  95. package/dist/models/DescribeCloudSiemAssetsRequest.js.map +1 -1
  96. package/dist/models/DescribeCloudSiemAssetsResponseBody.d.ts +33 -25
  97. package/dist/models/DescribeCloudSiemAssetsResponseBody.js.map +1 -1
  98. package/dist/models/DescribeCloudSiemEventDetailRequest.d.ts +10 -7
  99. package/dist/models/DescribeCloudSiemEventDetailRequest.js.map +1 -1
  100. package/dist/models/DescribeCloudSiemEventDetailResponseBody.d.ts +74 -21
  101. package/dist/models/DescribeCloudSiemEventDetailResponseBody.js.map +1 -1
  102. package/dist/models/DescribeCloudSiemEventsRequest.d.ts +38 -25
  103. package/dist/models/DescribeCloudSiemEventsRequest.js.map +1 -1
  104. package/dist/models/DescribeCloudSiemEventsResponseBody.d.ts +74 -25
  105. package/dist/models/DescribeCloudSiemEventsResponseBody.js.map +1 -1
  106. package/dist/models/DescribeCustomizeRuleCountRequest.d.ts +10 -7
  107. package/dist/models/DescribeCustomizeRuleCountRequest.js.map +1 -1
  108. package/dist/models/DescribeCustomizeRuleCountResponseBody.d.ts +17 -16
  109. package/dist/models/DescribeCustomizeRuleCountResponseBody.js.map +1 -1
  110. package/dist/models/DescribeCustomizeRuleTestHistogramRequest.d.ts +11 -8
  111. package/dist/models/DescribeCustomizeRuleTestHistogramRequest.js.map +1 -1
  112. package/dist/models/DescribeCustomizeRuleTestHistogramResponseBody.d.ts +9 -8
  113. package/dist/models/DescribeCustomizeRuleTestHistogramResponseBody.js.map +1 -1
  114. package/dist/models/DescribeCustomizeRuleTestRequest.d.ts +11 -8
  115. package/dist/models/DescribeCustomizeRuleTestRequest.js.map +1 -1
  116. package/dist/models/DescribeCustomizeRuleTestResponseBody.d.ts +15 -10
  117. package/dist/models/DescribeCustomizeRuleTestResponseBody.js.map +1 -1
  118. package/dist/models/DescribeDataSourceInstanceRequest.d.ts +12 -9
  119. package/dist/models/DescribeDataSourceInstanceRequest.js.map +1 -1
  120. package/dist/models/DescribeDataSourceInstanceResponseBody.d.ts +12 -10
  121. package/dist/models/DescribeDataSourceInstanceResponseBody.js.map +1 -1
  122. package/dist/models/DescribeDataSourceParametersRequest.d.ts +10 -13
  123. package/dist/models/DescribeDataSourceParametersRequest.js.map +1 -1
  124. package/dist/models/DescribeDataSourceParametersResponseBody.d.ts +34 -26
  125. package/dist/models/DescribeDataSourceParametersResponseBody.js.map +1 -1
  126. package/dist/models/DescribeDisposeAndPlaybookRequest.d.ts +17 -15
  127. package/dist/models/DescribeDisposeAndPlaybookRequest.js.map +1 -1
  128. package/dist/models/DescribeDisposeAndPlaybookResponseBody.d.ts +61 -25
  129. package/dist/models/DescribeDisposeAndPlaybookResponseBody.js +4 -0
  130. package/dist/models/DescribeDisposeAndPlaybookResponseBody.js.map +1 -1
  131. package/dist/models/DescribeDisposeStrategyPlaybookRequest.d.ts +12 -9
  132. package/dist/models/DescribeDisposeStrategyPlaybookRequest.js.map +1 -1
  133. package/dist/models/DescribeDisposeStrategyPlaybookResponseBody.d.ts +5 -4
  134. package/dist/models/DescribeDisposeStrategyPlaybookResponseBody.js.map +1 -1
  135. package/dist/models/DescribeEntityInfoRequest.d.ts +13 -10
  136. package/dist/models/DescribeEntityInfoRequest.js.map +1 -1
  137. package/dist/models/DescribeEntityInfoResponseBody.d.ts +18 -12
  138. package/dist/models/DescribeEntityInfoResponseBody.js.map +1 -1
  139. package/dist/models/DescribeEventCountByThreatLevelRequest.d.ts +11 -9
  140. package/dist/models/DescribeEventCountByThreatLevelRequest.js.map +1 -1
  141. package/dist/models/DescribeEventCountByThreatLevelResponseBody.d.ts +52 -12
  142. package/dist/models/DescribeEventCountByThreatLevelResponseBody.js.map +1 -1
  143. package/dist/models/DescribeEventDisposeRequest.d.ts +13 -10
  144. package/dist/models/DescribeEventDisposeRequest.js.map +1 -1
  145. package/dist/models/DescribeEventDisposeResponseBody.d.ts +28 -22
  146. package/dist/models/DescribeEventDisposeResponseBody.js.map +1 -1
  147. package/dist/models/DescribeImportedLogCountRequest.d.ts +22 -3
  148. package/dist/models/DescribeImportedLogCountRequest.js.map +1 -1
  149. package/dist/models/DescribeImportedLogCountResponseBody.d.ts +4 -4
  150. package/dist/models/DescribeLogFieldsRequest.d.ts +12 -9
  151. package/dist/models/DescribeLogFieldsRequest.js.map +1 -1
  152. package/dist/models/DescribeLogFieldsResponseBody.d.ts +11 -9
  153. package/dist/models/DescribeLogFieldsResponseBody.js.map +1 -1
  154. package/dist/models/DescribeLogSourceRequest.d.ts +10 -7
  155. package/dist/models/DescribeLogSourceRequest.js.map +1 -1
  156. package/dist/models/DescribeLogSourceResponseBody.d.ts +6 -5
  157. package/dist/models/DescribeLogSourceResponseBody.js.map +1 -1
  158. package/dist/models/DescribeLogTypeRequest.d.ts +9 -6
  159. package/dist/models/DescribeLogTypeRequest.js.map +1 -1
  160. package/dist/models/DescribeLogTypeResponseBody.d.ts +7 -6
  161. package/dist/models/DescribeLogTypeResponseBody.js.map +1 -1
  162. package/dist/models/DescribeOperatorsRequest.d.ts +14 -10
  163. package/dist/models/DescribeOperatorsRequest.js.map +1 -1
  164. package/dist/models/DescribeOperatorsResponseBody.d.ts +10 -9
  165. package/dist/models/DescribeOperatorsResponseBody.js.map +1 -1
  166. package/dist/models/DescribeProdCountRequest.d.ts +22 -3
  167. package/dist/models/DescribeProdCountRequest.js.map +1 -1
  168. package/dist/models/DescribeProdCountResponseBody.d.ts +35 -4
  169. package/dist/models/DescribeProdCountResponseBody.js.map +1 -1
  170. package/dist/models/DescribeScopeUsersRequest.d.ts +10 -7
  171. package/dist/models/DescribeScopeUsersRequest.js.map +1 -1
  172. package/dist/models/DescribeScopeUsersResponseBody.d.ts +13 -10
  173. package/dist/models/DescribeScopeUsersResponseBody.js.map +1 -1
  174. package/dist/models/DescribeServiceStatusRequest.d.ts +4 -3
  175. package/dist/models/DescribeServiceStatusRequest.js.map +1 -1
  176. package/dist/models/DescribeServiceStatusResponseBody.d.ts +4 -3
  177. package/dist/models/DescribeServiceStatusResponseBody.js.map +1 -1
  178. package/dist/models/DescribeStorageRequest.d.ts +10 -7
  179. package/dist/models/DescribeStorageRequest.js.map +1 -1
  180. package/dist/models/DescribeStorageResponseBody.d.ts +4 -3
  181. package/dist/models/DescribeStorageResponseBody.js.map +1 -1
  182. package/dist/models/DescribeUserBuyStatusRequest.d.ts +4 -3
  183. package/dist/models/DescribeUserBuyStatusRequest.js.map +1 -1
  184. package/dist/models/DescribeUserBuyStatusResponseBody.d.ts +23 -15
  185. package/dist/models/DescribeUserBuyStatusResponseBody.js.map +1 -1
  186. package/dist/models/DescribeWafScopeRequest.d.ts +11 -8
  187. package/dist/models/DescribeWafScopeRequest.js.map +1 -1
  188. package/dist/models/DescribeWafScopeResponseBody.d.ts +7 -6
  189. package/dist/models/DescribeWafScopeResponseBody.js.map +1 -1
  190. package/dist/models/DescribeWhiteRuleListRequest.d.ts +15 -12
  191. package/dist/models/DescribeWhiteRuleListRequest.js.map +1 -1
  192. package/dist/models/DescribeWhiteRuleListResponseBody.d.ts +55 -44
  193. package/dist/models/DescribeWhiteRuleListResponseBody.js.map +1 -1
  194. package/dist/models/EnableAccessForCloudSiemRequest.d.ts +11 -10
  195. package/dist/models/EnableAccessForCloudSiemRequest.js.map +1 -1
  196. package/dist/models/EnableAccessForCloudSiemResponseBody.d.ts +2 -2
  197. package/dist/models/EnableServiceForCloudSiemRequest.d.ts +4 -3
  198. package/dist/models/EnableServiceForCloudSiemRequest.js.map +1 -1
  199. package/dist/models/EnableServiceForCloudSiemResponseBody.d.ts +4 -3
  200. package/dist/models/EnableServiceForCloudSiemResponseBody.js.map +1 -1
  201. package/dist/models/GetCapacityRequest.d.ts +10 -7
  202. package/dist/models/GetCapacityRequest.js.map +1 -1
  203. package/dist/models/GetCapacityResponseBody.d.ts +14 -7
  204. package/dist/models/GetCapacityResponseBody.js.map +1 -1
  205. package/dist/models/GetDataStorageRequest.d.ts +41 -0
  206. package/dist/models/GetDataStorageRequest.js +62 -0
  207. package/dist/models/GetDataStorageRequest.js.map +1 -0
  208. package/dist/models/GetDataStorageResponse.d.ts +19 -0
  209. package/dist/models/GetDataStorageResponse.js +69 -0
  210. package/dist/models/GetDataStorageResponse.js.map +1 -0
  211. package/dist/models/GetDataStorageResponseBody.d.ts +314 -0
  212. package/dist/models/GetDataStorageResponseBody.js +203 -0
  213. package/dist/models/GetDataStorageResponseBody.js.map +1 -0
  214. package/dist/models/GetEntitiyStatRequest.d.ts +122 -0
  215. package/dist/models/GetEntitiyStatRequest.js +80 -0
  216. package/dist/models/GetEntitiyStatRequest.js.map +1 -0
  217. package/dist/models/GetEntitiyStatResponse.d.ts +19 -0
  218. package/dist/models/GetEntitiyStatResponse.js +69 -0
  219. package/dist/models/GetEntitiyStatResponse.js.map +1 -0
  220. package/dist/models/GetEntitiyStatResponseBody.d.ts +92 -0
  221. package/dist/models/GetEntitiyStatResponseBody.js +92 -0
  222. package/dist/models/GetEntitiyStatResponseBody.js.map +1 -0
  223. package/dist/models/GetStorageRequest.d.ts +9 -6
  224. package/dist/models/GetStorageRequest.js.map +1 -1
  225. package/dist/models/GetStorageResponseBody.d.ts +13 -11
  226. package/dist/models/GetStorageResponseBody.js.map +1 -1
  227. package/dist/models/ListAccountAccessIdRequest.d.ts +12 -14
  228. package/dist/models/ListAccountAccessIdRequest.js.map +1 -1
  229. package/dist/models/ListAccountAccessIdResponseBody.d.ts +14 -12
  230. package/dist/models/ListAccountAccessIdResponseBody.js.map +1 -1
  231. package/dist/models/ListAccountsByLogRequest.d.ts +13 -10
  232. package/dist/models/ListAccountsByLogRequest.js.map +1 -1
  233. package/dist/models/ListAccountsByLogResponseBody.d.ts +10 -8
  234. package/dist/models/ListAccountsByLogResponseBody.js.map +1 -1
  235. package/dist/models/ListAllProdsRequest.d.ts +9 -7
  236. package/dist/models/ListAllProdsRequest.js.map +1 -1
  237. package/dist/models/ListAllProdsResponseBody.d.ts +12 -10
  238. package/dist/models/ListAllProdsResponseBody.js.map +1 -1
  239. package/dist/models/ListAutomateResponseConfigsRequest.d.ts +36 -18
  240. package/dist/models/ListAutomateResponseConfigsRequest.js.map +1 -1
  241. package/dist/models/ListAutomateResponseConfigsResponseBody.d.ts +37 -24
  242. package/dist/models/ListAutomateResponseConfigsResponseBody.js.map +1 -1
  243. package/dist/models/ListBindAccountRequest.d.ts +27 -6
  244. package/dist/models/ListBindAccountRequest.js.map +1 -1
  245. package/dist/models/ListBindAccountResponseBody.d.ts +13 -11
  246. package/dist/models/ListBindAccountResponseBody.js.map +1 -1
  247. package/dist/models/ListBindDataSourcesRequest.d.ts +6 -11
  248. package/dist/models/ListBindDataSourcesRequest.js.map +1 -1
  249. package/dist/models/ListBindDataSourcesResponseBody.d.ts +17 -13
  250. package/dist/models/ListBindDataSourcesResponseBody.js.map +1 -1
  251. package/dist/models/ListCloudSiemCustomizeRulesRequest.d.ts +39 -28
  252. package/dist/models/ListCloudSiemCustomizeRulesRequest.js.map +1 -1
  253. package/dist/models/ListCloudSiemCustomizeRulesResponseBody.d.ts +49 -37
  254. package/dist/models/ListCloudSiemCustomizeRulesResponseBody.js.map +1 -1
  255. package/dist/models/ListCloudSiemPredefinedRulesRequest.d.ts +51 -38
  256. package/dist/models/ListCloudSiemPredefinedRulesRequest.js.map +1 -1
  257. package/dist/models/ListCloudSiemPredefinedRulesResponseBody.d.ts +29 -23
  258. package/dist/models/ListCloudSiemPredefinedRulesResponseBody.js.map +1 -1
  259. package/dist/models/ListCustomizeRuleTestResultRequest.d.ts +45 -10
  260. package/dist/models/ListCustomizeRuleTestResultRequest.js.map +1 -1
  261. package/dist/models/ListCustomizeRuleTestResultResponseBody.d.ts +45 -23
  262. package/dist/models/ListCustomizeRuleTestResultResponseBody.js.map +1 -1
  263. package/dist/models/ListDataSourceLogsRequest.d.ts +12 -9
  264. package/dist/models/ListDataSourceLogsRequest.js.map +1 -1
  265. package/dist/models/ListDataSourceLogsResponseBody.d.ts +20 -17
  266. package/dist/models/ListDataSourceLogsResponseBody.js.map +1 -1
  267. package/dist/models/ListDataSourceTypesRequest.d.ts +5 -9
  268. package/dist/models/ListDataSourceTypesRequest.js.map +1 -1
  269. package/dist/models/ListDataSourceTypesResponseBody.d.ts +7 -5
  270. package/dist/models/ListDataSourceTypesResponseBody.js.map +1 -1
  271. package/dist/models/ListDeliveryRequest.d.ts +10 -7
  272. package/dist/models/ListDeliveryRequest.js.map +1 -1
  273. package/dist/models/ListDeliveryResponseBody.d.ts +76 -51
  274. package/dist/models/ListDeliveryResponseBody.js.map +1 -1
  275. package/dist/models/ListDisposeStrategyRequest.d.ts +63 -36
  276. package/dist/models/ListDisposeStrategyRequest.js.map +1 -1
  277. package/dist/models/ListDisposeStrategyResponseBody.d.ts +66 -48
  278. package/dist/models/ListDisposeStrategyResponseBody.js.map +1 -1
  279. package/dist/models/ListEntitiesRequest.d.ts +62 -0
  280. package/dist/models/ListEntitiesRequest.js.map +1 -1
  281. package/dist/models/ListEntitiesResponseBody.d.ts +170 -0
  282. package/dist/models/ListEntitiesResponseBody.js +6 -0
  283. package/dist/models/ListEntitiesResponseBody.js.map +1 -1
  284. package/dist/models/ListImportedLogsByProdRequest.d.ts +17 -12
  285. package/dist/models/ListImportedLogsByProdRequest.js.map +1 -1
  286. package/dist/models/ListImportedLogsByProdResponseBody.d.ts +25 -20
  287. package/dist/models/ListImportedLogsByProdResponseBody.js.map +1 -1
  288. package/dist/models/ListProjectLogStoresRequest.d.ts +7 -6
  289. package/dist/models/ListProjectLogStoresRequest.js.map +1 -1
  290. package/dist/models/ListProjectLogStoresResponseBody.d.ts +8 -8
  291. package/dist/models/ListRdUsersRequest.d.ts +4 -3
  292. package/dist/models/ListRdUsersRequest.js.map +1 -1
  293. package/dist/models/ListRdUsersResponseBody.d.ts +9 -8
  294. package/dist/models/ListRdUsersResponseBody.js.map +1 -1
  295. package/dist/models/ModifyBindAccountRequest.d.ts +27 -8
  296. package/dist/models/ModifyBindAccountRequest.js.map +1 -1
  297. package/dist/models/ModifyBindAccountResponseBody.d.ts +3 -3
  298. package/dist/models/ModifyDataSourceLogRequest.d.ts +21 -15
  299. package/dist/models/ModifyDataSourceLogRequest.js.map +1 -1
  300. package/dist/models/ModifyDataSourceLogResponseBody.d.ts +3 -3
  301. package/dist/models/ModifyDataSourceRequest.d.ts +18 -13
  302. package/dist/models/ModifyDataSourceRequest.js.map +1 -1
  303. package/dist/models/ModifyDataSourceResponseBody.d.ts +3 -3
  304. package/dist/models/OpenDeliveryRequest.d.ts +55 -30
  305. package/dist/models/OpenDeliveryRequest.js.map +1 -1
  306. package/dist/models/OpenDeliveryResponseBody.d.ts +4 -3
  307. package/dist/models/OpenDeliveryResponseBody.js.map +1 -1
  308. package/dist/models/PostAutomateResponseConfigRequest.d.ts +23 -17
  309. package/dist/models/PostAutomateResponseConfigRequest.js.map +1 -1
  310. package/dist/models/PostAutomateResponseConfigResponseBody.d.ts +6 -5
  311. package/dist/models/PostAutomateResponseConfigResponseBody.js.map +1 -1
  312. package/dist/models/PostCustomizeRuleRequest.d.ts +36 -28
  313. package/dist/models/PostCustomizeRuleRequest.js.map +1 -1
  314. package/dist/models/PostCustomizeRuleResponseBody.d.ts +44 -33
  315. package/dist/models/PostCustomizeRuleResponseBody.js.map +1 -1
  316. package/dist/models/PostCustomizeRuleTestRequest.d.ts +15 -11
  317. package/dist/models/PostCustomizeRuleTestRequest.js.map +1 -1
  318. package/dist/models/PostCustomizeRuleTestResponseBody.d.ts +6 -5
  319. package/dist/models/PostCustomizeRuleTestResponseBody.js.map +1 -1
  320. package/dist/models/PostEventDisposeAndWhiteruleListRequest.d.ts +52 -16
  321. package/dist/models/PostEventDisposeAndWhiteruleListRequest.js.map +1 -1
  322. package/dist/models/PostEventDisposeAndWhiteruleListResponseBody.d.ts +7 -6
  323. package/dist/models/PostEventDisposeAndWhiteruleListResponseBody.js.map +1 -1
  324. package/dist/models/PostEventWhiteruleListRequest.d.ts +12 -9
  325. package/dist/models/PostEventWhiteruleListRequest.js.map +1 -1
  326. package/dist/models/PostEventWhiteruleListResponseBody.d.ts +4 -3
  327. package/dist/models/PostEventWhiteruleListResponseBody.js.map +1 -1
  328. package/dist/models/PostFinishCustomizeRuleTestRequest.d.ts +11 -8
  329. package/dist/models/PostFinishCustomizeRuleTestRequest.js.map +1 -1
  330. package/dist/models/PostFinishCustomizeRuleTestResponseBody.d.ts +6 -5
  331. package/dist/models/PostFinishCustomizeRuleTestResponseBody.js.map +1 -1
  332. package/dist/models/PostRuleStatusChangeRequest.d.ts +18 -13
  333. package/dist/models/PostRuleStatusChangeRequest.js.map +1 -1
  334. package/dist/models/PostRuleStatusChangeResponseBody.d.ts +6 -5
  335. package/dist/models/PostRuleStatusChangeResponseBody.js.map +1 -1
  336. package/dist/models/RestoreCapacityRequest.d.ts +10 -7
  337. package/dist/models/RestoreCapacityRequest.js.map +1 -1
  338. package/dist/models/RestoreCapacityResponseBody.d.ts +5 -4
  339. package/dist/models/RestoreCapacityResponseBody.js.map +1 -1
  340. package/dist/models/SetStorageRequest.d.ts +14 -11
  341. package/dist/models/SetStorageRequest.js.map +1 -1
  342. package/dist/models/SetStorageResponseBody.d.ts +4 -3
  343. package/dist/models/SetStorageResponseBody.js.map +1 -1
  344. package/dist/models/SubmitImportLogTasksRequest.d.ts +25 -24
  345. package/dist/models/SubmitImportLogTasksRequest.js.map +1 -1
  346. package/dist/models/SubmitImportLogTasksResponseBody.d.ts +1 -1
  347. package/dist/models/UpdateAutomateResponseConfigStatusRequest.d.ts +15 -11
  348. package/dist/models/UpdateAutomateResponseConfigStatusRequest.js.map +1 -1
  349. package/dist/models/UpdateAutomateResponseConfigStatusResponseBody.d.ts +6 -5
  350. package/dist/models/UpdateAutomateResponseConfigStatusResponseBody.js.map +1 -1
  351. package/dist/models/UpdateWhiteRuleListRequest.d.ts +24 -5
  352. package/dist/models/UpdateWhiteRuleListRequest.js.map +1 -1
  353. package/dist/models/UpdateWhiteRuleListResponseBody.d.ts +6 -5
  354. package/dist/models/UpdateWhiteRuleListResponseBody.js.map +1 -1
  355. package/dist/models/model.d.ts +11 -0
  356. package/dist/models/model.js +29 -7
  357. package/dist/models/model.js.map +1 -1
  358. package/package.json +1 -1
  359. package/src/client.ts +321 -169
  360. package/src/models/AddDataSourceLogRequest.ts +14 -11
  361. package/src/models/AddDataSourceLogResponseBody.ts +2 -2
  362. package/src/models/AddDataSourceRequest.ts +14 -17
  363. package/src/models/AddDataSourceResponseBody.ts +3 -3
  364. package/src/models/AddUserSourceLogConfigRequest.ts +13 -11
  365. package/src/models/AddUserSourceLogConfigResponseBody.ts +10 -10
  366. package/src/models/BindAccountRequest.ts +26 -9
  367. package/src/models/BindAccountResponseBody.ts +2 -2
  368. package/src/models/CloseDeliveryRequest.ts +56 -31
  369. package/src/models/CloseDeliveryResponseBody.ts +4 -3
  370. package/src/models/DeleteAutomateResponseConfigRequest.ts +11 -8
  371. package/src/models/DeleteAutomateResponseConfigResponseBody.ts +6 -5
  372. package/src/models/DeleteBindAccountRequest.ts +29 -8
  373. package/src/models/DeleteBindAccountResponseBody.ts +1 -1
  374. package/src/models/DeleteCustomizeRuleRequest.ts +8 -6
  375. package/src/models/DeleteCustomizeRuleResponseBody.ts +5 -4
  376. package/src/models/DeleteDataSourceRequest.ts +12 -9
  377. package/src/models/DeleteDataSourceResponseBody.ts +3 -3
  378. package/src/models/DeleteWhiteRuleListRequest.ts +10 -7
  379. package/src/models/DeleteWhiteRuleListResponseBody.ts +4 -3
  380. package/src/models/DescribeAggregateFunctionRequest.ts +9 -6
  381. package/src/models/DescribeAggregateFunctionResponseBody.ts +6 -5
  382. package/src/models/DescribeAlertSceneByEventRequest.ts +11 -8
  383. package/src/models/DescribeAlertSceneByEventResponseBody.ts +16 -15
  384. package/src/models/DescribeAlertSceneRequest.ts +10 -7
  385. package/src/models/DescribeAlertSceneResponseBody.ts +12 -11
  386. package/src/models/DescribeAlertSourceRequest.ts +18 -13
  387. package/src/models/DescribeAlertSourceResponseBody.ts +12 -7
  388. package/src/models/DescribeAlertSourceWithEventRequest.ts +11 -8
  389. package/src/models/DescribeAlertSourceWithEventResponseBody.ts +5 -4
  390. package/src/models/DescribeAlertTypeRequest.ts +15 -10
  391. package/src/models/DescribeAlertTypeResponseBody.ts +6 -5
  392. package/src/models/DescribeAlertsCountRequest.ts +15 -9
  393. package/src/models/DescribeAlertsCountResponseBody.ts +10 -5
  394. package/src/models/DescribeAlertsRequest.ts +87 -20
  395. package/src/models/DescribeAlertsResponseBody.ts +97 -41
  396. package/src/models/DescribeAlertsWithEntityRequest.ts +22 -10
  397. package/src/models/DescribeAlertsWithEntityResponseBody.ts +83 -40
  398. package/src/models/DescribeAlertsWithEventRequest.ts +68 -15
  399. package/src/models/DescribeAlertsWithEventResponseBody.ts +93 -43
  400. package/src/models/DescribeAuthRequest.ts +4 -3
  401. package/src/models/DescribeAuthResponseBody.ts +4 -3
  402. package/src/models/DescribeAutomateResponseConfigCounterRequest.ts +10 -7
  403. package/src/models/DescribeAutomateResponseConfigCounterResponseBody.ts +5 -4
  404. package/src/models/DescribeAutomateResponseConfigFeatureRequest.ts +14 -10
  405. package/src/models/DescribeAutomateResponseConfigFeatureResponseBody.ts +20 -18
  406. package/src/models/DescribeCloudSiemAssetsCounterRequest.ts +10 -7
  407. package/src/models/DescribeCloudSiemAssetsCounterResponseBody.ts +18 -12
  408. package/src/models/DescribeCloudSiemAssetsRequest.ts +30 -16
  409. package/src/models/DescribeCloudSiemAssetsResponseBody.ts +33 -25
  410. package/src/models/DescribeCloudSiemEventDetailRequest.ts +10 -7
  411. package/src/models/DescribeCloudSiemEventDetailResponseBody.ts +74 -21
  412. package/src/models/DescribeCloudSiemEventsRequest.ts +38 -25
  413. package/src/models/DescribeCloudSiemEventsResponseBody.ts +74 -25
  414. package/src/models/DescribeCustomizeRuleCountRequest.ts +10 -7
  415. package/src/models/DescribeCustomizeRuleCountResponseBody.ts +17 -16
  416. package/src/models/DescribeCustomizeRuleTestHistogramRequest.ts +11 -8
  417. package/src/models/DescribeCustomizeRuleTestHistogramResponseBody.ts +9 -8
  418. package/src/models/DescribeCustomizeRuleTestRequest.ts +11 -8
  419. package/src/models/DescribeCustomizeRuleTestResponseBody.ts +15 -10
  420. package/src/models/DescribeDataSourceInstanceRequest.ts +12 -9
  421. package/src/models/DescribeDataSourceInstanceResponseBody.ts +12 -10
  422. package/src/models/DescribeDataSourceParametersRequest.ts +10 -13
  423. package/src/models/DescribeDataSourceParametersResponseBody.ts +34 -26
  424. package/src/models/DescribeDisposeAndPlaybookRequest.ts +17 -15
  425. package/src/models/DescribeDisposeAndPlaybookResponseBody.ts +65 -25
  426. package/src/models/DescribeDisposeStrategyPlaybookRequest.ts +12 -9
  427. package/src/models/DescribeDisposeStrategyPlaybookResponseBody.ts +5 -4
  428. package/src/models/DescribeEntityInfoRequest.ts +13 -10
  429. package/src/models/DescribeEntityInfoResponseBody.ts +18 -12
  430. package/src/models/DescribeEventCountByThreatLevelRequest.ts +11 -9
  431. package/src/models/DescribeEventCountByThreatLevelResponseBody.ts +52 -12
  432. package/src/models/DescribeEventDisposeRequest.ts +13 -10
  433. package/src/models/DescribeEventDisposeResponseBody.ts +28 -22
  434. package/src/models/DescribeImportedLogCountRequest.ts +22 -3
  435. package/src/models/DescribeImportedLogCountResponseBody.ts +4 -4
  436. package/src/models/DescribeLogFieldsRequest.ts +12 -9
  437. package/src/models/DescribeLogFieldsResponseBody.ts +11 -9
  438. package/src/models/DescribeLogSourceRequest.ts +10 -7
  439. package/src/models/DescribeLogSourceResponseBody.ts +6 -5
  440. package/src/models/DescribeLogTypeRequest.ts +9 -6
  441. package/src/models/DescribeLogTypeResponseBody.ts +7 -6
  442. package/src/models/DescribeOperatorsRequest.ts +14 -10
  443. package/src/models/DescribeOperatorsResponseBody.ts +10 -9
  444. package/src/models/DescribeProdCountRequest.ts +22 -3
  445. package/src/models/DescribeProdCountResponseBody.ts +35 -4
  446. package/src/models/DescribeScopeUsersRequest.ts +10 -7
  447. package/src/models/DescribeScopeUsersResponseBody.ts +13 -10
  448. package/src/models/DescribeServiceStatusRequest.ts +4 -3
  449. package/src/models/DescribeServiceStatusResponseBody.ts +4 -3
  450. package/src/models/DescribeStorageRequest.ts +10 -7
  451. package/src/models/DescribeStorageResponseBody.ts +4 -3
  452. package/src/models/DescribeUserBuyStatusRequest.ts +4 -3
  453. package/src/models/DescribeUserBuyStatusResponseBody.ts +23 -15
  454. package/src/models/DescribeWafScopeRequest.ts +11 -8
  455. package/src/models/DescribeWafScopeResponseBody.ts +7 -6
  456. package/src/models/DescribeWhiteRuleListRequest.ts +15 -12
  457. package/src/models/DescribeWhiteRuleListResponseBody.ts +55 -44
  458. package/src/models/EnableAccessForCloudSiemRequest.ts +11 -10
  459. package/src/models/EnableAccessForCloudSiemResponseBody.ts +2 -2
  460. package/src/models/EnableServiceForCloudSiemRequest.ts +4 -3
  461. package/src/models/EnableServiceForCloudSiemResponseBody.ts +4 -3
  462. package/src/models/GetCapacityRequest.ts +10 -7
  463. package/src/models/GetCapacityResponseBody.ts +14 -7
  464. package/src/models/GetDataStorageRequest.ts +58 -0
  465. package/src/models/GetDataStorageResponse.ts +40 -0
  466. package/src/models/GetDataStorageResponseBody.ts +436 -0
  467. package/src/models/GetEntitiyStatRequest.ts +157 -0
  468. package/src/models/GetEntitiyStatResponse.ts +40 -0
  469. package/src/models/GetEntitiyStatResponseBody.ts +130 -0
  470. package/src/models/GetStorageRequest.ts +9 -6
  471. package/src/models/GetStorageResponseBody.ts +13 -11
  472. package/src/models/ListAccountAccessIdRequest.ts +12 -14
  473. package/src/models/ListAccountAccessIdResponseBody.ts +14 -12
  474. package/src/models/ListAccountsByLogRequest.ts +13 -10
  475. package/src/models/ListAccountsByLogResponseBody.ts +10 -8
  476. package/src/models/ListAllProdsRequest.ts +9 -7
  477. package/src/models/ListAllProdsResponseBody.ts +12 -10
  478. package/src/models/ListAutomateResponseConfigsRequest.ts +36 -18
  479. package/src/models/ListAutomateResponseConfigsResponseBody.ts +37 -24
  480. package/src/models/ListBindAccountRequest.ts +27 -6
  481. package/src/models/ListBindAccountResponseBody.ts +13 -11
  482. package/src/models/ListBindDataSourcesRequest.ts +6 -11
  483. package/src/models/ListBindDataSourcesResponseBody.ts +17 -13
  484. package/src/models/ListCloudSiemCustomizeRulesRequest.ts +39 -28
  485. package/src/models/ListCloudSiemCustomizeRulesResponseBody.ts +49 -37
  486. package/src/models/ListCloudSiemPredefinedRulesRequest.ts +51 -38
  487. package/src/models/ListCloudSiemPredefinedRulesResponseBody.ts +29 -23
  488. package/src/models/ListCustomizeRuleTestResultRequest.ts +45 -10
  489. package/src/models/ListCustomizeRuleTestResultResponseBody.ts +45 -23
  490. package/src/models/ListDataSourceLogsRequest.ts +12 -9
  491. package/src/models/ListDataSourceLogsResponseBody.ts +20 -17
  492. package/src/models/ListDataSourceTypesRequest.ts +5 -9
  493. package/src/models/ListDataSourceTypesResponseBody.ts +7 -5
  494. package/src/models/ListDeliveryRequest.ts +10 -7
  495. package/src/models/ListDeliveryResponseBody.ts +76 -51
  496. package/src/models/ListDisposeStrategyRequest.ts +63 -36
  497. package/src/models/ListDisposeStrategyResponseBody.ts +66 -48
  498. package/src/models/ListEntitiesRequest.ts +62 -0
  499. package/src/models/ListEntitiesResponseBody.ts +176 -0
  500. package/src/models/ListImportedLogsByProdRequest.ts +17 -12
  501. package/src/models/ListImportedLogsByProdResponseBody.ts +25 -20
  502. package/src/models/ListProjectLogStoresRequest.ts +7 -6
  503. package/src/models/ListProjectLogStoresResponseBody.ts +8 -8
  504. package/src/models/ListRdUsersRequest.ts +4 -3
  505. package/src/models/ListRdUsersResponseBody.ts +9 -8
  506. package/src/models/ModifyBindAccountRequest.ts +27 -8
  507. package/src/models/ModifyBindAccountResponseBody.ts +3 -3
  508. package/src/models/ModifyDataSourceLogRequest.ts +21 -15
  509. package/src/models/ModifyDataSourceLogResponseBody.ts +3 -3
  510. package/src/models/ModifyDataSourceRequest.ts +18 -13
  511. package/src/models/ModifyDataSourceResponseBody.ts +3 -3
  512. package/src/models/OpenDeliveryRequest.ts +55 -30
  513. package/src/models/OpenDeliveryResponseBody.ts +4 -3
  514. package/src/models/PostAutomateResponseConfigRequest.ts +23 -17
  515. package/src/models/PostAutomateResponseConfigResponseBody.ts +6 -5
  516. package/src/models/PostCustomizeRuleRequest.ts +36 -28
  517. package/src/models/PostCustomizeRuleResponseBody.ts +44 -33
  518. package/src/models/PostCustomizeRuleTestRequest.ts +15 -11
  519. package/src/models/PostCustomizeRuleTestResponseBody.ts +6 -5
  520. package/src/models/PostEventDisposeAndWhiteruleListRequest.ts +52 -16
  521. package/src/models/PostEventDisposeAndWhiteruleListResponseBody.ts +7 -6
  522. package/src/models/PostEventWhiteruleListRequest.ts +12 -9
  523. package/src/models/PostEventWhiteruleListResponseBody.ts +4 -3
  524. package/src/models/PostFinishCustomizeRuleTestRequest.ts +11 -8
  525. package/src/models/PostFinishCustomizeRuleTestResponseBody.ts +6 -5
  526. package/src/models/PostRuleStatusChangeRequest.ts +18 -13
  527. package/src/models/PostRuleStatusChangeResponseBody.ts +6 -5
  528. package/src/models/RestoreCapacityRequest.ts +10 -7
  529. package/src/models/RestoreCapacityResponseBody.ts +5 -4
  530. package/src/models/SetStorageRequest.ts +14 -11
  531. package/src/models/SetStorageResponseBody.ts +4 -3
  532. package/src/models/SubmitImportLogTasksRequest.ts +25 -24
  533. package/src/models/SubmitImportLogTasksResponseBody.ts +1 -1
  534. package/src/models/UpdateAutomateResponseConfigStatusRequest.ts +15 -11
  535. package/src/models/UpdateAutomateResponseConfigStatusResponseBody.ts +6 -5
  536. package/src/models/UpdateWhiteRuleListRequest.ts +24 -5
  537. package/src/models/UpdateWhiteRuleListResponseBody.ts +6 -5
  538. package/src/models/model.ts +11 -0
@@ -25,7 +25,7 @@ export class DeleteBindAccountRequest extends $dara.Model {
25
25
  accountId?: string;
26
26
  /**
27
27
  * @remarks
28
- * The ID generated when the account is added to the threat analysis feature. You can call the [ListBindAccount](https://api.aliyun-inc.com/#/publishment/document/cloud-siem/863fdf54478f4cc5877e27c2a5fe9e44?tenantUuid=f382fccd88b94c5c8c864def6815b854\\&activeTabKey=api%7CListBindAccount) operation to query the ID.
28
+ * The binding ID. Call the [ListBindAccount](https://api.aliyun-inc.com/#/publishment/document/cloud-siem/863fdf54478f4cc5877e27c2a5fe9e44?tenantUuid=f382fccd88b94c5c8c864def6815b854\\&activeTabKey=api%7CListBindAccount) operation to obtain the binding ID.
29
29
  *
30
30
  * @example
31
31
  * 10
@@ -33,11 +33,13 @@ export class DeleteBindAccountRequest extends $dara.Model {
33
33
  bindId?: number;
34
34
  /**
35
35
  * @remarks
36
- * The code of the cloud service provider. Valid values:
36
+ * The code for the cloud service provider. Valid values:
37
37
  *
38
- * * qcloud: Tencent Cloud
39
- * * aliyun: Alibaba Cloud
40
- * * hcloud: Huawei Cloud
38
+ * - qcloud: Tencent Cloud
39
+ *
40
+ * - aliyun: Alibaba Cloud
41
+ *
42
+ * - hcloud: Huawei Cloud
41
43
  *
42
44
  * This parameter is required.
43
45
  *
@@ -47,16 +49,35 @@ export class DeleteBindAccountRequest extends $dara.Model {
47
49
  cloudCode?: string;
48
50
  /**
49
51
  * @remarks
50
- * The region in which the data management center of the threat analysis feature resides. Specify this parameter based on the regions in which your assets reside. Valid values:
52
+ * The region where the threat analysis data center is located. Select a region based on the location of your assets. Valid values:
51
53
  *
52
- * * cn-hangzhou: Your assets reside in regions in China.
53
- * * ap-southeast-1: Your assets reside in regions outside China.
54
+ * - cn-hangzhou: Your assets are in mainland China or the China (Hong Kong) region.
55
+ *
56
+ * - ap-southeast-1: Your assets are in regions outside China.
54
57
  *
55
58
  * @example
56
59
  * cn-hangzhou
57
60
  */
58
61
  regionId?: string;
62
+ /**
63
+ * @remarks
64
+ * The user ID of the member. An administrator can specify this parameter to perform the operation from the perspective of a member.
65
+ *
66
+ * @example
67
+ * 113091674488****
68
+ */
59
69
  roleFor?: number;
70
+ /**
71
+ * @remarks
72
+ * The type of the view. Valid values:
73
+ *
74
+ * - 0: The view of the current Alibaba Cloud account.
75
+ *
76
+ * - 1: The view of all accounts that are managed by your enterprise.
77
+ *
78
+ * @example
79
+ * 1
80
+ */
60
81
  roleType?: number;
61
82
  static names(): { [key: string]: string } {
62
83
  return {
@@ -5,7 +5,7 @@ import * as $dara from '@darabonba/typescript';
5
5
  export class DeleteBindAccountResponseBodyData extends $dara.Model {
6
6
  /**
7
7
  * @remarks
8
- * The number of cloud accounts that are removed. The value 1 indicates that cloud account is removed, and a value less than or equal to 0 indicates that the cloud account failed to be removed.
8
+ * The number of account bindings that are deleted. A value of 1 indicates that the operation was successful. A value of 0 or less indicates that the operation failed.
9
9
  *
10
10
  * @example
11
11
  * 1
@@ -5,7 +5,7 @@ import * as $dara from '@darabonba/typescript';
5
5
  export class DeleteCustomizeRuleRequest extends $dara.Model {
6
6
  /**
7
7
  * @remarks
8
- * The region in which the service is deployed.
8
+ * The region where the product is deployed.
9
9
  *
10
10
  * @example
11
11
  * cn-shanghai
@@ -13,7 +13,7 @@ export class DeleteCustomizeRuleRequest extends $dara.Model {
13
13
  regionId?: string;
14
14
  /**
15
15
  * @remarks
16
- * The ID of the account that you switch from the management account.
16
+ * The user ID of the member. This parameter is used when an administrator switches to the perspective of a member.
17
17
  *
18
18
  * @example
19
19
  * 113091674488****
@@ -21,9 +21,11 @@ export class DeleteCustomizeRuleRequest extends $dara.Model {
21
21
  roleFor?: number;
22
22
  /**
23
23
  * @remarks
24
- * The type of the view. Valid values:
25
- * - 0: the current Alibaba Cloud account
26
- * - 1: the global account
24
+ * The type of the view.
25
+ *
26
+ * - 0: The view of the current Alibaba Cloud account.
27
+ *
28
+ * - 1: The view of all accounts in your enterprise.
27
29
  *
28
30
  * @example
29
31
  * 1
@@ -31,7 +33,7 @@ export class DeleteCustomizeRuleRequest extends $dara.Model {
31
33
  roleType?: number;
32
34
  /**
33
35
  * @remarks
34
- * The ID of the rule.
36
+ * The ID of the custom rule.
35
37
  *
36
38
  * @example
37
39
  * 123456789
@@ -5,7 +5,7 @@ import * as $dara from '@darabonba/typescript';
5
5
  export class DeleteCustomizeRuleResponseBody extends $dara.Model {
6
6
  /**
7
7
  * @remarks
8
- * The HTTP status code that is returned.
8
+ * The status code of the request.
9
9
  *
10
10
  * @example
11
11
  * 200
@@ -13,7 +13,7 @@ export class DeleteCustomizeRuleResponseBody extends $dara.Model {
13
13
  code?: number;
14
14
  /**
15
15
  * @remarks
16
- * The data returned.
16
+ * The return value of the request.
17
17
  *
18
18
  * @example
19
19
  * 123456
@@ -39,8 +39,9 @@ export class DeleteCustomizeRuleResponseBody extends $dara.Model {
39
39
  * @remarks
40
40
  * Indicates whether the request was successful. Valid values:
41
41
  *
42
- * * true
43
- * * false
42
+ * - true: The request was successful.
43
+ *
44
+ * - false: The request failed.
44
45
  *
45
46
  * @example
46
47
  * true
@@ -5,7 +5,7 @@ import * as $dara from '@darabonba/typescript';
5
5
  export class DeleteDataSourceRequest extends $dara.Model {
6
6
  /**
7
7
  * @remarks
8
- * The ID of the cloud account.
8
+ * The ID of the Alibaba Cloud account.
9
9
  *
10
10
  * This parameter is required.
11
11
  *
@@ -15,11 +15,13 @@ export class DeleteDataSourceRequest extends $dara.Model {
15
15
  accountId?: string;
16
16
  /**
17
17
  * @remarks
18
- * The code of the cloud service provider. Valid values:
18
+ * The code for the multicloud environment. Valid values:
19
19
  *
20
- * * qcloud: Tencent Cloud
21
- * * aliyun: Alibaba Cloud
22
- * * hcloud: Huawei Cloud
20
+ * - qcloud: Tencent Cloud.
21
+ *
22
+ * - aliyun: Alibaba Cloud.
23
+ *
24
+ * - hcloud: Huawei Cloud.
23
25
  *
24
26
  * This parameter is required.
25
27
  *
@@ -29,7 +31,7 @@ export class DeleteDataSourceRequest extends $dara.Model {
29
31
  cloudCode?: string;
30
32
  /**
31
33
  * @remarks
32
- * The ID of the data source. The ID is an MD5 hash value that is calculated by the threat analysis feature based on specific parameters. You can call the [ListDataSourceLogs](https://api.aliyun-inc.com/#/publishment/document/cloud-siem/863fdf54478f4cc5877e27c2a5fe9e44?tenantUuid=f382fccd88b94c5c8c864def6815b854\\&activeTabKey=api%7CListDataSourceLogs) operation to query the IDs of data sources.
34
+ * The ID of the data source. This ID is an MD5 hash value calculated by Threat Analysis based on specific parameters. Call the [ListDataSourceLogs](https://api.aliyun-inc.com/#/publishment/document/cloud-siem/863fdf54478f4cc5877e27c2a5fe9e44?tenantUuid=f382fccd88b94c5c8c864def6815b854\\&activeTabKey=api%7CListDataSourceLogs) operation to obtain the data source ID.
33
35
  *
34
36
  * This parameter is required.
35
37
  *
@@ -39,10 +41,11 @@ export class DeleteDataSourceRequest extends $dara.Model {
39
41
  dataSourceInstanceId?: string;
40
42
  /**
41
43
  * @remarks
42
- * The region in which the data management center of the threat analysis feature resides. Specify this parameter based on the regions in which your assets reside. Valid values:
44
+ * The region where the Data Management hub of Threat Analysis is located. Select the region of the management hub based on the region where your assets are located. Valid values:
45
+ *
46
+ * - cn-hangzhou: Your assets are in the Chinese mainland or China (Hong Kong).
43
47
  *
44
- * * cn-hangzhou: Your assets reside in regions in China.
45
- * * ap-southeast-1: Your assets reside in regions outside China.
48
+ * - ap-southeast-1: Your assets are outside China.
46
49
  *
47
50
  * @example
48
51
  * cn-hangzhou
@@ -5,7 +5,7 @@ import * as $dara from '@darabonba/typescript';
5
5
  export class DeleteDataSourceResponseBodyData extends $dara.Model {
6
6
  /**
7
7
  * @remarks
8
- * The number of data sources that are removed. The value 1 indicates that data source is removed, and a value less than or equal to 0 indicates that the data source failed to be removed.
8
+ * The number of data sources that are deleted. A value of 1 indicates success. A value of 0 or less indicates failure.
9
9
  *
10
10
  * @example
11
11
  * 1
@@ -35,12 +35,12 @@ export class DeleteDataSourceResponseBodyData extends $dara.Model {
35
35
  export class DeleteDataSourceResponseBody extends $dara.Model {
36
36
  /**
37
37
  * @remarks
38
- * The data returned.
38
+ * The return value of the request.
39
39
  */
40
40
  data?: DeleteDataSourceResponseBodyData;
41
41
  /**
42
42
  * @remarks
43
- * The request ID.
43
+ * The ID of the request.
44
44
  *
45
45
  * @example
46
46
  * 6276D891-*****-55B2-87B9-74D413F7****
@@ -15,10 +15,11 @@ export class DeleteWhiteRuleListRequest extends $dara.Model {
15
15
  id?: number;
16
16
  /**
17
17
  * @remarks
18
- * The region in which the data management center of the threat analysis feature resides. Specify this parameter based on the regions in which your assets reside. Valid values:
18
+ * The region of the data management center for threat analysis. Select a region based on the location of your assets. Valid values:
19
19
  *
20
- * * cn-hangzhou: Your assets reside in regions in China.
21
- * * ap-southeast-1: Your assets reside in regions outside China.
20
+ * - cn-hangzhou: The assets are in the Chinese mainland or China (Hong Kong).
21
+ *
22
+ * - ap-southeast-1: The assets are in a region outside China.
22
23
  *
23
24
  * @example
24
25
  * cn-hangzhou
@@ -26,7 +27,7 @@ export class DeleteWhiteRuleListRequest extends $dara.Model {
26
27
  regionId?: string;
27
28
  /**
28
29
  * @remarks
29
- * The ID of the account that you switch from the management account.
30
+ * The user ID of a member. An administrator can switch to the perspective of the member.
30
31
  *
31
32
  * @example
32
33
  * 113091674488****
@@ -34,9 +35,11 @@ export class DeleteWhiteRuleListRequest extends $dara.Model {
34
35
  roleFor?: number;
35
36
  /**
36
37
  * @remarks
37
- * The type of the view. Valid values:
38
- * - 0: the current Alibaba Cloud account
39
- * - 1: the global account
38
+ * The view type.
39
+ *
40
+ * - 0: The view for the current Alibaba Cloud account.
41
+ *
42
+ * - 1: The view for all accounts in the enterprise.
40
43
  *
41
44
  * @example
42
45
  * 1
@@ -5,7 +5,7 @@ import * as $dara from '@darabonba/typescript';
5
5
  export class DeleteWhiteRuleListResponseBody extends $dara.Model {
6
6
  /**
7
7
  * @remarks
8
- * The HTTP status code.
8
+ * The status code of the request.
9
9
  *
10
10
  * @example
11
11
  * 200
@@ -39,8 +39,9 @@ export class DeleteWhiteRuleListResponseBody extends $dara.Model {
39
39
  * @remarks
40
40
  * Indicates whether the request was successful. Valid values:
41
41
  *
42
- * * true
43
- * * false
42
+ * - true: The request was successful.
43
+ *
44
+ * - false: The request failed.
44
45
  *
45
46
  * @example
46
47
  * true
@@ -5,10 +5,11 @@ import * as $dara from '@darabonba/typescript';
5
5
  export class DescribeAggregateFunctionRequest extends $dara.Model {
6
6
  /**
7
7
  * @remarks
8
- * The region in which the data management center of the threat analysis feature resides. Specify this parameter based on the regions in which your assets reside. Valid values:
8
+ * The region where the data management center of Threat Analysis is located. Select a region based on the location of your assets. Valid values:
9
9
  *
10
- * * cn-hangzhou: Your assets reside in regions in China.
11
- * * ap-southeast-1: Your assets reside in regions outside China.
10
+ * - cn-hangzhou: Your assets are in the Chinese mainland or Hong Kong (China).
11
+ *
12
+ * - ap-southeast-1: Your assets are in a region outside the Chinese mainland.
12
13
  *
13
14
  * @example
14
15
  * cn-hangzhou
@@ -16,7 +17,7 @@ export class DescribeAggregateFunctionRequest extends $dara.Model {
16
17
  regionId?: string;
17
18
  /**
18
19
  * @remarks
19
- * The ID of the account that you switch from the management account.
20
+ * The ID of the member. An administrator can switch to the perspective of the member.
20
21
  *
21
22
  * @example
22
23
  * 113091674488****
@@ -25,8 +26,10 @@ export class DescribeAggregateFunctionRequest extends $dara.Model {
25
26
  /**
26
27
  * @remarks
27
28
  * The type of the view. Valid values:
28
- * - 0: the current Alibaba Cloud account
29
- * - 1: the global account
29
+ *
30
+ * - 0: The view of the current Alibaba Cloud account.
31
+ *
32
+ * - 1: The view of all accounts in the enterprise.
30
33
  *
31
34
  * @example
32
35
  * 1
@@ -45,7 +45,7 @@ export class DescribeAggregateFunctionResponseBodyData extends $dara.Model {
45
45
  export class DescribeAggregateFunctionResponseBody extends $dara.Model {
46
46
  /**
47
47
  * @remarks
48
- * The HTTP status code.
48
+ * The status code of the request.
49
49
  *
50
50
  * @example
51
51
  * 200
@@ -53,7 +53,7 @@ export class DescribeAggregateFunctionResponseBody extends $dara.Model {
53
53
  code?: number;
54
54
  /**
55
55
  * @remarks
56
- * The data returned.
56
+ * The returned data.
57
57
  *
58
58
  * @example
59
59
  * 123456
@@ -69,7 +69,7 @@ export class DescribeAggregateFunctionResponseBody extends $dara.Model {
69
69
  message?: string;
70
70
  /**
71
71
  * @remarks
72
- * The request ID.
72
+ * The ID of the request.
73
73
  *
74
74
  * @example
75
75
  * 9AAA9ED9-78F4-5021-86DC-D51C7511****
@@ -79,8 +79,9 @@ export class DescribeAggregateFunctionResponseBody extends $dara.Model {
79
79
  * @remarks
80
80
  * Indicates whether the request was successful. Valid values:
81
81
  *
82
- * * true
83
- * * false
82
+ * - true: The request was successful.
83
+ *
84
+ * - false: The request failed.
84
85
  *
85
86
  * @example
86
87
  * true
@@ -5,7 +5,7 @@ import * as $dara from '@darabonba/typescript';
5
5
  export class DescribeAlertSceneByEventRequest extends $dara.Model {
6
6
  /**
7
7
  * @remarks
8
- * The ID of the event.
8
+ * The event ID.
9
9
  *
10
10
  * This parameter is required.
11
11
  *
@@ -15,10 +15,11 @@ export class DescribeAlertSceneByEventRequest extends $dara.Model {
15
15
  incidentUuid?: string;
16
16
  /**
17
17
  * @remarks
18
- * The region in which the data management center of the threat analysis feature resides. Specify this parameter based on the regions in which your assets reside. Valid values:
18
+ * The region of the Data Management center. Select a region based on the location of your assets. Valid values:
19
19
  *
20
- * * cn-hangzhou: Your assets reside in regions in China.
21
- * * ap-southeast-1: Your assets reside in regions outside China.
20
+ * - cn-hangzhou: Assets are in the Chinese mainland or China (Hong Kong).
21
+ *
22
+ * - ap-southeast-1: Assets are outside China.
22
23
  *
23
24
  * @example
24
25
  * cn-hangzhou
@@ -26,7 +27,7 @@ export class DescribeAlertSceneByEventRequest extends $dara.Model {
26
27
  regionId?: string;
27
28
  /**
28
29
  * @remarks
29
- * The ID of the account that you switch from the management account.
30
+ * The user ID of the member. This parameter is used when an administrator switches to the perspective of a member.
30
31
  *
31
32
  * @example
32
33
  * 113091674488****
@@ -34,9 +35,11 @@ export class DescribeAlertSceneByEventRequest extends $dara.Model {
34
35
  roleFor?: number;
35
36
  /**
36
37
  * @remarks
37
- * The type of the view. Valid values:
38
- * - 0: the current Alibaba Cloud account
39
- * - 1: the global account
38
+ * The view type.
39
+ *
40
+ * - 0: the view of the current Alibaba Cloud account.
41
+ *
42
+ * - 1: the view of all accounts that belong to the enterprise.
40
43
  *
41
44
  * @example
42
45
  * 1
@@ -5,7 +5,7 @@ import * as $dara from '@darabonba/typescript';
5
5
  export class DescribeAlertSceneByEventResponseBodyDataTargets extends $dara.Model {
6
6
  /**
7
7
  * @remarks
8
- * The display name of the entity attribute field that can be added to the whitelist.
8
+ * The display name of the entity property field that can be whitelisted.
9
9
  *
10
10
  * @example
11
11
  * host uuid
@@ -13,7 +13,7 @@ export class DescribeAlertSceneByEventResponseBodyDataTargets extends $dara.Mode
13
13
  name?: string;
14
14
  /**
15
15
  * @remarks
16
- * The entity attribute field that can be added to the whitelist.
16
+ * The field of the entity property that can be whitelisted.
17
17
  *
18
18
  * @example
19
19
  * host_uuid
@@ -21,7 +21,7 @@ export class DescribeAlertSceneByEventResponseBodyDataTargets extends $dara.Mode
21
21
  type?: string;
22
22
  /**
23
23
  * @remarks
24
- * The right operand that is displayed by default in the whitelist rule.
24
+ * The default right operand displayed for the whitelisting rule.
25
25
  *
26
26
  * @example
27
27
  * 441862da-a539-4cc0-a00d-47395582****
@@ -29,7 +29,7 @@ export class DescribeAlertSceneByEventResponseBodyDataTargets extends $dara.Mode
29
29
  value?: string;
30
30
  /**
31
31
  * @remarks
32
- * The supported right operands of the whitelist rule.
32
+ * The available right operands for the whitelisting rule.
33
33
  *
34
34
  * @example
35
35
  * ["441862da-a539-4cc0-a00d-473955826881"]
@@ -68,7 +68,7 @@ export class DescribeAlertSceneByEventResponseBodyDataTargets extends $dara.Mode
68
68
  export class DescribeAlertSceneByEventResponseBodyData extends $dara.Model {
69
69
  /**
70
70
  * @remarks
71
- * The alert name. The display name of the alert name varies based on the language of the system, such as Chinese and English.
71
+ * The display name of the alert. The value varies based on the language settings.
72
72
  *
73
73
  * @example
74
74
  * login_common_ip
@@ -76,7 +76,7 @@ export class DescribeAlertSceneByEventResponseBodyData extends $dara.Model {
76
76
  alertName?: string;
77
77
  /**
78
78
  * @remarks
79
- * The ID of the alert name.
79
+ * The identifier of the alert name.
80
80
  *
81
81
  * @example
82
82
  * login_common_ip
@@ -84,7 +84,7 @@ export class DescribeAlertSceneByEventResponseBodyData extends $dara.Model {
84
84
  alertNameId?: string;
85
85
  /**
86
86
  * @remarks
87
- * The alert title. The display name of the alert title varies based on the language of the system, such as Chinese and English.
87
+ * The display title of the alert. The value varies based on the language settings.
88
88
  *
89
89
  * @example
90
90
  * Unusual Logon-login_common_ip
@@ -92,7 +92,7 @@ export class DescribeAlertSceneByEventResponseBodyData extends $dara.Model {
92
92
  alertTile?: string;
93
93
  /**
94
94
  * @remarks
95
- * The ID of the alert title.
95
+ * The identifier of the alert title.
96
96
  *
97
97
  * @example
98
98
  * Unusual Logon-login_common_ip
@@ -100,7 +100,7 @@ export class DescribeAlertSceneByEventResponseBodyData extends $dara.Model {
100
100
  alertTileId?: string;
101
101
  /**
102
102
  * @remarks
103
- * The alert type. The display name of the alert type varies based on the language of the system, such as Chinese and English.
103
+ * The display name of the alert type. The value varies based on the language settings.
104
104
  *
105
105
  * @example
106
106
  * Unusual Logon
@@ -108,7 +108,7 @@ export class DescribeAlertSceneByEventResponseBodyData extends $dara.Model {
108
108
  alertType?: string;
109
109
  /**
110
110
  * @remarks
111
- * The ID of the alert type.
111
+ * The identifier of the alert type.
112
112
  *
113
113
  * @example
114
114
  * Unusual Logon
@@ -116,7 +116,7 @@ export class DescribeAlertSceneByEventResponseBodyData extends $dara.Model {
116
116
  alertTypeId?: string;
117
117
  /**
118
118
  * @remarks
119
- * The objects that can be added to the whitelist.
119
+ * The objects to be whitelisted.
120
120
  *
121
121
  * @example
122
122
  * [{"Type": "host_uuid","Value": "441862da-a539-4cc0-a00d-473955826881","Values": ["441862da-a539-4cc0-a00d-473955826881"],"Name": "${aliyun.siem.entity.host_uuid}"}]
@@ -161,7 +161,7 @@ export class DescribeAlertSceneByEventResponseBodyData extends $dara.Model {
161
161
  export class DescribeAlertSceneByEventResponseBody extends $dara.Model {
162
162
  /**
163
163
  * @remarks
164
- * The HTTP status code.
164
+ * The status code of the request.
165
165
  *
166
166
  * @example
167
167
  * 200
@@ -177,7 +177,7 @@ export class DescribeAlertSceneByEventResponseBody extends $dara.Model {
177
177
  data?: DescribeAlertSceneByEventResponseBodyData[];
178
178
  /**
179
179
  * @remarks
180
- * The returned message.
180
+ * The message returned for the request.
181
181
  *
182
182
  * @example
183
183
  * success
@@ -195,8 +195,9 @@ export class DescribeAlertSceneByEventResponseBody extends $dara.Model {
195
195
  * @remarks
196
196
  * Indicates whether the request was successful. Valid values:
197
197
  *
198
- * * true
199
- * * false
198
+ * - true: The request was successful.
199
+ *
200
+ * - false: The request failed.
200
201
  *
201
202
  * @example
202
203
  * true
@@ -5,10 +5,11 @@ import * as $dara from '@darabonba/typescript';
5
5
  export class DescribeAlertSceneRequest extends $dara.Model {
6
6
  /**
7
7
  * @remarks
8
- * The region in which the data management center of the threat analysis feature resides. Specify this parameter based on the regions in which your assets reside. Valid values:
8
+ * The region where the data management center of Threat Analysis is deployed. You must select the region where your assets are located. Valid values:
9
9
  *
10
- * * cn-hangzhou: Your assets reside in regions in China.
11
- * * ap-southeast-1: Your assets reside in regions outside China.
10
+ * - cn-hangzhou: your assets are in the Chinese mainland or China (Hong Kong).
11
+ *
12
+ * - ap-southeast-1: your assets are outside China.
12
13
  *
13
14
  * @example
14
15
  * cn-hangzhou
@@ -16,7 +17,7 @@ export class DescribeAlertSceneRequest extends $dara.Model {
16
17
  regionId?: string;
17
18
  /**
18
19
  * @remarks
19
- * The ID of the account that you switch from the management account.
20
+ * The user ID of the member. An administrator can use this ID to switch to the member\\"s perspective.
20
21
  *
21
22
  * @example
22
23
  * 113091674488****
@@ -24,9 +25,11 @@ export class DescribeAlertSceneRequest extends $dara.Model {
24
25
  roleFor?: number;
25
26
  /**
26
27
  * @remarks
27
- * The type of the view. Valid values:
28
- * - 0: the current Alibaba Cloud account
29
- * - 1: the global account
28
+ * The type of the view.
29
+ *
30
+ * - 0: the view of the current Alibaba Cloud account.
31
+ *
32
+ * - 1: the view of all accounts within the enterprise.
30
33
  *
31
34
  * @example
32
35
  * 1
@@ -5,7 +5,7 @@ import * as $dara from '@darabonba/typescript';
5
5
  export class DescribeAlertSceneResponseBodyDataTargets extends $dara.Model {
6
6
  /**
7
7
  * @remarks
8
- * The display name of the attribute for the entity.
8
+ * The display name of the field of the entity that can be added to the whitelist.
9
9
  *
10
10
  * @example
11
11
  * HOST UUID
@@ -13,7 +13,7 @@ export class DescribeAlertSceneResponseBodyDataTargets extends $dara.Model {
13
13
  name?: string;
14
14
  /**
15
15
  * @remarks
16
- * The attribute of the entity.
16
+ * The field of the entity that can be added to the whitelist.
17
17
  *
18
18
  * @example
19
19
  * host_uuid
@@ -21,7 +21,7 @@ export class DescribeAlertSceneResponseBodyDataTargets extends $dara.Model {
21
21
  type?: string;
22
22
  /**
23
23
  * @remarks
24
- * The right operand that is displayed by default in the whitelist rule.
24
+ * The default right operand that is displayed for the whitelist rule.
25
25
  *
26
26
  * @example
27
27
  * 441862da-a539-4cc0-a00d-47395582****
@@ -29,7 +29,7 @@ export class DescribeAlertSceneResponseBodyDataTargets extends $dara.Model {
29
29
  value?: string;
30
30
  /**
31
31
  * @remarks
32
- * The right operands supported by the whitelist rule.
32
+ * The available right operands for the whitelist rule.
33
33
  *
34
34
  * @example
35
35
  * ["441862da-a539-4cc0-a00d-473955826881"]
@@ -68,7 +68,7 @@ export class DescribeAlertSceneResponseBodyDataTargets extends $dara.Model {
68
68
  export class DescribeAlertSceneResponseBodyData extends $dara.Model {
69
69
  /**
70
70
  * @remarks
71
- * The name of the alert. The value varies based on the display language (Chinese or English) of the Security Center console.
71
+ * The display name of the alert. The value varies based on the language of the environment.
72
72
  *
73
73
  * @example
74
74
  * login_common_ip
@@ -84,7 +84,7 @@ export class DescribeAlertSceneResponseBodyData extends $dara.Model {
84
84
  alertNameId?: string;
85
85
  /**
86
86
  * @remarks
87
- * The title of the alert notification. The value varies based on the display language (Chinese or English) of the Security Center console.
87
+ * The display title of the alert. The value varies based on the language of the environment.
88
88
  *
89
89
  * @example
90
90
  * unusual login-login_common_ip
@@ -100,7 +100,7 @@ export class DescribeAlertSceneResponseBodyData extends $dara.Model {
100
100
  alertTileId?: string;
101
101
  /**
102
102
  * @remarks
103
- * The type of the alert. The value varies based on the display language (Chinese or English) of the Security Center console.
103
+ * The display name of the alert type. The value varies based on the language of the environment.
104
104
  *
105
105
  * @example
106
106
  * unusual login
@@ -116,7 +116,7 @@ export class DescribeAlertSceneResponseBodyData extends $dara.Model {
116
116
  alertTypeId?: string;
117
117
  /**
118
118
  * @remarks
119
- * The information about the entities for which you need to add the alert to the whitelist.
119
+ * The objects that can be added to the whitelist.
120
120
  *
121
121
  * @example
122
122
  * [{"Type": "host_uuid","Value": "441862da-a539-4cc0-a00d-473955826881","Values": ["441862da-a539-4cc0-a00d-473955826881"],"Name": "${aliyun.siem.entity.host_uuid}"}]
@@ -161,7 +161,7 @@ export class DescribeAlertSceneResponseBodyData extends $dara.Model {
161
161
  export class DescribeAlertSceneResponseBody extends $dara.Model {
162
162
  /**
163
163
  * @remarks
164
- * The response code.
164
+ * The status code of the request.
165
165
  *
166
166
  * @example
167
167
  * 200
@@ -195,8 +195,9 @@ export class DescribeAlertSceneResponseBody extends $dara.Model {
195
195
  * @remarks
196
196
  * Indicates whether the request was successful. Valid values:
197
197
  *
198
- * * true
199
- * * false
198
+ * - true: The request was successful.
199
+ *
200
+ * - false: The request failed.
200
201
  *
201
202
  * @example
202
203
  * true