云SSL相关接口

更新时间：2021-05-20

站点列表

接口描述

站点列表，查看用户所拥有的云端证书部署的站点

请求结构

POST /host/list_host
<公共请求头>

请求参数

参数名称	参数类型	是否必须	描述	示例值	参数位置
body	Object	否	HostlistRequest	null	Body

请求体参数

HostlistRequest

参数名称	参数类型	是否必须	描述	示例值
host	String	是	站点	"a.com"

响应参数

无

请求示例

POST /host/list_host

<公共请求头>
{
  "host" : "host"
}

响应示例

HTTP/1.1 200 OK
<公共响应头>
[
    {
        "host":"aaa.com",
        "status":"RUNNING",
        "resource_id":"xxx"
    },
    {
        "host":"bbb.com",
        "status":"SUSPEND",
        "resource_id":"yyy"
    }
]

站点详情

接口描述

站点详情

请求结构

POST /host/detail
<公共请求头>

请求参数

参数名称	参数类型	是否必须	描述	示例值	参数位置
body	Object	否	DetailRequest	null	Body

请求体参数

DetailRequest

参数名称	参数类型	是否必须	描述	示例值
host	String	是	站点	"a.com"

响应参数

无

请求示例

POST /host/detail

<公共请求头>
{"host":"a.com"}

响应示例

HTTP/1.1 200 OK
<公共响应头>
{
    "id":0,
    "resource_id":"",
    "host":"",
    "user_id":"",
    "cname_record":"",
    "iam_cert_id":"",
    "enable":"",
    "status":"",
    "route_type":"",
    "origins":null,
    "updated_at":"0001-01-01T00:00:00Z",
    "created_at":"0001-01-01T00:00:00Z",
    "ssl_versions":null,
    "ocsp_stapling":"",
    "mandatory_https":"",
    "file_trim":"",
    "hsts":"",
    "quic":"",
    "cache":"",
    "seo_push_record":"",
    "seo_directly_origin":"",
    "traffic_limit_rate":0,
    "compress":"",
    "quota_id":0
    }

站点停止

接口描述

站点停止

请求结构

POST /host/shutdown
<公共请求头>

请求参数

参数名称	参数类型	是否必须	描述	示例值	参数位置
body	Object	否	查看请求体参数	{"host":"a.com"}	Body

请求体参数

参数名称	参数类型	是否必须	描述	示例值
host	String	是	站点	"a.com"

响应参数

无

请求示例

POST /host/shutdown

<公共请求头>
{"host":"a.com"}

响应示例

HTTP/1.1 200 OK
<公共响应头>
{
    "id":0,
    "resource_id":"",
    "host":"",
    "user_id":"",
    "cname_record":"",
    "iam_cert_id":"",
    "enable":"",
    "status":"",
    "route_type":"",
    "origins":null,
    "updated_at":"0001-01-01T00:00:00Z",
    "created_at":"0001-01-01T00:00:00Z",
    "ssl_versions":null,
    "ocsp_stapling":"",
    "mandatory_https":"",
    "file_trim":"",
    "hsts":"",
    "quic":"",
    "cache":"",
    "seo_push_record":"",
    "seo_directly_origin":"",
    "traffic_limit_rate":0,
    "compress":"",
    "quota_id":0
    }

更新IPv6

接口描述

更新ipv6

请求结构

POST /host/update_ipv6
<公共请求头>

请求参数

参数名称	参数类型	是否必须	描述	示例值	参数位置
body	Object	否	Updateipv6Request	null	Body

请求体参数

Updateipv6Request

参数名称	参数类型	是否必须	描述	示例值
host	String	是	站点	"a.com"
ipv6	String	是	是否优化，可选值"true" "false"	"true"

响应参数

无

请求示例

POST /host/update_ipv6

<公共请求头>
{"host":"a.com","ipv6":"true"}

响应示例

