Domain name for API request: cbs.intl.tencentcloudapi.com.
This API is used to modify only the Project ID of elastic cloud disks. The Project ID of a cloud disk created with a host is linked to the host. Whether a cloud disk is elastic can be checked through the DescribeDisks API. See the Portable field explanation in the output parameters.
The "cloud disk name" is only for ease of management for users. Tencent Cloud does not use this name as a basis for submitting tickets or performing cloud disk management operations.
This API is used to support batch operations. If multiple cloud disk IDs are passed in, modify cloud disks to the same attribute. If there is a cloud disk that does not allow operation, the operation will not be executed and return a specific error code.
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 | Yes | String | Common Params. For more information, please see the list of regions supported by the product. |
| DiskIds.N | Yes | Array of String | One or more cloud disk ids to be operated, which can be queried through the DescribeDisks api. if multiple cloud disk ids are passed in, only modifying all cloud disks to the same attribute is supported. |
| 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 CLOUD disk type, you can input this parameter to indicate the target type. valid values: changing the CLOUD disk type does not support changing other attributes at the same time. For details, see adjust cloud disk type. |
| BurstPerformanceOperation | No | String | Enable/Disable cloud disk performance burst feature. valid values:. CREATE: enable. Specifies to CANCEL and close. |
| Parameter Name | Type | Description |
|---|---|---|
| RequestId | String | The unique request ID, generated by the server, will be returned for every request (if the request fails to reach the server for other reasons, the request will not obtain a RequestId). 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.intl.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. |
| ResourceInsufficient.UpgradeServiceBusy | Cloud block storage upgrade service is busy. please retry later. |
| ResourceNotFound.NotFound | The resource is not found. |
| ResourceUnavailable.NotSupported | The resource does not support this operation. |
| TradeDealConflict | Order conflict. |
피드백