emqx_connector_api.hocon 1.8 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899
  1. emqx_connector_api {
  2. desc_api1.desc:
  3. """List all created connectors."""
  4. desc_api1.label:
  5. """List All Connectors"""
  6. desc_api2.desc:
  7. """Create a new connector by type and name."""
  8. desc_api2.label:
  9. """Create Connector"""
  10. desc_api3.desc:
  11. """Get a connector by id."""
  12. desc_api3.label:
  13. """Get Connector"""
  14. desc_api4.desc:
  15. """Update a connector by id."""
  16. desc_api4.label:
  17. """Update Connector"""
  18. desc_api5.desc:
  19. """Delete a connector by id."""
  20. desc_api5.label:
  21. """Delete Connector"""
  22. desc_api6.desc:
  23. """Reset a connector metrics by id."""
  24. desc_api6.label:
  25. """Reset Connector Metrics"""
  26. desc_api7.desc:
  27. """Start connector on all nodes in the cluster."""
  28. desc_api7.label:
  29. """Cluster Connector Operate"""
  30. desc_api8.desc:
  31. """Start connector on a specific node."""
  32. desc_api8.label:
  33. """Node Connector Operate"""
  34. desc_api9.desc:
  35. """Test creating a new connector."""
  36. desc_api9.label:
  37. """Test Connector Creation"""
  38. desc_connector_metrics.desc:
  39. """Get connector metrics by id."""
  40. desc_connector_metrics.label:
  41. """Get Connector Metrics"""
  42. desc_enable_connector.desc:
  43. """Enable or Disable connector on all nodes in the cluster."""
  44. desc_enable_connector.label:
  45. """Cluster Connector Enable"""
  46. desc_param_path_enable.desc:
  47. """Whether to enable this connector."""
  48. desc_param_path_enable.label:
  49. """Enable connector"""
  50. desc_param_path_id.desc:
  51. """The connector id. Must be of format {type}:{name}."""
  52. desc_param_path_id.label:
  53. """Connector ID"""
  54. desc_param_path_node.desc:
  55. """The node name, e.g. 'emqx@127.0.0.1'."""
  56. desc_param_path_node.label:
  57. """The node name"""
  58. desc_param_path_operation_cluster.desc:
  59. """Operation can be one of: 'start'."""
  60. desc_param_path_operation_cluster.label:
  61. """Cluster Operation"""
  62. desc_param_path_operation_on_node.desc:
  63. """Operation can be one of: 'start'."""
  64. desc_param_path_operation_on_node.label:
  65. """Node Operation"""
  66. }