emqx_exhook_api {

  list_all_servers {
    desc {
      en: "List all servers"
      zh: "查看ExHook 服务器列表"
    }
  }

  add_server {
    desc {
      en: "Add a server"
      zh: "添加 ExHook 服务器"
    }
  }

  get_detail {
    desc {
      en: "Get the detail information of Exhook server"
      zh: "查看 Exhook 服务器详细信息"
    }
  }

  update_server {
    desc {
      en: "Update the server"
      zh: "更新 Exhook 服务器"
    }
  }

  delete_server {
    desc {
      en: "Delete the server"
      zh: "删除 Exhook 服务器"
    }
  }

  get_hooks {
    desc {
      en: "Get the hooks information of server"
      zh: "获取 Exhook 服务器的钩子信息"
    }
  }

  move_api {
    desc {
      en: """Move the server.
NOTE: The position should be \"front | rear | before:{name} | after:{name}"""
      zh: """移动 Exhook 服务器顺序。
注意: 移动的参数只能是：front | rear | before:{name} | after:{name}"""
    }
  }

  move_position {
    desc {
      en: "The target position to be moved"
      zh: "移动的方向"
    }
  }

  hook_name {
    desc {
      en: "The hook's name"
      zh: "钩子的名称"
    }
  }

  server_name {
    desc {
      en: "The Exhook server name"
      zh: "Exhook 服务器的名称"
    }
  }

  hook_params {
    desc {
      en: "The parameters used when the hook is registered"
      zh: "钩子注册时使用的参数"
    }
  }

  server_metrics {
    desc {
      en: "Metrics information of this server in the current node"
      zh: "当前节点中该服务器的指标信息"
    }
  }

  node_metrics {
    desc {
      en: "Metrics information of this server in all nodes"
      zh: "所有节点中该服务器的指标信息"
    }
  }

  node_status {
    desc {
      en: "status of this server in all nodes"
      zh: "所有节点中该服务器的状态信息"
    }
  }

  hook_metrics {
    desc {
      en: "Metrics information of this hook in the current node"
      zh: "当前节点中该钩子的指标信息"
    }
  }

  node_hook_metrics {
    desc {
      en: "Metrics information of this hook in all nodes"
      zh: "所有节点中该钩子的指标信息"
    }
  }

  node {
    desc {
      en: "Node name"
      zh: "节点名称"
    }
  }

  metrics {
    desc {
      en: "Metrics information"
      zh: "指标信息"
    }
  }

  status {
    desc {
      en: """The status of Exhook server.<br/>
connected: connection succeeded<br/>
connecting: connection failed, reconnecting<br/>
disconnected: failed to connect and didn't reconnect<br/>
disabled: this server is disabled<br/>
error: failed to view the status of this server"""
      zh: """Exhook 服务器的状态。<br/>
connected: 连接成功<br/>
connecting: 连接失败，重连中<br/>
disconnected: 连接失败，且未设置自动重连<br/>
disabled: 该服务器未开启<br/>
error: 查看该服务器状态时发生错误"""
    }
  }

  metric_succeed {
    desc {
      en: "The number of times the hooks execution successful"
      zh: "钩子执行成功的次数"
    }
  }

  metric_failed {
    desc {
      en: "The number of times the hook execution failed"
      zh: "钩子执行失败的次数"
    }
  }

  metric_rate {
    desc {
      en: "The call rate of hooks"
      zh: "钩子的调用速率"
    }
  }

  metric_max_rate {
    desc {
      en: "Maximum call rate of hooks"
      zh: "钩子的最大调用速率"
    }
  }

}