4. AppProfile 专案相关 API 配置

URL: https://api-client.apeirocdn.com/api/v1

1. resources.appProfiles.list 呈现当前的专案列表

Method : GET

① 示范 (curl 模式)

curl --location 'https://api-client.apeirocdn.com/api/v1/resources/app-profiles?groupName=cdn-xxx&from=0&size=10&filters=servername:example.com' \
--header 'Cookie: access_token=my-token' \

Parameter :

栏位

类型

预设/填写范例

描述

groupName

required

string

groupName=cdn-xxx

项目的群组名称

from

integer

from=0

从第 n 笔开始。预设：0。

size

integer

size=10

回传资料笔数。预设：10。

filters

string

Default: " "

filters=itemName:my_name

filters=appProfileDomainsLength Example: filters=servername:example.com filters=appProfileDomainsLength:2

用于检索项目的过滤器。

使用 +AND 来分隔过滤特征
使用 * 作为通配符
itemName=栏位名称 my_name=该栏位后面的 value
appProfile 当前域名使用量：appProfileDomainsLength
可以透过 appProfileDomainsLength 查看当前专案中域名使用量，例如：appProfileDomainsLength:2 即为过滤专案内只有两个域名的 Profile

2. resources.appProfiles.create 添加专案

Method : POST

① 示范 (curl 模式)

curl --location --request POST 'https://api-client.apeirocdn.com/api/v1/resources/app-profiles?groupName=cdn-xxx' \
  --header 'content-type: application/json' \
  --header 'Cookie: access_token=my-token' \
  --data '{"appProfileName":"example.profiles","serviceGroupName":"cdn-xxx-a01-ws","origins":["1.1.1.1","www.example.com"]}'

Parameter :

栏位

类型

预设/填写范例

描述

groupName

required

string

groupName=cdn-xxx

项目的群组名称

Body :

栏位

类型

预设/填写范例

描述

description

string

Default: ""

注解字段

3. resources.appProfiles.get 取得专案信息

Method : GET

① 示范 (curl 模式)

curl --location --request GET 'https://api-client.apeirocdn.com/api/v1/resources/app-profiles/{appProfileId}?groupName=cdn-xxx' \
--header 'Content-type: application/json' \ 
--header 'Cookie: access_token=my-token'

Path :

Path

类型

预设/填写范例

描述

appProfileId

required

string

<groupName>-<appProfileName> Example：cdn-xxx-my-profile

格式为群组名称 - 专案名称

Parameter :

栏位

类型

预设/填写范例

描述

groupName

required

string

groupName=cdn-xxx

项目的群组名称

4. resources.appProfiles.update 更新专案信息

Method : PATCH

① 示范 (curl 模式)

curl --location --request PATCH 'https://api-client.apeirocdn.com/api/v1/resources/app-profiles/{appProfileId}?groupName=cdn-xxx' \
  --header 'Content-Type: application/json' \
  --header 'Cookie: access_token=my-token' \
  --data '{"serviceGroupName":"my-servicegroup","origins":["1.1.1.1","www.example.com"]}'

Path :

Path

类型

预设/填写范例

描述

appProfileId

required

string

<groupName>-<appProfileName> Example：cdn-xxx-my-profile

格式为群组名称 - 专案名称

Parameter :

栏位

类型

预设/填写范例

描述

groupName

required

string

groupName=cdn-xxx

项目的群组名称

Body :

栏位

类型

预设/填写范例

描述

description

string

Default: ""

描述字段内容

5. resources.appProfiles.delete 删除专案信息

Method : DELETE

① 示范 (curl 模式)

curl --location --request DELETE 'https://api-client.apeirocdn.com/api/v1/resources/app-profiles/{appProfileId}?groupName=cdn-xxx' \
--header 'content-type: application/json' \
--header 'Cookie: access_token=my-token' \
--data ''

Path :

Path

类型

预设/填写范例

描述

appProfileId

required

string

<groupName>-<appProfileName> Example：cdn-xxx-my-profile

格式为群组名称 - 专案名称

Parameter :

栏位

类型

预设/填写范例

描述

groupName

required

string

groupName=cdn-xxx

项目的群组名称

6. purge cache of the app-profile 针对专案清除缓存

Method : POST

① 示范 (curl 模式)

curl --location --request POST 'https://api-client.apeirocdn.com/api/v1/resources/app-profiles/_actions/purgeCache?groupName=cdn-xxx' \
--header 'Content-Type: application/json' \
--header 'Cookie: access_token=my-token' \
--data '{
    "keys": [
        {
            "appProfileName": "my-profile1.com",
            "key": "/"
        },
        {
            "appProfileName": "my-profile2.com",
            "key": "/image"
        },
        {
            "appProfileName": "my-profile3.com",
            "key": "/background.png"
        }
    ]
}'

Parameter :

栏位

类型

预设/填写范例

描述

groupName

required

string

groupName=cdn-xxx

项目的群组名称

Body :

栏位

类型

预设/填写范例

描述

appProfileName

required

string

my-profile1.com

项目的专案名称

key

Array of objects

non-empty

/image

清除缓存路径/资源格式

7. OWASP 相关设定

Method : 添加专案 : POST

Method : 更新专案 : PATCH

① 示范 (curl 模式)

curl --location --request POST \
  --url 'https://api-client.apeirocdn.com/api/v1/resources/app-profiles?groupName=cdn-xxx' \
  --header 'content-type: application/json' \
  --header 'Cookie: access_token=my-token' \
  --data '{
  "appProfileName":"example.profiles",
  "serviceGroupName": "cdn-xxx-a01-ws",
  "origins": [
    "1.1.1.1",
    "www.example.com"
  ],
   "isUseOwasp":true,
   "owaspRuleName": "sys_default"  
}'

