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

6.4 KiB
Raw Permalink Blame History

NodeGrantService

节点认证信息管理服务


countAllEnabledNodeGrants

计算认证的数量

  • 角色:admin
  • HTTPPOST https://backend.dooki.cloud/NodeGrantService/countAllEnabledNodeGrants
  • RPCrpc countAllEnabledNodeGrants (CountAllEnabledNodeGrantsRequest) returns (RPCCountResponse);

请求对象 (CountAllEnabledNodeGrantsRequest)

{
  "keyword": "string // 关键词"
}

响应对象 (RPCCountResponse)

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

调用示例

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

createNodeGrant

创建认证

  • 角色:admin
  • HTTPPOST https://backend.dooki.cloud/NodeGrantService/createNodeGrant
  • RPCrpc createNodeGrant (CreateNodeGrantRequest) returns (CreateNodeGrantResponse);

请求对象 (CreateNodeGrantRequest)

{
  "name": "string // 名称",
  "method": "string",
  "username": "string",
  "password": "string",
  "privateKey": "string",
  "passphrase": "string",
  "description": "string // 描述(备注)",
  "nodeId": "int64 // 节点ID",
  "su": "bool"
}

响应对象 (CreateNodeGrantResponse)

{
  "nodeGrantId": "int64"
}

调用示例

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

disableNodeGrant

禁用认证

  • 角色:admin
  • HTTPPOST https://backend.dooki.cloud/NodeGrantService/disableNodeGrant
  • RPCrpc disableNodeGrant (DisableNodeGrantRequest) returns (DisableNodeGrantResponse);

请求对象 (DisableNodeGrantRequest)

{
  "nodeGrantId": "int64"
}

响应对象 (DisableNodeGrantResponse)

{}

调用示例

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

findAllEnabledNodeGrants

列出所有认证

  • 角色:admin
  • HTTPPOST https://backend.dooki.cloud/NodeGrantService/findAllEnabledNodeGrants
  • RPCrpc findAllEnabledNodeGrants (FindAllEnabledNodeGrantsRequest) returns (FindAllEnabledNodeGrantsResponse);

请求对象 (FindAllEnabledNodeGrantsRequest)

{}

响应对象 (FindAllEnabledNodeGrantsResponse)

{
  "nodeGrants": "[]NodeGrant"
}

调用示例

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

findEnabledNodeGrant

获取单个认证信息

  • 角色:admin
  • HTTPPOST https://backend.dooki.cloud/NodeGrantService/findEnabledNodeGrant
  • RPCrpc findEnabledNodeGrant (FindEnabledNodeGrantRequest) returns (FindEnabledNodeGrantResponse);

请求对象 (FindEnabledNodeGrantRequest)

{
  "nodeGrantId": "int64"
}

响应对象 (FindEnabledNodeGrantResponse)

{
  "nodeGrant": "NodeGrant"
}

调用示例

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

findSuggestNodeGrants

查找集群推荐的认证

  • 角色:admin
  • HTTPPOST https://backend.dooki.cloud/NodeGrantService/findSuggestNodeGrants
  • RPCrpc findSuggestNodeGrants(FindSuggestNodeGrantsRequest) returns (FindSuggestNodeGrantsResponse);

请求对象 (FindSuggestNodeGrantsRequest)

{
  "nodeClusterId": "int64 // 边缘节点集群",
  "nsClusterId": "int64 // NS节点集群"
}

响应对象 (FindSuggestNodeGrantsResponse)

{
  "nodeGrants": "[]NodeGrant"
}

调用示例

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

listEnabledNodeGrants

列出单页认证

  • 角色:admin
  • HTTPPOST https://backend.dooki.cloud/NodeGrantService/listEnabledNodeGrants
  • RPCrpc listEnabledNodeGrants (ListEnabledNodeGrantsRequest) returns (ListEnabledNodeGrantsResponse);

请求对象 (ListEnabledNodeGrantsRequest)

{
  "keyword": "string // 关键词",
  "offset": "int64 // 读取位置",
  "size": "int64 // 数量通常不能小于0"
}

响应对象 (ListEnabledNodeGrantsResponse)

{
  "nodeGrants": "[]NodeGrant"
}

调用示例

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

testNodeGrant

测试连接

  • 角色:admin
  • HTTPPOST https://backend.dooki.cloud/NodeGrantService/testNodeGrant
  • RPCrpc testNodeGrant (TestNodeGrantRequest) returns (TestNodeGrantResponse);

请求对象 (TestNodeGrantRequest)

{
  "nodeGrantId": "int64",
  "host": "string",
  "port": "int32"
}

响应对象 (TestNodeGrantResponse)

{
  "isOk": "bool",
  "error": "string"
}

调用示例

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

updateNodeGrant

修改认证

  • 角色:admin
  • HTTPPOST https://backend.dooki.cloud/NodeGrantService/updateNodeGrant
  • RPCrpc updateNodeGrant (UpdateNodeGrantRequest) returns (RPCSuccess);

请求对象 (UpdateNodeGrantRequest)

{
  "nodeGrantId": "int64",
  "name": "string // 名称",
  "method": "string",
  "username": "string",
  "password": "string",
  "privateKey": "string",
  "passphrase": "string",
  "description": "string // 描述(备注)",
  "nodeId": "int64 // 节点ID",
  "su": "bool"
}

响应对象 (RPCSuccess)

{}

调用示例

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