diff --git a/doc/admin-api.md b/doc/admin-api.md index 22faa506..51e70c50 100644 --- a/doc/admin-api.md +++ b/doc/admin-api.md @@ -658,8 +658,10 @@ Return response from etcd currently. |Parameter |Required |Type |Description |Example| |---------|---------|----|-----------|----| -|cert|True|Public key|https Public key|| -|key|True|Private key|https Private key|| +|cert|True|Certificate|https certificate|| +|key|True|Private key|https private key|| +|certs|False|An array of certificate|when you need to configure multiple certificate for the same domain, you can pass extra https certificates (excluding the one given as cert) in this field|| +|keys|False|An array of private key|https private keys. The keys should be paired with certs above|| |sni|True|Match Rules|https SNI|| |labels|False |Match Rules|Key/value pairs to specify attributes|{"version":"v2","build":"16","env":"production"}| |create_time|False| Auxiliary|epoch timestamp in second, will be created automatically if missing | 1602883670| @@ -670,7 +672,7 @@ Config Example: ```shell { "id": "1", # id - "cert": "cert", # Public key + "cert": "cert", # Certificate "key": "key", # Private key "sni": "sni" # https SNI } diff --git a/doc/zh-cn/admin-api.md b/doc/zh-cn/admin-api.md index a126e1cd..5dae7d59 100644 --- a/doc/zh-cn/admin-api.md +++ b/doc/zh-cn/admin-api.md @@ -671,8 +671,10 @@ HTTP/1.1 200 OK |名字 |可选项 |类型 |说明 |示例| |---------|---------|----|-----------|----| -|cert|必需|公钥|https 证书公钥|| +|cert|必需|证书|https 证书|| |key|必需|私钥|https 证书私钥|| +|certs|可选|证书字符串数组|当你想给同一个域名配置多个证书时,除了第一个证书需要通过cert传递外,剩下的证书可以通过该参数传递上来|| +|keys|可选|私钥字符串数组|certs 对应的证书私钥,注意要跟 certs 一一对应|| |sni|必需|匹配规则|https 证书SNI|| |labels|可选|匹配规则|标识附加属性的键值对|{"version":"v2","build":"16","env":"production"}| |create_time|可选|辅助|单位为秒的 epoch 时间戳,如果不指定则自动创建|1602883670| @@ -683,7 +685,7 @@ ssl 对象 json 配置内容: ```shell { "id": "1", # id - "cert": "cert", # 公钥 + "cert": "cert", # 证书 "key": "key", # 私钥 "sni": "sni" # host 域名 }