ModifyDiskAttributes
* Only the project ID of elastic cloud disk can be modified. The project ID of the cloud disk created with the CVM is linked with the CVM. The project ID can be can be queried in the Portable field in the output parameters through the API DescribeDisks.
Wire call
Converge Cloud is RPC over HTTP. There is one path — / — and the action travels in the X-TC-Action header. The /cbs/ModifyDiskAttributes path used in the OpenAPI document is a documentation convenience so each action is addressable; it is not a route on the server.
curl -sS https://cbs.api3.convergecloud.com/ \
-H 'Authorization: TC3-HMAC-SHA256 Credential=<SecretId>/<YYYY-MM-DD>/cbs/tc3_request, SignedHeaders=content-type;host;x-tc-action, Signature=<sig>' \
-H 'Content-Type: application/json; charset=utf-8' \
-H 'Host: cbs.api3.convergecloud.com' \
-H 'X-TC-Action: ModifyDiskAttributes' \
-H 'X-TC-Version: 2017-03-12' \
-H 'X-TC-Timestamp: <unix-seconds>' \
-H 'X-TC-Region: luzon' \
-d '{"DiskIds":["<DiskId>"]}'Request parameters
| Field | Type | Required | Description |
|---|---|---|---|
| DiskIds | string[] | Yes | 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 | string | No | Name of new cloud disk. |
| Portable | boolean | No | 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 | integer | No | 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 | boolean | No | 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 | string | No | When changing the type of a cloud disk, this parameter can be passed to indicate the desired cloud disk type. Value range: CLOUD_PREMIUM: Premium cloud storage. CLOUD_SSD: SSD cloud disk. 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 ot… |
| BurstPerformanceOperation | string | No | Enable/disable disk bursting. |
Response
Fields are returned inside the Response envelope. Converge Cloud answers HTTP 200 for errors as well as successes, so read Response.Error rather than the status code — and test for the presence of that object, because Code is occasionally the empty string.
| Field | Type | Description |
|---|---|---|
| RequestId | string | The unique request ID, which is returned for each request. RequestId is required for locating a problem. |
{
"Response": {
// action-specific fields,
"RequestId": "…"
}
}{
"Response": {
"Error": { "Code": "…", "Message": "…" },
"RequestId": "…"
}
}