docs(gw): add zh docs
This commit is contained in:
JianBo He
parent
0f46d5ac02
commit
64ce6ba4c6
|
|
@ -3,56 +3,56 @@ emqx_coap_api {
|
|||
send_coap_request {
|
||||
desc {
|
||||
en: """Send a CoAP request message to the client"""
|
||||
zh: """ """
|
||||
zh: """发送 CoAP 消息到指定客户端"""
|
||||
}
|
||||
}
|
||||
|
||||
token {
|
||||
desc {
|
||||
en: """Message token, can be empty"""
|
||||
zh: """ """
|
||||
zh: """消息 Token, 可以为空"""
|
||||
}
|
||||
}
|
||||
|
||||
method {
|
||||
desc {
|
||||
en: """"Request method type"""
|
||||
zh: """ """
|
||||
zh: """请求 Method 类型"""
|
||||
}
|
||||
}
|
||||
|
||||
timeout {
|
||||
desc {
|
||||
en: """Timespan for response"""
|
||||
zh: """ """
|
||||
zh: """请求超时时间"""
|
||||
}
|
||||
}
|
||||
|
||||
content_type {
|
||||
desc {
|
||||
en: """"Payload type" """
|
||||
zh: """ """
|
||||
zh: """Payload 类型"""
|
||||
}
|
||||
}
|
||||
|
||||
payload {
|
||||
desc {
|
||||
en: """The content of the payload"""
|
||||
zh: """ """
|
||||
zh: """Payload 内容"""
|
||||
}
|
||||
}
|
||||
|
||||
message_id {
|
||||
desc {
|
||||
en: """Message ID"""
|
||||
zh: """ """
|
||||
zh: """消息 ID"""
|
||||
}
|
||||
}
|
||||
|
||||
response_code {
|
||||
desc {
|
||||
en: """Response code"""
|
||||
zh: """ """
|
||||
zh: """应答码"""
|
||||
}
|
||||
}
|
||||
}
|
||||
|
|
|
|||
|
|
@ -3,91 +3,91 @@ emqx_gateway_api_authn {
|
|||
get_authn {
|
||||
desc {
|
||||
en: """Get the gateway authentication"""
|
||||
zh: """ """
|
||||
zh: """获取指定网关认证器"""
|
||||
}
|
||||
}
|
||||
|
||||
update_authn {
|
||||
desc {
|
||||
en: """Update authentication for the gateway"""
|
||||
zh: """ """
|
||||
zh: """更新网关认证器"""
|
||||
}
|
||||
}
|
||||
|
||||
add_authn {
|
||||
desc {
|
||||
en: """Add authentication for the gateway"""
|
||||
zh: """ """
|
||||
zh: """为指定网关新增认证器"""
|
||||
}
|
||||
}
|
||||
|
||||
delete_authn {
|
||||
desc {
|
||||
en: """Remove the gateway authentication"""
|
||||
zh: """ """
|
||||
zh: """删除指定网关的认证器"""
|
||||
}
|
||||
}
|
||||
|
||||
list_users {
|
||||
desc {
|
||||
en: """Get the users for the authentication"""
|
||||
zh: """ """
|
||||
zh: """获取用户列表（仅支持 built_in_database 类型的认证器）"""
|
||||
}
|
||||
}
|
||||
|
||||
add_user {
|
||||
desc {
|
||||
en: """Add user for the authentication"""
|
||||
zh: """ """
|
||||
zh: """添加用户（仅支持 built_in_database 类型的认证器）"""
|
||||
}
|
||||
}
|
||||
|
||||
get_user {
|
||||
desc {
|
||||
en: """Get user info from the gateway authentication"""
|
||||
zh: """ """
|
||||
zh: """获取用户信息（仅支持 built_in_database 类型的认证器）"""
|
||||
}
|
||||
}
|
||||
|
||||
update_user {
|
||||
desc {
|
||||
en: """Update the user info for the gateway authentication"""
|
||||
zh: """ """
|
||||
zh: """更新用户信息（仅支持 built_in_database 类型的认证器）"""
|
||||
}
|
||||
}
|
||||
|
||||
delete_user {
|
||||
desc {
|
||||
en: """Delete the user for the gateway authentication"""
|
||||
zh: """ """
|
||||
zh: """删除用户（仅支持 built_in_database 类型的认证器）"""
|
||||
}
|
||||
}
|
||||
|
||||
import_users {
|
||||
desc {
|
||||
en: """Import users into the gateway authentication"""
|
||||
zh: """ """
|
||||
zh: """导入用户（仅支持 built_in_database 类型的认证器）"""
|
||||
}
|
||||
}
|
||||
|
||||
user_id {
|
||||
desc {
|
||||
en: """User ID"""
|
||||
zh: """ """
|
||||
zh: """用户 ID"""
|
||||
}
|
||||
}
|
||||
|
||||
like_username {
|
||||
desc {
|
||||
en: """Fuzzy search by username"""
|
||||
zh: """ """
|
||||
zh: """Username 模糊搜索"""
|
||||
}
|
||||
}
|
||||
|
||||
like_clientid{
|
||||
desc {
|
||||
en: """Fuzzy search by clientid"""
|
||||
zh: """ """
|
||||
zh: """Client ID 模糊搜索"""
|
||||
}
|
||||
}
|
||||
}
|
||||
|
|
|
|||
|
|
@ -3,505 +3,469 @@ emqx_gateway_api_clients {
|
|||
list_clients {
|
||||
desc {
|
||||
en: """Get the gateway client list"""
|
||||
zh: """ """
|
||||
zh: """获取指定网关的客户端列表"""
|
||||
}
|
||||
}
|
||||
|
||||
get_client {
|
||||
desc {
|
||||
en: """Get the gateway client information"""
|
||||
zh: """ """
|
||||
zh: """获取客户端信息"""
|
||||
}
|
||||
}
|
||||
|
||||
kick_client {
|
||||
desc {
|
||||
en: """Kick out the gateway client"""
|
||||
zh: """ """
|
||||
zh: """踢出指定客户端"""
|
||||
}
|
||||
}
|
||||
|
||||
list_subscriptions {
|
||||
desc {
|
||||
en: """Get the gateway client subscriptions"""
|
||||
zh: """ """
|
||||
zh: """获取某客户端的主题订阅列表"""
|
||||
}
|
||||
}
|
||||
|
||||
add_subscription {
|
||||
desc {
|
||||
en: """Create a subscription membership"""
|
||||
zh: """ """
|
||||
zh: """为某客户端新增订阅关系"""
|
||||
}
|
||||
}
|
||||
|
||||
delete_subscription {
|
||||
desc {
|
||||
en: """Delete a subscriptions membership"""
|
||||
zh: """ """
|
||||
zh: """为某客户端删除某订阅关系"""
|
||||
}
|
||||
}
|
||||
|
||||
param_node {
|
||||
desc {
|
||||
en: """Match the client's node name"""
|
||||
zh: """ """
|
||||
zh: """匹配客户端的节点名称"""
|
||||
}
|
||||
}
|
||||
|
||||
param_clientid {
|
||||
desc {
|
||||
en: """Match the client's ID"""
|
||||
zh: """ """
|
||||
zh: """匹配客户端 ID"""
|
||||
}
|
||||
}
|
||||
|
||||
param_username {
|
||||
desc {
|
||||
en: """Match the client's Username"""
|
||||
zh: """ """
|
||||
zh: """匹配客户端 Username"""
|
||||
}
|
||||
}
|
||||
|
||||
param_ip_address {
|
||||
desc {
|
||||
en: """Match the client's ip address"""
|
||||
zh: """ """
|
||||
zh: """匹配客户端 IP 地址"""
|
||||
}
|
||||
}
|
||||
|
||||
param_conn_state {
|
||||
desc {
|
||||
en: """Match the client's connection state"""
|
||||
zh: """ """
|
||||
zh: """匹配客户端连接状态"""
|
||||
}
|
||||
}
|
||||
|
||||
param_proto_ver {
|
||||
desc {
|
||||
en: """Match the client's protocol version"""
|
||||
zh: """ """
|
||||
zh: """匹配客户端协议版本"""
|
||||
}
|
||||
}
|
||||
|
||||
param_clean_start {
|
||||
desc {
|
||||
en: """Match the client's clean start flag"""
|
||||
zh: """ """
|
||||
zh: """匹配客户端 `clean_start` 标记"""
|
||||
}
|
||||
}
|
||||
|
||||
param_like_clientid {
|
||||
desc {
|
||||
en: """Use sub-string to match client's ID"""
|
||||
zh: """ """
|
||||
zh: """子串匹配客户端 ID"""
|
||||
}
|
||||
}
|
||||
|
||||
param_like_username {
|
||||
desc {
|
||||
en: """Use sub-string to match client's username"""
|
||||
zh: """ """
|
||||
zh: """子串匹配 客户端 Username"""
|
||||
}
|
||||
}
|
||||
|
||||
param_gte_created_at {
|
||||
desc {
|
||||
en: """Match the session created datetime greater than a certain value"""
|
||||
zh: """ """
|
||||
zh: """匹配会话创建时间大于等于指定值的客户端"""
|
||||
}
|
||||
}
|
||||
|
||||
param_lte_created_at {
|
||||
desc {
|
||||
en: """Match the session created datetime less than a certain value"""
|
||||
zh: """ """
|
||||
zh: """匹配会话创建时间小于等于指定值的客户端"""
|
||||
}
|
||||
}
|
||||
|
||||
param_gte_connected_at{
|
||||
desc {
|
||||
en: """Match the client socket connected datetime greater than a certain value"""
|
||||
zh: """ """
|
||||
zh: """匹配连接创建时间大于等于指定值的客户端"""
|
||||
}
|
||||
}
|
||||
|
||||
param_lte_connected_at {
|
||||
desc {
|
||||
en: """Match the client socket connected datatime less than a certain value"""
|
||||
zh: """ """
|
||||
zh: """匹配连接创建时间小于等于指定值的客户端"""
|
||||
}
|
||||
}
|
||||
|
||||
param_endpoint_name {
|
||||
desc {
|
||||
en: """Match the lwm2m client's endpoint name"""
|
||||
zh: """ """
|
||||
zh: """匹配 LwM2M 客户端 Endpoint Name"""
|
||||
}
|
||||
}
|
||||
|
||||
param_like_endpoint_name {
|
||||
desc {
|
||||
en: """Use sub-string to match lwm2m client's endpoint name"""
|
||||
zh: """ """
|
||||
zh: """子串匹配 LwM2M 客户端 Endpoint Name"""
|
||||
}
|
||||
}
|
||||
|
||||
param_gte_lifetime {
|
||||
desc {
|
||||
en: """Match the lwm2m client registered lifetime greater than a certain value"""
|
||||
zh: """ """
|
||||
zh: """匹配心跳时间大于等于指定值的 LwM2M 客户端"""
|
||||
}
|
||||
}
|
||||
|
||||
param_lte_lifetime {
|
||||
desc {
|
||||
en: """Match the lwm2m client registered lifetime less than a certain value"""
|
||||
zh: """ """
|
||||
zh: """匹配心跳时间小于等于指定值的 LwM2M 客户端"""
|
||||
}
|
||||
}
|
||||
|
||||
clientid {
|
||||
desc {
|
||||
en: """Client ID"""
|
||||
zh: """ """
|
||||
zh: """客户端 ID"""
|
||||
}
|
||||
}
|
||||
|
||||
topic {
|
||||
desc {
|
||||
en: """Topic Filter/Name"""
|
||||
zh: """ """
|
||||
zh: """主题过滤器或主题名称"""
|
||||
}
|
||||
}
|
||||
|
||||
endpoint_name {
|
||||
desc {
|
||||
en: """The LwM2M client endpoint name"""
|
||||
zh: """ """
|
||||
zh: """LwM2M 客户端 Endpoint Name"""
|
||||
}
|
||||
}
|
||||
|
||||
lifetime {
|
||||
desc {
|
||||
en: """Life time"""
|
||||
zh: """ """
|
||||
en: """LwM2M Life time"""
|
||||
zh: """LwM2M 客户端心跳周期"""
|
||||
}
|
||||
}
|
||||
|
||||
qos {
|
||||
desc {
|
||||
en: """QoS level, enum: 0, 1, 2"""
|
||||
zh: """ """
|
||||
zh: """QoS 等级，枚举：0，1，2"""
|
||||
}
|
||||
}
|
||||
|
||||
nl {
|
||||
desc {
|
||||
en: """No Local option, enum: 0, 1"""
|
||||
zh: """ """
|
||||
zh: """No Local 选项，枚举：0，1"""
|
||||
}
|
||||
}
|
||||
|
||||
rap {
|
||||
desc {
|
||||
en: """Retain as Published option, enum: 0, 1"""
|
||||
zh: """ """
|
||||
zh: """Retain as Published 选项，枚举：0，1"""
|
||||
}
|
||||
}
|
||||
|
||||
rh {
|
||||
desc {
|
||||
en: """Retain Handling option, enum: 0, 1, 2"""
|
||||
zh: """ """
|
||||
zh: """Retain Handling 选项，枚举：0，1，2"""
|
||||
}
|
||||
}
|
||||
|
||||
sub_props {
|
||||
desc {
|
||||
en: """Subscription properties"""
|
||||
zh: """ """
|
||||
zh: """订阅属性"""
|
||||
}
|
||||
}
|
||||
|
||||
subid {
|
||||
desc {
|
||||
en: """Only stomp protocol, a unique identity for the subscription. range: 1-65535."""
|
||||
zh: """ """
|
||||
zh: """订阅ID，仅用于 Stomp 网关。用于创建订阅关系时指定订阅 ID。取值范围 1-65535。"""
|
||||
}
|
||||
}
|
||||
|
||||
node {
|
||||
desc {
|
||||
en: """Name of the node to which the client is connected"""
|
||||
zh: """ """
|
||||
zh: """客户端连接到的节点名称"""
|
||||
}
|
||||
}
|
||||
|
||||
username {
|
||||
desc {
|
||||
en: """Username of client when connecting"""
|
||||
zh: """ """
|
||||
zh: """客户端连接的用户名"""
|
||||
}
|
||||
}
|
||||
|
||||
proto_name {
|
||||
desc {
|
||||
en: """Client protocol name"""
|
||||
zh: """ """
|
||||
zh: """客户端使用的协议名称"""
|
||||
}
|
||||
}
|
||||
|
||||
proto_ver {
|
||||
desc {
|
||||
en: """Protocol version used by the client"""
|
||||
zh: """ """
|
||||
zh: """客户端使用的协议版本"""
|
||||
}
|
||||
}
|
||||
|
||||
ip_address {
|
||||
desc {
|
||||
en: """Client's IP address"""
|
||||
zh: """ """
|
||||
zh: """客户端 IP 地址"""
|
||||
}
|
||||
}
|
||||
|
||||
port {
|
||||
desc {
|
||||
en: """Client's port"""
|
||||
zh: """ """
|
||||
zh: """客户端端口"""
|
||||
}
|
||||
}
|
||||
|
||||
is_bridge {
|
||||
desc {
|
||||
en: """Indicates whether the client is connected via bridge"""
|
||||
zh: """ """
|
||||
zh: """标识客户端是否通过 is_bridge 标志连接"""
|
||||
}
|
||||
}
|
||||
|
||||
connected_at {
|
||||
desc {
|
||||
en: """Client connection time"""
|
||||
zh: """ """
|
||||
zh: """客户端连接时间"""
|
||||
}
|
||||
}
|
||||
|
||||
disconnected_at {
|
||||
desc {
|
||||
en: """Client offline time, This field is only valid and returned when connected is false"""
|
||||
zh: """ """
|
||||
zh: """客户端连接断开时间"""
|
||||
}
|
||||
}
|
||||
|
||||
connected {
|
||||
desc {
|
||||
en: """Whether the client is connected"""
|
||||
zh: """ """
|
||||
zh: """标识客户端是否已连接到网关"""
|
||||
}
|
||||
}
|
||||
|
||||
keepalive {
|
||||
desc {
|
||||
en: """keepalive time, with the unit of second"""
|
||||
zh: """ """
|
||||
en: """Keepalive time, with the unit of second"""
|
||||
zh: """Keepalive 时间，单位：秒"""
|
||||
}
|
||||
}
|
||||
|
||||
clean_start {
|
||||
desc {
|
||||
en: """Indicate whether the client is using a brand new session"""
|
||||
zh: """ """
|
||||
zh: """标识客户端是否以 clean_start 的标志连接到网关"""
|
||||
}
|
||||
}
|
||||
|
||||
expiry_interval {
|
||||
desc {
|
||||
en: """Session expiration interval, with the unit of second"""
|
||||
zh: """ """
|
||||
zh: """会话超期时间，单位：秒"""
|
||||
}
|
||||
}
|
||||
|
||||
created_at {
|
||||
desc {
|
||||
en: """Session creation time"""
|
||||
zh: """ """
|
||||
zh: """会话创建时间"""
|
||||
}
|
||||
}
|
||||
|
||||
subscriptions_cnt {
|
||||
desc {
|
||||
en: """Number of subscriptions established by this client"""
|
||||
zh: """ """
|
||||
zh: """客户端已订阅主题数"""
|
||||
}
|
||||
}
|
||||
|
||||
subscriptions_max {
|
||||
desc {
|
||||
en: """Maximum number of subscriptions allowed by this client"""
|
||||
zh: """ """
|
||||
zh: """客户端允许订阅的最大主题数"""
|
||||
}
|
||||
}
|
||||
|
||||
inflight_cnt {
|
||||
desc {
|
||||
en: """Current length of inflight"""
|
||||
zh: """ """
|
||||
zh: """客户端当前飞行窗口大小"""
|
||||
}
|
||||
}
|
||||
|
||||
inflight_max {
|
||||
desc {
|
||||
en: """Maximum length of inflight"""
|
||||
zh: """ """
|
||||
zh: """客户端允许的飞行窗口最大值"""
|
||||
}
|
||||
}
|
||||
|
||||
mqueue_len {
|
||||
desc {
|
||||
en: """Current length of message queue"""
|
||||
zh: """ """
|
||||
zh: """客户端当前消息队列长度"""
|
||||
}
|
||||
}
|
||||
|
||||
mqueue_max {
|
||||
desc {
|
||||
en: """Maximum length of message queue"""
|
||||
zh: """ """
|
||||
zh: """客户端允许的最大消息队列长度"""
|
||||
}
|
||||
}
|
||||
|
||||
mqueue_dropped {
|
||||
desc {
|
||||
en: """Number of messages dropped by the message queue due to exceeding the length"""
|
||||
zh: """ """
|
||||
zh: """由于消息队列过程，客户端消息队列丢弃消息条数"""
|
||||
}
|
||||
}
|
||||
|
||||
awaiting_rel_cnt {
|
||||
desc {
|
||||
en: """Number of awaiting acknowledge packet"""
|
||||
zh: """ """
|
||||
zh: """客户端当前等待 PUBREL 确认的 PUBREC 消息的条数"""
|
||||
}
|
||||
}
|
||||
|
||||
awaiting_rel_max {
|
||||
desc {
|
||||
en: """Maximum allowed number of awaiting PUBREC packet"""
|
||||
zh: """ """
|
||||
zh: """客户端允许的最大 PUBREC 等待队列长度"""
|
||||
}
|
||||
}
|
||||
|
||||
recv_oct {
|
||||
desc {
|
||||
en: """Number of bytes received"""
|
||||
zh: """ """
|
||||
zh: """已接收的字节数"""
|
||||
}
|
||||
}
|
||||
|
||||
recv_cnt {
|
||||
desc {
|
||||
en: """Number of socket packets received"""
|
||||
zh: """ """
|
||||
zh: """已接收 Socket 报文次数"""
|
||||
}
|
||||
}
|
||||
|
||||
recv_pkt {
|
||||
desc {
|
||||
en: """Number of protocol packets received"""
|
||||
zh: """ """
|
||||
zh: """已接收应用层协议控制报文数"""
|
||||
}
|
||||
}
|
||||
|
||||
recv_msg {
|
||||
desc {
|
||||
en: """Number of message packets received"""
|
||||
zh: """ """
|
||||
zh: """已接收上行的消息条数"""
|
||||
}
|
||||
}
|
||||
|
||||
send_oct {
|
||||
desc {
|
||||
en: """Number of bytes sent"""
|
||||
zh: """ """
|
||||
zh: """已发送字节数"""
|
||||
}
|
||||
}
|
||||
|
||||
send_cnt {
|
||||
desc {
|
||||
en: """Number of socket packets sent"""
|
||||
zh: """ """
|
||||
zh: """已发送 Socket 报文次数"""
|
||||
}
|
||||
}
|
||||
|
||||
send_pkt {
|
||||
desc {
|
||||
en: """Number of protocol packets sent"""
|
||||
zh: """ """
|
||||
zh: """已发送应用层协议控制报文数"""
|
||||
}
|
||||
}
|
||||
|
||||
send_msg {
|
||||
desc {
|
||||
en: """Number of message packets sent"""
|
||||
zh: """ """
|
||||
zh: """已发送下行消息数条数"""
|
||||
}
|
||||
}
|
||||
|
||||
mailbox_len {
|
||||
desc {
|
||||
en: """Process mailbox size"""
|
||||
zh: """ """
|
||||
zh: """进程邮箱大小"""
|
||||
}
|
||||
}
|
||||
|
||||
heap_size {
|
||||
desc {
|
||||
en: """Process heap size with the unit of byte"""
|
||||
zh: """ """
|
||||
zh: """进程堆内存大小，单位：字节"""
|
||||
}
|
||||
}
|
||||
|
||||
reductions {
|
||||
desc {
|
||||
en: """Erlang reduction"""
|
||||
zh: """ """
|
||||
zh: """进程已消耗 Reduction 数"""
|
||||
}
|
||||
}
|
||||
|
||||
endpoint_name {
|
||||
desc {
|
||||
en: """ """
|
||||
zh: """ """
|
||||
}
|
||||
}
|
||||
|
||||
endpoint_name {
|
||||
desc {
|
||||
en: """ """
|
||||
zh: """ """
|
||||
}
|
||||
}
|
||||
|
||||
endpoint_name {
|
||||
desc {
|
||||
en: """ """
|
||||
zh: """ """
|
||||
}
|
||||
}
|
||||
|
||||
endpoint_name {
|
||||
desc {
|
||||
en: """ """
|
||||
zh: """ """
|
||||
}
|
||||
}
|
||||
|
||||
endpoint_name {
|
||||
desc {
|
||||
en: """ """
|
||||
zh: """ """
|
||||
}
|
||||
}
|
||||
|
||||
}
|
||||
|
|
|
|||
|
|
@ -3,119 +3,119 @@ emqx_gateway_api {
|
|||
list_gateway {
|
||||
desc {
|
||||
en: """Get gateway list"""
|
||||
zh: """ """
|
||||
zh: """获取网关列表"""
|
||||
}
|
||||
}
|
||||
|
||||
enable_gateway {
|
||||
desc {
|
||||
en: """Enable a gateway"""
|
||||
zh: """ """
|
||||
zh: """启用某网关"""
|
||||
}
|
||||
}
|
||||
|
||||
get_gateway {
|
||||
desc {
|
||||
en: """Get the gateway configurations"""
|
||||
zh: """ """
|
||||
zh: """获取网关配置详情"""
|
||||
}
|
||||
}
|
||||
|
||||
delete_gateway {
|
||||
desc {
|
||||
en: """Delete/Unload the gateway"""
|
||||
zh: """ """
|
||||
zh: """删除/禁用某网关"""
|
||||
}
|
||||
}
|
||||
|
||||
update_gateway {
|
||||
desc {
|
||||
en: """Update the gateway configurations/status"""
|
||||
zh: """ """
|
||||
zh: """更新网关配置或启用状态"""
|
||||
}
|
||||
}
|
||||
|
||||
gateway_name {
|
||||
desc {
|
||||
en: """Gateway Name"""
|
||||
zh: """ """
|
||||
zh: """网关名称"""
|
||||
}
|
||||
}
|
||||
|
||||
gateway_status {
|
||||
desc {
|
||||
en: """Gateway Status"""
|
||||
zh: """ """
|
||||
zh: """网关启用状态"""
|
||||
}
|
||||
}
|
||||
|
||||
gateway_created_at {
|
||||
desc {
|
||||
en: """The Gateway created datetime"""
|
||||
zh: """ """
|
||||
zh: """网关创建时间"""
|
||||
}
|
||||
}
|
||||
|
||||
gateway_started_at {
|
||||
desc {
|
||||
en: """The Gateway started datetime"""
|
||||
zh: """ """
|
||||
zh: """网关启用时间"""
|
||||
}
|
||||
}
|
||||
|
||||
gateway_stopped_at {
|
||||
desc {
|
||||
en: """The Gateway stopped datetime"""
|
||||
zh: """ """
|
||||
zh: """网关停用时间"""
|
||||
}
|
||||
}
|
||||
|
||||
gateway_max_connections {
|
||||
desc {
|
||||
en: """The Gateway allowed maximum connections/clients"""
|
||||
zh: """ """
|
||||
zh: """最大连接数"""
|
||||
}
|
||||
}
|
||||
|
||||
gateway_current_connections {
|
||||
desc {
|
||||
en: """The Gateway current connected connections/clients"""
|
||||
zh: """ """
|
||||
zh: """当前连接数"""
|
||||
}
|
||||
}
|
||||
|
||||
gateway_listeners {
|
||||
desc {
|
||||
en: """The Gateway listeners overview"""
|
||||
zh: """ """
|
||||
zh: """网关监听器列表"""
|
||||
}
|
||||
}
|
||||
|
||||
gateway_listener_id {
|
||||
desc {
|
||||
en: """Listener ID"""
|
||||
zh: """ """
|
||||
zh: """监听器 ID"""
|
||||
}
|
||||
}
|
||||
|
||||
gateway_listener_name {
|
||||
desc {
|
||||
en: """Listener Name"""
|
||||
zh: """ """
|
||||
zh: """监听器名称"""
|
||||
}
|
||||
}
|
||||
|
||||
gateway_listener_running {
|
||||
desc {
|
||||
en: """Listener Running status"""
|
||||
zh: """ """
|
||||
zh: """监听器运行状态"""
|
||||
}
|
||||
}
|
||||
|
||||
gateway_listener_type {
|
||||
desc {
|
||||
en: """Listener Type"""
|
||||
zh: """ """
|
||||
zh: """监听器类型"""
|
||||
}
|
||||
}
|
||||
}
|
||||
|
|
|
|||
|
|
@ -3,112 +3,112 @@ emqx_gateway_api_listeners {
|
|||
list_listeners {
|
||||
desc {
|
||||
en: """Get the gateway listeners"""
|
||||
zh: """ """
|
||||
zh: """获取网关监听器列表"""
|
||||
}
|
||||
}
|
||||
|
||||
add_listener {
|
||||
desc {
|
||||
en: """Create the gateway listener"""
|
||||
zh: """ """
|
||||
zh: """为指定网关添加监听器"""
|
||||
}
|
||||
}
|
||||
|
||||
get_listener {
|
||||
desc {
|
||||
en: """Get the gateway listener configurations"""
|
||||
zh: """ """
|
||||
zh: """获取指定监听器信息"""
|
||||
}
|
||||
}
|
||||
|
||||
delete_listener {
|
||||
desc {
|
||||
en: """Delete the gateway listener"""
|
||||
zh: """ """
|
||||
zh: """删除监听器"""
|
||||
}
|
||||
}
|
||||
|
||||
update_listener {
|
||||
desc {
|
||||
en: """Update the gateway listener"""
|
||||
zh: """ """
|
||||
zh: """更新监听器"""
|
||||
}
|
||||
}
|
||||
|
||||
get_listener_authn {
|
||||
desc {
|
||||
en: """Get the listener's authentication info"""
|
||||
zh: """ """
|
||||
zh: """获取监听器的认证器信息"""
|
||||
}
|
||||
}
|
||||
|
||||
add_listener_authn {
|
||||
desc {
|
||||
en: """Add authentication for the listener"""
|
||||
zh: """ """
|
||||
zh: """为指定监听器添加认证器"""
|
||||
}
|
||||
}
|
||||
|
||||
update_listener_authn {
|
||||
desc {
|
||||
en: """Update authentication for the listener"""
|
||||
zh: """ """
|
||||
zh: """更新指定监听上的认证器配置"""
|
||||
}
|
||||
}
|
||||
|
||||
delete_listener_authn {
|
||||
desc {
|
||||
en: """Remove authentication for the listener"""
|
||||
zh: """ """
|
||||
zh: """为指定监听器移除认证器"""
|
||||
}
|
||||
}
|
||||
|
||||
list_users {
|
||||
desc {
|
||||
en: """Get the users for the authentication"""
|
||||
zh: """ """
|
||||
zh: """获取用户列表（仅支持 built_in_database 类型的认证器）"""
|
||||
}
|
||||
}
|
||||
|
||||
add_user {
|
||||
desc {
|
||||
en: """Add user for the authentication"""
|
||||
zh: """ """
|
||||
zh: """添加用户（仅支持 built_in_database 类型的认证器）"""
|
||||
}
|
||||
}
|
||||
|
||||
get_user {
|
||||
desc {
|
||||
en: """Get user info from the gateway authentication"""
|
||||
zh: """ """
|
||||
zh: """获取用户信息（仅支持 built_in_database 类型的认证器）"""
|
||||
}
|
||||
}
|
||||
|
||||
update_user {
|
||||
desc {
|
||||
en: """Update the user info for the gateway authentication"""
|
||||
zh: """ """
|
||||
zh: """更新用户信息（仅支持 built_in_database 类型的认证器）"""
|
||||
}
|
||||
}
|
||||
|
||||
delete_user {
|
||||
desc {
|
||||
en: """Delete the user for the gateway authentication"""
|
||||
zh: """ """
|
||||
zh: """删除用户（仅支持 built_in_database 类型的认证器）"""
|
||||
}
|
||||
}
|
||||
|
||||
import_users {
|
||||
desc {
|
||||
en: """Import users into the gateway authentication"""
|
||||
zh: """ """
|
||||
zh: """导入用户（仅支持 built_in_database 类型的认证器）"""
|
||||
}
|
||||
}
|
||||
|
||||
listener_id {
|
||||
desc {
|
||||
en: """Listener ID"""
|
||||
zh: """ """
|
||||
zh: """监听器 ID"""
|
||||
}
|
||||
}
|
||||
}
|
||||
|
|
|
|||
|
|
@ -11,21 +11,21 @@ This gateway supports v1.2/1.1/1.0"""
|
|||
stom_frame_max_headers {
|
||||
desc {
|
||||
en: """The maximum number of Header"""
|
||||
zh: """ """
|
||||
zh: """允许的 Header 最大数量"""
|
||||
}
|
||||
}
|
||||
|
||||
stomp_frame_max_headers_length {
|
||||
desc {
|
||||
en: """The maximum string length of the Header Value"""
|
||||
zh: """ """
|
||||
zh: """允许的 Header 字符串的最大长度"""
|
||||
}
|
||||
}
|
||||
|
||||
stom_frame_max_body_length {
|
||||
desc {
|
||||
en: """Maximum number of bytes of Body allowed per Stomp packet"""
|
||||
zh: """ """
|
||||
zh: """允许的 Stomp 报文 Body 的最大字节数"""
|
||||
}
|
||||
}
|
||||
|
||||
|
|
@ -41,14 +41,15 @@ This gateway only supports the v1.2 protocol"""
|
|||
desc {
|
||||
en: """MQTT-SN Gateway ID.
|
||||
When the <code>broadcast</code> option is enabled, the gateway will broadcast ADVERTISE message with this value"""
|
||||
zh: """ """
|
||||
zh: """MQTT-SN 网关 ID。
|
||||
当 <code>broadcast</code> 打开时，MQTT-SN 网关会使用该 ID 来广播 ADVERTISE 消息"""
|
||||
}
|
||||
}
|
||||
|
||||
mqttsn_broadcast {
|
||||
desc {
|
||||
en: """Whether to periodically broadcast ADVERTISE messages"""
|
||||
zh: """ """
|
||||
zh: """是否周期性广播 ADVERTISE 消息 """
|
||||
}
|
||||
}
|
||||
|
||||
|
|
@ -56,14 +57,15 @@ When the <code>broadcast</code> option is enabled, the gateway will broadcast AD
|
|||
desc {
|
||||
en: """Allows connectionless clients to publish messages with a Qos of -1.
|
||||
This feature is defined for very simple client implementations which do not support any other features except this one. There is no connection setup nor tear down, no registration nor subscription. The client just sends its 'PUBLISH' messages to a GW"""
|
||||
zh: """ """
|
||||
zh: """是否允许无连接的客户端发送 QoS 等于 -1 的消息。
|
||||
该功能主要用于支持轻量的 MQTT-SN 客户端实现，它不会向网关建立连接，注册主题，也不会发起订阅；它只使用 QoS 为 -1 来发布消息"""
|
||||
}
|
||||
}
|
||||
|
||||
mqttsn_subs_resume {
|
||||
desc {
|
||||
en: """Whether to initiate all subscribed topic name registration messages to the client after the Session has been taken over by a new channel"""
|
||||
zh: """ """
|
||||
zh: """在会话被重用后，网关是否主动向客户端注册对已订阅主题名称"""
|
||||
}
|
||||
}
|
||||
|
||||
|
|
@ -71,29 +73,31 @@ This feature is defined for very simple client implementations which do not supp
|
|||
desc {
|
||||
en: """The pre-defined topic IDs and topic names.
|
||||
A 'pre-defined' topic ID is a topic ID whose mapping to a topic name is known in advance by both the client's application and the gateway"""
|
||||
zh: """ """
|
||||
zh: """预定义主题列表。
|
||||
预定义的主题列表，是一组 主题 ID 和 主题名称 的映射关系。使用预先定义的主题列表，可以减少 MQTT-SN 客户端和网关对于固定主题的注册请求"""
|
||||
}
|
||||
}
|
||||
|
||||
mqttsn_predefined_id {
|
||||
desc {
|
||||
en: """Topic ID.<br>Range: 1-65535"""
|
||||
zh: """ """
|
||||
en: """Topic ID. Range: 1-65535"""
|
||||
zh: """主题 ID。范围：1-65535 """
|
||||
}
|
||||
}
|
||||
|
||||
mqttsn_predefined_topic {
|
||||
desc {
|
||||
en: """Topic Name"""
|
||||
zh: """ """
|
||||
zh: """主题名称。注：不支持通配符"""
|
||||
}
|
||||
}
|
||||
|
||||
coap {
|
||||
desc {
|
||||
en: """The CoAP Gateway configuration.<br>\n
|
||||
en: """The CoAP Gateway configuration.
|
||||
This gateway is implemented based on RFC-7252 and https://core-wg.github.io/coap-pubsub/draft-ietf-core-pubsub.html"""
|
||||
zh: """ """
|
||||
zh: """CoAP 网关配置。
|
||||
该网关的实现基于 RFC-7252 和 https://core-wg.github.io/coap-pubsub/draft-ietf-core-pubsub.html"""
|
||||
}
|
||||
}
|
||||
|
||||
|
|
@ -101,7 +105,8 @@ This gateway is implemented based on RFC-7252 and https://core-wg.github.io/coap
|
|||
desc {
|
||||
en: """The gateway server required minimum heartbeat interval.
|
||||
When connection mode is enabled, this parameter is used to set the minimum heartbeat interval for the connection to be alive"""
|
||||
zh: """ """
|
||||
zh: """CoAP 网关要求客户端的最小心跳间隔时间。
|
||||
当 <code>connection_required</code> 开启后，该参数用于检查客户端连接是否存活"""
|
||||
}
|
||||
}
|
||||
|
||||
|
|
@ -109,7 +114,8 @@ When connection mode is enabled, this parameter is used to set the minimum heart
|
|||
desc {
|
||||
en: """Enable or disable connection mode.
|
||||
Connection mode is a feature of non-standard protocols. When connection mode is enabled, it is necessary to maintain the creation, authentication and alive of connection resources"""
|
||||
zh: """ """
|
||||
zh: """是否开启连接模式。
|
||||
连接模式是非标准协议的功能。它维护 CoAP 客户端上线、认证、和连接状态的保持"""
|
||||
}
|
||||
}
|
||||
|
||||
|
|
@ -117,10 +123,15 @@ Connection mode is a feature of non-standard protocols. When connection mode is
|
|||
desc {
|
||||
en: """The Notification Message will be delivered to the CoAP client if a new message received on an observed topic.
|
||||
The type of delivered coap message can be set to:
|
||||
1. non: Non-confirmable;
|
||||
2. con: Confirmable;
|
||||
3. qos: Mapping from QoS type of received message, QoS0 -> non, QoS1,2 -> con"""
|
||||
zh: """ """
|
||||
- non: Non-confirmable;
|
||||
- con: Confirmable;
|
||||
- qos: Mapping from QoS type of received message, QoS0 -> non, QoS1,2 -> con
|
||||
"""
|
||||
zh: """投递给 CoAP 客户端的通知消息类型。当客户端 Observe 一个资源（或订阅某个主题）时，网关会向客户端推送新产生的消息。其消息类型可设置为：
|
||||
- non: 不需要客户端返回确认消息;
|
||||
- con: 需要客户端返回一个确认消息;
|
||||
- qos: 取决于消息的 QoS 等级; QoS 0 会以 `non` 类型下发，QoS 1/2 会以 `con` 类型下发
|
||||
"""
|
||||
}
|
||||
}
|
||||
|
||||
|
|
@ -131,9 +142,15 @@ This option specifies the QoS level for the CoAP Client when establishing a subs
|
|||
- qos0, qos1, qos2: Fixed default QoS level
|
||||
- coap: Dynamic QoS level by the message type of subscribe request
|
||||
* qos0: If the subscribe request is non-confirmable
|
||||
* qos1: If the subscribe request is confirmable"""
|
||||
|
||||
zh: """ """
|
||||
* qos1: If the subscribe request is confirmable
|
||||
"""
|
||||
zh: """客户端订阅请求的默认 QoS 等级。
|
||||
当 CoAP 客户端发起订阅请求时，如果未携带 `qos` 参数则会使用该默认值。默认值可设置为：
|
||||
- qos0, qos1, qos2: 设置为固定的 QoS 等级
|
||||
- coap: 依据订阅操作的 CoAP 报文类型来动态决定
|
||||
* 当订阅请求为 `non-confirmable` 类型时，取值为 qos0
|
||||
* 当订阅请求为 `confirmable` 类型时，取值为 qos1
|
||||
"""
|
||||
}
|
||||
}
|
||||
|
||||
|
|
@ -146,36 +163,41 @@ This option specifies the QoS level for the CoAP Client when publishing a messag
|
|||
* qos0: If the publish request is non-confirmable
|
||||
* qos1: If the publish request is confirmable"""
|
||||
|
||||
zh: """ """
|
||||
zh: """客户端发布请求的默认 QoS 等级。
|
||||
当 CoAP 客户端发起发布请求时，如果未携带 `qos` 参数则会使用该默认值。默认值可设置为：
|
||||
- qos0, qos1, qos2: 设置为固定的 QoS 等级
|
||||
- coap: 依据发布操作的 CoAP 报文类型来动态决定
|
||||
* 当发布请求为 `non-confirmable` 类型时，取值为 qos0
|
||||
* 当发布请求为 `confirmable` 类型时，取值为 qos1
|
||||
"""
|
||||
}
|
||||
}
|
||||
|
||||
lwm2m {
|
||||
desc {
|
||||
en: """The LwM2M Gateway configuration.
|
||||
This gateway only supports the v1.0.1 protocol"""
|
||||
zh: """ """
|
||||
en: """The LwM2M Gateway configuration. This gateway only supports the v1.0.1 protocol"""
|
||||
zh: """LwM2M 网关配置。仅支持 v1.0.1 协议"""
|
||||
}
|
||||
}
|
||||
|
||||
lwm2m_xml_dir {
|
||||
desc {
|
||||
en: """The Directory for LwM2M Resource definition"""
|
||||
zh: """ """
|
||||
zh: """LwM2M Resource 定义的 XML 文件目录路径"""
|
||||
}
|
||||
}
|
||||
|
||||
lwm2m_lifetime_min {
|
||||
desc {
|
||||
en: """Minimum value of lifetime allowed to be set by the LwM2M client"""
|
||||
zh: """ """
|
||||
zh: """允许 LwM2M 客户端允许设置的心跳最小值"""
|
||||
}
|
||||
}
|
||||
|
||||
lwm2m_lifetime_max {
|
||||
desc {
|
||||
en: """Maximum value of lifetime allowed to be set by the LwM2M client"""
|
||||
zh: """ """
|
||||
zh: """允许 LwM2M 客户端允许设置的心跳最大值"""
|
||||
}
|
||||
}
|
||||
|
||||
|
|
@ -184,14 +206,15 @@ This gateway only supports the v1.0.1 protocol"""
|
|||
en: """The value of the time window during which the network link is considered valid by the LwM2M Gateway in QMode mode.
|
||||
For example, after receiving an update message from a client, any messages within this time window are sent directly to the LwM2M client, and all messages beyond this time window are temporarily stored in memory."""
|
||||
|
||||
zh: """ """
|
||||
zh: """在QMode模式下，LwM2M网关认为网络链接有效的时间窗口的值。
|
||||
例如，在收到客户端的更新信息后，在这个时间窗口内的任何信息都会直接发送到LwM2M客户端，而超过这个时间窗口的所有信息都会暂时储存在内存中"""
|
||||
}
|
||||
}
|
||||
|
||||
lwm2m_auto_observe {
|
||||
desc {
|
||||
en: """Automatically observe the object list of REGISTER packet"""
|
||||
zh: """ """
|
||||
zh: """自动 Observe REGISTER 数据包的 Object 列表"""
|
||||
}
|
||||
}
|
||||
|
||||
|
|
@ -199,16 +222,19 @@ For example, after receiving an update message from a client, any messages withi
|
|||
desc {
|
||||
en: """"Policy for publishing UPDATE event message.
|
||||
- always: send update events as long as the UPDATE request is received.
|
||||
- contains_object_list: send update events only if the UPDATE request carries any Object List"""
|
||||
|
||||
zh: """ """
|
||||
- contains_object_list: send update events only if the UPDATE request carries any Object List
|
||||
"""
|
||||
zh: """发布UPDATE事件消息的策略。
|
||||
- always: 只要收到 UPDATE 请求，就发送更新事件。
|
||||
- contains_object_list: 仅当 UPDATE 请求携带 Object 列表时才发送更新事件
|
||||
"""
|
||||
}
|
||||
}
|
||||
|
||||
lwm2m_translators {
|
||||
desc {
|
||||
en: """Topic configuration for LwM2M's gateway publishing and subscription"""
|
||||
zh: """ """
|
||||
zh: """LwM2M 网关订阅/发布消息的主题映射配置"""
|
||||
}
|
||||
}
|
||||
|
||||
|
|
@ -217,14 +243,15 @@ For example, after receiving an update message from a client, any messages withi
|
|||
en: """The topic for receiving downstream commands.
|
||||
For each new LwM2M client that succeeds in going online, the gateway creates a subscription relationship to receive downstream commands and send it to the LwM2M client"""
|
||||
|
||||
zh: """ """
|
||||
zh: """下行命令主题。
|
||||
对于每个成功上线的新 LwM2M 客户端，网关会创建一个订阅关系来接收下行消息并将其发送给客户端"""
|
||||
}
|
||||
}
|
||||
|
||||
lwm2m_translators_response {
|
||||
desc {
|
||||
en: """The topic for gateway to publish the acknowledge events from LwM2M client"""
|
||||
zh: """ """
|
||||
zh: """用于网关发布来自 LwM2M 客户端的确认事件的主题"""
|
||||
}
|
||||
}
|
||||
|
||||
|
|
@ -233,105 +260,108 @@ For each new LwM2M client that succeeds in going online, the gateway creates a s
|
|||
en: """The topic for gateway to publish the notify events from LwM2M client.
|
||||
After succeed observe a resource of LwM2M client, Gateway will send the notify events via this topic, if the client reports any resource changes"""
|
||||
|
||||
zh: """ """
|
||||
zh: """用于发布来自 LwM2M 客户端的通知事件的主题。
|
||||
在成功 Observe 到 LwM2M 客户端的资源后，如果客户端报告任何资源状态的变化，网关将通过该主题发送通知事件"""
|
||||
}
|
||||
}
|
||||
|
||||
lwm2m_translators_register {
|
||||
desc {
|
||||
en: """The topic for gateway to publish the register events from LwM2M client."""
|
||||
zh: """ """
|
||||
zh: """用于发布来自 LwM2M 客户端的注册事件的主题"""
|
||||
}
|
||||
}
|
||||
|
||||
lwm2m_translators_update {
|
||||
desc {
|
||||
en: """The topic for gateway to publish the update events from LwM2M client"""
|
||||
zh: """ """
|
||||
zh: """用于发布来自LwM2M客户端的更新事件的主题"""
|
||||
}
|
||||
}
|
||||
|
||||
translator {
|
||||
desc {
|
||||
en: """MQTT topic that corresponds to a particular type of event."""
|
||||
zh: """ """
|
||||
zh: """配置某网关客户端对于发布消息或订阅的主题和 QoS 等级"""
|
||||
}
|
||||
}
|
||||
|
||||
translator_topic {
|
||||
desc {
|
||||
en: """Which topic the device's upstream message is published to."""
|
||||
zh: """ """
|
||||
en: """Topic Name"""
|
||||
zh: """主题名称"""
|
||||
}
|
||||
}
|
||||
|
||||
translator_qos {
|
||||
desc {
|
||||
en: """QoS of the published messages."""
|
||||
zh: """ """
|
||||
en: """QoS Level"""
|
||||
zh: """QoS 等级"""
|
||||
}
|
||||
}
|
||||
|
||||
exproto {
|
||||
desc {
|
||||
en: """The Extension Protocol configuration"""
|
||||
zh: """ """
|
||||
zh: """ExProto 网关"""
|
||||
}
|
||||
}
|
||||
|
||||
exproto_server {
|
||||
desc {
|
||||
en: """Configurations for starting the <code>ConnectionAdapter</code> service"""
|
||||
zh: """ """
|
||||
zh: """配置 ExProto 网关需要启动的 <code>ConnectionAdapter</code> 服务。
|
||||
该服务用于提供客户端的认证、发布、订阅和数据下行等功能。"""
|
||||
}
|
||||
}
|
||||
|
||||
exproto_grpc_server_bind {
|
||||
desc {
|
||||
en: """Listening address and port for the gRPC server."""
|
||||
zh: """ """
|
||||
zh: """服务监听地址和端口。"""
|
||||
}
|
||||
}
|
||||
|
||||
exproto_grpc_server_ssl {
|
||||
desc {
|
||||
en: """SSL configuration for the gRPC server."""
|
||||
zh: """ """
|
||||
zh: """服务 SSL 配置。"""
|
||||
}
|
||||
}
|
||||
|
||||
exproto_handler {
|
||||
desc {
|
||||
en: """Configurations for request to <code>ConnectionHandler</code> service"""
|
||||
zh: """ """
|
||||
zh: """配置 ExProto 网关需要请求的 <code>ConnectionHandler</code> 服务地址。
|
||||
该服务用于给 ExProto 提供客户端的 Socket 事件处理、字节解码、订阅消息接收等功能。"""
|
||||
}
|
||||
}
|
||||
|
||||
exproto_grpc_handler_address {
|
||||
desc {
|
||||
en: """gRPC server address."""
|
||||
zh: """ """
|
||||
zh: """对端 gRPC 服务器地址。"""
|
||||
}
|
||||
}
|
||||
|
||||
exproto_grpc_handler_ssl {
|
||||
desc {
|
||||
en: """SSL configuration for the gRPC client."""
|
||||
zh: """ """
|
||||
zh: """gRPC 客户端的 SSL 配置。"""
|
||||
}
|
||||
}
|
||||
|
||||
gateway_common_enable {
|
||||
desc {
|
||||
en: """Whether to enable this gateway"""
|
||||
zh: """ """
|
||||
zh: """是否启用该网关"""
|
||||
}
|
||||
}
|
||||
|
||||
gateway_common_enable_stats {
|
||||
desc {
|
||||
en: """Whether to enable client process statistic"""
|
||||
zh: """ """
|
||||
zh: """是否开启客户端统计"""
|
||||
}
|
||||
}
|
||||
|
||||
|
|
@ -340,7 +370,9 @@ After succeed observe a resource of LwM2M client, Gateway will send the notify e
|
|||
en: """The idle time of the client connection process. It has two purposes:
|
||||
1. A newly created client process that does not receive any client requests after that time will be closed directly.
|
||||
2. A running client process that does not receive any client requests after this time will go into hibernation to save resources."""
|
||||
zh: """ """
|
||||
zh: """客户端连接过程的空闲时间。该配置用于：
|
||||
1. 一个新创建的客户端进程如果在该时间间隔内没有收到任何客户端请求，将被直接关闭。
|
||||
2. 一个正在运行的客户进程如果在这段时间后没有收到任何客户请求，将进入休眠状态以节省资源。"""
|
||||
}
|
||||
}
|
||||
|
||||
|
|
@ -354,54 +386,54 @@ After succeed observe a resource of LwM2M client, Gateway will send the notify e
|
|||
gateway_common_clientinfo_override {
|
||||
desc {
|
||||
en: """ClientInfo override."""
|
||||
zh: """ """
|
||||
zh: """ClientInfo 重写。"""
|
||||
}
|
||||
}
|
||||
|
||||
gateway_common_clientinfo_override_username {
|
||||
desc {
|
||||
en: """Template for overriding username."""
|
||||
zh: """ """
|
||||
zh: """username 重写模板"""
|
||||
}
|
||||
}
|
||||
gateway_common_clientinfo_override_password {
|
||||
desc {
|
||||
en: """Template for overriding password."""
|
||||
zh: """ """
|
||||
zh: """password 重写模板"""
|
||||
}
|
||||
}
|
||||
gateway_common_clientinfo_override_clientid {
|
||||
desc {
|
||||
en: """Template for overriding clientid."""
|
||||
zh: """ """
|
||||
zh: """clientid 重写模板"""
|
||||
}
|
||||
}
|
||||
|
||||
gateway_common_authentication {
|
||||
desc {
|
||||
en: """Default authentication configs for all the gateway listeners. For per-listener overrides see <code>authentication</code>\n in listener configs"""
|
||||
zh: """ """
|
||||
zh: """网关的认证器配置，对该网关下所以的监听器生效。如果每个监听器需要配置不同的认证器，需要配置监听器下的 <code>authentication</code> 字段"""
|
||||
}
|
||||
}
|
||||
|
||||
tcp_udp_listeners {
|
||||
desc {
|
||||
en: """Settings for the listeners."""
|
||||
zh: """ """
|
||||
zh: """监听器配置"""
|
||||
}
|
||||
}
|
||||
|
||||
tcp_listeners {
|
||||
desc {
|
||||
en: """Settings for the TCP listeners."""
|
||||
zh: """ """
|
||||
zh: """配置 TCP 类型的监听器"""
|
||||
}
|
||||
}
|
||||
|
||||
udp_listeners {
|
||||
desc {
|
||||
en: """Settings for the UDP listeners."""
|
||||
zh: """ """
|
||||
zh: """配置 UDP 类型的监听器"""
|
||||
}
|
||||
}
|
||||
|
||||
|
|
@ -415,14 +447,14 @@ After succeed observe a resource of LwM2M client, Gateway will send the notify e
|
|||
tcp_listener_acceptors {
|
||||
desc {
|
||||
en: """Size of the acceptor pool."""
|
||||
zh: """ """
|
||||
zh: """Acceptor 进程池大小。"""
|
||||
}
|
||||
}
|
||||
|
||||
tcp_listener_tcp_opts{
|
||||
desc {
|
||||
en: """Setting the TCP socket options."""
|
||||
zh: """ """
|
||||
zh: """TCP Socket 配置"""
|
||||
}
|
||||
}
|
||||
|
||||
|
|
@ -430,7 +462,7 @@ After succeed observe a resource of LwM2M client, Gateway will send the notify e
|
|||
desc {
|
||||
en: """Enable the Proxy Protocol V1/2 if the EMQX cluster is deployed behind HAProxy or Nginx.
|
||||
See: https://www.haproxy.com/blog/haproxy/proxy-protocol/"""
|
||||
zh: """ """
|
||||
zh: """是否开启 Proxy Protocol V1/2。当 EMQX 集群部署在 HAProxy 或 Nginx 后需要获取客户端真实 IP 时常用到该选项。参考：https://www.haproxy.com/blog/haproxy/proxy-protocol/"""
|
||||
}
|
||||
}
|
||||
|
||||
|
|
@ -438,7 +470,7 @@ See: https://www.haproxy.com/blog/haproxy/proxy-protocol/"""
|
|||
desc {
|
||||
en: """Timeout for proxy protocol.
|
||||
EMQX will close the TCP connection if proxy protocol packet is not received within the timeout."""
|
||||
zh: """ """
|
||||
zh: """接收 Proxy Protocol 报文头的超时时间。如果在超时内没有收到 Proxy Protocol 包，EMQX 将关闭 TCP 连接。"""
|
||||
}
|
||||
}
|
||||
|
||||
|
|
@ -451,8 +483,8 @@ EMQX will close the TCP connection if proxy protocol packet is not received with
|
|||
|
||||
ssl_listener_options {
|
||||
desc {
|
||||
en: """SSL listener options."""
|
||||
zh: """ """
|
||||
en: """SSL Socket options."""
|
||||
zh: """SSL Socket 配置"""
|
||||
}
|
||||
}
|
||||
|
||||
|
|
@ -466,7 +498,7 @@ EMQX will close the TCP connection if proxy protocol packet is not received with
|
|||
udp_listener_udp_opts {
|
||||
desc {
|
||||
en: """Settings for the UDP sockets."""
|
||||
zh: """ """
|
||||
zh: """UDP Socket 配置 """
|
||||
}
|
||||
}
|
||||
|
||||
|
|
@ -474,35 +506,36 @@ EMQX will close the TCP connection if proxy protocol packet is not received with
|
|||
desc {
|
||||
en: """Specify the {active, N} option for the socket.
|
||||
See: https://erlang.org/doc/man/inet.html#setopts-2"""
|
||||
zh: """ """
|
||||
zh: """为 Socket 指定 {active, N} 选项。
|
||||
参见：https://erlang.org/doc/man/inet.html#setopts-2"""
|
||||
}
|
||||
}
|
||||
|
||||
udp_listener_recbuf {
|
||||
desc {
|
||||
en: """Size of the kernel-space receive buffer for the socket."""
|
||||
zh: """ """
|
||||
zh: """Socket 在内核空间接收缓冲区的大小。"""
|
||||
}
|
||||
}
|
||||
|
||||
udp_listener_sndbuf {
|
||||
desc {
|
||||
en: """Size of the kernel-space send buffer for the socket."""
|
||||
zh: """ """
|
||||
zh: """Socket 在内核空间发送缓冲区的大小。"""
|
||||
}
|
||||
}
|
||||
|
||||
udp_listener_buffer {
|
||||
desc {
|
||||
en: """Size of the user-space buffer for the socket."""
|
||||
zh: """ """
|
||||
zh: """Socket 在用户空间的缓冲区大小。"""
|
||||
}
|
||||
}
|
||||
|
||||
udp_listener_reuseaddr {
|
||||
desc {
|
||||
en: """Allow local reuse of port numbers."""
|
||||
zh: """ """
|
||||
zh: """允许重用本地处于 TIME_WAIT 的端口号"""
|
||||
}
|
||||
}
|
||||
|
||||
|
|
@ -516,14 +549,14 @@ See: https://erlang.org/doc/man/inet.html#setopts-2"""
|
|||
dtls_listener_acceptors {
|
||||
desc {
|
||||
en: """Size of the acceptor pool."""
|
||||
zh: """ """
|
||||
zh: """Acceptor 进程池大小。"""
|
||||
}
|
||||
}
|
||||
|
||||
dtls_listener_dtls_opts {
|
||||
desc {
|
||||
en: """DTLS listener options"""
|
||||
zh: """ """
|
||||
en: """DTLS socket options"""
|
||||
zh: """DTLS Socket 配置"""
|
||||
}
|
||||
|
||||
}
|
||||
|
|
@ -531,28 +564,28 @@ See: https://erlang.org/doc/man/inet.html#setopts-2"""
|
|||
gateway_common_listener_enable {
|
||||
desc {
|
||||
en: """Enable the listener."""
|
||||
zh: """ """
|
||||
zh: """是否启用该监听器。"""
|
||||
}
|
||||
}
|
||||
|
||||
gateway_common_listener_bind {
|
||||
desc {
|
||||
en: """The IP address and port that the listener will bind."""
|
||||
zh: """ """
|
||||
zh: """监听器绑定的 IP 地址或端口。"""
|
||||
}
|
||||
}
|
||||
|
||||
gateway_common_listener_max_connections {
|
||||
desc {
|
||||
en: """Maximum number of concurrent connections."""
|
||||
zh: """ """
|
||||
zh: """监听器支持的最大连接数。"""
|
||||
}
|
||||
}
|
||||
|
||||
gateway_common_listener_max_conn_rate {
|
||||
desc {
|
||||
en: """Maximum connections per second."""
|
||||
zh: """ """
|
||||
zh: """监听器支持的最大连接速率。"""
|
||||
}
|
||||
}
|
||||
|
||||
|
|
@ -565,7 +598,13 @@ Variables in mountpoint string:
|
|||
- <code>${clientid}</code>: clientid
|
||||
- <code>${username}</code>: username
|
||||
"""
|
||||
zh: """ """
|
||||
zh: """发布或订阅时，在所有主题前增加前缀字符串。
|
||||
当消息投递给订阅者时，前缀字符串将从主题名称中删除。挂载点是用户可以用来实现不同监听器之间的消息路由隔离的一种方式。
|
||||
例如，如果客户端 A 在 `listeners.tcp.<name>.mountpoint` 设置为 `some_tenant` 的情况下订阅 `t`，则客户端实际上订阅了 `some_tenant/t` 主题。 类似地，如果另一个客户端 B（连接到与客户端 A 相同的侦听器）向主题 `t` 发送消息，则该消息被路由到所有订阅了 `some_tenant/t` 的客户端，因此客户端 A 将收到该消息，带有 主题名称`t`。 设置为 `\"\"` 以禁用该功能。
|
||||
挂载点字符串中可用的变量：
|
||||
- <code>${clientid}</code>：clientid
|
||||
- <code>${username}</code>：用户名
|
||||
"""
|
||||
}
|
||||
}
|
||||
|
||||
|
|
@ -573,15 +612,8 @@ Variables in mountpoint string:
|
|||
desc {
|
||||
en: """The access control rules for this listener.
|
||||
See: https://github.com/emqtt/esockd#allowdeny"""
|
||||
zh: """ """
|
||||
zh: """配置监听器的访问控制规则。
|
||||
见：https://github.com/emqtt/esockd#allowdeny"""
|
||||
}
|
||||
}
|
||||
|
||||
gateway_common_listener_enable {
|
||||
desc {
|
||||
en: """ """
|
||||
zh: """ """
|
||||
}
|
||||
}
|
||||
|
||||
}
|
||||
|
|
|
|||
|
|
@ -3,56 +3,56 @@ emqx_lwm2m_api {
|
|||
lookup_resource {
|
||||
desc {
|
||||
en: """Look up a resource"""
|
||||
zh: """ """
|
||||
zh: """查看指定资源状态"""
|
||||
}
|
||||
}
|
||||
|
||||
observe_resource {
|
||||
desc {
|
||||
en: """Observe or Cancel observe a resource"""
|
||||
zh: """ """
|
||||
zh: """Observe/Un-Observe 指定资源"""
|
||||
}
|
||||
}
|
||||
|
||||
read_resource {
|
||||
desc {
|
||||
en: """Send a read command to a resource"""
|
||||
zh: """ """
|
||||
zh: """发送读指令到某资源"""
|
||||
}
|
||||
}
|
||||
|
||||
write_resource {
|
||||
desc {
|
||||
en: """Send a write command to a resource"""
|
||||
zh: """ """
|
||||
zh: """发送写指令到某资源"""
|
||||
}
|
||||
}
|
||||
|
||||
operations {
|
||||
desc {
|
||||
en: """Resource Operations"""
|
||||
zh: """ """
|
||||
zh: """资源可用操作列表"""
|
||||
}
|
||||
}
|
||||
|
||||
dataType {
|
||||
desc {
|
||||
en: """Data Type"""
|
||||
zh: """ """
|
||||
zh: """数据类型"""
|
||||
}
|
||||
}
|
||||
|
||||
path {
|
||||
desc {
|
||||
en: """Resource Path"""
|
||||
zh: """ """
|
||||
zh: """资源路径"""
|
||||
}
|
||||
}
|
||||
|
||||
name {
|
||||
desc {
|
||||
en: """Resource Name"""
|
||||
zh: """ """
|
||||
zh: """资源名称"""
|
||||
}
|
||||
}
|
||||
}
|
||||
|
|
|
|||
Loading…
Reference in New Issue