云服务器内容精选

  • 响应示例 返回状态码为200:配置成功,响应体参考DeviceVTYResponse。 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" : { "siteId" : "00000000-0000-0000-0000-000000000000", "deviceId" : "00000000-0000-0000-0000-000000000000", "authenticationModel" : "aaa", "idleTimeOutMinutes" : "", "idleTimeOutSeconds" : "", "inboundACLNum" : 2100, "outboundACLNum" : 2100, "inboundACL6Num" : 2100, "outboundACL6Num" : 2100 } } 返回状态码为400:请求参数错误,响应体参考CommonResponse。 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 { "errCode" : "0", "errMsg" : "" } 返回状态码为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/v1/sdwan/vty/global 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 { "siteId" : "00000000-0000-0000-0000-000000000000", "deviceId" : "00000000-0000-0000-0000-000000000000", "authenticationModel" : "aaa", "idleTimeOutMinutes" : "", "idleTimeOutSeconds" : "", "inboundACLNum" : 2100, "outboundACLNum" : 2100, "inboundACL6Num" : 2100, "outboundACL6Num" : 2100 }
  • 响应参数 返回状态码为200:配置成功,响应体参考DeviceVTYResponse。 表3 DeviceVTYResponse对象的参数列表 参数名称 类型 参数值域 默认值 参数说明 参数示例 errCode string 0~10个字符。 - 错误码。 "0" errMsg string 0~255个字符。 - 错误描述。 "" data REFERENCE 详细请参见表4。 - - 表4 DeviceVTYInfo对象的参数列表 参数名称 类型 参数值域 默认值 参数说明 参数示例 siteId uuid - - 站点的ID。 "00000000-0000-0000-0000-000000000000" deviceId uuid - - 设备ID。 "00000000-0000-0000-0000-000000000000" authenticationModel string aaa password - 认证模式,取值范围:aaa、password。 当前仅支持aaa认证模式。 "aaa" idleTimeOutMinutes int32 [0-35791] 5 登录会话超时时间,单位是分钟,超时时间是XX分钟XX秒。默认值为5。 - idleTimeOutSeconds int32 [0-59] 0 登录会话超时时间,单位是秒。默认值为0。 - inboundACLNum int32 [2000-2999] - 控制能登录进来的ACL编号。可以通过第三方开放接口/controller/campus/v1/sdwan/vty/acl得到。 2100 outboundACLNum int32 [2000-2999] - 控制从一个设备登录到另一个设备的ACL编号。可以通过第三方开放接口/controller/campus/v1/sdwan/vty/acl得到。 2100 inboundACL6Num int32 [2000-2999] - 对于IPv6的地址,控制能登录进来的ACL编号。可以通过第三方开放接口/controller/campus/v1/sdwan/vty/acl得到。 2100 outboundACL6Num int32 [2000-2999] - 对于IPv6的地址,控制从一个设备登录到另一个设备的ACL编号。可以通过第三方开放接口/controller/campus/v1/sdwan/vty/acl得到。 2100 返回状态码为400:请求参数错误,响应体参考CommonResponse。 表5 CommonResponse对象的参数列表 参数名称 类型 参数值域 默认值 参数说明 参数示例 errCode string 0~10个字符。 - 错误码。 "0" errMsg string 0~255个字符。 - 错误描述。 "" 返回状态码为500:内部异常。 详细信息请参见实际响应消息体。
  • 请求参数 表1 body参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 deviceVTY 是 REFERENCE 详细请参见表2。 设备VTY信息。 - 表2 DeviceVTYInfo对象的参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 siteId 是 uuid - - 站点的ID。 "00000000-0000-0000-0000-000000000000" deviceId 是 uuid - - 设备ID。 "00000000-0000-0000-0000-000000000000" authenticationModel 是 string aaa password - 认证模式,取值范围:aaa、password。 当前仅支持aaa认证模式。 "aaa" idleTimeOutMinutes 否 int32 [0-35791] 5 登录会话超时时间,单位是分钟,超时时间是XX分钟XX秒。默认值为5。 - idleTimeOutSeconds 否 int32 [0-59] 0 登录会话超时时间,单位是秒。默认值为0。 - inboundACLNum 否 int32 [2000-2999] - 控制能登录进来的ACL编号。可以通过第三方开放接口/controller/campus/v1/sdwan/vty/acl得到。 2100 outboundACLNum 否 int32 [2000-2999] - 控制从一个设备登录到另一个设备的ACL编号。可以通过第三方开放接口/controller/campus/v1/sdwan/vty/acl得到。 2100 inboundACL6Num 否 int32 [2000-2999] - 对于IPv6的地址,控制能登录进来的ACL编号。可以通过第三方开放接口/controller/campus/v1/sdwan/vty/acl得到。 2100 outboundACL6Num 否 int32 [2000-2999] - 对于IPv6的地址,控制从一个设备登录到另一个设备的ACL编号。可以通过第三方开放接口/controller/campus/v1/sdwan/vty/acl得到。 2100
  • 响应参数 返回状态码为200:查询成功,响应体参考QueryVtyACLPolicyResponse。 表2 QueryVtyACLPolicyResponse对象的参数列表 参数名称 类型 参数值域 默认值 参数说明 参数示例 data ARRAY_REFERENCE 0-2000个列表项,详细请参见表5。 - - pageIndex int32 [1-10000] - 当前页。 1 pageSize int32 [1-10000] - 页大小。 10 totalRecords int32 [1-100000] - 总记录数。 100 返回状态码为400:请求参数错误。 详细信息请参见实际响应消息体。 返回状态码为500:内部异常。 详细信息请参见实际响应消息体。
  • 响应示例 返回状态码为200:查询成功,响应体参考QueryVtyACLPolicyResponse。 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 { "data" : [ { "siteId" : "00000000-0000-0000-0000-000000000000", "deviceId" : "00000000-0000-0000-0000-000000000000", "aclNum" : 2100, "type" : "IPv4", "ruleList" : [ { "ruleId" : 10, "operateType" : 1, "ipRange" : "192.168.1.1/16" } ] } ], "pageIndex" : 1, "pageSize" : 10, "totalRecords" : 100 } 返回状态码为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
  • URI /controller/campus/v1/sdwan/vty/acl 表1 query参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 pageIndex 否 int32 [1-10000] 1 起始页。默认值为1。 1 pageSize 否 int32 [1-1000] 10 页行记录数。默认值为10。 10 siteId 否 uuid - - 站点ID。 "00000000-0000-0000-0000-000000000000" deviceId 否 uuid - - 设备ID。 "00000000-0000-0000-0000-000000000000" aclNum 否 int32 [2000-2999] - VTY ACL的acl编号。 2100
  • 请求示例 HTTP的示例 GET /controller/campus/v1/sdwan/vty/acl?pageIndex=1&pageSize=10&siteId=00000000-0000-0000-0000-000000000000&deviceId=00000000-0000-0000-0000-000000000000&aclNum=2100 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
  • 请求示例 HTTP的示例 PUT /controller/campus/v1/sdwan/vty/acl 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", "aclNum" : 2100, "type" : "IPv4", "ruleList" : [ { "ruleId" : 10, "operateType" : 1, "ipRange" : "192.168.1.1/16" } ] }
  • 响应示例 返回状态码为200:修改成功,响应体参考CommonRestResponse。 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" : { "siteId" : "00000000-0000-0000-0000-000000000000", "deviceId" : "00000000-0000-0000-0000-000000000000", "aclNum" : 2100, "type" : "IPv4", "ruleList" : [ { "ruleId" : 10, "operateType" : 1, "ipRange" : "192.168.1.1/16" } ] } } 返回状态码为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:删除成功,响应体参考DeleteACLRepsonse。 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" : "" } 返回状态码为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:删除成功,响应体参考DeleteACLRepsonse。 表2 DeleteACLRepsonse对象的参数列表 参数名称 类型 参数值域 默认值 参数说明 参数示例 errCode string 0~10个字符。 - 错误码。 "0" errMsg string 0~255个字符。 - 错误描述。 "" 返回状态码为400:请求参数错误。 详细信息请参见实际响应消息体。 返回状态码为500:内部异常。 详细信息请参见实际响应消息体。
  • URI /controller/campus/v1/sdwan/vty/acl 表1 query参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 siteId 是 uuid - - 站点ID。 "00000000-0000-0000-0000-000000000000" deviceId 是 uuid - - 设备ID。 "00000000-0000-0000-0000-000000000000" aclNum 是 string [2000-2999] - VTY ACL的acl编号。 "2100" type 否 string - IPv4 VTY ACL类型,该字段可以设置为以下几种: a) IPv4 b) IPv6 默认为IPv4。 "IPv4"
  • 请求示例 HTTP的示例 DELETE /controller/campus/v1/sdwan/vty/acl?siteId=00000000-0000-0000-0000-000000000000&deviceId=00000000-0000-0000-0000-000000000000&aclNum=2100&type=IPv4 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
  • 响应参数 返回状态码为201:创建成功,响应体参考CommonRestResponse。 表4 CommonRestResponse对象的参数列表 参数名称 类型 参数值域 默认值 参数说明 参数示例 errCode string 0~10个字符。 - 错误码。 "0" errMsg string 0~255个字符。 - 错误描述。 "" data REFERENCE 详细请参见表5。 - - 表5 VtyACLPolicyInfo对象的参数列表 参数名称 类型 参数值域 默认值 参数说明 参数示例 siteId uuid 1~64个字符。 - 站点ID。 "00000000-0000-0000-0000-000000000000" deviceId uuid 1~64个字符。 - 设备ID。 "00000000-0000-0000-0000-000000000000" aclNum int32 [2000-2999] - ACL编号,同一设备的IPv4和IPv6的ACL编号不能相同。 2100 type string 0~8个字符。 IPv4 VTY ACL类型,该字段可以设置为以下几种: a) IPv4 b) IPv6 默认为IPv4。 "IPv4" ruleList ARRAY_REFERENCE 1-100个列表项,详细请参见表6。 ACL规则列表。配置ACL必须配置规则。 - 表6 ACLRule对象的参数列表 参数名称 类型 参数值域 默认值 参数说明 参数示例 ruleId int64 [0-4294967294] - VTY ACL规则优先级。 10 operateType int32 - 1 操作类型,取值范围:1---允许、2---拒绝。默认值为1。 1 ipRange string - - IP地址范围,支持IPv4和IPv6,格式:IP地址/掩码或Any。其中IPv4的掩码范围为0-32,IPv6的掩码范围为1-128。若需要配置全地址(即IPv4掩码为0、IPv6前缀为0),可以输入“Any”(不区分大小写)。 IPv4地址如:192.168.1.1/16; IPv6地址如:fc22::1010/64。 "192.168.1.1/16" 返回状态码为400:请求参数错误。 详细信息请参见实际响应消息体。 返回状态码为500:内部异常。 详细信息请参见实际响应消息体。