华为云用户手册

  • 响应示例 返回状态码为200:修改成功,响应体参考TrafficSteeringPolicyResponse。 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" : "", "success" : [ { "id" : "00000000-0000-0000-0000-000000000000", "vpnId" : "00000000-0000-0000-0000-000000000000", "name" : "TrafficSteeringPolicy", "policyPriority" : 50, "switchoverCondition" : "custom", "delay" : 50, "jitter" : 50, "packetLossRate" : 50, "preferredTransportNetworks" : [ { "transportNetworks" : [ "00000000-0000-0000-0000-000000000000" ], "priority" : 1 } ], "secondaryTransportNetworks" : [ "00000000-0000-0000-0000-000000000000" ], "enableFixed" : true, "classificationId" : "00000000-0000-0000-0000-000000000000", "classificationName" : "classificationName", "effectiveTimeId" : "00000000-0000-0000-0000-000000000000", "effectiveTimeName" : "effectiveTimeName", "advancedSetting" : { "enableSwitchThresholdUp" : true, "switchThresholdUp" : 90, "enableSwitchThresholdLow" : true, "switchThresholdLow" : 20, "actionNotSatisfied" : 1, "enableAdvancePriority" : true, "advancePriority" : 1, "switchMode" : 1, "policyBtwTN" : 1, "bwConditionList" : [ { "transportNetwork" : "Internet", "bwUpType" : "0", "bwUpLimitValPer" : "50", "bwLowType" : "0", "bwLowLimitValPer" : "20", "bwAppUpType" : "1", "bwMaxApp" : "20", "bwAppLowType" : "1", "bwMinApp" : "10" } ], "isGwFirst" : false, "enablePacketReplication" : false, "loadBalanceMode" : "Flow" }, "status" : 1, "isActive" : true } ], "fail" : [ { "errcode" : "0x00c8000c", "errmsg" : "The parameter is invalid.", "data" : { "id" : "00000000-0000-0000-0000-000000000000", "vpnId" : "00000000-0000-0000-0000-000000000000", "name" : "TrafficSteeringPolicy", "policyPriority" : 50, "switchoverCondition" : "custom", "delay" : 50, "jitter" : 50, "packetLossRate" : 50, "preferredTransportNetworks" : [ { "transportNetworks" : [ "00000000-0000-0000-0000-000000000000" ], "priority" : 1 } ], "secondaryTransportNetworks" : [ "00000000-0000-0000-0000-000000000000" ], "enableFixed" : true, "classificationId" : "00000000-0000-0000-0000-000000000000", "classificationName" : "classificationName", "effectiveTimeId" : "00000000-0000-0000-0000-000000000000", "effectiveTimeName" : "effectiveTimeName", "advancedSetting" : { "enableSwitchThresholdUp" : true, "switchThresholdUp" : 90, "enableSwitchThresholdLow" : true, "switchThresholdLow" : 20, "actionNotSatisfied" : 1, "enableAdvancePriority" : true, "advancePriority" : 1, "switchMode" : 1, "policyBtwTN" : 1, "bwConditionList" : [ { "transportNetwork" : "Internet", "bwUpType" : "0", "bwUpLimitValPer" : "50", "bwLowType" : "0", "bwLowLimitValPer" : "20", "bwAppUpType" : "1", "bwMaxApp" : "20", "bwAppLowType" : "1", "bwMinApp" : "10" } ], "isGwFirst" : false, "enablePacketReplication" : false, "loadBalanceMode" : "Flow" }, "status" : 1, "isActive" : true } } ] } 返回状态码为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:成功响应,响应体参考BusinessSuccessRsp。 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" : { "businessBase" : { "name" : "business-exp", "id" : "00000000-0000-0000-0000-000000000000", "label" : "label-exp", "description" : "description-exp", "startTime" : 4102415940000, "endTime" : 4102415940000, "extBusinessId" : "00000000-0000-0000-0000-000000000000" }, "terminalList" : [ { "srcIpOrMac" : "192.168.1.1", "srcPort" : 1, "name" : "terminal-exp" } ], "appList" : [ { "dstIp" : "192.168.1.1", "dstPort" : 1, "protocol" : "ANY" } ], "smartAppInfo" : { "appType" : "Custom", "appId" : "12305", "appName" : "腾讯会议" } } } 返回状态码为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/assurance/business 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 { "businessBase" : { "name" : "business-exp", "id" : "00000000-0000-0000-0000-000000000000", "label" : "label-exp", "description" : "description-exp", "startTime" : 4102415940000, "endTime" : 4102415940000, "extBusinessId" : "00000000-0000-0000-0000-000000000000" }, "terminalList" : [ { "srcIpOrMac" : "192.168.1.1", "srcPort" : 1, "name" : "terminal-exp" } ], "appList" : [ { "dstIp" : "192.168.1.1", "dstPort" : 1, "protocol" : "ANY" } ], "smartAppInfo" : { "appType" : "Custom", "appId" : "12305", "appName" : "腾讯会议" } }
  • 响应参数 返回状态码为200:成功响应,响应体参考BusinessSuccessRsp。 表7 BusinessSuccessRsp对象的参数列表 参数名称 类型 参数值域 默认值 参数说明 参数示例 errcode string 0~64个字符。 - 状态码,0:请求成功。 "0" errmsg string 0~256个字符。 - 接口调用结果的描述信息。 "" data REFERENCE 详细请参见表8。 会议信息。 - 表8 BusinessInfoRsp对象的参数列表 参数名称 类型 参数值域 默认值 参数说明 参数示例 businessBase REFERENCE 详细请参见表9。 业务保障基本信息。 - terminalList ARRAY_REFERENCE 1-2000个列表项,详细请参见表10。 终端列表。 - appList ARRAY_REFERENCE 0-128个列表项,详细请参见表11。 服务组列表。 - smartAppInfo REFERENCE 详细请参见表12。 智能应用信息。 - 表9 BusinessBase对象的参数列表 参数名称 类型 参数值域 默认值 参数说明 参数示例 name string 0~64个字符。 - 业务保障名字。 "business-exp" id string 0~36个字符。 - 业务保障Id。 "00000000-0000-0000-0000-000000000000" label string 0~64个字符。 - 业务保障标签,用户可以为业务保障打任何标签。 "label-exp" description string 0~256个字符。 - 业务保障描述信息。 "description-exp" startTime int64 [0-4102415940000] - 业务保障开始时间,格式为UNIX时间戳,即从1970年1月1日(UTC/GMT的午夜)开始所经过的秒数,不考虑闰秒。 startTime必须大于当前时间且小于endTime,startTime与endTime之间的间隔要小于等于24小时。 不支持在业务保障进行中或结束后进行修改。 4102415940000 endTime int64 [0-4102415940000] - 业务保障结束时间,格式为UNIX时间戳,即从1970年1月1日(UTC/GMT的午夜)开始所经过的秒数,不考虑闰秒。 endTime必须大于startTime,startTime与endTime之间的间隔要小于等于24小时。 进行中状态的业务保障可以增加endTime,已结束状态的业务保障无法修改endTime。 4102415940000 extBusinessId string 0~64个字符。 - 对接外部系统业务Id,可以是会议名或者会议ID等信息,只要能够唯一确定外部会议的标识就可以。 "00000000-0000-0000-0000-000000000000" 表10 TerminalInfo对象的参数列表 参数名称 类型 参数值域 默认值 参数说明 参数示例 srcIpOrMac string 0~64个字符。 - 源IP或MAC。 "192.168.1.1" srcPort int32 [0-65535] - 源端口。 1 name string 0~64个字符。 - 终端名称。 "terminal-exp" 表11 AppInfo对象的参数列表 参数名称 类型 参数值域 默认值 参数说明 参数示例 dstIp string 0~64个字符。 - 目的IP。 "192.168.1.1" dstPort int32 [0-65535] - 目的端口。 1 protocol string 0~3个字符。 ANY 协议类型,取值为ANY,UDP,TCP。 "ANY" 表12 SmartAppInfo对象的参数列表 参数名称 类型 参数值域 默认值 参数说明 参数示例 appType string 1~16个字符。 - 应用类型。Predefine表示预定义应用,Custom表示自定义应用。 "Custom" appId string 0~64个字符。 - 应用ID。当appType是Predefine必填。 "12305" appName string 0~128个字符。 - 应用名称。当appType是Custom必填。 "腾讯会议" 返回状态码为400:异常响应。 详细信息请参见实际响应消息体。 返回状态码为500:内部错误。 详细信息请参见实际响应消息体。
  • 请求参数 表1 body参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 createBusinessBody 是 REFERENCE 详细请参见表2。 业务保障信息。 - 表2 BusinessInfo对象的参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 businessBase 是 REFERENCE 详细请参见表3。 业务保障基本信息。 - terminalList 是 ARRAY_REFERENCE 1-2000个列表项,详细请参见表4。 终端列表,不支持在业务保障进行中或结束后进行修改。 - appList 否 ARRAY_REFERENCE 0-128个列表项,详细请参见表5。 服务组列表,不支持在业务保障进行中或结束后进行修改。 - smartAppInfo 否 REFERENCE 详细请参见表6。 智能应用信息,不支持在业务保障进行中或结束后进行修改。 - 表3 BusinessBase对象的参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 name 是 string 0~64个字符。 - 业务保障名字。 "business-exp" id 否 string 0~36个字符。 - 业务保障Id。 "00000000-0000-0000-0000-000000000000" label 否 string 0~64个字符。 - 业务保障标签,用户可以为业务保障打任何标签。 "label-exp" description 否 string 0~256个字符。 - 业务保障描述信息。 "description-exp" startTime 是 int64 [0-4102415940000] - 业务保障开始时间,格式为UNIX时间戳,即从1970年1月1日(UTC/GMT的午夜)开始所经过的秒数,不考虑闰秒。 startTime必须大于当前时间且小于endTime,startTime与endTime之间的间隔要小于等于24小时。 不支持在业务保障进行中或结束后进行修改。 4102415940000 endTime 是 int64 [0-4102415940000] - 业务保障结束时间,格式为UNIX时间戳,即从1970年1月1日(UTC/GMT的午夜)开始所经过的秒数,不考虑闰秒。 endTime必须大于startTime,startTime与endTime之间的间隔要小于等于24小时。 进行中状态的业务保障可以增加endTime,已结束状态的业务保障无法修改endTime。 4102415940000 extBusinessId 否 string 0~64个字符。 - 对接外部系统业务Id,可以是会议名或者会议ID等信息,只要能够唯一确定外部会议的标识就可以。 "00000000-0000-0000-0000-000000000000" 表4 TerminalInfoReq对象的参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 srcIpOrMac 是 string 0~64个字符。 - 源IP或MAC。 "192.168.1.1" srcPort 否 int32 [0-65535] - 源端口。 1 name 否 string 0~64个字符。 - 终端名称。 "terminal-exp" 表5 AppInfoReq对象的参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 dstIp 否 string 0~64个字符。 - 目的IP。 "192.168.1.1" dstPort 否 int32 [0-65535] - 目的端口。 1 protocol 否 string 0~3个字符。 ANY 协议类型,取值为ANY,UDP,TCP。 "ANY" 表6 SmartAppInfo对象的参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 appType 是 string 1~16个字符。 - 应用类型。Predefine表示预定义应用,Custom表示自定义应用。 "Custom" appId 否 string 0~64个字符。 - 应用ID。当appType是Predefine必填。 "12305" appName 否 string 0~128个字符。 - 应用名称。当appType是Custom必填。 "腾讯会议"
  • 响应示例 返回状态码为200:接口调用成功,响应体参考QueryCommunityFilterResponse。 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" : 20, "pageIndex" : 1, "data" : [ { "id" : "a99f794e-b510-438c-a75d-de59f02347eb", "siteId" : "a99f794e-b510-438c-a75d-de59f02347eb", "deviceId" : "a99f794e-b510-438c-a75d-de59f02347eb", "mode" : "basic", "name" : "communityTest", "nodes" : [ { "index" : 1, "matchMode" : "permit", "communityMembers" : ["10"], "regular" : "^65537$" } ] } ] } 返回状态码为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:接口调用成功,响应体参考QueryCommunityFilterResponse。 表2 QueryCommunityFilterResponse对象的参数列表 参数名称 类型 参数值域 默认值 参数说明 参数示例 errcode string - - 错误码。 "0" errmsg string - - 错误信息。 "" totalRecords integer - - 总数据条数。 1 pageSize integer - 20 每页显示数量,默认20。 20 pageIndex integer - - 当前页,从1开始。 1 data ARRAY_REFERENCE 0-100个列表项,详细请参见表6。 团体属性过滤器信息。 - 返回状态码为400:校验异常。 详细信息请参见实际响应消息体。 返回状态码为500:内部错误。 详细信息请参见实际响应消息体。
  • 请求示例 HTTP的示例 GET /controller/campus/v1/sdwan/routing-protocol/community-filter?pageIndex=1&pageSize=20&siteId=a99f794e-b510-438c-a75d-de59f02347eb&deviceId=a99f794e-b510-438c-a75d-de59f02347eb 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/v1/sdwan/routing-protocol/community-filter 表1 query参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 pageIndex 否 int32 [1-65535] 1 当前页,默认值为1。 1 pageSize 否 int32 [1-100] 20 每页显示数量,默认值为20。 20 siteId 是 string - - 站点ID,UUID格式。 "a99f794e-b510-438c-a75d-de59f02347eb" deviceId 是 string - - 设备ID,UUID格式。 "a99f794e-b510-438c-a75d-de59f02347eb"
  • 响应参数 返回状态码为200:查询返回的Soft-GRE模板信息。 表2 QuerySoftGreResponse对象的参数列表 参数名称 类型 参数值域 默认值 参数说明 参数示例 errcode string 0~64个字符。 - 错误码。 "0" errmsg string 0~256个字符。 - 错误信息。 "" totalRecords int32 [0-100] - 查询匹配到的SoftGre模板总数。 1 data ARRAY_REFERENCE 0-100个列表项,详细请参见表4。 返回的SoftGre模板记录信息。 - 返回状态码为400:校验异常。 详细信息请参见实际响应消息体。 返回状态码为500:内部错误。 详细信息请参见实际响应消息体。
  • 响应示例 返回状态码为200:查询返回的Soft-GRE模板信息。 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, "data" : [ { "id" : "fbde1c5d-5b94-49e3-a912-48641015e45c", "name" : "Soft-GREProfile1", "destinationIp" : "10.10.1.1", "keepAliveEnable" : true, "period" : 5, "retryTimes" : 3, "untaggedVlan" : 3 } ] } 返回状态码为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/api/v1/southboundservice/profile/softgre?pageIndex=1&pageSize=5&queryValue=dev1 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/api/v1/southboundservice/profile/softgre 表1 query参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 pageIndex 否 int32 [1-20] - 页码。 1 pageSize 否 int32 [5-100] - 分页大小。 5 queryValue 否 string 0~64个字符。 - 过滤关键字。 "dev1"
  • 响应示例 返回状态码为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" : "" } 返回状态码为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/sdwan/policy/revoke 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 { "policyType" : "qos", "time" : "1676008846", "policyIds" : ["00000000-0000-0000-0000-000000000000"] }
  • 响应示例 返回状态码为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 返回状态码为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的示例 PUT /restconf/v2/data/huawei-ac-nes-device:nes/ne/00000000-0000-0000-0000-000000000000/huawei-nce-e-ssl-policy:ssl-policies 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 restconf-transaction-id: "00000000-0000-0000-0000-000000000000" { "huawei-nce-e-ssl-policy:ssl-policies" : [ { "config-status" : "configured-database-success", "last-committed-time" : "2022-01-01 00:00:00", "related-pkg-version" : "1.0.1", "edit-state" : "RUNNING", "policy-name" : "test1", "pki-realm" : "default", "cert-file" : "Device-cert.pem", "key-file" : "Device-key.pem", "auth-code-cert" : "Huawei@123", "ca-file-one" : "SRV6_CA.cer", "auth-code-ca-one" : "ddddd", "ca-file-two" : "ddddd", "auth-code-ca-two" : "ddddd" } ] }
  • URI /restconf/v2/data/huawei-ac-nes-device:nes/ne/{id}/huawei-nce-e-ssl-policy:ssl-policies 表1 path参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 id 是 string 36个字符。满足正则表达[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}。 - 设备ID。 "00000000-0000-0000-0000-000000000000"
  • 请求参数 表2 header参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 restconf-transaction-id 是 string - - 事务ID。 "00000000-0000-0000-0000-000000000000" 表3 body参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 huawei-nce-e-ssl-policy:ssl-policies 是 REFERENCE 详细请参见表4。 Secure Socket Layer (SSL) - 表4 nes-ne-ssl-policies-augment对象的参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 huawei-nce-e-ssl-policy:ssl-policies 否 ARRAY_REFERENCE 详细请参见表5。 Secure Socket Layer (SSL) - 表5 nes-ne-ssl-policies对象的参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 config-status 否 string reserved initial configuring-database configured-database-success configured-database-failed configuring-device configured-device-success configured-device-failed reserved 配置状态,对应保留未用状态、初始状态、数据库存储中状态、预配置状态、数据库存储失败状态、部署中状态、成功状态、失败状态;不支持编辑,仅查询返回。 "configured-database-success" last-committed-time 否 string 0~255个字符。 - 最后提交时间,该特性最后提交时间;不支持编辑,仅查询返回。 "2022-01-01 00:00:00" related-pkg-version 否 string 0~255个字符。 - 包版本,插件包版本;不支持编辑,仅查询返回。 "1.0.1" edit-state 否 string RUNNING CANDIDATE UNDEPLOYING UNDEPLOYED - 编辑状态,对应运行状态、候选状态、取消部署状态、未部署状态;不支持编辑,仅查询返回。 "RUNNING" policy-name 否 string 1~23个字符。满足正则表达[a-z0-9_]*。 - ssl-policies名称配置,范围为1-23位小写字符,数字,下划线 "test1" pki-realm 否 string 1~64个字符。 - PKI配置,默认PKI填写default,或设备自定义的pki-domain域,证书导入模式此项不填 "default" cert-file 否 string 1~64个字符。 - 证书文件名称配置,证书导入ssl-policy必填,请确保输入设备本身带有的证书文件名称 "Device-cert.pem" key-file 否 string 1~64个字符。 - 证书key文件名称配置,证书导入ssl-policy必填,请确保输入设备本身带有的证书key文件名称 "Device-key.pem" auth-code-cert 否 string 1~432个字符。 - 证书Key文件密码配置,证书导入ssl-policy必填 "Huawei@123" ca-file-one 否 string 1~64个字符。 - 一级信任证书文件名称配置,证书导入ssl-policy必填,请确保输入设备本身带有的一级信任证书文件名称 "SRV6_CA.cer" auth-code-ca-one 否 string 1~432个字符。 - 一级信任证书文件密码配置,可选填:1-168位字符或数字 "ddddd" ca-file-two 否 string 1~64个字符。 - 二级信任证书文件名称配置,可选填,1-64位字符或数字 "ddddd" auth-code-ca-two 否 string 1~432个字符。 - 二级信任证书文件密码配置,可选填:1-168位字符或数字 "ddddd"
  • 响应示例 返回状态码为200:配置成功,响应体参考QosInterworkTunnelResponse。 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" : "", "success" : [ { "siteId" : "00000000-0000-0000-0000-000000000000", "qosOverHead" : false } ], "fail" : [ { "errcode" : "0x00c8000c", "errmsg" : "The parameter is invalid", "data" : { "siteId" : "00000000-0000-0000-0000-000000000000", "qosOverHead" : 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:配置成功,响应体参考QosInterworkTunnelResponse。 表4 QosInterworkTunnelResponse对象的参数列表 参数名称 类型 参数值域 默认值 参数说明 参数示例 errcode string - - 错误码。 "0" errmsg string - - 错误信息。 "" success ARRAY_REFERENCE 0-100个列表项,详细请参见表5。 成功的站点内联隧道QoS带宽统计开销配置信息列表。 - fail ARRAY_REFERENCE 0-100个列表项,详细请参见表6。 失败的站点内联隧道QoS带宽统计开销配置信息列表。 - 表5 QosInterworkTunnelInfo对象的参数列表 参数名称 类型 参数值域 默认值 参数说明 参数示例 siteId string 0~64个字符。 - 站点ID,uuid格式。 "00000000-0000-0000-0000-000000000000" qosOverHead boolean true false false 内联隧道QoS带宽统计开销。默认值为false。置为true后,站点内联隧道QoS带宽统计开销行为与设备QoS带宽统计开销行为保持一致。 false 表6 FailQosInterworkTunnelInfo对象的参数列表 参数名称 类型 参数值域 默认值 参数说明 参数示例 errcode string - - 错误码。 "0x00c8000c" errmsg string - - 错误信息。 "The parameter is invalid" data REFERENCE 详细请参见表5。 失败的站点内联隧道QoS带宽统计开销配置详细信息。 - 返回状态码为400:请求参数错误。 详细信息请参见实际响应消息体。 返回状态码为500:内部错误。 详细信息请参见实际响应消息体。
  • 请求参数 表1 body参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 qosInterworkTunnelInfos 是 REFERENCE 详细请参见表2。 配置站点内联隧道QoS带宽统计开销请求数据。 - 表2 QosInterworkTunnelInfos对象的参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 qosInterworkTunnelInfos 否 ARRAY_REFERENCE 1-100个列表项,详细请参见表3。 站点内联隧道QoS带宽统计开销配置详细信息。 - 表3 QosInterworkTunnelInfo对象的参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 siteId 是 string 0~64个字符。 - 站点ID,uuid格式。 "00000000-0000-0000-0000-000000000000" qosOverHead 是 boolean true false false 内联隧道QoS带宽统计开销。默认值为false。置为true后,站点内联隧道QoS带宽统计开销行为与设备QoS带宽统计开销行为保持一致。 false
  • 请求示例 HTTP的示例 PUT /controller/campus/v1/sdwan/policy/traffic/interworktunnel/qos 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 { "qosInterworkTunnelInfos" : [ { "siteId" : "00000000-0000-0000-0000-000000000000", "qosOverHead" : false } ] }
  • 响应示例 返回状态码为200:接口调用成功,响应体参考QueryStaticRouteOutInterfaceResponse。 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" : [ { "deviceId" : "00000000-0000-0000-0000-000000000000", "name" : "Tunnel0/0/40", "type" : "IPSec" } ] } 返回状态码为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/routing-protocol/static-outinterface 表1 query参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 vpnId 是 uuid 0~36个字符。 - VPN ID,UUID格式。查询LAN静态路由出接口时使用。 "00000000-0000-0000-0000-000000000000" siteId 是 uuid 0~36个字符。 - 站点ID,UUID格式。 "00000000-0000-0000-0000-000000000000"
  • 请求示例 HTTP的示例 GET /controller/campus/v1/sdwan/routing-protocol/static-outinterface?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:接口调用成功,响应体参考QueryStaticRouteOutInterfaceResponse。 表2 QueryStaticRouteOutInterfaceResponse对象的参数列表 参数名称 类型 参数值域 默认值 参数说明 参数示例 errcode string - - 错误码。 "0" errmsg string - - 错误信息。 "" data ARRAY_REFERENCE 0-2000个列表项,详细请参见表3。 静态路由出接口信息。 - 表3 StaticRouteOutInterface对象的参数列表 参数名称 类型 参数值域 默认值 参数说明 参数示例 deviceId uuid 0~36个字符。 - 静态路由所在设备ID,UUID格式。 "00000000-0000-0000-0000-000000000000" name string 0~64个字符。 - 静态路由可选的出接口。 "Tunnel0/0/40" type string 0~64个字符。 - 出接口类型,取值范围:IPSec、Interworking Link。 "IPSec" 返回状态码为400:校验异常。 详细信息请参见实际响应消息体。 返回状态码为500:内部错误。 详细信息请参见实际响应消息体。
  • 请求示例 HTTP的示例 POST /controller/campus/v1/sdwan/net/sites/action/batch-delete 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 { "sites" : [ { "id" : "a99f794e-b510-438c-a75d-de59f02347eb", "name" : "site1", "locations" : [ { "name" : "Beijing", "address" : "Beijing", "floor" : "5F", "postcode" : "100000", "latitude" : "39.92", "longitude" : "116.46" } ], "devices" : [ { "deviceId" : "a99f794e-b510-438c-a75d-de59f02347eb", "locationName" : "nanjing" } ], "siteType" : "single-gateway", "interLink" : { "type" : "l3-interface", "enableGre" : false, "vlanMin" : 4000, "vlanMax" : 4008, "extendVlans" : ["1:9"], "portPairs" : [ { "device1PortId" : "a99f794e-b510-438c-a75d-de59f02347eb", "device2PortId" : "a99f794e-b510-438c-a75d-de59f02347eb", "device1Id" : "a99f794e-b510-438c-a75d-de59f02347eb", "device1PortType" : "GE", "device1PortNum" : "0/0/1", "device1PortAddress" : "192.168.101.1", "device1PortMask" : 24, "device2Id" : "a99f794e-b510-438c-a75d-de59f02347eb", "device2PortType" : "GE", "device2PortNum" : "0/0/1", "device2PortAddress" : "192.168.101.1", "device2PortMask" : 24 } ], "mtu" : 1500, "mss" : 1200 }, "role" : ["sd-wan-edge","evpn-rr"], "controlPoints" : ["a99f794e-b510-438c-a75d-de59f02347eb"], "timeZone" : "(UTC+08:00)Beijing,Chongqing,Hong Kong,Urumqi", "enableSummerConfig" : "", "enableAutoConfig" : true, "daylightSavingTime" : { "name" : "Atlantic/Canary", "offset" : "01:00", "enableWeekDay" : false, "startTime" : { "month" : "Jan", "time" : "23:59", "week" : "first", "weekday" : "Mon", "day" : 21 }, "stopTime" : { "month" : "Jan", "time" : "23:59", "week" : "first", "weekday" : "Mon", "day" : 21 } }, "contact" : { "responsiblePerson" : "Jack Lee", "phoneNumber" : "152xxxxxxxx", "emails" : ["xxx@xxx.xxx"] }, "description" : "sdwan Site", "tag" : "tagHub", "isolated" : false, "enhancedMode" : false } ] }
  • 响应示例 返回状态码为200:删除站点成功。返回的Site信息中仅包含对应的ID,响应体参考SiteResponse。 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" : "", "success" : [ { "id" : "a99f794e-b510-438c-a75d-de59f02347eb", "name" : "site1", "locations" : [ { "name" : "Beijing", "address" : "Beijing", "floor" : "5F", "postcode" : "100000", "latitude" : "39.92", "longitude" : "116.46" } ], "devices" : [ { "deviceId" : "a99f794e-b510-438c-a75d-de59f02347eb", "locationName" : "nanjing" } ], "siteType" : "single-gateway", "interLink" : { "type" : "l3-interface", "enableGre" : false, "vlanMin" : 4000, "vlanMax" : 4008, "extendVlans" : ["1:9"], "portPairs" : [ { "device1PortId" : "a99f794e-b510-438c-a75d-de59f02347eb", "device2PortId" : "a99f794e-b510-438c-a75d-de59f02347eb", "device1Id" : "a99f794e-b510-438c-a75d-de59f02347eb", "device1PortType" : "GE", "device1PortNum" : "0/0/1", "device1PortAddress" : "192.168.101.1", "device1PortMask" : 24, "device2Id" : "a99f794e-b510-438c-a75d-de59f02347eb", "device2PortType" : "GE", "device2PortNum" : "0/0/1", "device2PortAddress" : "192.168.101.1", "device2PortMask" : 24 } ], "mtu" : 1500, "mss" : 1200 }, "role" : ["sd-wan-edge","evpn-rr"], "controlPoints" : ["a99f794e-b510-438c-a75d-de59f02347eb"], "timeZone" : "(UTC+08:00)Beijing,Chongqing,Hong Kong,Urumqi", "enableSummerConfig" : "", "enableAutoConfig" : true, "daylightSavingTime" : { "name" : "Atlantic/Canary", "offset" : "01:00", "enableWeekDay" : false, "startTime" : { "month" : "Jan", "time" : "23:59", "week" : "first", "weekday" : "Mon", "day" : 21 }, "stopTime" : { "month" : "Jan", "time" : "23:59", "week" : "first", "weekday" : "Mon", "day" : 21 } }, "contact" : { "responsiblePerson" : "Jack Lee", "phoneNumber" : "152xxxxxxxx", "emails" : ["xxx@xxx.xxx"] }, "description" : "sdwan Site", "tag" : "tagHub", "isolated" : false, "enhancedMode" : false } ], "fail" : [ { "errcode" : "0", "errmsg" : "", "data" : { "id" : "a99f794e-b510-438c-a75d-de59f02347eb", "name" : "site1", "locations" : [ { "name" : "Beijing", "address" : "Beijing", "floor" : "5F", "postcode" : "100000", "latitude" : "39.92", "longitude" : "116.46" } ], "devices" : [ { "deviceId" : "a99f794e-b510-438c-a75d-de59f02347eb", "locationName" : "nanjing" } ], "siteType" : "single-gateway", "interLink" : { "type" : "l3-interface", "enableGre" : false, "vlanMin" : 4000, "vlanMax" : 4008, "extendVlans" : ["1:9"], "portPairs" : [ { "device1PortId" : "a99f794e-b510-438c-a75d-de59f02347eb", "device2PortId" : "a99f794e-b510-438c-a75d-de59f02347eb", "device1Id" : "a99f794e-b510-438c-a75d-de59f02347eb", "device1PortType" : "GE", "device1PortNum" : "0/0/1", "device1PortAddress" : "192.168.101.1", "device1PortMask" : 24, "device2Id" : "a99f794e-b510-438c-a75d-de59f02347eb", "device2PortType" : "GE", "device2PortNum" : "0/0/1", "device2PortAddress" : "192.168.101.1", "device2PortMask" : 24 } ], "mtu" : 1500, "mss" : 1200 }, "role" : ["sd-wan-edge","evpn-rr"], "controlPoints" : ["a99f794e-b510-438c-a75d-de59f02347eb"], "timeZone" : "(UTC+08:00)Beijing,Chongqing,Hong Kong,Urumqi", "enableSummerConfig" : "", "enableAutoConfig" : true, "daylightSavingTime" : { "name" : "Atlantic/Canary", "offset" : "01:00", "enableWeekDay" : false, "startTime" : { "month" : "Jan", "time" : "23:59", "week" : "first", "weekday" : "Mon", "day" : 21 }, "stopTime" : { "month" : "Jan", "time" : "23:59", "week" : "first", "weekday" : "Mon", "day" : 21 } }, "contact" : { "responsiblePerson" : "Jack Lee", "phoneNumber" : "152xxxxxxxx", "emails" : ["xxx@xxx.xxx"] }, "description" : "sdwan Site", "tag" : "tagHub", "isolated" : false, "enhancedMode" : false } } ], "processInstanceId" : "" } 返回状态码为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
  • URI /controller/campus/v1/networkservice/networkconfig/net/lswport/devices/{deviceId}/ethtrunk-ports/{name} 表1 path参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 deviceId 是 uuid - - 设备ID。 "fbb684c8-0d37-496f-bafa-4b06d5151e2e" name 是 string 10~12个字符。 - EthTrunk端口名称,必须是Eth-Trunk[数字]的格式,数字最大511。 "Eth-Trunk1"
共100000条
提示

您即将访问非华为云网站,请注意账号财产安全