package meta.service.mqtt

Get desktop application:
View/edit binary Protocol Buffers messages

• rpc ConnectorHeartbeat (ConnectorHeartbeatRequest, ConnectorHeartbeatReply)

  mqtt.proto:271

  message ConnectorHeartbeatRequest

  mqtt.proto:671

  • string cluster_name = 1

  • repeated ConnectorHeartbeatRaw heatbeats = 2

  message ConnectorHeartbeatReply

  mqtt.proto:683

  (message has no fields)

• rpc CreateAcl (CreateAclRequest, CreateAclReply)

  mqtt.proto:197

  Creates the corresponding ACL based on the request Parameters: - `cluster_name: String`: The name of the cluster. - `acl: Vec<u8>`: The parameter contains acl information, encoded from a `MQTTAcl` object into a binary format. Returns: An empty struct.

  message CreateAclRequest

  mqtt.proto:531

  • string cluster_name = 1

    The name of the cluster.

  • bytes acl = 2

    The parameter contains acl information, encoded from a `MQTTAcl` object into a binary format.

  message CreateAclReply

  mqtt.proto:539

  (message has no fields)

• rpc CreateBlacklist (CreateBlacklistRequest, CreateBlacklistReply)

  mqtt.proto:225

  Creates the corresponding blacklist based on the request Parameters: - `cluster_name: String`: The name of the cluster. - `blacklist: Vec<u8>`: The parameter contains blacklist information, encoded from a `MQTTAclBlackList` object into a binary format. Returns: An empty struct.

  message CreateBlacklistRequest

  mqtt.proto:551

  • string cluster_name = 1

    The name of the cluster.

  • bytes blacklist = 2

    The parameter contains blacklist information, encoded from a `MQTTAclBlackList` object into a binary format.

  message CreateBlacklistReply

  mqtt.proto:559

  (message has no fields)

• rpc CreateConnector (CreateConnectorRequest, CreateConnectorReply)

  mqtt.proto:265

  message CreateConnectorRequest

  mqtt.proto:648

  • string cluster_name = 1

  • string connector_name = 2

  • bytes connector = 3

  message CreateConnectorReply

  mqtt.proto:654

  (message has no fields)

• rpc CreateSession (CreateSessionRequest, CreateSessionReply)

  mqtt.proto:70

  Creates the corresponding session based on the request Parameters: - `cluster_name: String`: The name of the cluster. - `client_id: String`: The id of the client. - `session: Vec<u8>`: The parameter contains session information, encoded from a `MQTTSession` object into a binary format. Returns: An empty struct.

  message CreateSessionRequest

  mqtt.proto:441

  • string cluster_name = 1

    The name of the cluster.

  • string client_id = 2

    The id of the client.

  • bytes session = 3

    The parameter contains session information, encoded from a `MQTTSession` object into a binary format.

  message CreateSessionReply

  mqtt.proto:452

  (message has no fields)

• rpc CreateTopic (CreateTopicRequest, CreateTopicReply)

  mqtt.proto:124

  Creates the corresponding topic based on the request Parameters: - `cluster_name: String`: The name of the cluster. - `topic_name: String`: The name of the topic. - `content: Vec<u8>`: The parameter contains topic information, encoded from a `MQTTTopic` object into a binary format. Returns: An empty struct.

  message CreateTopicRequest

  mqtt.proto:373

  • string cluster_name = 1

    The name of the cluster.

  • string topic_name = 2

    The name of the topic.

  • bytes content = 3

    The parameter contains topic information, encoded from a `MQTTTopic` object into a binary format.

  message CreateTopicReply

  mqtt.proto:384

  (message has no fields)

• rpc CreateTopicRewriteRule (CreateTopicRewriteRuleRequest, CreateTopicRewriteRuleReply)

  mqtt.proto:237

  Create a topic rewrite rule. Parameters: - `cluster_name: String`: The name of the cluster. - `action: String`: The action of the rewrite rule, one of the publish|subscribe|all. - `source_topic: String`: The source topic of the rewrite rule. - `dest_topic: String`: The dest topic of the rewrite rule. - `re: String`: The regex for extracting variables. Returns: An empty struct.

  message CreateTopicRewriteRuleRequest

  mqtt.proto:574

  • string cluster_name = 1

    The cluster of the rewrite rule.

  • string action = 2

    The action of the rewrite rule, one of the publish|subscribe|all.

  • string source_topic = 3

    The source topic of the rewrite rule.

  • string dest_topic = 4

    The dest topic of the rewrite rule.

  • string regex = 5

    The regex of the rewrite rule.

  message CreateTopicRewriteRuleReply

  mqtt.proto:591

  (message has no fields)

