emqx_rule_engine_api.hocon 1.5 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899
  1. emqx_rule_engine_api {
  2. api1.desc:
  3. """List all rules"""
  4. api1.label:
  5. """List All Rules"""
  6. api10.desc:
  7. """Update rule engine configuration."""
  8. api10.label:
  9. """Update configuration"""
  10. api1_enable.desc:
  11. """Filter enable/disable rules"""
  12. api1_from.desc:
  13. """Filter rules by from(topic), exact match"""
  14. api1_like_description.desc:
  15. """Filter rules by description, Substring matching"""
  16. api1_like_from.desc:
  17. """Filter rules by from(topic), Substring matching"""
  18. api1_like_id.desc:
  19. """Filter rules by id, Substring matching"""
  20. api1_match_from.desc:
  21. """Filter rules by from(topic), Mqtt topic matching"""
  22. api1_resp.desc:
  23. """List of rules"""
  24. api1_resp.label:
  25. """List Rules"""
  26. api2.desc:
  27. """Create a new rule using given Id"""
  28. api2.label:
  29. """Create Rule By ID"""
  30. api3.desc:
  31. """List all events can be used in rules"""
  32. api3.label:
  33. """List All Events Can Be Used In Rule"""
  34. api4.desc:
  35. """Get a rule by given Id"""
  36. api4.label:
  37. """Get Rule"""
  38. api4_1.desc:
  39. """Get a rule's metrics by given Id"""
  40. api4_1.label:
  41. """Get Metric"""
  42. api5.desc:
  43. """Update a rule by given Id to all nodes in the cluster"""
  44. api5.label:
  45. """Update Cluster Rule"""
  46. api6.desc:
  47. """Delete a rule by given Id from all nodes in the cluster"""
  48. api6.label:
  49. """Delete Cluster Rule"""
  50. api7.desc:
  51. """Reset a rule metrics"""
  52. api7.label:
  53. """Reset Rule Metrics"""
  54. api8.desc:
  55. """Test a rule"""
  56. api8.label:
  57. """Test Rule"""
  58. api9.desc:
  59. """Get rule engine configuration."""
  60. api9.label:
  61. """Get configuration"""
  62. api11.desc:
  63. """Apply a rule with the given message and environment"""
  64. api11.label:
  65. """Apply Rule"""
  66. }