上述为添加专案 : POST 的代码，如要更新专案请将 "--request" 更改为 PATCH。

Parameter :

栏位

类型

预设/填写范例

描述

groupName

required

string

groupName=cdn-xxx

项目的群组名称

Body :

栏位

类型

预设/填写范例

描述

isUseOwasp

boolean

Default: false

使用 OWASP 开关

owaspRuleName

required if isUseOwasp is true

string

Example: "sys_default"

OWASP 规则，当 isUseOwasp 为 true 时必填

8. 回源 URL 改写设定

Method : 添加专案 : POST

Method : 更新专案 : PATCH

① 示范 (curl 模式)

curl --location --request POST \
  --url 'https://api-client.apeirocdn.com/api/v1/resources/app-profiles?groupName=cdn-xxx' \
  --header 'content-type: application/json' \
  --header 'Cookie: access_token=my-token' \
  --data '{
  "servername": "example.com",
  "serviceGroupName": "cdn-xxx-a01-ws",
  "origins": [
        "1.1.1.1",
        "www.example.com"
        ],
    "rewriteUrlRules": [
        {
            "description": "測試建立",
            "isRewriteUrlPath": True,
            "sourcePath": "/test123",
            "destPath": "/test9999",
            "isRewriteUrlArgs": True,
            "rewriteUrlArgsRules": 
            [
                {
                "sourceArgs": "22",
                "destArgs": "55",
                "isReplaceAll": True,
                "isIteration": True
                },
                {
                "sourceArgs": "11",
                "destArgs": "66",
                "isReplaceAll": True,
                "isIteration": True
                },
            ]
        }
                    ]
}'
}'

上述为添加专案 : POST 的代码，如要更新专案请将 "--request" 更改为 PATCH。

Parameter :

栏位

类型

预设/填写范例

描述

groupName

required

string

groupName=cdn-xxx

项目的群组名称

Body :

栏位

类型

预设/填写范例

描述

rewriteUrlRules

Array of objects

Example: See below

改写回源 URL 的规则集合

description

string

Default: ""

描述此改写规则的用途

isRewriteUrlPath

boolean

Default: false

是否启用路径改写

sourcePath

string

Default: ""

改写目标路径

destPath

string

Default: ""

替换路径

isReplaceAll

boolean

Default: false

是否开启全部替换

isIteration

boolean

Default: false

是否开启迭代

isRewriteUrlArgs

boolean

Default: false

是否启用 args 改写

rewriteUrlArgsRules

Array of objects

Default: []

改写 args 的规则集合

sourceArgs

string

Default: ""

改写目标 args

destArgs

string

Default: ""

替换 args

isReplaceAll

boolean

Default: false

是否开启全部替换

isIteration

boolean

Default: false

是否开启迭代

9. 进阶缓存设定

Method : 添加专案时增加进阶缓存设定 : POST

Method : 更新进阶缓存设定 : PATCH

① 示范 (curl 模式)

curl --location --request POST \
  --url 'https://api-client.apeirocdn.com/api/v1/resources/app-profiles?groupName=cdn-xxx' \
  --header 'content-type: application/json' \
  --header 'Cookie: access_token=my-token' \
  --data '{
  "servername": "example.com",
   "cacheUrlRules": [
        {
        "cacheType": "cache",
        "uriPath": "/rule1",
        "description": "rule 1",
        "isSlice": true,
        "slice": 8,
        "isPassSetCookie": true,
        "browserExp": 60,
        "serverExp": 5,
        "argsType": "keepAll",
        "argsRules": []
        },
        {
        "cacheType": "cache",
        "uriPath": "/rule2",
        "description": "rule 2",
        "isSlice": false,
        "slice": 5,
        "isPassSetCookie": false,
        "browserExp": 60,
        "serverExp": 11,
        "argsType": "ignoreAll",
        "argsRules": []
        }
    ]
}'

上述为添加专案时增加进阶缓存设定 : POST 的代码，如要更新设定请将 "--request" 更改为 PATCH。

Parameter :

栏位

类型

预设/填写范例

描述

groupName

required

string

groupName=cdn-xxx

项目的群组名称

Body:

栏位

类型

预设/填写范例

描述

cacheUrlRules

Array of objects

Example: See below

进阶缓存规则集合，以 "{ }" 分开多条规则

cacheType

String

Default: "" Example: "cache"

缓存类型，栏位可套用唯一值如下: - followOrigin (遵循源站) - cache (缓存) - notCache (不缓存)

uriPath

String

Default: "" Example: "/rule1"

指定缓存路径

description

String

Default: "" Example: "this-is-rule1"

描述此缓存规则的用途

isSlice

Boolean

Default: false Example: "true"

是否开启拆分缓存大小功能

slice

Number

Default: Example: "5"

缓存文件拆分大小，单位 : MB

browserExp

Number

Default: Example: "5"

资源在浏览器过期时间，单位 : min

serverExp

Number

Default: Example: "5"

资源在服务器过期时间，单位 : min

argsType

Array of objects

Default: []

Args 缓存规则集合，栏位可套用唯一值如下: - keepAll (全部保留) - ignoreAll (全部忽略) - keepParams (保留指定参数，其余忽略) - ignoreParams (忽略指定参数，其余保留)

argsRules

Array of objects Key : string Value : string

Default: [] Example: [{"key": "456", "value":"789"}, "key": "123", "value":"321"}]

argsType 缓存规则的详细对象参数

Previous3. WafRules WAF 规则相关 API 配置 Next5. Certs API 配置文件

Last updated 20 days ago