mirror of
https://github.com/TeaOSLab/EdgeCommon.git
synced 2025-11-15 14:10:26 +08:00
完善API注释
This commit is contained in:
67
pkg/rpc/jsons/https_protocol.md
Normal file
67
pkg/rpc/jsons/https_protocol.md
Normal file
@@ -0,0 +1,67 @@
|
||||
# HTTPS协议配置
|
||||
|
||||
## 定义
|
||||
~~~json
|
||||
{
|
||||
"isOn": "是否启用",
|
||||
"listen": [
|
||||
{
|
||||
"protocol": "协议",
|
||||
"host": "主机地址,通常为空",
|
||||
"portRange": "端口或者端口范围"
|
||||
},
|
||||
...
|
||||
],
|
||||
"sslPolicyRef": {
|
||||
"isOn": "启用SSL策略",
|
||||
"sslPolicyId": "SSL策略ID"
|
||||
}
|
||||
}
|
||||
~~~
|
||||
|
||||
其中 `SSL策略ID` 通过 `/SSLPolicyService/createSSLPolicy` 接口创建。
|
||||
|
||||
## 示例
|
||||
|
||||
### 监听443端口
|
||||
~~~json
|
||||
{
|
||||
"isOn": true,
|
||||
"listen": [
|
||||
{
|
||||
"protocol": "https",
|
||||
"host": "",
|
||||
"portRange": "443"
|
||||
}
|
||||
],
|
||||
"sslPolicyRef": {
|
||||
"isOn": true,
|
||||
"sslPolicyId": 123
|
||||
}
|
||||
}
|
||||
~~~
|
||||
|
||||
其中SSL策略ID `123` 通过 `/SSLPolicyService/createSSLPolicy` 接口创建。
|
||||
|
||||
### 监听443和8443端口
|
||||
~~~json
|
||||
{
|
||||
"isOn": true,
|
||||
"listen": [
|
||||
{
|
||||
"protocol": "https",
|
||||
"portRange": "443"
|
||||
},
|
||||
{
|
||||
"protocol": "https",
|
||||
"portRange": "8443"
|
||||
}
|
||||
],
|
||||
"sslPolicyRef": {
|
||||
"isOn": true,
|
||||
"sslPolicyId": 123
|
||||
}
|
||||
}
|
||||
~~~
|
||||
|
||||
其中SSL策略ID `123` 通过 `/SSLPolicyService/createSSLPolicy` 接口创建。
|
||||
Reference in New Issue
Block a user