云服务器内容精选

  • 响应参数 返回状态码为200:删除成功,响应体参考SimpleResponse。 表3 SimpleResponse对象的参数列表 参数名称 类型 参数值域 默认值 参数说明 参数示例 errcode string - - 错误码:0 表示接口执行成功,非0 表示接口执行失败。 "0" errmsg string - - 错误信息。 "" processInstanceId string 0~36个字符。 - 编排流程实例ID,UUID格式。当接口返回码为202时非空。 - 返回状态码为202:请求正在处理中,请求处理详情请通过“查询业务编排结果”接口,确认是否处理成功。响应体参考SimpleResponse。 SimpleResponse对象的参数列表,详细请参见表3。 返回状态码为400:请求参数错误。 详细信息请参见实际响应消息体。 返回状态码为500:内部异常。 详细信息请参见实际响应消息体。
  • 响应示例 返回状态码为200:删除成功,响应体参考SimpleResponse。 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" : "", "processInstanceId" : "" } 返回状态码为202:请求正在处理中,请求处理详情请通过“查询业务编排结果”接口,确认是否处理成功。响应体参考SimpleResponse。 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 { "errcode" : "0", "errmsg" : "", "processInstanceId" : "" } 返回状态码为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
  • 请求示例 HTTP的示例 POST /controller/campus/v2/sdwansyslog/syslog/batch-delete 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 { "syslogIds" : [ "00000000-0000-0000-0000-000000000000" ] }
  • 响应参数 返回状态码为200:修改成功,响应体参考SyslogResponse。 SyslogResponse对象的参数列表,详细请参见表3。 返回状态码为202:请求正在处理中,请求处理详情请通过“查询业务编排结果”接口,确认是否处理成功。响应体参考SimpleResponse。 SyslogResponse对象的参数列表,详细请参见表3。 返回状态码为400:请求参数错误。 详细信息请参见实际响应消息体。 返回状态码为500:内部异常。 详细信息请参见实际响应消息体。
  • 响应示例 返回状态码为200:修改成功,响应体参考SyslogResponse。 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" : "", "data" : { "id" : "00000000-0000-0000-0000-000000000000", "syslog" : { "enableHec" : true, "hecToken" : "00000000-0000-0000-0000-000000000000", "domainName" : "www.example.org", "address" : "10.136.108.65", "port" : 514, "hostname" : "sysname", "time" : "utc", "level" : "error", "logFormat" : "SYS LOG ", "syslogType" : ["IPS","AV"], "binarylogType" : ["SESSION_LOG"], "enableSsl" : true } }, "processInstanceId" : "" } 返回状态码为202:请求正在处理中,请求处理详情请通过“查询业务编排结果”接口,确认是否处理成功。响应体参考SimpleResponse。 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 { "errcode" : "0", "errmsg" : "", "data" : { "id" : "00000000-0000-0000-0000-000000000000", "syslog" : { "enableHec" : true, "hecToken" : "00000000-0000-0000-0000-000000000000", "domainName" : "www.example.org", "address" : "10.136.108.65", "port" : 514, "hostname" : "sysname", "time" : "utc", "level" : "error", "logFormat" : "SYSLOG", "syslogType" : ["IPS","AV"], "binarylogType" : ["SESSION_LOG"], "enableSsl" : true } }, "processInstanceId" : "" } 返回状态码为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
  • 请求参数 表1 body参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 reqBody 是 REFERENCE 详细请参见表2。 设备日志服务器信息。 - 表2 SyslogWithId对象的参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 id 是 string - - 设备日志服务器ID。 "00000000-0000-0000-0000-000000000000" syslog 是 REFERENCE 详细请参见表2。 - -
  • 请求示例 HTTP的示例 PUT /controller/campus/v2/sdwansyslog/syslog 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 { "id" : "00000000-0000-0000-0000-000000000000", "syslog" : { "enableHec" : true, "hecToken" : "00000000-0000-0000-0000-000000000000", "domainName" : "www.example.org", "address" : "10.136.108.65", "port" : 514, "hostname" : "sysname", "time" : "utc", "level" : "error", "logFormat" : "SYSLOG", "syslogType" : ["IPS","AV"], "binarylogType" : ["SESSION_LOG"], "enableSsl" : true } }
  • 响应示例 返回状态码为200:配置成功,响应体参考SimpleResponse。 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" : "", "processInstanceId" : "" } 返回状态码为202:请求正在处理中,请求处理详情请通过“查询业务编排结果”接口,确认是否处理成功。响应体参考SimpleResponse。 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 返回状态码为207:部分失败,响应体参考BindSyslogRsp。 HTTP/1.1 207 Multi-Status 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 { "successList" : [ { "errmsg" : "", "siteId" : "00000000-0000-0000-0000-000000000000", "siteName" : "site1", "deviceId" : "00000000-0000-0000-0000-000000000000", "deviceName" : "device1", "linkId" : "00000000-0000-0000-0000-000000000000", "linkName" : "link1", "vpnId" : "00000000-0000-0000-0000-000000000000", "vpnName" : "vpn1", "sourceIp" : "192.168.0.1", "sourceInterface" : "loopback601" } ], "failList" : [ { "errmsg" : "", "siteId" : "00000000-0000-0000-0000-000000000000", "siteName" : "site1", "deviceId" : "00000000-0000-0000-0000-000000000000", "deviceName" : "device1", "linkId" : "00000000-0000-0000-0000-000000000000", "linkName" : "link1", "vpnId" : "00000000-0000-0000-0000-000000000000", "vpnName" : "vpn1", "sourceIp" : "192.168.0.1", "sourceInterface" : "loopback601" } ] } 返回状态码为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:配置成功,响应体参考SimpleResponse。 SimpleResponse对象的参数列表,详细请参见表3。 返回状态码为202:请求正在处理中,请求处理详情请通过“查询业务编排结果”接口,确认是否处理成功。响应体参考SimpleResponse。 返回状态码为207:部分失败,响应体参考BindSyslogRsp。 表6 BindSyslogRsp对象的参数列表 参数名称 类型 参数值域 默认值 参数说明 参数示例 successList ARRAY_REFERENCE 详细请参见表7。 成功列表。 - failList ARRAY_REFERENCE 详细请参见表7。 失败列表。 - 表7 SuccessFailData对象的参数列表 参数名称 类型 参数值域 默认值 参数说明 参数示例 errmsg string - - 失败原因,成功时则为空。 "" siteId string - - 站点ID。 "00000000-0000-0000-0000-000000000000" siteName string - - 站点名称。 "site1" deviceId string - - 设备ID。 "00000000-0000-0000-0000-000000000000" deviceName string - - 设备名称。 "device1" linkId string - - 链路ID。 "00000000-0000-0000-0000-000000000000" linkName string - - 链路名称。 "link1" vpnId string - - VPN ID。 "00000000-0000-0000-0000-000000000000" vpnName string - - VPN名称。 "vpn1" sourceIp string - - 设备日志源Ip。 "192.168.0.1" sourceInterface string - - 设备日志源接口。 "loopback601" 返回状态码为400:请求参数错误。 详细信息请参见实际响应消息体。 返回状态码为500:内部异常。 详细信息请参见实际响应消息体。
  • 请求示例 HTTP的示例 PUT /controller/campus/v2/sdwansyslog/syslog/00000000-0000-0000-0000-000000000000/site 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 { "bindSites" : [ { "siteId" : "00000000-0000-0000-0000-000000000000", "vpnId" : "00000000-0000-0000-0000-000000000000", "devices" : [ { "deviceId" : "00000000-0000-0000-0000-000000000000", "linkId" : "00000000-0000-0000-0000-000000000000", "sourceIp" : "192.168.0.1", "sourcePort" : 10245, "sourceInterface" : "601" } ] } ], "unbindSites" : [ "00000000-0000-0000-0000-000000000000" ] }
  • 响应示例 返回状态码为200:查询成功,响应体参考SyslogSitesRsp。 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" : "", "pageIndex" : 0, "pageSize" : 10, "totalRecords" : 100, "data" : [ { "siteId" : "00000000-0000-0000-0000-000000000000", "siteName" : "site1", "platform" : "pnf", "associatedType" : "overlay", "vpnId" : "00000000-0000-0000-0000-000000000000", "vpnName" : "vpn1", "SyslogDeviceInfo" : [ { "deviceId" : "00000000-0000-0000-0000-000000000000", "deviceName" : "device1", "configuredSourceIp" : "192.168.0.1", "configuredSourcePort" : "", "linkInfos" : [ { "linkId" : "00000000-0000-0000-0000-000000000000", "linkName" : "link1", "used" : true } ], "sourceInfos" : [ { "sourceIp" : "192.168.0.1", "sourceInterface" : "loopback601", "used" : true } ], "isConfigured" : true } ] } ] } 返回状态码为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
  • 请求示例 HTTP的示例 GET /controller/campus/v2/sdwansyslog/syslog/00000000-0000-0000-0000-000000000000/usedsite?pageIndex=1&pageSize=10&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:查询成功,响应体参考SyslogSitesRsp。 表3 SyslogSitesRsp对象的参数列表 参数名称 类型 参数值域 默认值 参数说明 参数示例 errcode string - - 错误码:0 表示接口执行成功,非0 表示接口执行失败。 "0" errmsg string - - 错误信息。 "" pageIndex int32 - - 当前页。 0 pageSize int32 - - 页大小。 10 totalRecords int32 - - 总数。 100 data ARRAY_REFERENCE 0-1000个列表项,详细请参见表4。 主体数据。 - 表4 SyslogSiteInfo对象的参数列表 参数名称 类型 参数值域 默认值 参数说明 参数示例 siteId string - - 站点ID。 "00000000-0000-0000-0000-000000000000" siteName string - - 站点名称。 "site1" platform string - - 站点下设备是否是V600系列版本的标识。pnf表示是V600系列版本的设备。 "pnf" associatedType string - - 关联方式,存在如下两种:overlay、underlay。 "overlay" vpnId string - - VPN ID。 "00000000-0000-0000-0000-000000000000" vpnName string - - VPN名称。 "vpn1" SyslogDeviceInfo ARRAY_REFERENCE 0-1000个列表项,详细请参见表5。 设备日志服务器关联设备点信息。 - 表5 SyslogDeviceInfo对象的参数列表 参数名称 类型 参数值域 默认值 参数说明 参数示例 deviceId string - - 设备ID。 "00000000-0000-0000-0000-000000000000" deviceName string - - 设备名称。 "device1" configuredSourceIp string - - 配置过的设备日志源Ip,用于记录V600系列版本的设备配置,或者二进制日志场景设备。 "192.168.0.1" configuredSourcePort integer [10240-55534] - 二进制日志场景设备日志源端口。 - linkInfos ARRAY_REFERENCE 0-100个列表项,详细请参见表6。 underlay关联时,该设备下所有链路信息。 - sourceInfos ARRAY_REFERENCE 0-100个列表项,详细请参见表7。 overlay关联时,该设备当前vpnId下所有loopback口信息。 - isConfigured boolean true false - 当前设备是否配置了设备日志服务器。true表示已配置,false表示未配置。 true 表6 LinkInfo对象的参数列表 参数名称 类型 参数值域 默认值 参数说明 参数示例 linkId string - - 链路ID。 "00000000-0000-0000-0000-000000000000" linkName string - - 链路名称。 "link1" used boolean true false - 该链路是否已经被使用,true为是,false为否。 true 表7 SourceInfo对象的参数列表 参数名称 类型 参数值域 默认值 参数说明 参数示例 sourceIp string - - loopback口的Ip。 "192.168.0.1" sourceInterface string - - loopback口的接口名。 "loopback601" used boolean true false - 该loopback口是否已经被使用,true为是,false为否。 true 返回状态码为400:请求参数错误。 详细信息请参见实际响应消息体。 返回状态码为500:内部异常。 详细信息请参见实际响应消息体。
  • URI /controller/campus/v2/sdwansyslog/syslog/{id}/usedsite 表1 path参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 id 是 string 0~36个字符。 - 设备日志服务器id。 "00000000-0000-0000-0000-000000000000" 表2 query参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 pageIndex 否 integer [1-10000] - 当前页。 pageIndex或pageSize不填写时表示全量查询。 1 pageSize 否 integer [1-1000] - 页大小。 pageIndex或pageSize不填写时表示全量查询。 10 siteName 否 string - - 站点名称。 支持模糊查询。 "site1"
  • 请求示例 HTTP的示例 POST /controller/campus/v2/sdwansyslog/syslog 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 { "enableHec" : true, "hecToken" : "00000000-0000-0000-0000-000000000000", "domainName" : "www.example.org", "address" : "10.136.108.65", "port" : 514, "hostname" : "sysname", "time" : "utc", "level" : "error", "logFormat" : "SYSLOG", "syslogType" : ["IPS","AV"], "binarylogType" : ["SESSION_LOG"], "enableSsl" : true }