HTTP/1.1 200 OK
<公共响应头>
{
    "id":0,
    "resource_id":"",
    "host":"",
    "user_id":"",
    "cname_record":"",
    "iam_cert_id":"",
    "enable":"",
    "status":"",
    "route_type":"",
    "origins":null,
    "updated_at":"0001-01-01T00:00:00Z",
    "created_at":"0001-01-01T00:00:00Z",
    "ssl_versions":null,
    "ocsp_stapling":"",
    "mandatory_https":"",
    "file_trim":"",
    "hsts":"",
    "quic":"",
    "cache":"",
    "seo_push_record":"",
    "seo_directly_origin":"",
    "traffic_limit_rate":0,
    "compress":"",
    "quota_id":0
    }

更新TLS协议版本控制

接口描述

更新tls协议版本控制

请求结构

POST /host/batch_update_tls
<公共请求头>

请求参数

参数名称	参数类型	是否必须	描述	示例值	参数位置
body	Object	否	BatchUpdateTLSRequest	null	Body

请求体参数

BatchUpdateTLSRequest

参数名称	参数类型	是否必须	描述	示例值
host	String	是	站点	www.baidu.com
ssl_protocols	List<String>	是	协议，包含 (TLS10,TLS11,TLS12,TLS13)	["TLS10","TLS11"]

响应参数

无

请求示例

POST /host/batch_update_tls

<公共请求头>

{"host":"a.com","ssl_protocols":["TLS10","TLS11"]}

响应示例

HTTP/1.1 200 OK
<公共响应头>

{
    "id":0,
    "resource_id":"",
    "host":"",
    "user_id":"",
    "cname_record":"",
    "iam_cert_id":"",
    "enable":"",
    "status":"",
    "route_type":"",
    "origins":null,
    "updated_at":"0001-01-01T00:00:00Z",
    "created_at":"0001-01-01T00:00:00Z",
    "ssl_versions":null,
    "ocsp_stapling":"",
    "mandatory_https":"",
    "file_trim":"",
    "hsts":"",
    "quic":"",
    "cache":"",
    "seo_push_record":"",
    "seo_directly_origin":"",
    "traffic_limit_rate":0,
    "compress":"",
    "quota_id":0
    }

更新OCSP

接口描述

更新ocsp

请求结构

POST /host/update_ocsp
<公共请求头>

请求参数

参数名称	参数类型	是否必须	描述	示例值	参数位置
body	Object	否	UpdateOCSPRequest	null	Body

请求体参数

UpdateOCSPRequest

参数名称	参数类型	是否必须	描述	示例值
host	String	是	站点	"ac.com"
ocsp_stapling	String	是	是否启用，可选值 "true" "false"	"true" 或"false"

响应参数

无

请求示例

POST /host/update_ocsp

<公共请求头>
{"host":"a.com","ocsp_stapling":"true"}

响应示例

HTTP/1.1 200 OK
<公共响应头>
{
    "id":0,
    "resource_id":"",
    "host":"",
    "user_id":"",
    "cname_record":"",
    "iam_cert_id":"",
    "enable":"",
    "Enable1":false,
    "status":"",
    "route_type":"",
    "origins":null,
    "updated_at":"0001-01-01T00:00:00Z",
    "created_at":"0001-01-01T00:00:00Z",
    "ssl_versions":null,
    "ocsp_stapling":"",
    "mandatory_https":"",
    "file_trim":"",
    "hsts":"",
    "quic":"",
    "cache":"",
    "seo_push_record":"",
    "seo_directly_origin":"",
    "traffic_limit_rate":0,
    "compress":"",
    "quota_id":0
    }

更新QUIC

接口描述

更新quic

请求结构

POST /host/update_quic
<公共请求头>

请求参数

UpdatequicResponse

参数名称	参数类型	是否必须	描述	示例值
quic	String	是	是否启用，可选值 "true"或"false"	"true"
host	String	是	站点	"a.com"

响应参数

无

响应状态码

200

请求示例

POST /host/update_quic

<公共请求头>
{"host":"a.com","quic":"true"}

响应示例