• rpc CreateUser (CreateUserRequest, CreateUserReply)

  mqtt.proto:41

  Creates the corresponding user based on the request Parameters: - `cluster_name: String`: The name of the cluster. - `user_name: String`: The name of the user. - `content: Vec<u8>`: The parameter contains user information, encoded from a `MQTTUser` object into a binary format. Returns: An empty struct.

  message CreateUserRequest

  mqtt.proto:337

  • string cluster_name = 1

    The name of the cluster.

  • string user_name = 2

    The name of the user.

  • bytes content = 3

    The parameter contains user information, encoded from a `MQTTUser` object into a binary format.

  message CreateUserReply

  mqtt.proto:348

  (message has no fields)

• rpc DeleteAcl (DeleteAclRequest, DeleteAclReply)

  mqtt.proto:188

  Deletes the corresponding ACL based on the request Parameters: - `cluster_name: String`: The name of the cluster. - `acl: Vec<u8>`: The parameter contains acl information, encoded from a `MQTTAcl` object into a binary format. Returns: An empty struct.

  message DeleteAclRequest

  mqtt.proto:521

  • string cluster_name = 1

    The name of the cluster.

  • bytes acl = 2

    The parameter contains acl information, encoded from a `MQTTAcl` object into a binary format.

  message DeleteAclReply

  mqtt.proto:529

  (message has no fields)

• rpc DeleteAutoSubscribeRule (DeleteAutoSubscribeRuleRequest, DeleteAutoSubscribeRuleReply)

  mqtt.proto:293

  Delete a auto subscribe rule. Parameters: - `cluster_name: String`: The name of the cluster. - `topic: String`: The topic of the auto subscribe rule. Returns: An empty struct.

  message DeleteAutoSubscribeRuleRequest

  mqtt.proto:707

  • string cluster_name = 1

    The cluster of the auto subscribe rule.

  • string topic = 2

    The topic of the auto subscribe rule.

  message DeleteAutoSubscribeRuleReply

  mqtt.proto:715

  (message has no fields)

• rpc DeleteBlacklist (DeleteBlacklistRequest, DeleteBlacklistReply)

  mqtt.proto:216

  Deletes the corresponding blacklist based on the request Parameters: - `cluster_name: String`: The name of the cluster. - `blacklist_type: String`: The type of blacklist. Refer to the `MQTTAclBlackListType` enum for specific values. - `resource_name: String`: The name of the resource. Returns: An empty struct.

  message DeleteBlacklistRequest

  mqtt.proto:561

  • string cluster_name = 1

    The name of the cluster.

  • string blacklist_type = 2

    The type of blacklist. Refer to the `MQTTAclBlackListType` enum for specific values.

  • string resource_name = 3

    The name of the resource.

  message DeleteBlacklistReply

  mqtt.proto:572

  (message has no fields)

• rpc DeleteConnector (DeleteConnectorRequest, DeleteConnectorReply)

  mqtt.proto:269

  message DeleteConnectorRequest

  mqtt.proto:664

  • string cluster_name = 1

  • string connector_name = 2

  message DeleteConnectorReply

  mqtt.proto:669

  (message has no fields)

• rpc DeleteSession (DeleteSessionRequest, DeleteSessionReply)

  mqtt.proto:93

  Deletes the corresponding session based on the request Parameters: - `cluster_name: String`: The name of the cluster. - `client_id: String`: The id of the client. Returns: An empty struct.

  message DeleteSessionRequest

  mqtt.proto:476

  • string cluster_name = 1

    The name of the cluster.

  • string client_id = 2

    The id of the client.

  message DeleteSessionReply

  mqtt.proto:484

  (message has no fields)

• rpc DeleteSubscribe (DeleteSubscribeRequest, DeleteSubscribeReply)

  mqtt.proto:261

  message DeleteSubscribeRequest

  mqtt.proto:623

  • string cluster_name = 1

  • string client_id = 2

  • string path = 3

  message DeleteSubscribeReply

  mqtt.proto:629

  (message has no fields)

• rpc DeleteTopic (DeleteTopicRequest, DeleteTopicReply)

  mqtt.proto:133

  Deletes the corresponding topic based on the request Parameters: - `cluster_name: String`: The name of the cluster. - `topic_name: String`: The name of the topic. Returns: An empty struct.

  message DeleteTopicRequest

  mqtt.proto:386

  • string cluster_name = 1

    The name of the cluster.

  • string topic_name = 2

    The name of the topic.

  message DeleteTopicReply

  mqtt.proto:394

  (message has no fields)

