QoS

列举所有QoS策略

功能介绍

列举所有QoS策略。一个策略可以包含多个类型的规则。

URI

GET /v2.0/qos/policies

请求消息

参数	是否可选	参数类型	描述
description	是	String	根据描述筛选列表结果。
tenant_id	是	String	根据资源所属项目的ID筛选列表结果。
project_id	是	String	根据资源所属项目的ID筛选列表结果。
revision_number	是	integer	根据资源的版本号筛选列表结果。
shared	是	boolean	根据该策略是否在所有项目中共享，筛选列表结果。
id	是	String	根据资源ID筛选列表结果。
name	是	String	根据描述筛选列表结果。
sort_dir	是	String	升序/降序排序。 可选值是asc(升序)或desc(降序)。可以指定多个排序键值和排序方向。
sort_key	是	String	按QoS策略属性排序。可以指定多个排序键值和排序方向。排序键值被限制为以下值：id，name，project_id，tenant_id
fields	是	String	指定服务器返回的字段。如果没有指定字段查询参数，API将返回QoS策略的所有属性。

请求示例

GET /v2.0/qos/policies?sort_key=id&sort_dir=desc

响应消息

参数	参数类型	描述
policies	array	QoS策略对象列表。
description	String	QoS策略的描述。
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	资源的创建时间(UTC ISO8601格式)。
updated_at	String	资源的更新时间(UTC ISO8601格式)。

响应示例

{
    "policies": [
        {
            "id": "6db39786-07be-4f34-9844-f718cd8f6e88",
            "project_id": "1203faf7b52d4c02b695ecf24706fa0f",
            "name": "10Mbit",
            "shared": false,
            "rules": [],
            "revision_number": 0,
            "description": "",
            "created_at": "2021-04-25T05:55:08Z",
            "updated_at": "2021-04-25T05:55:08Z",
            "tenant_id": "1203faf7b52d4c02b695ecf24706fa0f"
        }
    ]
}

正常响应代码

200

错误码

401

创建QoS策略

功能介绍

根据配置创建QoS策略。

URI

Post /v2.0/qos/policies

请求消息

参数	是否可选	参数类型	描述
policy	否	object	QoS策略对象。
description	是	String	Qos策略描述。
tenant_id	是	String	拥有该资源所属的项目的ID。只有管理员和advsvc用户可以指定项目ID。
project_id	是	String	拥有该资源所属的项目的ID。只有管理员和advsvc用户可以指定项目ID。
shared	是	boolean	是否与其他项目共享此策略。默认值为false。
name	是	String	QoS策略名称。

请求示例

{
    "policy": {
        "shared": true,
        "name": "10Mbit",
        "description": "This policy limits the ports to 10Mbit max."
    }
}

响应消息

参数	参数类型	描述
policy	object	QoS策略对象。
description	String	Qos策略描述。
tenant_id	String	项目ID。
project_id	String	项目ID。
revision_number	integer	资源的版本号。
shared	boolean	是否在所有项目中共享该策略。
rules	array	规则列表。
id	String	QoS策略ID。
name	String	QoS策略名称。
created_at	String	创建资源的时间(UTC ISO8601格式)。
updated_at	String	更新资源的时间(UTC ISO8601格式)。

响应示例

{
    "policy": {
        "id": "11e748f6-c31c-45cf-ba38-a0ef38e56dfc",
        "project_id": "1203faf7b52d4c02b695ecf24706fa0f",
        "name": "10Mbit",
        "shared": true,
        "rules": [],
        "revision_number": 0,
        "description": "This policy limits the ports to 10Mbit max.",
        "created_at": "2021-04-25T09:09:33Z",
        "updated_at": "2021-04-25T09:09:33Z",
        "tenant_id": "1203faf7b52d4c02b695ecf24706fa0f",
    }
}

正常响应代码

201

错误码

401、403、404、409

显示QoS策略详细信息

功能介绍

显示QoS策略的详细信息

URI

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

请求消息

参数	是否可选	参数类型	描述
policy_id	否	String	QoS策略ID

