2. Domain 域名相关 API 配置

当前版本尚不支持使用 api 修改缓存设定。

1. getDomains 获取域名

GET

/domains

示范

curl -XGET http://api.example.com/client/v1/domains
groupName=mygroupName \

-H "Authorization: Bearer
eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJ1c2VybmFtZSI6ImFkbWluIi
wiZXhwIjoxNTc2OTEwODEzLCJpYXQiOjE1NzY5MDcyMTN9.P8HVCsFTt
YAm0_UTwT4bxLw2ct3eQNkBhTXyopo2WMo"

Query string

栏位	类型	描述
groupName	String	获取指定群组域名。
size	String	回传资料笔数。预设：10。
from	String	从第 n 笔开始。预设：0。
_source	String	指定返回栏位。预设：全部。
serviceGroupName	String	获取指定服务群组域名。预设：无。
tags	String	获取指定标签域名。预设：无。

2. getDomain 获取单个域名

GET

/domains/:servername

示范

curl -XGET http://api.example.com/client/v1/domains/mysite.com?
groupName=mygroupName \

-H "Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJ1c2VybmFtZSI6ImFkbWluIi
wiZXhwIjoxNTc2OTEwODEzLCJpYXQiOjE1NzY5MDcyMTN9.P8HVCsFTt
YAm0_UTwT4bxLw2ct3eQNkBhTXyopo2WMo" \

参数

栏位	类型	描述
servername	String	域名。

Query string

栏位	类型	描述
groupName	String	获取指定群组域名。
_source	String	指定返回栏位。预设：全部。

3. addDomain 添加域名

POST

/domains

示范

curl -XPOST http://api.example.com/client/v1/domains \

-H 'Content-Type: Application/json' \

-H "Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJ1c2VybmFtZSI6ImFkbWluIi
wiZXhwIjoxNTc2OTEzMTcyLCJpYXQiOjE1NzY5MDk1NzJ9.K-
7c3AXP9iXE7hCQnygG3og2ZrpGwbdI7YTI2ktci_U" \

-d '{
"groupName": "mygroupName",
"servername": "mysite1.com",
"serviceGroupName": "test001",
"origins": ["1.1.1.1"]
}'

参数

栏位	类型	描述
groupName	String	群组。
servername	String	域名。
appProfileName 选填	String	专案名称。预设：none。
serviceGroupName	String	服务群组。
origins	String[]	回源地址。多选，可填写 IP 或是 域名。
tags 选填	String[]	标签。预设：[]。
description 选填	String	叙述。预设：无。
scheme 选填	String[]	协议。多选，示范：["http", "https"]。预设：["http"]。
keypairname 选填	String	凭证组名称。预设：self-sign。
httpPort 选填	String[]	http 监听端口。多选，可选范围 80, 8080, 8880, 2052, 2082, 2086, 2095。预设：[80]。
httpsPort 选填	String[]	https 监听端口。多选，可选范围 443 及 1001-4999、6001-32767。除了 httpPort 和 9600 不可选。预设：[443]。
redirecthttps 选填	Boolean	是否开启 302 跳转 https。预设：false。
useHsts 选填	Boolean	是否开启 HSTS。预设：false。
useSystemCert 选填	Boolean	是否使用系统凭证。预设：true。
usedWafRules 选填	String[]	套用的 waf 规则。多选，内容必须包含规则名称 value，以及是否启用 isEnabled 比如：[{"value": "myrule", "isEnabled": false }]。预设：[]。
originscheme 选填	String	回源协议。可填写 http, https，如果源站有 302 https, 则必须填写 https。预设 http。
originPort 选填	Number	回源端口。originscheme 为 http 时预设 80, originscheme 为 https 时预设 443。
portMappingType 选填	String	回源端口映射方式。可填写 default 或是 static，预设 default。
setCustomHostHeader 选填	String	是否替换回源 Host Header。可填写 on 或是 off，预设 off。
customHostHeader 选填	String	替换回源 Host Header 的值。当 setCustomHostHeader 设置为 on 的时候才生效。
isAcceptHttpV1 选填	Boolean	是否接受以 HTTP v1 的形式访问。预设：false。

