-
请求示例 HTTP的示例 PUT /controller/campus/v1/sdwan/aaa/domain/00000000-0000-0000-0000-000000000000 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
{
"domainId" : "00000000-0000-0000-0000-000000000000",
"siteId" : "00000000-0000-0000-0000-000000000000",
"deviceId" : "00000000-0000-0000-0000-000000000000",
"domainName" : "name",
"domainSates" : {
"state" : true
},
"authenticationSchemaId" : "00000000-0000-0000-0000-000000000000",
"enableAuthorizationSchema" : true,
"authorizationSchemaId" : "00000000-0000-0000-0000-000000000000",
"enableTacasServerTemplate" : true,
"tacasServerTemplateId" : "00000000-0000-0000-0000-000000000000",
"radiusServerTemplateName" : "radius1"
}
-
响应参数 返回状态码为200：修改成功，响应体参考DomainResponse。 DomainResponse对象的参数列表，详细请参见表4。 返回状态码为400：请求参数错误，响应体参考CommonDomainResponse。 表4 CommonDomainResponse对象的参数列表 参数名称 类型 参数值域 默认值 参数说明 参数示例 errcode string - - 错误码。 "0" errmsg string 0~255个字符。 - 错误描述。 "" 返回状态码为500：内部异常。 详细信息请参见实际响应消息体。
-
响应示例 返回状态码为200：修改成功，响应体参考DomainResponse。 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" : {
"domainId" : "00000000-0000-0000-0000-000000000000",
"siteId" : "00000000-0000-0000-0000-000000000000",
"deviceId" : "00000000-0000-0000-0000-000000000000",
"domainName" : "name",
"domainSates" : {
"state" : true
},
"authenticationSchemaId" : "00000000-0000-0000-0000-000000000000",
"enableAuthorizationSchema" : true,
"authorizationSchemaId" : "00000000-0000-0000-0000-000000000000",
"enableTacasServerTemplate" : true,
"tacasServerTemplateId" : "00000000-0000-0000-0000-000000000000",
"radiusServerTemplateName" : "radius1"
}
} 返回状态码为400：请求参数错误，响应体参考CommonDomainResponse。 HTTP/1.1 400 Bad Request
Server: example-server
Content-Type: application/json;charset=UTF-8
Content-Length: 250
Connection: keep-alive
{
"errcode" : "0x587679",
"errmsg" : ""
} 返回状态码为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
-
请求参数 表2 body参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 body 是 REFERENCE 详细请参见表3。 域信息。 - 表3 DomainInfo对象的参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 domainId 是 uuid - - 域ID，UUID格式，主键字段 "00000000-0000-0000-0000-000000000000" siteId 是 uuid - - 站点ID，UUID格式 "00000000-0000-0000-0000-000000000000" deviceId 是 uuid - - 设备ID，UUID格式 "00000000-0000-0000-0000-000000000000" domainName 是 string 1~128个字符。 -
域名 称。 创建后不允许修改。 "name" domainSates 否 REFERENCE 详细请参见表3。 - - authenticationSchemaId 是 uuid - - 认证方案ID，UUID格式 "00000000-0000-0000-0000-000000000000" enableAuthorizationSchema 否 boolean true false - 是否使能授权方案。 当为 false 时表示去使能授权方案，为 true 时表示使能授权方案，不填写时表示维持创建时的配置。 true authorizationSchemaId 否 uuid - - 授权方案ID，UUID格式 "00000000-0000-0000-0000-000000000000" enableTacasServerTemplate 否 boolean true false - 是否使能HWTACA
CS 服务器模板。 当为 false 时表示去使能HWTACACS服务器模板，为 true 时表示使能HWTACACS服务器模板，不填写时表示维持创建时的配置。 true tacasServerTemplateId 否 uuid - - HWTACACS服务器模板ID，UUID格式 "00000000-0000-0000-0000-000000000000" radiusServerTemplateName 否 string 0~32个字符。 - 设备RADIUS服务器模板名称。 "radius1"
-
响应示例 返回状态码为201：创建成功，响应体参考DomainResponse。 HTTP/1.1 201 Created
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" : {
"domainId" : "00000000-0000-0000-0000-000000000000",
"siteId" : "00000000-0000-0000-0000-000000000000",
"deviceId" : "00000000-0000-0000-0000-000000000000",
"domainName" : "name",
"domainSates" : {
"state" : true
},
"authenticationSchemaId" : "00000000-0000-0000-0000-000000000000",
"enableAuthorizationSchema" : true,
"authorizationSchemaId" : "00000000-0000-0000-0000-000000000000",
"enableTacasServerTemplate" : true,
"tacasServerTemplateId" : "00000000-0000-0000-0000-000000000000",
"radiusServerTemplateName" : "radius1"
}
} 返回状态码为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
-
响应参数 返回状态码为201：创建成功，响应体参考DomainResponse。 表4 DomainResponse对象的参数列表 参数名称 类型 参数值域 默认值 参数说明 参数示例 errcode string - - 错误码。 "0" errmsg string 0~255个字符。 - 错误描述。 "" data REFERENCE 详细请参见表5。 - - 表5 DomainInfo对象的参数列表 参数名称 类型 参数值域 默认值 参数说明 参数示例 domainId uuid - - 域ID，UUID格式，主键字段 "00000000-0000-0000-0000-000000000000" siteId uuid - - 站点ID，UUID格式 "00000000-0000-0000-0000-000000000000" deviceId uuid - - 设备ID，UUID格式 "00000000-0000-0000-0000-000000000000" domainName string 1~128个字符。 - 域名称。 创建后不允许修改。 "name" domainSates REFERENCE 详细请参见表6。 - - authenticationSchemaId uuid - - 认证方案ID，UUID格式 "00000000-0000-0000-0000-000000000000" enableAuthorizationSchema boolean true false - 是否使能授权方案。 当为 false 时表示去使能授权方案，为 true 时表示使能授权方案，不填写时表示维持创建时的配置。 true authorizationSchemaId uuid - - 授权方案ID，UUID格式 "00000000-0000-0000-0000-000000000000" enableTacasServerTemplate boolean true false - 是否使能HWTACACS服务器模板。 当为 false 时表示去使能HWTACACS服务器模板，为 true 时表示使能HWTACACS服务器模板，不填写时表示维持创建时的配置。 true tacasServerTemplateId uuid - - HWTACACS服务器模板ID，UUID格式 "00000000-0000-0000-0000-000000000000" radiusServerTemplateName string 0~32个字符。 - 设备RADIUS服务器模板名称。 "radius1" 表6 DomainStateInfo对象的参数列表 参数名称 类型 参数值域 默认值 参数说明 参数示例 state boolean true false true 使能域，默认为true。 true 返回状态码为400：请求参数错误。 详细信息请参见实际响应消息体。 返回状态码为500：内部异常。 详细信息请参见实际响应消息体。
-
请求示例 HTTP的示例 POST /controller/campus/v1/sdwan/aaa/domain 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",
"domainName" : "name",
"domainSates" : {
"state" : true
},
"authenticationSchemaId" : "00000000-0000-0000-0000-000000000000",
"authorizationSchemaId" : "00000000-0000-0000-0000-000000000000",
"tacasServerTemplateId" : "00000000-0000-0000-0000-000000000000",
"radiusServerTemplateName" : "radius1"
}
-
请求参数 表1 body参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 domain 是 REFERENCE 详细请参见表2。 域信息。 - 表2 Domain对象的参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 siteId 是 uuid - - 站点ID，UUID格式 "00000000-0000-0000-0000-000000000000" deviceId 是 uuid - - 设备ID，UUID格式 "00000000-0000-0000-0000-000000000000" domainName 是 string 1~128个字符。 - 域名称。 创建后不允许修改。 长度范围是1～64，不支持空格、中文字符，且不能包含字符“*” “？” “"”。 其中V600版本设备的域名称不能包含大写字母。 "name" domainSates 否 REFERENCE 详细请参见表3。 - - authenticationSchemaId 是 uuid - - 认证方案ID，UUID格式。 "00000000-0000-0000-0000-000000000000" authorizationSchemaId 否 uuid - - 授权方案ID，UUID格式。 "00000000-0000-0000-0000-000000000000" tacasServerTemplateId 否 uuid - - HWTACACS服务器模板ID，UUID格式。 "00000000-0000-0000-0000-000000000000" radiusServerTemplateName 否 string 0~32个字符。 - 设备RADIUS服务器模板名称。 "radius1" 表3 DomainStateInfo对象的参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 state 是 boolean true false true 使能域，默认为true。 true
-
响应参数 返回状态码为200：删除成功，响应体参考CommonDomainResponse。 CommonDomainResponse对象的参数列表，详细请参见表4。 返回状态码为400：请求参数错误，响应体参考DeleteDomainResult。 表2 DeleteDomainResult对象的参数列表 参数名称 类型 参数值域 默认值 参数说明 参数示例 errorCode string - 0 删除失败错误码，如果成功，错误码默认为0。 "0x587679" errorMsg string 0~255个字符。 - 删除失败的错误异常信息。 "" 返回状态码为500：内部异常。 详细信息请参见实际响应消息体。
-
响应示例 返回状态码为200：删除成功，响应体参考CommonDomainResponse。 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" : ""
} 返回状态码为400：请求参数错误，响应体参考DeleteDomainResult。 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
{
"errorCode" : "0x587679",
"errorMsg" : ""
} 返回状态码为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的示例 DELETE /controller/campus/v1/sdwan/aaa/domain/00000000-0000-0000-0000-000000000000 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
-
响应参数 返回状态码为200：查询成功，响应体参考QueryDomainResponse。 表2 QueryDomainResponse对象的参数列表 参数名称 类型 参数值域 默认值 参数说明 参数示例 errcode string - - 错误码。 "0" errmsg string 0~255个字符。 - 错误描述。 "" data ARRAY_REFERENCE 0-1000个列表项，详细请参见表5。 域信息列表 - pageIndex int32 - - 当前页。 1 pageSize int32 [1-10000] - 页大小。 10 totalRecords int32 [1-100000] - 总记录数。 100 返回状态码为400：请求参数错误。 详细信息请参见实际响应消息体。 返回状态码为500：内部异常。 详细信息请参见实际响应消息体。
-
请求示例 HTTP的示例 GET /controller/campus/v1/sdwan/aaa/domain?pageIndex=1&pageSize=10&siteId=00000000-0000-0000-0000-000000000000&deviceId=00000000-0000-0000-0000-000000000000&domainName=name 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
-
响应示例 返回状态码为200：查询成功，响应体参考QueryDomainResponse。 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" : [
{
"domainId" : "00000000-0000-0000-0000-000000000000",
"siteId" : "00000000-0000-0000-0000-000000000000",
"deviceId" : "00000000-0000-0000-0000-000000000000",
"domainName" : "name",
"domainSates" : {
"state" : true
},
"authenticationSchemaId" : "00000000-0000-0000-0000-000000000000",
"enableAuthorizationSchema" : true,
"authorizationSchemaId" : "00000000-0000-0000-0000-000000000000",
"enableTacasServerTemplate" : true,
"tacasServerTemplateId" : "00000000-0000-0000-0000-000000000000",
"radiusServerTemplateName" : "radius1"
}
],
"pageIndex" : 1,
"pageSize" : 10,
"totalRecords" : 100
} 返回状态码为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
-
URI /controller/campus/v1/sdwan/aaa/domain 表1 query参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 pageIndex 否 int32 - - 起始页，默认值1 1 pageSize 否 int32 [1-1000] - 页行记录数，默认值10 10 siteId 否 uuid - - 站点ID。 "00000000-0000-0000-0000-000000000000" deviceId 否 uuid - - 设备ID。 "00000000-0000-0000-0000-000000000000" domainName 否 string - - 域名模糊查询。 "name"
