ModifyDiskAttribute

修改一個或多個區塊儲存裝置的名稱、描述、是否隨執行個體釋放、是否隨磁碟刪除其自動快照、是否啟用自動快照策略、是否開啟效能突發功能等。

介面說明

您可以呼叫DiskId參數修改一個區塊儲存裝置的名稱、描述、是否隨執行個體釋放等屬性，呼叫DiskIds.N參數批次修改多個區塊儲存裝置的屬性。

調試

您可以在OpenAPI Explorer中直接運行該介面，免去您計算簽名的困擾。運行成功後，OpenAPI Explorer可以自動產生SDK程式碼範例。

調試

授權資訊

下表是API對應的授權資訊，可以在RAM權限原則語句的Action元素中使用，用來給RAM使用者或RAM角色授予調用此API的許可權。具體說明如下：

操作：是指具體的許可權點。
存取層級：是指每個操作的存取層級，取值為寫入（Write）、讀取（Read）或列出（List）。
資源類型：是指操作中支援授權的資源類型。具體說明如下：
- 對於必選的資源類型，用前面加 * 表示。
- 對於不支援資源級授權的操作，用全部資源表示。
條件關鍵字：是指雲產品自身定義的條件關鍵字。
關聯操作：是指成功執行操作所需要的其他許可權。操作者必須同時具備關聯操作的許可權，操作才能成功。

操作

存取層級

資源類型

條件關鍵字

關聯操作

ecs:ModifyDiskAttribute

update

*Disk

acs:ecs:{#regionId}:{#accountId}:disk/{#diskId}

無

請求參數

名稱	類型	必填	描述	樣本值
DiskId	string	否	待修改屬性的磁碟 ID。說明 `DiskId`和`DiskIds.N`兩個參數不能同時被呼叫，請您根據需求任選其一傳值。	d-bp1famypsnar20bv****
DiskName	string	否	磁碟名稱。長度為 2~128 個字元，支援 Unicode 中 letter 分類下的字元（其中包括英文、中文和數字等）。可以包含半形冒號（:）、下劃線（_）、半形句號（.）或者短劃線（-）。	MyDiskName
Description	string	否	磁碟描述。長度為 2~256 個英文或中文字元，不能以`http://`和`https://`開頭。	TestDescription
DeleteWithInstance	boolean	否	磁碟是否隨執行個體釋放。預設值：無，無表示不改變當前的值。在下列兩種情況下，將參數`DeleteWithInstance`設定成`false`時會報錯。磁碟的種類（category）為本機磁碟（ephemeral）時。磁碟的種類（category）為普通雲端硬碟（cloud），且不可以卸載（Portable=false）時。警告如果您設定了不隨執行個體釋放（DeleteWithInstance=false），一旦磁碟掛載的 ECS 執行個體被安全鎖定且 OperationLocks 中標記了「LockReason」:「security」的鎖定狀態，釋放執行個體時會忽略磁碟的 DeleteWithInstance 屬性而被同時釋放。。	false
DeleteAutoSnapshot	boolean	否	刪除磁碟時，是否同時刪除其自動快照。取值範圍： true：啟用。 false：關閉。預設值：無，無表示不改變當前的值。	false
EnableAutoSnapshot	boolean	否	磁碟是否啟用自動快照策略功能。取值範圍： true：啟用。 false：關閉。預設值：無，表示不改變當前的值。說明該參數已棄用。建立後的雲端硬碟預設啟用自動快照策略功能，您只需要為雲端硬碟繫結自動快照策略即可正常使用。	true
RegionId	string	否	地域 ID。您可以呼叫 DescribeRegions 查看最新的阿里雲地域列表。	cn-hangzhou
DiskIds	array	否	待修改多個磁碟的 ID 列表。N 的取值範圍為 0 ~ 100。說明 `DiskId`和`DiskIds.N`兩個參數不能同時被呼叫，請您根據需求任選其一傳值。	d-bp1famypsnar20bv****
	string	否	待修改多個磁碟的 ID。N 的取值範圍為 0 ~ 100。說明 `DiskId`和`DiskIds.N`兩個參數不能同時被呼叫，請您根據需求任選其一傳值。	d-bp1famypsnar20bv****
BurstingEnabled	boolean	否	針對支援 Burst（效能突發）的磁碟是否開啟此功能，取值範圍： true：是。 false：否。說明對於不支援 Burst 功能的磁碟，傳入任意值將會報錯。	false

返回參數

名稱	類型	描述	樣本值
	object
RequestId	string	請求 ID。	473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E

樣本

正常返回樣本

JSON格式

{
  "RequestId": "473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E"
}

異常返回樣本

JSON格式

{
    "RequestId": "473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E"
}

錯誤碼

HTTP status code	錯誤碼	錯誤資訊
400	InvalidDiskName.Malformed	The specified disk name is wrongly formed.
400	NoAttributeToModify	No attribute to be modified in this request.
400	IncompleteParamter	Some fields can not be null in this request.
400	InvalidRegionId.MalFormed	The specified RegionId is not valid.
400	MissingParameter.DiskIdOrDiskIds	Specified parameter DiskId or DiskIds is missing.
400	ParameterConflict.DiskIdAndDiskIds	Specified parameter DiskId and DiskIds conflict, only one can be chosen.
400	BurstingEnabledForDiskCategoryUnsupported	The specified disk category does not support bursting enabled.
400	BurstingEnabledForMultiAttachDiskUnsupported	The multi attach disk does not support bursting enabled.
400	BurstingEnabledForModifyingDiskUnsupported	The modifying disk does not support bursting enabled.
400	InvalidBurstingEnabled.DiskSizeTooSmall	The disk size must be greater than 3 GiB to enable burst.
403	QuotaExceed.Snapshot	The snapshot quota exceeds.
403	DiskNotPortable	The specified disk is not a portable disk.
403	IncorrectDiskStatus	The operation is not supported in this status.
403	UserNotInTheWhiteList	The user is not in disk white list.
403	DeleteWithInstance.Conflict	The specified image is from the image market, you cannot set DeleteWithInstance attribute to false.
404	InvalidDiskId.NotFound	The specified disk does not exist.
404	InvalidDescription.Malformed	The specified description is wrongly formed.
404	InvalidInstanceId.NotFound	Specified attached instance does not exist.

訪問錯誤中心查看更多錯誤碼。

變更歷史

更多資訊，參考變更詳情。