Help Center/ Workspace/ API Reference/ Workspace APIs/ Disk/ Batch Modifying Disk QoS Configurations

Updated on 2026-02-10 GMT+08:00

View PDF

Batch Modifying Disk QoS Configurations

Function

Modifies disk QoS configurations in batches.

Debugging

You can debug this API through automatic authentication in API Explorer or use the SDK sample code generated by API Explorer.

Authorization Information

Each account has all the permissions required to call all APIs, but IAM users must be assigned the required permissions.

If you are using role/policy-based authorization, see Permissions Policies and Supported Actions for details on the required permissions.

If you are using identity policy-based authorization, the following identity policy-based permissions are required.

Action	Access Level	Resource Type (*: required)	Condition Key	Alias	Dependencies
workspace:volumes:modifyQos	Write	-	-	-	-

URI

PUT /v2/{project_id}/volumes/batch-modify-qos

**Table 1** Path Parameters
Parameter	Mandatory	Type	Description
project_id	Yes	String	Project ID.

Request Parameters

**Table 2** Request body parameters
Parameter	Mandatory	Type	Description
volume_ids	Yes	Array of strings	IDs of the disks whose QoS configurations are to be modified.
qos	Yes	Qos object	QoS information.

**Table 3** Qos
Parameter	Mandatory	Type	Description
iops	Yes	Integer	Number of read/write operations performed by a disk per second.
throughput	Yes	Integer	The amount of data read from and written to a disk per second (unit: MiB/s).

Response Parameters

Status code: 200

**Table 4** Response body parameters
Parameter	Type	Description
job_id	String	Task ID.

Status code: 400

**Table 5** Response body parameters
Parameter	Type	Description
error_code	String	Error code, which is returned upon failure.
error_msg	String	Error message.
error_detail	String	Error details.
encoded_authorization_message	String	Encrypted detailed reason for rejection. You can call the API decode-authorization-message of STS to decrypt the reason.

Status code: 401

**Table 6** Response body parameters
Parameter	Type	Description
error_code	String	Error code, which is returned upon failure.
error_msg	String	Error message.
error_detail	String	Error details.
encoded_authorization_message	String	Encrypted detailed reason for rejection. You can call the API decode-authorization-message of STS to decrypt the reason.

Status code: 403

**Table 7** Response body parameters
Parameter	Type	Description
error_code	String	Error code, which is returned upon failure.
error_msg	String	Error message.
error_detail	String	Error details.
encoded_authorization_message	String	Encrypted detailed reason for rejection. You can call the API decode-authorization-message of STS to decrypt the reason.

Status code: 404

**Table 8** Response body parameters
Parameter	Type	Description
error_code	String	Error code, which is returned upon failure.
error_msg	String	Error message.
error_detail	String	Error details.
encoded_authorization_message	String	Encrypted detailed reason for rejection. You can call the API decode-authorization-message of STS to decrypt the reason.

Status code: 409

**Table 9** Response body parameters
Parameter	Type	Description
error_code	String	Error code, which is returned upon failure.
error_msg	String	Error message.
error_detail	String	Error details.
encoded_authorization_message	String	Encrypted detailed reason for rejection. You can call the API decode-authorization-message of STS to decrypt the reason.

Status code: 500

**Table 10** Response body parameters
Parameter	Type	Description
error_code	String	Error code, which is returned upon failure.
error_msg	String	Error message.
error_detail	String	Error details.
encoded_authorization_message	String	Encrypted detailed reason for rejection. You can call the API decode-authorization-message of STS to decrypt the reason.

Example Requests

PUT /v2/9565be6e740941c493b38a1f46ecae6f/volumes/batch-modify-qos

{
  "volume_ids" : [ "e6635b00-c032-4b54-b93b-c36d3ebxxxx" ],
  "qos" : {
    "iops" : 3000,
    "throughput" : 125
  }
}

Example Responses

Status code: 200

Normal.

{
  "job_id" : "1792d3eb-35c6-4e99-8381-abfc8e02126b"
}

Status Codes

Status Code	Description
200	Normal.
400	The request cannot be understood by the server due to malformed syntax.
401	Authentication failed.
403	No operation permissions.
404	No resources found.
409	Operation conflict.
500	An internal service error occurred. For details about the error code, see the error code description.