All Products
Search
Document Center

:ModifyDiskSpec

更新時間:Dec 25, 2023

Changes the category of a disk or modifies the performance level of an enhanced SSD (ESSD).

Usage notes

Take note of the following items:

  • To modify the performance level of an ESSD, take note of the following items:
    • For a subscription ESSD, you can only upgrade the performance level of the ESSD.
    • For a pay-as-you-go ESSD, you can upgrade or downgrade its performance level. However, you cannot downgrade the performance level to PL0.
    • The ESSD must be in the In Use (In_Use) or Unattached (Available) state.
    • If the ESSD is attached to an Elastic Compute Service (ECS) instance, the instance must be in the Running (Running) or Stopped (Stopped) state. The instance cannot be in the Expired state or stopped due to an overdue payment.
    • If you cannot upgrade the performance level of an ESSD due to the capacity limit, resize the ESSD by calling the ResizeDisk operation and then try again. For more information, see ESSDs.
  • For information about the limits on changing the category of a disk, see the "Limits" section in Change the category of a disk.

The new disk category or performance level takes effect immediately after this operation is performed. Alibaba Cloud calculates the bill based on the new disk category and performance level.

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer. OpenAPI Explorer dynamically generates the sample code of the operation for different SDKs.

Request parameters

Parameter

Type

Required

Example

Description

Action String Yes ModifyDiskSpec

The operation that you want to perform. Set the value to ModifyDiskSpec.

DiskId String Yes d-bp131n0q38u3a4zi****

The ID of the disk.

PerformanceLevel String No PL2

The new performance level of the ESSD. Valid values:

  • PL0: A single ESSD can deliver up to 10000 random read/write IOPS.
  • PL1: A single ESSD can deliver up to 50000 random read/write IOPS.
  • PL2: A single ESSD can deliver up to 100000 random read/write IOPS.
  • PL3: A single ESSD can deliver up to 1000000 random read/write IOPS.

Default value: PL1.

DiskCategory String No cloud_essd

The new category of the disk. Valid values:

  • cloud_essd: ESSD
  • cloud_auto: ESSD AutoPL disk
  • cloud_ssd: standard SSD

  • cloud_efficiency: ultra disk

This parameter is empty by default, which indicates that the disk category is not changed.

Note
  • The preceding values are listed in descending order of disk performance. Subscription disks cannot be downgraded.

DryRun Boolean No false

Specifies whether to perform only a dry run, without performing the actual request. Valid values:

  • true: performs only a dry run. The system checks the request for potential issues, including missing parameter values, incorrect request syntax, service limits, and insufficient Elastic Compute Service (ECS) resources. If the request fails the dry run, an error message is returned. If the request passes the dry run, the DryRunOperation error code is returned.
  • false: performs a dry run and performs the actual request. If the request passes the dry run, a 2xx HTTP status code is returned and the operation is performed.

Default value: false.

ProvisionedIops Long No 50000

The provisioned read/write IOPS of the ESSD AutoPL disk. Valid values: 0 to min{50,000, 1,000 × Capacity - Baseline IOPS}.

Baseline IOPS = min{1,800 + 50 × Capacity, 50,000}.

Note This parameter is available only if DiskCategory is set to cloud_auto. For more information, see ESSD AutoPL disks and Modify the performance configurations of an ESSD AutoPL disk.
PerformanceControlOptions.IOPS Integer No 2000

The new IOPS of the disk. You can modify the IOPS of only disks in dedicated block storage clusters.

Valid values: 900 to maximum IOPS per disk (with an increment of 100).

For more information, see Block storage performance.

PerformanceControlOptions.Throughput Integer No 200

The new throughput of the disk. You can modify the throughput of only disks in dedicated block storage clusters. Unit: MB/s.

Valid values: 60 to maximum throughput per disk.

For more information, see Block storage performance.

PerformanceControlOptions.Recover String No All

Specifies whether to reset the IOPS and throughput of the disk. This parameter is valid only when the disk is in a dedicated block storage cluster.

After you specify this parameter, PerformanceControlOptions.IOPS and PerformanceControlOptions.Throughput do not take effect.

Set the value to All, which indicates that the IOPS and throughput of the disk is reset to the initial values.

Response parameters

Parameter

Type

Example

Description

RequestId String 473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E

The ID of the request.

TaskId String t-bp67acfmxazb4p****

The ID of the disk category change task.

Note If you only modify the performance level of an ESSD, this parameter is not returned.
OrderId String 20413515388****

The ID of the order.

Note This parameter is returned only when the category of a subscription disk or the performance level of a subscription ESSD is modified.

Examples

Sample requests

http(s)://ecs.aliyuncs.com/?Action=ModifyDiskSpec
&ResourceOwnerId=123
&DiskId=d-bp131n0q38u3a4zi****
&PerformanceLevel=PL2
&DiskCategory=cloud_essd
&DryRun=false
&ProvisionedIops=50000
&<Common request parameters>

