Reviewed-by: Muller, Martin <martin.muller@t-systems.com> Co-authored-by: lizaoxu <lizaoxu@huawei.com> Co-committed-by: lizaoxu <lizaoxu@huawei.com>
16 KiB
Modifying QoS of an EVS Disk
Function
This API is used to change the IOPS or throughput of an EVS disk.
Constraints
The disk must be in the available or in-use state. For a General Purpose SSD V2 disk, both the IOPS and throughput can be changed. This API is not supported for other types of EVS disks.
URI
PUT /v5/{project_id}/cloudvolumes/{volume_id}/qos
Parameter |
Mandatory |
Type |
Description |
|---|---|---|---|
project_id |
Yes |
String |
The project ID. |
volume_id |
Yes |
String |
The disk ID. |
Request Parameters
Parameter |
Mandatory |
Type |
Description |
|---|---|---|---|
X-Auth-Token |
Yes |
String |
The user token. It can be obtained by calling the IAM API used to obtain a user token. The value of X-Subject-Token in the response header is the user token. |
Parameter |
Mandatory |
Type |
Description |
|---|---|---|---|
qos_modify |
Yes |
ModifyVolumeQoSOption object |
The disk QoS change marker. |
Parameter |
Mandatory |
Type |
Description |
|---|---|---|---|
iops |
Yes |
Integer |
The new maximum IOPS of the disk. Only General Purpose SSD V2 disks are supported. |
throughput |
No |
Integer |
The new maximum throughput of the disk, in the unit of MiB/s. This parameter is only supported for General Purpose SSD V2 disks. |
Response Parameters
Status code: 202
Parameter |
Type |
Description |
|---|---|---|
job_id |
String |
The task ID. NOTE:
To query the task status, see Querying Task Status. |
Status code: 400
Parameter |
Type |
Description |
|---|---|---|
error |
Error object |
The error code returned if an error occurs. For details about the error code, see Error Codes. |
Parameter |
Type |
Description |
|---|---|---|
code |
String |
The error code returned if an error occurs. For details about the error code, see Error Codes. |
message |
String |
The error message returned if an error occurs. |
Example Requests
PUT https://{endpoint}/v5/{project_id}/cloudvolumes/{volume_id}/qos
{
"qos_modify" : {
"iops" : 10000,
"throughput" : 200
}
}
Example Responses
Status code: 202
Accepted
{
"job_id" : "70a599e0-31e7-49b7-b260-868f441e862b"
}
Status code: 400
Bad Request
{
"error" : {
"code" : "XXXX",
"message" : "XXX"
}
}
Status Codes
Status Code |
Description |
|---|---|
202 |
Accepted |
400 |
Bad Request |
Error Codes
For details, see Error Codes.