华为云用户手册

  • 请求示例 HTTP的示例 PUT /v1/runbook/external-systems/3814d9aa-8d46-42ee-9194-dc17d0c21888 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 { "id" : "3814d9aa-8d46-42ee-9194-dc17d0c21888", "account" : "support_e@huawei.com", "pwd" : "Example@123" }
  • 响应示例 返回状态码为200:批量审批成功,响应体参考ApproveResult。 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 { "errorCode" : "0", "errorMessage" : "设备不存在", "success" : [ { "deviceId" : "00000000-0000-0000-0000-000000000001", "oldTenantId" : "00000000-0000-0000-0000-000000000004", "oldTenantName" : "tenant1", "oldDeviceGroupId" : "00000000-0000-0000-0000-000000000004", "oldDeviceGroupName" : "group1", "errorCode" : "0x00c8003c", "errorMsg" : "register failed" } ], "fail" : [ { "deviceId" : "00000000-0000-0000-0000-000000000001", "oldTenantId" : "00000000-0000-0000-0000-000000000004", "oldTenantName" : "tenant1", "oldDeviceGroupId" : "00000000-0000-0000-0000-000000000004", "oldDeviceGroupName" : "group1", "errorCode" : "0x00c8003c", "errorMsg" : "register failed" } ] } 返回状态码为400:设备ID格式错误时返回,响应体参考ErrorResponse。 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" : "0x00c80035", "errorMessage" : "参数非法" } 返回状态码为500:服务内部异常时返回,响应体参考ErrorResponse。 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 { "errorCode" : "0x00c80035", "errorMessage" : "参数非法" }
  • 请求示例 HTTP的示例 POST /v1/devicemgr/access-approvals/action/batch-approve 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 { "actionType" : 1, "deviceIds" : ["00000000-0000-0000-0000-000000000001"], "forceRegister" : true }
  • 响应参数 返回状态码为200:批量审批成功,响应体参考ApproveResult。 表3 ApproveResult对象的参数列表 参数名称 类型 参数值域 默认值 参数说明 参数示例 errorCode string 1~10个字符。 - 错误码,0表示成功,1表示失败 "0" errorMessage string 1~100个字符。 - 错误原因 "设备不存在" success ARRAY_REFERENCE 0-1000个列表项,详细请参见表4。 审批成功列表 - fail ARRAY_REFERENCE 0-1000个列表项,详细请参见表4。 审批失败列表 - 表4 ApproveResultUnit对象的参数列表 参数名称 类型 参数值域 默认值 参数说明 参数示例 deviceId string 1~64个字符。 - 设备ID "00000000-0000-0000-0000-000000000001" oldTenantId string 0~36个字符。 - 添加设备esn重复时,展示原租户id "00000000-0000-0000-0000-000000000004" oldTenantName string 0~64个字符。 - 添加设备esn重复时,展示原租户名称并匿名化处理 "tenant1" oldDeviceGroupId string 0~36个字符。 - 添加设备esn重复时,展示原站点id "00000000-0000-0000-0000-000000000004" oldDeviceGroupName string 0~64个字符。 - 添加设备esn重复时,展示原站点名称并匿名化处理 "group1" errorCode string 1~128个字符。 - 错误码 "0x00c8003c" errorMsg string 1~2048个字符。 - 错误信息 "register failed" 返回状态码为400:设备ID格式错误时返回,响应体参考ErrorResponse。 ErrorResponse对象的参数列表,详细请参见表5。 返回状态码为500:服务内部异常时返回,响应体参考ErrorResponse。 ErrorResponse对象的参数列表,详细请参见表5。
  • 响应示例 返回状态码为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
  • URI /restconf/v2/data/huawei-ac-nes-device:nes/ne/{id}/huawei-nce-e-nqa:nqa 表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"
  • 请求示例 HTTP的示例 PATCH /restconf/v2/data/huawei-ac-nes-device:nes/ne/00000000-0000-0000-0000-000000000000/huawei-nce-e-nqa:nqa 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-nqa:nqa" : { "test-name" : "TestName", "type" : "ipv4", "ipv4-dest-address" : "192.168.1.1", "ipv4-next-hop" : "192.168.1.2", "ipv6-dest-address" : "FC00::1101", "ipv6-next-hop" : "FC00::1102", "out-if-name" : "GE0/0/1", "vpn-instance" : "_public_", "probe-count" : 5, "interval" : 4, "timeout" : 3, "frequency" : 22, "data-size" : 0, "ttl" : 30, "tos" : 0, "send-trap-bits" : "resultchange", "execution-switch" : true } }
  • 响应示例 返回状态码为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
  • 请求示例 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" }
  • 响应参数 返回状态码为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 - 是否使能HWTACA CS 服务器模板。 当为 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:内部异常。 详细信息请参见实际响应消息体。
  • 请求参数 表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:成功删除RADIUS服务器模板信息。 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" : [ "fbb684c8-0d37-496f-bafa-4b06db151e2a" ], "fail" : [ { "errcode" : "0304030091", "errmsg" : "The specified object does not exist", "data" : "fbb684c8-0d37-496f-bafa-4b06db151e2a" } ] } 返回状态码为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/networkservice/networkconfig/profile/radius/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 { "ids" : [ "fbb684c8-0d37-496f-bafa-4b06db151e2a" ] }
  • 请求示例 HTTP的示例 GET /controller/campus/v1/sdwan/policy/apply-policy?policyId=00000000-0000-0000-0000-000000000000&policyType=qos&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:查询成功,响应体参考QueryApplyPolicResponse。 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" : [ { "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" } ] } 返回状态码为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/api/v1/networkconfig/lswdefendpolicy/devices/{deviceId}/defendpolicy/batch-delete 表1 path参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 deviceId 是 string 36个字符。 - 设备ID。 "fbb684c8-0d37-496f-bafa-4b06d5151e2e"
  • 响应参数 返回状态码为200:删除交换机防攻击策略配置成功。 表4 ResponseBaseDto对象的参数列表 参数名称 类型 参数值域 默认值 参数说明 参数示例 errcode string 0~64个字符。 - 错误码。 "0" errmsg string 0~256个字符。 - 错误信息。 "" 返回状态码为400:校验异常。 详细信息请参见实际响应消息体。 返回状态码为500:内部服务错误 详细信息请参见实际响应消息体。
  • 响应示例 返回状态码为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" : "" } 返回状态码为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/api/v1/networkconfig/lswdefendpolicy/devices/fbb684c8-0d37-496f-bafa-4b06d5151e2e/defendpolicy/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 { "ids" : ["e4d2b0e95bb94ef0a75b6a530d0b41be"] }
  • 响应示例 返回状态码为200:修改成功,响应体参考ReflectorConfigResponse。 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", "interfaceName" : "GigabitEthernet0/0/1", "srcPort" : 49187, "destPort" : 7, "status" : 1, "updateTime" : 1629947096000 } } 返回状态码为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 /controller/campus/v1/sdwan/interface/reflector 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 { "deviceId" : "00000000-0000-0000-0000-000000000000", "interfaceName" : "GigabitEthernet0/0/1", "srcPort" : 49187, "destPort" : 7 }
  • 响应示例 返回状态码为200:查询ping探测结果信息成功,响应体参考PingReplyResponse。 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" : "The device does not exist.", "data" : { "taskId" : "75ade72a-e7a9-4c81-8fca-894e7ca9c2c2", "totalCount" : 5, "successCount" : 5, "lossRate" : 100, "rttAvg" : 5, "status" : 1, "PingReply" : { "data" : [ { "sequence" : 5, "dataByte" : 5, "ttlOrHoplimit" : 100, "rtt" : 5, "result" : 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:查询ping探测结果信息成功,响应体参考PingReplyResponse。 表2 PingReplyResponse对象的参数列表 参数名称 类型 参数值域 默认值 参数说明 参数示例 errcode string - - 错误码。 "0" errmsg string - - 错误信息。 "The device does not exist." data REFERENCE 详细请参见表3。 ping任务返回结果 - 表3 PingReplyResult对象的参数列表 参数名称 类型 参数值域 默认值 参数说明 参数示例 taskId string - - ping探测任务ID,格式UUID。 "75ade72a-e7a9-4c81-8fca-894e7ca9c2c2" totalCount integer - - 总探测次数。 5 successCount integer - - 成功探测次数。 5 lossRate float - - 丢失率。单位:百分比。 100 rttAvg integer - - 报文平均响应时间,单位:毫秒。 5 status integer - - 探测状态。 0 --- 成功 1 --- 执行中 2 --- 超时 3 --- 失败 1 PingReply REFERENCE 详细请参见表4。 ping探测任务返回具体信息。 - 表4 PingReply对象的参数列表 参数名称 类型 参数值域 默认值 参数说明 参数示例 data ARRAY_REFERENCE 0-2147483647个列表项,详细请参见表5。 ping探测任务返回具体信息。 - 表5 PingReplySingle对象的参数列表 参数名称 类型 参数值域 默认值 参数说明 参数示例 sequence integer - - 探测序号。 5 dataByte integer - - 响应报文的长度,单位:字节。 5 ttlOrHoplimit integer - - 生存时间值,单位:毫秒。 100 rtt integer - - 响应时间,单位:毫秒。 5 result integer - - 探测状态。 0 --- 成功 1 --- 执行中 2 --- 超时 1 返回状态码为400:请求参数错误,无响应体。 详细信息请参见实际响应消息体。 返回状态码为500:内部服务器错误,无响应体。 详细信息请参见实际响应消息体。
  • 请求示例 HTTP的示例 GET /controller/campus/v1/oamservice/ping/75ade72a-e7a9-4c81-8fca-894e7ca9c2c2 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:增加南向接入成功,响应体参考SouthAccessCreateOutput。 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" : "OK", "data" : { "id" : "00000000-0000-0000-000000000000", "name" : "运营商A", "description" : "运营商A的南向ip", "enable" : "false", "mainIp" : "192.168.10.10", "backupIp" : "192.168.10.11", "ipType" : "IPv4", "priority" : 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
  • 请求示例 HTTP的示例 POST /controller/campus/v2/south/access 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 { "name" : "运营商A", "description" : "运营商A的南向ip", "enable" : "false", "mainIp" : "192.168.10.10", "backupIp" : "192.168.10.11", "ipType" : "IPv4", "priority" : 1 }
  • 响应参数 返回状态码为200:增加南向接入成功,响应体参考SouthAccessCreateOutput。 表3 SouthAccessCreateOutput对象的参数列表 参数名称 类型 参数值域 默认值 参数说明 参数示例 errcode string 1~2048个字符。 - 错误码 "0" errmsg string 1~2048个字符。 - 错误信息 "OK" data REFERENCE 详细请参见表4。 南向接入服务响应参数 - 表4 SouthAccessBaseCommonDto对象的参数列表 参数名称 类型 参数值域 默认值 参数说明 参数示例 id string 0~64个字符。 - 主键 "00000000-0000-0000-000000000000" name string 0~64个字符。 - 名称 "运营商A" description string 0~64个字符。 - 描述信息 "运营商A的南向ip" enable boolean true false - 是否启用。当enable为true时,msp/tenant创建wan链路可选择该接入服务,站点激活后,接入服务主用ip不可更改;当enable为false时,msp/tenant创建wan链路不可选择该接入服务。msp/tenant查询不可见。 "false" mainIp string 0~64个字符。 - 主用ip,msp/tenant查询不可见。 "192.168.10.10" backupIp string 0~64个字符。 - 备用ip,msp/tenant查询不可见。 "192.168.10.11" ipType string 0~6个字符。 - ip类型,v4或v6。 "IPv4" priority int32 [1-4096] - 优先级。 1 返回状态码为400:校验异常。 详细信息请参见实际响应消息体。 返回状态码为500:内部错误 详细信息请参见实际响应消息体。
  • 请求参数 表1 body参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 southAccessCreateInput 是 REFERENCE 详细请参见表2。 增加南向接入请求体 - 表2 SouthAccessCreateInput对象的参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 name 否 string 0~64个字符。 - 名称 "运营商A" description 否 string 0~64个字符。 - 描述信息 "运营商A的南向ip" enable 否 boolean true false - 是否启用。当enable为true时,msp/tenant创建wan链路可选择该接入服务,站点激活后,接入服务主用ip不可更改;当enable为false时,msp/tenant创建wan链路不可选择该接入服务。msp/tenant查询不可见。 "false" mainIp 否 string 0~64个字符。 - 主用ip,msp/tenant查询不可见。 "192.168.10.10" backupIp 否 string 0~64个字符。 - 备用ip,msp/tenant查询不可见。 "192.168.10.11" ipType 否 string 0~6个字符。 - ip类型,v4或v6。 "IPv4" priority 否 int32 [1-4096] - 优先级。 1
  • 响应示例 返回状态码为201:创建成功,响应体参考TacacsServerTemplateResponse。 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" : { "siteId" : "00000000-0000-0000-0000-000000000000", "deviceId" : "00000000-0000-0000-0000-000000000000", "templateName" : "server1", "descr" : "server1 is in SD", "primaryAuthenServerInfo" : { "serverIP" : "10.134.6.5", "serverPort" : 10, "tnpId" : "00000000-0000-0000-0000-000000000000", "vpnId" : "00000000-0000-0000-0000-000000000000" }, "secondAuthenServerInfo" : { "serverIP" : "10.134.6.5", "serverPort" : 10, "tnpId" : "00000000-0000-0000-0000-000000000000", "vpnId" : "00000000-0000-0000-0000-000000000000" }, "thirdAuthenServerInfo" : { "serverIP" : "10.134.6.5", "serverPort" : 10, "tnpId" : "00000000-0000-0000-0000-000000000000", "vpnId" : "00000000-0000-0000-0000-000000000000" }, "primaryAuthorServerInfo" : { "serverIP" : "10.134.6.5", "serverPort" : 10, "tnpId" : "00000000-0000-0000-0000-000000000000", "vpnId" : "00000000-0000-0000-0000-000000000000" }, "secondAuthorServerInfo" : { "serverIP" : "10.134.6.5", "serverPort" : 10, "tnpId" : "00000000-0000-0000-0000-000000000000", "vpnId" : "00000000-0000-0000-0000-000000000000" }, "thirdAuthorServerInfo" : { "serverIP" : "10.134.6.5", "serverPort" : 10, "tnpId" : "00000000-0000-0000-0000-000000000000", "vpnId" : "00000000-0000-0000-0000-000000000000" }, "primaryAccountServerInfo" : { "serverIP" : "10.134.6.5", "serverPort" : 10, "tnpId" : "00000000-0000-0000-0000-000000000000", "vpnId" : "00000000-0000-0000-0000-000000000000" }, "secondAccountServerInfo" : { "serverIP" : "10.134.6.5", "serverPort" : 10, "tnpId" : "00000000-0000-0000-0000-000000000000", "vpnId" : "00000000-0000-0000-0000-000000000000" }, "thirdAccountServerInfo" : { "serverIP" : "10.134.6.5", "serverPort" : 10, "tnpId" : "00000000-0000-0000-0000-000000000000", "vpnId" : "00000000-0000-0000-0000-000000000000" }, "isContainDomainName" : true, "passwordKey" : "Example@123", "sourceIp" : "10.134.6.5", "tempalteId" : "" } } 返回状态码为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/aaa/tacaservertemplate 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", "templateName" : "server1", "descr" : "server1 is in SD", "primaryAuthenServerInfo" : { "serverIP" : "10.134.6.5", "serverPort" : 10, "tnpId" : "00000000-0000-0000-0000-000000000000", "vpnId" : "00000000-0000-0000-0000-000000000000" }, "secondAuthenServerInfo" : { "serverIP" : "10.134.6.5", "serverPort" : 10, "tnpId" : "00000000-0000-0000-0000-000000000000", "vpnId" : "00000000-0000-0000-0000-000000000000" }, "thirdAuthenServerInfo" : { "serverIP" : "10.134.6.5", "serverPort" : 10, "tnpId" : "00000000-0000-0000-0000-000000000000", "vpnId" : "00000000-0000-0000-0000-000000000000" }, "primaryAuthorServerInfo" : { "serverIP" : "10.134.6.5", "serverPort" : 10, "tnpId" : "00000000-0000-0000-0000-000000000000", "vpnId" : "00000000-0000-0000-0000-000000000000" }, "secondAuthorServerInfo" : { "serverIP" : "10.134.6.5", "serverPort" : 10, "tnpId" : "00000000-0000-0000-0000-000000000000", "vpnId" : "00000000-0000-0000-0000-000000000000" }, "thirdAuthorServerInfo" : { "serverIP" : "10.134.6.5", "serverPort" : 10, "tnpId" : "00000000-0000-0000-0000-000000000000", "vpnId" : "00000000-0000-0000-0000-000000000000" }, "primaryAccountServerInfo" : { "serverIP" : "10.134.6.5", "serverPort" : 10, "tnpId" : "00000000-0000-0000-0000-000000000000", "vpnId" : "00000000-0000-0000-0000-000000000000" }, "secondAccountServerInfo" : { "serverIP" : "10.134.6.5", "serverPort" : 10, "tnpId" : "00000000-0000-0000-0000-000000000000", "vpnId" : "00000000-0000-0000-0000-000000000000" }, "thirdAccountServerInfo" : { "serverIP" : "10.134.6.5", "serverPort" : 10, "tnpId" : "00000000-0000-0000-0000-000000000000", "vpnId" : "00000000-0000-0000-0000-000000000000" }, "isContainDomainName" : true, "passwordKey" : "Example@123", "sourceIp" : "10.134.6.5" }
共100000条
提示

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