云服务器内容精选

  • 响应示例 返回状态码为200:应用策略成功,响应体参考ApplyPolicyResponse。 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" : "", "errparam" : "name", "processInstanceId" : "00000000-0000-0000-0000-000000000000" } 返回状态码为202:请求正在处理中,请求处理详情请通过“查询业务编排结果”接口,确认是否处理成功。响应体参考ApplyPolicyResponse。 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
  • 请求示例 HTTP的示例 POST /controller/campus/v1/sdwan/policy/traffic/bandwidth-management-policies/apply-policy 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 { "policyId" : "00000000-0000-0000-0000-000000000000", "sites" : [ { "siteId" : "00000000-0000-0000-0000-000000000000", "siteName" : "Site1" } ] }
  • 请求参数 表1 body参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 bandwidthMgrApplyPolicyInfo 是 REFERENCE 详细请参见表2。 应用FW带宽管理策略参数。 - 表2 BandwidthMgrApplyPolicyInfo对象的参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 policyId 否 string 0~64个字符。 - 策略id。 "00000000-0000-0000-0000-000000000000" sites 否 ARRAY_REFERENCE 0-2000个列表项,详细请参见表3。 策略应用的站点信息。 - 表3 Site对象的参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 siteId 否 string 0~64个字符。 - 站点id "00000000-0000-0000-0000-000000000000" siteName 否 string 0~64个字符。 - 站点名称。 "Site1"
  • 响应参数 返回状态码为200:应用策略成功,响应体参考ApplyPolicyResponse。 表4 ApplyPolicyResponse对象的参数列表 参数名称 类型 参数值域 默认值 参数说明 参数示例 errcode string - - 错误码。 "0" errmsg string - - 错误信息。 "" errparam string - - 错误参数。 "name" processInstanceId string - - 编排流程实例ID,UUID格式。当接口返回码为202时非空。 "00000000-0000-0000-0000-000000000000" 返回状态码为202:请求正在处理中,请求处理详情请通过“查询业务编排结果”接口,确认是否处理成功。响应体参考ApplyPolicyResponse。 返回状态码为400:请求参数错误。 详细信息请参见实际响应消息体。 返回状态码为500:内部错误。 详细信息请参见实际响应消息体。
  • 请求示例 HTTP的示例 PUT /controller/campus/v1/sdwan/policy/traffic/bandwidth-management-policies 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 { "bandwidthMgrPolicies" : [ { "id" : "00000000-0000-0000-0000-000000000000", "name" : "bandwidth1", "vpnId" : "00000000-0000-0000-0000-000000000000", "vpnGroupId" : "00000000-0000-0000-0000-000000000000", "bandwidthMgrRule" : { "priority" : 1, "classificationId" : "00000000-0000-0000-0000-000000000000", "classificationName" : "classificationName", "profileId" : "00000000-0000-0000-0000-000000000000", "profileName" : "templateName", "effectiveTimeId" : "00000000-0000-0000-0000-000000000000", "effectiveTimeName" : "effectiveTimeName" }, "status" : 1 } ] }
  • 响应示例 返回状态码为200:修改成功,响应体参考BandwidthMgrPolicyResponse。 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" : [ { "id" : "00000000-0000-0000-0000-000000000000", "name" : "bandwidth1", "vpnId" : "00000000-0000-0000-0000-000000000000", "vpnGroupId" : "00000000-0000-0000-0000-000000000000", "bandwidthMgrRule" : { "priority" : 1, "classificationId" : "00000000-0000-0000-0000-000000000000", "classificationName" : "classificationName", "profileId" : "00000000-0000-0000-0000-000000000000", "profileName" : "templateName", "effectiveTimeId" : "00000000-0000-0000-0000-000000000000", "effectiveTimeName" : "effectiveTimeName" }, "status" : 1 } ], "fail" : [ { "errcode" : "0", "errmsg" : "", "data" : { "id" : "00000000-0000-0000-0000-000000000000", "name" : "bandwidth1", "vpnId" : "00000000-0000-0000-0000-000000000000", "vpnGroupId" : "00000000-0000-0000-0000-000000000000", "bandwidthMgrRule" : { "priority" : 1, "classificationId" : "00000000-0000-0000-0000-000000000000", "classificationName" : "classificationName", "profileId" : "00000000-0000-0000-0000-000000000000", "profileName" : "templateName", "effectiveTimeId" : "00000000-0000-0000-0000-000000000000", "effectiveTimeName" : "effectiveTimeName" }, "status" : 1 } } ] } 返回状态码为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/v1/sdwan/policy/traffic/bandwidth-management-policies?sort=policyName&policyId=00000000-0000-0000-0000-00000000000&vpnId=00000000-0000-0000-0000-000000000000&vpnGroupId=00000000-0000-0000-0000-000000000000&policyName=policy&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:查询成功,响应体参考QueryBandwidthMgrPolicyResponse。 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" : "", "totalRecords" : 1, "pageSize" : 10, "pageIndex" : 1, "data" : [ { "id" : "00000000-0000-0000-0000-000000000000", "name" : "bandwidth1", "vpnId" : "00000000-0000-0000-0000-000000000000", "vpnGroupId" : "00000000-0000-0000-0000-000000000000", "bandwidthMgrRule" : { "priority" : 1, "classificationId" : "00000000-0000-0000-0000-000000000000", "classificationName" : "classificationName", "profileId" : "00000000-0000-0000-0000-000000000000", "profileName" : "templateName", "effectiveTimeId" : "00000000-0000-0000-0000-000000000000", "effectiveTimeName" : "effectiveTimeName" }, "status" : 1 } ] } 返回状态码为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/policy/traffic/bandwidth-management-policies 表1 query参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 pageIndex 否 int32 [1-65535] 1 当前页数。 - pageSize 否 int32 [1-1000] 20 总页数,默认是20。 - sort 否 string 0~255个字符。 - 排序字段。 当前仅支持按policyName排序,"policyName"表示升序,"-policyName"表示降序,默认升序。 "policyName" policyId 否 string 0~64个字符。 - 策略ID。 "00000000-0000-0000-0000-00000000000" vpnId 否 string 0~64个字符。 - VPN业务ID。vpnId和vpnGroupId最多只能配置其中一个进行查询。 "00000000-0000-0000-0000-000000000000" vpnGroupId 否 string 0~64个字符。 - Qos VPN Group业务ID。vpnId和vpnGroupId最多只能配置其中一个进行查询。 "00000000-0000-0000-0000-000000000000" policyName 否 string 0~64个字符。 - 策略名称,支持模糊匹配。 "policy" siteId 否 string 0~64个字符。 - 站点ID。 "00000000-0000-0000-0000-000000000000"
  • 响应参数 返回状态码为200:查询成功,响应体参考QueryBandwidthMgrPolicyResponse。 表2 QueryBandwidthMgrPolicyResponse对象的参数列表 参数名称 类型 参数值域 默认值 参数说明 参数示例 errcode string - - 错误码。 "0" errmsg string - - 错误信息。 "" totalRecords int32 - - 总的数据条数。 1 pageSize int32 - - 每页显示数量。 10 pageIndex int32 - - 当前页数。 1 data ARRAY_REFERENCE 0-1000个列表项,详细请参见表6。 带宽管理策略信息。 - 返回状态码为400:请求参数错误。 详细信息请参见实际响应消息体。 返回状态码为500:内部错误。 详细信息请参见实际响应消息体。
  • 请求示例 HTTP的示例 POST /controller/campus/v1/sdwan/policy/traffic/bandwidth-management-policies/action/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 { "bandwidthMgrPolicies" : [ { "id" : "00000000-0000-0000-0000-000000000000", "name" : "bandwidth1", "vpnId" : "00000000-0000-0000-0000-000000000000", "vpnGroupId" : "00000000-0000-0000-0000-000000000000", "bandwidthMgrRule" : { "priority" : 1, "classificationId" : "00000000-0000-0000-0000-000000000000", "classificationName" : "classificationName", "profileId" : "00000000-0000-0000-0000-000000000000", "profileName" : "templateName", "effectiveTimeId" : "00000000-0000-0000-0000-000000000000", "effectiveTimeName" : "effectiveTimeName" }, "status" : 1 } ] }
  • 响应示例 返回状态码为200:删除成功,响应体参考BandwidthMgrPolicyResponse。 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" : [ { "id" : "00000000-0000-0000-0000-000000000000", "name" : "bandwidth1", "vpnId" : "00000000-0000-0000-0000-000000000000", "vpnGroupId" : "00000000-0000-0000-0000-000000000000", "bandwidthMgrRule" : { "priority" : 1, "classificationId" : "00000000-0000-0000-0000-000000000000", "classificationName" : "classificationName", "profileId" : "00000000-0000-0000-0000-000000000000", "profileName" : "templateName", "effectiveTimeId" : "00000000-0000-0000-0000-000000000000", "effectiveTimeName" : "effectiveTimeName" }, "status" : 1 } ], "fail" : [ { "errcode" : "0", "errmsg" : "", "data" : { "id" : "00000000-0000-0000-0000-000000000000", "name" : "bandwidth1", "vpnId" : "00000000-0000-0000-0000-000000000000", "vpnGroupId" : "00000000-0000-0000-0000-000000000000", "bandwidthMgrRule" : { "priority" : 1, "classificationId" : "00000000-0000-0000-0000-000000000000", "classificationName" : "classificationName", "profileId" : "00000000-0000-0000-0000-000000000000", "profileName" : "templateName", "effectiveTimeId" : "00000000-0000-0000-0000-000000000000", "effectiveTimeName" : "effectiveTimeName" }, "status" : 1 } } ] } 返回状态码为204:执行成功,没有数据。 HTTP/1.1 204 No Content 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