请求示例

无

响应消息

参数	参数类型	描述
policy	object	QoS策略对象。
description	String	QoS策略描述。
tenant_id	String	项目ID。
project_id	String	项目ID。
revision_number	integer	资源的版本号。
shared	boolean	是否在所有项目中共享该策略。
rules	array	规则列表。
id	String	QoS策略ID。
name	String	QoS策略名称。
created_at	String	创建资源的时间(UTC ISO8601格式)。
updated_at	String	更新资源的时间(UTC ISO8601格式)。

响应示例

{
    "policy": {
        "name": "10Mbit",
        "rules": [],
        "tenant_id": "60797caf1b8049cdb143426f3e51f5d7",
        "created_at": "2021-04-26T02:33:43Z",
        "updated_at": "2021-04-26T02:33:43Z",
        "revision_number": 1,
        "shared": false,
        "project_id": "60797caf1b8049cdb143426f3e51f5d7",
        "id": "3190edb6-0ea8-496e-910e-f5ed0382adfd",
        "description": ""
    }
}

正常响应代码

200

错误码

401、404

更新QoS策略

功能介绍

更新QoS策略。

URI

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

请求参数

参数	是否可选	参数类型	描述
policy_id	否	String	QoS策略ID。
policy	否	object	QoS策略对象。
description	是	String	QoS策略描述。
shared	是	boolean	设置为true将与其他项目共享此策略。默认是false。
name	是	String	QoS策略名称。

请求示例

{
    "policy": {
        "name": "20Mbit",
        "description": "This policy limits the ports to 20Mbit max."
    }
}'

响应消息

参数	参数类型	描述
policy	object	QoS策略对象。
description	String	QoS策略描述。
tenant_id	String	项目ID
project_id	String	项目ID
revision_number	integer	资源的版本号。
shared	boolean	是否在所有项目中共享该策略。
rules	array	规则列表。
id	String	QoS策略ID
name	String	QoS策略名称。
created_at	String	创建资源的时间(UTC ISO8601格式)。
updated_at	String	更新资源的时间(UTC ISO8601格式)。

响应示例

{
    "policy": {
        "name": "20Mbit",
        "tenant_id": "60797caf1b8049cdb143426f3e51f5d7",
        "created_at": "2021-04-26T05:55:50Z",
        "updated_at": "2021-04-26T05:59:06Z",
        "revision_number": 3,
        "shared": false,
        "project_id": "60797caf1b8049cdb143426f3e51f5d7",
        "id": "d3faf3ac-daad-450c-a13a-8b1e3cc62342",
        "description": "This policy limits the ports to 20Mbit max."
    }
}

正常响应代码

202

错误码

400、401、404、412

删除QoS策略

功能介绍

删除QoS策略。

URI

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

请求消息

参数	是否可选	参数类型	描述
policy_id	否	String	QoS策略ID。

请求示例

DELETE /qos/policies/1934160a-0f24-4055-8855-d2a285ccc86c

响应消息

无

响应示例

无

正常响应代码

204

错误码

400、401、404、412

列举QoS策略的所有带宽限制规则

功能描述

列举QoS策略的所有带宽限制规则。

URI

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

请求消息

参数	是否可选	参数类型	描述
policy_id	否	String	QoS策略ID。
max_kbps	是	integer	根据maximum KBPS(单位：Kb/s)值过滤结果列表。
id	是	String	根据资源ID过滤结果列表。
sort_dir	是	String	升序/降序排序。 有效值是asc(升序)或desc(降序)。可以指定多个排序键值和排序方向。
sort_key	是	String	按带宽限制规则属性进行排序。可以指定多个排序键值和排序方向。排序键值被限制为以下值：
id
max_kbps

请求示例

GET v2.0/qos/policies/3f15743a-8f46-4daf-b2c0-0eb41555c9f1/bandwidth_limit_rules.json?max_kbps=1024

响应消息

