华为云用户手册

响应示例 返回状态码为200：接口调用成功，响应体参考QueryBridgeDomainManufactureVlanConfigResponse。 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" : "", "totalRecords" : 200, "pageSize" : 20, "pageIndex" : 1, "data" : [ { "siteId" : "00000000-0000-0000-0000-000000000000", "clear" : false } ] } 返回状态码为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：接口调用成功，响应体参考QueryBridgeDomainManufactureVlanConfigResponse。 表2 QueryBridgeDomainManufactureVlanConfigResponse对象的参数列表 参数名称 类型 参数值域 默认值 参数说明 参数示例 errcode string - - 错误码。 "0" errmsg string - - 错误信息。 "" totalRecords int32 - - 总的数据条数。 200 pageSize int32 - - 分页数。 20 pageIndex int32 - - 当前页数。 1 data ARRAY_REFERENCE 0-1000个列表项，详细请参见表3。 默认管理口配置信息。 - 表3 BridgeDomainManufactureVlanConfig对象的参数列表 参数名称 类型 参数值域 默认值 参数说明 参数示例 siteId uuid - - 站点ID，格式是uuid。 "00000000-0000-0000-0000-000000000000" clear boolean true false false 清除标识，true标识默认管理口配置清除，反之则标识未清除。必填。 false 返回状态码为400：校验异常。 详细信息请参见实际响应消息体。 返回状态码为500：内部错误。 详细信息请参见实际响应消息体。

请求示例 HTTP的示例 GET /controller/campus/v1/sdwan/overlay-network/bridge-domains/action/clear-manufacture-vlan?pageIndex=0&pageSize=20&siteId=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

响应示例 返回状态码为200：查询成功，响应体参考QueryPolicyRelSitesResponse。 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" : "", "totalRecords" : 1, "pageSize" : 10, "pageIndex" : 1, "data" : [ { "siteId" : "d51ef5ed-cdf9-4120-becc-04790eb79a1e", "siteName" : "site1", "deviceName" : "device1", "linkId" : "d51ef5ed-cdf9-4120-becc-04790eb79a12", "linkName" : "link1", "interfaceName" : "GE0/0/1" } ] } 返回状态码为204：执行成功。 HTTP/1.1 204 No Content 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 返回状态码为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/v1/sdwan/policy/traffic/saas/relsite?pageIndex=1&pageSize=20&policyId=00000000-0000-0000-0000-000000000000&siteName=site1 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：查询成功，响应体参考QueryPolicyRelSitesResponse。 表2 QueryPolicyRelSitesResponse对象的参数列表 参数名称 类型 参数值域 默认值 参数说明 参数示例 errcode string - - 错误码。 "0" errmsg string - - 错误信息。 "" totalRecords int32 - - 总的数据条数。 1 pageSize int32 - - 每页显示数量。 10 pageIndex int32 - - 当前页数。 1 data ARRAY_REFERENCE 详细请参见表3。 SaaS选路策略关联站点信息。 - 表3 PolicyRelSiteInfo对象的参数列表 参数名称 类型 参数值域 默认值 参数说明 参数示例 siteId string - - 站点ID。 "d51ef5ed-cdf9-4120-becc-04790eb79a1e" siteName string - - 站点名称。 "site1" deviceName string - - 设备名称。 "device1" linkId string - - 链路ID。 "d51ef5ed-cdf9-4120-becc-04790eb79a12" linkName string - - 链路名称。 "link1" interfaceName string - - 接口名称。 "GE0/0/1" 返回状态码为204：执行成功。 返回状态码为400：请求参数错误。 详细信息请参见实际响应消息体。 返回状态码为500：内部错误。 详细信息请参见实际响应消息体。

URI /controller/campus/v1/sdwan/policy/traffic/saas/relsite 表1 query参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 pageIndex 是 int32 [1-1000] 1 当前页数，默认是1。 1 pageSize 是 int32 [1-100] 20 每页显示数量，默认是20。 20 policyId 是 string 1~64个字符。 - 策略ID。 "00000000-0000-0000-0000-000000000000" siteName 否 string 0~64个字符。 - 站点名称，支持模糊匹配。 "site1"

响应示例 返回状态码为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" : "" } 返回状态码为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的示例 DELETE /controller/campus/rest/sdwan/v1/device/dot1x/config 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" : "fbb684c8-ddaa-3451-bafa-4b06d5158956", "deviceId" : "fbb684c8-ddaa-3451-bafa-4b06d5158956", "interfaceId" : "fbb684c8-ddaa-3451-bafa-4b06d5158956" }

响应参数 返回状态码为200：去使能成功，响应体参考CommonResponse。 表3 CommonResponse对象的参数列表 参数名称 类型 参数值域 默认值 参数说明 参数示例 errcode string 0~10个字符。 - 错误码。 "0" errmsg string 0~255个字符。 - 错误描述。 "" 返回状态码为400：请求参数错误。 详细信息请参见实际响应消息体。 返回状态码为500：内部异常。 详细信息请参见实际响应消息体。

