Appearance
域名管理
域名管理接口用于对监控域名进行增删查操作,以及管理上传客户端设置。
域名列表
获取当前用户所有监控域名。
- URL:
/open/domainData/domainList - 方法:
GET
请求参数
| 参数 | 类型 | 必填 | 说明 |
|---|---|---|---|
| identityId | integer | 否 | 用户身份 ID,不传则查询默认身份 |
请求示例
bash
curl "https://cookieplus.perk-net.com/api/open/domainData/domainList" \
-H "token: d7b******62f"bash
curl "https://cookieplus.perk-net.com/api/open/domainData/domainList?identityId=1" \
-H "token: d7b******62f"响应示例
json
{
"code": 200,
"msg": "执行成功",
"data": [
{
"domain": "perk-net.com",
"deviceId": "fp-fc616b7c0d336568f7ca2423409ec702",
"keepAlive": 0
}
]
}响应字段
| 字段 | 类型 | 说明 |
|---|---|---|
| domain | string | 域名 |
| deviceId | string | 客户端设备 ID |
| keepAlive | integer | Cookie 保活时间,单位分钟;0 为不保活 |
新增域名
添加一个新的监控域名。
- URL:
/open/domainData/addDomain - 方法:
POST - Content-Type:
application/json
请求参数
| 参数 | 类型 | 必填 | 说明 |
|---|---|---|---|
| domain | string | 是 | 监控域名 |
| deviceId | string | 是 | 客户端设备 ID |
| keepAlive | integer | 是 | 保活时间,单位分钟;0 代表不保活 |
| identityId | integer | 否 | 用户身份 ID,不传则使用默认身份 |
请求示例
bash
curl -X POST https://cookieplus.perk-net.com/api/open/domainData/addDomain \
-H "token: d7b******62f" \
-H "Content-Type: application/json" \
-d '{
"domain": "perk-net.com",
"deviceId": "fp-fc616b7c0d336568f7ca2423409ec702",
"keepAlive": 0
}'响应示例
json
{
"code": 200,
"msg": "执行成功",
"data": {
"deviceId": "fp-fc616b7c0d336568f7ca2423409ec702"
}
}响应字段
| 字段 | 类型 | 说明 |
|---|---|---|
| deviceId | string | 客户端设备 ID |
删除域名
删除一个监控域名。
- URL:
/open/domainData/deleteDomain - 方法:
GET
请求参数
| 参数 | 类型 | 必填 | 说明 |
|---|---|---|---|
| domain | string | 是 | 要删除的监控域名 |
| identityId | integer | 否 | 用户身份 ID,不传则使用默认身份 |
请求示例
bash
curl "https://cookieplus.perk-net.com/api/open/domainData/deleteDomain?domain=perk-net.com" \
-H "token: d7b******62f"响应示例
json
{
"code": 200,
"msg": "执行成功"
}设置上传客户端
为指定域名设置上传客户端。只有设置为上传客户端的设备才会执行数据上传。
- URL:
/open/domainData/setUploadClient - 方法:
POST - Content-Type:
application/json
请求参数
| 参数 | 类型 | 必填 | 说明 |
|---|---|---|---|
| domain | string | 是 | 域名 |
| deviceId | string | 是 | 客户端设备 ID |
| keepAlive | integer | 是 | 保活时间,单位分钟;0 代表不保活 |
| identityId | integer | 否 | 用户身份 ID,不传则使用默认身份 |
请求示例
bash
curl -X POST https://cookieplus.perk-net.com/api/open/domainData/setUploadClient \
-H "token: d7b******62f" \
-H "Content-Type: application/json" \
-d '{
"domain": "perk-net.com",
"deviceId": "fp-fc616b7c0d336568f7ca2423409ec702",
"keepAlive": 0
}'响应示例
json
{
"code": 200,
"msg": "执行成功"
}获取上传客户端
获取指定域名当前设置的上传客户端设备 ID。
- URL:
/open/domainData/uploadClient - 方法:
GET
请求参数
| 参数 | 类型 | 必填 | 说明 |
|---|---|---|---|
| domain | string | 是 | 域名 |
| identityId | integer | 否 | 用户身份 ID,不传则使用默认身份 |
请求示例
bash
curl "https://cookieplus.perk-net.com/api/open/domainData/uploadClient?domain=perk-net.com" \
-H "token: d7b******62f"响应示例
json
{
"code": 200,
"msg": "执行成功",
"data": "fp-fc616b7c0d336568f7ca2423409ec702"
}响应字段
data 为当前上传客户端的设备 ID 字符串。如果该域名尚未添加监控,data 为 null。