HTTP/1.1 200 OK
<公共响应头>
{
    "id":0,
    "resource_id":"",
    "host":"",
    "user_id":"",
    "cname_record":"",
    "iam_cert_id":"",
    "enable":"",
    "Enable1":false,
    "status":"",
    "route_type":"",
    "origins":null,
    "updated_at":"0001-01-01T00:00:00Z",
    "created_at":"0001-01-01T00:00:00Z",
    "ssl_versions":null,
    "ocsp_stapling":"",
    "mandatory_https":"",
    "file_trim":"",
    "hsts":"",
    "quic":"",
    "cache":"",
    "seo_push_record":"",
    "seo_directly_origin":"",
    "traffic_limit_rate":0,
    "compress":"",
    "quota_id":0
    }

更新源站地址

接口描述

更新源站地址

请求结构

POST /host/update_origin
<公共请求头>

请求参数

参数名称	参数类型	是否必须	描述	示例值	参数位置
body	Object	否	UpdateOriginRequest	null	Body

请求体参数

UpdateOriginRequest

参数名称	参数类型	是否必须	描述	示例值
host	String	是	站点	"abc.com"
origins	Origin	是	源站数组	[{"addr":"2.2.2.2","http_port":"80","https_port":"443","type":""}]

响应参数

无

请求示例

POST /host/update_origin

<公共请求头>
{
    "host":"abc.com",
    "origins":[
        {
            "addr":"2.2.2.2",
            "http_port":"80",
            "https_port":"443",
            "type":""
        }
    ]
}

响应示例

HTTP/1.1 200 OK
<公共响应头>
{
    "id":0,
    "resource_id":"",
    "host":"",
    "user_id":"",
    "cname_record":"",
    "iam_cert_id":"",
    "enable":"",
    "Enable1":false,
    "status":"",
    "route_type":"",
    "origins":null,
    "updated_at":"0001-01-01T00:00:00Z",
    "created_at":"0001-01-01T00:00:00Z",
    "ssl_versions":null,
    "ocsp_stapling":"",
    "mandatory_https":"",
    "file_trim":"",
    "hsts":"",
    "quic":"",
    "cache":"",
    "seo_push_record":"",
    "seo_directly_origin":"",
    "traffic_limit_rate":0,
    "compress":"",
    "quota_id":0
    }

更新压缩

接口描述

更新压缩

请求结构

POST /host/update_compress
<公共请求头>

请求参数

参数名称	参数类型	是否必须	描述	示例值	参数位置
body	Object	否	UpdateCompressRequest	null	Body

请求体参数

UpdateCompressRequest

参数名称	参数类型	是否必须	描述	示例值
host	String	是	站点	"a.com"
compress	String	是	是否压缩，可选值"true" "false"	"true"

响应参数

无

请求示例

POST /host/update_compress

<公共请求头>
{
	"host": "a.com",
	"compress": "true"
}

响应示例

HTTP/1.1 200 OK
<公共响应头>
{
    "id":0,
    "resource_id":"",
    "host":"",
    "user_id":"",
    "cname_record":"",
    "iam_cert_id":"",
    "enable":"",
    "Enable1":false,
    "status":"",
    "route_type":"",
    "origins":null,
    "updated_at":"0001-01-01T00:00:00Z",
    "created_at":"0001-01-01T00:00:00Z",
    "ssl_versions":null,
    "ocsp_stapling":"",
    "mandatory_https":"",
    "file_trim":"",
    "hsts":"",
    "quic":"",
    "cache":"",
    "seo_push_record":"",
    "seo_directly_origin":"",
    "traffic_limit_rate":0,
    "compress":"",
    "quota_id":0
    }

更新SEO

接口描述

更新seo

请求结构

POST /host/update_seo
<公共请求头>

请求参数

参数名称	参数类型	是否必须	描述	示例值	参数位置
body	Object	否	UpdateSEORequest	null	Body

请求体参数

UpdateSEORequest

参数名称	参数类型	是否必须	描述	示例值
host	String	是	站点	"a.com"
seo_push_record	String	是	是否主动推数据，可选值"true" "false"	"true"
seo_directly_origin	String	是	是否直接回源"true" "false"	"true"

请求示例