请求参数 表1 body参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 RequestBody 是 REFERENCE 详细请参见表2。 802.1X和MAC接入认证配置信息。 - 表2 DisableDeviceDot1xInterface对象的参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 siteId 是 string 0~36个字符。 - 站点ID。 "fbb684c8-ddaa-3451-bafa-4b06d5158956" deviceId 是 string 0~36个字符。 - 设备ID。 "fbb684c8-ddaa-3451-bafa-4b06d5158956" interfaceId 是 string 0~36个字符。 - 设备接口ID。 "fbb684c8-ddaa-3451-bafa-4b06d5158956"

响应示例 返回状态码为200：查询成功，响应体参考QueryDeviceRecordingResponse。 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" : [ { "siteId" : "00000000-0000-0000-0000-000000000000", "deviceId" : "00000000-0000-0000-0000-000000000000", "recordingSchema" : "name", "tacacsTemplateId" : "00000000-0000-0000-0000-000000000000", "cmdRecordEnable" : false, "deviceRecordingId" : "00000000-0000-0000-0000-000000000000" } ], "pageIndex" : 1, "pageSize" : 10, "totalRecords" : 1 } 返回状态码为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：查询成功，响应体参考QueryDeviceRecordingResponse。 表2 QueryDeviceRecordingResponse对象的参数列表 参数名称 类型 参数值域 默认值 参数说明 参数示例 errcode string 0~10个字符。 - 错误码。 "0" errmsg string 0~255个字符。 - 错误描述。 "" data ARRAY_REFERENCE 0-10个列表项，详细请参见表4。 - - pageIndex int32 [1-10000] - 当前页，从1开始。 1 pageSize int32 [1-10000] - 页大小。 10 totalRecords int32 [1-100000] - 总记录数。 1 返回状态码为400：请求参数错误。 详细信息请参见实际响应消息体。 返回状态码为500：内部异常。 详细信息请参见实际响应消息体。

URI /controller/campus/v1/sdwan/aaa/recording 表1 query参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 pageIndex 否 int32 [1-1000] - 起始页。 1 pageSize 否 int32 [0-100] - 页行记录数。 10 siteId 否 uuid - - 站点ID。 "00000000-0000-0000-0000-000000000000" deviceId 否 uuid - - 设备ID。 "00000000-0000-0000-0000-000000000000" recordingSchema 否 string - - 记录方案名称。 "name"

请求示例 HTTP的示例 GET /controller/campus/v1/sdwan/aaa/recording?pageIndex=1&pageSize=10&siteId=00000000-0000-0000-0000-000000000000&deviceId=00000000-0000-0000-0000-000000000000&recordingSchema=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：操作成功，返回用户组ID，响应体参考AddUsergroupOutputDto。 表3 AddUsergroupOutputDto对象的参数列表 参数名称 类型 参数值域 默认值 参数说明 参数示例 errcode string - - 错误码。 "0" errmsg string - - 错误信息描述。 "" data REFERENCE 详细请参见表4。 返回数据内容。 - 表4 AddUsergroupOutData对象的参数列表 参数名称 类型 参数值域 默认值 参数说明 参数示例 id string - - 用户组ID。UUID格式 "a91e1696-02a2-4a68-bad4-aa639359c8cf" 返回状态码为400：校验异常。 详细信息请参见实际响应消息体。 返回状态码为500：内部错误。 详细信息请参见实际响应消息体。

响应示例 返回状态码为200：操作成功，返回用户组ID，响应体参考AddUsergroupOutputDto。 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" : "a91e1696-02a2-4a68-bad4-aa639359c8cf" } } 返回状态码为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/v1/accountservice/usergroups 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 { "parentId" : "a91e1696-02a2-4a68-bad4-aa639359c8cf", "name" : "friend", "address" : "Xihu North Community", "postalCode" : "125744", "adminEmail" : "xxx@example.com", "description" : "common user group" }

请求参数 表1 body参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 body 是 REFERENCE 详细请参见表2。 用户组结构。 - 表2 AddUsergroupInputDto对象的参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 parentId 是 string - - 父用户组ID。UUID格式 "a91e1696-02a2-4a68-bad4-aa639359c8cf" name 是 string 1~128个字符。 - 用户组名称，不能包含=+%,#"特殊字符。 "friend" address 否 string 0~256个字符。 - 地址。 "Xihu North Community" postalCode 否 string 0~50个字符。 - 邮编。 "125744" adminEmail 否 string 0~100个字符。 - 用户组管理员邮箱。 "xxx@example.com" description 否 string 0~256个字符。 - 用户组描述信息。 "common user group"

接口约束 1、该接口仅支持租户视图或msp代维视图下，角色为“Open Api Operator”的用户访问，必须在用户会话建立后使用。 2、当policyType为vpn bandwidth时，接口返回202，表示请求正在处理中，请求处理详情请通过“查询业务编排结果”接口，确认是否处理成功；接口返回其他状态码，表示请求已处理完成。当policyType为其他类型时，接口在提交之后立即返回，实际业务还在执行中，可通过对应策略的查询接口查询执行状态。

