批量上传证书
更新时间:2023-08-03
接口说明
本接口用于批量上传HTTPS证书
注意:
如果domain已经绑定了一个证书id,则该接口为修改(将用户新上传的证书替换掉证书库中的老证书,且给domain绑定新证书的id)。 如果domain之前没有绑定证书,则该接口为上传新证书且将新的证书id绑到domain上。该接口替换老证书后不对证书库中对老证书做处理
method | path | 说明 |
---|---|---|
POST | /v2/domain/certificate?action=put | 增加or修改domain绑定的certificate |
请求体
参数 | 可选 | 类型 | 说明 |
---|---|---|---|
domains | 必选 | list |
要配置的域名列表,不能超过100个,且这些域名均能和证书内容的DNS names匹配 |
certificate | 必选 | certificate | 证书内容 |
https | 可选 | https | HTTPS关联配置 |
certificate类型说明
参数 | 可选 | 类型 | 说明 |
---|---|---|---|
certName | 必选 | string | 证书的名称。长度限制为1-65个字符,以字母开头,只允许包含字母、数字、’-‘、’/’、’.’、’’、’*’,Java正则表达式 ^[a-zA-Z]a-zA-Z0-9-/.*]{0,64}$ |
certServerData | 必选 | string | 服务器证书的数据内容 (Base64编码) |
certPrivateData | 必选 | string | 证书的私钥数据内容 (Base64编码) |
certLinkData | 可选 | string | 证书链数据内容 (Base64编码) |
certType | 可选 | int | 证书类型,值为1,表服务端证书,不能传客户端证书 |
https类型说明
参数 | 可选 | 类型 | 说明 |
---|---|---|---|
httpRedirect | 可选 | bool | 为true时将HTTP请求重定向到HTTPS(重定向状态码为httpRedirectCode所配置),默认为false,当enabled=false此项无效,不可与httpsRedirect同时为true |
httpRedirectCode | 可选 | int | 重定向状态码,可选值301/302,默认302,当enabled=false此项无效,httpRedirect=false此项无效 |
httpsRedirect | 可选 | bool | 为true时将HTTPS请求重定向到HTTP重定向状态码为httpsRedirectCode所配置),默认为false,当enabled=false此项无效,不可与httpRedirect同时为true |
httpsRedirectCode | 可选 | int | 重定向状态码,可选值301/302,默认302,当enabled=false此项无效,httpsRedirect=false此项无效 |
http2Enabled | 可选 | bool | 开启HTTP2特性,默认true,当enabled=false此项无效 |
disableHttpsSpider | 可选 | string | 跳转时排除包含该字段ua值的请求 |
响应体
参数 | 可选 | 类型 | 说明 |
---|---|---|---|
certId | 必选 | string | 证书入库后的certId |
请求示例
POST /v2/domain/certificate?action=put
{
"domains": [
"*.baidu.com",
"test.baidu.com"
],
"certificate": {
"certName": "test",
"certServerData": "-----BEGIN CERTIFICATE-----END CERTIFICATE-----",
"certPrivateData": "-----BEGIN RSA PRIVATE KEY-----END RSA PRIVATE KEY-----"
}
}
响应示例
{"certId":"cert-z086cxsudg2k"}