-
响应参数 返回状态码为200:删除成功,响应体参考CommonResponse。 CommonResponse对象的参数列表,详细请参见表3。 返回状态码为202:请求正在处理中,请求处理详情请通过“查询业务编排结果”接口,确认是否处理成功。响应体参考DeviceRadiusDeleteResponse。 DeviceRadiusDeleteResponse对象的参数列表,详细请参见表4。 返回状态码为400:请求参数错误。 详细信息请参见实际响应消息体。 返回状态码为500:内部异常。 详细信息请参见实际响应消息体。
-
请求示例 HTTP的示例 POST /controller/campus/rest/sdwan/v1/device/radius/template/action/batch-delete HTTP/1.1
Host: 192.168.1.125:18002
Content-Type: application/json
Accept: application/json
Accept-Language: en-US
X-AC
CES S-TOKEN: x-yyyyyy
{
"ids" : ["fbb684c8-0d37-496f-bafa-4b06d515j7l6","fbb684c8-0d37-496f-bafa-4b06d515j7l7"]
}
-
响应示例 返回状态码为200:删除成功,响应体参考CommonResponse。 HTTP/1.1 200 OK
Date: Sun,11 May 2025 10:00:00 GMT
Server: example-server
Content-Type: application/json;charset=UTF-8
Content-Length: 250
Connection: keep-alive
{
"errcode" : "0",
"errmsg" : ""
} 返回状态码为202:请求正在处理中,请求处理详情请通过“查询业务编排结果”接口,确认是否处理成功。响应体参考DeviceRadiusDeleteResponse。 HTTP/1.1 202 Accepted
Date: Sun,11 May 2025 10:00:00 GMT
Server: example-server
Content-Type: application/json;charset=UTF-8
Content-Length: 250
Connection: keep-alive
{
"errcode" : "0",
"errmsg" : "",
"processInstanceId" : ""
} 返回状态码为400:请求参数错误。 HTTP/1.1 400 Bad Request
Date: Sun,11 May 2025 10:00:00 GMT
Server: example-server
Content-Type: application/json;charset=UTF-8
Content-Length: 250
Connection: keep-alive
返回状态码为500:内部异常。 HTTP/1.1 500 Internal Server Error
Date: Sun,11 May 2025 10:00:00 GMT
Server: example-server
Content-Type: application/json;charset=UTF-8
Content-Length: 250
Connection: keep-alive
-
响应示例 返回状态码为200:创建成功,响应体参考DeviceRadiusCreateOrUpdateResponse。 HTTP/1.1 200 OK
Date: Sun,11 May 2025 10:00:00 GMT
Server: example-server
Content-Type: application/json;charset=UTF-8
Content-Length: 250
Connection: keep-alive
{
"errcode" : "0",
"errmsg" : "",
"data" : {
"id" : "00000000-0000-0000-0000-000000000000",
"templateInfo" : {
"siteId" : "00000000-0000-0000-0000-000000000000",
"deviceId" : "00000000-0000-0000-0000-000000000000",
"name" : "RadiusServer1",
"desc" : "RADIUS服务器",
"isContainDomainName" : true,
"sharedKey" : "Example@123",
"primaryAuthenServerInfo" : {
"serverIP" : "10.134.6.5",
"serverPort" : 10,
"tnpId" : "00000000-0000-0000-0000-000000000000",
"vpnId" : "fbb684c8-0d37-496f-bafa-4b06d515j7l6",
"ipAddress" : "10.134.6.5",
"loopbackInterface" : "601"
},
"secondAuthenServerInfo" : {
"serverIP" : "10.134.6.5",
"serverPort" : 10,
"tnpId" : "00000000-0000-0000-0000-000000000000",
"vpnId" : "fbb684c8-0d37-496f-bafa-4b06d515j7l6",
"ipAddress" : "10.134.6.5",
"loopbackInterface" : "601"
},
"primaryAccountServerInfo" : {
"serverIP" : "10.134.6.5",
"serverPort" : 10,
"tnpId" : "00000000-0000-0000-0000-000000000000",
"vpnId" : "fbb684c8-0d37-496f-bafa-4b06d515j7l6",
"ipAddress" : "10.134.6.5",
"loopbackInterface" : "601"
},
"secondAccountServerInfo" : {
"serverIP" : "10.134.6.5",
"serverPort" : 10,
"tnpId" : "00000000-0000-0000-0000-000000000000",
"vpnId" : "fbb684c8-0d37-496f-bafa-4b06d515j7l6",
"ipAddress" : "10.134.6.5",
"loopbackInterface" : "601"
}
}
}
} 返回状态码为400:请求参数错误。 HTTP/1.1 400 Bad Request
Date: Sun,11 May 2025 10:00:00 GMT
Server: example-server
Content-Type: application/json;charset=UTF-8
Content-Length: 250
Connection: keep-alive
返回状态码为500:内部异常。 HTTP/1.1 500 Internal Server Error
Date: Sun,11 May 2025 10:00:00 GMT
Server: example-server
Content-Type: application/json;charset=UTF-8
Content-Length: 250
Connection: keep-alive
-
请求示例 HTTP的示例 POST /controller/campus/rest/sdwan/v1/device/radius/template HTTP/1.1
Host: 192.168.1.125:18002
Content-Type: application/json
Accept: application/json
Accept-Language: en-US
X-ACCESS-TOKEN: x-yyyyyy
{
"siteId" : "00000000-0000-0000-0000-000000000000",
"deviceId" : "00000000-0000-0000-0000-000000000000",
"name" : "RadiusServer1",
"desc" : "RADIUS服务器",
"isContainDomainName" : true,
"sharedKey" : "Example@123",
"primaryAuthenServerInfo" : {
"serverIP" : "10.134.6.5",
"serverPort" : 10,
"tnpId" : "00000000-0000-0000-0000-000000000000",
"vpnId" : "fbb684c8-0d37-496f-bafa-4b06d515j7l6",
"ipAddress" : "10.134.6.5",
"loopbackInterface" : "601"
},
"secondAuthenServerInfo" : {
"serverIP" : "10.134.6.5",
"serverPort" : 10,
"tnpId" : "00000000-0000-0000-0000-000000000000",
"vpnId" : "fbb684c8-0d37-496f-bafa-4b06d515j7l6",
"ipAddress" : "10.134.6.5",
"loopbackInterface" : "601"
},
"primaryAccountServerInfo" : {
"serverIP" : "10.134.6.5",
"serverPort" : 10,
"tnpId" : "00000000-0000-0000-0000-000000000000",
"vpnId" : "fbb684c8-0d37-496f-bafa-4b06d515j7l6",
"ipAddress" : "10.134.6.5",
"loopbackInterface" : "601"
},
"secondAccountServerInfo" : {
"serverIP" : "10.134.6.5",
"serverPort" : 10,
"tnpId" : "00000000-0000-0000-0000-000000000000",
"vpnId" : "fbb684c8-0d37-496f-bafa-4b06d515j7l6",
"ipAddress" : "10.134.6.5",
"loopbackInterface" : "601"
}
}
-
响应参数 返回状态码为200:创建成功,响应体参考DeviceRadiusCreateOrUpdateResponse。 表4 DeviceRadiusCreateOrUpdateResponse对象的参数列表 参数名称 类型 参数值域 默认值 参数说明 参数示例 errcode string 0~10个字符。 - 错误码。 "0" errmsg string 0~255个字符。 - 错误描述。 "" data REFERENCE 详细请参见表5。 - - 表5 DeviceRadiusServerTemplateInfoWithId对象的参数列表 参数名称 类型 参数值域 默认值 参数说明 参数示例 id string 0~36个字符。 - 设备RADIUS服务器模板ID "00000000-0000-0000-0000-000000000000" templateInfo REFERENCE 详细请参见表6。 - - 表6 DeviceRadiusServerTemplateInfo对象的参数列表 参数名称 类型 参数值域 默认值 参数说明 参数示例 siteId string 0~36个字符。 - 站点ID "00000000-0000-0000-0000-000000000000" deviceId string 0~36个字符。 - 设备ID "00000000-0000-0000-0000-000000000000" name string 1~32个字符。 - 设备RADIUS服务器名称,不允许修改。 字符串形式,区分大小写,长度范围是1~32。字符包括大写字母、小写字母、数字、点号“.”、下划线“_”和中划线“-”。不能配置为“-”或“--”。 "RadiusServer1" desc string 0~128个字符。 - 设备RADIUS服务器描述。 "RADIUS服务器" isContainDomainName boolean true false false 是否包含
域名 ,默认false。 true sharedKey password 1~128个字符。 - 该字段可能包含敏感信息和个人数据,请妥善做好保护。 共享密钥。 "Example@123" primaryAuthenServerInfo REFERENCE 详细请参见表7。 - - secondAuthenServerInfo REFERENCE 详细请参见表7。 - - primaryAccountServerInfo REFERENCE 详细请参见表7。 - - secondAccountServerInfo REFERENCE 详细请参见表7。 - - 表7 DeviceServerInfo对象的参数列表 参数名称 类型 参数值域 默认值 参数说明 参数示例 serverIP string 0~64个字符。 - 服务器IP地址,支持IPv4,主备server地址不能相同。 "10.134.6.5" serverPort int32 [1-65535] - 服务器端口号, 范围1~65535。 10 tnpId string 0~36个字符。 - 指定站点设备下用于连接ServerIp的TNP ID。 tnpId和vpnId必须且只能选一个。 "00000000-0000-0000-0000-000000000000" vpnId string 0~36个字符。 - 指定站点设备下用于连接ServerIp的VPN ID。 tnpId和vpnId必须且只能选一个。 "fbb684c8-0d37-496f-bafa-4b06d515j7l6" ipAddress string 0~64个字符。 - Overlay场景,设备与服务器通讯的源端IPv4地址。 输入vpnid场景ipAddress和loopbackInterfaceId必须且只能选一个。 "10.134.6.5" loopbackInterface string 0~5个字符。 - Overlay场景,设备与服务器通讯的源端接口。 输入vpnid场景ipAddress和loopbackInterface必须且只能选一个,整数形式,0-1023之间。 "601" 返回状态码为400:请求参数错误。 详细信息请参见实际响应消息体。 返回状态码为500:内部异常。 详细信息请参见实际响应消息体。
-
请求参数 表1 body参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 RequestBody 是 REFERENCE 详细请参见表2。 设备RADIUS服务器信息。 - 表2 DeviceRadiusServerTemplateInfo对象的参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 siteId 是 string 0~36个字符。 - 站点ID "00000000-0000-0000-0000-000000000000" deviceId 是 string 0~36个字符。 - 设备ID "00000000-0000-0000-0000-000000000000" name 是 string 1~32个字符。 - 设备RADIUS服务器名称,不允许修改。 字符串形式,区分大小写,长度范围是1~32。字符包括大写字母、小写字母、数字、点号“.”、下划线“_”和中划线“-”。不能配置为“-”或“--”。 "RadiusServer1" desc 否 string 0~128个字符。 - 设备RADIUS服务器描述。 "RADIUS服务器" isContainDomainName 否 boolean true false false 是否包含域名,默认false。 true sharedKey 是 password 1~128个字符。 - 该字段可能包含敏感信息和个人数据,请妥善做好保护。 共享密钥。 "Example@123" primaryAuthenServerInfo 是 REFERENCE 详细请参见表3。 - - secondAuthenServerInfo 否 REFERENCE 详细请参见表3。 - - primaryAccountServerInfo 否 REFERENCE 详细请参见表3。 - - secondAccountServerInfo 否 REFERENCE 详细请参见表3。 - - 表3 DeviceServerInfo对象的参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 serverIP 是 string 0~64个字符。 - 服务器IP地址,支持IPv4,主备server地址不能相同。 "10.134.6.5" serverPort 是 int32 [1-65535] - 服务器端口号, 范围1~65535。 10 tnpId 否 string 0~36个字符。 - 指定站点设备下用于连接ServerIp的TNP ID。 tnpId和vpnId必须且只能选一个。 "00000000-0000-0000-0000-000000000000" vpnId 否 string 0~36个字符。 - 指定站点设备下用于连接ServerIp的VPN ID。 tnpId和vpnId必须且只能选一个。 "fbb684c8-0d37-496f-bafa-4b06d515j7l6" ipAddress 否 string 0~64个字符。 - Overlay场景,设备与服务器通讯的源端IPv4地址。 输入vpnid场景ipAddress和loopbackInterfaceId必须且只能选一个。 "10.134.6.5" loopbackInterface 否 string 0~5个字符。 - Overlay场景,设备与服务器通讯的源端接口。 输入vpnid场景ipAddress和loopbackInterface必须且只能选一个,整数形式,0-1023之间。 "601"
-
请求示例 HTTP的示例 PUT /controller/campus/rest/sdwan/v1/device/radius/template HTTP/1.1
Host: 192.168.1.125:18002
Content-Type: application/json
Accept: application/json
Accept-Language: en-US
X-ACCESS-TOKEN: x-yyyyyy
{
"id" : "00000000-0000-0000-0000-000000000000",
"templateInfo" : {
"siteId" : "00000000-0000-0000-0000-000000000000",
"deviceId" : "00000000-0000-0000-0000-000000000000",
"name" : "RadiusServer1",
"desc" : "RADIUS服务器",
"isContainDomainName" : true,
"sharedKey" : "Example@123",
"primaryAuthenServerInfo" : {
"serverIP" : "10.134.6.5",
"serverPort" : 10,
"tnpId" : "00000000-0000-0000-0000-000000000000",
"vpnId" : "fbb684c8-0d37-496f-bafa-4b06d515j7l6",
"ipAddress" : "10.134.6.5",
"loopbackInterface" : "601"
},
"secondAuthenServerInfo" : {
"serverIP" : "10.134.6.5",
"serverPort" : 10,
"tnpId" : "00000000-0000-0000-0000-000000000000",
"vpnId" : "fbb684c8-0d37-496f-bafa-4b06d515j7l6",
"ipAddress" : "10.134.6.5",
"loopbackInterface" : "601"
},
"primaryAccountServerInfo" : {
"serverIP" : "10.134.6.5",
"serverPort" : 10,
"tnpId" : "00000000-0000-0000-0000-000000000000",
"vpnId" : "fbb684c8-0d37-496f-bafa-4b06d515j7l6",
"ipAddress" : "10.134.6.5",
"loopbackInterface" : "601"
},
"secondAccountServerInfo" : {
"serverIP" : "10.134.6.5",
"serverPort" : 10,
"tnpId" : "00000000-0000-0000-0000-000000000000",
"vpnId" : "fbb684c8-0d37-496f-bafa-4b06d515j7l6",
"ipAddress" : "10.134.6.5",
"loopbackInterface" : "601"
}
}
}
-
响应示例 返回状态码为200:修改成功,响应体参考DeviceRadiusCreateOrUpdateResponse。 HTTP/1.1 200 OK
Date: Sun,11 May 2025 10:00:00 GMT
Server: example-server
Content-Type: application/json;charset=UTF-8
Content-Length: 250
Connection: keep-alive
{
"errcode" : "0",
"errmsg" : "",
"data" : {
"id" : "00000000-0000-0000-0000-000000000000",
"templateInfo" : {
"siteId" : "00000000-0000-0000-0000-000000000000",
"deviceId" : "00000000-0000-0000-0000-000000000000",
"name" : "RadiusServer1",
"desc" : "RADIUS服务器",
"isContainDomainName" : true,
"sharedKey" : "Example@123",
"primaryAuthenServerInfo" : {
"serverIP" : "10.134.6.5",
"serverPort" : 10,
"tnpId" : "00000000-0000-0000-0000-000000000000",
"vpnId" : "fbb684c8-0d37-496f-bafa-4b06d515j7l6",
"ipAddress" : "10.134.6.5",
"loopbackInterface" : "601"
},
"secondAuthenServerInfo" : {
"serverIP" : "10.134.6.5",
"serverPort" : 10,
"tnpId" : "00000000-0000-0000-0000-000000000000",
"vpnId" : "fbb684c8-0d37-496f-bafa-4b06d515j7l6",
"ipAddress" : "10.134.6.5",
"loopbackInterface" : "601"
},
"primaryAccountServerInfo" : {
"serverIP" : "10.134.6.5",
"serverPort" : 10,
"tnpId" : "00000000-0000-0000-0000-000000000000",
"vpnId" : "fbb684c8-0d37-496f-bafa-4b06d515j7l6",
"ipAddress" : "10.134.6.5",
"loopbackInterface" : "601"
},
"secondAccountServerInfo" : {
"serverIP" : "10.134.6.5",
"serverPort" : 10,
"tnpId" : "00000000-0000-0000-0000-000000000000",
"vpnId" : "fbb684c8-0d37-496f-bafa-4b06d515j7l6",
"ipAddress" : "10.134.6.5",
"loopbackInterface" : "601"
}
}
}
} 返回状态码为400:请求参数错误。 HTTP/1.1 400 Bad Request
Date: Sun,11 May 2025 10:00:00 GMT
Server: example-server
Content-Type: application/json;charset=UTF-8
Content-Length: 250
Connection: keep-alive
返回状态码为500:内部异常。 HTTP/1.1 500 Internal Server Error
Date: Sun,11 May 2025 10:00:00 GMT
Server: example-server
Content-Type: application/json;charset=UTF-8
Content-Length: 250
Connection: keep-alive
-
请求参数 表1 body参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 RequestBody 是 REFERENCE 详细请参见表2。 设备RADIUS服务器模板信息。 - 表2 DeviceRadiusServerTemplateInfoWithId对象的参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 id 是 string 0~36个字符。 - 设备RADIUS服务器模板ID "00000000-0000-0000-0000-000000000000" templateInfo 是 REFERENCE 详细请参见表2。 - -
-
响应参数 返回状态码为200:查询成功,响应体参考QueryDeviceRadiusServerTemplateRsp。 表2 QueryDeviceRadiusServerTemplateRsp对象的参数列表 参数名称 类型 参数值域 默认值 参数说明 参数示例 errcode string 0~10个字符。 - 错误码。 "0" errmsg string 0~255个字符。 - 错误描述。 "" pageIndex int32 [1-10000] - 当前页,从1开始。 1 pageSize int32 [1-10000] - 页大小。 10 totalRecords int32 [1-100000] - 总记录数。 100 data ARRAY_REFERENCE 0-10000个列表项,详细请参见表3。 设备RADIUS服务器模板信息 - 表3 DetailedDeviceRadiusServerTemplateInfo对象的参数列表 参数名称 类型 参数值域 默认值 参数说明 参数示例 id string 0~36个字符。 - 设备RADIUS服务器模板ID "00000000-0000-0000-0000-000000000000" templateInfo REFERENCE 详细请参见表6。 - - createTime string 0~13个字符。 - 创建时间 "1604909066000" 返回状态码为400:请求参数错误。 详细信息请参见实际响应消息体。 返回状态码为500:内部异常。 详细信息请参见实际响应消息体。
-
响应示例 返回状态码为200:查询成功,响应体参考QueryDeviceRadiusServerTemplateRsp。 HTTP/1.1 200 OK
Date: Sun,11 May 2025 10:00:00 GMT
Server: example-server
Content-Type: application/json;charset=UTF-8
Content-Length: 250
Connection: keep-alive
{
"errcode" : "0",
"errmsg" : "",
"pageIndex" : 1,
"pageSize" : 10,
"totalRecords" : 100,
"data" : [
{
"id" : "00000000-0000-0000-0000-000000000000",
"templateInfo" : {
"siteId" : "00000000-0000-0000-0000-000000000000",
"deviceId" : "00000000-0000-0000-0000-000000000000",
"name" : "RadiusServer1",
"desc" : "RADIUS服务器",
"isContainDomainName" : true,
"sharedKey" : "Example@123",
"primaryAuthenServerInfo" : {
"serverIP" : "10.134.6.5",
"serverPort" : 10,
"tnpId" : "00000000-0000-0000-0000-000000000000",
"vpnId" : "fbb684c8-0d37-496f-bafa-4b06d515j7l6",
"ipAddress" : "10.134.6.5",
"loopbackInterface" : "601"
},
"secondAuthenServerInfo" : {
"serverIP" : "10.134.6.5",
"serverPort" : 10,
"tnpId" : "00000000-0000-0000-0000-000000000000",
"vpnId" : "fbb684c8-0d37-496f-bafa-4b06d515j7l6",
"ipAddress" : "10.134.6.5",
"loopbackInterface" : "601"
},
"primaryAccountServerInfo" : {
"serverIP" : "10.134.6.5",
"serverPort" : 10,
"tnpId" : "00000000-0000-0000-0000-000000000000",
"vpnId" : "fbb684c8-0d37-496f-bafa-4b06d515j7l6",
"ipAddress" : "10.134.6.5",
"loopbackInterface" : "601"
},
"secondAccountServerInfo" : {
"serverIP" : "10.134.6.5",
"serverPort" : 10,
"tnpId" : "00000000-0000-0000-0000-000000000000",
"vpnId" : "fbb684c8-0d37-496f-bafa-4b06d515j7l6",
"ipAddress" : "10.134.6.5",
"loopbackInterface" : "601"
}
},
"createTime" : "1604909066000"
}
]
} 返回状态码为400:请求参数错误。 HTTP/1.1 400 Bad Request
Date: Sun,11 May 2025 10:00:00 GMT
Server: example-server
Content-Type: application/json;charset=UTF-8
Content-Length: 250
Connection: keep-alive
返回状态码为500:内部异常。 HTTP/1.1 500 Internal Server Error
Date: Sun,11 May 2025 10:00:00 GMT
Server: example-server
Content-Type: application/json;charset=UTF-8
Content-Length: 250
Connection: keep-alive
-
请求示例 HTTP的示例 GET /controller/campus/rest/sdwan/v1/device/radius/template?pageIndex=1&pageSize=10&siteId=00000000-0000-0000-0000-000000000000&deviceId=00000000-0000-0000-0000-000000000000&name=radiusServer1 HTTP/1.1
Host: 192.168.1.125:18002
Content-Type: application/json
Accept: application/json
Accept-Language: en-US
X-ACCESS-TOKEN: x-yyyyyy
-
URI /controller/campus/rest/sdwan/v1/device/radius/template 表1 query参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 pageIndex 是 int32 [0-10000] - 起始页。 pageIndex或pageSize为0时表示查询该租户下符合其他查询条件的所有RADIUS服务器模板。 1 pageSize 是 int32 [0-100] - 页行记录数。 pageIndex或pageSize为0时表示查询该租户下符合其他查询条件的所有RADIUS服务器模板。 10 siteId 否 string 0~36个字符。 - 站点ID "00000000-0000-0000-0000-000000000000" deviceId 否 string 0~36个字符。 - 设备ID "00000000-0000-0000-0000-000000000000" name 否 string 0~32个字符。 - 设备RADIUS服务器模板名称,模糊查询。 "radiusServer1"