参数	参数类型	描述
bandwidth_limit_rules	array	与QoS策略关联的带宽限制规则列表。
max_kbps	integer	最大带宽(单位：Kb/s)。必须大于0，否则max_kbps将无效。
id	String	带宽限制规则的ID

响应示例

{
    "bandwidth_limit_rules": [
        {
            "max_kbps": 20000,
            "id": "51395c0e-9c25-4383-8d22-030ef8943647",
            "max_burst_kbps": 0
        }
    ]
}

正常响应代码

200

错误码

401、404 

创建带宽限制规则

功能描述

为QoS策略创建带宽限制规则

URI

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

请求消息

参数	是否可选	参数类型	参数类型
policy_id	否	String	QoS策略ID。
bandwidth_limit_rule	否	object	bandwidth_limit_rule对象。
max_kbps	是	integer	最大带宽(单位：Kb/s)。必须大于0，否则max_kbps将无效。

请求示例

{
    "bandwidth_limit_rule": {
        "max_kbps": "20000"
    }
}

响应消息

参数	参数类型	描述
bandwidth_limit_rule	object	一个bandwidth_limit_rule对象。
max_kbps	integer	最大带宽(单位：Kb/s)。必须大于0，否则max_kbps将无效。
id	String	QoS带宽限制规则的ID。

响应示例

{
    "bandwidth_limit_rule": {
        "max_kbps": 20000,
        "extra_fields": {
            "floatingip_ids": []
        },
        "id": "51395c0e-9c25-4383-8d22-030ef8943647",
        "max_burst_kbps": 0
    }
}

正常响应代码

201

错误码

400、401、404、409

显示宽带限制规则详细信息

功能描述

显示QoS策略的带宽限制规则的详细信息。

URI

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

请求消息

参数	是否可选	参数类型	描述
policy_id	否	String	QoS策略ID。
rule_id	否	String	QoS规则ID。

响应消息

参数	参数类型	描述
bandwidth_limit_rule	object	一个bandwidth_limit_rule 对象.
max_kbps	integer	最大带宽(单位：Kb/s)。必须大于0，否则max_kbps将无效。
id	String	QoS带宽限制规则的ID。

响应示例

{
    "bandwidth_limit_rule": {
        "max_kbps": 20000,
        "id": "51395c0e-9c25-4383-8d22-030ef8943647",
        "max_burst_kbps": 0
    }
}

正常响应代码

200

错误码

401、404

更新带宽限制规则

功能描述

更新QoS策略的带宽限制规则。

URI

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

请求消息

参数	是否可选	参数类型	描述
policy_id	否	String	QoS策略ID。
rule_id	否	String	QoS规则ID。
bandwidth_limit_rule	否	object	一个bandwidth_limit_rule对象。
max_kbps	是	integer	最大带宽(单位：Kb/s)。必须大于0，否则max_kbps将无效。

请求示例

{
    "bandwidth_limit_rule": {
        "max_kbps": "20000"
    }
}

响应消息

参数	参数类型	描述
bandwidth_limit_rule	object	一个bandwidth_limit_rule对象。
max_kbps	integer	最大带宽(单位：Kb/s)。必须大于0，否则max_kbps将无效。
id	String	QoS带宽限制规则的ID。

响应示例

{
    "bandwidth_limit_rule": {
        "max_kbps": 20000,
        "extra_fields": {
            "floatingip_ids": []
        },
        "id": "51395c0e-9c25-4383-8d22-030ef8943647",
        "max_burst_kbps": 0
    }
}

正常响应代码

202

错误码

400、401、404

删除带宽限制规则

功能描述

删除QoS策略的带宽限制规则。

URI

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

请求消息

参数	是否可选	参数类型
policy_id	否	QoS策略ID。
rule_id	否	QoS规则ID。

请求示例

DELETE /v2.0/qos/policies/1934160a-0f24-4055-8855-d2a285ccc86c/bandwidth_limit_rules/8a7c3910-03d6-4c7b-b767-73326cb71610

响应消息

无

响应示例

无

正常响应代码

204

错误码

400、401、404