1. Interface Description
Interface request domain name: cbs.api3.convergecloud.com.
This API is used to modify the attributes of a cloud disk.
*Only the project ID of cloud disks can be modified. The project ID of cloud disks created together with CVM instances is the same as that of the CVM instances. It can be queried by calling the DescribeDisks API. For details, see the description of the output parameter Portable.
*The cloud disk name is used only for snapshot management by users. The cloud platform does not use this name for submitting tickets or performing snapshot management operations.
*Batch operations are supported. If multiple cloud disk IDs are passed in, the attribute after modification applies to all corresponding cloud disks. If any cloud disk does not support the operation, the operation will not be performed, and a specific error code will be returned.
Default interface request rate limit: 20 times per second.
Interface update time: 2025-03-29 00:42:53.
The interface only verifies the signature but does not authenticate.
2. Input Parameters
The following list of request parameters only lists interface request parameters and some public parameters, For a complete list of public parameters see public request parameters.
| Parameter name | Required | Allow NULL | Type | Description |
|---|---|---|---|---|
| Action | Yes | No | String | Public parameter, The value of this interface: ModifyDiskAttributes |
| Version | Yes | No | String | Public parameter, The value of this interface: 2017-03-12 |
| Region | No | No | String | Public parameter,Regional information A list of supported geographies is available through the DescribeRegions interface |
| DiskIds | Yes | No | Array of String | ID of one or more cloud disks to be operated on. If multiple cloud disk IDs are input, only modification to the same attribute for all cloud disks is supported. Example: ["disk-7q2iy7gp"] |
| ProjectId | No | No | Uint64 | New project ID of the cloud disk. Modification of the project ID is supported only for elastic cloud disks. The available projects and their IDs can be queried through the DescribeProjects API. Example: 0 |
| DiskName | No | No | String | New cloud disk name. Example: ARM-centOS_System disk |
| Portable | No | No | Bool | It indicates whether it is an elastic cloud disk. FALSE indicates a non-elastic cloud disk, and TRUE indicates an elastic cloud disk. Only non-elastic cloud disks can be converted into elastic cloud disks. Example: TRUE |
| DeleteWithInstance | No | No | Bool | It indicates whether the cloud disk, once successfully mounted to a cloud host, is destroyed along with the cloud host. TRUE indicates it will be destroyed along with the cloud server, and FALSE indicates it will not. It only supports pay-as-you-go cloud disk data disks. Example: FALSE |
| DiskType | No | No | String | When changing the cloud disk type, this parameter can be input in to indicate the target type. Value range: Currently, batch type change is not supported, that is, when DiskType is input, DiskIds only supports entering one cloud disk ID; Changing the cloud disk type does not support changing other attributes at the same time. Example: CLOUD_SSD |
3. Output Parameters
| Parameter name | Type | Description |
|---|---|---|
| RequestId | String | Unique request id, Each request will return. The RequestId of the request needs to be provided when locating the problem. |
4. Error Code
The following lists only the error codes related to the interface business logic, For other error codes, see public ErrorCode.
| Error Code | Description |
|---|---|
| InvalidDiskId.NotFound | The input DiskId does not exist. |
| InvalidDisk.NotSupported | The cloud disk does not support this operation. |
| InvalidParameterValue | Invalid parameter value. The format of the parameter value is incorrect or the parameter value is not supported. |
| MissingParameter | Missing parameter. The request does not include the mandatory parameter. |
| ResourceNotFound.NotFound | The resource does not exist. |