Files
pyGoEdge-UserPanel/reference/goedge 文档/UserADInstanceService.md
2025-11-18 03:36:49 +08:00

5.9 KiB
Raw Permalink Blame History

UserADInstanceService

用户高防实例服务


buyUserADInstance

购买用户高防实例

  • 角色:admin
  • HTTPPOST https://backend.dooki.cloud/UserADInstanceService/buyUserADInstance
  • RPCrpc buyUserADInstance(BuyUserADInstanceRequest) returns (BuyUserADInstanceResponse);

请求对象 (BuyUserADInstanceRequest)

{
  "userId": "int64 // 用户ID",
  "adPackageId": "int64",
  "adPackagePeriodId": "int64",
  "count": "int32 // 数量"
}

响应对象 (BuyUserADInstanceResponse)

{
  "userADInstanceIds": "[]int64"
}

调用示例

curl -X POST "https://backend.dooki.cloud/UserADInstanceService/buyUserADInstance" \
  -H "Content-Type: application/json" \
  -H "X-Edge-Access-Token: <YOUR_TOKEN>" \
  -d '{
    ...
  }'

countUserADInstances

计算用户高防实例数量

  • 角色:admin
  • HTTPPOST https://backend.dooki.cloud/UserADInstanceService/countUserADInstances
  • RPCrpc countUserADInstances(CountUserADInstancesRequest) returns (RPCCountResponse);

请求对象 (CountUserADInstancesRequest)

{
  "adNetworkId": "int64 // 线路ID",
  "userId": "int64 // 用户ID",
  "adPackagePeriodId": "int64",
  "expiresDay": "string",
  "availableOnly": "bool // 是否只查询有效的高防实例"
}

响应对象 (RPCCountResponse)

{
  "count": "int64 // 数量"
}

调用示例

curl -X POST "https://backend.dooki.cloud/UserADInstanceService/countUserADInstances" \
  -H "Content-Type: application/json" \
  -H "X-Edge-Access-Token: <YOUR_TOKEN>" \
  -d '{
    ...
  }'

createUserADInstance

创建用户高防实例

  • 角色:admin
  • HTTPPOST https://backend.dooki.cloud/UserADInstanceService/createUserADInstance
  • RPCrpc createUserADInstance(CreateUserADInstanceRequest) returns (CreateUserADInstanceResponse);

请求对象 (CreateUserADInstanceRequest)

{
  "userId": "int64 // 用户ID",
  "adPackageId": "int64",
  "adPackagePeriodId": "int64",
  "count": "int32 // 数量"
}

响应对象 (CreateUserADInstanceResponse)

{
  "userADInstanceIds": "[]int64"
}

调用示例

curl -X POST "https://backend.dooki.cloud/UserADInstanceService/createUserADInstance" \
  -H "Content-Type: application/json" \
  -H "X-Edge-Access-Token: <YOUR_TOKEN>" \
  -d '{
    ...
  }'

deleteUserADInstance

删除用户高防实例

  • 角色:admin
  • HTTPPOST https://backend.dooki.cloud/UserADInstanceService/deleteUserADInstance
  • RPCrpc deleteUserADInstance(DeleteUserADInstanceRequest) returns (RPCSuccess);

请求对象 (DeleteUserADInstanceRequest)

{
  "userADInstanceId": "int64"
}

响应对象 (RPCSuccess)

{}

调用示例

curl -X POST "https://backend.dooki.cloud/UserADInstanceService/deleteUserADInstance" \
  -H "Content-Type: application/json" \
  -H "X-Edge-Access-Token: <YOUR_TOKEN>" \
  -d '{
    ...
  }'

findUserADInstance

查找单个用户高防实例

  • 角色:admin
  • HTTPPOST https://backend.dooki.cloud/UserADInstanceService/findUserADInstance
  • RPCrpc findUserADInstance(FindUserADInstanceRequest) returns (FindUserADInstanceResponse);

请求对象 (FindUserADInstanceRequest)

{
  "userADInstanceId": "int64"
}

响应对象 (FindUserADInstanceResponse)

{
  "userADInstance": "UserADInstance"
}

调用示例

curl -X POST "https://backend.dooki.cloud/UserADInstanceService/findUserADInstance" \
  -H "Content-Type: application/json" \
  -H "X-Edge-Access-Token: <YOUR_TOKEN>" \
  -d '{
    ...
  }'

listUserADInstances

列出单页用户高防实例

  • 角色:admin
  • HTTPPOST https://backend.dooki.cloud/UserADInstanceService/listUserADInstances
  • RPCrpc listUserADInstances(ListUserADInstancesRequest) returns (ListUserADInstancesResponse);

请求对象 (ListUserADInstancesRequest)

{
  "adNetworkId": "int64 // 线路ID",
  "userId": "int64 // 用户ID",
  "adPackagePeriodId": "int64",
  "expiresDay": "string",
  "availableOnly": "bool // 是否只查询有效的高防实例",
  "offset": "int64 // 读取位置",
  "size": "int64 // 数量通常不能小于0"
}

响应对象 (ListUserADInstancesResponse)

{
  "userADInstances": "[]UserADInstance"
}

调用示例

curl -X POST "https://backend.dooki.cloud/UserADInstanceService/listUserADInstances" \
  -H "Content-Type: application/json" \
  -H "X-Edge-Access-Token: <YOUR_TOKEN>" \
  -d '{
    ...
  }'

renewUserADInstance

续期用户高防实例

  • 角色:admin
  • HTTPPOST https://backend.dooki.cloud/UserADInstanceService/renewUserADInstance
  • RPCrpc renewUserADInstance(RenewUserADInstanceRequest) returns (RPCSuccess);

请求对象 (RenewUserADInstanceRequest)

{
  "userADInstanceId": "int64",
  "adPackagePeriodId": "int64"
}

响应对象 (RPCSuccess)

{}

调用示例

curl -X POST "https://backend.dooki.cloud/UserADInstanceService/renewUserADInstance" \
  -H "Content-Type: application/json" \
  -H "X-Edge-Access-Token: <YOUR_TOKEN>" \
  -d '{
    ...
  }'

updateUserADInstanceObjects

修改实例防护对象

  • 角色:admin
  • HTTPPOST https://backend.dooki.cloud/UserADInstanceService/updateUserADInstanceObjects
  • RPCrpc updateUserADInstanceObjects(UpdateUserADInstanceObjectsRequest) returns (RPCSuccess);

请求对象 (UpdateUserADInstanceObjectsRequest)

{
  "userADInstanceId": "int64",
  "objectCodes": "[]string"
}

响应对象 (RPCSuccess)

{}

调用示例

curl -X POST "https://backend.dooki.cloud/UserADInstanceService/updateUserADInstanceObjects" \
  -H "Content-Type: application/json" \
  -H "X-Edge-Access-Token: <YOUR_TOKEN>" \
  -d '{
    ...
  }'