云服务器内容精选

  • 响应示例 返回状态码为200:查询成功,响应体参考PingReplyResponse。 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 { "errorCode" : 0, "errorMsg" : "", "data" : [ { "id" : "00000000-0000-0000-0000-000000000000", "testName" : "task", "totalCount" : 5, "successCount" : 5, "lossRate" : 50, "rttAvg" : 50, "status" : 1, "startTime" : "2018-03-26 20:01:36", "replys" : [ { "sequence" : 1, "dataByte" : 56, "ttlOrHoplimit" : 10, "rtt" : 50, "result" : 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:查询成功,响应体参考PingReplyResponse。 表2 PingReplyResponse对象的参数列表 参数名称 类型 参数值域 默认值 参数说明 参数示例 errorCode int32 - - 错误码。 0 errorMsg string - - 错误信息。 "" data ARRAY_REFERENCE 0-2147483647个列表项,详细请参见表3。 - - 表3 PingReplyListOutput对象的参数列表 参数名称 类型 参数值域 默认值 参数说明 参数示例 id string - - 任务ID。 "00000000-0000-0000-0000-000000000000" testName string - - 任务名称。 "task" totalCount Int2 - - Reply包数量。 5 successCount Int2 - - 成功响应Reply包数量。 5 lossRate Int4 - - 丢包率(%)。 50 rttAvg Int8 - - 平均响应时间(ms)。 50 status Int2 - - 任务状态。0表示成功,1表示进行中,2表示超时,3表示失败。 1 startTime string - - 测试开始时间。 "2018-03-26 20:01:36" replys ARRAY_REFERENCE 0-2147483647个列表项,详细请参见表4。 - - 表4 PingReplyOutput对象的参数列表 参数名称 类型 参数值域 默认值 参数说明 参数示例 sequence Int2 - - 任务中Reply包序号。 1 dataByte Int4 - - Reply包大小。 56 ttlOrHoplimit Int4 - - Reply包TTL。 10 rtt Int8 - - Reply包平均响应时间(ms)。 50 result Int2 - - Reply包响应结果。0表示成功,1表示超时,3表示失败。 0 返回状态码为400:请求参数错误。 详细信息请参见实际响应消息体。 返回状态码为500:内部异常。 详细信息请参见实际响应消息体。
  • 请求示例 HTTP的示例 GET /controller/campus/v2/sdwan/diagnose/ping/reply/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-AC CES S-TOKEN: x-yyyyyy
  • 响应示例 返回状态码为200:查询成功,响应体参考PingTaskResponse。 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 { "errorCode" : 0, "errorMsg" : "", "data" : [ { "taskId" : "00000000-0000-0000-0000-000000000000", "taskName" : "task", "siteId" : "00000000-0000-0000-0000-000000000000", "siteName" : "site", "deviceId" : "00000000-0000-0000-0000-000000000000", "deviceName" : "device", "networkType" : 0, "linkId" : "00000000-0000-0000-0000-000000000000", "linkName" : "link", "virtualNetworkId" : "00000000-0000-0000-0000-000000000000", "virtualNetworkName" : "vpn1", "vpnName" : "vpn", "ipType" : "IPv4", "sourceIp" : "192.168.1.1", "target" : "192.168.1.1", "packetSize" : 100, "parketNumber" : 10, "status" : 1, "packetLossRate" : 20, "avgDelay" : 20 } ] } 返回状态码为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/sdwan/diagnose/ping/task/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:查询成功,响应体参考PingTaskResponse。 表2 PingTaskResponse对象的参数列表 参数名称 类型 参数值域 默认值 参数说明 参数示例 errorCode int32 - - 错误码。 0 errorMsg string - - 错误信息。 "" data ARRAY_REFERENCE 0-2147483647个列表项,详细请参见表3。 - - 表3 PingTaskInfoOutput对象的参数列表 参数名称 类型 参数值域 默认值 参数说明 参数示例 taskId string - - 任务ID,创建ping任务时自动生成。 "00000000-0000-0000-0000-000000000000" taskName string - - 任务名称。 "task" siteId string - - 站点ID,UUID格式。 "00000000-0000-0000-0000-000000000000" siteName string - - 站点名称。 "site" deviceId string - - 设备ID,UUID格式。 "00000000-0000-0000-0000-000000000000" deviceName string - - 设备名称。 "device" networkType Int2 - 0 网络类型:0 表示物理网络,1 表示虚拟网络。默认值0(物理网络)。 0 linkId string - - 链路ID。 "00000000-0000-0000-0000-000000000000" linkName string - - 链路名称。 "link" virtualNetworkId string - - 虚拟网络ID。 "00000000-0000-0000-0000-000000000000" virtualNetworkName string - - 虚拟网络实例名称。 "vpn1" vpnName string - - 虚拟网络名称。 "vpn" ipType string - - IP类型,值为IPv4或者IPv6。 "IPv4" sourceIp string - - 源IP。 "192.168.1.1" target string - - 目的IP。 "192.168.1.1" packetSize Int4 - 56 包大小。默认值56。 100 parketNumber Int2 - 5 请求包个数。默认值5。 10 status Int2 - - 任务状态。0表示成功,1表示进行中,2表示超时。 1 packetLossRate int4 - - 丢包率(%)。 20 avgDelay int8 - - 平均时延(ms)。 20 返回状态码为400:请求参数错误。 详细信息请参见实际响应消息体。 返回状态码为500:内部异常。 详细信息请参见实际响应消息体。
  • 响应示例 返回状态码为200:创建成功,响应体参考PingConfigResponse。 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 { "errorCode" : 0, "errorMsg" : "", "data" : [ { "id" : "00000000-0000-0000-0000-000000000000", "taskName" : "task", "siteId" : "00000000-0000-0000-0000-000000000000", "deviceId" : "00000000-0000-0000-0000-000000000000", "networkType" : 0, "linkId" : "00000000-0000-0000-0000-000000000000", "virtualNetworkId" : "00000000-0000-0000-0000-000000000000", "ipType" : "IPv4", "sourceIp" : "192.168.1.1", "destination" : "192.168.1.1", "packetSize" : 100, "count" : 10, "status" : 1, "createTime" : "2019-02-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:创建成功,响应体参考PingConfigResponse。 表3 PingConfigResponse对象的参数列表 参数名称 类型 参数值域 默认值 参数说明 参数示例 errorCode int32 - - 错误码。 0 errorMsg string - - 错误信息。 "" data ARRAY_REFERENCE 0-2147483647个列表项,详细请参见表4。 - - 表4 PingTask对象的参数列表 参数名称 类型 参数值域 默认值 参数说明 参数示例 id string - - 任务ID。 "00000000-0000-0000-0000-000000000000" taskName string - - 任务名称。 "task" siteId string - - 站点ID。 "00000000-0000-0000-0000-000000000000" deviceId string - - 设备ID。 "00000000-0000-0000-0000-000000000000" networkType Int2 - 0 网络类型:0 表示物理网络,1 表示虚拟网络。默认值为0(物理网络)。 0 linkId string - - 链路ID。 "00000000-0000-0000-0000-000000000000" virtualNetworkId string - - 虚拟网络ID。 "00000000-0000-0000-0000-000000000000" ipType string - - IP类型,值为IPv4或者IPv6。 "IPv4" sourceIp string - - 源IP。 "192.168.1.1" destination string - - 目的IP。 "192.168.1.1" packetSize Int4 - 56 包大小。默认值为56。 100 count Int2 - 5 请求包个数。默认值为5。 10 status Int2 - 0 Ping任务状态。0表示成功,1表示进行中,2表示超时。默认值为0(成功)。 1 createTime string - - Ping任务创建时间。 "2019-02-16" 返回状态码为400:请求参数错误。 详细信息请参见实际响应消息体。 返回状态码为500:内部异常。 详细信息请参见实际响应消息体。
  • 请求示例 HTTP的示例 POST /controller/campus/v2/sdwan/diagnose/ping 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", "subDeviceId" : "00000000-0000-0000-0000-000000000000", "networkType" : 1, "linkId" : "00000000-0000-0000-0000-000000000000", "tenantId" : "00000000-0000-0000-0000-000000000000", "virtualNetworkId" : "00000000-0000-0000-0000-000000000000", "ipType" : "IPv4", "sourceIp" : "192.168.1.1", "destination" : "192.168.1.1", "count" : 10, "packetSize" : 100, "teClass" : 100, "vpnInstanceName" : "" }
  • 请求参数 表1 body参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 body 是 REFERENCE 详细请参见表2。 Ping任务信息。 - 表2 PingConfigRequest对象的参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 siteId 是 string 36个字符。 - 站点Id,UUID格式。 "00000000-0000-0000-0000-000000000000" deviceId 是 string 36个字符。 - 设备Id,UUID格式。 "00000000-0000-0000-0000-000000000000" subDeviceId 否 string 36个字符。 - 子设备Id,UUID格式,仅6700V系列设备支持。 "00000000-0000-0000-0000-000000000000" networkType 是 int32 1个字符。 - 网络类型。 对非AR6700V设备,0 表示物理网络,1 表示虚拟网络;对AR6700V设备,仅0为合法值。 1 linkId 否 string 36个字符。 - 链路Id,用于ping物理网络。 SRv6隧道模式下,该字段无效。 "00000000-0000-0000-0000-000000000000" tenantId 否 string - - IWG场景类型为虚拟网络,MSP下的租户ID;networkType配置为虚拟网络,此字段必填。 "00000000-0000-0000-0000-000000000000" virtualNetworkId 否 string 36个字符。 - 虚拟网络Id,用于ping虚拟网络。 "00000000-0000-0000-0000-000000000000" ipType 否 string 0~10个字符。 - IP类型,值为IPv4或者IPv6。 "IPv4" sourceIp 否 string 0~255个字符。 - 源IP。 "192.168.1.1" destination 是 string 1~255个字符。 - 目的IP。 "192.168.1.1" count 否 int32 [1-64] 5 Ping包个数。默认值5。 10 packetSize 否 int32 [20-9600] 56 包大小。默认值56。 100 teClass 否 int32 [1-65535] - Te class,该字段仅支持SRv6隧道模式下使用。 100 vpnInstanceName 否 string 0~31个字符。 - 虚拟网络名称,预留字段,暂不支持。 -