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

6.1 KiB
Raw Permalink Blame History

ADPackageInstanceService

高防实例服务


countADPackageInstances

计算实例数量

  • 角色:admin
  • HTTPPOST https://backend.dooki.cloud/ADPackageInstanceService/countADPackageInstances
  • RPCrpc countADPackageInstances(CountADPackageInstancesRequest) returns (RPCCountResponse);

请求对象 (CountADPackageInstancesRequest)

{
  "adNetworkId": "int64 // 可选,线路",
  "adPackageId": "int64 // 可选,如果不填则表示获取所有实例数量",
  "userId": "int64 // 可选用户ID",
  "ip": "string // 可选高防IP"
}

响应对象 (RPCCountResponse)

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

调用示例

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

countIdleADPackageInstances

计算可购的实例数量

  • 角色:admin
  • HTTPPOST https://backend.dooki.cloud/ADPackageInstanceService/countIdleADPackageInstances
  • RPCrpc countIdleADPackageInstances(CountIdleADPackageInstancesRequest) returns (RPCCountResponse);

请求对象 (CountIdleADPackageInstancesRequest)

{
  "adPackageId": "int64"
}

响应对象 (RPCCountResponse)

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

调用示例

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

createADPackageInstance

创建实例

  • 角色:admin
  • HTTPPOST https://backend.dooki.cloud/ADPackageInstanceService/createADPackageInstance
  • RPCrpc createADPackageInstance(CreateADPackageInstanceRequest) returns (CreateADPackageInstanceResponse);

请求对象 (CreateADPackageInstanceRequest)

{
  "adPackageId": "int64",
  "nodeClusterId": "int64 // 集群ID",
  "nodeIds": "[]int64",
  "ipAddresses": "[]string"
}

响应对象 (CreateADPackageInstanceResponse)

{
  "adPackageInstanceId": "int64"
}

调用示例

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

deleteADPackageInstance

删除实例

  • 角色:admin
  • HTTPPOST https://backend.dooki.cloud/ADPackageInstanceService/deleteADPackageInstance
  • RPCrpc deleteADPackageInstance(DeleteADPackageInstanceRequest) returns (RPCSuccess);

请求对象 (DeleteADPackageInstanceRequest)

{
  "adPackageInstanceId": "int64"
}

响应对象 (RPCSuccess)

{}

调用示例

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

findADPackageInstance

查找单个实例

  • 角色:admin
  • HTTPPOST https://backend.dooki.cloud/ADPackageInstanceService/findADPackageInstance
  • RPCrpc findADPackageInstance(FindADPackageInstanceRequest) returns (FindADPackageInstanceResponse);

请求对象 (FindADPackageInstanceRequest)

{
  "adPackageInstanceId": "int64"
}

响应对象 (FindADPackageInstanceResponse)

{
  "adPackageInstance": "ADPackageInstance"
}

调用示例

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

findAllADPackageInstances

列出单个高防产品所有实例

  • 角色:admin
  • HTTPPOST https://backend.dooki.cloud/ADPackageInstanceService/findAllADPackageInstances
  • RPCrpc findAllADPackageInstances(FindAllADPackageInstancesRequest) returns (FindAllADPackageInstancesResponse);

请求对象 (FindAllADPackageInstancesRequest)

{
  "adPackageId": "int64"
}

响应对象 (FindAllADPackageInstancesResponse)

{
  "adPackageInstances": "[]ADPackageInstance"
}

调用示例

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

listADPackageInstances

列出单页实例

  • 角色:admin
  • HTTPPOST https://backend.dooki.cloud/ADPackageInstanceService/listADPackageInstances
  • RPCrpc listADPackageInstances(ListADPackageInstancesRequest) returns (ListADPackageInstancesResponse);

请求对象 (ListADPackageInstancesRequest)

{
  "adNetworkId": "int64 // 可选,线路",
  "adPackageId": "int64 // 可选,如果不填则表示获取所有实例数量",
  "userId": "int64 // 可选用户ID",
  "ip": "string // 可选高防IP",
  "offset": "int64 // 读取位置",
  "size": "int64 // 数量通常不能小于0"
}

响应对象 (ListADPackageInstancesResponse)

{
  "adPackageInstances": "[]ADPackageInstance"
}

调用示例

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

updateADPackageInstance

修改实例

  • 角色:admin
  • HTTPPOST https://backend.dooki.cloud/ADPackageInstanceService/updateADPackageInstance
  • RPCrpc updateADPackageInstance(UpdateADPackageInstanceRequest) returns (RPCSuccess);

请求对象 (UpdateADPackageInstanceRequest)

{
  "adPackageInstanceId": "int64",
  "nodeClusterId": "int64 // 集群ID",
  "nodeIds": "[]int64",
  "ipAddresses": "[]string",
  "isOn": "bool // 是否启用"
}

响应对象 (RPCSuccess)

{}

调用示例

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