QoS策略

列举QoS policy

功能介绍

‎列举QoS策略。

URI

GET /v2.0/qos/policies

请求消息

无

响应消息

参数	参数类型	描述
policies	array	policy对象列表。
description	string	描述。
tenant_id	string	租户id。
project_id	string	租户id。
revision_number	integer	版本号。
shared	boolean	是否租户项目间共享。
id	string	QoS策略id。
is_default	boolean	是否是默认策略。
rules	array	QoS策略规则列表。
name	string	名字。
created_at	string	创建时间。
updated_at	string	上一次更新时间。

请求示例

GET http://{endpoint}/v2.0/qos/policies

正常响应示例

{
   "policies":[
      {
         "name":"096c7e01-28ab-46e5-9427-1444f6f67a12",
         "rules":[
            {
               "max_kbps":1024,
               "type":"bandwidth_limit",
               "id":"feaba4ba-c002-455c-810c-ffdaddac9c6a",
               "max_burst_kbps":819,
               "qos_policy_id":"c15ce4a2-787e-4225-82f7-5ba538f0715e"
            }
         ],
         "tenant_id":"2caf92e24f284a76be9cb54577ecebed",
         "created_at":"2021-02-25T06:04:43Z",
         "updated_at":"2021-02-25T06:04:43Z",
         "revision_number":2,
         "shared":false,
         "project_id":"2caf92e24f284a76be9cb54577ecebed",
         "id":"c15ce4a2-787e-4225-82f7-5ba538f0715e",
         "description":""
      },
      {
         "name":"096c7e01-28ab-46e5-9427-1444f6f67a12",
         "rules":[
            {
               "max_kbps":2048,
               "type":"bandwidth_limit",
               "id":"04cf4639-ffe8-42f3-bf79-42d22cccfcf2",
               "max_burst_kbps":1638,
               "qos_policy_id":"ffc9b0cd-f4db-4db3-ac82-9be3401e3a53"
            }
         ],
         "tenant_id":"2caf92e24f284a76be9cb54577ecebed",
         "created_at":"2021-02-25T06:27:57Z",
         "updated_at":"2021-02-25T06:27:57Z",
         "revision_number":2,
         "shared":false,
         "project_id":"2caf92e24f284a76be9cb54577ecebed",
         "id":"ffc9b0cd-f4db-4db3-ac82-9be3401e3a53",
         "description":""
      }
   ]
}

正常响应代码

200

错误码

401

创建QoS policy

功能介绍

‎创建QoS策略。

URI

POST /v2.0/qos/policies

请求消息

参数	参数类型	是否必选	Description
policy	是	object	QoS策略对象。
policy:name	是	string	QoS策略名字。
policy:shared	否	bool	是否共享。

响应消息

参数	参数类型	描述
policy	object	policy对象。
description	string	描述。
tenant_id	string	租户id。
project_id	string	租户id。
revision_number	integer	版本号。
shared	boolean	是否租户项目间共享。
id	string	QoS策略id。
rules	array	QoS策略规则列表。
name	string	名字。
created_at	string	创建时间。
updated_at	string	上一次更新时间。
is_default	boolean	是否是默认策略。

请求示例

POST http://{endpoint}/v2.0/qos/policies

{
    "policy":{
        "name":"test_qos"
    }
}

正常响应示例

{
   "policy":{
      "name":"test_qos",
      "rules":[
         
      ],
      "tenant_id":"cf8d21b7fc084813a0481fb9bf331357",
      "created_at":"2021-02-25T07:06:23Z",
      "updated_at":"2021-02-25T07:06:23Z",
      "revision_number":1,
      "shared":false,
      "project_id":"cf8d21b7fc084813a0481fb9bf331357",
      "id":"05e0ab13-0e6e-40d2-a04d-b5ead44d2653",
      "is_default": false, 
      "description":""
   }
}

正常响应代码

201

错误码

401，403，404，409

显示QoS policy详情

功能介绍

‎显示QoS策略详情。

URI

GET /v2.0/qos/policies/{policy_id}

参数	参数类型	是否必选	Description
policy_id	string	是	QoS策略的ID。

请求消息

无

响应消息

参数	参数类型	描述
policy	object	policy对象。
description	string	描述。
tenant_id	string	租户id。
project_id	string	租户id。
revision_number	integer	版本。
shared	boolean	是否租户项目间共享。
id	string	QoS策略id。
rules	array	QoS策略规则列表。
name	string	名字。
created_at	string	创建时间。
updated_at	string	上一次更新时间。
is_default	boolean	是否是默认策略。

请求示例

GET http://{endpoint}/v2.0/qos/policies/ffc9b0cd-f4db-4db3-ac82-9be3401e3a53

正常响应示例

