方法列表
创建单个域名
admin
user
RPC
createNSDomain (CreateNSDomainRequest) returns (CreateNSDomainResponse)
HTTP
POST /NSDomainService/createNSDomain
输入对象:CreateNSDomainRequest:
{ // 所属集群 int64 nsClusterId; // 所属用户 int64 userId; // 域名 string name; // 域名分组ID []int64 nsDomainGroupIds; }
输出对象:CreateNSDomainResponse:
批量创建域名
admin
user
RPC
createNSDomains (CreateNSDomainsRequest) returns (CreateNSDomainsResponse)
HTTP
POST /NSDomainService/createNSDomains
输入对象:CreateNSDomainsRequest:
{ // 所属集群 int64 nsClusterId; // 所属用户 int64 userId; // 一组域名 []string names; // 域名分组ID []int64 nsDomainGroupIds; }
输出对象:CreateNSDomainsResponse:
修改域名
admin
user
RPC
updateNSDomain (UpdateNSDomainRequest) returns (RPCSuccess)
HTTP
POST /NSDomainService/updateNSDomain
输入对象:UpdateNSDomainRequest:
{ int64 nsDomainId; int64 nsClusterId; // 用户ID int64 userId; // 域名分组ID []int64 nsDomainGroupIds; // 是否启用 bool isOn; }
输出对象:RPCSuccess:
{ }
修改域名状态
admin
RPC
updateNSDomainStatus (UpdateNSDomainStatusRequest) returns (RPCSuccess)
HTTP
POST /NSDomainService/updateNSDomainStatus
输入对象:UpdateNSDomainStatusRequest:
输出对象:RPCSuccess:
{ }
删除域名
admin
user
RPC
deleteNSDomain (DeleteNSDomainRequest) returns (RPCSuccess)
HTTP
POST /NSDomainService/deleteNSDomain
输入对象:DeleteNSDomainRequest:
输出对象:RPCSuccess:
{ }
批量删除域名
admin
user
RPC
deleteNSDomains (DeleteNSDomainsRequest) returns (RPCSuccess)
HTTP
POST /NSDomainService/deleteNSDomains
输入对象:DeleteNSDomainsRequest:
{ []string names; // 域名所属用户ID int64 userId; }
输出对象:RPCSuccess:
{ }
查找单个域名
admin
user
RPC
findNSDomain (FindNSDomainRequest) returns (FindNSDomainResponse)
HTTP
POST /NSDomainService/findNSDomain
输入对象:FindNSDomainRequest:
{ // 域名ID int64 nsDomainId; }
输出对象:FindNSDomainResponse:
根据域名名称查找域名
admin
user
RPC
findNSDomainWithName (FindNSDomainWithNameRequest) returns (FindNSDomainWithNameResponse)
HTTP
POST /NSDomainService/findNSDomainWithName
输入对象:FindNSDomainWithNameRequest:
{ // 用户ID,只有管理员才能指定用户 int64 userId; // 域名 string name; }
输出对象:FindNSDomainWithNameResponse:
根据域名名称查找集群中的已验证域名
admin
RPC
findVerifiedNSDomainOnCluster (FindVerifiedNSDomainOnClusterRequest) returns (FindVerifiedNSDomainOnClusterResponse)
HTTP
POST /NSDomainService/findVerifiedNSDomainOnCluster
输入对象:FindVerifiedNSDomainOnClusterRequest:
{ // 集群ID int64 nsClusterId; // 域名 string name; }
输出对象:FindVerifiedNSDomainOnClusterResponse:
计算域名数量
admin
user
RPC
countAllNSDomains (CountAllNSDomainsRequest) returns (RPCCountResponse)
HTTP
POST /NSDomainService/countAllNSDomains
输入对象:CountAllNSDomainsRequest:
输出对象:RPCCountResponse:
{ // 数量 int64 count; }
列出单页域名
admin
user
RPC
listNSDomains (ListNSDomainsRequest) returns (ListNSDomainsResponse)
HTTP
POST /NSDomainService/listNSDomains
输入对象:ListNSDomainsRequest:
{ // 用户ID int64 userId; int64 nsClusterId; // 关键词 string keyword; int64 nsDomainGroupId; // 读取位置 int64 offset; // 数量,通常不能小于0 int64 size; }
输出对象:ListNSDomainsResponse:
查找TSIG配置
admin
RPC
findNSDomainTSIG (FindNSDomainTSIGRequest) returns (FindNSDomainTSIGResponse)
HTTP
POST /NSDomainService/findNSDomainTSIG
输入对象:FindNSDomainTSIGRequest:
输出对象:FindNSDomainTSIGResponse:
修改TSIG配置
admin
RPC
updateNSDomainTSIG (UpdateNSDomainTSIGRequest) returns (RPCSuccess)
HTTP
POST /NSDomainService/updateNSDomainTSIG
输入对象:UpdateNSDomainTSIGRequest:
输出对象:RPCSuccess:
{ }
检查一组域名是否在用户账户中存在
admin
user
RPC
existNSDomains (ExistNSDomainsRequest) returns (ExistNSDomainsResponse)
HTTP
POST /NSDomainService/existNSDomains
输入对象:ExistNSDomainsRequest:
{ []string names; // 用户ID int64 userId; }
输出对象:ExistNSDomainsResponse:
检查一组域名是否已通过验证
admin
user
RPC
existVerifiedNSDomains (ExistVerifiedNSDomainsRequest) returns (ExistVerifiedNSDomainsResponse)
HTTP
POST /NSDomainService/existVerifiedNSDomains
输入对象:ExistVerifiedNSDomainsRequest:
输出对象:ExistVerifiedNSDomainsResponse:
获取域名验证信息
admin
user
RPC
findNSDomainVerifyingInfo (FindNSDomainVerifyingInfoRequest) returns (FindNSDomainVerifyingInfoResponse)
HTTP
POST /NSDomainService/findNSDomainVerifyingInfo
输入对象:FindNSDomainVerifyingInfoRequest:
{ // 要验证的域名ID int64 nsDomainId; }
输出对象:FindNSDomainVerifyingInfoResponse:
{ // 是否需要TXT验证,如果不需要(值false),则表示用户不需要手动设置TXT,此时 txt 字段内容可能为空 bool requireTXT; // TXT记录 string txt; // TXT过期时间 int64 expiresAt; // 当前状态 string status; }
验证域名信息
admin
user
RPC
verifyNSDomain (VerifyNSDomainRequest) returns (VerifyNSDomainResponse)
HTTP
POST /NSDomainService/verifyNSDomain
输入对象:VerifyNSDomainRequest:
输出对象:VerifyNSDomainResponse:
{ // 是否成功 bool isOk; // 错误代码 string errorCode; // 错误消息 string errorMessage; // 当前的TXT值 []string currentTXTValues; // 当前的NS记录值 []string currentNSValues; }
查询记录健康检查全局设置
admin
user
RPC
findNSDomainRecordsHealthCheck (FindNSDomainRecordsHealthCheckRequest) returns (FindNSDomainRecordsHealthCheckResponse)
HTTP
POST /NSDomainService/findNSDomainRecordsHealthCheck
输入对象:FindNSDomainRecordsHealthCheckRequest:
{ // 域名ID int64 nsDomainId; }
输出对象:FindNSDomainRecordsHealthCheckResponse:
{ // 健康检查设置 bytes nsDomainRecordsHealthCheckJSON; }
修改记录健康检查全局设置
admin
user
RPC
updateNSDomainRecordsHealthCheck (UpdateNSDomainRecordsHealthCheckRequest) returns (RPCSuccess)
HTTP
POST /NSDomainService/updateNSDomainRecordsHealthCheck
输入对象:UpdateNSDomainRecordsHealthCheckRequest:
{ // 域名ID int64 nsDomainId; // 健康检查设置 bytes nsDomainRecordsHealthCheckJSON; }
输出对象:RPCSuccess:
{ }