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

4.2 KiB
Raw Blame History

NSPlanService

DNS套餐服务


createNSPlan

创建DNS套餐

  • 角色:admin
  • HTTPPOST https://backend.dooki.cloud/NSPlanService/createNSPlan
  • RPCrpc createNSPlan(CreateNSPlanRequest) returns (CreateNSPlanResponse);

请求对象 (CreateNSPlanRequest)

{
  "name": "string // 名称",
  "monthlyPrice": "float",
  "yearlyPrice": "float",
  "configJSON": "bytes"
}

响应对象 (CreateNSPlanResponse)

{
  "nsPlanId": "int64"
}

调用示例

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

deleteNSPlan

删除DNS套餐

  • 角色:admin
  • HTTPPOST https://backend.dooki.cloud/NSPlanService/deleteNSPlan
  • RPCrpc deleteNSPlan(DeleteNSPlanRequest) returns (RPCSuccess);

请求对象 (DeleteNSPlanRequest)

{
  "nsPlanId": "int64"
}

响应对象 (RPCSuccess)

{}

调用示例

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

findAllEnabledNSPlans

查找所有可用DNS套餐

  • 角色:admin, user
  • HTTPPOST https://backend.dooki.cloud/NSPlanService/findAllEnabledNSPlans
  • RPCrpc findAllEnabledNSPlans(FindAllEnabledNSPlansRequest) returns (FindAllEnabledNSPlansResponse);

请求对象 (FindAllEnabledNSPlansRequest)

{}

响应对象 (FindAllEnabledNSPlansResponse)

{
  "nsPlans": "[]NSPlan"
}

调用示例

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

findAllNSPlans

查找所有DNS套餐

  • 角色:admin
  • HTTPPOST https://backend.dooki.cloud/NSPlanService/findAllNSPlans
  • RPCrpc findAllNSPlans(FindAllNSPlansRequest) returns (FindAllNSPlansResponse);

请求对象 (FindAllNSPlansRequest)

{}

响应对象 (FindAllNSPlansResponse)

{
  "nsPlans": "[]NSPlan"
}

调用示例

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

findNSPlan

查找DNS套餐

  • 角色:admin, user
  • HTTPPOST https://backend.dooki.cloud/NSPlanService/findNSPlan
  • RPCrpc findNSPlan(FindNSPlanRequest) returns (FindNSPlanResponse);

请求对象 (FindNSPlanRequest)

{
  "nsPlanId": "int64"
}

响应对象 (FindNSPlanResponse)

{
  "nsPlan": "NSPlan"
}

调用示例

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

sortNSPlanOrders

修改DNS套餐顺序

  • 角色:admin
  • HTTPPOST https://backend.dooki.cloud/NSPlanService/sortNSPlanOrders
  • RPCrpc sortNSPlanOrders(SortNSPlansRequest) returns (RPCSuccess);

请求对象 (SortNSPlansRequest)

{
  "nsPlanIds": "[]int64"
}

响应对象 (RPCSuccess)

{}

调用示例

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

updateNSPlan

修改DNS套餐

  • 角色:admin
  • HTTPPOST https://backend.dooki.cloud/NSPlanService/updateNSPlan
  • RPCrpc updateNSPlan(UpdateNSPlanRequest) returns (RPCSuccess);

请求对象 (UpdateNSPlanRequest)

{
  "nsPlanId": "int64",
  "name": "string // 名称",
  "isOn": "bool // 是否启用",
  "monthlyPrice": "float",
  "yearlyPrice": "float",
  "configJSON": "bytes"
}

响应对象 (RPCSuccess)

{}

调用示例

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