Sample success responses

XML format

HTTP/1.1 200 OK
Content-Type:application/xml

<ModifyDiskSpecResponse>
    <TaskId>t-bp67acfmxazb4p****</TaskId>
    <RequestId>5B38289D-88AB-42BD-B021-12FC6942F099</RequestId>
    <OrderId>20413515388****</TaskId>
</ModifyDiskSpecResponse>

JSON format

HTTP/1.1 200 OK
Content-Type:application/json

{
  "TaskId" : "t-bp67acfmxazb4p****",
  "RequestId" : "5B38289D-88AB-42BD-B021-12FC6942F099",
  "OrderId" : "20413515388****"
}

Error codes

HTTP status code

Error code

Error message

Description

400 InvalidPerformanceLevel.Malformed The specified parameter PerformanceLevel is not valid. Invalid PerformanceLevel value.
400 ProvisionedIopsForDiskCategoryUnsupported The specified disk category does not support provisioned iops. The disk category does not support provisioned IOPS.
400 QuotaExceed.DiskCapacity The used capacity of disk type has exceeded the quota in the zone, %s. The capacity of disks that belong to the specified disk category exceeds the quota limit for the zone. You can go to Quota Center to view and increase the quota.
400 MalformedParameter.PerformanceControlOptions Parameter invalid, %s. Invalid parameter value.
400 InvalidPerformanceControlOptions.ModifyOperationUnsupported The specified performance control options are conflicts with disk category or performance level or ProvisionIOPS. Parameters prefixed with PerformanceControlOptions conflict with the disk category, performance level, or provisioned IOPS of the disk.
400 InvalidOperation.InstanceRenewWithDowngradeInPlan The operation is denied due to the specified instance has renew with downgrade record in plan. Renewal and configuration downgrade orders did not take effect. This operation cannot be performed before the orders take effect.
403 DiskInArrears The specified operation is denied as your disk owing fee. You have an overdue payment for the specified disk.
403 InstanceExpiredOrInArrears The specified operation is denied as your prepay instance is expired (prepay mode) or in arrears (afterpay mode). The instance has expired or has an overdue payment. Renew or complete the payment for the instance and try again.
403 IncorrectDiskStatus The current disk status does not support this operation. This operation cannot be performed on the disk in the current state. Make sure that the disk is available and that you have no overdue payments for it.
403 DiskCreatingSnapshot The operation is denied due to a snapshot of the specified disk is not completed yet. A snapshot is being created for the specified disk.
403 OperationDenied The type of the disk does not support the operation. The specified disk category does not support this operation.
403 OperationDenied.PerformanceLevelNotMatch The specified PerformanceLevel and disk size do not match. The specified performance level and the disk size do not correspond to each other.
403 InvalidInstanceType.NotSupportDiskCategory The instanceType of the specified instance does not support this disk category. The instance type specified by InstanceType does not support the disk category of the instance. Try another instance type. For information about the disk categories supported by instance types, see the instance family documentation.
403 ModifyingDiskCategoryLimitExceed The amount of modifying disk category exceeds the limit. The maximum number of disks whose configurations are being changed is exceeded in the region.
403 DiskInCoolingPeriod There is a cooling period after the disk is successfully modified. The disk is in a configuration change limitation period and cannot have the configurations changed during the period.
403 NoChangeInDiskCategoryAndPerformanceLevel There is no change between the parameters transmitted and the current. The specified disk category and performance level are the same as the current disk category and performance level.
403 OperationDenied.NoStock The requested resource is sold out in the specified zone; try other types of resources or other regions and zones. The requested resources are unavailable in the specified zone. Try another instance type or zone. You can call the DescribeZones operation to query available resources.
403 InvalidOperation.MultiAttachDisk Multi attach disk does not support this operation. The disk for which the multi-attach feature is enabled does not support the operation.
403 InvalidDiskCategory.NotSupported The specified disk category is not supported. The specified disk category does not support the operation.
403 InvalidPerformanceParameter.DiskNotInDedicatedStorageCluster The specified disk not in dedicated storage cluster, can not modify performance control options. Disks that are not in dedicated block storage clusters do not support parameters prefixed with PerformanceControlOptions.
403 InvalidStatus.DiskUnderPerformanceControl The specified disk is under performance control, any modifications to the category or performance level of the specified disk are unsupported.. The disk category and performance level cannot be modified when parameters prefixed with PerformanceControlOptions are specified.
403 InvalidStatus.DiskNotReady This specified disk is not ready, status needs to be either In_use or Available. The specified disk must be in the In_use or Available state.
404 InvalidDiskId.NotFound The specified disk does not exist. The specified disk is not found. Check whether the disk ID is valid.
404 InvalidInstanceId.NotFound The specified InstanceId does not exist. The instance is not found. Check whether the instance ID is correct.
500 InternalError The request processing has failed due to some unknown error, exception or failure. An internal error occurred. Try again later.

For a list of error codes, see Service error codes.