• rpc DeleteTopicRewriteRule (DeleteTopicRewriteRuleRequest, DeleteTopicRewriteRuleReply)

  mqtt.proto:247

  Delete a topic rewrite rule. Parameters: - `cluster_name: String`: The name of the cluster. - `action: String`: The action of the rewrite rule, one of the publish|subscribe|all. - `source_topic: String`: The source topic of the rewrite rule. Returns: An empty struct.

  message DeleteTopicRewriteRuleRequest

  mqtt.proto:593

  • string cluster_name = 1

    The cluster of the rewrite rule.

  • string action = 2

    The action of the rewrite rule, one of the publish|subscribe|all.

  • string source_topic = 3

    The source topic of the rewrite rule.

  message DeleteTopicRewriteRuleReply

  mqtt.proto:602

  (message has no fields)

• rpc DeleteUser (DeleteUserRequest, DeleteUserReply)

  mqtt.proto:50

  Deletes the corresponding user based on the request Parameters: - `cluster_name: String`: The name of the cluster. - `user_name: String`: The name of the user. Returns: An empty struct.

  message DeleteUserRequest

  mqtt.proto:350

  • string cluster_name = 1

    The name of the cluster.

  • string user_name = 2

    The name of the user.

  message DeleteUserReply

  mqtt.proto:358

  (message has no fields)

• rpc GetLastWillMessage (GetLastWillMessageRequest, GetLastWillMessageReply)

  mqtt.proto:170

  message GetLastWillMessageRequest

  mqtt.proto:499

  • string cluster_name = 1

    The name of the cluster.

  • string client_id = 2

    The id of the client.

  message GetLastWillMessageReply

  mqtt.proto:507

  • bytes message = 1

• rpc GetShareSubLeader (GetShareSubLeaderRequest, GetShareSubLeaderReply)

  mqtt.proto:158

  Gets the share sub leader based on the request Parameters: - `group_name: String`: The name of the group. - `cluster_name: String`: The name of the cluster. Returns: - `broker_id: u64`: The ip address of the broker - `broker_addr: String`: The ip address of the broker - `extend_info: String`: The parameter for the extended information of the broker node.

  message GetShareSubLeaderRequest

  mqtt.proto:305

  • string group_name = 1

    The name of the group.

  • string cluster_name = 2

    The name of the cluster.

  message GetShareSubLeaderReply

  mqtt.proto:313

  • uint64 broker_id = 1

    The id of the broker.

  • string broker_addr = 2

    The ip address of the broker

  • bytes extend_info = 3

    The parameter for the extended information of the broker node.

• rpc GetTopicRetainMessage (GetTopicRetainMessageRequest, GetTopicRetainMessageReply)

  mqtt.proto:146

  message GetTopicRetainMessageRequest

  mqtt.proto:412

  • string cluster_name = 1

    The name of the cluster.

  • string topic_name = 2

    The name of the topic.

  message GetTopicRetainMessageReply

  mqtt.proto:420

  • optional bytes retain_message = 1

    The parameter contains retain message, encoded from a `MQTTMessage` object into a binary format.

  • uint64 retain_message_expired_at = 2

    The parameter is the expiration time of the retain message. The unit is seconds.

• rpc ListAcl (ListAclRequest, ListAclReply)

  mqtt.proto:179

  Returns a list of ACLs based on the parameters of the request Parameters: - `cluster_name: String`: The name of the cluster. Returns: - `acls: Vec<Vec<u8>>`: It's the result of encoding a `Vec<MQTTAcl>` into a binary format.

  message ListAclRequest

  mqtt.proto:511

  • string cluster_name = 1

    The name of the cluster.

  message ListAclReply

  mqtt.proto:516

  • repeated bytes acls = 2

    The parameter contains a list of acls, encoded from a `Vec<MQTTAcl>` into a binary format.

• rpc ListAutoSubscribeRule (ListAutoSubscribeRuleRequest, ListAutoSubscribeRuleReply)

  mqtt.proto:302

  List auto subscribe rules. Parameters: - `cluster_name: String`: The name of the cluster. Returns: - `auto_subscribe_rules Vec<MQTTAutoSubscribeRule>`: It's the result of encoding a `Vec<MQTTAutoSubscribeRule>` into a binary format.

  message ListAutoSubscribeRuleRequest

  mqtt.proto:717

  • string cluster_name = 1

    The name of the cluster.

  message ListAutoSubscribeRuleReply

  mqtt.proto:722

  • repeated bytes auto_subscribe_rules = 1

    The parameter contains a list of users, encoded from a `Vec<MQTTAutoSubscribeRule>` into a binary format.

