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

6.7 KiB
Raw Permalink Blame History

DNSProviderService

DNS服务商相关服务


countAllEnabledDNSProviders

计算服务商数量

  • 角色:admin
  • HTTPPOST https://backend.dooki.cloud/DNSProviderService/countAllEnabledDNSProviders
  • RPCrpc countAllEnabledDNSProviders (CountAllEnabledDNSProvidersRequest) returns (RPCCountResponse);

请求对象 (CountAllEnabledDNSProvidersRequest)

{
  "adminId": "int64 // 管理员ID",
  "userId": "int64 // 用户ID",
  "keyword": "string // 关键词",
  "domain": "string",
  "type": "string"
}

响应对象 (RPCCountResponse)

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

调用示例

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

createDNSProvider

创建服务商

  • 角色:admin
  • HTTPPOST https://backend.dooki.cloud/DNSProviderService/createDNSProvider
  • RPCrpc createDNSProvider (CreateDNSProviderRequest) returns (CreateDNSProviderResponse);

请求对象 (CreateDNSProviderRequest)

{
  "name": "string // 名称",
  "type": "string",
  "apiParamsJSON": "bytes",
  "minTTL": "int32 // 最小TTL"
}

响应对象 (CreateDNSProviderResponse)

{
  "dnsProviderId": "int64"
}

调用示例

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

deleteDNSProvider

删除服务商

  • 角色:admin
  • HTTPPOST https://backend.dooki.cloud/DNSProviderService/deleteDNSProvider
  • RPCrpc deleteDNSProvider (DeleteDNSProviderRequest) returns (RPCSuccess);

请求对象 (DeleteDNSProviderRequest)

{
  "dnsProviderId": "int64"
}

响应对象 (RPCSuccess)

{}

调用示例

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

findAllDNSProviderTypes

取得所有服务商类型

  • 角色:admin
  • HTTPPOST https://backend.dooki.cloud/DNSProviderService/findAllDNSProviderTypes
  • RPCrpc findAllDNSProviderTypes (FindAllDNSProviderTypesRequest) returns (FindAllDNSProviderTypesResponse);

请求对象 (FindAllDNSProviderTypesRequest)

{}

响应对象 (FindAllDNSProviderTypesResponse)

{
  "providerTypes": "[]DNSProviderType"
}

调用示例

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

findAllEnabledDNSProviders

查找所有的DNS服务商

  • 角色:admin
  • HTTPPOST https://backend.dooki.cloud/DNSProviderService/findAllEnabledDNSProviders
  • RPCrpc findAllEnabledDNSProviders (FindAllEnabledDNSProvidersRequest) returns (FindAllEnabledDNSProvidersResponse);

请求对象 (FindAllEnabledDNSProvidersRequest)

{
  "adminId": "int64 // 管理员ID",
  "userId": "int64 // 用户ID"
}

响应对象 (FindAllEnabledDNSProvidersResponse)

{
  "dnsProviders": "[]DNSProvider"
}

调用示例

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

findAllEnabledDNSProvidersWithType

取得某个类型的所有服务商

  • 角色:admin
  • HTTPPOST https://backend.dooki.cloud/DNSProviderService/findAllEnabledDNSProvidersWithType
  • RPCrpc findAllEnabledDNSProvidersWithType (FindAllEnabledDNSProvidersWithTypeRequest) returns (FindAllEnabledDNSProvidersWithTypeResponse);

请求对象 (FindAllEnabledDNSProvidersWithTypeRequest)

{
  "providerTypeCode": "string"
}

响应对象 (FindAllEnabledDNSProvidersWithTypeResponse)

{
  "dnsProviders": "[]DNSProvider"
}

调用示例

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

findEnabledDNSProvider

查找单个服务商

  • 角色:admin
  • HTTPPOST https://backend.dooki.cloud/DNSProviderService/findEnabledDNSProvider
  • RPCrpc findEnabledDNSProvider (FindEnabledDNSProviderRequest) returns (FindEnabledDNSProviderResponse);

请求对象 (FindEnabledDNSProviderRequest)

{
  "dnsProviderId": "int64 // DNS服务商ID",
  "maskParams": "bool // 是否对参数中的密钥进行掩码"
}

响应对象 (FindEnabledDNSProviderResponse)

{
  "dnsProvider": "DNSProvider // DNS服务商信息"
}

调用示例

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

listEnabledDNSProviders

列出单页服务商信息

  • 角色:admin
  • HTTPPOST https://backend.dooki.cloud/DNSProviderService/listEnabledDNSProviders
  • RPCrpc listEnabledDNSProviders (ListEnabledDNSProvidersRequest) returns (ListEnabledDNSProvidersResponse);

请求对象 (ListEnabledDNSProvidersRequest)

{
  "adminId": "int64 // 管理员ID",
  "userId": "int64 // 用户ID",
  "keyword": "string // 关键词",
  "domain": "string",
  "type": "string",
  "offset": "int64 // 读取位置",
  "size": "int64 // 数量通常不能小于0"
}

响应对象 (ListEnabledDNSProvidersResponse)

{
  "dnsProviders": "[]DNSProvider"
}

调用示例

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

updateDNSProvider

修改服务商

  • 角色:admin
  • HTTPPOST https://backend.dooki.cloud/DNSProviderService/updateDNSProvider
  • RPCrpc updateDNSProvider (UpdateDNSProviderRequest) returns (RPCSuccess);

请求对象 (UpdateDNSProviderRequest)

{
  "dnsProviderId": "int64",
  "name": "string // 名称",
  "apiParamsJSON": "bytes",
  "minTTL": "int32 // 最小TTL"
}

响应对象 (RPCSuccess)

{}

调用示例

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