Domain name for API request: cbs.tencentcloudapi.com.
A maximum of 20 requests can be initiated per second for this API.
The following request parameter list only provides API request parameters and some common parameters. For the complete common parameter list, see Common Request Parameters.
Parameter Name | Required | Type | Description |
---|---|---|---|
Action | Yes | String | Common Params. The value used for this API: ModifyDiskAttributes. |
Version | Yes | String | Common Params. The value used for this API: 2017-03-12. |
Region | No | String | Common Params. This parameter is not required for this API. |
DiskIds.N | Yes | Array of String | IDs of one or more cloud disks to be operated. If multiple cloud disk IDs are selected, it only supports modifying all cloud disks with the same attributes. |
DiskName | No | String | Name of new cloud disk. |
Portable | No | Boolean | Whether it is an elastic cloud disk. FALSE: non-elastic cloud disk; TRUE: elastic cloud disk. You can only modify non-elastic cloud disks to elastic cloud disks. |
ProjectId | No | Integer | The new project ID of the cloud disk. Only the project ID of elastic cloud disk can be modified. The available projects and their IDs can be queried via the API DescribeProject. |
DeleteWithInstance | No | Boolean | Whether the cloud disk is terminated with the CVM after it has been successfully mounted. TRUE indicates that it is terminated with the CVM. FALSE indicates that it is not terminated with the CVM. This is only supported for cloud disks and data disks that are pay-as-you-go. |
DiskType | No | String | When changing the type of a cloud disk, this parameter can be passed to indicate the desired cloud disk type. Value range: Currently, batch operations are not supported for changing type. That is, when DiskType is passed, only one cloud disk can be passed through DiskIds . When the cloud disk type is changed, the changing of other attributes is not supported concurrently. |
BurstPerformanceOperation | No | String | Enable/disable disk bursting. |
Parameter Name | Type | Description |
---|---|---|
RequestId | String | The unique request ID, which is returned for each request. RequestId is required for locating a problem. |
This example shows you how to rename the specified cloud disk test_data_disk
.
POST / HTTP/1.1
Host: cbs.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: ModifyDiskAttributes
<Common request parameters>
{
"DiskName": "test_data_disk",
"DiskIds": [
"disk-fyctkqsf"
]
}
{
"Response": {
"RequestId": "bf84fb00-6949-c0f6-aea8-5a1f806401c2"
}
}
TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to call APIs.
The following only lists the error codes related to the API business logic. For other error codes, see Common Error Codes.
Error Code | Description |
---|---|
InternalError.ComponentError | Dependent component request failed. Please contact customer service. |
InvalidAccount.InsufficientBalance | Insufficient account balance |
InvalidDisk.NotSupported | Indicates that the operation is not supported for the cloud disk. |
InvalidDiskId.NotFound | The ‘DiskId’ entered does not exist. |
InvalidInstanceId.NotFound | The ‘InstanceId’ entered does not exist. |
InvalidParameter.DiskConfigNotSupported | Currently configured cloud disk not supported in current region. |
InvalidParameterValue | Invalid parameter value. |
InvalidParameterValue.LimitExceeded | Number of parameter values exceeds the limit. |
MissingParameter | Missing parameter. |
ResourceInUse.DiskMigrating | The cloud disk is being migrated. Try again later. |
ResourceInsufficient | Insufficient resources. |
ResourceNotFound.NotFound | The resource is not found. |
ResourceUnavailable.NotSupported | The resource does not support this operation. |
本页内容是否解决了您的问题?