• rpc ListBlacklist (ListBlacklistRequest, ListBlacklistReply)

  mqtt.proto:206

  Returns a list of blacklist based on the parameters of the request Parameters: - `cluster_name: String`: The name of the cluster. Returns: - `blacklists: Vec<Vec<u8>>`: It's the result of encoding a `Vec<MQTTAclBlackList>` into a binary format.

  message ListBlacklistRequest

  mqtt.proto:541

  • string cluster_name = 1

    The name of the cluster.

  message ListBlacklistReply

  mqtt.proto:546

  • repeated bytes blacklists = 2

    The parameter contains a list of blacklist, encoded from a `Vec<MQTTAclBlackList>` into a binary format.

• rpc ListConnectors (ListConnectorRequest, ListConnectorReply)

  mqtt.proto:263

  message ListConnectorRequest

  mqtt.proto:639

  • string cluster_name = 1

  • string connector_name = 2

  message ListConnectorReply

  mqtt.proto:644

  • repeated bytes connectors = 1

• rpc ListSession (ListSessionRequest, ListSessionReply)

  mqtt.proto:60

  Returns a list of sessions based on the parameters of the request Parameters: - `cluster_name: String`: The name of the cluster. - `client_id: String` (Option): The id of the client. Returns: - `sessions: Vec<Vec<u8>>`: It's the result of encoding a `Vec<MQTTSession>` into a binary format.

  message ListSessionRequest

  mqtt.proto:428

  • string cluster_name = 1

    The name of the cluster.

  • string client_id = 2

    The id of the client.

  message ListSessionReply

  mqtt.proto:436

  • repeated bytes sessions = 1

    The parameter contains a list of sessions, encoded from a `Vec<MQTTSession>` into a binary format.

• rpc ListSubscribe (ListSubscribeRequest, ListSubscribeReply)

  mqtt.proto:257

  message ListSubscribeRequest

  mqtt.proto:631

  • string cluster_name = 1

  message ListSubscribeReply

  mqtt.proto:635

  • repeated bytes subscribes = 1

• rpc ListTopic (ListTopicRequest, stream ListTopicReply)

  mqtt.proto:114

  message ListTopicRequest

  mqtt.proto:360

  • string cluster_name = 1

    The name of the cluster.

  • string topic_name = 2

    The name of the topic.

  message ListTopicReply

  mqtt.proto:368

  • bytes topic = 1

    stream topics

• rpc ListTopicRewriteRule (ListTopicRewriteRuleRequest, ListTopicRewriteRuleReply)

  mqtt.proto:255

  List topic rewrite rules. Parameters: - `cluster_name: String`: The name of the cluster. - `topic_rewrite_rules Vec<MQTTTopicRewriteRule>`: It's the result of encoding a `Vec<MQTTTopicRewriteRule>` into a binary format.

  message ListTopicRewriteRuleRequest

  mqtt.proto:604

  • string cluster_name = 1

    The name of the cluster.

  message ListTopicRewriteRuleReply

  mqtt.proto:609

  • repeated bytes topic_rewrite_rules = 1

    The parameter contains a list of users, encoded from a `Vec<MQTTTopicRewriteRule>` into a binary format.

• rpc ListUser (ListUserRequest, ListUserReply)

  mqtt.proto:31

  Returns a list of users based on the parameters of the request Parameters: - `cluster_name: String`: The name of the cluster. - `user_name: String` (Option): The name of the user. Returns: - `users: Vec<Vec<u8>>`: It's the result of encoding a `Vec<MQTTUser>` into a binary format.

  message ListUserRequest

  mqtt.proto:324

  • string cluster_name = 1

    The name of the cluster.

  • string user_name = 2

    The name of the user.

  message ListUserReply

  mqtt.proto:332

  • repeated bytes users = 1

    The parameter contains a list of users, encoded from a `Vec<MQTTTopic>` into a binary format.

• rpc SaveLastWillMessage (SaveLastWillMessageRequest, SaveLastWillMessageReply)

  mqtt.proto:168

  Saves the client's will message based on request Parameters: - `cluster_name: String`: The name of the cluster. - `client_id: String`: The id of the client. - `last_will_message: Vec<u8>`: The parameter contains last will message, encoded from a `LastWillData` object into a binary format. Returns: An empty struct.

  message SaveLastWillMessageRequest

  mqtt.proto:486

  • string cluster_name = 1

    The name of the cluster.

  • string client_id = 2

    The id of the client.

  • bytes last_will_message = 3

    The parameter contains last will message, encoded from a `LastWillData` object into a binary format.

  message SaveLastWillMessageReply

  mqtt.proto:497

  (message has no fields)

