forked from emqx/cloud-docs
-
Notifications
You must be signed in to change notification settings - Fork 0
/
directory.json
1042 lines (1042 loc) · 25.6 KB
/
directory.json
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
{
"cn": [
{
"title": "EMQX Cloud",
"path": "./"
},
{
"title": "产品简介",
"children": [
{
"title": "产品概述",
"path": "overview"
},
{
"title": "产品优势",
"path": "intro/advance"
},
{
"title": "产品限制",
"path": "intro/restriction"
}
]
},
{
"title": "产品定价",
"children": [
{
"title": "定价介绍",
"path": "price/pricing"
},
{
"title": "计费说明",
"path": "price/charging"
},
{
"title": "价格计算",
"path": "price/calculator"
}
]
},
{
"title": "快速入门",
"children": [
{
"title": "入门简介",
"path": "quick_start/introduction"
},
{
"title": "创建免费试用部署",
"path": "quick_start/create_free_trial"
},
{
"title": "创建计费部署",
"path": "deployments/create_deployment"
},
{
"title": "使用 MQTT X 连接到部署",
"path": "connect_to_deployments/mqttx"
}
]
},
{
"title": "功能概述",
"children": [
{
"title": "项目中心",
"path": "feature/project_center"
},
{
"title": "项目列表",
"path": "deployments/project"
},
{
"title": "角色权限",
"path": "feature/role"
},
{
"title": "子用户管理",
"path": "feature/user"
},
{
"title": "财务管理",
"path": "billing/introduction"
},
{
"title": "账单概览",
"path": "billing/overview"
},
{
"title": "代金券",
"path": "billing/coupon"
},
{
"title": "发票",
"path": "billing/invoices"
},
{
"title": "续费管理",
"path": "billing/subscription"
},
{
"title": "工单",
"path": "feature/tickets"
}
]
},
{
"title": "部署和连接",
"children": [
{
"title": "部署简介",
"path": "deployments/introduction"
},
{
"title": "部署概览",
"path": "deployments/view_deployment"
},
{
"title": "TLS/SSL 设置",
"path": "deployments/tls_ssl"
},
{
"title": "VPC 对等连接设置",
"path": "deployments/vpc_peering"
},
{
"title": "私网连接 PrivateLink 设置",
"path": "deployments/privatelink"
},
{
"title": "认证",
"path": "deployments/auth"
},
{
"title": "访问控制",
"path": "deployments/acl"
},
{
"title": "自定义认证概述",
"path": "deployments/custom_auth"
},
{
"title": "HTTP 自定义认证",
"path": "deployments/http_auth"
},
{
"title": "MySQL 认证/访问控制",
"path": "deployments/mysql_auth"
},
{
"title": "PostgreSQL 认证/访问控制",
"path": "deployments/pgsql_auth"
},
{
"title": "Redis 认证/访问控制",
"path": "deployments/redis_auth"
},
{
"title": "JWT 认证",
"path": "deployments/jwt_auth"
},
{
"title": "监控",
"path": "deployments/monitors"
},
{
"title": "指标",
"path": "deployments/metrics"
},
{
"title": "Prometheus",
"path": "deployments/prometheus"
},
{
"title": "日志",
"path": "deployments/logs"
},
{
"title": "告警",
"path": "deployments/alerts"
},
{
"title": "Webhook 告警",
"path": "deployments/alerts_webhook"
},
{
"title": "停止/删除部署",
"path": "deployments/stop_delete_deployment"
}
]
},
{
"title": "连接到部署",
"children": [
{
"title": "简介",
"path": "connect_to_deployments/overview"
},
{
"title": "Python SDK 连接",
"path": "connect_to_deployments/python_sdk"
},
{
"title": "Go SDK 连接",
"path": "connect_to_deployments/golang_sdk"
},
{
"title": "Java SDK 连接",
"path": "connect_to_deployments/java_sdk"
},
{
"title": "Node.js SDK 连接",
"path": "connect_to_deployments/nodejs_sdk"
},
{
"title": "C SDK 连接",
"path": "connect_to_deployments/c_sdk"
},
{
"title": "C# SDK 连接",
"path": "connect_to_deployments/c_sharp_sdk"
},
{
"title": "Android Kotlin SDK 连接",
"path": "https://www.emqx.com/zh/blog/android-connects-mqtt-using-kotlin"
},
{
"title": "WebSocket SDK 连接",
"path": "https://www.emqx.com/zh/blog/connect-to-mqtt-broker-with-websocket"
},
{
"title": "Vue.js SDK 连接",
"path": "connect_to_deployments/vue_sdk"
},
{
"title": "React SDK 连接",
"path": "connect_to_deployments/react_sdk"
},
{
"title": "Electron SDK 连接",
"path": "connect_to_deployments/electron_sdk"
},
{
"title": "微信小程序 SDK 连接",
"path": "connect_to_deployments/wechat_miniprogram"
},
{
"title": "使用 ESP8266 连接到部署",
"path": "connect_to_deployments/esp8266"
},
{
"title": "使用 ESP32 连接到部署",
"path": "connect_to_deployments/esp32"
},
{
"title": "使用 MQTT X 连接到部署",
"path": "connect_to_deployments/mqttx"
},
{
"title": "使用 MQTT.fx 连接到部署",
"path": "connect_to_deployments/mqttfx"
},
{
"title": "共享订阅",
"path": "connect_to_deployments/shared_subscription"
}
]
},
{
"title": "数据集成",
"children": [
{
"title": "数据集成简介",
"path": "rule_engine/introduction"
},
{
"title": "资源管理",
"path": "rule_engine/resources"
},
{
"title": "规则管理",
"path": "rule_engine/rules"
},
{
"title": "事件订阅",
"path": "rule_engine/rule_engine_events"
},
{
"title": "空动作(调试)",
"path": "rule_engine/rule_engine_empty_action_debug"
},
{
"title": "消息重新发布",
"path": "rule_engine/rule_engine_republish"
},
{
"title": "桥接数据到 Webhook",
"path": "rule_engine/rule_engine_web_hook"
},
{
"title": "桥接数据到 MQTT Broker",
"path": "rule_engine/rule_engine_mqtt"
},
{
"title": "桥接数据到 Kafka",
"path": "rule_engine/rule_engine_kafka"
},
{
"title": "桥接数据到 阿里云 Kafka",
"path": "rule_engine/rule_engine_aliyun_kafka"
},
{
"title": "桥接数据到 华为云 Kafka",
"path": "rule_engine/rule_engine_huawei_kafka"
},
{
"title": "桥接数据到 Pulsar",
"path": "rule_engine/rule_engine_bridge_pulsar"
},
{
"title": "桥接数据到 RabbitMQ",
"path": "rule_engine/rule_engine_bridge_rabbitmq"
},
{
"title": "保存数据到 MySQL",
"path": "rule_engine/rule_engine_save_mysql"
},
{
"title": "保存数据到 阿里云 MySQL",
"path": "rule_engine/rule_engine_save_rds_mysql"
},
{
"title": "保存数据到 AWS RDS MySQL",
"path": "rule_engine/rule_engine_save_aws_rds_mysql"
},
{
"title": "保存数据到 TimescaleDB",
"path": "rule_engine/rule_engine_save_timescaladb"
},
{
"title": "保存数据到 PostgreSQL",
"path": "rule_engine/rule_engine_save_postgresql"
},
{
"title": "保存数据到 MongoDB",
"path": "rule_engine/rule_engine_save_mongodb"
},
{
"title": "保存数据到 阿里云 MongoDB",
"path": "rule_engine/rule_engine_aliyun_mongodb"
},
{
"title": "保存数据到 Redis",
"path": "rule_engine/rule_engine_save_redis"
},
{
"title": "保存数据到 ClickHouse",
"path": "rule_engine/rule_engine_save_clickhouse"
},
{
"title": "保存数据到 InfluxDB 2.0",
"path": "rule_engine/rule_engine_influxDB_2.0"
},
{
"title": "保存数据到 SQL Server",
"path": "rule_engine/rule_engine_save_sqlserver"
},
{
"title": "保存数据到 TDengine",
"path": "rule_engine/rule_engine_save_tdengine"
},
{
"title": "保存数据到 阿里云 Lindorm",
"path": "rule_engine/rule_engine_aliyun_lindorm"
},
{
"title": "保存数据到 阿里云 Tablestore",
"path": "rule_engine/rule_engine_save_tablestore"
},
{
"title": "保存数据到 HStreamDB",
"path": "rule_engine/rule_engine_save_hstreamdb"
},
{
"title": "获取订阅关系",
"path": "rule_engine/rule_engine_get_subscription"
},
{
"title": "保存离线消息",
"path": "rule_engine/rule_engine_offline_msg_saving"
}
]
},
{
"title": "增值服务",
"children": [
{
"title": "增值服务简介",
"path": "vas/vas-intro"
},
{
"title": "增值服务计费说明",
"path": "vas/vas-price"
},
{
"title": "NAT 网关",
"path": "vas/nat-gateway"
},
{
"title": "内网负载均衡",
"path": "vas/intranet-lb"
},
{
"title": "流量包",
"path": "vas/traffic-pack"
},
{
"title": "自定义函数",
"path": "vas/codec"
},
{
"title": "影子服务",
"path": "vas/shadows"
}
]
},
{
"title": "影子服务",
"children": [
{
"title": "服务概览",
"path": "shadow_service/overview"
},
{
"title": "计费说明",
"path": "shadow_service/pricing"
},
{
"title": "功能简介",
"path": "shadow_service/feature"
},
{
"title": "调用和通信",
"path": "shadow_service/invoke"
},
{
"title": "场景案例:设备影子",
"path": "shadow_service/device_shadow"
},
{
"title": "场景案例:物模型管理应用",
"path": "shadow_service/things_model"
}
]
},
{
"title": "API",
"children": [
{
"title": "API 概览",
"path": "api/introduction"
},
{
"title": "认证管理",
"path": "api/auth"
},
{
"title": "访问控制管理",
"path": "api/acl"
},
{
"title": "客户端管理",
"path": "api/clients"
},
{
"title": "订阅信息",
"path": "api/subscriptions"
},
{
"title": "主题订阅",
"path": "api/subscribe"
},
{
"title": "消息发布",
"path": "api/publish"
},
{
"title": "指标",
"path": "api/metrics"
},
{
"title": "影子服务",
"path": "api/shadow_service"
}
]
},
{
"title": "最佳实践",
"children": [
{
"title": "数据集成 + Redis 实时获取主题下订阅的客户端",
"path": "best_practices/save_topic_clients_to_redis"
}
]
},
{
"title": "产品动态",
"path": "release_notes"
},
{
"title": "常见问题",
"children": [
{
"title": "一般业务问题",
"path": "faq/normal_a"
},
{
"title": "一般开发问题",
"path": "faq/normal_b"
},
{
"title": "部署相关问题",
"path": "faq/deploy"
},
{
"title": "财务相关问题",
"path": "faq/billing"
}
]
}
],
"en": [
{
"title": "EMQX Cloud Overview",
"path": "./"
},
{
"title": "Introduction",
"children": [
{
"title": "Overview",
"path": "overview"
},
{
"title": "Advantages",
"path": "intro/advance"
},
{
"title": "Limitations",
"path": "intro/restriction"
}
]
},
{
"title": "Pricing",
"children": [
{
"title": "Product Plans",
"path": "price/pricing"
},
{
"title": "Billing",
"path": "price/billing"
},
{
"title": "Price Estimation",
"path": "price/calculator"
}
]
},
{
"title": "Quick Start",
"children": [
{
"title": "Overview",
"path": "quick_start/introduction"
},
{
"title": "Create a free trial deployment",
"path": "quick_start/create_free_trial"
},
{
"title": "Create a billing deployment",
"path": "deployments/create_deployment"
},
{
"title": "Use MQTT X to connect to deployment",
"path": "connect_to_deployments/mqttx"
}
]
},
{
"title": "Features",
"children": [
{
"title": "Project Center",
"path": "feature/project_center"
},
{
"title": "Project List",
"path": "feature/project"
},
{
"title": "Role & Authentication",
"path": "feature/role"
},
{
"title": "Subaccount Management",
"path": "feature/user"
},
{
"title": "Tickets",
"path": "feature/tickets"
}
]
},
{
"title": "Deployment",
"children": [
{
"title": "Introduction",
"path": "deployments/introduction"
},
{
"title": "Deployment Overview",
"path": "deployments/view_deployment"
},
{
"title": "TLS/SSL",
"path": "deployments/tls_ssl"
},
{
"title": "VPC Peering Connection",
"path": "deployments/vpc_peering"
},
{
"title": "PrivateLink Setting",
"path": "deployments/privatelink"
},
{
"title": "Authentication",
"path": "deployments/auth"
},
{
"title": "ACL",
"path": "deployments/acl"
},
{
"title": "Custom Authentication Intro",
"path": "deployments/custom_auth"
},
{
"title": "HTTP Authentication & ACL",
"path": "deployments/http_auth"
},
{
"title": "MySQL Authentication & ACL",
"path": "deployments/mysql_auth"
},
{
"title": "PostgreSQL Authentication & ACL",
"path": "deployments/pgsql_auth"
},
{
"title": "Redis Authentication & ACL",
"path": "deployments/redis_auth"
},
{
"title": "JWT Authentication",
"path": "deployments/jwt_auth"
},
{
"title": "Data Integrations",
"path": "deployments/rule_engine"
},
{
"title": "Monitor",
"path": "deployments/monitors"
},
{
"title": "Metrics",
"path": "deployments/metrics"
},
{
"title": "Prometheus",
"path": "deployments/prometheus"
},
{
"title": "Logs",
"path": "deployments/logs"
},
{
"title": "Alerts",
"path": "deployments/alerts"
},
{
"title": "Webhook Alerts",
"path": "deployments/alerts_webhook"
},
{
"title": "Stop Deployment",
"path": "deployments/stop_deployment"
},
{
"title": "Delete Deployment",
"path": "deployments/delete_deployment"
}
]
},
{
"title": "Connect To Deployment",
"children": [
{
"title": "Introduction",
"path": "connect_to_deployments/overview"
},
{
"title": "Python SDK connection",
"path": "connect_to_deployments/python_sdk"
},
{
"title": "Go SDK connection",
"path": "connect_to_deployments/golang_sdk"
},
{
"title": "Java SDK connection",
"path": "connect_to_deployments/java_sdk"
},
{
"title": "Node.js SDK connection",
"path": "connect_to_deployments/nodejs_sdk"
},
{
"title": "C SDK connection",
"path": "connect_to_deployments/c_sdk"
},
{
"title": "C# SDK connection",
"path": "connect_to_deployments/c_sharp_sdk"
},
{
"title": "WebSocket SDK connection",
"path": "https://www.emqx.com/en/blog/connect-to-mqtt-broker-with-websocket"
},
{
"title": "Vue.js SDK connection",
"path": "connect_to_deployments/vue_sdk"
},
{
"title": "React SDK connection",
"path": "connect_to_deployments/react_sdk"
},
{
"title": "Electron SDK connection",
"path": "connect_to_deployments/electron_sdk"
},
{
"title": "Connect with MQTT X",
"path": "connect_to_deployments/mqttx"
},
{
"title": "Connect with MQTT.fx",
"path": "connect_to_deployments/mqttfx"
},
{
"title": "Connect with ESP8266",
"path": "connect_to_deployments/esp8266"
},
{
"title": "Connect with ESP32",
"path": "connect_to_deployments/esp32"
},
{
"title": "Connect with Home Assistant",
"path": "connect_to_deployments/home_assistant"
},
{
"title": "Connect with openHAB",
"path": "connect_to_deployments/openhab"
},
{
"title": "Shared subscription",
"path": "connect_to_deployments/shared_subscription"
}
]
},
{
"title": "Data Integrations",
"children": [
{
"title": "Introduction",
"path": "rule_engine/introduction"
},
{
"title": "Resource Management",
"path": "rule_engine/resources"
},
{
"title": "Rule Management",
"path": "rule_engine/rules"
},
{
"title": "Event Topics",
"path": "rule_engine/rule_engine_events"
},
{
"title": "Republish messages",
"path": "rule_engine/rule_engine_republish"
},
{
"title": "Bridge data to Webhook",
"path": "rule_engine/rule_engine_web_hook"
},
{
"title": "Bridge data to MQTT Broker",
"path": "rule_engine/rule_engine_mqtt"
},
{
"title": "Bridge data to Kafka",
"path": "rule_engine/rule_engine_kafka"
},
{
"title": "Bridge data to Confluent Cloud",
"path": "rule_engine/rule_engine_confluent"
},
{
"title": "Bridge data to Pulsar",
"path": "rule_engine/rule_engine_bridge_pulsar"
},
{
"title": "Save data to TimescaleDB",
"path": "rule_engine/rule_engine_save_timescaledb"
},
{
"title": "Save data to Timescale Cloud",
"path": "rule_engine/rule_engine_save_timescale_cloud"
},
{
"title": "Save data to PostgreSQL",
"path": "rule_engine/rule_engine_save_psql"
},
{
"title": "Save data to MySQL",
"path": "rule_engine/rule_engine_save_mysql"
},
{
"title": "Save data to MongoDB",
"path": "rule_engine/rule_engine_save_mongodb"
},
{
"title": "Save data to MongoDB Atlas",
"path": "rule_engine/rule_engine_save_mongodb_atlas"
},
{
"title": "Save data to InfluxDB",
"path": "rule_engine/rule_engine_influxDB"
},
{
"title": "Save data to InfluxDB 2.0",
"path": "rule_engine/rule_engine_influxDB_2.0"
},
{
"title": "Save data to Redis",
"path": "rule_engine/rule_engine_save_redis"
},
{
"title": "Save data to SQL Server",
"path": "rule_engine/rule_engine_save_sqlserver"
},
{
"title": "Save data to TDengine",
"path": "rule_engine/rule_engine_save_tdengine"
},
{
"title": "Save data to HStreamDB",
"path": "rule_engine/rule_engine_save_hstreamdb"
},
{
"title": "Save data to ClickHouse",
"path": "rule_engine/rule_engine_save_clickhouse"
},
{
"title": "Save data to ClickHouse Cloud",
"path": "rule_engine/rule_engine_save_clickhouse_cloud"
},
{
"title": "Store device offline messages",
"path": "rule_engine/rule_engine_offline_msg_saving"
},
{
"title": "Get subscription topic information",
"path": "rule_engine/rule_engine_get_subscription"
}
]
},
{
"title": "Developer Guides",
"path": "dev_guide"
},
{
"title": "Billing",
"children": [
{
"title": "Billing Brief",
"path": "billing/introduction"
},
{
"title": "Billing Overview",
"path": "billing/overview"
},
{
"title": "Billing Information",
"path": "billing/billing_information"
},
{
"title": "Invoice",
"path": "billing/invoices"
},
{
"title": "Coupon",
"path": "billing/coupon"
},
{
"title": "Taxation by Region",
"path": "billing/taxation"
}
]
},
{
"title": "VAS",
"children": [
{
"title": "VAS Introduction",
"path": "vas/vas-intro"
},
{
"title": "VAS Billing",
"path": "vas/vas-price"
},
{
"title": "NAT Gateway",
"path": "vas/nat-gateway"
},
{
"title": "Internal Load Balancers",
"path": "vas/intranet-lb"
}
]
},
{
"title": "Shadow Service",
"children": [
{
"title": "Overview",
"path": "shadow_service/overview"
},
{
"title": "Pricing",
"path": "shadow_service/pricing"
},
{
"title": "Features",
"path": "shadow_service/feature"
},
{
"title": "Communication",
"path": "shadow_service/invoke"
}
]
},
{
"title": "API",
"children": [
{
"title": "API Overview",
"path": "api/api_overview"
},
{
"title": "Authentication Management",
"path": "api/auth"
},
{
"title": "ACL Management",
"path": "api/acl"
},
{
"title": "Client Management",
"path": "api/client"
},
{
"title": "Subscription",
"path": "api/sub"
},
{
"title": "Topic Subscription",
"path": "api/topic"
},
{
"title": "Message Publish",
"path": "api/pub"