云SSL相关接口
站点列表
接口描述
站点列表,查看用户所拥有的云端证书部署的站点
请求结构
1POST /host/list_host
2<公共请求头>
请求参数
参数名称 | 参数类型 | 是否必须 | 描述 | 示例值 | 参数位置 |
---|---|---|---|---|---|
body | Object | 否 | HostlistRequest | null | Body |
请求体参数
HostlistRequest
参数名称 | 参数类型 | 是否必须 | 描述 | 示例值 |
---|---|---|---|---|
host | String | 是 | 站点 | "a.com" |
响应参数
无
请求示例
POST /host/list_host
1<公共请求头>
2{
3 "host" : "host"
4}
响应示例
1HTTP/1.1 200 OK
2<公共响应头>
3[
4 {
5 "host":"aaa.com",
6 "status":"RUNNING",
7 "resource_id":"xxx"
8 },
9 {
10 "host":"bbb.com",
11 "status":"SUSPEND",
12 "resource_id":"yyy"
13 }
14]
站点详情
接口描述
站点详情
请求结构
1POST /host/detail
2<公共请求头>
请求参数
参数名称 | 参数类型 | 是否必须 | 描述 | 示例值 | 参数位置 |
---|---|---|---|---|---|
body | Object | 否 | DetailRequest | null | Body |
请求体参数
DetailRequest
参数名称 | 参数类型 | 是否必须 | 描述 | 示例值 |
---|---|---|---|---|
host | String | 是 | 站点 | "a.com" |
响应参数
无
请求示例
POST /host/detail
1<公共请求头>
2{"host":"a.com"}
响应示例
1HTTP/1.1 200 OK
2<公共响应头>
3{
4 "id":0,
5 "resource_id":"",
6 "host":"",
7 "user_id":"",
8 "cname_record":"",
9 "iam_cert_id":"",
10 "enable":"",
11 "status":"",
12 "route_type":"",
13 "origins":null,
14 "updated_at":"0001-01-01T00:00:00Z",
15 "created_at":"0001-01-01T00:00:00Z",
16 "ssl_versions":null,
17 "ocsp_stapling":"",
18 "mandatory_https":"",
19 "file_trim":"",
20 "hsts":"",
21 "quic":"",
22 "cache":"",
23 "seo_push_record":"",
24 "seo_directly_origin":"",
25 "traffic_limit_rate":0,
26 "compress":"",
27 "quota_id":0
28 }
站点停止
接口描述
站点停止
请求结构
1POST /host/shutdown
2<公共请求头>
请求参数
参数名称 | 参数类型 | 是否必须 | 描述 | 示例值 | 参数位置 |
---|---|---|---|---|---|
body | Object | 否 | 查看请求体参数 | {"host":"a.com"} | Body |
请求体参数
参数名称 | 参数类型 | 是否必须 | 描述 | 示例值 |
---|---|---|---|---|
host | String | 是 | 站点 | "a.com" |
响应参数
无
请求示例
POST /host/shutdown
1<公共请求头>
2{"host":"a.com"}
响应示例
1HTTP/1.1 200 OK
2<公共响应头>
3{
4 "id":0,
5 "resource_id":"",
6 "host":"",
7 "user_id":"",
8 "cname_record":"",
9 "iam_cert_id":"",
10 "enable":"",
11 "status":"",
12 "route_type":"",
13 "origins":null,
14 "updated_at":"0001-01-01T00:00:00Z",
15 "created_at":"0001-01-01T00:00:00Z",
16 "ssl_versions":null,
17 "ocsp_stapling":"",
18 "mandatory_https":"",
19 "file_trim":"",
20 "hsts":"",
21 "quic":"",
22 "cache":"",
23 "seo_push_record":"",
24 "seo_directly_origin":"",
25 "traffic_limit_rate":0,
26 "compress":"",
27 "quota_id":0
28 }
更新IPv6
接口描述
更新ipv6
请求结构
1POST /host/update_ipv6
2<公共请求头>
请求参数
参数名称 | 参数类型 | 是否必须 | 描述 | 示例值 | 参数位置 |
---|---|---|---|---|---|
body | Object | 否 | Updateipv6Request | null | Body |
请求体参数
Updateipv6Request
参数名称 | 参数类型 | 是否必须 | 描述 | 示例值 |
---|---|---|---|---|
host | String | 是 | 站点 | "a.com" |
ipv6 | String | 是 | 是否优化,可选值"true" "false" | "true" |
响应参数
无
请求示例
POST /host/update_ipv6
1<公共请求头>
2{"host":"a.com","ipv6":"true"}
响应示例
1HTTP/1.1 200 OK
2<公共响应头>
3{
4 "id":0,
5 "resource_id":"",
6 "host":"",
7 "user_id":"",
8 "cname_record":"",
9 "iam_cert_id":"",
10 "enable":"",
11 "status":"",
12 "route_type":"",
13 "origins":null,
14 "updated_at":"0001-01-01T00:00:00Z",
15 "created_at":"0001-01-01T00:00:00Z",
16 "ssl_versions":null,
17 "ocsp_stapling":"",
18 "mandatory_https":"",
19 "file_trim":"",
20 "hsts":"",
21 "quic":"",
22 "cache":"",
23 "seo_push_record":"",
24 "seo_directly_origin":"",
25 "traffic_limit_rate":0,
26 "compress":"",
27 "quota_id":0
28 }
更新TLS协议版本控制
接口描述
更新tls协议版本控制
请求结构
1POST /host/batch_update_tls
2<公共请求头>
请求参数
参数名称 | 参数类型 | 是否必须 | 描述 | 示例值 | 参数位置 |
---|---|---|---|---|---|
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
1<公共请求头>
2
3{"host":"a.com","ssl_protocols":["TLS10","TLS11"]}
响应示例
1HTTP/1.1 200 OK
2<公共响应头>
3
4{
5 "id":0,
6 "resource_id":"",
7 "host":"",
8 "user_id":"",
9 "cname_record":"",
10 "iam_cert_id":"",
11 "enable":"",
12 "status":"",
13 "route_type":"",
14 "origins":null,
15 "updated_at":"0001-01-01T00:00:00Z",
16 "created_at":"0001-01-01T00:00:00Z",
17 "ssl_versions":null,
18 "ocsp_stapling":"",
19 "mandatory_https":"",
20 "file_trim":"",
21 "hsts":"",
22 "quic":"",
23 "cache":"",
24 "seo_push_record":"",
25 "seo_directly_origin":"",
26 "traffic_limit_rate":0,
27 "compress":"",
28 "quota_id":0
29 }
更新OCSP
接口描述
更新ocsp
请求结构
1POST /host/update_ocsp
2<公共请求头>
请求参数
参数名称 | 参数类型 | 是否必须 | 描述 | 示例值 | 参数位置 |
---|---|---|---|---|---|
body | Object | 否 | UpdateOCSPRequest | null | Body |
请求体参数
UpdateOCSPRequest
参数名称 | 参数类型 | 是否必须 | 描述 | 示例值 |
---|---|---|---|---|
host | String | 是 | 站点 | "ac.com" |
ocsp_stapling | String | 是 | 是否启用,可选值 "true" "false" | "true" 或"false" |
响应参数
无
请求示例
POST /host/update_ocsp
1<公共请求头>
2{"host":"a.com","ocsp_stapling":"true"}
响应示例
1HTTP/1.1 200 OK
2<公共响应头>
3{
4 "id":0,
5 "resource_id":"",
6 "host":"",
7 "user_id":"",
8 "cname_record":"",
9 "iam_cert_id":"",
10 "enable":"",
11 "Enable1":false,
12 "status":"",
13 "route_type":"",
14 "origins":null,
15 "updated_at":"0001-01-01T00:00:00Z",
16 "created_at":"0001-01-01T00:00:00Z",
17 "ssl_versions":null,
18 "ocsp_stapling":"",
19 "mandatory_https":"",
20 "file_trim":"",
21 "hsts":"",
22 "quic":"",
23 "cache":"",
24 "seo_push_record":"",
25 "seo_directly_origin":"",
26 "traffic_limit_rate":0,
27 "compress":"",
28 "quota_id":0
29 }
更新QUIC
接口描述
更新quic
请求结构
1POST /host/update_quic
2<公共请求头>
请求参数
UpdatequicResponse
参数名称 | 参数类型 | 是否必须 | 描述 | 示例值 |
---|---|---|---|---|
quic | String | 是 | 是否启用,可选值 "true"或"false" | "true" |
host | String | 是 | 站点 | "a.com" |
响应参数
无
响应状态码
200
请求示例
POST /host/update_quic
1<公共请求头>
2{"host":"a.com","quic":"true"}
响应示例
1HTTP/1.1 200 OK
2<公共响应头>
3{
4 "id":0,
5 "resource_id":"",
6 "host":"",
7 "user_id":"",
8 "cname_record":"",
9 "iam_cert_id":"",
10 "enable":"",
11 "Enable1":false,
12 "status":"",
13 "route_type":"",
14 "origins":null,
15 "updated_at":"0001-01-01T00:00:00Z",
16 "created_at":"0001-01-01T00:00:00Z",
17 "ssl_versions":null,
18 "ocsp_stapling":"",
19 "mandatory_https":"",
20 "file_trim":"",
21 "hsts":"",
22 "quic":"",
23 "cache":"",
24 "seo_push_record":"",
25 "seo_directly_origin":"",
26 "traffic_limit_rate":0,
27 "compress":"",
28 "quota_id":0
29 }
更新源站地址
接口描述
更新源站地址
请求结构
1POST /host/update_origin
2<公共请求头>
请求参数
参数名称 | 参数类型 | 是否必须 | 描述 | 示例值 | 参数位置 |
---|---|---|---|---|---|
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
1<公共请求头>
2{
3 "host":"abc.com",
4 "origins":[
5 {
6 "addr":"2.2.2.2",
7 "http_port":"80",
8 "https_port":"443",
9 "type":""
10 }
11 ]
12}
响应示例
1HTTP/1.1 200 OK
2<公共响应头>
3{
4 "id":0,
5 "resource_id":"",
6 "host":"",
7 "user_id":"",
8 "cname_record":"",
9 "iam_cert_id":"",
10 "enable":"",
11 "Enable1":false,
12 "status":"",
13 "route_type":"",
14 "origins":null,
15 "updated_at":"0001-01-01T00:00:00Z",
16 "created_at":"0001-01-01T00:00:00Z",
17 "ssl_versions":null,
18 "ocsp_stapling":"",
19 "mandatory_https":"",
20 "file_trim":"",
21 "hsts":"",
22 "quic":"",
23 "cache":"",
24 "seo_push_record":"",
25 "seo_directly_origin":"",
26 "traffic_limit_rate":0,
27 "compress":"",
28 "quota_id":0
29 }
更新压缩
接口描述
更新压缩
请求结构
1POST /host/update_compress
2<公共请求头>
请求参数
参数名称 | 参数类型 | 是否必须 | 描述 | 示例值 | 参数位置 |
---|---|---|---|---|---|
body | Object | 否 | UpdateCompressRequest | null | Body |
请求体参数
UpdateCompressRequest
参数名称 | 参数类型 | 是否必须 | 描述 | 示例值 |
---|---|---|---|---|
host | String | 是 | 站点 | "a.com" |
compress | String | 是 | 是否压缩,可选值"true" "false" | "true" |
响应参数
无
请求示例
POST /host/update_compress
1<公共请求头>
2{
3 "host": "a.com",
4 "compress": "true"
5}
响应示例
1HTTP/1.1 200 OK
2<公共响应头>
3{
4 "id":0,
5 "resource_id":"",
6 "host":"",
7 "user_id":"",
8 "cname_record":"",
9 "iam_cert_id":"",
10 "enable":"",
11 "Enable1":false,
12 "status":"",
13 "route_type":"",
14 "origins":null,
15 "updated_at":"0001-01-01T00:00:00Z",
16 "created_at":"0001-01-01T00:00:00Z",
17 "ssl_versions":null,
18 "ocsp_stapling":"",
19 "mandatory_https":"",
20 "file_trim":"",
21 "hsts":"",
22 "quic":"",
23 "cache":"",
24 "seo_push_record":"",
25 "seo_directly_origin":"",
26 "traffic_limit_rate":0,
27 "compress":"",
28 "quota_id":0
29 }
更新SEO
接口描述
更新seo
请求结构
1POST /host/update_seo
2<公共请求头>
请求参数
参数名称 | 参数类型 | 是否必须 | 描述 | 示例值 | 参数位置 |
---|---|---|---|---|---|
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
1<公共请求头>
2{
3 "host": "a.com",
4 "seo_push_record": "true",
5 "seo_directly_origin": "false"
6}
响应参数
无
响应示例
1HTTP/1.1 200 OK
2<公共响应头>
3{
4 "id":0,
5 "resource_id":"",
6 "host":"",
7 "user_id":"",
8 "cname_record":"",
9 "iam_cert_id":"",
10 "enable":"",
11 "status":"",
12 "route_type":"",
13 "origins":null,
14 "updated_at":"0001-01-01T00:00:00Z",
15 "created_at":"0001-01-01T00:00:00Z",
16 "ssl_versions":null,
17 "ocsp_stapling":"",
18 "mandatory_https":"",
19 "file_trim":"",
20 "hsts":"",
21 "quic":"",
22 "cache":"",
23 "seo_push_record":"",
24 "seo_directly_origin":"",
25 "traffic_limit_rate":0,
26 "compress":"",
27 "quota_id":0
28 }
页面多余字符裁剪
接口说明
页面多余字符裁剪
请求结构
1POST /host/update_file_trim
2<公共请求头>
请求参数
参数名称 | 参数类型 | 是否必须 | 描述 | 示例值 | 参数位置 |
---|---|---|---|---|---|
body | Object | 否 | UpdateFileTrimRequest | null | Body |
请求体参数
UpdateFileTrimRequest
参数名称 | 参数类型 | 是否必须 | 描述 | 示例值 |
---|---|---|---|---|
host | String | 是 | 站点 | "a.com" |
trim | String | 是 | 是否优化,可选值"true" "false" | "false" |
响应参数
无
请求示例
POST /host/update_file_trim
1<公共请求头>
2{"host":"a.com","trim":"true"}
响应示例
1HTTP/1.1 200 OK
2<公共响应头>
3{
4 "id":0,
5 "resource_id":"",
6 "host":"",
7 "user_id":"",
8 "cname_record":"",
9 "iam_cert_id":"",
10 "enable":"",
11 "Enable1":false,
12 "status":"",
13 "route_type":"",
14 "origins":null,
15 "updated_at":"0001-01-01T00:00:00Z",
16 "created_at":"0001-01-01T00:00:00Z",
17 "ssl_versions":null,
18 "ocsp_stapling":"",
19 "mandatory_https":"",
20 "file_trim":"",
21 "hsts":"",
22 "quic":"",
23 "cache":"",
24 "seo_push_record":"",
25 "seo_directly_origin":"",
26 "traffic_limit_rate":0,
27 "compress":"",
28 "quota_id":0
29 }
HTTPS强制跳转
接口描述
https强制跳转
请求结构
1POST /host/update_mandatory_https
2<公共请求头>
请求参数
参数名称 | 参数类型 | 是否必须 | 描述 | 示例值 | 参数位置 |
---|---|---|---|---|---|
body | Object | 否 | UpdateMandatoryHTTPSRequest | null | Body |
请求体参数
UpdateMandatoryHTTPSRequest
参数名称 | 参数类型 | 是否必须 | 描述 | 示例值 |
---|---|---|---|---|
host | String | 是 | 站点 | "a.com" |
mandatory_https | String | 是 | 是否启动,可选"true","false" | "false" |
响应参数
无
请求示例
POST /host/update_mandatory_https
1<公共请求头>
2{"host":"a.com","mandatory_https":"true"}
响应示例
1HTTP/1.1 200 OK
2<公共响应头>
3{
4 "id":0,
5 "resource_id":"",
6 "host":"",
7 "user_id":"",
8 "cname_record":"",
9 "iam_cert_id":"",
10 "enable":"",
11 "status":"",
12 "route_type":"",
13 "origins":null,
14 "updated_at":"0001-01-01T00:00:00Z",
15 "created_at":"0001-01-01T00:00:00Z",
16 "ssl_versions":null,
17 "ocsp_stapling":"",
18 "mandatory_https":"",
19 "file_trim":"",
20 "hsts":"",
21 "quic":"",
22 "cache":"",
23 "seo_push_record":"",
24 "seo_directly_origin":"",
25 "traffic_limit_rate":0,
26 "compress":"",
27 "quota_id":0
28 }