云服务器内容精选

  • 响应示例 返回状态码为200:导出成功。 HTTP/1.1 200 OK Date: Sun,16 Feb 2025 10:00:00 GMT Server: example-server Content-Type: application/octerstream,application/json;charset=UTF-8 Content-Length: 250 Connection: keep-alive 返回状态码为400:请求参数错误,响应体参考ExportCmdResponse。 HTTP/1.1 400 Bad Request Date: Sun,16 Feb 2025 10:00:00 GMT Server: example-server Content-Type: application/octerstream,application/json;charset=UTF-8 Content-Length: 250 Connection: keep-alive { "errcode" : "error", "errmsg" : "" } 返回状态码为500:系统内部错误。 HTTP/1.1 500 Internal Server Error Date: Sun,16 Feb 2025 10:00:00 GMT Server: example-server Content-Type: application/octerstream,application/json;charset=UTF-8 Content-Length: 250 Connection: keep-alive
  • 响应参数 返回状态码为200:导出成功。 返回状态码为400:请求参数错误,响应体参考ExportCmdResponse。 表3 ExportCmdResponse对象的参数列表 参数名称 类型 参数值域 默认值 参数说明 参数示例 errcode string - - 错误码,0表示成功,非0表示失败。 "error" errmsg string - - 错误信息。 "" 返回状态码为500:系统内部错误。 详细信息请参见实际响应消息体。
  • 请求示例 HTTP的示例 POST /controller/campus/ui/v2/sdwan/openapi/maintenance/cli/export HTTP/1.1 Host: 192.168.1.125:18002 Content-Type: application/json Accept: application/octerstream,application/json Accept-Language: en-US X-AC CES S-TOKEN: x-yyyyyy { "exportPassword" : "Example@123", "exportAll" : true, "siteIds" : [ "00000000-0000-0000-0000-000000000000" ], "deviceIds" : [ "00000000-0000-0000-0000-000000000000" ], "esns" : [ "AR500102390000000001" ] }
  • 响应示例 返回状态码为200:配置成功,响应体参考ImportCmdResponse。 HTTP/1.1 200 OK Date: Sun,16 Feb 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" : [ { "deviceId" : "00000000-0000-0000-0000-000000000000", "errorMsg" : "The esn does not exist." } ], "fail" : [ { "deviceId" : "00000000-0000-0000-0000-000000000000", "errorMsg" : "The esn does not exist." } ], "processInstanceId" : "" } 返回状态码为202:请求正在处理中,请求处理详情请通过“查询业务编排结果”接口,确认是否处理成功。响应体参考ImportCmdResponse。 HTTP/1.1 202 Accepted Date: Sun,16 Feb 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,16 Feb 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,16 Feb 2025 10:00:00 GMT Server: example-server Content-Type: application/json;charset=UTF-8 Content-Length: 250 Connection: keep-alive
  • 响应参数 返回状态码为200:配置成功,响应体参考ImportCmdResponse。 表5 ImportCmdResponse对象的参数列表 参数名称 类型 参数值域 默认值 参数说明 参数示例 errcode string - - 错误码,0表示成功,非0表示失败。 "0" errmsg string - - 错误信息。 "" success ARRAY_REFERENCE 0-3200个列表项,详细请参见表6。 成功列表。 - fail ARRAY_REFERENCE 0-3200个列表项,详细请参见表6。 失败列表。 - processInstanceId string 0~36个字符。 - 编排流程实例ID,UUID格式。当接口返回码为202时非空。 - 表6 ImportCmdResultVo对象的参数列表 参数名称 类型 参数值域 默认值 参数说明 参数示例 deviceId string - - 设备ID,格式UUID。 "00000000-0000-0000-0000-000000000000" errorMsg string - - 错误信息。如果没有错误信息,该字段返回空。 "The esn does not exist." 返回状态码为202:请求正在处理中,请求处理详情请通过“查询业务编排结果”接口,确认是否处理成功。响应体参考ImportCmdResponse。 返回状态码为400:请求参数错误。 详细信息请参见实际响应消息体。 返回状态码为500:系统内部错误。 详细信息请参见实际响应消息体。
  • 接口约束 1、该接口仅支持租户视图或msp代维视图下,角色为“Open Api Operator”的用户访问,必须在用户会话建立后使用。 2、接口不返回配置结果。 3、同一设备下发两次配置,新的配置会覆盖旧的配置。 4、CLI序列不支持事务,如果识别,需要人工修订配置。 5、不允许下发与iMaster NCE-Campus编排冲突的配置。 6、该接口请在华为工程师的指导下使用。 7、V600系列版本的设备不支持CLI下发配置。
  • 请求参数 表1 body参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 importCmdListVo 是 REFERENCE 详细请参见表2。 下发的命令。 设备ID不能重复; 每个命令之前用\n分开; 每条配置最多支持4096个字符,其中\n算一个字符。 - 表2 ImportCmdListVo对象的参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 cmdList 否 ARRAY_REFERENCE 0-3200个列表项,详细请参见表3。 下发的命令列表。 - 表3 ImportCmdVo对象的参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 deviceId 是 string 1~64个字符。 - 设备ID。 在列表中不允许重复。 "00000000-0000-0000-0000-000000000000" cmds 是 ARRAY_REFERENCE 1-3个列表项,详细请参见表4。 待执行的所有命令。 - 表4 CmdVo对象的参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 buildRun 否 password 0~4096个字符。 - 该字段可能包含敏感信息和个人数据,请妥善做好保护。 全量执行配置。 不能超过4096个字符。 "returnsyssysname spoke" executeCli 否 password 0~4096个字符。 - 该字段可能包含敏感信息和个人数据,请妥善做好保护。 实时执行配置。 不能超过4096个字符。 "returnsyssysname spoke" index 否 integer [0-2] - 执行顺序标记位。 取值范围[0,2]。 0
  • 请求示例 HTTP的示例 POST /controller/campus/ui/v1/sdwan/openapi/maintenance/cli/inject 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 { "cmdList" : [ { "deviceId" : "00000000-0000-0000-0000-000000000000", "cmds" : [ { "buildRun" : "return\nsys\nsysname spoke", "executeCli" : "return\nsys\nsysname spoke", "index" : 0 } ] } ] }
  • 响应示例 返回状态码为200:查询成功,响应体参考QueryCmdResponse。 HTTP/1.1 200 OK Date: Sun,16 Feb 2025 10:00:00 GMT Server: example-server Content-Type: application/json;charset=UTF-8 Content-Length: 250 Connection: keep-alive { "errcode" : "0", "errmsg" : "", "total" : 10, "pageIndex" : 1, "pageSize" : 20, "data" : [ { "esn" : "AR500102390000000001", "deviceId" : "00000000-0000-0000-0000-000000000000", "deviceName" : "deviceName1", "siteId" : "00000000-0000-0000-0000-000000000000", "siteName" : "spoke", "userName" : "tenant", "updateTime" : "2019-06-06 10:10:10", "result" : "The esn does not exist.", "runTag" : 0 } ] } 返回状态码为400:请求参数错误。 HTTP/1.1 400 Bad Request Date: Sun,16 Feb 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,16 Feb 2025 10:00:00 GMT Server: example-server Content-Type: application/json;charset=UTF-8 Content-Length: 250 Connection: keep-alive
  • 响应参数 返回状态码为200:查询成功,响应体参考QueryCmdResponse。 表3 QueryCmdResponse对象的参数列表 参数名称 类型 参数值域 默认值 参数说明 参数示例 errcode string - - 错误码,0表示成功,非0表示失败。 "0" errmsg string - - 错误信息。 "" total int32 - - 总记录数量。 10 pageIndex int32 - - 当前页。 1 pageSize int32 - - 分页大小。 20 data ARRAY_REFERENCE 0-3200个列表项,详细请参见表4。 - - 表4 QueryCmdResultVo对象的参数列表 参数名称 类型 参数值域 默认值 参数说明 参数示例 esn string - - 设备ESN。 "AR500102390000000001" deviceId uuid - - 设备ID,UUID格式。 "00000000-0000-0000-0000-000000000000" deviceName string - - 设备名称。 "deviceName1" siteId uuid - - 站点ID,UUID格式。 "00000000-0000-0000-0000-000000000000" siteName string - - 站点名称。 "spoke" userName string - - 用户名称。 "tenant" updateTime string - - 更新时间。 "2019-06-06 10:10:10" result string 0~50个字符。 - 校验结果。 "The esn does not exist." runTag int32 [0-4] - 执行结果。0---成功;1---告警;2---预配置;3---失败;4---正在下发。 0 返回状态码为400:请求参数错误。 详细信息请参见实际响应消息体。 返回状态码为500:系统内部错误。 详细信息请参见实际响应消息体。
  • 请求示例 HTTP的示例 POST /controller/campus/ui/v1/sdwan/openapi/maintenance/cli/query 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 { "pageIndex" : 1, "pageSize" : 20, "siteIds" : [ "00000000-0000-0000-0000-000000000000" ], "deviceIds" : [ "00000000-0000-0000-0000-000000000000" ], "esns" : [ "AR500102390000000001" ], "keyword" : "站点A" }