响应参数 返回状态码为200：配置成功，响应体参考ApplyPolicyResponse。 ApplyPolicyResponse对象的参数列表，详细请参见表6。 返回状态码为202：请求正在处理中，请求处理详情请通过“查询业务编排结果”接口，确认是否处理成功。响应体参考ApplyPolicyResponse。 返回状态码为400：请求参数错误，无响应体。 详细信息请参见实际响应消息体。 返回状态码为500：内部错误，无响应体。 详细信息请参见实际响应消息体。

请求示例 HTTP的示例 PUT /controller/campus/v1/sdwan/policy/unbind-policy 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 { "policyId" : "00000000-0000-0000-0000-000000000000", "policyType" : "qos", "effectImmediate" : true, "sites" : [ { "siteId" : "00000000-0000-0000-0000-000000000000", "siteName" : "Site1", "tnpIds" : [ "00000000-0000-0000-0000-000000000000" ], "externalPortIds" : [ "00000000-0000-0000-0000-000000000000" ], "lanPortIds" : [ "00000000-0000-0000-0000-000000000000" ], "devicePortTypes" : [ { "deviceId" : "00000000-0000-0000-0000-000000000000", "portType" : "EvpnTunnel" } ], "destSites" : [ "00000000-0000-0000-0000-000000000000" ] } ], "status" : "committing" }

响应示例 返回状态码为200：配置成功，响应体参考ApplyPolicyResponse。 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" : "", "errparam" : "["policyName"]", "processInstanceId" : "" } 返回状态码为202：请求正在处理中，请求处理详情请通过“查询业务编排结果”接口，确认是否处理成功。响应体参考ApplyPolicyResponse。 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 返回状态码为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的示例 DELETE /controller/campus/v1/sdwan/aaa/devicemanager/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：删除成功，响应体参考CommonDeviceManagerResponse。 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：请求参数错误。 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：正常响应,返回体参考QueryInterlinkRouteResponse。 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" : 20, "totalRecords" : 1, "success" : { "vpnId" : "00000000-0000-0000-0000-000000000000", "interlinkRoutes" : [ { "id" : "00000000-0000-0000-0000-000000000000", "siteId" : "00000000-0000-0000-0000-000000000000", "helloTimer" : 5, "timerDead" : 15, "enableImportDefaultRoute" : false } ] } } 返回状态码为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：正常响应,返回体参考QueryInterlinkRouteResponse。 表2 QueryInterlinkRouteResponse对象的参数列表 参数名称 类型 参数值域 默认值 参数说明 参数示例 errcode string - - 错误码。 "0" errmsg string - - 错误信息。 "" pageIndex int32 - - 页码。 1 pageSize int32 - - 页大小。 20 totalRecords int32 - - 总数。 1 success REFERENCE 详细请参见表3。 - - 表3 InterlinkRouteInfos对象的参数列表 参数名称 类型 参数值域 默认值 参数说明 参数示例 vpnId uuid 0~36个字符。 - VPN ID，uuid格式。 "00000000-0000-0000-0000-000000000000" interlinkRoutes ARRAY_REFERENCE 1-100个列表项，详细请参见表4。 双网关互联链路路由信息。 - 表4 InterlinkRouteInfo对象的参数列表 参数名称 类型 参数值域 默认值 参数说明 参数示例 id uuid 0~36个字符。 - ID，uuid格式。 "00000000-0000-0000-0000-000000000000" siteId uuid 0~36个字符。 - 站点ID，uuid格式。 "00000000-0000-0000-0000-000000000000" helloTimer int32 [1-65535] 5 Hello报文时间间隔。建议Hello报文时间间隔取值不小于5，否则可能会造成邻接关系的中断。缺省情况下，P2P、Broadcast类型接口发送Hello报文的时间间隔的值为10秒；P2MP、NBMA类型接口发送Hello报文的时间间隔的值为30秒 5 timerDead int32 [1-65535] - OSPF的邻居失效时间，必须大于Hello报文的时间间隔。 15 enableImportDefaultRoute boolean true false - 是否引入双网关默认路由。 false 返回状态码为400：校验异常。 详细信息请参见实际响应消息体。 返回状态码为500：内部错误。 详细信息请参见实际响应消息体。

请求示例 HTTP的示例 GET /controller/campus/v1/sdwan/net/interlink-route?pageIndex=1&pageSize=20&vpnId=00000000-0000-0000-0000-000000000000&siteId=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：查询成功。 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" : "d3dcf87e-8c14-4ba8-bb23-2ccc4451b845", "nameCn" : "(UTC)协调世界时，加那利群岛", "nameEn" : "(UTC)UTC,Canary Islands", "timezoneUtcOffset" : "0" } ] }

请求示例 HTTP的示例 GET /controller/campus/v1/networkservice/networkconfig/net/timezones 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