• rpc SetAutoSubscribeRule (SetAutoSubscribeRuleRequest, SetAutoSubscribeRuleReply)

  mqtt.proto:284

  Sets a auto subscribe rule for the cluster Parameters: - `cluster_name: String`: The name of the cluster. - `topic: String`: The name of the topic. - `qos: u8`: The qos of this subscribe. - `no_local: bool`: If you subscribe to a topic from which you publish messages, you will receive all messages you publish. - `retain_as_published: bool`: This option specifies whether the server should retain the RETAIN flag when forwarding messages to clients. - `retained_handling: u8`: This option specifies whether the server should retain the RETAIN flag when forwarding messages to clients. Returns: An empty struct.

  message SetAutoSubscribeRuleRequest

  mqtt.proto:685

  • string cluster_name = 1

    The cluster of the auto subscribe rule

  • string topic = 2

    The topic of the auto subscribe rule.

  • uint32 qos = 3

    The qos of the auto subscribe rule.

  • bool no_local = 4

    The no local of the auto subscribe rule.

  • bool retain_as_published = 5

    The retain sa published of the auto subscribe rule.

  • uint32 retained_handling = 6

    The retained handling of the auto subscribe rule.

  message SetAutoSubscribeRuleReply

  mqtt.proto:705

  (message has no fields)

• rpc SetSubscribe (SetSubscribeRequest, SetSubscribeReply)

  mqtt.proto:259

  message SetSubscribeRequest

  mqtt.proto:614

  • string cluster_name = 1

  • string client_id = 3

  • string path = 4

  • bytes subscribe = 5

  message SetSubscribeReply

  mqtt.proto:621

  (message has no fields)

• rpc SetTopicRetainMessage (SetTopicRetainMessageRequest, SetTopicRetainMessageReply)

  mqtt.proto:144

  Sets the retain message for the corresponding topic based on the request Parameters: - `cluster_name: String`: The name of the cluster. - `topic_name: String`: The name of the topic. - `retain_message: Vec<u8>`: The parameter contains retain message, encoded from a `MQTTMessage` object into a binary format. - `retain_message_expired_at: u64`: The parameter is the expiration time of the retain message. The unit is seconds. Returns: An empty struct.

  message SetTopicRetainMessageRequest

  mqtt.proto:396

  • string cluster_name = 1

    The name of the cluster.

  • string topic_name = 2

    The name of the topic.

  • optional bytes retain_message = 3

    The parameter contains retain message, encoded from a `MQTTMessage` object into a binary format.

  • uint64 retain_message_expired_at = 4

    The parameter is the expiration time of the retain message. The unit is seconds.

  message SetTopicRetainMessageReply

  mqtt.proto:410

  (message has no fields)

• rpc UpdateConnector (UpdateConnectorRequest, UpdateConnectorReply)

  mqtt.proto:267

  message UpdateConnectorRequest

  mqtt.proto:656

  • string cluster_name = 1

  • string connector_name = 2

  • bytes connector = 3

  message UpdateConnectorReply

  mqtt.proto:662

  (message has no fields)

• rpc UpdateSession (UpdateSessionRequest, UpdateSessionReply)

  mqtt.proto:83

  Updates the corresponding session based on the request Parameters: - `cluster_name: String`: The name of the cluster. - `client_id: String`: The id of the client. - `connection_id: u64` (Option): The id of the connection. - `broker_id: u64` (Option): The id of the broker. - `reconnect_time: u64` (Option): The parameter is the time when session reconnects. The unit is seconds. - `distinct_time: u64` (Option): The parameter is the time when session disconnects. The unit is seconds. Returns: An empty struct.

  message UpdateSessionRequest

  mqtt.proto:454

  • string cluster_name = 1

    The name of the cluster.

  • string client_id = 2

    The id of the client.

  • uint64 connection_id = 3

    The id of the connection.

  • uint64 broker_id = 4

    The id of the broker.

  • uint64 reconnect_time = 5

    The parameter is the time when session reconnects. The unit is seconds.

  • uint64 distinct_time = 6

    The parameter is the time when session disconnects. The unit is seconds.

  message UpdateSessionReply

  mqtt.proto:474

  (message has no fields)

Used in: ConnectorHeartbeatRequest

• string connector_name = 1

• uint64 broker_id = 2

• uint64 heartbeat_time = 3