{
   "policy":{
      "name":"096c7e01-28ab-46e5-9427-1444f6f67a12",
      "rules":[
         {
            "max_kbps":2048,
            "type":"bandwidth_limit",
            "id":"04cf4639-ffe8-42f3-bf79-42d22cccfcf2",
            "max_burst_kbps":1638,
            "qos_policy_id":"ffc9b0cd-f4db-4db3-ac82-9be3401e3a53"
         }
      ],
      "tenant_id":"2caf92e24f284a76be9cb54577ecebed",
      "created_at":"2021-02-25T06:27:57Z",
      "updated_at":"2021-02-25T06:27:57Z",
      "revision_number":2,
      "shared":false,
      "project_id":"2caf92e24f284a76be9cb54577ecebed",
      "id":"ffc9b0cd-f4db-4db3-ac82-9be3401e3a53",
      "is_default": false,
      "description":""
   }
}

正常响应代码

200

错误码

401，404

给QoS policy设置带宽

功能介绍

‎给QoS策略设置带宽规则。

URI

POST /v2.0/qos/policies/{policy_id}/bandwidth_limit_rules

参数	参数类型	是否必选	Description
policy_id	string	否	QoS policy id

请求消息

参数	参数类型	是否必选	Description
bandwidth_limit_rule	是	object	带宽限制对象。
bandwidth_limit_rule:max_kbps	否	integer	每秒最大流量(K)。
bandwidth_limit_roule:max_burst_kbps	否	integer	流量峰值(K)。
bandwidth_limit_roule:direction	否	string	QoS规则方向 egress or ingress，默认是 egress。

响应消息

参数	参数类型	描述
bandwidth_limit_rule	object	带宽限制规则对象。
max_kbps	integer	每秒最大数据量(K)。
id	string	带宽规则id。
max_burst_kbps	integer	最大峰值流量(K)。
direction	string	方向ingress(入口),egress(出口）。

请求示例

POST http://{endpoint}/v2.0/qos/policies/05e0ab13-0e6e-40d2-a04d-b5ead44d2653/bandwidth_limit_rules

{
    "bandwidth_limit_rule":{
        "max_kbps":"2048",
        "max_burst_kbps":"2048"
    }
}

正常响应示例

{
    "bandwidth_limit_rule": {
        "id": "5f126d84-551a-4dcf-bb01-0e9c0df0c793",
        "max_kbps": 2048,
        "max_burst_kbps": 2048,
        "direction": "egress"
    }
}

正常响应代码

201

错误码

400，401，404，409

更新QoS policy带宽

功能介绍

‎更新QoS带宽规则。

URI

PUT /v2.0/qos/policies/{policy_id}/bandwidth_limit_rules/{rule_id}

参数	参数类型	是否必选	Description
policy_id	string	是	QoS策略的 id
rule_id	string	是	QoS规则的 id

请求消息

参数	参数类型	是否必选	Description
bandwidth_limit_rule	是	object	带宽限制对象。
bandwidth_limit_rule:max_kbps	否	integer	每秒最大流量(K)。
bandwidth_limit_roule:max_burst_kbps	否	integer	流量峰值(K)。
bandwidth_limit_roule:direction	否	string	QoS规则方向 egress or ingress，默认是 egress。

响应消息

参数	参数类型	描述
bandwidth_limit_rule	object	带宽限制规则对象。
max_kbps	integer	每秒最大数据量(K)。
id	string	带宽规则id。
max_burst_kbps	integer	最大峰值流量(K)。
direction	string	方向ingress(入口),egress(出口）。

请求示例

PUT http://{endpoint}/v2.0/qos/policies/05e0ab13-0e6e-40d2-a04d-b5ead44d2653/bandwidth_limit_rules/d1a8dc46-34df-453c-908c-a4eb36e0ba4f

{"bandwidth_limit_rule":{
    "max_kbps":"2048",
    "max_burst_kbps":"3096"
    }
}

正常响应示例

{
   "bandwidth_limit_rule":{
      "max_kbps":2048,
      "id":"d1a8dc46-34df-453c-908c-a4eb36e0ba4f",
      "max_burst_kbps":3096,
      "direction":"ingress"
   }
}

正常响应代码

200

错误码

400，401，404

删除QoS policy带宽规则

功能介绍

‎删除QoS带宽规则。

URI

DELETE /v2.0/qos/policies/{policy_id}/bandwidth_limit_rules/{rule_id}

参数	参数类型	是否必选	Description
policy_id	string	是	QoS策略的 id。
rule_id	string	是	QoS规则的 id。

请求消息

无

响应消息

无

请求示例

DELETE https://{endpoint}/v2.0/qos/policies/05e0ab13-0e6e-40d2-a04d-b5ead44d2653/bandwidth_limit_rules/d1a8dc46-34df-453c-908c-a4eb36e0ba4f

正常响应示例

无

正常响应代码

204

错误码

400，401，404