接口功能介绍
IPsec 连接限速修改
接口约束
支持集群模式资源池。
URI
POST /v4/vpn/ipsec-qos-limit/update
路径参数
无
Query参数
无
请求参数
请求header参数
无
请求body参数
| 参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|---|
| regionID | 是 | String | 资源池ID | 81f7728662dd11ec810800155d307d5b | |
| limitType | 是 | String | 限速类型，取值范围: cidr:子网类型, ipsec:ipsec连接型, 不能修改之前的限速类型 | ipsec | |
| value | 否 | Integer | IPSec类型限速值,当limitType为ipsec必填，否则不填,范围不超过购买带宽上限 | 2 | |
| unit | 否 | String | IPSec限速单位，取值范围: Mbps:Mbps, Kbps:Kbps, 当limitType为ipsec必填，否则不填 | Mbps | |
| vpnConnectionID | 是 | String | 连接ID | 725b7f5a-d25d-11ef-a030-525400bf5caf | |
| ruleList | 否 | Array | cidr限速规则, 当limitType为cidr必填，否则不填 | ruleList | |
| qosID | 是 | String | 限速qos id | 60433908-ef30-11ef-bcf0-525400bf5caf |
表ruleList
| 参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|---|
| srcCidr | 是 | String | 本端网络 | 12.3.4.0/24 | |
| dstCidr | 是 | String | 对端网络 | 11.5.6.0/24 | |
| value | 是 | Integer | 限速值 | 1 | |
| unit | 是 | String | 限速单位，取值范围: Mbps:Mbps, Kbps:Kbps, | Mbps |
响应参数
| 参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|---|
| statusCode | 否 | integer | 返回状态码 取值范围: 800：成功 900：失败 | 800 | |
| errorCode | 否 | string | 业务细分码，为product.module.code三段式码 | ||
| message | 否 | string | 失败时的错误描述，一般为英文描述 | ||
| description | 否 | string | 失败时的错误描述，一般为中文描述 | ||
| returnObj | 否 | object | 返回参数 | returnObj |
表returnObj
| 参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|---|
| logMark | 否 | string | 链路追踪ID | 124368318645 |
请求示例
请求url
无
请求头header
无
请求体body
params = {
"regionID": "81f7728662dd11ec810800155d307d5b",
"limitType": "ipsec",
"value": 2,
"unit": "Mbps",
"vpnConnectionID": "725b7f5a-d25d-11ef-a030-525400bf5caf",
"qosID":"60433908-ef30-11ef-bcf0-525400bf5caf",
}响应示例
{
"statusCode": 800,
"returnObj": {
"logMark": "124368318645"
}
}状态码
| 状态码 | 含义 |
|---|---|
| 200 | 请求成功 |
错误码
| errorCode | 含义 |
|---|---|
| QosLimit.PatternCheck.NotValid | 请求参数无效 |