4. editDomain 修改域名

PATCH

/domains/:servern

示范

curl -XPATCH http://api.example.com/client/v1/domains/mysite.com \

-H 'Content-Type: Application/json' \

-H "Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJ1c2VybmFtZSI6ImFkbWluIi
wiZXhwIjoxNTc2OTEzMTcyLCJpYXQiOjE1NzY5MDk1NzJ9.K-
7c3AXP9iXE7hCQnygG3og2ZrpGwbdI7YTI2ktci_U" \

-d '{
"groupName": "mygroupName",
"serviceGroupName": "test001",
"origins": ["1.1.1.2"],
"isAcceptHttpV1": true
}'

参数

栏位	类型	描述
groupName	String	群组。
servername	String	域名。
appProfileName	String	专案名称。预设：none。
serviceGroupName	String	服务群组。
origins	String[]	回源地址。多选，可填写 IP 或是 域名。
tags	String[]	标签。预设：[]。
description	String	叙述。预设：无。
scheme	String[]	协议。多选，示范：["http", "https"]。预设：["http"]。
keypairname	String	凭证组名称。
httpPort	String[]	http 监听端口。多选，可选范围 80, 8080, 8880, 2052, 2082, 2086, 2095。预设：[80]。
httpsPort	String[]	https 监听端口。多选，可选范围 443 及 1001-4999、6001-32767。除了 httpPort 和 9600 不可选。预设：[443]。
redirecthttps	Boolean	是否开启 302 跳转 https。预设：false。
useHsts	Boolean	是否开启 HSTS。预设：false。
useSystemCert	Boolean	是否使用系统凭证。预设：true。
usedWafRules	String[]	套用的 waf 规则。多选，内容必须包含规则名称 value，以及是否启用 isEnabled 比如：[{"value": "myrule", "isEnabled": false }]。预设：[]。
originscheme	String	回源协议。可填写 http, https，如果源站有 302 https, 则必须填写 https 预设 http。
originPort	Number	回源端口。originscheme 预设 80。
portMappingType	String	回源端口映射方式。可填写 default 或是 static，预设 default。
setCustomHostHeader	String	是否替换回源 Host Header。可填写 on 或是 off，预设 off。
customHostHeader	String	替换回源 Host Header 的值。当 setCustomHostHeader 设置为 on 的时候才生效。
isAcceptHttpV1	Boolean	是否接受以 HTTP v1 的形式访问。预设：false。

5. removeDomain 删除域名

DELETE

/domains/:servername

示范

curl -XDELETE http://api.example.com/client/v1/domains/mysite1.com \

-H 'Content-Type: Application/json' \

-H "Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJ1c2VybmFtZSI6ImFkbWluIi
wiZXhwIjoxNTc2OTEzMTcyLCJpYXQiOjE1NzY5MDk1NzJ9.K-
7c3AXP9iXE7hCQnygG3og2ZrpGwbdI7YTI2ktci_U" \

-d '{
"groupName": "mygroupName"
}'

参数

栏位	类型	描述
groupName	String	群组。
servername	String	域名。

6. purgeCache 清除缓存

POST

/domains/purge_cache

示范

curl -XPOST http://api.example.com/client/v1/domains/purge_cache \

-H 'Content-Type: Application/json' \

-H "Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJ1c2VybmFtZSI6ImFkbWluIi
wiZXhwIjoxNTc2OTEzMTcyLCJpYXQiOjE1NzY5MDk1NzJ9.K-
7c3AXP9iXE7hCQnygG3og2ZrpGwbdI7YTI2ktci_U" \

-d '{
"groupName": "mygroupName",
"keys": [
{ "domain": "host1.com", "key": "/assets" },
{ "domain": "host2.com", "key": "/images/foo.png" },
{ "domain": "host3.com" }
]
}'

参数

栏位	类型	描述
groupName	String	群组。
keys	String	清除的缓存路径。多选，内容必须包含域名 domain; 路径 key 为选填，缺少 key 则清除域名下全部缓存。比如：[{"domain": "mydomain.com", "key": "/img" }]