POST /host/update_seo

<公共请求头>
{
	"host": "a.com",
	"seo_push_record": "true",
	"seo_directly_origin": "false"
}

响应参数

无

响应示例

HTTP/1.1 200 OK
<公共响应头>
{
    "id":0,
    "resource_id":"",
    "host":"",
    "user_id":"",
    "cname_record":"",
    "iam_cert_id":"",
    "enable":"",
    "status":"",
    "route_type":"",
    "origins":null,
    "updated_at":"0001-01-01T00:00:00Z",
    "created_at":"0001-01-01T00:00:00Z",
    "ssl_versions":null,
    "ocsp_stapling":"",
    "mandatory_https":"",
    "file_trim":"",
    "hsts":"",
    "quic":"",
    "cache":"",
    "seo_push_record":"",
    "seo_directly_origin":"",
    "traffic_limit_rate":0,
    "compress":"",
    "quota_id":0
    }

页面多余字符裁剪

接口说明

页面多余字符裁剪

请求结构

POST /host/update_file_trim
<公共请求头>

请求参数

参数名称	参数类型	是否必须	描述	示例值	参数位置
body	Object	否	UpdateFileTrimRequest	null	Body

请求体参数

UpdateFileTrimRequest

参数名称	参数类型	是否必须	描述	示例值
host	String	是	站点	"a.com"
trim	String	是	是否优化，可选值"true" "false"	"false"

响应参数

无

请求示例

POST /host/update_file_trim

<公共请求头>
{"host":"a.com","trim":"true"}

响应示例

HTTP/1.1 200 OK
<公共响应头>
{
    "id":0,
    "resource_id":"",
    "host":"",
    "user_id":"",
    "cname_record":"",
    "iam_cert_id":"",
    "enable":"",
    "Enable1":false,
    "status":"",
    "route_type":"",
    "origins":null,
    "updated_at":"0001-01-01T00:00:00Z",
    "created_at":"0001-01-01T00:00:00Z",
    "ssl_versions":null,
    "ocsp_stapling":"",
    "mandatory_https":"",
    "file_trim":"",
    "hsts":"",
    "quic":"",
    "cache":"",
    "seo_push_record":"",
    "seo_directly_origin":"",
    "traffic_limit_rate":0,
    "compress":"",
    "quota_id":0
    }

HTTPS强制跳转

接口描述

https强制跳转

请求结构

POST /host/update_mandatory_https
<公共请求头>

请求参数

参数名称	参数类型	是否必须	描述	示例值	参数位置
body	Object	否	UpdateMandatoryHTTPSRequest	null	Body

请求体参数

UpdateMandatoryHTTPSRequest

参数名称	参数类型	是否必须	描述	示例值
host	String	是	站点	"a.com"
mandatory_https	String	是	是否启动，可选"true","false"	"false"

响应参数

无

请求示例

POST /host/update_mandatory_https

<公共请求头>
{"host":"a.com","mandatory_https":"true"}

响应示例

HTTP/1.1 200 OK
<公共响应头>
{
    "id":0,
    "resource_id":"",
    "host":"",
    "user_id":"",
    "cname_record":"",
    "iam_cert_id":"",
    "enable":"",
    "status":"",
    "route_type":"",
    "origins":null,
    "updated_at":"0001-01-01T00:00:00Z",
    "created_at":"0001-01-01T00:00:00Z",
    "ssl_versions":null,
    "ocsp_stapling":"",
    "mandatory_https":"",
    "file_trim":"",
    "hsts":"",
    "quic":"",
    "cache":"",
    "seo_push_record":"",
    "seo_directly_origin":"",
    "traffic_limit_rate":0,
    "compress":"",
    "quota_id":0
    }

证书相关接口

附录

百度智能云

SSL证书服务 CAS

SSL证书服务 CAS

云SSL相关接口

站点列表

站点详情

站点停止

更新IPv6

更新TLS协议版本控制

更新OCSP

更新QUIC

更新源站地址

更新压缩

更新SEO

页面多余字符裁剪

HTTPS强制跳转